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 = MUTABLE_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 = MUTABLE_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 = MUTABLE_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 = MUTABLE_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 = MUTABLE_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 == (const SV *) PL_fdpid || sv == (const 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 = MUTABLE_SV(SvANY(sva));
641 while (svanext && SvFAKE(svanext))
642 svanext = MUTABLE_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((const 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 = 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_ MUTABLE_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 != (const 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)) == (const IO *)sv)
4745 mg->mg_len = namlen;
4748 mg->mg_ptr = savepvn(name, namlen);
4749 else if (namlen == HEf_SVKEY) {
4750 /* Yes, this is casting away const. This is only for the case of
4751 HEf_SVKEY. I think we need to document this abberation of the
4752 constness of the API, rather than making name non-const, as
4753 that change propagating outwards a long way. */
4754 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
4756 mg->mg_ptr = (char *) name;
4758 mg->mg_virtual = (MGVTBL *) vtable;
4762 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4767 =for apidoc sv_magic
4769 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4770 then adds a new magic item of type C<how> to the head of the magic list.
4772 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4773 handling of the C<name> and C<namlen> arguments.
4775 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4776 to add more than one instance of the same 'how'.
4782 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4783 const char *const name, const I32 namlen)
4786 const MGVTBL *vtable;
4789 PERL_ARGS_ASSERT_SV_MAGIC;
4791 #ifdef PERL_OLD_COPY_ON_WRITE
4793 sv_force_normal_flags(sv, 0);
4795 if (SvREADONLY(sv)) {
4797 /* its okay to attach magic to shared strings; the subsequent
4798 * upgrade to PVMG will unshare the string */
4799 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4802 && how != PERL_MAGIC_regex_global
4803 && how != PERL_MAGIC_bm
4804 && how != PERL_MAGIC_fm
4805 && how != PERL_MAGIC_sv
4806 && how != PERL_MAGIC_backref
4809 Perl_croak(aTHX_ PL_no_modify);
4812 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4813 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4814 /* sv_magic() refuses to add a magic of the same 'how' as an
4817 if (how == PERL_MAGIC_taint) {
4819 /* Any scalar which already had taint magic on which someone
4820 (erroneously?) did SvIOK_on() or similar will now be
4821 incorrectly sporting public "OK" flags. */
4822 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4830 vtable = &PL_vtbl_sv;
4832 case PERL_MAGIC_overload:
4833 vtable = &PL_vtbl_amagic;
4835 case PERL_MAGIC_overload_elem:
4836 vtable = &PL_vtbl_amagicelem;
4838 case PERL_MAGIC_overload_table:
4839 vtable = &PL_vtbl_ovrld;
4842 vtable = &PL_vtbl_bm;
4844 case PERL_MAGIC_regdata:
4845 vtable = &PL_vtbl_regdata;
4847 case PERL_MAGIC_regdatum:
4848 vtable = &PL_vtbl_regdatum;
4850 case PERL_MAGIC_env:
4851 vtable = &PL_vtbl_env;
4854 vtable = &PL_vtbl_fm;
4856 case PERL_MAGIC_envelem:
4857 vtable = &PL_vtbl_envelem;
4859 case PERL_MAGIC_regex_global:
4860 vtable = &PL_vtbl_mglob;
4862 case PERL_MAGIC_isa:
4863 vtable = &PL_vtbl_isa;
4865 case PERL_MAGIC_isaelem:
4866 vtable = &PL_vtbl_isaelem;
4868 case PERL_MAGIC_nkeys:
4869 vtable = &PL_vtbl_nkeys;
4871 case PERL_MAGIC_dbfile:
4874 case PERL_MAGIC_dbline:
4875 vtable = &PL_vtbl_dbline;
4877 #ifdef USE_LOCALE_COLLATE
4878 case PERL_MAGIC_collxfrm:
4879 vtable = &PL_vtbl_collxfrm;
4881 #endif /* USE_LOCALE_COLLATE */
4882 case PERL_MAGIC_tied:
4883 vtable = &PL_vtbl_pack;
4885 case PERL_MAGIC_tiedelem:
4886 case PERL_MAGIC_tiedscalar:
4887 vtable = &PL_vtbl_packelem;
4890 vtable = &PL_vtbl_regexp;
4892 case PERL_MAGIC_hints:
4893 /* As this vtable is all NULL, we can reuse it. */
4894 case PERL_MAGIC_sig:
4895 vtable = &PL_vtbl_sig;
4897 case PERL_MAGIC_sigelem:
4898 vtable = &PL_vtbl_sigelem;
4900 case PERL_MAGIC_taint:
4901 vtable = &PL_vtbl_taint;
4903 case PERL_MAGIC_uvar:
4904 vtable = &PL_vtbl_uvar;
4906 case PERL_MAGIC_vec:
4907 vtable = &PL_vtbl_vec;
4909 case PERL_MAGIC_arylen_p:
4910 case PERL_MAGIC_rhash:
4911 case PERL_MAGIC_symtab:
4912 case PERL_MAGIC_vstring:
4915 case PERL_MAGIC_utf8:
4916 vtable = &PL_vtbl_utf8;
4918 case PERL_MAGIC_substr:
4919 vtable = &PL_vtbl_substr;
4921 case PERL_MAGIC_defelem:
4922 vtable = &PL_vtbl_defelem;
4924 case PERL_MAGIC_arylen:
4925 vtable = &PL_vtbl_arylen;
4927 case PERL_MAGIC_pos:
4928 vtable = &PL_vtbl_pos;
4930 case PERL_MAGIC_backref:
4931 vtable = &PL_vtbl_backref;
4933 case PERL_MAGIC_hintselem:
4934 vtable = &PL_vtbl_hintselem;
4936 case PERL_MAGIC_ext:
4937 /* Reserved for use by extensions not perl internals. */
4938 /* Useful for attaching extension internal data to perl vars. */
4939 /* Note that multiple extensions may clash if magical scalars */
4940 /* etc holding private data from one are passed to another. */
4944 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4947 /* Rest of work is done else where */
4948 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4951 case PERL_MAGIC_taint:
4954 case PERL_MAGIC_ext:
4955 case PERL_MAGIC_dbfile:
4962 =for apidoc sv_unmagic
4964 Removes all magic of type C<type> from an SV.
4970 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4975 PERL_ARGS_ASSERT_SV_UNMAGIC;
4977 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4979 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4980 for (mg = *mgp; mg; mg = *mgp) {
4981 if (mg->mg_type == type) {
4982 const MGVTBL* const vtbl = mg->mg_virtual;
4983 *mgp = mg->mg_moremagic;
4984 if (vtbl && vtbl->svt_free)
4985 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4986 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4988 Safefree(mg->mg_ptr);
4989 else if (mg->mg_len == HEf_SVKEY)
4990 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
4991 else if (mg->mg_type == PERL_MAGIC_utf8)
4992 Safefree(mg->mg_ptr);
4994 if (mg->mg_flags & MGf_REFCOUNTED)
4995 SvREFCNT_dec(mg->mg_obj);
4999 mgp = &mg->mg_moremagic;
5003 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5004 SvMAGIC_set(sv, NULL);
5011 =for apidoc sv_rvweaken
5013 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5014 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5015 push a back-reference to this RV onto the array of backreferences
5016 associated with that magic. If the RV is magical, set magic will be
5017 called after the RV is cleared.
5023 Perl_sv_rvweaken(pTHX_ SV *const sv)
5027 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5029 if (!SvOK(sv)) /* let undefs pass */
5032 Perl_croak(aTHX_ "Can't weaken a nonreference");
5033 else if (SvWEAKREF(sv)) {
5034 if (ckWARN(WARN_MISC))
5035 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5039 Perl_sv_add_backref(aTHX_ tsv, sv);
5045 /* Give tsv backref magic if it hasn't already got it, then push a
5046 * back-reference to sv onto the array associated with the backref magic.
5049 /* A discussion about the backreferences array and its refcount:
5051 * The AV holding the backreferences is pointed to either as the mg_obj of
5052 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5053 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5054 * have the standard magic instead.) The array is created with a refcount
5055 * of 2. This means that if during global destruction the array gets
5056 * picked on first to have its refcount decremented by the random zapper,
5057 * it won't actually be freed, meaning it's still theere for when its
5058 * parent gets freed.
5059 * When the parent SV is freed, in the case of magic, the magic is freed,
5060 * Perl_magic_killbackrefs is called which decrements one refcount, then
5061 * mg_obj is freed which kills the second count.
5062 * In the vase of a HV being freed, one ref is removed by
5063 * Perl_hv_kill_backrefs, the other by Perl_sv_kill_backrefs, which it
5068 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5073 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5075 if (SvTYPE(tsv) == SVt_PVHV) {
5076 AV **const avp = Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5080 /* There is no AV in the offical place - try a fixup. */
5081 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5084 /* Aha. They've got it stowed in magic. Bring it back. */
5085 av = MUTABLE_AV(mg->mg_obj);
5086 /* Stop mg_free decreasing the refernce count. */
5088 /* Stop mg_free even calling the destructor, given that
5089 there's no AV to free up. */
5091 sv_unmagic(tsv, PERL_MAGIC_backref);
5095 SvREFCNT_inc_simple_void(av); /* see discussion above */
5100 const MAGIC *const mg
5101 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5103 av = MUTABLE_AV(mg->mg_obj);
5107 sv_magic(tsv, MUTABLE_SV(av), PERL_MAGIC_backref, NULL, 0);
5108 /* av now has a refcnt of 2; see discussion above */
5111 if (AvFILLp(av) >= AvMAX(av)) {
5112 av_extend(av, AvFILLp(av)+1);
5114 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5117 /* delete a back-reference to ourselves from the backref magic associated
5118 * with the SV we point to.
5122 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5129 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5131 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5132 av = *Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5133 /* We mustn't attempt to "fix up" the hash here by moving the
5134 backreference array back to the hv_aux structure, as that is stored
5135 in the main HvARRAY(), and hfreentries assumes that no-one
5136 reallocates HvARRAY() while it is running. */
5139 const MAGIC *const mg
5140 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5142 av = MUTABLE_AV(mg->mg_obj);
5146 Perl_croak(aTHX_ "panic: del_backref");
5148 assert(!SvIS_FREED(av));
5151 /* We shouldn't be in here more than once, but for paranoia reasons lets
5153 for (i = AvFILLp(av); i >= 0; i--) {
5155 const SSize_t fill = AvFILLp(av);
5157 /* We weren't the last entry.
5158 An unordered list has this property that you can take the
5159 last element off the end to fill the hole, and it's still
5160 an unordered list :-)
5165 AvFILLp(av) = fill - 1;
5171 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5173 SV **svp = AvARRAY(av);
5175 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5176 PERL_UNUSED_ARG(sv);
5178 assert(!svp || !SvIS_FREED(av));
5180 SV *const *const last = svp + AvFILLp(av);
5182 while (svp <= last) {
5184 SV *const referrer = *svp;
5185 if (SvWEAKREF(referrer)) {
5186 /* XXX Should we check that it hasn't changed? */
5187 SvRV_set(referrer, 0);
5189 SvWEAKREF_off(referrer);
5190 SvSETMAGIC(referrer);
5191 } else if (SvTYPE(referrer) == SVt_PVGV ||
5192 SvTYPE(referrer) == SVt_PVLV) {
5193 /* You lookin' at me? */
5194 assert(GvSTASH(referrer));
5195 assert(GvSTASH(referrer) == (const HV *)sv);
5196 GvSTASH(referrer) = 0;
5199 "panic: magic_killbackrefs (flags=%"UVxf")",
5200 (UV)SvFLAGS(referrer));
5208 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5213 =for apidoc sv_insert
5215 Inserts a string at the specified offset/length within the SV. Similar to
5216 the Perl substr() function. Handles get magic.
5218 =for apidoc sv_insert_flags
5220 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5226 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5231 register char *midend;
5232 register char *bigend;
5236 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5239 Perl_croak(aTHX_ "Can't modify non-existent substring");
5240 SvPV_force_flags(bigstr, curlen, flags);
5241 (void)SvPOK_only_UTF8(bigstr);
5242 if (offset + len > curlen) {
5243 SvGROW(bigstr, offset+len+1);
5244 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5245 SvCUR_set(bigstr, offset+len);
5249 i = littlelen - len;
5250 if (i > 0) { /* string might grow */
5251 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5252 mid = big + offset + len;
5253 midend = bigend = big + SvCUR(bigstr);
5256 while (midend > mid) /* shove everything down */
5257 *--bigend = *--midend;
5258 Move(little,big+offset,littlelen,char);
5259 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5264 Move(little,SvPVX(bigstr)+offset,len,char);
5269 big = SvPVX(bigstr);
5272 bigend = big + SvCUR(bigstr);
5274 if (midend > bigend)
5275 Perl_croak(aTHX_ "panic: sv_insert");
5277 if (mid - big > bigend - midend) { /* faster to shorten from end */
5279 Move(little, mid, littlelen,char);
5282 i = bigend - midend;
5284 Move(midend, mid, i,char);
5288 SvCUR_set(bigstr, mid - big);
5290 else if ((i = mid - big)) { /* faster from front */
5291 midend -= littlelen;
5293 Move(big, midend - i, i, char);
5294 sv_chop(bigstr,midend-i);
5296 Move(little, mid, littlelen,char);
5298 else if (littlelen) {
5299 midend -= littlelen;
5300 sv_chop(bigstr,midend);
5301 Move(little,midend,littlelen,char);
5304 sv_chop(bigstr,midend);
5310 =for apidoc sv_replace
5312 Make the first argument a copy of the second, then delete the original.
5313 The target SV physically takes over ownership of the body of the source SV
5314 and inherits its flags; however, the target keeps any magic it owns,
5315 and any magic in the source is discarded.
5316 Note that this is a rather specialist SV copying operation; most of the
5317 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5323 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5326 const U32 refcnt = SvREFCNT(sv);
5328 PERL_ARGS_ASSERT_SV_REPLACE;
5330 SV_CHECK_THINKFIRST_COW_DROP(sv);
5331 if (SvREFCNT(nsv) != 1) {
5332 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5333 UVuf " != 1)", (UV) SvREFCNT(nsv));
5335 if (SvMAGICAL(sv)) {
5339 sv_upgrade(nsv, SVt_PVMG);
5340 SvMAGIC_set(nsv, SvMAGIC(sv));
5341 SvFLAGS(nsv) |= SvMAGICAL(sv);
5343 SvMAGIC_set(sv, NULL);
5347 assert(!SvREFCNT(sv));
5348 #ifdef DEBUG_LEAKING_SCALARS
5349 sv->sv_flags = nsv->sv_flags;
5350 sv->sv_any = nsv->sv_any;
5351 sv->sv_refcnt = nsv->sv_refcnt;
5352 sv->sv_u = nsv->sv_u;
5354 StructCopy(nsv,sv,SV);
5356 if(SvTYPE(sv) == SVt_IV) {
5358 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5362 #ifdef PERL_OLD_COPY_ON_WRITE
5363 if (SvIsCOW_normal(nsv)) {
5364 /* We need to follow the pointers around the loop to make the
5365 previous SV point to sv, rather than nsv. */
5368 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5371 assert(SvPVX_const(current) == SvPVX_const(nsv));
5373 /* Make the SV before us point to the SV after us. */
5375 PerlIO_printf(Perl_debug_log, "previous is\n");
5377 PerlIO_printf(Perl_debug_log,
5378 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5379 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5381 SV_COW_NEXT_SV_SET(current, sv);
5384 SvREFCNT(sv) = refcnt;
5385 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5391 =for apidoc sv_clear
5393 Clear an SV: call any destructors, free up any memory used by the body,
5394 and free the body itself. The SV's head is I<not> freed, although
5395 its type is set to all 1's so that it won't inadvertently be assumed
5396 to be live during global destruction etc.
5397 This function should only be called when REFCNT is zero. Most of the time
5398 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5405 Perl_sv_clear(pTHX_ register SV *const sv)
5408 const U32 type = SvTYPE(sv);
5409 const struct body_details *const sv_type_details
5410 = bodies_by_type + type;
5413 PERL_ARGS_ASSERT_SV_CLEAR;
5414 assert(SvREFCNT(sv) == 0);
5415 assert(SvTYPE(sv) != SVTYPEMASK);
5417 if (type <= SVt_IV) {
5418 /* See the comment in sv.h about the collusion between this early
5419 return and the overloading of the NULL and IV slots in the size
5422 SV * const target = SvRV(sv);
5424 sv_del_backref(target, sv);
5426 SvREFCNT_dec(target);
5428 SvFLAGS(sv) &= SVf_BREAK;
5429 SvFLAGS(sv) |= SVTYPEMASK;
5434 if (PL_defstash && /* Still have a symbol table? */
5441 stash = SvSTASH(sv);
5442 destructor = StashHANDLER(stash,DESTROY);
5444 SV* const tmpref = newRV(sv);
5445 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5447 PUSHSTACKi(PERLSI_DESTROY);
5452 call_sv(MUTABLE_SV(destructor), G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5458 if(SvREFCNT(tmpref) < 2) {
5459 /* tmpref is not kept alive! */
5461 SvRV_set(tmpref, NULL);
5464 SvREFCNT_dec(tmpref);
5466 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5470 if (PL_in_clean_objs)
5471 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5473 /* DESTROY gave object new lease on life */
5479 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5480 SvOBJECT_off(sv); /* Curse the object. */
5481 if (type != SVt_PVIO)
5482 --PL_sv_objcount; /* XXX Might want something more general */
5485 if (type >= SVt_PVMG) {
5486 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5487 SvREFCNT_dec(SvOURSTASH(sv));
5488 } else if (SvMAGIC(sv))
5490 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5491 SvREFCNT_dec(SvSTASH(sv));
5494 /* case SVt_BIND: */
5497 IoIFP(sv) != PerlIO_stdin() &&
5498 IoIFP(sv) != PerlIO_stdout() &&
5499 IoIFP(sv) != PerlIO_stderr())
5501 io_close(MUTABLE_IO(sv), FALSE);
5503 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5504 PerlDir_close(IoDIRP(sv));
5505 IoDIRP(sv) = (DIR*)NULL;
5506 Safefree(IoTOP_NAME(sv));
5507 Safefree(IoFMT_NAME(sv));
5508 Safefree(IoBOTTOM_NAME(sv));
5511 /* FIXME for plugins */
5512 pregfree2((REGEXP*) sv);
5516 cv_undef(MUTABLE_CV(sv));
5519 if (PL_last_swash_hv == (const HV *)sv) {
5520 PL_last_swash_hv = NULL;
5522 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5523 hv_undef(MUTABLE_HV(sv));
5526 if (PL_comppad == MUTABLE_AV(sv)) {
5530 av_undef(MUTABLE_AV(sv));
5533 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5534 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5535 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5536 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5538 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5539 SvREFCNT_dec(LvTARG(sv));
5541 if (isGV_with_GP(sv)) {
5542 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5543 mro_method_changed_in(stash);
5546 unshare_hek(GvNAME_HEK(sv));
5547 /* If we're in a stash, we don't own a reference to it. However it does
5548 have a back reference to us, which needs to be cleared. */
5549 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5550 sv_del_backref(MUTABLE_SV(stash), sv);
5552 /* FIXME. There are probably more unreferenced pointers to SVs in the
5553 interpreter struct that we should check and tidy in a similar
5555 if ((GV*)sv == PL_last_in_gv)
5556 PL_last_in_gv = NULL;
5562 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5565 SvOOK_offset(sv, offset);
5566 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5567 /* Don't even bother with turning off the OOK flag. */
5570 SV * const target = SvRV(sv);
5572 sv_del_backref(target, sv);
5574 SvREFCNT_dec(target);
5576 #ifdef PERL_OLD_COPY_ON_WRITE
5577 else if (SvPVX_const(sv)) {
5579 /* I believe I need to grab the global SV mutex here and
5580 then recheck the COW status. */
5582 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5586 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5588 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5591 /* And drop it here. */
5593 } else if (SvLEN(sv)) {
5594 Safefree(SvPVX_const(sv));
5598 else if (SvPVX_const(sv) && SvLEN(sv))
5599 Safefree(SvPVX_mutable(sv));
5600 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5601 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5610 SvFLAGS(sv) &= SVf_BREAK;
5611 SvFLAGS(sv) |= SVTYPEMASK;
5613 if (sv_type_details->arena) {
5614 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5615 &PL_body_roots[type]);
5617 else if (sv_type_details->body_size) {
5618 my_safefree(SvANY(sv));
5623 =for apidoc sv_newref
5625 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5632 Perl_sv_newref(pTHX_ SV *const sv)
5634 PERL_UNUSED_CONTEXT;
5643 Decrement an SV's reference count, and if it drops to zero, call
5644 C<sv_clear> to invoke destructors and free up any memory used by
5645 the body; finally, deallocate the SV's head itself.
5646 Normally called via a wrapper macro C<SvREFCNT_dec>.
5652 Perl_sv_free(pTHX_ SV *const sv)
5657 if (SvREFCNT(sv) == 0) {
5658 if (SvFLAGS(sv) & SVf_BREAK)
5659 /* this SV's refcnt has been artificially decremented to
5660 * trigger cleanup */
5662 if (PL_in_clean_all) /* All is fair */
5664 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5665 /* make sure SvREFCNT(sv)==0 happens very seldom */
5666 SvREFCNT(sv) = (~(U32)0)/2;
5669 if (ckWARN_d(WARN_INTERNAL)) {
5670 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5671 Perl_dump_sv_child(aTHX_ sv);
5673 #ifdef DEBUG_LEAKING_SCALARS
5676 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5677 if (PL_warnhook == PERL_WARNHOOK_FATAL
5678 || ckDEAD(packWARN(WARN_INTERNAL))) {
5679 /* Don't let Perl_warner cause us to escape our fate: */
5683 /* This may not return: */
5684 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5685 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5686 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5689 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5694 if (--(SvREFCNT(sv)) > 0)
5696 Perl_sv_free2(aTHX_ sv);
5700 Perl_sv_free2(pTHX_ SV *const sv)
5704 PERL_ARGS_ASSERT_SV_FREE2;
5708 if (ckWARN_d(WARN_DEBUGGING))
5709 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5710 "Attempt to free temp prematurely: SV 0x%"UVxf
5711 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5715 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5716 /* make sure SvREFCNT(sv)==0 happens very seldom */
5717 SvREFCNT(sv) = (~(U32)0)/2;
5728 Returns the length of the string in the SV. Handles magic and type
5729 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5735 Perl_sv_len(pTHX_ register SV *const sv)
5743 len = mg_length(sv);
5745 (void)SvPV_const(sv, len);
5750 =for apidoc sv_len_utf8
5752 Returns the number of characters in the string in an SV, counting wide
5753 UTF-8 bytes as a single character. Handles magic and type coercion.
5759 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5760 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5761 * (Note that the mg_len is not the length of the mg_ptr field.
5762 * This allows the cache to store the character length of the string without
5763 * needing to malloc() extra storage to attach to the mg_ptr.)
5768 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5774 return mg_length(sv);
5778 const U8 *s = (U8*)SvPV_const(sv, len);
5782 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5784 if (mg && mg->mg_len != -1) {
5786 if (PL_utf8cache < 0) {
5787 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5789 /* Need to turn the assertions off otherwise we may
5790 recurse infinitely while printing error messages.
5792 SAVEI8(PL_utf8cache);
5794 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5795 " real %"UVuf" for %"SVf,
5796 (UV) ulen, (UV) real, SVfARG(sv));
5801 ulen = Perl_utf8_length(aTHX_ s, s + len);
5802 if (!SvREADONLY(sv)) {
5804 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5805 &PL_vtbl_utf8, 0, 0);
5813 return Perl_utf8_length(aTHX_ s, s + len);
5817 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5820 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5823 const U8 *s = start;
5825 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5827 while (s < send && uoffset--)
5830 /* This is the existing behaviour. Possibly it should be a croak, as
5831 it's actually a bounds error */
5837 /* Given the length of the string in both bytes and UTF-8 characters, decide
5838 whether to walk forwards or backwards to find the byte corresponding to
5839 the passed in UTF-8 offset. */
5841 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5842 const STRLEN uoffset, const STRLEN uend)
5844 STRLEN backw = uend - uoffset;
5846 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5848 if (uoffset < 2 * backw) {
5849 /* The assumption is that going forwards is twice the speed of going
5850 forward (that's where the 2 * backw comes from).
5851 (The real figure of course depends on the UTF-8 data.) */
5852 return sv_pos_u2b_forwards(start, send, uoffset);
5857 while (UTF8_IS_CONTINUATION(*send))
5860 return send - start;
5863 /* For the string representation of the given scalar, find the byte
5864 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5865 give another position in the string, *before* the sought offset, which
5866 (which is always true, as 0, 0 is a valid pair of positions), which should
5867 help reduce the amount of linear searching.
5868 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5869 will be used to reduce the amount of linear searching. The cache will be
5870 created if necessary, and the found value offered to it for update. */
5872 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5873 const U8 *const send, const STRLEN uoffset,
5874 STRLEN uoffset0, STRLEN boffset0)
5876 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5879 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5881 assert (uoffset >= uoffset0);
5883 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5884 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5885 if ((*mgp)->mg_ptr) {
5886 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5887 if (cache[0] == uoffset) {
5888 /* An exact match. */
5891 if (cache[2] == uoffset) {
5892 /* An exact match. */
5896 if (cache[0] < uoffset) {
5897 /* The cache already knows part of the way. */
5898 if (cache[0] > uoffset0) {
5899 /* The cache knows more than the passed in pair */
5900 uoffset0 = cache[0];
5901 boffset0 = cache[1];
5903 if ((*mgp)->mg_len != -1) {
5904 /* And we know the end too. */
5906 + sv_pos_u2b_midway(start + boffset0, send,
5908 (*mgp)->mg_len - uoffset0);
5911 + sv_pos_u2b_forwards(start + boffset0,
5912 send, uoffset - uoffset0);
5915 else if (cache[2] < uoffset) {
5916 /* We're between the two cache entries. */
5917 if (cache[2] > uoffset0) {
5918 /* and the cache knows more than the passed in pair */
5919 uoffset0 = cache[2];
5920 boffset0 = cache[3];
5924 + sv_pos_u2b_midway(start + boffset0,
5927 cache[0] - uoffset0);
5930 + sv_pos_u2b_midway(start + boffset0,
5933 cache[2] - uoffset0);
5937 else if ((*mgp)->mg_len != -1) {
5938 /* If we can take advantage of a passed in offset, do so. */
5939 /* In fact, offset0 is either 0, or less than offset, so don't
5940 need to worry about the other possibility. */
5942 + sv_pos_u2b_midway(start + boffset0, send,
5944 (*mgp)->mg_len - uoffset0);
5949 if (!found || PL_utf8cache < 0) {
5950 const STRLEN real_boffset
5951 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5952 send, uoffset - uoffset0);
5954 if (found && PL_utf8cache < 0) {
5955 if (real_boffset != boffset) {
5956 /* Need to turn the assertions off otherwise we may recurse
5957 infinitely while printing error messages. */
5958 SAVEI8(PL_utf8cache);
5960 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5961 " real %"UVuf" for %"SVf,
5962 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5965 boffset = real_boffset;
5969 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5975 =for apidoc sv_pos_u2b
5977 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5978 the start of the string, to a count of the equivalent number of bytes; if
5979 lenp is non-zero, it does the same to lenp, but this time starting from
5980 the offset, rather than from the start of the string. Handles magic and
5987 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5988 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5989 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5994 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5999 PERL_ARGS_ASSERT_SV_POS_U2B;
6004 start = (U8*)SvPV_const(sv, len);
6006 STRLEN uoffset = (STRLEN) *offsetp;
6007 const U8 * const send = start + len;
6009 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
6012 *offsetp = (I32) boffset;
6015 /* Convert the relative offset to absolute. */
6016 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
6017 const STRLEN boffset2
6018 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6019 uoffset, boffset) - boffset;
6033 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6034 byte length pairing. The (byte) length of the total SV is passed in too,
6035 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6036 may not have updated SvCUR, so we can't rely on reading it directly.
6038 The proffered utf8/byte length pairing isn't used if the cache already has
6039 two pairs, and swapping either for the proffered pair would increase the
6040 RMS of the intervals between known byte offsets.
6042 The cache itself consists of 4 STRLEN values
6043 0: larger UTF-8 offset
6044 1: corresponding byte offset
6045 2: smaller UTF-8 offset
6046 3: corresponding byte offset
6048 Unused cache pairs have the value 0, 0.
6049 Keeping the cache "backwards" means that the invariant of
6050 cache[0] >= cache[2] is maintained even with empty slots, which means that
6051 the code that uses it doesn't need to worry if only 1 entry has actually
6052 been set to non-zero. It also makes the "position beyond the end of the
6053 cache" logic much simpler, as the first slot is always the one to start
6057 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6058 const STRLEN utf8, const STRLEN blen)
6062 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6068 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6070 (*mgp)->mg_len = -1;
6074 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6075 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6076 (*mgp)->mg_ptr = (char *) cache;
6080 if (PL_utf8cache < 0) {
6081 const U8 *start = (const U8 *) SvPVX_const(sv);
6082 const STRLEN realutf8 = utf8_length(start, start + byte);
6084 if (realutf8 != utf8) {
6085 /* Need to turn the assertions off otherwise we may recurse
6086 infinitely while printing error messages. */
6087 SAVEI8(PL_utf8cache);
6089 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6090 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6094 /* Cache is held with the later position first, to simplify the code
6095 that deals with unbounded ends. */
6097 ASSERT_UTF8_CACHE(cache);
6098 if (cache[1] == 0) {
6099 /* Cache is totally empty */
6102 } else if (cache[3] == 0) {
6103 if (byte > cache[1]) {
6104 /* New one is larger, so goes first. */
6105 cache[2] = cache[0];
6106 cache[3] = cache[1];
6114 #define THREEWAY_SQUARE(a,b,c,d) \
6115 ((float)((d) - (c))) * ((float)((d) - (c))) \
6116 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6117 + ((float)((b) - (a))) * ((float)((b) - (a)))
6119 /* Cache has 2 slots in use, and we know three potential pairs.
6120 Keep the two that give the lowest RMS distance. Do the
6121 calcualation in bytes simply because we always know the byte
6122 length. squareroot has the same ordering as the positive value,
6123 so don't bother with the actual square root. */
6124 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6125 if (byte > cache[1]) {
6126 /* New position is after the existing pair of pairs. */
6127 const float keep_earlier
6128 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6129 const float keep_later
6130 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6132 if (keep_later < keep_earlier) {
6133 if (keep_later < existing) {
6134 cache[2] = cache[0];
6135 cache[3] = cache[1];
6141 if (keep_earlier < existing) {
6147 else if (byte > cache[3]) {
6148 /* New position is between the existing pair of pairs. */
6149 const float keep_earlier
6150 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6151 const float keep_later
6152 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6154 if (keep_later < keep_earlier) {
6155 if (keep_later < existing) {
6161 if (keep_earlier < existing) {
6168 /* New position is before the existing pair of pairs. */
6169 const float keep_earlier
6170 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6171 const float keep_later
6172 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6174 if (keep_later < keep_earlier) {
6175 if (keep_later < existing) {
6181 if (keep_earlier < existing) {
6182 cache[0] = cache[2];
6183 cache[1] = cache[3];
6190 ASSERT_UTF8_CACHE(cache);
6193 /* We already know all of the way, now we may be able to walk back. The same
6194 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6195 backward is half the speed of walking forward. */
6197 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6198 const U8 *end, STRLEN endu)
6200 const STRLEN forw = target - s;
6201 STRLEN backw = end - target;
6203 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6205 if (forw < 2 * backw) {
6206 return utf8_length(s, target);
6209 while (end > target) {
6211 while (UTF8_IS_CONTINUATION(*end)) {
6220 =for apidoc sv_pos_b2u
6222 Converts the value pointed to by offsetp from a count of bytes from the
6223 start of the string, to a count of the equivalent number of UTF-8 chars.
6224 Handles magic and type coercion.
6230 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6231 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6236 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6239 const STRLEN byte = *offsetp;
6240 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6246 PERL_ARGS_ASSERT_SV_POS_B2U;
6251 s = (const U8*)SvPV_const(sv, blen);
6254 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6258 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6259 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6261 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6262 if (cache[1] == byte) {
6263 /* An exact match. */
6264 *offsetp = cache[0];
6267 if (cache[3] == byte) {
6268 /* An exact match. */
6269 *offsetp = cache[2];
6273 if (cache[1] < byte) {
6274 /* We already know part of the way. */
6275 if (mg->mg_len != -1) {
6276 /* Actually, we know the end too. */
6278 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6279 s + blen, mg->mg_len - cache[0]);
6281 len = cache[0] + utf8_length(s + cache[1], send);
6284 else if (cache[3] < byte) {
6285 /* We're between the two cached pairs, so we do the calculation
6286 offset by the byte/utf-8 positions for the earlier pair,
6287 then add the utf-8 characters from the string start to
6289 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6290 s + cache[1], cache[0] - cache[2])
6294 else { /* cache[3] > byte */
6295 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6299 ASSERT_UTF8_CACHE(cache);
6301 } else if (mg->mg_len != -1) {
6302 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6306 if (!found || PL_utf8cache < 0) {
6307 const STRLEN real_len = utf8_length(s, send);
6309 if (found && PL_utf8cache < 0) {
6310 if (len != real_len) {
6311 /* Need to turn the assertions off otherwise we may recurse
6312 infinitely while printing error messages. */
6313 SAVEI8(PL_utf8cache);
6315 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6316 " real %"UVuf" for %"SVf,
6317 (UV) len, (UV) real_len, SVfARG(sv));
6325 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6331 Returns a boolean indicating whether the strings in the two SVs are
6332 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6333 coerce its args to strings if necessary.
6339 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6348 SV* svrecode = NULL;
6355 /* if pv1 and pv2 are the same, second SvPV_const call may
6356 * invalidate pv1, so we may need to make a copy */
6357 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6358 pv1 = SvPV_const(sv1, cur1);
6359 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6361 pv1 = SvPV_const(sv1, cur1);
6369 pv2 = SvPV_const(sv2, cur2);
6371 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6372 /* Differing utf8ness.
6373 * Do not UTF8size the comparands as a side-effect. */
6376 svrecode = newSVpvn(pv2, cur2);
6377 sv_recode_to_utf8(svrecode, PL_encoding);
6378 pv2 = SvPV_const(svrecode, cur2);
6381 svrecode = newSVpvn(pv1, cur1);
6382 sv_recode_to_utf8(svrecode, PL_encoding);
6383 pv1 = SvPV_const(svrecode, cur1);
6385 /* Now both are in UTF-8. */
6387 SvREFCNT_dec(svrecode);
6392 bool is_utf8 = TRUE;
6395 /* sv1 is the UTF-8 one,
6396 * if is equal it must be downgrade-able */
6397 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6403 /* sv2 is the UTF-8 one,
6404 * if is equal it must be downgrade-able */
6405 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6411 /* Downgrade not possible - cannot be eq */
6419 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6421 SvREFCNT_dec(svrecode);
6431 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6432 string in C<sv1> is less than, equal to, or greater than the string in
6433 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6434 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6440 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6444 const char *pv1, *pv2;
6447 SV *svrecode = NULL;
6454 pv1 = SvPV_const(sv1, cur1);
6461 pv2 = SvPV_const(sv2, cur2);
6463 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6464 /* Differing utf8ness.
6465 * Do not UTF8size the comparands as a side-effect. */
6468 svrecode = newSVpvn(pv2, cur2);
6469 sv_recode_to_utf8(svrecode, PL_encoding);
6470 pv2 = SvPV_const(svrecode, cur2);
6473 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6478 svrecode = newSVpvn(pv1, cur1);
6479 sv_recode_to_utf8(svrecode, PL_encoding);
6480 pv1 = SvPV_const(svrecode, cur1);
6483 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6489 cmp = cur2 ? -1 : 0;
6493 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6496 cmp = retval < 0 ? -1 : 1;
6497 } else if (cur1 == cur2) {
6500 cmp = cur1 < cur2 ? -1 : 1;
6504 SvREFCNT_dec(svrecode);
6512 =for apidoc sv_cmp_locale
6514 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6515 'use bytes' aware, handles get magic, and will coerce its args to strings
6516 if necessary. See also C<sv_cmp>.
6522 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6525 #ifdef USE_LOCALE_COLLATE
6531 if (PL_collation_standard)
6535 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6537 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6539 if (!pv1 || !len1) {
6550 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6553 return retval < 0 ? -1 : 1;
6556 * When the result of collation is equality, that doesn't mean
6557 * that there are no differences -- some locales exclude some
6558 * characters from consideration. So to avoid false equalities,
6559 * we use the raw string as a tiebreaker.
6565 #endif /* USE_LOCALE_COLLATE */
6567 return sv_cmp(sv1, sv2);
6571 #ifdef USE_LOCALE_COLLATE
6574 =for apidoc sv_collxfrm
6576 Add Collate Transform magic to an SV if it doesn't already have it.
6578 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6579 scalar data of the variable, but transformed to such a format that a normal
6580 memory comparison can be used to compare the data according to the locale
6587 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6592 PERL_ARGS_ASSERT_SV_COLLXFRM;
6594 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6595 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6601 Safefree(mg->mg_ptr);
6602 s = SvPV_const(sv, len);
6603 if ((xf = mem_collxfrm(s, len, &xlen))) {
6605 #ifdef PERL_OLD_COPY_ON_WRITE
6607 sv_force_normal_flags(sv, 0);
6609 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6623 if (mg && mg->mg_ptr) {
6625 return mg->mg_ptr + sizeof(PL_collation_ix);
6633 #endif /* USE_LOCALE_COLLATE */
6638 Get a line from the filehandle and store it into the SV, optionally
6639 appending to the currently-stored string.
6645 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6650 register STDCHAR rslast;
6651 register STDCHAR *bp;
6656 PERL_ARGS_ASSERT_SV_GETS;
6658 if (SvTHINKFIRST(sv))
6659 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6660 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6662 However, perlbench says it's slower, because the existing swipe code
6663 is faster than copy on write.
6664 Swings and roundabouts. */
6665 SvUPGRADE(sv, SVt_PV);
6670 if (PerlIO_isutf8(fp)) {
6672 sv_utf8_upgrade_nomg(sv);
6673 sv_pos_u2b(sv,&append,0);
6675 } else if (SvUTF8(sv)) {
6676 SV * const tsv = newSV(0);
6677 sv_gets(tsv, fp, 0);
6678 sv_utf8_upgrade_nomg(tsv);
6679 SvCUR_set(sv,append);
6682 goto return_string_or_null;
6687 if (PerlIO_isutf8(fp))
6690 if (IN_PERL_COMPILETIME) {
6691 /* we always read code in line mode */
6695 else if (RsSNARF(PL_rs)) {
6696 /* If it is a regular disk file use size from stat() as estimate
6697 of amount we are going to read -- may result in mallocing
6698 more memory than we really need if the layers below reduce
6699 the size we read (e.g. CRLF or a gzip layer).
6702 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6703 const Off_t offset = PerlIO_tell(fp);
6704 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6705 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6711 else if (RsRECORD(PL_rs)) {
6719 /* Grab the size of the record we're getting */
6720 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6721 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6724 /* VMS wants read instead of fread, because fread doesn't respect */
6725 /* RMS record boundaries. This is not necessarily a good thing to be */
6726 /* doing, but we've got no other real choice - except avoid stdio
6727 as implementation - perhaps write a :vms layer ?
6729 fd = PerlIO_fileno(fp);
6730 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6731 bytesread = PerlIO_read(fp, buffer, recsize);
6734 bytesread = PerlLIO_read(fd, buffer, recsize);
6737 bytesread = PerlIO_read(fp, buffer, recsize);
6741 SvCUR_set(sv, bytesread + append);
6742 buffer[bytesread] = '\0';
6743 goto return_string_or_null;
6745 else if (RsPARA(PL_rs)) {
6751 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6752 if (PerlIO_isutf8(fp)) {
6753 rsptr = SvPVutf8(PL_rs, rslen);
6756 if (SvUTF8(PL_rs)) {
6757 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6758 Perl_croak(aTHX_ "Wide character in $/");
6761 rsptr = SvPV_const(PL_rs, rslen);
6765 rslast = rslen ? rsptr[rslen - 1] : '\0';
6767 if (rspara) { /* have to do this both before and after */
6768 do { /* to make sure file boundaries work right */
6771 i = PerlIO_getc(fp);
6775 PerlIO_ungetc(fp,i);
6781 /* See if we know enough about I/O mechanism to cheat it ! */
6783 /* This used to be #ifdef test - it is made run-time test for ease
6784 of abstracting out stdio interface. One call should be cheap
6785 enough here - and may even be a macro allowing compile
6789 if (PerlIO_fast_gets(fp)) {
6792 * We're going to steal some values from the stdio struct
6793 * and put EVERYTHING in the innermost loop into registers.
6795 register STDCHAR *ptr;
6799 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6800 /* An ungetc()d char is handled separately from the regular
6801 * buffer, so we getc() it back out and stuff it in the buffer.
6803 i = PerlIO_getc(fp);
6804 if (i == EOF) return 0;
6805 *(--((*fp)->_ptr)) = (unsigned char) i;
6809 /* Here is some breathtakingly efficient cheating */
6811 cnt = PerlIO_get_cnt(fp); /* get count into register */
6812 /* make sure we have the room */
6813 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6814 /* Not room for all of it
6815 if we are looking for a separator and room for some
6817 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6818 /* just process what we have room for */
6819 shortbuffered = cnt - SvLEN(sv) + append + 1;
6820 cnt -= shortbuffered;
6824 /* remember that cnt can be negative */
6825 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6830 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6831 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6832 DEBUG_P(PerlIO_printf(Perl_debug_log,
6833 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6834 DEBUG_P(PerlIO_printf(Perl_debug_log,
6835 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6836 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6837 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6842 while (cnt > 0) { /* this | eat */
6844 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6845 goto thats_all_folks; /* screams | sed :-) */
6849 Copy(ptr, bp, cnt, char); /* this | eat */
6850 bp += cnt; /* screams | dust */
6851 ptr += cnt; /* louder | sed :-) */
6856 if (shortbuffered) { /* oh well, must extend */
6857 cnt = shortbuffered;
6859 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6861 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6862 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6866 DEBUG_P(PerlIO_printf(Perl_debug_log,
6867 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6868 PTR2UV(ptr),(long)cnt));
6869 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6871 DEBUG_P(PerlIO_printf(Perl_debug_log,
6872 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6873 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6874 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6876 /* This used to call 'filbuf' in stdio form, but as that behaves like
6877 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6878 another abstraction. */
6879 i = PerlIO_getc(fp); /* get more characters */
6881 DEBUG_P(PerlIO_printf(Perl_debug_log,
6882 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6883 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6884 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6886 cnt = PerlIO_get_cnt(fp);
6887 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6888 DEBUG_P(PerlIO_printf(Perl_debug_log,
6889 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6891 if (i == EOF) /* all done for ever? */
6892 goto thats_really_all_folks;
6894 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6896 SvGROW(sv, bpx + cnt + 2);
6897 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6899 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6901 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6902 goto thats_all_folks;
6906 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6907 memNE((char*)bp - rslen, rsptr, rslen))
6908 goto screamer; /* go back to the fray */
6909 thats_really_all_folks:
6911 cnt += shortbuffered;
6912 DEBUG_P(PerlIO_printf(Perl_debug_log,
6913 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6914 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6915 DEBUG_P(PerlIO_printf(Perl_debug_log,
6916 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6917 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6918 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6920 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6921 DEBUG_P(PerlIO_printf(Perl_debug_log,
6922 "Screamer: done, len=%ld, string=|%.*s|\n",
6923 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6927 /*The big, slow, and stupid way. */
6928 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6929 STDCHAR *buf = NULL;
6930 Newx(buf, 8192, STDCHAR);
6938 register const STDCHAR * const bpe = buf + sizeof(buf);
6940 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6941 ; /* keep reading */
6945 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6946 /* Accomodate broken VAXC compiler, which applies U8 cast to
6947 * both args of ?: operator, causing EOF to change into 255
6950 i = (U8)buf[cnt - 1];
6956 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6958 sv_catpvn(sv, (char *) buf, cnt);
6960 sv_setpvn(sv, (char *) buf, cnt);
6962 if (i != EOF && /* joy */
6964 SvCUR(sv) < rslen ||
6965 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6969 * If we're reading from a TTY and we get a short read,
6970 * indicating that the user hit his EOF character, we need
6971 * to notice it now, because if we try to read from the TTY
6972 * again, the EOF condition will disappear.
6974 * The comparison of cnt to sizeof(buf) is an optimization
6975 * that prevents unnecessary calls to feof().
6979 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6983 #ifdef USE_HEAP_INSTEAD_OF_STACK
6988 if (rspara) { /* have to do this both before and after */
6989 while (i != EOF) { /* to make sure file boundaries work right */
6990 i = PerlIO_getc(fp);
6992 PerlIO_ungetc(fp,i);
6998 return_string_or_null:
6999 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7005 Auto-increment of the value in the SV, doing string to numeric conversion
7006 if necessary. Handles 'get' magic.
7012 Perl_sv_inc(pTHX_ register SV *const sv)
7021 if (SvTHINKFIRST(sv)) {
7023 sv_force_normal_flags(sv, 0);
7024 if (SvREADONLY(sv)) {
7025 if (IN_PERL_RUNTIME)
7026 Perl_croak(aTHX_ PL_no_modify);
7030 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7032 i = PTR2IV(SvRV(sv));
7037 flags = SvFLAGS(sv);
7038 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7039 /* It's (privately or publicly) a float, but not tested as an
7040 integer, so test it to see. */
7042 flags = SvFLAGS(sv);
7044 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7045 /* It's publicly an integer, or privately an integer-not-float */
7046 #ifdef PERL_PRESERVE_IVUV
7050 if (SvUVX(sv) == UV_MAX)
7051 sv_setnv(sv, UV_MAX_P1);
7053 (void)SvIOK_only_UV(sv);
7054 SvUV_set(sv, SvUVX(sv) + 1);
7056 if (SvIVX(sv) == IV_MAX)
7057 sv_setuv(sv, (UV)IV_MAX + 1);
7059 (void)SvIOK_only(sv);
7060 SvIV_set(sv, SvIVX(sv) + 1);
7065 if (flags & SVp_NOK) {
7066 const NV was = SvNVX(sv);
7067 if (NV_OVERFLOWS_INTEGERS_AT &&
7068 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7069 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7070 "Lost precision when incrementing %" NVff " by 1",
7073 (void)SvNOK_only(sv);
7074 SvNV_set(sv, was + 1.0);
7078 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7079 if ((flags & SVTYPEMASK) < SVt_PVIV)
7080 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7081 (void)SvIOK_only(sv);
7086 while (isALPHA(*d)) d++;
7087 while (isDIGIT(*d)) d++;
7089 #ifdef PERL_PRESERVE_IVUV
7090 /* Got to punt this as an integer if needs be, but we don't issue
7091 warnings. Probably ought to make the sv_iv_please() that does
7092 the conversion if possible, and silently. */
7093 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7094 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7095 /* Need to try really hard to see if it's an integer.
7096 9.22337203685478e+18 is an integer.
7097 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7098 so $a="9.22337203685478e+18"; $a+0; $a++
7099 needs to be the same as $a="9.22337203685478e+18"; $a++
7106 /* sv_2iv *should* have made this an NV */
7107 if (flags & SVp_NOK) {
7108 (void)SvNOK_only(sv);
7109 SvNV_set(sv, SvNVX(sv) + 1.0);
7112 /* I don't think we can get here. Maybe I should assert this
7113 And if we do get here I suspect that sv_setnv will croak. NWC
7115 #if defined(USE_LONG_DOUBLE)
7116 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",
7117 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7119 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7120 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7123 #endif /* PERL_PRESERVE_IVUV */
7124 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7128 while (d >= SvPVX_const(sv)) {
7136 /* MKS: The original code here died if letters weren't consecutive.
7137 * at least it didn't have to worry about non-C locales. The
7138 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7139 * arranged in order (although not consecutively) and that only
7140 * [A-Za-z] are accepted by isALPHA in the C locale.
7142 if (*d != 'z' && *d != 'Z') {
7143 do { ++*d; } while (!isALPHA(*d));
7146 *(d--) -= 'z' - 'a';
7151 *(d--) -= 'z' - 'a' + 1;
7155 /* oh,oh, the number grew */
7156 SvGROW(sv, SvCUR(sv) + 2);
7157 SvCUR_set(sv, SvCUR(sv) + 1);
7158 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7169 Auto-decrement of the value in the SV, doing string to numeric conversion
7170 if necessary. Handles 'get' magic.
7176 Perl_sv_dec(pTHX_ register SV *const sv)
7184 if (SvTHINKFIRST(sv)) {
7186 sv_force_normal_flags(sv, 0);
7187 if (SvREADONLY(sv)) {
7188 if (IN_PERL_RUNTIME)
7189 Perl_croak(aTHX_ PL_no_modify);
7193 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7195 i = PTR2IV(SvRV(sv));
7200 /* Unlike sv_inc we don't have to worry about string-never-numbers
7201 and keeping them magic. But we mustn't warn on punting */
7202 flags = SvFLAGS(sv);
7203 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7204 /* It's publicly an integer, or privately an integer-not-float */
7205 #ifdef PERL_PRESERVE_IVUV
7209 if (SvUVX(sv) == 0) {
7210 (void)SvIOK_only(sv);
7214 (void)SvIOK_only_UV(sv);
7215 SvUV_set(sv, SvUVX(sv) - 1);
7218 if (SvIVX(sv) == IV_MIN) {
7219 sv_setnv(sv, (NV)IV_MIN);
7223 (void)SvIOK_only(sv);
7224 SvIV_set(sv, SvIVX(sv) - 1);
7229 if (flags & SVp_NOK) {
7232 const NV was = SvNVX(sv);
7233 if (NV_OVERFLOWS_INTEGERS_AT &&
7234 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7235 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7236 "Lost precision when decrementing %" NVff " by 1",
7239 (void)SvNOK_only(sv);
7240 SvNV_set(sv, was - 1.0);
7244 if (!(flags & SVp_POK)) {
7245 if ((flags & SVTYPEMASK) < SVt_PVIV)
7246 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7248 (void)SvIOK_only(sv);
7251 #ifdef PERL_PRESERVE_IVUV
7253 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7254 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7255 /* Need to try really hard to see if it's an integer.
7256 9.22337203685478e+18 is an integer.
7257 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7258 so $a="9.22337203685478e+18"; $a+0; $a--
7259 needs to be the same as $a="9.22337203685478e+18"; $a--
7266 /* sv_2iv *should* have made this an NV */
7267 if (flags & SVp_NOK) {
7268 (void)SvNOK_only(sv);
7269 SvNV_set(sv, SvNVX(sv) - 1.0);
7272 /* I don't think we can get here. Maybe I should assert this
7273 And if we do get here I suspect that sv_setnv will croak. NWC
7275 #if defined(USE_LONG_DOUBLE)
7276 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",
7277 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7279 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7280 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7284 #endif /* PERL_PRESERVE_IVUV */
7285 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7289 =for apidoc sv_mortalcopy
7291 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7292 The new SV is marked as mortal. It will be destroyed "soon", either by an
7293 explicit call to FREETMPS, or by an implicit call at places such as
7294 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7299 /* Make a string that will exist for the duration of the expression
7300 * evaluation. Actually, it may have to last longer than that, but
7301 * hopefully we won't free it until it has been assigned to a
7302 * permanent location. */
7305 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7311 sv_setsv(sv,oldstr);
7313 PL_tmps_stack[++PL_tmps_ix] = sv;
7319 =for apidoc sv_newmortal
7321 Creates a new null SV which is mortal. The reference count of the SV is
7322 set to 1. It will be destroyed "soon", either by an explicit call to
7323 FREETMPS, or by an implicit call at places such as statement boundaries.
7324 See also C<sv_mortalcopy> and C<sv_2mortal>.
7330 Perl_sv_newmortal(pTHX)
7336 SvFLAGS(sv) = SVs_TEMP;
7338 PL_tmps_stack[++PL_tmps_ix] = sv;
7344 =for apidoc newSVpvn_flags
7346 Creates a new SV and copies a string into it. The reference count for the
7347 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7348 string. You are responsible for ensuring that the source string is at least
7349 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7350 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7351 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7352 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7353 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7355 #define newSVpvn_utf8(s, len, u) \
7356 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7362 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7367 /* All the flags we don't support must be zero.
7368 And we're new code so I'm going to assert this from the start. */
7369 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7371 sv_setpvn(sv,s,len);
7372 SvFLAGS(sv) |= (flags & SVf_UTF8);
7373 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7377 =for apidoc sv_2mortal
7379 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7380 by an explicit call to FREETMPS, or by an implicit call at places such as
7381 statement boundaries. SvTEMP() is turned on which means that the SV's
7382 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7383 and C<sv_mortalcopy>.
7389 Perl_sv_2mortal(pTHX_ register SV *const sv)
7394 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7397 PL_tmps_stack[++PL_tmps_ix] = sv;
7405 Creates a new SV and copies a string into it. The reference count for the
7406 SV is set to 1. If C<len> is zero, Perl will compute the length using
7407 strlen(). For efficiency, consider using C<newSVpvn> instead.
7413 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7419 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7424 =for apidoc newSVpvn
7426 Creates a new SV and copies a string into it. The reference count for the
7427 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7428 string. You are responsible for ensuring that the source string is at least
7429 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7435 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7441 sv_setpvn(sv,s,len);
7446 =for apidoc newSVhek
7448 Creates a new SV from the hash key structure. It will generate scalars that
7449 point to the shared string table where possible. Returns a new (undefined)
7450 SV if the hek is NULL.
7456 Perl_newSVhek(pTHX_ const HEK *const hek)
7466 if (HEK_LEN(hek) == HEf_SVKEY) {
7467 return newSVsv(*(SV**)HEK_KEY(hek));
7469 const int flags = HEK_FLAGS(hek);
7470 if (flags & HVhek_WASUTF8) {
7472 Andreas would like keys he put in as utf8 to come back as utf8
7474 STRLEN utf8_len = HEK_LEN(hek);
7475 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7476 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7479 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7481 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7482 /* We don't have a pointer to the hv, so we have to replicate the
7483 flag into every HEK. This hv is using custom a hasing
7484 algorithm. Hence we can't return a shared string scalar, as
7485 that would contain the (wrong) hash value, and might get passed
7486 into an hv routine with a regular hash.
7487 Similarly, a hash that isn't using shared hash keys has to have
7488 the flag in every key so that we know not to try to call
7489 share_hek_kek on it. */
7491 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7496 /* This will be overwhelminly the most common case. */
7498 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7499 more efficient than sharepvn(). */
7503 sv_upgrade(sv, SVt_PV);
7504 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7505 SvCUR_set(sv, HEK_LEN(hek));
7518 =for apidoc newSVpvn_share
7520 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7521 table. If the string does not already exist in the table, it is created
7522 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7523 value is used; otherwise the hash is computed. The string's hash can be later
7524 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7525 that as the string table is used for shared hash keys these strings will have
7526 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7532 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7536 bool is_utf8 = FALSE;
7537 const char *const orig_src = src;
7540 STRLEN tmplen = -len;
7542 /* See the note in hv.c:hv_fetch() --jhi */
7543 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7547 PERL_HASH(hash, src, len);
7549 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
7550 changes here, update it there too. */
7551 sv_upgrade(sv, SVt_PV);
7552 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7560 if (src != orig_src)
7566 #if defined(PERL_IMPLICIT_CONTEXT)
7568 /* pTHX_ magic can't cope with varargs, so this is a no-context
7569 * version of the main function, (which may itself be aliased to us).
7570 * Don't access this version directly.
7574 Perl_newSVpvf_nocontext(const char *const pat, ...)
7580 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7582 va_start(args, pat);
7583 sv = vnewSVpvf(pat, &args);
7590 =for apidoc newSVpvf
7592 Creates a new SV and initializes it with the string formatted like
7599 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7604 PERL_ARGS_ASSERT_NEWSVPVF;
7606 va_start(args, pat);
7607 sv = vnewSVpvf(pat, &args);
7612 /* backend for newSVpvf() and newSVpvf_nocontext() */
7615 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7620 PERL_ARGS_ASSERT_VNEWSVPVF;
7623 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7630 Creates a new SV and copies a floating point value into it.
7631 The reference count for the SV is set to 1.
7637 Perl_newSVnv(pTHX_ const NV n)
7650 Creates a new SV and copies an integer into it. The reference count for the
7657 Perl_newSViv(pTHX_ const IV i)
7670 Creates a new SV and copies an unsigned integer into it.
7671 The reference count for the SV is set to 1.
7677 Perl_newSVuv(pTHX_ const UV u)
7688 =for apidoc newSV_type
7690 Creates a new SV, of the type specified. The reference count for the new SV
7697 Perl_newSV_type(pTHX_ const svtype type)
7702 sv_upgrade(sv, type);
7707 =for apidoc newRV_noinc
7709 Creates an RV wrapper for an SV. The reference count for the original
7710 SV is B<not> incremented.
7716 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7719 register SV *sv = newSV_type(SVt_IV);
7721 PERL_ARGS_ASSERT_NEWRV_NOINC;
7724 SvRV_set(sv, tmpRef);
7729 /* newRV_inc is the official function name to use now.
7730 * newRV_inc is in fact #defined to newRV in sv.h
7734 Perl_newRV(pTHX_ SV *const sv)
7738 PERL_ARGS_ASSERT_NEWRV;
7740 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7746 Creates a new SV which is an exact duplicate of the original SV.
7753 Perl_newSVsv(pTHX_ register SV *const old)
7760 if (SvTYPE(old) == SVTYPEMASK) {
7761 if (ckWARN_d(WARN_INTERNAL))
7762 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7766 /* SV_GMAGIC is the default for sv_setv()
7767 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7768 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7769 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7774 =for apidoc sv_reset
7776 Underlying implementation for the C<reset> Perl function.
7777 Note that the perl-level function is vaguely deprecated.
7783 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7786 char todo[PERL_UCHAR_MAX+1];
7788 PERL_ARGS_ASSERT_SV_RESET;
7793 if (!*s) { /* reset ?? searches */
7794 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
7796 const U32 count = mg->mg_len / sizeof(PMOP**);
7797 PMOP **pmp = (PMOP**) mg->mg_ptr;
7798 PMOP *const *const end = pmp + count;
7802 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7804 (*pmp)->op_pmflags &= ~PMf_USED;
7812 /* reset variables */
7814 if (!HvARRAY(stash))
7817 Zero(todo, 256, char);
7820 I32 i = (unsigned char)*s;
7824 max = (unsigned char)*s++;
7825 for ( ; i <= max; i++) {
7828 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7830 for (entry = HvARRAY(stash)[i];
7832 entry = HeNEXT(entry))
7837 if (!todo[(U8)*HeKEY(entry)])
7839 gv = (GV*)HeVAL(entry);
7842 if (SvTHINKFIRST(sv)) {
7843 if (!SvREADONLY(sv) && SvROK(sv))
7845 /* XXX Is this continue a bug? Why should THINKFIRST
7846 exempt us from resetting arrays and hashes? */
7850 if (SvTYPE(sv) >= SVt_PV) {
7852 if (SvPVX_const(sv) != NULL)
7860 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7862 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7865 # if defined(USE_ENVIRON_ARRAY)
7868 # endif /* USE_ENVIRON_ARRAY */
7879 Using various gambits, try to get an IO from an SV: the IO slot if its a
7880 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7881 named after the PV if we're a string.
7887 Perl_sv_2io(pTHX_ SV *const sv)
7892 PERL_ARGS_ASSERT_SV_2IO;
7894 switch (SvTYPE(sv)) {
7896 io = MUTABLE_IO(sv);
7899 if (isGV_with_GP(sv)) {
7903 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7909 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7911 return sv_2io(SvRV(sv));
7912 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7918 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7927 Using various gambits, try to get a CV from an SV; in addition, try if
7928 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7929 The flags in C<lref> are passed to sv_fetchsv.
7935 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7941 PERL_ARGS_ASSERT_SV_2CV;
7948 switch (SvTYPE(sv)) {
7952 return MUTABLE_CV(sv);
7959 if (isGV_with_GP(sv)) {
7969 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7971 tryAMAGICunDEREF(to_cv);
7974 if (SvTYPE(sv) == SVt_PVCV) {
7975 cv = MUTABLE_CV(sv);
7980 else if(isGV_with_GP(sv))
7983 Perl_croak(aTHX_ "Not a subroutine reference");
7985 else if (isGV_with_GP(sv)) {
7990 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7996 /* Some flags to gv_fetchsv mean don't really create the GV */
7997 if (!isGV_with_GP(gv)) {
8003 if (lref && !GvCVu(gv)) {
8007 gv_efullname3(tmpsv, gv, NULL);
8008 /* XXX this is probably not what they think they're getting.
8009 * It has the same effect as "sub name;", i.e. just a forward
8011 newSUB(start_subparse(FALSE, 0),
8012 newSVOP(OP_CONST, 0, tmpsv),
8016 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8017 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8026 Returns true if the SV has a true value by Perl's rules.
8027 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8028 instead use an in-line version.
8034 Perl_sv_true(pTHX_ register SV *const sv)
8039 register const XPV* const tXpv = (XPV*)SvANY(sv);
8041 (tXpv->xpv_cur > 1 ||
8042 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8049 return SvIVX(sv) != 0;
8052 return SvNVX(sv) != 0.0;
8054 return sv_2bool(sv);
8060 =for apidoc sv_pvn_force
8062 Get a sensible string out of the SV somehow.
8063 A private implementation of the C<SvPV_force> macro for compilers which
8064 can't cope with complex macro expressions. Always use the macro instead.
8066 =for apidoc sv_pvn_force_flags
8068 Get a sensible string out of the SV somehow.
8069 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8070 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8071 implemented in terms of this function.
8072 You normally want to use the various wrapper macros instead: see
8073 C<SvPV_force> and C<SvPV_force_nomg>
8079 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8083 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8085 if (SvTHINKFIRST(sv) && !SvROK(sv))
8086 sv_force_normal_flags(sv, 0);
8096 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8097 const char * const ref = sv_reftype(sv,0);
8099 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8100 ref, OP_NAME(PL_op));
8102 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8104 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8105 || isGV_with_GP(sv))
8106 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8108 s = sv_2pv_flags(sv, &len, flags);
8112 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8115 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8116 SvGROW(sv, len + 1);
8117 Move(s,SvPVX(sv),len,char);
8119 SvPVX(sv)[len] = '\0';
8122 SvPOK_on(sv); /* validate pointer */
8124 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8125 PTR2UV(sv),SvPVX_const(sv)));
8128 return SvPVX_mutable(sv);
8132 =for apidoc sv_pvbyten_force
8134 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8140 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8142 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8144 sv_pvn_force(sv,lp);
8145 sv_utf8_downgrade(sv,0);
8151 =for apidoc sv_pvutf8n_force
8153 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8159 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8161 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8163 sv_pvn_force(sv,lp);
8164 sv_utf8_upgrade(sv);
8170 =for apidoc sv_reftype
8172 Returns a string describing what the SV is a reference to.
8178 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8180 PERL_ARGS_ASSERT_SV_REFTYPE;
8182 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8183 inside return suggests a const propagation bug in g++. */
8184 if (ob && SvOBJECT(sv)) {
8185 char * const name = HvNAME_get(SvSTASH(sv));
8186 return name ? name : (char *) "__ANON__";
8189 switch (SvTYPE(sv)) {
8204 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8205 /* tied lvalues should appear to be
8206 * scalars for backwards compatitbility */
8207 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8208 ? "SCALAR" : "LVALUE");
8209 case SVt_PVAV: return "ARRAY";
8210 case SVt_PVHV: return "HASH";
8211 case SVt_PVCV: return "CODE";
8212 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8213 ? "GLOB" : "SCALAR");
8214 case SVt_PVFM: return "FORMAT";
8215 case SVt_PVIO: return "IO";
8216 case SVt_BIND: return "BIND";
8217 case SVt_REGEXP: return "REGEXP";
8218 default: return "UNKNOWN";
8224 =for apidoc sv_isobject
8226 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8227 object. If the SV is not an RV, or if the object is not blessed, then this
8234 Perl_sv_isobject(pTHX_ SV *sv)
8250 Returns a boolean indicating whether the SV is blessed into the specified
8251 class. This does not check for subtypes; use C<sv_derived_from> to verify
8252 an inheritance relationship.
8258 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8262 PERL_ARGS_ASSERT_SV_ISA;
8272 hvname = HvNAME_get(SvSTASH(sv));
8276 return strEQ(hvname, name);
8282 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8283 it will be upgraded to one. If C<classname> is non-null then the new SV will
8284 be blessed in the specified package. The new SV is returned and its
8285 reference count is 1.
8291 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8296 PERL_ARGS_ASSERT_NEWSVRV;
8300 SV_CHECK_THINKFIRST_COW_DROP(rv);
8301 (void)SvAMAGIC_off(rv);
8303 if (SvTYPE(rv) >= SVt_PVMG) {
8304 const U32 refcnt = SvREFCNT(rv);
8308 SvREFCNT(rv) = refcnt;
8310 sv_upgrade(rv, SVt_IV);
8311 } else if (SvROK(rv)) {
8312 SvREFCNT_dec(SvRV(rv));
8314 prepare_SV_for_RV(rv);
8322 HV* const stash = gv_stashpv(classname, GV_ADD);
8323 (void)sv_bless(rv, stash);
8329 =for apidoc sv_setref_pv
8331 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8332 argument will be upgraded to an RV. That RV will be modified to point to
8333 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8334 into the SV. The C<classname> argument indicates the package for the
8335 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8336 will have a reference count of 1, and the RV will be returned.
8338 Do not use with other Perl types such as HV, AV, SV, CV, because those
8339 objects will become corrupted by the pointer copy process.
8341 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8347 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8351 PERL_ARGS_ASSERT_SV_SETREF_PV;
8354 sv_setsv(rv, &PL_sv_undef);
8358 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8363 =for apidoc sv_setref_iv
8365 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8366 argument will be upgraded to an RV. That RV will be modified to point to
8367 the new SV. The C<classname> argument indicates the package for the
8368 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8369 will have a reference count of 1, and the RV will be returned.
8375 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8377 PERL_ARGS_ASSERT_SV_SETREF_IV;
8379 sv_setiv(newSVrv(rv,classname), iv);
8384 =for apidoc sv_setref_uv
8386 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8387 argument will be upgraded to an RV. That RV will be modified to point to
8388 the new SV. The C<classname> argument indicates the package for the
8389 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8390 will have a reference count of 1, and the RV will be returned.
8396 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8398 PERL_ARGS_ASSERT_SV_SETREF_UV;
8400 sv_setuv(newSVrv(rv,classname), uv);
8405 =for apidoc sv_setref_nv
8407 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8408 argument will be upgraded to an RV. That RV will be modified to point to
8409 the new SV. The C<classname> argument indicates the package for the
8410 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8411 will have a reference count of 1, and the RV will be returned.
8417 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8419 PERL_ARGS_ASSERT_SV_SETREF_NV;
8421 sv_setnv(newSVrv(rv,classname), nv);
8426 =for apidoc sv_setref_pvn
8428 Copies a string into a new SV, optionally blessing the SV. The length of the
8429 string must be specified with C<n>. The C<rv> argument will be upgraded to
8430 an RV. That RV will be modified to point to the new SV. The C<classname>
8431 argument indicates the package for the blessing. Set C<classname> to
8432 C<NULL> to avoid the blessing. The new SV will have a reference count
8433 of 1, and the RV will be returned.
8435 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8441 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8442 const char *const pv, const STRLEN n)
8444 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8446 sv_setpvn(newSVrv(rv,classname), pv, n);
8451 =for apidoc sv_bless
8453 Blesses an SV into a specified package. The SV must be an RV. The package
8454 must be designated by its stash (see C<gv_stashpv()>). The reference count
8455 of the SV is unaffected.
8461 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8466 PERL_ARGS_ASSERT_SV_BLESS;
8469 Perl_croak(aTHX_ "Can't bless non-reference value");
8471 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8472 if (SvIsCOW(tmpRef))
8473 sv_force_normal_flags(tmpRef, 0);
8474 if (SvREADONLY(tmpRef))
8475 Perl_croak(aTHX_ PL_no_modify);
8476 if (SvOBJECT(tmpRef)) {
8477 if (SvTYPE(tmpRef) != SVt_PVIO)
8479 SvREFCNT_dec(SvSTASH(tmpRef));
8482 SvOBJECT_on(tmpRef);
8483 if (SvTYPE(tmpRef) != SVt_PVIO)
8485 SvUPGRADE(tmpRef, SVt_PVMG);
8486 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
8491 (void)SvAMAGIC_off(sv);
8493 if(SvSMAGICAL(tmpRef))
8494 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8502 /* Downgrades a PVGV to a PVMG.
8506 S_sv_unglob(pTHX_ SV *const sv)
8511 SV * const temp = sv_newmortal();
8513 PERL_ARGS_ASSERT_SV_UNGLOB;
8515 assert(SvTYPE(sv) == SVt_PVGV);
8517 gv_efullname3(temp, (GV *) sv, "*");
8520 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8521 mro_method_changed_in(stash);
8525 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
8529 if (GvNAME_HEK(sv)) {
8530 unshare_hek(GvNAME_HEK(sv));
8532 isGV_with_GP_off(sv);
8534 /* need to keep SvANY(sv) in the right arena */
8535 xpvmg = new_XPVMG();
8536 StructCopy(SvANY(sv), xpvmg, XPVMG);
8537 del_XPVGV(SvANY(sv));
8540 SvFLAGS(sv) &= ~SVTYPEMASK;
8541 SvFLAGS(sv) |= SVt_PVMG;
8543 /* Intentionally not calling any local SET magic, as this isn't so much a
8544 set operation as merely an internal storage change. */
8545 sv_setsv_flags(sv, temp, 0);
8549 =for apidoc sv_unref_flags
8551 Unsets the RV status of the SV, and decrements the reference count of
8552 whatever was being referenced by the RV. This can almost be thought of
8553 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8554 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8555 (otherwise the decrementing is conditional on the reference count being
8556 different from one or the reference being a readonly SV).
8563 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8565 SV* const target = SvRV(ref);
8567 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8569 if (SvWEAKREF(ref)) {
8570 sv_del_backref(target, ref);
8572 SvRV_set(ref, NULL);
8575 SvRV_set(ref, NULL);
8577 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8578 assigned to as BEGIN {$a = \"Foo"} will fail. */
8579 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8580 SvREFCNT_dec(target);
8581 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8582 sv_2mortal(target); /* Schedule for freeing later */
8586 =for apidoc sv_untaint
8588 Untaint an SV. Use C<SvTAINTED_off> instead.
8593 Perl_sv_untaint(pTHX_ SV *const sv)
8595 PERL_ARGS_ASSERT_SV_UNTAINT;
8597 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8598 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8605 =for apidoc sv_tainted
8607 Test an SV for taintedness. Use C<SvTAINTED> instead.
8612 Perl_sv_tainted(pTHX_ SV *const sv)
8614 PERL_ARGS_ASSERT_SV_TAINTED;
8616 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8617 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8618 if (mg && (mg->mg_len & 1) )
8625 =for apidoc sv_setpviv
8627 Copies an integer into the given SV, also updating its string value.
8628 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8634 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8636 char buf[TYPE_CHARS(UV)];
8638 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8640 PERL_ARGS_ASSERT_SV_SETPVIV;
8642 sv_setpvn(sv, ptr, ebuf - ptr);
8646 =for apidoc sv_setpviv_mg
8648 Like C<sv_setpviv>, but also handles 'set' magic.
8654 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8656 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8662 #if defined(PERL_IMPLICIT_CONTEXT)
8664 /* pTHX_ magic can't cope with varargs, so this is a no-context
8665 * version of the main function, (which may itself be aliased to us).
8666 * Don't access this version directly.
8670 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8675 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8677 va_start(args, pat);
8678 sv_vsetpvf(sv, pat, &args);
8682 /* pTHX_ magic can't cope with varargs, so this is a no-context
8683 * version of the main function, (which may itself be aliased to us).
8684 * Don't access this version directly.
8688 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8693 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8695 va_start(args, pat);
8696 sv_vsetpvf_mg(sv, pat, &args);
8702 =for apidoc sv_setpvf
8704 Works like C<sv_catpvf> but copies the text into the SV instead of
8705 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8711 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8715 PERL_ARGS_ASSERT_SV_SETPVF;
8717 va_start(args, pat);
8718 sv_vsetpvf(sv, pat, &args);
8723 =for apidoc sv_vsetpvf
8725 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8726 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8728 Usually used via its frontend C<sv_setpvf>.
8734 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8736 PERL_ARGS_ASSERT_SV_VSETPVF;
8738 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8742 =for apidoc sv_setpvf_mg
8744 Like C<sv_setpvf>, but also handles 'set' magic.
8750 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8754 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8756 va_start(args, pat);
8757 sv_vsetpvf_mg(sv, pat, &args);
8762 =for apidoc sv_vsetpvf_mg
8764 Like C<sv_vsetpvf>, but also handles 'set' magic.
8766 Usually used via its frontend C<sv_setpvf_mg>.
8772 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8774 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8776 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8780 #if defined(PERL_IMPLICIT_CONTEXT)
8782 /* pTHX_ magic can't cope with varargs, so this is a no-context
8783 * version of the main function, (which may itself be aliased to us).
8784 * Don't access this version directly.
8788 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8793 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8795 va_start(args, pat);
8796 sv_vcatpvf(sv, pat, &args);
8800 /* pTHX_ magic can't cope with varargs, so this is a no-context
8801 * version of the main function, (which may itself be aliased to us).
8802 * Don't access this version directly.
8806 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8811 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8813 va_start(args, pat);
8814 sv_vcatpvf_mg(sv, pat, &args);
8820 =for apidoc sv_catpvf
8822 Processes its arguments like C<sprintf> and appends the formatted
8823 output to an SV. If the appended data contains "wide" characters
8824 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8825 and characters >255 formatted with %c), the original SV might get
8826 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8827 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8828 valid UTF-8; if the original SV was bytes, the pattern should be too.
8833 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8837 PERL_ARGS_ASSERT_SV_CATPVF;
8839 va_start(args, pat);
8840 sv_vcatpvf(sv, pat, &args);
8845 =for apidoc sv_vcatpvf
8847 Processes its arguments like C<vsprintf> and appends the formatted output
8848 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8850 Usually used via its frontend C<sv_catpvf>.
8856 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8858 PERL_ARGS_ASSERT_SV_VCATPVF;
8860 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8864 =for apidoc sv_catpvf_mg
8866 Like C<sv_catpvf>, but also handles 'set' magic.
8872 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8876 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8878 va_start(args, pat);
8879 sv_vcatpvf_mg(sv, pat, &args);
8884 =for apidoc sv_vcatpvf_mg
8886 Like C<sv_vcatpvf>, but also handles 'set' magic.
8888 Usually used via its frontend C<sv_catpvf_mg>.
8894 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8896 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8898 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8903 =for apidoc sv_vsetpvfn
8905 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8908 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8914 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8915 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8917 PERL_ARGS_ASSERT_SV_VSETPVFN;
8920 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8924 S_expect_number(pTHX_ char **const pattern)
8929 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8931 switch (**pattern) {
8932 case '1': case '2': case '3':
8933 case '4': case '5': case '6':
8934 case '7': case '8': case '9':
8935 var = *(*pattern)++ - '0';
8936 while (isDIGIT(**pattern)) {
8937 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8939 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8947 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8949 const int neg = nv < 0;
8952 PERL_ARGS_ASSERT_F0CONVERT;
8960 if (uv & 1 && uv == nv)
8961 uv--; /* Round to even */
8963 const unsigned dig = uv % 10;
8976 =for apidoc sv_vcatpvfn
8978 Processes its arguments like C<vsprintf> and appends the formatted output
8979 to an SV. Uses an array of SVs if the C style variable argument list is
8980 missing (NULL). When running with taint checks enabled, indicates via
8981 C<maybe_tainted> if results are untrustworthy (often due to the use of
8984 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8990 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8991 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8992 vec_utf8 = DO_UTF8(vecsv);
8994 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8997 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8998 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9006 static const char nullstr[] = "(null)";
9008 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9009 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9011 /* Times 4: a decimal digit takes more than 3 binary digits.
9012 * NV_DIG: mantissa takes than many decimal digits.
9013 * Plus 32: Playing safe. */
9014 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9015 /* large enough for "%#.#f" --chip */
9016 /* what about long double NVs? --jhi */
9018 PERL_ARGS_ASSERT_SV_VCATPVFN;
9019 PERL_UNUSED_ARG(maybe_tainted);
9021 /* no matter what, this is a string now */
9022 (void)SvPV_force(sv, origlen);
9024 /* special-case "", "%s", and "%-p" (SVf - see below) */
9027 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9029 const char * const s = va_arg(*args, char*);
9030 sv_catpv(sv, s ? s : nullstr);
9032 else if (svix < svmax) {
9033 sv_catsv(sv, *svargs);
9037 if (args && patlen == 3 && pat[0] == '%' &&
9038 pat[1] == '-' && pat[2] == 'p') {
9039 argsv = MUTABLE_SV(va_arg(*args, void*));
9040 sv_catsv(sv, argsv);
9044 #ifndef USE_LONG_DOUBLE
9045 /* special-case "%.<number>[gf]" */
9046 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9047 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9048 unsigned digits = 0;
9052 while (*pp >= '0' && *pp <= '9')
9053 digits = 10 * digits + (*pp++ - '0');
9054 if (pp - pat == (int)patlen - 1) {
9062 /* Add check for digits != 0 because it seems that some
9063 gconverts are buggy in this case, and we don't yet have
9064 a Configure test for this. */
9065 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9066 /* 0, point, slack */
9067 Gconvert(nv, (int)digits, 0, ebuf);
9069 if (*ebuf) /* May return an empty string for digits==0 */
9072 } else if (!digits) {
9075 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9076 sv_catpvn(sv, p, l);
9082 #endif /* !USE_LONG_DOUBLE */
9084 if (!args && svix < svmax && DO_UTF8(*svargs))
9087 patend = (char*)pat + patlen;
9088 for (p = (char*)pat; p < patend; p = q) {
9091 bool vectorize = FALSE;
9092 bool vectorarg = FALSE;
9093 bool vec_utf8 = FALSE;
9099 bool has_precis = FALSE;
9101 const I32 osvix = svix;
9102 bool is_utf8 = FALSE; /* is this item utf8? */
9103 #ifdef HAS_LDBL_SPRINTF_BUG
9104 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9105 with sfio - Allen <allens@cpan.org> */
9106 bool fix_ldbl_sprintf_bug = FALSE;
9110 U8 utf8buf[UTF8_MAXBYTES+1];
9111 STRLEN esignlen = 0;
9113 const char *eptr = NULL;
9116 const U8 *vecstr = NULL;
9123 /* we need a long double target in case HAS_LONG_DOUBLE but
9126 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9134 const char *dotstr = ".";
9135 STRLEN dotstrlen = 1;
9136 I32 efix = 0; /* explicit format parameter index */
9137 I32 ewix = 0; /* explicit width index */
9138 I32 epix = 0; /* explicit precision index */
9139 I32 evix = 0; /* explicit vector index */
9140 bool asterisk = FALSE;
9142 /* echo everything up to the next format specification */
9143 for (q = p; q < patend && *q != '%'; ++q) ;
9145 if (has_utf8 && !pat_utf8)
9146 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9148 sv_catpvn(sv, p, q - p);
9155 We allow format specification elements in this order:
9156 \d+\$ explicit format parameter index
9158 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9159 0 flag (as above): repeated to allow "v02"
9160 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9161 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9163 [%bcdefginopsuxDFOUX] format (mandatory)
9168 As of perl5.9.3, printf format checking is on by default.
9169 Internally, perl uses %p formats to provide an escape to
9170 some extended formatting. This block deals with those
9171 extensions: if it does not match, (char*)q is reset and
9172 the normal format processing code is used.
9174 Currently defined extensions are:
9175 %p include pointer address (standard)
9176 %-p (SVf) include an SV (previously %_)
9177 %-<num>p include an SV with precision <num>
9178 %<num>p reserved for future extensions
9180 Robin Barker 2005-07-14
9182 %1p (VDf) removed. RMB 2007-10-19
9189 n = expect_number(&q);
9196 argsv = MUTABLE_SV(va_arg(*args, void*));
9197 eptr = SvPV_const(argsv, elen);
9203 if (ckWARN_d(WARN_INTERNAL))
9204 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9205 "internal %%<num>p might conflict with future printf extensions");
9211 if ( (width = expect_number(&q)) ) {
9226 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9255 if ( (ewix = expect_number(&q)) )
9264 if ((vectorarg = asterisk)) {
9277 width = expect_number(&q);
9283 vecsv = va_arg(*args, SV*);
9285 vecsv = (evix > 0 && evix <= svmax)
9286 ? svargs[evix-1] : &PL_sv_undef;
9288 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9290 dotstr = SvPV_const(vecsv, dotstrlen);
9291 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9292 bad with tied or overloaded values that return UTF8. */
9295 else if (has_utf8) {
9296 vecsv = sv_mortalcopy(vecsv);
9297 sv_utf8_upgrade(vecsv);
9298 dotstr = SvPV_const(vecsv, dotstrlen);
9305 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9306 vecsv = svargs[efix ? efix-1 : svix++];
9307 vecstr = (U8*)SvPV_const(vecsv,veclen);
9308 vec_utf8 = DO_UTF8(vecsv);
9310 /* if this is a version object, we need to convert
9311 * back into v-string notation and then let the
9312 * vectorize happen normally
9314 if (sv_derived_from(vecsv, "version")) {
9315 char *version = savesvpv(vecsv);
9316 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
9317 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9318 "vector argument not supported with alpha versions");
9321 vecsv = sv_newmortal();
9322 scan_vstring(version, version + veclen, vecsv);
9323 vecstr = (U8*)SvPV_const(vecsv, veclen);
9324 vec_utf8 = DO_UTF8(vecsv);
9336 i = va_arg(*args, int);
9338 i = (ewix ? ewix <= svmax : svix < svmax) ?
9339 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9341 width = (i < 0) ? -i : i;
9351 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9353 /* XXX: todo, support specified precision parameter */
9357 i = va_arg(*args, int);
9359 i = (ewix ? ewix <= svmax : svix < svmax)
9360 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9362 has_precis = !(i < 0);
9367 precis = precis * 10 + (*q++ - '0');
9376 case 'I': /* Ix, I32x, and I64x */
9378 if (q[1] == '6' && q[2] == '4') {
9384 if (q[1] == '3' && q[2] == '2') {
9394 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9405 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9406 if (*(q + 1) == 'l') { /* lld, llf */
9432 if (!vectorize && !args) {
9434 const I32 i = efix-1;
9435 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9437 argsv = (svix >= 0 && svix < svmax)
9438 ? svargs[svix++] : &PL_sv_undef;
9449 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9451 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9453 eptr = (char*)utf8buf;
9454 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9468 eptr = va_arg(*args, char*);
9470 #ifdef MACOS_TRADITIONAL
9471 /* On MacOS, %#s format is used for Pascal strings */
9476 elen = strlen(eptr);
9478 eptr = (char *)nullstr;
9479 elen = sizeof nullstr - 1;
9483 eptr = SvPV_const(argsv, elen);
9484 if (DO_UTF8(argsv)) {
9485 I32 old_precis = precis;
9486 if (has_precis && precis < elen) {
9488 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9491 if (width) { /* fudge width (can't fudge elen) */
9492 if (has_precis && precis < elen)
9493 width += precis - old_precis;
9495 width += elen - sv_len_utf8(argsv);
9502 if (has_precis && elen > precis)
9509 if (alt || vectorize)
9511 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9532 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9541 esignbuf[esignlen++] = plus;
9545 case 'h': iv = (short)va_arg(*args, int); break;
9546 case 'l': iv = va_arg(*args, long); break;
9547 case 'V': iv = va_arg(*args, IV); break;
9548 default: iv = va_arg(*args, int); break;
9550 case 'q': iv = va_arg(*args, Quad_t); break;
9555 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9557 case 'h': iv = (short)tiv; break;
9558 case 'l': iv = (long)tiv; break;
9560 default: iv = tiv; break;
9562 case 'q': iv = (Quad_t)tiv; break;
9566 if ( !vectorize ) /* we already set uv above */
9571 esignbuf[esignlen++] = plus;
9575 esignbuf[esignlen++] = '-';
9619 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9630 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9631 case 'l': uv = va_arg(*args, unsigned long); break;
9632 case 'V': uv = va_arg(*args, UV); break;
9633 default: uv = va_arg(*args, unsigned); break;
9635 case 'q': uv = va_arg(*args, Uquad_t); break;
9640 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9642 case 'h': uv = (unsigned short)tuv; break;
9643 case 'l': uv = (unsigned long)tuv; break;
9645 default: uv = tuv; break;
9647 case 'q': uv = (Uquad_t)tuv; break;
9654 char *ptr = ebuf + sizeof ebuf;
9655 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9661 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9667 esignbuf[esignlen++] = '0';
9668 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9676 if (alt && *ptr != '0')
9685 esignbuf[esignlen++] = '0';
9686 esignbuf[esignlen++] = c;
9689 default: /* it had better be ten or less */
9693 } while (uv /= base);
9696 elen = (ebuf + sizeof ebuf) - ptr;
9700 zeros = precis - elen;
9701 else if (precis == 0 && elen == 1 && *eptr == '0'
9702 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9705 /* a precision nullifies the 0 flag. */
9712 /* FLOATING POINT */
9715 c = 'f'; /* maybe %F isn't supported here */
9723 /* This is evil, but floating point is even more evil */
9725 /* for SV-style calling, we can only get NV
9726 for C-style calling, we assume %f is double;
9727 for simplicity we allow any of %Lf, %llf, %qf for long double
9731 #if defined(USE_LONG_DOUBLE)
9735 /* [perl #20339] - we should accept and ignore %lf rather than die */
9739 #if defined(USE_LONG_DOUBLE)
9740 intsize = args ? 0 : 'q';
9744 #if defined(HAS_LONG_DOUBLE)
9753 /* now we need (long double) if intsize == 'q', else (double) */
9755 #if LONG_DOUBLESIZE > DOUBLESIZE
9757 va_arg(*args, long double) :
9758 va_arg(*args, double)
9760 va_arg(*args, double)
9765 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9766 else. frexp() has some unspecified behaviour for those three */
9767 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9769 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9770 will cast our (long double) to (double) */
9771 (void)Perl_frexp(nv, &i);
9772 if (i == PERL_INT_MIN)
9773 Perl_die(aTHX_ "panic: frexp");
9775 need = BIT_DIGITS(i);
9777 need += has_precis ? precis : 6; /* known default */
9782 #ifdef HAS_LDBL_SPRINTF_BUG
9783 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9784 with sfio - Allen <allens@cpan.org> */
9787 # define MY_DBL_MAX DBL_MAX
9788 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9789 # if DOUBLESIZE >= 8
9790 # define MY_DBL_MAX 1.7976931348623157E+308L
9792 # define MY_DBL_MAX 3.40282347E+38L
9796 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9797 # define MY_DBL_MAX_BUG 1L
9799 # define MY_DBL_MAX_BUG MY_DBL_MAX
9803 # define MY_DBL_MIN DBL_MIN
9804 # else /* XXX guessing! -Allen */
9805 # if DOUBLESIZE >= 8
9806 # define MY_DBL_MIN 2.2250738585072014E-308L
9808 # define MY_DBL_MIN 1.17549435E-38L
9812 if ((intsize == 'q') && (c == 'f') &&
9813 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9815 /* it's going to be short enough that
9816 * long double precision is not needed */
9818 if ((nv <= 0L) && (nv >= -0L))
9819 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9821 /* would use Perl_fp_class as a double-check but not
9822 * functional on IRIX - see perl.h comments */
9824 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9825 /* It's within the range that a double can represent */
9826 #if defined(DBL_MAX) && !defined(DBL_MIN)
9827 if ((nv >= ((long double)1/DBL_MAX)) ||
9828 (nv <= (-(long double)1/DBL_MAX)))
9830 fix_ldbl_sprintf_bug = TRUE;
9833 if (fix_ldbl_sprintf_bug == TRUE) {
9843 # undef MY_DBL_MAX_BUG
9846 #endif /* HAS_LDBL_SPRINTF_BUG */
9848 need += 20; /* fudge factor */
9849 if (PL_efloatsize < need) {
9850 Safefree(PL_efloatbuf);
9851 PL_efloatsize = need + 20; /* more fudge */
9852 Newx(PL_efloatbuf, PL_efloatsize, char);
9853 PL_efloatbuf[0] = '\0';
9856 if ( !(width || left || plus || alt) && fill != '0'
9857 && has_precis && intsize != 'q' ) { /* Shortcuts */
9858 /* See earlier comment about buggy Gconvert when digits,
9860 if ( c == 'g' && precis) {
9861 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9862 /* May return an empty string for digits==0 */
9863 if (*PL_efloatbuf) {
9864 elen = strlen(PL_efloatbuf);
9865 goto float_converted;
9867 } else if ( c == 'f' && !precis) {
9868 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9873 char *ptr = ebuf + sizeof ebuf;
9876 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9877 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9878 if (intsize == 'q') {
9879 /* Copy the one or more characters in a long double
9880 * format before the 'base' ([efgEFG]) character to
9881 * the format string. */
9882 static char const prifldbl[] = PERL_PRIfldbl;
9883 char const *p = prifldbl + sizeof(prifldbl) - 3;
9884 while (p >= prifldbl) { *--ptr = *p--; }
9889 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9894 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9906 /* No taint. Otherwise we are in the strange situation
9907 * where printf() taints but print($float) doesn't.
9909 #if defined(HAS_LONG_DOUBLE)
9910 elen = ((intsize == 'q')
9911 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9912 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9914 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9918 eptr = PL_efloatbuf;
9926 i = SvCUR(sv) - origlen;
9929 case 'h': *(va_arg(*args, short*)) = i; break;
9930 default: *(va_arg(*args, int*)) = i; break;
9931 case 'l': *(va_arg(*args, long*)) = i; break;
9932 case 'V': *(va_arg(*args, IV*)) = i; break;
9934 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9939 sv_setuv_mg(argsv, (UV)i);
9940 continue; /* not "break" */
9947 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9948 && ckWARN(WARN_PRINTF))
9950 SV * const msg = sv_newmortal();
9951 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9952 (PL_op->op_type == OP_PRTF) ? "" : "s");
9955 Perl_sv_catpvf(aTHX_ msg,
9956 "\"%%%c\"", c & 0xFF);
9958 Perl_sv_catpvf(aTHX_ msg,
9959 "\"%%\\%03"UVof"\"",
9962 sv_catpvs(msg, "end of string");
9963 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9966 /* output mangled stuff ... */
9972 /* ... right here, because formatting flags should not apply */
9973 SvGROW(sv, SvCUR(sv) + elen + 1);
9975 Copy(eptr, p, elen, char);
9978 SvCUR_set(sv, p - SvPVX_const(sv));
9980 continue; /* not "break" */
9983 if (is_utf8 != has_utf8) {
9986 sv_utf8_upgrade(sv);
9989 const STRLEN old_elen = elen;
9990 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9991 sv_utf8_upgrade(nsv);
9992 eptr = SvPVX_const(nsv);
9995 if (width) { /* fudge width (can't fudge elen) */
9996 width += elen - old_elen;
10002 have = esignlen + zeros + elen;
10004 Perl_croak_nocontext(PL_memory_wrap);
10006 need = (have > width ? have : width);
10009 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10010 Perl_croak_nocontext(PL_memory_wrap);
10011 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10013 if (esignlen && fill == '0') {
10015 for (i = 0; i < (int)esignlen; i++)
10016 *p++ = esignbuf[i];
10018 if (gap && !left) {
10019 memset(p, fill, gap);
10022 if (esignlen && fill != '0') {
10024 for (i = 0; i < (int)esignlen; i++)
10025 *p++ = esignbuf[i];
10029 for (i = zeros; i; i--)
10033 Copy(eptr, p, elen, char);
10037 memset(p, ' ', gap);
10042 Copy(dotstr, p, dotstrlen, char);
10046 vectorize = FALSE; /* done iterating over vecstr */
10053 SvCUR_set(sv, p - SvPVX_const(sv));
10061 /* =========================================================================
10063 =head1 Cloning an interpreter
10065 All the macros and functions in this section are for the private use of
10066 the main function, perl_clone().
10068 The foo_dup() functions make an exact copy of an existing foo thingy.
10069 During the course of a cloning, a hash table is used to map old addresses
10070 to new addresses. The table is created and manipulated with the
10071 ptr_table_* functions.
10075 ============================================================================*/
10078 #if defined(USE_ITHREADS)
10080 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10081 #ifndef GpREFCNT_inc
10082 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10086 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10087 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10088 If this changes, please unmerge ss_dup. */
10089 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10090 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10091 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
10092 #define av_dup_inc(s,t) MUTABLE_AV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10093 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
10094 #define hv_dup_inc(s,t) MUTABLE_HV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10095 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
10096 #define cv_dup_inc(s,t) MUTABLE_CV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10097 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
10098 #define io_dup_inc(s,t) MUTABLE_IO(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10099 #define gv_dup(s,t) (GV*)sv_dup((const SV *)s,t)
10100 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((const SV *)s,t))
10101 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10102 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10104 /* clone a parser */
10107 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10111 PERL_ARGS_ASSERT_PARSER_DUP;
10116 /* look for it in the table first */
10117 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10121 /* create anew and remember what it is */
10122 Newxz(parser, 1, yy_parser);
10123 ptr_table_store(PL_ptr_table, proto, parser);
10125 parser->yyerrstatus = 0;
10126 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10128 /* XXX these not yet duped */
10129 parser->old_parser = NULL;
10130 parser->stack = NULL;
10132 parser->stack_size = 0;
10133 /* XXX parser->stack->state = 0; */
10135 /* XXX eventually, just Copy() most of the parser struct ? */
10137 parser->lex_brackets = proto->lex_brackets;
10138 parser->lex_casemods = proto->lex_casemods;
10139 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10140 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10141 parser->lex_casestack = savepvn(proto->lex_casestack,
10142 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10143 parser->lex_defer = proto->lex_defer;
10144 parser->lex_dojoin = proto->lex_dojoin;
10145 parser->lex_expect = proto->lex_expect;
10146 parser->lex_formbrack = proto->lex_formbrack;
10147 parser->lex_inpat = proto->lex_inpat;
10148 parser->lex_inwhat = proto->lex_inwhat;
10149 parser->lex_op = proto->lex_op;
10150 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10151 parser->lex_starts = proto->lex_starts;
10152 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10153 parser->multi_close = proto->multi_close;
10154 parser->multi_open = proto->multi_open;
10155 parser->multi_start = proto->multi_start;
10156 parser->multi_end = proto->multi_end;
10157 parser->pending_ident = proto->pending_ident;
10158 parser->preambled = proto->preambled;
10159 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10160 parser->linestr = sv_dup_inc(proto->linestr, param);
10161 parser->expect = proto->expect;
10162 parser->copline = proto->copline;
10163 parser->last_lop_op = proto->last_lop_op;
10164 parser->lex_state = proto->lex_state;
10165 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10166 /* rsfp_filters entries have fake IoDIRP() */
10167 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10168 parser->in_my = proto->in_my;
10169 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10170 parser->error_count = proto->error_count;
10173 parser->linestr = sv_dup_inc(proto->linestr, param);
10176 char * const ols = SvPVX(proto->linestr);
10177 char * const ls = SvPVX(parser->linestr);
10179 parser->bufptr = ls + (proto->bufptr >= ols ?
10180 proto->bufptr - ols : 0);
10181 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10182 proto->oldbufptr - ols : 0);
10183 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10184 proto->oldoldbufptr - ols : 0);
10185 parser->linestart = ls + (proto->linestart >= ols ?
10186 proto->linestart - ols : 0);
10187 parser->last_uni = ls + (proto->last_uni >= ols ?
10188 proto->last_uni - ols : 0);
10189 parser->last_lop = ls + (proto->last_lop >= ols ?
10190 proto->last_lop - ols : 0);
10192 parser->bufend = ls + SvCUR(parser->linestr);
10195 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10199 parser->endwhite = proto->endwhite;
10200 parser->faketokens = proto->faketokens;
10201 parser->lasttoke = proto->lasttoke;
10202 parser->nextwhite = proto->nextwhite;
10203 parser->realtokenstart = proto->realtokenstart;
10204 parser->skipwhite = proto->skipwhite;
10205 parser->thisclose = proto->thisclose;
10206 parser->thismad = proto->thismad;
10207 parser->thisopen = proto->thisopen;
10208 parser->thisstuff = proto->thisstuff;
10209 parser->thistoken = proto->thistoken;
10210 parser->thiswhite = proto->thiswhite;
10212 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10213 parser->curforce = proto->curforce;
10215 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10216 Copy(proto->nexttype, parser->nexttype, 5, I32);
10217 parser->nexttoke = proto->nexttoke;
10223 /* duplicate a file handle */
10226 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10230 PERL_ARGS_ASSERT_FP_DUP;
10231 PERL_UNUSED_ARG(type);
10234 return (PerlIO*)NULL;
10236 /* look for it in the table first */
10237 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10241 /* create anew and remember what it is */
10242 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10243 ptr_table_store(PL_ptr_table, fp, ret);
10247 /* duplicate a directory handle */
10250 Perl_dirp_dup(pTHX_ DIR *const dp)
10252 PERL_UNUSED_CONTEXT;
10259 /* duplicate a typeglob */
10262 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10266 PERL_ARGS_ASSERT_GP_DUP;
10270 /* look for it in the table first */
10271 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10275 /* create anew and remember what it is */
10277 ptr_table_store(PL_ptr_table, gp, ret);
10280 ret->gp_refcnt = 0; /* must be before any other dups! */
10281 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10282 ret->gp_io = io_dup_inc(gp->gp_io, param);
10283 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10284 ret->gp_av = av_dup_inc(gp->gp_av, param);
10285 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10286 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10287 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10288 ret->gp_cvgen = gp->gp_cvgen;
10289 ret->gp_line = gp->gp_line;
10290 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10294 /* duplicate a chain of magic */
10297 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10299 MAGIC *mgprev = (MAGIC*)NULL;
10302 PERL_ARGS_ASSERT_MG_DUP;
10305 return (MAGIC*)NULL;
10306 /* look for it in the table first */
10307 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10311 for (; mg; mg = mg->mg_moremagic) {
10313 Newxz(nmg, 1, MAGIC);
10315 mgprev->mg_moremagic = nmg;
10318 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10319 nmg->mg_private = mg->mg_private;
10320 nmg->mg_type = mg->mg_type;
10321 nmg->mg_flags = mg->mg_flags;
10322 /* FIXME for plugins
10323 if (mg->mg_type == PERL_MAGIC_qr) {
10324 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)mg->mg_obj, param));
10328 if(mg->mg_type == PERL_MAGIC_backref) {
10329 /* The backref AV has its reference count deliberately bumped by
10332 = SvREFCNT_inc(av_dup_inc((const AV *) mg->mg_obj, param));
10335 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10336 ? sv_dup_inc(mg->mg_obj, param)
10337 : sv_dup(mg->mg_obj, param);
10339 nmg->mg_len = mg->mg_len;
10340 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10341 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10342 if (mg->mg_len > 0) {
10343 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10344 if (mg->mg_type == PERL_MAGIC_overload_table &&
10345 AMT_AMAGIC((AMT*)mg->mg_ptr))
10347 const AMT * const amtp = (AMT*)mg->mg_ptr;
10348 AMT * const namtp = (AMT*)nmg->mg_ptr;
10350 for (i = 1; i < NofAMmeth; i++) {
10351 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10355 else if (mg->mg_len == HEf_SVKEY)
10356 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)mg->mg_ptr, param);
10358 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10359 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10366 #endif /* USE_ITHREADS */
10368 /* create a new pointer-mapping table */
10371 Perl_ptr_table_new(pTHX)
10374 PERL_UNUSED_CONTEXT;
10376 Newxz(tbl, 1, PTR_TBL_t);
10377 tbl->tbl_max = 511;
10378 tbl->tbl_items = 0;
10379 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10383 #define PTR_TABLE_HASH(ptr) \
10384 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10387 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10388 following define) and at call to new_body_inline made below in
10389 Perl_ptr_table_store()
10392 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10394 /* map an existing pointer using a table */
10396 STATIC PTR_TBL_ENT_t *
10397 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10399 PTR_TBL_ENT_t *tblent;
10400 const UV hash = PTR_TABLE_HASH(sv);
10402 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10404 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10405 for (; tblent; tblent = tblent->next) {
10406 if (tblent->oldval == sv)
10413 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10415 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10417 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10418 PERL_UNUSED_CONTEXT;
10420 return tblent ? tblent->newval : NULL;
10423 /* add a new entry to a pointer-mapping table */
10426 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10428 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10430 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10431 PERL_UNUSED_CONTEXT;
10434 tblent->newval = newsv;
10436 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10438 new_body_inline(tblent, PTE_SVSLOT);
10440 tblent->oldval = oldsv;
10441 tblent->newval = newsv;
10442 tblent->next = tbl->tbl_ary[entry];
10443 tbl->tbl_ary[entry] = tblent;
10445 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10446 ptr_table_split(tbl);
10450 /* double the hash bucket size of an existing ptr table */
10453 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10455 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10456 const UV oldsize = tbl->tbl_max + 1;
10457 UV newsize = oldsize * 2;
10460 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10461 PERL_UNUSED_CONTEXT;
10463 Renew(ary, newsize, PTR_TBL_ENT_t*);
10464 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10465 tbl->tbl_max = --newsize;
10466 tbl->tbl_ary = ary;
10467 for (i=0; i < oldsize; i++, ary++) {
10468 PTR_TBL_ENT_t **curentp, **entp, *ent;
10471 curentp = ary + oldsize;
10472 for (entp = ary, ent = *ary; ent; ent = *entp) {
10473 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10475 ent->next = *curentp;
10485 /* remove all the entries from a ptr table */
10488 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10490 if (tbl && tbl->tbl_items) {
10491 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10492 UV riter = tbl->tbl_max;
10495 PTR_TBL_ENT_t *entry = array[riter];
10498 PTR_TBL_ENT_t * const oentry = entry;
10499 entry = entry->next;
10504 tbl->tbl_items = 0;
10508 /* clear and free a ptr table */
10511 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10516 ptr_table_clear(tbl);
10517 Safefree(tbl->tbl_ary);
10521 #if defined(USE_ITHREADS)
10524 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10526 PERL_ARGS_ASSERT_RVPV_DUP;
10529 SvRV_set(dstr, SvWEAKREF(sstr)
10530 ? sv_dup(SvRV(sstr), param)
10531 : sv_dup_inc(SvRV(sstr), param));
10534 else if (SvPVX_const(sstr)) {
10535 /* Has something there */
10537 /* Normal PV - clone whole allocated space */
10538 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10539 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10540 /* Not that normal - actually sstr is copy on write.
10541 But we are a true, independant SV, so: */
10542 SvREADONLY_off(dstr);
10547 /* Special case - not normally malloced for some reason */
10548 if (isGV_with_GP(sstr)) {
10549 /* Don't need to do anything here. */
10551 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10552 /* A "shared" PV - clone it as "shared" PV */
10554 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10558 /* Some other special case - random pointer */
10559 SvPV_set(dstr, SvPVX(sstr));
10564 /* Copy the NULL */
10565 SvPV_set(dstr, NULL);
10569 /* duplicate an SV of any type (including AV, HV etc) */
10572 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10577 PERL_ARGS_ASSERT_SV_DUP;
10581 if (SvTYPE(sstr) == SVTYPEMASK) {
10582 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10587 /* look for it in the table first */
10588 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
10592 if(param->flags & CLONEf_JOIN_IN) {
10593 /** We are joining here so we don't want do clone
10594 something that is bad **/
10595 if (SvTYPE(sstr) == SVt_PVHV) {
10596 const HEK * const hvname = HvNAME_HEK(sstr);
10598 /** don't clone stashes if they already exist **/
10599 return MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
10603 /* create anew and remember what it is */
10606 #ifdef DEBUG_LEAKING_SCALARS
10607 dstr->sv_debug_optype = sstr->sv_debug_optype;
10608 dstr->sv_debug_line = sstr->sv_debug_line;
10609 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10610 dstr->sv_debug_cloned = 1;
10611 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10614 ptr_table_store(PL_ptr_table, sstr, dstr);
10617 SvFLAGS(dstr) = SvFLAGS(sstr);
10618 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10619 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10622 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10623 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10624 (void*)PL_watch_pvx, SvPVX_const(sstr));
10627 /* don't clone objects whose class has asked us not to */
10628 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10633 switch (SvTYPE(sstr)) {
10635 SvANY(dstr) = NULL;
10638 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10640 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10642 SvIV_set(dstr, SvIVX(sstr));
10646 SvANY(dstr) = new_XNV();
10647 SvNV_set(dstr, SvNVX(sstr));
10649 /* case SVt_BIND: */
10652 /* These are all the types that need complex bodies allocating. */
10654 const svtype sv_type = SvTYPE(sstr);
10655 const struct body_details *const sv_type_details
10656 = bodies_by_type + sv_type;
10660 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10664 if (GvUNIQUE((GV*)sstr)) {
10665 NOOP; /* Do sharing here, and fall through */
10678 assert(sv_type_details->body_size);
10679 if (sv_type_details->arena) {
10680 new_body_inline(new_body, sv_type);
10682 = (void*)((char*)new_body - sv_type_details->offset);
10684 new_body = new_NOARENA(sv_type_details);
10688 SvANY(dstr) = new_body;
10691 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10692 ((char*)SvANY(dstr)) + sv_type_details->offset,
10693 sv_type_details->copy, char);
10695 Copy(((char*)SvANY(sstr)),
10696 ((char*)SvANY(dstr)),
10697 sv_type_details->body_size + sv_type_details->offset, char);
10700 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10701 && !isGV_with_GP(dstr))
10702 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10704 /* The Copy above means that all the source (unduplicated) pointers
10705 are now in the destination. We can check the flags and the
10706 pointers in either, but it's possible that there's less cache
10707 missing by always going for the destination.
10708 FIXME - instrument and check that assumption */
10709 if (sv_type >= SVt_PVMG) {
10710 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10711 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10712 } else if (SvMAGIC(dstr))
10713 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10715 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10718 /* The cast silences a GCC warning about unhandled types. */
10719 switch ((int)sv_type) {
10729 /* FIXME for plugins */
10730 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10733 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10734 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10735 LvTARG(dstr) = dstr;
10736 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10737 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
10739 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10741 if(isGV_with_GP(sstr)) {
10742 if (GvNAME_HEK(dstr))
10743 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10744 /* Don't call sv_add_backref here as it's going to be
10745 created as part of the magic cloning of the symbol
10747 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10748 at the point of this comment. */
10749 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10750 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10751 (void)GpREFCNT_inc(GvGP(dstr));
10753 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10756 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10757 if (IoOFP(dstr) == IoIFP(sstr))
10758 IoOFP(dstr) = IoIFP(dstr);
10760 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10761 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10762 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10763 /* I have no idea why fake dirp (rsfps)
10764 should be treated differently but otherwise
10765 we end up with leaks -- sky*/
10766 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10767 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10768 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10770 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10771 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10772 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10773 if (IoDIRP(dstr)) {
10774 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10777 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10780 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10781 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10782 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10785 if (AvARRAY((const AV *)sstr)) {
10786 SV **dst_ary, **src_ary;
10787 SSize_t items = AvFILLp((const AV *)sstr) + 1;
10789 src_ary = AvARRAY((const AV *)sstr);
10790 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
10791 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10792 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
10793 AvALLOC((const AV *)dstr) = dst_ary;
10794 if (AvREAL((const AV *)sstr)) {
10795 while (items-- > 0)
10796 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10799 while (items-- > 0)
10800 *dst_ary++ = sv_dup(*src_ary++, param);
10802 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
10803 while (items-- > 0) {
10804 *dst_ary++ = &PL_sv_undef;
10808 AvARRAY(MUTABLE_AV(dstr)) = NULL;
10809 AvALLOC((const AV *)dstr) = (SV**)NULL;
10813 if (HvARRAY((const HV *)sstr)) {
10815 const bool sharekeys = !!HvSHAREKEYS(sstr);
10816 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10817 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10819 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10820 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10822 HvARRAY(dstr) = (HE**)darray;
10823 while (i <= sxhv->xhv_max) {
10824 const HE * const source = HvARRAY(sstr)[i];
10825 HvARRAY(dstr)[i] = source
10826 ? he_dup(source, sharekeys, param) : 0;
10831 const struct xpvhv_aux * const saux = HvAUX(sstr);
10832 struct xpvhv_aux * const daux = HvAUX(dstr);
10833 /* This flag isn't copied. */
10834 /* SvOOK_on(hv) attacks the IV flags. */
10835 SvFLAGS(dstr) |= SVf_OOK;
10837 hvname = saux->xhv_name;
10838 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10840 daux->xhv_riter = saux->xhv_riter;
10841 daux->xhv_eiter = saux->xhv_eiter
10842 ? he_dup(saux->xhv_eiter,
10843 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10844 /* backref array needs refcnt=2; see sv_add_backref */
10845 daux->xhv_backreferences =
10846 saux->xhv_backreferences
10847 ? MUTABLE_AV(SvREFCNT_inc(
10848 sv_dup_inc((const SV *)saux->xhv_backreferences, param)))
10851 daux->xhv_mro_meta = saux->xhv_mro_meta
10852 ? mro_meta_dup(saux->xhv_mro_meta, param)
10855 /* Record stashes for possible cloning in Perl_clone(). */
10857 av_push(param->stashes, dstr);
10861 HvARRAY(MUTABLE_HV(dstr)) = NULL;
10864 if (!(param->flags & CLONEf_COPY_STACKS)) {
10868 /* NOTE: not refcounted */
10869 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10871 if (!CvISXSUB(dstr))
10872 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10874 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10875 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10876 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10877 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
10879 /* don't dup if copying back - CvGV isn't refcounted, so the
10880 * duped GV may never be freed. A bit of a hack! DAPM */
10881 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10882 NULL : gv_dup(CvGV(dstr), param) ;
10883 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10885 CvWEAKOUTSIDE(sstr)
10886 ? cv_dup( CvOUTSIDE(dstr), param)
10887 : cv_dup_inc(CvOUTSIDE(dstr), param);
10888 if (!CvISXSUB(dstr))
10889 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10895 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10901 /* duplicate a context */
10904 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10906 PERL_CONTEXT *ncxs;
10908 PERL_ARGS_ASSERT_CX_DUP;
10911 return (PERL_CONTEXT*)NULL;
10913 /* look for it in the table first */
10914 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10918 /* create anew and remember what it is */
10919 Newx(ncxs, max + 1, PERL_CONTEXT);
10920 ptr_table_store(PL_ptr_table, cxs, ncxs);
10921 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10924 PERL_CONTEXT * const ncx = &ncxs[ix];
10925 if (CxTYPE(ncx) == CXt_SUBST) {
10926 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10929 switch (CxTYPE(ncx)) {
10931 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10932 ? cv_dup_inc(ncx->blk_sub.cv, param)
10933 : cv_dup(ncx->blk_sub.cv,param));
10934 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10935 ? av_dup_inc(ncx->blk_sub.argarray,
10938 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10940 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10941 ncx->blk_sub.oldcomppad);
10944 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10946 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10948 case CXt_LOOP_LAZYSV:
10949 ncx->blk_loop.state_u.lazysv.end
10950 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10951 /* We are taking advantage of av_dup_inc and sv_dup_inc
10952 actually being the same function, and order equivalance of
10954 We can assert the later [but only at run time :-(] */
10955 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10956 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10958 ncx->blk_loop.state_u.ary.ary
10959 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10960 case CXt_LOOP_LAZYIV:
10961 case CXt_LOOP_PLAIN:
10962 if (CxPADLOOP(ncx)) {
10963 ncx->blk_loop.oldcomppad
10964 = (PAD*)ptr_table_fetch(PL_ptr_table,
10965 ncx->blk_loop.oldcomppad);
10967 ncx->blk_loop.oldcomppad
10968 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10972 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10973 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10974 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10987 /* duplicate a stack info structure */
10990 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10994 PERL_ARGS_ASSERT_SI_DUP;
10997 return (PERL_SI*)NULL;
10999 /* look for it in the table first */
11000 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11004 /* create anew and remember what it is */
11005 Newxz(nsi, 1, PERL_SI);
11006 ptr_table_store(PL_ptr_table, si, nsi);
11008 nsi->si_stack = av_dup_inc(si->si_stack, param);
11009 nsi->si_cxix = si->si_cxix;
11010 nsi->si_cxmax = si->si_cxmax;
11011 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11012 nsi->si_type = si->si_type;
11013 nsi->si_prev = si_dup(si->si_prev, param);
11014 nsi->si_next = si_dup(si->si_next, param);
11015 nsi->si_markoff = si->si_markoff;
11020 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11021 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11022 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11023 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11024 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11025 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11026 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11027 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11028 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11029 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11030 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11031 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11032 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11033 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11036 #define pv_dup_inc(p) SAVEPV(p)
11037 #define pv_dup(p) SAVEPV(p)
11038 #define svp_dup_inc(p,pp) any_dup(p,pp)
11040 /* map any object to the new equivent - either something in the
11041 * ptr table, or something in the interpreter structure
11045 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
11049 PERL_ARGS_ASSERT_ANY_DUP;
11052 return (void*)NULL;
11054 /* look for it in the table first */
11055 ret = ptr_table_fetch(PL_ptr_table, v);
11059 /* see if it is part of the interpreter structure */
11060 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11061 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11069 /* duplicate the save stack */
11072 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11075 ANY * const ss = proto_perl->Isavestack;
11076 const I32 max = proto_perl->Isavestack_max;
11077 I32 ix = proto_perl->Isavestack_ix;
11090 void (*dptr) (void*);
11091 void (*dxptr) (pTHX_ void*);
11093 PERL_ARGS_ASSERT_SS_DUP;
11095 Newxz(nss, max, ANY);
11098 const I32 type = POPINT(ss,ix);
11099 TOPINT(nss,ix) = type;
11101 case SAVEt_HELEM: /* hash element */
11102 sv = (const SV *)POPPTR(ss,ix);
11103 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11105 case SAVEt_ITEM: /* normal string */
11106 case SAVEt_SV: /* scalar reference */
11107 sv = (const SV *)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11111 case SAVEt_MORTALIZESV:
11112 sv = (const SV *)POPPTR(ss,ix);
11113 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11115 case SAVEt_SHARED_PVREF: /* char* in shared space */
11116 c = (char*)POPPTR(ss,ix);
11117 TOPPTR(nss,ix) = savesharedpv(c);
11118 ptr = POPPTR(ss,ix);
11119 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11121 case SAVEt_GENERIC_SVREF: /* generic sv */
11122 case SAVEt_SVREF: /* scalar reference */
11123 sv = (const SV *)POPPTR(ss,ix);
11124 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11125 ptr = POPPTR(ss,ix);
11126 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11128 case SAVEt_HV: /* hash reference */
11129 case SAVEt_AV: /* array reference */
11130 sv = (const SV *) POPPTR(ss,ix);
11131 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11133 case SAVEt_COMPPAD:
11135 sv = (const SV *) POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = sv_dup(sv, param);
11138 case SAVEt_INT: /* int reference */
11139 ptr = POPPTR(ss,ix);
11140 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11141 intval = (int)POPINT(ss,ix);
11142 TOPINT(nss,ix) = intval;
11144 case SAVEt_LONG: /* long reference */
11145 ptr = POPPTR(ss,ix);
11146 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11148 case SAVEt_CLEARSV:
11149 longval = (long)POPLONG(ss,ix);
11150 TOPLONG(nss,ix) = longval;
11152 case SAVEt_I32: /* I32 reference */
11153 case SAVEt_I16: /* I16 reference */
11154 case SAVEt_I8: /* I8 reference */
11155 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11156 ptr = POPPTR(ss,ix);
11157 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11159 TOPINT(nss,ix) = i;
11161 case SAVEt_IV: /* IV reference */
11162 ptr = POPPTR(ss,ix);
11163 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11165 TOPIV(nss,ix) = iv;
11167 case SAVEt_HPTR: /* HV* reference */
11168 case SAVEt_APTR: /* AV* reference */
11169 case SAVEt_SPTR: /* SV* reference */
11170 ptr = POPPTR(ss,ix);
11171 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11172 sv = (const SV *)POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = sv_dup(sv, param);
11175 case SAVEt_VPTR: /* random* reference */
11176 ptr = POPPTR(ss,ix);
11177 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11178 ptr = POPPTR(ss,ix);
11179 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11181 case SAVEt_GENERIC_PVREF: /* generic char* */
11182 case SAVEt_PPTR: /* char* reference */
11183 ptr = POPPTR(ss,ix);
11184 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11185 c = (char*)POPPTR(ss,ix);
11186 TOPPTR(nss,ix) = pv_dup(c);
11188 case SAVEt_GP: /* scalar reference */
11189 gp = (GP*)POPPTR(ss,ix);
11190 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11191 (void)GpREFCNT_inc(gp);
11192 gv = (GV*)POPPTR(ss,ix);
11193 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11196 ptr = POPPTR(ss,ix);
11197 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11198 /* these are assumed to be refcounted properly */
11200 switch (((OP*)ptr)->op_type) {
11202 case OP_LEAVESUBLV:
11206 case OP_LEAVEWRITE:
11207 TOPPTR(nss,ix) = ptr;
11210 (void) OpREFCNT_inc(o);
11214 TOPPTR(nss,ix) = NULL;
11219 TOPPTR(nss,ix) = NULL;
11222 c = (char*)POPPTR(ss,ix);
11223 TOPPTR(nss,ix) = pv_dup_inc(c);
11226 hv = (const HV *)POPPTR(ss,ix);
11227 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11228 c = (char*)POPPTR(ss,ix);
11229 TOPPTR(nss,ix) = pv_dup_inc(c);
11231 case SAVEt_STACK_POS: /* Position on Perl stack */
11233 TOPINT(nss,ix) = i;
11235 case SAVEt_DESTRUCTOR:
11236 ptr = POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11238 dptr = POPDPTR(ss,ix);
11239 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11240 any_dup(FPTR2DPTR(void *, dptr),
11243 case SAVEt_DESTRUCTOR_X:
11244 ptr = POPPTR(ss,ix);
11245 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11246 dxptr = POPDXPTR(ss,ix);
11247 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11248 any_dup(FPTR2DPTR(void *, dxptr),
11251 case SAVEt_REGCONTEXT:
11254 TOPINT(nss,ix) = i;
11257 case SAVEt_AELEM: /* array element */
11258 sv = (const SV *)POPPTR(ss,ix);
11259 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11261 TOPINT(nss,ix) = i;
11262 av = (const AV *)POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = av_dup_inc(av, param);
11266 ptr = POPPTR(ss,ix);
11267 TOPPTR(nss,ix) = ptr;
11271 TOPINT(nss,ix) = i;
11272 ptr = POPPTR(ss,ix);
11275 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11276 HINTS_REFCNT_UNLOCK;
11278 TOPPTR(nss,ix) = ptr;
11279 if (i & HINT_LOCALIZE_HH) {
11280 hv = (const HV *)POPPTR(ss,ix);
11281 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11284 case SAVEt_PADSV_AND_MORTALIZE:
11285 longval = (long)POPLONG(ss,ix);
11286 TOPLONG(nss,ix) = longval;
11287 ptr = POPPTR(ss,ix);
11288 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11289 sv = (const SV *)POPPTR(ss,ix);
11290 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11293 ptr = POPPTR(ss,ix);
11294 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11295 longval = (long)POPBOOL(ss,ix);
11296 TOPBOOL(nss,ix) = (bool)longval;
11298 case SAVEt_SET_SVFLAGS:
11300 TOPINT(nss,ix) = i;
11302 TOPINT(nss,ix) = i;
11303 sv = (const SV *)POPPTR(ss,ix);
11304 TOPPTR(nss,ix) = sv_dup(sv, param);
11306 case SAVEt_RE_STATE:
11308 const struct re_save_state *const old_state
11309 = (struct re_save_state *)
11310 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11311 struct re_save_state *const new_state
11312 = (struct re_save_state *)
11313 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11315 Copy(old_state, new_state, 1, struct re_save_state);
11316 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11318 new_state->re_state_bostr
11319 = pv_dup(old_state->re_state_bostr);
11320 new_state->re_state_reginput
11321 = pv_dup(old_state->re_state_reginput);
11322 new_state->re_state_regeol
11323 = pv_dup(old_state->re_state_regeol);
11324 new_state->re_state_regoffs
11325 = (regexp_paren_pair*)
11326 any_dup(old_state->re_state_regoffs, proto_perl);
11327 new_state->re_state_reglastparen
11328 = (U32*) any_dup(old_state->re_state_reglastparen,
11330 new_state->re_state_reglastcloseparen
11331 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11333 /* XXX This just has to be broken. The old save_re_context
11334 code did SAVEGENERICPV(PL_reg_start_tmp);
11335 PL_reg_start_tmp is char **.
11336 Look above to what the dup code does for
11337 SAVEt_GENERIC_PVREF
11338 It can never have worked.
11339 So this is merely a faithful copy of the exiting bug: */
11340 new_state->re_state_reg_start_tmp
11341 = (char **) pv_dup((char *)
11342 old_state->re_state_reg_start_tmp);
11343 /* I assume that it only ever "worked" because no-one called
11344 (pseudo)fork while the regexp engine had re-entered itself.
11346 #ifdef PERL_OLD_COPY_ON_WRITE
11347 new_state->re_state_nrs
11348 = sv_dup(old_state->re_state_nrs, param);
11350 new_state->re_state_reg_magic
11351 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11353 new_state->re_state_reg_oldcurpm
11354 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11356 new_state->re_state_reg_curpm
11357 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11359 new_state->re_state_reg_oldsaved
11360 = pv_dup(old_state->re_state_reg_oldsaved);
11361 new_state->re_state_reg_poscache
11362 = pv_dup(old_state->re_state_reg_poscache);
11363 new_state->re_state_reg_starttry
11364 = pv_dup(old_state->re_state_reg_starttry);
11367 case SAVEt_COMPILE_WARNINGS:
11368 ptr = POPPTR(ss,ix);
11369 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11372 ptr = POPPTR(ss,ix);
11373 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11377 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11385 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11386 * flag to the result. This is done for each stash before cloning starts,
11387 * so we know which stashes want their objects cloned */
11390 do_mark_cloneable_stash(pTHX_ SV *const sv)
11392 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
11394 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
11395 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11396 if (cloner && GvCV(cloner)) {
11403 mXPUSHs(newSVhek(hvname));
11405 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
11412 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11420 =for apidoc perl_clone
11422 Create and return a new interpreter by cloning the current one.
11424 perl_clone takes these flags as parameters:
11426 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11427 without it we only clone the data and zero the stacks,
11428 with it we copy the stacks and the new perl interpreter is
11429 ready to run at the exact same point as the previous one.
11430 The pseudo-fork code uses COPY_STACKS while the
11431 threads->create doesn't.
11433 CLONEf_KEEP_PTR_TABLE
11434 perl_clone keeps a ptr_table with the pointer of the old
11435 variable as a key and the new variable as a value,
11436 this allows it to check if something has been cloned and not
11437 clone it again but rather just use the value and increase the
11438 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11439 the ptr_table using the function
11440 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11441 reason to keep it around is if you want to dup some of your own
11442 variable who are outside the graph perl scans, example of this
11443 code is in threads.xs create
11446 This is a win32 thing, it is ignored on unix, it tells perls
11447 win32host code (which is c++) to clone itself, this is needed on
11448 win32 if you want to run two threads at the same time,
11449 if you just want to do some stuff in a separate perl interpreter
11450 and then throw it away and return to the original one,
11451 you don't need to do anything.
11456 /* XXX the above needs expanding by someone who actually understands it ! */
11457 EXTERN_C PerlInterpreter *
11458 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11461 perl_clone(PerlInterpreter *proto_perl, UV flags)
11464 #ifdef PERL_IMPLICIT_SYS
11466 PERL_ARGS_ASSERT_PERL_CLONE;
11468 /* perlhost.h so we need to call into it
11469 to clone the host, CPerlHost should have a c interface, sky */
11471 if (flags & CLONEf_CLONE_HOST) {
11472 return perl_clone_host(proto_perl,flags);
11474 return perl_clone_using(proto_perl, flags,
11476 proto_perl->IMemShared,
11477 proto_perl->IMemParse,
11479 proto_perl->IStdIO,
11483 proto_perl->IProc);
11487 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11488 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11489 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11490 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11491 struct IPerlDir* ipD, struct IPerlSock* ipS,
11492 struct IPerlProc* ipP)
11494 /* XXX many of the string copies here can be optimized if they're
11495 * constants; they need to be allocated as common memory and just
11496 * their pointers copied. */
11499 CLONE_PARAMS clone_params;
11500 CLONE_PARAMS* const param = &clone_params;
11502 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11504 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11506 /* for each stash, determine whether its objects should be cloned */
11507 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11508 PERL_SET_THX(my_perl);
11511 PoisonNew(my_perl, 1, PerlInterpreter);
11517 PL_savestack_ix = 0;
11518 PL_savestack_max = -1;
11519 PL_sig_pending = 0;
11521 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11522 # else /* !DEBUGGING */
11523 Zero(my_perl, 1, PerlInterpreter);
11524 # endif /* DEBUGGING */
11526 /* host pointers */
11528 PL_MemShared = ipMS;
11529 PL_MemParse = ipMP;
11536 #else /* !PERL_IMPLICIT_SYS */
11538 CLONE_PARAMS clone_params;
11539 CLONE_PARAMS* param = &clone_params;
11540 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11542 PERL_ARGS_ASSERT_PERL_CLONE;
11544 /* for each stash, determine whether its objects should be cloned */
11545 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11546 PERL_SET_THX(my_perl);
11549 PoisonNew(my_perl, 1, PerlInterpreter);
11555 PL_savestack_ix = 0;
11556 PL_savestack_max = -1;
11557 PL_sig_pending = 0;
11559 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11560 # else /* !DEBUGGING */
11561 Zero(my_perl, 1, PerlInterpreter);
11562 # endif /* DEBUGGING */
11563 #endif /* PERL_IMPLICIT_SYS */
11564 param->flags = flags;
11565 param->proto_perl = proto_perl;
11567 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11569 PL_body_arenas = NULL;
11570 Zero(&PL_body_roots, 1, PL_body_roots);
11572 PL_nice_chunk = NULL;
11573 PL_nice_chunk_size = 0;
11575 PL_sv_objcount = 0;
11577 PL_sv_arenaroot = NULL;
11579 PL_debug = proto_perl->Idebug;
11581 PL_hash_seed = proto_perl->Ihash_seed;
11582 PL_rehash_seed = proto_perl->Irehash_seed;
11584 #ifdef USE_REENTRANT_API
11585 /* XXX: things like -Dm will segfault here in perlio, but doing
11586 * PERL_SET_CONTEXT(proto_perl);
11587 * breaks too many other things
11589 Perl_reentrant_init(aTHX);
11592 /* create SV map for pointer relocation */
11593 PL_ptr_table = ptr_table_new();
11595 /* initialize these special pointers as early as possible */
11596 SvANY(&PL_sv_undef) = NULL;
11597 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11598 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11599 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11601 SvANY(&PL_sv_no) = new_XPVNV();
11602 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11603 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11604 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11605 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11606 SvCUR_set(&PL_sv_no, 0);
11607 SvLEN_set(&PL_sv_no, 1);
11608 SvIV_set(&PL_sv_no, 0);
11609 SvNV_set(&PL_sv_no, 0);
11610 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11612 SvANY(&PL_sv_yes) = new_XPVNV();
11613 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11614 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11615 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11616 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11617 SvCUR_set(&PL_sv_yes, 1);
11618 SvLEN_set(&PL_sv_yes, 2);
11619 SvIV_set(&PL_sv_yes, 1);
11620 SvNV_set(&PL_sv_yes, 1);
11621 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11623 /* create (a non-shared!) shared string table */
11624 PL_strtab = newHV();
11625 HvSHAREKEYS_off(PL_strtab);
11626 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11627 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11629 PL_compiling = proto_perl->Icompiling;
11631 /* These two PVs will be free'd special way so must set them same way op.c does */
11632 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11633 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11635 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11636 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11638 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11639 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11640 if (PL_compiling.cop_hints_hash) {
11642 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11643 HINTS_REFCNT_UNLOCK;
11645 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11646 #ifdef PERL_DEBUG_READONLY_OPS
11651 /* pseudo environmental stuff */
11652 PL_origargc = proto_perl->Iorigargc;
11653 PL_origargv = proto_perl->Iorigargv;
11655 param->stashes = newAV(); /* Setup array of objects to call clone on */
11657 /* Set tainting stuff before PerlIO_debug can possibly get called */
11658 PL_tainting = proto_perl->Itainting;
11659 PL_taint_warn = proto_perl->Itaint_warn;
11661 #ifdef PERLIO_LAYERS
11662 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11663 PerlIO_clone(aTHX_ proto_perl, param);
11666 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11667 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11668 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11669 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11670 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11671 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11674 PL_minus_c = proto_perl->Iminus_c;
11675 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11676 PL_localpatches = proto_perl->Ilocalpatches;
11677 PL_splitstr = proto_perl->Isplitstr;
11678 PL_minus_n = proto_perl->Iminus_n;
11679 PL_minus_p = proto_perl->Iminus_p;
11680 PL_minus_l = proto_perl->Iminus_l;
11681 PL_minus_a = proto_perl->Iminus_a;
11682 PL_minus_E = proto_perl->Iminus_E;
11683 PL_minus_F = proto_perl->Iminus_F;
11684 PL_doswitches = proto_perl->Idoswitches;
11685 PL_dowarn = proto_perl->Idowarn;
11686 PL_doextract = proto_perl->Idoextract;
11687 PL_sawampersand = proto_perl->Isawampersand;
11688 PL_unsafe = proto_perl->Iunsafe;
11689 PL_inplace = SAVEPV(proto_perl->Iinplace);
11690 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11691 PL_perldb = proto_perl->Iperldb;
11692 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11693 PL_exit_flags = proto_perl->Iexit_flags;
11695 /* magical thingies */
11696 /* XXX time(&PL_basetime) when asked for? */
11697 PL_basetime = proto_perl->Ibasetime;
11698 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11700 PL_maxsysfd = proto_perl->Imaxsysfd;
11701 PL_statusvalue = proto_perl->Istatusvalue;
11703 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11705 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11707 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11709 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
11710 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
11711 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
11714 /* RE engine related */
11715 Zero(&PL_reg_state, 1, struct re_save_state);
11716 PL_reginterp_cnt = 0;
11717 PL_regmatch_slab = NULL;
11719 /* Clone the regex array */
11720 /* ORANGE FIXME for plugins, probably in the SV dup code.
11721 newSViv(PTR2IV(CALLREGDUPE(
11722 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11724 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11725 PL_regex_pad = AvARRAY(PL_regex_padav);
11727 /* shortcuts to various I/O objects */
11728 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11729 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11730 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11731 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11732 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11733 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11735 /* shortcuts to regexp stuff */
11736 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11738 /* shortcuts to misc objects */
11739 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11741 /* shortcuts to debugging objects */
11742 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11743 PL_DBline = gv_dup(proto_perl->IDBline, param);
11744 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11745 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11746 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11747 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11748 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11750 /* symbol tables */
11751 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11752 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11753 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11754 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11755 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11757 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11758 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11759 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11760 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11761 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11762 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11763 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11764 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11766 PL_sub_generation = proto_perl->Isub_generation;
11767 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11769 /* funky return mechanisms */
11770 PL_forkprocess = proto_perl->Iforkprocess;
11772 /* subprocess state */
11773 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11775 /* internal state */
11776 PL_maxo = proto_perl->Imaxo;
11777 if (proto_perl->Iop_mask)
11778 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11781 /* PL_asserting = proto_perl->Iasserting; */
11783 /* current interpreter roots */
11784 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11786 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11788 PL_main_start = proto_perl->Imain_start;
11789 PL_eval_root = proto_perl->Ieval_root;
11790 PL_eval_start = proto_perl->Ieval_start;
11792 /* runtime control stuff */
11793 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11795 PL_filemode = proto_perl->Ifilemode;
11796 PL_lastfd = proto_perl->Ilastfd;
11797 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11800 PL_gensym = proto_perl->Igensym;
11801 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11802 PL_laststatval = proto_perl->Ilaststatval;
11803 PL_laststype = proto_perl->Ilaststype;
11806 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11808 /* interpreter atexit processing */
11809 PL_exitlistlen = proto_perl->Iexitlistlen;
11810 if (PL_exitlistlen) {
11811 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11812 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11815 PL_exitlist = (PerlExitListEntry*)NULL;
11817 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11818 if (PL_my_cxt_size) {
11819 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11820 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11821 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11822 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11823 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11827 PL_my_cxt_list = (void**)NULL;
11828 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11829 PL_my_cxt_keys = (const char**)NULL;
11832 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11833 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11834 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11836 PL_profiledata = NULL;
11838 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11840 PAD_CLONE_VARS(proto_perl, param);
11842 #ifdef HAVE_INTERP_INTERN
11843 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11846 /* more statics moved here */
11847 PL_generation = proto_perl->Igeneration;
11848 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11850 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11851 PL_in_clean_all = proto_perl->Iin_clean_all;
11853 PL_uid = proto_perl->Iuid;
11854 PL_euid = proto_perl->Ieuid;
11855 PL_gid = proto_perl->Igid;
11856 PL_egid = proto_perl->Iegid;
11857 PL_nomemok = proto_perl->Inomemok;
11858 PL_an = proto_perl->Ian;
11859 PL_evalseq = proto_perl->Ievalseq;
11860 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11861 PL_origalen = proto_perl->Iorigalen;
11862 #ifdef PERL_USES_PL_PIDSTATUS
11863 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11865 PL_osname = SAVEPV(proto_perl->Iosname);
11866 PL_sighandlerp = proto_perl->Isighandlerp;
11868 PL_runops = proto_perl->Irunops;
11870 PL_parser = parser_dup(proto_perl->Iparser, param);
11872 PL_subline = proto_perl->Isubline;
11873 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11876 PL_cryptseen = proto_perl->Icryptseen;
11879 PL_hints = proto_perl->Ihints;
11881 PL_amagic_generation = proto_perl->Iamagic_generation;
11883 #ifdef USE_LOCALE_COLLATE
11884 PL_collation_ix = proto_perl->Icollation_ix;
11885 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11886 PL_collation_standard = proto_perl->Icollation_standard;
11887 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11888 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11889 #endif /* USE_LOCALE_COLLATE */
11891 #ifdef USE_LOCALE_NUMERIC
11892 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11893 PL_numeric_standard = proto_perl->Inumeric_standard;
11894 PL_numeric_local = proto_perl->Inumeric_local;
11895 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11896 #endif /* !USE_LOCALE_NUMERIC */
11898 /* utf8 character classes */
11899 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11900 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11901 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11902 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11903 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11904 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11905 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11906 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11907 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11908 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11909 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11910 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11911 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11912 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11913 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11914 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11915 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11916 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11917 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11918 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11920 /* Did the locale setup indicate UTF-8? */
11921 PL_utf8locale = proto_perl->Iutf8locale;
11922 /* Unicode features (see perlrun/-C) */
11923 PL_unicode = proto_perl->Iunicode;
11925 /* Pre-5.8 signals control */
11926 PL_signals = proto_perl->Isignals;
11928 /* times() ticks per second */
11929 PL_clocktick = proto_perl->Iclocktick;
11931 /* Recursion stopper for PerlIO_find_layer */
11932 PL_in_load_module = proto_perl->Iin_load_module;
11934 /* sort() routine */
11935 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11937 /* Not really needed/useful since the reenrant_retint is "volatile",
11938 * but do it for consistency's sake. */
11939 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11941 /* Hooks to shared SVs and locks. */
11942 PL_sharehook = proto_perl->Isharehook;
11943 PL_lockhook = proto_perl->Ilockhook;
11944 PL_unlockhook = proto_perl->Iunlockhook;
11945 PL_threadhook = proto_perl->Ithreadhook;
11946 PL_destroyhook = proto_perl->Idestroyhook;
11948 #ifdef THREADS_HAVE_PIDS
11949 PL_ppid = proto_perl->Ippid;
11953 PL_last_swash_hv = NULL; /* reinits on demand */
11954 PL_last_swash_klen = 0;
11955 PL_last_swash_key[0]= '\0';
11956 PL_last_swash_tmps = (U8*)NULL;
11957 PL_last_swash_slen = 0;
11959 PL_glob_index = proto_perl->Iglob_index;
11960 PL_srand_called = proto_perl->Isrand_called;
11961 PL_bitcount = NULL; /* reinits on demand */
11963 if (proto_perl->Ipsig_pend) {
11964 Newxz(PL_psig_pend, SIG_SIZE, int);
11967 PL_psig_pend = (int*)NULL;
11970 if (proto_perl->Ipsig_ptr) {
11971 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11972 Newxz(PL_psig_name, SIG_SIZE, SV*);
11973 for (i = 1; i < SIG_SIZE; i++) {
11974 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11975 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11979 PL_psig_ptr = (SV**)NULL;
11980 PL_psig_name = (SV**)NULL;
11983 /* intrpvar.h stuff */
11985 if (flags & CLONEf_COPY_STACKS) {
11986 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11987 PL_tmps_ix = proto_perl->Itmps_ix;
11988 PL_tmps_max = proto_perl->Itmps_max;
11989 PL_tmps_floor = proto_perl->Itmps_floor;
11990 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11992 while (i <= PL_tmps_ix) {
11993 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11997 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11998 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11999 Newxz(PL_markstack, i, I32);
12000 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
12001 - proto_perl->Imarkstack);
12002 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
12003 - proto_perl->Imarkstack);
12004 Copy(proto_perl->Imarkstack, PL_markstack,
12005 PL_markstack_ptr - PL_markstack + 1, I32);
12007 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12008 * NOTE: unlike the others! */
12009 PL_scopestack_ix = proto_perl->Iscopestack_ix;
12010 PL_scopestack_max = proto_perl->Iscopestack_max;
12011 Newxz(PL_scopestack, PL_scopestack_max, I32);
12012 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
12014 /* NOTE: si_dup() looks at PL_markstack */
12015 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
12017 /* PL_curstack = PL_curstackinfo->si_stack; */
12018 PL_curstack = av_dup(proto_perl->Icurstack, param);
12019 PL_mainstack = av_dup(proto_perl->Imainstack, param);
12021 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12022 PL_stack_base = AvARRAY(PL_curstack);
12023 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
12024 - proto_perl->Istack_base);
12025 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12027 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12028 * NOTE: unlike the others! */
12029 PL_savestack_ix = proto_perl->Isavestack_ix;
12030 PL_savestack_max = proto_perl->Isavestack_max;
12031 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
12032 PL_savestack = ss_dup(proto_perl, param);
12036 ENTER; /* perl_destruct() wants to LEAVE; */
12038 /* although we're not duplicating the tmps stack, we should still
12039 * add entries for any SVs on the tmps stack that got cloned by a
12040 * non-refcount means (eg a temp in @_); otherwise they will be
12043 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
12044 SV * const nsv = MUTABLE_SV(ptr_table_fetch(PL_ptr_table,
12045 proto_perl->Itmps_stack[i]));
12046 if (nsv && !SvREFCNT(nsv)) {
12048 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
12053 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
12054 PL_top_env = &PL_start_env;
12056 PL_op = proto_perl->Iop;
12059 PL_Xpv = (XPV*)NULL;
12060 my_perl->Ina = proto_perl->Ina;
12062 PL_statbuf = proto_perl->Istatbuf;
12063 PL_statcache = proto_perl->Istatcache;
12064 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12065 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12067 PL_timesbuf = proto_perl->Itimesbuf;
12070 PL_tainted = proto_perl->Itainted;
12071 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12072 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12073 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12074 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
12075 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12076 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12077 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12078 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12079 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12081 PL_restartop = proto_perl->Irestartop;
12082 PL_in_eval = proto_perl->Iin_eval;
12083 PL_delaymagic = proto_perl->Idelaymagic;
12084 PL_dirty = proto_perl->Idirty;
12085 PL_localizing = proto_perl->Ilocalizing;
12087 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12088 PL_hv_fetch_ent_mh = NULL;
12089 PL_modcount = proto_perl->Imodcount;
12090 PL_lastgotoprobe = NULL;
12091 PL_dumpindent = proto_perl->Idumpindent;
12093 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12094 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12095 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12096 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12097 PL_efloatbuf = NULL; /* reinits on demand */
12098 PL_efloatsize = 0; /* reinits on demand */
12102 PL_screamfirst = NULL;
12103 PL_screamnext = NULL;
12104 PL_maxscream = -1; /* reinits on demand */
12105 PL_lastscream = NULL;
12108 PL_regdummy = proto_perl->Iregdummy;
12109 PL_colorset = 0; /* reinits PL_colors[] */
12110 /*PL_colors[6] = {0,0,0,0,0,0};*/
12114 /* Pluggable optimizer */
12115 PL_peepp = proto_perl->Ipeepp;
12117 PL_stashcache = newHV();
12119 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12120 proto_perl->Iwatchaddr);
12121 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12122 if (PL_debug && PL_watchaddr) {
12123 PerlIO_printf(Perl_debug_log,
12124 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12125 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12126 PTR2UV(PL_watchok));
12129 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12130 ptr_table_free(PL_ptr_table);
12131 PL_ptr_table = NULL;
12134 /* Call the ->CLONE method, if it exists, for each of the stashes
12135 identified by sv_dup() above.
12137 while(av_len(param->stashes) != -1) {
12138 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
12139 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12140 if (cloner && GvCV(cloner)) {
12145 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12147 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
12153 SvREFCNT_dec(param->stashes);
12155 /* orphaned? eg threads->new inside BEGIN or use */
12156 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12157 SvREFCNT_inc_simple_void(PL_compcv);
12158 SAVEFREESV(PL_compcv);
12164 #endif /* USE_ITHREADS */
12167 =head1 Unicode Support
12169 =for apidoc sv_recode_to_utf8
12171 The encoding is assumed to be an Encode object, on entry the PV
12172 of the sv is assumed to be octets in that encoding, and the sv
12173 will be converted into Unicode (and UTF-8).
12175 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12176 is not a reference, nothing is done to the sv. If the encoding is not
12177 an C<Encode::XS> Encoding object, bad things will happen.
12178 (See F<lib/encoding.pm> and L<Encode>).
12180 The PV of the sv is returned.
12185 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12189 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12191 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12205 Passing sv_yes is wrong - it needs to be or'ed set of constants
12206 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12207 remove converted chars from source.
12209 Both will default the value - let them.
12211 XPUSHs(&PL_sv_yes);
12214 call_method("decode", G_SCALAR);
12218 s = SvPV_const(uni, len);
12219 if (s != SvPVX_const(sv)) {
12220 SvGROW(sv, len + 1);
12221 Move(s, SvPVX(sv), len + 1, char);
12222 SvCUR_set(sv, len);
12229 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12233 =for apidoc sv_cat_decode
12235 The encoding is assumed to be an Encode object, the PV of the ssv is
12236 assumed to be octets in that encoding and decoding the input starts
12237 from the position which (PV + *offset) pointed to. The dsv will be
12238 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12239 when the string tstr appears in decoding output or the input ends on
12240 the PV of the ssv. The value which the offset points will be modified
12241 to the last input position on the ssv.
12243 Returns TRUE if the terminator was found, else returns FALSE.
12248 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12249 SV *ssv, int *offset, char *tstr, int tlen)
12254 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12256 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12267 offsv = newSViv(*offset);
12269 mXPUSHp(tstr, tlen);
12271 call_method("cat_decode", G_SCALAR);
12273 ret = SvTRUE(TOPs);
12274 *offset = SvIV(offsv);
12280 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12285 /* ---------------------------------------------------------------------
12287 * support functions for report_uninit()
12290 /* the maxiumum size of array or hash where we will scan looking
12291 * for the undefined element that triggered the warning */
12293 #define FUV_MAX_SEARCH_SIZE 1000
12295 /* Look for an entry in the hash whose value has the same SV as val;
12296 * If so, return a mortal copy of the key. */
12299 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
12302 register HE **array;
12305 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12307 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12308 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12311 array = HvARRAY(hv);
12313 for (i=HvMAX(hv); i>0; i--) {
12314 register HE *entry;
12315 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12316 if (HeVAL(entry) != val)
12318 if ( HeVAL(entry) == &PL_sv_undef ||
12319 HeVAL(entry) == &PL_sv_placeholder)
12323 if (HeKLEN(entry) == HEf_SVKEY)
12324 return sv_mortalcopy(HeKEY_sv(entry));
12325 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12331 /* Look for an entry in the array whose value has the same SV as val;
12332 * If so, return the index, otherwise return -1. */
12335 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
12339 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12341 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12342 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12345 if (val != &PL_sv_undef) {
12346 SV ** const svp = AvARRAY(av);
12349 for (i=AvFILLp(av); i>=0; i--)
12356 /* S_varname(): return the name of a variable, optionally with a subscript.
12357 * If gv is non-zero, use the name of that global, along with gvtype (one
12358 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12359 * targ. Depending on the value of the subscript_type flag, return:
12362 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12363 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12364 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12365 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12368 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
12369 const SV *const keyname, I32 aindex, int subscript_type)
12372 SV * const name = sv_newmortal();
12375 buffer[0] = gvtype;
12378 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12380 gv_fullname4(name, gv, buffer, 0);
12382 if ((unsigned int)SvPVX(name)[1] <= 26) {
12384 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12386 /* Swap the 1 unprintable control character for the 2 byte pretty
12387 version - ie substr($name, 1, 1) = $buffer; */
12388 sv_insert(name, 1, 1, buffer, 2);
12392 CV * const cv = find_runcv(NULL);
12396 if (!cv || !CvPADLIST(cv))
12398 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
12399 sv = *av_fetch(av, targ, FALSE);
12400 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12403 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12404 SV * const sv = newSV(0);
12405 *SvPVX(name) = '$';
12406 Perl_sv_catpvf(aTHX_ name, "{%s}",
12407 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12410 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12411 *SvPVX(name) = '$';
12412 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12414 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12415 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12416 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12424 =for apidoc find_uninit_var
12426 Find the name of the undefined variable (if any) that caused the operator o
12427 to issue a "Use of uninitialized value" warning.
12428 If match is true, only return a name if it's value matches uninit_sv.
12429 So roughly speaking, if a unary operator (such as OP_COS) generates a
12430 warning, then following the direct child of the op may yield an
12431 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12432 other hand, with OP_ADD there are two branches to follow, so we only print
12433 the variable name if we get an exact match.
12435 The name is returned as a mortal SV.
12437 Assumes that PL_op is the op that originally triggered the error, and that
12438 PL_comppad/PL_curpad points to the currently executing pad.
12444 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
12450 const OP *o, *o2, *kid;
12452 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12453 uninit_sv == &PL_sv_placeholder)))
12456 switch (obase->op_type) {
12463 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12464 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12467 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12469 if (pad) { /* @lex, %lex */
12470 sv = PAD_SVl(obase->op_targ);
12474 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12475 /* @global, %global */
12476 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12479 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
12481 else /* @{expr}, %{expr} */
12482 return find_uninit_var(cUNOPx(obase)->op_first,
12486 /* attempt to find a match within the aggregate */
12488 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12490 subscript_type = FUV_SUBSCRIPT_HASH;
12493 index = find_array_subscript((const AV *)sv, uninit_sv);
12495 subscript_type = FUV_SUBSCRIPT_ARRAY;
12498 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12501 return varname(gv, hash ? '%' : '@', obase->op_targ,
12502 keysv, index, subscript_type);
12506 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12508 return varname(NULL, '$', obase->op_targ,
12509 NULL, 0, FUV_SUBSCRIPT_NONE);
12512 gv = cGVOPx_gv(obase);
12513 if (!gv || (match && GvSV(gv) != uninit_sv))
12515 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12518 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12521 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
12522 if (!av || SvRMAGICAL(av))
12524 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12525 if (!svp || *svp != uninit_sv)
12528 return varname(NULL, '$', obase->op_targ,
12529 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12532 gv = cGVOPx_gv(obase);
12537 AV *const av = GvAV(gv);
12538 if (!av || SvRMAGICAL(av))
12540 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12541 if (!svp || *svp != uninit_sv)
12544 return varname(gv, '$', 0,
12545 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12550 o = cUNOPx(obase)->op_first;
12551 if (!o || o->op_type != OP_NULL ||
12552 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12554 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12558 if (PL_op == obase)
12559 /* $a[uninit_expr] or $h{uninit_expr} */
12560 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12563 o = cBINOPx(obase)->op_first;
12564 kid = cBINOPx(obase)->op_last;
12566 /* get the av or hv, and optionally the gv */
12568 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12569 sv = PAD_SV(o->op_targ);
12571 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12572 && cUNOPo->op_first->op_type == OP_GV)
12574 gv = cGVOPx_gv(cUNOPo->op_first);
12578 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
12583 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12584 /* index is constant */
12588 if (obase->op_type == OP_HELEM) {
12589 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
12590 if (!he || HeVAL(he) != uninit_sv)
12594 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
12595 if (!svp || *svp != uninit_sv)
12599 if (obase->op_type == OP_HELEM)
12600 return varname(gv, '%', o->op_targ,
12601 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12603 return varname(gv, '@', o->op_targ, NULL,
12604 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12607 /* index is an expression;
12608 * attempt to find a match within the aggregate */
12609 if (obase->op_type == OP_HELEM) {
12610 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12612 return varname(gv, '%', o->op_targ,
12613 keysv, 0, FUV_SUBSCRIPT_HASH);
12617 = find_array_subscript((const AV *)sv, uninit_sv);
12619 return varname(gv, '@', o->op_targ,
12620 NULL, index, FUV_SUBSCRIPT_ARRAY);
12625 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12627 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12632 /* only examine RHS */
12633 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12636 o = cUNOPx(obase)->op_first;
12637 if (o->op_type == OP_PUSHMARK)
12640 if (!o->op_sibling) {
12641 /* one-arg version of open is highly magical */
12643 if (o->op_type == OP_GV) { /* open FOO; */
12645 if (match && GvSV(gv) != uninit_sv)
12647 return varname(gv, '$', 0,
12648 NULL, 0, FUV_SUBSCRIPT_NONE);
12650 /* other possibilities not handled are:
12651 * open $x; or open my $x; should return '${*$x}'
12652 * open expr; should return '$'.expr ideally
12658 /* ops where $_ may be an implicit arg */
12662 if ( !(obase->op_flags & OPf_STACKED)) {
12663 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12664 ? PAD_SVl(obase->op_targ)
12667 sv = sv_newmortal();
12668 sv_setpvs(sv, "$_");
12677 match = 1; /* print etc can return undef on defined args */
12678 /* skip filehandle as it can't produce 'undef' warning */
12679 o = cUNOPx(obase)->op_first;
12680 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12681 o = o->op_sibling->op_sibling;
12685 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12687 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12689 /* the following ops are capable of returning PL_sv_undef even for
12690 * defined arg(s) */
12709 case OP_GETPEERNAME:
12757 case OP_SMARTMATCH:
12766 /* XXX tmp hack: these two may call an XS sub, and currently
12767 XS subs don't have a SUB entry on the context stack, so CV and
12768 pad determination goes wrong, and BAD things happen. So, just
12769 don't try to determine the value under those circumstances.
12770 Need a better fix at dome point. DAPM 11/2007 */
12775 /* def-ness of rval pos() is independent of the def-ness of its arg */
12776 if ( !(obase->op_flags & OPf_MOD))
12781 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12782 return newSVpvs_flags("${$/}", SVs_TEMP);
12787 if (!(obase->op_flags & OPf_KIDS))
12789 o = cUNOPx(obase)->op_first;
12795 /* if all except one arg are constant, or have no side-effects,
12796 * or are optimized away, then it's unambiguous */
12798 for (kid=o; kid; kid = kid->op_sibling) {
12800 const OPCODE type = kid->op_type;
12801 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12802 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12803 || (type == OP_PUSHMARK)
12807 if (o2) { /* more than one found */
12814 return find_uninit_var(o2, uninit_sv, match);
12816 /* scan all args */
12818 sv = find_uninit_var(o, uninit_sv, 1);
12830 =for apidoc report_uninit
12832 Print appropriate "Use of uninitialized variable" warning
12838 Perl_report_uninit(pTHX_ SV* uninit_sv)
12842 SV* varname = NULL;
12844 varname = find_uninit_var(PL_op, uninit_sv,0);
12846 sv_insert(varname, 0, 0, " ", 1);
12848 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12849 varname ? SvPV_nolen_const(varname) : "",
12850 " in ", OP_DESC(PL_op));
12853 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12859 * c-indentation-style: bsd
12860 * c-basic-offset: 4
12861 * indent-tabs-mode: t
12864 * ex: set ts=8 sts=4 sw=4 noet: