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 && 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];
593 S_free_arena(pTHX_ void **root) {
595 void ** const next = *(void **)root;
603 =for apidoc sv_free_arenas
605 Deallocate the memory used by all arenas. Note that all the individual SV
606 heads and bodies within the arenas must already have been freed.
611 Perl_sv_free_arenas(pTHX)
618 /* Free arenas here, but be careful about fake ones. (We assume
619 contiguity of the fake ones with the corresponding real ones.) */
621 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
622 svanext = (SV*) SvANY(sva);
623 while (svanext && SvFAKE(svanext))
624 svanext = (SV*) SvANY(svanext);
632 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
634 for (; aroot; aroot = next) {
635 const int max = aroot->curr;
636 for (i=0; i<max; i++) {
637 assert(aroot->set[i].arena);
638 Safefree(aroot->set[i].arena);
645 S_free_arena(aTHX_ (void**) PL_body_arenas);
649 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
650 PL_body_roots[i] = 0;
652 Safefree(PL_nice_chunk);
653 PL_nice_chunk = NULL;
654 PL_nice_chunk_size = 0;
660 Here are mid-level routines that manage the allocation of bodies out
661 of the various arenas. There are 5 kinds of arenas:
663 1. SV-head arenas, which are discussed and handled above
664 2. regular body arenas
665 3. arenas for reduced-size bodies
667 5. pte arenas (thread related)
669 Arena types 2 & 3 are chained by body-type off an array of
670 arena-root pointers, which is indexed by svtype. Some of the
671 larger/less used body types are malloced singly, since a large
672 unused block of them is wasteful. Also, several svtypes dont have
673 bodies; the data fits into the sv-head itself. The arena-root
674 pointer thus has a few unused root-pointers (which may be hijacked
675 later for arena types 4,5)
677 3 differs from 2 as an optimization; some body types have several
678 unused fields in the front of the structure (which are kept in-place
679 for consistency). These bodies can be allocated in smaller chunks,
680 because the leading fields arent accessed. Pointers to such bodies
681 are decremented to point at the unused 'ghost' memory, knowing that
682 the pointers are used with offsets to the real memory.
684 HE, HEK arenas are managed separately, with separate code, but may
685 be merge-able later..
687 PTE arenas are not sv-bodies, but they share these mid-level
688 mechanics, so are considered here. The new mid-level mechanics rely
689 on the sv_type of the body being allocated, so we just reserve one
690 of the unused body-slots for PTEs, then use it in those (2) PTE
691 contexts below (line ~10k)
694 /* get_arena(size): when ARENASETS is enabled, this creates
695 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
697 TBD: export properly for hv.c: S_more_he().
700 Perl_get_arena(pTHX_ int arena_size)
705 /* allocate and attach arena */
706 Newx(arp, arena_size, char);
707 arp->next = PL_body_arenas;
708 PL_body_arenas = arp;
712 struct arena_desc* adesc;
713 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
716 /* shouldnt need this
717 if (!arena_size) arena_size = PERL_ARENA_SIZE;
720 /* may need new arena-set to hold new arena */
721 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
722 Newxz(newroot, 1, struct arena_set);
723 newroot->set_size = ARENAS_PER_SET;
724 newroot->next = *aroot;
726 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
729 /* ok, now have arena-set with at least 1 empty/available arena-desc */
730 curr = (*aroot)->curr++;
731 adesc = &((*aroot)->set[curr]);
732 assert(!adesc->arena);
734 Newxz(adesc->arena, arena_size, char);
735 adesc->size = arena_size;
736 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
737 curr, adesc->arena, arena_size));
744 /* return a thing to the free list */
746 #define del_body(thing, root) \
748 void ** const thing_copy = (void **)thing;\
750 *thing_copy = *root; \
751 *root = (void*)thing_copy; \
757 =head1 SV-Body Allocation
759 Allocation of SV-bodies is similar to SV-heads, differing as follows;
760 the allocation mechanism is used for many body types, so is somewhat
761 more complicated, it uses arena-sets, and has no need for still-live
764 At the outermost level, (new|del)_X*V macros return bodies of the
765 appropriate type. These macros call either (new|del)_body_type or
766 (new|del)_body_allocated macro pairs, depending on specifics of the
767 type. Most body types use the former pair, the latter pair is used to
768 allocate body types with "ghost fields".
770 "ghost fields" are fields that are unused in certain types, and
771 consequently dont need to actually exist. They are declared because
772 they're part of a "base type", which allows use of functions as
773 methods. The simplest examples are AVs and HVs, 2 aggregate types
774 which don't use the fields which support SCALAR semantics.
776 For these types, the arenas are carved up into *_allocated size
777 chunks, we thus avoid wasted memory for those unaccessed members.
778 When bodies are allocated, we adjust the pointer back in memory by the
779 size of the bit not allocated, so it's as if we allocated the full
780 structure. (But things will all go boom if you write to the part that
781 is "not there", because you'll be overwriting the last members of the
782 preceding structure in memory.)
784 We calculate the correction using the STRUCT_OFFSET macro. For
785 example, if xpv_allocated is the same structure as XPV then the two
786 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
787 structure is smaller (no initial NV actually allocated) then the net
788 effect is to subtract the size of the NV from the pointer, to return a
789 new pointer as if an initial NV were actually allocated.
791 This is the same trick as was used for NV and IV bodies. Ironically it
792 doesn't need to be used for NV bodies any more, because NV is now at
793 the start of the structure. IV bodies don't need it either, because
794 they are no longer allocated.
796 In turn, the new_body_* allocators call S_new_body(), which invokes
797 new_body_inline macro, which takes a lock, and takes a body off the
798 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
799 necessary to refresh an empty list. Then the lock is released, and
800 the body is returned.
802 S_more_bodies calls get_arena(), and carves it up into an array of N
803 bodies, which it strings into a linked list. It looks up arena-size
804 and body-size from the body_details table described below, thus
805 supporting the multiple body-types.
807 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
808 the (new|del)_X*V macros are mapped directly to malloc/free.
814 For each sv-type, struct body_details bodies_by_type[] carries
815 parameters which control these aspects of SV handling:
817 Arena_size determines whether arenas are used for this body type, and if
818 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
819 zero, forcing individual mallocs and frees.
821 Body_size determines how big a body is, and therefore how many fit into
822 each arena. Offset carries the body-pointer adjustment needed for
823 *_allocated body types, and is used in *_allocated macros.
825 But its main purpose is to parameterize info needed in
826 Perl_sv_upgrade(). The info here dramatically simplifies the function
827 vs the implementation in 5.8.7, making it table-driven. All fields
828 are used for this, except for arena_size.
830 For the sv-types that have no bodies, arenas are not used, so those
831 PL_body_roots[sv_type] are unused, and can be overloaded. In
832 something of a special case, SVt_NULL is borrowed for HE arenas;
833 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
834 bodies_by_type[SVt_NULL] slot is not used, as the table is not
837 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
838 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
839 they can just use the same allocation semantics. At first, PTEs were
840 also overloaded to a non-body sv-type, but this yielded hard-to-find
841 malloc bugs, so was simplified by claiming a new slot. This choice
842 has no consequence at this time.
846 struct body_details {
847 U8 body_size; /* Size to allocate */
848 U8 copy; /* Size of structure to copy (may be shorter) */
850 unsigned int type : 4; /* We have space for a sanity check. */
851 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
852 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
853 unsigned int arena : 1; /* Allocated from an arena */
854 size_t arena_size; /* Size of arena to allocate */
862 /* With -DPURFIY we allocate everything directly, and don't use arenas.
863 This seems a rather elegant way to simplify some of the code below. */
864 #define HASARENA FALSE
866 #define HASARENA TRUE
868 #define NOARENA FALSE
870 /* Size the arenas to exactly fit a given number of bodies. A count
871 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
872 simplifying the default. If count > 0, the arena is sized to fit
873 only that many bodies, allowing arenas to be used for large, rare
874 bodies (XPVFM, XPVIO) without undue waste. The arena size is
875 limited by PERL_ARENA_SIZE, so we can safely oversize the
878 #define FIT_ARENA(count, body_size) \
879 (!count || count * body_size > PERL_ARENA_SIZE) \
880 ? (int)(PERL_ARENA_SIZE / body_size) * body_size : count * body_size
882 /* A macro to work out the offset needed to subtract from a pointer to (say)
889 to make its members accessible via a pointer to (say)
899 #define relative_STRUCT_OFFSET(longer, shorter, member) \
900 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
902 /* Calculate the length to copy. Specifically work out the length less any
903 final padding the compiler needed to add. See the comment in sv_upgrade
904 for why copying the padding proved to be a bug. */
906 #define copy_length(type, last_member) \
907 STRUCT_OFFSET(type, last_member) \
908 + sizeof (((type*)SvANY((SV*)0))->last_member)
910 static const struct body_details bodies_by_type[] = {
911 { sizeof(HE), 0, 0, SVt_NULL,
912 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
914 /* IVs are in the head, so the allocation size is 0.
915 However, the slot is overloaded for PTEs. */
916 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
917 sizeof(IV), /* This is used to copy out the IV body. */
918 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
919 NOARENA /* IVS don't need an arena */,
920 /* But PTEs need to know the size of their arena */
921 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
924 /* 8 bytes on most ILP32 with IEEE doubles */
925 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
926 FIT_ARENA(0, sizeof(NV)) },
928 /* RVs are in the head now. */
929 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
931 /* 8 bytes on most ILP32 with IEEE doubles */
932 { sizeof(xpv_allocated),
933 copy_length(XPV, xpv_len)
934 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
935 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
936 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
939 { sizeof(xpviv_allocated),
940 copy_length(XPVIV, xiv_u)
941 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
942 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
943 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
946 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
947 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
950 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
951 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
954 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
955 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
958 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
959 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
962 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
963 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
965 { sizeof(xpvav_allocated),
966 copy_length(XPVAV, xmg_stash)
967 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
968 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
969 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
971 { sizeof(xpvhv_allocated),
972 copy_length(XPVHV, xmg_stash)
973 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
974 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
975 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
978 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
979 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
980 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
982 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
983 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
984 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
986 /* XPVIO is 84 bytes, fits 48x */
987 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
988 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
991 #define new_body_type(sv_type) \
992 (void *)((char *)S_new_body(aTHX_ sv_type))
994 #define del_body_type(p, sv_type) \
995 del_body(p, &PL_body_roots[sv_type])
998 #define new_body_allocated(sv_type) \
999 (void *)((char *)S_new_body(aTHX_ sv_type) \
1000 - bodies_by_type[sv_type].offset)
1002 #define del_body_allocated(p, sv_type) \
1003 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
1006 #define my_safemalloc(s) (void*)safemalloc(s)
1007 #define my_safecalloc(s) (void*)safecalloc(s, 1)
1008 #define my_safefree(p) safefree((char*)p)
1012 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1013 #define del_XNV(p) my_safefree(p)
1015 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1016 #define del_XPVNV(p) my_safefree(p)
1018 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1019 #define del_XPVAV(p) my_safefree(p)
1021 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1022 #define del_XPVHV(p) my_safefree(p)
1024 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1025 #define del_XPVMG(p) my_safefree(p)
1027 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1028 #define del_XPVGV(p) my_safefree(p)
1032 #define new_XNV() new_body_type(SVt_NV)
1033 #define del_XNV(p) del_body_type(p, SVt_NV)
1035 #define new_XPVNV() new_body_type(SVt_PVNV)
1036 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1038 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1039 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1041 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1042 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1044 #define new_XPVMG() new_body_type(SVt_PVMG)
1045 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1047 #define new_XPVGV() new_body_type(SVt_PVGV)
1048 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1052 /* no arena for you! */
1054 #define new_NOARENA(details) \
1055 my_safemalloc((details)->body_size + (details)->offset)
1056 #define new_NOARENAZ(details) \
1057 my_safecalloc((details)->body_size + (details)->offset)
1060 static bool done_sanity_check;
1064 S_more_bodies (pTHX_ svtype sv_type)
1067 void ** const root = &PL_body_roots[sv_type];
1068 const struct body_details * const bdp = &bodies_by_type[sv_type];
1069 const size_t body_size = bdp->body_size;
1073 assert(bdp->arena_size);
1076 if (!done_sanity_check) {
1079 done_sanity_check = TRUE;
1082 assert (bodies_by_type[i].type == i);
1086 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1088 end = start + bdp->arena_size - body_size;
1091 /* The initial slot is used to link the arenas together, so it isn't to be
1092 linked into the list of ready-to-use bodies. */
1095 /* computed count doesnt reflect the 1st slot reservation */
1096 DEBUG_m(PerlIO_printf(Perl_debug_log,
1097 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1098 start, end, bdp->arena_size, sv_type, body_size,
1099 bdp->arena_size / body_size));
1102 *root = (void *)start;
1104 while (start < end) {
1105 char * const next = start + body_size;
1106 *(void**) start = (void *)next;
1109 *(void **)start = 0;
1114 /* grab a new thing from the free list, allocating more if necessary.
1115 The inline version is used for speed in hot routines, and the
1116 function using it serves the rest (unless PURIFY).
1118 #define new_body_inline(xpv, sv_type) \
1120 void ** const r3wt = &PL_body_roots[sv_type]; \
1122 xpv = *((void **)(r3wt)) \
1123 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1124 *(r3wt) = *(void**)(xpv); \
1131 S_new_body(pTHX_ svtype sv_type)
1135 new_body_inline(xpv, sv_type);
1142 =for apidoc sv_upgrade
1144 Upgrade an SV to a more complex form. Generally adds a new body type to the
1145 SV, then copies across as much information as possible from the old body.
1146 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1152 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1157 const U32 old_type = SvTYPE(sv);
1158 const struct body_details *new_type_details;
1159 const struct body_details *const old_type_details
1160 = bodies_by_type + old_type;
1162 if (new_type != SVt_PV && SvIsCOW(sv)) {
1163 sv_force_normal_flags(sv, 0);
1166 if (old_type == new_type)
1169 if (old_type > new_type)
1170 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1171 (int)old_type, (int)new_type);
1174 old_body = SvANY(sv);
1176 /* Copying structures onto other structures that have been neatly zeroed
1177 has a subtle gotcha. Consider XPVMG
1179 +------+------+------+------+------+-------+-------+
1180 | NV | CUR | LEN | IV | MAGIC | STASH |
1181 +------+------+------+------+------+-------+-------+
1182 0 4 8 12 16 20 24 28
1184 where NVs are aligned to 8 bytes, so that sizeof that structure is
1185 actually 32 bytes long, with 4 bytes of padding at the end:
1187 +------+------+------+------+------+-------+-------+------+
1188 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1189 +------+------+------+------+------+-------+-------+------+
1190 0 4 8 12 16 20 24 28 32
1192 so what happens if you allocate memory for this structure:
1194 +------+------+------+------+------+-------+-------+------+------+...
1195 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1196 +------+------+------+------+------+-------+-------+------+------+...
1197 0 4 8 12 16 20 24 28 32 36
1199 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1200 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1201 started out as zero once, but it's quite possible that it isn't. So now,
1202 rather than a nicely zeroed GP, you have it pointing somewhere random.
1205 (In fact, GP ends up pointing at a previous GP structure, because the
1206 principle cause of the padding in XPVMG getting garbage is a copy of
1207 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1209 So we are careful and work out the size of used parts of all the
1216 if (new_type < SVt_PVIV) {
1217 new_type = (new_type == SVt_NV)
1218 ? SVt_PVNV : SVt_PVIV;
1222 if (new_type < SVt_PVNV) {
1223 new_type = SVt_PVNV;
1229 assert(new_type > SVt_PV);
1230 assert(SVt_IV < SVt_PV);
1231 assert(SVt_NV < SVt_PV);
1238 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1239 there's no way that it can be safely upgraded, because perl.c
1240 expects to Safefree(SvANY(PL_mess_sv)) */
1241 assert(sv != PL_mess_sv);
1242 /* This flag bit is used to mean other things in other scalar types.
1243 Given that it only has meaning inside the pad, it shouldn't be set
1244 on anything that can get upgraded. */
1245 assert(!SvPAD_TYPED(sv));
1248 if (old_type_details->cant_upgrade)
1249 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1250 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1252 new_type_details = bodies_by_type + new_type;
1254 SvFLAGS(sv) &= ~SVTYPEMASK;
1255 SvFLAGS(sv) |= new_type;
1257 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1258 the return statements above will have triggered. */
1259 assert (new_type != SVt_NULL);
1262 assert(old_type == SVt_NULL);
1263 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1267 assert(old_type == SVt_NULL);
1268 SvANY(sv) = new_XNV();
1272 assert(old_type == SVt_NULL);
1273 SvANY(sv) = &sv->sv_u.svu_rv;
1278 assert(new_type_details->body_size);
1281 assert(new_type_details->arena);
1282 assert(new_type_details->arena_size);
1283 /* This points to the start of the allocated area. */
1284 new_body_inline(new_body, new_type);
1285 Zero(new_body, new_type_details->body_size, char);
1286 new_body = ((char *)new_body) - new_type_details->offset;
1288 /* We always allocated the full length item with PURIFY. To do this
1289 we fake things so that arena is false for all 16 types.. */
1290 new_body = new_NOARENAZ(new_type_details);
1292 SvANY(sv) = new_body;
1293 if (new_type == SVt_PVAV) {
1299 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1300 The target created by newSVrv also is, and it can have magic.
1301 However, it never has SvPVX set.
1303 if (old_type >= SVt_RV) {
1304 assert(SvPVX_const(sv) == 0);
1307 /* Could put this in the else clause below, as PVMG must have SvPVX
1308 0 already (the assertion above) */
1311 if (old_type >= SVt_PVMG) {
1312 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1313 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1319 /* XXX Is this still needed? Was it ever needed? Surely as there is
1320 no route from NV to PVIV, NOK can never be true */
1321 assert(!SvNOKp(sv));
1333 assert(new_type_details->body_size);
1334 /* We always allocated the full length item with PURIFY. To do this
1335 we fake things so that arena is false for all 16 types.. */
1336 if(new_type_details->arena) {
1337 /* This points to the start of the allocated area. */
1338 new_body_inline(new_body, new_type);
1339 Zero(new_body, new_type_details->body_size, char);
1340 new_body = ((char *)new_body) - new_type_details->offset;
1342 new_body = new_NOARENAZ(new_type_details);
1344 SvANY(sv) = new_body;
1346 if (old_type_details->copy) {
1347 Copy((char *)old_body + old_type_details->offset,
1348 (char *)new_body + old_type_details->offset,
1349 old_type_details->copy, char);
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354 * correct 0.0 for us. Otherwise, if the old body didn't have an
1355 * NV slot, but the new one does, then we need to initialise the
1356 * freshly created NV slot with whatever the correct bit pattern is
1358 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1362 if (new_type == SVt_PVIO)
1363 IoPAGE_LEN(sv) = 60;
1364 if (old_type < SVt_RV)
1368 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1369 (unsigned long)new_type);
1372 if (old_type_details->arena) {
1373 /* If there was an old body, then we need to free it.
1374 Note that there is an assumption that all bodies of types that
1375 can be upgraded came from arenas. Only the more complex non-
1376 upgradable types are allowed to be directly malloc()ed. */
1378 my_safefree(old_body);
1380 del_body((void*)((char*)old_body + old_type_details->offset),
1381 &PL_body_roots[old_type]);
1387 =for apidoc sv_backoff
1389 Remove any string offset. You should normally use the C<SvOOK_off> macro
1396 Perl_sv_backoff(pTHX_ register SV *sv)
1398 PERL_UNUSED_CONTEXT;
1400 assert(SvTYPE(sv) != SVt_PVHV);
1401 assert(SvTYPE(sv) != SVt_PVAV);
1403 const char * const s = SvPVX_const(sv);
1404 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1405 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1407 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1409 SvFLAGS(sv) &= ~SVf_OOK;
1416 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1417 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1418 Use the C<SvGROW> wrapper instead.
1424 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1428 #ifdef HAS_64K_LIMIT
1429 if (newlen >= 0x10000) {
1430 PerlIO_printf(Perl_debug_log,
1431 "Allocation too large: %"UVxf"\n", (UV)newlen);
1434 #endif /* HAS_64K_LIMIT */
1437 if (SvTYPE(sv) < SVt_PV) {
1438 sv_upgrade(sv, SVt_PV);
1439 s = SvPVX_mutable(sv);
1441 else if (SvOOK(sv)) { /* pv is offset? */
1443 s = SvPVX_mutable(sv);
1444 if (newlen > SvLEN(sv))
1445 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1446 #ifdef HAS_64K_LIMIT
1447 if (newlen >= 0x10000)
1452 s = SvPVX_mutable(sv);
1454 if (newlen > SvLEN(sv)) { /* need more room? */
1455 newlen = PERL_STRLEN_ROUNDUP(newlen);
1456 if (SvLEN(sv) && s) {
1458 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1464 s = saferealloc(s, newlen);
1467 s = safemalloc(newlen);
1468 if (SvPVX_const(sv) && SvCUR(sv)) {
1469 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1473 SvLEN_set(sv, newlen);
1479 =for apidoc sv_setiv
1481 Copies an integer into the given SV, upgrading first if necessary.
1482 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1488 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1491 SV_CHECK_THINKFIRST_COW_DROP(sv);
1492 switch (SvTYPE(sv)) {
1494 sv_upgrade(sv, SVt_IV);
1497 sv_upgrade(sv, SVt_PVNV);
1501 sv_upgrade(sv, SVt_PVIV);
1510 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1513 (void)SvIOK_only(sv); /* validate number */
1519 =for apidoc sv_setiv_mg
1521 Like C<sv_setiv>, but also handles 'set' magic.
1527 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1534 =for apidoc sv_setuv
1536 Copies an unsigned integer into the given SV, upgrading first if necessary.
1537 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1543 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1545 /* With these two if statements:
1546 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1549 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1551 If you wish to remove them, please benchmark to see what the effect is
1553 if (u <= (UV)IV_MAX) {
1554 sv_setiv(sv, (IV)u);
1563 =for apidoc sv_setuv_mg
1565 Like C<sv_setuv>, but also handles 'set' magic.
1571 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1580 =for apidoc sv_setnv
1582 Copies a double into the given SV, upgrading first if necessary.
1583 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1589 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1592 SV_CHECK_THINKFIRST_COW_DROP(sv);
1593 switch (SvTYPE(sv)) {
1596 sv_upgrade(sv, SVt_NV);
1601 sv_upgrade(sv, SVt_PVNV);
1610 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1614 (void)SvNOK_only(sv); /* validate number */
1619 =for apidoc sv_setnv_mg
1621 Like C<sv_setnv>, but also handles 'set' magic.
1627 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1633 /* Print an "isn't numeric" warning, using a cleaned-up,
1634 * printable version of the offending string
1638 S_not_a_number(pTHX_ SV *sv)
1646 dsv = sv_2mortal(newSVpvs(""));
1647 pv = sv_uni_display(dsv, sv, 10, 0);
1650 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1651 /* each *s can expand to 4 chars + "...\0",
1652 i.e. need room for 8 chars */
1654 const char *s = SvPVX_const(sv);
1655 const char * const end = s + SvCUR(sv);
1656 for ( ; s < end && d < limit; s++ ) {
1658 if (ch & 128 && !isPRINT_LC(ch)) {
1667 else if (ch == '\r') {
1671 else if (ch == '\f') {
1675 else if (ch == '\\') {
1679 else if (ch == '\0') {
1683 else if (isPRINT_LC(ch))
1700 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1701 "Argument \"%s\" isn't numeric in %s", pv,
1704 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1705 "Argument \"%s\" isn't numeric", pv);
1709 =for apidoc looks_like_number
1711 Test if the content of an SV looks like a number (or is a number).
1712 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1713 non-numeric warning), even if your atof() doesn't grok them.
1719 Perl_looks_like_number(pTHX_ SV *sv)
1721 register const char *sbegin;
1725 sbegin = SvPVX_const(sv);
1728 else if (SvPOKp(sv))
1729 sbegin = SvPV_const(sv, len);
1731 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1732 return grok_number(sbegin, len, NULL);
1736 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1738 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1739 SV *const buffer = sv_newmortal();
1741 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1744 gv_efullname3(buffer, gv, "*");
1745 SvFLAGS(gv) |= wasfake;
1748 /* We know that all GVs stringify to something that is not-a-number,
1749 so no need to test that. */
1750 if (ckWARN(WARN_NUMERIC))
1751 not_a_number(buffer);
1752 /* We just want something true to return, so that S_sv_2iuv_common
1753 can tail call us and return true. */
1756 return SvPV(buffer, *len);
1760 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1761 until proven guilty, assume that things are not that bad... */
1766 As 64 bit platforms often have an NV that doesn't preserve all bits of
1767 an IV (an assumption perl has been based on to date) it becomes necessary
1768 to remove the assumption that the NV always carries enough precision to
1769 recreate the IV whenever needed, and that the NV is the canonical form.
1770 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1771 precision as a side effect of conversion (which would lead to insanity
1772 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1773 1) to distinguish between IV/UV/NV slots that have cached a valid
1774 conversion where precision was lost and IV/UV/NV slots that have a
1775 valid conversion which has lost no precision
1776 2) to ensure that if a numeric conversion to one form is requested that
1777 would lose precision, the precise conversion (or differently
1778 imprecise conversion) is also performed and cached, to prevent
1779 requests for different numeric formats on the same SV causing
1780 lossy conversion chains. (lossless conversion chains are perfectly
1785 SvIOKp is true if the IV slot contains a valid value
1786 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1787 SvNOKp is true if the NV slot contains a valid value
1788 SvNOK is true only if the NV value is accurate
1791 while converting from PV to NV, check to see if converting that NV to an
1792 IV(or UV) would lose accuracy over a direct conversion from PV to
1793 IV(or UV). If it would, cache both conversions, return NV, but mark
1794 SV as IOK NOKp (ie not NOK).
1796 While converting from PV to IV, check to see if converting that IV to an
1797 NV would lose accuracy over a direct conversion from PV to NV. If it
1798 would, cache both conversions, flag similarly.
1800 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1801 correctly because if IV & NV were set NV *always* overruled.
1802 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1803 changes - now IV and NV together means that the two are interchangeable:
1804 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1806 The benefit of this is that operations such as pp_add know that if
1807 SvIOK is true for both left and right operands, then integer addition
1808 can be used instead of floating point (for cases where the result won't
1809 overflow). Before, floating point was always used, which could lead to
1810 loss of precision compared with integer addition.
1812 * making IV and NV equal status should make maths accurate on 64 bit
1814 * may speed up maths somewhat if pp_add and friends start to use
1815 integers when possible instead of fp. (Hopefully the overhead in
1816 looking for SvIOK and checking for overflow will not outweigh the
1817 fp to integer speedup)
1818 * will slow down integer operations (callers of SvIV) on "inaccurate"
1819 values, as the change from SvIOK to SvIOKp will cause a call into
1820 sv_2iv each time rather than a macro access direct to the IV slot
1821 * should speed up number->string conversion on integers as IV is
1822 favoured when IV and NV are equally accurate
1824 ####################################################################
1825 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1826 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1827 On the other hand, SvUOK is true iff UV.
1828 ####################################################################
1830 Your mileage will vary depending your CPU's relative fp to integer
1834 #ifndef NV_PRESERVES_UV
1835 # define IS_NUMBER_UNDERFLOW_IV 1
1836 # define IS_NUMBER_UNDERFLOW_UV 2
1837 # define IS_NUMBER_IV_AND_UV 2
1838 # define IS_NUMBER_OVERFLOW_IV 4
1839 # define IS_NUMBER_OVERFLOW_UV 5
1841 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1843 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1845 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1848 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));
1849 if (SvNVX(sv) < (NV)IV_MIN) {
1850 (void)SvIOKp_on(sv);
1852 SvIV_set(sv, IV_MIN);
1853 return IS_NUMBER_UNDERFLOW_IV;
1855 if (SvNVX(sv) > (NV)UV_MAX) {
1856 (void)SvIOKp_on(sv);
1859 SvUV_set(sv, UV_MAX);
1860 return IS_NUMBER_OVERFLOW_UV;
1862 (void)SvIOKp_on(sv);
1864 /* Can't use strtol etc to convert this string. (See truth table in
1866 if (SvNVX(sv) <= (UV)IV_MAX) {
1867 SvIV_set(sv, I_V(SvNVX(sv)));
1868 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1869 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1871 /* Integer is imprecise. NOK, IOKp */
1873 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1876 SvUV_set(sv, U_V(SvNVX(sv)));
1877 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1878 if (SvUVX(sv) == UV_MAX) {
1879 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1880 possibly be preserved by NV. Hence, it must be overflow.
1882 return IS_NUMBER_OVERFLOW_UV;
1884 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1886 /* Integer is imprecise. NOK, IOKp */
1888 return IS_NUMBER_OVERFLOW_IV;
1890 #endif /* !NV_PRESERVES_UV*/
1893 S_sv_2iuv_common(pTHX_ SV *sv) {
1896 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1897 * without also getting a cached IV/UV from it at the same time
1898 * (ie PV->NV conversion should detect loss of accuracy and cache
1899 * IV or UV at same time to avoid this. */
1900 /* IV-over-UV optimisation - choose to cache IV if possible */
1902 if (SvTYPE(sv) == SVt_NV)
1903 sv_upgrade(sv, SVt_PVNV);
1905 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1906 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1907 certainly cast into the IV range at IV_MAX, whereas the correct
1908 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1910 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1911 SvIV_set(sv, I_V(SvNVX(sv)));
1912 if (SvNVX(sv) == (NV) SvIVX(sv)
1913 #ifndef NV_PRESERVES_UV
1914 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1915 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1916 /* Don't flag it as "accurately an integer" if the number
1917 came from a (by definition imprecise) NV operation, and
1918 we're outside the range of NV integer precision */
1921 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1922 DEBUG_c(PerlIO_printf(Perl_debug_log,
1923 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1929 /* IV not precise. No need to convert from PV, as NV
1930 conversion would already have cached IV if it detected
1931 that PV->IV would be better than PV->NV->IV
1932 flags already correct - don't set public IOK. */
1933 DEBUG_c(PerlIO_printf(Perl_debug_log,
1934 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1939 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1940 but the cast (NV)IV_MIN rounds to a the value less (more
1941 negative) than IV_MIN which happens to be equal to SvNVX ??
1942 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1943 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1944 (NV)UVX == NVX are both true, but the values differ. :-(
1945 Hopefully for 2s complement IV_MIN is something like
1946 0x8000000000000000 which will be exact. NWC */
1949 SvUV_set(sv, U_V(SvNVX(sv)));
1951 (SvNVX(sv) == (NV) SvUVX(sv))
1952 #ifndef NV_PRESERVES_UV
1953 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1954 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1955 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1956 /* Don't flag it as "accurately an integer" if the number
1957 came from a (by definition imprecise) NV operation, and
1958 we're outside the range of NV integer precision */
1963 DEBUG_c(PerlIO_printf(Perl_debug_log,
1964 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1970 else if (SvPOKp(sv) && SvLEN(sv)) {
1972 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1973 /* We want to avoid a possible problem when we cache an IV/ a UV which
1974 may be later translated to an NV, and the resulting NV is not
1975 the same as the direct translation of the initial string
1976 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1977 be careful to ensure that the value with the .456 is around if the
1978 NV value is requested in the future).
1980 This means that if we cache such an IV/a UV, we need to cache the
1981 NV as well. Moreover, we trade speed for space, and do not
1982 cache the NV if we are sure it's not needed.
1985 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1986 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1987 == IS_NUMBER_IN_UV) {
1988 /* It's definitely an integer, only upgrade to PVIV */
1989 if (SvTYPE(sv) < SVt_PVIV)
1990 sv_upgrade(sv, SVt_PVIV);
1992 } else if (SvTYPE(sv) < SVt_PVNV)
1993 sv_upgrade(sv, SVt_PVNV);
1995 /* If NVs preserve UVs then we only use the UV value if we know that
1996 we aren't going to call atof() below. If NVs don't preserve UVs
1997 then the value returned may have more precision than atof() will
1998 return, even though value isn't perfectly accurate. */
1999 if ((numtype & (IS_NUMBER_IN_UV
2000 #ifdef NV_PRESERVES_UV
2003 )) == IS_NUMBER_IN_UV) {
2004 /* This won't turn off the public IOK flag if it was set above */
2005 (void)SvIOKp_on(sv);
2007 if (!(numtype & IS_NUMBER_NEG)) {
2009 if (value <= (UV)IV_MAX) {
2010 SvIV_set(sv, (IV)value);
2012 /* it didn't overflow, and it was positive. */
2013 SvUV_set(sv, value);
2017 /* 2s complement assumption */
2018 if (value <= (UV)IV_MIN) {
2019 SvIV_set(sv, -(IV)value);
2021 /* Too negative for an IV. This is a double upgrade, but
2022 I'm assuming it will be rare. */
2023 if (SvTYPE(sv) < SVt_PVNV)
2024 sv_upgrade(sv, SVt_PVNV);
2028 SvNV_set(sv, -(NV)value);
2029 SvIV_set(sv, IV_MIN);
2033 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2034 will be in the previous block to set the IV slot, and the next
2035 block to set the NV slot. So no else here. */
2037 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2038 != IS_NUMBER_IN_UV) {
2039 /* It wasn't an (integer that doesn't overflow the UV). */
2040 SvNV_set(sv, Atof(SvPVX_const(sv)));
2042 if (! numtype && ckWARN(WARN_NUMERIC))
2045 #if defined(USE_LONG_DOUBLE)
2046 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2047 PTR2UV(sv), SvNVX(sv)));
2049 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2050 PTR2UV(sv), SvNVX(sv)));
2053 #ifdef NV_PRESERVES_UV
2054 (void)SvIOKp_on(sv);
2056 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2057 SvIV_set(sv, I_V(SvNVX(sv)));
2058 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2061 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2063 /* UV will not work better than IV */
2065 if (SvNVX(sv) > (NV)UV_MAX) {
2067 /* Integer is inaccurate. NOK, IOKp, is UV */
2068 SvUV_set(sv, UV_MAX);
2070 SvUV_set(sv, U_V(SvNVX(sv)));
2071 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2072 NV preservse UV so can do correct comparison. */
2073 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2076 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2081 #else /* NV_PRESERVES_UV */
2082 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2083 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2084 /* The IV/UV slot will have been set from value returned by
2085 grok_number above. The NV slot has just been set using
2088 assert (SvIOKp(sv));
2090 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2091 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2092 /* Small enough to preserve all bits. */
2093 (void)SvIOKp_on(sv);
2095 SvIV_set(sv, I_V(SvNVX(sv)));
2096 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2098 /* Assumption: first non-preserved integer is < IV_MAX,
2099 this NV is in the preserved range, therefore: */
2100 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2102 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);
2106 0 0 already failed to read UV.
2107 0 1 already failed to read UV.
2108 1 0 you won't get here in this case. IV/UV
2109 slot set, public IOK, Atof() unneeded.
2110 1 1 already read UV.
2111 so there's no point in sv_2iuv_non_preserve() attempting
2112 to use atol, strtol, strtoul etc. */
2113 sv_2iuv_non_preserve (sv, numtype);
2116 #endif /* NV_PRESERVES_UV */
2120 if (((SvFLAGS(sv) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM)
2121 && (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV)) {
2122 return PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2124 if (SvTYPE(sv) == SVt_PVGV)
2127 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2128 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2131 if (SvTYPE(sv) < SVt_IV)
2132 /* Typically the caller expects that sv_any is not NULL now. */
2133 sv_upgrade(sv, SVt_IV);
2134 /* Return 0 from the caller. */
2141 =for apidoc sv_2iv_flags
2143 Return the integer value of an SV, doing any necessary string
2144 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2145 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2151 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2156 if (SvGMAGICAL(sv)) {
2157 if (flags & SV_GMAGIC)
2162 return I_V(SvNVX(sv));
2164 if (SvPOKp(sv) && SvLEN(sv)) {
2167 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2169 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2170 == IS_NUMBER_IN_UV) {
2171 /* It's definitely an integer */
2172 if (numtype & IS_NUMBER_NEG) {
2173 if (value < (UV)IV_MIN)
2176 if (value < (UV)IV_MAX)
2181 if (ckWARN(WARN_NUMERIC))
2184 return I_V(Atof(SvPVX_const(sv)));
2189 assert(SvTYPE(sv) >= SVt_PVMG);
2190 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2191 } else if (SvTHINKFIRST(sv)) {
2195 SV * const tmpstr=AMG_CALLun(sv,numer);
2196 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2197 return SvIV(tmpstr);
2200 return PTR2IV(SvRV(sv));
2203 sv_force_normal_flags(sv, 0);
2205 if (SvREADONLY(sv) && !SvOK(sv)) {
2206 if (ckWARN(WARN_UNINITIALIZED))
2212 if (S_sv_2iuv_common(aTHX_ sv))
2215 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2216 PTR2UV(sv),SvIVX(sv)));
2217 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2221 =for apidoc sv_2uv_flags
2223 Return the unsigned integer value of an SV, doing any necessary string
2224 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2225 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2231 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2236 if (SvGMAGICAL(sv)) {
2237 if (flags & SV_GMAGIC)
2242 return U_V(SvNVX(sv));
2243 if (SvPOKp(sv) && SvLEN(sv)) {
2246 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2248 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2249 == IS_NUMBER_IN_UV) {
2250 /* It's definitely an integer */
2251 if (!(numtype & IS_NUMBER_NEG))
2255 if (ckWARN(WARN_NUMERIC))
2258 return U_V(Atof(SvPVX_const(sv)));
2263 assert(SvTYPE(sv) >= SVt_PVMG);
2264 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2265 } else if (SvTHINKFIRST(sv)) {
2269 SV *const tmpstr = AMG_CALLun(sv,numer);
2270 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2271 return SvUV(tmpstr);
2274 return PTR2UV(SvRV(sv));
2277 sv_force_normal_flags(sv, 0);
2279 if (SvREADONLY(sv) && !SvOK(sv)) {
2280 if (ckWARN(WARN_UNINITIALIZED))
2286 if (S_sv_2iuv_common(aTHX_ sv))
2290 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2291 PTR2UV(sv),SvUVX(sv)));
2292 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2298 Return the num value of an SV, doing any necessary string or integer
2299 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2306 Perl_sv_2nv(pTHX_ register SV *sv)
2311 if (SvGMAGICAL(sv)) {
2315 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2316 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2317 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2319 return Atof(SvPVX_const(sv));
2323 return (NV)SvUVX(sv);
2325 return (NV)SvIVX(sv);
2330 assert(SvTYPE(sv) >= SVt_PVMG);
2331 /* This falls through to the report_uninit near the end of the
2333 } else if (SvTHINKFIRST(sv)) {
2337 SV *const tmpstr = AMG_CALLun(sv,numer);
2338 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2339 return SvNV(tmpstr);
2342 return PTR2NV(SvRV(sv));
2345 sv_force_normal_flags(sv, 0);
2347 if (SvREADONLY(sv) && !SvOK(sv)) {
2348 if (ckWARN(WARN_UNINITIALIZED))
2353 if (SvTYPE(sv) < SVt_NV) {
2354 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2355 sv_upgrade(sv, SVt_NV);
2356 #ifdef USE_LONG_DOUBLE
2358 STORE_NUMERIC_LOCAL_SET_STANDARD();
2359 PerlIO_printf(Perl_debug_log,
2360 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2361 PTR2UV(sv), SvNVX(sv));
2362 RESTORE_NUMERIC_LOCAL();
2366 STORE_NUMERIC_LOCAL_SET_STANDARD();
2367 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2368 PTR2UV(sv), SvNVX(sv));
2369 RESTORE_NUMERIC_LOCAL();
2373 else if (SvTYPE(sv) < SVt_PVNV)
2374 sv_upgrade(sv, SVt_PVNV);
2379 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2380 #ifdef NV_PRESERVES_UV
2383 /* Only set the public NV OK flag if this NV preserves the IV */
2384 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2385 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2386 : (SvIVX(sv) == I_V(SvNVX(sv))))
2392 else if (SvPOKp(sv) && SvLEN(sv)) {
2394 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2395 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2397 #ifdef NV_PRESERVES_UV
2398 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2399 == IS_NUMBER_IN_UV) {
2400 /* It's definitely an integer */
2401 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2403 SvNV_set(sv, Atof(SvPVX_const(sv)));
2406 SvNV_set(sv, Atof(SvPVX_const(sv)));
2407 /* Only set the public NV OK flag if this NV preserves the value in
2408 the PV at least as well as an IV/UV would.
2409 Not sure how to do this 100% reliably. */
2410 /* if that shift count is out of range then Configure's test is
2411 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2413 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2414 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2415 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2416 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2417 /* Can't use strtol etc to convert this string, so don't try.
2418 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2421 /* value has been set. It may not be precise. */
2422 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2423 /* 2s complement assumption for (UV)IV_MIN */
2424 SvNOK_on(sv); /* Integer is too negative. */
2429 if (numtype & IS_NUMBER_NEG) {
2430 SvIV_set(sv, -(IV)value);
2431 } else if (value <= (UV)IV_MAX) {
2432 SvIV_set(sv, (IV)value);
2434 SvUV_set(sv, value);
2438 if (numtype & IS_NUMBER_NOT_INT) {
2439 /* I believe that even if the original PV had decimals,
2440 they are lost beyond the limit of the FP precision.
2441 However, neither is canonical, so both only get p
2442 flags. NWC, 2000/11/25 */
2443 /* Both already have p flags, so do nothing */
2445 const NV nv = SvNVX(sv);
2446 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2447 if (SvIVX(sv) == I_V(nv)) {
2450 /* It had no "." so it must be integer. */
2454 /* between IV_MAX and NV(UV_MAX).
2455 Could be slightly > UV_MAX */
2457 if (numtype & IS_NUMBER_NOT_INT) {
2458 /* UV and NV both imprecise. */
2460 const UV nv_as_uv = U_V(nv);
2462 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2471 #endif /* NV_PRESERVES_UV */
2474 if (((SvFLAGS(sv) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM)
2475 && (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV)) {
2476 glob_2inpuv((GV *)sv, NULL, TRUE);
2480 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2482 assert (SvTYPE(sv) >= SVt_NV);
2483 /* Typically the caller expects that sv_any is not NULL now. */
2484 /* XXX Ilya implies that this is a bug in callers that assume this
2485 and ideally should be fixed. */
2488 #if defined(USE_LONG_DOUBLE)
2490 STORE_NUMERIC_LOCAL_SET_STANDARD();
2491 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2492 PTR2UV(sv), SvNVX(sv));
2493 RESTORE_NUMERIC_LOCAL();
2497 STORE_NUMERIC_LOCAL_SET_STANDARD();
2498 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2499 PTR2UV(sv), SvNVX(sv));
2500 RESTORE_NUMERIC_LOCAL();
2506 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2507 * UV as a string towards the end of buf, and return pointers to start and
2510 * We assume that buf is at least TYPE_CHARS(UV) long.
2514 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2516 char *ptr = buf + TYPE_CHARS(UV);
2517 char * const ebuf = ptr;
2530 *--ptr = '0' + (char)(uv % 10);
2538 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2539 * a regexp to its stringified form.
2543 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2545 const regexp * const re = (regexp *)mg->mg_obj;
2548 const char *fptr = "msix";
2553 bool need_newline = 0;
2554 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2556 while((ch = *fptr++)) {
2558 reflags[left++] = ch;
2561 reflags[right--] = ch;
2566 reflags[left] = '-';
2570 mg->mg_len = re->prelen + 4 + left;
2572 * If /x was used, we have to worry about a regex ending with a
2573 * comment later being embedded within another regex. If so, we don't
2574 * want this regex's "commentization" to leak out to the right part of
2575 * the enclosing regex, we must cap it with a newline.
2577 * So, if /x was used, we scan backwards from the end of the regex. If
2578 * we find a '#' before we find a newline, we need to add a newline
2579 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2580 * we don't need to add anything. -jfriedl
2582 if (PMf_EXTENDED & re->reganch) {
2583 const char *endptr = re->precomp + re->prelen;
2584 while (endptr >= re->precomp) {
2585 const char c = *(endptr--);
2587 break; /* don't need another */
2589 /* we end while in a comment, so we need a newline */
2590 mg->mg_len++; /* save space for it */
2591 need_newline = 1; /* note to add it */
2597 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2598 mg->mg_ptr[0] = '(';
2599 mg->mg_ptr[1] = '?';
2600 Copy(reflags, mg->mg_ptr+2, left, char);
2601 *(mg->mg_ptr+left+2) = ':';
2602 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2604 mg->mg_ptr[mg->mg_len - 2] = '\n';
2605 mg->mg_ptr[mg->mg_len - 1] = ')';
2606 mg->mg_ptr[mg->mg_len] = 0;
2608 PL_reginterp_cnt += re->program[0].next_off;
2610 if (re->reganch & ROPT_UTF8)
2620 =for apidoc sv_2pv_flags
2622 Returns a pointer to the string value of an SV, and sets *lp to its length.
2623 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2625 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2626 usually end up here too.
2632 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2642 if (SvGMAGICAL(sv)) {
2643 if (flags & SV_GMAGIC)
2648 if (flags & SV_MUTABLE_RETURN)
2649 return SvPVX_mutable(sv);
2650 if (flags & SV_CONST_RETURN)
2651 return (char *)SvPVX_const(sv);
2654 if (SvIOKp(sv) || SvNOKp(sv)) {
2655 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2659 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2660 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2662 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2669 #ifdef FIXNEGATIVEZERO
2670 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2676 SvUPGRADE(sv, SVt_PV);
2679 s = SvGROW_mutable(sv, len + 1);
2682 return memcpy(s, tbuf, len + 1);
2688 assert(SvTYPE(sv) >= SVt_PVMG);
2689 /* This falls through to the report_uninit near the end of the
2691 } else if (SvTHINKFIRST(sv)) {
2695 SV *const tmpstr = AMG_CALLun(sv,string);
2696 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2698 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2702 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2703 if (flags & SV_CONST_RETURN) {
2704 pv = (char *) SvPVX_const(tmpstr);
2706 pv = (flags & SV_MUTABLE_RETURN)
2707 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2710 *lp = SvCUR(tmpstr);
2712 pv = sv_2pv_flags(tmpstr, lp, flags);
2724 const SV *const referent = (SV*)SvRV(sv);
2727 tsv = sv_2mortal(newSVpvs("NULLREF"));
2728 } else if (SvTYPE(referent) == SVt_PVMG
2729 && ((SvFLAGS(referent) &
2730 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2731 == (SVs_OBJECT|SVs_SMG))
2732 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2733 return stringify_regexp(sv, mg, lp);
2735 const char *const typestr = sv_reftype(referent, 0);
2737 tsv = sv_newmortal();
2738 if (SvOBJECT(referent)) {
2739 const char *const name = HvNAME_get(SvSTASH(referent));
2740 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2741 name ? name : "__ANON__" , typestr,
2745 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2753 if (SvREADONLY(sv) && !SvOK(sv)) {
2754 if (ckWARN(WARN_UNINITIALIZED))
2761 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2762 /* I'm assuming that if both IV and NV are equally valid then
2763 converting the IV is going to be more efficient */
2764 const U32 isIOK = SvIOK(sv);
2765 const U32 isUIOK = SvIsUV(sv);
2766 char buf[TYPE_CHARS(UV)];
2769 if (SvTYPE(sv) < SVt_PVIV)
2770 sv_upgrade(sv, SVt_PVIV);
2771 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2772 /* inlined from sv_setpvn */
2773 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2774 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2775 SvCUR_set(sv, ebuf - ptr);
2785 else if (SvNOKp(sv)) {
2786 const int olderrno = errno;
2787 if (SvTYPE(sv) < SVt_PVNV)
2788 sv_upgrade(sv, SVt_PVNV);
2789 /* The +20 is pure guesswork. Configure test needed. --jhi */
2790 s = SvGROW_mutable(sv, NV_DIG + 20);
2791 /* some Xenix systems wipe out errno here */
2793 if (SvNVX(sv) == 0.0)
2794 (void)strcpy(s,"0");
2798 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2801 #ifdef FIXNEGATIVEZERO
2802 if (*s == '-' && s[1] == '0' && !s[2])
2812 if (((SvFLAGS(sv) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM)
2813 && (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV)) {
2814 return glob_2inpuv((GV *)sv, lp, FALSE);
2817 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2821 if (SvTYPE(sv) < SVt_PV)
2822 /* Typically the caller expects that sv_any is not NULL now. */
2823 sv_upgrade(sv, SVt_PV);
2827 const STRLEN len = s - SvPVX_const(sv);
2833 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2834 PTR2UV(sv),SvPVX_const(sv)));
2835 if (flags & SV_CONST_RETURN)
2836 return (char *)SvPVX_const(sv);
2837 if (flags & SV_MUTABLE_RETURN)
2838 return SvPVX_mutable(sv);
2843 =for apidoc sv_copypv
2845 Copies a stringified representation of the source SV into the
2846 destination SV. Automatically performs any necessary mg_get and
2847 coercion of numeric values into strings. Guaranteed to preserve
2848 UTF-8 flag even from overloaded objects. Similar in nature to
2849 sv_2pv[_flags] but operates directly on an SV instead of just the
2850 string. Mostly uses sv_2pv_flags to do its work, except when that
2851 would lose the UTF-8'ness of the PV.
2857 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2860 const char * const s = SvPV_const(ssv,len);
2861 sv_setpvn(dsv,s,len);
2869 =for apidoc sv_2pvbyte
2871 Return a pointer to the byte-encoded representation of the SV, and set *lp
2872 to its length. May cause the SV to be downgraded from UTF-8 as a
2875 Usually accessed via the C<SvPVbyte> macro.
2881 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2883 sv_utf8_downgrade(sv,0);
2884 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2888 =for apidoc sv_2pvutf8
2890 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2891 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2893 Usually accessed via the C<SvPVutf8> macro.
2899 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2901 sv_utf8_upgrade(sv);
2902 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2907 =for apidoc sv_2bool
2909 This function is only called on magical items, and is only used by
2910 sv_true() or its macro equivalent.
2916 Perl_sv_2bool(pTHX_ register SV *sv)
2925 SV * const tmpsv = AMG_CALLun(sv,bool_);
2926 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2927 return (bool)SvTRUE(tmpsv);
2929 return SvRV(sv) != 0;
2932 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2934 (*sv->sv_u.svu_pv > '0' ||
2935 Xpvtmp->xpv_cur > 1 ||
2936 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2943 return SvIVX(sv) != 0;
2946 return SvNVX(sv) != 0.0;
2948 if ((SvFLAGS(sv) & SVp_SCREAM)
2949 && (SvTYPE(sv) == (SVt_PVGV) || SvTYPE(sv) == (SVt_PVLV)))
2959 =for apidoc sv_utf8_upgrade
2961 Converts the PV of an SV to its UTF-8-encoded form.
2962 Forces the SV to string form if it is not already.
2963 Always sets the SvUTF8 flag to avoid future validity checks even
2964 if all the bytes have hibit clear.
2966 This is not as a general purpose byte encoding to Unicode interface:
2967 use the Encode extension for that.
2969 =for apidoc sv_utf8_upgrade_flags
2971 Converts the PV of an SV to its UTF-8-encoded form.
2972 Forces the SV to string form if it is not already.
2973 Always sets the SvUTF8 flag to avoid future validity checks even
2974 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2975 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2976 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2978 This is not as a general purpose byte encoding to Unicode interface:
2979 use the Encode extension for that.
2985 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2988 if (sv == &PL_sv_undef)
2992 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2993 (void) sv_2pv_flags(sv,&len, flags);
2997 (void) SvPV_force(sv,len);
3006 sv_force_normal_flags(sv, 0);
3009 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3010 sv_recode_to_utf8(sv, PL_encoding);
3011 else { /* Assume Latin-1/EBCDIC */
3012 /* This function could be much more efficient if we
3013 * had a FLAG in SVs to signal if there are any hibit
3014 * chars in the PV. Given that there isn't such a flag
3015 * make the loop as fast as possible. */
3016 const U8 * const s = (U8 *) SvPVX_const(sv);
3017 const U8 * const e = (U8 *) SvEND(sv);
3022 /* Check for hi bit */
3023 if (!NATIVE_IS_INVARIANT(ch)) {
3024 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3025 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3027 SvPV_free(sv); /* No longer using what was there before. */
3028 SvPV_set(sv, (char*)recoded);
3029 SvCUR_set(sv, len - 1);
3030 SvLEN_set(sv, len); /* No longer know the real size. */
3034 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3041 =for apidoc sv_utf8_downgrade
3043 Attempts to convert the PV of an SV from characters to bytes.
3044 If the PV contains a character beyond byte, this conversion will fail;
3045 in this case, either returns false or, if C<fail_ok> is not
3048 This is not as a general purpose Unicode to byte encoding interface:
3049 use the Encode extension for that.
3055 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3058 if (SvPOKp(sv) && SvUTF8(sv)) {
3064 sv_force_normal_flags(sv, 0);
3066 s = (U8 *) SvPV(sv, len);
3067 if (!utf8_to_bytes(s, &len)) {
3072 Perl_croak(aTHX_ "Wide character in %s",
3075 Perl_croak(aTHX_ "Wide character");
3086 =for apidoc sv_utf8_encode
3088 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3089 flag off so that it looks like octets again.
3095 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3097 (void) sv_utf8_upgrade(sv);
3099 sv_force_normal_flags(sv, 0);
3101 if (SvREADONLY(sv)) {
3102 Perl_croak(aTHX_ PL_no_modify);
3108 =for apidoc sv_utf8_decode
3110 If the PV of the SV is an octet sequence in UTF-8
3111 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3112 so that it looks like a character. If the PV contains only single-byte
3113 characters, the C<SvUTF8> flag stays being off.
3114 Scans PV for validity and returns false if the PV is invalid UTF-8.
3120 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3126 /* The octets may have got themselves encoded - get them back as
3129 if (!sv_utf8_downgrade(sv, TRUE))
3132 /* it is actually just a matter of turning the utf8 flag on, but
3133 * we want to make sure everything inside is valid utf8 first.
3135 c = (const U8 *) SvPVX_const(sv);
3136 if (!is_utf8_string(c, SvCUR(sv)+1))
3138 e = (const U8 *) SvEND(sv);
3141 if (!UTF8_IS_INVARIANT(ch)) {
3151 =for apidoc sv_setsv
3153 Copies the contents of the source SV C<ssv> into the destination SV
3154 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3155 function if the source SV needs to be reused. Does not handle 'set' magic.
3156 Loosely speaking, it performs a copy-by-value, obliterating any previous
3157 content of the destination.
3159 You probably want to use one of the assortment of wrappers, such as
3160 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3161 C<SvSetMagicSV_nosteal>.
3163 =for apidoc sv_setsv_flags
3165 Copies the contents of the source SV C<ssv> into the destination SV
3166 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3167 function if the source SV needs to be reused. Does not handle 'set' magic.
3168 Loosely speaking, it performs a copy-by-value, obliterating any previous
3169 content of the destination.
3170 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3171 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3172 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3173 and C<sv_setsv_nomg> are implemented in terms of this function.
3175 You probably want to use one of the assortment of wrappers, such as
3176 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3177 C<SvSetMagicSV_nosteal>.
3179 This is the primary function for copying scalars, and most other
3180 copy-ish functions and macros use this underneath.
3186 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3188 if (dtype != SVt_PVGV) {
3189 const char * const name = GvNAME(sstr);
3190 const STRLEN len = GvNAMELEN(sstr);
3191 /* don't upgrade SVt_PVLV: it can hold a glob */
3192 if (dtype != SVt_PVLV)
3193 sv_upgrade(dstr, SVt_PVGV);
3194 GvSTASH(dstr) = GvSTASH(sstr);
3196 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3197 GvNAME(dstr) = savepvn(name, len);
3198 GvNAMELEN(dstr) = len;
3199 SvFAKE_on(dstr); /* can coerce to non-glob */
3202 #ifdef GV_UNIQUE_CHECK
3203 if (GvUNIQUE((GV*)dstr)) {
3204 Perl_croak(aTHX_ PL_no_modify);
3208 (void)SvOK_off(dstr);
3210 GvINTRO_off(dstr); /* one-shot flag */
3212 GvGP(dstr) = gp_ref(GvGP(sstr));
3213 if (SvTAINTED(sstr))
3215 if (GvIMPORTED(dstr) != GVf_IMPORTED
3216 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3218 GvIMPORTED_on(dstr);
3225 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3226 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3228 const int intro = GvINTRO(dstr);
3231 const U32 stype = SvTYPE(sref);
3234 #ifdef GV_UNIQUE_CHECK
3235 if (GvUNIQUE((GV*)dstr)) {
3236 Perl_croak(aTHX_ PL_no_modify);
3241 GvINTRO_off(dstr); /* one-shot flag */
3242 GvLINE(dstr) = CopLINE(PL_curcop);
3243 GvEGV(dstr) = (GV*)dstr;
3248 location = (SV **) &GvCV(dstr);
3249 import_flag = GVf_IMPORTED_CV;
3252 location = (SV **) &GvHV(dstr);
3253 import_flag = GVf_IMPORTED_HV;
3256 location = (SV **) &GvAV(dstr);
3257 import_flag = GVf_IMPORTED_AV;
3260 location = (SV **) &GvIOp(dstr);
3263 location = (SV **) &GvFORM(dstr);
3265 location = &GvSV(dstr);
3266 import_flag = GVf_IMPORTED_SV;
3269 if (stype == SVt_PVCV) {
3270 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3271 SvREFCNT_dec(GvCV(dstr));
3273 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3274 PL_sub_generation++;
3277 SAVEGENERICSV(*location);
3281 if (stype == SVt_PVCV && *location != sref) {
3282 CV* const cv = (CV*)*location;
3284 if (!GvCVGEN((GV*)dstr) &&
3285 (CvROOT(cv) || CvXSUB(cv)))
3287 /* Redefining a sub - warning is mandatory if
3288 it was a const and its value changed. */
3289 if (CvCONST(cv) && CvCONST((CV*)sref)
3290 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3292 /* They are 2 constant subroutines generated from
3293 the same constant. This probably means that
3294 they are really the "same" proxy subroutine
3295 instantiated in 2 places. Most likely this is
3296 when a constant is exported twice. Don't warn.
3299 else if (ckWARN(WARN_REDEFINE)
3301 && (!CvCONST((CV*)sref)
3302 || sv_cmp(cv_const_sv(cv),
3303 cv_const_sv((CV*)sref))))) {
3304 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3306 ? "Constant subroutine %s::%s redefined"
3307 : "Subroutine %s::%s redefined",
3308 HvNAME_get(GvSTASH((GV*)dstr)),
3309 GvENAME((GV*)dstr));
3313 cv_ckproto(cv, (GV*)dstr,
3314 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3316 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3317 GvASSUMECV_on(dstr);
3318 PL_sub_generation++;
3321 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3322 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3323 GvFLAGS(dstr) |= import_flag;
3329 if (SvTAINTED(sstr))
3335 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3338 register U32 sflags;
3344 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3346 sstr = &PL_sv_undef;
3347 stype = SvTYPE(sstr);
3348 dtype = SvTYPE(dstr);
3353 /* need to nuke the magic */
3355 SvRMAGICAL_off(dstr);
3358 /* There's a lot of redundancy below but we're going for speed here */
3363 if (dtype != SVt_PVGV) {
3364 (void)SvOK_off(dstr);
3372 sv_upgrade(dstr, SVt_IV);
3377 sv_upgrade(dstr, SVt_PVIV);
3380 (void)SvIOK_only(dstr);
3381 SvIV_set(dstr, SvIVX(sstr));
3384 /* SvTAINTED can only be true if the SV has taint magic, which in
3385 turn means that the SV type is PVMG (or greater). This is the
3386 case statement for SVt_IV, so this cannot be true (whatever gcov
3388 assert(!SvTAINTED(sstr));
3398 sv_upgrade(dstr, SVt_NV);
3403 sv_upgrade(dstr, SVt_PVNV);
3406 SvNV_set(dstr, SvNVX(sstr));
3407 (void)SvNOK_only(dstr);
3408 /* SvTAINTED can only be true if the SV has taint magic, which in
3409 turn means that the SV type is PVMG (or greater). This is the
3410 case statement for SVt_NV, so this cannot be true (whatever gcov
3412 assert(!SvTAINTED(sstr));
3419 sv_upgrade(dstr, SVt_RV);
3422 #ifdef PERL_OLD_COPY_ON_WRITE
3423 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3424 if (dtype < SVt_PVIV)
3425 sv_upgrade(dstr, SVt_PVIV);
3432 sv_upgrade(dstr, SVt_PV);
3435 if (dtype < SVt_PVIV)
3436 sv_upgrade(dstr, SVt_PVIV);
3439 if (dtype < SVt_PVNV)
3440 sv_upgrade(dstr, SVt_PVNV);
3447 const char * const type = sv_reftype(sstr,0);
3449 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3451 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3456 if (dtype <= SVt_PVGV) {
3457 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3463 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3465 if ((int)SvTYPE(sstr) != stype) {
3466 stype = SvTYPE(sstr);
3467 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3468 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3473 if (stype == SVt_PVLV)
3474 SvUPGRADE(dstr, SVt_PVNV);
3476 SvUPGRADE(dstr, (U32)stype);
3479 /* dstr may have been upgraded. */
3480 dtype = SvTYPE(dstr);
3481 sflags = SvFLAGS(sstr);
3483 if (sflags & SVf_ROK) {
3484 if (dtype == SVt_PVGV &&
3485 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3488 if (GvIMPORTED(dstr) != GVf_IMPORTED
3489 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3491 GvIMPORTED_on(dstr);
3496 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3500 if (dtype >= SVt_PV) {
3501 if (dtype == SVt_PVGV) {
3502 S_glob_assign_ref(aTHX_ dstr, sstr);
3505 if (SvPVX_const(dstr)) {
3511 (void)SvOK_off(dstr);
3512 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3513 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3514 assert(!(sflags & SVp_NOK));
3515 assert(!(sflags & SVp_IOK));
3516 assert(!(sflags & SVf_NOK));
3517 assert(!(sflags & SVf_IOK));
3519 else if (dtype == SVt_PVGV) {
3520 if (!(sflags & SVf_OK)) {
3521 if (ckWARN(WARN_MISC))
3522 Perl_warner(aTHX_ packWARN(WARN_MISC),
3523 "Undefined value assigned to typeglob");
3526 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3527 if (dstr != (SV*)gv) {
3530 GvGP(dstr) = gp_ref(GvGP(gv));
3534 else if (sflags & SVp_POK) {
3538 * Check to see if we can just swipe the string. If so, it's a
3539 * possible small lose on short strings, but a big win on long ones.
3540 * It might even be a win on short strings if SvPVX_const(dstr)
3541 * has to be allocated and SvPVX_const(sstr) has to be freed.
3544 /* Whichever path we take through the next code, we want this true,
3545 and doing it now facilitates the COW check. */
3546 (void)SvPOK_only(dstr);
3549 /* We're not already COW */
3550 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3551 #ifndef PERL_OLD_COPY_ON_WRITE
3552 /* or we are, but dstr isn't a suitable target. */
3553 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3558 (sflags & SVs_TEMP) && /* slated for free anyway? */
3559 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3560 (!(flags & SV_NOSTEAL)) &&
3561 /* and we're allowed to steal temps */
3562 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3563 SvLEN(sstr) && /* and really is a string */
3564 /* and won't be needed again, potentially */
3565 !(PL_op && PL_op->op_type == OP_AASSIGN))
3566 #ifdef PERL_OLD_COPY_ON_WRITE
3567 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3568 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3569 && SvTYPE(sstr) >= SVt_PVIV)
3572 /* Failed the swipe test, and it's not a shared hash key either.
3573 Have to copy the string. */
3574 STRLEN len = SvCUR(sstr);
3575 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3576 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3577 SvCUR_set(dstr, len);
3578 *SvEND(dstr) = '\0';
3580 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3582 /* Either it's a shared hash key, or it's suitable for
3583 copy-on-write or we can swipe the string. */
3585 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3589 #ifdef PERL_OLD_COPY_ON_WRITE
3591 /* I believe I should acquire a global SV mutex if
3592 it's a COW sv (not a shared hash key) to stop
3593 it going un copy-on-write.
3594 If the source SV has gone un copy on write between up there
3595 and down here, then (assert() that) it is of the correct
3596 form to make it copy on write again */
3597 if ((sflags & (SVf_FAKE | SVf_READONLY))
3598 != (SVf_FAKE | SVf_READONLY)) {
3599 SvREADONLY_on(sstr);
3601 /* Make the source SV into a loop of 1.
3602 (about to become 2) */
3603 SV_COW_NEXT_SV_SET(sstr, sstr);
3607 /* Initial code is common. */
3608 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3613 /* making another shared SV. */
3614 STRLEN cur = SvCUR(sstr);
3615 STRLEN len = SvLEN(sstr);
3616 #ifdef PERL_OLD_COPY_ON_WRITE
3618 assert (SvTYPE(dstr) >= SVt_PVIV);
3619 /* SvIsCOW_normal */
3620 /* splice us in between source and next-after-source. */
3621 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3622 SV_COW_NEXT_SV_SET(sstr, dstr);
3623 SvPV_set(dstr, SvPVX_mutable(sstr));
3627 /* SvIsCOW_shared_hash */
3628 DEBUG_C(PerlIO_printf(Perl_debug_log,
3629 "Copy on write: Sharing hash\n"));
3631 assert (SvTYPE(dstr) >= SVt_PV);
3633 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3635 SvLEN_set(dstr, len);
3636 SvCUR_set(dstr, cur);
3637 SvREADONLY_on(dstr);
3639 /* Relesase a global SV mutex. */
3642 { /* Passes the swipe test. */
3643 SvPV_set(dstr, SvPVX_mutable(sstr));
3644 SvLEN_set(dstr, SvLEN(sstr));
3645 SvCUR_set(dstr, SvCUR(sstr));
3648 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3649 SvPV_set(sstr, NULL);
3655 if (sflags & SVp_NOK) {
3656 SvNV_set(dstr, SvNVX(sstr));
3658 if (sflags & SVp_IOK) {
3659 SvRELEASE_IVX(dstr);
3660 SvIV_set(dstr, SvIVX(sstr));
3661 /* Must do this otherwise some other overloaded use of 0x80000000
3662 gets confused. I guess SVpbm_VALID */
3663 if (sflags & SVf_IVisUV)
3666 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3668 const MAGIC * const smg = SvVOK(sstr);
3670 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3671 smg->mg_ptr, smg->mg_len);
3672 SvRMAGICAL_on(dstr);
3676 else if (sflags & (SVp_IOK|SVp_NOK)) {
3677 (void)SvOK_off(dstr);
3678 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3679 if (sflags & SVp_IOK) {
3680 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3681 SvIV_set(dstr, SvIVX(sstr));
3683 if (sflags & SVp_NOK) {
3684 SvNV_set(dstr, SvNVX(sstr));
3688 if ((stype == SVt_PVGV || stype == SVt_PVLV)
3689 && (sflags & SVp_SCREAM)) {
3690 /* This stringification rule for globs is spread in 3 places.
3691 This feels bad. FIXME. */
3692 const U32 wasfake = sflags & SVf_FAKE;
3694 /* FAKE globs can get coerced, so need to turn this off
3695 temporarily if it is on. */
3697 gv_efullname3(dstr, (GV *)sstr, "*");
3698 SvFLAGS(sstr) |= wasfake;
3701 (void)SvOK_off(dstr);
3703 if (SvTAINTED(sstr))
3708 =for apidoc sv_setsv_mg
3710 Like C<sv_setsv>, but also handles 'set' magic.
3716 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3718 sv_setsv(dstr,sstr);
3722 #ifdef PERL_OLD_COPY_ON_WRITE
3724 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3726 STRLEN cur = SvCUR(sstr);
3727 STRLEN len = SvLEN(sstr);
3728 register char *new_pv;
3731 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3739 if (SvTHINKFIRST(dstr))
3740 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3741 else if (SvPVX_const(dstr))
3742 Safefree(SvPVX_const(dstr));
3746 SvUPGRADE(dstr, SVt_PVIV);
3748 assert (SvPOK(sstr));
3749 assert (SvPOKp(sstr));
3750 assert (!SvIOK(sstr));
3751 assert (!SvIOKp(sstr));
3752 assert (!SvNOK(sstr));
3753 assert (!SvNOKp(sstr));
3755 if (SvIsCOW(sstr)) {
3757 if (SvLEN(sstr) == 0) {
3758 /* source is a COW shared hash key. */
3759 DEBUG_C(PerlIO_printf(Perl_debug_log,
3760 "Fast copy on write: Sharing hash\n"));
3761 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3764 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3766 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3767 SvUPGRADE(sstr, SVt_PVIV);
3768 SvREADONLY_on(sstr);
3770 DEBUG_C(PerlIO_printf(Perl_debug_log,
3771 "Fast copy on write: Converting sstr to COW\n"));
3772 SV_COW_NEXT_SV_SET(dstr, sstr);
3774 SV_COW_NEXT_SV_SET(sstr, dstr);
3775 new_pv = SvPVX_mutable(sstr);
3778 SvPV_set(dstr, new_pv);
3779 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3782 SvLEN_set(dstr, len);
3783 SvCUR_set(dstr, cur);
3792 =for apidoc sv_setpvn
3794 Copies a string into an SV. The C<len> parameter indicates the number of
3795 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3796 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3802 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3805 register char *dptr;
3807 SV_CHECK_THINKFIRST_COW_DROP(sv);
3813 /* len is STRLEN which is unsigned, need to copy to signed */
3816 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3818 SvUPGRADE(sv, SVt_PV);
3820 dptr = SvGROW(sv, len + 1);
3821 Move(ptr,dptr,len,char);
3824 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3829 =for apidoc sv_setpvn_mg
3831 Like C<sv_setpvn>, but also handles 'set' magic.
3837 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3839 sv_setpvn(sv,ptr,len);
3844 =for apidoc sv_setpv
3846 Copies a string into an SV. The string must be null-terminated. Does not
3847 handle 'set' magic. See C<sv_setpv_mg>.
3853 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3856 register STRLEN len;
3858 SV_CHECK_THINKFIRST_COW_DROP(sv);
3864 SvUPGRADE(sv, SVt_PV);
3866 SvGROW(sv, len + 1);
3867 Move(ptr,SvPVX(sv),len+1,char);
3869 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3874 =for apidoc sv_setpv_mg
3876 Like C<sv_setpv>, but also handles 'set' magic.
3882 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3889 =for apidoc sv_usepvn
3891 Tells an SV to use C<ptr> to find its string value. Normally the string is
3892 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3893 The C<ptr> should point to memory that was allocated by C<malloc>. The
3894 string length, C<len>, must be supplied. This function will realloc the
3895 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3896 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3897 See C<sv_usepvn_mg>.
3903 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3907 SV_CHECK_THINKFIRST_COW_DROP(sv);
3908 SvUPGRADE(sv, SVt_PV);
3913 if (SvPVX_const(sv))
3916 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3917 ptr = saferealloc (ptr, allocate);
3920 SvLEN_set(sv, allocate);
3922 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3927 =for apidoc sv_usepvn_mg
3929 Like C<sv_usepvn>, but also handles 'set' magic.
3935 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3937 sv_usepvn(sv,ptr,len);
3941 #ifdef PERL_OLD_COPY_ON_WRITE
3942 /* Need to do this *after* making the SV normal, as we need the buffer
3943 pointer to remain valid until after we've copied it. If we let go too early,
3944 another thread could invalidate it by unsharing last of the same hash key
3945 (which it can do by means other than releasing copy-on-write Svs)
3946 or by changing the other copy-on-write SVs in the loop. */
3948 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3950 if (len) { /* this SV was SvIsCOW_normal(sv) */
3951 /* we need to find the SV pointing to us. */
3952 SV *current = SV_COW_NEXT_SV(after);
3954 if (current == sv) {
3955 /* The SV we point to points back to us (there were only two of us
3957 Hence other SV is no longer copy on write either. */
3959 SvREADONLY_off(after);
3961 /* We need to follow the pointers around the loop. */
3963 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3966 /* don't loop forever if the structure is bust, and we have
3967 a pointer into a closed loop. */
3968 assert (current != after);
3969 assert (SvPVX_const(current) == pvx);
3971 /* Make the SV before us point to the SV after us. */
3972 SV_COW_NEXT_SV_SET(current, after);
3975 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3980 Perl_sv_release_IVX(pTHX_ register SV *sv)
3983 sv_force_normal_flags(sv, 0);
3989 =for apidoc sv_force_normal_flags
3991 Undo various types of fakery on an SV: if the PV is a shared string, make
3992 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3993 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3994 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3995 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3996 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3997 set to some other value.) In addition, the C<flags> parameter gets passed to
3998 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3999 with flags set to 0.
4005 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4008 #ifdef PERL_OLD_COPY_ON_WRITE
4009 if (SvREADONLY(sv)) {
4010 /* At this point I believe I should acquire a global SV mutex. */
4012 const char * const pvx = SvPVX_const(sv);
4013 const STRLEN len = SvLEN(sv);
4014 const STRLEN cur = SvCUR(sv);
4015 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4017 PerlIO_printf(Perl_debug_log,
4018 "Copy on write: Force normal %ld\n",
4024 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4027 if (flags & SV_COW_DROP_PV) {
4028 /* OK, so we don't need to copy our buffer. */
4031 SvGROW(sv, cur + 1);
4032 Move(pvx,SvPVX(sv),cur,char);
4036 sv_release_COW(sv, pvx, len, next);
4041 else if (IN_PERL_RUNTIME)
4042 Perl_croak(aTHX_ PL_no_modify);
4043 /* At this point I believe that I can drop the global SV mutex. */
4046 if (SvREADONLY(sv)) {
4048 const char * const pvx = SvPVX_const(sv);
4049 const STRLEN len = SvCUR(sv);
4054 SvGROW(sv, len + 1);
4055 Move(pvx,SvPVX(sv),len,char);
4057 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4059 else if (IN_PERL_RUNTIME)
4060 Perl_croak(aTHX_ PL_no_modify);
4064 sv_unref_flags(sv, flags);
4065 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4072 Efficient removal of characters from the beginning of the string buffer.
4073 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4074 the string buffer. The C<ptr> becomes the first character of the adjusted
4075 string. Uses the "OOK hack".
4076 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4077 refer to the same chunk of data.
4083 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4085 register STRLEN delta;
4086 if (!ptr || !SvPOKp(sv))
4088 delta = ptr - SvPVX_const(sv);
4089 SV_CHECK_THINKFIRST(sv);
4090 if (SvTYPE(sv) < SVt_PVIV)
4091 sv_upgrade(sv,SVt_PVIV);
4094 if (!SvLEN(sv)) { /* make copy of shared string */
4095 const char *pvx = SvPVX_const(sv);
4096 const STRLEN len = SvCUR(sv);
4097 SvGROW(sv, len + 1);
4098 Move(pvx,SvPVX(sv),len,char);
4102 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4103 and we do that anyway inside the SvNIOK_off
4105 SvFLAGS(sv) |= SVf_OOK;
4108 SvLEN_set(sv, SvLEN(sv) - delta);
4109 SvCUR_set(sv, SvCUR(sv) - delta);
4110 SvPV_set(sv, SvPVX(sv) + delta);
4111 SvIV_set(sv, SvIVX(sv) + delta);
4115 =for apidoc sv_catpvn
4117 Concatenates the string onto the end of the string which is in the SV. The
4118 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4119 status set, then the bytes appended should be valid UTF-8.
4120 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4122 =for apidoc sv_catpvn_flags
4124 Concatenates the string onto the end of the string which is in the SV. The
4125 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4126 status set, then the bytes appended should be valid UTF-8.
4127 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4128 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4129 in terms of this function.
4135 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4139 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4141 SvGROW(dsv, dlen + slen + 1);
4143 sstr = SvPVX_const(dsv);
4144 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4145 SvCUR_set(dsv, SvCUR(dsv) + slen);
4147 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4149 if (flags & SV_SMAGIC)
4154 =for apidoc sv_catsv
4156 Concatenates the string from SV C<ssv> onto the end of the string in
4157 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4158 not 'set' magic. See C<sv_catsv_mg>.
4160 =for apidoc sv_catsv_flags
4162 Concatenates the string from SV C<ssv> onto the end of the string in
4163 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4164 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4165 and C<sv_catsv_nomg> are implemented in terms of this function.
4170 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4175 const char *spv = SvPV_const(ssv, slen);
4177 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4178 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4179 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4180 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4181 dsv->sv_flags doesn't have that bit set.
4182 Andy Dougherty 12 Oct 2001
4184 const I32 sutf8 = DO_UTF8(ssv);
4187 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4189 dutf8 = DO_UTF8(dsv);
4191 if (dutf8 != sutf8) {
4193 /* Not modifying source SV, so taking a temporary copy. */
4194 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4196 sv_utf8_upgrade(csv);
4197 spv = SvPV_const(csv, slen);
4200 sv_utf8_upgrade_nomg(dsv);
4202 sv_catpvn_nomg(dsv, spv, slen);
4205 if (flags & SV_SMAGIC)
4210 =for apidoc sv_catpv
4212 Concatenates the string onto the end of the string which is in the SV.
4213 If the SV has the UTF-8 status set, then the bytes appended should be
4214 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4219 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4222 register STRLEN len;
4228 junk = SvPV_force(sv, tlen);
4230 SvGROW(sv, tlen + len + 1);
4232 ptr = SvPVX_const(sv);
4233 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4234 SvCUR_set(sv, SvCUR(sv) + len);
4235 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4240 =for apidoc sv_catpv_mg
4242 Like C<sv_catpv>, but also handles 'set' magic.
4248 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4257 Creates a new SV. A non-zero C<len> parameter indicates the number of
4258 bytes of preallocated string space the SV should have. An extra byte for a
4259 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4260 space is allocated.) The reference count for the new SV is set to 1.
4262 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4263 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4264 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4265 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4266 modules supporting older perls.
4272 Perl_newSV(pTHX_ STRLEN len)
4279 sv_upgrade(sv, SVt_PV);
4280 SvGROW(sv, len + 1);
4285 =for apidoc sv_magicext
4287 Adds magic to an SV, upgrading it if necessary. Applies the
4288 supplied vtable and returns a pointer to the magic added.
4290 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4291 In particular, you can add magic to SvREADONLY SVs, and add more than
4292 one instance of the same 'how'.
4294 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4295 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4296 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4297 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4299 (This is now used as a subroutine by C<sv_magic>.)
4304 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4305 const char* name, I32 namlen)
4310 if (SvTYPE(sv) < SVt_PVMG) {
4311 SvUPGRADE(sv, SVt_PVMG);
4313 Newxz(mg, 1, MAGIC);
4314 mg->mg_moremagic = SvMAGIC(sv);
4315 SvMAGIC_set(sv, mg);
4317 /* Sometimes a magic contains a reference loop, where the sv and
4318 object refer to each other. To prevent a reference loop that
4319 would prevent such objects being freed, we look for such loops
4320 and if we find one we avoid incrementing the object refcount.
4322 Note we cannot do this to avoid self-tie loops as intervening RV must
4323 have its REFCNT incremented to keep it in existence.
4326 if (!obj || obj == sv ||
4327 how == PERL_MAGIC_arylen ||
4328 how == PERL_MAGIC_qr ||
4329 how == PERL_MAGIC_symtab ||
4330 (SvTYPE(obj) == SVt_PVGV &&
4331 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4332 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4333 GvFORM(obj) == (CV*)sv)))
4338 mg->mg_obj = SvREFCNT_inc(obj);
4339 mg->mg_flags |= MGf_REFCOUNTED;
4342 /* Normal self-ties simply pass a null object, and instead of
4343 using mg_obj directly, use the SvTIED_obj macro to produce a
4344 new RV as needed. For glob "self-ties", we are tieing the PVIO
4345 with an RV obj pointing to the glob containing the PVIO. In
4346 this case, to avoid a reference loop, we need to weaken the
4350 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4351 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4357 mg->mg_len = namlen;
4360 mg->mg_ptr = savepvn(name, namlen);
4361 else if (namlen == HEf_SVKEY)
4362 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4364 mg->mg_ptr = (char *) name;
4366 mg->mg_virtual = vtable;
4370 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4375 =for apidoc sv_magic
4377 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4378 then adds a new magic item of type C<how> to the head of the magic list.
4380 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4381 handling of the C<name> and C<namlen> arguments.
4383 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4384 to add more than one instance of the same 'how'.
4390 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4396 #ifdef PERL_OLD_COPY_ON_WRITE
4398 sv_force_normal_flags(sv, 0);
4400 if (SvREADONLY(sv)) {
4402 /* its okay to attach magic to shared strings; the subsequent
4403 * upgrade to PVMG will unshare the string */
4404 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4407 && how != PERL_MAGIC_regex_global
4408 && how != PERL_MAGIC_bm
4409 && how != PERL_MAGIC_fm
4410 && how != PERL_MAGIC_sv
4411 && how != PERL_MAGIC_backref
4414 Perl_croak(aTHX_ PL_no_modify);
4417 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4418 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4419 /* sv_magic() refuses to add a magic of the same 'how' as an
4422 if (how == PERL_MAGIC_taint) {
4424 /* Any scalar which already had taint magic on which someone
4425 (erroneously?) did SvIOK_on() or similar will now be
4426 incorrectly sporting public "OK" flags. */
4427 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4435 vtable = &PL_vtbl_sv;
4437 case PERL_MAGIC_overload:
4438 vtable = &PL_vtbl_amagic;
4440 case PERL_MAGIC_overload_elem:
4441 vtable = &PL_vtbl_amagicelem;
4443 case PERL_MAGIC_overload_table:
4444 vtable = &PL_vtbl_ovrld;
4447 vtable = &PL_vtbl_bm;
4449 case PERL_MAGIC_regdata:
4450 vtable = &PL_vtbl_regdata;
4452 case PERL_MAGIC_regdatum:
4453 vtable = &PL_vtbl_regdatum;
4455 case PERL_MAGIC_env:
4456 vtable = &PL_vtbl_env;
4459 vtable = &PL_vtbl_fm;
4461 case PERL_MAGIC_envelem:
4462 vtable = &PL_vtbl_envelem;
4464 case PERL_MAGIC_regex_global:
4465 vtable = &PL_vtbl_mglob;
4467 case PERL_MAGIC_isa:
4468 vtable = &PL_vtbl_isa;
4470 case PERL_MAGIC_isaelem:
4471 vtable = &PL_vtbl_isaelem;
4473 case PERL_MAGIC_nkeys:
4474 vtable = &PL_vtbl_nkeys;
4476 case PERL_MAGIC_dbfile:
4479 case PERL_MAGIC_dbline:
4480 vtable = &PL_vtbl_dbline;
4482 #ifdef USE_LOCALE_COLLATE
4483 case PERL_MAGIC_collxfrm:
4484 vtable = &PL_vtbl_collxfrm;
4486 #endif /* USE_LOCALE_COLLATE */
4487 case PERL_MAGIC_tied:
4488 vtable = &PL_vtbl_pack;
4490 case PERL_MAGIC_tiedelem:
4491 case PERL_MAGIC_tiedscalar:
4492 vtable = &PL_vtbl_packelem;
4495 vtable = &PL_vtbl_regexp;
4497 case PERL_MAGIC_sig:
4498 vtable = &PL_vtbl_sig;
4500 case PERL_MAGIC_sigelem:
4501 vtable = &PL_vtbl_sigelem;
4503 case PERL_MAGIC_taint:
4504 vtable = &PL_vtbl_taint;
4506 case PERL_MAGIC_uvar:
4507 vtable = &PL_vtbl_uvar;
4509 case PERL_MAGIC_vec:
4510 vtable = &PL_vtbl_vec;
4512 case PERL_MAGIC_arylen_p:
4513 case PERL_MAGIC_rhash:
4514 case PERL_MAGIC_symtab:
4515 case PERL_MAGIC_vstring:
4518 case PERL_MAGIC_utf8:
4519 vtable = &PL_vtbl_utf8;
4521 case PERL_MAGIC_substr:
4522 vtable = &PL_vtbl_substr;
4524 case PERL_MAGIC_defelem:
4525 vtable = &PL_vtbl_defelem;
4527 case PERL_MAGIC_arylen:
4528 vtable = &PL_vtbl_arylen;
4530 case PERL_MAGIC_pos:
4531 vtable = &PL_vtbl_pos;
4533 case PERL_MAGIC_backref:
4534 vtable = &PL_vtbl_backref;
4536 case PERL_MAGIC_ext:
4537 /* Reserved for use by extensions not perl internals. */
4538 /* Useful for attaching extension internal data to perl vars. */
4539 /* Note that multiple extensions may clash if magical scalars */
4540 /* etc holding private data from one are passed to another. */
4544 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4547 /* Rest of work is done else where */
4548 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4551 case PERL_MAGIC_taint:
4554 case PERL_MAGIC_ext:
4555 case PERL_MAGIC_dbfile:
4562 =for apidoc sv_unmagic
4564 Removes all magic of type C<type> from an SV.
4570 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4574 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4577 for (mg = *mgp; mg; mg = *mgp) {
4578 if (mg->mg_type == type) {
4579 const MGVTBL* const vtbl = mg->mg_virtual;
4580 *mgp = mg->mg_moremagic;
4581 if (vtbl && vtbl->svt_free)
4582 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4583 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4585 Safefree(mg->mg_ptr);
4586 else if (mg->mg_len == HEf_SVKEY)
4587 SvREFCNT_dec((SV*)mg->mg_ptr);
4588 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4589 Safefree(mg->mg_ptr);
4591 if (mg->mg_flags & MGf_REFCOUNTED)
4592 SvREFCNT_dec(mg->mg_obj);
4596 mgp = &mg->mg_moremagic;
4600 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4601 SvMAGIC_set(sv, NULL);
4608 =for apidoc sv_rvweaken
4610 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4611 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4612 push a back-reference to this RV onto the array of backreferences
4613 associated with that magic.
4619 Perl_sv_rvweaken(pTHX_ SV *sv)
4622 if (!SvOK(sv)) /* let undefs pass */
4625 Perl_croak(aTHX_ "Can't weaken a nonreference");
4626 else if (SvWEAKREF(sv)) {
4627 if (ckWARN(WARN_MISC))
4628 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4632 Perl_sv_add_backref(aTHX_ tsv, sv);
4638 /* Give tsv backref magic if it hasn't already got it, then push a
4639 * back-reference to sv onto the array associated with the backref magic.
4643 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4648 if (SvTYPE(tsv) == SVt_PVHV) {
4649 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4653 /* There is no AV in the offical place - try a fixup. */
4654 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4657 /* Aha. They've got it stowed in magic. Bring it back. */
4658 av = (AV*)mg->mg_obj;
4659 /* Stop mg_free decreasing the refernce count. */
4661 /* Stop mg_free even calling the destructor, given that
4662 there's no AV to free up. */
4664 sv_unmagic(tsv, PERL_MAGIC_backref);
4673 const MAGIC *const mg
4674 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4676 av = (AV*)mg->mg_obj;
4680 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4681 /* av now has a refcnt of 2, which avoids it getting freed
4682 * before us during global cleanup. The extra ref is removed
4683 * by magic_killbackrefs() when tsv is being freed */
4686 if (AvFILLp(av) >= AvMAX(av)) {
4687 av_extend(av, AvFILLp(av)+1);
4689 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4692 /* delete a back-reference to ourselves from the backref magic associated
4693 * with the SV we point to.
4697 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4704 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4705 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4706 /* We mustn't attempt to "fix up" the hash here by moving the
4707 backreference array back to the hv_aux structure, as that is stored
4708 in the main HvARRAY(), and hfreentries assumes that no-one
4709 reallocates HvARRAY() while it is running. */
4712 const MAGIC *const mg
4713 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4715 av = (AV *)mg->mg_obj;
4718 if (PL_in_clean_all)
4720 Perl_croak(aTHX_ "panic: del_backref");
4727 /* We shouldn't be in here more than once, but for paranoia reasons lets
4729 for (i = AvFILLp(av); i >= 0; i--) {
4731 const SSize_t fill = AvFILLp(av);
4733 /* We weren't the last entry.
4734 An unordered list has this property that you can take the
4735 last element off the end to fill the hole, and it's still
4736 an unordered list :-)
4741 AvFILLp(av) = fill - 1;
4747 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4749 SV **svp = AvARRAY(av);
4751 PERL_UNUSED_ARG(sv);
4753 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4754 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4755 if (svp && !SvIS_FREED(av)) {
4756 SV *const *const last = svp + AvFILLp(av);
4758 while (svp <= last) {
4760 SV *const referrer = *svp;
4761 if (SvWEAKREF(referrer)) {
4762 /* XXX Should we check that it hasn't changed? */
4763 SvRV_set(referrer, 0);
4765 SvWEAKREF_off(referrer);
4766 } else if (SvTYPE(referrer) == SVt_PVGV ||
4767 SvTYPE(referrer) == SVt_PVLV) {
4768 /* You lookin' at me? */
4769 assert(GvSTASH(referrer));
4770 assert(GvSTASH(referrer) == (HV*)sv);
4771 GvSTASH(referrer) = 0;
4774 "panic: magic_killbackrefs (flags=%"UVxf")",
4775 (UV)SvFLAGS(referrer));
4783 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4788 =for apidoc sv_insert
4790 Inserts a string at the specified offset/length within the SV. Similar to
4791 the Perl substr() function.
4797 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4802 register char *midend;
4803 register char *bigend;
4809 Perl_croak(aTHX_ "Can't modify non-existent substring");
4810 SvPV_force(bigstr, curlen);
4811 (void)SvPOK_only_UTF8(bigstr);
4812 if (offset + len > curlen) {
4813 SvGROW(bigstr, offset+len+1);
4814 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4815 SvCUR_set(bigstr, offset+len);
4819 i = littlelen - len;
4820 if (i > 0) { /* string might grow */
4821 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4822 mid = big + offset + len;
4823 midend = bigend = big + SvCUR(bigstr);
4826 while (midend > mid) /* shove everything down */
4827 *--bigend = *--midend;
4828 Move(little,big+offset,littlelen,char);
4829 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4834 Move(little,SvPVX(bigstr)+offset,len,char);
4839 big = SvPVX(bigstr);
4842 bigend = big + SvCUR(bigstr);
4844 if (midend > bigend)
4845 Perl_croak(aTHX_ "panic: sv_insert");
4847 if (mid - big > bigend - midend) { /* faster to shorten from end */
4849 Move(little, mid, littlelen,char);
4852 i = bigend - midend;
4854 Move(midend, mid, i,char);
4858 SvCUR_set(bigstr, mid - big);
4860 else if ((i = mid - big)) { /* faster from front */
4861 midend -= littlelen;
4863 sv_chop(bigstr,midend-i);
4868 Move(little, mid, littlelen,char);
4870 else if (littlelen) {
4871 midend -= littlelen;
4872 sv_chop(bigstr,midend);
4873 Move(little,midend,littlelen,char);
4876 sv_chop(bigstr,midend);
4882 =for apidoc sv_replace
4884 Make the first argument a copy of the second, then delete the original.
4885 The target SV physically takes over ownership of the body of the source SV
4886 and inherits its flags; however, the target keeps any magic it owns,
4887 and any magic in the source is discarded.
4888 Note that this is a rather specialist SV copying operation; most of the
4889 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4895 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4898 const U32 refcnt = SvREFCNT(sv);
4899 SV_CHECK_THINKFIRST_COW_DROP(sv);
4900 if (SvREFCNT(nsv) != 1) {
4901 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4902 UVuf " != 1)", (UV) SvREFCNT(nsv));
4904 if (SvMAGICAL(sv)) {
4908 sv_upgrade(nsv, SVt_PVMG);
4909 SvMAGIC_set(nsv, SvMAGIC(sv));
4910 SvFLAGS(nsv) |= SvMAGICAL(sv);
4912 SvMAGIC_set(sv, NULL);
4916 assert(!SvREFCNT(sv));
4917 #ifdef DEBUG_LEAKING_SCALARS
4918 sv->sv_flags = nsv->sv_flags;
4919 sv->sv_any = nsv->sv_any;
4920 sv->sv_refcnt = nsv->sv_refcnt;
4921 sv->sv_u = nsv->sv_u;
4923 StructCopy(nsv,sv,SV);
4925 /* Currently could join these into one piece of pointer arithmetic, but
4926 it would be unclear. */
4927 if(SvTYPE(sv) == SVt_IV)
4929 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4930 else if (SvTYPE(sv) == SVt_RV) {
4931 SvANY(sv) = &sv->sv_u.svu_rv;
4935 #ifdef PERL_OLD_COPY_ON_WRITE
4936 if (SvIsCOW_normal(nsv)) {
4937 /* We need to follow the pointers around the loop to make the
4938 previous SV point to sv, rather than nsv. */
4941 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4944 assert(SvPVX_const(current) == SvPVX_const(nsv));
4946 /* Make the SV before us point to the SV after us. */
4948 PerlIO_printf(Perl_debug_log, "previous is\n");
4950 PerlIO_printf(Perl_debug_log,
4951 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4952 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4954 SV_COW_NEXT_SV_SET(current, sv);
4957 SvREFCNT(sv) = refcnt;
4958 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4964 =for apidoc sv_clear
4966 Clear an SV: call any destructors, free up any memory used by the body,
4967 and free the body itself. The SV's head is I<not> freed, although
4968 its type is set to all 1's so that it won't inadvertently be assumed
4969 to be live during global destruction etc.
4970 This function should only be called when REFCNT is zero. Most of the time
4971 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4978 Perl_sv_clear(pTHX_ register SV *sv)
4981 const U32 type = SvTYPE(sv);
4982 const struct body_details *const sv_type_details
4983 = bodies_by_type + type;
4986 assert(SvREFCNT(sv) == 0);
4988 if (type <= SVt_IV) {
4989 /* See the comment in sv.h about the collusion between this early
4990 return and the overloading of the NULL and IV slots in the size
4996 if (PL_defstash) { /* Still have a symbol table? */
5001 stash = SvSTASH(sv);
5002 destructor = StashHANDLER(stash,DESTROY);
5004 SV* const tmpref = newRV(sv);
5005 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5007 PUSHSTACKi(PERLSI_DESTROY);
5012 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5018 if(SvREFCNT(tmpref) < 2) {
5019 /* tmpref is not kept alive! */
5021 SvRV_set(tmpref, NULL);
5024 SvREFCNT_dec(tmpref);
5026 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5030 if (PL_in_clean_objs)
5031 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5033 /* DESTROY gave object new lease on life */
5039 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5040 SvOBJECT_off(sv); /* Curse the object. */
5041 if (type != SVt_PVIO)
5042 --PL_sv_objcount; /* XXX Might want something more general */
5045 if (type >= SVt_PVMG) {
5047 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5048 (ourstash = OURSTASH(sv))) {
5049 SvREFCNT_dec(ourstash);
5050 } else if (SvMAGIC(sv))
5052 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5053 SvREFCNT_dec(SvSTASH(sv));
5058 IoIFP(sv) != PerlIO_stdin() &&
5059 IoIFP(sv) != PerlIO_stdout() &&
5060 IoIFP(sv) != PerlIO_stderr())
5062 io_close((IO*)sv, FALSE);
5064 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5065 PerlDir_close(IoDIRP(sv));
5066 IoDIRP(sv) = (DIR*)NULL;
5067 Safefree(IoTOP_NAME(sv));
5068 Safefree(IoFMT_NAME(sv));
5069 Safefree(IoBOTTOM_NAME(sv));
5078 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5085 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5086 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5087 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5088 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5090 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5091 SvREFCNT_dec(LvTARG(sv));
5095 Safefree(GvNAME(sv));
5096 /* If we're in a stash, we don't own a reference to it. However it does
5097 have a back reference to us, which needs to be cleared. */
5099 sv_del_backref((SV*)GvSTASH(sv), sv);
5104 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5106 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5107 /* Don't even bother with turning off the OOK flag. */
5112 SV *target = SvRV(sv);
5114 sv_del_backref(target, sv);
5116 SvREFCNT_dec(target);
5118 #ifdef PERL_OLD_COPY_ON_WRITE
5119 else if (SvPVX_const(sv)) {
5121 /* I believe I need to grab the global SV mutex here and
5122 then recheck the COW status. */
5124 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5127 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5128 SV_COW_NEXT_SV(sv));
5129 /* And drop it here. */
5131 } else if (SvLEN(sv)) {
5132 Safefree(SvPVX_const(sv));
5136 else if (SvPVX_const(sv) && SvLEN(sv))
5137 Safefree(SvPVX_mutable(sv));
5138 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5139 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5148 SvFLAGS(sv) &= SVf_BREAK;
5149 SvFLAGS(sv) |= SVTYPEMASK;
5151 if (sv_type_details->arena) {
5152 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5153 &PL_body_roots[type]);
5155 else if (sv_type_details->body_size) {
5156 my_safefree(SvANY(sv));
5161 =for apidoc sv_newref
5163 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5170 Perl_sv_newref(pTHX_ SV *sv)
5172 PERL_UNUSED_CONTEXT;
5181 Decrement an SV's reference count, and if it drops to zero, call
5182 C<sv_clear> to invoke destructors and free up any memory used by
5183 the body; finally, deallocate the SV's head itself.
5184 Normally called via a wrapper macro C<SvREFCNT_dec>.
5190 Perl_sv_free(pTHX_ SV *sv)
5195 if (SvREFCNT(sv) == 0) {
5196 if (SvFLAGS(sv) & SVf_BREAK)
5197 /* this SV's refcnt has been artificially decremented to
5198 * trigger cleanup */
5200 if (PL_in_clean_all) /* All is fair */
5202 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5203 /* make sure SvREFCNT(sv)==0 happens very seldom */
5204 SvREFCNT(sv) = (~(U32)0)/2;
5207 if (ckWARN_d(WARN_INTERNAL)) {
5208 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5209 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5210 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5211 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5212 Perl_dump_sv_child(aTHX_ sv);
5217 if (--(SvREFCNT(sv)) > 0)
5219 Perl_sv_free2(aTHX_ sv);
5223 Perl_sv_free2(pTHX_ SV *sv)
5228 if (ckWARN_d(WARN_DEBUGGING))
5229 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5230 "Attempt to free temp prematurely: SV 0x%"UVxf
5231 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5235 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5236 /* make sure SvREFCNT(sv)==0 happens very seldom */
5237 SvREFCNT(sv) = (~(U32)0)/2;
5248 Returns the length of the string in the SV. Handles magic and type
5249 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5255 Perl_sv_len(pTHX_ register SV *sv)
5263 len = mg_length(sv);
5265 (void)SvPV_const(sv, len);
5270 =for apidoc sv_len_utf8
5272 Returns the number of characters in the string in an SV, counting wide
5273 UTF-8 bytes as a single character. Handles magic and type coercion.
5279 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5280 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5281 * (Note that the mg_len is not the length of the mg_ptr field.)
5286 Perl_sv_len_utf8(pTHX_ register SV *sv)
5292 return mg_length(sv);
5296 const U8 *s = (U8*)SvPV_const(sv, len);
5297 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5299 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5301 #ifdef PERL_UTF8_CACHE_ASSERT
5302 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5306 ulen = Perl_utf8_length(aTHX_ s, s + len);
5307 if (!mg && !SvREADONLY(sv)) {
5308 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5309 mg = mg_find(sv, PERL_MAGIC_utf8);
5319 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5320 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5321 * between UTF-8 and byte offsets. There are two (substr offset and substr
5322 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5323 * and byte offset) cache positions.
5325 * The mg_len field is used by sv_len_utf8(), see its comments.
5326 * Note that the mg_len is not the length of the mg_ptr field.
5330 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5331 I32 offsetp, const U8 *s, const U8 *start)
5335 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5337 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5341 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5343 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5344 (*mgp)->mg_ptr = (char *) *cachep;
5348 (*cachep)[i] = offsetp;
5349 (*cachep)[i+1] = s - start;
5357 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5358 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5359 * between UTF-8 and byte offsets. See also the comments of
5360 * S_utf8_mg_pos_init().
5364 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)
5368 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5370 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5371 if (*mgp && (*mgp)->mg_ptr) {
5372 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5373 ASSERT_UTF8_CACHE(*cachep);
5374 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5376 else { /* We will skip to the right spot. */
5381 /* The assumption is that going backward is half
5382 * the speed of going forward (that's where the
5383 * 2 * backw in the below comes from). (The real
5384 * figure of course depends on the UTF-8 data.) */
5386 if ((*cachep)[i] > (STRLEN)uoff) {
5388 backw = (*cachep)[i] - (STRLEN)uoff;
5390 if (forw < 2 * backw)
5393 p = start + (*cachep)[i+1];
5395 /* Try this only for the substr offset (i == 0),
5396 * not for the substr length (i == 2). */
5397 else if (i == 0) { /* (*cachep)[i] < uoff */
5398 const STRLEN ulen = sv_len_utf8(sv);
5400 if ((STRLEN)uoff < ulen) {
5401 forw = (STRLEN)uoff - (*cachep)[i];
5402 backw = ulen - (STRLEN)uoff;
5404 if (forw < 2 * backw)
5405 p = start + (*cachep)[i+1];
5410 /* If the string is not long enough for uoff,
5411 * we could extend it, but not at this low a level. */
5415 if (forw < 2 * backw) {
5422 while (UTF8_IS_CONTINUATION(*p))
5427 /* Update the cache. */
5428 (*cachep)[i] = (STRLEN)uoff;
5429 (*cachep)[i+1] = p - start;
5431 /* Drop the stale "length" cache */
5440 if (found) { /* Setup the return values. */
5441 *offsetp = (*cachep)[i+1];
5442 *sp = start + *offsetp;
5445 *offsetp = send - start;
5447 else if (*sp < start) {
5453 #ifdef PERL_UTF8_CACHE_ASSERT
5458 while (n-- && s < send)
5462 assert(*offsetp == s - start);
5463 assert((*cachep)[0] == (STRLEN)uoff);
5464 assert((*cachep)[1] == *offsetp);
5466 ASSERT_UTF8_CACHE(*cachep);
5475 =for apidoc sv_pos_u2b
5477 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5478 the start of the string, to a count of the equivalent number of bytes; if
5479 lenp is non-zero, it does the same to lenp, but this time starting from
5480 the offset, rather than from the start of the string. Handles magic and
5487 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5488 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5489 * byte offsets. See also the comments of S_utf8_mg_pos().
5494 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5502 start = (U8*)SvPV_const(sv, len);
5505 STRLEN *cache = NULL;
5506 const U8 *s = start;
5507 I32 uoffset = *offsetp;
5508 const U8 * const send = s + len;
5510 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5512 if (!found && uoffset > 0) {
5513 while (s < send && uoffset--)
5517 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5519 *offsetp = s - start;
5524 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5528 if (!found && *lenp > 0) {
5531 while (s < send && ulen--)
5535 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5539 ASSERT_UTF8_CACHE(cache);
5551 =for apidoc sv_pos_b2u
5553 Converts the value pointed to by offsetp from a count of bytes from the
5554 start of the string, to a count of the equivalent number of UTF-8 chars.
5555 Handles magic and type coercion.
5561 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5562 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5563 * byte offsets. See also the comments of S_utf8_mg_pos().
5568 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5576 s = (const U8*)SvPV_const(sv, len);
5577 if ((I32)len < *offsetp)
5578 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5580 const U8* send = s + *offsetp;
5582 STRLEN *cache = NULL;
5586 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5587 mg = mg_find(sv, PERL_MAGIC_utf8);
5588 if (mg && mg->mg_ptr) {
5589 cache = (STRLEN *) mg->mg_ptr;
5590 if (cache[1] == (STRLEN)*offsetp) {
5591 /* An exact match. */
5592 *offsetp = cache[0];
5596 else if (cache[1] < (STRLEN)*offsetp) {
5597 /* We already know part of the way. */
5600 /* Let the below loop do the rest. */
5602 else { /* cache[1] > *offsetp */
5603 /* We already know all of the way, now we may
5604 * be able to walk back. The same assumption
5605 * is made as in S_utf8_mg_pos(), namely that
5606 * walking backward is twice slower than
5607 * walking forward. */
5608 const STRLEN forw = *offsetp;
5609 STRLEN backw = cache[1] - *offsetp;
5611 if (!(forw < 2 * backw)) {
5612 const U8 *p = s + cache[1];
5619 while (UTF8_IS_CONTINUATION(*p)) {
5627 *offsetp = cache[0];
5629 /* Drop the stale "length" cache */
5637 ASSERT_UTF8_CACHE(cache);
5643 /* Call utf8n_to_uvchr() to validate the sequence
5644 * (unless a simple non-UTF character) */
5645 if (!UTF8_IS_INVARIANT(*s))
5646 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5655 if (!SvREADONLY(sv)) {
5657 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5658 mg = mg_find(sv, PERL_MAGIC_utf8);
5663 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5664 mg->mg_ptr = (char *) cache;
5669 cache[1] = *offsetp;
5670 /* Drop the stale "length" cache */
5683 Returns a boolean indicating whether the strings in the two SVs are
5684 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5685 coerce its args to strings if necessary.
5691 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5700 SV* svrecode = NULL;
5707 pv1 = SvPV_const(sv1, cur1);
5714 pv2 = SvPV_const(sv2, cur2);
5716 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5717 /* Differing utf8ness.
5718 * Do not UTF8size the comparands as a side-effect. */
5721 svrecode = newSVpvn(pv2, cur2);
5722 sv_recode_to_utf8(svrecode, PL_encoding);
5723 pv2 = SvPV_const(svrecode, cur2);
5726 svrecode = newSVpvn(pv1, cur1);
5727 sv_recode_to_utf8(svrecode, PL_encoding);
5728 pv1 = SvPV_const(svrecode, cur1);
5730 /* Now both are in UTF-8. */
5732 SvREFCNT_dec(svrecode);
5737 bool is_utf8 = TRUE;
5740 /* sv1 is the UTF-8 one,
5741 * if is equal it must be downgrade-able */
5742 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5748 /* sv2 is the UTF-8 one,
5749 * if is equal it must be downgrade-able */
5750 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5756 /* Downgrade not possible - cannot be eq */
5764 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5767 SvREFCNT_dec(svrecode);
5778 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5779 string in C<sv1> is less than, equal to, or greater than the string in
5780 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5781 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5787 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5791 const char *pv1, *pv2;
5794 SV *svrecode = NULL;
5801 pv1 = SvPV_const(sv1, cur1);
5808 pv2 = SvPV_const(sv2, cur2);
5810 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5811 /* Differing utf8ness.
5812 * Do not UTF8size the comparands as a side-effect. */
5815 svrecode = newSVpvn(pv2, cur2);
5816 sv_recode_to_utf8(svrecode, PL_encoding);
5817 pv2 = SvPV_const(svrecode, cur2);
5820 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5825 svrecode = newSVpvn(pv1, cur1);
5826 sv_recode_to_utf8(svrecode, PL_encoding);
5827 pv1 = SvPV_const(svrecode, cur1);
5830 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5836 cmp = cur2 ? -1 : 0;
5840 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5843 cmp = retval < 0 ? -1 : 1;
5844 } else if (cur1 == cur2) {
5847 cmp = cur1 < cur2 ? -1 : 1;
5852 SvREFCNT_dec(svrecode);
5861 =for apidoc sv_cmp_locale
5863 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5864 'use bytes' aware, handles get magic, and will coerce its args to strings
5865 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5871 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5874 #ifdef USE_LOCALE_COLLATE
5880 if (PL_collation_standard)
5884 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5886 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5888 if (!pv1 || !len1) {
5899 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5902 return retval < 0 ? -1 : 1;
5905 * When the result of collation is equality, that doesn't mean
5906 * that there are no differences -- some locales exclude some
5907 * characters from consideration. So to avoid false equalities,
5908 * we use the raw string as a tiebreaker.
5914 #endif /* USE_LOCALE_COLLATE */
5916 return sv_cmp(sv1, sv2);
5920 #ifdef USE_LOCALE_COLLATE
5923 =for apidoc sv_collxfrm
5925 Add Collate Transform magic to an SV if it doesn't already have it.
5927 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5928 scalar data of the variable, but transformed to such a format that a normal
5929 memory comparison can be used to compare the data according to the locale
5936 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5941 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5942 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5948 Safefree(mg->mg_ptr);
5949 s = SvPV_const(sv, len);
5950 if ((xf = mem_collxfrm(s, len, &xlen))) {
5951 if (SvREADONLY(sv)) {
5954 return xf + sizeof(PL_collation_ix);
5957 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5958 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5971 if (mg && mg->mg_ptr) {
5973 return mg->mg_ptr + sizeof(PL_collation_ix);
5981 #endif /* USE_LOCALE_COLLATE */
5986 Get a line from the filehandle and store it into the SV, optionally
5987 appending to the currently-stored string.
5993 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5998 register STDCHAR rslast;
5999 register STDCHAR *bp;
6005 if (SvTHINKFIRST(sv))
6006 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6007 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6009 However, perlbench says it's slower, because the existing swipe code
6010 is faster than copy on write.
6011 Swings and roundabouts. */
6012 SvUPGRADE(sv, SVt_PV);
6017 if (PerlIO_isutf8(fp)) {
6019 sv_utf8_upgrade_nomg(sv);
6020 sv_pos_u2b(sv,&append,0);
6022 } else if (SvUTF8(sv)) {
6023 SV * const tsv = newSV(0);
6024 sv_gets(tsv, fp, 0);
6025 sv_utf8_upgrade_nomg(tsv);
6026 SvCUR_set(sv,append);
6029 goto return_string_or_null;
6034 if (PerlIO_isutf8(fp))
6037 if (IN_PERL_COMPILETIME) {
6038 /* we always read code in line mode */
6042 else if (RsSNARF(PL_rs)) {
6043 /* If it is a regular disk file use size from stat() as estimate
6044 of amount we are going to read - may result in malloc-ing
6045 more memory than we realy need if layers bellow reduce
6046 size we read (e.g. CRLF or a gzip layer)
6049 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6050 const Off_t offset = PerlIO_tell(fp);
6051 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6052 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6058 else if (RsRECORD(PL_rs)) {
6062 /* Grab the size of the record we're getting */
6063 recsize = SvIV(SvRV(PL_rs));
6064 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6067 /* VMS wants read instead of fread, because fread doesn't respect */
6068 /* RMS record boundaries. This is not necessarily a good thing to be */
6069 /* doing, but we've got no other real choice - except avoid stdio
6070 as implementation - perhaps write a :vms layer ?
6072 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6074 bytesread = PerlIO_read(fp, buffer, recsize);
6078 SvCUR_set(sv, bytesread += append);
6079 buffer[bytesread] = '\0';
6080 goto return_string_or_null;
6082 else if (RsPARA(PL_rs)) {
6088 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6089 if (PerlIO_isutf8(fp)) {
6090 rsptr = SvPVutf8(PL_rs, rslen);
6093 if (SvUTF8(PL_rs)) {
6094 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6095 Perl_croak(aTHX_ "Wide character in $/");
6098 rsptr = SvPV_const(PL_rs, rslen);
6102 rslast = rslen ? rsptr[rslen - 1] : '\0';
6104 if (rspara) { /* have to do this both before and after */
6105 do { /* to make sure file boundaries work right */
6108 i = PerlIO_getc(fp);
6112 PerlIO_ungetc(fp,i);
6118 /* See if we know enough about I/O mechanism to cheat it ! */
6120 /* This used to be #ifdef test - it is made run-time test for ease
6121 of abstracting out stdio interface. One call should be cheap
6122 enough here - and may even be a macro allowing compile
6126 if (PerlIO_fast_gets(fp)) {
6129 * We're going to steal some values from the stdio struct
6130 * and put EVERYTHING in the innermost loop into registers.
6132 register STDCHAR *ptr;
6136 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6137 /* An ungetc()d char is handled separately from the regular
6138 * buffer, so we getc() it back out and stuff it in the buffer.
6140 i = PerlIO_getc(fp);
6141 if (i == EOF) return 0;
6142 *(--((*fp)->_ptr)) = (unsigned char) i;
6146 /* Here is some breathtakingly efficient cheating */
6148 cnt = PerlIO_get_cnt(fp); /* get count into register */
6149 /* make sure we have the room */
6150 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6151 /* Not room for all of it
6152 if we are looking for a separator and room for some
6154 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6155 /* just process what we have room for */
6156 shortbuffered = cnt - SvLEN(sv) + append + 1;
6157 cnt -= shortbuffered;
6161 /* remember that cnt can be negative */
6162 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6167 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6168 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6169 DEBUG_P(PerlIO_printf(Perl_debug_log,
6170 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6171 DEBUG_P(PerlIO_printf(Perl_debug_log,
6172 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6173 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6174 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6179 while (cnt > 0) { /* this | eat */
6181 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6182 goto thats_all_folks; /* screams | sed :-) */
6186 Copy(ptr, bp, cnt, char); /* this | eat */
6187 bp += cnt; /* screams | dust */
6188 ptr += cnt; /* louder | sed :-) */
6193 if (shortbuffered) { /* oh well, must extend */
6194 cnt = shortbuffered;
6196 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6198 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6199 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6203 DEBUG_P(PerlIO_printf(Perl_debug_log,
6204 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6205 PTR2UV(ptr),(long)cnt));
6206 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6208 DEBUG_P(PerlIO_printf(Perl_debug_log,
6209 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6210 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6211 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6213 /* This used to call 'filbuf' in stdio form, but as that behaves like
6214 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6215 another abstraction. */
6216 i = PerlIO_getc(fp); /* get more characters */
6218 DEBUG_P(PerlIO_printf(Perl_debug_log,
6219 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6220 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6221 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6223 cnt = PerlIO_get_cnt(fp);
6224 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6225 DEBUG_P(PerlIO_printf(Perl_debug_log,
6226 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6228 if (i == EOF) /* all done for ever? */
6229 goto thats_really_all_folks;
6231 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6233 SvGROW(sv, bpx + cnt + 2);
6234 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6236 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6238 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6239 goto thats_all_folks;
6243 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6244 memNE((char*)bp - rslen, rsptr, rslen))
6245 goto screamer; /* go back to the fray */
6246 thats_really_all_folks:
6248 cnt += shortbuffered;
6249 DEBUG_P(PerlIO_printf(Perl_debug_log,
6250 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6251 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6252 DEBUG_P(PerlIO_printf(Perl_debug_log,
6253 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6254 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6255 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6257 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6258 DEBUG_P(PerlIO_printf(Perl_debug_log,
6259 "Screamer: done, len=%ld, string=|%.*s|\n",
6260 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6264 /*The big, slow, and stupid way. */
6265 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6266 STDCHAR *buf = NULL;
6267 Newx(buf, 8192, STDCHAR);
6275 register const STDCHAR * const bpe = buf + sizeof(buf);
6277 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6278 ; /* keep reading */
6282 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6283 /* Accomodate broken VAXC compiler, which applies U8 cast to
6284 * both args of ?: operator, causing EOF to change into 255
6287 i = (U8)buf[cnt - 1];
6293 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6295 sv_catpvn(sv, (char *) buf, cnt);
6297 sv_setpvn(sv, (char *) buf, cnt);
6299 if (i != EOF && /* joy */
6301 SvCUR(sv) < rslen ||
6302 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6306 * If we're reading from a TTY and we get a short read,
6307 * indicating that the user hit his EOF character, we need
6308 * to notice it now, because if we try to read from the TTY
6309 * again, the EOF condition will disappear.
6311 * The comparison of cnt to sizeof(buf) is an optimization
6312 * that prevents unnecessary calls to feof().
6316 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6320 #ifdef USE_HEAP_INSTEAD_OF_STACK
6325 if (rspara) { /* have to do this both before and after */
6326 while (i != EOF) { /* to make sure file boundaries work right */
6327 i = PerlIO_getc(fp);
6329 PerlIO_ungetc(fp,i);
6335 return_string_or_null:
6336 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6342 Auto-increment of the value in the SV, doing string to numeric conversion
6343 if necessary. Handles 'get' magic.
6349 Perl_sv_inc(pTHX_ register SV *sv)
6358 if (SvTHINKFIRST(sv)) {
6360 sv_force_normal_flags(sv, 0);
6361 if (SvREADONLY(sv)) {
6362 if (IN_PERL_RUNTIME)
6363 Perl_croak(aTHX_ PL_no_modify);
6367 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6369 i = PTR2IV(SvRV(sv));
6374 flags = SvFLAGS(sv);
6375 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6376 /* It's (privately or publicly) a float, but not tested as an
6377 integer, so test it to see. */
6379 flags = SvFLAGS(sv);
6381 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6382 /* It's publicly an integer, or privately an integer-not-float */
6383 #ifdef PERL_PRESERVE_IVUV
6387 if (SvUVX(sv) == UV_MAX)
6388 sv_setnv(sv, UV_MAX_P1);
6390 (void)SvIOK_only_UV(sv);
6391 SvUV_set(sv, SvUVX(sv) + 1);
6393 if (SvIVX(sv) == IV_MAX)
6394 sv_setuv(sv, (UV)IV_MAX + 1);
6396 (void)SvIOK_only(sv);
6397 SvIV_set(sv, SvIVX(sv) + 1);
6402 if (flags & SVp_NOK) {
6403 (void)SvNOK_only(sv);
6404 SvNV_set(sv, SvNVX(sv) + 1.0);
6408 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6409 if ((flags & SVTYPEMASK) < SVt_PVIV)
6410 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6411 (void)SvIOK_only(sv);
6416 while (isALPHA(*d)) d++;
6417 while (isDIGIT(*d)) d++;
6419 #ifdef PERL_PRESERVE_IVUV
6420 /* Got to punt this as an integer if needs be, but we don't issue
6421 warnings. Probably ought to make the sv_iv_please() that does
6422 the conversion if possible, and silently. */
6423 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6424 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6425 /* Need to try really hard to see if it's an integer.
6426 9.22337203685478e+18 is an integer.
6427 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6428 so $a="9.22337203685478e+18"; $a+0; $a++
6429 needs to be the same as $a="9.22337203685478e+18"; $a++
6436 /* sv_2iv *should* have made this an NV */
6437 if (flags & SVp_NOK) {
6438 (void)SvNOK_only(sv);
6439 SvNV_set(sv, SvNVX(sv) + 1.0);
6442 /* I don't think we can get here. Maybe I should assert this
6443 And if we do get here I suspect that sv_setnv will croak. NWC
6445 #if defined(USE_LONG_DOUBLE)
6446 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",
6447 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6449 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6450 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6453 #endif /* PERL_PRESERVE_IVUV */
6454 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6458 while (d >= SvPVX_const(sv)) {
6466 /* MKS: The original code here died if letters weren't consecutive.
6467 * at least it didn't have to worry about non-C locales. The
6468 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6469 * arranged in order (although not consecutively) and that only
6470 * [A-Za-z] are accepted by isALPHA in the C locale.
6472 if (*d != 'z' && *d != 'Z') {
6473 do { ++*d; } while (!isALPHA(*d));
6476 *(d--) -= 'z' - 'a';
6481 *(d--) -= 'z' - 'a' + 1;
6485 /* oh,oh, the number grew */
6486 SvGROW(sv, SvCUR(sv) + 2);
6487 SvCUR_set(sv, SvCUR(sv) + 1);
6488 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6499 Auto-decrement of the value in the SV, doing string to numeric conversion
6500 if necessary. Handles 'get' magic.
6506 Perl_sv_dec(pTHX_ register SV *sv)
6514 if (SvTHINKFIRST(sv)) {
6516 sv_force_normal_flags(sv, 0);
6517 if (SvREADONLY(sv)) {
6518 if (IN_PERL_RUNTIME)
6519 Perl_croak(aTHX_ PL_no_modify);
6523 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6525 i = PTR2IV(SvRV(sv));
6530 /* Unlike sv_inc we don't have to worry about string-never-numbers
6531 and keeping them magic. But we mustn't warn on punting */
6532 flags = SvFLAGS(sv);
6533 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6534 /* It's publicly an integer, or privately an integer-not-float */
6535 #ifdef PERL_PRESERVE_IVUV
6539 if (SvUVX(sv) == 0) {
6540 (void)SvIOK_only(sv);
6544 (void)SvIOK_only_UV(sv);
6545 SvUV_set(sv, SvUVX(sv) - 1);
6548 if (SvIVX(sv) == IV_MIN)
6549 sv_setnv(sv, (NV)IV_MIN - 1.0);
6551 (void)SvIOK_only(sv);
6552 SvIV_set(sv, SvIVX(sv) - 1);
6557 if (flags & SVp_NOK) {
6558 SvNV_set(sv, SvNVX(sv) - 1.0);
6559 (void)SvNOK_only(sv);
6562 if (!(flags & SVp_POK)) {
6563 if ((flags & SVTYPEMASK) < SVt_PVIV)
6564 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6566 (void)SvIOK_only(sv);
6569 #ifdef PERL_PRESERVE_IVUV
6571 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6572 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6573 /* Need to try really hard to see if it's an integer.
6574 9.22337203685478e+18 is an integer.
6575 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6576 so $a="9.22337203685478e+18"; $a+0; $a--
6577 needs to be the same as $a="9.22337203685478e+18"; $a--
6584 /* sv_2iv *should* have made this an NV */
6585 if (flags & SVp_NOK) {
6586 (void)SvNOK_only(sv);
6587 SvNV_set(sv, SvNVX(sv) - 1.0);
6590 /* I don't think we can get here. Maybe I should assert this
6591 And if we do get here I suspect that sv_setnv will croak. NWC
6593 #if defined(USE_LONG_DOUBLE)
6594 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",
6595 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6597 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6598 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6602 #endif /* PERL_PRESERVE_IVUV */
6603 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6607 =for apidoc sv_mortalcopy
6609 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6610 The new SV is marked as mortal. It will be destroyed "soon", either by an
6611 explicit call to FREETMPS, or by an implicit call at places such as
6612 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6617 /* Make a string that will exist for the duration of the expression
6618 * evaluation. Actually, it may have to last longer than that, but
6619 * hopefully we won't free it until it has been assigned to a
6620 * permanent location. */
6623 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6629 sv_setsv(sv,oldstr);
6631 PL_tmps_stack[++PL_tmps_ix] = sv;
6637 =for apidoc sv_newmortal
6639 Creates a new null SV which is mortal. The reference count of the SV is
6640 set to 1. It will be destroyed "soon", either by an explicit call to
6641 FREETMPS, or by an implicit call at places such as statement boundaries.
6642 See also C<sv_mortalcopy> and C<sv_2mortal>.
6648 Perl_sv_newmortal(pTHX)
6654 SvFLAGS(sv) = SVs_TEMP;
6656 PL_tmps_stack[++PL_tmps_ix] = sv;
6661 =for apidoc sv_2mortal
6663 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6664 by an explicit call to FREETMPS, or by an implicit call at places such as
6665 statement boundaries. SvTEMP() is turned on which means that the SV's
6666 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6667 and C<sv_mortalcopy>.
6673 Perl_sv_2mortal(pTHX_ register SV *sv)
6678 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6681 PL_tmps_stack[++PL_tmps_ix] = sv;
6689 Creates a new SV and copies a string into it. The reference count for the
6690 SV is set to 1. If C<len> is zero, Perl will compute the length using
6691 strlen(). For efficiency, consider using C<newSVpvn> instead.
6697 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6703 sv_setpvn(sv,s,len ? len : strlen(s));
6708 =for apidoc newSVpvn
6710 Creates a new SV and copies a string into it. The reference count for the
6711 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6712 string. You are responsible for ensuring that the source string is at least
6713 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6719 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6725 sv_setpvn(sv,s,len);
6731 =for apidoc newSVhek
6733 Creates a new SV from the hash key structure. It will generate scalars that
6734 point to the shared string table where possible. Returns a new (undefined)
6735 SV if the hek is NULL.
6741 Perl_newSVhek(pTHX_ const HEK *hek)
6751 if (HEK_LEN(hek) == HEf_SVKEY) {
6752 return newSVsv(*(SV**)HEK_KEY(hek));
6754 const int flags = HEK_FLAGS(hek);
6755 if (flags & HVhek_WASUTF8) {
6757 Andreas would like keys he put in as utf8 to come back as utf8
6759 STRLEN utf8_len = HEK_LEN(hek);
6760 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6761 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6764 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6766 } else if (flags & HVhek_REHASH) {
6767 /* We don't have a pointer to the hv, so we have to replicate the
6768 flag into every HEK. This hv is using custom a hasing
6769 algorithm. Hence we can't return a shared string scalar, as
6770 that would contain the (wrong) hash value, and might get passed
6771 into an hv routine with a regular hash */
6773 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6778 /* This will be overwhelminly the most common case. */
6779 return newSVpvn_share(HEK_KEY(hek),
6780 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6786 =for apidoc newSVpvn_share
6788 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6789 table. If the string does not already exist in the table, it is created
6790 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6791 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6792 otherwise the hash is computed. The idea here is that as the string table
6793 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6794 hash lookup will avoid string compare.
6800 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6804 bool is_utf8 = FALSE;
6806 STRLEN tmplen = -len;
6808 /* See the note in hv.c:hv_fetch() --jhi */
6809 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6813 PERL_HASH(hash, src, len);
6815 sv_upgrade(sv, SVt_PV);
6816 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6828 #if defined(PERL_IMPLICIT_CONTEXT)
6830 /* pTHX_ magic can't cope with varargs, so this is a no-context
6831 * version of the main function, (which may itself be aliased to us).
6832 * Don't access this version directly.
6836 Perl_newSVpvf_nocontext(const char* pat, ...)
6841 va_start(args, pat);
6842 sv = vnewSVpvf(pat, &args);
6849 =for apidoc newSVpvf
6851 Creates a new SV and initializes it with the string formatted like
6858 Perl_newSVpvf(pTHX_ const char* pat, ...)
6862 va_start(args, pat);
6863 sv = vnewSVpvf(pat, &args);
6868 /* backend for newSVpvf() and newSVpvf_nocontext() */
6871 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6876 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
6883 Creates a new SV and copies a floating point value into it.
6884 The reference count for the SV is set to 1.
6890 Perl_newSVnv(pTHX_ NV n)
6903 Creates a new SV and copies an integer into it. The reference count for the
6910 Perl_newSViv(pTHX_ IV i)
6923 Creates a new SV and copies an unsigned integer into it.
6924 The reference count for the SV is set to 1.
6930 Perl_newSVuv(pTHX_ UV u)
6941 =for apidoc newRV_noinc
6943 Creates an RV wrapper for an SV. The reference count for the original
6944 SV is B<not> incremented.
6950 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6956 sv_upgrade(sv, SVt_RV);
6958 SvRV_set(sv, tmpRef);
6963 /* newRV_inc is the official function name to use now.
6964 * newRV_inc is in fact #defined to newRV in sv.h
6968 Perl_newRV(pTHX_ SV *tmpRef)
6971 return newRV_noinc(SvREFCNT_inc(tmpRef));
6977 Creates a new SV which is an exact duplicate of the original SV.
6984 Perl_newSVsv(pTHX_ register SV *old)
6991 if (SvTYPE(old) == SVTYPEMASK) {
6992 if (ckWARN_d(WARN_INTERNAL))
6993 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6997 /* SV_GMAGIC is the default for sv_setv()
6998 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6999 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7000 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7005 =for apidoc sv_reset
7007 Underlying implementation for the C<reset> Perl function.
7008 Note that the perl-level function is vaguely deprecated.
7014 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7017 char todo[PERL_UCHAR_MAX+1];
7022 if (!*s) { /* reset ?? searches */
7023 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7025 PMOP *pm = (PMOP *) mg->mg_obj;
7027 pm->op_pmdynflags &= ~PMdf_USED;
7034 /* reset variables */
7036 if (!HvARRAY(stash))
7039 Zero(todo, 256, char);
7042 I32 i = (unsigned char)*s;
7046 max = (unsigned char)*s++;
7047 for ( ; i <= max; i++) {
7050 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7052 for (entry = HvARRAY(stash)[i];
7054 entry = HeNEXT(entry))
7059 if (!todo[(U8)*HeKEY(entry)])
7061 gv = (GV*)HeVAL(entry);
7064 if (SvTHINKFIRST(sv)) {
7065 if (!SvREADONLY(sv) && SvROK(sv))
7067 /* XXX Is this continue a bug? Why should THINKFIRST
7068 exempt us from resetting arrays and hashes? */
7072 if (SvTYPE(sv) >= SVt_PV) {
7074 if (SvPVX_const(sv) != NULL)
7082 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7084 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7087 # if defined(USE_ENVIRON_ARRAY)
7090 # endif /* USE_ENVIRON_ARRAY */
7101 Using various gambits, try to get an IO from an SV: the IO slot if its a
7102 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7103 named after the PV if we're a string.
7109 Perl_sv_2io(pTHX_ SV *sv)
7114 switch (SvTYPE(sv)) {
7122 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7126 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7128 return sv_2io(SvRV(sv));
7129 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7135 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7144 Using various gambits, try to get a CV from an SV; in addition, try if
7145 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7146 The flags in C<lref> are passed to sv_fetchsv.
7152 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7163 switch (SvTYPE(sv)) {
7182 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7183 tryAMAGICunDEREF(to_cv);
7186 if (SvTYPE(sv) == SVt_PVCV) {
7195 Perl_croak(aTHX_ "Not a subroutine reference");
7200 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7206 /* Some flags to gv_fetchsv mean don't really create the GV */
7207 if (SvTYPE(gv) != SVt_PVGV) {
7213 if (lref && !GvCVu(gv)) {
7217 gv_efullname3(tmpsv, gv, NULL);
7218 /* XXX this is probably not what they think they're getting.
7219 * It has the same effect as "sub name;", i.e. just a forward
7221 newSUB(start_subparse(FALSE, 0),
7222 newSVOP(OP_CONST, 0, tmpsv),
7226 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7236 Returns true if the SV has a true value by Perl's rules.
7237 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7238 instead use an in-line version.
7244 Perl_sv_true(pTHX_ register SV *sv)
7249 register const XPV* const tXpv = (XPV*)SvANY(sv);
7251 (tXpv->xpv_cur > 1 ||
7252 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7259 return SvIVX(sv) != 0;
7262 return SvNVX(sv) != 0.0;
7264 return sv_2bool(sv);
7270 =for apidoc sv_pvn_force
7272 Get a sensible string out of the SV somehow.
7273 A private implementation of the C<SvPV_force> macro for compilers which
7274 can't cope with complex macro expressions. Always use the macro instead.
7276 =for apidoc sv_pvn_force_flags
7278 Get a sensible string out of the SV somehow.
7279 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7280 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7281 implemented in terms of this function.
7282 You normally want to use the various wrapper macros instead: see
7283 C<SvPV_force> and C<SvPV_force_nomg>
7289 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7292 if (SvTHINKFIRST(sv) && !SvROK(sv))
7293 sv_force_normal_flags(sv, 0);
7303 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7304 const char * const ref = sv_reftype(sv,0);
7306 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7307 ref, OP_NAME(PL_op));
7309 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7311 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7312 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7314 s = sv_2pv_flags(sv, &len, flags);
7318 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7321 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7322 SvGROW(sv, len + 1);
7323 Move(s,SvPVX(sv),len,char);
7328 SvPOK_on(sv); /* validate pointer */
7330 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7331 PTR2UV(sv),SvPVX_const(sv)));
7334 return SvPVX_mutable(sv);
7338 =for apidoc sv_pvbyten_force
7340 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7346 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7348 sv_pvn_force(sv,lp);
7349 sv_utf8_downgrade(sv,0);
7355 =for apidoc sv_pvutf8n_force
7357 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7363 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7365 sv_pvn_force(sv,lp);
7366 sv_utf8_upgrade(sv);
7372 =for apidoc sv_reftype
7374 Returns a string describing what the SV is a reference to.
7380 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7382 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7383 inside return suggests a const propagation bug in g++. */
7384 if (ob && SvOBJECT(sv)) {
7385 char * const name = HvNAME_get(SvSTASH(sv));
7386 return name ? name : (char *) "__ANON__";
7389 switch (SvTYPE(sv)) {
7406 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7407 /* tied lvalues should appear to be
7408 * scalars for backwards compatitbility */
7409 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7410 ? "SCALAR" : "LVALUE");
7411 case SVt_PVAV: return "ARRAY";
7412 case SVt_PVHV: return "HASH";
7413 case SVt_PVCV: return "CODE";
7414 case SVt_PVGV: return "GLOB";
7415 case SVt_PVFM: return "FORMAT";
7416 case SVt_PVIO: return "IO";
7417 default: return "UNKNOWN";
7423 =for apidoc sv_isobject
7425 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7426 object. If the SV is not an RV, or if the object is not blessed, then this
7433 Perl_sv_isobject(pTHX_ SV *sv)
7449 Returns a boolean indicating whether the SV is blessed into the specified
7450 class. This does not check for subtypes; use C<sv_derived_from> to verify
7451 an inheritance relationship.
7457 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7468 hvname = HvNAME_get(SvSTASH(sv));
7472 return strEQ(hvname, name);
7478 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7479 it will be upgraded to one. If C<classname> is non-null then the new SV will
7480 be blessed in the specified package. The new SV is returned and its
7481 reference count is 1.
7487 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7494 SV_CHECK_THINKFIRST_COW_DROP(rv);
7497 if (SvTYPE(rv) >= SVt_PVMG) {
7498 const U32 refcnt = SvREFCNT(rv);
7502 SvREFCNT(rv) = refcnt;
7505 if (SvTYPE(rv) < SVt_RV)
7506 sv_upgrade(rv, SVt_RV);
7507 else if (SvTYPE(rv) > SVt_RV) {
7518 HV* const stash = gv_stashpv(classname, TRUE);
7519 (void)sv_bless(rv, stash);
7525 =for apidoc sv_setref_pv
7527 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7528 argument will be upgraded to an RV. That RV will be modified to point to
7529 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7530 into the SV. The C<classname> argument indicates the package for the
7531 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7532 will have a reference count of 1, and the RV will be returned.
7534 Do not use with other Perl types such as HV, AV, SV, CV, because those
7535 objects will become corrupted by the pointer copy process.
7537 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7543 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7547 sv_setsv(rv, &PL_sv_undef);
7551 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7556 =for apidoc sv_setref_iv
7558 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7559 argument will be upgraded to an RV. That RV will be modified to point to
7560 the new SV. The C<classname> argument indicates the package for the
7561 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7562 will have a reference count of 1, and the RV will be returned.
7568 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7570 sv_setiv(newSVrv(rv,classname), iv);
7575 =for apidoc sv_setref_uv
7577 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7578 argument will be upgraded to an RV. That RV will be modified to point to
7579 the new SV. The C<classname> argument indicates the package for the
7580 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7581 will have a reference count of 1, and the RV will be returned.
7587 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7589 sv_setuv(newSVrv(rv,classname), uv);
7594 =for apidoc sv_setref_nv
7596 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7597 argument will be upgraded to an RV. That RV will be modified to point to
7598 the new SV. The C<classname> argument indicates the package for the
7599 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7600 will have a reference count of 1, and the RV will be returned.
7606 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7608 sv_setnv(newSVrv(rv,classname), nv);
7613 =for apidoc sv_setref_pvn
7615 Copies a string into a new SV, optionally blessing the SV. The length of the
7616 string must be specified with C<n>. The C<rv> argument will be upgraded to
7617 an RV. That RV will be modified to point to the new SV. The C<classname>
7618 argument indicates the package for the blessing. Set C<classname> to
7619 C<NULL> to avoid the blessing. The new SV will have a reference count
7620 of 1, and the RV will be returned.
7622 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7628 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7630 sv_setpvn(newSVrv(rv,classname), pv, n);
7635 =for apidoc sv_bless
7637 Blesses an SV into a specified package. The SV must be an RV. The package
7638 must be designated by its stash (see C<gv_stashpv()>). The reference count
7639 of the SV is unaffected.
7645 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7650 Perl_croak(aTHX_ "Can't bless non-reference value");
7652 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7653 if (SvREADONLY(tmpRef))
7654 Perl_croak(aTHX_ PL_no_modify);
7655 if (SvOBJECT(tmpRef)) {
7656 if (SvTYPE(tmpRef) != SVt_PVIO)
7658 SvREFCNT_dec(SvSTASH(tmpRef));
7661 SvOBJECT_on(tmpRef);
7662 if (SvTYPE(tmpRef) != SVt_PVIO)
7664 SvUPGRADE(tmpRef, SVt_PVMG);
7665 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7672 if(SvSMAGICAL(tmpRef))
7673 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7681 /* Downgrades a PVGV to a PVMG.
7685 S_sv_unglob(pTHX_ SV *sv)
7689 SV *temp = sv_newmortal();
7691 assert(SvTYPE(sv) == SVt_PVGV);
7693 gv_efullname3(temp, (GV *) sv, "*");
7698 sv_del_backref((SV*)GvSTASH(sv), sv);
7702 Safefree(GvNAME(sv));
7705 /* need to keep SvANY(sv) in the right arena */
7706 xpvmg = new_XPVMG();
7707 StructCopy(SvANY(sv), xpvmg, XPVMG);
7708 del_XPVGV(SvANY(sv));
7711 SvFLAGS(sv) &= ~SVTYPEMASK;
7712 SvFLAGS(sv) |= SVt_PVMG;
7714 /* Intentionally not calling any local SET magic, as this isn't so much a
7715 set operation as merely an internal storage change. */
7716 sv_setsv_flags(sv, temp, 0);
7720 =for apidoc sv_unref_flags
7722 Unsets the RV status of the SV, and decrements the reference count of
7723 whatever was being referenced by the RV. This can almost be thought of
7724 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7725 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7726 (otherwise the decrementing is conditional on the reference count being
7727 different from one or the reference being a readonly SV).
7734 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7736 SV* const target = SvRV(ref);
7738 if (SvWEAKREF(ref)) {
7739 sv_del_backref(target, ref);
7741 SvRV_set(ref, NULL);
7744 SvRV_set(ref, NULL);
7746 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7747 assigned to as BEGIN {$a = \"Foo"} will fail. */
7748 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7749 SvREFCNT_dec(target);
7750 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7751 sv_2mortal(target); /* Schedule for freeing later */
7755 =for apidoc sv_untaint
7757 Untaint an SV. Use C<SvTAINTED_off> instead.
7762 Perl_sv_untaint(pTHX_ SV *sv)
7764 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7765 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7772 =for apidoc sv_tainted
7774 Test an SV for taintedness. Use C<SvTAINTED> instead.
7779 Perl_sv_tainted(pTHX_ SV *sv)
7781 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7782 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7783 if (mg && (mg->mg_len & 1) )
7790 =for apidoc sv_setpviv
7792 Copies an integer into the given SV, also updating its string value.
7793 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7799 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7801 char buf[TYPE_CHARS(UV)];
7803 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7805 sv_setpvn(sv, ptr, ebuf - ptr);
7809 =for apidoc sv_setpviv_mg
7811 Like C<sv_setpviv>, but also handles 'set' magic.
7817 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7823 #if defined(PERL_IMPLICIT_CONTEXT)
7825 /* pTHX_ magic can't cope with varargs, so this is a no-context
7826 * version of the main function, (which may itself be aliased to us).
7827 * Don't access this version directly.
7831 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7835 va_start(args, pat);
7836 sv_vsetpvf(sv, pat, &args);
7840 /* pTHX_ magic can't cope with varargs, so this is a no-context
7841 * version of the main function, (which may itself be aliased to us).
7842 * Don't access this version directly.
7846 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7850 va_start(args, pat);
7851 sv_vsetpvf_mg(sv, pat, &args);
7857 =for apidoc sv_setpvf
7859 Works like C<sv_catpvf> but copies the text into the SV instead of
7860 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7866 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7869 va_start(args, pat);
7870 sv_vsetpvf(sv, pat, &args);
7875 =for apidoc sv_vsetpvf
7877 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7878 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7880 Usually used via its frontend C<sv_setpvf>.
7886 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7888 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7892 =for apidoc sv_setpvf_mg
7894 Like C<sv_setpvf>, but also handles 'set' magic.
7900 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7903 va_start(args, pat);
7904 sv_vsetpvf_mg(sv, pat, &args);
7909 =for apidoc sv_vsetpvf_mg
7911 Like C<sv_vsetpvf>, but also handles 'set' magic.
7913 Usually used via its frontend C<sv_setpvf_mg>.
7919 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7921 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7925 #if defined(PERL_IMPLICIT_CONTEXT)
7927 /* pTHX_ magic can't cope with varargs, so this is a no-context
7928 * version of the main function, (which may itself be aliased to us).
7929 * Don't access this version directly.
7933 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7937 va_start(args, pat);
7938 sv_vcatpvf(sv, pat, &args);
7942 /* pTHX_ magic can't cope with varargs, so this is a no-context
7943 * version of the main function, (which may itself be aliased to us).
7944 * Don't access this version directly.
7948 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7952 va_start(args, pat);
7953 sv_vcatpvf_mg(sv, pat, &args);
7959 =for apidoc sv_catpvf
7961 Processes its arguments like C<sprintf> and appends the formatted
7962 output to an SV. If the appended data contains "wide" characters
7963 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7964 and characters >255 formatted with %c), the original SV might get
7965 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7966 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7967 valid UTF-8; if the original SV was bytes, the pattern should be too.
7972 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7975 va_start(args, pat);
7976 sv_vcatpvf(sv, pat, &args);
7981 =for apidoc sv_vcatpvf
7983 Processes its arguments like C<vsprintf> and appends the formatted output
7984 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7986 Usually used via its frontend C<sv_catpvf>.
7992 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7994 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7998 =for apidoc sv_catpvf_mg
8000 Like C<sv_catpvf>, but also handles 'set' magic.
8006 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8009 va_start(args, pat);
8010 sv_vcatpvf_mg(sv, pat, &args);
8015 =for apidoc sv_vcatpvf_mg
8017 Like C<sv_vcatpvf>, but also handles 'set' magic.
8019 Usually used via its frontend C<sv_catpvf_mg>.
8025 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8027 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8032 =for apidoc sv_vsetpvfn
8034 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8037 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8043 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8045 sv_setpvn(sv, "", 0);
8046 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8050 S_expect_number(pTHX_ char** pattern)
8054 switch (**pattern) {
8055 case '1': case '2': case '3':
8056 case '4': case '5': case '6':
8057 case '7': case '8': case '9':
8058 var = *(*pattern)++ - '0';
8059 while (isDIGIT(**pattern)) {
8060 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8062 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8070 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8072 const int neg = nv < 0;
8081 if (uv & 1 && uv == nv)
8082 uv--; /* Round to even */
8084 const unsigned dig = uv % 10;
8097 =for apidoc sv_vcatpvfn
8099 Processes its arguments like C<vsprintf> and appends the formatted output
8100 to an SV. Uses an array of SVs if the C style variable argument list is
8101 missing (NULL). When running with taint checks enabled, indicates via
8102 C<maybe_tainted> if results are untrustworthy (often due to the use of
8105 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8111 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8112 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8113 vec_utf8 = DO_UTF8(vecsv);
8115 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8118 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8126 static const char nullstr[] = "(null)";
8128 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8129 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8131 /* Times 4: a decimal digit takes more than 3 binary digits.
8132 * NV_DIG: mantissa takes than many decimal digits.
8133 * Plus 32: Playing safe. */
8134 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8135 /* large enough for "%#.#f" --chip */
8136 /* what about long double NVs? --jhi */
8138 PERL_UNUSED_ARG(maybe_tainted);
8140 /* no matter what, this is a string now */
8141 (void)SvPV_force(sv, origlen);
8143 /* special-case "", "%s", and "%-p" (SVf - see below) */
8146 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8148 const char * const s = va_arg(*args, char*);
8149 sv_catpv(sv, s ? s : nullstr);
8151 else if (svix < svmax) {
8152 sv_catsv(sv, *svargs);
8156 if (args && patlen == 3 && pat[0] == '%' &&
8157 pat[1] == '-' && pat[2] == 'p') {
8158 argsv = va_arg(*args, SV*);
8159 sv_catsv(sv, argsv);
8163 #ifndef USE_LONG_DOUBLE
8164 /* special-case "%.<number>[gf]" */
8165 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8166 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8167 unsigned digits = 0;
8171 while (*pp >= '0' && *pp <= '9')
8172 digits = 10 * digits + (*pp++ - '0');
8173 if (pp - pat == (int)patlen - 1) {
8181 /* Add check for digits != 0 because it seems that some
8182 gconverts are buggy in this case, and we don't yet have
8183 a Configure test for this. */
8184 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8185 /* 0, point, slack */
8186 Gconvert(nv, (int)digits, 0, ebuf);
8188 if (*ebuf) /* May return an empty string for digits==0 */
8191 } else if (!digits) {
8194 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8195 sv_catpvn(sv, p, l);
8201 #endif /* !USE_LONG_DOUBLE */
8203 if (!args && svix < svmax && DO_UTF8(*svargs))
8206 patend = (char*)pat + patlen;
8207 for (p = (char*)pat; p < patend; p = q) {
8210 bool vectorize = FALSE;
8211 bool vectorarg = FALSE;
8212 bool vec_utf8 = FALSE;
8218 bool has_precis = FALSE;
8220 const I32 osvix = svix;
8221 bool is_utf8 = FALSE; /* is this item utf8? */
8222 #ifdef HAS_LDBL_SPRINTF_BUG
8223 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8224 with sfio - Allen <allens@cpan.org> */
8225 bool fix_ldbl_sprintf_bug = FALSE;
8229 U8 utf8buf[UTF8_MAXBYTES+1];
8230 STRLEN esignlen = 0;
8232 const char *eptr = NULL;
8235 const U8 *vecstr = NULL;
8242 /* we need a long double target in case HAS_LONG_DOUBLE but
8245 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8253 const char *dotstr = ".";
8254 STRLEN dotstrlen = 1;
8255 I32 efix = 0; /* explicit format parameter index */
8256 I32 ewix = 0; /* explicit width index */
8257 I32 epix = 0; /* explicit precision index */
8258 I32 evix = 0; /* explicit vector index */
8259 bool asterisk = FALSE;
8261 /* echo everything up to the next format specification */
8262 for (q = p; q < patend && *q != '%'; ++q) ;
8264 if (has_utf8 && !pat_utf8)
8265 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8267 sv_catpvn(sv, p, q - p);
8274 We allow format specification elements in this order:
8275 \d+\$ explicit format parameter index
8277 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8278 0 flag (as above): repeated to allow "v02"
8279 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8280 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8282 [%bcdefginopsuxDFOUX] format (mandatory)
8287 As of perl5.9.3, printf format checking is on by default.
8288 Internally, perl uses %p formats to provide an escape to
8289 some extended formatting. This block deals with those
8290 extensions: if it does not match, (char*)q is reset and
8291 the normal format processing code is used.
8293 Currently defined extensions are:
8294 %p include pointer address (standard)
8295 %-p (SVf) include an SV (previously %_)
8296 %-<num>p include an SV with precision <num>
8297 %1p (VDf) include a v-string (as %vd)
8298 %<num>p reserved for future extensions
8300 Robin Barker 2005-07-14
8307 n = expect_number(&q);
8314 argsv = va_arg(*args, SV*);
8315 eptr = SvPVx_const(argsv, elen);
8321 else if (n == vdNUMBER) { /* VDf */
8328 if (ckWARN_d(WARN_INTERNAL))
8329 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8330 "internal %%<num>p might conflict with future printf extensions");
8336 if ( (width = expect_number(&q)) ) {
8377 if ( (ewix = expect_number(&q)) )
8386 if ((vectorarg = asterisk)) {
8399 width = expect_number(&q);
8405 vecsv = va_arg(*args, SV*);
8407 vecsv = (evix > 0 && evix <= svmax)
8408 ? svargs[evix-1] : &PL_sv_undef;
8410 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8412 dotstr = SvPV_const(vecsv, dotstrlen);
8413 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8414 bad with tied or overloaded values that return UTF8. */
8417 else if (has_utf8) {
8418 vecsv = sv_mortalcopy(vecsv);
8419 sv_utf8_upgrade(vecsv);
8420 dotstr = SvPV_const(vecsv, dotstrlen);
8427 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8428 vecsv = svargs[efix ? efix-1 : svix++];
8429 vecstr = (U8*)SvPV_const(vecsv,veclen);
8430 vec_utf8 = DO_UTF8(vecsv);
8432 /* if this is a version object, we need to convert
8433 * back into v-string notation and then let the
8434 * vectorize happen normally
8436 if (sv_derived_from(vecsv, "version")) {
8437 char *version = savesvpv(vecsv);
8438 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8439 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8440 "vector argument not supported with alpha versions");
8443 vecsv = sv_newmortal();
8444 /* scan_vstring is expected to be called during
8445 * tokenization, so we need to fake up the end
8446 * of the buffer for it
8448 PL_bufend = version + veclen;
8449 scan_vstring(version, vecsv);
8450 vecstr = (U8*)SvPV_const(vecsv, veclen);
8451 vec_utf8 = DO_UTF8(vecsv);
8463 i = va_arg(*args, int);
8465 i = (ewix ? ewix <= svmax : svix < svmax) ?
8466 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8468 width = (i < 0) ? -i : i;
8478 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8480 /* XXX: todo, support specified precision parameter */
8484 i = va_arg(*args, int);
8486 i = (ewix ? ewix <= svmax : svix < svmax)
8487 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8488 precis = (i < 0) ? 0 : i;
8493 precis = precis * 10 + (*q++ - '0');
8502 case 'I': /* Ix, I32x, and I64x */
8504 if (q[1] == '6' && q[2] == '4') {
8510 if (q[1] == '3' && q[2] == '2') {
8520 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8531 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8532 if (*(q + 1) == 'l') { /* lld, llf */
8558 if (!vectorize && !args) {
8560 const I32 i = efix-1;
8561 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8563 argsv = (svix >= 0 && svix < svmax)
8564 ? svargs[svix++] : &PL_sv_undef;
8575 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8577 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8579 eptr = (char*)utf8buf;
8580 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8594 eptr = va_arg(*args, char*);
8596 #ifdef MACOS_TRADITIONAL
8597 /* On MacOS, %#s format is used for Pascal strings */
8602 elen = strlen(eptr);
8604 eptr = (char *)nullstr;
8605 elen = sizeof nullstr - 1;
8609 eptr = SvPVx_const(argsv, elen);
8610 if (DO_UTF8(argsv)) {
8611 if (has_precis && precis < elen) {
8613 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8616 if (width) { /* fudge width (can't fudge elen) */
8617 width += elen - sv_len_utf8(argsv);
8624 if (has_precis && elen > precis)
8631 if (alt || vectorize)
8633 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8654 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8663 esignbuf[esignlen++] = plus;
8667 case 'h': iv = (short)va_arg(*args, int); break;
8668 case 'l': iv = va_arg(*args, long); break;
8669 case 'V': iv = va_arg(*args, IV); break;
8670 default: iv = va_arg(*args, int); break;
8672 case 'q': iv = va_arg(*args, Quad_t); break;
8677 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8679 case 'h': iv = (short)tiv; break;
8680 case 'l': iv = (long)tiv; break;
8682 default: iv = tiv; break;
8684 case 'q': iv = (Quad_t)tiv; break;
8688 if ( !vectorize ) /* we already set uv above */
8693 esignbuf[esignlen++] = plus;
8697 esignbuf[esignlen++] = '-';
8740 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8751 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8752 case 'l': uv = va_arg(*args, unsigned long); break;
8753 case 'V': uv = va_arg(*args, UV); break;
8754 default: uv = va_arg(*args, unsigned); break;
8756 case 'q': uv = va_arg(*args, Uquad_t); break;
8761 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8763 case 'h': uv = (unsigned short)tuv; break;
8764 case 'l': uv = (unsigned long)tuv; break;
8766 default: uv = tuv; break;
8768 case 'q': uv = (Uquad_t)tuv; break;
8775 char *ptr = ebuf + sizeof ebuf;
8781 p = (char*)((c == 'X')
8782 ? "0123456789ABCDEF" : "0123456789abcdef");
8788 esignbuf[esignlen++] = '0';
8789 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8797 if (alt && *ptr != '0')
8808 esignbuf[esignlen++] = '0';
8809 esignbuf[esignlen++] = 'b';
8812 default: /* it had better be ten or less */
8816 } while (uv /= base);
8819 elen = (ebuf + sizeof ebuf) - ptr;
8823 zeros = precis - elen;
8824 else if (precis == 0 && elen == 1 && *eptr == '0')
8830 /* FLOATING POINT */
8833 c = 'f'; /* maybe %F isn't supported here */
8841 /* This is evil, but floating point is even more evil */
8843 /* for SV-style calling, we can only get NV
8844 for C-style calling, we assume %f is double;
8845 for simplicity we allow any of %Lf, %llf, %qf for long double
8849 #if defined(USE_LONG_DOUBLE)
8853 /* [perl #20339] - we should accept and ignore %lf rather than die */
8857 #if defined(USE_LONG_DOUBLE)
8858 intsize = args ? 0 : 'q';
8862 #if defined(HAS_LONG_DOUBLE)
8871 /* now we need (long double) if intsize == 'q', else (double) */
8873 #if LONG_DOUBLESIZE > DOUBLESIZE
8875 va_arg(*args, long double) :
8876 va_arg(*args, double)
8878 va_arg(*args, double)
8883 if (c != 'e' && c != 'E') {
8885 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8886 will cast our (long double) to (double) */
8887 (void)Perl_frexp(nv, &i);
8888 if (i == PERL_INT_MIN)
8889 Perl_die(aTHX_ "panic: frexp");
8891 need = BIT_DIGITS(i);
8893 need += has_precis ? precis : 6; /* known default */
8898 #ifdef HAS_LDBL_SPRINTF_BUG
8899 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8900 with sfio - Allen <allens@cpan.org> */
8903 # define MY_DBL_MAX DBL_MAX
8904 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8905 # if DOUBLESIZE >= 8
8906 # define MY_DBL_MAX 1.7976931348623157E+308L
8908 # define MY_DBL_MAX 3.40282347E+38L
8912 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8913 # define MY_DBL_MAX_BUG 1L
8915 # define MY_DBL_MAX_BUG MY_DBL_MAX
8919 # define MY_DBL_MIN DBL_MIN
8920 # else /* XXX guessing! -Allen */
8921 # if DOUBLESIZE >= 8
8922 # define MY_DBL_MIN 2.2250738585072014E-308L
8924 # define MY_DBL_MIN 1.17549435E-38L
8928 if ((intsize == 'q') && (c == 'f') &&
8929 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8931 /* it's going to be short enough that
8932 * long double precision is not needed */
8934 if ((nv <= 0L) && (nv >= -0L))
8935 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8937 /* would use Perl_fp_class as a double-check but not
8938 * functional on IRIX - see perl.h comments */
8940 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8941 /* It's within the range that a double can represent */
8942 #if defined(DBL_MAX) && !defined(DBL_MIN)
8943 if ((nv >= ((long double)1/DBL_MAX)) ||
8944 (nv <= (-(long double)1/DBL_MAX)))
8946 fix_ldbl_sprintf_bug = TRUE;
8949 if (fix_ldbl_sprintf_bug == TRUE) {
8959 # undef MY_DBL_MAX_BUG
8962 #endif /* HAS_LDBL_SPRINTF_BUG */
8964 need += 20; /* fudge factor */
8965 if (PL_efloatsize < need) {
8966 Safefree(PL_efloatbuf);
8967 PL_efloatsize = need + 20; /* more fudge */
8968 Newx(PL_efloatbuf, PL_efloatsize, char);
8969 PL_efloatbuf[0] = '\0';
8972 if ( !(width || left || plus || alt) && fill != '0'
8973 && has_precis && intsize != 'q' ) { /* Shortcuts */
8974 /* See earlier comment about buggy Gconvert when digits,
8976 if ( c == 'g' && precis) {
8977 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8978 /* May return an empty string for digits==0 */
8979 if (*PL_efloatbuf) {
8980 elen = strlen(PL_efloatbuf);
8981 goto float_converted;
8983 } else if ( c == 'f' && !precis) {
8984 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8989 char *ptr = ebuf + sizeof ebuf;
8992 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8993 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8994 if (intsize == 'q') {
8995 /* Copy the one or more characters in a long double
8996 * format before the 'base' ([efgEFG]) character to
8997 * the format string. */
8998 static char const prifldbl[] = PERL_PRIfldbl;
8999 char const *p = prifldbl + sizeof(prifldbl) - 3;
9000 while (p >= prifldbl) { *--ptr = *p--; }
9005 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9010 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9022 /* No taint. Otherwise we are in the strange situation
9023 * where printf() taints but print($float) doesn't.
9025 #if defined(HAS_LONG_DOUBLE)
9026 elen = ((intsize == 'q')
9027 ? my_sprintf(PL_efloatbuf, ptr, nv)
9028 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9030 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9034 eptr = PL_efloatbuf;
9042 i = SvCUR(sv) - origlen;
9045 case 'h': *(va_arg(*args, short*)) = i; break;
9046 default: *(va_arg(*args, int*)) = i; break;
9047 case 'l': *(va_arg(*args, long*)) = i; break;
9048 case 'V': *(va_arg(*args, IV*)) = i; break;
9050 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9055 sv_setuv_mg(argsv, (UV)i);
9056 continue; /* not "break" */
9063 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9064 && ckWARN(WARN_PRINTF))
9066 SV * const msg = sv_newmortal();
9067 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9068 (PL_op->op_type == OP_PRTF) ? "" : "s");
9071 Perl_sv_catpvf(aTHX_ msg,
9072 "\"%%%c\"", c & 0xFF);
9074 Perl_sv_catpvf(aTHX_ msg,
9075 "\"%%\\%03"UVof"\"",
9078 sv_catpvs(msg, "end of string");
9079 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9082 /* output mangled stuff ... */
9088 /* ... right here, because formatting flags should not apply */
9089 SvGROW(sv, SvCUR(sv) + elen + 1);
9091 Copy(eptr, p, elen, char);
9094 SvCUR_set(sv, p - SvPVX_const(sv));
9096 continue; /* not "break" */
9099 /* calculate width before utf8_upgrade changes it */
9100 have = esignlen + zeros + elen;
9102 Perl_croak_nocontext(PL_memory_wrap);
9104 if (is_utf8 != has_utf8) {
9107 sv_utf8_upgrade(sv);
9110 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9111 sv_utf8_upgrade(nsv);
9112 eptr = SvPVX_const(nsv);
9115 SvGROW(sv, SvCUR(sv) + elen + 1);
9120 need = (have > width ? have : width);
9123 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9124 Perl_croak_nocontext(PL_memory_wrap);
9125 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9127 if (esignlen && fill == '0') {
9129 for (i = 0; i < (int)esignlen; i++)
9133 memset(p, fill, gap);
9136 if (esignlen && fill != '0') {
9138 for (i = 0; i < (int)esignlen; i++)
9143 for (i = zeros; i; i--)
9147 Copy(eptr, p, elen, char);
9151 memset(p, ' ', gap);
9156 Copy(dotstr, p, dotstrlen, char);
9160 vectorize = FALSE; /* done iterating over vecstr */
9167 SvCUR_set(sv, p - SvPVX_const(sv));
9175 /* =========================================================================
9177 =head1 Cloning an interpreter
9179 All the macros and functions in this section are for the private use of
9180 the main function, perl_clone().
9182 The foo_dup() functions make an exact copy of an existing foo thinngy.
9183 During the course of a cloning, a hash table is used to map old addresses
9184 to new addresses. The table is created and manipulated with the
9185 ptr_table_* functions.
9189 ============================================================================*/
9192 #if defined(USE_ITHREADS)
9194 #ifndef GpREFCNT_inc
9195 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9199 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9200 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9201 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9202 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9203 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9204 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9205 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9206 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9207 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9208 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9209 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9210 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9211 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9214 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9215 regcomp.c. AMS 20010712 */
9218 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9223 struct reg_substr_datum *s;
9226 return (REGEXP *)NULL;
9228 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9231 len = r->offsets[0];
9232 npar = r->nparens+1;
9234 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9235 Copy(r->program, ret->program, len+1, regnode);
9237 Newx(ret->startp, npar, I32);
9238 Copy(r->startp, ret->startp, npar, I32);
9239 Newx(ret->endp, npar, I32);
9240 Copy(r->startp, ret->startp, npar, I32);
9242 Newx(ret->substrs, 1, struct reg_substr_data);
9243 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9244 s->min_offset = r->substrs->data[i].min_offset;
9245 s->max_offset = r->substrs->data[i].max_offset;
9246 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9247 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9250 ret->regstclass = NULL;
9253 const int count = r->data->count;
9256 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9257 char, struct reg_data);
9258 Newx(d->what, count, U8);
9261 for (i = 0; i < count; i++) {
9262 d->what[i] = r->data->what[i];
9263 switch (d->what[i]) {
9264 /* legal options are one of: sfpont
9265 see also regcomp.h and pregfree() */
9267 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9270 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9273 /* This is cheating. */
9274 Newx(d->data[i], 1, struct regnode_charclass_class);
9275 StructCopy(r->data->data[i], d->data[i],
9276 struct regnode_charclass_class);
9277 ret->regstclass = (regnode*)d->data[i];
9280 /* Compiled op trees are readonly, and can thus be
9281 shared without duplication. */
9283 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9287 d->data[i] = r->data->data[i];
9290 d->data[i] = r->data->data[i];
9292 ((reg_trie_data*)d->data[i])->refcount++;
9296 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9305 Newx(ret->offsets, 2*len+1, U32);
9306 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9308 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9309 ret->refcnt = r->refcnt;
9310 ret->minlen = r->minlen;
9311 ret->prelen = r->prelen;
9312 ret->nparens = r->nparens;
9313 ret->lastparen = r->lastparen;
9314 ret->lastcloseparen = r->lastcloseparen;
9315 ret->reganch = r->reganch;
9317 ret->sublen = r->sublen;
9319 if (RX_MATCH_COPIED(ret))
9320 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9323 #ifdef PERL_OLD_COPY_ON_WRITE
9324 ret->saved_copy = NULL;
9327 ptr_table_store(PL_ptr_table, r, ret);
9331 /* duplicate a file handle */
9334 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9338 PERL_UNUSED_ARG(type);
9341 return (PerlIO*)NULL;
9343 /* look for it in the table first */
9344 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9348 /* create anew and remember what it is */
9349 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9350 ptr_table_store(PL_ptr_table, fp, ret);
9354 /* duplicate a directory handle */
9357 Perl_dirp_dup(pTHX_ DIR *dp)
9359 PERL_UNUSED_CONTEXT;
9366 /* duplicate a typeglob */
9369 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9374 /* look for it in the table first */
9375 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9379 /* create anew and remember what it is */
9381 ptr_table_store(PL_ptr_table, gp, ret);
9384 ret->gp_refcnt = 0; /* must be before any other dups! */
9385 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9386 ret->gp_io = io_dup_inc(gp->gp_io, param);
9387 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9388 ret->gp_av = av_dup_inc(gp->gp_av, param);
9389 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9390 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9391 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9392 ret->gp_cvgen = gp->gp_cvgen;
9393 ret->gp_line = gp->gp_line;
9394 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9398 /* duplicate a chain of magic */
9401 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9403 MAGIC *mgprev = (MAGIC*)NULL;
9406 return (MAGIC*)NULL;
9407 /* look for it in the table first */
9408 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9412 for (; mg; mg = mg->mg_moremagic) {
9414 Newxz(nmg, 1, MAGIC);
9416 mgprev->mg_moremagic = nmg;
9419 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9420 nmg->mg_private = mg->mg_private;
9421 nmg->mg_type = mg->mg_type;
9422 nmg->mg_flags = mg->mg_flags;
9423 if (mg->mg_type == PERL_MAGIC_qr) {
9424 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9426 else if(mg->mg_type == PERL_MAGIC_backref) {
9427 /* The backref AV has its reference count deliberately bumped by
9429 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9431 else if (mg->mg_type == PERL_MAGIC_symtab) {
9432 nmg->mg_obj = mg->mg_obj;
9435 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9436 ? sv_dup_inc(mg->mg_obj, param)
9437 : sv_dup(mg->mg_obj, param);
9439 nmg->mg_len = mg->mg_len;
9440 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9441 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9442 if (mg->mg_len > 0) {
9443 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9444 if (mg->mg_type == PERL_MAGIC_overload_table &&
9445 AMT_AMAGIC((AMT*)mg->mg_ptr))
9447 const AMT * const amtp = (AMT*)mg->mg_ptr;
9448 AMT * const namtp = (AMT*)nmg->mg_ptr;
9450 for (i = 1; i < NofAMmeth; i++) {
9451 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9455 else if (mg->mg_len == HEf_SVKEY)
9456 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9458 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9459 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9466 /* create a new pointer-mapping table */
9469 Perl_ptr_table_new(pTHX)
9472 PERL_UNUSED_CONTEXT;
9474 Newxz(tbl, 1, PTR_TBL_t);
9477 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9481 #define PTR_TABLE_HASH(ptr) \
9482 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9485 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9486 following define) and at call to new_body_inline made below in
9487 Perl_ptr_table_store()
9490 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9492 /* map an existing pointer using a table */
9494 STATIC PTR_TBL_ENT_t *
9495 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9496 PTR_TBL_ENT_t *tblent;
9497 const UV hash = PTR_TABLE_HASH(sv);
9499 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9500 for (; tblent; tblent = tblent->next) {
9501 if (tblent->oldval == sv)
9508 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9510 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9511 PERL_UNUSED_CONTEXT;
9512 return tblent ? tblent->newval : (void *) 0;
9515 /* add a new entry to a pointer-mapping table */
9518 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9520 PTR_TBL_ENT_t *tblent = S_ptr_table_find(tbl, oldsv);
9521 PERL_UNUSED_CONTEXT;
9524 tblent->newval = newsv;
9526 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9528 new_body_inline(tblent, PTE_SVSLOT);
9530 tblent->oldval = oldsv;
9531 tblent->newval = newsv;
9532 tblent->next = tbl->tbl_ary[entry];
9533 tbl->tbl_ary[entry] = tblent;
9535 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9536 ptr_table_split(tbl);
9540 /* double the hash bucket size of an existing ptr table */
9543 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9545 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9546 const UV oldsize = tbl->tbl_max + 1;
9547 UV newsize = oldsize * 2;
9549 PERL_UNUSED_CONTEXT;
9551 Renew(ary, newsize, PTR_TBL_ENT_t*);
9552 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9553 tbl->tbl_max = --newsize;
9555 for (i=0; i < oldsize; i++, ary++) {
9556 PTR_TBL_ENT_t **curentp, **entp, *ent;
9559 curentp = ary + oldsize;
9560 for (entp = ary, ent = *ary; ent; ent = *entp) {
9561 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9563 ent->next = *curentp;
9573 /* remove all the entries from a ptr table */
9576 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9578 if (tbl && tbl->tbl_items) {
9579 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9580 UV riter = tbl->tbl_max;
9583 PTR_TBL_ENT_t *entry = array[riter];
9586 PTR_TBL_ENT_t * const oentry = entry;
9587 entry = entry->next;
9596 /* clear and free a ptr table */
9599 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9604 ptr_table_clear(tbl);
9605 Safefree(tbl->tbl_ary);
9611 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9614 SvRV_set(dstr, SvWEAKREF(sstr)
9615 ? sv_dup(SvRV(sstr), param)
9616 : sv_dup_inc(SvRV(sstr), param));
9619 else if (SvPVX_const(sstr)) {
9620 /* Has something there */
9622 /* Normal PV - clone whole allocated space */
9623 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9624 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9625 /* Not that normal - actually sstr is copy on write.
9626 But we are a true, independant SV, so: */
9627 SvREADONLY_off(dstr);
9632 /* Special case - not normally malloced for some reason */
9633 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9634 /* A "shared" PV - clone it as "shared" PV */
9636 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9640 /* Some other special case - random pointer */
9641 SvPV_set(dstr, SvPVX(sstr));
9647 if (SvTYPE(dstr) == SVt_RV)
9648 SvRV_set(dstr, NULL);
9650 SvPV_set(dstr, NULL);
9654 /* duplicate an SV of any type (including AV, HV etc) */
9657 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9662 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9664 /* look for it in the table first */
9665 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9669 if(param->flags & CLONEf_JOIN_IN) {
9670 /** We are joining here so we don't want do clone
9671 something that is bad **/
9672 if (SvTYPE(sstr) == SVt_PVHV) {
9673 const char * const hvname = HvNAME_get(sstr);
9675 /** don't clone stashes if they already exist **/
9676 return (SV*)gv_stashpv(hvname,0);
9680 /* create anew and remember what it is */
9683 #ifdef DEBUG_LEAKING_SCALARS
9684 dstr->sv_debug_optype = sstr->sv_debug_optype;
9685 dstr->sv_debug_line = sstr->sv_debug_line;
9686 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9687 dstr->sv_debug_cloned = 1;
9688 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9691 ptr_table_store(PL_ptr_table, sstr, dstr);
9694 SvFLAGS(dstr) = SvFLAGS(sstr);
9695 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9696 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9699 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9700 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9701 PL_watch_pvx, SvPVX_const(sstr));
9704 /* don't clone objects whose class has asked us not to */
9705 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9706 SvFLAGS(dstr) &= ~SVTYPEMASK;
9711 switch (SvTYPE(sstr)) {
9716 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9717 SvIV_set(dstr, SvIVX(sstr));
9720 SvANY(dstr) = new_XNV();
9721 SvNV_set(dstr, SvNVX(sstr));
9724 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9725 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9729 /* These are all the types that need complex bodies allocating. */
9731 const svtype sv_type = SvTYPE(sstr);
9732 const struct body_details *const sv_type_details
9733 = bodies_by_type + sv_type;
9737 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9741 if (GvUNIQUE((GV*)sstr)) {
9742 /*EMPTY*/; /* Do sharing here, and fall through */
9755 assert(sv_type_details->body_size);
9756 if (sv_type_details->arena) {
9757 new_body_inline(new_body, sv_type);
9759 = (void*)((char*)new_body - sv_type_details->offset);
9761 new_body = new_NOARENA(sv_type_details);
9765 SvANY(dstr) = new_body;
9768 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9769 ((char*)SvANY(dstr)) + sv_type_details->offset,
9770 sv_type_details->copy, char);
9772 Copy(((char*)SvANY(sstr)),
9773 ((char*)SvANY(dstr)),
9774 sv_type_details->body_size + sv_type_details->offset, char);
9777 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9778 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9780 /* The Copy above means that all the source (unduplicated) pointers
9781 are now in the destination. We can check the flags and the
9782 pointers in either, but it's possible that there's less cache
9783 missing by always going for the destination.
9784 FIXME - instrument and check that assumption */
9785 if (sv_type >= SVt_PVMG) {
9787 if ((sv_type == SVt_PVMG || sv_type == SVt_PVGV) &&
9788 (ourstash = OURSTASH(dstr))) {
9789 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9790 } else if (SvMAGIC(dstr))
9791 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9793 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9796 /* The cast silences a GCC warning about unhandled types. */
9797 switch ((int)sv_type) {
9809 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9810 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9811 LvTARG(dstr) = dstr;
9812 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9813 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9815 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9818 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9819 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9820 /* Don't call sv_add_backref here as it's going to be created
9821 as part of the magic cloning of the symbol table. */
9822 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9823 (void)GpREFCNT_inc(GvGP(dstr));
9826 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9827 if (IoOFP(dstr) == IoIFP(sstr))
9828 IoOFP(dstr) = IoIFP(dstr);
9830 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9831 /* PL_rsfp_filters entries have fake IoDIRP() */
9832 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9833 /* I have no idea why fake dirp (rsfps)
9834 should be treated differently but otherwise
9835 we end up with leaks -- sky*/
9836 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9837 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9838 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9840 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9841 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9842 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9844 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9847 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9850 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9851 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9852 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9855 if (AvARRAY((AV*)sstr)) {
9856 SV **dst_ary, **src_ary;
9857 SSize_t items = AvFILLp((AV*)sstr) + 1;
9859 src_ary = AvARRAY((AV*)sstr);
9860 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9861 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9862 SvPV_set(dstr, (char*)dst_ary);
9863 AvALLOC((AV*)dstr) = dst_ary;
9864 if (AvREAL((AV*)sstr)) {
9866 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9870 *dst_ary++ = sv_dup(*src_ary++, param);
9872 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9873 while (items-- > 0) {
9874 *dst_ary++ = &PL_sv_undef;
9878 SvPV_set(dstr, NULL);
9879 AvALLOC((AV*)dstr) = (SV**)NULL;
9886 if (HvARRAY((HV*)sstr)) {
9888 const bool sharekeys = !!HvSHAREKEYS(sstr);
9889 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9890 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9892 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9893 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9895 HvARRAY(dstr) = (HE**)darray;
9896 while (i <= sxhv->xhv_max) {
9897 const HE *source = HvARRAY(sstr)[i];
9898 HvARRAY(dstr)[i] = source
9899 ? he_dup(source, sharekeys, param) : 0;
9903 struct xpvhv_aux * const saux = HvAUX(sstr);
9904 struct xpvhv_aux * const daux = HvAUX(dstr);
9905 /* This flag isn't copied. */
9906 /* SvOOK_on(hv) attacks the IV flags. */
9907 SvFLAGS(dstr) |= SVf_OOK;
9909 hvname = saux->xhv_name;
9911 = hvname ? hek_dup(hvname, param) : hvname;
9913 daux->xhv_riter = saux->xhv_riter;
9914 daux->xhv_eiter = saux->xhv_eiter
9915 ? he_dup(saux->xhv_eiter,
9916 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9917 daux->xhv_backreferences = saux->xhv_backreferences
9918 ? (AV*) SvREFCNT_inc(
9926 SvPV_set(dstr, NULL);
9928 /* Record stashes for possible cloning in Perl_clone(). */
9930 av_push(param->stashes, dstr);
9934 if (!(param->flags & CLONEf_COPY_STACKS)) {
9938 /* NOTE: not refcounted */
9939 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9941 if (!CvISXSUB(dstr))
9942 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9944 if (CvCONST(dstr) && CvISXSUB(dstr)) {
9945 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9946 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9947 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9949 /* don't dup if copying back - CvGV isn't refcounted, so the
9950 * duped GV may never be freed. A bit of a hack! DAPM */
9951 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9952 NULL : gv_dup(CvGV(dstr), param) ;
9953 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9956 ? cv_dup( CvOUTSIDE(dstr), param)
9957 : cv_dup_inc(CvOUTSIDE(dstr), param);
9958 if (!CvISXSUB(dstr))
9959 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9965 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9971 /* duplicate a context */
9974 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9979 return (PERL_CONTEXT*)NULL;
9981 /* look for it in the table first */
9982 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9986 /* create anew and remember what it is */
9987 Newxz(ncxs, max + 1, PERL_CONTEXT);
9988 ptr_table_store(PL_ptr_table, cxs, ncxs);
9991 PERL_CONTEXT * const cx = &cxs[ix];
9992 PERL_CONTEXT * const ncx = &ncxs[ix];
9993 ncx->cx_type = cx->cx_type;
9994 if (CxTYPE(cx) == CXt_SUBST) {
9995 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9998 ncx->blk_oldsp = cx->blk_oldsp;
9999 ncx->blk_oldcop = cx->blk_oldcop;
10000 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10001 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10002 ncx->blk_oldpm = cx->blk_oldpm;
10003 ncx->blk_gimme = cx->blk_gimme;
10004 switch (CxTYPE(cx)) {
10006 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10007 ? cv_dup_inc(cx->blk_sub.cv, param)
10008 : cv_dup(cx->blk_sub.cv,param));
10009 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10010 ? av_dup_inc(cx->blk_sub.argarray, param)
10012 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10013 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10014 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10015 ncx->blk_sub.lval = cx->blk_sub.lval;
10016 ncx->blk_sub.retop = cx->blk_sub.retop;
10019 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10020 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10021 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10022 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10023 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10024 ncx->blk_eval.retop = cx->blk_eval.retop;
10027 ncx->blk_loop.label = cx->blk_loop.label;
10028 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10029 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10030 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10031 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10032 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10033 ? cx->blk_loop.iterdata
10034 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10035 ncx->blk_loop.oldcomppad
10036 = (PAD*)ptr_table_fetch(PL_ptr_table,
10037 cx->blk_loop.oldcomppad);
10038 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10039 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10040 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10041 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10042 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10045 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10046 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10047 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10048 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10049 ncx->blk_sub.retop = cx->blk_sub.retop;
10061 /* duplicate a stack info structure */
10064 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10069 return (PERL_SI*)NULL;
10071 /* look for it in the table first */
10072 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10076 /* create anew and remember what it is */
10077 Newxz(nsi, 1, PERL_SI);
10078 ptr_table_store(PL_ptr_table, si, nsi);
10080 nsi->si_stack = av_dup_inc(si->si_stack, param);
10081 nsi->si_cxix = si->si_cxix;
10082 nsi->si_cxmax = si->si_cxmax;
10083 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10084 nsi->si_type = si->si_type;
10085 nsi->si_prev = si_dup(si->si_prev, param);
10086 nsi->si_next = si_dup(si->si_next, param);
10087 nsi->si_markoff = si->si_markoff;
10092 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10093 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10094 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10095 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10096 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10097 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10098 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10099 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10100 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10101 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10102 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10103 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10104 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10105 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10108 #define pv_dup_inc(p) SAVEPV(p)
10109 #define pv_dup(p) SAVEPV(p)
10110 #define svp_dup_inc(p,pp) any_dup(p,pp)
10112 /* map any object to the new equivent - either something in the
10113 * ptr table, or something in the interpreter structure
10117 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10122 return (void*)NULL;
10124 /* look for it in the table first */
10125 ret = ptr_table_fetch(PL_ptr_table, v);
10129 /* see if it is part of the interpreter structure */
10130 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10131 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10139 /* duplicate the save stack */
10142 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10144 ANY * const ss = proto_perl->Tsavestack;
10145 const I32 max = proto_perl->Tsavestack_max;
10146 I32 ix = proto_perl->Tsavestack_ix;
10158 void (*dptr) (void*);
10159 void (*dxptr) (pTHX_ void*);
10161 Newxz(nss, max, ANY);
10164 I32 i = POPINT(ss,ix);
10165 TOPINT(nss,ix) = i;
10167 case SAVEt_ITEM: /* normal string */
10168 sv = (SV*)POPPTR(ss,ix);
10169 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10170 sv = (SV*)POPPTR(ss,ix);
10171 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10173 case SAVEt_SV: /* scalar reference */
10174 sv = (SV*)POPPTR(ss,ix);
10175 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10176 gv = (GV*)POPPTR(ss,ix);
10177 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10179 case SAVEt_GENERIC_PVREF: /* generic char* */
10180 c = (char*)POPPTR(ss,ix);
10181 TOPPTR(nss,ix) = pv_dup(c);
10182 ptr = POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10185 case SAVEt_SHARED_PVREF: /* char* in shared space */
10186 c = (char*)POPPTR(ss,ix);
10187 TOPPTR(nss,ix) = savesharedpv(c);
10188 ptr = POPPTR(ss,ix);
10189 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10191 case SAVEt_GENERIC_SVREF: /* generic sv */
10192 case SAVEt_SVREF: /* scalar reference */
10193 sv = (SV*)POPPTR(ss,ix);
10194 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10195 ptr = POPPTR(ss,ix);
10196 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10198 case SAVEt_AV: /* array reference */
10199 av = (AV*)POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = av_dup_inc(av, param);
10201 gv = (GV*)POPPTR(ss,ix);
10202 TOPPTR(nss,ix) = gv_dup(gv, param);
10204 case SAVEt_HV: /* hash reference */
10205 hv = (HV*)POPPTR(ss,ix);
10206 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10207 gv = (GV*)POPPTR(ss,ix);
10208 TOPPTR(nss,ix) = gv_dup(gv, param);
10210 case SAVEt_INT: /* int reference */
10211 ptr = POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10213 intval = (int)POPINT(ss,ix);
10214 TOPINT(nss,ix) = intval;
10216 case SAVEt_LONG: /* long reference */
10217 ptr = POPPTR(ss,ix);
10218 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10219 longval = (long)POPLONG(ss,ix);
10220 TOPLONG(nss,ix) = longval;
10222 case SAVEt_I32: /* I32 reference */
10223 case SAVEt_I16: /* I16 reference */
10224 case SAVEt_I8: /* I8 reference */
10225 ptr = POPPTR(ss,ix);
10226 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10228 TOPINT(nss,ix) = i;
10230 case SAVEt_IV: /* IV reference */
10231 ptr = POPPTR(ss,ix);
10232 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10234 TOPIV(nss,ix) = iv;
10236 case SAVEt_SPTR: /* SV* reference */
10237 ptr = POPPTR(ss,ix);
10238 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10239 sv = (SV*)POPPTR(ss,ix);
10240 TOPPTR(nss,ix) = sv_dup(sv, param);
10242 case SAVEt_VPTR: /* random* reference */
10243 ptr = POPPTR(ss,ix);
10244 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10245 ptr = POPPTR(ss,ix);
10246 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10248 case SAVEt_PPTR: /* char* reference */
10249 ptr = POPPTR(ss,ix);
10250 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10251 c = (char*)POPPTR(ss,ix);
10252 TOPPTR(nss,ix) = pv_dup(c);
10254 case SAVEt_HPTR: /* HV* reference */
10255 ptr = POPPTR(ss,ix);
10256 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10257 hv = (HV*)POPPTR(ss,ix);
10258 TOPPTR(nss,ix) = hv_dup(hv, param);
10260 case SAVEt_APTR: /* AV* reference */
10261 ptr = POPPTR(ss,ix);
10262 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10263 av = (AV*)POPPTR(ss,ix);
10264 TOPPTR(nss,ix) = av_dup(av, param);
10267 gv = (GV*)POPPTR(ss,ix);
10268 TOPPTR(nss,ix) = gv_dup(gv, param);
10270 case SAVEt_GP: /* scalar reference */
10271 gp = (GP*)POPPTR(ss,ix);
10272 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10273 (void)GpREFCNT_inc(gp);
10274 gv = (GV*)POPPTR(ss,ix);
10275 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10276 c = (char*)POPPTR(ss,ix);
10277 TOPPTR(nss,ix) = pv_dup(c);
10279 TOPIV(nss,ix) = iv;
10281 TOPIV(nss,ix) = iv;
10284 case SAVEt_MORTALIZESV:
10285 sv = (SV*)POPPTR(ss,ix);
10286 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10289 ptr = POPPTR(ss,ix);
10290 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10291 /* these are assumed to be refcounted properly */
10293 switch (((OP*)ptr)->op_type) {
10295 case OP_LEAVESUBLV:
10299 case OP_LEAVEWRITE:
10300 TOPPTR(nss,ix) = ptr;
10305 TOPPTR(nss,ix) = NULL;
10310 TOPPTR(nss,ix) = NULL;
10313 c = (char*)POPPTR(ss,ix);
10314 TOPPTR(nss,ix) = pv_dup_inc(c);
10316 case SAVEt_CLEARSV:
10317 longval = POPLONG(ss,ix);
10318 TOPLONG(nss,ix) = longval;
10321 hv = (HV*)POPPTR(ss,ix);
10322 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10323 c = (char*)POPPTR(ss,ix);
10324 TOPPTR(nss,ix) = pv_dup_inc(c);
10326 TOPINT(nss,ix) = i;
10328 case SAVEt_DESTRUCTOR:
10329 ptr = POPPTR(ss,ix);
10330 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10331 dptr = POPDPTR(ss,ix);
10332 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10333 any_dup(FPTR2DPTR(void *, dptr),
10336 case SAVEt_DESTRUCTOR_X:
10337 ptr = POPPTR(ss,ix);
10338 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10339 dxptr = POPDXPTR(ss,ix);
10340 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10341 any_dup(FPTR2DPTR(void *, dxptr),
10344 case SAVEt_REGCONTEXT:
10347 TOPINT(nss,ix) = i;
10350 case SAVEt_STACK_POS: /* Position on Perl stack */
10352 TOPINT(nss,ix) = i;
10354 case SAVEt_AELEM: /* array element */
10355 sv = (SV*)POPPTR(ss,ix);
10356 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10358 TOPINT(nss,ix) = i;
10359 av = (AV*)POPPTR(ss,ix);
10360 TOPPTR(nss,ix) = av_dup_inc(av, param);
10362 case SAVEt_HELEM: /* hash element */
10363 sv = (SV*)POPPTR(ss,ix);
10364 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10365 sv = (SV*)POPPTR(ss,ix);
10366 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10367 hv = (HV*)POPPTR(ss,ix);
10368 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10371 ptr = POPPTR(ss,ix);
10372 TOPPTR(nss,ix) = ptr;
10376 TOPINT(nss,ix) = i;
10378 case SAVEt_COMPPAD:
10379 av = (AV*)POPPTR(ss,ix);
10380 TOPPTR(nss,ix) = av_dup(av, param);
10383 longval = (long)POPLONG(ss,ix);
10384 TOPLONG(nss,ix) = longval;
10385 ptr = POPPTR(ss,ix);
10386 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10387 sv = (SV*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = sv_dup(sv, param);
10391 ptr = POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10393 longval = (long)POPBOOL(ss,ix);
10394 TOPBOOL(nss,ix) = (bool)longval;
10396 case SAVEt_SET_SVFLAGS:
10398 TOPINT(nss,ix) = i;
10400 TOPINT(nss,ix) = i;
10401 sv = (SV*)POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = sv_dup(sv, param);
10405 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10413 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10414 * flag to the result. This is done for each stash before cloning starts,
10415 * so we know which stashes want their objects cloned */
10418 do_mark_cloneable_stash(pTHX_ SV *sv)
10420 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10422 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10423 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10424 if (cloner && GvCV(cloner)) {
10431 XPUSHs(sv_2mortal(newSVhek(hvname)));
10433 call_sv((SV*)GvCV(cloner), G_SCALAR);
10440 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10448 =for apidoc perl_clone
10450 Create and return a new interpreter by cloning the current one.
10452 perl_clone takes these flags as parameters:
10454 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10455 without it we only clone the data and zero the stacks,
10456 with it we copy the stacks and the new perl interpreter is
10457 ready to run at the exact same point as the previous one.
10458 The pseudo-fork code uses COPY_STACKS while the
10459 threads->new doesn't.
10461 CLONEf_KEEP_PTR_TABLE
10462 perl_clone keeps a ptr_table with the pointer of the old
10463 variable as a key and the new variable as a value,
10464 this allows it to check if something has been cloned and not
10465 clone it again but rather just use the value and increase the
10466 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10467 the ptr_table using the function
10468 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10469 reason to keep it around is if you want to dup some of your own
10470 variable who are outside the graph perl scans, example of this
10471 code is in threads.xs create
10474 This is a win32 thing, it is ignored on unix, it tells perls
10475 win32host code (which is c++) to clone itself, this is needed on
10476 win32 if you want to run two threads at the same time,
10477 if you just want to do some stuff in a separate perl interpreter
10478 and then throw it away and return to the original one,
10479 you don't need to do anything.
10484 /* XXX the above needs expanding by someone who actually understands it ! */
10485 EXTERN_C PerlInterpreter *
10486 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10489 perl_clone(PerlInterpreter *proto_perl, UV flags)
10492 #ifdef PERL_IMPLICIT_SYS
10494 /* perlhost.h so we need to call into it
10495 to clone the host, CPerlHost should have a c interface, sky */
10497 if (flags & CLONEf_CLONE_HOST) {
10498 return perl_clone_host(proto_perl,flags);
10500 return perl_clone_using(proto_perl, flags,
10502 proto_perl->IMemShared,
10503 proto_perl->IMemParse,
10505 proto_perl->IStdIO,
10509 proto_perl->IProc);
10513 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10514 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10515 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10516 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10517 struct IPerlDir* ipD, struct IPerlSock* ipS,
10518 struct IPerlProc* ipP)
10520 /* XXX many of the string copies here can be optimized if they're
10521 * constants; they need to be allocated as common memory and just
10522 * their pointers copied. */
10525 CLONE_PARAMS clone_params;
10526 CLONE_PARAMS* const param = &clone_params;
10528 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10529 /* for each stash, determine whether its objects should be cloned */
10530 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10531 PERL_SET_THX(my_perl);
10534 Poison(my_perl, 1, PerlInterpreter);
10540 PL_savestack_ix = 0;
10541 PL_savestack_max = -1;
10542 PL_sig_pending = 0;
10543 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10544 # else /* !DEBUGGING */
10545 Zero(my_perl, 1, PerlInterpreter);
10546 # endif /* DEBUGGING */
10548 /* host pointers */
10550 PL_MemShared = ipMS;
10551 PL_MemParse = ipMP;
10558 #else /* !PERL_IMPLICIT_SYS */
10560 CLONE_PARAMS clone_params;
10561 CLONE_PARAMS* param = &clone_params;
10562 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10563 /* for each stash, determine whether its objects should be cloned */
10564 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10565 PERL_SET_THX(my_perl);
10568 Poison(my_perl, 1, PerlInterpreter);
10574 PL_savestack_ix = 0;
10575 PL_savestack_max = -1;
10576 PL_sig_pending = 0;
10577 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10578 # else /* !DEBUGGING */
10579 Zero(my_perl, 1, PerlInterpreter);
10580 # endif /* DEBUGGING */
10581 #endif /* PERL_IMPLICIT_SYS */
10582 param->flags = flags;
10583 param->proto_perl = proto_perl;
10585 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10587 PL_body_arenas = NULL;
10588 Zero(&PL_body_roots, 1, PL_body_roots);
10590 PL_nice_chunk = NULL;
10591 PL_nice_chunk_size = 0;
10593 PL_sv_objcount = 0;
10595 PL_sv_arenaroot = NULL;
10597 PL_debug = proto_perl->Idebug;
10599 PL_hash_seed = proto_perl->Ihash_seed;
10600 PL_rehash_seed = proto_perl->Irehash_seed;
10602 #ifdef USE_REENTRANT_API
10603 /* XXX: things like -Dm will segfault here in perlio, but doing
10604 * PERL_SET_CONTEXT(proto_perl);
10605 * breaks too many other things
10607 Perl_reentrant_init(aTHX);
10610 /* create SV map for pointer relocation */
10611 PL_ptr_table = ptr_table_new();
10613 /* initialize these special pointers as early as possible */
10614 SvANY(&PL_sv_undef) = NULL;
10615 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10616 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10617 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10619 SvANY(&PL_sv_no) = new_XPVNV();
10620 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10621 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10622 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10623 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10624 SvCUR_set(&PL_sv_no, 0);
10625 SvLEN_set(&PL_sv_no, 1);
10626 SvIV_set(&PL_sv_no, 0);
10627 SvNV_set(&PL_sv_no, 0);
10628 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10630 SvANY(&PL_sv_yes) = new_XPVNV();
10631 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10632 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10633 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10634 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10635 SvCUR_set(&PL_sv_yes, 1);
10636 SvLEN_set(&PL_sv_yes, 2);
10637 SvIV_set(&PL_sv_yes, 1);
10638 SvNV_set(&PL_sv_yes, 1);
10639 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10641 /* create (a non-shared!) shared string table */
10642 PL_strtab = newHV();
10643 HvSHAREKEYS_off(PL_strtab);
10644 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10645 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10647 PL_compiling = proto_perl->Icompiling;
10649 /* These two PVs will be free'd special way so must set them same way op.c does */
10650 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10651 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10653 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10654 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10656 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10657 if (!specialWARN(PL_compiling.cop_warnings))
10658 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10659 if (!specialCopIO(PL_compiling.cop_io))
10660 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10661 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10663 /* pseudo environmental stuff */
10664 PL_origargc = proto_perl->Iorigargc;
10665 PL_origargv = proto_perl->Iorigargv;
10667 param->stashes = newAV(); /* Setup array of objects to call clone on */
10669 /* Set tainting stuff before PerlIO_debug can possibly get called */
10670 PL_tainting = proto_perl->Itainting;
10671 PL_taint_warn = proto_perl->Itaint_warn;
10673 #ifdef PERLIO_LAYERS
10674 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10675 PerlIO_clone(aTHX_ proto_perl, param);
10678 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10679 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10680 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10681 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10682 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10683 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10686 PL_minus_c = proto_perl->Iminus_c;
10687 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10688 PL_localpatches = proto_perl->Ilocalpatches;
10689 PL_splitstr = proto_perl->Isplitstr;
10690 PL_preprocess = proto_perl->Ipreprocess;
10691 PL_minus_n = proto_perl->Iminus_n;
10692 PL_minus_p = proto_perl->Iminus_p;
10693 PL_minus_l = proto_perl->Iminus_l;
10694 PL_minus_a = proto_perl->Iminus_a;
10695 PL_minus_E = proto_perl->Iminus_E;
10696 PL_minus_F = proto_perl->Iminus_F;
10697 PL_doswitches = proto_perl->Idoswitches;
10698 PL_dowarn = proto_perl->Idowarn;
10699 PL_doextract = proto_perl->Idoextract;
10700 PL_sawampersand = proto_perl->Isawampersand;
10701 PL_unsafe = proto_perl->Iunsafe;
10702 PL_inplace = SAVEPV(proto_perl->Iinplace);
10703 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10704 PL_perldb = proto_perl->Iperldb;
10705 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10706 PL_exit_flags = proto_perl->Iexit_flags;
10708 /* magical thingies */
10709 /* XXX time(&PL_basetime) when asked for? */
10710 PL_basetime = proto_perl->Ibasetime;
10711 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10713 PL_maxsysfd = proto_perl->Imaxsysfd;
10714 PL_multiline = proto_perl->Imultiline;
10715 PL_statusvalue = proto_perl->Istatusvalue;
10717 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10719 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10721 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10723 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10724 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10725 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10727 /* Clone the regex array */
10728 PL_regex_padav = newAV();
10730 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10731 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10733 av_push(PL_regex_padav,
10734 sv_dup_inc(regexen[0],param));
10735 for(i = 1; i <= len; i++) {
10736 const SV * const regex = regexen[i];
10739 ? sv_dup_inc(regex, param)
10741 newSViv(PTR2IV(re_dup(
10742 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10744 av_push(PL_regex_padav, sv);
10747 PL_regex_pad = AvARRAY(PL_regex_padav);
10749 /* shortcuts to various I/O objects */
10750 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10751 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10752 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10753 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10754 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10755 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10757 /* shortcuts to regexp stuff */
10758 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10760 /* shortcuts to misc objects */
10761 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10763 /* shortcuts to debugging objects */
10764 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10765 PL_DBline = gv_dup(proto_perl->IDBline, param);
10766 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10767 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10768 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10769 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10770 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10771 PL_lineary = av_dup(proto_perl->Ilineary, param);
10772 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10774 /* symbol tables */
10775 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10776 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10777 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10778 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10779 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10781 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10782 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10783 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10784 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10785 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10786 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10788 PL_sub_generation = proto_perl->Isub_generation;
10790 /* funky return mechanisms */
10791 PL_forkprocess = proto_perl->Iforkprocess;
10793 /* subprocess state */
10794 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10796 /* internal state */
10797 PL_maxo = proto_perl->Imaxo;
10798 if (proto_perl->Iop_mask)
10799 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10802 /* PL_asserting = proto_perl->Iasserting; */
10804 /* current interpreter roots */
10805 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10806 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10807 PL_main_start = proto_perl->Imain_start;
10808 PL_eval_root = proto_perl->Ieval_root;
10809 PL_eval_start = proto_perl->Ieval_start;
10811 /* runtime control stuff */
10812 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10813 PL_copline = proto_perl->Icopline;
10815 PL_filemode = proto_perl->Ifilemode;
10816 PL_lastfd = proto_perl->Ilastfd;
10817 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10820 PL_gensym = proto_perl->Igensym;
10821 PL_preambled = proto_perl->Ipreambled;
10822 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10823 PL_laststatval = proto_perl->Ilaststatval;
10824 PL_laststype = proto_perl->Ilaststype;
10827 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10829 /* interpreter atexit processing */
10830 PL_exitlistlen = proto_perl->Iexitlistlen;
10831 if (PL_exitlistlen) {
10832 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10833 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10836 PL_exitlist = (PerlExitListEntry*)NULL;
10838 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10839 if (PL_my_cxt_size) {
10840 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10841 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10844 PL_my_cxt_list = (void**)NULL;
10845 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10846 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10847 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10849 PL_profiledata = NULL;
10850 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10851 /* PL_rsfp_filters entries have fake IoDIRP() */
10852 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10854 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10856 PAD_CLONE_VARS(proto_perl, param);
10858 #ifdef HAVE_INTERP_INTERN
10859 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10862 /* more statics moved here */
10863 PL_generation = proto_perl->Igeneration;
10864 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10866 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10867 PL_in_clean_all = proto_perl->Iin_clean_all;
10869 PL_uid = proto_perl->Iuid;
10870 PL_euid = proto_perl->Ieuid;
10871 PL_gid = proto_perl->Igid;
10872 PL_egid = proto_perl->Iegid;
10873 PL_nomemok = proto_perl->Inomemok;
10874 PL_an = proto_perl->Ian;
10875 PL_evalseq = proto_perl->Ievalseq;
10876 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10877 PL_origalen = proto_perl->Iorigalen;
10878 #ifdef PERL_USES_PL_PIDSTATUS
10879 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10881 PL_osname = SAVEPV(proto_perl->Iosname);
10882 PL_sighandlerp = proto_perl->Isighandlerp;
10884 PL_runops = proto_perl->Irunops;
10886 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10889 PL_cshlen = proto_perl->Icshlen;
10890 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10893 PL_lex_state = proto_perl->Ilex_state;
10894 PL_lex_defer = proto_perl->Ilex_defer;
10895 PL_lex_expect = proto_perl->Ilex_expect;
10896 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10897 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10898 PL_lex_starts = proto_perl->Ilex_starts;
10899 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10900 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10901 PL_lex_op = proto_perl->Ilex_op;
10902 PL_lex_inpat = proto_perl->Ilex_inpat;
10903 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10904 PL_lex_brackets = proto_perl->Ilex_brackets;
10905 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10906 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10907 PL_lex_casemods = proto_perl->Ilex_casemods;
10908 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10909 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10911 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10912 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10913 PL_nexttoke = proto_perl->Inexttoke;
10915 /* XXX This is probably masking the deeper issue of why
10916 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10917 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10918 * (A little debugging with a watchpoint on it may help.)
10920 if (SvANY(proto_perl->Ilinestr)) {
10921 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10922 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10923 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10924 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10925 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10926 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10927 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10928 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10929 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10932 PL_linestr = newSV(79);
10933 sv_upgrade(PL_linestr,SVt_PVIV);
10934 sv_setpvn(PL_linestr,"",0);
10935 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10937 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10938 PL_pending_ident = proto_perl->Ipending_ident;
10939 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10941 PL_expect = proto_perl->Iexpect;
10943 PL_multi_start = proto_perl->Imulti_start;
10944 PL_multi_end = proto_perl->Imulti_end;
10945 PL_multi_open = proto_perl->Imulti_open;
10946 PL_multi_close = proto_perl->Imulti_close;
10948 PL_error_count = proto_perl->Ierror_count;
10949 PL_subline = proto_perl->Isubline;
10950 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10952 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10953 if (SvANY(proto_perl->Ilinestr)) {
10954 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10955 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10956 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10957 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10958 PL_last_lop_op = proto_perl->Ilast_lop_op;
10961 PL_last_uni = SvPVX(PL_linestr);
10962 PL_last_lop = SvPVX(PL_linestr);
10963 PL_last_lop_op = 0;
10965 PL_in_my = proto_perl->Iin_my;
10966 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10968 PL_cryptseen = proto_perl->Icryptseen;
10971 PL_hints = proto_perl->Ihints;
10973 PL_amagic_generation = proto_perl->Iamagic_generation;
10975 #ifdef USE_LOCALE_COLLATE
10976 PL_collation_ix = proto_perl->Icollation_ix;
10977 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10978 PL_collation_standard = proto_perl->Icollation_standard;
10979 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10980 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10981 #endif /* USE_LOCALE_COLLATE */
10983 #ifdef USE_LOCALE_NUMERIC
10984 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10985 PL_numeric_standard = proto_perl->Inumeric_standard;
10986 PL_numeric_local = proto_perl->Inumeric_local;
10987 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10988 #endif /* !USE_LOCALE_NUMERIC */
10990 /* utf8 character classes */
10991 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10992 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10993 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10994 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10995 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10996 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10997 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10998 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10999 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11000 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11001 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11002 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11003 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11004 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11005 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11006 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11007 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11008 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11009 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11010 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11012 /* Did the locale setup indicate UTF-8? */
11013 PL_utf8locale = proto_perl->Iutf8locale;
11014 /* Unicode features (see perlrun/-C) */
11015 PL_unicode = proto_perl->Iunicode;
11017 /* Pre-5.8 signals control */
11018 PL_signals = proto_perl->Isignals;
11020 /* times() ticks per second */
11021 PL_clocktick = proto_perl->Iclocktick;
11023 /* Recursion stopper for PerlIO_find_layer */
11024 PL_in_load_module = proto_perl->Iin_load_module;
11026 /* sort() routine */
11027 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11029 /* Not really needed/useful since the reenrant_retint is "volatile",
11030 * but do it for consistency's sake. */
11031 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11033 /* Hooks to shared SVs and locks. */
11034 PL_sharehook = proto_perl->Isharehook;
11035 PL_lockhook = proto_perl->Ilockhook;
11036 PL_unlockhook = proto_perl->Iunlockhook;
11037 PL_threadhook = proto_perl->Ithreadhook;
11039 PL_runops_std = proto_perl->Irunops_std;
11040 PL_runops_dbg = proto_perl->Irunops_dbg;
11042 #ifdef THREADS_HAVE_PIDS
11043 PL_ppid = proto_perl->Ippid;
11047 PL_last_swash_hv = NULL; /* reinits on demand */
11048 PL_last_swash_klen = 0;
11049 PL_last_swash_key[0]= '\0';
11050 PL_last_swash_tmps = (U8*)NULL;
11051 PL_last_swash_slen = 0;
11053 PL_glob_index = proto_perl->Iglob_index;
11054 PL_srand_called = proto_perl->Isrand_called;
11055 PL_uudmap['M'] = 0; /* reinits on demand */
11056 PL_bitcount = NULL; /* reinits on demand */
11058 if (proto_perl->Ipsig_pend) {
11059 Newxz(PL_psig_pend, SIG_SIZE, int);
11062 PL_psig_pend = (int*)NULL;
11065 if (proto_perl->Ipsig_ptr) {
11066 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11067 Newxz(PL_psig_name, SIG_SIZE, SV*);
11068 for (i = 1; i < SIG_SIZE; i++) {
11069 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11070 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11074 PL_psig_ptr = (SV**)NULL;
11075 PL_psig_name = (SV**)NULL;
11078 /* thrdvar.h stuff */
11080 if (flags & CLONEf_COPY_STACKS) {
11081 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11082 PL_tmps_ix = proto_perl->Ttmps_ix;
11083 PL_tmps_max = proto_perl->Ttmps_max;
11084 PL_tmps_floor = proto_perl->Ttmps_floor;
11085 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11087 while (i <= PL_tmps_ix) {
11088 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11092 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11093 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11094 Newxz(PL_markstack, i, I32);
11095 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11096 - proto_perl->Tmarkstack);
11097 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11098 - proto_perl->Tmarkstack);
11099 Copy(proto_perl->Tmarkstack, PL_markstack,
11100 PL_markstack_ptr - PL_markstack + 1, I32);
11102 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11103 * NOTE: unlike the others! */
11104 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11105 PL_scopestack_max = proto_perl->Tscopestack_max;
11106 Newxz(PL_scopestack, PL_scopestack_max, I32);
11107 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11109 /* NOTE: si_dup() looks at PL_markstack */
11110 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11112 /* PL_curstack = PL_curstackinfo->si_stack; */
11113 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11114 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11116 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11117 PL_stack_base = AvARRAY(PL_curstack);
11118 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11119 - proto_perl->Tstack_base);
11120 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11122 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11123 * NOTE: unlike the others! */
11124 PL_savestack_ix = proto_perl->Tsavestack_ix;
11125 PL_savestack_max = proto_perl->Tsavestack_max;
11126 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11127 PL_savestack = ss_dup(proto_perl, param);
11131 ENTER; /* perl_destruct() wants to LEAVE; */
11133 /* although we're not duplicating the tmps stack, we should still
11134 * add entries for any SVs on the tmps stack that got cloned by a
11135 * non-refcount means (eg a temp in @_); otherwise they will be
11138 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11139 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11140 proto_perl->Ttmps_stack[i]);
11141 if (nsv && !SvREFCNT(nsv)) {
11143 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
11148 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11149 PL_top_env = &PL_start_env;
11151 PL_op = proto_perl->Top;
11154 PL_Xpv = (XPV*)NULL;
11155 PL_na = proto_perl->Tna;
11157 PL_statbuf = proto_perl->Tstatbuf;
11158 PL_statcache = proto_perl->Tstatcache;
11159 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11160 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11162 PL_timesbuf = proto_perl->Ttimesbuf;
11165 PL_tainted = proto_perl->Ttainted;
11166 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11167 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11168 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11169 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11170 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11171 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11172 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11173 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11174 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11176 PL_restartop = proto_perl->Trestartop;
11177 PL_in_eval = proto_perl->Tin_eval;
11178 PL_delaymagic = proto_perl->Tdelaymagic;
11179 PL_dirty = proto_perl->Tdirty;
11180 PL_localizing = proto_perl->Tlocalizing;
11182 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11183 PL_hv_fetch_ent_mh = NULL;
11184 PL_modcount = proto_perl->Tmodcount;
11185 PL_lastgotoprobe = NULL;
11186 PL_dumpindent = proto_perl->Tdumpindent;
11188 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11189 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11190 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11191 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11192 PL_efloatbuf = NULL; /* reinits on demand */
11193 PL_efloatsize = 0; /* reinits on demand */
11197 PL_screamfirst = NULL;
11198 PL_screamnext = NULL;
11199 PL_maxscream = -1; /* reinits on demand */
11200 PL_lastscream = NULL;
11202 PL_watchaddr = NULL;
11205 PL_regdummy = proto_perl->Tregdummy;
11206 PL_regprecomp = NULL;
11209 PL_colorset = 0; /* reinits PL_colors[] */
11210 /*PL_colors[6] = {0,0,0,0,0,0};*/
11211 PL_reginput = NULL;
11214 PL_regstartp = (I32*)NULL;
11215 PL_regendp = (I32*)NULL;
11216 PL_reglastparen = (U32*)NULL;
11217 PL_reglastcloseparen = (U32*)NULL;
11219 PL_reg_start_tmp = (char**)NULL;
11220 PL_reg_start_tmpl = 0;
11221 PL_regdata = (struct reg_data*)NULL;
11224 PL_reg_eval_set = 0;
11226 PL_regprogram = (regnode*)NULL;
11228 PL_regcc = (CURCUR*)NULL;
11229 PL_reg_call_cc = (struct re_cc_state*)NULL;
11230 PL_reg_re = (regexp*)NULL;
11231 PL_reg_ganch = NULL;
11233 PL_reg_match_utf8 = FALSE;
11234 PL_reg_magic = (MAGIC*)NULL;
11236 PL_reg_oldcurpm = (PMOP*)NULL;
11237 PL_reg_curpm = (PMOP*)NULL;
11238 PL_reg_oldsaved = NULL;
11239 PL_reg_oldsavedlen = 0;
11240 #ifdef PERL_OLD_COPY_ON_WRITE
11243 PL_reg_maxiter = 0;
11244 PL_reg_leftiter = 0;
11245 PL_reg_poscache = NULL;
11246 PL_reg_poscache_size= 0;
11248 /* RE engine - function pointers */
11249 PL_regcompp = proto_perl->Tregcompp;
11250 PL_regexecp = proto_perl->Tregexecp;
11251 PL_regint_start = proto_perl->Tregint_start;
11252 PL_regint_string = proto_perl->Tregint_string;
11253 PL_regfree = proto_perl->Tregfree;
11255 PL_reginterp_cnt = 0;
11256 PL_reg_starttry = 0;
11258 /* Pluggable optimizer */
11259 PL_peepp = proto_perl->Tpeepp;
11261 PL_stashcache = newHV();
11263 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11264 ptr_table_free(PL_ptr_table);
11265 PL_ptr_table = NULL;
11268 /* Call the ->CLONE method, if it exists, for each of the stashes
11269 identified by sv_dup() above.
11271 while(av_len(param->stashes) != -1) {
11272 HV* const stash = (HV*) av_shift(param->stashes);
11273 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11274 if (cloner && GvCV(cloner)) {
11279 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11281 call_sv((SV*)GvCV(cloner), G_DISCARD);
11287 SvREFCNT_dec(param->stashes);
11289 /* orphaned? eg threads->new inside BEGIN or use */
11290 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11291 (void)SvREFCNT_inc(PL_compcv);
11292 SAVEFREESV(PL_compcv);
11298 #endif /* USE_ITHREADS */
11301 =head1 Unicode Support
11303 =for apidoc sv_recode_to_utf8
11305 The encoding is assumed to be an Encode object, on entry the PV
11306 of the sv is assumed to be octets in that encoding, and the sv
11307 will be converted into Unicode (and UTF-8).
11309 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11310 is not a reference, nothing is done to the sv. If the encoding is not
11311 an C<Encode::XS> Encoding object, bad things will happen.
11312 (See F<lib/encoding.pm> and L<Encode>).
11314 The PV of the sv is returned.
11319 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11322 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11336 Passing sv_yes is wrong - it needs to be or'ed set of constants
11337 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11338 remove converted chars from source.
11340 Both will default the value - let them.
11342 XPUSHs(&PL_sv_yes);
11345 call_method("decode", G_SCALAR);
11349 s = SvPV_const(uni, len);
11350 if (s != SvPVX_const(sv)) {
11351 SvGROW(sv, len + 1);
11352 Move(s, SvPVX(sv), len + 1, char);
11353 SvCUR_set(sv, len);
11360 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11364 =for apidoc sv_cat_decode
11366 The encoding is assumed to be an Encode object, the PV of the ssv is
11367 assumed to be octets in that encoding and decoding the input starts
11368 from the position which (PV + *offset) pointed to. The dsv will be
11369 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11370 when the string tstr appears in decoding output or the input ends on
11371 the PV of the ssv. The value which the offset points will be modified
11372 to the last input position on the ssv.
11374 Returns TRUE if the terminator was found, else returns FALSE.
11379 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11380 SV *ssv, int *offset, char *tstr, int tlen)
11384 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11395 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11396 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11398 call_method("cat_decode", G_SCALAR);
11400 ret = SvTRUE(TOPs);
11401 *offset = SvIV(offsv);
11407 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11412 /* ---------------------------------------------------------------------
11414 * support functions for report_uninit()
11417 /* the maxiumum size of array or hash where we will scan looking
11418 * for the undefined element that triggered the warning */
11420 #define FUV_MAX_SEARCH_SIZE 1000
11422 /* Look for an entry in the hash whose value has the same SV as val;
11423 * If so, return a mortal copy of the key. */
11426 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11429 register HE **array;
11432 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11433 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11436 array = HvARRAY(hv);
11438 for (i=HvMAX(hv); i>0; i--) {
11439 register HE *entry;
11440 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11441 if (HeVAL(entry) != val)
11443 if ( HeVAL(entry) == &PL_sv_undef ||
11444 HeVAL(entry) == &PL_sv_placeholder)
11448 if (HeKLEN(entry) == HEf_SVKEY)
11449 return sv_mortalcopy(HeKEY_sv(entry));
11450 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11456 /* Look for an entry in the array whose value has the same SV as val;
11457 * If so, return the index, otherwise return -1. */
11460 S_find_array_subscript(pTHX_ AV *av, SV* val)
11465 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11466 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11470 for (i=AvFILLp(av); i>=0; i--) {
11471 if (svp[i] == val && svp[i] != &PL_sv_undef)
11477 /* S_varname(): return the name of a variable, optionally with a subscript.
11478 * If gv is non-zero, use the name of that global, along with gvtype (one
11479 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11480 * targ. Depending on the value of the subscript_type flag, return:
11483 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11484 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11485 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11486 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11489 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11490 SV* keyname, I32 aindex, int subscript_type)
11493 SV * const name = sv_newmortal();
11496 buffer[0] = gvtype;
11499 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11501 gv_fullname4(name, gv, buffer, 0);
11503 if ((unsigned int)SvPVX(name)[1] <= 26) {
11505 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11507 /* Swap the 1 unprintable control character for the 2 byte pretty
11508 version - ie substr($name, 1, 1) = $buffer; */
11509 sv_insert(name, 1, 1, buffer, 2);
11514 CV * const cv = find_runcv(&unused);
11518 if (!cv || !CvPADLIST(cv))
11520 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11521 sv = *av_fetch(av, targ, FALSE);
11522 /* SvLEN in a pad name is not to be trusted */
11523 sv_setpv(name, SvPV_nolen_const(sv));
11526 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11527 SV * const sv = newSV(0);
11528 *SvPVX(name) = '$';
11529 Perl_sv_catpvf(aTHX_ name, "{%s}",
11530 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11533 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11534 *SvPVX(name) = '$';
11535 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11537 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11538 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11545 =for apidoc find_uninit_var
11547 Find the name of the undefined variable (if any) that caused the operator o
11548 to issue a "Use of uninitialized value" warning.
11549 If match is true, only return a name if it's value matches uninit_sv.
11550 So roughly speaking, if a unary operator (such as OP_COS) generates a
11551 warning, then following the direct child of the op may yield an
11552 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11553 other hand, with OP_ADD there are two branches to follow, so we only print
11554 the variable name if we get an exact match.
11556 The name is returned as a mortal SV.
11558 Assumes that PL_op is the op that originally triggered the error, and that
11559 PL_comppad/PL_curpad points to the currently executing pad.
11565 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11573 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11574 uninit_sv == &PL_sv_placeholder)))
11577 switch (obase->op_type) {
11584 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11585 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11588 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11590 if (pad) { /* @lex, %lex */
11591 sv = PAD_SVl(obase->op_targ);
11595 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11596 /* @global, %global */
11597 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11600 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11602 else /* @{expr}, %{expr} */
11603 return find_uninit_var(cUNOPx(obase)->op_first,
11607 /* attempt to find a match within the aggregate */
11609 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11611 subscript_type = FUV_SUBSCRIPT_HASH;
11614 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11616 subscript_type = FUV_SUBSCRIPT_ARRAY;
11619 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11622 return varname(gv, hash ? '%' : '@', obase->op_targ,
11623 keysv, index, subscript_type);
11627 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11629 return varname(NULL, '$', obase->op_targ,
11630 NULL, 0, FUV_SUBSCRIPT_NONE);
11633 gv = cGVOPx_gv(obase);
11634 if (!gv || (match && GvSV(gv) != uninit_sv))
11636 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11639 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11642 av = (AV*)PAD_SV(obase->op_targ);
11643 if (!av || SvRMAGICAL(av))
11645 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11646 if (!svp || *svp != uninit_sv)
11649 return varname(NULL, '$', obase->op_targ,
11650 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11653 gv = cGVOPx_gv(obase);
11659 if (!av || SvRMAGICAL(av))
11661 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11662 if (!svp || *svp != uninit_sv)
11665 return varname(gv, '$', 0,
11666 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11671 o = cUNOPx(obase)->op_first;
11672 if (!o || o->op_type != OP_NULL ||
11673 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11675 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11679 if (PL_op == obase)
11680 /* $a[uninit_expr] or $h{uninit_expr} */
11681 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11684 o = cBINOPx(obase)->op_first;
11685 kid = cBINOPx(obase)->op_last;
11687 /* get the av or hv, and optionally the gv */
11689 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11690 sv = PAD_SV(o->op_targ);
11692 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11693 && cUNOPo->op_first->op_type == OP_GV)
11695 gv = cGVOPx_gv(cUNOPo->op_first);
11698 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11703 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11704 /* index is constant */
11708 if (obase->op_type == OP_HELEM) {
11709 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11710 if (!he || HeVAL(he) != uninit_sv)
11714 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11715 if (!svp || *svp != uninit_sv)
11719 if (obase->op_type == OP_HELEM)
11720 return varname(gv, '%', o->op_targ,
11721 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11723 return varname(gv, '@', o->op_targ, NULL,
11724 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11727 /* index is an expression;
11728 * attempt to find a match within the aggregate */
11729 if (obase->op_type == OP_HELEM) {
11730 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11732 return varname(gv, '%', o->op_targ,
11733 keysv, 0, FUV_SUBSCRIPT_HASH);
11736 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11738 return varname(gv, '@', o->op_targ,
11739 NULL, index, FUV_SUBSCRIPT_ARRAY);
11744 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11746 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11751 /* only examine RHS */
11752 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11755 o = cUNOPx(obase)->op_first;
11756 if (o->op_type == OP_PUSHMARK)
11759 if (!o->op_sibling) {
11760 /* one-arg version of open is highly magical */
11762 if (o->op_type == OP_GV) { /* open FOO; */
11764 if (match && GvSV(gv) != uninit_sv)
11766 return varname(gv, '$', 0,
11767 NULL, 0, FUV_SUBSCRIPT_NONE);
11769 /* other possibilities not handled are:
11770 * open $x; or open my $x; should return '${*$x}'
11771 * open expr; should return '$'.expr ideally
11777 /* ops where $_ may be an implicit arg */
11781 if ( !(obase->op_flags & OPf_STACKED)) {
11782 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11783 ? PAD_SVl(obase->op_targ)
11786 sv = sv_newmortal();
11787 sv_setpvn(sv, "$_", 2);
11795 /* skip filehandle as it can't produce 'undef' warning */
11796 o = cUNOPx(obase)->op_first;
11797 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11798 o = o->op_sibling->op_sibling;
11805 match = 1; /* XS or custom code could trigger random warnings */
11810 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11811 return sv_2mortal(newSVpvs("${$/}"));
11816 if (!(obase->op_flags & OPf_KIDS))
11818 o = cUNOPx(obase)->op_first;
11824 /* if all except one arg are constant, or have no side-effects,
11825 * or are optimized away, then it's unambiguous */
11827 for (kid=o; kid; kid = kid->op_sibling) {
11829 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11830 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11831 || (kid->op_type == OP_PUSHMARK)
11835 if (o2) { /* more than one found */
11842 return find_uninit_var(o2, uninit_sv, match);
11844 /* scan all args */
11846 sv = find_uninit_var(o, uninit_sv, 1);
11858 =for apidoc report_uninit
11860 Print appropriate "Use of uninitialized variable" warning
11866 Perl_report_uninit(pTHX_ SV* uninit_sv)
11870 SV* varname = NULL;
11872 varname = find_uninit_var(PL_op, uninit_sv,0);
11874 sv_insert(varname, 0, 0, " ", 1);
11876 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11877 varname ? SvPV_nolen_const(varname) : "",
11878 " in ", OP_DESC(PL_op));
11881 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11887 * c-indentation-style: bsd
11888 * c-basic-offset: 4
11889 * indent-tabs-mode: t
11892 * ex: set ts=8 sts=4 sw=4 noet: