3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
62 sv, av, hv...) contains type and reference count information, and for
63 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
64 contains fields specific to each type. Some types store all they need
65 in the head, so don't have a body.
67 In all but the most memory-paranoid configuations (ex: PURIFY), heads
68 and bodies are allocated out of arenas, which by default are
69 approximately 4K chunks of memory parcelled up into N heads or bodies.
70 Sv-bodies are allocated by their sv-type, guaranteeing size
71 consistency needed to allocate safely from arrays.
73 For SV-heads, the first slot in each arena is reserved, and holds a
74 link to the next arena, some flags, and a note of the number of slots.
75 Snaked through each arena chain is a linked list of free items; when
76 this becomes empty, an extra arena is allocated and divided up into N
77 items which are threaded into the free list.
79 SV-bodies are similar, but they use arena-sets by default, which
80 separate the link and info from the arena itself, and reclaim the 1st
81 slot in the arena. SV-bodies are further described later.
83 The following global variables are associated with arenas:
85 PL_sv_arenaroot pointer to list of SV arenas
86 PL_sv_root pointer to list of free SV structures
88 PL_body_arenas head of linked-list of body arenas
89 PL_body_roots[] array of pointers to list of free bodies of svtype
90 arrays are indexed by the svtype needed
92 A few special SV heads are not allocated from an arena, but are
93 instead directly created in the interpreter structure, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 At the time of very final cleanup, sv_free_arenas() is called from
107 perl_destruct() to physically free all the arenas allocated since the
108 start of the interpreter.
110 Manipulation of any of the PL_*root pointers is protected by enclosing
111 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
112 if threads are enabled.
114 The function visit() scans the SV arenas list, and calls a specified
115 function for each SV it finds which is still live - ie which has an SvTYPE
116 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
117 following functions (specified as [function that calls visit()] / [function
118 called by visit() for each SV]):
120 sv_report_used() / do_report_used()
121 dump all remaining SVs (debugging aid)
123 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
124 Attempt to free all objects pointed to by RVs,
125 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
126 try to do the same for all objects indirectly
127 referenced by typeglobs too. Called once from
128 perl_destruct(), prior to calling sv_clean_all()
131 sv_clean_all() / do_clean_all()
132 SvREFCNT_dec(sv) each remaining SV, possibly
133 triggering an sv_free(). It also sets the
134 SVf_BREAK flag on the SV to indicate that the
135 refcnt has been artificially lowered, and thus
136 stopping sv_free() from giving spurious warnings
137 about SVs which unexpectedly have a refcnt
138 of zero. called repeatedly from perl_destruct()
139 until there are no SVs left.
141 =head2 Arena allocator API Summary
143 Private API to rest of sv.c
147 new_XIV(), del_XIV(),
148 new_XNV(), del_XNV(),
153 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
157 ============================================================================ */
160 * "A time to plant, and a time to uproot what was planted..."
164 * nice_chunk and nice_chunk size need to be set
165 * and queried under the protection of sv_mutex
168 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
174 new_chunk = (void *)(chunk);
175 new_chunk_size = (chunk_size);
176 if (new_chunk_size > PL_nice_chunk_size) {
177 Safefree(PL_nice_chunk);
178 PL_nice_chunk = (char *) new_chunk;
179 PL_nice_chunk_size = new_chunk_size;
186 #ifdef DEBUG_LEAKING_SCALARS
187 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
189 # define FREE_SV_DEBUG_FILE(sv)
193 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
194 /* Whilst I'd love to do this, it seems that things like to check on
196 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
198 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
199 Poison(&SvREFCNT(sv), 1, U32)
201 # define SvARENA_CHAIN(sv) SvANY(sv)
202 # define POSION_SV_HEAD(sv)
205 #define plant_SV(p) \
207 FREE_SV_DEBUG_FILE(p); \
209 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
210 SvFLAGS(p) = SVTYPEMASK; \
215 /* sv_mutex must be held while calling uproot_SV() */
216 #define uproot_SV(p) \
219 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
224 /* make some more SVs by adding another arena */
226 /* sv_mutex must be held while calling more_sv() */
234 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
235 PL_nice_chunk = NULL;
236 PL_nice_chunk_size = 0;
239 char *chunk; /* must use New here to match call to */
240 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
241 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
247 /* new_SV(): return a new, empty SV head */
249 #ifdef DEBUG_LEAKING_SCALARS
250 /* provide a real function for a debugger to play with */
260 sv = S_more_sv(aTHX);
265 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
266 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
267 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
268 sv->sv_debug_inpad = 0;
269 sv->sv_debug_cloned = 0;
270 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
274 # define new_SV(p) (p)=S_new_SV(aTHX)
283 (p) = S_more_sv(aTHX); \
292 /* del_SV(): return an empty SV head to the free list */
307 S_del_sv(pTHX_ SV *p)
313 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
314 const SV * const sv = sva + 1;
315 const SV * const svend = &sva[SvREFCNT(sva)];
316 if (p >= sv && p < svend) {
322 if (ckWARN_d(WARN_INTERNAL))
323 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
324 "Attempt to free non-arena SV: 0x%"UVxf
325 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
332 #else /* ! DEBUGGING */
334 #define del_SV(p) plant_SV(p)
336 #endif /* DEBUGGING */
340 =head1 SV Manipulation Functions
342 =for apidoc sv_add_arena
344 Given a chunk of memory, link it to the head of the list of arenas,
345 and split it into a list of free SVs.
351 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
354 SV* const sva = (SV*)ptr;
358 /* The first SV in an arena isn't an SV. */
359 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
360 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
361 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
363 PL_sv_arenaroot = sva;
364 PL_sv_root = sva + 1;
366 svend = &sva[SvREFCNT(sva) - 1];
369 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
373 /* Must always set typemask because it's awlays checked in on cleanup
374 when the arenas are walked looking for objects. */
375 SvFLAGS(sv) = SVTYPEMASK;
378 SvARENA_CHAIN(sv) = 0;
382 SvFLAGS(sv) = SVTYPEMASK;
385 /* visit(): call the named function for each non-free SV in the arenas
386 * whose flags field matches the flags/mask args. */
389 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
395 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
396 register const SV * const svend = &sva[SvREFCNT(sva)];
398 for (sv = sva + 1; sv < svend; ++sv) {
399 if (SvTYPE(sv) != SVTYPEMASK
400 && (sv->sv_flags & mask) == flags
413 /* called by sv_report_used() for each live SV */
416 do_report_used(pTHX_ SV *sv)
418 if (SvTYPE(sv) != SVTYPEMASK) {
419 PerlIO_printf(Perl_debug_log, "****\n");
426 =for apidoc sv_report_used
428 Dump the contents of all SVs not yet freed. (Debugging aid).
434 Perl_sv_report_used(pTHX)
437 visit(do_report_used, 0, 0);
443 /* called by sv_clean_objs() for each live SV */
446 do_clean_objs(pTHX_ SV *ref)
450 SV * const target = SvRV(ref);
451 if (SvOBJECT(target)) {
452 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
453 if (SvWEAKREF(ref)) {
454 sv_del_backref(target, ref);
460 SvREFCNT_dec(target);
465 /* XXX Might want to check arrays, etc. */
468 /* called by sv_clean_objs() for each live SV */
470 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 do_clean_named_objs(pTHX_ SV *sv)
475 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(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, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
545 PL_in_clean_all = TRUE;
546 cleaned = visit(do_clean_all, 0,0);
547 PL_in_clean_all = FALSE;
552 ARENASETS: a meta-arena implementation which separates arena-info
553 into struct arena_set, which contains an array of struct
554 arena_descs, each holding info for a single arena. By separating
555 the meta-info from the arena, we recover the 1st slot, formerly
556 borrowed for list management. The arena_set is about the size of an
557 arena, avoiding the needless malloc overhead of a naive linked-list
559 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
560 memory in the last arena-set (1/2 on average). In trade, we get
561 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
562 smaller types). The recovery of the wasted space allows use of
563 small arenas for large, rare body types,
566 char *arena; /* the raw storage, allocated aligned */
567 size_t size; /* its size ~4k typ */
568 int unit_type; /* useful for arena audits */
569 /* info for sv-heads (eventually)
576 /* Get the maximum number of elements in set[] such that struct arena_set
577 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
578 therefore likely to be 1 aligned memory page. */
580 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
581 - 2 * sizeof(int)) / sizeof (struct arena_desc))
584 struct arena_set* next;
585 int set_size; /* ie ARENAS_PER_SET */
586 int curr; /* index of next available arena-desc */
587 struct arena_desc set[ARENAS_PER_SET];
591 =for apidoc sv_free_arenas
593 Deallocate the memory used by all arenas. Note that all the individual SV
594 heads and bodies within the arenas must already have been freed.
599 Perl_sv_free_arenas(pTHX)
606 /* Free arenas here, but be careful about fake ones. (We assume
607 contiguity of the fake ones with the corresponding real ones.) */
609 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
610 svanext = (SV*) SvANY(sva);
611 while (svanext && SvFAKE(svanext))
612 svanext = (SV*) SvANY(svanext);
619 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
621 for (; aroot; aroot = next) {
622 const int max = aroot->curr;
623 for (i=0; i<max; i++) {
624 assert(aroot->set[i].arena);
625 Safefree(aroot->set[i].arena);
633 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
634 PL_body_roots[i] = 0;
636 Safefree(PL_nice_chunk);
637 PL_nice_chunk = NULL;
638 PL_nice_chunk_size = 0;
644 Here are mid-level routines that manage the allocation of bodies out
645 of the various arenas. There are 5 kinds of arenas:
647 1. SV-head arenas, which are discussed and handled above
648 2. regular body arenas
649 3. arenas for reduced-size bodies
651 5. pte arenas (thread related)
653 Arena types 2 & 3 are chained by body-type off an array of
654 arena-root pointers, which is indexed by svtype. Some of the
655 larger/less used body types are malloced singly, since a large
656 unused block of them is wasteful. Also, several svtypes dont have
657 bodies; the data fits into the sv-head itself. The arena-root
658 pointer thus has a few unused root-pointers (which may be hijacked
659 later for arena types 4,5)
661 3 differs from 2 as an optimization; some body types have several
662 unused fields in the front of the structure (which are kept in-place
663 for consistency). These bodies can be allocated in smaller chunks,
664 because the leading fields arent accessed. Pointers to such bodies
665 are decremented to point at the unused 'ghost' memory, knowing that
666 the pointers are used with offsets to the real memory.
668 HE, HEK arenas are managed separately, with separate code, but may
669 be merge-able later..
671 PTE arenas are not sv-bodies, but they share these mid-level
672 mechanics, so are considered here. The new mid-level mechanics rely
673 on the sv_type of the body being allocated, so we just reserve one
674 of the unused body-slots for PTEs, then use it in those (2) PTE
675 contexts below (line ~10k)
678 /* get_arena(size): this creates custom-sized arenas
679 TBD: export properly for hv.c: S_more_he().
682 Perl_get_arena(pTHX_ int arena_size)
684 struct arena_desc* adesc;
685 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
688 /* shouldnt need this
689 if (!arena_size) arena_size = PERL_ARENA_SIZE;
692 /* may need new arena-set to hold new arena */
693 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
694 Newxz(newroot, 1, struct arena_set);
695 newroot->set_size = ARENAS_PER_SET;
696 newroot->next = *aroot;
698 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
701 /* ok, now have arena-set with at least 1 empty/available arena-desc */
702 curr = (*aroot)->curr++;
703 adesc = &((*aroot)->set[curr]);
704 assert(!adesc->arena);
706 Newxz(adesc->arena, arena_size, char);
707 adesc->size = arena_size;
708 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
709 curr, adesc->arena, arena_size));
715 /* return a thing to the free list */
717 #define del_body(thing, root) \
719 void ** const thing_copy = (void **)thing;\
721 *thing_copy = *root; \
722 *root = (void*)thing_copy; \
728 =head1 SV-Body Allocation
730 Allocation of SV-bodies is similar to SV-heads, differing as follows;
731 the allocation mechanism is used for many body types, so is somewhat
732 more complicated, it uses arena-sets, and has no need for still-live
735 At the outermost level, (new|del)_X*V macros return bodies of the
736 appropriate type. These macros call either (new|del)_body_type or
737 (new|del)_body_allocated macro pairs, depending on specifics of the
738 type. Most body types use the former pair, the latter pair is used to
739 allocate body types with "ghost fields".
741 "ghost fields" are fields that are unused in certain types, and
742 consequently dont need to actually exist. They are declared because
743 they're part of a "base type", which allows use of functions as
744 methods. The simplest examples are AVs and HVs, 2 aggregate types
745 which don't use the fields which support SCALAR semantics.
747 For these types, the arenas are carved up into *_allocated size
748 chunks, we thus avoid wasted memory for those unaccessed members.
749 When bodies are allocated, we adjust the pointer back in memory by the
750 size of the bit not allocated, so it's as if we allocated the full
751 structure. (But things will all go boom if you write to the part that
752 is "not there", because you'll be overwriting the last members of the
753 preceding structure in memory.)
755 We calculate the correction using the STRUCT_OFFSET macro. For
756 example, if xpv_allocated is the same structure as XPV then the two
757 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
758 structure is smaller (no initial NV actually allocated) then the net
759 effect is to subtract the size of the NV from the pointer, to return a
760 new pointer as if an initial NV were actually allocated.
762 This is the same trick as was used for NV and IV bodies. Ironically it
763 doesn't need to be used for NV bodies any more, because NV is now at
764 the start of the structure. IV bodies don't need it either, because
765 they are no longer allocated.
767 In turn, the new_body_* allocators call S_new_body(), which invokes
768 new_body_inline macro, which takes a lock, and takes a body off the
769 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
770 necessary to refresh an empty list. Then the lock is released, and
771 the body is returned.
773 S_more_bodies calls get_arena(), and carves it up into an array of N
774 bodies, which it strings into a linked list. It looks up arena-size
775 and body-size from the body_details table described below, thus
776 supporting the multiple body-types.
778 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
779 the (new|del)_X*V macros are mapped directly to malloc/free.
785 For each sv-type, struct body_details bodies_by_type[] carries
786 parameters which control these aspects of SV handling:
788 Arena_size determines whether arenas are used for this body type, and if
789 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
790 zero, forcing individual mallocs and frees.
792 Body_size determines how big a body is, and therefore how many fit into
793 each arena. Offset carries the body-pointer adjustment needed for
794 *_allocated body types, and is used in *_allocated macros.
796 But its main purpose is to parameterize info needed in
797 Perl_sv_upgrade(). The info here dramatically simplifies the function
798 vs the implementation in 5.8.7, making it table-driven. All fields
799 are used for this, except for arena_size.
801 For the sv-types that have no bodies, arenas are not used, so those
802 PL_body_roots[sv_type] are unused, and can be overloaded. In
803 something of a special case, SVt_NULL is borrowed for HE arenas;
804 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
805 bodies_by_type[SVt_NULL] slot is not used, as the table is not
808 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
809 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
810 they can just use the same allocation semantics. At first, PTEs were
811 also overloaded to a non-body sv-type, but this yielded hard-to-find
812 malloc bugs, so was simplified by claiming a new slot. This choice
813 has no consequence at this time.
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* A macro to work out the offset needed to subtract from a pointer to (say)
867 to make its members accessible via a pointer to (say)
877 #define relative_STRUCT_OFFSET(longer, shorter, member) \
878 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
880 /* Calculate the length to copy. Specifically work out the length less any
881 final padding the compiler needed to add. See the comment in sv_upgrade
882 for why copying the padding proved to be a bug. */
884 #define copy_length(type, last_member) \
885 STRUCT_OFFSET(type, last_member) \
886 + sizeof (((type*)SvANY((SV*)0))->last_member)
888 static const struct body_details bodies_by_type[] = {
889 { sizeof(HE), 0, 0, SVt_NULL,
890 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
892 /* IVs are in the head, so the allocation size is 0.
893 However, the slot is overloaded for PTEs. */
894 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
895 sizeof(IV), /* This is used to copy out the IV body. */
896 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
897 NOARENA /* IVS don't need an arena */,
898 /* But PTEs need to know the size of their arena */
899 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
902 /* 8 bytes on most ILP32 with IEEE doubles */
903 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
904 FIT_ARENA(0, sizeof(NV)) },
906 /* RVs are in the head now. */
907 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
909 /* 8 bytes on most ILP32 with IEEE doubles */
910 { sizeof(xpv_allocated),
911 copy_length(XPV, xpv_len)
912 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
913 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
917 { sizeof(xpviv_allocated),
918 copy_length(XPVIV, xiv_u)
919 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
920 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
924 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
925 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
928 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
932 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
933 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
936 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
937 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
940 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
943 { sizeof(xpvav_allocated),
944 copy_length(XPVAV, xmg_stash)
945 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
946 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
947 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
949 { sizeof(xpvhv_allocated),
950 copy_length(XPVHV, xmg_stash)
951 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
952 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
953 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
956 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
957 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
958 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
960 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
961 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
962 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
964 /* XPVIO is 84 bytes, fits 48x */
965 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
966 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
969 #define new_body_type(sv_type) \
970 (void *)((char *)S_new_body(aTHX_ sv_type))
972 #define del_body_type(p, sv_type) \
973 del_body(p, &PL_body_roots[sv_type])
976 #define new_body_allocated(sv_type) \
977 (void *)((char *)S_new_body(aTHX_ sv_type) \
978 - bodies_by_type[sv_type].offset)
980 #define del_body_allocated(p, sv_type) \
981 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
984 #define my_safemalloc(s) (void*)safemalloc(s)
985 #define my_safecalloc(s) (void*)safecalloc(s, 1)
986 #define my_safefree(p) safefree((char*)p)
990 #define new_XNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XNV(p) my_safefree(p)
993 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
994 #define del_XPVNV(p) my_safefree(p)
996 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
997 #define del_XPVAV(p) my_safefree(p)
999 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1000 #define del_XPVHV(p) my_safefree(p)
1002 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1003 #define del_XPVMG(p) my_safefree(p)
1005 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1006 #define del_XPVGV(p) my_safefree(p)
1010 #define new_XNV() new_body_type(SVt_NV)
1011 #define del_XNV(p) del_body_type(p, SVt_NV)
1013 #define new_XPVNV() new_body_type(SVt_PVNV)
1014 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1016 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1017 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1019 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1020 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1022 #define new_XPVMG() new_body_type(SVt_PVMG)
1023 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1025 #define new_XPVGV() new_body_type(SVt_PVGV)
1026 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1030 /* no arena for you! */
1032 #define new_NOARENA(details) \
1033 my_safemalloc((details)->body_size + (details)->offset)
1034 #define new_NOARENAZ(details) \
1035 my_safecalloc((details)->body_size + (details)->offset)
1038 static bool done_sanity_check;
1042 S_more_bodies (pTHX_ svtype sv_type)
1045 void ** const root = &PL_body_roots[sv_type];
1046 const struct body_details * const bdp = &bodies_by_type[sv_type];
1047 const size_t body_size = bdp->body_size;
1051 assert(bdp->arena_size);
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1071 start, end, bdp->arena_size, sv_type, body_size,
1072 bdp->arena_size / body_size));
1074 *root = (void *)start;
1076 while (start < end) {
1077 char * const next = start + body_size;
1078 *(void**) start = (void *)next;
1081 *(void **)start = 0;
1086 /* grab a new thing from the free list, allocating more if necessary.
1087 The inline version is used for speed in hot routines, and the
1088 function using it serves the rest (unless PURIFY).
1090 #define new_body_inline(xpv, sv_type) \
1092 void ** const r3wt = &PL_body_roots[sv_type]; \
1094 xpv = *((void **)(r3wt)) \
1095 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1096 *(r3wt) = *(void**)(xpv); \
1103 S_new_body(pTHX_ svtype sv_type)
1107 new_body_inline(xpv, sv_type);
1114 =for apidoc sv_upgrade
1116 Upgrade an SV to a more complex form. Generally adds a new body type to the
1117 SV, then copies across as much information as possible from the old body.
1118 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1124 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1129 const U32 old_type = SvTYPE(sv);
1130 const struct body_details *new_type_details;
1131 const struct body_details *const old_type_details
1132 = bodies_by_type + old_type;
1134 if (new_type != SVt_PV && SvIsCOW(sv)) {
1135 sv_force_normal_flags(sv, 0);
1138 if (old_type == new_type)
1141 if (old_type > new_type)
1142 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1143 (int)old_type, (int)new_type);
1146 old_body = SvANY(sv);
1148 /* Copying structures onto other structures that have been neatly zeroed
1149 has a subtle gotcha. Consider XPVMG
1151 +------+------+------+------+------+-------+-------+
1152 | NV | CUR | LEN | IV | MAGIC | STASH |
1153 +------+------+------+------+------+-------+-------+
1154 0 4 8 12 16 20 24 28
1156 where NVs are aligned to 8 bytes, so that sizeof that structure is
1157 actually 32 bytes long, with 4 bytes of padding at the end:
1159 +------+------+------+------+------+-------+-------+------+
1160 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1161 +------+------+------+------+------+-------+-------+------+
1162 0 4 8 12 16 20 24 28 32
1164 so what happens if you allocate memory for this structure:
1166 +------+------+------+------+------+-------+-------+------+------+...
1167 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1168 +------+------+------+------+------+-------+-------+------+------+...
1169 0 4 8 12 16 20 24 28 32 36
1171 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1172 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1173 started out as zero once, but it's quite possible that it isn't. So now,
1174 rather than a nicely zeroed GP, you have it pointing somewhere random.
1177 (In fact, GP ends up pointing at a previous GP structure, because the
1178 principle cause of the padding in XPVMG getting garbage is a copy of
1179 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1181 So we are careful and work out the size of used parts of all the
1188 if (new_type < SVt_PVIV) {
1189 new_type = (new_type == SVt_NV)
1190 ? SVt_PVNV : SVt_PVIV;
1194 if (new_type < SVt_PVNV) {
1195 new_type = SVt_PVNV;
1201 assert(new_type > SVt_PV);
1202 assert(SVt_IV < SVt_PV);
1203 assert(SVt_NV < SVt_PV);
1210 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1211 there's no way that it can be safely upgraded, because perl.c
1212 expects to Safefree(SvANY(PL_mess_sv)) */
1213 assert(sv != PL_mess_sv);
1214 /* This flag bit is used to mean other things in other scalar types.
1215 Given that it only has meaning inside the pad, it shouldn't be set
1216 on anything that can get upgraded. */
1217 assert(!SvPAD_TYPED(sv));
1220 if (old_type_details->cant_upgrade)
1221 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1222 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1244 assert(old_type == SVt_NULL);
1245 SvANY(sv) = &sv->sv_u.svu_rv;
1250 assert(new_type_details->body_size);
1253 assert(new_type_details->arena);
1254 assert(new_type_details->arena_size);
1255 /* This points to the start of the allocated area. */
1256 new_body_inline(new_body, new_type);
1257 Zero(new_body, new_type_details->body_size, char);
1258 new_body = ((char *)new_body) - new_type_details->offset;
1260 /* We always allocated the full length item with PURIFY. To do this
1261 we fake things so that arena is false for all 16 types.. */
1262 new_body = new_NOARENAZ(new_type_details);
1264 SvANY(sv) = new_body;
1265 if (new_type == SVt_PVAV) {
1271 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1272 The target created by newSVrv also is, and it can have magic.
1273 However, it never has SvPVX set.
1275 if (old_type >= SVt_RV) {
1276 assert(SvPVX_const(sv) == 0);
1279 /* Could put this in the else clause below, as PVMG must have SvPVX
1280 0 already (the assertion above) */
1283 if (old_type >= SVt_PVMG) {
1284 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1285 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1291 /* XXX Is this still needed? Was it ever needed? Surely as there is
1292 no route from NV to PVIV, NOK can never be true */
1293 assert(!SvNOKp(sv));
1305 assert(new_type_details->body_size);
1306 /* We always allocated the full length item with PURIFY. To do this
1307 we fake things so that arena is false for all 16 types.. */
1308 if(new_type_details->arena) {
1309 /* This points to the start of the allocated area. */
1310 new_body_inline(new_body, new_type);
1311 Zero(new_body, new_type_details->body_size, char);
1312 new_body = ((char *)new_body) - new_type_details->offset;
1314 new_body = new_NOARENAZ(new_type_details);
1316 SvANY(sv) = new_body;
1318 if (old_type_details->copy) {
1319 /* There is now the potential for an upgrade from something without
1320 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1321 int offset = old_type_details->offset;
1322 int length = old_type_details->copy;
1324 if (new_type_details->offset > old_type_details->offset) {
1326 = new_type_details->offset - old_type_details->offset;
1327 offset += difference;
1328 length -= difference;
1330 assert (length >= 0);
1332 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1336 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1337 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1338 * correct 0.0 for us. Otherwise, if the old body didn't have an
1339 * NV slot, but the new one does, then we need to initialise the
1340 * freshly created NV slot with whatever the correct bit pattern is
1342 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1346 if (new_type == SVt_PVIO)
1347 IoPAGE_LEN(sv) = 60;
1348 if (old_type < SVt_RV)
1352 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1353 (unsigned long)new_type);
1356 if (old_type_details->arena) {
1357 /* If there was an old body, then we need to free it.
1358 Note that there is an assumption that all bodies of types that
1359 can be upgraded came from arenas. Only the more complex non-
1360 upgradable types are allowed to be directly malloc()ed. */
1362 my_safefree(old_body);
1364 del_body((void*)((char*)old_body + old_type_details->offset),
1365 &PL_body_roots[old_type]);
1371 =for apidoc sv_backoff
1373 Remove any string offset. You should normally use the C<SvOOK_off> macro
1380 Perl_sv_backoff(pTHX_ register SV *sv)
1382 PERL_UNUSED_CONTEXT;
1384 assert(SvTYPE(sv) != SVt_PVHV);
1385 assert(SvTYPE(sv) != SVt_PVAV);
1387 const char * const s = SvPVX_const(sv);
1388 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1389 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1391 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1393 SvFLAGS(sv) &= ~SVf_OOK;
1400 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1401 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1402 Use the C<SvGROW> wrapper instead.
1408 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1412 if (PL_madskills && newlen >= 0x100000) {
1413 PerlIO_printf(Perl_debug_log,
1414 "Allocation too large: %"UVxf"\n", (UV)newlen);
1416 #ifdef HAS_64K_LIMIT
1417 if (newlen >= 0x10000) {
1418 PerlIO_printf(Perl_debug_log,
1419 "Allocation too large: %"UVxf"\n", (UV)newlen);
1422 #endif /* HAS_64K_LIMIT */
1425 if (SvTYPE(sv) < SVt_PV) {
1426 sv_upgrade(sv, SVt_PV);
1427 s = SvPVX_mutable(sv);
1429 else if (SvOOK(sv)) { /* pv is offset? */
1431 s = SvPVX_mutable(sv);
1432 if (newlen > SvLEN(sv))
1433 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1434 #ifdef HAS_64K_LIMIT
1435 if (newlen >= 0x10000)
1440 s = SvPVX_mutable(sv);
1442 if (newlen > SvLEN(sv)) { /* need more room? */
1443 newlen = PERL_STRLEN_ROUNDUP(newlen);
1444 if (SvLEN(sv) && s) {
1446 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1452 s = saferealloc(s, newlen);
1455 s = safemalloc(newlen);
1456 if (SvPVX_const(sv) && SvCUR(sv)) {
1457 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1461 SvLEN_set(sv, newlen);
1467 =for apidoc sv_setiv
1469 Copies an integer into the given SV, upgrading first if necessary.
1470 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1476 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1479 SV_CHECK_THINKFIRST_COW_DROP(sv);
1480 switch (SvTYPE(sv)) {
1482 sv_upgrade(sv, SVt_IV);
1485 sv_upgrade(sv, SVt_PVNV);
1489 sv_upgrade(sv, SVt_PVIV);
1498 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1501 (void)SvIOK_only(sv); /* validate number */
1507 =for apidoc sv_setiv_mg
1509 Like C<sv_setiv>, but also handles 'set' magic.
1515 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1522 =for apidoc sv_setuv
1524 Copies an unsigned integer into the given SV, upgrading first if necessary.
1525 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1531 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1533 /* With these two if statements:
1534 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1537 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1539 If you wish to remove them, please benchmark to see what the effect is
1541 if (u <= (UV)IV_MAX) {
1542 sv_setiv(sv, (IV)u);
1551 =for apidoc sv_setuv_mg
1553 Like C<sv_setuv>, but also handles 'set' magic.
1559 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1568 =for apidoc sv_setnv
1570 Copies a double into the given SV, upgrading first if necessary.
1571 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1577 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1580 SV_CHECK_THINKFIRST_COW_DROP(sv);
1581 switch (SvTYPE(sv)) {
1584 sv_upgrade(sv, SVt_NV);
1589 sv_upgrade(sv, SVt_PVNV);
1598 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1602 (void)SvNOK_only(sv); /* validate number */
1607 =for apidoc sv_setnv_mg
1609 Like C<sv_setnv>, but also handles 'set' magic.
1615 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1621 /* Print an "isn't numeric" warning, using a cleaned-up,
1622 * printable version of the offending string
1626 S_not_a_number(pTHX_ SV *sv)
1634 dsv = sv_2mortal(newSVpvs(""));
1635 pv = sv_uni_display(dsv, sv, 10, 0);
1638 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1639 /* each *s can expand to 4 chars + "...\0",
1640 i.e. need room for 8 chars */
1642 const char *s = SvPVX_const(sv);
1643 const char * const end = s + SvCUR(sv);
1644 for ( ; s < end && d < limit; s++ ) {
1646 if (ch & 128 && !isPRINT_LC(ch)) {
1655 else if (ch == '\r') {
1659 else if (ch == '\f') {
1663 else if (ch == '\\') {
1667 else if (ch == '\0') {
1671 else if (isPRINT_LC(ch))
1688 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1689 "Argument \"%s\" isn't numeric in %s", pv,
1692 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1693 "Argument \"%s\" isn't numeric", pv);
1697 =for apidoc looks_like_number
1699 Test if the content of an SV looks like a number (or is a number).
1700 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1701 non-numeric warning), even if your atof() doesn't grok them.
1707 Perl_looks_like_number(pTHX_ SV *sv)
1709 register const char *sbegin;
1713 sbegin = SvPVX_const(sv);
1716 else if (SvPOKp(sv))
1717 sbegin = SvPV_const(sv, len);
1719 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1720 return grok_number(sbegin, len, NULL);
1724 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1726 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1727 SV *const buffer = sv_newmortal();
1729 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1732 gv_efullname3(buffer, gv, "*");
1733 SvFLAGS(gv) |= wasfake;
1736 /* We know that all GVs stringify to something that is not-a-number,
1737 so no need to test that. */
1738 if (ckWARN(WARN_NUMERIC))
1739 not_a_number(buffer);
1740 /* We just want something true to return, so that S_sv_2iuv_common
1741 can tail call us and return true. */
1744 return SvPV(buffer, *len);
1748 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1749 until proven guilty, assume that things are not that bad... */
1754 As 64 bit platforms often have an NV that doesn't preserve all bits of
1755 an IV (an assumption perl has been based on to date) it becomes necessary
1756 to remove the assumption that the NV always carries enough precision to
1757 recreate the IV whenever needed, and that the NV is the canonical form.
1758 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1759 precision as a side effect of conversion (which would lead to insanity
1760 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1761 1) to distinguish between IV/UV/NV slots that have cached a valid
1762 conversion where precision was lost and IV/UV/NV slots that have a
1763 valid conversion which has lost no precision
1764 2) to ensure that if a numeric conversion to one form is requested that
1765 would lose precision, the precise conversion (or differently
1766 imprecise conversion) is also performed and cached, to prevent
1767 requests for different numeric formats on the same SV causing
1768 lossy conversion chains. (lossless conversion chains are perfectly
1773 SvIOKp is true if the IV slot contains a valid value
1774 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1775 SvNOKp is true if the NV slot contains a valid value
1776 SvNOK is true only if the NV value is accurate
1779 while converting from PV to NV, check to see if converting that NV to an
1780 IV(or UV) would lose accuracy over a direct conversion from PV to
1781 IV(or UV). If it would, cache both conversions, return NV, but mark
1782 SV as IOK NOKp (ie not NOK).
1784 While converting from PV to IV, check to see if converting that IV to an
1785 NV would lose accuracy over a direct conversion from PV to NV. If it
1786 would, cache both conversions, flag similarly.
1788 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1789 correctly because if IV & NV were set NV *always* overruled.
1790 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1791 changes - now IV and NV together means that the two are interchangeable:
1792 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1794 The benefit of this is that operations such as pp_add know that if
1795 SvIOK is true for both left and right operands, then integer addition
1796 can be used instead of floating point (for cases where the result won't
1797 overflow). Before, floating point was always used, which could lead to
1798 loss of precision compared with integer addition.
1800 * making IV and NV equal status should make maths accurate on 64 bit
1802 * may speed up maths somewhat if pp_add and friends start to use
1803 integers when possible instead of fp. (Hopefully the overhead in
1804 looking for SvIOK and checking for overflow will not outweigh the
1805 fp to integer speedup)
1806 * will slow down integer operations (callers of SvIV) on "inaccurate"
1807 values, as the change from SvIOK to SvIOKp will cause a call into
1808 sv_2iv each time rather than a macro access direct to the IV slot
1809 * should speed up number->string conversion on integers as IV is
1810 favoured when IV and NV are equally accurate
1812 ####################################################################
1813 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1814 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1815 On the other hand, SvUOK is true iff UV.
1816 ####################################################################
1818 Your mileage will vary depending your CPU's relative fp to integer
1822 #ifndef NV_PRESERVES_UV
1823 # define IS_NUMBER_UNDERFLOW_IV 1
1824 # define IS_NUMBER_UNDERFLOW_UV 2
1825 # define IS_NUMBER_IV_AND_UV 2
1826 # define IS_NUMBER_OVERFLOW_IV 4
1827 # define IS_NUMBER_OVERFLOW_UV 5
1829 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1831 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1833 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1836 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));
1837 if (SvNVX(sv) < (NV)IV_MIN) {
1838 (void)SvIOKp_on(sv);
1840 SvIV_set(sv, IV_MIN);
1841 return IS_NUMBER_UNDERFLOW_IV;
1843 if (SvNVX(sv) > (NV)UV_MAX) {
1844 (void)SvIOKp_on(sv);
1847 SvUV_set(sv, UV_MAX);
1848 return IS_NUMBER_OVERFLOW_UV;
1850 (void)SvIOKp_on(sv);
1852 /* Can't use strtol etc to convert this string. (See truth table in
1854 if (SvNVX(sv) <= (UV)IV_MAX) {
1855 SvIV_set(sv, I_V(SvNVX(sv)));
1856 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1857 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1859 /* Integer is imprecise. NOK, IOKp */
1861 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1864 SvUV_set(sv, U_V(SvNVX(sv)));
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866 if (SvUVX(sv) == UV_MAX) {
1867 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1868 possibly be preserved by NV. Hence, it must be overflow.
1870 return IS_NUMBER_OVERFLOW_UV;
1872 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return IS_NUMBER_OVERFLOW_IV;
1878 #endif /* !NV_PRESERVES_UV*/
1881 S_sv_2iuv_common(pTHX_ SV *sv) {
1884 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1885 * without also getting a cached IV/UV from it at the same time
1886 * (ie PV->NV conversion should detect loss of accuracy and cache
1887 * IV or UV at same time to avoid this. */
1888 /* IV-over-UV optimisation - choose to cache IV if possible */
1890 if (SvTYPE(sv) == SVt_NV)
1891 sv_upgrade(sv, SVt_PVNV);
1893 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1894 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1895 certainly cast into the IV range at IV_MAX, whereas the correct
1896 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1898 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1899 if (Perl_isnan(SvNVX(sv))) {
1905 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1906 SvIV_set(sv, I_V(SvNVX(sv)));
1907 if (SvNVX(sv) == (NV) SvIVX(sv)
1908 #ifndef NV_PRESERVES_UV
1909 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1910 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1911 /* Don't flag it as "accurately an integer" if the number
1912 came from a (by definition imprecise) NV operation, and
1913 we're outside the range of NV integer precision */
1916 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1917 DEBUG_c(PerlIO_printf(Perl_debug_log,
1918 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1924 /* IV not precise. No need to convert from PV, as NV
1925 conversion would already have cached IV if it detected
1926 that PV->IV would be better than PV->NV->IV
1927 flags already correct - don't set public IOK. */
1928 DEBUG_c(PerlIO_printf(Perl_debug_log,
1929 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1934 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1935 but the cast (NV)IV_MIN rounds to a the value less (more
1936 negative) than IV_MIN which happens to be equal to SvNVX ??
1937 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1938 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1939 (NV)UVX == NVX are both true, but the values differ. :-(
1940 Hopefully for 2s complement IV_MIN is something like
1941 0x8000000000000000 which will be exact. NWC */
1944 SvUV_set(sv, U_V(SvNVX(sv)));
1946 (SvNVX(sv) == (NV) SvUVX(sv))
1947 #ifndef NV_PRESERVES_UV
1948 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1949 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1950 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1951 /* Don't flag it as "accurately an integer" if the number
1952 came from a (by definition imprecise) NV operation, and
1953 we're outside the range of NV integer precision */
1958 DEBUG_c(PerlIO_printf(Perl_debug_log,
1959 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1965 else if (SvPOKp(sv) && SvLEN(sv)) {
1967 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1968 /* We want to avoid a possible problem when we cache an IV/ a UV which
1969 may be later translated to an NV, and the resulting NV is not
1970 the same as the direct translation of the initial string
1971 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1972 be careful to ensure that the value with the .456 is around if the
1973 NV value is requested in the future).
1975 This means that if we cache such an IV/a UV, we need to cache the
1976 NV as well. Moreover, we trade speed for space, and do not
1977 cache the NV if we are sure it's not needed.
1980 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1981 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1982 == IS_NUMBER_IN_UV) {
1983 /* It's definitely an integer, only upgrade to PVIV */
1984 if (SvTYPE(sv) < SVt_PVIV)
1985 sv_upgrade(sv, SVt_PVIV);
1987 } else if (SvTYPE(sv) < SVt_PVNV)
1988 sv_upgrade(sv, SVt_PVNV);
1990 /* If NVs preserve UVs then we only use the UV value if we know that
1991 we aren't going to call atof() below. If NVs don't preserve UVs
1992 then the value returned may have more precision than atof() will
1993 return, even though value isn't perfectly accurate. */
1994 if ((numtype & (IS_NUMBER_IN_UV
1995 #ifdef NV_PRESERVES_UV
1998 )) == IS_NUMBER_IN_UV) {
1999 /* This won't turn off the public IOK flag if it was set above */
2000 (void)SvIOKp_on(sv);
2002 if (!(numtype & IS_NUMBER_NEG)) {
2004 if (value <= (UV)IV_MAX) {
2005 SvIV_set(sv, (IV)value);
2007 /* it didn't overflow, and it was positive. */
2008 SvUV_set(sv, value);
2012 /* 2s complement assumption */
2013 if (value <= (UV)IV_MIN) {
2014 SvIV_set(sv, -(IV)value);
2016 /* Too negative for an IV. This is a double upgrade, but
2017 I'm assuming it will be rare. */
2018 if (SvTYPE(sv) < SVt_PVNV)
2019 sv_upgrade(sv, SVt_PVNV);
2023 SvNV_set(sv, -(NV)value);
2024 SvIV_set(sv, IV_MIN);
2028 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2029 will be in the previous block to set the IV slot, and the next
2030 block to set the NV slot. So no else here. */
2032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2033 != IS_NUMBER_IN_UV) {
2034 /* It wasn't an (integer that doesn't overflow the UV). */
2035 SvNV_set(sv, Atof(SvPVX_const(sv)));
2037 if (! numtype && ckWARN(WARN_NUMERIC))
2040 #if defined(USE_LONG_DOUBLE)
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2045 PTR2UV(sv), SvNVX(sv)));
2048 #ifdef NV_PRESERVES_UV
2049 (void)SvIOKp_on(sv);
2051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2052 SvIV_set(sv, I_V(SvNVX(sv)));
2053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2058 /* UV will not work better than IV */
2060 if (SvNVX(sv) > (NV)UV_MAX) {
2062 /* Integer is inaccurate. NOK, IOKp, is UV */
2063 SvUV_set(sv, UV_MAX);
2065 SvUV_set(sv, U_V(SvNVX(sv)));
2066 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2067 NV preservse UV so can do correct comparison. */
2068 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2071 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2076 #else /* NV_PRESERVES_UV */
2077 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2078 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2079 /* The IV/UV slot will have been set from value returned by
2080 grok_number above. The NV slot has just been set using
2083 assert (SvIOKp(sv));
2085 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2086 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2087 /* Small enough to preserve all bits. */
2088 (void)SvIOKp_on(sv);
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2093 /* Assumption: first non-preserved integer is < IV_MAX,
2094 this NV is in the preserved range, therefore: */
2095 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2097 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);
2101 0 0 already failed to read UV.
2102 0 1 already failed to read UV.
2103 1 0 you won't get here in this case. IV/UV
2104 slot set, public IOK, Atof() unneeded.
2105 1 1 already read UV.
2106 so there's no point in sv_2iuv_non_preserve() attempting
2107 to use atol, strtol, strtoul etc. */
2108 sv_2iuv_non_preserve (sv, numtype);
2111 #endif /* NV_PRESERVES_UV */
2115 if (isGV_with_GP(sv)) {
2116 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2119 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2120 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2123 if (SvTYPE(sv) < SVt_IV)
2124 /* Typically the caller expects that sv_any is not NULL now. */
2125 sv_upgrade(sv, SVt_IV);
2126 /* Return 0 from the caller. */
2133 =for apidoc sv_2iv_flags
2135 Return the integer value of an SV, doing any necessary string
2136 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2137 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2143 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2148 if (SvGMAGICAL(sv)) {
2149 if (flags & SV_GMAGIC)
2154 return I_V(SvNVX(sv));
2156 if (SvPOKp(sv) && SvLEN(sv)) {
2159 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == IS_NUMBER_IN_UV) {
2163 /* It's definitely an integer */
2164 if (numtype & IS_NUMBER_NEG) {
2165 if (value < (UV)IV_MIN)
2168 if (value < (UV)IV_MAX)
2173 if (ckWARN(WARN_NUMERIC))
2176 return I_V(Atof(SvPVX_const(sv)));
2181 assert(SvTYPE(sv) >= SVt_PVMG);
2182 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2183 } else if (SvTHINKFIRST(sv)) {
2187 SV * const tmpstr=AMG_CALLun(sv,numer);
2188 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2189 return SvIV(tmpstr);
2192 return PTR2IV(SvRV(sv));
2195 sv_force_normal_flags(sv, 0);
2197 if (SvREADONLY(sv) && !SvOK(sv)) {
2198 if (ckWARN(WARN_UNINITIALIZED))
2204 if (S_sv_2iuv_common(aTHX_ sv))
2207 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2208 PTR2UV(sv),SvIVX(sv)));
2209 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2213 =for apidoc sv_2uv_flags
2215 Return the unsigned integer value of an SV, doing any necessary string
2216 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2217 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2223 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2228 if (SvGMAGICAL(sv)) {
2229 if (flags & SV_GMAGIC)
2234 return U_V(SvNVX(sv));
2235 if (SvPOKp(sv) && SvLEN(sv)) {
2238 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2240 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2241 == IS_NUMBER_IN_UV) {
2242 /* It's definitely an integer */
2243 if (!(numtype & IS_NUMBER_NEG))
2247 if (ckWARN(WARN_NUMERIC))
2250 return U_V(Atof(SvPVX_const(sv)));
2255 assert(SvTYPE(sv) >= SVt_PVMG);
2256 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2257 } else if (SvTHINKFIRST(sv)) {
2261 SV *const tmpstr = AMG_CALLun(sv,numer);
2262 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2263 return SvUV(tmpstr);
2266 return PTR2UV(SvRV(sv));
2269 sv_force_normal_flags(sv, 0);
2271 if (SvREADONLY(sv) && !SvOK(sv)) {
2272 if (ckWARN(WARN_UNINITIALIZED))
2278 if (S_sv_2iuv_common(aTHX_ sv))
2282 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2283 PTR2UV(sv),SvUVX(sv)));
2284 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2290 Return the num value of an SV, doing any necessary string or integer
2291 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2298 Perl_sv_2nv(pTHX_ register SV *sv)
2303 if (SvGMAGICAL(sv)) {
2307 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2308 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2309 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2311 return Atof(SvPVX_const(sv));
2315 return (NV)SvUVX(sv);
2317 return (NV)SvIVX(sv);
2322 assert(SvTYPE(sv) >= SVt_PVMG);
2323 /* This falls through to the report_uninit near the end of the
2325 } else if (SvTHINKFIRST(sv)) {
2329 SV *const tmpstr = AMG_CALLun(sv,numer);
2330 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2331 return SvNV(tmpstr);
2334 return PTR2NV(SvRV(sv));
2337 sv_force_normal_flags(sv, 0);
2339 if (SvREADONLY(sv) && !SvOK(sv)) {
2340 if (ckWARN(WARN_UNINITIALIZED))
2345 if (SvTYPE(sv) < SVt_NV) {
2346 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2347 sv_upgrade(sv, SVt_NV);
2348 #ifdef USE_LONG_DOUBLE
2350 STORE_NUMERIC_LOCAL_SET_STANDARD();
2351 PerlIO_printf(Perl_debug_log,
2352 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2353 PTR2UV(sv), SvNVX(sv));
2354 RESTORE_NUMERIC_LOCAL();
2358 STORE_NUMERIC_LOCAL_SET_STANDARD();
2359 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2360 PTR2UV(sv), SvNVX(sv));
2361 RESTORE_NUMERIC_LOCAL();
2365 else if (SvTYPE(sv) < SVt_PVNV)
2366 sv_upgrade(sv, SVt_PVNV);
2371 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2372 #ifdef NV_PRESERVES_UV
2375 /* Only set the public NV OK flag if this NV preserves the IV */
2376 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2377 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2378 : (SvIVX(sv) == I_V(SvNVX(sv))))
2384 else if (SvPOKp(sv) && SvLEN(sv)) {
2386 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2387 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2389 #ifdef NV_PRESERVES_UV
2390 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2391 == IS_NUMBER_IN_UV) {
2392 /* It's definitely an integer */
2393 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2395 SvNV_set(sv, Atof(SvPVX_const(sv)));
2398 SvNV_set(sv, Atof(SvPVX_const(sv)));
2399 /* Only set the public NV OK flag if this NV preserves the value in
2400 the PV at least as well as an IV/UV would.
2401 Not sure how to do this 100% reliably. */
2402 /* if that shift count is out of range then Configure's test is
2403 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2405 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2406 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2407 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2408 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2409 /* Can't use strtol etc to convert this string, so don't try.
2410 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2413 /* value has been set. It may not be precise. */
2414 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2415 /* 2s complement assumption for (UV)IV_MIN */
2416 SvNOK_on(sv); /* Integer is too negative. */
2421 if (numtype & IS_NUMBER_NEG) {
2422 SvIV_set(sv, -(IV)value);
2423 } else if (value <= (UV)IV_MAX) {
2424 SvIV_set(sv, (IV)value);
2426 SvUV_set(sv, value);
2430 if (numtype & IS_NUMBER_NOT_INT) {
2431 /* I believe that even if the original PV had decimals,
2432 they are lost beyond the limit of the FP precision.
2433 However, neither is canonical, so both only get p
2434 flags. NWC, 2000/11/25 */
2435 /* Both already have p flags, so do nothing */
2437 const NV nv = SvNVX(sv);
2438 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2439 if (SvIVX(sv) == I_V(nv)) {
2442 /* It had no "." so it must be integer. */
2446 /* between IV_MAX and NV(UV_MAX).
2447 Could be slightly > UV_MAX */
2449 if (numtype & IS_NUMBER_NOT_INT) {
2450 /* UV and NV both imprecise. */
2452 const UV nv_as_uv = U_V(nv);
2454 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2463 #endif /* NV_PRESERVES_UV */
2466 if (isGV_with_GP(sv)) {
2467 glob_2inpuv((GV *)sv, NULL, TRUE);
2471 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2473 assert (SvTYPE(sv) >= SVt_NV);
2474 /* Typically the caller expects that sv_any is not NULL now. */
2475 /* XXX Ilya implies that this is a bug in callers that assume this
2476 and ideally should be fixed. */
2479 #if defined(USE_LONG_DOUBLE)
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
2489 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2490 PTR2UV(sv), SvNVX(sv));
2491 RESTORE_NUMERIC_LOCAL();
2497 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2498 * UV as a string towards the end of buf, and return pointers to start and
2501 * We assume that buf is at least TYPE_CHARS(UV) long.
2505 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2507 char *ptr = buf + TYPE_CHARS(UV);
2508 char * const ebuf = ptr;
2521 *--ptr = '0' + (char)(uv % 10);
2529 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2530 * a regexp to its stringified form.
2534 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2536 const regexp * const re = (regexp *)mg->mg_obj;
2539 const char *fptr = "msix";
2544 bool need_newline = 0;
2545 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2547 while((ch = *fptr++)) {
2549 reflags[left++] = ch;
2552 reflags[right--] = ch;
2557 reflags[left] = '-';
2561 mg->mg_len = re->prelen + 4 + left;
2563 * If /x was used, we have to worry about a regex ending with a
2564 * comment later being embedded within another regex. If so, we don't
2565 * want this regex's "commentization" to leak out to the right part of
2566 * the enclosing regex, we must cap it with a newline.
2568 * So, if /x was used, we scan backwards from the end of the regex. If
2569 * we find a '#' before we find a newline, we need to add a newline
2570 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2571 * we don't need to add anything. -jfriedl
2573 if (PMf_EXTENDED & re->reganch) {
2574 const char *endptr = re->precomp + re->prelen;
2575 while (endptr >= re->precomp) {
2576 const char c = *(endptr--);
2578 break; /* don't need another */
2580 /* we end while in a comment, so we need a newline */
2581 mg->mg_len++; /* save space for it */
2582 need_newline = 1; /* note to add it */
2588 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2589 mg->mg_ptr[0] = '(';
2590 mg->mg_ptr[1] = '?';
2591 Copy(reflags, mg->mg_ptr+2, left, char);
2592 *(mg->mg_ptr+left+2) = ':';
2593 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2595 mg->mg_ptr[mg->mg_len - 2] = '\n';
2596 mg->mg_ptr[mg->mg_len - 1] = ')';
2597 mg->mg_ptr[mg->mg_len] = 0;
2599 PL_reginterp_cnt += re->program[0].next_off;
2601 if (re->reganch & ROPT_UTF8)
2611 =for apidoc sv_2pv_flags
2613 Returns a pointer to the string value of an SV, and sets *lp to its length.
2614 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2616 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2617 usually end up here too.
2623 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2633 if (SvGMAGICAL(sv)) {
2634 if (flags & SV_GMAGIC)
2639 if (flags & SV_MUTABLE_RETURN)
2640 return SvPVX_mutable(sv);
2641 if (flags & SV_CONST_RETURN)
2642 return (char *)SvPVX_const(sv);
2645 if (SvIOKp(sv) || SvNOKp(sv)) {
2646 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2650 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2651 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2653 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2660 #ifdef FIXNEGATIVEZERO
2661 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2667 SvUPGRADE(sv, SVt_PV);
2670 s = SvGROW_mutable(sv, len + 1);
2673 return memcpy(s, tbuf, len + 1);
2679 assert(SvTYPE(sv) >= SVt_PVMG);
2680 /* This falls through to the report_uninit near the end of the
2682 } else if (SvTHINKFIRST(sv)) {
2686 SV *const tmpstr = AMG_CALLun(sv,string);
2687 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2689 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2693 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2694 if (flags & SV_CONST_RETURN) {
2695 pv = (char *) SvPVX_const(tmpstr);
2697 pv = (flags & SV_MUTABLE_RETURN)
2698 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2701 *lp = SvCUR(tmpstr);
2703 pv = sv_2pv_flags(tmpstr, lp, flags);
2715 const SV *const referent = (SV*)SvRV(sv);
2718 tsv = sv_2mortal(newSVpvs("NULLREF"));
2719 } else if (SvTYPE(referent) == SVt_PVMG
2720 && ((SvFLAGS(referent) &
2721 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2722 == (SVs_OBJECT|SVs_SMG))
2723 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2724 return stringify_regexp(sv, mg, lp);
2726 const char *const typestr = sv_reftype(referent, 0);
2728 tsv = sv_newmortal();
2729 if (SvOBJECT(referent)) {
2730 const char *const name = HvNAME_get(SvSTASH(referent));
2731 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2732 name ? name : "__ANON__" , typestr,
2736 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2744 if (SvREADONLY(sv) && !SvOK(sv)) {
2745 if (ckWARN(WARN_UNINITIALIZED))
2752 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2753 /* I'm assuming that if both IV and NV are equally valid then
2754 converting the IV is going to be more efficient */
2755 const U32 isIOK = SvIOK(sv);
2756 const U32 isUIOK = SvIsUV(sv);
2757 char buf[TYPE_CHARS(UV)];
2760 if (SvTYPE(sv) < SVt_PVIV)
2761 sv_upgrade(sv, SVt_PVIV);
2762 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2763 /* inlined from sv_setpvn */
2764 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2765 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2766 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 (void)strcpy(s,"0");
2789 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2792 #ifdef FIXNEGATIVEZERO
2793 if (*s == '-' && s[1] == '0' && !s[2])
2803 if (isGV_with_GP(sv)) {
2804 return glob_2inpuv((GV *)sv, lp, FALSE);
2807 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2811 if (SvTYPE(sv) < SVt_PV)
2812 /* Typically the caller expects that sv_any is not NULL now. */
2813 sv_upgrade(sv, SVt_PV);
2817 const STRLEN len = s - SvPVX_const(sv);
2823 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2824 PTR2UV(sv),SvPVX_const(sv)));
2825 if (flags & SV_CONST_RETURN)
2826 return (char *)SvPVX_const(sv);
2827 if (flags & SV_MUTABLE_RETURN)
2828 return SvPVX_mutable(sv);
2833 =for apidoc sv_copypv
2835 Copies a stringified representation of the source SV into the
2836 destination SV. Automatically performs any necessary mg_get and
2837 coercion of numeric values into strings. Guaranteed to preserve
2838 UTF-8 flag even from overloaded objects. Similar in nature to
2839 sv_2pv[_flags] but operates directly on an SV instead of just the
2840 string. Mostly uses sv_2pv_flags to do its work, except when that
2841 would lose the UTF-8'ness of the PV.
2847 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2850 const char * const s = SvPV_const(ssv,len);
2851 sv_setpvn(dsv,s,len);
2859 =for apidoc sv_2pvbyte
2861 Return a pointer to the byte-encoded representation of the SV, and set *lp
2862 to its length. May cause the SV to be downgraded from UTF-8 as a
2865 Usually accessed via the C<SvPVbyte> macro.
2871 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2873 sv_utf8_downgrade(sv,0);
2874 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2878 =for apidoc sv_2pvutf8
2880 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2881 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2883 Usually accessed via the C<SvPVutf8> macro.
2889 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2891 sv_utf8_upgrade(sv);
2892 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2897 =for apidoc sv_2bool
2899 This function is only called on magical items, and is only used by
2900 sv_true() or its macro equivalent.
2906 Perl_sv_2bool(pTHX_ register SV *sv)
2915 SV * const tmpsv = AMG_CALLun(sv,bool_);
2916 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2917 return (bool)SvTRUE(tmpsv);
2919 return SvRV(sv) != 0;
2922 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2924 (*sv->sv_u.svu_pv > '0' ||
2925 Xpvtmp->xpv_cur > 1 ||
2926 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2933 return SvIVX(sv) != 0;
2936 return SvNVX(sv) != 0.0;
2938 if (isGV_with_GP(sv))
2948 =for apidoc sv_utf8_upgrade
2950 Converts the PV of an SV to its UTF-8-encoded form.
2951 Forces the SV to string form if it is not already.
2952 Always sets the SvUTF8 flag to avoid future validity checks even
2953 if all the bytes have hibit clear.
2955 This is not as a general purpose byte encoding to Unicode interface:
2956 use the Encode extension for that.
2958 =for apidoc sv_utf8_upgrade_flags
2960 Converts the PV of an SV to its UTF-8-encoded form.
2961 Forces the SV to string form if it is not already.
2962 Always sets the SvUTF8 flag to avoid future validity checks even
2963 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2964 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2965 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2967 This is not as a general purpose byte encoding to Unicode interface:
2968 use the Encode extension for that.
2974 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2977 if (sv == &PL_sv_undef)
2981 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2982 (void) sv_2pv_flags(sv,&len, flags);
2986 (void) SvPV_force(sv,len);
2995 sv_force_normal_flags(sv, 0);
2998 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2999 sv_recode_to_utf8(sv, PL_encoding);
3000 else { /* Assume Latin-1/EBCDIC */
3001 /* This function could be much more efficient if we
3002 * had a FLAG in SVs to signal if there are any hibit
3003 * chars in the PV. Given that there isn't such a flag
3004 * make the loop as fast as possible. */
3005 const U8 * const s = (U8 *) SvPVX_const(sv);
3006 const U8 * const e = (U8 *) SvEND(sv);
3011 /* Check for hi bit */
3012 if (!NATIVE_IS_INVARIANT(ch)) {
3013 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3014 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3016 SvPV_free(sv); /* No longer using what was there before. */
3017 SvPV_set(sv, (char*)recoded);
3018 SvCUR_set(sv, len - 1);
3019 SvLEN_set(sv, len); /* No longer know the real size. */
3023 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3030 =for apidoc sv_utf8_downgrade
3032 Attempts to convert the PV of an SV from characters to bytes.
3033 If the PV contains a character beyond byte, this conversion will fail;
3034 in this case, either returns false or, if C<fail_ok> is not
3037 This is not as a general purpose Unicode to byte encoding interface:
3038 use the Encode extension for that.
3044 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3047 if (SvPOKp(sv) && SvUTF8(sv)) {
3053 sv_force_normal_flags(sv, 0);
3055 s = (U8 *) SvPV(sv, len);
3056 if (!utf8_to_bytes(s, &len)) {
3061 Perl_croak(aTHX_ "Wide character in %s",
3064 Perl_croak(aTHX_ "Wide character");
3075 =for apidoc sv_utf8_encode
3077 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3078 flag off so that it looks like octets again.
3084 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3086 (void) sv_utf8_upgrade(sv);
3088 sv_force_normal_flags(sv, 0);
3090 if (SvREADONLY(sv)) {
3091 Perl_croak(aTHX_ PL_no_modify);
3097 =for apidoc sv_utf8_decode
3099 If the PV of the SV is an octet sequence in UTF-8
3100 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3101 so that it looks like a character. If the PV contains only single-byte
3102 characters, the C<SvUTF8> flag stays being off.
3103 Scans PV for validity and returns false if the PV is invalid UTF-8.
3109 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3115 /* The octets may have got themselves encoded - get them back as
3118 if (!sv_utf8_downgrade(sv, TRUE))
3121 /* it is actually just a matter of turning the utf8 flag on, but
3122 * we want to make sure everything inside is valid utf8 first.
3124 c = (const U8 *) SvPVX_const(sv);
3125 if (!is_utf8_string(c, SvCUR(sv)+1))
3127 e = (const U8 *) SvEND(sv);
3130 if (!UTF8_IS_INVARIANT(ch)) {
3140 =for apidoc sv_setsv
3142 Copies the contents of the source SV C<ssv> into the destination SV
3143 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3144 function if the source SV needs to be reused. Does not handle 'set' magic.
3145 Loosely speaking, it performs a copy-by-value, obliterating any previous
3146 content of the destination.
3148 You probably want to use one of the assortment of wrappers, such as
3149 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3150 C<SvSetMagicSV_nosteal>.
3152 =for apidoc sv_setsv_flags
3154 Copies the contents of the source SV C<ssv> into the destination SV
3155 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3156 function if the source SV needs to be reused. Does not handle 'set' magic.
3157 Loosely speaking, it performs a copy-by-value, obliterating any previous
3158 content of the destination.
3159 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3160 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3161 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3162 and C<sv_setsv_nomg> are implemented in terms of this function.
3164 You probably want to use one of the assortment of wrappers, such as
3165 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3166 C<SvSetMagicSV_nosteal>.
3168 This is the primary function for copying scalars, and most other
3169 copy-ish functions and macros use this underneath.
3175 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3177 if (dtype != SVt_PVGV) {
3178 const char * const name = GvNAME(sstr);
3179 const STRLEN len = GvNAMELEN(sstr);
3180 /* don't upgrade SVt_PVLV: it can hold a glob */
3181 if (dtype != SVt_PVLV) {
3182 if (dtype >= SVt_PV) {
3188 sv_upgrade(dstr, SVt_PVGV);
3189 (void)SvOK_off(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);
3207 (void)SvOK_off(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),
3304 ? "Constant subroutine %s::%s redefined"
3305 : "Subroutine %s::%s redefined",
3306 HvNAME_get(GvSTASH((GV*)dstr)),
3307 GvENAME((GV*)dstr));
3311 cv_ckproto(cv, (GV*)dstr,
3312 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3314 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3315 GvASSUMECV_on(dstr);
3316 PL_sub_generation++;
3319 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3320 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3321 GvFLAGS(dstr) |= import_flag;
3326 if (SvTAINTED(sstr))
3332 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3335 register U32 sflags;
3341 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3343 sstr = &PL_sv_undef;
3344 stype = SvTYPE(sstr);
3345 dtype = SvTYPE(dstr);
3350 /* need to nuke the magic */
3352 SvRMAGICAL_off(dstr);
3355 /* There's a lot of redundancy below but we're going for speed here */
3360 if (dtype != SVt_PVGV) {
3361 (void)SvOK_off(dstr);
3369 sv_upgrade(dstr, SVt_IV);
3374 sv_upgrade(dstr, SVt_PVIV);
3377 (void)SvIOK_only(dstr);
3378 SvIV_set(dstr, SvIVX(sstr));
3381 /* SvTAINTED can only be true if the SV has taint magic, which in
3382 turn means that the SV type is PVMG (or greater). This is the
3383 case statement for SVt_IV, so this cannot be true (whatever gcov
3385 assert(!SvTAINTED(sstr));
3395 sv_upgrade(dstr, SVt_NV);
3400 sv_upgrade(dstr, SVt_PVNV);
3403 SvNV_set(dstr, SvNVX(sstr));
3404 (void)SvNOK_only(dstr);
3405 /* SvTAINTED can only be true if the SV has taint magic, which in
3406 turn means that the SV type is PVMG (or greater). This is the
3407 case statement for SVt_NV, so this cannot be true (whatever gcov
3409 assert(!SvTAINTED(sstr));
3416 sv_upgrade(dstr, SVt_RV);
3419 #ifdef PERL_OLD_COPY_ON_WRITE
3420 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3421 if (dtype < SVt_PVIV)
3422 sv_upgrade(dstr, SVt_PVIV);
3429 sv_upgrade(dstr, SVt_PV);
3432 if (dtype < SVt_PVIV)
3433 sv_upgrade(dstr, SVt_PVIV);
3436 if (dtype < SVt_PVNV)
3437 sv_upgrade(dstr, SVt_PVNV);
3441 const char * const type = sv_reftype(sstr,0);
3443 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3445 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3450 if (dtype <= SVt_PVGV) {
3451 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3459 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3461 if ((int)SvTYPE(sstr) != stype) {
3462 stype = SvTYPE(sstr);
3463 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3464 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3469 if (stype == SVt_PVLV)
3470 SvUPGRADE(dstr, SVt_PVNV);
3472 SvUPGRADE(dstr, (U32)stype);
3475 /* dstr may have been upgraded. */
3476 dtype = SvTYPE(dstr);
3477 sflags = SvFLAGS(sstr);
3479 if (sflags & SVf_ROK) {
3480 if (dtype == SVt_PVGV &&
3481 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3484 if (GvIMPORTED(dstr) != GVf_IMPORTED
3485 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3487 GvIMPORTED_on(dstr);
3492 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3496 if (dtype >= SVt_PV) {
3497 if (dtype == SVt_PVGV) {
3498 S_glob_assign_ref(aTHX_ dstr, sstr);
3501 if (SvPVX_const(dstr)) {
3507 (void)SvOK_off(dstr);
3508 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3509 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3510 assert(!(sflags & SVp_NOK));
3511 assert(!(sflags & SVp_IOK));
3512 assert(!(sflags & SVf_NOK));
3513 assert(!(sflags & SVf_IOK));
3515 else if (dtype == SVt_PVGV) {
3516 if (!(sflags & SVf_OK)) {
3517 if (ckWARN(WARN_MISC))
3518 Perl_warner(aTHX_ packWARN(WARN_MISC),
3519 "Undefined value assigned to typeglob");
3522 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3523 if (dstr != (SV*)gv) {
3526 GvGP(dstr) = gp_ref(GvGP(gv));
3530 else if (sflags & SVp_POK) {
3534 * Check to see if we can just swipe the string. If so, it's a
3535 * possible small lose on short strings, but a big win on long ones.
3536 * It might even be a win on short strings if SvPVX_const(dstr)
3537 * has to be allocated and SvPVX_const(sstr) has to be freed.
3540 /* Whichever path we take through the next code, we want this true,
3541 and doing it now facilitates the COW check. */
3542 (void)SvPOK_only(dstr);
3545 /* We're not already COW */
3546 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3547 #ifndef PERL_OLD_COPY_ON_WRITE
3548 /* or we are, but dstr isn't a suitable target. */
3549 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3554 (sflags & SVs_TEMP) && /* slated for free anyway? */
3555 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3556 (!(flags & SV_NOSTEAL)) &&
3557 /* and we're allowed to steal temps */
3558 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3559 SvLEN(sstr) && /* and really is a string */
3560 /* and won't be needed again, potentially */
3561 !(PL_op && PL_op->op_type == OP_AASSIGN))
3562 #ifdef PERL_OLD_COPY_ON_WRITE
3563 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3564 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3565 && SvTYPE(sstr) >= SVt_PVIV)
3568 /* Failed the swipe test, and it's not a shared hash key either.
3569 Have to copy the string. */
3570 STRLEN len = SvCUR(sstr);
3571 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3572 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3573 SvCUR_set(dstr, len);
3574 *SvEND(dstr) = '\0';
3576 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3578 /* Either it's a shared hash key, or it's suitable for
3579 copy-on-write or we can swipe the string. */
3581 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3585 #ifdef PERL_OLD_COPY_ON_WRITE
3587 /* I believe I should acquire a global SV mutex if
3588 it's a COW sv (not a shared hash key) to stop
3589 it going un copy-on-write.
3590 If the source SV has gone un copy on write between up there
3591 and down here, then (assert() that) it is of the correct
3592 form to make it copy on write again */
3593 if ((sflags & (SVf_FAKE | SVf_READONLY))
3594 != (SVf_FAKE | SVf_READONLY)) {
3595 SvREADONLY_on(sstr);
3597 /* Make the source SV into a loop of 1.
3598 (about to become 2) */
3599 SV_COW_NEXT_SV_SET(sstr, sstr);
3603 /* Initial code is common. */
3604 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3609 /* making another shared SV. */
3610 STRLEN cur = SvCUR(sstr);
3611 STRLEN len = SvLEN(sstr);
3612 #ifdef PERL_OLD_COPY_ON_WRITE
3614 assert (SvTYPE(dstr) >= SVt_PVIV);
3615 /* SvIsCOW_normal */
3616 /* splice us in between source and next-after-source. */
3617 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3618 SV_COW_NEXT_SV_SET(sstr, dstr);
3619 SvPV_set(dstr, SvPVX_mutable(sstr));
3623 /* SvIsCOW_shared_hash */
3624 DEBUG_C(PerlIO_printf(Perl_debug_log,
3625 "Copy on write: Sharing hash\n"));
3627 assert (SvTYPE(dstr) >= SVt_PV);
3629 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3631 SvLEN_set(dstr, len);
3632 SvCUR_set(dstr, cur);
3633 SvREADONLY_on(dstr);
3635 /* Relesase a global SV mutex. */
3638 { /* Passes the swipe test. */
3639 SvPV_set(dstr, SvPVX_mutable(sstr));
3640 SvLEN_set(dstr, SvLEN(sstr));
3641 SvCUR_set(dstr, SvCUR(sstr));
3644 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3645 SvPV_set(sstr, NULL);
3651 if (sflags & SVp_NOK) {
3652 SvNV_set(dstr, SvNVX(sstr));
3654 if (sflags & SVp_IOK) {
3655 SvRELEASE_IVX(dstr);
3656 SvIV_set(dstr, SvIVX(sstr));
3657 /* Must do this otherwise some other overloaded use of 0x80000000
3658 gets confused. I guess SVpbm_VALID */
3659 if (sflags & SVf_IVisUV)
3662 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3665 const MAGIC * const smg = SvVOK(sstr);
3667 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3668 smg->mg_ptr, smg->mg_len);
3669 SvRMAGICAL_on(dstr);
3673 else if (sflags & (SVp_IOK|SVp_NOK)) {
3674 (void)SvOK_off(dstr);
3675 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3677 if (sflags & SVp_IOK) {
3678 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3679 SvIV_set(dstr, SvIVX(sstr));
3681 if (sflags & SVp_NOK) {
3682 SvNV_set(dstr, SvNVX(sstr));
3686 if (isGV_with_GP(sstr)) {
3687 /* This stringification rule for globs is spread in 3 places.
3688 This feels bad. FIXME. */
3689 const U32 wasfake = sflags & SVf_FAKE;
3691 /* FAKE globs can get coerced, so need to turn this off
3692 temporarily if it is on. */
3694 gv_efullname3(dstr, (GV *)sstr, "*");
3695 SvFLAGS(sstr) |= wasfake;
3696 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3699 (void)SvOK_off(dstr);
3701 if (SvTAINTED(sstr))
3706 =for apidoc sv_setsv_mg
3708 Like C<sv_setsv>, but also handles 'set' magic.
3714 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3716 sv_setsv(dstr,sstr);
3720 #ifdef PERL_OLD_COPY_ON_WRITE
3722 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3724 STRLEN cur = SvCUR(sstr);
3725 STRLEN len = SvLEN(sstr);
3726 register char *new_pv;
3729 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3737 if (SvTHINKFIRST(dstr))
3738 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3739 else if (SvPVX_const(dstr))
3740 Safefree(SvPVX_const(dstr));
3744 SvUPGRADE(dstr, SVt_PVIV);
3746 assert (SvPOK(sstr));
3747 assert (SvPOKp(sstr));
3748 assert (!SvIOK(sstr));
3749 assert (!SvIOKp(sstr));
3750 assert (!SvNOK(sstr));
3751 assert (!SvNOKp(sstr));
3753 if (SvIsCOW(sstr)) {
3755 if (SvLEN(sstr) == 0) {
3756 /* source is a COW shared hash key. */
3757 DEBUG_C(PerlIO_printf(Perl_debug_log,
3758 "Fast copy on write: Sharing hash\n"));
3759 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3762 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3764 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3765 SvUPGRADE(sstr, SVt_PVIV);
3766 SvREADONLY_on(sstr);
3768 DEBUG_C(PerlIO_printf(Perl_debug_log,
3769 "Fast copy on write: Converting sstr to COW\n"));
3770 SV_COW_NEXT_SV_SET(dstr, sstr);
3772 SV_COW_NEXT_SV_SET(sstr, dstr);
3773 new_pv = SvPVX_mutable(sstr);
3776 SvPV_set(dstr, new_pv);
3777 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3780 SvLEN_set(dstr, len);
3781 SvCUR_set(dstr, cur);
3790 =for apidoc sv_setpvn
3792 Copies a string into an SV. The C<len> parameter indicates the number of
3793 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3794 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3800 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3803 register char *dptr;
3805 SV_CHECK_THINKFIRST_COW_DROP(sv);
3811 /* len is STRLEN which is unsigned, need to copy to signed */
3814 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3816 SvUPGRADE(sv, SVt_PV);
3818 dptr = SvGROW(sv, len + 1);
3819 Move(ptr,dptr,len,char);
3822 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3827 =for apidoc sv_setpvn_mg
3829 Like C<sv_setpvn>, but also handles 'set' magic.
3835 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3837 sv_setpvn(sv,ptr,len);
3842 =for apidoc sv_setpv
3844 Copies a string into an SV. The string must be null-terminated. Does not
3845 handle 'set' magic. See C<sv_setpv_mg>.
3851 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3854 register STRLEN len;
3856 SV_CHECK_THINKFIRST_COW_DROP(sv);
3862 SvUPGRADE(sv, SVt_PV);
3864 SvGROW(sv, len + 1);
3865 Move(ptr,SvPVX(sv),len+1,char);
3867 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3872 =for apidoc sv_setpv_mg
3874 Like C<sv_setpv>, but also handles 'set' magic.
3880 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3887 =for apidoc sv_usepvn
3889 Tells an SV to use C<ptr> to find its string value. Normally the string is
3890 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3891 The C<ptr> should point to memory that was allocated by C<malloc>. The
3892 string length, C<len>, must be supplied. This function will realloc the
3893 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3894 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3895 See C<sv_usepvn_mg>.
3901 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3905 SV_CHECK_THINKFIRST_COW_DROP(sv);
3906 SvUPGRADE(sv, SVt_PV);
3911 if (SvPVX_const(sv))
3914 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3915 ptr = saferealloc (ptr, allocate);
3918 SvLEN_set(sv, allocate);
3920 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3925 =for apidoc sv_usepvn_mg
3927 Like C<sv_usepvn>, but also handles 'set' magic.
3933 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3935 sv_usepvn(sv,ptr,len);
3939 #ifdef PERL_OLD_COPY_ON_WRITE
3940 /* Need to do this *after* making the SV normal, as we need the buffer
3941 pointer to remain valid until after we've copied it. If we let go too early,
3942 another thread could invalidate it by unsharing last of the same hash key
3943 (which it can do by means other than releasing copy-on-write Svs)
3944 or by changing the other copy-on-write SVs in the loop. */
3946 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3948 if (len) { /* this SV was SvIsCOW_normal(sv) */
3949 /* we need to find the SV pointing to us. */
3950 SV *current = SV_COW_NEXT_SV(after);
3952 if (current == sv) {
3953 /* The SV we point to points back to us (there were only two of us
3955 Hence other SV is no longer copy on write either. */
3957 SvREADONLY_off(after);
3959 /* We need to follow the pointers around the loop. */
3961 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3964 /* don't loop forever if the structure is bust, and we have
3965 a pointer into a closed loop. */
3966 assert (current != after);
3967 assert (SvPVX_const(current) == pvx);
3969 /* Make the SV before us point to the SV after us. */
3970 SV_COW_NEXT_SV_SET(current, after);
3973 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3978 Perl_sv_release_IVX(pTHX_ register SV *sv)
3981 sv_force_normal_flags(sv, 0);
3987 =for apidoc sv_force_normal_flags
3989 Undo various types of fakery on an SV: if the PV is a shared string, make
3990 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3991 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3992 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3993 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3994 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3995 set to some other value.) In addition, the C<flags> parameter gets passed to
3996 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3997 with flags set to 0.
4003 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4006 #ifdef PERL_OLD_COPY_ON_WRITE
4007 if (SvREADONLY(sv)) {
4008 /* At this point I believe I should acquire a global SV mutex. */
4010 const char * const pvx = SvPVX_const(sv);
4011 const STRLEN len = SvLEN(sv);
4012 const STRLEN cur = SvCUR(sv);
4013 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4015 PerlIO_printf(Perl_debug_log,
4016 "Copy on write: Force normal %ld\n",
4022 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4025 if (flags & SV_COW_DROP_PV) {
4026 /* OK, so we don't need to copy our buffer. */
4029 SvGROW(sv, cur + 1);
4030 Move(pvx,SvPVX(sv),cur,char);
4034 sv_release_COW(sv, pvx, len, next);
4039 else if (IN_PERL_RUNTIME)
4040 Perl_croak(aTHX_ PL_no_modify);
4041 /* At this point I believe that I can drop the global SV mutex. */
4044 if (SvREADONLY(sv)) {
4046 const char * const pvx = SvPVX_const(sv);
4047 const STRLEN len = SvCUR(sv);
4052 SvGROW(sv, len + 1);
4053 Move(pvx,SvPVX(sv),len,char);
4055 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4057 else if (IN_PERL_RUNTIME)
4058 Perl_croak(aTHX_ PL_no_modify);
4062 sv_unref_flags(sv, flags);
4063 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4070 Efficient removal of characters from the beginning of the string buffer.
4071 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4072 the string buffer. The C<ptr> becomes the first character of the adjusted
4073 string. Uses the "OOK hack".
4074 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4075 refer to the same chunk of data.
4081 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4083 register STRLEN delta;
4084 if (!ptr || !SvPOKp(sv))
4086 delta = ptr - SvPVX_const(sv);
4087 SV_CHECK_THINKFIRST(sv);
4088 if (SvTYPE(sv) < SVt_PVIV)
4089 sv_upgrade(sv,SVt_PVIV);
4092 if (!SvLEN(sv)) { /* make copy of shared string */
4093 const char *pvx = SvPVX_const(sv);
4094 const STRLEN len = SvCUR(sv);
4095 SvGROW(sv, len + 1);
4096 Move(pvx,SvPVX(sv),len,char);
4100 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4101 and we do that anyway inside the SvNIOK_off
4103 SvFLAGS(sv) |= SVf_OOK;
4106 SvLEN_set(sv, SvLEN(sv) - delta);
4107 SvCUR_set(sv, SvCUR(sv) - delta);
4108 SvPV_set(sv, SvPVX(sv) + delta);
4109 SvIV_set(sv, SvIVX(sv) + delta);
4113 =for apidoc sv_catpvn
4115 Concatenates the string onto the end of the string which is in the SV. The
4116 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4117 status set, then the bytes appended should be valid UTF-8.
4118 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4120 =for apidoc sv_catpvn_flags
4122 Concatenates the string onto the end of the string which is in the SV. The
4123 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4124 status set, then the bytes appended should be valid UTF-8.
4125 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4126 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4127 in terms of this function.
4133 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4137 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4139 SvGROW(dsv, dlen + slen + 1);
4141 sstr = SvPVX_const(dsv);
4142 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4143 SvCUR_set(dsv, SvCUR(dsv) + slen);
4145 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4147 if (flags & SV_SMAGIC)
4152 =for apidoc sv_catsv
4154 Concatenates the string from SV C<ssv> onto the end of the string in
4155 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4156 not 'set' magic. See C<sv_catsv_mg>.
4158 =for apidoc sv_catsv_flags
4160 Concatenates the string from SV C<ssv> onto the end of the string in
4161 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4162 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4163 and C<sv_catsv_nomg> are implemented in terms of this function.
4168 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4173 const char *spv = SvPV_const(ssv, slen);
4175 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4176 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4177 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4178 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4179 dsv->sv_flags doesn't have that bit set.
4180 Andy Dougherty 12 Oct 2001
4182 const I32 sutf8 = DO_UTF8(ssv);
4185 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4187 dutf8 = DO_UTF8(dsv);
4189 if (dutf8 != sutf8) {
4191 /* Not modifying source SV, so taking a temporary copy. */
4192 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4194 sv_utf8_upgrade(csv);
4195 spv = SvPV_const(csv, slen);
4198 sv_utf8_upgrade_nomg(dsv);
4200 sv_catpvn_nomg(dsv, spv, slen);
4203 if (flags & SV_SMAGIC)
4208 =for apidoc sv_catpv
4210 Concatenates the string onto the end of the string which is in the SV.
4211 If the SV has the UTF-8 status set, then the bytes appended should be
4212 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4217 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4220 register STRLEN len;
4226 junk = SvPV_force(sv, tlen);
4228 SvGROW(sv, tlen + len + 1);
4230 ptr = SvPVX_const(sv);
4231 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4232 SvCUR_set(sv, SvCUR(sv) + len);
4233 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4238 =for apidoc sv_catpv_mg
4240 Like C<sv_catpv>, but also handles 'set' magic.
4246 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4255 Creates a new SV. A non-zero C<len> parameter indicates the number of
4256 bytes of preallocated string space the SV should have. An extra byte for a
4257 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4258 space is allocated.) The reference count for the new SV is set to 1.
4260 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4261 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4262 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4263 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4264 modules supporting older perls.
4270 Perl_newSV(pTHX_ STRLEN len)
4277 sv_upgrade(sv, SVt_PV);
4278 SvGROW(sv, len + 1);
4283 =for apidoc sv_magicext
4285 Adds magic to an SV, upgrading it if necessary. Applies the
4286 supplied vtable and returns a pointer to the magic added.
4288 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4289 In particular, you can add magic to SvREADONLY SVs, and add more than
4290 one instance of the same 'how'.
4292 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4293 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4294 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4295 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4297 (This is now used as a subroutine by C<sv_magic>.)
4302 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4303 const char* name, I32 namlen)
4308 if (SvTYPE(sv) < SVt_PVMG) {
4309 SvUPGRADE(sv, SVt_PVMG);
4311 Newxz(mg, 1, MAGIC);
4312 mg->mg_moremagic = SvMAGIC(sv);
4313 SvMAGIC_set(sv, mg);
4315 /* Sometimes a magic contains a reference loop, where the sv and
4316 object refer to each other. To prevent a reference loop that
4317 would prevent such objects being freed, we look for such loops
4318 and if we find one we avoid incrementing the object refcount.
4320 Note we cannot do this to avoid self-tie loops as intervening RV must
4321 have its REFCNT incremented to keep it in existence.
4324 if (!obj || obj == sv ||
4325 how == PERL_MAGIC_arylen ||
4326 how == PERL_MAGIC_qr ||
4327 how == PERL_MAGIC_symtab ||
4328 (SvTYPE(obj) == SVt_PVGV &&
4329 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4330 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4331 GvFORM(obj) == (CV*)sv)))
4336 mg->mg_obj = SvREFCNT_inc_simple(obj);
4337 mg->mg_flags |= MGf_REFCOUNTED;
4340 /* Normal self-ties simply pass a null object, and instead of
4341 using mg_obj directly, use the SvTIED_obj macro to produce a
4342 new RV as needed. For glob "self-ties", we are tieing the PVIO
4343 with an RV obj pointing to the glob containing the PVIO. In
4344 this case, to avoid a reference loop, we need to weaken the
4348 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4349 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4355 mg->mg_len = namlen;
4358 mg->mg_ptr = savepvn(name, namlen);
4359 else if (namlen == HEf_SVKEY)
4360 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4362 mg->mg_ptr = (char *) name;
4364 mg->mg_virtual = vtable;
4368 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4373 =for apidoc sv_magic
4375 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4376 then adds a new magic item of type C<how> to the head of the magic list.
4378 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4379 handling of the C<name> and C<namlen> arguments.
4381 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4382 to add more than one instance of the same 'how'.
4388 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4394 #ifdef PERL_OLD_COPY_ON_WRITE
4396 sv_force_normal_flags(sv, 0);
4398 if (SvREADONLY(sv)) {
4400 /* its okay to attach magic to shared strings; the subsequent
4401 * upgrade to PVMG will unshare the string */
4402 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4405 && how != PERL_MAGIC_regex_global
4406 && how != PERL_MAGIC_bm
4407 && how != PERL_MAGIC_fm
4408 && how != PERL_MAGIC_sv
4409 && how != PERL_MAGIC_backref
4412 Perl_croak(aTHX_ PL_no_modify);
4415 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4416 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4417 /* sv_magic() refuses to add a magic of the same 'how' as an
4420 if (how == PERL_MAGIC_taint) {
4422 /* Any scalar which already had taint magic on which someone
4423 (erroneously?) did SvIOK_on() or similar will now be
4424 incorrectly sporting public "OK" flags. */
4425 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4433 vtable = &PL_vtbl_sv;
4435 case PERL_MAGIC_overload:
4436 vtable = &PL_vtbl_amagic;
4438 case PERL_MAGIC_overload_elem:
4439 vtable = &PL_vtbl_amagicelem;
4441 case PERL_MAGIC_overload_table:
4442 vtable = &PL_vtbl_ovrld;
4445 vtable = &PL_vtbl_bm;
4447 case PERL_MAGIC_regdata:
4448 vtable = &PL_vtbl_regdata;
4450 case PERL_MAGIC_regdatum:
4451 vtable = &PL_vtbl_regdatum;
4453 case PERL_MAGIC_env:
4454 vtable = &PL_vtbl_env;
4457 vtable = &PL_vtbl_fm;
4459 case PERL_MAGIC_envelem:
4460 vtable = &PL_vtbl_envelem;
4462 case PERL_MAGIC_regex_global:
4463 vtable = &PL_vtbl_mglob;
4465 case PERL_MAGIC_isa:
4466 vtable = &PL_vtbl_isa;
4468 case PERL_MAGIC_isaelem:
4469 vtable = &PL_vtbl_isaelem;
4471 case PERL_MAGIC_nkeys:
4472 vtable = &PL_vtbl_nkeys;
4474 case PERL_MAGIC_dbfile:
4477 case PERL_MAGIC_dbline:
4478 vtable = &PL_vtbl_dbline;
4480 #ifdef USE_LOCALE_COLLATE
4481 case PERL_MAGIC_collxfrm:
4482 vtable = &PL_vtbl_collxfrm;
4484 #endif /* USE_LOCALE_COLLATE */
4485 case PERL_MAGIC_tied:
4486 vtable = &PL_vtbl_pack;
4488 case PERL_MAGIC_tiedelem:
4489 case PERL_MAGIC_tiedscalar:
4490 vtable = &PL_vtbl_packelem;
4493 vtable = &PL_vtbl_regexp;
4495 case PERL_MAGIC_sig:
4496 vtable = &PL_vtbl_sig;
4498 case PERL_MAGIC_sigelem:
4499 vtable = &PL_vtbl_sigelem;
4501 case PERL_MAGIC_taint:
4502 vtable = &PL_vtbl_taint;
4504 case PERL_MAGIC_uvar:
4505 vtable = &PL_vtbl_uvar;
4507 case PERL_MAGIC_vec:
4508 vtable = &PL_vtbl_vec;
4510 case PERL_MAGIC_arylen_p:
4511 case PERL_MAGIC_rhash:
4512 case PERL_MAGIC_symtab:
4513 case PERL_MAGIC_vstring:
4516 case PERL_MAGIC_utf8:
4517 vtable = &PL_vtbl_utf8;
4519 case PERL_MAGIC_substr:
4520 vtable = &PL_vtbl_substr;
4522 case PERL_MAGIC_defelem:
4523 vtable = &PL_vtbl_defelem;
4525 case PERL_MAGIC_arylen:
4526 vtable = &PL_vtbl_arylen;
4528 case PERL_MAGIC_pos:
4529 vtable = &PL_vtbl_pos;
4531 case PERL_MAGIC_backref:
4532 vtable = &PL_vtbl_backref;
4534 case PERL_MAGIC_ext:
4535 /* Reserved for use by extensions not perl internals. */
4536 /* Useful for attaching extension internal data to perl vars. */
4537 /* Note that multiple extensions may clash if magical scalars */
4538 /* etc holding private data from one are passed to another. */
4542 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4545 /* Rest of work is done else where */
4546 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4549 case PERL_MAGIC_taint:
4552 case PERL_MAGIC_ext:
4553 case PERL_MAGIC_dbfile:
4560 =for apidoc sv_unmagic
4562 Removes all magic of type C<type> from an SV.
4568 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4572 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4574 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4575 for (mg = *mgp; mg; mg = *mgp) {
4576 if (mg->mg_type == type) {
4577 const MGVTBL* const vtbl = mg->mg_virtual;
4578 *mgp = mg->mg_moremagic;
4579 if (vtbl && vtbl->svt_free)
4580 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4581 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4583 Safefree(mg->mg_ptr);
4584 else if (mg->mg_len == HEf_SVKEY)
4585 SvREFCNT_dec((SV*)mg->mg_ptr);
4586 else if (mg->mg_type == PERL_MAGIC_utf8)
4587 Safefree(mg->mg_ptr);
4589 if (mg->mg_flags & MGf_REFCOUNTED)
4590 SvREFCNT_dec(mg->mg_obj);
4594 mgp = &mg->mg_moremagic;
4598 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4599 SvMAGIC_set(sv, NULL);
4606 =for apidoc sv_rvweaken
4608 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4609 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4610 push a back-reference to this RV onto the array of backreferences
4611 associated with that magic.
4617 Perl_sv_rvweaken(pTHX_ SV *sv)
4620 if (!SvOK(sv)) /* let undefs pass */
4623 Perl_croak(aTHX_ "Can't weaken a nonreference");
4624 else if (SvWEAKREF(sv)) {
4625 if (ckWARN(WARN_MISC))
4626 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4630 Perl_sv_add_backref(aTHX_ tsv, sv);
4636 /* Give tsv backref magic if it hasn't already got it, then push a
4637 * back-reference to sv onto the array associated with the backref magic.
4641 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4646 if (SvTYPE(tsv) == SVt_PVHV) {
4647 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4651 /* There is no AV in the offical place - try a fixup. */
4652 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4655 /* Aha. They've got it stowed in magic. Bring it back. */
4656 av = (AV*)mg->mg_obj;
4657 /* Stop mg_free decreasing the refernce count. */
4659 /* Stop mg_free even calling the destructor, given that
4660 there's no AV to free up. */
4662 sv_unmagic(tsv, PERL_MAGIC_backref);
4666 SvREFCNT_inc_simple_void(av);
4671 const MAGIC *const mg
4672 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4674 av = (AV*)mg->mg_obj;
4678 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4679 /* av now has a refcnt of 2, which avoids it getting freed
4680 * before us during global cleanup. The extra ref is removed
4681 * by magic_killbackrefs() when tsv is being freed */
4684 if (AvFILLp(av) >= AvMAX(av)) {
4685 av_extend(av, AvFILLp(av)+1);
4687 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4690 /* delete a back-reference to ourselves from the backref magic associated
4691 * with the SV we point to.
4695 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4702 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4703 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4704 /* We mustn't attempt to "fix up" the hash here by moving the
4705 backreference array back to the hv_aux structure, as that is stored
4706 in the main HvARRAY(), and hfreentries assumes that no-one
4707 reallocates HvARRAY() while it is running. */
4710 const MAGIC *const mg
4711 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4713 av = (AV *)mg->mg_obj;
4716 if (PL_in_clean_all)
4718 Perl_croak(aTHX_ "panic: del_backref");
4725 /* We shouldn't be in here more than once, but for paranoia reasons lets
4727 for (i = AvFILLp(av); i >= 0; i--) {
4729 const SSize_t fill = AvFILLp(av);
4731 /* We weren't the last entry.
4732 An unordered list has this property that you can take the
4733 last element off the end to fill the hole, and it's still
4734 an unordered list :-)
4739 AvFILLp(av) = fill - 1;
4745 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4747 SV **svp = AvARRAY(av);
4749 PERL_UNUSED_ARG(sv);
4751 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4752 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4753 if (svp && !SvIS_FREED(av)) {
4754 SV *const *const last = svp + AvFILLp(av);
4756 while (svp <= last) {
4758 SV *const referrer = *svp;
4759 if (SvWEAKREF(referrer)) {
4760 /* XXX Should we check that it hasn't changed? */
4761 SvRV_set(referrer, 0);
4763 SvWEAKREF_off(referrer);
4764 } else if (SvTYPE(referrer) == SVt_PVGV ||
4765 SvTYPE(referrer) == SVt_PVLV) {
4766 /* You lookin' at me? */
4767 assert(GvSTASH(referrer));
4768 assert(GvSTASH(referrer) == (HV*)sv);
4769 GvSTASH(referrer) = 0;
4772 "panic: magic_killbackrefs (flags=%"UVxf")",
4773 (UV)SvFLAGS(referrer));
4781 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4786 =for apidoc sv_insert
4788 Inserts a string at the specified offset/length within the SV. Similar to
4789 the Perl substr() function.
4795 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4800 register char *midend;
4801 register char *bigend;
4807 Perl_croak(aTHX_ "Can't modify non-existent substring");
4808 SvPV_force(bigstr, curlen);
4809 (void)SvPOK_only_UTF8(bigstr);
4810 if (offset + len > curlen) {
4811 SvGROW(bigstr, offset+len+1);
4812 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4813 SvCUR_set(bigstr, offset+len);
4817 i = littlelen - len;
4818 if (i > 0) { /* string might grow */
4819 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4820 mid = big + offset + len;
4821 midend = bigend = big + SvCUR(bigstr);
4824 while (midend > mid) /* shove everything down */
4825 *--bigend = *--midend;
4826 Move(little,big+offset,littlelen,char);
4827 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4832 Move(little,SvPVX(bigstr)+offset,len,char);
4837 big = SvPVX(bigstr);
4840 bigend = big + SvCUR(bigstr);
4842 if (midend > bigend)
4843 Perl_croak(aTHX_ "panic: sv_insert");
4845 if (mid - big > bigend - midend) { /* faster to shorten from end */
4847 Move(little, mid, littlelen,char);
4850 i = bigend - midend;
4852 Move(midend, mid, i,char);
4856 SvCUR_set(bigstr, mid - big);
4858 else if ((i = mid - big)) { /* faster from front */
4859 midend -= littlelen;
4861 sv_chop(bigstr,midend-i);
4866 Move(little, mid, littlelen,char);
4868 else if (littlelen) {
4869 midend -= littlelen;
4870 sv_chop(bigstr,midend);
4871 Move(little,midend,littlelen,char);
4874 sv_chop(bigstr,midend);
4880 =for apidoc sv_replace
4882 Make the first argument a copy of the second, then delete the original.
4883 The target SV physically takes over ownership of the body of the source SV
4884 and inherits its flags; however, the target keeps any magic it owns,
4885 and any magic in the source is discarded.
4886 Note that this is a rather specialist SV copying operation; most of the
4887 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4893 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4896 const U32 refcnt = SvREFCNT(sv);
4897 SV_CHECK_THINKFIRST_COW_DROP(sv);
4898 if (SvREFCNT(nsv) != 1) {
4899 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4900 UVuf " != 1)", (UV) SvREFCNT(nsv));
4902 if (SvMAGICAL(sv)) {
4906 sv_upgrade(nsv, SVt_PVMG);
4907 SvMAGIC_set(nsv, SvMAGIC(sv));
4908 SvFLAGS(nsv) |= SvMAGICAL(sv);
4910 SvMAGIC_set(sv, NULL);
4914 assert(!SvREFCNT(sv));
4915 #ifdef DEBUG_LEAKING_SCALARS
4916 sv->sv_flags = nsv->sv_flags;
4917 sv->sv_any = nsv->sv_any;
4918 sv->sv_refcnt = nsv->sv_refcnt;
4919 sv->sv_u = nsv->sv_u;
4921 StructCopy(nsv,sv,SV);
4923 /* Currently could join these into one piece of pointer arithmetic, but
4924 it would be unclear. */
4925 if(SvTYPE(sv) == SVt_IV)
4927 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4928 else if (SvTYPE(sv) == SVt_RV) {
4929 SvANY(sv) = &sv->sv_u.svu_rv;
4933 #ifdef PERL_OLD_COPY_ON_WRITE
4934 if (SvIsCOW_normal(nsv)) {
4935 /* We need to follow the pointers around the loop to make the
4936 previous SV point to sv, rather than nsv. */
4939 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4942 assert(SvPVX_const(current) == SvPVX_const(nsv));
4944 /* Make the SV before us point to the SV after us. */
4946 PerlIO_printf(Perl_debug_log, "previous is\n");
4948 PerlIO_printf(Perl_debug_log,
4949 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4950 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4952 SV_COW_NEXT_SV_SET(current, sv);
4955 SvREFCNT(sv) = refcnt;
4956 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4962 =for apidoc sv_clear
4964 Clear an SV: call any destructors, free up any memory used by the body,
4965 and free the body itself. The SV's head is I<not> freed, although
4966 its type is set to all 1's so that it won't inadvertently be assumed
4967 to be live during global destruction etc.
4968 This function should only be called when REFCNT is zero. Most of the time
4969 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4976 Perl_sv_clear(pTHX_ register SV *sv)
4979 const U32 type = SvTYPE(sv);
4980 const struct body_details *const sv_type_details
4981 = bodies_by_type + type;
4984 assert(SvREFCNT(sv) == 0);
4986 if (type <= SVt_IV) {
4987 /* See the comment in sv.h about the collusion between this early
4988 return and the overloading of the NULL and IV slots in the size
4994 if (PL_defstash) { /* Still have a symbol table? */
4999 stash = SvSTASH(sv);
5000 destructor = StashHANDLER(stash,DESTROY);
5002 SV* const tmpref = newRV(sv);
5003 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5005 PUSHSTACKi(PERLSI_DESTROY);
5010 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5016 if(SvREFCNT(tmpref) < 2) {
5017 /* tmpref is not kept alive! */
5019 SvRV_set(tmpref, NULL);
5022 SvREFCNT_dec(tmpref);
5024 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5028 if (PL_in_clean_objs)
5029 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5031 /* DESTROY gave object new lease on life */
5037 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5038 SvOBJECT_off(sv); /* Curse the object. */
5039 if (type != SVt_PVIO)
5040 --PL_sv_objcount; /* XXX Might want something more general */
5043 if (type >= SVt_PVMG) {
5045 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5046 (ourstash = OURSTASH(sv))) {
5047 SvREFCNT_dec(ourstash);
5048 } else if (SvMAGIC(sv))
5050 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5051 SvREFCNT_dec(SvSTASH(sv));
5056 IoIFP(sv) != PerlIO_stdin() &&
5057 IoIFP(sv) != PerlIO_stdout() &&
5058 IoIFP(sv) != PerlIO_stderr())
5060 io_close((IO*)sv, FALSE);
5062 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5063 PerlDir_close(IoDIRP(sv));
5064 IoDIRP(sv) = (DIR*)NULL;
5065 Safefree(IoTOP_NAME(sv));
5066 Safefree(IoFMT_NAME(sv));
5067 Safefree(IoBOTTOM_NAME(sv));
5076 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5083 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5084 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5085 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5086 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5088 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5089 SvREFCNT_dec(LvTARG(sv));
5093 if (GvNAME_HEK(sv)) {
5094 unshare_hek(GvNAME_HEK(sv));
5096 /* If we're in a stash, we don't own a reference to it. However it does
5097 have a back reference to us, which needs to be cleared. */
5099 sv_del_backref((SV*)GvSTASH(sv), sv);
5104 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5106 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5107 /* Don't even bother with turning off the OOK flag. */
5112 SV * const target = SvRV(sv);
5114 sv_del_backref(target, sv);
5116 SvREFCNT_dec(target);
5118 #ifdef PERL_OLD_COPY_ON_WRITE
5119 else if (SvPVX_const(sv)) {
5121 /* I believe I need to grab the global SV mutex here and
5122 then recheck the COW status. */
5124 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5127 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5128 SV_COW_NEXT_SV(sv));
5129 /* And drop it here. */
5131 } else if (SvLEN(sv)) {
5132 Safefree(SvPVX_const(sv));
5136 else if (SvPVX_const(sv) && SvLEN(sv))
5137 Safefree(SvPVX_mutable(sv));
5138 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5139 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5148 SvFLAGS(sv) &= SVf_BREAK;
5149 SvFLAGS(sv) |= SVTYPEMASK;
5151 if (sv_type_details->arena) {
5152 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5153 &PL_body_roots[type]);
5155 else if (sv_type_details->body_size) {
5156 my_safefree(SvANY(sv));
5161 =for apidoc sv_newref
5163 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5170 Perl_sv_newref(pTHX_ SV *sv)
5172 PERL_UNUSED_CONTEXT;
5181 Decrement an SV's reference count, and if it drops to zero, call
5182 C<sv_clear> to invoke destructors and free up any memory used by
5183 the body; finally, deallocate the SV's head itself.
5184 Normally called via a wrapper macro C<SvREFCNT_dec>.
5190 Perl_sv_free(pTHX_ SV *sv)
5195 if (SvREFCNT(sv) == 0) {
5196 if (SvFLAGS(sv) & SVf_BREAK)
5197 /* this SV's refcnt has been artificially decremented to
5198 * trigger cleanup */
5200 if (PL_in_clean_all) /* All is fair */
5202 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5203 /* make sure SvREFCNT(sv)==0 happens very seldom */
5204 SvREFCNT(sv) = (~(U32)0)/2;
5207 if (ckWARN_d(WARN_INTERNAL)) {
5208 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5209 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5210 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5211 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5212 Perl_dump_sv_child(aTHX_ sv);
5217 if (--(SvREFCNT(sv)) > 0)
5219 Perl_sv_free2(aTHX_ sv);
5223 Perl_sv_free2(pTHX_ SV *sv)
5228 if (ckWARN_d(WARN_DEBUGGING))
5229 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5230 "Attempt to free temp prematurely: SV 0x%"UVxf
5231 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5235 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5236 /* make sure SvREFCNT(sv)==0 happens very seldom */
5237 SvREFCNT(sv) = (~(U32)0)/2;
5248 Returns the length of the string in the SV. Handles magic and type
5249 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5255 Perl_sv_len(pTHX_ register SV *sv)
5263 len = mg_length(sv);
5265 (void)SvPV_const(sv, len);
5270 =for apidoc sv_len_utf8
5272 Returns the number of characters in the string in an SV, counting wide
5273 UTF-8 bytes as a single character. Handles magic and type coercion.
5279 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5280 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5281 * (Note that the mg_len is not the length of the mg_ptr field.)
5286 Perl_sv_len_utf8(pTHX_ register SV *sv)
5292 return mg_length(sv);
5296 const U8 *s = (U8*)SvPV_const(sv, len);
5300 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5302 if (mg && mg->mg_len != -1) {
5304 if (PL_utf8cache < 0) {
5305 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5307 /* Need to turn the assertions off otherwise we may
5308 recurse infinitely while printing error messages.
5310 SAVEI8(PL_utf8cache);
5312 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5313 " real %"UVf" for %"SVf,
5314 (UV) ulen, (UV) real, sv);
5319 ulen = Perl_utf8_length(aTHX_ s, s + len);
5320 if (!SvREADONLY(sv)) {
5322 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5323 &PL_vtbl_utf8, 0, 0);
5331 return Perl_utf8_length(aTHX_ s, s + len);
5335 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5336 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5337 * between UTF-8 and byte offsets. There are two (substr offset and substr
5338 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5339 * and byte offset) cache positions.
5341 * The mg_len field is used by sv_len_utf8(), see its comments.
5342 * Note that the mg_len is not the length of the mg_ptr field.
5346 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5347 I32 offsetp, const U8 *s, const U8 *start)
5351 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5353 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5354 (*mgp)->mg_len = -1;
5359 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5361 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5362 (*mgp)->mg_ptr = (char *) *cachep;
5366 (*cachep)[i] = offsetp;
5367 (*cachep)[i+1] = s - start;
5375 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5376 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5377 * between UTF-8 and byte offsets. See also the comments of
5378 * S_utf8_mg_pos_init().
5382 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5386 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5388 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5389 if (*mgp && (*mgp)->mg_ptr) {
5390 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5391 ASSERT_UTF8_CACHE(*cachep);
5392 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5394 else { /* We will skip to the right spot. */
5399 /* The assumption is that going backward is half
5400 * the speed of going forward (that's where the
5401 * 2 * backw in the below comes from). (The real
5402 * figure of course depends on the UTF-8 data.) */
5404 if ((*cachep)[i] > (STRLEN)uoff) {
5406 backw = (*cachep)[i] - (STRLEN)uoff;
5408 if (forw < 2 * backw)
5411 p = start + (*cachep)[i+1];
5413 /* Try this only for the substr offset (i == 0),
5414 * not for the substr length (i == 2). */
5415 else if (i == 0) { /* (*cachep)[i] < uoff */
5416 const STRLEN ulen = sv_len_utf8(sv);
5418 if ((STRLEN)uoff < ulen) {
5419 forw = (STRLEN)uoff - (*cachep)[i];
5420 backw = ulen - (STRLEN)uoff;
5422 if (forw < 2 * backw)
5423 p = start + (*cachep)[i+1];
5428 /* If the string is not long enough for uoff,
5429 * we could extend it, but not at this low a level. */
5433 if (forw < 2 * backw) {
5440 while (UTF8_IS_CONTINUATION(*p))
5445 /* Update the cache. */
5446 (*cachep)[i] = (STRLEN)uoff;
5447 (*cachep)[i+1] = p - start;
5449 /* Drop the stale "length" cache */
5458 if (found) { /* Setup the return values. */
5459 *offsetp = (*cachep)[i+1];
5460 *sp = start + *offsetp;
5463 *offsetp = send - start;
5465 else if (*sp < start) {
5471 #ifdef PERL_UTF8_CACHE_ASSERT
5473 const U8 *s = start;
5476 while (n-- && s < send)
5480 assert(*offsetp == s - start);
5481 assert((*cachep)[0] == (STRLEN)uoff);
5482 assert((*cachep)[1] == *offsetp);
5484 ASSERT_UTF8_CACHE(*cachep);
5493 =for apidoc sv_pos_u2b
5495 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5496 the start of the string, to a count of the equivalent number of bytes; if
5497 lenp is non-zero, it does the same to lenp, but this time starting from
5498 the offset, rather than from the start of the string. Handles magic and
5505 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5506 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5507 * byte offsets. See also the comments of S_utf8_mg_pos().
5512 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8);
5515 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5518 const U8 *s = start;
5520 while (s < send && uoffset--)
5523 /* This is the existing behaviour. Possibly it should be a croak, as
5524 it's actually a bounds error */
5532 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5533 STRLEN uoffset, STRLEN uend)
5535 STRLEN backw = uend - uoffset;
5536 if (uoffset < 2 * backw) {
5537 /* The assumption is that going fowards is twice the speed of going
5538 forward (that's where the 2 * backw comes from).
5539 (The real figure of course depends on the UTF-8 data.) */
5540 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5545 while (UTF8_IS_CONTINUATION(*send))
5548 return send - start;
5552 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5553 const U8 *const send, STRLEN uoffset,
5554 STRLEN uoffset0, STRLEN boffset0) {
5558 assert (uoffset >= uoffset0);
5560 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5561 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5562 if ((*mgp)->mg_ptr) {
5563 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5564 if (cache[0] == uoffset) {
5565 /* An exact match. */
5569 if (cache[0] < uoffset) {
5570 /* The cache already knows part of the way. */
5571 if (cache[0] > uoffset0) {
5572 /* The cache knows more than the passed in pair */
5573 uoffset0 = cache[0];
5574 boffset0 = cache[1];
5576 if ((*mgp)->mg_len != -1) {
5577 /* And we know the end too. */
5579 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5581 (*mgp)->mg_len - uoffset0);
5584 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5585 send, uoffset - uoffset0);
5589 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5592 cache[0] - uoffset0);
5596 else if ((*mgp)->mg_len != -1) {
5597 /* If we can take advantage of a passed in offset, do so. */
5598 /* In fact, offset0 is either 0, or less than offset, so don't
5599 need to worry about the other possibility. */
5601 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5603 (*mgp)->mg_len - uoffset0);
5608 if (!found || PL_utf8cache < 0) {
5609 const STRLEN real_boffset
5610 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5611 send, uoffset - uoffset0);
5613 if (found && PL_utf8cache < 0) {
5614 if (real_boffset != boffset) {
5615 /* Need to turn the assertions off otherwise we may recurse
5616 infinitely while printing error messages. */
5617 SAVEI8(PL_utf8cache);
5619 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5620 " real %"UVf" for %"SVf,
5621 (UV) boffset, (UV) real_boffset, sv);
5624 boffset = real_boffset;
5627 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset);
5632 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5640 start = (U8*)SvPV_const(sv, len);
5642 STRLEN uoffset = (STRLEN) *offsetp;
5643 const U8 * const send = start + len;
5645 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5648 *offsetp = (I32) boffset;
5651 /* Convert the relative offset to absolute. */
5652 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5654 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5655 uoffset, boffset) - boffset;
5670 =for apidoc sv_pos_b2u
5672 Converts the value pointed to by offsetp from a count of bytes from the
5673 start of the string, to a count of the equivalent number of UTF-8 chars.
5674 Handles magic and type coercion.
5680 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5681 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5682 * byte offsets. See also the comments of S_utf8_mg_pos().
5688 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target);
5691 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8)
5698 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5700 (*mgp)->mg_len = -1;
5704 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5705 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5706 (*mgp)->mg_ptr = (char *) cache;
5710 if (PL_utf8cache < 0) {
5711 const U8 *start = (const U8 *) SvPVX_const(sv);
5712 const U8 *const end = start + byte;
5713 STRLEN realutf8 = 0;
5715 while (start < end) {
5716 start += UTF8SKIP(start);
5720 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5721 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5722 doesn't? I don't know whether this difference was introduced with
5723 the caching code in 5.8.1. */
5725 if (realutf8 != utf8) {
5726 /* Need to turn the assertions off otherwise we may recurse
5727 infinitely while printing error messages. */
5728 SAVEI8(PL_utf8cache);
5730 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5731 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5736 ASSERT_UTF8_CACHE(cache);
5737 /* Drop the stale "length" cache */
5742 /* If we don't know the character offset of the end of a region, our only
5743 option is to walk forwards to the target byte offset. */
5745 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5748 while (s < target) {
5751 /* Call utf8n_to_uvchr() to validate the sequence
5752 * (unless a simple non-UTF character) */
5753 if (!UTF8_IS_INVARIANT(*s))
5754 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5765 /* We already know all of the way, now we may be able to walk back. The same
5766 assumption is made as in S_utf8_mg_pos(), namely that walking backward is
5767 twice slower than walking forward. */
5769 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5772 const STRLEN forw = target - s;
5773 STRLEN backw = end - target;
5775 if (forw < 2 * backw) {
5776 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5779 while (end > target) {
5781 while (UTF8_IS_CONTINUATION(*end)) {
5790 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5793 const STRLEN byte = *offsetp;
5801 s = (const U8*)SvPV_const(sv, len);
5804 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5808 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5809 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5811 STRLEN *cache = (STRLEN *) mg->mg_ptr;
5812 if (cache[1] == byte) {
5813 /* An exact match. */
5814 *offsetp = cache[0];
5818 if (cache[1] < byte) {
5819 /* We already know part of the way. */
5820 if (mg->mg_len != -1) {
5821 /* Actually, we know the end too. */
5823 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5824 s + len, mg->mg_len - cache[0]);
5827 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5830 else { /* cache[1] > byte */
5831 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[1],
5835 ASSERT_UTF8_CACHE(cache);
5836 if (PL_utf8cache < 0) {
5837 const STRLEN reallen = S_sv_pos_b2u_forwards(aTHX_ s, send);
5839 if (len != reallen) {
5840 /* Need to turn the assertions off otherwise we may recurse
5841 infinitely while printing error messages. */
5842 SAVEI8(PL_utf8cache);
5844 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5845 " real %"UVf" for %"SVf,
5846 (UV) len, (UV) reallen, sv);
5849 } else if (mg->mg_len != -1) {
5850 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + len, mg->mg_len);
5852 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5856 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5860 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len);
5866 Returns a boolean indicating whether the strings in the two SVs are
5867 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5868 coerce its args to strings if necessary.
5874 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5883 SV* svrecode = NULL;
5890 pv1 = SvPV_const(sv1, cur1);
5897 pv2 = SvPV_const(sv2, cur2);
5899 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5900 /* Differing utf8ness.
5901 * Do not UTF8size the comparands as a side-effect. */
5904 svrecode = newSVpvn(pv2, cur2);
5905 sv_recode_to_utf8(svrecode, PL_encoding);
5906 pv2 = SvPV_const(svrecode, cur2);
5909 svrecode = newSVpvn(pv1, cur1);
5910 sv_recode_to_utf8(svrecode, PL_encoding);
5911 pv1 = SvPV_const(svrecode, cur1);
5913 /* Now both are in UTF-8. */
5915 SvREFCNT_dec(svrecode);
5920 bool is_utf8 = TRUE;
5923 /* sv1 is the UTF-8 one,
5924 * if is equal it must be downgrade-able */
5925 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5931 /* sv2 is the UTF-8 one,
5932 * if is equal it must be downgrade-able */
5933 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5939 /* Downgrade not possible - cannot be eq */
5947 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5949 SvREFCNT_dec(svrecode);
5959 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5960 string in C<sv1> is less than, equal to, or greater than the string in
5961 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5962 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5968 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5972 const char *pv1, *pv2;
5975 SV *svrecode = NULL;
5982 pv1 = SvPV_const(sv1, cur1);
5989 pv2 = SvPV_const(sv2, cur2);
5991 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5992 /* Differing utf8ness.
5993 * Do not UTF8size the comparands as a side-effect. */
5996 svrecode = newSVpvn(pv2, cur2);
5997 sv_recode_to_utf8(svrecode, PL_encoding);
5998 pv2 = SvPV_const(svrecode, cur2);
6001 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6006 svrecode = newSVpvn(pv1, cur1);
6007 sv_recode_to_utf8(svrecode, PL_encoding);
6008 pv1 = SvPV_const(svrecode, cur1);
6011 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6017 cmp = cur2 ? -1 : 0;
6021 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6024 cmp = retval < 0 ? -1 : 1;
6025 } else if (cur1 == cur2) {
6028 cmp = cur1 < cur2 ? -1 : 1;
6032 SvREFCNT_dec(svrecode);
6040 =for apidoc sv_cmp_locale
6042 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6043 'use bytes' aware, handles get magic, and will coerce its args to strings
6044 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6050 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6053 #ifdef USE_LOCALE_COLLATE
6059 if (PL_collation_standard)
6063 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6065 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6067 if (!pv1 || !len1) {
6078 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6081 return retval < 0 ? -1 : 1;
6084 * When the result of collation is equality, that doesn't mean
6085 * that there are no differences -- some locales exclude some
6086 * characters from consideration. So to avoid false equalities,
6087 * we use the raw string as a tiebreaker.
6093 #endif /* USE_LOCALE_COLLATE */
6095 return sv_cmp(sv1, sv2);
6099 #ifdef USE_LOCALE_COLLATE
6102 =for apidoc sv_collxfrm
6104 Add Collate Transform magic to an SV if it doesn't already have it.
6106 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6107 scalar data of the variable, but transformed to such a format that a normal
6108 memory comparison can be used to compare the data according to the locale
6115 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6120 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6121 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6127 Safefree(mg->mg_ptr);
6128 s = SvPV_const(sv, len);
6129 if ((xf = mem_collxfrm(s, len, &xlen))) {
6130 if (SvREADONLY(sv)) {
6133 return xf + sizeof(PL_collation_ix);
6136 #ifdef PERL_OLD_COPY_ON_WRITE
6138 sv_force_normal_flags(sv, 0);
6140 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6154 if (mg && mg->mg_ptr) {
6156 return mg->mg_ptr + sizeof(PL_collation_ix);
6164 #endif /* USE_LOCALE_COLLATE */
6169 Get a line from the filehandle and store it into the SV, optionally
6170 appending to the currently-stored string.
6176 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6181 register STDCHAR rslast;
6182 register STDCHAR *bp;
6188 if (SvTHINKFIRST(sv))
6189 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6190 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6192 However, perlbench says it's slower, because the existing swipe code
6193 is faster than copy on write.
6194 Swings and roundabouts. */
6195 SvUPGRADE(sv, SVt_PV);
6200 if (PerlIO_isutf8(fp)) {
6202 sv_utf8_upgrade_nomg(sv);
6203 sv_pos_u2b(sv,&append,0);
6205 } else if (SvUTF8(sv)) {
6206 SV * const tsv = newSV(0);
6207 sv_gets(tsv, fp, 0);
6208 sv_utf8_upgrade_nomg(tsv);
6209 SvCUR_set(sv,append);
6212 goto return_string_or_null;
6217 if (PerlIO_isutf8(fp))
6220 if (IN_PERL_COMPILETIME) {
6221 /* we always read code in line mode */
6225 else if (RsSNARF(PL_rs)) {
6226 /* If it is a regular disk file use size from stat() as estimate
6227 of amount we are going to read - may result in malloc-ing
6228 more memory than we realy need if layers bellow reduce
6229 size we read (e.g. CRLF or a gzip layer)
6232 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6233 const Off_t offset = PerlIO_tell(fp);
6234 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6235 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6241 else if (RsRECORD(PL_rs)) {
6245 /* Grab the size of the record we're getting */
6246 recsize = SvIV(SvRV(PL_rs));
6247 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6250 /* VMS wants read instead of fread, because fread doesn't respect */
6251 /* RMS record boundaries. This is not necessarily a good thing to be */
6252 /* doing, but we've got no other real choice - except avoid stdio
6253 as implementation - perhaps write a :vms layer ?
6255 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6257 bytesread = PerlIO_read(fp, buffer, recsize);
6261 SvCUR_set(sv, bytesread += append);
6262 buffer[bytesread] = '\0';
6263 goto return_string_or_null;
6265 else if (RsPARA(PL_rs)) {
6271 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6272 if (PerlIO_isutf8(fp)) {
6273 rsptr = SvPVutf8(PL_rs, rslen);
6276 if (SvUTF8(PL_rs)) {
6277 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6278 Perl_croak(aTHX_ "Wide character in $/");
6281 rsptr = SvPV_const(PL_rs, rslen);
6285 rslast = rslen ? rsptr[rslen - 1] : '\0';
6287 if (rspara) { /* have to do this both before and after */
6288 do { /* to make sure file boundaries work right */
6291 i = PerlIO_getc(fp);
6295 PerlIO_ungetc(fp,i);
6301 /* See if we know enough about I/O mechanism to cheat it ! */
6303 /* This used to be #ifdef test - it is made run-time test for ease
6304 of abstracting out stdio interface. One call should be cheap
6305 enough here - and may even be a macro allowing compile
6309 if (PerlIO_fast_gets(fp)) {
6312 * We're going to steal some values from the stdio struct
6313 * and put EVERYTHING in the innermost loop into registers.
6315 register STDCHAR *ptr;
6319 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6320 /* An ungetc()d char is handled separately from the regular
6321 * buffer, so we getc() it back out and stuff it in the buffer.
6323 i = PerlIO_getc(fp);
6324 if (i == EOF) return 0;
6325 *(--((*fp)->_ptr)) = (unsigned char) i;
6329 /* Here is some breathtakingly efficient cheating */
6331 cnt = PerlIO_get_cnt(fp); /* get count into register */
6332 /* make sure we have the room */
6333 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6334 /* Not room for all of it
6335 if we are looking for a separator and room for some
6337 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6338 /* just process what we have room for */
6339 shortbuffered = cnt - SvLEN(sv) + append + 1;
6340 cnt -= shortbuffered;
6344 /* remember that cnt can be negative */
6345 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6350 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6351 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6352 DEBUG_P(PerlIO_printf(Perl_debug_log,
6353 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6354 DEBUG_P(PerlIO_printf(Perl_debug_log,
6355 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6356 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6357 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6362 while (cnt > 0) { /* this | eat */
6364 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6365 goto thats_all_folks; /* screams | sed :-) */
6369 Copy(ptr, bp, cnt, char); /* this | eat */
6370 bp += cnt; /* screams | dust */
6371 ptr += cnt; /* louder | sed :-) */
6376 if (shortbuffered) { /* oh well, must extend */
6377 cnt = shortbuffered;
6379 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6381 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6382 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
6387 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6388 PTR2UV(ptr),(long)cnt));
6389 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6391 DEBUG_P(PerlIO_printf(Perl_debug_log,
6392 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6393 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6394 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6396 /* This used to call 'filbuf' in stdio form, but as that behaves like
6397 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6398 another abstraction. */
6399 i = PerlIO_getc(fp); /* get more characters */
6401 DEBUG_P(PerlIO_printf(Perl_debug_log,
6402 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6403 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6404 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6406 cnt = PerlIO_get_cnt(fp);
6407 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6408 DEBUG_P(PerlIO_printf(Perl_debug_log,
6409 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6411 if (i == EOF) /* all done for ever? */
6412 goto thats_really_all_folks;
6414 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6416 SvGROW(sv, bpx + cnt + 2);
6417 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6419 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6421 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6422 goto thats_all_folks;
6426 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6427 memNE((char*)bp - rslen, rsptr, rslen))
6428 goto screamer; /* go back to the fray */
6429 thats_really_all_folks:
6431 cnt += shortbuffered;
6432 DEBUG_P(PerlIO_printf(Perl_debug_log,
6433 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6434 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6435 DEBUG_P(PerlIO_printf(Perl_debug_log,
6436 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6437 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6438 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6440 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6441 DEBUG_P(PerlIO_printf(Perl_debug_log,
6442 "Screamer: done, len=%ld, string=|%.*s|\n",
6443 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6447 /*The big, slow, and stupid way. */
6448 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6449 STDCHAR *buf = NULL;
6450 Newx(buf, 8192, STDCHAR);
6458 register const STDCHAR * const bpe = buf + sizeof(buf);
6460 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6461 ; /* keep reading */
6465 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6466 /* Accomodate broken VAXC compiler, which applies U8 cast to
6467 * both args of ?: operator, causing EOF to change into 255
6470 i = (U8)buf[cnt - 1];
6476 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6478 sv_catpvn(sv, (char *) buf, cnt);
6480 sv_setpvn(sv, (char *) buf, cnt);
6482 if (i != EOF && /* joy */
6484 SvCUR(sv) < rslen ||
6485 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6489 * If we're reading from a TTY and we get a short read,
6490 * indicating that the user hit his EOF character, we need
6491 * to notice it now, because if we try to read from the TTY
6492 * again, the EOF condition will disappear.
6494 * The comparison of cnt to sizeof(buf) is an optimization
6495 * that prevents unnecessary calls to feof().
6499 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6503 #ifdef USE_HEAP_INSTEAD_OF_STACK
6508 if (rspara) { /* have to do this both before and after */
6509 while (i != EOF) { /* to make sure file boundaries work right */
6510 i = PerlIO_getc(fp);
6512 PerlIO_ungetc(fp,i);
6518 return_string_or_null:
6519 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6525 Auto-increment of the value in the SV, doing string to numeric conversion
6526 if necessary. Handles 'get' magic.
6532 Perl_sv_inc(pTHX_ register SV *sv)
6541 if (SvTHINKFIRST(sv)) {
6543 sv_force_normal_flags(sv, 0);
6544 if (SvREADONLY(sv)) {
6545 if (IN_PERL_RUNTIME)
6546 Perl_croak(aTHX_ PL_no_modify);
6550 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6552 i = PTR2IV(SvRV(sv));
6557 flags = SvFLAGS(sv);
6558 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6559 /* It's (privately or publicly) a float, but not tested as an
6560 integer, so test it to see. */
6562 flags = SvFLAGS(sv);
6564 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6565 /* It's publicly an integer, or privately an integer-not-float */
6566 #ifdef PERL_PRESERVE_IVUV
6570 if (SvUVX(sv) == UV_MAX)
6571 sv_setnv(sv, UV_MAX_P1);
6573 (void)SvIOK_only_UV(sv);
6574 SvUV_set(sv, SvUVX(sv) + 1);
6576 if (SvIVX(sv) == IV_MAX)
6577 sv_setuv(sv, (UV)IV_MAX + 1);
6579 (void)SvIOK_only(sv);
6580 SvIV_set(sv, SvIVX(sv) + 1);
6585 if (flags & SVp_NOK) {
6586 (void)SvNOK_only(sv);
6587 SvNV_set(sv, SvNVX(sv) + 1.0);
6591 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6592 if ((flags & SVTYPEMASK) < SVt_PVIV)
6593 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6594 (void)SvIOK_only(sv);
6599 while (isALPHA(*d)) d++;
6600 while (isDIGIT(*d)) d++;
6602 #ifdef PERL_PRESERVE_IVUV
6603 /* Got to punt this as an integer if needs be, but we don't issue
6604 warnings. Probably ought to make the sv_iv_please() that does
6605 the conversion if possible, and silently. */
6606 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6607 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6608 /* Need to try really hard to see if it's an integer.
6609 9.22337203685478e+18 is an integer.
6610 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6611 so $a="9.22337203685478e+18"; $a+0; $a++
6612 needs to be the same as $a="9.22337203685478e+18"; $a++
6619 /* sv_2iv *should* have made this an NV */
6620 if (flags & SVp_NOK) {
6621 (void)SvNOK_only(sv);
6622 SvNV_set(sv, SvNVX(sv) + 1.0);
6625 /* I don't think we can get here. Maybe I should assert this
6626 And if we do get here I suspect that sv_setnv will croak. NWC
6628 #if defined(USE_LONG_DOUBLE)
6629 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",
6630 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6632 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6633 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6636 #endif /* PERL_PRESERVE_IVUV */
6637 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6641 while (d >= SvPVX_const(sv)) {
6649 /* MKS: The original code here died if letters weren't consecutive.
6650 * at least it didn't have to worry about non-C locales. The
6651 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6652 * arranged in order (although not consecutively) and that only
6653 * [A-Za-z] are accepted by isALPHA in the C locale.
6655 if (*d != 'z' && *d != 'Z') {
6656 do { ++*d; } while (!isALPHA(*d));
6659 *(d--) -= 'z' - 'a';
6664 *(d--) -= 'z' - 'a' + 1;
6668 /* oh,oh, the number grew */
6669 SvGROW(sv, SvCUR(sv) + 2);
6670 SvCUR_set(sv, SvCUR(sv) + 1);
6671 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6682 Auto-decrement of the value in the SV, doing string to numeric conversion
6683 if necessary. Handles 'get' magic.
6689 Perl_sv_dec(pTHX_ register SV *sv)
6697 if (SvTHINKFIRST(sv)) {
6699 sv_force_normal_flags(sv, 0);
6700 if (SvREADONLY(sv)) {
6701 if (IN_PERL_RUNTIME)
6702 Perl_croak(aTHX_ PL_no_modify);
6706 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6708 i = PTR2IV(SvRV(sv));
6713 /* Unlike sv_inc we don't have to worry about string-never-numbers
6714 and keeping them magic. But we mustn't warn on punting */
6715 flags = SvFLAGS(sv);
6716 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6717 /* It's publicly an integer, or privately an integer-not-float */
6718 #ifdef PERL_PRESERVE_IVUV
6722 if (SvUVX(sv) == 0) {
6723 (void)SvIOK_only(sv);
6727 (void)SvIOK_only_UV(sv);
6728 SvUV_set(sv, SvUVX(sv) - 1);
6731 if (SvIVX(sv) == IV_MIN)
6732 sv_setnv(sv, (NV)IV_MIN - 1.0);
6734 (void)SvIOK_only(sv);
6735 SvIV_set(sv, SvIVX(sv) - 1);
6740 if (flags & SVp_NOK) {
6741 SvNV_set(sv, SvNVX(sv) - 1.0);
6742 (void)SvNOK_only(sv);
6745 if (!(flags & SVp_POK)) {
6746 if ((flags & SVTYPEMASK) < SVt_PVIV)
6747 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6749 (void)SvIOK_only(sv);
6752 #ifdef PERL_PRESERVE_IVUV
6754 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6755 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6756 /* Need to try really hard to see if it's an integer.
6757 9.22337203685478e+18 is an integer.
6758 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6759 so $a="9.22337203685478e+18"; $a+0; $a--
6760 needs to be the same as $a="9.22337203685478e+18"; $a--
6767 /* sv_2iv *should* have made this an NV */
6768 if (flags & SVp_NOK) {
6769 (void)SvNOK_only(sv);
6770 SvNV_set(sv, SvNVX(sv) - 1.0);
6773 /* I don't think we can get here. Maybe I should assert this
6774 And if we do get here I suspect that sv_setnv will croak. NWC
6776 #if defined(USE_LONG_DOUBLE)
6777 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",
6778 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6780 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6781 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6785 #endif /* PERL_PRESERVE_IVUV */
6786 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6790 =for apidoc sv_mortalcopy
6792 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6793 The new SV is marked as mortal. It will be destroyed "soon", either by an
6794 explicit call to FREETMPS, or by an implicit call at places such as
6795 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6800 /* Make a string that will exist for the duration of the expression
6801 * evaluation. Actually, it may have to last longer than that, but
6802 * hopefully we won't free it until it has been assigned to a
6803 * permanent location. */
6806 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6812 sv_setsv(sv,oldstr);
6814 PL_tmps_stack[++PL_tmps_ix] = sv;
6820 =for apidoc sv_newmortal
6822 Creates a new null SV which is mortal. The reference count of the SV is
6823 set to 1. It will be destroyed "soon", either by an explicit call to
6824 FREETMPS, or by an implicit call at places such as statement boundaries.
6825 See also C<sv_mortalcopy> and C<sv_2mortal>.
6831 Perl_sv_newmortal(pTHX)
6837 SvFLAGS(sv) = SVs_TEMP;
6839 PL_tmps_stack[++PL_tmps_ix] = sv;
6844 =for apidoc sv_2mortal
6846 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6847 by an explicit call to FREETMPS, or by an implicit call at places such as
6848 statement boundaries. SvTEMP() is turned on which means that the SV's
6849 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6850 and C<sv_mortalcopy>.
6856 Perl_sv_2mortal(pTHX_ register SV *sv)
6861 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6864 PL_tmps_stack[++PL_tmps_ix] = sv;
6872 Creates a new SV and copies a string into it. The reference count for the
6873 SV is set to 1. If C<len> is zero, Perl will compute the length using
6874 strlen(). For efficiency, consider using C<newSVpvn> instead.
6880 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6886 sv_setpvn(sv,s,len ? len : strlen(s));
6891 =for apidoc newSVpvn
6893 Creates a new SV and copies a string into it. The reference count for the
6894 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6895 string. You are responsible for ensuring that the source string is at least
6896 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6902 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6908 sv_setpvn(sv,s,len);
6914 =for apidoc newSVhek
6916 Creates a new SV from the hash key structure. It will generate scalars that
6917 point to the shared string table where possible. Returns a new (undefined)
6918 SV if the hek is NULL.
6924 Perl_newSVhek(pTHX_ const HEK *hek)
6934 if (HEK_LEN(hek) == HEf_SVKEY) {
6935 return newSVsv(*(SV**)HEK_KEY(hek));
6937 const int flags = HEK_FLAGS(hek);
6938 if (flags & HVhek_WASUTF8) {
6940 Andreas would like keys he put in as utf8 to come back as utf8
6942 STRLEN utf8_len = HEK_LEN(hek);
6943 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6944 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6947 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6949 } else if (flags & HVhek_REHASH) {
6950 /* We don't have a pointer to the hv, so we have to replicate the
6951 flag into every HEK. This hv is using custom a hasing
6952 algorithm. Hence we can't return a shared string scalar, as
6953 that would contain the (wrong) hash value, and might get passed
6954 into an hv routine with a regular hash */
6956 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6961 /* This will be overwhelminly the most common case. */
6962 return newSVpvn_share(HEK_KEY(hek),
6963 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6969 =for apidoc newSVpvn_share
6971 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6972 table. If the string does not already exist in the table, it is created
6973 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6974 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6975 otherwise the hash is computed. The idea here is that as the string table
6976 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6977 hash lookup will avoid string compare.
6983 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6987 bool is_utf8 = FALSE;
6989 STRLEN tmplen = -len;
6991 /* See the note in hv.c:hv_fetch() --jhi */
6992 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6996 PERL_HASH(hash, src, len);
6998 sv_upgrade(sv, SVt_PV);
6999 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7011 #if defined(PERL_IMPLICIT_CONTEXT)
7013 /* pTHX_ magic can't cope with varargs, so this is a no-context
7014 * version of the main function, (which may itself be aliased to us).
7015 * Don't access this version directly.
7019 Perl_newSVpvf_nocontext(const char* pat, ...)
7024 va_start(args, pat);
7025 sv = vnewSVpvf(pat, &args);
7032 =for apidoc newSVpvf
7034 Creates a new SV and initializes it with the string formatted like
7041 Perl_newSVpvf(pTHX_ const char* pat, ...)
7045 va_start(args, pat);
7046 sv = vnewSVpvf(pat, &args);
7051 /* backend for newSVpvf() and newSVpvf_nocontext() */
7054 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7059 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7066 Creates a new SV and copies a floating point value into it.
7067 The reference count for the SV is set to 1.
7073 Perl_newSVnv(pTHX_ NV n)
7086 Creates a new SV and copies an integer into it. The reference count for the
7093 Perl_newSViv(pTHX_ IV i)
7106 Creates a new SV and copies an unsigned integer into it.
7107 The reference count for the SV is set to 1.
7113 Perl_newSVuv(pTHX_ UV u)
7124 =for apidoc newRV_noinc
7126 Creates an RV wrapper for an SV. The reference count for the original
7127 SV is B<not> incremented.
7133 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7139 sv_upgrade(sv, SVt_RV);
7141 SvRV_set(sv, tmpRef);
7146 /* newRV_inc is the official function name to use now.
7147 * newRV_inc is in fact #defined to newRV in sv.h
7151 Perl_newRV(pTHX_ SV *sv)
7154 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7160 Creates a new SV which is an exact duplicate of the original SV.
7167 Perl_newSVsv(pTHX_ register SV *old)
7174 if (SvTYPE(old) == SVTYPEMASK) {
7175 if (ckWARN_d(WARN_INTERNAL))
7176 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7180 /* SV_GMAGIC is the default for sv_setv()
7181 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7182 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7183 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7188 =for apidoc sv_reset
7190 Underlying implementation for the C<reset> Perl function.
7191 Note that the perl-level function is vaguely deprecated.
7197 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7200 char todo[PERL_UCHAR_MAX+1];
7205 if (!*s) { /* reset ?? searches */
7206 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7208 PMOP *pm = (PMOP *) mg->mg_obj;
7210 pm->op_pmdynflags &= ~PMdf_USED;
7217 /* reset variables */
7219 if (!HvARRAY(stash))
7222 Zero(todo, 256, char);
7225 I32 i = (unsigned char)*s;
7229 max = (unsigned char)*s++;
7230 for ( ; i <= max; i++) {
7233 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7235 for (entry = HvARRAY(stash)[i];
7237 entry = HeNEXT(entry))
7242 if (!todo[(U8)*HeKEY(entry)])
7244 gv = (GV*)HeVAL(entry);
7247 if (SvTHINKFIRST(sv)) {
7248 if (!SvREADONLY(sv) && SvROK(sv))
7250 /* XXX Is this continue a bug? Why should THINKFIRST
7251 exempt us from resetting arrays and hashes? */
7255 if (SvTYPE(sv) >= SVt_PV) {
7257 if (SvPVX_const(sv) != NULL)
7265 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7267 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7270 # if defined(USE_ENVIRON_ARRAY)
7273 # endif /* USE_ENVIRON_ARRAY */
7284 Using various gambits, try to get an IO from an SV: the IO slot if its a
7285 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7286 named after the PV if we're a string.
7292 Perl_sv_2io(pTHX_ SV *sv)
7297 switch (SvTYPE(sv)) {
7305 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7309 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7311 return sv_2io(SvRV(sv));
7312 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7318 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7327 Using various gambits, try to get a CV from an SV; in addition, try if
7328 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7329 The flags in C<lref> are passed to sv_fetchsv.
7335 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7346 switch (SvTYPE(sv)) {
7365 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7366 tryAMAGICunDEREF(to_cv);
7369 if (SvTYPE(sv) == SVt_PVCV) {
7378 Perl_croak(aTHX_ "Not a subroutine reference");
7383 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7389 /* Some flags to gv_fetchsv mean don't really create the GV */
7390 if (SvTYPE(gv) != SVt_PVGV) {
7396 if (lref && !GvCVu(gv)) {
7400 gv_efullname3(tmpsv, gv, NULL);
7401 /* XXX this is probably not what they think they're getting.
7402 * It has the same effect as "sub name;", i.e. just a forward
7404 newSUB(start_subparse(FALSE, 0),
7405 newSVOP(OP_CONST, 0, tmpsv),
7409 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7419 Returns true if the SV has a true value by Perl's rules.
7420 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7421 instead use an in-line version.
7427 Perl_sv_true(pTHX_ register SV *sv)
7432 register const XPV* const tXpv = (XPV*)SvANY(sv);
7434 (tXpv->xpv_cur > 1 ||
7435 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7442 return SvIVX(sv) != 0;
7445 return SvNVX(sv) != 0.0;
7447 return sv_2bool(sv);
7453 =for apidoc sv_pvn_force
7455 Get a sensible string out of the SV somehow.
7456 A private implementation of the C<SvPV_force> macro for compilers which
7457 can't cope with complex macro expressions. Always use the macro instead.
7459 =for apidoc sv_pvn_force_flags
7461 Get a sensible string out of the SV somehow.
7462 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7463 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7464 implemented in terms of this function.
7465 You normally want to use the various wrapper macros instead: see
7466 C<SvPV_force> and C<SvPV_force_nomg>
7472 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7475 if (SvTHINKFIRST(sv) && !SvROK(sv))
7476 sv_force_normal_flags(sv, 0);
7486 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7487 const char * const ref = sv_reftype(sv,0);
7489 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7490 ref, OP_NAME(PL_op));
7492 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7494 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7495 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7497 s = sv_2pv_flags(sv, &len, flags);
7501 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7504 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7505 SvGROW(sv, len + 1);
7506 Move(s,SvPVX(sv),len,char);
7511 SvPOK_on(sv); /* validate pointer */
7513 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7514 PTR2UV(sv),SvPVX_const(sv)));
7517 return SvPVX_mutable(sv);
7521 =for apidoc sv_pvbyten_force
7523 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7529 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7531 sv_pvn_force(sv,lp);
7532 sv_utf8_downgrade(sv,0);
7538 =for apidoc sv_pvutf8n_force
7540 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7546 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7548 sv_pvn_force(sv,lp);
7549 sv_utf8_upgrade(sv);
7555 =for apidoc sv_reftype
7557 Returns a string describing what the SV is a reference to.
7563 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7565 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7566 inside return suggests a const propagation bug in g++. */
7567 if (ob && SvOBJECT(sv)) {
7568 char * const name = HvNAME_get(SvSTASH(sv));
7569 return name ? name : (char *) "__ANON__";
7572 switch (SvTYPE(sv)) {
7589 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7590 /* tied lvalues should appear to be
7591 * scalars for backwards compatitbility */
7592 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7593 ? "SCALAR" : "LVALUE");
7594 case SVt_PVAV: return "ARRAY";
7595 case SVt_PVHV: return "HASH";
7596 case SVt_PVCV: return "CODE";
7597 case SVt_PVGV: return "GLOB";
7598 case SVt_PVFM: return "FORMAT";
7599 case SVt_PVIO: return "IO";
7600 default: return "UNKNOWN";
7606 =for apidoc sv_isobject
7608 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7609 object. If the SV is not an RV, or if the object is not blessed, then this
7616 Perl_sv_isobject(pTHX_ SV *sv)
7632 Returns a boolean indicating whether the SV is blessed into the specified
7633 class. This does not check for subtypes; use C<sv_derived_from> to verify
7634 an inheritance relationship.
7640 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7651 hvname = HvNAME_get(SvSTASH(sv));
7655 return strEQ(hvname, name);
7661 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7662 it will be upgraded to one. If C<classname> is non-null then the new SV will
7663 be blessed in the specified package. The new SV is returned and its
7664 reference count is 1.
7670 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7677 SV_CHECK_THINKFIRST_COW_DROP(rv);
7680 if (SvTYPE(rv) >= SVt_PVMG) {
7681 const U32 refcnt = SvREFCNT(rv);
7685 SvREFCNT(rv) = refcnt;
7688 if (SvTYPE(rv) < SVt_RV)
7689 sv_upgrade(rv, SVt_RV);
7690 else if (SvTYPE(rv) > SVt_RV) {
7701 HV* const stash = gv_stashpv(classname, TRUE);
7702 (void)sv_bless(rv, stash);
7708 =for apidoc sv_setref_pv
7710 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7711 argument will be upgraded to an RV. That RV will be modified to point to
7712 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7713 into the SV. The C<classname> argument indicates the package for the
7714 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7715 will have a reference count of 1, and the RV will be returned.
7717 Do not use with other Perl types such as HV, AV, SV, CV, because those
7718 objects will become corrupted by the pointer copy process.
7720 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7726 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7730 sv_setsv(rv, &PL_sv_undef);
7734 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7739 =for apidoc sv_setref_iv
7741 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7742 argument will be upgraded to an RV. That RV will be modified to point to
7743 the new SV. The C<classname> argument indicates the package for the
7744 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7745 will have a reference count of 1, and the RV will be returned.
7751 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7753 sv_setiv(newSVrv(rv,classname), iv);
7758 =for apidoc sv_setref_uv
7760 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7761 argument will be upgraded to an RV. That RV will be modified to point to
7762 the new SV. The C<classname> argument indicates the package for the
7763 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7764 will have a reference count of 1, and the RV will be returned.
7770 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7772 sv_setuv(newSVrv(rv,classname), uv);
7777 =for apidoc sv_setref_nv
7779 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7780 argument will be upgraded to an RV. That RV will be modified to point to
7781 the new SV. The C<classname> argument indicates the package for the
7782 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7783 will have a reference count of 1, and the RV will be returned.
7789 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7791 sv_setnv(newSVrv(rv,classname), nv);
7796 =for apidoc sv_setref_pvn
7798 Copies a string into a new SV, optionally blessing the SV. The length of the
7799 string must be specified with C<n>. The C<rv> argument will be upgraded to
7800 an RV. That RV will be modified to point to the new SV. The C<classname>
7801 argument indicates the package for the blessing. Set C<classname> to
7802 C<NULL> to avoid the blessing. The new SV will have a reference count
7803 of 1, and the RV will be returned.
7805 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7811 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7813 sv_setpvn(newSVrv(rv,classname), pv, n);
7818 =for apidoc sv_bless
7820 Blesses an SV into a specified package. The SV must be an RV. The package
7821 must be designated by its stash (see C<gv_stashpv()>). The reference count
7822 of the SV is unaffected.
7828 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7833 Perl_croak(aTHX_ "Can't bless non-reference value");
7835 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7836 if (SvREADONLY(tmpRef))
7837 Perl_croak(aTHX_ PL_no_modify);
7838 if (SvOBJECT(tmpRef)) {
7839 if (SvTYPE(tmpRef) != SVt_PVIO)
7841 SvREFCNT_dec(SvSTASH(tmpRef));
7844 SvOBJECT_on(tmpRef);
7845 if (SvTYPE(tmpRef) != SVt_PVIO)
7847 SvUPGRADE(tmpRef, SVt_PVMG);
7848 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7855 if(SvSMAGICAL(tmpRef))
7856 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7864 /* Downgrades a PVGV to a PVMG.
7868 S_sv_unglob(pTHX_ SV *sv)
7872 SV * const temp = sv_newmortal();
7874 assert(SvTYPE(sv) == SVt_PVGV);
7876 gv_efullname3(temp, (GV *) sv, "*");
7882 sv_del_backref((SV*)GvSTASH(sv), sv);
7886 if (GvNAME_HEK(sv)) {
7887 unshare_hek(GvNAME_HEK(sv));
7891 /* need to keep SvANY(sv) in the right arena */
7892 xpvmg = new_XPVMG();
7893 StructCopy(SvANY(sv), xpvmg, XPVMG);
7894 del_XPVGV(SvANY(sv));
7897 SvFLAGS(sv) &= ~SVTYPEMASK;
7898 SvFLAGS(sv) |= SVt_PVMG;
7900 /* Intentionally not calling any local SET magic, as this isn't so much a
7901 set operation as merely an internal storage change. */
7902 sv_setsv_flags(sv, temp, 0);
7906 =for apidoc sv_unref_flags
7908 Unsets the RV status of the SV, and decrements the reference count of
7909 whatever was being referenced by the RV. This can almost be thought of
7910 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7911 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7912 (otherwise the decrementing is conditional on the reference count being
7913 different from one or the reference being a readonly SV).
7920 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7922 SV* const target = SvRV(ref);
7924 if (SvWEAKREF(ref)) {
7925 sv_del_backref(target, ref);
7927 SvRV_set(ref, NULL);
7930 SvRV_set(ref, NULL);
7932 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7933 assigned to as BEGIN {$a = \"Foo"} will fail. */
7934 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7935 SvREFCNT_dec(target);
7936 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7937 sv_2mortal(target); /* Schedule for freeing later */
7941 =for apidoc sv_untaint
7943 Untaint an SV. Use C<SvTAINTED_off> instead.
7948 Perl_sv_untaint(pTHX_ SV *sv)
7950 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7951 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7958 =for apidoc sv_tainted
7960 Test an SV for taintedness. Use C<SvTAINTED> instead.
7965 Perl_sv_tainted(pTHX_ SV *sv)
7967 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7968 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7969 if (mg && (mg->mg_len & 1) )
7976 =for apidoc sv_setpviv
7978 Copies an integer into the given SV, also updating its string value.
7979 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7985 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7987 char buf[TYPE_CHARS(UV)];
7989 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7991 sv_setpvn(sv, ptr, ebuf - ptr);
7995 =for apidoc sv_setpviv_mg
7997 Like C<sv_setpviv>, but also handles 'set' magic.
8003 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8009 #if defined(PERL_IMPLICIT_CONTEXT)
8011 /* pTHX_ magic can't cope with varargs, so this is a no-context
8012 * version of the main function, (which may itself be aliased to us).
8013 * Don't access this version directly.
8017 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8021 va_start(args, pat);
8022 sv_vsetpvf(sv, pat, &args);
8026 /* pTHX_ magic can't cope with varargs, so this is a no-context
8027 * version of the main function, (which may itself be aliased to us).
8028 * Don't access this version directly.
8032 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8036 va_start(args, pat);
8037 sv_vsetpvf_mg(sv, pat, &args);
8043 =for apidoc sv_setpvf
8045 Works like C<sv_catpvf> but copies the text into the SV instead of
8046 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8052 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8055 va_start(args, pat);
8056 sv_vsetpvf(sv, pat, &args);
8061 =for apidoc sv_vsetpvf
8063 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8064 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8066 Usually used via its frontend C<sv_setpvf>.
8072 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8074 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8078 =for apidoc sv_setpvf_mg
8080 Like C<sv_setpvf>, but also handles 'set' magic.
8086 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8089 va_start(args, pat);
8090 sv_vsetpvf_mg(sv, pat, &args);
8095 =for apidoc sv_vsetpvf_mg
8097 Like C<sv_vsetpvf>, but also handles 'set' magic.
8099 Usually used via its frontend C<sv_setpvf_mg>.
8105 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8107 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8111 #if defined(PERL_IMPLICIT_CONTEXT)
8113 /* pTHX_ magic can't cope with varargs, so this is a no-context
8114 * version of the main function, (which may itself be aliased to us).
8115 * Don't access this version directly.
8119 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8123 va_start(args, pat);
8124 sv_vcatpvf(sv, pat, &args);
8128 /* pTHX_ magic can't cope with varargs, so this is a no-context
8129 * version of the main function, (which may itself be aliased to us).
8130 * Don't access this version directly.
8134 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8138 va_start(args, pat);
8139 sv_vcatpvf_mg(sv, pat, &args);
8145 =for apidoc sv_catpvf
8147 Processes its arguments like C<sprintf> and appends the formatted
8148 output to an SV. If the appended data contains "wide" characters
8149 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8150 and characters >255 formatted with %c), the original SV might get
8151 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8152 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8153 valid UTF-8; if the original SV was bytes, the pattern should be too.
8158 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8161 va_start(args, pat);
8162 sv_vcatpvf(sv, pat, &args);
8167 =for apidoc sv_vcatpvf
8169 Processes its arguments like C<vsprintf> and appends the formatted output
8170 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8172 Usually used via its frontend C<sv_catpvf>.
8178 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8180 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8184 =for apidoc sv_catpvf_mg
8186 Like C<sv_catpvf>, but also handles 'set' magic.
8192 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8195 va_start(args, pat);
8196 sv_vcatpvf_mg(sv, pat, &args);
8201 =for apidoc sv_vcatpvf_mg
8203 Like C<sv_vcatpvf>, but also handles 'set' magic.
8205 Usually used via its frontend C<sv_catpvf_mg>.
8211 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8213 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8218 =for apidoc sv_vsetpvfn
8220 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8223 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8229 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8231 sv_setpvn(sv, "", 0);
8232 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8236 S_expect_number(pTHX_ char** pattern)
8240 switch (**pattern) {
8241 case '1': case '2': case '3':
8242 case '4': case '5': case '6':
8243 case '7': case '8': case '9':
8244 var = *(*pattern)++ - '0';
8245 while (isDIGIT(**pattern)) {
8246 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8248 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8256 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8258 const int neg = nv < 0;
8267 if (uv & 1 && uv == nv)
8268 uv--; /* Round to even */
8270 const unsigned dig = uv % 10;
8283 =for apidoc sv_vcatpvfn
8285 Processes its arguments like C<vsprintf> and appends the formatted output
8286 to an SV. Uses an array of SVs if the C style variable argument list is
8287 missing (NULL). When running with taint checks enabled, indicates via
8288 C<maybe_tainted> if results are untrustworthy (often due to the use of
8291 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8297 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8298 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8299 vec_utf8 = DO_UTF8(vecsv);
8301 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8304 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8312 static const char nullstr[] = "(null)";
8314 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8315 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8317 /* Times 4: a decimal digit takes more than 3 binary digits.
8318 * NV_DIG: mantissa takes than many decimal digits.
8319 * Plus 32: Playing safe. */
8320 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8321 /* large enough for "%#.#f" --chip */
8322 /* what about long double NVs? --jhi */
8324 PERL_UNUSED_ARG(maybe_tainted);
8326 /* no matter what, this is a string now */
8327 (void)SvPV_force(sv, origlen);
8329 /* special-case "", "%s", and "%-p" (SVf - see below) */
8332 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8334 const char * const s = va_arg(*args, char*);
8335 sv_catpv(sv, s ? s : nullstr);
8337 else if (svix < svmax) {
8338 sv_catsv(sv, *svargs);
8342 if (args && patlen == 3 && pat[0] == '%' &&
8343 pat[1] == '-' && pat[2] == 'p') {
8344 argsv = va_arg(*args, SV*);
8345 sv_catsv(sv, argsv);
8349 #ifndef USE_LONG_DOUBLE
8350 /* special-case "%.<number>[gf]" */
8351 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8352 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8353 unsigned digits = 0;
8357 while (*pp >= '0' && *pp <= '9')
8358 digits = 10 * digits + (*pp++ - '0');
8359 if (pp - pat == (int)patlen - 1) {
8367 /* Add check for digits != 0 because it seems that some
8368 gconverts are buggy in this case, and we don't yet have
8369 a Configure test for this. */
8370 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8371 /* 0, point, slack */
8372 Gconvert(nv, (int)digits, 0, ebuf);
8374 if (*ebuf) /* May return an empty string for digits==0 */
8377 } else if (!digits) {
8380 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8381 sv_catpvn(sv, p, l);
8387 #endif /* !USE_LONG_DOUBLE */
8389 if (!args && svix < svmax && DO_UTF8(*svargs))
8392 patend = (char*)pat + patlen;
8393 for (p = (char*)pat; p < patend; p = q) {
8396 bool vectorize = FALSE;
8397 bool vectorarg = FALSE;
8398 bool vec_utf8 = FALSE;
8404 bool has_precis = FALSE;
8406 const I32 osvix = svix;
8407 bool is_utf8 = FALSE; /* is this item utf8? */
8408 #ifdef HAS_LDBL_SPRINTF_BUG
8409 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8410 with sfio - Allen <allens@cpan.org> */
8411 bool fix_ldbl_sprintf_bug = FALSE;
8415 U8 utf8buf[UTF8_MAXBYTES+1];
8416 STRLEN esignlen = 0;
8418 const char *eptr = NULL;
8421 const U8 *vecstr = NULL;
8428 /* we need a long double target in case HAS_LONG_DOUBLE but
8431 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8439 const char *dotstr = ".";
8440 STRLEN dotstrlen = 1;
8441 I32 efix = 0; /* explicit format parameter index */
8442 I32 ewix = 0; /* explicit width index */
8443 I32 epix = 0; /* explicit precision index */
8444 I32 evix = 0; /* explicit vector index */
8445 bool asterisk = FALSE;
8447 /* echo everything up to the next format specification */
8448 for (q = p; q < patend && *q != '%'; ++q) ;
8450 if (has_utf8 && !pat_utf8)
8451 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8453 sv_catpvn(sv, p, q - p);
8460 We allow format specification elements in this order:
8461 \d+\$ explicit format parameter index
8463 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8464 0 flag (as above): repeated to allow "v02"
8465 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8466 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8468 [%bcdefginopsuxDFOUX] format (mandatory)
8473 As of perl5.9.3, printf format checking is on by default.
8474 Internally, perl uses %p formats to provide an escape to
8475 some extended formatting. This block deals with those
8476 extensions: if it does not match, (char*)q is reset and
8477 the normal format processing code is used.
8479 Currently defined extensions are:
8480 %p include pointer address (standard)
8481 %-p (SVf) include an SV (previously %_)
8482 %-<num>p include an SV with precision <num>
8483 %1p (VDf) include a v-string (as %vd)
8484 %<num>p reserved for future extensions
8486 Robin Barker 2005-07-14
8493 n = expect_number(&q);
8500 argsv = va_arg(*args, SV*);
8501 eptr = SvPVx_const(argsv, elen);
8507 else if (n == vdNUMBER) { /* VDf */
8514 if (ckWARN_d(WARN_INTERNAL))
8515 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8516 "internal %%<num>p might conflict with future printf extensions");
8522 if ( (width = expect_number(&q)) ) {
8563 if ( (ewix = expect_number(&q)) )
8572 if ((vectorarg = asterisk)) {
8585 width = expect_number(&q);
8591 vecsv = va_arg(*args, SV*);
8593 vecsv = (evix > 0 && evix <= svmax)
8594 ? svargs[evix-1] : &PL_sv_undef;
8596 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8598 dotstr = SvPV_const(vecsv, dotstrlen);
8599 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8600 bad with tied or overloaded values that return UTF8. */
8603 else if (has_utf8) {
8604 vecsv = sv_mortalcopy(vecsv);
8605 sv_utf8_upgrade(vecsv);
8606 dotstr = SvPV_const(vecsv, dotstrlen);
8613 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8614 vecsv = svargs[efix ? efix-1 : svix++];
8615 vecstr = (U8*)SvPV_const(vecsv,veclen);
8616 vec_utf8 = DO_UTF8(vecsv);
8618 /* if this is a version object, we need to convert
8619 * back into v-string notation and then let the
8620 * vectorize happen normally
8622 if (sv_derived_from(vecsv, "version")) {
8623 char *version = savesvpv(vecsv);
8624 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8625 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8626 "vector argument not supported with alpha versions");
8629 vecsv = sv_newmortal();
8630 /* scan_vstring is expected to be called during
8631 * tokenization, so we need to fake up the end
8632 * of the buffer for it
8634 PL_bufend = version + veclen;
8635 scan_vstring(version, vecsv);
8636 vecstr = (U8*)SvPV_const(vecsv, veclen);
8637 vec_utf8 = DO_UTF8(vecsv);
8649 i = va_arg(*args, int);
8651 i = (ewix ? ewix <= svmax : svix < svmax) ?
8652 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8654 width = (i < 0) ? -i : i;
8664 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8666 /* XXX: todo, support specified precision parameter */
8670 i = va_arg(*args, int);
8672 i = (ewix ? ewix <= svmax : svix < svmax)
8673 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8674 precis = (i < 0) ? 0 : i;
8679 precis = precis * 10 + (*q++ - '0');
8688 case 'I': /* Ix, I32x, and I64x */
8690 if (q[1] == '6' && q[2] == '4') {
8696 if (q[1] == '3' && q[2] == '2') {
8706 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8717 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8718 if (*(q + 1) == 'l') { /* lld, llf */
8744 if (!vectorize && !args) {
8746 const I32 i = efix-1;
8747 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8749 argsv = (svix >= 0 && svix < svmax)
8750 ? svargs[svix++] : &PL_sv_undef;
8761 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8763 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8765 eptr = (char*)utf8buf;
8766 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8780 eptr = va_arg(*args, char*);
8782 #ifdef MACOS_TRADITIONAL
8783 /* On MacOS, %#s format is used for Pascal strings */
8788 elen = strlen(eptr);
8790 eptr = (char *)nullstr;
8791 elen = sizeof nullstr - 1;
8795 eptr = SvPVx_const(argsv, elen);
8796 if (DO_UTF8(argsv)) {
8797 if (has_precis && precis < elen) {
8799 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8802 if (width) { /* fudge width (can't fudge elen) */
8803 width += elen - sv_len_utf8(argsv);
8810 if (has_precis && elen > precis)
8817 if (alt || vectorize)
8819 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8840 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8849 esignbuf[esignlen++] = plus;
8853 case 'h': iv = (short)va_arg(*args, int); break;
8854 case 'l': iv = va_arg(*args, long); break;
8855 case 'V': iv = va_arg(*args, IV); break;
8856 default: iv = va_arg(*args, int); break;
8858 case 'q': iv = va_arg(*args, Quad_t); break;
8863 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8865 case 'h': iv = (short)tiv; break;
8866 case 'l': iv = (long)tiv; break;
8868 default: iv = tiv; break;
8870 case 'q': iv = (Quad_t)tiv; break;
8874 if ( !vectorize ) /* we already set uv above */
8879 esignbuf[esignlen++] = plus;
8883 esignbuf[esignlen++] = '-';
8926 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8937 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8938 case 'l': uv = va_arg(*args, unsigned long); break;
8939 case 'V': uv = va_arg(*args, UV); break;
8940 default: uv = va_arg(*args, unsigned); break;
8942 case 'q': uv = va_arg(*args, Uquad_t); break;
8947 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8949 case 'h': uv = (unsigned short)tuv; break;
8950 case 'l': uv = (unsigned long)tuv; break;
8952 default: uv = tuv; break;
8954 case 'q': uv = (Uquad_t)tuv; break;
8961 char *ptr = ebuf + sizeof ebuf;
8967 p = (char*)((c == 'X')
8968 ? "0123456789ABCDEF" : "0123456789abcdef");
8974 esignbuf[esignlen++] = '0';
8975 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8983 if (alt && *ptr != '0')
8994 esignbuf[esignlen++] = '0';
8995 esignbuf[esignlen++] = 'b';
8998 default: /* it had better be ten or less */
9002 } while (uv /= base);
9005 elen = (ebuf + sizeof ebuf) - ptr;
9009 zeros = precis - elen;
9010 else if (precis == 0 && elen == 1 && *eptr == '0')
9016 /* FLOATING POINT */
9019 c = 'f'; /* maybe %F isn't supported here */
9027 /* This is evil, but floating point is even more evil */
9029 /* for SV-style calling, we can only get NV
9030 for C-style calling, we assume %f is double;
9031 for simplicity we allow any of %Lf, %llf, %qf for long double
9035 #if defined(USE_LONG_DOUBLE)
9039 /* [perl #20339] - we should accept and ignore %lf rather than die */
9043 #if defined(USE_LONG_DOUBLE)
9044 intsize = args ? 0 : 'q';
9048 #if defined(HAS_LONG_DOUBLE)
9057 /* now we need (long double) if intsize == 'q', else (double) */
9059 #if LONG_DOUBLESIZE > DOUBLESIZE
9061 va_arg(*args, long double) :
9062 va_arg(*args, double)
9064 va_arg(*args, double)
9069 if (c != 'e' && c != 'E') {
9071 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9072 will cast our (long double) to (double) */
9073 (void)Perl_frexp(nv, &i);
9074 if (i == PERL_INT_MIN)
9075 Perl_die(aTHX_ "panic: frexp");
9077 need = BIT_DIGITS(i);
9079 need += has_precis ? precis : 6; /* known default */
9084 #ifdef HAS_LDBL_SPRINTF_BUG
9085 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9086 with sfio - Allen <allens@cpan.org> */
9089 # define MY_DBL_MAX DBL_MAX
9090 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9091 # if DOUBLESIZE >= 8
9092 # define MY_DBL_MAX 1.7976931348623157E+308L
9094 # define MY_DBL_MAX 3.40282347E+38L
9098 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9099 # define MY_DBL_MAX_BUG 1L
9101 # define MY_DBL_MAX_BUG MY_DBL_MAX
9105 # define MY_DBL_MIN DBL_MIN
9106 # else /* XXX guessing! -Allen */
9107 # if DOUBLESIZE >= 8
9108 # define MY_DBL_MIN 2.2250738585072014E-308L
9110 # define MY_DBL_MIN 1.17549435E-38L
9114 if ((intsize == 'q') && (c == 'f') &&
9115 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9117 /* it's going to be short enough that
9118 * long double precision is not needed */
9120 if ((nv <= 0L) && (nv >= -0L))
9121 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9123 /* would use Perl_fp_class as a double-check but not
9124 * functional on IRIX - see perl.h comments */
9126 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9127 /* It's within the range that a double can represent */
9128 #if defined(DBL_MAX) && !defined(DBL_MIN)
9129 if ((nv >= ((long double)1/DBL_MAX)) ||
9130 (nv <= (-(long double)1/DBL_MAX)))
9132 fix_ldbl_sprintf_bug = TRUE;
9135 if (fix_ldbl_sprintf_bug == TRUE) {
9145 # undef MY_DBL_MAX_BUG
9148 #endif /* HAS_LDBL_SPRINTF_BUG */
9150 need += 20; /* fudge factor */
9151 if (PL_efloatsize < need) {
9152 Safefree(PL_efloatbuf);
9153 PL_efloatsize = need + 20; /* more fudge */
9154 Newx(PL_efloatbuf, PL_efloatsize, char);
9155 PL_efloatbuf[0] = '\0';
9158 if ( !(width || left || plus || alt) && fill != '0'
9159 && has_precis && intsize != 'q' ) { /* Shortcuts */
9160 /* See earlier comment about buggy Gconvert when digits,
9162 if ( c == 'g' && precis) {
9163 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9164 /* May return an empty string for digits==0 */
9165 if (*PL_efloatbuf) {
9166 elen = strlen(PL_efloatbuf);
9167 goto float_converted;
9169 } else if ( c == 'f' && !precis) {
9170 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9175 char *ptr = ebuf + sizeof ebuf;
9178 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9179 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9180 if (intsize == 'q') {
9181 /* Copy the one or more characters in a long double
9182 * format before the 'base' ([efgEFG]) character to
9183 * the format string. */
9184 static char const prifldbl[] = PERL_PRIfldbl;
9185 char const *p = prifldbl + sizeof(prifldbl) - 3;
9186 while (p >= prifldbl) { *--ptr = *p--; }
9191 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9196 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9208 /* No taint. Otherwise we are in the strange situation
9209 * where printf() taints but print($float) doesn't.
9211 #if defined(HAS_LONG_DOUBLE)
9212 elen = ((intsize == 'q')
9213 ? my_sprintf(PL_efloatbuf, ptr, nv)
9214 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9216 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9220 eptr = PL_efloatbuf;
9228 i = SvCUR(sv) - origlen;
9231 case 'h': *(va_arg(*args, short*)) = i; break;
9232 default: *(va_arg(*args, int*)) = i; break;
9233 case 'l': *(va_arg(*args, long*)) = i; break;
9234 case 'V': *(va_arg(*args, IV*)) = i; break;
9236 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9241 sv_setuv_mg(argsv, (UV)i);
9242 continue; /* not "break" */
9249 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9250 && ckWARN(WARN_PRINTF))
9252 SV * const msg = sv_newmortal();
9253 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9254 (PL_op->op_type == OP_PRTF) ? "" : "s");
9257 Perl_sv_catpvf(aTHX_ msg,
9258 "\"%%%c\"", c & 0xFF);
9260 Perl_sv_catpvf(aTHX_ msg,
9261 "\"%%\\%03"UVof"\"",
9264 sv_catpvs(msg, "end of string");
9265 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9268 /* output mangled stuff ... */
9274 /* ... right here, because formatting flags should not apply */
9275 SvGROW(sv, SvCUR(sv) + elen + 1);
9277 Copy(eptr, p, elen, char);
9280 SvCUR_set(sv, p - SvPVX_const(sv));
9282 continue; /* not "break" */
9285 /* calculate width before utf8_upgrade changes it */
9286 have = esignlen + zeros + elen;
9288 Perl_croak_nocontext(PL_memory_wrap);
9290 if (is_utf8 != has_utf8) {
9293 sv_utf8_upgrade(sv);
9296 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9297 sv_utf8_upgrade(nsv);
9298 eptr = SvPVX_const(nsv);
9301 SvGROW(sv, SvCUR(sv) + elen + 1);
9306 need = (have > width ? have : width);
9309 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9310 Perl_croak_nocontext(PL_memory_wrap);
9311 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9313 if (esignlen && fill == '0') {
9315 for (i = 0; i < (int)esignlen; i++)
9319 memset(p, fill, gap);
9322 if (esignlen && fill != '0') {
9324 for (i = 0; i < (int)esignlen; i++)
9329 for (i = zeros; i; i--)
9333 Copy(eptr, p, elen, char);
9337 memset(p, ' ', gap);
9342 Copy(dotstr, p, dotstrlen, char);
9346 vectorize = FALSE; /* done iterating over vecstr */
9353 SvCUR_set(sv, p - SvPVX_const(sv));
9361 /* =========================================================================
9363 =head1 Cloning an interpreter
9365 All the macros and functions in this section are for the private use of
9366 the main function, perl_clone().
9368 The foo_dup() functions make an exact copy of an existing foo thinngy.
9369 During the course of a cloning, a hash table is used to map old addresses
9370 to new addresses. The table is created and manipulated with the
9371 ptr_table_* functions.
9375 ============================================================================*/
9378 #if defined(USE_ITHREADS)
9380 #ifndef GpREFCNT_inc
9381 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9385 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9386 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9387 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9388 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9389 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9390 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9391 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9392 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9393 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9394 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9395 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9396 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9397 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9398 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9401 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9402 regcomp.c. AMS 20010712 */
9405 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9410 struct reg_substr_datum *s;
9413 return (REGEXP *)NULL;
9415 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9418 len = r->offsets[0];
9419 npar = r->nparens+1;
9421 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9422 Copy(r->program, ret->program, len+1, regnode);
9424 Newx(ret->startp, npar, I32);
9425 Copy(r->startp, ret->startp, npar, I32);
9426 Newx(ret->endp, npar, I32);
9427 Copy(r->startp, ret->startp, npar, I32);
9429 Newx(ret->substrs, 1, struct reg_substr_data);
9430 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9431 s->min_offset = r->substrs->data[i].min_offset;
9432 s->max_offset = r->substrs->data[i].max_offset;
9433 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9434 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9437 ret->regstclass = NULL;
9440 const int count = r->data->count;
9443 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9444 char, struct reg_data);
9445 Newx(d->what, count, U8);
9448 for (i = 0; i < count; i++) {
9449 d->what[i] = r->data->what[i];
9450 switch (d->what[i]) {
9451 /* legal options are one of: sfpont
9452 see also regcomp.h and pregfree() */
9454 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9457 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9460 /* This is cheating. */
9461 Newx(d->data[i], 1, struct regnode_charclass_class);
9462 StructCopy(r->data->data[i], d->data[i],
9463 struct regnode_charclass_class);
9464 ret->regstclass = (regnode*)d->data[i];
9467 /* Compiled op trees are readonly, and can thus be
9468 shared without duplication. */
9470 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9474 d->data[i] = r->data->data[i];
9477 d->data[i] = r->data->data[i];
9479 ((reg_trie_data*)d->data[i])->refcount++;
9483 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9492 Newx(ret->offsets, 2*len+1, U32);
9493 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9495 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9496 ret->refcnt = r->refcnt;
9497 ret->minlen = r->minlen;
9498 ret->prelen = r->prelen;
9499 ret->nparens = r->nparens;
9500 ret->lastparen = r->lastparen;
9501 ret->lastcloseparen = r->lastcloseparen;
9502 ret->reganch = r->reganch;
9504 ret->sublen = r->sublen;
9506 if (RX_MATCH_COPIED(ret))
9507 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9510 #ifdef PERL_OLD_COPY_ON_WRITE
9511 ret->saved_copy = NULL;
9514 ptr_table_store(PL_ptr_table, r, ret);
9518 /* duplicate a file handle */
9521 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9525 PERL_UNUSED_ARG(type);
9528 return (PerlIO*)NULL;
9530 /* look for it in the table first */
9531 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9535 /* create anew and remember what it is */
9536 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9537 ptr_table_store(PL_ptr_table, fp, ret);
9541 /* duplicate a directory handle */
9544 Perl_dirp_dup(pTHX_ DIR *dp)
9546 PERL_UNUSED_CONTEXT;
9553 /* duplicate a typeglob */
9556 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9562 /* look for it in the table first */
9563 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9567 /* create anew and remember what it is */
9569 ptr_table_store(PL_ptr_table, gp, ret);
9572 ret->gp_refcnt = 0; /* must be before any other dups! */
9573 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9574 ret->gp_io = io_dup_inc(gp->gp_io, param);
9575 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9576 ret->gp_av = av_dup_inc(gp->gp_av, param);
9577 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9578 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9579 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9580 ret->gp_cvgen = gp->gp_cvgen;
9581 ret->gp_line = gp->gp_line;
9582 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9586 /* duplicate a chain of magic */
9589 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9591 MAGIC *mgprev = (MAGIC*)NULL;
9594 return (MAGIC*)NULL;
9595 /* look for it in the table first */
9596 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9600 for (; mg; mg = mg->mg_moremagic) {
9602 Newxz(nmg, 1, MAGIC);
9604 mgprev->mg_moremagic = nmg;
9607 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9608 nmg->mg_private = mg->mg_private;
9609 nmg->mg_type = mg->mg_type;
9610 nmg->mg_flags = mg->mg_flags;
9611 if (mg->mg_type == PERL_MAGIC_qr) {
9612 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9614 else if(mg->mg_type == PERL_MAGIC_backref) {
9615 /* The backref AV has its reference count deliberately bumped by
9617 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9619 else if (mg->mg_type == PERL_MAGIC_symtab) {
9620 nmg->mg_obj = mg->mg_obj;
9623 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9624 ? sv_dup_inc(mg->mg_obj, param)
9625 : sv_dup(mg->mg_obj, param);
9627 nmg->mg_len = mg->mg_len;
9628 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9629 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9630 if (mg->mg_len > 0) {
9631 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9632 if (mg->mg_type == PERL_MAGIC_overload_table &&
9633 AMT_AMAGIC((AMT*)mg->mg_ptr))
9635 const AMT * const amtp = (AMT*)mg->mg_ptr;
9636 AMT * const namtp = (AMT*)nmg->mg_ptr;
9638 for (i = 1; i < NofAMmeth; i++) {
9639 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9643 else if (mg->mg_len == HEf_SVKEY)
9644 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9646 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9647 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9654 /* create a new pointer-mapping table */
9657 Perl_ptr_table_new(pTHX)
9660 PERL_UNUSED_CONTEXT;
9662 Newxz(tbl, 1, PTR_TBL_t);
9665 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9669 #define PTR_TABLE_HASH(ptr) \
9670 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9673 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9674 following define) and at call to new_body_inline made below in
9675 Perl_ptr_table_store()
9678 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9680 /* map an existing pointer using a table */
9682 STATIC PTR_TBL_ENT_t *
9683 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9684 PTR_TBL_ENT_t *tblent;
9685 const UV hash = PTR_TABLE_HASH(sv);
9687 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9688 for (; tblent; tblent = tblent->next) {
9689 if (tblent->oldval == sv)
9696 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9698 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9699 PERL_UNUSED_CONTEXT;
9700 return tblent ? tblent->newval : (void *) 0;
9703 /* add a new entry to a pointer-mapping table */
9706 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9708 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9709 PERL_UNUSED_CONTEXT;
9712 tblent->newval = newsv;
9714 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9716 new_body_inline(tblent, PTE_SVSLOT);
9718 tblent->oldval = oldsv;
9719 tblent->newval = newsv;
9720 tblent->next = tbl->tbl_ary[entry];
9721 tbl->tbl_ary[entry] = tblent;
9723 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9724 ptr_table_split(tbl);
9728 /* double the hash bucket size of an existing ptr table */
9731 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9733 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9734 const UV oldsize = tbl->tbl_max + 1;
9735 UV newsize = oldsize * 2;
9737 PERL_UNUSED_CONTEXT;
9739 Renew(ary, newsize, PTR_TBL_ENT_t*);
9740 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9741 tbl->tbl_max = --newsize;
9743 for (i=0; i < oldsize; i++, ary++) {
9744 PTR_TBL_ENT_t **curentp, **entp, *ent;
9747 curentp = ary + oldsize;
9748 for (entp = ary, ent = *ary; ent; ent = *entp) {
9749 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9751 ent->next = *curentp;
9761 /* remove all the entries from a ptr table */
9764 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9766 if (tbl && tbl->tbl_items) {
9767 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9768 UV riter = tbl->tbl_max;
9771 PTR_TBL_ENT_t *entry = array[riter];
9774 PTR_TBL_ENT_t * const oentry = entry;
9775 entry = entry->next;
9784 /* clear and free a ptr table */
9787 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9792 ptr_table_clear(tbl);
9793 Safefree(tbl->tbl_ary);
9799 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9802 SvRV_set(dstr, SvWEAKREF(sstr)
9803 ? sv_dup(SvRV(sstr), param)
9804 : sv_dup_inc(SvRV(sstr), param));
9807 else if (SvPVX_const(sstr)) {
9808 /* Has something there */
9810 /* Normal PV - clone whole allocated space */
9811 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9812 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9813 /* Not that normal - actually sstr is copy on write.
9814 But we are a true, independant SV, so: */
9815 SvREADONLY_off(dstr);
9820 /* Special case - not normally malloced for some reason */
9821 if (isGV_with_GP(sstr)) {
9822 /* Don't need to do anything here. */
9824 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9825 /* A "shared" PV - clone it as "shared" PV */
9827 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9831 /* Some other special case - random pointer */
9832 SvPV_set(dstr, SvPVX(sstr));
9838 if (SvTYPE(dstr) == SVt_RV)
9839 SvRV_set(dstr, NULL);
9841 SvPV_set(dstr, NULL);
9845 /* duplicate an SV of any type (including AV, HV etc) */
9848 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9853 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9855 /* look for it in the table first */
9856 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9860 if(param->flags & CLONEf_JOIN_IN) {
9861 /** We are joining here so we don't want do clone
9862 something that is bad **/
9863 if (SvTYPE(sstr) == SVt_PVHV) {
9864 const char * const hvname = HvNAME_get(sstr);
9866 /** don't clone stashes if they already exist **/
9867 return (SV*)gv_stashpv(hvname,0);
9871 /* create anew and remember what it is */
9874 #ifdef DEBUG_LEAKING_SCALARS
9875 dstr->sv_debug_optype = sstr->sv_debug_optype;
9876 dstr->sv_debug_line = sstr->sv_debug_line;
9877 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9878 dstr->sv_debug_cloned = 1;
9879 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9882 ptr_table_store(PL_ptr_table, sstr, dstr);
9885 SvFLAGS(dstr) = SvFLAGS(sstr);
9886 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9887 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9890 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9891 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9892 PL_watch_pvx, SvPVX_const(sstr));
9895 /* don't clone objects whose class has asked us not to */
9896 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9897 SvFLAGS(dstr) &= ~SVTYPEMASK;
9902 switch (SvTYPE(sstr)) {
9907 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9908 SvIV_set(dstr, SvIVX(sstr));
9911 SvANY(dstr) = new_XNV();
9912 SvNV_set(dstr, SvNVX(sstr));
9915 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9916 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9920 /* These are all the types that need complex bodies allocating. */
9922 const svtype sv_type = SvTYPE(sstr);
9923 const struct body_details *const sv_type_details
9924 = bodies_by_type + sv_type;
9928 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9932 if (GvUNIQUE((GV*)sstr)) {
9933 /*EMPTY*/; /* Do sharing here, and fall through */
9946 assert(sv_type_details->body_size);
9947 if (sv_type_details->arena) {
9948 new_body_inline(new_body, sv_type);
9950 = (void*)((char*)new_body - sv_type_details->offset);
9952 new_body = new_NOARENA(sv_type_details);
9956 SvANY(dstr) = new_body;
9959 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9960 ((char*)SvANY(dstr)) + sv_type_details->offset,
9961 sv_type_details->copy, char);
9963 Copy(((char*)SvANY(sstr)),
9964 ((char*)SvANY(dstr)),
9965 sv_type_details->body_size + sv_type_details->offset, char);
9968 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9969 && !isGV_with_GP(dstr))
9970 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9972 /* The Copy above means that all the source (unduplicated) pointers
9973 are now in the destination. We can check the flags and the
9974 pointers in either, but it's possible that there's less cache
9975 missing by always going for the destination.
9976 FIXME - instrument and check that assumption */
9977 if (sv_type >= SVt_PVMG) {
9979 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9980 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9981 } else if (SvMAGIC(dstr))
9982 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9984 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9987 /* The cast silences a GCC warning about unhandled types. */
9988 switch ((int)sv_type) {
10000 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10001 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10002 LvTARG(dstr) = dstr;
10003 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10004 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10006 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10009 if (GvNAME_HEK(dstr))
10010 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10012 /* Don't call sv_add_backref here as it's going to be created
10013 as part of the magic cloning of the symbol table. */
10014 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10015 if(isGV_with_GP(sstr)) {
10016 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10017 at the point of this comment. */
10018 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10019 (void)GpREFCNT_inc(GvGP(dstr));
10021 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10024 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10025 if (IoOFP(dstr) == IoIFP(sstr))
10026 IoOFP(dstr) = IoIFP(dstr);
10028 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10029 /* PL_rsfp_filters entries have fake IoDIRP() */
10030 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10031 /* I have no idea why fake dirp (rsfps)
10032 should be treated differently but otherwise
10033 we end up with leaks -- sky*/
10034 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10035 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10036 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10038 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10039 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10040 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10041 if (IoDIRP(dstr)) {
10042 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10045 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10048 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10049 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10050 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10053 if (AvARRAY((AV*)sstr)) {
10054 SV **dst_ary, **src_ary;
10055 SSize_t items = AvFILLp((AV*)sstr) + 1;
10057 src_ary = AvARRAY((AV*)sstr);
10058 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10059 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10060 SvPV_set(dstr, (char*)dst_ary);
10061 AvALLOC((AV*)dstr) = dst_ary;
10062 if (AvREAL((AV*)sstr)) {
10063 while (items-- > 0)
10064 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10067 while (items-- > 0)
10068 *dst_ary++ = sv_dup(*src_ary++, param);
10070 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10071 while (items-- > 0) {
10072 *dst_ary++ = &PL_sv_undef;
10076 SvPV_set(dstr, NULL);
10077 AvALLOC((AV*)dstr) = (SV**)NULL;
10082 HEK *hvname = NULL;
10084 if (HvARRAY((HV*)sstr)) {
10086 const bool sharekeys = !!HvSHAREKEYS(sstr);
10087 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10088 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10090 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10091 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10093 HvARRAY(dstr) = (HE**)darray;
10094 while (i <= sxhv->xhv_max) {
10095 const HE *source = HvARRAY(sstr)[i];
10096 HvARRAY(dstr)[i] = source
10097 ? he_dup(source, sharekeys, param) : 0;
10101 struct xpvhv_aux * const saux = HvAUX(sstr);
10102 struct xpvhv_aux * const daux = HvAUX(dstr);
10103 /* This flag isn't copied. */
10104 /* SvOOK_on(hv) attacks the IV flags. */
10105 SvFLAGS(dstr) |= SVf_OOK;
10107 hvname = saux->xhv_name;
10109 = hvname ? hek_dup(hvname, param) : hvname;
10111 daux->xhv_riter = saux->xhv_riter;
10112 daux->xhv_eiter = saux->xhv_eiter
10113 ? he_dup(saux->xhv_eiter,
10114 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10115 daux->xhv_backreferences = saux->xhv_backreferences
10116 ? (AV*) SvREFCNT_inc(
10118 xhv_backreferences,
10124 SvPV_set(dstr, NULL);
10126 /* Record stashes for possible cloning in Perl_clone(). */
10128 av_push(param->stashes, dstr);
10132 if (!(param->flags & CLONEf_COPY_STACKS)) {
10136 /* NOTE: not refcounted */
10137 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10139 if (!CvISXSUB(dstr))
10140 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10142 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10143 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10144 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10145 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10147 /* don't dup if copying back - CvGV isn't refcounted, so the
10148 * duped GV may never be freed. A bit of a hack! DAPM */
10149 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10150 NULL : gv_dup(CvGV(dstr), param) ;
10151 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10153 CvWEAKOUTSIDE(sstr)
10154 ? cv_dup( CvOUTSIDE(dstr), param)
10155 : cv_dup_inc(CvOUTSIDE(dstr), param);
10156 if (!CvISXSUB(dstr))
10157 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10163 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10169 /* duplicate a context */
10172 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10174 PERL_CONTEXT *ncxs;
10177 return (PERL_CONTEXT*)NULL;
10179 /* look for it in the table first */
10180 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10184 /* create anew and remember what it is */
10185 Newxz(ncxs, max + 1, PERL_CONTEXT);
10186 ptr_table_store(PL_ptr_table, cxs, ncxs);
10189 PERL_CONTEXT * const cx = &cxs[ix];
10190 PERL_CONTEXT * const ncx = &ncxs[ix];
10191 ncx->cx_type = cx->cx_type;
10192 if (CxTYPE(cx) == CXt_SUBST) {
10193 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10196 ncx->blk_oldsp = cx->blk_oldsp;
10197 ncx->blk_oldcop = cx->blk_oldcop;
10198 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10199 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10200 ncx->blk_oldpm = cx->blk_oldpm;
10201 ncx->blk_gimme = cx->blk_gimme;
10202 switch (CxTYPE(cx)) {
10204 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10205 ? cv_dup_inc(cx->blk_sub.cv, param)
10206 : cv_dup(cx->blk_sub.cv,param));
10207 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10208 ? av_dup_inc(cx->blk_sub.argarray, param)
10210 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10211 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10212 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10213 ncx->blk_sub.lval = cx->blk_sub.lval;
10214 ncx->blk_sub.retop = cx->blk_sub.retop;
10217 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10218 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10219 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10220 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10221 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10222 ncx->blk_eval.retop = cx->blk_eval.retop;
10225 ncx->blk_loop.label = cx->blk_loop.label;
10226 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10227 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10228 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10229 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10230 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10231 ? cx->blk_loop.iterdata
10232 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10233 ncx->blk_loop.oldcomppad
10234 = (PAD*)ptr_table_fetch(PL_ptr_table,
10235 cx->blk_loop.oldcomppad);
10236 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10237 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10238 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10239 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10240 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10243 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10244 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10245 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10246 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10247 ncx->blk_sub.retop = cx->blk_sub.retop;
10259 /* duplicate a stack info structure */
10262 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10267 return (PERL_SI*)NULL;
10269 /* look for it in the table first */
10270 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10274 /* create anew and remember what it is */
10275 Newxz(nsi, 1, PERL_SI);
10276 ptr_table_store(PL_ptr_table, si, nsi);
10278 nsi->si_stack = av_dup_inc(si->si_stack, param);
10279 nsi->si_cxix = si->si_cxix;
10280 nsi->si_cxmax = si->si_cxmax;
10281 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10282 nsi->si_type = si->si_type;
10283 nsi->si_prev = si_dup(si->si_prev, param);
10284 nsi->si_next = si_dup(si->si_next, param);
10285 nsi->si_markoff = si->si_markoff;
10290 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10291 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10292 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10293 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10294 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10295 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10296 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10297 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10298 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10299 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10300 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10301 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10302 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10303 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10306 #define pv_dup_inc(p) SAVEPV(p)
10307 #define pv_dup(p) SAVEPV(p)
10308 #define svp_dup_inc(p,pp) any_dup(p,pp)
10310 /* map any object to the new equivent - either something in the
10311 * ptr table, or something in the interpreter structure
10315 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10320 return (void*)NULL;
10322 /* look for it in the table first */
10323 ret = ptr_table_fetch(PL_ptr_table, v);
10327 /* see if it is part of the interpreter structure */
10328 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10329 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10337 /* duplicate the save stack */
10340 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10342 ANY * const ss = proto_perl->Tsavestack;
10343 const I32 max = proto_perl->Tsavestack_max;
10344 I32 ix = proto_perl->Tsavestack_ix;
10356 void (*dptr) (void*);
10357 void (*dxptr) (pTHX_ void*);
10359 Newxz(nss, max, ANY);
10362 I32 i = POPINT(ss,ix);
10363 TOPINT(nss,ix) = i;
10365 case SAVEt_ITEM: /* normal string */
10366 sv = (SV*)POPPTR(ss,ix);
10367 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10368 sv = (SV*)POPPTR(ss,ix);
10369 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10371 case SAVEt_SV: /* scalar reference */
10372 sv = (SV*)POPPTR(ss,ix);
10373 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10374 gv = (GV*)POPPTR(ss,ix);
10375 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10377 case SAVEt_GENERIC_PVREF: /* generic char* */
10378 c = (char*)POPPTR(ss,ix);
10379 TOPPTR(nss,ix) = pv_dup(c);
10380 ptr = POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10383 case SAVEt_SHARED_PVREF: /* char* in shared space */
10384 c = (char*)POPPTR(ss,ix);
10385 TOPPTR(nss,ix) = savesharedpv(c);
10386 ptr = POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10389 case SAVEt_GENERIC_SVREF: /* generic sv */
10390 case SAVEt_SVREF: /* scalar reference */
10391 sv = (SV*)POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10393 ptr = POPPTR(ss,ix);
10394 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10396 case SAVEt_AV: /* array reference */
10397 av = (AV*)POPPTR(ss,ix);
10398 TOPPTR(nss,ix) = av_dup_inc(av, param);
10399 gv = (GV*)POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = gv_dup(gv, param);
10402 case SAVEt_HV: /* hash reference */
10403 hv = (HV*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10405 gv = (GV*)POPPTR(ss,ix);
10406 TOPPTR(nss,ix) = gv_dup(gv, param);
10408 case SAVEt_INT: /* int reference */
10409 ptr = POPPTR(ss,ix);
10410 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10411 intval = (int)POPINT(ss,ix);
10412 TOPINT(nss,ix) = intval;
10414 case SAVEt_LONG: /* long reference */
10415 ptr = POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10417 longval = (long)POPLONG(ss,ix);
10418 TOPLONG(nss,ix) = longval;
10420 case SAVEt_I32: /* I32 reference */
10421 case SAVEt_I16: /* I16 reference */
10422 case SAVEt_I8: /* I8 reference */
10423 ptr = POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10426 TOPINT(nss,ix) = i;
10428 case SAVEt_IV: /* IV reference */
10429 ptr = POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10432 TOPIV(nss,ix) = iv;
10434 case SAVEt_SPTR: /* SV* reference */
10435 ptr = POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10437 sv = (SV*)POPPTR(ss,ix);
10438 TOPPTR(nss,ix) = sv_dup(sv, param);
10440 case SAVEt_VPTR: /* random* reference */
10441 ptr = POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10443 ptr = POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 case SAVEt_PPTR: /* char* reference */
10447 ptr = POPPTR(ss,ix);
10448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10449 c = (char*)POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = pv_dup(c);
10452 case SAVEt_HPTR: /* HV* reference */
10453 ptr = POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10455 hv = (HV*)POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = hv_dup(hv, param);
10458 case SAVEt_APTR: /* AV* reference */
10459 ptr = POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 av = (AV*)POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = av_dup(av, param);
10465 gv = (GV*)POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = gv_dup(gv, param);
10468 case SAVEt_GP: /* scalar reference */
10469 gp = (GP*)POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10471 (void)GpREFCNT_inc(gp);
10472 gv = (GV*)POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10474 c = (char*)POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = pv_dup(c);
10477 TOPIV(nss,ix) = iv;
10479 TOPIV(nss,ix) = iv;
10482 case SAVEt_MORTALIZESV:
10483 sv = (SV*)POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10487 ptr = POPPTR(ss,ix);
10488 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10489 /* these are assumed to be refcounted properly */
10491 switch (((OP*)ptr)->op_type) {
10493 case OP_LEAVESUBLV:
10497 case OP_LEAVEWRITE:
10498 TOPPTR(nss,ix) = ptr;
10503 TOPPTR(nss,ix) = NULL;
10508 TOPPTR(nss,ix) = NULL;
10511 c = (char*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = pv_dup_inc(c);
10514 case SAVEt_CLEARSV:
10515 longval = POPLONG(ss,ix);
10516 TOPLONG(nss,ix) = longval;
10519 hv = (HV*)POPPTR(ss,ix);
10520 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10521 c = (char*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = pv_dup_inc(c);
10524 TOPINT(nss,ix) = i;
10526 case SAVEt_DESTRUCTOR:
10527 ptr = POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10529 dptr = POPDPTR(ss,ix);
10530 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10531 any_dup(FPTR2DPTR(void *, dptr),
10534 case SAVEt_DESTRUCTOR_X:
10535 ptr = POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10537 dxptr = POPDXPTR(ss,ix);
10538 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10539 any_dup(FPTR2DPTR(void *, dxptr),
10542 case SAVEt_REGCONTEXT:
10545 TOPINT(nss,ix) = i;
10548 case SAVEt_STACK_POS: /* Position on Perl stack */
10550 TOPINT(nss,ix) = i;
10552 case SAVEt_AELEM: /* array element */
10553 sv = (SV*)POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10556 TOPINT(nss,ix) = i;
10557 av = (AV*)POPPTR(ss,ix);
10558 TOPPTR(nss,ix) = av_dup_inc(av, param);
10560 case SAVEt_HELEM: /* hash element */
10561 sv = (SV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10563 sv = (SV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10565 hv = (HV*)POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10569 ptr = POPPTR(ss,ix);
10570 TOPPTR(nss,ix) = ptr;
10574 TOPINT(nss,ix) = i;
10576 case SAVEt_COMPPAD:
10577 av = (AV*)POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = av_dup(av, param);
10581 longval = (long)POPLONG(ss,ix);
10582 TOPLONG(nss,ix) = longval;
10583 ptr = POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10585 sv = (SV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = sv_dup(sv, param);
10589 ptr = POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 longval = (long)POPBOOL(ss,ix);
10592 TOPBOOL(nss,ix) = (bool)longval;
10594 case SAVEt_SET_SVFLAGS:
10596 TOPINT(nss,ix) = i;
10598 TOPINT(nss,ix) = i;
10599 sv = (SV*)POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = sv_dup(sv, param);
10603 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10611 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10612 * flag to the result. This is done for each stash before cloning starts,
10613 * so we know which stashes want their objects cloned */
10616 do_mark_cloneable_stash(pTHX_ SV *sv)
10618 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10620 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10621 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10622 if (cloner && GvCV(cloner)) {
10629 XPUSHs(sv_2mortal(newSVhek(hvname)));
10631 call_sv((SV*)GvCV(cloner), G_SCALAR);
10638 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10646 =for apidoc perl_clone
10648 Create and return a new interpreter by cloning the current one.
10650 perl_clone takes these flags as parameters:
10652 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10653 without it we only clone the data and zero the stacks,
10654 with it we copy the stacks and the new perl interpreter is
10655 ready to run at the exact same point as the previous one.
10656 The pseudo-fork code uses COPY_STACKS while the
10657 threads->new doesn't.
10659 CLONEf_KEEP_PTR_TABLE
10660 perl_clone keeps a ptr_table with the pointer of the old
10661 variable as a key and the new variable as a value,
10662 this allows it to check if something has been cloned and not
10663 clone it again but rather just use the value and increase the
10664 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10665 the ptr_table using the function
10666 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10667 reason to keep it around is if you want to dup some of your own
10668 variable who are outside the graph perl scans, example of this
10669 code is in threads.xs create
10672 This is a win32 thing, it is ignored on unix, it tells perls
10673 win32host code (which is c++) to clone itself, this is needed on
10674 win32 if you want to run two threads at the same time,
10675 if you just want to do some stuff in a separate perl interpreter
10676 and then throw it away and return to the original one,
10677 you don't need to do anything.
10682 /* XXX the above needs expanding by someone who actually understands it ! */
10683 EXTERN_C PerlInterpreter *
10684 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10687 perl_clone(PerlInterpreter *proto_perl, UV flags)
10690 #ifdef PERL_IMPLICIT_SYS
10692 /* perlhost.h so we need to call into it
10693 to clone the host, CPerlHost should have a c interface, sky */
10695 if (flags & CLONEf_CLONE_HOST) {
10696 return perl_clone_host(proto_perl,flags);
10698 return perl_clone_using(proto_perl, flags,
10700 proto_perl->IMemShared,
10701 proto_perl->IMemParse,
10703 proto_perl->IStdIO,
10707 proto_perl->IProc);
10711 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10712 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10713 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10714 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10715 struct IPerlDir* ipD, struct IPerlSock* ipS,
10716 struct IPerlProc* ipP)
10718 /* XXX many of the string copies here can be optimized if they're
10719 * constants; they need to be allocated as common memory and just
10720 * their pointers copied. */
10723 CLONE_PARAMS clone_params;
10724 CLONE_PARAMS* const param = &clone_params;
10726 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10727 /* for each stash, determine whether its objects should be cloned */
10728 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10729 PERL_SET_THX(my_perl);
10732 Poison(my_perl, 1, PerlInterpreter);
10738 PL_savestack_ix = 0;
10739 PL_savestack_max = -1;
10740 PL_sig_pending = 0;
10741 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10742 # else /* !DEBUGGING */
10743 Zero(my_perl, 1, PerlInterpreter);
10744 # endif /* DEBUGGING */
10746 /* host pointers */
10748 PL_MemShared = ipMS;
10749 PL_MemParse = ipMP;
10756 #else /* !PERL_IMPLICIT_SYS */
10758 CLONE_PARAMS clone_params;
10759 CLONE_PARAMS* param = &clone_params;
10760 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10761 /* for each stash, determine whether its objects should be cloned */
10762 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10763 PERL_SET_THX(my_perl);
10766 Poison(my_perl, 1, PerlInterpreter);
10772 PL_savestack_ix = 0;
10773 PL_savestack_max = -1;
10774 PL_sig_pending = 0;
10775 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10776 # else /* !DEBUGGING */
10777 Zero(my_perl, 1, PerlInterpreter);
10778 # endif /* DEBUGGING */
10779 #endif /* PERL_IMPLICIT_SYS */
10780 param->flags = flags;
10781 param->proto_perl = proto_perl;
10783 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10785 PL_body_arenas = NULL;
10786 Zero(&PL_body_roots, 1, PL_body_roots);
10788 PL_nice_chunk = NULL;
10789 PL_nice_chunk_size = 0;
10791 PL_sv_objcount = 0;
10793 PL_sv_arenaroot = NULL;
10795 PL_debug = proto_perl->Idebug;
10797 PL_hash_seed = proto_perl->Ihash_seed;
10798 PL_rehash_seed = proto_perl->Irehash_seed;
10800 #ifdef USE_REENTRANT_API
10801 /* XXX: things like -Dm will segfault here in perlio, but doing
10802 * PERL_SET_CONTEXT(proto_perl);
10803 * breaks too many other things
10805 Perl_reentrant_init(aTHX);
10808 /* create SV map for pointer relocation */
10809 PL_ptr_table = ptr_table_new();
10811 /* initialize these special pointers as early as possible */
10812 SvANY(&PL_sv_undef) = NULL;
10813 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10814 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10815 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10817 SvANY(&PL_sv_no) = new_XPVNV();
10818 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10819 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10820 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10821 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10822 SvCUR_set(&PL_sv_no, 0);
10823 SvLEN_set(&PL_sv_no, 1);
10824 SvIV_set(&PL_sv_no, 0);
10825 SvNV_set(&PL_sv_no, 0);
10826 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10828 SvANY(&PL_sv_yes) = new_XPVNV();
10829 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10830 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10831 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10832 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10833 SvCUR_set(&PL_sv_yes, 1);
10834 SvLEN_set(&PL_sv_yes, 2);
10835 SvIV_set(&PL_sv_yes, 1);
10836 SvNV_set(&PL_sv_yes, 1);
10837 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10839 /* create (a non-shared!) shared string table */
10840 PL_strtab = newHV();
10841 HvSHAREKEYS_off(PL_strtab);
10842 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10843 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10845 PL_compiling = proto_perl->Icompiling;
10847 /* These two PVs will be free'd special way so must set them same way op.c does */
10848 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10849 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10851 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10852 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10854 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10855 if (!specialWARN(PL_compiling.cop_warnings))
10856 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10857 if (!specialCopIO(PL_compiling.cop_io))
10858 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10859 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10861 /* pseudo environmental stuff */
10862 PL_origargc = proto_perl->Iorigargc;
10863 PL_origargv = proto_perl->Iorigargv;
10865 param->stashes = newAV(); /* Setup array of objects to call clone on */
10867 /* Set tainting stuff before PerlIO_debug can possibly get called */
10868 PL_tainting = proto_perl->Itainting;
10869 PL_taint_warn = proto_perl->Itaint_warn;
10871 #ifdef PERLIO_LAYERS
10872 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10873 PerlIO_clone(aTHX_ proto_perl, param);
10876 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10877 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10878 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10879 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10880 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10881 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10884 PL_minus_c = proto_perl->Iminus_c;
10885 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10886 PL_localpatches = proto_perl->Ilocalpatches;
10887 PL_splitstr = proto_perl->Isplitstr;
10888 PL_preprocess = proto_perl->Ipreprocess;
10889 PL_minus_n = proto_perl->Iminus_n;
10890 PL_minus_p = proto_perl->Iminus_p;
10891 PL_minus_l = proto_perl->Iminus_l;
10892 PL_minus_a = proto_perl->Iminus_a;
10893 PL_minus_E = proto_perl->Iminus_E;
10894 PL_minus_F = proto_perl->Iminus_F;
10895 PL_doswitches = proto_perl->Idoswitches;
10896 PL_dowarn = proto_perl->Idowarn;
10897 PL_doextract = proto_perl->Idoextract;
10898 PL_sawampersand = proto_perl->Isawampersand;
10899 PL_unsafe = proto_perl->Iunsafe;
10900 PL_inplace = SAVEPV(proto_perl->Iinplace);
10901 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10902 PL_perldb = proto_perl->Iperldb;
10903 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10904 PL_exit_flags = proto_perl->Iexit_flags;
10906 /* magical thingies */
10907 /* XXX time(&PL_basetime) when asked for? */
10908 PL_basetime = proto_perl->Ibasetime;
10909 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10911 PL_maxsysfd = proto_perl->Imaxsysfd;
10912 PL_multiline = proto_perl->Imultiline;
10913 PL_statusvalue = proto_perl->Istatusvalue;
10915 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10917 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10919 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10921 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10922 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10923 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10925 /* Clone the regex array */
10926 PL_regex_padav = newAV();
10928 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10929 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10931 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10932 for(i = 1; i <= len; i++) {
10933 const SV * const regex = regexen[i];
10936 ? sv_dup_inc(regex, param)
10938 newSViv(PTR2IV(re_dup(
10939 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10941 av_push(PL_regex_padav, sv);
10944 PL_regex_pad = AvARRAY(PL_regex_padav);
10946 /* shortcuts to various I/O objects */
10947 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10948 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10949 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10950 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10951 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10952 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10954 /* shortcuts to regexp stuff */
10955 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10957 /* shortcuts to misc objects */
10958 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10960 /* shortcuts to debugging objects */
10961 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10962 PL_DBline = gv_dup(proto_perl->IDBline, param);
10963 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10964 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10965 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10966 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10967 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10968 PL_lineary = av_dup(proto_perl->Ilineary, param);
10969 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10971 /* symbol tables */
10972 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10973 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10974 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10975 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10976 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10978 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10979 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10980 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10981 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10982 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10983 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10985 PL_sub_generation = proto_perl->Isub_generation;
10987 /* funky return mechanisms */
10988 PL_forkprocess = proto_perl->Iforkprocess;
10990 /* subprocess state */
10991 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10993 /* internal state */
10994 PL_maxo = proto_perl->Imaxo;
10995 if (proto_perl->Iop_mask)
10996 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10999 /* PL_asserting = proto_perl->Iasserting; */
11001 /* current interpreter roots */
11002 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11003 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11004 PL_main_start = proto_perl->Imain_start;
11005 PL_eval_root = proto_perl->Ieval_root;
11006 PL_eval_start = proto_perl->Ieval_start;
11008 /* runtime control stuff */
11009 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11010 PL_copline = proto_perl->Icopline;
11012 PL_filemode = proto_perl->Ifilemode;
11013 PL_lastfd = proto_perl->Ilastfd;
11014 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11017 PL_gensym = proto_perl->Igensym;
11018 PL_preambled = proto_perl->Ipreambled;
11019 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11020 PL_laststatval = proto_perl->Ilaststatval;
11021 PL_laststype = proto_perl->Ilaststype;
11024 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11026 /* interpreter atexit processing */
11027 PL_exitlistlen = proto_perl->Iexitlistlen;
11028 if (PL_exitlistlen) {
11029 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11030 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11033 PL_exitlist = (PerlExitListEntry*)NULL;
11035 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11036 if (PL_my_cxt_size) {
11037 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11038 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11041 PL_my_cxt_list = (void**)NULL;
11042 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11043 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11044 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11046 PL_profiledata = NULL;
11047 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11048 /* PL_rsfp_filters entries have fake IoDIRP() */
11049 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11051 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11053 PAD_CLONE_VARS(proto_perl, param);
11055 #ifdef HAVE_INTERP_INTERN
11056 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11059 /* more statics moved here */
11060 PL_generation = proto_perl->Igeneration;
11061 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11063 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11064 PL_in_clean_all = proto_perl->Iin_clean_all;
11066 PL_uid = proto_perl->Iuid;
11067 PL_euid = proto_perl->Ieuid;
11068 PL_gid = proto_perl->Igid;
11069 PL_egid = proto_perl->Iegid;
11070 PL_nomemok = proto_perl->Inomemok;
11071 PL_an = proto_perl->Ian;
11072 PL_evalseq = proto_perl->Ievalseq;
11073 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11074 PL_origalen = proto_perl->Iorigalen;
11075 #ifdef PERL_USES_PL_PIDSTATUS
11076 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11078 PL_osname = SAVEPV(proto_perl->Iosname);
11079 PL_sighandlerp = proto_perl->Isighandlerp;
11081 PL_runops = proto_perl->Irunops;
11083 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11086 PL_cshlen = proto_perl->Icshlen;
11087 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11090 PL_lex_state = proto_perl->Ilex_state;
11091 PL_lex_defer = proto_perl->Ilex_defer;
11092 PL_lex_expect = proto_perl->Ilex_expect;
11093 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11094 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11095 PL_lex_starts = proto_perl->Ilex_starts;
11096 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11097 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11098 PL_lex_op = proto_perl->Ilex_op;
11099 PL_lex_inpat = proto_perl->Ilex_inpat;
11100 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11101 PL_lex_brackets = proto_perl->Ilex_brackets;
11102 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11103 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11104 PL_lex_casemods = proto_perl->Ilex_casemods;
11105 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11106 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11109 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11110 PL_lasttoke = proto_perl->Ilasttoke;
11111 PL_realtokenstart = proto_perl->Irealtokenstart;
11112 PL_faketokens = proto_perl->Ifaketokens;
11113 PL_thismad = proto_perl->Ithismad;
11114 PL_thistoken = proto_perl->Ithistoken;
11115 PL_thisopen = proto_perl->Ithisopen;
11116 PL_thisstuff = proto_perl->Ithisstuff;
11117 PL_thisclose = proto_perl->Ithisclose;
11118 PL_thiswhite = proto_perl->Ithiswhite;
11119 PL_nextwhite = proto_perl->Inextwhite;
11120 PL_skipwhite = proto_perl->Iskipwhite;
11121 PL_endwhite = proto_perl->Iendwhite;
11122 PL_curforce = proto_perl->Icurforce;
11124 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11125 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11126 PL_nexttoke = proto_perl->Inexttoke;
11129 /* XXX This is probably masking the deeper issue of why
11130 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11131 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11132 * (A little debugging with a watchpoint on it may help.)
11134 if (SvANY(proto_perl->Ilinestr)) {
11135 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11136 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11137 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11138 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11139 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11140 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11141 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11142 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11143 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11146 PL_linestr = newSV(79);
11147 sv_upgrade(PL_linestr,SVt_PVIV);
11148 sv_setpvn(PL_linestr,"",0);
11149 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11151 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11152 PL_pending_ident = proto_perl->Ipending_ident;
11153 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11155 PL_expect = proto_perl->Iexpect;
11157 PL_multi_start = proto_perl->Imulti_start;
11158 PL_multi_end = proto_perl->Imulti_end;
11159 PL_multi_open = proto_perl->Imulti_open;
11160 PL_multi_close = proto_perl->Imulti_close;
11162 PL_error_count = proto_perl->Ierror_count;
11163 PL_subline = proto_perl->Isubline;
11164 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11166 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11167 if (SvANY(proto_perl->Ilinestr)) {
11168 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11169 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11170 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11171 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11172 PL_last_lop_op = proto_perl->Ilast_lop_op;
11175 PL_last_uni = SvPVX(PL_linestr);
11176 PL_last_lop = SvPVX(PL_linestr);
11177 PL_last_lop_op = 0;
11179 PL_in_my = proto_perl->Iin_my;
11180 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11182 PL_cryptseen = proto_perl->Icryptseen;
11185 PL_hints = proto_perl->Ihints;
11187 PL_amagic_generation = proto_perl->Iamagic_generation;
11189 #ifdef USE_LOCALE_COLLATE
11190 PL_collation_ix = proto_perl->Icollation_ix;
11191 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11192 PL_collation_standard = proto_perl->Icollation_standard;
11193 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11194 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11195 #endif /* USE_LOCALE_COLLATE */
11197 #ifdef USE_LOCALE_NUMERIC
11198 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11199 PL_numeric_standard = proto_perl->Inumeric_standard;
11200 PL_numeric_local = proto_perl->Inumeric_local;
11201 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11202 #endif /* !USE_LOCALE_NUMERIC */
11204 /* utf8 character classes */
11205 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11206 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11207 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11208 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11209 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11210 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11211 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11212 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11213 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11214 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11215 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11216 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11217 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11218 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11219 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11220 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11221 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11222 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11223 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11224 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11226 /* Did the locale setup indicate UTF-8? */
11227 PL_utf8locale = proto_perl->Iutf8locale;
11228 /* Unicode features (see perlrun/-C) */
11229 PL_unicode = proto_perl->Iunicode;
11231 /* Pre-5.8 signals control */
11232 PL_signals = proto_perl->Isignals;
11234 /* times() ticks per second */
11235 PL_clocktick = proto_perl->Iclocktick;
11237 /* Recursion stopper for PerlIO_find_layer */
11238 PL_in_load_module = proto_perl->Iin_load_module;
11240 /* sort() routine */
11241 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11243 /* Not really needed/useful since the reenrant_retint is "volatile",
11244 * but do it for consistency's sake. */
11245 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11247 /* Hooks to shared SVs and locks. */
11248 PL_sharehook = proto_perl->Isharehook;
11249 PL_lockhook = proto_perl->Ilockhook;
11250 PL_unlockhook = proto_perl->Iunlockhook;
11251 PL_threadhook = proto_perl->Ithreadhook;
11253 PL_runops_std = proto_perl->Irunops_std;
11254 PL_runops_dbg = proto_perl->Irunops_dbg;
11256 #ifdef THREADS_HAVE_PIDS
11257 PL_ppid = proto_perl->Ippid;
11261 PL_last_swash_hv = NULL; /* reinits on demand */
11262 PL_last_swash_klen = 0;
11263 PL_last_swash_key[0]= '\0';
11264 PL_last_swash_tmps = (U8*)NULL;
11265 PL_last_swash_slen = 0;
11267 PL_glob_index = proto_perl->Iglob_index;
11268 PL_srand_called = proto_perl->Isrand_called;
11269 PL_uudmap['M'] = 0; /* reinits on demand */
11270 PL_bitcount = NULL; /* reinits on demand */
11272 if (proto_perl->Ipsig_pend) {
11273 Newxz(PL_psig_pend, SIG_SIZE, int);
11276 PL_psig_pend = (int*)NULL;
11279 if (proto_perl->Ipsig_ptr) {
11280 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11281 Newxz(PL_psig_name, SIG_SIZE, SV*);
11282 for (i = 1; i < SIG_SIZE; i++) {
11283 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11284 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11288 PL_psig_ptr = (SV**)NULL;
11289 PL_psig_name = (SV**)NULL;
11292 /* thrdvar.h stuff */
11294 if (flags & CLONEf_COPY_STACKS) {
11295 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11296 PL_tmps_ix = proto_perl->Ttmps_ix;
11297 PL_tmps_max = proto_perl->Ttmps_max;
11298 PL_tmps_floor = proto_perl->Ttmps_floor;
11299 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11301 while (i <= PL_tmps_ix) {
11302 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11306 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11307 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11308 Newxz(PL_markstack, i, I32);
11309 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11310 - proto_perl->Tmarkstack);
11311 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11312 - proto_perl->Tmarkstack);
11313 Copy(proto_perl->Tmarkstack, PL_markstack,
11314 PL_markstack_ptr - PL_markstack + 1, I32);
11316 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11317 * NOTE: unlike the others! */
11318 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11319 PL_scopestack_max = proto_perl->Tscopestack_max;
11320 Newxz(PL_scopestack, PL_scopestack_max, I32);
11321 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11323 /* NOTE: si_dup() looks at PL_markstack */
11324 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11326 /* PL_curstack = PL_curstackinfo->si_stack; */
11327 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11328 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11330 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11331 PL_stack_base = AvARRAY(PL_curstack);
11332 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11333 - proto_perl->Tstack_base);
11334 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11336 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11337 * NOTE: unlike the others! */
11338 PL_savestack_ix = proto_perl->Tsavestack_ix;
11339 PL_savestack_max = proto_perl->Tsavestack_max;
11340 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11341 PL_savestack = ss_dup(proto_perl, param);
11345 ENTER; /* perl_destruct() wants to LEAVE; */
11347 /* although we're not duplicating the tmps stack, we should still
11348 * add entries for any SVs on the tmps stack that got cloned by a
11349 * non-refcount means (eg a temp in @_); otherwise they will be
11352 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11353 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11354 proto_perl->Ttmps_stack[i]);
11355 if (nsv && !SvREFCNT(nsv)) {
11357 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11362 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11363 PL_top_env = &PL_start_env;
11365 PL_op = proto_perl->Top;
11368 PL_Xpv = (XPV*)NULL;
11369 PL_na = proto_perl->Tna;
11371 PL_statbuf = proto_perl->Tstatbuf;
11372 PL_statcache = proto_perl->Tstatcache;
11373 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11374 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11376 PL_timesbuf = proto_perl->Ttimesbuf;
11379 PL_tainted = proto_perl->Ttainted;
11380 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11381 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11382 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11383 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11384 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11385 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11386 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11387 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11388 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11390 PL_restartop = proto_perl->Trestartop;
11391 PL_in_eval = proto_perl->Tin_eval;
11392 PL_delaymagic = proto_perl->Tdelaymagic;
11393 PL_dirty = proto_perl->Tdirty;
11394 PL_localizing = proto_perl->Tlocalizing;
11396 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11397 PL_hv_fetch_ent_mh = NULL;
11398 PL_modcount = proto_perl->Tmodcount;
11399 PL_lastgotoprobe = NULL;
11400 PL_dumpindent = proto_perl->Tdumpindent;
11402 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11403 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11404 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11405 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11406 PL_efloatbuf = NULL; /* reinits on demand */
11407 PL_efloatsize = 0; /* reinits on demand */
11411 PL_screamfirst = NULL;
11412 PL_screamnext = NULL;
11413 PL_maxscream = -1; /* reinits on demand */
11414 PL_lastscream = NULL;
11416 PL_watchaddr = NULL;
11419 PL_regdummy = proto_perl->Tregdummy;
11420 PL_regprecomp = NULL;
11423 PL_colorset = 0; /* reinits PL_colors[] */
11424 /*PL_colors[6] = {0,0,0,0,0,0};*/
11425 PL_reginput = NULL;
11428 PL_regstartp = (I32*)NULL;
11429 PL_regendp = (I32*)NULL;
11430 PL_reglastparen = (U32*)NULL;
11431 PL_reglastcloseparen = (U32*)NULL;
11433 PL_reg_start_tmp = (char**)NULL;
11434 PL_reg_start_tmpl = 0;
11435 PL_regdata = (struct reg_data*)NULL;
11438 PL_reg_eval_set = 0;
11440 PL_regprogram = (regnode*)NULL;
11442 PL_regcc = (CURCUR*)NULL;
11443 PL_reg_call_cc = (struct re_cc_state*)NULL;
11444 PL_reg_re = (regexp*)NULL;
11445 PL_reg_ganch = NULL;
11447 PL_reg_match_utf8 = FALSE;
11448 PL_reg_magic = (MAGIC*)NULL;
11450 PL_reg_oldcurpm = (PMOP*)NULL;
11451 PL_reg_curpm = (PMOP*)NULL;
11452 PL_reg_oldsaved = NULL;
11453 PL_reg_oldsavedlen = 0;
11454 #ifdef PERL_OLD_COPY_ON_WRITE
11457 PL_reg_maxiter = 0;
11458 PL_reg_leftiter = 0;
11459 PL_reg_poscache = NULL;
11460 PL_reg_poscache_size= 0;
11462 /* RE engine - function pointers */
11463 PL_regcompp = proto_perl->Tregcompp;
11464 PL_regexecp = proto_perl->Tregexecp;
11465 PL_regint_start = proto_perl->Tregint_start;
11466 PL_regint_string = proto_perl->Tregint_string;
11467 PL_regfree = proto_perl->Tregfree;
11469 PL_reginterp_cnt = 0;
11470 PL_reg_starttry = 0;
11472 /* Pluggable optimizer */
11473 PL_peepp = proto_perl->Tpeepp;
11475 PL_stashcache = newHV();
11477 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11478 ptr_table_free(PL_ptr_table);
11479 PL_ptr_table = NULL;
11482 /* Call the ->CLONE method, if it exists, for each of the stashes
11483 identified by sv_dup() above.
11485 while(av_len(param->stashes) != -1) {
11486 HV* const stash = (HV*) av_shift(param->stashes);
11487 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11488 if (cloner && GvCV(cloner)) {
11493 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11495 call_sv((SV*)GvCV(cloner), G_DISCARD);
11501 SvREFCNT_dec(param->stashes);
11503 /* orphaned? eg threads->new inside BEGIN or use */
11504 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11505 SvREFCNT_inc_simple_void(PL_compcv);
11506 SAVEFREESV(PL_compcv);
11512 #endif /* USE_ITHREADS */
11515 =head1 Unicode Support
11517 =for apidoc sv_recode_to_utf8
11519 The encoding is assumed to be an Encode object, on entry the PV
11520 of the sv is assumed to be octets in that encoding, and the sv
11521 will be converted into Unicode (and UTF-8).
11523 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11524 is not a reference, nothing is done to the sv. If the encoding is not
11525 an C<Encode::XS> Encoding object, bad things will happen.
11526 (See F<lib/encoding.pm> and L<Encode>).
11528 The PV of the sv is returned.
11533 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11536 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11550 Passing sv_yes is wrong - it needs to be or'ed set of constants
11551 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11552 remove converted chars from source.
11554 Both will default the value - let them.
11556 XPUSHs(&PL_sv_yes);
11559 call_method("decode", G_SCALAR);
11563 s = SvPV_const(uni, len);
11564 if (s != SvPVX_const(sv)) {
11565 SvGROW(sv, len + 1);
11566 Move(s, SvPVX(sv), len + 1, char);
11567 SvCUR_set(sv, len);
11574 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11578 =for apidoc sv_cat_decode
11580 The encoding is assumed to be an Encode object, the PV of the ssv is
11581 assumed to be octets in that encoding and decoding the input starts
11582 from the position which (PV + *offset) pointed to. The dsv will be
11583 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11584 when the string tstr appears in decoding output or the input ends on
11585 the PV of the ssv. The value which the offset points will be modified
11586 to the last input position on the ssv.
11588 Returns TRUE if the terminator was found, else returns FALSE.
11593 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11594 SV *ssv, int *offset, char *tstr, int tlen)
11598 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11609 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11610 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11612 call_method("cat_decode", G_SCALAR);
11614 ret = SvTRUE(TOPs);
11615 *offset = SvIV(offsv);
11621 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11626 /* ---------------------------------------------------------------------
11628 * support functions for report_uninit()
11631 /* the maxiumum size of array or hash where we will scan looking
11632 * for the undefined element that triggered the warning */
11634 #define FUV_MAX_SEARCH_SIZE 1000
11636 /* Look for an entry in the hash whose value has the same SV as val;
11637 * If so, return a mortal copy of the key. */
11640 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11643 register HE **array;
11646 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11647 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11650 array = HvARRAY(hv);
11652 for (i=HvMAX(hv); i>0; i--) {
11653 register HE *entry;
11654 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11655 if (HeVAL(entry) != val)
11657 if ( HeVAL(entry) == &PL_sv_undef ||
11658 HeVAL(entry) == &PL_sv_placeholder)
11662 if (HeKLEN(entry) == HEf_SVKEY)
11663 return sv_mortalcopy(HeKEY_sv(entry));
11664 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11670 /* Look for an entry in the array whose value has the same SV as val;
11671 * If so, return the index, otherwise return -1. */
11674 S_find_array_subscript(pTHX_ AV *av, SV* val)
11679 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11680 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11684 for (i=AvFILLp(av); i>=0; i--) {
11685 if (svp[i] == val && svp[i] != &PL_sv_undef)
11691 /* S_varname(): return the name of a variable, optionally with a subscript.
11692 * If gv is non-zero, use the name of that global, along with gvtype (one
11693 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11694 * targ. Depending on the value of the subscript_type flag, return:
11697 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11698 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11699 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11700 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11703 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11704 SV* keyname, I32 aindex, int subscript_type)
11707 SV * const name = sv_newmortal();
11710 buffer[0] = gvtype;
11713 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11715 gv_fullname4(name, gv, buffer, 0);
11717 if ((unsigned int)SvPVX(name)[1] <= 26) {
11719 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11721 /* Swap the 1 unprintable control character for the 2 byte pretty
11722 version - ie substr($name, 1, 1) = $buffer; */
11723 sv_insert(name, 1, 1, buffer, 2);
11728 CV * const cv = find_runcv(&unused);
11732 if (!cv || !CvPADLIST(cv))
11734 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11735 sv = *av_fetch(av, targ, FALSE);
11736 /* SvLEN in a pad name is not to be trusted */
11737 sv_setpv(name, SvPV_nolen_const(sv));
11740 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11741 SV * const sv = newSV(0);
11742 *SvPVX(name) = '$';
11743 Perl_sv_catpvf(aTHX_ name, "{%s}",
11744 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11747 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11748 *SvPVX(name) = '$';
11749 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11751 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11752 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11759 =for apidoc find_uninit_var
11761 Find the name of the undefined variable (if any) that caused the operator o
11762 to issue a "Use of uninitialized value" warning.
11763 If match is true, only return a name if it's value matches uninit_sv.
11764 So roughly speaking, if a unary operator (such as OP_COS) generates a
11765 warning, then following the direct child of the op may yield an
11766 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11767 other hand, with OP_ADD there are two branches to follow, so we only print
11768 the variable name if we get an exact match.
11770 The name is returned as a mortal SV.
11772 Assumes that PL_op is the op that originally triggered the error, and that
11773 PL_comppad/PL_curpad points to the currently executing pad.
11779 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11787 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11788 uninit_sv == &PL_sv_placeholder)))
11791 switch (obase->op_type) {
11798 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11799 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11802 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11804 if (pad) { /* @lex, %lex */
11805 sv = PAD_SVl(obase->op_targ);
11809 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11810 /* @global, %global */
11811 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11814 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11816 else /* @{expr}, %{expr} */
11817 return find_uninit_var(cUNOPx(obase)->op_first,
11821 /* attempt to find a match within the aggregate */
11823 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11825 subscript_type = FUV_SUBSCRIPT_HASH;
11828 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11830 subscript_type = FUV_SUBSCRIPT_ARRAY;
11833 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11836 return varname(gv, hash ? '%' : '@', obase->op_targ,
11837 keysv, index, subscript_type);
11841 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11843 return varname(NULL, '$', obase->op_targ,
11844 NULL, 0, FUV_SUBSCRIPT_NONE);
11847 gv = cGVOPx_gv(obase);
11848 if (!gv || (match && GvSV(gv) != uninit_sv))
11850 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11853 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11856 av = (AV*)PAD_SV(obase->op_targ);
11857 if (!av || SvRMAGICAL(av))
11859 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11860 if (!svp || *svp != uninit_sv)
11863 return varname(NULL, '$', obase->op_targ,
11864 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11867 gv = cGVOPx_gv(obase);
11873 if (!av || SvRMAGICAL(av))
11875 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11876 if (!svp || *svp != uninit_sv)
11879 return varname(gv, '$', 0,
11880 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11885 o = cUNOPx(obase)->op_first;
11886 if (!o || o->op_type != OP_NULL ||
11887 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11889 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11893 if (PL_op == obase)
11894 /* $a[uninit_expr] or $h{uninit_expr} */
11895 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11898 o = cBINOPx(obase)->op_first;
11899 kid = cBINOPx(obase)->op_last;
11901 /* get the av or hv, and optionally the gv */
11903 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11904 sv = PAD_SV(o->op_targ);
11906 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11907 && cUNOPo->op_first->op_type == OP_GV)
11909 gv = cGVOPx_gv(cUNOPo->op_first);
11912 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11917 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11918 /* index is constant */
11922 if (obase->op_type == OP_HELEM) {
11923 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11924 if (!he || HeVAL(he) != uninit_sv)
11928 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11929 if (!svp || *svp != uninit_sv)
11933 if (obase->op_type == OP_HELEM)
11934 return varname(gv, '%', o->op_targ,
11935 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11937 return varname(gv, '@', o->op_targ, NULL,
11938 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11941 /* index is an expression;
11942 * attempt to find a match within the aggregate */
11943 if (obase->op_type == OP_HELEM) {
11944 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11946 return varname(gv, '%', o->op_targ,
11947 keysv, 0, FUV_SUBSCRIPT_HASH);
11950 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11952 return varname(gv, '@', o->op_targ,
11953 NULL, index, FUV_SUBSCRIPT_ARRAY);
11958 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11960 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11965 /* only examine RHS */
11966 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11969 o = cUNOPx(obase)->op_first;
11970 if (o->op_type == OP_PUSHMARK)
11973 if (!o->op_sibling) {
11974 /* one-arg version of open is highly magical */
11976 if (o->op_type == OP_GV) { /* open FOO; */
11978 if (match && GvSV(gv) != uninit_sv)
11980 return varname(gv, '$', 0,
11981 NULL, 0, FUV_SUBSCRIPT_NONE);
11983 /* other possibilities not handled are:
11984 * open $x; or open my $x; should return '${*$x}'
11985 * open expr; should return '$'.expr ideally
11991 /* ops where $_ may be an implicit arg */
11995 if ( !(obase->op_flags & OPf_STACKED)) {
11996 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11997 ? PAD_SVl(obase->op_targ)
12000 sv = sv_newmortal();
12001 sv_setpvn(sv, "$_", 2);
12009 /* skip filehandle as it can't produce 'undef' warning */
12010 o = cUNOPx(obase)->op_first;
12011 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12012 o = o->op_sibling->op_sibling;
12019 match = 1; /* XS or custom code could trigger random warnings */
12024 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12025 return sv_2mortal(newSVpvs("${$/}"));
12030 if (!(obase->op_flags & OPf_KIDS))
12032 o = cUNOPx(obase)->op_first;
12038 /* if all except one arg are constant, or have no side-effects,
12039 * or are optimized away, then it's unambiguous */
12041 for (kid=o; kid; kid = kid->op_sibling) {
12043 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12044 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12045 || (kid->op_type == OP_PUSHMARK)
12049 if (o2) { /* more than one found */
12056 return find_uninit_var(o2, uninit_sv, match);
12058 /* scan all args */
12060 sv = find_uninit_var(o, uninit_sv, 1);
12072 =for apidoc report_uninit
12074 Print appropriate "Use of uninitialized variable" warning
12080 Perl_report_uninit(pTHX_ SV* uninit_sv)
12084 SV* varname = NULL;
12086 varname = find_uninit_var(PL_op, uninit_sv,0);
12088 sv_insert(varname, 0, 0, " ", 1);
12090 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12091 varname ? SvPV_nolen_const(varname) : "",
12092 " in ", OP_DESC(PL_op));
12095 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12101 * c-indentation-style: bsd
12102 * c-basic-offset: 4
12103 * indent-tabs-mode: t
12106 * ex: set ts=8 sts=4 sw=4 noet: