3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
7 * You may distribute under the terms of either the GNU General Public
8 * License or the Artistic License, as specified in the README file.
13 * 'I wonder what the Entish is for "yes" and "no",' he thought.
16 * [p.480 of _The Lord of the Rings_, III/iv: "Treebeard"]
22 * This file contains the code that creates, manipulates and destroys
23 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
24 * structure of an SV, so their creation and destruction is handled
25 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
26 * level functions (eg. substr, split, join) for each of the types are
38 /* Missing proto on LynxOS */
39 char *gconvert(double, int, int, char *);
42 #ifdef PERL_UTF8_CACHE_ASSERT
43 /* if adding more checks watch out for the following tests:
44 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
45 * lib/utf8.t lib/Unicode/Collate/t/index.t
48 # define ASSERT_UTF8_CACHE(cache) \
49 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
50 assert((cache)[2] <= (cache)[3]); \
51 assert((cache)[3] <= (cache)[1]);} \
54 # define ASSERT_UTF8_CACHE(cache) NOOP
57 #ifdef PERL_OLD_COPY_ON_WRITE
58 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
59 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
60 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
64 /* ============================================================================
66 =head1 Allocation and deallocation of SVs.
68 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
69 sv, av, hv...) contains type and reference count information, and for
70 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
71 contains fields specific to each type. Some types store all they need
72 in the head, so don't have a body.
74 In all but the most memory-paranoid configuations (ex: PURIFY), heads
75 and bodies are allocated out of arenas, which by default are
76 approximately 4K chunks of memory parcelled up into N heads or bodies.
77 Sv-bodies are allocated by their sv-type, guaranteeing size
78 consistency needed to allocate safely from arrays.
80 For SV-heads, the first slot in each arena is reserved, and holds a
81 link to the next arena, some flags, and a note of the number of slots.
82 Snaked through each arena chain is a linked list of free items; when
83 this becomes empty, an extra arena is allocated and divided up into N
84 items which are threaded into the free list.
86 SV-bodies are similar, but they use arena-sets by default, which
87 separate the link and info from the arena itself, and reclaim the 1st
88 slot in the arena. SV-bodies are further described later.
90 The following global variables are associated with arenas:
92 PL_sv_arenaroot pointer to list of SV arenas
93 PL_sv_root pointer to list of free SV structures
95 PL_body_arenas head of linked-list of body arenas
96 PL_body_roots[] array of pointers to list of free bodies of svtype
97 arrays are indexed by the svtype needed
99 A few special SV heads are not allocated from an arena, but are
100 instead directly created in the interpreter structure, eg PL_sv_undef.
101 The size of arenas can be changed from the default by setting
102 PERL_ARENA_SIZE appropriately at compile time.
104 The SV arena serves the secondary purpose of allowing still-live SVs
105 to be located and destroyed during final cleanup.
107 At the lowest level, the macros new_SV() and del_SV() grab and free
108 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
109 to return the SV to the free list with error checking.) new_SV() calls
110 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
111 SVs in the free list have their SvTYPE field set to all ones.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 The function visit() scans the SV arenas list, and calls a specified
118 function for each SV it finds which is still live - ie which has an SvTYPE
119 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
120 following functions (specified as [function that calls visit()] / [function
121 called by visit() for each SV]):
123 sv_report_used() / do_report_used()
124 dump all remaining SVs (debugging aid)
126 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
127 Attempt to free all objects pointed to by RVs,
128 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
129 try to do the same for all objects indirectly
130 referenced by typeglobs too. Called once from
131 perl_destruct(), prior to calling sv_clean_all()
134 sv_clean_all() / do_clean_all()
135 SvREFCNT_dec(sv) each remaining SV, possibly
136 triggering an sv_free(). It also sets the
137 SVf_BREAK flag on the SV to indicate that the
138 refcnt has been artificially lowered, and thus
139 stopping sv_free() from giving spurious warnings
140 about SVs which unexpectedly have a refcnt
141 of zero. called repeatedly from perl_destruct()
142 until there are no SVs left.
144 =head2 Arena allocator API Summary
146 Private API to rest of sv.c
150 new_XIV(), del_XIV(),
151 new_XNV(), del_XNV(),
156 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 * ========================================================================= */
163 * "A time to plant, and a time to uproot what was planted..."
167 Perl_offer_nice_chunk(pTHX_ void *const chunk, const U32 chunk_size)
173 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
175 new_chunk = (void *)(chunk);
176 new_chunk_size = (chunk_size);
177 if (new_chunk_size > PL_nice_chunk_size) {
178 Safefree(PL_nice_chunk);
179 PL_nice_chunk = (char *) new_chunk;
180 PL_nice_chunk_size = new_chunk_size;
187 # define MEM_LOG_NEW_SV(sv, file, line, func) \
188 Perl_mem_log_new_sv(sv, file, line, func)
189 # define MEM_LOG_DEL_SV(sv, file, line, func) \
190 Perl_mem_log_del_sv(sv, file, line, func)
192 # define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
193 # define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define DEBUG_SV_SERIAL(sv) \
199 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
200 PTR2UV(sv), (long)(sv)->sv_debug_serial))
202 # define FREE_SV_DEBUG_FILE(sv)
203 # define DEBUG_SV_SERIAL(sv) NOOP
207 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
208 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
209 /* Whilst I'd love to do this, it seems that things like to check on
211 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
213 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
214 PoisonNew(&SvREFCNT(sv), 1, U32)
216 # define SvARENA_CHAIN(sv) SvANY(sv)
217 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
218 # define POSION_SV_HEAD(sv)
221 /* Mark an SV head as unused, and add to free list.
223 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
224 * its refcount artificially decremented during global destruction, so
225 * there may be dangling pointers to it. The last thing we want in that
226 * case is for it to be reused. */
228 #define plant_SV(p) \
230 const U32 old_flags = SvFLAGS(p); \
231 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
232 DEBUG_SV_SERIAL(p); \
233 FREE_SV_DEBUG_FILE(p); \
235 SvFLAGS(p) = SVTYPEMASK; \
236 if (!(old_flags & SVf_BREAK)) { \
237 SvARENA_CHAIN_SET(p, PL_sv_root); \
243 #define uproot_SV(p) \
246 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
251 /* make some more SVs by adding another arena */
260 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
261 PL_nice_chunk = NULL;
262 PL_nice_chunk_size = 0;
265 char *chunk; /* must use New here to match call to */
266 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
267 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
273 /* new_SV(): return a new, empty SV head */
275 #ifdef DEBUG_LEAKING_SCALARS
276 /* provide a real function for a debugger to play with */
278 S_new_SV(pTHX_ const char *file, int line, const char *func)
285 sv = S_more_sv(aTHX);
289 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
290 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
296 sv->sv_debug_inpad = 0;
297 sv->sv_debug_cloned = 0;
298 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
300 sv->sv_debug_serial = PL_sv_serial++;
302 MEM_LOG_NEW_SV(sv, file, line, func);
303 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
304 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
308 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
316 (p) = S_more_sv(aTHX); \
320 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
325 /* del_SV(): return an empty SV head to the free list */
338 S_del_sv(pTHX_ SV *p)
342 PERL_ARGS_ASSERT_DEL_SV;
347 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
348 const SV * const sv = sva + 1;
349 const SV * const svend = &sva[SvREFCNT(sva)];
350 if (p >= sv && p < svend) {
356 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
357 "Attempt to free non-arena SV: 0x%"UVxf
358 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
365 #else /* ! DEBUGGING */
367 #define del_SV(p) plant_SV(p)
369 #endif /* DEBUGGING */
373 =head1 SV Manipulation Functions
375 =for apidoc sv_add_arena
377 Given a chunk of memory, link it to the head of the list of arenas,
378 and split it into a list of free SVs.
384 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
387 SV *const sva = MUTABLE_SV(ptr);
391 PERL_ARGS_ASSERT_SV_ADD_ARENA;
393 /* The first SV in an arena isn't an SV. */
394 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
395 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
396 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
398 PL_sv_arenaroot = sva;
399 PL_sv_root = sva + 1;
401 svend = &sva[SvREFCNT(sva) - 1];
404 SvARENA_CHAIN_SET(sv, (sv + 1));
408 /* Must always set typemask because it's always checked in on cleanup
409 when the arenas are walked looking for objects. */
410 SvFLAGS(sv) = SVTYPEMASK;
413 SvARENA_CHAIN_SET(sv, 0);
417 SvFLAGS(sv) = SVTYPEMASK;
420 /* visit(): call the named function for each non-free SV in the arenas
421 * whose flags field matches the flags/mask args. */
424 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
430 PERL_ARGS_ASSERT_VISIT;
432 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
433 register const SV * const svend = &sva[SvREFCNT(sva)];
435 for (sv = sva + 1; sv < svend; ++sv) {
436 if (SvTYPE(sv) != SVTYPEMASK
437 && (sv->sv_flags & mask) == flags
450 /* called by sv_report_used() for each live SV */
453 do_report_used(pTHX_ SV *const sv)
455 if (SvTYPE(sv) != SVTYPEMASK) {
456 PerlIO_printf(Perl_debug_log, "****\n");
463 =for apidoc sv_report_used
465 Dump the contents of all SVs not yet freed. (Debugging aid).
471 Perl_sv_report_used(pTHX)
474 visit(do_report_used, 0, 0);
480 /* called by sv_clean_objs() for each live SV */
483 do_clean_objs(pTHX_ SV *const ref)
488 SV * const target = SvRV(ref);
489 if (SvOBJECT(target)) {
490 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
491 if (SvWEAKREF(ref)) {
492 sv_del_backref(target, ref);
498 SvREFCNT_dec(target);
503 /* XXX Might want to check arrays, etc. */
506 /* called by sv_clean_objs() for each live SV */
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
510 do_clean_named_objs(pTHX_ SV *const sv)
513 assert(SvTYPE(sv) == SVt_PVGV);
514 assert(isGV_with_GP(sv));
517 #ifdef PERL_DONT_CREATE_GVSV
520 SvOBJECT(GvSV(sv))) ||
521 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
522 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
523 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
524 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
525 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
527 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
528 SvFLAGS(sv) |= SVf_BREAK;
536 =for apidoc sv_clean_objs
538 Attempt to destroy all objects not yet freed
544 Perl_sv_clean_objs(pTHX)
547 PL_in_clean_objs = TRUE;
548 visit(do_clean_objs, SVf_ROK, SVf_ROK);
549 #ifndef DISABLE_DESTRUCTOR_KLUDGE
550 /* some barnacles may yet remain, clinging to typeglobs */
551 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
553 PL_in_clean_objs = FALSE;
556 /* called by sv_clean_all() for each live SV */
559 do_clean_all(pTHX_ SV *const sv)
562 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
563 /* don't clean pid table and strtab */
566 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
567 SvFLAGS(sv) |= SVf_BREAK;
572 =for apidoc sv_clean_all
574 Decrement the refcnt of each remaining SV, possibly triggering a
575 cleanup. This function may have to be called multiple times to free
576 SVs which are in complex self-referential hierarchies.
582 Perl_sv_clean_all(pTHX)
586 PL_in_clean_all = TRUE;
587 cleaned = visit(do_clean_all, 0,0);
588 PL_in_clean_all = FALSE;
593 ARENASETS: a meta-arena implementation which separates arena-info
594 into struct arena_set, which contains an array of struct
595 arena_descs, each holding info for a single arena. By separating
596 the meta-info from the arena, we recover the 1st slot, formerly
597 borrowed for list management. The arena_set is about the size of an
598 arena, avoiding the needless malloc overhead of a naive linked-list.
600 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
601 memory in the last arena-set (1/2 on average). In trade, we get
602 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
603 smaller types). The recovery of the wasted space allows use of
604 small arenas for large, rare body types, by changing array* fields
605 in body_details_by_type[] below.
608 char *arena; /* the raw storage, allocated aligned */
609 size_t size; /* its size ~4k typ */
610 svtype utype; /* bodytype stored in arena */
615 /* Get the maximum number of elements in set[] such that struct arena_set
616 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
617 therefore likely to be 1 aligned memory page. */
619 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
620 - 2 * sizeof(int)) / sizeof (struct arena_desc))
623 struct arena_set* next;
624 unsigned int set_size; /* ie ARENAS_PER_SET */
625 unsigned int curr; /* index of next available arena-desc */
626 struct arena_desc set[ARENAS_PER_SET];
630 =for apidoc sv_free_arenas
632 Deallocate the memory used by all arenas. Note that all the individual SV
633 heads and bodies within the arenas must already have been freed.
638 Perl_sv_free_arenas(pTHX)
645 /* Free arenas here, but be careful about fake ones. (We assume
646 contiguity of the fake ones with the corresponding real ones.) */
648 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
649 svanext = MUTABLE_SV(SvANY(sva));
650 while (svanext && SvFAKE(svanext))
651 svanext = MUTABLE_SV(SvANY(svanext));
658 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
661 struct arena_set *current = aroot;
664 assert(aroot->set[i].arena);
665 Safefree(aroot->set[i].arena);
673 i = PERL_ARENA_ROOTS_SIZE;
675 PL_body_roots[i] = 0;
677 Safefree(PL_nice_chunk);
678 PL_nice_chunk = NULL;
679 PL_nice_chunk_size = 0;
685 Here are mid-level routines that manage the allocation of bodies out
686 of the various arenas. There are 5 kinds of arenas:
688 1. SV-head arenas, which are discussed and handled above
689 2. regular body arenas
690 3. arenas for reduced-size bodies
692 5. pte arenas (thread related)
694 Arena types 2 & 3 are chained by body-type off an array of
695 arena-root pointers, which is indexed by svtype. Some of the
696 larger/less used body types are malloced singly, since a large
697 unused block of them is wasteful. Also, several svtypes dont have
698 bodies; the data fits into the sv-head itself. The arena-root
699 pointer thus has a few unused root-pointers (which may be hijacked
700 later for arena types 4,5)
702 3 differs from 2 as an optimization; some body types have several
703 unused fields in the front of the structure (which are kept in-place
704 for consistency). These bodies can be allocated in smaller chunks,
705 because the leading fields arent accessed. Pointers to such bodies
706 are decremented to point at the unused 'ghost' memory, knowing that
707 the pointers are used with offsets to the real memory.
709 HE, HEK arenas are managed separately, with separate code, but may
710 be merge-able later..
712 PTE arenas are not sv-bodies, but they share these mid-level
713 mechanics, so are considered here. The new mid-level mechanics rely
714 on the sv_type of the body being allocated, so we just reserve one
715 of the unused body-slots for PTEs, then use it in those (2) PTE
716 contexts below (line ~10k)
719 /* get_arena(size): this creates custom-sized arenas
720 TBD: export properly for hv.c: S_more_he().
723 Perl_get_arena(pTHX_ const size_t arena_size, const svtype bodytype)
726 struct arena_desc* adesc;
727 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
730 /* shouldnt need this
731 if (!arena_size) arena_size = PERL_ARENA_SIZE;
734 /* may need new arena-set to hold new arena */
735 if (!aroot || aroot->curr >= aroot->set_size) {
736 struct arena_set *newroot;
737 Newxz(newroot, 1, struct arena_set);
738 newroot->set_size = ARENAS_PER_SET;
739 newroot->next = aroot;
741 PL_body_arenas = (void *) newroot;
742 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
745 /* ok, now have arena-set with at least 1 empty/available arena-desc */
746 curr = aroot->curr++;
747 adesc = &(aroot->set[curr]);
748 assert(!adesc->arena);
750 Newx(adesc->arena, arena_size, char);
751 adesc->size = arena_size;
752 adesc->utype = bodytype;
753 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
754 curr, (void*)adesc->arena, (UV)arena_size));
760 /* return a thing to the free list */
762 #define del_body(thing, root) \
764 void ** const thing_copy = (void **)thing;\
765 *thing_copy = *root; \
766 *root = (void*)thing_copy; \
771 =head1 SV-Body Allocation
773 Allocation of SV-bodies is similar to SV-heads, differing as follows;
774 the allocation mechanism is used for many body types, so is somewhat
775 more complicated, it uses arena-sets, and has no need for still-live
778 At the outermost level, (new|del)_X*V macros return bodies of the
779 appropriate type. These macros call either (new|del)_body_type or
780 (new|del)_body_allocated macro pairs, depending on specifics of the
781 type. Most body types use the former pair, the latter pair is used to
782 allocate body types with "ghost fields".
784 "ghost fields" are fields that are unused in certain types, and
785 consequently don't need to actually exist. They are declared because
786 they're part of a "base type", which allows use of functions as
787 methods. The simplest examples are AVs and HVs, 2 aggregate types
788 which don't use the fields which support SCALAR semantics.
790 For these types, the arenas are carved up into appropriately sized
791 chunks, we thus avoid wasted memory for those unaccessed members.
792 When bodies are allocated, we adjust the pointer back in memory by the
793 size of the part not allocated, so it's as if we allocated the full
794 structure. (But things will all go boom if you write to the part that
795 is "not there", because you'll be overwriting the last members of the
796 preceding structure in memory.)
798 We calculate the correction using the STRUCT_OFFSET macro on the first
799 member present. If the allocated structure is smaller (no initial NV
800 actually allocated) then the net effect is to subtract the size of the NV
801 from the pointer, to return a new pointer as if an initial NV were actually
802 allocated. (We were using structures named *_allocated for this, but
803 this turned out to be a subtle bug, because a structure without an NV
804 could have a lower alignment constraint, but the compiler is allowed to
805 optimised accesses based on the alignment constraint of the actual pointer
806 to the full structure, for example, using a single 64 bit load instruction
807 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
809 This is the same trick as was used for NV and IV bodies. Ironically it
810 doesn't need to be used for NV bodies any more, because NV is now at
811 the start of the structure. IV bodies don't need it either, because
812 they are no longer allocated.
814 In turn, the new_body_* allocators call S_new_body(), which invokes
815 new_body_inline macro, which takes a lock, and takes a body off the
816 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
817 necessary to refresh an empty list. Then the lock is released, and
818 the body is returned.
820 S_more_bodies calls get_arena(), and carves it up into an array of N
821 bodies, which it strings into a linked list. It looks up arena-size
822 and body-size from the body_details table described below, thus
823 supporting the multiple body-types.
825 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
826 the (new|del)_X*V macros are mapped directly to malloc/free.
832 For each sv-type, struct body_details bodies_by_type[] carries
833 parameters which control these aspects of SV handling:
835 Arena_size determines whether arenas are used for this body type, and if
836 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
837 zero, forcing individual mallocs and frees.
839 Body_size determines how big a body is, and therefore how many fit into
840 each arena. Offset carries the body-pointer adjustment needed for
841 "ghost fields", and is used in *_allocated macros.
843 But its main purpose is to parameterize info needed in
844 Perl_sv_upgrade(). The info here dramatically simplifies the function
845 vs the implementation in 5.8.8, making it table-driven. All fields
846 are used for this, except for arena_size.
848 For the sv-types that have no bodies, arenas are not used, so those
849 PL_body_roots[sv_type] are unused, and can be overloaded. In
850 something of a special case, SVt_NULL is borrowed for HE arenas;
851 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
852 bodies_by_type[SVt_NULL] slot is not used, as the table is not
855 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
856 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
857 just use the same allocation semantics. At first, PTEs were also
858 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
859 bugs, so was simplified by claiming a new slot. This choice has no
860 consequence at this time.
864 struct body_details {
865 U8 body_size; /* Size to allocate */
866 U8 copy; /* Size of structure to copy (may be shorter) */
868 unsigned int type : 4; /* We have space for a sanity check. */
869 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
870 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
871 unsigned int arena : 1; /* Allocated from an arena */
872 size_t arena_size; /* Size of arena to allocate */
880 /* With -DPURFIY we allocate everything directly, and don't use arenas.
881 This seems a rather elegant way to simplify some of the code below. */
882 #define HASARENA FALSE
884 #define HASARENA TRUE
886 #define NOARENA FALSE
888 /* Size the arenas to exactly fit a given number of bodies. A count
889 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
890 simplifying the default. If count > 0, the arena is sized to fit
891 only that many bodies, allowing arenas to be used for large, rare
892 bodies (XPVFM, XPVIO) without undue waste. The arena size is
893 limited by PERL_ARENA_SIZE, so we can safely oversize the
896 #define FIT_ARENA0(body_size) \
897 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
898 #define FIT_ARENAn(count,body_size) \
899 ( count * body_size <= PERL_ARENA_SIZE) \
900 ? count * body_size \
901 : FIT_ARENA0 (body_size)
902 #define FIT_ARENA(count,body_size) \
904 ? FIT_ARENAn (count, body_size) \
905 : FIT_ARENA0 (body_size)
907 /* Calculate the length to copy. Specifically work out the length less any
908 final padding the compiler needed to add. See the comment in sv_upgrade
909 for why copying the padding proved to be a bug. */
911 #define copy_length(type, last_member) \
912 STRUCT_OFFSET(type, last_member) \
913 + sizeof (((type*)SvANY((const SV *)0))->last_member)
915 static const struct body_details bodies_by_type[] = {
916 { sizeof(HE), 0, 0, SVt_NULL,
917 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
919 /* The bind placeholder pretends to be an RV for now.
920 Also it's marked as "can't upgrade" to stop anyone using it before it's
922 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
924 /* IVs are in the head, so the allocation size is 0.
925 However, the slot is overloaded for PTEs. */
926 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
927 sizeof(IV), /* This is used to copy out the IV body. */
928 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
929 NOARENA /* IVS don't need an arena */,
930 /* But PTEs need to know the size of their arena */
931 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
934 /* 8 bytes on most ILP32 with IEEE doubles */
935 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
936 FIT_ARENA(0, sizeof(NV)) },
938 /* 8 bytes on most ILP32 with IEEE doubles */
939 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
940 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
941 + STRUCT_OFFSET(XPV, xpv_cur),
942 SVt_PV, FALSE, NONV, HASARENA,
943 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
946 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
947 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
948 + STRUCT_OFFSET(XPVIV, xpv_cur),
949 SVt_PVIV, FALSE, NONV, HASARENA,
950 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
953 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
954 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
957 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
958 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
961 { sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur),
962 sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur),
963 + STRUCT_OFFSET(regexp, xpv_cur),
964 SVt_REGEXP, FALSE, NONV, HASARENA,
965 FIT_ARENA(0, sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur))
969 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
970 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
973 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
974 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
976 { sizeof(XPVAV) - STRUCT_OFFSET(XPVAV, xav_fill),
977 copy_length(XPVAV, xmg_stash) - STRUCT_OFFSET(XPVAV, xav_fill),
978 + STRUCT_OFFSET(XPVAV, xav_fill),
979 SVt_PVAV, TRUE, NONV, HASARENA,
980 FIT_ARENA(0, sizeof(XPVAV) - STRUCT_OFFSET(XPVAV, xav_fill)) },
982 { sizeof(XPVHV) - STRUCT_OFFSET(XPVHV, xhv_fill),
983 copy_length(XPVHV, xmg_stash) - STRUCT_OFFSET(XPVHV, xhv_fill),
984 + STRUCT_OFFSET(XPVHV, xhv_fill),
985 SVt_PVHV, TRUE, NONV, HASARENA,
986 FIT_ARENA(0, sizeof(XPVHV) - STRUCT_OFFSET(XPVHV, xhv_fill)) },
989 { sizeof(XPVCV) - STRUCT_OFFSET(XPVCV, xpv_cur),
990 sizeof(XPVCV) - STRUCT_OFFSET(XPVCV, xpv_cur),
991 + STRUCT_OFFSET(XPVCV, xpv_cur),
992 SVt_PVCV, TRUE, NONV, HASARENA,
993 FIT_ARENA(0, sizeof(XPVCV) - STRUCT_OFFSET(XPVCV, xpv_cur)) },
995 { sizeof(XPVFM) - STRUCT_OFFSET(XPVFM, xpv_cur),
996 sizeof(XPVFM) - STRUCT_OFFSET(XPVFM, xpv_cur),
997 + STRUCT_OFFSET(XPVFM, xpv_cur),
998 SVt_PVFM, TRUE, NONV, NOARENA,
999 FIT_ARENA(20, sizeof(XPVFM) - STRUCT_OFFSET(XPVFM, xpv_cur)) },
1001 /* XPVIO is 84 bytes, fits 48x */
1002 { sizeof(XPVIO) - STRUCT_OFFSET(XPVIO, xpv_cur),
1003 sizeof(XPVIO) - STRUCT_OFFSET(XPVIO, xpv_cur),
1004 + STRUCT_OFFSET(XPVIO, xpv_cur),
1005 SVt_PVIO, TRUE, NONV, HASARENA,
1006 FIT_ARENA(24, sizeof(XPVIO) - STRUCT_OFFSET(XPVIO, xpv_cur)) },
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 (old_type == new_type)
1190 /* This clause was purposefully added ahead of the early return above to
1191 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1192 inference by Nick I-S that it would fix other troublesome cases. See
1193 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1195 Given that shared hash key scalars are no longer PVIV, but PV, there is
1196 no longer need to unshare so as to free up the IVX slot for its proper
1197 purpose. So it's safe to move the early return earlier. */
1199 if (new_type != SVt_PV && SvIsCOW(sv)) {
1200 sv_force_normal_flags(sv, 0);
1203 old_body = SvANY(sv);
1205 /* Copying structures onto other structures that have been neatly zeroed
1206 has a subtle gotcha. Consider XPVMG
1208 +------+------+------+------+------+-------+-------+
1209 | NV | CUR | LEN | IV | MAGIC | STASH |
1210 +------+------+------+------+------+-------+-------+
1211 0 4 8 12 16 20 24 28
1213 where NVs are aligned to 8 bytes, so that sizeof that structure is
1214 actually 32 bytes long, with 4 bytes of padding at the end:
1216 +------+------+------+------+------+-------+-------+------+
1217 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1218 +------+------+------+------+------+-------+-------+------+
1219 0 4 8 12 16 20 24 28 32
1221 so what happens if you allocate memory for this structure:
1223 +------+------+------+------+------+-------+-------+------+------+...
1224 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1225 +------+------+------+------+------+-------+-------+------+------+...
1226 0 4 8 12 16 20 24 28 32 36
1228 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1229 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1230 started out as zero once, but it's quite possible that it isn't. So now,
1231 rather than a nicely zeroed GP, you have it pointing somewhere random.
1234 (In fact, GP ends up pointing at a previous GP structure, because the
1235 principle cause of the padding in XPVMG getting garbage is a copy of
1236 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1237 this happens to be moot because XPVGV has been re-ordered, with GP
1238 no longer after STASH)
1240 So we are careful and work out the size of used parts of all the
1248 referant = SvRV(sv);
1249 old_type_details = &fake_rv;
1250 if (new_type == SVt_NV)
1251 new_type = SVt_PVNV;
1253 if (new_type < SVt_PVIV) {
1254 new_type = (new_type == SVt_NV)
1255 ? SVt_PVNV : SVt_PVIV;
1260 if (new_type < SVt_PVNV) {
1261 new_type = SVt_PVNV;
1265 assert(new_type > SVt_PV);
1266 assert(SVt_IV < SVt_PV);
1267 assert(SVt_NV < SVt_PV);
1274 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1275 there's no way that it can be safely upgraded, because perl.c
1276 expects to Safefree(SvANY(PL_mess_sv)) */
1277 assert(sv != PL_mess_sv);
1278 /* This flag bit is used to mean other things in other scalar types.
1279 Given that it only has meaning inside the pad, it shouldn't be set
1280 on anything that can get upgraded. */
1281 assert(!SvPAD_TYPED(sv));
1284 if (old_type_details->cant_upgrade)
1285 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1286 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1289 if (old_type > new_type)
1290 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1291 (int)old_type, (int)new_type);
1293 new_type_details = bodies_by_type + new_type;
1295 SvFLAGS(sv) &= ~SVTYPEMASK;
1296 SvFLAGS(sv) |= new_type;
1298 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1299 the return statements above will have triggered. */
1300 assert (new_type != SVt_NULL);
1303 assert(old_type == SVt_NULL);
1304 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1308 assert(old_type == SVt_NULL);
1309 SvANY(sv) = new_XNV();
1314 assert(new_type_details->body_size);
1317 assert(new_type_details->arena);
1318 assert(new_type_details->arena_size);
1319 /* This points to the start of the allocated area. */
1320 new_body_inline(new_body, new_type);
1321 Zero(new_body, new_type_details->body_size, char);
1322 new_body = ((char *)new_body) - new_type_details->offset;
1324 /* We always allocated the full length item with PURIFY. To do this
1325 we fake things so that arena is false for all 16 types.. */
1326 new_body = new_NOARENAZ(new_type_details);
1328 SvANY(sv) = new_body;
1329 if (new_type == SVt_PVAV) {
1333 if (old_type_details->body_size) {
1336 /* It will have been zeroed when the new body was allocated.
1337 Lets not write to it, in case it confuses a write-back
1343 #ifndef NODEFAULT_SHAREKEYS
1344 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1346 HvMAX(sv) = 7; /* (start with 8 buckets) */
1347 if (old_type_details->body_size) {
1350 /* It will have been zeroed when the new body was allocated.
1351 Lets not write to it, in case it confuses a write-back
1356 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1357 The target created by newSVrv also is, and it can have magic.
1358 However, it never has SvPVX set.
1360 if (old_type == SVt_IV) {
1362 } else if (old_type >= SVt_PV) {
1363 assert(SvPVX_const(sv) == 0);
1366 if (old_type >= SVt_PVMG) {
1367 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1368 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1370 sv->sv_u.svu_array = NULL; /* or svu_hash */
1376 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1377 sv_force_normal_flags(sv) is called. */
1380 /* XXX Is this still needed? Was it ever needed? Surely as there is
1381 no route from NV to PVIV, NOK can never be true */
1382 assert(!SvNOKp(sv));
1393 assert(new_type_details->body_size);
1394 /* We always allocated the full length item with PURIFY. To do this
1395 we fake things so that arena is false for all 16 types.. */
1396 if(new_type_details->arena) {
1397 /* This points to the start of the allocated area. */
1398 new_body_inline(new_body, new_type);
1399 Zero(new_body, new_type_details->body_size, char);
1400 new_body = ((char *)new_body) - new_type_details->offset;
1402 new_body = new_NOARENAZ(new_type_details);
1404 SvANY(sv) = new_body;
1406 if (old_type_details->copy) {
1407 /* There is now the potential for an upgrade from something without
1408 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1409 int offset = old_type_details->offset;
1410 int length = old_type_details->copy;
1412 if (new_type_details->offset > old_type_details->offset) {
1413 const int difference
1414 = new_type_details->offset - old_type_details->offset;
1415 offset += difference;
1416 length -= difference;
1418 assert (length >= 0);
1420 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1424 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1425 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1426 * correct 0.0 for us. Otherwise, if the old body didn't have an
1427 * NV slot, but the new one does, then we need to initialise the
1428 * freshly created NV slot with whatever the correct bit pattern is
1430 if (old_type_details->zero_nv && !new_type_details->zero_nv
1431 && !isGV_with_GP(sv))
1435 if (new_type == SVt_PVIO) {
1436 IO * const io = MUTABLE_IO(sv);
1437 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1440 /* Clear the stashcache because a new IO could overrule a package
1442 hv_clear(PL_stashcache);
1444 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1445 IoPAGE_LEN(sv) = 60;
1447 if (old_type < SVt_PV) {
1448 /* referant will be NULL unless the old type was SVt_IV emulating
1450 sv->sv_u.svu_rv = referant;
1454 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1455 (unsigned long)new_type);
1458 if (old_type > SVt_IV) { /* SVt_IVs are overloaded for PTEs */
1460 my_safefree(old_body);
1462 /* Note that there is an assumption that all bodies of types that
1463 can be upgraded came from arenas. Only the more complex non-
1464 upgradable types are allowed to be directly malloc()ed. */
1465 assert(old_type_details->arena);
1466 del_body((void*)((char*)old_body + old_type_details->offset),
1467 &PL_body_roots[old_type]);
1473 =for apidoc sv_backoff
1475 Remove any string offset. You should normally use the C<SvOOK_off> macro
1482 Perl_sv_backoff(pTHX_ register SV *const sv)
1485 const char * const s = SvPVX_const(sv);
1487 PERL_ARGS_ASSERT_SV_BACKOFF;
1488 PERL_UNUSED_CONTEXT;
1491 assert(SvTYPE(sv) != SVt_PVHV);
1492 assert(SvTYPE(sv) != SVt_PVAV);
1494 SvOOK_offset(sv, delta);
1496 SvLEN_set(sv, SvLEN(sv) + delta);
1497 SvPV_set(sv, SvPVX(sv) - delta);
1498 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1499 SvFLAGS(sv) &= ~SVf_OOK;
1506 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1507 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1508 Use the C<SvGROW> wrapper instead.
1514 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1518 PERL_ARGS_ASSERT_SV_GROW;
1520 if (PL_madskills && newlen >= 0x100000) {
1521 PerlIO_printf(Perl_debug_log,
1522 "Allocation too large: %"UVxf"\n", (UV)newlen);
1524 #ifdef HAS_64K_LIMIT
1525 if (newlen >= 0x10000) {
1526 PerlIO_printf(Perl_debug_log,
1527 "Allocation too large: %"UVxf"\n", (UV)newlen);
1530 #endif /* HAS_64K_LIMIT */
1533 if (SvTYPE(sv) < SVt_PV) {
1534 sv_upgrade(sv, SVt_PV);
1535 s = SvPVX_mutable(sv);
1537 else if (SvOOK(sv)) { /* pv is offset? */
1539 s = SvPVX_mutable(sv);
1540 if (newlen > SvLEN(sv))
1541 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1542 #ifdef HAS_64K_LIMIT
1543 if (newlen >= 0x10000)
1548 s = SvPVX_mutable(sv);
1550 if (newlen > SvLEN(sv)) { /* need more room? */
1551 #ifndef Perl_safesysmalloc_size
1552 newlen = PERL_STRLEN_ROUNDUP(newlen);
1554 if (SvLEN(sv) && s) {
1555 s = (char*)saferealloc(s, newlen);
1558 s = (char*)safemalloc(newlen);
1559 if (SvPVX_const(sv) && SvCUR(sv)) {
1560 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1564 #ifdef Perl_safesysmalloc_size
1565 /* Do this here, do it once, do it right, and then we will never get
1566 called back into sv_grow() unless there really is some growing
1568 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1570 SvLEN_set(sv, newlen);
1577 =for apidoc sv_setiv
1579 Copies an integer into the given SV, upgrading first if necessary.
1580 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1586 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1590 PERL_ARGS_ASSERT_SV_SETIV;
1592 SV_CHECK_THINKFIRST_COW_DROP(sv);
1593 switch (SvTYPE(sv)) {
1596 sv_upgrade(sv, SVt_IV);
1599 sv_upgrade(sv, SVt_PVIV);
1603 if (!isGV_with_GP(sv))
1610 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1614 (void)SvIOK_only(sv); /* validate number */
1620 =for apidoc sv_setiv_mg
1622 Like C<sv_setiv>, but also handles 'set' magic.
1628 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1630 PERL_ARGS_ASSERT_SV_SETIV_MG;
1637 =for apidoc sv_setuv
1639 Copies an unsigned integer into the given SV, upgrading first if necessary.
1640 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1646 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1648 PERL_ARGS_ASSERT_SV_SETUV;
1650 /* With these two if statements:
1651 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1654 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1656 If you wish to remove them, please benchmark to see what the effect is
1658 if (u <= (UV)IV_MAX) {
1659 sv_setiv(sv, (IV)u);
1668 =for apidoc sv_setuv_mg
1670 Like C<sv_setuv>, but also handles 'set' magic.
1676 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1678 PERL_ARGS_ASSERT_SV_SETUV_MG;
1685 =for apidoc sv_setnv
1687 Copies a double into the given SV, upgrading first if necessary.
1688 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1694 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1698 PERL_ARGS_ASSERT_SV_SETNV;
1700 SV_CHECK_THINKFIRST_COW_DROP(sv);
1701 switch (SvTYPE(sv)) {
1704 sv_upgrade(sv, SVt_NV);
1708 sv_upgrade(sv, SVt_PVNV);
1712 if (!isGV_with_GP(sv))
1719 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1724 (void)SvNOK_only(sv); /* validate number */
1729 =for apidoc sv_setnv_mg
1731 Like C<sv_setnv>, but also handles 'set' magic.
1737 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1739 PERL_ARGS_ASSERT_SV_SETNV_MG;
1745 /* Print an "isn't numeric" warning, using a cleaned-up,
1746 * printable version of the offending string
1750 S_not_a_number(pTHX_ SV *const sv)
1757 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1760 dsv = newSVpvs_flags("", SVs_TEMP);
1761 pv = sv_uni_display(dsv, sv, 10, 0);
1764 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1765 /* each *s can expand to 4 chars + "...\0",
1766 i.e. need room for 8 chars */
1768 const char *s = SvPVX_const(sv);
1769 const char * const end = s + SvCUR(sv);
1770 for ( ; s < end && d < limit; s++ ) {
1772 if (ch & 128 && !isPRINT_LC(ch)) {
1781 else if (ch == '\r') {
1785 else if (ch == '\f') {
1789 else if (ch == '\\') {
1793 else if (ch == '\0') {
1797 else if (isPRINT_LC(ch))
1814 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1815 "Argument \"%s\" isn't numeric in %s", pv,
1818 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1819 "Argument \"%s\" isn't numeric", pv);
1823 =for apidoc looks_like_number
1825 Test if the content of an SV looks like a number (or is a number).
1826 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1827 non-numeric warning), even if your atof() doesn't grok them.
1833 Perl_looks_like_number(pTHX_ SV *const sv)
1835 register const char *sbegin;
1838 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1841 sbegin = SvPVX_const(sv);
1844 else if (SvPOKp(sv))
1845 sbegin = SvPV_const(sv, len);
1847 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1848 return grok_number(sbegin, len, NULL);
1852 S_glob_2number(pTHX_ GV * const gv)
1854 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1855 SV *const buffer = sv_newmortal();
1857 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1859 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1862 gv_efullname3(buffer, gv, "*");
1863 SvFLAGS(gv) |= wasfake;
1865 /* We know that all GVs stringify to something that is not-a-number,
1866 so no need to test that. */
1867 if (ckWARN(WARN_NUMERIC))
1868 not_a_number(buffer);
1869 /* We just want something true to return, so that S_sv_2iuv_common
1870 can tail call us and return true. */
1874 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1875 until proven guilty, assume that things are not that bad... */
1880 As 64 bit platforms often have an NV that doesn't preserve all bits of
1881 an IV (an assumption perl has been based on to date) it becomes necessary
1882 to remove the assumption that the NV always carries enough precision to
1883 recreate the IV whenever needed, and that the NV is the canonical form.
1884 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1885 precision as a side effect of conversion (which would lead to insanity
1886 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1887 1) to distinguish between IV/UV/NV slots that have cached a valid
1888 conversion where precision was lost and IV/UV/NV slots that have a
1889 valid conversion which has lost no precision
1890 2) to ensure that if a numeric conversion to one form is requested that
1891 would lose precision, the precise conversion (or differently
1892 imprecise conversion) is also performed and cached, to prevent
1893 requests for different numeric formats on the same SV causing
1894 lossy conversion chains. (lossless conversion chains are perfectly
1899 SvIOKp is true if the IV slot contains a valid value
1900 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1901 SvNOKp is true if the NV slot contains a valid value
1902 SvNOK is true only if the NV value is accurate
1905 while converting from PV to NV, check to see if converting that NV to an
1906 IV(or UV) would lose accuracy over a direct conversion from PV to
1907 IV(or UV). If it would, cache both conversions, return NV, but mark
1908 SV as IOK NOKp (ie not NOK).
1910 While converting from PV to IV, check to see if converting that IV to an
1911 NV would lose accuracy over a direct conversion from PV to NV. If it
1912 would, cache both conversions, flag similarly.
1914 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1915 correctly because if IV & NV were set NV *always* overruled.
1916 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1917 changes - now IV and NV together means that the two are interchangeable:
1918 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1920 The benefit of this is that operations such as pp_add know that if
1921 SvIOK is true for both left and right operands, then integer addition
1922 can be used instead of floating point (for cases where the result won't
1923 overflow). Before, floating point was always used, which could lead to
1924 loss of precision compared with integer addition.
1926 * making IV and NV equal status should make maths accurate on 64 bit
1928 * may speed up maths somewhat if pp_add and friends start to use
1929 integers when possible instead of fp. (Hopefully the overhead in
1930 looking for SvIOK and checking for overflow will not outweigh the
1931 fp to integer speedup)
1932 * will slow down integer operations (callers of SvIV) on "inaccurate"
1933 values, as the change from SvIOK to SvIOKp will cause a call into
1934 sv_2iv each time rather than a macro access direct to the IV slot
1935 * should speed up number->string conversion on integers as IV is
1936 favoured when IV and NV are equally accurate
1938 ####################################################################
1939 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1940 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1941 On the other hand, SvUOK is true iff UV.
1942 ####################################################################
1944 Your mileage will vary depending your CPU's relative fp to integer
1948 #ifndef NV_PRESERVES_UV
1949 # define IS_NUMBER_UNDERFLOW_IV 1
1950 # define IS_NUMBER_UNDERFLOW_UV 2
1951 # define IS_NUMBER_IV_AND_UV 2
1952 # define IS_NUMBER_OVERFLOW_IV 4
1953 # define IS_NUMBER_OVERFLOW_UV 5
1955 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1957 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1959 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1967 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1969 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));
1970 if (SvNVX(sv) < (NV)IV_MIN) {
1971 (void)SvIOKp_on(sv);
1973 SvIV_set(sv, IV_MIN);
1974 return IS_NUMBER_UNDERFLOW_IV;
1976 if (SvNVX(sv) > (NV)UV_MAX) {
1977 (void)SvIOKp_on(sv);
1980 SvUV_set(sv, UV_MAX);
1981 return IS_NUMBER_OVERFLOW_UV;
1983 (void)SvIOKp_on(sv);
1985 /* Can't use strtol etc to convert this string. (See truth table in
1987 if (SvNVX(sv) <= (UV)IV_MAX) {
1988 SvIV_set(sv, I_V(SvNVX(sv)));
1989 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1990 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1992 /* Integer is imprecise. NOK, IOKp */
1994 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1997 SvUV_set(sv, U_V(SvNVX(sv)));
1998 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1999 if (SvUVX(sv) == UV_MAX) {
2000 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2001 possibly be preserved by NV. Hence, it must be overflow.
2003 return IS_NUMBER_OVERFLOW_UV;
2005 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2007 /* Integer is imprecise. NOK, IOKp */
2009 return IS_NUMBER_OVERFLOW_IV;
2011 #endif /* !NV_PRESERVES_UV*/
2014 S_sv_2iuv_common(pTHX_ SV *const sv)
2018 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
2021 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2022 * without also getting a cached IV/UV from it at the same time
2023 * (ie PV->NV conversion should detect loss of accuracy and cache
2024 * IV or UV at same time to avoid this. */
2025 /* IV-over-UV optimisation - choose to cache IV if possible */
2027 if (SvTYPE(sv) == SVt_NV)
2028 sv_upgrade(sv, SVt_PVNV);
2030 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2031 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2032 certainly cast into the IV range at IV_MAX, whereas the correct
2033 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2035 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2036 if (Perl_isnan(SvNVX(sv))) {
2042 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2043 SvIV_set(sv, I_V(SvNVX(sv)));
2044 if (SvNVX(sv) == (NV) SvIVX(sv)
2045 #ifndef NV_PRESERVES_UV
2046 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2047 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2048 /* Don't flag it as "accurately an integer" if the number
2049 came from a (by definition imprecise) NV operation, and
2050 we're outside the range of NV integer precision */
2054 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2056 /* scalar has trailing garbage, eg "42a" */
2058 DEBUG_c(PerlIO_printf(Perl_debug_log,
2059 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2065 /* IV not precise. No need to convert from PV, as NV
2066 conversion would already have cached IV if it detected
2067 that PV->IV would be better than PV->NV->IV
2068 flags already correct - don't set public IOK. */
2069 DEBUG_c(PerlIO_printf(Perl_debug_log,
2070 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2075 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2076 but the cast (NV)IV_MIN rounds to a the value less (more
2077 negative) than IV_MIN which happens to be equal to SvNVX ??
2078 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2079 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2080 (NV)UVX == NVX are both true, but the values differ. :-(
2081 Hopefully for 2s complement IV_MIN is something like
2082 0x8000000000000000 which will be exact. NWC */
2085 SvUV_set(sv, U_V(SvNVX(sv)));
2087 (SvNVX(sv) == (NV) SvUVX(sv))
2088 #ifndef NV_PRESERVES_UV
2089 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2090 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2091 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2092 /* Don't flag it as "accurately an integer" if the number
2093 came from a (by definition imprecise) NV operation, and
2094 we're outside the range of NV integer precision */
2100 DEBUG_c(PerlIO_printf(Perl_debug_log,
2101 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2107 else if (SvPOKp(sv) && SvLEN(sv)) {
2109 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2110 /* We want to avoid a possible problem when we cache an IV/ a UV which
2111 may be later translated to an NV, and the resulting NV is not
2112 the same as the direct translation of the initial string
2113 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2114 be careful to ensure that the value with the .456 is around if the
2115 NV value is requested in the future).
2117 This means that if we cache such an IV/a UV, we need to cache the
2118 NV as well. Moreover, we trade speed for space, and do not
2119 cache the NV if we are sure it's not needed.
2122 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2123 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2124 == IS_NUMBER_IN_UV) {
2125 /* It's definitely an integer, only upgrade to PVIV */
2126 if (SvTYPE(sv) < SVt_PVIV)
2127 sv_upgrade(sv, SVt_PVIV);
2129 } else if (SvTYPE(sv) < SVt_PVNV)
2130 sv_upgrade(sv, SVt_PVNV);
2132 /* If NVs preserve UVs then we only use the UV value if we know that
2133 we aren't going to call atof() below. If NVs don't preserve UVs
2134 then the value returned may have more precision than atof() will
2135 return, even though value isn't perfectly accurate. */
2136 if ((numtype & (IS_NUMBER_IN_UV
2137 #ifdef NV_PRESERVES_UV
2140 )) == IS_NUMBER_IN_UV) {
2141 /* This won't turn off the public IOK flag if it was set above */
2142 (void)SvIOKp_on(sv);
2144 if (!(numtype & IS_NUMBER_NEG)) {
2146 if (value <= (UV)IV_MAX) {
2147 SvIV_set(sv, (IV)value);
2149 /* it didn't overflow, and it was positive. */
2150 SvUV_set(sv, value);
2154 /* 2s complement assumption */
2155 if (value <= (UV)IV_MIN) {
2156 SvIV_set(sv, -(IV)value);
2158 /* Too negative for an IV. This is a double upgrade, but
2159 I'm assuming it will be rare. */
2160 if (SvTYPE(sv) < SVt_PVNV)
2161 sv_upgrade(sv, SVt_PVNV);
2165 SvNV_set(sv, -(NV)value);
2166 SvIV_set(sv, IV_MIN);
2170 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2171 will be in the previous block to set the IV slot, and the next
2172 block to set the NV slot. So no else here. */
2174 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2175 != IS_NUMBER_IN_UV) {
2176 /* It wasn't an (integer that doesn't overflow the UV). */
2177 SvNV_set(sv, Atof(SvPVX_const(sv)));
2179 if (! numtype && ckWARN(WARN_NUMERIC))
2182 #if defined(USE_LONG_DOUBLE)
2183 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2184 PTR2UV(sv), SvNVX(sv)));
2186 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2187 PTR2UV(sv), SvNVX(sv)));
2190 #ifdef NV_PRESERVES_UV
2191 (void)SvIOKp_on(sv);
2193 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2194 SvIV_set(sv, I_V(SvNVX(sv)));
2195 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2198 NOOP; /* Integer is imprecise. NOK, IOKp */
2200 /* UV will not work better than IV */
2202 if (SvNVX(sv) > (NV)UV_MAX) {
2204 /* Integer is inaccurate. NOK, IOKp, is UV */
2205 SvUV_set(sv, UV_MAX);
2207 SvUV_set(sv, U_V(SvNVX(sv)));
2208 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2209 NV preservse UV so can do correct comparison. */
2210 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2213 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2218 #else /* NV_PRESERVES_UV */
2219 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2220 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2221 /* The IV/UV slot will have been set from value returned by
2222 grok_number above. The NV slot has just been set using
2225 assert (SvIOKp(sv));
2227 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2228 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2229 /* Small enough to preserve all bits. */
2230 (void)SvIOKp_on(sv);
2232 SvIV_set(sv, I_V(SvNVX(sv)));
2233 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2235 /* Assumption: first non-preserved integer is < IV_MAX,
2236 this NV is in the preserved range, therefore: */
2237 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2239 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);
2243 0 0 already failed to read UV.
2244 0 1 already failed to read UV.
2245 1 0 you won't get here in this case. IV/UV
2246 slot set, public IOK, Atof() unneeded.
2247 1 1 already read UV.
2248 so there's no point in sv_2iuv_non_preserve() attempting
2249 to use atol, strtol, strtoul etc. */
2251 sv_2iuv_non_preserve (sv, numtype);
2253 sv_2iuv_non_preserve (sv);
2257 #endif /* NV_PRESERVES_UV */
2258 /* It might be more code efficient to go through the entire logic above
2259 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2260 gets complex and potentially buggy, so more programmer efficient
2261 to do it this way, by turning off the public flags: */
2263 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2267 if (isGV_with_GP(sv))
2268 return glob_2number(MUTABLE_GV(sv));
2270 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2271 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2274 if (SvTYPE(sv) < SVt_IV)
2275 /* Typically the caller expects that sv_any is not NULL now. */
2276 sv_upgrade(sv, SVt_IV);
2277 /* Return 0 from the caller. */
2284 =for apidoc sv_2iv_flags
2286 Return the integer value of an SV, doing any necessary string
2287 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2288 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2294 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2299 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2300 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2301 cache IVs just in case. In practice it seems that they never
2302 actually anywhere accessible by user Perl code, let alone get used
2303 in anything other than a string context. */
2304 if (flags & SV_GMAGIC)
2309 return I_V(SvNVX(sv));
2311 if (SvPOKp(sv) && SvLEN(sv)) {
2314 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2316 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2317 == IS_NUMBER_IN_UV) {
2318 /* It's definitely an integer */
2319 if (numtype & IS_NUMBER_NEG) {
2320 if (value < (UV)IV_MIN)
2323 if (value < (UV)IV_MAX)
2328 if (ckWARN(WARN_NUMERIC))
2331 return I_V(Atof(SvPVX_const(sv)));
2336 assert(SvTYPE(sv) >= SVt_PVMG);
2337 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2338 } else if (SvTHINKFIRST(sv)) {
2342 SV * const tmpstr=AMG_CALLun(sv,numer);
2343 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2344 return SvIV(tmpstr);
2347 return PTR2IV(SvRV(sv));
2350 sv_force_normal_flags(sv, 0);
2352 if (SvREADONLY(sv) && !SvOK(sv)) {
2353 if (ckWARN(WARN_UNINITIALIZED))
2359 if (S_sv_2iuv_common(aTHX_ sv))
2362 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2363 PTR2UV(sv),SvIVX(sv)));
2364 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2368 =for apidoc sv_2uv_flags
2370 Return the unsigned integer value of an SV, doing any necessary string
2371 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2372 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2378 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2383 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2384 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2385 cache IVs just in case. */
2386 if (flags & SV_GMAGIC)
2391 return U_V(SvNVX(sv));
2392 if (SvPOKp(sv) && SvLEN(sv)) {
2395 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2397 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2398 == IS_NUMBER_IN_UV) {
2399 /* It's definitely an integer */
2400 if (!(numtype & IS_NUMBER_NEG))
2404 if (ckWARN(WARN_NUMERIC))
2407 return U_V(Atof(SvPVX_const(sv)));
2412 assert(SvTYPE(sv) >= SVt_PVMG);
2413 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2414 } else if (SvTHINKFIRST(sv)) {
2418 SV *const tmpstr = AMG_CALLun(sv,numer);
2419 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2420 return SvUV(tmpstr);
2423 return PTR2UV(SvRV(sv));
2426 sv_force_normal_flags(sv, 0);
2428 if (SvREADONLY(sv) && !SvOK(sv)) {
2429 if (ckWARN(WARN_UNINITIALIZED))
2435 if (S_sv_2iuv_common(aTHX_ sv))
2439 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2440 PTR2UV(sv),SvUVX(sv)));
2441 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2447 Return the num value of an SV, doing any necessary string or integer
2448 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2455 Perl_sv_2nv(pTHX_ register SV *const sv)
2460 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2461 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2462 cache IVs just in case. */
2466 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2467 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2468 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2470 return Atof(SvPVX_const(sv));
2474 return (NV)SvUVX(sv);
2476 return (NV)SvIVX(sv);
2481 assert(SvTYPE(sv) >= SVt_PVMG);
2482 /* This falls through to the report_uninit near the end of the
2484 } else if (SvTHINKFIRST(sv)) {
2488 SV *const tmpstr = AMG_CALLun(sv,numer);
2489 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2490 return SvNV(tmpstr);
2493 return PTR2NV(SvRV(sv));
2496 sv_force_normal_flags(sv, 0);
2498 if (SvREADONLY(sv) && !SvOK(sv)) {
2499 if (ckWARN(WARN_UNINITIALIZED))
2504 if (SvTYPE(sv) < SVt_NV) {
2505 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2506 sv_upgrade(sv, SVt_NV);
2507 #ifdef USE_LONG_DOUBLE
2509 STORE_NUMERIC_LOCAL_SET_STANDARD();
2510 PerlIO_printf(Perl_debug_log,
2511 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2512 PTR2UV(sv), SvNVX(sv));
2513 RESTORE_NUMERIC_LOCAL();
2517 STORE_NUMERIC_LOCAL_SET_STANDARD();
2518 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2519 PTR2UV(sv), SvNVX(sv));
2520 RESTORE_NUMERIC_LOCAL();
2524 else if (SvTYPE(sv) < SVt_PVNV)
2525 sv_upgrade(sv, SVt_PVNV);
2530 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2531 #ifdef NV_PRESERVES_UV
2537 /* Only set the public NV OK flag if this NV preserves the IV */
2538 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2540 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2541 : (SvIVX(sv) == I_V(SvNVX(sv))))
2547 else if (SvPOKp(sv) && SvLEN(sv)) {
2549 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2550 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2552 #ifdef NV_PRESERVES_UV
2553 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2554 == IS_NUMBER_IN_UV) {
2555 /* It's definitely an integer */
2556 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2558 SvNV_set(sv, Atof(SvPVX_const(sv)));
2564 SvNV_set(sv, Atof(SvPVX_const(sv)));
2565 /* Only set the public NV OK flag if this NV preserves the value in
2566 the PV at least as well as an IV/UV would.
2567 Not sure how to do this 100% reliably. */
2568 /* if that shift count is out of range then Configure's test is
2569 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2571 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2572 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2573 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2574 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2575 /* Can't use strtol etc to convert this string, so don't try.
2576 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2579 /* value has been set. It may not be precise. */
2580 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2581 /* 2s complement assumption for (UV)IV_MIN */
2582 SvNOK_on(sv); /* Integer is too negative. */
2587 if (numtype & IS_NUMBER_NEG) {
2588 SvIV_set(sv, -(IV)value);
2589 } else if (value <= (UV)IV_MAX) {
2590 SvIV_set(sv, (IV)value);
2592 SvUV_set(sv, value);
2596 if (numtype & IS_NUMBER_NOT_INT) {
2597 /* I believe that even if the original PV had decimals,
2598 they are lost beyond the limit of the FP precision.
2599 However, neither is canonical, so both only get p
2600 flags. NWC, 2000/11/25 */
2601 /* Both already have p flags, so do nothing */
2603 const NV nv = SvNVX(sv);
2604 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2605 if (SvIVX(sv) == I_V(nv)) {
2608 /* It had no "." so it must be integer. */
2612 /* between IV_MAX and NV(UV_MAX).
2613 Could be slightly > UV_MAX */
2615 if (numtype & IS_NUMBER_NOT_INT) {
2616 /* UV and NV both imprecise. */
2618 const UV nv_as_uv = U_V(nv);
2620 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2629 /* It might be more code efficient to go through the entire logic above
2630 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2631 gets complex and potentially buggy, so more programmer efficient
2632 to do it this way, by turning off the public flags: */
2634 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2635 #endif /* NV_PRESERVES_UV */
2638 if (isGV_with_GP(sv)) {
2639 glob_2number(MUTABLE_GV(sv));
2643 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2645 assert (SvTYPE(sv) >= SVt_NV);
2646 /* Typically the caller expects that sv_any is not NULL now. */
2647 /* XXX Ilya implies that this is a bug in callers that assume this
2648 and ideally should be fixed. */
2651 #if defined(USE_LONG_DOUBLE)
2653 STORE_NUMERIC_LOCAL_SET_STANDARD();
2654 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2655 PTR2UV(sv), SvNVX(sv));
2656 RESTORE_NUMERIC_LOCAL();
2660 STORE_NUMERIC_LOCAL_SET_STANDARD();
2661 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2662 PTR2UV(sv), SvNVX(sv));
2663 RESTORE_NUMERIC_LOCAL();
2672 Return an SV with the numeric value of the source SV, doing any necessary
2673 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2674 access this function.
2680 Perl_sv_2num(pTHX_ register SV *const sv)
2682 PERL_ARGS_ASSERT_SV_2NUM;
2687 SV * const tmpsv = AMG_CALLun(sv,numer);
2688 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2689 return sv_2num(tmpsv);
2691 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2694 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2695 * UV as a string towards the end of buf, and return pointers to start and
2698 * We assume that buf is at least TYPE_CHARS(UV) long.
2702 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2704 char *ptr = buf + TYPE_CHARS(UV);
2705 char * const ebuf = ptr;
2708 PERL_ARGS_ASSERT_UIV_2BUF;
2720 *--ptr = '0' + (char)(uv % 10);
2729 =for apidoc sv_2pv_flags
2731 Returns a pointer to the string value of an SV, and sets *lp to its length.
2732 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2734 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2735 usually end up here too.
2741 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2751 if (SvGMAGICAL(sv)) {
2752 if (flags & SV_GMAGIC)
2757 if (flags & SV_MUTABLE_RETURN)
2758 return SvPVX_mutable(sv);
2759 if (flags & SV_CONST_RETURN)
2760 return (char *)SvPVX_const(sv);
2763 if (SvIOKp(sv) || SvNOKp(sv)) {
2764 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2769 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2770 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2772 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2779 #ifdef FIXNEGATIVEZERO
2780 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2786 SvUPGRADE(sv, SVt_PV);
2789 s = SvGROW_mutable(sv, len + 1);
2792 return (char*)memcpy(s, tbuf, len + 1);
2798 assert(SvTYPE(sv) >= SVt_PVMG);
2799 /* This falls through to the report_uninit near the end of the
2801 } else if (SvTHINKFIRST(sv)) {
2805 SV *const tmpstr = AMG_CALLun(sv,string);
2806 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2808 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2812 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2813 if (flags & SV_CONST_RETURN) {
2814 pv = (char *) SvPVX_const(tmpstr);
2816 pv = (flags & SV_MUTABLE_RETURN)
2817 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2820 *lp = SvCUR(tmpstr);
2822 pv = sv_2pv_flags(tmpstr, lp, flags);
2835 SV *const referent = SvRV(sv);
2839 retval = buffer = savepvn("NULLREF", len);
2840 } else if (SvTYPE(referent) == SVt_REGEXP) {
2841 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2846 /* If the regex is UTF-8 we want the containing scalar to
2847 have an UTF-8 flag too */
2853 if ((seen_evals = RX_SEEN_EVALS(re)))
2854 PL_reginterp_cnt += seen_evals;
2857 *lp = RX_WRAPLEN(re);
2859 return RX_WRAPPED(re);
2861 const char *const typestr = sv_reftype(referent, 0);
2862 const STRLEN typelen = strlen(typestr);
2863 UV addr = PTR2UV(referent);
2864 const char *stashname = NULL;
2865 STRLEN stashnamelen = 0; /* hush, gcc */
2866 const char *buffer_end;
2868 if (SvOBJECT(referent)) {
2869 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2872 stashname = HEK_KEY(name);
2873 stashnamelen = HEK_LEN(name);
2875 if (HEK_UTF8(name)) {
2881 stashname = "__ANON__";
2884 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2885 + 2 * sizeof(UV) + 2 /* )\0 */;
2887 len = typelen + 3 /* (0x */
2888 + 2 * sizeof(UV) + 2 /* )\0 */;
2891 Newx(buffer, len, char);
2892 buffer_end = retval = buffer + len;
2894 /* Working backwards */
2898 *--retval = PL_hexdigit[addr & 15];
2899 } while (addr >>= 4);
2905 memcpy(retval, typestr, typelen);
2909 retval -= stashnamelen;
2910 memcpy(retval, stashname, stashnamelen);
2912 /* retval may not neccesarily have reached the start of the
2914 assert (retval >= buffer);
2916 len = buffer_end - retval - 1; /* -1 for that \0 */
2924 if (SvREADONLY(sv) && !SvOK(sv)) {
2927 if (flags & SV_UNDEF_RETURNS_NULL)
2929 if (ckWARN(WARN_UNINITIALIZED))
2934 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2935 /* I'm assuming that if both IV and NV are equally valid then
2936 converting the IV is going to be more efficient */
2937 const U32 isUIOK = SvIsUV(sv);
2938 char buf[TYPE_CHARS(UV)];
2942 if (SvTYPE(sv) < SVt_PVIV)
2943 sv_upgrade(sv, SVt_PVIV);
2944 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2946 /* inlined from sv_setpvn */
2947 s = SvGROW_mutable(sv, len + 1);
2948 Move(ptr, s, len, char);
2952 else if (SvNOKp(sv)) {
2954 if (SvTYPE(sv) < SVt_PVNV)
2955 sv_upgrade(sv, SVt_PVNV);
2956 /* The +20 is pure guesswork. Configure test needed. --jhi */
2957 s = SvGROW_mutable(sv, NV_DIG + 20);
2958 /* some Xenix systems wipe out errno here */
2960 if (SvNVX(sv) == 0.0)
2961 my_strlcpy(s, "0", SvLEN(sv));
2965 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2968 #ifdef FIXNEGATIVEZERO
2969 if (*s == '-' && s[1] == '0' && !s[2]) {
2981 if (isGV_with_GP(sv)) {
2982 GV *const gv = MUTABLE_GV(sv);
2983 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2984 SV *const buffer = sv_newmortal();
2986 /* FAKE globs can get coerced, so need to turn this off temporarily
2989 gv_efullname3(buffer, gv, "*");
2990 SvFLAGS(gv) |= wasfake;
2992 if (SvPOK(buffer)) {
2994 *lp = SvCUR(buffer);
2996 return SvPVX(buffer);
3007 if (flags & SV_UNDEF_RETURNS_NULL)
3009 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3011 if (SvTYPE(sv) < SVt_PV)
3012 /* Typically the caller expects that sv_any is not NULL now. */
3013 sv_upgrade(sv, SVt_PV);
3017 const STRLEN len = s - SvPVX_const(sv);
3023 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3024 PTR2UV(sv),SvPVX_const(sv)));
3025 if (flags & SV_CONST_RETURN)
3026 return (char *)SvPVX_const(sv);
3027 if (flags & SV_MUTABLE_RETURN)
3028 return SvPVX_mutable(sv);
3033 =for apidoc sv_copypv
3035 Copies a stringified representation of the source SV into the
3036 destination SV. Automatically performs any necessary mg_get and
3037 coercion of numeric values into strings. Guaranteed to preserve
3038 UTF8 flag even from overloaded objects. Similar in nature to
3039 sv_2pv[_flags] but operates directly on an SV instead of just the
3040 string. Mostly uses sv_2pv_flags to do its work, except when that
3041 would lose the UTF-8'ness of the PV.
3047 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3050 const char * const s = SvPV_const(ssv,len);
3052 PERL_ARGS_ASSERT_SV_COPYPV;
3054 sv_setpvn(dsv,s,len);
3062 =for apidoc sv_2pvbyte
3064 Return a pointer to the byte-encoded representation of the SV, and set *lp
3065 to its length. May cause the SV to be downgraded from UTF-8 as a
3068 Usually accessed via the C<SvPVbyte> macro.
3074 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3076 PERL_ARGS_ASSERT_SV_2PVBYTE;
3078 sv_utf8_downgrade(sv,0);
3079 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3083 =for apidoc sv_2pvutf8
3085 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3086 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3088 Usually accessed via the C<SvPVutf8> macro.
3094 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3096 PERL_ARGS_ASSERT_SV_2PVUTF8;
3098 sv_utf8_upgrade(sv);
3099 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3104 =for apidoc sv_2bool
3106 This function is only called on magical items, and is only used by
3107 sv_true() or its macro equivalent.
3113 Perl_sv_2bool(pTHX_ register SV *const sv)
3117 PERL_ARGS_ASSERT_SV_2BOOL;
3125 SV * const tmpsv = AMG_CALLun(sv,bool_);
3126 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3127 return (bool)SvTRUE(tmpsv);
3129 return SvRV(sv) != 0;
3132 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3134 (*sv->sv_u.svu_pv > '0' ||
3135 Xpvtmp->xpv_cur > 1 ||
3136 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3143 return SvIVX(sv) != 0;
3146 return SvNVX(sv) != 0.0;
3148 if (isGV_with_GP(sv))
3158 =for apidoc sv_utf8_upgrade
3160 Converts the PV of an SV to its UTF-8-encoded form.
3161 Forces the SV to string form if it is not already.
3162 Will C<mg_get> on C<sv> if appropriate.
3163 Always sets the SvUTF8 flag to avoid future validity checks even
3164 if the whole string is the same in UTF-8 as not.
3165 Returns the number of bytes in the converted string
3167 This is not as a general purpose byte encoding to Unicode interface:
3168 use the Encode extension for that.
3170 =for apidoc sv_utf8_upgrade_nomg
3172 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3174 =for apidoc sv_utf8_upgrade_flags
3176 Converts the PV of an SV to its UTF-8-encoded form.
3177 Forces the SV to string form if it is not already.
3178 Always sets the SvUTF8 flag to avoid future validity checks even
3179 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3180 will C<mg_get> on C<sv> if appropriate, else not.
3181 Returns the number of bytes in the converted string
3182 C<sv_utf8_upgrade> and
3183 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3185 This is not as a general purpose byte encoding to Unicode interface:
3186 use the Encode extension for that.
3190 The grow version is currently not externally documented. It adds a parameter,
3191 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3192 have free after it upon return. This allows the caller to reserve extra space
3193 that it intends to fill, to avoid extra grows.
3195 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3196 which can be used to tell this function to not first check to see if there are
3197 any characters that are different in UTF-8 (variant characters) which would
3198 force it to allocate a new string to sv, but to assume there are. Typically
3199 this flag is used by a routine that has already parsed the string to find that
3200 there are such characters, and passes this information on so that the work
3201 doesn't have to be repeated.
3203 (One might think that the calling routine could pass in the position of the
3204 first such variant, so it wouldn't have to be found again. But that is not the
3205 case, because typically when the caller is likely to use this flag, it won't be
3206 calling this routine unless it finds something that won't fit into a byte.
3207 Otherwise it tries to not upgrade and just use bytes. But some things that
3208 do fit into a byte are variants in utf8, and the caller may not have been
3209 keeping track of these.)
3211 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3212 isn't guaranteed due to having other routines do the work in some input cases,
3213 or if the input is already flagged as being in utf8.
3215 The speed of this could perhaps be improved for many cases if someone wanted to
3216 write a fast function that counts the number of variant characters in a string,
3217 especially if it could return the position of the first one.
3222 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3226 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3228 if (sv == &PL_sv_undef)
3232 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3233 (void) sv_2pv_flags(sv,&len, flags);
3235 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3239 (void) SvPV_force(sv,len);
3244 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3249 sv_force_normal_flags(sv, 0);
3252 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3253 sv_recode_to_utf8(sv, PL_encoding);
3254 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3258 if (SvCUR(sv) == 0) {
3259 if (extra) SvGROW(sv, extra);
3260 } else { /* Assume Latin-1/EBCDIC */
3261 /* This function could be much more efficient if we
3262 * had a FLAG in SVs to signal if there are any variant
3263 * chars in the PV. Given that there isn't such a flag
3264 * make the loop as fast as possible (although there are certainly ways
3265 * to speed this up, eg. through vectorization) */
3266 U8 * s = (U8 *) SvPVX_const(sv);
3267 U8 * e = (U8 *) SvEND(sv);
3269 STRLEN two_byte_count = 0;
3271 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3273 /* See if really will need to convert to utf8. We mustn't rely on our
3274 * incoming SV being well formed and having a trailing '\0', as certain
3275 * code in pp_formline can send us partially built SVs. */
3279 if (NATIVE_IS_INVARIANT(ch)) continue;
3281 t--; /* t already incremented; re-point to first variant */
3286 /* utf8 conversion not needed because all are invariants. Mark as
3287 * UTF-8 even if no variant - saves scanning loop */
3293 /* Here, the string should be converted to utf8, either because of an
3294 * input flag (two_byte_count = 0), or because a character that
3295 * requires 2 bytes was found (two_byte_count = 1). t points either to
3296 * the beginning of the string (if we didn't examine anything), or to
3297 * the first variant. In either case, everything from s to t - 1 will
3298 * occupy only 1 byte each on output.
3300 * There are two main ways to convert. One is to create a new string
3301 * and go through the input starting from the beginning, appending each
3302 * converted value onto the new string as we go along. It's probably
3303 * best to allocate enough space in the string for the worst possible
3304 * case rather than possibly running out of space and having to
3305 * reallocate and then copy what we've done so far. Since everything
3306 * from s to t - 1 is invariant, the destination can be initialized
3307 * with these using a fast memory copy
3309 * The other way is to figure out exactly how big the string should be
3310 * by parsing the entire input. Then you don't have to make it big
3311 * enough to handle the worst possible case, and more importantly, if
3312 * the string you already have is large enough, you don't have to
3313 * allocate a new string, you can copy the last character in the input
3314 * string to the final position(s) that will be occupied by the
3315 * converted string and go backwards, stopping at t, since everything
3316 * before that is invariant.
3318 * There are advantages and disadvantages to each method.
3320 * In the first method, we can allocate a new string, do the memory
3321 * copy from the s to t - 1, and then proceed through the rest of the
3322 * string byte-by-byte.
3324 * In the second method, we proceed through the rest of the input
3325 * string just calculating how big the converted string will be. Then
3326 * there are two cases:
3327 * 1) if the string has enough extra space to handle the converted
3328 * value. We go backwards through the string, converting until we
3329 * get to the position we are at now, and then stop. If this
3330 * position is far enough along in the string, this method is
3331 * faster than the other method. If the memory copy were the same
3332 * speed as the byte-by-byte loop, that position would be about
3333 * half-way, as at the half-way mark, parsing to the end and back
3334 * is one complete string's parse, the same amount as starting
3335 * over and going all the way through. Actually, it would be
3336 * somewhat less than half-way, as it's faster to just count bytes
3337 * than to also copy, and we don't have the overhead of allocating
3338 * a new string, changing the scalar to use it, and freeing the
3339 * existing one. But if the memory copy is fast, the break-even
3340 * point is somewhere after half way. The counting loop could be
3341 * sped up by vectorization, etc, to move the break-even point
3342 * further towards the beginning.
3343 * 2) if the string doesn't have enough space to handle the converted
3344 * value. A new string will have to be allocated, and one might
3345 * as well, given that, start from the beginning doing the first
3346 * method. We've spent extra time parsing the string and in
3347 * exchange all we've gotten is that we know precisely how big to
3348 * make the new one. Perl is more optimized for time than space,
3349 * so this case is a loser.
3350 * So what I've decided to do is not use the 2nd method unless it is
3351 * guaranteed that a new string won't have to be allocated, assuming
3352 * the worst case. I also decided not to put any more conditions on it
3353 * than this, for now. It seems likely that, since the worst case is
3354 * twice as big as the unknown portion of the string (plus 1), we won't
3355 * be guaranteed enough space, causing us to go to the first method,
3356 * unless the string is short, or the first variant character is near
3357 * the end of it. In either of these cases, it seems best to use the
3358 * 2nd method. The only circumstance I can think of where this would
3359 * be really slower is if the string had once had much more data in it
3360 * than it does now, but there is still a substantial amount in it */
3363 STRLEN invariant_head = t - s;
3364 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3365 if (SvLEN(sv) < size) {
3367 /* Here, have decided to allocate a new string */
3372 Newx(dst, size, U8);
3374 /* If no known invariants at the beginning of the input string,
3375 * set so starts from there. Otherwise, can use memory copy to
3376 * get up to where we are now, and then start from here */
3378 if (invariant_head <= 0) {
3381 Copy(s, dst, invariant_head, char);
3382 d = dst + invariant_head;
3386 const UV uv = NATIVE8_TO_UNI(*t++);
3387 if (UNI_IS_INVARIANT(uv))
3388 *d++ = (U8)UNI_TO_NATIVE(uv);
3390 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3391 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3395 SvPV_free(sv); /* No longer using pre-existing string */
3396 SvPV_set(sv, (char*)dst);
3397 SvCUR_set(sv, d - dst);
3398 SvLEN_set(sv, size);
3401 /* Here, have decided to get the exact size of the string.
3402 * Currently this happens only when we know that there is
3403 * guaranteed enough space to fit the converted string, so
3404 * don't have to worry about growing. If two_byte_count is 0,
3405 * then t points to the first byte of the string which hasn't
3406 * been examined yet. Otherwise two_byte_count is 1, and t
3407 * points to the first byte in the string that will expand to
3408 * two. Depending on this, start examining at t or 1 after t.
3411 U8 *d = t + two_byte_count;
3414 /* Count up the remaining bytes that expand to two */
3417 const U8 chr = *d++;
3418 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3421 /* The string will expand by just the number of bytes that
3422 * occupy two positions. But we are one afterwards because of
3423 * the increment just above. This is the place to put the
3424 * trailing NUL, and to set the length before we decrement */
3426 d += two_byte_count;
3427 SvCUR_set(sv, d - s);
3431 /* Having decremented d, it points to the position to put the
3432 * very last byte of the expanded string. Go backwards through
3433 * the string, copying and expanding as we go, stopping when we
3434 * get to the part that is invariant the rest of the way down */
3438 const U8 ch = NATIVE8_TO_UNI(*e--);
3439 if (UNI_IS_INVARIANT(ch)) {
3440 *d-- = UNI_TO_NATIVE(ch);
3442 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3443 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3450 /* Mark as UTF-8 even if no variant - saves scanning loop */
3456 =for apidoc sv_utf8_downgrade
3458 Attempts to convert the PV of an SV from characters to bytes.
3459 If the PV contains a character that cannot fit
3460 in a byte, this conversion will fail;
3461 in this case, either returns false or, if C<fail_ok> is not
3464 This is not as a general purpose Unicode to byte encoding interface:
3465 use the Encode extension for that.
3471 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3475 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3477 if (SvPOKp(sv) && SvUTF8(sv)) {
3483 sv_force_normal_flags(sv, 0);
3485 s = (U8 *) SvPV(sv, len);
3486 if (!utf8_to_bytes(s, &len)) {
3491 Perl_croak(aTHX_ "Wide character in %s",
3494 Perl_croak(aTHX_ "Wide character");
3505 =for apidoc sv_utf8_encode
3507 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3508 flag off so that it looks like octets again.
3514 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3516 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3519 sv_force_normal_flags(sv, 0);
3521 if (SvREADONLY(sv)) {
3522 Perl_croak(aTHX_ "%s", PL_no_modify);
3524 (void) sv_utf8_upgrade(sv);
3529 =for apidoc sv_utf8_decode
3531 If the PV of the SV is an octet sequence in UTF-8
3532 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3533 so that it looks like a character. If the PV contains only single-byte
3534 characters, the C<SvUTF8> flag stays being off.
3535 Scans PV for validity and returns false if the PV is invalid UTF-8.
3541 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3543 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3549 /* The octets may have got themselves encoded - get them back as
3552 if (!sv_utf8_downgrade(sv, TRUE))
3555 /* it is actually just a matter of turning the utf8 flag on, but
3556 * we want to make sure everything inside is valid utf8 first.
3558 c = (const U8 *) SvPVX_const(sv);
3559 if (!is_utf8_string(c, SvCUR(sv)+1))
3561 e = (const U8 *) SvEND(sv);
3564 if (!UTF8_IS_INVARIANT(ch)) {
3574 =for apidoc sv_setsv
3576 Copies the contents of the source SV C<ssv> into the destination SV
3577 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3578 function if the source SV needs to be reused. Does not handle 'set' magic.
3579 Loosely speaking, it performs a copy-by-value, obliterating any previous
3580 content of the destination.
3582 You probably want to use one of the assortment of wrappers, such as
3583 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3584 C<SvSetMagicSV_nosteal>.
3586 =for apidoc sv_setsv_flags
3588 Copies the contents of the source SV C<ssv> into the destination SV
3589 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3590 function if the source SV needs to be reused. Does not handle 'set' magic.
3591 Loosely speaking, it performs a copy-by-value, obliterating any previous
3592 content of the destination.
3593 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3594 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3595 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3596 and C<sv_setsv_nomg> are implemented in terms of this function.
3598 You probably want to use one of the assortment of wrappers, such as
3599 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3600 C<SvSetMagicSV_nosteal>.
3602 This is the primary function for copying scalars, and most other
3603 copy-ish functions and macros use this underneath.
3609 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3611 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3613 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3615 if (dtype != SVt_PVGV) {
3616 const char * const name = GvNAME(sstr);
3617 const STRLEN len = GvNAMELEN(sstr);
3619 if (dtype >= SVt_PV) {
3625 SvUPGRADE(dstr, SVt_PVGV);
3626 (void)SvOK_off(dstr);
3627 /* FIXME - why are we doing this, then turning it off and on again
3629 isGV_with_GP_on(dstr);
3631 GvSTASH(dstr) = GvSTASH(sstr);
3633 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3634 gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3635 SvFAKE_on(dstr); /* can coerce to non-glob */
3638 if(GvGP(MUTABLE_GV(sstr))) {
3639 /* If source has method cache entry, clear it */
3641 SvREFCNT_dec(GvCV(sstr));
3645 /* If source has a real method, then a method is
3647 else if(GvCV((const GV *)sstr)) {
3652 /* If dest already had a real method, that's a change as well */
3653 if(!mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)) {
3657 if(strEQ(GvNAME((const GV *)dstr),"ISA"))
3660 gp_free(MUTABLE_GV(dstr));
3661 isGV_with_GP_off(dstr);
3662 (void)SvOK_off(dstr);
3663 isGV_with_GP_on(dstr);
3664 GvINTRO_off(dstr); /* one-shot flag */
3665 GvGP(dstr) = gp_ref(GvGP(sstr));
3666 if (SvTAINTED(sstr))
3668 if (GvIMPORTED(dstr) != GVf_IMPORTED
3669 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3671 GvIMPORTED_on(dstr);
3674 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3675 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3680 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3682 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3684 const int intro = GvINTRO(dstr);
3687 const U32 stype = SvTYPE(sref);
3688 bool mro_changes = FALSE;
3690 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3693 GvINTRO_off(dstr); /* one-shot flag */
3694 GvLINE(dstr) = CopLINE(PL_curcop);
3695 GvEGV(dstr) = MUTABLE_GV(dstr);
3700 location = (SV **) &GvCV(dstr);
3701 import_flag = GVf_IMPORTED_CV;
3704 location = (SV **) &GvHV(dstr);
3705 import_flag = GVf_IMPORTED_HV;
3708 location = (SV **) &GvAV(dstr);
3709 if (strEQ(GvNAME((GV*)dstr), "ISA"))
3711 import_flag = GVf_IMPORTED_AV;
3714 location = (SV **) &GvIOp(dstr);
3717 location = (SV **) &GvFORM(dstr);
3720 location = &GvSV(dstr);
3721 import_flag = GVf_IMPORTED_SV;
3724 if (stype == SVt_PVCV) {
3725 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3726 if (GvCVGEN(dstr)) {
3727 SvREFCNT_dec(GvCV(dstr));
3729 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3732 SAVEGENERICSV(*location);
3736 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3737 CV* const cv = MUTABLE_CV(*location);
3739 if (!GvCVGEN((const GV *)dstr) &&
3740 (CvROOT(cv) || CvXSUB(cv)))
3742 /* Redefining a sub - warning is mandatory if
3743 it was a const and its value changed. */
3744 if (CvCONST(cv) && CvCONST((const CV *)sref)
3746 == cv_const_sv((const CV *)sref)) {
3748 /* They are 2 constant subroutines generated from
3749 the same constant. This probably means that
3750 they are really the "same" proxy subroutine
3751 instantiated in 2 places. Most likely this is
3752 when a constant is exported twice. Don't warn.
3755 else if (ckWARN(WARN_REDEFINE)
3757 && (!CvCONST((const CV *)sref)
3758 || sv_cmp(cv_const_sv(cv),
3759 cv_const_sv((const CV *)
3761 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3764 ? "Constant subroutine %s::%s redefined"
3765 : "Subroutine %s::%s redefined"),
3766 HvNAME_get(GvSTASH((const GV *)dstr)),
3767 GvENAME(MUTABLE_GV(dstr)));
3771 cv_ckproto_len(cv, (const GV *)dstr,
3772 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3773 SvPOK(sref) ? SvCUR(sref) : 0);
3775 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3776 GvASSUMECV_on(dstr);
3777 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3780 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3781 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3782 GvFLAGS(dstr) |= import_flag;
3787 if (SvTAINTED(sstr))
3789 if (mro_changes) mro_isa_changed_in(GvSTASH(dstr));
3794 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3797 register U32 sflags;
3799 register svtype stype;
3801 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3806 if (SvIS_FREED(dstr)) {
3807 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3808 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3810 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3812 sstr = &PL_sv_undef;
3813 if (SvIS_FREED(sstr)) {
3814 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3815 (void*)sstr, (void*)dstr);
3817 stype = SvTYPE(sstr);
3818 dtype = SvTYPE(dstr);
3820 (void)SvAMAGIC_off(dstr);
3823 /* need to nuke the magic */
3827 /* There's a lot of redundancy below but we're going for speed here */
3832 if (dtype != SVt_PVGV) {
3833 (void)SvOK_off(dstr);
3841 sv_upgrade(dstr, SVt_IV);
3845 sv_upgrade(dstr, SVt_PVIV);
3848 goto end_of_first_switch;
3850 (void)SvIOK_only(dstr);
3851 SvIV_set(dstr, SvIVX(sstr));
3854 /* SvTAINTED can only be true if the SV has taint magic, which in
3855 turn means that the SV type is PVMG (or greater). This is the
3856 case statement for SVt_IV, so this cannot be true (whatever gcov
3858 assert(!SvTAINTED(sstr));
3863 if (dtype < SVt_PV && dtype != SVt_IV)
3864 sv_upgrade(dstr, SVt_IV);
3872 sv_upgrade(dstr, SVt_NV);
3876 sv_upgrade(dstr, SVt_PVNV);
3879 goto end_of_first_switch;
3881 SvNV_set(dstr, SvNVX(sstr));
3882 (void)SvNOK_only(dstr);
3883 /* SvTAINTED can only be true if the SV has taint magic, which in
3884 turn means that the SV type is PVMG (or greater). This is the
3885 case statement for SVt_NV, so this cannot be true (whatever gcov
3887 assert(!SvTAINTED(sstr));
3893 #ifdef PERL_OLD_COPY_ON_WRITE
3894 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3895 if (dtype < SVt_PVIV)
3896 sv_upgrade(dstr, SVt_PVIV);
3903 sv_upgrade(dstr, SVt_PV);
3906 if (dtype < SVt_PVIV)
3907 sv_upgrade(dstr, SVt_PVIV);
3910 if (dtype < SVt_PVNV)
3911 sv_upgrade(dstr, SVt_PVNV);
3915 const char * const type = sv_reftype(sstr,0);
3917 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3919 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3924 if (dtype < SVt_REGEXP)
3925 sv_upgrade(dstr, SVt_REGEXP);
3928 /* case SVt_BIND: */
3931 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3932 glob_assign_glob(dstr, sstr, dtype);
3935 /* SvVALID means that this PVGV is playing at being an FBM. */
3939 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3941 if (SvTYPE(sstr) != stype) {
3942 stype = SvTYPE(sstr);
3943 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3944 glob_assign_glob(dstr, sstr, dtype);
3949 if (stype == SVt_PVLV)
3950 SvUPGRADE(dstr, SVt_PVNV);
3952 SvUPGRADE(dstr, (svtype)stype);
3954 end_of_first_switch:
3956 /* dstr may have been upgraded. */
3957 dtype = SvTYPE(dstr);
3958 sflags = SvFLAGS(sstr);
3960 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3961 /* Assigning to a subroutine sets the prototype. */
3964 const char *const ptr = SvPV_const(sstr, len);
3966 SvGROW(dstr, len + 1);
3967 Copy(ptr, SvPVX(dstr), len + 1, char);
3968 SvCUR_set(dstr, len);
3970 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3974 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3975 const char * const type = sv_reftype(dstr,0);
3977 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3979 Perl_croak(aTHX_ "Cannot copy to %s", type);
3980 } else if (sflags & SVf_ROK) {
3981 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3982 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3985 if (GvIMPORTED(dstr) != GVf_IMPORTED
3986 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3988 GvIMPORTED_on(dstr);
3993 glob_assign_glob(dstr, sstr, dtype);
3997 if (dtype >= SVt_PV) {
3998 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3999 glob_assign_ref(dstr, sstr);
4002 if (SvPVX_const(dstr)) {
4008 (void)SvOK_off(dstr);
4009 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4010 SvFLAGS(dstr) |= sflags & SVf_ROK;
4011 assert(!(sflags & SVp_NOK));
4012 assert(!(sflags & SVp_IOK));
4013 assert(!(sflags & SVf_NOK));
4014 assert(!(sflags & SVf_IOK));
4016 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
4017 if (!(sflags & SVf_OK)) {
4018 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4019 "Undefined value assigned to typeglob");
4022 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4023 if (dstr != (const SV *)gv) {
4025 gp_free(MUTABLE_GV(dstr));
4026 GvGP(dstr) = gp_ref(GvGP(gv));
4030 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4031 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4033 else if (sflags & SVp_POK) {
4037 * Check to see if we can just swipe the string. If so, it's a
4038 * possible small lose on short strings, but a big win on long ones.
4039 * It might even be a win on short strings if SvPVX_const(dstr)
4040 * has to be allocated and SvPVX_const(sstr) has to be freed.
4041 * Likewise if we can set up COW rather than doing an actual copy, we
4042 * drop to the else clause, as the swipe code and the COW setup code
4043 * have much in common.
4046 /* Whichever path we take through the next code, we want this true,
4047 and doing it now facilitates the COW check. */
4048 (void)SvPOK_only(dstr);
4051 /* If we're already COW then this clause is not true, and if COW
4052 is allowed then we drop down to the else and make dest COW
4053 with us. If caller hasn't said that we're allowed to COW
4054 shared hash keys then we don't do the COW setup, even if the
4055 source scalar is a shared hash key scalar. */
4056 (((flags & SV_COW_SHARED_HASH_KEYS)
4057 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4058 : 1 /* If making a COW copy is forbidden then the behaviour we
4059 desire is as if the source SV isn't actually already
4060 COW, even if it is. So we act as if the source flags
4061 are not COW, rather than actually testing them. */
4063 #ifndef PERL_OLD_COPY_ON_WRITE
4064 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4065 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4066 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4067 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4068 but in turn, it's somewhat dead code, never expected to go
4069 live, but more kept as a placeholder on how to do it better
4070 in a newer implementation. */
4071 /* If we are COW and dstr is a suitable target then we drop down
4072 into the else and make dest a COW of us. */
4073 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4078 (sflags & SVs_TEMP) && /* slated for free anyway? */
4079 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4080 (!(flags & SV_NOSTEAL)) &&
4081 /* and we're allowed to steal temps */
4082 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4083 SvLEN(sstr) && /* and really is a string */
4084 /* and won't be needed again, potentially */
4085 !(PL_op && PL_op->op_type == OP_AASSIGN))
4086 #ifdef PERL_OLD_COPY_ON_WRITE
4087 && ((flags & SV_COW_SHARED_HASH_KEYS)
4088 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4089 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4090 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4094 /* Failed the swipe test, and it's not a shared hash key either.
4095 Have to copy the string. */
4096 STRLEN len = SvCUR(sstr);
4097 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4098 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4099 SvCUR_set(dstr, len);
4100 *SvEND(dstr) = '\0';
4102 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4104 /* Either it's a shared hash key, or it's suitable for
4105 copy-on-write or we can swipe the string. */
4107 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4111 #ifdef PERL_OLD_COPY_ON_WRITE
4113 if ((sflags & (SVf_FAKE | SVf_READONLY))
4114 != (SVf_FAKE | SVf_READONLY)) {
4115 SvREADONLY_on(sstr);
4117 /* Make the source SV into a loop of 1.
4118 (about to become 2) */
4119 SV_COW_NEXT_SV_SET(sstr, sstr);
4123 /* Initial code is common. */
4124 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4129 /* making another shared SV. */
4130 STRLEN cur = SvCUR(sstr);
4131 STRLEN len = SvLEN(sstr);
4132 #ifdef PERL_OLD_COPY_ON_WRITE
4134 assert (SvTYPE(dstr) >= SVt_PVIV);
4135 /* SvIsCOW_normal */
4136 /* splice us in between source and next-after-source. */
4137 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4138 SV_COW_NEXT_SV_SET(sstr, dstr);
4139 SvPV_set(dstr, SvPVX_mutable(sstr));
4143 /* SvIsCOW_shared_hash */
4144 DEBUG_C(PerlIO_printf(Perl_debug_log,
4145 "Copy on write: Sharing hash\n"));
4147 assert (SvTYPE(dstr) >= SVt_PV);
4149 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4151 SvLEN_set(dstr, len);
4152 SvCUR_set(dstr, cur);
4153 SvREADONLY_on(dstr);
4157 { /* Passes the swipe test. */
4158 SvPV_set(dstr, SvPVX_mutable(sstr));
4159 SvLEN_set(dstr, SvLEN(sstr));
4160 SvCUR_set(dstr, SvCUR(sstr));
4163 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4164 SvPV_set(sstr, NULL);
4170 if (sflags & SVp_NOK) {
4171 SvNV_set(dstr, SvNVX(sstr));
4173 if (sflags & SVp_IOK) {
4174 SvIV_set(dstr, SvIVX(sstr));
4175 /* Must do this otherwise some other overloaded use of 0x80000000
4176 gets confused. I guess SVpbm_VALID */
4177 if (sflags & SVf_IVisUV)
4180 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4182 const MAGIC * const smg = SvVSTRING_mg(sstr);
4184 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4185 smg->mg_ptr, smg->mg_len);
4186 SvRMAGICAL_on(dstr);
4190 else if (sflags & (SVp_IOK|SVp_NOK)) {
4191 (void)SvOK_off(dstr);
4192 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4193 if (sflags & SVp_IOK) {
4194 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4195 SvIV_set(dstr, SvIVX(sstr));
4197 if (sflags & SVp_NOK) {
4198 SvNV_set(dstr, SvNVX(sstr));
4202 if (isGV_with_GP(sstr)) {
4203 /* This stringification rule for globs is spread in 3 places.
4204 This feels bad. FIXME. */
4205 const U32 wasfake = sflags & SVf_FAKE;
4207 /* FAKE globs can get coerced, so need to turn this off
4208 temporarily if it is on. */
4210 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4211 SvFLAGS(sstr) |= wasfake;
4214 (void)SvOK_off(dstr);
4216 if (SvTAINTED(sstr))
4221 =for apidoc sv_setsv_mg
4223 Like C<sv_setsv>, but also handles 'set' magic.
4229 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4231 PERL_ARGS_ASSERT_SV_SETSV_MG;
4233 sv_setsv(dstr,sstr);
4237 #ifdef PERL_OLD_COPY_ON_WRITE
4239 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4241 STRLEN cur = SvCUR(sstr);
4242 STRLEN len = SvLEN(sstr);
4243 register char *new_pv;
4245 PERL_ARGS_ASSERT_SV_SETSV_COW;
4248 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4249 (void*)sstr, (void*)dstr);
4256 if (SvTHINKFIRST(dstr))
4257 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4258 else if (SvPVX_const(dstr))
4259 Safefree(SvPVX_const(dstr));
4263 SvUPGRADE(dstr, SVt_PVIV);
4265 assert (SvPOK(sstr));
4266 assert (SvPOKp(sstr));
4267 assert (!SvIOK(sstr));
4268 assert (!SvIOKp(sstr));
4269 assert (!SvNOK(sstr));
4270 assert (!SvNOKp(sstr));
4272 if (SvIsCOW(sstr)) {
4274 if (SvLEN(sstr) == 0) {
4275 /* source is a COW shared hash key. */
4276 DEBUG_C(PerlIO_printf(Perl_debug_log,
4277 "Fast copy on write: Sharing hash\n"));
4278 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4281 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4283 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4284 SvUPGRADE(sstr, SVt_PVIV);
4285 SvREADONLY_on(sstr);
4287 DEBUG_C(PerlIO_printf(Perl_debug_log,
4288 "Fast copy on write: Converting sstr to COW\n"));
4289 SV_COW_NEXT_SV_SET(dstr, sstr);
4291 SV_COW_NEXT_SV_SET(sstr, dstr);
4292 new_pv = SvPVX_mutable(sstr);
4295 SvPV_set(dstr, new_pv);
4296 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4299 SvLEN_set(dstr, len);
4300 SvCUR_set(dstr, cur);
4309 =for apidoc sv_setpvn
4311 Copies a string into an SV. The C<len> parameter indicates the number of
4312 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4313 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4319 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4322 register char *dptr;
4324 PERL_ARGS_ASSERT_SV_SETPVN;
4326 SV_CHECK_THINKFIRST_COW_DROP(sv);
4332 /* len is STRLEN which is unsigned, need to copy to signed */
4335 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4337 SvUPGRADE(sv, SVt_PV);
4339 dptr = SvGROW(sv, len + 1);
4340 Move(ptr,dptr,len,char);
4343 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4348 =for apidoc sv_setpvn_mg
4350 Like C<sv_setpvn>, but also handles 'set' magic.
4356 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4358 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4360 sv_setpvn(sv,ptr,len);
4365 =for apidoc sv_setpv
4367 Copies a string into an SV. The string must be null-terminated. Does not
4368 handle 'set' magic. See C<sv_setpv_mg>.
4374 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4377 register STRLEN len;
4379 PERL_ARGS_ASSERT_SV_SETPV;
4381 SV_CHECK_THINKFIRST_COW_DROP(sv);
4387 SvUPGRADE(sv, SVt_PV);
4389 SvGROW(sv, len + 1);
4390 Move(ptr,SvPVX(sv),len+1,char);
4392 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4397 =for apidoc sv_setpv_mg
4399 Like C<sv_setpv>, but also handles 'set' magic.
4405 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4407 PERL_ARGS_ASSERT_SV_SETPV_MG;
4414 =for apidoc sv_usepvn_flags
4416 Tells an SV to use C<ptr> to find its string value. Normally the
4417 string is stored inside the SV but sv_usepvn allows the SV to use an
4418 outside string. The C<ptr> should point to memory that was allocated
4419 by C<malloc>. The string length, C<len>, must be supplied. By default
4420 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4421 so that pointer should not be freed or used by the programmer after
4422 giving it to sv_usepvn, and neither should any pointers from "behind"
4423 that pointer (e.g. ptr + 1) be used.
4425 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4426 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4427 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4428 C<len>, and already meets the requirements for storing in C<SvPVX>)
4434 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4439 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4441 SV_CHECK_THINKFIRST_COW_DROP(sv);
4442 SvUPGRADE(sv, SVt_PV);
4445 if (flags & SV_SMAGIC)
4449 if (SvPVX_const(sv))
4453 if (flags & SV_HAS_TRAILING_NUL)
4454 assert(ptr[len] == '\0');
4457 allocate = (flags & SV_HAS_TRAILING_NUL)
4459 #ifdef Perl_safesysmalloc_size
4462 PERL_STRLEN_ROUNDUP(len + 1);
4464 if (flags & SV_HAS_TRAILING_NUL) {
4465 /* It's long enough - do nothing.
4466 Specfically Perl_newCONSTSUB is relying on this. */
4469 /* Force a move to shake out bugs in callers. */
4470 char *new_ptr = (char*)safemalloc(allocate);
4471 Copy(ptr, new_ptr, len, char);
4472 PoisonFree(ptr,len,char);
4476 ptr = (char*) saferealloc (ptr, allocate);
4479 #ifdef Perl_safesysmalloc_size
4480 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4482 SvLEN_set(sv, allocate);
4486 if (!(flags & SV_HAS_TRAILING_NUL)) {
4489 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4491 if (flags & SV_SMAGIC)
4495 #ifdef PERL_OLD_COPY_ON_WRITE
4496 /* Need to do this *after* making the SV normal, as we need the buffer
4497 pointer to remain valid until after we've copied it. If we let go too early,
4498 another thread could invalidate it by unsharing last of the same hash key
4499 (which it can do by means other than releasing copy-on-write Svs)
4500 or by changing the other copy-on-write SVs in the loop. */
4502 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4504 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4506 { /* this SV was SvIsCOW_normal(sv) */
4507 /* we need to find the SV pointing to us. */
4508 SV *current = SV_COW_NEXT_SV(after);
4510 if (current == sv) {
4511 /* The SV we point to points back to us (there were only two of us
4513 Hence other SV is no longer copy on write either. */
4515 SvREADONLY_off(after);
4517 /* We need to follow the pointers around the loop. */
4519 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4522 /* don't loop forever if the structure is bust, and we have
4523 a pointer into a closed loop. */
4524 assert (current != after);
4525 assert (SvPVX_const(current) == pvx);
4527 /* Make the SV before us point to the SV after us. */
4528 SV_COW_NEXT_SV_SET(current, after);
4534 =for apidoc sv_force_normal_flags
4536 Undo various types of fakery on an SV: if the PV is a shared string, make
4537 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4538 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4539 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4540 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4541 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4542 set to some other value.) In addition, the C<flags> parameter gets passed to
4543 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4544 with flags set to 0.
4550 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4554 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4556 #ifdef PERL_OLD_COPY_ON_WRITE
4557 if (SvREADONLY(sv)) {
4559 const char * const pvx = SvPVX_const(sv);
4560 const STRLEN len = SvLEN(sv);
4561 const STRLEN cur = SvCUR(sv);
4562 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4563 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4564 we'll fail an assertion. */
4565 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4568 PerlIO_printf(Perl_debug_log,
4569 "Copy on write: Force normal %ld\n",
4575 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4578 if (flags & SV_COW_DROP_PV) {
4579 /* OK, so we don't need to copy our buffer. */
4582 SvGROW(sv, cur + 1);
4583 Move(pvx,SvPVX(sv),cur,char);
4588 sv_release_COW(sv, pvx, next);
4590 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4596 else if (IN_PERL_RUNTIME)
4597 Perl_croak(aTHX_ "%s", PL_no_modify);
4600 if (SvREADONLY(sv)) {
4602 const char * const pvx = SvPVX_const(sv);
4603 const STRLEN len = SvCUR(sv);
4608 SvGROW(sv, len + 1);
4609 Move(pvx,SvPVX(sv),len,char);
4611 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4613 else if (IN_PERL_RUNTIME)
4614 Perl_croak(aTHX_ "%s", PL_no_modify);
4618 sv_unref_flags(sv, flags);
4619 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4621 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4622 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analagous
4623 to sv_unglob. We only need it here, so inline it. */
4624 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4625 SV *const temp = newSV_type(new_type);
4626 void *const temp_p = SvANY(sv);
4628 if (new_type == SVt_PVMG) {
4629 SvMAGIC_set(temp, SvMAGIC(sv));
4630 SvMAGIC_set(sv, NULL);
4631 SvSTASH_set(temp, SvSTASH(sv));
4632 SvSTASH_set(sv, NULL);
4634 SvCUR_set(temp, SvCUR(sv));
4635 /* Remember that SvPVX is in the head, not the body. */
4637 SvLEN_set(temp, SvLEN(sv));
4638 /* This signals "buffer is owned by someone else" in sv_clear,
4639 which is the least effort way to stop it freeing the buffer.
4641 SvLEN_set(sv, SvLEN(sv)+1);
4643 /* Their buffer is already owned by someone else. */
4644 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4645 SvLEN_set(temp, SvCUR(sv)+1);
4648 /* Now swap the rest of the bodies. */
4650 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4651 SvFLAGS(sv) |= new_type;
4652 SvANY(sv) = SvANY(temp);
4654 SvFLAGS(temp) &= ~(SVTYPEMASK);
4655 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4656 SvANY(temp) = temp_p;
4665 Efficient removal of characters from the beginning of the string buffer.
4666 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4667 the string buffer. The C<ptr> becomes the first character of the adjusted
4668 string. Uses the "OOK hack".
4669 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4670 refer to the same chunk of data.
4676 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4682 const U8 *real_start;
4686 PERL_ARGS_ASSERT_SV_CHOP;
4688 if (!ptr || !SvPOKp(sv))
4690 delta = ptr - SvPVX_const(sv);
4692 /* Nothing to do. */
4695 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4696 nothing uses the value of ptr any more. */
4697 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4698 if (ptr <= SvPVX_const(sv))
4699 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4700 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4701 SV_CHECK_THINKFIRST(sv);
4702 if (delta > max_delta)
4703 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4704 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4705 SvPVX_const(sv) + max_delta);
4708 if (!SvLEN(sv)) { /* make copy of shared string */
4709 const char *pvx = SvPVX_const(sv);
4710 const STRLEN len = SvCUR(sv);
4711 SvGROW(sv, len + 1);
4712 Move(pvx,SvPVX(sv),len,char);
4715 SvFLAGS(sv) |= SVf_OOK;
4718 SvOOK_offset(sv, old_delta);
4720 SvLEN_set(sv, SvLEN(sv) - delta);
4721 SvCUR_set(sv, SvCUR(sv) - delta);
4722 SvPV_set(sv, SvPVX(sv) + delta);
4724 p = (U8 *)SvPVX_const(sv);
4729 real_start = p - delta;
4733 if (delta < 0x100) {
4737 p -= sizeof(STRLEN);
4738 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4742 /* Fill the preceding buffer with sentinals to verify that no-one is
4744 while (p > real_start) {
4752 =for apidoc sv_catpvn
4754 Concatenates the string onto the end of the string which is in the SV. The
4755 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4756 status set, then the bytes appended should be valid UTF-8.
4757 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4759 =for apidoc sv_catpvn_flags
4761 Concatenates the string onto the end of the string which is in the SV. The
4762 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4763 status set, then the bytes appended should be valid UTF-8.
4764 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4765 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4766 in terms of this function.
4772 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4776 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4778 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4780 SvGROW(dsv, dlen + slen + 1);
4782 sstr = SvPVX_const(dsv);
4783 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4784 SvCUR_set(dsv, SvCUR(dsv) + slen);
4786 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4788 if (flags & SV_SMAGIC)
4793 =for apidoc sv_catsv
4795 Concatenates the string from SV C<ssv> onto the end of the string in
4796 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4797 not 'set' magic. See C<sv_catsv_mg>.
4799 =for apidoc sv_catsv_flags
4801 Concatenates the string from SV C<ssv> onto the end of the string in
4802 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4803 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4804 and C<sv_catsv_nomg> are implemented in terms of this function.
4809 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4813 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4817 const char *spv = SvPV_const(ssv, slen);
4819 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4820 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4821 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4822 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4823 dsv->sv_flags doesn't have that bit set.
4824 Andy Dougherty 12 Oct 2001
4826 const I32 sutf8 = DO_UTF8(ssv);
4829 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4831 dutf8 = DO_UTF8(dsv);
4833 if (dutf8 != sutf8) {
4835 /* Not modifying source SV, so taking a temporary copy. */
4836 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4838 sv_utf8_upgrade(csv);
4839 spv = SvPV_const(csv, slen);
4842 /* Leave enough space for the cat that's about to happen */
4843 sv_utf8_upgrade_flags_grow(dsv, 0, slen);
4845 sv_catpvn_nomg(dsv, spv, slen);
4848 if (flags & SV_SMAGIC)
4853 =for apidoc sv_catpv
4855 Concatenates the string onto the end of the string which is in the SV.
4856 If the SV has the UTF-8 status set, then the bytes appended should be
4857 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4862 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4865 register STRLEN len;
4869 PERL_ARGS_ASSERT_SV_CATPV;
4873 junk = SvPV_force(sv, tlen);
4875 SvGROW(sv, tlen + len + 1);
4877 ptr = SvPVX_const(sv);
4878 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4879 SvCUR_set(sv, SvCUR(sv) + len);
4880 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4885 =for apidoc sv_catpv_mg
4887 Like C<sv_catpv>, but also handles 'set' magic.
4893 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4895 PERL_ARGS_ASSERT_SV_CATPV_MG;
4904 Creates a new SV. A non-zero C<len> parameter indicates the number of
4905 bytes of preallocated string space the SV should have. An extra byte for a
4906 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4907 space is allocated.) The reference count for the new SV is set to 1.
4909 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4910 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4911 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4912 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4913 modules supporting older perls.
4919 Perl_newSV(pTHX_ const STRLEN len)
4926 sv_upgrade(sv, SVt_PV);
4927 SvGROW(sv, len + 1);
4932 =for apidoc sv_magicext
4934 Adds magic to an SV, upgrading it if necessary. Applies the
4935 supplied vtable and returns a pointer to the magic added.
4937 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4938 In particular, you can add magic to SvREADONLY SVs, and add more than
4939 one instance of the same 'how'.
4941 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4942 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4943 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4944 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4946 (This is now used as a subroutine by C<sv_magic>.)
4951 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4952 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4957 PERL_ARGS_ASSERT_SV_MAGICEXT;
4959 SvUPGRADE(sv, SVt_PVMG);
4960 Newxz(mg, 1, MAGIC);
4961 mg->mg_moremagic = SvMAGIC(sv);
4962 SvMAGIC_set(sv, mg);
4964 /* Sometimes a magic contains a reference loop, where the sv and
4965 object refer to each other. To prevent a reference loop that
4966 would prevent such objects being freed, we look for such loops
4967 and if we find one we avoid incrementing the object refcount.
4969 Note we cannot do this to avoid self-tie loops as intervening RV must
4970 have its REFCNT incremented to keep it in existence.
4973 if (!obj || obj == sv ||
4974 how == PERL_MAGIC_arylen ||
4975 how == PERL_MAGIC_symtab ||
4976 (SvTYPE(obj) == SVt_PVGV &&
4977 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
4978 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
4979 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
4984 mg->mg_obj = SvREFCNT_inc_simple(obj);
4985 mg->mg_flags |= MGf_REFCOUNTED;
4988 /* Normal self-ties simply pass a null object, and instead of
4989 using mg_obj directly, use the SvTIED_obj macro to produce a
4990 new RV as needed. For glob "self-ties", we are tieing the PVIO
4991 with an RV obj pointing to the glob containing the PVIO. In
4992 this case, to avoid a reference loop, we need to weaken the
4996 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4997 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5003 mg->mg_len = namlen;
5006 mg->mg_ptr = savepvn(name, namlen);
5007 else if (namlen == HEf_SVKEY) {
5008 /* Yes, this is casting away const. This is only for the case of
5009 HEf_SVKEY. I think we need to document this abberation of the
5010 constness of the API, rather than making name non-const, as
5011 that change propagating outwards a long way. */
5012 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5014 mg->mg_ptr = (char *) name;
5016 mg->mg_virtual = (MGVTBL *) vtable;
5020 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5025 =for apidoc sv_magic
5027 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5028 then adds a new magic item of type C<how> to the head of the magic list.
5030 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5031 handling of the C<name> and C<namlen> arguments.
5033 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5034 to add more than one instance of the same 'how'.
5040 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5041 const char *const name, const I32 namlen)
5044 const MGVTBL *vtable;
5047 PERL_ARGS_ASSERT_SV_MAGIC;
5049 #ifdef PERL_OLD_COPY_ON_WRITE
5051 sv_force_normal_flags(sv, 0);
5053 if (SvREADONLY(sv)) {
5055 /* its okay to attach magic to shared strings; the subsequent
5056 * upgrade to PVMG will unshare the string */
5057 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5060 && how != PERL_MAGIC_regex_global
5061 && how != PERL_MAGIC_bm
5062 && how != PERL_MAGIC_fm
5063 && how != PERL_MAGIC_sv
5064 && how != PERL_MAGIC_backref
5067 Perl_croak(aTHX_ "%s", PL_no_modify);
5070 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5071 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5072 /* sv_magic() refuses to add a magic of the same 'how' as an
5075 if (how == PERL_MAGIC_taint) {
5077 /* Any scalar which already had taint magic on which someone
5078 (erroneously?) did SvIOK_on() or similar will now be
5079 incorrectly sporting public "OK" flags. */
5080 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5088 vtable = &PL_vtbl_sv;
5090 case PERL_MAGIC_overload:
5091 vtable = &PL_vtbl_amagic;
5093 case PERL_MAGIC_overload_elem:
5094 vtable = &PL_vtbl_amagicelem;
5096 case PERL_MAGIC_overload_table:
5097 vtable = &PL_vtbl_ovrld;
5100 vtable = &PL_vtbl_bm;
5102 case PERL_MAGIC_regdata:
5103 vtable = &PL_vtbl_regdata;
5105 case PERL_MAGIC_regdatum:
5106 vtable = &PL_vtbl_regdatum;
5108 case PERL_MAGIC_env:
5109 vtable = &PL_vtbl_env;
5112 vtable = &PL_vtbl_fm;
5114 case PERL_MAGIC_envelem:
5115 vtable = &PL_vtbl_envelem;
5117 case PERL_MAGIC_regex_global:
5118 vtable = &PL_vtbl_mglob;
5120 case PERL_MAGIC_isa:
5121 vtable = &PL_vtbl_isa;
5123 case PERL_MAGIC_isaelem:
5124 vtable = &PL_vtbl_isaelem;
5126 case PERL_MAGIC_nkeys:
5127 vtable = &PL_vtbl_nkeys;
5129 case PERL_MAGIC_dbfile:
5132 case PERL_MAGIC_dbline:
5133 vtable = &PL_vtbl_dbline;
5135 #ifdef USE_LOCALE_COLLATE
5136 case PERL_MAGIC_collxfrm:
5137 vtable = &PL_vtbl_collxfrm;
5139 #endif /* USE_LOCALE_COLLATE */
5140 case PERL_MAGIC_tied:
5141 vtable = &PL_vtbl_pack;
5143 case PERL_MAGIC_tiedelem:
5144 case PERL_MAGIC_tiedscalar:
5145 vtable = &PL_vtbl_packelem;
5148 vtable = &PL_vtbl_regexp;
5150 case PERL_MAGIC_sig:
5151 vtable = &PL_vtbl_sig;
5153 case PERL_MAGIC_sigelem:
5154 vtable = &PL_vtbl_sigelem;
5156 case PERL_MAGIC_taint:
5157 vtable = &PL_vtbl_taint;
5159 case PERL_MAGIC_uvar:
5160 vtable = &PL_vtbl_uvar;
5162 case PERL_MAGIC_vec:
5163 vtable = &PL_vtbl_vec;
5165 case PERL_MAGIC_arylen_p:
5166 case PERL_MAGIC_rhash:
5167 case PERL_MAGIC_symtab:
5168 case PERL_MAGIC_vstring:
5171 case PERL_MAGIC_utf8:
5172 vtable = &PL_vtbl_utf8;
5174 case PERL_MAGIC_substr:
5175 vtable = &PL_vtbl_substr;
5177 case PERL_MAGIC_defelem:
5178 vtable = &PL_vtbl_defelem;
5180 case PERL_MAGIC_arylen:
5181 vtable = &PL_vtbl_arylen;
5183 case PERL_MAGIC_pos:
5184 vtable = &PL_vtbl_pos;
5186 case PERL_MAGIC_backref:
5187 vtable = &PL_vtbl_backref;
5189 case PERL_MAGIC_hintselem:
5190 vtable = &PL_vtbl_hintselem;
5192 case PERL_MAGIC_hints:
5193 vtable = &PL_vtbl_hints;
5195 case PERL_MAGIC_ext:
5196 /* Reserved for use by extensions not perl internals. */
5197 /* Useful for attaching extension internal data to perl vars. */
5198 /* Note that multiple extensions may clash if magical scalars */
5199 /* etc holding private data from one are passed to another. */
5203 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5206 /* Rest of work is done else where */
5207 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5210 case PERL_MAGIC_taint:
5213 case PERL_MAGIC_ext:
5214 case PERL_MAGIC_dbfile:
5221 =for apidoc sv_unmagic
5223 Removes all magic of type C<type> from an SV.
5229 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5234 PERL_ARGS_ASSERT_SV_UNMAGIC;
5236 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5238 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5239 for (mg = *mgp; mg; mg = *mgp) {
5240 if (mg->mg_type == type) {
5241 const MGVTBL* const vtbl = mg->mg_virtual;
5242 *mgp = mg->mg_moremagic;
5243 if (vtbl && vtbl->svt_free)
5244 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5245 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5247 Safefree(mg->mg_ptr);
5248 else if (mg->mg_len == HEf_SVKEY)
5249 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5250 else if (mg->mg_type == PERL_MAGIC_utf8)
5251 Safefree(mg->mg_ptr);
5253 if (mg->mg_flags & MGf_REFCOUNTED)
5254 SvREFCNT_dec(mg->mg_obj);
5258 mgp = &mg->mg_moremagic;
5261 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5262 mg_magical(sv); /* else fix the flags now */
5266 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5272 =for apidoc sv_rvweaken
5274 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5275 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5276 push a back-reference to this RV onto the array of backreferences
5277 associated with that magic. If the RV is magical, set magic will be
5278 called after the RV is cleared.
5284 Perl_sv_rvweaken(pTHX_ SV *const sv)
5288 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5290 if (!SvOK(sv)) /* let undefs pass */
5293 Perl_croak(aTHX_ "Can't weaken a nonreference");
5294 else if (SvWEAKREF(sv)) {
5295 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5299 Perl_sv_add_backref(aTHX_ tsv, sv);
5305 /* Give tsv backref magic if it hasn't already got it, then push a
5306 * back-reference to sv onto the array associated with the backref magic.
5309 /* A discussion about the backreferences array and its refcount:
5311 * The AV holding the backreferences is pointed to either as the mg_obj of
5312 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5313 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5314 * have the standard magic instead.) The array is created with a refcount
5315 * of 2. This means that if during global destruction the array gets
5316 * picked on first to have its refcount decremented by the random zapper,
5317 * it won't actually be freed, meaning it's still theere for when its
5318 * parent gets freed.
5319 * When the parent SV is freed, in the case of magic, the magic is freed,
5320 * Perl_magic_killbackrefs is called which decrements one refcount, then
5321 * mg_obj is freed which kills the second count.
5322 * In the vase of a HV being freed, one ref is removed by
5323 * Perl_hv_kill_backrefs, the other by Perl_sv_kill_backrefs, which it
5328 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5333 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5335 if (SvTYPE(tsv) == SVt_PVHV) {
5336 AV **const avp = Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5340 /* There is no AV in the offical place - try a fixup. */
5341 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5344 /* Aha. They've got it stowed in magic. Bring it back. */
5345 av = MUTABLE_AV(mg->mg_obj);
5346 /* Stop mg_free decreasing the refernce count. */
5348 /* Stop mg_free even calling the destructor, given that
5349 there's no AV to free up. */
5351 sv_unmagic(tsv, PERL_MAGIC_backref);
5355 SvREFCNT_inc_simple_void(av); /* see discussion above */
5360 const MAGIC *const mg
5361 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5363 av = MUTABLE_AV(mg->mg_obj);
5367 sv_magic(tsv, MUTABLE_SV(av), PERL_MAGIC_backref, NULL, 0);
5368 /* av now has a refcnt of 2; see discussion above */
5371 if (AvFILLp(av) >= AvMAX(av)) {
5372 av_extend(av, AvFILLp(av)+1);
5374 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5377 /* delete a back-reference to ourselves from the backref magic associated
5378 * with the SV we point to.
5382 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5389 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5391 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5392 av = *Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5393 /* We mustn't attempt to "fix up" the hash here by moving the
5394 backreference array back to the hv_aux structure, as that is stored
5395 in the main HvARRAY(), and hfreentries assumes that no-one
5396 reallocates HvARRAY() while it is running. */
5399 const MAGIC *const mg
5400 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5402 av = MUTABLE_AV(mg->mg_obj);
5406 Perl_croak(aTHX_ "panic: del_backref");
5408 assert(!SvIS_FREED(av));
5411 /* We shouldn't be in here more than once, but for paranoia reasons lets
5413 for (i = AvFILLp(av); i >= 0; i--) {
5415 const SSize_t fill = AvFILLp(av);
5417 /* We weren't the last entry.
5418 An unordered list has this property that you can take the
5419 last element off the end to fill the hole, and it's still
5420 an unordered list :-)
5425 AvFILLp(av) = fill - 1;
5431 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5433 SV **svp = AvARRAY(av);
5435 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5436 PERL_UNUSED_ARG(sv);
5438 assert(!svp || !SvIS_FREED(av));
5440 SV *const *const last = svp + AvFILLp(av);
5442 while (svp <= last) {
5444 SV *const referrer = *svp;
5445 if (SvWEAKREF(referrer)) {
5446 /* XXX Should we check that it hasn't changed? */
5447 SvRV_set(referrer, 0);
5449 SvWEAKREF_off(referrer);
5450 SvSETMAGIC(referrer);
5451 } else if (SvTYPE(referrer) == SVt_PVGV ||
5452 SvTYPE(referrer) == SVt_PVLV) {
5453 /* You lookin' at me? */
5454 assert(GvSTASH(referrer));
5455 assert(GvSTASH(referrer) == (const HV *)sv);
5456 GvSTASH(referrer) = 0;
5459 "panic: magic_killbackrefs (flags=%"UVxf")",
5460 (UV)SvFLAGS(referrer));
5468 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5473 =for apidoc sv_insert
5475 Inserts a string at the specified offset/length within the SV. Similar to
5476 the Perl substr() function. Handles get magic.
5478 =for apidoc sv_insert_flags
5480 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5486 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5491 register char *midend;
5492 register char *bigend;
5496 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5499 Perl_croak(aTHX_ "Can't modify non-existent substring");
5500 SvPV_force_flags(bigstr, curlen, flags);
5501 (void)SvPOK_only_UTF8(bigstr);
5502 if (offset + len > curlen) {
5503 SvGROW(bigstr, offset+len+1);
5504 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5505 SvCUR_set(bigstr, offset+len);
5509 i = littlelen - len;
5510 if (i > 0) { /* string might grow */
5511 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5512 mid = big + offset + len;
5513 midend = bigend = big + SvCUR(bigstr);
5516 while (midend > mid) /* shove everything down */
5517 *--bigend = *--midend;
5518 Move(little,big+offset,littlelen,char);
5519 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5524 Move(little,SvPVX(bigstr)+offset,len,char);
5529 big = SvPVX(bigstr);
5532 bigend = big + SvCUR(bigstr);
5534 if (midend > bigend)
5535 Perl_croak(aTHX_ "panic: sv_insert");
5537 if (mid - big > bigend - midend) { /* faster to shorten from end */
5539 Move(little, mid, littlelen,char);
5542 i = bigend - midend;
5544 Move(midend, mid, i,char);
5548 SvCUR_set(bigstr, mid - big);
5550 else if ((i = mid - big)) { /* faster from front */
5551 midend -= littlelen;
5553 Move(big, midend - i, i, char);
5554 sv_chop(bigstr,midend-i);
5556 Move(little, mid, littlelen,char);
5558 else if (littlelen) {
5559 midend -= littlelen;
5560 sv_chop(bigstr,midend);
5561 Move(little,midend,littlelen,char);
5564 sv_chop(bigstr,midend);
5570 =for apidoc sv_replace
5572 Make the first argument a copy of the second, then delete the original.
5573 The target SV physically takes over ownership of the body of the source SV
5574 and inherits its flags; however, the target keeps any magic it owns,
5575 and any magic in the source is discarded.
5576 Note that this is a rather specialist SV copying operation; most of the
5577 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5583 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5586 const U32 refcnt = SvREFCNT(sv);
5588 PERL_ARGS_ASSERT_SV_REPLACE;
5590 SV_CHECK_THINKFIRST_COW_DROP(sv);
5591 if (SvREFCNT(nsv) != 1) {
5592 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5593 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5595 if (SvMAGICAL(sv)) {
5599 sv_upgrade(nsv, SVt_PVMG);
5600 SvMAGIC_set(nsv, SvMAGIC(sv));
5601 SvFLAGS(nsv) |= SvMAGICAL(sv);
5603 SvMAGIC_set(sv, NULL);
5607 assert(!SvREFCNT(sv));
5608 #ifdef DEBUG_LEAKING_SCALARS
5609 sv->sv_flags = nsv->sv_flags;
5610 sv->sv_any = nsv->sv_any;
5611 sv->sv_refcnt = nsv->sv_refcnt;
5612 sv->sv_u = nsv->sv_u;
5614 StructCopy(nsv,sv,SV);
5616 if(SvTYPE(sv) == SVt_IV) {
5618 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5622 #ifdef PERL_OLD_COPY_ON_WRITE
5623 if (SvIsCOW_normal(nsv)) {
5624 /* We need to follow the pointers around the loop to make the
5625 previous SV point to sv, rather than nsv. */
5628 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5631 assert(SvPVX_const(current) == SvPVX_const(nsv));
5633 /* Make the SV before us point to the SV after us. */
5635 PerlIO_printf(Perl_debug_log, "previous is\n");
5637 PerlIO_printf(Perl_debug_log,
5638 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5639 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5641 SV_COW_NEXT_SV_SET(current, sv);
5644 SvREFCNT(sv) = refcnt;
5645 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5651 =for apidoc sv_clear
5653 Clear an SV: call any destructors, free up any memory used by the body,
5654 and free the body itself. The SV's head is I<not> freed, although
5655 its type is set to all 1's so that it won't inadvertently be assumed
5656 to be live during global destruction etc.
5657 This function should only be called when REFCNT is zero. Most of the time
5658 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5665 Perl_sv_clear(pTHX_ register SV *const sv)
5668 const U32 type = SvTYPE(sv);
5669 const struct body_details *const sv_type_details
5670 = bodies_by_type + type;
5673 PERL_ARGS_ASSERT_SV_CLEAR;
5674 assert(SvREFCNT(sv) == 0);
5675 assert(SvTYPE(sv) != SVTYPEMASK);
5677 if (type <= SVt_IV) {
5678 /* See the comment in sv.h about the collusion between this early
5679 return and the overloading of the NULL and IV slots in the size
5682 SV * const target = SvRV(sv);
5684 sv_del_backref(target, sv);
5686 SvREFCNT_dec(target);
5688 SvFLAGS(sv) &= SVf_BREAK;
5689 SvFLAGS(sv) |= SVTYPEMASK;
5694 if (PL_defstash && /* Still have a symbol table? */
5701 stash = SvSTASH(sv);
5702 destructor = StashHANDLER(stash,DESTROY);
5704 /* A constant subroutine can have no side effects, so
5705 don't bother calling it. */
5706 && !CvCONST(destructor)
5707 /* Don't bother calling an empty destructor */
5708 && (CvISXSUB(destructor)
5709 || (CvSTART(destructor)
5710 && (CvSTART(destructor)->op_next->op_type != OP_LEAVESUB))))
5712 SV* const tmpref = newRV(sv);
5713 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5715 PUSHSTACKi(PERLSI_DESTROY);
5720 call_sv(MUTABLE_SV(destructor), G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5726 if(SvREFCNT(tmpref) < 2) {
5727 /* tmpref is not kept alive! */
5729 SvRV_set(tmpref, NULL);
5732 SvREFCNT_dec(tmpref);
5734 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5738 if (PL_in_clean_objs)
5739 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5741 /* DESTROY gave object new lease on life */
5747 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5748 SvOBJECT_off(sv); /* Curse the object. */
5749 if (type != SVt_PVIO)
5750 --PL_sv_objcount; /* XXX Might want something more general */
5753 if (type >= SVt_PVMG) {
5754 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5755 SvREFCNT_dec(SvOURSTASH(sv));
5756 } else if (SvMAGIC(sv))
5758 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5759 SvREFCNT_dec(SvSTASH(sv));
5762 /* case SVt_BIND: */
5765 IoIFP(sv) != PerlIO_stdin() &&
5766 IoIFP(sv) != PerlIO_stdout() &&
5767 IoIFP(sv) != PerlIO_stderr())
5769 io_close(MUTABLE_IO(sv), FALSE);
5771 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5772 PerlDir_close(IoDIRP(sv));
5773 IoDIRP(sv) = (DIR*)NULL;
5774 Safefree(IoTOP_NAME(sv));
5775 Safefree(IoFMT_NAME(sv));
5776 Safefree(IoBOTTOM_NAME(sv));
5779 /* FIXME for plugins */
5780 pregfree2((REGEXP*) sv);
5784 cv_undef(MUTABLE_CV(sv));
5787 if (PL_last_swash_hv == (const HV *)sv) {
5788 PL_last_swash_hv = NULL;
5790 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5791 hv_undef(MUTABLE_HV(sv));
5794 if (PL_comppad == MUTABLE_AV(sv)) {
5798 av_undef(MUTABLE_AV(sv));
5801 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5802 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5803 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5804 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5806 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5807 SvREFCNT_dec(LvTARG(sv));
5809 if (isGV_with_GP(sv)) {
5810 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
5811 && HvNAME_get(stash))
5812 mro_method_changed_in(stash);
5813 gp_free(MUTABLE_GV(sv));
5815 unshare_hek(GvNAME_HEK(sv));
5816 /* If we're in a stash, we don't own a reference to it. However it does
5817 have a back reference to us, which needs to be cleared. */
5818 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5819 sv_del_backref(MUTABLE_SV(stash), sv);
5821 /* FIXME. There are probably more unreferenced pointers to SVs in the
5822 interpreter struct that we should check and tidy in a similar
5824 if ((const GV *)sv == PL_last_in_gv)
5825 PL_last_in_gv = NULL;
5831 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5834 SvOOK_offset(sv, offset);
5835 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5836 /* Don't even bother with turning off the OOK flag. */
5839 SV * const target = SvRV(sv);
5841 sv_del_backref(target, sv);
5843 SvREFCNT_dec(target);
5845 #ifdef PERL_OLD_COPY_ON_WRITE
5846 else if (SvPVX_const(sv)) {
5849 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5853 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5855 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5859 } else if (SvLEN(sv)) {
5860 Safefree(SvPVX_const(sv));
5864 else if (SvPVX_const(sv) && SvLEN(sv))
5865 Safefree(SvPVX_mutable(sv));
5866 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5867 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5876 SvFLAGS(sv) &= SVf_BREAK;
5877 SvFLAGS(sv) |= SVTYPEMASK;
5879 if (sv_type_details->arena) {
5880 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5881 &PL_body_roots[type]);
5883 else if (sv_type_details->body_size) {
5884 my_safefree(SvANY(sv));
5889 =for apidoc sv_newref
5891 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5898 Perl_sv_newref(pTHX_ SV *const sv)
5900 PERL_UNUSED_CONTEXT;
5909 Decrement an SV's reference count, and if it drops to zero, call
5910 C<sv_clear> to invoke destructors and free up any memory used by
5911 the body; finally, deallocate the SV's head itself.
5912 Normally called via a wrapper macro C<SvREFCNT_dec>.
5918 Perl_sv_free(pTHX_ SV *const sv)
5923 if (SvREFCNT(sv) == 0) {
5924 if (SvFLAGS(sv) & SVf_BREAK)
5925 /* this SV's refcnt has been artificially decremented to
5926 * trigger cleanup */
5928 if (PL_in_clean_all) /* All is fair */
5930 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5931 /* make sure SvREFCNT(sv)==0 happens very seldom */
5932 SvREFCNT(sv) = (~(U32)0)/2;
5935 if (ckWARN_d(WARN_INTERNAL)) {
5936 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5937 Perl_dump_sv_child(aTHX_ sv);
5939 #ifdef DEBUG_LEAKING_SCALARS
5942 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5943 if (PL_warnhook == PERL_WARNHOOK_FATAL
5944 || ckDEAD(packWARN(WARN_INTERNAL))) {
5945 /* Don't let Perl_warner cause us to escape our fate: */
5949 /* This may not return: */
5950 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5951 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5952 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5955 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5960 if (--(SvREFCNT(sv)) > 0)
5962 Perl_sv_free2(aTHX_ sv);
5966 Perl_sv_free2(pTHX_ SV *const sv)
5970 PERL_ARGS_ASSERT_SV_FREE2;
5974 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
5975 "Attempt to free temp prematurely: SV 0x%"UVxf
5976 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5980 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5981 /* make sure SvREFCNT(sv)==0 happens very seldom */
5982 SvREFCNT(sv) = (~(U32)0)/2;
5993 Returns the length of the string in the SV. Handles magic and type
5994 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6000 Perl_sv_len(pTHX_ register SV *const sv)
6008 len = mg_length(sv);
6010 (void)SvPV_const(sv, len);
6015 =for apidoc sv_len_utf8
6017 Returns the number of characters in the string in an SV, counting wide
6018 UTF-8 bytes as a single character. Handles magic and type coercion.
6024 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6025 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6026 * (Note that the mg_len is not the length of the mg_ptr field.
6027 * This allows the cache to store the character length of the string without
6028 * needing to malloc() extra storage to attach to the mg_ptr.)
6033 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6039 return mg_length(sv);
6043 const U8 *s = (U8*)SvPV_const(sv, len);
6047 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6049 if (mg && mg->mg_len != -1) {
6051 if (PL_utf8cache < 0) {
6052 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6054 /* Need to turn the assertions off otherwise we may
6055 recurse infinitely while printing error messages.
6057 SAVEI8(PL_utf8cache);
6059 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
6060 " real %"UVuf" for %"SVf,
6061 (UV) ulen, (UV) real, SVfARG(sv));
6066 ulen = Perl_utf8_length(aTHX_ s, s + len);
6067 if (!SvREADONLY(sv)) {
6068 if (!mg && (SvTYPE(sv) < SVt_PVMG ||
6069 !(mg = mg_find(sv, PERL_MAGIC_utf8)))) {
6070 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
6071 &PL_vtbl_utf8, 0, 0);
6079 return Perl_utf8_length(aTHX_ s, s + len);
6083 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6086 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6089 const U8 *s = start;
6091 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6093 while (s < send && uoffset--)
6096 /* This is the existing behaviour. Possibly it should be a croak, as
6097 it's actually a bounds error */
6103 /* Given the length of the string in both bytes and UTF-8 characters, decide
6104 whether to walk forwards or backwards to find the byte corresponding to
6105 the passed in UTF-8 offset. */
6107 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6108 const STRLEN uoffset, const STRLEN uend)
6110 STRLEN backw = uend - uoffset;
6112 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6114 if (uoffset < 2 * backw) {
6115 /* The assumption is that going forwards is twice the speed of going
6116 forward (that's where the 2 * backw comes from).
6117 (The real figure of course depends on the UTF-8 data.) */
6118 return sv_pos_u2b_forwards(start, send, uoffset);
6123 while (UTF8_IS_CONTINUATION(*send))
6126 return send - start;
6129 /* For the string representation of the given scalar, find the byte
6130 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6131 give another position in the string, *before* the sought offset, which
6132 (which is always true, as 0, 0 is a valid pair of positions), which should
6133 help reduce the amount of linear searching.
6134 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6135 will be used to reduce the amount of linear searching. The cache will be
6136 created if necessary, and the found value offered to it for update. */
6138 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6139 const U8 *const send, const STRLEN uoffset,
6140 STRLEN uoffset0, STRLEN boffset0)
6142 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6145 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6147 assert (uoffset >= uoffset0);
6151 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6152 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6153 if ((*mgp)->mg_ptr) {
6154 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6155 if (cache[0] == uoffset) {
6156 /* An exact match. */
6159 if (cache[2] == uoffset) {
6160 /* An exact match. */
6164 if (cache[0] < uoffset) {
6165 /* The cache already knows part of the way. */
6166 if (cache[0] > uoffset0) {
6167 /* The cache knows more than the passed in pair */
6168 uoffset0 = cache[0];
6169 boffset0 = cache[1];
6171 if ((*mgp)->mg_len != -1) {
6172 /* And we know the end too. */
6174 + sv_pos_u2b_midway(start + boffset0, send,
6176 (*mgp)->mg_len - uoffset0);
6179 + sv_pos_u2b_forwards(start + boffset0,
6180 send, uoffset - uoffset0);
6183 else if (cache[2] < uoffset) {
6184 /* We're between the two cache entries. */
6185 if (cache[2] > uoffset0) {
6186 /* and the cache knows more than the passed in pair */
6187 uoffset0 = cache[2];
6188 boffset0 = cache[3];
6192 + sv_pos_u2b_midway(start + boffset0,
6195 cache[0] - uoffset0);
6198 + sv_pos_u2b_midway(start + boffset0,
6201 cache[2] - uoffset0);
6205 else if ((*mgp)->mg_len != -1) {
6206 /* If we can take advantage of a passed in offset, do so. */
6207 /* In fact, offset0 is either 0, or less than offset, so don't
6208 need to worry about the other possibility. */
6210 + sv_pos_u2b_midway(start + boffset0, send,
6212 (*mgp)->mg_len - uoffset0);
6217 if (!found || PL_utf8cache < 0) {
6218 const STRLEN real_boffset
6219 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6220 send, uoffset - uoffset0);
6222 if (found && PL_utf8cache < 0) {
6223 if (real_boffset != boffset) {
6224 /* Need to turn the assertions off otherwise we may recurse
6225 infinitely while printing error messages. */
6226 SAVEI8(PL_utf8cache);
6228 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
6229 " real %"UVuf" for %"SVf,
6230 (UV) boffset, (UV) real_boffset, SVfARG(sv));
6233 boffset = real_boffset;
6237 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6243 =for apidoc sv_pos_u2b_flags
6245 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6246 the start of the string, to a count of the equivalent number of bytes; if
6247 lenp is non-zero, it does the same to lenp, but this time starting from
6248 the offset, rather than from the start of the string. Handles type coercion.
6249 I<flags> is passed to C<SvPV_flags>, and usually should be
6250 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6256 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6257 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6258 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6263 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6270 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6272 start = (U8*)SvPV_flags(sv, len, flags);
6274 const U8 * const send = start + len;
6276 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6279 /* Convert the relative offset to absolute. */
6280 const STRLEN uoffset2 = uoffset + *lenp;
6281 const STRLEN boffset2
6282 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6283 uoffset, boffset) - boffset;
6297 =for apidoc sv_pos_u2b
6299 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6300 the start of the string, to a count of the equivalent number of bytes; if
6301 lenp is non-zero, it does the same to lenp, but this time starting from
6302 the offset, rather than from the start of the string. Handles magic and
6305 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6312 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6313 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6314 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6318 /* This function is subject to size and sign problems */
6321 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6323 STRLEN uoffset = (STRLEN)*offsetp;
6325 PERL_ARGS_ASSERT_SV_POS_U2B;
6328 STRLEN ulen = (STRLEN)*lenp;
6329 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6330 SV_GMAGIC|SV_CONST_RETURN);
6333 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6334 SV_GMAGIC|SV_CONST_RETURN);
6338 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6339 byte length pairing. The (byte) length of the total SV is passed in too,
6340 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6341 may not have updated SvCUR, so we can't rely on reading it directly.
6343 The proffered utf8/byte length pairing isn't used if the cache already has
6344 two pairs, and swapping either for the proffered pair would increase the
6345 RMS of the intervals between known byte offsets.
6347 The cache itself consists of 4 STRLEN values
6348 0: larger UTF-8 offset
6349 1: corresponding byte offset
6350 2: smaller UTF-8 offset
6351 3: corresponding byte offset
6353 Unused cache pairs have the value 0, 0.
6354 Keeping the cache "backwards" means that the invariant of
6355 cache[0] >= cache[2] is maintained even with empty slots, which means that
6356 the code that uses it doesn't need to worry if only 1 entry has actually
6357 been set to non-zero. It also makes the "position beyond the end of the
6358 cache" logic much simpler, as the first slot is always the one to start
6362 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6363 const STRLEN utf8, const STRLEN blen)
6367 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6372 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6373 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6374 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6376 (*mgp)->mg_len = -1;
6380 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6381 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6382 (*mgp)->mg_ptr = (char *) cache;
6386 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6387 /* SvPOKp() because it's possible that sv has string overloading, and
6388 therefore is a reference, hence SvPVX() is actually a pointer.
6389 This cures the (very real) symptoms of RT 69422, but I'm not actually
6390 sure whether we should even be caching the results of UTF-8
6391 operations on overloading, given that nothing stops overloading
6392 returning a different value every time it's called. */
6393 const U8 *start = (const U8 *) SvPVX_const(sv);
6394 const STRLEN realutf8 = utf8_length(start, start + byte);
6396 if (realutf8 != utf8) {
6397 /* Need to turn the assertions off otherwise we may recurse
6398 infinitely while printing error messages. */
6399 SAVEI8(PL_utf8cache);
6401 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6402 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6406 /* Cache is held with the later position first, to simplify the code
6407 that deals with unbounded ends. */
6409 ASSERT_UTF8_CACHE(cache);
6410 if (cache[1] == 0) {
6411 /* Cache is totally empty */
6414 } else if (cache[3] == 0) {
6415 if (byte > cache[1]) {
6416 /* New one is larger, so goes first. */
6417 cache[2] = cache[0];
6418 cache[3] = cache[1];
6426 #define THREEWAY_SQUARE(a,b,c,d) \
6427 ((float)((d) - (c))) * ((float)((d) - (c))) \
6428 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6429 + ((float)((b) - (a))) * ((float)((b) - (a)))
6431 /* Cache has 2 slots in use, and we know three potential pairs.
6432 Keep the two that give the lowest RMS distance. Do the
6433 calcualation in bytes simply because we always know the byte
6434 length. squareroot has the same ordering as the positive value,
6435 so don't bother with the actual square root. */
6436 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6437 if (byte > cache[1]) {
6438 /* New position is after the existing pair of pairs. */
6439 const float keep_earlier
6440 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6441 const float keep_later
6442 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6444 if (keep_later < keep_earlier) {
6445 if (keep_later < existing) {
6446 cache[2] = cache[0];
6447 cache[3] = cache[1];
6453 if (keep_earlier < existing) {
6459 else if (byte > cache[3]) {
6460 /* New position is between the existing pair of pairs. */
6461 const float keep_earlier
6462 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6463 const float keep_later
6464 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6466 if (keep_later < keep_earlier) {
6467 if (keep_later < existing) {
6473 if (keep_earlier < existing) {
6480 /* New position is before the existing pair of pairs. */
6481 const float keep_earlier
6482 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6483 const float keep_later
6484 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6486 if (keep_later < keep_earlier) {
6487 if (keep_later < existing) {
6493 if (keep_earlier < existing) {
6494 cache[0] = cache[2];
6495 cache[1] = cache[3];
6502 ASSERT_UTF8_CACHE(cache);
6505 /* We already know all of the way, now we may be able to walk back. The same
6506 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6507 backward is half the speed of walking forward. */
6509 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6510 const U8 *end, STRLEN endu)
6512 const STRLEN forw = target - s;
6513 STRLEN backw = end - target;
6515 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6517 if (forw < 2 * backw) {
6518 return utf8_length(s, target);
6521 while (end > target) {
6523 while (UTF8_IS_CONTINUATION(*end)) {
6532 =for apidoc sv_pos_b2u
6534 Converts the value pointed to by offsetp from a count of bytes from the
6535 start of the string, to a count of the equivalent number of UTF-8 chars.
6536 Handles magic and type coercion.
6542 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6543 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6548 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6551 const STRLEN byte = *offsetp;
6552 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6558 PERL_ARGS_ASSERT_SV_POS_B2U;
6563 s = (const U8*)SvPV_const(sv, blen);
6566 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6572 && SvTYPE(sv) >= SVt_PVMG
6573 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
6576 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6577 if (cache[1] == byte) {
6578 /* An exact match. */
6579 *offsetp = cache[0];
6582 if (cache[3] == byte) {
6583 /* An exact match. */
6584 *offsetp = cache[2];
6588 if (cache[1] < byte) {
6589 /* We already know part of the way. */
6590 if (mg->mg_len != -1) {
6591 /* Actually, we know the end too. */
6593 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6594 s + blen, mg->mg_len - cache[0]);
6596 len = cache[0] + utf8_length(s + cache[1], send);
6599 else if (cache[3] < byte) {
6600 /* We're between the two cached pairs, so we do the calculation
6601 offset by the byte/utf-8 positions for the earlier pair,
6602 then add the utf-8 characters from the string start to
6604 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6605 s + cache[1], cache[0] - cache[2])
6609 else { /* cache[3] > byte */
6610 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6614 ASSERT_UTF8_CACHE(cache);
6616 } else if (mg->mg_len != -1) {
6617 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6621 if (!found || PL_utf8cache < 0) {
6622 const STRLEN real_len = utf8_length(s, send);
6624 if (found && PL_utf8cache < 0) {
6625 if (len != real_len) {
6626 /* Need to turn the assertions off otherwise we may recurse
6627 infinitely while printing error messages. */
6628 SAVEI8(PL_utf8cache);
6630 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6631 " real %"UVuf" for %"SVf,
6632 (UV) len, (UV) real_len, SVfARG(sv));
6640 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6646 Returns a boolean indicating whether the strings in the two SVs are
6647 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6648 coerce its args to strings if necessary.
6654 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6663 SV* svrecode = NULL;
6670 /* if pv1 and pv2 are the same, second SvPV_const call may
6671 * invalidate pv1, so we may need to make a copy */
6672 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6673 pv1 = SvPV_const(sv1, cur1);
6674 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6676 pv1 = SvPV_const(sv1, cur1);
6684 pv2 = SvPV_const(sv2, cur2);
6686 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6687 /* Differing utf8ness.
6688 * Do not UTF8size the comparands as a side-effect. */
6691 svrecode = newSVpvn(pv2, cur2);
6692 sv_recode_to_utf8(svrecode, PL_encoding);
6693 pv2 = SvPV_const(svrecode, cur2);
6696 svrecode = newSVpvn(pv1, cur1);
6697 sv_recode_to_utf8(svrecode, PL_encoding);
6698 pv1 = SvPV_const(svrecode, cur1);
6700 /* Now both are in UTF-8. */
6702 SvREFCNT_dec(svrecode);
6707 bool is_utf8 = TRUE;
6710 /* sv1 is the UTF-8 one,
6711 * if is equal it must be downgrade-able */
6712 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6718 /* sv2 is the UTF-8 one,
6719 * if is equal it must be downgrade-able */
6720 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6726 /* Downgrade not possible - cannot be eq */
6734 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6736 SvREFCNT_dec(svrecode);
6746 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6747 string in C<sv1> is less than, equal to, or greater than the string in
6748 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6749 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6755 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6759 const char *pv1, *pv2;
6762 SV *svrecode = NULL;
6769 pv1 = SvPV_const(sv1, cur1);
6776 pv2 = SvPV_const(sv2, cur2);
6778 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6779 /* Differing utf8ness.
6780 * Do not UTF8size the comparands as a side-effect. */
6783 svrecode = newSVpvn(pv2, cur2);
6784 sv_recode_to_utf8(svrecode, PL_encoding);
6785 pv2 = SvPV_const(svrecode, cur2);
6788 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6793 svrecode = newSVpvn(pv1, cur1);
6794 sv_recode_to_utf8(svrecode, PL_encoding);
6795 pv1 = SvPV_const(svrecode, cur1);
6798 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6804 cmp = cur2 ? -1 : 0;
6808 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6811 cmp = retval < 0 ? -1 : 1;
6812 } else if (cur1 == cur2) {
6815 cmp = cur1 < cur2 ? -1 : 1;
6819 SvREFCNT_dec(svrecode);
6827 =for apidoc sv_cmp_locale
6829 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6830 'use bytes' aware, handles get magic, and will coerce its args to strings
6831 if necessary. See also C<sv_cmp>.
6837 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6840 #ifdef USE_LOCALE_COLLATE
6846 if (PL_collation_standard)
6850 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6852 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6854 if (!pv1 || !len1) {
6865 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6868 return retval < 0 ? -1 : 1;
6871 * When the result of collation is equality, that doesn't mean
6872 * that there are no differences -- some locales exclude some
6873 * characters from consideration. So to avoid false equalities,
6874 * we use the raw string as a tiebreaker.
6880 #endif /* USE_LOCALE_COLLATE */
6882 return sv_cmp(sv1, sv2);
6886 #ifdef USE_LOCALE_COLLATE
6889 =for apidoc sv_collxfrm
6891 Add Collate Transform magic to an SV if it doesn't already have it.
6893 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6894 scalar data of the variable, but transformed to such a format that a normal
6895 memory comparison can be used to compare the data according to the locale
6902 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6907 PERL_ARGS_ASSERT_SV_COLLXFRM;
6909 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6910 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6916 Safefree(mg->mg_ptr);
6917 s = SvPV_const(sv, len);
6918 if ((xf = mem_collxfrm(s, len, &xlen))) {
6920 #ifdef PERL_OLD_COPY_ON_WRITE
6922 sv_force_normal_flags(sv, 0);
6924 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6938 if (mg && mg->mg_ptr) {
6940 return mg->mg_ptr + sizeof(PL_collation_ix);
6948 #endif /* USE_LOCALE_COLLATE */
6953 Get a line from the filehandle and store it into the SV, optionally
6954 appending to the currently-stored string.
6960 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6965 register STDCHAR rslast;
6966 register STDCHAR *bp;
6971 PERL_ARGS_ASSERT_SV_GETS;
6973 if (SvTHINKFIRST(sv))
6974 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6975 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6977 However, perlbench says it's slower, because the existing swipe code
6978 is faster than copy on write.
6979 Swings and roundabouts. */
6980 SvUPGRADE(sv, SVt_PV);
6985 if (PerlIO_isutf8(fp)) {
6987 sv_utf8_upgrade_nomg(sv);
6988 sv_pos_u2b(sv,&append,0);
6990 } else if (SvUTF8(sv)) {
6991 SV * const tsv = newSV(0);
6992 sv_gets(tsv, fp, 0);
6993 sv_utf8_upgrade_nomg(tsv);
6994 SvCUR_set(sv,append);
6997 goto return_string_or_null;
7002 if (PerlIO_isutf8(fp))
7005 if (IN_PERL_COMPILETIME) {
7006 /* we always read code in line mode */
7010 else if (RsSNARF(PL_rs)) {
7011 /* If it is a regular disk file use size from stat() as estimate
7012 of amount we are going to read -- may result in mallocing
7013 more memory than we really need if the layers below reduce
7014 the size we read (e.g. CRLF or a gzip layer).
7017 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7018 const Off_t offset = PerlIO_tell(fp);
7019 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7020 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7026 else if (RsRECORD(PL_rs)) {
7034 /* Grab the size of the record we're getting */
7035 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7036 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7039 /* VMS wants read instead of fread, because fread doesn't respect */
7040 /* RMS record boundaries. This is not necessarily a good thing to be */
7041 /* doing, but we've got no other real choice - except avoid stdio
7042 as implementation - perhaps write a :vms layer ?
7044 fd = PerlIO_fileno(fp);
7045 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
7046 bytesread = PerlIO_read(fp, buffer, recsize);
7049 bytesread = PerlLIO_read(fd, buffer, recsize);
7052 bytesread = PerlIO_read(fp, buffer, recsize);
7056 SvCUR_set(sv, bytesread + append);
7057 buffer[bytesread] = '\0';
7058 goto return_string_or_null;
7060 else if (RsPARA(PL_rs)) {
7066 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7067 if (PerlIO_isutf8(fp)) {
7068 rsptr = SvPVutf8(PL_rs, rslen);
7071 if (SvUTF8(PL_rs)) {
7072 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7073 Perl_croak(aTHX_ "Wide character in $/");
7076 rsptr = SvPV_const(PL_rs, rslen);
7080 rslast = rslen ? rsptr[rslen - 1] : '\0';
7082 if (rspara) { /* have to do this both before and after */
7083 do { /* to make sure file boundaries work right */
7086 i = PerlIO_getc(fp);
7090 PerlIO_ungetc(fp,i);
7096 /* See if we know enough about I/O mechanism to cheat it ! */
7098 /* This used to be #ifdef test - it is made run-time test for ease
7099 of abstracting out stdio interface. One call should be cheap
7100 enough here - and may even be a macro allowing compile
7104 if (PerlIO_fast_gets(fp)) {
7107 * We're going to steal some values from the stdio struct
7108 * and put EVERYTHING in the innermost loop into registers.
7110 register STDCHAR *ptr;
7114 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7115 /* An ungetc()d char is handled separately from the regular
7116 * buffer, so we getc() it back out and stuff it in the buffer.
7118 i = PerlIO_getc(fp);
7119 if (i == EOF) return 0;
7120 *(--((*fp)->_ptr)) = (unsigned char) i;
7124 /* Here is some breathtakingly efficient cheating */
7126 cnt = PerlIO_get_cnt(fp); /* get count into register */
7127 /* make sure we have the room */
7128 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7129 /* Not room for all of it
7130 if we are looking for a separator and room for some
7132 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7133 /* just process what we have room for */
7134 shortbuffered = cnt - SvLEN(sv) + append + 1;
7135 cnt -= shortbuffered;
7139 /* remember that cnt can be negative */
7140 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7145 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7146 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7147 DEBUG_P(PerlIO_printf(Perl_debug_log,
7148 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7149 DEBUG_P(PerlIO_printf(Perl_debug_log,
7150 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7151 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7152 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7157 while (cnt > 0) { /* this | eat */
7159 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7160 goto thats_all_folks; /* screams | sed :-) */
7164 Copy(ptr, bp, cnt, char); /* this | eat */
7165 bp += cnt; /* screams | dust */
7166 ptr += cnt; /* louder | sed :-) */
7171 if (shortbuffered) { /* oh well, must extend */
7172 cnt = shortbuffered;
7174 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7176 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7177 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7181 DEBUG_P(PerlIO_printf(Perl_debug_log,
7182 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7183 PTR2UV(ptr),(long)cnt));
7184 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7186 DEBUG_P(PerlIO_printf(Perl_debug_log,
7187 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7188 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7189 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7191 /* This used to call 'filbuf' in stdio form, but as that behaves like
7192 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7193 another abstraction. */
7194 i = PerlIO_getc(fp); /* get more characters */
7196 DEBUG_P(PerlIO_printf(Perl_debug_log,
7197 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7198 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7199 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7201 cnt = PerlIO_get_cnt(fp);
7202 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7203 DEBUG_P(PerlIO_printf(Perl_debug_log,
7204 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7206 if (i == EOF) /* all done for ever? */
7207 goto thats_really_all_folks;
7209 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7211 SvGROW(sv, bpx + cnt + 2);
7212 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7214 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7216 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7217 goto thats_all_folks;
7221 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7222 memNE((char*)bp - rslen, rsptr, rslen))
7223 goto screamer; /* go back to the fray */
7224 thats_really_all_folks:
7226 cnt += shortbuffered;
7227 DEBUG_P(PerlIO_printf(Perl_debug_log,
7228 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7229 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7230 DEBUG_P(PerlIO_printf(Perl_debug_log,
7231 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7232 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7233 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7235 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7236 DEBUG_P(PerlIO_printf(Perl_debug_log,
7237 "Screamer: done, len=%ld, string=|%.*s|\n",
7238 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7242 /*The big, slow, and stupid way. */
7243 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7244 STDCHAR *buf = NULL;
7245 Newx(buf, 8192, STDCHAR);
7253 register const STDCHAR * const bpe = buf + sizeof(buf);
7255 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7256 ; /* keep reading */
7260 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7261 /* Accomodate broken VAXC compiler, which applies U8 cast to
7262 * both args of ?: operator, causing EOF to change into 255
7265 i = (U8)buf[cnt - 1];
7271 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7273 sv_catpvn(sv, (char *) buf, cnt);
7275 sv_setpvn(sv, (char *) buf, cnt);
7277 if (i != EOF && /* joy */
7279 SvCUR(sv) < rslen ||
7280 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7284 * If we're reading from a TTY and we get a short read,
7285 * indicating that the user hit his EOF character, we need
7286 * to notice it now, because if we try to read from the TTY
7287 * again, the EOF condition will disappear.
7289 * The comparison of cnt to sizeof(buf) is an optimization
7290 * that prevents unnecessary calls to feof().
7294 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7298 #ifdef USE_HEAP_INSTEAD_OF_STACK
7303 if (rspara) { /* have to do this both before and after */
7304 while (i != EOF) { /* to make sure file boundaries work right */
7305 i = PerlIO_getc(fp);
7307 PerlIO_ungetc(fp,i);
7313 return_string_or_null:
7314 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7320 Auto-increment of the value in the SV, doing string to numeric conversion
7321 if necessary. Handles 'get' magic.
7327 Perl_sv_inc(pTHX_ register SV *const sv)
7336 if (SvTHINKFIRST(sv)) {
7338 sv_force_normal_flags(sv, 0);
7339 if (SvREADONLY(sv)) {
7340 if (IN_PERL_RUNTIME)
7341 Perl_croak(aTHX_ "%s", PL_no_modify);
7345 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7347 i = PTR2IV(SvRV(sv));
7352 flags = SvFLAGS(sv);
7353 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7354 /* It's (privately or publicly) a float, but not tested as an
7355 integer, so test it to see. */
7357 flags = SvFLAGS(sv);
7359 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7360 /* It's publicly an integer, or privately an integer-not-float */
7361 #ifdef PERL_PRESERVE_IVUV
7365 if (SvUVX(sv) == UV_MAX)
7366 sv_setnv(sv, UV_MAX_P1);
7368 (void)SvIOK_only_UV(sv);
7369 SvUV_set(sv, SvUVX(sv) + 1);
7371 if (SvIVX(sv) == IV_MAX)
7372 sv_setuv(sv, (UV)IV_MAX + 1);
7374 (void)SvIOK_only(sv);
7375 SvIV_set(sv, SvIVX(sv) + 1);
7380 if (flags & SVp_NOK) {
7381 const NV was = SvNVX(sv);
7382 if (NV_OVERFLOWS_INTEGERS_AT &&
7383 was >= NV_OVERFLOWS_INTEGERS_AT) {
7384 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7385 "Lost precision when incrementing %" NVff " by 1",
7388 (void)SvNOK_only(sv);
7389 SvNV_set(sv, was + 1.0);
7393 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7394 if ((flags & SVTYPEMASK) < SVt_PVIV)
7395 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7396 (void)SvIOK_only(sv);
7401 while (isALPHA(*d)) d++;
7402 while (isDIGIT(*d)) d++;
7403 if (d < SvEND(sv)) {
7404 #ifdef PERL_PRESERVE_IVUV
7405 /* Got to punt this as an integer if needs be, but we don't issue
7406 warnings. Probably ought to make the sv_iv_please() that does
7407 the conversion if possible, and silently. */
7408 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7409 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7410 /* Need to try really hard to see if it's an integer.
7411 9.22337203685478e+18 is an integer.
7412 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7413 so $a="9.22337203685478e+18"; $a+0; $a++
7414 needs to be the same as $a="9.22337203685478e+18"; $a++
7421 /* sv_2iv *should* have made this an NV */
7422 if (flags & SVp_NOK) {
7423 (void)SvNOK_only(sv);
7424 SvNV_set(sv, SvNVX(sv) + 1.0);
7427 /* I don't think we can get here. Maybe I should assert this
7428 And if we do get here I suspect that sv_setnv will croak. NWC
7430 #if defined(USE_LONG_DOUBLE)
7431 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",
7432 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7434 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7435 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7438 #endif /* PERL_PRESERVE_IVUV */
7439 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7443 while (d >= SvPVX_const(sv)) {
7451 /* MKS: The original code here died if letters weren't consecutive.
7452 * at least it didn't have to worry about non-C locales. The
7453 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7454 * arranged in order (although not consecutively) and that only
7455 * [A-Za-z] are accepted by isALPHA in the C locale.
7457 if (*d != 'z' && *d != 'Z') {
7458 do { ++*d; } while (!isALPHA(*d));
7461 *(d--) -= 'z' - 'a';
7466 *(d--) -= 'z' - 'a' + 1;
7470 /* oh,oh, the number grew */
7471 SvGROW(sv, SvCUR(sv) + 2);
7472 SvCUR_set(sv, SvCUR(sv) + 1);
7473 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7484 Auto-decrement of the value in the SV, doing string to numeric conversion
7485 if necessary. Handles 'get' magic.
7491 Perl_sv_dec(pTHX_ register SV *const sv)
7499 if (SvTHINKFIRST(sv)) {
7501 sv_force_normal_flags(sv, 0);
7502 if (SvREADONLY(sv)) {
7503 if (IN_PERL_RUNTIME)
7504 Perl_croak(aTHX_ "%s", PL_no_modify);
7508 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7510 i = PTR2IV(SvRV(sv));
7515 /* Unlike sv_inc we don't have to worry about string-never-numbers
7516 and keeping them magic. But we mustn't warn on punting */
7517 flags = SvFLAGS(sv);
7518 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7519 /* It's publicly an integer, or privately an integer-not-float */
7520 #ifdef PERL_PRESERVE_IVUV
7524 if (SvUVX(sv) == 0) {
7525 (void)SvIOK_only(sv);
7529 (void)SvIOK_only_UV(sv);
7530 SvUV_set(sv, SvUVX(sv) - 1);
7533 if (SvIVX(sv) == IV_MIN) {
7534 sv_setnv(sv, (NV)IV_MIN);
7538 (void)SvIOK_only(sv);
7539 SvIV_set(sv, SvIVX(sv) - 1);
7544 if (flags & SVp_NOK) {
7547 const NV was = SvNVX(sv);
7548 if (NV_OVERFLOWS_INTEGERS_AT &&
7549 was <= -NV_OVERFLOWS_INTEGERS_AT) {
7550 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7551 "Lost precision when decrementing %" NVff " by 1",
7554 (void)SvNOK_only(sv);
7555 SvNV_set(sv, was - 1.0);
7559 if (!(flags & SVp_POK)) {
7560 if ((flags & SVTYPEMASK) < SVt_PVIV)
7561 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7563 (void)SvIOK_only(sv);
7566 #ifdef PERL_PRESERVE_IVUV
7568 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7569 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7570 /* Need to try really hard to see if it's an integer.
7571 9.22337203685478e+18 is an integer.
7572 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7573 so $a="9.22337203685478e+18"; $a+0; $a--
7574 needs to be the same as $a="9.22337203685478e+18"; $a--
7581 /* sv_2iv *should* have made this an NV */
7582 if (flags & SVp_NOK) {
7583 (void)SvNOK_only(sv);
7584 SvNV_set(sv, SvNVX(sv) - 1.0);
7587 /* I don't think we can get here. Maybe I should assert this
7588 And if we do get here I suspect that sv_setnv will croak. NWC
7590 #if defined(USE_LONG_DOUBLE)
7591 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",
7592 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7594 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7595 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7599 #endif /* PERL_PRESERVE_IVUV */
7600 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7603 /* this define is used to eliminate a chunk of duplicated but shared logic
7604 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
7605 * used anywhere but here - yves
7607 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
7610 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
7614 =for apidoc sv_mortalcopy
7616 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7617 The new SV is marked as mortal. It will be destroyed "soon", either by an
7618 explicit call to FREETMPS, or by an implicit call at places such as
7619 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7624 /* Make a string that will exist for the duration of the expression
7625 * evaluation. Actually, it may have to last longer than that, but
7626 * hopefully we won't free it until it has been assigned to a
7627 * permanent location. */
7630 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7636 sv_setsv(sv,oldstr);
7637 PUSH_EXTEND_MORTAL__SV_C(sv);
7643 =for apidoc sv_newmortal
7645 Creates a new null SV which is mortal. The reference count of the SV is
7646 set to 1. It will be destroyed "soon", either by an explicit call to
7647 FREETMPS, or by an implicit call at places such as statement boundaries.
7648 See also C<sv_mortalcopy> and C<sv_2mortal>.
7654 Perl_sv_newmortal(pTHX)
7660 SvFLAGS(sv) = SVs_TEMP;
7661 PUSH_EXTEND_MORTAL__SV_C(sv);
7667 =for apidoc newSVpvn_flags
7669 Creates a new SV and copies a string into it. The reference count for the
7670 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7671 string. You are responsible for ensuring that the source string is at least
7672 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7673 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7674 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7675 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7676 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7678 #define newSVpvn_utf8(s, len, u) \
7679 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7685 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7690 /* All the flags we don't support must be zero.
7691 And we're new code so I'm going to assert this from the start. */
7692 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7694 sv_setpvn(sv,s,len);
7696 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
7697 * and do what it does outselves here.
7698 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
7699 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
7700 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
7701 * eleminate quite a few steps than it looks - Yves (explaining patch by gfx)
7704 SvFLAGS(sv) |= flags;
7706 if(flags & SVs_TEMP){
7707 PUSH_EXTEND_MORTAL__SV_C(sv);
7714 =for apidoc sv_2mortal
7716 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7717 by an explicit call to FREETMPS, or by an implicit call at places such as
7718 statement boundaries. SvTEMP() is turned on which means that the SV's
7719 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7720 and C<sv_mortalcopy>.
7726 Perl_sv_2mortal(pTHX_ register SV *const sv)
7731 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7733 PUSH_EXTEND_MORTAL__SV_C(sv);
7741 Creates a new SV and copies a string into it. The reference count for the
7742 SV is set to 1. If C<len> is zero, Perl will compute the length using
7743 strlen(). For efficiency, consider using C<newSVpvn> instead.
7749 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7755 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7760 =for apidoc newSVpvn
7762 Creates a new SV and copies a string into it. The reference count for the
7763 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7764 string. You are responsible for ensuring that the source string is at least
7765 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7771 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7777 sv_setpvn(sv,s,len);
7782 =for apidoc newSVhek
7784 Creates a new SV from the hash key structure. It will generate scalars that
7785 point to the shared string table where possible. Returns a new (undefined)
7786 SV if the hek is NULL.
7792 Perl_newSVhek(pTHX_ const HEK *const hek)
7802 if (HEK_LEN(hek) == HEf_SVKEY) {
7803 return newSVsv(*(SV**)HEK_KEY(hek));
7805 const int flags = HEK_FLAGS(hek);
7806 if (flags & HVhek_WASUTF8) {
7808 Andreas would like keys he put in as utf8 to come back as utf8
7810 STRLEN utf8_len = HEK_LEN(hek);
7811 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7812 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7815 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7817 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7818 /* We don't have a pointer to the hv, so we have to replicate the
7819 flag into every HEK. This hv is using custom a hasing
7820 algorithm. Hence we can't return a shared string scalar, as
7821 that would contain the (wrong) hash value, and might get passed
7822 into an hv routine with a regular hash.
7823 Similarly, a hash that isn't using shared hash keys has to have
7824 the flag in every key so that we know not to try to call
7825 share_hek_kek on it. */
7827 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7832 /* This will be overwhelminly the most common case. */
7834 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7835 more efficient than sharepvn(). */
7839 sv_upgrade(sv, SVt_PV);
7840 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7841 SvCUR_set(sv, HEK_LEN(hek));
7854 =for apidoc newSVpvn_share
7856 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7857 table. If the string does not already exist in the table, it is created
7858 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7859 value is used; otherwise the hash is computed. The string's hash can be later
7860 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7861 that as the string table is used for shared hash keys these strings will have
7862 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7868 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7872 bool is_utf8 = FALSE;
7873 const char *const orig_src = src;
7876 STRLEN tmplen = -len;
7878 /* See the note in hv.c:hv_fetch() --jhi */
7879 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7883 PERL_HASH(hash, src, len);
7885 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
7886 changes here, update it there too. */
7887 sv_upgrade(sv, SVt_PV);
7888 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7896 if (src != orig_src)
7902 #if defined(PERL_IMPLICIT_CONTEXT)
7904 /* pTHX_ magic can't cope with varargs, so this is a no-context
7905 * version of the main function, (which may itself be aliased to us).
7906 * Don't access this version directly.
7910 Perl_newSVpvf_nocontext(const char *const pat, ...)
7916 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7918 va_start(args, pat);
7919 sv = vnewSVpvf(pat, &args);
7926 =for apidoc newSVpvf
7928 Creates a new SV and initializes it with the string formatted like
7935 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7940 PERL_ARGS_ASSERT_NEWSVPVF;
7942 va_start(args, pat);
7943 sv = vnewSVpvf(pat, &args);
7948 /* backend for newSVpvf() and newSVpvf_nocontext() */
7951 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7956 PERL_ARGS_ASSERT_VNEWSVPVF;
7959 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7966 Creates a new SV and copies a floating point value into it.
7967 The reference count for the SV is set to 1.
7973 Perl_newSVnv(pTHX_ const NV n)
7986 Creates a new SV and copies an integer into it. The reference count for the
7993 Perl_newSViv(pTHX_ const IV i)
8006 Creates a new SV and copies an unsigned integer into it.
8007 The reference count for the SV is set to 1.
8013 Perl_newSVuv(pTHX_ const UV u)
8024 =for apidoc newSV_type
8026 Creates a new SV, of the type specified. The reference count for the new SV
8033 Perl_newSV_type(pTHX_ const svtype type)
8038 sv_upgrade(sv, type);
8043 =for apidoc newRV_noinc
8045 Creates an RV wrapper for an SV. The reference count for the original
8046 SV is B<not> incremented.
8052 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8055 register SV *sv = newSV_type(SVt_IV);
8057 PERL_ARGS_ASSERT_NEWRV_NOINC;
8060 SvRV_set(sv, tmpRef);
8065 /* newRV_inc is the official function name to use now.
8066 * newRV_inc is in fact #defined to newRV in sv.h
8070 Perl_newRV(pTHX_ SV *const sv)
8074 PERL_ARGS_ASSERT_NEWRV;
8076 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8082 Creates a new SV which is an exact duplicate of the original SV.
8089 Perl_newSVsv(pTHX_ register SV *const old)
8096 if (SvTYPE(old) == SVTYPEMASK) {
8097 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8101 /* SV_GMAGIC is the default for sv_setv()
8102 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8103 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8104 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8109 =for apidoc sv_reset
8111 Underlying implementation for the C<reset> Perl function.
8112 Note that the perl-level function is vaguely deprecated.
8118 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8121 char todo[PERL_UCHAR_MAX+1];
8123 PERL_ARGS_ASSERT_SV_RESET;
8128 if (!*s) { /* reset ?? searches */
8129 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8131 const U32 count = mg->mg_len / sizeof(PMOP**);
8132 PMOP **pmp = (PMOP**) mg->mg_ptr;
8133 PMOP *const *const end = pmp + count;
8137 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8139 (*pmp)->op_pmflags &= ~PMf_USED;
8147 /* reset variables */
8149 if (!HvARRAY(stash))
8152 Zero(todo, 256, char);
8155 I32 i = (unsigned char)*s;
8159 max = (unsigned char)*s++;
8160 for ( ; i <= max; i++) {
8163 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8165 for (entry = HvARRAY(stash)[i];
8167 entry = HeNEXT(entry))
8172 if (!todo[(U8)*HeKEY(entry)])
8174 gv = MUTABLE_GV(HeVAL(entry));
8177 if (SvTHINKFIRST(sv)) {
8178 if (!SvREADONLY(sv) && SvROK(sv))
8180 /* XXX Is this continue a bug? Why should THINKFIRST
8181 exempt us from resetting arrays and hashes? */
8185 if (SvTYPE(sv) >= SVt_PV) {
8187 if (SvPVX_const(sv) != NULL)
8195 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8197 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8200 # if defined(USE_ENVIRON_ARRAY)
8203 # endif /* USE_ENVIRON_ARRAY */
8214 Using various gambits, try to get an IO from an SV: the IO slot if its a
8215 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8216 named after the PV if we're a string.
8222 Perl_sv_2io(pTHX_ SV *const sv)
8227 PERL_ARGS_ASSERT_SV_2IO;
8229 switch (SvTYPE(sv)) {
8231 io = MUTABLE_IO(sv);
8234 if (isGV_with_GP(sv)) {
8235 gv = MUTABLE_GV(sv);
8238 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8244 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8246 return sv_2io(SvRV(sv));
8247 gv = gv_fetchsv(sv, 0, SVt_PVIO);
8253 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
8262 Using various gambits, try to get a CV from an SV; in addition, try if
8263 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8264 The flags in C<lref> are passed to gv_fetchsv.
8270 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8276 PERL_ARGS_ASSERT_SV_2CV;
8283 switch (SvTYPE(sv)) {
8287 return MUTABLE_CV(sv);
8294 if (isGV_with_GP(sv)) {
8295 gv = MUTABLE_GV(sv);
8304 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8306 tryAMAGICunDEREF(to_cv);
8309 if (SvTYPE(sv) == SVt_PVCV) {
8310 cv = MUTABLE_CV(sv);
8315 else if(isGV_with_GP(sv))
8316 gv = MUTABLE_GV(sv);
8318 Perl_croak(aTHX_ "Not a subroutine reference");
8320 else if (isGV_with_GP(sv)) {
8322 gv = MUTABLE_GV(sv);
8325 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
8331 /* Some flags to gv_fetchsv mean don't really create the GV */
8332 if (!isGV_with_GP(gv)) {
8338 if (lref && !GvCVu(gv)) {
8342 gv_efullname3(tmpsv, gv, NULL);
8343 /* XXX this is probably not what they think they're getting.
8344 * It has the same effect as "sub name;", i.e. just a forward
8346 newSUB(start_subparse(FALSE, 0),
8347 newSVOP(OP_CONST, 0, tmpsv),
8351 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8352 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8361 Returns true if the SV has a true value by Perl's rules.
8362 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8363 instead use an in-line version.
8369 Perl_sv_true(pTHX_ register SV *const sv)
8374 register const XPV* const tXpv = (XPV*)SvANY(sv);
8376 (tXpv->xpv_cur > 1 ||
8377 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8384 return SvIVX(sv) != 0;
8387 return SvNVX(sv) != 0.0;
8389 return sv_2bool(sv);
8395 =for apidoc sv_pvn_force
8397 Get a sensible string out of the SV somehow.
8398 A private implementation of the C<SvPV_force> macro for compilers which
8399 can't cope with complex macro expressions. Always use the macro instead.
8401 =for apidoc sv_pvn_force_flags
8403 Get a sensible string out of the SV somehow.
8404 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8405 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8406 implemented in terms of this function.
8407 You normally want to use the various wrapper macros instead: see
8408 C<SvPV_force> and C<SvPV_force_nomg>
8414 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8418 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8420 if (SvTHINKFIRST(sv) && !SvROK(sv))
8421 sv_force_normal_flags(sv, 0);
8431 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8432 const char * const ref = sv_reftype(sv,0);
8434 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8435 ref, OP_NAME(PL_op));
8437 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8439 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8440 || isGV_with_GP(sv))
8441 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8443 s = sv_2pv_flags(sv, &len, flags);
8447 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8450 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8451 SvGROW(sv, len + 1);
8452 Move(s,SvPVX(sv),len,char);
8454 SvPVX(sv)[len] = '\0';
8457 SvPOK_on(sv); /* validate pointer */
8459 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8460 PTR2UV(sv),SvPVX_const(sv)));
8463 return SvPVX_mutable(sv);
8467 =for apidoc sv_pvbyten_force
8469 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8475 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8477 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8479 sv_pvn_force(sv,lp);
8480 sv_utf8_downgrade(sv,0);
8486 =for apidoc sv_pvutf8n_force
8488 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8494 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8496 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8498 sv_pvn_force(sv,lp);
8499 sv_utf8_upgrade(sv);
8505 =for apidoc sv_reftype
8507 Returns a string describing what the SV is a reference to.
8513 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8515 PERL_ARGS_ASSERT_SV_REFTYPE;
8517 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8518 inside return suggests a const propagation bug in g++. */
8519 if (ob && SvOBJECT(sv)) {
8520 char * const name = HvNAME_get(SvSTASH(sv));
8521 return name ? name : (char *) "__ANON__";
8524 switch (SvTYPE(sv)) {
8539 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8540 /* tied lvalues should appear to be
8541 * scalars for backwards compatitbility */
8542 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8543 ? "SCALAR" : "LVALUE");
8544 case SVt_PVAV: return "ARRAY";
8545 case SVt_PVHV: return "HASH";
8546 case SVt_PVCV: return "CODE";
8547 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8548 ? "GLOB" : "SCALAR");
8549 case SVt_PVFM: return "FORMAT";
8550 case SVt_PVIO: return "IO";
8551 case SVt_BIND: return "BIND";
8552 case SVt_REGEXP: return "REGEXP";
8553 default: return "UNKNOWN";
8559 =for apidoc sv_isobject
8561 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8562 object. If the SV is not an RV, or if the object is not blessed, then this
8569 Perl_sv_isobject(pTHX_ SV *sv)
8585 Returns a boolean indicating whether the SV is blessed into the specified
8586 class. This does not check for subtypes; use C<sv_derived_from> to verify
8587 an inheritance relationship.
8593 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8597 PERL_ARGS_ASSERT_SV_ISA;
8607 hvname = HvNAME_get(SvSTASH(sv));
8611 return strEQ(hvname, name);
8617 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8618 it will be upgraded to one. If C<classname> is non-null then the new SV will
8619 be blessed in the specified package. The new SV is returned and its
8620 reference count is 1.
8626 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8631 PERL_ARGS_ASSERT_NEWSVRV;
8635 SV_CHECK_THINKFIRST_COW_DROP(rv);
8636 (void)SvAMAGIC_off(rv);
8638 if (SvTYPE(rv) >= SVt_PVMG) {
8639 const U32 refcnt = SvREFCNT(rv);
8643 SvREFCNT(rv) = refcnt;
8645 sv_upgrade(rv, SVt_IV);
8646 } else if (SvROK(rv)) {
8647 SvREFCNT_dec(SvRV(rv));
8649 prepare_SV_for_RV(rv);
8657 HV* const stash = gv_stashpv(classname, GV_ADD);
8658 (void)sv_bless(rv, stash);
8664 =for apidoc sv_setref_pv
8666 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8667 argument will be upgraded to an RV. That RV will be modified to point to
8668 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8669 into the SV. The C<classname> argument indicates the package for the
8670 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8671 will have a reference count of 1, and the RV will be returned.
8673 Do not use with other Perl types such as HV, AV, SV, CV, because those
8674 objects will become corrupted by the pointer copy process.
8676 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8682 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8686 PERL_ARGS_ASSERT_SV_SETREF_PV;
8689 sv_setsv(rv, &PL_sv_undef);
8693 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8698 =for apidoc sv_setref_iv
8700 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8701 argument will be upgraded to an RV. That RV will be modified to point to
8702 the new SV. The C<classname> argument indicates the package for the
8703 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8704 will have a reference count of 1, and the RV will be returned.
8710 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8712 PERL_ARGS_ASSERT_SV_SETREF_IV;
8714 sv_setiv(newSVrv(rv,classname), iv);
8719 =for apidoc sv_setref_uv
8721 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8722 argument will be upgraded to an RV. That RV will be modified to point to
8723 the new SV. The C<classname> argument indicates the package for the
8724 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8725 will have a reference count of 1, and the RV will be returned.
8731 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8733 PERL_ARGS_ASSERT_SV_SETREF_UV;
8735 sv_setuv(newSVrv(rv,classname), uv);
8740 =for apidoc sv_setref_nv
8742 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8743 argument will be upgraded to an RV. That RV will be modified to point to
8744 the new SV. The C<classname> argument indicates the package for the
8745 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8746 will have a reference count of 1, and the RV will be returned.
8752 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8754 PERL_ARGS_ASSERT_SV_SETREF_NV;
8756 sv_setnv(newSVrv(rv,classname), nv);
8761 =for apidoc sv_setref_pvn
8763 Copies a string into a new SV, optionally blessing the SV. The length of the
8764 string must be specified with C<n>. The C<rv> argument will be upgraded to
8765 an RV. That RV will be modified to point to the new SV. The C<classname>
8766 argument indicates the package for the blessing. Set C<classname> to
8767 C<NULL> to avoid the blessing. The new SV will have a reference count
8768 of 1, and the RV will be returned.
8770 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8776 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8777 const char *const pv, const STRLEN n)
8779 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8781 sv_setpvn(newSVrv(rv,classname), pv, n);
8786 =for apidoc sv_bless
8788 Blesses an SV into a specified package. The SV must be an RV. The package
8789 must be designated by its stash (see C<gv_stashpv()>). The reference count
8790 of the SV is unaffected.
8796 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8801 PERL_ARGS_ASSERT_SV_BLESS;
8804 Perl_croak(aTHX_ "Can't bless non-reference value");
8806 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8807 if (SvIsCOW(tmpRef))
8808 sv_force_normal_flags(tmpRef, 0);
8809 if (SvREADONLY(tmpRef))
8810 Perl_croak(aTHX_ "%s", PL_no_modify);
8811 if (SvOBJECT(tmpRef)) {
8812 if (SvTYPE(tmpRef) != SVt_PVIO)
8814 SvREFCNT_dec(SvSTASH(tmpRef));
8817 SvOBJECT_on(tmpRef);
8818 if (SvTYPE(tmpRef) != SVt_PVIO)
8820 SvUPGRADE(tmpRef, SVt_PVMG);
8821 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
8826 (void)SvAMAGIC_off(sv);
8828 if(SvSMAGICAL(tmpRef))
8829 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8837 /* Downgrades a PVGV to a PVMG.
8841 S_sv_unglob(pTHX_ SV *const sv)
8846 SV * const temp = sv_newmortal();
8848 PERL_ARGS_ASSERT_SV_UNGLOB;
8850 assert(SvTYPE(sv) == SVt_PVGV);
8852 gv_efullname3(temp, MUTABLE_GV(sv), "*");
8855 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
8856 && HvNAME_get(stash))
8857 mro_method_changed_in(stash);
8858 gp_free(MUTABLE_GV(sv));
8861 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
8865 if (GvNAME_HEK(sv)) {
8866 unshare_hek(GvNAME_HEK(sv));
8868 isGV_with_GP_off(sv);
8870 /* need to keep SvANY(sv) in the right arena */
8871 xpvmg = new_XPVMG();
8872 StructCopy(SvANY(sv), xpvmg, XPVMG);
8873 del_XPVGV(SvANY(sv));
8876 SvFLAGS(sv) &= ~SVTYPEMASK;
8877 SvFLAGS(sv) |= SVt_PVMG;
8879 /* Intentionally not calling any local SET magic, as this isn't so much a
8880 set operation as merely an internal storage change. */
8881 sv_setsv_flags(sv, temp, 0);
8885 =for apidoc sv_unref_flags
8887 Unsets the RV status of the SV, and decrements the reference count of
8888 whatever was being referenced by the RV. This can almost be thought of
8889 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8890 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8891 (otherwise the decrementing is conditional on the reference count being
8892 different from one or the reference being a readonly SV).
8899 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8901 SV* const target = SvRV(ref);
8903 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8905 if (SvWEAKREF(ref)) {
8906 sv_del_backref(target, ref);
8908 SvRV_set(ref, NULL);
8911 SvRV_set(ref, NULL);
8913 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8914 assigned to as BEGIN {$a = \"Foo"} will fail. */
8915 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8916 SvREFCNT_dec(target);
8917 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8918 sv_2mortal(target); /* Schedule for freeing later */
8922 =for apidoc sv_untaint
8924 Untaint an SV. Use C<SvTAINTED_off> instead.
8929 Perl_sv_untaint(pTHX_ SV *const sv)
8931 PERL_ARGS_ASSERT_SV_UNTAINT;
8933 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8934 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8941 =for apidoc sv_tainted
8943 Test an SV for taintedness. Use C<SvTAINTED> instead.
8948 Perl_sv_tainted(pTHX_ SV *const sv)
8950 PERL_ARGS_ASSERT_SV_TAINTED;
8952 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8953 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8954 if (mg && (mg->mg_len & 1) )
8961 =for apidoc sv_setpviv
8963 Copies an integer into the given SV, also updating its string value.
8964 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8970 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8972 char buf[TYPE_CHARS(UV)];
8974 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8976 PERL_ARGS_ASSERT_SV_SETPVIV;
8978 sv_setpvn(sv, ptr, ebuf - ptr);
8982 =for apidoc sv_setpviv_mg
8984 Like C<sv_setpviv>, but also handles 'set' magic.
8990 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8992 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8998 #if defined(PERL_IMPLICIT_CONTEXT)
9000 /* pTHX_ magic can't cope with varargs, so this is a no-context
9001 * version of the main function, (which may itself be aliased to us).
9002 * Don't access this version directly.
9006 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9011 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9013 va_start(args, pat);
9014 sv_vsetpvf(sv, pat, &args);
9018 /* pTHX_ magic can't cope with varargs, so this is a no-context
9019 * version of the main function, (which may itself be aliased to us).
9020 * Don't access this version directly.
9024 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9029 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9031 va_start(args, pat);
9032 sv_vsetpvf_mg(sv, pat, &args);
9038 =for apidoc sv_setpvf
9040 Works like C<sv_catpvf> but copies the text into the SV instead of
9041 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9047 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9051 PERL_ARGS_ASSERT_SV_SETPVF;
9053 va_start(args, pat);
9054 sv_vsetpvf(sv, pat, &args);
9059 =for apidoc sv_vsetpvf
9061 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9062 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9064 Usually used via its frontend C<sv_setpvf>.
9070 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9072 PERL_ARGS_ASSERT_SV_VSETPVF;
9074 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9078 =for apidoc sv_setpvf_mg
9080 Like C<sv_setpvf>, but also handles 'set' magic.
9086 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9090 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9092 va_start(args, pat);
9093 sv_vsetpvf_mg(sv, pat, &args);
9098 =for apidoc sv_vsetpvf_mg
9100 Like C<sv_vsetpvf>, but also handles 'set' magic.
9102 Usually used via its frontend C<sv_setpvf_mg>.
9108 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9110 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9112 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9116 #if defined(PERL_IMPLICIT_CONTEXT)
9118 /* pTHX_ magic can't cope with varargs, so this is a no-context
9119 * version of the main function, (which may itself be aliased to us).
9120 * Don't access this version directly.
9124 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9129 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9131 va_start(args, pat);
9132 sv_vcatpvf(sv, pat, &args);
9136 /* pTHX_ magic can't cope with varargs, so this is a no-context
9137 * version of the main function, (which may itself be aliased to us).
9138 * Don't access this version directly.
9142 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9147 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9149 va_start(args, pat);
9150 sv_vcatpvf_mg(sv, pat, &args);
9156 =for apidoc sv_catpvf
9158 Processes its arguments like C<sprintf> and appends the formatted
9159 output to an SV. If the appended data contains "wide" characters
9160 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9161 and characters >255 formatted with %c), the original SV might get
9162 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9163 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9164 valid UTF-8; if the original SV was bytes, the pattern should be too.
9169 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9173 PERL_ARGS_ASSERT_SV_CATPVF;
9175 va_start(args, pat);
9176 sv_vcatpvf(sv, pat, &args);
9181 =for apidoc sv_vcatpvf
9183 Processes its arguments like C<vsprintf> and appends the formatted output
9184 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9186 Usually used via its frontend C<sv_catpvf>.
9192 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9194 PERL_ARGS_ASSERT_SV_VCATPVF;
9196 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9200 =for apidoc sv_catpvf_mg
9202 Like C<sv_catpvf>, but also handles 'set' magic.
9208 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9212 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9214 va_start(args, pat);
9215 sv_vcatpvf_mg(sv, pat, &args);
9220 =for apidoc sv_vcatpvf_mg
9222 Like C<sv_vcatpvf>, but also handles 'set' magic.
9224 Usually used via its frontend C<sv_catpvf_mg>.
9230 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9232 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9234 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9239 =for apidoc sv_vsetpvfn
9241 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9244 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9250 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9251 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9253 PERL_ARGS_ASSERT_SV_VSETPVFN;
9256 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9261 * Warn of missing argument to sprintf, and then return a defined value
9262 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9264 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9266 S_vcatpvfn_missing_argument(pTHX) {
9267 if (ckWARN(WARN_MISSING)) {
9268 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9269 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9276 S_expect_number(pTHX_ char **const pattern)
9281 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9283 switch (**pattern) {
9284 case '1': case '2': case '3':
9285 case '4': case '5': case '6':
9286 case '7': case '8': case '9':
9287 var = *(*pattern)++ - '0';
9288 while (isDIGIT(**pattern)) {
9289 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9291 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
9299 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9301 const int neg = nv < 0;
9304 PERL_ARGS_ASSERT_F0CONVERT;
9312 if (uv & 1 && uv == nv)
9313 uv--; /* Round to even */
9315 const unsigned dig = uv % 10;
9328 =for apidoc sv_vcatpvfn
9330 Processes its arguments like C<vsprintf> and appends the formatted output
9331 to an SV. Uses an array of SVs if the C style variable argument list is
9332 missing (NULL). When running with taint checks enabled, indicates via
9333 C<maybe_tainted> if results are untrustworthy (often due to the use of
9336 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9342 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
9343 vecstr = (U8*)SvPV_const(vecsv,veclen);\
9344 vec_utf8 = DO_UTF8(vecsv);
9346 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9349 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9350 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9358 static const char nullstr[] = "(null)";
9360 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9361 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9363 /* Times 4: a decimal digit takes more than 3 binary digits.
9364 * NV_DIG: mantissa takes than many decimal digits.
9365 * Plus 32: Playing safe. */
9366 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9367 /* large enough for "%#.#f" --chip */
9368 /* what about long double NVs? --jhi */
9370 PERL_ARGS_ASSERT_SV_VCATPVFN;
9371 PERL_UNUSED_ARG(maybe_tainted);
9373 /* no matter what, this is a string now */
9374 (void)SvPV_force(sv, origlen);
9376 /* special-case "", "%s", and "%-p" (SVf - see below) */
9379 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9381 const char * const s = va_arg(*args, char*);
9382 sv_catpv(sv, s ? s : nullstr);
9384 else if (svix < svmax) {
9385 sv_catsv(sv, *svargs);
9389 if (args && patlen == 3 && pat[0] == '%' &&
9390 pat[1] == '-' && pat[2] == 'p') {
9391 argsv = MUTABLE_SV(va_arg(*args, void*));
9392 sv_catsv(sv, argsv);
9396 #ifndef USE_LONG_DOUBLE
9397 /* special-case "%.<number>[gf]" */
9398 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9399 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9400 unsigned digits = 0;
9404 while (*pp >= '0' && *pp <= '9')
9405 digits = 10 * digits + (*pp++ - '0');
9406 if (pp - pat == (int)patlen - 1) {
9414 /* Add check for digits != 0 because it seems that some
9415 gconverts are buggy in this case, and we don't yet have
9416 a Configure test for this. */
9417 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9418 /* 0, point, slack */
9419 Gconvert(nv, (int)digits, 0, ebuf);
9421 if (*ebuf) /* May return an empty string for digits==0 */
9424 } else if (!digits) {
9427 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9428 sv_catpvn(sv, p, l);
9434 #endif /* !USE_LONG_DOUBLE */
9436 if (!args && svix < svmax && DO_UTF8(*svargs))
9439 patend = (char*)pat + patlen;
9440 for (p = (char*)pat; p < patend; p = q) {
9443 bool vectorize = FALSE;
9444 bool vectorarg = FALSE;
9445 bool vec_utf8 = FALSE;
9451 bool has_precis = FALSE;
9453 const I32 osvix = svix;
9454 bool is_utf8 = FALSE; /* is this item utf8? */
9455 #ifdef HAS_LDBL_SPRINTF_BUG
9456 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9457 with sfio - Allen <allens@cpan.org> */
9458 bool fix_ldbl_sprintf_bug = FALSE;
9462 U8 utf8buf[UTF8_MAXBYTES+1];
9463 STRLEN esignlen = 0;
9465 const char *eptr = NULL;
9466 const char *fmtstart;
9469 const U8 *vecstr = NULL;
9476 /* we need a long double target in case HAS_LONG_DOUBLE but
9479 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9487 const char *dotstr = ".";
9488 STRLEN dotstrlen = 1;
9489 I32 efix = 0; /* explicit format parameter index */
9490 I32 ewix = 0; /* explicit width index */
9491 I32 epix = 0; /* explicit precision index */
9492 I32 evix = 0; /* explicit vector index */
9493 bool asterisk = FALSE;
9495 /* echo everything up to the next format specification */
9496 for (q = p; q < patend && *q != '%'; ++q) ;
9498 if (has_utf8 && !pat_utf8)
9499 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9501 sv_catpvn(sv, p, q - p);
9510 We allow format specification elements in this order:
9511 \d+\$ explicit format parameter index
9513 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9514 0 flag (as above): repeated to allow "v02"
9515 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9516 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9518 [%bcdefginopsuxDFOUX] format (mandatory)
9523 As of perl5.9.3, printf format checking is on by default.
9524 Internally, perl uses %p formats to provide an escape to
9525 some extended formatting. This block deals with those
9526 extensions: if it does not match, (char*)q is reset and
9527 the normal format processing code is used.
9529 Currently defined extensions are:
9530 %p include pointer address (standard)
9531 %-p (SVf) include an SV (previously %_)
9532 %-<num>p include an SV with precision <num>
9533 %<num>p reserved for future extensions
9535 Robin Barker 2005-07-14
9537 %1p (VDf) removed. RMB 2007-10-19
9544 n = expect_number(&q);
9551 argsv = MUTABLE_SV(va_arg(*args, void*));
9552 eptr = SvPV_const(argsv, elen);
9558 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
9559 "internal %%<num>p might conflict with future printf extensions");
9565 if ( (width = expect_number(&q)) ) {
9580 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9609 if ( (ewix = expect_number(&q)) )
9618 if ((vectorarg = asterisk)) {
9631 width = expect_number(&q);
9637 vecsv = va_arg(*args, SV*);
9639 vecsv = (evix > 0 && evix <= svmax)
9640 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
9642 vecsv = svix < svmax
9643 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
9645 dotstr = SvPV_const(vecsv, dotstrlen);
9646 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9647 bad with tied or overloaded values that return UTF8. */
9650 else if (has_utf8) {
9651 vecsv = sv_mortalcopy(vecsv);
9652 sv_utf8_upgrade(vecsv);
9653 dotstr = SvPV_const(vecsv, dotstrlen);
9660 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9661 vecsv = svargs[efix ? efix-1 : svix++];
9662 vecstr = (U8*)SvPV_const(vecsv,veclen);
9663 vec_utf8 = DO_UTF8(vecsv);
9665 /* if this is a version object, we need to convert
9666 * back into v-string notation and then let the
9667 * vectorize happen normally
9669 if (sv_derived_from(vecsv, "version")) {
9670 char *version = savesvpv(vecsv);
9671 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
9672 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9673 "vector argument not supported with alpha versions");
9676 vecsv = sv_newmortal();
9677 scan_vstring(version, version + veclen, vecsv);
9678 vecstr = (U8*)SvPV_const(vecsv, veclen);
9679 vec_utf8 = DO_UTF8(vecsv);
9691 i = va_arg(*args, int);
9693 i = (ewix ? ewix <= svmax : svix < svmax) ?
9694 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9696 width = (i < 0) ? -i : i;
9706 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9708 /* XXX: todo, support specified precision parameter */
9712 i = va_arg(*args, int);
9714 i = (ewix ? ewix <= svmax : svix < svmax)
9715 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9717 has_precis = !(i < 0);
9722 precis = precis * 10 + (*q++ - '0');
9731 case 'I': /* Ix, I32x, and I64x */
9733 if (q[1] == '6' && q[2] == '4') {
9739 if (q[1] == '3' && q[2] == '2') {
9749 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9760 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9761 if (*(q + 1) == 'l') { /* lld, llf */
9787 if (!vectorize && !args) {
9789 const I32 i = efix-1;
9790 argsv = (i >= 0 && i < svmax)
9791 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
9793 argsv = (svix >= 0 && svix < svmax)
9794 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
9805 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9807 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9809 eptr = (char*)utf8buf;
9810 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9824 eptr = va_arg(*args, char*);
9826 elen = strlen(eptr);
9828 eptr = (char *)nullstr;
9829 elen = sizeof nullstr - 1;
9833 eptr = SvPV_const(argsv, elen);
9834 if (DO_UTF8(argsv)) {
9835 STRLEN old_precis = precis;
9836 if (has_precis && precis < elen) {
9837 STRLEN ulen = sv_len_utf8(argsv);
9838 I32 p = precis > ulen ? ulen : precis;
9839 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9842 if (width) { /* fudge width (can't fudge elen) */
9843 if (has_precis && precis < elen)
9844 width += precis - old_precis;
9846 width += elen - sv_len_utf8(argsv);
9853 if (has_precis && precis < elen)
9860 if (alt || vectorize)
9862 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9883 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9892 esignbuf[esignlen++] = plus;
9896 case 'h': iv = (short)va_arg(*args, int); break;
9897 case 'l': iv = va_arg(*args, long); break;
9898 case 'V': iv = va_arg(*args, IV); break;
9899 default: iv = va_arg(*args, int); break;
9902 iv = va_arg(*args, Quad_t); break;
9909 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9911 case 'h': iv = (short)tiv; break;
9912 case 'l': iv = (long)tiv; break;
9914 default: iv = tiv; break;
9917 iv = (Quad_t)tiv; break;
9923 if ( !vectorize ) /* we already set uv above */
9928 esignbuf[esignlen++] = plus;
9932 esignbuf[esignlen++] = '-';
9976 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9987 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9988 case 'l': uv = va_arg(*args, unsigned long); break;
9989 case 'V': uv = va_arg(*args, UV); break;
9990 default: uv = va_arg(*args, unsigned); break;
9993 uv = va_arg(*args, Uquad_t); break;
10000 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10002 case 'h': uv = (unsigned short)tuv; break;
10003 case 'l': uv = (unsigned long)tuv; break;
10005 default: uv = tuv; break;
10008 uv = (Uquad_t)tuv; break;
10017 char *ptr = ebuf + sizeof ebuf;
10018 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10024 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10028 } while (uv >>= 4);
10030 esignbuf[esignlen++] = '0';
10031 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10037 *--ptr = '0' + dig;
10038 } while (uv >>= 3);
10039 if (alt && *ptr != '0')
10045 *--ptr = '0' + dig;
10046 } while (uv >>= 1);
10048 esignbuf[esignlen++] = '0';
10049 esignbuf[esignlen++] = c;
10052 default: /* it had better be ten or less */
10055 *--ptr = '0' + dig;
10056 } while (uv /= base);
10059 elen = (ebuf + sizeof ebuf) - ptr;
10063 zeros = precis - elen;
10064 else if (precis == 0 && elen == 1 && *eptr == '0'
10065 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10068 /* a precision nullifies the 0 flag. */
10075 /* FLOATING POINT */
10078 c = 'f'; /* maybe %F isn't supported here */
10080 case 'e': case 'E':
10082 case 'g': case 'G':
10086 /* This is evil, but floating point is even more evil */
10088 /* for SV-style calling, we can only get NV
10089 for C-style calling, we assume %f is double;
10090 for simplicity we allow any of %Lf, %llf, %qf for long double
10094 #if defined(USE_LONG_DOUBLE)
10098 /* [perl #20339] - we should accept and ignore %lf rather than die */
10102 #if defined(USE_LONG_DOUBLE)
10103 intsize = args ? 0 : 'q';
10107 #if defined(HAS_LONG_DOUBLE)
10116 /* now we need (long double) if intsize == 'q', else (double) */
10118 #if LONG_DOUBLESIZE > DOUBLESIZE
10120 va_arg(*args, long double) :
10121 va_arg(*args, double)
10123 va_arg(*args, double)
10128 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10129 else. frexp() has some unspecified behaviour for those three */
10130 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10132 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10133 will cast our (long double) to (double) */
10134 (void)Perl_frexp(nv, &i);
10135 if (i == PERL_INT_MIN)
10136 Perl_die(aTHX_ "panic: frexp");
10138 need = BIT_DIGITS(i);
10140 need += has_precis ? precis : 6; /* known default */
10145 #ifdef HAS_LDBL_SPRINTF_BUG
10146 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10147 with sfio - Allen <allens@cpan.org> */
10150 # define MY_DBL_MAX DBL_MAX
10151 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10152 # if DOUBLESIZE >= 8
10153 # define MY_DBL_MAX 1.7976931348623157E+308L
10155 # define MY_DBL_MAX 3.40282347E+38L
10159 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10160 # define MY_DBL_MAX_BUG 1L
10162 # define MY_DBL_MAX_BUG MY_DBL_MAX
10166 # define MY_DBL_MIN DBL_MIN
10167 # else /* XXX guessing! -Allen */
10168 # if DOUBLESIZE >= 8
10169 # define MY_DBL_MIN 2.2250738585072014E-308L
10171 # define MY_DBL_MIN 1.17549435E-38L
10175 if ((intsize == 'q') && (c == 'f') &&
10176 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10177 (need < DBL_DIG)) {
10178 /* it's going to be short enough that
10179 * long double precision is not needed */
10181 if ((nv <= 0L) && (nv >= -0L))
10182 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10184 /* would use Perl_fp_class as a double-check but not
10185 * functional on IRIX - see perl.h comments */
10187 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10188 /* It's within the range that a double can represent */
10189 #if defined(DBL_MAX) && !defined(DBL_MIN)
10190 if ((nv >= ((long double)1/DBL_MAX)) ||
10191 (nv <= (-(long double)1/DBL_MAX)))
10193 fix_ldbl_sprintf_bug = TRUE;
10196 if (fix_ldbl_sprintf_bug == TRUE) {
10206 # undef MY_DBL_MAX_BUG
10209 #endif /* HAS_LDBL_SPRINTF_BUG */
10211 need += 20; /* fudge factor */
10212 if (PL_efloatsize < need) {
10213 Safefree(PL_efloatbuf);
10214 PL_efloatsize = need + 20; /* more fudge */
10215 Newx(PL_efloatbuf, PL_efloatsize, char);
10216 PL_efloatbuf[0] = '\0';
10219 if ( !(width || left || plus || alt) && fill != '0'
10220 && has_precis && intsize != 'q' ) { /* Shortcuts */
10221 /* See earlier comment about buggy Gconvert when digits,
10223 if ( c == 'g' && precis) {
10224 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10225 /* May return an empty string for digits==0 */
10226 if (*PL_efloatbuf) {
10227 elen = strlen(PL_efloatbuf);
10228 goto float_converted;
10230 } else if ( c == 'f' && !precis) {
10231 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10236 char *ptr = ebuf + sizeof ebuf;
10239 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10240 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10241 if (intsize == 'q') {
10242 /* Copy the one or more characters in a long double
10243 * format before the 'base' ([efgEFG]) character to
10244 * the format string. */
10245 static char const prifldbl[] = PERL_PRIfldbl;
10246 char const *p = prifldbl + sizeof(prifldbl) - 3;
10247 while (p >= prifldbl) { *--ptr = *p--; }
10252 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10257 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10269 /* No taint. Otherwise we are in the strange situation
10270 * where printf() taints but print($float) doesn't.
10272 #if defined(HAS_LONG_DOUBLE)
10273 elen = ((intsize == 'q')
10274 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10275 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10277 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10281 eptr = PL_efloatbuf;
10289 i = SvCUR(sv) - origlen;
10292 case 'h': *(va_arg(*args, short*)) = i; break;
10293 default: *(va_arg(*args, int*)) = i; break;
10294 case 'l': *(va_arg(*args, long*)) = i; break;
10295 case 'V': *(va_arg(*args, IV*)) = i; break;
10298 *(va_arg(*args, Quad_t*)) = i; break;
10305 sv_setuv_mg(argsv, (UV)i);
10306 continue; /* not "break" */
10313 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
10314 && ckWARN(WARN_PRINTF))
10316 SV * const msg = sv_newmortal();
10317 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10318 (PL_op->op_type == OP_PRTF) ? "" : "s");
10319 if (fmtstart < patend) {
10320 const char * const fmtend = q < patend ? q : patend;
10322 sv_catpvs(msg, "\"%");
10323 for (f = fmtstart; f < fmtend; f++) {
10325 sv_catpvn(msg, f, 1);
10327 Perl_sv_catpvf(aTHX_ msg,
10328 "\\%03"UVof, (UV)*f & 0xFF);
10331 sv_catpvs(msg, "\"");
10333 sv_catpvs(msg, "end of string");
10335 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
10338 /* output mangled stuff ... */
10344 /* ... right here, because formatting flags should not apply */
10345 SvGROW(sv, SvCUR(sv) + elen + 1);
10347 Copy(eptr, p, elen, char);
10350 SvCUR_set(sv, p - SvPVX_const(sv));
10352 continue; /* not "break" */
10355 if (is_utf8 != has_utf8) {
10358 sv_utf8_upgrade(sv);
10361 const STRLEN old_elen = elen;
10362 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
10363 sv_utf8_upgrade(nsv);
10364 eptr = SvPVX_const(nsv);
10367 if (width) { /* fudge width (can't fudge elen) */
10368 width += elen - old_elen;
10374 have = esignlen + zeros + elen;
10376 Perl_croak_nocontext("%s", PL_memory_wrap);
10378 need = (have > width ? have : width);
10381 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10382 Perl_croak_nocontext("%s", PL_memory_wrap);
10383 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10385 if (esignlen && fill == '0') {
10387 for (i = 0; i < (int)esignlen; i++)
10388 *p++ = esignbuf[i];
10390 if (gap && !left) {
10391 memset(p, fill, gap);
10394 if (esignlen && fill != '0') {
10396 for (i = 0; i < (int)esignlen; i++)
10397 *p++ = esignbuf[i];
10401 for (i = zeros; i; i--)
10405 Copy(eptr, p, elen, char);
10409 memset(p, ' ', gap);
10414 Copy(dotstr, p, dotstrlen, char);
10418 vectorize = FALSE; /* done iterating over vecstr */
10425 SvCUR_set(sv, p - SvPVX_const(sv));
10433 /* =========================================================================
10435 =head1 Cloning an interpreter
10437 All the macros and functions in this section are for the private use of
10438 the main function, perl_clone().
10440 The foo_dup() functions make an exact copy of an existing foo thingy.
10441 During the course of a cloning, a hash table is used to map old addresses
10442 to new addresses. The table is created and manipulated with the
10443 ptr_table_* functions.
10447 * =========================================================================*/
10450 #if defined(USE_ITHREADS)
10452 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10453 #ifndef GpREFCNT_inc
10454 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10458 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10459 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10460 If this changes, please unmerge ss_dup.
10461 Likewise, sv_dup_inc_multiple() relies on this fact. */
10462 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10463 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10464 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
10465 #define av_dup_inc(s,t) MUTABLE_AV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10466 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
10467 #define hv_dup_inc(s,t) MUTABLE_HV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10468 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
10469 #define cv_dup_inc(s,t) MUTABLE_CV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10470 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
10471 #define io_dup_inc(s,t) MUTABLE_IO(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10472 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
10473 #define gv_dup_inc(s,t) MUTABLE_GV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10474 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10475 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10477 /* clone a parser */
10480 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10484 PERL_ARGS_ASSERT_PARSER_DUP;
10489 /* look for it in the table first */
10490 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10494 /* create anew and remember what it is */
10495 Newxz(parser, 1, yy_parser);
10496 ptr_table_store(PL_ptr_table, proto, parser);
10498 parser->yyerrstatus = 0;
10499 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10501 /* XXX these not yet duped */
10502 parser->old_parser = NULL;
10503 parser->stack = NULL;
10505 parser->stack_size = 0;
10506 /* XXX parser->stack->state = 0; */
10508 /* XXX eventually, just Copy() most of the parser struct ? */
10510 parser->lex_brackets = proto->lex_brackets;
10511 parser->lex_casemods = proto->lex_casemods;
10512 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10513 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10514 parser->lex_casestack = savepvn(proto->lex_casestack,
10515 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10516 parser->lex_defer = proto->lex_defer;
10517 parser->lex_dojoin = proto->lex_dojoin;
10518 parser->lex_expect = proto->lex_expect;
10519 parser->lex_formbrack = proto->lex_formbrack;
10520 parser->lex_inpat = proto->lex_inpat;
10521 parser->lex_inwhat = proto->lex_inwhat;
10522 parser->lex_op = proto->lex_op;
10523 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10524 parser->lex_starts = proto->lex_starts;
10525 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10526 parser->multi_close = proto->multi_close;
10527 parser->multi_open = proto->multi_open;
10528 parser->multi_start = proto->multi_start;
10529 parser->multi_end = proto->multi_end;
10530 parser->pending_ident = proto->pending_ident;
10531 parser->preambled = proto->preambled;
10532 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10533 parser->linestr = sv_dup_inc(proto->linestr, param);
10534 parser->expect = proto->expect;
10535 parser->copline = proto->copline;
10536 parser->last_lop_op = proto->last_lop_op;
10537 parser->lex_state = proto->lex_state;
10538 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10539 /* rsfp_filters entries have fake IoDIRP() */
10540 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10541 parser->in_my = proto->in_my;
10542 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10543 parser->error_count = proto->error_count;
10546 parser->linestr = sv_dup_inc(proto->linestr, param);
10549 char * const ols = SvPVX(proto->linestr);
10550 char * const ls = SvPVX(parser->linestr);
10552 parser->bufptr = ls + (proto->bufptr >= ols ?
10553 proto->bufptr - ols : 0);
10554 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10555 proto->oldbufptr - ols : 0);
10556 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10557 proto->oldoldbufptr - ols : 0);
10558 parser->linestart = ls + (proto->linestart >= ols ?
10559 proto->linestart - ols : 0);
10560 parser->last_uni = ls + (proto->last_uni >= ols ?
10561 proto->last_uni - ols : 0);
10562 parser->last_lop = ls + (proto->last_lop >= ols ?
10563 proto->last_lop - ols : 0);
10565 parser->bufend = ls + SvCUR(parser->linestr);
10568 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10572 parser->endwhite = proto->endwhite;
10573 parser->faketokens = proto->faketokens;
10574 parser->lasttoke = proto->lasttoke;
10575 parser->nextwhite = proto->nextwhite;
10576 parser->realtokenstart = proto->realtokenstart;
10577 parser->skipwhite = proto->skipwhite;
10578 parser->thisclose = proto->thisclose;
10579 parser->thismad = proto->thismad;
10580 parser->thisopen = proto->thisopen;
10581 parser->thisstuff = proto->thisstuff;
10582 parser->thistoken = proto->thistoken;
10583 parser->thiswhite = proto->thiswhite;
10585 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10586 parser->curforce = proto->curforce;
10588 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10589 Copy(proto->nexttype, parser->nexttype, 5, I32);
10590 parser->nexttoke = proto->nexttoke;
10593 /* XXX should clone saved_curcop here, but we aren't passed
10594 * proto_perl; so do it in perl_clone_using instead */
10600 /* duplicate a file handle */
10603 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10607 PERL_ARGS_ASSERT_FP_DUP;
10608 PERL_UNUSED_ARG(type);
10611 return (PerlIO*)NULL;
10613 /* look for it in the table first */
10614 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10618 /* create anew and remember what it is */
10619 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10620 ptr_table_store(PL_ptr_table, fp, ret);
10624 /* duplicate a directory handle */
10627 Perl_dirp_dup(pTHX_ DIR *const dp)
10629 PERL_UNUSED_CONTEXT;
10636 /* duplicate a typeglob */
10639 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10643 PERL_ARGS_ASSERT_GP_DUP;
10647 /* look for it in the table first */
10648 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10652 /* create anew and remember what it is */
10654 ptr_table_store(PL_ptr_table, gp, ret);
10657 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
10658 on Newxz() to do this for us. */
10659 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10660 ret->gp_io = io_dup_inc(gp->gp_io, param);
10661 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10662 ret->gp_av = av_dup_inc(gp->gp_av, param);
10663 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10664 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10665 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10666 ret->gp_cvgen = gp->gp_cvgen;
10667 ret->gp_line = gp->gp_line;
10668 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10672 /* duplicate a chain of magic */
10675 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10677 MAGIC *mgret = NULL;
10678 MAGIC **mgprev_p = &mgret;
10680 PERL_ARGS_ASSERT_MG_DUP;
10682 for (; mg; mg = mg->mg_moremagic) {
10684 Newx(nmg, 1, MAGIC);
10686 mgprev_p = &(nmg->mg_moremagic);
10688 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
10689 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
10690 from the original commit adding Perl_mg_dup() - revision 4538.
10691 Similarly there is the annotation "XXX random ptr?" next to the
10692 assignment to nmg->mg_ptr. */
10695 /* FIXME for plugins
10696 if (nmg->mg_type == PERL_MAGIC_qr) {
10697 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
10701 if(nmg->mg_type == PERL_MAGIC_backref) {
10702 /* The backref AV has its reference count deliberately bumped by
10705 = SvREFCNT_inc(av_dup_inc((const AV *) nmg->mg_obj, param));
10708 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
10709 ? sv_dup_inc(nmg->mg_obj, param)
10710 : sv_dup(nmg->mg_obj, param);
10713 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
10714 if (nmg->mg_len > 0) {
10715 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
10716 if (nmg->mg_type == PERL_MAGIC_overload_table &&
10717 AMT_AMAGIC((AMT*)nmg->mg_ptr))
10719 AMT * const namtp = (AMT*)nmg->mg_ptr;
10720 sv_dup_inc_multiple((SV**)(namtp->table),
10721 (SV**)(namtp->table), NofAMmeth, param);
10724 else if (nmg->mg_len == HEf_SVKEY)
10725 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
10727 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
10728 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10734 #endif /* USE_ITHREADS */
10736 /* create a new pointer-mapping table */
10739 Perl_ptr_table_new(pTHX)
10742 PERL_UNUSED_CONTEXT;
10744 Newx(tbl, 1, PTR_TBL_t);
10745 tbl->tbl_max = 511;
10746 tbl->tbl_items = 0;
10747 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10751 #define PTR_TABLE_HASH(ptr) \
10752 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10755 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10756 following define) and at call to new_body_inline made below in
10757 Perl_ptr_table_store()
10760 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10762 /* map an existing pointer using a table */
10764 STATIC PTR_TBL_ENT_t *
10765 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10767 PTR_TBL_ENT_t *tblent;
10768 const UV hash = PTR_TABLE_HASH(sv);
10770 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10772 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10773 for (; tblent; tblent = tblent->next) {
10774 if (tblent->oldval == sv)
10781 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10783 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10785 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10786 PERL_UNUSED_CONTEXT;
10788 return tblent ? tblent->newval : NULL;
10791 /* add a new entry to a pointer-mapping table */
10794 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10796 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10798 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10799 PERL_UNUSED_CONTEXT;
10802 tblent->newval = newsv;
10804 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10806 new_body_inline(tblent, PTE_SVSLOT);
10808 tblent->oldval = oldsv;
10809 tblent->newval = newsv;
10810 tblent->next = tbl->tbl_ary[entry];
10811 tbl->tbl_ary[entry] = tblent;
10813 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10814 ptr_table_split(tbl);
10818 /* double the hash bucket size of an existing ptr table */
10821 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10823 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10824 const UV oldsize = tbl->tbl_max + 1;
10825 UV newsize = oldsize * 2;
10828 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10829 PERL_UNUSED_CONTEXT;
10831 Renew(ary, newsize, PTR_TBL_ENT_t*);
10832 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10833 tbl->tbl_max = --newsize;
10834 tbl->tbl_ary = ary;
10835 for (i=0; i < oldsize; i++, ary++) {
10836 PTR_TBL_ENT_t **curentp, **entp, *ent;
10839 curentp = ary + oldsize;
10840 for (entp = ary, ent = *ary; ent; ent = *entp) {
10841 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10843 ent->next = *curentp;
10853 /* remove all the entries from a ptr table */
10856 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10858 if (tbl && tbl->tbl_items) {
10859 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10860 UV riter = tbl->tbl_max;
10863 PTR_TBL_ENT_t *entry = array[riter];
10866 PTR_TBL_ENT_t * const oentry = entry;
10867 entry = entry->next;
10872 tbl->tbl_items = 0;
10876 /* clear and free a ptr table */
10879 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10884 ptr_table_clear(tbl);
10885 Safefree(tbl->tbl_ary);
10889 #if defined(USE_ITHREADS)
10892 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10894 PERL_ARGS_ASSERT_RVPV_DUP;
10897 SvRV_set(dstr, SvWEAKREF(sstr)
10898 ? sv_dup(SvRV_const(sstr), param)
10899 : sv_dup_inc(SvRV_const(sstr), param));
10902 else if (SvPVX_const(sstr)) {
10903 /* Has something there */
10905 /* Normal PV - clone whole allocated space */
10906 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10907 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10908 /* Not that normal - actually sstr is copy on write.
10909 But we are a true, independant SV, so: */
10910 SvREADONLY_off(dstr);
10915 /* Special case - not normally malloced for some reason */
10916 if (isGV_with_GP(sstr)) {
10917 /* Don't need to do anything here. */
10919 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10920 /* A "shared" PV - clone it as "shared" PV */
10922 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10926 /* Some other special case - random pointer */
10927 SvPV_set(dstr, (char *) SvPVX_const(sstr));
10932 /* Copy the NULL */
10933 SvPV_set(dstr, NULL);
10937 /* duplicate a list of SVs. source and dest may point to the same memory. */
10939 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
10940 SSize_t items, CLONE_PARAMS *const param)
10942 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
10944 while (items-- > 0) {
10945 *dest++ = sv_dup_inc(*source++, param);
10951 /* duplicate an SV of any type (including AV, HV etc) */
10954 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10959 PERL_ARGS_ASSERT_SV_DUP;
10963 if (SvTYPE(sstr) == SVTYPEMASK) {
10964 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10969 /* look for it in the table first */
10970 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
10974 if(param->flags & CLONEf_JOIN_IN) {
10975 /** We are joining here so we don't want do clone
10976 something that is bad **/
10977 if (SvTYPE(sstr) == SVt_PVHV) {
10978 const HEK * const hvname = HvNAME_HEK(sstr);
10980 /** don't clone stashes if they already exist **/
10981 return MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
10985 /* create anew and remember what it is */
10988 #ifdef DEBUG_LEAKING_SCALARS
10989 dstr->sv_debug_optype = sstr->sv_debug_optype;
10990 dstr->sv_debug_line = sstr->sv_debug_line;
10991 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10992 dstr->sv_debug_cloned = 1;
10993 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10996 ptr_table_store(PL_ptr_table, sstr, dstr);
10999 SvFLAGS(dstr) = SvFLAGS(sstr);
11000 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11001 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11004 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11005 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11006 (void*)PL_watch_pvx, SvPVX_const(sstr));
11009 /* don't clone objects whose class has asked us not to */
11010 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11015 switch (SvTYPE(sstr)) {
11017 SvANY(dstr) = NULL;
11020 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11022 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11024 SvIV_set(dstr, SvIVX(sstr));
11028 SvANY(dstr) = new_XNV();
11029 SvNV_set(dstr, SvNVX(sstr));
11031 /* case SVt_BIND: */
11034 /* These are all the types that need complex bodies allocating. */
11036 const svtype sv_type = SvTYPE(sstr);
11037 const struct body_details *const sv_type_details
11038 = bodies_by_type + sv_type;
11042 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11057 assert(sv_type_details->body_size);
11058 if (sv_type_details->arena) {
11059 new_body_inline(new_body, sv_type);
11061 = (void*)((char*)new_body - sv_type_details->offset);
11063 new_body = new_NOARENA(sv_type_details);
11067 SvANY(dstr) = new_body;
11070 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11071 ((char*)SvANY(dstr)) + sv_type_details->offset,
11072 sv_type_details->copy, char);
11074 Copy(((char*)SvANY(sstr)),
11075 ((char*)SvANY(dstr)),
11076 sv_type_details->body_size + sv_type_details->offset, char);
11079 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11080 && !isGV_with_GP(dstr))
11081 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11083 /* The Copy above means that all the source (unduplicated) pointers
11084 are now in the destination. We can check the flags and the
11085 pointers in either, but it's possible that there's less cache
11086 missing by always going for the destination.
11087 FIXME - instrument and check that assumption */
11088 if (sv_type >= SVt_PVMG) {
11089 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11090 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11091 } else if (SvMAGIC(dstr))
11092 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11094 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11097 /* The cast silences a GCC warning about unhandled types. */
11098 switch ((int)sv_type) {
11108 /* FIXME for plugins */
11109 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11112 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11113 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11114 LvTARG(dstr) = dstr;
11115 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11116 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11118 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11120 if(isGV_with_GP(sstr)) {
11121 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11122 /* Don't call sv_add_backref here as it's going to be
11123 created as part of the magic cloning of the symbol
11124 table--unless this is during a join and the stash
11125 is not actually being cloned. */
11126 /* Danger Will Robinson - GvGP(dstr) isn't initialised
11127 at the point of this comment. */
11128 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11129 if(param->flags & CLONEf_JOIN_IN) {
11130 const HEK * const hvname
11131 = HvNAME_HEK(GvSTASH(dstr));
11133 && GvSTASH(dstr) == gv_stashpvn(
11134 HEK_KEY(hvname), HEK_LEN(hvname), 0
11137 Perl_sv_add_backref(
11138 aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr
11141 GvGP(dstr) = gp_dup(GvGP(sstr), param);
11142 (void)GpREFCNT_inc(GvGP(dstr));
11144 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11147 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
11148 if (IoOFP(dstr) == IoIFP(sstr))
11149 IoOFP(dstr) = IoIFP(dstr);
11151 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11152 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11153 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11154 /* I have no idea why fake dirp (rsfps)
11155 should be treated differently but otherwise
11156 we end up with leaks -- sky*/
11157 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
11158 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
11159 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11161 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
11162 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
11163 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
11164 if (IoDIRP(dstr)) {
11165 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
11168 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
11171 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
11172 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
11173 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
11176 /* avoid cloning an empty array */
11177 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11178 SV **dst_ary, **src_ary;
11179 SSize_t items = AvFILLp((const AV *)sstr) + 1;
11181 src_ary = AvARRAY((const AV *)sstr);
11182 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
11183 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11184 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
11185 AvALLOC((const AV *)dstr) = dst_ary;
11186 if (AvREAL((const AV *)sstr)) {
11187 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
11191 while (items-- > 0)
11192 *dst_ary++ = sv_dup(*src_ary++, param);
11193 if (!(param->flags & CLONEf_COPY_STACKS)
11196 av_reify(MUTABLE_AV(dstr)); /* #41138 */
11199 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
11200 while (items-- > 0) {
11201 *dst_ary++ = &PL_sv_undef;
11205 AvARRAY(MUTABLE_AV(dstr)) = NULL;
11206 AvALLOC((const AV *)dstr) = (SV**)NULL;
11207 AvMAX( (const AV *)dstr) = -1;
11208 AvFILLp((const AV *)dstr) = -1;
11212 if (HvARRAY((const HV *)sstr)) {
11214 const bool sharekeys = !!HvSHAREKEYS(sstr);
11215 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11216 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11218 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11219 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
11221 HvARRAY(dstr) = (HE**)darray;
11222 while (i <= sxhv->xhv_max) {
11223 const HE * const source = HvARRAY(sstr)[i];
11224 HvARRAY(dstr)[i] = source
11225 ? he_dup(source, sharekeys, param) : 0;
11230 const struct xpvhv_aux * const saux = HvAUX(sstr);
11231 struct xpvhv_aux * const daux = HvAUX(dstr);
11232 /* This flag isn't copied. */
11233 /* SvOOK_on(hv) attacks the IV flags. */
11234 SvFLAGS(dstr) |= SVf_OOK;
11236 hvname = saux->xhv_name;
11237 daux->xhv_name = hek_dup(hvname, param);
11239 daux->xhv_riter = saux->xhv_riter;
11240 daux->xhv_eiter = saux->xhv_eiter
11241 ? he_dup(saux->xhv_eiter,
11242 (bool)!!HvSHAREKEYS(sstr), param) : 0;
11243 /* backref array needs refcnt=2; see sv_add_backref */
11244 daux->xhv_backreferences =
11245 saux->xhv_backreferences
11246 ? MUTABLE_AV(SvREFCNT_inc(
11247 sv_dup_inc((const SV *)saux->xhv_backreferences, param)))
11250 daux->xhv_mro_meta = saux->xhv_mro_meta
11251 ? mro_meta_dup(saux->xhv_mro_meta, param)
11254 /* Record stashes for possible cloning in Perl_clone(). */
11256 av_push(param->stashes, dstr);
11260 HvARRAY(MUTABLE_HV(dstr)) = NULL;
11263 if (!(param->flags & CLONEf_COPY_STACKS)) {
11267 /* NOTE: not refcounted */
11268 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
11270 if (!CvISXSUB(dstr))
11271 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
11273 if (CvCONST(dstr) && CvISXSUB(dstr)) {
11274 CvXSUBANY(dstr).any_ptr =
11275 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
11277 /* don't dup if copying back - CvGV isn't refcounted, so the
11278 * duped GV may never be freed. A bit of a hack! DAPM */
11279 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11280 NULL : gv_dup(CvGV(dstr), param) ;
11281 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11283 CvWEAKOUTSIDE(sstr)
11284 ? cv_dup( CvOUTSIDE(dstr), param)
11285 : cv_dup_inc(CvOUTSIDE(dstr), param);
11286 if (!CvISXSUB(dstr))
11287 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
11293 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11299 /* duplicate a context */
11302 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11304 PERL_CONTEXT *ncxs;
11306 PERL_ARGS_ASSERT_CX_DUP;
11309 return (PERL_CONTEXT*)NULL;
11311 /* look for it in the table first */
11312 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11316 /* create anew and remember what it is */
11317 Newx(ncxs, max + 1, PERL_CONTEXT);
11318 ptr_table_store(PL_ptr_table, cxs, ncxs);
11319 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
11322 PERL_CONTEXT * const ncx = &ncxs[ix];
11323 if (CxTYPE(ncx) == CXt_SUBST) {
11324 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11327 switch (CxTYPE(ncx)) {
11329 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
11330 ? cv_dup_inc(ncx->blk_sub.cv, param)
11331 : cv_dup(ncx->blk_sub.cv,param));
11332 ncx->blk_sub.argarray = (CxHASARGS(ncx)
11333 ? av_dup_inc(ncx->blk_sub.argarray,
11336 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
11338 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
11339 ncx->blk_sub.oldcomppad);
11342 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
11344 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
11346 case CXt_LOOP_LAZYSV:
11347 ncx->blk_loop.state_u.lazysv.end
11348 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
11349 /* We are taking advantage of av_dup_inc and sv_dup_inc
11350 actually being the same function, and order equivalance of
11352 We can assert the later [but only at run time :-(] */
11353 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
11354 (void *) &ncx->blk_loop.state_u.lazysv.cur);
11356 ncx->blk_loop.state_u.ary.ary
11357 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
11358 case CXt_LOOP_LAZYIV:
11359 case CXt_LOOP_PLAIN:
11360 if (CxPADLOOP(ncx)) {
11361 ncx->blk_loop.oldcomppad
11362 = (PAD*)ptr_table_fetch(PL_ptr_table,
11363 ncx->blk_loop.oldcomppad);
11365 ncx->blk_loop.oldcomppad
11366 = (PAD*)gv_dup((const GV *)ncx->blk_loop.oldcomppad,
11371 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
11372 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
11373 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
11386 /* duplicate a stack info structure */
11389 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11393 PERL_ARGS_ASSERT_SI_DUP;
11396 return (PERL_SI*)NULL;
11398 /* look for it in the table first */
11399 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11403 /* create anew and remember what it is */
11404 Newxz(nsi, 1, PERL_SI);
11405 ptr_table_store(PL_ptr_table, si, nsi);
11407 nsi->si_stack = av_dup_inc(si->si_stack, param);
11408 nsi->si_cxix = si->si_cxix;
11409 nsi->si_cxmax = si->si_cxmax;
11410 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11411 nsi->si_type = si->si_type;
11412 nsi->si_prev = si_dup(si->si_prev, param);
11413 nsi->si_next = si_dup(si->si_next, param);
11414 nsi->si_markoff = si->si_markoff;
11419 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11420 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11421 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11422 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11423 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11424 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11425 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11426 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11427 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11428 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11429 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11430 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11431 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11432 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11435 #define pv_dup_inc(p) SAVEPV(p)
11436 #define pv_dup(p) SAVEPV(p)
11437 #define svp_dup_inc(p,pp) any_dup(p,pp)
11439 /* map any object to the new equivent - either something in the
11440 * ptr table, or something in the interpreter structure
11444 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
11448 PERL_ARGS_ASSERT_ANY_DUP;
11451 return (void*)NULL;
11453 /* look for it in the table first */
11454 ret = ptr_table_fetch(PL_ptr_table, v);
11458 /* see if it is part of the interpreter structure */
11459 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11460 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11468 /* duplicate the save stack */
11471 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11474 ANY * const ss = proto_perl->Isavestack;
11475 const I32 max = proto_perl->Isavestack_max;
11476 I32 ix = proto_perl->Isavestack_ix;
11489 void (*dptr) (void*);
11490 void (*dxptr) (pTHX_ void*);
11492 PERL_ARGS_ASSERT_SS_DUP;
11494 Newxz(nss, max, ANY);
11497 const I32 type = POPINT(ss,ix);
11498 TOPINT(nss,ix) = type;
11500 case SAVEt_HELEM: /* hash element */
11501 sv = (const SV *)POPPTR(ss,ix);
11502 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11504 case SAVEt_ITEM: /* normal string */
11505 case SAVEt_SV: /* scalar reference */
11506 sv = (const SV *)POPPTR(ss,ix);
11507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11510 case SAVEt_MORTALIZESV:
11511 sv = (const SV *)POPPTR(ss,ix);
11512 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11514 case SAVEt_SHARED_PVREF: /* char* in shared space */
11515 c = (char*)POPPTR(ss,ix);
11516 TOPPTR(nss,ix) = savesharedpv(c);
11517 ptr = POPPTR(ss,ix);
11518 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11520 case SAVEt_GENERIC_SVREF: /* generic sv */
11521 case SAVEt_SVREF: /* scalar reference */
11522 sv = (const SV *)POPPTR(ss,ix);
11523 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11524 ptr = POPPTR(ss,ix);
11525 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11527 case SAVEt_HV: /* hash reference */
11528 case SAVEt_AV: /* array reference */
11529 sv = (const SV *) POPPTR(ss,ix);
11530 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11532 case SAVEt_COMPPAD:
11534 sv = (const SV *) POPPTR(ss,ix);
11535 TOPPTR(nss,ix) = sv_dup(sv, param);
11537 case SAVEt_INT: /* int reference */
11538 ptr = POPPTR(ss,ix);
11539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11540 intval = (int)POPINT(ss,ix);
11541 TOPINT(nss,ix) = intval;
11543 case SAVEt_LONG: /* long reference */
11544 ptr = POPPTR(ss,ix);
11545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11547 case SAVEt_CLEARSV:
11548 longval = (long)POPLONG(ss,ix);
11549 TOPLONG(nss,ix) = longval;
11551 case SAVEt_I32: /* I32 reference */
11552 case SAVEt_I16: /* I16 reference */
11553 case SAVEt_I8: /* I8 reference */
11554 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11555 ptr = POPPTR(ss,ix);
11556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11558 TOPINT(nss,ix) = i;
11560 case SAVEt_IV: /* IV reference */
11561 ptr = POPPTR(ss,ix);
11562 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11564 TOPIV(nss,ix) = iv;
11566 case SAVEt_HPTR: /* HV* reference */
11567 case SAVEt_APTR: /* AV* reference */
11568 case SAVEt_SPTR: /* SV* reference */
11569 ptr = POPPTR(ss,ix);
11570 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11571 sv = (const SV *)POPPTR(ss,ix);
11572 TOPPTR(nss,ix) = sv_dup(sv, param);
11574 case SAVEt_VPTR: /* random* reference */
11575 ptr = POPPTR(ss,ix);
11576 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11577 ptr = POPPTR(ss,ix);
11578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11580 case SAVEt_GENERIC_PVREF: /* generic char* */
11581 case SAVEt_PPTR: /* char* reference */
11582 ptr = POPPTR(ss,ix);
11583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11584 c = (char*)POPPTR(ss,ix);
11585 TOPPTR(nss,ix) = pv_dup(c);
11587 case SAVEt_GP: /* scalar reference */
11588 gp = (GP*)POPPTR(ss,ix);
11589 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11590 (void)GpREFCNT_inc(gp);
11591 gv = (const GV *)POPPTR(ss,ix);
11592 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11595 ptr = POPPTR(ss,ix);
11596 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11597 /* these are assumed to be refcounted properly */
11599 switch (((OP*)ptr)->op_type) {
11601 case OP_LEAVESUBLV:
11605 case OP_LEAVEWRITE:
11606 TOPPTR(nss,ix) = ptr;
11609 (void) OpREFCNT_inc(o);
11613 TOPPTR(nss,ix) = NULL;
11618 TOPPTR(nss,ix) = NULL;
11621 hv = (const HV *)POPPTR(ss,ix);
11622 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11624 TOPINT(nss,ix) = i;
11627 c = (char*)POPPTR(ss,ix);
11628 TOPPTR(nss,ix) = pv_dup_inc(c);
11630 case SAVEt_STACK_POS: /* Position on Perl stack */
11632 TOPINT(nss,ix) = i;
11634 case SAVEt_DESTRUCTOR:
11635 ptr = POPPTR(ss,ix);
11636 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11637 dptr = POPDPTR(ss,ix);
11638 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11639 any_dup(FPTR2DPTR(void *, dptr),
11642 case SAVEt_DESTRUCTOR_X:
11643 ptr = POPPTR(ss,ix);
11644 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11645 dxptr = POPDXPTR(ss,ix);
11646 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11647 any_dup(FPTR2DPTR(void *, dxptr),
11650 case SAVEt_REGCONTEXT:
11653 TOPINT(nss,ix) = i;
11656 case SAVEt_AELEM: /* array element */
11657 sv = (const SV *)POPPTR(ss,ix);
11658 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11660 TOPINT(nss,ix) = i;
11661 av = (const AV *)POPPTR(ss,ix);
11662 TOPPTR(nss,ix) = av_dup_inc(av, param);
11665 ptr = POPPTR(ss,ix);
11666 TOPPTR(nss,ix) = ptr;
11669 ptr = POPPTR(ss,ix);
11672 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11673 HINTS_REFCNT_UNLOCK;
11675 TOPPTR(nss,ix) = ptr;
11677 TOPINT(nss,ix) = i;
11678 if (i & HINT_LOCALIZE_HH) {
11679 hv = (const HV *)POPPTR(ss,ix);
11680 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11683 case SAVEt_PADSV_AND_MORTALIZE:
11684 longval = (long)POPLONG(ss,ix);
11685 TOPLONG(nss,ix) = longval;
11686 ptr = POPPTR(ss,ix);
11687 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11688 sv = (const SV *)POPPTR(ss,ix);
11689 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11692 ptr = POPPTR(ss,ix);
11693 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11694 longval = (long)POPBOOL(ss,ix);
11695 TOPBOOL(nss,ix) = (bool)longval;
11697 case SAVEt_SET_SVFLAGS:
11699 TOPINT(nss,ix) = i;
11701 TOPINT(nss,ix) = i;
11702 sv = (const SV *)POPPTR(ss,ix);
11703 TOPPTR(nss,ix) = sv_dup(sv, param);
11705 case SAVEt_RE_STATE:
11707 const struct re_save_state *const old_state
11708 = (struct re_save_state *)
11709 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11710 struct re_save_state *const new_state
11711 = (struct re_save_state *)
11712 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11714 Copy(old_state, new_state, 1, struct re_save_state);
11715 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11717 new_state->re_state_bostr
11718 = pv_dup(old_state->re_state_bostr);
11719 new_state->re_state_reginput
11720 = pv_dup(old_state->re_state_reginput);
11721 new_state->re_state_regeol
11722 = pv_dup(old_state->re_state_regeol);
11723 new_state->re_state_regoffs
11724 = (regexp_paren_pair*)
11725 any_dup(old_state->re_state_regoffs, proto_perl);
11726 new_state->re_state_reglastparen
11727 = (U32*) any_dup(old_state->re_state_reglastparen,
11729 new_state->re_state_reglastcloseparen
11730 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11732 /* XXX This just has to be broken. The old save_re_context
11733 code did SAVEGENERICPV(PL_reg_start_tmp);
11734 PL_reg_start_tmp is char **.
11735 Look above to what the dup code does for
11736 SAVEt_GENERIC_PVREF
11737 It can never have worked.
11738 So this is merely a faithful copy of the exiting bug: */
11739 new_state->re_state_reg_start_tmp
11740 = (char **) pv_dup((char *)
11741 old_state->re_state_reg_start_tmp);
11742 /* I assume that it only ever "worked" because no-one called
11743 (pseudo)fork while the regexp engine had re-entered itself.
11745 #ifdef PERL_OLD_COPY_ON_WRITE
11746 new_state->re_state_nrs
11747 = sv_dup(old_state->re_state_nrs, param);
11749 new_state->re_state_reg_magic
11750 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11752 new_state->re_state_reg_oldcurpm
11753 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11755 new_state->re_state_reg_curpm
11756 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11758 new_state->re_state_reg_oldsaved
11759 = pv_dup(old_state->re_state_reg_oldsaved);
11760 new_state->re_state_reg_poscache
11761 = pv_dup(old_state->re_state_reg_poscache);
11762 new_state->re_state_reg_starttry
11763 = pv_dup(old_state->re_state_reg_starttry);
11766 case SAVEt_COMPILE_WARNINGS:
11767 ptr = POPPTR(ss,ix);
11768 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11771 ptr = POPPTR(ss,ix);
11772 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11776 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11784 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11785 * flag to the result. This is done for each stash before cloning starts,
11786 * so we know which stashes want their objects cloned */
11789 do_mark_cloneable_stash(pTHX_ SV *const sv)
11791 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
11793 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
11794 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11795 if (cloner && GvCV(cloner)) {
11802 mXPUSHs(newSVhek(hvname));
11804 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
11811 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11819 =for apidoc perl_clone
11821 Create and return a new interpreter by cloning the current one.
11823 perl_clone takes these flags as parameters:
11825 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11826 without it we only clone the data and zero the stacks,
11827 with it we copy the stacks and the new perl interpreter is
11828 ready to run at the exact same point as the previous one.
11829 The pseudo-fork code uses COPY_STACKS while the
11830 threads->create doesn't.
11832 CLONEf_KEEP_PTR_TABLE
11833 perl_clone keeps a ptr_table with the pointer of the old
11834 variable as a key and the new variable as a value,
11835 this allows it to check if something has been cloned and not
11836 clone it again but rather just use the value and increase the
11837 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11838 the ptr_table using the function
11839 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11840 reason to keep it around is if you want to dup some of your own
11841 variable who are outside the graph perl scans, example of this
11842 code is in threads.xs create
11845 This is a win32 thing, it is ignored on unix, it tells perls
11846 win32host code (which is c++) to clone itself, this is needed on
11847 win32 if you want to run two threads at the same time,
11848 if you just want to do some stuff in a separate perl interpreter
11849 and then throw it away and return to the original one,
11850 you don't need to do anything.
11855 /* XXX the above needs expanding by someone who actually understands it ! */
11856 EXTERN_C PerlInterpreter *
11857 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11860 perl_clone(PerlInterpreter *proto_perl, UV flags)
11863 #ifdef PERL_IMPLICIT_SYS
11865 PERL_ARGS_ASSERT_PERL_CLONE;
11867 /* perlhost.h so we need to call into it
11868 to clone the host, CPerlHost should have a c interface, sky */
11870 if (flags & CLONEf_CLONE_HOST) {
11871 return perl_clone_host(proto_perl,flags);
11873 return perl_clone_using(proto_perl, flags,
11875 proto_perl->IMemShared,
11876 proto_perl->IMemParse,
11878 proto_perl->IStdIO,
11882 proto_perl->IProc);
11886 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11887 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11888 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11889 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11890 struct IPerlDir* ipD, struct IPerlSock* ipS,
11891 struct IPerlProc* ipP)
11893 /* XXX many of the string copies here can be optimized if they're
11894 * constants; they need to be allocated as common memory and just
11895 * their pointers copied. */
11898 CLONE_PARAMS clone_params;
11899 CLONE_PARAMS* const param = &clone_params;
11901 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11903 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11904 #else /* !PERL_IMPLICIT_SYS */
11906 CLONE_PARAMS clone_params;
11907 CLONE_PARAMS* param = &clone_params;
11908 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11910 PERL_ARGS_ASSERT_PERL_CLONE;
11911 #endif /* PERL_IMPLICIT_SYS */
11913 /* for each stash, determine whether its objects should be cloned */
11914 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11915 PERL_SET_THX(my_perl);
11918 PoisonNew(my_perl, 1, PerlInterpreter);
11923 PL_scopestack_name = 0;
11925 PL_savestack_ix = 0;
11926 PL_savestack_max = -1;
11927 PL_sig_pending = 0;
11929 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11930 # ifdef DEBUG_LEAKING_SCALARS
11931 PL_sv_serial = (((U32)my_perl >> 2) & 0xfff) * 1000000;
11933 #else /* !DEBUGGING */
11934 Zero(my_perl, 1, PerlInterpreter);
11935 #endif /* DEBUGGING */
11937 #ifdef PERL_IMPLICIT_SYS
11938 /* host pointers */
11940 PL_MemShared = ipMS;
11941 PL_MemParse = ipMP;
11948 #endif /* PERL_IMPLICIT_SYS */
11950 param->flags = flags;
11951 param->proto_perl = proto_perl;
11953 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11955 PL_body_arenas = NULL;
11956 Zero(&PL_body_roots, 1, PL_body_roots);
11958 PL_nice_chunk = NULL;
11959 PL_nice_chunk_size = 0;
11961 PL_sv_objcount = 0;
11963 PL_sv_arenaroot = NULL;
11965 PL_debug = proto_perl->Idebug;
11967 PL_hash_seed = proto_perl->Ihash_seed;
11968 PL_rehash_seed = proto_perl->Irehash_seed;
11970 #ifdef USE_REENTRANT_API
11971 /* XXX: things like -Dm will segfault here in perlio, but doing
11972 * PERL_SET_CONTEXT(proto_perl);
11973 * breaks too many other things
11975 Perl_reentrant_init(aTHX);
11978 /* create SV map for pointer relocation */
11979 PL_ptr_table = ptr_table_new();
11981 /* initialize these special pointers as early as possible */
11982 SvANY(&PL_sv_undef) = NULL;
11983 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11984 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11985 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11987 SvANY(&PL_sv_no) = new_XPVNV();
11988 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11989 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11990 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11991 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11992 SvCUR_set(&PL_sv_no, 0);
11993 SvLEN_set(&PL_sv_no, 1);
11994 SvIV_set(&PL_sv_no, 0);
11995 SvNV_set(&PL_sv_no, 0);
11996 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11998 SvANY(&PL_sv_yes) = new_XPVNV();
11999 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12000 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12001 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12002 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
12003 SvCUR_set(&PL_sv_yes, 1);
12004 SvLEN_set(&PL_sv_yes, 2);
12005 SvIV_set(&PL_sv_yes, 1);
12006 SvNV_set(&PL_sv_yes, 1);
12007 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
12009 /* dbargs array probably holds garbage; give the child a clean array */
12010 PL_dbargs = newAV();
12011 ptr_table_store(PL_ptr_table, proto_perl->Idbargs, PL_dbargs);
12013 /* create (a non-shared!) shared string table */
12014 PL_strtab = newHV();
12015 HvSHAREKEYS_off(PL_strtab);
12016 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
12017 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
12019 PL_compiling = proto_perl->Icompiling;
12021 /* These two PVs will be free'd special way so must set them same way op.c does */
12022 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
12023 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
12025 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
12026 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
12028 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
12029 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
12030 if (PL_compiling.cop_hints_hash) {
12032 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
12033 HINTS_REFCNT_UNLOCK;
12035 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
12036 #ifdef PERL_DEBUG_READONLY_OPS
12041 /* pseudo environmental stuff */
12042 PL_origargc = proto_perl->Iorigargc;
12043 PL_origargv = proto_perl->Iorigargv;
12045 param->stashes = newAV(); /* Setup array of objects to call clone on */
12047 /* Set tainting stuff before PerlIO_debug can possibly get called */
12048 PL_tainting = proto_perl->Itainting;
12049 PL_taint_warn = proto_perl->Itaint_warn;
12051 #ifdef PERLIO_LAYERS
12052 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
12053 PerlIO_clone(aTHX_ proto_perl, param);
12056 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
12057 PL_incgv = gv_dup(proto_perl->Iincgv, param);
12058 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
12059 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
12060 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
12061 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
12064 PL_minus_c = proto_perl->Iminus_c;
12065 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
12066 PL_localpatches = proto_perl->Ilocalpatches;
12067 PL_splitstr = proto_perl->Isplitstr;
12068 PL_minus_n = proto_perl->Iminus_n;
12069 PL_minus_p = proto_perl->Iminus_p;
12070 PL_minus_l = proto_perl->Iminus_l;
12071 PL_minus_a = proto_perl->Iminus_a;
12072 PL_minus_E = proto_perl->Iminus_E;
12073 PL_minus_F = proto_perl->Iminus_F;
12074 PL_doswitches = proto_perl->Idoswitches;
12075 PL_dowarn = proto_perl->Idowarn;
12076 PL_doextract = proto_perl->Idoextract;
12077 PL_sawampersand = proto_perl->Isawampersand;
12078 PL_unsafe = proto_perl->Iunsafe;
12079 PL_inplace = SAVEPV(proto_perl->Iinplace);
12080 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
12081 PL_perldb = proto_perl->Iperldb;
12082 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12083 PL_exit_flags = proto_perl->Iexit_flags;
12085 /* magical thingies */
12086 /* XXX time(&PL_basetime) when asked for? */
12087 PL_basetime = proto_perl->Ibasetime;
12088 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
12090 PL_maxsysfd = proto_perl->Imaxsysfd;
12091 PL_statusvalue = proto_perl->Istatusvalue;
12093 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12095 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12097 PL_encoding = sv_dup(proto_perl->Iencoding, param);
12099 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
12100 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
12101 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
12104 /* RE engine related */
12105 Zero(&PL_reg_state, 1, struct re_save_state);
12106 PL_reginterp_cnt = 0;
12107 PL_regmatch_slab = NULL;
12109 /* Clone the regex array */
12110 /* ORANGE FIXME for plugins, probably in the SV dup code.
12111 newSViv(PTR2IV(CALLREGDUPE(
12112 INT2PTR(REGEXP *, SvIVX(regex)), param))))
12114 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
12115 PL_regex_pad = AvARRAY(PL_regex_padav);
12117 /* shortcuts to various I/O objects */
12118 PL_ofsgv = gv_dup(proto_perl->Iofsgv, param);
12119 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
12120 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
12121 PL_defgv = gv_dup(proto_perl->Idefgv, param);
12122 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
12123 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
12124 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
12126 /* shortcuts to regexp stuff */
12127 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
12129 /* shortcuts to misc objects */
12130 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
12132 /* shortcuts to debugging objects */
12133 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
12134 PL_DBline = gv_dup(proto_perl->IDBline, param);
12135 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
12136 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
12137 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
12138 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
12140 /* symbol tables */
12141 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
12142 PL_curstash = hv_dup(proto_perl->Icurstash, param);
12143 PL_debstash = hv_dup(proto_perl->Idebstash, param);
12144 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
12145 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
12147 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
12148 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
12149 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
12150 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
12151 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
12152 PL_endav = av_dup_inc(proto_perl->Iendav, param);
12153 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
12154 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
12156 PL_sub_generation = proto_perl->Isub_generation;
12157 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
12159 /* funky return mechanisms */
12160 PL_forkprocess = proto_perl->Iforkprocess;
12162 /* subprocess state */
12163 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
12165 /* internal state */
12166 PL_maxo = proto_perl->Imaxo;
12167 if (proto_perl->Iop_mask)
12168 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
12171 /* PL_asserting = proto_perl->Iasserting; */
12173 /* current interpreter roots */
12174 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
12176 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
12178 PL_main_start = proto_perl->Imain_start;
12179 PL_eval_root = proto_perl->Ieval_root;
12180 PL_eval_start = proto_perl->Ieval_start;
12182 /* runtime control stuff */
12183 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
12185 PL_filemode = proto_perl->Ifilemode;
12186 PL_lastfd = proto_perl->Ilastfd;
12187 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
12190 PL_gensym = proto_perl->Igensym;
12191 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
12192 PL_laststatval = proto_perl->Ilaststatval;
12193 PL_laststype = proto_perl->Ilaststype;
12196 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
12198 /* interpreter atexit processing */
12199 PL_exitlistlen = proto_perl->Iexitlistlen;
12200 if (PL_exitlistlen) {
12201 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12202 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12205 PL_exitlist = (PerlExitListEntry*)NULL;
12207 PL_my_cxt_size = proto_perl->Imy_cxt_size;
12208 if (PL_my_cxt_size) {
12209 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
12210 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
12211 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12212 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
12213 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
12217 PL_my_cxt_list = (void**)NULL;
12218 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12219 PL_my_cxt_keys = (const char**)NULL;
12222 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
12223 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
12224 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12226 PL_profiledata = NULL;
12228 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12230 PAD_CLONE_VARS(proto_perl, param);
12232 #ifdef HAVE_INTERP_INTERN
12233 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12236 /* more statics moved here */
12237 PL_generation = proto_perl->Igeneration;
12238 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12240 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12241 PL_in_clean_all = proto_perl->Iin_clean_all;
12243 PL_uid = proto_perl->Iuid;
12244 PL_euid = proto_perl->Ieuid;
12245 PL_gid = proto_perl->Igid;
12246 PL_egid = proto_perl->Iegid;
12247 PL_nomemok = proto_perl->Inomemok;
12248 PL_an = proto_perl->Ian;
12249 PL_evalseq = proto_perl->Ievalseq;
12250 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12251 PL_origalen = proto_perl->Iorigalen;
12252 #ifdef PERL_USES_PL_PIDSTATUS
12253 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12255 PL_osname = SAVEPV(proto_perl->Iosname);
12256 PL_sighandlerp = proto_perl->Isighandlerp;
12258 PL_runops = proto_perl->Irunops;
12260 PL_parser = parser_dup(proto_perl->Iparser, param);
12262 /* XXX this only works if the saved cop has already been cloned */
12263 if (proto_perl->Iparser) {
12264 PL_parser->saved_curcop = (COP*)any_dup(
12265 proto_perl->Iparser->saved_curcop,
12269 PL_subline = proto_perl->Isubline;
12270 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12273 PL_cryptseen = proto_perl->Icryptseen;
12276 PL_hints = proto_perl->Ihints;
12278 PL_amagic_generation = proto_perl->Iamagic_generation;
12280 #ifdef USE_LOCALE_COLLATE
12281 PL_collation_ix = proto_perl->Icollation_ix;
12282 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12283 PL_collation_standard = proto_perl->Icollation_standard;
12284 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12285 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12286 #endif /* USE_LOCALE_COLLATE */
12288 #ifdef USE_LOCALE_NUMERIC
12289 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12290 PL_numeric_standard = proto_perl->Inumeric_standard;
12291 PL_numeric_local = proto_perl->Inumeric_local;
12292 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12293 #endif /* !USE_LOCALE_NUMERIC */
12295 /* utf8 character classes */
12296 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12297 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12298 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12299 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12300 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12301 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12302 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12303 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12304 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12305 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12306 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12307 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12308 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12309 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
12310 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
12311 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
12312 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
12313 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
12314 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
12315 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
12316 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
12317 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
12318 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
12319 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12320 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12321 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12322 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12323 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12324 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12326 /* Did the locale setup indicate UTF-8? */
12327 PL_utf8locale = proto_perl->Iutf8locale;
12328 /* Unicode features (see perlrun/-C) */
12329 PL_unicode = proto_perl->Iunicode;
12331 /* Pre-5.8 signals control */
12332 PL_signals = proto_perl->Isignals;
12334 /* times() ticks per second */
12335 PL_clocktick = proto_perl->Iclocktick;
12337 /* Recursion stopper for PerlIO_find_layer */
12338 PL_in_load_module = proto_perl->Iin_load_module;
12340 /* sort() routine */
12341 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12343 /* Not really needed/useful since the reenrant_retint is "volatile",
12344 * but do it for consistency's sake. */
12345 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12347 /* Hooks to shared SVs and locks. */
12348 PL_sharehook = proto_perl->Isharehook;
12349 PL_lockhook = proto_perl->Ilockhook;
12350 PL_unlockhook = proto_perl->Iunlockhook;
12351 PL_threadhook = proto_perl->Ithreadhook;
12352 PL_destroyhook = proto_perl->Idestroyhook;
12354 #ifdef THREADS_HAVE_PIDS
12355 PL_ppid = proto_perl->Ippid;
12359 PL_last_swash_hv = NULL; /* reinits on demand */
12360 PL_last_swash_klen = 0;
12361 PL_last_swash_key[0]= '\0';
12362 PL_last_swash_tmps = (U8*)NULL;
12363 PL_last_swash_slen = 0;
12365 PL_glob_index = proto_perl->Iglob_index;
12366 PL_srand_called = proto_perl->Isrand_called;
12368 if (proto_perl->Ipsig_pend) {
12369 Newxz(PL_psig_pend, SIG_SIZE, int);
12372 PL_psig_pend = (int*)NULL;
12375 if (proto_perl->Ipsig_name) {
12376 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
12377 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
12379 PL_psig_ptr = PL_psig_name + SIG_SIZE;
12382 PL_psig_ptr = (SV**)NULL;
12383 PL_psig_name = (SV**)NULL;
12386 /* intrpvar.h stuff */
12388 if (flags & CLONEf_COPY_STACKS) {
12389 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12390 PL_tmps_ix = proto_perl->Itmps_ix;
12391 PL_tmps_max = proto_perl->Itmps_max;
12392 PL_tmps_floor = proto_perl->Itmps_floor;
12393 Newx(PL_tmps_stack, PL_tmps_max, SV*);
12394 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
12395 PL_tmps_ix+1, param);
12397 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12398 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
12399 Newxz(PL_markstack, i, I32);
12400 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
12401 - proto_perl->Imarkstack);
12402 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
12403 - proto_perl->Imarkstack);
12404 Copy(proto_perl->Imarkstack, PL_markstack,
12405 PL_markstack_ptr - PL_markstack + 1, I32);
12407 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12408 * NOTE: unlike the others! */
12409 PL_scopestack_ix = proto_perl->Iscopestack_ix;
12410 PL_scopestack_max = proto_perl->Iscopestack_max;
12411 Newxz(PL_scopestack, PL_scopestack_max, I32);
12412 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
12415 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
12416 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
12418 /* NOTE: si_dup() looks at PL_markstack */
12419 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
12421 /* PL_curstack = PL_curstackinfo->si_stack; */
12422 PL_curstack = av_dup(proto_perl->Icurstack, param);
12423 PL_mainstack = av_dup(proto_perl->Imainstack, param);
12425 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12426 PL_stack_base = AvARRAY(PL_curstack);
12427 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
12428 - proto_perl->Istack_base);
12429 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12431 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12432 * NOTE: unlike the others! */
12433 PL_savestack_ix = proto_perl->Isavestack_ix;
12434 PL_savestack_max = proto_perl->Isavestack_max;
12435 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
12436 PL_savestack = ss_dup(proto_perl, param);
12440 ENTER; /* perl_destruct() wants to LEAVE; */
12442 /* although we're not duplicating the tmps stack, we should still
12443 * add entries for any SVs on the tmps stack that got cloned by a
12444 * non-refcount means (eg a temp in @_); otherwise they will be
12447 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
12448 SV * const nsv = MUTABLE_SV(ptr_table_fetch(PL_ptr_table,
12449 proto_perl->Itmps_stack[i]));
12450 if (nsv && !SvREFCNT(nsv)) {
12451 PUSH_EXTEND_MORTAL__SV_C(SvREFCNT_inc_simple(nsv));
12456 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
12457 PL_top_env = &PL_start_env;
12459 PL_op = proto_perl->Iop;
12462 PL_Xpv = (XPV*)NULL;
12463 my_perl->Ina = proto_perl->Ina;
12465 PL_statbuf = proto_perl->Istatbuf;
12466 PL_statcache = proto_perl->Istatcache;
12467 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12468 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12470 PL_timesbuf = proto_perl->Itimesbuf;
12473 PL_tainted = proto_perl->Itainted;
12474 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12475 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12476 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12477 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12478 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12479 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12480 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12481 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12483 PL_restartop = proto_perl->Irestartop;
12484 PL_in_eval = proto_perl->Iin_eval;
12485 PL_delaymagic = proto_perl->Idelaymagic;
12486 PL_dirty = proto_perl->Idirty;
12487 PL_localizing = proto_perl->Ilocalizing;
12489 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12490 PL_hv_fetch_ent_mh = NULL;
12491 PL_modcount = proto_perl->Imodcount;
12492 PL_lastgotoprobe = NULL;
12493 PL_dumpindent = proto_perl->Idumpindent;
12495 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12496 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12497 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12498 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12499 PL_efloatbuf = NULL; /* reinits on demand */
12500 PL_efloatsize = 0; /* reinits on demand */
12504 PL_screamfirst = NULL;
12505 PL_screamnext = NULL;
12506 PL_maxscream = -1; /* reinits on demand */
12507 PL_lastscream = NULL;
12510 PL_regdummy = proto_perl->Iregdummy;
12511 PL_colorset = 0; /* reinits PL_colors[] */
12512 /*PL_colors[6] = {0,0,0,0,0,0};*/
12516 /* Pluggable optimizer */
12517 PL_peepp = proto_perl->Ipeepp;
12518 /* op_free() hook */
12519 PL_opfreehook = proto_perl->Iopfreehook;
12521 PL_stashcache = newHV();
12523 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12524 proto_perl->Iwatchaddr);
12525 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12526 if (PL_debug && PL_watchaddr) {
12527 PerlIO_printf(Perl_debug_log,
12528 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12529 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12530 PTR2UV(PL_watchok));
12533 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
12535 /* Call the ->CLONE method, if it exists, for each of the stashes
12536 identified by sv_dup() above.
12538 while(av_len(param->stashes) != -1) {
12539 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
12540 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12541 if (cloner && GvCV(cloner)) {
12546 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12548 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
12554 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12555 ptr_table_free(PL_ptr_table);
12556 PL_ptr_table = NULL;
12560 SvREFCNT_dec(param->stashes);
12562 /* orphaned? eg threads->new inside BEGIN or use */
12563 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12564 SvREFCNT_inc_simple_void(PL_compcv);
12565 SAVEFREESV(PL_compcv);
12571 #endif /* USE_ITHREADS */
12574 =head1 Unicode Support
12576 =for apidoc sv_recode_to_utf8
12578 The encoding is assumed to be an Encode object, on entry the PV
12579 of the sv is assumed to be octets in that encoding, and the sv
12580 will be converted into Unicode (and UTF-8).
12582 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12583 is not a reference, nothing is done to the sv. If the encoding is not
12584 an C<Encode::XS> Encoding object, bad things will happen.
12585 (See F<lib/encoding.pm> and L<Encode>).
12587 The PV of the sv is returned.
12592 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12596 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12598 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12612 Passing sv_yes is wrong - it needs to be or'ed set of constants
12613 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12614 remove converted chars from source.
12616 Both will default the value - let them.
12618 XPUSHs(&PL_sv_yes);
12621 call_method("decode", G_SCALAR);
12625 s = SvPV_const(uni, len);
12626 if (s != SvPVX_const(sv)) {
12627 SvGROW(sv, len + 1);
12628 Move(s, SvPVX(sv), len + 1, char);
12629 SvCUR_set(sv, len);
12636 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12640 =for apidoc sv_cat_decode
12642 The encoding is assumed to be an Encode object, the PV of the ssv is
12643 assumed to be octets in that encoding and decoding the input starts
12644 from the position which (PV + *offset) pointed to. The dsv will be
12645 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12646 when the string tstr appears in decoding output or the input ends on
12647 the PV of the ssv. The value which the offset points will be modified
12648 to the last input position on the ssv.
12650 Returns TRUE if the terminator was found, else returns FALSE.
12655 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12656 SV *ssv, int *offset, char *tstr, int tlen)
12661 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12663 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12674 offsv = newSViv(*offset);
12676 mXPUSHp(tstr, tlen);
12678 call_method("cat_decode", G_SCALAR);
12680 ret = SvTRUE(TOPs);
12681 *offset = SvIV(offsv);
12687 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12692 /* ---------------------------------------------------------------------
12694 * support functions for report_uninit()
12697 /* the maxiumum size of array or hash where we will scan looking
12698 * for the undefined element that triggered the warning */
12700 #define FUV_MAX_SEARCH_SIZE 1000
12702 /* Look for an entry in the hash whose value has the same SV as val;
12703 * If so, return a mortal copy of the key. */
12706 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
12709 register HE **array;
12712 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12714 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12715 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12718 array = HvARRAY(hv);
12720 for (i=HvMAX(hv); i>0; i--) {
12721 register HE *entry;
12722 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12723 if (HeVAL(entry) != val)
12725 if ( HeVAL(entry) == &PL_sv_undef ||
12726 HeVAL(entry) == &PL_sv_placeholder)
12730 if (HeKLEN(entry) == HEf_SVKEY)
12731 return sv_mortalcopy(HeKEY_sv(entry));
12732 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12738 /* Look for an entry in the array whose value has the same SV as val;
12739 * If so, return the index, otherwise return -1. */
12742 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
12746 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12748 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12749 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12752 if (val != &PL_sv_undef) {
12753 SV ** const svp = AvARRAY(av);
12756 for (i=AvFILLp(av); i>=0; i--)
12763 /* S_varname(): return the name of a variable, optionally with a subscript.
12764 * If gv is non-zero, use the name of that global, along with gvtype (one
12765 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12766 * targ. Depending on the value of the subscript_type flag, return:
12769 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12770 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12771 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12772 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12775 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
12776 const SV *const keyname, I32 aindex, int subscript_type)
12779 SV * const name = sv_newmortal();
12782 buffer[0] = gvtype;
12785 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12787 gv_fullname4(name, gv, buffer, 0);
12789 if ((unsigned int)SvPVX(name)[1] <= 26) {
12791 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12793 /* Swap the 1 unprintable control character for the 2 byte pretty
12794 version - ie substr($name, 1, 1) = $buffer; */
12795 sv_insert(name, 1, 1, buffer, 2);
12799 CV * const cv = find_runcv(NULL);
12803 if (!cv || !CvPADLIST(cv))
12805 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
12806 sv = *av_fetch(av, targ, FALSE);
12807 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12810 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12811 SV * const sv = newSV(0);
12812 *SvPVX(name) = '$';
12813 Perl_sv_catpvf(aTHX_ name, "{%s}",
12814 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12817 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12818 *SvPVX(name) = '$';
12819 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12821 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12822 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12823 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12831 =for apidoc find_uninit_var
12833 Find the name of the undefined variable (if any) that caused the operator o
12834 to issue a "Use of uninitialized value" warning.
12835 If match is true, only return a name if it's value matches uninit_sv.
12836 So roughly speaking, if a unary operator (such as OP_COS) generates a
12837 warning, then following the direct child of the op may yield an
12838 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12839 other hand, with OP_ADD there are two branches to follow, so we only print
12840 the variable name if we get an exact match.
12842 The name is returned as a mortal SV.
12844 Assumes that PL_op is the op that originally triggered the error, and that
12845 PL_comppad/PL_curpad points to the currently executing pad.
12851 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
12857 const OP *o, *o2, *kid;
12859 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12860 uninit_sv == &PL_sv_placeholder)))
12863 switch (obase->op_type) {
12870 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12871 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12874 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12876 if (pad) { /* @lex, %lex */
12877 sv = PAD_SVl(obase->op_targ);
12881 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12882 /* @global, %global */
12883 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12886 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
12888 else /* @{expr}, %{expr} */
12889 return find_uninit_var(cUNOPx(obase)->op_first,
12893 /* attempt to find a match within the aggregate */
12895 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12897 subscript_type = FUV_SUBSCRIPT_HASH;
12900 index = find_array_subscript((const AV *)sv, uninit_sv);
12902 subscript_type = FUV_SUBSCRIPT_ARRAY;
12905 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12908 return varname(gv, hash ? '%' : '@', obase->op_targ,
12909 keysv, index, subscript_type);
12913 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12915 return varname(NULL, '$', obase->op_targ,
12916 NULL, 0, FUV_SUBSCRIPT_NONE);
12919 gv = cGVOPx_gv(obase);
12920 if (!gv || (match && GvSV(gv) != uninit_sv))
12922 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12925 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12928 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
12929 if (!av || SvRMAGICAL(av))
12931 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12932 if (!svp || *svp != uninit_sv)
12935 return varname(NULL, '$', obase->op_targ,
12936 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12939 gv = cGVOPx_gv(obase);
12944 AV *const av = GvAV(gv);
12945 if (!av || SvRMAGICAL(av))
12947 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12948 if (!svp || *svp != uninit_sv)
12951 return varname(gv, '$', 0,
12952 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12957 o = cUNOPx(obase)->op_first;
12958 if (!o || o->op_type != OP_NULL ||
12959 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12961 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12965 if (PL_op == obase)
12966 /* $a[uninit_expr] or $h{uninit_expr} */
12967 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12970 o = cBINOPx(obase)->op_first;
12971 kid = cBINOPx(obase)->op_last;
12973 /* get the av or hv, and optionally the gv */
12975 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12976 sv = PAD_SV(o->op_targ);
12978 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12979 && cUNOPo->op_first->op_type == OP_GV)
12981 gv = cGVOPx_gv(cUNOPo->op_first);
12985 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
12990 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12991 /* index is constant */
12995 if (obase->op_type == OP_HELEM) {
12996 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
12997 if (!he || HeVAL(he) != uninit_sv)
13001 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
13002 if (!svp || *svp != uninit_sv)
13006 if (obase->op_type == OP_HELEM)
13007 return varname(gv, '%', o->op_targ,
13008 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
13010 return varname(gv, '@', o->op_targ, NULL,
13011 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
13014 /* index is an expression;
13015 * attempt to find a match within the aggregate */
13016 if (obase->op_type == OP_HELEM) {
13017 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13019 return varname(gv, '%', o->op_targ,
13020 keysv, 0, FUV_SUBSCRIPT_HASH);
13024 = find_array_subscript((const AV *)sv, uninit_sv);
13026 return varname(gv, '@', o->op_targ,
13027 NULL, index, FUV_SUBSCRIPT_ARRAY);
13032 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
13034 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
13039 /* only examine RHS */
13040 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
13043 o = cUNOPx(obase)->op_first;
13044 if (o->op_type == OP_PUSHMARK)
13047 if (!o->op_sibling) {
13048 /* one-arg version of open is highly magical */
13050 if (o->op_type == OP_GV) { /* open FOO; */
13052 if (match && GvSV(gv) != uninit_sv)
13054 return varname(gv, '$', 0,
13055 NULL, 0, FUV_SUBSCRIPT_NONE);
13057 /* other possibilities not handled are:
13058 * open $x; or open my $x; should return '${*$x}'
13059 * open expr; should return '$'.expr ideally
13065 /* ops where $_ may be an implicit arg */
13069 if ( !(obase->op_flags & OPf_STACKED)) {
13070 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
13071 ? PAD_SVl(obase->op_targ)
13074 sv = sv_newmortal();
13075 sv_setpvs(sv, "$_");
13084 match = 1; /* print etc can return undef on defined args */
13085 /* skip filehandle as it can't produce 'undef' warning */
13086 o = cUNOPx(obase)->op_first;
13087 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
13088 o = o->op_sibling->op_sibling;
13092 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
13094 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
13096 /* the following ops are capable of returning PL_sv_undef even for
13097 * defined arg(s) */
13116 case OP_GETPEERNAME:
13164 case OP_SMARTMATCH:
13173 /* XXX tmp hack: these two may call an XS sub, and currently
13174 XS subs don't have a SUB entry on the context stack, so CV and
13175 pad determination goes wrong, and BAD things happen. So, just
13176 don't try to determine the value under those circumstances.
13177 Need a better fix at dome point. DAPM 11/2007 */
13183 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
13184 if (gv && GvSV(gv) == uninit_sv)
13185 return newSVpvs_flags("$.", SVs_TEMP);
13190 /* def-ness of rval pos() is independent of the def-ness of its arg */
13191 if ( !(obase->op_flags & OPf_MOD))
13196 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
13197 return newSVpvs_flags("${$/}", SVs_TEMP);
13202 if (!(obase->op_flags & OPf_KIDS))
13204 o = cUNOPx(obase)->op_first;
13210 /* if all except one arg are constant, or have no side-effects,
13211 * or are optimized away, then it's unambiguous */
13213 for (kid=o; kid; kid = kid->op_sibling) {
13215 const OPCODE type = kid->op_type;
13216 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
13217 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
13218 || (type == OP_PUSHMARK)
13222 if (o2) { /* more than one found */
13229 return find_uninit_var(o2, uninit_sv, match);
13231 /* scan all args */
13233 sv = find_uninit_var(o, uninit_sv, 1);
13245 =for apidoc report_uninit
13247 Print appropriate "Use of uninitialized variable" warning
13253 Perl_report_uninit(pTHX_ const SV *uninit_sv)
13257 SV* varname = NULL;
13259 varname = find_uninit_var(PL_op, uninit_sv,0);
13261 sv_insert(varname, 0, 0, " ", 1);
13263 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
13264 varname ? SvPV_nolen_const(varname) : "",
13265 " in ", OP_DESC(PL_op));
13268 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
13274 * c-indentation-style: bsd
13275 * c-basic-offset: 4
13276 * indent-tabs-mode: t
13279 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob