3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
62 sv, av, hv...) contains type and reference count information, and for
63 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
64 contains fields specific to each type. Some types store all they need
65 in the head, so don't have a body.
67 In all but the most memory-paranoid configuations (ex: PURIFY), heads
68 and bodies are allocated out of arenas, which by default are
69 approximately 4K chunks of memory parcelled up into N heads or bodies.
70 Sv-bodies are allocated by their sv-type, guaranteeing size
71 consistency needed to allocate safely from arrays.
73 For SV-heads, the first slot in each arena is reserved, and holds a
74 link to the next arena, some flags, and a note of the number of slots.
75 Snaked through each arena chain is a linked list of free items; when
76 this becomes empty, an extra arena is allocated and divided up into N
77 items which are threaded into the free list.
79 SV-bodies are similar, but they use arena-sets by default, which
80 separate the link and info from the arena itself, and reclaim the 1st
81 slot in the arena. SV-bodies are further described later.
83 The following global variables are associated with arenas:
85 PL_sv_arenaroot pointer to list of SV arenas
86 PL_sv_root pointer to list of free SV structures
88 PL_body_arenas head of linked-list of body arenas
89 PL_body_roots[] array of pointers to list of free bodies of svtype
90 arrays are indexed by the svtype needed
92 A few special SV heads are not allocated from an arena, but are
93 instead directly created in the interpreter structure, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 At the time of very final cleanup, sv_free_arenas() is called from
107 perl_destruct() to physically free all the arenas allocated since the
108 start of the interpreter.
110 Manipulation of any of the PL_*root pointers is protected by enclosing
111 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
112 if threads are enabled.
114 The function visit() scans the SV arenas list, and calls a specified
115 function for each SV it finds which is still live - ie which has an SvTYPE
116 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
117 following functions (specified as [function that calls visit()] / [function
118 called by visit() for each SV]):
120 sv_report_used() / do_report_used()
121 dump all remaining SVs (debugging aid)
123 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
124 Attempt to free all objects pointed to by RVs,
125 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
126 try to do the same for all objects indirectly
127 referenced by typeglobs too. Called once from
128 perl_destruct(), prior to calling sv_clean_all()
131 sv_clean_all() / do_clean_all()
132 SvREFCNT_dec(sv) each remaining SV, possibly
133 triggering an sv_free(). It also sets the
134 SVf_BREAK flag on the SV to indicate that the
135 refcnt has been artificially lowered, and thus
136 stopping sv_free() from giving spurious warnings
137 about SVs which unexpectedly have a refcnt
138 of zero. called repeatedly from perl_destruct()
139 until there are no SVs left.
141 =head2 Arena allocator API Summary
143 Private API to rest of sv.c
147 new_XIV(), del_XIV(),
148 new_XNV(), del_XNV(),
153 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
157 ============================================================================ */
160 * "A time to plant, and a time to uproot what was planted..."
164 * nice_chunk and nice_chunk size need to be set
165 * and queried under the protection of sv_mutex
168 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
174 new_chunk = (void *)(chunk);
175 new_chunk_size = (chunk_size);
176 if (new_chunk_size > PL_nice_chunk_size) {
177 Safefree(PL_nice_chunk);
178 PL_nice_chunk = (char *) new_chunk;
179 PL_nice_chunk_size = new_chunk_size;
186 #ifdef DEBUG_LEAKING_SCALARS
187 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
189 # define FREE_SV_DEBUG_FILE(sv)
193 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
194 /* Whilst I'd love to do this, it seems that things like to check on
196 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
198 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
199 Poison(&SvREFCNT(sv), 1, U32)
201 # define SvARENA_CHAIN(sv) SvANY(sv)
202 # define POSION_SV_HEAD(sv)
205 #define plant_SV(p) \
207 FREE_SV_DEBUG_FILE(p); \
209 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
210 SvFLAGS(p) = SVTYPEMASK; \
215 /* sv_mutex must be held while calling uproot_SV() */
216 #define uproot_SV(p) \
219 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
224 /* make some more SVs by adding another arena */
226 /* sv_mutex must be held while calling more_sv() */
234 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
235 PL_nice_chunk = NULL;
236 PL_nice_chunk_size = 0;
239 char *chunk; /* must use New here to match call to */
240 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
241 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
247 /* new_SV(): return a new, empty SV head */
249 #ifdef DEBUG_LEAKING_SCALARS
250 /* provide a real function for a debugger to play with */
260 sv = S_more_sv(aTHX);
265 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
266 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
267 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
268 sv->sv_debug_inpad = 0;
269 sv->sv_debug_cloned = 0;
270 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
274 # define new_SV(p) (p)=S_new_SV(aTHX)
283 (p) = S_more_sv(aTHX); \
292 /* del_SV(): return an empty SV head to the free list */
307 S_del_sv(pTHX_ SV *p)
313 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
314 const SV * const sv = sva + 1;
315 const SV * const svend = &sva[SvREFCNT(sva)];
316 if (p >= sv && p < svend) {
322 if (ckWARN_d(WARN_INTERNAL))
323 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
324 "Attempt to free non-arena SV: 0x%"UVxf
325 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
332 #else /* ! DEBUGGING */
334 #define del_SV(p) plant_SV(p)
336 #endif /* DEBUGGING */
340 =head1 SV Manipulation Functions
342 =for apidoc sv_add_arena
344 Given a chunk of memory, link it to the head of the list of arenas,
345 and split it into a list of free SVs.
351 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
354 SV* const sva = (SV*)ptr;
358 /* The first SV in an arena isn't an SV. */
359 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
360 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
361 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
363 PL_sv_arenaroot = sva;
364 PL_sv_root = sva + 1;
366 svend = &sva[SvREFCNT(sva) - 1];
369 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
373 /* Must always set typemask because it's awlays checked in on cleanup
374 when the arenas are walked looking for objects. */
375 SvFLAGS(sv) = SVTYPEMASK;
378 SvARENA_CHAIN(sv) = 0;
382 SvFLAGS(sv) = SVTYPEMASK;
385 /* visit(): call the named function for each non-free SV in the arenas
386 * whose flags field matches the flags/mask args. */
389 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
395 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
396 register const SV * const svend = &sva[SvREFCNT(sva)];
398 for (sv = sva + 1; sv < svend; ++sv) {
399 if (SvTYPE(sv) != SVTYPEMASK
400 && (sv->sv_flags & mask) == flags
413 /* called by sv_report_used() for each live SV */
416 do_report_used(pTHX_ SV *sv)
418 if (SvTYPE(sv) != SVTYPEMASK) {
419 PerlIO_printf(Perl_debug_log, "****\n");
426 =for apidoc sv_report_used
428 Dump the contents of all SVs not yet freed. (Debugging aid).
434 Perl_sv_report_used(pTHX)
437 visit(do_report_used, 0, 0);
443 /* called by sv_clean_objs() for each live SV */
446 do_clean_objs(pTHX_ SV *ref)
450 SV * const target = SvRV(ref);
451 if (SvOBJECT(target)) {
452 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
453 if (SvWEAKREF(ref)) {
454 sv_del_backref(target, ref);
460 SvREFCNT_dec(target);
465 /* XXX Might want to check arrays, etc. */
468 /* called by sv_clean_objs() for each live SV */
470 #ifndef DISABLE_DESTRUCTOR_KLUDGE
472 do_clean_named_objs(pTHX_ SV *sv)
475 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
477 #ifdef PERL_DONT_CREATE_GVSV
480 SvOBJECT(GvSV(sv))) ||
481 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
482 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
483 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
484 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
486 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
487 SvFLAGS(sv) |= SVf_BREAK;
495 =for apidoc sv_clean_objs
497 Attempt to destroy all objects not yet freed
503 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
545 PL_in_clean_all = TRUE;
546 cleaned = visit(do_clean_all, 0,0);
547 PL_in_clean_all = FALSE;
552 ARENASETS: a meta-arena implementation which separates arena-info
553 into struct arena_set, which contains an array of struct
554 arena_descs, each holding info for a single arena. By separating
555 the meta-info from the arena, we recover the 1st slot, formerly
556 borrowed for list management. The arena_set is about the size of an
557 arena, avoiding the needless malloc overhead of a naive linked-list
559 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
560 memory in the last arena-set (1/2 on average). In trade, we get
561 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
562 smaller types). The recovery of the wasted space allows use of
563 small arenas for large, rare body types,
566 char *arena; /* the raw storage, allocated aligned */
567 size_t size; /* its size ~4k typ */
568 int unit_type; /* useful for arena audits */
569 /* info for sv-heads (eventually)
576 /* Get the maximum number of elements in set[] such that struct arena_set
577 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
578 therefore likely to be 1 aligned memory page. */
580 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
581 - 2 * sizeof(int)) / sizeof (struct arena_desc))
584 struct arena_set* next;
585 int set_size; /* ie ARENAS_PER_SET */
586 int curr; /* index of next available arena-desc */
587 struct arena_desc set[ARENAS_PER_SET];
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_ARENA0(body_size) \
879 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
880 #define FIT_ARENAn(count,body_size) \
881 ( count * body_size <= PERL_ARENA_SIZE) \
882 ? count * body_size \
883 : FIT_ARENA0 (body_size)
884 #define FIT_ARENA(count,body_size) \
886 ? FIT_ARENAn (count, body_size) \
887 : FIT_ARENA0 (body_size)
889 /* A macro to work out the offset needed to subtract from a pointer to (say)
896 to make its members accessible via a pointer to (say)
906 #define relative_STRUCT_OFFSET(longer, shorter, member) \
907 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
909 /* Calculate the length to copy. Specifically work out the length less any
910 final padding the compiler needed to add. See the comment in sv_upgrade
911 for why copying the padding proved to be a bug. */
913 #define copy_length(type, last_member) \
914 STRUCT_OFFSET(type, last_member) \
915 + sizeof (((type*)SvANY((SV*)0))->last_member)
917 static const struct body_details bodies_by_type[] = {
918 { sizeof(HE), 0, 0, SVt_NULL,
919 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
921 /* IVs are in the head, so the allocation size is 0.
922 However, the slot is overloaded for PTEs. */
923 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
924 sizeof(IV), /* This is used to copy out the IV body. */
925 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
926 NOARENA /* IVS don't need an arena */,
927 /* But PTEs need to know the size of their arena */
928 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
931 /* 8 bytes on most ILP32 with IEEE doubles */
932 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
933 FIT_ARENA(0, sizeof(NV)) },
935 /* RVs are in the head now. */
936 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
938 /* 8 bytes on most ILP32 with IEEE doubles */
939 { sizeof(xpv_allocated),
940 copy_length(XPV, xpv_len)
941 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
942 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
943 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
946 { sizeof(xpviv_allocated),
947 copy_length(XPVIV, xiv_u)
948 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
949 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
950 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
953 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
954 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
957 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
958 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
961 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
962 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
965 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
966 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
969 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
970 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
972 { sizeof(xpvav_allocated),
973 copy_length(XPVAV, xmg_stash)
974 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
975 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
976 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
978 { sizeof(xpvhv_allocated),
979 copy_length(XPVHV, xmg_stash)
980 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
981 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
982 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
985 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
986 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
987 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
989 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
990 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
991 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
993 /* XPVIO is 84 bytes, fits 48x */
994 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
995 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
998 #define new_body_type(sv_type) \
999 (void *)((char *)S_new_body(aTHX_ sv_type))
1001 #define del_body_type(p, sv_type) \
1002 del_body(p, &PL_body_roots[sv_type])
1005 #define new_body_allocated(sv_type) \
1006 (void *)((char *)S_new_body(aTHX_ sv_type) \
1007 - bodies_by_type[sv_type].offset)
1009 #define del_body_allocated(p, sv_type) \
1010 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
1013 #define my_safemalloc(s) (void*)safemalloc(s)
1014 #define my_safecalloc(s) (void*)safecalloc(s, 1)
1015 #define my_safefree(p) safefree((char*)p)
1019 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1020 #define del_XNV(p) my_safefree(p)
1022 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1023 #define del_XPVNV(p) my_safefree(p)
1025 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1026 #define del_XPVAV(p) my_safefree(p)
1028 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1029 #define del_XPVHV(p) my_safefree(p)
1031 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1032 #define del_XPVMG(p) my_safefree(p)
1034 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1035 #define del_XPVGV(p) my_safefree(p)
1039 #define new_XNV() new_body_type(SVt_NV)
1040 #define del_XNV(p) del_body_type(p, SVt_NV)
1042 #define new_XPVNV() new_body_type(SVt_PVNV)
1043 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1045 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1046 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1048 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1049 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1051 #define new_XPVMG() new_body_type(SVt_PVMG)
1052 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1054 #define new_XPVGV() new_body_type(SVt_PVGV)
1055 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1059 /* no arena for you! */
1061 #define new_NOARENA(details) \
1062 my_safemalloc((details)->body_size + (details)->offset)
1063 #define new_NOARENAZ(details) \
1064 my_safecalloc((details)->body_size + (details)->offset)
1067 static bool done_sanity_check;
1071 S_more_bodies (pTHX_ svtype sv_type)
1074 void ** const root = &PL_body_roots[sv_type];
1075 const struct body_details * const bdp = &bodies_by_type[sv_type];
1076 const size_t body_size = bdp->body_size;
1080 assert(bdp->arena_size);
1083 if (!done_sanity_check) {
1084 unsigned int i = SVt_LAST;
1086 done_sanity_check = TRUE;
1089 assert (bodies_by_type[i].type == i);
1093 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1095 end = start + bdp->arena_size - body_size;
1098 /* The initial slot is used to link the arenas together, so it isn't to be
1099 linked into the list of ready-to-use bodies. */
1102 /* computed count doesnt reflect the 1st slot reservation */
1103 DEBUG_m(PerlIO_printf(Perl_debug_log,
1104 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1105 start, end, bdp->arena_size, sv_type, body_size,
1106 bdp->arena_size / body_size));
1109 *root = (void *)start;
1111 while (start < end) {
1112 char * const next = start + body_size;
1113 *(void**) start = (void *)next;
1116 *(void **)start = 0;
1121 /* grab a new thing from the free list, allocating more if necessary.
1122 The inline version is used for speed in hot routines, and the
1123 function using it serves the rest (unless PURIFY).
1125 #define new_body_inline(xpv, sv_type) \
1127 void ** const r3wt = &PL_body_roots[sv_type]; \
1129 xpv = *((void **)(r3wt)) \
1130 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ sv_type); \
1131 *(r3wt) = *(void**)(xpv); \
1138 S_new_body(pTHX_ svtype sv_type)
1142 new_body_inline(xpv, sv_type);
1149 =for apidoc sv_upgrade
1151 Upgrade an SV to a more complex form. Generally adds a new body type to the
1152 SV, then copies across as much information as possible from the old body.
1153 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1159 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1164 const U32 old_type = SvTYPE(sv);
1165 const struct body_details *new_type_details;
1166 const struct body_details *const old_type_details
1167 = bodies_by_type + old_type;
1169 if (new_type != SVt_PV && SvIsCOW(sv)) {
1170 sv_force_normal_flags(sv, 0);
1173 if (old_type == new_type)
1176 if (old_type > new_type)
1177 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1178 (int)old_type, (int)new_type);
1181 old_body = SvANY(sv);
1183 /* Copying structures onto other structures that have been neatly zeroed
1184 has a subtle gotcha. Consider XPVMG
1186 +------+------+------+------+------+-------+-------+
1187 | NV | CUR | LEN | IV | MAGIC | STASH |
1188 +------+------+------+------+------+-------+-------+
1189 0 4 8 12 16 20 24 28
1191 where NVs are aligned to 8 bytes, so that sizeof that structure is
1192 actually 32 bytes long, with 4 bytes of padding at the end:
1194 +------+------+------+------+------+-------+-------+------+
1195 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1196 +------+------+------+------+------+-------+-------+------+
1197 0 4 8 12 16 20 24 28 32
1199 so what happens if you allocate memory for this structure:
1201 +------+------+------+------+------+-------+-------+------+------+...
1202 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1203 +------+------+------+------+------+-------+-------+------+------+...
1204 0 4 8 12 16 20 24 28 32 36
1206 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1207 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1208 started out as zero once, but it's quite possible that it isn't. So now,
1209 rather than a nicely zeroed GP, you have it pointing somewhere random.
1212 (In fact, GP ends up pointing at a previous GP structure, because the
1213 principle cause of the padding in XPVMG getting garbage is a copy of
1214 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1216 So we are careful and work out the size of used parts of all the
1223 if (new_type < SVt_PVIV) {
1224 new_type = (new_type == SVt_NV)
1225 ? SVt_PVNV : SVt_PVIV;
1229 if (new_type < SVt_PVNV) {
1230 new_type = SVt_PVNV;
1236 assert(new_type > SVt_PV);
1237 assert(SVt_IV < SVt_PV);
1238 assert(SVt_NV < SVt_PV);
1245 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1246 there's no way that it can be safely upgraded, because perl.c
1247 expects to Safefree(SvANY(PL_mess_sv)) */
1248 assert(sv != PL_mess_sv);
1249 /* This flag bit is used to mean other things in other scalar types.
1250 Given that it only has meaning inside the pad, it shouldn't be set
1251 on anything that can get upgraded. */
1252 assert(!SvPAD_TYPED(sv));
1255 if (old_type_details->cant_upgrade)
1256 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1257 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1259 new_type_details = bodies_by_type + new_type;
1261 SvFLAGS(sv) &= ~SVTYPEMASK;
1262 SvFLAGS(sv) |= new_type;
1264 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1265 the return statements above will have triggered. */
1266 assert (new_type != SVt_NULL);
1269 assert(old_type == SVt_NULL);
1270 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1274 assert(old_type == SVt_NULL);
1275 SvANY(sv) = new_XNV();
1279 assert(old_type == SVt_NULL);
1280 SvANY(sv) = &sv->sv_u.svu_rv;
1285 assert(new_type_details->body_size);
1288 assert(new_type_details->arena);
1289 assert(new_type_details->arena_size);
1290 /* This points to the start of the allocated area. */
1291 new_body_inline(new_body, new_type);
1292 Zero(new_body, new_type_details->body_size, char);
1293 new_body = ((char *)new_body) - new_type_details->offset;
1295 /* We always allocated the full length item with PURIFY. To do this
1296 we fake things so that arena is false for all 16 types.. */
1297 new_body = new_NOARENAZ(new_type_details);
1299 SvANY(sv) = new_body;
1300 if (new_type == SVt_PVAV) {
1306 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1307 The target created by newSVrv also is, and it can have magic.
1308 However, it never has SvPVX set.
1310 if (old_type >= SVt_RV) {
1311 assert(SvPVX_const(sv) == 0);
1314 /* Could put this in the else clause below, as PVMG must have SvPVX
1315 0 already (the assertion above) */
1318 if (old_type >= SVt_PVMG) {
1319 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1320 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1326 /* XXX Is this still needed? Was it ever needed? Surely as there is
1327 no route from NV to PVIV, NOK can never be true */
1328 assert(!SvNOKp(sv));
1340 assert(new_type_details->body_size);
1341 /* We always allocated the full length item with PURIFY. To do this
1342 we fake things so that arena is false for all 16 types.. */
1343 if(new_type_details->arena) {
1344 /* This points to the start of the allocated area. */
1345 new_body_inline(new_body, new_type);
1346 Zero(new_body, new_type_details->body_size, char);
1347 new_body = ((char *)new_body) - new_type_details->offset;
1349 new_body = new_NOARENAZ(new_type_details);
1351 SvANY(sv) = new_body;
1353 if (old_type_details->copy) {
1354 /* There is now the potential for an upgrade from something without
1355 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1356 int offset = old_type_details->offset;
1357 int length = old_type_details->copy;
1359 if (new_type_details->offset > old_type_details->offset) {
1361 = new_type_details->offset - old_type_details->offset;
1362 offset += difference;
1363 length -= difference;
1365 assert (length >= 0);
1367 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1371 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1372 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1373 * correct 0.0 for us. Otherwise, if the old body didn't have an
1374 * NV slot, but the new one does, then we need to initialise the
1375 * freshly created NV slot with whatever the correct bit pattern is
1377 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1381 if (new_type == SVt_PVIO)
1382 IoPAGE_LEN(sv) = 60;
1383 if (old_type < SVt_RV)
1387 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1388 (unsigned long)new_type);
1391 if (old_type_details->arena) {
1392 /* If there was an old body, then we need to free it.
1393 Note that there is an assumption that all bodies of types that
1394 can be upgraded came from arenas. Only the more complex non-
1395 upgradable types are allowed to be directly malloc()ed. */
1397 my_safefree(old_body);
1399 del_body((void*)((char*)old_body + old_type_details->offset),
1400 &PL_body_roots[old_type]);
1406 =for apidoc sv_backoff
1408 Remove any string offset. You should normally use the C<SvOOK_off> macro
1415 Perl_sv_backoff(pTHX_ register SV *sv)
1417 PERL_UNUSED_CONTEXT;
1419 assert(SvTYPE(sv) != SVt_PVHV);
1420 assert(SvTYPE(sv) != SVt_PVAV);
1422 const char * const s = SvPVX_const(sv);
1423 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1424 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1426 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1428 SvFLAGS(sv) &= ~SVf_OOK;
1435 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1436 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1437 Use the C<SvGROW> wrapper instead.
1443 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1447 #ifdef HAS_64K_LIMIT
1448 if (newlen >= 0x10000) {
1449 PerlIO_printf(Perl_debug_log,
1450 "Allocation too large: %"UVxf"\n", (UV)newlen);
1453 #endif /* HAS_64K_LIMIT */
1456 if (SvTYPE(sv) < SVt_PV) {
1457 sv_upgrade(sv, SVt_PV);
1458 s = SvPVX_mutable(sv);
1460 else if (SvOOK(sv)) { /* pv is offset? */
1462 s = SvPVX_mutable(sv);
1463 if (newlen > SvLEN(sv))
1464 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1465 #ifdef HAS_64K_LIMIT
1466 if (newlen >= 0x10000)
1471 s = SvPVX_mutable(sv);
1473 if (newlen > SvLEN(sv)) { /* need more room? */
1474 newlen = PERL_STRLEN_ROUNDUP(newlen);
1475 if (SvLEN(sv) && s) {
1477 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1483 s = saferealloc(s, newlen);
1486 s = safemalloc(newlen);
1487 if (SvPVX_const(sv) && SvCUR(sv)) {
1488 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1492 SvLEN_set(sv, newlen);
1498 =for apidoc sv_setiv
1500 Copies an integer into the given SV, upgrading first if necessary.
1501 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1507 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1510 SV_CHECK_THINKFIRST_COW_DROP(sv);
1511 switch (SvTYPE(sv)) {
1513 sv_upgrade(sv, SVt_IV);
1516 sv_upgrade(sv, SVt_PVNV);
1520 sv_upgrade(sv, SVt_PVIV);
1529 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1532 (void)SvIOK_only(sv); /* validate number */
1538 =for apidoc sv_setiv_mg
1540 Like C<sv_setiv>, but also handles 'set' magic.
1546 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1553 =for apidoc sv_setuv
1555 Copies an unsigned integer into the given SV, upgrading first if necessary.
1556 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1562 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1564 /* With these two if statements:
1565 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1568 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1570 If you wish to remove them, please benchmark to see what the effect is
1572 if (u <= (UV)IV_MAX) {
1573 sv_setiv(sv, (IV)u);
1582 =for apidoc sv_setuv_mg
1584 Like C<sv_setuv>, but also handles 'set' magic.
1590 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1599 =for apidoc sv_setnv
1601 Copies a double into the given SV, upgrading first if necessary.
1602 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1608 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1611 SV_CHECK_THINKFIRST_COW_DROP(sv);
1612 switch (SvTYPE(sv)) {
1615 sv_upgrade(sv, SVt_NV);
1620 sv_upgrade(sv, SVt_PVNV);
1629 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1633 (void)SvNOK_only(sv); /* validate number */
1638 =for apidoc sv_setnv_mg
1640 Like C<sv_setnv>, but also handles 'set' magic.
1646 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1652 /* Print an "isn't numeric" warning, using a cleaned-up,
1653 * printable version of the offending string
1657 S_not_a_number(pTHX_ SV *sv)
1665 dsv = sv_2mortal(newSVpvs(""));
1666 pv = sv_uni_display(dsv, sv, 10, 0);
1669 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1670 /* each *s can expand to 4 chars + "...\0",
1671 i.e. need room for 8 chars */
1673 const char *s = SvPVX_const(sv);
1674 const char * const end = s + SvCUR(sv);
1675 for ( ; s < end && d < limit; s++ ) {
1677 if (ch & 128 && !isPRINT_LC(ch)) {
1686 else if (ch == '\r') {
1690 else if (ch == '\f') {
1694 else if (ch == '\\') {
1698 else if (ch == '\0') {
1702 else if (isPRINT_LC(ch))
1719 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1720 "Argument \"%s\" isn't numeric in %s", pv,
1723 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1724 "Argument \"%s\" isn't numeric", pv);
1728 =for apidoc looks_like_number
1730 Test if the content of an SV looks like a number (or is a number).
1731 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1732 non-numeric warning), even if your atof() doesn't grok them.
1738 Perl_looks_like_number(pTHX_ SV *sv)
1740 register const char *sbegin;
1744 sbegin = SvPVX_const(sv);
1747 else if (SvPOKp(sv))
1748 sbegin = SvPV_const(sv, len);
1750 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1751 return grok_number(sbegin, len, NULL);
1755 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1757 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1758 SV *const buffer = sv_newmortal();
1760 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1763 gv_efullname3(buffer, gv, "*");
1764 SvFLAGS(gv) |= wasfake;
1767 /* We know that all GVs stringify to something that is not-a-number,
1768 so no need to test that. */
1769 if (ckWARN(WARN_NUMERIC))
1770 not_a_number(buffer);
1771 /* We just want something true to return, so that S_sv_2iuv_common
1772 can tail call us and return true. */
1775 return SvPV(buffer, *len);
1779 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1780 until proven guilty, assume that things are not that bad... */
1785 As 64 bit platforms often have an NV that doesn't preserve all bits of
1786 an IV (an assumption perl has been based on to date) it becomes necessary
1787 to remove the assumption that the NV always carries enough precision to
1788 recreate the IV whenever needed, and that the NV is the canonical form.
1789 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1790 precision as a side effect of conversion (which would lead to insanity
1791 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1792 1) to distinguish between IV/UV/NV slots that have cached a valid
1793 conversion where precision was lost and IV/UV/NV slots that have a
1794 valid conversion which has lost no precision
1795 2) to ensure that if a numeric conversion to one form is requested that
1796 would lose precision, the precise conversion (or differently
1797 imprecise conversion) is also performed and cached, to prevent
1798 requests for different numeric formats on the same SV causing
1799 lossy conversion chains. (lossless conversion chains are perfectly
1804 SvIOKp is true if the IV slot contains a valid value
1805 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1806 SvNOKp is true if the NV slot contains a valid value
1807 SvNOK is true only if the NV value is accurate
1810 while converting from PV to NV, check to see if converting that NV to an
1811 IV(or UV) would lose accuracy over a direct conversion from PV to
1812 IV(or UV). If it would, cache both conversions, return NV, but mark
1813 SV as IOK NOKp (ie not NOK).
1815 While converting from PV to IV, check to see if converting that IV to an
1816 NV would lose accuracy over a direct conversion from PV to NV. If it
1817 would, cache both conversions, flag similarly.
1819 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1820 correctly because if IV & NV were set NV *always* overruled.
1821 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1822 changes - now IV and NV together means that the two are interchangeable:
1823 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1825 The benefit of this is that operations such as pp_add know that if
1826 SvIOK is true for both left and right operands, then integer addition
1827 can be used instead of floating point (for cases where the result won't
1828 overflow). Before, floating point was always used, which could lead to
1829 loss of precision compared with integer addition.
1831 * making IV and NV equal status should make maths accurate on 64 bit
1833 * may speed up maths somewhat if pp_add and friends start to use
1834 integers when possible instead of fp. (Hopefully the overhead in
1835 looking for SvIOK and checking for overflow will not outweigh the
1836 fp to integer speedup)
1837 * will slow down integer operations (callers of SvIV) on "inaccurate"
1838 values, as the change from SvIOK to SvIOKp will cause a call into
1839 sv_2iv each time rather than a macro access direct to the IV slot
1840 * should speed up number->string conversion on integers as IV is
1841 favoured when IV and NV are equally accurate
1843 ####################################################################
1844 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1845 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1846 On the other hand, SvUOK is true iff UV.
1847 ####################################################################
1849 Your mileage will vary depending your CPU's relative fp to integer
1853 #ifndef NV_PRESERVES_UV
1854 # define IS_NUMBER_UNDERFLOW_IV 1
1855 # define IS_NUMBER_UNDERFLOW_UV 2
1856 # define IS_NUMBER_IV_AND_UV 2
1857 # define IS_NUMBER_OVERFLOW_IV 4
1858 # define IS_NUMBER_OVERFLOW_UV 5
1860 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1862 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1864 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1867 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));
1868 if (SvNVX(sv) < (NV)IV_MIN) {
1869 (void)SvIOKp_on(sv);
1871 SvIV_set(sv, IV_MIN);
1872 return IS_NUMBER_UNDERFLOW_IV;
1874 if (SvNVX(sv) > (NV)UV_MAX) {
1875 (void)SvIOKp_on(sv);
1878 SvUV_set(sv, UV_MAX);
1879 return IS_NUMBER_OVERFLOW_UV;
1881 (void)SvIOKp_on(sv);
1883 /* Can't use strtol etc to convert this string. (See truth table in
1885 if (SvNVX(sv) <= (UV)IV_MAX) {
1886 SvIV_set(sv, I_V(SvNVX(sv)));
1887 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1888 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1890 /* Integer is imprecise. NOK, IOKp */
1892 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1895 SvUV_set(sv, U_V(SvNVX(sv)));
1896 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1897 if (SvUVX(sv) == UV_MAX) {
1898 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1899 possibly be preserved by NV. Hence, it must be overflow.
1901 return IS_NUMBER_OVERFLOW_UV;
1903 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1905 /* Integer is imprecise. NOK, IOKp */
1907 return IS_NUMBER_OVERFLOW_IV;
1909 #endif /* !NV_PRESERVES_UV*/
1912 S_sv_2iuv_common(pTHX_ SV *sv) {
1915 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1916 * without also getting a cached IV/UV from it at the same time
1917 * (ie PV->NV conversion should detect loss of accuracy and cache
1918 * IV or UV at same time to avoid this. */
1919 /* IV-over-UV optimisation - choose to cache IV if possible */
1921 if (SvTYPE(sv) == SVt_NV)
1922 sv_upgrade(sv, SVt_PVNV);
1924 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1925 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1926 certainly cast into the IV range at IV_MAX, whereas the correct
1927 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1929 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1930 SvIV_set(sv, I_V(SvNVX(sv)));
1931 if (SvNVX(sv) == (NV) SvIVX(sv)
1932 #ifndef NV_PRESERVES_UV
1933 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1934 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1935 /* Don't flag it as "accurately an integer" if the number
1936 came from a (by definition imprecise) NV operation, and
1937 we're outside the range of NV integer precision */
1940 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1941 DEBUG_c(PerlIO_printf(Perl_debug_log,
1942 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1948 /* IV not precise. No need to convert from PV, as NV
1949 conversion would already have cached IV if it detected
1950 that PV->IV would be better than PV->NV->IV
1951 flags already correct - don't set public IOK. */
1952 DEBUG_c(PerlIO_printf(Perl_debug_log,
1953 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1958 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1959 but the cast (NV)IV_MIN rounds to a the value less (more
1960 negative) than IV_MIN which happens to be equal to SvNVX ??
1961 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1962 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1963 (NV)UVX == NVX are both true, but the values differ. :-(
1964 Hopefully for 2s complement IV_MIN is something like
1965 0x8000000000000000 which will be exact. NWC */
1968 SvUV_set(sv, U_V(SvNVX(sv)));
1970 (SvNVX(sv) == (NV) SvUVX(sv))
1971 #ifndef NV_PRESERVES_UV
1972 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1973 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1974 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1975 /* Don't flag it as "accurately an integer" if the number
1976 came from a (by definition imprecise) NV operation, and
1977 we're outside the range of NV integer precision */
1982 DEBUG_c(PerlIO_printf(Perl_debug_log,
1983 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1989 else if (SvPOKp(sv) && SvLEN(sv)) {
1991 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1992 /* We want to avoid a possible problem when we cache an IV/ a UV which
1993 may be later translated to an NV, and the resulting NV is not
1994 the same as the direct translation of the initial string
1995 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1996 be careful to ensure that the value with the .456 is around if the
1997 NV value is requested in the future).
1999 This means that if we cache such an IV/a UV, we need to cache the
2000 NV as well. Moreover, we trade speed for space, and do not
2001 cache the NV if we are sure it's not needed.
2004 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2005 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2006 == IS_NUMBER_IN_UV) {
2007 /* It's definitely an integer, only upgrade to PVIV */
2008 if (SvTYPE(sv) < SVt_PVIV)
2009 sv_upgrade(sv, SVt_PVIV);
2011 } else if (SvTYPE(sv) < SVt_PVNV)
2012 sv_upgrade(sv, SVt_PVNV);
2014 /* If NVs preserve UVs then we only use the UV value if we know that
2015 we aren't going to call atof() below. If NVs don't preserve UVs
2016 then the value returned may have more precision than atof() will
2017 return, even though value isn't perfectly accurate. */
2018 if ((numtype & (IS_NUMBER_IN_UV
2019 #ifdef NV_PRESERVES_UV
2022 )) == IS_NUMBER_IN_UV) {
2023 /* This won't turn off the public IOK flag if it was set above */
2024 (void)SvIOKp_on(sv);
2026 if (!(numtype & IS_NUMBER_NEG)) {
2028 if (value <= (UV)IV_MAX) {
2029 SvIV_set(sv, (IV)value);
2031 /* it didn't overflow, and it was positive. */
2032 SvUV_set(sv, value);
2036 /* 2s complement assumption */
2037 if (value <= (UV)IV_MIN) {
2038 SvIV_set(sv, -(IV)value);
2040 /* Too negative for an IV. This is a double upgrade, but
2041 I'm assuming it will be rare. */
2042 if (SvTYPE(sv) < SVt_PVNV)
2043 sv_upgrade(sv, SVt_PVNV);
2047 SvNV_set(sv, -(NV)value);
2048 SvIV_set(sv, IV_MIN);
2052 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2053 will be in the previous block to set the IV slot, and the next
2054 block to set the NV slot. So no else here. */
2056 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2057 != IS_NUMBER_IN_UV) {
2058 /* It wasn't an (integer that doesn't overflow the UV). */
2059 SvNV_set(sv, Atof(SvPVX_const(sv)));
2061 if (! numtype && ckWARN(WARN_NUMERIC))
2064 #if defined(USE_LONG_DOUBLE)
2065 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2066 PTR2UV(sv), SvNVX(sv)));
2068 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2069 PTR2UV(sv), SvNVX(sv)));
2072 #ifdef NV_PRESERVES_UV
2073 (void)SvIOKp_on(sv);
2075 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2076 SvIV_set(sv, I_V(SvNVX(sv)));
2077 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2080 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2082 /* UV will not work better than IV */
2084 if (SvNVX(sv) > (NV)UV_MAX) {
2086 /* Integer is inaccurate. NOK, IOKp, is UV */
2087 SvUV_set(sv, UV_MAX);
2089 SvUV_set(sv, U_V(SvNVX(sv)));
2090 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2091 NV preservse UV so can do correct comparison. */
2092 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2095 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2100 #else /* NV_PRESERVES_UV */
2101 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2102 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2103 /* The IV/UV slot will have been set from value returned by
2104 grok_number above. The NV slot has just been set using
2107 assert (SvIOKp(sv));
2109 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2110 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2111 /* Small enough to preserve all bits. */
2112 (void)SvIOKp_on(sv);
2114 SvIV_set(sv, I_V(SvNVX(sv)));
2115 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2117 /* Assumption: first non-preserved integer is < IV_MAX,
2118 this NV is in the preserved range, therefore: */
2119 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2121 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);
2125 0 0 already failed to read UV.
2126 0 1 already failed to read UV.
2127 1 0 you won't get here in this case. IV/UV
2128 slot set, public IOK, Atof() unneeded.
2129 1 1 already read UV.
2130 so there's no point in sv_2iuv_non_preserve() attempting
2131 to use atol, strtol, strtoul etc. */
2132 sv_2iuv_non_preserve (sv, numtype);
2135 #endif /* NV_PRESERVES_UV */
2139 if (isGV_with_GP(sv)) {
2140 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2143 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2144 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2147 if (SvTYPE(sv) < SVt_IV)
2148 /* Typically the caller expects that sv_any is not NULL now. */
2149 sv_upgrade(sv, SVt_IV);
2150 /* Return 0 from the caller. */
2157 =for apidoc sv_2iv_flags
2159 Return the integer value of an SV, doing any necessary string
2160 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2161 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2167 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2172 if (SvGMAGICAL(sv)) {
2173 if (flags & SV_GMAGIC)
2178 return I_V(SvNVX(sv));
2180 if (SvPOKp(sv) && SvLEN(sv)) {
2183 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2185 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2186 == IS_NUMBER_IN_UV) {
2187 /* It's definitely an integer */
2188 if (numtype & IS_NUMBER_NEG) {
2189 if (value < (UV)IV_MIN)
2192 if (value < (UV)IV_MAX)
2197 if (ckWARN(WARN_NUMERIC))
2200 return I_V(Atof(SvPVX_const(sv)));
2205 assert(SvTYPE(sv) >= SVt_PVMG);
2206 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2207 } else if (SvTHINKFIRST(sv)) {
2211 SV * const tmpstr=AMG_CALLun(sv,numer);
2212 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2213 return SvIV(tmpstr);
2216 return PTR2IV(SvRV(sv));
2219 sv_force_normal_flags(sv, 0);
2221 if (SvREADONLY(sv) && !SvOK(sv)) {
2222 if (ckWARN(WARN_UNINITIALIZED))
2228 if (S_sv_2iuv_common(aTHX_ sv))
2231 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2232 PTR2UV(sv),SvIVX(sv)));
2233 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2237 =for apidoc sv_2uv_flags
2239 Return the unsigned integer value of an SV, doing any necessary string
2240 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2241 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2247 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2252 if (SvGMAGICAL(sv)) {
2253 if (flags & SV_GMAGIC)
2258 return U_V(SvNVX(sv));
2259 if (SvPOKp(sv) && SvLEN(sv)) {
2262 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2264 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2265 == IS_NUMBER_IN_UV) {
2266 /* It's definitely an integer */
2267 if (!(numtype & IS_NUMBER_NEG))
2271 if (ckWARN(WARN_NUMERIC))
2274 return U_V(Atof(SvPVX_const(sv)));
2279 assert(SvTYPE(sv) >= SVt_PVMG);
2280 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2281 } else if (SvTHINKFIRST(sv)) {
2285 SV *const tmpstr = AMG_CALLun(sv,numer);
2286 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2287 return SvUV(tmpstr);
2290 return PTR2UV(SvRV(sv));
2293 sv_force_normal_flags(sv, 0);
2295 if (SvREADONLY(sv) && !SvOK(sv)) {
2296 if (ckWARN(WARN_UNINITIALIZED))
2302 if (S_sv_2iuv_common(aTHX_ sv))
2306 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2307 PTR2UV(sv),SvUVX(sv)));
2308 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2314 Return the num value of an SV, doing any necessary string or integer
2315 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2322 Perl_sv_2nv(pTHX_ register SV *sv)
2327 if (SvGMAGICAL(sv)) {
2331 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2332 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2333 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2335 return Atof(SvPVX_const(sv));
2339 return (NV)SvUVX(sv);
2341 return (NV)SvIVX(sv);
2346 assert(SvTYPE(sv) >= SVt_PVMG);
2347 /* This falls through to the report_uninit near the end of the
2349 } else if (SvTHINKFIRST(sv)) {
2353 SV *const tmpstr = AMG_CALLun(sv,numer);
2354 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2355 return SvNV(tmpstr);
2358 return PTR2NV(SvRV(sv));
2361 sv_force_normal_flags(sv, 0);
2363 if (SvREADONLY(sv) && !SvOK(sv)) {
2364 if (ckWARN(WARN_UNINITIALIZED))
2369 if (SvTYPE(sv) < SVt_NV) {
2370 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2371 sv_upgrade(sv, SVt_NV);
2372 #ifdef USE_LONG_DOUBLE
2374 STORE_NUMERIC_LOCAL_SET_STANDARD();
2375 PerlIO_printf(Perl_debug_log,
2376 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2377 PTR2UV(sv), SvNVX(sv));
2378 RESTORE_NUMERIC_LOCAL();
2382 STORE_NUMERIC_LOCAL_SET_STANDARD();
2383 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2384 PTR2UV(sv), SvNVX(sv));
2385 RESTORE_NUMERIC_LOCAL();
2389 else if (SvTYPE(sv) < SVt_PVNV)
2390 sv_upgrade(sv, SVt_PVNV);
2395 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2396 #ifdef NV_PRESERVES_UV
2399 /* Only set the public NV OK flag if this NV preserves the IV */
2400 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2401 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2402 : (SvIVX(sv) == I_V(SvNVX(sv))))
2408 else if (SvPOKp(sv) && SvLEN(sv)) {
2410 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2411 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2413 #ifdef NV_PRESERVES_UV
2414 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2415 == IS_NUMBER_IN_UV) {
2416 /* It's definitely an integer */
2417 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2419 SvNV_set(sv, Atof(SvPVX_const(sv)));
2422 SvNV_set(sv, Atof(SvPVX_const(sv)));
2423 /* Only set the public NV OK flag if this NV preserves the value in
2424 the PV at least as well as an IV/UV would.
2425 Not sure how to do this 100% reliably. */
2426 /* if that shift count is out of range then Configure's test is
2427 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2429 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2430 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2431 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2432 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2433 /* Can't use strtol etc to convert this string, so don't try.
2434 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2437 /* value has been set. It may not be precise. */
2438 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2439 /* 2s complement assumption for (UV)IV_MIN */
2440 SvNOK_on(sv); /* Integer is too negative. */
2445 if (numtype & IS_NUMBER_NEG) {
2446 SvIV_set(sv, -(IV)value);
2447 } else if (value <= (UV)IV_MAX) {
2448 SvIV_set(sv, (IV)value);
2450 SvUV_set(sv, value);
2454 if (numtype & IS_NUMBER_NOT_INT) {
2455 /* I believe that even if the original PV had decimals,
2456 they are lost beyond the limit of the FP precision.
2457 However, neither is canonical, so both only get p
2458 flags. NWC, 2000/11/25 */
2459 /* Both already have p flags, so do nothing */
2461 const NV nv = SvNVX(sv);
2462 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2463 if (SvIVX(sv) == I_V(nv)) {
2466 /* It had no "." so it must be integer. */
2470 /* between IV_MAX and NV(UV_MAX).
2471 Could be slightly > UV_MAX */
2473 if (numtype & IS_NUMBER_NOT_INT) {
2474 /* UV and NV both imprecise. */
2476 const UV nv_as_uv = U_V(nv);
2478 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2487 #endif /* NV_PRESERVES_UV */
2490 if (isGV_with_GP(sv)) {
2491 glob_2inpuv((GV *)sv, NULL, TRUE);
2495 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2497 assert (SvTYPE(sv) >= SVt_NV);
2498 /* Typically the caller expects that sv_any is not NULL now. */
2499 /* XXX Ilya implies that this is a bug in callers that assume this
2500 and ideally should be fixed. */
2503 #if defined(USE_LONG_DOUBLE)
2505 STORE_NUMERIC_LOCAL_SET_STANDARD();
2506 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2507 PTR2UV(sv), SvNVX(sv));
2508 RESTORE_NUMERIC_LOCAL();
2512 STORE_NUMERIC_LOCAL_SET_STANDARD();
2513 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2514 PTR2UV(sv), SvNVX(sv));
2515 RESTORE_NUMERIC_LOCAL();
2521 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2522 * UV as a string towards the end of buf, and return pointers to start and
2525 * We assume that buf is at least TYPE_CHARS(UV) long.
2529 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2531 char *ptr = buf + TYPE_CHARS(UV);
2532 char * const ebuf = ptr;
2545 *--ptr = '0' + (char)(uv % 10);
2553 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2554 * a regexp to its stringified form.
2558 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2560 const regexp * const re = (regexp *)mg->mg_obj;
2563 const char *fptr = "msix";
2568 bool need_newline = 0;
2569 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2571 while((ch = *fptr++)) {
2573 reflags[left++] = ch;
2576 reflags[right--] = ch;
2581 reflags[left] = '-';
2585 mg->mg_len = re->prelen + 4 + left;
2587 * If /x was used, we have to worry about a regex ending with a
2588 * comment later being embedded within another regex. If so, we don't
2589 * want this regex's "commentization" to leak out to the right part of
2590 * the enclosing regex, we must cap it with a newline.
2592 * So, if /x was used, we scan backwards from the end of the regex. If
2593 * we find a '#' before we find a newline, we need to add a newline
2594 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2595 * we don't need to add anything. -jfriedl
2597 if (PMf_EXTENDED & re->reganch) {
2598 const char *endptr = re->precomp + re->prelen;
2599 while (endptr >= re->precomp) {
2600 const char c = *(endptr--);
2602 break; /* don't need another */
2604 /* we end while in a comment, so we need a newline */
2605 mg->mg_len++; /* save space for it */
2606 need_newline = 1; /* note to add it */
2612 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2613 mg->mg_ptr[0] = '(';
2614 mg->mg_ptr[1] = '?';
2615 Copy(reflags, mg->mg_ptr+2, left, char);
2616 *(mg->mg_ptr+left+2) = ':';
2617 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2619 mg->mg_ptr[mg->mg_len - 2] = '\n';
2620 mg->mg_ptr[mg->mg_len - 1] = ')';
2621 mg->mg_ptr[mg->mg_len] = 0;
2623 PL_reginterp_cnt += re->program[0].next_off;
2625 if (re->reganch & ROPT_UTF8)
2635 =for apidoc sv_2pv_flags
2637 Returns a pointer to the string value of an SV, and sets *lp to its length.
2638 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2640 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2641 usually end up here too.
2647 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2657 if (SvGMAGICAL(sv)) {
2658 if (flags & SV_GMAGIC)
2663 if (flags & SV_MUTABLE_RETURN)
2664 return SvPVX_mutable(sv);
2665 if (flags & SV_CONST_RETURN)
2666 return (char *)SvPVX_const(sv);
2669 if (SvIOKp(sv) || SvNOKp(sv)) {
2670 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2674 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2675 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2677 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2684 #ifdef FIXNEGATIVEZERO
2685 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2691 SvUPGRADE(sv, SVt_PV);
2694 s = SvGROW_mutable(sv, len + 1);
2697 return memcpy(s, tbuf, len + 1);
2703 assert(SvTYPE(sv) >= SVt_PVMG);
2704 /* This falls through to the report_uninit near the end of the
2706 } else if (SvTHINKFIRST(sv)) {
2710 SV *const tmpstr = AMG_CALLun(sv,string);
2711 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2713 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2717 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2718 if (flags & SV_CONST_RETURN) {
2719 pv = (char *) SvPVX_const(tmpstr);
2721 pv = (flags & SV_MUTABLE_RETURN)
2722 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2725 *lp = SvCUR(tmpstr);
2727 pv = sv_2pv_flags(tmpstr, lp, flags);
2739 const SV *const referent = (SV*)SvRV(sv);
2742 tsv = sv_2mortal(newSVpvs("NULLREF"));
2743 } else if (SvTYPE(referent) == SVt_PVMG
2744 && ((SvFLAGS(referent) &
2745 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2746 == (SVs_OBJECT|SVs_SMG))
2747 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2748 return stringify_regexp(sv, mg, lp);
2750 const char *const typestr = sv_reftype(referent, 0);
2752 tsv = sv_newmortal();
2753 if (SvOBJECT(referent)) {
2754 const char *const name = HvNAME_get(SvSTASH(referent));
2755 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2756 name ? name : "__ANON__" , typestr,
2760 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2768 if (SvREADONLY(sv) && !SvOK(sv)) {
2769 if (ckWARN(WARN_UNINITIALIZED))
2776 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2777 /* I'm assuming that if both IV and NV are equally valid then
2778 converting the IV is going to be more efficient */
2779 const U32 isIOK = SvIOK(sv);
2780 const U32 isUIOK = SvIsUV(sv);
2781 char buf[TYPE_CHARS(UV)];
2784 if (SvTYPE(sv) < SVt_PVIV)
2785 sv_upgrade(sv, SVt_PVIV);
2786 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2787 /* inlined from sv_setpvn */
2788 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2789 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2790 SvCUR_set(sv, ebuf - ptr);
2800 else if (SvNOKp(sv)) {
2801 const int olderrno = errno;
2802 if (SvTYPE(sv) < SVt_PVNV)
2803 sv_upgrade(sv, SVt_PVNV);
2804 /* The +20 is pure guesswork. Configure test needed. --jhi */
2805 s = SvGROW_mutable(sv, NV_DIG + 20);
2806 /* some Xenix systems wipe out errno here */
2808 if (SvNVX(sv) == 0.0)
2809 (void)strcpy(s,"0");
2813 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2816 #ifdef FIXNEGATIVEZERO
2817 if (*s == '-' && s[1] == '0' && !s[2])
2827 if (isGV_with_GP(sv)) {
2828 return glob_2inpuv((GV *)sv, lp, FALSE);
2831 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2835 if (SvTYPE(sv) < SVt_PV)
2836 /* Typically the caller expects that sv_any is not NULL now. */
2837 sv_upgrade(sv, SVt_PV);
2841 const STRLEN len = s - SvPVX_const(sv);
2847 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2848 PTR2UV(sv),SvPVX_const(sv)));
2849 if (flags & SV_CONST_RETURN)
2850 return (char *)SvPVX_const(sv);
2851 if (flags & SV_MUTABLE_RETURN)
2852 return SvPVX_mutable(sv);
2857 =for apidoc sv_copypv
2859 Copies a stringified representation of the source SV into the
2860 destination SV. Automatically performs any necessary mg_get and
2861 coercion of numeric values into strings. Guaranteed to preserve
2862 UTF-8 flag even from overloaded objects. Similar in nature to
2863 sv_2pv[_flags] but operates directly on an SV instead of just the
2864 string. Mostly uses sv_2pv_flags to do its work, except when that
2865 would lose the UTF-8'ness of the PV.
2871 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2874 const char * const s = SvPV_const(ssv,len);
2875 sv_setpvn(dsv,s,len);
2883 =for apidoc sv_2pvbyte
2885 Return a pointer to the byte-encoded representation of the SV, and set *lp
2886 to its length. May cause the SV to be downgraded from UTF-8 as a
2889 Usually accessed via the C<SvPVbyte> macro.
2895 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2897 sv_utf8_downgrade(sv,0);
2898 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2902 =for apidoc sv_2pvutf8
2904 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2905 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2907 Usually accessed via the C<SvPVutf8> macro.
2913 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2915 sv_utf8_upgrade(sv);
2916 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2921 =for apidoc sv_2bool
2923 This function is only called on magical items, and is only used by
2924 sv_true() or its macro equivalent.
2930 Perl_sv_2bool(pTHX_ register SV *sv)
2939 SV * const tmpsv = AMG_CALLun(sv,bool_);
2940 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2941 return (bool)SvTRUE(tmpsv);
2943 return SvRV(sv) != 0;
2946 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2948 (*sv->sv_u.svu_pv > '0' ||
2949 Xpvtmp->xpv_cur > 1 ||
2950 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2957 return SvIVX(sv) != 0;
2960 return SvNVX(sv) != 0.0;
2962 if (isGV_with_GP(sv))
2972 =for apidoc sv_utf8_upgrade
2974 Converts the PV of an SV to its UTF-8-encoded form.
2975 Forces the SV to string form if it is not already.
2976 Always sets the SvUTF8 flag to avoid future validity checks even
2977 if all the bytes have hibit clear.
2979 This is not as a general purpose byte encoding to Unicode interface:
2980 use the Encode extension for that.
2982 =for apidoc sv_utf8_upgrade_flags
2984 Converts the PV of an SV to its UTF-8-encoded form.
2985 Forces the SV to string form if it is not already.
2986 Always sets the SvUTF8 flag to avoid future validity checks even
2987 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2988 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2989 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2991 This is not as a general purpose byte encoding to Unicode interface:
2992 use the Encode extension for that.
2998 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3001 if (sv == &PL_sv_undef)
3005 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3006 (void) sv_2pv_flags(sv,&len, flags);
3010 (void) SvPV_force(sv,len);
3019 sv_force_normal_flags(sv, 0);
3022 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3023 sv_recode_to_utf8(sv, PL_encoding);
3024 else { /* Assume Latin-1/EBCDIC */
3025 /* This function could be much more efficient if we
3026 * had a FLAG in SVs to signal if there are any hibit
3027 * chars in the PV. Given that there isn't such a flag
3028 * make the loop as fast as possible. */
3029 const U8 * const s = (U8 *) SvPVX_const(sv);
3030 const U8 * const e = (U8 *) SvEND(sv);
3035 /* Check for hi bit */
3036 if (!NATIVE_IS_INVARIANT(ch)) {
3037 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3038 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3040 SvPV_free(sv); /* No longer using what was there before. */
3041 SvPV_set(sv, (char*)recoded);
3042 SvCUR_set(sv, len - 1);
3043 SvLEN_set(sv, len); /* No longer know the real size. */
3047 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3054 =for apidoc sv_utf8_downgrade
3056 Attempts to convert the PV of an SV from characters to bytes.
3057 If the PV contains a character beyond byte, this conversion will fail;
3058 in this case, either returns false or, if C<fail_ok> is not
3061 This is not as a general purpose Unicode to byte encoding interface:
3062 use the Encode extension for that.
3068 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3071 if (SvPOKp(sv) && SvUTF8(sv)) {
3077 sv_force_normal_flags(sv, 0);
3079 s = (U8 *) SvPV(sv, len);
3080 if (!utf8_to_bytes(s, &len)) {
3085 Perl_croak(aTHX_ "Wide character in %s",
3088 Perl_croak(aTHX_ "Wide character");
3099 =for apidoc sv_utf8_encode
3101 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3102 flag off so that it looks like octets again.
3108 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3110 (void) sv_utf8_upgrade(sv);
3112 sv_force_normal_flags(sv, 0);
3114 if (SvREADONLY(sv)) {
3115 Perl_croak(aTHX_ PL_no_modify);
3121 =for apidoc sv_utf8_decode
3123 If the PV of the SV is an octet sequence in UTF-8
3124 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3125 so that it looks like a character. If the PV contains only single-byte
3126 characters, the C<SvUTF8> flag stays being off.
3127 Scans PV for validity and returns false if the PV is invalid UTF-8.
3133 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3139 /* The octets may have got themselves encoded - get them back as
3142 if (!sv_utf8_downgrade(sv, TRUE))
3145 /* it is actually just a matter of turning the utf8 flag on, but
3146 * we want to make sure everything inside is valid utf8 first.
3148 c = (const U8 *) SvPVX_const(sv);
3149 if (!is_utf8_string(c, SvCUR(sv)+1))
3151 e = (const U8 *) SvEND(sv);
3154 if (!UTF8_IS_INVARIANT(ch)) {
3164 =for apidoc sv_setsv
3166 Copies the contents of the source SV C<ssv> into the destination SV
3167 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3168 function if the source SV needs to be reused. Does not handle 'set' magic.
3169 Loosely speaking, it performs a copy-by-value, obliterating any previous
3170 content of the destination.
3172 You probably want to use one of the assortment of wrappers, such as
3173 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3174 C<SvSetMagicSV_nosteal>.
3176 =for apidoc sv_setsv_flags
3178 Copies the contents of the source SV C<ssv> into the destination SV
3179 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3180 function if the source SV needs to be reused. Does not handle 'set' magic.
3181 Loosely speaking, it performs a copy-by-value, obliterating any previous
3182 content of the destination.
3183 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3184 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3185 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3186 and C<sv_setsv_nomg> are implemented in terms of this function.
3188 You probably want to use one of the assortment of wrappers, such as
3189 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3190 C<SvSetMagicSV_nosteal>.
3192 This is the primary function for copying scalars, and most other
3193 copy-ish functions and macros use this underneath.
3199 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3201 if (dtype != SVt_PVGV) {
3202 const char * const name = GvNAME(sstr);
3203 const STRLEN len = GvNAMELEN(sstr);
3204 /* don't upgrade SVt_PVLV: it can hold a glob */
3205 if (dtype != SVt_PVLV) {
3206 if (dtype >= SVt_PV) {
3212 sv_upgrade(dstr, SVt_PVGV);
3213 (void)SvOK_off(dstr);
3216 GvSTASH(dstr) = GvSTASH(sstr);
3218 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3219 gv_name_set((GV *)dstr, name, len, 0);
3220 SvFAKE_on(dstr); /* can coerce to non-glob */
3223 #ifdef GV_UNIQUE_CHECK
3224 if (GvUNIQUE((GV*)dstr)) {
3225 Perl_croak(aTHX_ PL_no_modify);
3231 (void)SvOK_off(dstr);
3233 GvINTRO_off(dstr); /* one-shot flag */
3234 GvGP(dstr) = gp_ref(GvGP(sstr));
3235 if (SvTAINTED(sstr))
3237 if (GvIMPORTED(dstr) != GVf_IMPORTED
3238 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3240 GvIMPORTED_on(dstr);
3247 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3248 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3250 const int intro = GvINTRO(dstr);
3253 const U32 stype = SvTYPE(sref);
3256 #ifdef GV_UNIQUE_CHECK
3257 if (GvUNIQUE((GV*)dstr)) {
3258 Perl_croak(aTHX_ PL_no_modify);
3263 GvINTRO_off(dstr); /* one-shot flag */
3264 GvLINE(dstr) = CopLINE(PL_curcop);
3265 GvEGV(dstr) = (GV*)dstr;
3270 location = (SV **) &GvCV(dstr);
3271 import_flag = GVf_IMPORTED_CV;
3274 location = (SV **) &GvHV(dstr);
3275 import_flag = GVf_IMPORTED_HV;
3278 location = (SV **) &GvAV(dstr);
3279 import_flag = GVf_IMPORTED_AV;
3282 location = (SV **) &GvIOp(dstr);
3285 location = (SV **) &GvFORM(dstr);
3287 location = &GvSV(dstr);
3288 import_flag = GVf_IMPORTED_SV;
3291 if (stype == SVt_PVCV) {
3292 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3293 SvREFCNT_dec(GvCV(dstr));
3295 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3296 PL_sub_generation++;
3299 SAVEGENERICSV(*location);
3303 if (stype == SVt_PVCV && *location != sref) {
3304 CV* const cv = (CV*)*location;
3306 if (!GvCVGEN((GV*)dstr) &&
3307 (CvROOT(cv) || CvXSUB(cv)))
3309 /* Redefining a sub - warning is mandatory if
3310 it was a const and its value changed. */
3311 if (CvCONST(cv) && CvCONST((CV*)sref)
3312 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3314 /* They are 2 constant subroutines generated from
3315 the same constant. This probably means that
3316 they are really the "same" proxy subroutine
3317 instantiated in 2 places. Most likely this is
3318 when a constant is exported twice. Don't warn.
3321 else if (ckWARN(WARN_REDEFINE)
3323 && (!CvCONST((CV*)sref)
3324 || sv_cmp(cv_const_sv(cv),
3325 cv_const_sv((CV*)sref))))) {
3326 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3328 ? "Constant subroutine %s::%s redefined"
3329 : "Subroutine %s::%s redefined",
3330 HvNAME_get(GvSTASH((GV*)dstr)),
3331 GvENAME((GV*)dstr));
3335 cv_ckproto(cv, (GV*)dstr,
3336 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3338 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3339 GvASSUMECV_on(dstr);
3340 PL_sub_generation++;
3343 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3344 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3345 GvFLAGS(dstr) |= import_flag;
3350 if (SvTAINTED(sstr))
3356 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3359 register U32 sflags;
3365 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3367 sstr = &PL_sv_undef;
3368 stype = SvTYPE(sstr);
3369 dtype = SvTYPE(dstr);
3374 /* need to nuke the magic */
3376 SvRMAGICAL_off(dstr);
3379 /* There's a lot of redundancy below but we're going for speed here */
3384 if (dtype != SVt_PVGV) {
3385 (void)SvOK_off(dstr);
3393 sv_upgrade(dstr, SVt_IV);
3398 sv_upgrade(dstr, SVt_PVIV);
3401 (void)SvIOK_only(dstr);
3402 SvIV_set(dstr, SvIVX(sstr));
3405 /* SvTAINTED can only be true if the SV has taint magic, which in
3406 turn means that the SV type is PVMG (or greater). This is the
3407 case statement for SVt_IV, so this cannot be true (whatever gcov
3409 assert(!SvTAINTED(sstr));
3419 sv_upgrade(dstr, SVt_NV);
3424 sv_upgrade(dstr, SVt_PVNV);
3427 SvNV_set(dstr, SvNVX(sstr));
3428 (void)SvNOK_only(dstr);
3429 /* SvTAINTED can only be true if the SV has taint magic, which in
3430 turn means that the SV type is PVMG (or greater). This is the
3431 case statement for SVt_NV, so this cannot be true (whatever gcov
3433 assert(!SvTAINTED(sstr));
3440 sv_upgrade(dstr, SVt_RV);
3443 #ifdef PERL_OLD_COPY_ON_WRITE
3444 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3445 if (dtype < SVt_PVIV)
3446 sv_upgrade(dstr, SVt_PVIV);
3453 sv_upgrade(dstr, SVt_PV);
3456 if (dtype < SVt_PVIV)
3457 sv_upgrade(dstr, SVt_PVIV);
3460 if (dtype < SVt_PVNV)
3461 sv_upgrade(dstr, SVt_PVNV);
3465 const char * const type = sv_reftype(sstr,0);
3467 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3469 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3474 if (dtype <= SVt_PVGV) {
3475 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3483 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3485 if ((int)SvTYPE(sstr) != stype) {
3486 stype = SvTYPE(sstr);
3487 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3488 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3493 if (stype == SVt_PVLV)
3494 SvUPGRADE(dstr, SVt_PVNV);
3496 SvUPGRADE(dstr, (U32)stype);
3499 /* dstr may have been upgraded. */
3500 dtype = SvTYPE(dstr);
3501 sflags = SvFLAGS(sstr);
3503 if (sflags & SVf_ROK) {
3504 if (dtype == SVt_PVGV &&
3505 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3508 if (GvIMPORTED(dstr) != GVf_IMPORTED
3509 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3511 GvIMPORTED_on(dstr);
3516 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3520 if (dtype >= SVt_PV) {
3521 if (dtype == SVt_PVGV) {
3522 S_glob_assign_ref(aTHX_ dstr, sstr);
3525 if (SvPVX_const(dstr)) {
3531 (void)SvOK_off(dstr);
3532 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3533 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3534 assert(!(sflags & SVp_NOK));
3535 assert(!(sflags & SVp_IOK));
3536 assert(!(sflags & SVf_NOK));
3537 assert(!(sflags & SVf_IOK));
3539 else if (dtype == SVt_PVGV) {
3540 if (!(sflags & SVf_OK)) {
3541 if (ckWARN(WARN_MISC))
3542 Perl_warner(aTHX_ packWARN(WARN_MISC),
3543 "Undefined value assigned to typeglob");
3546 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3547 if (dstr != (SV*)gv) {
3550 GvGP(dstr) = gp_ref(GvGP(gv));
3554 else if (sflags & SVp_POK) {
3558 * Check to see if we can just swipe the string. If so, it's a
3559 * possible small lose on short strings, but a big win on long ones.
3560 * It might even be a win on short strings if SvPVX_const(dstr)
3561 * has to be allocated and SvPVX_const(sstr) has to be freed.
3564 /* Whichever path we take through the next code, we want this true,
3565 and doing it now facilitates the COW check. */
3566 (void)SvPOK_only(dstr);
3569 /* We're not already COW */
3570 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3571 #ifndef PERL_OLD_COPY_ON_WRITE
3572 /* or we are, but dstr isn't a suitable target. */
3573 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3578 (sflags & SVs_TEMP) && /* slated for free anyway? */
3579 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3580 (!(flags & SV_NOSTEAL)) &&
3581 /* and we're allowed to steal temps */
3582 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3583 SvLEN(sstr) && /* and really is a string */
3584 /* and won't be needed again, potentially */
3585 !(PL_op && PL_op->op_type == OP_AASSIGN))
3586 #ifdef PERL_OLD_COPY_ON_WRITE
3587 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3588 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3589 && SvTYPE(sstr) >= SVt_PVIV)
3592 /* Failed the swipe test, and it's not a shared hash key either.
3593 Have to copy the string. */
3594 STRLEN len = SvCUR(sstr);
3595 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3596 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3597 SvCUR_set(dstr, len);
3598 *SvEND(dstr) = '\0';
3600 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3602 /* Either it's a shared hash key, or it's suitable for
3603 copy-on-write or we can swipe the string. */
3605 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3609 #ifdef PERL_OLD_COPY_ON_WRITE
3611 /* I believe I should acquire a global SV mutex if
3612 it's a COW sv (not a shared hash key) to stop
3613 it going un copy-on-write.
3614 If the source SV has gone un copy on write between up there
3615 and down here, then (assert() that) it is of the correct
3616 form to make it copy on write again */
3617 if ((sflags & (SVf_FAKE | SVf_READONLY))
3618 != (SVf_FAKE | SVf_READONLY)) {
3619 SvREADONLY_on(sstr);
3621 /* Make the source SV into a loop of 1.
3622 (about to become 2) */
3623 SV_COW_NEXT_SV_SET(sstr, sstr);
3627 /* Initial code is common. */
3628 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3633 /* making another shared SV. */
3634 STRLEN cur = SvCUR(sstr);
3635 STRLEN len = SvLEN(sstr);
3636 #ifdef PERL_OLD_COPY_ON_WRITE
3638 assert (SvTYPE(dstr) >= SVt_PVIV);
3639 /* SvIsCOW_normal */
3640 /* splice us in between source and next-after-source. */
3641 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3642 SV_COW_NEXT_SV_SET(sstr, dstr);
3643 SvPV_set(dstr, SvPVX_mutable(sstr));
3647 /* SvIsCOW_shared_hash */
3648 DEBUG_C(PerlIO_printf(Perl_debug_log,
3649 "Copy on write: Sharing hash\n"));
3651 assert (SvTYPE(dstr) >= SVt_PV);
3653 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3655 SvLEN_set(dstr, len);
3656 SvCUR_set(dstr, cur);
3657 SvREADONLY_on(dstr);
3659 /* Relesase a global SV mutex. */
3662 { /* Passes the swipe test. */
3663 SvPV_set(dstr, SvPVX_mutable(sstr));
3664 SvLEN_set(dstr, SvLEN(sstr));
3665 SvCUR_set(dstr, SvCUR(sstr));
3668 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3669 SvPV_set(sstr, NULL);
3675 if (sflags & SVp_NOK) {
3676 SvNV_set(dstr, SvNVX(sstr));
3678 if (sflags & SVp_IOK) {
3679 SvRELEASE_IVX(dstr);
3680 SvIV_set(dstr, SvIVX(sstr));
3681 /* Must do this otherwise some other overloaded use of 0x80000000
3682 gets confused. I guess SVpbm_VALID */
3683 if (sflags & SVf_IVisUV)
3686 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3688 const MAGIC * const smg = SvVOK(sstr);
3690 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3691 smg->mg_ptr, smg->mg_len);
3692 SvRMAGICAL_on(dstr);
3696 else if (sflags & (SVp_IOK|SVp_NOK)) {
3697 (void)SvOK_off(dstr);
3698 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3699 if (sflags & SVp_IOK) {
3700 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3701 SvIV_set(dstr, SvIVX(sstr));
3703 if (sflags & SVp_NOK) {
3704 SvNV_set(dstr, SvNVX(sstr));
3708 if (isGV_with_GP(sstr)) {
3709 /* This stringification rule for globs is spread in 3 places.
3710 This feels bad. FIXME. */
3711 const U32 wasfake = sflags & SVf_FAKE;
3713 /* FAKE globs can get coerced, so need to turn this off
3714 temporarily if it is on. */
3716 gv_efullname3(dstr, (GV *)sstr, "*");
3717 SvFLAGS(sstr) |= wasfake;
3720 (void)SvOK_off(dstr);
3722 if (SvTAINTED(sstr))
3727 =for apidoc sv_setsv_mg
3729 Like C<sv_setsv>, but also handles 'set' magic.
3735 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3737 sv_setsv(dstr,sstr);
3741 #ifdef PERL_OLD_COPY_ON_WRITE
3743 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3745 STRLEN cur = SvCUR(sstr);
3746 STRLEN len = SvLEN(sstr);
3747 register char *new_pv;
3750 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3758 if (SvTHINKFIRST(dstr))
3759 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3760 else if (SvPVX_const(dstr))
3761 Safefree(SvPVX_const(dstr));
3765 SvUPGRADE(dstr, SVt_PVIV);
3767 assert (SvPOK(sstr));
3768 assert (SvPOKp(sstr));
3769 assert (!SvIOK(sstr));
3770 assert (!SvIOKp(sstr));
3771 assert (!SvNOK(sstr));
3772 assert (!SvNOKp(sstr));
3774 if (SvIsCOW(sstr)) {
3776 if (SvLEN(sstr) == 0) {
3777 /* source is a COW shared hash key. */
3778 DEBUG_C(PerlIO_printf(Perl_debug_log,
3779 "Fast copy on write: Sharing hash\n"));
3780 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3783 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3785 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3786 SvUPGRADE(sstr, SVt_PVIV);
3787 SvREADONLY_on(sstr);
3789 DEBUG_C(PerlIO_printf(Perl_debug_log,
3790 "Fast copy on write: Converting sstr to COW\n"));
3791 SV_COW_NEXT_SV_SET(dstr, sstr);
3793 SV_COW_NEXT_SV_SET(sstr, dstr);
3794 new_pv = SvPVX_mutable(sstr);
3797 SvPV_set(dstr, new_pv);
3798 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3801 SvLEN_set(dstr, len);
3802 SvCUR_set(dstr, cur);
3811 =for apidoc sv_setpvn
3813 Copies a string into an SV. The C<len> parameter indicates the number of
3814 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3815 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3821 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3824 register char *dptr;
3826 SV_CHECK_THINKFIRST_COW_DROP(sv);
3832 /* len is STRLEN which is unsigned, need to copy to signed */
3835 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3837 SvUPGRADE(sv, SVt_PV);
3839 dptr = SvGROW(sv, len + 1);
3840 Move(ptr,dptr,len,char);
3843 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3848 =for apidoc sv_setpvn_mg
3850 Like C<sv_setpvn>, but also handles 'set' magic.
3856 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3858 sv_setpvn(sv,ptr,len);
3863 =for apidoc sv_setpv
3865 Copies a string into an SV. The string must be null-terminated. Does not
3866 handle 'set' magic. See C<sv_setpv_mg>.
3872 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3875 register STRLEN len;
3877 SV_CHECK_THINKFIRST_COW_DROP(sv);
3883 SvUPGRADE(sv, SVt_PV);
3885 SvGROW(sv, len + 1);
3886 Move(ptr,SvPVX(sv),len+1,char);
3888 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3893 =for apidoc sv_setpv_mg
3895 Like C<sv_setpv>, but also handles 'set' magic.
3901 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3908 =for apidoc sv_usepvn
3910 Tells an SV to use C<ptr> to find its string value. Normally the string is
3911 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3912 The C<ptr> should point to memory that was allocated by C<malloc>. The
3913 string length, C<len>, must be supplied. This function will realloc the
3914 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3915 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3916 See C<sv_usepvn_mg>.
3922 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3926 SV_CHECK_THINKFIRST_COW_DROP(sv);
3927 SvUPGRADE(sv, SVt_PV);
3932 if (SvPVX_const(sv))
3935 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3936 ptr = saferealloc (ptr, allocate);
3939 SvLEN_set(sv, allocate);
3941 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3946 =for apidoc sv_usepvn_mg
3948 Like C<sv_usepvn>, but also handles 'set' magic.
3954 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3956 sv_usepvn(sv,ptr,len);
3960 #ifdef PERL_OLD_COPY_ON_WRITE
3961 /* Need to do this *after* making the SV normal, as we need the buffer
3962 pointer to remain valid until after we've copied it. If we let go too early,
3963 another thread could invalidate it by unsharing last of the same hash key
3964 (which it can do by means other than releasing copy-on-write Svs)
3965 or by changing the other copy-on-write SVs in the loop. */
3967 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3969 if (len) { /* this SV was SvIsCOW_normal(sv) */
3970 /* we need to find the SV pointing to us. */
3971 SV *current = SV_COW_NEXT_SV(after);
3973 if (current == sv) {
3974 /* The SV we point to points back to us (there were only two of us
3976 Hence other SV is no longer copy on write either. */
3978 SvREADONLY_off(after);
3980 /* We need to follow the pointers around the loop. */
3982 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3985 /* don't loop forever if the structure is bust, and we have
3986 a pointer into a closed loop. */
3987 assert (current != after);
3988 assert (SvPVX_const(current) == pvx);
3990 /* Make the SV before us point to the SV after us. */
3991 SV_COW_NEXT_SV_SET(current, after);
3994 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3999 Perl_sv_release_IVX(pTHX_ register SV *sv)
4002 sv_force_normal_flags(sv, 0);
4008 =for apidoc sv_force_normal_flags
4010 Undo various types of fakery on an SV: if the PV is a shared string, make
4011 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4012 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4013 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4014 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4015 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4016 set to some other value.) In addition, the C<flags> parameter gets passed to
4017 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4018 with flags set to 0.
4024 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4027 #ifdef PERL_OLD_COPY_ON_WRITE
4028 if (SvREADONLY(sv)) {
4029 /* At this point I believe I should acquire a global SV mutex. */
4031 const char * const pvx = SvPVX_const(sv);
4032 const STRLEN len = SvLEN(sv);
4033 const STRLEN cur = SvCUR(sv);
4034 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4036 PerlIO_printf(Perl_debug_log,
4037 "Copy on write: Force normal %ld\n",
4043 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4046 if (flags & SV_COW_DROP_PV) {
4047 /* OK, so we don't need to copy our buffer. */
4050 SvGROW(sv, cur + 1);
4051 Move(pvx,SvPVX(sv),cur,char);
4055 sv_release_COW(sv, pvx, len, next);
4060 else if (IN_PERL_RUNTIME)
4061 Perl_croak(aTHX_ PL_no_modify);
4062 /* At this point I believe that I can drop the global SV mutex. */
4065 if (SvREADONLY(sv)) {
4067 const char * const pvx = SvPVX_const(sv);
4068 const STRLEN len = SvCUR(sv);
4073 SvGROW(sv, len + 1);
4074 Move(pvx,SvPVX(sv),len,char);
4076 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4078 else if (IN_PERL_RUNTIME)
4079 Perl_croak(aTHX_ PL_no_modify);
4083 sv_unref_flags(sv, flags);
4084 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4091 Efficient removal of characters from the beginning of the string buffer.
4092 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4093 the string buffer. The C<ptr> becomes the first character of the adjusted
4094 string. Uses the "OOK hack".
4095 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4096 refer to the same chunk of data.
4102 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4104 register STRLEN delta;
4105 if (!ptr || !SvPOKp(sv))
4107 delta = ptr - SvPVX_const(sv);
4108 SV_CHECK_THINKFIRST(sv);
4109 if (SvTYPE(sv) < SVt_PVIV)
4110 sv_upgrade(sv,SVt_PVIV);
4113 if (!SvLEN(sv)) { /* make copy of shared string */
4114 const char *pvx = SvPVX_const(sv);
4115 const STRLEN len = SvCUR(sv);
4116 SvGROW(sv, len + 1);
4117 Move(pvx,SvPVX(sv),len,char);
4121 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4122 and we do that anyway inside the SvNIOK_off
4124 SvFLAGS(sv) |= SVf_OOK;
4127 SvLEN_set(sv, SvLEN(sv) - delta);
4128 SvCUR_set(sv, SvCUR(sv) - delta);
4129 SvPV_set(sv, SvPVX(sv) + delta);
4130 SvIV_set(sv, SvIVX(sv) + delta);
4134 =for apidoc sv_catpvn
4136 Concatenates the string onto the end of the string which is in the SV. The
4137 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4138 status set, then the bytes appended should be valid UTF-8.
4139 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4141 =for apidoc sv_catpvn_flags
4143 Concatenates the string onto the end of the string which is in the SV. The
4144 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4145 status set, then the bytes appended should be valid UTF-8.
4146 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4147 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4148 in terms of this function.
4154 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4158 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4160 SvGROW(dsv, dlen + slen + 1);
4162 sstr = SvPVX_const(dsv);
4163 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4164 SvCUR_set(dsv, SvCUR(dsv) + slen);
4166 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4168 if (flags & SV_SMAGIC)
4173 =for apidoc sv_catsv
4175 Concatenates the string from SV C<ssv> onto the end of the string in
4176 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4177 not 'set' magic. See C<sv_catsv_mg>.
4179 =for apidoc sv_catsv_flags
4181 Concatenates the string from SV C<ssv> onto the end of the string in
4182 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4183 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4184 and C<sv_catsv_nomg> are implemented in terms of this function.
4189 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4194 const char *spv = SvPV_const(ssv, slen);
4196 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4197 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4198 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4199 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4200 dsv->sv_flags doesn't have that bit set.
4201 Andy Dougherty 12 Oct 2001
4203 const I32 sutf8 = DO_UTF8(ssv);
4206 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4208 dutf8 = DO_UTF8(dsv);
4210 if (dutf8 != sutf8) {
4212 /* Not modifying source SV, so taking a temporary copy. */
4213 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4215 sv_utf8_upgrade(csv);
4216 spv = SvPV_const(csv, slen);
4219 sv_utf8_upgrade_nomg(dsv);
4221 sv_catpvn_nomg(dsv, spv, slen);
4224 if (flags & SV_SMAGIC)
4229 =for apidoc sv_catpv
4231 Concatenates the string onto the end of the string which is in the SV.
4232 If the SV has the UTF-8 status set, then the bytes appended should be
4233 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4238 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4241 register STRLEN len;
4247 junk = SvPV_force(sv, tlen);
4249 SvGROW(sv, tlen + len + 1);
4251 ptr = SvPVX_const(sv);
4252 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4253 SvCUR_set(sv, SvCUR(sv) + len);
4254 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4259 =for apidoc sv_catpv_mg
4261 Like C<sv_catpv>, but also handles 'set' magic.
4267 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4276 Creates a new SV. A non-zero C<len> parameter indicates the number of
4277 bytes of preallocated string space the SV should have. An extra byte for a
4278 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4279 space is allocated.) The reference count for the new SV is set to 1.
4281 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4282 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4283 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4284 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4285 modules supporting older perls.
4291 Perl_newSV(pTHX_ STRLEN len)
4298 sv_upgrade(sv, SVt_PV);
4299 SvGROW(sv, len + 1);
4304 =for apidoc sv_magicext
4306 Adds magic to an SV, upgrading it if necessary. Applies the
4307 supplied vtable and returns a pointer to the magic added.
4309 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4310 In particular, you can add magic to SvREADONLY SVs, and add more than
4311 one instance of the same 'how'.
4313 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4314 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4315 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4316 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4318 (This is now used as a subroutine by C<sv_magic>.)
4323 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4324 const char* name, I32 namlen)
4329 if (SvTYPE(sv) < SVt_PVMG) {
4330 SvUPGRADE(sv, SVt_PVMG);
4332 Newxz(mg, 1, MAGIC);
4333 mg->mg_moremagic = SvMAGIC(sv);
4334 SvMAGIC_set(sv, mg);
4336 /* Sometimes a magic contains a reference loop, where the sv and
4337 object refer to each other. To prevent a reference loop that
4338 would prevent such objects being freed, we look for such loops
4339 and if we find one we avoid incrementing the object refcount.
4341 Note we cannot do this to avoid self-tie loops as intervening RV must
4342 have its REFCNT incremented to keep it in existence.
4345 if (!obj || obj == sv ||
4346 how == PERL_MAGIC_arylen ||
4347 how == PERL_MAGIC_qr ||
4348 how == PERL_MAGIC_symtab ||
4349 (SvTYPE(obj) == SVt_PVGV &&
4350 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4351 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4352 GvFORM(obj) == (CV*)sv)))
4357 mg->mg_obj = SvREFCNT_inc_simple(obj);
4358 mg->mg_flags |= MGf_REFCOUNTED;
4361 /* Normal self-ties simply pass a null object, and instead of
4362 using mg_obj directly, use the SvTIED_obj macro to produce a
4363 new RV as needed. For glob "self-ties", we are tieing the PVIO
4364 with an RV obj pointing to the glob containing the PVIO. In
4365 this case, to avoid a reference loop, we need to weaken the
4369 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4370 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4376 mg->mg_len = namlen;
4379 mg->mg_ptr = savepvn(name, namlen);
4380 else if (namlen == HEf_SVKEY)
4381 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4383 mg->mg_ptr = (char *) name;
4385 mg->mg_virtual = vtable;
4389 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4394 =for apidoc sv_magic
4396 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4397 then adds a new magic item of type C<how> to the head of the magic list.
4399 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4400 handling of the C<name> and C<namlen> arguments.
4402 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4403 to add more than one instance of the same 'how'.
4409 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4415 #ifdef PERL_OLD_COPY_ON_WRITE
4417 sv_force_normal_flags(sv, 0);
4419 if (SvREADONLY(sv)) {
4421 /* its okay to attach magic to shared strings; the subsequent
4422 * upgrade to PVMG will unshare the string */
4423 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4426 && how != PERL_MAGIC_regex_global
4427 && how != PERL_MAGIC_bm
4428 && how != PERL_MAGIC_fm
4429 && how != PERL_MAGIC_sv
4430 && how != PERL_MAGIC_backref
4433 Perl_croak(aTHX_ PL_no_modify);
4436 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4437 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4438 /* sv_magic() refuses to add a magic of the same 'how' as an
4441 if (how == PERL_MAGIC_taint) {
4443 /* Any scalar which already had taint magic on which someone
4444 (erroneously?) did SvIOK_on() or similar will now be
4445 incorrectly sporting public "OK" flags. */
4446 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4454 vtable = &PL_vtbl_sv;
4456 case PERL_MAGIC_overload:
4457 vtable = &PL_vtbl_amagic;
4459 case PERL_MAGIC_overload_elem:
4460 vtable = &PL_vtbl_amagicelem;
4462 case PERL_MAGIC_overload_table:
4463 vtable = &PL_vtbl_ovrld;
4466 vtable = &PL_vtbl_bm;
4468 case PERL_MAGIC_regdata:
4469 vtable = &PL_vtbl_regdata;
4471 case PERL_MAGIC_regdatum:
4472 vtable = &PL_vtbl_regdatum;
4474 case PERL_MAGIC_env:
4475 vtable = &PL_vtbl_env;
4478 vtable = &PL_vtbl_fm;
4480 case PERL_MAGIC_envelem:
4481 vtable = &PL_vtbl_envelem;
4483 case PERL_MAGIC_regex_global:
4484 vtable = &PL_vtbl_mglob;
4486 case PERL_MAGIC_isa:
4487 vtable = &PL_vtbl_isa;
4489 case PERL_MAGIC_isaelem:
4490 vtable = &PL_vtbl_isaelem;
4492 case PERL_MAGIC_nkeys:
4493 vtable = &PL_vtbl_nkeys;
4495 case PERL_MAGIC_dbfile:
4498 case PERL_MAGIC_dbline:
4499 vtable = &PL_vtbl_dbline;
4501 #ifdef USE_LOCALE_COLLATE
4502 case PERL_MAGIC_collxfrm:
4503 vtable = &PL_vtbl_collxfrm;
4505 #endif /* USE_LOCALE_COLLATE */
4506 case PERL_MAGIC_tied:
4507 vtable = &PL_vtbl_pack;
4509 case PERL_MAGIC_tiedelem:
4510 case PERL_MAGIC_tiedscalar:
4511 vtable = &PL_vtbl_packelem;
4514 vtable = &PL_vtbl_regexp;
4516 case PERL_MAGIC_sig:
4517 vtable = &PL_vtbl_sig;
4519 case PERL_MAGIC_sigelem:
4520 vtable = &PL_vtbl_sigelem;
4522 case PERL_MAGIC_taint:
4523 vtable = &PL_vtbl_taint;
4525 case PERL_MAGIC_uvar:
4526 vtable = &PL_vtbl_uvar;
4528 case PERL_MAGIC_vec:
4529 vtable = &PL_vtbl_vec;
4531 case PERL_MAGIC_arylen_p:
4532 case PERL_MAGIC_rhash:
4533 case PERL_MAGIC_symtab:
4534 case PERL_MAGIC_vstring:
4537 case PERL_MAGIC_utf8:
4538 vtable = &PL_vtbl_utf8;
4540 case PERL_MAGIC_substr:
4541 vtable = &PL_vtbl_substr;
4543 case PERL_MAGIC_defelem:
4544 vtable = &PL_vtbl_defelem;
4546 case PERL_MAGIC_arylen:
4547 vtable = &PL_vtbl_arylen;
4549 case PERL_MAGIC_pos:
4550 vtable = &PL_vtbl_pos;
4552 case PERL_MAGIC_backref:
4553 vtable = &PL_vtbl_backref;
4555 case PERL_MAGIC_ext:
4556 /* Reserved for use by extensions not perl internals. */
4557 /* Useful for attaching extension internal data to perl vars. */
4558 /* Note that multiple extensions may clash if magical scalars */
4559 /* etc holding private data from one are passed to another. */
4563 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4566 /* Rest of work is done else where */
4567 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4570 case PERL_MAGIC_taint:
4573 case PERL_MAGIC_ext:
4574 case PERL_MAGIC_dbfile:
4581 =for apidoc sv_unmagic
4583 Removes all magic of type C<type> from an SV.
4589 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4593 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4595 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4596 for (mg = *mgp; mg; mg = *mgp) {
4597 if (mg->mg_type == type) {
4598 const MGVTBL* const vtbl = mg->mg_virtual;
4599 *mgp = mg->mg_moremagic;
4600 if (vtbl && vtbl->svt_free)
4601 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4602 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4604 Safefree(mg->mg_ptr);
4605 else if (mg->mg_len == HEf_SVKEY)
4606 SvREFCNT_dec((SV*)mg->mg_ptr);
4607 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4608 Safefree(mg->mg_ptr);
4610 if (mg->mg_flags & MGf_REFCOUNTED)
4611 SvREFCNT_dec(mg->mg_obj);
4615 mgp = &mg->mg_moremagic;
4619 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4620 SvMAGIC_set(sv, NULL);
4627 =for apidoc sv_rvweaken
4629 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4630 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4631 push a back-reference to this RV onto the array of backreferences
4632 associated with that magic.
4638 Perl_sv_rvweaken(pTHX_ SV *sv)
4641 if (!SvOK(sv)) /* let undefs pass */
4644 Perl_croak(aTHX_ "Can't weaken a nonreference");
4645 else if (SvWEAKREF(sv)) {
4646 if (ckWARN(WARN_MISC))
4647 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4651 Perl_sv_add_backref(aTHX_ tsv, sv);
4657 /* Give tsv backref magic if it hasn't already got it, then push a
4658 * back-reference to sv onto the array associated with the backref magic.
4662 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4667 if (SvTYPE(tsv) == SVt_PVHV) {
4668 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4672 /* There is no AV in the offical place - try a fixup. */
4673 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4676 /* Aha. They've got it stowed in magic. Bring it back. */
4677 av = (AV*)mg->mg_obj;
4678 /* Stop mg_free decreasing the refernce count. */
4680 /* Stop mg_free even calling the destructor, given that
4681 there's no AV to free up. */
4683 sv_unmagic(tsv, PERL_MAGIC_backref);
4687 SvREFCNT_inc_simple_void(av);
4692 const MAGIC *const mg
4693 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4695 av = (AV*)mg->mg_obj;
4699 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4700 /* av now has a refcnt of 2, which avoids it getting freed
4701 * before us during global cleanup. The extra ref is removed
4702 * by magic_killbackrefs() when tsv is being freed */
4705 if (AvFILLp(av) >= AvMAX(av)) {
4706 av_extend(av, AvFILLp(av)+1);
4708 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4711 /* delete a back-reference to ourselves from the backref magic associated
4712 * with the SV we point to.
4716 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4723 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4724 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4725 /* We mustn't attempt to "fix up" the hash here by moving the
4726 backreference array back to the hv_aux structure, as that is stored
4727 in the main HvARRAY(), and hfreentries assumes that no-one
4728 reallocates HvARRAY() while it is running. */
4731 const MAGIC *const mg
4732 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4734 av = (AV *)mg->mg_obj;
4737 if (PL_in_clean_all)
4739 Perl_croak(aTHX_ "panic: del_backref");
4746 /* We shouldn't be in here more than once, but for paranoia reasons lets
4748 for (i = AvFILLp(av); i >= 0; i--) {
4750 const SSize_t fill = AvFILLp(av);
4752 /* We weren't the last entry.
4753 An unordered list has this property that you can take the
4754 last element off the end to fill the hole, and it's still
4755 an unordered list :-)
4760 AvFILLp(av) = fill - 1;
4766 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4768 SV **svp = AvARRAY(av);
4770 PERL_UNUSED_ARG(sv);
4772 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4773 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4774 if (svp && !SvIS_FREED(av)) {
4775 SV *const *const last = svp + AvFILLp(av);
4777 while (svp <= last) {
4779 SV *const referrer = *svp;
4780 if (SvWEAKREF(referrer)) {
4781 /* XXX Should we check that it hasn't changed? */
4782 SvRV_set(referrer, 0);
4784 SvWEAKREF_off(referrer);
4785 } else if (SvTYPE(referrer) == SVt_PVGV ||
4786 SvTYPE(referrer) == SVt_PVLV) {
4787 /* You lookin' at me? */
4788 assert(GvSTASH(referrer));
4789 assert(GvSTASH(referrer) == (HV*)sv);
4790 GvSTASH(referrer) = 0;
4793 "panic: magic_killbackrefs (flags=%"UVxf")",
4794 (UV)SvFLAGS(referrer));
4802 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4807 =for apidoc sv_insert
4809 Inserts a string at the specified offset/length within the SV. Similar to
4810 the Perl substr() function.
4816 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4821 register char *midend;
4822 register char *bigend;
4828 Perl_croak(aTHX_ "Can't modify non-existent substring");
4829 SvPV_force(bigstr, curlen);
4830 (void)SvPOK_only_UTF8(bigstr);
4831 if (offset + len > curlen) {
4832 SvGROW(bigstr, offset+len+1);
4833 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4834 SvCUR_set(bigstr, offset+len);
4838 i = littlelen - len;
4839 if (i > 0) { /* string might grow */
4840 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4841 mid = big + offset + len;
4842 midend = bigend = big + SvCUR(bigstr);
4845 while (midend > mid) /* shove everything down */
4846 *--bigend = *--midend;
4847 Move(little,big+offset,littlelen,char);
4848 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4853 Move(little,SvPVX(bigstr)+offset,len,char);
4858 big = SvPVX(bigstr);
4861 bigend = big + SvCUR(bigstr);
4863 if (midend > bigend)
4864 Perl_croak(aTHX_ "panic: sv_insert");
4866 if (mid - big > bigend - midend) { /* faster to shorten from end */
4868 Move(little, mid, littlelen,char);
4871 i = bigend - midend;
4873 Move(midend, mid, i,char);
4877 SvCUR_set(bigstr, mid - big);
4879 else if ((i = mid - big)) { /* faster from front */
4880 midend -= littlelen;
4882 sv_chop(bigstr,midend-i);
4887 Move(little, mid, littlelen,char);
4889 else if (littlelen) {
4890 midend -= littlelen;
4891 sv_chop(bigstr,midend);
4892 Move(little,midend,littlelen,char);
4895 sv_chop(bigstr,midend);
4901 =for apidoc sv_replace
4903 Make the first argument a copy of the second, then delete the original.
4904 The target SV physically takes over ownership of the body of the source SV
4905 and inherits its flags; however, the target keeps any magic it owns,
4906 and any magic in the source is discarded.
4907 Note that this is a rather specialist SV copying operation; most of the
4908 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4914 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4917 const U32 refcnt = SvREFCNT(sv);
4918 SV_CHECK_THINKFIRST_COW_DROP(sv);
4919 if (SvREFCNT(nsv) != 1) {
4920 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4921 UVuf " != 1)", (UV) SvREFCNT(nsv));
4923 if (SvMAGICAL(sv)) {
4927 sv_upgrade(nsv, SVt_PVMG);
4928 SvMAGIC_set(nsv, SvMAGIC(sv));
4929 SvFLAGS(nsv) |= SvMAGICAL(sv);
4931 SvMAGIC_set(sv, NULL);
4935 assert(!SvREFCNT(sv));
4936 #ifdef DEBUG_LEAKING_SCALARS
4937 sv->sv_flags = nsv->sv_flags;
4938 sv->sv_any = nsv->sv_any;
4939 sv->sv_refcnt = nsv->sv_refcnt;
4940 sv->sv_u = nsv->sv_u;
4942 StructCopy(nsv,sv,SV);
4944 /* Currently could join these into one piece of pointer arithmetic, but
4945 it would be unclear. */
4946 if(SvTYPE(sv) == SVt_IV)
4948 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4949 else if (SvTYPE(sv) == SVt_RV) {
4950 SvANY(sv) = &sv->sv_u.svu_rv;
4954 #ifdef PERL_OLD_COPY_ON_WRITE
4955 if (SvIsCOW_normal(nsv)) {
4956 /* We need to follow the pointers around the loop to make the
4957 previous SV point to sv, rather than nsv. */
4960 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4963 assert(SvPVX_const(current) == SvPVX_const(nsv));
4965 /* Make the SV before us point to the SV after us. */
4967 PerlIO_printf(Perl_debug_log, "previous is\n");
4969 PerlIO_printf(Perl_debug_log,
4970 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4971 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4973 SV_COW_NEXT_SV_SET(current, sv);
4976 SvREFCNT(sv) = refcnt;
4977 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4983 =for apidoc sv_clear
4985 Clear an SV: call any destructors, free up any memory used by the body,
4986 and free the body itself. The SV's head is I<not> freed, although
4987 its type is set to all 1's so that it won't inadvertently be assumed
4988 to be live during global destruction etc.
4989 This function should only be called when REFCNT is zero. Most of the time
4990 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4997 Perl_sv_clear(pTHX_ register SV *sv)
5000 const U32 type = SvTYPE(sv);
5001 const struct body_details *const sv_type_details
5002 = bodies_by_type + type;
5005 assert(SvREFCNT(sv) == 0);
5007 if (type <= SVt_IV) {
5008 /* See the comment in sv.h about the collusion between this early
5009 return and the overloading of the NULL and IV slots in the size
5015 if (PL_defstash) { /* Still have a symbol table? */
5020 stash = SvSTASH(sv);
5021 destructor = StashHANDLER(stash,DESTROY);
5023 SV* const tmpref = newRV(sv);
5024 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5026 PUSHSTACKi(PERLSI_DESTROY);
5031 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5037 if(SvREFCNT(tmpref) < 2) {
5038 /* tmpref is not kept alive! */
5040 SvRV_set(tmpref, NULL);
5043 SvREFCNT_dec(tmpref);
5045 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5049 if (PL_in_clean_objs)
5050 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5052 /* DESTROY gave object new lease on life */
5058 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5059 SvOBJECT_off(sv); /* Curse the object. */
5060 if (type != SVt_PVIO)
5061 --PL_sv_objcount; /* XXX Might want something more general */
5064 if (type >= SVt_PVMG) {
5066 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5067 (ourstash = OURSTASH(sv))) {
5068 SvREFCNT_dec(ourstash);
5069 } else if (SvMAGIC(sv))
5071 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5072 SvREFCNT_dec(SvSTASH(sv));
5077 IoIFP(sv) != PerlIO_stdin() &&
5078 IoIFP(sv) != PerlIO_stdout() &&
5079 IoIFP(sv) != PerlIO_stderr())
5081 io_close((IO*)sv, FALSE);
5083 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5084 PerlDir_close(IoDIRP(sv));
5085 IoDIRP(sv) = (DIR*)NULL;
5086 Safefree(IoTOP_NAME(sv));
5087 Safefree(IoFMT_NAME(sv));
5088 Safefree(IoBOTTOM_NAME(sv));
5097 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5104 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5105 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5106 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5107 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5109 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5110 SvREFCNT_dec(LvTARG(sv));
5114 if (GvNAME_HEK(sv)) {
5115 unshare_hek(GvNAME_HEK(sv));
5117 /* If we're in a stash, we don't own a reference to it. However it does
5118 have a back reference to us, which needs to be cleared. */
5120 sv_del_backref((SV*)GvSTASH(sv), sv);
5125 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5127 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5128 /* Don't even bother with turning off the OOK flag. */
5133 SV * const target = SvRV(sv);
5135 sv_del_backref(target, sv);
5137 SvREFCNT_dec(target);
5139 #ifdef PERL_OLD_COPY_ON_WRITE
5140 else if (SvPVX_const(sv)) {
5142 /* I believe I need to grab the global SV mutex here and
5143 then recheck the COW status. */
5145 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5148 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5149 SV_COW_NEXT_SV(sv));
5150 /* And drop it here. */
5152 } else if (SvLEN(sv)) {
5153 Safefree(SvPVX_const(sv));
5157 else if (SvPVX_const(sv) && SvLEN(sv))
5158 Safefree(SvPVX_mutable(sv));
5159 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5160 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5169 SvFLAGS(sv) &= SVf_BREAK;
5170 SvFLAGS(sv) |= SVTYPEMASK;
5172 if (sv_type_details->arena) {
5173 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5174 &PL_body_roots[type]);
5176 else if (sv_type_details->body_size) {
5177 my_safefree(SvANY(sv));
5182 =for apidoc sv_newref
5184 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5191 Perl_sv_newref(pTHX_ SV *sv)
5193 PERL_UNUSED_CONTEXT;
5202 Decrement an SV's reference count, and if it drops to zero, call
5203 C<sv_clear> to invoke destructors and free up any memory used by
5204 the body; finally, deallocate the SV's head itself.
5205 Normally called via a wrapper macro C<SvREFCNT_dec>.
5211 Perl_sv_free(pTHX_ SV *sv)
5216 if (SvREFCNT(sv) == 0) {
5217 if (SvFLAGS(sv) & SVf_BREAK)
5218 /* this SV's refcnt has been artificially decremented to
5219 * trigger cleanup */
5221 if (PL_in_clean_all) /* All is fair */
5223 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5224 /* make sure SvREFCNT(sv)==0 happens very seldom */
5225 SvREFCNT(sv) = (~(U32)0)/2;
5228 if (ckWARN_d(WARN_INTERNAL)) {
5229 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5230 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5231 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5232 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5233 Perl_dump_sv_child(aTHX_ sv);
5238 if (--(SvREFCNT(sv)) > 0)
5240 Perl_sv_free2(aTHX_ sv);
5244 Perl_sv_free2(pTHX_ SV *sv)
5249 if (ckWARN_d(WARN_DEBUGGING))
5250 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5251 "Attempt to free temp prematurely: SV 0x%"UVxf
5252 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5256 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5257 /* make sure SvREFCNT(sv)==0 happens very seldom */
5258 SvREFCNT(sv) = (~(U32)0)/2;
5269 Returns the length of the string in the SV. Handles magic and type
5270 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5276 Perl_sv_len(pTHX_ register SV *sv)
5284 len = mg_length(sv);
5286 (void)SvPV_const(sv, len);
5291 =for apidoc sv_len_utf8
5293 Returns the number of characters in the string in an SV, counting wide
5294 UTF-8 bytes as a single character. Handles magic and type coercion.
5300 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5301 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5302 * (Note that the mg_len is not the length of the mg_ptr field.)
5307 Perl_sv_len_utf8(pTHX_ register SV *sv)
5313 return mg_length(sv);
5317 const U8 *s = (U8*)SvPV_const(sv, len);
5318 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5320 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5322 #ifdef PERL_UTF8_CACHE_ASSERT
5323 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5327 ulen = Perl_utf8_length(aTHX_ s, s + len);
5328 if (!mg && !SvREADONLY(sv)) {
5329 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5330 mg = mg_find(sv, PERL_MAGIC_utf8);
5340 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5341 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5342 * between UTF-8 and byte offsets. There are two (substr offset and substr
5343 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5344 * and byte offset) cache positions.
5346 * The mg_len field is used by sv_len_utf8(), see its comments.
5347 * Note that the mg_len is not the length of the mg_ptr field.
5351 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5352 I32 offsetp, const U8 *s, const U8 *start)
5356 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5358 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5362 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5364 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5365 (*mgp)->mg_ptr = (char *) *cachep;
5369 (*cachep)[i] = offsetp;
5370 (*cachep)[i+1] = s - start;
5378 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5379 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5380 * between UTF-8 and byte offsets. See also the comments of
5381 * S_utf8_mg_pos_init().
5385 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)
5389 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5391 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5392 if (*mgp && (*mgp)->mg_ptr) {
5393 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5394 ASSERT_UTF8_CACHE(*cachep);
5395 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5397 else { /* We will skip to the right spot. */
5402 /* The assumption is that going backward is half
5403 * the speed of going forward (that's where the
5404 * 2 * backw in the below comes from). (The real
5405 * figure of course depends on the UTF-8 data.) */
5407 if ((*cachep)[i] > (STRLEN)uoff) {
5409 backw = (*cachep)[i] - (STRLEN)uoff;
5411 if (forw < 2 * backw)
5414 p = start + (*cachep)[i+1];
5416 /* Try this only for the substr offset (i == 0),
5417 * not for the substr length (i == 2). */
5418 else if (i == 0) { /* (*cachep)[i] < uoff */
5419 const STRLEN ulen = sv_len_utf8(sv);
5421 if ((STRLEN)uoff < ulen) {
5422 forw = (STRLEN)uoff - (*cachep)[i];
5423 backw = ulen - (STRLEN)uoff;
5425 if (forw < 2 * backw)
5426 p = start + (*cachep)[i+1];
5431 /* If the string is not long enough for uoff,
5432 * we could extend it, but not at this low a level. */
5436 if (forw < 2 * backw) {
5443 while (UTF8_IS_CONTINUATION(*p))
5448 /* Update the cache. */
5449 (*cachep)[i] = (STRLEN)uoff;
5450 (*cachep)[i+1] = p - start;
5452 /* Drop the stale "length" cache */
5461 if (found) { /* Setup the return values. */
5462 *offsetp = (*cachep)[i+1];
5463 *sp = start + *offsetp;
5466 *offsetp = send - start;
5468 else if (*sp < start) {
5474 #ifdef PERL_UTF8_CACHE_ASSERT
5479 while (n-- && s < send)
5483 assert(*offsetp == s - start);
5484 assert((*cachep)[0] == (STRLEN)uoff);
5485 assert((*cachep)[1] == *offsetp);
5487 ASSERT_UTF8_CACHE(*cachep);
5496 =for apidoc sv_pos_u2b
5498 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5499 the start of the string, to a count of the equivalent number of bytes; if
5500 lenp is non-zero, it does the same to lenp, but this time starting from
5501 the offset, rather than from the start of the string. Handles magic and
5508 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5509 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5510 * byte offsets. See also the comments of S_utf8_mg_pos().
5515 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5523 start = (U8*)SvPV_const(sv, len);
5526 STRLEN *cache = NULL;
5527 const U8 *s = start;
5528 I32 uoffset = *offsetp;
5529 const U8 * const send = s + len;
5531 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5533 if (!found && uoffset > 0) {
5534 while (s < send && uoffset--)
5538 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5540 *offsetp = s - start;
5545 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5549 if (!found && *lenp > 0) {
5552 while (s < send && ulen--)
5556 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5560 ASSERT_UTF8_CACHE(cache);
5572 =for apidoc sv_pos_b2u
5574 Converts the value pointed to by offsetp from a count of bytes from the
5575 start of the string, to a count of the equivalent number of UTF-8 chars.
5576 Handles magic and type coercion.
5582 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5583 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5584 * byte offsets. See also the comments of S_utf8_mg_pos().
5589 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5597 s = (const U8*)SvPV_const(sv, len);
5598 if ((I32)len < *offsetp)
5599 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5601 const U8* send = s + *offsetp;
5603 STRLEN *cache = NULL;
5607 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5608 mg = mg_find(sv, PERL_MAGIC_utf8);
5609 if (mg && mg->mg_ptr) {
5610 cache = (STRLEN *) mg->mg_ptr;
5611 if (cache[1] == (STRLEN)*offsetp) {
5612 /* An exact match. */
5613 *offsetp = cache[0];
5617 else if (cache[1] < (STRLEN)*offsetp) {
5618 /* We already know part of the way. */
5621 /* Let the below loop do the rest. */
5623 else { /* cache[1] > *offsetp */
5624 /* We already know all of the way, now we may
5625 * be able to walk back. The same assumption
5626 * is made as in S_utf8_mg_pos(), namely that
5627 * walking backward is twice slower than
5628 * walking forward. */
5629 const STRLEN forw = *offsetp;
5630 STRLEN backw = cache[1] - *offsetp;
5632 if (!(forw < 2 * backw)) {
5633 const U8 *p = s + cache[1];
5640 while (UTF8_IS_CONTINUATION(*p)) {
5648 *offsetp = cache[0];
5650 /* Drop the stale "length" cache */
5658 ASSERT_UTF8_CACHE(cache);
5664 /* Call utf8n_to_uvchr() to validate the sequence
5665 * (unless a simple non-UTF character) */
5666 if (!UTF8_IS_INVARIANT(*s))
5667 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5676 if (!SvREADONLY(sv)) {
5678 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5679 mg = mg_find(sv, PERL_MAGIC_utf8);
5684 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5685 mg->mg_ptr = (char *) cache;
5690 cache[1] = *offsetp;
5691 /* Drop the stale "length" cache */
5704 Returns a boolean indicating whether the strings in the two SVs are
5705 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5706 coerce its args to strings if necessary.
5712 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5721 SV* svrecode = NULL;
5728 pv1 = SvPV_const(sv1, cur1);
5735 pv2 = SvPV_const(sv2, cur2);
5737 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5738 /* Differing utf8ness.
5739 * Do not UTF8size the comparands as a side-effect. */
5742 svrecode = newSVpvn(pv2, cur2);
5743 sv_recode_to_utf8(svrecode, PL_encoding);
5744 pv2 = SvPV_const(svrecode, cur2);
5747 svrecode = newSVpvn(pv1, cur1);
5748 sv_recode_to_utf8(svrecode, PL_encoding);
5749 pv1 = SvPV_const(svrecode, cur1);
5751 /* Now both are in UTF-8. */
5753 SvREFCNT_dec(svrecode);
5758 bool is_utf8 = TRUE;
5761 /* sv1 is the UTF-8 one,
5762 * if is equal it must be downgrade-able */
5763 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5769 /* sv2 is the UTF-8 one,
5770 * if is equal it must be downgrade-able */
5771 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5777 /* Downgrade not possible - cannot be eq */
5785 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5787 SvREFCNT_dec(svrecode);
5797 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5798 string in C<sv1> is less than, equal to, or greater than the string in
5799 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5800 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5806 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5810 const char *pv1, *pv2;
5813 SV *svrecode = NULL;
5820 pv1 = SvPV_const(sv1, cur1);
5827 pv2 = SvPV_const(sv2, cur2);
5829 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5830 /* Differing utf8ness.
5831 * Do not UTF8size the comparands as a side-effect. */
5834 svrecode = newSVpvn(pv2, cur2);
5835 sv_recode_to_utf8(svrecode, PL_encoding);
5836 pv2 = SvPV_const(svrecode, cur2);
5839 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5844 svrecode = newSVpvn(pv1, cur1);
5845 sv_recode_to_utf8(svrecode, PL_encoding);
5846 pv1 = SvPV_const(svrecode, cur1);
5849 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5855 cmp = cur2 ? -1 : 0;
5859 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5862 cmp = retval < 0 ? -1 : 1;
5863 } else if (cur1 == cur2) {
5866 cmp = cur1 < cur2 ? -1 : 1;
5870 SvREFCNT_dec(svrecode);
5878 =for apidoc sv_cmp_locale
5880 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5881 'use bytes' aware, handles get magic, and will coerce its args to strings
5882 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5888 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5891 #ifdef USE_LOCALE_COLLATE
5897 if (PL_collation_standard)
5901 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5903 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5905 if (!pv1 || !len1) {
5916 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5919 return retval < 0 ? -1 : 1;
5922 * When the result of collation is equality, that doesn't mean
5923 * that there are no differences -- some locales exclude some
5924 * characters from consideration. So to avoid false equalities,
5925 * we use the raw string as a tiebreaker.
5931 #endif /* USE_LOCALE_COLLATE */
5933 return sv_cmp(sv1, sv2);
5937 #ifdef USE_LOCALE_COLLATE
5940 =for apidoc sv_collxfrm
5942 Add Collate Transform magic to an SV if it doesn't already have it.
5944 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5945 scalar data of the variable, but transformed to such a format that a normal
5946 memory comparison can be used to compare the data according to the locale
5953 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5958 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5959 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5965 Safefree(mg->mg_ptr);
5966 s = SvPV_const(sv, len);
5967 if ((xf = mem_collxfrm(s, len, &xlen))) {
5968 if (SvREADONLY(sv)) {
5971 return xf + sizeof(PL_collation_ix);
5974 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5975 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5988 if (mg && mg->mg_ptr) {
5990 return mg->mg_ptr + sizeof(PL_collation_ix);
5998 #endif /* USE_LOCALE_COLLATE */
6003 Get a line from the filehandle and store it into the SV, optionally
6004 appending to the currently-stored string.
6010 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6015 register STDCHAR rslast;
6016 register STDCHAR *bp;
6022 if (SvTHINKFIRST(sv))
6023 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6024 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6026 However, perlbench says it's slower, because the existing swipe code
6027 is faster than copy on write.
6028 Swings and roundabouts. */
6029 SvUPGRADE(sv, SVt_PV);
6034 if (PerlIO_isutf8(fp)) {
6036 sv_utf8_upgrade_nomg(sv);
6037 sv_pos_u2b(sv,&append,0);
6039 } else if (SvUTF8(sv)) {
6040 SV * const tsv = newSV(0);
6041 sv_gets(tsv, fp, 0);
6042 sv_utf8_upgrade_nomg(tsv);
6043 SvCUR_set(sv,append);
6046 goto return_string_or_null;
6051 if (PerlIO_isutf8(fp))
6054 if (IN_PERL_COMPILETIME) {
6055 /* we always read code in line mode */
6059 else if (RsSNARF(PL_rs)) {
6060 /* If it is a regular disk file use size from stat() as estimate
6061 of amount we are going to read - may result in malloc-ing
6062 more memory than we realy need if layers bellow reduce
6063 size we read (e.g. CRLF or a gzip layer)
6066 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6067 const Off_t offset = PerlIO_tell(fp);
6068 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6069 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6075 else if (RsRECORD(PL_rs)) {
6079 /* Grab the size of the record we're getting */
6080 recsize = SvIV(SvRV(PL_rs));
6081 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6084 /* VMS wants read instead of fread, because fread doesn't respect */
6085 /* RMS record boundaries. This is not necessarily a good thing to be */
6086 /* doing, but we've got no other real choice - except avoid stdio
6087 as implementation - perhaps write a :vms layer ?
6089 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6091 bytesread = PerlIO_read(fp, buffer, recsize);
6095 SvCUR_set(sv, bytesread += append);
6096 buffer[bytesread] = '\0';
6097 goto return_string_or_null;
6099 else if (RsPARA(PL_rs)) {
6105 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6106 if (PerlIO_isutf8(fp)) {
6107 rsptr = SvPVutf8(PL_rs, rslen);
6110 if (SvUTF8(PL_rs)) {
6111 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6112 Perl_croak(aTHX_ "Wide character in $/");
6115 rsptr = SvPV_const(PL_rs, rslen);
6119 rslast = rslen ? rsptr[rslen - 1] : '\0';
6121 if (rspara) { /* have to do this both before and after */
6122 do { /* to make sure file boundaries work right */
6125 i = PerlIO_getc(fp);
6129 PerlIO_ungetc(fp,i);
6135 /* See if we know enough about I/O mechanism to cheat it ! */
6137 /* This used to be #ifdef test - it is made run-time test for ease
6138 of abstracting out stdio interface. One call should be cheap
6139 enough here - and may even be a macro allowing compile
6143 if (PerlIO_fast_gets(fp)) {
6146 * We're going to steal some values from the stdio struct
6147 * and put EVERYTHING in the innermost loop into registers.
6149 register STDCHAR *ptr;
6153 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6154 /* An ungetc()d char is handled separately from the regular
6155 * buffer, so we getc() it back out and stuff it in the buffer.
6157 i = PerlIO_getc(fp);
6158 if (i == EOF) return 0;
6159 *(--((*fp)->_ptr)) = (unsigned char) i;
6163 /* Here is some breathtakingly efficient cheating */
6165 cnt = PerlIO_get_cnt(fp); /* get count into register */
6166 /* make sure we have the room */
6167 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6168 /* Not room for all of it
6169 if we are looking for a separator and room for some
6171 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6172 /* just process what we have room for */
6173 shortbuffered = cnt - SvLEN(sv) + append + 1;
6174 cnt -= shortbuffered;
6178 /* remember that cnt can be negative */
6179 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6184 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6185 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6186 DEBUG_P(PerlIO_printf(Perl_debug_log,
6187 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6188 DEBUG_P(PerlIO_printf(Perl_debug_log,
6189 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6190 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6191 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6196 while (cnt > 0) { /* this | eat */
6198 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6199 goto thats_all_folks; /* screams | sed :-) */
6203 Copy(ptr, bp, cnt, char); /* this | eat */
6204 bp += cnt; /* screams | dust */
6205 ptr += cnt; /* louder | sed :-) */
6210 if (shortbuffered) { /* oh well, must extend */
6211 cnt = shortbuffered;
6213 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6215 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6216 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6220 DEBUG_P(PerlIO_printf(Perl_debug_log,
6221 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6222 PTR2UV(ptr),(long)cnt));
6223 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6225 DEBUG_P(PerlIO_printf(Perl_debug_log,
6226 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6227 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6228 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6230 /* This used to call 'filbuf' in stdio form, but as that behaves like
6231 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6232 another abstraction. */
6233 i = PerlIO_getc(fp); /* get more characters */
6235 DEBUG_P(PerlIO_printf(Perl_debug_log,
6236 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6237 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6238 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6240 cnt = PerlIO_get_cnt(fp);
6241 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6242 DEBUG_P(PerlIO_printf(Perl_debug_log,
6243 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6245 if (i == EOF) /* all done for ever? */
6246 goto thats_really_all_folks;
6248 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6250 SvGROW(sv, bpx + cnt + 2);
6251 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6253 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6255 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6256 goto thats_all_folks;
6260 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6261 memNE((char*)bp - rslen, rsptr, rslen))
6262 goto screamer; /* go back to the fray */
6263 thats_really_all_folks:
6265 cnt += shortbuffered;
6266 DEBUG_P(PerlIO_printf(Perl_debug_log,
6267 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6268 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6269 DEBUG_P(PerlIO_printf(Perl_debug_log,
6270 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6271 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6272 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6274 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6275 DEBUG_P(PerlIO_printf(Perl_debug_log,
6276 "Screamer: done, len=%ld, string=|%.*s|\n",
6277 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6281 /*The big, slow, and stupid way. */
6282 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6283 STDCHAR *buf = NULL;
6284 Newx(buf, 8192, STDCHAR);
6292 register const STDCHAR * const bpe = buf + sizeof(buf);
6294 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6295 ; /* keep reading */
6299 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6300 /* Accomodate broken VAXC compiler, which applies U8 cast to
6301 * both args of ?: operator, causing EOF to change into 255
6304 i = (U8)buf[cnt - 1];
6310 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6312 sv_catpvn(sv, (char *) buf, cnt);
6314 sv_setpvn(sv, (char *) buf, cnt);
6316 if (i != EOF && /* joy */
6318 SvCUR(sv) < rslen ||
6319 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6323 * If we're reading from a TTY and we get a short read,
6324 * indicating that the user hit his EOF character, we need
6325 * to notice it now, because if we try to read from the TTY
6326 * again, the EOF condition will disappear.
6328 * The comparison of cnt to sizeof(buf) is an optimization
6329 * that prevents unnecessary calls to feof().
6333 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6337 #ifdef USE_HEAP_INSTEAD_OF_STACK
6342 if (rspara) { /* have to do this both before and after */
6343 while (i != EOF) { /* to make sure file boundaries work right */
6344 i = PerlIO_getc(fp);
6346 PerlIO_ungetc(fp,i);
6352 return_string_or_null:
6353 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6359 Auto-increment of the value in the SV, doing string to numeric conversion
6360 if necessary. Handles 'get' magic.
6366 Perl_sv_inc(pTHX_ register SV *sv)
6375 if (SvTHINKFIRST(sv)) {
6377 sv_force_normal_flags(sv, 0);
6378 if (SvREADONLY(sv)) {
6379 if (IN_PERL_RUNTIME)
6380 Perl_croak(aTHX_ PL_no_modify);
6384 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6386 i = PTR2IV(SvRV(sv));
6391 flags = SvFLAGS(sv);
6392 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6393 /* It's (privately or publicly) a float, but not tested as an
6394 integer, so test it to see. */
6396 flags = SvFLAGS(sv);
6398 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6399 /* It's publicly an integer, or privately an integer-not-float */
6400 #ifdef PERL_PRESERVE_IVUV
6404 if (SvUVX(sv) == UV_MAX)
6405 sv_setnv(sv, UV_MAX_P1);
6407 (void)SvIOK_only_UV(sv);
6408 SvUV_set(sv, SvUVX(sv) + 1);
6410 if (SvIVX(sv) == IV_MAX)
6411 sv_setuv(sv, (UV)IV_MAX + 1);
6413 (void)SvIOK_only(sv);
6414 SvIV_set(sv, SvIVX(sv) + 1);
6419 if (flags & SVp_NOK) {
6420 (void)SvNOK_only(sv);
6421 SvNV_set(sv, SvNVX(sv) + 1.0);
6425 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6426 if ((flags & SVTYPEMASK) < SVt_PVIV)
6427 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6428 (void)SvIOK_only(sv);
6433 while (isALPHA(*d)) d++;
6434 while (isDIGIT(*d)) d++;
6436 #ifdef PERL_PRESERVE_IVUV
6437 /* Got to punt this as an integer if needs be, but we don't issue
6438 warnings. Probably ought to make the sv_iv_please() that does
6439 the conversion if possible, and silently. */
6440 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6441 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6442 /* Need to try really hard to see if it's an integer.
6443 9.22337203685478e+18 is an integer.
6444 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6445 so $a="9.22337203685478e+18"; $a+0; $a++
6446 needs to be the same as $a="9.22337203685478e+18"; $a++
6453 /* sv_2iv *should* have made this an NV */
6454 if (flags & SVp_NOK) {
6455 (void)SvNOK_only(sv);
6456 SvNV_set(sv, SvNVX(sv) + 1.0);
6459 /* I don't think we can get here. Maybe I should assert this
6460 And if we do get here I suspect that sv_setnv will croak. NWC
6462 #if defined(USE_LONG_DOUBLE)
6463 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",
6464 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6466 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6467 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6470 #endif /* PERL_PRESERVE_IVUV */
6471 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6475 while (d >= SvPVX_const(sv)) {
6483 /* MKS: The original code here died if letters weren't consecutive.
6484 * at least it didn't have to worry about non-C locales. The
6485 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6486 * arranged in order (although not consecutively) and that only
6487 * [A-Za-z] are accepted by isALPHA in the C locale.
6489 if (*d != 'z' && *d != 'Z') {
6490 do { ++*d; } while (!isALPHA(*d));
6493 *(d--) -= 'z' - 'a';
6498 *(d--) -= 'z' - 'a' + 1;
6502 /* oh,oh, the number grew */
6503 SvGROW(sv, SvCUR(sv) + 2);
6504 SvCUR_set(sv, SvCUR(sv) + 1);
6505 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6516 Auto-decrement of the value in the SV, doing string to numeric conversion
6517 if necessary. Handles 'get' magic.
6523 Perl_sv_dec(pTHX_ register SV *sv)
6531 if (SvTHINKFIRST(sv)) {
6533 sv_force_normal_flags(sv, 0);
6534 if (SvREADONLY(sv)) {
6535 if (IN_PERL_RUNTIME)
6536 Perl_croak(aTHX_ PL_no_modify);
6540 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6542 i = PTR2IV(SvRV(sv));
6547 /* Unlike sv_inc we don't have to worry about string-never-numbers
6548 and keeping them magic. But we mustn't warn on punting */
6549 flags = SvFLAGS(sv);
6550 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6551 /* It's publicly an integer, or privately an integer-not-float */
6552 #ifdef PERL_PRESERVE_IVUV
6556 if (SvUVX(sv) == 0) {
6557 (void)SvIOK_only(sv);
6561 (void)SvIOK_only_UV(sv);
6562 SvUV_set(sv, SvUVX(sv) - 1);
6565 if (SvIVX(sv) == IV_MIN)
6566 sv_setnv(sv, (NV)IV_MIN - 1.0);
6568 (void)SvIOK_only(sv);
6569 SvIV_set(sv, SvIVX(sv) - 1);
6574 if (flags & SVp_NOK) {
6575 SvNV_set(sv, SvNVX(sv) - 1.0);
6576 (void)SvNOK_only(sv);
6579 if (!(flags & SVp_POK)) {
6580 if ((flags & SVTYPEMASK) < SVt_PVIV)
6581 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6583 (void)SvIOK_only(sv);
6586 #ifdef PERL_PRESERVE_IVUV
6588 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6589 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6590 /* Need to try really hard to see if it's an integer.
6591 9.22337203685478e+18 is an integer.
6592 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6593 so $a="9.22337203685478e+18"; $a+0; $a--
6594 needs to be the same as $a="9.22337203685478e+18"; $a--
6601 /* sv_2iv *should* have made this an NV */
6602 if (flags & SVp_NOK) {
6603 (void)SvNOK_only(sv);
6604 SvNV_set(sv, SvNVX(sv) - 1.0);
6607 /* I don't think we can get here. Maybe I should assert this
6608 And if we do get here I suspect that sv_setnv will croak. NWC
6610 #if defined(USE_LONG_DOUBLE)
6611 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",
6612 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6614 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6615 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6619 #endif /* PERL_PRESERVE_IVUV */
6620 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6624 =for apidoc sv_mortalcopy
6626 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6627 The new SV is marked as mortal. It will be destroyed "soon", either by an
6628 explicit call to FREETMPS, or by an implicit call at places such as
6629 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6634 /* Make a string that will exist for the duration of the expression
6635 * evaluation. Actually, it may have to last longer than that, but
6636 * hopefully we won't free it until it has been assigned to a
6637 * permanent location. */
6640 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6646 sv_setsv(sv,oldstr);
6648 PL_tmps_stack[++PL_tmps_ix] = sv;
6654 =for apidoc sv_newmortal
6656 Creates a new null SV which is mortal. The reference count of the SV is
6657 set to 1. It will be destroyed "soon", either by an explicit call to
6658 FREETMPS, or by an implicit call at places such as statement boundaries.
6659 See also C<sv_mortalcopy> and C<sv_2mortal>.
6665 Perl_sv_newmortal(pTHX)
6671 SvFLAGS(sv) = SVs_TEMP;
6673 PL_tmps_stack[++PL_tmps_ix] = sv;
6678 =for apidoc sv_2mortal
6680 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6681 by an explicit call to FREETMPS, or by an implicit call at places such as
6682 statement boundaries. SvTEMP() is turned on which means that the SV's
6683 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6684 and C<sv_mortalcopy>.
6690 Perl_sv_2mortal(pTHX_ register SV *sv)
6695 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6698 PL_tmps_stack[++PL_tmps_ix] = sv;
6706 Creates a new SV and copies a string into it. The reference count for the
6707 SV is set to 1. If C<len> is zero, Perl will compute the length using
6708 strlen(). For efficiency, consider using C<newSVpvn> instead.
6714 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6720 sv_setpvn(sv,s,len ? len : strlen(s));
6725 =for apidoc newSVpvn
6727 Creates a new SV and copies a string into it. The reference count for the
6728 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6729 string. You are responsible for ensuring that the source string is at least
6730 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6736 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6742 sv_setpvn(sv,s,len);
6748 =for apidoc newSVhek
6750 Creates a new SV from the hash key structure. It will generate scalars that
6751 point to the shared string table where possible. Returns a new (undefined)
6752 SV if the hek is NULL.
6758 Perl_newSVhek(pTHX_ const HEK *hek)
6768 if (HEK_LEN(hek) == HEf_SVKEY) {
6769 return newSVsv(*(SV**)HEK_KEY(hek));
6771 const int flags = HEK_FLAGS(hek);
6772 if (flags & HVhek_WASUTF8) {
6774 Andreas would like keys he put in as utf8 to come back as utf8
6776 STRLEN utf8_len = HEK_LEN(hek);
6777 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6778 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6781 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6783 } else if (flags & HVhek_REHASH) {
6784 /* We don't have a pointer to the hv, so we have to replicate the
6785 flag into every HEK. This hv is using custom a hasing
6786 algorithm. Hence we can't return a shared string scalar, as
6787 that would contain the (wrong) hash value, and might get passed
6788 into an hv routine with a regular hash */
6790 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6795 /* This will be overwhelminly the most common case. */
6796 return newSVpvn_share(HEK_KEY(hek),
6797 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6803 =for apidoc newSVpvn_share
6805 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6806 table. If the string does not already exist in the table, it is created
6807 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6808 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6809 otherwise the hash is computed. The idea here is that as the string table
6810 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6811 hash lookup will avoid string compare.
6817 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6821 bool is_utf8 = FALSE;
6823 STRLEN tmplen = -len;
6825 /* See the note in hv.c:hv_fetch() --jhi */
6826 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6830 PERL_HASH(hash, src, len);
6832 sv_upgrade(sv, SVt_PV);
6833 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6845 #if defined(PERL_IMPLICIT_CONTEXT)
6847 /* pTHX_ magic can't cope with varargs, so this is a no-context
6848 * version of the main function, (which may itself be aliased to us).
6849 * Don't access this version directly.
6853 Perl_newSVpvf_nocontext(const char* pat, ...)
6858 va_start(args, pat);
6859 sv = vnewSVpvf(pat, &args);
6866 =for apidoc newSVpvf
6868 Creates a new SV and initializes it with the string formatted like
6875 Perl_newSVpvf(pTHX_ const char* pat, ...)
6879 va_start(args, pat);
6880 sv = vnewSVpvf(pat, &args);
6885 /* backend for newSVpvf() and newSVpvf_nocontext() */
6888 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6893 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
6900 Creates a new SV and copies a floating point value into it.
6901 The reference count for the SV is set to 1.
6907 Perl_newSVnv(pTHX_ NV n)
6920 Creates a new SV and copies an integer into it. The reference count for the
6927 Perl_newSViv(pTHX_ IV i)
6940 Creates a new SV and copies an unsigned integer into it.
6941 The reference count for the SV is set to 1.
6947 Perl_newSVuv(pTHX_ UV u)
6958 =for apidoc newRV_noinc
6960 Creates an RV wrapper for an SV. The reference count for the original
6961 SV is B<not> incremented.
6967 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6973 sv_upgrade(sv, SVt_RV);
6975 SvRV_set(sv, tmpRef);
6980 /* newRV_inc is the official function name to use now.
6981 * newRV_inc is in fact #defined to newRV in sv.h
6985 Perl_newRV(pTHX_ SV *sv)
6988 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
6994 Creates a new SV which is an exact duplicate of the original SV.
7001 Perl_newSVsv(pTHX_ register SV *old)
7008 if (SvTYPE(old) == SVTYPEMASK) {
7009 if (ckWARN_d(WARN_INTERNAL))
7010 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7014 /* SV_GMAGIC is the default for sv_setv()
7015 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7016 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7017 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7022 =for apidoc sv_reset
7024 Underlying implementation for the C<reset> Perl function.
7025 Note that the perl-level function is vaguely deprecated.
7031 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7034 char todo[PERL_UCHAR_MAX+1];
7039 if (!*s) { /* reset ?? searches */
7040 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7042 PMOP *pm = (PMOP *) mg->mg_obj;
7044 pm->op_pmdynflags &= ~PMdf_USED;
7051 /* reset variables */
7053 if (!HvARRAY(stash))
7056 Zero(todo, 256, char);
7059 I32 i = (unsigned char)*s;
7063 max = (unsigned char)*s++;
7064 for ( ; i <= max; i++) {
7067 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7069 for (entry = HvARRAY(stash)[i];
7071 entry = HeNEXT(entry))
7076 if (!todo[(U8)*HeKEY(entry)])
7078 gv = (GV*)HeVAL(entry);
7081 if (SvTHINKFIRST(sv)) {
7082 if (!SvREADONLY(sv) && SvROK(sv))
7084 /* XXX Is this continue a bug? Why should THINKFIRST
7085 exempt us from resetting arrays and hashes? */
7089 if (SvTYPE(sv) >= SVt_PV) {
7091 if (SvPVX_const(sv) != NULL)
7099 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7101 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7104 # if defined(USE_ENVIRON_ARRAY)
7107 # endif /* USE_ENVIRON_ARRAY */
7118 Using various gambits, try to get an IO from an SV: the IO slot if its a
7119 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7120 named after the PV if we're a string.
7126 Perl_sv_2io(pTHX_ SV *sv)
7131 switch (SvTYPE(sv)) {
7139 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7143 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7145 return sv_2io(SvRV(sv));
7146 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7152 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7161 Using various gambits, try to get a CV from an SV; in addition, try if
7162 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7163 The flags in C<lref> are passed to sv_fetchsv.
7169 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7180 switch (SvTYPE(sv)) {
7199 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7200 tryAMAGICunDEREF(to_cv);
7203 if (SvTYPE(sv) == SVt_PVCV) {
7212 Perl_croak(aTHX_ "Not a subroutine reference");
7217 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7223 /* Some flags to gv_fetchsv mean don't really create the GV */
7224 if (SvTYPE(gv) != SVt_PVGV) {
7230 if (lref && !GvCVu(gv)) {
7234 gv_efullname3(tmpsv, gv, NULL);
7235 /* XXX this is probably not what they think they're getting.
7236 * It has the same effect as "sub name;", i.e. just a forward
7238 newSUB(start_subparse(FALSE, 0),
7239 newSVOP(OP_CONST, 0, tmpsv),
7243 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7253 Returns true if the SV has a true value by Perl's rules.
7254 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7255 instead use an in-line version.
7261 Perl_sv_true(pTHX_ register SV *sv)
7266 register const XPV* const tXpv = (XPV*)SvANY(sv);
7268 (tXpv->xpv_cur > 1 ||
7269 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7276 return SvIVX(sv) != 0;
7279 return SvNVX(sv) != 0.0;
7281 return sv_2bool(sv);
7287 =for apidoc sv_pvn_force
7289 Get a sensible string out of the SV somehow.
7290 A private implementation of the C<SvPV_force> macro for compilers which
7291 can't cope with complex macro expressions. Always use the macro instead.
7293 =for apidoc sv_pvn_force_flags
7295 Get a sensible string out of the SV somehow.
7296 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7297 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7298 implemented in terms of this function.
7299 You normally want to use the various wrapper macros instead: see
7300 C<SvPV_force> and C<SvPV_force_nomg>
7306 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7309 if (SvTHINKFIRST(sv) && !SvROK(sv))
7310 sv_force_normal_flags(sv, 0);
7320 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7321 const char * const ref = sv_reftype(sv,0);
7323 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7324 ref, OP_NAME(PL_op));
7326 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7328 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7329 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7331 s = sv_2pv_flags(sv, &len, flags);
7335 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7338 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7339 SvGROW(sv, len + 1);
7340 Move(s,SvPVX(sv),len,char);
7345 SvPOK_on(sv); /* validate pointer */
7347 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7348 PTR2UV(sv),SvPVX_const(sv)));
7351 return SvPVX_mutable(sv);
7355 =for apidoc sv_pvbyten_force
7357 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7363 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7365 sv_pvn_force(sv,lp);
7366 sv_utf8_downgrade(sv,0);
7372 =for apidoc sv_pvutf8n_force
7374 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7380 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7382 sv_pvn_force(sv,lp);
7383 sv_utf8_upgrade(sv);
7389 =for apidoc sv_reftype
7391 Returns a string describing what the SV is a reference to.
7397 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7399 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7400 inside return suggests a const propagation bug in g++. */
7401 if (ob && SvOBJECT(sv)) {
7402 char * const name = HvNAME_get(SvSTASH(sv));
7403 return name ? name : (char *) "__ANON__";
7406 switch (SvTYPE(sv)) {
7423 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7424 /* tied lvalues should appear to be
7425 * scalars for backwards compatitbility */
7426 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7427 ? "SCALAR" : "LVALUE");
7428 case SVt_PVAV: return "ARRAY";
7429 case SVt_PVHV: return "HASH";
7430 case SVt_PVCV: return "CODE";
7431 case SVt_PVGV: return "GLOB";
7432 case SVt_PVFM: return "FORMAT";
7433 case SVt_PVIO: return "IO";
7434 default: return "UNKNOWN";
7440 =for apidoc sv_isobject
7442 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7443 object. If the SV is not an RV, or if the object is not blessed, then this
7450 Perl_sv_isobject(pTHX_ SV *sv)
7466 Returns a boolean indicating whether the SV is blessed into the specified
7467 class. This does not check for subtypes; use C<sv_derived_from> to verify
7468 an inheritance relationship.
7474 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7485 hvname = HvNAME_get(SvSTASH(sv));
7489 return strEQ(hvname, name);
7495 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7496 it will be upgraded to one. If C<classname> is non-null then the new SV will
7497 be blessed in the specified package. The new SV is returned and its
7498 reference count is 1.
7504 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7511 SV_CHECK_THINKFIRST_COW_DROP(rv);
7514 if (SvTYPE(rv) >= SVt_PVMG) {
7515 const U32 refcnt = SvREFCNT(rv);
7519 SvREFCNT(rv) = refcnt;
7522 if (SvTYPE(rv) < SVt_RV)
7523 sv_upgrade(rv, SVt_RV);
7524 else if (SvTYPE(rv) > SVt_RV) {
7535 HV* const stash = gv_stashpv(classname, TRUE);
7536 (void)sv_bless(rv, stash);
7542 =for apidoc sv_setref_pv
7544 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7545 argument will be upgraded to an RV. That RV will be modified to point to
7546 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7547 into the SV. The C<classname> argument indicates the package for the
7548 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7549 will have a reference count of 1, and the RV will be returned.
7551 Do not use with other Perl types such as HV, AV, SV, CV, because those
7552 objects will become corrupted by the pointer copy process.
7554 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7560 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7564 sv_setsv(rv, &PL_sv_undef);
7568 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7573 =for apidoc sv_setref_iv
7575 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7576 argument will be upgraded to an RV. That RV will be modified to point to
7577 the new SV. The C<classname> argument indicates the package for the
7578 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7579 will have a reference count of 1, and the RV will be returned.
7585 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7587 sv_setiv(newSVrv(rv,classname), iv);
7592 =for apidoc sv_setref_uv
7594 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7595 argument will be upgraded to an RV. That RV will be modified to point to
7596 the new SV. The C<classname> argument indicates the package for the
7597 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7598 will have a reference count of 1, and the RV will be returned.
7604 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7606 sv_setuv(newSVrv(rv,classname), uv);
7611 =for apidoc sv_setref_nv
7613 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7614 argument will be upgraded to an RV. That RV will be modified to point to
7615 the new SV. The C<classname> argument indicates the package for the
7616 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7617 will have a reference count of 1, and the RV will be returned.
7623 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7625 sv_setnv(newSVrv(rv,classname), nv);
7630 =for apidoc sv_setref_pvn
7632 Copies a string into a new SV, optionally blessing the SV. The length of the
7633 string must be specified with C<n>. The C<rv> argument will be upgraded to
7634 an RV. That RV will be modified to point to the new SV. The C<classname>
7635 argument indicates the package for the blessing. Set C<classname> to
7636 C<NULL> to avoid the blessing. The new SV will have a reference count
7637 of 1, and the RV will be returned.
7639 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7645 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7647 sv_setpvn(newSVrv(rv,classname), pv, n);
7652 =for apidoc sv_bless
7654 Blesses an SV into a specified package. The SV must be an RV. The package
7655 must be designated by its stash (see C<gv_stashpv()>). The reference count
7656 of the SV is unaffected.
7662 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7667 Perl_croak(aTHX_ "Can't bless non-reference value");
7669 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7670 if (SvREADONLY(tmpRef))
7671 Perl_croak(aTHX_ PL_no_modify);
7672 if (SvOBJECT(tmpRef)) {
7673 if (SvTYPE(tmpRef) != SVt_PVIO)
7675 SvREFCNT_dec(SvSTASH(tmpRef));
7678 SvOBJECT_on(tmpRef);
7679 if (SvTYPE(tmpRef) != SVt_PVIO)
7681 SvUPGRADE(tmpRef, SVt_PVMG);
7682 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7689 if(SvSMAGICAL(tmpRef))
7690 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7698 /* Downgrades a PVGV to a PVMG.
7702 S_sv_unglob(pTHX_ SV *sv)
7706 SV * const temp = sv_newmortal();
7708 assert(SvTYPE(sv) == SVt_PVGV);
7710 gv_efullname3(temp, (GV *) sv, "*");
7716 sv_del_backref((SV*)GvSTASH(sv), sv);
7720 if (GvNAME_HEK(sv)) {
7721 unshare_hek(GvNAME_HEK(sv));
7725 /* need to keep SvANY(sv) in the right arena */
7726 xpvmg = new_XPVMG();
7727 StructCopy(SvANY(sv), xpvmg, XPVMG);
7728 del_XPVGV(SvANY(sv));
7731 SvFLAGS(sv) &= ~SVTYPEMASK;
7732 SvFLAGS(sv) |= SVt_PVMG;
7734 /* Intentionally not calling any local SET magic, as this isn't so much a
7735 set operation as merely an internal storage change. */
7736 sv_setsv_flags(sv, temp, 0);
7740 =for apidoc sv_unref_flags
7742 Unsets the RV status of the SV, and decrements the reference count of
7743 whatever was being referenced by the RV. This can almost be thought of
7744 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7745 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7746 (otherwise the decrementing is conditional on the reference count being
7747 different from one or the reference being a readonly SV).
7754 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7756 SV* const target = SvRV(ref);
7758 if (SvWEAKREF(ref)) {
7759 sv_del_backref(target, ref);
7761 SvRV_set(ref, NULL);
7764 SvRV_set(ref, NULL);
7766 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7767 assigned to as BEGIN {$a = \"Foo"} will fail. */
7768 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7769 SvREFCNT_dec(target);
7770 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7771 sv_2mortal(target); /* Schedule for freeing later */
7775 =for apidoc sv_untaint
7777 Untaint an SV. Use C<SvTAINTED_off> instead.
7782 Perl_sv_untaint(pTHX_ SV *sv)
7784 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7785 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7792 =for apidoc sv_tainted
7794 Test an SV for taintedness. Use C<SvTAINTED> instead.
7799 Perl_sv_tainted(pTHX_ SV *sv)
7801 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7802 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7803 if (mg && (mg->mg_len & 1) )
7810 =for apidoc sv_setpviv
7812 Copies an integer into the given SV, also updating its string value.
7813 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7819 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7821 char buf[TYPE_CHARS(UV)];
7823 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7825 sv_setpvn(sv, ptr, ebuf - ptr);
7829 =for apidoc sv_setpviv_mg
7831 Like C<sv_setpviv>, but also handles 'set' magic.
7837 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7843 #if defined(PERL_IMPLICIT_CONTEXT)
7845 /* pTHX_ magic can't cope with varargs, so this is a no-context
7846 * version of the main function, (which may itself be aliased to us).
7847 * Don't access this version directly.
7851 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7855 va_start(args, pat);
7856 sv_vsetpvf(sv, pat, &args);
7860 /* pTHX_ magic can't cope with varargs, so this is a no-context
7861 * version of the main function, (which may itself be aliased to us).
7862 * Don't access this version directly.
7866 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7870 va_start(args, pat);
7871 sv_vsetpvf_mg(sv, pat, &args);
7877 =for apidoc sv_setpvf
7879 Works like C<sv_catpvf> but copies the text into the SV instead of
7880 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7886 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7889 va_start(args, pat);
7890 sv_vsetpvf(sv, pat, &args);
7895 =for apidoc sv_vsetpvf
7897 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7898 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7900 Usually used via its frontend C<sv_setpvf>.
7906 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7908 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7912 =for apidoc sv_setpvf_mg
7914 Like C<sv_setpvf>, but also handles 'set' magic.
7920 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7923 va_start(args, pat);
7924 sv_vsetpvf_mg(sv, pat, &args);
7929 =for apidoc sv_vsetpvf_mg
7931 Like C<sv_vsetpvf>, but also handles 'set' magic.
7933 Usually used via its frontend C<sv_setpvf_mg>.
7939 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7941 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7945 #if defined(PERL_IMPLICIT_CONTEXT)
7947 /* pTHX_ magic can't cope with varargs, so this is a no-context
7948 * version of the main function, (which may itself be aliased to us).
7949 * Don't access this version directly.
7953 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7957 va_start(args, pat);
7958 sv_vcatpvf(sv, pat, &args);
7962 /* pTHX_ magic can't cope with varargs, so this is a no-context
7963 * version of the main function, (which may itself be aliased to us).
7964 * Don't access this version directly.
7968 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7972 va_start(args, pat);
7973 sv_vcatpvf_mg(sv, pat, &args);
7979 =for apidoc sv_catpvf
7981 Processes its arguments like C<sprintf> and appends the formatted
7982 output to an SV. If the appended data contains "wide" characters
7983 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7984 and characters >255 formatted with %c), the original SV might get
7985 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7986 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7987 valid UTF-8; if the original SV was bytes, the pattern should be too.
7992 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7995 va_start(args, pat);
7996 sv_vcatpvf(sv, pat, &args);
8001 =for apidoc sv_vcatpvf
8003 Processes its arguments like C<vsprintf> and appends the formatted output
8004 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8006 Usually used via its frontend C<sv_catpvf>.
8012 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8014 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8018 =for apidoc sv_catpvf_mg
8020 Like C<sv_catpvf>, but also handles 'set' magic.
8026 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8029 va_start(args, pat);
8030 sv_vcatpvf_mg(sv, pat, &args);
8035 =for apidoc sv_vcatpvf_mg
8037 Like C<sv_vcatpvf>, but also handles 'set' magic.
8039 Usually used via its frontend C<sv_catpvf_mg>.
8045 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8047 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8052 =for apidoc sv_vsetpvfn
8054 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8057 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8063 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8065 sv_setpvn(sv, "", 0);
8066 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8070 S_expect_number(pTHX_ char** pattern)
8074 switch (**pattern) {
8075 case '1': case '2': case '3':
8076 case '4': case '5': case '6':
8077 case '7': case '8': case '9':
8078 var = *(*pattern)++ - '0';
8079 while (isDIGIT(**pattern)) {
8080 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8082 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8090 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8092 const int neg = nv < 0;
8101 if (uv & 1 && uv == nv)
8102 uv--; /* Round to even */
8104 const unsigned dig = uv % 10;
8117 =for apidoc sv_vcatpvfn
8119 Processes its arguments like C<vsprintf> and appends the formatted output
8120 to an SV. Uses an array of SVs if the C style variable argument list is
8121 missing (NULL). When running with taint checks enabled, indicates via
8122 C<maybe_tainted> if results are untrustworthy (often due to the use of
8125 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8131 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8132 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8133 vec_utf8 = DO_UTF8(vecsv);
8135 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8138 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8146 static const char nullstr[] = "(null)";
8148 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8149 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8151 /* Times 4: a decimal digit takes more than 3 binary digits.
8152 * NV_DIG: mantissa takes than many decimal digits.
8153 * Plus 32: Playing safe. */
8154 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8155 /* large enough for "%#.#f" --chip */
8156 /* what about long double NVs? --jhi */
8158 PERL_UNUSED_ARG(maybe_tainted);
8160 /* no matter what, this is a string now */
8161 (void)SvPV_force(sv, origlen);
8163 /* special-case "", "%s", and "%-p" (SVf - see below) */
8166 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8168 const char * const s = va_arg(*args, char*);
8169 sv_catpv(sv, s ? s : nullstr);
8171 else if (svix < svmax) {
8172 sv_catsv(sv, *svargs);
8176 if (args && patlen == 3 && pat[0] == '%' &&
8177 pat[1] == '-' && pat[2] == 'p') {
8178 argsv = va_arg(*args, SV*);
8179 sv_catsv(sv, argsv);
8183 #ifndef USE_LONG_DOUBLE
8184 /* special-case "%.<number>[gf]" */
8185 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8186 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8187 unsigned digits = 0;
8191 while (*pp >= '0' && *pp <= '9')
8192 digits = 10 * digits + (*pp++ - '0');
8193 if (pp - pat == (int)patlen - 1) {
8201 /* Add check for digits != 0 because it seems that some
8202 gconverts are buggy in this case, and we don't yet have
8203 a Configure test for this. */
8204 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8205 /* 0, point, slack */
8206 Gconvert(nv, (int)digits, 0, ebuf);
8208 if (*ebuf) /* May return an empty string for digits==0 */
8211 } else if (!digits) {
8214 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8215 sv_catpvn(sv, p, l);
8221 #endif /* !USE_LONG_DOUBLE */
8223 if (!args && svix < svmax && DO_UTF8(*svargs))
8226 patend = (char*)pat + patlen;
8227 for (p = (char*)pat; p < patend; p = q) {
8230 bool vectorize = FALSE;
8231 bool vectorarg = FALSE;
8232 bool vec_utf8 = FALSE;
8238 bool has_precis = FALSE;
8240 const I32 osvix = svix;
8241 bool is_utf8 = FALSE; /* is this item utf8? */
8242 #ifdef HAS_LDBL_SPRINTF_BUG
8243 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8244 with sfio - Allen <allens@cpan.org> */
8245 bool fix_ldbl_sprintf_bug = FALSE;
8249 U8 utf8buf[UTF8_MAXBYTES+1];
8250 STRLEN esignlen = 0;
8252 const char *eptr = NULL;
8255 const U8 *vecstr = NULL;
8262 /* we need a long double target in case HAS_LONG_DOUBLE but
8265 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8273 const char *dotstr = ".";
8274 STRLEN dotstrlen = 1;
8275 I32 efix = 0; /* explicit format parameter index */
8276 I32 ewix = 0; /* explicit width index */
8277 I32 epix = 0; /* explicit precision index */
8278 I32 evix = 0; /* explicit vector index */
8279 bool asterisk = FALSE;
8281 /* echo everything up to the next format specification */
8282 for (q = p; q < patend && *q != '%'; ++q) ;
8284 if (has_utf8 && !pat_utf8)
8285 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8287 sv_catpvn(sv, p, q - p);
8294 We allow format specification elements in this order:
8295 \d+\$ explicit format parameter index
8297 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8298 0 flag (as above): repeated to allow "v02"
8299 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8300 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8302 [%bcdefginopsuxDFOUX] format (mandatory)
8307 As of perl5.9.3, printf format checking is on by default.
8308 Internally, perl uses %p formats to provide an escape to
8309 some extended formatting. This block deals with those
8310 extensions: if it does not match, (char*)q is reset and
8311 the normal format processing code is used.
8313 Currently defined extensions are:
8314 %p include pointer address (standard)
8315 %-p (SVf) include an SV (previously %_)
8316 %-<num>p include an SV with precision <num>
8317 %1p (VDf) include a v-string (as %vd)
8318 %<num>p reserved for future extensions
8320 Robin Barker 2005-07-14
8327 n = expect_number(&q);
8334 argsv = va_arg(*args, SV*);
8335 eptr = SvPVx_const(argsv, elen);
8341 else if (n == vdNUMBER) { /* VDf */
8348 if (ckWARN_d(WARN_INTERNAL))
8349 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8350 "internal %%<num>p might conflict with future printf extensions");
8356 if ( (width = expect_number(&q)) ) {
8397 if ( (ewix = expect_number(&q)) )
8406 if ((vectorarg = asterisk)) {
8419 width = expect_number(&q);
8425 vecsv = va_arg(*args, SV*);
8427 vecsv = (evix > 0 && evix <= svmax)
8428 ? svargs[evix-1] : &PL_sv_undef;
8430 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8432 dotstr = SvPV_const(vecsv, dotstrlen);
8433 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8434 bad with tied or overloaded values that return UTF8. */
8437 else if (has_utf8) {
8438 vecsv = sv_mortalcopy(vecsv);
8439 sv_utf8_upgrade(vecsv);
8440 dotstr = SvPV_const(vecsv, dotstrlen);
8447 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8448 vecsv = svargs[efix ? efix-1 : svix++];
8449 vecstr = (U8*)SvPV_const(vecsv,veclen);
8450 vec_utf8 = DO_UTF8(vecsv);
8452 /* if this is a version object, we need to convert
8453 * back into v-string notation and then let the
8454 * vectorize happen normally
8456 if (sv_derived_from(vecsv, "version")) {
8457 char *version = savesvpv(vecsv);
8458 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8459 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8460 "vector argument not supported with alpha versions");
8463 vecsv = sv_newmortal();
8464 /* scan_vstring is expected to be called during
8465 * tokenization, so we need to fake up the end
8466 * of the buffer for it
8468 PL_bufend = version + veclen;
8469 scan_vstring(version, vecsv);
8470 vecstr = (U8*)SvPV_const(vecsv, veclen);
8471 vec_utf8 = DO_UTF8(vecsv);
8483 i = va_arg(*args, int);
8485 i = (ewix ? ewix <= svmax : svix < svmax) ?
8486 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8488 width = (i < 0) ? -i : i;
8498 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8500 /* XXX: todo, support specified precision parameter */
8504 i = va_arg(*args, int);
8506 i = (ewix ? ewix <= svmax : svix < svmax)
8507 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8508 precis = (i < 0) ? 0 : i;
8513 precis = precis * 10 + (*q++ - '0');
8522 case 'I': /* Ix, I32x, and I64x */
8524 if (q[1] == '6' && q[2] == '4') {
8530 if (q[1] == '3' && q[2] == '2') {
8540 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8551 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8552 if (*(q + 1) == 'l') { /* lld, llf */
8578 if (!vectorize && !args) {
8580 const I32 i = efix-1;
8581 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8583 argsv = (svix >= 0 && svix < svmax)
8584 ? svargs[svix++] : &PL_sv_undef;
8595 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8597 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8599 eptr = (char*)utf8buf;
8600 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8614 eptr = va_arg(*args, char*);
8616 #ifdef MACOS_TRADITIONAL
8617 /* On MacOS, %#s format is used for Pascal strings */
8622 elen = strlen(eptr);
8624 eptr = (char *)nullstr;
8625 elen = sizeof nullstr - 1;
8629 eptr = SvPVx_const(argsv, elen);
8630 if (DO_UTF8(argsv)) {
8631 if (has_precis && precis < elen) {
8633 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8636 if (width) { /* fudge width (can't fudge elen) */
8637 width += elen - sv_len_utf8(argsv);
8644 if (has_precis && elen > precis)
8651 if (alt || vectorize)
8653 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8674 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8683 esignbuf[esignlen++] = plus;
8687 case 'h': iv = (short)va_arg(*args, int); break;
8688 case 'l': iv = va_arg(*args, long); break;
8689 case 'V': iv = va_arg(*args, IV); break;
8690 default: iv = va_arg(*args, int); break;
8692 case 'q': iv = va_arg(*args, Quad_t); break;
8697 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8699 case 'h': iv = (short)tiv; break;
8700 case 'l': iv = (long)tiv; break;
8702 default: iv = tiv; break;
8704 case 'q': iv = (Quad_t)tiv; break;
8708 if ( !vectorize ) /* we already set uv above */
8713 esignbuf[esignlen++] = plus;
8717 esignbuf[esignlen++] = '-';
8760 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8771 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8772 case 'l': uv = va_arg(*args, unsigned long); break;
8773 case 'V': uv = va_arg(*args, UV); break;
8774 default: uv = va_arg(*args, unsigned); break;
8776 case 'q': uv = va_arg(*args, Uquad_t); break;
8781 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8783 case 'h': uv = (unsigned short)tuv; break;
8784 case 'l': uv = (unsigned long)tuv; break;
8786 default: uv = tuv; break;
8788 case 'q': uv = (Uquad_t)tuv; break;
8795 char *ptr = ebuf + sizeof ebuf;
8801 p = (char*)((c == 'X')
8802 ? "0123456789ABCDEF" : "0123456789abcdef");
8808 esignbuf[esignlen++] = '0';
8809 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8817 if (alt && *ptr != '0')
8828 esignbuf[esignlen++] = '0';
8829 esignbuf[esignlen++] = 'b';
8832 default: /* it had better be ten or less */
8836 } while (uv /= base);
8839 elen = (ebuf + sizeof ebuf) - ptr;
8843 zeros = precis - elen;
8844 else if (precis == 0 && elen == 1 && *eptr == '0')
8850 /* FLOATING POINT */
8853 c = 'f'; /* maybe %F isn't supported here */
8861 /* This is evil, but floating point is even more evil */
8863 /* for SV-style calling, we can only get NV
8864 for C-style calling, we assume %f is double;
8865 for simplicity we allow any of %Lf, %llf, %qf for long double
8869 #if defined(USE_LONG_DOUBLE)
8873 /* [perl #20339] - we should accept and ignore %lf rather than die */
8877 #if defined(USE_LONG_DOUBLE)
8878 intsize = args ? 0 : 'q';
8882 #if defined(HAS_LONG_DOUBLE)
8891 /* now we need (long double) if intsize == 'q', else (double) */
8893 #if LONG_DOUBLESIZE > DOUBLESIZE
8895 va_arg(*args, long double) :
8896 va_arg(*args, double)
8898 va_arg(*args, double)
8903 if (c != 'e' && c != 'E') {
8905 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8906 will cast our (long double) to (double) */
8907 (void)Perl_frexp(nv, &i);
8908 if (i == PERL_INT_MIN)
8909 Perl_die(aTHX_ "panic: frexp");
8911 need = BIT_DIGITS(i);
8913 need += has_precis ? precis : 6; /* known default */
8918 #ifdef HAS_LDBL_SPRINTF_BUG
8919 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8920 with sfio - Allen <allens@cpan.org> */
8923 # define MY_DBL_MAX DBL_MAX
8924 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8925 # if DOUBLESIZE >= 8
8926 # define MY_DBL_MAX 1.7976931348623157E+308L
8928 # define MY_DBL_MAX 3.40282347E+38L
8932 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8933 # define MY_DBL_MAX_BUG 1L
8935 # define MY_DBL_MAX_BUG MY_DBL_MAX
8939 # define MY_DBL_MIN DBL_MIN
8940 # else /* XXX guessing! -Allen */
8941 # if DOUBLESIZE >= 8
8942 # define MY_DBL_MIN 2.2250738585072014E-308L
8944 # define MY_DBL_MIN 1.17549435E-38L
8948 if ((intsize == 'q') && (c == 'f') &&
8949 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8951 /* it's going to be short enough that
8952 * long double precision is not needed */
8954 if ((nv <= 0L) && (nv >= -0L))
8955 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8957 /* would use Perl_fp_class as a double-check but not
8958 * functional on IRIX - see perl.h comments */
8960 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8961 /* It's within the range that a double can represent */
8962 #if defined(DBL_MAX) && !defined(DBL_MIN)
8963 if ((nv >= ((long double)1/DBL_MAX)) ||
8964 (nv <= (-(long double)1/DBL_MAX)))
8966 fix_ldbl_sprintf_bug = TRUE;
8969 if (fix_ldbl_sprintf_bug == TRUE) {
8979 # undef MY_DBL_MAX_BUG
8982 #endif /* HAS_LDBL_SPRINTF_BUG */
8984 need += 20; /* fudge factor */
8985 if (PL_efloatsize < need) {
8986 Safefree(PL_efloatbuf);
8987 PL_efloatsize = need + 20; /* more fudge */
8988 Newx(PL_efloatbuf, PL_efloatsize, char);
8989 PL_efloatbuf[0] = '\0';
8992 if ( !(width || left || plus || alt) && fill != '0'
8993 && has_precis && intsize != 'q' ) { /* Shortcuts */
8994 /* See earlier comment about buggy Gconvert when digits,
8996 if ( c == 'g' && precis) {
8997 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8998 /* May return an empty string for digits==0 */
8999 if (*PL_efloatbuf) {
9000 elen = strlen(PL_efloatbuf);
9001 goto float_converted;
9003 } else if ( c == 'f' && !precis) {
9004 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9009 char *ptr = ebuf + sizeof ebuf;
9012 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9013 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9014 if (intsize == 'q') {
9015 /* Copy the one or more characters in a long double
9016 * format before the 'base' ([efgEFG]) character to
9017 * the format string. */
9018 static char const prifldbl[] = PERL_PRIfldbl;
9019 char const *p = prifldbl + sizeof(prifldbl) - 3;
9020 while (p >= prifldbl) { *--ptr = *p--; }
9025 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9030 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9042 /* No taint. Otherwise we are in the strange situation
9043 * where printf() taints but print($float) doesn't.
9045 #if defined(HAS_LONG_DOUBLE)
9046 elen = ((intsize == 'q')
9047 ? my_sprintf(PL_efloatbuf, ptr, nv)
9048 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9050 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9054 eptr = PL_efloatbuf;
9062 i = SvCUR(sv) - origlen;
9065 case 'h': *(va_arg(*args, short*)) = i; break;
9066 default: *(va_arg(*args, int*)) = i; break;
9067 case 'l': *(va_arg(*args, long*)) = i; break;
9068 case 'V': *(va_arg(*args, IV*)) = i; break;
9070 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9075 sv_setuv_mg(argsv, (UV)i);
9076 continue; /* not "break" */
9083 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9084 && ckWARN(WARN_PRINTF))
9086 SV * const msg = sv_newmortal();
9087 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9088 (PL_op->op_type == OP_PRTF) ? "" : "s");
9091 Perl_sv_catpvf(aTHX_ msg,
9092 "\"%%%c\"", c & 0xFF);
9094 Perl_sv_catpvf(aTHX_ msg,
9095 "\"%%\\%03"UVof"\"",
9098 sv_catpvs(msg, "end of string");
9099 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9102 /* output mangled stuff ... */
9108 /* ... right here, because formatting flags should not apply */
9109 SvGROW(sv, SvCUR(sv) + elen + 1);
9111 Copy(eptr, p, elen, char);
9114 SvCUR_set(sv, p - SvPVX_const(sv));
9116 continue; /* not "break" */
9119 /* calculate width before utf8_upgrade changes it */
9120 have = esignlen + zeros + elen;
9122 Perl_croak_nocontext(PL_memory_wrap);
9124 if (is_utf8 != has_utf8) {
9127 sv_utf8_upgrade(sv);
9130 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9131 sv_utf8_upgrade(nsv);
9132 eptr = SvPVX_const(nsv);
9135 SvGROW(sv, SvCUR(sv) + elen + 1);
9140 need = (have > width ? have : width);
9143 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9144 Perl_croak_nocontext(PL_memory_wrap);
9145 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9147 if (esignlen && fill == '0') {
9149 for (i = 0; i < (int)esignlen; i++)
9153 memset(p, fill, gap);
9156 if (esignlen && fill != '0') {
9158 for (i = 0; i < (int)esignlen; i++)
9163 for (i = zeros; i; i--)
9167 Copy(eptr, p, elen, char);
9171 memset(p, ' ', gap);
9176 Copy(dotstr, p, dotstrlen, char);
9180 vectorize = FALSE; /* done iterating over vecstr */
9187 SvCUR_set(sv, p - SvPVX_const(sv));
9195 /* =========================================================================
9197 =head1 Cloning an interpreter
9199 All the macros and functions in this section are for the private use of
9200 the main function, perl_clone().
9202 The foo_dup() functions make an exact copy of an existing foo thinngy.
9203 During the course of a cloning, a hash table is used to map old addresses
9204 to new addresses. The table is created and manipulated with the
9205 ptr_table_* functions.
9209 ============================================================================*/
9212 #if defined(USE_ITHREADS)
9214 #ifndef GpREFCNT_inc
9215 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9219 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9220 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9221 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9222 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9223 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9224 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9225 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9226 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9227 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9228 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9229 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9230 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9231 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9232 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9235 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9236 regcomp.c. AMS 20010712 */
9239 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9244 struct reg_substr_datum *s;
9247 return (REGEXP *)NULL;
9249 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9252 len = r->offsets[0];
9253 npar = r->nparens+1;
9255 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9256 Copy(r->program, ret->program, len+1, regnode);
9258 Newx(ret->startp, npar, I32);
9259 Copy(r->startp, ret->startp, npar, I32);
9260 Newx(ret->endp, npar, I32);
9261 Copy(r->startp, ret->startp, npar, I32);
9263 Newx(ret->substrs, 1, struct reg_substr_data);
9264 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9265 s->min_offset = r->substrs->data[i].min_offset;
9266 s->max_offset = r->substrs->data[i].max_offset;
9267 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9268 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9271 ret->regstclass = NULL;
9274 const int count = r->data->count;
9277 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9278 char, struct reg_data);
9279 Newx(d->what, count, U8);
9282 for (i = 0; i < count; i++) {
9283 d->what[i] = r->data->what[i];
9284 switch (d->what[i]) {
9285 /* legal options are one of: sfpont
9286 see also regcomp.h and pregfree() */
9288 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9291 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9294 /* This is cheating. */
9295 Newx(d->data[i], 1, struct regnode_charclass_class);
9296 StructCopy(r->data->data[i], d->data[i],
9297 struct regnode_charclass_class);
9298 ret->regstclass = (regnode*)d->data[i];
9301 /* Compiled op trees are readonly, and can thus be
9302 shared without duplication. */
9304 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9308 d->data[i] = r->data->data[i];
9311 d->data[i] = r->data->data[i];
9313 ((reg_trie_data*)d->data[i])->refcount++;
9317 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9326 Newx(ret->offsets, 2*len+1, U32);
9327 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9329 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9330 ret->refcnt = r->refcnt;
9331 ret->minlen = r->minlen;
9332 ret->prelen = r->prelen;
9333 ret->nparens = r->nparens;
9334 ret->lastparen = r->lastparen;
9335 ret->lastcloseparen = r->lastcloseparen;
9336 ret->reganch = r->reganch;
9338 ret->sublen = r->sublen;
9340 if (RX_MATCH_COPIED(ret))
9341 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9344 #ifdef PERL_OLD_COPY_ON_WRITE
9345 ret->saved_copy = NULL;
9348 ptr_table_store(PL_ptr_table, r, ret);
9352 /* duplicate a file handle */
9355 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9359 PERL_UNUSED_ARG(type);
9362 return (PerlIO*)NULL;
9364 /* look for it in the table first */
9365 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9369 /* create anew and remember what it is */
9370 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9371 ptr_table_store(PL_ptr_table, fp, ret);
9375 /* duplicate a directory handle */
9378 Perl_dirp_dup(pTHX_ DIR *dp)
9380 PERL_UNUSED_CONTEXT;
9387 /* duplicate a typeglob */
9390 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9396 /* look for it in the table first */
9397 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9401 /* create anew and remember what it is */
9403 ptr_table_store(PL_ptr_table, gp, ret);
9406 ret->gp_refcnt = 0; /* must be before any other dups! */
9407 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9408 ret->gp_io = io_dup_inc(gp->gp_io, param);
9409 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9410 ret->gp_av = av_dup_inc(gp->gp_av, param);
9411 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9412 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9413 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9414 ret->gp_cvgen = gp->gp_cvgen;
9415 ret->gp_line = gp->gp_line;
9416 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9420 /* duplicate a chain of magic */
9423 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9425 MAGIC *mgprev = (MAGIC*)NULL;
9428 return (MAGIC*)NULL;
9429 /* look for it in the table first */
9430 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9434 for (; mg; mg = mg->mg_moremagic) {
9436 Newxz(nmg, 1, MAGIC);
9438 mgprev->mg_moremagic = nmg;
9441 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9442 nmg->mg_private = mg->mg_private;
9443 nmg->mg_type = mg->mg_type;
9444 nmg->mg_flags = mg->mg_flags;
9445 if (mg->mg_type == PERL_MAGIC_qr) {
9446 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9448 else if(mg->mg_type == PERL_MAGIC_backref) {
9449 /* The backref AV has its reference count deliberately bumped by
9451 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9453 else if (mg->mg_type == PERL_MAGIC_symtab) {
9454 nmg->mg_obj = mg->mg_obj;
9457 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9458 ? sv_dup_inc(mg->mg_obj, param)
9459 : sv_dup(mg->mg_obj, param);
9461 nmg->mg_len = mg->mg_len;
9462 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9463 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9464 if (mg->mg_len > 0) {
9465 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9466 if (mg->mg_type == PERL_MAGIC_overload_table &&
9467 AMT_AMAGIC((AMT*)mg->mg_ptr))
9469 const AMT * const amtp = (AMT*)mg->mg_ptr;
9470 AMT * const namtp = (AMT*)nmg->mg_ptr;
9472 for (i = 1; i < NofAMmeth; i++) {
9473 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9477 else if (mg->mg_len == HEf_SVKEY)
9478 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9480 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9481 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9488 /* create a new pointer-mapping table */
9491 Perl_ptr_table_new(pTHX)
9494 PERL_UNUSED_CONTEXT;
9496 Newxz(tbl, 1, PTR_TBL_t);
9499 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9503 #define PTR_TABLE_HASH(ptr) \
9504 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9507 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9508 following define) and at call to new_body_inline made below in
9509 Perl_ptr_table_store()
9512 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9514 /* map an existing pointer using a table */
9516 STATIC PTR_TBL_ENT_t *
9517 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9518 PTR_TBL_ENT_t *tblent;
9519 const UV hash = PTR_TABLE_HASH(sv);
9521 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9522 for (; tblent; tblent = tblent->next) {
9523 if (tblent->oldval == sv)
9530 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9532 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9533 PERL_UNUSED_CONTEXT;
9534 return tblent ? tblent->newval : (void *) 0;
9537 /* add a new entry to a pointer-mapping table */
9540 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9542 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9543 PERL_UNUSED_CONTEXT;
9546 tblent->newval = newsv;
9548 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9550 new_body_inline(tblent, PTE_SVSLOT);
9552 tblent->oldval = oldsv;
9553 tblent->newval = newsv;
9554 tblent->next = tbl->tbl_ary[entry];
9555 tbl->tbl_ary[entry] = tblent;
9557 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9558 ptr_table_split(tbl);
9562 /* double the hash bucket size of an existing ptr table */
9565 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9567 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9568 const UV oldsize = tbl->tbl_max + 1;
9569 UV newsize = oldsize * 2;
9571 PERL_UNUSED_CONTEXT;
9573 Renew(ary, newsize, PTR_TBL_ENT_t*);
9574 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9575 tbl->tbl_max = --newsize;
9577 for (i=0; i < oldsize; i++, ary++) {
9578 PTR_TBL_ENT_t **curentp, **entp, *ent;
9581 curentp = ary + oldsize;
9582 for (entp = ary, ent = *ary; ent; ent = *entp) {
9583 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9585 ent->next = *curentp;
9595 /* remove all the entries from a ptr table */
9598 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9600 if (tbl && tbl->tbl_items) {
9601 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9602 UV riter = tbl->tbl_max;
9605 PTR_TBL_ENT_t *entry = array[riter];
9608 PTR_TBL_ENT_t * const oentry = entry;
9609 entry = entry->next;
9618 /* clear and free a ptr table */
9621 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9626 ptr_table_clear(tbl);
9627 Safefree(tbl->tbl_ary);
9633 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9636 SvRV_set(dstr, SvWEAKREF(sstr)
9637 ? sv_dup(SvRV(sstr), param)
9638 : sv_dup_inc(SvRV(sstr), param));
9641 else if (SvPVX_const(sstr)) {
9642 /* Has something there */
9644 /* Normal PV - clone whole allocated space */
9645 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9646 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9647 /* Not that normal - actually sstr is copy on write.
9648 But we are a true, independant SV, so: */
9649 SvREADONLY_off(dstr);
9654 /* Special case - not normally malloced for some reason */
9655 if (isGV_with_GP(sstr)) {
9656 /* Don't need to do anything here. */
9658 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9659 /* A "shared" PV - clone it as "shared" PV */
9661 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9665 /* Some other special case - random pointer */
9666 SvPV_set(dstr, SvPVX(sstr));
9672 if (SvTYPE(dstr) == SVt_RV)
9673 SvRV_set(dstr, NULL);
9675 SvPV_set(dstr, NULL);
9679 /* duplicate an SV of any type (including AV, HV etc) */
9682 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9687 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9689 /* look for it in the table first */
9690 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9694 if(param->flags & CLONEf_JOIN_IN) {
9695 /** We are joining here so we don't want do clone
9696 something that is bad **/
9697 if (SvTYPE(sstr) == SVt_PVHV) {
9698 const char * const hvname = HvNAME_get(sstr);
9700 /** don't clone stashes if they already exist **/
9701 return (SV*)gv_stashpv(hvname,0);
9705 /* create anew and remember what it is */
9708 #ifdef DEBUG_LEAKING_SCALARS
9709 dstr->sv_debug_optype = sstr->sv_debug_optype;
9710 dstr->sv_debug_line = sstr->sv_debug_line;
9711 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9712 dstr->sv_debug_cloned = 1;
9713 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9716 ptr_table_store(PL_ptr_table, sstr, dstr);
9719 SvFLAGS(dstr) = SvFLAGS(sstr);
9720 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9721 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9724 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9725 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9726 PL_watch_pvx, SvPVX_const(sstr));
9729 /* don't clone objects whose class has asked us not to */
9730 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9731 SvFLAGS(dstr) &= ~SVTYPEMASK;
9736 switch (SvTYPE(sstr)) {
9741 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9742 SvIV_set(dstr, SvIVX(sstr));
9745 SvANY(dstr) = new_XNV();
9746 SvNV_set(dstr, SvNVX(sstr));
9749 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9750 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9754 /* These are all the types that need complex bodies allocating. */
9756 const svtype sv_type = SvTYPE(sstr);
9757 const struct body_details *const sv_type_details
9758 = bodies_by_type + sv_type;
9762 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9766 if (GvUNIQUE((GV*)sstr)) {
9767 /*EMPTY*/; /* Do sharing here, and fall through */
9780 assert(sv_type_details->body_size);
9781 if (sv_type_details->arena) {
9782 new_body_inline(new_body, sv_type);
9784 = (void*)((char*)new_body - sv_type_details->offset);
9786 new_body = new_NOARENA(sv_type_details);
9790 SvANY(dstr) = new_body;
9793 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9794 ((char*)SvANY(dstr)) + sv_type_details->offset,
9795 sv_type_details->copy, char);
9797 Copy(((char*)SvANY(sstr)),
9798 ((char*)SvANY(dstr)),
9799 sv_type_details->body_size + sv_type_details->offset, char);
9802 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9803 && !isGV_with_GP(dstr))
9804 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9806 /* The Copy above means that all the source (unduplicated) pointers
9807 are now in the destination. We can check the flags and the
9808 pointers in either, but it's possible that there's less cache
9809 missing by always going for the destination.
9810 FIXME - instrument and check that assumption */
9811 if (sv_type >= SVt_PVMG) {
9813 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9814 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9815 } else if (SvMAGIC(dstr))
9816 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9818 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9821 /* The cast silences a GCC warning about unhandled types. */
9822 switch ((int)sv_type) {
9834 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9835 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9836 LvTARG(dstr) = dstr;
9837 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9838 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9840 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9843 if (GvNAME_HEK(dstr))
9844 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
9846 /* Don't call sv_add_backref here as it's going to be created
9847 as part of the magic cloning of the symbol table. */
9848 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9849 if(isGV_with_GP(sstr)) {
9850 /* Danger Will Robinson - GvGP(dstr) isn't initialised
9851 at the point of this comment. */
9852 GvGP(dstr) = gp_dup(GvGP(sstr), param);
9853 (void)GpREFCNT_inc(GvGP(dstr));
9855 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9858 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9859 if (IoOFP(dstr) == IoIFP(sstr))
9860 IoOFP(dstr) = IoIFP(dstr);
9862 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9863 /* PL_rsfp_filters entries have fake IoDIRP() */
9864 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9865 /* I have no idea why fake dirp (rsfps)
9866 should be treated differently but otherwise
9867 we end up with leaks -- sky*/
9868 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9869 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9870 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9872 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9873 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9874 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9876 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9879 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9882 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9883 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9884 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9887 if (AvARRAY((AV*)sstr)) {
9888 SV **dst_ary, **src_ary;
9889 SSize_t items = AvFILLp((AV*)sstr) + 1;
9891 src_ary = AvARRAY((AV*)sstr);
9892 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9893 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9894 SvPV_set(dstr, (char*)dst_ary);
9895 AvALLOC((AV*)dstr) = dst_ary;
9896 if (AvREAL((AV*)sstr)) {
9898 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9902 *dst_ary++ = sv_dup(*src_ary++, param);
9904 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9905 while (items-- > 0) {
9906 *dst_ary++ = &PL_sv_undef;
9910 SvPV_set(dstr, NULL);
9911 AvALLOC((AV*)dstr) = (SV**)NULL;
9918 if (HvARRAY((HV*)sstr)) {
9920 const bool sharekeys = !!HvSHAREKEYS(sstr);
9921 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9922 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9924 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9925 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9927 HvARRAY(dstr) = (HE**)darray;
9928 while (i <= sxhv->xhv_max) {
9929 const HE *source = HvARRAY(sstr)[i];
9930 HvARRAY(dstr)[i] = source
9931 ? he_dup(source, sharekeys, param) : 0;
9935 struct xpvhv_aux * const saux = HvAUX(sstr);
9936 struct xpvhv_aux * const daux = HvAUX(dstr);
9937 /* This flag isn't copied. */
9938 /* SvOOK_on(hv) attacks the IV flags. */
9939 SvFLAGS(dstr) |= SVf_OOK;
9941 hvname = saux->xhv_name;
9943 = hvname ? hek_dup(hvname, param) : hvname;
9945 daux->xhv_riter = saux->xhv_riter;
9946 daux->xhv_eiter = saux->xhv_eiter
9947 ? he_dup(saux->xhv_eiter,
9948 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9949 daux->xhv_backreferences = saux->xhv_backreferences
9950 ? (AV*) SvREFCNT_inc(
9958 SvPV_set(dstr, NULL);
9960 /* Record stashes for possible cloning in Perl_clone(). */
9962 av_push(param->stashes, dstr);
9966 if (!(param->flags & CLONEf_COPY_STACKS)) {
9970 /* NOTE: not refcounted */
9971 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9973 if (!CvISXSUB(dstr))
9974 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9976 if (CvCONST(dstr) && CvISXSUB(dstr)) {
9977 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9978 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9979 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9981 /* don't dup if copying back - CvGV isn't refcounted, so the
9982 * duped GV may never be freed. A bit of a hack! DAPM */
9983 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9984 NULL : gv_dup(CvGV(dstr), param) ;
9985 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9988 ? cv_dup( CvOUTSIDE(dstr), param)
9989 : cv_dup_inc(CvOUTSIDE(dstr), param);
9990 if (!CvISXSUB(dstr))
9991 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9997 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10003 /* duplicate a context */
10006 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10008 PERL_CONTEXT *ncxs;
10011 return (PERL_CONTEXT*)NULL;
10013 /* look for it in the table first */
10014 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10018 /* create anew and remember what it is */
10019 Newxz(ncxs, max + 1, PERL_CONTEXT);
10020 ptr_table_store(PL_ptr_table, cxs, ncxs);
10023 PERL_CONTEXT * const cx = &cxs[ix];
10024 PERL_CONTEXT * const ncx = &ncxs[ix];
10025 ncx->cx_type = cx->cx_type;
10026 if (CxTYPE(cx) == CXt_SUBST) {
10027 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10030 ncx->blk_oldsp = cx->blk_oldsp;
10031 ncx->blk_oldcop = cx->blk_oldcop;
10032 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10033 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10034 ncx->blk_oldpm = cx->blk_oldpm;
10035 ncx->blk_gimme = cx->blk_gimme;
10036 switch (CxTYPE(cx)) {
10038 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10039 ? cv_dup_inc(cx->blk_sub.cv, param)
10040 : cv_dup(cx->blk_sub.cv,param));
10041 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10042 ? av_dup_inc(cx->blk_sub.argarray, param)
10044 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10045 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10046 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10047 ncx->blk_sub.lval = cx->blk_sub.lval;
10048 ncx->blk_sub.retop = cx->blk_sub.retop;
10051 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10052 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10053 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10054 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10055 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10056 ncx->blk_eval.retop = cx->blk_eval.retop;
10059 ncx->blk_loop.label = cx->blk_loop.label;
10060 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10061 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10062 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10063 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10064 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10065 ? cx->blk_loop.iterdata
10066 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10067 ncx->blk_loop.oldcomppad
10068 = (PAD*)ptr_table_fetch(PL_ptr_table,
10069 cx->blk_loop.oldcomppad);
10070 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10071 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10072 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10073 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10074 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10077 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10078 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10079 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10080 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10081 ncx->blk_sub.retop = cx->blk_sub.retop;
10093 /* duplicate a stack info structure */
10096 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10101 return (PERL_SI*)NULL;
10103 /* look for it in the table first */
10104 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10108 /* create anew and remember what it is */
10109 Newxz(nsi, 1, PERL_SI);
10110 ptr_table_store(PL_ptr_table, si, nsi);
10112 nsi->si_stack = av_dup_inc(si->si_stack, param);
10113 nsi->si_cxix = si->si_cxix;
10114 nsi->si_cxmax = si->si_cxmax;
10115 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10116 nsi->si_type = si->si_type;
10117 nsi->si_prev = si_dup(si->si_prev, param);
10118 nsi->si_next = si_dup(si->si_next, param);
10119 nsi->si_markoff = si->si_markoff;
10124 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10125 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10126 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10127 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10128 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10129 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10130 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10131 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10132 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10133 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10134 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10135 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10136 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10137 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10140 #define pv_dup_inc(p) SAVEPV(p)
10141 #define pv_dup(p) SAVEPV(p)
10142 #define svp_dup_inc(p,pp) any_dup(p,pp)
10144 /* map any object to the new equivent - either something in the
10145 * ptr table, or something in the interpreter structure
10149 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10154 return (void*)NULL;
10156 /* look for it in the table first */
10157 ret = ptr_table_fetch(PL_ptr_table, v);
10161 /* see if it is part of the interpreter structure */
10162 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10163 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10171 /* duplicate the save stack */
10174 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10176 ANY * const ss = proto_perl->Tsavestack;
10177 const I32 max = proto_perl->Tsavestack_max;
10178 I32 ix = proto_perl->Tsavestack_ix;
10190 void (*dptr) (void*);
10191 void (*dxptr) (pTHX_ void*);
10193 Newxz(nss, max, ANY);
10196 I32 i = POPINT(ss,ix);
10197 TOPINT(nss,ix) = i;
10199 case SAVEt_ITEM: /* normal string */
10200 sv = (SV*)POPPTR(ss,ix);
10201 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10202 sv = (SV*)POPPTR(ss,ix);
10203 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10205 case SAVEt_SV: /* scalar reference */
10206 sv = (SV*)POPPTR(ss,ix);
10207 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10208 gv = (GV*)POPPTR(ss,ix);
10209 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10211 case SAVEt_GENERIC_PVREF: /* generic char* */
10212 c = (char*)POPPTR(ss,ix);
10213 TOPPTR(nss,ix) = pv_dup(c);
10214 ptr = POPPTR(ss,ix);
10215 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10217 case SAVEt_SHARED_PVREF: /* char* in shared space */
10218 c = (char*)POPPTR(ss,ix);
10219 TOPPTR(nss,ix) = savesharedpv(c);
10220 ptr = POPPTR(ss,ix);
10221 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10223 case SAVEt_GENERIC_SVREF: /* generic sv */
10224 case SAVEt_SVREF: /* scalar reference */
10225 sv = (SV*)POPPTR(ss,ix);
10226 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10227 ptr = POPPTR(ss,ix);
10228 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10230 case SAVEt_AV: /* array reference */
10231 av = (AV*)POPPTR(ss,ix);
10232 TOPPTR(nss,ix) = av_dup_inc(av, param);
10233 gv = (GV*)POPPTR(ss,ix);
10234 TOPPTR(nss,ix) = gv_dup(gv, param);
10236 case SAVEt_HV: /* hash reference */
10237 hv = (HV*)POPPTR(ss,ix);
10238 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10239 gv = (GV*)POPPTR(ss,ix);
10240 TOPPTR(nss,ix) = gv_dup(gv, param);
10242 case SAVEt_INT: /* int reference */
10243 ptr = POPPTR(ss,ix);
10244 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10245 intval = (int)POPINT(ss,ix);
10246 TOPINT(nss,ix) = intval;
10248 case SAVEt_LONG: /* long reference */
10249 ptr = POPPTR(ss,ix);
10250 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10251 longval = (long)POPLONG(ss,ix);
10252 TOPLONG(nss,ix) = longval;
10254 case SAVEt_I32: /* I32 reference */
10255 case SAVEt_I16: /* I16 reference */
10256 case SAVEt_I8: /* I8 reference */
10257 ptr = POPPTR(ss,ix);
10258 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10260 TOPINT(nss,ix) = i;
10262 case SAVEt_IV: /* IV reference */
10263 ptr = POPPTR(ss,ix);
10264 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10266 TOPIV(nss,ix) = iv;
10268 case SAVEt_SPTR: /* SV* reference */
10269 ptr = POPPTR(ss,ix);
10270 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10271 sv = (SV*)POPPTR(ss,ix);
10272 TOPPTR(nss,ix) = sv_dup(sv, param);
10274 case SAVEt_VPTR: /* random* reference */
10275 ptr = POPPTR(ss,ix);
10276 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10277 ptr = POPPTR(ss,ix);
10278 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10280 case SAVEt_PPTR: /* char* reference */
10281 ptr = POPPTR(ss,ix);
10282 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10283 c = (char*)POPPTR(ss,ix);
10284 TOPPTR(nss,ix) = pv_dup(c);
10286 case SAVEt_HPTR: /* HV* reference */
10287 ptr = POPPTR(ss,ix);
10288 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10289 hv = (HV*)POPPTR(ss,ix);
10290 TOPPTR(nss,ix) = hv_dup(hv, param);
10292 case SAVEt_APTR: /* AV* reference */
10293 ptr = POPPTR(ss,ix);
10294 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10295 av = (AV*)POPPTR(ss,ix);
10296 TOPPTR(nss,ix) = av_dup(av, param);
10299 gv = (GV*)POPPTR(ss,ix);
10300 TOPPTR(nss,ix) = gv_dup(gv, param);
10302 case SAVEt_GP: /* scalar reference */
10303 gp = (GP*)POPPTR(ss,ix);
10304 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10305 (void)GpREFCNT_inc(gp);
10306 gv = (GV*)POPPTR(ss,ix);
10307 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10308 c = (char*)POPPTR(ss,ix);
10309 TOPPTR(nss,ix) = pv_dup(c);
10311 TOPIV(nss,ix) = iv;
10313 TOPIV(nss,ix) = iv;
10316 case SAVEt_MORTALIZESV:
10317 sv = (SV*)POPPTR(ss,ix);
10318 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10321 ptr = POPPTR(ss,ix);
10322 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10323 /* these are assumed to be refcounted properly */
10325 switch (((OP*)ptr)->op_type) {
10327 case OP_LEAVESUBLV:
10331 case OP_LEAVEWRITE:
10332 TOPPTR(nss,ix) = ptr;
10337 TOPPTR(nss,ix) = NULL;
10342 TOPPTR(nss,ix) = NULL;
10345 c = (char*)POPPTR(ss,ix);
10346 TOPPTR(nss,ix) = pv_dup_inc(c);
10348 case SAVEt_CLEARSV:
10349 longval = POPLONG(ss,ix);
10350 TOPLONG(nss,ix) = longval;
10353 hv = (HV*)POPPTR(ss,ix);
10354 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10355 c = (char*)POPPTR(ss,ix);
10356 TOPPTR(nss,ix) = pv_dup_inc(c);
10358 TOPINT(nss,ix) = i;
10360 case SAVEt_DESTRUCTOR:
10361 ptr = POPPTR(ss,ix);
10362 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10363 dptr = POPDPTR(ss,ix);
10364 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10365 any_dup(FPTR2DPTR(void *, dptr),
10368 case SAVEt_DESTRUCTOR_X:
10369 ptr = POPPTR(ss,ix);
10370 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10371 dxptr = POPDXPTR(ss,ix);
10372 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10373 any_dup(FPTR2DPTR(void *, dxptr),
10376 case SAVEt_REGCONTEXT:
10379 TOPINT(nss,ix) = i;
10382 case SAVEt_STACK_POS: /* Position on Perl stack */
10384 TOPINT(nss,ix) = i;
10386 case SAVEt_AELEM: /* array element */
10387 sv = (SV*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10390 TOPINT(nss,ix) = i;
10391 av = (AV*)POPPTR(ss,ix);
10392 TOPPTR(nss,ix) = av_dup_inc(av, param);
10394 case SAVEt_HELEM: /* hash element */
10395 sv = (SV*)POPPTR(ss,ix);
10396 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10397 sv = (SV*)POPPTR(ss,ix);
10398 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10399 hv = (HV*)POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10403 ptr = POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = ptr;
10408 TOPINT(nss,ix) = i;
10410 case SAVEt_COMPPAD:
10411 av = (AV*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = av_dup(av, param);
10415 longval = (long)POPLONG(ss,ix);
10416 TOPLONG(nss,ix) = longval;
10417 ptr = POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10419 sv = (SV*)POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = sv_dup(sv, param);
10423 ptr = POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10425 longval = (long)POPBOOL(ss,ix);
10426 TOPBOOL(nss,ix) = (bool)longval;
10428 case SAVEt_SET_SVFLAGS:
10430 TOPINT(nss,ix) = i;
10432 TOPINT(nss,ix) = i;
10433 sv = (SV*)POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = sv_dup(sv, param);
10437 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10445 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10446 * flag to the result. This is done for each stash before cloning starts,
10447 * so we know which stashes want their objects cloned */
10450 do_mark_cloneable_stash(pTHX_ SV *sv)
10452 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10454 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10455 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10456 if (cloner && GvCV(cloner)) {
10463 XPUSHs(sv_2mortal(newSVhek(hvname)));
10465 call_sv((SV*)GvCV(cloner), G_SCALAR);
10472 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10480 =for apidoc perl_clone
10482 Create and return a new interpreter by cloning the current one.
10484 perl_clone takes these flags as parameters:
10486 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10487 without it we only clone the data and zero the stacks,
10488 with it we copy the stacks and the new perl interpreter is
10489 ready to run at the exact same point as the previous one.
10490 The pseudo-fork code uses COPY_STACKS while the
10491 threads->new doesn't.
10493 CLONEf_KEEP_PTR_TABLE
10494 perl_clone keeps a ptr_table with the pointer of the old
10495 variable as a key and the new variable as a value,
10496 this allows it to check if something has been cloned and not
10497 clone it again but rather just use the value and increase the
10498 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10499 the ptr_table using the function
10500 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10501 reason to keep it around is if you want to dup some of your own
10502 variable who are outside the graph perl scans, example of this
10503 code is in threads.xs create
10506 This is a win32 thing, it is ignored on unix, it tells perls
10507 win32host code (which is c++) to clone itself, this is needed on
10508 win32 if you want to run two threads at the same time,
10509 if you just want to do some stuff in a separate perl interpreter
10510 and then throw it away and return to the original one,
10511 you don't need to do anything.
10516 /* XXX the above needs expanding by someone who actually understands it ! */
10517 EXTERN_C PerlInterpreter *
10518 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10521 perl_clone(PerlInterpreter *proto_perl, UV flags)
10524 #ifdef PERL_IMPLICIT_SYS
10526 /* perlhost.h so we need to call into it
10527 to clone the host, CPerlHost should have a c interface, sky */
10529 if (flags & CLONEf_CLONE_HOST) {
10530 return perl_clone_host(proto_perl,flags);
10532 return perl_clone_using(proto_perl, flags,
10534 proto_perl->IMemShared,
10535 proto_perl->IMemParse,
10537 proto_perl->IStdIO,
10541 proto_perl->IProc);
10545 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10546 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10547 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10548 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10549 struct IPerlDir* ipD, struct IPerlSock* ipS,
10550 struct IPerlProc* ipP)
10552 /* XXX many of the string copies here can be optimized if they're
10553 * constants; they need to be allocated as common memory and just
10554 * their pointers copied. */
10557 CLONE_PARAMS clone_params;
10558 CLONE_PARAMS* const param = &clone_params;
10560 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10561 /* for each stash, determine whether its objects should be cloned */
10562 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10563 PERL_SET_THX(my_perl);
10566 Poison(my_perl, 1, PerlInterpreter);
10572 PL_savestack_ix = 0;
10573 PL_savestack_max = -1;
10574 PL_sig_pending = 0;
10575 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10576 # else /* !DEBUGGING */
10577 Zero(my_perl, 1, PerlInterpreter);
10578 # endif /* DEBUGGING */
10580 /* host pointers */
10582 PL_MemShared = ipMS;
10583 PL_MemParse = ipMP;
10590 #else /* !PERL_IMPLICIT_SYS */
10592 CLONE_PARAMS clone_params;
10593 CLONE_PARAMS* param = &clone_params;
10594 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10595 /* for each stash, determine whether its objects should be cloned */
10596 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10597 PERL_SET_THX(my_perl);
10600 Poison(my_perl, 1, PerlInterpreter);
10606 PL_savestack_ix = 0;
10607 PL_savestack_max = -1;
10608 PL_sig_pending = 0;
10609 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10610 # else /* !DEBUGGING */
10611 Zero(my_perl, 1, PerlInterpreter);
10612 # endif /* DEBUGGING */
10613 #endif /* PERL_IMPLICIT_SYS */
10614 param->flags = flags;
10615 param->proto_perl = proto_perl;
10617 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10619 PL_body_arenas = NULL;
10620 Zero(&PL_body_roots, 1, PL_body_roots);
10622 PL_nice_chunk = NULL;
10623 PL_nice_chunk_size = 0;
10625 PL_sv_objcount = 0;
10627 PL_sv_arenaroot = NULL;
10629 PL_debug = proto_perl->Idebug;
10631 PL_hash_seed = proto_perl->Ihash_seed;
10632 PL_rehash_seed = proto_perl->Irehash_seed;
10634 #ifdef USE_REENTRANT_API
10635 /* XXX: things like -Dm will segfault here in perlio, but doing
10636 * PERL_SET_CONTEXT(proto_perl);
10637 * breaks too many other things
10639 Perl_reentrant_init(aTHX);
10642 /* create SV map for pointer relocation */
10643 PL_ptr_table = ptr_table_new();
10645 /* initialize these special pointers as early as possible */
10646 SvANY(&PL_sv_undef) = NULL;
10647 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10648 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10649 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10651 SvANY(&PL_sv_no) = new_XPVNV();
10652 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10653 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10654 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10655 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10656 SvCUR_set(&PL_sv_no, 0);
10657 SvLEN_set(&PL_sv_no, 1);
10658 SvIV_set(&PL_sv_no, 0);
10659 SvNV_set(&PL_sv_no, 0);
10660 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10662 SvANY(&PL_sv_yes) = new_XPVNV();
10663 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10664 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10665 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10666 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10667 SvCUR_set(&PL_sv_yes, 1);
10668 SvLEN_set(&PL_sv_yes, 2);
10669 SvIV_set(&PL_sv_yes, 1);
10670 SvNV_set(&PL_sv_yes, 1);
10671 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10673 /* create (a non-shared!) shared string table */
10674 PL_strtab = newHV();
10675 HvSHAREKEYS_off(PL_strtab);
10676 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10677 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10679 PL_compiling = proto_perl->Icompiling;
10681 /* These two PVs will be free'd special way so must set them same way op.c does */
10682 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10683 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10685 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10686 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10688 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10689 if (!specialWARN(PL_compiling.cop_warnings))
10690 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10691 if (!specialCopIO(PL_compiling.cop_io))
10692 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10693 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10695 /* pseudo environmental stuff */
10696 PL_origargc = proto_perl->Iorigargc;
10697 PL_origargv = proto_perl->Iorigargv;
10699 param->stashes = newAV(); /* Setup array of objects to call clone on */
10701 /* Set tainting stuff before PerlIO_debug can possibly get called */
10702 PL_tainting = proto_perl->Itainting;
10703 PL_taint_warn = proto_perl->Itaint_warn;
10705 #ifdef PERLIO_LAYERS
10706 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10707 PerlIO_clone(aTHX_ proto_perl, param);
10710 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10711 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10712 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10713 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10714 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10715 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10718 PL_minus_c = proto_perl->Iminus_c;
10719 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10720 PL_localpatches = proto_perl->Ilocalpatches;
10721 PL_splitstr = proto_perl->Isplitstr;
10722 PL_preprocess = proto_perl->Ipreprocess;
10723 PL_minus_n = proto_perl->Iminus_n;
10724 PL_minus_p = proto_perl->Iminus_p;
10725 PL_minus_l = proto_perl->Iminus_l;
10726 PL_minus_a = proto_perl->Iminus_a;
10727 PL_minus_E = proto_perl->Iminus_E;
10728 PL_minus_F = proto_perl->Iminus_F;
10729 PL_doswitches = proto_perl->Idoswitches;
10730 PL_dowarn = proto_perl->Idowarn;
10731 PL_doextract = proto_perl->Idoextract;
10732 PL_sawampersand = proto_perl->Isawampersand;
10733 PL_unsafe = proto_perl->Iunsafe;
10734 PL_inplace = SAVEPV(proto_perl->Iinplace);
10735 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10736 PL_perldb = proto_perl->Iperldb;
10737 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10738 PL_exit_flags = proto_perl->Iexit_flags;
10740 /* magical thingies */
10741 /* XXX time(&PL_basetime) when asked for? */
10742 PL_basetime = proto_perl->Ibasetime;
10743 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10745 PL_maxsysfd = proto_perl->Imaxsysfd;
10746 PL_multiline = proto_perl->Imultiline;
10747 PL_statusvalue = proto_perl->Istatusvalue;
10749 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10751 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10753 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10755 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10756 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10757 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10759 /* Clone the regex array */
10760 PL_regex_padav = newAV();
10762 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10763 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10765 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10766 for(i = 1; i <= len; i++) {
10767 const SV * const regex = regexen[i];
10770 ? sv_dup_inc(regex, param)
10772 newSViv(PTR2IV(re_dup(
10773 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10775 av_push(PL_regex_padav, sv);
10778 PL_regex_pad = AvARRAY(PL_regex_padav);
10780 /* shortcuts to various I/O objects */
10781 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10782 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10783 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10784 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10785 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10786 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10788 /* shortcuts to regexp stuff */
10789 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10791 /* shortcuts to misc objects */
10792 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10794 /* shortcuts to debugging objects */
10795 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10796 PL_DBline = gv_dup(proto_perl->IDBline, param);
10797 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10798 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10799 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10800 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10801 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10802 PL_lineary = av_dup(proto_perl->Ilineary, param);
10803 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10805 /* symbol tables */
10806 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10807 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10808 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10809 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10810 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10812 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10813 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10814 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10815 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10816 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10817 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10819 PL_sub_generation = proto_perl->Isub_generation;
10821 /* funky return mechanisms */
10822 PL_forkprocess = proto_perl->Iforkprocess;
10824 /* subprocess state */
10825 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10827 /* internal state */
10828 PL_maxo = proto_perl->Imaxo;
10829 if (proto_perl->Iop_mask)
10830 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10833 /* PL_asserting = proto_perl->Iasserting; */
10835 /* current interpreter roots */
10836 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10837 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10838 PL_main_start = proto_perl->Imain_start;
10839 PL_eval_root = proto_perl->Ieval_root;
10840 PL_eval_start = proto_perl->Ieval_start;
10842 /* runtime control stuff */
10843 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10844 PL_copline = proto_perl->Icopline;
10846 PL_filemode = proto_perl->Ifilemode;
10847 PL_lastfd = proto_perl->Ilastfd;
10848 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10851 PL_gensym = proto_perl->Igensym;
10852 PL_preambled = proto_perl->Ipreambled;
10853 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10854 PL_laststatval = proto_perl->Ilaststatval;
10855 PL_laststype = proto_perl->Ilaststype;
10858 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10860 /* interpreter atexit processing */
10861 PL_exitlistlen = proto_perl->Iexitlistlen;
10862 if (PL_exitlistlen) {
10863 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10864 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10867 PL_exitlist = (PerlExitListEntry*)NULL;
10869 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10870 if (PL_my_cxt_size) {
10871 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10872 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10875 PL_my_cxt_list = (void**)NULL;
10876 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10877 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10878 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10880 PL_profiledata = NULL;
10881 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10882 /* PL_rsfp_filters entries have fake IoDIRP() */
10883 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10885 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10887 PAD_CLONE_VARS(proto_perl, param);
10889 #ifdef HAVE_INTERP_INTERN
10890 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10893 /* more statics moved here */
10894 PL_generation = proto_perl->Igeneration;
10895 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10897 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10898 PL_in_clean_all = proto_perl->Iin_clean_all;
10900 PL_uid = proto_perl->Iuid;
10901 PL_euid = proto_perl->Ieuid;
10902 PL_gid = proto_perl->Igid;
10903 PL_egid = proto_perl->Iegid;
10904 PL_nomemok = proto_perl->Inomemok;
10905 PL_an = proto_perl->Ian;
10906 PL_evalseq = proto_perl->Ievalseq;
10907 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10908 PL_origalen = proto_perl->Iorigalen;
10909 #ifdef PERL_USES_PL_PIDSTATUS
10910 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10912 PL_osname = SAVEPV(proto_perl->Iosname);
10913 PL_sighandlerp = proto_perl->Isighandlerp;
10915 PL_runops = proto_perl->Irunops;
10917 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10920 PL_cshlen = proto_perl->Icshlen;
10921 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10924 PL_lex_state = proto_perl->Ilex_state;
10925 PL_lex_defer = proto_perl->Ilex_defer;
10926 PL_lex_expect = proto_perl->Ilex_expect;
10927 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10928 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10929 PL_lex_starts = proto_perl->Ilex_starts;
10930 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10931 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10932 PL_lex_op = proto_perl->Ilex_op;
10933 PL_lex_inpat = proto_perl->Ilex_inpat;
10934 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10935 PL_lex_brackets = proto_perl->Ilex_brackets;
10936 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10937 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10938 PL_lex_casemods = proto_perl->Ilex_casemods;
10939 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10940 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10942 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10943 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10944 PL_nexttoke = proto_perl->Inexttoke;
10946 /* XXX This is probably masking the deeper issue of why
10947 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10948 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10949 * (A little debugging with a watchpoint on it may help.)
10951 if (SvANY(proto_perl->Ilinestr)) {
10952 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10953 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10954 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10955 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10956 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10957 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10958 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10959 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10960 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10963 PL_linestr = newSV(79);
10964 sv_upgrade(PL_linestr,SVt_PVIV);
10965 sv_setpvn(PL_linestr,"",0);
10966 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10968 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10969 PL_pending_ident = proto_perl->Ipending_ident;
10970 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10972 PL_expect = proto_perl->Iexpect;
10974 PL_multi_start = proto_perl->Imulti_start;
10975 PL_multi_end = proto_perl->Imulti_end;
10976 PL_multi_open = proto_perl->Imulti_open;
10977 PL_multi_close = proto_perl->Imulti_close;
10979 PL_error_count = proto_perl->Ierror_count;
10980 PL_subline = proto_perl->Isubline;
10981 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10983 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10984 if (SvANY(proto_perl->Ilinestr)) {
10985 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10986 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10987 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10988 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10989 PL_last_lop_op = proto_perl->Ilast_lop_op;
10992 PL_last_uni = SvPVX(PL_linestr);
10993 PL_last_lop = SvPVX(PL_linestr);
10994 PL_last_lop_op = 0;
10996 PL_in_my = proto_perl->Iin_my;
10997 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10999 PL_cryptseen = proto_perl->Icryptseen;
11002 PL_hints = proto_perl->Ihints;
11004 PL_amagic_generation = proto_perl->Iamagic_generation;
11006 #ifdef USE_LOCALE_COLLATE
11007 PL_collation_ix = proto_perl->Icollation_ix;
11008 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11009 PL_collation_standard = proto_perl->Icollation_standard;
11010 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11011 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11012 #endif /* USE_LOCALE_COLLATE */
11014 #ifdef USE_LOCALE_NUMERIC
11015 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11016 PL_numeric_standard = proto_perl->Inumeric_standard;
11017 PL_numeric_local = proto_perl->Inumeric_local;
11018 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11019 #endif /* !USE_LOCALE_NUMERIC */
11021 /* utf8 character classes */
11022 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11023 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11024 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11025 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11026 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11027 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11028 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11029 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11030 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11031 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11032 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11033 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11034 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11035 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11036 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11037 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11038 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11039 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11040 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11041 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11043 /* Did the locale setup indicate UTF-8? */
11044 PL_utf8locale = proto_perl->Iutf8locale;
11045 /* Unicode features (see perlrun/-C) */
11046 PL_unicode = proto_perl->Iunicode;
11048 /* Pre-5.8 signals control */
11049 PL_signals = proto_perl->Isignals;
11051 /* times() ticks per second */
11052 PL_clocktick = proto_perl->Iclocktick;
11054 /* Recursion stopper for PerlIO_find_layer */
11055 PL_in_load_module = proto_perl->Iin_load_module;
11057 /* sort() routine */
11058 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11060 /* Not really needed/useful since the reenrant_retint is "volatile",
11061 * but do it for consistency's sake. */
11062 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11064 /* Hooks to shared SVs and locks. */
11065 PL_sharehook = proto_perl->Isharehook;
11066 PL_lockhook = proto_perl->Ilockhook;
11067 PL_unlockhook = proto_perl->Iunlockhook;
11068 PL_threadhook = proto_perl->Ithreadhook;
11070 PL_runops_std = proto_perl->Irunops_std;
11071 PL_runops_dbg = proto_perl->Irunops_dbg;
11073 #ifdef THREADS_HAVE_PIDS
11074 PL_ppid = proto_perl->Ippid;
11078 PL_last_swash_hv = NULL; /* reinits on demand */
11079 PL_last_swash_klen = 0;
11080 PL_last_swash_key[0]= '\0';
11081 PL_last_swash_tmps = (U8*)NULL;
11082 PL_last_swash_slen = 0;
11084 PL_glob_index = proto_perl->Iglob_index;
11085 PL_srand_called = proto_perl->Isrand_called;
11086 PL_uudmap['M'] = 0; /* reinits on demand */
11087 PL_bitcount = NULL; /* reinits on demand */
11089 if (proto_perl->Ipsig_pend) {
11090 Newxz(PL_psig_pend, SIG_SIZE, int);
11093 PL_psig_pend = (int*)NULL;
11096 if (proto_perl->Ipsig_ptr) {
11097 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11098 Newxz(PL_psig_name, SIG_SIZE, SV*);
11099 for (i = 1; i < SIG_SIZE; i++) {
11100 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11101 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11105 PL_psig_ptr = (SV**)NULL;
11106 PL_psig_name = (SV**)NULL;
11109 /* thrdvar.h stuff */
11111 if (flags & CLONEf_COPY_STACKS) {
11112 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11113 PL_tmps_ix = proto_perl->Ttmps_ix;
11114 PL_tmps_max = proto_perl->Ttmps_max;
11115 PL_tmps_floor = proto_perl->Ttmps_floor;
11116 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11118 while (i <= PL_tmps_ix) {
11119 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11123 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11124 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11125 Newxz(PL_markstack, i, I32);
11126 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11127 - proto_perl->Tmarkstack);
11128 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11129 - proto_perl->Tmarkstack);
11130 Copy(proto_perl->Tmarkstack, PL_markstack,
11131 PL_markstack_ptr - PL_markstack + 1, I32);
11133 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11134 * NOTE: unlike the others! */
11135 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11136 PL_scopestack_max = proto_perl->Tscopestack_max;
11137 Newxz(PL_scopestack, PL_scopestack_max, I32);
11138 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11140 /* NOTE: si_dup() looks at PL_markstack */
11141 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11143 /* PL_curstack = PL_curstackinfo->si_stack; */
11144 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11145 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11147 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11148 PL_stack_base = AvARRAY(PL_curstack);
11149 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11150 - proto_perl->Tstack_base);
11151 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11153 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11154 * NOTE: unlike the others! */
11155 PL_savestack_ix = proto_perl->Tsavestack_ix;
11156 PL_savestack_max = proto_perl->Tsavestack_max;
11157 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11158 PL_savestack = ss_dup(proto_perl, param);
11162 ENTER; /* perl_destruct() wants to LEAVE; */
11164 /* although we're not duplicating the tmps stack, we should still
11165 * add entries for any SVs on the tmps stack that got cloned by a
11166 * non-refcount means (eg a temp in @_); otherwise they will be
11169 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11170 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11171 proto_perl->Ttmps_stack[i]);
11172 if (nsv && !SvREFCNT(nsv)) {
11174 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11179 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11180 PL_top_env = &PL_start_env;
11182 PL_op = proto_perl->Top;
11185 PL_Xpv = (XPV*)NULL;
11186 PL_na = proto_perl->Tna;
11188 PL_statbuf = proto_perl->Tstatbuf;
11189 PL_statcache = proto_perl->Tstatcache;
11190 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11191 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11193 PL_timesbuf = proto_perl->Ttimesbuf;
11196 PL_tainted = proto_perl->Ttainted;
11197 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11198 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11199 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11200 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11201 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11202 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11203 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11204 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11205 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11207 PL_restartop = proto_perl->Trestartop;
11208 PL_in_eval = proto_perl->Tin_eval;
11209 PL_delaymagic = proto_perl->Tdelaymagic;
11210 PL_dirty = proto_perl->Tdirty;
11211 PL_localizing = proto_perl->Tlocalizing;
11213 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11214 PL_hv_fetch_ent_mh = NULL;
11215 PL_modcount = proto_perl->Tmodcount;
11216 PL_lastgotoprobe = NULL;
11217 PL_dumpindent = proto_perl->Tdumpindent;
11219 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11220 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11221 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11222 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11223 PL_efloatbuf = NULL; /* reinits on demand */
11224 PL_efloatsize = 0; /* reinits on demand */
11228 PL_screamfirst = NULL;
11229 PL_screamnext = NULL;
11230 PL_maxscream = -1; /* reinits on demand */
11231 PL_lastscream = NULL;
11233 PL_watchaddr = NULL;
11236 PL_regdummy = proto_perl->Tregdummy;
11237 PL_regprecomp = NULL;
11240 PL_colorset = 0; /* reinits PL_colors[] */
11241 /*PL_colors[6] = {0,0,0,0,0,0};*/
11242 PL_reginput = NULL;
11245 PL_regstartp = (I32*)NULL;
11246 PL_regendp = (I32*)NULL;
11247 PL_reglastparen = (U32*)NULL;
11248 PL_reglastcloseparen = (U32*)NULL;
11250 PL_reg_start_tmp = (char**)NULL;
11251 PL_reg_start_tmpl = 0;
11252 PL_regdata = (struct reg_data*)NULL;
11255 PL_reg_eval_set = 0;
11257 PL_regprogram = (regnode*)NULL;
11259 PL_regcc = (CURCUR*)NULL;
11260 PL_reg_call_cc = (struct re_cc_state*)NULL;
11261 PL_reg_re = (regexp*)NULL;
11262 PL_reg_ganch = NULL;
11264 PL_reg_match_utf8 = FALSE;
11265 PL_reg_magic = (MAGIC*)NULL;
11267 PL_reg_oldcurpm = (PMOP*)NULL;
11268 PL_reg_curpm = (PMOP*)NULL;
11269 PL_reg_oldsaved = NULL;
11270 PL_reg_oldsavedlen = 0;
11271 #ifdef PERL_OLD_COPY_ON_WRITE
11274 PL_reg_maxiter = 0;
11275 PL_reg_leftiter = 0;
11276 PL_reg_poscache = NULL;
11277 PL_reg_poscache_size= 0;
11279 /* RE engine - function pointers */
11280 PL_regcompp = proto_perl->Tregcompp;
11281 PL_regexecp = proto_perl->Tregexecp;
11282 PL_regint_start = proto_perl->Tregint_start;
11283 PL_regint_string = proto_perl->Tregint_string;
11284 PL_regfree = proto_perl->Tregfree;
11286 PL_reginterp_cnt = 0;
11287 PL_reg_starttry = 0;
11289 /* Pluggable optimizer */
11290 PL_peepp = proto_perl->Tpeepp;
11292 PL_stashcache = newHV();
11294 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11295 ptr_table_free(PL_ptr_table);
11296 PL_ptr_table = NULL;
11299 /* Call the ->CLONE method, if it exists, for each of the stashes
11300 identified by sv_dup() above.
11302 while(av_len(param->stashes) != -1) {
11303 HV* const stash = (HV*) av_shift(param->stashes);
11304 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11305 if (cloner && GvCV(cloner)) {
11310 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11312 call_sv((SV*)GvCV(cloner), G_DISCARD);
11318 SvREFCNT_dec(param->stashes);
11320 /* orphaned? eg threads->new inside BEGIN or use */
11321 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11322 SvREFCNT_inc_simple_void(PL_compcv);
11323 SAVEFREESV(PL_compcv);
11329 #endif /* USE_ITHREADS */
11332 =head1 Unicode Support
11334 =for apidoc sv_recode_to_utf8
11336 The encoding is assumed to be an Encode object, on entry the PV
11337 of the sv is assumed to be octets in that encoding, and the sv
11338 will be converted into Unicode (and UTF-8).
11340 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11341 is not a reference, nothing is done to the sv. If the encoding is not
11342 an C<Encode::XS> Encoding object, bad things will happen.
11343 (See F<lib/encoding.pm> and L<Encode>).
11345 The PV of the sv is returned.
11350 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11353 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11367 Passing sv_yes is wrong - it needs to be or'ed set of constants
11368 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11369 remove converted chars from source.
11371 Both will default the value - let them.
11373 XPUSHs(&PL_sv_yes);
11376 call_method("decode", G_SCALAR);
11380 s = SvPV_const(uni, len);
11381 if (s != SvPVX_const(sv)) {
11382 SvGROW(sv, len + 1);
11383 Move(s, SvPVX(sv), len + 1, char);
11384 SvCUR_set(sv, len);
11391 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11395 =for apidoc sv_cat_decode
11397 The encoding is assumed to be an Encode object, the PV of the ssv is
11398 assumed to be octets in that encoding and decoding the input starts
11399 from the position which (PV + *offset) pointed to. The dsv will be
11400 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11401 when the string tstr appears in decoding output or the input ends on
11402 the PV of the ssv. The value which the offset points will be modified
11403 to the last input position on the ssv.
11405 Returns TRUE if the terminator was found, else returns FALSE.
11410 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11411 SV *ssv, int *offset, char *tstr, int tlen)
11415 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11426 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11427 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11429 call_method("cat_decode", G_SCALAR);
11431 ret = SvTRUE(TOPs);
11432 *offset = SvIV(offsv);
11438 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11443 /* ---------------------------------------------------------------------
11445 * support functions for report_uninit()
11448 /* the maxiumum size of array or hash where we will scan looking
11449 * for the undefined element that triggered the warning */
11451 #define FUV_MAX_SEARCH_SIZE 1000
11453 /* Look for an entry in the hash whose value has the same SV as val;
11454 * If so, return a mortal copy of the key. */
11457 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11460 register HE **array;
11463 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11464 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11467 array = HvARRAY(hv);
11469 for (i=HvMAX(hv); i>0; i--) {
11470 register HE *entry;
11471 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11472 if (HeVAL(entry) != val)
11474 if ( HeVAL(entry) == &PL_sv_undef ||
11475 HeVAL(entry) == &PL_sv_placeholder)
11479 if (HeKLEN(entry) == HEf_SVKEY)
11480 return sv_mortalcopy(HeKEY_sv(entry));
11481 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11487 /* Look for an entry in the array whose value has the same SV as val;
11488 * If so, return the index, otherwise return -1. */
11491 S_find_array_subscript(pTHX_ AV *av, SV* val)
11496 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11497 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11501 for (i=AvFILLp(av); i>=0; i--) {
11502 if (svp[i] == val && svp[i] != &PL_sv_undef)
11508 /* S_varname(): return the name of a variable, optionally with a subscript.
11509 * If gv is non-zero, use the name of that global, along with gvtype (one
11510 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11511 * targ. Depending on the value of the subscript_type flag, return:
11514 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11515 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11516 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11517 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11520 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11521 SV* keyname, I32 aindex, int subscript_type)
11524 SV * const name = sv_newmortal();
11527 buffer[0] = gvtype;
11530 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11532 gv_fullname4(name, gv, buffer, 0);
11534 if ((unsigned int)SvPVX(name)[1] <= 26) {
11536 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11538 /* Swap the 1 unprintable control character for the 2 byte pretty
11539 version - ie substr($name, 1, 1) = $buffer; */
11540 sv_insert(name, 1, 1, buffer, 2);
11545 CV * const cv = find_runcv(&unused);
11549 if (!cv || !CvPADLIST(cv))
11551 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11552 sv = *av_fetch(av, targ, FALSE);
11553 /* SvLEN in a pad name is not to be trusted */
11554 sv_setpv(name, SvPV_nolen_const(sv));
11557 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11558 SV * const sv = newSV(0);
11559 *SvPVX(name) = '$';
11560 Perl_sv_catpvf(aTHX_ name, "{%s}",
11561 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11564 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11565 *SvPVX(name) = '$';
11566 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11568 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11569 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11576 =for apidoc find_uninit_var
11578 Find the name of the undefined variable (if any) that caused the operator o
11579 to issue a "Use of uninitialized value" warning.
11580 If match is true, only return a name if it's value matches uninit_sv.
11581 So roughly speaking, if a unary operator (such as OP_COS) generates a
11582 warning, then following the direct child of the op may yield an
11583 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11584 other hand, with OP_ADD there are two branches to follow, so we only print
11585 the variable name if we get an exact match.
11587 The name is returned as a mortal SV.
11589 Assumes that PL_op is the op that originally triggered the error, and that
11590 PL_comppad/PL_curpad points to the currently executing pad.
11596 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11604 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11605 uninit_sv == &PL_sv_placeholder)))
11608 switch (obase->op_type) {
11615 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11616 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11619 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11621 if (pad) { /* @lex, %lex */
11622 sv = PAD_SVl(obase->op_targ);
11626 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11627 /* @global, %global */
11628 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11631 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11633 else /* @{expr}, %{expr} */
11634 return find_uninit_var(cUNOPx(obase)->op_first,
11638 /* attempt to find a match within the aggregate */
11640 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11642 subscript_type = FUV_SUBSCRIPT_HASH;
11645 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11647 subscript_type = FUV_SUBSCRIPT_ARRAY;
11650 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11653 return varname(gv, hash ? '%' : '@', obase->op_targ,
11654 keysv, index, subscript_type);
11658 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11660 return varname(NULL, '$', obase->op_targ,
11661 NULL, 0, FUV_SUBSCRIPT_NONE);
11664 gv = cGVOPx_gv(obase);
11665 if (!gv || (match && GvSV(gv) != uninit_sv))
11667 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11670 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11673 av = (AV*)PAD_SV(obase->op_targ);
11674 if (!av || SvRMAGICAL(av))
11676 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11677 if (!svp || *svp != uninit_sv)
11680 return varname(NULL, '$', obase->op_targ,
11681 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11684 gv = cGVOPx_gv(obase);
11690 if (!av || SvRMAGICAL(av))
11692 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11693 if (!svp || *svp != uninit_sv)
11696 return varname(gv, '$', 0,
11697 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11702 o = cUNOPx(obase)->op_first;
11703 if (!o || o->op_type != OP_NULL ||
11704 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11706 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11710 if (PL_op == obase)
11711 /* $a[uninit_expr] or $h{uninit_expr} */
11712 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11715 o = cBINOPx(obase)->op_first;
11716 kid = cBINOPx(obase)->op_last;
11718 /* get the av or hv, and optionally the gv */
11720 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11721 sv = PAD_SV(o->op_targ);
11723 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11724 && cUNOPo->op_first->op_type == OP_GV)
11726 gv = cGVOPx_gv(cUNOPo->op_first);
11729 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11734 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11735 /* index is constant */
11739 if (obase->op_type == OP_HELEM) {
11740 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11741 if (!he || HeVAL(he) != uninit_sv)
11745 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11746 if (!svp || *svp != uninit_sv)
11750 if (obase->op_type == OP_HELEM)
11751 return varname(gv, '%', o->op_targ,
11752 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11754 return varname(gv, '@', o->op_targ, NULL,
11755 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11758 /* index is an expression;
11759 * attempt to find a match within the aggregate */
11760 if (obase->op_type == OP_HELEM) {
11761 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11763 return varname(gv, '%', o->op_targ,
11764 keysv, 0, FUV_SUBSCRIPT_HASH);
11767 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11769 return varname(gv, '@', o->op_targ,
11770 NULL, index, FUV_SUBSCRIPT_ARRAY);
11775 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11777 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11782 /* only examine RHS */
11783 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11786 o = cUNOPx(obase)->op_first;
11787 if (o->op_type == OP_PUSHMARK)
11790 if (!o->op_sibling) {
11791 /* one-arg version of open is highly magical */
11793 if (o->op_type == OP_GV) { /* open FOO; */
11795 if (match && GvSV(gv) != uninit_sv)
11797 return varname(gv, '$', 0,
11798 NULL, 0, FUV_SUBSCRIPT_NONE);
11800 /* other possibilities not handled are:
11801 * open $x; or open my $x; should return '${*$x}'
11802 * open expr; should return '$'.expr ideally
11808 /* ops where $_ may be an implicit arg */
11812 if ( !(obase->op_flags & OPf_STACKED)) {
11813 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11814 ? PAD_SVl(obase->op_targ)
11817 sv = sv_newmortal();
11818 sv_setpvn(sv, "$_", 2);
11826 /* skip filehandle as it can't produce 'undef' warning */
11827 o = cUNOPx(obase)->op_first;
11828 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11829 o = o->op_sibling->op_sibling;
11836 match = 1; /* XS or custom code could trigger random warnings */
11841 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11842 return sv_2mortal(newSVpvs("${$/}"));
11847 if (!(obase->op_flags & OPf_KIDS))
11849 o = cUNOPx(obase)->op_first;
11855 /* if all except one arg are constant, or have no side-effects,
11856 * or are optimized away, then it's unambiguous */
11858 for (kid=o; kid; kid = kid->op_sibling) {
11860 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11861 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11862 || (kid->op_type == OP_PUSHMARK)
11866 if (o2) { /* more than one found */
11873 return find_uninit_var(o2, uninit_sv, match);
11875 /* scan all args */
11877 sv = find_uninit_var(o, uninit_sv, 1);
11889 =for apidoc report_uninit
11891 Print appropriate "Use of uninitialized variable" warning
11897 Perl_report_uninit(pTHX_ SV* uninit_sv)
11901 SV* varname = NULL;
11903 varname = find_uninit_var(PL_op, uninit_sv,0);
11905 sv_insert(varname, 0, 0, " ", 1);
11907 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11908 varname ? SvPV_nolen_const(varname) : "",
11909 " in ", OP_DESC(PL_op));
11912 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11918 * c-indentation-style: bsd
11919 * c-basic-offset: 4
11920 * indent-tabs-mode: t
11923 * ex: set ts=8 sts=4 sw=4 noet: