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 U32 misc; /* type, and in future other things. */
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 U32 misc)
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;
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 /* XXX Is this still needed? Was it ever needed? Surely as there is
1377 no route from NV to PVIV, NOK can never be true */
1378 assert(!SvNOKp(sv));
1390 assert(new_type_details->body_size);
1391 /* We always allocated the full length item with PURIFY. To do this
1392 we fake things so that arena is false for all 16 types.. */
1393 if(new_type_details->arena) {
1394 /* This points to the start of the allocated area. */
1395 new_body_inline(new_body, new_type);
1396 Zero(new_body, new_type_details->body_size, char);
1397 new_body = ((char *)new_body) - new_type_details->offset;
1399 new_body = new_NOARENAZ(new_type_details);
1401 SvANY(sv) = new_body;
1403 if (old_type_details->copy) {
1404 /* There is now the potential for an upgrade from something without
1405 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1406 int offset = old_type_details->offset;
1407 int length = old_type_details->copy;
1409 if (new_type_details->offset > old_type_details->offset) {
1410 const int difference
1411 = new_type_details->offset - old_type_details->offset;
1412 offset += difference;
1413 length -= difference;
1415 assert (length >= 0);
1417 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1421 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1422 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1423 * correct 0.0 for us. Otherwise, if the old body didn't have an
1424 * NV slot, but the new one does, then we need to initialise the
1425 * freshly created NV slot with whatever the correct bit pattern is
1427 if (old_type_details->zero_nv && !new_type_details->zero_nv
1428 && !isGV_with_GP(sv))
1432 if (new_type == SVt_PVIO) {
1433 IO * const io = MUTABLE_IO(sv);
1434 GV *iogv = gv_fetchpvs("FileHandle::", 0, SVt_PVHV);
1437 /* Clear the stashcache because a new IO could overrule a package
1439 hv_clear(PL_stashcache);
1441 /* unless exists($main::{FileHandle}) and
1442 defined(%main::FileHandle::) */
1443 if (!(iogv && GvHV(iogv) && HvARRAY(GvHV(iogv))))
1444 iogv = gv_fetchpvs("IO::Handle::", GV_ADD, SVt_PVHV);
1445 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1446 IoPAGE_LEN(sv) = 60;
1448 if (old_type < SVt_PV) {
1449 /* referant will be NULL unless the old type was SVt_IV emulating
1451 sv->sv_u.svu_rv = referant;
1455 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1456 (unsigned long)new_type);
1459 if (old_type > SVt_IV) { /* SVt_IVs are overloaded for PTEs */
1461 my_safefree(old_body);
1463 /* Note that there is an assumption that all bodies of types that
1464 can be upgraded came from arenas. Only the more complex non-
1465 upgradable types are allowed to be directly malloc()ed. */
1466 assert(old_type_details->arena);
1467 del_body((void*)((char*)old_body + old_type_details->offset),
1468 &PL_body_roots[old_type]);
1474 =for apidoc sv_backoff
1476 Remove any string offset. You should normally use the C<SvOOK_off> macro
1483 Perl_sv_backoff(pTHX_ register SV *const sv)
1486 const char * const s = SvPVX_const(sv);
1488 PERL_ARGS_ASSERT_SV_BACKOFF;
1489 PERL_UNUSED_CONTEXT;
1492 assert(SvTYPE(sv) != SVt_PVHV);
1493 assert(SvTYPE(sv) != SVt_PVAV);
1495 SvOOK_offset(sv, delta);
1497 SvLEN_set(sv, SvLEN(sv) + delta);
1498 SvPV_set(sv, SvPVX(sv) - delta);
1499 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1500 SvFLAGS(sv) &= ~SVf_OOK;
1507 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1508 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1509 Use the C<SvGROW> wrapper instead.
1515 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1519 PERL_ARGS_ASSERT_SV_GROW;
1521 if (PL_madskills && newlen >= 0x100000) {
1522 PerlIO_printf(Perl_debug_log,
1523 "Allocation too large: %"UVxf"\n", (UV)newlen);
1525 #ifdef HAS_64K_LIMIT
1526 if (newlen >= 0x10000) {
1527 PerlIO_printf(Perl_debug_log,
1528 "Allocation too large: %"UVxf"\n", (UV)newlen);
1531 #endif /* HAS_64K_LIMIT */
1534 if (SvTYPE(sv) < SVt_PV) {
1535 sv_upgrade(sv, SVt_PV);
1536 s = SvPVX_mutable(sv);
1538 else if (SvOOK(sv)) { /* pv is offset? */
1540 s = SvPVX_mutable(sv);
1541 if (newlen > SvLEN(sv))
1542 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1543 #ifdef HAS_64K_LIMIT
1544 if (newlen >= 0x10000)
1549 s = SvPVX_mutable(sv);
1551 if (newlen > SvLEN(sv)) { /* need more room? */
1552 #ifndef Perl_safesysmalloc_size
1553 newlen = PERL_STRLEN_ROUNDUP(newlen);
1555 if (SvLEN(sv) && s) {
1556 s = (char*)saferealloc(s, newlen);
1559 s = (char*)safemalloc(newlen);
1560 if (SvPVX_const(sv) && SvCUR(sv)) {
1561 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1565 #ifdef Perl_safesysmalloc_size
1566 /* Do this here, do it once, do it right, and then we will never get
1567 called back into sv_grow() unless there really is some growing
1569 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1571 SvLEN_set(sv, newlen);
1578 =for apidoc sv_setiv
1580 Copies an integer into the given SV, upgrading first if necessary.
1581 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1587 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1591 PERL_ARGS_ASSERT_SV_SETIV;
1593 SV_CHECK_THINKFIRST_COW_DROP(sv);
1594 switch (SvTYPE(sv)) {
1597 sv_upgrade(sv, SVt_IV);
1600 sv_upgrade(sv, SVt_PVIV);
1604 if (!isGV_with_GP(sv))
1611 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1615 (void)SvIOK_only(sv); /* validate number */
1621 =for apidoc sv_setiv_mg
1623 Like C<sv_setiv>, but also handles 'set' magic.
1629 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1631 PERL_ARGS_ASSERT_SV_SETIV_MG;
1638 =for apidoc sv_setuv
1640 Copies an unsigned integer into the given SV, upgrading first if necessary.
1641 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1647 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1649 PERL_ARGS_ASSERT_SV_SETUV;
1651 /* With these two if statements:
1652 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1655 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1657 If you wish to remove them, please benchmark to see what the effect is
1659 if (u <= (UV)IV_MAX) {
1660 sv_setiv(sv, (IV)u);
1669 =for apidoc sv_setuv_mg
1671 Like C<sv_setuv>, but also handles 'set' magic.
1677 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1679 PERL_ARGS_ASSERT_SV_SETUV_MG;
1686 =for apidoc sv_setnv
1688 Copies a double into the given SV, upgrading first if necessary.
1689 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1695 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1699 PERL_ARGS_ASSERT_SV_SETNV;
1701 SV_CHECK_THINKFIRST_COW_DROP(sv);
1702 switch (SvTYPE(sv)) {
1705 sv_upgrade(sv, SVt_NV);
1709 sv_upgrade(sv, SVt_PVNV);
1713 if (!isGV_with_GP(sv))
1720 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1725 (void)SvNOK_only(sv); /* validate number */
1730 =for apidoc sv_setnv_mg
1732 Like C<sv_setnv>, but also handles 'set' magic.
1738 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1740 PERL_ARGS_ASSERT_SV_SETNV_MG;
1746 /* Print an "isn't numeric" warning, using a cleaned-up,
1747 * printable version of the offending string
1751 S_not_a_number(pTHX_ SV *const sv)
1758 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1761 dsv = newSVpvs_flags("", SVs_TEMP);
1762 pv = sv_uni_display(dsv, sv, 10, 0);
1765 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1766 /* each *s can expand to 4 chars + "...\0",
1767 i.e. need room for 8 chars */
1769 const char *s = SvPVX_const(sv);
1770 const char * const end = s + SvCUR(sv);
1771 for ( ; s < end && d < limit; s++ ) {
1773 if (ch & 128 && !isPRINT_LC(ch)) {
1782 else if (ch == '\r') {
1786 else if (ch == '\f') {
1790 else if (ch == '\\') {
1794 else if (ch == '\0') {
1798 else if (isPRINT_LC(ch))
1815 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1816 "Argument \"%s\" isn't numeric in %s", pv,
1819 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1820 "Argument \"%s\" isn't numeric", pv);
1824 =for apidoc looks_like_number
1826 Test if the content of an SV looks like a number (or is a number).
1827 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1828 non-numeric warning), even if your atof() doesn't grok them.
1834 Perl_looks_like_number(pTHX_ SV *const sv)
1836 register const char *sbegin;
1839 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1842 sbegin = SvPVX_const(sv);
1845 else if (SvPOKp(sv))
1846 sbegin = SvPV_const(sv, len);
1848 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1849 return grok_number(sbegin, len, NULL);
1853 S_glob_2number(pTHX_ GV * const gv)
1855 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1856 SV *const buffer = sv_newmortal();
1858 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1860 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1863 gv_efullname3(buffer, gv, "*");
1864 SvFLAGS(gv) |= wasfake;
1866 /* We know that all GVs stringify to something that is not-a-number,
1867 so no need to test that. */
1868 if (ckWARN(WARN_NUMERIC))
1869 not_a_number(buffer);
1870 /* We just want something true to return, so that S_sv_2iuv_common
1871 can tail call us and return true. */
1875 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1876 until proven guilty, assume that things are not that bad... */
1881 As 64 bit platforms often have an NV that doesn't preserve all bits of
1882 an IV (an assumption perl has been based on to date) it becomes necessary
1883 to remove the assumption that the NV always carries enough precision to
1884 recreate the IV whenever needed, and that the NV is the canonical form.
1885 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1886 precision as a side effect of conversion (which would lead to insanity
1887 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1888 1) to distinguish between IV/UV/NV slots that have cached a valid
1889 conversion where precision was lost and IV/UV/NV slots that have a
1890 valid conversion which has lost no precision
1891 2) to ensure that if a numeric conversion to one form is requested that
1892 would lose precision, the precise conversion (or differently
1893 imprecise conversion) is also performed and cached, to prevent
1894 requests for different numeric formats on the same SV causing
1895 lossy conversion chains. (lossless conversion chains are perfectly
1900 SvIOKp is true if the IV slot contains a valid value
1901 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1902 SvNOKp is true if the NV slot contains a valid value
1903 SvNOK is true only if the NV value is accurate
1906 while converting from PV to NV, check to see if converting that NV to an
1907 IV(or UV) would lose accuracy over a direct conversion from PV to
1908 IV(or UV). If it would, cache both conversions, return NV, but mark
1909 SV as IOK NOKp (ie not NOK).
1911 While converting from PV to IV, check to see if converting that IV to an
1912 NV would lose accuracy over a direct conversion from PV to NV. If it
1913 would, cache both conversions, flag similarly.
1915 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1916 correctly because if IV & NV were set NV *always* overruled.
1917 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1918 changes - now IV and NV together means that the two are interchangeable:
1919 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1921 The benefit of this is that operations such as pp_add know that if
1922 SvIOK is true for both left and right operands, then integer addition
1923 can be used instead of floating point (for cases where the result won't
1924 overflow). Before, floating point was always used, which could lead to
1925 loss of precision compared with integer addition.
1927 * making IV and NV equal status should make maths accurate on 64 bit
1929 * may speed up maths somewhat if pp_add and friends start to use
1930 integers when possible instead of fp. (Hopefully the overhead in
1931 looking for SvIOK and checking for overflow will not outweigh the
1932 fp to integer speedup)
1933 * will slow down integer operations (callers of SvIV) on "inaccurate"
1934 values, as the change from SvIOK to SvIOKp will cause a call into
1935 sv_2iv each time rather than a macro access direct to the IV slot
1936 * should speed up number->string conversion on integers as IV is
1937 favoured when IV and NV are equally accurate
1939 ####################################################################
1940 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1941 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1942 On the other hand, SvUOK is true iff UV.
1943 ####################################################################
1945 Your mileage will vary depending your CPU's relative fp to integer
1949 #ifndef NV_PRESERVES_UV
1950 # define IS_NUMBER_UNDERFLOW_IV 1
1951 # define IS_NUMBER_UNDERFLOW_UV 2
1952 # define IS_NUMBER_IV_AND_UV 2
1953 # define IS_NUMBER_OVERFLOW_IV 4
1954 # define IS_NUMBER_OVERFLOW_UV 5
1956 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1958 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1960 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1968 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1970 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));
1971 if (SvNVX(sv) < (NV)IV_MIN) {
1972 (void)SvIOKp_on(sv);
1974 SvIV_set(sv, IV_MIN);
1975 return IS_NUMBER_UNDERFLOW_IV;
1977 if (SvNVX(sv) > (NV)UV_MAX) {
1978 (void)SvIOKp_on(sv);
1981 SvUV_set(sv, UV_MAX);
1982 return IS_NUMBER_OVERFLOW_UV;
1984 (void)SvIOKp_on(sv);
1986 /* Can't use strtol etc to convert this string. (See truth table in
1988 if (SvNVX(sv) <= (UV)IV_MAX) {
1989 SvIV_set(sv, I_V(SvNVX(sv)));
1990 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1991 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1993 /* Integer is imprecise. NOK, IOKp */
1995 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1998 SvUV_set(sv, U_V(SvNVX(sv)));
1999 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2000 if (SvUVX(sv) == UV_MAX) {
2001 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2002 possibly be preserved by NV. Hence, it must be overflow.
2004 return IS_NUMBER_OVERFLOW_UV;
2006 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2008 /* Integer is imprecise. NOK, IOKp */
2010 return IS_NUMBER_OVERFLOW_IV;
2012 #endif /* !NV_PRESERVES_UV*/
2015 S_sv_2iuv_common(pTHX_ SV *const sv)
2019 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
2022 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2023 * without also getting a cached IV/UV from it at the same time
2024 * (ie PV->NV conversion should detect loss of accuracy and cache
2025 * IV or UV at same time to avoid this. */
2026 /* IV-over-UV optimisation - choose to cache IV if possible */
2028 if (SvTYPE(sv) == SVt_NV)
2029 sv_upgrade(sv, SVt_PVNV);
2031 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2032 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2033 certainly cast into the IV range at IV_MAX, whereas the correct
2034 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2036 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2037 if (Perl_isnan(SvNVX(sv))) {
2043 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2044 SvIV_set(sv, I_V(SvNVX(sv)));
2045 if (SvNVX(sv) == (NV) SvIVX(sv)
2046 #ifndef NV_PRESERVES_UV
2047 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2048 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2049 /* Don't flag it as "accurately an integer" if the number
2050 came from a (by definition imprecise) NV operation, and
2051 we're outside the range of NV integer precision */
2055 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2057 /* scalar has trailing garbage, eg "42a" */
2059 DEBUG_c(PerlIO_printf(Perl_debug_log,
2060 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2066 /* IV not precise. No need to convert from PV, as NV
2067 conversion would already have cached IV if it detected
2068 that PV->IV would be better than PV->NV->IV
2069 flags already correct - don't set public IOK. */
2070 DEBUG_c(PerlIO_printf(Perl_debug_log,
2071 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2076 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2077 but the cast (NV)IV_MIN rounds to a the value less (more
2078 negative) than IV_MIN which happens to be equal to SvNVX ??
2079 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2080 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2081 (NV)UVX == NVX are both true, but the values differ. :-(
2082 Hopefully for 2s complement IV_MIN is something like
2083 0x8000000000000000 which will be exact. NWC */
2086 SvUV_set(sv, U_V(SvNVX(sv)));
2088 (SvNVX(sv) == (NV) SvUVX(sv))
2089 #ifndef NV_PRESERVES_UV
2090 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2091 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2092 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2093 /* Don't flag it as "accurately an integer" if the number
2094 came from a (by definition imprecise) NV operation, and
2095 we're outside the range of NV integer precision */
2101 DEBUG_c(PerlIO_printf(Perl_debug_log,
2102 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2108 else if (SvPOKp(sv) && SvLEN(sv)) {
2110 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2111 /* We want to avoid a possible problem when we cache an IV/ a UV which
2112 may be later translated to an NV, and the resulting NV is not
2113 the same as the direct translation of the initial string
2114 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2115 be careful to ensure that the value with the .456 is around if the
2116 NV value is requested in the future).
2118 This means that if we cache such an IV/a UV, we need to cache the
2119 NV as well. Moreover, we trade speed for space, and do not
2120 cache the NV if we are sure it's not needed.
2123 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2124 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2125 == IS_NUMBER_IN_UV) {
2126 /* It's definitely an integer, only upgrade to PVIV */
2127 if (SvTYPE(sv) < SVt_PVIV)
2128 sv_upgrade(sv, SVt_PVIV);
2130 } else if (SvTYPE(sv) < SVt_PVNV)
2131 sv_upgrade(sv, SVt_PVNV);
2133 /* If NVs preserve UVs then we only use the UV value if we know that
2134 we aren't going to call atof() below. If NVs don't preserve UVs
2135 then the value returned may have more precision than atof() will
2136 return, even though value isn't perfectly accurate. */
2137 if ((numtype & (IS_NUMBER_IN_UV
2138 #ifdef NV_PRESERVES_UV
2141 )) == IS_NUMBER_IN_UV) {
2142 /* This won't turn off the public IOK flag if it was set above */
2143 (void)SvIOKp_on(sv);
2145 if (!(numtype & IS_NUMBER_NEG)) {
2147 if (value <= (UV)IV_MAX) {
2148 SvIV_set(sv, (IV)value);
2150 /* it didn't overflow, and it was positive. */
2151 SvUV_set(sv, value);
2155 /* 2s complement assumption */
2156 if (value <= (UV)IV_MIN) {
2157 SvIV_set(sv, -(IV)value);
2159 /* Too negative for an IV. This is a double upgrade, but
2160 I'm assuming it will be rare. */
2161 if (SvTYPE(sv) < SVt_PVNV)
2162 sv_upgrade(sv, SVt_PVNV);
2166 SvNV_set(sv, -(NV)value);
2167 SvIV_set(sv, IV_MIN);
2171 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2172 will be in the previous block to set the IV slot, and the next
2173 block to set the NV slot. So no else here. */
2175 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2176 != IS_NUMBER_IN_UV) {
2177 /* It wasn't an (integer that doesn't overflow the UV). */
2178 SvNV_set(sv, Atof(SvPVX_const(sv)));
2180 if (! numtype && ckWARN(WARN_NUMERIC))
2183 #if defined(USE_LONG_DOUBLE)
2184 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2185 PTR2UV(sv), SvNVX(sv)));
2187 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2188 PTR2UV(sv), SvNVX(sv)));
2191 #ifdef NV_PRESERVES_UV
2192 (void)SvIOKp_on(sv);
2194 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2195 SvIV_set(sv, I_V(SvNVX(sv)));
2196 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2199 NOOP; /* Integer is imprecise. NOK, IOKp */
2201 /* UV will not work better than IV */
2203 if (SvNVX(sv) > (NV)UV_MAX) {
2205 /* Integer is inaccurate. NOK, IOKp, is UV */
2206 SvUV_set(sv, UV_MAX);
2208 SvUV_set(sv, U_V(SvNVX(sv)));
2209 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2210 NV preservse UV so can do correct comparison. */
2211 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2214 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2219 #else /* NV_PRESERVES_UV */
2220 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2221 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2222 /* The IV/UV slot will have been set from value returned by
2223 grok_number above. The NV slot has just been set using
2226 assert (SvIOKp(sv));
2228 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2229 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2230 /* Small enough to preserve all bits. */
2231 (void)SvIOKp_on(sv);
2233 SvIV_set(sv, I_V(SvNVX(sv)));
2234 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2236 /* Assumption: first non-preserved integer is < IV_MAX,
2237 this NV is in the preserved range, therefore: */
2238 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2240 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);
2244 0 0 already failed to read UV.
2245 0 1 already failed to read UV.
2246 1 0 you won't get here in this case. IV/UV
2247 slot set, public IOK, Atof() unneeded.
2248 1 1 already read UV.
2249 so there's no point in sv_2iuv_non_preserve() attempting
2250 to use atol, strtol, strtoul etc. */
2252 sv_2iuv_non_preserve (sv, numtype);
2254 sv_2iuv_non_preserve (sv);
2258 #endif /* NV_PRESERVES_UV */
2259 /* It might be more code efficient to go through the entire logic above
2260 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2261 gets complex and potentially buggy, so more programmer efficient
2262 to do it this way, by turning off the public flags: */
2264 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2268 if (isGV_with_GP(sv))
2269 return glob_2number(MUTABLE_GV(sv));
2271 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2272 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2275 if (SvTYPE(sv) < SVt_IV)
2276 /* Typically the caller expects that sv_any is not NULL now. */
2277 sv_upgrade(sv, SVt_IV);
2278 /* Return 0 from the caller. */
2285 =for apidoc sv_2iv_flags
2287 Return the integer value of an SV, doing any necessary string
2288 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2289 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2295 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2300 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2301 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2302 cache IVs just in case. In practice it seems that they never
2303 actually anywhere accessible by user Perl code, let alone get used
2304 in anything other than a string context. */
2305 if (flags & SV_GMAGIC)
2310 return I_V(SvNVX(sv));
2312 if (SvPOKp(sv) && SvLEN(sv)) {
2315 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2317 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2318 == IS_NUMBER_IN_UV) {
2319 /* It's definitely an integer */
2320 if (numtype & IS_NUMBER_NEG) {
2321 if (value < (UV)IV_MIN)
2324 if (value < (UV)IV_MAX)
2329 if (ckWARN(WARN_NUMERIC))
2332 return I_V(Atof(SvPVX_const(sv)));
2337 assert(SvTYPE(sv) >= SVt_PVMG);
2338 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2339 } else if (SvTHINKFIRST(sv)) {
2343 SV * const tmpstr=AMG_CALLun(sv,numer);
2344 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2345 return SvIV(tmpstr);
2348 return PTR2IV(SvRV(sv));
2351 sv_force_normal_flags(sv, 0);
2353 if (SvREADONLY(sv) && !SvOK(sv)) {
2354 if (ckWARN(WARN_UNINITIALIZED))
2360 if (S_sv_2iuv_common(aTHX_ sv))
2363 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2364 PTR2UV(sv),SvIVX(sv)));
2365 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2369 =for apidoc sv_2uv_flags
2371 Return the unsigned integer value of an SV, doing any necessary string
2372 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2373 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2379 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2384 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2385 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2386 cache IVs just in case. */
2387 if (flags & SV_GMAGIC)
2392 return U_V(SvNVX(sv));
2393 if (SvPOKp(sv) && SvLEN(sv)) {
2396 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2398 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2399 == IS_NUMBER_IN_UV) {
2400 /* It's definitely an integer */
2401 if (!(numtype & IS_NUMBER_NEG))
2405 if (ckWARN(WARN_NUMERIC))
2408 return U_V(Atof(SvPVX_const(sv)));
2413 assert(SvTYPE(sv) >= SVt_PVMG);
2414 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2415 } else if (SvTHINKFIRST(sv)) {
2419 SV *const tmpstr = AMG_CALLun(sv,numer);
2420 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2421 return SvUV(tmpstr);
2424 return PTR2UV(SvRV(sv));
2427 sv_force_normal_flags(sv, 0);
2429 if (SvREADONLY(sv) && !SvOK(sv)) {
2430 if (ckWARN(WARN_UNINITIALIZED))
2436 if (S_sv_2iuv_common(aTHX_ sv))
2440 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2441 PTR2UV(sv),SvUVX(sv)));
2442 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2448 Return the num value of an SV, doing any necessary string or integer
2449 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2456 Perl_sv_2nv(pTHX_ register SV *const sv)
2461 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2462 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2463 cache IVs just in case. */
2467 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2468 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2469 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2471 return Atof(SvPVX_const(sv));
2475 return (NV)SvUVX(sv);
2477 return (NV)SvIVX(sv);
2482 assert(SvTYPE(sv) >= SVt_PVMG);
2483 /* This falls through to the report_uninit near the end of the
2485 } else if (SvTHINKFIRST(sv)) {
2489 SV *const tmpstr = AMG_CALLun(sv,numer);
2490 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2491 return SvNV(tmpstr);
2494 return PTR2NV(SvRV(sv));
2497 sv_force_normal_flags(sv, 0);
2499 if (SvREADONLY(sv) && !SvOK(sv)) {
2500 if (ckWARN(WARN_UNINITIALIZED))
2505 if (SvTYPE(sv) < SVt_NV) {
2506 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2507 sv_upgrade(sv, SVt_NV);
2508 #ifdef USE_LONG_DOUBLE
2510 STORE_NUMERIC_LOCAL_SET_STANDARD();
2511 PerlIO_printf(Perl_debug_log,
2512 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2513 PTR2UV(sv), SvNVX(sv));
2514 RESTORE_NUMERIC_LOCAL();
2518 STORE_NUMERIC_LOCAL_SET_STANDARD();
2519 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2520 PTR2UV(sv), SvNVX(sv));
2521 RESTORE_NUMERIC_LOCAL();
2525 else if (SvTYPE(sv) < SVt_PVNV)
2526 sv_upgrade(sv, SVt_PVNV);
2531 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2532 #ifdef NV_PRESERVES_UV
2538 /* Only set the public NV OK flag if this NV preserves the IV */
2539 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2541 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2542 : (SvIVX(sv) == I_V(SvNVX(sv))))
2548 else if (SvPOKp(sv) && SvLEN(sv)) {
2550 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2551 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2553 #ifdef NV_PRESERVES_UV
2554 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2555 == IS_NUMBER_IN_UV) {
2556 /* It's definitely an integer */
2557 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2559 SvNV_set(sv, Atof(SvPVX_const(sv)));
2565 SvNV_set(sv, Atof(SvPVX_const(sv)));
2566 /* Only set the public NV OK flag if this NV preserves the value in
2567 the PV at least as well as an IV/UV would.
2568 Not sure how to do this 100% reliably. */
2569 /* if that shift count is out of range then Configure's test is
2570 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2572 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2573 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2574 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2575 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2576 /* Can't use strtol etc to convert this string, so don't try.
2577 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2580 /* value has been set. It may not be precise. */
2581 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2582 /* 2s complement assumption for (UV)IV_MIN */
2583 SvNOK_on(sv); /* Integer is too negative. */
2588 if (numtype & IS_NUMBER_NEG) {
2589 SvIV_set(sv, -(IV)value);
2590 } else if (value <= (UV)IV_MAX) {
2591 SvIV_set(sv, (IV)value);
2593 SvUV_set(sv, value);
2597 if (numtype & IS_NUMBER_NOT_INT) {
2598 /* I believe that even if the original PV had decimals,
2599 they are lost beyond the limit of the FP precision.
2600 However, neither is canonical, so both only get p
2601 flags. NWC, 2000/11/25 */
2602 /* Both already have p flags, so do nothing */
2604 const NV nv = SvNVX(sv);
2605 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2606 if (SvIVX(sv) == I_V(nv)) {
2609 /* It had no "." so it must be integer. */
2613 /* between IV_MAX and NV(UV_MAX).
2614 Could be slightly > UV_MAX */
2616 if (numtype & IS_NUMBER_NOT_INT) {
2617 /* UV and NV both imprecise. */
2619 const UV nv_as_uv = U_V(nv);
2621 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2630 /* It might be more code efficient to go through the entire logic above
2631 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2632 gets complex and potentially buggy, so more programmer efficient
2633 to do it this way, by turning off the public flags: */
2635 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2636 #endif /* NV_PRESERVES_UV */
2639 if (isGV_with_GP(sv)) {
2640 glob_2number(MUTABLE_GV(sv));
2644 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2646 assert (SvTYPE(sv) >= SVt_NV);
2647 /* Typically the caller expects that sv_any is not NULL now. */
2648 /* XXX Ilya implies that this is a bug in callers that assume this
2649 and ideally should be fixed. */
2652 #if defined(USE_LONG_DOUBLE)
2654 STORE_NUMERIC_LOCAL_SET_STANDARD();
2655 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2656 PTR2UV(sv), SvNVX(sv));
2657 RESTORE_NUMERIC_LOCAL();
2661 STORE_NUMERIC_LOCAL_SET_STANDARD();
2662 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2663 PTR2UV(sv), SvNVX(sv));
2664 RESTORE_NUMERIC_LOCAL();
2673 Return an SV with the numeric value of the source SV, doing any necessary
2674 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2675 access this function.
2681 Perl_sv_2num(pTHX_ register SV *const sv)
2683 PERL_ARGS_ASSERT_SV_2NUM;
2688 SV * const tmpsv = AMG_CALLun(sv,numer);
2689 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2690 return sv_2num(tmpsv);
2692 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2695 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2696 * UV as a string towards the end of buf, and return pointers to start and
2699 * We assume that buf is at least TYPE_CHARS(UV) long.
2703 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2705 char *ptr = buf + TYPE_CHARS(UV);
2706 char * const ebuf = ptr;
2709 PERL_ARGS_ASSERT_UIV_2BUF;
2721 *--ptr = '0' + (char)(uv % 10);
2730 =for apidoc sv_2pv_flags
2732 Returns a pointer to the string value of an SV, and sets *lp to its length.
2733 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2735 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2736 usually end up here too.
2742 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2752 if (SvGMAGICAL(sv)) {
2753 if (flags & SV_GMAGIC)
2758 if (flags & SV_MUTABLE_RETURN)
2759 return SvPVX_mutable(sv);
2760 if (flags & SV_CONST_RETURN)
2761 return (char *)SvPVX_const(sv);
2764 if (SvIOKp(sv) || SvNOKp(sv)) {
2765 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2770 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2771 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2773 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2780 #ifdef FIXNEGATIVEZERO
2781 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2787 SvUPGRADE(sv, SVt_PV);
2790 s = SvGROW_mutable(sv, len + 1);
2793 return (char*)memcpy(s, tbuf, len + 1);
2799 assert(SvTYPE(sv) >= SVt_PVMG);
2800 /* This falls through to the report_uninit near the end of the
2802 } else if (SvTHINKFIRST(sv)) {
2806 SV *const tmpstr = AMG_CALLun(sv,string);
2807 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2809 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2813 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2814 if (flags & SV_CONST_RETURN) {
2815 pv = (char *) SvPVX_const(tmpstr);
2817 pv = (flags & SV_MUTABLE_RETURN)
2818 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2821 *lp = SvCUR(tmpstr);
2823 pv = sv_2pv_flags(tmpstr, lp, flags);
2836 SV *const referent = SvRV(sv);
2840 retval = buffer = savepvn("NULLREF", len);
2841 } else if (SvTYPE(referent) == SVt_REGEXP) {
2842 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2847 /* If the regex is UTF-8 we want the containing scalar to
2848 have an UTF-8 flag too */
2854 if ((seen_evals = RX_SEEN_EVALS(re)))
2855 PL_reginterp_cnt += seen_evals;
2858 *lp = RX_WRAPLEN(re);
2860 return RX_WRAPPED(re);
2862 const char *const typestr = sv_reftype(referent, 0);
2863 const STRLEN typelen = strlen(typestr);
2864 UV addr = PTR2UV(referent);
2865 const char *stashname = NULL;
2866 STRLEN stashnamelen = 0; /* hush, gcc */
2867 const char *buffer_end;
2869 if (SvOBJECT(referent)) {
2870 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2873 stashname = HEK_KEY(name);
2874 stashnamelen = HEK_LEN(name);
2876 if (HEK_UTF8(name)) {
2882 stashname = "__ANON__";
2885 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2886 + 2 * sizeof(UV) + 2 /* )\0 */;
2888 len = typelen + 3 /* (0x */
2889 + 2 * sizeof(UV) + 2 /* )\0 */;
2892 Newx(buffer, len, char);
2893 buffer_end = retval = buffer + len;
2895 /* Working backwards */
2899 *--retval = PL_hexdigit[addr & 15];
2900 } while (addr >>= 4);
2906 memcpy(retval, typestr, typelen);
2910 retval -= stashnamelen;
2911 memcpy(retval, stashname, stashnamelen);
2913 /* retval may not neccesarily have reached the start of the
2915 assert (retval >= buffer);
2917 len = buffer_end - retval - 1; /* -1 for that \0 */
2925 if (SvREADONLY(sv) && !SvOK(sv)) {
2928 if (flags & SV_UNDEF_RETURNS_NULL)
2930 if (ckWARN(WARN_UNINITIALIZED))
2935 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2936 /* I'm assuming that if both IV and NV are equally valid then
2937 converting the IV is going to be more efficient */
2938 const U32 isUIOK = SvIsUV(sv);
2939 char buf[TYPE_CHARS(UV)];
2943 if (SvTYPE(sv) < SVt_PVIV)
2944 sv_upgrade(sv, SVt_PVIV);
2945 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2947 /* inlined from sv_setpvn */
2948 s = SvGROW_mutable(sv, len + 1);
2949 Move(ptr, s, len, char);
2953 else if (SvNOKp(sv)) {
2955 if (SvTYPE(sv) < SVt_PVNV)
2956 sv_upgrade(sv, SVt_PVNV);
2957 /* The +20 is pure guesswork. Configure test needed. --jhi */
2958 s = SvGROW_mutable(sv, NV_DIG + 20);
2959 /* some Xenix systems wipe out errno here */
2961 if (SvNVX(sv) == 0.0)
2962 my_strlcpy(s, "0", SvLEN(sv));
2966 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2969 #ifdef FIXNEGATIVEZERO
2970 if (*s == '-' && s[1] == '0' && !s[2]) {
2982 if (isGV_with_GP(sv)) {
2983 GV *const gv = MUTABLE_GV(sv);
2984 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2985 SV *const buffer = sv_newmortal();
2987 /* FAKE globs can get coerced, so need to turn this off temporarily
2990 gv_efullname3(buffer, gv, "*");
2991 SvFLAGS(gv) |= wasfake;
2993 assert(SvPOK(buffer));
2995 *lp = SvCUR(buffer);
2997 return SvPVX(buffer);
3002 if (flags & SV_UNDEF_RETURNS_NULL)
3004 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3006 if (SvTYPE(sv) < SVt_PV)
3007 /* Typically the caller expects that sv_any is not NULL now. */
3008 sv_upgrade(sv, SVt_PV);
3012 const STRLEN len = s - SvPVX_const(sv);
3018 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3019 PTR2UV(sv),SvPVX_const(sv)));
3020 if (flags & SV_CONST_RETURN)
3021 return (char *)SvPVX_const(sv);
3022 if (flags & SV_MUTABLE_RETURN)
3023 return SvPVX_mutable(sv);
3028 =for apidoc sv_copypv
3030 Copies a stringified representation of the source SV into the
3031 destination SV. Automatically performs any necessary mg_get and
3032 coercion of numeric values into strings. Guaranteed to preserve
3033 UTF8 flag even from overloaded objects. Similar in nature to
3034 sv_2pv[_flags] but operates directly on an SV instead of just the
3035 string. Mostly uses sv_2pv_flags to do its work, except when that
3036 would lose the UTF-8'ness of the PV.
3042 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3045 const char * const s = SvPV_const(ssv,len);
3047 PERL_ARGS_ASSERT_SV_COPYPV;
3049 sv_setpvn(dsv,s,len);
3057 =for apidoc sv_2pvbyte
3059 Return a pointer to the byte-encoded representation of the SV, and set *lp
3060 to its length. May cause the SV to be downgraded from UTF-8 as a
3063 Usually accessed via the C<SvPVbyte> macro.
3069 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3071 PERL_ARGS_ASSERT_SV_2PVBYTE;
3073 sv_utf8_downgrade(sv,0);
3074 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3078 =for apidoc sv_2pvutf8
3080 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3081 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3083 Usually accessed via the C<SvPVutf8> macro.
3089 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3091 PERL_ARGS_ASSERT_SV_2PVUTF8;
3093 sv_utf8_upgrade(sv);
3094 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3099 =for apidoc sv_2bool
3101 This function is only called on magical items, and is only used by
3102 sv_true() or its macro equivalent.
3108 Perl_sv_2bool(pTHX_ register SV *const sv)
3112 PERL_ARGS_ASSERT_SV_2BOOL;
3120 SV * const tmpsv = AMG_CALLun(sv,bool_);
3121 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3122 return (bool)SvTRUE(tmpsv);
3124 return SvRV(sv) != 0;
3127 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3129 (*sv->sv_u.svu_pv > '0' ||
3130 Xpvtmp->xpv_cur > 1 ||
3131 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3138 return SvIVX(sv) != 0;
3141 return SvNVX(sv) != 0.0;
3143 if (isGV_with_GP(sv))
3153 =for apidoc sv_utf8_upgrade
3155 Converts the PV of an SV to its UTF-8-encoded form.
3156 Forces the SV to string form if it is not already.
3157 Will C<mg_get> on C<sv> if appropriate.
3158 Always sets the SvUTF8 flag to avoid future validity checks even
3159 if the whole string is the same in UTF-8 as not.
3160 Returns the number of bytes in the converted string
3162 This is not as a general purpose byte encoding to Unicode interface:
3163 use the Encode extension for that.
3165 =for apidoc sv_utf8_upgrade_nomg
3167 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3169 =for apidoc sv_utf8_upgrade_flags
3171 Converts the PV of an SV to its UTF-8-encoded form.
3172 Forces the SV to string form if it is not already.
3173 Always sets the SvUTF8 flag to avoid future validity checks even
3174 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3175 will C<mg_get> on C<sv> if appropriate, else not.
3176 Returns the number of bytes in the converted string
3177 C<sv_utf8_upgrade> and
3178 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3180 This is not as a general purpose byte encoding to Unicode interface:
3181 use the Encode extension for that.
3185 The grow version is currently not externally documented. It adds a parameter,
3186 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3187 have free after it upon return. This allows the caller to reserve extra space
3188 that it intends to fill, to avoid extra grows.
3190 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3191 which can be used to tell this function to not first check to see if there are
3192 any characters that are different in UTF-8 (variant characters) which would
3193 force it to allocate a new string to sv, but to assume there are. Typically
3194 this flag is used by a routine that has already parsed the string to find that
3195 there are such characters, and passes this information on so that the work
3196 doesn't have to be repeated.
3198 (One might think that the calling routine could pass in the position of the
3199 first such variant, so it wouldn't have to be found again. But that is not the
3200 case, because typically when the caller is likely to use this flag, it won't be
3201 calling this routine unless it finds something that won't fit into a byte.
3202 Otherwise it tries to not upgrade and just use bytes. But some things that
3203 do fit into a byte are variants in utf8, and the caller may not have been
3204 keeping track of these.)
3206 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3207 isn't guaranteed due to having other routines do the work in some input cases,
3208 or if the input is already flagged as being in utf8.
3210 The speed of this could perhaps be improved for many cases if someone wanted to
3211 write a fast function that counts the number of variant characters in a string,
3212 especially if it could return the position of the first one.
3217 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3221 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3223 if (sv == &PL_sv_undef)
3227 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3228 (void) sv_2pv_flags(sv,&len, flags);
3230 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3234 (void) SvPV_force(sv,len);
3239 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3244 sv_force_normal_flags(sv, 0);
3247 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3248 sv_recode_to_utf8(sv, PL_encoding);
3249 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3253 if (SvCUR(sv) == 0) {
3254 if (extra) SvGROW(sv, extra);
3255 } else { /* Assume Latin-1/EBCDIC */
3256 /* This function could be much more efficient if we
3257 * had a FLAG in SVs to signal if there are any variant
3258 * chars in the PV. Given that there isn't such a flag
3259 * make the loop as fast as possible (although there are certainly ways
3260 * to speed this up, eg. through vectorization) */
3261 U8 * s = (U8 *) SvPVX_const(sv);
3262 U8 * e = (U8 *) SvEND(sv);
3264 STRLEN two_byte_count = 0;
3266 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3268 /* See if really will need to convert to utf8. We mustn't rely on our
3269 * incoming SV being well formed and having a trailing '\0', as certain
3270 * code in pp_formline can send us partially built SVs. */
3274 if (NATIVE_IS_INVARIANT(ch)) continue;
3276 t--; /* t already incremented; re-point to first variant */
3281 /* utf8 conversion not needed because all are invariants. Mark as
3282 * UTF-8 even if no variant - saves scanning loop */
3288 /* Here, the string should be converted to utf8, either because of an
3289 * input flag (two_byte_count = 0), or because a character that
3290 * requires 2 bytes was found (two_byte_count = 1). t points either to
3291 * the beginning of the string (if we didn't examine anything), or to
3292 * the first variant. In either case, everything from s to t - 1 will
3293 * occupy only 1 byte each on output.
3295 * There are two main ways to convert. One is to create a new string
3296 * and go through the input starting from the beginning, appending each
3297 * converted value onto the new string as we go along. It's probably
3298 * best to allocate enough space in the string for the worst possible
3299 * case rather than possibly running out of space and having to
3300 * reallocate and then copy what we've done so far. Since everything
3301 * from s to t - 1 is invariant, the destination can be initialized
3302 * with these using a fast memory copy
3304 * The other way is to figure out exactly how big the string should be
3305 * by parsing the entire input. Then you don't have to make it big
3306 * enough to handle the worst possible case, and more importantly, if
3307 * the string you already have is large enough, you don't have to
3308 * allocate a new string, you can copy the last character in the input
3309 * string to the final position(s) that will be occupied by the
3310 * converted string and go backwards, stopping at t, since everything
3311 * before that is invariant.
3313 * There are advantages and disadvantages to each method.
3315 * In the first method, we can allocate a new string, do the memory
3316 * copy from the s to t - 1, and then proceed through the rest of the
3317 * string byte-by-byte.
3319 * In the second method, we proceed through the rest of the input
3320 * string just calculating how big the converted string will be. Then
3321 * there are two cases:
3322 * 1) if the string has enough extra space to handle the converted
3323 * value. We go backwards through the string, converting until we
3324 * get to the position we are at now, and then stop. If this
3325 * position is far enough along in the string, this method is
3326 * faster than the other method. If the memory copy were the same
3327 * speed as the byte-by-byte loop, that position would be about
3328 * half-way, as at the half-way mark, parsing to the end and back
3329 * is one complete string's parse, the same amount as starting
3330 * over and going all the way through. Actually, it would be
3331 * somewhat less than half-way, as it's faster to just count bytes
3332 * than to also copy, and we don't have the overhead of allocating
3333 * a new string, changing the scalar to use it, and freeing the
3334 * existing one. But if the memory copy is fast, the break-even
3335 * point is somewhere after half way. The counting loop could be
3336 * sped up by vectorization, etc, to move the break-even point
3337 * further towards the beginning.
3338 * 2) if the string doesn't have enough space to handle the converted
3339 * value. A new string will have to be allocated, and one might
3340 * as well, given that, start from the beginning doing the first
3341 * method. We've spent extra time parsing the string and in
3342 * exchange all we've gotten is that we know precisely how big to
3343 * make the new one. Perl is more optimized for time than space,
3344 * so this case is a loser.
3345 * So what I've decided to do is not use the 2nd method unless it is
3346 * guaranteed that a new string won't have to be allocated, assuming
3347 * the worst case. I also decided not to put any more conditions on it
3348 * than this, for now. It seems likely that, since the worst case is
3349 * twice as big as the unknown portion of the string (plus 1), we won't
3350 * be guaranteed enough space, causing us to go to the first method,
3351 * unless the string is short, or the first variant character is near
3352 * the end of it. In either of these cases, it seems best to use the
3353 * 2nd method. The only circumstance I can think of where this would
3354 * be really slower is if the string had once had much more data in it
3355 * than it does now, but there is still a substantial amount in it */
3358 STRLEN invariant_head = t - s;
3359 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3360 if (SvLEN(sv) < size) {
3362 /* Here, have decided to allocate a new string */
3367 Newx(dst, size, U8);
3369 /* If no known invariants at the beginning of the input string,
3370 * set so starts from there. Otherwise, can use memory copy to
3371 * get up to where we are now, and then start from here */
3373 if (invariant_head <= 0) {
3376 Copy(s, dst, invariant_head, char);
3377 d = dst + invariant_head;
3381 const UV uv = NATIVE8_TO_UNI(*t++);
3382 if (UNI_IS_INVARIANT(uv))
3383 *d++ = (U8)UNI_TO_NATIVE(uv);
3385 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3386 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3390 SvPV_free(sv); /* No longer using pre-existing string */
3391 SvPV_set(sv, (char*)dst);
3392 SvCUR_set(sv, d - dst);
3393 SvLEN_set(sv, size);
3396 /* Here, have decided to get the exact size of the string.
3397 * Currently this happens only when we know that there is
3398 * guaranteed enough space to fit the converted string, so
3399 * don't have to worry about growing. If two_byte_count is 0,
3400 * then t points to the first byte of the string which hasn't
3401 * been examined yet. Otherwise two_byte_count is 1, and t
3402 * points to the first byte in the string that will expand to
3403 * two. Depending on this, start examining at t or 1 after t.
3406 U8 *d = t + two_byte_count;
3409 /* Count up the remaining bytes that expand to two */
3412 const U8 chr = *d++;
3413 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3416 /* The string will expand by just the number of bytes that
3417 * occupy two positions. But we are one afterwards because of
3418 * the increment just above. This is the place to put the
3419 * trailing NUL, and to set the length before we decrement */
3421 d += two_byte_count;
3422 SvCUR_set(sv, d - s);
3426 /* Having decremented d, it points to the position to put the
3427 * very last byte of the expanded string. Go backwards through
3428 * the string, copying and expanding as we go, stopping when we
3429 * get to the part that is invariant the rest of the way down */
3433 const U8 ch = NATIVE8_TO_UNI(*e--);
3434 if (UNI_IS_INVARIANT(ch)) {
3435 *d-- = UNI_TO_NATIVE(ch);
3437 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3438 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3445 /* Mark as UTF-8 even if no variant - saves scanning loop */
3451 =for apidoc sv_utf8_downgrade
3453 Attempts to convert the PV of an SV from characters to bytes.
3454 If the PV contains a character that cannot fit
3455 in a byte, this conversion will fail;
3456 in this case, either returns false or, if C<fail_ok> is not
3459 This is not as a general purpose Unicode to byte encoding interface:
3460 use the Encode extension for that.
3466 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3470 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3472 if (SvPOKp(sv) && SvUTF8(sv)) {
3478 sv_force_normal_flags(sv, 0);
3480 s = (U8 *) SvPV(sv, len);
3481 if (!utf8_to_bytes(s, &len)) {
3486 Perl_croak(aTHX_ "Wide character in %s",
3489 Perl_croak(aTHX_ "Wide character");
3500 =for apidoc sv_utf8_encode
3502 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3503 flag off so that it looks like octets again.
3509 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3511 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3514 sv_force_normal_flags(sv, 0);
3516 if (SvREADONLY(sv)) {
3517 Perl_croak(aTHX_ "%s", PL_no_modify);
3519 (void) sv_utf8_upgrade(sv);
3524 =for apidoc sv_utf8_decode
3526 If the PV of the SV is an octet sequence in UTF-8
3527 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3528 so that it looks like a character. If the PV contains only single-byte
3529 characters, the C<SvUTF8> flag stays being off.
3530 Scans PV for validity and returns false if the PV is invalid UTF-8.
3536 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3538 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3544 /* The octets may have got themselves encoded - get them back as
3547 if (!sv_utf8_downgrade(sv, TRUE))
3550 /* it is actually just a matter of turning the utf8 flag on, but
3551 * we want to make sure everything inside is valid utf8 first.
3553 c = (const U8 *) SvPVX_const(sv);
3554 if (!is_utf8_string(c, SvCUR(sv)+1))
3556 e = (const U8 *) SvEND(sv);
3559 if (!UTF8_IS_INVARIANT(ch)) {
3569 =for apidoc sv_setsv
3571 Copies the contents of the source SV C<ssv> into the destination SV
3572 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3573 function if the source SV needs to be reused. Does not handle 'set' magic.
3574 Loosely speaking, it performs a copy-by-value, obliterating any previous
3575 content of the destination.
3577 You probably want to use one of the assortment of wrappers, such as
3578 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3579 C<SvSetMagicSV_nosteal>.
3581 =for apidoc sv_setsv_flags
3583 Copies the contents of the source SV C<ssv> into the destination SV
3584 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3585 function if the source SV needs to be reused. Does not handle 'set' magic.
3586 Loosely speaking, it performs a copy-by-value, obliterating any previous
3587 content of the destination.
3588 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3589 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3590 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3591 and C<sv_setsv_nomg> are implemented in terms of this function.
3593 You probably want to use one of the assortment of wrappers, such as
3594 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3595 C<SvSetMagicSV_nosteal>.
3597 This is the primary function for copying scalars, and most other
3598 copy-ish functions and macros use this underneath.
3604 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3606 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3608 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3610 if (dtype != SVt_PVGV) {
3611 const char * const name = GvNAME(sstr);
3612 const STRLEN len = GvNAMELEN(sstr);
3614 if (dtype >= SVt_PV) {
3620 SvUPGRADE(dstr, SVt_PVGV);
3621 (void)SvOK_off(dstr);
3622 /* FIXME - why are we doing this, then turning it off and on again
3624 isGV_with_GP_on(dstr);
3626 GvSTASH(dstr) = GvSTASH(sstr);
3628 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3629 gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3630 SvFAKE_on(dstr); /* can coerce to non-glob */
3633 if(GvGP(MUTABLE_GV(sstr))) {
3634 /* If source has method cache entry, clear it */
3636 SvREFCNT_dec(GvCV(sstr));
3640 /* If source has a real method, then a method is
3642 else if(GvCV((const GV *)sstr)) {
3647 /* If dest already had a real method, that's a change as well */
3648 if(!mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)) {
3652 if(strEQ(GvNAME((const GV *)dstr),"ISA"))
3655 gp_free(MUTABLE_GV(dstr));
3656 isGV_with_GP_off(dstr);
3657 (void)SvOK_off(dstr);
3658 isGV_with_GP_on(dstr);
3659 GvINTRO_off(dstr); /* one-shot flag */
3660 GvGP(dstr) = gp_ref(GvGP(sstr));
3661 if (SvTAINTED(sstr))
3663 if (GvIMPORTED(dstr) != GVf_IMPORTED
3664 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3666 GvIMPORTED_on(dstr);
3669 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3670 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3675 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3677 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3679 const int intro = GvINTRO(dstr);
3682 const U32 stype = SvTYPE(sref);
3683 bool mro_changes = FALSE;
3685 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3688 GvINTRO_off(dstr); /* one-shot flag */
3689 GvLINE(dstr) = CopLINE(PL_curcop);
3690 GvEGV(dstr) = MUTABLE_GV(dstr);
3695 location = (SV **) &GvCV(dstr);
3696 import_flag = GVf_IMPORTED_CV;
3699 location = (SV **) &GvHV(dstr);
3700 import_flag = GVf_IMPORTED_HV;
3703 location = (SV **) &GvAV(dstr);
3704 if (strEQ(GvNAME((GV*)dstr), "ISA"))
3706 import_flag = GVf_IMPORTED_AV;
3709 location = (SV **) &GvIOp(dstr);
3712 location = (SV **) &GvFORM(dstr);
3715 location = &GvSV(dstr);
3716 import_flag = GVf_IMPORTED_SV;
3719 if (stype == SVt_PVCV) {
3720 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3721 if (GvCVGEN(dstr)) {
3722 SvREFCNT_dec(GvCV(dstr));
3724 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3727 SAVEGENERICSV(*location);
3731 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3732 CV* const cv = MUTABLE_CV(*location);
3734 if (!GvCVGEN((const GV *)dstr) &&
3735 (CvROOT(cv) || CvXSUB(cv)))
3737 /* Redefining a sub - warning is mandatory if
3738 it was a const and its value changed. */
3739 if (CvCONST(cv) && CvCONST((const CV *)sref)
3741 == cv_const_sv((const CV *)sref)) {
3743 /* They are 2 constant subroutines generated from
3744 the same constant. This probably means that
3745 they are really the "same" proxy subroutine
3746 instantiated in 2 places. Most likely this is
3747 when a constant is exported twice. Don't warn.
3750 else if (ckWARN(WARN_REDEFINE)
3752 && (!CvCONST((const CV *)sref)
3753 || sv_cmp(cv_const_sv(cv),
3754 cv_const_sv((const CV *)
3756 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3759 ? "Constant subroutine %s::%s redefined"
3760 : "Subroutine %s::%s redefined"),
3761 HvNAME_get(GvSTASH((const GV *)dstr)),
3762 GvENAME(MUTABLE_GV(dstr)));
3766 cv_ckproto_len(cv, (const GV *)dstr,
3767 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3768 SvPOK(sref) ? SvCUR(sref) : 0);
3770 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3771 GvASSUMECV_on(dstr);
3772 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3775 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3776 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3777 GvFLAGS(dstr) |= import_flag;
3782 if (SvTAINTED(sstr))
3784 if (mro_changes) mro_isa_changed_in(GvSTASH(dstr));
3789 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3792 register U32 sflags;
3794 register svtype stype;
3796 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3801 if (SvIS_FREED(dstr)) {
3802 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3803 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3805 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3807 sstr = &PL_sv_undef;
3808 if (SvIS_FREED(sstr)) {
3809 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3810 (void*)sstr, (void*)dstr);
3812 stype = SvTYPE(sstr);
3813 dtype = SvTYPE(dstr);
3815 (void)SvAMAGIC_off(dstr);
3818 /* need to nuke the magic */
3822 /* There's a lot of redundancy below but we're going for speed here */
3827 if (dtype != SVt_PVGV) {
3828 (void)SvOK_off(dstr);
3836 sv_upgrade(dstr, SVt_IV);
3840 sv_upgrade(dstr, SVt_PVIV);
3843 goto end_of_first_switch;
3845 (void)SvIOK_only(dstr);
3846 SvIV_set(dstr, SvIVX(sstr));
3849 /* SvTAINTED can only be true if the SV has taint magic, which in
3850 turn means that the SV type is PVMG (or greater). This is the
3851 case statement for SVt_IV, so this cannot be true (whatever gcov
3853 assert(!SvTAINTED(sstr));
3858 if (dtype < SVt_PV && dtype != SVt_IV)
3859 sv_upgrade(dstr, SVt_IV);
3867 sv_upgrade(dstr, SVt_NV);
3871 sv_upgrade(dstr, SVt_PVNV);
3874 goto end_of_first_switch;
3876 SvNV_set(dstr, SvNVX(sstr));
3877 (void)SvNOK_only(dstr);
3878 /* SvTAINTED can only be true if the SV has taint magic, which in
3879 turn means that the SV type is PVMG (or greater). This is the
3880 case statement for SVt_NV, so this cannot be true (whatever gcov
3882 assert(!SvTAINTED(sstr));
3888 #ifdef PERL_OLD_COPY_ON_WRITE
3889 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3890 if (dtype < SVt_PVIV)
3891 sv_upgrade(dstr, SVt_PVIV);
3898 sv_upgrade(dstr, SVt_PV);
3901 if (dtype < SVt_PVIV)
3902 sv_upgrade(dstr, SVt_PVIV);
3905 if (dtype < SVt_PVNV)
3906 sv_upgrade(dstr, SVt_PVNV);
3910 const char * const type = sv_reftype(sstr,0);
3912 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3914 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3919 if (dtype < SVt_REGEXP)
3920 sv_upgrade(dstr, SVt_REGEXP);
3923 /* case SVt_BIND: */
3926 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3927 glob_assign_glob(dstr, sstr, dtype);
3930 /* SvVALID means that this PVGV is playing at being an FBM. */
3934 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3936 if (SvTYPE(sstr) != stype) {
3937 stype = SvTYPE(sstr);
3938 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3939 glob_assign_glob(dstr, sstr, dtype);
3944 if (stype == SVt_PVLV)
3945 SvUPGRADE(dstr, SVt_PVNV);
3947 SvUPGRADE(dstr, (svtype)stype);
3949 end_of_first_switch:
3951 /* dstr may have been upgraded. */
3952 dtype = SvTYPE(dstr);
3953 sflags = SvFLAGS(sstr);
3955 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3956 /* Assigning to a subroutine sets the prototype. */
3959 const char *const ptr = SvPV_const(sstr, len);
3961 SvGROW(dstr, len + 1);
3962 Copy(ptr, SvPVX(dstr), len + 1, char);
3963 SvCUR_set(dstr, len);
3965 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3969 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3970 const char * const type = sv_reftype(dstr,0);
3972 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3974 Perl_croak(aTHX_ "Cannot copy to %s", type);
3975 } else if (sflags & SVf_ROK) {
3976 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3977 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3980 if (GvIMPORTED(dstr) != GVf_IMPORTED
3981 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3983 GvIMPORTED_on(dstr);
3988 glob_assign_glob(dstr, sstr, dtype);
3992 if (dtype >= SVt_PV) {
3993 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3994 glob_assign_ref(dstr, sstr);
3997 if (SvPVX_const(dstr)) {
4003 (void)SvOK_off(dstr);
4004 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4005 SvFLAGS(dstr) |= sflags & SVf_ROK;
4006 assert(!(sflags & SVp_NOK));
4007 assert(!(sflags & SVp_IOK));
4008 assert(!(sflags & SVf_NOK));
4009 assert(!(sflags & SVf_IOK));
4011 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
4012 if (!(sflags & SVf_OK)) {
4013 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4014 "Undefined value assigned to typeglob");
4017 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4018 if (dstr != (const SV *)gv) {
4020 gp_free(MUTABLE_GV(dstr));
4021 GvGP(dstr) = gp_ref(GvGP(gv));
4025 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4026 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4028 else if (sflags & SVp_POK) {
4032 * Check to see if we can just swipe the string. If so, it's a
4033 * possible small lose on short strings, but a big win on long ones.
4034 * It might even be a win on short strings if SvPVX_const(dstr)
4035 * has to be allocated and SvPVX_const(sstr) has to be freed.
4036 * Likewise if we can set up COW rather than doing an actual copy, we
4037 * drop to the else clause, as the swipe code and the COW setup code
4038 * have much in common.
4041 /* Whichever path we take through the next code, we want this true,
4042 and doing it now facilitates the COW check. */
4043 (void)SvPOK_only(dstr);
4046 /* If we're already COW then this clause is not true, and if COW
4047 is allowed then we drop down to the else and make dest COW
4048 with us. If caller hasn't said that we're allowed to COW
4049 shared hash keys then we don't do the COW setup, even if the
4050 source scalar is a shared hash key scalar. */
4051 (((flags & SV_COW_SHARED_HASH_KEYS)
4052 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4053 : 1 /* If making a COW copy is forbidden then the behaviour we
4054 desire is as if the source SV isn't actually already
4055 COW, even if it is. So we act as if the source flags
4056 are not COW, rather than actually testing them. */
4058 #ifndef PERL_OLD_COPY_ON_WRITE
4059 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4060 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4061 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4062 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4063 but in turn, it's somewhat dead code, never expected to go
4064 live, but more kept as a placeholder on how to do it better
4065 in a newer implementation. */
4066 /* If we are COW and dstr is a suitable target then we drop down
4067 into the else and make dest a COW of us. */
4068 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4073 (sflags & SVs_TEMP) && /* slated for free anyway? */
4074 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4075 (!(flags & SV_NOSTEAL)) &&
4076 /* and we're allowed to steal temps */
4077 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4078 SvLEN(sstr) && /* and really is a string */
4079 /* and won't be needed again, potentially */
4080 !(PL_op && PL_op->op_type == OP_AASSIGN))
4081 #ifdef PERL_OLD_COPY_ON_WRITE
4082 && ((flags & SV_COW_SHARED_HASH_KEYS)
4083 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4084 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4085 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4089 /* Failed the swipe test, and it's not a shared hash key either.
4090 Have to copy the string. */
4091 STRLEN len = SvCUR(sstr);
4092 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4093 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4094 SvCUR_set(dstr, len);
4095 *SvEND(dstr) = '\0';
4097 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4099 /* Either it's a shared hash key, or it's suitable for
4100 copy-on-write or we can swipe the string. */
4102 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4106 #ifdef PERL_OLD_COPY_ON_WRITE
4108 if ((sflags & (SVf_FAKE | SVf_READONLY))
4109 != (SVf_FAKE | SVf_READONLY)) {
4110 SvREADONLY_on(sstr);
4112 /* Make the source SV into a loop of 1.
4113 (about to become 2) */
4114 SV_COW_NEXT_SV_SET(sstr, sstr);
4118 /* Initial code is common. */
4119 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4124 /* making another shared SV. */
4125 STRLEN cur = SvCUR(sstr);
4126 STRLEN len = SvLEN(sstr);
4127 #ifdef PERL_OLD_COPY_ON_WRITE
4129 assert (SvTYPE(dstr) >= SVt_PVIV);
4130 /* SvIsCOW_normal */
4131 /* splice us in between source and next-after-source. */
4132 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4133 SV_COW_NEXT_SV_SET(sstr, dstr);
4134 SvPV_set(dstr, SvPVX_mutable(sstr));
4138 /* SvIsCOW_shared_hash */
4139 DEBUG_C(PerlIO_printf(Perl_debug_log,
4140 "Copy on write: Sharing hash\n"));
4142 assert (SvTYPE(dstr) >= SVt_PV);
4144 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4146 SvLEN_set(dstr, len);
4147 SvCUR_set(dstr, cur);
4148 SvREADONLY_on(dstr);
4152 { /* Passes the swipe test. */
4153 SvPV_set(dstr, SvPVX_mutable(sstr));
4154 SvLEN_set(dstr, SvLEN(sstr));
4155 SvCUR_set(dstr, SvCUR(sstr));
4158 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4159 SvPV_set(sstr, NULL);
4165 if (sflags & SVp_NOK) {
4166 SvNV_set(dstr, SvNVX(sstr));
4168 if (sflags & SVp_IOK) {
4169 SvIV_set(dstr, SvIVX(sstr));
4170 /* Must do this otherwise some other overloaded use of 0x80000000
4171 gets confused. I guess SVpbm_VALID */
4172 if (sflags & SVf_IVisUV)
4175 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4177 const MAGIC * const smg = SvVSTRING_mg(sstr);
4179 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4180 smg->mg_ptr, smg->mg_len);
4181 SvRMAGICAL_on(dstr);
4185 else if (sflags & (SVp_IOK|SVp_NOK)) {
4186 (void)SvOK_off(dstr);
4187 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4188 if (sflags & SVp_IOK) {
4189 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4190 SvIV_set(dstr, SvIVX(sstr));
4192 if (sflags & SVp_NOK) {
4193 SvNV_set(dstr, SvNVX(sstr));
4197 if (isGV_with_GP(sstr)) {
4198 /* This stringification rule for globs is spread in 3 places.
4199 This feels bad. FIXME. */
4200 const U32 wasfake = sflags & SVf_FAKE;
4202 /* FAKE globs can get coerced, so need to turn this off
4203 temporarily if it is on. */
4205 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4206 SvFLAGS(sstr) |= wasfake;
4209 (void)SvOK_off(dstr);
4211 if (SvTAINTED(sstr))
4216 =for apidoc sv_setsv_mg
4218 Like C<sv_setsv>, but also handles 'set' magic.
4224 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4226 PERL_ARGS_ASSERT_SV_SETSV_MG;
4228 sv_setsv(dstr,sstr);
4232 #ifdef PERL_OLD_COPY_ON_WRITE
4234 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4236 STRLEN cur = SvCUR(sstr);
4237 STRLEN len = SvLEN(sstr);
4238 register char *new_pv;
4240 PERL_ARGS_ASSERT_SV_SETSV_COW;
4243 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4244 (void*)sstr, (void*)dstr);
4251 if (SvTHINKFIRST(dstr))
4252 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4253 else if (SvPVX_const(dstr))
4254 Safefree(SvPVX_const(dstr));
4258 SvUPGRADE(dstr, SVt_PVIV);
4260 assert (SvPOK(sstr));
4261 assert (SvPOKp(sstr));
4262 assert (!SvIOK(sstr));
4263 assert (!SvIOKp(sstr));
4264 assert (!SvNOK(sstr));
4265 assert (!SvNOKp(sstr));
4267 if (SvIsCOW(sstr)) {
4269 if (SvLEN(sstr) == 0) {
4270 /* source is a COW shared hash key. */
4271 DEBUG_C(PerlIO_printf(Perl_debug_log,
4272 "Fast copy on write: Sharing hash\n"));
4273 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4276 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4278 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4279 SvUPGRADE(sstr, SVt_PVIV);
4280 SvREADONLY_on(sstr);
4282 DEBUG_C(PerlIO_printf(Perl_debug_log,
4283 "Fast copy on write: Converting sstr to COW\n"));
4284 SV_COW_NEXT_SV_SET(dstr, sstr);
4286 SV_COW_NEXT_SV_SET(sstr, dstr);
4287 new_pv = SvPVX_mutable(sstr);
4290 SvPV_set(dstr, new_pv);
4291 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4294 SvLEN_set(dstr, len);
4295 SvCUR_set(dstr, cur);
4304 =for apidoc sv_setpvn
4306 Copies a string into an SV. The C<len> parameter indicates the number of
4307 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4308 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4314 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4317 register char *dptr;
4319 PERL_ARGS_ASSERT_SV_SETPVN;
4321 SV_CHECK_THINKFIRST_COW_DROP(sv);
4327 /* len is STRLEN which is unsigned, need to copy to signed */
4330 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4332 SvUPGRADE(sv, SVt_PV);
4334 dptr = SvGROW(sv, len + 1);
4335 Move(ptr,dptr,len,char);
4338 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4343 =for apidoc sv_setpvn_mg
4345 Like C<sv_setpvn>, but also handles 'set' magic.
4351 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4353 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4355 sv_setpvn(sv,ptr,len);
4360 =for apidoc sv_setpv
4362 Copies a string into an SV. The string must be null-terminated. Does not
4363 handle 'set' magic. See C<sv_setpv_mg>.
4369 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4372 register STRLEN len;
4374 PERL_ARGS_ASSERT_SV_SETPV;
4376 SV_CHECK_THINKFIRST_COW_DROP(sv);
4382 SvUPGRADE(sv, SVt_PV);
4384 SvGROW(sv, len + 1);
4385 Move(ptr,SvPVX(sv),len+1,char);
4387 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4392 =for apidoc sv_setpv_mg
4394 Like C<sv_setpv>, but also handles 'set' magic.
4400 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4402 PERL_ARGS_ASSERT_SV_SETPV_MG;
4409 =for apidoc sv_usepvn_flags
4411 Tells an SV to use C<ptr> to find its string value. Normally the
4412 string is stored inside the SV but sv_usepvn allows the SV to use an
4413 outside string. The C<ptr> should point to memory that was allocated
4414 by C<malloc>. The string length, C<len>, must be supplied. By default
4415 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4416 so that pointer should not be freed or used by the programmer after
4417 giving it to sv_usepvn, and neither should any pointers from "behind"
4418 that pointer (e.g. ptr + 1) be used.
4420 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4421 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4422 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4423 C<len>, and already meets the requirements for storing in C<SvPVX>)
4429 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4434 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4436 SV_CHECK_THINKFIRST_COW_DROP(sv);
4437 SvUPGRADE(sv, SVt_PV);
4440 if (flags & SV_SMAGIC)
4444 if (SvPVX_const(sv))
4448 if (flags & SV_HAS_TRAILING_NUL)
4449 assert(ptr[len] == '\0');
4452 allocate = (flags & SV_HAS_TRAILING_NUL)
4454 #ifdef Perl_safesysmalloc_size
4457 PERL_STRLEN_ROUNDUP(len + 1);
4459 if (flags & SV_HAS_TRAILING_NUL) {
4460 /* It's long enough - do nothing.
4461 Specfically Perl_newCONSTSUB is relying on this. */
4464 /* Force a move to shake out bugs in callers. */
4465 char *new_ptr = (char*)safemalloc(allocate);
4466 Copy(ptr, new_ptr, len, char);
4467 PoisonFree(ptr,len,char);
4471 ptr = (char*) saferealloc (ptr, allocate);
4474 #ifdef Perl_safesysmalloc_size
4475 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4477 SvLEN_set(sv, allocate);
4481 if (!(flags & SV_HAS_TRAILING_NUL)) {
4484 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4486 if (flags & SV_SMAGIC)
4490 #ifdef PERL_OLD_COPY_ON_WRITE
4491 /* Need to do this *after* making the SV normal, as we need the buffer
4492 pointer to remain valid until after we've copied it. If we let go too early,
4493 another thread could invalidate it by unsharing last of the same hash key
4494 (which it can do by means other than releasing copy-on-write Svs)
4495 or by changing the other copy-on-write SVs in the loop. */
4497 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4499 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4501 { /* this SV was SvIsCOW_normal(sv) */
4502 /* we need to find the SV pointing to us. */
4503 SV *current = SV_COW_NEXT_SV(after);
4505 if (current == sv) {
4506 /* The SV we point to points back to us (there were only two of us
4508 Hence other SV is no longer copy on write either. */
4510 SvREADONLY_off(after);
4512 /* We need to follow the pointers around the loop. */
4514 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4517 /* don't loop forever if the structure is bust, and we have
4518 a pointer into a closed loop. */
4519 assert (current != after);
4520 assert (SvPVX_const(current) == pvx);
4522 /* Make the SV before us point to the SV after us. */
4523 SV_COW_NEXT_SV_SET(current, after);
4529 =for apidoc sv_force_normal_flags
4531 Undo various types of fakery on an SV: if the PV is a shared string, make
4532 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4533 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4534 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4535 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4536 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4537 set to some other value.) In addition, the C<flags> parameter gets passed to
4538 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4539 with flags set to 0.
4545 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4549 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4551 #ifdef PERL_OLD_COPY_ON_WRITE
4552 if (SvREADONLY(sv)) {
4554 const char * const pvx = SvPVX_const(sv);
4555 const STRLEN len = SvLEN(sv);
4556 const STRLEN cur = SvCUR(sv);
4557 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4558 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4559 we'll fail an assertion. */
4560 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4563 PerlIO_printf(Perl_debug_log,
4564 "Copy on write: Force normal %ld\n",
4570 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4573 if (flags & SV_COW_DROP_PV) {
4574 /* OK, so we don't need to copy our buffer. */
4577 SvGROW(sv, cur + 1);
4578 Move(pvx,SvPVX(sv),cur,char);
4583 sv_release_COW(sv, pvx, next);
4585 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4591 else if (IN_PERL_RUNTIME)
4592 Perl_croak(aTHX_ "%s", PL_no_modify);
4595 if (SvREADONLY(sv)) {
4597 const char * const pvx = SvPVX_const(sv);
4598 const STRLEN len = SvCUR(sv);
4603 SvGROW(sv, len + 1);
4604 Move(pvx,SvPVX(sv),len,char);
4606 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4608 else if (IN_PERL_RUNTIME)
4609 Perl_croak(aTHX_ "%s", PL_no_modify);
4613 sv_unref_flags(sv, flags);
4614 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4621 Efficient removal of characters from the beginning of the string buffer.
4622 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4623 the string buffer. The C<ptr> becomes the first character of the adjusted
4624 string. Uses the "OOK hack".
4625 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4626 refer to the same chunk of data.
4632 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4638 const U8 *real_start;
4642 PERL_ARGS_ASSERT_SV_CHOP;
4644 if (!ptr || !SvPOKp(sv))
4646 delta = ptr - SvPVX_const(sv);
4648 /* Nothing to do. */
4651 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4652 nothing uses the value of ptr any more. */
4653 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4654 if (ptr <= SvPVX_const(sv))
4655 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4656 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4657 SV_CHECK_THINKFIRST(sv);
4658 if (delta > max_delta)
4659 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4660 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4661 SvPVX_const(sv) + max_delta);
4664 if (!SvLEN(sv)) { /* make copy of shared string */
4665 const char *pvx = SvPVX_const(sv);
4666 const STRLEN len = SvCUR(sv);
4667 SvGROW(sv, len + 1);
4668 Move(pvx,SvPVX(sv),len,char);
4671 SvFLAGS(sv) |= SVf_OOK;
4674 SvOOK_offset(sv, old_delta);
4676 SvLEN_set(sv, SvLEN(sv) - delta);
4677 SvCUR_set(sv, SvCUR(sv) - delta);
4678 SvPV_set(sv, SvPVX(sv) + delta);
4680 p = (U8 *)SvPVX_const(sv);
4685 real_start = p - delta;
4689 if (delta < 0x100) {
4693 p -= sizeof(STRLEN);
4694 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4698 /* Fill the preceding buffer with sentinals to verify that no-one is
4700 while (p > real_start) {
4708 =for apidoc sv_catpvn
4710 Concatenates the string onto the end of the string which is in the SV. The
4711 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4712 status set, then the bytes appended should be valid UTF-8.
4713 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4715 =for apidoc sv_catpvn_flags
4717 Concatenates the string onto the end of the string which is in the SV. The
4718 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4719 status set, then the bytes appended should be valid UTF-8.
4720 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4721 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4722 in terms of this function.
4728 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4732 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4734 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4736 SvGROW(dsv, dlen + slen + 1);
4738 sstr = SvPVX_const(dsv);
4739 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4740 SvCUR_set(dsv, SvCUR(dsv) + slen);
4742 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4744 if (flags & SV_SMAGIC)
4749 =for apidoc sv_catsv
4751 Concatenates the string from SV C<ssv> onto the end of the string in
4752 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4753 not 'set' magic. See C<sv_catsv_mg>.
4755 =for apidoc sv_catsv_flags
4757 Concatenates the string from SV C<ssv> onto the end of the string in
4758 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4759 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4760 and C<sv_catsv_nomg> are implemented in terms of this function.
4765 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4769 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4773 const char *spv = SvPV_const(ssv, slen);
4775 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4776 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4777 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4778 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4779 dsv->sv_flags doesn't have that bit set.
4780 Andy Dougherty 12 Oct 2001
4782 const I32 sutf8 = DO_UTF8(ssv);
4785 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4787 dutf8 = DO_UTF8(dsv);
4789 if (dutf8 != sutf8) {
4791 /* Not modifying source SV, so taking a temporary copy. */
4792 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4794 sv_utf8_upgrade(csv);
4795 spv = SvPV_const(csv, slen);
4798 /* Leave enough space for the cat that's about to happen */
4799 sv_utf8_upgrade_flags_grow(dsv, 0, slen);
4801 sv_catpvn_nomg(dsv, spv, slen);
4804 if (flags & SV_SMAGIC)
4809 =for apidoc sv_catpv
4811 Concatenates the string onto the end of the string which is in the SV.
4812 If the SV has the UTF-8 status set, then the bytes appended should be
4813 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4818 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4821 register STRLEN len;
4825 PERL_ARGS_ASSERT_SV_CATPV;
4829 junk = SvPV_force(sv, tlen);
4831 SvGROW(sv, tlen + len + 1);
4833 ptr = SvPVX_const(sv);
4834 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4835 SvCUR_set(sv, SvCUR(sv) + len);
4836 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4841 =for apidoc sv_catpv_mg
4843 Like C<sv_catpv>, but also handles 'set' magic.
4849 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4851 PERL_ARGS_ASSERT_SV_CATPV_MG;
4860 Creates a new SV. A non-zero C<len> parameter indicates the number of
4861 bytes of preallocated string space the SV should have. An extra byte for a
4862 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4863 space is allocated.) The reference count for the new SV is set to 1.
4865 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4866 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4867 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4868 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4869 modules supporting older perls.
4875 Perl_newSV(pTHX_ const STRLEN len)
4882 sv_upgrade(sv, SVt_PV);
4883 SvGROW(sv, len + 1);
4888 =for apidoc sv_magicext
4890 Adds magic to an SV, upgrading it if necessary. Applies the
4891 supplied vtable and returns a pointer to the magic added.
4893 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4894 In particular, you can add magic to SvREADONLY SVs, and add more than
4895 one instance of the same 'how'.
4897 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4898 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4899 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4900 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4902 (This is now used as a subroutine by C<sv_magic>.)
4907 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4908 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4913 PERL_ARGS_ASSERT_SV_MAGICEXT;
4915 SvUPGRADE(sv, SVt_PVMG);
4916 Newxz(mg, 1, MAGIC);
4917 mg->mg_moremagic = SvMAGIC(sv);
4918 SvMAGIC_set(sv, mg);
4920 /* Sometimes a magic contains a reference loop, where the sv and
4921 object refer to each other. To prevent a reference loop that
4922 would prevent such objects being freed, we look for such loops
4923 and if we find one we avoid incrementing the object refcount.
4925 Note we cannot do this to avoid self-tie loops as intervening RV must
4926 have its REFCNT incremented to keep it in existence.
4929 if (!obj || obj == sv ||
4930 how == PERL_MAGIC_arylen ||
4931 how == PERL_MAGIC_symtab ||
4932 (SvTYPE(obj) == SVt_PVGV &&
4933 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
4934 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
4935 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
4940 mg->mg_obj = SvREFCNT_inc_simple(obj);
4941 mg->mg_flags |= MGf_REFCOUNTED;
4944 /* Normal self-ties simply pass a null object, and instead of
4945 using mg_obj directly, use the SvTIED_obj macro to produce a
4946 new RV as needed. For glob "self-ties", we are tieing the PVIO
4947 with an RV obj pointing to the glob containing the PVIO. In
4948 this case, to avoid a reference loop, we need to weaken the
4952 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4953 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
4959 mg->mg_len = namlen;
4962 mg->mg_ptr = savepvn(name, namlen);
4963 else if (namlen == HEf_SVKEY) {
4964 /* Yes, this is casting away const. This is only for the case of
4965 HEf_SVKEY. I think we need to document this abberation of the
4966 constness of the API, rather than making name non-const, as
4967 that change propagating outwards a long way. */
4968 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
4970 mg->mg_ptr = (char *) name;
4972 mg->mg_virtual = (MGVTBL *) vtable;
4976 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4981 =for apidoc sv_magic
4983 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4984 then adds a new magic item of type C<how> to the head of the magic list.
4986 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4987 handling of the C<name> and C<namlen> arguments.
4989 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4990 to add more than one instance of the same 'how'.
4996 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4997 const char *const name, const I32 namlen)
5000 const MGVTBL *vtable;
5003 PERL_ARGS_ASSERT_SV_MAGIC;
5005 #ifdef PERL_OLD_COPY_ON_WRITE
5007 sv_force_normal_flags(sv, 0);
5009 if (SvREADONLY(sv)) {
5011 /* its okay to attach magic to shared strings; the subsequent
5012 * upgrade to PVMG will unshare the string */
5013 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5016 && how != PERL_MAGIC_regex_global
5017 && how != PERL_MAGIC_bm
5018 && how != PERL_MAGIC_fm
5019 && how != PERL_MAGIC_sv
5020 && how != PERL_MAGIC_backref
5023 Perl_croak(aTHX_ "%s", PL_no_modify);
5026 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5027 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5028 /* sv_magic() refuses to add a magic of the same 'how' as an
5031 if (how == PERL_MAGIC_taint) {
5033 /* Any scalar which already had taint magic on which someone
5034 (erroneously?) did SvIOK_on() or similar will now be
5035 incorrectly sporting public "OK" flags. */
5036 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5044 vtable = &PL_vtbl_sv;
5046 case PERL_MAGIC_overload:
5047 vtable = &PL_vtbl_amagic;
5049 case PERL_MAGIC_overload_elem:
5050 vtable = &PL_vtbl_amagicelem;
5052 case PERL_MAGIC_overload_table:
5053 vtable = &PL_vtbl_ovrld;
5056 vtable = &PL_vtbl_bm;
5058 case PERL_MAGIC_regdata:
5059 vtable = &PL_vtbl_regdata;
5061 case PERL_MAGIC_regdatum:
5062 vtable = &PL_vtbl_regdatum;
5064 case PERL_MAGIC_env:
5065 vtable = &PL_vtbl_env;
5068 vtable = &PL_vtbl_fm;
5070 case PERL_MAGIC_envelem:
5071 vtable = &PL_vtbl_envelem;
5073 case PERL_MAGIC_regex_global:
5074 vtable = &PL_vtbl_mglob;
5076 case PERL_MAGIC_isa:
5077 vtable = &PL_vtbl_isa;
5079 case PERL_MAGIC_isaelem:
5080 vtable = &PL_vtbl_isaelem;
5082 case PERL_MAGIC_nkeys:
5083 vtable = &PL_vtbl_nkeys;
5085 case PERL_MAGIC_dbfile:
5088 case PERL_MAGIC_dbline:
5089 vtable = &PL_vtbl_dbline;
5091 #ifdef USE_LOCALE_COLLATE
5092 case PERL_MAGIC_collxfrm:
5093 vtable = &PL_vtbl_collxfrm;
5095 #endif /* USE_LOCALE_COLLATE */
5096 case PERL_MAGIC_tied:
5097 vtable = &PL_vtbl_pack;
5099 case PERL_MAGIC_tiedelem:
5100 case PERL_MAGIC_tiedscalar:
5101 vtable = &PL_vtbl_packelem;
5104 vtable = &PL_vtbl_regexp;
5106 case PERL_MAGIC_sig:
5107 vtable = &PL_vtbl_sig;
5109 case PERL_MAGIC_sigelem:
5110 vtable = &PL_vtbl_sigelem;
5112 case PERL_MAGIC_taint:
5113 vtable = &PL_vtbl_taint;
5115 case PERL_MAGIC_uvar:
5116 vtable = &PL_vtbl_uvar;
5118 case PERL_MAGIC_vec:
5119 vtable = &PL_vtbl_vec;
5121 case PERL_MAGIC_arylen_p:
5122 case PERL_MAGIC_rhash:
5123 case PERL_MAGIC_symtab:
5124 case PERL_MAGIC_vstring:
5127 case PERL_MAGIC_utf8:
5128 vtable = &PL_vtbl_utf8;
5130 case PERL_MAGIC_substr:
5131 vtable = &PL_vtbl_substr;
5133 case PERL_MAGIC_defelem:
5134 vtable = &PL_vtbl_defelem;
5136 case PERL_MAGIC_arylen:
5137 vtable = &PL_vtbl_arylen;
5139 case PERL_MAGIC_pos:
5140 vtable = &PL_vtbl_pos;
5142 case PERL_MAGIC_backref:
5143 vtable = &PL_vtbl_backref;
5145 case PERL_MAGIC_hintselem:
5146 vtable = &PL_vtbl_hintselem;
5148 case PERL_MAGIC_hints:
5149 vtable = &PL_vtbl_hints;
5151 case PERL_MAGIC_ext:
5152 /* Reserved for use by extensions not perl internals. */
5153 /* Useful for attaching extension internal data to perl vars. */
5154 /* Note that multiple extensions may clash if magical scalars */
5155 /* etc holding private data from one are passed to another. */
5159 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5162 /* Rest of work is done else where */
5163 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5166 case PERL_MAGIC_taint:
5169 case PERL_MAGIC_ext:
5170 case PERL_MAGIC_dbfile:
5177 =for apidoc sv_unmagic
5179 Removes all magic of type C<type> from an SV.
5185 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5190 PERL_ARGS_ASSERT_SV_UNMAGIC;
5192 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5194 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5195 for (mg = *mgp; mg; mg = *mgp) {
5196 if (mg->mg_type == type) {
5197 const MGVTBL* const vtbl = mg->mg_virtual;
5198 *mgp = mg->mg_moremagic;
5199 if (vtbl && vtbl->svt_free)
5200 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5201 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5203 Safefree(mg->mg_ptr);
5204 else if (mg->mg_len == HEf_SVKEY)
5205 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5206 else if (mg->mg_type == PERL_MAGIC_utf8)
5207 Safefree(mg->mg_ptr);
5209 if (mg->mg_flags & MGf_REFCOUNTED)
5210 SvREFCNT_dec(mg->mg_obj);
5214 mgp = &mg->mg_moremagic;
5218 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5219 SvMAGIC_set(sv, NULL);
5226 =for apidoc sv_rvweaken
5228 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5229 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5230 push a back-reference to this RV onto the array of backreferences
5231 associated with that magic. If the RV is magical, set magic will be
5232 called after the RV is cleared.
5238 Perl_sv_rvweaken(pTHX_ SV *const sv)
5242 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5244 if (!SvOK(sv)) /* let undefs pass */
5247 Perl_croak(aTHX_ "Can't weaken a nonreference");
5248 else if (SvWEAKREF(sv)) {
5249 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5253 Perl_sv_add_backref(aTHX_ tsv, sv);
5259 /* Give tsv backref magic if it hasn't already got it, then push a
5260 * back-reference to sv onto the array associated with the backref magic.
5263 /* A discussion about the backreferences array and its refcount:
5265 * The AV holding the backreferences is pointed to either as the mg_obj of
5266 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5267 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5268 * have the standard magic instead.) The array is created with a refcount
5269 * of 2. This means that if during global destruction the array gets
5270 * picked on first to have its refcount decremented by the random zapper,
5271 * it won't actually be freed, meaning it's still theere for when its
5272 * parent gets freed.
5273 * When the parent SV is freed, in the case of magic, the magic is freed,
5274 * Perl_magic_killbackrefs is called which decrements one refcount, then
5275 * mg_obj is freed which kills the second count.
5276 * In the vase of a HV being freed, one ref is removed by
5277 * Perl_hv_kill_backrefs, the other by Perl_sv_kill_backrefs, which it
5282 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5287 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5289 if (SvTYPE(tsv) == SVt_PVHV) {
5290 AV **const avp = Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5294 /* There is no AV in the offical place - try a fixup. */
5295 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5298 /* Aha. They've got it stowed in magic. Bring it back. */
5299 av = MUTABLE_AV(mg->mg_obj);
5300 /* Stop mg_free decreasing the refernce count. */
5302 /* Stop mg_free even calling the destructor, given that
5303 there's no AV to free up. */
5305 sv_unmagic(tsv, PERL_MAGIC_backref);
5309 SvREFCNT_inc_simple_void(av); /* see discussion above */
5314 const MAGIC *const mg
5315 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5317 av = MUTABLE_AV(mg->mg_obj);
5321 sv_magic(tsv, MUTABLE_SV(av), PERL_MAGIC_backref, NULL, 0);
5322 /* av now has a refcnt of 2; see discussion above */
5325 if (AvFILLp(av) >= AvMAX(av)) {
5326 av_extend(av, AvFILLp(av)+1);
5328 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5331 /* delete a back-reference to ourselves from the backref magic associated
5332 * with the SV we point to.
5336 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5343 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5345 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5346 av = *Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5347 /* We mustn't attempt to "fix up" the hash here by moving the
5348 backreference array back to the hv_aux structure, as that is stored
5349 in the main HvARRAY(), and hfreentries assumes that no-one
5350 reallocates HvARRAY() while it is running. */
5353 const MAGIC *const mg
5354 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5356 av = MUTABLE_AV(mg->mg_obj);
5360 Perl_croak(aTHX_ "panic: del_backref");
5362 assert(!SvIS_FREED(av));
5365 /* We shouldn't be in here more than once, but for paranoia reasons lets
5367 for (i = AvFILLp(av); i >= 0; i--) {
5369 const SSize_t fill = AvFILLp(av);
5371 /* We weren't the last entry.
5372 An unordered list has this property that you can take the
5373 last element off the end to fill the hole, and it's still
5374 an unordered list :-)
5379 AvFILLp(av) = fill - 1;
5385 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5387 SV **svp = AvARRAY(av);
5389 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5390 PERL_UNUSED_ARG(sv);
5392 assert(!svp || !SvIS_FREED(av));
5394 SV *const *const last = svp + AvFILLp(av);
5396 while (svp <= last) {
5398 SV *const referrer = *svp;
5399 if (SvWEAKREF(referrer)) {
5400 /* XXX Should we check that it hasn't changed? */
5401 SvRV_set(referrer, 0);
5403 SvWEAKREF_off(referrer);
5404 SvSETMAGIC(referrer);
5405 } else if (SvTYPE(referrer) == SVt_PVGV ||
5406 SvTYPE(referrer) == SVt_PVLV) {
5407 /* You lookin' at me? */
5408 assert(GvSTASH(referrer));
5409 assert(GvSTASH(referrer) == (const HV *)sv);
5410 GvSTASH(referrer) = 0;
5413 "panic: magic_killbackrefs (flags=%"UVxf")",
5414 (UV)SvFLAGS(referrer));
5422 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5427 =for apidoc sv_insert
5429 Inserts a string at the specified offset/length within the SV. Similar to
5430 the Perl substr() function. Handles get magic.
5432 =for apidoc sv_insert_flags
5434 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5440 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5445 register char *midend;
5446 register char *bigend;
5450 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5453 Perl_croak(aTHX_ "Can't modify non-existent substring");
5454 SvPV_force_flags(bigstr, curlen, flags);
5455 (void)SvPOK_only_UTF8(bigstr);
5456 if (offset + len > curlen) {
5457 SvGROW(bigstr, offset+len+1);
5458 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5459 SvCUR_set(bigstr, offset+len);
5463 i = littlelen - len;
5464 if (i > 0) { /* string might grow */
5465 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5466 mid = big + offset + len;
5467 midend = bigend = big + SvCUR(bigstr);
5470 while (midend > mid) /* shove everything down */
5471 *--bigend = *--midend;
5472 Move(little,big+offset,littlelen,char);
5473 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5478 Move(little,SvPVX(bigstr)+offset,len,char);
5483 big = SvPVX(bigstr);
5486 bigend = big + SvCUR(bigstr);
5488 if (midend > bigend)
5489 Perl_croak(aTHX_ "panic: sv_insert");
5491 if (mid - big > bigend - midend) { /* faster to shorten from end */
5493 Move(little, mid, littlelen,char);
5496 i = bigend - midend;
5498 Move(midend, mid, i,char);
5502 SvCUR_set(bigstr, mid - big);
5504 else if ((i = mid - big)) { /* faster from front */
5505 midend -= littlelen;
5507 Move(big, midend - i, i, char);
5508 sv_chop(bigstr,midend-i);
5510 Move(little, mid, littlelen,char);
5512 else if (littlelen) {
5513 midend -= littlelen;
5514 sv_chop(bigstr,midend);
5515 Move(little,midend,littlelen,char);
5518 sv_chop(bigstr,midend);
5524 =for apidoc sv_replace
5526 Make the first argument a copy of the second, then delete the original.
5527 The target SV physically takes over ownership of the body of the source SV
5528 and inherits its flags; however, the target keeps any magic it owns,
5529 and any magic in the source is discarded.
5530 Note that this is a rather specialist SV copying operation; most of the
5531 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5537 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5540 const U32 refcnt = SvREFCNT(sv);
5542 PERL_ARGS_ASSERT_SV_REPLACE;
5544 SV_CHECK_THINKFIRST_COW_DROP(sv);
5545 if (SvREFCNT(nsv) != 1) {
5546 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5547 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5549 if (SvMAGICAL(sv)) {
5553 sv_upgrade(nsv, SVt_PVMG);
5554 SvMAGIC_set(nsv, SvMAGIC(sv));
5555 SvFLAGS(nsv) |= SvMAGICAL(sv);
5557 SvMAGIC_set(sv, NULL);
5561 assert(!SvREFCNT(sv));
5562 #ifdef DEBUG_LEAKING_SCALARS
5563 sv->sv_flags = nsv->sv_flags;
5564 sv->sv_any = nsv->sv_any;
5565 sv->sv_refcnt = nsv->sv_refcnt;
5566 sv->sv_u = nsv->sv_u;
5568 StructCopy(nsv,sv,SV);
5570 if(SvTYPE(sv) == SVt_IV) {
5572 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5576 #ifdef PERL_OLD_COPY_ON_WRITE
5577 if (SvIsCOW_normal(nsv)) {
5578 /* We need to follow the pointers around the loop to make the
5579 previous SV point to sv, rather than nsv. */
5582 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5585 assert(SvPVX_const(current) == SvPVX_const(nsv));
5587 /* Make the SV before us point to the SV after us. */
5589 PerlIO_printf(Perl_debug_log, "previous is\n");
5591 PerlIO_printf(Perl_debug_log,
5592 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5593 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5595 SV_COW_NEXT_SV_SET(current, sv);
5598 SvREFCNT(sv) = refcnt;
5599 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5605 =for apidoc sv_clear
5607 Clear an SV: call any destructors, free up any memory used by the body,
5608 and free the body itself. The SV's head is I<not> freed, although
5609 its type is set to all 1's so that it won't inadvertently be assumed
5610 to be live during global destruction etc.
5611 This function should only be called when REFCNT is zero. Most of the time
5612 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5619 Perl_sv_clear(pTHX_ register SV *const sv)
5622 const U32 type = SvTYPE(sv);
5623 const struct body_details *const sv_type_details
5624 = bodies_by_type + type;
5627 PERL_ARGS_ASSERT_SV_CLEAR;
5628 assert(SvREFCNT(sv) == 0);
5629 assert(SvTYPE(sv) != SVTYPEMASK);
5631 if (type <= SVt_IV) {
5632 /* See the comment in sv.h about the collusion between this early
5633 return and the overloading of the NULL and IV slots in the size
5636 SV * const target = SvRV(sv);
5638 sv_del_backref(target, sv);
5640 SvREFCNT_dec(target);
5642 SvFLAGS(sv) &= SVf_BREAK;
5643 SvFLAGS(sv) |= SVTYPEMASK;
5648 if (PL_defstash && /* Still have a symbol table? */
5655 stash = SvSTASH(sv);
5656 destructor = StashHANDLER(stash,DESTROY);
5658 /* A constant subroutine can have no side effects, so
5659 don't bother calling it. */
5660 && !CvCONST(destructor)
5661 /* Don't bother calling an empty destructor */
5662 && (CvISXSUB(destructor)
5663 || CvSTART(destructor)->op_next->op_type != OP_LEAVESUB))
5665 SV* const tmpref = newRV(sv);
5666 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5668 PUSHSTACKi(PERLSI_DESTROY);
5673 call_sv(MUTABLE_SV(destructor), G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5679 if(SvREFCNT(tmpref) < 2) {
5680 /* tmpref is not kept alive! */
5682 SvRV_set(tmpref, NULL);
5685 SvREFCNT_dec(tmpref);
5687 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5691 if (PL_in_clean_objs)
5692 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5694 /* DESTROY gave object new lease on life */
5700 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5701 SvOBJECT_off(sv); /* Curse the object. */
5702 if (type != SVt_PVIO)
5703 --PL_sv_objcount; /* XXX Might want something more general */
5706 if (type >= SVt_PVMG) {
5707 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5708 SvREFCNT_dec(SvOURSTASH(sv));
5709 } else if (SvMAGIC(sv))
5711 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5712 SvREFCNT_dec(SvSTASH(sv));
5715 /* case SVt_BIND: */
5718 IoIFP(sv) != PerlIO_stdin() &&
5719 IoIFP(sv) != PerlIO_stdout() &&
5720 IoIFP(sv) != PerlIO_stderr())
5722 io_close(MUTABLE_IO(sv), FALSE);
5724 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5725 PerlDir_close(IoDIRP(sv));
5726 IoDIRP(sv) = (DIR*)NULL;
5727 Safefree(IoTOP_NAME(sv));
5728 Safefree(IoFMT_NAME(sv));
5729 Safefree(IoBOTTOM_NAME(sv));
5732 /* FIXME for plugins */
5733 pregfree2((REGEXP*) sv);
5737 cv_undef(MUTABLE_CV(sv));
5740 if (PL_last_swash_hv == (const HV *)sv) {
5741 PL_last_swash_hv = NULL;
5743 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5744 hv_undef(MUTABLE_HV(sv));
5747 if (PL_comppad == MUTABLE_AV(sv)) {
5751 av_undef(MUTABLE_AV(sv));
5754 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5755 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5756 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5757 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5759 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5760 SvREFCNT_dec(LvTARG(sv));
5762 if (isGV_with_GP(sv)) {
5763 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
5764 && HvNAME_get(stash))
5765 mro_method_changed_in(stash);
5766 gp_free(MUTABLE_GV(sv));
5768 unshare_hek(GvNAME_HEK(sv));
5769 /* If we're in a stash, we don't own a reference to it. However it does
5770 have a back reference to us, which needs to be cleared. */
5771 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5772 sv_del_backref(MUTABLE_SV(stash), sv);
5774 /* FIXME. There are probably more unreferenced pointers to SVs in the
5775 interpreter struct that we should check and tidy in a similar
5777 if ((const GV *)sv == PL_last_in_gv)
5778 PL_last_in_gv = NULL;
5784 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5787 SvOOK_offset(sv, offset);
5788 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5789 /* Don't even bother with turning off the OOK flag. */
5792 SV * const target = SvRV(sv);
5794 sv_del_backref(target, sv);
5796 SvREFCNT_dec(target);
5798 #ifdef PERL_OLD_COPY_ON_WRITE
5799 else if (SvPVX_const(sv)) {
5802 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5806 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5808 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5812 } else if (SvLEN(sv)) {
5813 Safefree(SvPVX_const(sv));
5817 else if (SvPVX_const(sv) && SvLEN(sv))
5818 Safefree(SvPVX_mutable(sv));
5819 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5820 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5829 SvFLAGS(sv) &= SVf_BREAK;
5830 SvFLAGS(sv) |= SVTYPEMASK;
5832 if (sv_type_details->arena) {
5833 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5834 &PL_body_roots[type]);
5836 else if (sv_type_details->body_size) {
5837 my_safefree(SvANY(sv));
5842 =for apidoc sv_newref
5844 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5851 Perl_sv_newref(pTHX_ SV *const sv)
5853 PERL_UNUSED_CONTEXT;
5862 Decrement an SV's reference count, and if it drops to zero, call
5863 C<sv_clear> to invoke destructors and free up any memory used by
5864 the body; finally, deallocate the SV's head itself.
5865 Normally called via a wrapper macro C<SvREFCNT_dec>.
5871 Perl_sv_free(pTHX_ SV *const sv)
5876 if (SvREFCNT(sv) == 0) {
5877 if (SvFLAGS(sv) & SVf_BREAK)
5878 /* this SV's refcnt has been artificially decremented to
5879 * trigger cleanup */
5881 if (PL_in_clean_all) /* All is fair */
5883 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5884 /* make sure SvREFCNT(sv)==0 happens very seldom */
5885 SvREFCNT(sv) = (~(U32)0)/2;
5888 if (ckWARN_d(WARN_INTERNAL)) {
5889 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5890 Perl_dump_sv_child(aTHX_ sv);
5892 #ifdef DEBUG_LEAKING_SCALARS
5895 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5896 if (PL_warnhook == PERL_WARNHOOK_FATAL
5897 || ckDEAD(packWARN(WARN_INTERNAL))) {
5898 /* Don't let Perl_warner cause us to escape our fate: */
5902 /* This may not return: */
5903 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5904 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5905 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5908 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5913 if (--(SvREFCNT(sv)) > 0)
5915 Perl_sv_free2(aTHX_ sv);
5919 Perl_sv_free2(pTHX_ SV *const sv)
5923 PERL_ARGS_ASSERT_SV_FREE2;
5927 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
5928 "Attempt to free temp prematurely: SV 0x%"UVxf
5929 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5933 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5934 /* make sure SvREFCNT(sv)==0 happens very seldom */
5935 SvREFCNT(sv) = (~(U32)0)/2;
5946 Returns the length of the string in the SV. Handles magic and type
5947 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5953 Perl_sv_len(pTHX_ register SV *const sv)
5961 len = mg_length(sv);
5963 (void)SvPV_const(sv, len);
5968 =for apidoc sv_len_utf8
5970 Returns the number of characters in the string in an SV, counting wide
5971 UTF-8 bytes as a single character. Handles magic and type coercion.
5977 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
5978 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5979 * (Note that the mg_len is not the length of the mg_ptr field.
5980 * This allows the cache to store the character length of the string without
5981 * needing to malloc() extra storage to attach to the mg_ptr.)
5986 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5992 return mg_length(sv);
5996 const U8 *s = (U8*)SvPV_const(sv, len);
6000 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6002 if (mg && mg->mg_len != -1) {
6004 if (PL_utf8cache < 0) {
6005 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6007 /* Need to turn the assertions off otherwise we may
6008 recurse infinitely while printing error messages.
6010 SAVEI8(PL_utf8cache);
6012 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
6013 " real %"UVuf" for %"SVf,
6014 (UV) ulen, (UV) real, SVfARG(sv));
6019 ulen = Perl_utf8_length(aTHX_ s, s + len);
6020 if (!SvREADONLY(sv)) {
6022 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
6023 &PL_vtbl_utf8, 0, 0);
6031 return Perl_utf8_length(aTHX_ s, s + len);
6035 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6038 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6041 const U8 *s = start;
6043 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6045 while (s < send && uoffset--)
6048 /* This is the existing behaviour. Possibly it should be a croak, as
6049 it's actually a bounds error */
6055 /* Given the length of the string in both bytes and UTF-8 characters, decide
6056 whether to walk forwards or backwards to find the byte corresponding to
6057 the passed in UTF-8 offset. */
6059 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6060 const STRLEN uoffset, const STRLEN uend)
6062 STRLEN backw = uend - uoffset;
6064 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6066 if (uoffset < 2 * backw) {
6067 /* The assumption is that going forwards is twice the speed of going
6068 forward (that's where the 2 * backw comes from).
6069 (The real figure of course depends on the UTF-8 data.) */
6070 return sv_pos_u2b_forwards(start, send, uoffset);
6075 while (UTF8_IS_CONTINUATION(*send))
6078 return send - start;
6081 /* For the string representation of the given scalar, find the byte
6082 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6083 give another position in the string, *before* the sought offset, which
6084 (which is always true, as 0, 0 is a valid pair of positions), which should
6085 help reduce the amount of linear searching.
6086 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6087 will be used to reduce the amount of linear searching. The cache will be
6088 created if necessary, and the found value offered to it for update. */
6090 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6091 const U8 *const send, const STRLEN uoffset,
6092 STRLEN uoffset0, STRLEN boffset0)
6094 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6097 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6099 assert (uoffset >= uoffset0);
6101 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6102 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6103 if ((*mgp)->mg_ptr) {
6104 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6105 if (cache[0] == uoffset) {
6106 /* An exact match. */
6109 if (cache[2] == uoffset) {
6110 /* An exact match. */
6114 if (cache[0] < uoffset) {
6115 /* The cache already knows part of the way. */
6116 if (cache[0] > uoffset0) {
6117 /* The cache knows more than the passed in pair */
6118 uoffset0 = cache[0];
6119 boffset0 = cache[1];
6121 if ((*mgp)->mg_len != -1) {
6122 /* And we know the end too. */
6124 + sv_pos_u2b_midway(start + boffset0, send,
6126 (*mgp)->mg_len - uoffset0);
6129 + sv_pos_u2b_forwards(start + boffset0,
6130 send, uoffset - uoffset0);
6133 else if (cache[2] < uoffset) {
6134 /* We're between the two cache entries. */
6135 if (cache[2] > uoffset0) {
6136 /* and the cache knows more than the passed in pair */
6137 uoffset0 = cache[2];
6138 boffset0 = cache[3];
6142 + sv_pos_u2b_midway(start + boffset0,
6145 cache[0] - uoffset0);
6148 + sv_pos_u2b_midway(start + boffset0,
6151 cache[2] - uoffset0);
6155 else if ((*mgp)->mg_len != -1) {
6156 /* If we can take advantage of a passed in offset, do so. */
6157 /* In fact, offset0 is either 0, or less than offset, so don't
6158 need to worry about the other possibility. */
6160 + sv_pos_u2b_midway(start + boffset0, send,
6162 (*mgp)->mg_len - uoffset0);
6167 if (!found || PL_utf8cache < 0) {
6168 const STRLEN real_boffset
6169 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6170 send, uoffset - uoffset0);
6172 if (found && PL_utf8cache < 0) {
6173 if (real_boffset != boffset) {
6174 /* Need to turn the assertions off otherwise we may recurse
6175 infinitely while printing error messages. */
6176 SAVEI8(PL_utf8cache);
6178 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
6179 " real %"UVuf" for %"SVf,
6180 (UV) boffset, (UV) real_boffset, SVfARG(sv));
6183 boffset = real_boffset;
6187 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6193 =for apidoc sv_pos_u2b
6195 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6196 the start of the string, to a count of the equivalent number of bytes; if
6197 lenp is non-zero, it does the same to lenp, but this time starting from
6198 the offset, rather than from the start of the string. Handles magic and
6205 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6206 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6207 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6212 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6217 PERL_ARGS_ASSERT_SV_POS_U2B;
6222 start = (U8*)SvPV_const(sv, len);
6224 STRLEN uoffset = (STRLEN) *offsetp;
6225 const U8 * const send = start + len;
6227 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
6230 *offsetp = (I32) boffset;
6233 /* Convert the relative offset to absolute. */
6234 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
6235 const STRLEN boffset2
6236 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6237 uoffset, boffset) - boffset;
6251 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6252 byte length pairing. The (byte) length of the total SV is passed in too,
6253 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6254 may not have updated SvCUR, so we can't rely on reading it directly.
6256 The proffered utf8/byte length pairing isn't used if the cache already has
6257 two pairs, and swapping either for the proffered pair would increase the
6258 RMS of the intervals between known byte offsets.
6260 The cache itself consists of 4 STRLEN values
6261 0: larger UTF-8 offset
6262 1: corresponding byte offset
6263 2: smaller UTF-8 offset
6264 3: corresponding byte offset
6266 Unused cache pairs have the value 0, 0.
6267 Keeping the cache "backwards" means that the invariant of
6268 cache[0] >= cache[2] is maintained even with empty slots, which means that
6269 the code that uses it doesn't need to worry if only 1 entry has actually
6270 been set to non-zero. It also makes the "position beyond the end of the
6271 cache" logic much simpler, as the first slot is always the one to start
6275 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6276 const STRLEN utf8, const STRLEN blen)
6280 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6286 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6288 (*mgp)->mg_len = -1;
6292 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6293 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6294 (*mgp)->mg_ptr = (char *) cache;
6298 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6299 /* SvPOKp() because it's possible that sv has string overloading, and
6300 therefore is a reference, hence SvPVX() is actually a pointer.
6301 This cures the (very real) symptoms of RT 69422, but I'm not actually
6302 sure whether we should even be caching the results of UTF-8
6303 operations on overloading, given that nothing stops overloading
6304 returning a different value every time it's called. */
6305 const U8 *start = (const U8 *) SvPVX_const(sv);
6306 const STRLEN realutf8 = utf8_length(start, start + byte);
6308 if (realutf8 != utf8) {
6309 /* Need to turn the assertions off otherwise we may recurse
6310 infinitely while printing error messages. */
6311 SAVEI8(PL_utf8cache);
6313 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6314 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6318 /* Cache is held with the later position first, to simplify the code
6319 that deals with unbounded ends. */
6321 ASSERT_UTF8_CACHE(cache);
6322 if (cache[1] == 0) {
6323 /* Cache is totally empty */
6326 } else if (cache[3] == 0) {
6327 if (byte > cache[1]) {
6328 /* New one is larger, so goes first. */
6329 cache[2] = cache[0];
6330 cache[3] = cache[1];
6338 #define THREEWAY_SQUARE(a,b,c,d) \
6339 ((float)((d) - (c))) * ((float)((d) - (c))) \
6340 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6341 + ((float)((b) - (a))) * ((float)((b) - (a)))
6343 /* Cache has 2 slots in use, and we know three potential pairs.
6344 Keep the two that give the lowest RMS distance. Do the
6345 calcualation in bytes simply because we always know the byte
6346 length. squareroot has the same ordering as the positive value,
6347 so don't bother with the actual square root. */
6348 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6349 if (byte > cache[1]) {
6350 /* New position is after the existing pair of pairs. */
6351 const float keep_earlier
6352 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6353 const float keep_later
6354 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6356 if (keep_later < keep_earlier) {
6357 if (keep_later < existing) {
6358 cache[2] = cache[0];
6359 cache[3] = cache[1];
6365 if (keep_earlier < existing) {
6371 else if (byte > cache[3]) {
6372 /* New position is between the existing pair of pairs. */
6373 const float keep_earlier
6374 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6375 const float keep_later
6376 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6378 if (keep_later < keep_earlier) {
6379 if (keep_later < existing) {
6385 if (keep_earlier < existing) {
6392 /* New position is before the existing pair of pairs. */
6393 const float keep_earlier
6394 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6395 const float keep_later
6396 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6398 if (keep_later < keep_earlier) {
6399 if (keep_later < existing) {
6405 if (keep_earlier < existing) {
6406 cache[0] = cache[2];
6407 cache[1] = cache[3];
6414 ASSERT_UTF8_CACHE(cache);
6417 /* We already know all of the way, now we may be able to walk back. The same
6418 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6419 backward is half the speed of walking forward. */
6421 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6422 const U8 *end, STRLEN endu)
6424 const STRLEN forw = target - s;
6425 STRLEN backw = end - target;
6427 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6429 if (forw < 2 * backw) {
6430 return utf8_length(s, target);
6433 while (end > target) {
6435 while (UTF8_IS_CONTINUATION(*end)) {
6444 =for apidoc sv_pos_b2u
6446 Converts the value pointed to by offsetp from a count of bytes from the
6447 start of the string, to a count of the equivalent number of UTF-8 chars.
6448 Handles magic and type coercion.
6454 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6455 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6460 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6463 const STRLEN byte = *offsetp;
6464 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6470 PERL_ARGS_ASSERT_SV_POS_B2U;
6475 s = (const U8*)SvPV_const(sv, blen);
6478 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6482 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6483 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6485 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6486 if (cache[1] == byte) {
6487 /* An exact match. */
6488 *offsetp = cache[0];
6491 if (cache[3] == byte) {
6492 /* An exact match. */
6493 *offsetp = cache[2];
6497 if (cache[1] < byte) {
6498 /* We already know part of the way. */
6499 if (mg->mg_len != -1) {
6500 /* Actually, we know the end too. */
6502 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6503 s + blen, mg->mg_len - cache[0]);
6505 len = cache[0] + utf8_length(s + cache[1], send);
6508 else if (cache[3] < byte) {
6509 /* We're between the two cached pairs, so we do the calculation
6510 offset by the byte/utf-8 positions for the earlier pair,
6511 then add the utf-8 characters from the string start to
6513 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6514 s + cache[1], cache[0] - cache[2])
6518 else { /* cache[3] > byte */
6519 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6523 ASSERT_UTF8_CACHE(cache);
6525 } else if (mg->mg_len != -1) {
6526 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6530 if (!found || PL_utf8cache < 0) {
6531 const STRLEN real_len = utf8_length(s, send);
6533 if (found && PL_utf8cache < 0) {
6534 if (len != real_len) {
6535 /* Need to turn the assertions off otherwise we may recurse
6536 infinitely while printing error messages. */
6537 SAVEI8(PL_utf8cache);
6539 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6540 " real %"UVuf" for %"SVf,
6541 (UV) len, (UV) real_len, SVfARG(sv));
6549 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6555 Returns a boolean indicating whether the strings in the two SVs are
6556 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6557 coerce its args to strings if necessary.
6563 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6572 SV* svrecode = NULL;
6579 /* if pv1 and pv2 are the same, second SvPV_const call may
6580 * invalidate pv1, so we may need to make a copy */
6581 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6582 pv1 = SvPV_const(sv1, cur1);
6583 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6585 pv1 = SvPV_const(sv1, cur1);
6593 pv2 = SvPV_const(sv2, cur2);
6595 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6596 /* Differing utf8ness.
6597 * Do not UTF8size the comparands as a side-effect. */
6600 svrecode = newSVpvn(pv2, cur2);
6601 sv_recode_to_utf8(svrecode, PL_encoding);
6602 pv2 = SvPV_const(svrecode, cur2);
6605 svrecode = newSVpvn(pv1, cur1);
6606 sv_recode_to_utf8(svrecode, PL_encoding);
6607 pv1 = SvPV_const(svrecode, cur1);
6609 /* Now both are in UTF-8. */
6611 SvREFCNT_dec(svrecode);
6616 bool is_utf8 = TRUE;
6619 /* sv1 is the UTF-8 one,
6620 * if is equal it must be downgrade-able */
6621 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6627 /* sv2 is the UTF-8 one,
6628 * if is equal it must be downgrade-able */
6629 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6635 /* Downgrade not possible - cannot be eq */
6643 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6645 SvREFCNT_dec(svrecode);
6655 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6656 string in C<sv1> is less than, equal to, or greater than the string in
6657 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6658 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6664 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6668 const char *pv1, *pv2;
6671 SV *svrecode = NULL;
6678 pv1 = SvPV_const(sv1, cur1);
6685 pv2 = SvPV_const(sv2, cur2);
6687 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6688 /* Differing utf8ness.
6689 * Do not UTF8size the comparands as a side-effect. */
6692 svrecode = newSVpvn(pv2, cur2);
6693 sv_recode_to_utf8(svrecode, PL_encoding);
6694 pv2 = SvPV_const(svrecode, cur2);
6697 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6702 svrecode = newSVpvn(pv1, cur1);
6703 sv_recode_to_utf8(svrecode, PL_encoding);
6704 pv1 = SvPV_const(svrecode, cur1);
6707 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6713 cmp = cur2 ? -1 : 0;
6717 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6720 cmp = retval < 0 ? -1 : 1;
6721 } else if (cur1 == cur2) {
6724 cmp = cur1 < cur2 ? -1 : 1;
6728 SvREFCNT_dec(svrecode);
6736 =for apidoc sv_cmp_locale
6738 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6739 'use bytes' aware, handles get magic, and will coerce its args to strings
6740 if necessary. See also C<sv_cmp>.
6746 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6749 #ifdef USE_LOCALE_COLLATE
6755 if (PL_collation_standard)
6759 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6761 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6763 if (!pv1 || !len1) {
6774 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6777 return retval < 0 ? -1 : 1;
6780 * When the result of collation is equality, that doesn't mean
6781 * that there are no differences -- some locales exclude some
6782 * characters from consideration. So to avoid false equalities,
6783 * we use the raw string as a tiebreaker.
6789 #endif /* USE_LOCALE_COLLATE */
6791 return sv_cmp(sv1, sv2);
6795 #ifdef USE_LOCALE_COLLATE
6798 =for apidoc sv_collxfrm
6800 Add Collate Transform magic to an SV if it doesn't already have it.
6802 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6803 scalar data of the variable, but transformed to such a format that a normal
6804 memory comparison can be used to compare the data according to the locale
6811 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6816 PERL_ARGS_ASSERT_SV_COLLXFRM;
6818 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6819 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6825 Safefree(mg->mg_ptr);
6826 s = SvPV_const(sv, len);
6827 if ((xf = mem_collxfrm(s, len, &xlen))) {
6829 #ifdef PERL_OLD_COPY_ON_WRITE
6831 sv_force_normal_flags(sv, 0);
6833 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6847 if (mg && mg->mg_ptr) {
6849 return mg->mg_ptr + sizeof(PL_collation_ix);
6857 #endif /* USE_LOCALE_COLLATE */
6862 Get a line from the filehandle and store it into the SV, optionally
6863 appending to the currently-stored string.
6869 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6874 register STDCHAR rslast;
6875 register STDCHAR *bp;
6880 PERL_ARGS_ASSERT_SV_GETS;
6882 if (SvTHINKFIRST(sv))
6883 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6884 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6886 However, perlbench says it's slower, because the existing swipe code
6887 is faster than copy on write.
6888 Swings and roundabouts. */
6889 SvUPGRADE(sv, SVt_PV);
6894 if (PerlIO_isutf8(fp)) {
6896 sv_utf8_upgrade_nomg(sv);
6897 sv_pos_u2b(sv,&append,0);
6899 } else if (SvUTF8(sv)) {
6900 SV * const tsv = newSV(0);
6901 sv_gets(tsv, fp, 0);
6902 sv_utf8_upgrade_nomg(tsv);
6903 SvCUR_set(sv,append);
6906 goto return_string_or_null;
6911 if (PerlIO_isutf8(fp))
6914 if (IN_PERL_COMPILETIME) {
6915 /* we always read code in line mode */
6919 else if (RsSNARF(PL_rs)) {
6920 /* If it is a regular disk file use size from stat() as estimate
6921 of amount we are going to read -- may result in mallocing
6922 more memory than we really need if the layers below reduce
6923 the size we read (e.g. CRLF or a gzip layer).
6926 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6927 const Off_t offset = PerlIO_tell(fp);
6928 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6929 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6935 else if (RsRECORD(PL_rs)) {
6943 /* Grab the size of the record we're getting */
6944 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6945 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6948 /* VMS wants read instead of fread, because fread doesn't respect */
6949 /* RMS record boundaries. This is not necessarily a good thing to be */
6950 /* doing, but we've got no other real choice - except avoid stdio
6951 as implementation - perhaps write a :vms layer ?
6953 fd = PerlIO_fileno(fp);
6954 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6955 bytesread = PerlIO_read(fp, buffer, recsize);
6958 bytesread = PerlLIO_read(fd, buffer, recsize);
6961 bytesread = PerlIO_read(fp, buffer, recsize);
6965 SvCUR_set(sv, bytesread + append);
6966 buffer[bytesread] = '\0';
6967 goto return_string_or_null;
6969 else if (RsPARA(PL_rs)) {
6975 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6976 if (PerlIO_isutf8(fp)) {
6977 rsptr = SvPVutf8(PL_rs, rslen);
6980 if (SvUTF8(PL_rs)) {
6981 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6982 Perl_croak(aTHX_ "Wide character in $/");
6985 rsptr = SvPV_const(PL_rs, rslen);
6989 rslast = rslen ? rsptr[rslen - 1] : '\0';
6991 if (rspara) { /* have to do this both before and after */
6992 do { /* to make sure file boundaries work right */
6995 i = PerlIO_getc(fp);
6999 PerlIO_ungetc(fp,i);
7005 /* See if we know enough about I/O mechanism to cheat it ! */
7007 /* This used to be #ifdef test - it is made run-time test for ease
7008 of abstracting out stdio interface. One call should be cheap
7009 enough here - and may even be a macro allowing compile
7013 if (PerlIO_fast_gets(fp)) {
7016 * We're going to steal some values from the stdio struct
7017 * and put EVERYTHING in the innermost loop into registers.
7019 register STDCHAR *ptr;
7023 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7024 /* An ungetc()d char is handled separately from the regular
7025 * buffer, so we getc() it back out and stuff it in the buffer.
7027 i = PerlIO_getc(fp);
7028 if (i == EOF) return 0;
7029 *(--((*fp)->_ptr)) = (unsigned char) i;
7033 /* Here is some breathtakingly efficient cheating */
7035 cnt = PerlIO_get_cnt(fp); /* get count into register */
7036 /* make sure we have the room */
7037 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7038 /* Not room for all of it
7039 if we are looking for a separator and room for some
7041 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7042 /* just process what we have room for */
7043 shortbuffered = cnt - SvLEN(sv) + append + 1;
7044 cnt -= shortbuffered;
7048 /* remember that cnt can be negative */
7049 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7054 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7055 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7056 DEBUG_P(PerlIO_printf(Perl_debug_log,
7057 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7058 DEBUG_P(PerlIO_printf(Perl_debug_log,
7059 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7060 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7061 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7066 while (cnt > 0) { /* this | eat */
7068 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7069 goto thats_all_folks; /* screams | sed :-) */
7073 Copy(ptr, bp, cnt, char); /* this | eat */
7074 bp += cnt; /* screams | dust */
7075 ptr += cnt; /* louder | sed :-) */
7080 if (shortbuffered) { /* oh well, must extend */
7081 cnt = shortbuffered;
7083 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7085 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7086 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7090 DEBUG_P(PerlIO_printf(Perl_debug_log,
7091 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7092 PTR2UV(ptr),(long)cnt));
7093 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7095 DEBUG_P(PerlIO_printf(Perl_debug_log,
7096 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7097 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7098 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7100 /* This used to call 'filbuf' in stdio form, but as that behaves like
7101 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7102 another abstraction. */
7103 i = PerlIO_getc(fp); /* get more characters */
7105 DEBUG_P(PerlIO_printf(Perl_debug_log,
7106 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7107 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7108 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7110 cnt = PerlIO_get_cnt(fp);
7111 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7112 DEBUG_P(PerlIO_printf(Perl_debug_log,
7113 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7115 if (i == EOF) /* all done for ever? */
7116 goto thats_really_all_folks;
7118 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7120 SvGROW(sv, bpx + cnt + 2);
7121 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7123 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7125 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7126 goto thats_all_folks;
7130 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7131 memNE((char*)bp - rslen, rsptr, rslen))
7132 goto screamer; /* go back to the fray */
7133 thats_really_all_folks:
7135 cnt += shortbuffered;
7136 DEBUG_P(PerlIO_printf(Perl_debug_log,
7137 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7138 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7139 DEBUG_P(PerlIO_printf(Perl_debug_log,
7140 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7141 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7142 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7144 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7145 DEBUG_P(PerlIO_printf(Perl_debug_log,
7146 "Screamer: done, len=%ld, string=|%.*s|\n",
7147 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7151 /*The big, slow, and stupid way. */
7152 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7153 STDCHAR *buf = NULL;
7154 Newx(buf, 8192, STDCHAR);
7162 register const STDCHAR * const bpe = buf + sizeof(buf);
7164 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7165 ; /* keep reading */
7169 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7170 /* Accomodate broken VAXC compiler, which applies U8 cast to
7171 * both args of ?: operator, causing EOF to change into 255
7174 i = (U8)buf[cnt - 1];
7180 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7182 sv_catpvn(sv, (char *) buf, cnt);
7184 sv_setpvn(sv, (char *) buf, cnt);
7186 if (i != EOF && /* joy */
7188 SvCUR(sv) < rslen ||
7189 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7193 * If we're reading from a TTY and we get a short read,
7194 * indicating that the user hit his EOF character, we need
7195 * to notice it now, because if we try to read from the TTY
7196 * again, the EOF condition will disappear.
7198 * The comparison of cnt to sizeof(buf) is an optimization
7199 * that prevents unnecessary calls to feof().
7203 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7207 #ifdef USE_HEAP_INSTEAD_OF_STACK
7212 if (rspara) { /* have to do this both before and after */
7213 while (i != EOF) { /* to make sure file boundaries work right */
7214 i = PerlIO_getc(fp);
7216 PerlIO_ungetc(fp,i);
7222 return_string_or_null:
7223 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7229 Auto-increment of the value in the SV, doing string to numeric conversion
7230 if necessary. Handles 'get' magic.
7236 Perl_sv_inc(pTHX_ register SV *const sv)
7245 if (SvTHINKFIRST(sv)) {
7247 sv_force_normal_flags(sv, 0);
7248 if (SvREADONLY(sv)) {
7249 if (IN_PERL_RUNTIME)
7250 Perl_croak(aTHX_ "%s", PL_no_modify);
7254 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7256 i = PTR2IV(SvRV(sv));
7261 flags = SvFLAGS(sv);
7262 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7263 /* It's (privately or publicly) a float, but not tested as an
7264 integer, so test it to see. */
7266 flags = SvFLAGS(sv);
7268 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7269 /* It's publicly an integer, or privately an integer-not-float */
7270 #ifdef PERL_PRESERVE_IVUV
7274 if (SvUVX(sv) == UV_MAX)
7275 sv_setnv(sv, UV_MAX_P1);
7277 (void)SvIOK_only_UV(sv);
7278 SvUV_set(sv, SvUVX(sv) + 1);
7280 if (SvIVX(sv) == IV_MAX)
7281 sv_setuv(sv, (UV)IV_MAX + 1);
7283 (void)SvIOK_only(sv);
7284 SvIV_set(sv, SvIVX(sv) + 1);
7289 if (flags & SVp_NOK) {
7290 const NV was = SvNVX(sv);
7291 if (NV_OVERFLOWS_INTEGERS_AT &&
7292 was >= NV_OVERFLOWS_INTEGERS_AT) {
7293 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7294 "Lost precision when incrementing %" NVff " by 1",
7297 (void)SvNOK_only(sv);
7298 SvNV_set(sv, was + 1.0);
7302 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7303 if ((flags & SVTYPEMASK) < SVt_PVIV)
7304 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7305 (void)SvIOK_only(sv);
7310 while (isALPHA(*d)) d++;
7311 while (isDIGIT(*d)) d++;
7312 if (d < SvEND(sv)) {
7313 #ifdef PERL_PRESERVE_IVUV
7314 /* Got to punt this as an integer if needs be, but we don't issue
7315 warnings. Probably ought to make the sv_iv_please() that does
7316 the conversion if possible, and silently. */
7317 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7318 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7319 /* Need to try really hard to see if it's an integer.
7320 9.22337203685478e+18 is an integer.
7321 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7322 so $a="9.22337203685478e+18"; $a+0; $a++
7323 needs to be the same as $a="9.22337203685478e+18"; $a++
7330 /* sv_2iv *should* have made this an NV */
7331 if (flags & SVp_NOK) {
7332 (void)SvNOK_only(sv);
7333 SvNV_set(sv, SvNVX(sv) + 1.0);
7336 /* I don't think we can get here. Maybe I should assert this
7337 And if we do get here I suspect that sv_setnv will croak. NWC
7339 #if defined(USE_LONG_DOUBLE)
7340 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",
7341 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7343 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7344 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7347 #endif /* PERL_PRESERVE_IVUV */
7348 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7352 while (d >= SvPVX_const(sv)) {
7360 /* MKS: The original code here died if letters weren't consecutive.
7361 * at least it didn't have to worry about non-C locales. The
7362 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7363 * arranged in order (although not consecutively) and that only
7364 * [A-Za-z] are accepted by isALPHA in the C locale.
7366 if (*d != 'z' && *d != 'Z') {
7367 do { ++*d; } while (!isALPHA(*d));
7370 *(d--) -= 'z' - 'a';
7375 *(d--) -= 'z' - 'a' + 1;
7379 /* oh,oh, the number grew */
7380 SvGROW(sv, SvCUR(sv) + 2);
7381 SvCUR_set(sv, SvCUR(sv) + 1);
7382 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7393 Auto-decrement of the value in the SV, doing string to numeric conversion
7394 if necessary. Handles 'get' magic.
7400 Perl_sv_dec(pTHX_ register SV *const sv)
7408 if (SvTHINKFIRST(sv)) {
7410 sv_force_normal_flags(sv, 0);
7411 if (SvREADONLY(sv)) {
7412 if (IN_PERL_RUNTIME)
7413 Perl_croak(aTHX_ "%s", PL_no_modify);
7417 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7419 i = PTR2IV(SvRV(sv));
7424 /* Unlike sv_inc we don't have to worry about string-never-numbers
7425 and keeping them magic. But we mustn't warn on punting */
7426 flags = SvFLAGS(sv);
7427 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7428 /* It's publicly an integer, or privately an integer-not-float */
7429 #ifdef PERL_PRESERVE_IVUV
7433 if (SvUVX(sv) == 0) {
7434 (void)SvIOK_only(sv);
7438 (void)SvIOK_only_UV(sv);
7439 SvUV_set(sv, SvUVX(sv) - 1);
7442 if (SvIVX(sv) == IV_MIN) {
7443 sv_setnv(sv, (NV)IV_MIN);
7447 (void)SvIOK_only(sv);
7448 SvIV_set(sv, SvIVX(sv) - 1);
7453 if (flags & SVp_NOK) {
7456 const NV was = SvNVX(sv);
7457 if (NV_OVERFLOWS_INTEGERS_AT &&
7458 was <= -NV_OVERFLOWS_INTEGERS_AT) {
7459 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7460 "Lost precision when decrementing %" NVff " by 1",
7463 (void)SvNOK_only(sv);
7464 SvNV_set(sv, was - 1.0);
7468 if (!(flags & SVp_POK)) {
7469 if ((flags & SVTYPEMASK) < SVt_PVIV)
7470 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7472 (void)SvIOK_only(sv);
7475 #ifdef PERL_PRESERVE_IVUV
7477 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7478 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7479 /* Need to try really hard to see if it's an integer.
7480 9.22337203685478e+18 is an integer.
7481 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7482 so $a="9.22337203685478e+18"; $a+0; $a--
7483 needs to be the same as $a="9.22337203685478e+18"; $a--
7490 /* sv_2iv *should* have made this an NV */
7491 if (flags & SVp_NOK) {
7492 (void)SvNOK_only(sv);
7493 SvNV_set(sv, SvNVX(sv) - 1.0);
7496 /* I don't think we can get here. Maybe I should assert this
7497 And if we do get here I suspect that sv_setnv will croak. NWC
7499 #if defined(USE_LONG_DOUBLE)
7500 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",
7501 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7503 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7504 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7508 #endif /* PERL_PRESERVE_IVUV */
7509 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7512 /* this define is used to eliminate a chunk of duplicated but shared logic
7513 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
7514 * used anywhere but here - yves
7516 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
7519 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
7523 =for apidoc sv_mortalcopy
7525 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7526 The new SV is marked as mortal. It will be destroyed "soon", either by an
7527 explicit call to FREETMPS, or by an implicit call at places such as
7528 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7533 /* Make a string that will exist for the duration of the expression
7534 * evaluation. Actually, it may have to last longer than that, but
7535 * hopefully we won't free it until it has been assigned to a
7536 * permanent location. */
7539 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7545 sv_setsv(sv,oldstr);
7546 PUSH_EXTEND_MORTAL__SV_C(sv);
7552 =for apidoc sv_newmortal
7554 Creates a new null SV which is mortal. The reference count of the SV is
7555 set to 1. It will be destroyed "soon", either by an explicit call to
7556 FREETMPS, or by an implicit call at places such as statement boundaries.
7557 See also C<sv_mortalcopy> and C<sv_2mortal>.
7563 Perl_sv_newmortal(pTHX)
7569 SvFLAGS(sv) = SVs_TEMP;
7570 PUSH_EXTEND_MORTAL__SV_C(sv);
7576 =for apidoc newSVpvn_flags
7578 Creates a new SV and copies a string into it. The reference count for the
7579 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7580 string. You are responsible for ensuring that the source string is at least
7581 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7582 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7583 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7584 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7585 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7587 #define newSVpvn_utf8(s, len, u) \
7588 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7594 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7599 /* All the flags we don't support must be zero.
7600 And we're new code so I'm going to assert this from the start. */
7601 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7603 sv_setpvn(sv,s,len);
7605 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
7606 * and do what it does outselves here.
7607 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
7608 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
7609 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
7610 * eleminate quite a few steps than it looks - Yves (explaining patch by gfx)
7613 SvFLAGS(sv) |= flags;
7615 if(flags & SVs_TEMP){
7616 PUSH_EXTEND_MORTAL__SV_C(sv);
7623 =for apidoc sv_2mortal
7625 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7626 by an explicit call to FREETMPS, or by an implicit call at places such as
7627 statement boundaries. SvTEMP() is turned on which means that the SV's
7628 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7629 and C<sv_mortalcopy>.
7635 Perl_sv_2mortal(pTHX_ register SV *const sv)
7640 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7642 PUSH_EXTEND_MORTAL__SV_C(sv);
7650 Creates a new SV and copies a string into it. The reference count for the
7651 SV is set to 1. If C<len> is zero, Perl will compute the length using
7652 strlen(). For efficiency, consider using C<newSVpvn> instead.
7658 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7664 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7669 =for apidoc newSVpvn
7671 Creates a new SV and copies a string into it. The reference count for the
7672 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7673 string. You are responsible for ensuring that the source string is at least
7674 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7680 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7686 sv_setpvn(sv,s,len);
7691 =for apidoc newSVhek
7693 Creates a new SV from the hash key structure. It will generate scalars that
7694 point to the shared string table where possible. Returns a new (undefined)
7695 SV if the hek is NULL.
7701 Perl_newSVhek(pTHX_ const HEK *const hek)
7711 if (HEK_LEN(hek) == HEf_SVKEY) {
7712 return newSVsv(*(SV**)HEK_KEY(hek));
7714 const int flags = HEK_FLAGS(hek);
7715 if (flags & HVhek_WASUTF8) {
7717 Andreas would like keys he put in as utf8 to come back as utf8
7719 STRLEN utf8_len = HEK_LEN(hek);
7720 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7721 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7724 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7726 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7727 /* We don't have a pointer to the hv, so we have to replicate the
7728 flag into every HEK. This hv is using custom a hasing
7729 algorithm. Hence we can't return a shared string scalar, as
7730 that would contain the (wrong) hash value, and might get passed
7731 into an hv routine with a regular hash.
7732 Similarly, a hash that isn't using shared hash keys has to have
7733 the flag in every key so that we know not to try to call
7734 share_hek_kek on it. */
7736 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7741 /* This will be overwhelminly the most common case. */
7743 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7744 more efficient than sharepvn(). */
7748 sv_upgrade(sv, SVt_PV);
7749 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7750 SvCUR_set(sv, HEK_LEN(hek));
7763 =for apidoc newSVpvn_share
7765 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7766 table. If the string does not already exist in the table, it is created
7767 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7768 value is used; otherwise the hash is computed. The string's hash can be later
7769 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7770 that as the string table is used for shared hash keys these strings will have
7771 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7777 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7781 bool is_utf8 = FALSE;
7782 const char *const orig_src = src;
7785 STRLEN tmplen = -len;
7787 /* See the note in hv.c:hv_fetch() --jhi */
7788 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7792 PERL_HASH(hash, src, len);
7794 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
7795 changes here, update it there too. */
7796 sv_upgrade(sv, SVt_PV);
7797 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7805 if (src != orig_src)
7811 #if defined(PERL_IMPLICIT_CONTEXT)
7813 /* pTHX_ magic can't cope with varargs, so this is a no-context
7814 * version of the main function, (which may itself be aliased to us).
7815 * Don't access this version directly.
7819 Perl_newSVpvf_nocontext(const char *const pat, ...)
7825 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7827 va_start(args, pat);
7828 sv = vnewSVpvf(pat, &args);
7835 =for apidoc newSVpvf
7837 Creates a new SV and initializes it with the string formatted like
7844 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7849 PERL_ARGS_ASSERT_NEWSVPVF;
7851 va_start(args, pat);
7852 sv = vnewSVpvf(pat, &args);
7857 /* backend for newSVpvf() and newSVpvf_nocontext() */
7860 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7865 PERL_ARGS_ASSERT_VNEWSVPVF;
7868 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7875 Creates a new SV and copies a floating point value into it.
7876 The reference count for the SV is set to 1.
7882 Perl_newSVnv(pTHX_ const NV n)
7895 Creates a new SV and copies an integer into it. The reference count for the
7902 Perl_newSViv(pTHX_ const IV i)
7915 Creates a new SV and copies an unsigned integer into it.
7916 The reference count for the SV is set to 1.
7922 Perl_newSVuv(pTHX_ const UV u)
7933 =for apidoc newSV_type
7935 Creates a new SV, of the type specified. The reference count for the new SV
7942 Perl_newSV_type(pTHX_ const svtype type)
7947 sv_upgrade(sv, type);
7952 =for apidoc newRV_noinc
7954 Creates an RV wrapper for an SV. The reference count for the original
7955 SV is B<not> incremented.
7961 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7964 register SV *sv = newSV_type(SVt_IV);
7966 PERL_ARGS_ASSERT_NEWRV_NOINC;
7969 SvRV_set(sv, tmpRef);
7974 /* newRV_inc is the official function name to use now.
7975 * newRV_inc is in fact #defined to newRV in sv.h
7979 Perl_newRV(pTHX_ SV *const sv)
7983 PERL_ARGS_ASSERT_NEWRV;
7985 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7991 Creates a new SV which is an exact duplicate of the original SV.
7998 Perl_newSVsv(pTHX_ register SV *const old)
8005 if (SvTYPE(old) == SVTYPEMASK) {
8006 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8010 /* SV_GMAGIC is the default for sv_setv()
8011 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8012 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8013 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8018 =for apidoc sv_reset
8020 Underlying implementation for the C<reset> Perl function.
8021 Note that the perl-level function is vaguely deprecated.
8027 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8030 char todo[PERL_UCHAR_MAX+1];
8032 PERL_ARGS_ASSERT_SV_RESET;
8037 if (!*s) { /* reset ?? searches */
8038 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8040 const U32 count = mg->mg_len / sizeof(PMOP**);
8041 PMOP **pmp = (PMOP**) mg->mg_ptr;
8042 PMOP *const *const end = pmp + count;
8046 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8048 (*pmp)->op_pmflags &= ~PMf_USED;
8056 /* reset variables */
8058 if (!HvARRAY(stash))
8061 Zero(todo, 256, char);
8064 I32 i = (unsigned char)*s;
8068 max = (unsigned char)*s++;
8069 for ( ; i <= max; i++) {
8072 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8074 for (entry = HvARRAY(stash)[i];
8076 entry = HeNEXT(entry))
8081 if (!todo[(U8)*HeKEY(entry)])
8083 gv = MUTABLE_GV(HeVAL(entry));
8086 if (SvTHINKFIRST(sv)) {
8087 if (!SvREADONLY(sv) && SvROK(sv))
8089 /* XXX Is this continue a bug? Why should THINKFIRST
8090 exempt us from resetting arrays and hashes? */
8094 if (SvTYPE(sv) >= SVt_PV) {
8096 if (SvPVX_const(sv) != NULL)
8104 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8106 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8109 # if defined(USE_ENVIRON_ARRAY)
8112 # endif /* USE_ENVIRON_ARRAY */
8123 Using various gambits, try to get an IO from an SV: the IO slot if its a
8124 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8125 named after the PV if we're a string.
8131 Perl_sv_2io(pTHX_ SV *const sv)
8136 PERL_ARGS_ASSERT_SV_2IO;
8138 switch (SvTYPE(sv)) {
8140 io = MUTABLE_IO(sv);
8143 if (isGV_with_GP(sv)) {
8144 gv = MUTABLE_GV(sv);
8147 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8153 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8155 return sv_2io(SvRV(sv));
8156 gv = gv_fetchsv(sv, 0, SVt_PVIO);
8162 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
8171 Using various gambits, try to get a CV from an SV; in addition, try if
8172 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8173 The flags in C<lref> are passed to gv_fetchsv.
8179 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8185 PERL_ARGS_ASSERT_SV_2CV;
8192 switch (SvTYPE(sv)) {
8196 return MUTABLE_CV(sv);
8203 if (isGV_with_GP(sv)) {
8204 gv = MUTABLE_GV(sv);
8213 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8215 tryAMAGICunDEREF(to_cv);
8218 if (SvTYPE(sv) == SVt_PVCV) {
8219 cv = MUTABLE_CV(sv);
8224 else if(isGV_with_GP(sv))
8225 gv = MUTABLE_GV(sv);
8227 Perl_croak(aTHX_ "Not a subroutine reference");
8229 else if (isGV_with_GP(sv)) {
8231 gv = MUTABLE_GV(sv);
8234 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
8240 /* Some flags to gv_fetchsv mean don't really create the GV */
8241 if (!isGV_with_GP(gv)) {
8247 if (lref && !GvCVu(gv)) {
8251 gv_efullname3(tmpsv, gv, NULL);
8252 /* XXX this is probably not what they think they're getting.
8253 * It has the same effect as "sub name;", i.e. just a forward
8255 newSUB(start_subparse(FALSE, 0),
8256 newSVOP(OP_CONST, 0, tmpsv),
8260 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8261 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8270 Returns true if the SV has a true value by Perl's rules.
8271 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8272 instead use an in-line version.
8278 Perl_sv_true(pTHX_ register SV *const sv)
8283 register const XPV* const tXpv = (XPV*)SvANY(sv);
8285 (tXpv->xpv_cur > 1 ||
8286 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8293 return SvIVX(sv) != 0;
8296 return SvNVX(sv) != 0.0;
8298 return sv_2bool(sv);
8304 =for apidoc sv_pvn_force
8306 Get a sensible string out of the SV somehow.
8307 A private implementation of the C<SvPV_force> macro for compilers which
8308 can't cope with complex macro expressions. Always use the macro instead.
8310 =for apidoc sv_pvn_force_flags
8312 Get a sensible string out of the SV somehow.
8313 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8314 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8315 implemented in terms of this function.
8316 You normally want to use the various wrapper macros instead: see
8317 C<SvPV_force> and C<SvPV_force_nomg>
8323 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8327 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8329 if (SvTHINKFIRST(sv) && !SvROK(sv))
8330 sv_force_normal_flags(sv, 0);
8340 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8341 const char * const ref = sv_reftype(sv,0);
8343 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8344 ref, OP_NAME(PL_op));
8346 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8348 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8349 || isGV_with_GP(sv))
8350 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8352 s = sv_2pv_flags(sv, &len, flags);
8356 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8359 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8360 SvGROW(sv, len + 1);
8361 Move(s,SvPVX(sv),len,char);
8363 SvPVX(sv)[len] = '\0';
8366 SvPOK_on(sv); /* validate pointer */
8368 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8369 PTR2UV(sv),SvPVX_const(sv)));
8372 return SvPVX_mutable(sv);
8376 =for apidoc sv_pvbyten_force
8378 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8384 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8386 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8388 sv_pvn_force(sv,lp);
8389 sv_utf8_downgrade(sv,0);
8395 =for apidoc sv_pvutf8n_force
8397 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8403 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8405 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8407 sv_pvn_force(sv,lp);
8408 sv_utf8_upgrade(sv);
8414 =for apidoc sv_reftype
8416 Returns a string describing what the SV is a reference to.
8422 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8424 PERL_ARGS_ASSERT_SV_REFTYPE;
8426 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8427 inside return suggests a const propagation bug in g++. */
8428 if (ob && SvOBJECT(sv)) {
8429 char * const name = HvNAME_get(SvSTASH(sv));
8430 return name ? name : (char *) "__ANON__";
8433 switch (SvTYPE(sv)) {
8448 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8449 /* tied lvalues should appear to be
8450 * scalars for backwards compatitbility */
8451 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8452 ? "SCALAR" : "LVALUE");
8453 case SVt_PVAV: return "ARRAY";
8454 case SVt_PVHV: return "HASH";
8455 case SVt_PVCV: return "CODE";
8456 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8457 ? "GLOB" : "SCALAR");
8458 case SVt_PVFM: return "FORMAT";
8459 case SVt_PVIO: return "IO";
8460 case SVt_BIND: return "BIND";
8461 case SVt_REGEXP: return "REGEXP";
8462 default: return "UNKNOWN";
8468 =for apidoc sv_isobject
8470 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8471 object. If the SV is not an RV, or if the object is not blessed, then this
8478 Perl_sv_isobject(pTHX_ SV *sv)
8494 Returns a boolean indicating whether the SV is blessed into the specified
8495 class. This does not check for subtypes; use C<sv_derived_from> to verify
8496 an inheritance relationship.
8502 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8506 PERL_ARGS_ASSERT_SV_ISA;
8516 hvname = HvNAME_get(SvSTASH(sv));
8520 return strEQ(hvname, name);
8526 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8527 it will be upgraded to one. If C<classname> is non-null then the new SV will
8528 be blessed in the specified package. The new SV is returned and its
8529 reference count is 1.
8535 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8540 PERL_ARGS_ASSERT_NEWSVRV;
8544 SV_CHECK_THINKFIRST_COW_DROP(rv);
8545 (void)SvAMAGIC_off(rv);
8547 if (SvTYPE(rv) >= SVt_PVMG) {
8548 const U32 refcnt = SvREFCNT(rv);
8552 SvREFCNT(rv) = refcnt;
8554 sv_upgrade(rv, SVt_IV);
8555 } else if (SvROK(rv)) {
8556 SvREFCNT_dec(SvRV(rv));
8558 prepare_SV_for_RV(rv);
8566 HV* const stash = gv_stashpv(classname, GV_ADD);
8567 (void)sv_bless(rv, stash);
8573 =for apidoc sv_setref_pv
8575 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8576 argument will be upgraded to an RV. That RV will be modified to point to
8577 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8578 into the SV. The C<classname> argument indicates the package for the
8579 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8580 will have a reference count of 1, and the RV will be returned.
8582 Do not use with other Perl types such as HV, AV, SV, CV, because those
8583 objects will become corrupted by the pointer copy process.
8585 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8591 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8595 PERL_ARGS_ASSERT_SV_SETREF_PV;
8598 sv_setsv(rv, &PL_sv_undef);
8602 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8607 =for apidoc sv_setref_iv
8609 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8610 argument will be upgraded to an RV. That RV will be modified to point to
8611 the new SV. The C<classname> argument indicates the package for the
8612 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8613 will have a reference count of 1, and the RV will be returned.
8619 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8621 PERL_ARGS_ASSERT_SV_SETREF_IV;
8623 sv_setiv(newSVrv(rv,classname), iv);
8628 =for apidoc sv_setref_uv
8630 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8631 argument will be upgraded to an RV. That RV will be modified to point to
8632 the new SV. The C<classname> argument indicates the package for the
8633 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8634 will have a reference count of 1, and the RV will be returned.
8640 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8642 PERL_ARGS_ASSERT_SV_SETREF_UV;
8644 sv_setuv(newSVrv(rv,classname), uv);
8649 =for apidoc sv_setref_nv
8651 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8652 argument will be upgraded to an RV. That RV will be modified to point to
8653 the new SV. The C<classname> argument indicates the package for the
8654 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8655 will have a reference count of 1, and the RV will be returned.
8661 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8663 PERL_ARGS_ASSERT_SV_SETREF_NV;
8665 sv_setnv(newSVrv(rv,classname), nv);
8670 =for apidoc sv_setref_pvn
8672 Copies a string into a new SV, optionally blessing the SV. The length of the
8673 string must be specified with C<n>. The C<rv> argument will be upgraded to
8674 an RV. That RV will be modified to point to the new SV. The C<classname>
8675 argument indicates the package for the blessing. Set C<classname> to
8676 C<NULL> to avoid the blessing. The new SV will have a reference count
8677 of 1, and the RV will be returned.
8679 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8685 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8686 const char *const pv, const STRLEN n)
8688 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8690 sv_setpvn(newSVrv(rv,classname), pv, n);
8695 =for apidoc sv_bless
8697 Blesses an SV into a specified package. The SV must be an RV. The package
8698 must be designated by its stash (see C<gv_stashpv()>). The reference count
8699 of the SV is unaffected.
8705 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8710 PERL_ARGS_ASSERT_SV_BLESS;
8713 Perl_croak(aTHX_ "Can't bless non-reference value");
8715 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8716 if (SvIsCOW(tmpRef))
8717 sv_force_normal_flags(tmpRef, 0);
8718 if (SvREADONLY(tmpRef))
8719 Perl_croak(aTHX_ "%s", PL_no_modify);
8720 if (SvOBJECT(tmpRef)) {
8721 if (SvTYPE(tmpRef) != SVt_PVIO)
8723 SvREFCNT_dec(SvSTASH(tmpRef));
8726 SvOBJECT_on(tmpRef);
8727 if (SvTYPE(tmpRef) != SVt_PVIO)
8729 SvUPGRADE(tmpRef, SVt_PVMG);
8730 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
8735 (void)SvAMAGIC_off(sv);
8737 if(SvSMAGICAL(tmpRef))
8738 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8746 /* Downgrades a PVGV to a PVMG.
8750 S_sv_unglob(pTHX_ SV *const sv)
8755 SV * const temp = sv_newmortal();
8757 PERL_ARGS_ASSERT_SV_UNGLOB;
8759 assert(SvTYPE(sv) == SVt_PVGV);
8761 gv_efullname3(temp, MUTABLE_GV(sv), "*");
8764 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
8765 && HvNAME_get(stash))
8766 mro_method_changed_in(stash);
8767 gp_free(MUTABLE_GV(sv));
8770 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
8774 if (GvNAME_HEK(sv)) {
8775 unshare_hek(GvNAME_HEK(sv));
8777 isGV_with_GP_off(sv);
8779 /* need to keep SvANY(sv) in the right arena */
8780 xpvmg = new_XPVMG();
8781 StructCopy(SvANY(sv), xpvmg, XPVMG);
8782 del_XPVGV(SvANY(sv));
8785 SvFLAGS(sv) &= ~SVTYPEMASK;
8786 SvFLAGS(sv) |= SVt_PVMG;
8788 /* Intentionally not calling any local SET magic, as this isn't so much a
8789 set operation as merely an internal storage change. */
8790 sv_setsv_flags(sv, temp, 0);
8794 =for apidoc sv_unref_flags
8796 Unsets the RV status of the SV, and decrements the reference count of
8797 whatever was being referenced by the RV. This can almost be thought of
8798 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8799 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8800 (otherwise the decrementing is conditional on the reference count being
8801 different from one or the reference being a readonly SV).
8808 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8810 SV* const target = SvRV(ref);
8812 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8814 if (SvWEAKREF(ref)) {
8815 sv_del_backref(target, ref);
8817 SvRV_set(ref, NULL);
8820 SvRV_set(ref, NULL);
8822 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8823 assigned to as BEGIN {$a = \"Foo"} will fail. */
8824 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8825 SvREFCNT_dec(target);
8826 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8827 sv_2mortal(target); /* Schedule for freeing later */
8831 =for apidoc sv_untaint
8833 Untaint an SV. Use C<SvTAINTED_off> instead.
8838 Perl_sv_untaint(pTHX_ SV *const sv)
8840 PERL_ARGS_ASSERT_SV_UNTAINT;
8842 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8843 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8850 =for apidoc sv_tainted
8852 Test an SV for taintedness. Use C<SvTAINTED> instead.
8857 Perl_sv_tainted(pTHX_ SV *const sv)
8859 PERL_ARGS_ASSERT_SV_TAINTED;
8861 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8862 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8863 if (mg && (mg->mg_len & 1) )
8870 =for apidoc sv_setpviv
8872 Copies an integer into the given SV, also updating its string value.
8873 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8879 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8881 char buf[TYPE_CHARS(UV)];
8883 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8885 PERL_ARGS_ASSERT_SV_SETPVIV;
8887 sv_setpvn(sv, ptr, ebuf - ptr);
8891 =for apidoc sv_setpviv_mg
8893 Like C<sv_setpviv>, but also handles 'set' magic.
8899 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8901 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8907 #if defined(PERL_IMPLICIT_CONTEXT)
8909 /* pTHX_ magic can't cope with varargs, so this is a no-context
8910 * version of the main function, (which may itself be aliased to us).
8911 * Don't access this version directly.
8915 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8920 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8922 va_start(args, pat);
8923 sv_vsetpvf(sv, pat, &args);
8927 /* pTHX_ magic can't cope with varargs, so this is a no-context
8928 * version of the main function, (which may itself be aliased to us).
8929 * Don't access this version directly.
8933 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8938 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8940 va_start(args, pat);
8941 sv_vsetpvf_mg(sv, pat, &args);
8947 =for apidoc sv_setpvf
8949 Works like C<sv_catpvf> but copies the text into the SV instead of
8950 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8956 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8960 PERL_ARGS_ASSERT_SV_SETPVF;
8962 va_start(args, pat);
8963 sv_vsetpvf(sv, pat, &args);
8968 =for apidoc sv_vsetpvf
8970 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8971 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8973 Usually used via its frontend C<sv_setpvf>.
8979 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8981 PERL_ARGS_ASSERT_SV_VSETPVF;
8983 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8987 =for apidoc sv_setpvf_mg
8989 Like C<sv_setpvf>, but also handles 'set' magic.
8995 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8999 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9001 va_start(args, pat);
9002 sv_vsetpvf_mg(sv, pat, &args);
9007 =for apidoc sv_vsetpvf_mg
9009 Like C<sv_vsetpvf>, but also handles 'set' magic.
9011 Usually used via its frontend C<sv_setpvf_mg>.
9017 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9019 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9021 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9025 #if defined(PERL_IMPLICIT_CONTEXT)
9027 /* pTHX_ magic can't cope with varargs, so this is a no-context
9028 * version of the main function, (which may itself be aliased to us).
9029 * Don't access this version directly.
9033 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9038 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9040 va_start(args, pat);
9041 sv_vcatpvf(sv, pat, &args);
9045 /* pTHX_ magic can't cope with varargs, so this is a no-context
9046 * version of the main function, (which may itself be aliased to us).
9047 * Don't access this version directly.
9051 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9056 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9058 va_start(args, pat);
9059 sv_vcatpvf_mg(sv, pat, &args);
9065 =for apidoc sv_catpvf
9067 Processes its arguments like C<sprintf> and appends the formatted
9068 output to an SV. If the appended data contains "wide" characters
9069 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9070 and characters >255 formatted with %c), the original SV might get
9071 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9072 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9073 valid UTF-8; if the original SV was bytes, the pattern should be too.
9078 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9082 PERL_ARGS_ASSERT_SV_CATPVF;
9084 va_start(args, pat);
9085 sv_vcatpvf(sv, pat, &args);
9090 =for apidoc sv_vcatpvf
9092 Processes its arguments like C<vsprintf> and appends the formatted output
9093 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9095 Usually used via its frontend C<sv_catpvf>.
9101 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9103 PERL_ARGS_ASSERT_SV_VCATPVF;
9105 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9109 =for apidoc sv_catpvf_mg
9111 Like C<sv_catpvf>, but also handles 'set' magic.
9117 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9121 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9123 va_start(args, pat);
9124 sv_vcatpvf_mg(sv, pat, &args);
9129 =for apidoc sv_vcatpvf_mg
9131 Like C<sv_vcatpvf>, but also handles 'set' magic.
9133 Usually used via its frontend C<sv_catpvf_mg>.
9139 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9141 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9143 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9148 =for apidoc sv_vsetpvfn
9150 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9153 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9159 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9160 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9162 PERL_ARGS_ASSERT_SV_VSETPVFN;
9165 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9169 S_expect_number(pTHX_ char **const pattern)
9174 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9176 switch (**pattern) {
9177 case '1': case '2': case '3':
9178 case '4': case '5': case '6':
9179 case '7': case '8': case '9':
9180 var = *(*pattern)++ - '0';
9181 while (isDIGIT(**pattern)) {
9182 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9184 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
9192 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9194 const int neg = nv < 0;
9197 PERL_ARGS_ASSERT_F0CONVERT;
9205 if (uv & 1 && uv == nv)
9206 uv--; /* Round to even */
9208 const unsigned dig = uv % 10;
9221 =for apidoc sv_vcatpvfn
9223 Processes its arguments like C<vsprintf> and appends the formatted output
9224 to an SV. Uses an array of SVs if the C style variable argument list is
9225 missing (NULL). When running with taint checks enabled, indicates via
9226 C<maybe_tainted> if results are untrustworthy (often due to the use of
9229 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9235 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
9236 vecstr = (U8*)SvPV_const(vecsv,veclen);\
9237 vec_utf8 = DO_UTF8(vecsv);
9239 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9242 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9243 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9251 static const char nullstr[] = "(null)";
9253 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9254 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9256 /* Times 4: a decimal digit takes more than 3 binary digits.
9257 * NV_DIG: mantissa takes than many decimal digits.
9258 * Plus 32: Playing safe. */
9259 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9260 /* large enough for "%#.#f" --chip */
9261 /* what about long double NVs? --jhi */
9263 PERL_ARGS_ASSERT_SV_VCATPVFN;
9264 PERL_UNUSED_ARG(maybe_tainted);
9266 /* no matter what, this is a string now */
9267 (void)SvPV_force(sv, origlen);
9269 /* special-case "", "%s", and "%-p" (SVf - see below) */
9272 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9274 const char * const s = va_arg(*args, char*);
9275 sv_catpv(sv, s ? s : nullstr);
9277 else if (svix < svmax) {
9278 sv_catsv(sv, *svargs);
9282 if (args && patlen == 3 && pat[0] == '%' &&
9283 pat[1] == '-' && pat[2] == 'p') {
9284 argsv = MUTABLE_SV(va_arg(*args, void*));
9285 sv_catsv(sv, argsv);
9289 #ifndef USE_LONG_DOUBLE
9290 /* special-case "%.<number>[gf]" */
9291 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9292 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9293 unsigned digits = 0;
9297 while (*pp >= '0' && *pp <= '9')
9298 digits = 10 * digits + (*pp++ - '0');
9299 if (pp - pat == (int)patlen - 1) {
9307 /* Add check for digits != 0 because it seems that some
9308 gconverts are buggy in this case, and we don't yet have
9309 a Configure test for this. */
9310 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9311 /* 0, point, slack */
9312 Gconvert(nv, (int)digits, 0, ebuf);
9314 if (*ebuf) /* May return an empty string for digits==0 */
9317 } else if (!digits) {
9320 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9321 sv_catpvn(sv, p, l);
9327 #endif /* !USE_LONG_DOUBLE */
9329 if (!args && svix < svmax && DO_UTF8(*svargs))
9332 patend = (char*)pat + patlen;
9333 for (p = (char*)pat; p < patend; p = q) {
9336 bool vectorize = FALSE;
9337 bool vectorarg = FALSE;
9338 bool vec_utf8 = FALSE;
9344 bool has_precis = FALSE;
9346 const I32 osvix = svix;
9347 bool is_utf8 = FALSE; /* is this item utf8? */
9348 #ifdef HAS_LDBL_SPRINTF_BUG
9349 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9350 with sfio - Allen <allens@cpan.org> */
9351 bool fix_ldbl_sprintf_bug = FALSE;
9355 U8 utf8buf[UTF8_MAXBYTES+1];
9356 STRLEN esignlen = 0;
9358 const char *eptr = NULL;
9359 const char *fmtstart;
9362 const U8 *vecstr = NULL;
9369 /* we need a long double target in case HAS_LONG_DOUBLE but
9372 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9380 const char *dotstr = ".";
9381 STRLEN dotstrlen = 1;
9382 I32 efix = 0; /* explicit format parameter index */
9383 I32 ewix = 0; /* explicit width index */
9384 I32 epix = 0; /* explicit precision index */
9385 I32 evix = 0; /* explicit vector index */
9386 bool asterisk = FALSE;
9388 /* echo everything up to the next format specification */
9389 for (q = p; q < patend && *q != '%'; ++q) ;
9391 if (has_utf8 && !pat_utf8)
9392 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9394 sv_catpvn(sv, p, q - p);
9403 We allow format specification elements in this order:
9404 \d+\$ explicit format parameter index
9406 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9407 0 flag (as above): repeated to allow "v02"
9408 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9409 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9411 [%bcdefginopsuxDFOUX] format (mandatory)
9416 As of perl5.9.3, printf format checking is on by default.
9417 Internally, perl uses %p formats to provide an escape to
9418 some extended formatting. This block deals with those
9419 extensions: if it does not match, (char*)q is reset and
9420 the normal format processing code is used.
9422 Currently defined extensions are:
9423 %p include pointer address (standard)
9424 %-p (SVf) include an SV (previously %_)
9425 %-<num>p include an SV with precision <num>
9426 %<num>p reserved for future extensions
9428 Robin Barker 2005-07-14
9430 %1p (VDf) removed. RMB 2007-10-19
9437 n = expect_number(&q);
9444 argsv = MUTABLE_SV(va_arg(*args, void*));
9445 eptr = SvPV_const(argsv, elen);
9451 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
9452 "internal %%<num>p might conflict with future printf extensions");
9458 if ( (width = expect_number(&q)) ) {
9473 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9502 if ( (ewix = expect_number(&q)) )
9511 if ((vectorarg = asterisk)) {
9524 width = expect_number(&q);
9530 vecsv = va_arg(*args, SV*);
9532 vecsv = (evix > 0 && evix <= svmax)
9533 ? svargs[evix-1] : &PL_sv_undef;
9535 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9537 dotstr = SvPV_const(vecsv, dotstrlen);
9538 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9539 bad with tied or overloaded values that return UTF8. */
9542 else if (has_utf8) {
9543 vecsv = sv_mortalcopy(vecsv);
9544 sv_utf8_upgrade(vecsv);
9545 dotstr = SvPV_const(vecsv, dotstrlen);
9552 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9553 vecsv = svargs[efix ? efix-1 : svix++];
9554 vecstr = (U8*)SvPV_const(vecsv,veclen);
9555 vec_utf8 = DO_UTF8(vecsv);
9557 /* if this is a version object, we need to convert
9558 * back into v-string notation and then let the
9559 * vectorize happen normally
9561 if (sv_derived_from(vecsv, "version")) {
9562 char *version = savesvpv(vecsv);
9563 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
9564 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9565 "vector argument not supported with alpha versions");
9568 vecsv = sv_newmortal();
9569 scan_vstring(version, version + veclen, vecsv);
9570 vecstr = (U8*)SvPV_const(vecsv, veclen);
9571 vec_utf8 = DO_UTF8(vecsv);
9583 i = va_arg(*args, int);
9585 i = (ewix ? ewix <= svmax : svix < svmax) ?
9586 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9588 width = (i < 0) ? -i : i;
9598 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9600 /* XXX: todo, support specified precision parameter */
9604 i = va_arg(*args, int);
9606 i = (ewix ? ewix <= svmax : svix < svmax)
9607 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9609 has_precis = !(i < 0);
9614 precis = precis * 10 + (*q++ - '0');
9623 case 'I': /* Ix, I32x, and I64x */
9625 if (q[1] == '6' && q[2] == '4') {
9631 if (q[1] == '3' && q[2] == '2') {
9641 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9652 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9653 if (*(q + 1) == 'l') { /* lld, llf */
9679 if (!vectorize && !args) {
9681 const I32 i = efix-1;
9682 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9684 argsv = (svix >= 0 && svix < svmax)
9685 ? svargs[svix++] : &PL_sv_undef;
9696 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9698 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9700 eptr = (char*)utf8buf;
9701 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9715 eptr = va_arg(*args, char*);
9717 elen = strlen(eptr);
9719 eptr = (char *)nullstr;
9720 elen = sizeof nullstr - 1;
9724 eptr = SvPV_const(argsv, elen);
9725 if (DO_UTF8(argsv)) {
9726 STRLEN old_precis = precis;
9727 if (has_precis && precis < elen) {
9728 STRLEN ulen = sv_len_utf8(argsv);
9729 I32 p = precis > ulen ? ulen : precis;
9730 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9733 if (width) { /* fudge width (can't fudge elen) */
9734 if (has_precis && precis < elen)
9735 width += precis - old_precis;
9737 width += elen - sv_len_utf8(argsv);
9744 if (has_precis && precis < elen)
9751 if (alt || vectorize)
9753 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9774 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9783 esignbuf[esignlen++] = plus;
9787 case 'h': iv = (short)va_arg(*args, int); break;
9788 case 'l': iv = va_arg(*args, long); break;
9789 case 'V': iv = va_arg(*args, IV); break;
9790 default: iv = va_arg(*args, int); break;
9793 iv = va_arg(*args, Quad_t); break;
9800 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9802 case 'h': iv = (short)tiv; break;
9803 case 'l': iv = (long)tiv; break;
9805 default: iv = tiv; break;
9808 iv = (Quad_t)tiv; break;
9814 if ( !vectorize ) /* we already set uv above */
9819 esignbuf[esignlen++] = plus;
9823 esignbuf[esignlen++] = '-';
9867 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9878 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9879 case 'l': uv = va_arg(*args, unsigned long); break;
9880 case 'V': uv = va_arg(*args, UV); break;
9881 default: uv = va_arg(*args, unsigned); break;
9884 uv = va_arg(*args, Uquad_t); break;
9891 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9893 case 'h': uv = (unsigned short)tuv; break;
9894 case 'l': uv = (unsigned long)tuv; break;
9896 default: uv = tuv; break;
9899 uv = (Uquad_t)tuv; break;
9908 char *ptr = ebuf + sizeof ebuf;
9909 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9915 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9921 esignbuf[esignlen++] = '0';
9922 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9930 if (alt && *ptr != '0')
9939 esignbuf[esignlen++] = '0';
9940 esignbuf[esignlen++] = c;
9943 default: /* it had better be ten or less */
9947 } while (uv /= base);
9950 elen = (ebuf + sizeof ebuf) - ptr;
9954 zeros = precis - elen;
9955 else if (precis == 0 && elen == 1 && *eptr == '0'
9956 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9959 /* a precision nullifies the 0 flag. */
9966 /* FLOATING POINT */
9969 c = 'f'; /* maybe %F isn't supported here */
9977 /* This is evil, but floating point is even more evil */
9979 /* for SV-style calling, we can only get NV
9980 for C-style calling, we assume %f is double;
9981 for simplicity we allow any of %Lf, %llf, %qf for long double
9985 #if defined(USE_LONG_DOUBLE)
9989 /* [perl #20339] - we should accept and ignore %lf rather than die */
9993 #if defined(USE_LONG_DOUBLE)
9994 intsize = args ? 0 : 'q';
9998 #if defined(HAS_LONG_DOUBLE)
10007 /* now we need (long double) if intsize == 'q', else (double) */
10009 #if LONG_DOUBLESIZE > DOUBLESIZE
10011 va_arg(*args, long double) :
10012 va_arg(*args, double)
10014 va_arg(*args, double)
10019 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10020 else. frexp() has some unspecified behaviour for those three */
10021 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10023 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10024 will cast our (long double) to (double) */
10025 (void)Perl_frexp(nv, &i);
10026 if (i == PERL_INT_MIN)
10027 Perl_die(aTHX_ "panic: frexp");
10029 need = BIT_DIGITS(i);
10031 need += has_precis ? precis : 6; /* known default */
10036 #ifdef HAS_LDBL_SPRINTF_BUG
10037 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10038 with sfio - Allen <allens@cpan.org> */
10041 # define MY_DBL_MAX DBL_MAX
10042 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10043 # if DOUBLESIZE >= 8
10044 # define MY_DBL_MAX 1.7976931348623157E+308L
10046 # define MY_DBL_MAX 3.40282347E+38L
10050 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10051 # define MY_DBL_MAX_BUG 1L
10053 # define MY_DBL_MAX_BUG MY_DBL_MAX
10057 # define MY_DBL_MIN DBL_MIN
10058 # else /* XXX guessing! -Allen */
10059 # if DOUBLESIZE >= 8
10060 # define MY_DBL_MIN 2.2250738585072014E-308L
10062 # define MY_DBL_MIN 1.17549435E-38L
10066 if ((intsize == 'q') && (c == 'f') &&
10067 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10068 (need < DBL_DIG)) {
10069 /* it's going to be short enough that
10070 * long double precision is not needed */
10072 if ((nv <= 0L) && (nv >= -0L))
10073 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10075 /* would use Perl_fp_class as a double-check but not
10076 * functional on IRIX - see perl.h comments */
10078 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10079 /* It's within the range that a double can represent */
10080 #if defined(DBL_MAX) && !defined(DBL_MIN)
10081 if ((nv >= ((long double)1/DBL_MAX)) ||
10082 (nv <= (-(long double)1/DBL_MAX)))
10084 fix_ldbl_sprintf_bug = TRUE;
10087 if (fix_ldbl_sprintf_bug == TRUE) {
10097 # undef MY_DBL_MAX_BUG
10100 #endif /* HAS_LDBL_SPRINTF_BUG */
10102 need += 20; /* fudge factor */
10103 if (PL_efloatsize < need) {
10104 Safefree(PL_efloatbuf);
10105 PL_efloatsize = need + 20; /* more fudge */
10106 Newx(PL_efloatbuf, PL_efloatsize, char);
10107 PL_efloatbuf[0] = '\0';
10110 if ( !(width || left || plus || alt) && fill != '0'
10111 && has_precis && intsize != 'q' ) { /* Shortcuts */
10112 /* See earlier comment about buggy Gconvert when digits,
10114 if ( c == 'g' && precis) {
10115 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10116 /* May return an empty string for digits==0 */
10117 if (*PL_efloatbuf) {
10118 elen = strlen(PL_efloatbuf);
10119 goto float_converted;
10121 } else if ( c == 'f' && !precis) {
10122 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10127 char *ptr = ebuf + sizeof ebuf;
10130 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10131 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10132 if (intsize == 'q') {
10133 /* Copy the one or more characters in a long double
10134 * format before the 'base' ([efgEFG]) character to
10135 * the format string. */
10136 static char const prifldbl[] = PERL_PRIfldbl;
10137 char const *p = prifldbl + sizeof(prifldbl) - 3;
10138 while (p >= prifldbl) { *--ptr = *p--; }
10143 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10148 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10160 /* No taint. Otherwise we are in the strange situation
10161 * where printf() taints but print($float) doesn't.
10163 #if defined(HAS_LONG_DOUBLE)
10164 elen = ((intsize == 'q')
10165 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10166 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10168 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10172 eptr = PL_efloatbuf;
10180 i = SvCUR(sv) - origlen;
10183 case 'h': *(va_arg(*args, short*)) = i; break;
10184 default: *(va_arg(*args, int*)) = i; break;
10185 case 'l': *(va_arg(*args, long*)) = i; break;
10186 case 'V': *(va_arg(*args, IV*)) = i; break;
10189 *(va_arg(*args, Quad_t*)) = i; break;
10196 sv_setuv_mg(argsv, (UV)i);
10197 continue; /* not "break" */
10204 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
10205 && ckWARN(WARN_PRINTF))
10207 SV * const msg = sv_newmortal();
10208 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10209 (PL_op->op_type == OP_PRTF) ? "" : "s");
10210 if (fmtstart < patend) {
10211 const char * const fmtend = q < patend ? q : patend;
10213 sv_catpvs(msg, "\"%");
10214 for (f = fmtstart; f < fmtend; f++) {
10216 sv_catpvn(msg, f, 1);
10218 Perl_sv_catpvf(aTHX_ msg,
10219 "\\%03"UVof, (UV)*f & 0xFF);
10222 sv_catpvs(msg, "\"");
10224 sv_catpvs(msg, "end of string");
10226 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
10229 /* output mangled stuff ... */
10235 /* ... right here, because formatting flags should not apply */
10236 SvGROW(sv, SvCUR(sv) + elen + 1);
10238 Copy(eptr, p, elen, char);
10241 SvCUR_set(sv, p - SvPVX_const(sv));
10243 continue; /* not "break" */
10246 if (is_utf8 != has_utf8) {
10249 sv_utf8_upgrade(sv);
10252 const STRLEN old_elen = elen;
10253 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
10254 sv_utf8_upgrade(nsv);
10255 eptr = SvPVX_const(nsv);
10258 if (width) { /* fudge width (can't fudge elen) */
10259 width += elen - old_elen;
10265 have = esignlen + zeros + elen;
10267 Perl_croak_nocontext("%s", PL_memory_wrap);
10269 need = (have > width ? have : width);
10272 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10273 Perl_croak_nocontext("%s", PL_memory_wrap);
10274 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10276 if (esignlen && fill == '0') {
10278 for (i = 0; i < (int)esignlen; i++)
10279 *p++ = esignbuf[i];
10281 if (gap && !left) {
10282 memset(p, fill, gap);
10285 if (esignlen && fill != '0') {
10287 for (i = 0; i < (int)esignlen; i++)
10288 *p++ = esignbuf[i];
10292 for (i = zeros; i; i--)
10296 Copy(eptr, p, elen, char);
10300 memset(p, ' ', gap);
10305 Copy(dotstr, p, dotstrlen, char);
10309 vectorize = FALSE; /* done iterating over vecstr */
10316 SvCUR_set(sv, p - SvPVX_const(sv));
10324 /* =========================================================================
10326 =head1 Cloning an interpreter
10328 All the macros and functions in this section are for the private use of
10329 the main function, perl_clone().
10331 The foo_dup() functions make an exact copy of an existing foo thingy.
10332 During the course of a cloning, a hash table is used to map old addresses
10333 to new addresses. The table is created and manipulated with the
10334 ptr_table_* functions.
10338 * =========================================================================*/
10341 #if defined(USE_ITHREADS)
10343 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10344 #ifndef GpREFCNT_inc
10345 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10349 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10350 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10351 If this changes, please unmerge ss_dup.
10352 Likewise, sv_dup_inc_multiple() relies on this fact. */
10353 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10354 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10355 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
10356 #define av_dup_inc(s,t) MUTABLE_AV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10357 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
10358 #define hv_dup_inc(s,t) MUTABLE_HV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10359 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
10360 #define cv_dup_inc(s,t) MUTABLE_CV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10361 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
10362 #define io_dup_inc(s,t) MUTABLE_IO(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10363 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
10364 #define gv_dup_inc(s,t) MUTABLE_GV(SvREFCNT_inc(sv_dup((const SV *)s,t)))
10365 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10366 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10368 /* clone a parser */
10371 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10375 PERL_ARGS_ASSERT_PARSER_DUP;
10380 /* look for it in the table first */
10381 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10385 /* create anew and remember what it is */
10386 Newxz(parser, 1, yy_parser);
10387 ptr_table_store(PL_ptr_table, proto, parser);
10389 parser->yyerrstatus = 0;
10390 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10392 /* XXX these not yet duped */
10393 parser->old_parser = NULL;
10394 parser->stack = NULL;
10396 parser->stack_size = 0;
10397 /* XXX parser->stack->state = 0; */
10399 /* XXX eventually, just Copy() most of the parser struct ? */
10401 parser->lex_brackets = proto->lex_brackets;
10402 parser->lex_casemods = proto->lex_casemods;
10403 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10404 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10405 parser->lex_casestack = savepvn(proto->lex_casestack,
10406 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10407 parser->lex_defer = proto->lex_defer;
10408 parser->lex_dojoin = proto->lex_dojoin;
10409 parser->lex_expect = proto->lex_expect;
10410 parser->lex_formbrack = proto->lex_formbrack;
10411 parser->lex_inpat = proto->lex_inpat;
10412 parser->lex_inwhat = proto->lex_inwhat;
10413 parser->lex_op = proto->lex_op;
10414 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10415 parser->lex_starts = proto->lex_starts;
10416 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10417 parser->multi_close = proto->multi_close;
10418 parser->multi_open = proto->multi_open;
10419 parser->multi_start = proto->multi_start;
10420 parser->multi_end = proto->multi_end;
10421 parser->pending_ident = proto->pending_ident;
10422 parser->preambled = proto->preambled;
10423 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10424 parser->linestr = sv_dup_inc(proto->linestr, param);
10425 parser->expect = proto->expect;
10426 parser->copline = proto->copline;
10427 parser->last_lop_op = proto->last_lop_op;
10428 parser->lex_state = proto->lex_state;
10429 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10430 /* rsfp_filters entries have fake IoDIRP() */
10431 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10432 parser->in_my = proto->in_my;
10433 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10434 parser->error_count = proto->error_count;
10437 parser->linestr = sv_dup_inc(proto->linestr, param);
10440 char * const ols = SvPVX(proto->linestr);
10441 char * const ls = SvPVX(parser->linestr);
10443 parser->bufptr = ls + (proto->bufptr >= ols ?
10444 proto->bufptr - ols : 0);
10445 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10446 proto->oldbufptr - ols : 0);
10447 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10448 proto->oldoldbufptr - ols : 0);
10449 parser->linestart = ls + (proto->linestart >= ols ?
10450 proto->linestart - ols : 0);
10451 parser->last_uni = ls + (proto->last_uni >= ols ?
10452 proto->last_uni - ols : 0);
10453 parser->last_lop = ls + (proto->last_lop >= ols ?
10454 proto->last_lop - ols : 0);
10456 parser->bufend = ls + SvCUR(parser->linestr);
10459 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10463 parser->endwhite = proto->endwhite;
10464 parser->faketokens = proto->faketokens;
10465 parser->lasttoke = proto->lasttoke;
10466 parser->nextwhite = proto->nextwhite;
10467 parser->realtokenstart = proto->realtokenstart;
10468 parser->skipwhite = proto->skipwhite;
10469 parser->thisclose = proto->thisclose;
10470 parser->thismad = proto->thismad;
10471 parser->thisopen = proto->thisopen;
10472 parser->thisstuff = proto->thisstuff;
10473 parser->thistoken = proto->thistoken;
10474 parser->thiswhite = proto->thiswhite;
10476 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10477 parser->curforce = proto->curforce;
10479 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10480 Copy(proto->nexttype, parser->nexttype, 5, I32);
10481 parser->nexttoke = proto->nexttoke;
10484 /* XXX should clone saved_curcop here, but we aren't passed
10485 * proto_perl; so do it in perl_clone_using instead */
10491 /* duplicate a file handle */
10494 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10498 PERL_ARGS_ASSERT_FP_DUP;
10499 PERL_UNUSED_ARG(type);
10502 return (PerlIO*)NULL;
10504 /* look for it in the table first */
10505 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10509 /* create anew and remember what it is */
10510 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10511 ptr_table_store(PL_ptr_table, fp, ret);
10515 /* duplicate a directory handle */
10518 Perl_dirp_dup(pTHX_ DIR *const dp)
10520 PERL_UNUSED_CONTEXT;
10527 /* duplicate a typeglob */
10530 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10534 PERL_ARGS_ASSERT_GP_DUP;
10538 /* look for it in the table first */
10539 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10543 /* create anew and remember what it is */
10545 ptr_table_store(PL_ptr_table, gp, ret);
10548 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
10549 on Newxz() to do this for us. */
10550 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10551 ret->gp_io = io_dup_inc(gp->gp_io, param);
10552 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10553 ret->gp_av = av_dup_inc(gp->gp_av, param);
10554 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10555 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10556 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10557 ret->gp_cvgen = gp->gp_cvgen;
10558 ret->gp_line = gp->gp_line;
10559 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10563 /* duplicate a chain of magic */
10566 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10568 MAGIC *mgret = NULL;
10569 MAGIC **mgprev_p = &mgret;
10571 PERL_ARGS_ASSERT_MG_DUP;
10573 for (; mg; mg = mg->mg_moremagic) {
10575 Newx(nmg, 1, MAGIC);
10577 mgprev_p = &(nmg->mg_moremagic);
10579 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
10580 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
10581 from the original commit adding Perl_mg_dup() - revision 4538.
10582 Similarly there is the annotation "XXX random ptr?" next to the
10583 assignment to nmg->mg_ptr. */
10586 /* FIXME for plugins
10587 if (nmg->mg_type == PERL_MAGIC_qr) {
10588 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
10592 if(nmg->mg_type == PERL_MAGIC_backref) {
10593 /* The backref AV has its reference count deliberately bumped by
10596 = SvREFCNT_inc(av_dup_inc((const AV *) nmg->mg_obj, param));
10599 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
10600 ? sv_dup_inc(nmg->mg_obj, param)
10601 : sv_dup(nmg->mg_obj, param);
10604 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
10605 if (nmg->mg_len > 0) {
10606 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
10607 if (nmg->mg_type == PERL_MAGIC_overload_table &&
10608 AMT_AMAGIC((AMT*)nmg->mg_ptr))
10610 AMT * const namtp = (AMT*)nmg->mg_ptr;
10611 sv_dup_inc_multiple((SV**)(namtp->table),
10612 (SV**)(namtp->table), NofAMmeth, param);
10615 else if (nmg->mg_len == HEf_SVKEY)
10616 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
10618 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
10619 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10625 #endif /* USE_ITHREADS */
10627 /* create a new pointer-mapping table */
10630 Perl_ptr_table_new(pTHX)
10633 PERL_UNUSED_CONTEXT;
10635 Newx(tbl, 1, PTR_TBL_t);
10636 tbl->tbl_max = 511;
10637 tbl->tbl_items = 0;
10638 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10642 #define PTR_TABLE_HASH(ptr) \
10643 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10646 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10647 following define) and at call to new_body_inline made below in
10648 Perl_ptr_table_store()
10651 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10653 /* map an existing pointer using a table */
10655 STATIC PTR_TBL_ENT_t *
10656 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10658 PTR_TBL_ENT_t *tblent;
10659 const UV hash = PTR_TABLE_HASH(sv);
10661 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10663 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10664 for (; tblent; tblent = tblent->next) {
10665 if (tblent->oldval == sv)
10672 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10674 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10676 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10677 PERL_UNUSED_CONTEXT;
10679 return tblent ? tblent->newval : NULL;
10682 /* add a new entry to a pointer-mapping table */
10685 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10687 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10689 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10690 PERL_UNUSED_CONTEXT;
10693 tblent->newval = newsv;
10695 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10697 new_body_inline(tblent, PTE_SVSLOT);
10699 tblent->oldval = oldsv;
10700 tblent->newval = newsv;
10701 tblent->next = tbl->tbl_ary[entry];
10702 tbl->tbl_ary[entry] = tblent;
10704 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10705 ptr_table_split(tbl);
10709 /* double the hash bucket size of an existing ptr table */
10712 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10714 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10715 const UV oldsize = tbl->tbl_max + 1;
10716 UV newsize = oldsize * 2;
10719 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10720 PERL_UNUSED_CONTEXT;
10722 Renew(ary, newsize, PTR_TBL_ENT_t*);
10723 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10724 tbl->tbl_max = --newsize;
10725 tbl->tbl_ary = ary;
10726 for (i=0; i < oldsize; i++, ary++) {
10727 PTR_TBL_ENT_t **curentp, **entp, *ent;
10730 curentp = ary + oldsize;
10731 for (entp = ary, ent = *ary; ent; ent = *entp) {
10732 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10734 ent->next = *curentp;
10744 /* remove all the entries from a ptr table */
10747 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10749 if (tbl && tbl->tbl_items) {
10750 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10751 UV riter = tbl->tbl_max;
10754 PTR_TBL_ENT_t *entry = array[riter];
10757 PTR_TBL_ENT_t * const oentry = entry;
10758 entry = entry->next;
10763 tbl->tbl_items = 0;
10767 /* clear and free a ptr table */
10770 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10775 ptr_table_clear(tbl);
10776 Safefree(tbl->tbl_ary);
10780 #if defined(USE_ITHREADS)
10783 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10785 PERL_ARGS_ASSERT_RVPV_DUP;
10788 SvRV_set(dstr, SvWEAKREF(sstr)
10789 ? sv_dup(SvRV_const(sstr), param)
10790 : sv_dup_inc(SvRV_const(sstr), param));
10793 else if (SvPVX_const(sstr)) {
10794 /* Has something there */
10796 /* Normal PV - clone whole allocated space */
10797 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10798 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10799 /* Not that normal - actually sstr is copy on write.
10800 But we are a true, independant SV, so: */
10801 SvREADONLY_off(dstr);
10806 /* Special case - not normally malloced for some reason */
10807 if (isGV_with_GP(sstr)) {
10808 /* Don't need to do anything here. */
10810 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10811 /* A "shared" PV - clone it as "shared" PV */
10813 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10817 /* Some other special case - random pointer */
10818 SvPV_set(dstr, (char *) SvPVX_const(sstr));
10823 /* Copy the NULL */
10824 SvPV_set(dstr, NULL);
10828 /* duplicate a list of SVs. source and dest may point to the same memory. */
10830 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
10831 SSize_t items, CLONE_PARAMS *const param)
10833 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
10835 while (items-- > 0) {
10836 *dest++ = sv_dup_inc(*source++, param);
10842 /* duplicate an SV of any type (including AV, HV etc) */
10845 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10850 PERL_ARGS_ASSERT_SV_DUP;
10854 if (SvTYPE(sstr) == SVTYPEMASK) {
10855 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10860 /* look for it in the table first */
10861 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
10865 if(param->flags & CLONEf_JOIN_IN) {
10866 /** We are joining here so we don't want do clone
10867 something that is bad **/
10868 if (SvTYPE(sstr) == SVt_PVHV) {
10869 const HEK * const hvname = HvNAME_HEK(sstr);
10871 /** don't clone stashes if they already exist **/
10872 return MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
10876 /* create anew and remember what it is */
10879 #ifdef DEBUG_LEAKING_SCALARS
10880 dstr->sv_debug_optype = sstr->sv_debug_optype;
10881 dstr->sv_debug_line = sstr->sv_debug_line;
10882 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10883 dstr->sv_debug_cloned = 1;
10884 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10887 ptr_table_store(PL_ptr_table, sstr, dstr);
10890 SvFLAGS(dstr) = SvFLAGS(sstr);
10891 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10892 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10895 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10896 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10897 (void*)PL_watch_pvx, SvPVX_const(sstr));
10900 /* don't clone objects whose class has asked us not to */
10901 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10906 switch (SvTYPE(sstr)) {
10908 SvANY(dstr) = NULL;
10911 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10913 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10915 SvIV_set(dstr, SvIVX(sstr));
10919 SvANY(dstr) = new_XNV();
10920 SvNV_set(dstr, SvNVX(sstr));
10922 /* case SVt_BIND: */
10925 /* These are all the types that need complex bodies allocating. */
10927 const svtype sv_type = SvTYPE(sstr);
10928 const struct body_details *const sv_type_details
10929 = bodies_by_type + sv_type;
10933 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10948 assert(sv_type_details->body_size);
10949 if (sv_type_details->arena) {
10950 new_body_inline(new_body, sv_type);
10952 = (void*)((char*)new_body - sv_type_details->offset);
10954 new_body = new_NOARENA(sv_type_details);
10958 SvANY(dstr) = new_body;
10961 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10962 ((char*)SvANY(dstr)) + sv_type_details->offset,
10963 sv_type_details->copy, char);
10965 Copy(((char*)SvANY(sstr)),
10966 ((char*)SvANY(dstr)),
10967 sv_type_details->body_size + sv_type_details->offset, char);
10970 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10971 && !isGV_with_GP(dstr))
10972 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10974 /* The Copy above means that all the source (unduplicated) pointers
10975 are now in the destination. We can check the flags and the
10976 pointers in either, but it's possible that there's less cache
10977 missing by always going for the destination.
10978 FIXME - instrument and check that assumption */
10979 if (sv_type >= SVt_PVMG) {
10980 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10981 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10982 } else if (SvMAGIC(dstr))
10983 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10985 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10988 /* The cast silences a GCC warning about unhandled types. */
10989 switch ((int)sv_type) {
10999 /* FIXME for plugins */
11000 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11003 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11004 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11005 LvTARG(dstr) = dstr;
11006 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11007 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11009 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11011 if(isGV_with_GP(sstr)) {
11012 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11013 /* Don't call sv_add_backref here as it's going to be
11014 created as part of the magic cloning of the symbol
11016 /* Danger Will Robinson - GvGP(dstr) isn't initialised
11017 at the point of this comment. */
11018 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11019 GvGP(dstr) = gp_dup(GvGP(sstr), param);
11020 (void)GpREFCNT_inc(GvGP(dstr));
11022 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11025 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
11026 if (IoOFP(dstr) == IoIFP(sstr))
11027 IoOFP(dstr) = IoIFP(dstr);
11029 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11030 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11031 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11032 /* I have no idea why fake dirp (rsfps)
11033 should be treated differently but otherwise
11034 we end up with leaks -- sky*/
11035 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
11036 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
11037 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11039 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
11040 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
11041 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
11042 if (IoDIRP(dstr)) {
11043 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
11046 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
11049 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
11050 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
11051 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
11054 /* avoid cloning an empty array */
11055 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11056 SV **dst_ary, **src_ary;
11057 SSize_t items = AvFILLp((const AV *)sstr) + 1;
11059 src_ary = AvARRAY((const AV *)sstr);
11060 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
11061 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11062 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
11063 AvALLOC((const AV *)dstr) = dst_ary;
11064 if (AvREAL((const AV *)sstr)) {
11065 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
11069 while (items-- > 0)
11070 *dst_ary++ = sv_dup(*src_ary++, param);
11072 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
11073 while (items-- > 0) {
11074 *dst_ary++ = &PL_sv_undef;
11078 AvARRAY(MUTABLE_AV(dstr)) = NULL;
11079 AvALLOC((const AV *)dstr) = (SV**)NULL;
11080 AvMAX( (const AV *)dstr) = -1;
11081 AvFILLp((const AV *)dstr) = -1;
11085 if (HvARRAY((const HV *)sstr)) {
11087 const bool sharekeys = !!HvSHAREKEYS(sstr);
11088 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11089 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11091 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11092 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
11094 HvARRAY(dstr) = (HE**)darray;
11095 while (i <= sxhv->xhv_max) {
11096 const HE * const source = HvARRAY(sstr)[i];
11097 HvARRAY(dstr)[i] = source
11098 ? he_dup(source, sharekeys, param) : 0;
11103 const struct xpvhv_aux * const saux = HvAUX(sstr);
11104 struct xpvhv_aux * const daux = HvAUX(dstr);
11105 /* This flag isn't copied. */
11106 /* SvOOK_on(hv) attacks the IV flags. */
11107 SvFLAGS(dstr) |= SVf_OOK;
11109 hvname = saux->xhv_name;
11110 daux->xhv_name = hek_dup(hvname, param);
11112 daux->xhv_riter = saux->xhv_riter;
11113 daux->xhv_eiter = saux->xhv_eiter
11114 ? he_dup(saux->xhv_eiter,
11115 (bool)!!HvSHAREKEYS(sstr), param) : 0;
11116 /* backref array needs refcnt=2; see sv_add_backref */
11117 daux->xhv_backreferences =
11118 saux->xhv_backreferences
11119 ? MUTABLE_AV(SvREFCNT_inc(
11120 sv_dup_inc((const SV *)saux->xhv_backreferences, param)))
11123 daux->xhv_mro_meta = saux->xhv_mro_meta
11124 ? mro_meta_dup(saux->xhv_mro_meta, param)
11127 /* Record stashes for possible cloning in Perl_clone(). */
11129 av_push(param->stashes, dstr);
11133 HvARRAY(MUTABLE_HV(dstr)) = NULL;
11136 if (!(param->flags & CLONEf_COPY_STACKS)) {
11140 /* NOTE: not refcounted */
11141 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
11143 if (!CvISXSUB(dstr))
11144 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
11146 if (CvCONST(dstr) && CvISXSUB(dstr)) {
11147 CvXSUBANY(dstr).any_ptr =
11148 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
11150 /* don't dup if copying back - CvGV isn't refcounted, so the
11151 * duped GV may never be freed. A bit of a hack! DAPM */
11152 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11153 NULL : gv_dup(CvGV(dstr), param) ;
11154 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11156 CvWEAKOUTSIDE(sstr)
11157 ? cv_dup( CvOUTSIDE(dstr), param)
11158 : cv_dup_inc(CvOUTSIDE(dstr), param);
11159 if (!CvISXSUB(dstr))
11160 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
11166 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11172 /* duplicate a context */
11175 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11177 PERL_CONTEXT *ncxs;
11179 PERL_ARGS_ASSERT_CX_DUP;
11182 return (PERL_CONTEXT*)NULL;
11184 /* look for it in the table first */
11185 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11189 /* create anew and remember what it is */
11190 Newx(ncxs, max + 1, PERL_CONTEXT);
11191 ptr_table_store(PL_ptr_table, cxs, ncxs);
11192 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
11195 PERL_CONTEXT * const ncx = &ncxs[ix];
11196 if (CxTYPE(ncx) == CXt_SUBST) {
11197 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11200 switch (CxTYPE(ncx)) {
11202 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
11203 ? cv_dup_inc(ncx->blk_sub.cv, param)
11204 : cv_dup(ncx->blk_sub.cv,param));
11205 ncx->blk_sub.argarray = (CxHASARGS(ncx)
11206 ? av_dup_inc(ncx->blk_sub.argarray,
11209 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
11211 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
11212 ncx->blk_sub.oldcomppad);
11215 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
11217 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
11219 case CXt_LOOP_LAZYSV:
11220 ncx->blk_loop.state_u.lazysv.end
11221 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
11222 /* We are taking advantage of av_dup_inc and sv_dup_inc
11223 actually being the same function, and order equivalance of
11225 We can assert the later [but only at run time :-(] */
11226 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
11227 (void *) &ncx->blk_loop.state_u.lazysv.cur);
11229 ncx->blk_loop.state_u.ary.ary
11230 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
11231 case CXt_LOOP_LAZYIV:
11232 case CXt_LOOP_PLAIN:
11233 if (CxPADLOOP(ncx)) {
11234 ncx->blk_loop.oldcomppad
11235 = (PAD*)ptr_table_fetch(PL_ptr_table,
11236 ncx->blk_loop.oldcomppad);
11238 ncx->blk_loop.oldcomppad
11239 = (PAD*)gv_dup((const GV *)ncx->blk_loop.oldcomppad,
11244 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
11245 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
11246 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
11259 /* duplicate a stack info structure */
11262 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11266 PERL_ARGS_ASSERT_SI_DUP;
11269 return (PERL_SI*)NULL;
11271 /* look for it in the table first */
11272 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11276 /* create anew and remember what it is */
11277 Newxz(nsi, 1, PERL_SI);
11278 ptr_table_store(PL_ptr_table, si, nsi);
11280 nsi->si_stack = av_dup_inc(si->si_stack, param);
11281 nsi->si_cxix = si->si_cxix;
11282 nsi->si_cxmax = si->si_cxmax;
11283 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11284 nsi->si_type = si->si_type;
11285 nsi->si_prev = si_dup(si->si_prev, param);
11286 nsi->si_next = si_dup(si->si_next, param);
11287 nsi->si_markoff = si->si_markoff;
11292 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11293 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11294 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11295 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11296 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11297 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11298 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11299 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11300 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11301 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11302 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11303 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11304 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11305 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11308 #define pv_dup_inc(p) SAVEPV(p)
11309 #define pv_dup(p) SAVEPV(p)
11310 #define svp_dup_inc(p,pp) any_dup(p,pp)
11312 /* map any object to the new equivent - either something in the
11313 * ptr table, or something in the interpreter structure
11317 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
11321 PERL_ARGS_ASSERT_ANY_DUP;
11324 return (void*)NULL;
11326 /* look for it in the table first */
11327 ret = ptr_table_fetch(PL_ptr_table, v);
11331 /* see if it is part of the interpreter structure */
11332 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11333 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11341 /* duplicate the save stack */
11344 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11347 ANY * const ss = proto_perl->Isavestack;
11348 const I32 max = proto_perl->Isavestack_max;
11349 I32 ix = proto_perl->Isavestack_ix;
11362 void (*dptr) (void*);
11363 void (*dxptr) (pTHX_ void*);
11365 PERL_ARGS_ASSERT_SS_DUP;
11367 Newxz(nss, max, ANY);
11370 const I32 type = POPINT(ss,ix);
11371 TOPINT(nss,ix) = type;
11373 case SAVEt_HELEM: /* hash element */
11374 sv = (const SV *)POPPTR(ss,ix);
11375 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11377 case SAVEt_ITEM: /* normal string */
11378 case SAVEt_SV: /* scalar reference */
11379 sv = (const SV *)POPPTR(ss,ix);
11380 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11383 case SAVEt_MORTALIZESV:
11384 sv = (const SV *)POPPTR(ss,ix);
11385 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11387 case SAVEt_SHARED_PVREF: /* char* in shared space */
11388 c = (char*)POPPTR(ss,ix);
11389 TOPPTR(nss,ix) = savesharedpv(c);
11390 ptr = POPPTR(ss,ix);
11391 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11393 case SAVEt_GENERIC_SVREF: /* generic sv */
11394 case SAVEt_SVREF: /* scalar reference */
11395 sv = (const SV *)POPPTR(ss,ix);
11396 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11397 ptr = POPPTR(ss,ix);
11398 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11400 case SAVEt_HV: /* hash reference */
11401 case SAVEt_AV: /* array reference */
11402 sv = (const SV *) POPPTR(ss,ix);
11403 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11405 case SAVEt_COMPPAD:
11407 sv = (const SV *) POPPTR(ss,ix);
11408 TOPPTR(nss,ix) = sv_dup(sv, param);
11410 case SAVEt_INT: /* int reference */
11411 ptr = POPPTR(ss,ix);
11412 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11413 intval = (int)POPINT(ss,ix);
11414 TOPINT(nss,ix) = intval;
11416 case SAVEt_LONG: /* long reference */
11417 ptr = POPPTR(ss,ix);
11418 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11420 case SAVEt_CLEARSV:
11421 longval = (long)POPLONG(ss,ix);
11422 TOPLONG(nss,ix) = longval;
11424 case SAVEt_I32: /* I32 reference */
11425 case SAVEt_I16: /* I16 reference */
11426 case SAVEt_I8: /* I8 reference */
11427 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11428 ptr = POPPTR(ss,ix);
11429 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11431 TOPINT(nss,ix) = i;
11433 case SAVEt_IV: /* IV reference */
11434 ptr = POPPTR(ss,ix);
11435 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11437 TOPIV(nss,ix) = iv;
11439 case SAVEt_HPTR: /* HV* reference */
11440 case SAVEt_APTR: /* AV* reference */
11441 case SAVEt_SPTR: /* SV* reference */
11442 ptr = POPPTR(ss,ix);
11443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11444 sv = (const SV *)POPPTR(ss,ix);
11445 TOPPTR(nss,ix) = sv_dup(sv, param);
11447 case SAVEt_VPTR: /* random* reference */
11448 ptr = POPPTR(ss,ix);
11449 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11450 ptr = POPPTR(ss,ix);
11451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11453 case SAVEt_GENERIC_PVREF: /* generic char* */
11454 case SAVEt_PPTR: /* char* reference */
11455 ptr = POPPTR(ss,ix);
11456 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11457 c = (char*)POPPTR(ss,ix);
11458 TOPPTR(nss,ix) = pv_dup(c);
11460 case SAVEt_GP: /* scalar reference */
11461 gp = (GP*)POPPTR(ss,ix);
11462 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11463 (void)GpREFCNT_inc(gp);
11464 gv = (const GV *)POPPTR(ss,ix);
11465 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11468 ptr = POPPTR(ss,ix);
11469 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11470 /* these are assumed to be refcounted properly */
11472 switch (((OP*)ptr)->op_type) {
11474 case OP_LEAVESUBLV:
11478 case OP_LEAVEWRITE:
11479 TOPPTR(nss,ix) = ptr;
11482 (void) OpREFCNT_inc(o);
11486 TOPPTR(nss,ix) = NULL;
11491 TOPPTR(nss,ix) = NULL;
11494 hv = (const HV *)POPPTR(ss,ix);
11495 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11497 TOPINT(nss,ix) = i;
11500 c = (char*)POPPTR(ss,ix);
11501 TOPPTR(nss,ix) = pv_dup_inc(c);
11503 case SAVEt_STACK_POS: /* Position on Perl stack */
11505 TOPINT(nss,ix) = i;
11507 case SAVEt_DESTRUCTOR:
11508 ptr = POPPTR(ss,ix);
11509 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11510 dptr = POPDPTR(ss,ix);
11511 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11512 any_dup(FPTR2DPTR(void *, dptr),
11515 case SAVEt_DESTRUCTOR_X:
11516 ptr = POPPTR(ss,ix);
11517 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11518 dxptr = POPDXPTR(ss,ix);
11519 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11520 any_dup(FPTR2DPTR(void *, dxptr),
11523 case SAVEt_REGCONTEXT:
11526 TOPINT(nss,ix) = i;
11529 case SAVEt_AELEM: /* array element */
11530 sv = (const SV *)POPPTR(ss,ix);
11531 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11533 TOPINT(nss,ix) = i;
11534 av = (const AV *)POPPTR(ss,ix);
11535 TOPPTR(nss,ix) = av_dup_inc(av, param);
11538 ptr = POPPTR(ss,ix);
11539 TOPPTR(nss,ix) = ptr;
11542 ptr = POPPTR(ss,ix);
11545 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11546 HINTS_REFCNT_UNLOCK;
11548 TOPPTR(nss,ix) = ptr;
11550 TOPINT(nss,ix) = i;
11551 if (i & HINT_LOCALIZE_HH) {
11552 hv = (const HV *)POPPTR(ss,ix);
11553 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11556 case SAVEt_PADSV_AND_MORTALIZE:
11557 longval = (long)POPLONG(ss,ix);
11558 TOPLONG(nss,ix) = longval;
11559 ptr = POPPTR(ss,ix);
11560 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11561 sv = (const SV *)POPPTR(ss,ix);
11562 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11565 ptr = POPPTR(ss,ix);
11566 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11567 longval = (long)POPBOOL(ss,ix);
11568 TOPBOOL(nss,ix) = (bool)longval;
11570 case SAVEt_SET_SVFLAGS:
11572 TOPINT(nss,ix) = i;
11574 TOPINT(nss,ix) = i;
11575 sv = (const SV *)POPPTR(ss,ix);
11576 TOPPTR(nss,ix) = sv_dup(sv, param);
11578 case SAVEt_RE_STATE:
11580 const struct re_save_state *const old_state
11581 = (struct re_save_state *)
11582 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11583 struct re_save_state *const new_state
11584 = (struct re_save_state *)
11585 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11587 Copy(old_state, new_state, 1, struct re_save_state);
11588 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11590 new_state->re_state_bostr
11591 = pv_dup(old_state->re_state_bostr);
11592 new_state->re_state_reginput
11593 = pv_dup(old_state->re_state_reginput);
11594 new_state->re_state_regeol
11595 = pv_dup(old_state->re_state_regeol);
11596 new_state->re_state_regoffs
11597 = (regexp_paren_pair*)
11598 any_dup(old_state->re_state_regoffs, proto_perl);
11599 new_state->re_state_reglastparen
11600 = (U32*) any_dup(old_state->re_state_reglastparen,
11602 new_state->re_state_reglastcloseparen
11603 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11605 /* XXX This just has to be broken. The old save_re_context
11606 code did SAVEGENERICPV(PL_reg_start_tmp);
11607 PL_reg_start_tmp is char **.
11608 Look above to what the dup code does for
11609 SAVEt_GENERIC_PVREF
11610 It can never have worked.
11611 So this is merely a faithful copy of the exiting bug: */
11612 new_state->re_state_reg_start_tmp
11613 = (char **) pv_dup((char *)
11614 old_state->re_state_reg_start_tmp);
11615 /* I assume that it only ever "worked" because no-one called
11616 (pseudo)fork while the regexp engine had re-entered itself.
11618 #ifdef PERL_OLD_COPY_ON_WRITE
11619 new_state->re_state_nrs
11620 = sv_dup(old_state->re_state_nrs, param);
11622 new_state->re_state_reg_magic
11623 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11625 new_state->re_state_reg_oldcurpm
11626 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11628 new_state->re_state_reg_curpm
11629 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11631 new_state->re_state_reg_oldsaved
11632 = pv_dup(old_state->re_state_reg_oldsaved);
11633 new_state->re_state_reg_poscache
11634 = pv_dup(old_state->re_state_reg_poscache);
11635 new_state->re_state_reg_starttry
11636 = pv_dup(old_state->re_state_reg_starttry);
11639 case SAVEt_COMPILE_WARNINGS:
11640 ptr = POPPTR(ss,ix);
11641 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11644 ptr = POPPTR(ss,ix);
11645 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11649 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11657 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11658 * flag to the result. This is done for each stash before cloning starts,
11659 * so we know which stashes want their objects cloned */
11662 do_mark_cloneable_stash(pTHX_ SV *const sv)
11664 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
11666 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
11667 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11668 if (cloner && GvCV(cloner)) {
11675 mXPUSHs(newSVhek(hvname));
11677 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
11684 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11692 =for apidoc perl_clone
11694 Create and return a new interpreter by cloning the current one.
11696 perl_clone takes these flags as parameters:
11698 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11699 without it we only clone the data and zero the stacks,
11700 with it we copy the stacks and the new perl interpreter is
11701 ready to run at the exact same point as the previous one.
11702 The pseudo-fork code uses COPY_STACKS while the
11703 threads->create doesn't.
11705 CLONEf_KEEP_PTR_TABLE
11706 perl_clone keeps a ptr_table with the pointer of the old
11707 variable as a key and the new variable as a value,
11708 this allows it to check if something has been cloned and not
11709 clone it again but rather just use the value and increase the
11710 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11711 the ptr_table using the function
11712 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11713 reason to keep it around is if you want to dup some of your own
11714 variable who are outside the graph perl scans, example of this
11715 code is in threads.xs create
11718 This is a win32 thing, it is ignored on unix, it tells perls
11719 win32host code (which is c++) to clone itself, this is needed on
11720 win32 if you want to run two threads at the same time,
11721 if you just want to do some stuff in a separate perl interpreter
11722 and then throw it away and return to the original one,
11723 you don't need to do anything.
11728 /* XXX the above needs expanding by someone who actually understands it ! */
11729 EXTERN_C PerlInterpreter *
11730 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11733 perl_clone(PerlInterpreter *proto_perl, UV flags)
11736 #ifdef PERL_IMPLICIT_SYS
11738 PERL_ARGS_ASSERT_PERL_CLONE;
11740 /* perlhost.h so we need to call into it
11741 to clone the host, CPerlHost should have a c interface, sky */
11743 if (flags & CLONEf_CLONE_HOST) {
11744 return perl_clone_host(proto_perl,flags);
11746 return perl_clone_using(proto_perl, flags,
11748 proto_perl->IMemShared,
11749 proto_perl->IMemParse,
11751 proto_perl->IStdIO,
11755 proto_perl->IProc);
11759 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11760 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11761 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11762 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11763 struct IPerlDir* ipD, struct IPerlSock* ipS,
11764 struct IPerlProc* ipP)
11766 /* XXX many of the string copies here can be optimized if they're
11767 * constants; they need to be allocated as common memory and just
11768 * their pointers copied. */
11771 CLONE_PARAMS clone_params;
11772 CLONE_PARAMS* const param = &clone_params;
11774 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11776 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11778 /* for each stash, determine whether its objects should be cloned */
11779 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11780 PERL_SET_THX(my_perl);
11783 PoisonNew(my_perl, 1, PerlInterpreter);
11788 PL_scopestack_name = 0;
11790 PL_savestack_ix = 0;
11791 PL_savestack_max = -1;
11792 PL_sig_pending = 0;
11794 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11795 # else /* !DEBUGGING */
11796 Zero(my_perl, 1, PerlInterpreter);
11797 # endif /* DEBUGGING */
11799 /* host pointers */
11801 PL_MemShared = ipMS;
11802 PL_MemParse = ipMP;
11809 #else /* !PERL_IMPLICIT_SYS */
11811 CLONE_PARAMS clone_params;
11812 CLONE_PARAMS* param = &clone_params;
11813 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11815 PERL_ARGS_ASSERT_PERL_CLONE;
11817 /* for each stash, determine whether its objects should be cloned */
11818 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11819 PERL_SET_THX(my_perl);
11822 PoisonNew(my_perl, 1, PerlInterpreter);
11827 PL_scopestack_name = 0;
11829 PL_savestack_ix = 0;
11830 PL_savestack_max = -1;
11831 PL_sig_pending = 0;
11833 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11834 # else /* !DEBUGGING */
11835 Zero(my_perl, 1, PerlInterpreter);
11836 # endif /* DEBUGGING */
11837 #endif /* PERL_IMPLICIT_SYS */
11838 param->flags = flags;
11839 param->proto_perl = proto_perl;
11841 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11843 PL_body_arenas = NULL;
11844 Zero(&PL_body_roots, 1, PL_body_roots);
11846 PL_nice_chunk = NULL;
11847 PL_nice_chunk_size = 0;
11849 PL_sv_objcount = 0;
11851 PL_sv_arenaroot = NULL;
11853 PL_debug = proto_perl->Idebug;
11855 PL_hash_seed = proto_perl->Ihash_seed;
11856 PL_rehash_seed = proto_perl->Irehash_seed;
11858 #ifdef USE_REENTRANT_API
11859 /* XXX: things like -Dm will segfault here in perlio, but doing
11860 * PERL_SET_CONTEXT(proto_perl);
11861 * breaks too many other things
11863 Perl_reentrant_init(aTHX);
11866 /* create SV map for pointer relocation */
11867 PL_ptr_table = ptr_table_new();
11869 /* initialize these special pointers as early as possible */
11870 SvANY(&PL_sv_undef) = NULL;
11871 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11872 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11873 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11875 SvANY(&PL_sv_no) = new_XPVNV();
11876 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11877 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11878 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11879 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11880 SvCUR_set(&PL_sv_no, 0);
11881 SvLEN_set(&PL_sv_no, 1);
11882 SvIV_set(&PL_sv_no, 0);
11883 SvNV_set(&PL_sv_no, 0);
11884 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11886 SvANY(&PL_sv_yes) = new_XPVNV();
11887 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11888 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11889 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11890 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11891 SvCUR_set(&PL_sv_yes, 1);
11892 SvLEN_set(&PL_sv_yes, 2);
11893 SvIV_set(&PL_sv_yes, 1);
11894 SvNV_set(&PL_sv_yes, 1);
11895 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11897 /* create (a non-shared!) shared string table */
11898 PL_strtab = newHV();
11899 HvSHAREKEYS_off(PL_strtab);
11900 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11901 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11903 PL_compiling = proto_perl->Icompiling;
11905 /* These two PVs will be free'd special way so must set them same way op.c does */
11906 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11907 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11909 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11910 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11912 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11913 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11914 if (PL_compiling.cop_hints_hash) {
11916 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11917 HINTS_REFCNT_UNLOCK;
11919 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11920 #ifdef PERL_DEBUG_READONLY_OPS
11925 /* pseudo environmental stuff */
11926 PL_origargc = proto_perl->Iorigargc;
11927 PL_origargv = proto_perl->Iorigargv;
11929 param->stashes = newAV(); /* Setup array of objects to call clone on */
11931 /* Set tainting stuff before PerlIO_debug can possibly get called */
11932 PL_tainting = proto_perl->Itainting;
11933 PL_taint_warn = proto_perl->Itaint_warn;
11935 #ifdef PERLIO_LAYERS
11936 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11937 PerlIO_clone(aTHX_ proto_perl, param);
11940 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11941 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11942 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11943 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11944 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11945 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11948 PL_minus_c = proto_perl->Iminus_c;
11949 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11950 PL_localpatches = proto_perl->Ilocalpatches;
11951 PL_splitstr = proto_perl->Isplitstr;
11952 PL_minus_n = proto_perl->Iminus_n;
11953 PL_minus_p = proto_perl->Iminus_p;
11954 PL_minus_l = proto_perl->Iminus_l;
11955 PL_minus_a = proto_perl->Iminus_a;
11956 PL_minus_E = proto_perl->Iminus_E;
11957 PL_minus_F = proto_perl->Iminus_F;
11958 PL_doswitches = proto_perl->Idoswitches;
11959 PL_dowarn = proto_perl->Idowarn;
11960 PL_doextract = proto_perl->Idoextract;
11961 PL_sawampersand = proto_perl->Isawampersand;
11962 PL_unsafe = proto_perl->Iunsafe;
11963 PL_inplace = SAVEPV(proto_perl->Iinplace);
11964 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11965 PL_perldb = proto_perl->Iperldb;
11966 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11967 PL_exit_flags = proto_perl->Iexit_flags;
11969 /* magical thingies */
11970 /* XXX time(&PL_basetime) when asked for? */
11971 PL_basetime = proto_perl->Ibasetime;
11972 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11974 PL_maxsysfd = proto_perl->Imaxsysfd;
11975 PL_statusvalue = proto_perl->Istatusvalue;
11977 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11979 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11981 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11983 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
11984 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
11985 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
11988 /* RE engine related */
11989 Zero(&PL_reg_state, 1, struct re_save_state);
11990 PL_reginterp_cnt = 0;
11991 PL_regmatch_slab = NULL;
11993 /* Clone the regex array */
11994 /* ORANGE FIXME for plugins, probably in the SV dup code.
11995 newSViv(PTR2IV(CALLREGDUPE(
11996 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11998 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11999 PL_regex_pad = AvARRAY(PL_regex_padav);
12001 /* shortcuts to various I/O objects */
12002 PL_ofsgv = gv_dup(proto_perl->Iofsgv, param);
12003 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
12004 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
12005 PL_defgv = gv_dup(proto_perl->Idefgv, param);
12006 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
12007 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
12008 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
12010 /* shortcuts to regexp stuff */
12011 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
12013 /* shortcuts to misc objects */
12014 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
12016 /* shortcuts to debugging objects */
12017 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
12018 PL_DBline = gv_dup(proto_perl->IDBline, param);
12019 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
12020 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
12021 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
12022 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
12023 PL_dbargs = av_dup(proto_perl->Idbargs, param);
12025 /* symbol tables */
12026 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
12027 PL_curstash = hv_dup(proto_perl->Icurstash, param);
12028 PL_debstash = hv_dup(proto_perl->Idebstash, param);
12029 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
12030 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
12032 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
12033 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
12034 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
12035 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
12036 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
12037 PL_endav = av_dup_inc(proto_perl->Iendav, param);
12038 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
12039 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
12041 PL_sub_generation = proto_perl->Isub_generation;
12042 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
12044 /* funky return mechanisms */
12045 PL_forkprocess = proto_perl->Iforkprocess;
12047 /* subprocess state */
12048 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
12050 /* internal state */
12051 PL_maxo = proto_perl->Imaxo;
12052 if (proto_perl->Iop_mask)
12053 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
12056 /* PL_asserting = proto_perl->Iasserting; */
12058 /* current interpreter roots */
12059 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
12061 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
12063 PL_main_start = proto_perl->Imain_start;
12064 PL_eval_root = proto_perl->Ieval_root;
12065 PL_eval_start = proto_perl->Ieval_start;
12067 /* runtime control stuff */
12068 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
12070 PL_filemode = proto_perl->Ifilemode;
12071 PL_lastfd = proto_perl->Ilastfd;
12072 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
12075 PL_gensym = proto_perl->Igensym;
12076 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
12077 PL_laststatval = proto_perl->Ilaststatval;
12078 PL_laststype = proto_perl->Ilaststype;
12081 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
12083 /* interpreter atexit processing */
12084 PL_exitlistlen = proto_perl->Iexitlistlen;
12085 if (PL_exitlistlen) {
12086 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12087 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12090 PL_exitlist = (PerlExitListEntry*)NULL;
12092 PL_my_cxt_size = proto_perl->Imy_cxt_size;
12093 if (PL_my_cxt_size) {
12094 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
12095 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
12096 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12097 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
12098 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
12102 PL_my_cxt_list = (void**)NULL;
12103 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12104 PL_my_cxt_keys = (const char**)NULL;
12107 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
12108 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
12109 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12111 PL_profiledata = NULL;
12113 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12115 PAD_CLONE_VARS(proto_perl, param);
12117 #ifdef HAVE_INTERP_INTERN
12118 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12121 /* more statics moved here */
12122 PL_generation = proto_perl->Igeneration;
12123 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
12125 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12126 PL_in_clean_all = proto_perl->Iin_clean_all;
12128 PL_uid = proto_perl->Iuid;
12129 PL_euid = proto_perl->Ieuid;
12130 PL_gid = proto_perl->Igid;
12131 PL_egid = proto_perl->Iegid;
12132 PL_nomemok = proto_perl->Inomemok;
12133 PL_an = proto_perl->Ian;
12134 PL_evalseq = proto_perl->Ievalseq;
12135 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12136 PL_origalen = proto_perl->Iorigalen;
12137 #ifdef PERL_USES_PL_PIDSTATUS
12138 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12140 PL_osname = SAVEPV(proto_perl->Iosname);
12141 PL_sighandlerp = proto_perl->Isighandlerp;
12143 PL_runops = proto_perl->Irunops;
12145 PL_parser = parser_dup(proto_perl->Iparser, param);
12147 /* XXX this only works if the saved cop has already been cloned */
12148 if (proto_perl->Iparser) {
12149 PL_parser->saved_curcop = (COP*)any_dup(
12150 proto_perl->Iparser->saved_curcop,
12154 PL_subline = proto_perl->Isubline;
12155 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
12158 PL_cryptseen = proto_perl->Icryptseen;
12161 PL_hints = proto_perl->Ihints;
12163 PL_amagic_generation = proto_perl->Iamagic_generation;
12165 #ifdef USE_LOCALE_COLLATE
12166 PL_collation_ix = proto_perl->Icollation_ix;
12167 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12168 PL_collation_standard = proto_perl->Icollation_standard;
12169 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12170 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12171 #endif /* USE_LOCALE_COLLATE */
12173 #ifdef USE_LOCALE_NUMERIC
12174 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12175 PL_numeric_standard = proto_perl->Inumeric_standard;
12176 PL_numeric_local = proto_perl->Inumeric_local;
12177 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12178 #endif /* !USE_LOCALE_NUMERIC */
12180 /* utf8 character classes */
12181 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12182 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12183 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12184 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12185 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12186 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12187 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12188 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12189 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12190 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12191 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12192 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12193 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12194 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12195 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12196 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12197 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12198 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12199 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12201 /* Did the locale setup indicate UTF-8? */
12202 PL_utf8locale = proto_perl->Iutf8locale;
12203 /* Unicode features (see perlrun/-C) */
12204 PL_unicode = proto_perl->Iunicode;
12206 /* Pre-5.8 signals control */
12207 PL_signals = proto_perl->Isignals;
12209 /* times() ticks per second */
12210 PL_clocktick = proto_perl->Iclocktick;
12212 /* Recursion stopper for PerlIO_find_layer */
12213 PL_in_load_module = proto_perl->Iin_load_module;
12215 /* sort() routine */
12216 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12218 /* Not really needed/useful since the reenrant_retint is "volatile",
12219 * but do it for consistency's sake. */
12220 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12222 /* Hooks to shared SVs and locks. */
12223 PL_sharehook = proto_perl->Isharehook;
12224 PL_lockhook = proto_perl->Ilockhook;
12225 PL_unlockhook = proto_perl->Iunlockhook;
12226 PL_threadhook = proto_perl->Ithreadhook;
12227 PL_destroyhook = proto_perl->Idestroyhook;
12229 #ifdef THREADS_HAVE_PIDS
12230 PL_ppid = proto_perl->Ippid;
12234 PL_last_swash_hv = NULL; /* reinits on demand */
12235 PL_last_swash_klen = 0;
12236 PL_last_swash_key[0]= '\0';
12237 PL_last_swash_tmps = (U8*)NULL;
12238 PL_last_swash_slen = 0;
12240 PL_glob_index = proto_perl->Iglob_index;
12241 PL_srand_called = proto_perl->Isrand_called;
12243 if (proto_perl->Ipsig_pend) {
12244 Newxz(PL_psig_pend, SIG_SIZE, int);
12247 PL_psig_pend = (int*)NULL;
12250 if (proto_perl->Ipsig_name) {
12251 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
12252 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
12254 PL_psig_ptr = PL_psig_name + SIG_SIZE;
12257 PL_psig_ptr = (SV**)NULL;
12258 PL_psig_name = (SV**)NULL;
12261 /* intrpvar.h stuff */
12263 if (flags & CLONEf_COPY_STACKS) {
12264 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12265 PL_tmps_ix = proto_perl->Itmps_ix;
12266 PL_tmps_max = proto_perl->Itmps_max;
12267 PL_tmps_floor = proto_perl->Itmps_floor;
12268 Newx(PL_tmps_stack, PL_tmps_max, SV*);
12269 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
12270 PL_tmps_ix+1, param);
12272 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12273 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
12274 Newxz(PL_markstack, i, I32);
12275 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
12276 - proto_perl->Imarkstack);
12277 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
12278 - proto_perl->Imarkstack);
12279 Copy(proto_perl->Imarkstack, PL_markstack,
12280 PL_markstack_ptr - PL_markstack + 1, I32);
12282 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12283 * NOTE: unlike the others! */
12284 PL_scopestack_ix = proto_perl->Iscopestack_ix;
12285 PL_scopestack_max = proto_perl->Iscopestack_max;
12286 Newxz(PL_scopestack, PL_scopestack_max, I32);
12287 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
12290 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
12291 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
12293 /* NOTE: si_dup() looks at PL_markstack */
12294 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
12296 /* PL_curstack = PL_curstackinfo->si_stack; */
12297 PL_curstack = av_dup(proto_perl->Icurstack, param);
12298 PL_mainstack = av_dup(proto_perl->Imainstack, param);
12300 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12301 PL_stack_base = AvARRAY(PL_curstack);
12302 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
12303 - proto_perl->Istack_base);
12304 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12306 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12307 * NOTE: unlike the others! */
12308 PL_savestack_ix = proto_perl->Isavestack_ix;
12309 PL_savestack_max = proto_perl->Isavestack_max;
12310 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
12311 PL_savestack = ss_dup(proto_perl, param);
12315 ENTER; /* perl_destruct() wants to LEAVE; */
12317 /* although we're not duplicating the tmps stack, we should still
12318 * add entries for any SVs on the tmps stack that got cloned by a
12319 * non-refcount means (eg a temp in @_); otherwise they will be
12322 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
12323 SV * const nsv = MUTABLE_SV(ptr_table_fetch(PL_ptr_table,
12324 proto_perl->Itmps_stack[i]));
12325 if (nsv && !SvREFCNT(nsv)) {
12326 PUSH_EXTEND_MORTAL__SV_C(SvREFCNT_inc_simple(nsv));
12331 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
12332 PL_top_env = &PL_start_env;
12334 PL_op = proto_perl->Iop;
12337 PL_Xpv = (XPV*)NULL;
12338 my_perl->Ina = proto_perl->Ina;
12340 PL_statbuf = proto_perl->Istatbuf;
12341 PL_statcache = proto_perl->Istatcache;
12342 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12343 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12345 PL_timesbuf = proto_perl->Itimesbuf;
12348 PL_tainted = proto_perl->Itainted;
12349 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12350 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12351 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12352 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12353 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12354 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12355 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12356 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12358 PL_restartop = proto_perl->Irestartop;
12359 PL_in_eval = proto_perl->Iin_eval;
12360 PL_delaymagic = proto_perl->Idelaymagic;
12361 PL_dirty = proto_perl->Idirty;
12362 PL_localizing = proto_perl->Ilocalizing;
12364 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12365 PL_hv_fetch_ent_mh = NULL;
12366 PL_modcount = proto_perl->Imodcount;
12367 PL_lastgotoprobe = NULL;
12368 PL_dumpindent = proto_perl->Idumpindent;
12370 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12371 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12372 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12373 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12374 PL_efloatbuf = NULL; /* reinits on demand */
12375 PL_efloatsize = 0; /* reinits on demand */
12379 PL_screamfirst = NULL;
12380 PL_screamnext = NULL;
12381 PL_maxscream = -1; /* reinits on demand */
12382 PL_lastscream = NULL;
12385 PL_regdummy = proto_perl->Iregdummy;
12386 PL_colorset = 0; /* reinits PL_colors[] */
12387 /*PL_colors[6] = {0,0,0,0,0,0};*/
12391 /* Pluggable optimizer */
12392 PL_peepp = proto_perl->Ipeepp;
12393 /* op_free() hook */
12394 PL_opfreehook = proto_perl->Iopfreehook;
12396 PL_stashcache = newHV();
12398 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12399 proto_perl->Iwatchaddr);
12400 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12401 if (PL_debug && PL_watchaddr) {
12402 PerlIO_printf(Perl_debug_log,
12403 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12404 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12405 PTR2UV(PL_watchok));
12408 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
12410 /* Call the ->CLONE method, if it exists, for each of the stashes
12411 identified by sv_dup() above.
12413 while(av_len(param->stashes) != -1) {
12414 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
12415 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12416 if (cloner && GvCV(cloner)) {
12421 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12423 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
12429 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12430 ptr_table_free(PL_ptr_table);
12431 PL_ptr_table = NULL;
12435 SvREFCNT_dec(param->stashes);
12437 /* orphaned? eg threads->new inside BEGIN or use */
12438 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12439 SvREFCNT_inc_simple_void(PL_compcv);
12440 SAVEFREESV(PL_compcv);
12446 #endif /* USE_ITHREADS */
12449 =head1 Unicode Support
12451 =for apidoc sv_recode_to_utf8
12453 The encoding is assumed to be an Encode object, on entry the PV
12454 of the sv is assumed to be octets in that encoding, and the sv
12455 will be converted into Unicode (and UTF-8).
12457 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12458 is not a reference, nothing is done to the sv. If the encoding is not
12459 an C<Encode::XS> Encoding object, bad things will happen.
12460 (See F<lib/encoding.pm> and L<Encode>).
12462 The PV of the sv is returned.
12467 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12471 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12473 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12487 Passing sv_yes is wrong - it needs to be or'ed set of constants
12488 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12489 remove converted chars from source.
12491 Both will default the value - let them.
12493 XPUSHs(&PL_sv_yes);
12496 call_method("decode", G_SCALAR);
12500 s = SvPV_const(uni, len);
12501 if (s != SvPVX_const(sv)) {
12502 SvGROW(sv, len + 1);
12503 Move(s, SvPVX(sv), len + 1, char);
12504 SvCUR_set(sv, len);
12511 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12515 =for apidoc sv_cat_decode
12517 The encoding is assumed to be an Encode object, the PV of the ssv is
12518 assumed to be octets in that encoding and decoding the input starts
12519 from the position which (PV + *offset) pointed to. The dsv will be
12520 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12521 when the string tstr appears in decoding output or the input ends on
12522 the PV of the ssv. The value which the offset points will be modified
12523 to the last input position on the ssv.
12525 Returns TRUE if the terminator was found, else returns FALSE.
12530 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12531 SV *ssv, int *offset, char *tstr, int tlen)
12536 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12538 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12549 offsv = newSViv(*offset);
12551 mXPUSHp(tstr, tlen);
12553 call_method("cat_decode", G_SCALAR);
12555 ret = SvTRUE(TOPs);
12556 *offset = SvIV(offsv);
12562 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12567 /* ---------------------------------------------------------------------
12569 * support functions for report_uninit()
12572 /* the maxiumum size of array or hash where we will scan looking
12573 * for the undefined element that triggered the warning */
12575 #define FUV_MAX_SEARCH_SIZE 1000
12577 /* Look for an entry in the hash whose value has the same SV as val;
12578 * If so, return a mortal copy of the key. */
12581 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
12584 register HE **array;
12587 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12589 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12590 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12593 array = HvARRAY(hv);
12595 for (i=HvMAX(hv); i>0; i--) {
12596 register HE *entry;
12597 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12598 if (HeVAL(entry) != val)
12600 if ( HeVAL(entry) == &PL_sv_undef ||
12601 HeVAL(entry) == &PL_sv_placeholder)
12605 if (HeKLEN(entry) == HEf_SVKEY)
12606 return sv_mortalcopy(HeKEY_sv(entry));
12607 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12613 /* Look for an entry in the array whose value has the same SV as val;
12614 * If so, return the index, otherwise return -1. */
12617 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
12621 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12623 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12624 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12627 if (val != &PL_sv_undef) {
12628 SV ** const svp = AvARRAY(av);
12631 for (i=AvFILLp(av); i>=0; i--)
12638 /* S_varname(): return the name of a variable, optionally with a subscript.
12639 * If gv is non-zero, use the name of that global, along with gvtype (one
12640 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12641 * targ. Depending on the value of the subscript_type flag, return:
12644 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12645 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12646 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12647 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12650 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
12651 const SV *const keyname, I32 aindex, int subscript_type)
12654 SV * const name = sv_newmortal();
12657 buffer[0] = gvtype;
12660 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12662 gv_fullname4(name, gv, buffer, 0);
12664 if ((unsigned int)SvPVX(name)[1] <= 26) {
12666 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12668 /* Swap the 1 unprintable control character for the 2 byte pretty
12669 version - ie substr($name, 1, 1) = $buffer; */
12670 sv_insert(name, 1, 1, buffer, 2);
12674 CV * const cv = find_runcv(NULL);
12678 if (!cv || !CvPADLIST(cv))
12680 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
12681 sv = *av_fetch(av, targ, FALSE);
12682 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12685 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12686 SV * const sv = newSV(0);
12687 *SvPVX(name) = '$';
12688 Perl_sv_catpvf(aTHX_ name, "{%s}",
12689 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12692 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12693 *SvPVX(name) = '$';
12694 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12696 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12697 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12698 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12706 =for apidoc find_uninit_var
12708 Find the name of the undefined variable (if any) that caused the operator o
12709 to issue a "Use of uninitialized value" warning.
12710 If match is true, only return a name if it's value matches uninit_sv.
12711 So roughly speaking, if a unary operator (such as OP_COS) generates a
12712 warning, then following the direct child of the op may yield an
12713 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12714 other hand, with OP_ADD there are two branches to follow, so we only print
12715 the variable name if we get an exact match.
12717 The name is returned as a mortal SV.
12719 Assumes that PL_op is the op that originally triggered the error, and that
12720 PL_comppad/PL_curpad points to the currently executing pad.
12726 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
12732 const OP *o, *o2, *kid;
12734 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12735 uninit_sv == &PL_sv_placeholder)))
12738 switch (obase->op_type) {
12745 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12746 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12749 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12751 if (pad) { /* @lex, %lex */
12752 sv = PAD_SVl(obase->op_targ);
12756 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12757 /* @global, %global */
12758 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12761 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
12763 else /* @{expr}, %{expr} */
12764 return find_uninit_var(cUNOPx(obase)->op_first,
12768 /* attempt to find a match within the aggregate */
12770 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12772 subscript_type = FUV_SUBSCRIPT_HASH;
12775 index = find_array_subscript((const AV *)sv, uninit_sv);
12777 subscript_type = FUV_SUBSCRIPT_ARRAY;
12780 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12783 return varname(gv, hash ? '%' : '@', obase->op_targ,
12784 keysv, index, subscript_type);
12788 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12790 return varname(NULL, '$', obase->op_targ,
12791 NULL, 0, FUV_SUBSCRIPT_NONE);
12794 gv = cGVOPx_gv(obase);
12795 if (!gv || (match && GvSV(gv) != uninit_sv))
12797 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12800 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12803 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
12804 if (!av || SvRMAGICAL(av))
12806 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12807 if (!svp || *svp != uninit_sv)
12810 return varname(NULL, '$', obase->op_targ,
12811 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12814 gv = cGVOPx_gv(obase);
12819 AV *const av = GvAV(gv);
12820 if (!av || SvRMAGICAL(av))
12822 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12823 if (!svp || *svp != uninit_sv)
12826 return varname(gv, '$', 0,
12827 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12832 o = cUNOPx(obase)->op_first;
12833 if (!o || o->op_type != OP_NULL ||
12834 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12836 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12840 if (PL_op == obase)
12841 /* $a[uninit_expr] or $h{uninit_expr} */
12842 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12845 o = cBINOPx(obase)->op_first;
12846 kid = cBINOPx(obase)->op_last;
12848 /* get the av or hv, and optionally the gv */
12850 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12851 sv = PAD_SV(o->op_targ);
12853 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12854 && cUNOPo->op_first->op_type == OP_GV)
12856 gv = cGVOPx_gv(cUNOPo->op_first);
12860 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
12865 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12866 /* index is constant */
12870 if (obase->op_type == OP_HELEM) {
12871 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
12872 if (!he || HeVAL(he) != uninit_sv)
12876 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
12877 if (!svp || *svp != uninit_sv)
12881 if (obase->op_type == OP_HELEM)
12882 return varname(gv, '%', o->op_targ,
12883 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12885 return varname(gv, '@', o->op_targ, NULL,
12886 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12889 /* index is an expression;
12890 * attempt to find a match within the aggregate */
12891 if (obase->op_type == OP_HELEM) {
12892 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
12894 return varname(gv, '%', o->op_targ,
12895 keysv, 0, FUV_SUBSCRIPT_HASH);
12899 = find_array_subscript((const AV *)sv, uninit_sv);
12901 return varname(gv, '@', o->op_targ,
12902 NULL, index, FUV_SUBSCRIPT_ARRAY);
12907 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12909 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12914 /* only examine RHS */
12915 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12918 o = cUNOPx(obase)->op_first;
12919 if (o->op_type == OP_PUSHMARK)
12922 if (!o->op_sibling) {
12923 /* one-arg version of open is highly magical */
12925 if (o->op_type == OP_GV) { /* open FOO; */
12927 if (match && GvSV(gv) != uninit_sv)
12929 return varname(gv, '$', 0,
12930 NULL, 0, FUV_SUBSCRIPT_NONE);
12932 /* other possibilities not handled are:
12933 * open $x; or open my $x; should return '${*$x}'
12934 * open expr; should return '$'.expr ideally
12940 /* ops where $_ may be an implicit arg */
12944 if ( !(obase->op_flags & OPf_STACKED)) {
12945 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12946 ? PAD_SVl(obase->op_targ)
12949 sv = sv_newmortal();
12950 sv_setpvs(sv, "$_");
12959 match = 1; /* print etc can return undef on defined args */
12960 /* skip filehandle as it can't produce 'undef' warning */
12961 o = cUNOPx(obase)->op_first;
12962 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12963 o = o->op_sibling->op_sibling;
12967 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12969 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12971 /* the following ops are capable of returning PL_sv_undef even for
12972 * defined arg(s) */
12991 case OP_GETPEERNAME:
13039 case OP_SMARTMATCH:
13048 /* XXX tmp hack: these two may call an XS sub, and currently
13049 XS subs don't have a SUB entry on the context stack, so CV and
13050 pad determination goes wrong, and BAD things happen. So, just
13051 don't try to determine the value under those circumstances.
13052 Need a better fix at dome point. DAPM 11/2007 */
13058 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
13059 if (gv && GvSV(gv) == uninit_sv)
13060 return newSVpvs_flags("$.", SVs_TEMP);
13065 /* def-ness of rval pos() is independent of the def-ness of its arg */
13066 if ( !(obase->op_flags & OPf_MOD))
13071 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
13072 return newSVpvs_flags("${$/}", SVs_TEMP);
13077 if (!(obase->op_flags & OPf_KIDS))
13079 o = cUNOPx(obase)->op_first;
13085 /* if all except one arg are constant, or have no side-effects,
13086 * or are optimized away, then it's unambiguous */
13088 for (kid=o; kid; kid = kid->op_sibling) {
13090 const OPCODE type = kid->op_type;
13091 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
13092 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
13093 || (type == OP_PUSHMARK)
13097 if (o2) { /* more than one found */
13104 return find_uninit_var(o2, uninit_sv, match);
13106 /* scan all args */
13108 sv = find_uninit_var(o, uninit_sv, 1);
13120 =for apidoc report_uninit
13122 Print appropriate "Use of uninitialized variable" warning
13128 Perl_report_uninit(pTHX_ const SV *uninit_sv)
13132 SV* varname = NULL;
13134 varname = find_uninit_var(PL_op, uninit_sv,0);
13136 sv_insert(varname, 0, 0, " ", 1);
13138 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
13139 varname ? SvPV_nolen_const(varname) : "",
13140 " in ", OP_DESC(PL_op));
13143 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
13149 * c-indentation-style: bsd
13150 * c-basic-offset: 4
13151 * indent-tabs-mode: t
13154 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob