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 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
448 SV * const target = SvRV(ref);
449 if (SvOBJECT(target)) {
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
451 if (SvWEAKREF(ref)) {
452 sv_del_backref(target, ref);
458 SvREFCNT_dec(target);
463 /* XXX Might want to check arrays, etc. */
466 /* called by sv_clean_objs() for each live SV */
468 #ifndef DISABLE_DESTRUCTOR_KLUDGE
470 do_clean_named_objs(pTHX_ SV *sv)
473 assert(SvTYPE(sv) == SVt_PVGV);
474 assert(isGV_with_GP(sv));
477 #ifdef PERL_DONT_CREATE_GVSV
480 SvOBJECT(GvSV(sv))) ||
481 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
482 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
483 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
484 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
486 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
487 SvFLAGS(sv) |= SVf_BREAK;
495 =for apidoc sv_clean_objs
497 Attempt to destroy all objects not yet freed
503 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
545 PL_in_clean_all = TRUE;
546 cleaned = visit(do_clean_all, 0,0);
547 PL_in_clean_all = FALSE;
552 ARENASETS: a meta-arena implementation which separates arena-info
553 into struct arena_set, which contains an array of struct
554 arena_descs, each holding info for a single arena. By separating
555 the meta-info from the arena, we recover the 1st slot, formerly
556 borrowed for list management. The arena_set is about the size of an
557 arena, avoiding the needless malloc overhead of a naive linked-list.
559 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
560 memory in the last arena-set (1/2 on average). In trade, we get
561 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
562 smaller types). The recovery of the wasted space allows use of
563 small arenas for large, rare body types,
566 char *arena; /* the raw storage, allocated aligned */
567 size_t size; /* its size ~4k typ */
568 U32 misc; /* type, and in future other things. */
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 unsigned int set_size; /* ie ARENAS_PER_SET */
583 unsigned int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
619 struct arena_set *current = aroot;
622 assert(aroot->set[i].arena);
623 Safefree(aroot->set[i].arena);
631 i = PERL_ARENA_ROOTS_SIZE;
633 PL_body_roots[i] = 0;
635 Safefree(PL_nice_chunk);
636 PL_nice_chunk = NULL;
637 PL_nice_chunk_size = 0;
643 Here are mid-level routines that manage the allocation of bodies out
644 of the various arenas. There are 5 kinds of arenas:
646 1. SV-head arenas, which are discussed and handled above
647 2. regular body arenas
648 3. arenas for reduced-size bodies
650 5. pte arenas (thread related)
652 Arena types 2 & 3 are chained by body-type off an array of
653 arena-root pointers, which is indexed by svtype. Some of the
654 larger/less used body types are malloced singly, since a large
655 unused block of them is wasteful. Also, several svtypes dont have
656 bodies; the data fits into the sv-head itself. The arena-root
657 pointer thus has a few unused root-pointers (which may be hijacked
658 later for arena types 4,5)
660 3 differs from 2 as an optimization; some body types have several
661 unused fields in the front of the structure (which are kept in-place
662 for consistency). These bodies can be allocated in smaller chunks,
663 because the leading fields arent accessed. Pointers to such bodies
664 are decremented to point at the unused 'ghost' memory, knowing that
665 the pointers are used with offsets to the real memory.
667 HE, HEK arenas are managed separately, with separate code, but may
668 be merge-able later..
670 PTE arenas are not sv-bodies, but they share these mid-level
671 mechanics, so are considered here. The new mid-level mechanics rely
672 on the sv_type of the body being allocated, so we just reserve one
673 of the unused body-slots for PTEs, then use it in those (2) PTE
674 contexts below (line ~10k)
677 /* get_arena(size): this creates custom-sized arenas
678 TBD: export properly for hv.c: S_more_he().
681 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
684 struct arena_desc* adesc;
685 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
688 /* shouldnt need this
689 if (!arena_size) arena_size = PERL_ARENA_SIZE;
692 /* may need new arena-set to hold new arena */
693 if (!aroot || aroot->curr >= aroot->set_size) {
694 struct arena_set *newroot;
695 Newxz(newroot, 1, struct arena_set);
696 newroot->set_size = ARENAS_PER_SET;
697 newroot->next = aroot;
699 PL_body_arenas = (void *) newroot;
700 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", aroot));
703 /* ok, now have arena-set with at least 1 empty/available arena-desc */
704 curr = aroot->curr++;
705 adesc = &(aroot->set[curr]);
706 assert(!adesc->arena);
708 Newx(adesc->arena, arena_size, char);
709 adesc->size = arena_size;
711 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
712 curr, (void*)adesc->arena, arena_size));
718 /* return a thing to the free list */
720 #define del_body(thing, root) \
722 void ** const thing_copy = (void **)thing;\
724 *thing_copy = *root; \
725 *root = (void*)thing_copy; \
731 =head1 SV-Body Allocation
733 Allocation of SV-bodies is similar to SV-heads, differing as follows;
734 the allocation mechanism is used for many body types, so is somewhat
735 more complicated, it uses arena-sets, and has no need for still-live
738 At the outermost level, (new|del)_X*V macros return bodies of the
739 appropriate type. These macros call either (new|del)_body_type or
740 (new|del)_body_allocated macro pairs, depending on specifics of the
741 type. Most body types use the former pair, the latter pair is used to
742 allocate body types with "ghost fields".
744 "ghost fields" are fields that are unused in certain types, and
745 consequently dont need to actually exist. They are declared because
746 they're part of a "base type", which allows use of functions as
747 methods. The simplest examples are AVs and HVs, 2 aggregate types
748 which don't use the fields which support SCALAR semantics.
750 For these types, the arenas are carved up into *_allocated size
751 chunks, we thus avoid wasted memory for those unaccessed members.
752 When bodies are allocated, we adjust the pointer back in memory by the
753 size of the bit not allocated, so it's as if we allocated the full
754 structure. (But things will all go boom if you write to the part that
755 is "not there", because you'll be overwriting the last members of the
756 preceding structure in memory.)
758 We calculate the correction using the STRUCT_OFFSET macro. For
759 example, if xpv_allocated is the same structure as XPV then the two
760 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
761 structure is smaller (no initial NV actually allocated) then the net
762 effect is to subtract the size of the NV from the pointer, to return a
763 new pointer as if an initial NV were actually allocated.
765 This is the same trick as was used for NV and IV bodies. Ironically it
766 doesn't need to be used for NV bodies any more, because NV is now at
767 the start of the structure. IV bodies don't need it either, because
768 they are no longer allocated.
770 In turn, the new_body_* allocators call S_new_body(), which invokes
771 new_body_inline macro, which takes a lock, and takes a body off the
772 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
773 necessary to refresh an empty list. Then the lock is released, and
774 the body is returned.
776 S_more_bodies calls get_arena(), and carves it up into an array of N
777 bodies, which it strings into a linked list. It looks up arena-size
778 and body-size from the body_details table described below, thus
779 supporting the multiple body-types.
781 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
782 the (new|del)_X*V macros are mapped directly to malloc/free.
788 For each sv-type, struct body_details bodies_by_type[] carries
789 parameters which control these aspects of SV handling:
791 Arena_size determines whether arenas are used for this body type, and if
792 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
793 zero, forcing individual mallocs and frees.
795 Body_size determines how big a body is, and therefore how many fit into
796 each arena. Offset carries the body-pointer adjustment needed for
797 *_allocated body types, and is used in *_allocated macros.
799 But its main purpose is to parameterize info needed in
800 Perl_sv_upgrade(). The info here dramatically simplifies the function
801 vs the implementation in 5.8.7, making it table-driven. All fields
802 are used for this, except for arena_size.
804 For the sv-types that have no bodies, arenas are not used, so those
805 PL_body_roots[sv_type] are unused, and can be overloaded. In
806 something of a special case, SVt_NULL is borrowed for HE arenas;
807 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
808 bodies_by_type[SVt_NULL] slot is not used, as the table is not
811 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
812 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
813 they can just use the same allocation semantics. At first, PTEs were
814 also overloaded to a non-body sv-type, but this yielded hard-to-find
815 malloc bugs, so was simplified by claiming a new slot. This choice
816 has no consequence at this time.
820 struct body_details {
821 U8 body_size; /* Size to allocate */
822 U8 copy; /* Size of structure to copy (may be shorter) */
824 unsigned int type : 4; /* We have space for a sanity check. */
825 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
826 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
827 unsigned int arena : 1; /* Allocated from an arena */
828 size_t arena_size; /* Size of arena to allocate */
836 /* With -DPURFIY we allocate everything directly, and don't use arenas.
837 This seems a rather elegant way to simplify some of the code below. */
838 #define HASARENA FALSE
840 #define HASARENA TRUE
842 #define NOARENA FALSE
844 /* Size the arenas to exactly fit a given number of bodies. A count
845 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
846 simplifying the default. If count > 0, the arena is sized to fit
847 only that many bodies, allowing arenas to be used for large, rare
848 bodies (XPVFM, XPVIO) without undue waste. The arena size is
849 limited by PERL_ARENA_SIZE, so we can safely oversize the
852 #define FIT_ARENA0(body_size) \
853 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
854 #define FIT_ARENAn(count,body_size) \
855 ( count * body_size <= PERL_ARENA_SIZE) \
856 ? count * body_size \
857 : FIT_ARENA0 (body_size)
858 #define FIT_ARENA(count,body_size) \
860 ? FIT_ARENAn (count, body_size) \
861 : FIT_ARENA0 (body_size)
863 /* A macro to work out the offset needed to subtract from a pointer to (say)
870 to make its members accessible via a pointer to (say)
880 #define relative_STRUCT_OFFSET(longer, shorter, member) \
881 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
883 /* Calculate the length to copy. Specifically work out the length less any
884 final padding the compiler needed to add. See the comment in sv_upgrade
885 for why copying the padding proved to be a bug. */
887 #define copy_length(type, last_member) \
888 STRUCT_OFFSET(type, last_member) \
889 + sizeof (((type*)SvANY((SV*)0))->last_member)
891 static const struct body_details bodies_by_type[] = {
892 { sizeof(HE), 0, 0, SVt_NULL,
893 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
895 /* The bind placeholder pretends to be an RV for now.
896 Also it's marked as "can't upgrade" top stop anyone using it before it's
898 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
900 /* IVs are in the head, so the allocation size is 0.
901 However, the slot is overloaded for PTEs. */
902 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
903 sizeof(IV), /* This is used to copy out the IV body. */
904 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
905 NOARENA /* IVS don't need an arena */,
906 /* But PTEs need to know the size of their arena */
907 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
910 /* 8 bytes on most ILP32 with IEEE doubles */
911 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
912 FIT_ARENA(0, sizeof(NV)) },
914 /* RVs are in the head now. */
915 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
917 /* 8 bytes on most ILP32 with IEEE doubles */
918 { sizeof(xpv_allocated),
919 copy_length(XPV, xpv_len)
920 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
921 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
922 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
925 { sizeof(xpviv_allocated),
926 copy_length(XPVIV, xiv_u)
927 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
928 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
929 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
932 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
933 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
936 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
937 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
940 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
944 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
945 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
947 { sizeof(xpvav_allocated),
948 copy_length(XPVAV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
953 { sizeof(xpvhv_allocated),
954 copy_length(XPVHV, xmg_stash)
955 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
960 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
961 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
962 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
964 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
965 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
966 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
968 /* XPVIO is 84 bytes, fits 48x */
969 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
970 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
973 #define new_body_type(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ sv_type))
976 #define del_body_type(p, sv_type) \
977 del_body(p, &PL_body_roots[sv_type])
980 #define new_body_allocated(sv_type) \
981 (void *)((char *)S_new_body(aTHX_ sv_type) \
982 - bodies_by_type[sv_type].offset)
984 #define del_body_allocated(p, sv_type) \
985 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
988 #define my_safemalloc(s) (void*)safemalloc(s)
989 #define my_safecalloc(s) (void*)safecalloc(s, 1)
990 #define my_safefree(p) safefree((char*)p)
994 #define new_XNV() my_safemalloc(sizeof(XPVNV))
995 #define del_XNV(p) my_safefree(p)
997 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
998 #define del_XPVNV(p) my_safefree(p)
1000 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1001 #define del_XPVAV(p) my_safefree(p)
1003 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1004 #define del_XPVHV(p) my_safefree(p)
1006 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1007 #define del_XPVMG(p) my_safefree(p)
1009 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1010 #define del_XPVGV(p) my_safefree(p)
1014 #define new_XNV() new_body_type(SVt_NV)
1015 #define del_XNV(p) del_body_type(p, SVt_NV)
1017 #define new_XPVNV() new_body_type(SVt_PVNV)
1018 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1020 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1021 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1023 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1024 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1026 #define new_XPVMG() new_body_type(SVt_PVMG)
1027 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1029 #define new_XPVGV() new_body_type(SVt_PVGV)
1030 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1034 /* no arena for you! */
1036 #define new_NOARENA(details) \
1037 my_safemalloc((details)->body_size + (details)->offset)
1038 #define new_NOARENAZ(details) \
1039 my_safecalloc((details)->body_size + (details)->offset)
1042 S_more_bodies (pTHX_ svtype sv_type)
1045 void ** const root = &PL_body_roots[sv_type];
1046 const struct body_details * const bdp = &bodies_by_type[sv_type];
1047 const size_t body_size = bdp->body_size;
1050 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1051 static bool done_sanity_check;
1053 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1054 * variables like done_sanity_check. */
1055 if (!done_sanity_check) {
1056 unsigned int i = SVt_LAST;
1058 done_sanity_check = TRUE;
1061 assert (bodies_by_type[i].type == i);
1065 assert(bdp->arena_size);
1067 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1069 end = start + bdp->arena_size - body_size;
1071 /* computed count doesnt reflect the 1st slot reservation */
1072 DEBUG_m(PerlIO_printf(Perl_debug_log,
1073 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1074 (void*)start, (void*)end,
1075 (int)bdp->arena_size, sv_type, (int)body_size,
1076 (int)bdp->arena_size / (int)body_size));
1078 *root = (void *)start;
1080 while (start < end) {
1081 char * const next = start + body_size;
1082 *(void**) start = (void *)next;
1085 *(void **)start = 0;
1090 /* grab a new thing from the free list, allocating more if necessary.
1091 The inline version is used for speed in hot routines, and the
1092 function using it serves the rest (unless PURIFY).
1094 #define new_body_inline(xpv, sv_type) \
1096 void ** const r3wt = &PL_body_roots[sv_type]; \
1098 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1099 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1100 *(r3wt) = *(void**)(xpv); \
1107 S_new_body(pTHX_ svtype sv_type)
1111 new_body_inline(xpv, sv_type);
1118 =for apidoc sv_upgrade
1120 Upgrade an SV to a more complex form. Generally adds a new body type to the
1121 SV, then copies across as much information as possible from the old body.
1122 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1128 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1133 const svtype old_type = SvTYPE(sv);
1134 const struct body_details *new_type_details;
1135 const struct body_details *const old_type_details
1136 = bodies_by_type + old_type;
1138 if (new_type != SVt_PV && SvIsCOW(sv)) {
1139 sv_force_normal_flags(sv, 0);
1142 if (old_type == new_type)
1145 if (old_type > new_type)
1146 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1147 (int)old_type, (int)new_type);
1150 old_body = SvANY(sv);
1152 /* Copying structures onto other structures that have been neatly zeroed
1153 has a subtle gotcha. Consider XPVMG
1155 +------+------+------+------+------+-------+-------+
1156 | NV | CUR | LEN | IV | MAGIC | STASH |
1157 +------+------+------+------+------+-------+-------+
1158 0 4 8 12 16 20 24 28
1160 where NVs are aligned to 8 bytes, so that sizeof that structure is
1161 actually 32 bytes long, with 4 bytes of padding at the end:
1163 +------+------+------+------+------+-------+-------+------+
1164 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1165 +------+------+------+------+------+-------+-------+------+
1166 0 4 8 12 16 20 24 28 32
1168 so what happens if you allocate memory for this structure:
1170 +------+------+------+------+------+-------+-------+------+------+...
1171 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1172 +------+------+------+------+------+-------+-------+------+------+...
1173 0 4 8 12 16 20 24 28 32 36
1175 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1176 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1177 started out as zero once, but it's quite possible that it isn't. So now,
1178 rather than a nicely zeroed GP, you have it pointing somewhere random.
1181 (In fact, GP ends up pointing at a previous GP structure, because the
1182 principle cause of the padding in XPVMG getting garbage is a copy of
1183 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1184 this happens to be moot because XPVGV has been re-ordered, with GP
1185 no longer after STASH)
1187 So we are careful and work out the size of used parts of all the
1194 if (new_type < SVt_PVIV) {
1195 new_type = (new_type == SVt_NV)
1196 ? SVt_PVNV : SVt_PVIV;
1200 if (new_type < SVt_PVNV) {
1201 new_type = SVt_PVNV;
1207 assert(new_type > SVt_PV);
1208 assert(SVt_IV < SVt_PV);
1209 assert(SVt_NV < SVt_PV);
1216 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1217 there's no way that it can be safely upgraded, because perl.c
1218 expects to Safefree(SvANY(PL_mess_sv)) */
1219 assert(sv != PL_mess_sv);
1220 /* This flag bit is used to mean other things in other scalar types.
1221 Given that it only has meaning inside the pad, it shouldn't be set
1222 on anything that can get upgraded. */
1223 assert(!SvPAD_TYPED(sv));
1226 if (old_type_details->cant_upgrade)
1227 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1228 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1230 new_type_details = bodies_by_type + new_type;
1232 SvFLAGS(sv) &= ~SVTYPEMASK;
1233 SvFLAGS(sv) |= new_type;
1235 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1236 the return statements above will have triggered. */
1237 assert (new_type != SVt_NULL);
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = new_XNV();
1250 assert(old_type == SVt_NULL);
1251 SvANY(sv) = &sv->sv_u.svu_rv;
1256 assert(new_type_details->body_size);
1259 assert(new_type_details->arena);
1260 assert(new_type_details->arena_size);
1261 /* This points to the start of the allocated area. */
1262 new_body_inline(new_body, new_type);
1263 Zero(new_body, new_type_details->body_size, char);
1264 new_body = ((char *)new_body) - new_type_details->offset;
1266 /* We always allocated the full length item with PURIFY. To do this
1267 we fake things so that arena is false for all 16 types.. */
1268 new_body = new_NOARENAZ(new_type_details);
1270 SvANY(sv) = new_body;
1271 if (new_type == SVt_PVAV) {
1277 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1278 The target created by newSVrv also is, and it can have magic.
1279 However, it never has SvPVX set.
1281 if (old_type >= SVt_RV) {
1282 assert(SvPVX_const(sv) == 0);
1285 if (old_type >= SVt_PVMG) {
1286 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1287 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1289 sv->sv_u.svu_array = NULL; /* or svu_hash */
1295 /* XXX Is this still needed? Was it ever needed? Surely as there is
1296 no route from NV to PVIV, NOK can never be true */
1297 assert(!SvNOKp(sv));
1308 assert(new_type_details->body_size);
1309 /* We always allocated the full length item with PURIFY. To do this
1310 we fake things so that arena is false for all 16 types.. */
1311 if(new_type_details->arena) {
1312 /* This points to the start of the allocated area. */
1313 new_body_inline(new_body, new_type);
1314 Zero(new_body, new_type_details->body_size, char);
1315 new_body = ((char *)new_body) - new_type_details->offset;
1317 new_body = new_NOARENAZ(new_type_details);
1319 SvANY(sv) = new_body;
1321 if (old_type_details->copy) {
1322 /* There is now the potential for an upgrade from something without
1323 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1324 int offset = old_type_details->offset;
1325 int length = old_type_details->copy;
1327 if (new_type_details->offset > old_type_details->offset) {
1328 const int difference
1329 = new_type_details->offset - old_type_details->offset;
1330 offset += difference;
1331 length -= difference;
1333 assert (length >= 0);
1335 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1339 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1340 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1341 * correct 0.0 for us. Otherwise, if the old body didn't have an
1342 * NV slot, but the new one does, then we need to initialise the
1343 * freshly created NV slot with whatever the correct bit pattern is
1345 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1349 if (new_type == SVt_PVIO)
1350 IoPAGE_LEN(sv) = 60;
1351 if (old_type < SVt_RV)
1355 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1356 (unsigned long)new_type);
1359 if (old_type_details->arena) {
1360 /* If there was an old body, then we need to free it.
1361 Note that there is an assumption that all bodies of types that
1362 can be upgraded came from arenas. Only the more complex non-
1363 upgradable types are allowed to be directly malloc()ed. */
1365 my_safefree(old_body);
1367 del_body((void*)((char*)old_body + old_type_details->offset),
1368 &PL_body_roots[old_type]);
1374 =for apidoc sv_backoff
1376 Remove any string offset. You should normally use the C<SvOOK_off> macro
1383 Perl_sv_backoff(pTHX_ register SV *sv)
1385 PERL_UNUSED_CONTEXT;
1387 assert(SvTYPE(sv) != SVt_PVHV);
1388 assert(SvTYPE(sv) != SVt_PVAV);
1390 const char * const s = SvPVX_const(sv);
1391 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1392 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1394 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1396 SvFLAGS(sv) &= ~SVf_OOK;
1403 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1404 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1405 Use the C<SvGROW> wrapper instead.
1411 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1415 if (PL_madskills && newlen >= 0x100000) {
1416 PerlIO_printf(Perl_debug_log,
1417 "Allocation too large: %"UVxf"\n", (UV)newlen);
1419 #ifdef HAS_64K_LIMIT
1420 if (newlen >= 0x10000) {
1421 PerlIO_printf(Perl_debug_log,
1422 "Allocation too large: %"UVxf"\n", (UV)newlen);
1425 #endif /* HAS_64K_LIMIT */
1428 if (SvTYPE(sv) < SVt_PV) {
1429 sv_upgrade(sv, SVt_PV);
1430 s = SvPVX_mutable(sv);
1432 else if (SvOOK(sv)) { /* pv is offset? */
1434 s = SvPVX_mutable(sv);
1435 if (newlen > SvLEN(sv))
1436 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1437 #ifdef HAS_64K_LIMIT
1438 if (newlen >= 0x10000)
1443 s = SvPVX_mutable(sv);
1445 if (newlen > SvLEN(sv)) { /* need more room? */
1446 newlen = PERL_STRLEN_ROUNDUP(newlen);
1447 if (SvLEN(sv) && s) {
1449 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1455 s = (char*)saferealloc(s, newlen);
1458 s = (char*)safemalloc(newlen);
1459 if (SvPVX_const(sv) && SvCUR(sv)) {
1460 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1464 SvLEN_set(sv, newlen);
1470 =for apidoc sv_setiv
1472 Copies an integer into the given SV, upgrading first if necessary.
1473 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1479 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1482 SV_CHECK_THINKFIRST_COW_DROP(sv);
1483 switch (SvTYPE(sv)) {
1485 sv_upgrade(sv, SVt_IV);
1488 sv_upgrade(sv, SVt_PVNV);
1492 sv_upgrade(sv, SVt_PVIV);
1501 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1505 (void)SvIOK_only(sv); /* validate number */
1511 =for apidoc sv_setiv_mg
1513 Like C<sv_setiv>, but also handles 'set' magic.
1519 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1526 =for apidoc sv_setuv
1528 Copies an unsigned integer into the given SV, upgrading first if necessary.
1529 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1535 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1537 /* With these two if statements:
1538 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1541 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1543 If you wish to remove them, please benchmark to see what the effect is
1545 if (u <= (UV)IV_MAX) {
1546 sv_setiv(sv, (IV)u);
1555 =for apidoc sv_setuv_mg
1557 Like C<sv_setuv>, but also handles 'set' magic.
1563 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1855 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));
1856 if (SvNVX(sv) < (NV)IV_MIN) {
1857 (void)SvIOKp_on(sv);
1859 SvIV_set(sv, IV_MIN);
1860 return IS_NUMBER_UNDERFLOW_IV;
1862 if (SvNVX(sv) > (NV)UV_MAX) {
1863 (void)SvIOKp_on(sv);
1866 SvUV_set(sv, UV_MAX);
1867 return IS_NUMBER_OVERFLOW_UV;
1869 (void)SvIOKp_on(sv);
1871 /* Can't use strtol etc to convert this string. (See truth table in
1873 if (SvNVX(sv) <= (UV)IV_MAX) {
1874 SvIV_set(sv, I_V(SvNVX(sv)));
1875 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1876 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1878 /* Integer is imprecise. NOK, IOKp */
1880 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1883 SvUV_set(sv, U_V(SvNVX(sv)));
1884 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1885 if (SvUVX(sv) == UV_MAX) {
1886 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1887 possibly be preserved by NV. Hence, it must be overflow.
1889 return IS_NUMBER_OVERFLOW_UV;
1891 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1893 /* Integer is imprecise. NOK, IOKp */
1895 return IS_NUMBER_OVERFLOW_IV;
1897 #endif /* !NV_PRESERVES_UV*/
1900 S_sv_2iuv_common(pTHX_ SV *sv) {
1903 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1904 * without also getting a cached IV/UV from it at the same time
1905 * (ie PV->NV conversion should detect loss of accuracy and cache
1906 * IV or UV at same time to avoid this. */
1907 /* IV-over-UV optimisation - choose to cache IV if possible */
1909 if (SvTYPE(sv) == SVt_NV)
1910 sv_upgrade(sv, SVt_PVNV);
1912 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1913 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1914 certainly cast into the IV range at IV_MAX, whereas the correct
1915 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1917 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1918 if (Perl_isnan(SvNVX(sv))) {
1924 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1925 SvIV_set(sv, I_V(SvNVX(sv)));
1926 if (SvNVX(sv) == (NV) SvIVX(sv)
1927 #ifndef NV_PRESERVES_UV
1928 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1929 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1930 /* Don't flag it as "accurately an integer" if the number
1931 came from a (by definition imprecise) NV operation, and
1932 we're outside the range of NV integer precision */
1935 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1943 /* IV not precise. No need to convert from PV, as NV
1944 conversion would already have cached IV if it detected
1945 that PV->IV would be better than PV->NV->IV
1946 flags already correct - don't set public IOK. */
1947 DEBUG_c(PerlIO_printf(Perl_debug_log,
1948 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1953 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1954 but the cast (NV)IV_MIN rounds to a the value less (more
1955 negative) than IV_MIN which happens to be equal to SvNVX ??
1956 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1957 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1958 (NV)UVX == NVX are both true, but the values differ. :-(
1959 Hopefully for 2s complement IV_MIN is something like
1960 0x8000000000000000 which will be exact. NWC */
1963 SvUV_set(sv, U_V(SvNVX(sv)));
1965 (SvNVX(sv) == (NV) SvUVX(sv))
1966 #ifndef NV_PRESERVES_UV
1967 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1968 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1969 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1970 /* Don't flag it as "accurately an integer" if the number
1971 came from a (by definition imprecise) NV operation, and
1972 we're outside the range of NV integer precision */
1977 DEBUG_c(PerlIO_printf(Perl_debug_log,
1978 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1984 else if (SvPOKp(sv) && SvLEN(sv)) {
1986 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1987 /* We want to avoid a possible problem when we cache an IV/ a UV which
1988 may be later translated to an NV, and the resulting NV is not
1989 the same as the direct translation of the initial string
1990 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1991 be careful to ensure that the value with the .456 is around if the
1992 NV value is requested in the future).
1994 This means that if we cache such an IV/a UV, we need to cache the
1995 NV as well. Moreover, we trade speed for space, and do not
1996 cache the NV if we are sure it's not needed.
1999 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2000 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2001 == IS_NUMBER_IN_UV) {
2002 /* It's definitely an integer, only upgrade to PVIV */
2003 if (SvTYPE(sv) < SVt_PVIV)
2004 sv_upgrade(sv, SVt_PVIV);
2006 } else if (SvTYPE(sv) < SVt_PVNV)
2007 sv_upgrade(sv, SVt_PVNV);
2009 /* If NVs preserve UVs then we only use the UV value if we know that
2010 we aren't going to call atof() below. If NVs don't preserve UVs
2011 then the value returned may have more precision than atof() will
2012 return, even though value isn't perfectly accurate. */
2013 if ((numtype & (IS_NUMBER_IN_UV
2014 #ifdef NV_PRESERVES_UV
2017 )) == IS_NUMBER_IN_UV) {
2018 /* This won't turn off the public IOK flag if it was set above */
2019 (void)SvIOKp_on(sv);
2021 if (!(numtype & IS_NUMBER_NEG)) {
2023 if (value <= (UV)IV_MAX) {
2024 SvIV_set(sv, (IV)value);
2026 /* it didn't overflow, and it was positive. */
2027 SvUV_set(sv, value);
2031 /* 2s complement assumption */
2032 if (value <= (UV)IV_MIN) {
2033 SvIV_set(sv, -(IV)value);
2035 /* Too negative for an IV. This is a double upgrade, but
2036 I'm assuming it will be rare. */
2037 if (SvTYPE(sv) < SVt_PVNV)
2038 sv_upgrade(sv, SVt_PVNV);
2042 SvNV_set(sv, -(NV)value);
2043 SvIV_set(sv, IV_MIN);
2047 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2048 will be in the previous block to set the IV slot, and the next
2049 block to set the NV slot. So no else here. */
2051 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2052 != IS_NUMBER_IN_UV) {
2053 /* It wasn't an (integer that doesn't overflow the UV). */
2054 SvNV_set(sv, Atof(SvPVX_const(sv)));
2056 if (! numtype && ckWARN(WARN_NUMERIC))
2059 #if defined(USE_LONG_DOUBLE)
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2067 #ifdef NV_PRESERVES_UV
2068 (void)SvIOKp_on(sv);
2070 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2071 SvIV_set(sv, I_V(SvNVX(sv)));
2072 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2075 NOOP; /* Integer is imprecise. NOK, IOKp */
2077 /* UV will not work better than IV */
2079 if (SvNVX(sv) > (NV)UV_MAX) {
2081 /* Integer is inaccurate. NOK, IOKp, is UV */
2082 SvUV_set(sv, UV_MAX);
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2085 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2086 NV preservse UV so can do correct comparison. */
2087 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2090 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2095 #else /* NV_PRESERVES_UV */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2098 /* The IV/UV slot will have been set from value returned by
2099 grok_number above. The NV slot has just been set using
2102 assert (SvIOKp(sv));
2104 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2105 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2106 /* Small enough to preserve all bits. */
2107 (void)SvIOKp_on(sv);
2109 SvIV_set(sv, I_V(SvNVX(sv)));
2110 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2112 /* Assumption: first non-preserved integer is < IV_MAX,
2113 this NV is in the preserved range, therefore: */
2114 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2116 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);
2120 0 0 already failed to read UV.
2121 0 1 already failed to read UV.
2122 1 0 you won't get here in this case. IV/UV
2123 slot set, public IOK, Atof() unneeded.
2124 1 1 already read UV.
2125 so there's no point in sv_2iuv_non_preserve() attempting
2126 to use atol, strtol, strtoul etc. */
2127 sv_2iuv_non_preserve (sv, numtype);
2130 #endif /* NV_PRESERVES_UV */
2134 if (isGV_with_GP(sv))
2135 return glob_2number((GV *)sv);
2137 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2138 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2141 if (SvTYPE(sv) < SVt_IV)
2142 /* Typically the caller expects that sv_any is not NULL now. */
2143 sv_upgrade(sv, SVt_IV);
2144 /* Return 0 from the caller. */
2151 =for apidoc sv_2iv_flags
2153 Return the integer value of an SV, doing any necessary string
2154 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2155 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2161 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2166 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2167 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2168 cache IVs just in case. In practice it seems that they never
2169 actually anywhere accessible by user Perl code, let alone get used
2170 in anything other than a string context. */
2171 if (flags & SV_GMAGIC)
2176 return I_V(SvNVX(sv));
2178 if (SvPOKp(sv) && SvLEN(sv)) {
2181 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2183 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2184 == IS_NUMBER_IN_UV) {
2185 /* It's definitely an integer */
2186 if (numtype & IS_NUMBER_NEG) {
2187 if (value < (UV)IV_MIN)
2190 if (value < (UV)IV_MAX)
2195 if (ckWARN(WARN_NUMERIC))
2198 return I_V(Atof(SvPVX_const(sv)));
2203 assert(SvTYPE(sv) >= SVt_PVMG);
2204 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2205 } else if (SvTHINKFIRST(sv)) {
2209 SV * const tmpstr=AMG_CALLun(sv,numer);
2210 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2211 return SvIV(tmpstr);
2214 return PTR2IV(SvRV(sv));
2217 sv_force_normal_flags(sv, 0);
2219 if (SvREADONLY(sv) && !SvOK(sv)) {
2220 if (ckWARN(WARN_UNINITIALIZED))
2226 if (S_sv_2iuv_common(aTHX_ sv))
2229 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2230 PTR2UV(sv),SvIVX(sv)));
2231 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2235 =for apidoc sv_2uv_flags
2237 Return the unsigned integer value of an SV, doing any necessary string
2238 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2239 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2245 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2250 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2251 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2252 cache IVs just in case. */
2253 if (flags & SV_GMAGIC)
2258 return U_V(SvNVX(sv));
2259 if (SvPOKp(sv) && SvLEN(sv)) {
2262 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2264 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2265 == IS_NUMBER_IN_UV) {
2266 /* It's definitely an integer */
2267 if (!(numtype & IS_NUMBER_NEG))
2271 if (ckWARN(WARN_NUMERIC))
2274 return U_V(Atof(SvPVX_const(sv)));
2279 assert(SvTYPE(sv) >= SVt_PVMG);
2280 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2281 } else if (SvTHINKFIRST(sv)) {
2285 SV *const tmpstr = AMG_CALLun(sv,numer);
2286 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2287 return SvUV(tmpstr);
2290 return PTR2UV(SvRV(sv));
2293 sv_force_normal_flags(sv, 0);
2295 if (SvREADONLY(sv) && !SvOK(sv)) {
2296 if (ckWARN(WARN_UNINITIALIZED))
2302 if (S_sv_2iuv_common(aTHX_ sv))
2306 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2307 PTR2UV(sv),SvUVX(sv)));
2308 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2314 Return the num value of an SV, doing any necessary string or integer
2315 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2322 Perl_sv_2nv(pTHX_ register SV *sv)
2327 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2328 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2329 cache IVs just in case. */
2333 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2334 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2335 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2337 return Atof(SvPVX_const(sv));
2341 return (NV)SvUVX(sv);
2343 return (NV)SvIVX(sv);
2348 assert(SvTYPE(sv) >= SVt_PVMG);
2349 /* This falls through to the report_uninit near the end of the
2351 } else if (SvTHINKFIRST(sv)) {
2355 SV *const tmpstr = AMG_CALLun(sv,numer);
2356 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2357 return SvNV(tmpstr);
2360 return PTR2NV(SvRV(sv));
2363 sv_force_normal_flags(sv, 0);
2365 if (SvREADONLY(sv) && !SvOK(sv)) {
2366 if (ckWARN(WARN_UNINITIALIZED))
2371 if (SvTYPE(sv) < SVt_NV) {
2372 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2373 sv_upgrade(sv, SVt_NV);
2374 #ifdef USE_LONG_DOUBLE
2376 STORE_NUMERIC_LOCAL_SET_STANDARD();
2377 PerlIO_printf(Perl_debug_log,
2378 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2379 PTR2UV(sv), SvNVX(sv));
2380 RESTORE_NUMERIC_LOCAL();
2384 STORE_NUMERIC_LOCAL_SET_STANDARD();
2385 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2386 PTR2UV(sv), SvNVX(sv));
2387 RESTORE_NUMERIC_LOCAL();
2391 else if (SvTYPE(sv) < SVt_PVNV)
2392 sv_upgrade(sv, SVt_PVNV);
2397 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2398 #ifdef NV_PRESERVES_UV
2401 /* Only set the public NV OK flag if this NV preserves the IV */
2402 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2403 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2404 : (SvIVX(sv) == I_V(SvNVX(sv))))
2410 else if (SvPOKp(sv) && SvLEN(sv)) {
2412 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2413 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2415 #ifdef NV_PRESERVES_UV
2416 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2417 == IS_NUMBER_IN_UV) {
2418 /* It's definitely an integer */
2419 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2421 SvNV_set(sv, Atof(SvPVX_const(sv)));
2424 SvNV_set(sv, Atof(SvPVX_const(sv)));
2425 /* Only set the public NV OK flag if this NV preserves the value in
2426 the PV at least as well as an IV/UV would.
2427 Not sure how to do this 100% reliably. */
2428 /* if that shift count is out of range then Configure's test is
2429 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2431 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2432 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2433 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2434 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2435 /* Can't use strtol etc to convert this string, so don't try.
2436 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2439 /* value has been set. It may not be precise. */
2440 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2441 /* 2s complement assumption for (UV)IV_MIN */
2442 SvNOK_on(sv); /* Integer is too negative. */
2447 if (numtype & IS_NUMBER_NEG) {
2448 SvIV_set(sv, -(IV)value);
2449 } else if (value <= (UV)IV_MAX) {
2450 SvIV_set(sv, (IV)value);
2452 SvUV_set(sv, value);
2456 if (numtype & IS_NUMBER_NOT_INT) {
2457 /* I believe that even if the original PV had decimals,
2458 they are lost beyond the limit of the FP precision.
2459 However, neither is canonical, so both only get p
2460 flags. NWC, 2000/11/25 */
2461 /* Both already have p flags, so do nothing */
2463 const NV nv = SvNVX(sv);
2464 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2465 if (SvIVX(sv) == I_V(nv)) {
2468 /* It had no "." so it must be integer. */
2472 /* between IV_MAX and NV(UV_MAX).
2473 Could be slightly > UV_MAX */
2475 if (numtype & IS_NUMBER_NOT_INT) {
2476 /* UV and NV both imprecise. */
2478 const UV nv_as_uv = U_V(nv);
2480 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2489 #endif /* NV_PRESERVES_UV */
2492 if (isGV_with_GP(sv)) {
2493 glob_2number((GV *)sv);
2497 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2499 assert (SvTYPE(sv) >= SVt_NV);
2500 /* Typically the caller expects that sv_any is not NULL now. */
2501 /* XXX Ilya implies that this is a bug in callers that assume this
2502 and ideally should be fixed. */
2505 #if defined(USE_LONG_DOUBLE)
2507 STORE_NUMERIC_LOCAL_SET_STANDARD();
2508 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2509 PTR2UV(sv), SvNVX(sv));
2510 RESTORE_NUMERIC_LOCAL();
2514 STORE_NUMERIC_LOCAL_SET_STANDARD();
2515 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2516 PTR2UV(sv), SvNVX(sv));
2517 RESTORE_NUMERIC_LOCAL();
2523 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2524 * UV as a string towards the end of buf, and return pointers to start and
2527 * We assume that buf is at least TYPE_CHARS(UV) long.
2531 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2533 char *ptr = buf + TYPE_CHARS(UV);
2534 char * const ebuf = ptr;
2547 *--ptr = '0' + (char)(uv % 10);
2556 =for apidoc sv_2pv_flags
2558 Returns a pointer to the string value of an SV, and sets *lp to its length.
2559 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2561 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2562 usually end up here too.
2568 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2578 if (SvGMAGICAL(sv)) {
2579 if (flags & SV_GMAGIC)
2584 if (flags & SV_MUTABLE_RETURN)
2585 return SvPVX_mutable(sv);
2586 if (flags & SV_CONST_RETURN)
2587 return (char *)SvPVX_const(sv);
2590 if (SvIOKp(sv) || SvNOKp(sv)) {
2591 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2596 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2597 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2599 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2606 #ifdef FIXNEGATIVEZERO
2607 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2613 SvUPGRADE(sv, SVt_PV);
2616 s = SvGROW_mutable(sv, len + 1);
2619 return (char*)memcpy(s, tbuf, len + 1);
2625 assert(SvTYPE(sv) >= SVt_PVMG);
2626 /* This falls through to the report_uninit near the end of the
2628 } else if (SvTHINKFIRST(sv)) {
2632 SV *const tmpstr = AMG_CALLun(sv,string);
2633 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2635 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2639 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2640 if (flags & SV_CONST_RETURN) {
2641 pv = (char *) SvPVX_const(tmpstr);
2643 pv = (flags & SV_MUTABLE_RETURN)
2644 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2647 *lp = SvCUR(tmpstr);
2649 pv = sv_2pv_flags(tmpstr, lp, flags);
2663 const SV *const referent = (SV*)SvRV(sv);
2667 retval = buffer = savepvn("NULLREF", len);
2668 } else if (SvTYPE(referent) == SVt_PVMG
2669 && ((SvFLAGS(referent) &
2670 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2671 == (SVs_OBJECT|SVs_SMG))
2672 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2677 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2682 PL_reginterp_cnt += haseval;
2685 const char *const typestr = sv_reftype(referent, 0);
2686 const STRLEN typelen = strlen(typestr);
2687 UV addr = PTR2UV(referent);
2688 const char *stashname = NULL;
2689 STRLEN stashnamelen = 0; /* hush, gcc */
2690 const char *buffer_end;
2692 if (SvOBJECT(referent)) {
2693 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2696 stashname = HEK_KEY(name);
2697 stashnamelen = HEK_LEN(name);
2699 if (HEK_UTF8(name)) {
2705 stashname = "__ANON__";
2708 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2709 + 2 * sizeof(UV) + 2 /* )\0 */;
2711 len = typelen + 3 /* (0x */
2712 + 2 * sizeof(UV) + 2 /* )\0 */;
2715 Newx(buffer, len, char);
2716 buffer_end = retval = buffer + len;
2718 /* Working backwards */
2722 *--retval = PL_hexdigit[addr & 15];
2723 } while (addr >>= 4);
2729 memcpy(retval, typestr, typelen);
2733 retval -= stashnamelen;
2734 memcpy(retval, stashname, stashnamelen);
2736 /* retval may not neccesarily have reached the start of the
2738 assert (retval >= buffer);
2740 len = buffer_end - retval - 1; /* -1 for that \0 */
2748 if (SvREADONLY(sv) && !SvOK(sv)) {
2749 if (ckWARN(WARN_UNINITIALIZED))
2756 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2757 /* I'm assuming that if both IV and NV are equally valid then
2758 converting the IV is going to be more efficient */
2759 const U32 isUIOK = SvIsUV(sv);
2760 char buf[TYPE_CHARS(UV)];
2763 if (SvTYPE(sv) < SVt_PVIV)
2764 sv_upgrade(sv, SVt_PVIV);
2765 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2766 /* inlined from sv_setpvn */
2767 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2768 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2769 SvCUR_set(sv, ebuf - ptr);
2773 else if (SvNOKp(sv)) {
2774 const int olderrno = errno;
2775 if (SvTYPE(sv) < SVt_PVNV)
2776 sv_upgrade(sv, SVt_PVNV);
2777 /* The +20 is pure guesswork. Configure test needed. --jhi */
2778 s = SvGROW_mutable(sv, NV_DIG + 20);
2779 /* some Xenix systems wipe out errno here */
2781 if (SvNVX(sv) == 0.0)
2782 my_strlcpy(s, "0", SvLEN(sv));
2786 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2789 #ifdef FIXNEGATIVEZERO
2790 if (*s == '-' && s[1] == '0' && !s[2])
2791 my_strlcpy(s, "0", SvLEN(s));
2800 if (isGV_with_GP(sv))
2801 return glob_2pv((GV *)sv, lp);
2803 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2807 if (SvTYPE(sv) < SVt_PV)
2808 /* Typically the caller expects that sv_any is not NULL now. */
2809 sv_upgrade(sv, SVt_PV);
2813 const STRLEN len = s - SvPVX_const(sv);
2819 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2820 PTR2UV(sv),SvPVX_const(sv)));
2821 if (flags & SV_CONST_RETURN)
2822 return (char *)SvPVX_const(sv);
2823 if (flags & SV_MUTABLE_RETURN)
2824 return SvPVX_mutable(sv);
2829 =for apidoc sv_copypv
2831 Copies a stringified representation of the source SV into the
2832 destination SV. Automatically performs any necessary mg_get and
2833 coercion of numeric values into strings. Guaranteed to preserve
2834 UTF-8 flag even from overloaded objects. Similar in nature to
2835 sv_2pv[_flags] but operates directly on an SV instead of just the
2836 string. Mostly uses sv_2pv_flags to do its work, except when that
2837 would lose the UTF-8'ness of the PV.
2843 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2846 const char * const s = SvPV_const(ssv,len);
2847 sv_setpvn(dsv,s,len);
2855 =for apidoc sv_2pvbyte
2857 Return a pointer to the byte-encoded representation of the SV, and set *lp
2858 to its length. May cause the SV to be downgraded from UTF-8 as a
2861 Usually accessed via the C<SvPVbyte> macro.
2867 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2869 sv_utf8_downgrade(sv,0);
2870 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2874 =for apidoc sv_2pvutf8
2876 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2877 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2879 Usually accessed via the C<SvPVutf8> macro.
2885 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2887 sv_utf8_upgrade(sv);
2888 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2893 =for apidoc sv_2bool
2895 This function is only called on magical items, and is only used by
2896 sv_true() or its macro equivalent.
2902 Perl_sv_2bool(pTHX_ register SV *sv)
2911 SV * const tmpsv = AMG_CALLun(sv,bool_);
2912 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2913 return (bool)SvTRUE(tmpsv);
2915 return SvRV(sv) != 0;
2918 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2920 (*sv->sv_u.svu_pv > '0' ||
2921 Xpvtmp->xpv_cur > 1 ||
2922 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2929 return SvIVX(sv) != 0;
2932 return SvNVX(sv) != 0.0;
2934 if (isGV_with_GP(sv))
2944 =for apidoc sv_utf8_upgrade
2946 Converts the PV of an SV to its UTF-8-encoded form.
2947 Forces the SV to string form if it is not already.
2948 Always sets the SvUTF8 flag to avoid future validity checks even
2949 if all the bytes have hibit clear.
2951 This is not as a general purpose byte encoding to Unicode interface:
2952 use the Encode extension for that.
2954 =for apidoc sv_utf8_upgrade_flags
2956 Converts the PV of an SV to its UTF-8-encoded form.
2957 Forces the SV to string form if it is not already.
2958 Always sets the SvUTF8 flag to avoid future validity checks even
2959 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2960 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2961 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2963 This is not as a general purpose byte encoding to Unicode interface:
2964 use the Encode extension for that.
2970 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2973 if (sv == &PL_sv_undef)
2977 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2978 (void) sv_2pv_flags(sv,&len, flags);
2982 (void) SvPV_force(sv,len);
2991 sv_force_normal_flags(sv, 0);
2994 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2995 sv_recode_to_utf8(sv, PL_encoding);
2996 else { /* Assume Latin-1/EBCDIC */
2997 /* This function could be much more efficient if we
2998 * had a FLAG in SVs to signal if there are any hibit
2999 * chars in the PV. Given that there isn't such a flag
3000 * make the loop as fast as possible. */
3001 const U8 * const s = (U8 *) SvPVX_const(sv);
3002 const U8 * const e = (U8 *) SvEND(sv);
3007 /* Check for hi bit */
3008 if (!NATIVE_IS_INVARIANT(ch)) {
3009 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3010 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3012 SvPV_free(sv); /* No longer using what was there before. */
3013 SvPV_set(sv, (char*)recoded);
3014 SvCUR_set(sv, len - 1);
3015 SvLEN_set(sv, len); /* No longer know the real size. */
3019 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3026 =for apidoc sv_utf8_downgrade
3028 Attempts to convert the PV of an SV from characters to bytes.
3029 If the PV contains a character beyond byte, this conversion will fail;
3030 in this case, either returns false or, if C<fail_ok> is not
3033 This is not as a general purpose Unicode to byte encoding interface:
3034 use the Encode extension for that.
3040 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3043 if (SvPOKp(sv) && SvUTF8(sv)) {
3049 sv_force_normal_flags(sv, 0);
3051 s = (U8 *) SvPV(sv, len);
3052 if (!utf8_to_bytes(s, &len)) {
3057 Perl_croak(aTHX_ "Wide character in %s",
3060 Perl_croak(aTHX_ "Wide character");
3071 =for apidoc sv_utf8_encode
3073 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3074 flag off so that it looks like octets again.
3080 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3083 sv_force_normal_flags(sv, 0);
3085 if (SvREADONLY(sv)) {
3086 Perl_croak(aTHX_ PL_no_modify);
3088 (void) sv_utf8_upgrade(sv);
3093 =for apidoc sv_utf8_decode
3095 If the PV of the SV is an octet sequence in UTF-8
3096 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3097 so that it looks like a character. If the PV contains only single-byte
3098 characters, the C<SvUTF8> flag stays being off.
3099 Scans PV for validity and returns false if the PV is invalid UTF-8.
3105 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3111 /* The octets may have got themselves encoded - get them back as
3114 if (!sv_utf8_downgrade(sv, TRUE))
3117 /* it is actually just a matter of turning the utf8 flag on, but
3118 * we want to make sure everything inside is valid utf8 first.
3120 c = (const U8 *) SvPVX_const(sv);
3121 if (!is_utf8_string(c, SvCUR(sv)+1))
3123 e = (const U8 *) SvEND(sv);
3126 if (!UTF8_IS_INVARIANT(ch)) {
3136 =for apidoc sv_setsv
3138 Copies the contents of the source SV C<ssv> into the destination SV
3139 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3140 function if the source SV needs to be reused. Does not handle 'set' magic.
3141 Loosely speaking, it performs a copy-by-value, obliterating any previous
3142 content of the destination.
3144 You probably want to use one of the assortment of wrappers, such as
3145 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3146 C<SvSetMagicSV_nosteal>.
3148 =for apidoc sv_setsv_flags
3150 Copies the contents of the source SV C<ssv> into the destination SV
3151 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3152 function if the source SV needs to be reused. Does not handle 'set' magic.
3153 Loosely speaking, it performs a copy-by-value, obliterating any previous
3154 content of the destination.
3155 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3156 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3157 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3158 and C<sv_setsv_nomg> are implemented in terms of this function.
3160 You probably want to use one of the assortment of wrappers, such as
3161 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3162 C<SvSetMagicSV_nosteal>.
3164 This is the primary function for copying scalars, and most other
3165 copy-ish functions and macros use this underneath.
3171 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3173 if (dtype != SVt_PVGV) {
3174 const char * const name = GvNAME(sstr);
3175 const STRLEN len = GvNAMELEN(sstr);
3177 if (dtype >= SVt_PV) {
3183 SvUPGRADE(dstr, SVt_PVGV);
3184 (void)SvOK_off(dstr);
3185 /* FIXME - why are we doing this, then turning it off and on again
3187 isGV_with_GP_on(dstr);
3189 GvSTASH(dstr) = GvSTASH(sstr);
3191 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3192 gv_name_set((GV *)dstr, name, len, GV_ADD);
3193 SvFAKE_on(dstr); /* can coerce to non-glob */
3196 #ifdef GV_UNIQUE_CHECK
3197 if (GvUNIQUE((GV*)dstr)) {
3198 Perl_croak(aTHX_ PL_no_modify);
3203 isGV_with_GP_off(dstr);
3204 (void)SvOK_off(dstr);
3205 isGV_with_GP_on(dstr);
3206 GvINTRO_off(dstr); /* one-shot flag */
3207 GvGP(dstr) = gp_ref(GvGP(sstr));
3208 if (SvTAINTED(sstr))
3210 if (GvIMPORTED(dstr) != GVf_IMPORTED
3211 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3213 GvIMPORTED_on(dstr);
3220 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3221 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3223 const int intro = GvINTRO(dstr);
3226 const U32 stype = SvTYPE(sref);
3229 #ifdef GV_UNIQUE_CHECK
3230 if (GvUNIQUE((GV*)dstr)) {
3231 Perl_croak(aTHX_ PL_no_modify);
3236 GvINTRO_off(dstr); /* one-shot flag */
3237 GvLINE(dstr) = CopLINE(PL_curcop);
3238 GvEGV(dstr) = (GV*)dstr;
3243 location = (SV **) &GvCV(dstr);
3244 import_flag = GVf_IMPORTED_CV;
3247 location = (SV **) &GvHV(dstr);
3248 import_flag = GVf_IMPORTED_HV;
3251 location = (SV **) &GvAV(dstr);
3252 import_flag = GVf_IMPORTED_AV;
3255 location = (SV **) &GvIOp(dstr);
3258 location = (SV **) &GvFORM(dstr);
3260 location = &GvSV(dstr);
3261 import_flag = GVf_IMPORTED_SV;
3264 if (stype == SVt_PVCV) {
3265 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3266 SvREFCNT_dec(GvCV(dstr));
3268 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3269 PL_sub_generation++;
3272 SAVEGENERICSV(*location);
3276 if (stype == SVt_PVCV && *location != sref) {
3277 CV* const cv = (CV*)*location;
3279 if (!GvCVGEN((GV*)dstr) &&
3280 (CvROOT(cv) || CvXSUB(cv)))
3282 /* Redefining a sub - warning is mandatory if
3283 it was a const and its value changed. */
3284 if (CvCONST(cv) && CvCONST((CV*)sref)
3285 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3287 /* They are 2 constant subroutines generated from
3288 the same constant. This probably means that
3289 they are really the "same" proxy subroutine
3290 instantiated in 2 places. Most likely this is
3291 when a constant is exported twice. Don't warn.
3294 else if (ckWARN(WARN_REDEFINE)
3296 && (!CvCONST((CV*)sref)
3297 || sv_cmp(cv_const_sv(cv),
3298 cv_const_sv((CV*)sref))))) {
3299 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3302 ? "Constant subroutine %s::%s redefined"
3303 : "Subroutine %s::%s redefined"),
3304 HvNAME_get(GvSTASH((GV*)dstr)),
3305 GvENAME((GV*)dstr));
3309 cv_ckproto_len(cv, (GV*)dstr,
3310 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3311 SvPOK(sref) ? SvCUR(sref) : 0);
3313 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3314 GvASSUMECV_on(dstr);
3315 PL_sub_generation++;
3318 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3319 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3320 GvFLAGS(dstr) |= import_flag;
3325 if (SvTAINTED(sstr))
3331 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3334 register U32 sflags;
3336 register svtype stype;
3341 if (SvIS_FREED(dstr)) {
3342 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3343 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3345 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3347 sstr = &PL_sv_undef;
3348 if (SvIS_FREED(sstr)) {
3349 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3350 (void*)sstr, (void*)dstr);
3352 stype = SvTYPE(sstr);
3353 dtype = SvTYPE(dstr);
3358 /* need to nuke the magic */
3360 SvRMAGICAL_off(dstr);
3363 /* There's a lot of redundancy below but we're going for speed here */
3368 if (dtype != SVt_PVGV) {
3369 (void)SvOK_off(dstr);
3377 sv_upgrade(dstr, SVt_IV);
3382 sv_upgrade(dstr, SVt_PVIV);
3385 goto end_of_first_switch;
3387 (void)SvIOK_only(dstr);
3388 SvIV_set(dstr, SvIVX(sstr));
3391 /* SvTAINTED can only be true if the SV has taint magic, which in
3392 turn means that the SV type is PVMG (or greater). This is the
3393 case statement for SVt_IV, so this cannot be true (whatever gcov
3395 assert(!SvTAINTED(sstr));
3405 sv_upgrade(dstr, SVt_NV);
3410 sv_upgrade(dstr, SVt_PVNV);
3413 goto end_of_first_switch;
3415 SvNV_set(dstr, SvNVX(sstr));
3416 (void)SvNOK_only(dstr);
3417 /* SvTAINTED can only be true if the SV has taint magic, which in
3418 turn means that the SV type is PVMG (or greater). This is the
3419 case statement for SVt_NV, so this cannot be true (whatever gcov
3421 assert(!SvTAINTED(sstr));
3428 sv_upgrade(dstr, SVt_RV);
3431 #ifdef PERL_OLD_COPY_ON_WRITE
3432 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3433 if (dtype < SVt_PVIV)
3434 sv_upgrade(dstr, SVt_PVIV);
3441 sv_upgrade(dstr, SVt_PV);
3444 if (dtype < SVt_PVIV)
3445 sv_upgrade(dstr, SVt_PVIV);
3448 if (dtype < SVt_PVNV)
3449 sv_upgrade(dstr, SVt_PVNV);
3453 const char * const type = sv_reftype(sstr,0);
3455 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3457 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3461 /* case SVt_BIND: */
3464 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3465 glob_assign_glob(dstr, sstr, dtype);
3468 /* SvVALID means that this PVGV is playing at being an FBM. */
3472 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3474 if (SvTYPE(sstr) != stype) {
3475 stype = SvTYPE(sstr);
3476 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3477 glob_assign_glob(dstr, sstr, dtype);
3482 if (stype == SVt_PVLV)
3483 SvUPGRADE(dstr, SVt_PVNV);
3485 SvUPGRADE(dstr, (svtype)stype);
3487 end_of_first_switch:
3489 /* dstr may have been upgraded. */
3490 dtype = SvTYPE(dstr);
3491 sflags = SvFLAGS(sstr);
3493 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3494 /* Assigning to a subroutine sets the prototype. */
3497 const char *const ptr = SvPV_const(sstr, len);
3499 SvGROW(dstr, len + 1);
3500 Copy(ptr, SvPVX(dstr), len + 1, char);
3501 SvCUR_set(dstr, len);
3503 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3507 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3508 const char * const type = sv_reftype(dstr,0);
3510 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3512 Perl_croak(aTHX_ "Cannot copy to %s", type);
3513 } else if (sflags & SVf_ROK) {
3514 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3515 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3518 if (GvIMPORTED(dstr) != GVf_IMPORTED
3519 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3521 GvIMPORTED_on(dstr);
3526 glob_assign_glob(dstr, sstr, dtype);
3530 if (dtype >= SVt_PV) {
3531 if (dtype == SVt_PVGV) {
3532 glob_assign_ref(dstr, sstr);
3535 if (SvPVX_const(dstr)) {
3541 (void)SvOK_off(dstr);
3542 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3543 SvFLAGS(dstr) |= sflags & SVf_ROK;
3544 assert(!(sflags & SVp_NOK));
3545 assert(!(sflags & SVp_IOK));
3546 assert(!(sflags & SVf_NOK));
3547 assert(!(sflags & SVf_IOK));
3549 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3550 if (!(sflags & SVf_OK)) {
3551 if (ckWARN(WARN_MISC))
3552 Perl_warner(aTHX_ packWARN(WARN_MISC),
3553 "Undefined value assigned to typeglob");
3556 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3557 if (dstr != (SV*)gv) {
3560 GvGP(dstr) = gp_ref(GvGP(gv));
3564 else if (sflags & SVp_POK) {
3568 * Check to see if we can just swipe the string. If so, it's a
3569 * possible small lose on short strings, but a big win on long ones.
3570 * It might even be a win on short strings if SvPVX_const(dstr)
3571 * has to be allocated and SvPVX_const(sstr) has to be freed.
3572 * Likewise if we can set up COW rather than doing an actual copy, we
3573 * drop to the else clause, as the swipe code and the COW setup code
3574 * have much in common.
3577 /* Whichever path we take through the next code, we want this true,
3578 and doing it now facilitates the COW check. */
3579 (void)SvPOK_only(dstr);
3582 /* If we're already COW then this clause is not true, and if COW
3583 is allowed then we drop down to the else and make dest COW
3584 with us. If caller hasn't said that we're allowed to COW
3585 shared hash keys then we don't do the COW setup, even if the
3586 source scalar is a shared hash key scalar. */
3587 (((flags & SV_COW_SHARED_HASH_KEYS)
3588 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3589 : 1 /* If making a COW copy is forbidden then the behaviour we
3590 desire is as if the source SV isn't actually already
3591 COW, even if it is. So we act as if the source flags
3592 are not COW, rather than actually testing them. */
3594 #ifndef PERL_OLD_COPY_ON_WRITE
3595 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3596 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3597 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3598 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3599 but in turn, it's somewhat dead code, never expected to go
3600 live, but more kept as a placeholder on how to do it better
3601 in a newer implementation. */
3602 /* If we are COW and dstr is a suitable target then we drop down
3603 into the else and make dest a COW of us. */
3604 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3609 (sflags & SVs_TEMP) && /* slated for free anyway? */
3610 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3611 (!(flags & SV_NOSTEAL)) &&
3612 /* and we're allowed to steal temps */
3613 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3614 SvLEN(sstr) && /* and really is a string */
3615 /* and won't be needed again, potentially */
3616 !(PL_op && PL_op->op_type == OP_AASSIGN))
3617 #ifdef PERL_OLD_COPY_ON_WRITE
3618 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3619 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3620 && SvTYPE(sstr) >= SVt_PVIV)
3623 /* Failed the swipe test, and it's not a shared hash key either.
3624 Have to copy the string. */
3625 STRLEN len = SvCUR(sstr);
3626 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3627 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3628 SvCUR_set(dstr, len);
3629 *SvEND(dstr) = '\0';
3631 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3633 /* Either it's a shared hash key, or it's suitable for
3634 copy-on-write or we can swipe the string. */
3636 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3640 #ifdef PERL_OLD_COPY_ON_WRITE
3642 /* I believe I should acquire a global SV mutex if
3643 it's a COW sv (not a shared hash key) to stop
3644 it going un copy-on-write.
3645 If the source SV has gone un copy on write between up there
3646 and down here, then (assert() that) it is of the correct
3647 form to make it copy on write again */
3648 if ((sflags & (SVf_FAKE | SVf_READONLY))
3649 != (SVf_FAKE | SVf_READONLY)) {
3650 SvREADONLY_on(sstr);
3652 /* Make the source SV into a loop of 1.
3653 (about to become 2) */
3654 SV_COW_NEXT_SV_SET(sstr, sstr);
3658 /* Initial code is common. */
3659 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3664 /* making another shared SV. */
3665 STRLEN cur = SvCUR(sstr);
3666 STRLEN len = SvLEN(sstr);
3667 #ifdef PERL_OLD_COPY_ON_WRITE
3669 assert (SvTYPE(dstr) >= SVt_PVIV);
3670 /* SvIsCOW_normal */
3671 /* splice us in between source and next-after-source. */
3672 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3673 SV_COW_NEXT_SV_SET(sstr, dstr);
3674 SvPV_set(dstr, SvPVX_mutable(sstr));
3678 /* SvIsCOW_shared_hash */
3679 DEBUG_C(PerlIO_printf(Perl_debug_log,
3680 "Copy on write: Sharing hash\n"));
3682 assert (SvTYPE(dstr) >= SVt_PV);
3684 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3686 SvLEN_set(dstr, len);
3687 SvCUR_set(dstr, cur);
3688 SvREADONLY_on(dstr);
3690 /* Relesase a global SV mutex. */
3693 { /* Passes the swipe test. */
3694 SvPV_set(dstr, SvPVX_mutable(sstr));
3695 SvLEN_set(dstr, SvLEN(sstr));
3696 SvCUR_set(dstr, SvCUR(sstr));
3699 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3700 SvPV_set(sstr, NULL);
3706 if (sflags & SVp_NOK) {
3707 SvNV_set(dstr, SvNVX(sstr));
3709 if (sflags & SVp_IOK) {
3711 SvIV_set(dstr, SvIVX(sstr));
3712 /* Must do this otherwise some other overloaded use of 0x80000000
3713 gets confused. I guess SVpbm_VALID */
3714 if (sflags & SVf_IVisUV)
3717 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3719 const MAGIC * const smg = SvVSTRING_mg(sstr);
3721 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3722 smg->mg_ptr, smg->mg_len);
3723 SvRMAGICAL_on(dstr);
3727 else if (sflags & (SVp_IOK|SVp_NOK)) {
3728 (void)SvOK_off(dstr);
3729 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3730 if (sflags & SVp_IOK) {
3731 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3732 SvIV_set(dstr, SvIVX(sstr));
3734 if (sflags & SVp_NOK) {
3735 SvNV_set(dstr, SvNVX(sstr));
3739 if (isGV_with_GP(sstr)) {
3740 /* This stringification rule for globs is spread in 3 places.
3741 This feels bad. FIXME. */
3742 const U32 wasfake = sflags & SVf_FAKE;
3744 /* FAKE globs can get coerced, so need to turn this off
3745 temporarily if it is on. */
3747 gv_efullname3(dstr, (GV *)sstr, "*");
3748 SvFLAGS(sstr) |= wasfake;
3751 (void)SvOK_off(dstr);
3753 if (SvTAINTED(sstr))
3758 =for apidoc sv_setsv_mg
3760 Like C<sv_setsv>, but also handles 'set' magic.
3766 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3768 sv_setsv(dstr,sstr);
3772 #ifdef PERL_OLD_COPY_ON_WRITE
3774 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3776 STRLEN cur = SvCUR(sstr);
3777 STRLEN len = SvLEN(sstr);
3778 register char *new_pv;
3781 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3782 (void*)sstr, (void*)dstr);
3789 if (SvTHINKFIRST(dstr))
3790 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3791 else if (SvPVX_const(dstr))
3792 Safefree(SvPVX_const(dstr));
3796 SvUPGRADE(dstr, SVt_PVIV);
3798 assert (SvPOK(sstr));
3799 assert (SvPOKp(sstr));
3800 assert (!SvIOK(sstr));
3801 assert (!SvIOKp(sstr));
3802 assert (!SvNOK(sstr));
3803 assert (!SvNOKp(sstr));
3805 if (SvIsCOW(sstr)) {
3807 if (SvLEN(sstr) == 0) {
3808 /* source is a COW shared hash key. */
3809 DEBUG_C(PerlIO_printf(Perl_debug_log,
3810 "Fast copy on write: Sharing hash\n"));
3811 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3814 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3816 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3817 SvUPGRADE(sstr, SVt_PVIV);
3818 SvREADONLY_on(sstr);
3820 DEBUG_C(PerlIO_printf(Perl_debug_log,
3821 "Fast copy on write: Converting sstr to COW\n"));
3822 SV_COW_NEXT_SV_SET(dstr, sstr);
3824 SV_COW_NEXT_SV_SET(sstr, dstr);
3825 new_pv = SvPVX_mutable(sstr);
3828 SvPV_set(dstr, new_pv);
3829 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3832 SvLEN_set(dstr, len);
3833 SvCUR_set(dstr, cur);
3842 =for apidoc sv_setpvn
3844 Copies a string into an SV. The C<len> parameter indicates the number of
3845 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3846 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3852 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3855 register char *dptr;
3857 SV_CHECK_THINKFIRST_COW_DROP(sv);
3863 /* len is STRLEN which is unsigned, need to copy to signed */
3866 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3868 SvUPGRADE(sv, SVt_PV);
3870 dptr = SvGROW(sv, len + 1);
3871 Move(ptr,dptr,len,char);
3874 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3879 =for apidoc sv_setpvn_mg
3881 Like C<sv_setpvn>, but also handles 'set' magic.
3887 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3889 sv_setpvn(sv,ptr,len);
3894 =for apidoc sv_setpv
3896 Copies a string into an SV. The string must be null-terminated. Does not
3897 handle 'set' magic. See C<sv_setpv_mg>.
3903 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3906 register STRLEN len;
3908 SV_CHECK_THINKFIRST_COW_DROP(sv);
3914 SvUPGRADE(sv, SVt_PV);
3916 SvGROW(sv, len + 1);
3917 Move(ptr,SvPVX(sv),len+1,char);
3919 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3924 =for apidoc sv_setpv_mg
3926 Like C<sv_setpv>, but also handles 'set' magic.
3932 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3939 =for apidoc sv_usepvn_flags
3941 Tells an SV to use C<ptr> to find its string value. Normally the
3942 string is stored inside the SV but sv_usepvn allows the SV to use an
3943 outside string. The C<ptr> should point to memory that was allocated
3944 by C<malloc>. The string length, C<len>, must be supplied. By default
3945 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3946 so that pointer should not be freed or used by the programmer after
3947 giving it to sv_usepvn, and neither should any pointers from "behind"
3948 that pointer (e.g. ptr + 1) be used.
3950 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3951 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3952 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3953 C<len>, and already meets the requirements for storing in C<SvPVX>)
3959 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3963 SV_CHECK_THINKFIRST_COW_DROP(sv);
3964 SvUPGRADE(sv, SVt_PV);
3967 if (flags & SV_SMAGIC)
3971 if (SvPVX_const(sv))
3975 if (flags & SV_HAS_TRAILING_NUL)
3976 assert(ptr[len] == '\0');
3979 allocate = (flags & SV_HAS_TRAILING_NUL)
3980 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3981 if (flags & SV_HAS_TRAILING_NUL) {
3982 /* It's long enough - do nothing.
3983 Specfically Perl_newCONSTSUB is relying on this. */
3986 /* Force a move to shake out bugs in callers. */
3987 char *new_ptr = (char*)safemalloc(allocate);
3988 Copy(ptr, new_ptr, len, char);
3989 PoisonFree(ptr,len,char);
3993 ptr = (char*) saferealloc (ptr, allocate);
3998 SvLEN_set(sv, allocate);
3999 if (!(flags & SV_HAS_TRAILING_NUL)) {
4002 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4004 if (flags & SV_SMAGIC)
4008 #ifdef PERL_OLD_COPY_ON_WRITE
4009 /* Need to do this *after* making the SV normal, as we need the buffer
4010 pointer to remain valid until after we've copied it. If we let go too early,
4011 another thread could invalidate it by unsharing last of the same hash key
4012 (which it can do by means other than releasing copy-on-write Svs)
4013 or by changing the other copy-on-write SVs in the loop. */
4015 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4017 { /* this SV was SvIsCOW_normal(sv) */
4018 /* we need to find the SV pointing to us. */
4019 SV *current = SV_COW_NEXT_SV(after);
4021 if (current == sv) {
4022 /* The SV we point to points back to us (there were only two of us
4024 Hence other SV is no longer copy on write either. */
4026 SvREADONLY_off(after);
4028 /* We need to follow the pointers around the loop. */
4030 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4033 /* don't loop forever if the structure is bust, and we have
4034 a pointer into a closed loop. */
4035 assert (current != after);
4036 assert (SvPVX_const(current) == pvx);
4038 /* Make the SV before us point to the SV after us. */
4039 SV_COW_NEXT_SV_SET(current, after);
4045 =for apidoc sv_force_normal_flags
4047 Undo various types of fakery on an SV: if the PV is a shared string, make
4048 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4049 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4050 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4051 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4052 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4053 set to some other value.) In addition, the C<flags> parameter gets passed to
4054 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4055 with flags set to 0.
4061 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4064 #ifdef PERL_OLD_COPY_ON_WRITE
4065 if (SvREADONLY(sv)) {
4066 /* At this point I believe I should acquire a global SV mutex. */
4068 const char * const pvx = SvPVX_const(sv);
4069 const STRLEN len = SvLEN(sv);
4070 const STRLEN cur = SvCUR(sv);
4071 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4072 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4073 we'll fail an assertion. */
4074 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4077 PerlIO_printf(Perl_debug_log,
4078 "Copy on write: Force normal %ld\n",
4084 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4087 if (flags & SV_COW_DROP_PV) {
4088 /* OK, so we don't need to copy our buffer. */
4091 SvGROW(sv, cur + 1);
4092 Move(pvx,SvPVX(sv),cur,char);
4097 sv_release_COW(sv, pvx, next);
4099 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4105 else if (IN_PERL_RUNTIME)
4106 Perl_croak(aTHX_ PL_no_modify);
4107 /* At this point I believe that I can drop the global SV mutex. */
4110 if (SvREADONLY(sv)) {
4112 const char * const pvx = SvPVX_const(sv);
4113 const STRLEN len = SvCUR(sv);
4118 SvGROW(sv, len + 1);
4119 Move(pvx,SvPVX(sv),len,char);
4121 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4123 else if (IN_PERL_RUNTIME)
4124 Perl_croak(aTHX_ PL_no_modify);
4128 sv_unref_flags(sv, flags);
4129 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4136 Efficient removal of characters from the beginning of the string buffer.
4137 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4138 the string buffer. The C<ptr> becomes the first character of the adjusted
4139 string. Uses the "OOK hack".
4140 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4141 refer to the same chunk of data.
4147 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4149 register STRLEN delta;
4150 if (!ptr || !SvPOKp(sv))
4152 delta = ptr - SvPVX_const(sv);
4153 SV_CHECK_THINKFIRST(sv);
4154 if (SvTYPE(sv) < SVt_PVIV)
4155 sv_upgrade(sv,SVt_PVIV);
4158 if (!SvLEN(sv)) { /* make copy of shared string */
4159 const char *pvx = SvPVX_const(sv);
4160 const STRLEN len = SvCUR(sv);
4161 SvGROW(sv, len + 1);
4162 Move(pvx,SvPVX(sv),len,char);
4166 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4167 and we do that anyway inside the SvNIOK_off
4169 SvFLAGS(sv) |= SVf_OOK;
4172 SvLEN_set(sv, SvLEN(sv) - delta);
4173 SvCUR_set(sv, SvCUR(sv) - delta);
4174 SvPV_set(sv, SvPVX(sv) + delta);
4175 SvIV_set(sv, SvIVX(sv) + delta);
4179 =for apidoc sv_catpvn
4181 Concatenates the string onto the end of the string which is in the SV. The
4182 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4183 status set, then the bytes appended should be valid UTF-8.
4184 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4186 =for apidoc sv_catpvn_flags
4188 Concatenates the string onto the end of the string which is in the SV. The
4189 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4190 status set, then the bytes appended should be valid UTF-8.
4191 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4192 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4193 in terms of this function.
4199 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4203 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4205 SvGROW(dsv, dlen + slen + 1);
4207 sstr = SvPVX_const(dsv);
4208 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4209 SvCUR_set(dsv, SvCUR(dsv) + slen);
4211 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4213 if (flags & SV_SMAGIC)
4218 =for apidoc sv_catsv
4220 Concatenates the string from SV C<ssv> onto the end of the string in
4221 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4222 not 'set' magic. See C<sv_catsv_mg>.
4224 =for apidoc sv_catsv_flags
4226 Concatenates the string from SV C<ssv> onto the end of the string in
4227 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4228 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4229 and C<sv_catsv_nomg> are implemented in terms of this function.
4234 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4239 const char *spv = SvPV_const(ssv, slen);
4241 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4242 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4243 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4244 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4245 dsv->sv_flags doesn't have that bit set.
4246 Andy Dougherty 12 Oct 2001
4248 const I32 sutf8 = DO_UTF8(ssv);
4251 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4253 dutf8 = DO_UTF8(dsv);
4255 if (dutf8 != sutf8) {
4257 /* Not modifying source SV, so taking a temporary copy. */
4258 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4260 sv_utf8_upgrade(csv);
4261 spv = SvPV_const(csv, slen);
4264 sv_utf8_upgrade_nomg(dsv);
4266 sv_catpvn_nomg(dsv, spv, slen);
4269 if (flags & SV_SMAGIC)
4274 =for apidoc sv_catpv
4276 Concatenates the string onto the end of the string which is in the SV.
4277 If the SV has the UTF-8 status set, then the bytes appended should be
4278 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4283 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4286 register STRLEN len;
4292 junk = SvPV_force(sv, tlen);
4294 SvGROW(sv, tlen + len + 1);
4296 ptr = SvPVX_const(sv);
4297 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4298 SvCUR_set(sv, SvCUR(sv) + len);
4299 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4304 =for apidoc sv_catpv_mg
4306 Like C<sv_catpv>, but also handles 'set' magic.
4312 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4321 Creates a new SV. A non-zero C<len> parameter indicates the number of
4322 bytes of preallocated string space the SV should have. An extra byte for a
4323 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4324 space is allocated.) The reference count for the new SV is set to 1.
4326 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4327 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4328 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4329 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4330 modules supporting older perls.
4336 Perl_newSV(pTHX_ STRLEN len)
4343 sv_upgrade(sv, SVt_PV);
4344 SvGROW(sv, len + 1);
4349 =for apidoc sv_magicext
4351 Adds magic to an SV, upgrading it if necessary. Applies the
4352 supplied vtable and returns a pointer to the magic added.
4354 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4355 In particular, you can add magic to SvREADONLY SVs, and add more than
4356 one instance of the same 'how'.
4358 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4359 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4360 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4361 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4363 (This is now used as a subroutine by C<sv_magic>.)
4368 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4369 const char* name, I32 namlen)
4374 if (SvTYPE(sv) < SVt_PVMG) {
4375 SvUPGRADE(sv, SVt_PVMG);
4377 Newxz(mg, 1, MAGIC);
4378 mg->mg_moremagic = SvMAGIC(sv);
4379 SvMAGIC_set(sv, mg);
4381 /* Sometimes a magic contains a reference loop, where the sv and
4382 object refer to each other. To prevent a reference loop that
4383 would prevent such objects being freed, we look for such loops
4384 and if we find one we avoid incrementing the object refcount.
4386 Note we cannot do this to avoid self-tie loops as intervening RV must
4387 have its REFCNT incremented to keep it in existence.
4390 if (!obj || obj == sv ||
4391 how == PERL_MAGIC_arylen ||
4392 how == PERL_MAGIC_qr ||
4393 how == PERL_MAGIC_symtab ||
4394 (SvTYPE(obj) == SVt_PVGV &&
4395 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4396 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4397 GvFORM(obj) == (CV*)sv)))
4402 mg->mg_obj = SvREFCNT_inc_simple(obj);
4403 mg->mg_flags |= MGf_REFCOUNTED;
4406 /* Normal self-ties simply pass a null object, and instead of
4407 using mg_obj directly, use the SvTIED_obj macro to produce a
4408 new RV as needed. For glob "self-ties", we are tieing the PVIO
4409 with an RV obj pointing to the glob containing the PVIO. In
4410 this case, to avoid a reference loop, we need to weaken the
4414 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4415 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4421 mg->mg_len = namlen;
4424 mg->mg_ptr = savepvn(name, namlen);
4425 else if (namlen == HEf_SVKEY)
4426 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4428 mg->mg_ptr = (char *) name;
4430 mg->mg_virtual = (MGVTBL *) vtable;
4434 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4439 =for apidoc sv_magic
4441 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4442 then adds a new magic item of type C<how> to the head of the magic list.
4444 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4445 handling of the C<name> and C<namlen> arguments.
4447 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4448 to add more than one instance of the same 'how'.
4454 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4457 const MGVTBL *vtable;
4460 #ifdef PERL_OLD_COPY_ON_WRITE
4462 sv_force_normal_flags(sv, 0);
4464 if (SvREADONLY(sv)) {
4466 /* its okay to attach magic to shared strings; the subsequent
4467 * upgrade to PVMG will unshare the string */
4468 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4471 && how != PERL_MAGIC_regex_global
4472 && how != PERL_MAGIC_bm
4473 && how != PERL_MAGIC_fm
4474 && how != PERL_MAGIC_sv
4475 && how != PERL_MAGIC_backref
4478 Perl_croak(aTHX_ PL_no_modify);
4481 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4482 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4483 /* sv_magic() refuses to add a magic of the same 'how' as an
4486 if (how == PERL_MAGIC_taint) {
4488 /* Any scalar which already had taint magic on which someone
4489 (erroneously?) did SvIOK_on() or similar will now be
4490 incorrectly sporting public "OK" flags. */
4491 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4499 vtable = &PL_vtbl_sv;
4501 case PERL_MAGIC_overload:
4502 vtable = &PL_vtbl_amagic;
4504 case PERL_MAGIC_overload_elem:
4505 vtable = &PL_vtbl_amagicelem;
4507 case PERL_MAGIC_overload_table:
4508 vtable = &PL_vtbl_ovrld;
4511 vtable = &PL_vtbl_bm;
4513 case PERL_MAGIC_regdata:
4514 vtable = &PL_vtbl_regdata;
4516 case PERL_MAGIC_regdatum:
4517 vtable = &PL_vtbl_regdatum;
4519 case PERL_MAGIC_env:
4520 vtable = &PL_vtbl_env;
4523 vtable = &PL_vtbl_fm;
4525 case PERL_MAGIC_envelem:
4526 vtable = &PL_vtbl_envelem;
4528 case PERL_MAGIC_regex_global:
4529 vtable = &PL_vtbl_mglob;
4531 case PERL_MAGIC_isa:
4532 vtable = &PL_vtbl_isa;
4534 case PERL_MAGIC_isaelem:
4535 vtable = &PL_vtbl_isaelem;
4537 case PERL_MAGIC_nkeys:
4538 vtable = &PL_vtbl_nkeys;
4540 case PERL_MAGIC_dbfile:
4543 case PERL_MAGIC_dbline:
4544 vtable = &PL_vtbl_dbline;
4546 #ifdef USE_LOCALE_COLLATE
4547 case PERL_MAGIC_collxfrm:
4548 vtable = &PL_vtbl_collxfrm;
4550 #endif /* USE_LOCALE_COLLATE */
4551 case PERL_MAGIC_tied:
4552 vtable = &PL_vtbl_pack;
4554 case PERL_MAGIC_tiedelem:
4555 case PERL_MAGIC_tiedscalar:
4556 vtable = &PL_vtbl_packelem;
4559 vtable = &PL_vtbl_regexp;
4561 case PERL_MAGIC_hints:
4562 /* As this vtable is all NULL, we can reuse it. */
4563 case PERL_MAGIC_sig:
4564 vtable = &PL_vtbl_sig;
4566 case PERL_MAGIC_sigelem:
4567 vtable = &PL_vtbl_sigelem;
4569 case PERL_MAGIC_taint:
4570 vtable = &PL_vtbl_taint;
4572 case PERL_MAGIC_uvar:
4573 vtable = &PL_vtbl_uvar;
4575 case PERL_MAGIC_vec:
4576 vtable = &PL_vtbl_vec;
4578 case PERL_MAGIC_arylen_p:
4579 case PERL_MAGIC_rhash:
4580 case PERL_MAGIC_symtab:
4581 case PERL_MAGIC_vstring:
4584 case PERL_MAGIC_utf8:
4585 vtable = &PL_vtbl_utf8;
4587 case PERL_MAGIC_substr:
4588 vtable = &PL_vtbl_substr;
4590 case PERL_MAGIC_defelem:
4591 vtable = &PL_vtbl_defelem;
4593 case PERL_MAGIC_arylen:
4594 vtable = &PL_vtbl_arylen;
4596 case PERL_MAGIC_pos:
4597 vtable = &PL_vtbl_pos;
4599 case PERL_MAGIC_backref:
4600 vtable = &PL_vtbl_backref;
4602 case PERL_MAGIC_hintselem:
4603 vtable = &PL_vtbl_hintselem;
4605 case PERL_MAGIC_ext:
4606 /* Reserved for use by extensions not perl internals. */
4607 /* Useful for attaching extension internal data to perl vars. */
4608 /* Note that multiple extensions may clash if magical scalars */
4609 /* etc holding private data from one are passed to another. */
4613 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4616 /* Rest of work is done else where */
4617 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4620 case PERL_MAGIC_taint:
4623 case PERL_MAGIC_ext:
4624 case PERL_MAGIC_dbfile:
4631 =for apidoc sv_unmagic
4633 Removes all magic of type C<type> from an SV.
4639 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4643 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4645 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4646 for (mg = *mgp; mg; mg = *mgp) {
4647 if (mg->mg_type == type) {
4648 const MGVTBL* const vtbl = mg->mg_virtual;
4649 *mgp = mg->mg_moremagic;
4650 if (vtbl && vtbl->svt_free)
4651 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4652 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4654 Safefree(mg->mg_ptr);
4655 else if (mg->mg_len == HEf_SVKEY)
4656 SvREFCNT_dec((SV*)mg->mg_ptr);
4657 else if (mg->mg_type == PERL_MAGIC_utf8)
4658 Safefree(mg->mg_ptr);
4660 if (mg->mg_flags & MGf_REFCOUNTED)
4661 SvREFCNT_dec(mg->mg_obj);
4665 mgp = &mg->mg_moremagic;
4669 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4670 SvMAGIC_set(sv, NULL);
4677 =for apidoc sv_rvweaken
4679 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4680 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4681 push a back-reference to this RV onto the array of backreferences
4682 associated with that magic. If the RV is magical, set magic will be
4683 called after the RV is cleared.
4689 Perl_sv_rvweaken(pTHX_ SV *sv)
4692 if (!SvOK(sv)) /* let undefs pass */
4695 Perl_croak(aTHX_ "Can't weaken a nonreference");
4696 else if (SvWEAKREF(sv)) {
4697 if (ckWARN(WARN_MISC))
4698 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4702 Perl_sv_add_backref(aTHX_ tsv, sv);
4708 /* Give tsv backref magic if it hasn't already got it, then push a
4709 * back-reference to sv onto the array associated with the backref magic.
4713 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4718 if (SvTYPE(tsv) == SVt_PVHV) {
4719 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4723 /* There is no AV in the offical place - try a fixup. */
4724 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4727 /* Aha. They've got it stowed in magic. Bring it back. */
4728 av = (AV*)mg->mg_obj;
4729 /* Stop mg_free decreasing the refernce count. */
4731 /* Stop mg_free even calling the destructor, given that
4732 there's no AV to free up. */
4734 sv_unmagic(tsv, PERL_MAGIC_backref);
4738 SvREFCNT_inc_simple_void(av);
4743 const MAGIC *const mg
4744 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4746 av = (AV*)mg->mg_obj;
4750 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4751 /* av now has a refcnt of 2, which avoids it getting freed
4752 * before us during global cleanup. The extra ref is removed
4753 * by magic_killbackrefs() when tsv is being freed */
4756 if (AvFILLp(av) >= AvMAX(av)) {
4757 av_extend(av, AvFILLp(av)+1);
4759 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4762 /* delete a back-reference to ourselves from the backref magic associated
4763 * with the SV we point to.
4767 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4774 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4775 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4776 /* We mustn't attempt to "fix up" the hash here by moving the
4777 backreference array back to the hv_aux structure, as that is stored
4778 in the main HvARRAY(), and hfreentries assumes that no-one
4779 reallocates HvARRAY() while it is running. */
4782 const MAGIC *const mg
4783 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4785 av = (AV *)mg->mg_obj;
4788 if (PL_in_clean_all)
4790 Perl_croak(aTHX_ "panic: del_backref");
4797 /* We shouldn't be in here more than once, but for paranoia reasons lets
4799 for (i = AvFILLp(av); i >= 0; i--) {
4801 const SSize_t fill = AvFILLp(av);
4803 /* We weren't the last entry.
4804 An unordered list has this property that you can take the
4805 last element off the end to fill the hole, and it's still
4806 an unordered list :-)
4811 AvFILLp(av) = fill - 1;
4817 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4819 SV **svp = AvARRAY(av);
4821 PERL_UNUSED_ARG(sv);
4823 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4824 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4825 if (svp && !SvIS_FREED(av)) {
4826 SV *const *const last = svp + AvFILLp(av);
4828 while (svp <= last) {
4830 SV *const referrer = *svp;
4831 if (SvWEAKREF(referrer)) {
4832 /* XXX Should we check that it hasn't changed? */
4833 SvRV_set(referrer, 0);
4835 SvWEAKREF_off(referrer);
4836 SvSETMAGIC(referrer);
4837 } else if (SvTYPE(referrer) == SVt_PVGV ||
4838 SvTYPE(referrer) == SVt_PVLV) {
4839 /* You lookin' at me? */
4840 assert(GvSTASH(referrer));
4841 assert(GvSTASH(referrer) == (HV*)sv);
4842 GvSTASH(referrer) = 0;
4845 "panic: magic_killbackrefs (flags=%"UVxf")",
4846 (UV)SvFLAGS(referrer));
4854 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4859 =for apidoc sv_insert
4861 Inserts a string at the specified offset/length within the SV. Similar to
4862 the Perl substr() function.
4868 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4873 register char *midend;
4874 register char *bigend;
4880 Perl_croak(aTHX_ "Can't modify non-existent substring");
4881 SvPV_force(bigstr, curlen);
4882 (void)SvPOK_only_UTF8(bigstr);
4883 if (offset + len > curlen) {
4884 SvGROW(bigstr, offset+len+1);
4885 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4886 SvCUR_set(bigstr, offset+len);
4890 i = littlelen - len;
4891 if (i > 0) { /* string might grow */
4892 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4893 mid = big + offset + len;
4894 midend = bigend = big + SvCUR(bigstr);
4897 while (midend > mid) /* shove everything down */
4898 *--bigend = *--midend;
4899 Move(little,big+offset,littlelen,char);
4900 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4905 Move(little,SvPVX(bigstr)+offset,len,char);
4910 big = SvPVX(bigstr);
4913 bigend = big + SvCUR(bigstr);
4915 if (midend > bigend)
4916 Perl_croak(aTHX_ "panic: sv_insert");
4918 if (mid - big > bigend - midend) { /* faster to shorten from end */
4920 Move(little, mid, littlelen,char);
4923 i = bigend - midend;
4925 Move(midend, mid, i,char);
4929 SvCUR_set(bigstr, mid - big);
4931 else if ((i = mid - big)) { /* faster from front */
4932 midend -= littlelen;
4934 sv_chop(bigstr,midend-i);
4939 Move(little, mid, littlelen,char);
4941 else if (littlelen) {
4942 midend -= littlelen;
4943 sv_chop(bigstr,midend);
4944 Move(little,midend,littlelen,char);
4947 sv_chop(bigstr,midend);
4953 =for apidoc sv_replace
4955 Make the first argument a copy of the second, then delete the original.
4956 The target SV physically takes over ownership of the body of the source SV
4957 and inherits its flags; however, the target keeps any magic it owns,
4958 and any magic in the source is discarded.
4959 Note that this is a rather specialist SV copying operation; most of the
4960 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4966 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4969 const U32 refcnt = SvREFCNT(sv);
4970 SV_CHECK_THINKFIRST_COW_DROP(sv);
4971 if (SvREFCNT(nsv) != 1) {
4972 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4973 UVuf " != 1)", (UV) SvREFCNT(nsv));
4975 if (SvMAGICAL(sv)) {
4979 sv_upgrade(nsv, SVt_PVMG);
4980 SvMAGIC_set(nsv, SvMAGIC(sv));
4981 SvFLAGS(nsv) |= SvMAGICAL(sv);
4983 SvMAGIC_set(sv, NULL);
4987 assert(!SvREFCNT(sv));
4988 #ifdef DEBUG_LEAKING_SCALARS
4989 sv->sv_flags = nsv->sv_flags;
4990 sv->sv_any = nsv->sv_any;
4991 sv->sv_refcnt = nsv->sv_refcnt;
4992 sv->sv_u = nsv->sv_u;
4994 StructCopy(nsv,sv,SV);
4996 /* Currently could join these into one piece of pointer arithmetic, but
4997 it would be unclear. */
4998 if(SvTYPE(sv) == SVt_IV)
5000 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5001 else if (SvTYPE(sv) == SVt_RV) {
5002 SvANY(sv) = &sv->sv_u.svu_rv;
5006 #ifdef PERL_OLD_COPY_ON_WRITE
5007 if (SvIsCOW_normal(nsv)) {
5008 /* We need to follow the pointers around the loop to make the
5009 previous SV point to sv, rather than nsv. */
5012 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5015 assert(SvPVX_const(current) == SvPVX_const(nsv));
5017 /* Make the SV before us point to the SV after us. */
5019 PerlIO_printf(Perl_debug_log, "previous is\n");
5021 PerlIO_printf(Perl_debug_log,
5022 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5023 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5025 SV_COW_NEXT_SV_SET(current, sv);
5028 SvREFCNT(sv) = refcnt;
5029 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5035 =for apidoc sv_clear
5037 Clear an SV: call any destructors, free up any memory used by the body,
5038 and free the body itself. The SV's head is I<not> freed, although
5039 its type is set to all 1's so that it won't inadvertently be assumed
5040 to be live during global destruction etc.
5041 This function should only be called when REFCNT is zero. Most of the time
5042 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5049 Perl_sv_clear(pTHX_ register SV *sv)
5052 const U32 type = SvTYPE(sv);
5053 const struct body_details *const sv_type_details
5054 = bodies_by_type + type;
5057 assert(SvREFCNT(sv) == 0);
5059 if (type <= SVt_IV) {
5060 /* See the comment in sv.h about the collusion between this early
5061 return and the overloading of the NULL and IV slots in the size
5067 if (PL_defstash) { /* Still have a symbol table? */
5072 stash = SvSTASH(sv);
5073 destructor = StashHANDLER(stash,DESTROY);
5075 SV* const tmpref = newRV(sv);
5076 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5078 PUSHSTACKi(PERLSI_DESTROY);
5083 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5089 if(SvREFCNT(tmpref) < 2) {
5090 /* tmpref is not kept alive! */
5092 SvRV_set(tmpref, NULL);
5095 SvREFCNT_dec(tmpref);
5097 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5101 if (PL_in_clean_objs)
5102 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5104 /* DESTROY gave object new lease on life */
5110 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5111 SvOBJECT_off(sv); /* Curse the object. */
5112 if (type != SVt_PVIO)
5113 --PL_sv_objcount; /* XXX Might want something more general */
5116 if (type >= SVt_PVMG) {
5117 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5118 SvREFCNT_dec(SvOURSTASH(sv));
5119 } else if (SvMAGIC(sv))
5121 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5122 SvREFCNT_dec(SvSTASH(sv));
5125 /* case SVt_BIND: */
5128 IoIFP(sv) != PerlIO_stdin() &&
5129 IoIFP(sv) != PerlIO_stdout() &&
5130 IoIFP(sv) != PerlIO_stderr())
5132 io_close((IO*)sv, FALSE);
5134 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5135 PerlDir_close(IoDIRP(sv));
5136 IoDIRP(sv) = (DIR*)NULL;
5137 Safefree(IoTOP_NAME(sv));
5138 Safefree(IoFMT_NAME(sv));
5139 Safefree(IoBOTTOM_NAME(sv));
5146 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5153 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5154 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5155 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5156 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5158 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5159 SvREFCNT_dec(LvTARG(sv));
5161 if (isGV_with_GP(sv)) {
5164 unshare_hek(GvNAME_HEK(sv));
5165 /* If we're in a stash, we don't own a reference to it. However it does
5166 have a back reference to us, which needs to be cleared. */
5167 if (!SvVALID(sv) && GvSTASH(sv))
5168 sv_del_backref((SV*)GvSTASH(sv), sv);
5174 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5176 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5177 /* Don't even bother with turning off the OOK flag. */
5182 SV * const target = SvRV(sv);
5184 sv_del_backref(target, sv);
5186 SvREFCNT_dec(target);
5188 #ifdef PERL_OLD_COPY_ON_WRITE
5189 else if (SvPVX_const(sv)) {
5191 /* I believe I need to grab the global SV mutex here and
5192 then recheck the COW status. */
5194 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5198 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5200 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5203 /* And drop it here. */
5205 } else if (SvLEN(sv)) {
5206 Safefree(SvPVX_const(sv));
5210 else if (SvPVX_const(sv) && SvLEN(sv))
5211 Safefree(SvPVX_mutable(sv));
5212 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5213 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5222 SvFLAGS(sv) &= SVf_BREAK;
5223 SvFLAGS(sv) |= SVTYPEMASK;
5225 if (sv_type_details->arena) {
5226 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5227 &PL_body_roots[type]);
5229 else if (sv_type_details->body_size) {
5230 my_safefree(SvANY(sv));
5235 =for apidoc sv_newref
5237 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5244 Perl_sv_newref(pTHX_ SV *sv)
5246 PERL_UNUSED_CONTEXT;
5255 Decrement an SV's reference count, and if it drops to zero, call
5256 C<sv_clear> to invoke destructors and free up any memory used by
5257 the body; finally, deallocate the SV's head itself.
5258 Normally called via a wrapper macro C<SvREFCNT_dec>.
5264 Perl_sv_free(pTHX_ SV *sv)
5269 if (SvREFCNT(sv) == 0) {
5270 if (SvFLAGS(sv) & SVf_BREAK)
5271 /* this SV's refcnt has been artificially decremented to
5272 * trigger cleanup */
5274 if (PL_in_clean_all) /* All is fair */
5276 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5277 /* make sure SvREFCNT(sv)==0 happens very seldom */
5278 SvREFCNT(sv) = (~(U32)0)/2;
5281 if (ckWARN_d(WARN_INTERNAL)) {
5282 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5283 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5284 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5285 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5286 Perl_dump_sv_child(aTHX_ sv);
5291 if (--(SvREFCNT(sv)) > 0)
5293 Perl_sv_free2(aTHX_ sv);
5297 Perl_sv_free2(pTHX_ SV *sv)
5302 if (ckWARN_d(WARN_DEBUGGING))
5303 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5304 "Attempt to free temp prematurely: SV 0x%"UVxf
5305 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5309 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5310 /* make sure SvREFCNT(sv)==0 happens very seldom */
5311 SvREFCNT(sv) = (~(U32)0)/2;
5322 Returns the length of the string in the SV. Handles magic and type
5323 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5329 Perl_sv_len(pTHX_ register SV *sv)
5337 len = mg_length(sv);
5339 (void)SvPV_const(sv, len);
5344 =for apidoc sv_len_utf8
5346 Returns the number of characters in the string in an SV, counting wide
5347 UTF-8 bytes as a single character. Handles magic and type coercion.
5353 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5354 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5355 * (Note that the mg_len is not the length of the mg_ptr field.
5356 * This allows the cache to store the character length of the string without
5357 * needing to malloc() extra storage to attach to the mg_ptr.)
5362 Perl_sv_len_utf8(pTHX_ register SV *sv)
5368 return mg_length(sv);
5372 const U8 *s = (U8*)SvPV_const(sv, len);
5376 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5378 if (mg && mg->mg_len != -1) {
5380 if (PL_utf8cache < 0) {
5381 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5383 /* Need to turn the assertions off otherwise we may
5384 recurse infinitely while printing error messages.
5386 SAVEI8(PL_utf8cache);
5388 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5389 " real %"UVuf" for %"SVf,
5390 (UV) ulen, (UV) real, SVfARG(sv));
5395 ulen = Perl_utf8_length(aTHX_ s, s + len);
5396 if (!SvREADONLY(sv)) {
5398 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5399 &PL_vtbl_utf8, 0, 0);
5407 return Perl_utf8_length(aTHX_ s, s + len);
5411 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5414 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5417 const U8 *s = start;
5419 while (s < send && uoffset--)
5422 /* This is the existing behaviour. Possibly it should be a croak, as
5423 it's actually a bounds error */
5429 /* Given the length of the string in both bytes and UTF-8 characters, decide
5430 whether to walk forwards or backwards to find the byte corresponding to
5431 the passed in UTF-8 offset. */
5433 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5434 STRLEN uoffset, STRLEN uend)
5436 STRLEN backw = uend - uoffset;
5437 if (uoffset < 2 * backw) {
5438 /* The assumption is that going forwards is twice the speed of going
5439 forward (that's where the 2 * backw comes from).
5440 (The real figure of course depends on the UTF-8 data.) */
5441 return sv_pos_u2b_forwards(start, send, uoffset);
5446 while (UTF8_IS_CONTINUATION(*send))
5449 return send - start;
5452 /* For the string representation of the given scalar, find the byte
5453 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5454 give another position in the string, *before* the sought offset, which
5455 (which is always true, as 0, 0 is a valid pair of positions), which should
5456 help reduce the amount of linear searching.
5457 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5458 will be used to reduce the amount of linear searching. The cache will be
5459 created if necessary, and the found value offered to it for update. */
5461 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5462 const U8 *const send, STRLEN uoffset,
5463 STRLEN uoffset0, STRLEN boffset0) {
5464 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5467 assert (uoffset >= uoffset0);
5469 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5470 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5471 if ((*mgp)->mg_ptr) {
5472 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5473 if (cache[0] == uoffset) {
5474 /* An exact match. */
5477 if (cache[2] == uoffset) {
5478 /* An exact match. */
5482 if (cache[0] < uoffset) {
5483 /* The cache already knows part of the way. */
5484 if (cache[0] > uoffset0) {
5485 /* The cache knows more than the passed in pair */
5486 uoffset0 = cache[0];
5487 boffset0 = cache[1];
5489 if ((*mgp)->mg_len != -1) {
5490 /* And we know the end too. */
5492 + sv_pos_u2b_midway(start + boffset0, send,
5494 (*mgp)->mg_len - uoffset0);
5497 + sv_pos_u2b_forwards(start + boffset0,
5498 send, uoffset - uoffset0);
5501 else if (cache[2] < uoffset) {
5502 /* We're between the two cache entries. */
5503 if (cache[2] > uoffset0) {
5504 /* and the cache knows more than the passed in pair */
5505 uoffset0 = cache[2];
5506 boffset0 = cache[3];
5510 + sv_pos_u2b_midway(start + boffset0,
5513 cache[0] - uoffset0);
5516 + sv_pos_u2b_midway(start + boffset0,
5519 cache[2] - uoffset0);
5523 else if ((*mgp)->mg_len != -1) {
5524 /* If we can take advantage of a passed in offset, do so. */
5525 /* In fact, offset0 is either 0, or less than offset, so don't
5526 need to worry about the other possibility. */
5528 + sv_pos_u2b_midway(start + boffset0, send,
5530 (*mgp)->mg_len - uoffset0);
5535 if (!found || PL_utf8cache < 0) {
5536 const STRLEN real_boffset
5537 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5538 send, uoffset - uoffset0);
5540 if (found && PL_utf8cache < 0) {
5541 if (real_boffset != boffset) {
5542 /* Need to turn the assertions off otherwise we may recurse
5543 infinitely while printing error messages. */
5544 SAVEI8(PL_utf8cache);
5546 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5547 " real %"UVuf" for %"SVf,
5548 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5551 boffset = real_boffset;
5554 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5560 =for apidoc sv_pos_u2b
5562 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5563 the start of the string, to a count of the equivalent number of bytes; if
5564 lenp is non-zero, it does the same to lenp, but this time starting from
5565 the offset, rather than from the start of the string. Handles magic and
5572 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5573 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5574 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5579 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5587 start = (U8*)SvPV_const(sv, len);
5589 STRLEN uoffset = (STRLEN) *offsetp;
5590 const U8 * const send = start + len;
5592 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5595 *offsetp = (I32) boffset;
5598 /* Convert the relative offset to absolute. */
5599 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5600 const STRLEN boffset2
5601 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5602 uoffset, boffset) - boffset;
5616 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5617 byte length pairing. The (byte) length of the total SV is passed in too,
5618 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5619 may not have updated SvCUR, so we can't rely on reading it directly.
5621 The proffered utf8/byte length pairing isn't used if the cache already has
5622 two pairs, and swapping either for the proffered pair would increase the
5623 RMS of the intervals between known byte offsets.
5625 The cache itself consists of 4 STRLEN values
5626 0: larger UTF-8 offset
5627 1: corresponding byte offset
5628 2: smaller UTF-8 offset
5629 3: corresponding byte offset
5631 Unused cache pairs have the value 0, 0.
5632 Keeping the cache "backwards" means that the invariant of
5633 cache[0] >= cache[2] is maintained even with empty slots, which means that
5634 the code that uses it doesn't need to worry if only 1 entry has actually
5635 been set to non-zero. It also makes the "position beyond the end of the
5636 cache" logic much simpler, as the first slot is always the one to start
5640 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5648 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5650 (*mgp)->mg_len = -1;
5654 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5655 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5656 (*mgp)->mg_ptr = (char *) cache;
5660 if (PL_utf8cache < 0) {
5661 const U8 *start = (const U8 *) SvPVX_const(sv);
5662 const STRLEN realutf8 = utf8_length(start, start + byte);
5664 if (realutf8 != utf8) {
5665 /* Need to turn the assertions off otherwise we may recurse
5666 infinitely while printing error messages. */
5667 SAVEI8(PL_utf8cache);
5669 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5670 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5674 /* Cache is held with the later position first, to simplify the code
5675 that deals with unbounded ends. */
5677 ASSERT_UTF8_CACHE(cache);
5678 if (cache[1] == 0) {
5679 /* Cache is totally empty */
5682 } else if (cache[3] == 0) {
5683 if (byte > cache[1]) {
5684 /* New one is larger, so goes first. */
5685 cache[2] = cache[0];
5686 cache[3] = cache[1];
5694 #define THREEWAY_SQUARE(a,b,c,d) \
5695 ((float)((d) - (c))) * ((float)((d) - (c))) \
5696 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5697 + ((float)((b) - (a))) * ((float)((b) - (a)))
5699 /* Cache has 2 slots in use, and we know three potential pairs.
5700 Keep the two that give the lowest RMS distance. Do the
5701 calcualation in bytes simply because we always know the byte
5702 length. squareroot has the same ordering as the positive value,
5703 so don't bother with the actual square root. */
5704 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5705 if (byte > cache[1]) {
5706 /* New position is after the existing pair of pairs. */
5707 const float keep_earlier
5708 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5709 const float keep_later
5710 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5712 if (keep_later < keep_earlier) {
5713 if (keep_later < existing) {
5714 cache[2] = cache[0];
5715 cache[3] = cache[1];
5721 if (keep_earlier < existing) {
5727 else if (byte > cache[3]) {
5728 /* New position is between the existing pair of pairs. */
5729 const float keep_earlier
5730 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5731 const float keep_later
5732 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5734 if (keep_later < keep_earlier) {
5735 if (keep_later < existing) {
5741 if (keep_earlier < existing) {
5748 /* New position is before the existing pair of pairs. */
5749 const float keep_earlier
5750 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5751 const float keep_later
5752 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5754 if (keep_later < keep_earlier) {
5755 if (keep_later < existing) {
5761 if (keep_earlier < existing) {
5762 cache[0] = cache[2];
5763 cache[1] = cache[3];
5770 ASSERT_UTF8_CACHE(cache);
5773 /* We already know all of the way, now we may be able to walk back. The same
5774 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5775 backward is half the speed of walking forward. */
5777 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5780 const STRLEN forw = target - s;
5781 STRLEN backw = end - target;
5783 if (forw < 2 * backw) {
5784 return utf8_length(s, target);
5787 while (end > target) {
5789 while (UTF8_IS_CONTINUATION(*end)) {
5798 =for apidoc sv_pos_b2u
5800 Converts the value pointed to by offsetp from a count of bytes from the
5801 start of the string, to a count of the equivalent number of UTF-8 chars.
5802 Handles magic and type coercion.
5808 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5809 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5814 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5817 const STRLEN byte = *offsetp;
5818 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5827 s = (const U8*)SvPV_const(sv, blen);
5830 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5834 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5835 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5837 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5838 if (cache[1] == byte) {
5839 /* An exact match. */
5840 *offsetp = cache[0];
5843 if (cache[3] == byte) {
5844 /* An exact match. */
5845 *offsetp = cache[2];
5849 if (cache[1] < byte) {
5850 /* We already know part of the way. */
5851 if (mg->mg_len != -1) {
5852 /* Actually, we know the end too. */
5854 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5855 s + blen, mg->mg_len - cache[0]);
5857 len = cache[0] + utf8_length(s + cache[1], send);
5860 else if (cache[3] < byte) {
5861 /* We're between the two cached pairs, so we do the calculation
5862 offset by the byte/utf-8 positions for the earlier pair,
5863 then add the utf-8 characters from the string start to
5865 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5866 s + cache[1], cache[0] - cache[2])
5870 else { /* cache[3] > byte */
5871 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5875 ASSERT_UTF8_CACHE(cache);
5877 } else if (mg->mg_len != -1) {
5878 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5882 if (!found || PL_utf8cache < 0) {
5883 const STRLEN real_len = utf8_length(s, send);
5885 if (found && PL_utf8cache < 0) {
5886 if (len != real_len) {
5887 /* Need to turn the assertions off otherwise we may recurse
5888 infinitely while printing error messages. */
5889 SAVEI8(PL_utf8cache);
5891 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5892 " real %"UVuf" for %"SVf,
5893 (UV) len, (UV) real_len, SVfARG(sv));
5900 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5906 Returns a boolean indicating whether the strings in the two SVs are
5907 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5908 coerce its args to strings if necessary.
5914 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5923 SV* svrecode = NULL;
5930 /* if pv1 and pv2 are the same, second SvPV_const call may
5931 * invalidate pv1, so we may need to make a copy */
5932 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5933 pv1 = SvPV_const(sv1, cur1);
5934 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5935 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5937 pv1 = SvPV_const(sv1, cur1);
5945 pv2 = SvPV_const(sv2, cur2);
5947 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5948 /* Differing utf8ness.
5949 * Do not UTF8size the comparands as a side-effect. */
5952 svrecode = newSVpvn(pv2, cur2);
5953 sv_recode_to_utf8(svrecode, PL_encoding);
5954 pv2 = SvPV_const(svrecode, cur2);
5957 svrecode = newSVpvn(pv1, cur1);
5958 sv_recode_to_utf8(svrecode, PL_encoding);
5959 pv1 = SvPV_const(svrecode, cur1);
5961 /* Now both are in UTF-8. */
5963 SvREFCNT_dec(svrecode);
5968 bool is_utf8 = TRUE;
5971 /* sv1 is the UTF-8 one,
5972 * if is equal it must be downgrade-able */
5973 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5979 /* sv2 is the UTF-8 one,
5980 * if is equal it must be downgrade-able */
5981 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5987 /* Downgrade not possible - cannot be eq */
5995 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5997 SvREFCNT_dec(svrecode);
6007 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6008 string in C<sv1> is less than, equal to, or greater than the string in
6009 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6010 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6016 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6020 const char *pv1, *pv2;
6023 SV *svrecode = NULL;
6030 pv1 = SvPV_const(sv1, cur1);
6037 pv2 = SvPV_const(sv2, cur2);
6039 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6040 /* Differing utf8ness.
6041 * Do not UTF8size the comparands as a side-effect. */
6044 svrecode = newSVpvn(pv2, cur2);
6045 sv_recode_to_utf8(svrecode, PL_encoding);
6046 pv2 = SvPV_const(svrecode, cur2);
6049 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6054 svrecode = newSVpvn(pv1, cur1);
6055 sv_recode_to_utf8(svrecode, PL_encoding);
6056 pv1 = SvPV_const(svrecode, cur1);
6059 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6065 cmp = cur2 ? -1 : 0;
6069 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6072 cmp = retval < 0 ? -1 : 1;
6073 } else if (cur1 == cur2) {
6076 cmp = cur1 < cur2 ? -1 : 1;
6080 SvREFCNT_dec(svrecode);
6088 =for apidoc sv_cmp_locale
6090 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6091 'use bytes' aware, handles get magic, and will coerce its args to strings
6092 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6098 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6101 #ifdef USE_LOCALE_COLLATE
6107 if (PL_collation_standard)
6111 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6113 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6115 if (!pv1 || !len1) {
6126 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6129 return retval < 0 ? -1 : 1;
6132 * When the result of collation is equality, that doesn't mean
6133 * that there are no differences -- some locales exclude some
6134 * characters from consideration. So to avoid false equalities,
6135 * we use the raw string as a tiebreaker.
6141 #endif /* USE_LOCALE_COLLATE */
6143 return sv_cmp(sv1, sv2);
6147 #ifdef USE_LOCALE_COLLATE
6150 =for apidoc sv_collxfrm
6152 Add Collate Transform magic to an SV if it doesn't already have it.
6154 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6155 scalar data of the variable, but transformed to such a format that a normal
6156 memory comparison can be used to compare the data according to the locale
6163 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6168 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6169 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6175 Safefree(mg->mg_ptr);
6176 s = SvPV_const(sv, len);
6177 if ((xf = mem_collxfrm(s, len, &xlen))) {
6178 if (SvREADONLY(sv)) {
6181 return xf + sizeof(PL_collation_ix);
6184 #ifdef PERL_OLD_COPY_ON_WRITE
6186 sv_force_normal_flags(sv, 0);
6188 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6202 if (mg && mg->mg_ptr) {
6204 return mg->mg_ptr + sizeof(PL_collation_ix);
6212 #endif /* USE_LOCALE_COLLATE */
6217 Get a line from the filehandle and store it into the SV, optionally
6218 appending to the currently-stored string.
6224 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6229 register STDCHAR rslast;
6230 register STDCHAR *bp;
6235 if (SvTHINKFIRST(sv))
6236 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6237 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6239 However, perlbench says it's slower, because the existing swipe code
6240 is faster than copy on write.
6241 Swings and roundabouts. */
6242 SvUPGRADE(sv, SVt_PV);
6247 if (PerlIO_isutf8(fp)) {
6249 sv_utf8_upgrade_nomg(sv);
6250 sv_pos_u2b(sv,&append,0);
6252 } else if (SvUTF8(sv)) {
6253 SV * const tsv = newSV(0);
6254 sv_gets(tsv, fp, 0);
6255 sv_utf8_upgrade_nomg(tsv);
6256 SvCUR_set(sv,append);
6259 goto return_string_or_null;
6264 if (PerlIO_isutf8(fp))
6267 if (IN_PERL_COMPILETIME) {
6268 /* we always read code in line mode */
6272 else if (RsSNARF(PL_rs)) {
6273 /* If it is a regular disk file use size from stat() as estimate
6274 of amount we are going to read -- may result in mallocing
6275 more memory than we really need if the layers below reduce
6276 the size we read (e.g. CRLF or a gzip layer).
6279 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6280 const Off_t offset = PerlIO_tell(fp);
6281 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6282 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6288 else if (RsRECORD(PL_rs)) {
6293 /* Grab the size of the record we're getting */
6294 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6295 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6298 /* VMS wants read instead of fread, because fread doesn't respect */
6299 /* RMS record boundaries. This is not necessarily a good thing to be */
6300 /* doing, but we've got no other real choice - except avoid stdio
6301 as implementation - perhaps write a :vms layer ?
6303 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6305 bytesread = PerlIO_read(fp, buffer, recsize);
6309 SvCUR_set(sv, bytesread += append);
6310 buffer[bytesread] = '\0';
6311 goto return_string_or_null;
6313 else if (RsPARA(PL_rs)) {
6319 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6320 if (PerlIO_isutf8(fp)) {
6321 rsptr = SvPVutf8(PL_rs, rslen);
6324 if (SvUTF8(PL_rs)) {
6325 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6326 Perl_croak(aTHX_ "Wide character in $/");
6329 rsptr = SvPV_const(PL_rs, rslen);
6333 rslast = rslen ? rsptr[rslen - 1] : '\0';
6335 if (rspara) { /* have to do this both before and after */
6336 do { /* to make sure file boundaries work right */
6339 i = PerlIO_getc(fp);
6343 PerlIO_ungetc(fp,i);
6349 /* See if we know enough about I/O mechanism to cheat it ! */
6351 /* This used to be #ifdef test - it is made run-time test for ease
6352 of abstracting out stdio interface. One call should be cheap
6353 enough here - and may even be a macro allowing compile
6357 if (PerlIO_fast_gets(fp)) {
6360 * We're going to steal some values from the stdio struct
6361 * and put EVERYTHING in the innermost loop into registers.
6363 register STDCHAR *ptr;
6367 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6368 /* An ungetc()d char is handled separately from the regular
6369 * buffer, so we getc() it back out and stuff it in the buffer.
6371 i = PerlIO_getc(fp);
6372 if (i == EOF) return 0;
6373 *(--((*fp)->_ptr)) = (unsigned char) i;
6377 /* Here is some breathtakingly efficient cheating */
6379 cnt = PerlIO_get_cnt(fp); /* get count into register */
6380 /* make sure we have the room */
6381 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6382 /* Not room for all of it
6383 if we are looking for a separator and room for some
6385 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6386 /* just process what we have room for */
6387 shortbuffered = cnt - SvLEN(sv) + append + 1;
6388 cnt -= shortbuffered;
6392 /* remember that cnt can be negative */
6393 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6398 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6399 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6400 DEBUG_P(PerlIO_printf(Perl_debug_log,
6401 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6402 DEBUG_P(PerlIO_printf(Perl_debug_log,
6403 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6404 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6405 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6410 while (cnt > 0) { /* this | eat */
6412 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6413 goto thats_all_folks; /* screams | sed :-) */
6417 Copy(ptr, bp, cnt, char); /* this | eat */
6418 bp += cnt; /* screams | dust */
6419 ptr += cnt; /* louder | sed :-) */
6424 if (shortbuffered) { /* oh well, must extend */
6425 cnt = shortbuffered;
6427 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6429 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6430 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6434 DEBUG_P(PerlIO_printf(Perl_debug_log,
6435 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6436 PTR2UV(ptr),(long)cnt));
6437 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6439 DEBUG_P(PerlIO_printf(Perl_debug_log,
6440 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6441 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6442 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6444 /* This used to call 'filbuf' in stdio form, but as that behaves like
6445 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6446 another abstraction. */
6447 i = PerlIO_getc(fp); /* get more characters */
6449 DEBUG_P(PerlIO_printf(Perl_debug_log,
6450 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6451 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6452 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6454 cnt = PerlIO_get_cnt(fp);
6455 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6456 DEBUG_P(PerlIO_printf(Perl_debug_log,
6457 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6459 if (i == EOF) /* all done for ever? */
6460 goto thats_really_all_folks;
6462 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6464 SvGROW(sv, bpx + cnt + 2);
6465 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6467 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6469 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6470 goto thats_all_folks;
6474 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6475 memNE((char*)bp - rslen, rsptr, rslen))
6476 goto screamer; /* go back to the fray */
6477 thats_really_all_folks:
6479 cnt += shortbuffered;
6480 DEBUG_P(PerlIO_printf(Perl_debug_log,
6481 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6482 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6485 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6486 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6488 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6489 DEBUG_P(PerlIO_printf(Perl_debug_log,
6490 "Screamer: done, len=%ld, string=|%.*s|\n",
6491 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6495 /*The big, slow, and stupid way. */
6496 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6497 STDCHAR *buf = NULL;
6498 Newx(buf, 8192, STDCHAR);
6506 register const STDCHAR * const bpe = buf + sizeof(buf);
6508 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6509 ; /* keep reading */
6513 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6514 /* Accomodate broken VAXC compiler, which applies U8 cast to
6515 * both args of ?: operator, causing EOF to change into 255
6518 i = (U8)buf[cnt - 1];
6524 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6526 sv_catpvn(sv, (char *) buf, cnt);
6528 sv_setpvn(sv, (char *) buf, cnt);
6530 if (i != EOF && /* joy */
6532 SvCUR(sv) < rslen ||
6533 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6537 * If we're reading from a TTY and we get a short read,
6538 * indicating that the user hit his EOF character, we need
6539 * to notice it now, because if we try to read from the TTY
6540 * again, the EOF condition will disappear.
6542 * The comparison of cnt to sizeof(buf) is an optimization
6543 * that prevents unnecessary calls to feof().
6547 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6551 #ifdef USE_HEAP_INSTEAD_OF_STACK
6556 if (rspara) { /* have to do this both before and after */
6557 while (i != EOF) { /* to make sure file boundaries work right */
6558 i = PerlIO_getc(fp);
6560 PerlIO_ungetc(fp,i);
6566 return_string_or_null:
6567 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6573 Auto-increment of the value in the SV, doing string to numeric conversion
6574 if necessary. Handles 'get' magic.
6580 Perl_sv_inc(pTHX_ register SV *sv)
6589 if (SvTHINKFIRST(sv)) {
6591 sv_force_normal_flags(sv, 0);
6592 if (SvREADONLY(sv)) {
6593 if (IN_PERL_RUNTIME)
6594 Perl_croak(aTHX_ PL_no_modify);
6598 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6600 i = PTR2IV(SvRV(sv));
6605 flags = SvFLAGS(sv);
6606 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6607 /* It's (privately or publicly) a float, but not tested as an
6608 integer, so test it to see. */
6610 flags = SvFLAGS(sv);
6612 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6613 /* It's publicly an integer, or privately an integer-not-float */
6614 #ifdef PERL_PRESERVE_IVUV
6618 if (SvUVX(sv) == UV_MAX)
6619 sv_setnv(sv, UV_MAX_P1);
6621 (void)SvIOK_only_UV(sv);
6622 SvUV_set(sv, SvUVX(sv) + 1);
6624 if (SvIVX(sv) == IV_MAX)
6625 sv_setuv(sv, (UV)IV_MAX + 1);
6627 (void)SvIOK_only(sv);
6628 SvIV_set(sv, SvIVX(sv) + 1);
6633 if (flags & SVp_NOK) {
6634 (void)SvNOK_only(sv);
6635 SvNV_set(sv, SvNVX(sv) + 1.0);
6639 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6640 if ((flags & SVTYPEMASK) < SVt_PVIV)
6641 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6642 (void)SvIOK_only(sv);
6647 while (isALPHA(*d)) d++;
6648 while (isDIGIT(*d)) d++;
6650 #ifdef PERL_PRESERVE_IVUV
6651 /* Got to punt this as an integer if needs be, but we don't issue
6652 warnings. Probably ought to make the sv_iv_please() that does
6653 the conversion if possible, and silently. */
6654 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6655 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6656 /* Need to try really hard to see if it's an integer.
6657 9.22337203685478e+18 is an integer.
6658 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6659 so $a="9.22337203685478e+18"; $a+0; $a++
6660 needs to be the same as $a="9.22337203685478e+18"; $a++
6667 /* sv_2iv *should* have made this an NV */
6668 if (flags & SVp_NOK) {
6669 (void)SvNOK_only(sv);
6670 SvNV_set(sv, SvNVX(sv) + 1.0);
6673 /* I don't think we can get here. Maybe I should assert this
6674 And if we do get here I suspect that sv_setnv will croak. NWC
6676 #if defined(USE_LONG_DOUBLE)
6677 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",
6678 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6680 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6681 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6684 #endif /* PERL_PRESERVE_IVUV */
6685 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6689 while (d >= SvPVX_const(sv)) {
6697 /* MKS: The original code here died if letters weren't consecutive.
6698 * at least it didn't have to worry about non-C locales. The
6699 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6700 * arranged in order (although not consecutively) and that only
6701 * [A-Za-z] are accepted by isALPHA in the C locale.
6703 if (*d != 'z' && *d != 'Z') {
6704 do { ++*d; } while (!isALPHA(*d));
6707 *(d--) -= 'z' - 'a';
6712 *(d--) -= 'z' - 'a' + 1;
6716 /* oh,oh, the number grew */
6717 SvGROW(sv, SvCUR(sv) + 2);
6718 SvCUR_set(sv, SvCUR(sv) + 1);
6719 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6730 Auto-decrement of the value in the SV, doing string to numeric conversion
6731 if necessary. Handles 'get' magic.
6737 Perl_sv_dec(pTHX_ register SV *sv)
6745 if (SvTHINKFIRST(sv)) {
6747 sv_force_normal_flags(sv, 0);
6748 if (SvREADONLY(sv)) {
6749 if (IN_PERL_RUNTIME)
6750 Perl_croak(aTHX_ PL_no_modify);
6754 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6756 i = PTR2IV(SvRV(sv));
6761 /* Unlike sv_inc we don't have to worry about string-never-numbers
6762 and keeping them magic. But we mustn't warn on punting */
6763 flags = SvFLAGS(sv);
6764 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6765 /* It's publicly an integer, or privately an integer-not-float */
6766 #ifdef PERL_PRESERVE_IVUV
6770 if (SvUVX(sv) == 0) {
6771 (void)SvIOK_only(sv);
6775 (void)SvIOK_only_UV(sv);
6776 SvUV_set(sv, SvUVX(sv) - 1);
6779 if (SvIVX(sv) == IV_MIN)
6780 sv_setnv(sv, (NV)IV_MIN - 1.0);
6782 (void)SvIOK_only(sv);
6783 SvIV_set(sv, SvIVX(sv) - 1);
6788 if (flags & SVp_NOK) {
6789 SvNV_set(sv, SvNVX(sv) - 1.0);
6790 (void)SvNOK_only(sv);
6793 if (!(flags & SVp_POK)) {
6794 if ((flags & SVTYPEMASK) < SVt_PVIV)
6795 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6797 (void)SvIOK_only(sv);
6800 #ifdef PERL_PRESERVE_IVUV
6802 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6803 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6804 /* Need to try really hard to see if it's an integer.
6805 9.22337203685478e+18 is an integer.
6806 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6807 so $a="9.22337203685478e+18"; $a+0; $a--
6808 needs to be the same as $a="9.22337203685478e+18"; $a--
6815 /* sv_2iv *should* have made this an NV */
6816 if (flags & SVp_NOK) {
6817 (void)SvNOK_only(sv);
6818 SvNV_set(sv, SvNVX(sv) - 1.0);
6821 /* I don't think we can get here. Maybe I should assert this
6822 And if we do get here I suspect that sv_setnv will croak. NWC
6824 #if defined(USE_LONG_DOUBLE)
6825 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",
6826 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6828 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6829 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6833 #endif /* PERL_PRESERVE_IVUV */
6834 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6838 =for apidoc sv_mortalcopy
6840 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6841 The new SV is marked as mortal. It will be destroyed "soon", either by an
6842 explicit call to FREETMPS, or by an implicit call at places such as
6843 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6848 /* Make a string that will exist for the duration of the expression
6849 * evaluation. Actually, it may have to last longer than that, but
6850 * hopefully we won't free it until it has been assigned to a
6851 * permanent location. */
6854 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6860 sv_setsv(sv,oldstr);
6862 PL_tmps_stack[++PL_tmps_ix] = sv;
6868 =for apidoc sv_newmortal
6870 Creates a new null SV which is mortal. The reference count of the SV is
6871 set to 1. It will be destroyed "soon", either by an explicit call to
6872 FREETMPS, or by an implicit call at places such as statement boundaries.
6873 See also C<sv_mortalcopy> and C<sv_2mortal>.
6879 Perl_sv_newmortal(pTHX)
6885 SvFLAGS(sv) = SVs_TEMP;
6887 PL_tmps_stack[++PL_tmps_ix] = sv;
6892 =for apidoc sv_2mortal
6894 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6895 by an explicit call to FREETMPS, or by an implicit call at places such as
6896 statement boundaries. SvTEMP() is turned on which means that the SV's
6897 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6898 and C<sv_mortalcopy>.
6904 Perl_sv_2mortal(pTHX_ register SV *sv)
6909 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6912 PL_tmps_stack[++PL_tmps_ix] = sv;
6920 Creates a new SV and copies a string into it. The reference count for the
6921 SV is set to 1. If C<len> is zero, Perl will compute the length using
6922 strlen(). For efficiency, consider using C<newSVpvn> instead.
6928 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6934 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6939 =for apidoc newSVpvn
6941 Creates a new SV and copies a string into it. The reference count for the
6942 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6943 string. You are responsible for ensuring that the source string is at least
6944 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6950 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6956 sv_setpvn(sv,s,len);
6962 =for apidoc newSVhek
6964 Creates a new SV from the hash key structure. It will generate scalars that
6965 point to the shared string table where possible. Returns a new (undefined)
6966 SV if the hek is NULL.
6972 Perl_newSVhek(pTHX_ const HEK *hek)
6982 if (HEK_LEN(hek) == HEf_SVKEY) {
6983 return newSVsv(*(SV**)HEK_KEY(hek));
6985 const int flags = HEK_FLAGS(hek);
6986 if (flags & HVhek_WASUTF8) {
6988 Andreas would like keys he put in as utf8 to come back as utf8
6990 STRLEN utf8_len = HEK_LEN(hek);
6991 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6992 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6995 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6997 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6998 /* We don't have a pointer to the hv, so we have to replicate the
6999 flag into every HEK. This hv is using custom a hasing
7000 algorithm. Hence we can't return a shared string scalar, as
7001 that would contain the (wrong) hash value, and might get passed
7002 into an hv routine with a regular hash.
7003 Similarly, a hash that isn't using shared hash keys has to have
7004 the flag in every key so that we know not to try to call
7005 share_hek_kek on it. */
7007 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7012 /* This will be overwhelminly the most common case. */
7014 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7015 more efficient than sharepvn(). */
7019 sv_upgrade(sv, SVt_PV);
7020 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7021 SvCUR_set(sv, HEK_LEN(hek));
7034 =for apidoc newSVpvn_share
7036 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7037 table. If the string does not already exist in the table, it is created
7038 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7039 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7040 otherwise the hash is computed. The idea here is that as the string table
7041 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7042 hash lookup will avoid string compare.
7048 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7052 bool is_utf8 = FALSE;
7053 const char *const orig_src = src;
7056 STRLEN tmplen = -len;
7058 /* See the note in hv.c:hv_fetch() --jhi */
7059 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7063 PERL_HASH(hash, src, len);
7065 sv_upgrade(sv, SVt_PV);
7066 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7074 if (src != orig_src)
7080 #if defined(PERL_IMPLICIT_CONTEXT)
7082 /* pTHX_ magic can't cope with varargs, so this is a no-context
7083 * version of the main function, (which may itself be aliased to us).
7084 * Don't access this version directly.
7088 Perl_newSVpvf_nocontext(const char* pat, ...)
7093 va_start(args, pat);
7094 sv = vnewSVpvf(pat, &args);
7101 =for apidoc newSVpvf
7103 Creates a new SV and initializes it with the string formatted like
7110 Perl_newSVpvf(pTHX_ const char* pat, ...)
7114 va_start(args, pat);
7115 sv = vnewSVpvf(pat, &args);
7120 /* backend for newSVpvf() and newSVpvf_nocontext() */
7123 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7128 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7135 Creates a new SV and copies a floating point value into it.
7136 The reference count for the SV is set to 1.
7142 Perl_newSVnv(pTHX_ NV n)
7155 Creates a new SV and copies an integer into it. The reference count for the
7162 Perl_newSViv(pTHX_ IV i)
7175 Creates a new SV and copies an unsigned integer into it.
7176 The reference count for the SV is set to 1.
7182 Perl_newSVuv(pTHX_ UV u)
7193 =for apidoc newRV_noinc
7195 Creates an RV wrapper for an SV. The reference count for the original
7196 SV is B<not> incremented.
7202 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7208 sv_upgrade(sv, SVt_RV);
7210 SvRV_set(sv, tmpRef);
7215 /* newRV_inc is the official function name to use now.
7216 * newRV_inc is in fact #defined to newRV in sv.h
7220 Perl_newRV(pTHX_ SV *sv)
7223 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7229 Creates a new SV which is an exact duplicate of the original SV.
7236 Perl_newSVsv(pTHX_ register SV *old)
7243 if (SvTYPE(old) == SVTYPEMASK) {
7244 if (ckWARN_d(WARN_INTERNAL))
7245 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7249 /* SV_GMAGIC is the default for sv_setv()
7250 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7251 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7252 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7257 =for apidoc sv_reset
7259 Underlying implementation for the C<reset> Perl function.
7260 Note that the perl-level function is vaguely deprecated.
7266 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7269 char todo[PERL_UCHAR_MAX+1];
7274 if (!*s) { /* reset ?? searches */
7275 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7277 PMOP *pm = (PMOP *) mg->mg_obj;
7279 pm->op_pmdynflags &= ~PMdf_USED;
7286 /* reset variables */
7288 if (!HvARRAY(stash))
7291 Zero(todo, 256, char);
7294 I32 i = (unsigned char)*s;
7298 max = (unsigned char)*s++;
7299 for ( ; i <= max; i++) {
7302 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7304 for (entry = HvARRAY(stash)[i];
7306 entry = HeNEXT(entry))
7311 if (!todo[(U8)*HeKEY(entry)])
7313 gv = (GV*)HeVAL(entry);
7316 if (SvTHINKFIRST(sv)) {
7317 if (!SvREADONLY(sv) && SvROK(sv))
7319 /* XXX Is this continue a bug? Why should THINKFIRST
7320 exempt us from resetting arrays and hashes? */
7324 if (SvTYPE(sv) >= SVt_PV) {
7326 if (SvPVX_const(sv) != NULL)
7334 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7336 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7339 # if defined(USE_ENVIRON_ARRAY)
7342 # endif /* USE_ENVIRON_ARRAY */
7353 Using various gambits, try to get an IO from an SV: the IO slot if its a
7354 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7355 named after the PV if we're a string.
7361 Perl_sv_2io(pTHX_ SV *sv)
7366 switch (SvTYPE(sv)) {
7374 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7378 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7380 return sv_2io(SvRV(sv));
7381 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7387 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7396 Using various gambits, try to get a CV from an SV; in addition, try if
7397 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7398 The flags in C<lref> are passed to sv_fetchsv.
7404 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7415 switch (SvTYPE(sv)) {
7434 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7435 tryAMAGICunDEREF(to_cv);
7438 if (SvTYPE(sv) == SVt_PVCV) {
7447 Perl_croak(aTHX_ "Not a subroutine reference");
7452 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7458 /* Some flags to gv_fetchsv mean don't really create the GV */
7459 if (SvTYPE(gv) != SVt_PVGV) {
7465 if (lref && !GvCVu(gv)) {
7469 gv_efullname3(tmpsv, gv, NULL);
7470 /* XXX this is probably not what they think they're getting.
7471 * It has the same effect as "sub name;", i.e. just a forward
7473 newSUB(start_subparse(FALSE, 0),
7474 newSVOP(OP_CONST, 0, tmpsv),
7478 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7488 Returns true if the SV has a true value by Perl's rules.
7489 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7490 instead use an in-line version.
7496 Perl_sv_true(pTHX_ register SV *sv)
7501 register const XPV* const tXpv = (XPV*)SvANY(sv);
7503 (tXpv->xpv_cur > 1 ||
7504 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7511 return SvIVX(sv) != 0;
7514 return SvNVX(sv) != 0.0;
7516 return sv_2bool(sv);
7522 =for apidoc sv_pvn_force
7524 Get a sensible string out of the SV somehow.
7525 A private implementation of the C<SvPV_force> macro for compilers which
7526 can't cope with complex macro expressions. Always use the macro instead.
7528 =for apidoc sv_pvn_force_flags
7530 Get a sensible string out of the SV somehow.
7531 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7532 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7533 implemented in terms of this function.
7534 You normally want to use the various wrapper macros instead: see
7535 C<SvPV_force> and C<SvPV_force_nomg>
7541 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7544 if (SvTHINKFIRST(sv) && !SvROK(sv))
7545 sv_force_normal_flags(sv, 0);
7555 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7556 const char * const ref = sv_reftype(sv,0);
7558 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7559 ref, OP_NAME(PL_op));
7561 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7563 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7564 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7566 s = sv_2pv_flags(sv, &len, flags);
7570 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7573 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7574 SvGROW(sv, len + 1);
7575 Move(s,SvPVX(sv),len,char);
7580 SvPOK_on(sv); /* validate pointer */
7582 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7583 PTR2UV(sv),SvPVX_const(sv)));
7586 return SvPVX_mutable(sv);
7590 =for apidoc sv_pvbyten_force
7592 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7598 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7600 sv_pvn_force(sv,lp);
7601 sv_utf8_downgrade(sv,0);
7607 =for apidoc sv_pvutf8n_force
7609 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7615 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7617 sv_pvn_force(sv,lp);
7618 sv_utf8_upgrade(sv);
7624 =for apidoc sv_reftype
7626 Returns a string describing what the SV is a reference to.
7632 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7634 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7635 inside return suggests a const propagation bug in g++. */
7636 if (ob && SvOBJECT(sv)) {
7637 char * const name = HvNAME_get(SvSTASH(sv));
7638 return name ? name : (char *) "__ANON__";
7641 switch (SvTYPE(sv)) {
7657 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7658 /* tied lvalues should appear to be
7659 * scalars for backwards compatitbility */
7660 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7661 ? "SCALAR" : "LVALUE");
7662 case SVt_PVAV: return "ARRAY";
7663 case SVt_PVHV: return "HASH";
7664 case SVt_PVCV: return "CODE";
7665 case SVt_PVGV: return "GLOB";
7666 case SVt_PVFM: return "FORMAT";
7667 case SVt_PVIO: return "IO";
7668 case SVt_BIND: return "BIND";
7669 default: return "UNKNOWN";
7675 =for apidoc sv_isobject
7677 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7678 object. If the SV is not an RV, or if the object is not blessed, then this
7685 Perl_sv_isobject(pTHX_ SV *sv)
7701 Returns a boolean indicating whether the SV is blessed into the specified
7702 class. This does not check for subtypes; use C<sv_derived_from> to verify
7703 an inheritance relationship.
7709 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7720 hvname = HvNAME_get(SvSTASH(sv));
7724 return strEQ(hvname, name);
7730 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7731 it will be upgraded to one. If C<classname> is non-null then the new SV will
7732 be blessed in the specified package. The new SV is returned and its
7733 reference count is 1.
7739 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7746 SV_CHECK_THINKFIRST_COW_DROP(rv);
7749 if (SvTYPE(rv) >= SVt_PVMG) {
7750 const U32 refcnt = SvREFCNT(rv);
7754 SvREFCNT(rv) = refcnt;
7756 sv_upgrade(rv, SVt_RV);
7757 } else if (SvROK(rv)) {
7758 SvREFCNT_dec(SvRV(rv));
7759 } else if (SvTYPE(rv) < SVt_RV)
7760 sv_upgrade(rv, SVt_RV);
7761 else if (SvTYPE(rv) > SVt_RV) {
7772 HV* const stash = gv_stashpv(classname, GV_ADD);
7773 (void)sv_bless(rv, stash);
7779 =for apidoc sv_setref_pv
7781 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7782 argument will be upgraded to an RV. That RV will be modified to point to
7783 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7784 into the SV. The C<classname> argument indicates the package for the
7785 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7786 will have a reference count of 1, and the RV will be returned.
7788 Do not use with other Perl types such as HV, AV, SV, CV, because those
7789 objects will become corrupted by the pointer copy process.
7791 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7797 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7801 sv_setsv(rv, &PL_sv_undef);
7805 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7810 =for apidoc sv_setref_iv
7812 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7813 argument will be upgraded to an RV. That RV will be modified to point to
7814 the new SV. The C<classname> argument indicates the package for the
7815 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7816 will have a reference count of 1, and the RV will be returned.
7822 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7824 sv_setiv(newSVrv(rv,classname), iv);
7829 =for apidoc sv_setref_uv
7831 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7832 argument will be upgraded to an RV. That RV will be modified to point to
7833 the new SV. The C<classname> argument indicates the package for the
7834 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7835 will have a reference count of 1, and the RV will be returned.
7841 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7843 sv_setuv(newSVrv(rv,classname), uv);
7848 =for apidoc sv_setref_nv
7850 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7851 argument will be upgraded to an RV. That RV will be modified to point to
7852 the new SV. The C<classname> argument indicates the package for the
7853 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7854 will have a reference count of 1, and the RV will be returned.
7860 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7862 sv_setnv(newSVrv(rv,classname), nv);
7867 =for apidoc sv_setref_pvn
7869 Copies a string into a new SV, optionally blessing the SV. The length of the
7870 string must be specified with C<n>. The C<rv> argument will be upgraded to
7871 an RV. That RV will be modified to point to the new SV. The C<classname>
7872 argument indicates the package for the blessing. Set C<classname> to
7873 C<NULL> to avoid the blessing. The new SV will have a reference count
7874 of 1, and the RV will be returned.
7876 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7882 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7884 sv_setpvn(newSVrv(rv,classname), pv, n);
7889 =for apidoc sv_bless
7891 Blesses an SV into a specified package. The SV must be an RV. The package
7892 must be designated by its stash (see C<gv_stashpv()>). The reference count
7893 of the SV is unaffected.
7899 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7904 Perl_croak(aTHX_ "Can't bless non-reference value");
7906 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7907 if (SvREADONLY(tmpRef))
7908 Perl_croak(aTHX_ PL_no_modify);
7909 if (SvOBJECT(tmpRef)) {
7910 if (SvTYPE(tmpRef) != SVt_PVIO)
7912 SvREFCNT_dec(SvSTASH(tmpRef));
7915 SvOBJECT_on(tmpRef);
7916 if (SvTYPE(tmpRef) != SVt_PVIO)
7918 SvUPGRADE(tmpRef, SVt_PVMG);
7919 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7926 if(SvSMAGICAL(tmpRef))
7927 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7935 /* Downgrades a PVGV to a PVMG.
7939 S_sv_unglob(pTHX_ SV *sv)
7943 SV * const temp = sv_newmortal();
7945 assert(SvTYPE(sv) == SVt_PVGV);
7947 gv_efullname3(temp, (GV *) sv, "*");
7953 sv_del_backref((SV*)GvSTASH(sv), sv);
7957 if (GvNAME_HEK(sv)) {
7958 unshare_hek(GvNAME_HEK(sv));
7960 isGV_with_GP_off(sv);
7962 /* need to keep SvANY(sv) in the right arena */
7963 xpvmg = new_XPVMG();
7964 StructCopy(SvANY(sv), xpvmg, XPVMG);
7965 del_XPVGV(SvANY(sv));
7968 SvFLAGS(sv) &= ~SVTYPEMASK;
7969 SvFLAGS(sv) |= SVt_PVMG;
7971 /* Intentionally not calling any local SET magic, as this isn't so much a
7972 set operation as merely an internal storage change. */
7973 sv_setsv_flags(sv, temp, 0);
7977 =for apidoc sv_unref_flags
7979 Unsets the RV status of the SV, and decrements the reference count of
7980 whatever was being referenced by the RV. This can almost be thought of
7981 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7982 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7983 (otherwise the decrementing is conditional on the reference count being
7984 different from one or the reference being a readonly SV).
7991 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7993 SV* const target = SvRV(ref);
7995 if (SvWEAKREF(ref)) {
7996 sv_del_backref(target, ref);
7998 SvRV_set(ref, NULL);
8001 SvRV_set(ref, NULL);
8003 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8004 assigned to as BEGIN {$a = \"Foo"} will fail. */
8005 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8006 SvREFCNT_dec(target);
8007 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8008 sv_2mortal(target); /* Schedule for freeing later */
8012 =for apidoc sv_untaint
8014 Untaint an SV. Use C<SvTAINTED_off> instead.
8019 Perl_sv_untaint(pTHX_ SV *sv)
8021 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8022 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8029 =for apidoc sv_tainted
8031 Test an SV for taintedness. Use C<SvTAINTED> instead.
8036 Perl_sv_tainted(pTHX_ SV *sv)
8038 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8039 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8040 if (mg && (mg->mg_len & 1) )
8047 =for apidoc sv_setpviv
8049 Copies an integer into the given SV, also updating its string value.
8050 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8056 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8058 char buf[TYPE_CHARS(UV)];
8060 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8062 sv_setpvn(sv, ptr, ebuf - ptr);
8066 =for apidoc sv_setpviv_mg
8068 Like C<sv_setpviv>, but also handles 'set' magic.
8074 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8080 #if defined(PERL_IMPLICIT_CONTEXT)
8082 /* pTHX_ magic can't cope with varargs, so this is a no-context
8083 * version of the main function, (which may itself be aliased to us).
8084 * Don't access this version directly.
8088 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8092 va_start(args, pat);
8093 sv_vsetpvf(sv, pat, &args);
8097 /* pTHX_ magic can't cope with varargs, so this is a no-context
8098 * version of the main function, (which may itself be aliased to us).
8099 * Don't access this version directly.
8103 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8107 va_start(args, pat);
8108 sv_vsetpvf_mg(sv, pat, &args);
8114 =for apidoc sv_setpvf
8116 Works like C<sv_catpvf> but copies the text into the SV instead of
8117 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8123 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8126 va_start(args, pat);
8127 sv_vsetpvf(sv, pat, &args);
8132 =for apidoc sv_vsetpvf
8134 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8135 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8137 Usually used via its frontend C<sv_setpvf>.
8143 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8145 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8149 =for apidoc sv_setpvf_mg
8151 Like C<sv_setpvf>, but also handles 'set' magic.
8157 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8160 va_start(args, pat);
8161 sv_vsetpvf_mg(sv, pat, &args);
8166 =for apidoc sv_vsetpvf_mg
8168 Like C<sv_vsetpvf>, but also handles 'set' magic.
8170 Usually used via its frontend C<sv_setpvf_mg>.
8176 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8178 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8182 #if defined(PERL_IMPLICIT_CONTEXT)
8184 /* pTHX_ magic can't cope with varargs, so this is a no-context
8185 * version of the main function, (which may itself be aliased to us).
8186 * Don't access this version directly.
8190 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8194 va_start(args, pat);
8195 sv_vcatpvf(sv, pat, &args);
8199 /* pTHX_ magic can't cope with varargs, so this is a no-context
8200 * version of the main function, (which may itself be aliased to us).
8201 * Don't access this version directly.
8205 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8209 va_start(args, pat);
8210 sv_vcatpvf_mg(sv, pat, &args);
8216 =for apidoc sv_catpvf
8218 Processes its arguments like C<sprintf> and appends the formatted
8219 output to an SV. If the appended data contains "wide" characters
8220 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8221 and characters >255 formatted with %c), the original SV might get
8222 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8223 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8224 valid UTF-8; if the original SV was bytes, the pattern should be too.
8229 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8232 va_start(args, pat);
8233 sv_vcatpvf(sv, pat, &args);
8238 =for apidoc sv_vcatpvf
8240 Processes its arguments like C<vsprintf> and appends the formatted output
8241 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8243 Usually used via its frontend C<sv_catpvf>.
8249 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8251 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8255 =for apidoc sv_catpvf_mg
8257 Like C<sv_catpvf>, but also handles 'set' magic.
8263 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8266 va_start(args, pat);
8267 sv_vcatpvf_mg(sv, pat, &args);
8272 =for apidoc sv_vcatpvf_mg
8274 Like C<sv_vcatpvf>, but also handles 'set' magic.
8276 Usually used via its frontend C<sv_catpvf_mg>.
8282 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8284 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8289 =for apidoc sv_vsetpvfn
8291 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8294 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8300 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8302 sv_setpvn(sv, "", 0);
8303 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8307 S_expect_number(pTHX_ char** pattern)
8311 switch (**pattern) {
8312 case '1': case '2': case '3':
8313 case '4': case '5': case '6':
8314 case '7': case '8': case '9':
8315 var = *(*pattern)++ - '0';
8316 while (isDIGIT(**pattern)) {
8317 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8319 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8327 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8329 const int neg = nv < 0;
8338 if (uv & 1 && uv == nv)
8339 uv--; /* Round to even */
8341 const unsigned dig = uv % 10;
8354 =for apidoc sv_vcatpvfn
8356 Processes its arguments like C<vsprintf> and appends the formatted output
8357 to an SV. Uses an array of SVs if the C style variable argument list is
8358 missing (NULL). When running with taint checks enabled, indicates via
8359 C<maybe_tainted> if results are untrustworthy (often due to the use of
8362 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8368 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8369 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8370 vec_utf8 = DO_UTF8(vecsv);
8372 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8375 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8383 static const char nullstr[] = "(null)";
8385 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8386 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8388 /* Times 4: a decimal digit takes more than 3 binary digits.
8389 * NV_DIG: mantissa takes than many decimal digits.
8390 * Plus 32: Playing safe. */
8391 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8392 /* large enough for "%#.#f" --chip */
8393 /* what about long double NVs? --jhi */
8395 PERL_UNUSED_ARG(maybe_tainted);
8397 /* no matter what, this is a string now */
8398 (void)SvPV_force(sv, origlen);
8400 /* special-case "", "%s", and "%-p" (SVf - see below) */
8403 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8405 const char * const s = va_arg(*args, char*);
8406 sv_catpv(sv, s ? s : nullstr);
8408 else if (svix < svmax) {
8409 sv_catsv(sv, *svargs);
8413 if (args && patlen == 3 && pat[0] == '%' &&
8414 pat[1] == '-' && pat[2] == 'p') {
8415 argsv = (SV*)va_arg(*args, void*);
8416 sv_catsv(sv, argsv);
8420 #ifndef USE_LONG_DOUBLE
8421 /* special-case "%.<number>[gf]" */
8422 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8423 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8424 unsigned digits = 0;
8428 while (*pp >= '0' && *pp <= '9')
8429 digits = 10 * digits + (*pp++ - '0');
8430 if (pp - pat == (int)patlen - 1) {
8438 /* Add check for digits != 0 because it seems that some
8439 gconverts are buggy in this case, and we don't yet have
8440 a Configure test for this. */
8441 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8442 /* 0, point, slack */
8443 Gconvert(nv, (int)digits, 0, ebuf);
8445 if (*ebuf) /* May return an empty string for digits==0 */
8448 } else if (!digits) {
8451 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8452 sv_catpvn(sv, p, l);
8458 #endif /* !USE_LONG_DOUBLE */
8460 if (!args && svix < svmax && DO_UTF8(*svargs))
8463 patend = (char*)pat + patlen;
8464 for (p = (char*)pat; p < patend; p = q) {
8467 bool vectorize = FALSE;
8468 bool vectorarg = FALSE;
8469 bool vec_utf8 = FALSE;
8475 bool has_precis = FALSE;
8477 const I32 osvix = svix;
8478 bool is_utf8 = FALSE; /* is this item utf8? */
8479 #ifdef HAS_LDBL_SPRINTF_BUG
8480 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8481 with sfio - Allen <allens@cpan.org> */
8482 bool fix_ldbl_sprintf_bug = FALSE;
8486 U8 utf8buf[UTF8_MAXBYTES+1];
8487 STRLEN esignlen = 0;
8489 const char *eptr = NULL;
8492 const U8 *vecstr = NULL;
8499 /* we need a long double target in case HAS_LONG_DOUBLE but
8502 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8510 const char *dotstr = ".";
8511 STRLEN dotstrlen = 1;
8512 I32 efix = 0; /* explicit format parameter index */
8513 I32 ewix = 0; /* explicit width index */
8514 I32 epix = 0; /* explicit precision index */
8515 I32 evix = 0; /* explicit vector index */
8516 bool asterisk = FALSE;
8518 /* echo everything up to the next format specification */
8519 for (q = p; q < patend && *q != '%'; ++q) ;
8521 if (has_utf8 && !pat_utf8)
8522 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8524 sv_catpvn(sv, p, q - p);
8531 We allow format specification elements in this order:
8532 \d+\$ explicit format parameter index
8534 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8535 0 flag (as above): repeated to allow "v02"
8536 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8537 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8539 [%bcdefginopsuxDFOUX] format (mandatory)
8544 As of perl5.9.3, printf format checking is on by default.
8545 Internally, perl uses %p formats to provide an escape to
8546 some extended formatting. This block deals with those
8547 extensions: if it does not match, (char*)q is reset and
8548 the normal format processing code is used.
8550 Currently defined extensions are:
8551 %p include pointer address (standard)
8552 %-p (SVf) include an SV (previously %_)
8553 %-<num>p include an SV with precision <num>
8554 %1p (VDf) include a v-string (as %vd)
8555 %<num>p reserved for future extensions
8557 Robin Barker 2005-07-14
8564 n = expect_number(&q);
8571 argsv = (SV*)va_arg(*args, void*);
8572 eptr = SvPVx_const(argsv, elen);
8578 else if (n == vdNUMBER) { /* VDf */
8585 if (ckWARN_d(WARN_INTERNAL))
8586 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8587 "internal %%<num>p might conflict with future printf extensions");
8593 if ( (width = expect_number(&q)) ) {
8608 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8637 if ( (ewix = expect_number(&q)) )
8646 if ((vectorarg = asterisk)) {
8659 width = expect_number(&q);
8665 vecsv = va_arg(*args, SV*);
8667 vecsv = (evix > 0 && evix <= svmax)
8668 ? svargs[evix-1] : &PL_sv_undef;
8670 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8672 dotstr = SvPV_const(vecsv, dotstrlen);
8673 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8674 bad with tied or overloaded values that return UTF8. */
8677 else if (has_utf8) {
8678 vecsv = sv_mortalcopy(vecsv);
8679 sv_utf8_upgrade(vecsv);
8680 dotstr = SvPV_const(vecsv, dotstrlen);
8687 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8688 vecsv = svargs[efix ? efix-1 : svix++];
8689 vecstr = (U8*)SvPV_const(vecsv,veclen);
8690 vec_utf8 = DO_UTF8(vecsv);
8692 /* if this is a version object, we need to convert
8693 * back into v-string notation and then let the
8694 * vectorize happen normally
8696 if (sv_derived_from(vecsv, "version")) {
8697 char *version = savesvpv(vecsv);
8698 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8699 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8700 "vector argument not supported with alpha versions");
8703 vecsv = sv_newmortal();
8704 /* scan_vstring is expected to be called during
8705 * tokenization, so we need to fake up the end
8706 * of the buffer for it
8708 PL_bufend = version + veclen;
8709 scan_vstring(version, vecsv);
8710 vecstr = (U8*)SvPV_const(vecsv, veclen);
8711 vec_utf8 = DO_UTF8(vecsv);
8723 i = va_arg(*args, int);
8725 i = (ewix ? ewix <= svmax : svix < svmax) ?
8726 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8728 width = (i < 0) ? -i : i;
8738 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8740 /* XXX: todo, support specified precision parameter */
8744 i = va_arg(*args, int);
8746 i = (ewix ? ewix <= svmax : svix < svmax)
8747 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8749 has_precis = !(i < 0);
8754 precis = precis * 10 + (*q++ - '0');
8763 case 'I': /* Ix, I32x, and I64x */
8765 if (q[1] == '6' && q[2] == '4') {
8771 if (q[1] == '3' && q[2] == '2') {
8781 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8792 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8793 if (*(q + 1) == 'l') { /* lld, llf */
8819 if (!vectorize && !args) {
8821 const I32 i = efix-1;
8822 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8824 argsv = (svix >= 0 && svix < svmax)
8825 ? svargs[svix++] : &PL_sv_undef;
8836 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8838 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8840 eptr = (char*)utf8buf;
8841 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8855 eptr = va_arg(*args, char*);
8857 #ifdef MACOS_TRADITIONAL
8858 /* On MacOS, %#s format is used for Pascal strings */
8863 elen = strlen(eptr);
8865 eptr = (char *)nullstr;
8866 elen = sizeof nullstr - 1;
8870 eptr = SvPVx_const(argsv, elen);
8871 if (DO_UTF8(argsv)) {
8872 I32 old_precis = precis;
8873 if (has_precis && precis < elen) {
8875 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8878 if (width) { /* fudge width (can't fudge elen) */
8879 if (has_precis && precis < elen)
8880 width += precis - old_precis;
8882 width += elen - sv_len_utf8(argsv);
8889 if (has_precis && elen > precis)
8896 if (alt || vectorize)
8898 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8919 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8928 esignbuf[esignlen++] = plus;
8932 case 'h': iv = (short)va_arg(*args, int); break;
8933 case 'l': iv = va_arg(*args, long); break;
8934 case 'V': iv = va_arg(*args, IV); break;
8935 default: iv = va_arg(*args, int); break;
8937 case 'q': iv = va_arg(*args, Quad_t); break;
8942 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8944 case 'h': iv = (short)tiv; break;
8945 case 'l': iv = (long)tiv; break;
8947 default: iv = tiv; break;
8949 case 'q': iv = (Quad_t)tiv; break;
8953 if ( !vectorize ) /* we already set uv above */
8958 esignbuf[esignlen++] = plus;
8962 esignbuf[esignlen++] = '-';
9006 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9017 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9018 case 'l': uv = va_arg(*args, unsigned long); break;
9019 case 'V': uv = va_arg(*args, UV); break;
9020 default: uv = va_arg(*args, unsigned); break;
9022 case 'q': uv = va_arg(*args, Uquad_t); break;
9027 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9029 case 'h': uv = (unsigned short)tuv; break;
9030 case 'l': uv = (unsigned long)tuv; break;
9032 default: uv = tuv; break;
9034 case 'q': uv = (Uquad_t)tuv; break;
9041 char *ptr = ebuf + sizeof ebuf;
9042 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9048 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9054 esignbuf[esignlen++] = '0';
9055 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9063 if (alt && *ptr != '0')
9072 esignbuf[esignlen++] = '0';
9073 esignbuf[esignlen++] = c;
9076 default: /* it had better be ten or less */
9080 } while (uv /= base);
9083 elen = (ebuf + sizeof ebuf) - ptr;
9087 zeros = precis - elen;
9088 else if (precis == 0 && elen == 1 && *eptr == '0'
9089 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9092 /* a precision nullifies the 0 flag. */
9099 /* FLOATING POINT */
9102 c = 'f'; /* maybe %F isn't supported here */
9110 /* This is evil, but floating point is even more evil */
9112 /* for SV-style calling, we can only get NV
9113 for C-style calling, we assume %f is double;
9114 for simplicity we allow any of %Lf, %llf, %qf for long double
9118 #if defined(USE_LONG_DOUBLE)
9122 /* [perl #20339] - we should accept and ignore %lf rather than die */
9126 #if defined(USE_LONG_DOUBLE)
9127 intsize = args ? 0 : 'q';
9131 #if defined(HAS_LONG_DOUBLE)
9140 /* now we need (long double) if intsize == 'q', else (double) */
9142 #if LONG_DOUBLESIZE > DOUBLESIZE
9144 va_arg(*args, long double) :
9145 va_arg(*args, double)
9147 va_arg(*args, double)
9152 if (c != 'e' && c != 'E') {
9154 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9155 will cast our (long double) to (double) */
9156 (void)Perl_frexp(nv, &i);
9157 if (i == PERL_INT_MIN)
9158 Perl_die(aTHX_ "panic: frexp");
9160 need = BIT_DIGITS(i);
9162 need += has_precis ? precis : 6; /* known default */
9167 #ifdef HAS_LDBL_SPRINTF_BUG
9168 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9169 with sfio - Allen <allens@cpan.org> */
9172 # define MY_DBL_MAX DBL_MAX
9173 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9174 # if DOUBLESIZE >= 8
9175 # define MY_DBL_MAX 1.7976931348623157E+308L
9177 # define MY_DBL_MAX 3.40282347E+38L
9181 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9182 # define MY_DBL_MAX_BUG 1L
9184 # define MY_DBL_MAX_BUG MY_DBL_MAX
9188 # define MY_DBL_MIN DBL_MIN
9189 # else /* XXX guessing! -Allen */
9190 # if DOUBLESIZE >= 8
9191 # define MY_DBL_MIN 2.2250738585072014E-308L
9193 # define MY_DBL_MIN 1.17549435E-38L
9197 if ((intsize == 'q') && (c == 'f') &&
9198 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9200 /* it's going to be short enough that
9201 * long double precision is not needed */
9203 if ((nv <= 0L) && (nv >= -0L))
9204 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9206 /* would use Perl_fp_class as a double-check but not
9207 * functional on IRIX - see perl.h comments */
9209 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9210 /* It's within the range that a double can represent */
9211 #if defined(DBL_MAX) && !defined(DBL_MIN)
9212 if ((nv >= ((long double)1/DBL_MAX)) ||
9213 (nv <= (-(long double)1/DBL_MAX)))
9215 fix_ldbl_sprintf_bug = TRUE;
9218 if (fix_ldbl_sprintf_bug == TRUE) {
9228 # undef MY_DBL_MAX_BUG
9231 #endif /* HAS_LDBL_SPRINTF_BUG */
9233 need += 20; /* fudge factor */
9234 if (PL_efloatsize < need) {
9235 Safefree(PL_efloatbuf);
9236 PL_efloatsize = need + 20; /* more fudge */
9237 Newx(PL_efloatbuf, PL_efloatsize, char);
9238 PL_efloatbuf[0] = '\0';
9241 if ( !(width || left || plus || alt) && fill != '0'
9242 && has_precis && intsize != 'q' ) { /* Shortcuts */
9243 /* See earlier comment about buggy Gconvert when digits,
9245 if ( c == 'g' && precis) {
9246 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9247 /* May return an empty string for digits==0 */
9248 if (*PL_efloatbuf) {
9249 elen = strlen(PL_efloatbuf);
9250 goto float_converted;
9252 } else if ( c == 'f' && !precis) {
9253 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9258 char *ptr = ebuf + sizeof ebuf;
9261 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9262 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9263 if (intsize == 'q') {
9264 /* Copy the one or more characters in a long double
9265 * format before the 'base' ([efgEFG]) character to
9266 * the format string. */
9267 static char const prifldbl[] = PERL_PRIfldbl;
9268 char const *p = prifldbl + sizeof(prifldbl) - 3;
9269 while (p >= prifldbl) { *--ptr = *p--; }
9274 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9279 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9291 /* No taint. Otherwise we are in the strange situation
9292 * where printf() taints but print($float) doesn't.
9294 #if defined(HAS_LONG_DOUBLE)
9295 elen = ((intsize == 'q')
9296 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9297 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9299 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9303 eptr = PL_efloatbuf;
9311 i = SvCUR(sv) - origlen;
9314 case 'h': *(va_arg(*args, short*)) = i; break;
9315 default: *(va_arg(*args, int*)) = i; break;
9316 case 'l': *(va_arg(*args, long*)) = i; break;
9317 case 'V': *(va_arg(*args, IV*)) = i; break;
9319 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9324 sv_setuv_mg(argsv, (UV)i);
9325 continue; /* not "break" */
9332 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9333 && ckWARN(WARN_PRINTF))
9335 SV * const msg = sv_newmortal();
9336 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9337 (PL_op->op_type == OP_PRTF) ? "" : "s");
9340 Perl_sv_catpvf(aTHX_ msg,
9341 "\"%%%c\"", c & 0xFF);
9343 Perl_sv_catpvf(aTHX_ msg,
9344 "\"%%\\%03"UVof"\"",
9347 sv_catpvs(msg, "end of string");
9348 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9351 /* output mangled stuff ... */
9357 /* ... right here, because formatting flags should not apply */
9358 SvGROW(sv, SvCUR(sv) + elen + 1);
9360 Copy(eptr, p, elen, char);
9363 SvCUR_set(sv, p - SvPVX_const(sv));
9365 continue; /* not "break" */
9368 if (is_utf8 != has_utf8) {
9371 sv_utf8_upgrade(sv);
9374 const STRLEN old_elen = elen;
9375 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9376 sv_utf8_upgrade(nsv);
9377 eptr = SvPVX_const(nsv);
9380 if (width) { /* fudge width (can't fudge elen) */
9381 width += elen - old_elen;
9387 have = esignlen + zeros + elen;
9389 Perl_croak_nocontext(PL_memory_wrap);
9391 need = (have > width ? have : width);
9394 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9395 Perl_croak_nocontext(PL_memory_wrap);
9396 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9398 if (esignlen && fill == '0') {
9400 for (i = 0; i < (int)esignlen; i++)
9404 memset(p, fill, gap);
9407 if (esignlen && fill != '0') {
9409 for (i = 0; i < (int)esignlen; i++)
9414 for (i = zeros; i; i--)
9418 Copy(eptr, p, elen, char);
9422 memset(p, ' ', gap);
9427 Copy(dotstr, p, dotstrlen, char);
9431 vectorize = FALSE; /* done iterating over vecstr */
9438 SvCUR_set(sv, p - SvPVX_const(sv));
9446 /* =========================================================================
9448 =head1 Cloning an interpreter
9450 All the macros and functions in this section are for the private use of
9451 the main function, perl_clone().
9453 The foo_dup() functions make an exact copy of an existing foo thinngy.
9454 During the course of a cloning, a hash table is used to map old addresses
9455 to new addresses. The table is created and manipulated with the
9456 ptr_table_* functions.
9460 ============================================================================*/
9463 #if defined(USE_ITHREADS)
9465 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9466 #ifndef GpREFCNT_inc
9467 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9471 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9472 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9473 If this changes, please unmerge ss_dup. */
9474 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9475 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9476 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9477 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9478 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9479 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9480 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9481 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9482 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9483 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9484 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9485 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9486 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9487 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9489 /* clone a parser */
9492 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9499 /* look for it in the table first */
9500 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9504 /* create anew and remember what it is */
9505 Newxz(parser, 1, yy_parser);
9506 ptr_table_store(PL_ptr_table, proto, parser);
9508 parser->yyerrstatus = 0;
9509 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9511 /* XXX these not yet duped */
9512 parser->old_parser = NULL;
9513 parser->stack = NULL;
9515 parser->stack_size = 0;
9516 /* XXX parser->stack->state = 0; */
9518 /* XXX eventually, just Copy() most of the parser struct ? */
9520 parser->lex_brackets = proto->lex_brackets;
9521 parser->lex_casemods = proto->lex_casemods;
9522 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9523 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9524 parser->lex_casestack = savepvn(proto->lex_casestack,
9525 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9526 parser->lex_defer = proto->lex_defer;
9527 parser->lex_dojoin = proto->lex_dojoin;
9528 parser->lex_expect = proto->lex_expect;
9529 parser->lex_formbrack = proto->lex_formbrack;
9530 parser->lex_inpat = proto->lex_inpat;
9531 parser->lex_inwhat = proto->lex_inwhat;
9532 parser->lex_op = proto->lex_op;
9533 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9534 parser->lex_starts = proto->lex_starts;
9535 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9536 parser->multi_close = proto->multi_close;
9537 parser->multi_open = proto->multi_open;
9538 parser->multi_start = proto->multi_start;
9539 parser->pending_ident = proto->pending_ident;
9540 parser->preambled = proto->preambled;
9541 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9544 parser->endwhite = proto->endwhite;
9545 parser->faketokens = proto->faketokens;
9546 parser->lasttoke = proto->lasttoke;
9547 parser->nextwhite = proto->nextwhite;
9548 parser->realtokenstart = proto->realtokenstart;
9549 parser->skipwhite = proto->skipwhite;
9550 parser->thisclose = proto->thisclose;
9551 parser->thismad = proto->thismad;
9552 parser->thisopen = proto->thisopen;
9553 parser->thisstuff = proto->thisstuff;
9554 parser->thistoken = proto->thistoken;
9555 parser->thiswhite = proto->thiswhite;
9561 /* duplicate a file handle */
9564 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9568 PERL_UNUSED_ARG(type);
9571 return (PerlIO*)NULL;
9573 /* look for it in the table first */
9574 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9578 /* create anew and remember what it is */
9579 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9580 ptr_table_store(PL_ptr_table, fp, ret);
9584 /* duplicate a directory handle */
9587 Perl_dirp_dup(pTHX_ DIR *dp)
9589 PERL_UNUSED_CONTEXT;
9596 /* duplicate a typeglob */
9599 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9605 /* look for it in the table first */
9606 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9610 /* create anew and remember what it is */
9612 ptr_table_store(PL_ptr_table, gp, ret);
9615 ret->gp_refcnt = 0; /* must be before any other dups! */
9616 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9617 ret->gp_io = io_dup_inc(gp->gp_io, param);
9618 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9619 ret->gp_av = av_dup_inc(gp->gp_av, param);
9620 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9621 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9622 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9623 ret->gp_cvgen = gp->gp_cvgen;
9624 ret->gp_line = gp->gp_line;
9625 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9629 /* duplicate a chain of magic */
9632 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9634 MAGIC *mgprev = (MAGIC*)NULL;
9637 return (MAGIC*)NULL;
9638 /* look for it in the table first */
9639 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9643 for (; mg; mg = mg->mg_moremagic) {
9645 Newxz(nmg, 1, MAGIC);
9647 mgprev->mg_moremagic = nmg;
9650 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9651 nmg->mg_private = mg->mg_private;
9652 nmg->mg_type = mg->mg_type;
9653 nmg->mg_flags = mg->mg_flags;
9654 if (mg->mg_type == PERL_MAGIC_qr) {
9655 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9657 else if(mg->mg_type == PERL_MAGIC_backref) {
9658 /* The backref AV has its reference count deliberately bumped by
9660 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9662 else if (mg->mg_type == PERL_MAGIC_symtab) {
9663 nmg->mg_obj = mg->mg_obj;
9666 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9667 ? sv_dup_inc(mg->mg_obj, param)
9668 : sv_dup(mg->mg_obj, param);
9670 nmg->mg_len = mg->mg_len;
9671 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9672 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9673 if (mg->mg_len > 0) {
9674 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9675 if (mg->mg_type == PERL_MAGIC_overload_table &&
9676 AMT_AMAGIC((AMT*)mg->mg_ptr))
9678 const AMT * const amtp = (AMT*)mg->mg_ptr;
9679 AMT * const namtp = (AMT*)nmg->mg_ptr;
9681 for (i = 1; i < NofAMmeth; i++) {
9682 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9686 else if (mg->mg_len == HEf_SVKEY)
9687 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9689 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9690 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9697 #endif /* USE_ITHREADS */
9699 /* create a new pointer-mapping table */
9702 Perl_ptr_table_new(pTHX)
9705 PERL_UNUSED_CONTEXT;
9707 Newxz(tbl, 1, PTR_TBL_t);
9710 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9714 #define PTR_TABLE_HASH(ptr) \
9715 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9718 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9719 following define) and at call to new_body_inline made below in
9720 Perl_ptr_table_store()
9723 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9725 /* map an existing pointer using a table */
9727 STATIC PTR_TBL_ENT_t *
9728 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9729 PTR_TBL_ENT_t *tblent;
9730 const UV hash = PTR_TABLE_HASH(sv);
9732 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9733 for (; tblent; tblent = tblent->next) {
9734 if (tblent->oldval == sv)
9741 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9743 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9744 PERL_UNUSED_CONTEXT;
9745 return tblent ? tblent->newval : NULL;
9748 /* add a new entry to a pointer-mapping table */
9751 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9753 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9754 PERL_UNUSED_CONTEXT;
9757 tblent->newval = newsv;
9759 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9761 new_body_inline(tblent, PTE_SVSLOT);
9763 tblent->oldval = oldsv;
9764 tblent->newval = newsv;
9765 tblent->next = tbl->tbl_ary[entry];
9766 tbl->tbl_ary[entry] = tblent;
9768 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9769 ptr_table_split(tbl);
9773 /* double the hash bucket size of an existing ptr table */
9776 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9778 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9779 const UV oldsize = tbl->tbl_max + 1;
9780 UV newsize = oldsize * 2;
9782 PERL_UNUSED_CONTEXT;
9784 Renew(ary, newsize, PTR_TBL_ENT_t*);
9785 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9786 tbl->tbl_max = --newsize;
9788 for (i=0; i < oldsize; i++, ary++) {
9789 PTR_TBL_ENT_t **curentp, **entp, *ent;
9792 curentp = ary + oldsize;
9793 for (entp = ary, ent = *ary; ent; ent = *entp) {
9794 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9796 ent->next = *curentp;
9806 /* remove all the entries from a ptr table */
9809 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9811 if (tbl && tbl->tbl_items) {
9812 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9813 UV riter = tbl->tbl_max;
9816 PTR_TBL_ENT_t *entry = array[riter];
9819 PTR_TBL_ENT_t * const oentry = entry;
9820 entry = entry->next;
9829 /* clear and free a ptr table */
9832 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9837 ptr_table_clear(tbl);
9838 Safefree(tbl->tbl_ary);
9842 #if defined(USE_ITHREADS)
9845 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9848 SvRV_set(dstr, SvWEAKREF(sstr)
9849 ? sv_dup(SvRV(sstr), param)
9850 : sv_dup_inc(SvRV(sstr), param));
9853 else if (SvPVX_const(sstr)) {
9854 /* Has something there */
9856 /* Normal PV - clone whole allocated space */
9857 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9858 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9859 /* Not that normal - actually sstr is copy on write.
9860 But we are a true, independant SV, so: */
9861 SvREADONLY_off(dstr);
9866 /* Special case - not normally malloced for some reason */
9867 if (isGV_with_GP(sstr)) {
9868 /* Don't need to do anything here. */
9870 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9871 /* A "shared" PV - clone it as "shared" PV */
9873 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9877 /* Some other special case - random pointer */
9878 SvPV_set(dstr, SvPVX(sstr));
9884 if (SvTYPE(dstr) == SVt_RV)
9885 SvRV_set(dstr, NULL);
9887 SvPV_set(dstr, NULL);
9891 /* duplicate an SV of any type (including AV, HV etc) */
9894 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9899 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9901 /* look for it in the table first */
9902 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9906 if(param->flags & CLONEf_JOIN_IN) {
9907 /** We are joining here so we don't want do clone
9908 something that is bad **/
9909 if (SvTYPE(sstr) == SVt_PVHV) {
9910 const char * const hvname = HvNAME_get(sstr);
9912 /** don't clone stashes if they already exist **/
9913 return (SV*)gv_stashpv(hvname,0);
9917 /* create anew and remember what it is */
9920 #ifdef DEBUG_LEAKING_SCALARS
9921 dstr->sv_debug_optype = sstr->sv_debug_optype;
9922 dstr->sv_debug_line = sstr->sv_debug_line;
9923 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9924 dstr->sv_debug_cloned = 1;
9925 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9928 ptr_table_store(PL_ptr_table, sstr, dstr);
9931 SvFLAGS(dstr) = SvFLAGS(sstr);
9932 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9933 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9936 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9937 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9938 (void*)PL_watch_pvx, SvPVX_const(sstr));
9941 /* don't clone objects whose class has asked us not to */
9942 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9943 SvFLAGS(dstr) &= ~SVTYPEMASK;
9948 switch (SvTYPE(sstr)) {
9953 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9954 SvIV_set(dstr, SvIVX(sstr));
9957 SvANY(dstr) = new_XNV();
9958 SvNV_set(dstr, SvNVX(sstr));
9961 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9962 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9964 /* case SVt_BIND: */
9967 /* These are all the types that need complex bodies allocating. */
9969 const svtype sv_type = SvTYPE(sstr);
9970 const struct body_details *const sv_type_details
9971 = bodies_by_type + sv_type;
9975 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9979 if (GvUNIQUE((GV*)sstr)) {
9980 NOOP; /* Do sharing here, and fall through */
9992 assert(sv_type_details->body_size);
9993 if (sv_type_details->arena) {
9994 new_body_inline(new_body, sv_type);
9996 = (void*)((char*)new_body - sv_type_details->offset);
9998 new_body = new_NOARENA(sv_type_details);
10002 SvANY(dstr) = new_body;
10005 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10006 ((char*)SvANY(dstr)) + sv_type_details->offset,
10007 sv_type_details->copy, char);
10009 Copy(((char*)SvANY(sstr)),
10010 ((char*)SvANY(dstr)),
10011 sv_type_details->body_size + sv_type_details->offset, char);
10014 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10015 && !isGV_with_GP(dstr))
10016 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10018 /* The Copy above means that all the source (unduplicated) pointers
10019 are now in the destination. We can check the flags and the
10020 pointers in either, but it's possible that there's less cache
10021 missing by always going for the destination.
10022 FIXME - instrument and check that assumption */
10023 if (sv_type >= SVt_PVMG) {
10024 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10025 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10026 } else if (SvMAGIC(dstr))
10027 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10029 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10032 /* The cast silences a GCC warning about unhandled types. */
10033 switch ((int)sv_type) {
10043 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10044 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10045 LvTARG(dstr) = dstr;
10046 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10047 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10049 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10051 if(isGV_with_GP(sstr)) {
10052 if (GvNAME_HEK(dstr))
10053 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10054 /* Don't call sv_add_backref here as it's going to be
10055 created as part of the magic cloning of the symbol
10057 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10058 at the point of this comment. */
10059 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10060 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10061 (void)GpREFCNT_inc(GvGP(dstr));
10063 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10066 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10067 if (IoOFP(dstr) == IoIFP(sstr))
10068 IoOFP(dstr) = IoIFP(dstr);
10070 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10071 /* PL_rsfp_filters entries have fake IoDIRP() */
10072 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10073 /* I have no idea why fake dirp (rsfps)
10074 should be treated differently but otherwise
10075 we end up with leaks -- sky*/
10076 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10077 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10078 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10080 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10081 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10082 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10083 if (IoDIRP(dstr)) {
10084 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10087 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10090 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10091 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10092 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10095 if (AvARRAY((AV*)sstr)) {
10096 SV **dst_ary, **src_ary;
10097 SSize_t items = AvFILLp((AV*)sstr) + 1;
10099 src_ary = AvARRAY((AV*)sstr);
10100 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10101 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10102 AvARRAY((AV*)dstr) = dst_ary;
10103 AvALLOC((AV*)dstr) = dst_ary;
10104 if (AvREAL((AV*)sstr)) {
10105 while (items-- > 0)
10106 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10109 while (items-- > 0)
10110 *dst_ary++ = sv_dup(*src_ary++, param);
10112 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10113 while (items-- > 0) {
10114 *dst_ary++ = &PL_sv_undef;
10118 AvARRAY((AV*)dstr) = NULL;
10119 AvALLOC((AV*)dstr) = (SV**)NULL;
10123 if (HvARRAY((HV*)sstr)) {
10125 const bool sharekeys = !!HvSHAREKEYS(sstr);
10126 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10127 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10129 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10130 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10132 HvARRAY(dstr) = (HE**)darray;
10133 while (i <= sxhv->xhv_max) {
10134 const HE * const source = HvARRAY(sstr)[i];
10135 HvARRAY(dstr)[i] = source
10136 ? he_dup(source, sharekeys, param) : 0;
10141 const struct xpvhv_aux * const saux = HvAUX(sstr);
10142 struct xpvhv_aux * const daux = HvAUX(dstr);
10143 /* This flag isn't copied. */
10144 /* SvOOK_on(hv) attacks the IV flags. */
10145 SvFLAGS(dstr) |= SVf_OOK;
10147 hvname = saux->xhv_name;
10148 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10150 daux->xhv_riter = saux->xhv_riter;
10151 daux->xhv_eiter = saux->xhv_eiter
10152 ? he_dup(saux->xhv_eiter,
10153 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10154 daux->xhv_backreferences =
10155 saux->xhv_backreferences
10156 ? (AV*) SvREFCNT_inc(
10157 sv_dup((SV*)saux->xhv_backreferences, param))
10159 /* Record stashes for possible cloning in Perl_clone(). */
10161 av_push(param->stashes, dstr);
10165 HvARRAY((HV*)dstr) = NULL;
10168 if (!(param->flags & CLONEf_COPY_STACKS)) {
10172 /* NOTE: not refcounted */
10173 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10175 if (!CvISXSUB(dstr))
10176 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10178 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10179 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10180 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10181 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10183 /* don't dup if copying back - CvGV isn't refcounted, so the
10184 * duped GV may never be freed. A bit of a hack! DAPM */
10185 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10186 NULL : gv_dup(CvGV(dstr), param) ;
10187 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10189 CvWEAKOUTSIDE(sstr)
10190 ? cv_dup( CvOUTSIDE(dstr), param)
10191 : cv_dup_inc(CvOUTSIDE(dstr), param);
10192 if (!CvISXSUB(dstr))
10193 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10199 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10205 /* duplicate a context */
10208 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10210 PERL_CONTEXT *ncxs;
10213 return (PERL_CONTEXT*)NULL;
10215 /* look for it in the table first */
10216 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10220 /* create anew and remember what it is */
10221 Newxz(ncxs, max + 1, PERL_CONTEXT);
10222 ptr_table_store(PL_ptr_table, cxs, ncxs);
10225 PERL_CONTEXT * const cx = &cxs[ix];
10226 PERL_CONTEXT * const ncx = &ncxs[ix];
10227 ncx->cx_type = cx->cx_type;
10228 if (CxTYPE(cx) == CXt_SUBST) {
10229 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10232 ncx->blk_oldsp = cx->blk_oldsp;
10233 ncx->blk_oldcop = cx->blk_oldcop;
10234 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10235 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10236 ncx->blk_oldpm = cx->blk_oldpm;
10237 ncx->blk_gimme = cx->blk_gimme;
10238 switch (CxTYPE(cx)) {
10240 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10241 ? cv_dup_inc(cx->blk_sub.cv, param)
10242 : cv_dup(cx->blk_sub.cv,param));
10243 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10244 ? av_dup_inc(cx->blk_sub.argarray, param)
10246 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10247 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10248 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10249 ncx->blk_sub.lval = cx->blk_sub.lval;
10250 ncx->blk_sub.retop = cx->blk_sub.retop;
10251 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10252 cx->blk_sub.oldcomppad);
10255 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10256 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10257 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10258 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10259 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10260 ncx->blk_eval.retop = cx->blk_eval.retop;
10263 ncx->blk_loop.label = cx->blk_loop.label;
10264 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10265 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10266 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10267 ? cx->blk_loop.iterdata
10268 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10269 ncx->blk_loop.oldcomppad
10270 = (PAD*)ptr_table_fetch(PL_ptr_table,
10271 cx->blk_loop.oldcomppad);
10272 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10273 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10274 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10275 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10276 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10279 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10280 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10281 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10282 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10283 ncx->blk_sub.retop = cx->blk_sub.retop;
10295 /* duplicate a stack info structure */
10298 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10303 return (PERL_SI*)NULL;
10305 /* look for it in the table first */
10306 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10310 /* create anew and remember what it is */
10311 Newxz(nsi, 1, PERL_SI);
10312 ptr_table_store(PL_ptr_table, si, nsi);
10314 nsi->si_stack = av_dup_inc(si->si_stack, param);
10315 nsi->si_cxix = si->si_cxix;
10316 nsi->si_cxmax = si->si_cxmax;
10317 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10318 nsi->si_type = si->si_type;
10319 nsi->si_prev = si_dup(si->si_prev, param);
10320 nsi->si_next = si_dup(si->si_next, param);
10321 nsi->si_markoff = si->si_markoff;
10326 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10327 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10328 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10329 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10330 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10331 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10332 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10333 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10334 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10335 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10336 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10337 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10338 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10339 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10342 #define pv_dup_inc(p) SAVEPV(p)
10343 #define pv_dup(p) SAVEPV(p)
10344 #define svp_dup_inc(p,pp) any_dup(p,pp)
10346 /* map any object to the new equivent - either something in the
10347 * ptr table, or something in the interpreter structure
10351 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10356 return (void*)NULL;
10358 /* look for it in the table first */
10359 ret = ptr_table_fetch(PL_ptr_table, v);
10363 /* see if it is part of the interpreter structure */
10364 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10365 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10373 /* duplicate the save stack */
10376 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10379 ANY * const ss = proto_perl->Tsavestack;
10380 const I32 max = proto_perl->Tsavestack_max;
10381 I32 ix = proto_perl->Tsavestack_ix;
10394 void (*dptr) (void*);
10395 void (*dxptr) (pTHX_ void*);
10397 Newxz(nss, max, ANY);
10400 const I32 type = POPINT(ss,ix);
10401 TOPINT(nss,ix) = type;
10403 case SAVEt_HELEM: /* hash element */
10404 sv = (SV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10407 case SAVEt_ITEM: /* normal string */
10408 case SAVEt_SV: /* scalar reference */
10409 sv = (SV*)POPPTR(ss,ix);
10410 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10413 case SAVEt_MORTALIZESV:
10414 sv = (SV*)POPPTR(ss,ix);
10415 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10417 case SAVEt_SHARED_PVREF: /* char* in shared space */
10418 c = (char*)POPPTR(ss,ix);
10419 TOPPTR(nss,ix) = savesharedpv(c);
10420 ptr = POPPTR(ss,ix);
10421 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10423 case SAVEt_GENERIC_SVREF: /* generic sv */
10424 case SAVEt_SVREF: /* scalar reference */
10425 sv = (SV*)POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10427 ptr = POPPTR(ss,ix);
10428 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10430 case SAVEt_HV: /* hash reference */
10431 case SAVEt_AV: /* array reference */
10432 sv = (SV*) POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10435 case SAVEt_COMPPAD:
10437 sv = (SV*) POPPTR(ss,ix);
10438 TOPPTR(nss,ix) = sv_dup(sv, param);
10440 case SAVEt_INT: /* int reference */
10441 ptr = POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10443 intval = (int)POPINT(ss,ix);
10444 TOPINT(nss,ix) = intval;
10446 case SAVEt_LONG: /* long reference */
10447 ptr = POPPTR(ss,ix);
10448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10450 case SAVEt_CLEARSV:
10451 longval = (long)POPLONG(ss,ix);
10452 TOPLONG(nss,ix) = longval;
10454 case SAVEt_I32: /* I32 reference */
10455 case SAVEt_I16: /* I16 reference */
10456 case SAVEt_I8: /* I8 reference */
10457 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 TOPINT(nss,ix) = i;
10463 case SAVEt_IV: /* IV reference */
10464 ptr = POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10467 TOPIV(nss,ix) = iv;
10469 case SAVEt_HPTR: /* HV* reference */
10470 case SAVEt_APTR: /* AV* reference */
10471 case SAVEt_SPTR: /* SV* reference */
10472 ptr = POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10474 sv = (SV*)POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = sv_dup(sv, param);
10477 case SAVEt_VPTR: /* random* reference */
10478 ptr = POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10480 ptr = POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10483 case SAVEt_GENERIC_PVREF: /* generic char* */
10484 case SAVEt_PPTR: /* char* reference */
10485 ptr = POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10487 c = (char*)POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = pv_dup(c);
10490 case SAVEt_GP: /* scalar reference */
10491 gp = (GP*)POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10493 (void)GpREFCNT_inc(gp);
10494 gv = (GV*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10498 ptr = POPPTR(ss,ix);
10499 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10500 /* these are assumed to be refcounted properly */
10502 switch (((OP*)ptr)->op_type) {
10504 case OP_LEAVESUBLV:
10508 case OP_LEAVEWRITE:
10509 TOPPTR(nss,ix) = ptr;
10516 TOPPTR(nss,ix) = NULL;
10521 TOPPTR(nss,ix) = NULL;
10524 c = (char*)POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = pv_dup_inc(c);
10528 hv = (HV*)POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10530 c = (char*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = pv_dup_inc(c);
10533 case SAVEt_STACK_POS: /* Position on Perl stack */
10535 TOPINT(nss,ix) = i;
10537 case SAVEt_DESTRUCTOR:
10538 ptr = POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10540 dptr = POPDPTR(ss,ix);
10541 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10542 any_dup(FPTR2DPTR(void *, dptr),
10545 case SAVEt_DESTRUCTOR_X:
10546 ptr = POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10548 dxptr = POPDXPTR(ss,ix);
10549 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10550 any_dup(FPTR2DPTR(void *, dxptr),
10553 case SAVEt_REGCONTEXT:
10556 TOPINT(nss,ix) = i;
10559 case SAVEt_AELEM: /* array element */
10560 sv = (SV*)POPPTR(ss,ix);
10561 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10563 TOPINT(nss,ix) = i;
10564 av = (AV*)POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = av_dup_inc(av, param);
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = ptr;
10573 TOPINT(nss,ix) = i;
10574 ptr = POPPTR(ss,ix);
10577 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10578 HINTS_REFCNT_UNLOCK;
10580 TOPPTR(nss,ix) = ptr;
10581 if (i & HINT_LOCALIZE_HH) {
10582 hv = (HV*)POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10587 longval = (long)POPLONG(ss,ix);
10588 TOPLONG(nss,ix) = longval;
10589 ptr = POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 sv = (SV*)POPPTR(ss,ix);
10592 TOPPTR(nss,ix) = sv_dup(sv, param);
10595 ptr = POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 longval = (long)POPBOOL(ss,ix);
10598 TOPBOOL(nss,ix) = (bool)longval;
10600 case SAVEt_SET_SVFLAGS:
10602 TOPINT(nss,ix) = i;
10604 TOPINT(nss,ix) = i;
10605 sv = (SV*)POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = sv_dup(sv, param);
10608 case SAVEt_RE_STATE:
10610 const struct re_save_state *const old_state
10611 = (struct re_save_state *)
10612 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10613 struct re_save_state *const new_state
10614 = (struct re_save_state *)
10615 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10617 Copy(old_state, new_state, 1, struct re_save_state);
10618 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10620 new_state->re_state_bostr
10621 = pv_dup(old_state->re_state_bostr);
10622 new_state->re_state_reginput
10623 = pv_dup(old_state->re_state_reginput);
10624 new_state->re_state_regeol
10625 = pv_dup(old_state->re_state_regeol);
10626 new_state->re_state_regstartp
10627 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10628 new_state->re_state_regendp
10629 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10630 new_state->re_state_reglastparen
10631 = (U32*) any_dup(old_state->re_state_reglastparen,
10633 new_state->re_state_reglastcloseparen
10634 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10636 /* XXX This just has to be broken. The old save_re_context
10637 code did SAVEGENERICPV(PL_reg_start_tmp);
10638 PL_reg_start_tmp is char **.
10639 Look above to what the dup code does for
10640 SAVEt_GENERIC_PVREF
10641 It can never have worked.
10642 So this is merely a faithful copy of the exiting bug: */
10643 new_state->re_state_reg_start_tmp
10644 = (char **) pv_dup((char *)
10645 old_state->re_state_reg_start_tmp);
10646 /* I assume that it only ever "worked" because no-one called
10647 (pseudo)fork while the regexp engine had re-entered itself.
10649 #ifdef PERL_OLD_COPY_ON_WRITE
10650 new_state->re_state_nrs
10651 = sv_dup(old_state->re_state_nrs, param);
10653 new_state->re_state_reg_magic
10654 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10656 new_state->re_state_reg_oldcurpm
10657 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10659 new_state->re_state_reg_curpm
10660 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10662 new_state->re_state_reg_oldsaved
10663 = pv_dup(old_state->re_state_reg_oldsaved);
10664 new_state->re_state_reg_poscache
10665 = pv_dup(old_state->re_state_reg_poscache);
10666 new_state->re_state_reg_starttry
10667 = pv_dup(old_state->re_state_reg_starttry);
10670 case SAVEt_COMPILE_WARNINGS:
10671 ptr = POPPTR(ss,ix);
10672 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10675 ptr = POPPTR(ss,ix);
10676 TOPPTR(nss,ix) = parser_dup(ptr, param);
10680 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10688 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10689 * flag to the result. This is done for each stash before cloning starts,
10690 * so we know which stashes want their objects cloned */
10693 do_mark_cloneable_stash(pTHX_ SV *sv)
10695 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10697 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10698 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10699 if (cloner && GvCV(cloner)) {
10706 XPUSHs(sv_2mortal(newSVhek(hvname)));
10708 call_sv((SV*)GvCV(cloner), G_SCALAR);
10715 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10723 =for apidoc perl_clone
10725 Create and return a new interpreter by cloning the current one.
10727 perl_clone takes these flags as parameters:
10729 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10730 without it we only clone the data and zero the stacks,
10731 with it we copy the stacks and the new perl interpreter is
10732 ready to run at the exact same point as the previous one.
10733 The pseudo-fork code uses COPY_STACKS while the
10734 threads->new doesn't.
10736 CLONEf_KEEP_PTR_TABLE
10737 perl_clone keeps a ptr_table with the pointer of the old
10738 variable as a key and the new variable as a value,
10739 this allows it to check if something has been cloned and not
10740 clone it again but rather just use the value and increase the
10741 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10742 the ptr_table using the function
10743 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10744 reason to keep it around is if you want to dup some of your own
10745 variable who are outside the graph perl scans, example of this
10746 code is in threads.xs create
10749 This is a win32 thing, it is ignored on unix, it tells perls
10750 win32host code (which is c++) to clone itself, this is needed on
10751 win32 if you want to run two threads at the same time,
10752 if you just want to do some stuff in a separate perl interpreter
10753 and then throw it away and return to the original one,
10754 you don't need to do anything.
10759 /* XXX the above needs expanding by someone who actually understands it ! */
10760 EXTERN_C PerlInterpreter *
10761 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10764 perl_clone(PerlInterpreter *proto_perl, UV flags)
10767 #ifdef PERL_IMPLICIT_SYS
10769 /* perlhost.h so we need to call into it
10770 to clone the host, CPerlHost should have a c interface, sky */
10772 if (flags & CLONEf_CLONE_HOST) {
10773 return perl_clone_host(proto_perl,flags);
10775 return perl_clone_using(proto_perl, flags,
10777 proto_perl->IMemShared,
10778 proto_perl->IMemParse,
10780 proto_perl->IStdIO,
10784 proto_perl->IProc);
10788 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10789 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10790 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10791 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10792 struct IPerlDir* ipD, struct IPerlSock* ipS,
10793 struct IPerlProc* ipP)
10795 /* XXX many of the string copies here can be optimized if they're
10796 * constants; they need to be allocated as common memory and just
10797 * their pointers copied. */
10800 CLONE_PARAMS clone_params;
10801 CLONE_PARAMS* const param = &clone_params;
10803 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10804 /* for each stash, determine whether its objects should be cloned */
10805 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10806 PERL_SET_THX(my_perl);
10809 PoisonNew(my_perl, 1, PerlInterpreter);
10815 PL_savestack_ix = 0;
10816 PL_savestack_max = -1;
10817 PL_sig_pending = 0;
10818 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10819 # else /* !DEBUGGING */
10820 Zero(my_perl, 1, PerlInterpreter);
10821 # endif /* DEBUGGING */
10823 /* host pointers */
10825 PL_MemShared = ipMS;
10826 PL_MemParse = ipMP;
10833 #else /* !PERL_IMPLICIT_SYS */
10835 CLONE_PARAMS clone_params;
10836 CLONE_PARAMS* param = &clone_params;
10837 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10838 /* for each stash, determine whether its objects should be cloned */
10839 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10840 PERL_SET_THX(my_perl);
10843 PoisonNew(my_perl, 1, PerlInterpreter);
10849 PL_savestack_ix = 0;
10850 PL_savestack_max = -1;
10851 PL_sig_pending = 0;
10852 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10853 # else /* !DEBUGGING */
10854 Zero(my_perl, 1, PerlInterpreter);
10855 # endif /* DEBUGGING */
10856 #endif /* PERL_IMPLICIT_SYS */
10857 param->flags = flags;
10858 param->proto_perl = proto_perl;
10860 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10862 PL_body_arenas = NULL;
10863 Zero(&PL_body_roots, 1, PL_body_roots);
10865 PL_nice_chunk = NULL;
10866 PL_nice_chunk_size = 0;
10868 PL_sv_objcount = 0;
10870 PL_sv_arenaroot = NULL;
10872 PL_debug = proto_perl->Idebug;
10874 PL_hash_seed = proto_perl->Ihash_seed;
10875 PL_rehash_seed = proto_perl->Irehash_seed;
10877 #ifdef USE_REENTRANT_API
10878 /* XXX: things like -Dm will segfault here in perlio, but doing
10879 * PERL_SET_CONTEXT(proto_perl);
10880 * breaks too many other things
10882 Perl_reentrant_init(aTHX);
10885 /* create SV map for pointer relocation */
10886 PL_ptr_table = ptr_table_new();
10888 /* initialize these special pointers as early as possible */
10889 SvANY(&PL_sv_undef) = NULL;
10890 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10891 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10892 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10894 SvANY(&PL_sv_no) = new_XPVNV();
10895 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10896 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10897 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10898 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10899 SvCUR_set(&PL_sv_no, 0);
10900 SvLEN_set(&PL_sv_no, 1);
10901 SvIV_set(&PL_sv_no, 0);
10902 SvNV_set(&PL_sv_no, 0);
10903 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10905 SvANY(&PL_sv_yes) = new_XPVNV();
10906 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10907 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10908 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10909 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10910 SvCUR_set(&PL_sv_yes, 1);
10911 SvLEN_set(&PL_sv_yes, 2);
10912 SvIV_set(&PL_sv_yes, 1);
10913 SvNV_set(&PL_sv_yes, 1);
10914 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10916 /* create (a non-shared!) shared string table */
10917 PL_strtab = newHV();
10918 HvSHAREKEYS_off(PL_strtab);
10919 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10920 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10922 PL_compiling = proto_perl->Icompiling;
10924 /* These two PVs will be free'd special way so must set them same way op.c does */
10925 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10926 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10928 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10929 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10931 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10932 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10933 if (PL_compiling.cop_hints_hash) {
10935 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10936 HINTS_REFCNT_UNLOCK;
10938 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10940 /* pseudo environmental stuff */
10941 PL_origargc = proto_perl->Iorigargc;
10942 PL_origargv = proto_perl->Iorigargv;
10944 param->stashes = newAV(); /* Setup array of objects to call clone on */
10946 /* Set tainting stuff before PerlIO_debug can possibly get called */
10947 PL_tainting = proto_perl->Itainting;
10948 PL_taint_warn = proto_perl->Itaint_warn;
10950 #ifdef PERLIO_LAYERS
10951 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10952 PerlIO_clone(aTHX_ proto_perl, param);
10955 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10956 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10957 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10958 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10959 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10960 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10963 PL_minus_c = proto_perl->Iminus_c;
10964 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10965 PL_localpatches = proto_perl->Ilocalpatches;
10966 PL_splitstr = proto_perl->Isplitstr;
10967 PL_preprocess = proto_perl->Ipreprocess;
10968 PL_minus_n = proto_perl->Iminus_n;
10969 PL_minus_p = proto_perl->Iminus_p;
10970 PL_minus_l = proto_perl->Iminus_l;
10971 PL_minus_a = proto_perl->Iminus_a;
10972 PL_minus_E = proto_perl->Iminus_E;
10973 PL_minus_F = proto_perl->Iminus_F;
10974 PL_doswitches = proto_perl->Idoswitches;
10975 PL_dowarn = proto_perl->Idowarn;
10976 PL_doextract = proto_perl->Idoextract;
10977 PL_sawampersand = proto_perl->Isawampersand;
10978 PL_unsafe = proto_perl->Iunsafe;
10979 PL_inplace = SAVEPV(proto_perl->Iinplace);
10980 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10981 PL_perldb = proto_perl->Iperldb;
10982 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10983 PL_exit_flags = proto_perl->Iexit_flags;
10985 /* magical thingies */
10986 /* XXX time(&PL_basetime) when asked for? */
10987 PL_basetime = proto_perl->Ibasetime;
10988 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10990 PL_maxsysfd = proto_perl->Imaxsysfd;
10991 PL_statusvalue = proto_perl->Istatusvalue;
10993 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10995 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10997 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10999 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11000 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11001 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11004 /* RE engine related */
11005 Zero(&PL_reg_state, 1, struct re_save_state);
11006 PL_reginterp_cnt = 0;
11007 PL_regmatch_slab = NULL;
11009 /* Clone the regex array */
11010 PL_regex_padav = newAV();
11012 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11013 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11015 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11016 for(i = 1; i <= len; i++) {
11017 const SV * const regex = regexen[i];
11020 ? sv_dup_inc(regex, param)
11022 newSViv(PTR2IV(CALLREGDUPE(
11023 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11025 if (SvFLAGS(regex) & SVf_BREAK)
11026 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11027 av_push(PL_regex_padav, sv);
11030 PL_regex_pad = AvARRAY(PL_regex_padav);
11032 /* shortcuts to various I/O objects */
11033 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11034 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11035 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11036 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11037 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11038 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11040 /* shortcuts to regexp stuff */
11041 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11043 /* shortcuts to misc objects */
11044 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11046 /* shortcuts to debugging objects */
11047 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11048 PL_DBline = gv_dup(proto_perl->IDBline, param);
11049 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11050 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11051 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11052 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11053 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11054 PL_lineary = av_dup(proto_perl->Ilineary, param);
11055 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11057 /* symbol tables */
11058 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11059 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11060 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11061 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11062 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11064 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11065 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11066 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11067 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11068 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11069 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11070 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11071 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11073 PL_sub_generation = proto_perl->Isub_generation;
11075 /* funky return mechanisms */
11076 PL_forkprocess = proto_perl->Iforkprocess;
11078 /* subprocess state */
11079 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11081 /* internal state */
11082 PL_maxo = proto_perl->Imaxo;
11083 if (proto_perl->Iop_mask)
11084 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11087 /* PL_asserting = proto_perl->Iasserting; */
11089 /* current interpreter roots */
11090 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11092 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11094 PL_main_start = proto_perl->Imain_start;
11095 PL_eval_root = proto_perl->Ieval_root;
11096 PL_eval_start = proto_perl->Ieval_start;
11098 /* runtime control stuff */
11099 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11100 PL_copline = proto_perl->Icopline;
11102 PL_filemode = proto_perl->Ifilemode;
11103 PL_lastfd = proto_perl->Ilastfd;
11104 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11107 PL_gensym = proto_perl->Igensym;
11108 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11109 PL_laststatval = proto_perl->Ilaststatval;
11110 PL_laststype = proto_perl->Ilaststype;
11113 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11115 /* interpreter atexit processing */
11116 PL_exitlistlen = proto_perl->Iexitlistlen;
11117 if (PL_exitlistlen) {
11118 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11119 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11122 PL_exitlist = (PerlExitListEntry*)NULL;
11124 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11125 if (PL_my_cxt_size) {
11126 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11127 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11128 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11129 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11130 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11134 PL_my_cxt_list = (void**)NULL;
11135 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11136 PL_my_cxt_keys = (void**)NULL;
11139 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11140 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11141 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11143 PL_profiledata = NULL;
11144 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11145 /* PL_rsfp_filters entries have fake IoDIRP() */
11146 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11148 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11150 PAD_CLONE_VARS(proto_perl, param);
11152 #ifdef HAVE_INTERP_INTERN
11153 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11156 /* more statics moved here */
11157 PL_generation = proto_perl->Igeneration;
11158 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11160 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11161 PL_in_clean_all = proto_perl->Iin_clean_all;
11163 PL_uid = proto_perl->Iuid;
11164 PL_euid = proto_perl->Ieuid;
11165 PL_gid = proto_perl->Igid;
11166 PL_egid = proto_perl->Iegid;
11167 PL_nomemok = proto_perl->Inomemok;
11168 PL_an = proto_perl->Ian;
11169 PL_evalseq = proto_perl->Ievalseq;
11170 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11171 PL_origalen = proto_perl->Iorigalen;
11172 #ifdef PERL_USES_PL_PIDSTATUS
11173 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11175 PL_osname = SAVEPV(proto_perl->Iosname);
11176 PL_sighandlerp = proto_perl->Isighandlerp;
11178 PL_runops = proto_perl->Irunops;
11180 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11183 PL_cshlen = proto_perl->Icshlen;
11184 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11187 PL_parser = parser_dup(proto_perl->Iparser, param);
11189 PL_lex_state = proto_perl->Ilex_state;
11192 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11193 PL_curforce = proto_perl->Icurforce;
11195 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11196 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11197 PL_nexttoke = proto_perl->Inexttoke;
11200 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11201 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11202 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11203 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11204 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11205 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11206 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11207 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11208 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11209 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11211 PL_expect = proto_perl->Iexpect;
11213 PL_multi_end = proto_perl->Imulti_end;
11215 PL_error_count = proto_perl->Ierror_count;
11216 PL_subline = proto_perl->Isubline;
11217 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11219 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11220 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11221 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11222 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11223 PL_last_lop_op = proto_perl->Ilast_lop_op;
11224 PL_in_my = proto_perl->Iin_my;
11225 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11227 PL_cryptseen = proto_perl->Icryptseen;
11230 PL_hints = proto_perl->Ihints;
11232 PL_amagic_generation = proto_perl->Iamagic_generation;
11234 #ifdef USE_LOCALE_COLLATE
11235 PL_collation_ix = proto_perl->Icollation_ix;
11236 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11237 PL_collation_standard = proto_perl->Icollation_standard;
11238 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11239 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11240 #endif /* USE_LOCALE_COLLATE */
11242 #ifdef USE_LOCALE_NUMERIC
11243 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11244 PL_numeric_standard = proto_perl->Inumeric_standard;
11245 PL_numeric_local = proto_perl->Inumeric_local;
11246 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11247 #endif /* !USE_LOCALE_NUMERIC */
11249 /* utf8 character classes */
11250 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11251 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11252 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11253 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11254 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11255 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11256 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11257 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11258 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11259 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11260 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11261 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11262 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11263 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11264 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11265 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11266 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11267 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11268 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11269 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11271 /* Did the locale setup indicate UTF-8? */
11272 PL_utf8locale = proto_perl->Iutf8locale;
11273 /* Unicode features (see perlrun/-C) */
11274 PL_unicode = proto_perl->Iunicode;
11276 /* Pre-5.8 signals control */
11277 PL_signals = proto_perl->Isignals;
11279 /* times() ticks per second */
11280 PL_clocktick = proto_perl->Iclocktick;
11282 /* Recursion stopper for PerlIO_find_layer */
11283 PL_in_load_module = proto_perl->Iin_load_module;
11285 /* sort() routine */
11286 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11288 /* Not really needed/useful since the reenrant_retint is "volatile",
11289 * but do it for consistency's sake. */
11290 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11292 /* Hooks to shared SVs and locks. */
11293 PL_sharehook = proto_perl->Isharehook;
11294 PL_lockhook = proto_perl->Ilockhook;
11295 PL_unlockhook = proto_perl->Iunlockhook;
11296 PL_threadhook = proto_perl->Ithreadhook;
11298 PL_runops_std = proto_perl->Irunops_std;
11299 PL_runops_dbg = proto_perl->Irunops_dbg;
11301 #ifdef THREADS_HAVE_PIDS
11302 PL_ppid = proto_perl->Ippid;
11306 PL_last_swash_hv = NULL; /* reinits on demand */
11307 PL_last_swash_klen = 0;
11308 PL_last_swash_key[0]= '\0';
11309 PL_last_swash_tmps = (U8*)NULL;
11310 PL_last_swash_slen = 0;
11312 PL_glob_index = proto_perl->Iglob_index;
11313 PL_srand_called = proto_perl->Isrand_called;
11314 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11315 PL_bitcount = NULL; /* reinits on demand */
11317 if (proto_perl->Ipsig_pend) {
11318 Newxz(PL_psig_pend, SIG_SIZE, int);
11321 PL_psig_pend = (int*)NULL;
11324 if (proto_perl->Ipsig_ptr) {
11325 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11326 Newxz(PL_psig_name, SIG_SIZE, SV*);
11327 for (i = 1; i < SIG_SIZE; i++) {
11328 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11329 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11333 PL_psig_ptr = (SV**)NULL;
11334 PL_psig_name = (SV**)NULL;
11337 /* thrdvar.h stuff */
11339 if (flags & CLONEf_COPY_STACKS) {
11340 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11341 PL_tmps_ix = proto_perl->Ttmps_ix;
11342 PL_tmps_max = proto_perl->Ttmps_max;
11343 PL_tmps_floor = proto_perl->Ttmps_floor;
11344 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11346 while (i <= PL_tmps_ix) {
11347 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11351 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11352 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11353 Newxz(PL_markstack, i, I32);
11354 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11355 - proto_perl->Tmarkstack);
11356 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11357 - proto_perl->Tmarkstack);
11358 Copy(proto_perl->Tmarkstack, PL_markstack,
11359 PL_markstack_ptr - PL_markstack + 1, I32);
11361 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11362 * NOTE: unlike the others! */
11363 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11364 PL_scopestack_max = proto_perl->Tscopestack_max;
11365 Newxz(PL_scopestack, PL_scopestack_max, I32);
11366 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11368 /* NOTE: si_dup() looks at PL_markstack */
11369 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11371 /* PL_curstack = PL_curstackinfo->si_stack; */
11372 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11373 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11375 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11376 PL_stack_base = AvARRAY(PL_curstack);
11377 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11378 - proto_perl->Tstack_base);
11379 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11381 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11382 * NOTE: unlike the others! */
11383 PL_savestack_ix = proto_perl->Tsavestack_ix;
11384 PL_savestack_max = proto_perl->Tsavestack_max;
11385 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11386 PL_savestack = ss_dup(proto_perl, param);
11390 ENTER; /* perl_destruct() wants to LEAVE; */
11392 /* although we're not duplicating the tmps stack, we should still
11393 * add entries for any SVs on the tmps stack that got cloned by a
11394 * non-refcount means (eg a temp in @_); otherwise they will be
11397 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11398 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11399 proto_perl->Ttmps_stack[i]);
11400 if (nsv && !SvREFCNT(nsv)) {
11402 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11407 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11408 PL_top_env = &PL_start_env;
11410 PL_op = proto_perl->Top;
11413 PL_Xpv = (XPV*)NULL;
11414 PL_na = proto_perl->Tna;
11416 PL_statbuf = proto_perl->Tstatbuf;
11417 PL_statcache = proto_perl->Tstatcache;
11418 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11419 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11421 PL_timesbuf = proto_perl->Ttimesbuf;
11424 PL_tainted = proto_perl->Ttainted;
11425 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11426 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11427 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11428 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11429 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11430 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11431 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11432 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11433 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11435 PL_restartop = proto_perl->Trestartop;
11436 PL_in_eval = proto_perl->Tin_eval;
11437 PL_delaymagic = proto_perl->Tdelaymagic;
11438 PL_dirty = proto_perl->Tdirty;
11439 PL_localizing = proto_perl->Tlocalizing;
11441 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11442 PL_hv_fetch_ent_mh = NULL;
11443 PL_modcount = proto_perl->Tmodcount;
11444 PL_lastgotoprobe = NULL;
11445 PL_dumpindent = proto_perl->Tdumpindent;
11447 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11448 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11449 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11450 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11451 PL_efloatbuf = NULL; /* reinits on demand */
11452 PL_efloatsize = 0; /* reinits on demand */
11456 PL_screamfirst = NULL;
11457 PL_screamnext = NULL;
11458 PL_maxscream = -1; /* reinits on demand */
11459 PL_lastscream = NULL;
11461 PL_watchaddr = NULL;
11464 PL_regdummy = proto_perl->Tregdummy;
11465 PL_colorset = 0; /* reinits PL_colors[] */
11466 /*PL_colors[6] = {0,0,0,0,0,0};*/
11470 /* Pluggable optimizer */
11471 PL_peepp = proto_perl->Tpeepp;
11473 PL_stashcache = newHV();
11475 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11476 ptr_table_free(PL_ptr_table);
11477 PL_ptr_table = NULL;
11480 /* Call the ->CLONE method, if it exists, for each of the stashes
11481 identified by sv_dup() above.
11483 while(av_len(param->stashes) != -1) {
11484 HV* const stash = (HV*) av_shift(param->stashes);
11485 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11486 if (cloner && GvCV(cloner)) {
11491 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11493 call_sv((SV*)GvCV(cloner), G_DISCARD);
11499 SvREFCNT_dec(param->stashes);
11501 /* orphaned? eg threads->new inside BEGIN or use */
11502 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11503 SvREFCNT_inc_simple_void(PL_compcv);
11504 SAVEFREESV(PL_compcv);
11510 #endif /* USE_ITHREADS */
11513 =head1 Unicode Support
11515 =for apidoc sv_recode_to_utf8
11517 The encoding is assumed to be an Encode object, on entry the PV
11518 of the sv is assumed to be octets in that encoding, and the sv
11519 will be converted into Unicode (and UTF-8).
11521 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11522 is not a reference, nothing is done to the sv. If the encoding is not
11523 an C<Encode::XS> Encoding object, bad things will happen.
11524 (See F<lib/encoding.pm> and L<Encode>).
11526 The PV of the sv is returned.
11531 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11534 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11548 Passing sv_yes is wrong - it needs to be or'ed set of constants
11549 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11550 remove converted chars from source.
11552 Both will default the value - let them.
11554 XPUSHs(&PL_sv_yes);
11557 call_method("decode", G_SCALAR);
11561 s = SvPV_const(uni, len);
11562 if (s != SvPVX_const(sv)) {
11563 SvGROW(sv, len + 1);
11564 Move(s, SvPVX(sv), len + 1, char);
11565 SvCUR_set(sv, len);
11572 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11576 =for apidoc sv_cat_decode
11578 The encoding is assumed to be an Encode object, the PV of the ssv is
11579 assumed to be octets in that encoding and decoding the input starts
11580 from the position which (PV + *offset) pointed to. The dsv will be
11581 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11582 when the string tstr appears in decoding output or the input ends on
11583 the PV of the ssv. The value which the offset points will be modified
11584 to the last input position on the ssv.
11586 Returns TRUE if the terminator was found, else returns FALSE.
11591 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11592 SV *ssv, int *offset, char *tstr, int tlen)
11596 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11607 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11608 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11610 call_method("cat_decode", G_SCALAR);
11612 ret = SvTRUE(TOPs);
11613 *offset = SvIV(offsv);
11619 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11624 /* ---------------------------------------------------------------------
11626 * support functions for report_uninit()
11629 /* the maxiumum size of array or hash where we will scan looking
11630 * for the undefined element that triggered the warning */
11632 #define FUV_MAX_SEARCH_SIZE 1000
11634 /* Look for an entry in the hash whose value has the same SV as val;
11635 * If so, return a mortal copy of the key. */
11638 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11641 register HE **array;
11644 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11645 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11648 array = HvARRAY(hv);
11650 for (i=HvMAX(hv); i>0; i--) {
11651 register HE *entry;
11652 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11653 if (HeVAL(entry) != val)
11655 if ( HeVAL(entry) == &PL_sv_undef ||
11656 HeVAL(entry) == &PL_sv_placeholder)
11660 if (HeKLEN(entry) == HEf_SVKEY)
11661 return sv_mortalcopy(HeKEY_sv(entry));
11662 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11668 /* Look for an entry in the array whose value has the same SV as val;
11669 * If so, return the index, otherwise return -1. */
11672 S_find_array_subscript(pTHX_ AV *av, SV* val)
11675 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11676 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11679 if (val != &PL_sv_undef) {
11680 SV ** const svp = AvARRAY(av);
11683 for (i=AvFILLp(av); i>=0; i--)
11690 /* S_varname(): return the name of a variable, optionally with a subscript.
11691 * If gv is non-zero, use the name of that global, along with gvtype (one
11692 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11693 * targ. Depending on the value of the subscript_type flag, return:
11696 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11697 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11698 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11699 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11702 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11703 SV* keyname, I32 aindex, int subscript_type)
11706 SV * const name = sv_newmortal();
11709 buffer[0] = gvtype;
11712 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11714 gv_fullname4(name, gv, buffer, 0);
11716 if ((unsigned int)SvPVX(name)[1] <= 26) {
11718 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11720 /* Swap the 1 unprintable control character for the 2 byte pretty
11721 version - ie substr($name, 1, 1) = $buffer; */
11722 sv_insert(name, 1, 1, buffer, 2);
11727 CV * const cv = find_runcv(&unused);
11731 if (!cv || !CvPADLIST(cv))
11733 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11734 sv = *av_fetch(av, targ, FALSE);
11735 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11738 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11739 SV * const sv = newSV(0);
11740 *SvPVX(name) = '$';
11741 Perl_sv_catpvf(aTHX_ name, "{%s}",
11742 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11745 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11746 *SvPVX(name) = '$';
11747 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11749 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11750 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11757 =for apidoc find_uninit_var
11759 Find the name of the undefined variable (if any) that caused the operator o
11760 to issue a "Use of uninitialized value" warning.
11761 If match is true, only return a name if it's value matches uninit_sv.
11762 So roughly speaking, if a unary operator (such as OP_COS) generates a
11763 warning, then following the direct child of the op may yield an
11764 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11765 other hand, with OP_ADD there are two branches to follow, so we only print
11766 the variable name if we get an exact match.
11768 The name is returned as a mortal SV.
11770 Assumes that PL_op is the op that originally triggered the error, and that
11771 PL_comppad/PL_curpad points to the currently executing pad.
11777 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11785 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11786 uninit_sv == &PL_sv_placeholder)))
11789 switch (obase->op_type) {
11796 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11797 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11800 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11802 if (pad) { /* @lex, %lex */
11803 sv = PAD_SVl(obase->op_targ);
11807 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11808 /* @global, %global */
11809 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11812 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11814 else /* @{expr}, %{expr} */
11815 return find_uninit_var(cUNOPx(obase)->op_first,
11819 /* attempt to find a match within the aggregate */
11821 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11823 subscript_type = FUV_SUBSCRIPT_HASH;
11826 index = find_array_subscript((AV*)sv, uninit_sv);
11828 subscript_type = FUV_SUBSCRIPT_ARRAY;
11831 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11834 return varname(gv, hash ? '%' : '@', obase->op_targ,
11835 keysv, index, subscript_type);
11839 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11841 return varname(NULL, '$', obase->op_targ,
11842 NULL, 0, FUV_SUBSCRIPT_NONE);
11845 gv = cGVOPx_gv(obase);
11846 if (!gv || (match && GvSV(gv) != uninit_sv))
11848 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11851 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11854 av = (AV*)PAD_SV(obase->op_targ);
11855 if (!av || SvRMAGICAL(av))
11857 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11858 if (!svp || *svp != uninit_sv)
11861 return varname(NULL, '$', obase->op_targ,
11862 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11865 gv = cGVOPx_gv(obase);
11871 if (!av || SvRMAGICAL(av))
11873 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11874 if (!svp || *svp != uninit_sv)
11877 return varname(gv, '$', 0,
11878 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11883 o = cUNOPx(obase)->op_first;
11884 if (!o || o->op_type != OP_NULL ||
11885 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11887 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11891 if (PL_op == obase)
11892 /* $a[uninit_expr] or $h{uninit_expr} */
11893 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11896 o = cBINOPx(obase)->op_first;
11897 kid = cBINOPx(obase)->op_last;
11899 /* get the av or hv, and optionally the gv */
11901 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11902 sv = PAD_SV(o->op_targ);
11904 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11905 && cUNOPo->op_first->op_type == OP_GV)
11907 gv = cGVOPx_gv(cUNOPo->op_first);
11910 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11915 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11916 /* index is constant */
11920 if (obase->op_type == OP_HELEM) {
11921 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11922 if (!he || HeVAL(he) != uninit_sv)
11926 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11927 if (!svp || *svp != uninit_sv)
11931 if (obase->op_type == OP_HELEM)
11932 return varname(gv, '%', o->op_targ,
11933 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11935 return varname(gv, '@', o->op_targ, NULL,
11936 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11939 /* index is an expression;
11940 * attempt to find a match within the aggregate */
11941 if (obase->op_type == OP_HELEM) {
11942 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11944 return varname(gv, '%', o->op_targ,
11945 keysv, 0, FUV_SUBSCRIPT_HASH);
11948 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11950 return varname(gv, '@', o->op_targ,
11951 NULL, index, FUV_SUBSCRIPT_ARRAY);
11956 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11958 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11963 /* only examine RHS */
11964 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11967 o = cUNOPx(obase)->op_first;
11968 if (o->op_type == OP_PUSHMARK)
11971 if (!o->op_sibling) {
11972 /* one-arg version of open is highly magical */
11974 if (o->op_type == OP_GV) { /* open FOO; */
11976 if (match && GvSV(gv) != uninit_sv)
11978 return varname(gv, '$', 0,
11979 NULL, 0, FUV_SUBSCRIPT_NONE);
11981 /* other possibilities not handled are:
11982 * open $x; or open my $x; should return '${*$x}'
11983 * open expr; should return '$'.expr ideally
11989 /* ops where $_ may be an implicit arg */
11993 if ( !(obase->op_flags & OPf_STACKED)) {
11994 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11995 ? PAD_SVl(obase->op_targ)
11998 sv = sv_newmortal();
11999 sv_setpvn(sv, "$_", 2);
12007 /* skip filehandle as it can't produce 'undef' warning */
12008 o = cUNOPx(obase)->op_first;
12009 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12010 o = o->op_sibling->op_sibling;
12017 match = 1; /* XS or custom code could trigger random warnings */
12022 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12023 return sv_2mortal(newSVpvs("${$/}"));
12028 if (!(obase->op_flags & OPf_KIDS))
12030 o = cUNOPx(obase)->op_first;
12036 /* if all except one arg are constant, or have no side-effects,
12037 * or are optimized away, then it's unambiguous */
12039 for (kid=o; kid; kid = kid->op_sibling) {
12041 const OPCODE type = kid->op_type;
12042 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12043 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12044 || (type == OP_PUSHMARK)
12048 if (o2) { /* more than one found */
12055 return find_uninit_var(o2, uninit_sv, match);
12057 /* scan all args */
12059 sv = find_uninit_var(o, uninit_sv, 1);
12071 =for apidoc report_uninit
12073 Print appropriate "Use of uninitialized variable" warning
12079 Perl_report_uninit(pTHX_ SV* uninit_sv)
12083 SV* varname = NULL;
12085 varname = find_uninit_var(PL_op, uninit_sv,0);
12087 sv_insert(varname, 0, 0, " ", 1);
12089 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12090 varname ? SvPV_nolen_const(varname) : "",
12091 " in ", OP_DESC(PL_op));
12094 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12100 * c-indentation-style: bsd
12101 * c-basic-offset: 4
12102 * indent-tabs-mode: t
12105 * ex: set ts=8 sts=4 sw=4 noet: