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 (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1899 SvIV_set(sv, I_V(SvNVX(sv)));
1900 if (SvNVX(sv) == (NV) SvIVX(sv)
1901 #ifndef NV_PRESERVES_UV
1902 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1903 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1904 /* Don't flag it as "accurately an integer" if the number
1905 came from a (by definition imprecise) NV operation, and
1906 we're outside the range of NV integer precision */
1909 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1910 DEBUG_c(PerlIO_printf(Perl_debug_log,
1911 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1917 /* IV not precise. No need to convert from PV, as NV
1918 conversion would already have cached IV if it detected
1919 that PV->IV would be better than PV->NV->IV
1920 flags already correct - don't set public IOK. */
1921 DEBUG_c(PerlIO_printf(Perl_debug_log,
1922 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1927 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1928 but the cast (NV)IV_MIN rounds to a the value less (more
1929 negative) than IV_MIN which happens to be equal to SvNVX ??
1930 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1931 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1932 (NV)UVX == NVX are both true, but the values differ. :-(
1933 Hopefully for 2s complement IV_MIN is something like
1934 0x8000000000000000 which will be exact. NWC */
1937 SvUV_set(sv, U_V(SvNVX(sv)));
1939 (SvNVX(sv) == (NV) SvUVX(sv))
1940 #ifndef NV_PRESERVES_UV
1941 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1942 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1943 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1944 /* Don't flag it as "accurately an integer" if the number
1945 came from a (by definition imprecise) NV operation, and
1946 we're outside the range of NV integer precision */
1951 DEBUG_c(PerlIO_printf(Perl_debug_log,
1952 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1958 else if (SvPOKp(sv) && SvLEN(sv)) {
1960 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1961 /* We want to avoid a possible problem when we cache an IV/ a UV which
1962 may be later translated to an NV, and the resulting NV is not
1963 the same as the direct translation of the initial string
1964 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1965 be careful to ensure that the value with the .456 is around if the
1966 NV value is requested in the future).
1968 This means that if we cache such an IV/a UV, we need to cache the
1969 NV as well. Moreover, we trade speed for space, and do not
1970 cache the NV if we are sure it's not needed.
1973 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1974 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1975 == IS_NUMBER_IN_UV) {
1976 /* It's definitely an integer, only upgrade to PVIV */
1977 if (SvTYPE(sv) < SVt_PVIV)
1978 sv_upgrade(sv, SVt_PVIV);
1980 } else if (SvTYPE(sv) < SVt_PVNV)
1981 sv_upgrade(sv, SVt_PVNV);
1983 /* If NVs preserve UVs then we only use the UV value if we know that
1984 we aren't going to call atof() below. If NVs don't preserve UVs
1985 then the value returned may have more precision than atof() will
1986 return, even though value isn't perfectly accurate. */
1987 if ((numtype & (IS_NUMBER_IN_UV
1988 #ifdef NV_PRESERVES_UV
1991 )) == IS_NUMBER_IN_UV) {
1992 /* This won't turn off the public IOK flag if it was set above */
1993 (void)SvIOKp_on(sv);
1995 if (!(numtype & IS_NUMBER_NEG)) {
1997 if (value <= (UV)IV_MAX) {
1998 SvIV_set(sv, (IV)value);
2000 /* it didn't overflow, and it was positive. */
2001 SvUV_set(sv, value);
2005 /* 2s complement assumption */
2006 if (value <= (UV)IV_MIN) {
2007 SvIV_set(sv, -(IV)value);
2009 /* Too negative for an IV. This is a double upgrade, but
2010 I'm assuming it will be rare. */
2011 if (SvTYPE(sv) < SVt_PVNV)
2012 sv_upgrade(sv, SVt_PVNV);
2016 SvNV_set(sv, -(NV)value);
2017 SvIV_set(sv, IV_MIN);
2021 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2022 will be in the previous block to set the IV slot, and the next
2023 block to set the NV slot. So no else here. */
2025 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2026 != IS_NUMBER_IN_UV) {
2027 /* It wasn't an (integer that doesn't overflow the UV). */
2028 SvNV_set(sv, Atof(SvPVX_const(sv)));
2030 if (! numtype && ckWARN(WARN_NUMERIC))
2033 #if defined(USE_LONG_DOUBLE)
2034 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2035 PTR2UV(sv), SvNVX(sv)));
2037 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2038 PTR2UV(sv), SvNVX(sv)));
2041 #ifdef NV_PRESERVES_UV
2042 (void)SvIOKp_on(sv);
2044 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2045 SvIV_set(sv, I_V(SvNVX(sv)));
2046 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2049 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2051 /* UV will not work better than IV */
2053 if (SvNVX(sv) > (NV)UV_MAX) {
2055 /* Integer is inaccurate. NOK, IOKp, is UV */
2056 SvUV_set(sv, UV_MAX);
2058 SvUV_set(sv, U_V(SvNVX(sv)));
2059 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2060 NV preservse UV so can do correct comparison. */
2061 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2064 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2069 #else /* NV_PRESERVES_UV */
2070 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2072 /* The IV/UV slot will have been set from value returned by
2073 grok_number above. The NV slot has just been set using
2076 assert (SvIOKp(sv));
2078 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2079 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2080 /* Small enough to preserve all bits. */
2081 (void)SvIOKp_on(sv);
2083 SvIV_set(sv, I_V(SvNVX(sv)));
2084 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2086 /* Assumption: first non-preserved integer is < IV_MAX,
2087 this NV is in the preserved range, therefore: */
2088 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2090 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);
2094 0 0 already failed to read UV.
2095 0 1 already failed to read UV.
2096 1 0 you won't get here in this case. IV/UV
2097 slot set, public IOK, Atof() unneeded.
2098 1 1 already read UV.
2099 so there's no point in sv_2iuv_non_preserve() attempting
2100 to use atol, strtol, strtoul etc. */
2101 sv_2iuv_non_preserve (sv, numtype);
2104 #endif /* NV_PRESERVES_UV */
2108 if (isGV_with_GP(sv)) {
2109 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2112 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2113 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2116 if (SvTYPE(sv) < SVt_IV)
2117 /* Typically the caller expects that sv_any is not NULL now. */
2118 sv_upgrade(sv, SVt_IV);
2119 /* Return 0 from the caller. */
2126 =for apidoc sv_2iv_flags
2128 Return the integer value of an SV, doing any necessary string
2129 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2130 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2136 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2141 if (SvGMAGICAL(sv)) {
2142 if (flags & SV_GMAGIC)
2147 return I_V(SvNVX(sv));
2149 if (SvPOKp(sv) && SvLEN(sv)) {
2152 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2154 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2155 == IS_NUMBER_IN_UV) {
2156 /* It's definitely an integer */
2157 if (numtype & IS_NUMBER_NEG) {
2158 if (value < (UV)IV_MIN)
2161 if (value < (UV)IV_MAX)
2166 if (ckWARN(WARN_NUMERIC))
2169 return I_V(Atof(SvPVX_const(sv)));
2174 assert(SvTYPE(sv) >= SVt_PVMG);
2175 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2176 } else if (SvTHINKFIRST(sv)) {
2180 SV * const tmpstr=AMG_CALLun(sv,numer);
2181 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2182 return SvIV(tmpstr);
2185 return PTR2IV(SvRV(sv));
2188 sv_force_normal_flags(sv, 0);
2190 if (SvREADONLY(sv) && !SvOK(sv)) {
2191 if (ckWARN(WARN_UNINITIALIZED))
2197 if (S_sv_2iuv_common(aTHX_ sv))
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2201 PTR2UV(sv),SvIVX(sv)));
2202 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2206 =for apidoc sv_2uv_flags
2208 Return the unsigned integer value of an SV, doing any necessary string
2209 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2210 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2216 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2221 if (SvGMAGICAL(sv)) {
2222 if (flags & SV_GMAGIC)
2227 return U_V(SvNVX(sv));
2228 if (SvPOKp(sv) && SvLEN(sv)) {
2231 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2233 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2234 == IS_NUMBER_IN_UV) {
2235 /* It's definitely an integer */
2236 if (!(numtype & IS_NUMBER_NEG))
2240 if (ckWARN(WARN_NUMERIC))
2243 return U_V(Atof(SvPVX_const(sv)));
2248 assert(SvTYPE(sv) >= SVt_PVMG);
2249 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2250 } else if (SvTHINKFIRST(sv)) {
2254 SV *const tmpstr = AMG_CALLun(sv,numer);
2255 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2256 return SvUV(tmpstr);
2259 return PTR2UV(SvRV(sv));
2262 sv_force_normal_flags(sv, 0);
2264 if (SvREADONLY(sv) && !SvOK(sv)) {
2265 if (ckWARN(WARN_UNINITIALIZED))
2271 if (S_sv_2iuv_common(aTHX_ sv))
2275 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2276 PTR2UV(sv),SvUVX(sv)));
2277 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2283 Return the num value of an SV, doing any necessary string or integer
2284 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2291 Perl_sv_2nv(pTHX_ register SV *sv)
2296 if (SvGMAGICAL(sv)) {
2300 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2301 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2302 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2304 return Atof(SvPVX_const(sv));
2308 return (NV)SvUVX(sv);
2310 return (NV)SvIVX(sv);
2315 assert(SvTYPE(sv) >= SVt_PVMG);
2316 /* This falls through to the report_uninit near the end of the
2318 } else if (SvTHINKFIRST(sv)) {
2322 SV *const tmpstr = AMG_CALLun(sv,numer);
2323 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2324 return SvNV(tmpstr);
2327 return PTR2NV(SvRV(sv));
2330 sv_force_normal_flags(sv, 0);
2332 if (SvREADONLY(sv) && !SvOK(sv)) {
2333 if (ckWARN(WARN_UNINITIALIZED))
2338 if (SvTYPE(sv) < SVt_NV) {
2339 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2340 sv_upgrade(sv, SVt_NV);
2341 #ifdef USE_LONG_DOUBLE
2343 STORE_NUMERIC_LOCAL_SET_STANDARD();
2344 PerlIO_printf(Perl_debug_log,
2345 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2346 PTR2UV(sv), SvNVX(sv));
2347 RESTORE_NUMERIC_LOCAL();
2351 STORE_NUMERIC_LOCAL_SET_STANDARD();
2352 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2353 PTR2UV(sv), SvNVX(sv));
2354 RESTORE_NUMERIC_LOCAL();
2358 else if (SvTYPE(sv) < SVt_PVNV)
2359 sv_upgrade(sv, SVt_PVNV);
2364 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2365 #ifdef NV_PRESERVES_UV
2368 /* Only set the public NV OK flag if this NV preserves the IV */
2369 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2370 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2371 : (SvIVX(sv) == I_V(SvNVX(sv))))
2377 else if (SvPOKp(sv) && SvLEN(sv)) {
2379 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2380 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2382 #ifdef NV_PRESERVES_UV
2383 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2384 == IS_NUMBER_IN_UV) {
2385 /* It's definitely an integer */
2386 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2388 SvNV_set(sv, Atof(SvPVX_const(sv)));
2391 SvNV_set(sv, Atof(SvPVX_const(sv)));
2392 /* Only set the public NV OK flag if this NV preserves the value in
2393 the PV at least as well as an IV/UV would.
2394 Not sure how to do this 100% reliably. */
2395 /* if that shift count is out of range then Configure's test is
2396 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2398 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2399 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2400 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2401 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2402 /* Can't use strtol etc to convert this string, so don't try.
2403 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2406 /* value has been set. It may not be precise. */
2407 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2408 /* 2s complement assumption for (UV)IV_MIN */
2409 SvNOK_on(sv); /* Integer is too negative. */
2414 if (numtype & IS_NUMBER_NEG) {
2415 SvIV_set(sv, -(IV)value);
2416 } else if (value <= (UV)IV_MAX) {
2417 SvIV_set(sv, (IV)value);
2419 SvUV_set(sv, value);
2423 if (numtype & IS_NUMBER_NOT_INT) {
2424 /* I believe that even if the original PV had decimals,
2425 they are lost beyond the limit of the FP precision.
2426 However, neither is canonical, so both only get p
2427 flags. NWC, 2000/11/25 */
2428 /* Both already have p flags, so do nothing */
2430 const NV nv = SvNVX(sv);
2431 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2432 if (SvIVX(sv) == I_V(nv)) {
2435 /* It had no "." so it must be integer. */
2439 /* between IV_MAX and NV(UV_MAX).
2440 Could be slightly > UV_MAX */
2442 if (numtype & IS_NUMBER_NOT_INT) {
2443 /* UV and NV both imprecise. */
2445 const UV nv_as_uv = U_V(nv);
2447 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2456 #endif /* NV_PRESERVES_UV */
2459 if (isGV_with_GP(sv)) {
2460 glob_2inpuv((GV *)sv, NULL, TRUE);
2464 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2466 assert (SvTYPE(sv) >= SVt_NV);
2467 /* Typically the caller expects that sv_any is not NULL now. */
2468 /* XXX Ilya implies that this is a bug in callers that assume this
2469 and ideally should be fixed. */
2472 #if defined(USE_LONG_DOUBLE)
2474 STORE_NUMERIC_LOCAL_SET_STANDARD();
2475 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2490 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2491 * UV as a string towards the end of buf, and return pointers to start and
2494 * We assume that buf is at least TYPE_CHARS(UV) long.
2498 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2500 char *ptr = buf + TYPE_CHARS(UV);
2501 char * const ebuf = ptr;
2514 *--ptr = '0' + (char)(uv % 10);
2522 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2523 * a regexp to its stringified form.
2527 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2529 const regexp * const re = (regexp *)mg->mg_obj;
2532 const char *fptr = "msix";
2537 bool need_newline = 0;
2538 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2540 while((ch = *fptr++)) {
2542 reflags[left++] = ch;
2545 reflags[right--] = ch;
2550 reflags[left] = '-';
2554 mg->mg_len = re->prelen + 4 + left;
2556 * If /x was used, we have to worry about a regex ending with a
2557 * comment later being embedded within another regex. If so, we don't
2558 * want this regex's "commentization" to leak out to the right part of
2559 * the enclosing regex, we must cap it with a newline.
2561 * So, if /x was used, we scan backwards from the end of the regex. If
2562 * we find a '#' before we find a newline, we need to add a newline
2563 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2564 * we don't need to add anything. -jfriedl
2566 if (PMf_EXTENDED & re->reganch) {
2567 const char *endptr = re->precomp + re->prelen;
2568 while (endptr >= re->precomp) {
2569 const char c = *(endptr--);
2571 break; /* don't need another */
2573 /* we end while in a comment, so we need a newline */
2574 mg->mg_len++; /* save space for it */
2575 need_newline = 1; /* note to add it */
2581 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2582 mg->mg_ptr[0] = '(';
2583 mg->mg_ptr[1] = '?';
2584 Copy(reflags, mg->mg_ptr+2, left, char);
2585 *(mg->mg_ptr+left+2) = ':';
2586 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2588 mg->mg_ptr[mg->mg_len - 2] = '\n';
2589 mg->mg_ptr[mg->mg_len - 1] = ')';
2590 mg->mg_ptr[mg->mg_len] = 0;
2592 PL_reginterp_cnt += re->program[0].next_off;
2594 if (re->reganch & ROPT_UTF8)
2604 =for apidoc sv_2pv_flags
2606 Returns a pointer to the string value of an SV, and sets *lp to its length.
2607 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2609 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2610 usually end up here too.
2616 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2626 if (SvGMAGICAL(sv)) {
2627 if (flags & SV_GMAGIC)
2632 if (flags & SV_MUTABLE_RETURN)
2633 return SvPVX_mutable(sv);
2634 if (flags & SV_CONST_RETURN)
2635 return (char *)SvPVX_const(sv);
2638 if (SvIOKp(sv) || SvNOKp(sv)) {
2639 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2643 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2644 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2646 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2653 #ifdef FIXNEGATIVEZERO
2654 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2660 SvUPGRADE(sv, SVt_PV);
2663 s = SvGROW_mutable(sv, len + 1);
2666 return memcpy(s, tbuf, len + 1);
2672 assert(SvTYPE(sv) >= SVt_PVMG);
2673 /* This falls through to the report_uninit near the end of the
2675 } else if (SvTHINKFIRST(sv)) {
2679 SV *const tmpstr = AMG_CALLun(sv,string);
2680 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2682 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2686 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2687 if (flags & SV_CONST_RETURN) {
2688 pv = (char *) SvPVX_const(tmpstr);
2690 pv = (flags & SV_MUTABLE_RETURN)
2691 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2694 *lp = SvCUR(tmpstr);
2696 pv = sv_2pv_flags(tmpstr, lp, flags);
2708 const SV *const referent = (SV*)SvRV(sv);
2711 tsv = sv_2mortal(newSVpvs("NULLREF"));
2712 } else if (SvTYPE(referent) == SVt_PVMG
2713 && ((SvFLAGS(referent) &
2714 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2715 == (SVs_OBJECT|SVs_SMG))
2716 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2717 return stringify_regexp(sv, mg, lp);
2719 const char *const typestr = sv_reftype(referent, 0);
2721 tsv = sv_newmortal();
2722 if (SvOBJECT(referent)) {
2723 const char *const name = HvNAME_get(SvSTASH(referent));
2724 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2725 name ? name : "__ANON__" , typestr,
2729 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2737 if (SvREADONLY(sv) && !SvOK(sv)) {
2738 if (ckWARN(WARN_UNINITIALIZED))
2745 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2746 /* I'm assuming that if both IV and NV are equally valid then
2747 converting the IV is going to be more efficient */
2748 const U32 isIOK = SvIOK(sv);
2749 const U32 isUIOK = SvIsUV(sv);
2750 char buf[TYPE_CHARS(UV)];
2753 if (SvTYPE(sv) < SVt_PVIV)
2754 sv_upgrade(sv, SVt_PVIV);
2755 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2756 /* inlined from sv_setpvn */
2757 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2758 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2759 SvCUR_set(sv, ebuf - ptr);
2769 else if (SvNOKp(sv)) {
2770 const int olderrno = errno;
2771 if (SvTYPE(sv) < SVt_PVNV)
2772 sv_upgrade(sv, SVt_PVNV);
2773 /* The +20 is pure guesswork. Configure test needed. --jhi */
2774 s = SvGROW_mutable(sv, NV_DIG + 20);
2775 /* some Xenix systems wipe out errno here */
2777 if (SvNVX(sv) == 0.0)
2778 (void)strcpy(s,"0");
2782 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2785 #ifdef FIXNEGATIVEZERO
2786 if (*s == '-' && s[1] == '0' && !s[2])
2796 if (isGV_with_GP(sv)) {
2797 return glob_2inpuv((GV *)sv, lp, FALSE);
2800 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2804 if (SvTYPE(sv) < SVt_PV)
2805 /* Typically the caller expects that sv_any is not NULL now. */
2806 sv_upgrade(sv, SVt_PV);
2810 const STRLEN len = s - SvPVX_const(sv);
2816 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2817 PTR2UV(sv),SvPVX_const(sv)));
2818 if (flags & SV_CONST_RETURN)
2819 return (char *)SvPVX_const(sv);
2820 if (flags & SV_MUTABLE_RETURN)
2821 return SvPVX_mutable(sv);
2826 =for apidoc sv_copypv
2828 Copies a stringified representation of the source SV into the
2829 destination SV. Automatically performs any necessary mg_get and
2830 coercion of numeric values into strings. Guaranteed to preserve
2831 UTF-8 flag even from overloaded objects. Similar in nature to
2832 sv_2pv[_flags] but operates directly on an SV instead of just the
2833 string. Mostly uses sv_2pv_flags to do its work, except when that
2834 would lose the UTF-8'ness of the PV.
2840 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2843 const char * const s = SvPV_const(ssv,len);
2844 sv_setpvn(dsv,s,len);
2852 =for apidoc sv_2pvbyte
2854 Return a pointer to the byte-encoded representation of the SV, and set *lp
2855 to its length. May cause the SV to be downgraded from UTF-8 as a
2858 Usually accessed via the C<SvPVbyte> macro.
2864 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2866 sv_utf8_downgrade(sv,0);
2867 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2871 =for apidoc sv_2pvutf8
2873 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2874 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2876 Usually accessed via the C<SvPVutf8> macro.
2882 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2884 sv_utf8_upgrade(sv);
2885 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2890 =for apidoc sv_2bool
2892 This function is only called on magical items, and is only used by
2893 sv_true() or its macro equivalent.
2899 Perl_sv_2bool(pTHX_ register SV *sv)
2908 SV * const tmpsv = AMG_CALLun(sv,bool_);
2909 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2910 return (bool)SvTRUE(tmpsv);
2912 return SvRV(sv) != 0;
2915 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2917 (*sv->sv_u.svu_pv > '0' ||
2918 Xpvtmp->xpv_cur > 1 ||
2919 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2926 return SvIVX(sv) != 0;
2929 return SvNVX(sv) != 0.0;
2931 if (isGV_with_GP(sv))
2941 =for apidoc sv_utf8_upgrade
2943 Converts the PV of an SV to its UTF-8-encoded form.
2944 Forces the SV to string form if it is not already.
2945 Always sets the SvUTF8 flag to avoid future validity checks even
2946 if all the bytes have hibit clear.
2948 This is not as a general purpose byte encoding to Unicode interface:
2949 use the Encode extension for that.
2951 =for apidoc sv_utf8_upgrade_flags
2953 Converts the PV of an SV to its UTF-8-encoded form.
2954 Forces the SV to string form if it is not already.
2955 Always sets the SvUTF8 flag to avoid future validity checks even
2956 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2957 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2958 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2960 This is not as a general purpose byte encoding to Unicode interface:
2961 use the Encode extension for that.
2967 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2970 if (sv == &PL_sv_undef)
2974 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2975 (void) sv_2pv_flags(sv,&len, flags);
2979 (void) SvPV_force(sv,len);
2988 sv_force_normal_flags(sv, 0);
2991 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2992 sv_recode_to_utf8(sv, PL_encoding);
2993 else { /* Assume Latin-1/EBCDIC */
2994 /* This function could be much more efficient if we
2995 * had a FLAG in SVs to signal if there are any hibit
2996 * chars in the PV. Given that there isn't such a flag
2997 * make the loop as fast as possible. */
2998 const U8 * const s = (U8 *) SvPVX_const(sv);
2999 const U8 * const e = (U8 *) SvEND(sv);
3004 /* Check for hi bit */
3005 if (!NATIVE_IS_INVARIANT(ch)) {
3006 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3007 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3009 SvPV_free(sv); /* No longer using what was there before. */
3010 SvPV_set(sv, (char*)recoded);
3011 SvCUR_set(sv, len - 1);
3012 SvLEN_set(sv, len); /* No longer know the real size. */
3016 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3023 =for apidoc sv_utf8_downgrade
3025 Attempts to convert the PV of an SV from characters to bytes.
3026 If the PV contains a character beyond byte, this conversion will fail;
3027 in this case, either returns false or, if C<fail_ok> is not
3030 This is not as a general purpose Unicode to byte encoding interface:
3031 use the Encode extension for that.
3037 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3040 if (SvPOKp(sv) && SvUTF8(sv)) {
3046 sv_force_normal_flags(sv, 0);
3048 s = (U8 *) SvPV(sv, len);
3049 if (!utf8_to_bytes(s, &len)) {
3054 Perl_croak(aTHX_ "Wide character in %s",
3057 Perl_croak(aTHX_ "Wide character");
3068 =for apidoc sv_utf8_encode
3070 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3071 flag off so that it looks like octets again.
3077 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3079 (void) sv_utf8_upgrade(sv);
3081 sv_force_normal_flags(sv, 0);
3083 if (SvREADONLY(sv)) {
3084 Perl_croak(aTHX_ PL_no_modify);
3090 =for apidoc sv_utf8_decode
3092 If the PV of the SV is an octet sequence in UTF-8
3093 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3094 so that it looks like a character. If the PV contains only single-byte
3095 characters, the C<SvUTF8> flag stays being off.
3096 Scans PV for validity and returns false if the PV is invalid UTF-8.
3102 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3108 /* The octets may have got themselves encoded - get them back as
3111 if (!sv_utf8_downgrade(sv, TRUE))
3114 /* it is actually just a matter of turning the utf8 flag on, but
3115 * we want to make sure everything inside is valid utf8 first.
3117 c = (const U8 *) SvPVX_const(sv);
3118 if (!is_utf8_string(c, SvCUR(sv)+1))
3120 e = (const U8 *) SvEND(sv);
3123 if (!UTF8_IS_INVARIANT(ch)) {
3133 =for apidoc sv_setsv
3135 Copies the contents of the source SV C<ssv> into the destination SV
3136 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3137 function if the source SV needs to be reused. Does not handle 'set' magic.
3138 Loosely speaking, it performs a copy-by-value, obliterating any previous
3139 content of the destination.
3141 You probably want to use one of the assortment of wrappers, such as
3142 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3143 C<SvSetMagicSV_nosteal>.
3145 =for apidoc sv_setsv_flags
3147 Copies the contents of the source SV C<ssv> into the destination SV
3148 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3149 function if the source SV needs to be reused. Does not handle 'set' magic.
3150 Loosely speaking, it performs a copy-by-value, obliterating any previous
3151 content of the destination.
3152 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3153 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3154 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3155 and C<sv_setsv_nomg> are implemented in terms of this function.
3157 You probably want to use one of the assortment of wrappers, such as
3158 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3159 C<SvSetMagicSV_nosteal>.
3161 This is the primary function for copying scalars, and most other
3162 copy-ish functions and macros use this underneath.
3168 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3170 if (dtype != SVt_PVGV) {
3171 const char * const name = GvNAME(sstr);
3172 const STRLEN len = GvNAMELEN(sstr);
3173 /* don't upgrade SVt_PVLV: it can hold a glob */
3174 if (dtype != SVt_PVLV) {
3175 if (dtype >= SVt_PV) {
3181 sv_upgrade(dstr, SVt_PVGV);
3182 (void)SvOK_off(dstr);
3185 GvSTASH(dstr) = GvSTASH(sstr);
3187 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3188 gv_name_set((GV *)dstr, name, len, GV_ADD);
3189 SvFAKE_on(dstr); /* can coerce to non-glob */
3192 #ifdef GV_UNIQUE_CHECK
3193 if (GvUNIQUE((GV*)dstr)) {
3194 Perl_croak(aTHX_ PL_no_modify);
3200 (void)SvOK_off(dstr);
3202 GvINTRO_off(dstr); /* one-shot flag */
3203 GvGP(dstr) = gp_ref(GvGP(sstr));
3204 if (SvTAINTED(sstr))
3206 if (GvIMPORTED(dstr) != GVf_IMPORTED
3207 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3209 GvIMPORTED_on(dstr);
3216 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3217 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3219 const int intro = GvINTRO(dstr);
3222 const U32 stype = SvTYPE(sref);
3225 #ifdef GV_UNIQUE_CHECK
3226 if (GvUNIQUE((GV*)dstr)) {
3227 Perl_croak(aTHX_ PL_no_modify);
3232 GvINTRO_off(dstr); /* one-shot flag */
3233 GvLINE(dstr) = CopLINE(PL_curcop);
3234 GvEGV(dstr) = (GV*)dstr;
3239 location = (SV **) &GvCV(dstr);
3240 import_flag = GVf_IMPORTED_CV;
3243 location = (SV **) &GvHV(dstr);
3244 import_flag = GVf_IMPORTED_HV;
3247 location = (SV **) &GvAV(dstr);
3248 import_flag = GVf_IMPORTED_AV;
3251 location = (SV **) &GvIOp(dstr);
3254 location = (SV **) &GvFORM(dstr);
3256 location = &GvSV(dstr);
3257 import_flag = GVf_IMPORTED_SV;
3260 if (stype == SVt_PVCV) {
3261 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3262 SvREFCNT_dec(GvCV(dstr));
3264 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3265 PL_sub_generation++;
3268 SAVEGENERICSV(*location);
3272 if (stype == SVt_PVCV && *location != sref) {
3273 CV* const cv = (CV*)*location;
3275 if (!GvCVGEN((GV*)dstr) &&
3276 (CvROOT(cv) || CvXSUB(cv)))
3278 /* Redefining a sub - warning is mandatory if
3279 it was a const and its value changed. */
3280 if (CvCONST(cv) && CvCONST((CV*)sref)
3281 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3283 /* They are 2 constant subroutines generated from
3284 the same constant. This probably means that
3285 they are really the "same" proxy subroutine
3286 instantiated in 2 places. Most likely this is
3287 when a constant is exported twice. Don't warn.
3290 else if (ckWARN(WARN_REDEFINE)
3292 && (!CvCONST((CV*)sref)
3293 || sv_cmp(cv_const_sv(cv),
3294 cv_const_sv((CV*)sref))))) {
3295 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3297 ? "Constant subroutine %s::%s redefined"
3298 : "Subroutine %s::%s redefined",
3299 HvNAME_get(GvSTASH((GV*)dstr)),
3300 GvENAME((GV*)dstr));
3304 cv_ckproto(cv, (GV*)dstr,
3305 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3307 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3308 GvASSUMECV_on(dstr);
3309 PL_sub_generation++;
3312 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3313 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3314 GvFLAGS(dstr) |= import_flag;
3319 if (SvTAINTED(sstr))
3325 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3328 register U32 sflags;
3334 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3336 sstr = &PL_sv_undef;
3337 stype = SvTYPE(sstr);
3338 dtype = SvTYPE(dstr);
3343 /* need to nuke the magic */
3345 SvRMAGICAL_off(dstr);
3348 /* There's a lot of redundancy below but we're going for speed here */
3353 if (dtype != SVt_PVGV) {
3354 (void)SvOK_off(dstr);
3362 sv_upgrade(dstr, SVt_IV);
3367 sv_upgrade(dstr, SVt_PVIV);
3370 (void)SvIOK_only(dstr);
3371 SvIV_set(dstr, SvIVX(sstr));
3374 /* SvTAINTED can only be true if the SV has taint magic, which in
3375 turn means that the SV type is PVMG (or greater). This is the
3376 case statement for SVt_IV, so this cannot be true (whatever gcov
3378 assert(!SvTAINTED(sstr));
3388 sv_upgrade(dstr, SVt_NV);
3393 sv_upgrade(dstr, SVt_PVNV);
3396 SvNV_set(dstr, SvNVX(sstr));
3397 (void)SvNOK_only(dstr);
3398 /* SvTAINTED can only be true if the SV has taint magic, which in
3399 turn means that the SV type is PVMG (or greater). This is the
3400 case statement for SVt_NV, so this cannot be true (whatever gcov
3402 assert(!SvTAINTED(sstr));
3409 sv_upgrade(dstr, SVt_RV);
3412 #ifdef PERL_OLD_COPY_ON_WRITE
3413 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3414 if (dtype < SVt_PVIV)
3415 sv_upgrade(dstr, SVt_PVIV);
3422 sv_upgrade(dstr, SVt_PV);
3425 if (dtype < SVt_PVIV)
3426 sv_upgrade(dstr, SVt_PVIV);
3429 if (dtype < SVt_PVNV)
3430 sv_upgrade(dstr, SVt_PVNV);
3434 const char * const type = sv_reftype(sstr,0);
3436 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3438 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3443 if (dtype <= SVt_PVGV) {
3444 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3452 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3454 if ((int)SvTYPE(sstr) != stype) {
3455 stype = SvTYPE(sstr);
3456 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3457 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3462 if (stype == SVt_PVLV)
3463 SvUPGRADE(dstr, SVt_PVNV);
3465 SvUPGRADE(dstr, (U32)stype);
3468 /* dstr may have been upgraded. */
3469 dtype = SvTYPE(dstr);
3470 sflags = SvFLAGS(sstr);
3472 if (sflags & SVf_ROK) {
3473 if (dtype == SVt_PVGV &&
3474 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3477 if (GvIMPORTED(dstr) != GVf_IMPORTED
3478 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3480 GvIMPORTED_on(dstr);
3485 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3489 if (dtype >= SVt_PV) {
3490 if (dtype == SVt_PVGV) {
3491 S_glob_assign_ref(aTHX_ dstr, sstr);
3494 if (SvPVX_const(dstr)) {
3500 (void)SvOK_off(dstr);
3501 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3502 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3503 assert(!(sflags & SVp_NOK));
3504 assert(!(sflags & SVp_IOK));
3505 assert(!(sflags & SVf_NOK));
3506 assert(!(sflags & SVf_IOK));
3508 else if (dtype == SVt_PVGV) {
3509 if (!(sflags & SVf_OK)) {
3510 if (ckWARN(WARN_MISC))
3511 Perl_warner(aTHX_ packWARN(WARN_MISC),
3512 "Undefined value assigned to typeglob");
3515 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3516 if (dstr != (SV*)gv) {
3519 GvGP(dstr) = gp_ref(GvGP(gv));
3523 else if (sflags & SVp_POK) {
3527 * Check to see if we can just swipe the string. If so, it's a
3528 * possible small lose on short strings, but a big win on long ones.
3529 * It might even be a win on short strings if SvPVX_const(dstr)
3530 * has to be allocated and SvPVX_const(sstr) has to be freed.
3533 /* Whichever path we take through the next code, we want this true,
3534 and doing it now facilitates the COW check. */
3535 (void)SvPOK_only(dstr);
3538 /* We're not already COW */
3539 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3540 #ifndef PERL_OLD_COPY_ON_WRITE
3541 /* or we are, but dstr isn't a suitable target. */
3542 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3547 (sflags & SVs_TEMP) && /* slated for free anyway? */
3548 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3549 (!(flags & SV_NOSTEAL)) &&
3550 /* and we're allowed to steal temps */
3551 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3552 SvLEN(sstr) && /* and really is a string */
3553 /* and won't be needed again, potentially */
3554 !(PL_op && PL_op->op_type == OP_AASSIGN))
3555 #ifdef PERL_OLD_COPY_ON_WRITE
3556 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3557 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3558 && SvTYPE(sstr) >= SVt_PVIV)
3561 /* Failed the swipe test, and it's not a shared hash key either.
3562 Have to copy the string. */
3563 STRLEN len = SvCUR(sstr);
3564 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3565 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3566 SvCUR_set(dstr, len);
3567 *SvEND(dstr) = '\0';
3569 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3571 /* Either it's a shared hash key, or it's suitable for
3572 copy-on-write or we can swipe the string. */
3574 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3578 #ifdef PERL_OLD_COPY_ON_WRITE
3580 /* I believe I should acquire a global SV mutex if
3581 it's a COW sv (not a shared hash key) to stop
3582 it going un copy-on-write.
3583 If the source SV has gone un copy on write between up there
3584 and down here, then (assert() that) it is of the correct
3585 form to make it copy on write again */
3586 if ((sflags & (SVf_FAKE | SVf_READONLY))
3587 != (SVf_FAKE | SVf_READONLY)) {
3588 SvREADONLY_on(sstr);
3590 /* Make the source SV into a loop of 1.
3591 (about to become 2) */
3592 SV_COW_NEXT_SV_SET(sstr, sstr);
3596 /* Initial code is common. */
3597 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3602 /* making another shared SV. */
3603 STRLEN cur = SvCUR(sstr);
3604 STRLEN len = SvLEN(sstr);
3605 #ifdef PERL_OLD_COPY_ON_WRITE
3607 assert (SvTYPE(dstr) >= SVt_PVIV);
3608 /* SvIsCOW_normal */
3609 /* splice us in between source and next-after-source. */
3610 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3611 SV_COW_NEXT_SV_SET(sstr, dstr);
3612 SvPV_set(dstr, SvPVX_mutable(sstr));
3616 /* SvIsCOW_shared_hash */
3617 DEBUG_C(PerlIO_printf(Perl_debug_log,
3618 "Copy on write: Sharing hash\n"));
3620 assert (SvTYPE(dstr) >= SVt_PV);
3622 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3624 SvLEN_set(dstr, len);
3625 SvCUR_set(dstr, cur);
3626 SvREADONLY_on(dstr);
3628 /* Relesase a global SV mutex. */
3631 { /* Passes the swipe test. */
3632 SvPV_set(dstr, SvPVX_mutable(sstr));
3633 SvLEN_set(dstr, SvLEN(sstr));
3634 SvCUR_set(dstr, SvCUR(sstr));
3637 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3638 SvPV_set(sstr, NULL);
3644 if (sflags & SVp_NOK) {
3645 SvNV_set(dstr, SvNVX(sstr));
3647 if (sflags & SVp_IOK) {
3648 SvRELEASE_IVX(dstr);
3649 SvIV_set(dstr, SvIVX(sstr));
3650 /* Must do this otherwise some other overloaded use of 0x80000000
3651 gets confused. I guess SVpbm_VALID */
3652 if (sflags & SVf_IVisUV)
3655 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3658 const MAGIC * const smg = SvVOK(sstr);
3660 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3661 smg->mg_ptr, smg->mg_len);
3662 SvRMAGICAL_on(dstr);
3666 else if (sflags & (SVp_IOK|SVp_NOK)) {
3667 (void)SvOK_off(dstr);
3668 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3670 if (sflags & SVp_IOK) {
3671 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3672 SvIV_set(dstr, SvIVX(sstr));
3674 if (sflags & SVp_NOK) {
3675 SvNV_set(dstr, SvNVX(sstr));
3679 if (isGV_with_GP(sstr)) {
3680 /* This stringification rule for globs is spread in 3 places.
3681 This feels bad. FIXME. */
3682 const U32 wasfake = sflags & SVf_FAKE;
3684 /* FAKE globs can get coerced, so need to turn this off
3685 temporarily if it is on. */
3687 gv_efullname3(dstr, (GV *)sstr, "*");
3688 SvFLAGS(sstr) |= wasfake;
3689 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3692 (void)SvOK_off(dstr);
3694 if (SvTAINTED(sstr))
3699 =for apidoc sv_setsv_mg
3701 Like C<sv_setsv>, but also handles 'set' magic.
3707 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3709 sv_setsv(dstr,sstr);
3713 #ifdef PERL_OLD_COPY_ON_WRITE
3715 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3717 STRLEN cur = SvCUR(sstr);
3718 STRLEN len = SvLEN(sstr);
3719 register char *new_pv;
3722 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3730 if (SvTHINKFIRST(dstr))
3731 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3732 else if (SvPVX_const(dstr))
3733 Safefree(SvPVX_const(dstr));
3737 SvUPGRADE(dstr, SVt_PVIV);
3739 assert (SvPOK(sstr));
3740 assert (SvPOKp(sstr));
3741 assert (!SvIOK(sstr));
3742 assert (!SvIOKp(sstr));
3743 assert (!SvNOK(sstr));
3744 assert (!SvNOKp(sstr));
3746 if (SvIsCOW(sstr)) {
3748 if (SvLEN(sstr) == 0) {
3749 /* source is a COW shared hash key. */
3750 DEBUG_C(PerlIO_printf(Perl_debug_log,
3751 "Fast copy on write: Sharing hash\n"));
3752 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3755 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3757 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3758 SvUPGRADE(sstr, SVt_PVIV);
3759 SvREADONLY_on(sstr);
3761 DEBUG_C(PerlIO_printf(Perl_debug_log,
3762 "Fast copy on write: Converting sstr to COW\n"));
3763 SV_COW_NEXT_SV_SET(dstr, sstr);
3765 SV_COW_NEXT_SV_SET(sstr, dstr);
3766 new_pv = SvPVX_mutable(sstr);
3769 SvPV_set(dstr, new_pv);
3770 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3773 SvLEN_set(dstr, len);
3774 SvCUR_set(dstr, cur);
3783 =for apidoc sv_setpvn
3785 Copies a string into an SV. The C<len> parameter indicates the number of
3786 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3787 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3793 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3796 register char *dptr;
3798 SV_CHECK_THINKFIRST_COW_DROP(sv);
3804 /* len is STRLEN which is unsigned, need to copy to signed */
3807 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3809 SvUPGRADE(sv, SVt_PV);
3811 dptr = SvGROW(sv, len + 1);
3812 Move(ptr,dptr,len,char);
3815 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3820 =for apidoc sv_setpvn_mg
3822 Like C<sv_setpvn>, but also handles 'set' magic.
3828 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3830 sv_setpvn(sv,ptr,len);
3835 =for apidoc sv_setpv
3837 Copies a string into an SV. The string must be null-terminated. Does not
3838 handle 'set' magic. See C<sv_setpv_mg>.
3844 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3847 register STRLEN len;
3849 SV_CHECK_THINKFIRST_COW_DROP(sv);
3855 SvUPGRADE(sv, SVt_PV);
3857 SvGROW(sv, len + 1);
3858 Move(ptr,SvPVX(sv),len+1,char);
3860 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3865 =for apidoc sv_setpv_mg
3867 Like C<sv_setpv>, but also handles 'set' magic.
3873 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3880 =for apidoc sv_usepvn
3882 Tells an SV to use C<ptr> to find its string value. Normally the string is
3883 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3884 The C<ptr> should point to memory that was allocated by C<malloc>. The
3885 string length, C<len>, must be supplied. This function will realloc the
3886 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3887 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3888 See C<sv_usepvn_mg>.
3894 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3898 SV_CHECK_THINKFIRST_COW_DROP(sv);
3899 SvUPGRADE(sv, SVt_PV);
3904 if (SvPVX_const(sv))
3907 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3908 ptr = saferealloc (ptr, allocate);
3911 SvLEN_set(sv, allocate);
3913 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3918 =for apidoc sv_usepvn_mg
3920 Like C<sv_usepvn>, but also handles 'set' magic.
3926 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3928 sv_usepvn(sv,ptr,len);
3932 #ifdef PERL_OLD_COPY_ON_WRITE
3933 /* Need to do this *after* making the SV normal, as we need the buffer
3934 pointer to remain valid until after we've copied it. If we let go too early,
3935 another thread could invalidate it by unsharing last of the same hash key
3936 (which it can do by means other than releasing copy-on-write Svs)
3937 or by changing the other copy-on-write SVs in the loop. */
3939 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3941 if (len) { /* this SV was SvIsCOW_normal(sv) */
3942 /* we need to find the SV pointing to us. */
3943 SV *current = SV_COW_NEXT_SV(after);
3945 if (current == sv) {
3946 /* The SV we point to points back to us (there were only two of us
3948 Hence other SV is no longer copy on write either. */
3950 SvREADONLY_off(after);
3952 /* We need to follow the pointers around the loop. */
3954 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3957 /* don't loop forever if the structure is bust, and we have
3958 a pointer into a closed loop. */
3959 assert (current != after);
3960 assert (SvPVX_const(current) == pvx);
3962 /* Make the SV before us point to the SV after us. */
3963 SV_COW_NEXT_SV_SET(current, after);
3966 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3971 Perl_sv_release_IVX(pTHX_ register SV *sv)
3974 sv_force_normal_flags(sv, 0);
3980 =for apidoc sv_force_normal_flags
3982 Undo various types of fakery on an SV: if the PV is a shared string, make
3983 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3984 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3985 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3986 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3987 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3988 set to some other value.) In addition, the C<flags> parameter gets passed to
3989 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3990 with flags set to 0.
3996 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3999 #ifdef PERL_OLD_COPY_ON_WRITE
4000 if (SvREADONLY(sv)) {
4001 /* At this point I believe I should acquire a global SV mutex. */
4003 const char * const pvx = SvPVX_const(sv);
4004 const STRLEN len = SvLEN(sv);
4005 const STRLEN cur = SvCUR(sv);
4006 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4008 PerlIO_printf(Perl_debug_log,
4009 "Copy on write: Force normal %ld\n",
4015 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4018 if (flags & SV_COW_DROP_PV) {
4019 /* OK, so we don't need to copy our buffer. */
4022 SvGROW(sv, cur + 1);
4023 Move(pvx,SvPVX(sv),cur,char);
4027 sv_release_COW(sv, pvx, len, next);
4032 else if (IN_PERL_RUNTIME)
4033 Perl_croak(aTHX_ PL_no_modify);
4034 /* At this point I believe that I can drop the global SV mutex. */
4037 if (SvREADONLY(sv)) {
4039 const char * const pvx = SvPVX_const(sv);
4040 const STRLEN len = SvCUR(sv);
4045 SvGROW(sv, len + 1);
4046 Move(pvx,SvPVX(sv),len,char);
4048 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4050 else if (IN_PERL_RUNTIME)
4051 Perl_croak(aTHX_ PL_no_modify);
4055 sv_unref_flags(sv, flags);
4056 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4063 Efficient removal of characters from the beginning of the string buffer.
4064 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4065 the string buffer. The C<ptr> becomes the first character of the adjusted
4066 string. Uses the "OOK hack".
4067 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4068 refer to the same chunk of data.
4074 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4076 register STRLEN delta;
4077 if (!ptr || !SvPOKp(sv))
4079 delta = ptr - SvPVX_const(sv);
4080 SV_CHECK_THINKFIRST(sv);
4081 if (SvTYPE(sv) < SVt_PVIV)
4082 sv_upgrade(sv,SVt_PVIV);
4085 if (!SvLEN(sv)) { /* make copy of shared string */
4086 const char *pvx = SvPVX_const(sv);
4087 const STRLEN len = SvCUR(sv);
4088 SvGROW(sv, len + 1);
4089 Move(pvx,SvPVX(sv),len,char);
4093 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4094 and we do that anyway inside the SvNIOK_off
4096 SvFLAGS(sv) |= SVf_OOK;
4099 SvLEN_set(sv, SvLEN(sv) - delta);
4100 SvCUR_set(sv, SvCUR(sv) - delta);
4101 SvPV_set(sv, SvPVX(sv) + delta);
4102 SvIV_set(sv, SvIVX(sv) + delta);
4106 =for apidoc sv_catpvn
4108 Concatenates the string onto the end of the string which is in the SV. The
4109 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4110 status set, then the bytes appended should be valid UTF-8.
4111 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4113 =for apidoc sv_catpvn_flags
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 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4119 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4120 in terms of this function.
4126 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4130 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4132 SvGROW(dsv, dlen + slen + 1);
4134 sstr = SvPVX_const(dsv);
4135 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4136 SvCUR_set(dsv, SvCUR(dsv) + slen);
4138 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4140 if (flags & SV_SMAGIC)
4145 =for apidoc sv_catsv
4147 Concatenates the string from SV C<ssv> onto the end of the string in
4148 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4149 not 'set' magic. See C<sv_catsv_mg>.
4151 =for apidoc sv_catsv_flags
4153 Concatenates the string from SV C<ssv> onto the end of the string in
4154 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4155 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4156 and C<sv_catsv_nomg> are implemented in terms of this function.
4161 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4166 const char *spv = SvPV_const(ssv, slen);
4168 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4169 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4170 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4171 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4172 dsv->sv_flags doesn't have that bit set.
4173 Andy Dougherty 12 Oct 2001
4175 const I32 sutf8 = DO_UTF8(ssv);
4178 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4180 dutf8 = DO_UTF8(dsv);
4182 if (dutf8 != sutf8) {
4184 /* Not modifying source SV, so taking a temporary copy. */
4185 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4187 sv_utf8_upgrade(csv);
4188 spv = SvPV_const(csv, slen);
4191 sv_utf8_upgrade_nomg(dsv);
4193 sv_catpvn_nomg(dsv, spv, slen);
4196 if (flags & SV_SMAGIC)
4201 =for apidoc sv_catpv
4203 Concatenates the string onto the end of the string which is in the SV.
4204 If the SV has the UTF-8 status set, then the bytes appended should be
4205 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4210 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4213 register STRLEN len;
4219 junk = SvPV_force(sv, tlen);
4221 SvGROW(sv, tlen + len + 1);
4223 ptr = SvPVX_const(sv);
4224 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4225 SvCUR_set(sv, SvCUR(sv) + len);
4226 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4231 =for apidoc sv_catpv_mg
4233 Like C<sv_catpv>, but also handles 'set' magic.
4239 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4248 Creates a new SV. A non-zero C<len> parameter indicates the number of
4249 bytes of preallocated string space the SV should have. An extra byte for a
4250 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4251 space is allocated.) The reference count for the new SV is set to 1.
4253 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4254 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4255 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4256 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4257 modules supporting older perls.
4263 Perl_newSV(pTHX_ STRLEN len)
4270 sv_upgrade(sv, SVt_PV);
4271 SvGROW(sv, len + 1);
4276 =for apidoc sv_magicext
4278 Adds magic to an SV, upgrading it if necessary. Applies the
4279 supplied vtable and returns a pointer to the magic added.
4281 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4282 In particular, you can add magic to SvREADONLY SVs, and add more than
4283 one instance of the same 'how'.
4285 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4286 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4287 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4288 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4290 (This is now used as a subroutine by C<sv_magic>.)
4295 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4296 const char* name, I32 namlen)
4301 if (SvTYPE(sv) < SVt_PVMG) {
4302 SvUPGRADE(sv, SVt_PVMG);
4304 Newxz(mg, 1, MAGIC);
4305 mg->mg_moremagic = SvMAGIC(sv);
4306 SvMAGIC_set(sv, mg);
4308 /* Sometimes a magic contains a reference loop, where the sv and
4309 object refer to each other. To prevent a reference loop that
4310 would prevent such objects being freed, we look for such loops
4311 and if we find one we avoid incrementing the object refcount.
4313 Note we cannot do this to avoid self-tie loops as intervening RV must
4314 have its REFCNT incremented to keep it in existence.
4317 if (!obj || obj == sv ||
4318 how == PERL_MAGIC_arylen ||
4319 how == PERL_MAGIC_qr ||
4320 how == PERL_MAGIC_symtab ||
4321 (SvTYPE(obj) == SVt_PVGV &&
4322 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4323 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4324 GvFORM(obj) == (CV*)sv)))
4329 mg->mg_obj = SvREFCNT_inc_simple(obj);
4330 mg->mg_flags |= MGf_REFCOUNTED;
4333 /* Normal self-ties simply pass a null object, and instead of
4334 using mg_obj directly, use the SvTIED_obj macro to produce a
4335 new RV as needed. For glob "self-ties", we are tieing the PVIO
4336 with an RV obj pointing to the glob containing the PVIO. In
4337 this case, to avoid a reference loop, we need to weaken the
4341 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4342 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4348 mg->mg_len = namlen;
4351 mg->mg_ptr = savepvn(name, namlen);
4352 else if (namlen == HEf_SVKEY)
4353 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4355 mg->mg_ptr = (char *) name;
4357 mg->mg_virtual = vtable;
4361 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4366 =for apidoc sv_magic
4368 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4369 then adds a new magic item of type C<how> to the head of the magic list.
4371 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4372 handling of the C<name> and C<namlen> arguments.
4374 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4375 to add more than one instance of the same 'how'.
4381 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4387 #ifdef PERL_OLD_COPY_ON_WRITE
4389 sv_force_normal_flags(sv, 0);
4391 if (SvREADONLY(sv)) {
4393 /* its okay to attach magic to shared strings; the subsequent
4394 * upgrade to PVMG will unshare the string */
4395 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4398 && how != PERL_MAGIC_regex_global
4399 && how != PERL_MAGIC_bm
4400 && how != PERL_MAGIC_fm
4401 && how != PERL_MAGIC_sv
4402 && how != PERL_MAGIC_backref
4405 Perl_croak(aTHX_ PL_no_modify);
4408 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4409 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4410 /* sv_magic() refuses to add a magic of the same 'how' as an
4413 if (how == PERL_MAGIC_taint) {
4415 /* Any scalar which already had taint magic on which someone
4416 (erroneously?) did SvIOK_on() or similar will now be
4417 incorrectly sporting public "OK" flags. */
4418 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4426 vtable = &PL_vtbl_sv;
4428 case PERL_MAGIC_overload:
4429 vtable = &PL_vtbl_amagic;
4431 case PERL_MAGIC_overload_elem:
4432 vtable = &PL_vtbl_amagicelem;
4434 case PERL_MAGIC_overload_table:
4435 vtable = &PL_vtbl_ovrld;
4438 vtable = &PL_vtbl_bm;
4440 case PERL_MAGIC_regdata:
4441 vtable = &PL_vtbl_regdata;
4443 case PERL_MAGIC_regdatum:
4444 vtable = &PL_vtbl_regdatum;
4446 case PERL_MAGIC_env:
4447 vtable = &PL_vtbl_env;
4450 vtable = &PL_vtbl_fm;
4452 case PERL_MAGIC_envelem:
4453 vtable = &PL_vtbl_envelem;
4455 case PERL_MAGIC_regex_global:
4456 vtable = &PL_vtbl_mglob;
4458 case PERL_MAGIC_isa:
4459 vtable = &PL_vtbl_isa;
4461 case PERL_MAGIC_isaelem:
4462 vtable = &PL_vtbl_isaelem;
4464 case PERL_MAGIC_nkeys:
4465 vtable = &PL_vtbl_nkeys;
4467 case PERL_MAGIC_dbfile:
4470 case PERL_MAGIC_dbline:
4471 vtable = &PL_vtbl_dbline;
4473 #ifdef USE_LOCALE_COLLATE
4474 case PERL_MAGIC_collxfrm:
4475 vtable = &PL_vtbl_collxfrm;
4477 #endif /* USE_LOCALE_COLLATE */
4478 case PERL_MAGIC_tied:
4479 vtable = &PL_vtbl_pack;
4481 case PERL_MAGIC_tiedelem:
4482 case PERL_MAGIC_tiedscalar:
4483 vtable = &PL_vtbl_packelem;
4486 vtable = &PL_vtbl_regexp;
4488 case PERL_MAGIC_sig:
4489 vtable = &PL_vtbl_sig;
4491 case PERL_MAGIC_sigelem:
4492 vtable = &PL_vtbl_sigelem;
4494 case PERL_MAGIC_taint:
4495 vtable = &PL_vtbl_taint;
4497 case PERL_MAGIC_uvar:
4498 vtable = &PL_vtbl_uvar;
4500 case PERL_MAGIC_vec:
4501 vtable = &PL_vtbl_vec;
4503 case PERL_MAGIC_arylen_p:
4504 case PERL_MAGIC_rhash:
4505 case PERL_MAGIC_symtab:
4506 case PERL_MAGIC_vstring:
4509 case PERL_MAGIC_utf8:
4510 vtable = &PL_vtbl_utf8;
4512 case PERL_MAGIC_substr:
4513 vtable = &PL_vtbl_substr;
4515 case PERL_MAGIC_defelem:
4516 vtable = &PL_vtbl_defelem;
4518 case PERL_MAGIC_arylen:
4519 vtable = &PL_vtbl_arylen;
4521 case PERL_MAGIC_pos:
4522 vtable = &PL_vtbl_pos;
4524 case PERL_MAGIC_backref:
4525 vtable = &PL_vtbl_backref;
4527 case PERL_MAGIC_ext:
4528 /* Reserved for use by extensions not perl internals. */
4529 /* Useful for attaching extension internal data to perl vars. */
4530 /* Note that multiple extensions may clash if magical scalars */
4531 /* etc holding private data from one are passed to another. */
4535 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4538 /* Rest of work is done else where */
4539 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4542 case PERL_MAGIC_taint:
4545 case PERL_MAGIC_ext:
4546 case PERL_MAGIC_dbfile:
4553 =for apidoc sv_unmagic
4555 Removes all magic of type C<type> from an SV.
4561 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4565 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4567 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4568 for (mg = *mgp; mg; mg = *mgp) {
4569 if (mg->mg_type == type) {
4570 const MGVTBL* const vtbl = mg->mg_virtual;
4571 *mgp = mg->mg_moremagic;
4572 if (vtbl && vtbl->svt_free)
4573 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4574 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4576 Safefree(mg->mg_ptr);
4577 else if (mg->mg_len == HEf_SVKEY)
4578 SvREFCNT_dec((SV*)mg->mg_ptr);
4579 else if (mg->mg_type == PERL_MAGIC_utf8)
4580 Safefree(mg->mg_ptr);
4582 if (mg->mg_flags & MGf_REFCOUNTED)
4583 SvREFCNT_dec(mg->mg_obj);
4587 mgp = &mg->mg_moremagic;
4591 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4592 SvMAGIC_set(sv, NULL);
4599 =for apidoc sv_rvweaken
4601 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4602 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4603 push a back-reference to this RV onto the array of backreferences
4604 associated with that magic.
4610 Perl_sv_rvweaken(pTHX_ SV *sv)
4613 if (!SvOK(sv)) /* let undefs pass */
4616 Perl_croak(aTHX_ "Can't weaken a nonreference");
4617 else if (SvWEAKREF(sv)) {
4618 if (ckWARN(WARN_MISC))
4619 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4623 Perl_sv_add_backref(aTHX_ tsv, sv);
4629 /* Give tsv backref magic if it hasn't already got it, then push a
4630 * back-reference to sv onto the array associated with the backref magic.
4634 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4639 if (SvTYPE(tsv) == SVt_PVHV) {
4640 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4644 /* There is no AV in the offical place - try a fixup. */
4645 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4648 /* Aha. They've got it stowed in magic. Bring it back. */
4649 av = (AV*)mg->mg_obj;
4650 /* Stop mg_free decreasing the refernce count. */
4652 /* Stop mg_free even calling the destructor, given that
4653 there's no AV to free up. */
4655 sv_unmagic(tsv, PERL_MAGIC_backref);
4659 SvREFCNT_inc_simple_void(av);
4664 const MAGIC *const mg
4665 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4667 av = (AV*)mg->mg_obj;
4671 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4672 /* av now has a refcnt of 2, which avoids it getting freed
4673 * before us during global cleanup. The extra ref is removed
4674 * by magic_killbackrefs() when tsv is being freed */
4677 if (AvFILLp(av) >= AvMAX(av)) {
4678 av_extend(av, AvFILLp(av)+1);
4680 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4683 /* delete a back-reference to ourselves from the backref magic associated
4684 * with the SV we point to.
4688 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4695 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4696 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4697 /* We mustn't attempt to "fix up" the hash here by moving the
4698 backreference array back to the hv_aux structure, as that is stored
4699 in the main HvARRAY(), and hfreentries assumes that no-one
4700 reallocates HvARRAY() while it is running. */
4703 const MAGIC *const mg
4704 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4706 av = (AV *)mg->mg_obj;
4709 if (PL_in_clean_all)
4711 Perl_croak(aTHX_ "panic: del_backref");
4718 /* We shouldn't be in here more than once, but for paranoia reasons lets
4720 for (i = AvFILLp(av); i >= 0; i--) {
4722 const SSize_t fill = AvFILLp(av);
4724 /* We weren't the last entry.
4725 An unordered list has this property that you can take the
4726 last element off the end to fill the hole, and it's still
4727 an unordered list :-)
4732 AvFILLp(av) = fill - 1;
4738 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4740 SV **svp = AvARRAY(av);
4742 PERL_UNUSED_ARG(sv);
4744 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4745 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4746 if (svp && !SvIS_FREED(av)) {
4747 SV *const *const last = svp + AvFILLp(av);
4749 while (svp <= last) {
4751 SV *const referrer = *svp;
4752 if (SvWEAKREF(referrer)) {
4753 /* XXX Should we check that it hasn't changed? */
4754 SvRV_set(referrer, 0);
4756 SvWEAKREF_off(referrer);
4757 } else if (SvTYPE(referrer) == SVt_PVGV ||
4758 SvTYPE(referrer) == SVt_PVLV) {
4759 /* You lookin' at me? */
4760 assert(GvSTASH(referrer));
4761 assert(GvSTASH(referrer) == (HV*)sv);
4762 GvSTASH(referrer) = 0;
4765 "panic: magic_killbackrefs (flags=%"UVxf")",
4766 (UV)SvFLAGS(referrer));
4774 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4779 =for apidoc sv_insert
4781 Inserts a string at the specified offset/length within the SV. Similar to
4782 the Perl substr() function.
4788 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4793 register char *midend;
4794 register char *bigend;
4800 Perl_croak(aTHX_ "Can't modify non-existent substring");
4801 SvPV_force(bigstr, curlen);
4802 (void)SvPOK_only_UTF8(bigstr);
4803 if (offset + len > curlen) {
4804 SvGROW(bigstr, offset+len+1);
4805 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4806 SvCUR_set(bigstr, offset+len);
4810 i = littlelen - len;
4811 if (i > 0) { /* string might grow */
4812 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4813 mid = big + offset + len;
4814 midend = bigend = big + SvCUR(bigstr);
4817 while (midend > mid) /* shove everything down */
4818 *--bigend = *--midend;
4819 Move(little,big+offset,littlelen,char);
4820 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4825 Move(little,SvPVX(bigstr)+offset,len,char);
4830 big = SvPVX(bigstr);
4833 bigend = big + SvCUR(bigstr);
4835 if (midend > bigend)
4836 Perl_croak(aTHX_ "panic: sv_insert");
4838 if (mid - big > bigend - midend) { /* faster to shorten from end */
4840 Move(little, mid, littlelen,char);
4843 i = bigend - midend;
4845 Move(midend, mid, i,char);
4849 SvCUR_set(bigstr, mid - big);
4851 else if ((i = mid - big)) { /* faster from front */
4852 midend -= littlelen;
4854 sv_chop(bigstr,midend-i);
4859 Move(little, mid, littlelen,char);
4861 else if (littlelen) {
4862 midend -= littlelen;
4863 sv_chop(bigstr,midend);
4864 Move(little,midend,littlelen,char);
4867 sv_chop(bigstr,midend);
4873 =for apidoc sv_replace
4875 Make the first argument a copy of the second, then delete the original.
4876 The target SV physically takes over ownership of the body of the source SV
4877 and inherits its flags; however, the target keeps any magic it owns,
4878 and any magic in the source is discarded.
4879 Note that this is a rather specialist SV copying operation; most of the
4880 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4886 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4889 const U32 refcnt = SvREFCNT(sv);
4890 SV_CHECK_THINKFIRST_COW_DROP(sv);
4891 if (SvREFCNT(nsv) != 1) {
4892 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4893 UVuf " != 1)", (UV) SvREFCNT(nsv));
4895 if (SvMAGICAL(sv)) {
4899 sv_upgrade(nsv, SVt_PVMG);
4900 SvMAGIC_set(nsv, SvMAGIC(sv));
4901 SvFLAGS(nsv) |= SvMAGICAL(sv);
4903 SvMAGIC_set(sv, NULL);
4907 assert(!SvREFCNT(sv));
4908 #ifdef DEBUG_LEAKING_SCALARS
4909 sv->sv_flags = nsv->sv_flags;
4910 sv->sv_any = nsv->sv_any;
4911 sv->sv_refcnt = nsv->sv_refcnt;
4912 sv->sv_u = nsv->sv_u;
4914 StructCopy(nsv,sv,SV);
4916 /* Currently could join these into one piece of pointer arithmetic, but
4917 it would be unclear. */
4918 if(SvTYPE(sv) == SVt_IV)
4920 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4921 else if (SvTYPE(sv) == SVt_RV) {
4922 SvANY(sv) = &sv->sv_u.svu_rv;
4926 #ifdef PERL_OLD_COPY_ON_WRITE
4927 if (SvIsCOW_normal(nsv)) {
4928 /* We need to follow the pointers around the loop to make the
4929 previous SV point to sv, rather than nsv. */
4932 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4935 assert(SvPVX_const(current) == SvPVX_const(nsv));
4937 /* Make the SV before us point to the SV after us. */
4939 PerlIO_printf(Perl_debug_log, "previous is\n");
4941 PerlIO_printf(Perl_debug_log,
4942 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4943 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4945 SV_COW_NEXT_SV_SET(current, sv);
4948 SvREFCNT(sv) = refcnt;
4949 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4955 =for apidoc sv_clear
4957 Clear an SV: call any destructors, free up any memory used by the body,
4958 and free the body itself. The SV's head is I<not> freed, although
4959 its type is set to all 1's so that it won't inadvertently be assumed
4960 to be live during global destruction etc.
4961 This function should only be called when REFCNT is zero. Most of the time
4962 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4969 Perl_sv_clear(pTHX_ register SV *sv)
4972 const U32 type = SvTYPE(sv);
4973 const struct body_details *const sv_type_details
4974 = bodies_by_type + type;
4977 assert(SvREFCNT(sv) == 0);
4979 if (type <= SVt_IV) {
4980 /* See the comment in sv.h about the collusion between this early
4981 return and the overloading of the NULL and IV slots in the size
4987 if (PL_defstash) { /* Still have a symbol table? */
4992 stash = SvSTASH(sv);
4993 destructor = StashHANDLER(stash,DESTROY);
4995 SV* const tmpref = newRV(sv);
4996 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4998 PUSHSTACKi(PERLSI_DESTROY);
5003 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5009 if(SvREFCNT(tmpref) < 2) {
5010 /* tmpref is not kept alive! */
5012 SvRV_set(tmpref, NULL);
5015 SvREFCNT_dec(tmpref);
5017 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5021 if (PL_in_clean_objs)
5022 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5024 /* DESTROY gave object new lease on life */
5030 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5031 SvOBJECT_off(sv); /* Curse the object. */
5032 if (type != SVt_PVIO)
5033 --PL_sv_objcount; /* XXX Might want something more general */
5036 if (type >= SVt_PVMG) {
5038 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5039 (ourstash = OURSTASH(sv))) {
5040 SvREFCNT_dec(ourstash);
5041 } else if (SvMAGIC(sv))
5043 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5044 SvREFCNT_dec(SvSTASH(sv));
5049 IoIFP(sv) != PerlIO_stdin() &&
5050 IoIFP(sv) != PerlIO_stdout() &&
5051 IoIFP(sv) != PerlIO_stderr())
5053 io_close((IO*)sv, FALSE);
5055 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5056 PerlDir_close(IoDIRP(sv));
5057 IoDIRP(sv) = (DIR*)NULL;
5058 Safefree(IoTOP_NAME(sv));
5059 Safefree(IoFMT_NAME(sv));
5060 Safefree(IoBOTTOM_NAME(sv));
5069 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5076 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5077 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5078 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5079 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5081 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5082 SvREFCNT_dec(LvTARG(sv));
5086 if (GvNAME_HEK(sv)) {
5087 unshare_hek(GvNAME_HEK(sv));
5089 /* If we're in a stash, we don't own a reference to it. However it does
5090 have a back reference to us, which needs to be cleared. */
5092 sv_del_backref((SV*)GvSTASH(sv), sv);
5097 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5099 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5100 /* Don't even bother with turning off the OOK flag. */
5105 SV * const target = SvRV(sv);
5107 sv_del_backref(target, sv);
5109 SvREFCNT_dec(target);
5111 #ifdef PERL_OLD_COPY_ON_WRITE
5112 else if (SvPVX_const(sv)) {
5114 /* I believe I need to grab the global SV mutex here and
5115 then recheck the COW status. */
5117 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5120 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5121 SV_COW_NEXT_SV(sv));
5122 /* And drop it here. */
5124 } else if (SvLEN(sv)) {
5125 Safefree(SvPVX_const(sv));
5129 else if (SvPVX_const(sv) && SvLEN(sv))
5130 Safefree(SvPVX_mutable(sv));
5131 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5132 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5141 SvFLAGS(sv) &= SVf_BREAK;
5142 SvFLAGS(sv) |= SVTYPEMASK;
5144 if (sv_type_details->arena) {
5145 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5146 &PL_body_roots[type]);
5148 else if (sv_type_details->body_size) {
5149 my_safefree(SvANY(sv));
5154 =for apidoc sv_newref
5156 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5163 Perl_sv_newref(pTHX_ SV *sv)
5165 PERL_UNUSED_CONTEXT;
5174 Decrement an SV's reference count, and if it drops to zero, call
5175 C<sv_clear> to invoke destructors and free up any memory used by
5176 the body; finally, deallocate the SV's head itself.
5177 Normally called via a wrapper macro C<SvREFCNT_dec>.
5183 Perl_sv_free(pTHX_ SV *sv)
5188 if (SvREFCNT(sv) == 0) {
5189 if (SvFLAGS(sv) & SVf_BREAK)
5190 /* this SV's refcnt has been artificially decremented to
5191 * trigger cleanup */
5193 if (PL_in_clean_all) /* All is fair */
5195 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5196 /* make sure SvREFCNT(sv)==0 happens very seldom */
5197 SvREFCNT(sv) = (~(U32)0)/2;
5200 if (ckWARN_d(WARN_INTERNAL)) {
5201 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5202 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5203 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5204 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5205 Perl_dump_sv_child(aTHX_ sv);
5210 if (--(SvREFCNT(sv)) > 0)
5212 Perl_sv_free2(aTHX_ sv);
5216 Perl_sv_free2(pTHX_ SV *sv)
5221 if (ckWARN_d(WARN_DEBUGGING))
5222 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5223 "Attempt to free temp prematurely: SV 0x%"UVxf
5224 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5228 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5229 /* make sure SvREFCNT(sv)==0 happens very seldom */
5230 SvREFCNT(sv) = (~(U32)0)/2;
5241 Returns the length of the string in the SV. Handles magic and type
5242 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5248 Perl_sv_len(pTHX_ register SV *sv)
5256 len = mg_length(sv);
5258 (void)SvPV_const(sv, len);
5263 =for apidoc sv_len_utf8
5265 Returns the number of characters in the string in an SV, counting wide
5266 UTF-8 bytes as a single character. Handles magic and type coercion.
5272 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5273 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5274 * (Note that the mg_len is not the length of the mg_ptr field.)
5279 Perl_sv_len_utf8(pTHX_ register SV *sv)
5285 return mg_length(sv);
5289 const U8 *s = (U8*)SvPV_const(sv, len);
5293 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5295 if (mg && mg->mg_len != -1) {
5297 if (PL_utf8cache < 0) {
5298 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5300 /* Need to turn the assertions off otherwise we may
5301 recurse infinitely while printing error messages.
5303 SAVEI8(PL_utf8cache);
5305 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5306 " real %"UVf" for %"SVf,
5307 (UV) ulen, (UV) real, sv);
5312 ulen = Perl_utf8_length(aTHX_ s, s + len);
5313 if (!SvREADONLY(sv)) {
5315 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5316 &PL_vtbl_utf8, 0, 0);
5324 return Perl_utf8_length(aTHX_ s, s + len);
5328 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5329 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5330 * between UTF-8 and byte offsets. There are two (substr offset and substr
5331 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5332 * and byte offset) cache positions.
5334 * The mg_len field is used by sv_len_utf8(), see its comments.
5335 * Note that the mg_len is not the length of the mg_ptr field.
5339 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5340 I32 offsetp, const U8 *s, const U8 *start)
5344 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5346 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5347 (*mgp)->mg_len = -1;
5352 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5354 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5355 (*mgp)->mg_ptr = (char *) *cachep;
5359 (*cachep)[i] = offsetp;
5360 (*cachep)[i+1] = s - start;
5368 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5369 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5370 * between UTF-8 and byte offsets. See also the comments of
5371 * S_utf8_mg_pos_init().
5375 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)
5379 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5381 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5382 if (*mgp && (*mgp)->mg_ptr) {
5383 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5384 ASSERT_UTF8_CACHE(*cachep);
5385 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5387 else { /* We will skip to the right spot. */
5392 /* The assumption is that going backward is half
5393 * the speed of going forward (that's where the
5394 * 2 * backw in the below comes from). (The real
5395 * figure of course depends on the UTF-8 data.) */
5397 if ((*cachep)[i] > (STRLEN)uoff) {
5399 backw = (*cachep)[i] - (STRLEN)uoff;
5401 if (forw < 2 * backw)
5404 p = start + (*cachep)[i+1];
5406 /* Try this only for the substr offset (i == 0),
5407 * not for the substr length (i == 2). */
5408 else if (i == 0) { /* (*cachep)[i] < uoff */
5409 const STRLEN ulen = sv_len_utf8(sv);
5411 if ((STRLEN)uoff < ulen) {
5412 forw = (STRLEN)uoff - (*cachep)[i];
5413 backw = ulen - (STRLEN)uoff;
5415 if (forw < 2 * backw)
5416 p = start + (*cachep)[i+1];
5421 /* If the string is not long enough for uoff,
5422 * we could extend it, but not at this low a level. */
5426 if (forw < 2 * backw) {
5433 while (UTF8_IS_CONTINUATION(*p))
5438 /* Update the cache. */
5439 (*cachep)[i] = (STRLEN)uoff;
5440 (*cachep)[i+1] = p - start;
5442 /* Drop the stale "length" cache */
5451 if (found) { /* Setup the return values. */
5452 *offsetp = (*cachep)[i+1];
5453 *sp = start + *offsetp;
5456 *offsetp = send - start;
5458 else if (*sp < start) {
5464 #ifdef PERL_UTF8_CACHE_ASSERT
5466 const U8 *s = start;
5469 while (n-- && s < send)
5473 assert(*offsetp == s - start);
5474 assert((*cachep)[0] == (STRLEN)uoff);
5475 assert((*cachep)[1] == *offsetp);
5477 ASSERT_UTF8_CACHE(*cachep);
5486 =for apidoc sv_pos_u2b
5488 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5489 the start of the string, to a count of the equivalent number of bytes; if
5490 lenp is non-zero, it does the same to lenp, but this time starting from
5491 the offset, rather than from the start of the string. Handles magic and
5498 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5499 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5500 * byte offsets. See also the comments of S_utf8_mg_pos().
5505 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5508 const U8 *s = start;
5510 while (s < send && uoffset--)
5513 /* This is the existing behaviour. Possibly it should be a croak, as
5514 it's actually a bounds error */
5522 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5523 STRLEN uoffset, STRLEN uend)
5525 STRLEN backw = uend - uoffset;
5526 if (uoffset < 2 * backw) {
5527 /* The assumption is that going fowards is twice the speed of going
5528 forward (that's where the 2 * backw comes from).
5529 (The real figure of course depends on the UTF-8 data.) */
5530 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5535 while (UTF8_IS_CONTINUATION(*send))
5538 return send - start;
5542 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5543 const U8 *const send, STRLEN uoffset,
5544 STRLEN uoffset0, STRLEN boffset0) {
5548 assert (uoffset >= uoffset0);
5550 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5551 && (*mgp = mg_find(sv, PERL_MAGIC_utf8))) {
5552 if ((*mgp)->mg_len != -1) {
5553 /* If we can take advantage of a passed in offset, do so. */
5554 /* In fact, offset0 is either 0, or less than offset, so don't
5555 need to worry about the other possibility. */
5557 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5559 (*mgp)->mg_len - uoffset0);
5564 if (!found || PL_utf8cache < 0) {
5565 const STRLEN real_boffset
5566 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5567 send, uoffset - uoffset0);
5569 if (found && PL_utf8cache < 0) {
5570 if (real_boffset != boffset) {
5571 /* Need to turn the assertions off otherwise we may recurse
5572 infinitely while printing error messages. */
5573 SAVEI8(PL_utf8cache);
5575 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5576 " real %"UVf" for %"SVf,
5577 (UV) boffset, (UV) real_boffset, sv);
5580 boffset = real_boffset;
5586 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5594 start = (U8*)SvPV_const(sv, len);
5596 STRLEN uoffset = (STRLEN) *offsetp;
5597 const U8 * const send = start + len;
5599 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5602 *offsetp = (I32) boffset;
5605 /* Convert the relative offset to absolute. */
5606 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5608 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5609 uoffset, boffset) - boffset;
5624 =for apidoc sv_pos_b2u
5626 Converts the value pointed to by offsetp from a count of bytes from the
5627 start of the string, to a count of the equivalent number of UTF-8 chars.
5628 Handles magic and type coercion.
5634 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5635 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5636 * byte offsets. See also the comments of S_utf8_mg_pos().
5642 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target);
5645 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8)
5652 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5654 (*mgp)->mg_len = -1;
5658 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5659 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5660 (*mgp)->mg_ptr = (char *) cache;
5664 if (PL_utf8cache < 0) {
5665 const U8 *start = (const U8 *) SvPVX_const(sv);
5666 const STRLEN realutf8
5667 = S_sv_pos_b2u_forwards(aTHX_ start, start + byte);
5669 if (realutf8 != utf8) {
5670 /* Need to turn the assertions off otherwise we may recurse
5671 infinitely while printing error messages. */
5672 SAVEI8(PL_utf8cache);
5674 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5675 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5680 /* Drop the stale "length" cache */
5685 /* If we don't know the character offset of the end of a region, our only
5686 option is to walk forwards to the target byte offset. */
5688 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5691 while (s < target) {
5694 /* Call utf8n_to_uvchr() to validate the sequence
5695 * (unless a simple non-UTF character) */
5696 if (!UTF8_IS_INVARIANT(*s))
5697 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5708 /* We already know all of the way, now we may be able to walk back. The same
5709 assumption is made as in S_utf8_mg_pos(), namely that walking backward is
5710 twice slower than walking forward. */
5712 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5715 const STRLEN forw = target - s;
5716 STRLEN backw = end - target;
5718 if (forw < 2 * backw) {
5719 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5722 while (end > target) {
5724 while (UTF8_IS_CONTINUATION(*end)) {
5733 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5736 const STRLEN byte = *offsetp;
5744 s = (const U8*)SvPV_const(sv, len);
5747 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5751 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5752 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5754 STRLEN *cache = (STRLEN *) mg->mg_ptr;
5755 if (cache[1] == byte) {
5756 /* An exact match. */
5757 *offsetp = cache[0];
5761 else if (cache[1] < byte) {
5762 /* We already know part of the way. */
5763 if (mg->mg_len != -1) {
5764 /* Actually, we know the end too. */
5766 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5767 s + len, mg->mg_len - cache[0]);
5770 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5773 else { /* cache[1] > byte */
5774 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[1],
5778 ASSERT_UTF8_CACHE(cache);
5779 if (PL_utf8cache < 0) {
5780 const STRLEN reallen = S_sv_pos_b2u_forwards(aTHX_ s, send);
5782 if (len != reallen) {
5783 /* Need to turn the assertions off otherwise we may recurse
5784 infinitely while printing error messages. */
5785 SAVEI8(PL_utf8cache);
5787 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5788 " real %"UVf" for %"SVf,
5789 (UV) len, (UV) reallen, sv);
5792 } else if (mg->mg_len != -1) {
5793 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + len, mg->mg_len);
5795 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5799 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5803 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len);
5809 Returns a boolean indicating whether the strings in the two SVs are
5810 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5811 coerce its args to strings if necessary.
5817 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5826 SV* svrecode = NULL;
5833 pv1 = SvPV_const(sv1, cur1);
5840 pv2 = SvPV_const(sv2, cur2);
5842 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5843 /* Differing utf8ness.
5844 * Do not UTF8size the comparands as a side-effect. */
5847 svrecode = newSVpvn(pv2, cur2);
5848 sv_recode_to_utf8(svrecode, PL_encoding);
5849 pv2 = SvPV_const(svrecode, cur2);
5852 svrecode = newSVpvn(pv1, cur1);
5853 sv_recode_to_utf8(svrecode, PL_encoding);
5854 pv1 = SvPV_const(svrecode, cur1);
5856 /* Now both are in UTF-8. */
5858 SvREFCNT_dec(svrecode);
5863 bool is_utf8 = TRUE;
5866 /* sv1 is the UTF-8 one,
5867 * if is equal it must be downgrade-able */
5868 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5874 /* sv2 is the UTF-8 one,
5875 * if is equal it must be downgrade-able */
5876 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5882 /* Downgrade not possible - cannot be eq */
5890 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5892 SvREFCNT_dec(svrecode);
5902 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5903 string in C<sv1> is less than, equal to, or greater than the string in
5904 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5905 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5911 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5915 const char *pv1, *pv2;
5918 SV *svrecode = NULL;
5925 pv1 = SvPV_const(sv1, cur1);
5932 pv2 = SvPV_const(sv2, cur2);
5934 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5935 /* Differing utf8ness.
5936 * Do not UTF8size the comparands as a side-effect. */
5939 svrecode = newSVpvn(pv2, cur2);
5940 sv_recode_to_utf8(svrecode, PL_encoding);
5941 pv2 = SvPV_const(svrecode, cur2);
5944 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5949 svrecode = newSVpvn(pv1, cur1);
5950 sv_recode_to_utf8(svrecode, PL_encoding);
5951 pv1 = SvPV_const(svrecode, cur1);
5954 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5960 cmp = cur2 ? -1 : 0;
5964 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5967 cmp = retval < 0 ? -1 : 1;
5968 } else if (cur1 == cur2) {
5971 cmp = cur1 < cur2 ? -1 : 1;
5975 SvREFCNT_dec(svrecode);
5983 =for apidoc sv_cmp_locale
5985 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5986 'use bytes' aware, handles get magic, and will coerce its args to strings
5987 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5993 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5996 #ifdef USE_LOCALE_COLLATE
6002 if (PL_collation_standard)
6006 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6008 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6010 if (!pv1 || !len1) {
6021 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6024 return retval < 0 ? -1 : 1;
6027 * When the result of collation is equality, that doesn't mean
6028 * that there are no differences -- some locales exclude some
6029 * characters from consideration. So to avoid false equalities,
6030 * we use the raw string as a tiebreaker.
6036 #endif /* USE_LOCALE_COLLATE */
6038 return sv_cmp(sv1, sv2);
6042 #ifdef USE_LOCALE_COLLATE
6045 =for apidoc sv_collxfrm
6047 Add Collate Transform magic to an SV if it doesn't already have it.
6049 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6050 scalar data of the variable, but transformed to such a format that a normal
6051 memory comparison can be used to compare the data according to the locale
6058 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6063 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6064 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6070 Safefree(mg->mg_ptr);
6071 s = SvPV_const(sv, len);
6072 if ((xf = mem_collxfrm(s, len, &xlen))) {
6073 if (SvREADONLY(sv)) {
6076 return xf + sizeof(PL_collation_ix);
6079 #ifdef PERL_OLD_COPY_ON_WRITE
6081 sv_force_normal_flags(sv, 0);
6083 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6097 if (mg && mg->mg_ptr) {
6099 return mg->mg_ptr + sizeof(PL_collation_ix);
6107 #endif /* USE_LOCALE_COLLATE */
6112 Get a line from the filehandle and store it into the SV, optionally
6113 appending to the currently-stored string.
6119 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6124 register STDCHAR rslast;
6125 register STDCHAR *bp;
6131 if (SvTHINKFIRST(sv))
6132 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6133 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6135 However, perlbench says it's slower, because the existing swipe code
6136 is faster than copy on write.
6137 Swings and roundabouts. */
6138 SvUPGRADE(sv, SVt_PV);
6143 if (PerlIO_isutf8(fp)) {
6145 sv_utf8_upgrade_nomg(sv);
6146 sv_pos_u2b(sv,&append,0);
6148 } else if (SvUTF8(sv)) {
6149 SV * const tsv = newSV(0);
6150 sv_gets(tsv, fp, 0);
6151 sv_utf8_upgrade_nomg(tsv);
6152 SvCUR_set(sv,append);
6155 goto return_string_or_null;
6160 if (PerlIO_isutf8(fp))
6163 if (IN_PERL_COMPILETIME) {
6164 /* we always read code in line mode */
6168 else if (RsSNARF(PL_rs)) {
6169 /* If it is a regular disk file use size from stat() as estimate
6170 of amount we are going to read - may result in malloc-ing
6171 more memory than we realy need if layers bellow reduce
6172 size we read (e.g. CRLF or a gzip layer)
6175 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6176 const Off_t offset = PerlIO_tell(fp);
6177 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6178 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6184 else if (RsRECORD(PL_rs)) {
6188 /* Grab the size of the record we're getting */
6189 recsize = SvIV(SvRV(PL_rs));
6190 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6193 /* VMS wants read instead of fread, because fread doesn't respect */
6194 /* RMS record boundaries. This is not necessarily a good thing to be */
6195 /* doing, but we've got no other real choice - except avoid stdio
6196 as implementation - perhaps write a :vms layer ?
6198 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6200 bytesread = PerlIO_read(fp, buffer, recsize);
6204 SvCUR_set(sv, bytesread += append);
6205 buffer[bytesread] = '\0';
6206 goto return_string_or_null;
6208 else if (RsPARA(PL_rs)) {
6214 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6215 if (PerlIO_isutf8(fp)) {
6216 rsptr = SvPVutf8(PL_rs, rslen);
6219 if (SvUTF8(PL_rs)) {
6220 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6221 Perl_croak(aTHX_ "Wide character in $/");
6224 rsptr = SvPV_const(PL_rs, rslen);
6228 rslast = rslen ? rsptr[rslen - 1] : '\0';
6230 if (rspara) { /* have to do this both before and after */
6231 do { /* to make sure file boundaries work right */
6234 i = PerlIO_getc(fp);
6238 PerlIO_ungetc(fp,i);
6244 /* See if we know enough about I/O mechanism to cheat it ! */
6246 /* This used to be #ifdef test - it is made run-time test for ease
6247 of abstracting out stdio interface. One call should be cheap
6248 enough here - and may even be a macro allowing compile
6252 if (PerlIO_fast_gets(fp)) {
6255 * We're going to steal some values from the stdio struct
6256 * and put EVERYTHING in the innermost loop into registers.
6258 register STDCHAR *ptr;
6262 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6263 /* An ungetc()d char is handled separately from the regular
6264 * buffer, so we getc() it back out and stuff it in the buffer.
6266 i = PerlIO_getc(fp);
6267 if (i == EOF) return 0;
6268 *(--((*fp)->_ptr)) = (unsigned char) i;
6272 /* Here is some breathtakingly efficient cheating */
6274 cnt = PerlIO_get_cnt(fp); /* get count into register */
6275 /* make sure we have the room */
6276 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6277 /* Not room for all of it
6278 if we are looking for a separator and room for some
6280 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6281 /* just process what we have room for */
6282 shortbuffered = cnt - SvLEN(sv) + append + 1;
6283 cnt -= shortbuffered;
6287 /* remember that cnt can be negative */
6288 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6293 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6294 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6295 DEBUG_P(PerlIO_printf(Perl_debug_log,
6296 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6297 DEBUG_P(PerlIO_printf(Perl_debug_log,
6298 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6299 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6300 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6305 while (cnt > 0) { /* this | eat */
6307 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6308 goto thats_all_folks; /* screams | sed :-) */
6312 Copy(ptr, bp, cnt, char); /* this | eat */
6313 bp += cnt; /* screams | dust */
6314 ptr += cnt; /* louder | sed :-) */
6319 if (shortbuffered) { /* oh well, must extend */
6320 cnt = shortbuffered;
6322 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6324 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6325 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6329 DEBUG_P(PerlIO_printf(Perl_debug_log,
6330 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6331 PTR2UV(ptr),(long)cnt));
6332 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6334 DEBUG_P(PerlIO_printf(Perl_debug_log,
6335 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6336 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6337 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6339 /* This used to call 'filbuf' in stdio form, but as that behaves like
6340 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6341 another abstraction. */
6342 i = PerlIO_getc(fp); /* get more characters */
6344 DEBUG_P(PerlIO_printf(Perl_debug_log,
6345 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6346 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6347 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6349 cnt = PerlIO_get_cnt(fp);
6350 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6351 DEBUG_P(PerlIO_printf(Perl_debug_log,
6352 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6354 if (i == EOF) /* all done for ever? */
6355 goto thats_really_all_folks;
6357 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6359 SvGROW(sv, bpx + cnt + 2);
6360 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6362 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6364 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6365 goto thats_all_folks;
6369 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6370 memNE((char*)bp - rslen, rsptr, rslen))
6371 goto screamer; /* go back to the fray */
6372 thats_really_all_folks:
6374 cnt += shortbuffered;
6375 DEBUG_P(PerlIO_printf(Perl_debug_log,
6376 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6377 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6378 DEBUG_P(PerlIO_printf(Perl_debug_log,
6379 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6380 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6381 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6383 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6384 DEBUG_P(PerlIO_printf(Perl_debug_log,
6385 "Screamer: done, len=%ld, string=|%.*s|\n",
6386 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6390 /*The big, slow, and stupid way. */
6391 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6392 STDCHAR *buf = NULL;
6393 Newx(buf, 8192, STDCHAR);
6401 register const STDCHAR * const bpe = buf + sizeof(buf);
6403 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6404 ; /* keep reading */
6408 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6409 /* Accomodate broken VAXC compiler, which applies U8 cast to
6410 * both args of ?: operator, causing EOF to change into 255
6413 i = (U8)buf[cnt - 1];
6419 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6421 sv_catpvn(sv, (char *) buf, cnt);
6423 sv_setpvn(sv, (char *) buf, cnt);
6425 if (i != EOF && /* joy */
6427 SvCUR(sv) < rslen ||
6428 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6432 * If we're reading from a TTY and we get a short read,
6433 * indicating that the user hit his EOF character, we need
6434 * to notice it now, because if we try to read from the TTY
6435 * again, the EOF condition will disappear.
6437 * The comparison of cnt to sizeof(buf) is an optimization
6438 * that prevents unnecessary calls to feof().
6442 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6446 #ifdef USE_HEAP_INSTEAD_OF_STACK
6451 if (rspara) { /* have to do this both before and after */
6452 while (i != EOF) { /* to make sure file boundaries work right */
6453 i = PerlIO_getc(fp);
6455 PerlIO_ungetc(fp,i);
6461 return_string_or_null:
6462 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6468 Auto-increment of the value in the SV, doing string to numeric conversion
6469 if necessary. Handles 'get' magic.
6475 Perl_sv_inc(pTHX_ register SV *sv)
6484 if (SvTHINKFIRST(sv)) {
6486 sv_force_normal_flags(sv, 0);
6487 if (SvREADONLY(sv)) {
6488 if (IN_PERL_RUNTIME)
6489 Perl_croak(aTHX_ PL_no_modify);
6493 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6495 i = PTR2IV(SvRV(sv));
6500 flags = SvFLAGS(sv);
6501 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6502 /* It's (privately or publicly) a float, but not tested as an
6503 integer, so test it to see. */
6505 flags = SvFLAGS(sv);
6507 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6508 /* It's publicly an integer, or privately an integer-not-float */
6509 #ifdef PERL_PRESERVE_IVUV
6513 if (SvUVX(sv) == UV_MAX)
6514 sv_setnv(sv, UV_MAX_P1);
6516 (void)SvIOK_only_UV(sv);
6517 SvUV_set(sv, SvUVX(sv) + 1);
6519 if (SvIVX(sv) == IV_MAX)
6520 sv_setuv(sv, (UV)IV_MAX + 1);
6522 (void)SvIOK_only(sv);
6523 SvIV_set(sv, SvIVX(sv) + 1);
6528 if (flags & SVp_NOK) {
6529 (void)SvNOK_only(sv);
6530 SvNV_set(sv, SvNVX(sv) + 1.0);
6534 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6535 if ((flags & SVTYPEMASK) < SVt_PVIV)
6536 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6537 (void)SvIOK_only(sv);
6542 while (isALPHA(*d)) d++;
6543 while (isDIGIT(*d)) d++;
6545 #ifdef PERL_PRESERVE_IVUV
6546 /* Got to punt this as an integer if needs be, but we don't issue
6547 warnings. Probably ought to make the sv_iv_please() that does
6548 the conversion if possible, and silently. */
6549 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6550 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6551 /* Need to try really hard to see if it's an integer.
6552 9.22337203685478e+18 is an integer.
6553 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6554 so $a="9.22337203685478e+18"; $a+0; $a++
6555 needs to be the same as $a="9.22337203685478e+18"; $a++
6562 /* sv_2iv *should* have made this an NV */
6563 if (flags & SVp_NOK) {
6564 (void)SvNOK_only(sv);
6565 SvNV_set(sv, SvNVX(sv) + 1.0);
6568 /* I don't think we can get here. Maybe I should assert this
6569 And if we do get here I suspect that sv_setnv will croak. NWC
6571 #if defined(USE_LONG_DOUBLE)
6572 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",
6573 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6575 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6576 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6579 #endif /* PERL_PRESERVE_IVUV */
6580 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6584 while (d >= SvPVX_const(sv)) {
6592 /* MKS: The original code here died if letters weren't consecutive.
6593 * at least it didn't have to worry about non-C locales. The
6594 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6595 * arranged in order (although not consecutively) and that only
6596 * [A-Za-z] are accepted by isALPHA in the C locale.
6598 if (*d != 'z' && *d != 'Z') {
6599 do { ++*d; } while (!isALPHA(*d));
6602 *(d--) -= 'z' - 'a';
6607 *(d--) -= 'z' - 'a' + 1;
6611 /* oh,oh, the number grew */
6612 SvGROW(sv, SvCUR(sv) + 2);
6613 SvCUR_set(sv, SvCUR(sv) + 1);
6614 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6625 Auto-decrement of the value in the SV, doing string to numeric conversion
6626 if necessary. Handles 'get' magic.
6632 Perl_sv_dec(pTHX_ register SV *sv)
6640 if (SvTHINKFIRST(sv)) {
6642 sv_force_normal_flags(sv, 0);
6643 if (SvREADONLY(sv)) {
6644 if (IN_PERL_RUNTIME)
6645 Perl_croak(aTHX_ PL_no_modify);
6649 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6651 i = PTR2IV(SvRV(sv));
6656 /* Unlike sv_inc we don't have to worry about string-never-numbers
6657 and keeping them magic. But we mustn't warn on punting */
6658 flags = SvFLAGS(sv);
6659 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6660 /* It's publicly an integer, or privately an integer-not-float */
6661 #ifdef PERL_PRESERVE_IVUV
6665 if (SvUVX(sv) == 0) {
6666 (void)SvIOK_only(sv);
6670 (void)SvIOK_only_UV(sv);
6671 SvUV_set(sv, SvUVX(sv) - 1);
6674 if (SvIVX(sv) == IV_MIN)
6675 sv_setnv(sv, (NV)IV_MIN - 1.0);
6677 (void)SvIOK_only(sv);
6678 SvIV_set(sv, SvIVX(sv) - 1);
6683 if (flags & SVp_NOK) {
6684 SvNV_set(sv, SvNVX(sv) - 1.0);
6685 (void)SvNOK_only(sv);
6688 if (!(flags & SVp_POK)) {
6689 if ((flags & SVTYPEMASK) < SVt_PVIV)
6690 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6692 (void)SvIOK_only(sv);
6695 #ifdef PERL_PRESERVE_IVUV
6697 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6698 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6699 /* Need to try really hard to see if it's an integer.
6700 9.22337203685478e+18 is an integer.
6701 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6702 so $a="9.22337203685478e+18"; $a+0; $a--
6703 needs to be the same as $a="9.22337203685478e+18"; $a--
6710 /* sv_2iv *should* have made this an NV */
6711 if (flags & SVp_NOK) {
6712 (void)SvNOK_only(sv);
6713 SvNV_set(sv, SvNVX(sv) - 1.0);
6716 /* I don't think we can get here. Maybe I should assert this
6717 And if we do get here I suspect that sv_setnv will croak. NWC
6719 #if defined(USE_LONG_DOUBLE)
6720 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",
6721 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6723 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6724 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6728 #endif /* PERL_PRESERVE_IVUV */
6729 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6733 =for apidoc sv_mortalcopy
6735 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6736 The new SV is marked as mortal. It will be destroyed "soon", either by an
6737 explicit call to FREETMPS, or by an implicit call at places such as
6738 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6743 /* Make a string that will exist for the duration of the expression
6744 * evaluation. Actually, it may have to last longer than that, but
6745 * hopefully we won't free it until it has been assigned to a
6746 * permanent location. */
6749 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6755 sv_setsv(sv,oldstr);
6757 PL_tmps_stack[++PL_tmps_ix] = sv;
6763 =for apidoc sv_newmortal
6765 Creates a new null SV which is mortal. The reference count of the SV is
6766 set to 1. It will be destroyed "soon", either by an explicit call to
6767 FREETMPS, or by an implicit call at places such as statement boundaries.
6768 See also C<sv_mortalcopy> and C<sv_2mortal>.
6774 Perl_sv_newmortal(pTHX)
6780 SvFLAGS(sv) = SVs_TEMP;
6782 PL_tmps_stack[++PL_tmps_ix] = sv;
6787 =for apidoc sv_2mortal
6789 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6790 by an explicit call to FREETMPS, or by an implicit call at places such as
6791 statement boundaries. SvTEMP() is turned on which means that the SV's
6792 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6793 and C<sv_mortalcopy>.
6799 Perl_sv_2mortal(pTHX_ register SV *sv)
6804 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6807 PL_tmps_stack[++PL_tmps_ix] = sv;
6815 Creates a new SV and copies a string into it. The reference count for the
6816 SV is set to 1. If C<len> is zero, Perl will compute the length using
6817 strlen(). For efficiency, consider using C<newSVpvn> instead.
6823 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6829 sv_setpvn(sv,s,len ? len : strlen(s));
6834 =for apidoc newSVpvn
6836 Creates a new SV and copies a string into it. The reference count for the
6837 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6838 string. You are responsible for ensuring that the source string is at least
6839 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6845 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6851 sv_setpvn(sv,s,len);
6857 =for apidoc newSVhek
6859 Creates a new SV from the hash key structure. It will generate scalars that
6860 point to the shared string table where possible. Returns a new (undefined)
6861 SV if the hek is NULL.
6867 Perl_newSVhek(pTHX_ const HEK *hek)
6877 if (HEK_LEN(hek) == HEf_SVKEY) {
6878 return newSVsv(*(SV**)HEK_KEY(hek));
6880 const int flags = HEK_FLAGS(hek);
6881 if (flags & HVhek_WASUTF8) {
6883 Andreas would like keys he put in as utf8 to come back as utf8
6885 STRLEN utf8_len = HEK_LEN(hek);
6886 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6887 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6890 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6892 } else if (flags & HVhek_REHASH) {
6893 /* We don't have a pointer to the hv, so we have to replicate the
6894 flag into every HEK. This hv is using custom a hasing
6895 algorithm. Hence we can't return a shared string scalar, as
6896 that would contain the (wrong) hash value, and might get passed
6897 into an hv routine with a regular hash */
6899 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6904 /* This will be overwhelminly the most common case. */
6905 return newSVpvn_share(HEK_KEY(hek),
6906 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6912 =for apidoc newSVpvn_share
6914 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6915 table. If the string does not already exist in the table, it is created
6916 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6917 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6918 otherwise the hash is computed. The idea here is that as the string table
6919 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6920 hash lookup will avoid string compare.
6926 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6930 bool is_utf8 = FALSE;
6932 STRLEN tmplen = -len;
6934 /* See the note in hv.c:hv_fetch() --jhi */
6935 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6939 PERL_HASH(hash, src, len);
6941 sv_upgrade(sv, SVt_PV);
6942 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6954 #if defined(PERL_IMPLICIT_CONTEXT)
6956 /* pTHX_ magic can't cope with varargs, so this is a no-context
6957 * version of the main function, (which may itself be aliased to us).
6958 * Don't access this version directly.
6962 Perl_newSVpvf_nocontext(const char* pat, ...)
6967 va_start(args, pat);
6968 sv = vnewSVpvf(pat, &args);
6975 =for apidoc newSVpvf
6977 Creates a new SV and initializes it with the string formatted like
6984 Perl_newSVpvf(pTHX_ const char* pat, ...)
6988 va_start(args, pat);
6989 sv = vnewSVpvf(pat, &args);
6994 /* backend for newSVpvf() and newSVpvf_nocontext() */
6997 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7002 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7009 Creates a new SV and copies a floating point value into it.
7010 The reference count for the SV is set to 1.
7016 Perl_newSVnv(pTHX_ NV n)
7029 Creates a new SV and copies an integer into it. The reference count for the
7036 Perl_newSViv(pTHX_ IV i)
7049 Creates a new SV and copies an unsigned integer into it.
7050 The reference count for the SV is set to 1.
7056 Perl_newSVuv(pTHX_ UV u)
7067 =for apidoc newRV_noinc
7069 Creates an RV wrapper for an SV. The reference count for the original
7070 SV is B<not> incremented.
7076 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7082 sv_upgrade(sv, SVt_RV);
7084 SvRV_set(sv, tmpRef);
7089 /* newRV_inc is the official function name to use now.
7090 * newRV_inc is in fact #defined to newRV in sv.h
7094 Perl_newRV(pTHX_ SV *sv)
7097 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7103 Creates a new SV which is an exact duplicate of the original SV.
7110 Perl_newSVsv(pTHX_ register SV *old)
7117 if (SvTYPE(old) == SVTYPEMASK) {
7118 if (ckWARN_d(WARN_INTERNAL))
7119 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7123 /* SV_GMAGIC is the default for sv_setv()
7124 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7125 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7126 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7131 =for apidoc sv_reset
7133 Underlying implementation for the C<reset> Perl function.
7134 Note that the perl-level function is vaguely deprecated.
7140 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7143 char todo[PERL_UCHAR_MAX+1];
7148 if (!*s) { /* reset ?? searches */
7149 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7151 PMOP *pm = (PMOP *) mg->mg_obj;
7153 pm->op_pmdynflags &= ~PMdf_USED;
7160 /* reset variables */
7162 if (!HvARRAY(stash))
7165 Zero(todo, 256, char);
7168 I32 i = (unsigned char)*s;
7172 max = (unsigned char)*s++;
7173 for ( ; i <= max; i++) {
7176 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7178 for (entry = HvARRAY(stash)[i];
7180 entry = HeNEXT(entry))
7185 if (!todo[(U8)*HeKEY(entry)])
7187 gv = (GV*)HeVAL(entry);
7190 if (SvTHINKFIRST(sv)) {
7191 if (!SvREADONLY(sv) && SvROK(sv))
7193 /* XXX Is this continue a bug? Why should THINKFIRST
7194 exempt us from resetting arrays and hashes? */
7198 if (SvTYPE(sv) >= SVt_PV) {
7200 if (SvPVX_const(sv) != NULL)
7208 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7210 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7213 # if defined(USE_ENVIRON_ARRAY)
7216 # endif /* USE_ENVIRON_ARRAY */
7227 Using various gambits, try to get an IO from an SV: the IO slot if its a
7228 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7229 named after the PV if we're a string.
7235 Perl_sv_2io(pTHX_ SV *sv)
7240 switch (SvTYPE(sv)) {
7248 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7252 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7254 return sv_2io(SvRV(sv));
7255 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7261 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7270 Using various gambits, try to get a CV from an SV; in addition, try if
7271 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7272 The flags in C<lref> are passed to sv_fetchsv.
7278 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7289 switch (SvTYPE(sv)) {
7308 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7309 tryAMAGICunDEREF(to_cv);
7312 if (SvTYPE(sv) == SVt_PVCV) {
7321 Perl_croak(aTHX_ "Not a subroutine reference");
7326 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7332 /* Some flags to gv_fetchsv mean don't really create the GV */
7333 if (SvTYPE(gv) != SVt_PVGV) {
7339 if (lref && !GvCVu(gv)) {
7343 gv_efullname3(tmpsv, gv, NULL);
7344 /* XXX this is probably not what they think they're getting.
7345 * It has the same effect as "sub name;", i.e. just a forward
7347 newSUB(start_subparse(FALSE, 0),
7348 newSVOP(OP_CONST, 0, tmpsv),
7352 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7362 Returns true if the SV has a true value by Perl's rules.
7363 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7364 instead use an in-line version.
7370 Perl_sv_true(pTHX_ register SV *sv)
7375 register const XPV* const tXpv = (XPV*)SvANY(sv);
7377 (tXpv->xpv_cur > 1 ||
7378 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7385 return SvIVX(sv) != 0;
7388 return SvNVX(sv) != 0.0;
7390 return sv_2bool(sv);
7396 =for apidoc sv_pvn_force
7398 Get a sensible string out of the SV somehow.
7399 A private implementation of the C<SvPV_force> macro for compilers which
7400 can't cope with complex macro expressions. Always use the macro instead.
7402 =for apidoc sv_pvn_force_flags
7404 Get a sensible string out of the SV somehow.
7405 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7406 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7407 implemented in terms of this function.
7408 You normally want to use the various wrapper macros instead: see
7409 C<SvPV_force> and C<SvPV_force_nomg>
7415 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7418 if (SvTHINKFIRST(sv) && !SvROK(sv))
7419 sv_force_normal_flags(sv, 0);
7429 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7430 const char * const ref = sv_reftype(sv,0);
7432 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7433 ref, OP_NAME(PL_op));
7435 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7437 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7438 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7440 s = sv_2pv_flags(sv, &len, flags);
7444 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7447 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7448 SvGROW(sv, len + 1);
7449 Move(s,SvPVX(sv),len,char);
7454 SvPOK_on(sv); /* validate pointer */
7456 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7457 PTR2UV(sv),SvPVX_const(sv)));
7460 return SvPVX_mutable(sv);
7464 =for apidoc sv_pvbyten_force
7466 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7472 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7474 sv_pvn_force(sv,lp);
7475 sv_utf8_downgrade(sv,0);
7481 =for apidoc sv_pvutf8n_force
7483 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7489 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7491 sv_pvn_force(sv,lp);
7492 sv_utf8_upgrade(sv);
7498 =for apidoc sv_reftype
7500 Returns a string describing what the SV is a reference to.
7506 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7508 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7509 inside return suggests a const propagation bug in g++. */
7510 if (ob && SvOBJECT(sv)) {
7511 char * const name = HvNAME_get(SvSTASH(sv));
7512 return name ? name : (char *) "__ANON__";
7515 switch (SvTYPE(sv)) {
7532 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7533 /* tied lvalues should appear to be
7534 * scalars for backwards compatitbility */
7535 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7536 ? "SCALAR" : "LVALUE");
7537 case SVt_PVAV: return "ARRAY";
7538 case SVt_PVHV: return "HASH";
7539 case SVt_PVCV: return "CODE";
7540 case SVt_PVGV: return "GLOB";
7541 case SVt_PVFM: return "FORMAT";
7542 case SVt_PVIO: return "IO";
7543 default: return "UNKNOWN";
7549 =for apidoc sv_isobject
7551 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7552 object. If the SV is not an RV, or if the object is not blessed, then this
7559 Perl_sv_isobject(pTHX_ SV *sv)
7575 Returns a boolean indicating whether the SV is blessed into the specified
7576 class. This does not check for subtypes; use C<sv_derived_from> to verify
7577 an inheritance relationship.
7583 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7594 hvname = HvNAME_get(SvSTASH(sv));
7598 return strEQ(hvname, name);
7604 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7605 it will be upgraded to one. If C<classname> is non-null then the new SV will
7606 be blessed in the specified package. The new SV is returned and its
7607 reference count is 1.
7613 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7620 SV_CHECK_THINKFIRST_COW_DROP(rv);
7623 if (SvTYPE(rv) >= SVt_PVMG) {
7624 const U32 refcnt = SvREFCNT(rv);
7628 SvREFCNT(rv) = refcnt;
7631 if (SvTYPE(rv) < SVt_RV)
7632 sv_upgrade(rv, SVt_RV);
7633 else if (SvTYPE(rv) > SVt_RV) {
7644 HV* const stash = gv_stashpv(classname, TRUE);
7645 (void)sv_bless(rv, stash);
7651 =for apidoc sv_setref_pv
7653 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7654 argument will be upgraded to an RV. That RV will be modified to point to
7655 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7656 into the SV. The C<classname> argument indicates the package for the
7657 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7658 will have a reference count of 1, and the RV will be returned.
7660 Do not use with other Perl types such as HV, AV, SV, CV, because those
7661 objects will become corrupted by the pointer copy process.
7663 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7669 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7673 sv_setsv(rv, &PL_sv_undef);
7677 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7682 =for apidoc sv_setref_iv
7684 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7685 argument will be upgraded to an RV. That RV will be modified to point to
7686 the new SV. The C<classname> argument indicates the package for the
7687 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7688 will have a reference count of 1, and the RV will be returned.
7694 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7696 sv_setiv(newSVrv(rv,classname), iv);
7701 =for apidoc sv_setref_uv
7703 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7704 argument will be upgraded to an RV. That RV will be modified to point to
7705 the new SV. The C<classname> argument indicates the package for the
7706 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7707 will have a reference count of 1, and the RV will be returned.
7713 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7715 sv_setuv(newSVrv(rv,classname), uv);
7720 =for apidoc sv_setref_nv
7722 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7723 argument will be upgraded to an RV. That RV will be modified to point to
7724 the new SV. The C<classname> argument indicates the package for the
7725 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7726 will have a reference count of 1, and the RV will be returned.
7732 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7734 sv_setnv(newSVrv(rv,classname), nv);
7739 =for apidoc sv_setref_pvn
7741 Copies a string into a new SV, optionally blessing the SV. The length of the
7742 string must be specified with C<n>. The C<rv> argument will be upgraded to
7743 an RV. That RV will be modified to point to the new SV. The C<classname>
7744 argument indicates the package for the blessing. Set C<classname> to
7745 C<NULL> to avoid the blessing. The new SV will have a reference count
7746 of 1, and the RV will be returned.
7748 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7754 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7756 sv_setpvn(newSVrv(rv,classname), pv, n);
7761 =for apidoc sv_bless
7763 Blesses an SV into a specified package. The SV must be an RV. The package
7764 must be designated by its stash (see C<gv_stashpv()>). The reference count
7765 of the SV is unaffected.
7771 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7776 Perl_croak(aTHX_ "Can't bless non-reference value");
7778 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7779 if (SvREADONLY(tmpRef))
7780 Perl_croak(aTHX_ PL_no_modify);
7781 if (SvOBJECT(tmpRef)) {
7782 if (SvTYPE(tmpRef) != SVt_PVIO)
7784 SvREFCNT_dec(SvSTASH(tmpRef));
7787 SvOBJECT_on(tmpRef);
7788 if (SvTYPE(tmpRef) != SVt_PVIO)
7790 SvUPGRADE(tmpRef, SVt_PVMG);
7791 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7798 if(SvSMAGICAL(tmpRef))
7799 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7807 /* Downgrades a PVGV to a PVMG.
7811 S_sv_unglob(pTHX_ SV *sv)
7815 SV * const temp = sv_newmortal();
7817 assert(SvTYPE(sv) == SVt_PVGV);
7819 gv_efullname3(temp, (GV *) sv, "*");
7825 sv_del_backref((SV*)GvSTASH(sv), sv);
7829 if (GvNAME_HEK(sv)) {
7830 unshare_hek(GvNAME_HEK(sv));
7834 /* need to keep SvANY(sv) in the right arena */
7835 xpvmg = new_XPVMG();
7836 StructCopy(SvANY(sv), xpvmg, XPVMG);
7837 del_XPVGV(SvANY(sv));
7840 SvFLAGS(sv) &= ~SVTYPEMASK;
7841 SvFLAGS(sv) |= SVt_PVMG;
7843 /* Intentionally not calling any local SET magic, as this isn't so much a
7844 set operation as merely an internal storage change. */
7845 sv_setsv_flags(sv, temp, 0);
7849 =for apidoc sv_unref_flags
7851 Unsets the RV status of the SV, and decrements the reference count of
7852 whatever was being referenced by the RV. This can almost be thought of
7853 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7854 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7855 (otherwise the decrementing is conditional on the reference count being
7856 different from one or the reference being a readonly SV).
7863 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7865 SV* const target = SvRV(ref);
7867 if (SvWEAKREF(ref)) {
7868 sv_del_backref(target, ref);
7870 SvRV_set(ref, NULL);
7873 SvRV_set(ref, NULL);
7875 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7876 assigned to as BEGIN {$a = \"Foo"} will fail. */
7877 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7878 SvREFCNT_dec(target);
7879 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7880 sv_2mortal(target); /* Schedule for freeing later */
7884 =for apidoc sv_untaint
7886 Untaint an SV. Use C<SvTAINTED_off> instead.
7891 Perl_sv_untaint(pTHX_ SV *sv)
7893 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7894 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7901 =for apidoc sv_tainted
7903 Test an SV for taintedness. Use C<SvTAINTED> instead.
7908 Perl_sv_tainted(pTHX_ SV *sv)
7910 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7911 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7912 if (mg && (mg->mg_len & 1) )
7919 =for apidoc sv_setpviv
7921 Copies an integer into the given SV, also updating its string value.
7922 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7928 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7930 char buf[TYPE_CHARS(UV)];
7932 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7934 sv_setpvn(sv, ptr, ebuf - ptr);
7938 =for apidoc sv_setpviv_mg
7940 Like C<sv_setpviv>, but also handles 'set' magic.
7946 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7952 #if defined(PERL_IMPLICIT_CONTEXT)
7954 /* pTHX_ magic can't cope with varargs, so this is a no-context
7955 * version of the main function, (which may itself be aliased to us).
7956 * Don't access this version directly.
7960 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7964 va_start(args, pat);
7965 sv_vsetpvf(sv, pat, &args);
7969 /* pTHX_ magic can't cope with varargs, so this is a no-context
7970 * version of the main function, (which may itself be aliased to us).
7971 * Don't access this version directly.
7975 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7979 va_start(args, pat);
7980 sv_vsetpvf_mg(sv, pat, &args);
7986 =for apidoc sv_setpvf
7988 Works like C<sv_catpvf> but copies the text into the SV instead of
7989 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7995 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7998 va_start(args, pat);
7999 sv_vsetpvf(sv, pat, &args);
8004 =for apidoc sv_vsetpvf
8006 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8007 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8009 Usually used via its frontend C<sv_setpvf>.
8015 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8017 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8021 =for apidoc sv_setpvf_mg
8023 Like C<sv_setpvf>, but also handles 'set' magic.
8029 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8032 va_start(args, pat);
8033 sv_vsetpvf_mg(sv, pat, &args);
8038 =for apidoc sv_vsetpvf_mg
8040 Like C<sv_vsetpvf>, but also handles 'set' magic.
8042 Usually used via its frontend C<sv_setpvf_mg>.
8048 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8050 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8054 #if defined(PERL_IMPLICIT_CONTEXT)
8056 /* pTHX_ magic can't cope with varargs, so this is a no-context
8057 * version of the main function, (which may itself be aliased to us).
8058 * Don't access this version directly.
8062 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8066 va_start(args, pat);
8067 sv_vcatpvf(sv, pat, &args);
8071 /* pTHX_ magic can't cope with varargs, so this is a no-context
8072 * version of the main function, (which may itself be aliased to us).
8073 * Don't access this version directly.
8077 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8081 va_start(args, pat);
8082 sv_vcatpvf_mg(sv, pat, &args);
8088 =for apidoc sv_catpvf
8090 Processes its arguments like C<sprintf> and appends the formatted
8091 output to an SV. If the appended data contains "wide" characters
8092 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8093 and characters >255 formatted with %c), the original SV might get
8094 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8095 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8096 valid UTF-8; if the original SV was bytes, the pattern should be too.
8101 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8104 va_start(args, pat);
8105 sv_vcatpvf(sv, pat, &args);
8110 =for apidoc sv_vcatpvf
8112 Processes its arguments like C<vsprintf> and appends the formatted output
8113 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8115 Usually used via its frontend C<sv_catpvf>.
8121 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8123 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8127 =for apidoc sv_catpvf_mg
8129 Like C<sv_catpvf>, but also handles 'set' magic.
8135 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8138 va_start(args, pat);
8139 sv_vcatpvf_mg(sv, pat, &args);
8144 =for apidoc sv_vcatpvf_mg
8146 Like C<sv_vcatpvf>, but also handles 'set' magic.
8148 Usually used via its frontend C<sv_catpvf_mg>.
8154 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8156 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8161 =for apidoc sv_vsetpvfn
8163 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8166 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8172 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8174 sv_setpvn(sv, "", 0);
8175 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8179 S_expect_number(pTHX_ char** pattern)
8183 switch (**pattern) {
8184 case '1': case '2': case '3':
8185 case '4': case '5': case '6':
8186 case '7': case '8': case '9':
8187 var = *(*pattern)++ - '0';
8188 while (isDIGIT(**pattern)) {
8189 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8191 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8199 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8201 const int neg = nv < 0;
8210 if (uv & 1 && uv == nv)
8211 uv--; /* Round to even */
8213 const unsigned dig = uv % 10;
8226 =for apidoc sv_vcatpvfn
8228 Processes its arguments like C<vsprintf> and appends the formatted output
8229 to an SV. Uses an array of SVs if the C style variable argument list is
8230 missing (NULL). When running with taint checks enabled, indicates via
8231 C<maybe_tainted> if results are untrustworthy (often due to the use of
8234 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8240 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8241 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8242 vec_utf8 = DO_UTF8(vecsv);
8244 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8247 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8255 static const char nullstr[] = "(null)";
8257 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8258 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8260 /* Times 4: a decimal digit takes more than 3 binary digits.
8261 * NV_DIG: mantissa takes than many decimal digits.
8262 * Plus 32: Playing safe. */
8263 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8264 /* large enough for "%#.#f" --chip */
8265 /* what about long double NVs? --jhi */
8267 PERL_UNUSED_ARG(maybe_tainted);
8269 /* no matter what, this is a string now */
8270 (void)SvPV_force(sv, origlen);
8272 /* special-case "", "%s", and "%-p" (SVf - see below) */
8275 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8277 const char * const s = va_arg(*args, char*);
8278 sv_catpv(sv, s ? s : nullstr);
8280 else if (svix < svmax) {
8281 sv_catsv(sv, *svargs);
8285 if (args && patlen == 3 && pat[0] == '%' &&
8286 pat[1] == '-' && pat[2] == 'p') {
8287 argsv = va_arg(*args, SV*);
8288 sv_catsv(sv, argsv);
8292 #ifndef USE_LONG_DOUBLE
8293 /* special-case "%.<number>[gf]" */
8294 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8295 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8296 unsigned digits = 0;
8300 while (*pp >= '0' && *pp <= '9')
8301 digits = 10 * digits + (*pp++ - '0');
8302 if (pp - pat == (int)patlen - 1) {
8310 /* Add check for digits != 0 because it seems that some
8311 gconverts are buggy in this case, and we don't yet have
8312 a Configure test for this. */
8313 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8314 /* 0, point, slack */
8315 Gconvert(nv, (int)digits, 0, ebuf);
8317 if (*ebuf) /* May return an empty string for digits==0 */
8320 } else if (!digits) {
8323 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8324 sv_catpvn(sv, p, l);
8330 #endif /* !USE_LONG_DOUBLE */
8332 if (!args && svix < svmax && DO_UTF8(*svargs))
8335 patend = (char*)pat + patlen;
8336 for (p = (char*)pat; p < patend; p = q) {
8339 bool vectorize = FALSE;
8340 bool vectorarg = FALSE;
8341 bool vec_utf8 = FALSE;
8347 bool has_precis = FALSE;
8349 const I32 osvix = svix;
8350 bool is_utf8 = FALSE; /* is this item utf8? */
8351 #ifdef HAS_LDBL_SPRINTF_BUG
8352 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8353 with sfio - Allen <allens@cpan.org> */
8354 bool fix_ldbl_sprintf_bug = FALSE;
8358 U8 utf8buf[UTF8_MAXBYTES+1];
8359 STRLEN esignlen = 0;
8361 const char *eptr = NULL;
8364 const U8 *vecstr = NULL;
8371 /* we need a long double target in case HAS_LONG_DOUBLE but
8374 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8382 const char *dotstr = ".";
8383 STRLEN dotstrlen = 1;
8384 I32 efix = 0; /* explicit format parameter index */
8385 I32 ewix = 0; /* explicit width index */
8386 I32 epix = 0; /* explicit precision index */
8387 I32 evix = 0; /* explicit vector index */
8388 bool asterisk = FALSE;
8390 /* echo everything up to the next format specification */
8391 for (q = p; q < patend && *q != '%'; ++q) ;
8393 if (has_utf8 && !pat_utf8)
8394 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8396 sv_catpvn(sv, p, q - p);
8403 We allow format specification elements in this order:
8404 \d+\$ explicit format parameter index
8406 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8407 0 flag (as above): repeated to allow "v02"
8408 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8409 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8411 [%bcdefginopsuxDFOUX] format (mandatory)
8416 As of perl5.9.3, printf format checking is on by default.
8417 Internally, perl uses %p formats to provide an escape to
8418 some extended formatting. This block deals with those
8419 extensions: if it does not match, (char*)q is reset and
8420 the normal format processing code is used.
8422 Currently defined extensions are:
8423 %p include pointer address (standard)
8424 %-p (SVf) include an SV (previously %_)
8425 %-<num>p include an SV with precision <num>
8426 %1p (VDf) include a v-string (as %vd)
8427 %<num>p reserved for future extensions
8429 Robin Barker 2005-07-14
8436 n = expect_number(&q);
8443 argsv = va_arg(*args, SV*);
8444 eptr = SvPVx_const(argsv, elen);
8450 else if (n == vdNUMBER) { /* VDf */
8457 if (ckWARN_d(WARN_INTERNAL))
8458 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8459 "internal %%<num>p might conflict with future printf extensions");
8465 if ( (width = expect_number(&q)) ) {
8506 if ( (ewix = expect_number(&q)) )
8515 if ((vectorarg = asterisk)) {
8528 width = expect_number(&q);
8534 vecsv = va_arg(*args, SV*);
8536 vecsv = (evix > 0 && evix <= svmax)
8537 ? svargs[evix-1] : &PL_sv_undef;
8539 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8541 dotstr = SvPV_const(vecsv, dotstrlen);
8542 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8543 bad with tied or overloaded values that return UTF8. */
8546 else if (has_utf8) {
8547 vecsv = sv_mortalcopy(vecsv);
8548 sv_utf8_upgrade(vecsv);
8549 dotstr = SvPV_const(vecsv, dotstrlen);
8556 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8557 vecsv = svargs[efix ? efix-1 : svix++];
8558 vecstr = (U8*)SvPV_const(vecsv,veclen);
8559 vec_utf8 = DO_UTF8(vecsv);
8561 /* if this is a version object, we need to convert
8562 * back into v-string notation and then let the
8563 * vectorize happen normally
8565 if (sv_derived_from(vecsv, "version")) {
8566 char *version = savesvpv(vecsv);
8567 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8568 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8569 "vector argument not supported with alpha versions");
8572 vecsv = sv_newmortal();
8573 /* scan_vstring is expected to be called during
8574 * tokenization, so we need to fake up the end
8575 * of the buffer for it
8577 PL_bufend = version + veclen;
8578 scan_vstring(version, vecsv);
8579 vecstr = (U8*)SvPV_const(vecsv, veclen);
8580 vec_utf8 = DO_UTF8(vecsv);
8592 i = va_arg(*args, int);
8594 i = (ewix ? ewix <= svmax : svix < svmax) ?
8595 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8597 width = (i < 0) ? -i : i;
8607 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8609 /* XXX: todo, support specified precision parameter */
8613 i = va_arg(*args, int);
8615 i = (ewix ? ewix <= svmax : svix < svmax)
8616 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8617 precis = (i < 0) ? 0 : i;
8622 precis = precis * 10 + (*q++ - '0');
8631 case 'I': /* Ix, I32x, and I64x */
8633 if (q[1] == '6' && q[2] == '4') {
8639 if (q[1] == '3' && q[2] == '2') {
8649 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8660 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8661 if (*(q + 1) == 'l') { /* lld, llf */
8687 if (!vectorize && !args) {
8689 const I32 i = efix-1;
8690 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8692 argsv = (svix >= 0 && svix < svmax)
8693 ? svargs[svix++] : &PL_sv_undef;
8704 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8706 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8708 eptr = (char*)utf8buf;
8709 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8723 eptr = va_arg(*args, char*);
8725 #ifdef MACOS_TRADITIONAL
8726 /* On MacOS, %#s format is used for Pascal strings */
8731 elen = strlen(eptr);
8733 eptr = (char *)nullstr;
8734 elen = sizeof nullstr - 1;
8738 eptr = SvPVx_const(argsv, elen);
8739 if (DO_UTF8(argsv)) {
8740 if (has_precis && precis < elen) {
8742 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8745 if (width) { /* fudge width (can't fudge elen) */
8746 width += elen - sv_len_utf8(argsv);
8753 if (has_precis && elen > precis)
8760 if (alt || vectorize)
8762 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8783 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8792 esignbuf[esignlen++] = plus;
8796 case 'h': iv = (short)va_arg(*args, int); break;
8797 case 'l': iv = va_arg(*args, long); break;
8798 case 'V': iv = va_arg(*args, IV); break;
8799 default: iv = va_arg(*args, int); break;
8801 case 'q': iv = va_arg(*args, Quad_t); break;
8806 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8808 case 'h': iv = (short)tiv; break;
8809 case 'l': iv = (long)tiv; break;
8811 default: iv = tiv; break;
8813 case 'q': iv = (Quad_t)tiv; break;
8817 if ( !vectorize ) /* we already set uv above */
8822 esignbuf[esignlen++] = plus;
8826 esignbuf[esignlen++] = '-';
8869 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8880 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8881 case 'l': uv = va_arg(*args, unsigned long); break;
8882 case 'V': uv = va_arg(*args, UV); break;
8883 default: uv = va_arg(*args, unsigned); break;
8885 case 'q': uv = va_arg(*args, Uquad_t); break;
8890 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8892 case 'h': uv = (unsigned short)tuv; break;
8893 case 'l': uv = (unsigned long)tuv; break;
8895 default: uv = tuv; break;
8897 case 'q': uv = (Uquad_t)tuv; break;
8904 char *ptr = ebuf + sizeof ebuf;
8910 p = (char*)((c == 'X')
8911 ? "0123456789ABCDEF" : "0123456789abcdef");
8917 esignbuf[esignlen++] = '0';
8918 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8926 if (alt && *ptr != '0')
8937 esignbuf[esignlen++] = '0';
8938 esignbuf[esignlen++] = 'b';
8941 default: /* it had better be ten or less */
8945 } while (uv /= base);
8948 elen = (ebuf + sizeof ebuf) - ptr;
8952 zeros = precis - elen;
8953 else if (precis == 0 && elen == 1 && *eptr == '0')
8959 /* FLOATING POINT */
8962 c = 'f'; /* maybe %F isn't supported here */
8970 /* This is evil, but floating point is even more evil */
8972 /* for SV-style calling, we can only get NV
8973 for C-style calling, we assume %f is double;
8974 for simplicity we allow any of %Lf, %llf, %qf for long double
8978 #if defined(USE_LONG_DOUBLE)
8982 /* [perl #20339] - we should accept and ignore %lf rather than die */
8986 #if defined(USE_LONG_DOUBLE)
8987 intsize = args ? 0 : 'q';
8991 #if defined(HAS_LONG_DOUBLE)
9000 /* now we need (long double) if intsize == 'q', else (double) */
9002 #if LONG_DOUBLESIZE > DOUBLESIZE
9004 va_arg(*args, long double) :
9005 va_arg(*args, double)
9007 va_arg(*args, double)
9012 if (c != 'e' && c != 'E') {
9014 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9015 will cast our (long double) to (double) */
9016 (void)Perl_frexp(nv, &i);
9017 if (i == PERL_INT_MIN)
9018 Perl_die(aTHX_ "panic: frexp");
9020 need = BIT_DIGITS(i);
9022 need += has_precis ? precis : 6; /* known default */
9027 #ifdef HAS_LDBL_SPRINTF_BUG
9028 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9029 with sfio - Allen <allens@cpan.org> */
9032 # define MY_DBL_MAX DBL_MAX
9033 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9034 # if DOUBLESIZE >= 8
9035 # define MY_DBL_MAX 1.7976931348623157E+308L
9037 # define MY_DBL_MAX 3.40282347E+38L
9041 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9042 # define MY_DBL_MAX_BUG 1L
9044 # define MY_DBL_MAX_BUG MY_DBL_MAX
9048 # define MY_DBL_MIN DBL_MIN
9049 # else /* XXX guessing! -Allen */
9050 # if DOUBLESIZE >= 8
9051 # define MY_DBL_MIN 2.2250738585072014E-308L
9053 # define MY_DBL_MIN 1.17549435E-38L
9057 if ((intsize == 'q') && (c == 'f') &&
9058 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9060 /* it's going to be short enough that
9061 * long double precision is not needed */
9063 if ((nv <= 0L) && (nv >= -0L))
9064 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9066 /* would use Perl_fp_class as a double-check but not
9067 * functional on IRIX - see perl.h comments */
9069 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9070 /* It's within the range that a double can represent */
9071 #if defined(DBL_MAX) && !defined(DBL_MIN)
9072 if ((nv >= ((long double)1/DBL_MAX)) ||
9073 (nv <= (-(long double)1/DBL_MAX)))
9075 fix_ldbl_sprintf_bug = TRUE;
9078 if (fix_ldbl_sprintf_bug == TRUE) {
9088 # undef MY_DBL_MAX_BUG
9091 #endif /* HAS_LDBL_SPRINTF_BUG */
9093 need += 20; /* fudge factor */
9094 if (PL_efloatsize < need) {
9095 Safefree(PL_efloatbuf);
9096 PL_efloatsize = need + 20; /* more fudge */
9097 Newx(PL_efloatbuf, PL_efloatsize, char);
9098 PL_efloatbuf[0] = '\0';
9101 if ( !(width || left || plus || alt) && fill != '0'
9102 && has_precis && intsize != 'q' ) { /* Shortcuts */
9103 /* See earlier comment about buggy Gconvert when digits,
9105 if ( c == 'g' && precis) {
9106 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9107 /* May return an empty string for digits==0 */
9108 if (*PL_efloatbuf) {
9109 elen = strlen(PL_efloatbuf);
9110 goto float_converted;
9112 } else if ( c == 'f' && !precis) {
9113 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9118 char *ptr = ebuf + sizeof ebuf;
9121 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9122 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9123 if (intsize == 'q') {
9124 /* Copy the one or more characters in a long double
9125 * format before the 'base' ([efgEFG]) character to
9126 * the format string. */
9127 static char const prifldbl[] = PERL_PRIfldbl;
9128 char const *p = prifldbl + sizeof(prifldbl) - 3;
9129 while (p >= prifldbl) { *--ptr = *p--; }
9134 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9139 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9151 /* No taint. Otherwise we are in the strange situation
9152 * where printf() taints but print($float) doesn't.
9154 #if defined(HAS_LONG_DOUBLE)
9155 elen = ((intsize == 'q')
9156 ? my_sprintf(PL_efloatbuf, ptr, nv)
9157 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9159 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9163 eptr = PL_efloatbuf;
9171 i = SvCUR(sv) - origlen;
9174 case 'h': *(va_arg(*args, short*)) = i; break;
9175 default: *(va_arg(*args, int*)) = i; break;
9176 case 'l': *(va_arg(*args, long*)) = i; break;
9177 case 'V': *(va_arg(*args, IV*)) = i; break;
9179 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9184 sv_setuv_mg(argsv, (UV)i);
9185 continue; /* not "break" */
9192 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9193 && ckWARN(WARN_PRINTF))
9195 SV * const msg = sv_newmortal();
9196 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9197 (PL_op->op_type == OP_PRTF) ? "" : "s");
9200 Perl_sv_catpvf(aTHX_ msg,
9201 "\"%%%c\"", c & 0xFF);
9203 Perl_sv_catpvf(aTHX_ msg,
9204 "\"%%\\%03"UVof"\"",
9207 sv_catpvs(msg, "end of string");
9208 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9211 /* output mangled stuff ... */
9217 /* ... right here, because formatting flags should not apply */
9218 SvGROW(sv, SvCUR(sv) + elen + 1);
9220 Copy(eptr, p, elen, char);
9223 SvCUR_set(sv, p - SvPVX_const(sv));
9225 continue; /* not "break" */
9228 /* calculate width before utf8_upgrade changes it */
9229 have = esignlen + zeros + elen;
9231 Perl_croak_nocontext(PL_memory_wrap);
9233 if (is_utf8 != has_utf8) {
9236 sv_utf8_upgrade(sv);
9239 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9240 sv_utf8_upgrade(nsv);
9241 eptr = SvPVX_const(nsv);
9244 SvGROW(sv, SvCUR(sv) + elen + 1);
9249 need = (have > width ? have : width);
9252 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9253 Perl_croak_nocontext(PL_memory_wrap);
9254 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9256 if (esignlen && fill == '0') {
9258 for (i = 0; i < (int)esignlen; i++)
9262 memset(p, fill, gap);
9265 if (esignlen && fill != '0') {
9267 for (i = 0; i < (int)esignlen; i++)
9272 for (i = zeros; i; i--)
9276 Copy(eptr, p, elen, char);
9280 memset(p, ' ', gap);
9285 Copy(dotstr, p, dotstrlen, char);
9289 vectorize = FALSE; /* done iterating over vecstr */
9296 SvCUR_set(sv, p - SvPVX_const(sv));
9304 /* =========================================================================
9306 =head1 Cloning an interpreter
9308 All the macros and functions in this section are for the private use of
9309 the main function, perl_clone().
9311 The foo_dup() functions make an exact copy of an existing foo thinngy.
9312 During the course of a cloning, a hash table is used to map old addresses
9313 to new addresses. The table is created and manipulated with the
9314 ptr_table_* functions.
9318 ============================================================================*/
9321 #if defined(USE_ITHREADS)
9323 #ifndef GpREFCNT_inc
9324 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9328 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9329 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9330 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9331 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9332 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9333 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9334 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9335 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9336 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9337 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9338 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9339 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9340 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9341 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9344 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9345 regcomp.c. AMS 20010712 */
9348 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9353 struct reg_substr_datum *s;
9356 return (REGEXP *)NULL;
9358 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9361 len = r->offsets[0];
9362 npar = r->nparens+1;
9364 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9365 Copy(r->program, ret->program, len+1, regnode);
9367 Newx(ret->startp, npar, I32);
9368 Copy(r->startp, ret->startp, npar, I32);
9369 Newx(ret->endp, npar, I32);
9370 Copy(r->startp, ret->startp, npar, I32);
9372 Newx(ret->substrs, 1, struct reg_substr_data);
9373 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9374 s->min_offset = r->substrs->data[i].min_offset;
9375 s->max_offset = r->substrs->data[i].max_offset;
9376 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9377 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9380 ret->regstclass = NULL;
9383 const int count = r->data->count;
9386 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9387 char, struct reg_data);
9388 Newx(d->what, count, U8);
9391 for (i = 0; i < count; i++) {
9392 d->what[i] = r->data->what[i];
9393 switch (d->what[i]) {
9394 /* legal options are one of: sfpont
9395 see also regcomp.h and pregfree() */
9397 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9400 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9403 /* This is cheating. */
9404 Newx(d->data[i], 1, struct regnode_charclass_class);
9405 StructCopy(r->data->data[i], d->data[i],
9406 struct regnode_charclass_class);
9407 ret->regstclass = (regnode*)d->data[i];
9410 /* Compiled op trees are readonly, and can thus be
9411 shared without duplication. */
9413 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9417 d->data[i] = r->data->data[i];
9420 d->data[i] = r->data->data[i];
9422 ((reg_trie_data*)d->data[i])->refcount++;
9426 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9435 Newx(ret->offsets, 2*len+1, U32);
9436 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9438 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9439 ret->refcnt = r->refcnt;
9440 ret->minlen = r->minlen;
9441 ret->prelen = r->prelen;
9442 ret->nparens = r->nparens;
9443 ret->lastparen = r->lastparen;
9444 ret->lastcloseparen = r->lastcloseparen;
9445 ret->reganch = r->reganch;
9447 ret->sublen = r->sublen;
9449 if (RX_MATCH_COPIED(ret))
9450 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9453 #ifdef PERL_OLD_COPY_ON_WRITE
9454 ret->saved_copy = NULL;
9457 ptr_table_store(PL_ptr_table, r, ret);
9461 /* duplicate a file handle */
9464 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9468 PERL_UNUSED_ARG(type);
9471 return (PerlIO*)NULL;
9473 /* look for it in the table first */
9474 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9478 /* create anew and remember what it is */
9479 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9480 ptr_table_store(PL_ptr_table, fp, ret);
9484 /* duplicate a directory handle */
9487 Perl_dirp_dup(pTHX_ DIR *dp)
9489 PERL_UNUSED_CONTEXT;
9496 /* duplicate a typeglob */
9499 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9505 /* look for it in the table first */
9506 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9510 /* create anew and remember what it is */
9512 ptr_table_store(PL_ptr_table, gp, ret);
9515 ret->gp_refcnt = 0; /* must be before any other dups! */
9516 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9517 ret->gp_io = io_dup_inc(gp->gp_io, param);
9518 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9519 ret->gp_av = av_dup_inc(gp->gp_av, param);
9520 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9521 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9522 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9523 ret->gp_cvgen = gp->gp_cvgen;
9524 ret->gp_line = gp->gp_line;
9525 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9529 /* duplicate a chain of magic */
9532 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9534 MAGIC *mgprev = (MAGIC*)NULL;
9537 return (MAGIC*)NULL;
9538 /* look for it in the table first */
9539 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9543 for (; mg; mg = mg->mg_moremagic) {
9545 Newxz(nmg, 1, MAGIC);
9547 mgprev->mg_moremagic = nmg;
9550 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9551 nmg->mg_private = mg->mg_private;
9552 nmg->mg_type = mg->mg_type;
9553 nmg->mg_flags = mg->mg_flags;
9554 if (mg->mg_type == PERL_MAGIC_qr) {
9555 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9557 else if(mg->mg_type == PERL_MAGIC_backref) {
9558 /* The backref AV has its reference count deliberately bumped by
9560 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9562 else if (mg->mg_type == PERL_MAGIC_symtab) {
9563 nmg->mg_obj = mg->mg_obj;
9566 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9567 ? sv_dup_inc(mg->mg_obj, param)
9568 : sv_dup(mg->mg_obj, param);
9570 nmg->mg_len = mg->mg_len;
9571 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9572 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9573 if (mg->mg_len > 0) {
9574 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9575 if (mg->mg_type == PERL_MAGIC_overload_table &&
9576 AMT_AMAGIC((AMT*)mg->mg_ptr))
9578 const AMT * const amtp = (AMT*)mg->mg_ptr;
9579 AMT * const namtp = (AMT*)nmg->mg_ptr;
9581 for (i = 1; i < NofAMmeth; i++) {
9582 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9586 else if (mg->mg_len == HEf_SVKEY)
9587 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9589 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9590 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9597 /* create a new pointer-mapping table */
9600 Perl_ptr_table_new(pTHX)
9603 PERL_UNUSED_CONTEXT;
9605 Newxz(tbl, 1, PTR_TBL_t);
9608 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9612 #define PTR_TABLE_HASH(ptr) \
9613 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9616 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9617 following define) and at call to new_body_inline made below in
9618 Perl_ptr_table_store()
9621 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9623 /* map an existing pointer using a table */
9625 STATIC PTR_TBL_ENT_t *
9626 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9627 PTR_TBL_ENT_t *tblent;
9628 const UV hash = PTR_TABLE_HASH(sv);
9630 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9631 for (; tblent; tblent = tblent->next) {
9632 if (tblent->oldval == sv)
9639 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9641 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9642 PERL_UNUSED_CONTEXT;
9643 return tblent ? tblent->newval : (void *) 0;
9646 /* add a new entry to a pointer-mapping table */
9649 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9651 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9652 PERL_UNUSED_CONTEXT;
9655 tblent->newval = newsv;
9657 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9659 new_body_inline(tblent, PTE_SVSLOT);
9661 tblent->oldval = oldsv;
9662 tblent->newval = newsv;
9663 tblent->next = tbl->tbl_ary[entry];
9664 tbl->tbl_ary[entry] = tblent;
9666 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9667 ptr_table_split(tbl);
9671 /* double the hash bucket size of an existing ptr table */
9674 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9676 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9677 const UV oldsize = tbl->tbl_max + 1;
9678 UV newsize = oldsize * 2;
9680 PERL_UNUSED_CONTEXT;
9682 Renew(ary, newsize, PTR_TBL_ENT_t*);
9683 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9684 tbl->tbl_max = --newsize;
9686 for (i=0; i < oldsize; i++, ary++) {
9687 PTR_TBL_ENT_t **curentp, **entp, *ent;
9690 curentp = ary + oldsize;
9691 for (entp = ary, ent = *ary; ent; ent = *entp) {
9692 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9694 ent->next = *curentp;
9704 /* remove all the entries from a ptr table */
9707 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9709 if (tbl && tbl->tbl_items) {
9710 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9711 UV riter = tbl->tbl_max;
9714 PTR_TBL_ENT_t *entry = array[riter];
9717 PTR_TBL_ENT_t * const oentry = entry;
9718 entry = entry->next;
9727 /* clear and free a ptr table */
9730 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9735 ptr_table_clear(tbl);
9736 Safefree(tbl->tbl_ary);
9742 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9745 SvRV_set(dstr, SvWEAKREF(sstr)
9746 ? sv_dup(SvRV(sstr), param)
9747 : sv_dup_inc(SvRV(sstr), param));
9750 else if (SvPVX_const(sstr)) {
9751 /* Has something there */
9753 /* Normal PV - clone whole allocated space */
9754 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9755 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9756 /* Not that normal - actually sstr is copy on write.
9757 But we are a true, independant SV, so: */
9758 SvREADONLY_off(dstr);
9763 /* Special case - not normally malloced for some reason */
9764 if (isGV_with_GP(sstr)) {
9765 /* Don't need to do anything here. */
9767 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9768 /* A "shared" PV - clone it as "shared" PV */
9770 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9774 /* Some other special case - random pointer */
9775 SvPV_set(dstr, SvPVX(sstr));
9781 if (SvTYPE(dstr) == SVt_RV)
9782 SvRV_set(dstr, NULL);
9784 SvPV_set(dstr, NULL);
9788 /* duplicate an SV of any type (including AV, HV etc) */
9791 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9796 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9798 /* look for it in the table first */
9799 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9803 if(param->flags & CLONEf_JOIN_IN) {
9804 /** We are joining here so we don't want do clone
9805 something that is bad **/
9806 if (SvTYPE(sstr) == SVt_PVHV) {
9807 const char * const hvname = HvNAME_get(sstr);
9809 /** don't clone stashes if they already exist **/
9810 return (SV*)gv_stashpv(hvname,0);
9814 /* create anew and remember what it is */
9817 #ifdef DEBUG_LEAKING_SCALARS
9818 dstr->sv_debug_optype = sstr->sv_debug_optype;
9819 dstr->sv_debug_line = sstr->sv_debug_line;
9820 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9821 dstr->sv_debug_cloned = 1;
9822 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9825 ptr_table_store(PL_ptr_table, sstr, dstr);
9828 SvFLAGS(dstr) = SvFLAGS(sstr);
9829 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9830 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9833 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9834 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9835 PL_watch_pvx, SvPVX_const(sstr));
9838 /* don't clone objects whose class has asked us not to */
9839 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9840 SvFLAGS(dstr) &= ~SVTYPEMASK;
9845 switch (SvTYPE(sstr)) {
9850 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9851 SvIV_set(dstr, SvIVX(sstr));
9854 SvANY(dstr) = new_XNV();
9855 SvNV_set(dstr, SvNVX(sstr));
9858 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9859 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9863 /* These are all the types that need complex bodies allocating. */
9865 const svtype sv_type = SvTYPE(sstr);
9866 const struct body_details *const sv_type_details
9867 = bodies_by_type + sv_type;
9871 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9875 if (GvUNIQUE((GV*)sstr)) {
9876 /*EMPTY*/; /* Do sharing here, and fall through */
9889 assert(sv_type_details->body_size);
9890 if (sv_type_details->arena) {
9891 new_body_inline(new_body, sv_type);
9893 = (void*)((char*)new_body - sv_type_details->offset);
9895 new_body = new_NOARENA(sv_type_details);
9899 SvANY(dstr) = new_body;
9902 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9903 ((char*)SvANY(dstr)) + sv_type_details->offset,
9904 sv_type_details->copy, char);
9906 Copy(((char*)SvANY(sstr)),
9907 ((char*)SvANY(dstr)),
9908 sv_type_details->body_size + sv_type_details->offset, char);
9911 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9912 && !isGV_with_GP(dstr))
9913 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9915 /* The Copy above means that all the source (unduplicated) pointers
9916 are now in the destination. We can check the flags and the
9917 pointers in either, but it's possible that there's less cache
9918 missing by always going for the destination.
9919 FIXME - instrument and check that assumption */
9920 if (sv_type >= SVt_PVMG) {
9922 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9923 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9924 } else if (SvMAGIC(dstr))
9925 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9927 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9930 /* The cast silences a GCC warning about unhandled types. */
9931 switch ((int)sv_type) {
9943 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9944 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9945 LvTARG(dstr) = dstr;
9946 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9947 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9949 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9952 if (GvNAME_HEK(dstr))
9953 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9955 /* Don't call sv_add_backref here as it's going to be created
9956 as part of the magic cloning of the symbol table. */
9957 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9958 if(isGV_with_GP(sstr)) {
9959 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9960 at the point of this comment. */
9961 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9962 (void)GpREFCNT_inc(GvGP(dstr));
9964 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9967 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9968 if (IoOFP(dstr) == IoIFP(sstr))
9969 IoOFP(dstr) = IoIFP(dstr);
9971 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9972 /* PL_rsfp_filters entries have fake IoDIRP() */
9973 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9974 /* I have no idea why fake dirp (rsfps)
9975 should be treated differently but otherwise
9976 we end up with leaks -- sky*/
9977 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9978 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9979 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9981 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9982 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9983 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9985 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9988 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9991 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9992 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9993 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9996 if (AvARRAY((AV*)sstr)) {
9997 SV **dst_ary, **src_ary;
9998 SSize_t items = AvFILLp((AV*)sstr) + 1;
10000 src_ary = AvARRAY((AV*)sstr);
10001 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10002 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10003 SvPV_set(dstr, (char*)dst_ary);
10004 AvALLOC((AV*)dstr) = dst_ary;
10005 if (AvREAL((AV*)sstr)) {
10006 while (items-- > 0)
10007 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10010 while (items-- > 0)
10011 *dst_ary++ = sv_dup(*src_ary++, param);
10013 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10014 while (items-- > 0) {
10015 *dst_ary++ = &PL_sv_undef;
10019 SvPV_set(dstr, NULL);
10020 AvALLOC((AV*)dstr) = (SV**)NULL;
10025 HEK *hvname = NULL;
10027 if (HvARRAY((HV*)sstr)) {
10029 const bool sharekeys = !!HvSHAREKEYS(sstr);
10030 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10031 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10033 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10034 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10036 HvARRAY(dstr) = (HE**)darray;
10037 while (i <= sxhv->xhv_max) {
10038 const HE *source = HvARRAY(sstr)[i];
10039 HvARRAY(dstr)[i] = source
10040 ? he_dup(source, sharekeys, param) : 0;
10044 struct xpvhv_aux * const saux = HvAUX(sstr);
10045 struct xpvhv_aux * const daux = HvAUX(dstr);
10046 /* This flag isn't copied. */
10047 /* SvOOK_on(hv) attacks the IV flags. */
10048 SvFLAGS(dstr) |= SVf_OOK;
10050 hvname = saux->xhv_name;
10052 = hvname ? hek_dup(hvname, param) : hvname;
10054 daux->xhv_riter = saux->xhv_riter;
10055 daux->xhv_eiter = saux->xhv_eiter
10056 ? he_dup(saux->xhv_eiter,
10057 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10058 daux->xhv_backreferences = saux->xhv_backreferences
10059 ? (AV*) SvREFCNT_inc(
10061 xhv_backreferences,
10067 SvPV_set(dstr, NULL);
10069 /* Record stashes for possible cloning in Perl_clone(). */
10071 av_push(param->stashes, dstr);
10075 if (!(param->flags & CLONEf_COPY_STACKS)) {
10079 /* NOTE: not refcounted */
10080 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10082 if (!CvISXSUB(dstr))
10083 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10085 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10086 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10087 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10088 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10090 /* don't dup if copying back - CvGV isn't refcounted, so the
10091 * duped GV may never be freed. A bit of a hack! DAPM */
10092 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10093 NULL : gv_dup(CvGV(dstr), param) ;
10094 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10096 CvWEAKOUTSIDE(sstr)
10097 ? cv_dup( CvOUTSIDE(dstr), param)
10098 : cv_dup_inc(CvOUTSIDE(dstr), param);
10099 if (!CvISXSUB(dstr))
10100 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10106 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10112 /* duplicate a context */
10115 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10117 PERL_CONTEXT *ncxs;
10120 return (PERL_CONTEXT*)NULL;
10122 /* look for it in the table first */
10123 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10127 /* create anew and remember what it is */
10128 Newxz(ncxs, max + 1, PERL_CONTEXT);
10129 ptr_table_store(PL_ptr_table, cxs, ncxs);
10132 PERL_CONTEXT * const cx = &cxs[ix];
10133 PERL_CONTEXT * const ncx = &ncxs[ix];
10134 ncx->cx_type = cx->cx_type;
10135 if (CxTYPE(cx) == CXt_SUBST) {
10136 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10139 ncx->blk_oldsp = cx->blk_oldsp;
10140 ncx->blk_oldcop = cx->blk_oldcop;
10141 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10142 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10143 ncx->blk_oldpm = cx->blk_oldpm;
10144 ncx->blk_gimme = cx->blk_gimme;
10145 switch (CxTYPE(cx)) {
10147 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10148 ? cv_dup_inc(cx->blk_sub.cv, param)
10149 : cv_dup(cx->blk_sub.cv,param));
10150 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10151 ? av_dup_inc(cx->blk_sub.argarray, param)
10153 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10154 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10155 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10156 ncx->blk_sub.lval = cx->blk_sub.lval;
10157 ncx->blk_sub.retop = cx->blk_sub.retop;
10160 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10161 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10162 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10163 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10164 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10165 ncx->blk_eval.retop = cx->blk_eval.retop;
10168 ncx->blk_loop.label = cx->blk_loop.label;
10169 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10170 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10171 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10172 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10173 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10174 ? cx->blk_loop.iterdata
10175 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10176 ncx->blk_loop.oldcomppad
10177 = (PAD*)ptr_table_fetch(PL_ptr_table,
10178 cx->blk_loop.oldcomppad);
10179 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10180 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10181 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10182 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10183 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10186 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10187 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10188 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10189 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10190 ncx->blk_sub.retop = cx->blk_sub.retop;
10202 /* duplicate a stack info structure */
10205 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10210 return (PERL_SI*)NULL;
10212 /* look for it in the table first */
10213 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10217 /* create anew and remember what it is */
10218 Newxz(nsi, 1, PERL_SI);
10219 ptr_table_store(PL_ptr_table, si, nsi);
10221 nsi->si_stack = av_dup_inc(si->si_stack, param);
10222 nsi->si_cxix = si->si_cxix;
10223 nsi->si_cxmax = si->si_cxmax;
10224 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10225 nsi->si_type = si->si_type;
10226 nsi->si_prev = si_dup(si->si_prev, param);
10227 nsi->si_next = si_dup(si->si_next, param);
10228 nsi->si_markoff = si->si_markoff;
10233 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10234 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10235 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10236 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10237 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10238 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10239 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10240 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10241 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10242 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10243 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10244 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10245 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10246 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10249 #define pv_dup_inc(p) SAVEPV(p)
10250 #define pv_dup(p) SAVEPV(p)
10251 #define svp_dup_inc(p,pp) any_dup(p,pp)
10253 /* map any object to the new equivent - either something in the
10254 * ptr table, or something in the interpreter structure
10258 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10263 return (void*)NULL;
10265 /* look for it in the table first */
10266 ret = ptr_table_fetch(PL_ptr_table, v);
10270 /* see if it is part of the interpreter structure */
10271 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10272 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10280 /* duplicate the save stack */
10283 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10285 ANY * const ss = proto_perl->Tsavestack;
10286 const I32 max = proto_perl->Tsavestack_max;
10287 I32 ix = proto_perl->Tsavestack_ix;
10299 void (*dptr) (void*);
10300 void (*dxptr) (pTHX_ void*);
10302 Newxz(nss, max, ANY);
10305 I32 i = POPINT(ss,ix);
10306 TOPINT(nss,ix) = i;
10308 case SAVEt_ITEM: /* normal string */
10309 sv = (SV*)POPPTR(ss,ix);
10310 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10311 sv = (SV*)POPPTR(ss,ix);
10312 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10314 case SAVEt_SV: /* scalar reference */
10315 sv = (SV*)POPPTR(ss,ix);
10316 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10317 gv = (GV*)POPPTR(ss,ix);
10318 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10320 case SAVEt_GENERIC_PVREF: /* generic char* */
10321 c = (char*)POPPTR(ss,ix);
10322 TOPPTR(nss,ix) = pv_dup(c);
10323 ptr = POPPTR(ss,ix);
10324 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10326 case SAVEt_SHARED_PVREF: /* char* in shared space */
10327 c = (char*)POPPTR(ss,ix);
10328 TOPPTR(nss,ix) = savesharedpv(c);
10329 ptr = POPPTR(ss,ix);
10330 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10332 case SAVEt_GENERIC_SVREF: /* generic sv */
10333 case SAVEt_SVREF: /* scalar reference */
10334 sv = (SV*)POPPTR(ss,ix);
10335 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10336 ptr = POPPTR(ss,ix);
10337 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10339 case SAVEt_AV: /* array reference */
10340 av = (AV*)POPPTR(ss,ix);
10341 TOPPTR(nss,ix) = av_dup_inc(av, param);
10342 gv = (GV*)POPPTR(ss,ix);
10343 TOPPTR(nss,ix) = gv_dup(gv, param);
10345 case SAVEt_HV: /* hash reference */
10346 hv = (HV*)POPPTR(ss,ix);
10347 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10348 gv = (GV*)POPPTR(ss,ix);
10349 TOPPTR(nss,ix) = gv_dup(gv, param);
10351 case SAVEt_INT: /* int reference */
10352 ptr = POPPTR(ss,ix);
10353 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10354 intval = (int)POPINT(ss,ix);
10355 TOPINT(nss,ix) = intval;
10357 case SAVEt_LONG: /* long reference */
10358 ptr = POPPTR(ss,ix);
10359 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10360 longval = (long)POPLONG(ss,ix);
10361 TOPLONG(nss,ix) = longval;
10363 case SAVEt_I32: /* I32 reference */
10364 case SAVEt_I16: /* I16 reference */
10365 case SAVEt_I8: /* I8 reference */
10366 ptr = POPPTR(ss,ix);
10367 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10369 TOPINT(nss,ix) = i;
10371 case SAVEt_IV: /* IV reference */
10372 ptr = POPPTR(ss,ix);
10373 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10375 TOPIV(nss,ix) = iv;
10377 case SAVEt_SPTR: /* SV* reference */
10378 ptr = POPPTR(ss,ix);
10379 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10380 sv = (SV*)POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = sv_dup(sv, param);
10383 case SAVEt_VPTR: /* random* reference */
10384 ptr = POPPTR(ss,ix);
10385 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10386 ptr = POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10389 case SAVEt_PPTR: /* char* reference */
10390 ptr = POPPTR(ss,ix);
10391 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10392 c = (char*)POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = pv_dup(c);
10395 case SAVEt_HPTR: /* HV* reference */
10396 ptr = POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10398 hv = (HV*)POPPTR(ss,ix);
10399 TOPPTR(nss,ix) = hv_dup(hv, param);
10401 case SAVEt_APTR: /* AV* reference */
10402 ptr = POPPTR(ss,ix);
10403 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10404 av = (AV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = av_dup(av, param);
10408 gv = (GV*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = gv_dup(gv, param);
10411 case SAVEt_GP: /* scalar reference */
10412 gp = (GP*)POPPTR(ss,ix);
10413 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10414 (void)GpREFCNT_inc(gp);
10415 gv = (GV*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10417 c = (char*)POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = pv_dup(c);
10420 TOPIV(nss,ix) = iv;
10422 TOPIV(nss,ix) = iv;
10425 case SAVEt_MORTALIZESV:
10426 sv = (SV*)POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10430 ptr = POPPTR(ss,ix);
10431 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10432 /* these are assumed to be refcounted properly */
10434 switch (((OP*)ptr)->op_type) {
10436 case OP_LEAVESUBLV:
10440 case OP_LEAVEWRITE:
10441 TOPPTR(nss,ix) = ptr;
10446 TOPPTR(nss,ix) = NULL;
10451 TOPPTR(nss,ix) = NULL;
10454 c = (char*)POPPTR(ss,ix);
10455 TOPPTR(nss,ix) = pv_dup_inc(c);
10457 case SAVEt_CLEARSV:
10458 longval = POPLONG(ss,ix);
10459 TOPLONG(nss,ix) = longval;
10462 hv = (HV*)POPPTR(ss,ix);
10463 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10464 c = (char*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = pv_dup_inc(c);
10467 TOPINT(nss,ix) = i;
10469 case SAVEt_DESTRUCTOR:
10470 ptr = POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10472 dptr = POPDPTR(ss,ix);
10473 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10474 any_dup(FPTR2DPTR(void *, dptr),
10477 case SAVEt_DESTRUCTOR_X:
10478 ptr = POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10480 dxptr = POPDXPTR(ss,ix);
10481 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10482 any_dup(FPTR2DPTR(void *, dxptr),
10485 case SAVEt_REGCONTEXT:
10488 TOPINT(nss,ix) = i;
10491 case SAVEt_STACK_POS: /* Position on Perl stack */
10493 TOPINT(nss,ix) = i;
10495 case SAVEt_AELEM: /* array element */
10496 sv = (SV*)POPPTR(ss,ix);
10497 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10499 TOPINT(nss,ix) = i;
10500 av = (AV*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = av_dup_inc(av, param);
10503 case SAVEt_HELEM: /* hash element */
10504 sv = (SV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10506 sv = (SV*)POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10508 hv = (HV*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10512 ptr = POPPTR(ss,ix);
10513 TOPPTR(nss,ix) = ptr;
10517 TOPINT(nss,ix) = i;
10519 case SAVEt_COMPPAD:
10520 av = (AV*)POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = av_dup(av, param);
10524 longval = (long)POPLONG(ss,ix);
10525 TOPLONG(nss,ix) = longval;
10526 ptr = POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10528 sv = (SV*)POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = sv_dup(sv, param);
10532 ptr = POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10534 longval = (long)POPBOOL(ss,ix);
10535 TOPBOOL(nss,ix) = (bool)longval;
10537 case SAVEt_SET_SVFLAGS:
10539 TOPINT(nss,ix) = i;
10541 TOPINT(nss,ix) = i;
10542 sv = (SV*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = sv_dup(sv, param);
10546 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10554 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10555 * flag to the result. This is done for each stash before cloning starts,
10556 * so we know which stashes want their objects cloned */
10559 do_mark_cloneable_stash(pTHX_ SV *sv)
10561 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10563 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10564 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10565 if (cloner && GvCV(cloner)) {
10572 XPUSHs(sv_2mortal(newSVhek(hvname)));
10574 call_sv((SV*)GvCV(cloner), G_SCALAR);
10581 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10589 =for apidoc perl_clone
10591 Create and return a new interpreter by cloning the current one.
10593 perl_clone takes these flags as parameters:
10595 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10596 without it we only clone the data and zero the stacks,
10597 with it we copy the stacks and the new perl interpreter is
10598 ready to run at the exact same point as the previous one.
10599 The pseudo-fork code uses COPY_STACKS while the
10600 threads->new doesn't.
10602 CLONEf_KEEP_PTR_TABLE
10603 perl_clone keeps a ptr_table with the pointer of the old
10604 variable as a key and the new variable as a value,
10605 this allows it to check if something has been cloned and not
10606 clone it again but rather just use the value and increase the
10607 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10608 the ptr_table using the function
10609 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10610 reason to keep it around is if you want to dup some of your own
10611 variable who are outside the graph perl scans, example of this
10612 code is in threads.xs create
10615 This is a win32 thing, it is ignored on unix, it tells perls
10616 win32host code (which is c++) to clone itself, this is needed on
10617 win32 if you want to run two threads at the same time,
10618 if you just want to do some stuff in a separate perl interpreter
10619 and then throw it away and return to the original one,
10620 you don't need to do anything.
10625 /* XXX the above needs expanding by someone who actually understands it ! */
10626 EXTERN_C PerlInterpreter *
10627 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10630 perl_clone(PerlInterpreter *proto_perl, UV flags)
10633 #ifdef PERL_IMPLICIT_SYS
10635 /* perlhost.h so we need to call into it
10636 to clone the host, CPerlHost should have a c interface, sky */
10638 if (flags & CLONEf_CLONE_HOST) {
10639 return perl_clone_host(proto_perl,flags);
10641 return perl_clone_using(proto_perl, flags,
10643 proto_perl->IMemShared,
10644 proto_perl->IMemParse,
10646 proto_perl->IStdIO,
10650 proto_perl->IProc);
10654 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10655 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10656 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10657 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10658 struct IPerlDir* ipD, struct IPerlSock* ipS,
10659 struct IPerlProc* ipP)
10661 /* XXX many of the string copies here can be optimized if they're
10662 * constants; they need to be allocated as common memory and just
10663 * their pointers copied. */
10666 CLONE_PARAMS clone_params;
10667 CLONE_PARAMS* const param = &clone_params;
10669 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10670 /* for each stash, determine whether its objects should be cloned */
10671 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10672 PERL_SET_THX(my_perl);
10675 Poison(my_perl, 1, PerlInterpreter);
10681 PL_savestack_ix = 0;
10682 PL_savestack_max = -1;
10683 PL_sig_pending = 0;
10684 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10685 # else /* !DEBUGGING */
10686 Zero(my_perl, 1, PerlInterpreter);
10687 # endif /* DEBUGGING */
10689 /* host pointers */
10691 PL_MemShared = ipMS;
10692 PL_MemParse = ipMP;
10699 #else /* !PERL_IMPLICIT_SYS */
10701 CLONE_PARAMS clone_params;
10702 CLONE_PARAMS* param = &clone_params;
10703 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10704 /* for each stash, determine whether its objects should be cloned */
10705 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10706 PERL_SET_THX(my_perl);
10709 Poison(my_perl, 1, PerlInterpreter);
10715 PL_savestack_ix = 0;
10716 PL_savestack_max = -1;
10717 PL_sig_pending = 0;
10718 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10719 # else /* !DEBUGGING */
10720 Zero(my_perl, 1, PerlInterpreter);
10721 # endif /* DEBUGGING */
10722 #endif /* PERL_IMPLICIT_SYS */
10723 param->flags = flags;
10724 param->proto_perl = proto_perl;
10726 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10728 PL_body_arenas = NULL;
10729 Zero(&PL_body_roots, 1, PL_body_roots);
10731 PL_nice_chunk = NULL;
10732 PL_nice_chunk_size = 0;
10734 PL_sv_objcount = 0;
10736 PL_sv_arenaroot = NULL;
10738 PL_debug = proto_perl->Idebug;
10740 PL_hash_seed = proto_perl->Ihash_seed;
10741 PL_rehash_seed = proto_perl->Irehash_seed;
10743 #ifdef USE_REENTRANT_API
10744 /* XXX: things like -Dm will segfault here in perlio, but doing
10745 * PERL_SET_CONTEXT(proto_perl);
10746 * breaks too many other things
10748 Perl_reentrant_init(aTHX);
10751 /* create SV map for pointer relocation */
10752 PL_ptr_table = ptr_table_new();
10754 /* initialize these special pointers as early as possible */
10755 SvANY(&PL_sv_undef) = NULL;
10756 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10757 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10758 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10760 SvANY(&PL_sv_no) = new_XPVNV();
10761 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10762 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10763 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10764 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10765 SvCUR_set(&PL_sv_no, 0);
10766 SvLEN_set(&PL_sv_no, 1);
10767 SvIV_set(&PL_sv_no, 0);
10768 SvNV_set(&PL_sv_no, 0);
10769 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10771 SvANY(&PL_sv_yes) = new_XPVNV();
10772 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10773 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10774 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10775 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10776 SvCUR_set(&PL_sv_yes, 1);
10777 SvLEN_set(&PL_sv_yes, 2);
10778 SvIV_set(&PL_sv_yes, 1);
10779 SvNV_set(&PL_sv_yes, 1);
10780 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10782 /* create (a non-shared!) shared string table */
10783 PL_strtab = newHV();
10784 HvSHAREKEYS_off(PL_strtab);
10785 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10786 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10788 PL_compiling = proto_perl->Icompiling;
10790 /* These two PVs will be free'd special way so must set them same way op.c does */
10791 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10792 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10794 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10795 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10797 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10798 if (!specialWARN(PL_compiling.cop_warnings))
10799 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10800 if (!specialCopIO(PL_compiling.cop_io))
10801 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10802 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10804 /* pseudo environmental stuff */
10805 PL_origargc = proto_perl->Iorigargc;
10806 PL_origargv = proto_perl->Iorigargv;
10808 param->stashes = newAV(); /* Setup array of objects to call clone on */
10810 /* Set tainting stuff before PerlIO_debug can possibly get called */
10811 PL_tainting = proto_perl->Itainting;
10812 PL_taint_warn = proto_perl->Itaint_warn;
10814 #ifdef PERLIO_LAYERS
10815 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10816 PerlIO_clone(aTHX_ proto_perl, param);
10819 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10820 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10821 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10822 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10823 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10824 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10827 PL_minus_c = proto_perl->Iminus_c;
10828 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10829 PL_localpatches = proto_perl->Ilocalpatches;
10830 PL_splitstr = proto_perl->Isplitstr;
10831 PL_preprocess = proto_perl->Ipreprocess;
10832 PL_minus_n = proto_perl->Iminus_n;
10833 PL_minus_p = proto_perl->Iminus_p;
10834 PL_minus_l = proto_perl->Iminus_l;
10835 PL_minus_a = proto_perl->Iminus_a;
10836 PL_minus_E = proto_perl->Iminus_E;
10837 PL_minus_F = proto_perl->Iminus_F;
10838 PL_doswitches = proto_perl->Idoswitches;
10839 PL_dowarn = proto_perl->Idowarn;
10840 PL_doextract = proto_perl->Idoextract;
10841 PL_sawampersand = proto_perl->Isawampersand;
10842 PL_unsafe = proto_perl->Iunsafe;
10843 PL_inplace = SAVEPV(proto_perl->Iinplace);
10844 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10845 PL_perldb = proto_perl->Iperldb;
10846 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10847 PL_exit_flags = proto_perl->Iexit_flags;
10849 /* magical thingies */
10850 /* XXX time(&PL_basetime) when asked for? */
10851 PL_basetime = proto_perl->Ibasetime;
10852 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10854 PL_maxsysfd = proto_perl->Imaxsysfd;
10855 PL_multiline = proto_perl->Imultiline;
10856 PL_statusvalue = proto_perl->Istatusvalue;
10858 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10860 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10862 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10864 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10865 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10866 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10868 /* Clone the regex array */
10869 PL_regex_padav = newAV();
10871 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10872 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10874 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10875 for(i = 1; i <= len; i++) {
10876 const SV * const regex = regexen[i];
10879 ? sv_dup_inc(regex, param)
10881 newSViv(PTR2IV(re_dup(
10882 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10884 av_push(PL_regex_padav, sv);
10887 PL_regex_pad = AvARRAY(PL_regex_padav);
10889 /* shortcuts to various I/O objects */
10890 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10891 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10892 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10893 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10894 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10895 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10897 /* shortcuts to regexp stuff */
10898 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10900 /* shortcuts to misc objects */
10901 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10903 /* shortcuts to debugging objects */
10904 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10905 PL_DBline = gv_dup(proto_perl->IDBline, param);
10906 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10907 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10908 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10909 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10910 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10911 PL_lineary = av_dup(proto_perl->Ilineary, param);
10912 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10914 /* symbol tables */
10915 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10916 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10917 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10918 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10919 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10921 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10922 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10923 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10924 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10925 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10926 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10928 PL_sub_generation = proto_perl->Isub_generation;
10930 /* funky return mechanisms */
10931 PL_forkprocess = proto_perl->Iforkprocess;
10933 /* subprocess state */
10934 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10936 /* internal state */
10937 PL_maxo = proto_perl->Imaxo;
10938 if (proto_perl->Iop_mask)
10939 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10942 /* PL_asserting = proto_perl->Iasserting; */
10944 /* current interpreter roots */
10945 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10946 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10947 PL_main_start = proto_perl->Imain_start;
10948 PL_eval_root = proto_perl->Ieval_root;
10949 PL_eval_start = proto_perl->Ieval_start;
10951 /* runtime control stuff */
10952 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10953 PL_copline = proto_perl->Icopline;
10955 PL_filemode = proto_perl->Ifilemode;
10956 PL_lastfd = proto_perl->Ilastfd;
10957 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10960 PL_gensym = proto_perl->Igensym;
10961 PL_preambled = proto_perl->Ipreambled;
10962 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10963 PL_laststatval = proto_perl->Ilaststatval;
10964 PL_laststype = proto_perl->Ilaststype;
10967 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10969 /* interpreter atexit processing */
10970 PL_exitlistlen = proto_perl->Iexitlistlen;
10971 if (PL_exitlistlen) {
10972 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10973 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10976 PL_exitlist = (PerlExitListEntry*)NULL;
10978 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10979 if (PL_my_cxt_size) {
10980 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10981 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10984 PL_my_cxt_list = (void**)NULL;
10985 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10986 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10987 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10989 PL_profiledata = NULL;
10990 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10991 /* PL_rsfp_filters entries have fake IoDIRP() */
10992 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10994 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10996 PAD_CLONE_VARS(proto_perl, param);
10998 #ifdef HAVE_INTERP_INTERN
10999 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11002 /* more statics moved here */
11003 PL_generation = proto_perl->Igeneration;
11004 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11006 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11007 PL_in_clean_all = proto_perl->Iin_clean_all;
11009 PL_uid = proto_perl->Iuid;
11010 PL_euid = proto_perl->Ieuid;
11011 PL_gid = proto_perl->Igid;
11012 PL_egid = proto_perl->Iegid;
11013 PL_nomemok = proto_perl->Inomemok;
11014 PL_an = proto_perl->Ian;
11015 PL_evalseq = proto_perl->Ievalseq;
11016 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11017 PL_origalen = proto_perl->Iorigalen;
11018 #ifdef PERL_USES_PL_PIDSTATUS
11019 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11021 PL_osname = SAVEPV(proto_perl->Iosname);
11022 PL_sighandlerp = proto_perl->Isighandlerp;
11024 PL_runops = proto_perl->Irunops;
11026 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11029 PL_cshlen = proto_perl->Icshlen;
11030 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11033 PL_lex_state = proto_perl->Ilex_state;
11034 PL_lex_defer = proto_perl->Ilex_defer;
11035 PL_lex_expect = proto_perl->Ilex_expect;
11036 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11037 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11038 PL_lex_starts = proto_perl->Ilex_starts;
11039 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11040 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11041 PL_lex_op = proto_perl->Ilex_op;
11042 PL_lex_inpat = proto_perl->Ilex_inpat;
11043 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11044 PL_lex_brackets = proto_perl->Ilex_brackets;
11045 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11046 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11047 PL_lex_casemods = proto_perl->Ilex_casemods;
11048 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11049 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11052 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11053 PL_lasttoke = proto_perl->Ilasttoke;
11054 PL_realtokenstart = proto_perl->Irealtokenstart;
11055 PL_faketokens = proto_perl->Ifaketokens;
11056 PL_thismad = proto_perl->Ithismad;
11057 PL_thistoken = proto_perl->Ithistoken;
11058 PL_thisopen = proto_perl->Ithisopen;
11059 PL_thisstuff = proto_perl->Ithisstuff;
11060 PL_thisclose = proto_perl->Ithisclose;
11061 PL_thiswhite = proto_perl->Ithiswhite;
11062 PL_nextwhite = proto_perl->Inextwhite;
11063 PL_skipwhite = proto_perl->Iskipwhite;
11064 PL_endwhite = proto_perl->Iendwhite;
11065 PL_curforce = proto_perl->Icurforce;
11067 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11068 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11069 PL_nexttoke = proto_perl->Inexttoke;
11072 /* XXX This is probably masking the deeper issue of why
11073 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11074 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11075 * (A little debugging with a watchpoint on it may help.)
11077 if (SvANY(proto_perl->Ilinestr)) {
11078 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11079 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11080 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11081 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11082 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11083 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11084 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11085 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11086 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11089 PL_linestr = newSV(79);
11090 sv_upgrade(PL_linestr,SVt_PVIV);
11091 sv_setpvn(PL_linestr,"",0);
11092 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11094 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11095 PL_pending_ident = proto_perl->Ipending_ident;
11096 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11098 PL_expect = proto_perl->Iexpect;
11100 PL_multi_start = proto_perl->Imulti_start;
11101 PL_multi_end = proto_perl->Imulti_end;
11102 PL_multi_open = proto_perl->Imulti_open;
11103 PL_multi_close = proto_perl->Imulti_close;
11105 PL_error_count = proto_perl->Ierror_count;
11106 PL_subline = proto_perl->Isubline;
11107 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11109 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11110 if (SvANY(proto_perl->Ilinestr)) {
11111 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11112 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11113 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11114 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11115 PL_last_lop_op = proto_perl->Ilast_lop_op;
11118 PL_last_uni = SvPVX(PL_linestr);
11119 PL_last_lop = SvPVX(PL_linestr);
11120 PL_last_lop_op = 0;
11122 PL_in_my = proto_perl->Iin_my;
11123 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11125 PL_cryptseen = proto_perl->Icryptseen;
11128 PL_hints = proto_perl->Ihints;
11130 PL_amagic_generation = proto_perl->Iamagic_generation;
11132 #ifdef USE_LOCALE_COLLATE
11133 PL_collation_ix = proto_perl->Icollation_ix;
11134 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11135 PL_collation_standard = proto_perl->Icollation_standard;
11136 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11137 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11138 #endif /* USE_LOCALE_COLLATE */
11140 #ifdef USE_LOCALE_NUMERIC
11141 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11142 PL_numeric_standard = proto_perl->Inumeric_standard;
11143 PL_numeric_local = proto_perl->Inumeric_local;
11144 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11145 #endif /* !USE_LOCALE_NUMERIC */
11147 /* utf8 character classes */
11148 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11149 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11150 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11151 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11152 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11153 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11154 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11155 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11156 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11157 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11158 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11159 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11160 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11161 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11162 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11163 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11164 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11165 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11166 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11167 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11169 /* Did the locale setup indicate UTF-8? */
11170 PL_utf8locale = proto_perl->Iutf8locale;
11171 /* Unicode features (see perlrun/-C) */
11172 PL_unicode = proto_perl->Iunicode;
11174 /* Pre-5.8 signals control */
11175 PL_signals = proto_perl->Isignals;
11177 /* times() ticks per second */
11178 PL_clocktick = proto_perl->Iclocktick;
11180 /* Recursion stopper for PerlIO_find_layer */
11181 PL_in_load_module = proto_perl->Iin_load_module;
11183 /* sort() routine */
11184 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11186 /* Not really needed/useful since the reenrant_retint is "volatile",
11187 * but do it for consistency's sake. */
11188 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11190 /* Hooks to shared SVs and locks. */
11191 PL_sharehook = proto_perl->Isharehook;
11192 PL_lockhook = proto_perl->Ilockhook;
11193 PL_unlockhook = proto_perl->Iunlockhook;
11194 PL_threadhook = proto_perl->Ithreadhook;
11196 PL_runops_std = proto_perl->Irunops_std;
11197 PL_runops_dbg = proto_perl->Irunops_dbg;
11199 #ifdef THREADS_HAVE_PIDS
11200 PL_ppid = proto_perl->Ippid;
11204 PL_last_swash_hv = NULL; /* reinits on demand */
11205 PL_last_swash_klen = 0;
11206 PL_last_swash_key[0]= '\0';
11207 PL_last_swash_tmps = (U8*)NULL;
11208 PL_last_swash_slen = 0;
11210 PL_glob_index = proto_perl->Iglob_index;
11211 PL_srand_called = proto_perl->Isrand_called;
11212 PL_uudmap['M'] = 0; /* reinits on demand */
11213 PL_bitcount = NULL; /* reinits on demand */
11215 if (proto_perl->Ipsig_pend) {
11216 Newxz(PL_psig_pend, SIG_SIZE, int);
11219 PL_psig_pend = (int*)NULL;
11222 if (proto_perl->Ipsig_ptr) {
11223 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11224 Newxz(PL_psig_name, SIG_SIZE, SV*);
11225 for (i = 1; i < SIG_SIZE; i++) {
11226 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11227 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11231 PL_psig_ptr = (SV**)NULL;
11232 PL_psig_name = (SV**)NULL;
11235 /* thrdvar.h stuff */
11237 if (flags & CLONEf_COPY_STACKS) {
11238 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11239 PL_tmps_ix = proto_perl->Ttmps_ix;
11240 PL_tmps_max = proto_perl->Ttmps_max;
11241 PL_tmps_floor = proto_perl->Ttmps_floor;
11242 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11244 while (i <= PL_tmps_ix) {
11245 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11249 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11250 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11251 Newxz(PL_markstack, i, I32);
11252 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11253 - proto_perl->Tmarkstack);
11254 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11255 - proto_perl->Tmarkstack);
11256 Copy(proto_perl->Tmarkstack, PL_markstack,
11257 PL_markstack_ptr - PL_markstack + 1, I32);
11259 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11260 * NOTE: unlike the others! */
11261 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11262 PL_scopestack_max = proto_perl->Tscopestack_max;
11263 Newxz(PL_scopestack, PL_scopestack_max, I32);
11264 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11266 /* NOTE: si_dup() looks at PL_markstack */
11267 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11269 /* PL_curstack = PL_curstackinfo->si_stack; */
11270 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11271 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11273 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11274 PL_stack_base = AvARRAY(PL_curstack);
11275 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11276 - proto_perl->Tstack_base);
11277 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11279 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11280 * NOTE: unlike the others! */
11281 PL_savestack_ix = proto_perl->Tsavestack_ix;
11282 PL_savestack_max = proto_perl->Tsavestack_max;
11283 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11284 PL_savestack = ss_dup(proto_perl, param);
11288 ENTER; /* perl_destruct() wants to LEAVE; */
11290 /* although we're not duplicating the tmps stack, we should still
11291 * add entries for any SVs on the tmps stack that got cloned by a
11292 * non-refcount means (eg a temp in @_); otherwise they will be
11295 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11296 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11297 proto_perl->Ttmps_stack[i]);
11298 if (nsv && !SvREFCNT(nsv)) {
11300 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11305 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11306 PL_top_env = &PL_start_env;
11308 PL_op = proto_perl->Top;
11311 PL_Xpv = (XPV*)NULL;
11312 PL_na = proto_perl->Tna;
11314 PL_statbuf = proto_perl->Tstatbuf;
11315 PL_statcache = proto_perl->Tstatcache;
11316 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11317 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11319 PL_timesbuf = proto_perl->Ttimesbuf;
11322 PL_tainted = proto_perl->Ttainted;
11323 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11324 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11325 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11326 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11327 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11328 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11329 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11330 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11331 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11333 PL_restartop = proto_perl->Trestartop;
11334 PL_in_eval = proto_perl->Tin_eval;
11335 PL_delaymagic = proto_perl->Tdelaymagic;
11336 PL_dirty = proto_perl->Tdirty;
11337 PL_localizing = proto_perl->Tlocalizing;
11339 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11340 PL_hv_fetch_ent_mh = NULL;
11341 PL_modcount = proto_perl->Tmodcount;
11342 PL_lastgotoprobe = NULL;
11343 PL_dumpindent = proto_perl->Tdumpindent;
11345 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11346 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11347 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11348 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11349 PL_efloatbuf = NULL; /* reinits on demand */
11350 PL_efloatsize = 0; /* reinits on demand */
11354 PL_screamfirst = NULL;
11355 PL_screamnext = NULL;
11356 PL_maxscream = -1; /* reinits on demand */
11357 PL_lastscream = NULL;
11359 PL_watchaddr = NULL;
11362 PL_regdummy = proto_perl->Tregdummy;
11363 PL_regprecomp = NULL;
11366 PL_colorset = 0; /* reinits PL_colors[] */
11367 /*PL_colors[6] = {0,0,0,0,0,0};*/
11368 PL_reginput = NULL;
11371 PL_regstartp = (I32*)NULL;
11372 PL_regendp = (I32*)NULL;
11373 PL_reglastparen = (U32*)NULL;
11374 PL_reglastcloseparen = (U32*)NULL;
11376 PL_reg_start_tmp = (char**)NULL;
11377 PL_reg_start_tmpl = 0;
11378 PL_regdata = (struct reg_data*)NULL;
11381 PL_reg_eval_set = 0;
11383 PL_regprogram = (regnode*)NULL;
11385 PL_regcc = (CURCUR*)NULL;
11386 PL_reg_call_cc = (struct re_cc_state*)NULL;
11387 PL_reg_re = (regexp*)NULL;
11388 PL_reg_ganch = NULL;
11390 PL_reg_match_utf8 = FALSE;
11391 PL_reg_magic = (MAGIC*)NULL;
11393 PL_reg_oldcurpm = (PMOP*)NULL;
11394 PL_reg_curpm = (PMOP*)NULL;
11395 PL_reg_oldsaved = NULL;
11396 PL_reg_oldsavedlen = 0;
11397 #ifdef PERL_OLD_COPY_ON_WRITE
11400 PL_reg_maxiter = 0;
11401 PL_reg_leftiter = 0;
11402 PL_reg_poscache = NULL;
11403 PL_reg_poscache_size= 0;
11405 /* RE engine - function pointers */
11406 PL_regcompp = proto_perl->Tregcompp;
11407 PL_regexecp = proto_perl->Tregexecp;
11408 PL_regint_start = proto_perl->Tregint_start;
11409 PL_regint_string = proto_perl->Tregint_string;
11410 PL_regfree = proto_perl->Tregfree;
11412 PL_reginterp_cnt = 0;
11413 PL_reg_starttry = 0;
11415 /* Pluggable optimizer */
11416 PL_peepp = proto_perl->Tpeepp;
11418 PL_stashcache = newHV();
11420 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11421 ptr_table_free(PL_ptr_table);
11422 PL_ptr_table = NULL;
11425 /* Call the ->CLONE method, if it exists, for each of the stashes
11426 identified by sv_dup() above.
11428 while(av_len(param->stashes) != -1) {
11429 HV* const stash = (HV*) av_shift(param->stashes);
11430 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11431 if (cloner && GvCV(cloner)) {
11436 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11438 call_sv((SV*)GvCV(cloner), G_DISCARD);
11444 SvREFCNT_dec(param->stashes);
11446 /* orphaned? eg threads->new inside BEGIN or use */
11447 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11448 SvREFCNT_inc_simple_void(PL_compcv);
11449 SAVEFREESV(PL_compcv);
11455 #endif /* USE_ITHREADS */
11458 =head1 Unicode Support
11460 =for apidoc sv_recode_to_utf8
11462 The encoding is assumed to be an Encode object, on entry the PV
11463 of the sv is assumed to be octets in that encoding, and the sv
11464 will be converted into Unicode (and UTF-8).
11466 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11467 is not a reference, nothing is done to the sv. If the encoding is not
11468 an C<Encode::XS> Encoding object, bad things will happen.
11469 (See F<lib/encoding.pm> and L<Encode>).
11471 The PV of the sv is returned.
11476 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11479 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11493 Passing sv_yes is wrong - it needs to be or'ed set of constants
11494 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11495 remove converted chars from source.
11497 Both will default the value - let them.
11499 XPUSHs(&PL_sv_yes);
11502 call_method("decode", G_SCALAR);
11506 s = SvPV_const(uni, len);
11507 if (s != SvPVX_const(sv)) {
11508 SvGROW(sv, len + 1);
11509 Move(s, SvPVX(sv), len + 1, char);
11510 SvCUR_set(sv, len);
11517 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11521 =for apidoc sv_cat_decode
11523 The encoding is assumed to be an Encode object, the PV of the ssv is
11524 assumed to be octets in that encoding and decoding the input starts
11525 from the position which (PV + *offset) pointed to. The dsv will be
11526 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11527 when the string tstr appears in decoding output or the input ends on
11528 the PV of the ssv. The value which the offset points will be modified
11529 to the last input position on the ssv.
11531 Returns TRUE if the terminator was found, else returns FALSE.
11536 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11537 SV *ssv, int *offset, char *tstr, int tlen)
11541 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11552 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11553 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11555 call_method("cat_decode", G_SCALAR);
11557 ret = SvTRUE(TOPs);
11558 *offset = SvIV(offsv);
11564 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11569 /* ---------------------------------------------------------------------
11571 * support functions for report_uninit()
11574 /* the maxiumum size of array or hash where we will scan looking
11575 * for the undefined element that triggered the warning */
11577 #define FUV_MAX_SEARCH_SIZE 1000
11579 /* Look for an entry in the hash whose value has the same SV as val;
11580 * If so, return a mortal copy of the key. */
11583 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11586 register HE **array;
11589 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11590 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11593 array = HvARRAY(hv);
11595 for (i=HvMAX(hv); i>0; i--) {
11596 register HE *entry;
11597 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11598 if (HeVAL(entry) != val)
11600 if ( HeVAL(entry) == &PL_sv_undef ||
11601 HeVAL(entry) == &PL_sv_placeholder)
11605 if (HeKLEN(entry) == HEf_SVKEY)
11606 return sv_mortalcopy(HeKEY_sv(entry));
11607 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11613 /* Look for an entry in the array whose value has the same SV as val;
11614 * If so, return the index, otherwise return -1. */
11617 S_find_array_subscript(pTHX_ AV *av, SV* val)
11622 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11623 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11627 for (i=AvFILLp(av); i>=0; i--) {
11628 if (svp[i] == val && svp[i] != &PL_sv_undef)
11634 /* S_varname(): return the name of a variable, optionally with a subscript.
11635 * If gv is non-zero, use the name of that global, along with gvtype (one
11636 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11637 * targ. Depending on the value of the subscript_type flag, return:
11640 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11641 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11642 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11643 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11646 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11647 SV* keyname, I32 aindex, int subscript_type)
11650 SV * const name = sv_newmortal();
11653 buffer[0] = gvtype;
11656 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11658 gv_fullname4(name, gv, buffer, 0);
11660 if ((unsigned int)SvPVX(name)[1] <= 26) {
11662 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11664 /* Swap the 1 unprintable control character for the 2 byte pretty
11665 version - ie substr($name, 1, 1) = $buffer; */
11666 sv_insert(name, 1, 1, buffer, 2);
11671 CV * const cv = find_runcv(&unused);
11675 if (!cv || !CvPADLIST(cv))
11677 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11678 sv = *av_fetch(av, targ, FALSE);
11679 /* SvLEN in a pad name is not to be trusted */
11680 sv_setpv(name, SvPV_nolen_const(sv));
11683 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11684 SV * const sv = newSV(0);
11685 *SvPVX(name) = '$';
11686 Perl_sv_catpvf(aTHX_ name, "{%s}",
11687 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11690 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11691 *SvPVX(name) = '$';
11692 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11694 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11695 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11702 =for apidoc find_uninit_var
11704 Find the name of the undefined variable (if any) that caused the operator o
11705 to issue a "Use of uninitialized value" warning.
11706 If match is true, only return a name if it's value matches uninit_sv.
11707 So roughly speaking, if a unary operator (such as OP_COS) generates a
11708 warning, then following the direct child of the op may yield an
11709 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11710 other hand, with OP_ADD there are two branches to follow, so we only print
11711 the variable name if we get an exact match.
11713 The name is returned as a mortal SV.
11715 Assumes that PL_op is the op that originally triggered the error, and that
11716 PL_comppad/PL_curpad points to the currently executing pad.
11722 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11730 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11731 uninit_sv == &PL_sv_placeholder)))
11734 switch (obase->op_type) {
11741 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11742 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11745 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11747 if (pad) { /* @lex, %lex */
11748 sv = PAD_SVl(obase->op_targ);
11752 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11753 /* @global, %global */
11754 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11757 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11759 else /* @{expr}, %{expr} */
11760 return find_uninit_var(cUNOPx(obase)->op_first,
11764 /* attempt to find a match within the aggregate */
11766 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11768 subscript_type = FUV_SUBSCRIPT_HASH;
11771 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11773 subscript_type = FUV_SUBSCRIPT_ARRAY;
11776 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11779 return varname(gv, hash ? '%' : '@', obase->op_targ,
11780 keysv, index, subscript_type);
11784 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11786 return varname(NULL, '$', obase->op_targ,
11787 NULL, 0, FUV_SUBSCRIPT_NONE);
11790 gv = cGVOPx_gv(obase);
11791 if (!gv || (match && GvSV(gv) != uninit_sv))
11793 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11796 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11799 av = (AV*)PAD_SV(obase->op_targ);
11800 if (!av || SvRMAGICAL(av))
11802 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11803 if (!svp || *svp != uninit_sv)
11806 return varname(NULL, '$', obase->op_targ,
11807 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11810 gv = cGVOPx_gv(obase);
11816 if (!av || SvRMAGICAL(av))
11818 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11819 if (!svp || *svp != uninit_sv)
11822 return varname(gv, '$', 0,
11823 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11828 o = cUNOPx(obase)->op_first;
11829 if (!o || o->op_type != OP_NULL ||
11830 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11832 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11836 if (PL_op == obase)
11837 /* $a[uninit_expr] or $h{uninit_expr} */
11838 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11841 o = cBINOPx(obase)->op_first;
11842 kid = cBINOPx(obase)->op_last;
11844 /* get the av or hv, and optionally the gv */
11846 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11847 sv = PAD_SV(o->op_targ);
11849 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11850 && cUNOPo->op_first->op_type == OP_GV)
11852 gv = cGVOPx_gv(cUNOPo->op_first);
11855 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11860 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11861 /* index is constant */
11865 if (obase->op_type == OP_HELEM) {
11866 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11867 if (!he || HeVAL(he) != uninit_sv)
11871 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11872 if (!svp || *svp != uninit_sv)
11876 if (obase->op_type == OP_HELEM)
11877 return varname(gv, '%', o->op_targ,
11878 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11880 return varname(gv, '@', o->op_targ, NULL,
11881 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11884 /* index is an expression;
11885 * attempt to find a match within the aggregate */
11886 if (obase->op_type == OP_HELEM) {
11887 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11889 return varname(gv, '%', o->op_targ,
11890 keysv, 0, FUV_SUBSCRIPT_HASH);
11893 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11895 return varname(gv, '@', o->op_targ,
11896 NULL, index, FUV_SUBSCRIPT_ARRAY);
11901 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11903 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11908 /* only examine RHS */
11909 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11912 o = cUNOPx(obase)->op_first;
11913 if (o->op_type == OP_PUSHMARK)
11916 if (!o->op_sibling) {
11917 /* one-arg version of open is highly magical */
11919 if (o->op_type == OP_GV) { /* open FOO; */
11921 if (match && GvSV(gv) != uninit_sv)
11923 return varname(gv, '$', 0,
11924 NULL, 0, FUV_SUBSCRIPT_NONE);
11926 /* other possibilities not handled are:
11927 * open $x; or open my $x; should return '${*$x}'
11928 * open expr; should return '$'.expr ideally
11934 /* ops where $_ may be an implicit arg */
11938 if ( !(obase->op_flags & OPf_STACKED)) {
11939 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11940 ? PAD_SVl(obase->op_targ)
11943 sv = sv_newmortal();
11944 sv_setpvn(sv, "$_", 2);
11952 /* skip filehandle as it can't produce 'undef' warning */
11953 o = cUNOPx(obase)->op_first;
11954 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11955 o = o->op_sibling->op_sibling;
11962 match = 1; /* XS or custom code could trigger random warnings */
11967 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11968 return sv_2mortal(newSVpvs("${$/}"));
11973 if (!(obase->op_flags & OPf_KIDS))
11975 o = cUNOPx(obase)->op_first;
11981 /* if all except one arg are constant, or have no side-effects,
11982 * or are optimized away, then it's unambiguous */
11984 for (kid=o; kid; kid = kid->op_sibling) {
11986 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11987 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11988 || (kid->op_type == OP_PUSHMARK)
11992 if (o2) { /* more than one found */
11999 return find_uninit_var(o2, uninit_sv, match);
12001 /* scan all args */
12003 sv = find_uninit_var(o, uninit_sv, 1);
12015 =for apidoc report_uninit
12017 Print appropriate "Use of uninitialized variable" warning
12023 Perl_report_uninit(pTHX_ SV* uninit_sv)
12027 SV* varname = NULL;
12029 varname = find_uninit_var(PL_op, uninit_sv,0);
12031 sv_insert(varname, 0, 0, " ", 1);
12033 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12034 varname ? SvPV_nolen_const(varname) : "",
12035 " in ", OP_DESC(PL_op));
12038 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12044 * c-indentation-style: bsd
12045 * c-basic-offset: 4
12046 * indent-tabs-mode: t
12049 * ex: set ts=8 sts=4 sw=4 noet: