3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
177 # define MEM_LOG_NEW_SV(sv, file, line, func) \
178 Perl_mem_log_new_sv(sv, file, line, func)
179 # define MEM_LOG_DEL_SV(sv, file, line, func) \
180 Perl_mem_log_del_sv(sv, file, line, func)
182 # define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
183 # define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
186 #ifdef DEBUG_LEAKING_SCALARS
187 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
188 # define DEBUG_SV_SERIAL(sv) \
189 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
190 PTR2UV(sv), (long)(sv)->sv_debug_serial))
192 # define FREE_SV_DEBUG_FILE(sv)
193 # define DEBUG_SV_SERIAL(sv) NOOP
197 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
198 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = (SV *)(val)
199 /* Whilst I'd love to do this, it seems that things like to check on
201 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
203 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
204 PoisonNew(&SvREFCNT(sv), 1, U32)
206 # define SvARENA_CHAIN(sv) SvANY(sv)
207 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
208 # define POSION_SV_HEAD(sv)
211 /* Mark an SV head as unused, and add to free list.
213 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
214 * its refcount artificially decremented during global destruction, so
215 * there may be dangling pointers to it. The last thing we want in that
216 * case is for it to be reused. */
218 #define plant_SV(p) \
220 const U32 old_flags = SvFLAGS(p); \
221 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
222 DEBUG_SV_SERIAL(p); \
223 FREE_SV_DEBUG_FILE(p); \
225 SvFLAGS(p) = SVTYPEMASK; \
226 if (!(old_flags & SVf_BREAK)) { \
227 SvARENA_CHAIN_SET(p, PL_sv_root); \
233 #define uproot_SV(p) \
236 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
241 /* make some more SVs by adding another arena */
250 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
251 PL_nice_chunk = NULL;
252 PL_nice_chunk_size = 0;
255 char *chunk; /* must use New here to match call to */
256 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
257 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
263 /* new_SV(): return a new, empty SV head */
265 #ifdef DEBUG_LEAKING_SCALARS
266 /* provide a real function for a debugger to play with */
268 S_new_SV(pTHX_ const char *file, int line, const char *func)
275 sv = S_more_sv(aTHX);
279 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
280 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
286 sv->sv_debug_inpad = 0;
287 sv->sv_debug_cloned = 0;
288 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
290 sv->sv_debug_serial = PL_sv_serial++;
292 MEM_LOG_NEW_SV(sv, file, line, func);
293 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
294 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
298 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
306 (p) = S_more_sv(aTHX); \
310 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
315 /* del_SV(): return an empty SV head to the free list */
328 S_del_sv(pTHX_ SV *p)
332 PERL_ARGS_ASSERT_DEL_SV;
337 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
338 const SV * const sv = sva + 1;
339 const SV * const svend = &sva[SvREFCNT(sva)];
340 if (p >= sv && p < svend) {
346 if (ckWARN_d(WARN_INTERNAL))
347 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
348 "Attempt to free non-arena SV: 0x%"UVxf
349 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
356 #else /* ! DEBUGGING */
358 #define del_SV(p) plant_SV(p)
360 #endif /* DEBUGGING */
364 =head1 SV Manipulation Functions
366 =for apidoc sv_add_arena
368 Given a chunk of memory, link it to the head of the list of arenas,
369 and split it into a list of free SVs.
375 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
378 SV* const sva = (SV*)ptr;
382 PERL_ARGS_ASSERT_SV_ADD_ARENA;
384 /* The first SV in an arena isn't an SV. */
385 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
386 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
387 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
389 PL_sv_arenaroot = sva;
390 PL_sv_root = sva + 1;
392 svend = &sva[SvREFCNT(sva) - 1];
395 SvARENA_CHAIN_SET(sv, (sv + 1));
399 /* Must always set typemask because it's always checked in on cleanup
400 when the arenas are walked looking for objects. */
401 SvFLAGS(sv) = SVTYPEMASK;
404 SvARENA_CHAIN_SET(sv, 0);
408 SvFLAGS(sv) = SVTYPEMASK;
411 /* visit(): call the named function for each non-free SV in the arenas
412 * whose flags field matches the flags/mask args. */
415 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
421 PERL_ARGS_ASSERT_VISIT;
423 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
424 register const SV * const svend = &sva[SvREFCNT(sva)];
426 for (sv = sva + 1; sv < svend; ++sv) {
427 if (SvTYPE(sv) != SVTYPEMASK
428 && (sv->sv_flags & mask) == flags
441 /* called by sv_report_used() for each live SV */
444 do_report_used(pTHX_ SV *const sv)
446 if (SvTYPE(sv) != SVTYPEMASK) {
447 PerlIO_printf(Perl_debug_log, "****\n");
454 =for apidoc sv_report_used
456 Dump the contents of all SVs not yet freed. (Debugging aid).
462 Perl_sv_report_used(pTHX)
465 visit(do_report_used, 0, 0);
471 /* called by sv_clean_objs() for each live SV */
474 do_clean_objs(pTHX_ SV *const ref)
479 SV * const target = SvRV(ref);
480 if (SvOBJECT(target)) {
481 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
482 if (SvWEAKREF(ref)) {
483 sv_del_backref(target, ref);
489 SvREFCNT_dec(target);
494 /* XXX Might want to check arrays, etc. */
497 /* called by sv_clean_objs() for each live SV */
499 #ifndef DISABLE_DESTRUCTOR_KLUDGE
501 do_clean_named_objs(pTHX_ SV *const sv)
504 assert(SvTYPE(sv) == SVt_PVGV);
505 assert(isGV_with_GP(sv));
508 #ifdef PERL_DONT_CREATE_GVSV
511 SvOBJECT(GvSV(sv))) ||
512 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
513 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
514 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
515 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
516 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
519 SvFLAGS(sv) |= SVf_BREAK;
527 =for apidoc sv_clean_objs
529 Attempt to destroy all objects not yet freed
535 Perl_sv_clean_objs(pTHX)
538 PL_in_clean_objs = TRUE;
539 visit(do_clean_objs, SVf_ROK, SVf_ROK);
540 #ifndef DISABLE_DESTRUCTOR_KLUDGE
541 /* some barnacles may yet remain, clinging to typeglobs */
542 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
544 PL_in_clean_objs = FALSE;
547 /* called by sv_clean_all() for each live SV */
550 do_clean_all(pTHX_ SV *const sv)
553 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
554 /* don't clean pid table and strtab */
557 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
558 SvFLAGS(sv) |= SVf_BREAK;
563 =for apidoc sv_clean_all
565 Decrement the refcnt of each remaining SV, possibly triggering a
566 cleanup. This function may have to be called multiple times to free
567 SVs which are in complex self-referential hierarchies.
573 Perl_sv_clean_all(pTHX)
577 PL_in_clean_all = TRUE;
578 cleaned = visit(do_clean_all, 0,0);
579 PL_in_clean_all = FALSE;
584 ARENASETS: a meta-arena implementation which separates arena-info
585 into struct arena_set, which contains an array of struct
586 arena_descs, each holding info for a single arena. By separating
587 the meta-info from the arena, we recover the 1st slot, formerly
588 borrowed for list management. The arena_set is about the size of an
589 arena, avoiding the needless malloc overhead of a naive linked-list.
591 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
592 memory in the last arena-set (1/2 on average). In trade, we get
593 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
594 smaller types). The recovery of the wasted space allows use of
595 small arenas for large, rare body types, by changing array* fields
596 in body_details_by_type[] below.
599 char *arena; /* the raw storage, allocated aligned */
600 size_t size; /* its size ~4k typ */
601 U32 misc; /* type, and in future other things. */
606 /* Get the maximum number of elements in set[] such that struct arena_set
607 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
608 therefore likely to be 1 aligned memory page. */
610 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
611 - 2 * sizeof(int)) / sizeof (struct arena_desc))
614 struct arena_set* next;
615 unsigned int set_size; /* ie ARENAS_PER_SET */
616 unsigned int curr; /* index of next available arena-desc */
617 struct arena_desc set[ARENAS_PER_SET];
621 =for apidoc sv_free_arenas
623 Deallocate the memory used by all arenas. Note that all the individual SV
624 heads and bodies within the arenas must already have been freed.
629 Perl_sv_free_arenas(pTHX)
636 /* Free arenas here, but be careful about fake ones. (We assume
637 contiguity of the fake ones with the corresponding real ones.) */
639 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
640 svanext = (SV*) SvANY(sva);
641 while (svanext && SvFAKE(svanext))
642 svanext = (SV*) SvANY(svanext);
649 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
652 struct arena_set *current = aroot;
655 assert(aroot->set[i].arena);
656 Safefree(aroot->set[i].arena);
664 i = PERL_ARENA_ROOTS_SIZE;
666 PL_body_roots[i] = 0;
668 Safefree(PL_nice_chunk);
669 PL_nice_chunk = NULL;
670 PL_nice_chunk_size = 0;
676 Here are mid-level routines that manage the allocation of bodies out
677 of the various arenas. There are 5 kinds of arenas:
679 1. SV-head arenas, which are discussed and handled above
680 2. regular body arenas
681 3. arenas for reduced-size bodies
683 5. pte arenas (thread related)
685 Arena types 2 & 3 are chained by body-type off an array of
686 arena-root pointers, which is indexed by svtype. Some of the
687 larger/less used body types are malloced singly, since a large
688 unused block of them is wasteful. Also, several svtypes dont have
689 bodies; the data fits into the sv-head itself. The arena-root
690 pointer thus has a few unused root-pointers (which may be hijacked
691 later for arena types 4,5)
693 3 differs from 2 as an optimization; some body types have several
694 unused fields in the front of the structure (which are kept in-place
695 for consistency). These bodies can be allocated in smaller chunks,
696 because the leading fields arent accessed. Pointers to such bodies
697 are decremented to point at the unused 'ghost' memory, knowing that
698 the pointers are used with offsets to the real memory.
700 HE, HEK arenas are managed separately, with separate code, but may
701 be merge-able later..
703 PTE arenas are not sv-bodies, but they share these mid-level
704 mechanics, so are considered here. The new mid-level mechanics rely
705 on the sv_type of the body being allocated, so we just reserve one
706 of the unused body-slots for PTEs, then use it in those (2) PTE
707 contexts below (line ~10k)
710 /* get_arena(size): this creates custom-sized arenas
711 TBD: export properly for hv.c: S_more_he().
714 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
717 struct arena_desc* adesc;
718 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
721 /* shouldnt need this
722 if (!arena_size) arena_size = PERL_ARENA_SIZE;
725 /* may need new arena-set to hold new arena */
726 if (!aroot || aroot->curr >= aroot->set_size) {
727 struct arena_set *newroot;
728 Newxz(newroot, 1, struct arena_set);
729 newroot->set_size = ARENAS_PER_SET;
730 newroot->next = aroot;
732 PL_body_arenas = (void *) newroot;
733 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
736 /* ok, now have arena-set with at least 1 empty/available arena-desc */
737 curr = aroot->curr++;
738 adesc = &(aroot->set[curr]);
739 assert(!adesc->arena);
741 Newx(adesc->arena, arena_size, char);
742 adesc->size = arena_size;
744 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
745 curr, (void*)adesc->arena, (UV)arena_size));
751 /* return a thing to the free list */
753 #define del_body(thing, root) \
755 void ** const thing_copy = (void **)thing;\
756 *thing_copy = *root; \
757 *root = (void*)thing_copy; \
762 =head1 SV-Body Allocation
764 Allocation of SV-bodies is similar to SV-heads, differing as follows;
765 the allocation mechanism is used for many body types, so is somewhat
766 more complicated, it uses arena-sets, and has no need for still-live
769 At the outermost level, (new|del)_X*V macros return bodies of the
770 appropriate type. These macros call either (new|del)_body_type or
771 (new|del)_body_allocated macro pairs, depending on specifics of the
772 type. Most body types use the former pair, the latter pair is used to
773 allocate body types with "ghost fields".
775 "ghost fields" are fields that are unused in certain types, and
776 consequently dont need to actually exist. They are declared because
777 they're part of a "base type", which allows use of functions as
778 methods. The simplest examples are AVs and HVs, 2 aggregate types
779 which don't use the fields which support SCALAR semantics.
781 For these types, the arenas are carved up into *_allocated size
782 chunks, we thus avoid wasted memory for those unaccessed members.
783 When bodies are allocated, we adjust the pointer back in memory by the
784 size of the bit not allocated, so it's as if we allocated the full
785 structure. (But things will all go boom if you write to the part that
786 is "not there", because you'll be overwriting the last members of the
787 preceding structure in memory.)
789 We calculate the correction using the STRUCT_OFFSET macro. For
790 example, if xpv_allocated is the same structure as XPV then the two
791 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
792 structure is smaller (no initial NV actually allocated) then the net
793 effect is to subtract the size of the NV from the pointer, to return a
794 new pointer as if an initial NV were actually allocated.
796 This is the same trick as was used for NV and IV bodies. Ironically it
797 doesn't need to be used for NV bodies any more, because NV is now at
798 the start of the structure. IV bodies don't need it either, because
799 they are no longer allocated.
801 In turn, the new_body_* allocators call S_new_body(), which invokes
802 new_body_inline macro, which takes a lock, and takes a body off the
803 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
804 necessary to refresh an empty list. Then the lock is released, and
805 the body is returned.
807 S_more_bodies calls get_arena(), and carves it up into an array of N
808 bodies, which it strings into a linked list. It looks up arena-size
809 and body-size from the body_details table described below, thus
810 supporting the multiple body-types.
812 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
813 the (new|del)_X*V macros are mapped directly to malloc/free.
819 For each sv-type, struct body_details bodies_by_type[] carries
820 parameters which control these aspects of SV handling:
822 Arena_size determines whether arenas are used for this body type, and if
823 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
824 zero, forcing individual mallocs and frees.
826 Body_size determines how big a body is, and therefore how many fit into
827 each arena. Offset carries the body-pointer adjustment needed for
828 *_allocated body types, and is used in *_allocated macros.
830 But its main purpose is to parameterize info needed in
831 Perl_sv_upgrade(). The info here dramatically simplifies the function
832 vs the implementation in 5.8.7, making it table-driven. All fields
833 are used for this, except for arena_size.
835 For the sv-types that have no bodies, arenas are not used, so those
836 PL_body_roots[sv_type] are unused, and can be overloaded. In
837 something of a special case, SVt_NULL is borrowed for HE arenas;
838 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
839 bodies_by_type[SVt_NULL] slot is not used, as the table is not
842 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
843 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
844 just use the same allocation semantics. At first, PTEs were also
845 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
846 bugs, so was simplified by claiming a new slot. This choice has no
847 consequence at this time.
851 struct body_details {
852 U8 body_size; /* Size to allocate */
853 U8 copy; /* Size of structure to copy (may be shorter) */
855 unsigned int type : 4; /* We have space for a sanity check. */
856 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
857 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
858 unsigned int arena : 1; /* Allocated from an arena */
859 size_t arena_size; /* Size of arena to allocate */
867 /* With -DPURFIY we allocate everything directly, and don't use arenas.
868 This seems a rather elegant way to simplify some of the code below. */
869 #define HASARENA FALSE
871 #define HASARENA TRUE
873 #define NOARENA FALSE
875 /* Size the arenas to exactly fit a given number of bodies. A count
876 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
877 simplifying the default. If count > 0, the arena is sized to fit
878 only that many bodies, allowing arenas to be used for large, rare
879 bodies (XPVFM, XPVIO) without undue waste. The arena size is
880 limited by PERL_ARENA_SIZE, so we can safely oversize the
883 #define FIT_ARENA0(body_size) \
884 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
885 #define FIT_ARENAn(count,body_size) \
886 ( count * body_size <= PERL_ARENA_SIZE) \
887 ? count * body_size \
888 : FIT_ARENA0 (body_size)
889 #define FIT_ARENA(count,body_size) \
891 ? FIT_ARENAn (count, body_size) \
892 : FIT_ARENA0 (body_size)
894 /* A macro to work out the offset needed to subtract from a pointer to (say)
901 to make its members accessible via a pointer to (say)
911 #define relative_STRUCT_OFFSET(longer, shorter, member) \
912 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
914 /* Calculate the length to copy. Specifically work out the length less any
915 final padding the compiler needed to add. See the comment in sv_upgrade
916 for why copying the padding proved to be a bug. */
918 #define copy_length(type, last_member) \
919 STRUCT_OFFSET(type, last_member) \
920 + sizeof (((type*)SvANY((SV*)0))->last_member)
922 static const struct body_details bodies_by_type[] = {
923 { sizeof(HE), 0, 0, SVt_NULL,
924 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
926 /* The bind placeholder pretends to be an RV for now.
927 Also it's marked as "can't upgrade" to stop anyone using it before it's
929 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
931 /* IVs are in the head, so the allocation size is 0.
932 However, the slot is overloaded for PTEs. */
933 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
934 sizeof(IV), /* This is used to copy out the IV body. */
935 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
936 NOARENA /* IVS don't need an arena */,
937 /* But PTEs need to know the size of their arena */
938 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
941 /* 8 bytes on most ILP32 with IEEE doubles */
942 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
943 FIT_ARENA(0, sizeof(NV)) },
945 /* 8 bytes on most ILP32 with IEEE doubles */
946 { sizeof(xpv_allocated),
947 copy_length(XPV, xpv_len)
948 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
949 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
950 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
953 { sizeof(xpviv_allocated),
954 copy_length(XPVIV, xiv_u)
955 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
956 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
957 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
960 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
961 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
964 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
965 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
968 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
969 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
970 SVt_REGEXP, FALSE, NONV, HASARENA,
971 FIT_ARENA(0, sizeof(struct regexp_allocated))
975 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
976 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
979 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
980 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
982 { sizeof(xpvav_allocated),
983 copy_length(XPVAV, xmg_stash)
984 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
985 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
986 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
988 { sizeof(xpvhv_allocated),
989 copy_length(XPVHV, xmg_stash)
990 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
991 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
992 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
995 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
996 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
997 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
999 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
1000 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
1001 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
1003 /* XPVIO is 84 bytes, fits 48x */
1004 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
1005 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
1006 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
1009 #define new_body_type(sv_type) \
1010 (void *)((char *)S_new_body(aTHX_ sv_type))
1012 #define del_body_type(p, sv_type) \
1013 del_body(p, &PL_body_roots[sv_type])
1016 #define new_body_allocated(sv_type) \
1017 (void *)((char *)S_new_body(aTHX_ sv_type) \
1018 - bodies_by_type[sv_type].offset)
1020 #define del_body_allocated(p, sv_type) \
1021 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
1024 #define my_safemalloc(s) (void*)safemalloc(s)
1025 #define my_safecalloc(s) (void*)safecalloc(s, 1)
1026 #define my_safefree(p) safefree((char*)p)
1030 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1031 #define del_XNV(p) my_safefree(p)
1033 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1034 #define del_XPVNV(p) my_safefree(p)
1036 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1037 #define del_XPVAV(p) my_safefree(p)
1039 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1040 #define del_XPVHV(p) my_safefree(p)
1042 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1043 #define del_XPVMG(p) my_safefree(p)
1045 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1046 #define del_XPVGV(p) my_safefree(p)
1050 #define new_XNV() new_body_type(SVt_NV)
1051 #define del_XNV(p) del_body_type(p, SVt_NV)
1053 #define new_XPVNV() new_body_type(SVt_PVNV)
1054 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1056 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1057 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1059 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1060 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1062 #define new_XPVMG() new_body_type(SVt_PVMG)
1063 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1065 #define new_XPVGV() new_body_type(SVt_PVGV)
1066 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1070 /* no arena for you! */
1072 #define new_NOARENA(details) \
1073 my_safemalloc((details)->body_size + (details)->offset)
1074 #define new_NOARENAZ(details) \
1075 my_safecalloc((details)->body_size + (details)->offset)
1078 S_more_bodies (pTHX_ const svtype sv_type)
1081 void ** const root = &PL_body_roots[sv_type];
1082 const struct body_details * const bdp = &bodies_by_type[sv_type];
1083 const size_t body_size = bdp->body_size;
1086 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1087 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1088 static bool done_sanity_check;
1090 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1091 * variables like done_sanity_check. */
1092 if (!done_sanity_check) {
1093 unsigned int i = SVt_LAST;
1095 done_sanity_check = TRUE;
1098 assert (bodies_by_type[i].type == i);
1102 assert(bdp->arena_size);
1104 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1106 end = start + arena_size - 2 * body_size;
1108 /* computed count doesnt reflect the 1st slot reservation */
1109 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1110 DEBUG_m(PerlIO_printf(Perl_debug_log,
1111 "arena %p end %p arena-size %d (from %d) type %d "
1113 (void*)start, (void*)end, (int)arena_size,
1114 (int)bdp->arena_size, sv_type, (int)body_size,
1115 (int)arena_size / (int)body_size));
1117 DEBUG_m(PerlIO_printf(Perl_debug_log,
1118 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1119 (void*)start, (void*)end,
1120 (int)bdp->arena_size, sv_type, (int)body_size,
1121 (int)bdp->arena_size / (int)body_size));
1123 *root = (void *)start;
1125 while (start <= end) {
1126 char * const next = start + body_size;
1127 *(void**) start = (void *)next;
1130 *(void **)start = 0;
1135 /* grab a new thing from the free list, allocating more if necessary.
1136 The inline version is used for speed in hot routines, and the
1137 function using it serves the rest (unless PURIFY).
1139 #define new_body_inline(xpv, sv_type) \
1141 void ** const r3wt = &PL_body_roots[sv_type]; \
1142 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1143 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1144 *(r3wt) = *(void**)(xpv); \
1150 S_new_body(pTHX_ const svtype sv_type)
1154 new_body_inline(xpv, sv_type);
1160 static const struct body_details fake_rv =
1161 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1164 =for apidoc sv_upgrade
1166 Upgrade an SV to a more complex form. Generally adds a new body type to the
1167 SV, then copies across as much information as possible from the old body.
1168 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1174 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1179 const svtype old_type = SvTYPE(sv);
1180 const struct body_details *new_type_details;
1181 const struct body_details *old_type_details
1182 = bodies_by_type + old_type;
1183 SV *referant = NULL;
1185 PERL_ARGS_ASSERT_SV_UPGRADE;
1187 if (new_type != SVt_PV && SvIsCOW(sv)) {
1188 sv_force_normal_flags(sv, 0);
1191 if (old_type == new_type)
1194 old_body = SvANY(sv);
1196 /* Copying structures onto other structures that have been neatly zeroed
1197 has a subtle gotcha. Consider XPVMG
1199 +------+------+------+------+------+-------+-------+
1200 | NV | CUR | LEN | IV | MAGIC | STASH |
1201 +------+------+------+------+------+-------+-------+
1202 0 4 8 12 16 20 24 28
1204 where NVs are aligned to 8 bytes, so that sizeof that structure is
1205 actually 32 bytes long, with 4 bytes of padding at the end:
1207 +------+------+------+------+------+-------+-------+------+
1208 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1209 +------+------+------+------+------+-------+-------+------+
1210 0 4 8 12 16 20 24 28 32
1212 so what happens if you allocate memory for this structure:
1214 +------+------+------+------+------+-------+-------+------+------+...
1215 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1216 +------+------+------+------+------+-------+-------+------+------+...
1217 0 4 8 12 16 20 24 28 32 36
1219 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1220 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1221 started out as zero once, but it's quite possible that it isn't. So now,
1222 rather than a nicely zeroed GP, you have it pointing somewhere random.
1225 (In fact, GP ends up pointing at a previous GP structure, because the
1226 principle cause of the padding in XPVMG getting garbage is a copy of
1227 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1228 this happens to be moot because XPVGV has been re-ordered, with GP
1229 no longer after STASH)
1231 So we are careful and work out the size of used parts of all the
1239 referant = SvRV(sv);
1240 old_type_details = &fake_rv;
1241 if (new_type == SVt_NV)
1242 new_type = SVt_PVNV;
1244 if (new_type < SVt_PVIV) {
1245 new_type = (new_type == SVt_NV)
1246 ? SVt_PVNV : SVt_PVIV;
1251 if (new_type < SVt_PVNV) {
1252 new_type = SVt_PVNV;
1256 assert(new_type > SVt_PV);
1257 assert(SVt_IV < SVt_PV);
1258 assert(SVt_NV < SVt_PV);
1265 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1266 there's no way that it can be safely upgraded, because perl.c
1267 expects to Safefree(SvANY(PL_mess_sv)) */
1268 assert(sv != PL_mess_sv);
1269 /* This flag bit is used to mean other things in other scalar types.
1270 Given that it only has meaning inside the pad, it shouldn't be set
1271 on anything that can get upgraded. */
1272 assert(!SvPAD_TYPED(sv));
1275 if (old_type_details->cant_upgrade)
1276 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1277 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1280 if (old_type > new_type)
1281 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1282 (int)old_type, (int)new_type);
1284 new_type_details = bodies_by_type + new_type;
1286 SvFLAGS(sv) &= ~SVTYPEMASK;
1287 SvFLAGS(sv) |= new_type;
1289 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1290 the return statements above will have triggered. */
1291 assert (new_type != SVt_NULL);
1294 assert(old_type == SVt_NULL);
1295 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1299 assert(old_type == SVt_NULL);
1300 SvANY(sv) = new_XNV();
1305 assert(new_type_details->body_size);
1308 assert(new_type_details->arena);
1309 assert(new_type_details->arena_size);
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 /* We always allocated the full length item with PURIFY. To do this
1316 we fake things so that arena is false for all 16 types.. */
1317 new_body = new_NOARENAZ(new_type_details);
1319 SvANY(sv) = new_body;
1320 if (new_type == SVt_PVAV) {
1324 if (old_type_details->body_size) {
1327 /* It will have been zeroed when the new body was allocated.
1328 Lets not write to it, in case it confuses a write-back
1334 #ifndef NODEFAULT_SHAREKEYS
1335 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1337 HvMAX(sv) = 7; /* (start with 8 buckets) */
1338 if (old_type_details->body_size) {
1341 /* It will have been zeroed when the new body was allocated.
1342 Lets not write to it, in case it confuses a write-back
1347 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1348 The target created by newSVrv also is, and it can have magic.
1349 However, it never has SvPVX set.
1351 if (old_type == SVt_IV) {
1353 } else if (old_type >= SVt_PV) {
1354 assert(SvPVX_const(sv) == 0);
1357 if (old_type >= SVt_PVMG) {
1358 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1359 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1361 sv->sv_u.svu_array = NULL; /* or svu_hash */
1367 /* XXX Is this still needed? Was it ever needed? Surely as there is
1368 no route from NV to PVIV, NOK can never be true */
1369 assert(!SvNOKp(sv));
1381 assert(new_type_details->body_size);
1382 /* We always allocated the full length item with PURIFY. To do this
1383 we fake things so that arena is false for all 16 types.. */
1384 if(new_type_details->arena) {
1385 /* This points to the start of the allocated area. */
1386 new_body_inline(new_body, new_type);
1387 Zero(new_body, new_type_details->body_size, char);
1388 new_body = ((char *)new_body) - new_type_details->offset;
1390 new_body = new_NOARENAZ(new_type_details);
1392 SvANY(sv) = new_body;
1394 if (old_type_details->copy) {
1395 /* There is now the potential for an upgrade from something without
1396 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1397 int offset = old_type_details->offset;
1398 int length = old_type_details->copy;
1400 if (new_type_details->offset > old_type_details->offset) {
1401 const int difference
1402 = new_type_details->offset - old_type_details->offset;
1403 offset += difference;
1404 length -= difference;
1406 assert (length >= 0);
1408 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1412 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1413 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1414 * correct 0.0 for us. Otherwise, if the old body didn't have an
1415 * NV slot, but the new one does, then we need to initialise the
1416 * freshly created NV slot with whatever the correct bit pattern is
1418 if (old_type_details->zero_nv && !new_type_details->zero_nv
1419 && !isGV_with_GP(sv))
1423 if (new_type == SVt_PVIO)
1424 IoPAGE_LEN(sv) = 60;
1425 if (old_type < SVt_PV) {
1426 /* referant will be NULL unless the old type was SVt_IV emulating
1428 sv->sv_u.svu_rv = referant;
1432 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1433 (unsigned long)new_type);
1436 if (old_type_details->arena) {
1437 /* If there was an old body, then we need to free it.
1438 Note that there is an assumption that all bodies of types that
1439 can be upgraded came from arenas. Only the more complex non-
1440 upgradable types are allowed to be directly malloc()ed. */
1442 my_safefree(old_body);
1444 del_body((void*)((char*)old_body + old_type_details->offset),
1445 &PL_body_roots[old_type]);
1451 =for apidoc sv_backoff
1453 Remove any string offset. You should normally use the C<SvOOK_off> macro
1460 Perl_sv_backoff(pTHX_ register SV *const sv)
1463 const char * const s = SvPVX_const(sv);
1465 PERL_ARGS_ASSERT_SV_BACKOFF;
1466 PERL_UNUSED_CONTEXT;
1469 assert(SvTYPE(sv) != SVt_PVHV);
1470 assert(SvTYPE(sv) != SVt_PVAV);
1472 SvOOK_offset(sv, delta);
1474 SvLEN_set(sv, SvLEN(sv) + delta);
1475 SvPV_set(sv, SvPVX(sv) - delta);
1476 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1477 SvFLAGS(sv) &= ~SVf_OOK;
1484 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1485 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1486 Use the C<SvGROW> wrapper instead.
1492 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1496 PERL_ARGS_ASSERT_SV_GROW;
1498 if (PL_madskills && newlen >= 0x100000) {
1499 PerlIO_printf(Perl_debug_log,
1500 "Allocation too large: %"UVxf"\n", (UV)newlen);
1502 #ifdef HAS_64K_LIMIT
1503 if (newlen >= 0x10000) {
1504 PerlIO_printf(Perl_debug_log,
1505 "Allocation too large: %"UVxf"\n", (UV)newlen);
1508 #endif /* HAS_64K_LIMIT */
1511 if (SvTYPE(sv) < SVt_PV) {
1512 sv_upgrade(sv, SVt_PV);
1513 s = SvPVX_mutable(sv);
1515 else if (SvOOK(sv)) { /* pv is offset? */
1517 s = SvPVX_mutable(sv);
1518 if (newlen > SvLEN(sv))
1519 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1520 #ifdef HAS_64K_LIMIT
1521 if (newlen >= 0x10000)
1526 s = SvPVX_mutable(sv);
1528 if (newlen > SvLEN(sv)) { /* need more room? */
1529 #ifndef Perl_safesysmalloc_size
1530 newlen = PERL_STRLEN_ROUNDUP(newlen);
1532 if (SvLEN(sv) && s) {
1533 s = (char*)saferealloc(s, newlen);
1536 s = (char*)safemalloc(newlen);
1537 if (SvPVX_const(sv) && SvCUR(sv)) {
1538 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1542 #ifdef Perl_safesysmalloc_size
1543 /* Do this here, do it once, do it right, and then we will never get
1544 called back into sv_grow() unless there really is some growing
1546 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1548 SvLEN_set(sv, newlen);
1555 =for apidoc sv_setiv
1557 Copies an integer into the given SV, upgrading first if necessary.
1558 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1564 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1568 PERL_ARGS_ASSERT_SV_SETIV;
1570 SV_CHECK_THINKFIRST_COW_DROP(sv);
1571 switch (SvTYPE(sv)) {
1574 sv_upgrade(sv, SVt_IV);
1577 sv_upgrade(sv, SVt_PVIV);
1581 if (!isGV_with_GP(sv))
1588 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1592 (void)SvIOK_only(sv); /* validate number */
1598 =for apidoc sv_setiv_mg
1600 Like C<sv_setiv>, but also handles 'set' magic.
1606 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1608 PERL_ARGS_ASSERT_SV_SETIV_MG;
1615 =for apidoc sv_setuv
1617 Copies an unsigned integer into the given SV, upgrading first if necessary.
1618 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1624 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1626 PERL_ARGS_ASSERT_SV_SETUV;
1628 /* With these two if statements:
1629 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1632 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1634 If you wish to remove them, please benchmark to see what the effect is
1636 if (u <= (UV)IV_MAX) {
1637 sv_setiv(sv, (IV)u);
1646 =for apidoc sv_setuv_mg
1648 Like C<sv_setuv>, but also handles 'set' magic.
1654 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1656 PERL_ARGS_ASSERT_SV_SETUV_MG;
1663 =for apidoc sv_setnv
1665 Copies a double into the given SV, upgrading first if necessary.
1666 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1672 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1676 PERL_ARGS_ASSERT_SV_SETNV;
1678 SV_CHECK_THINKFIRST_COW_DROP(sv);
1679 switch (SvTYPE(sv)) {
1682 sv_upgrade(sv, SVt_NV);
1686 sv_upgrade(sv, SVt_PVNV);
1690 if (!isGV_with_GP(sv))
1697 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1702 (void)SvNOK_only(sv); /* validate number */
1707 =for apidoc sv_setnv_mg
1709 Like C<sv_setnv>, but also handles 'set' magic.
1715 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1717 PERL_ARGS_ASSERT_SV_SETNV_MG;
1723 /* Print an "isn't numeric" warning, using a cleaned-up,
1724 * printable version of the offending string
1728 S_not_a_number(pTHX_ SV *const sv)
1735 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1738 dsv = newSVpvs_flags("", SVs_TEMP);
1739 pv = sv_uni_display(dsv, sv, 10, 0);
1742 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1743 /* each *s can expand to 4 chars + "...\0",
1744 i.e. need room for 8 chars */
1746 const char *s = SvPVX_const(sv);
1747 const char * const end = s + SvCUR(sv);
1748 for ( ; s < end && d < limit; s++ ) {
1750 if (ch & 128 && !isPRINT_LC(ch)) {
1759 else if (ch == '\r') {
1763 else if (ch == '\f') {
1767 else if (ch == '\\') {
1771 else if (ch == '\0') {
1775 else if (isPRINT_LC(ch))
1792 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1793 "Argument \"%s\" isn't numeric in %s", pv,
1796 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1797 "Argument \"%s\" isn't numeric", pv);
1801 =for apidoc looks_like_number
1803 Test if the content of an SV looks like a number (or is a number).
1804 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1805 non-numeric warning), even if your atof() doesn't grok them.
1811 Perl_looks_like_number(pTHX_ SV *const sv)
1813 register const char *sbegin;
1816 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1819 sbegin = SvPVX_const(sv);
1822 else if (SvPOKp(sv))
1823 sbegin = SvPV_const(sv, len);
1825 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1826 return grok_number(sbegin, len, NULL);
1830 S_glob_2number(pTHX_ GV * const gv)
1832 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1833 SV *const buffer = sv_newmortal();
1835 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1837 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1840 gv_efullname3(buffer, gv, "*");
1841 SvFLAGS(gv) |= wasfake;
1843 /* We know that all GVs stringify to something that is not-a-number,
1844 so no need to test that. */
1845 if (ckWARN(WARN_NUMERIC))
1846 not_a_number(buffer);
1847 /* We just want something true to return, so that S_sv_2iuv_common
1848 can tail call us and return true. */
1853 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1855 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1856 SV *const buffer = sv_newmortal();
1858 PERL_ARGS_ASSERT_GLOB_2PV;
1860 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1863 gv_efullname3(buffer, gv, "*");
1864 SvFLAGS(gv) |= wasfake;
1866 assert(SvPOK(buffer));
1868 *len = SvCUR(buffer);
1870 return SvPVX(buffer);
1873 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1874 until proven guilty, assume that things are not that bad... */
1879 As 64 bit platforms often have an NV that doesn't preserve all bits of
1880 an IV (an assumption perl has been based on to date) it becomes necessary
1881 to remove the assumption that the NV always carries enough precision to
1882 recreate the IV whenever needed, and that the NV is the canonical form.
1883 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1884 precision as a side effect of conversion (which would lead to insanity
1885 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1886 1) to distinguish between IV/UV/NV slots that have cached a valid
1887 conversion where precision was lost and IV/UV/NV slots that have a
1888 valid conversion which has lost no precision
1889 2) to ensure that if a numeric conversion to one form is requested that
1890 would lose precision, the precise conversion (or differently
1891 imprecise conversion) is also performed and cached, to prevent
1892 requests for different numeric formats on the same SV causing
1893 lossy conversion chains. (lossless conversion chains are perfectly
1898 SvIOKp is true if the IV slot contains a valid value
1899 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1900 SvNOKp is true if the NV slot contains a valid value
1901 SvNOK is true only if the NV value is accurate
1904 while converting from PV to NV, check to see if converting that NV to an
1905 IV(or UV) would lose accuracy over a direct conversion from PV to
1906 IV(or UV). If it would, cache both conversions, return NV, but mark
1907 SV as IOK NOKp (ie not NOK).
1909 While converting from PV to IV, check to see if converting that IV to an
1910 NV would lose accuracy over a direct conversion from PV to NV. If it
1911 would, cache both conversions, flag similarly.
1913 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1914 correctly because if IV & NV were set NV *always* overruled.
1915 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1916 changes - now IV and NV together means that the two are interchangeable:
1917 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1919 The benefit of this is that operations such as pp_add know that if
1920 SvIOK is true for both left and right operands, then integer addition
1921 can be used instead of floating point (for cases where the result won't
1922 overflow). Before, floating point was always used, which could lead to
1923 loss of precision compared with integer addition.
1925 * making IV and NV equal status should make maths accurate on 64 bit
1927 * may speed up maths somewhat if pp_add and friends start to use
1928 integers when possible instead of fp. (Hopefully the overhead in
1929 looking for SvIOK and checking for overflow will not outweigh the
1930 fp to integer speedup)
1931 * will slow down integer operations (callers of SvIV) on "inaccurate"
1932 values, as the change from SvIOK to SvIOKp will cause a call into
1933 sv_2iv each time rather than a macro access direct to the IV slot
1934 * should speed up number->string conversion on integers as IV is
1935 favoured when IV and NV are equally accurate
1937 ####################################################################
1938 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1939 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1940 On the other hand, SvUOK is true iff UV.
1941 ####################################################################
1943 Your mileage will vary depending your CPU's relative fp to integer
1947 #ifndef NV_PRESERVES_UV
1948 # define IS_NUMBER_UNDERFLOW_IV 1
1949 # define IS_NUMBER_UNDERFLOW_UV 2
1950 # define IS_NUMBER_IV_AND_UV 2
1951 # define IS_NUMBER_OVERFLOW_IV 4
1952 # define IS_NUMBER_OVERFLOW_UV 5
1954 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1956 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1958 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1966 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1968 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));
1969 if (SvNVX(sv) < (NV)IV_MIN) {
1970 (void)SvIOKp_on(sv);
1972 SvIV_set(sv, IV_MIN);
1973 return IS_NUMBER_UNDERFLOW_IV;
1975 if (SvNVX(sv) > (NV)UV_MAX) {
1976 (void)SvIOKp_on(sv);
1979 SvUV_set(sv, UV_MAX);
1980 return IS_NUMBER_OVERFLOW_UV;
1982 (void)SvIOKp_on(sv);
1984 /* Can't use strtol etc to convert this string. (See truth table in
1986 if (SvNVX(sv) <= (UV)IV_MAX) {
1987 SvIV_set(sv, I_V(SvNVX(sv)));
1988 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1989 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1991 /* Integer is imprecise. NOK, IOKp */
1993 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1996 SvUV_set(sv, U_V(SvNVX(sv)));
1997 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1998 if (SvUVX(sv) == UV_MAX) {
1999 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2000 possibly be preserved by NV. Hence, it must be overflow.
2002 return IS_NUMBER_OVERFLOW_UV;
2004 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2006 /* Integer is imprecise. NOK, IOKp */
2008 return IS_NUMBER_OVERFLOW_IV;
2010 #endif /* !NV_PRESERVES_UV*/
2013 S_sv_2iuv_common(pTHX_ SV *const sv)
2017 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
2020 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2021 * without also getting a cached IV/UV from it at the same time
2022 * (ie PV->NV conversion should detect loss of accuracy and cache
2023 * IV or UV at same time to avoid this. */
2024 /* IV-over-UV optimisation - choose to cache IV if possible */
2026 if (SvTYPE(sv) == SVt_NV)
2027 sv_upgrade(sv, SVt_PVNV);
2029 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2030 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2031 certainly cast into the IV range at IV_MAX, whereas the correct
2032 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2034 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2035 if (Perl_isnan(SvNVX(sv))) {
2041 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2042 SvIV_set(sv, I_V(SvNVX(sv)));
2043 if (SvNVX(sv) == (NV) SvIVX(sv)
2044 #ifndef NV_PRESERVES_UV
2045 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2046 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2047 /* Don't flag it as "accurately an integer" if the number
2048 came from a (by definition imprecise) NV operation, and
2049 we're outside the range of NV integer precision */
2053 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2055 /* scalar has trailing garbage, eg "42a" */
2057 DEBUG_c(PerlIO_printf(Perl_debug_log,
2058 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2064 /* IV not precise. No need to convert from PV, as NV
2065 conversion would already have cached IV if it detected
2066 that PV->IV would be better than PV->NV->IV
2067 flags already correct - don't set public IOK. */
2068 DEBUG_c(PerlIO_printf(Perl_debug_log,
2069 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2074 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2075 but the cast (NV)IV_MIN rounds to a the value less (more
2076 negative) than IV_MIN which happens to be equal to SvNVX ??
2077 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2078 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2079 (NV)UVX == NVX are both true, but the values differ. :-(
2080 Hopefully for 2s complement IV_MIN is something like
2081 0x8000000000000000 which will be exact. NWC */
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2086 (SvNVX(sv) == (NV) SvUVX(sv))
2087 #ifndef NV_PRESERVES_UV
2088 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2089 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2090 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2091 /* Don't flag it as "accurately an integer" if the number
2092 came from a (by definition imprecise) NV operation, and
2093 we're outside the range of NV integer precision */
2099 DEBUG_c(PerlIO_printf(Perl_debug_log,
2100 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2106 else if (SvPOKp(sv) && SvLEN(sv)) {
2108 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2109 /* We want to avoid a possible problem when we cache an IV/ a UV which
2110 may be later translated to an NV, and the resulting NV is not
2111 the same as the direct translation of the initial string
2112 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2113 be careful to ensure that the value with the .456 is around if the
2114 NV value is requested in the future).
2116 This means that if we cache such an IV/a UV, we need to cache the
2117 NV as well. Moreover, we trade speed for space, and do not
2118 cache the NV if we are sure it's not needed.
2121 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2122 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2123 == IS_NUMBER_IN_UV) {
2124 /* It's definitely an integer, only upgrade to PVIV */
2125 if (SvTYPE(sv) < SVt_PVIV)
2126 sv_upgrade(sv, SVt_PVIV);
2128 } else if (SvTYPE(sv) < SVt_PVNV)
2129 sv_upgrade(sv, SVt_PVNV);
2131 /* If NVs preserve UVs then we only use the UV value if we know that
2132 we aren't going to call atof() below. If NVs don't preserve UVs
2133 then the value returned may have more precision than atof() will
2134 return, even though value isn't perfectly accurate. */
2135 if ((numtype & (IS_NUMBER_IN_UV
2136 #ifdef NV_PRESERVES_UV
2139 )) == IS_NUMBER_IN_UV) {
2140 /* This won't turn off the public IOK flag if it was set above */
2141 (void)SvIOKp_on(sv);
2143 if (!(numtype & IS_NUMBER_NEG)) {
2145 if (value <= (UV)IV_MAX) {
2146 SvIV_set(sv, (IV)value);
2148 /* it didn't overflow, and it was positive. */
2149 SvUV_set(sv, value);
2153 /* 2s complement assumption */
2154 if (value <= (UV)IV_MIN) {
2155 SvIV_set(sv, -(IV)value);
2157 /* Too negative for an IV. This is a double upgrade, but
2158 I'm assuming it will be rare. */
2159 if (SvTYPE(sv) < SVt_PVNV)
2160 sv_upgrade(sv, SVt_PVNV);
2164 SvNV_set(sv, -(NV)value);
2165 SvIV_set(sv, IV_MIN);
2169 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2170 will be in the previous block to set the IV slot, and the next
2171 block to set the NV slot. So no else here. */
2173 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2174 != IS_NUMBER_IN_UV) {
2175 /* It wasn't an (integer that doesn't overflow the UV). */
2176 SvNV_set(sv, Atof(SvPVX_const(sv)));
2178 if (! numtype && ckWARN(WARN_NUMERIC))
2181 #if defined(USE_LONG_DOUBLE)
2182 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2183 PTR2UV(sv), SvNVX(sv)));
2185 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2186 PTR2UV(sv), SvNVX(sv)));
2189 #ifdef NV_PRESERVES_UV
2190 (void)SvIOKp_on(sv);
2192 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2193 SvIV_set(sv, I_V(SvNVX(sv)));
2194 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2197 NOOP; /* Integer is imprecise. NOK, IOKp */
2199 /* UV will not work better than IV */
2201 if (SvNVX(sv) > (NV)UV_MAX) {
2203 /* Integer is inaccurate. NOK, IOKp, is UV */
2204 SvUV_set(sv, UV_MAX);
2206 SvUV_set(sv, U_V(SvNVX(sv)));
2207 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2208 NV preservse UV so can do correct comparison. */
2209 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2212 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2217 #else /* NV_PRESERVES_UV */
2218 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2219 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2220 /* The IV/UV slot will have been set from value returned by
2221 grok_number above. The NV slot has just been set using
2224 assert (SvIOKp(sv));
2226 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2227 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2228 /* Small enough to preserve all bits. */
2229 (void)SvIOKp_on(sv);
2231 SvIV_set(sv, I_V(SvNVX(sv)));
2232 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2234 /* Assumption: first non-preserved integer is < IV_MAX,
2235 this NV is in the preserved range, therefore: */
2236 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2238 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);
2242 0 0 already failed to read UV.
2243 0 1 already failed to read UV.
2244 1 0 you won't get here in this case. IV/UV
2245 slot set, public IOK, Atof() unneeded.
2246 1 1 already read UV.
2247 so there's no point in sv_2iuv_non_preserve() attempting
2248 to use atol, strtol, strtoul etc. */
2250 sv_2iuv_non_preserve (sv, numtype);
2252 sv_2iuv_non_preserve (sv);
2256 #endif /* NV_PRESERVES_UV */
2257 /* It might be more code efficient to go through the entire logic above
2258 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2259 gets complex and potentially buggy, so more programmer efficient
2260 to do it this way, by turning off the public flags: */
2262 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2266 if (isGV_with_GP(sv))
2267 return glob_2number((GV *)sv);
2269 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2270 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2273 if (SvTYPE(sv) < SVt_IV)
2274 /* Typically the caller expects that sv_any is not NULL now. */
2275 sv_upgrade(sv, SVt_IV);
2276 /* Return 0 from the caller. */
2283 =for apidoc sv_2iv_flags
2285 Return the integer value of an SV, doing any necessary string
2286 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2287 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2293 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2298 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2299 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2300 cache IVs just in case. In practice it seems that they never
2301 actually anywhere accessible by user Perl code, let alone get used
2302 in anything other than a string context. */
2303 if (flags & SV_GMAGIC)
2308 return I_V(SvNVX(sv));
2310 if (SvPOKp(sv) && SvLEN(sv)) {
2313 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2315 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2316 == IS_NUMBER_IN_UV) {
2317 /* It's definitely an integer */
2318 if (numtype & IS_NUMBER_NEG) {
2319 if (value < (UV)IV_MIN)
2322 if (value < (UV)IV_MAX)
2327 if (ckWARN(WARN_NUMERIC))
2330 return I_V(Atof(SvPVX_const(sv)));
2335 assert(SvTYPE(sv) >= SVt_PVMG);
2336 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2337 } else if (SvTHINKFIRST(sv)) {
2341 SV * const tmpstr=AMG_CALLun(sv,numer);
2342 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2343 return SvIV(tmpstr);
2346 return PTR2IV(SvRV(sv));
2349 sv_force_normal_flags(sv, 0);
2351 if (SvREADONLY(sv) && !SvOK(sv)) {
2352 if (ckWARN(WARN_UNINITIALIZED))
2358 if (S_sv_2iuv_common(aTHX_ sv))
2361 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2362 PTR2UV(sv),SvIVX(sv)));
2363 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2367 =for apidoc sv_2uv_flags
2369 Return the unsigned integer value of an SV, doing any necessary string
2370 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2371 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2377 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2382 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2383 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2384 cache IVs just in case. */
2385 if (flags & SV_GMAGIC)
2390 return U_V(SvNVX(sv));
2391 if (SvPOKp(sv) && SvLEN(sv)) {
2394 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2396 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2397 == IS_NUMBER_IN_UV) {
2398 /* It's definitely an integer */
2399 if (!(numtype & IS_NUMBER_NEG))
2403 if (ckWARN(WARN_NUMERIC))
2406 return U_V(Atof(SvPVX_const(sv)));
2411 assert(SvTYPE(sv) >= SVt_PVMG);
2412 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2413 } else if (SvTHINKFIRST(sv)) {
2417 SV *const tmpstr = AMG_CALLun(sv,numer);
2418 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2419 return SvUV(tmpstr);
2422 return PTR2UV(SvRV(sv));
2425 sv_force_normal_flags(sv, 0);
2427 if (SvREADONLY(sv) && !SvOK(sv)) {
2428 if (ckWARN(WARN_UNINITIALIZED))
2434 if (S_sv_2iuv_common(aTHX_ sv))
2438 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2439 PTR2UV(sv),SvUVX(sv)));
2440 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2446 Return the num value of an SV, doing any necessary string or integer
2447 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2454 Perl_sv_2nv(pTHX_ register SV *const sv)
2459 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2460 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2461 cache IVs just in case. */
2465 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2466 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2467 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2469 return Atof(SvPVX_const(sv));
2473 return (NV)SvUVX(sv);
2475 return (NV)SvIVX(sv);
2480 assert(SvTYPE(sv) >= SVt_PVMG);
2481 /* This falls through to the report_uninit near the end of the
2483 } else if (SvTHINKFIRST(sv)) {
2487 SV *const tmpstr = AMG_CALLun(sv,numer);
2488 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2489 return SvNV(tmpstr);
2492 return PTR2NV(SvRV(sv));
2495 sv_force_normal_flags(sv, 0);
2497 if (SvREADONLY(sv) && !SvOK(sv)) {
2498 if (ckWARN(WARN_UNINITIALIZED))
2503 if (SvTYPE(sv) < SVt_NV) {
2504 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2505 sv_upgrade(sv, SVt_NV);
2506 #ifdef USE_LONG_DOUBLE
2508 STORE_NUMERIC_LOCAL_SET_STANDARD();
2509 PerlIO_printf(Perl_debug_log,
2510 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2511 PTR2UV(sv), SvNVX(sv));
2512 RESTORE_NUMERIC_LOCAL();
2516 STORE_NUMERIC_LOCAL_SET_STANDARD();
2517 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2518 PTR2UV(sv), SvNVX(sv));
2519 RESTORE_NUMERIC_LOCAL();
2523 else if (SvTYPE(sv) < SVt_PVNV)
2524 sv_upgrade(sv, SVt_PVNV);
2529 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2530 #ifdef NV_PRESERVES_UV
2536 /* Only set the public NV OK flag if this NV preserves the IV */
2537 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2539 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2540 : (SvIVX(sv) == I_V(SvNVX(sv))))
2546 else if (SvPOKp(sv) && SvLEN(sv)) {
2548 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2549 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2551 #ifdef NV_PRESERVES_UV
2552 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2553 == IS_NUMBER_IN_UV) {
2554 /* It's definitely an integer */
2555 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2557 SvNV_set(sv, Atof(SvPVX_const(sv)));
2563 SvNV_set(sv, Atof(SvPVX_const(sv)));
2564 /* Only set the public NV OK flag if this NV preserves the value in
2565 the PV at least as well as an IV/UV would.
2566 Not sure how to do this 100% reliably. */
2567 /* if that shift count is out of range then Configure's test is
2568 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2570 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2571 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2572 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2573 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2574 /* Can't use strtol etc to convert this string, so don't try.
2575 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2578 /* value has been set. It may not be precise. */
2579 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2580 /* 2s complement assumption for (UV)IV_MIN */
2581 SvNOK_on(sv); /* Integer is too negative. */
2586 if (numtype & IS_NUMBER_NEG) {
2587 SvIV_set(sv, -(IV)value);
2588 } else if (value <= (UV)IV_MAX) {
2589 SvIV_set(sv, (IV)value);
2591 SvUV_set(sv, value);
2595 if (numtype & IS_NUMBER_NOT_INT) {
2596 /* I believe that even if the original PV had decimals,
2597 they are lost beyond the limit of the FP precision.
2598 However, neither is canonical, so both only get p
2599 flags. NWC, 2000/11/25 */
2600 /* Both already have p flags, so do nothing */
2602 const NV nv = SvNVX(sv);
2603 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2604 if (SvIVX(sv) == I_V(nv)) {
2607 /* It had no "." so it must be integer. */
2611 /* between IV_MAX and NV(UV_MAX).
2612 Could be slightly > UV_MAX */
2614 if (numtype & IS_NUMBER_NOT_INT) {
2615 /* UV and NV both imprecise. */
2617 const UV nv_as_uv = U_V(nv);
2619 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2628 /* It might be more code efficient to go through the entire logic above
2629 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2630 gets complex and potentially buggy, so more programmer efficient
2631 to do it this way, by turning off the public flags: */
2633 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2634 #endif /* NV_PRESERVES_UV */
2637 if (isGV_with_GP(sv)) {
2638 glob_2number((GV *)sv);
2642 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2644 assert (SvTYPE(sv) >= SVt_NV);
2645 /* Typically the caller expects that sv_any is not NULL now. */
2646 /* XXX Ilya implies that this is a bug in callers that assume this
2647 and ideally should be fixed. */
2650 #if defined(USE_LONG_DOUBLE)
2652 STORE_NUMERIC_LOCAL_SET_STANDARD();
2653 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2654 PTR2UV(sv), SvNVX(sv));
2655 RESTORE_NUMERIC_LOCAL();
2659 STORE_NUMERIC_LOCAL_SET_STANDARD();
2660 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2661 PTR2UV(sv), SvNVX(sv));
2662 RESTORE_NUMERIC_LOCAL();
2671 Return an SV with the numeric value of the source SV, doing any necessary
2672 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2673 access this function.
2679 Perl_sv_2num(pTHX_ register SV *const sv)
2681 PERL_ARGS_ASSERT_SV_2NUM;
2686 SV * const tmpsv = AMG_CALLun(sv,numer);
2687 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2688 return sv_2num(tmpsv);
2690 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2693 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2694 * UV as a string towards the end of buf, and return pointers to start and
2697 * We assume that buf is at least TYPE_CHARS(UV) long.
2701 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2703 char *ptr = buf + TYPE_CHARS(UV);
2704 char * const ebuf = ptr;
2707 PERL_ARGS_ASSERT_UIV_2BUF;
2719 *--ptr = '0' + (char)(uv % 10);
2728 =for apidoc sv_2pv_flags
2730 Returns a pointer to the string value of an SV, and sets *lp to its length.
2731 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2733 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2734 usually end up here too.
2740 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2750 if (SvGMAGICAL(sv)) {
2751 if (flags & SV_GMAGIC)
2756 if (flags & SV_MUTABLE_RETURN)
2757 return SvPVX_mutable(sv);
2758 if (flags & SV_CONST_RETURN)
2759 return (char *)SvPVX_const(sv);
2762 if (SvIOKp(sv) || SvNOKp(sv)) {
2763 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2768 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2769 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2771 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2778 #ifdef FIXNEGATIVEZERO
2779 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2785 SvUPGRADE(sv, SVt_PV);
2788 s = SvGROW_mutable(sv, len + 1);
2791 return (char*)memcpy(s, tbuf, len + 1);
2797 assert(SvTYPE(sv) >= SVt_PVMG);
2798 /* This falls through to the report_uninit near the end of the
2800 } else if (SvTHINKFIRST(sv)) {
2804 SV *const tmpstr = AMG_CALLun(sv,string);
2805 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2807 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2811 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2812 if (flags & SV_CONST_RETURN) {
2813 pv = (char *) SvPVX_const(tmpstr);
2815 pv = (flags & SV_MUTABLE_RETURN)
2816 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2819 *lp = SvCUR(tmpstr);
2821 pv = sv_2pv_flags(tmpstr, lp, flags);
2834 const SV *const referent = (SV*)SvRV(sv);
2838 retval = buffer = savepvn("NULLREF", len);
2839 } else if (SvTYPE(referent) == SVt_REGEXP) {
2840 const REGEXP * const re = (REGEXP *)referent;
2845 /* If the regex is UTF-8 we want the containing scalar to
2846 have an UTF-8 flag too */
2852 if ((seen_evals = RX_SEEN_EVALS(re)))
2853 PL_reginterp_cnt += seen_evals;
2856 *lp = RX_WRAPLEN(re);
2858 return RX_WRAPPED(re);
2860 const char *const typestr = sv_reftype(referent, 0);
2861 const STRLEN typelen = strlen(typestr);
2862 UV addr = PTR2UV(referent);
2863 const char *stashname = NULL;
2864 STRLEN stashnamelen = 0; /* hush, gcc */
2865 const char *buffer_end;
2867 if (SvOBJECT(referent)) {
2868 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2871 stashname = HEK_KEY(name);
2872 stashnamelen = HEK_LEN(name);
2874 if (HEK_UTF8(name)) {
2880 stashname = "__ANON__";
2883 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2884 + 2 * sizeof(UV) + 2 /* )\0 */;
2886 len = typelen + 3 /* (0x */
2887 + 2 * sizeof(UV) + 2 /* )\0 */;
2890 Newx(buffer, len, char);
2891 buffer_end = retval = buffer + len;
2893 /* Working backwards */
2897 *--retval = PL_hexdigit[addr & 15];
2898 } while (addr >>= 4);
2904 memcpy(retval, typestr, typelen);
2908 retval -= stashnamelen;
2909 memcpy(retval, stashname, stashnamelen);
2911 /* retval may not neccesarily have reached the start of the
2913 assert (retval >= buffer);
2915 len = buffer_end - retval - 1; /* -1 for that \0 */
2923 if (SvREADONLY(sv) && !SvOK(sv)) {
2926 if (flags & SV_UNDEF_RETURNS_NULL)
2928 if (ckWARN(WARN_UNINITIALIZED))
2933 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2934 /* I'm assuming that if both IV and NV are equally valid then
2935 converting the IV is going to be more efficient */
2936 const U32 isUIOK = SvIsUV(sv);
2937 char buf[TYPE_CHARS(UV)];
2941 if (SvTYPE(sv) < SVt_PVIV)
2942 sv_upgrade(sv, SVt_PVIV);
2943 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2945 /* inlined from sv_setpvn */
2946 s = SvGROW_mutable(sv, len + 1);
2947 Move(ptr, s, len, char);
2951 else if (SvNOKp(sv)) {
2952 const int olderrno = errno;
2953 if (SvTYPE(sv) < SVt_PVNV)
2954 sv_upgrade(sv, SVt_PVNV);
2955 /* The +20 is pure guesswork. Configure test needed. --jhi */
2956 s = SvGROW_mutable(sv, NV_DIG + 20);
2957 /* some Xenix systems wipe out errno here */
2959 if (SvNVX(sv) == 0.0)
2960 my_strlcpy(s, "0", SvLEN(sv));
2964 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2967 #ifdef FIXNEGATIVEZERO
2968 if (*s == '-' && s[1] == '0' && !s[2]) {
2980 if (isGV_with_GP(sv))
2981 return glob_2pv((GV *)sv, lp);
2985 if (flags & SV_UNDEF_RETURNS_NULL)
2987 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2989 if (SvTYPE(sv) < SVt_PV)
2990 /* Typically the caller expects that sv_any is not NULL now. */
2991 sv_upgrade(sv, SVt_PV);
2995 const STRLEN len = s - SvPVX_const(sv);
3001 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3002 PTR2UV(sv),SvPVX_const(sv)));
3003 if (flags & SV_CONST_RETURN)
3004 return (char *)SvPVX_const(sv);
3005 if (flags & SV_MUTABLE_RETURN)
3006 return SvPVX_mutable(sv);
3011 =for apidoc sv_copypv
3013 Copies a stringified representation of the source SV into the
3014 destination SV. Automatically performs any necessary mg_get and
3015 coercion of numeric values into strings. Guaranteed to preserve
3016 UTF8 flag even from overloaded objects. Similar in nature to
3017 sv_2pv[_flags] but operates directly on an SV instead of just the
3018 string. Mostly uses sv_2pv_flags to do its work, except when that
3019 would lose the UTF-8'ness of the PV.
3025 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3028 const char * const s = SvPV_const(ssv,len);
3030 PERL_ARGS_ASSERT_SV_COPYPV;
3032 sv_setpvn(dsv,s,len);
3040 =for apidoc sv_2pvbyte
3042 Return a pointer to the byte-encoded representation of the SV, and set *lp
3043 to its length. May cause the SV to be downgraded from UTF-8 as a
3046 Usually accessed via the C<SvPVbyte> macro.
3052 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3054 PERL_ARGS_ASSERT_SV_2PVBYTE;
3056 sv_utf8_downgrade(sv,0);
3057 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3061 =for apidoc sv_2pvutf8
3063 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3064 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3066 Usually accessed via the C<SvPVutf8> macro.
3072 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3074 PERL_ARGS_ASSERT_SV_2PVUTF8;
3076 sv_utf8_upgrade(sv);
3077 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3082 =for apidoc sv_2bool
3084 This function is only called on magical items, and is only used by
3085 sv_true() or its macro equivalent.
3091 Perl_sv_2bool(pTHX_ register SV *const sv)
3095 PERL_ARGS_ASSERT_SV_2BOOL;
3103 SV * const tmpsv = AMG_CALLun(sv,bool_);
3104 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3105 return (bool)SvTRUE(tmpsv);
3107 return SvRV(sv) != 0;
3110 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3112 (*sv->sv_u.svu_pv > '0' ||
3113 Xpvtmp->xpv_cur > 1 ||
3114 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3121 return SvIVX(sv) != 0;
3124 return SvNVX(sv) != 0.0;
3126 if (isGV_with_GP(sv))
3136 =for apidoc sv_utf8_upgrade
3138 Converts the PV of an SV to its UTF-8-encoded form.
3139 Forces the SV to string form if it is not already.
3140 Always sets the SvUTF8 flag to avoid future validity checks even
3141 if all the bytes have hibit clear.
3143 This is not as a general purpose byte encoding to Unicode interface:
3144 use the Encode extension for that.
3146 =for apidoc sv_utf8_upgrade_flags
3148 Converts the PV of an SV to its UTF-8-encoded form.
3149 Forces the SV to string form if it is not already.
3150 Always sets the SvUTF8 flag to avoid future validity checks even
3151 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3152 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3153 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3155 This is not as a general purpose byte encoding to Unicode interface:
3156 use the Encode extension for that.
3162 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3166 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3168 if (sv == &PL_sv_undef)
3172 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3173 (void) sv_2pv_flags(sv,&len, flags);
3177 (void) SvPV_force(sv,len);
3186 sv_force_normal_flags(sv, 0);
3189 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3190 sv_recode_to_utf8(sv, PL_encoding);
3191 else { /* Assume Latin-1/EBCDIC */
3192 /* This function could be much more efficient if we
3193 * had a FLAG in SVs to signal if there are any hibit
3194 * chars in the PV. Given that there isn't such a flag
3195 * make the loop as fast as possible. */
3196 const U8 * const s = (U8 *) SvPVX_const(sv);
3197 const U8 * const e = (U8 *) SvEND(sv);
3202 /* Check for hi bit */
3203 if (!NATIVE_IS_INVARIANT(ch)) {
3204 STRLEN len = SvCUR(sv);
3205 /* *Currently* bytes_to_utf8() adds a '\0' after every string
3206 it converts. This isn't documented. It's not clear if it's
3207 a bad thing to be doing, and should be changed to do exactly
3208 what the documentation says. If so, this code will have to
3210 As is, we mustn't rely on our incoming SV being well formed
3211 and having a trailing '\0', as certain code in pp_formline
3212 can send us partially built SVs. */
3213 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3215 SvPV_free(sv); /* No longer using what was there before. */
3216 SvPV_set(sv, (char*)recoded);
3218 SvLEN_set(sv, len + 1); /* No longer know the real size. */
3222 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3229 =for apidoc sv_utf8_downgrade
3231 Attempts to convert the PV of an SV from characters to bytes.
3232 If the PV contains a character beyond byte, this conversion will fail;
3233 in this case, either returns false or, if C<fail_ok> is not
3236 This is not as a general purpose Unicode to byte encoding interface:
3237 use the Encode extension for that.
3243 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3247 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3249 if (SvPOKp(sv) && SvUTF8(sv)) {
3255 sv_force_normal_flags(sv, 0);
3257 s = (U8 *) SvPV(sv, len);
3258 if (!utf8_to_bytes(s, &len)) {
3263 Perl_croak(aTHX_ "Wide character in %s",
3266 Perl_croak(aTHX_ "Wide character");
3277 =for apidoc sv_utf8_encode
3279 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3280 flag off so that it looks like octets again.
3286 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3288 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3291 sv_force_normal_flags(sv, 0);
3293 if (SvREADONLY(sv)) {
3294 Perl_croak(aTHX_ PL_no_modify);
3296 (void) sv_utf8_upgrade(sv);
3301 =for apidoc sv_utf8_decode
3303 If the PV of the SV is an octet sequence in UTF-8
3304 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3305 so that it looks like a character. If the PV contains only single-byte
3306 characters, the C<SvUTF8> flag stays being off.
3307 Scans PV for validity and returns false if the PV is invalid UTF-8.
3313 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3315 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3321 /* The octets may have got themselves encoded - get them back as
3324 if (!sv_utf8_downgrade(sv, TRUE))
3327 /* it is actually just a matter of turning the utf8 flag on, but
3328 * we want to make sure everything inside is valid utf8 first.
3330 c = (const U8 *) SvPVX_const(sv);
3331 if (!is_utf8_string(c, SvCUR(sv)+1))
3333 e = (const U8 *) SvEND(sv);
3336 if (!UTF8_IS_INVARIANT(ch)) {
3346 =for apidoc sv_setsv
3348 Copies the contents of the source SV C<ssv> into the destination SV
3349 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3350 function if the source SV needs to be reused. Does not handle 'set' magic.
3351 Loosely speaking, it performs a copy-by-value, obliterating any previous
3352 content of the destination.
3354 You probably want to use one of the assortment of wrappers, such as
3355 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3356 C<SvSetMagicSV_nosteal>.
3358 =for apidoc sv_setsv_flags
3360 Copies the contents of the source SV C<ssv> into the destination SV
3361 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3362 function if the source SV needs to be reused. Does not handle 'set' magic.
3363 Loosely speaking, it performs a copy-by-value, obliterating any previous
3364 content of the destination.
3365 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3366 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3367 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3368 and C<sv_setsv_nomg> are implemented in terms of this function.
3370 You probably want to use one of the assortment of wrappers, such as
3371 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3372 C<SvSetMagicSV_nosteal>.
3374 This is the primary function for copying scalars, and most other
3375 copy-ish functions and macros use this underneath.
3381 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3383 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3385 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3387 if (dtype != SVt_PVGV) {
3388 const char * const name = GvNAME(sstr);
3389 const STRLEN len = GvNAMELEN(sstr);
3391 if (dtype >= SVt_PV) {
3397 SvUPGRADE(dstr, SVt_PVGV);
3398 (void)SvOK_off(dstr);
3399 /* FIXME - why are we doing this, then turning it off and on again
3401 isGV_with_GP_on(dstr);
3403 GvSTASH(dstr) = GvSTASH(sstr);
3405 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3406 gv_name_set((GV *)dstr, name, len, GV_ADD);
3407 SvFAKE_on(dstr); /* can coerce to non-glob */
3410 #ifdef GV_UNIQUE_CHECK
3411 if (GvUNIQUE((GV*)dstr)) {
3412 Perl_croak(aTHX_ PL_no_modify);
3416 if(GvGP((GV*)sstr)) {
3417 /* If source has method cache entry, clear it */
3419 SvREFCNT_dec(GvCV(sstr));
3423 /* If source has a real method, then a method is
3425 else if(GvCV((GV*)sstr)) {
3430 /* If dest already had a real method, that's a change as well */
3431 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3435 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3439 isGV_with_GP_off(dstr);
3440 (void)SvOK_off(dstr);
3441 isGV_with_GP_on(dstr);
3442 GvINTRO_off(dstr); /* one-shot flag */
3443 GvGP(dstr) = gp_ref(GvGP(sstr));
3444 if (SvTAINTED(sstr))
3446 if (GvIMPORTED(dstr) != GVf_IMPORTED
3447 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3449 GvIMPORTED_on(dstr);
3452 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3453 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3458 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3460 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3462 const int intro = GvINTRO(dstr);
3465 const U32 stype = SvTYPE(sref);
3467 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3469 #ifdef GV_UNIQUE_CHECK
3470 if (GvUNIQUE((GV*)dstr)) {
3471 Perl_croak(aTHX_ PL_no_modify);
3476 GvINTRO_off(dstr); /* one-shot flag */
3477 GvLINE(dstr) = CopLINE(PL_curcop);
3478 GvEGV(dstr) = (GV*)dstr;
3483 location = (SV **) &GvCV(dstr);
3484 import_flag = GVf_IMPORTED_CV;
3487 location = (SV **) &GvHV(dstr);
3488 import_flag = GVf_IMPORTED_HV;
3491 location = (SV **) &GvAV(dstr);
3492 import_flag = GVf_IMPORTED_AV;
3495 location = (SV **) &GvIOp(dstr);
3498 location = (SV **) &GvFORM(dstr);
3500 location = &GvSV(dstr);
3501 import_flag = GVf_IMPORTED_SV;
3504 if (stype == SVt_PVCV) {
3505 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3506 if (GvCVGEN(dstr)) {
3507 SvREFCNT_dec(GvCV(dstr));
3509 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3512 SAVEGENERICSV(*location);
3516 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3517 CV* const cv = MUTABLE_CV(*location);
3519 if (!GvCVGEN((GV*)dstr) &&
3520 (CvROOT(cv) || CvXSUB(cv)))
3522 /* Redefining a sub - warning is mandatory if
3523 it was a const and its value changed. */
3524 if (CvCONST(cv) && CvCONST((const CV *)sref)
3526 == cv_const_sv((const CV *)sref)) {
3528 /* They are 2 constant subroutines generated from
3529 the same constant. This probably means that
3530 they are really the "same" proxy subroutine
3531 instantiated in 2 places. Most likely this is
3532 when a constant is exported twice. Don't warn.
3535 else if (ckWARN(WARN_REDEFINE)
3537 && (!CvCONST((const CV *)sref)
3538 || sv_cmp(cv_const_sv(cv),
3539 cv_const_sv((const CV *)
3541 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3544 ? "Constant subroutine %s::%s redefined"
3545 : "Subroutine %s::%s redefined"),
3546 HvNAME_get(GvSTASH((GV*)dstr)),
3547 GvENAME((GV*)dstr));
3551 cv_ckproto_len(cv, (GV*)dstr,
3552 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3553 SvPOK(sref) ? SvCUR(sref) : 0);
3555 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3556 GvASSUMECV_on(dstr);
3557 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3560 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3561 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3562 GvFLAGS(dstr) |= import_flag;
3567 if (SvTAINTED(sstr))
3573 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3576 register U32 sflags;
3578 register svtype stype;
3580 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3585 if (SvIS_FREED(dstr)) {
3586 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3587 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3589 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3591 sstr = &PL_sv_undef;
3592 if (SvIS_FREED(sstr)) {
3593 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3594 (void*)sstr, (void*)dstr);
3596 stype = SvTYPE(sstr);
3597 dtype = SvTYPE(dstr);
3599 (void)SvAMAGIC_off(dstr);
3602 /* need to nuke the magic */
3606 /* There's a lot of redundancy below but we're going for speed here */
3611 if (dtype != SVt_PVGV) {
3612 (void)SvOK_off(dstr);
3620 sv_upgrade(dstr, SVt_IV);
3624 sv_upgrade(dstr, SVt_PVIV);
3627 goto end_of_first_switch;
3629 (void)SvIOK_only(dstr);
3630 SvIV_set(dstr, SvIVX(sstr));
3633 /* SvTAINTED can only be true if the SV has taint magic, which in
3634 turn means that the SV type is PVMG (or greater). This is the
3635 case statement for SVt_IV, so this cannot be true (whatever gcov
3637 assert(!SvTAINTED(sstr));
3642 if (dtype < SVt_PV && dtype != SVt_IV)
3643 sv_upgrade(dstr, SVt_IV);
3651 sv_upgrade(dstr, SVt_NV);
3655 sv_upgrade(dstr, SVt_PVNV);
3658 goto end_of_first_switch;
3660 SvNV_set(dstr, SvNVX(sstr));
3661 (void)SvNOK_only(dstr);
3662 /* SvTAINTED can only be true if the SV has taint magic, which in
3663 turn means that the SV type is PVMG (or greater). This is the
3664 case statement for SVt_NV, so this cannot be true (whatever gcov
3666 assert(!SvTAINTED(sstr));
3672 #ifdef PERL_OLD_COPY_ON_WRITE
3673 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3674 if (dtype < SVt_PVIV)
3675 sv_upgrade(dstr, SVt_PVIV);
3683 sv_upgrade(dstr, SVt_PV);
3686 if (dtype < SVt_PVIV)
3687 sv_upgrade(dstr, SVt_PVIV);
3690 if (dtype < SVt_PVNV)
3691 sv_upgrade(dstr, SVt_PVNV);
3695 const char * const type = sv_reftype(sstr,0);
3697 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3699 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3703 /* case SVt_BIND: */
3706 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3707 glob_assign_glob(dstr, sstr, dtype);
3710 /* SvVALID means that this PVGV is playing at being an FBM. */
3714 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3716 if (SvTYPE(sstr) != stype) {
3717 stype = SvTYPE(sstr);
3718 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3719 glob_assign_glob(dstr, sstr, dtype);
3724 if (stype == SVt_PVLV)
3725 SvUPGRADE(dstr, SVt_PVNV);
3727 SvUPGRADE(dstr, (svtype)stype);
3729 end_of_first_switch:
3731 /* dstr may have been upgraded. */
3732 dtype = SvTYPE(dstr);
3733 sflags = SvFLAGS(sstr);
3735 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3736 /* Assigning to a subroutine sets the prototype. */
3739 const char *const ptr = SvPV_const(sstr, len);
3741 SvGROW(dstr, len + 1);
3742 Copy(ptr, SvPVX(dstr), len + 1, char);
3743 SvCUR_set(dstr, len);
3745 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3749 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3750 const char * const type = sv_reftype(dstr,0);
3752 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3754 Perl_croak(aTHX_ "Cannot copy to %s", type);
3755 } else if (sflags & SVf_ROK) {
3756 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3757 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3760 if (GvIMPORTED(dstr) != GVf_IMPORTED
3761 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3763 GvIMPORTED_on(dstr);
3768 glob_assign_glob(dstr, sstr, dtype);
3772 if (dtype >= SVt_PV) {
3773 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3774 glob_assign_ref(dstr, sstr);
3777 if (SvPVX_const(dstr)) {
3783 (void)SvOK_off(dstr);
3784 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3785 SvFLAGS(dstr) |= sflags & SVf_ROK;
3786 assert(!(sflags & SVp_NOK));
3787 assert(!(sflags & SVp_IOK));
3788 assert(!(sflags & SVf_NOK));
3789 assert(!(sflags & SVf_IOK));
3791 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3792 if (!(sflags & SVf_OK)) {
3793 if (ckWARN(WARN_MISC))
3794 Perl_warner(aTHX_ packWARN(WARN_MISC),
3795 "Undefined value assigned to typeglob");
3798 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3799 if (dstr != (SV*)gv) {
3802 GvGP(dstr) = gp_ref(GvGP(gv));
3806 else if (sflags & SVp_POK) {
3810 * Check to see if we can just swipe the string. If so, it's a
3811 * possible small lose on short strings, but a big win on long ones.
3812 * It might even be a win on short strings if SvPVX_const(dstr)
3813 * has to be allocated and SvPVX_const(sstr) has to be freed.
3814 * Likewise if we can set up COW rather than doing an actual copy, we
3815 * drop to the else clause, as the swipe code and the COW setup code
3816 * have much in common.
3819 /* Whichever path we take through the next code, we want this true,
3820 and doing it now facilitates the COW check. */
3821 (void)SvPOK_only(dstr);
3824 /* If we're already COW then this clause is not true, and if COW
3825 is allowed then we drop down to the else and make dest COW
3826 with us. If caller hasn't said that we're allowed to COW
3827 shared hash keys then we don't do the COW setup, even if the
3828 source scalar is a shared hash key scalar. */
3829 (((flags & SV_COW_SHARED_HASH_KEYS)
3830 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3831 : 1 /* If making a COW copy is forbidden then the behaviour we
3832 desire is as if the source SV isn't actually already
3833 COW, even if it is. So we act as if the source flags
3834 are not COW, rather than actually testing them. */
3836 #ifndef PERL_OLD_COPY_ON_WRITE
3837 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3838 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3839 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3840 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3841 but in turn, it's somewhat dead code, never expected to go
3842 live, but more kept as a placeholder on how to do it better
3843 in a newer implementation. */
3844 /* If we are COW and dstr is a suitable target then we drop down
3845 into the else and make dest a COW of us. */
3846 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3851 (sflags & SVs_TEMP) && /* slated for free anyway? */
3852 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3853 (!(flags & SV_NOSTEAL)) &&
3854 /* and we're allowed to steal temps */
3855 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3856 SvLEN(sstr) && /* and really is a string */
3857 /* and won't be needed again, potentially */
3858 !(PL_op && PL_op->op_type == OP_AASSIGN))
3859 #ifdef PERL_OLD_COPY_ON_WRITE
3860 && ((flags & SV_COW_SHARED_HASH_KEYS)
3861 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3862 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3863 && SvTYPE(sstr) >= SVt_PVIV))
3867 /* Failed the swipe test, and it's not a shared hash key either.
3868 Have to copy the string. */
3869 STRLEN len = SvCUR(sstr);
3870 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3871 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3872 SvCUR_set(dstr, len);
3873 *SvEND(dstr) = '\0';
3875 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3877 /* Either it's a shared hash key, or it's suitable for
3878 copy-on-write or we can swipe the string. */
3880 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3884 #ifdef PERL_OLD_COPY_ON_WRITE
3886 /* I believe I should acquire a global SV mutex if
3887 it's a COW sv (not a shared hash key) to stop
3888 it going un copy-on-write.
3889 If the source SV has gone un copy on write between up there
3890 and down here, then (assert() that) it is of the correct
3891 form to make it copy on write again */
3892 if ((sflags & (SVf_FAKE | SVf_READONLY))
3893 != (SVf_FAKE | SVf_READONLY)) {
3894 SvREADONLY_on(sstr);
3896 /* Make the source SV into a loop of 1.
3897 (about to become 2) */
3898 SV_COW_NEXT_SV_SET(sstr, sstr);
3902 /* Initial code is common. */
3903 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3908 /* making another shared SV. */
3909 STRLEN cur = SvCUR(sstr);
3910 STRLEN len = SvLEN(sstr);
3911 #ifdef PERL_OLD_COPY_ON_WRITE
3913 assert (SvTYPE(dstr) >= SVt_PVIV);
3914 /* SvIsCOW_normal */
3915 /* splice us in between source and next-after-source. */
3916 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3917 SV_COW_NEXT_SV_SET(sstr, dstr);
3918 SvPV_set(dstr, SvPVX_mutable(sstr));
3922 /* SvIsCOW_shared_hash */
3923 DEBUG_C(PerlIO_printf(Perl_debug_log,
3924 "Copy on write: Sharing hash\n"));
3926 assert (SvTYPE(dstr) >= SVt_PV);
3928 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3930 SvLEN_set(dstr, len);
3931 SvCUR_set(dstr, cur);
3932 SvREADONLY_on(dstr);
3934 /* Relesase a global SV mutex. */
3937 { /* Passes the swipe test. */
3938 SvPV_set(dstr, SvPVX_mutable(sstr));
3939 SvLEN_set(dstr, SvLEN(sstr));
3940 SvCUR_set(dstr, SvCUR(sstr));
3943 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3944 SvPV_set(sstr, NULL);
3950 if (sflags & SVp_NOK) {
3951 SvNV_set(dstr, SvNVX(sstr));
3953 if (sflags & SVp_IOK) {
3954 SvIV_set(dstr, SvIVX(sstr));
3955 /* Must do this otherwise some other overloaded use of 0x80000000
3956 gets confused. I guess SVpbm_VALID */
3957 if (sflags & SVf_IVisUV)
3960 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3962 const MAGIC * const smg = SvVSTRING_mg(sstr);
3964 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3965 smg->mg_ptr, smg->mg_len);
3966 SvRMAGICAL_on(dstr);
3970 else if (sflags & (SVp_IOK|SVp_NOK)) {
3971 (void)SvOK_off(dstr);
3972 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3973 if (sflags & SVp_IOK) {
3974 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3975 SvIV_set(dstr, SvIVX(sstr));
3977 if (sflags & SVp_NOK) {
3978 SvNV_set(dstr, SvNVX(sstr));
3982 if (isGV_with_GP(sstr)) {
3983 /* This stringification rule for globs is spread in 3 places.
3984 This feels bad. FIXME. */
3985 const U32 wasfake = sflags & SVf_FAKE;
3987 /* FAKE globs can get coerced, so need to turn this off
3988 temporarily if it is on. */
3990 gv_efullname3(dstr, (GV *)sstr, "*");
3991 SvFLAGS(sstr) |= wasfake;
3994 (void)SvOK_off(dstr);
3996 if (SvTAINTED(sstr))
4001 =for apidoc sv_setsv_mg
4003 Like C<sv_setsv>, but also handles 'set' magic.
4009 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4011 PERL_ARGS_ASSERT_SV_SETSV_MG;
4013 sv_setsv(dstr,sstr);
4017 #ifdef PERL_OLD_COPY_ON_WRITE
4019 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4021 STRLEN cur = SvCUR(sstr);
4022 STRLEN len = SvLEN(sstr);
4023 register char *new_pv;
4025 PERL_ARGS_ASSERT_SV_SETSV_COW;
4028 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4029 (void*)sstr, (void*)dstr);
4036 if (SvTHINKFIRST(dstr))
4037 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4038 else if (SvPVX_const(dstr))
4039 Safefree(SvPVX_const(dstr));
4043 SvUPGRADE(dstr, SVt_PVIV);
4045 assert (SvPOK(sstr));
4046 assert (SvPOKp(sstr));
4047 assert (!SvIOK(sstr));
4048 assert (!SvIOKp(sstr));
4049 assert (!SvNOK(sstr));
4050 assert (!SvNOKp(sstr));
4052 if (SvIsCOW(sstr)) {
4054 if (SvLEN(sstr) == 0) {
4055 /* source is a COW shared hash key. */
4056 DEBUG_C(PerlIO_printf(Perl_debug_log,
4057 "Fast copy on write: Sharing hash\n"));
4058 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4061 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4063 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4064 SvUPGRADE(sstr, SVt_PVIV);
4065 SvREADONLY_on(sstr);
4067 DEBUG_C(PerlIO_printf(Perl_debug_log,
4068 "Fast copy on write: Converting sstr to COW\n"));
4069 SV_COW_NEXT_SV_SET(dstr, sstr);
4071 SV_COW_NEXT_SV_SET(sstr, dstr);
4072 new_pv = SvPVX_mutable(sstr);
4075 SvPV_set(dstr, new_pv);
4076 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4079 SvLEN_set(dstr, len);
4080 SvCUR_set(dstr, cur);
4089 =for apidoc sv_setpvn
4091 Copies a string into an SV. The C<len> parameter indicates the number of
4092 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4093 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4099 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4102 register char *dptr;
4104 PERL_ARGS_ASSERT_SV_SETPVN;
4106 SV_CHECK_THINKFIRST_COW_DROP(sv);
4112 /* len is STRLEN which is unsigned, need to copy to signed */
4115 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4117 SvUPGRADE(sv, SVt_PV);
4119 dptr = SvGROW(sv, len + 1);
4120 Move(ptr,dptr,len,char);
4123 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4128 =for apidoc sv_setpvn_mg
4130 Like C<sv_setpvn>, but also handles 'set' magic.
4136 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4138 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4140 sv_setpvn(sv,ptr,len);
4145 =for apidoc sv_setpv
4147 Copies a string into an SV. The string must be null-terminated. Does not
4148 handle 'set' magic. See C<sv_setpv_mg>.
4154 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4157 register STRLEN len;
4159 PERL_ARGS_ASSERT_SV_SETPV;
4161 SV_CHECK_THINKFIRST_COW_DROP(sv);
4167 SvUPGRADE(sv, SVt_PV);
4169 SvGROW(sv, len + 1);
4170 Move(ptr,SvPVX(sv),len+1,char);
4172 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4177 =for apidoc sv_setpv_mg
4179 Like C<sv_setpv>, but also handles 'set' magic.
4185 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4187 PERL_ARGS_ASSERT_SV_SETPV_MG;
4194 =for apidoc sv_usepvn_flags
4196 Tells an SV to use C<ptr> to find its string value. Normally the
4197 string is stored inside the SV but sv_usepvn allows the SV to use an
4198 outside string. The C<ptr> should point to memory that was allocated
4199 by C<malloc>. The string length, C<len>, must be supplied. By default
4200 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4201 so that pointer should not be freed or used by the programmer after
4202 giving it to sv_usepvn, and neither should any pointers from "behind"
4203 that pointer (e.g. ptr + 1) be used.
4205 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4206 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4207 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4208 C<len>, and already meets the requirements for storing in C<SvPVX>)
4214 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4219 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4221 SV_CHECK_THINKFIRST_COW_DROP(sv);
4222 SvUPGRADE(sv, SVt_PV);
4225 if (flags & SV_SMAGIC)
4229 if (SvPVX_const(sv))
4233 if (flags & SV_HAS_TRAILING_NUL)
4234 assert(ptr[len] == '\0');
4237 allocate = (flags & SV_HAS_TRAILING_NUL)
4239 #ifdef Perl_safesysmalloc_size
4242 PERL_STRLEN_ROUNDUP(len + 1);
4244 if (flags & SV_HAS_TRAILING_NUL) {
4245 /* It's long enough - do nothing.
4246 Specfically Perl_newCONSTSUB is relying on this. */
4249 /* Force a move to shake out bugs in callers. */
4250 char *new_ptr = (char*)safemalloc(allocate);
4251 Copy(ptr, new_ptr, len, char);
4252 PoisonFree(ptr,len,char);
4256 ptr = (char*) saferealloc (ptr, allocate);
4259 #ifdef Perl_safesysmalloc_size
4260 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4262 SvLEN_set(sv, allocate);
4266 if (!(flags & SV_HAS_TRAILING_NUL)) {
4269 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4271 if (flags & SV_SMAGIC)
4275 #ifdef PERL_OLD_COPY_ON_WRITE
4276 /* Need to do this *after* making the SV normal, as we need the buffer
4277 pointer to remain valid until after we've copied it. If we let go too early,
4278 another thread could invalidate it by unsharing last of the same hash key
4279 (which it can do by means other than releasing copy-on-write Svs)
4280 or by changing the other copy-on-write SVs in the loop. */
4282 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4284 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4286 { /* this SV was SvIsCOW_normal(sv) */
4287 /* we need to find the SV pointing to us. */
4288 SV *current = SV_COW_NEXT_SV(after);
4290 if (current == sv) {
4291 /* The SV we point to points back to us (there were only two of us
4293 Hence other SV is no longer copy on write either. */
4295 SvREADONLY_off(after);
4297 /* We need to follow the pointers around the loop. */
4299 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4302 /* don't loop forever if the structure is bust, and we have
4303 a pointer into a closed loop. */
4304 assert (current != after);
4305 assert (SvPVX_const(current) == pvx);
4307 /* Make the SV before us point to the SV after us. */
4308 SV_COW_NEXT_SV_SET(current, after);
4314 =for apidoc sv_force_normal_flags
4316 Undo various types of fakery on an SV: if the PV is a shared string, make
4317 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4318 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4319 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4320 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4321 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4322 set to some other value.) In addition, the C<flags> parameter gets passed to
4323 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4324 with flags set to 0.
4330 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4334 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4336 #ifdef PERL_OLD_COPY_ON_WRITE
4337 if (SvREADONLY(sv)) {
4338 /* At this point I believe I should acquire a global SV mutex. */
4340 const char * const pvx = SvPVX_const(sv);
4341 const STRLEN len = SvLEN(sv);
4342 const STRLEN cur = SvCUR(sv);
4343 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4344 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4345 we'll fail an assertion. */
4346 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4349 PerlIO_printf(Perl_debug_log,
4350 "Copy on write: Force normal %ld\n",
4356 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4359 if (flags & SV_COW_DROP_PV) {
4360 /* OK, so we don't need to copy our buffer. */
4363 SvGROW(sv, cur + 1);
4364 Move(pvx,SvPVX(sv),cur,char);
4369 sv_release_COW(sv, pvx, next);
4371 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4377 else if (IN_PERL_RUNTIME)
4378 Perl_croak(aTHX_ PL_no_modify);
4379 /* At this point I believe that I can drop the global SV mutex. */
4382 if (SvREADONLY(sv)) {
4384 const char * const pvx = SvPVX_const(sv);
4385 const STRLEN len = SvCUR(sv);
4390 SvGROW(sv, len + 1);
4391 Move(pvx,SvPVX(sv),len,char);
4393 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4395 else if (IN_PERL_RUNTIME)
4396 Perl_croak(aTHX_ PL_no_modify);
4400 sv_unref_flags(sv, flags);
4401 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4408 Efficient removal of characters from the beginning of the string buffer.
4409 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4410 the string buffer. The C<ptr> becomes the first character of the adjusted
4411 string. Uses the "OOK hack".
4412 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4413 refer to the same chunk of data.
4419 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4425 const U8 *real_start;
4429 PERL_ARGS_ASSERT_SV_CHOP;
4431 if (!ptr || !SvPOKp(sv))
4433 delta = ptr - SvPVX_const(sv);
4435 /* Nothing to do. */
4438 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4439 nothing uses the value of ptr any more. */
4440 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4441 if (ptr <= SvPVX_const(sv))
4442 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4443 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4444 SV_CHECK_THINKFIRST(sv);
4445 if (delta > max_delta)
4446 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4447 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4448 SvPVX_const(sv) + max_delta);
4451 if (!SvLEN(sv)) { /* make copy of shared string */
4452 const char *pvx = SvPVX_const(sv);
4453 const STRLEN len = SvCUR(sv);
4454 SvGROW(sv, len + 1);
4455 Move(pvx,SvPVX(sv),len,char);
4458 SvFLAGS(sv) |= SVf_OOK;
4461 SvOOK_offset(sv, old_delta);
4463 SvLEN_set(sv, SvLEN(sv) - delta);
4464 SvCUR_set(sv, SvCUR(sv) - delta);
4465 SvPV_set(sv, SvPVX(sv) + delta);
4467 p = (U8 *)SvPVX_const(sv);
4472 real_start = p - delta;
4476 if (delta < 0x100) {
4480 p -= sizeof(STRLEN);
4481 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4485 /* Fill the preceding buffer with sentinals to verify that no-one is
4487 while (p > real_start) {
4495 =for apidoc sv_catpvn
4497 Concatenates the string onto the end of the string which is in the SV. The
4498 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4499 status set, then the bytes appended should be valid UTF-8.
4500 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4502 =for apidoc sv_catpvn_flags
4504 Concatenates the string onto the end of the string which is in the SV. The
4505 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4506 status set, then the bytes appended should be valid UTF-8.
4507 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4508 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4509 in terms of this function.
4515 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4519 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4521 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4523 SvGROW(dsv, dlen + slen + 1);
4525 sstr = SvPVX_const(dsv);
4526 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4527 SvCUR_set(dsv, SvCUR(dsv) + slen);
4529 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4531 if (flags & SV_SMAGIC)
4536 =for apidoc sv_catsv
4538 Concatenates the string from SV C<ssv> onto the end of the string in
4539 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4540 not 'set' magic. See C<sv_catsv_mg>.
4542 =for apidoc sv_catsv_flags
4544 Concatenates the string from SV C<ssv> onto the end of the string in
4545 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4546 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4547 and C<sv_catsv_nomg> are implemented in terms of this function.
4552 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4556 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4560 const char *spv = SvPV_const(ssv, slen);
4562 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4563 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4564 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4565 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4566 dsv->sv_flags doesn't have that bit set.
4567 Andy Dougherty 12 Oct 2001
4569 const I32 sutf8 = DO_UTF8(ssv);
4572 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4574 dutf8 = DO_UTF8(dsv);
4576 if (dutf8 != sutf8) {
4578 /* Not modifying source SV, so taking a temporary copy. */
4579 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4581 sv_utf8_upgrade(csv);
4582 spv = SvPV_const(csv, slen);
4585 sv_utf8_upgrade_nomg(dsv);
4587 sv_catpvn_nomg(dsv, spv, slen);
4590 if (flags & SV_SMAGIC)
4595 =for apidoc sv_catpv
4597 Concatenates the string onto the end of the string which is in the SV.
4598 If the SV has the UTF-8 status set, then the bytes appended should be
4599 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4604 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4607 register STRLEN len;
4611 PERL_ARGS_ASSERT_SV_CATPV;
4615 junk = SvPV_force(sv, tlen);
4617 SvGROW(sv, tlen + len + 1);
4619 ptr = SvPVX_const(sv);
4620 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4621 SvCUR_set(sv, SvCUR(sv) + len);
4622 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4627 =for apidoc sv_catpv_mg
4629 Like C<sv_catpv>, but also handles 'set' magic.
4635 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4637 PERL_ARGS_ASSERT_SV_CATPV_MG;
4646 Creates a new SV. A non-zero C<len> parameter indicates the number of
4647 bytes of preallocated string space the SV should have. An extra byte for a
4648 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4649 space is allocated.) The reference count for the new SV is set to 1.
4651 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4652 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4653 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4654 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4655 modules supporting older perls.
4661 Perl_newSV(pTHX_ const STRLEN len)
4668 sv_upgrade(sv, SVt_PV);
4669 SvGROW(sv, len + 1);
4674 =for apidoc sv_magicext
4676 Adds magic to an SV, upgrading it if necessary. Applies the
4677 supplied vtable and returns a pointer to the magic added.
4679 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4680 In particular, you can add magic to SvREADONLY SVs, and add more than
4681 one instance of the same 'how'.
4683 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4684 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4685 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4686 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4688 (This is now used as a subroutine by C<sv_magic>.)
4693 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4694 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4699 PERL_ARGS_ASSERT_SV_MAGICEXT;
4701 SvUPGRADE(sv, SVt_PVMG);
4702 Newxz(mg, 1, MAGIC);
4703 mg->mg_moremagic = SvMAGIC(sv);
4704 SvMAGIC_set(sv, mg);
4706 /* Sometimes a magic contains a reference loop, where the sv and
4707 object refer to each other. To prevent a reference loop that
4708 would prevent such objects being freed, we look for such loops
4709 and if we find one we avoid incrementing the object refcount.
4711 Note we cannot do this to avoid self-tie loops as intervening RV must
4712 have its REFCNT incremented to keep it in existence.
4715 if (!obj || obj == sv ||
4716 how == PERL_MAGIC_arylen ||
4717 how == PERL_MAGIC_symtab ||
4718 (SvTYPE(obj) == SVt_PVGV &&
4719 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
4720 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
4721 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
4726 mg->mg_obj = SvREFCNT_inc_simple(obj);
4727 mg->mg_flags |= MGf_REFCOUNTED;
4730 /* Normal self-ties simply pass a null object, and instead of
4731 using mg_obj directly, use the SvTIED_obj macro to produce a
4732 new RV as needed. For glob "self-ties", we are tieing the PVIO
4733 with an RV obj pointing to the glob containing the PVIO. In
4734 this case, to avoid a reference loop, we need to weaken the
4738 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4739 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4745 mg->mg_len = namlen;
4748 mg->mg_ptr = savepvn(name, namlen);
4749 else if (namlen == HEf_SVKEY)
4750 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4752 mg->mg_ptr = (char *) name;
4754 mg->mg_virtual = (MGVTBL *) vtable;
4758 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4763 =for apidoc sv_magic
4765 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4766 then adds a new magic item of type C<how> to the head of the magic list.
4768 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4769 handling of the C<name> and C<namlen> arguments.
4771 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4772 to add more than one instance of the same 'how'.
4778 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4779 const char *const name, const I32 namlen)
4782 const MGVTBL *vtable;
4785 PERL_ARGS_ASSERT_SV_MAGIC;
4787 #ifdef PERL_OLD_COPY_ON_WRITE
4789 sv_force_normal_flags(sv, 0);
4791 if (SvREADONLY(sv)) {
4793 /* its okay to attach magic to shared strings; the subsequent
4794 * upgrade to PVMG will unshare the string */
4795 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4798 && how != PERL_MAGIC_regex_global
4799 && how != PERL_MAGIC_bm
4800 && how != PERL_MAGIC_fm
4801 && how != PERL_MAGIC_sv
4802 && how != PERL_MAGIC_backref
4805 Perl_croak(aTHX_ PL_no_modify);
4808 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4809 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4810 /* sv_magic() refuses to add a magic of the same 'how' as an
4813 if (how == PERL_MAGIC_taint) {
4815 /* Any scalar which already had taint magic on which someone
4816 (erroneously?) did SvIOK_on() or similar will now be
4817 incorrectly sporting public "OK" flags. */
4818 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4826 vtable = &PL_vtbl_sv;
4828 case PERL_MAGIC_overload:
4829 vtable = &PL_vtbl_amagic;
4831 case PERL_MAGIC_overload_elem:
4832 vtable = &PL_vtbl_amagicelem;
4834 case PERL_MAGIC_overload_table:
4835 vtable = &PL_vtbl_ovrld;
4838 vtable = &PL_vtbl_bm;
4840 case PERL_MAGIC_regdata:
4841 vtable = &PL_vtbl_regdata;
4843 case PERL_MAGIC_regdatum:
4844 vtable = &PL_vtbl_regdatum;
4846 case PERL_MAGIC_env:
4847 vtable = &PL_vtbl_env;
4850 vtable = &PL_vtbl_fm;
4852 case PERL_MAGIC_envelem:
4853 vtable = &PL_vtbl_envelem;
4855 case PERL_MAGIC_regex_global:
4856 vtable = &PL_vtbl_mglob;
4858 case PERL_MAGIC_isa:
4859 vtable = &PL_vtbl_isa;
4861 case PERL_MAGIC_isaelem:
4862 vtable = &PL_vtbl_isaelem;
4864 case PERL_MAGIC_nkeys:
4865 vtable = &PL_vtbl_nkeys;
4867 case PERL_MAGIC_dbfile:
4870 case PERL_MAGIC_dbline:
4871 vtable = &PL_vtbl_dbline;
4873 #ifdef USE_LOCALE_COLLATE
4874 case PERL_MAGIC_collxfrm:
4875 vtable = &PL_vtbl_collxfrm;
4877 #endif /* USE_LOCALE_COLLATE */
4878 case PERL_MAGIC_tied:
4879 vtable = &PL_vtbl_pack;
4881 case PERL_MAGIC_tiedelem:
4882 case PERL_MAGIC_tiedscalar:
4883 vtable = &PL_vtbl_packelem;
4886 vtable = &PL_vtbl_regexp;
4888 case PERL_MAGIC_hints:
4889 /* As this vtable is all NULL, we can reuse it. */
4890 case PERL_MAGIC_sig:
4891 vtable = &PL_vtbl_sig;
4893 case PERL_MAGIC_sigelem:
4894 vtable = &PL_vtbl_sigelem;
4896 case PERL_MAGIC_taint:
4897 vtable = &PL_vtbl_taint;
4899 case PERL_MAGIC_uvar:
4900 vtable = &PL_vtbl_uvar;
4902 case PERL_MAGIC_vec:
4903 vtable = &PL_vtbl_vec;
4905 case PERL_MAGIC_arylen_p:
4906 case PERL_MAGIC_rhash:
4907 case PERL_MAGIC_symtab:
4908 case PERL_MAGIC_vstring:
4911 case PERL_MAGIC_utf8:
4912 vtable = &PL_vtbl_utf8;
4914 case PERL_MAGIC_substr:
4915 vtable = &PL_vtbl_substr;
4917 case PERL_MAGIC_defelem:
4918 vtable = &PL_vtbl_defelem;
4920 case PERL_MAGIC_arylen:
4921 vtable = &PL_vtbl_arylen;
4923 case PERL_MAGIC_pos:
4924 vtable = &PL_vtbl_pos;
4926 case PERL_MAGIC_backref:
4927 vtable = &PL_vtbl_backref;
4929 case PERL_MAGIC_hintselem:
4930 vtable = &PL_vtbl_hintselem;
4932 case PERL_MAGIC_ext:
4933 /* Reserved for use by extensions not perl internals. */
4934 /* Useful for attaching extension internal data to perl vars. */
4935 /* Note that multiple extensions may clash if magical scalars */
4936 /* etc holding private data from one are passed to another. */
4940 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4943 /* Rest of work is done else where */
4944 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4947 case PERL_MAGIC_taint:
4950 case PERL_MAGIC_ext:
4951 case PERL_MAGIC_dbfile:
4958 =for apidoc sv_unmagic
4960 Removes all magic of type C<type> from an SV.
4966 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4971 PERL_ARGS_ASSERT_SV_UNMAGIC;
4973 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4975 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4976 for (mg = *mgp; mg; mg = *mgp) {
4977 if (mg->mg_type == type) {
4978 const MGVTBL* const vtbl = mg->mg_virtual;
4979 *mgp = mg->mg_moremagic;
4980 if (vtbl && vtbl->svt_free)
4981 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4982 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4984 Safefree(mg->mg_ptr);
4985 else if (mg->mg_len == HEf_SVKEY)
4986 SvREFCNT_dec((SV*)mg->mg_ptr);
4987 else if (mg->mg_type == PERL_MAGIC_utf8)
4988 Safefree(mg->mg_ptr);
4990 if (mg->mg_flags & MGf_REFCOUNTED)
4991 SvREFCNT_dec(mg->mg_obj);
4995 mgp = &mg->mg_moremagic;
4999 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5000 SvMAGIC_set(sv, NULL);
5007 =for apidoc sv_rvweaken
5009 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5010 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5011 push a back-reference to this RV onto the array of backreferences
5012 associated with that magic. If the RV is magical, set magic will be
5013 called after the RV is cleared.
5019 Perl_sv_rvweaken(pTHX_ SV *const sv)
5023 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5025 if (!SvOK(sv)) /* let undefs pass */
5028 Perl_croak(aTHX_ "Can't weaken a nonreference");
5029 else if (SvWEAKREF(sv)) {
5030 if (ckWARN(WARN_MISC))
5031 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5035 Perl_sv_add_backref(aTHX_ tsv, sv);
5041 /* Give tsv backref magic if it hasn't already got it, then push a
5042 * back-reference to sv onto the array associated with the backref magic.
5045 /* A discussion about the backreferences array and its refcount:
5047 * The AV holding the backreferences is pointed to either as the mg_obj of
5048 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5049 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5050 * have the standard magic instead.) The array is created with a refcount
5051 * of 2. This means that if during global destruction the array gets
5052 * picked on first to have its refcount decremented by the random zapper,
5053 * it won't actually be freed, meaning it's still theere for when its
5054 * parent gets freed.
5055 * When the parent SV is freed, in the case of magic, the magic is freed,
5056 * Perl_magic_killbackrefs is called which decrements one refcount, then
5057 * mg_obj is freed which kills the second count.
5058 * In the vase of a HV being freed, one ref is removed by
5059 * Perl_hv_kill_backrefs, the other by Perl_sv_kill_backrefs, which it
5064 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5069 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5071 if (SvTYPE(tsv) == SVt_PVHV) {
5072 AV **const avp = Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5076 /* There is no AV in the offical place - try a fixup. */
5077 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5080 /* Aha. They've got it stowed in magic. Bring it back. */
5081 av = MUTABLE_AV(mg->mg_obj);
5082 /* Stop mg_free decreasing the refernce count. */
5084 /* Stop mg_free even calling the destructor, given that
5085 there's no AV to free up. */
5087 sv_unmagic(tsv, PERL_MAGIC_backref);
5091 SvREFCNT_inc_simple_void(av); /* see discussion above */
5096 const MAGIC *const mg
5097 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5099 av = MUTABLE_AV(mg->mg_obj);
5103 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5104 /* av now has a refcnt of 2; see discussion above */
5107 if (AvFILLp(av) >= AvMAX(av)) {
5108 av_extend(av, AvFILLp(av)+1);
5110 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5113 /* delete a back-reference to ourselves from the backref magic associated
5114 * with the SV we point to.
5118 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5125 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5127 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5128 av = *Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5129 /* We mustn't attempt to "fix up" the hash here by moving the
5130 backreference array back to the hv_aux structure, as that is stored
5131 in the main HvARRAY(), and hfreentries assumes that no-one
5132 reallocates HvARRAY() while it is running. */
5135 const MAGIC *const mg
5136 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5138 av = MUTABLE_AV(mg->mg_obj);
5142 Perl_croak(aTHX_ "panic: del_backref");
5144 assert(!SvIS_FREED(av));
5147 /* We shouldn't be in here more than once, but for paranoia reasons lets
5149 for (i = AvFILLp(av); i >= 0; i--) {
5151 const SSize_t fill = AvFILLp(av);
5153 /* We weren't the last entry.
5154 An unordered list has this property that you can take the
5155 last element off the end to fill the hole, and it's still
5156 an unordered list :-)
5161 AvFILLp(av) = fill - 1;
5167 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5169 SV **svp = AvARRAY(av);
5171 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5172 PERL_UNUSED_ARG(sv);
5174 assert(!svp || !SvIS_FREED(av));
5176 SV *const *const last = svp + AvFILLp(av);
5178 while (svp <= last) {
5180 SV *const referrer = *svp;
5181 if (SvWEAKREF(referrer)) {
5182 /* XXX Should we check that it hasn't changed? */
5183 SvRV_set(referrer, 0);
5185 SvWEAKREF_off(referrer);
5186 SvSETMAGIC(referrer);
5187 } else if (SvTYPE(referrer) == SVt_PVGV ||
5188 SvTYPE(referrer) == SVt_PVLV) {
5189 /* You lookin' at me? */
5190 assert(GvSTASH(referrer));
5191 assert(GvSTASH(referrer) == (const HV *)sv);
5192 GvSTASH(referrer) = 0;
5195 "panic: magic_killbackrefs (flags=%"UVxf")",
5196 (UV)SvFLAGS(referrer));
5204 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5209 =for apidoc sv_insert
5211 Inserts a string at the specified offset/length within the SV. Similar to
5212 the Perl substr() function. Handles get magic.
5214 =for apidoc sv_insert_flags
5216 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5222 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5227 register char *midend;
5228 register char *bigend;
5232 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5235 Perl_croak(aTHX_ "Can't modify non-existent substring");
5236 SvPV_force_flags(bigstr, curlen, flags);
5237 (void)SvPOK_only_UTF8(bigstr);
5238 if (offset + len > curlen) {
5239 SvGROW(bigstr, offset+len+1);
5240 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5241 SvCUR_set(bigstr, offset+len);
5245 i = littlelen - len;
5246 if (i > 0) { /* string might grow */
5247 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5248 mid = big + offset + len;
5249 midend = bigend = big + SvCUR(bigstr);
5252 while (midend > mid) /* shove everything down */
5253 *--bigend = *--midend;
5254 Move(little,big+offset,littlelen,char);
5255 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5260 Move(little,SvPVX(bigstr)+offset,len,char);
5265 big = SvPVX(bigstr);
5268 bigend = big + SvCUR(bigstr);
5270 if (midend > bigend)
5271 Perl_croak(aTHX_ "panic: sv_insert");
5273 if (mid - big > bigend - midend) { /* faster to shorten from end */
5275 Move(little, mid, littlelen,char);
5278 i = bigend - midend;
5280 Move(midend, mid, i,char);
5284 SvCUR_set(bigstr, mid - big);
5286 else if ((i = mid - big)) { /* faster from front */
5287 midend -= littlelen;
5289 Move(big, midend - i, i, char);
5290 sv_chop(bigstr,midend-i);
5292 Move(little, mid, littlelen,char);
5294 else if (littlelen) {
5295 midend -= littlelen;
5296 sv_chop(bigstr,midend);
5297 Move(little,midend,littlelen,char);
5300 sv_chop(bigstr,midend);
5306 =for apidoc sv_replace
5308 Make the first argument a copy of the second, then delete the original.
5309 The target SV physically takes over ownership of the body of the source SV
5310 and inherits its flags; however, the target keeps any magic it owns,
5311 and any magic in the source is discarded.
5312 Note that this is a rather specialist SV copying operation; most of the
5313 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5319 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5322 const U32 refcnt = SvREFCNT(sv);
5324 PERL_ARGS_ASSERT_SV_REPLACE;
5326 SV_CHECK_THINKFIRST_COW_DROP(sv);
5327 if (SvREFCNT(nsv) != 1) {
5328 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5329 UVuf " != 1)", (UV) SvREFCNT(nsv));
5331 if (SvMAGICAL(sv)) {
5335 sv_upgrade(nsv, SVt_PVMG);
5336 SvMAGIC_set(nsv, SvMAGIC(sv));
5337 SvFLAGS(nsv) |= SvMAGICAL(sv);
5339 SvMAGIC_set(sv, NULL);
5343 assert(!SvREFCNT(sv));
5344 #ifdef DEBUG_LEAKING_SCALARS
5345 sv->sv_flags = nsv->sv_flags;
5346 sv->sv_any = nsv->sv_any;
5347 sv->sv_refcnt = nsv->sv_refcnt;
5348 sv->sv_u = nsv->sv_u;
5350 StructCopy(nsv,sv,SV);
5352 if(SvTYPE(sv) == SVt_IV) {
5354 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5358 #ifdef PERL_OLD_COPY_ON_WRITE
5359 if (SvIsCOW_normal(nsv)) {
5360 /* We need to follow the pointers around the loop to make the
5361 previous SV point to sv, rather than nsv. */
5364 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5367 assert(SvPVX_const(current) == SvPVX_const(nsv));
5369 /* Make the SV before us point to the SV after us. */
5371 PerlIO_printf(Perl_debug_log, "previous is\n");
5373 PerlIO_printf(Perl_debug_log,
5374 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5375 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5377 SV_COW_NEXT_SV_SET(current, sv);
5380 SvREFCNT(sv) = refcnt;
5381 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5387 =for apidoc sv_clear
5389 Clear an SV: call any destructors, free up any memory used by the body,
5390 and free the body itself. The SV's head is I<not> freed, although
5391 its type is set to all 1's so that it won't inadvertently be assumed
5392 to be live during global destruction etc.
5393 This function should only be called when REFCNT is zero. Most of the time
5394 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5401 Perl_sv_clear(pTHX_ register SV *const sv)
5404 const U32 type = SvTYPE(sv);
5405 const struct body_details *const sv_type_details
5406 = bodies_by_type + type;
5409 PERL_ARGS_ASSERT_SV_CLEAR;
5410 assert(SvREFCNT(sv) == 0);
5411 assert(SvTYPE(sv) != SVTYPEMASK);
5413 if (type <= SVt_IV) {
5414 /* See the comment in sv.h about the collusion between this early
5415 return and the overloading of the NULL and IV slots in the size
5418 SV * const target = SvRV(sv);
5420 sv_del_backref(target, sv);
5422 SvREFCNT_dec(target);
5424 SvFLAGS(sv) &= SVf_BREAK;
5425 SvFLAGS(sv) |= SVTYPEMASK;
5430 if (PL_defstash && /* Still have a symbol table? */
5437 stash = SvSTASH(sv);
5438 destructor = StashHANDLER(stash,DESTROY);
5440 SV* const tmpref = newRV(sv);
5441 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5443 PUSHSTACKi(PERLSI_DESTROY);
5448 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5454 if(SvREFCNT(tmpref) < 2) {
5455 /* tmpref is not kept alive! */
5457 SvRV_set(tmpref, NULL);
5460 SvREFCNT_dec(tmpref);
5462 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5466 if (PL_in_clean_objs)
5467 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5469 /* DESTROY gave object new lease on life */
5475 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5476 SvOBJECT_off(sv); /* Curse the object. */
5477 if (type != SVt_PVIO)
5478 --PL_sv_objcount; /* XXX Might want something more general */
5481 if (type >= SVt_PVMG) {
5482 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5483 SvREFCNT_dec(SvOURSTASH(sv));
5484 } else if (SvMAGIC(sv))
5486 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5487 SvREFCNT_dec(SvSTASH(sv));
5490 /* case SVt_BIND: */
5493 IoIFP(sv) != PerlIO_stdin() &&
5494 IoIFP(sv) != PerlIO_stdout() &&
5495 IoIFP(sv) != PerlIO_stderr())
5497 io_close((IO*)sv, FALSE);
5499 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5500 PerlDir_close(IoDIRP(sv));
5501 IoDIRP(sv) = (DIR*)NULL;
5502 Safefree(IoTOP_NAME(sv));
5503 Safefree(IoFMT_NAME(sv));
5504 Safefree(IoBOTTOM_NAME(sv));
5507 /* FIXME for plugins */
5508 pregfree2((REGEXP*) sv);
5512 cv_undef(MUTABLE_CV(sv));
5515 if (PL_last_swash_hv == (const HV *)sv) {
5516 PL_last_swash_hv = NULL;
5518 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5519 hv_undef(MUTABLE_HV(sv));
5522 if (PL_comppad == MUTABLE_AV(sv)) {
5526 av_undef(MUTABLE_AV(sv));
5529 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5530 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5531 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5532 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5534 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5535 SvREFCNT_dec(LvTARG(sv));
5537 if (isGV_with_GP(sv)) {
5538 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5539 mro_method_changed_in(stash);
5542 unshare_hek(GvNAME_HEK(sv));
5543 /* If we're in a stash, we don't own a reference to it. However it does
5544 have a back reference to us, which needs to be cleared. */
5545 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5546 sv_del_backref((SV*)stash, sv);
5548 /* FIXME. There are probably more unreferenced pointers to SVs in the
5549 interpreter struct that we should check and tidy in a similar
5551 if ((GV*)sv == PL_last_in_gv)
5552 PL_last_in_gv = NULL;
5558 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5561 SvOOK_offset(sv, offset);
5562 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5563 /* Don't even bother with turning off the OOK flag. */
5566 SV * const target = SvRV(sv);
5568 sv_del_backref(target, sv);
5570 SvREFCNT_dec(target);
5572 #ifdef PERL_OLD_COPY_ON_WRITE
5573 else if (SvPVX_const(sv)) {
5575 /* I believe I need to grab the global SV mutex here and
5576 then recheck the COW status. */
5578 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5582 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5584 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5587 /* And drop it here. */
5589 } else if (SvLEN(sv)) {
5590 Safefree(SvPVX_const(sv));
5594 else if (SvPVX_const(sv) && SvLEN(sv))
5595 Safefree(SvPVX_mutable(sv));
5596 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5597 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5606 SvFLAGS(sv) &= SVf_BREAK;
5607 SvFLAGS(sv) |= SVTYPEMASK;
5609 if (sv_type_details->arena) {
5610 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5611 &PL_body_roots[type]);
5613 else if (sv_type_details->body_size) {
5614 my_safefree(SvANY(sv));
5619 =for apidoc sv_newref
5621 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5628 Perl_sv_newref(pTHX_ SV *const sv)
5630 PERL_UNUSED_CONTEXT;
5639 Decrement an SV's reference count, and if it drops to zero, call
5640 C<sv_clear> to invoke destructors and free up any memory used by
5641 the body; finally, deallocate the SV's head itself.
5642 Normally called via a wrapper macro C<SvREFCNT_dec>.
5648 Perl_sv_free(pTHX_ SV *const sv)
5653 if (SvREFCNT(sv) == 0) {
5654 if (SvFLAGS(sv) & SVf_BREAK)
5655 /* this SV's refcnt has been artificially decremented to
5656 * trigger cleanup */
5658 if (PL_in_clean_all) /* All is fair */
5660 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5661 /* make sure SvREFCNT(sv)==0 happens very seldom */
5662 SvREFCNT(sv) = (~(U32)0)/2;
5665 if (ckWARN_d(WARN_INTERNAL)) {
5666 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5667 Perl_dump_sv_child(aTHX_ sv);
5669 #ifdef DEBUG_LEAKING_SCALARS
5672 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5673 if (PL_warnhook == PERL_WARNHOOK_FATAL
5674 || ckDEAD(packWARN(WARN_INTERNAL))) {
5675 /* Don't let Perl_warner cause us to escape our fate: */
5679 /* This may not return: */
5680 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5681 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5682 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5685 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5690 if (--(SvREFCNT(sv)) > 0)
5692 Perl_sv_free2(aTHX_ sv);
5696 Perl_sv_free2(pTHX_ SV *const sv)
5700 PERL_ARGS_ASSERT_SV_FREE2;
5704 if (ckWARN_d(WARN_DEBUGGING))
5705 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5706 "Attempt to free temp prematurely: SV 0x%"UVxf
5707 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5711 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5712 /* make sure SvREFCNT(sv)==0 happens very seldom */
5713 SvREFCNT(sv) = (~(U32)0)/2;
5724 Returns the length of the string in the SV. Handles magic and type
5725 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5731 Perl_sv_len(pTHX_ register SV *const sv)
5739 len = mg_length(sv);
5741 (void)SvPV_const(sv, len);
5746 =for apidoc sv_len_utf8
5748 Returns the number of characters in the string in an SV, counting wide
5749 UTF-8 bytes as a single character. Handles magic and type coercion.
5755 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5756 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5757 * (Note that the mg_len is not the length of the mg_ptr field.
5758 * This allows the cache to store the character length of the string without
5759 * needing to malloc() extra storage to attach to the mg_ptr.)
5764 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5770 return mg_length(sv);
5774 const U8 *s = (U8*)SvPV_const(sv, len);
5778 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5780 if (mg && mg->mg_len != -1) {
5782 if (PL_utf8cache < 0) {
5783 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5785 /* Need to turn the assertions off otherwise we may
5786 recurse infinitely while printing error messages.
5788 SAVEI8(PL_utf8cache);
5790 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5791 " real %"UVuf" for %"SVf,
5792 (UV) ulen, (UV) real, SVfARG(sv));
5797 ulen = Perl_utf8_length(aTHX_ s, s + len);
5798 if (!SvREADONLY(sv)) {
5800 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5801 &PL_vtbl_utf8, 0, 0);
5809 return Perl_utf8_length(aTHX_ s, s + len);
5813 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5816 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5819 const U8 *s = start;
5821 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5823 while (s < send && uoffset--)
5826 /* This is the existing behaviour. Possibly it should be a croak, as
5827 it's actually a bounds error */
5833 /* Given the length of the string in both bytes and UTF-8 characters, decide
5834 whether to walk forwards or backwards to find the byte corresponding to
5835 the passed in UTF-8 offset. */
5837 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5838 const STRLEN uoffset, const STRLEN uend)
5840 STRLEN backw = uend - uoffset;
5842 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5844 if (uoffset < 2 * backw) {
5845 /* The assumption is that going forwards is twice the speed of going
5846 forward (that's where the 2 * backw comes from).
5847 (The real figure of course depends on the UTF-8 data.) */
5848 return sv_pos_u2b_forwards(start, send, uoffset);
5853 while (UTF8_IS_CONTINUATION(*send))
5856 return send - start;
5859 /* For the string representation of the given scalar, find the byte
5860 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5861 give another position in the string, *before* the sought offset, which
5862 (which is always true, as 0, 0 is a valid pair of positions), which should
5863 help reduce the amount of linear searching.
5864 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5865 will be used to reduce the amount of linear searching. The cache will be
5866 created if necessary, and the found value offered to it for update. */
5868 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5869 const U8 *const send, const STRLEN uoffset,
5870 STRLEN uoffset0, STRLEN boffset0)
5872 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5875 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5877 assert (uoffset >= uoffset0);
5879 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5880 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5881 if ((*mgp)->mg_ptr) {
5882 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5883 if (cache[0] == uoffset) {
5884 /* An exact match. */
5887 if (cache[2] == uoffset) {
5888 /* An exact match. */
5892 if (cache[0] < uoffset) {
5893 /* The cache already knows part of the way. */
5894 if (cache[0] > uoffset0) {
5895 /* The cache knows more than the passed in pair */
5896 uoffset0 = cache[0];
5897 boffset0 = cache[1];
5899 if ((*mgp)->mg_len != -1) {
5900 /* And we know the end too. */
5902 + sv_pos_u2b_midway(start + boffset0, send,
5904 (*mgp)->mg_len - uoffset0);
5907 + sv_pos_u2b_forwards(start + boffset0,
5908 send, uoffset - uoffset0);
5911 else if (cache[2] < uoffset) {
5912 /* We're between the two cache entries. */
5913 if (cache[2] > uoffset0) {
5914 /* and the cache knows more than the passed in pair */
5915 uoffset0 = cache[2];
5916 boffset0 = cache[3];
5920 + sv_pos_u2b_midway(start + boffset0,
5923 cache[0] - uoffset0);
5926 + sv_pos_u2b_midway(start + boffset0,
5929 cache[2] - uoffset0);
5933 else if ((*mgp)->mg_len != -1) {
5934 /* If we can take advantage of a passed in offset, do so. */
5935 /* In fact, offset0 is either 0, or less than offset, so don't
5936 need to worry about the other possibility. */
5938 + sv_pos_u2b_midway(start + boffset0, send,
5940 (*mgp)->mg_len - uoffset0);
5945 if (!found || PL_utf8cache < 0) {
5946 const STRLEN real_boffset
5947 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5948 send, uoffset - uoffset0);
5950 if (found && PL_utf8cache < 0) {
5951 if (real_boffset != boffset) {
5952 /* Need to turn the assertions off otherwise we may recurse
5953 infinitely while printing error messages. */
5954 SAVEI8(PL_utf8cache);
5956 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5957 " real %"UVuf" for %"SVf,
5958 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5961 boffset = real_boffset;
5965 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5971 =for apidoc sv_pos_u2b
5973 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5974 the start of the string, to a count of the equivalent number of bytes; if
5975 lenp is non-zero, it does the same to lenp, but this time starting from
5976 the offset, rather than from the start of the string. Handles magic and
5983 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5984 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5985 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5990 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5995 PERL_ARGS_ASSERT_SV_POS_U2B;
6000 start = (U8*)SvPV_const(sv, len);
6002 STRLEN uoffset = (STRLEN) *offsetp;
6003 const U8 * const send = start + len;
6005 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
6008 *offsetp = (I32) boffset;
6011 /* Convert the relative offset to absolute. */
6012 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
6013 const STRLEN boffset2
6014 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6015 uoffset, boffset) - boffset;
6029 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6030 byte length pairing. The (byte) length of the total SV is passed in too,
6031 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6032 may not have updated SvCUR, so we can't rely on reading it directly.
6034 The proffered utf8/byte length pairing isn't used if the cache already has
6035 two pairs, and swapping either for the proffered pair would increase the
6036 RMS of the intervals between known byte offsets.
6038 The cache itself consists of 4 STRLEN values
6039 0: larger UTF-8 offset
6040 1: corresponding byte offset
6041 2: smaller UTF-8 offset
6042 3: corresponding byte offset
6044 Unused cache pairs have the value 0, 0.
6045 Keeping the cache "backwards" means that the invariant of
6046 cache[0] >= cache[2] is maintained even with empty slots, which means that
6047 the code that uses it doesn't need to worry if only 1 entry has actually
6048 been set to non-zero. It also makes the "position beyond the end of the
6049 cache" logic much simpler, as the first slot is always the one to start
6053 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6054 const STRLEN utf8, const STRLEN blen)
6058 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6064 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6066 (*mgp)->mg_len = -1;
6070 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6071 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6072 (*mgp)->mg_ptr = (char *) cache;
6076 if (PL_utf8cache < 0) {
6077 const U8 *start = (const U8 *) SvPVX_const(sv);
6078 const STRLEN realutf8 = utf8_length(start, start + byte);
6080 if (realutf8 != utf8) {
6081 /* Need to turn the assertions off otherwise we may recurse
6082 infinitely while printing error messages. */
6083 SAVEI8(PL_utf8cache);
6085 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6086 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6090 /* Cache is held with the later position first, to simplify the code
6091 that deals with unbounded ends. */
6093 ASSERT_UTF8_CACHE(cache);
6094 if (cache[1] == 0) {
6095 /* Cache is totally empty */
6098 } else if (cache[3] == 0) {
6099 if (byte > cache[1]) {
6100 /* New one is larger, so goes first. */
6101 cache[2] = cache[0];
6102 cache[3] = cache[1];
6110 #define THREEWAY_SQUARE(a,b,c,d) \
6111 ((float)((d) - (c))) * ((float)((d) - (c))) \
6112 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6113 + ((float)((b) - (a))) * ((float)((b) - (a)))
6115 /* Cache has 2 slots in use, and we know three potential pairs.
6116 Keep the two that give the lowest RMS distance. Do the
6117 calcualation in bytes simply because we always know the byte
6118 length. squareroot has the same ordering as the positive value,
6119 so don't bother with the actual square root. */
6120 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6121 if (byte > cache[1]) {
6122 /* New position is after the existing pair of pairs. */
6123 const float keep_earlier
6124 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6125 const float keep_later
6126 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6128 if (keep_later < keep_earlier) {
6129 if (keep_later < existing) {
6130 cache[2] = cache[0];
6131 cache[3] = cache[1];
6137 if (keep_earlier < existing) {
6143 else if (byte > cache[3]) {
6144 /* New position is between the existing pair of pairs. */
6145 const float keep_earlier
6146 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6147 const float keep_later
6148 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6150 if (keep_later < keep_earlier) {
6151 if (keep_later < existing) {
6157 if (keep_earlier < existing) {
6164 /* New position is before the existing pair of pairs. */
6165 const float keep_earlier
6166 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6167 const float keep_later
6168 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6170 if (keep_later < keep_earlier) {
6171 if (keep_later < existing) {
6177 if (keep_earlier < existing) {
6178 cache[0] = cache[2];
6179 cache[1] = cache[3];
6186 ASSERT_UTF8_CACHE(cache);
6189 /* We already know all of the way, now we may be able to walk back. The same
6190 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6191 backward is half the speed of walking forward. */
6193 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6194 const U8 *end, STRLEN endu)
6196 const STRLEN forw = target - s;
6197 STRLEN backw = end - target;
6199 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6201 if (forw < 2 * backw) {
6202 return utf8_length(s, target);
6205 while (end > target) {
6207 while (UTF8_IS_CONTINUATION(*end)) {
6216 =for apidoc sv_pos_b2u
6218 Converts the value pointed to by offsetp from a count of bytes from the
6219 start of the string, to a count of the equivalent number of UTF-8 chars.
6220 Handles magic and type coercion.
6226 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6227 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6232 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6235 const STRLEN byte = *offsetp;
6236 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6242 PERL_ARGS_ASSERT_SV_POS_B2U;
6247 s = (const U8*)SvPV_const(sv, blen);
6250 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6254 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6255 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6257 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6258 if (cache[1] == byte) {
6259 /* An exact match. */
6260 *offsetp = cache[0];
6263 if (cache[3] == byte) {
6264 /* An exact match. */
6265 *offsetp = cache[2];
6269 if (cache[1] < byte) {
6270 /* We already know part of the way. */
6271 if (mg->mg_len != -1) {
6272 /* Actually, we know the end too. */
6274 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6275 s + blen, mg->mg_len - cache[0]);
6277 len = cache[0] + utf8_length(s + cache[1], send);
6280 else if (cache[3] < byte) {
6281 /* We're between the two cached pairs, so we do the calculation
6282 offset by the byte/utf-8 positions for the earlier pair,
6283 then add the utf-8 characters from the string start to
6285 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6286 s + cache[1], cache[0] - cache[2])
6290 else { /* cache[3] > byte */
6291 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6295 ASSERT_UTF8_CACHE(cache);
6297 } else if (mg->mg_len != -1) {
6298 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6302 if (!found || PL_utf8cache < 0) {
6303 const STRLEN real_len = utf8_length(s, send);
6305 if (found && PL_utf8cache < 0) {
6306 if (len != real_len) {
6307 /* Need to turn the assertions off otherwise we may recurse
6308 infinitely while printing error messages. */
6309 SAVEI8(PL_utf8cache);
6311 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6312 " real %"UVuf" for %"SVf,
6313 (UV) len, (UV) real_len, SVfARG(sv));
6321 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6327 Returns a boolean indicating whether the strings in the two SVs are
6328 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6329 coerce its args to strings if necessary.
6335 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6344 SV* svrecode = NULL;
6351 /* if pv1 and pv2 are the same, second SvPV_const call may
6352 * invalidate pv1, so we may need to make a copy */
6353 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6354 pv1 = SvPV_const(sv1, cur1);
6355 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6357 pv1 = SvPV_const(sv1, cur1);
6365 pv2 = SvPV_const(sv2, cur2);
6367 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6368 /* Differing utf8ness.
6369 * Do not UTF8size the comparands as a side-effect. */
6372 svrecode = newSVpvn(pv2, cur2);
6373 sv_recode_to_utf8(svrecode, PL_encoding);
6374 pv2 = SvPV_const(svrecode, cur2);
6377 svrecode = newSVpvn(pv1, cur1);
6378 sv_recode_to_utf8(svrecode, PL_encoding);
6379 pv1 = SvPV_const(svrecode, cur1);
6381 /* Now both are in UTF-8. */
6383 SvREFCNT_dec(svrecode);
6388 bool is_utf8 = TRUE;
6391 /* sv1 is the UTF-8 one,
6392 * if is equal it must be downgrade-able */
6393 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6399 /* sv2 is the UTF-8 one,
6400 * if is equal it must be downgrade-able */
6401 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6407 /* Downgrade not possible - cannot be eq */
6415 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6417 SvREFCNT_dec(svrecode);
6427 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6428 string in C<sv1> is less than, equal to, or greater than the string in
6429 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6430 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6436 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6440 const char *pv1, *pv2;
6443 SV *svrecode = NULL;
6450 pv1 = SvPV_const(sv1, cur1);
6457 pv2 = SvPV_const(sv2, cur2);
6459 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6460 /* Differing utf8ness.
6461 * Do not UTF8size the comparands as a side-effect. */
6464 svrecode = newSVpvn(pv2, cur2);
6465 sv_recode_to_utf8(svrecode, PL_encoding);
6466 pv2 = SvPV_const(svrecode, cur2);
6469 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6474 svrecode = newSVpvn(pv1, cur1);
6475 sv_recode_to_utf8(svrecode, PL_encoding);
6476 pv1 = SvPV_const(svrecode, cur1);
6479 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6485 cmp = cur2 ? -1 : 0;
6489 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6492 cmp = retval < 0 ? -1 : 1;
6493 } else if (cur1 == cur2) {
6496 cmp = cur1 < cur2 ? -1 : 1;
6500 SvREFCNT_dec(svrecode);
6508 =for apidoc sv_cmp_locale
6510 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6511 'use bytes' aware, handles get magic, and will coerce its args to strings
6512 if necessary. See also C<sv_cmp>.
6518 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6521 #ifdef USE_LOCALE_COLLATE
6527 if (PL_collation_standard)
6531 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6533 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6535 if (!pv1 || !len1) {
6546 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6549 return retval < 0 ? -1 : 1;
6552 * When the result of collation is equality, that doesn't mean
6553 * that there are no differences -- some locales exclude some
6554 * characters from consideration. So to avoid false equalities,
6555 * we use the raw string as a tiebreaker.
6561 #endif /* USE_LOCALE_COLLATE */
6563 return sv_cmp(sv1, sv2);
6567 #ifdef USE_LOCALE_COLLATE
6570 =for apidoc sv_collxfrm
6572 Add Collate Transform magic to an SV if it doesn't already have it.
6574 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6575 scalar data of the variable, but transformed to such a format that a normal
6576 memory comparison can be used to compare the data according to the locale
6583 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6588 PERL_ARGS_ASSERT_SV_COLLXFRM;
6590 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6591 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6597 Safefree(mg->mg_ptr);
6598 s = SvPV_const(sv, len);
6599 if ((xf = mem_collxfrm(s, len, &xlen))) {
6601 #ifdef PERL_OLD_COPY_ON_WRITE
6603 sv_force_normal_flags(sv, 0);
6605 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6619 if (mg && mg->mg_ptr) {
6621 return mg->mg_ptr + sizeof(PL_collation_ix);
6629 #endif /* USE_LOCALE_COLLATE */
6634 Get a line from the filehandle and store it into the SV, optionally
6635 appending to the currently-stored string.
6641 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6646 register STDCHAR rslast;
6647 register STDCHAR *bp;
6652 PERL_ARGS_ASSERT_SV_GETS;
6654 if (SvTHINKFIRST(sv))
6655 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6656 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6658 However, perlbench says it's slower, because the existing swipe code
6659 is faster than copy on write.
6660 Swings and roundabouts. */
6661 SvUPGRADE(sv, SVt_PV);
6666 if (PerlIO_isutf8(fp)) {
6668 sv_utf8_upgrade_nomg(sv);
6669 sv_pos_u2b(sv,&append,0);
6671 } else if (SvUTF8(sv)) {
6672 SV * const tsv = newSV(0);
6673 sv_gets(tsv, fp, 0);
6674 sv_utf8_upgrade_nomg(tsv);
6675 SvCUR_set(sv,append);
6678 goto return_string_or_null;
6683 if (PerlIO_isutf8(fp))
6686 if (IN_PERL_COMPILETIME) {
6687 /* we always read code in line mode */
6691 else if (RsSNARF(PL_rs)) {
6692 /* If it is a regular disk file use size from stat() as estimate
6693 of amount we are going to read -- may result in mallocing
6694 more memory than we really need if the layers below reduce
6695 the size we read (e.g. CRLF or a gzip layer).
6698 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6699 const Off_t offset = PerlIO_tell(fp);
6700 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6701 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6707 else if (RsRECORD(PL_rs)) {
6715 /* Grab the size of the record we're getting */
6716 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6717 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6720 /* VMS wants read instead of fread, because fread doesn't respect */
6721 /* RMS record boundaries. This is not necessarily a good thing to be */
6722 /* doing, but we've got no other real choice - except avoid stdio
6723 as implementation - perhaps write a :vms layer ?
6725 fd = PerlIO_fileno(fp);
6726 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6727 bytesread = PerlIO_read(fp, buffer, recsize);
6730 bytesread = PerlLIO_read(fd, buffer, recsize);
6733 bytesread = PerlIO_read(fp, buffer, recsize);
6737 SvCUR_set(sv, bytesread + append);
6738 buffer[bytesread] = '\0';
6739 goto return_string_or_null;
6741 else if (RsPARA(PL_rs)) {
6747 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6748 if (PerlIO_isutf8(fp)) {
6749 rsptr = SvPVutf8(PL_rs, rslen);
6752 if (SvUTF8(PL_rs)) {
6753 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6754 Perl_croak(aTHX_ "Wide character in $/");
6757 rsptr = SvPV_const(PL_rs, rslen);
6761 rslast = rslen ? rsptr[rslen - 1] : '\0';
6763 if (rspara) { /* have to do this both before and after */
6764 do { /* to make sure file boundaries work right */
6767 i = PerlIO_getc(fp);
6771 PerlIO_ungetc(fp,i);
6777 /* See if we know enough about I/O mechanism to cheat it ! */
6779 /* This used to be #ifdef test - it is made run-time test for ease
6780 of abstracting out stdio interface. One call should be cheap
6781 enough here - and may even be a macro allowing compile
6785 if (PerlIO_fast_gets(fp)) {
6788 * We're going to steal some values from the stdio struct
6789 * and put EVERYTHING in the innermost loop into registers.
6791 register STDCHAR *ptr;
6795 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6796 /* An ungetc()d char is handled separately from the regular
6797 * buffer, so we getc() it back out and stuff it in the buffer.
6799 i = PerlIO_getc(fp);
6800 if (i == EOF) return 0;
6801 *(--((*fp)->_ptr)) = (unsigned char) i;
6805 /* Here is some breathtakingly efficient cheating */
6807 cnt = PerlIO_get_cnt(fp); /* get count into register */
6808 /* make sure we have the room */
6809 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6810 /* Not room for all of it
6811 if we are looking for a separator and room for some
6813 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6814 /* just process what we have room for */
6815 shortbuffered = cnt - SvLEN(sv) + append + 1;
6816 cnt -= shortbuffered;
6820 /* remember that cnt can be negative */
6821 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6826 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6827 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6828 DEBUG_P(PerlIO_printf(Perl_debug_log,
6829 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6830 DEBUG_P(PerlIO_printf(Perl_debug_log,
6831 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6832 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6833 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6838 while (cnt > 0) { /* this | eat */
6840 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6841 goto thats_all_folks; /* screams | sed :-) */
6845 Copy(ptr, bp, cnt, char); /* this | eat */
6846 bp += cnt; /* screams | dust */
6847 ptr += cnt; /* louder | sed :-) */
6852 if (shortbuffered) { /* oh well, must extend */
6853 cnt = shortbuffered;
6855 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6857 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6858 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6862 DEBUG_P(PerlIO_printf(Perl_debug_log,
6863 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6864 PTR2UV(ptr),(long)cnt));
6865 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6867 DEBUG_P(PerlIO_printf(Perl_debug_log,
6868 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6869 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6870 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6872 /* This used to call 'filbuf' in stdio form, but as that behaves like
6873 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6874 another abstraction. */
6875 i = PerlIO_getc(fp); /* get more characters */
6877 DEBUG_P(PerlIO_printf(Perl_debug_log,
6878 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6879 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6880 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6882 cnt = PerlIO_get_cnt(fp);
6883 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6884 DEBUG_P(PerlIO_printf(Perl_debug_log,
6885 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6887 if (i == EOF) /* all done for ever? */
6888 goto thats_really_all_folks;
6890 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6892 SvGROW(sv, bpx + cnt + 2);
6893 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6895 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6897 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6898 goto thats_all_folks;
6902 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6903 memNE((char*)bp - rslen, rsptr, rslen))
6904 goto screamer; /* go back to the fray */
6905 thats_really_all_folks:
6907 cnt += shortbuffered;
6908 DEBUG_P(PerlIO_printf(Perl_debug_log,
6909 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6910 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6911 DEBUG_P(PerlIO_printf(Perl_debug_log,
6912 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6913 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6914 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6916 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6917 DEBUG_P(PerlIO_printf(Perl_debug_log,
6918 "Screamer: done, len=%ld, string=|%.*s|\n",
6919 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6923 /*The big, slow, and stupid way. */
6924 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6925 STDCHAR *buf = NULL;
6926 Newx(buf, 8192, STDCHAR);
6934 register const STDCHAR * const bpe = buf + sizeof(buf);
6936 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6937 ; /* keep reading */
6941 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6942 /* Accomodate broken VAXC compiler, which applies U8 cast to
6943 * both args of ?: operator, causing EOF to change into 255
6946 i = (U8)buf[cnt - 1];
6952 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6954 sv_catpvn(sv, (char *) buf, cnt);
6956 sv_setpvn(sv, (char *) buf, cnt);
6958 if (i != EOF && /* joy */
6960 SvCUR(sv) < rslen ||
6961 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6965 * If we're reading from a TTY and we get a short read,
6966 * indicating that the user hit his EOF character, we need
6967 * to notice it now, because if we try to read from the TTY
6968 * again, the EOF condition will disappear.
6970 * The comparison of cnt to sizeof(buf) is an optimization
6971 * that prevents unnecessary calls to feof().
6975 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6979 #ifdef USE_HEAP_INSTEAD_OF_STACK
6984 if (rspara) { /* have to do this both before and after */
6985 while (i != EOF) { /* to make sure file boundaries work right */
6986 i = PerlIO_getc(fp);
6988 PerlIO_ungetc(fp,i);
6994 return_string_or_null:
6995 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7001 Auto-increment of the value in the SV, doing string to numeric conversion
7002 if necessary. Handles 'get' magic.
7008 Perl_sv_inc(pTHX_ register SV *const sv)
7017 if (SvTHINKFIRST(sv)) {
7019 sv_force_normal_flags(sv, 0);
7020 if (SvREADONLY(sv)) {
7021 if (IN_PERL_RUNTIME)
7022 Perl_croak(aTHX_ PL_no_modify);
7026 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7028 i = PTR2IV(SvRV(sv));
7033 flags = SvFLAGS(sv);
7034 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7035 /* It's (privately or publicly) a float, but not tested as an
7036 integer, so test it to see. */
7038 flags = SvFLAGS(sv);
7040 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7041 /* It's publicly an integer, or privately an integer-not-float */
7042 #ifdef PERL_PRESERVE_IVUV
7046 if (SvUVX(sv) == UV_MAX)
7047 sv_setnv(sv, UV_MAX_P1);
7049 (void)SvIOK_only_UV(sv);
7050 SvUV_set(sv, SvUVX(sv) + 1);
7052 if (SvIVX(sv) == IV_MAX)
7053 sv_setuv(sv, (UV)IV_MAX + 1);
7055 (void)SvIOK_only(sv);
7056 SvIV_set(sv, SvIVX(sv) + 1);
7061 if (flags & SVp_NOK) {
7062 const NV was = SvNVX(sv);
7063 if (NV_OVERFLOWS_INTEGERS_AT &&
7064 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7065 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7066 "Lost precision when incrementing %" NVff " by 1",
7069 (void)SvNOK_only(sv);
7070 SvNV_set(sv, was + 1.0);
7074 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7075 if ((flags & SVTYPEMASK) < SVt_PVIV)
7076 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7077 (void)SvIOK_only(sv);
7082 while (isALPHA(*d)) d++;
7083 while (isDIGIT(*d)) d++;
7085 #ifdef PERL_PRESERVE_IVUV
7086 /* Got to punt this as an integer if needs be, but we don't issue
7087 warnings. Probably ought to make the sv_iv_please() that does
7088 the conversion if possible, and silently. */
7089 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7090 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7091 /* Need to try really hard to see if it's an integer.
7092 9.22337203685478e+18 is an integer.
7093 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7094 so $a="9.22337203685478e+18"; $a+0; $a++
7095 needs to be the same as $a="9.22337203685478e+18"; $a++
7102 /* sv_2iv *should* have made this an NV */
7103 if (flags & SVp_NOK) {
7104 (void)SvNOK_only(sv);
7105 SvNV_set(sv, SvNVX(sv) + 1.0);
7108 /* I don't think we can get here. Maybe I should assert this
7109 And if we do get here I suspect that sv_setnv will croak. NWC
7111 #if defined(USE_LONG_DOUBLE)
7112 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",
7113 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7115 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7116 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7119 #endif /* PERL_PRESERVE_IVUV */
7120 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7124 while (d >= SvPVX_const(sv)) {
7132 /* MKS: The original code here died if letters weren't consecutive.
7133 * at least it didn't have to worry about non-C locales. The
7134 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7135 * arranged in order (although not consecutively) and that only
7136 * [A-Za-z] are accepted by isALPHA in the C locale.
7138 if (*d != 'z' && *d != 'Z') {
7139 do { ++*d; } while (!isALPHA(*d));
7142 *(d--) -= 'z' - 'a';
7147 *(d--) -= 'z' - 'a' + 1;
7151 /* oh,oh, the number grew */
7152 SvGROW(sv, SvCUR(sv) + 2);
7153 SvCUR_set(sv, SvCUR(sv) + 1);
7154 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7165 Auto-decrement of the value in the SV, doing string to numeric conversion
7166 if necessary. Handles 'get' magic.
7172 Perl_sv_dec(pTHX_ register SV *const sv)
7180 if (SvTHINKFIRST(sv)) {
7182 sv_force_normal_flags(sv, 0);
7183 if (SvREADONLY(sv)) {
7184 if (IN_PERL_RUNTIME)
7185 Perl_croak(aTHX_ PL_no_modify);
7189 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7191 i = PTR2IV(SvRV(sv));
7196 /* Unlike sv_inc we don't have to worry about string-never-numbers
7197 and keeping them magic. But we mustn't warn on punting */
7198 flags = SvFLAGS(sv);
7199 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7200 /* It's publicly an integer, or privately an integer-not-float */
7201 #ifdef PERL_PRESERVE_IVUV
7205 if (SvUVX(sv) == 0) {
7206 (void)SvIOK_only(sv);
7210 (void)SvIOK_only_UV(sv);
7211 SvUV_set(sv, SvUVX(sv) - 1);
7214 if (SvIVX(sv) == IV_MIN) {
7215 sv_setnv(sv, (NV)IV_MIN);
7219 (void)SvIOK_only(sv);
7220 SvIV_set(sv, SvIVX(sv) - 1);
7225 if (flags & SVp_NOK) {
7228 const NV was = SvNVX(sv);
7229 if (NV_OVERFLOWS_INTEGERS_AT &&
7230 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7231 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7232 "Lost precision when decrementing %" NVff " by 1",
7235 (void)SvNOK_only(sv);
7236 SvNV_set(sv, was - 1.0);
7240 if (!(flags & SVp_POK)) {
7241 if ((flags & SVTYPEMASK) < SVt_PVIV)
7242 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7244 (void)SvIOK_only(sv);
7247 #ifdef PERL_PRESERVE_IVUV
7249 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7250 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7251 /* Need to try really hard to see if it's an integer.
7252 9.22337203685478e+18 is an integer.
7253 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7254 so $a="9.22337203685478e+18"; $a+0; $a--
7255 needs to be the same as $a="9.22337203685478e+18"; $a--
7262 /* sv_2iv *should* have made this an NV */
7263 if (flags & SVp_NOK) {
7264 (void)SvNOK_only(sv);
7265 SvNV_set(sv, SvNVX(sv) - 1.0);
7268 /* I don't think we can get here. Maybe I should assert this
7269 And if we do get here I suspect that sv_setnv will croak. NWC
7271 #if defined(USE_LONG_DOUBLE)
7272 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",
7273 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7275 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7276 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7280 #endif /* PERL_PRESERVE_IVUV */
7281 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7285 =for apidoc sv_mortalcopy
7287 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7288 The new SV is marked as mortal. It will be destroyed "soon", either by an
7289 explicit call to FREETMPS, or by an implicit call at places such as
7290 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7295 /* Make a string that will exist for the duration of the expression
7296 * evaluation. Actually, it may have to last longer than that, but
7297 * hopefully we won't free it until it has been assigned to a
7298 * permanent location. */
7301 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7307 sv_setsv(sv,oldstr);
7309 PL_tmps_stack[++PL_tmps_ix] = sv;
7315 =for apidoc sv_newmortal
7317 Creates a new null SV which is mortal. The reference count of the SV is
7318 set to 1. It will be destroyed "soon", either by an explicit call to
7319 FREETMPS, or by an implicit call at places such as statement boundaries.
7320 See also C<sv_mortalcopy> and C<sv_2mortal>.
7326 Perl_sv_newmortal(pTHX)
7332 SvFLAGS(sv) = SVs_TEMP;
7334 PL_tmps_stack[++PL_tmps_ix] = sv;
7340 =for apidoc newSVpvn_flags
7342 Creates a new SV and copies a string into it. The reference count for the
7343 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7344 string. You are responsible for ensuring that the source string is at least
7345 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7346 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7347 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7348 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7349 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7351 #define newSVpvn_utf8(s, len, u) \
7352 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7358 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7363 /* All the flags we don't support must be zero.
7364 And we're new code so I'm going to assert this from the start. */
7365 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7367 sv_setpvn(sv,s,len);
7368 SvFLAGS(sv) |= (flags & SVf_UTF8);
7369 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7373 =for apidoc sv_2mortal
7375 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7376 by an explicit call to FREETMPS, or by an implicit call at places such as
7377 statement boundaries. SvTEMP() is turned on which means that the SV's
7378 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7379 and C<sv_mortalcopy>.
7385 Perl_sv_2mortal(pTHX_ register SV *const sv)
7390 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7393 PL_tmps_stack[++PL_tmps_ix] = sv;
7401 Creates a new SV and copies a string into it. The reference count for the
7402 SV is set to 1. If C<len> is zero, Perl will compute the length using
7403 strlen(). For efficiency, consider using C<newSVpvn> instead.
7409 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7415 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7420 =for apidoc newSVpvn
7422 Creates a new SV and copies a string into it. The reference count for the
7423 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7424 string. You are responsible for ensuring that the source string is at least
7425 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7431 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7437 sv_setpvn(sv,s,len);
7442 =for apidoc newSVhek
7444 Creates a new SV from the hash key structure. It will generate scalars that
7445 point to the shared string table where possible. Returns a new (undefined)
7446 SV if the hek is NULL.
7452 Perl_newSVhek(pTHX_ const HEK *const hek)
7462 if (HEK_LEN(hek) == HEf_SVKEY) {
7463 return newSVsv(*(SV**)HEK_KEY(hek));
7465 const int flags = HEK_FLAGS(hek);
7466 if (flags & HVhek_WASUTF8) {
7468 Andreas would like keys he put in as utf8 to come back as utf8
7470 STRLEN utf8_len = HEK_LEN(hek);
7471 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7472 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7475 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7477 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7478 /* We don't have a pointer to the hv, so we have to replicate the
7479 flag into every HEK. This hv is using custom a hasing
7480 algorithm. Hence we can't return a shared string scalar, as
7481 that would contain the (wrong) hash value, and might get passed
7482 into an hv routine with a regular hash.
7483 Similarly, a hash that isn't using shared hash keys has to have
7484 the flag in every key so that we know not to try to call
7485 share_hek_kek on it. */
7487 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7492 /* This will be overwhelminly the most common case. */
7494 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7495 more efficient than sharepvn(). */
7499 sv_upgrade(sv, SVt_PV);
7500 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7501 SvCUR_set(sv, HEK_LEN(hek));
7514 =for apidoc newSVpvn_share
7516 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7517 table. If the string does not already exist in the table, it is created
7518 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7519 value is used; otherwise the hash is computed. The string's hash can be later
7520 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7521 that as the string table is used for shared hash keys these strings will have
7522 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7528 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7532 bool is_utf8 = FALSE;
7533 const char *const orig_src = src;
7536 STRLEN tmplen = -len;
7538 /* See the note in hv.c:hv_fetch() --jhi */
7539 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7543 PERL_HASH(hash, src, len);
7545 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
7546 changes here, update it there too. */
7547 sv_upgrade(sv, SVt_PV);
7548 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7556 if (src != orig_src)
7562 #if defined(PERL_IMPLICIT_CONTEXT)
7564 /* pTHX_ magic can't cope with varargs, so this is a no-context
7565 * version of the main function, (which may itself be aliased to us).
7566 * Don't access this version directly.
7570 Perl_newSVpvf_nocontext(const char *const pat, ...)
7576 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7578 va_start(args, pat);
7579 sv = vnewSVpvf(pat, &args);
7586 =for apidoc newSVpvf
7588 Creates a new SV and initializes it with the string formatted like
7595 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7600 PERL_ARGS_ASSERT_NEWSVPVF;
7602 va_start(args, pat);
7603 sv = vnewSVpvf(pat, &args);
7608 /* backend for newSVpvf() and newSVpvf_nocontext() */
7611 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7616 PERL_ARGS_ASSERT_VNEWSVPVF;
7619 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7626 Creates a new SV and copies a floating point value into it.
7627 The reference count for the SV is set to 1.
7633 Perl_newSVnv(pTHX_ const NV n)
7646 Creates a new SV and copies an integer into it. The reference count for the
7653 Perl_newSViv(pTHX_ const IV i)
7666 Creates a new SV and copies an unsigned integer into it.
7667 The reference count for the SV is set to 1.
7673 Perl_newSVuv(pTHX_ const UV u)
7684 =for apidoc newSV_type
7686 Creates a new SV, of the type specified. The reference count for the new SV
7693 Perl_newSV_type(pTHX_ const svtype type)
7698 sv_upgrade(sv, type);
7703 =for apidoc newRV_noinc
7705 Creates an RV wrapper for an SV. The reference count for the original
7706 SV is B<not> incremented.
7712 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7715 register SV *sv = newSV_type(SVt_IV);
7717 PERL_ARGS_ASSERT_NEWRV_NOINC;
7720 SvRV_set(sv, tmpRef);
7725 /* newRV_inc is the official function name to use now.
7726 * newRV_inc is in fact #defined to newRV in sv.h
7730 Perl_newRV(pTHX_ SV *const sv)
7734 PERL_ARGS_ASSERT_NEWRV;
7736 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7742 Creates a new SV which is an exact duplicate of the original SV.
7749 Perl_newSVsv(pTHX_ register SV *const old)
7756 if (SvTYPE(old) == SVTYPEMASK) {
7757 if (ckWARN_d(WARN_INTERNAL))
7758 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7762 /* SV_GMAGIC is the default for sv_setv()
7763 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7764 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7765 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7770 =for apidoc sv_reset
7772 Underlying implementation for the C<reset> Perl function.
7773 Note that the perl-level function is vaguely deprecated.
7779 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7782 char todo[PERL_UCHAR_MAX+1];
7784 PERL_ARGS_ASSERT_SV_RESET;
7789 if (!*s) { /* reset ?? searches */
7790 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7792 const U32 count = mg->mg_len / sizeof(PMOP**);
7793 PMOP **pmp = (PMOP**) mg->mg_ptr;
7794 PMOP *const *const end = pmp + count;
7798 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7800 (*pmp)->op_pmflags &= ~PMf_USED;
7808 /* reset variables */
7810 if (!HvARRAY(stash))
7813 Zero(todo, 256, char);
7816 I32 i = (unsigned char)*s;
7820 max = (unsigned char)*s++;
7821 for ( ; i <= max; i++) {
7824 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7826 for (entry = HvARRAY(stash)[i];
7828 entry = HeNEXT(entry))
7833 if (!todo[(U8)*HeKEY(entry)])
7835 gv = (GV*)HeVAL(entry);
7838 if (SvTHINKFIRST(sv)) {
7839 if (!SvREADONLY(sv) && SvROK(sv))
7841 /* XXX Is this continue a bug? Why should THINKFIRST
7842 exempt us from resetting arrays and hashes? */
7846 if (SvTYPE(sv) >= SVt_PV) {
7848 if (SvPVX_const(sv) != NULL)
7856 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7858 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7861 # if defined(USE_ENVIRON_ARRAY)
7864 # endif /* USE_ENVIRON_ARRAY */
7875 Using various gambits, try to get an IO from an SV: the IO slot if its a
7876 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7877 named after the PV if we're a string.
7883 Perl_sv_2io(pTHX_ SV *const sv)
7888 PERL_ARGS_ASSERT_SV_2IO;
7890 switch (SvTYPE(sv)) {
7895 if (isGV_with_GP(sv)) {
7899 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7905 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7907 return sv_2io(SvRV(sv));
7908 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7914 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7923 Using various gambits, try to get a CV from an SV; in addition, try if
7924 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7925 The flags in C<lref> are passed to sv_fetchsv.
7931 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7937 PERL_ARGS_ASSERT_SV_2CV;
7944 switch (SvTYPE(sv)) {
7948 return MUTABLE_CV(sv);
7955 if (isGV_with_GP(sv)) {
7965 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7967 tryAMAGICunDEREF(to_cv);
7970 if (SvTYPE(sv) == SVt_PVCV) {
7971 cv = MUTABLE_CV(sv);
7976 else if(isGV_with_GP(sv))
7979 Perl_croak(aTHX_ "Not a subroutine reference");
7981 else if (isGV_with_GP(sv)) {
7986 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7992 /* Some flags to gv_fetchsv mean don't really create the GV */
7993 if (!isGV_with_GP(gv)) {
7999 if (lref && !GvCVu(gv)) {
8003 gv_efullname3(tmpsv, gv, NULL);
8004 /* XXX this is probably not what they think they're getting.
8005 * It has the same effect as "sub name;", i.e. just a forward
8007 newSUB(start_subparse(FALSE, 0),
8008 newSVOP(OP_CONST, 0, tmpsv),
8012 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8013 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8022 Returns true if the SV has a true value by Perl's rules.
8023 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8024 instead use an in-line version.
8030 Perl_sv_true(pTHX_ register SV *const sv)
8035 register const XPV* const tXpv = (XPV*)SvANY(sv);
8037 (tXpv->xpv_cur > 1 ||
8038 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8045 return SvIVX(sv) != 0;
8048 return SvNVX(sv) != 0.0;
8050 return sv_2bool(sv);
8056 =for apidoc sv_pvn_force
8058 Get a sensible string out of the SV somehow.
8059 A private implementation of the C<SvPV_force> macro for compilers which
8060 can't cope with complex macro expressions. Always use the macro instead.
8062 =for apidoc sv_pvn_force_flags
8064 Get a sensible string out of the SV somehow.
8065 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8066 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8067 implemented in terms of this function.
8068 You normally want to use the various wrapper macros instead: see
8069 C<SvPV_force> and C<SvPV_force_nomg>
8075 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8079 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8081 if (SvTHINKFIRST(sv) && !SvROK(sv))
8082 sv_force_normal_flags(sv, 0);
8092 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8093 const char * const ref = sv_reftype(sv,0);
8095 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8096 ref, OP_NAME(PL_op));
8098 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8100 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8101 || isGV_with_GP(sv))
8102 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8104 s = sv_2pv_flags(sv, &len, flags);
8108 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8111 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8112 SvGROW(sv, len + 1);
8113 Move(s,SvPVX(sv),len,char);
8115 SvPVX(sv)[len] = '\0';
8118 SvPOK_on(sv); /* validate pointer */
8120 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8121 PTR2UV(sv),SvPVX_const(sv)));
8124 return SvPVX_mutable(sv);
8128 =for apidoc sv_pvbyten_force
8130 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8136 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8138 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8140 sv_pvn_force(sv,lp);
8141 sv_utf8_downgrade(sv,0);
8147 =for apidoc sv_pvutf8n_force
8149 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8155 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8157 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8159 sv_pvn_force(sv,lp);
8160 sv_utf8_upgrade(sv);
8166 =for apidoc sv_reftype
8168 Returns a string describing what the SV is a reference to.
8174 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8176 PERL_ARGS_ASSERT_SV_REFTYPE;
8178 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8179 inside return suggests a const propagation bug in g++. */
8180 if (ob && SvOBJECT(sv)) {
8181 char * const name = HvNAME_get(SvSTASH(sv));
8182 return name ? name : (char *) "__ANON__";
8185 switch (SvTYPE(sv)) {
8200 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8201 /* tied lvalues should appear to be
8202 * scalars for backwards compatitbility */
8203 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8204 ? "SCALAR" : "LVALUE");
8205 case SVt_PVAV: return "ARRAY";
8206 case SVt_PVHV: return "HASH";
8207 case SVt_PVCV: return "CODE";
8208 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8209 ? "GLOB" : "SCALAR");
8210 case SVt_PVFM: return "FORMAT";
8211 case SVt_PVIO: return "IO";
8212 case SVt_BIND: return "BIND";
8213 case SVt_REGEXP: return "REGEXP";
8214 default: return "UNKNOWN";
8220 =for apidoc sv_isobject
8222 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8223 object. If the SV is not an RV, or if the object is not blessed, then this
8230 Perl_sv_isobject(pTHX_ SV *sv)
8246 Returns a boolean indicating whether the SV is blessed into the specified
8247 class. This does not check for subtypes; use C<sv_derived_from> to verify
8248 an inheritance relationship.
8254 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8258 PERL_ARGS_ASSERT_SV_ISA;
8268 hvname = HvNAME_get(SvSTASH(sv));
8272 return strEQ(hvname, name);
8278 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8279 it will be upgraded to one. If C<classname> is non-null then the new SV will
8280 be blessed in the specified package. The new SV is returned and its
8281 reference count is 1.
8287 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8292 PERL_ARGS_ASSERT_NEWSVRV;
8296 SV_CHECK_THINKFIRST_COW_DROP(rv);
8297 (void)SvAMAGIC_off(rv);
8299 if (SvTYPE(rv) >= SVt_PVMG) {
8300 const U32 refcnt = SvREFCNT(rv);
8304 SvREFCNT(rv) = refcnt;
8306 sv_upgrade(rv, SVt_IV);
8307 } else if (SvROK(rv)) {
8308 SvREFCNT_dec(SvRV(rv));
8310 prepare_SV_for_RV(rv);
8318 HV* const stash = gv_stashpv(classname, GV_ADD);
8319 (void)sv_bless(rv, stash);
8325 =for apidoc sv_setref_pv
8327 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8328 argument will be upgraded to an RV. That RV will be modified to point to
8329 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8330 into the SV. The C<classname> argument indicates the package for the
8331 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8332 will have a reference count of 1, and the RV will be returned.
8334 Do not use with other Perl types such as HV, AV, SV, CV, because those
8335 objects will become corrupted by the pointer copy process.
8337 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8343 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8347 PERL_ARGS_ASSERT_SV_SETREF_PV;
8350 sv_setsv(rv, &PL_sv_undef);
8354 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8359 =for apidoc sv_setref_iv
8361 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8362 argument will be upgraded to an RV. That RV will be modified to point to
8363 the new SV. The C<classname> argument indicates the package for the
8364 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8365 will have a reference count of 1, and the RV will be returned.
8371 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8373 PERL_ARGS_ASSERT_SV_SETREF_IV;
8375 sv_setiv(newSVrv(rv,classname), iv);
8380 =for apidoc sv_setref_uv
8382 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8383 argument will be upgraded to an RV. That RV will be modified to point to
8384 the new SV. The C<classname> argument indicates the package for the
8385 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8386 will have a reference count of 1, and the RV will be returned.
8392 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8394 PERL_ARGS_ASSERT_SV_SETREF_UV;
8396 sv_setuv(newSVrv(rv,classname), uv);
8401 =for apidoc sv_setref_nv
8403 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8404 argument will be upgraded to an RV. That RV will be modified to point to
8405 the new SV. The C<classname> argument indicates the package for the
8406 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8407 will have a reference count of 1, and the RV will be returned.
8413 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8415 PERL_ARGS_ASSERT_SV_SETREF_NV;
8417 sv_setnv(newSVrv(rv,classname), nv);
8422 =for apidoc sv_setref_pvn
8424 Copies a string into a new SV, optionally blessing the SV. The length of the
8425 string must be specified with C<n>. The C<rv> argument will be upgraded to
8426 an RV. That RV will be modified to point to the new SV. The C<classname>
8427 argument indicates the package for the blessing. Set C<classname> to
8428 C<NULL> to avoid the blessing. The new SV will have a reference count
8429 of 1, and the RV will be returned.
8431 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8437 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8438 const char *const pv, const STRLEN n)
8440 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8442 sv_setpvn(newSVrv(rv,classname), pv, n);
8447 =for apidoc sv_bless
8449 Blesses an SV into a specified package. The SV must be an RV. The package
8450 must be designated by its stash (see C<gv_stashpv()>). The reference count
8451 of the SV is unaffected.
8457 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8462 PERL_ARGS_ASSERT_SV_BLESS;
8465 Perl_croak(aTHX_ "Can't bless non-reference value");
8467 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8468 if (SvIsCOW(tmpRef))
8469 sv_force_normal_flags(tmpRef, 0);
8470 if (SvREADONLY(tmpRef))
8471 Perl_croak(aTHX_ PL_no_modify);
8472 if (SvOBJECT(tmpRef)) {
8473 if (SvTYPE(tmpRef) != SVt_PVIO)
8475 SvREFCNT_dec(SvSTASH(tmpRef));
8478 SvOBJECT_on(tmpRef);
8479 if (SvTYPE(tmpRef) != SVt_PVIO)
8481 SvUPGRADE(tmpRef, SVt_PVMG);
8482 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
8487 (void)SvAMAGIC_off(sv);
8489 if(SvSMAGICAL(tmpRef))
8490 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8498 /* Downgrades a PVGV to a PVMG.
8502 S_sv_unglob(pTHX_ SV *const sv)
8507 SV * const temp = sv_newmortal();
8509 PERL_ARGS_ASSERT_SV_UNGLOB;
8511 assert(SvTYPE(sv) == SVt_PVGV);
8513 gv_efullname3(temp, (GV *) sv, "*");
8516 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8517 mro_method_changed_in(stash);
8521 sv_del_backref((SV*)GvSTASH(sv), sv);
8525 if (GvNAME_HEK(sv)) {
8526 unshare_hek(GvNAME_HEK(sv));
8528 isGV_with_GP_off(sv);
8530 /* need to keep SvANY(sv) in the right arena */
8531 xpvmg = new_XPVMG();
8532 StructCopy(SvANY(sv), xpvmg, XPVMG);
8533 del_XPVGV(SvANY(sv));
8536 SvFLAGS(sv) &= ~SVTYPEMASK;
8537 SvFLAGS(sv) |= SVt_PVMG;
8539 /* Intentionally not calling any local SET magic, as this isn't so much a
8540 set operation as merely an internal storage change. */
8541 sv_setsv_flags(sv, temp, 0);
8545 =for apidoc sv_unref_flags
8547 Unsets the RV status of the SV, and decrements the reference count of
8548 whatever was being referenced by the RV. This can almost be thought of
8549 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8550 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8551 (otherwise the decrementing is conditional on the reference count being
8552 different from one or the reference being a readonly SV).
8559 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8561 SV* const target = SvRV(ref);
8563 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8565 if (SvWEAKREF(ref)) {
8566 sv_del_backref(target, ref);
8568 SvRV_set(ref, NULL);
8571 SvRV_set(ref, NULL);
8573 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8574 assigned to as BEGIN {$a = \"Foo"} will fail. */
8575 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8576 SvREFCNT_dec(target);
8577 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8578 sv_2mortal(target); /* Schedule for freeing later */
8582 =for apidoc sv_untaint
8584 Untaint an SV. Use C<SvTAINTED_off> instead.
8589 Perl_sv_untaint(pTHX_ SV *const sv)
8591 PERL_ARGS_ASSERT_SV_UNTAINT;
8593 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8594 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8601 =for apidoc sv_tainted
8603 Test an SV for taintedness. Use C<SvTAINTED> instead.
8608 Perl_sv_tainted(pTHX_ SV *const sv)
8610 PERL_ARGS_ASSERT_SV_TAINTED;
8612 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8613 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8614 if (mg && (mg->mg_len & 1) )
8621 =for apidoc sv_setpviv
8623 Copies an integer into the given SV, also updating its string value.
8624 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8630 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8632 char buf[TYPE_CHARS(UV)];
8634 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8636 PERL_ARGS_ASSERT_SV_SETPVIV;
8638 sv_setpvn(sv, ptr, ebuf - ptr);
8642 =for apidoc sv_setpviv_mg
8644 Like C<sv_setpviv>, but also handles 'set' magic.
8650 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8652 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8658 #if defined(PERL_IMPLICIT_CONTEXT)
8660 /* pTHX_ magic can't cope with varargs, so this is a no-context
8661 * version of the main function, (which may itself be aliased to us).
8662 * Don't access this version directly.
8666 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8671 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8673 va_start(args, pat);
8674 sv_vsetpvf(sv, pat, &args);
8678 /* pTHX_ magic can't cope with varargs, so this is a no-context
8679 * version of the main function, (which may itself be aliased to us).
8680 * Don't access this version directly.
8684 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8689 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8691 va_start(args, pat);
8692 sv_vsetpvf_mg(sv, pat, &args);
8698 =for apidoc sv_setpvf
8700 Works like C<sv_catpvf> but copies the text into the SV instead of
8701 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8707 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8711 PERL_ARGS_ASSERT_SV_SETPVF;
8713 va_start(args, pat);
8714 sv_vsetpvf(sv, pat, &args);
8719 =for apidoc sv_vsetpvf
8721 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8722 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8724 Usually used via its frontend C<sv_setpvf>.
8730 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8732 PERL_ARGS_ASSERT_SV_VSETPVF;
8734 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8738 =for apidoc sv_setpvf_mg
8740 Like C<sv_setpvf>, but also handles 'set' magic.
8746 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8750 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8752 va_start(args, pat);
8753 sv_vsetpvf_mg(sv, pat, &args);
8758 =for apidoc sv_vsetpvf_mg
8760 Like C<sv_vsetpvf>, but also handles 'set' magic.
8762 Usually used via its frontend C<sv_setpvf_mg>.
8768 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8770 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8772 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8776 #if defined(PERL_IMPLICIT_CONTEXT)
8778 /* pTHX_ magic can't cope with varargs, so this is a no-context
8779 * version of the main function, (which may itself be aliased to us).
8780 * Don't access this version directly.
8784 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8789 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8791 va_start(args, pat);
8792 sv_vcatpvf(sv, pat, &args);
8796 /* pTHX_ magic can't cope with varargs, so this is a no-context
8797 * version of the main function, (which may itself be aliased to us).
8798 * Don't access this version directly.
8802 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8807 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8809 va_start(args, pat);
8810 sv_vcatpvf_mg(sv, pat, &args);
8816 =for apidoc sv_catpvf
8818 Processes its arguments like C<sprintf> and appends the formatted
8819 output to an SV. If the appended data contains "wide" characters
8820 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8821 and characters >255 formatted with %c), the original SV might get
8822 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8823 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8824 valid UTF-8; if the original SV was bytes, the pattern should be too.
8829 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8833 PERL_ARGS_ASSERT_SV_CATPVF;
8835 va_start(args, pat);
8836 sv_vcatpvf(sv, pat, &args);
8841 =for apidoc sv_vcatpvf
8843 Processes its arguments like C<vsprintf> and appends the formatted output
8844 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8846 Usually used via its frontend C<sv_catpvf>.
8852 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8854 PERL_ARGS_ASSERT_SV_VCATPVF;
8856 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8860 =for apidoc sv_catpvf_mg
8862 Like C<sv_catpvf>, but also handles 'set' magic.
8868 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8872 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8874 va_start(args, pat);
8875 sv_vcatpvf_mg(sv, pat, &args);
8880 =for apidoc sv_vcatpvf_mg
8882 Like C<sv_vcatpvf>, but also handles 'set' magic.
8884 Usually used via its frontend C<sv_catpvf_mg>.
8890 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8892 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8894 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8899 =for apidoc sv_vsetpvfn
8901 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8904 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8910 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8911 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8913 PERL_ARGS_ASSERT_SV_VSETPVFN;
8916 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8920 S_expect_number(pTHX_ char **const pattern)
8925 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8927 switch (**pattern) {
8928 case '1': case '2': case '3':
8929 case '4': case '5': case '6':
8930 case '7': case '8': case '9':
8931 var = *(*pattern)++ - '0';
8932 while (isDIGIT(**pattern)) {
8933 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8935 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8943 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8945 const int neg = nv < 0;
8948 PERL_ARGS_ASSERT_F0CONVERT;
8956 if (uv & 1 && uv == nv)
8957 uv--; /* Round to even */
8959 const unsigned dig = uv % 10;
8972 =for apidoc sv_vcatpvfn
8974 Processes its arguments like C<vsprintf> and appends the formatted output
8975 to an SV. Uses an array of SVs if the C style variable argument list is
8976 missing (NULL). When running with taint checks enabled, indicates via
8977 C<maybe_tainted> if results are untrustworthy (often due to the use of
8980 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8986 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8987 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8988 vec_utf8 = DO_UTF8(vecsv);
8990 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8993 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8994 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9002 static const char nullstr[] = "(null)";
9004 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9005 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9007 /* Times 4: a decimal digit takes more than 3 binary digits.
9008 * NV_DIG: mantissa takes than many decimal digits.
9009 * Plus 32: Playing safe. */
9010 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9011 /* large enough for "%#.#f" --chip */
9012 /* what about long double NVs? --jhi */
9014 PERL_ARGS_ASSERT_SV_VCATPVFN;
9015 PERL_UNUSED_ARG(maybe_tainted);
9017 /* no matter what, this is a string now */
9018 (void)SvPV_force(sv, origlen);
9020 /* special-case "", "%s", and "%-p" (SVf - see below) */
9023 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9025 const char * const s = va_arg(*args, char*);
9026 sv_catpv(sv, s ? s : nullstr);
9028 else if (svix < svmax) {
9029 sv_catsv(sv, *svargs);
9033 if (args && patlen == 3 && pat[0] == '%' &&
9034 pat[1] == '-' && pat[2] == 'p') {
9035 argsv = (SV*)va_arg(*args, void*);
9036 sv_catsv(sv, argsv);
9040 #ifndef USE_LONG_DOUBLE
9041 /* special-case "%.<number>[gf]" */
9042 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9043 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9044 unsigned digits = 0;
9048 while (*pp >= '0' && *pp <= '9')
9049 digits = 10 * digits + (*pp++ - '0');
9050 if (pp - pat == (int)patlen - 1) {
9058 /* Add check for digits != 0 because it seems that some
9059 gconverts are buggy in this case, and we don't yet have
9060 a Configure test for this. */
9061 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9062 /* 0, point, slack */
9063 Gconvert(nv, (int)digits, 0, ebuf);
9065 if (*ebuf) /* May return an empty string for digits==0 */
9068 } else if (!digits) {
9071 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9072 sv_catpvn(sv, p, l);
9078 #endif /* !USE_LONG_DOUBLE */
9080 if (!args && svix < svmax && DO_UTF8(*svargs))
9083 patend = (char*)pat + patlen;
9084 for (p = (char*)pat; p < patend; p = q) {
9087 bool vectorize = FALSE;
9088 bool vectorarg = FALSE;
9089 bool vec_utf8 = FALSE;
9095 bool has_precis = FALSE;
9097 const I32 osvix = svix;
9098 bool is_utf8 = FALSE; /* is this item utf8? */
9099 #ifdef HAS_LDBL_SPRINTF_BUG
9100 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9101 with sfio - Allen <allens@cpan.org> */
9102 bool fix_ldbl_sprintf_bug = FALSE;
9106 U8 utf8buf[UTF8_MAXBYTES+1];
9107 STRLEN esignlen = 0;
9109 const char *eptr = NULL;
9112 const U8 *vecstr = NULL;
9119 /* we need a long double target in case HAS_LONG_DOUBLE but
9122 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9130 const char *dotstr = ".";
9131 STRLEN dotstrlen = 1;
9132 I32 efix = 0; /* explicit format parameter index */
9133 I32 ewix = 0; /* explicit width index */
9134 I32 epix = 0; /* explicit precision index */
9135 I32 evix = 0; /* explicit vector index */
9136 bool asterisk = FALSE;
9138 /* echo everything up to the next format specification */
9139 for (q = p; q < patend && *q != '%'; ++q) ;
9141 if (has_utf8 && !pat_utf8)
9142 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9144 sv_catpvn(sv, p, q - p);
9151 We allow format specification elements in this order:
9152 \d+\$ explicit format parameter index
9154 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9155 0 flag (as above): repeated to allow "v02"
9156 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9157 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9159 [%bcdefginopsuxDFOUX] format (mandatory)
9164 As of perl5.9.3, printf format checking is on by default.
9165 Internally, perl uses %p formats to provide an escape to
9166 some extended formatting. This block deals with those
9167 extensions: if it does not match, (char*)q is reset and
9168 the normal format processing code is used.
9170 Currently defined extensions are:
9171 %p include pointer address (standard)
9172 %-p (SVf) include an SV (previously %_)
9173 %-<num>p include an SV with precision <num>
9174 %<num>p reserved for future extensions
9176 Robin Barker 2005-07-14
9178 %1p (VDf) removed. RMB 2007-10-19
9185 n = expect_number(&q);
9192 argsv = (SV*)va_arg(*args, void*);
9193 eptr = SvPV_const(argsv, elen);
9199 if (ckWARN_d(WARN_INTERNAL))
9200 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9201 "internal %%<num>p might conflict with future printf extensions");
9207 if ( (width = expect_number(&q)) ) {
9222 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9251 if ( (ewix = expect_number(&q)) )
9260 if ((vectorarg = asterisk)) {
9273 width = expect_number(&q);
9279 vecsv = va_arg(*args, SV*);
9281 vecsv = (evix > 0 && evix <= svmax)
9282 ? svargs[evix-1] : &PL_sv_undef;
9284 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9286 dotstr = SvPV_const(vecsv, dotstrlen);
9287 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9288 bad with tied or overloaded values that return UTF8. */
9291 else if (has_utf8) {
9292 vecsv = sv_mortalcopy(vecsv);
9293 sv_utf8_upgrade(vecsv);
9294 dotstr = SvPV_const(vecsv, dotstrlen);
9301 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9302 vecsv = svargs[efix ? efix-1 : svix++];
9303 vecstr = (U8*)SvPV_const(vecsv,veclen);
9304 vec_utf8 = DO_UTF8(vecsv);
9306 /* if this is a version object, we need to convert
9307 * back into v-string notation and then let the
9308 * vectorize happen normally
9310 if (sv_derived_from(vecsv, "version")) {
9311 char *version = savesvpv(vecsv);
9312 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
9313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9314 "vector argument not supported with alpha versions");
9317 vecsv = sv_newmortal();
9318 scan_vstring(version, version + veclen, vecsv);
9319 vecstr = (U8*)SvPV_const(vecsv, veclen);
9320 vec_utf8 = DO_UTF8(vecsv);
9332 i = va_arg(*args, int);
9334 i = (ewix ? ewix <= svmax : svix < svmax) ?
9335 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9337 width = (i < 0) ? -i : i;
9347 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9349 /* XXX: todo, support specified precision parameter */
9353 i = va_arg(*args, int);
9355 i = (ewix ? ewix <= svmax : svix < svmax)
9356 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9358 has_precis = !(i < 0);
9363 precis = precis * 10 + (*q++ - '0');
9372 case 'I': /* Ix, I32x, and I64x */
9374 if (q[1] == '6' && q[2] == '4') {
9380 if (q[1] == '3' && q[2] == '2') {
9390 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9401 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9402 if (*(q + 1) == 'l') { /* lld, llf */
9428 if (!vectorize && !args) {
9430 const I32 i = efix-1;
9431 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9433 argsv = (svix >= 0 && svix < svmax)
9434 ? svargs[svix++] : &PL_sv_undef;
9445 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9447 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9449 eptr = (char*)utf8buf;
9450 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9464 eptr = va_arg(*args, char*);
9466 #ifdef MACOS_TRADITIONAL
9467 /* On MacOS, %#s format is used for Pascal strings */
9472 elen = strlen(eptr);
9474 eptr = (char *)nullstr;
9475 elen = sizeof nullstr - 1;
9479 eptr = SvPV_const(argsv, elen);
9480 if (DO_UTF8(argsv)) {
9481 I32 old_precis = precis;
9482 if (has_precis && precis < elen) {
9484 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9487 if (width) { /* fudge width (can't fudge elen) */
9488 if (has_precis && precis < elen)
9489 width += precis - old_precis;
9491 width += elen - sv_len_utf8(argsv);
9498 if (has_precis && elen > precis)
9505 if (alt || vectorize)
9507 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9528 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9537 esignbuf[esignlen++] = plus;
9541 case 'h': iv = (short)va_arg(*args, int); break;
9542 case 'l': iv = va_arg(*args, long); break;
9543 case 'V': iv = va_arg(*args, IV); break;
9544 default: iv = va_arg(*args, int); break;
9546 case 'q': iv = va_arg(*args, Quad_t); break;
9551 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9553 case 'h': iv = (short)tiv; break;
9554 case 'l': iv = (long)tiv; break;
9556 default: iv = tiv; break;
9558 case 'q': iv = (Quad_t)tiv; break;
9562 if ( !vectorize ) /* we already set uv above */
9567 esignbuf[esignlen++] = plus;
9571 esignbuf[esignlen++] = '-';
9615 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9626 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9627 case 'l': uv = va_arg(*args, unsigned long); break;
9628 case 'V': uv = va_arg(*args, UV); break;
9629 default: uv = va_arg(*args, unsigned); break;
9631 case 'q': uv = va_arg(*args, Uquad_t); break;
9636 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9638 case 'h': uv = (unsigned short)tuv; break;
9639 case 'l': uv = (unsigned long)tuv; break;
9641 default: uv = tuv; break;
9643 case 'q': uv = (Uquad_t)tuv; break;
9650 char *ptr = ebuf + sizeof ebuf;
9651 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9657 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9663 esignbuf[esignlen++] = '0';
9664 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9672 if (alt && *ptr != '0')
9681 esignbuf[esignlen++] = '0';
9682 esignbuf[esignlen++] = c;
9685 default: /* it had better be ten or less */
9689 } while (uv /= base);
9692 elen = (ebuf + sizeof ebuf) - ptr;
9696 zeros = precis - elen;
9697 else if (precis == 0 && elen == 1 && *eptr == '0'
9698 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9701 /* a precision nullifies the 0 flag. */
9708 /* FLOATING POINT */
9711 c = 'f'; /* maybe %F isn't supported here */
9719 /* This is evil, but floating point is even more evil */
9721 /* for SV-style calling, we can only get NV
9722 for C-style calling, we assume %f is double;
9723 for simplicity we allow any of %Lf, %llf, %qf for long double
9727 #if defined(USE_LONG_DOUBLE)
9731 /* [perl #20339] - we should accept and ignore %lf rather than die */
9735 #if defined(USE_LONG_DOUBLE)
9736 intsize = args ? 0 : 'q';
9740 #if defined(HAS_LONG_DOUBLE)
9749 /* now we need (long double) if intsize == 'q', else (double) */
9751 #if LONG_DOUBLESIZE > DOUBLESIZE
9753 va_arg(*args, long double) :
9754 va_arg(*args, double)
9756 va_arg(*args, double)
9761 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9762 else. frexp() has some unspecified behaviour for those three */
9763 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9765 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9766 will cast our (long double) to (double) */
9767 (void)Perl_frexp(nv, &i);
9768 if (i == PERL_INT_MIN)
9769 Perl_die(aTHX_ "panic: frexp");
9771 need = BIT_DIGITS(i);
9773 need += has_precis ? precis : 6; /* known default */
9778 #ifdef HAS_LDBL_SPRINTF_BUG
9779 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9780 with sfio - Allen <allens@cpan.org> */
9783 # define MY_DBL_MAX DBL_MAX
9784 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9785 # if DOUBLESIZE >= 8
9786 # define MY_DBL_MAX 1.7976931348623157E+308L
9788 # define MY_DBL_MAX 3.40282347E+38L
9792 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9793 # define MY_DBL_MAX_BUG 1L
9795 # define MY_DBL_MAX_BUG MY_DBL_MAX
9799 # define MY_DBL_MIN DBL_MIN
9800 # else /* XXX guessing! -Allen */
9801 # if DOUBLESIZE >= 8
9802 # define MY_DBL_MIN 2.2250738585072014E-308L
9804 # define MY_DBL_MIN 1.17549435E-38L
9808 if ((intsize == 'q') && (c == 'f') &&
9809 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9811 /* it's going to be short enough that
9812 * long double precision is not needed */
9814 if ((nv <= 0L) && (nv >= -0L))
9815 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9817 /* would use Perl_fp_class as a double-check but not
9818 * functional on IRIX - see perl.h comments */
9820 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9821 /* It's within the range that a double can represent */
9822 #if defined(DBL_MAX) && !defined(DBL_MIN)
9823 if ((nv >= ((long double)1/DBL_MAX)) ||
9824 (nv <= (-(long double)1/DBL_MAX)))
9826 fix_ldbl_sprintf_bug = TRUE;
9829 if (fix_ldbl_sprintf_bug == TRUE) {
9839 # undef MY_DBL_MAX_BUG
9842 #endif /* HAS_LDBL_SPRINTF_BUG */
9844 need += 20; /* fudge factor */
9845 if (PL_efloatsize < need) {
9846 Safefree(PL_efloatbuf);
9847 PL_efloatsize = need + 20; /* more fudge */
9848 Newx(PL_efloatbuf, PL_efloatsize, char);
9849 PL_efloatbuf[0] = '\0';
9852 if ( !(width || left || plus || alt) && fill != '0'
9853 && has_precis && intsize != 'q' ) { /* Shortcuts */
9854 /* See earlier comment about buggy Gconvert when digits,
9856 if ( c == 'g' && precis) {
9857 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9858 /* May return an empty string for digits==0 */
9859 if (*PL_efloatbuf) {
9860 elen = strlen(PL_efloatbuf);
9861 goto float_converted;
9863 } else if ( c == 'f' && !precis) {
9864 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9869 char *ptr = ebuf + sizeof ebuf;
9872 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9873 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9874 if (intsize == 'q') {
9875 /* Copy the one or more characters in a long double
9876 * format before the 'base' ([efgEFG]) character to
9877 * the format string. */
9878 static char const prifldbl[] = PERL_PRIfldbl;
9879 char const *p = prifldbl + sizeof(prifldbl) - 3;
9880 while (p >= prifldbl) { *--ptr = *p--; }
9885 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9890 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9902 /* No taint. Otherwise we are in the strange situation
9903 * where printf() taints but print($float) doesn't.
9905 #if defined(HAS_LONG_DOUBLE)
9906 elen = ((intsize == 'q')
9907 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9908 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9910 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9914 eptr = PL_efloatbuf;
9922 i = SvCUR(sv) - origlen;
9925 case 'h': *(va_arg(*args, short*)) = i; break;
9926 default: *(va_arg(*args, int*)) = i; break;
9927 case 'l': *(va_arg(*args, long*)) = i; break;
9928 case 'V': *(va_arg(*args, IV*)) = i; break;
9930 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9935 sv_setuv_mg(argsv, (UV)i);
9936 continue; /* not "break" */
9943 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9944 && ckWARN(WARN_PRINTF))
9946 SV * const msg = sv_newmortal();
9947 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9948 (PL_op->op_type == OP_PRTF) ? "" : "s");
9951 Perl_sv_catpvf(aTHX_ msg,
9952 "\"%%%c\"", c & 0xFF);
9954 Perl_sv_catpvf(aTHX_ msg,
9955 "\"%%\\%03"UVof"\"",
9958 sv_catpvs(msg, "end of string");
9959 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9962 /* output mangled stuff ... */
9968 /* ... right here, because formatting flags should not apply */
9969 SvGROW(sv, SvCUR(sv) + elen + 1);
9971 Copy(eptr, p, elen, char);
9974 SvCUR_set(sv, p - SvPVX_const(sv));
9976 continue; /* not "break" */
9979 if (is_utf8 != has_utf8) {
9982 sv_utf8_upgrade(sv);
9985 const STRLEN old_elen = elen;
9986 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9987 sv_utf8_upgrade(nsv);
9988 eptr = SvPVX_const(nsv);
9991 if (width) { /* fudge width (can't fudge elen) */
9992 width += elen - old_elen;
9998 have = esignlen + zeros + elen;
10000 Perl_croak_nocontext(PL_memory_wrap);
10002 need = (have > width ? have : width);
10005 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10006 Perl_croak_nocontext(PL_memory_wrap);
10007 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10009 if (esignlen && fill == '0') {
10011 for (i = 0; i < (int)esignlen; i++)
10012 *p++ = esignbuf[i];
10014 if (gap && !left) {
10015 memset(p, fill, gap);
10018 if (esignlen && fill != '0') {
10020 for (i = 0; i < (int)esignlen; i++)
10021 *p++ = esignbuf[i];
10025 for (i = zeros; i; i--)
10029 Copy(eptr, p, elen, char);
10033 memset(p, ' ', gap);
10038 Copy(dotstr, p, dotstrlen, char);
10042 vectorize = FALSE; /* done iterating over vecstr */
10049 SvCUR_set(sv, p - SvPVX_const(sv));
10057 /* =========================================================================
10059 =head1 Cloning an interpreter
10061 All the macros and functions in this section are for the private use of
10062 the main function, perl_clone().
10064 The foo_dup() functions make an exact copy of an existing foo thingy.
10065 During the course of a cloning, a hash table is used to map old addresses
10066 to new addresses. The table is created and manipulated with the
10067 ptr_table_* functions.
10071 ============================================================================*/
10074 #if defined(USE_ITHREADS)
10076 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10077 #ifndef GpREFCNT_inc
10078 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10082 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10083 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10084 If this changes, please unmerge ss_dup. */
10085 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10086 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10087 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
10088 #define av_dup_inc(s,t) MUTABLE_AV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10089 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
10090 #define hv_dup_inc(s,t) MUTABLE_HV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10091 #define cv_dup(s,t) MUTABLE_CV(sv_dup((SV*)s,t))
10092 #define cv_dup_inc(s,t) MUTABLE_CV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10093 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10094 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((const SV *)s,t))
10095 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10096 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((const SV *)s,t))
10097 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10098 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10100 /* clone a parser */
10103 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10107 PERL_ARGS_ASSERT_PARSER_DUP;
10112 /* look for it in the table first */
10113 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10117 /* create anew and remember what it is */
10118 Newxz(parser, 1, yy_parser);
10119 ptr_table_store(PL_ptr_table, proto, parser);
10121 parser->yyerrstatus = 0;
10122 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10124 /* XXX these not yet duped */
10125 parser->old_parser = NULL;
10126 parser->stack = NULL;
10128 parser->stack_size = 0;
10129 /* XXX parser->stack->state = 0; */
10131 /* XXX eventually, just Copy() most of the parser struct ? */
10133 parser->lex_brackets = proto->lex_brackets;
10134 parser->lex_casemods = proto->lex_casemods;
10135 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10136 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10137 parser->lex_casestack = savepvn(proto->lex_casestack,
10138 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10139 parser->lex_defer = proto->lex_defer;
10140 parser->lex_dojoin = proto->lex_dojoin;
10141 parser->lex_expect = proto->lex_expect;
10142 parser->lex_formbrack = proto->lex_formbrack;
10143 parser->lex_inpat = proto->lex_inpat;
10144 parser->lex_inwhat = proto->lex_inwhat;
10145 parser->lex_op = proto->lex_op;
10146 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10147 parser->lex_starts = proto->lex_starts;
10148 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10149 parser->multi_close = proto->multi_close;
10150 parser->multi_open = proto->multi_open;
10151 parser->multi_start = proto->multi_start;
10152 parser->multi_end = proto->multi_end;
10153 parser->pending_ident = proto->pending_ident;
10154 parser->preambled = proto->preambled;
10155 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10156 parser->linestr = sv_dup_inc(proto->linestr, param);
10157 parser->expect = proto->expect;
10158 parser->copline = proto->copline;
10159 parser->last_lop_op = proto->last_lop_op;
10160 parser->lex_state = proto->lex_state;
10161 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10162 /* rsfp_filters entries have fake IoDIRP() */
10163 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10164 parser->in_my = proto->in_my;
10165 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10166 parser->error_count = proto->error_count;
10169 parser->linestr = sv_dup_inc(proto->linestr, param);
10172 char * const ols = SvPVX(proto->linestr);
10173 char * const ls = SvPVX(parser->linestr);
10175 parser->bufptr = ls + (proto->bufptr >= ols ?
10176 proto->bufptr - ols : 0);
10177 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10178 proto->oldbufptr - ols : 0);
10179 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10180 proto->oldoldbufptr - ols : 0);
10181 parser->linestart = ls + (proto->linestart >= ols ?
10182 proto->linestart - ols : 0);
10183 parser->last_uni = ls + (proto->last_uni >= ols ?
10184 proto->last_uni - ols : 0);
10185 parser->last_lop = ls + (proto->last_lop >= ols ?
10186 proto->last_lop - ols : 0);
10188 parser->bufend = ls + SvCUR(parser->linestr);
10191 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10195 parser->endwhite = proto->endwhite;
10196 parser->faketokens = proto->faketokens;
10197 parser->lasttoke = proto->lasttoke;
10198 parser->nextwhite = proto->nextwhite;
10199 parser->realtokenstart = proto->realtokenstart;
10200 parser->skipwhite = proto->skipwhite;
10201 parser->thisclose = proto->thisclose;
10202 parser->thismad = proto->thismad;
10203 parser->thisopen = proto->thisopen;
10204 parser->thisstuff = proto->thisstuff;
10205 parser->thistoken = proto->thistoken;
10206 parser->thiswhite = proto->thiswhite;
10208 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10209 parser->curforce = proto->curforce;
10211 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10212 Copy(proto->nexttype, parser->nexttype, 5, I32);
10213 parser->nexttoke = proto->nexttoke;
10219 /* duplicate a file handle */
10222 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10226 PERL_ARGS_ASSERT_FP_DUP;
10227 PERL_UNUSED_ARG(type);
10230 return (PerlIO*)NULL;
10232 /* look for it in the table first */
10233 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10237 /* create anew and remember what it is */
10238 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10239 ptr_table_store(PL_ptr_table, fp, ret);
10243 /* duplicate a directory handle */
10246 Perl_dirp_dup(pTHX_ DIR *const dp)
10248 PERL_UNUSED_CONTEXT;
10255 /* duplicate a typeglob */
10258 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10262 PERL_ARGS_ASSERT_GP_DUP;
10266 /* look for it in the table first */
10267 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10271 /* create anew and remember what it is */
10273 ptr_table_store(PL_ptr_table, gp, ret);
10276 ret->gp_refcnt = 0; /* must be before any other dups! */
10277 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10278 ret->gp_io = io_dup_inc(gp->gp_io, param);
10279 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10280 ret->gp_av = av_dup_inc(gp->gp_av, param);
10281 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10282 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10283 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10284 ret->gp_cvgen = gp->gp_cvgen;
10285 ret->gp_line = gp->gp_line;
10286 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10290 /* duplicate a chain of magic */
10293 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10295 MAGIC *mgprev = (MAGIC*)NULL;
10298 PERL_ARGS_ASSERT_MG_DUP;
10301 return (MAGIC*)NULL;
10302 /* look for it in the table first */
10303 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10307 for (; mg; mg = mg->mg_moremagic) {
10309 Newxz(nmg, 1, MAGIC);
10311 mgprev->mg_moremagic = nmg;
10314 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10315 nmg->mg_private = mg->mg_private;
10316 nmg->mg_type = mg->mg_type;
10317 nmg->mg_flags = mg->mg_flags;
10318 /* FIXME for plugins
10319 if (mg->mg_type == PERL_MAGIC_qr) {
10320 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10324 if(mg->mg_type == PERL_MAGIC_backref) {
10325 /* The backref AV has its reference count deliberately bumped by
10328 = SvREFCNT_inc(av_dup_inc((const AV *) mg->mg_obj, param));
10331 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10332 ? sv_dup_inc(mg->mg_obj, param)
10333 : sv_dup(mg->mg_obj, param);
10335 nmg->mg_len = mg->mg_len;
10336 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10337 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10338 if (mg->mg_len > 0) {
10339 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10340 if (mg->mg_type == PERL_MAGIC_overload_table &&
10341 AMT_AMAGIC((AMT*)mg->mg_ptr))
10343 const AMT * const amtp = (AMT*)mg->mg_ptr;
10344 AMT * const namtp = (AMT*)nmg->mg_ptr;
10346 for (i = 1; i < NofAMmeth; i++) {
10347 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10351 else if (mg->mg_len == HEf_SVKEY)
10352 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10354 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10355 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10362 #endif /* USE_ITHREADS */
10364 /* create a new pointer-mapping table */
10367 Perl_ptr_table_new(pTHX)
10370 PERL_UNUSED_CONTEXT;
10372 Newxz(tbl, 1, PTR_TBL_t);
10373 tbl->tbl_max = 511;
10374 tbl->tbl_items = 0;
10375 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10379 #define PTR_TABLE_HASH(ptr) \
10380 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10383 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10384 following define) and at call to new_body_inline made below in
10385 Perl_ptr_table_store()
10388 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10390 /* map an existing pointer using a table */
10392 STATIC PTR_TBL_ENT_t *
10393 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10395 PTR_TBL_ENT_t *tblent;
10396 const UV hash = PTR_TABLE_HASH(sv);
10398 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10400 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10401 for (; tblent; tblent = tblent->next) {
10402 if (tblent->oldval == sv)
10409 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10411 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10413 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10414 PERL_UNUSED_CONTEXT;
10416 return tblent ? tblent->newval : NULL;
10419 /* add a new entry to a pointer-mapping table */
10422 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10424 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10426 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10427 PERL_UNUSED_CONTEXT;
10430 tblent->newval = newsv;
10432 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10434 new_body_inline(tblent, PTE_SVSLOT);
10436 tblent->oldval = oldsv;
10437 tblent->newval = newsv;
10438 tblent->next = tbl->tbl_ary[entry];
10439 tbl->tbl_ary[entry] = tblent;
10441 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10442 ptr_table_split(tbl);
10446 /* double the hash bucket size of an existing ptr table */
10449 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10451 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10452 const UV oldsize = tbl->tbl_max + 1;
10453 UV newsize = oldsize * 2;
10456 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10457 PERL_UNUSED_CONTEXT;
10459 Renew(ary, newsize, PTR_TBL_ENT_t*);
10460 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10461 tbl->tbl_max = --newsize;
10462 tbl->tbl_ary = ary;
10463 for (i=0; i < oldsize; i++, ary++) {
10464 PTR_TBL_ENT_t **curentp, **entp, *ent;
10467 curentp = ary + oldsize;
10468 for (entp = ary, ent = *ary; ent; ent = *entp) {
10469 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10471 ent->next = *curentp;
10481 /* remove all the entries from a ptr table */
10484 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10486 if (tbl && tbl->tbl_items) {
10487 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10488 UV riter = tbl->tbl_max;
10491 PTR_TBL_ENT_t *entry = array[riter];
10494 PTR_TBL_ENT_t * const oentry = entry;
10495 entry = entry->next;
10500 tbl->tbl_items = 0;
10504 /* clear and free a ptr table */
10507 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10512 ptr_table_clear(tbl);
10513 Safefree(tbl->tbl_ary);
10517 #if defined(USE_ITHREADS)
10520 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10522 PERL_ARGS_ASSERT_RVPV_DUP;
10525 SvRV_set(dstr, SvWEAKREF(sstr)
10526 ? sv_dup(SvRV(sstr), param)
10527 : sv_dup_inc(SvRV(sstr), param));
10530 else if (SvPVX_const(sstr)) {
10531 /* Has something there */
10533 /* Normal PV - clone whole allocated space */
10534 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10535 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10536 /* Not that normal - actually sstr is copy on write.
10537 But we are a true, independant SV, so: */
10538 SvREADONLY_off(dstr);
10543 /* Special case - not normally malloced for some reason */
10544 if (isGV_with_GP(sstr)) {
10545 /* Don't need to do anything here. */
10547 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10548 /* A "shared" PV - clone it as "shared" PV */
10550 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10554 /* Some other special case - random pointer */
10555 SvPV_set(dstr, SvPVX(sstr));
10560 /* Copy the NULL */
10561 SvPV_set(dstr, NULL);
10565 /* duplicate an SV of any type (including AV, HV etc) */
10568 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10573 PERL_ARGS_ASSERT_SV_DUP;
10577 if (SvTYPE(sstr) == SVTYPEMASK) {
10578 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10583 /* look for it in the table first */
10584 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10588 if(param->flags & CLONEf_JOIN_IN) {
10589 /** We are joining here so we don't want do clone
10590 something that is bad **/
10591 if (SvTYPE(sstr) == SVt_PVHV) {
10592 const HEK * const hvname = HvNAME_HEK(sstr);
10594 /** don't clone stashes if they already exist **/
10595 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10599 /* create anew and remember what it is */
10602 #ifdef DEBUG_LEAKING_SCALARS
10603 dstr->sv_debug_optype = sstr->sv_debug_optype;
10604 dstr->sv_debug_line = sstr->sv_debug_line;
10605 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10606 dstr->sv_debug_cloned = 1;
10607 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10610 ptr_table_store(PL_ptr_table, sstr, dstr);
10613 SvFLAGS(dstr) = SvFLAGS(sstr);
10614 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10615 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10618 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10619 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10620 (void*)PL_watch_pvx, SvPVX_const(sstr));
10623 /* don't clone objects whose class has asked us not to */
10624 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10629 switch (SvTYPE(sstr)) {
10631 SvANY(dstr) = NULL;
10634 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10636 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10638 SvIV_set(dstr, SvIVX(sstr));
10642 SvANY(dstr) = new_XNV();
10643 SvNV_set(dstr, SvNVX(sstr));
10645 /* case SVt_BIND: */
10648 /* These are all the types that need complex bodies allocating. */
10650 const svtype sv_type = SvTYPE(sstr);
10651 const struct body_details *const sv_type_details
10652 = bodies_by_type + sv_type;
10656 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10660 if (GvUNIQUE((GV*)sstr)) {
10661 NOOP; /* Do sharing here, and fall through */
10674 assert(sv_type_details->body_size);
10675 if (sv_type_details->arena) {
10676 new_body_inline(new_body, sv_type);
10678 = (void*)((char*)new_body - sv_type_details->offset);
10680 new_body = new_NOARENA(sv_type_details);
10684 SvANY(dstr) = new_body;
10687 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10688 ((char*)SvANY(dstr)) + sv_type_details->offset,
10689 sv_type_details->copy, char);
10691 Copy(((char*)SvANY(sstr)),
10692 ((char*)SvANY(dstr)),
10693 sv_type_details->body_size + sv_type_details->offset, char);
10696 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10697 && !isGV_with_GP(dstr))
10698 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10700 /* The Copy above means that all the source (unduplicated) pointers
10701 are now in the destination. We can check the flags and the
10702 pointers in either, but it's possible that there's less cache
10703 missing by always going for the destination.
10704 FIXME - instrument and check that assumption */
10705 if (sv_type >= SVt_PVMG) {
10706 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10707 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10708 } else if (SvMAGIC(dstr))
10709 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10711 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10714 /* The cast silences a GCC warning about unhandled types. */
10715 switch ((int)sv_type) {
10725 /* FIXME for plugins */
10726 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10729 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10730 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10731 LvTARG(dstr) = dstr;
10732 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10733 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10735 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10737 if(isGV_with_GP(sstr)) {
10738 if (GvNAME_HEK(dstr))
10739 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10740 /* Don't call sv_add_backref here as it's going to be
10741 created as part of the magic cloning of the symbol
10743 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10744 at the point of this comment. */
10745 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10746 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10747 (void)GpREFCNT_inc(GvGP(dstr));
10749 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10752 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10753 if (IoOFP(dstr) == IoIFP(sstr))
10754 IoOFP(dstr) = IoIFP(dstr);
10756 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10757 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10758 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10759 /* I have no idea why fake dirp (rsfps)
10760 should be treated differently but otherwise
10761 we end up with leaks -- sky*/
10762 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10763 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10764 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10766 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10767 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10768 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10769 if (IoDIRP(dstr)) {
10770 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10773 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10776 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10777 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10778 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10781 if (AvARRAY((const AV *)sstr)) {
10782 SV **dst_ary, **src_ary;
10783 SSize_t items = AvFILLp((const AV *)sstr) + 1;
10785 src_ary = AvARRAY((const AV *)sstr);
10786 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
10787 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10788 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
10789 AvALLOC((const AV *)dstr) = dst_ary;
10790 if (AvREAL((const AV *)sstr)) {
10791 while (items-- > 0)
10792 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10795 while (items-- > 0)
10796 *dst_ary++ = sv_dup(*src_ary++, param);
10798 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
10799 while (items-- > 0) {
10800 *dst_ary++ = &PL_sv_undef;
10804 AvARRAY(MUTABLE_AV(dstr)) = NULL;
10805 AvALLOC((const AV *)dstr) = (SV**)NULL;
10809 if (HvARRAY((const HV *)sstr)) {
10811 const bool sharekeys = !!HvSHAREKEYS(sstr);
10812 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10813 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10815 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10816 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10818 HvARRAY(dstr) = (HE**)darray;
10819 while (i <= sxhv->xhv_max) {
10820 const HE * const source = HvARRAY(sstr)[i];
10821 HvARRAY(dstr)[i] = source
10822 ? he_dup(source, sharekeys, param) : 0;
10827 const struct xpvhv_aux * const saux = HvAUX(sstr);
10828 struct xpvhv_aux * const daux = HvAUX(dstr);
10829 /* This flag isn't copied. */
10830 /* SvOOK_on(hv) attacks the IV flags. */
10831 SvFLAGS(dstr) |= SVf_OOK;
10833 hvname = saux->xhv_name;
10834 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10836 daux->xhv_riter = saux->xhv_riter;
10837 daux->xhv_eiter = saux->xhv_eiter
10838 ? he_dup(saux->xhv_eiter,
10839 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10840 /* backref array needs refcnt=2; see sv_add_backref */
10841 daux->xhv_backreferences =
10842 saux->xhv_backreferences
10843 ? MUTABLE_AV(SvREFCNT_inc(
10844 sv_dup_inc((SV*)saux->xhv_backreferences, param)))
10847 daux->xhv_mro_meta = saux->xhv_mro_meta
10848 ? mro_meta_dup(saux->xhv_mro_meta, param)
10851 /* Record stashes for possible cloning in Perl_clone(). */
10853 av_push(param->stashes, dstr);
10857 HvARRAY(MUTABLE_HV(dstr)) = NULL;
10860 if (!(param->flags & CLONEf_COPY_STACKS)) {
10864 /* NOTE: not refcounted */
10865 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10867 if (!CvISXSUB(dstr))
10868 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10870 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10871 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10872 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10873 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10875 /* don't dup if copying back - CvGV isn't refcounted, so the
10876 * duped GV may never be freed. A bit of a hack! DAPM */
10877 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10878 NULL : gv_dup(CvGV(dstr), param) ;
10879 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10881 CvWEAKOUTSIDE(sstr)
10882 ? cv_dup( CvOUTSIDE(dstr), param)
10883 : cv_dup_inc(CvOUTSIDE(dstr), param);
10884 if (!CvISXSUB(dstr))
10885 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10891 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10897 /* duplicate a context */
10900 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10902 PERL_CONTEXT *ncxs;
10904 PERL_ARGS_ASSERT_CX_DUP;
10907 return (PERL_CONTEXT*)NULL;
10909 /* look for it in the table first */
10910 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10914 /* create anew and remember what it is */
10915 Newx(ncxs, max + 1, PERL_CONTEXT);
10916 ptr_table_store(PL_ptr_table, cxs, ncxs);
10917 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10920 PERL_CONTEXT * const ncx = &ncxs[ix];
10921 if (CxTYPE(ncx) == CXt_SUBST) {
10922 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10925 switch (CxTYPE(ncx)) {
10927 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10928 ? cv_dup_inc(ncx->blk_sub.cv, param)
10929 : cv_dup(ncx->blk_sub.cv,param));
10930 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10931 ? av_dup_inc(ncx->blk_sub.argarray,
10934 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10936 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10937 ncx->blk_sub.oldcomppad);
10940 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10942 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10944 case CXt_LOOP_LAZYSV:
10945 ncx->blk_loop.state_u.lazysv.end
10946 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10947 /* We are taking advantage of av_dup_inc and sv_dup_inc
10948 actually being the same function, and order equivalance of
10950 We can assert the later [but only at run time :-(] */
10951 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10952 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10954 ncx->blk_loop.state_u.ary.ary
10955 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10956 case CXt_LOOP_LAZYIV:
10957 case CXt_LOOP_PLAIN:
10958 if (CxPADLOOP(ncx)) {
10959 ncx->blk_loop.oldcomppad
10960 = (PAD*)ptr_table_fetch(PL_ptr_table,
10961 ncx->blk_loop.oldcomppad);
10963 ncx->blk_loop.oldcomppad
10964 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10968 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10969 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10970 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10983 /* duplicate a stack info structure */
10986 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10990 PERL_ARGS_ASSERT_SI_DUP;
10993 return (PERL_SI*)NULL;
10995 /* look for it in the table first */
10996 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11000 /* create anew and remember what it is */
11001 Newxz(nsi, 1, PERL_SI);
11002 ptr_table_store(PL_ptr_table, si, nsi);
11004 nsi->si_stack = av_dup_inc(si->si_stack, param);
11005 nsi->si_cxix = si->si_cxix;
11006 nsi->si_cxmax = si->si_cxmax;
11007 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11008 nsi->si_type = si->si_type;
11009 nsi->si_prev = si_dup(si->si_prev, param);
11010 nsi->si_next = si_dup(si->si_next, param);
11011 nsi->si_markoff = si->si_markoff;
11016 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11017 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11018 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11019 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11020 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11021 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11022 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11023 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11024 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11025 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11026 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11027 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11028 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11029 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11032 #define pv_dup_inc(p) SAVEPV(p)
11033 #define pv_dup(p) SAVEPV(p)
11034 #define svp_dup_inc(p,pp) any_dup(p,pp)
11036 /* map any object to the new equivent - either something in the
11037 * ptr table, or something in the interpreter structure
11041 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
11045 PERL_ARGS_ASSERT_ANY_DUP;
11048 return (void*)NULL;
11050 /* look for it in the table first */
11051 ret = ptr_table_fetch(PL_ptr_table, v);
11055 /* see if it is part of the interpreter structure */
11056 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11057 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11065 /* duplicate the save stack */
11068 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11071 ANY * const ss = proto_perl->Isavestack;
11072 const I32 max = proto_perl->Isavestack_max;
11073 I32 ix = proto_perl->Isavestack_ix;
11086 void (*dptr) (void*);
11087 void (*dxptr) (pTHX_ void*);
11089 PERL_ARGS_ASSERT_SS_DUP;
11091 Newxz(nss, max, ANY);
11094 const I32 type = POPINT(ss,ix);
11095 TOPINT(nss,ix) = type;
11097 case SAVEt_HELEM: /* hash element */
11098 sv = (SV*)POPPTR(ss,ix);
11099 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11101 case SAVEt_ITEM: /* normal string */
11102 case SAVEt_SV: /* scalar reference */
11103 sv = (SV*)POPPTR(ss,ix);
11104 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11107 case SAVEt_MORTALIZESV:
11108 sv = (SV*)POPPTR(ss,ix);
11109 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11111 case SAVEt_SHARED_PVREF: /* char* in shared space */
11112 c = (char*)POPPTR(ss,ix);
11113 TOPPTR(nss,ix) = savesharedpv(c);
11114 ptr = POPPTR(ss,ix);
11115 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11117 case SAVEt_GENERIC_SVREF: /* generic sv */
11118 case SAVEt_SVREF: /* scalar reference */
11119 sv = (SV*)POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11121 ptr = POPPTR(ss,ix);
11122 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11124 case SAVEt_HV: /* hash reference */
11125 case SAVEt_AV: /* array reference */
11126 sv = (SV*) POPPTR(ss,ix);
11127 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11129 case SAVEt_COMPPAD:
11131 sv = (SV*) POPPTR(ss,ix);
11132 TOPPTR(nss,ix) = sv_dup(sv, param);
11134 case SAVEt_INT: /* int reference */
11135 ptr = POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11137 intval = (int)POPINT(ss,ix);
11138 TOPINT(nss,ix) = intval;
11140 case SAVEt_LONG: /* long reference */
11141 ptr = POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11144 case SAVEt_CLEARSV:
11145 longval = (long)POPLONG(ss,ix);
11146 TOPLONG(nss,ix) = longval;
11148 case SAVEt_I32: /* I32 reference */
11149 case SAVEt_I16: /* I16 reference */
11150 case SAVEt_I8: /* I8 reference */
11151 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11152 ptr = POPPTR(ss,ix);
11153 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11155 TOPINT(nss,ix) = i;
11157 case SAVEt_IV: /* IV reference */
11158 ptr = POPPTR(ss,ix);
11159 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11161 TOPIV(nss,ix) = iv;
11163 case SAVEt_HPTR: /* HV* reference */
11164 case SAVEt_APTR: /* AV* reference */
11165 case SAVEt_SPTR: /* SV* reference */
11166 ptr = POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11168 sv = (SV*)POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = sv_dup(sv, param);
11171 case SAVEt_VPTR: /* random* reference */
11172 ptr = POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11174 ptr = POPPTR(ss,ix);
11175 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11177 case SAVEt_GENERIC_PVREF: /* generic char* */
11178 case SAVEt_PPTR: /* char* reference */
11179 ptr = POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11181 c = (char*)POPPTR(ss,ix);
11182 TOPPTR(nss,ix) = pv_dup(c);
11184 case SAVEt_GP: /* scalar reference */
11185 gp = (GP*)POPPTR(ss,ix);
11186 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11187 (void)GpREFCNT_inc(gp);
11188 gv = (GV*)POPPTR(ss,ix);
11189 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11192 ptr = POPPTR(ss,ix);
11193 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11194 /* these are assumed to be refcounted properly */
11196 switch (((OP*)ptr)->op_type) {
11198 case OP_LEAVESUBLV:
11202 case OP_LEAVEWRITE:
11203 TOPPTR(nss,ix) = ptr;
11206 (void) OpREFCNT_inc(o);
11210 TOPPTR(nss,ix) = NULL;
11215 TOPPTR(nss,ix) = NULL;
11218 c = (char*)POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = pv_dup_inc(c);
11222 hv = (const HV *)POPPTR(ss,ix);
11223 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11224 c = (char*)POPPTR(ss,ix);
11225 TOPPTR(nss,ix) = pv_dup_inc(c);
11227 case SAVEt_STACK_POS: /* Position on Perl stack */
11229 TOPINT(nss,ix) = i;
11231 case SAVEt_DESTRUCTOR:
11232 ptr = POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11234 dptr = POPDPTR(ss,ix);
11235 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11236 any_dup(FPTR2DPTR(void *, dptr),
11239 case SAVEt_DESTRUCTOR_X:
11240 ptr = POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11242 dxptr = POPDXPTR(ss,ix);
11243 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11244 any_dup(FPTR2DPTR(void *, dxptr),
11247 case SAVEt_REGCONTEXT:
11250 TOPINT(nss,ix) = i;
11253 case SAVEt_AELEM: /* array element */
11254 sv = (SV*)POPPTR(ss,ix);
11255 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11257 TOPINT(nss,ix) = i;
11258 av = (const AV *)POPPTR(ss,ix);
11259 TOPPTR(nss,ix) = av_dup_inc(av, param);
11262 ptr = POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = ptr;
11267 TOPINT(nss,ix) = i;
11268 ptr = POPPTR(ss,ix);
11271 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11272 HINTS_REFCNT_UNLOCK;
11274 TOPPTR(nss,ix) = ptr;
11275 if (i & HINT_LOCALIZE_HH) {
11276 hv = (const HV *)POPPTR(ss,ix);
11277 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11280 case SAVEt_PADSV_AND_MORTALIZE:
11281 longval = (long)POPLONG(ss,ix);
11282 TOPLONG(nss,ix) = longval;
11283 ptr = POPPTR(ss,ix);
11284 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11285 sv = (SV*)POPPTR(ss,ix);
11286 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11289 ptr = POPPTR(ss,ix);
11290 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11291 longval = (long)POPBOOL(ss,ix);
11292 TOPBOOL(nss,ix) = (bool)longval;
11294 case SAVEt_SET_SVFLAGS:
11296 TOPINT(nss,ix) = i;
11298 TOPINT(nss,ix) = i;
11299 sv = (SV*)POPPTR(ss,ix);
11300 TOPPTR(nss,ix) = sv_dup(sv, param);
11302 case SAVEt_RE_STATE:
11304 const struct re_save_state *const old_state
11305 = (struct re_save_state *)
11306 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11307 struct re_save_state *const new_state
11308 = (struct re_save_state *)
11309 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11311 Copy(old_state, new_state, 1, struct re_save_state);
11312 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11314 new_state->re_state_bostr
11315 = pv_dup(old_state->re_state_bostr);
11316 new_state->re_state_reginput
11317 = pv_dup(old_state->re_state_reginput);
11318 new_state->re_state_regeol
11319 = pv_dup(old_state->re_state_regeol);
11320 new_state->re_state_regoffs
11321 = (regexp_paren_pair*)
11322 any_dup(old_state->re_state_regoffs, proto_perl);
11323 new_state->re_state_reglastparen
11324 = (U32*) any_dup(old_state->re_state_reglastparen,
11326 new_state->re_state_reglastcloseparen
11327 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11329 /* XXX This just has to be broken. The old save_re_context
11330 code did SAVEGENERICPV(PL_reg_start_tmp);
11331 PL_reg_start_tmp is char **.
11332 Look above to what the dup code does for
11333 SAVEt_GENERIC_PVREF
11334 It can never have worked.
11335 So this is merely a faithful copy of the exiting bug: */
11336 new_state->re_state_reg_start_tmp
11337 = (char **) pv_dup((char *)
11338 old_state->re_state_reg_start_tmp);
11339 /* I assume that it only ever "worked" because no-one called
11340 (pseudo)fork while the regexp engine had re-entered itself.
11342 #ifdef PERL_OLD_COPY_ON_WRITE
11343 new_state->re_state_nrs
11344 = sv_dup(old_state->re_state_nrs, param);
11346 new_state->re_state_reg_magic
11347 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11349 new_state->re_state_reg_oldcurpm
11350 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11352 new_state->re_state_reg_curpm
11353 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11355 new_state->re_state_reg_oldsaved
11356 = pv_dup(old_state->re_state_reg_oldsaved);
11357 new_state->re_state_reg_poscache
11358 = pv_dup(old_state->re_state_reg_poscache);
11359 new_state->re_state_reg_starttry
11360 = pv_dup(old_state->re_state_reg_starttry);
11363 case SAVEt_COMPILE_WARNINGS:
11364 ptr = POPPTR(ss,ix);
11365 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11368 ptr = POPPTR(ss,ix);
11369 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11373 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11381 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11382 * flag to the result. This is done for each stash before cloning starts,
11383 * so we know which stashes want their objects cloned */
11386 do_mark_cloneable_stash(pTHX_ SV *const sv)
11388 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
11390 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
11391 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11392 if (cloner && GvCV(cloner)) {
11399 mXPUSHs(newSVhek(hvname));
11401 call_sv((SV*)GvCV(cloner), G_SCALAR);
11408 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11416 =for apidoc perl_clone
11418 Create and return a new interpreter by cloning the current one.
11420 perl_clone takes these flags as parameters:
11422 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11423 without it we only clone the data and zero the stacks,
11424 with it we copy the stacks and the new perl interpreter is
11425 ready to run at the exact same point as the previous one.
11426 The pseudo-fork code uses COPY_STACKS while the
11427 threads->create doesn't.
11429 CLONEf_KEEP_PTR_TABLE
11430 perl_clone keeps a ptr_table with the pointer of the old
11431 variable as a key and the new variable as a value,
11432 this allows it to check if something has been cloned and not
11433 clone it again but rather just use the value and increase the
11434 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11435 the ptr_table using the function
11436 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11437 reason to keep it around is if you want to dup some of your own
11438 variable who are outside the graph perl scans, example of this
11439 code is in threads.xs create
11442 This is a win32 thing, it is ignored on unix, it tells perls
11443 win32host code (which is c++) to clone itself, this is needed on
11444 win32 if you want to run two threads at the same time,
11445 if you just want to do some stuff in a separate perl interpreter
11446 and then throw it away and return to the original one,
11447 you don't need to do anything.
11452 /* XXX the above needs expanding by someone who actually understands it ! */
11453 EXTERN_C PerlInterpreter *
11454 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11457 perl_clone(PerlInterpreter *proto_perl, UV flags)
11460 #ifdef PERL_IMPLICIT_SYS
11462 PERL_ARGS_ASSERT_PERL_CLONE;
11464 /* perlhost.h so we need to call into it
11465 to clone the host, CPerlHost should have a c interface, sky */
11467 if (flags & CLONEf_CLONE_HOST) {
11468 return perl_clone_host(proto_perl,flags);
11470 return perl_clone_using(proto_perl, flags,
11472 proto_perl->IMemShared,
11473 proto_perl->IMemParse,
11475 proto_perl->IStdIO,
11479 proto_perl->IProc);
11483 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11484 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11485 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11486 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11487 struct IPerlDir* ipD, struct IPerlSock* ipS,
11488 struct IPerlProc* ipP)
11490 /* XXX many of the string copies here can be optimized if they're
11491 * constants; they need to be allocated as common memory and just
11492 * their pointers copied. */
11495 CLONE_PARAMS clone_params;
11496 CLONE_PARAMS* const param = &clone_params;
11498 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11500 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11502 /* for each stash, determine whether its objects should be cloned */
11503 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11504 PERL_SET_THX(my_perl);
11507 PoisonNew(my_perl, 1, PerlInterpreter);
11513 PL_savestack_ix = 0;
11514 PL_savestack_max = -1;
11515 PL_sig_pending = 0;
11517 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11518 # else /* !DEBUGGING */
11519 Zero(my_perl, 1, PerlInterpreter);
11520 # endif /* DEBUGGING */
11522 /* host pointers */
11524 PL_MemShared = ipMS;
11525 PL_MemParse = ipMP;
11532 #else /* !PERL_IMPLICIT_SYS */
11534 CLONE_PARAMS clone_params;
11535 CLONE_PARAMS* param = &clone_params;
11536 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11538 PERL_ARGS_ASSERT_PERL_CLONE;
11540 /* for each stash, determine whether its objects should be cloned */
11541 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11542 PERL_SET_THX(my_perl);
11545 PoisonNew(my_perl, 1, PerlInterpreter);
11551 PL_savestack_ix = 0;
11552 PL_savestack_max = -1;
11553 PL_sig_pending = 0;
11555 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11556 # else /* !DEBUGGING */
11557 Zero(my_perl, 1, PerlInterpreter);
11558 # endif /* DEBUGGING */
11559 #endif /* PERL_IMPLICIT_SYS */
11560 param->flags = flags;
11561 param->proto_perl = proto_perl;
11563 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11565 PL_body_arenas = NULL;
11566 Zero(&PL_body_roots, 1, PL_body_roots);
11568 PL_nice_chunk = NULL;
11569 PL_nice_chunk_size = 0;
11571 PL_sv_objcount = 0;
11573 PL_sv_arenaroot = NULL;
11575 PL_debug = proto_perl->Idebug;
11577 PL_hash_seed = proto_perl->Ihash_seed;
11578 PL_rehash_seed = proto_perl->Irehash_seed;
11580 #ifdef USE_REENTRANT_API
11581 /* XXX: things like -Dm will segfault here in perlio, but doing
11582 * PERL_SET_CONTEXT(proto_perl);
11583 * breaks too many other things
11585 Perl_reentrant_init(aTHX);
11588 /* create SV map for pointer relocation */
11589 PL_ptr_table = ptr_table_new();
11591 /* initialize these special pointers as early as possible */
11592 SvANY(&PL_sv_undef) = NULL;
11593 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11594 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11595 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11597 SvANY(&PL_sv_no) = new_XPVNV();
11598 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11599 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11600 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11601 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11602 SvCUR_set(&PL_sv_no, 0);
11603 SvLEN_set(&PL_sv_no, 1);
11604 SvIV_set(&PL_sv_no, 0);
11605 SvNV_set(&PL_sv_no, 0);
11606 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11608 SvANY(&PL_sv_yes) = new_XPVNV();
11609 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11610 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11611 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11612 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11613 SvCUR_set(&PL_sv_yes, 1);
11614 SvLEN_set(&PL_sv_yes, 2);
11615 SvIV_set(&PL_sv_yes, 1);
11616 SvNV_set(&PL_sv_yes, 1);
11617 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11619 /* create (a non-shared!) shared string table */
11620 PL_strtab = newHV();
11621 HvSHAREKEYS_off(PL_strtab);
11622 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11623 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11625 PL_compiling = proto_perl->Icompiling;
11627 /* These two PVs will be free'd special way so must set them same way op.c does */
11628 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11629 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11631 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11632 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11634 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11635 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11636 if (PL_compiling.cop_hints_hash) {
11638 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11639 HINTS_REFCNT_UNLOCK;
11641 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11642 #ifdef PERL_DEBUG_READONLY_OPS
11647 /* pseudo environmental stuff */
11648 PL_origargc = proto_perl->Iorigargc;
11649 PL_origargv = proto_perl->Iorigargv;
11651 param->stashes = newAV(); /* Setup array of objects to call clone on */
11653 /* Set tainting stuff before PerlIO_debug can possibly get called */
11654 PL_tainting = proto_perl->Itainting;
11655 PL_taint_warn = proto_perl->Itaint_warn;
11657 #ifdef PERLIO_LAYERS
11658 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11659 PerlIO_clone(aTHX_ proto_perl, param);
11662 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11663 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11664 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11665 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11666 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11667 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11670 PL_minus_c = proto_perl->Iminus_c;
11671 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11672 PL_localpatches = proto_perl->Ilocalpatches;
11673 PL_splitstr = proto_perl->Isplitstr;
11674 PL_minus_n = proto_perl->Iminus_n;
11675 PL_minus_p = proto_perl->Iminus_p;
11676 PL_minus_l = proto_perl->Iminus_l;
11677 PL_minus_a = proto_perl->Iminus_a;
11678 PL_minus_E = proto_perl->Iminus_E;
11679 PL_minus_F = proto_perl->Iminus_F;
11680 PL_doswitches = proto_perl->Idoswitches;
11681 PL_dowarn = proto_perl->Idowarn;
11682 PL_doextract = proto_perl->Idoextract;
11683 PL_sawampersand = proto_perl->Isawampersand;
11684 PL_unsafe = proto_perl->Iunsafe;
11685 PL_inplace = SAVEPV(proto_perl->Iinplace);
11686 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11687 PL_perldb = proto_perl->Iperldb;
11688 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11689 PL_exit_flags = proto_perl->Iexit_flags;
11691 /* magical thingies */
11692 /* XXX time(&PL_basetime) when asked for? */
11693 PL_basetime = proto_perl->Ibasetime;
11694 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11696 PL_maxsysfd = proto_perl->Imaxsysfd;
11697 PL_statusvalue = proto_perl->Istatusvalue;
11699 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11701 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11703 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11705 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
11706 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
11707 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
11710 /* RE engine related */
11711 Zero(&PL_reg_state, 1, struct re_save_state);
11712 PL_reginterp_cnt = 0;
11713 PL_regmatch_slab = NULL;
11715 /* Clone the regex array */
11716 /* ORANGE FIXME for plugins, probably in the SV dup code.
11717 newSViv(PTR2IV(CALLREGDUPE(
11718 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11720 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11721 PL_regex_pad = AvARRAY(PL_regex_padav);
11723 /* shortcuts to various I/O objects */
11724 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11725 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11726 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11727 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11728 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11729 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11731 /* shortcuts to regexp stuff */
11732 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11734 /* shortcuts to misc objects */
11735 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11737 /* shortcuts to debugging objects */
11738 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11739 PL_DBline = gv_dup(proto_perl->IDBline, param);
11740 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11741 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11742 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11743 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11744 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11746 /* symbol tables */
11747 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11748 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11749 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11750 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11751 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11753 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11754 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11755 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11756 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11757 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11758 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11759 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11760 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11762 PL_sub_generation = proto_perl->Isub_generation;
11763 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11765 /* funky return mechanisms */
11766 PL_forkprocess = proto_perl->Iforkprocess;
11768 /* subprocess state */
11769 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11771 /* internal state */
11772 PL_maxo = proto_perl->Imaxo;
11773 if (proto_perl->Iop_mask)
11774 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11777 /* PL_asserting = proto_perl->Iasserting; */
11779 /* current interpreter roots */
11780 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11782 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11784 PL_main_start = proto_perl->Imain_start;
11785 PL_eval_root = proto_perl->Ieval_root;
11786 PL_eval_start = proto_perl->Ieval_start;
11788 /* runtime control stuff */
11789 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11791 PL_filemode = proto_perl->Ifilemode;
11792 PL_lastfd = proto_perl->Ilastfd;
11793 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11796 PL_gensym = proto_perl->Igensym;
11797 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11798 PL_laststatval = proto_perl->Ilaststatval;
11799 PL_laststype = proto_perl->Ilaststype;
11802 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11804 /* interpreter atexit processing */
11805 PL_exitlistlen = proto_perl->Iexitlistlen;
11806 if (PL_exitlistlen) {
11807 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11808 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11811 PL_exitlist = (PerlExitListEntry*)NULL;
11813 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11814 if (PL_my_cxt_size) {
11815 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11816 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11817 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11818 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11819 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11823 PL_my_cxt_list = (void**)NULL;
11824 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11825 PL_my_cxt_keys = (const char**)NULL;
11828 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11829 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11830 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11832 PL_profiledata = NULL;
11834 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11836 PAD_CLONE_VARS(proto_perl, param);
11838 #ifdef HAVE_INTERP_INTERN
11839 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11842 /* more statics moved here */
11843 PL_generation = proto_perl->Igeneration;
11844 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11846 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11847 PL_in_clean_all = proto_perl->Iin_clean_all;
11849 PL_uid = proto_perl->Iuid;
11850 PL_euid = proto_perl->Ieuid;
11851 PL_gid = proto_perl->Igid;
11852 PL_egid = proto_perl->Iegid;
11853 PL_nomemok = proto_perl->Inomemok;
11854 PL_an = proto_perl->Ian;
11855 PL_evalseq = proto_perl->Ievalseq;
11856 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11857 PL_origalen = proto_perl->Iorigalen;
11858 #ifdef PERL_USES_PL_PIDSTATUS
11859 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11861 PL_osname = SAVEPV(proto_perl->Iosname);
11862 PL_sighandlerp = proto_perl->Isighandlerp;
11864 PL_runops = proto_perl->Irunops;
11866 PL_parser = parser_dup(proto_perl->Iparser, param);
11868 PL_subline = proto_perl->Isubline;
11869 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11872 PL_cryptseen = proto_perl->Icryptseen;
11875 PL_hints = proto_perl->Ihints;
11877 PL_amagic_generation = proto_perl->Iamagic_generation;
11879 #ifdef USE_LOCALE_COLLATE
11880 PL_collation_ix = proto_perl->Icollation_ix;
11881 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11882 PL_collation_standard = proto_perl->Icollation_standard;
11883 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11884 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11885 #endif /* USE_LOCALE_COLLATE */
11887 #ifdef USE_LOCALE_NUMERIC
11888 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11889 PL_numeric_standard = proto_perl->Inumeric_standard;
11890 PL_numeric_local = proto_perl->Inumeric_local;
11891 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11892 #endif /* !USE_LOCALE_NUMERIC */
11894 /* utf8 character classes */
11895 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11896 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11897 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11898 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11899 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11900 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11901 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11902 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11903 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11904 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11905 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11906 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11907 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11908 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11909 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11910 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11911 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11912 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11913 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11914 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11916 /* Did the locale setup indicate UTF-8? */
11917 PL_utf8locale = proto_perl->Iutf8locale;
11918 /* Unicode features (see perlrun/-C) */
11919 PL_unicode = proto_perl->Iunicode;
11921 /* Pre-5.8 signals control */
11922 PL_signals = proto_perl->Isignals;
11924 /* times() ticks per second */
11925 PL_clocktick = proto_perl->Iclocktick;
11927 /* Recursion stopper for PerlIO_find_layer */
11928 PL_in_load_module = proto_perl->Iin_load_module;
11930 /* sort() routine */
11931 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11933 /* Not really needed/useful since the reenrant_retint is "volatile",
11934 * but do it for consistency's sake. */
11935 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11937 /* Hooks to shared SVs and locks. */
11938 PL_sharehook = proto_perl->Isharehook;
11939 PL_lockhook = proto_perl->Ilockhook;
11940 PL_unlockhook = proto_perl->Iunlockhook;
11941 PL_threadhook = proto_perl->Ithreadhook;
11942 PL_destroyhook = proto_perl->Idestroyhook;
11944 #ifdef THREADS_HAVE_PIDS
11945 PL_ppid = proto_perl->Ippid;
11949 PL_last_swash_hv = NULL; /* reinits on demand */
11950 PL_last_swash_klen = 0;
11951 PL_last_swash_key[0]= '\0';
11952 PL_last_swash_tmps = (U8*)NULL;
11953 PL_last_swash_slen = 0;
11955 PL_glob_index = proto_perl->Iglob_index;
11956 PL_srand_called = proto_perl->Isrand_called;
11957 PL_bitcount = NULL; /* reinits on demand */
11959 if (proto_perl->Ipsig_pend) {
11960 Newxz(PL_psig_pend, SIG_SIZE, int);
11963 PL_psig_pend = (int*)NULL;
11966 if (proto_perl->Ipsig_ptr) {
11967 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11968 Newxz(PL_psig_name, SIG_SIZE, SV*);
11969 for (i = 1; i < SIG_SIZE; i++) {
11970 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11971 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11975 PL_psig_ptr = (SV**)NULL;
11976 PL_psig_name = (SV**)NULL;
11979 /* intrpvar.h stuff */
11981 if (flags & CLONEf_COPY_STACKS) {
11982 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11983 PL_tmps_ix = proto_perl->Itmps_ix;
11984 PL_tmps_max = proto_perl->Itmps_max;
11985 PL_tmps_floor = proto_perl->Itmps_floor;
11986 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11988 while (i <= PL_tmps_ix) {
11989 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11993 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11994 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11995 Newxz(PL_markstack, i, I32);
11996 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11997 - proto_perl->Imarkstack);
11998 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11999 - proto_perl->Imarkstack);
12000 Copy(proto_perl->Imarkstack, PL_markstack,
12001 PL_markstack_ptr - PL_markstack + 1, I32);
12003 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12004 * NOTE: unlike the others! */
12005 PL_scopestack_ix = proto_perl->Iscopestack_ix;
12006 PL_scopestack_max = proto_perl->Iscopestack_max;
12007 Newxz(PL_scopestack, PL_scopestack_max, I32);
12008 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
12010 /* NOTE: si_dup() looks at PL_markstack */
12011 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
12013 /* PL_curstack = PL_curstackinfo->si_stack; */
12014 PL_curstack = av_dup(proto_perl->Icurstack, param);
12015 PL_mainstack = av_dup(proto_perl->Imainstack, param);
12017 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12018 PL_stack_base = AvARRAY(PL_curstack);
12019 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
12020 - proto_perl->Istack_base);
12021 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12023 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12024 * NOTE: unlike the others! */
12025 PL_savestack_ix = proto_perl->Isavestack_ix;
12026 PL_savestack_max = proto_perl->Isavestack_max;
12027 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
12028 PL_savestack = ss_dup(proto_perl, param);
12032 ENTER; /* perl_destruct() wants to LEAVE; */
12034 /* although we're not duplicating the tmps stack, we should still
12035 * add entries for any SVs on the tmps stack that got cloned by a
12036 * non-refcount means (eg a temp in @_); otherwise they will be
12039 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
12040 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
12041 proto_perl->Itmps_stack[i]);
12042 if (nsv && !SvREFCNT(nsv)) {
12044 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
12049 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
12050 PL_top_env = &PL_start_env;
12052 PL_op = proto_perl->Iop;
12055 PL_Xpv = (XPV*)NULL;
12056 my_perl->Ina = proto_perl->Ina;
12058 PL_statbuf = proto_perl->Istatbuf;
12059 PL_statcache = proto_perl->Istatcache;
12060 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12061 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12063 PL_timesbuf = proto_perl->Itimesbuf;
12066 PL_tainted = proto_perl->Itainted;
12067 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12068 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12069 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12070 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
12071 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12072 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12073 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12074 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12075 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12077 PL_restartop = proto_perl->Irestartop;
12078 PL_in_eval = proto_perl->Iin_eval;
12079 PL_delaymagic = proto_perl->Idelaymagic;
12080 PL_dirty = proto_perl->Idirty;
12081 PL_localizing = proto_perl->Ilocalizing;
12083 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12084 PL_hv_fetch_ent_mh = NULL;
12085 PL_modcount = proto_perl->Imodcount;
12086 PL_lastgotoprobe = NULL;
12087 PL_dumpindent = proto_perl->Idumpindent;
12089 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12090 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12091 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12092 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12093 PL_efloatbuf = NULL; /* reinits on demand */
12094 PL_efloatsize = 0; /* reinits on demand */
12098 PL_screamfirst = NULL;
12099 PL_screamnext = NULL;
12100 PL_maxscream = -1; /* reinits on demand */
12101 PL_lastscream = NULL;
12104 PL_regdummy = proto_perl->Iregdummy;
12105 PL_colorset = 0; /* reinits PL_colors[] */
12106 /*PL_colors[6] = {0,0,0,0,0,0};*/
12110 /* Pluggable optimizer */
12111 PL_peepp = proto_perl->Ipeepp;
12113 PL_stashcache = newHV();
12115 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12116 proto_perl->Iwatchaddr);
12117 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12118 if (PL_debug && PL_watchaddr) {
12119 PerlIO_printf(Perl_debug_log,
12120 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12121 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12122 PTR2UV(PL_watchok));
12125 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12126 ptr_table_free(PL_ptr_table);
12127 PL_ptr_table = NULL;
12130 /* Call the ->CLONE method, if it exists, for each of the stashes
12131 identified by sv_dup() above.
12133 while(av_len(param->stashes) != -1) {
12134 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
12135 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12136 if (cloner && GvCV(cloner)) {
12141 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12143 call_sv((SV*)GvCV(cloner), G_DISCARD);
12149 SvREFCNT_dec(param->stashes);
12151 /* orphaned? eg threads->new inside BEGIN or use */
12152 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12153 SvREFCNT_inc_simple_void(PL_compcv);
12154 SAVEFREESV(PL_compcv);
12160 #endif /* USE_ITHREADS */
12163 =head1 Unicode Support
12165 =for apidoc sv_recode_to_utf8
12167 The encoding is assumed to be an Encode object, on entry the PV
12168 of the sv is assumed to be octets in that encoding, and the sv
12169 will be converted into Unicode (and UTF-8).
12171 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12172 is not a reference, nothing is done to the sv. If the encoding is not
12173 an C<Encode::XS> Encoding object, bad things will happen.
12174 (See F<lib/encoding.pm> and L<Encode>).
12176 The PV of the sv is returned.
12181 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12185 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12187 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12201 Passing sv_yes is wrong - it needs to be or'ed set of constants
12202 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12203 remove converted chars from source.
12205 Both will default the value - let them.
12207 XPUSHs(&PL_sv_yes);
12210 call_method("decode", G_SCALAR);
12214 s = SvPV_const(uni, len);
12215 if (s != SvPVX_const(sv)) {
12216 SvGROW(sv, len + 1);
12217 Move(s, SvPVX(sv), len + 1, char);
12218 SvCUR_set(sv, len);
12225 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12229 =for apidoc sv_cat_decode
12231 The encoding is assumed to be an Encode object, the PV of the ssv is
12232 assumed to be octets in that encoding and decoding the input starts
12233 from the position which (PV + *offset) pointed to. The dsv will be
12234 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12235 when the string tstr appears in decoding output or the input ends on
12236 the PV of the ssv. The value which the offset points will be modified
12237 to the last input position on the ssv.
12239 Returns TRUE if the terminator was found, else returns FALSE.
12244 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12245 SV *ssv, int *offset, char *tstr, int tlen)
12250 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12252 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12263 offsv = newSViv(*offset);
12265 mXPUSHp(tstr, tlen);
12267 call_method("cat_decode", G_SCALAR);
12269 ret = SvTRUE(TOPs);
12270 *offset = SvIV(offsv);
12276 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12281 /* ---------------------------------------------------------------------
12283 * support functions for report_uninit()
12286 /* the maxiumum size of array or hash where we will scan looking
12287 * for the undefined element that triggered the warning */
12289 #define FUV_MAX_SEARCH_SIZE 1000
12291 /* Look for an entry in the hash whose value has the same SV as val;
12292 * If so, return a mortal copy of the key. */
12295 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
12298 register HE **array;
12301 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12303 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12304 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12307 array = HvARRAY(hv);
12309 for (i=HvMAX(hv); i>0; i--) {
12310 register HE *entry;
12311 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12312 if (HeVAL(entry) != val)
12314 if ( HeVAL(entry) == &PL_sv_undef ||
12315 HeVAL(entry) == &PL_sv_placeholder)
12319 if (HeKLEN(entry) == HEf_SVKEY)
12320 return sv_mortalcopy(HeKEY_sv(entry));
12321 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12327 /* Look for an entry in the array whose value has the same SV as val;
12328 * If so, return the index, otherwise return -1. */
12331 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
12335 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12337 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12338 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12341 if (val != &PL_sv_undef) {
12342 SV ** const svp = AvARRAY(av);
12345 for (i=AvFILLp(av); i>=0; i--)
12352 /* S_varname(): return the name of a variable, optionally with a subscript.
12353 * If gv is non-zero, use the name of that global, along with gvtype (one
12354 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12355 * targ. Depending on the value of the subscript_type flag, return:
12358 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12359 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12360 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12361 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12364 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
12365 const SV *const keyname, I32 aindex, int subscript_type)
12368 SV * const name = sv_newmortal();
12371 buffer[0] = gvtype;
12374 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12376 gv_fullname4(name, gv, buffer, 0);
12378 if ((unsigned int)SvPVX(name)[1] <= 26) {
12380 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12382 /* Swap the 1 unprintable control character for the 2 byte pretty
12383 version - ie substr($name, 1, 1) = $buffer; */
12384 sv_insert(name, 1, 1, buffer, 2);
12388 CV * const cv = find_runcv(NULL);
12392 if (!cv || !CvPADLIST(cv))
12394 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
12395 sv = *av_fetch(av, targ, FALSE);
12396 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12399 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12400 SV * const sv = newSV(0);
12401 *SvPVX(name) = '$';
12402 Perl_sv_catpvf(aTHX_ name, "{%s}",
12403 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12406 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12407 *SvPVX(name) = '$';
12408 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12410 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12411 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12412 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12420 =for apidoc find_uninit_var
12422 Find the name of the undefined variable (if any) that caused the operator o
12423 to issue a "Use of uninitialized value" warning.
12424 If match is true, only return a name if it's value matches uninit_sv.
12425 So roughly speaking, if a unary operator (such as OP_COS) generates a
12426 warning, then following the direct child of the op may yield an
12427 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12428 other hand, with OP_ADD there are two branches to follow, so we only print
12429 the variable name if we get an exact match.
12431 The name is returned as a mortal SV.
12433 Assumes that PL_op is the op that originally triggered the error, and that
12434 PL_comppad/PL_curpad points to the currently executing pad.
12440 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
12446 const OP *o, *o2, *kid;
12448 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12449 uninit_sv == &PL_sv_placeholder)))
12452 switch (obase->op_type) {
12459 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12460 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12463 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12465 if (pad) { /* @lex, %lex */
12466 sv = PAD_SVl(obase->op_targ);
12470 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12471 /* @global, %global */
12472 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12475 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12477 else /* @{expr}, %{expr} */
12478 return find_uninit_var(cUNOPx(obase)->op_first,
12482 /* attempt to find a match within the aggregate */
12484 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12486 subscript_type = FUV_SUBSCRIPT_HASH;
12489 index = find_array_subscript((const AV *)sv, uninit_sv);
12491 subscript_type = FUV_SUBSCRIPT_ARRAY;
12494 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12497 return varname(gv, hash ? '%' : '@', obase->op_targ,
12498 keysv, index, subscript_type);
12502 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12504 return varname(NULL, '$', obase->op_targ,
12505 NULL, 0, FUV_SUBSCRIPT_NONE);
12508 gv = cGVOPx_gv(obase);
12509 if (!gv || (match && GvSV(gv) != uninit_sv))
12511 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12514 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12517 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
12518 if (!av || SvRMAGICAL(av))
12520 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12521 if (!svp || *svp != uninit_sv)
12524 return varname(NULL, '$', obase->op_targ,
12525 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12528 gv = cGVOPx_gv(obase);
12533 AV *const av = GvAV(gv);
12534 if (!av || SvRMAGICAL(av))
12536 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12537 if (!svp || *svp != uninit_sv)
12540 return varname(gv, '$', 0,
12541 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12546 o = cUNOPx(obase)->op_first;
12547 if (!o || o->op_type != OP_NULL ||
12548 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12550 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12554 if (PL_op == obase)
12555 /* $a[uninit_expr] or $h{uninit_expr} */
12556 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12559 o = cBINOPx(obase)->op_first;
12560 kid = cBINOPx(obase)->op_last;
12562 /* get the av or hv, and optionally the gv */
12564 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12565 sv = PAD_SV(o->op_targ);
12567 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12568 && cUNOPo->op_first->op_type == OP_GV)
12570 gv = cGVOPx_gv(cUNOPo->op_first);
12573 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12578 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12579 /* index is constant */
12583 if (obase->op_type == OP_HELEM) {
12584 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
12585 if (!he || HeVAL(he) != uninit_sv)
12589 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
12590 if (!svp || *svp != uninit_sv)
12594 if (obase->op_type == OP_HELEM)
12595 return varname(gv, '%', o->op_targ,
12596 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12598 return varname(gv, '@', o->op_targ, NULL,
12599 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12602 /* index is an expression;
12603 * attempt to find a match within the aggregate */
12604 if (obase->op_type == OP_HELEM) {
12605 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12607 return varname(gv, '%', o->op_targ,
12608 keysv, 0, FUV_SUBSCRIPT_HASH);
12612 = find_array_subscript((const AV *)sv, uninit_sv);
12614 return varname(gv, '@', o->op_targ,
12615 NULL, index, FUV_SUBSCRIPT_ARRAY);
12620 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12622 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12627 /* only examine RHS */
12628 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12631 o = cUNOPx(obase)->op_first;
12632 if (o->op_type == OP_PUSHMARK)
12635 if (!o->op_sibling) {
12636 /* one-arg version of open is highly magical */
12638 if (o->op_type == OP_GV) { /* open FOO; */
12640 if (match && GvSV(gv) != uninit_sv)
12642 return varname(gv, '$', 0,
12643 NULL, 0, FUV_SUBSCRIPT_NONE);
12645 /* other possibilities not handled are:
12646 * open $x; or open my $x; should return '${*$x}'
12647 * open expr; should return '$'.expr ideally
12653 /* ops where $_ may be an implicit arg */
12657 if ( !(obase->op_flags & OPf_STACKED)) {
12658 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12659 ? PAD_SVl(obase->op_targ)
12662 sv = sv_newmortal();
12663 sv_setpvs(sv, "$_");
12672 match = 1; /* print etc can return undef on defined args */
12673 /* skip filehandle as it can't produce 'undef' warning */
12674 o = cUNOPx(obase)->op_first;
12675 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12676 o = o->op_sibling->op_sibling;
12680 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12682 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12684 /* the following ops are capable of returning PL_sv_undef even for
12685 * defined arg(s) */
12704 case OP_GETPEERNAME:
12752 case OP_SMARTMATCH:
12761 /* XXX tmp hack: these two may call an XS sub, and currently
12762 XS subs don't have a SUB entry on the context stack, so CV and
12763 pad determination goes wrong, and BAD things happen. So, just
12764 don't try to determine the value under those circumstances.
12765 Need a better fix at dome point. DAPM 11/2007 */
12770 /* def-ness of rval pos() is independent of the def-ness of its arg */
12771 if ( !(obase->op_flags & OPf_MOD))
12776 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12777 return newSVpvs_flags("${$/}", SVs_TEMP);
12782 if (!(obase->op_flags & OPf_KIDS))
12784 o = cUNOPx(obase)->op_first;
12790 /* if all except one arg are constant, or have no side-effects,
12791 * or are optimized away, then it's unambiguous */
12793 for (kid=o; kid; kid = kid->op_sibling) {
12795 const OPCODE type = kid->op_type;
12796 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12797 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12798 || (type == OP_PUSHMARK)
12802 if (o2) { /* more than one found */
12809 return find_uninit_var(o2, uninit_sv, match);
12811 /* scan all args */
12813 sv = find_uninit_var(o, uninit_sv, 1);
12825 =for apidoc report_uninit
12827 Print appropriate "Use of uninitialized variable" warning
12833 Perl_report_uninit(pTHX_ SV* uninit_sv)
12837 SV* varname = NULL;
12839 varname = find_uninit_var(PL_op, uninit_sv,0);
12841 sv_insert(varname, 0, 0, " ", 1);
12843 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12844 varname ? SvPV_nolen_const(varname) : "",
12845 " in ", OP_DESC(PL_op));
12848 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12854 * c-indentation-style: bsd
12855 * c-basic-offset: 4
12856 * indent-tabs-mode: t
12859 * ex: set ts=8 sts=4 sw=4 noet: