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 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5513 start = (U8*)SvPV_const(sv, len);
5516 STRLEN *cache = NULL;
5517 const U8 *s = start;
5518 I32 uoffset = *offsetp;
5519 const U8 * const send = s + len;
5521 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5523 if (!found && uoffset > 0) {
5524 while (s < send && uoffset--)
5528 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5530 *offsetp = s - start;
5535 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5539 if (!found && *lenp > 0) {
5542 while (s < send && ulen--)
5546 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5550 ASSERT_UTF8_CACHE(cache);
5562 =for apidoc sv_pos_b2u
5564 Converts the value pointed to by offsetp from a count of bytes from the
5565 start of the string, to a count of the equivalent number of UTF-8 chars.
5566 Handles magic and type coercion.
5572 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5573 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5574 * byte offsets. See also the comments of S_utf8_mg_pos().
5580 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target);
5583 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8)
5590 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5592 (*mgp)->mg_len = -1;
5596 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5597 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5598 (*mgp)->mg_ptr = (char *) cache;
5602 if (PL_utf8cache < 0) {
5603 const char *start = SvPVX_const(sv);
5604 const STRLEN realutf8
5605 = S_sv_pos_b2u_forwards(aTHX_ start, start + byte);
5607 if (realutf8 != utf8) {
5608 /* Need to turn the assertions off otherwise we may recurse
5609 infinitely while printing error messages. */
5610 SAVEI8(PL_utf8cache);
5612 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5613 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5618 /* Drop the stale "length" cache */
5623 /* If we don't know the character offset of the end of a region, our only
5624 option is to walk forwards to the target byte offset. */
5626 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5629 while (s < target) {
5632 /* Call utf8n_to_uvchr() to validate the sequence
5633 * (unless a simple non-UTF character) */
5634 if (!UTF8_IS_INVARIANT(*s))
5635 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5646 /* We already know all of the way, now we may be able to walk back. The same
5647 assumption is made as in S_utf8_mg_pos(), namely that walking backward is
5648 twice slower than walking forward. */
5650 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5653 const STRLEN forw = target - s;
5654 STRLEN backw = end - target;
5656 if (forw < 2 * backw) {
5657 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5660 while (end > target) {
5662 while (UTF8_IS_CONTINUATION(*end)) {
5671 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5674 const STRLEN byte = *offsetp;
5682 s = (const U8*)SvPV_const(sv, len);
5684 if ((I32)len < byte)
5685 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5689 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache) {
5690 mg = mg_find(sv, PERL_MAGIC_utf8);
5691 if (mg && mg->mg_ptr) {
5692 STRLEN *cache = (STRLEN *) mg->mg_ptr;
5693 if (cache[1] == (STRLEN)byte) {
5694 /* An exact match. */
5695 *offsetp = cache[0];
5699 else if (cache[1] < (STRLEN)byte) {
5700 /* We already know part of the way. */
5702 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1] , send);
5704 else { /* cache[1] > byte */
5705 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[1],
5709 ASSERT_UTF8_CACHE(cache);
5710 if (PL_utf8cache < 0) {
5711 const STRLEN reallen = S_sv_pos_b2u_forwards(aTHX_ s, send);
5713 if (len != reallen) {
5714 /* Need to turn the assertions off otherwise we may recurse
5715 infinitely while printing error messages. */
5716 SAVEI8(PL_utf8cache);
5718 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5719 " real %"UVf" for %"SVf,
5720 (UV) len, (UV) reallen, sv);
5724 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5728 len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5732 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len);
5738 Returns a boolean indicating whether the strings in the two SVs are
5739 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5740 coerce its args to strings if necessary.
5746 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5755 SV* svrecode = NULL;
5762 pv1 = SvPV_const(sv1, cur1);
5769 pv2 = SvPV_const(sv2, cur2);
5771 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5772 /* Differing utf8ness.
5773 * Do not UTF8size the comparands as a side-effect. */
5776 svrecode = newSVpvn(pv2, cur2);
5777 sv_recode_to_utf8(svrecode, PL_encoding);
5778 pv2 = SvPV_const(svrecode, cur2);
5781 svrecode = newSVpvn(pv1, cur1);
5782 sv_recode_to_utf8(svrecode, PL_encoding);
5783 pv1 = SvPV_const(svrecode, cur1);
5785 /* Now both are in UTF-8. */
5787 SvREFCNT_dec(svrecode);
5792 bool is_utf8 = TRUE;
5795 /* sv1 is the UTF-8 one,
5796 * if is equal it must be downgrade-able */
5797 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5803 /* sv2 is the UTF-8 one,
5804 * if is equal it must be downgrade-able */
5805 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5811 /* Downgrade not possible - cannot be eq */
5819 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5821 SvREFCNT_dec(svrecode);
5831 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5832 string in C<sv1> is less than, equal to, or greater than the string in
5833 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5834 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5840 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5844 const char *pv1, *pv2;
5847 SV *svrecode = NULL;
5854 pv1 = SvPV_const(sv1, cur1);
5861 pv2 = SvPV_const(sv2, cur2);
5863 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5864 /* Differing utf8ness.
5865 * Do not UTF8size the comparands as a side-effect. */
5868 svrecode = newSVpvn(pv2, cur2);
5869 sv_recode_to_utf8(svrecode, PL_encoding);
5870 pv2 = SvPV_const(svrecode, cur2);
5873 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5878 svrecode = newSVpvn(pv1, cur1);
5879 sv_recode_to_utf8(svrecode, PL_encoding);
5880 pv1 = SvPV_const(svrecode, cur1);
5883 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5889 cmp = cur2 ? -1 : 0;
5893 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5896 cmp = retval < 0 ? -1 : 1;
5897 } else if (cur1 == cur2) {
5900 cmp = cur1 < cur2 ? -1 : 1;
5904 SvREFCNT_dec(svrecode);
5912 =for apidoc sv_cmp_locale
5914 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5915 'use bytes' aware, handles get magic, and will coerce its args to strings
5916 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5922 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5925 #ifdef USE_LOCALE_COLLATE
5931 if (PL_collation_standard)
5935 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5937 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5939 if (!pv1 || !len1) {
5950 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5953 return retval < 0 ? -1 : 1;
5956 * When the result of collation is equality, that doesn't mean
5957 * that there are no differences -- some locales exclude some
5958 * characters from consideration. So to avoid false equalities,
5959 * we use the raw string as a tiebreaker.
5965 #endif /* USE_LOCALE_COLLATE */
5967 return sv_cmp(sv1, sv2);
5971 #ifdef USE_LOCALE_COLLATE
5974 =for apidoc sv_collxfrm
5976 Add Collate Transform magic to an SV if it doesn't already have it.
5978 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5979 scalar data of the variable, but transformed to such a format that a normal
5980 memory comparison can be used to compare the data according to the locale
5987 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5992 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5993 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5999 Safefree(mg->mg_ptr);
6000 s = SvPV_const(sv, len);
6001 if ((xf = mem_collxfrm(s, len, &xlen))) {
6002 if (SvREADONLY(sv)) {
6005 return xf + sizeof(PL_collation_ix);
6008 #ifdef PERL_OLD_COPY_ON_WRITE
6010 sv_force_normal_flags(sv, 0);
6012 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6026 if (mg && mg->mg_ptr) {
6028 return mg->mg_ptr + sizeof(PL_collation_ix);
6036 #endif /* USE_LOCALE_COLLATE */
6041 Get a line from the filehandle and store it into the SV, optionally
6042 appending to the currently-stored string.
6048 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6053 register STDCHAR rslast;
6054 register STDCHAR *bp;
6060 if (SvTHINKFIRST(sv))
6061 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6062 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6064 However, perlbench says it's slower, because the existing swipe code
6065 is faster than copy on write.
6066 Swings and roundabouts. */
6067 SvUPGRADE(sv, SVt_PV);
6072 if (PerlIO_isutf8(fp)) {
6074 sv_utf8_upgrade_nomg(sv);
6075 sv_pos_u2b(sv,&append,0);
6077 } else if (SvUTF8(sv)) {
6078 SV * const tsv = newSV(0);
6079 sv_gets(tsv, fp, 0);
6080 sv_utf8_upgrade_nomg(tsv);
6081 SvCUR_set(sv,append);
6084 goto return_string_or_null;
6089 if (PerlIO_isutf8(fp))
6092 if (IN_PERL_COMPILETIME) {
6093 /* we always read code in line mode */
6097 else if (RsSNARF(PL_rs)) {
6098 /* If it is a regular disk file use size from stat() as estimate
6099 of amount we are going to read - may result in malloc-ing
6100 more memory than we realy need if layers bellow reduce
6101 size we read (e.g. CRLF or a gzip layer)
6104 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6105 const Off_t offset = PerlIO_tell(fp);
6106 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6107 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6113 else if (RsRECORD(PL_rs)) {
6117 /* Grab the size of the record we're getting */
6118 recsize = SvIV(SvRV(PL_rs));
6119 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6122 /* VMS wants read instead of fread, because fread doesn't respect */
6123 /* RMS record boundaries. This is not necessarily a good thing to be */
6124 /* doing, but we've got no other real choice - except avoid stdio
6125 as implementation - perhaps write a :vms layer ?
6127 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6129 bytesread = PerlIO_read(fp, buffer, recsize);
6133 SvCUR_set(sv, bytesread += append);
6134 buffer[bytesread] = '\0';
6135 goto return_string_or_null;
6137 else if (RsPARA(PL_rs)) {
6143 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6144 if (PerlIO_isutf8(fp)) {
6145 rsptr = SvPVutf8(PL_rs, rslen);
6148 if (SvUTF8(PL_rs)) {
6149 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6150 Perl_croak(aTHX_ "Wide character in $/");
6153 rsptr = SvPV_const(PL_rs, rslen);
6157 rslast = rslen ? rsptr[rslen - 1] : '\0';
6159 if (rspara) { /* have to do this both before and after */
6160 do { /* to make sure file boundaries work right */
6163 i = PerlIO_getc(fp);
6167 PerlIO_ungetc(fp,i);
6173 /* See if we know enough about I/O mechanism to cheat it ! */
6175 /* This used to be #ifdef test - it is made run-time test for ease
6176 of abstracting out stdio interface. One call should be cheap
6177 enough here - and may even be a macro allowing compile
6181 if (PerlIO_fast_gets(fp)) {
6184 * We're going to steal some values from the stdio struct
6185 * and put EVERYTHING in the innermost loop into registers.
6187 register STDCHAR *ptr;
6191 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6192 /* An ungetc()d char is handled separately from the regular
6193 * buffer, so we getc() it back out and stuff it in the buffer.
6195 i = PerlIO_getc(fp);
6196 if (i == EOF) return 0;
6197 *(--((*fp)->_ptr)) = (unsigned char) i;
6201 /* Here is some breathtakingly efficient cheating */
6203 cnt = PerlIO_get_cnt(fp); /* get count into register */
6204 /* make sure we have the room */
6205 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6206 /* Not room for all of it
6207 if we are looking for a separator and room for some
6209 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6210 /* just process what we have room for */
6211 shortbuffered = cnt - SvLEN(sv) + append + 1;
6212 cnt -= shortbuffered;
6216 /* remember that cnt can be negative */
6217 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6222 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6223 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6224 DEBUG_P(PerlIO_printf(Perl_debug_log,
6225 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6226 DEBUG_P(PerlIO_printf(Perl_debug_log,
6227 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6228 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6229 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6234 while (cnt > 0) { /* this | eat */
6236 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6237 goto thats_all_folks; /* screams | sed :-) */
6241 Copy(ptr, bp, cnt, char); /* this | eat */
6242 bp += cnt; /* screams | dust */
6243 ptr += cnt; /* louder | sed :-) */
6248 if (shortbuffered) { /* oh well, must extend */
6249 cnt = shortbuffered;
6251 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6253 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6254 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6258 DEBUG_P(PerlIO_printf(Perl_debug_log,
6259 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6260 PTR2UV(ptr),(long)cnt));
6261 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6263 DEBUG_P(PerlIO_printf(Perl_debug_log,
6264 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6265 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6266 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6268 /* This used to call 'filbuf' in stdio form, but as that behaves like
6269 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6270 another abstraction. */
6271 i = PerlIO_getc(fp); /* get more characters */
6273 DEBUG_P(PerlIO_printf(Perl_debug_log,
6274 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6275 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6276 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6278 cnt = PerlIO_get_cnt(fp);
6279 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6280 DEBUG_P(PerlIO_printf(Perl_debug_log,
6281 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6283 if (i == EOF) /* all done for ever? */
6284 goto thats_really_all_folks;
6286 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6288 SvGROW(sv, bpx + cnt + 2);
6289 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6291 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6293 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6294 goto thats_all_folks;
6298 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6299 memNE((char*)bp - rslen, rsptr, rslen))
6300 goto screamer; /* go back to the fray */
6301 thats_really_all_folks:
6303 cnt += shortbuffered;
6304 DEBUG_P(PerlIO_printf(Perl_debug_log,
6305 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6306 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6307 DEBUG_P(PerlIO_printf(Perl_debug_log,
6308 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6309 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6310 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6312 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6313 DEBUG_P(PerlIO_printf(Perl_debug_log,
6314 "Screamer: done, len=%ld, string=|%.*s|\n",
6315 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6319 /*The big, slow, and stupid way. */
6320 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6321 STDCHAR *buf = NULL;
6322 Newx(buf, 8192, STDCHAR);
6330 register const STDCHAR * const bpe = buf + sizeof(buf);
6332 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6333 ; /* keep reading */
6337 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6338 /* Accomodate broken VAXC compiler, which applies U8 cast to
6339 * both args of ?: operator, causing EOF to change into 255
6342 i = (U8)buf[cnt - 1];
6348 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6350 sv_catpvn(sv, (char *) buf, cnt);
6352 sv_setpvn(sv, (char *) buf, cnt);
6354 if (i != EOF && /* joy */
6356 SvCUR(sv) < rslen ||
6357 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6361 * If we're reading from a TTY and we get a short read,
6362 * indicating that the user hit his EOF character, we need
6363 * to notice it now, because if we try to read from the TTY
6364 * again, the EOF condition will disappear.
6366 * The comparison of cnt to sizeof(buf) is an optimization
6367 * that prevents unnecessary calls to feof().
6371 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6375 #ifdef USE_HEAP_INSTEAD_OF_STACK
6380 if (rspara) { /* have to do this both before and after */
6381 while (i != EOF) { /* to make sure file boundaries work right */
6382 i = PerlIO_getc(fp);
6384 PerlIO_ungetc(fp,i);
6390 return_string_or_null:
6391 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6397 Auto-increment of the value in the SV, doing string to numeric conversion
6398 if necessary. Handles 'get' magic.
6404 Perl_sv_inc(pTHX_ register SV *sv)
6413 if (SvTHINKFIRST(sv)) {
6415 sv_force_normal_flags(sv, 0);
6416 if (SvREADONLY(sv)) {
6417 if (IN_PERL_RUNTIME)
6418 Perl_croak(aTHX_ PL_no_modify);
6422 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6424 i = PTR2IV(SvRV(sv));
6429 flags = SvFLAGS(sv);
6430 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6431 /* It's (privately or publicly) a float, but not tested as an
6432 integer, so test it to see. */
6434 flags = SvFLAGS(sv);
6436 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6437 /* It's publicly an integer, or privately an integer-not-float */
6438 #ifdef PERL_PRESERVE_IVUV
6442 if (SvUVX(sv) == UV_MAX)
6443 sv_setnv(sv, UV_MAX_P1);
6445 (void)SvIOK_only_UV(sv);
6446 SvUV_set(sv, SvUVX(sv) + 1);
6448 if (SvIVX(sv) == IV_MAX)
6449 sv_setuv(sv, (UV)IV_MAX + 1);
6451 (void)SvIOK_only(sv);
6452 SvIV_set(sv, SvIVX(sv) + 1);
6457 if (flags & SVp_NOK) {
6458 (void)SvNOK_only(sv);
6459 SvNV_set(sv, SvNVX(sv) + 1.0);
6463 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6464 if ((flags & SVTYPEMASK) < SVt_PVIV)
6465 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6466 (void)SvIOK_only(sv);
6471 while (isALPHA(*d)) d++;
6472 while (isDIGIT(*d)) d++;
6474 #ifdef PERL_PRESERVE_IVUV
6475 /* Got to punt this as an integer if needs be, but we don't issue
6476 warnings. Probably ought to make the sv_iv_please() that does
6477 the conversion if possible, and silently. */
6478 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6479 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6480 /* Need to try really hard to see if it's an integer.
6481 9.22337203685478e+18 is an integer.
6482 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6483 so $a="9.22337203685478e+18"; $a+0; $a++
6484 needs to be the same as $a="9.22337203685478e+18"; $a++
6491 /* sv_2iv *should* have made this an NV */
6492 if (flags & SVp_NOK) {
6493 (void)SvNOK_only(sv);
6494 SvNV_set(sv, SvNVX(sv) + 1.0);
6497 /* I don't think we can get here. Maybe I should assert this
6498 And if we do get here I suspect that sv_setnv will croak. NWC
6500 #if defined(USE_LONG_DOUBLE)
6501 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",
6502 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6504 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6505 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6508 #endif /* PERL_PRESERVE_IVUV */
6509 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6513 while (d >= SvPVX_const(sv)) {
6521 /* MKS: The original code here died if letters weren't consecutive.
6522 * at least it didn't have to worry about non-C locales. The
6523 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6524 * arranged in order (although not consecutively) and that only
6525 * [A-Za-z] are accepted by isALPHA in the C locale.
6527 if (*d != 'z' && *d != 'Z') {
6528 do { ++*d; } while (!isALPHA(*d));
6531 *(d--) -= 'z' - 'a';
6536 *(d--) -= 'z' - 'a' + 1;
6540 /* oh,oh, the number grew */
6541 SvGROW(sv, SvCUR(sv) + 2);
6542 SvCUR_set(sv, SvCUR(sv) + 1);
6543 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6554 Auto-decrement of the value in the SV, doing string to numeric conversion
6555 if necessary. Handles 'get' magic.
6561 Perl_sv_dec(pTHX_ register SV *sv)
6569 if (SvTHINKFIRST(sv)) {
6571 sv_force_normal_flags(sv, 0);
6572 if (SvREADONLY(sv)) {
6573 if (IN_PERL_RUNTIME)
6574 Perl_croak(aTHX_ PL_no_modify);
6578 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6580 i = PTR2IV(SvRV(sv));
6585 /* Unlike sv_inc we don't have to worry about string-never-numbers
6586 and keeping them magic. But we mustn't warn on punting */
6587 flags = SvFLAGS(sv);
6588 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6589 /* It's publicly an integer, or privately an integer-not-float */
6590 #ifdef PERL_PRESERVE_IVUV
6594 if (SvUVX(sv) == 0) {
6595 (void)SvIOK_only(sv);
6599 (void)SvIOK_only_UV(sv);
6600 SvUV_set(sv, SvUVX(sv) - 1);
6603 if (SvIVX(sv) == IV_MIN)
6604 sv_setnv(sv, (NV)IV_MIN - 1.0);
6606 (void)SvIOK_only(sv);
6607 SvIV_set(sv, SvIVX(sv) - 1);
6612 if (flags & SVp_NOK) {
6613 SvNV_set(sv, SvNVX(sv) - 1.0);
6614 (void)SvNOK_only(sv);
6617 if (!(flags & SVp_POK)) {
6618 if ((flags & SVTYPEMASK) < SVt_PVIV)
6619 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6621 (void)SvIOK_only(sv);
6624 #ifdef PERL_PRESERVE_IVUV
6626 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6627 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6628 /* Need to try really hard to see if it's an integer.
6629 9.22337203685478e+18 is an integer.
6630 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6631 so $a="9.22337203685478e+18"; $a+0; $a--
6632 needs to be the same as $a="9.22337203685478e+18"; $a--
6639 /* sv_2iv *should* have made this an NV */
6640 if (flags & SVp_NOK) {
6641 (void)SvNOK_only(sv);
6642 SvNV_set(sv, SvNVX(sv) - 1.0);
6645 /* I don't think we can get here. Maybe I should assert this
6646 And if we do get here I suspect that sv_setnv will croak. NWC
6648 #if defined(USE_LONG_DOUBLE)
6649 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",
6650 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6652 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6653 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6657 #endif /* PERL_PRESERVE_IVUV */
6658 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6662 =for apidoc sv_mortalcopy
6664 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6665 The new SV is marked as mortal. It will be destroyed "soon", either by an
6666 explicit call to FREETMPS, or by an implicit call at places such as
6667 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6672 /* Make a string that will exist for the duration of the expression
6673 * evaluation. Actually, it may have to last longer than that, but
6674 * hopefully we won't free it until it has been assigned to a
6675 * permanent location. */
6678 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6684 sv_setsv(sv,oldstr);
6686 PL_tmps_stack[++PL_tmps_ix] = sv;
6692 =for apidoc sv_newmortal
6694 Creates a new null SV which is mortal. The reference count of the SV is
6695 set to 1. It will be destroyed "soon", either by an explicit call to
6696 FREETMPS, or by an implicit call at places such as statement boundaries.
6697 See also C<sv_mortalcopy> and C<sv_2mortal>.
6703 Perl_sv_newmortal(pTHX)
6709 SvFLAGS(sv) = SVs_TEMP;
6711 PL_tmps_stack[++PL_tmps_ix] = sv;
6716 =for apidoc sv_2mortal
6718 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6719 by an explicit call to FREETMPS, or by an implicit call at places such as
6720 statement boundaries. SvTEMP() is turned on which means that the SV's
6721 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6722 and C<sv_mortalcopy>.
6728 Perl_sv_2mortal(pTHX_ register SV *sv)
6733 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6736 PL_tmps_stack[++PL_tmps_ix] = sv;
6744 Creates a new SV and copies a string into it. The reference count for the
6745 SV is set to 1. If C<len> is zero, Perl will compute the length using
6746 strlen(). For efficiency, consider using C<newSVpvn> instead.
6752 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6758 sv_setpvn(sv,s,len ? len : strlen(s));
6763 =for apidoc newSVpvn
6765 Creates a new SV and copies a string into it. The reference count for the
6766 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6767 string. You are responsible for ensuring that the source string is at least
6768 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6774 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6780 sv_setpvn(sv,s,len);
6786 =for apidoc newSVhek
6788 Creates a new SV from the hash key structure. It will generate scalars that
6789 point to the shared string table where possible. Returns a new (undefined)
6790 SV if the hek is NULL.
6796 Perl_newSVhek(pTHX_ const HEK *hek)
6806 if (HEK_LEN(hek) == HEf_SVKEY) {
6807 return newSVsv(*(SV**)HEK_KEY(hek));
6809 const int flags = HEK_FLAGS(hek);
6810 if (flags & HVhek_WASUTF8) {
6812 Andreas would like keys he put in as utf8 to come back as utf8
6814 STRLEN utf8_len = HEK_LEN(hek);
6815 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6816 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6819 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6821 } else if (flags & HVhek_REHASH) {
6822 /* We don't have a pointer to the hv, so we have to replicate the
6823 flag into every HEK. This hv is using custom a hasing
6824 algorithm. Hence we can't return a shared string scalar, as
6825 that would contain the (wrong) hash value, and might get passed
6826 into an hv routine with a regular hash */
6828 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6833 /* This will be overwhelminly the most common case. */
6834 return newSVpvn_share(HEK_KEY(hek),
6835 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6841 =for apidoc newSVpvn_share
6843 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6844 table. If the string does not already exist in the table, it is created
6845 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6846 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6847 otherwise the hash is computed. The idea here is that as the string table
6848 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6849 hash lookup will avoid string compare.
6855 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6859 bool is_utf8 = FALSE;
6861 STRLEN tmplen = -len;
6863 /* See the note in hv.c:hv_fetch() --jhi */
6864 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6868 PERL_HASH(hash, src, len);
6870 sv_upgrade(sv, SVt_PV);
6871 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6883 #if defined(PERL_IMPLICIT_CONTEXT)
6885 /* pTHX_ magic can't cope with varargs, so this is a no-context
6886 * version of the main function, (which may itself be aliased to us).
6887 * Don't access this version directly.
6891 Perl_newSVpvf_nocontext(const char* pat, ...)
6896 va_start(args, pat);
6897 sv = vnewSVpvf(pat, &args);
6904 =for apidoc newSVpvf
6906 Creates a new SV and initializes it with the string formatted like
6913 Perl_newSVpvf(pTHX_ const char* pat, ...)
6917 va_start(args, pat);
6918 sv = vnewSVpvf(pat, &args);
6923 /* backend for newSVpvf() and newSVpvf_nocontext() */
6926 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6931 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
6938 Creates a new SV and copies a floating point value into it.
6939 The reference count for the SV is set to 1.
6945 Perl_newSVnv(pTHX_ NV n)
6958 Creates a new SV and copies an integer into it. The reference count for the
6965 Perl_newSViv(pTHX_ IV i)
6978 Creates a new SV and copies an unsigned integer into it.
6979 The reference count for the SV is set to 1.
6985 Perl_newSVuv(pTHX_ UV u)
6996 =for apidoc newRV_noinc
6998 Creates an RV wrapper for an SV. The reference count for the original
6999 SV is B<not> incremented.
7005 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7011 sv_upgrade(sv, SVt_RV);
7013 SvRV_set(sv, tmpRef);
7018 /* newRV_inc is the official function name to use now.
7019 * newRV_inc is in fact #defined to newRV in sv.h
7023 Perl_newRV(pTHX_ SV *sv)
7026 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7032 Creates a new SV which is an exact duplicate of the original SV.
7039 Perl_newSVsv(pTHX_ register SV *old)
7046 if (SvTYPE(old) == SVTYPEMASK) {
7047 if (ckWARN_d(WARN_INTERNAL))
7048 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7052 /* SV_GMAGIC is the default for sv_setv()
7053 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7054 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7055 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7060 =for apidoc sv_reset
7062 Underlying implementation for the C<reset> Perl function.
7063 Note that the perl-level function is vaguely deprecated.
7069 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7072 char todo[PERL_UCHAR_MAX+1];
7077 if (!*s) { /* reset ?? searches */
7078 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7080 PMOP *pm = (PMOP *) mg->mg_obj;
7082 pm->op_pmdynflags &= ~PMdf_USED;
7089 /* reset variables */
7091 if (!HvARRAY(stash))
7094 Zero(todo, 256, char);
7097 I32 i = (unsigned char)*s;
7101 max = (unsigned char)*s++;
7102 for ( ; i <= max; i++) {
7105 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7107 for (entry = HvARRAY(stash)[i];
7109 entry = HeNEXT(entry))
7114 if (!todo[(U8)*HeKEY(entry)])
7116 gv = (GV*)HeVAL(entry);
7119 if (SvTHINKFIRST(sv)) {
7120 if (!SvREADONLY(sv) && SvROK(sv))
7122 /* XXX Is this continue a bug? Why should THINKFIRST
7123 exempt us from resetting arrays and hashes? */
7127 if (SvTYPE(sv) >= SVt_PV) {
7129 if (SvPVX_const(sv) != NULL)
7137 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7139 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7142 # if defined(USE_ENVIRON_ARRAY)
7145 # endif /* USE_ENVIRON_ARRAY */
7156 Using various gambits, try to get an IO from an SV: the IO slot if its a
7157 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7158 named after the PV if we're a string.
7164 Perl_sv_2io(pTHX_ SV *sv)
7169 switch (SvTYPE(sv)) {
7177 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7181 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7183 return sv_2io(SvRV(sv));
7184 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7190 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7199 Using various gambits, try to get a CV from an SV; in addition, try if
7200 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7201 The flags in C<lref> are passed to sv_fetchsv.
7207 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7218 switch (SvTYPE(sv)) {
7237 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7238 tryAMAGICunDEREF(to_cv);
7241 if (SvTYPE(sv) == SVt_PVCV) {
7250 Perl_croak(aTHX_ "Not a subroutine reference");
7255 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7261 /* Some flags to gv_fetchsv mean don't really create the GV */
7262 if (SvTYPE(gv) != SVt_PVGV) {
7268 if (lref && !GvCVu(gv)) {
7272 gv_efullname3(tmpsv, gv, NULL);
7273 /* XXX this is probably not what they think they're getting.
7274 * It has the same effect as "sub name;", i.e. just a forward
7276 newSUB(start_subparse(FALSE, 0),
7277 newSVOP(OP_CONST, 0, tmpsv),
7281 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7291 Returns true if the SV has a true value by Perl's rules.
7292 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7293 instead use an in-line version.
7299 Perl_sv_true(pTHX_ register SV *sv)
7304 register const XPV* const tXpv = (XPV*)SvANY(sv);
7306 (tXpv->xpv_cur > 1 ||
7307 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7314 return SvIVX(sv) != 0;
7317 return SvNVX(sv) != 0.0;
7319 return sv_2bool(sv);
7325 =for apidoc sv_pvn_force
7327 Get a sensible string out of the SV somehow.
7328 A private implementation of the C<SvPV_force> macro for compilers which
7329 can't cope with complex macro expressions. Always use the macro instead.
7331 =for apidoc sv_pvn_force_flags
7333 Get a sensible string out of the SV somehow.
7334 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7335 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7336 implemented in terms of this function.
7337 You normally want to use the various wrapper macros instead: see
7338 C<SvPV_force> and C<SvPV_force_nomg>
7344 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7347 if (SvTHINKFIRST(sv) && !SvROK(sv))
7348 sv_force_normal_flags(sv, 0);
7358 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7359 const char * const ref = sv_reftype(sv,0);
7361 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7362 ref, OP_NAME(PL_op));
7364 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7366 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7367 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7369 s = sv_2pv_flags(sv, &len, flags);
7373 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7376 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7377 SvGROW(sv, len + 1);
7378 Move(s,SvPVX(sv),len,char);
7383 SvPOK_on(sv); /* validate pointer */
7385 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7386 PTR2UV(sv),SvPVX_const(sv)));
7389 return SvPVX_mutable(sv);
7393 =for apidoc sv_pvbyten_force
7395 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7401 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7403 sv_pvn_force(sv,lp);
7404 sv_utf8_downgrade(sv,0);
7410 =for apidoc sv_pvutf8n_force
7412 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7418 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7420 sv_pvn_force(sv,lp);
7421 sv_utf8_upgrade(sv);
7427 =for apidoc sv_reftype
7429 Returns a string describing what the SV is a reference to.
7435 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7437 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7438 inside return suggests a const propagation bug in g++. */
7439 if (ob && SvOBJECT(sv)) {
7440 char * const name = HvNAME_get(SvSTASH(sv));
7441 return name ? name : (char *) "__ANON__";
7444 switch (SvTYPE(sv)) {
7461 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7462 /* tied lvalues should appear to be
7463 * scalars for backwards compatitbility */
7464 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7465 ? "SCALAR" : "LVALUE");
7466 case SVt_PVAV: return "ARRAY";
7467 case SVt_PVHV: return "HASH";
7468 case SVt_PVCV: return "CODE";
7469 case SVt_PVGV: return "GLOB";
7470 case SVt_PVFM: return "FORMAT";
7471 case SVt_PVIO: return "IO";
7472 default: return "UNKNOWN";
7478 =for apidoc sv_isobject
7480 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7481 object. If the SV is not an RV, or if the object is not blessed, then this
7488 Perl_sv_isobject(pTHX_ SV *sv)
7504 Returns a boolean indicating whether the SV is blessed into the specified
7505 class. This does not check for subtypes; use C<sv_derived_from> to verify
7506 an inheritance relationship.
7512 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7523 hvname = HvNAME_get(SvSTASH(sv));
7527 return strEQ(hvname, name);
7533 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7534 it will be upgraded to one. If C<classname> is non-null then the new SV will
7535 be blessed in the specified package. The new SV is returned and its
7536 reference count is 1.
7542 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7549 SV_CHECK_THINKFIRST_COW_DROP(rv);
7552 if (SvTYPE(rv) >= SVt_PVMG) {
7553 const U32 refcnt = SvREFCNT(rv);
7557 SvREFCNT(rv) = refcnt;
7560 if (SvTYPE(rv) < SVt_RV)
7561 sv_upgrade(rv, SVt_RV);
7562 else if (SvTYPE(rv) > SVt_RV) {
7573 HV* const stash = gv_stashpv(classname, TRUE);
7574 (void)sv_bless(rv, stash);
7580 =for apidoc sv_setref_pv
7582 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7583 argument will be upgraded to an RV. That RV will be modified to point to
7584 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7585 into the SV. The C<classname> argument indicates the package for the
7586 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7587 will have a reference count of 1, and the RV will be returned.
7589 Do not use with other Perl types such as HV, AV, SV, CV, because those
7590 objects will become corrupted by the pointer copy process.
7592 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7598 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7602 sv_setsv(rv, &PL_sv_undef);
7606 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7611 =for apidoc sv_setref_iv
7613 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7614 argument will be upgraded to an RV. That RV will be modified to point to
7615 the new SV. The C<classname> argument indicates the package for the
7616 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7617 will have a reference count of 1, and the RV will be returned.
7623 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7625 sv_setiv(newSVrv(rv,classname), iv);
7630 =for apidoc sv_setref_uv
7632 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7633 argument will be upgraded to an RV. That RV will be modified to point to
7634 the new SV. The C<classname> argument indicates the package for the
7635 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7636 will have a reference count of 1, and the RV will be returned.
7642 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7644 sv_setuv(newSVrv(rv,classname), uv);
7649 =for apidoc sv_setref_nv
7651 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7652 argument will be upgraded to an RV. That RV will be modified to point to
7653 the new SV. The C<classname> argument indicates the package for the
7654 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7655 will have a reference count of 1, and the RV will be returned.
7661 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7663 sv_setnv(newSVrv(rv,classname), nv);
7668 =for apidoc sv_setref_pvn
7670 Copies a string into a new SV, optionally blessing the SV. The length of the
7671 string must be specified with C<n>. The C<rv> argument will be upgraded to
7672 an RV. That RV will be modified to point to the new SV. The C<classname>
7673 argument indicates the package for the blessing. Set C<classname> to
7674 C<NULL> to avoid the blessing. The new SV will have a reference count
7675 of 1, and the RV will be returned.
7677 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7683 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7685 sv_setpvn(newSVrv(rv,classname), pv, n);
7690 =for apidoc sv_bless
7692 Blesses an SV into a specified package. The SV must be an RV. The package
7693 must be designated by its stash (see C<gv_stashpv()>). The reference count
7694 of the SV is unaffected.
7700 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7705 Perl_croak(aTHX_ "Can't bless non-reference value");
7707 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7708 if (SvREADONLY(tmpRef))
7709 Perl_croak(aTHX_ PL_no_modify);
7710 if (SvOBJECT(tmpRef)) {
7711 if (SvTYPE(tmpRef) != SVt_PVIO)
7713 SvREFCNT_dec(SvSTASH(tmpRef));
7716 SvOBJECT_on(tmpRef);
7717 if (SvTYPE(tmpRef) != SVt_PVIO)
7719 SvUPGRADE(tmpRef, SVt_PVMG);
7720 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7727 if(SvSMAGICAL(tmpRef))
7728 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7736 /* Downgrades a PVGV to a PVMG.
7740 S_sv_unglob(pTHX_ SV *sv)
7744 SV * const temp = sv_newmortal();
7746 assert(SvTYPE(sv) == SVt_PVGV);
7748 gv_efullname3(temp, (GV *) sv, "*");
7754 sv_del_backref((SV*)GvSTASH(sv), sv);
7758 if (GvNAME_HEK(sv)) {
7759 unshare_hek(GvNAME_HEK(sv));
7763 /* need to keep SvANY(sv) in the right arena */
7764 xpvmg = new_XPVMG();
7765 StructCopy(SvANY(sv), xpvmg, XPVMG);
7766 del_XPVGV(SvANY(sv));
7769 SvFLAGS(sv) &= ~SVTYPEMASK;
7770 SvFLAGS(sv) |= SVt_PVMG;
7772 /* Intentionally not calling any local SET magic, as this isn't so much a
7773 set operation as merely an internal storage change. */
7774 sv_setsv_flags(sv, temp, 0);
7778 =for apidoc sv_unref_flags
7780 Unsets the RV status of the SV, and decrements the reference count of
7781 whatever was being referenced by the RV. This can almost be thought of
7782 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7783 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7784 (otherwise the decrementing is conditional on the reference count being
7785 different from one or the reference being a readonly SV).
7792 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7794 SV* const target = SvRV(ref);
7796 if (SvWEAKREF(ref)) {
7797 sv_del_backref(target, ref);
7799 SvRV_set(ref, NULL);
7802 SvRV_set(ref, NULL);
7804 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7805 assigned to as BEGIN {$a = \"Foo"} will fail. */
7806 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7807 SvREFCNT_dec(target);
7808 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7809 sv_2mortal(target); /* Schedule for freeing later */
7813 =for apidoc sv_untaint
7815 Untaint an SV. Use C<SvTAINTED_off> instead.
7820 Perl_sv_untaint(pTHX_ SV *sv)
7822 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7823 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7830 =for apidoc sv_tainted
7832 Test an SV for taintedness. Use C<SvTAINTED> instead.
7837 Perl_sv_tainted(pTHX_ SV *sv)
7839 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7840 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7841 if (mg && (mg->mg_len & 1) )
7848 =for apidoc sv_setpviv
7850 Copies an integer into the given SV, also updating its string value.
7851 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7857 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7859 char buf[TYPE_CHARS(UV)];
7861 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7863 sv_setpvn(sv, ptr, ebuf - ptr);
7867 =for apidoc sv_setpviv_mg
7869 Like C<sv_setpviv>, but also handles 'set' magic.
7875 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7881 #if defined(PERL_IMPLICIT_CONTEXT)
7883 /* pTHX_ magic can't cope with varargs, so this is a no-context
7884 * version of the main function, (which may itself be aliased to us).
7885 * Don't access this version directly.
7889 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7893 va_start(args, pat);
7894 sv_vsetpvf(sv, pat, &args);
7898 /* pTHX_ magic can't cope with varargs, so this is a no-context
7899 * version of the main function, (which may itself be aliased to us).
7900 * Don't access this version directly.
7904 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7908 va_start(args, pat);
7909 sv_vsetpvf_mg(sv, pat, &args);
7915 =for apidoc sv_setpvf
7917 Works like C<sv_catpvf> but copies the text into the SV instead of
7918 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7924 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7927 va_start(args, pat);
7928 sv_vsetpvf(sv, pat, &args);
7933 =for apidoc sv_vsetpvf
7935 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7936 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7938 Usually used via its frontend C<sv_setpvf>.
7944 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7946 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7950 =for apidoc sv_setpvf_mg
7952 Like C<sv_setpvf>, but also handles 'set' magic.
7958 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7961 va_start(args, pat);
7962 sv_vsetpvf_mg(sv, pat, &args);
7967 =for apidoc sv_vsetpvf_mg
7969 Like C<sv_vsetpvf>, but also handles 'set' magic.
7971 Usually used via its frontend C<sv_setpvf_mg>.
7977 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7979 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7983 #if defined(PERL_IMPLICIT_CONTEXT)
7985 /* pTHX_ magic can't cope with varargs, so this is a no-context
7986 * version of the main function, (which may itself be aliased to us).
7987 * Don't access this version directly.
7991 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7995 va_start(args, pat);
7996 sv_vcatpvf(sv, pat, &args);
8000 /* pTHX_ magic can't cope with varargs, so this is a no-context
8001 * version of the main function, (which may itself be aliased to us).
8002 * Don't access this version directly.
8006 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8010 va_start(args, pat);
8011 sv_vcatpvf_mg(sv, pat, &args);
8017 =for apidoc sv_catpvf
8019 Processes its arguments like C<sprintf> and appends the formatted
8020 output to an SV. If the appended data contains "wide" characters
8021 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8022 and characters >255 formatted with %c), the original SV might get
8023 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8024 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8025 valid UTF-8; if the original SV was bytes, the pattern should be too.
8030 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8033 va_start(args, pat);
8034 sv_vcatpvf(sv, pat, &args);
8039 =for apidoc sv_vcatpvf
8041 Processes its arguments like C<vsprintf> and appends the formatted output
8042 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8044 Usually used via its frontend C<sv_catpvf>.
8050 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8052 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8056 =for apidoc sv_catpvf_mg
8058 Like C<sv_catpvf>, but also handles 'set' magic.
8064 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8067 va_start(args, pat);
8068 sv_vcatpvf_mg(sv, pat, &args);
8073 =for apidoc sv_vcatpvf_mg
8075 Like C<sv_vcatpvf>, but also handles 'set' magic.
8077 Usually used via its frontend C<sv_catpvf_mg>.
8083 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8085 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8090 =for apidoc sv_vsetpvfn
8092 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8095 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8101 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8103 sv_setpvn(sv, "", 0);
8104 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8108 S_expect_number(pTHX_ char** pattern)
8112 switch (**pattern) {
8113 case '1': case '2': case '3':
8114 case '4': case '5': case '6':
8115 case '7': case '8': case '9':
8116 var = *(*pattern)++ - '0';
8117 while (isDIGIT(**pattern)) {
8118 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8120 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8128 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8130 const int neg = nv < 0;
8139 if (uv & 1 && uv == nv)
8140 uv--; /* Round to even */
8142 const unsigned dig = uv % 10;
8155 =for apidoc sv_vcatpvfn
8157 Processes its arguments like C<vsprintf> and appends the formatted output
8158 to an SV. Uses an array of SVs if the C style variable argument list is
8159 missing (NULL). When running with taint checks enabled, indicates via
8160 C<maybe_tainted> if results are untrustworthy (often due to the use of
8163 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8169 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8170 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8171 vec_utf8 = DO_UTF8(vecsv);
8173 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8176 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8184 static const char nullstr[] = "(null)";
8186 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8187 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8189 /* Times 4: a decimal digit takes more than 3 binary digits.
8190 * NV_DIG: mantissa takes than many decimal digits.
8191 * Plus 32: Playing safe. */
8192 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8193 /* large enough for "%#.#f" --chip */
8194 /* what about long double NVs? --jhi */
8196 PERL_UNUSED_ARG(maybe_tainted);
8198 /* no matter what, this is a string now */
8199 (void)SvPV_force(sv, origlen);
8201 /* special-case "", "%s", and "%-p" (SVf - see below) */
8204 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8206 const char * const s = va_arg(*args, char*);
8207 sv_catpv(sv, s ? s : nullstr);
8209 else if (svix < svmax) {
8210 sv_catsv(sv, *svargs);
8214 if (args && patlen == 3 && pat[0] == '%' &&
8215 pat[1] == '-' && pat[2] == 'p') {
8216 argsv = va_arg(*args, SV*);
8217 sv_catsv(sv, argsv);
8221 #ifndef USE_LONG_DOUBLE
8222 /* special-case "%.<number>[gf]" */
8223 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8224 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8225 unsigned digits = 0;
8229 while (*pp >= '0' && *pp <= '9')
8230 digits = 10 * digits + (*pp++ - '0');
8231 if (pp - pat == (int)patlen - 1) {
8239 /* Add check for digits != 0 because it seems that some
8240 gconverts are buggy in this case, and we don't yet have
8241 a Configure test for this. */
8242 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8243 /* 0, point, slack */
8244 Gconvert(nv, (int)digits, 0, ebuf);
8246 if (*ebuf) /* May return an empty string for digits==0 */
8249 } else if (!digits) {
8252 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8253 sv_catpvn(sv, p, l);
8259 #endif /* !USE_LONG_DOUBLE */
8261 if (!args && svix < svmax && DO_UTF8(*svargs))
8264 patend = (char*)pat + patlen;
8265 for (p = (char*)pat; p < patend; p = q) {
8268 bool vectorize = FALSE;
8269 bool vectorarg = FALSE;
8270 bool vec_utf8 = FALSE;
8276 bool has_precis = FALSE;
8278 const I32 osvix = svix;
8279 bool is_utf8 = FALSE; /* is this item utf8? */
8280 #ifdef HAS_LDBL_SPRINTF_BUG
8281 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8282 with sfio - Allen <allens@cpan.org> */
8283 bool fix_ldbl_sprintf_bug = FALSE;
8287 U8 utf8buf[UTF8_MAXBYTES+1];
8288 STRLEN esignlen = 0;
8290 const char *eptr = NULL;
8293 const U8 *vecstr = NULL;
8300 /* we need a long double target in case HAS_LONG_DOUBLE but
8303 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8311 const char *dotstr = ".";
8312 STRLEN dotstrlen = 1;
8313 I32 efix = 0; /* explicit format parameter index */
8314 I32 ewix = 0; /* explicit width index */
8315 I32 epix = 0; /* explicit precision index */
8316 I32 evix = 0; /* explicit vector index */
8317 bool asterisk = FALSE;
8319 /* echo everything up to the next format specification */
8320 for (q = p; q < patend && *q != '%'; ++q) ;
8322 if (has_utf8 && !pat_utf8)
8323 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8325 sv_catpvn(sv, p, q - p);
8332 We allow format specification elements in this order:
8333 \d+\$ explicit format parameter index
8335 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8336 0 flag (as above): repeated to allow "v02"
8337 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8338 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8340 [%bcdefginopsuxDFOUX] format (mandatory)
8345 As of perl5.9.3, printf format checking is on by default.
8346 Internally, perl uses %p formats to provide an escape to
8347 some extended formatting. This block deals with those
8348 extensions: if it does not match, (char*)q is reset and
8349 the normal format processing code is used.
8351 Currently defined extensions are:
8352 %p include pointer address (standard)
8353 %-p (SVf) include an SV (previously %_)
8354 %-<num>p include an SV with precision <num>
8355 %1p (VDf) include a v-string (as %vd)
8356 %<num>p reserved for future extensions
8358 Robin Barker 2005-07-14
8365 n = expect_number(&q);
8372 argsv = va_arg(*args, SV*);
8373 eptr = SvPVx_const(argsv, elen);
8379 else if (n == vdNUMBER) { /* VDf */
8386 if (ckWARN_d(WARN_INTERNAL))
8387 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8388 "internal %%<num>p might conflict with future printf extensions");
8394 if ( (width = expect_number(&q)) ) {
8435 if ( (ewix = expect_number(&q)) )
8444 if ((vectorarg = asterisk)) {
8457 width = expect_number(&q);
8463 vecsv = va_arg(*args, SV*);
8465 vecsv = (evix > 0 && evix <= svmax)
8466 ? svargs[evix-1] : &PL_sv_undef;
8468 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8470 dotstr = SvPV_const(vecsv, dotstrlen);
8471 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8472 bad with tied or overloaded values that return UTF8. */
8475 else if (has_utf8) {
8476 vecsv = sv_mortalcopy(vecsv);
8477 sv_utf8_upgrade(vecsv);
8478 dotstr = SvPV_const(vecsv, dotstrlen);
8485 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8486 vecsv = svargs[efix ? efix-1 : svix++];
8487 vecstr = (U8*)SvPV_const(vecsv,veclen);
8488 vec_utf8 = DO_UTF8(vecsv);
8490 /* if this is a version object, we need to convert
8491 * back into v-string notation and then let the
8492 * vectorize happen normally
8494 if (sv_derived_from(vecsv, "version")) {
8495 char *version = savesvpv(vecsv);
8496 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8497 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8498 "vector argument not supported with alpha versions");
8501 vecsv = sv_newmortal();
8502 /* scan_vstring is expected to be called during
8503 * tokenization, so we need to fake up the end
8504 * of the buffer for it
8506 PL_bufend = version + veclen;
8507 scan_vstring(version, vecsv);
8508 vecstr = (U8*)SvPV_const(vecsv, veclen);
8509 vec_utf8 = DO_UTF8(vecsv);
8521 i = va_arg(*args, int);
8523 i = (ewix ? ewix <= svmax : svix < svmax) ?
8524 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8526 width = (i < 0) ? -i : i;
8536 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8538 /* XXX: todo, support specified precision parameter */
8542 i = va_arg(*args, int);
8544 i = (ewix ? ewix <= svmax : svix < svmax)
8545 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8546 precis = (i < 0) ? 0 : i;
8551 precis = precis * 10 + (*q++ - '0');
8560 case 'I': /* Ix, I32x, and I64x */
8562 if (q[1] == '6' && q[2] == '4') {
8568 if (q[1] == '3' && q[2] == '2') {
8578 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8589 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8590 if (*(q + 1) == 'l') { /* lld, llf */
8616 if (!vectorize && !args) {
8618 const I32 i = efix-1;
8619 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8621 argsv = (svix >= 0 && svix < svmax)
8622 ? svargs[svix++] : &PL_sv_undef;
8633 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8635 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8637 eptr = (char*)utf8buf;
8638 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8652 eptr = va_arg(*args, char*);
8654 #ifdef MACOS_TRADITIONAL
8655 /* On MacOS, %#s format is used for Pascal strings */
8660 elen = strlen(eptr);
8662 eptr = (char *)nullstr;
8663 elen = sizeof nullstr - 1;
8667 eptr = SvPVx_const(argsv, elen);
8668 if (DO_UTF8(argsv)) {
8669 if (has_precis && precis < elen) {
8671 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8674 if (width) { /* fudge width (can't fudge elen) */
8675 width += elen - sv_len_utf8(argsv);
8682 if (has_precis && elen > precis)
8689 if (alt || vectorize)
8691 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8712 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8721 esignbuf[esignlen++] = plus;
8725 case 'h': iv = (short)va_arg(*args, int); break;
8726 case 'l': iv = va_arg(*args, long); break;
8727 case 'V': iv = va_arg(*args, IV); break;
8728 default: iv = va_arg(*args, int); break;
8730 case 'q': iv = va_arg(*args, Quad_t); break;
8735 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8737 case 'h': iv = (short)tiv; break;
8738 case 'l': iv = (long)tiv; break;
8740 default: iv = tiv; break;
8742 case 'q': iv = (Quad_t)tiv; break;
8746 if ( !vectorize ) /* we already set uv above */
8751 esignbuf[esignlen++] = plus;
8755 esignbuf[esignlen++] = '-';
8798 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8809 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8810 case 'l': uv = va_arg(*args, unsigned long); break;
8811 case 'V': uv = va_arg(*args, UV); break;
8812 default: uv = va_arg(*args, unsigned); break;
8814 case 'q': uv = va_arg(*args, Uquad_t); break;
8819 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8821 case 'h': uv = (unsigned short)tuv; break;
8822 case 'l': uv = (unsigned long)tuv; break;
8824 default: uv = tuv; break;
8826 case 'q': uv = (Uquad_t)tuv; break;
8833 char *ptr = ebuf + sizeof ebuf;
8839 p = (char*)((c == 'X')
8840 ? "0123456789ABCDEF" : "0123456789abcdef");
8846 esignbuf[esignlen++] = '0';
8847 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8855 if (alt && *ptr != '0')
8866 esignbuf[esignlen++] = '0';
8867 esignbuf[esignlen++] = 'b';
8870 default: /* it had better be ten or less */
8874 } while (uv /= base);
8877 elen = (ebuf + sizeof ebuf) - ptr;
8881 zeros = precis - elen;
8882 else if (precis == 0 && elen == 1 && *eptr == '0')
8888 /* FLOATING POINT */
8891 c = 'f'; /* maybe %F isn't supported here */
8899 /* This is evil, but floating point is even more evil */
8901 /* for SV-style calling, we can only get NV
8902 for C-style calling, we assume %f is double;
8903 for simplicity we allow any of %Lf, %llf, %qf for long double
8907 #if defined(USE_LONG_DOUBLE)
8911 /* [perl #20339] - we should accept and ignore %lf rather than die */
8915 #if defined(USE_LONG_DOUBLE)
8916 intsize = args ? 0 : 'q';
8920 #if defined(HAS_LONG_DOUBLE)
8929 /* now we need (long double) if intsize == 'q', else (double) */
8931 #if LONG_DOUBLESIZE > DOUBLESIZE
8933 va_arg(*args, long double) :
8934 va_arg(*args, double)
8936 va_arg(*args, double)
8941 if (c != 'e' && c != 'E') {
8943 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8944 will cast our (long double) to (double) */
8945 (void)Perl_frexp(nv, &i);
8946 if (i == PERL_INT_MIN)
8947 Perl_die(aTHX_ "panic: frexp");
8949 need = BIT_DIGITS(i);
8951 need += has_precis ? precis : 6; /* known default */
8956 #ifdef HAS_LDBL_SPRINTF_BUG
8957 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8958 with sfio - Allen <allens@cpan.org> */
8961 # define MY_DBL_MAX DBL_MAX
8962 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8963 # if DOUBLESIZE >= 8
8964 # define MY_DBL_MAX 1.7976931348623157E+308L
8966 # define MY_DBL_MAX 3.40282347E+38L
8970 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8971 # define MY_DBL_MAX_BUG 1L
8973 # define MY_DBL_MAX_BUG MY_DBL_MAX
8977 # define MY_DBL_MIN DBL_MIN
8978 # else /* XXX guessing! -Allen */
8979 # if DOUBLESIZE >= 8
8980 # define MY_DBL_MIN 2.2250738585072014E-308L
8982 # define MY_DBL_MIN 1.17549435E-38L
8986 if ((intsize == 'q') && (c == 'f') &&
8987 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8989 /* it's going to be short enough that
8990 * long double precision is not needed */
8992 if ((nv <= 0L) && (nv >= -0L))
8993 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8995 /* would use Perl_fp_class as a double-check but not
8996 * functional on IRIX - see perl.h comments */
8998 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8999 /* It's within the range that a double can represent */
9000 #if defined(DBL_MAX) && !defined(DBL_MIN)
9001 if ((nv >= ((long double)1/DBL_MAX)) ||
9002 (nv <= (-(long double)1/DBL_MAX)))
9004 fix_ldbl_sprintf_bug = TRUE;
9007 if (fix_ldbl_sprintf_bug == TRUE) {
9017 # undef MY_DBL_MAX_BUG
9020 #endif /* HAS_LDBL_SPRINTF_BUG */
9022 need += 20; /* fudge factor */
9023 if (PL_efloatsize < need) {
9024 Safefree(PL_efloatbuf);
9025 PL_efloatsize = need + 20; /* more fudge */
9026 Newx(PL_efloatbuf, PL_efloatsize, char);
9027 PL_efloatbuf[0] = '\0';
9030 if ( !(width || left || plus || alt) && fill != '0'
9031 && has_precis && intsize != 'q' ) { /* Shortcuts */
9032 /* See earlier comment about buggy Gconvert when digits,
9034 if ( c == 'g' && precis) {
9035 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9036 /* May return an empty string for digits==0 */
9037 if (*PL_efloatbuf) {
9038 elen = strlen(PL_efloatbuf);
9039 goto float_converted;
9041 } else if ( c == 'f' && !precis) {
9042 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9047 char *ptr = ebuf + sizeof ebuf;
9050 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9051 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9052 if (intsize == 'q') {
9053 /* Copy the one or more characters in a long double
9054 * format before the 'base' ([efgEFG]) character to
9055 * the format string. */
9056 static char const prifldbl[] = PERL_PRIfldbl;
9057 char const *p = prifldbl + sizeof(prifldbl) - 3;
9058 while (p >= prifldbl) { *--ptr = *p--; }
9063 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9068 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9080 /* No taint. Otherwise we are in the strange situation
9081 * where printf() taints but print($float) doesn't.
9083 #if defined(HAS_LONG_DOUBLE)
9084 elen = ((intsize == 'q')
9085 ? my_sprintf(PL_efloatbuf, ptr, nv)
9086 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9088 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9092 eptr = PL_efloatbuf;
9100 i = SvCUR(sv) - origlen;
9103 case 'h': *(va_arg(*args, short*)) = i; break;
9104 default: *(va_arg(*args, int*)) = i; break;
9105 case 'l': *(va_arg(*args, long*)) = i; break;
9106 case 'V': *(va_arg(*args, IV*)) = i; break;
9108 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9113 sv_setuv_mg(argsv, (UV)i);
9114 continue; /* not "break" */
9121 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9122 && ckWARN(WARN_PRINTF))
9124 SV * const msg = sv_newmortal();
9125 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9126 (PL_op->op_type == OP_PRTF) ? "" : "s");
9129 Perl_sv_catpvf(aTHX_ msg,
9130 "\"%%%c\"", c & 0xFF);
9132 Perl_sv_catpvf(aTHX_ msg,
9133 "\"%%\\%03"UVof"\"",
9136 sv_catpvs(msg, "end of string");
9137 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9140 /* output mangled stuff ... */
9146 /* ... right here, because formatting flags should not apply */
9147 SvGROW(sv, SvCUR(sv) + elen + 1);
9149 Copy(eptr, p, elen, char);
9152 SvCUR_set(sv, p - SvPVX_const(sv));
9154 continue; /* not "break" */
9157 /* calculate width before utf8_upgrade changes it */
9158 have = esignlen + zeros + elen;
9160 Perl_croak_nocontext(PL_memory_wrap);
9162 if (is_utf8 != has_utf8) {
9165 sv_utf8_upgrade(sv);
9168 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9169 sv_utf8_upgrade(nsv);
9170 eptr = SvPVX_const(nsv);
9173 SvGROW(sv, SvCUR(sv) + elen + 1);
9178 need = (have > width ? have : width);
9181 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9182 Perl_croak_nocontext(PL_memory_wrap);
9183 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9185 if (esignlen && fill == '0') {
9187 for (i = 0; i < (int)esignlen; i++)
9191 memset(p, fill, gap);
9194 if (esignlen && fill != '0') {
9196 for (i = 0; i < (int)esignlen; i++)
9201 for (i = zeros; i; i--)
9205 Copy(eptr, p, elen, char);
9209 memset(p, ' ', gap);
9214 Copy(dotstr, p, dotstrlen, char);
9218 vectorize = FALSE; /* done iterating over vecstr */
9225 SvCUR_set(sv, p - SvPVX_const(sv));
9233 /* =========================================================================
9235 =head1 Cloning an interpreter
9237 All the macros and functions in this section are for the private use of
9238 the main function, perl_clone().
9240 The foo_dup() functions make an exact copy of an existing foo thinngy.
9241 During the course of a cloning, a hash table is used to map old addresses
9242 to new addresses. The table is created and manipulated with the
9243 ptr_table_* functions.
9247 ============================================================================*/
9250 #if defined(USE_ITHREADS)
9252 #ifndef GpREFCNT_inc
9253 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9257 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9258 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9259 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9260 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9261 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9262 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9263 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9264 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9265 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9266 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9267 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9268 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9269 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9270 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9273 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9274 regcomp.c. AMS 20010712 */
9277 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9282 struct reg_substr_datum *s;
9285 return (REGEXP *)NULL;
9287 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9290 len = r->offsets[0];
9291 npar = r->nparens+1;
9293 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9294 Copy(r->program, ret->program, len+1, regnode);
9296 Newx(ret->startp, npar, I32);
9297 Copy(r->startp, ret->startp, npar, I32);
9298 Newx(ret->endp, npar, I32);
9299 Copy(r->startp, ret->startp, npar, I32);
9301 Newx(ret->substrs, 1, struct reg_substr_data);
9302 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9303 s->min_offset = r->substrs->data[i].min_offset;
9304 s->max_offset = r->substrs->data[i].max_offset;
9305 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9306 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9309 ret->regstclass = NULL;
9312 const int count = r->data->count;
9315 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9316 char, struct reg_data);
9317 Newx(d->what, count, U8);
9320 for (i = 0; i < count; i++) {
9321 d->what[i] = r->data->what[i];
9322 switch (d->what[i]) {
9323 /* legal options are one of: sfpont
9324 see also regcomp.h and pregfree() */
9326 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9329 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9332 /* This is cheating. */
9333 Newx(d->data[i], 1, struct regnode_charclass_class);
9334 StructCopy(r->data->data[i], d->data[i],
9335 struct regnode_charclass_class);
9336 ret->regstclass = (regnode*)d->data[i];
9339 /* Compiled op trees are readonly, and can thus be
9340 shared without duplication. */
9342 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9346 d->data[i] = r->data->data[i];
9349 d->data[i] = r->data->data[i];
9351 ((reg_trie_data*)d->data[i])->refcount++;
9355 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9364 Newx(ret->offsets, 2*len+1, U32);
9365 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9367 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9368 ret->refcnt = r->refcnt;
9369 ret->minlen = r->minlen;
9370 ret->prelen = r->prelen;
9371 ret->nparens = r->nparens;
9372 ret->lastparen = r->lastparen;
9373 ret->lastcloseparen = r->lastcloseparen;
9374 ret->reganch = r->reganch;
9376 ret->sublen = r->sublen;
9378 if (RX_MATCH_COPIED(ret))
9379 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9382 #ifdef PERL_OLD_COPY_ON_WRITE
9383 ret->saved_copy = NULL;
9386 ptr_table_store(PL_ptr_table, r, ret);
9390 /* duplicate a file handle */
9393 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9397 PERL_UNUSED_ARG(type);
9400 return (PerlIO*)NULL;
9402 /* look for it in the table first */
9403 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9407 /* create anew and remember what it is */
9408 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9409 ptr_table_store(PL_ptr_table, fp, ret);
9413 /* duplicate a directory handle */
9416 Perl_dirp_dup(pTHX_ DIR *dp)
9418 PERL_UNUSED_CONTEXT;
9425 /* duplicate a typeglob */
9428 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9434 /* look for it in the table first */
9435 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9439 /* create anew and remember what it is */
9441 ptr_table_store(PL_ptr_table, gp, ret);
9444 ret->gp_refcnt = 0; /* must be before any other dups! */
9445 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9446 ret->gp_io = io_dup_inc(gp->gp_io, param);
9447 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9448 ret->gp_av = av_dup_inc(gp->gp_av, param);
9449 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9450 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9451 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9452 ret->gp_cvgen = gp->gp_cvgen;
9453 ret->gp_line = gp->gp_line;
9454 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9458 /* duplicate a chain of magic */
9461 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9463 MAGIC *mgprev = (MAGIC*)NULL;
9466 return (MAGIC*)NULL;
9467 /* look for it in the table first */
9468 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9472 for (; mg; mg = mg->mg_moremagic) {
9474 Newxz(nmg, 1, MAGIC);
9476 mgprev->mg_moremagic = nmg;
9479 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9480 nmg->mg_private = mg->mg_private;
9481 nmg->mg_type = mg->mg_type;
9482 nmg->mg_flags = mg->mg_flags;
9483 if (mg->mg_type == PERL_MAGIC_qr) {
9484 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9486 else if(mg->mg_type == PERL_MAGIC_backref) {
9487 /* The backref AV has its reference count deliberately bumped by
9489 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9491 else if (mg->mg_type == PERL_MAGIC_symtab) {
9492 nmg->mg_obj = mg->mg_obj;
9495 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9496 ? sv_dup_inc(mg->mg_obj, param)
9497 : sv_dup(mg->mg_obj, param);
9499 nmg->mg_len = mg->mg_len;
9500 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9501 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9502 if (mg->mg_len > 0) {
9503 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9504 if (mg->mg_type == PERL_MAGIC_overload_table &&
9505 AMT_AMAGIC((AMT*)mg->mg_ptr))
9507 const AMT * const amtp = (AMT*)mg->mg_ptr;
9508 AMT * const namtp = (AMT*)nmg->mg_ptr;
9510 for (i = 1; i < NofAMmeth; i++) {
9511 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9515 else if (mg->mg_len == HEf_SVKEY)
9516 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9518 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9519 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9526 /* create a new pointer-mapping table */
9529 Perl_ptr_table_new(pTHX)
9532 PERL_UNUSED_CONTEXT;
9534 Newxz(tbl, 1, PTR_TBL_t);
9537 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9541 #define PTR_TABLE_HASH(ptr) \
9542 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9545 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9546 following define) and at call to new_body_inline made below in
9547 Perl_ptr_table_store()
9550 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9552 /* map an existing pointer using a table */
9554 STATIC PTR_TBL_ENT_t *
9555 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9556 PTR_TBL_ENT_t *tblent;
9557 const UV hash = PTR_TABLE_HASH(sv);
9559 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9560 for (; tblent; tblent = tblent->next) {
9561 if (tblent->oldval == sv)
9568 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9570 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9571 PERL_UNUSED_CONTEXT;
9572 return tblent ? tblent->newval : (void *) 0;
9575 /* add a new entry to a pointer-mapping table */
9578 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9580 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9581 PERL_UNUSED_CONTEXT;
9584 tblent->newval = newsv;
9586 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9588 new_body_inline(tblent, PTE_SVSLOT);
9590 tblent->oldval = oldsv;
9591 tblent->newval = newsv;
9592 tblent->next = tbl->tbl_ary[entry];
9593 tbl->tbl_ary[entry] = tblent;
9595 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9596 ptr_table_split(tbl);
9600 /* double the hash bucket size of an existing ptr table */
9603 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9605 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9606 const UV oldsize = tbl->tbl_max + 1;
9607 UV newsize = oldsize * 2;
9609 PERL_UNUSED_CONTEXT;
9611 Renew(ary, newsize, PTR_TBL_ENT_t*);
9612 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9613 tbl->tbl_max = --newsize;
9615 for (i=0; i < oldsize; i++, ary++) {
9616 PTR_TBL_ENT_t **curentp, **entp, *ent;
9619 curentp = ary + oldsize;
9620 for (entp = ary, ent = *ary; ent; ent = *entp) {
9621 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9623 ent->next = *curentp;
9633 /* remove all the entries from a ptr table */
9636 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9638 if (tbl && tbl->tbl_items) {
9639 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9640 UV riter = tbl->tbl_max;
9643 PTR_TBL_ENT_t *entry = array[riter];
9646 PTR_TBL_ENT_t * const oentry = entry;
9647 entry = entry->next;
9656 /* clear and free a ptr table */
9659 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9664 ptr_table_clear(tbl);
9665 Safefree(tbl->tbl_ary);
9671 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9674 SvRV_set(dstr, SvWEAKREF(sstr)
9675 ? sv_dup(SvRV(sstr), param)
9676 : sv_dup_inc(SvRV(sstr), param));
9679 else if (SvPVX_const(sstr)) {
9680 /* Has something there */
9682 /* Normal PV - clone whole allocated space */
9683 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9684 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9685 /* Not that normal - actually sstr is copy on write.
9686 But we are a true, independant SV, so: */
9687 SvREADONLY_off(dstr);
9692 /* Special case - not normally malloced for some reason */
9693 if (isGV_with_GP(sstr)) {
9694 /* Don't need to do anything here. */
9696 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9697 /* A "shared" PV - clone it as "shared" PV */
9699 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9703 /* Some other special case - random pointer */
9704 SvPV_set(dstr, SvPVX(sstr));
9710 if (SvTYPE(dstr) == SVt_RV)
9711 SvRV_set(dstr, NULL);
9713 SvPV_set(dstr, NULL);
9717 /* duplicate an SV of any type (including AV, HV etc) */
9720 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9725 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9727 /* look for it in the table first */
9728 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9732 if(param->flags & CLONEf_JOIN_IN) {
9733 /** We are joining here so we don't want do clone
9734 something that is bad **/
9735 if (SvTYPE(sstr) == SVt_PVHV) {
9736 const char * const hvname = HvNAME_get(sstr);
9738 /** don't clone stashes if they already exist **/
9739 return (SV*)gv_stashpv(hvname,0);
9743 /* create anew and remember what it is */
9746 #ifdef DEBUG_LEAKING_SCALARS
9747 dstr->sv_debug_optype = sstr->sv_debug_optype;
9748 dstr->sv_debug_line = sstr->sv_debug_line;
9749 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9750 dstr->sv_debug_cloned = 1;
9751 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9754 ptr_table_store(PL_ptr_table, sstr, dstr);
9757 SvFLAGS(dstr) = SvFLAGS(sstr);
9758 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9759 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9762 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9763 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9764 PL_watch_pvx, SvPVX_const(sstr));
9767 /* don't clone objects whose class has asked us not to */
9768 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9769 SvFLAGS(dstr) &= ~SVTYPEMASK;
9774 switch (SvTYPE(sstr)) {
9779 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9780 SvIV_set(dstr, SvIVX(sstr));
9783 SvANY(dstr) = new_XNV();
9784 SvNV_set(dstr, SvNVX(sstr));
9787 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9788 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9792 /* These are all the types that need complex bodies allocating. */
9794 const svtype sv_type = SvTYPE(sstr);
9795 const struct body_details *const sv_type_details
9796 = bodies_by_type + sv_type;
9800 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9804 if (GvUNIQUE((GV*)sstr)) {
9805 /*EMPTY*/; /* Do sharing here, and fall through */
9818 assert(sv_type_details->body_size);
9819 if (sv_type_details->arena) {
9820 new_body_inline(new_body, sv_type);
9822 = (void*)((char*)new_body - sv_type_details->offset);
9824 new_body = new_NOARENA(sv_type_details);
9828 SvANY(dstr) = new_body;
9831 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9832 ((char*)SvANY(dstr)) + sv_type_details->offset,
9833 sv_type_details->copy, char);
9835 Copy(((char*)SvANY(sstr)),
9836 ((char*)SvANY(dstr)),
9837 sv_type_details->body_size + sv_type_details->offset, char);
9840 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9841 && !isGV_with_GP(dstr))
9842 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9844 /* The Copy above means that all the source (unduplicated) pointers
9845 are now in the destination. We can check the flags and the
9846 pointers in either, but it's possible that there's less cache
9847 missing by always going for the destination.
9848 FIXME - instrument and check that assumption */
9849 if (sv_type >= SVt_PVMG) {
9851 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9852 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9853 } else if (SvMAGIC(dstr))
9854 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9856 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9859 /* The cast silences a GCC warning about unhandled types. */
9860 switch ((int)sv_type) {
9872 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9873 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9874 LvTARG(dstr) = dstr;
9875 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9876 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9878 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9881 if (GvNAME_HEK(dstr))
9882 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9884 /* Don't call sv_add_backref here as it's going to be created
9885 as part of the magic cloning of the symbol table. */
9886 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9887 if(isGV_with_GP(sstr)) {
9888 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9889 at the point of this comment. */
9890 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9891 (void)GpREFCNT_inc(GvGP(dstr));
9893 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9896 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9897 if (IoOFP(dstr) == IoIFP(sstr))
9898 IoOFP(dstr) = IoIFP(dstr);
9900 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9901 /* PL_rsfp_filters entries have fake IoDIRP() */
9902 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9903 /* I have no idea why fake dirp (rsfps)
9904 should be treated differently but otherwise
9905 we end up with leaks -- sky*/
9906 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9907 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9908 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9910 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9911 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9912 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9914 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9917 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9920 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9921 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9922 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9925 if (AvARRAY((AV*)sstr)) {
9926 SV **dst_ary, **src_ary;
9927 SSize_t items = AvFILLp((AV*)sstr) + 1;
9929 src_ary = AvARRAY((AV*)sstr);
9930 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9931 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9932 SvPV_set(dstr, (char*)dst_ary);
9933 AvALLOC((AV*)dstr) = dst_ary;
9934 if (AvREAL((AV*)sstr)) {
9936 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9940 *dst_ary++ = sv_dup(*src_ary++, param);
9942 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9943 while (items-- > 0) {
9944 *dst_ary++ = &PL_sv_undef;
9948 SvPV_set(dstr, NULL);
9949 AvALLOC((AV*)dstr) = (SV**)NULL;
9956 if (HvARRAY((HV*)sstr)) {
9958 const bool sharekeys = !!HvSHAREKEYS(sstr);
9959 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9960 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9962 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9963 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9965 HvARRAY(dstr) = (HE**)darray;
9966 while (i <= sxhv->xhv_max) {
9967 const HE *source = HvARRAY(sstr)[i];
9968 HvARRAY(dstr)[i] = source
9969 ? he_dup(source, sharekeys, param) : 0;
9973 struct xpvhv_aux * const saux = HvAUX(sstr);
9974 struct xpvhv_aux * const daux = HvAUX(dstr);
9975 /* This flag isn't copied. */
9976 /* SvOOK_on(hv) attacks the IV flags. */
9977 SvFLAGS(dstr) |= SVf_OOK;
9979 hvname = saux->xhv_name;
9981 = hvname ? hek_dup(hvname, param) : hvname;
9983 daux->xhv_riter = saux->xhv_riter;
9984 daux->xhv_eiter = saux->xhv_eiter
9985 ? he_dup(saux->xhv_eiter,
9986 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9987 daux->xhv_backreferences = saux->xhv_backreferences
9988 ? (AV*) SvREFCNT_inc(
9996 SvPV_set(dstr, NULL);
9998 /* Record stashes for possible cloning in Perl_clone(). */
10000 av_push(param->stashes, dstr);
10004 if (!(param->flags & CLONEf_COPY_STACKS)) {
10008 /* NOTE: not refcounted */
10009 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10011 if (!CvISXSUB(dstr))
10012 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10014 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10015 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10016 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10017 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10019 /* don't dup if copying back - CvGV isn't refcounted, so the
10020 * duped GV may never be freed. A bit of a hack! DAPM */
10021 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10022 NULL : gv_dup(CvGV(dstr), param) ;
10023 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10025 CvWEAKOUTSIDE(sstr)
10026 ? cv_dup( CvOUTSIDE(dstr), param)
10027 : cv_dup_inc(CvOUTSIDE(dstr), param);
10028 if (!CvISXSUB(dstr))
10029 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10035 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10041 /* duplicate a context */
10044 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10046 PERL_CONTEXT *ncxs;
10049 return (PERL_CONTEXT*)NULL;
10051 /* look for it in the table first */
10052 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10056 /* create anew and remember what it is */
10057 Newxz(ncxs, max + 1, PERL_CONTEXT);
10058 ptr_table_store(PL_ptr_table, cxs, ncxs);
10061 PERL_CONTEXT * const cx = &cxs[ix];
10062 PERL_CONTEXT * const ncx = &ncxs[ix];
10063 ncx->cx_type = cx->cx_type;
10064 if (CxTYPE(cx) == CXt_SUBST) {
10065 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10068 ncx->blk_oldsp = cx->blk_oldsp;
10069 ncx->blk_oldcop = cx->blk_oldcop;
10070 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10071 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10072 ncx->blk_oldpm = cx->blk_oldpm;
10073 ncx->blk_gimme = cx->blk_gimme;
10074 switch (CxTYPE(cx)) {
10076 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10077 ? cv_dup_inc(cx->blk_sub.cv, param)
10078 : cv_dup(cx->blk_sub.cv,param));
10079 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10080 ? av_dup_inc(cx->blk_sub.argarray, param)
10082 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10083 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10084 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10085 ncx->blk_sub.lval = cx->blk_sub.lval;
10086 ncx->blk_sub.retop = cx->blk_sub.retop;
10089 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10090 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10091 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10092 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10093 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10094 ncx->blk_eval.retop = cx->blk_eval.retop;
10097 ncx->blk_loop.label = cx->blk_loop.label;
10098 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10099 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10100 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10101 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10102 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10103 ? cx->blk_loop.iterdata
10104 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10105 ncx->blk_loop.oldcomppad
10106 = (PAD*)ptr_table_fetch(PL_ptr_table,
10107 cx->blk_loop.oldcomppad);
10108 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10109 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10110 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10111 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10112 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10115 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10116 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10117 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10118 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10119 ncx->blk_sub.retop = cx->blk_sub.retop;
10131 /* duplicate a stack info structure */
10134 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10139 return (PERL_SI*)NULL;
10141 /* look for it in the table first */
10142 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10146 /* create anew and remember what it is */
10147 Newxz(nsi, 1, PERL_SI);
10148 ptr_table_store(PL_ptr_table, si, nsi);
10150 nsi->si_stack = av_dup_inc(si->si_stack, param);
10151 nsi->si_cxix = si->si_cxix;
10152 nsi->si_cxmax = si->si_cxmax;
10153 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10154 nsi->si_type = si->si_type;
10155 nsi->si_prev = si_dup(si->si_prev, param);
10156 nsi->si_next = si_dup(si->si_next, param);
10157 nsi->si_markoff = si->si_markoff;
10162 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10163 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10164 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10165 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10166 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10167 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10168 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10169 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10170 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10171 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10172 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10173 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10174 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10175 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10178 #define pv_dup_inc(p) SAVEPV(p)
10179 #define pv_dup(p) SAVEPV(p)
10180 #define svp_dup_inc(p,pp) any_dup(p,pp)
10182 /* map any object to the new equivent - either something in the
10183 * ptr table, or something in the interpreter structure
10187 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10192 return (void*)NULL;
10194 /* look for it in the table first */
10195 ret = ptr_table_fetch(PL_ptr_table, v);
10199 /* see if it is part of the interpreter structure */
10200 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10201 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10209 /* duplicate the save stack */
10212 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10214 ANY * const ss = proto_perl->Tsavestack;
10215 const I32 max = proto_perl->Tsavestack_max;
10216 I32 ix = proto_perl->Tsavestack_ix;
10228 void (*dptr) (void*);
10229 void (*dxptr) (pTHX_ void*);
10231 Newxz(nss, max, ANY);
10234 I32 i = POPINT(ss,ix);
10235 TOPINT(nss,ix) = i;
10237 case SAVEt_ITEM: /* normal string */
10238 sv = (SV*)POPPTR(ss,ix);
10239 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10240 sv = (SV*)POPPTR(ss,ix);
10241 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10243 case SAVEt_SV: /* scalar reference */
10244 sv = (SV*)POPPTR(ss,ix);
10245 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10246 gv = (GV*)POPPTR(ss,ix);
10247 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10249 case SAVEt_GENERIC_PVREF: /* generic char* */
10250 c = (char*)POPPTR(ss,ix);
10251 TOPPTR(nss,ix) = pv_dup(c);
10252 ptr = POPPTR(ss,ix);
10253 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10255 case SAVEt_SHARED_PVREF: /* char* in shared space */
10256 c = (char*)POPPTR(ss,ix);
10257 TOPPTR(nss,ix) = savesharedpv(c);
10258 ptr = POPPTR(ss,ix);
10259 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10261 case SAVEt_GENERIC_SVREF: /* generic sv */
10262 case SAVEt_SVREF: /* scalar reference */
10263 sv = (SV*)POPPTR(ss,ix);
10264 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10265 ptr = POPPTR(ss,ix);
10266 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10268 case SAVEt_AV: /* array reference */
10269 av = (AV*)POPPTR(ss,ix);
10270 TOPPTR(nss,ix) = av_dup_inc(av, param);
10271 gv = (GV*)POPPTR(ss,ix);
10272 TOPPTR(nss,ix) = gv_dup(gv, param);
10274 case SAVEt_HV: /* hash reference */
10275 hv = (HV*)POPPTR(ss,ix);
10276 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10277 gv = (GV*)POPPTR(ss,ix);
10278 TOPPTR(nss,ix) = gv_dup(gv, param);
10280 case SAVEt_INT: /* int reference */
10281 ptr = POPPTR(ss,ix);
10282 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10283 intval = (int)POPINT(ss,ix);
10284 TOPINT(nss,ix) = intval;
10286 case SAVEt_LONG: /* long reference */
10287 ptr = POPPTR(ss,ix);
10288 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10289 longval = (long)POPLONG(ss,ix);
10290 TOPLONG(nss,ix) = longval;
10292 case SAVEt_I32: /* I32 reference */
10293 case SAVEt_I16: /* I16 reference */
10294 case SAVEt_I8: /* I8 reference */
10295 ptr = POPPTR(ss,ix);
10296 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10298 TOPINT(nss,ix) = i;
10300 case SAVEt_IV: /* IV reference */
10301 ptr = POPPTR(ss,ix);
10302 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10304 TOPIV(nss,ix) = iv;
10306 case SAVEt_SPTR: /* SV* reference */
10307 ptr = POPPTR(ss,ix);
10308 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10309 sv = (SV*)POPPTR(ss,ix);
10310 TOPPTR(nss,ix) = sv_dup(sv, param);
10312 case SAVEt_VPTR: /* random* reference */
10313 ptr = POPPTR(ss,ix);
10314 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10315 ptr = POPPTR(ss,ix);
10316 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10318 case SAVEt_PPTR: /* char* reference */
10319 ptr = POPPTR(ss,ix);
10320 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10321 c = (char*)POPPTR(ss,ix);
10322 TOPPTR(nss,ix) = pv_dup(c);
10324 case SAVEt_HPTR: /* HV* reference */
10325 ptr = POPPTR(ss,ix);
10326 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10327 hv = (HV*)POPPTR(ss,ix);
10328 TOPPTR(nss,ix) = hv_dup(hv, param);
10330 case SAVEt_APTR: /* AV* reference */
10331 ptr = POPPTR(ss,ix);
10332 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10333 av = (AV*)POPPTR(ss,ix);
10334 TOPPTR(nss,ix) = av_dup(av, param);
10337 gv = (GV*)POPPTR(ss,ix);
10338 TOPPTR(nss,ix) = gv_dup(gv, param);
10340 case SAVEt_GP: /* scalar reference */
10341 gp = (GP*)POPPTR(ss,ix);
10342 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10343 (void)GpREFCNT_inc(gp);
10344 gv = (GV*)POPPTR(ss,ix);
10345 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10346 c = (char*)POPPTR(ss,ix);
10347 TOPPTR(nss,ix) = pv_dup(c);
10349 TOPIV(nss,ix) = iv;
10351 TOPIV(nss,ix) = iv;
10354 case SAVEt_MORTALIZESV:
10355 sv = (SV*)POPPTR(ss,ix);
10356 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10359 ptr = POPPTR(ss,ix);
10360 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10361 /* these are assumed to be refcounted properly */
10363 switch (((OP*)ptr)->op_type) {
10365 case OP_LEAVESUBLV:
10369 case OP_LEAVEWRITE:
10370 TOPPTR(nss,ix) = ptr;
10375 TOPPTR(nss,ix) = NULL;
10380 TOPPTR(nss,ix) = NULL;
10383 c = (char*)POPPTR(ss,ix);
10384 TOPPTR(nss,ix) = pv_dup_inc(c);
10386 case SAVEt_CLEARSV:
10387 longval = POPLONG(ss,ix);
10388 TOPLONG(nss,ix) = longval;
10391 hv = (HV*)POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10393 c = (char*)POPPTR(ss,ix);
10394 TOPPTR(nss,ix) = pv_dup_inc(c);
10396 TOPINT(nss,ix) = i;
10398 case SAVEt_DESTRUCTOR:
10399 ptr = POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10401 dptr = POPDPTR(ss,ix);
10402 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10403 any_dup(FPTR2DPTR(void *, dptr),
10406 case SAVEt_DESTRUCTOR_X:
10407 ptr = POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10409 dxptr = POPDXPTR(ss,ix);
10410 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10411 any_dup(FPTR2DPTR(void *, dxptr),
10414 case SAVEt_REGCONTEXT:
10417 TOPINT(nss,ix) = i;
10420 case SAVEt_STACK_POS: /* Position on Perl stack */
10422 TOPINT(nss,ix) = i;
10424 case SAVEt_AELEM: /* array element */
10425 sv = (SV*)POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10428 TOPINT(nss,ix) = i;
10429 av = (AV*)POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = av_dup_inc(av, param);
10432 case SAVEt_HELEM: /* hash element */
10433 sv = (SV*)POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10435 sv = (SV*)POPPTR(ss,ix);
10436 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10437 hv = (HV*)POPPTR(ss,ix);
10438 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10441 ptr = POPPTR(ss,ix);
10442 TOPPTR(nss,ix) = ptr;
10446 TOPINT(nss,ix) = i;
10448 case SAVEt_COMPPAD:
10449 av = (AV*)POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = av_dup(av, param);
10453 longval = (long)POPLONG(ss,ix);
10454 TOPLONG(nss,ix) = longval;
10455 ptr = POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10457 sv = (SV*)POPPTR(ss,ix);
10458 TOPPTR(nss,ix) = sv_dup(sv, param);
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10463 longval = (long)POPBOOL(ss,ix);
10464 TOPBOOL(nss,ix) = (bool)longval;
10466 case SAVEt_SET_SVFLAGS:
10468 TOPINT(nss,ix) = i;
10470 TOPINT(nss,ix) = i;
10471 sv = (SV*)POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = sv_dup(sv, param);
10475 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10483 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10484 * flag to the result. This is done for each stash before cloning starts,
10485 * so we know which stashes want their objects cloned */
10488 do_mark_cloneable_stash(pTHX_ SV *sv)
10490 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10492 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10493 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10494 if (cloner && GvCV(cloner)) {
10501 XPUSHs(sv_2mortal(newSVhek(hvname)));
10503 call_sv((SV*)GvCV(cloner), G_SCALAR);
10510 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10518 =for apidoc perl_clone
10520 Create and return a new interpreter by cloning the current one.
10522 perl_clone takes these flags as parameters:
10524 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10525 without it we only clone the data and zero the stacks,
10526 with it we copy the stacks and the new perl interpreter is
10527 ready to run at the exact same point as the previous one.
10528 The pseudo-fork code uses COPY_STACKS while the
10529 threads->new doesn't.
10531 CLONEf_KEEP_PTR_TABLE
10532 perl_clone keeps a ptr_table with the pointer of the old
10533 variable as a key and the new variable as a value,
10534 this allows it to check if something has been cloned and not
10535 clone it again but rather just use the value and increase the
10536 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10537 the ptr_table using the function
10538 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10539 reason to keep it around is if you want to dup some of your own
10540 variable who are outside the graph perl scans, example of this
10541 code is in threads.xs create
10544 This is a win32 thing, it is ignored on unix, it tells perls
10545 win32host code (which is c++) to clone itself, this is needed on
10546 win32 if you want to run two threads at the same time,
10547 if you just want to do some stuff in a separate perl interpreter
10548 and then throw it away and return to the original one,
10549 you don't need to do anything.
10554 /* XXX the above needs expanding by someone who actually understands it ! */
10555 EXTERN_C PerlInterpreter *
10556 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10559 perl_clone(PerlInterpreter *proto_perl, UV flags)
10562 #ifdef PERL_IMPLICIT_SYS
10564 /* perlhost.h so we need to call into it
10565 to clone the host, CPerlHost should have a c interface, sky */
10567 if (flags & CLONEf_CLONE_HOST) {
10568 return perl_clone_host(proto_perl,flags);
10570 return perl_clone_using(proto_perl, flags,
10572 proto_perl->IMemShared,
10573 proto_perl->IMemParse,
10575 proto_perl->IStdIO,
10579 proto_perl->IProc);
10583 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10584 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10585 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10586 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10587 struct IPerlDir* ipD, struct IPerlSock* ipS,
10588 struct IPerlProc* ipP)
10590 /* XXX many of the string copies here can be optimized if they're
10591 * constants; they need to be allocated as common memory and just
10592 * their pointers copied. */
10595 CLONE_PARAMS clone_params;
10596 CLONE_PARAMS* const param = &clone_params;
10598 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10599 /* for each stash, determine whether its objects should be cloned */
10600 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10601 PERL_SET_THX(my_perl);
10604 Poison(my_perl, 1, PerlInterpreter);
10610 PL_savestack_ix = 0;
10611 PL_savestack_max = -1;
10612 PL_sig_pending = 0;
10613 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10614 # else /* !DEBUGGING */
10615 Zero(my_perl, 1, PerlInterpreter);
10616 # endif /* DEBUGGING */
10618 /* host pointers */
10620 PL_MemShared = ipMS;
10621 PL_MemParse = ipMP;
10628 #else /* !PERL_IMPLICIT_SYS */
10630 CLONE_PARAMS clone_params;
10631 CLONE_PARAMS* param = &clone_params;
10632 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10633 /* for each stash, determine whether its objects should be cloned */
10634 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10635 PERL_SET_THX(my_perl);
10638 Poison(my_perl, 1, PerlInterpreter);
10644 PL_savestack_ix = 0;
10645 PL_savestack_max = -1;
10646 PL_sig_pending = 0;
10647 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10648 # else /* !DEBUGGING */
10649 Zero(my_perl, 1, PerlInterpreter);
10650 # endif /* DEBUGGING */
10651 #endif /* PERL_IMPLICIT_SYS */
10652 param->flags = flags;
10653 param->proto_perl = proto_perl;
10655 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10657 PL_body_arenas = NULL;
10658 Zero(&PL_body_roots, 1, PL_body_roots);
10660 PL_nice_chunk = NULL;
10661 PL_nice_chunk_size = 0;
10663 PL_sv_objcount = 0;
10665 PL_sv_arenaroot = NULL;
10667 PL_debug = proto_perl->Idebug;
10669 PL_hash_seed = proto_perl->Ihash_seed;
10670 PL_rehash_seed = proto_perl->Irehash_seed;
10672 #ifdef USE_REENTRANT_API
10673 /* XXX: things like -Dm will segfault here in perlio, but doing
10674 * PERL_SET_CONTEXT(proto_perl);
10675 * breaks too many other things
10677 Perl_reentrant_init(aTHX);
10680 /* create SV map for pointer relocation */
10681 PL_ptr_table = ptr_table_new();
10683 /* initialize these special pointers as early as possible */
10684 SvANY(&PL_sv_undef) = NULL;
10685 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10686 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10687 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10689 SvANY(&PL_sv_no) = new_XPVNV();
10690 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10691 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10692 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10693 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10694 SvCUR_set(&PL_sv_no, 0);
10695 SvLEN_set(&PL_sv_no, 1);
10696 SvIV_set(&PL_sv_no, 0);
10697 SvNV_set(&PL_sv_no, 0);
10698 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10700 SvANY(&PL_sv_yes) = new_XPVNV();
10701 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10702 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10703 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10704 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10705 SvCUR_set(&PL_sv_yes, 1);
10706 SvLEN_set(&PL_sv_yes, 2);
10707 SvIV_set(&PL_sv_yes, 1);
10708 SvNV_set(&PL_sv_yes, 1);
10709 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10711 /* create (a non-shared!) shared string table */
10712 PL_strtab = newHV();
10713 HvSHAREKEYS_off(PL_strtab);
10714 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10715 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10717 PL_compiling = proto_perl->Icompiling;
10719 /* These two PVs will be free'd special way so must set them same way op.c does */
10720 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10721 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10723 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10724 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10726 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10727 if (!specialWARN(PL_compiling.cop_warnings))
10728 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10729 if (!specialCopIO(PL_compiling.cop_io))
10730 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10731 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10733 /* pseudo environmental stuff */
10734 PL_origargc = proto_perl->Iorigargc;
10735 PL_origargv = proto_perl->Iorigargv;
10737 param->stashes = newAV(); /* Setup array of objects to call clone on */
10739 /* Set tainting stuff before PerlIO_debug can possibly get called */
10740 PL_tainting = proto_perl->Itainting;
10741 PL_taint_warn = proto_perl->Itaint_warn;
10743 #ifdef PERLIO_LAYERS
10744 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10745 PerlIO_clone(aTHX_ proto_perl, param);
10748 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10749 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10750 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10751 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10752 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10753 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10756 PL_minus_c = proto_perl->Iminus_c;
10757 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10758 PL_localpatches = proto_perl->Ilocalpatches;
10759 PL_splitstr = proto_perl->Isplitstr;
10760 PL_preprocess = proto_perl->Ipreprocess;
10761 PL_minus_n = proto_perl->Iminus_n;
10762 PL_minus_p = proto_perl->Iminus_p;
10763 PL_minus_l = proto_perl->Iminus_l;
10764 PL_minus_a = proto_perl->Iminus_a;
10765 PL_minus_E = proto_perl->Iminus_E;
10766 PL_minus_F = proto_perl->Iminus_F;
10767 PL_doswitches = proto_perl->Idoswitches;
10768 PL_dowarn = proto_perl->Idowarn;
10769 PL_doextract = proto_perl->Idoextract;
10770 PL_sawampersand = proto_perl->Isawampersand;
10771 PL_unsafe = proto_perl->Iunsafe;
10772 PL_inplace = SAVEPV(proto_perl->Iinplace);
10773 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10774 PL_perldb = proto_perl->Iperldb;
10775 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10776 PL_exit_flags = proto_perl->Iexit_flags;
10778 /* magical thingies */
10779 /* XXX time(&PL_basetime) when asked for? */
10780 PL_basetime = proto_perl->Ibasetime;
10781 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10783 PL_maxsysfd = proto_perl->Imaxsysfd;
10784 PL_multiline = proto_perl->Imultiline;
10785 PL_statusvalue = proto_perl->Istatusvalue;
10787 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10789 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10791 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10793 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10794 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10795 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10797 /* Clone the regex array */
10798 PL_regex_padav = newAV();
10800 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10801 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10803 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10804 for(i = 1; i <= len; i++) {
10805 const SV * const regex = regexen[i];
10808 ? sv_dup_inc(regex, param)
10810 newSViv(PTR2IV(re_dup(
10811 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10813 av_push(PL_regex_padav, sv);
10816 PL_regex_pad = AvARRAY(PL_regex_padav);
10818 /* shortcuts to various I/O objects */
10819 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10820 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10821 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10822 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10823 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10824 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10826 /* shortcuts to regexp stuff */
10827 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10829 /* shortcuts to misc objects */
10830 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10832 /* shortcuts to debugging objects */
10833 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10834 PL_DBline = gv_dup(proto_perl->IDBline, param);
10835 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10836 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10837 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10838 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10839 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10840 PL_lineary = av_dup(proto_perl->Ilineary, param);
10841 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10843 /* symbol tables */
10844 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10845 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10846 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10847 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10848 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10850 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10851 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10852 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10853 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10854 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10855 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10857 PL_sub_generation = proto_perl->Isub_generation;
10859 /* funky return mechanisms */
10860 PL_forkprocess = proto_perl->Iforkprocess;
10862 /* subprocess state */
10863 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10865 /* internal state */
10866 PL_maxo = proto_perl->Imaxo;
10867 if (proto_perl->Iop_mask)
10868 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10871 /* PL_asserting = proto_perl->Iasserting; */
10873 /* current interpreter roots */
10874 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10875 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10876 PL_main_start = proto_perl->Imain_start;
10877 PL_eval_root = proto_perl->Ieval_root;
10878 PL_eval_start = proto_perl->Ieval_start;
10880 /* runtime control stuff */
10881 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10882 PL_copline = proto_perl->Icopline;
10884 PL_filemode = proto_perl->Ifilemode;
10885 PL_lastfd = proto_perl->Ilastfd;
10886 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10889 PL_gensym = proto_perl->Igensym;
10890 PL_preambled = proto_perl->Ipreambled;
10891 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10892 PL_laststatval = proto_perl->Ilaststatval;
10893 PL_laststype = proto_perl->Ilaststype;
10896 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10898 /* interpreter atexit processing */
10899 PL_exitlistlen = proto_perl->Iexitlistlen;
10900 if (PL_exitlistlen) {
10901 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10902 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10905 PL_exitlist = (PerlExitListEntry*)NULL;
10907 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10908 if (PL_my_cxt_size) {
10909 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10910 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10913 PL_my_cxt_list = (void**)NULL;
10914 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10915 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10916 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10918 PL_profiledata = NULL;
10919 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10920 /* PL_rsfp_filters entries have fake IoDIRP() */
10921 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10923 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10925 PAD_CLONE_VARS(proto_perl, param);
10927 #ifdef HAVE_INTERP_INTERN
10928 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10931 /* more statics moved here */
10932 PL_generation = proto_perl->Igeneration;
10933 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10935 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10936 PL_in_clean_all = proto_perl->Iin_clean_all;
10938 PL_uid = proto_perl->Iuid;
10939 PL_euid = proto_perl->Ieuid;
10940 PL_gid = proto_perl->Igid;
10941 PL_egid = proto_perl->Iegid;
10942 PL_nomemok = proto_perl->Inomemok;
10943 PL_an = proto_perl->Ian;
10944 PL_evalseq = proto_perl->Ievalseq;
10945 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10946 PL_origalen = proto_perl->Iorigalen;
10947 #ifdef PERL_USES_PL_PIDSTATUS
10948 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10950 PL_osname = SAVEPV(proto_perl->Iosname);
10951 PL_sighandlerp = proto_perl->Isighandlerp;
10953 PL_runops = proto_perl->Irunops;
10955 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10958 PL_cshlen = proto_perl->Icshlen;
10959 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10962 PL_lex_state = proto_perl->Ilex_state;
10963 PL_lex_defer = proto_perl->Ilex_defer;
10964 PL_lex_expect = proto_perl->Ilex_expect;
10965 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10966 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10967 PL_lex_starts = proto_perl->Ilex_starts;
10968 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10969 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10970 PL_lex_op = proto_perl->Ilex_op;
10971 PL_lex_inpat = proto_perl->Ilex_inpat;
10972 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10973 PL_lex_brackets = proto_perl->Ilex_brackets;
10974 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10975 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10976 PL_lex_casemods = proto_perl->Ilex_casemods;
10977 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10978 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10981 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
10982 PL_lasttoke = proto_perl->Ilasttoke;
10983 PL_realtokenstart = proto_perl->Irealtokenstart;
10984 PL_faketokens = proto_perl->Ifaketokens;
10985 PL_thismad = proto_perl->Ithismad;
10986 PL_thistoken = proto_perl->Ithistoken;
10987 PL_thisopen = proto_perl->Ithisopen;
10988 PL_thisstuff = proto_perl->Ithisstuff;
10989 PL_thisclose = proto_perl->Ithisclose;
10990 PL_thiswhite = proto_perl->Ithiswhite;
10991 PL_nextwhite = proto_perl->Inextwhite;
10992 PL_skipwhite = proto_perl->Iskipwhite;
10993 PL_endwhite = proto_perl->Iendwhite;
10994 PL_curforce = proto_perl->Icurforce;
10996 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10997 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10998 PL_nexttoke = proto_perl->Inexttoke;
11001 /* XXX This is probably masking the deeper issue of why
11002 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11003 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11004 * (A little debugging with a watchpoint on it may help.)
11006 if (SvANY(proto_perl->Ilinestr)) {
11007 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11008 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11009 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11010 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11011 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11012 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11013 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11014 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11015 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11018 PL_linestr = newSV(79);
11019 sv_upgrade(PL_linestr,SVt_PVIV);
11020 sv_setpvn(PL_linestr,"",0);
11021 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11023 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11024 PL_pending_ident = proto_perl->Ipending_ident;
11025 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11027 PL_expect = proto_perl->Iexpect;
11029 PL_multi_start = proto_perl->Imulti_start;
11030 PL_multi_end = proto_perl->Imulti_end;
11031 PL_multi_open = proto_perl->Imulti_open;
11032 PL_multi_close = proto_perl->Imulti_close;
11034 PL_error_count = proto_perl->Ierror_count;
11035 PL_subline = proto_perl->Isubline;
11036 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11038 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11039 if (SvANY(proto_perl->Ilinestr)) {
11040 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11041 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11042 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11043 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11044 PL_last_lop_op = proto_perl->Ilast_lop_op;
11047 PL_last_uni = SvPVX(PL_linestr);
11048 PL_last_lop = SvPVX(PL_linestr);
11049 PL_last_lop_op = 0;
11051 PL_in_my = proto_perl->Iin_my;
11052 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11054 PL_cryptseen = proto_perl->Icryptseen;
11057 PL_hints = proto_perl->Ihints;
11059 PL_amagic_generation = proto_perl->Iamagic_generation;
11061 #ifdef USE_LOCALE_COLLATE
11062 PL_collation_ix = proto_perl->Icollation_ix;
11063 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11064 PL_collation_standard = proto_perl->Icollation_standard;
11065 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11066 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11067 #endif /* USE_LOCALE_COLLATE */
11069 #ifdef USE_LOCALE_NUMERIC
11070 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11071 PL_numeric_standard = proto_perl->Inumeric_standard;
11072 PL_numeric_local = proto_perl->Inumeric_local;
11073 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11074 #endif /* !USE_LOCALE_NUMERIC */
11076 /* utf8 character classes */
11077 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11078 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11079 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11080 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11081 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11082 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11083 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11084 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11085 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11086 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11087 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11088 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11089 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11090 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11091 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11092 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11093 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11094 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11095 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11096 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11098 /* Did the locale setup indicate UTF-8? */
11099 PL_utf8locale = proto_perl->Iutf8locale;
11100 /* Unicode features (see perlrun/-C) */
11101 PL_unicode = proto_perl->Iunicode;
11103 /* Pre-5.8 signals control */
11104 PL_signals = proto_perl->Isignals;
11106 /* times() ticks per second */
11107 PL_clocktick = proto_perl->Iclocktick;
11109 /* Recursion stopper for PerlIO_find_layer */
11110 PL_in_load_module = proto_perl->Iin_load_module;
11112 /* sort() routine */
11113 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11115 /* Not really needed/useful since the reenrant_retint is "volatile",
11116 * but do it for consistency's sake. */
11117 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11119 /* Hooks to shared SVs and locks. */
11120 PL_sharehook = proto_perl->Isharehook;
11121 PL_lockhook = proto_perl->Ilockhook;
11122 PL_unlockhook = proto_perl->Iunlockhook;
11123 PL_threadhook = proto_perl->Ithreadhook;
11125 PL_runops_std = proto_perl->Irunops_std;
11126 PL_runops_dbg = proto_perl->Irunops_dbg;
11128 #ifdef THREADS_HAVE_PIDS
11129 PL_ppid = proto_perl->Ippid;
11133 PL_last_swash_hv = NULL; /* reinits on demand */
11134 PL_last_swash_klen = 0;
11135 PL_last_swash_key[0]= '\0';
11136 PL_last_swash_tmps = (U8*)NULL;
11137 PL_last_swash_slen = 0;
11139 PL_glob_index = proto_perl->Iglob_index;
11140 PL_srand_called = proto_perl->Isrand_called;
11141 PL_uudmap['M'] = 0; /* reinits on demand */
11142 PL_bitcount = NULL; /* reinits on demand */
11144 if (proto_perl->Ipsig_pend) {
11145 Newxz(PL_psig_pend, SIG_SIZE, int);
11148 PL_psig_pend = (int*)NULL;
11151 if (proto_perl->Ipsig_ptr) {
11152 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11153 Newxz(PL_psig_name, SIG_SIZE, SV*);
11154 for (i = 1; i < SIG_SIZE; i++) {
11155 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11156 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11160 PL_psig_ptr = (SV**)NULL;
11161 PL_psig_name = (SV**)NULL;
11164 /* thrdvar.h stuff */
11166 if (flags & CLONEf_COPY_STACKS) {
11167 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11168 PL_tmps_ix = proto_perl->Ttmps_ix;
11169 PL_tmps_max = proto_perl->Ttmps_max;
11170 PL_tmps_floor = proto_perl->Ttmps_floor;
11171 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11173 while (i <= PL_tmps_ix) {
11174 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11178 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11179 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11180 Newxz(PL_markstack, i, I32);
11181 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11182 - proto_perl->Tmarkstack);
11183 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11184 - proto_perl->Tmarkstack);
11185 Copy(proto_perl->Tmarkstack, PL_markstack,
11186 PL_markstack_ptr - PL_markstack + 1, I32);
11188 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11189 * NOTE: unlike the others! */
11190 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11191 PL_scopestack_max = proto_perl->Tscopestack_max;
11192 Newxz(PL_scopestack, PL_scopestack_max, I32);
11193 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11195 /* NOTE: si_dup() looks at PL_markstack */
11196 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11198 /* PL_curstack = PL_curstackinfo->si_stack; */
11199 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11200 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11202 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11203 PL_stack_base = AvARRAY(PL_curstack);
11204 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11205 - proto_perl->Tstack_base);
11206 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11208 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11209 * NOTE: unlike the others! */
11210 PL_savestack_ix = proto_perl->Tsavestack_ix;
11211 PL_savestack_max = proto_perl->Tsavestack_max;
11212 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11213 PL_savestack = ss_dup(proto_perl, param);
11217 ENTER; /* perl_destruct() wants to LEAVE; */
11219 /* although we're not duplicating the tmps stack, we should still
11220 * add entries for any SVs on the tmps stack that got cloned by a
11221 * non-refcount means (eg a temp in @_); otherwise they will be
11224 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11225 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11226 proto_perl->Ttmps_stack[i]);
11227 if (nsv && !SvREFCNT(nsv)) {
11229 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11234 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11235 PL_top_env = &PL_start_env;
11237 PL_op = proto_perl->Top;
11240 PL_Xpv = (XPV*)NULL;
11241 PL_na = proto_perl->Tna;
11243 PL_statbuf = proto_perl->Tstatbuf;
11244 PL_statcache = proto_perl->Tstatcache;
11245 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11246 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11248 PL_timesbuf = proto_perl->Ttimesbuf;
11251 PL_tainted = proto_perl->Ttainted;
11252 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11253 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11254 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11255 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11256 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11257 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11258 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11259 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11260 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11262 PL_restartop = proto_perl->Trestartop;
11263 PL_in_eval = proto_perl->Tin_eval;
11264 PL_delaymagic = proto_perl->Tdelaymagic;
11265 PL_dirty = proto_perl->Tdirty;
11266 PL_localizing = proto_perl->Tlocalizing;
11268 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11269 PL_hv_fetch_ent_mh = NULL;
11270 PL_modcount = proto_perl->Tmodcount;
11271 PL_lastgotoprobe = NULL;
11272 PL_dumpindent = proto_perl->Tdumpindent;
11274 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11275 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11276 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11277 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11278 PL_efloatbuf = NULL; /* reinits on demand */
11279 PL_efloatsize = 0; /* reinits on demand */
11283 PL_screamfirst = NULL;
11284 PL_screamnext = NULL;
11285 PL_maxscream = -1; /* reinits on demand */
11286 PL_lastscream = NULL;
11288 PL_watchaddr = NULL;
11291 PL_regdummy = proto_perl->Tregdummy;
11292 PL_regprecomp = NULL;
11295 PL_colorset = 0; /* reinits PL_colors[] */
11296 /*PL_colors[6] = {0,0,0,0,0,0};*/
11297 PL_reginput = NULL;
11300 PL_regstartp = (I32*)NULL;
11301 PL_regendp = (I32*)NULL;
11302 PL_reglastparen = (U32*)NULL;
11303 PL_reglastcloseparen = (U32*)NULL;
11305 PL_reg_start_tmp = (char**)NULL;
11306 PL_reg_start_tmpl = 0;
11307 PL_regdata = (struct reg_data*)NULL;
11310 PL_reg_eval_set = 0;
11312 PL_regprogram = (regnode*)NULL;
11314 PL_regcc = (CURCUR*)NULL;
11315 PL_reg_call_cc = (struct re_cc_state*)NULL;
11316 PL_reg_re = (regexp*)NULL;
11317 PL_reg_ganch = NULL;
11319 PL_reg_match_utf8 = FALSE;
11320 PL_reg_magic = (MAGIC*)NULL;
11322 PL_reg_oldcurpm = (PMOP*)NULL;
11323 PL_reg_curpm = (PMOP*)NULL;
11324 PL_reg_oldsaved = NULL;
11325 PL_reg_oldsavedlen = 0;
11326 #ifdef PERL_OLD_COPY_ON_WRITE
11329 PL_reg_maxiter = 0;
11330 PL_reg_leftiter = 0;
11331 PL_reg_poscache = NULL;
11332 PL_reg_poscache_size= 0;
11334 /* RE engine - function pointers */
11335 PL_regcompp = proto_perl->Tregcompp;
11336 PL_regexecp = proto_perl->Tregexecp;
11337 PL_regint_start = proto_perl->Tregint_start;
11338 PL_regint_string = proto_perl->Tregint_string;
11339 PL_regfree = proto_perl->Tregfree;
11341 PL_reginterp_cnt = 0;
11342 PL_reg_starttry = 0;
11344 /* Pluggable optimizer */
11345 PL_peepp = proto_perl->Tpeepp;
11347 PL_stashcache = newHV();
11349 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11350 ptr_table_free(PL_ptr_table);
11351 PL_ptr_table = NULL;
11354 /* Call the ->CLONE method, if it exists, for each of the stashes
11355 identified by sv_dup() above.
11357 while(av_len(param->stashes) != -1) {
11358 HV* const stash = (HV*) av_shift(param->stashes);
11359 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11360 if (cloner && GvCV(cloner)) {
11365 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11367 call_sv((SV*)GvCV(cloner), G_DISCARD);
11373 SvREFCNT_dec(param->stashes);
11375 /* orphaned? eg threads->new inside BEGIN or use */
11376 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11377 SvREFCNT_inc_simple_void(PL_compcv);
11378 SAVEFREESV(PL_compcv);
11384 #endif /* USE_ITHREADS */
11387 =head1 Unicode Support
11389 =for apidoc sv_recode_to_utf8
11391 The encoding is assumed to be an Encode object, on entry the PV
11392 of the sv is assumed to be octets in that encoding, and the sv
11393 will be converted into Unicode (and UTF-8).
11395 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11396 is not a reference, nothing is done to the sv. If the encoding is not
11397 an C<Encode::XS> Encoding object, bad things will happen.
11398 (See F<lib/encoding.pm> and L<Encode>).
11400 The PV of the sv is returned.
11405 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11408 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11422 Passing sv_yes is wrong - it needs to be or'ed set of constants
11423 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11424 remove converted chars from source.
11426 Both will default the value - let them.
11428 XPUSHs(&PL_sv_yes);
11431 call_method("decode", G_SCALAR);
11435 s = SvPV_const(uni, len);
11436 if (s != SvPVX_const(sv)) {
11437 SvGROW(sv, len + 1);
11438 Move(s, SvPVX(sv), len + 1, char);
11439 SvCUR_set(sv, len);
11446 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11450 =for apidoc sv_cat_decode
11452 The encoding is assumed to be an Encode object, the PV of the ssv is
11453 assumed to be octets in that encoding and decoding the input starts
11454 from the position which (PV + *offset) pointed to. The dsv will be
11455 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11456 when the string tstr appears in decoding output or the input ends on
11457 the PV of the ssv. The value which the offset points will be modified
11458 to the last input position on the ssv.
11460 Returns TRUE if the terminator was found, else returns FALSE.
11465 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11466 SV *ssv, int *offset, char *tstr, int tlen)
11470 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11481 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11482 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11484 call_method("cat_decode", G_SCALAR);
11486 ret = SvTRUE(TOPs);
11487 *offset = SvIV(offsv);
11493 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11498 /* ---------------------------------------------------------------------
11500 * support functions for report_uninit()
11503 /* the maxiumum size of array or hash where we will scan looking
11504 * for the undefined element that triggered the warning */
11506 #define FUV_MAX_SEARCH_SIZE 1000
11508 /* Look for an entry in the hash whose value has the same SV as val;
11509 * If so, return a mortal copy of the key. */
11512 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11515 register HE **array;
11518 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11519 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11522 array = HvARRAY(hv);
11524 for (i=HvMAX(hv); i>0; i--) {
11525 register HE *entry;
11526 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11527 if (HeVAL(entry) != val)
11529 if ( HeVAL(entry) == &PL_sv_undef ||
11530 HeVAL(entry) == &PL_sv_placeholder)
11534 if (HeKLEN(entry) == HEf_SVKEY)
11535 return sv_mortalcopy(HeKEY_sv(entry));
11536 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11542 /* Look for an entry in the array whose value has the same SV as val;
11543 * If so, return the index, otherwise return -1. */
11546 S_find_array_subscript(pTHX_ AV *av, SV* val)
11551 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11552 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11556 for (i=AvFILLp(av); i>=0; i--) {
11557 if (svp[i] == val && svp[i] != &PL_sv_undef)
11563 /* S_varname(): return the name of a variable, optionally with a subscript.
11564 * If gv is non-zero, use the name of that global, along with gvtype (one
11565 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11566 * targ. Depending on the value of the subscript_type flag, return:
11569 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11570 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11571 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11572 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11575 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11576 SV* keyname, I32 aindex, int subscript_type)
11579 SV * const name = sv_newmortal();
11582 buffer[0] = gvtype;
11585 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11587 gv_fullname4(name, gv, buffer, 0);
11589 if ((unsigned int)SvPVX(name)[1] <= 26) {
11591 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11593 /* Swap the 1 unprintable control character for the 2 byte pretty
11594 version - ie substr($name, 1, 1) = $buffer; */
11595 sv_insert(name, 1, 1, buffer, 2);
11600 CV * const cv = find_runcv(&unused);
11604 if (!cv || !CvPADLIST(cv))
11606 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11607 sv = *av_fetch(av, targ, FALSE);
11608 /* SvLEN in a pad name is not to be trusted */
11609 sv_setpv(name, SvPV_nolen_const(sv));
11612 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11613 SV * const sv = newSV(0);
11614 *SvPVX(name) = '$';
11615 Perl_sv_catpvf(aTHX_ name, "{%s}",
11616 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11619 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11620 *SvPVX(name) = '$';
11621 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11623 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11624 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11631 =for apidoc find_uninit_var
11633 Find the name of the undefined variable (if any) that caused the operator o
11634 to issue a "Use of uninitialized value" warning.
11635 If match is true, only return a name if it's value matches uninit_sv.
11636 So roughly speaking, if a unary operator (such as OP_COS) generates a
11637 warning, then following the direct child of the op may yield an
11638 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11639 other hand, with OP_ADD there are two branches to follow, so we only print
11640 the variable name if we get an exact match.
11642 The name is returned as a mortal SV.
11644 Assumes that PL_op is the op that originally triggered the error, and that
11645 PL_comppad/PL_curpad points to the currently executing pad.
11651 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11659 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11660 uninit_sv == &PL_sv_placeholder)))
11663 switch (obase->op_type) {
11670 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11671 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11674 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11676 if (pad) { /* @lex, %lex */
11677 sv = PAD_SVl(obase->op_targ);
11681 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11682 /* @global, %global */
11683 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11686 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11688 else /* @{expr}, %{expr} */
11689 return find_uninit_var(cUNOPx(obase)->op_first,
11693 /* attempt to find a match within the aggregate */
11695 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11697 subscript_type = FUV_SUBSCRIPT_HASH;
11700 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11702 subscript_type = FUV_SUBSCRIPT_ARRAY;
11705 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11708 return varname(gv, hash ? '%' : '@', obase->op_targ,
11709 keysv, index, subscript_type);
11713 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11715 return varname(NULL, '$', obase->op_targ,
11716 NULL, 0, FUV_SUBSCRIPT_NONE);
11719 gv = cGVOPx_gv(obase);
11720 if (!gv || (match && GvSV(gv) != uninit_sv))
11722 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11725 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11728 av = (AV*)PAD_SV(obase->op_targ);
11729 if (!av || SvRMAGICAL(av))
11731 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11732 if (!svp || *svp != uninit_sv)
11735 return varname(NULL, '$', obase->op_targ,
11736 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11739 gv = cGVOPx_gv(obase);
11745 if (!av || SvRMAGICAL(av))
11747 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11748 if (!svp || *svp != uninit_sv)
11751 return varname(gv, '$', 0,
11752 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11757 o = cUNOPx(obase)->op_first;
11758 if (!o || o->op_type != OP_NULL ||
11759 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11761 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11765 if (PL_op == obase)
11766 /* $a[uninit_expr] or $h{uninit_expr} */
11767 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11770 o = cBINOPx(obase)->op_first;
11771 kid = cBINOPx(obase)->op_last;
11773 /* get the av or hv, and optionally the gv */
11775 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11776 sv = PAD_SV(o->op_targ);
11778 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11779 && cUNOPo->op_first->op_type == OP_GV)
11781 gv = cGVOPx_gv(cUNOPo->op_first);
11784 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11789 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11790 /* index is constant */
11794 if (obase->op_type == OP_HELEM) {
11795 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11796 if (!he || HeVAL(he) != uninit_sv)
11800 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11801 if (!svp || *svp != uninit_sv)
11805 if (obase->op_type == OP_HELEM)
11806 return varname(gv, '%', o->op_targ,
11807 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11809 return varname(gv, '@', o->op_targ, NULL,
11810 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11813 /* index is an expression;
11814 * attempt to find a match within the aggregate */
11815 if (obase->op_type == OP_HELEM) {
11816 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11818 return varname(gv, '%', o->op_targ,
11819 keysv, 0, FUV_SUBSCRIPT_HASH);
11822 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11824 return varname(gv, '@', o->op_targ,
11825 NULL, index, FUV_SUBSCRIPT_ARRAY);
11830 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11832 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11837 /* only examine RHS */
11838 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11841 o = cUNOPx(obase)->op_first;
11842 if (o->op_type == OP_PUSHMARK)
11845 if (!o->op_sibling) {
11846 /* one-arg version of open is highly magical */
11848 if (o->op_type == OP_GV) { /* open FOO; */
11850 if (match && GvSV(gv) != uninit_sv)
11852 return varname(gv, '$', 0,
11853 NULL, 0, FUV_SUBSCRIPT_NONE);
11855 /* other possibilities not handled are:
11856 * open $x; or open my $x; should return '${*$x}'
11857 * open expr; should return '$'.expr ideally
11863 /* ops where $_ may be an implicit arg */
11867 if ( !(obase->op_flags & OPf_STACKED)) {
11868 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11869 ? PAD_SVl(obase->op_targ)
11872 sv = sv_newmortal();
11873 sv_setpvn(sv, "$_", 2);
11881 /* skip filehandle as it can't produce 'undef' warning */
11882 o = cUNOPx(obase)->op_first;
11883 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11884 o = o->op_sibling->op_sibling;
11891 match = 1; /* XS or custom code could trigger random warnings */
11896 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11897 return sv_2mortal(newSVpvs("${$/}"));
11902 if (!(obase->op_flags & OPf_KIDS))
11904 o = cUNOPx(obase)->op_first;
11910 /* if all except one arg are constant, or have no side-effects,
11911 * or are optimized away, then it's unambiguous */
11913 for (kid=o; kid; kid = kid->op_sibling) {
11915 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11916 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11917 || (kid->op_type == OP_PUSHMARK)
11921 if (o2) { /* more than one found */
11928 return find_uninit_var(o2, uninit_sv, match);
11930 /* scan all args */
11932 sv = find_uninit_var(o, uninit_sv, 1);
11944 =for apidoc report_uninit
11946 Print appropriate "Use of uninitialized variable" warning
11952 Perl_report_uninit(pTHX_ SV* uninit_sv)
11956 SV* varname = NULL;
11958 varname = find_uninit_var(PL_op, uninit_sv,0);
11960 sv_insert(varname, 0, 0, " ", 1);
11962 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11963 varname ? SvPV_nolen_const(varname) : "",
11964 " in ", OP_DESC(PL_op));
11967 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11973 * c-indentation-style: bsd
11974 * c-basic-offset: 4
11975 * indent-tabs-mode: t
11978 * ex: set ts=8 sts=4 sw=4 noet: