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.
558 The arena_sets are themselves stored in an arena, but as arenas
559 themselves are never freed at run time, there is no need to chain the
560 arena_sets onto an arena_set root.
562 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
563 memory in the last arena-set (1/2 on average). In trade, we get
564 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
565 smaller types). The recovery of the wasted space allows use of
566 small arenas for large, rare body types,
569 char *arena; /* the raw storage, allocated aligned */
570 size_t size; /* its size ~4k typ */
571 int unit_type; /* useful for arena audits */
572 /* info for sv-heads (eventually)
579 /* Get the maximum number of elements in set[] such that struct arena_set
580 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
581 therefore likely to be 1 aligned memory page. */
583 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
584 - 2 * sizeof(int)) / sizeof (struct arena_desc))
587 struct arena_set* next;
588 int set_size; /* ie ARENAS_PER_SET */
589 int curr; /* index of next available arena-desc */
590 struct arena_desc set[ARENAS_PER_SET];
594 =for apidoc sv_free_arenas
596 Deallocate the memory used by all arenas. Note that all the individual SV
597 heads and bodies within the arenas must already have been freed.
602 Perl_sv_free_arenas(pTHX)
609 /* Free arenas here, but be careful about fake ones. (We assume
610 contiguity of the fake ones with the corresponding real ones.) */
612 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
613 svanext = (SV*) SvANY(sva);
614 while (svanext && SvFAKE(svanext))
615 svanext = (SV*) SvANY(svanext);
622 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
624 for (; aroot; aroot = next) {
625 const int max = aroot->curr;
626 for (i=0; i<max; i++) {
627 assert(aroot->set[i].arena);
628 Safefree(aroot->set[i].arena);
636 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
637 PL_body_roots[i] = 0;
639 Safefree(PL_nice_chunk);
640 PL_nice_chunk = NULL;
641 PL_nice_chunk_size = 0;
647 Here are mid-level routines that manage the allocation of bodies out
648 of the various arenas. There are 5 kinds of arenas:
650 1. SV-head arenas, which are discussed and handled above
651 2. regular body arenas
652 3. arenas for reduced-size bodies
654 5. pte arenas (thread related)
656 Arena types 2 & 3 are chained by body-type off an array of
657 arena-root pointers, which is indexed by svtype. Some of the
658 larger/less used body types are malloced singly, since a large
659 unused block of them is wasteful. Also, several svtypes dont have
660 bodies; the data fits into the sv-head itself. The arena-root
661 pointer thus has a few unused root-pointers (which may be hijacked
662 later for arena types 4,5)
664 3 differs from 2 as an optimization; some body types have several
665 unused fields in the front of the structure (which are kept in-place
666 for consistency). These bodies can be allocated in smaller chunks,
667 because the leading fields arent accessed. Pointers to such bodies
668 are decremented to point at the unused 'ghost' memory, knowing that
669 the pointers are used with offsets to the real memory.
671 HE, HEK arenas are managed separately, with separate code, but may
672 be merge-able later..
674 PTE arenas are not sv-bodies, but they share these mid-level
675 mechanics, so are considered here. The new mid-level mechanics rely
676 on the sv_type of the body being allocated, so we just reserve one
677 of the unused body-slots for PTEs, then use it in those (2) PTE
678 contexts below (line ~10k)
681 /* get_arena(size): this creates custom-sized arenas
682 TBD: export properly for hv.c: S_more_he().
685 Perl_get_arena(pTHX_ size_t arena_size)
688 struct arena_desc* adesc;
689 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
692 /* shouldnt need this
693 if (!arena_size) arena_size = PERL_ARENA_SIZE;
696 /* may need new arena-set to hold new arena */
697 if (!aroot || aroot->curr >= aroot->set_size) {
698 struct arena_set *newroot;
699 Newxz(newroot, 1, struct arena_set);
700 newroot->set_size = ARENAS_PER_SET;
701 newroot->next = aroot;
703 PL_body_arenas = (void *) newroot;
704 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
707 /* ok, now have arena-set with at least 1 empty/available arena-desc */
708 curr = aroot->curr++;
709 adesc = &(aroot->set[curr]);
710 assert(!adesc->arena);
712 Newx(adesc->arena, arena_size, char);
713 adesc->size = arena_size;
714 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
715 curr, (void*)adesc->arena, arena_size));
721 /* return a thing to the free list */
723 #define del_body(thing, root) \
725 void ** const thing_copy = (void **)thing;\
727 *thing_copy = *root; \
728 *root = (void*)thing_copy; \
734 =head1 SV-Body Allocation
736 Allocation of SV-bodies is similar to SV-heads, differing as follows;
737 the allocation mechanism is used for many body types, so is somewhat
738 more complicated, it uses arena-sets, and has no need for still-live
741 At the outermost level, (new|del)_X*V macros return bodies of the
742 appropriate type. These macros call either (new|del)_body_type or
743 (new|del)_body_allocated macro pairs, depending on specifics of the
744 type. Most body types use the former pair, the latter pair is used to
745 allocate body types with "ghost fields".
747 "ghost fields" are fields that are unused in certain types, and
748 consequently dont need to actually exist. They are declared because
749 they're part of a "base type", which allows use of functions as
750 methods. The simplest examples are AVs and HVs, 2 aggregate types
751 which don't use the fields which support SCALAR semantics.
753 For these types, the arenas are carved up into *_allocated size
754 chunks, we thus avoid wasted memory for those unaccessed members.
755 When bodies are allocated, we adjust the pointer back in memory by the
756 size of the bit not allocated, so it's as if we allocated the full
757 structure. (But things will all go boom if you write to the part that
758 is "not there", because you'll be overwriting the last members of the
759 preceding structure in memory.)
761 We calculate the correction using the STRUCT_OFFSET macro. For
762 example, if xpv_allocated is the same structure as XPV then the two
763 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
764 structure is smaller (no initial NV actually allocated) then the net
765 effect is to subtract the size of the NV from the pointer, to return a
766 new pointer as if an initial NV were actually allocated.
768 This is the same trick as was used for NV and IV bodies. Ironically it
769 doesn't need to be used for NV bodies any more, because NV is now at
770 the start of the structure. IV bodies don't need it either, because
771 they are no longer allocated.
773 In turn, the new_body_* allocators call S_new_body(), which invokes
774 new_body_inline macro, which takes a lock, and takes a body off the
775 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
776 necessary to refresh an empty list. Then the lock is released, and
777 the body is returned.
779 S_more_bodies calls get_arena(), and carves it up into an array of N
780 bodies, which it strings into a linked list. It looks up arena-size
781 and body-size from the body_details table described below, thus
782 supporting the multiple body-types.
784 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
785 the (new|del)_X*V macros are mapped directly to malloc/free.
791 For each sv-type, struct body_details bodies_by_type[] carries
792 parameters which control these aspects of SV handling:
794 Arena_size determines whether arenas are used for this body type, and if
795 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
796 zero, forcing individual mallocs and frees.
798 Body_size determines how big a body is, and therefore how many fit into
799 each arena. Offset carries the body-pointer adjustment needed for
800 *_allocated body types, and is used in *_allocated macros.
802 But its main purpose is to parameterize info needed in
803 Perl_sv_upgrade(). The info here dramatically simplifies the function
804 vs the implementation in 5.8.7, making it table-driven. All fields
805 are used for this, except for arena_size.
807 For the sv-types that have no bodies, arenas are not used, so those
808 PL_body_roots[sv_type] are unused, and can be overloaded. In
809 something of a special case, SVt_NULL is borrowed for HE arenas;
810 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
811 bodies_by_type[SVt_NULL] slot is not used, as the table is not
814 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
815 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
816 they can just use the same allocation semantics. At first, PTEs were
817 also overloaded to a non-body sv-type, but this yielded hard-to-find
818 malloc bugs, so was simplified by claiming a new slot. This choice
819 has no consequence at this time.
823 struct body_details {
824 U8 body_size; /* Size to allocate */
825 U8 copy; /* Size of structure to copy (may be shorter) */
827 unsigned int type : 4; /* We have space for a sanity check. */
828 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
829 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
830 unsigned int arena : 1; /* Allocated from an arena */
831 size_t arena_size; /* Size of arena to allocate */
839 /* With -DPURFIY we allocate everything directly, and don't use arenas.
840 This seems a rather elegant way to simplify some of the code below. */
841 #define HASARENA FALSE
843 #define HASARENA TRUE
845 #define NOARENA FALSE
847 /* Size the arenas to exactly fit a given number of bodies. A count
848 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
849 simplifying the default. If count > 0, the arena is sized to fit
850 only that many bodies, allowing arenas to be used for large, rare
851 bodies (XPVFM, XPVIO) without undue waste. The arena size is
852 limited by PERL_ARENA_SIZE, so we can safely oversize the
855 #define FIT_ARENA0(body_size) \
856 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
857 #define FIT_ARENAn(count,body_size) \
858 ( count * body_size <= PERL_ARENA_SIZE) \
859 ? count * body_size \
860 : FIT_ARENA0 (body_size)
861 #define FIT_ARENA(count,body_size) \
863 ? FIT_ARENAn (count, body_size) \
864 : FIT_ARENA0 (body_size)
866 /* A macro to work out the offset needed to subtract from a pointer to (say)
873 to make its members accessible via a pointer to (say)
883 #define relative_STRUCT_OFFSET(longer, shorter, member) \
884 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
886 /* Calculate the length to copy. Specifically work out the length less any
887 final padding the compiler needed to add. See the comment in sv_upgrade
888 for why copying the padding proved to be a bug. */
890 #define copy_length(type, last_member) \
891 STRUCT_OFFSET(type, last_member) \
892 + sizeof (((type*)SvANY((SV*)0))->last_member)
894 static const struct body_details bodies_by_type[] = {
895 { sizeof(HE), 0, 0, SVt_NULL,
896 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
898 /* The bind placeholder pretends to be an RV for now.
899 Also it's marked as "can't upgrade" top stop anyone using it before it's
901 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
903 /* IVs are in the head, so the allocation size is 0.
904 However, the slot is overloaded for PTEs. */
905 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
906 sizeof(IV), /* This is used to copy out the IV body. */
907 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
908 NOARENA /* IVS don't need an arena */,
909 /* But PTEs need to know the size of their arena */
910 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
913 /* 8 bytes on most ILP32 with IEEE doubles */
914 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
915 FIT_ARENA(0, sizeof(NV)) },
917 /* RVs are in the head now. */
918 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
920 /* 8 bytes on most ILP32 with IEEE doubles */
921 { sizeof(xpv_allocated),
922 copy_length(XPV, xpv_len)
923 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
924 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
925 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
928 { sizeof(xpviv_allocated),
929 copy_length(XPVIV, xiv_u)
930 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
931 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
932 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
935 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
936 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
939 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
940 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
943 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
944 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
947 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
948 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
950 { sizeof(xpvav_allocated),
951 copy_length(XPVAV, xmg_stash)
952 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
953 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
954 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
956 { sizeof(xpvhv_allocated),
957 copy_length(XPVHV, xmg_stash)
958 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
959 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
960 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
963 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
964 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
965 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
967 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
968 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
969 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
971 /* XPVIO is 84 bytes, fits 48x */
972 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
973 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
976 #define new_body_type(sv_type) \
977 (void *)((char *)S_new_body(aTHX_ sv_type))
979 #define del_body_type(p, sv_type) \
980 del_body(p, &PL_body_roots[sv_type])
983 #define new_body_allocated(sv_type) \
984 (void *)((char *)S_new_body(aTHX_ sv_type) \
985 - bodies_by_type[sv_type].offset)
987 #define del_body_allocated(p, sv_type) \
988 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
991 #define my_safemalloc(s) (void*)safemalloc(s)
992 #define my_safecalloc(s) (void*)safecalloc(s, 1)
993 #define my_safefree(p) safefree((char*)p)
997 #define new_XNV() my_safemalloc(sizeof(XPVNV))
998 #define del_XNV(p) my_safefree(p)
1000 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1001 #define del_XPVNV(p) my_safefree(p)
1003 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1004 #define del_XPVAV(p) my_safefree(p)
1006 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1007 #define del_XPVHV(p) my_safefree(p)
1009 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1010 #define del_XPVMG(p) my_safefree(p)
1012 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1013 #define del_XPVGV(p) my_safefree(p)
1017 #define new_XNV() new_body_type(SVt_NV)
1018 #define del_XNV(p) del_body_type(p, SVt_NV)
1020 #define new_XPVNV() new_body_type(SVt_PVNV)
1021 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1023 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1024 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1026 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1027 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1029 #define new_XPVMG() new_body_type(SVt_PVMG)
1030 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1032 #define new_XPVGV() new_body_type(SVt_PVGV)
1033 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1037 /* no arena for you! */
1039 #define new_NOARENA(details) \
1040 my_safemalloc((details)->body_size + (details)->offset)
1041 #define new_NOARENAZ(details) \
1042 my_safecalloc((details)->body_size + (details)->offset)
1045 S_more_bodies (pTHX_ svtype sv_type)
1048 void ** const root = &PL_body_roots[sv_type];
1049 const struct body_details * const bdp = &bodies_by_type[sv_type];
1050 const size_t body_size = bdp->body_size;
1053 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1054 static bool done_sanity_check;
1056 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1057 * variables like done_sanity_check. */
1058 if (!done_sanity_check) {
1059 unsigned int i = SVt_LAST;
1061 done_sanity_check = TRUE;
1064 assert (bodies_by_type[i].type == i);
1068 assert(bdp->arena_size);
1070 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1072 end = start + bdp->arena_size - body_size;
1074 /* computed count doesnt reflect the 1st slot reservation */
1075 DEBUG_m(PerlIO_printf(Perl_debug_log,
1076 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1077 (void*)start, (void*)end,
1078 (int)bdp->arena_size, sv_type, (int)body_size,
1079 (int)bdp->arena_size / (int)body_size));
1081 *root = (void *)start;
1083 while (start < end) {
1084 char * const next = start + body_size;
1085 *(void**) start = (void *)next;
1088 *(void **)start = 0;
1093 /* grab a new thing from the free list, allocating more if necessary.
1094 The inline version is used for speed in hot routines, and the
1095 function using it serves the rest (unless PURIFY).
1097 #define new_body_inline(xpv, sv_type) \
1099 void ** const r3wt = &PL_body_roots[sv_type]; \
1101 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1102 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1103 *(r3wt) = *(void**)(xpv); \
1110 S_new_body(pTHX_ svtype sv_type)
1114 new_body_inline(xpv, sv_type);
1121 =for apidoc sv_upgrade
1123 Upgrade an SV to a more complex form. Generally adds a new body type to the
1124 SV, then copies across as much information as possible from the old body.
1125 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1131 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1136 const svtype old_type = SvTYPE(sv);
1137 const struct body_details *new_type_details;
1138 const struct body_details *const old_type_details
1139 = bodies_by_type + old_type;
1141 if (new_type != SVt_PV && SvIsCOW(sv)) {
1142 sv_force_normal_flags(sv, 0);
1145 if (old_type == new_type)
1148 if (old_type > new_type)
1149 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1150 (int)old_type, (int)new_type);
1153 old_body = SvANY(sv);
1155 /* Copying structures onto other structures that have been neatly zeroed
1156 has a subtle gotcha. Consider XPVMG
1158 +------+------+------+------+------+-------+-------+
1159 | NV | CUR | LEN | IV | MAGIC | STASH |
1160 +------+------+------+------+------+-------+-------+
1161 0 4 8 12 16 20 24 28
1163 where NVs are aligned to 8 bytes, so that sizeof that structure is
1164 actually 32 bytes long, with 4 bytes of padding at the end:
1166 +------+------+------+------+------+-------+-------+------+
1167 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1168 +------+------+------+------+------+-------+-------+------+
1169 0 4 8 12 16 20 24 28 32
1171 so what happens if you allocate memory for this structure:
1173 +------+------+------+------+------+-------+-------+------+------+...
1174 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1175 +------+------+------+------+------+-------+-------+------+------+...
1176 0 4 8 12 16 20 24 28 32 36
1178 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1179 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1180 started out as zero once, but it's quite possible that it isn't. So now,
1181 rather than a nicely zeroed GP, you have it pointing somewhere random.
1184 (In fact, GP ends up pointing at a previous GP structure, because the
1185 principle cause of the padding in XPVMG getting garbage is a copy of
1186 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1187 this happens to be moot because XPVGV has been re-ordered, with GP
1188 no longer after STASH)
1190 So we are careful and work out the size of used parts of all the
1197 if (new_type < SVt_PVIV) {
1198 new_type = (new_type == SVt_NV)
1199 ? SVt_PVNV : SVt_PVIV;
1203 if (new_type < SVt_PVNV) {
1204 new_type = SVt_PVNV;
1210 assert(new_type > SVt_PV);
1211 assert(SVt_IV < SVt_PV);
1212 assert(SVt_NV < SVt_PV);
1219 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1220 there's no way that it can be safely upgraded, because perl.c
1221 expects to Safefree(SvANY(PL_mess_sv)) */
1222 assert(sv != PL_mess_sv);
1223 /* This flag bit is used to mean other things in other scalar types.
1224 Given that it only has meaning inside the pad, it shouldn't be set
1225 on anything that can get upgraded. */
1226 assert(!SvPAD_TYPED(sv));
1229 if (old_type_details->cant_upgrade)
1230 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1231 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1233 new_type_details = bodies_by_type + new_type;
1235 SvFLAGS(sv) &= ~SVTYPEMASK;
1236 SvFLAGS(sv) |= new_type;
1238 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1239 the return statements above will have triggered. */
1240 assert (new_type != SVt_NULL);
1243 assert(old_type == SVt_NULL);
1244 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1248 assert(old_type == SVt_NULL);
1249 SvANY(sv) = new_XNV();
1253 assert(old_type == SVt_NULL);
1254 SvANY(sv) = &sv->sv_u.svu_rv;
1259 assert(new_type_details->body_size);
1262 assert(new_type_details->arena);
1263 assert(new_type_details->arena_size);
1264 /* This points to the start of the allocated area. */
1265 new_body_inline(new_body, new_type);
1266 Zero(new_body, new_type_details->body_size, char);
1267 new_body = ((char *)new_body) - new_type_details->offset;
1269 /* We always allocated the full length item with PURIFY. To do this
1270 we fake things so that arena is false for all 16 types.. */
1271 new_body = new_NOARENAZ(new_type_details);
1273 SvANY(sv) = new_body;
1274 if (new_type == SVt_PVAV) {
1280 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1281 The target created by newSVrv also is, and it can have magic.
1282 However, it never has SvPVX set.
1284 if (old_type >= SVt_RV) {
1285 assert(SvPVX_const(sv) == 0);
1288 if (old_type >= SVt_PVMG) {
1289 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1290 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 sv->sv_u.svu_array = NULL; /* or svu_hash */
1298 /* XXX Is this still needed? Was it ever needed? Surely as there is
1299 no route from NV to PVIV, NOK can never be true */
1300 assert(!SvNOKp(sv));
1311 assert(new_type_details->body_size);
1312 /* We always allocated the full length item with PURIFY. To do this
1313 we fake things so that arena is false for all 16 types.. */
1314 if(new_type_details->arena) {
1315 /* This points to the start of the allocated area. */
1316 new_body_inline(new_body, new_type);
1317 Zero(new_body, new_type_details->body_size, char);
1318 new_body = ((char *)new_body) - new_type_details->offset;
1320 new_body = new_NOARENAZ(new_type_details);
1322 SvANY(sv) = new_body;
1324 if (old_type_details->copy) {
1325 /* There is now the potential for an upgrade from something without
1326 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1327 int offset = old_type_details->offset;
1328 int length = old_type_details->copy;
1330 if (new_type_details->offset > old_type_details->offset) {
1331 const int difference
1332 = new_type_details->offset - old_type_details->offset;
1333 offset += difference;
1334 length -= difference;
1336 assert (length >= 0);
1338 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1342 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1343 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1344 * correct 0.0 for us. Otherwise, if the old body didn't have an
1345 * NV slot, but the new one does, then we need to initialise the
1346 * freshly created NV slot with whatever the correct bit pattern is
1348 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1352 if (new_type == SVt_PVIO)
1353 IoPAGE_LEN(sv) = 60;
1354 if (old_type < SVt_RV)
1358 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1359 (unsigned long)new_type);
1362 if (old_type_details->arena) {
1363 /* If there was an old body, then we need to free it.
1364 Note that there is an assumption that all bodies of types that
1365 can be upgraded came from arenas. Only the more complex non-
1366 upgradable types are allowed to be directly malloc()ed. */
1368 my_safefree(old_body);
1370 del_body((void*)((char*)old_body + old_type_details->offset),
1371 &PL_body_roots[old_type]);
1377 =for apidoc sv_backoff
1379 Remove any string offset. You should normally use the C<SvOOK_off> macro
1386 Perl_sv_backoff(pTHX_ register SV *sv)
1388 PERL_UNUSED_CONTEXT;
1390 assert(SvTYPE(sv) != SVt_PVHV);
1391 assert(SvTYPE(sv) != SVt_PVAV);
1393 const char * const s = SvPVX_const(sv);
1394 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1395 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1397 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1399 SvFLAGS(sv) &= ~SVf_OOK;
1406 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1407 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1408 Use the C<SvGROW> wrapper instead.
1414 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1418 if (PL_madskills && newlen >= 0x100000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1422 #ifdef HAS_64K_LIMIT
1423 if (newlen >= 0x10000) {
1424 PerlIO_printf(Perl_debug_log,
1425 "Allocation too large: %"UVxf"\n", (UV)newlen);
1428 #endif /* HAS_64K_LIMIT */
1431 if (SvTYPE(sv) < SVt_PV) {
1432 sv_upgrade(sv, SVt_PV);
1433 s = SvPVX_mutable(sv);
1435 else if (SvOOK(sv)) { /* pv is offset? */
1437 s = SvPVX_mutable(sv);
1438 if (newlen > SvLEN(sv))
1439 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1440 #ifdef HAS_64K_LIMIT
1441 if (newlen >= 0x10000)
1446 s = SvPVX_mutable(sv);
1448 if (newlen > SvLEN(sv)) { /* need more room? */
1449 newlen = PERL_STRLEN_ROUNDUP(newlen);
1450 if (SvLEN(sv) && s) {
1452 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1458 s = (char*)saferealloc(s, newlen);
1461 s = (char*)safemalloc(newlen);
1462 if (SvPVX_const(sv) && SvCUR(sv)) {
1463 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1467 SvLEN_set(sv, newlen);
1473 =for apidoc sv_setiv
1475 Copies an integer into the given SV, upgrading first if necessary.
1476 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1482 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1485 SV_CHECK_THINKFIRST_COW_DROP(sv);
1486 switch (SvTYPE(sv)) {
1488 sv_upgrade(sv, SVt_IV);
1491 sv_upgrade(sv, SVt_PVNV);
1495 sv_upgrade(sv, SVt_PVIV);
1504 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1508 (void)SvIOK_only(sv); /* validate number */
1514 =for apidoc sv_setiv_mg
1516 Like C<sv_setiv>, but also handles 'set' magic.
1522 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1529 =for apidoc sv_setuv
1531 Copies an unsigned integer into the given SV, upgrading first if necessary.
1532 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1538 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1540 /* With these two if statements:
1541 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1544 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1546 If you wish to remove them, please benchmark to see what the effect is
1548 if (u <= (UV)IV_MAX) {
1549 sv_setiv(sv, (IV)u);
1558 =for apidoc sv_setuv_mg
1560 Like C<sv_setuv>, but also handles 'set' magic.
1566 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1573 =for apidoc sv_setnv
1575 Copies a double into the given SV, upgrading first if necessary.
1576 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1582 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1585 SV_CHECK_THINKFIRST_COW_DROP(sv);
1586 switch (SvTYPE(sv)) {
1589 sv_upgrade(sv, SVt_NV);
1594 sv_upgrade(sv, SVt_PVNV);
1603 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1608 (void)SvNOK_only(sv); /* validate number */
1613 =for apidoc sv_setnv_mg
1615 Like C<sv_setnv>, but also handles 'set' magic.
1621 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1627 /* Print an "isn't numeric" warning, using a cleaned-up,
1628 * printable version of the offending string
1632 S_not_a_number(pTHX_ SV *sv)
1640 dsv = sv_2mortal(newSVpvs(""));
1641 pv = sv_uni_display(dsv, sv, 10, 0);
1644 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1645 /* each *s can expand to 4 chars + "...\0",
1646 i.e. need room for 8 chars */
1648 const char *s = SvPVX_const(sv);
1649 const char * const end = s + SvCUR(sv);
1650 for ( ; s < end && d < limit; s++ ) {
1652 if (ch & 128 && !isPRINT_LC(ch)) {
1661 else if (ch == '\r') {
1665 else if (ch == '\f') {
1669 else if (ch == '\\') {
1673 else if (ch == '\0') {
1677 else if (isPRINT_LC(ch))
1694 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1695 "Argument \"%s\" isn't numeric in %s", pv,
1698 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1699 "Argument \"%s\" isn't numeric", pv);
1703 =for apidoc looks_like_number
1705 Test if the content of an SV looks like a number (or is a number).
1706 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1707 non-numeric warning), even if your atof() doesn't grok them.
1713 Perl_looks_like_number(pTHX_ SV *sv)
1715 register const char *sbegin;
1719 sbegin = SvPVX_const(sv);
1722 else if (SvPOKp(sv))
1723 sbegin = SvPV_const(sv, len);
1725 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1726 return grok_number(sbegin, len, NULL);
1730 S_glob_2number(pTHX_ GV * const gv)
1732 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1733 SV *const buffer = sv_newmortal();
1735 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1738 gv_efullname3(buffer, gv, "*");
1739 SvFLAGS(gv) |= wasfake;
1741 /* We know that all GVs stringify to something that is not-a-number,
1742 so no need to test that. */
1743 if (ckWARN(WARN_NUMERIC))
1744 not_a_number(buffer);
1745 /* We just want something true to return, so that S_sv_2iuv_common
1746 can tail call us and return true. */
1751 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1753 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1754 SV *const buffer = sv_newmortal();
1756 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1759 gv_efullname3(buffer, gv, "*");
1760 SvFLAGS(gv) |= wasfake;
1762 assert(SvPOK(buffer));
1764 *len = SvCUR(buffer);
1766 return SvPVX(buffer);
1769 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1770 until proven guilty, assume that things are not that bad... */
1775 As 64 bit platforms often have an NV that doesn't preserve all bits of
1776 an IV (an assumption perl has been based on to date) it becomes necessary
1777 to remove the assumption that the NV always carries enough precision to
1778 recreate the IV whenever needed, and that the NV is the canonical form.
1779 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1780 precision as a side effect of conversion (which would lead to insanity
1781 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1782 1) to distinguish between IV/UV/NV slots that have cached a valid
1783 conversion where precision was lost and IV/UV/NV slots that have a
1784 valid conversion which has lost no precision
1785 2) to ensure that if a numeric conversion to one form is requested that
1786 would lose precision, the precise conversion (or differently
1787 imprecise conversion) is also performed and cached, to prevent
1788 requests for different numeric formats on the same SV causing
1789 lossy conversion chains. (lossless conversion chains are perfectly
1794 SvIOKp is true if the IV slot contains a valid value
1795 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1796 SvNOKp is true if the NV slot contains a valid value
1797 SvNOK is true only if the NV value is accurate
1800 while converting from PV to NV, check to see if converting that NV to an
1801 IV(or UV) would lose accuracy over a direct conversion from PV to
1802 IV(or UV). If it would, cache both conversions, return NV, but mark
1803 SV as IOK NOKp (ie not NOK).
1805 While converting from PV to IV, check to see if converting that IV to an
1806 NV would lose accuracy over a direct conversion from PV to NV. If it
1807 would, cache both conversions, flag similarly.
1809 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1810 correctly because if IV & NV were set NV *always* overruled.
1811 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1812 changes - now IV and NV together means that the two are interchangeable:
1813 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1815 The benefit of this is that operations such as pp_add know that if
1816 SvIOK is true for both left and right operands, then integer addition
1817 can be used instead of floating point (for cases where the result won't
1818 overflow). Before, floating point was always used, which could lead to
1819 loss of precision compared with integer addition.
1821 * making IV and NV equal status should make maths accurate on 64 bit
1823 * may speed up maths somewhat if pp_add and friends start to use
1824 integers when possible instead of fp. (Hopefully the overhead in
1825 looking for SvIOK and checking for overflow will not outweigh the
1826 fp to integer speedup)
1827 * will slow down integer operations (callers of SvIV) on "inaccurate"
1828 values, as the change from SvIOK to SvIOKp will cause a call into
1829 sv_2iv each time rather than a macro access direct to the IV slot
1830 * should speed up number->string conversion on integers as IV is
1831 favoured when IV and NV are equally accurate
1833 ####################################################################
1834 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1835 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1836 On the other hand, SvUOK is true iff UV.
1837 ####################################################################
1839 Your mileage will vary depending your CPU's relative fp to integer
1843 #ifndef NV_PRESERVES_UV
1844 # define IS_NUMBER_UNDERFLOW_IV 1
1845 # define IS_NUMBER_UNDERFLOW_UV 2
1846 # define IS_NUMBER_IV_AND_UV 2
1847 # define IS_NUMBER_OVERFLOW_IV 4
1848 # define IS_NUMBER_OVERFLOW_UV 5
1850 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1852 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1854 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1857 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1858 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));
1859 if (SvNVX(sv) < (NV)IV_MIN) {
1860 (void)SvIOKp_on(sv);
1862 SvIV_set(sv, IV_MIN);
1863 return IS_NUMBER_UNDERFLOW_IV;
1865 if (SvNVX(sv) > (NV)UV_MAX) {
1866 (void)SvIOKp_on(sv);
1869 SvUV_set(sv, UV_MAX);
1870 return IS_NUMBER_OVERFLOW_UV;
1872 (void)SvIOKp_on(sv);
1874 /* Can't use strtol etc to convert this string. (See truth table in
1876 if (SvNVX(sv) <= (UV)IV_MAX) {
1877 SvIV_set(sv, I_V(SvNVX(sv)));
1878 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1879 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1881 /* Integer is imprecise. NOK, IOKp */
1883 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1886 SvUV_set(sv, U_V(SvNVX(sv)));
1887 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1888 if (SvUVX(sv) == UV_MAX) {
1889 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1890 possibly be preserved by NV. Hence, it must be overflow.
1892 return IS_NUMBER_OVERFLOW_UV;
1894 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1896 /* Integer is imprecise. NOK, IOKp */
1898 return IS_NUMBER_OVERFLOW_IV;
1900 #endif /* !NV_PRESERVES_UV*/
1903 S_sv_2iuv_common(pTHX_ SV *sv) {
1906 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1907 * without also getting a cached IV/UV from it at the same time
1908 * (ie PV->NV conversion should detect loss of accuracy and cache
1909 * IV or UV at same time to avoid this. */
1910 /* IV-over-UV optimisation - choose to cache IV if possible */
1912 if (SvTYPE(sv) == SVt_NV)
1913 sv_upgrade(sv, SVt_PVNV);
1915 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1916 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1917 certainly cast into the IV range at IV_MAX, whereas the correct
1918 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1920 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1921 if (Perl_isnan(SvNVX(sv))) {
1927 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1928 SvIV_set(sv, I_V(SvNVX(sv)));
1929 if (SvNVX(sv) == (NV) SvIVX(sv)
1930 #ifndef NV_PRESERVES_UV
1931 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1932 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1933 /* Don't flag it as "accurately an integer" if the number
1934 came from a (by definition imprecise) NV operation, and
1935 we're outside the range of NV integer precision */
1938 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1939 DEBUG_c(PerlIO_printf(Perl_debug_log,
1940 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1946 /* IV not precise. No need to convert from PV, as NV
1947 conversion would already have cached IV if it detected
1948 that PV->IV would be better than PV->NV->IV
1949 flags already correct - don't set public IOK. */
1950 DEBUG_c(PerlIO_printf(Perl_debug_log,
1951 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1956 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1957 but the cast (NV)IV_MIN rounds to a the value less (more
1958 negative) than IV_MIN which happens to be equal to SvNVX ??
1959 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1960 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1961 (NV)UVX == NVX are both true, but the values differ. :-(
1962 Hopefully for 2s complement IV_MIN is something like
1963 0x8000000000000000 which will be exact. NWC */
1966 SvUV_set(sv, U_V(SvNVX(sv)));
1968 (SvNVX(sv) == (NV) SvUVX(sv))
1969 #ifndef NV_PRESERVES_UV
1970 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1971 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1972 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1973 /* Don't flag it as "accurately an integer" if the number
1974 came from a (by definition imprecise) NV operation, and
1975 we're outside the range of NV integer precision */
1980 DEBUG_c(PerlIO_printf(Perl_debug_log,
1981 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1987 else if (SvPOKp(sv) && SvLEN(sv)) {
1989 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1990 /* We want to avoid a possible problem when we cache an IV/ a UV which
1991 may be later translated to an NV, and the resulting NV is not
1992 the same as the direct translation of the initial string
1993 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1994 be careful to ensure that the value with the .456 is around if the
1995 NV value is requested in the future).
1997 This means that if we cache such an IV/a UV, we need to cache the
1998 NV as well. Moreover, we trade speed for space, and do not
1999 cache the NV if we are sure it's not needed.
2002 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2003 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2004 == IS_NUMBER_IN_UV) {
2005 /* It's definitely an integer, only upgrade to PVIV */
2006 if (SvTYPE(sv) < SVt_PVIV)
2007 sv_upgrade(sv, SVt_PVIV);
2009 } else if (SvTYPE(sv) < SVt_PVNV)
2010 sv_upgrade(sv, SVt_PVNV);
2012 /* If NVs preserve UVs then we only use the UV value if we know that
2013 we aren't going to call atof() below. If NVs don't preserve UVs
2014 then the value returned may have more precision than atof() will
2015 return, even though value isn't perfectly accurate. */
2016 if ((numtype & (IS_NUMBER_IN_UV
2017 #ifdef NV_PRESERVES_UV
2020 )) == IS_NUMBER_IN_UV) {
2021 /* This won't turn off the public IOK flag if it was set above */
2022 (void)SvIOKp_on(sv);
2024 if (!(numtype & IS_NUMBER_NEG)) {
2026 if (value <= (UV)IV_MAX) {
2027 SvIV_set(sv, (IV)value);
2029 /* it didn't overflow, and it was positive. */
2030 SvUV_set(sv, value);
2034 /* 2s complement assumption */
2035 if (value <= (UV)IV_MIN) {
2036 SvIV_set(sv, -(IV)value);
2038 /* Too negative for an IV. This is a double upgrade, but
2039 I'm assuming it will be rare. */
2040 if (SvTYPE(sv) < SVt_PVNV)
2041 sv_upgrade(sv, SVt_PVNV);
2045 SvNV_set(sv, -(NV)value);
2046 SvIV_set(sv, IV_MIN);
2050 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2051 will be in the previous block to set the IV slot, and the next
2052 block to set the NV slot. So no else here. */
2054 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2055 != IS_NUMBER_IN_UV) {
2056 /* It wasn't an (integer that doesn't overflow the UV). */
2057 SvNV_set(sv, Atof(SvPVX_const(sv)));
2059 if (! numtype && ckWARN(WARN_NUMERIC))
2062 #if defined(USE_LONG_DOUBLE)
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2066 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2067 PTR2UV(sv), SvNVX(sv)));
2070 #ifdef NV_PRESERVES_UV
2071 (void)SvIOKp_on(sv);
2073 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2074 SvIV_set(sv, I_V(SvNVX(sv)));
2075 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2078 NOOP; /* Integer is imprecise. NOK, IOKp */
2080 /* UV will not work better than IV */
2082 if (SvNVX(sv) > (NV)UV_MAX) {
2084 /* Integer is inaccurate. NOK, IOKp, is UV */
2085 SvUV_set(sv, UV_MAX);
2087 SvUV_set(sv, U_V(SvNVX(sv)));
2088 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2089 NV preservse UV so can do correct comparison. */
2090 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2093 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2098 #else /* NV_PRESERVES_UV */
2099 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2100 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2101 /* The IV/UV slot will have been set from value returned by
2102 grok_number above. The NV slot has just been set using
2105 assert (SvIOKp(sv));
2107 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2108 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2109 /* Small enough to preserve all bits. */
2110 (void)SvIOKp_on(sv);
2112 SvIV_set(sv, I_V(SvNVX(sv)));
2113 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2115 /* Assumption: first non-preserved integer is < IV_MAX,
2116 this NV is in the preserved range, therefore: */
2117 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2119 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);
2123 0 0 already failed to read UV.
2124 0 1 already failed to read UV.
2125 1 0 you won't get here in this case. IV/UV
2126 slot set, public IOK, Atof() unneeded.
2127 1 1 already read UV.
2128 so there's no point in sv_2iuv_non_preserve() attempting
2129 to use atol, strtol, strtoul etc. */
2130 sv_2iuv_non_preserve (sv, numtype);
2133 #endif /* NV_PRESERVES_UV */
2137 if (isGV_with_GP(sv))
2138 return glob_2number((GV *)sv);
2140 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2141 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2144 if (SvTYPE(sv) < SVt_IV)
2145 /* Typically the caller expects that sv_any is not NULL now. */
2146 sv_upgrade(sv, SVt_IV);
2147 /* Return 0 from the caller. */
2154 =for apidoc sv_2iv_flags
2156 Return the integer value of an SV, doing any necessary string
2157 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2158 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2164 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2169 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2170 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2171 cache IVs just in case. In practice it seems that they never
2172 actually anywhere accessible by user Perl code, let alone get used
2173 in anything other than a string context. */
2174 if (flags & SV_GMAGIC)
2179 return I_V(SvNVX(sv));
2181 if (SvPOKp(sv) && SvLEN(sv)) {
2184 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2186 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2187 == IS_NUMBER_IN_UV) {
2188 /* It's definitely an integer */
2189 if (numtype & IS_NUMBER_NEG) {
2190 if (value < (UV)IV_MIN)
2193 if (value < (UV)IV_MAX)
2198 if (ckWARN(WARN_NUMERIC))
2201 return I_V(Atof(SvPVX_const(sv)));
2206 assert(SvTYPE(sv) >= SVt_PVMG);
2207 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2208 } else if (SvTHINKFIRST(sv)) {
2212 SV * const tmpstr=AMG_CALLun(sv,numer);
2213 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2214 return SvIV(tmpstr);
2217 return PTR2IV(SvRV(sv));
2220 sv_force_normal_flags(sv, 0);
2222 if (SvREADONLY(sv) && !SvOK(sv)) {
2223 if (ckWARN(WARN_UNINITIALIZED))
2229 if (S_sv_2iuv_common(aTHX_ sv))
2232 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2233 PTR2UV(sv),SvIVX(sv)));
2234 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2238 =for apidoc sv_2uv_flags
2240 Return the unsigned integer value of an SV, doing any necessary string
2241 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2242 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2248 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2253 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2254 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2255 cache IVs just in case. */
2256 if (flags & SV_GMAGIC)
2261 return U_V(SvNVX(sv));
2262 if (SvPOKp(sv) && SvLEN(sv)) {
2265 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2267 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2268 == IS_NUMBER_IN_UV) {
2269 /* It's definitely an integer */
2270 if (!(numtype & IS_NUMBER_NEG))
2274 if (ckWARN(WARN_NUMERIC))
2277 return U_V(Atof(SvPVX_const(sv)));
2282 assert(SvTYPE(sv) >= SVt_PVMG);
2283 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2284 } else if (SvTHINKFIRST(sv)) {
2288 SV *const tmpstr = AMG_CALLun(sv,numer);
2289 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2290 return SvUV(tmpstr);
2293 return PTR2UV(SvRV(sv));
2296 sv_force_normal_flags(sv, 0);
2298 if (SvREADONLY(sv) && !SvOK(sv)) {
2299 if (ckWARN(WARN_UNINITIALIZED))
2305 if (S_sv_2iuv_common(aTHX_ sv))
2309 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2310 PTR2UV(sv),SvUVX(sv)));
2311 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2317 Return the num value of an SV, doing any necessary string or integer
2318 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2325 Perl_sv_2nv(pTHX_ register SV *sv)
2330 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2331 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2332 cache IVs just in case. */
2336 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2337 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2338 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2340 return Atof(SvPVX_const(sv));
2344 return (NV)SvUVX(sv);
2346 return (NV)SvIVX(sv);
2351 assert(SvTYPE(sv) >= SVt_PVMG);
2352 /* This falls through to the report_uninit near the end of the
2354 } else if (SvTHINKFIRST(sv)) {
2358 SV *const tmpstr = AMG_CALLun(sv,numer);
2359 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2360 return SvNV(tmpstr);
2363 return PTR2NV(SvRV(sv));
2366 sv_force_normal_flags(sv, 0);
2368 if (SvREADONLY(sv) && !SvOK(sv)) {
2369 if (ckWARN(WARN_UNINITIALIZED))
2374 if (SvTYPE(sv) < SVt_NV) {
2375 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2376 sv_upgrade(sv, SVt_NV);
2377 #ifdef USE_LONG_DOUBLE
2379 STORE_NUMERIC_LOCAL_SET_STANDARD();
2380 PerlIO_printf(Perl_debug_log,
2381 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2382 PTR2UV(sv), SvNVX(sv));
2383 RESTORE_NUMERIC_LOCAL();
2387 STORE_NUMERIC_LOCAL_SET_STANDARD();
2388 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2389 PTR2UV(sv), SvNVX(sv));
2390 RESTORE_NUMERIC_LOCAL();
2394 else if (SvTYPE(sv) < SVt_PVNV)
2395 sv_upgrade(sv, SVt_PVNV);
2400 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2401 #ifdef NV_PRESERVES_UV
2404 /* Only set the public NV OK flag if this NV preserves the IV */
2405 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2406 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2407 : (SvIVX(sv) == I_V(SvNVX(sv))))
2413 else if (SvPOKp(sv) && SvLEN(sv)) {
2415 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2416 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2418 #ifdef NV_PRESERVES_UV
2419 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2420 == IS_NUMBER_IN_UV) {
2421 /* It's definitely an integer */
2422 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2424 SvNV_set(sv, Atof(SvPVX_const(sv)));
2427 SvNV_set(sv, Atof(SvPVX_const(sv)));
2428 /* Only set the public NV OK flag if this NV preserves the value in
2429 the PV at least as well as an IV/UV would.
2430 Not sure how to do this 100% reliably. */
2431 /* if that shift count is out of range then Configure's test is
2432 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2434 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2435 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2436 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2437 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2438 /* Can't use strtol etc to convert this string, so don't try.
2439 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2442 /* value has been set. It may not be precise. */
2443 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2444 /* 2s complement assumption for (UV)IV_MIN */
2445 SvNOK_on(sv); /* Integer is too negative. */
2450 if (numtype & IS_NUMBER_NEG) {
2451 SvIV_set(sv, -(IV)value);
2452 } else if (value <= (UV)IV_MAX) {
2453 SvIV_set(sv, (IV)value);
2455 SvUV_set(sv, value);
2459 if (numtype & IS_NUMBER_NOT_INT) {
2460 /* I believe that even if the original PV had decimals,
2461 they are lost beyond the limit of the FP precision.
2462 However, neither is canonical, so both only get p
2463 flags. NWC, 2000/11/25 */
2464 /* Both already have p flags, so do nothing */
2466 const NV nv = SvNVX(sv);
2467 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2468 if (SvIVX(sv) == I_V(nv)) {
2471 /* It had no "." so it must be integer. */
2475 /* between IV_MAX and NV(UV_MAX).
2476 Could be slightly > UV_MAX */
2478 if (numtype & IS_NUMBER_NOT_INT) {
2479 /* UV and NV both imprecise. */
2481 const UV nv_as_uv = U_V(nv);
2483 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2492 #endif /* NV_PRESERVES_UV */
2495 if (isGV_with_GP(sv)) {
2496 glob_2number((GV *)sv);
2500 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2502 assert (SvTYPE(sv) >= SVt_NV);
2503 /* Typically the caller expects that sv_any is not NULL now. */
2504 /* XXX Ilya implies that this is a bug in callers that assume this
2505 and ideally should be fixed. */
2508 #if defined(USE_LONG_DOUBLE)
2510 STORE_NUMERIC_LOCAL_SET_STANDARD();
2511 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2512 PTR2UV(sv), SvNVX(sv));
2513 RESTORE_NUMERIC_LOCAL();
2517 STORE_NUMERIC_LOCAL_SET_STANDARD();
2518 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2519 PTR2UV(sv), SvNVX(sv));
2520 RESTORE_NUMERIC_LOCAL();
2526 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2527 * UV as a string towards the end of buf, and return pointers to start and
2530 * We assume that buf is at least TYPE_CHARS(UV) long.
2534 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2536 char *ptr = buf + TYPE_CHARS(UV);
2537 char * const ebuf = ptr;
2550 *--ptr = '0' + (char)(uv % 10);
2559 =for apidoc sv_2pv_flags
2561 Returns a pointer to the string value of an SV, and sets *lp to its length.
2562 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2564 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2565 usually end up here too.
2571 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2581 if (SvGMAGICAL(sv)) {
2582 if (flags & SV_GMAGIC)
2587 if (flags & SV_MUTABLE_RETURN)
2588 return SvPVX_mutable(sv);
2589 if (flags & SV_CONST_RETURN)
2590 return (char *)SvPVX_const(sv);
2593 if (SvIOKp(sv) || SvNOKp(sv)) {
2594 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2599 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2600 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2602 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2609 #ifdef FIXNEGATIVEZERO
2610 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2616 SvUPGRADE(sv, SVt_PV);
2619 s = SvGROW_mutable(sv, len + 1);
2622 return (char*)memcpy(s, tbuf, len + 1);
2628 assert(SvTYPE(sv) >= SVt_PVMG);
2629 /* This falls through to the report_uninit near the end of the
2631 } else if (SvTHINKFIRST(sv)) {
2635 SV *const tmpstr = AMG_CALLun(sv,string);
2636 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2638 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2642 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2643 if (flags & SV_CONST_RETURN) {
2644 pv = (char *) SvPVX_const(tmpstr);
2646 pv = (flags & SV_MUTABLE_RETURN)
2647 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2650 *lp = SvCUR(tmpstr);
2652 pv = sv_2pv_flags(tmpstr, lp, flags);
2666 const SV *const referent = (SV*)SvRV(sv);
2670 retval = buffer = savepvn("NULLREF", len);
2671 } else if (SvTYPE(referent) == SVt_PVMG
2672 && ((SvFLAGS(referent) &
2673 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2674 == (SVs_OBJECT|SVs_SMG))
2675 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2680 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2685 PL_reginterp_cnt += haseval;
2688 const char *const typestr = sv_reftype(referent, 0);
2689 const STRLEN typelen = strlen(typestr);
2690 UV addr = PTR2UV(referent);
2691 const char *stashname = NULL;
2692 STRLEN stashnamelen = 0; /* hush, gcc */
2693 const char *buffer_end;
2695 if (SvOBJECT(referent)) {
2696 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2699 stashname = HEK_KEY(name);
2700 stashnamelen = HEK_LEN(name);
2702 if (HEK_UTF8(name)) {
2708 stashname = "__ANON__";
2711 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2712 + 2 * sizeof(UV) + 2 /* )\0 */;
2714 len = typelen + 3 /* (0x */
2715 + 2 * sizeof(UV) + 2 /* )\0 */;
2718 Newx(buffer, len, char);
2719 buffer_end = retval = buffer + len;
2721 /* Working backwards */
2725 *--retval = PL_hexdigit[addr & 15];
2726 } while (addr >>= 4);
2732 memcpy(retval, typestr, typelen);
2736 retval -= stashnamelen;
2737 memcpy(retval, stashname, stashnamelen);
2739 /* retval may not neccesarily have reached the start of the
2741 assert (retval >= buffer);
2743 len = buffer_end - retval - 1; /* -1 for that \0 */
2751 if (SvREADONLY(sv) && !SvOK(sv)) {
2752 if (ckWARN(WARN_UNINITIALIZED))
2759 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2760 /* I'm assuming that if both IV and NV are equally valid then
2761 converting the IV is going to be more efficient */
2762 const U32 isUIOK = SvIsUV(sv);
2763 char buf[TYPE_CHARS(UV)];
2766 if (SvTYPE(sv) < SVt_PVIV)
2767 sv_upgrade(sv, SVt_PVIV);
2768 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2769 /* inlined from sv_setpvn */
2770 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2771 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2772 SvCUR_set(sv, ebuf - ptr);
2776 else if (SvNOKp(sv)) {
2777 const int olderrno = errno;
2778 if (SvTYPE(sv) < SVt_PVNV)
2779 sv_upgrade(sv, SVt_PVNV);
2780 /* The +20 is pure guesswork. Configure test needed. --jhi */
2781 s = SvGROW_mutable(sv, NV_DIG + 20);
2782 /* some Xenix systems wipe out errno here */
2784 if (SvNVX(sv) == 0.0)
2785 my_strlcpy(s, "0", SvLEN(sv));
2789 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2792 #ifdef FIXNEGATIVEZERO
2793 if (*s == '-' && s[1] == '0' && !s[2])
2794 my_strlcpy(s, "0", SvLEN(s));
2803 if (isGV_with_GP(sv))
2804 return glob_2pv((GV *)sv, lp);
2806 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2810 if (SvTYPE(sv) < SVt_PV)
2811 /* Typically the caller expects that sv_any is not NULL now. */
2812 sv_upgrade(sv, SVt_PV);
2816 const STRLEN len = s - SvPVX_const(sv);
2822 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2823 PTR2UV(sv),SvPVX_const(sv)));
2824 if (flags & SV_CONST_RETURN)
2825 return (char *)SvPVX_const(sv);
2826 if (flags & SV_MUTABLE_RETURN)
2827 return SvPVX_mutable(sv);
2832 =for apidoc sv_copypv
2834 Copies a stringified representation of the source SV into the
2835 destination SV. Automatically performs any necessary mg_get and
2836 coercion of numeric values into strings. Guaranteed to preserve
2837 UTF-8 flag even from overloaded objects. Similar in nature to
2838 sv_2pv[_flags] but operates directly on an SV instead of just the
2839 string. Mostly uses sv_2pv_flags to do its work, except when that
2840 would lose the UTF-8'ness of the PV.
2846 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2849 const char * const s = SvPV_const(ssv,len);
2850 sv_setpvn(dsv,s,len);
2858 =for apidoc sv_2pvbyte
2860 Return a pointer to the byte-encoded representation of the SV, and set *lp
2861 to its length. May cause the SV to be downgraded from UTF-8 as a
2864 Usually accessed via the C<SvPVbyte> macro.
2870 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2872 sv_utf8_downgrade(sv,0);
2873 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2877 =for apidoc sv_2pvutf8
2879 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2880 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2882 Usually accessed via the C<SvPVutf8> macro.
2888 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2890 sv_utf8_upgrade(sv);
2891 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2896 =for apidoc sv_2bool
2898 This function is only called on magical items, and is only used by
2899 sv_true() or its macro equivalent.
2905 Perl_sv_2bool(pTHX_ register SV *sv)
2914 SV * const tmpsv = AMG_CALLun(sv,bool_);
2915 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2916 return (bool)SvTRUE(tmpsv);
2918 return SvRV(sv) != 0;
2921 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2923 (*sv->sv_u.svu_pv > '0' ||
2924 Xpvtmp->xpv_cur > 1 ||
2925 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2932 return SvIVX(sv) != 0;
2935 return SvNVX(sv) != 0.0;
2937 if (isGV_with_GP(sv))
2947 =for apidoc sv_utf8_upgrade
2949 Converts the PV of an SV to its UTF-8-encoded form.
2950 Forces the SV to string form if it is not already.
2951 Always sets the SvUTF8 flag to avoid future validity checks even
2952 if all the bytes have hibit clear.
2954 This is not as a general purpose byte encoding to Unicode interface:
2955 use the Encode extension for that.
2957 =for apidoc sv_utf8_upgrade_flags
2959 Converts the PV of an SV to its UTF-8-encoded form.
2960 Forces the SV to string form if it is not already.
2961 Always sets the SvUTF8 flag to avoid future validity checks even
2962 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2963 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2964 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2966 This is not as a general purpose byte encoding to Unicode interface:
2967 use the Encode extension for that.
2973 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2976 if (sv == &PL_sv_undef)
2980 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2981 (void) sv_2pv_flags(sv,&len, flags);
2985 (void) SvPV_force(sv,len);
2994 sv_force_normal_flags(sv, 0);
2997 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2998 sv_recode_to_utf8(sv, PL_encoding);
2999 else { /* Assume Latin-1/EBCDIC */
3000 /* This function could be much more efficient if we
3001 * had a FLAG in SVs to signal if there are any hibit
3002 * chars in the PV. Given that there isn't such a flag
3003 * make the loop as fast as possible. */
3004 const U8 * const s = (U8 *) SvPVX_const(sv);
3005 const U8 * const e = (U8 *) SvEND(sv);
3010 /* Check for hi bit */
3011 if (!NATIVE_IS_INVARIANT(ch)) {
3012 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3013 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3015 SvPV_free(sv); /* No longer using what was there before. */
3016 SvPV_set(sv, (char*)recoded);
3017 SvCUR_set(sv, len - 1);
3018 SvLEN_set(sv, len); /* No longer know the real size. */
3022 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3029 =for apidoc sv_utf8_downgrade
3031 Attempts to convert the PV of an SV from characters to bytes.
3032 If the PV contains a character beyond byte, this conversion will fail;
3033 in this case, either returns false or, if C<fail_ok> is not
3036 This is not as a general purpose Unicode to byte encoding interface:
3037 use the Encode extension for that.
3043 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3046 if (SvPOKp(sv) && SvUTF8(sv)) {
3052 sv_force_normal_flags(sv, 0);
3054 s = (U8 *) SvPV(sv, len);
3055 if (!utf8_to_bytes(s, &len)) {
3060 Perl_croak(aTHX_ "Wide character in %s",
3063 Perl_croak(aTHX_ "Wide character");
3074 =for apidoc sv_utf8_encode
3076 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3077 flag off so that it looks like octets again.
3083 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3086 sv_force_normal_flags(sv, 0);
3088 if (SvREADONLY(sv)) {
3089 Perl_croak(aTHX_ PL_no_modify);
3091 (void) sv_utf8_upgrade(sv);
3096 =for apidoc sv_utf8_decode
3098 If the PV of the SV is an octet sequence in UTF-8
3099 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3100 so that it looks like a character. If the PV contains only single-byte
3101 characters, the C<SvUTF8> flag stays being off.
3102 Scans PV for validity and returns false if the PV is invalid UTF-8.
3108 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3114 /* The octets may have got themselves encoded - get them back as
3117 if (!sv_utf8_downgrade(sv, TRUE))
3120 /* it is actually just a matter of turning the utf8 flag on, but
3121 * we want to make sure everything inside is valid utf8 first.
3123 c = (const U8 *) SvPVX_const(sv);
3124 if (!is_utf8_string(c, SvCUR(sv)+1))
3126 e = (const U8 *) SvEND(sv);
3129 if (!UTF8_IS_INVARIANT(ch)) {
3139 =for apidoc sv_setsv
3141 Copies the contents of the source SV C<ssv> into the destination SV
3142 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3143 function if the source SV needs to be reused. Does not handle 'set' magic.
3144 Loosely speaking, it performs a copy-by-value, obliterating any previous
3145 content of the destination.
3147 You probably want to use one of the assortment of wrappers, such as
3148 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3149 C<SvSetMagicSV_nosteal>.
3151 =for apidoc sv_setsv_flags
3153 Copies the contents of the source SV C<ssv> into the destination SV
3154 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3155 function if the source SV needs to be reused. Does not handle 'set' magic.
3156 Loosely speaking, it performs a copy-by-value, obliterating any previous
3157 content of the destination.
3158 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3159 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3160 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3161 and C<sv_setsv_nomg> are implemented in terms of this function.
3163 You probably want to use one of the assortment of wrappers, such as
3164 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3165 C<SvSetMagicSV_nosteal>.
3167 This is the primary function for copying scalars, and most other
3168 copy-ish functions and macros use this underneath.
3174 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3176 if (dtype != SVt_PVGV) {
3177 const char * const name = GvNAME(sstr);
3178 const STRLEN len = GvNAMELEN(sstr);
3180 if (dtype >= SVt_PV) {
3186 SvUPGRADE(dstr, SVt_PVGV);
3187 (void)SvOK_off(dstr);
3188 /* FIXME - why are we doing this, then turning it off and on again
3190 isGV_with_GP_on(dstr);
3192 GvSTASH(dstr) = GvSTASH(sstr);
3194 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3195 gv_name_set((GV *)dstr, name, len, GV_ADD);
3196 SvFAKE_on(dstr); /* can coerce to non-glob */
3199 #ifdef GV_UNIQUE_CHECK
3200 if (GvUNIQUE((GV*)dstr)) {
3201 Perl_croak(aTHX_ PL_no_modify);
3206 isGV_with_GP_off(dstr);
3207 (void)SvOK_off(dstr);
3208 isGV_with_GP_on(dstr);
3209 GvINTRO_off(dstr); /* one-shot flag */
3210 GvGP(dstr) = gp_ref(GvGP(sstr));
3211 if (SvTAINTED(sstr))
3213 if (GvIMPORTED(dstr) != GVf_IMPORTED
3214 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3216 GvIMPORTED_on(dstr);
3223 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3224 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3226 const int intro = GvINTRO(dstr);
3229 const U32 stype = SvTYPE(sref);
3232 #ifdef GV_UNIQUE_CHECK
3233 if (GvUNIQUE((GV*)dstr)) {
3234 Perl_croak(aTHX_ PL_no_modify);
3239 GvINTRO_off(dstr); /* one-shot flag */
3240 GvLINE(dstr) = CopLINE(PL_curcop);
3241 GvEGV(dstr) = (GV*)dstr;
3246 location = (SV **) &GvCV(dstr);
3247 import_flag = GVf_IMPORTED_CV;
3250 location = (SV **) &GvHV(dstr);
3251 import_flag = GVf_IMPORTED_HV;
3254 location = (SV **) &GvAV(dstr);
3255 import_flag = GVf_IMPORTED_AV;
3258 location = (SV **) &GvIOp(dstr);
3261 location = (SV **) &GvFORM(dstr);
3263 location = &GvSV(dstr);
3264 import_flag = GVf_IMPORTED_SV;
3267 if (stype == SVt_PVCV) {
3268 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3269 SvREFCNT_dec(GvCV(dstr));
3271 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3272 PL_sub_generation++;
3275 SAVEGENERICSV(*location);
3279 if (stype == SVt_PVCV && *location != sref) {
3280 CV* const cv = (CV*)*location;
3282 if (!GvCVGEN((GV*)dstr) &&
3283 (CvROOT(cv) || CvXSUB(cv)))
3285 /* Redefining a sub - warning is mandatory if
3286 it was a const and its value changed. */
3287 if (CvCONST(cv) && CvCONST((CV*)sref)
3288 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3290 /* They are 2 constant subroutines generated from
3291 the same constant. This probably means that
3292 they are really the "same" proxy subroutine
3293 instantiated in 2 places. Most likely this is
3294 when a constant is exported twice. Don't warn.
3297 else if (ckWARN(WARN_REDEFINE)
3299 && (!CvCONST((CV*)sref)
3300 || sv_cmp(cv_const_sv(cv),
3301 cv_const_sv((CV*)sref))))) {
3302 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3305 ? "Constant subroutine %s::%s redefined"
3306 : "Subroutine %s::%s redefined"),
3307 HvNAME_get(GvSTASH((GV*)dstr)),
3308 GvENAME((GV*)dstr));
3312 cv_ckproto_len(cv, (GV*)dstr,
3313 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3314 SvPOK(sref) ? SvCUR(sref) : 0);
3316 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3317 GvASSUMECV_on(dstr);
3318 PL_sub_generation++;
3321 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3322 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3323 GvFLAGS(dstr) |= import_flag;
3328 if (SvTAINTED(sstr))
3334 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3337 register U32 sflags;
3339 register svtype stype;
3344 if (SvIS_FREED(dstr)) {
3345 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3346 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3348 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3350 sstr = &PL_sv_undef;
3351 if (SvIS_FREED(sstr)) {
3352 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3353 (void*)sstr, (void*)dstr);
3355 stype = SvTYPE(sstr);
3356 dtype = SvTYPE(dstr);
3361 /* need to nuke the magic */
3363 SvRMAGICAL_off(dstr);
3366 /* There's a lot of redundancy below but we're going for speed here */
3371 if (dtype != SVt_PVGV) {
3372 (void)SvOK_off(dstr);
3380 sv_upgrade(dstr, SVt_IV);
3385 sv_upgrade(dstr, SVt_PVIV);
3388 goto end_of_first_switch;
3390 (void)SvIOK_only(dstr);
3391 SvIV_set(dstr, SvIVX(sstr));
3394 /* SvTAINTED can only be true if the SV has taint magic, which in
3395 turn means that the SV type is PVMG (or greater). This is the
3396 case statement for SVt_IV, so this cannot be true (whatever gcov
3398 assert(!SvTAINTED(sstr));
3408 sv_upgrade(dstr, SVt_NV);
3413 sv_upgrade(dstr, SVt_PVNV);
3416 goto end_of_first_switch;
3418 SvNV_set(dstr, SvNVX(sstr));
3419 (void)SvNOK_only(dstr);
3420 /* SvTAINTED can only be true if the SV has taint magic, which in
3421 turn means that the SV type is PVMG (or greater). This is the
3422 case statement for SVt_NV, so this cannot be true (whatever gcov
3424 assert(!SvTAINTED(sstr));
3431 sv_upgrade(dstr, SVt_RV);
3434 #ifdef PERL_OLD_COPY_ON_WRITE
3435 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3436 if (dtype < SVt_PVIV)
3437 sv_upgrade(dstr, SVt_PVIV);
3444 sv_upgrade(dstr, SVt_PV);
3447 if (dtype < SVt_PVIV)
3448 sv_upgrade(dstr, SVt_PVIV);
3451 if (dtype < SVt_PVNV)
3452 sv_upgrade(dstr, SVt_PVNV);
3456 const char * const type = sv_reftype(sstr,0);
3458 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3460 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3464 /* case SVt_BIND: */
3467 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3468 glob_assign_glob(dstr, sstr, dtype);
3471 /* SvVALID means that this PVGV is playing at being an FBM. */
3475 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3477 if (SvTYPE(sstr) != stype) {
3478 stype = SvTYPE(sstr);
3479 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3480 glob_assign_glob(dstr, sstr, dtype);
3485 if (stype == SVt_PVLV)
3486 SvUPGRADE(dstr, SVt_PVNV);
3488 SvUPGRADE(dstr, (svtype)stype);
3490 end_of_first_switch:
3492 /* dstr may have been upgraded. */
3493 dtype = SvTYPE(dstr);
3494 sflags = SvFLAGS(sstr);
3496 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3497 /* Assigning to a subroutine sets the prototype. */
3500 const char *const ptr = SvPV_const(sstr, len);
3502 SvGROW(dstr, len + 1);
3503 Copy(ptr, SvPVX(dstr), len + 1, char);
3504 SvCUR_set(dstr, len);
3506 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3510 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3511 const char * const type = sv_reftype(dstr,0);
3513 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3515 Perl_croak(aTHX_ "Cannot copy to %s", type);
3516 } else if (sflags & SVf_ROK) {
3517 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3518 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3521 if (GvIMPORTED(dstr) != GVf_IMPORTED
3522 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3524 GvIMPORTED_on(dstr);
3529 glob_assign_glob(dstr, sstr, dtype);
3533 if (dtype >= SVt_PV) {
3534 if (dtype == SVt_PVGV) {
3535 glob_assign_ref(dstr, sstr);
3538 if (SvPVX_const(dstr)) {
3544 (void)SvOK_off(dstr);
3545 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3546 SvFLAGS(dstr) |= sflags & SVf_ROK;
3547 assert(!(sflags & SVp_NOK));
3548 assert(!(sflags & SVp_IOK));
3549 assert(!(sflags & SVf_NOK));
3550 assert(!(sflags & SVf_IOK));
3552 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3553 if (!(sflags & SVf_OK)) {
3554 if (ckWARN(WARN_MISC))
3555 Perl_warner(aTHX_ packWARN(WARN_MISC),
3556 "Undefined value assigned to typeglob");
3559 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3560 if (dstr != (SV*)gv) {
3563 GvGP(dstr) = gp_ref(GvGP(gv));
3567 else if (sflags & SVp_POK) {
3571 * Check to see if we can just swipe the string. If so, it's a
3572 * possible small lose on short strings, but a big win on long ones.
3573 * It might even be a win on short strings if SvPVX_const(dstr)
3574 * has to be allocated and SvPVX_const(sstr) has to be freed.
3575 * Likewise if we can set up COW rather than doing an actual copy, we
3576 * drop to the else clause, as the swipe code and the COW setup code
3577 * have much in common.
3580 /* Whichever path we take through the next code, we want this true,
3581 and doing it now facilitates the COW check. */
3582 (void)SvPOK_only(dstr);
3585 /* If we're already COW then this clause is not true, and if COW
3586 is allowed then we drop down to the else and make dest COW
3587 with us. If caller hasn't said that we're allowed to COW
3588 shared hash keys then we don't do the COW setup, even if the
3589 source scalar is a shared hash key scalar. */
3590 (((flags & SV_COW_SHARED_HASH_KEYS)
3591 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3592 : 1 /* If making a COW copy is forbidden then the behaviour we
3593 desire is as if the source SV isn't actually already
3594 COW, even if it is. So we act as if the source flags
3595 are not COW, rather than actually testing them. */
3597 #ifndef PERL_OLD_COPY_ON_WRITE
3598 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3599 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3600 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3601 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3602 but in turn, it's somewhat dead code, never expected to go
3603 live, but more kept as a placeholder on how to do it better
3604 in a newer implementation. */
3605 /* If we are COW and dstr is a suitable target then we drop down
3606 into the else and make dest a COW of us. */
3607 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3612 (sflags & SVs_TEMP) && /* slated for free anyway? */
3613 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3614 (!(flags & SV_NOSTEAL)) &&
3615 /* and we're allowed to steal temps */
3616 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3617 SvLEN(sstr) && /* and really is a string */
3618 /* and won't be needed again, potentially */
3619 !(PL_op && PL_op->op_type == OP_AASSIGN))
3620 #ifdef PERL_OLD_COPY_ON_WRITE
3621 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3622 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3623 && SvTYPE(sstr) >= SVt_PVIV)
3626 /* Failed the swipe test, and it's not a shared hash key either.
3627 Have to copy the string. */
3628 STRLEN len = SvCUR(sstr);
3629 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3630 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3631 SvCUR_set(dstr, len);
3632 *SvEND(dstr) = '\0';
3634 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3636 /* Either it's a shared hash key, or it's suitable for
3637 copy-on-write or we can swipe the string. */
3639 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3643 #ifdef PERL_OLD_COPY_ON_WRITE
3645 /* I believe I should acquire a global SV mutex if
3646 it's a COW sv (not a shared hash key) to stop
3647 it going un copy-on-write.
3648 If the source SV has gone un copy on write between up there
3649 and down here, then (assert() that) it is of the correct
3650 form to make it copy on write again */
3651 if ((sflags & (SVf_FAKE | SVf_READONLY))
3652 != (SVf_FAKE | SVf_READONLY)) {
3653 SvREADONLY_on(sstr);
3655 /* Make the source SV into a loop of 1.
3656 (about to become 2) */
3657 SV_COW_NEXT_SV_SET(sstr, sstr);
3661 /* Initial code is common. */
3662 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3667 /* making another shared SV. */
3668 STRLEN cur = SvCUR(sstr);
3669 STRLEN len = SvLEN(sstr);
3670 #ifdef PERL_OLD_COPY_ON_WRITE
3672 assert (SvTYPE(dstr) >= SVt_PVIV);
3673 /* SvIsCOW_normal */
3674 /* splice us in between source and next-after-source. */
3675 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3676 SV_COW_NEXT_SV_SET(sstr, dstr);
3677 SvPV_set(dstr, SvPVX_mutable(sstr));
3681 /* SvIsCOW_shared_hash */
3682 DEBUG_C(PerlIO_printf(Perl_debug_log,
3683 "Copy on write: Sharing hash\n"));
3685 assert (SvTYPE(dstr) >= SVt_PV);
3687 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3689 SvLEN_set(dstr, len);
3690 SvCUR_set(dstr, cur);
3691 SvREADONLY_on(dstr);
3693 /* Relesase a global SV mutex. */
3696 { /* Passes the swipe test. */
3697 SvPV_set(dstr, SvPVX_mutable(sstr));
3698 SvLEN_set(dstr, SvLEN(sstr));
3699 SvCUR_set(dstr, SvCUR(sstr));
3702 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3703 SvPV_set(sstr, NULL);
3709 if (sflags & SVp_NOK) {
3710 SvNV_set(dstr, SvNVX(sstr));
3712 if (sflags & SVp_IOK) {
3714 SvIV_set(dstr, SvIVX(sstr));
3715 /* Must do this otherwise some other overloaded use of 0x80000000
3716 gets confused. I guess SVpbm_VALID */
3717 if (sflags & SVf_IVisUV)
3720 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3722 const MAGIC * const smg = SvVSTRING_mg(sstr);
3724 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3725 smg->mg_ptr, smg->mg_len);
3726 SvRMAGICAL_on(dstr);
3730 else if (sflags & (SVp_IOK|SVp_NOK)) {
3731 (void)SvOK_off(dstr);
3732 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3733 if (sflags & SVp_IOK) {
3734 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3735 SvIV_set(dstr, SvIVX(sstr));
3737 if (sflags & SVp_NOK) {
3738 SvNV_set(dstr, SvNVX(sstr));
3742 if (isGV_with_GP(sstr)) {
3743 /* This stringification rule for globs is spread in 3 places.
3744 This feels bad. FIXME. */
3745 const U32 wasfake = sflags & SVf_FAKE;
3747 /* FAKE globs can get coerced, so need to turn this off
3748 temporarily if it is on. */
3750 gv_efullname3(dstr, (GV *)sstr, "*");
3751 SvFLAGS(sstr) |= wasfake;
3754 (void)SvOK_off(dstr);
3756 if (SvTAINTED(sstr))
3761 =for apidoc sv_setsv_mg
3763 Like C<sv_setsv>, but also handles 'set' magic.
3769 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3771 sv_setsv(dstr,sstr);
3775 #ifdef PERL_OLD_COPY_ON_WRITE
3777 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3779 STRLEN cur = SvCUR(sstr);
3780 STRLEN len = SvLEN(sstr);
3781 register char *new_pv;
3784 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3785 (void*)sstr, (void*)dstr);
3792 if (SvTHINKFIRST(dstr))
3793 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3794 else if (SvPVX_const(dstr))
3795 Safefree(SvPVX_const(dstr));
3799 SvUPGRADE(dstr, SVt_PVIV);
3801 assert (SvPOK(sstr));
3802 assert (SvPOKp(sstr));
3803 assert (!SvIOK(sstr));
3804 assert (!SvIOKp(sstr));
3805 assert (!SvNOK(sstr));
3806 assert (!SvNOKp(sstr));
3808 if (SvIsCOW(sstr)) {
3810 if (SvLEN(sstr) == 0) {
3811 /* source is a COW shared hash key. */
3812 DEBUG_C(PerlIO_printf(Perl_debug_log,
3813 "Fast copy on write: Sharing hash\n"));
3814 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3817 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3819 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3820 SvUPGRADE(sstr, SVt_PVIV);
3821 SvREADONLY_on(sstr);
3823 DEBUG_C(PerlIO_printf(Perl_debug_log,
3824 "Fast copy on write: Converting sstr to COW\n"));
3825 SV_COW_NEXT_SV_SET(dstr, sstr);
3827 SV_COW_NEXT_SV_SET(sstr, dstr);
3828 new_pv = SvPVX_mutable(sstr);
3831 SvPV_set(dstr, new_pv);
3832 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3835 SvLEN_set(dstr, len);
3836 SvCUR_set(dstr, cur);
3845 =for apidoc sv_setpvn
3847 Copies a string into an SV. The C<len> parameter indicates the number of
3848 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3849 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3855 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3858 register char *dptr;
3860 SV_CHECK_THINKFIRST_COW_DROP(sv);
3866 /* len is STRLEN which is unsigned, need to copy to signed */
3869 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3871 SvUPGRADE(sv, SVt_PV);
3873 dptr = SvGROW(sv, len + 1);
3874 Move(ptr,dptr,len,char);
3877 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3882 =for apidoc sv_setpvn_mg
3884 Like C<sv_setpvn>, but also handles 'set' magic.
3890 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3892 sv_setpvn(sv,ptr,len);
3897 =for apidoc sv_setpv
3899 Copies a string into an SV. The string must be null-terminated. Does not
3900 handle 'set' magic. See C<sv_setpv_mg>.
3906 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3909 register STRLEN len;
3911 SV_CHECK_THINKFIRST_COW_DROP(sv);
3917 SvUPGRADE(sv, SVt_PV);
3919 SvGROW(sv, len + 1);
3920 Move(ptr,SvPVX(sv),len+1,char);
3922 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3927 =for apidoc sv_setpv_mg
3929 Like C<sv_setpv>, but also handles 'set' magic.
3935 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3942 =for apidoc sv_usepvn_flags
3944 Tells an SV to use C<ptr> to find its string value. Normally the
3945 string is stored inside the SV but sv_usepvn allows the SV to use an
3946 outside string. The C<ptr> should point to memory that was allocated
3947 by C<malloc>. The string length, C<len>, must be supplied. By default
3948 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3949 so that pointer should not be freed or used by the programmer after
3950 giving it to sv_usepvn, and neither should any pointers from "behind"
3951 that pointer (e.g. ptr + 1) be used.
3953 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3954 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3955 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3956 C<len>, and already meets the requirements for storing in C<SvPVX>)
3962 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3966 SV_CHECK_THINKFIRST_COW_DROP(sv);
3967 SvUPGRADE(sv, SVt_PV);
3970 if (flags & SV_SMAGIC)
3974 if (SvPVX_const(sv))
3978 if (flags & SV_HAS_TRAILING_NUL)
3979 assert(ptr[len] == '\0');
3982 allocate = (flags & SV_HAS_TRAILING_NUL)
3983 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3984 if (flags & SV_HAS_TRAILING_NUL) {
3985 /* It's long enough - do nothing.
3986 Specfically Perl_newCONSTSUB is relying on this. */
3989 /* Force a move to shake out bugs in callers. */
3990 char *new_ptr = (char*)safemalloc(allocate);
3991 Copy(ptr, new_ptr, len, char);
3992 PoisonFree(ptr,len,char);
3996 ptr = (char*) saferealloc (ptr, allocate);
4001 SvLEN_set(sv, allocate);
4002 if (!(flags & SV_HAS_TRAILING_NUL)) {
4005 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4007 if (flags & SV_SMAGIC)
4011 #ifdef PERL_OLD_COPY_ON_WRITE
4012 /* Need to do this *after* making the SV normal, as we need the buffer
4013 pointer to remain valid until after we've copied it. If we let go too early,
4014 another thread could invalidate it by unsharing last of the same hash key
4015 (which it can do by means other than releasing copy-on-write Svs)
4016 or by changing the other copy-on-write SVs in the loop. */
4018 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4020 { /* this SV was SvIsCOW_normal(sv) */
4021 /* we need to find the SV pointing to us. */
4022 SV *current = SV_COW_NEXT_SV(after);
4024 if (current == sv) {
4025 /* The SV we point to points back to us (there were only two of us
4027 Hence other SV is no longer copy on write either. */
4029 SvREADONLY_off(after);
4031 /* We need to follow the pointers around the loop. */
4033 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4036 /* don't loop forever if the structure is bust, and we have
4037 a pointer into a closed loop. */
4038 assert (current != after);
4039 assert (SvPVX_const(current) == pvx);
4041 /* Make the SV before us point to the SV after us. */
4042 SV_COW_NEXT_SV_SET(current, after);
4048 =for apidoc sv_force_normal_flags
4050 Undo various types of fakery on an SV: if the PV is a shared string, make
4051 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4052 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4053 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4054 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4055 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4056 set to some other value.) In addition, the C<flags> parameter gets passed to
4057 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4058 with flags set to 0.
4064 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4067 #ifdef PERL_OLD_COPY_ON_WRITE
4068 if (SvREADONLY(sv)) {
4069 /* At this point I believe I should acquire a global SV mutex. */
4071 const char * const pvx = SvPVX_const(sv);
4072 const STRLEN len = SvLEN(sv);
4073 const STRLEN cur = SvCUR(sv);
4074 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4075 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4076 we'll fail an assertion. */
4077 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4080 PerlIO_printf(Perl_debug_log,
4081 "Copy on write: Force normal %ld\n",
4087 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4090 if (flags & SV_COW_DROP_PV) {
4091 /* OK, so we don't need to copy our buffer. */
4094 SvGROW(sv, cur + 1);
4095 Move(pvx,SvPVX(sv),cur,char);
4100 sv_release_COW(sv, pvx, next);
4102 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4108 else if (IN_PERL_RUNTIME)
4109 Perl_croak(aTHX_ PL_no_modify);
4110 /* At this point I believe that I can drop the global SV mutex. */
4113 if (SvREADONLY(sv)) {
4115 const char * const pvx = SvPVX_const(sv);
4116 const STRLEN len = SvCUR(sv);
4121 SvGROW(sv, len + 1);
4122 Move(pvx,SvPVX(sv),len,char);
4124 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4126 else if (IN_PERL_RUNTIME)
4127 Perl_croak(aTHX_ PL_no_modify);
4131 sv_unref_flags(sv, flags);
4132 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4139 Efficient removal of characters from the beginning of the string buffer.
4140 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4141 the string buffer. The C<ptr> becomes the first character of the adjusted
4142 string. Uses the "OOK hack".
4143 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4144 refer to the same chunk of data.
4150 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4152 register STRLEN delta;
4153 if (!ptr || !SvPOKp(sv))
4155 delta = ptr - SvPVX_const(sv);
4156 SV_CHECK_THINKFIRST(sv);
4157 if (SvTYPE(sv) < SVt_PVIV)
4158 sv_upgrade(sv,SVt_PVIV);
4161 if (!SvLEN(sv)) { /* make copy of shared string */
4162 const char *pvx = SvPVX_const(sv);
4163 const STRLEN len = SvCUR(sv);
4164 SvGROW(sv, len + 1);
4165 Move(pvx,SvPVX(sv),len,char);
4169 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4170 and we do that anyway inside the SvNIOK_off
4172 SvFLAGS(sv) |= SVf_OOK;
4175 SvLEN_set(sv, SvLEN(sv) - delta);
4176 SvCUR_set(sv, SvCUR(sv) - delta);
4177 SvPV_set(sv, SvPVX(sv) + delta);
4178 SvIV_set(sv, SvIVX(sv) + delta);
4182 =for apidoc sv_catpvn
4184 Concatenates the string onto the end of the string which is in the SV. The
4185 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4186 status set, then the bytes appended should be valid UTF-8.
4187 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4189 =for apidoc sv_catpvn_flags
4191 Concatenates the string onto the end of the string which is in the SV. The
4192 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4193 status set, then the bytes appended should be valid UTF-8.
4194 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4195 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4196 in terms of this function.
4202 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4206 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4208 SvGROW(dsv, dlen + slen + 1);
4210 sstr = SvPVX_const(dsv);
4211 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4212 SvCUR_set(dsv, SvCUR(dsv) + slen);
4214 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4216 if (flags & SV_SMAGIC)
4221 =for apidoc sv_catsv
4223 Concatenates the string from SV C<ssv> onto the end of the string in
4224 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4225 not 'set' magic. See C<sv_catsv_mg>.
4227 =for apidoc sv_catsv_flags
4229 Concatenates the string from SV C<ssv> onto the end of the string in
4230 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4231 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4232 and C<sv_catsv_nomg> are implemented in terms of this function.
4237 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4242 const char *spv = SvPV_const(ssv, slen);
4244 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4245 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4246 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4247 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4248 dsv->sv_flags doesn't have that bit set.
4249 Andy Dougherty 12 Oct 2001
4251 const I32 sutf8 = DO_UTF8(ssv);
4254 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4256 dutf8 = DO_UTF8(dsv);
4258 if (dutf8 != sutf8) {
4260 /* Not modifying source SV, so taking a temporary copy. */
4261 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4263 sv_utf8_upgrade(csv);
4264 spv = SvPV_const(csv, slen);
4267 sv_utf8_upgrade_nomg(dsv);
4269 sv_catpvn_nomg(dsv, spv, slen);
4272 if (flags & SV_SMAGIC)
4277 =for apidoc sv_catpv
4279 Concatenates the string onto the end of the string which is in the SV.
4280 If the SV has the UTF-8 status set, then the bytes appended should be
4281 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4286 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4289 register STRLEN len;
4295 junk = SvPV_force(sv, tlen);
4297 SvGROW(sv, tlen + len + 1);
4299 ptr = SvPVX_const(sv);
4300 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4301 SvCUR_set(sv, SvCUR(sv) + len);
4302 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4307 =for apidoc sv_catpv_mg
4309 Like C<sv_catpv>, but also handles 'set' magic.
4315 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4324 Creates a new SV. A non-zero C<len> parameter indicates the number of
4325 bytes of preallocated string space the SV should have. An extra byte for a
4326 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4327 space is allocated.) The reference count for the new SV is set to 1.
4329 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4330 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4331 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4332 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4333 modules supporting older perls.
4339 Perl_newSV(pTHX_ STRLEN len)
4346 sv_upgrade(sv, SVt_PV);
4347 SvGROW(sv, len + 1);
4352 =for apidoc sv_magicext
4354 Adds magic to an SV, upgrading it if necessary. Applies the
4355 supplied vtable and returns a pointer to the magic added.
4357 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4358 In particular, you can add magic to SvREADONLY SVs, and add more than
4359 one instance of the same 'how'.
4361 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4362 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4363 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4364 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4366 (This is now used as a subroutine by C<sv_magic>.)
4371 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4372 const char* name, I32 namlen)
4377 if (SvTYPE(sv) < SVt_PVMG) {
4378 SvUPGRADE(sv, SVt_PVMG);
4380 Newxz(mg, 1, MAGIC);
4381 mg->mg_moremagic = SvMAGIC(sv);
4382 SvMAGIC_set(sv, mg);
4384 /* Sometimes a magic contains a reference loop, where the sv and
4385 object refer to each other. To prevent a reference loop that
4386 would prevent such objects being freed, we look for such loops
4387 and if we find one we avoid incrementing the object refcount.
4389 Note we cannot do this to avoid self-tie loops as intervening RV must
4390 have its REFCNT incremented to keep it in existence.
4393 if (!obj || obj == sv ||
4394 how == PERL_MAGIC_arylen ||
4395 how == PERL_MAGIC_qr ||
4396 how == PERL_MAGIC_symtab ||
4397 (SvTYPE(obj) == SVt_PVGV &&
4398 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4399 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4400 GvFORM(obj) == (CV*)sv)))
4405 mg->mg_obj = SvREFCNT_inc_simple(obj);
4406 mg->mg_flags |= MGf_REFCOUNTED;
4409 /* Normal self-ties simply pass a null object, and instead of
4410 using mg_obj directly, use the SvTIED_obj macro to produce a
4411 new RV as needed. For glob "self-ties", we are tieing the PVIO
4412 with an RV obj pointing to the glob containing the PVIO. In
4413 this case, to avoid a reference loop, we need to weaken the
4417 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4418 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4424 mg->mg_len = namlen;
4427 mg->mg_ptr = savepvn(name, namlen);
4428 else if (namlen == HEf_SVKEY)
4429 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4431 mg->mg_ptr = (char *) name;
4433 mg->mg_virtual = (MGVTBL *) vtable;
4437 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4442 =for apidoc sv_magic
4444 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4445 then adds a new magic item of type C<how> to the head of the magic list.
4447 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4448 handling of the C<name> and C<namlen> arguments.
4450 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4451 to add more than one instance of the same 'how'.
4457 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4460 const MGVTBL *vtable;
4463 #ifdef PERL_OLD_COPY_ON_WRITE
4465 sv_force_normal_flags(sv, 0);
4467 if (SvREADONLY(sv)) {
4469 /* its okay to attach magic to shared strings; the subsequent
4470 * upgrade to PVMG will unshare the string */
4471 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4474 && how != PERL_MAGIC_regex_global
4475 && how != PERL_MAGIC_bm
4476 && how != PERL_MAGIC_fm
4477 && how != PERL_MAGIC_sv
4478 && how != PERL_MAGIC_backref
4481 Perl_croak(aTHX_ PL_no_modify);
4484 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4485 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4486 /* sv_magic() refuses to add a magic of the same 'how' as an
4489 if (how == PERL_MAGIC_taint) {
4491 /* Any scalar which already had taint magic on which someone
4492 (erroneously?) did SvIOK_on() or similar will now be
4493 incorrectly sporting public "OK" flags. */
4494 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4502 vtable = &PL_vtbl_sv;
4504 case PERL_MAGIC_overload:
4505 vtable = &PL_vtbl_amagic;
4507 case PERL_MAGIC_overload_elem:
4508 vtable = &PL_vtbl_amagicelem;
4510 case PERL_MAGIC_overload_table:
4511 vtable = &PL_vtbl_ovrld;
4514 vtable = &PL_vtbl_bm;
4516 case PERL_MAGIC_regdata:
4517 vtable = &PL_vtbl_regdata;
4519 case PERL_MAGIC_regdatum:
4520 vtable = &PL_vtbl_regdatum;
4522 case PERL_MAGIC_env:
4523 vtable = &PL_vtbl_env;
4526 vtable = &PL_vtbl_fm;
4528 case PERL_MAGIC_envelem:
4529 vtable = &PL_vtbl_envelem;
4531 case PERL_MAGIC_regex_global:
4532 vtable = &PL_vtbl_mglob;
4534 case PERL_MAGIC_isa:
4535 vtable = &PL_vtbl_isa;
4537 case PERL_MAGIC_isaelem:
4538 vtable = &PL_vtbl_isaelem;
4540 case PERL_MAGIC_nkeys:
4541 vtable = &PL_vtbl_nkeys;
4543 case PERL_MAGIC_dbfile:
4546 case PERL_MAGIC_dbline:
4547 vtable = &PL_vtbl_dbline;
4549 #ifdef USE_LOCALE_COLLATE
4550 case PERL_MAGIC_collxfrm:
4551 vtable = &PL_vtbl_collxfrm;
4553 #endif /* USE_LOCALE_COLLATE */
4554 case PERL_MAGIC_tied:
4555 vtable = &PL_vtbl_pack;
4557 case PERL_MAGIC_tiedelem:
4558 case PERL_MAGIC_tiedscalar:
4559 vtable = &PL_vtbl_packelem;
4562 vtable = &PL_vtbl_regexp;
4564 case PERL_MAGIC_hints:
4565 /* As this vtable is all NULL, we can reuse it. */
4566 case PERL_MAGIC_sig:
4567 vtable = &PL_vtbl_sig;
4569 case PERL_MAGIC_sigelem:
4570 vtable = &PL_vtbl_sigelem;
4572 case PERL_MAGIC_taint:
4573 vtable = &PL_vtbl_taint;
4575 case PERL_MAGIC_uvar:
4576 vtable = &PL_vtbl_uvar;
4578 case PERL_MAGIC_vec:
4579 vtable = &PL_vtbl_vec;
4581 case PERL_MAGIC_arylen_p:
4582 case PERL_MAGIC_rhash:
4583 case PERL_MAGIC_symtab:
4584 case PERL_MAGIC_vstring:
4587 case PERL_MAGIC_utf8:
4588 vtable = &PL_vtbl_utf8;
4590 case PERL_MAGIC_substr:
4591 vtable = &PL_vtbl_substr;
4593 case PERL_MAGIC_defelem:
4594 vtable = &PL_vtbl_defelem;
4596 case PERL_MAGIC_arylen:
4597 vtable = &PL_vtbl_arylen;
4599 case PERL_MAGIC_pos:
4600 vtable = &PL_vtbl_pos;
4602 case PERL_MAGIC_backref:
4603 vtable = &PL_vtbl_backref;
4605 case PERL_MAGIC_hintselem:
4606 vtable = &PL_vtbl_hintselem;
4608 case PERL_MAGIC_ext:
4609 /* Reserved for use by extensions not perl internals. */
4610 /* Useful for attaching extension internal data to perl vars. */
4611 /* Note that multiple extensions may clash if magical scalars */
4612 /* etc holding private data from one are passed to another. */
4616 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4619 /* Rest of work is done else where */
4620 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4623 case PERL_MAGIC_taint:
4626 case PERL_MAGIC_ext:
4627 case PERL_MAGIC_dbfile:
4634 =for apidoc sv_unmagic
4636 Removes all magic of type C<type> from an SV.
4642 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4646 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4648 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4649 for (mg = *mgp; mg; mg = *mgp) {
4650 if (mg->mg_type == type) {
4651 const MGVTBL* const vtbl = mg->mg_virtual;
4652 *mgp = mg->mg_moremagic;
4653 if (vtbl && vtbl->svt_free)
4654 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4655 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4657 Safefree(mg->mg_ptr);
4658 else if (mg->mg_len == HEf_SVKEY)
4659 SvREFCNT_dec((SV*)mg->mg_ptr);
4660 else if (mg->mg_type == PERL_MAGIC_utf8)
4661 Safefree(mg->mg_ptr);
4663 if (mg->mg_flags & MGf_REFCOUNTED)
4664 SvREFCNT_dec(mg->mg_obj);
4668 mgp = &mg->mg_moremagic;
4672 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4673 SvMAGIC_set(sv, NULL);
4680 =for apidoc sv_rvweaken
4682 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4683 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4684 push a back-reference to this RV onto the array of backreferences
4685 associated with that magic. If the RV is magical, set magic will be
4686 called after the RV is cleared.
4692 Perl_sv_rvweaken(pTHX_ SV *sv)
4695 if (!SvOK(sv)) /* let undefs pass */
4698 Perl_croak(aTHX_ "Can't weaken a nonreference");
4699 else if (SvWEAKREF(sv)) {
4700 if (ckWARN(WARN_MISC))
4701 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4705 Perl_sv_add_backref(aTHX_ tsv, sv);
4711 /* Give tsv backref magic if it hasn't already got it, then push a
4712 * back-reference to sv onto the array associated with the backref magic.
4716 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4721 if (SvTYPE(tsv) == SVt_PVHV) {
4722 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4726 /* There is no AV in the offical place - try a fixup. */
4727 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4730 /* Aha. They've got it stowed in magic. Bring it back. */
4731 av = (AV*)mg->mg_obj;
4732 /* Stop mg_free decreasing the refernce count. */
4734 /* Stop mg_free even calling the destructor, given that
4735 there's no AV to free up. */
4737 sv_unmagic(tsv, PERL_MAGIC_backref);
4741 SvREFCNT_inc_simple_void(av);
4746 const MAGIC *const mg
4747 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4749 av = (AV*)mg->mg_obj;
4753 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4754 /* av now has a refcnt of 2, which avoids it getting freed
4755 * before us during global cleanup. The extra ref is removed
4756 * by magic_killbackrefs() when tsv is being freed */
4759 if (AvFILLp(av) >= AvMAX(av)) {
4760 av_extend(av, AvFILLp(av)+1);
4762 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4765 /* delete a back-reference to ourselves from the backref magic associated
4766 * with the SV we point to.
4770 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4777 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4778 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4779 /* We mustn't attempt to "fix up" the hash here by moving the
4780 backreference array back to the hv_aux structure, as that is stored
4781 in the main HvARRAY(), and hfreentries assumes that no-one
4782 reallocates HvARRAY() while it is running. */
4785 const MAGIC *const mg
4786 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4788 av = (AV *)mg->mg_obj;
4791 if (PL_in_clean_all)
4793 Perl_croak(aTHX_ "panic: del_backref");
4800 /* We shouldn't be in here more than once, but for paranoia reasons lets
4802 for (i = AvFILLp(av); i >= 0; i--) {
4804 const SSize_t fill = AvFILLp(av);
4806 /* We weren't the last entry.
4807 An unordered list has this property that you can take the
4808 last element off the end to fill the hole, and it's still
4809 an unordered list :-)
4814 AvFILLp(av) = fill - 1;
4820 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4822 SV **svp = AvARRAY(av);
4824 PERL_UNUSED_ARG(sv);
4826 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4827 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4828 if (svp && !SvIS_FREED(av)) {
4829 SV *const *const last = svp + AvFILLp(av);
4831 while (svp <= last) {
4833 SV *const referrer = *svp;
4834 if (SvWEAKREF(referrer)) {
4835 /* XXX Should we check that it hasn't changed? */
4836 SvRV_set(referrer, 0);
4838 SvWEAKREF_off(referrer);
4839 SvSETMAGIC(referrer);
4840 } else if (SvTYPE(referrer) == SVt_PVGV ||
4841 SvTYPE(referrer) == SVt_PVLV) {
4842 /* You lookin' at me? */
4843 assert(GvSTASH(referrer));
4844 assert(GvSTASH(referrer) == (HV*)sv);
4845 GvSTASH(referrer) = 0;
4848 "panic: magic_killbackrefs (flags=%"UVxf")",
4849 (UV)SvFLAGS(referrer));
4857 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4862 =for apidoc sv_insert
4864 Inserts a string at the specified offset/length within the SV. Similar to
4865 the Perl substr() function.
4871 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4876 register char *midend;
4877 register char *bigend;
4883 Perl_croak(aTHX_ "Can't modify non-existent substring");
4884 SvPV_force(bigstr, curlen);
4885 (void)SvPOK_only_UTF8(bigstr);
4886 if (offset + len > curlen) {
4887 SvGROW(bigstr, offset+len+1);
4888 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4889 SvCUR_set(bigstr, offset+len);
4893 i = littlelen - len;
4894 if (i > 0) { /* string might grow */
4895 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4896 mid = big + offset + len;
4897 midend = bigend = big + SvCUR(bigstr);
4900 while (midend > mid) /* shove everything down */
4901 *--bigend = *--midend;
4902 Move(little,big+offset,littlelen,char);
4903 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4908 Move(little,SvPVX(bigstr)+offset,len,char);
4913 big = SvPVX(bigstr);
4916 bigend = big + SvCUR(bigstr);
4918 if (midend > bigend)
4919 Perl_croak(aTHX_ "panic: sv_insert");
4921 if (mid - big > bigend - midend) { /* faster to shorten from end */
4923 Move(little, mid, littlelen,char);
4926 i = bigend - midend;
4928 Move(midend, mid, i,char);
4932 SvCUR_set(bigstr, mid - big);
4934 else if ((i = mid - big)) { /* faster from front */
4935 midend -= littlelen;
4937 sv_chop(bigstr,midend-i);
4942 Move(little, mid, littlelen,char);
4944 else if (littlelen) {
4945 midend -= littlelen;
4946 sv_chop(bigstr,midend);
4947 Move(little,midend,littlelen,char);
4950 sv_chop(bigstr,midend);
4956 =for apidoc sv_replace
4958 Make the first argument a copy of the second, then delete the original.
4959 The target SV physically takes over ownership of the body of the source SV
4960 and inherits its flags; however, the target keeps any magic it owns,
4961 and any magic in the source is discarded.
4962 Note that this is a rather specialist SV copying operation; most of the
4963 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4969 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4972 const U32 refcnt = SvREFCNT(sv);
4973 SV_CHECK_THINKFIRST_COW_DROP(sv);
4974 if (SvREFCNT(nsv) != 1) {
4975 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4976 UVuf " != 1)", (UV) SvREFCNT(nsv));
4978 if (SvMAGICAL(sv)) {
4982 sv_upgrade(nsv, SVt_PVMG);
4983 SvMAGIC_set(nsv, SvMAGIC(sv));
4984 SvFLAGS(nsv) |= SvMAGICAL(sv);
4986 SvMAGIC_set(sv, NULL);
4990 assert(!SvREFCNT(sv));
4991 #ifdef DEBUG_LEAKING_SCALARS
4992 sv->sv_flags = nsv->sv_flags;
4993 sv->sv_any = nsv->sv_any;
4994 sv->sv_refcnt = nsv->sv_refcnt;
4995 sv->sv_u = nsv->sv_u;
4997 StructCopy(nsv,sv,SV);
4999 /* Currently could join these into one piece of pointer arithmetic, but
5000 it would be unclear. */
5001 if(SvTYPE(sv) == SVt_IV)
5003 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5004 else if (SvTYPE(sv) == SVt_RV) {
5005 SvANY(sv) = &sv->sv_u.svu_rv;
5009 #ifdef PERL_OLD_COPY_ON_WRITE
5010 if (SvIsCOW_normal(nsv)) {
5011 /* We need to follow the pointers around the loop to make the
5012 previous SV point to sv, rather than nsv. */
5015 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5018 assert(SvPVX_const(current) == SvPVX_const(nsv));
5020 /* Make the SV before us point to the SV after us. */
5022 PerlIO_printf(Perl_debug_log, "previous is\n");
5024 PerlIO_printf(Perl_debug_log,
5025 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5026 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5028 SV_COW_NEXT_SV_SET(current, sv);
5031 SvREFCNT(sv) = refcnt;
5032 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5038 =for apidoc sv_clear
5040 Clear an SV: call any destructors, free up any memory used by the body,
5041 and free the body itself. The SV's head is I<not> freed, although
5042 its type is set to all 1's so that it won't inadvertently be assumed
5043 to be live during global destruction etc.
5044 This function should only be called when REFCNT is zero. Most of the time
5045 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5052 Perl_sv_clear(pTHX_ register SV *sv)
5055 const U32 type = SvTYPE(sv);
5056 const struct body_details *const sv_type_details
5057 = bodies_by_type + type;
5060 assert(SvREFCNT(sv) == 0);
5062 if (type <= SVt_IV) {
5063 /* See the comment in sv.h about the collusion between this early
5064 return and the overloading of the NULL and IV slots in the size
5070 if (PL_defstash) { /* Still have a symbol table? */
5075 stash = SvSTASH(sv);
5076 destructor = StashHANDLER(stash,DESTROY);
5078 SV* const tmpref = newRV(sv);
5079 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5081 PUSHSTACKi(PERLSI_DESTROY);
5086 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5092 if(SvREFCNT(tmpref) < 2) {
5093 /* tmpref is not kept alive! */
5095 SvRV_set(tmpref, NULL);
5098 SvREFCNT_dec(tmpref);
5100 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5104 if (PL_in_clean_objs)
5105 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5107 /* DESTROY gave object new lease on life */
5113 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5114 SvOBJECT_off(sv); /* Curse the object. */
5115 if (type != SVt_PVIO)
5116 --PL_sv_objcount; /* XXX Might want something more general */
5119 if (type >= SVt_PVMG) {
5120 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5121 SvREFCNT_dec(SvOURSTASH(sv));
5122 } else if (SvMAGIC(sv))
5124 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5125 SvREFCNT_dec(SvSTASH(sv));
5128 /* case SVt_BIND: */
5131 IoIFP(sv) != PerlIO_stdin() &&
5132 IoIFP(sv) != PerlIO_stdout() &&
5133 IoIFP(sv) != PerlIO_stderr())
5135 io_close((IO*)sv, FALSE);
5137 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5138 PerlDir_close(IoDIRP(sv));
5139 IoDIRP(sv) = (DIR*)NULL;
5140 Safefree(IoTOP_NAME(sv));
5141 Safefree(IoFMT_NAME(sv));
5142 Safefree(IoBOTTOM_NAME(sv));
5149 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5156 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5157 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5158 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5159 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5161 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5162 SvREFCNT_dec(LvTARG(sv));
5164 if (isGV_with_GP(sv)) {
5167 unshare_hek(GvNAME_HEK(sv));
5168 /* If we're in a stash, we don't own a reference to it. However it does
5169 have a back reference to us, which needs to be cleared. */
5170 if (!SvVALID(sv) && GvSTASH(sv))
5171 sv_del_backref((SV*)GvSTASH(sv), sv);
5177 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5179 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5180 /* Don't even bother with turning off the OOK flag. */
5185 SV * const target = SvRV(sv);
5187 sv_del_backref(target, sv);
5189 SvREFCNT_dec(target);
5191 #ifdef PERL_OLD_COPY_ON_WRITE
5192 else if (SvPVX_const(sv)) {
5194 /* I believe I need to grab the global SV mutex here and
5195 then recheck the COW status. */
5197 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5201 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5203 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5206 /* And drop it here. */
5208 } else if (SvLEN(sv)) {
5209 Safefree(SvPVX_const(sv));
5213 else if (SvPVX_const(sv) && SvLEN(sv))
5214 Safefree(SvPVX_mutable(sv));
5215 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5216 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5225 SvFLAGS(sv) &= SVf_BREAK;
5226 SvFLAGS(sv) |= SVTYPEMASK;
5228 if (sv_type_details->arena) {
5229 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5230 &PL_body_roots[type]);
5232 else if (sv_type_details->body_size) {
5233 my_safefree(SvANY(sv));
5238 =for apidoc sv_newref
5240 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5247 Perl_sv_newref(pTHX_ SV *sv)
5249 PERL_UNUSED_CONTEXT;
5258 Decrement an SV's reference count, and if it drops to zero, call
5259 C<sv_clear> to invoke destructors and free up any memory used by
5260 the body; finally, deallocate the SV's head itself.
5261 Normally called via a wrapper macro C<SvREFCNT_dec>.
5267 Perl_sv_free(pTHX_ SV *sv)
5272 if (SvREFCNT(sv) == 0) {
5273 if (SvFLAGS(sv) & SVf_BREAK)
5274 /* this SV's refcnt has been artificially decremented to
5275 * trigger cleanup */
5277 if (PL_in_clean_all) /* All is fair */
5279 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5280 /* make sure SvREFCNT(sv)==0 happens very seldom */
5281 SvREFCNT(sv) = (~(U32)0)/2;
5284 if (ckWARN_d(WARN_INTERNAL)) {
5285 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5286 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5287 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5288 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5289 Perl_dump_sv_child(aTHX_ sv);
5294 if (--(SvREFCNT(sv)) > 0)
5296 Perl_sv_free2(aTHX_ sv);
5300 Perl_sv_free2(pTHX_ SV *sv)
5305 if (ckWARN_d(WARN_DEBUGGING))
5306 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5307 "Attempt to free temp prematurely: SV 0x%"UVxf
5308 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5312 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5313 /* make sure SvREFCNT(sv)==0 happens very seldom */
5314 SvREFCNT(sv) = (~(U32)0)/2;
5325 Returns the length of the string in the SV. Handles magic and type
5326 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5332 Perl_sv_len(pTHX_ register SV *sv)
5340 len = mg_length(sv);
5342 (void)SvPV_const(sv, len);
5347 =for apidoc sv_len_utf8
5349 Returns the number of characters in the string in an SV, counting wide
5350 UTF-8 bytes as a single character. Handles magic and type coercion.
5356 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5357 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5358 * (Note that the mg_len is not the length of the mg_ptr field.
5359 * This allows the cache to store the character length of the string without
5360 * needing to malloc() extra storage to attach to the mg_ptr.)
5365 Perl_sv_len_utf8(pTHX_ register SV *sv)
5371 return mg_length(sv);
5375 const U8 *s = (U8*)SvPV_const(sv, len);
5379 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5381 if (mg && mg->mg_len != -1) {
5383 if (PL_utf8cache < 0) {
5384 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5386 /* Need to turn the assertions off otherwise we may
5387 recurse infinitely while printing error messages.
5389 SAVEI8(PL_utf8cache);
5391 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5392 " real %"UVuf" for %"SVf,
5393 (UV) ulen, (UV) real, SVfARG(sv));
5398 ulen = Perl_utf8_length(aTHX_ s, s + len);
5399 if (!SvREADONLY(sv)) {
5401 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5402 &PL_vtbl_utf8, 0, 0);
5410 return Perl_utf8_length(aTHX_ s, s + len);
5414 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5417 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5420 const U8 *s = start;
5422 while (s < send && uoffset--)
5425 /* This is the existing behaviour. Possibly it should be a croak, as
5426 it's actually a bounds error */
5432 /* Given the length of the string in both bytes and UTF-8 characters, decide
5433 whether to walk forwards or backwards to find the byte corresponding to
5434 the passed in UTF-8 offset. */
5436 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5437 STRLEN uoffset, STRLEN uend)
5439 STRLEN backw = uend - uoffset;
5440 if (uoffset < 2 * backw) {
5441 /* The assumption is that going forwards is twice the speed of going
5442 forward (that's where the 2 * backw comes from).
5443 (The real figure of course depends on the UTF-8 data.) */
5444 return sv_pos_u2b_forwards(start, send, uoffset);
5449 while (UTF8_IS_CONTINUATION(*send))
5452 return send - start;
5455 /* For the string representation of the given scalar, find the byte
5456 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5457 give another position in the string, *before* the sought offset, which
5458 (which is always true, as 0, 0 is a valid pair of positions), which should
5459 help reduce the amount of linear searching.
5460 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5461 will be used to reduce the amount of linear searching. The cache will be
5462 created if necessary, and the found value offered to it for update. */
5464 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5465 const U8 *const send, STRLEN uoffset,
5466 STRLEN uoffset0, STRLEN boffset0) {
5467 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5470 assert (uoffset >= uoffset0);
5472 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5473 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5474 if ((*mgp)->mg_ptr) {
5475 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5476 if (cache[0] == uoffset) {
5477 /* An exact match. */
5480 if (cache[2] == uoffset) {
5481 /* An exact match. */
5485 if (cache[0] < uoffset) {
5486 /* The cache already knows part of the way. */
5487 if (cache[0] > uoffset0) {
5488 /* The cache knows more than the passed in pair */
5489 uoffset0 = cache[0];
5490 boffset0 = cache[1];
5492 if ((*mgp)->mg_len != -1) {
5493 /* And we know the end too. */
5495 + sv_pos_u2b_midway(start + boffset0, send,
5497 (*mgp)->mg_len - uoffset0);
5500 + sv_pos_u2b_forwards(start + boffset0,
5501 send, uoffset - uoffset0);
5504 else if (cache[2] < uoffset) {
5505 /* We're between the two cache entries. */
5506 if (cache[2] > uoffset0) {
5507 /* and the cache knows more than the passed in pair */
5508 uoffset0 = cache[2];
5509 boffset0 = cache[3];
5513 + sv_pos_u2b_midway(start + boffset0,
5516 cache[0] - uoffset0);
5519 + sv_pos_u2b_midway(start + boffset0,
5522 cache[2] - uoffset0);
5526 else if ((*mgp)->mg_len != -1) {
5527 /* If we can take advantage of a passed in offset, do so. */
5528 /* In fact, offset0 is either 0, or less than offset, so don't
5529 need to worry about the other possibility. */
5531 + sv_pos_u2b_midway(start + boffset0, send,
5533 (*mgp)->mg_len - uoffset0);
5538 if (!found || PL_utf8cache < 0) {
5539 const STRLEN real_boffset
5540 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5541 send, uoffset - uoffset0);
5543 if (found && PL_utf8cache < 0) {
5544 if (real_boffset != boffset) {
5545 /* Need to turn the assertions off otherwise we may recurse
5546 infinitely while printing error messages. */
5547 SAVEI8(PL_utf8cache);
5549 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5550 " real %"UVuf" for %"SVf,
5551 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5554 boffset = real_boffset;
5557 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5563 =for apidoc sv_pos_u2b
5565 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5566 the start of the string, to a count of the equivalent number of bytes; if
5567 lenp is non-zero, it does the same to lenp, but this time starting from
5568 the offset, rather than from the start of the string. Handles magic and
5575 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5576 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5577 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5582 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5590 start = (U8*)SvPV_const(sv, len);
5592 STRLEN uoffset = (STRLEN) *offsetp;
5593 const U8 * const send = start + len;
5595 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5598 *offsetp = (I32) boffset;
5601 /* Convert the relative offset to absolute. */
5602 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5603 const STRLEN boffset2
5604 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5605 uoffset, boffset) - boffset;
5619 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5620 byte length pairing. The (byte) length of the total SV is passed in too,
5621 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5622 may not have updated SvCUR, so we can't rely on reading it directly.
5624 The proffered utf8/byte length pairing isn't used if the cache already has
5625 two pairs, and swapping either for the proffered pair would increase the
5626 RMS of the intervals between known byte offsets.
5628 The cache itself consists of 4 STRLEN values
5629 0: larger UTF-8 offset
5630 1: corresponding byte offset
5631 2: smaller UTF-8 offset
5632 3: corresponding byte offset
5634 Unused cache pairs have the value 0, 0.
5635 Keeping the cache "backwards" means that the invariant of
5636 cache[0] >= cache[2] is maintained even with empty slots, which means that
5637 the code that uses it doesn't need to worry if only 1 entry has actually
5638 been set to non-zero. It also makes the "position beyond the end of the
5639 cache" logic much simpler, as the first slot is always the one to start
5643 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5651 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5653 (*mgp)->mg_len = -1;
5657 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5658 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5659 (*mgp)->mg_ptr = (char *) cache;
5663 if (PL_utf8cache < 0) {
5664 const U8 *start = (const U8 *) SvPVX_const(sv);
5665 const STRLEN realutf8 = utf8_length(start, start + byte);
5667 if (realutf8 != utf8) {
5668 /* Need to turn the assertions off otherwise we may recurse
5669 infinitely while printing error messages. */
5670 SAVEI8(PL_utf8cache);
5672 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5673 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5677 /* Cache is held with the later position first, to simplify the code
5678 that deals with unbounded ends. */
5680 ASSERT_UTF8_CACHE(cache);
5681 if (cache[1] == 0) {
5682 /* Cache is totally empty */
5685 } else if (cache[3] == 0) {
5686 if (byte > cache[1]) {
5687 /* New one is larger, so goes first. */
5688 cache[2] = cache[0];
5689 cache[3] = cache[1];
5697 #define THREEWAY_SQUARE(a,b,c,d) \
5698 ((float)((d) - (c))) * ((float)((d) - (c))) \
5699 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5700 + ((float)((b) - (a))) * ((float)((b) - (a)))
5702 /* Cache has 2 slots in use, and we know three potential pairs.
5703 Keep the two that give the lowest RMS distance. Do the
5704 calcualation in bytes simply because we always know the byte
5705 length. squareroot has the same ordering as the positive value,
5706 so don't bother with the actual square root. */
5707 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5708 if (byte > cache[1]) {
5709 /* New position is after the existing pair of pairs. */
5710 const float keep_earlier
5711 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5712 const float keep_later
5713 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5715 if (keep_later < keep_earlier) {
5716 if (keep_later < existing) {
5717 cache[2] = cache[0];
5718 cache[3] = cache[1];
5724 if (keep_earlier < existing) {
5730 else if (byte > cache[3]) {
5731 /* New position is between the existing pair of pairs. */
5732 const float keep_earlier
5733 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5734 const float keep_later
5735 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5737 if (keep_later < keep_earlier) {
5738 if (keep_later < existing) {
5744 if (keep_earlier < existing) {
5751 /* New position is before the existing pair of pairs. */
5752 const float keep_earlier
5753 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5754 const float keep_later
5755 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5757 if (keep_later < keep_earlier) {
5758 if (keep_later < existing) {
5764 if (keep_earlier < existing) {
5765 cache[0] = cache[2];
5766 cache[1] = cache[3];
5773 ASSERT_UTF8_CACHE(cache);
5776 /* We already know all of the way, now we may be able to walk back. The same
5777 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5778 backward is half the speed of walking forward. */
5780 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5783 const STRLEN forw = target - s;
5784 STRLEN backw = end - target;
5786 if (forw < 2 * backw) {
5787 return utf8_length(s, target);
5790 while (end > target) {
5792 while (UTF8_IS_CONTINUATION(*end)) {
5801 =for apidoc sv_pos_b2u
5803 Converts the value pointed to by offsetp from a count of bytes from the
5804 start of the string, to a count of the equivalent number of UTF-8 chars.
5805 Handles magic and type coercion.
5811 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5812 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5817 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5820 const STRLEN byte = *offsetp;
5821 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5830 s = (const U8*)SvPV_const(sv, blen);
5833 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5837 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5838 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5840 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5841 if (cache[1] == byte) {
5842 /* An exact match. */
5843 *offsetp = cache[0];
5846 if (cache[3] == byte) {
5847 /* An exact match. */
5848 *offsetp = cache[2];
5852 if (cache[1] < byte) {
5853 /* We already know part of the way. */
5854 if (mg->mg_len != -1) {
5855 /* Actually, we know the end too. */
5857 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5858 s + blen, mg->mg_len - cache[0]);
5860 len = cache[0] + utf8_length(s + cache[1], send);
5863 else if (cache[3] < byte) {
5864 /* We're between the two cached pairs, so we do the calculation
5865 offset by the byte/utf-8 positions for the earlier pair,
5866 then add the utf-8 characters from the string start to
5868 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5869 s + cache[1], cache[0] - cache[2])
5873 else { /* cache[3] > byte */
5874 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5878 ASSERT_UTF8_CACHE(cache);
5880 } else if (mg->mg_len != -1) {
5881 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5885 if (!found || PL_utf8cache < 0) {
5886 const STRLEN real_len = utf8_length(s, send);
5888 if (found && PL_utf8cache < 0) {
5889 if (len != real_len) {
5890 /* Need to turn the assertions off otherwise we may recurse
5891 infinitely while printing error messages. */
5892 SAVEI8(PL_utf8cache);
5894 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5895 " real %"UVuf" for %"SVf,
5896 (UV) len, (UV) real_len, SVfARG(sv));
5903 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5909 Returns a boolean indicating whether the strings in the two SVs are
5910 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5911 coerce its args to strings if necessary.
5917 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5926 SV* svrecode = NULL;
5933 /* if pv1 and pv2 are the same, second SvPV_const call may
5934 * invalidate pv1, so we may need to make a copy */
5935 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5936 pv1 = SvPV_const(sv1, cur1);
5937 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5938 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5940 pv1 = SvPV_const(sv1, cur1);
5948 pv2 = SvPV_const(sv2, cur2);
5950 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5951 /* Differing utf8ness.
5952 * Do not UTF8size the comparands as a side-effect. */
5955 svrecode = newSVpvn(pv2, cur2);
5956 sv_recode_to_utf8(svrecode, PL_encoding);
5957 pv2 = SvPV_const(svrecode, cur2);
5960 svrecode = newSVpvn(pv1, cur1);
5961 sv_recode_to_utf8(svrecode, PL_encoding);
5962 pv1 = SvPV_const(svrecode, cur1);
5964 /* Now both are in UTF-8. */
5966 SvREFCNT_dec(svrecode);
5971 bool is_utf8 = TRUE;
5974 /* sv1 is the UTF-8 one,
5975 * if is equal it must be downgrade-able */
5976 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5982 /* sv2 is the UTF-8 one,
5983 * if is equal it must be downgrade-able */
5984 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5990 /* Downgrade not possible - cannot be eq */
5998 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6000 SvREFCNT_dec(svrecode);
6010 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6011 string in C<sv1> is less than, equal to, or greater than the string in
6012 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6013 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6019 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6023 const char *pv1, *pv2;
6026 SV *svrecode = NULL;
6033 pv1 = SvPV_const(sv1, cur1);
6040 pv2 = SvPV_const(sv2, cur2);
6042 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6043 /* Differing utf8ness.
6044 * Do not UTF8size the comparands as a side-effect. */
6047 svrecode = newSVpvn(pv2, cur2);
6048 sv_recode_to_utf8(svrecode, PL_encoding);
6049 pv2 = SvPV_const(svrecode, cur2);
6052 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6057 svrecode = newSVpvn(pv1, cur1);
6058 sv_recode_to_utf8(svrecode, PL_encoding);
6059 pv1 = SvPV_const(svrecode, cur1);
6062 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6068 cmp = cur2 ? -1 : 0;
6072 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6075 cmp = retval < 0 ? -1 : 1;
6076 } else if (cur1 == cur2) {
6079 cmp = cur1 < cur2 ? -1 : 1;
6083 SvREFCNT_dec(svrecode);
6091 =for apidoc sv_cmp_locale
6093 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6094 'use bytes' aware, handles get magic, and will coerce its args to strings
6095 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6101 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6104 #ifdef USE_LOCALE_COLLATE
6110 if (PL_collation_standard)
6114 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6116 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6118 if (!pv1 || !len1) {
6129 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6132 return retval < 0 ? -1 : 1;
6135 * When the result of collation is equality, that doesn't mean
6136 * that there are no differences -- some locales exclude some
6137 * characters from consideration. So to avoid false equalities,
6138 * we use the raw string as a tiebreaker.
6144 #endif /* USE_LOCALE_COLLATE */
6146 return sv_cmp(sv1, sv2);
6150 #ifdef USE_LOCALE_COLLATE
6153 =for apidoc sv_collxfrm
6155 Add Collate Transform magic to an SV if it doesn't already have it.
6157 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6158 scalar data of the variable, but transformed to such a format that a normal
6159 memory comparison can be used to compare the data according to the locale
6166 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6171 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6172 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6178 Safefree(mg->mg_ptr);
6179 s = SvPV_const(sv, len);
6180 if ((xf = mem_collxfrm(s, len, &xlen))) {
6181 if (SvREADONLY(sv)) {
6184 return xf + sizeof(PL_collation_ix);
6187 #ifdef PERL_OLD_COPY_ON_WRITE
6189 sv_force_normal_flags(sv, 0);
6191 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6205 if (mg && mg->mg_ptr) {
6207 return mg->mg_ptr + sizeof(PL_collation_ix);
6215 #endif /* USE_LOCALE_COLLATE */
6220 Get a line from the filehandle and store it into the SV, optionally
6221 appending to the currently-stored string.
6227 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6232 register STDCHAR rslast;
6233 register STDCHAR *bp;
6238 if (SvTHINKFIRST(sv))
6239 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6240 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6242 However, perlbench says it's slower, because the existing swipe code
6243 is faster than copy on write.
6244 Swings and roundabouts. */
6245 SvUPGRADE(sv, SVt_PV);
6250 if (PerlIO_isutf8(fp)) {
6252 sv_utf8_upgrade_nomg(sv);
6253 sv_pos_u2b(sv,&append,0);
6255 } else if (SvUTF8(sv)) {
6256 SV * const tsv = newSV(0);
6257 sv_gets(tsv, fp, 0);
6258 sv_utf8_upgrade_nomg(tsv);
6259 SvCUR_set(sv,append);
6262 goto return_string_or_null;
6267 if (PerlIO_isutf8(fp))
6270 if (IN_PERL_COMPILETIME) {
6271 /* we always read code in line mode */
6275 else if (RsSNARF(PL_rs)) {
6276 /* If it is a regular disk file use size from stat() as estimate
6277 of amount we are going to read -- may result in mallocing
6278 more memory than we really need if the layers below reduce
6279 the size we read (e.g. CRLF or a gzip layer).
6282 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6283 const Off_t offset = PerlIO_tell(fp);
6284 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6285 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6291 else if (RsRECORD(PL_rs)) {
6296 /* Grab the size of the record we're getting */
6297 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6298 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6301 /* VMS wants read instead of fread, because fread doesn't respect */
6302 /* RMS record boundaries. This is not necessarily a good thing to be */
6303 /* doing, but we've got no other real choice - except avoid stdio
6304 as implementation - perhaps write a :vms layer ?
6306 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6308 bytesread = PerlIO_read(fp, buffer, recsize);
6312 SvCUR_set(sv, bytesread += append);
6313 buffer[bytesread] = '\0';
6314 goto return_string_or_null;
6316 else if (RsPARA(PL_rs)) {
6322 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6323 if (PerlIO_isutf8(fp)) {
6324 rsptr = SvPVutf8(PL_rs, rslen);
6327 if (SvUTF8(PL_rs)) {
6328 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6329 Perl_croak(aTHX_ "Wide character in $/");
6332 rsptr = SvPV_const(PL_rs, rslen);
6336 rslast = rslen ? rsptr[rslen - 1] : '\0';
6338 if (rspara) { /* have to do this both before and after */
6339 do { /* to make sure file boundaries work right */
6342 i = PerlIO_getc(fp);
6346 PerlIO_ungetc(fp,i);
6352 /* See if we know enough about I/O mechanism to cheat it ! */
6354 /* This used to be #ifdef test - it is made run-time test for ease
6355 of abstracting out stdio interface. One call should be cheap
6356 enough here - and may even be a macro allowing compile
6360 if (PerlIO_fast_gets(fp)) {
6363 * We're going to steal some values from the stdio struct
6364 * and put EVERYTHING in the innermost loop into registers.
6366 register STDCHAR *ptr;
6370 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6371 /* An ungetc()d char is handled separately from the regular
6372 * buffer, so we getc() it back out and stuff it in the buffer.
6374 i = PerlIO_getc(fp);
6375 if (i == EOF) return 0;
6376 *(--((*fp)->_ptr)) = (unsigned char) i;
6380 /* Here is some breathtakingly efficient cheating */
6382 cnt = PerlIO_get_cnt(fp); /* get count into register */
6383 /* make sure we have the room */
6384 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6385 /* Not room for all of it
6386 if we are looking for a separator and room for some
6388 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6389 /* just process what we have room for */
6390 shortbuffered = cnt - SvLEN(sv) + append + 1;
6391 cnt -= shortbuffered;
6395 /* remember that cnt can be negative */
6396 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6401 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6402 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6403 DEBUG_P(PerlIO_printf(Perl_debug_log,
6404 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6405 DEBUG_P(PerlIO_printf(Perl_debug_log,
6406 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6407 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6408 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6413 while (cnt > 0) { /* this | eat */
6415 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6416 goto thats_all_folks; /* screams | sed :-) */
6420 Copy(ptr, bp, cnt, char); /* this | eat */
6421 bp += cnt; /* screams | dust */
6422 ptr += cnt; /* louder | sed :-) */
6427 if (shortbuffered) { /* oh well, must extend */
6428 cnt = shortbuffered;
6430 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6432 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6433 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6437 DEBUG_P(PerlIO_printf(Perl_debug_log,
6438 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6439 PTR2UV(ptr),(long)cnt));
6440 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6442 DEBUG_P(PerlIO_printf(Perl_debug_log,
6443 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6444 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6445 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6447 /* This used to call 'filbuf' in stdio form, but as that behaves like
6448 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6449 another abstraction. */
6450 i = PerlIO_getc(fp); /* get more characters */
6452 DEBUG_P(PerlIO_printf(Perl_debug_log,
6453 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6454 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6455 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6457 cnt = PerlIO_get_cnt(fp);
6458 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6459 DEBUG_P(PerlIO_printf(Perl_debug_log,
6460 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6462 if (i == EOF) /* all done for ever? */
6463 goto thats_really_all_folks;
6465 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6467 SvGROW(sv, bpx + cnt + 2);
6468 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6470 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6472 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6473 goto thats_all_folks;
6477 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6478 memNE((char*)bp - rslen, rsptr, rslen))
6479 goto screamer; /* go back to the fray */
6480 thats_really_all_folks:
6482 cnt += shortbuffered;
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6485 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6486 DEBUG_P(PerlIO_printf(Perl_debug_log,
6487 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6488 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6489 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6491 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6492 DEBUG_P(PerlIO_printf(Perl_debug_log,
6493 "Screamer: done, len=%ld, string=|%.*s|\n",
6494 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6498 /*The big, slow, and stupid way. */
6499 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6500 STDCHAR *buf = NULL;
6501 Newx(buf, 8192, STDCHAR);
6509 register const STDCHAR * const bpe = buf + sizeof(buf);
6511 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6512 ; /* keep reading */
6516 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6517 /* Accomodate broken VAXC compiler, which applies U8 cast to
6518 * both args of ?: operator, causing EOF to change into 255
6521 i = (U8)buf[cnt - 1];
6527 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6529 sv_catpvn(sv, (char *) buf, cnt);
6531 sv_setpvn(sv, (char *) buf, cnt);
6533 if (i != EOF && /* joy */
6535 SvCUR(sv) < rslen ||
6536 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6540 * If we're reading from a TTY and we get a short read,
6541 * indicating that the user hit his EOF character, we need
6542 * to notice it now, because if we try to read from the TTY
6543 * again, the EOF condition will disappear.
6545 * The comparison of cnt to sizeof(buf) is an optimization
6546 * that prevents unnecessary calls to feof().
6550 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6554 #ifdef USE_HEAP_INSTEAD_OF_STACK
6559 if (rspara) { /* have to do this both before and after */
6560 while (i != EOF) { /* to make sure file boundaries work right */
6561 i = PerlIO_getc(fp);
6563 PerlIO_ungetc(fp,i);
6569 return_string_or_null:
6570 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6576 Auto-increment of the value in the SV, doing string to numeric conversion
6577 if necessary. Handles 'get' magic.
6583 Perl_sv_inc(pTHX_ register SV *sv)
6592 if (SvTHINKFIRST(sv)) {
6594 sv_force_normal_flags(sv, 0);
6595 if (SvREADONLY(sv)) {
6596 if (IN_PERL_RUNTIME)
6597 Perl_croak(aTHX_ PL_no_modify);
6601 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6603 i = PTR2IV(SvRV(sv));
6608 flags = SvFLAGS(sv);
6609 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6610 /* It's (privately or publicly) a float, but not tested as an
6611 integer, so test it to see. */
6613 flags = SvFLAGS(sv);
6615 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6616 /* It's publicly an integer, or privately an integer-not-float */
6617 #ifdef PERL_PRESERVE_IVUV
6621 if (SvUVX(sv) == UV_MAX)
6622 sv_setnv(sv, UV_MAX_P1);
6624 (void)SvIOK_only_UV(sv);
6625 SvUV_set(sv, SvUVX(sv) + 1);
6627 if (SvIVX(sv) == IV_MAX)
6628 sv_setuv(sv, (UV)IV_MAX + 1);
6630 (void)SvIOK_only(sv);
6631 SvIV_set(sv, SvIVX(sv) + 1);
6636 if (flags & SVp_NOK) {
6637 (void)SvNOK_only(sv);
6638 SvNV_set(sv, SvNVX(sv) + 1.0);
6642 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6643 if ((flags & SVTYPEMASK) < SVt_PVIV)
6644 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6645 (void)SvIOK_only(sv);
6650 while (isALPHA(*d)) d++;
6651 while (isDIGIT(*d)) d++;
6653 #ifdef PERL_PRESERVE_IVUV
6654 /* Got to punt this as an integer if needs be, but we don't issue
6655 warnings. Probably ought to make the sv_iv_please() that does
6656 the conversion if possible, and silently. */
6657 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6658 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6659 /* Need to try really hard to see if it's an integer.
6660 9.22337203685478e+18 is an integer.
6661 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6662 so $a="9.22337203685478e+18"; $a+0; $a++
6663 needs to be the same as $a="9.22337203685478e+18"; $a++
6670 /* sv_2iv *should* have made this an NV */
6671 if (flags & SVp_NOK) {
6672 (void)SvNOK_only(sv);
6673 SvNV_set(sv, SvNVX(sv) + 1.0);
6676 /* I don't think we can get here. Maybe I should assert this
6677 And if we do get here I suspect that sv_setnv will croak. NWC
6679 #if defined(USE_LONG_DOUBLE)
6680 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",
6681 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6683 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6684 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6687 #endif /* PERL_PRESERVE_IVUV */
6688 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6692 while (d >= SvPVX_const(sv)) {
6700 /* MKS: The original code here died if letters weren't consecutive.
6701 * at least it didn't have to worry about non-C locales. The
6702 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6703 * arranged in order (although not consecutively) and that only
6704 * [A-Za-z] are accepted by isALPHA in the C locale.
6706 if (*d != 'z' && *d != 'Z') {
6707 do { ++*d; } while (!isALPHA(*d));
6710 *(d--) -= 'z' - 'a';
6715 *(d--) -= 'z' - 'a' + 1;
6719 /* oh,oh, the number grew */
6720 SvGROW(sv, SvCUR(sv) + 2);
6721 SvCUR_set(sv, SvCUR(sv) + 1);
6722 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6733 Auto-decrement of the value in the SV, doing string to numeric conversion
6734 if necessary. Handles 'get' magic.
6740 Perl_sv_dec(pTHX_ register SV *sv)
6748 if (SvTHINKFIRST(sv)) {
6750 sv_force_normal_flags(sv, 0);
6751 if (SvREADONLY(sv)) {
6752 if (IN_PERL_RUNTIME)
6753 Perl_croak(aTHX_ PL_no_modify);
6757 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6759 i = PTR2IV(SvRV(sv));
6764 /* Unlike sv_inc we don't have to worry about string-never-numbers
6765 and keeping them magic. But we mustn't warn on punting */
6766 flags = SvFLAGS(sv);
6767 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6768 /* It's publicly an integer, or privately an integer-not-float */
6769 #ifdef PERL_PRESERVE_IVUV
6773 if (SvUVX(sv) == 0) {
6774 (void)SvIOK_only(sv);
6778 (void)SvIOK_only_UV(sv);
6779 SvUV_set(sv, SvUVX(sv) - 1);
6782 if (SvIVX(sv) == IV_MIN)
6783 sv_setnv(sv, (NV)IV_MIN - 1.0);
6785 (void)SvIOK_only(sv);
6786 SvIV_set(sv, SvIVX(sv) - 1);
6791 if (flags & SVp_NOK) {
6792 SvNV_set(sv, SvNVX(sv) - 1.0);
6793 (void)SvNOK_only(sv);
6796 if (!(flags & SVp_POK)) {
6797 if ((flags & SVTYPEMASK) < SVt_PVIV)
6798 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6800 (void)SvIOK_only(sv);
6803 #ifdef PERL_PRESERVE_IVUV
6805 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6806 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6807 /* Need to try really hard to see if it's an integer.
6808 9.22337203685478e+18 is an integer.
6809 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6810 so $a="9.22337203685478e+18"; $a+0; $a--
6811 needs to be the same as $a="9.22337203685478e+18"; $a--
6818 /* sv_2iv *should* have made this an NV */
6819 if (flags & SVp_NOK) {
6820 (void)SvNOK_only(sv);
6821 SvNV_set(sv, SvNVX(sv) - 1.0);
6824 /* I don't think we can get here. Maybe I should assert this
6825 And if we do get here I suspect that sv_setnv will croak. NWC
6827 #if defined(USE_LONG_DOUBLE)
6828 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",
6829 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6831 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6832 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6836 #endif /* PERL_PRESERVE_IVUV */
6837 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6841 =for apidoc sv_mortalcopy
6843 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6844 The new SV is marked as mortal. It will be destroyed "soon", either by an
6845 explicit call to FREETMPS, or by an implicit call at places such as
6846 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6851 /* Make a string that will exist for the duration of the expression
6852 * evaluation. Actually, it may have to last longer than that, but
6853 * hopefully we won't free it until it has been assigned to a
6854 * permanent location. */
6857 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6863 sv_setsv(sv,oldstr);
6865 PL_tmps_stack[++PL_tmps_ix] = sv;
6871 =for apidoc sv_newmortal
6873 Creates a new null SV which is mortal. The reference count of the SV is
6874 set to 1. It will be destroyed "soon", either by an explicit call to
6875 FREETMPS, or by an implicit call at places such as statement boundaries.
6876 See also C<sv_mortalcopy> and C<sv_2mortal>.
6882 Perl_sv_newmortal(pTHX)
6888 SvFLAGS(sv) = SVs_TEMP;
6890 PL_tmps_stack[++PL_tmps_ix] = sv;
6895 =for apidoc sv_2mortal
6897 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6898 by an explicit call to FREETMPS, or by an implicit call at places such as
6899 statement boundaries. SvTEMP() is turned on which means that the SV's
6900 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6901 and C<sv_mortalcopy>.
6907 Perl_sv_2mortal(pTHX_ register SV *sv)
6912 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6915 PL_tmps_stack[++PL_tmps_ix] = sv;
6923 Creates a new SV and copies a string into it. The reference count for the
6924 SV is set to 1. If C<len> is zero, Perl will compute the length using
6925 strlen(). For efficiency, consider using C<newSVpvn> instead.
6931 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6937 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6942 =for apidoc newSVpvn
6944 Creates a new SV and copies a string into it. The reference count for the
6945 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6946 string. You are responsible for ensuring that the source string is at least
6947 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6953 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6959 sv_setpvn(sv,s,len);
6965 =for apidoc newSVhek
6967 Creates a new SV from the hash key structure. It will generate scalars that
6968 point to the shared string table where possible. Returns a new (undefined)
6969 SV if the hek is NULL.
6975 Perl_newSVhek(pTHX_ const HEK *hek)
6985 if (HEK_LEN(hek) == HEf_SVKEY) {
6986 return newSVsv(*(SV**)HEK_KEY(hek));
6988 const int flags = HEK_FLAGS(hek);
6989 if (flags & HVhek_WASUTF8) {
6991 Andreas would like keys he put in as utf8 to come back as utf8
6993 STRLEN utf8_len = HEK_LEN(hek);
6994 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6995 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6998 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7000 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7001 /* We don't have a pointer to the hv, so we have to replicate the
7002 flag into every HEK. This hv is using custom a hasing
7003 algorithm. Hence we can't return a shared string scalar, as
7004 that would contain the (wrong) hash value, and might get passed
7005 into an hv routine with a regular hash.
7006 Similarly, a hash that isn't using shared hash keys has to have
7007 the flag in every key so that we know not to try to call
7008 share_hek_kek on it. */
7010 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7015 /* This will be overwhelminly the most common case. */
7017 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7018 more efficient than sharepvn(). */
7022 sv_upgrade(sv, SVt_PV);
7023 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7024 SvCUR_set(sv, HEK_LEN(hek));
7037 =for apidoc newSVpvn_share
7039 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7040 table. If the string does not already exist in the table, it is created
7041 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7042 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7043 otherwise the hash is computed. The idea here is that as the string table
7044 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7045 hash lookup will avoid string compare.
7051 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7055 bool is_utf8 = FALSE;
7056 const char *const orig_src = src;
7059 STRLEN tmplen = -len;
7061 /* See the note in hv.c:hv_fetch() --jhi */
7062 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7066 PERL_HASH(hash, src, len);
7068 sv_upgrade(sv, SVt_PV);
7069 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7077 if (src != orig_src)
7083 #if defined(PERL_IMPLICIT_CONTEXT)
7085 /* pTHX_ magic can't cope with varargs, so this is a no-context
7086 * version of the main function, (which may itself be aliased to us).
7087 * Don't access this version directly.
7091 Perl_newSVpvf_nocontext(const char* pat, ...)
7096 va_start(args, pat);
7097 sv = vnewSVpvf(pat, &args);
7104 =for apidoc newSVpvf
7106 Creates a new SV and initializes it with the string formatted like
7113 Perl_newSVpvf(pTHX_ const char* pat, ...)
7117 va_start(args, pat);
7118 sv = vnewSVpvf(pat, &args);
7123 /* backend for newSVpvf() and newSVpvf_nocontext() */
7126 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7131 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7138 Creates a new SV and copies a floating point value into it.
7139 The reference count for the SV is set to 1.
7145 Perl_newSVnv(pTHX_ NV n)
7158 Creates a new SV and copies an integer into it. The reference count for the
7165 Perl_newSViv(pTHX_ IV i)
7178 Creates a new SV and copies an unsigned integer into it.
7179 The reference count for the SV is set to 1.
7185 Perl_newSVuv(pTHX_ UV u)
7196 =for apidoc newRV_noinc
7198 Creates an RV wrapper for an SV. The reference count for the original
7199 SV is B<not> incremented.
7205 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7211 sv_upgrade(sv, SVt_RV);
7213 SvRV_set(sv, tmpRef);
7218 /* newRV_inc is the official function name to use now.
7219 * newRV_inc is in fact #defined to newRV in sv.h
7223 Perl_newRV(pTHX_ SV *sv)
7226 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7232 Creates a new SV which is an exact duplicate of the original SV.
7239 Perl_newSVsv(pTHX_ register SV *old)
7246 if (SvTYPE(old) == SVTYPEMASK) {
7247 if (ckWARN_d(WARN_INTERNAL))
7248 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7252 /* SV_GMAGIC is the default for sv_setv()
7253 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7254 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7255 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7260 =for apidoc sv_reset
7262 Underlying implementation for the C<reset> Perl function.
7263 Note that the perl-level function is vaguely deprecated.
7269 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7272 char todo[PERL_UCHAR_MAX+1];
7277 if (!*s) { /* reset ?? searches */
7278 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7280 PMOP *pm = (PMOP *) mg->mg_obj;
7282 pm->op_pmdynflags &= ~PMdf_USED;
7289 /* reset variables */
7291 if (!HvARRAY(stash))
7294 Zero(todo, 256, char);
7297 I32 i = (unsigned char)*s;
7301 max = (unsigned char)*s++;
7302 for ( ; i <= max; i++) {
7305 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7307 for (entry = HvARRAY(stash)[i];
7309 entry = HeNEXT(entry))
7314 if (!todo[(U8)*HeKEY(entry)])
7316 gv = (GV*)HeVAL(entry);
7319 if (SvTHINKFIRST(sv)) {
7320 if (!SvREADONLY(sv) && SvROK(sv))
7322 /* XXX Is this continue a bug? Why should THINKFIRST
7323 exempt us from resetting arrays and hashes? */
7327 if (SvTYPE(sv) >= SVt_PV) {
7329 if (SvPVX_const(sv) != NULL)
7337 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7339 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7342 # if defined(USE_ENVIRON_ARRAY)
7345 # endif /* USE_ENVIRON_ARRAY */
7356 Using various gambits, try to get an IO from an SV: the IO slot if its a
7357 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7358 named after the PV if we're a string.
7364 Perl_sv_2io(pTHX_ SV *sv)
7369 switch (SvTYPE(sv)) {
7377 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7381 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7383 return sv_2io(SvRV(sv));
7384 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7390 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7399 Using various gambits, try to get a CV from an SV; in addition, try if
7400 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7401 The flags in C<lref> are passed to sv_fetchsv.
7407 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7418 switch (SvTYPE(sv)) {
7437 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7438 tryAMAGICunDEREF(to_cv);
7441 if (SvTYPE(sv) == SVt_PVCV) {
7450 Perl_croak(aTHX_ "Not a subroutine reference");
7455 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7461 /* Some flags to gv_fetchsv mean don't really create the GV */
7462 if (SvTYPE(gv) != SVt_PVGV) {
7468 if (lref && !GvCVu(gv)) {
7472 gv_efullname3(tmpsv, gv, NULL);
7473 /* XXX this is probably not what they think they're getting.
7474 * It has the same effect as "sub name;", i.e. just a forward
7476 newSUB(start_subparse(FALSE, 0),
7477 newSVOP(OP_CONST, 0, tmpsv),
7481 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7491 Returns true if the SV has a true value by Perl's rules.
7492 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7493 instead use an in-line version.
7499 Perl_sv_true(pTHX_ register SV *sv)
7504 register const XPV* const tXpv = (XPV*)SvANY(sv);
7506 (tXpv->xpv_cur > 1 ||
7507 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7514 return SvIVX(sv) != 0;
7517 return SvNVX(sv) != 0.0;
7519 return sv_2bool(sv);
7525 =for apidoc sv_pvn_force
7527 Get a sensible string out of the SV somehow.
7528 A private implementation of the C<SvPV_force> macro for compilers which
7529 can't cope with complex macro expressions. Always use the macro instead.
7531 =for apidoc sv_pvn_force_flags
7533 Get a sensible string out of the SV somehow.
7534 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7535 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7536 implemented in terms of this function.
7537 You normally want to use the various wrapper macros instead: see
7538 C<SvPV_force> and C<SvPV_force_nomg>
7544 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7547 if (SvTHINKFIRST(sv) && !SvROK(sv))
7548 sv_force_normal_flags(sv, 0);
7558 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7559 const char * const ref = sv_reftype(sv,0);
7561 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7562 ref, OP_NAME(PL_op));
7564 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7566 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7567 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7569 s = sv_2pv_flags(sv, &len, flags);
7573 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7576 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7577 SvGROW(sv, len + 1);
7578 Move(s,SvPVX(sv),len,char);
7583 SvPOK_on(sv); /* validate pointer */
7585 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7586 PTR2UV(sv),SvPVX_const(sv)));
7589 return SvPVX_mutable(sv);
7593 =for apidoc sv_pvbyten_force
7595 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7601 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7603 sv_pvn_force(sv,lp);
7604 sv_utf8_downgrade(sv,0);
7610 =for apidoc sv_pvutf8n_force
7612 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7618 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7620 sv_pvn_force(sv,lp);
7621 sv_utf8_upgrade(sv);
7627 =for apidoc sv_reftype
7629 Returns a string describing what the SV is a reference to.
7635 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7637 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7638 inside return suggests a const propagation bug in g++. */
7639 if (ob && SvOBJECT(sv)) {
7640 char * const name = HvNAME_get(SvSTASH(sv));
7641 return name ? name : (char *) "__ANON__";
7644 switch (SvTYPE(sv)) {
7660 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7661 /* tied lvalues should appear to be
7662 * scalars for backwards compatitbility */
7663 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7664 ? "SCALAR" : "LVALUE");
7665 case SVt_PVAV: return "ARRAY";
7666 case SVt_PVHV: return "HASH";
7667 case SVt_PVCV: return "CODE";
7668 case SVt_PVGV: return "GLOB";
7669 case SVt_PVFM: return "FORMAT";
7670 case SVt_PVIO: return "IO";
7671 case SVt_BIND: return "BIND";
7672 default: return "UNKNOWN";
7678 =for apidoc sv_isobject
7680 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7681 object. If the SV is not an RV, or if the object is not blessed, then this
7688 Perl_sv_isobject(pTHX_ SV *sv)
7704 Returns a boolean indicating whether the SV is blessed into the specified
7705 class. This does not check for subtypes; use C<sv_derived_from> to verify
7706 an inheritance relationship.
7712 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7723 hvname = HvNAME_get(SvSTASH(sv));
7727 return strEQ(hvname, name);
7733 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7734 it will be upgraded to one. If C<classname> is non-null then the new SV will
7735 be blessed in the specified package. The new SV is returned and its
7736 reference count is 1.
7742 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7749 SV_CHECK_THINKFIRST_COW_DROP(rv);
7752 if (SvTYPE(rv) >= SVt_PVMG) {
7753 const U32 refcnt = SvREFCNT(rv);
7757 SvREFCNT(rv) = refcnt;
7759 sv_upgrade(rv, SVt_RV);
7760 } else if (SvROK(rv)) {
7761 SvREFCNT_dec(SvRV(rv));
7762 } else if (SvTYPE(rv) < SVt_RV)
7763 sv_upgrade(rv, SVt_RV);
7764 else if (SvTYPE(rv) > SVt_RV) {
7775 HV* const stash = gv_stashpv(classname, TRUE);
7776 (void)sv_bless(rv, stash);
7782 =for apidoc sv_setref_pv
7784 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7785 argument will be upgraded to an RV. That RV will be modified to point to
7786 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7787 into the SV. The C<classname> argument indicates the package for the
7788 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7789 will have a reference count of 1, and the RV will be returned.
7791 Do not use with other Perl types such as HV, AV, SV, CV, because those
7792 objects will become corrupted by the pointer copy process.
7794 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7800 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7804 sv_setsv(rv, &PL_sv_undef);
7808 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7813 =for apidoc sv_setref_iv
7815 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7816 argument will be upgraded to an RV. That RV will be modified to point to
7817 the new SV. The C<classname> argument indicates the package for the
7818 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7819 will have a reference count of 1, and the RV will be returned.
7825 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7827 sv_setiv(newSVrv(rv,classname), iv);
7832 =for apidoc sv_setref_uv
7834 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7835 argument will be upgraded to an RV. That RV will be modified to point to
7836 the new SV. The C<classname> argument indicates the package for the
7837 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7838 will have a reference count of 1, and the RV will be returned.
7844 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7846 sv_setuv(newSVrv(rv,classname), uv);
7851 =for apidoc sv_setref_nv
7853 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7854 argument will be upgraded to an RV. That RV will be modified to point to
7855 the new SV. The C<classname> argument indicates the package for the
7856 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7857 will have a reference count of 1, and the RV will be returned.
7863 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7865 sv_setnv(newSVrv(rv,classname), nv);
7870 =for apidoc sv_setref_pvn
7872 Copies a string into a new SV, optionally blessing the SV. The length of the
7873 string must be specified with C<n>. The C<rv> argument will be upgraded to
7874 an RV. That RV will be modified to point to the new SV. The C<classname>
7875 argument indicates the package for the blessing. Set C<classname> to
7876 C<NULL> to avoid the blessing. The new SV will have a reference count
7877 of 1, and the RV will be returned.
7879 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7885 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7887 sv_setpvn(newSVrv(rv,classname), pv, n);
7892 =for apidoc sv_bless
7894 Blesses an SV into a specified package. The SV must be an RV. The package
7895 must be designated by its stash (see C<gv_stashpv()>). The reference count
7896 of the SV is unaffected.
7902 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7907 Perl_croak(aTHX_ "Can't bless non-reference value");
7909 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7910 if (SvREADONLY(tmpRef))
7911 Perl_croak(aTHX_ PL_no_modify);
7912 if (SvOBJECT(tmpRef)) {
7913 if (SvTYPE(tmpRef) != SVt_PVIO)
7915 SvREFCNT_dec(SvSTASH(tmpRef));
7918 SvOBJECT_on(tmpRef);
7919 if (SvTYPE(tmpRef) != SVt_PVIO)
7921 SvUPGRADE(tmpRef, SVt_PVMG);
7922 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7929 if(SvSMAGICAL(tmpRef))
7930 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7938 /* Downgrades a PVGV to a PVMG.
7942 S_sv_unglob(pTHX_ SV *sv)
7946 SV * const temp = sv_newmortal();
7948 assert(SvTYPE(sv) == SVt_PVGV);
7950 gv_efullname3(temp, (GV *) sv, "*");
7956 sv_del_backref((SV*)GvSTASH(sv), sv);
7960 if (GvNAME_HEK(sv)) {
7961 unshare_hek(GvNAME_HEK(sv));
7963 isGV_with_GP_off(sv);
7965 /* need to keep SvANY(sv) in the right arena */
7966 xpvmg = new_XPVMG();
7967 StructCopy(SvANY(sv), xpvmg, XPVMG);
7968 del_XPVGV(SvANY(sv));
7971 SvFLAGS(sv) &= ~SVTYPEMASK;
7972 SvFLAGS(sv) |= SVt_PVMG;
7974 /* Intentionally not calling any local SET magic, as this isn't so much a
7975 set operation as merely an internal storage change. */
7976 sv_setsv_flags(sv, temp, 0);
7980 =for apidoc sv_unref_flags
7982 Unsets the RV status of the SV, and decrements the reference count of
7983 whatever was being referenced by the RV. This can almost be thought of
7984 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7985 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7986 (otherwise the decrementing is conditional on the reference count being
7987 different from one or the reference being a readonly SV).
7994 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7996 SV* const target = SvRV(ref);
7998 if (SvWEAKREF(ref)) {
7999 sv_del_backref(target, ref);
8001 SvRV_set(ref, NULL);
8004 SvRV_set(ref, NULL);
8006 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8007 assigned to as BEGIN {$a = \"Foo"} will fail. */
8008 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8009 SvREFCNT_dec(target);
8010 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8011 sv_2mortal(target); /* Schedule for freeing later */
8015 =for apidoc sv_untaint
8017 Untaint an SV. Use C<SvTAINTED_off> instead.
8022 Perl_sv_untaint(pTHX_ SV *sv)
8024 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8025 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8032 =for apidoc sv_tainted
8034 Test an SV for taintedness. Use C<SvTAINTED> instead.
8039 Perl_sv_tainted(pTHX_ SV *sv)
8041 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8042 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8043 if (mg && (mg->mg_len & 1) )
8050 =for apidoc sv_setpviv
8052 Copies an integer into the given SV, also updating its string value.
8053 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8059 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8061 char buf[TYPE_CHARS(UV)];
8063 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8065 sv_setpvn(sv, ptr, ebuf - ptr);
8069 =for apidoc sv_setpviv_mg
8071 Like C<sv_setpviv>, but also handles 'set' magic.
8077 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8083 #if defined(PERL_IMPLICIT_CONTEXT)
8085 /* pTHX_ magic can't cope with varargs, so this is a no-context
8086 * version of the main function, (which may itself be aliased to us).
8087 * Don't access this version directly.
8091 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8095 va_start(args, pat);
8096 sv_vsetpvf(sv, pat, &args);
8100 /* pTHX_ magic can't cope with varargs, so this is a no-context
8101 * version of the main function, (which may itself be aliased to us).
8102 * Don't access this version directly.
8106 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8110 va_start(args, pat);
8111 sv_vsetpvf_mg(sv, pat, &args);
8117 =for apidoc sv_setpvf
8119 Works like C<sv_catpvf> but copies the text into the SV instead of
8120 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8126 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8129 va_start(args, pat);
8130 sv_vsetpvf(sv, pat, &args);
8135 =for apidoc sv_vsetpvf
8137 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8138 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8140 Usually used via its frontend C<sv_setpvf>.
8146 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8148 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8152 =for apidoc sv_setpvf_mg
8154 Like C<sv_setpvf>, but also handles 'set' magic.
8160 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8163 va_start(args, pat);
8164 sv_vsetpvf_mg(sv, pat, &args);
8169 =for apidoc sv_vsetpvf_mg
8171 Like C<sv_vsetpvf>, but also handles 'set' magic.
8173 Usually used via its frontend C<sv_setpvf_mg>.
8179 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8181 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8185 #if defined(PERL_IMPLICIT_CONTEXT)
8187 /* pTHX_ magic can't cope with varargs, so this is a no-context
8188 * version of the main function, (which may itself be aliased to us).
8189 * Don't access this version directly.
8193 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8197 va_start(args, pat);
8198 sv_vcatpvf(sv, pat, &args);
8202 /* pTHX_ magic can't cope with varargs, so this is a no-context
8203 * version of the main function, (which may itself be aliased to us).
8204 * Don't access this version directly.
8208 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8212 va_start(args, pat);
8213 sv_vcatpvf_mg(sv, pat, &args);
8219 =for apidoc sv_catpvf
8221 Processes its arguments like C<sprintf> and appends the formatted
8222 output to an SV. If the appended data contains "wide" characters
8223 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8224 and characters >255 formatted with %c), the original SV might get
8225 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8226 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8227 valid UTF-8; if the original SV was bytes, the pattern should be too.
8232 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8235 va_start(args, pat);
8236 sv_vcatpvf(sv, pat, &args);
8241 =for apidoc sv_vcatpvf
8243 Processes its arguments like C<vsprintf> and appends the formatted output
8244 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8246 Usually used via its frontend C<sv_catpvf>.
8252 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8254 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8258 =for apidoc sv_catpvf_mg
8260 Like C<sv_catpvf>, but also handles 'set' magic.
8266 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8269 va_start(args, pat);
8270 sv_vcatpvf_mg(sv, pat, &args);
8275 =for apidoc sv_vcatpvf_mg
8277 Like C<sv_vcatpvf>, but also handles 'set' magic.
8279 Usually used via its frontend C<sv_catpvf_mg>.
8285 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8287 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8292 =for apidoc sv_vsetpvfn
8294 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8297 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8303 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8305 sv_setpvn(sv, "", 0);
8306 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8310 S_expect_number(pTHX_ char** pattern)
8314 switch (**pattern) {
8315 case '1': case '2': case '3':
8316 case '4': case '5': case '6':
8317 case '7': case '8': case '9':
8318 var = *(*pattern)++ - '0';
8319 while (isDIGIT(**pattern)) {
8320 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8322 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8330 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8332 const int neg = nv < 0;
8341 if (uv & 1 && uv == nv)
8342 uv--; /* Round to even */
8344 const unsigned dig = uv % 10;
8357 =for apidoc sv_vcatpvfn
8359 Processes its arguments like C<vsprintf> and appends the formatted output
8360 to an SV. Uses an array of SVs if the C style variable argument list is
8361 missing (NULL). When running with taint checks enabled, indicates via
8362 C<maybe_tainted> if results are untrustworthy (often due to the use of
8365 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8371 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8372 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8373 vec_utf8 = DO_UTF8(vecsv);
8375 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8378 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8386 static const char nullstr[] = "(null)";
8388 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8389 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8391 /* Times 4: a decimal digit takes more than 3 binary digits.
8392 * NV_DIG: mantissa takes than many decimal digits.
8393 * Plus 32: Playing safe. */
8394 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8395 /* large enough for "%#.#f" --chip */
8396 /* what about long double NVs? --jhi */
8398 PERL_UNUSED_ARG(maybe_tainted);
8400 /* no matter what, this is a string now */
8401 (void)SvPV_force(sv, origlen);
8403 /* special-case "", "%s", and "%-p" (SVf - see below) */
8406 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8408 const char * const s = va_arg(*args, char*);
8409 sv_catpv(sv, s ? s : nullstr);
8411 else if (svix < svmax) {
8412 sv_catsv(sv, *svargs);
8416 if (args && patlen == 3 && pat[0] == '%' &&
8417 pat[1] == '-' && pat[2] == 'p') {
8418 argsv = (SV*)va_arg(*args, void*);
8419 sv_catsv(sv, argsv);
8423 #ifndef USE_LONG_DOUBLE
8424 /* special-case "%.<number>[gf]" */
8425 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8426 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8427 unsigned digits = 0;
8431 while (*pp >= '0' && *pp <= '9')
8432 digits = 10 * digits + (*pp++ - '0');
8433 if (pp - pat == (int)patlen - 1) {
8441 /* Add check for digits != 0 because it seems that some
8442 gconverts are buggy in this case, and we don't yet have
8443 a Configure test for this. */
8444 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8445 /* 0, point, slack */
8446 Gconvert(nv, (int)digits, 0, ebuf);
8448 if (*ebuf) /* May return an empty string for digits==0 */
8451 } else if (!digits) {
8454 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8455 sv_catpvn(sv, p, l);
8461 #endif /* !USE_LONG_DOUBLE */
8463 if (!args && svix < svmax && DO_UTF8(*svargs))
8466 patend = (char*)pat + patlen;
8467 for (p = (char*)pat; p < patend; p = q) {
8470 bool vectorize = FALSE;
8471 bool vectorarg = FALSE;
8472 bool vec_utf8 = FALSE;
8478 bool has_precis = FALSE;
8480 const I32 osvix = svix;
8481 bool is_utf8 = FALSE; /* is this item utf8? */
8482 #ifdef HAS_LDBL_SPRINTF_BUG
8483 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8484 with sfio - Allen <allens@cpan.org> */
8485 bool fix_ldbl_sprintf_bug = FALSE;
8489 U8 utf8buf[UTF8_MAXBYTES+1];
8490 STRLEN esignlen = 0;
8492 const char *eptr = NULL;
8495 const U8 *vecstr = NULL;
8502 /* we need a long double target in case HAS_LONG_DOUBLE but
8505 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8513 const char *dotstr = ".";
8514 STRLEN dotstrlen = 1;
8515 I32 efix = 0; /* explicit format parameter index */
8516 I32 ewix = 0; /* explicit width index */
8517 I32 epix = 0; /* explicit precision index */
8518 I32 evix = 0; /* explicit vector index */
8519 bool asterisk = FALSE;
8521 /* echo everything up to the next format specification */
8522 for (q = p; q < patend && *q != '%'; ++q) ;
8524 if (has_utf8 && !pat_utf8)
8525 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8527 sv_catpvn(sv, p, q - p);
8534 We allow format specification elements in this order:
8535 \d+\$ explicit format parameter index
8537 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8538 0 flag (as above): repeated to allow "v02"
8539 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8540 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8542 [%bcdefginopsuxDFOUX] format (mandatory)
8547 As of perl5.9.3, printf format checking is on by default.
8548 Internally, perl uses %p formats to provide an escape to
8549 some extended formatting. This block deals with those
8550 extensions: if it does not match, (char*)q is reset and
8551 the normal format processing code is used.
8553 Currently defined extensions are:
8554 %p include pointer address (standard)
8555 %-p (SVf) include an SV (previously %_)
8556 %-<num>p include an SV with precision <num>
8557 %1p (VDf) include a v-string (as %vd)
8558 %<num>p reserved for future extensions
8560 Robin Barker 2005-07-14
8567 n = expect_number(&q);
8574 argsv = (SV*)va_arg(*args, void*);
8575 eptr = SvPVx_const(argsv, elen);
8581 else if (n == vdNUMBER) { /* VDf */
8588 if (ckWARN_d(WARN_INTERNAL))
8589 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8590 "internal %%<num>p might conflict with future printf extensions");
8596 if ( (width = expect_number(&q)) ) {
8611 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8640 if ( (ewix = expect_number(&q)) )
8649 if ((vectorarg = asterisk)) {
8662 width = expect_number(&q);
8668 vecsv = va_arg(*args, SV*);
8670 vecsv = (evix > 0 && evix <= svmax)
8671 ? svargs[evix-1] : &PL_sv_undef;
8673 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8675 dotstr = SvPV_const(vecsv, dotstrlen);
8676 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8677 bad with tied or overloaded values that return UTF8. */
8680 else if (has_utf8) {
8681 vecsv = sv_mortalcopy(vecsv);
8682 sv_utf8_upgrade(vecsv);
8683 dotstr = SvPV_const(vecsv, dotstrlen);
8690 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8691 vecsv = svargs[efix ? efix-1 : svix++];
8692 vecstr = (U8*)SvPV_const(vecsv,veclen);
8693 vec_utf8 = DO_UTF8(vecsv);
8695 /* if this is a version object, we need to convert
8696 * back into v-string notation and then let the
8697 * vectorize happen normally
8699 if (sv_derived_from(vecsv, "version")) {
8700 char *version = savesvpv(vecsv);
8701 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8702 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8703 "vector argument not supported with alpha versions");
8706 vecsv = sv_newmortal();
8707 /* scan_vstring is expected to be called during
8708 * tokenization, so we need to fake up the end
8709 * of the buffer for it
8711 PL_bufend = version + veclen;
8712 scan_vstring(version, vecsv);
8713 vecstr = (U8*)SvPV_const(vecsv, veclen);
8714 vec_utf8 = DO_UTF8(vecsv);
8726 i = va_arg(*args, int);
8728 i = (ewix ? ewix <= svmax : svix < svmax) ?
8729 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8731 width = (i < 0) ? -i : i;
8741 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8743 /* XXX: todo, support specified precision parameter */
8747 i = va_arg(*args, int);
8749 i = (ewix ? ewix <= svmax : svix < svmax)
8750 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8752 has_precis = !(i < 0);
8757 precis = precis * 10 + (*q++ - '0');
8766 case 'I': /* Ix, I32x, and I64x */
8768 if (q[1] == '6' && q[2] == '4') {
8774 if (q[1] == '3' && q[2] == '2') {
8784 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8795 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8796 if (*(q + 1) == 'l') { /* lld, llf */
8822 if (!vectorize && !args) {
8824 const I32 i = efix-1;
8825 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8827 argsv = (svix >= 0 && svix < svmax)
8828 ? svargs[svix++] : &PL_sv_undef;
8839 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8841 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8843 eptr = (char*)utf8buf;
8844 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8858 eptr = va_arg(*args, char*);
8860 #ifdef MACOS_TRADITIONAL
8861 /* On MacOS, %#s format is used for Pascal strings */
8866 elen = strlen(eptr);
8868 eptr = (char *)nullstr;
8869 elen = sizeof nullstr - 1;
8873 eptr = SvPVx_const(argsv, elen);
8874 if (DO_UTF8(argsv)) {
8875 I32 old_precis = precis;
8876 if (has_precis && precis < elen) {
8878 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8881 if (width) { /* fudge width (can't fudge elen) */
8882 if (has_precis && precis < elen)
8883 width += precis - old_precis;
8885 width += elen - sv_len_utf8(argsv);
8892 if (has_precis && elen > precis)
8899 if (alt || vectorize)
8901 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8922 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8931 esignbuf[esignlen++] = plus;
8935 case 'h': iv = (short)va_arg(*args, int); break;
8936 case 'l': iv = va_arg(*args, long); break;
8937 case 'V': iv = va_arg(*args, IV); break;
8938 default: iv = va_arg(*args, int); break;
8940 case 'q': iv = va_arg(*args, Quad_t); break;
8945 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8947 case 'h': iv = (short)tiv; break;
8948 case 'l': iv = (long)tiv; break;
8950 default: iv = tiv; break;
8952 case 'q': iv = (Quad_t)tiv; break;
8956 if ( !vectorize ) /* we already set uv above */
8961 esignbuf[esignlen++] = plus;
8965 esignbuf[esignlen++] = '-';
9009 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9020 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9021 case 'l': uv = va_arg(*args, unsigned long); break;
9022 case 'V': uv = va_arg(*args, UV); break;
9023 default: uv = va_arg(*args, unsigned); break;
9025 case 'q': uv = va_arg(*args, Uquad_t); break;
9030 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9032 case 'h': uv = (unsigned short)tuv; break;
9033 case 'l': uv = (unsigned long)tuv; break;
9035 default: uv = tuv; break;
9037 case 'q': uv = (Uquad_t)tuv; break;
9044 char *ptr = ebuf + sizeof ebuf;
9045 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9051 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9057 esignbuf[esignlen++] = '0';
9058 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9066 if (alt && *ptr != '0')
9075 esignbuf[esignlen++] = '0';
9076 esignbuf[esignlen++] = c;
9079 default: /* it had better be ten or less */
9083 } while (uv /= base);
9086 elen = (ebuf + sizeof ebuf) - ptr;
9090 zeros = precis - elen;
9091 else if (precis == 0 && elen == 1 && *eptr == '0'
9092 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9095 /* a precision nullifies the 0 flag. */
9102 /* FLOATING POINT */
9105 c = 'f'; /* maybe %F isn't supported here */
9113 /* This is evil, but floating point is even more evil */
9115 /* for SV-style calling, we can only get NV
9116 for C-style calling, we assume %f is double;
9117 for simplicity we allow any of %Lf, %llf, %qf for long double
9121 #if defined(USE_LONG_DOUBLE)
9125 /* [perl #20339] - we should accept and ignore %lf rather than die */
9129 #if defined(USE_LONG_DOUBLE)
9130 intsize = args ? 0 : 'q';
9134 #if defined(HAS_LONG_DOUBLE)
9143 /* now we need (long double) if intsize == 'q', else (double) */
9145 #if LONG_DOUBLESIZE > DOUBLESIZE
9147 va_arg(*args, long double) :
9148 va_arg(*args, double)
9150 va_arg(*args, double)
9155 if (c != 'e' && c != 'E') {
9157 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9158 will cast our (long double) to (double) */
9159 (void)Perl_frexp(nv, &i);
9160 if (i == PERL_INT_MIN)
9161 Perl_die(aTHX_ "panic: frexp");
9163 need = BIT_DIGITS(i);
9165 need += has_precis ? precis : 6; /* known default */
9170 #ifdef HAS_LDBL_SPRINTF_BUG
9171 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9172 with sfio - Allen <allens@cpan.org> */
9175 # define MY_DBL_MAX DBL_MAX
9176 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9177 # if DOUBLESIZE >= 8
9178 # define MY_DBL_MAX 1.7976931348623157E+308L
9180 # define MY_DBL_MAX 3.40282347E+38L
9184 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9185 # define MY_DBL_MAX_BUG 1L
9187 # define MY_DBL_MAX_BUG MY_DBL_MAX
9191 # define MY_DBL_MIN DBL_MIN
9192 # else /* XXX guessing! -Allen */
9193 # if DOUBLESIZE >= 8
9194 # define MY_DBL_MIN 2.2250738585072014E-308L
9196 # define MY_DBL_MIN 1.17549435E-38L
9200 if ((intsize == 'q') && (c == 'f') &&
9201 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9203 /* it's going to be short enough that
9204 * long double precision is not needed */
9206 if ((nv <= 0L) && (nv >= -0L))
9207 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9209 /* would use Perl_fp_class as a double-check but not
9210 * functional on IRIX - see perl.h comments */
9212 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9213 /* It's within the range that a double can represent */
9214 #if defined(DBL_MAX) && !defined(DBL_MIN)
9215 if ((nv >= ((long double)1/DBL_MAX)) ||
9216 (nv <= (-(long double)1/DBL_MAX)))
9218 fix_ldbl_sprintf_bug = TRUE;
9221 if (fix_ldbl_sprintf_bug == TRUE) {
9231 # undef MY_DBL_MAX_BUG
9234 #endif /* HAS_LDBL_SPRINTF_BUG */
9236 need += 20; /* fudge factor */
9237 if (PL_efloatsize < need) {
9238 Safefree(PL_efloatbuf);
9239 PL_efloatsize = need + 20; /* more fudge */
9240 Newx(PL_efloatbuf, PL_efloatsize, char);
9241 PL_efloatbuf[0] = '\0';
9244 if ( !(width || left || plus || alt) && fill != '0'
9245 && has_precis && intsize != 'q' ) { /* Shortcuts */
9246 /* See earlier comment about buggy Gconvert when digits,
9248 if ( c == 'g' && precis) {
9249 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9250 /* May return an empty string for digits==0 */
9251 if (*PL_efloatbuf) {
9252 elen = strlen(PL_efloatbuf);
9253 goto float_converted;
9255 } else if ( c == 'f' && !precis) {
9256 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9261 char *ptr = ebuf + sizeof ebuf;
9264 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9265 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9266 if (intsize == 'q') {
9267 /* Copy the one or more characters in a long double
9268 * format before the 'base' ([efgEFG]) character to
9269 * the format string. */
9270 static char const prifldbl[] = PERL_PRIfldbl;
9271 char const *p = prifldbl + sizeof(prifldbl) - 3;
9272 while (p >= prifldbl) { *--ptr = *p--; }
9277 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9282 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9294 /* No taint. Otherwise we are in the strange situation
9295 * where printf() taints but print($float) doesn't.
9297 #if defined(HAS_LONG_DOUBLE)
9298 elen = ((intsize == 'q')
9299 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9300 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9302 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9306 eptr = PL_efloatbuf;
9314 i = SvCUR(sv) - origlen;
9317 case 'h': *(va_arg(*args, short*)) = i; break;
9318 default: *(va_arg(*args, int*)) = i; break;
9319 case 'l': *(va_arg(*args, long*)) = i; break;
9320 case 'V': *(va_arg(*args, IV*)) = i; break;
9322 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9327 sv_setuv_mg(argsv, (UV)i);
9328 continue; /* not "break" */
9335 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9336 && ckWARN(WARN_PRINTF))
9338 SV * const msg = sv_newmortal();
9339 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9340 (PL_op->op_type == OP_PRTF) ? "" : "s");
9343 Perl_sv_catpvf(aTHX_ msg,
9344 "\"%%%c\"", c & 0xFF);
9346 Perl_sv_catpvf(aTHX_ msg,
9347 "\"%%\\%03"UVof"\"",
9350 sv_catpvs(msg, "end of string");
9351 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9354 /* output mangled stuff ... */
9360 /* ... right here, because formatting flags should not apply */
9361 SvGROW(sv, SvCUR(sv) + elen + 1);
9363 Copy(eptr, p, elen, char);
9366 SvCUR_set(sv, p - SvPVX_const(sv));
9368 continue; /* not "break" */
9371 if (is_utf8 != has_utf8) {
9374 sv_utf8_upgrade(sv);
9377 const STRLEN old_elen = elen;
9378 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9379 sv_utf8_upgrade(nsv);
9380 eptr = SvPVX_const(nsv);
9383 if (width) { /* fudge width (can't fudge elen) */
9384 width += elen - old_elen;
9390 have = esignlen + zeros + elen;
9392 Perl_croak_nocontext(PL_memory_wrap);
9394 need = (have > width ? have : width);
9397 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9398 Perl_croak_nocontext(PL_memory_wrap);
9399 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9401 if (esignlen && fill == '0') {
9403 for (i = 0; i < (int)esignlen; i++)
9407 memset(p, fill, gap);
9410 if (esignlen && fill != '0') {
9412 for (i = 0; i < (int)esignlen; i++)
9417 for (i = zeros; i; i--)
9421 Copy(eptr, p, elen, char);
9425 memset(p, ' ', gap);
9430 Copy(dotstr, p, dotstrlen, char);
9434 vectorize = FALSE; /* done iterating over vecstr */
9441 SvCUR_set(sv, p - SvPVX_const(sv));
9449 /* =========================================================================
9451 =head1 Cloning an interpreter
9453 All the macros and functions in this section are for the private use of
9454 the main function, perl_clone().
9456 The foo_dup() functions make an exact copy of an existing foo thinngy.
9457 During the course of a cloning, a hash table is used to map old addresses
9458 to new addresses. The table is created and manipulated with the
9459 ptr_table_* functions.
9463 ============================================================================*/
9466 #if defined(USE_ITHREADS)
9468 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9469 #ifndef GpREFCNT_inc
9470 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9474 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9475 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9476 If this changes, please unmerge ss_dup. */
9477 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9478 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9479 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9480 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9481 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9482 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9483 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9484 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9485 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9486 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9487 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9488 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9489 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9490 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9492 /* clone a parser */
9495 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9502 /* look for it in the table first */
9503 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9507 /* create anew and remember what it is */
9508 Newxz(parser, 1, yy_parser);
9509 ptr_table_store(PL_ptr_table, proto, parser);
9511 parser->yyerrstatus = 0;
9512 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9514 /* XXX these not yet duped */
9515 parser->old_parser = NULL;
9516 parser->stack = NULL;
9518 parser->stack_size = 0;
9519 /* XXX parser->stack->state = 0; */
9521 /* XXX eventually, just Copy() most of the parser struct ? */
9523 parser->lex_brackets = proto->lex_brackets;
9524 parser->lex_casemods = proto->lex_casemods;
9525 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9526 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9527 parser->lex_casestack = savepvn(proto->lex_casestack,
9528 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9529 parser->lex_defer = proto->lex_defer;
9530 parser->lex_dojoin = proto->lex_dojoin;
9531 parser->lex_expect = proto->lex_expect;
9532 parser->lex_formbrack = proto->lex_formbrack;
9533 parser->lex_inpat = proto->lex_inpat;
9534 parser->lex_inwhat = proto->lex_inwhat;
9535 parser->lex_op = proto->lex_op;
9536 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9537 parser->lex_starts = proto->lex_starts;
9538 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9539 parser->multi_close = proto->multi_close;
9540 parser->multi_open = proto->multi_open;
9541 parser->multi_start = proto->multi_start;
9542 parser->pending_ident = proto->pending_ident;
9543 parser->preambled = proto->preambled;
9544 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9547 parser->endwhite = proto->endwhite;
9548 parser->faketokens = proto->faketokens;
9549 parser->lasttoke = proto->lasttoke;
9550 parser->nextwhite = proto->nextwhite;
9551 parser->realtokenstart = proto->realtokenstart;
9552 parser->skipwhite = proto->skipwhite;
9553 parser->thisclose = proto->thisclose;
9554 parser->thismad = proto->thismad;
9555 parser->thisopen = proto->thisopen;
9556 parser->thisstuff = proto->thisstuff;
9557 parser->thistoken = proto->thistoken;
9558 parser->thiswhite = proto->thiswhite;
9564 /* duplicate a file handle */
9567 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9571 PERL_UNUSED_ARG(type);
9574 return (PerlIO*)NULL;
9576 /* look for it in the table first */
9577 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9581 /* create anew and remember what it is */
9582 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9583 ptr_table_store(PL_ptr_table, fp, ret);
9587 /* duplicate a directory handle */
9590 Perl_dirp_dup(pTHX_ DIR *dp)
9592 PERL_UNUSED_CONTEXT;
9599 /* duplicate a typeglob */
9602 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9608 /* look for it in the table first */
9609 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9613 /* create anew and remember what it is */
9615 ptr_table_store(PL_ptr_table, gp, ret);
9618 ret->gp_refcnt = 0; /* must be before any other dups! */
9619 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9620 ret->gp_io = io_dup_inc(gp->gp_io, param);
9621 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9622 ret->gp_av = av_dup_inc(gp->gp_av, param);
9623 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9624 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9625 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9626 ret->gp_cvgen = gp->gp_cvgen;
9627 ret->gp_line = gp->gp_line;
9628 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9632 /* duplicate a chain of magic */
9635 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9637 MAGIC *mgprev = (MAGIC*)NULL;
9640 return (MAGIC*)NULL;
9641 /* look for it in the table first */
9642 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9646 for (; mg; mg = mg->mg_moremagic) {
9648 Newxz(nmg, 1, MAGIC);
9650 mgprev->mg_moremagic = nmg;
9653 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9654 nmg->mg_private = mg->mg_private;
9655 nmg->mg_type = mg->mg_type;
9656 nmg->mg_flags = mg->mg_flags;
9657 if (mg->mg_type == PERL_MAGIC_qr) {
9658 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9660 else if(mg->mg_type == PERL_MAGIC_backref) {
9661 /* The backref AV has its reference count deliberately bumped by
9663 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9665 else if (mg->mg_type == PERL_MAGIC_symtab) {
9666 nmg->mg_obj = mg->mg_obj;
9669 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9670 ? sv_dup_inc(mg->mg_obj, param)
9671 : sv_dup(mg->mg_obj, param);
9673 nmg->mg_len = mg->mg_len;
9674 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9675 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9676 if (mg->mg_len > 0) {
9677 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9678 if (mg->mg_type == PERL_MAGIC_overload_table &&
9679 AMT_AMAGIC((AMT*)mg->mg_ptr))
9681 const AMT * const amtp = (AMT*)mg->mg_ptr;
9682 AMT * const namtp = (AMT*)nmg->mg_ptr;
9684 for (i = 1; i < NofAMmeth; i++) {
9685 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9689 else if (mg->mg_len == HEf_SVKEY)
9690 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9692 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9693 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9700 #endif /* USE_ITHREADS */
9702 /* create a new pointer-mapping table */
9705 Perl_ptr_table_new(pTHX)
9708 PERL_UNUSED_CONTEXT;
9710 Newxz(tbl, 1, PTR_TBL_t);
9713 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9717 #define PTR_TABLE_HASH(ptr) \
9718 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9721 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9722 following define) and at call to new_body_inline made below in
9723 Perl_ptr_table_store()
9726 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9728 /* map an existing pointer using a table */
9730 STATIC PTR_TBL_ENT_t *
9731 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9732 PTR_TBL_ENT_t *tblent;
9733 const UV hash = PTR_TABLE_HASH(sv);
9735 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9736 for (; tblent; tblent = tblent->next) {
9737 if (tblent->oldval == sv)
9744 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9746 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9747 PERL_UNUSED_CONTEXT;
9748 return tblent ? tblent->newval : NULL;
9751 /* add a new entry to a pointer-mapping table */
9754 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9756 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9757 PERL_UNUSED_CONTEXT;
9760 tblent->newval = newsv;
9762 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9764 new_body_inline(tblent, PTE_SVSLOT);
9766 tblent->oldval = oldsv;
9767 tblent->newval = newsv;
9768 tblent->next = tbl->tbl_ary[entry];
9769 tbl->tbl_ary[entry] = tblent;
9771 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9772 ptr_table_split(tbl);
9776 /* double the hash bucket size of an existing ptr table */
9779 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9781 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9782 const UV oldsize = tbl->tbl_max + 1;
9783 UV newsize = oldsize * 2;
9785 PERL_UNUSED_CONTEXT;
9787 Renew(ary, newsize, PTR_TBL_ENT_t*);
9788 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9789 tbl->tbl_max = --newsize;
9791 for (i=0; i < oldsize; i++, ary++) {
9792 PTR_TBL_ENT_t **curentp, **entp, *ent;
9795 curentp = ary + oldsize;
9796 for (entp = ary, ent = *ary; ent; ent = *entp) {
9797 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9799 ent->next = *curentp;
9809 /* remove all the entries from a ptr table */
9812 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9814 if (tbl && tbl->tbl_items) {
9815 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9816 UV riter = tbl->tbl_max;
9819 PTR_TBL_ENT_t *entry = array[riter];
9822 PTR_TBL_ENT_t * const oentry = entry;
9823 entry = entry->next;
9832 /* clear and free a ptr table */
9835 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9840 ptr_table_clear(tbl);
9841 Safefree(tbl->tbl_ary);
9845 #if defined(USE_ITHREADS)
9848 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9851 SvRV_set(dstr, SvWEAKREF(sstr)
9852 ? sv_dup(SvRV(sstr), param)
9853 : sv_dup_inc(SvRV(sstr), param));
9856 else if (SvPVX_const(sstr)) {
9857 /* Has something there */
9859 /* Normal PV - clone whole allocated space */
9860 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9861 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9862 /* Not that normal - actually sstr is copy on write.
9863 But we are a true, independant SV, so: */
9864 SvREADONLY_off(dstr);
9869 /* Special case - not normally malloced for some reason */
9870 if (isGV_with_GP(sstr)) {
9871 /* Don't need to do anything here. */
9873 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9874 /* A "shared" PV - clone it as "shared" PV */
9876 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9880 /* Some other special case - random pointer */
9881 SvPV_set(dstr, SvPVX(sstr));
9887 if (SvTYPE(dstr) == SVt_RV)
9888 SvRV_set(dstr, NULL);
9890 SvPV_set(dstr, NULL);
9894 /* duplicate an SV of any type (including AV, HV etc) */
9897 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9902 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9904 /* look for it in the table first */
9905 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9909 if(param->flags & CLONEf_JOIN_IN) {
9910 /** We are joining here so we don't want do clone
9911 something that is bad **/
9912 if (SvTYPE(sstr) == SVt_PVHV) {
9913 const char * const hvname = HvNAME_get(sstr);
9915 /** don't clone stashes if they already exist **/
9916 return (SV*)gv_stashpv(hvname,0);
9920 /* create anew and remember what it is */
9923 #ifdef DEBUG_LEAKING_SCALARS
9924 dstr->sv_debug_optype = sstr->sv_debug_optype;
9925 dstr->sv_debug_line = sstr->sv_debug_line;
9926 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9927 dstr->sv_debug_cloned = 1;
9928 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9931 ptr_table_store(PL_ptr_table, sstr, dstr);
9934 SvFLAGS(dstr) = SvFLAGS(sstr);
9935 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9936 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9939 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9940 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9941 (void*)PL_watch_pvx, SvPVX_const(sstr));
9944 /* don't clone objects whose class has asked us not to */
9945 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9946 SvFLAGS(dstr) &= ~SVTYPEMASK;
9951 switch (SvTYPE(sstr)) {
9956 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9957 SvIV_set(dstr, SvIVX(sstr));
9960 SvANY(dstr) = new_XNV();
9961 SvNV_set(dstr, SvNVX(sstr));
9964 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9965 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9967 /* case SVt_BIND: */
9970 /* These are all the types that need complex bodies allocating. */
9972 const svtype sv_type = SvTYPE(sstr);
9973 const struct body_details *const sv_type_details
9974 = bodies_by_type + sv_type;
9978 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9982 if (GvUNIQUE((GV*)sstr)) {
9983 NOOP; /* Do sharing here, and fall through */
9995 assert(sv_type_details->body_size);
9996 if (sv_type_details->arena) {
9997 new_body_inline(new_body, sv_type);
9999 = (void*)((char*)new_body - sv_type_details->offset);
10001 new_body = new_NOARENA(sv_type_details);
10005 SvANY(dstr) = new_body;
10008 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10009 ((char*)SvANY(dstr)) + sv_type_details->offset,
10010 sv_type_details->copy, char);
10012 Copy(((char*)SvANY(sstr)),
10013 ((char*)SvANY(dstr)),
10014 sv_type_details->body_size + sv_type_details->offset, char);
10017 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10018 && !isGV_with_GP(dstr))
10019 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10021 /* The Copy above means that all the source (unduplicated) pointers
10022 are now in the destination. We can check the flags and the
10023 pointers in either, but it's possible that there's less cache
10024 missing by always going for the destination.
10025 FIXME - instrument and check that assumption */
10026 if (sv_type >= SVt_PVMG) {
10027 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10028 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10029 } else if (SvMAGIC(dstr))
10030 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10032 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10035 /* The cast silences a GCC warning about unhandled types. */
10036 switch ((int)sv_type) {
10046 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10047 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10048 LvTARG(dstr) = dstr;
10049 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10050 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10052 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10054 if(isGV_with_GP(sstr)) {
10055 if (GvNAME_HEK(dstr))
10056 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10057 /* Don't call sv_add_backref here as it's going to be
10058 created as part of the magic cloning of the symbol
10060 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10061 at the point of this comment. */
10062 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10063 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10064 (void)GpREFCNT_inc(GvGP(dstr));
10066 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10069 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10070 if (IoOFP(dstr) == IoIFP(sstr))
10071 IoOFP(dstr) = IoIFP(dstr);
10073 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10074 /* PL_rsfp_filters entries have fake IoDIRP() */
10075 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10076 /* I have no idea why fake dirp (rsfps)
10077 should be treated differently but otherwise
10078 we end up with leaks -- sky*/
10079 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10080 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10081 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10083 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10084 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10085 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10086 if (IoDIRP(dstr)) {
10087 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10090 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10093 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10094 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10095 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10098 if (AvARRAY((AV*)sstr)) {
10099 SV **dst_ary, **src_ary;
10100 SSize_t items = AvFILLp((AV*)sstr) + 1;
10102 src_ary = AvARRAY((AV*)sstr);
10103 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10104 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10105 AvARRAY((AV*)dstr) = dst_ary;
10106 AvALLOC((AV*)dstr) = dst_ary;
10107 if (AvREAL((AV*)sstr)) {
10108 while (items-- > 0)
10109 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10112 while (items-- > 0)
10113 *dst_ary++ = sv_dup(*src_ary++, param);
10115 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10116 while (items-- > 0) {
10117 *dst_ary++ = &PL_sv_undef;
10121 AvARRAY((AV*)dstr) = NULL;
10122 AvALLOC((AV*)dstr) = (SV**)NULL;
10126 if (HvARRAY((HV*)sstr)) {
10128 const bool sharekeys = !!HvSHAREKEYS(sstr);
10129 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10130 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10132 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10133 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10135 HvARRAY(dstr) = (HE**)darray;
10136 while (i <= sxhv->xhv_max) {
10137 const HE * const source = HvARRAY(sstr)[i];
10138 HvARRAY(dstr)[i] = source
10139 ? he_dup(source, sharekeys, param) : 0;
10144 const struct xpvhv_aux * const saux = HvAUX(sstr);
10145 struct xpvhv_aux * const daux = HvAUX(dstr);
10146 /* This flag isn't copied. */
10147 /* SvOOK_on(hv) attacks the IV flags. */
10148 SvFLAGS(dstr) |= SVf_OOK;
10150 hvname = saux->xhv_name;
10151 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10153 daux->xhv_riter = saux->xhv_riter;
10154 daux->xhv_eiter = saux->xhv_eiter
10155 ? he_dup(saux->xhv_eiter,
10156 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10157 daux->xhv_backreferences =
10158 saux->xhv_backreferences
10159 ? (AV*) SvREFCNT_inc(
10160 sv_dup((SV*)saux->xhv_backreferences, param))
10162 /* Record stashes for possible cloning in Perl_clone(). */
10164 av_push(param->stashes, dstr);
10168 HvARRAY((HV*)dstr) = NULL;
10171 if (!(param->flags & CLONEf_COPY_STACKS)) {
10175 /* NOTE: not refcounted */
10176 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10178 if (!CvISXSUB(dstr))
10179 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10181 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10182 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10183 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10184 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10186 /* don't dup if copying back - CvGV isn't refcounted, so the
10187 * duped GV may never be freed. A bit of a hack! DAPM */
10188 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10189 NULL : gv_dup(CvGV(dstr), param) ;
10190 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10192 CvWEAKOUTSIDE(sstr)
10193 ? cv_dup( CvOUTSIDE(dstr), param)
10194 : cv_dup_inc(CvOUTSIDE(dstr), param);
10195 if (!CvISXSUB(dstr))
10196 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10202 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10208 /* duplicate a context */
10211 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10213 PERL_CONTEXT *ncxs;
10216 return (PERL_CONTEXT*)NULL;
10218 /* look for it in the table first */
10219 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10223 /* create anew and remember what it is */
10224 Newxz(ncxs, max + 1, PERL_CONTEXT);
10225 ptr_table_store(PL_ptr_table, cxs, ncxs);
10228 PERL_CONTEXT * const cx = &cxs[ix];
10229 PERL_CONTEXT * const ncx = &ncxs[ix];
10230 ncx->cx_type = cx->cx_type;
10231 if (CxTYPE(cx) == CXt_SUBST) {
10232 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10235 ncx->blk_oldsp = cx->blk_oldsp;
10236 ncx->blk_oldcop = cx->blk_oldcop;
10237 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10238 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10239 ncx->blk_oldpm = cx->blk_oldpm;
10240 ncx->blk_gimme = cx->blk_gimme;
10241 switch (CxTYPE(cx)) {
10243 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10244 ? cv_dup_inc(cx->blk_sub.cv, param)
10245 : cv_dup(cx->blk_sub.cv,param));
10246 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10247 ? av_dup_inc(cx->blk_sub.argarray, param)
10249 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10250 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10251 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10252 ncx->blk_sub.lval = cx->blk_sub.lval;
10253 ncx->blk_sub.retop = cx->blk_sub.retop;
10254 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10255 cx->blk_sub.oldcomppad);
10258 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10259 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10260 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10261 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10262 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10263 ncx->blk_eval.retop = cx->blk_eval.retop;
10266 ncx->blk_loop.label = cx->blk_loop.label;
10267 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10268 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10269 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10270 ? cx->blk_loop.iterdata
10271 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10272 ncx->blk_loop.oldcomppad
10273 = (PAD*)ptr_table_fetch(PL_ptr_table,
10274 cx->blk_loop.oldcomppad);
10275 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10276 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10277 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10278 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10279 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10282 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10283 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10284 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10285 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10286 ncx->blk_sub.retop = cx->blk_sub.retop;
10298 /* duplicate a stack info structure */
10301 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10306 return (PERL_SI*)NULL;
10308 /* look for it in the table first */
10309 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10313 /* create anew and remember what it is */
10314 Newxz(nsi, 1, PERL_SI);
10315 ptr_table_store(PL_ptr_table, si, nsi);
10317 nsi->si_stack = av_dup_inc(si->si_stack, param);
10318 nsi->si_cxix = si->si_cxix;
10319 nsi->si_cxmax = si->si_cxmax;
10320 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10321 nsi->si_type = si->si_type;
10322 nsi->si_prev = si_dup(si->si_prev, param);
10323 nsi->si_next = si_dup(si->si_next, param);
10324 nsi->si_markoff = si->si_markoff;
10329 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10330 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10331 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10332 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10333 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10334 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10335 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10336 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10337 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10338 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10339 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10340 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10341 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10342 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10345 #define pv_dup_inc(p) SAVEPV(p)
10346 #define pv_dup(p) SAVEPV(p)
10347 #define svp_dup_inc(p,pp) any_dup(p,pp)
10349 /* map any object to the new equivent - either something in the
10350 * ptr table, or something in the interpreter structure
10354 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10359 return (void*)NULL;
10361 /* look for it in the table first */
10362 ret = ptr_table_fetch(PL_ptr_table, v);
10366 /* see if it is part of the interpreter structure */
10367 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10368 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10376 /* duplicate the save stack */
10379 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10382 ANY * const ss = proto_perl->Tsavestack;
10383 const I32 max = proto_perl->Tsavestack_max;
10384 I32 ix = proto_perl->Tsavestack_ix;
10397 void (*dptr) (void*);
10398 void (*dxptr) (pTHX_ void*);
10400 Newxz(nss, max, ANY);
10403 const I32 type = POPINT(ss,ix);
10404 TOPINT(nss,ix) = type;
10406 case SAVEt_HELEM: /* hash element */
10407 sv = (SV*)POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10410 case SAVEt_ITEM: /* normal string */
10411 case SAVEt_SV: /* scalar reference */
10412 sv = (SV*)POPPTR(ss,ix);
10413 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10416 case SAVEt_MORTALIZESV:
10417 sv = (SV*)POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10420 case SAVEt_SHARED_PVREF: /* char* in shared space */
10421 c = (char*)POPPTR(ss,ix);
10422 TOPPTR(nss,ix) = savesharedpv(c);
10423 ptr = POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10426 case SAVEt_GENERIC_SVREF: /* generic sv */
10427 case SAVEt_SVREF: /* scalar reference */
10428 sv = (SV*)POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10430 ptr = POPPTR(ss,ix);
10431 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10433 case SAVEt_HV: /* hash reference */
10434 case SAVEt_AV: /* array reference */
10435 sv = (SV*) POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10438 case SAVEt_COMPPAD:
10440 sv = (SV*) POPPTR(ss,ix);
10441 TOPPTR(nss,ix) = sv_dup(sv, param);
10443 case SAVEt_INT: /* int reference */
10444 ptr = POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 intval = (int)POPINT(ss,ix);
10447 TOPINT(nss,ix) = intval;
10449 case SAVEt_LONG: /* long reference */
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10453 case SAVEt_CLEARSV:
10454 longval = (long)POPLONG(ss,ix);
10455 TOPLONG(nss,ix) = longval;
10457 case SAVEt_I32: /* I32 reference */
10458 case SAVEt_I16: /* I16 reference */
10459 case SAVEt_I8: /* I8 reference */
10460 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 TOPINT(nss,ix) = i;
10466 case SAVEt_IV: /* IV reference */
10467 ptr = POPPTR(ss,ix);
10468 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10470 TOPIV(nss,ix) = iv;
10472 case SAVEt_HPTR: /* HV* reference */
10473 case SAVEt_APTR: /* AV* reference */
10474 case SAVEt_SPTR: /* SV* reference */
10475 ptr = POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 sv = (SV*)POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = sv_dup(sv, param);
10480 case SAVEt_VPTR: /* random* reference */
10481 ptr = POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10483 ptr = POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 case SAVEt_GENERIC_PVREF: /* generic char* */
10487 case SAVEt_PPTR: /* char* reference */
10488 ptr = POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10490 c = (char*)POPPTR(ss,ix);
10491 TOPPTR(nss,ix) = pv_dup(c);
10493 case SAVEt_GP: /* scalar reference */
10494 gp = (GP*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10496 (void)GpREFCNT_inc(gp);
10497 gv = (GV*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10501 ptr = POPPTR(ss,ix);
10502 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10503 /* these are assumed to be refcounted properly */
10505 switch (((OP*)ptr)->op_type) {
10507 case OP_LEAVESUBLV:
10511 case OP_LEAVEWRITE:
10512 TOPPTR(nss,ix) = ptr;
10519 TOPPTR(nss,ix) = NULL;
10524 TOPPTR(nss,ix) = NULL;
10527 c = (char*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = pv_dup_inc(c);
10531 hv = (HV*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10533 c = (char*)POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = pv_dup_inc(c);
10536 case SAVEt_STACK_POS: /* Position on Perl stack */
10538 TOPINT(nss,ix) = i;
10540 case SAVEt_DESTRUCTOR:
10541 ptr = POPPTR(ss,ix);
10542 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10543 dptr = POPDPTR(ss,ix);
10544 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10545 any_dup(FPTR2DPTR(void *, dptr),
10548 case SAVEt_DESTRUCTOR_X:
10549 ptr = POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10551 dxptr = POPDXPTR(ss,ix);
10552 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10553 any_dup(FPTR2DPTR(void *, dxptr),
10556 case SAVEt_REGCONTEXT:
10559 TOPINT(nss,ix) = i;
10562 case SAVEt_AELEM: /* array element */
10563 sv = (SV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10566 TOPINT(nss,ix) = i;
10567 av = (AV*)POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = av_dup_inc(av, param);
10571 ptr = POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = ptr;
10576 TOPINT(nss,ix) = i;
10577 ptr = POPPTR(ss,ix);
10580 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10581 HINTS_REFCNT_UNLOCK;
10583 TOPPTR(nss,ix) = ptr;
10584 if (i & HINT_LOCALIZE_HH) {
10585 hv = (HV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10590 longval = (long)POPLONG(ss,ix);
10591 TOPLONG(nss,ix) = longval;
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10594 sv = (SV*)POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = sv_dup(sv, param);
10598 ptr = POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600 longval = (long)POPBOOL(ss,ix);
10601 TOPBOOL(nss,ix) = (bool)longval;
10603 case SAVEt_SET_SVFLAGS:
10605 TOPINT(nss,ix) = i;
10607 TOPINT(nss,ix) = i;
10608 sv = (SV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = sv_dup(sv, param);
10611 case SAVEt_RE_STATE:
10613 const struct re_save_state *const old_state
10614 = (struct re_save_state *)
10615 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10616 struct re_save_state *const new_state
10617 = (struct re_save_state *)
10618 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10620 Copy(old_state, new_state, 1, struct re_save_state);
10621 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10623 new_state->re_state_bostr
10624 = pv_dup(old_state->re_state_bostr);
10625 new_state->re_state_reginput
10626 = pv_dup(old_state->re_state_reginput);
10627 new_state->re_state_regeol
10628 = pv_dup(old_state->re_state_regeol);
10629 new_state->re_state_regstartp
10630 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10631 new_state->re_state_regendp
10632 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10633 new_state->re_state_reglastparen
10634 = (U32*) any_dup(old_state->re_state_reglastparen,
10636 new_state->re_state_reglastcloseparen
10637 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10639 /* XXX This just has to be broken. The old save_re_context
10640 code did SAVEGENERICPV(PL_reg_start_tmp);
10641 PL_reg_start_tmp is char **.
10642 Look above to what the dup code does for
10643 SAVEt_GENERIC_PVREF
10644 It can never have worked.
10645 So this is merely a faithful copy of the exiting bug: */
10646 new_state->re_state_reg_start_tmp
10647 = (char **) pv_dup((char *)
10648 old_state->re_state_reg_start_tmp);
10649 /* I assume that it only ever "worked" because no-one called
10650 (pseudo)fork while the regexp engine had re-entered itself.
10652 #ifdef PERL_OLD_COPY_ON_WRITE
10653 new_state->re_state_nrs
10654 = sv_dup(old_state->re_state_nrs, param);
10656 new_state->re_state_reg_magic
10657 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10659 new_state->re_state_reg_oldcurpm
10660 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10662 new_state->re_state_reg_curpm
10663 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10665 new_state->re_state_reg_oldsaved
10666 = pv_dup(old_state->re_state_reg_oldsaved);
10667 new_state->re_state_reg_poscache
10668 = pv_dup(old_state->re_state_reg_poscache);
10669 new_state->re_state_reg_starttry
10670 = pv_dup(old_state->re_state_reg_starttry);
10673 case SAVEt_COMPILE_WARNINGS:
10674 ptr = POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10678 ptr = POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = parser_dup(ptr, param);
10683 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10691 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10692 * flag to the result. This is done for each stash before cloning starts,
10693 * so we know which stashes want their objects cloned */
10696 do_mark_cloneable_stash(pTHX_ SV *sv)
10698 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10700 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10701 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10702 if (cloner && GvCV(cloner)) {
10709 XPUSHs(sv_2mortal(newSVhek(hvname)));
10711 call_sv((SV*)GvCV(cloner), G_SCALAR);
10718 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10726 =for apidoc perl_clone
10728 Create and return a new interpreter by cloning the current one.
10730 perl_clone takes these flags as parameters:
10732 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10733 without it we only clone the data and zero the stacks,
10734 with it we copy the stacks and the new perl interpreter is
10735 ready to run at the exact same point as the previous one.
10736 The pseudo-fork code uses COPY_STACKS while the
10737 threads->new doesn't.
10739 CLONEf_KEEP_PTR_TABLE
10740 perl_clone keeps a ptr_table with the pointer of the old
10741 variable as a key and the new variable as a value,
10742 this allows it to check if something has been cloned and not
10743 clone it again but rather just use the value and increase the
10744 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10745 the ptr_table using the function
10746 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10747 reason to keep it around is if you want to dup some of your own
10748 variable who are outside the graph perl scans, example of this
10749 code is in threads.xs create
10752 This is a win32 thing, it is ignored on unix, it tells perls
10753 win32host code (which is c++) to clone itself, this is needed on
10754 win32 if you want to run two threads at the same time,
10755 if you just want to do some stuff in a separate perl interpreter
10756 and then throw it away and return to the original one,
10757 you don't need to do anything.
10762 /* XXX the above needs expanding by someone who actually understands it ! */
10763 EXTERN_C PerlInterpreter *
10764 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10767 perl_clone(PerlInterpreter *proto_perl, UV flags)
10770 #ifdef PERL_IMPLICIT_SYS
10772 /* perlhost.h so we need to call into it
10773 to clone the host, CPerlHost should have a c interface, sky */
10775 if (flags & CLONEf_CLONE_HOST) {
10776 return perl_clone_host(proto_perl,flags);
10778 return perl_clone_using(proto_perl, flags,
10780 proto_perl->IMemShared,
10781 proto_perl->IMemParse,
10783 proto_perl->IStdIO,
10787 proto_perl->IProc);
10791 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10792 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10793 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10794 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10795 struct IPerlDir* ipD, struct IPerlSock* ipS,
10796 struct IPerlProc* ipP)
10798 /* XXX many of the string copies here can be optimized if they're
10799 * constants; they need to be allocated as common memory and just
10800 * their pointers copied. */
10803 CLONE_PARAMS clone_params;
10804 CLONE_PARAMS* const param = &clone_params;
10806 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10807 /* for each stash, determine whether its objects should be cloned */
10808 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10809 PERL_SET_THX(my_perl);
10812 PoisonNew(my_perl, 1, PerlInterpreter);
10818 PL_savestack_ix = 0;
10819 PL_savestack_max = -1;
10820 PL_sig_pending = 0;
10821 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10822 # else /* !DEBUGGING */
10823 Zero(my_perl, 1, PerlInterpreter);
10824 # endif /* DEBUGGING */
10826 /* host pointers */
10828 PL_MemShared = ipMS;
10829 PL_MemParse = ipMP;
10836 #else /* !PERL_IMPLICIT_SYS */
10838 CLONE_PARAMS clone_params;
10839 CLONE_PARAMS* param = &clone_params;
10840 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10841 /* for each stash, determine whether its objects should be cloned */
10842 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10843 PERL_SET_THX(my_perl);
10846 PoisonNew(my_perl, 1, PerlInterpreter);
10852 PL_savestack_ix = 0;
10853 PL_savestack_max = -1;
10854 PL_sig_pending = 0;
10855 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10856 # else /* !DEBUGGING */
10857 Zero(my_perl, 1, PerlInterpreter);
10858 # endif /* DEBUGGING */
10859 #endif /* PERL_IMPLICIT_SYS */
10860 param->flags = flags;
10861 param->proto_perl = proto_perl;
10863 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10865 PL_body_arenas = NULL;
10866 Zero(&PL_body_roots, 1, PL_body_roots);
10868 PL_nice_chunk = NULL;
10869 PL_nice_chunk_size = 0;
10871 PL_sv_objcount = 0;
10873 PL_sv_arenaroot = NULL;
10875 PL_debug = proto_perl->Idebug;
10877 PL_hash_seed = proto_perl->Ihash_seed;
10878 PL_rehash_seed = proto_perl->Irehash_seed;
10880 #ifdef USE_REENTRANT_API
10881 /* XXX: things like -Dm will segfault here in perlio, but doing
10882 * PERL_SET_CONTEXT(proto_perl);
10883 * breaks too many other things
10885 Perl_reentrant_init(aTHX);
10888 /* create SV map for pointer relocation */
10889 PL_ptr_table = ptr_table_new();
10891 /* initialize these special pointers as early as possible */
10892 SvANY(&PL_sv_undef) = NULL;
10893 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10894 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10895 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10897 SvANY(&PL_sv_no) = new_XPVNV();
10898 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10899 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10900 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10901 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10902 SvCUR_set(&PL_sv_no, 0);
10903 SvLEN_set(&PL_sv_no, 1);
10904 SvIV_set(&PL_sv_no, 0);
10905 SvNV_set(&PL_sv_no, 0);
10906 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10908 SvANY(&PL_sv_yes) = new_XPVNV();
10909 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10910 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10911 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10912 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10913 SvCUR_set(&PL_sv_yes, 1);
10914 SvLEN_set(&PL_sv_yes, 2);
10915 SvIV_set(&PL_sv_yes, 1);
10916 SvNV_set(&PL_sv_yes, 1);
10917 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10919 /* create (a non-shared!) shared string table */
10920 PL_strtab = newHV();
10921 HvSHAREKEYS_off(PL_strtab);
10922 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10923 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10925 PL_compiling = proto_perl->Icompiling;
10927 /* These two PVs will be free'd special way so must set them same way op.c does */
10928 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10929 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10931 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10932 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10934 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10935 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10936 if (PL_compiling.cop_hints_hash) {
10938 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10939 HINTS_REFCNT_UNLOCK;
10941 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10943 /* pseudo environmental stuff */
10944 PL_origargc = proto_perl->Iorigargc;
10945 PL_origargv = proto_perl->Iorigargv;
10947 param->stashes = newAV(); /* Setup array of objects to call clone on */
10949 /* Set tainting stuff before PerlIO_debug can possibly get called */
10950 PL_tainting = proto_perl->Itainting;
10951 PL_taint_warn = proto_perl->Itaint_warn;
10953 #ifdef PERLIO_LAYERS
10954 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10955 PerlIO_clone(aTHX_ proto_perl, param);
10958 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10959 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10960 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10961 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10962 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10963 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10966 PL_minus_c = proto_perl->Iminus_c;
10967 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10968 PL_localpatches = proto_perl->Ilocalpatches;
10969 PL_splitstr = proto_perl->Isplitstr;
10970 PL_preprocess = proto_perl->Ipreprocess;
10971 PL_minus_n = proto_perl->Iminus_n;
10972 PL_minus_p = proto_perl->Iminus_p;
10973 PL_minus_l = proto_perl->Iminus_l;
10974 PL_minus_a = proto_perl->Iminus_a;
10975 PL_minus_E = proto_perl->Iminus_E;
10976 PL_minus_F = proto_perl->Iminus_F;
10977 PL_doswitches = proto_perl->Idoswitches;
10978 PL_dowarn = proto_perl->Idowarn;
10979 PL_doextract = proto_perl->Idoextract;
10980 PL_sawampersand = proto_perl->Isawampersand;
10981 PL_unsafe = proto_perl->Iunsafe;
10982 PL_inplace = SAVEPV(proto_perl->Iinplace);
10983 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10984 PL_perldb = proto_perl->Iperldb;
10985 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10986 PL_exit_flags = proto_perl->Iexit_flags;
10988 /* magical thingies */
10989 /* XXX time(&PL_basetime) when asked for? */
10990 PL_basetime = proto_perl->Ibasetime;
10991 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10993 PL_maxsysfd = proto_perl->Imaxsysfd;
10994 PL_statusvalue = proto_perl->Istatusvalue;
10996 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10998 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11000 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11002 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11003 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11004 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11007 /* RE engine related */
11008 Zero(&PL_reg_state, 1, struct re_save_state);
11009 PL_reginterp_cnt = 0;
11010 PL_regmatch_slab = NULL;
11012 /* Clone the regex array */
11013 PL_regex_padav = newAV();
11015 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11016 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11018 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11019 for(i = 1; i <= len; i++) {
11020 const SV * const regex = regexen[i];
11023 ? sv_dup_inc(regex, param)
11025 newSViv(PTR2IV(CALLREGDUPE(
11026 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11028 if (SvFLAGS(regex) & SVf_BREAK)
11029 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11030 av_push(PL_regex_padav, sv);
11033 PL_regex_pad = AvARRAY(PL_regex_padav);
11035 /* shortcuts to various I/O objects */
11036 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11037 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11038 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11039 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11040 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11041 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11043 /* shortcuts to regexp stuff */
11044 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11046 /* shortcuts to misc objects */
11047 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11049 /* shortcuts to debugging objects */
11050 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11051 PL_DBline = gv_dup(proto_perl->IDBline, param);
11052 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11053 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11054 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11055 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11056 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11057 PL_lineary = av_dup(proto_perl->Ilineary, param);
11058 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11060 /* symbol tables */
11061 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11062 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11063 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11064 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11065 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11067 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11068 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11069 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11070 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11071 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11072 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11073 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11074 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11076 PL_sub_generation = proto_perl->Isub_generation;
11078 /* funky return mechanisms */
11079 PL_forkprocess = proto_perl->Iforkprocess;
11081 /* subprocess state */
11082 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11084 /* internal state */
11085 PL_maxo = proto_perl->Imaxo;
11086 if (proto_perl->Iop_mask)
11087 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11090 /* PL_asserting = proto_perl->Iasserting; */
11092 /* current interpreter roots */
11093 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11095 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11097 PL_main_start = proto_perl->Imain_start;
11098 PL_eval_root = proto_perl->Ieval_root;
11099 PL_eval_start = proto_perl->Ieval_start;
11101 /* runtime control stuff */
11102 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11103 PL_copline = proto_perl->Icopline;
11105 PL_filemode = proto_perl->Ifilemode;
11106 PL_lastfd = proto_perl->Ilastfd;
11107 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11110 PL_gensym = proto_perl->Igensym;
11111 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11112 PL_laststatval = proto_perl->Ilaststatval;
11113 PL_laststype = proto_perl->Ilaststype;
11116 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11118 /* interpreter atexit processing */
11119 PL_exitlistlen = proto_perl->Iexitlistlen;
11120 if (PL_exitlistlen) {
11121 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11122 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11125 PL_exitlist = (PerlExitListEntry*)NULL;
11127 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11128 if (PL_my_cxt_size) {
11129 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11130 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11131 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11132 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11133 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11137 PL_my_cxt_list = (void**)NULL;
11138 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11139 PL_my_cxt_keys = (void**)NULL;
11142 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11143 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11144 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11146 PL_profiledata = NULL;
11147 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11148 /* PL_rsfp_filters entries have fake IoDIRP() */
11149 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11151 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11153 PAD_CLONE_VARS(proto_perl, param);
11155 #ifdef HAVE_INTERP_INTERN
11156 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11159 /* more statics moved here */
11160 PL_generation = proto_perl->Igeneration;
11161 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11163 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11164 PL_in_clean_all = proto_perl->Iin_clean_all;
11166 PL_uid = proto_perl->Iuid;
11167 PL_euid = proto_perl->Ieuid;
11168 PL_gid = proto_perl->Igid;
11169 PL_egid = proto_perl->Iegid;
11170 PL_nomemok = proto_perl->Inomemok;
11171 PL_an = proto_perl->Ian;
11172 PL_evalseq = proto_perl->Ievalseq;
11173 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11174 PL_origalen = proto_perl->Iorigalen;
11175 #ifdef PERL_USES_PL_PIDSTATUS
11176 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11178 PL_osname = SAVEPV(proto_perl->Iosname);
11179 PL_sighandlerp = proto_perl->Isighandlerp;
11181 PL_runops = proto_perl->Irunops;
11183 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11186 PL_cshlen = proto_perl->Icshlen;
11187 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11190 PL_parser = parser_dup(proto_perl->Iparser, param);
11192 PL_lex_state = proto_perl->Ilex_state;
11195 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11196 PL_curforce = proto_perl->Icurforce;
11198 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11199 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11200 PL_nexttoke = proto_perl->Inexttoke;
11203 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11204 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11205 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11206 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11207 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11208 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11209 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11210 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11211 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11214 PL_expect = proto_perl->Iexpect;
11216 PL_multi_end = proto_perl->Imulti_end;
11218 PL_error_count = proto_perl->Ierror_count;
11219 PL_subline = proto_perl->Isubline;
11220 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11222 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11223 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11224 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11225 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11226 PL_last_lop_op = proto_perl->Ilast_lop_op;
11227 PL_in_my = proto_perl->Iin_my;
11228 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11230 PL_cryptseen = proto_perl->Icryptseen;
11233 PL_hints = proto_perl->Ihints;
11235 PL_amagic_generation = proto_perl->Iamagic_generation;
11237 #ifdef USE_LOCALE_COLLATE
11238 PL_collation_ix = proto_perl->Icollation_ix;
11239 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11240 PL_collation_standard = proto_perl->Icollation_standard;
11241 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11242 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11243 #endif /* USE_LOCALE_COLLATE */
11245 #ifdef USE_LOCALE_NUMERIC
11246 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11247 PL_numeric_standard = proto_perl->Inumeric_standard;
11248 PL_numeric_local = proto_perl->Inumeric_local;
11249 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11250 #endif /* !USE_LOCALE_NUMERIC */
11252 /* utf8 character classes */
11253 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11254 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11255 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11256 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11257 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11258 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11259 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11260 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11261 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11262 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11263 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11264 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11265 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11266 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11267 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11268 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11269 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11270 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11271 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11272 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11274 /* Did the locale setup indicate UTF-8? */
11275 PL_utf8locale = proto_perl->Iutf8locale;
11276 /* Unicode features (see perlrun/-C) */
11277 PL_unicode = proto_perl->Iunicode;
11279 /* Pre-5.8 signals control */
11280 PL_signals = proto_perl->Isignals;
11282 /* times() ticks per second */
11283 PL_clocktick = proto_perl->Iclocktick;
11285 /* Recursion stopper for PerlIO_find_layer */
11286 PL_in_load_module = proto_perl->Iin_load_module;
11288 /* sort() routine */
11289 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11291 /* Not really needed/useful since the reenrant_retint is "volatile",
11292 * but do it for consistency's sake. */
11293 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11295 /* Hooks to shared SVs and locks. */
11296 PL_sharehook = proto_perl->Isharehook;
11297 PL_lockhook = proto_perl->Ilockhook;
11298 PL_unlockhook = proto_perl->Iunlockhook;
11299 PL_threadhook = proto_perl->Ithreadhook;
11301 PL_runops_std = proto_perl->Irunops_std;
11302 PL_runops_dbg = proto_perl->Irunops_dbg;
11304 #ifdef THREADS_HAVE_PIDS
11305 PL_ppid = proto_perl->Ippid;
11309 PL_last_swash_hv = NULL; /* reinits on demand */
11310 PL_last_swash_klen = 0;
11311 PL_last_swash_key[0]= '\0';
11312 PL_last_swash_tmps = (U8*)NULL;
11313 PL_last_swash_slen = 0;
11315 PL_glob_index = proto_perl->Iglob_index;
11316 PL_srand_called = proto_perl->Isrand_called;
11317 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11318 PL_bitcount = NULL; /* reinits on demand */
11320 if (proto_perl->Ipsig_pend) {
11321 Newxz(PL_psig_pend, SIG_SIZE, int);
11324 PL_psig_pend = (int*)NULL;
11327 if (proto_perl->Ipsig_ptr) {
11328 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11329 Newxz(PL_psig_name, SIG_SIZE, SV*);
11330 for (i = 1; i < SIG_SIZE; i++) {
11331 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11332 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11336 PL_psig_ptr = (SV**)NULL;
11337 PL_psig_name = (SV**)NULL;
11340 /* thrdvar.h stuff */
11342 if (flags & CLONEf_COPY_STACKS) {
11343 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11344 PL_tmps_ix = proto_perl->Ttmps_ix;
11345 PL_tmps_max = proto_perl->Ttmps_max;
11346 PL_tmps_floor = proto_perl->Ttmps_floor;
11347 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11349 while (i <= PL_tmps_ix) {
11350 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11354 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11355 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11356 Newxz(PL_markstack, i, I32);
11357 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11358 - proto_perl->Tmarkstack);
11359 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11360 - proto_perl->Tmarkstack);
11361 Copy(proto_perl->Tmarkstack, PL_markstack,
11362 PL_markstack_ptr - PL_markstack + 1, I32);
11364 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11365 * NOTE: unlike the others! */
11366 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11367 PL_scopestack_max = proto_perl->Tscopestack_max;
11368 Newxz(PL_scopestack, PL_scopestack_max, I32);
11369 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11371 /* NOTE: si_dup() looks at PL_markstack */
11372 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11374 /* PL_curstack = PL_curstackinfo->si_stack; */
11375 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11376 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11378 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11379 PL_stack_base = AvARRAY(PL_curstack);
11380 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11381 - proto_perl->Tstack_base);
11382 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11384 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11385 * NOTE: unlike the others! */
11386 PL_savestack_ix = proto_perl->Tsavestack_ix;
11387 PL_savestack_max = proto_perl->Tsavestack_max;
11388 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11389 PL_savestack = ss_dup(proto_perl, param);
11393 ENTER; /* perl_destruct() wants to LEAVE; */
11395 /* although we're not duplicating the tmps stack, we should still
11396 * add entries for any SVs on the tmps stack that got cloned by a
11397 * non-refcount means (eg a temp in @_); otherwise they will be
11400 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11401 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11402 proto_perl->Ttmps_stack[i]);
11403 if (nsv && !SvREFCNT(nsv)) {
11405 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11410 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11411 PL_top_env = &PL_start_env;
11413 PL_op = proto_perl->Top;
11416 PL_Xpv = (XPV*)NULL;
11417 PL_na = proto_perl->Tna;
11419 PL_statbuf = proto_perl->Tstatbuf;
11420 PL_statcache = proto_perl->Tstatcache;
11421 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11422 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11424 PL_timesbuf = proto_perl->Ttimesbuf;
11427 PL_tainted = proto_perl->Ttainted;
11428 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11429 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11430 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11431 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11432 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11433 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11434 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11435 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11436 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11438 PL_restartop = proto_perl->Trestartop;
11439 PL_in_eval = proto_perl->Tin_eval;
11440 PL_delaymagic = proto_perl->Tdelaymagic;
11441 PL_dirty = proto_perl->Tdirty;
11442 PL_localizing = proto_perl->Tlocalizing;
11444 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11445 PL_hv_fetch_ent_mh = NULL;
11446 PL_modcount = proto_perl->Tmodcount;
11447 PL_lastgotoprobe = NULL;
11448 PL_dumpindent = proto_perl->Tdumpindent;
11450 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11451 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11452 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11453 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11454 PL_efloatbuf = NULL; /* reinits on demand */
11455 PL_efloatsize = 0; /* reinits on demand */
11459 PL_screamfirst = NULL;
11460 PL_screamnext = NULL;
11461 PL_maxscream = -1; /* reinits on demand */
11462 PL_lastscream = NULL;
11464 PL_watchaddr = NULL;
11467 PL_regdummy = proto_perl->Tregdummy;
11468 PL_colorset = 0; /* reinits PL_colors[] */
11469 /*PL_colors[6] = {0,0,0,0,0,0};*/
11473 /* Pluggable optimizer */
11474 PL_peepp = proto_perl->Tpeepp;
11476 PL_stashcache = newHV();
11478 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11479 ptr_table_free(PL_ptr_table);
11480 PL_ptr_table = NULL;
11483 /* Call the ->CLONE method, if it exists, for each of the stashes
11484 identified by sv_dup() above.
11486 while(av_len(param->stashes) != -1) {
11487 HV* const stash = (HV*) av_shift(param->stashes);
11488 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11489 if (cloner && GvCV(cloner)) {
11494 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11496 call_sv((SV*)GvCV(cloner), G_DISCARD);
11502 SvREFCNT_dec(param->stashes);
11504 /* orphaned? eg threads->new inside BEGIN or use */
11505 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11506 SvREFCNT_inc_simple_void(PL_compcv);
11507 SAVEFREESV(PL_compcv);
11513 #endif /* USE_ITHREADS */
11516 =head1 Unicode Support
11518 =for apidoc sv_recode_to_utf8
11520 The encoding is assumed to be an Encode object, on entry the PV
11521 of the sv is assumed to be octets in that encoding, and the sv
11522 will be converted into Unicode (and UTF-8).
11524 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11525 is not a reference, nothing is done to the sv. If the encoding is not
11526 an C<Encode::XS> Encoding object, bad things will happen.
11527 (See F<lib/encoding.pm> and L<Encode>).
11529 The PV of the sv is returned.
11534 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11537 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11551 Passing sv_yes is wrong - it needs to be or'ed set of constants
11552 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11553 remove converted chars from source.
11555 Both will default the value - let them.
11557 XPUSHs(&PL_sv_yes);
11560 call_method("decode", G_SCALAR);
11564 s = SvPV_const(uni, len);
11565 if (s != SvPVX_const(sv)) {
11566 SvGROW(sv, len + 1);
11567 Move(s, SvPVX(sv), len + 1, char);
11568 SvCUR_set(sv, len);
11575 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11579 =for apidoc sv_cat_decode
11581 The encoding is assumed to be an Encode object, the PV of the ssv is
11582 assumed to be octets in that encoding and decoding the input starts
11583 from the position which (PV + *offset) pointed to. The dsv will be
11584 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11585 when the string tstr appears in decoding output or the input ends on
11586 the PV of the ssv. The value which the offset points will be modified
11587 to the last input position on the ssv.
11589 Returns TRUE if the terminator was found, else returns FALSE.
11594 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11595 SV *ssv, int *offset, char *tstr, int tlen)
11599 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11610 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11611 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11613 call_method("cat_decode", G_SCALAR);
11615 ret = SvTRUE(TOPs);
11616 *offset = SvIV(offsv);
11622 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11627 /* ---------------------------------------------------------------------
11629 * support functions for report_uninit()
11632 /* the maxiumum size of array or hash where we will scan looking
11633 * for the undefined element that triggered the warning */
11635 #define FUV_MAX_SEARCH_SIZE 1000
11637 /* Look for an entry in the hash whose value has the same SV as val;
11638 * If so, return a mortal copy of the key. */
11641 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11644 register HE **array;
11647 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11648 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11651 array = HvARRAY(hv);
11653 for (i=HvMAX(hv); i>0; i--) {
11654 register HE *entry;
11655 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11656 if (HeVAL(entry) != val)
11658 if ( HeVAL(entry) == &PL_sv_undef ||
11659 HeVAL(entry) == &PL_sv_placeholder)
11663 if (HeKLEN(entry) == HEf_SVKEY)
11664 return sv_mortalcopy(HeKEY_sv(entry));
11665 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11671 /* Look for an entry in the array whose value has the same SV as val;
11672 * If so, return the index, otherwise return -1. */
11675 S_find_array_subscript(pTHX_ AV *av, SV* val)
11678 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11679 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11682 if (val != &PL_sv_undef) {
11683 SV ** const svp = AvARRAY(av);
11686 for (i=AvFILLp(av); i>=0; i--)
11693 /* S_varname(): return the name of a variable, optionally with a subscript.
11694 * If gv is non-zero, use the name of that global, along with gvtype (one
11695 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11696 * targ. Depending on the value of the subscript_type flag, return:
11699 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11700 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11701 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11702 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11705 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11706 SV* keyname, I32 aindex, int subscript_type)
11709 SV * const name = sv_newmortal();
11712 buffer[0] = gvtype;
11715 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11717 gv_fullname4(name, gv, buffer, 0);
11719 if ((unsigned int)SvPVX(name)[1] <= 26) {
11721 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11723 /* Swap the 1 unprintable control character for the 2 byte pretty
11724 version - ie substr($name, 1, 1) = $buffer; */
11725 sv_insert(name, 1, 1, buffer, 2);
11730 CV * const cv = find_runcv(&unused);
11734 if (!cv || !CvPADLIST(cv))
11736 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11737 sv = *av_fetch(av, targ, FALSE);
11738 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11741 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11742 SV * const sv = newSV(0);
11743 *SvPVX(name) = '$';
11744 Perl_sv_catpvf(aTHX_ name, "{%s}",
11745 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11748 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11749 *SvPVX(name) = '$';
11750 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11752 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11753 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11760 =for apidoc find_uninit_var
11762 Find the name of the undefined variable (if any) that caused the operator o
11763 to issue a "Use of uninitialized value" warning.
11764 If match is true, only return a name if it's value matches uninit_sv.
11765 So roughly speaking, if a unary operator (such as OP_COS) generates a
11766 warning, then following the direct child of the op may yield an
11767 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11768 other hand, with OP_ADD there are two branches to follow, so we only print
11769 the variable name if we get an exact match.
11771 The name is returned as a mortal SV.
11773 Assumes that PL_op is the op that originally triggered the error, and that
11774 PL_comppad/PL_curpad points to the currently executing pad.
11780 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11788 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11789 uninit_sv == &PL_sv_placeholder)))
11792 switch (obase->op_type) {
11799 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11800 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11803 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11805 if (pad) { /* @lex, %lex */
11806 sv = PAD_SVl(obase->op_targ);
11810 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11811 /* @global, %global */
11812 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11815 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11817 else /* @{expr}, %{expr} */
11818 return find_uninit_var(cUNOPx(obase)->op_first,
11822 /* attempt to find a match within the aggregate */
11824 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11826 subscript_type = FUV_SUBSCRIPT_HASH;
11829 index = find_array_subscript((AV*)sv, uninit_sv);
11831 subscript_type = FUV_SUBSCRIPT_ARRAY;
11834 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11837 return varname(gv, hash ? '%' : '@', obase->op_targ,
11838 keysv, index, subscript_type);
11842 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11844 return varname(NULL, '$', obase->op_targ,
11845 NULL, 0, FUV_SUBSCRIPT_NONE);
11848 gv = cGVOPx_gv(obase);
11849 if (!gv || (match && GvSV(gv) != uninit_sv))
11851 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11854 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11857 av = (AV*)PAD_SV(obase->op_targ);
11858 if (!av || SvRMAGICAL(av))
11860 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11861 if (!svp || *svp != uninit_sv)
11864 return varname(NULL, '$', obase->op_targ,
11865 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11868 gv = cGVOPx_gv(obase);
11874 if (!av || SvRMAGICAL(av))
11876 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11877 if (!svp || *svp != uninit_sv)
11880 return varname(gv, '$', 0,
11881 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11886 o = cUNOPx(obase)->op_first;
11887 if (!o || o->op_type != OP_NULL ||
11888 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11890 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11894 if (PL_op == obase)
11895 /* $a[uninit_expr] or $h{uninit_expr} */
11896 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11899 o = cBINOPx(obase)->op_first;
11900 kid = cBINOPx(obase)->op_last;
11902 /* get the av or hv, and optionally the gv */
11904 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11905 sv = PAD_SV(o->op_targ);
11907 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11908 && cUNOPo->op_first->op_type == OP_GV)
11910 gv = cGVOPx_gv(cUNOPo->op_first);
11913 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11918 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11919 /* index is constant */
11923 if (obase->op_type == OP_HELEM) {
11924 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11925 if (!he || HeVAL(he) != uninit_sv)
11929 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11930 if (!svp || *svp != uninit_sv)
11934 if (obase->op_type == OP_HELEM)
11935 return varname(gv, '%', o->op_targ,
11936 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11938 return varname(gv, '@', o->op_targ, NULL,
11939 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11942 /* index is an expression;
11943 * attempt to find a match within the aggregate */
11944 if (obase->op_type == OP_HELEM) {
11945 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11947 return varname(gv, '%', o->op_targ,
11948 keysv, 0, FUV_SUBSCRIPT_HASH);
11951 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11953 return varname(gv, '@', o->op_targ,
11954 NULL, index, FUV_SUBSCRIPT_ARRAY);
11959 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11961 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11966 /* only examine RHS */
11967 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11970 o = cUNOPx(obase)->op_first;
11971 if (o->op_type == OP_PUSHMARK)
11974 if (!o->op_sibling) {
11975 /* one-arg version of open is highly magical */
11977 if (o->op_type == OP_GV) { /* open FOO; */
11979 if (match && GvSV(gv) != uninit_sv)
11981 return varname(gv, '$', 0,
11982 NULL, 0, FUV_SUBSCRIPT_NONE);
11984 /* other possibilities not handled are:
11985 * open $x; or open my $x; should return '${*$x}'
11986 * open expr; should return '$'.expr ideally
11992 /* ops where $_ may be an implicit arg */
11996 if ( !(obase->op_flags & OPf_STACKED)) {
11997 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11998 ? PAD_SVl(obase->op_targ)
12001 sv = sv_newmortal();
12002 sv_setpvn(sv, "$_", 2);
12010 /* skip filehandle as it can't produce 'undef' warning */
12011 o = cUNOPx(obase)->op_first;
12012 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12013 o = o->op_sibling->op_sibling;
12020 match = 1; /* XS or custom code could trigger random warnings */
12025 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12026 return sv_2mortal(newSVpvs("${$/}"));
12031 if (!(obase->op_flags & OPf_KIDS))
12033 o = cUNOPx(obase)->op_first;
12039 /* if all except one arg are constant, or have no side-effects,
12040 * or are optimized away, then it's unambiguous */
12042 for (kid=o; kid; kid = kid->op_sibling) {
12044 const OPCODE type = kid->op_type;
12045 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12046 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12047 || (type == OP_PUSHMARK)
12051 if (o2) { /* more than one found */
12058 return find_uninit_var(o2, uninit_sv, match);
12060 /* scan all args */
12062 sv = find_uninit_var(o, uninit_sv, 1);
12074 =for apidoc report_uninit
12076 Print appropriate "Use of uninitialized variable" warning
12082 Perl_report_uninit(pTHX_ SV* uninit_sv)
12086 SV* varname = NULL;
12088 varname = find_uninit_var(PL_op, uninit_sv,0);
12090 sv_insert(varname, 0, 0, " ", 1);
12092 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12093 varname ? SvPV_nolen_const(varname) : "",
12094 " in ", OP_DESC(PL_op));
12097 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12103 * c-indentation-style: bsd
12104 * c-basic-offset: 4
12105 * indent-tabs-mode: t
12108 * ex: set ts=8 sts=4 sw=4 noet: