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
36 # if __STDC_VERSION__ >= 199901L && !defined(VMS)
47 /* Missing proto on LynxOS */
48 char *gconvert(double, int, int, char *);
51 #ifdef PERL_UTF8_CACHE_ASSERT
52 /* if adding more checks watch out for the following tests:
53 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
54 * lib/utf8.t lib/Unicode/Collate/t/index.t
57 # define ASSERT_UTF8_CACHE(cache) \
58 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
59 assert((cache)[2] <= (cache)[3]); \
60 assert((cache)[3] <= (cache)[1]);} \
63 # define ASSERT_UTF8_CACHE(cache) NOOP
66 #ifdef PERL_OLD_COPY_ON_WRITE
67 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
68 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
69 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
73 /* ============================================================================
75 =head1 Allocation and deallocation of SVs.
77 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
78 sv, av, hv...) contains type and reference count information, and for
79 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
80 contains fields specific to each type. Some types store all they need
81 in the head, so don't have a body.
83 In all but the most memory-paranoid configurations (ex: PURIFY), heads
84 and bodies are allocated out of arenas, which by default are
85 approximately 4K chunks of memory parcelled up into N heads or bodies.
86 Sv-bodies are allocated by their sv-type, guaranteeing size
87 consistency needed to allocate safely from arrays.
89 For SV-heads, the first slot in each arena is reserved, and holds a
90 link to the next arena, some flags, and a note of the number of slots.
91 Snaked through each arena chain is a linked list of free items; when
92 this becomes empty, an extra arena is allocated and divided up into N
93 items which are threaded into the free list.
95 SV-bodies are similar, but they use arena-sets by default, which
96 separate the link and info from the arena itself, and reclaim the 1st
97 slot in the arena. SV-bodies are further described later.
99 The following global variables are associated with arenas:
101 PL_sv_arenaroot pointer to list of SV arenas
102 PL_sv_root pointer to list of free SV structures
104 PL_body_arenas head of linked-list of body arenas
105 PL_body_roots[] array of pointers to list of free bodies of svtype
106 arrays are indexed by the svtype needed
108 A few special SV heads are not allocated from an arena, but are
109 instead directly created in the interpreter structure, eg PL_sv_undef.
110 The size of arenas can be changed from the default by setting
111 PERL_ARENA_SIZE appropriately at compile time.
113 The SV arena serves the secondary purpose of allowing still-live SVs
114 to be located and destroyed during final cleanup.
116 At the lowest level, the macros new_SV() and del_SV() grab and free
117 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
118 to return the SV to the free list with error checking.) new_SV() calls
119 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
120 SVs in the free list have their SvTYPE field set to all ones.
122 At the time of very final cleanup, sv_free_arenas() is called from
123 perl_destruct() to physically free all the arenas allocated since the
124 start of the interpreter.
126 The function visit() scans the SV arenas list, and calls a specified
127 function for each SV it finds which is still live - ie which has an SvTYPE
128 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
129 following functions (specified as [function that calls visit()] / [function
130 called by visit() for each SV]):
132 sv_report_used() / do_report_used()
133 dump all remaining SVs (debugging aid)
135 sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
136 do_clean_named_io_objs()
137 Attempt to free all objects pointed to by RVs,
138 and try to do the same for all objects indirectly
139 referenced by typeglobs too. Called once from
140 perl_destruct(), prior to calling sv_clean_all()
143 sv_clean_all() / do_clean_all()
144 SvREFCNT_dec(sv) each remaining SV, possibly
145 triggering an sv_free(). It also sets the
146 SVf_BREAK flag on the SV to indicate that the
147 refcnt has been artificially lowered, and thus
148 stopping sv_free() from giving spurious warnings
149 about SVs which unexpectedly have a refcnt
150 of zero. called repeatedly from perl_destruct()
151 until there are no SVs left.
153 =head2 Arena allocator API Summary
155 Private API to rest of sv.c
159 new_XPVNV(), del_XPVGV(),
164 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
168 * ========================================================================= */
171 * "A time to plant, and a time to uproot what was planted..."
175 # define MEM_LOG_NEW_SV(sv, file, line, func) \
176 Perl_mem_log_new_sv(sv, file, line, func)
177 # define MEM_LOG_DEL_SV(sv, file, line, func) \
178 Perl_mem_log_del_sv(sv, file, line, func)
180 # define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
181 # define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
184 #ifdef DEBUG_LEAKING_SCALARS
185 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define DEBUG_SV_SERIAL(sv) \
187 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
188 PTR2UV(sv), (long)(sv)->sv_debug_serial))
190 # define FREE_SV_DEBUG_FILE(sv)
191 # define DEBUG_SV_SERIAL(sv) NOOP
195 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
196 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
197 /* Whilst I'd love to do this, it seems that things like to check on
199 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
201 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
202 PoisonNew(&SvREFCNT(sv), 1, U32)
204 # define SvARENA_CHAIN(sv) SvANY(sv)
205 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
206 # define POSION_SV_HEAD(sv)
209 /* Mark an SV head as unused, and add to free list.
211 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
212 * its refcount artificially decremented during global destruction, so
213 * there may be dangling pointers to it. The last thing we want in that
214 * case is for it to be reused. */
216 #define plant_SV(p) \
218 const U32 old_flags = SvFLAGS(p); \
219 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
220 DEBUG_SV_SERIAL(p); \
221 FREE_SV_DEBUG_FILE(p); \
223 SvFLAGS(p) = SVTYPEMASK; \
224 if (!(old_flags & SVf_BREAK)) { \
225 SvARENA_CHAIN_SET(p, PL_sv_root); \
231 #define uproot_SV(p) \
234 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
239 /* make some more SVs by adding another arena */
246 char *chunk; /* must use New here to match call to */
247 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
248 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
253 /* new_SV(): return a new, empty SV head */
255 #ifdef DEBUG_LEAKING_SCALARS
256 /* provide a real function for a debugger to play with */
258 S_new_SV(pTHX_ const char *file, int line, const char *func)
265 sv = S_more_sv(aTHX);
269 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
270 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_parent = NULL;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
280 sv->sv_debug_serial = PL_sv_serial++;
282 MEM_LOG_NEW_SV(sv, file, line, func);
283 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
284 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
288 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
296 (p) = S_more_sv(aTHX); \
300 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
305 /* del_SV(): return an empty SV head to the free list */
318 S_del_sv(pTHX_ SV *p)
322 PERL_ARGS_ASSERT_DEL_SV;
327 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
328 const SV * const sv = sva + 1;
329 const SV * const svend = &sva[SvREFCNT(sva)];
330 if (p >= sv && p < svend) {
336 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
337 "Attempt to free non-arena SV: 0x%"UVxf
338 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
345 #else /* ! DEBUGGING */
347 #define del_SV(p) plant_SV(p)
349 #endif /* DEBUGGING */
353 =head1 SV Manipulation Functions
355 =for apidoc sv_add_arena
357 Given a chunk of memory, link it to the head of the list of arenas,
358 and split it into a list of free SVs.
364 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
367 SV *const sva = MUTABLE_SV(ptr);
371 PERL_ARGS_ASSERT_SV_ADD_ARENA;
373 /* The first SV in an arena isn't an SV. */
374 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
375 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
376 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
378 PL_sv_arenaroot = sva;
379 PL_sv_root = sva + 1;
381 svend = &sva[SvREFCNT(sva) - 1];
384 SvARENA_CHAIN_SET(sv, (sv + 1));
388 /* Must always set typemask because it's always checked in on cleanup
389 when the arenas are walked looking for objects. */
390 SvFLAGS(sv) = SVTYPEMASK;
393 SvARENA_CHAIN_SET(sv, 0);
397 SvFLAGS(sv) = SVTYPEMASK;
400 /* visit(): call the named function for each non-free SV in the arenas
401 * whose flags field matches the flags/mask args. */
404 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
410 PERL_ARGS_ASSERT_VISIT;
412 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
413 register const SV * const svend = &sva[SvREFCNT(sva)];
415 for (sv = sva + 1; sv < svend; ++sv) {
416 if (SvTYPE(sv) != (svtype)SVTYPEMASK
417 && (sv->sv_flags & mask) == flags
430 /* called by sv_report_used() for each live SV */
433 do_report_used(pTHX_ SV *const sv)
435 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
436 PerlIO_printf(Perl_debug_log, "****\n");
443 =for apidoc sv_report_used
445 Dump the contents of all SVs not yet freed (debugging aid).
451 Perl_sv_report_used(pTHX)
454 visit(do_report_used, 0, 0);
460 /* called by sv_clean_objs() for each live SV */
463 do_clean_objs(pTHX_ SV *const ref)
468 SV * const target = SvRV(ref);
469 if (SvOBJECT(target)) {
470 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
471 if (SvWEAKREF(ref)) {
472 sv_del_backref(target, ref);
478 SvREFCNT_dec(target);
483 /* XXX Might want to check arrays, etc. */
487 /* clear any slots in a GV which hold objects - except IO;
488 * called by sv_clean_objs() for each live GV */
491 do_clean_named_objs(pTHX_ SV *const sv)
495 assert(SvTYPE(sv) == SVt_PVGV);
496 assert(isGV_with_GP(sv));
500 /* freeing GP entries may indirectly free the current GV;
501 * hold onto it while we mess with the GP slots */
504 if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
505 DEBUG_D((PerlIO_printf(Perl_debug_log,
506 "Cleaning named glob SV object:\n "), sv_dump(obj)));
510 if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
511 DEBUG_D((PerlIO_printf(Perl_debug_log,
512 "Cleaning named glob AV object:\n "), sv_dump(obj)));
516 if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
517 DEBUG_D((PerlIO_printf(Perl_debug_log,
518 "Cleaning named glob HV object:\n "), sv_dump(obj)));
522 if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
523 DEBUG_D((PerlIO_printf(Perl_debug_log,
524 "Cleaning named glob CV object:\n "), sv_dump(obj)));
528 SvREFCNT_dec(sv); /* undo the inc above */
531 /* clear any IO slots in a GV which hold objects (except stderr, defout);
532 * called by sv_clean_objs() for each live GV */
535 do_clean_named_io_objs(pTHX_ SV *const sv)
539 assert(SvTYPE(sv) == SVt_PVGV);
540 assert(isGV_with_GP(sv));
541 if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
545 if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
546 DEBUG_D((PerlIO_printf(Perl_debug_log,
547 "Cleaning named glob IO object:\n "), sv_dump(obj)));
551 SvREFCNT_dec(sv); /* undo the inc above */
554 /* Void wrapper to pass to visit() */
556 do_curse(pTHX_ SV * const sv) {
557 if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
558 || (PL_defoutgv && GvGP(PL_defoutgv) && (SV*)GvIO(PL_defoutgv) == sv))
564 =for apidoc sv_clean_objs
566 Attempt to destroy all objects not yet freed.
572 Perl_sv_clean_objs(pTHX)
576 PL_in_clean_objs = TRUE;
577 visit(do_clean_objs, SVf_ROK, SVf_ROK);
578 /* Some barnacles may yet remain, clinging to typeglobs.
579 * Run the non-IO destructors first: they may want to output
580 * error messages, close files etc */
581 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
582 visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
583 /* And if there are some very tenacious barnacles clinging to arrays,
584 closures, or what have you.... */
585 visit(do_curse, SVs_OBJECT, SVs_OBJECT);
586 olddef = PL_defoutgv;
587 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
588 if (olddef && isGV_with_GP(olddef))
589 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
590 olderr = PL_stderrgv;
591 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
592 if (olderr && isGV_with_GP(olderr))
593 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
594 SvREFCNT_dec(olddef);
595 PL_in_clean_objs = FALSE;
598 /* called by sv_clean_all() for each live SV */
601 do_clean_all(pTHX_ SV *const sv)
604 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
605 /* don't clean pid table and strtab */
608 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
609 SvFLAGS(sv) |= SVf_BREAK;
614 =for apidoc sv_clean_all
616 Decrement the refcnt of each remaining SV, possibly triggering a
617 cleanup. This function may have to be called multiple times to free
618 SVs which are in complex self-referential hierarchies.
624 Perl_sv_clean_all(pTHX)
628 PL_in_clean_all = TRUE;
629 cleaned = visit(do_clean_all, 0,0);
634 ARENASETS: a meta-arena implementation which separates arena-info
635 into struct arena_set, which contains an array of struct
636 arena_descs, each holding info for a single arena. By separating
637 the meta-info from the arena, we recover the 1st slot, formerly
638 borrowed for list management. The arena_set is about the size of an
639 arena, avoiding the needless malloc overhead of a naive linked-list.
641 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
642 memory in the last arena-set (1/2 on average). In trade, we get
643 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
644 smaller types). The recovery of the wasted space allows use of
645 small arenas for large, rare body types, by changing array* fields
646 in body_details_by_type[] below.
649 char *arena; /* the raw storage, allocated aligned */
650 size_t size; /* its size ~4k typ */
651 svtype utype; /* bodytype stored in arena */
656 /* Get the maximum number of elements in set[] such that struct arena_set
657 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
658 therefore likely to be 1 aligned memory page. */
660 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
661 - 2 * sizeof(int)) / sizeof (struct arena_desc))
664 struct arena_set* next;
665 unsigned int set_size; /* ie ARENAS_PER_SET */
666 unsigned int curr; /* index of next available arena-desc */
667 struct arena_desc set[ARENAS_PER_SET];
671 =for apidoc sv_free_arenas
673 Deallocate the memory used by all arenas. Note that all the individual SV
674 heads and bodies within the arenas must already have been freed.
679 Perl_sv_free_arenas(pTHX)
686 /* Free arenas here, but be careful about fake ones. (We assume
687 contiguity of the fake ones with the corresponding real ones.) */
689 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
690 svanext = MUTABLE_SV(SvANY(sva));
691 while (svanext && SvFAKE(svanext))
692 svanext = MUTABLE_SV(SvANY(svanext));
699 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
702 struct arena_set *current = aroot;
705 assert(aroot->set[i].arena);
706 Safefree(aroot->set[i].arena);
714 i = PERL_ARENA_ROOTS_SIZE;
716 PL_body_roots[i] = 0;
723 Here are mid-level routines that manage the allocation of bodies out
724 of the various arenas. There are 5 kinds of arenas:
726 1. SV-head arenas, which are discussed and handled above
727 2. regular body arenas
728 3. arenas for reduced-size bodies
731 Arena types 2 & 3 are chained by body-type off an array of
732 arena-root pointers, which is indexed by svtype. Some of the
733 larger/less used body types are malloced singly, since a large
734 unused block of them is wasteful. Also, several svtypes dont have
735 bodies; the data fits into the sv-head itself. The arena-root
736 pointer thus has a few unused root-pointers (which may be hijacked
737 later for arena types 4,5)
739 3 differs from 2 as an optimization; some body types have several
740 unused fields in the front of the structure (which are kept in-place
741 for consistency). These bodies can be allocated in smaller chunks,
742 because the leading fields arent accessed. Pointers to such bodies
743 are decremented to point at the unused 'ghost' memory, knowing that
744 the pointers are used with offsets to the real memory.
747 =head1 SV-Body Allocation
749 Allocation of SV-bodies is similar to SV-heads, differing as follows;
750 the allocation mechanism is used for many body types, so is somewhat
751 more complicated, it uses arena-sets, and has no need for still-live
754 At the outermost level, (new|del)_X*V macros return bodies of the
755 appropriate type. These macros call either (new|del)_body_type or
756 (new|del)_body_allocated macro pairs, depending on specifics of the
757 type. Most body types use the former pair, the latter pair is used to
758 allocate body types with "ghost fields".
760 "ghost fields" are fields that are unused in certain types, and
761 consequently don't need to actually exist. They are declared because
762 they're part of a "base type", which allows use of functions as
763 methods. The simplest examples are AVs and HVs, 2 aggregate types
764 which don't use the fields which support SCALAR semantics.
766 For these types, the arenas are carved up into appropriately sized
767 chunks, we thus avoid wasted memory for those unaccessed members.
768 When bodies are allocated, we adjust the pointer back in memory by the
769 size of the part not allocated, so it's as if we allocated the full
770 structure. (But things will all go boom if you write to the part that
771 is "not there", because you'll be overwriting the last members of the
772 preceding structure in memory.)
774 We calculate the correction using the STRUCT_OFFSET macro on the first
775 member present. If the allocated structure is smaller (no initial NV
776 actually allocated) then the net effect is to subtract the size of the NV
777 from the pointer, to return a new pointer as if an initial NV were actually
778 allocated. (We were using structures named *_allocated for this, but
779 this turned out to be a subtle bug, because a structure without an NV
780 could have a lower alignment constraint, but the compiler is allowed to
781 optimised accesses based on the alignment constraint of the actual pointer
782 to the full structure, for example, using a single 64 bit load instruction
783 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
785 This is the same trick as was used for NV and IV bodies. Ironically it
786 doesn't need to be used for NV bodies any more, because NV is now at
787 the start of the structure. IV bodies don't need it either, because
788 they are no longer allocated.
790 In turn, the new_body_* allocators call S_new_body(), which invokes
791 new_body_inline macro, which takes a lock, and takes a body off the
792 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
793 necessary to refresh an empty list. Then the lock is released, and
794 the body is returned.
796 Perl_more_bodies allocates a new arena, and carves it up into an array of N
797 bodies, which it strings into a linked list. It looks up arena-size
798 and body-size from the body_details table described below, thus
799 supporting the multiple body-types.
801 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
802 the (new|del)_X*V macros are mapped directly to malloc/free.
804 For each sv-type, struct body_details bodies_by_type[] carries
805 parameters which control these aspects of SV handling:
807 Arena_size determines whether arenas are used for this body type, and if
808 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
809 zero, forcing individual mallocs and frees.
811 Body_size determines how big a body is, and therefore how many fit into
812 each arena. Offset carries the body-pointer adjustment needed for
813 "ghost fields", and is used in *_allocated macros.
815 But its main purpose is to parameterize info needed in
816 Perl_sv_upgrade(). The info here dramatically simplifies the function
817 vs the implementation in 5.8.8, making it table-driven. All fields
818 are used for this, except for arena_size.
820 For the sv-types that have no bodies, arenas are not used, so those
821 PL_body_roots[sv_type] are unused, and can be overloaded. In
822 something of a special case, SVt_NULL is borrowed for HE arenas;
823 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
824 bodies_by_type[SVt_NULL] slot is not used, as the table is not
829 struct body_details {
830 U8 body_size; /* Size to allocate */
831 U8 copy; /* Size of structure to copy (may be shorter) */
833 unsigned int type : 4; /* We have space for a sanity check. */
834 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
835 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
836 unsigned int arena : 1; /* Allocated from an arena */
837 size_t arena_size; /* Size of arena to allocate */
845 /* With -DPURFIY we allocate everything directly, and don't use arenas.
846 This seems a rather elegant way to simplify some of the code below. */
847 #define HASARENA FALSE
849 #define HASARENA TRUE
851 #define NOARENA FALSE
853 /* Size the arenas to exactly fit a given number of bodies. A count
854 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
855 simplifying the default. If count > 0, the arena is sized to fit
856 only that many bodies, allowing arenas to be used for large, rare
857 bodies (XPVFM, XPVIO) without undue waste. The arena size is
858 limited by PERL_ARENA_SIZE, so we can safely oversize the
861 #define FIT_ARENA0(body_size) \
862 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
863 #define FIT_ARENAn(count,body_size) \
864 ( count * body_size <= PERL_ARENA_SIZE) \
865 ? count * body_size \
866 : FIT_ARENA0 (body_size)
867 #define FIT_ARENA(count,body_size) \
869 ? FIT_ARENAn (count, body_size) \
870 : FIT_ARENA0 (body_size)
872 /* Calculate the length to copy. Specifically work out the length less any
873 final padding the compiler needed to add. See the comment in sv_upgrade
874 for why copying the padding proved to be a bug. */
876 #define copy_length(type, last_member) \
877 STRUCT_OFFSET(type, last_member) \
878 + sizeof (((type*)SvANY((const SV *)0))->last_member)
880 static const struct body_details bodies_by_type[] = {
881 /* HEs use this offset for their arena. */
882 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
884 /* The bind placeholder pretends to be an RV for now.
885 Also it's marked as "can't upgrade" to stop anyone using it before it's
887 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
889 /* IVs are in the head, so the allocation size is 0. */
891 sizeof(IV), /* This is used to copy out the IV body. */
892 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
893 NOARENA /* IVS don't need an arena */, 0
896 { sizeof(NV), sizeof(NV),
897 STRUCT_OFFSET(XPVNV, xnv_u),
898 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
900 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
901 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
902 + STRUCT_OFFSET(XPV, xpv_cur),
903 SVt_PV, FALSE, NONV, HASARENA,
904 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
906 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
907 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
908 + STRUCT_OFFSET(XPV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA,
910 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
912 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
913 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
914 + STRUCT_OFFSET(XPV, xpv_cur),
915 SVt_PVNV, FALSE, HADNV, HASARENA,
916 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
918 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
919 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
924 SVt_REGEXP, FALSE, NONV, HASARENA,
925 FIT_ARENA(0, sizeof(regexp))
928 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
935 copy_length(XPVAV, xav_alloc),
937 SVt_PVAV, TRUE, NONV, HASARENA,
938 FIT_ARENA(0, sizeof(XPVAV)) },
941 copy_length(XPVHV, xhv_max),
943 SVt_PVHV, TRUE, NONV, HASARENA,
944 FIT_ARENA(0, sizeof(XPVHV)) },
949 SVt_PVCV, TRUE, NONV, HASARENA,
950 FIT_ARENA(0, sizeof(XPVCV)) },
955 SVt_PVFM, TRUE, NONV, NOARENA,
956 FIT_ARENA(20, sizeof(XPVFM)) },
961 SVt_PVIO, TRUE, NONV, HASARENA,
962 FIT_ARENA(24, sizeof(XPVIO)) },
965 #define new_body_allocated(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ sv_type) \
967 - bodies_by_type[sv_type].offset)
969 /* return a thing to the free list */
971 #define del_body(thing, root) \
973 void ** const thing_copy = (void **)thing; \
974 *thing_copy = *root; \
975 *root = (void*)thing_copy; \
980 #define new_XNV() safemalloc(sizeof(XPVNV))
981 #define new_XPVNV() safemalloc(sizeof(XPVNV))
982 #define new_XPVMG() safemalloc(sizeof(XPVMG))
984 #define del_XPVGV(p) safefree(p)
988 #define new_XNV() new_body_allocated(SVt_NV)
989 #define new_XPVNV() new_body_allocated(SVt_PVNV)
990 #define new_XPVMG() new_body_allocated(SVt_PVMG)
992 #define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
993 &PL_body_roots[SVt_PVGV])
997 /* no arena for you! */
999 #define new_NOARENA(details) \
1000 safemalloc((details)->body_size + (details)->offset)
1001 #define new_NOARENAZ(details) \
1002 safecalloc((details)->body_size + (details)->offset, 1)
1005 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1006 const size_t arena_size)
1009 void ** const root = &PL_body_roots[sv_type];
1010 struct arena_desc *adesc;
1011 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1015 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1016 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1017 static bool done_sanity_check;
1019 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1020 * variables like done_sanity_check. */
1021 if (!done_sanity_check) {
1022 unsigned int i = SVt_LAST;
1024 done_sanity_check = TRUE;
1027 assert (bodies_by_type[i].type == i);
1033 /* may need new arena-set to hold new arena */
1034 if (!aroot || aroot->curr >= aroot->set_size) {
1035 struct arena_set *newroot;
1036 Newxz(newroot, 1, struct arena_set);
1037 newroot->set_size = ARENAS_PER_SET;
1038 newroot->next = aroot;
1040 PL_body_arenas = (void *) newroot;
1041 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1044 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1045 curr = aroot->curr++;
1046 adesc = &(aroot->set[curr]);
1047 assert(!adesc->arena);
1049 Newx(adesc->arena, good_arena_size, char);
1050 adesc->size = good_arena_size;
1051 adesc->utype = sv_type;
1052 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1053 curr, (void*)adesc->arena, (UV)good_arena_size));
1055 start = (char *) adesc->arena;
1057 /* Get the address of the byte after the end of the last body we can fit.
1058 Remember, this is integer division: */
1059 end = start + good_arena_size / body_size * body_size;
1061 /* computed count doesn't reflect the 1st slot reservation */
1062 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1063 DEBUG_m(PerlIO_printf(Perl_debug_log,
1064 "arena %p end %p arena-size %d (from %d) type %d "
1066 (void*)start, (void*)end, (int)good_arena_size,
1067 (int)arena_size, sv_type, (int)body_size,
1068 (int)good_arena_size / (int)body_size));
1070 DEBUG_m(PerlIO_printf(Perl_debug_log,
1071 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (void*)start, (void*)end,
1073 (int)arena_size, sv_type, (int)body_size,
1074 (int)good_arena_size / (int)body_size));
1076 *root = (void *)start;
1079 /* Where the next body would start: */
1080 char * const next = start + body_size;
1083 /* This is the last body: */
1084 assert(next == end);
1086 *(void **)start = 0;
1090 *(void**) start = (void *)next;
1095 /* grab a new thing from the free list, allocating more if necessary.
1096 The inline version is used for speed in hot routines, and the
1097 function using it serves the rest (unless PURIFY).
1099 #define new_body_inline(xpv, sv_type) \
1101 void ** const r3wt = &PL_body_roots[sv_type]; \
1102 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1103 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1104 bodies_by_type[sv_type].body_size,\
1105 bodies_by_type[sv_type].arena_size)); \
1106 *(r3wt) = *(void**)(xpv); \
1112 S_new_body(pTHX_ const svtype sv_type)
1116 new_body_inline(xpv, sv_type);
1122 static const struct body_details fake_rv =
1123 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1126 =for apidoc sv_upgrade
1128 Upgrade an SV to a more complex form. Generally adds a new body type to the
1129 SV, then copies across as much information as possible from the old body.
1130 It croaks if the SV is already in a more complex form than requested. You
1131 generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
1132 before calling C<sv_upgrade>, and hence does not croak. See also
1139 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1144 const svtype old_type = SvTYPE(sv);
1145 const struct body_details *new_type_details;
1146 const struct body_details *old_type_details
1147 = bodies_by_type + old_type;
1148 SV *referant = NULL;
1150 PERL_ARGS_ASSERT_SV_UPGRADE;
1152 if (old_type == new_type)
1155 /* This clause was purposefully added ahead of the early return above to
1156 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1157 inference by Nick I-S that it would fix other troublesome cases. See
1158 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1160 Given that shared hash key scalars are no longer PVIV, but PV, there is
1161 no longer need to unshare so as to free up the IVX slot for its proper
1162 purpose. So it's safe to move the early return earlier. */
1164 if (new_type != SVt_PV && SvIsCOW(sv)) {
1165 sv_force_normal_flags(sv, 0);
1168 old_body = SvANY(sv);
1170 /* Copying structures onto other structures that have been neatly zeroed
1171 has a subtle gotcha. Consider XPVMG
1173 +------+------+------+------+------+-------+-------+
1174 | NV | CUR | LEN | IV | MAGIC | STASH |
1175 +------+------+------+------+------+-------+-------+
1176 0 4 8 12 16 20 24 28
1178 where NVs are aligned to 8 bytes, so that sizeof that structure is
1179 actually 32 bytes long, with 4 bytes of padding at the end:
1181 +------+------+------+------+------+-------+-------+------+
1182 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1183 +------+------+------+------+------+-------+-------+------+
1184 0 4 8 12 16 20 24 28 32
1186 so what happens if you allocate memory for this structure:
1188 +------+------+------+------+------+-------+-------+------+------+...
1189 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1190 +------+------+------+------+------+-------+-------+------+------+...
1191 0 4 8 12 16 20 24 28 32 36
1193 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1194 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1195 started out as zero once, but it's quite possible that it isn't. So now,
1196 rather than a nicely zeroed GP, you have it pointing somewhere random.
1199 (In fact, GP ends up pointing at a previous GP structure, because the
1200 principle cause of the padding in XPVMG getting garbage is a copy of
1201 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1202 this happens to be moot because XPVGV has been re-ordered, with GP
1203 no longer after STASH)
1205 So we are careful and work out the size of used parts of all the
1213 referant = SvRV(sv);
1214 old_type_details = &fake_rv;
1215 if (new_type == SVt_NV)
1216 new_type = SVt_PVNV;
1218 if (new_type < SVt_PVIV) {
1219 new_type = (new_type == SVt_NV)
1220 ? SVt_PVNV : SVt_PVIV;
1225 if (new_type < SVt_PVNV) {
1226 new_type = SVt_PVNV;
1230 assert(new_type > SVt_PV);
1231 assert(SVt_IV < SVt_PV);
1232 assert(SVt_NV < SVt_PV);
1239 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1240 there's no way that it can be safely upgraded, because perl.c
1241 expects to Safefree(SvANY(PL_mess_sv)) */
1242 assert(sv != PL_mess_sv);
1243 /* This flag bit is used to mean other things in other scalar types.
1244 Given that it only has meaning inside the pad, it shouldn't be set
1245 on anything that can get upgraded. */
1246 assert(!SvPAD_TYPED(sv));
1249 if (old_type_details->cant_upgrade)
1250 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1251 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1254 if (old_type > new_type)
1255 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1256 (int)old_type, (int)new_type);
1258 new_type_details = bodies_by_type + new_type;
1260 SvFLAGS(sv) &= ~SVTYPEMASK;
1261 SvFLAGS(sv) |= new_type;
1263 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1264 the return statements above will have triggered. */
1265 assert (new_type != SVt_NULL);
1268 assert(old_type == SVt_NULL);
1269 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1273 assert(old_type == SVt_NULL);
1274 SvANY(sv) = new_XNV();
1279 assert(new_type_details->body_size);
1282 assert(new_type_details->arena);
1283 assert(new_type_details->arena_size);
1284 /* This points to the start of the allocated area. */
1285 new_body_inline(new_body, new_type);
1286 Zero(new_body, new_type_details->body_size, char);
1287 new_body = ((char *)new_body) - new_type_details->offset;
1289 /* We always allocated the full length item with PURIFY. To do this
1290 we fake things so that arena is false for all 16 types.. */
1291 new_body = new_NOARENAZ(new_type_details);
1293 SvANY(sv) = new_body;
1294 if (new_type == SVt_PVAV) {
1298 if (old_type_details->body_size) {
1301 /* It will have been zeroed when the new body was allocated.
1302 Lets not write to it, in case it confuses a write-back
1308 #ifndef NODEFAULT_SHAREKEYS
1309 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1311 HvMAX(sv) = 7; /* (start with 8 buckets) */
1314 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1315 The target created by newSVrv also is, and it can have magic.
1316 However, it never has SvPVX set.
1318 if (old_type == SVt_IV) {
1320 } else if (old_type >= SVt_PV) {
1321 assert(SvPVX_const(sv) == 0);
1324 if (old_type >= SVt_PVMG) {
1325 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1326 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1328 sv->sv_u.svu_array = NULL; /* or svu_hash */
1334 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1335 sv_force_normal_flags(sv) is called. */
1338 /* XXX Is this still needed? Was it ever needed? Surely as there is
1339 no route from NV to PVIV, NOK can never be true */
1340 assert(!SvNOKp(sv));
1351 assert(new_type_details->body_size);
1352 /* We always allocated the full length item with PURIFY. To do this
1353 we fake things so that arena is false for all 16 types.. */
1354 if(new_type_details->arena) {
1355 /* This points to the start of the allocated area. */
1356 new_body_inline(new_body, new_type);
1357 Zero(new_body, new_type_details->body_size, char);
1358 new_body = ((char *)new_body) - new_type_details->offset;
1360 new_body = new_NOARENAZ(new_type_details);
1362 SvANY(sv) = new_body;
1364 if (old_type_details->copy) {
1365 /* There is now the potential for an upgrade from something without
1366 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1367 int offset = old_type_details->offset;
1368 int length = old_type_details->copy;
1370 if (new_type_details->offset > old_type_details->offset) {
1371 const int difference
1372 = new_type_details->offset - old_type_details->offset;
1373 offset += difference;
1374 length -= difference;
1376 assert (length >= 0);
1378 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1382 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1383 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1384 * correct 0.0 for us. Otherwise, if the old body didn't have an
1385 * NV slot, but the new one does, then we need to initialise the
1386 * freshly created NV slot with whatever the correct bit pattern is
1388 if (old_type_details->zero_nv && !new_type_details->zero_nv
1389 && !isGV_with_GP(sv))
1393 if (new_type == SVt_PVIO) {
1394 IO * const io = MUTABLE_IO(sv);
1395 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1398 /* Clear the stashcache because a new IO could overrule a package
1400 hv_clear(PL_stashcache);
1402 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1403 IoPAGE_LEN(sv) = 60;
1405 if (old_type < SVt_PV) {
1406 /* referant will be NULL unless the old type was SVt_IV emulating
1408 sv->sv_u.svu_rv = referant;
1412 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1413 (unsigned long)new_type);
1416 if (old_type > SVt_IV) {
1420 /* Note that there is an assumption that all bodies of types that
1421 can be upgraded came from arenas. Only the more complex non-
1422 upgradable types are allowed to be directly malloc()ed. */
1423 assert(old_type_details->arena);
1424 del_body((void*)((char*)old_body + old_type_details->offset),
1425 &PL_body_roots[old_type]);
1431 =for apidoc sv_backoff
1433 Remove any string offset. You should normally use the C<SvOOK_off> macro
1440 Perl_sv_backoff(pTHX_ register SV *const sv)
1443 const char * const s = SvPVX_const(sv);
1445 PERL_ARGS_ASSERT_SV_BACKOFF;
1446 PERL_UNUSED_CONTEXT;
1449 assert(SvTYPE(sv) != SVt_PVHV);
1450 assert(SvTYPE(sv) != SVt_PVAV);
1452 SvOOK_offset(sv, delta);
1454 SvLEN_set(sv, SvLEN(sv) + delta);
1455 SvPV_set(sv, SvPVX(sv) - delta);
1456 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1457 SvFLAGS(sv) &= ~SVf_OOK;
1464 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1465 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1466 Use the C<SvGROW> wrapper instead.
1472 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1476 PERL_ARGS_ASSERT_SV_GROW;
1478 if (PL_madskills && newlen >= 0x100000) {
1479 PerlIO_printf(Perl_debug_log,
1480 "Allocation too large: %"UVxf"\n", (UV)newlen);
1482 #ifdef HAS_64K_LIMIT
1483 if (newlen >= 0x10000) {
1484 PerlIO_printf(Perl_debug_log,
1485 "Allocation too large: %"UVxf"\n", (UV)newlen);
1488 #endif /* HAS_64K_LIMIT */
1491 if (SvTYPE(sv) < SVt_PV) {
1492 sv_upgrade(sv, SVt_PV);
1493 s = SvPVX_mutable(sv);
1495 else if (SvOOK(sv)) { /* pv is offset? */
1497 s = SvPVX_mutable(sv);
1498 if (newlen > SvLEN(sv))
1499 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1500 #ifdef HAS_64K_LIMIT
1501 if (newlen >= 0x10000)
1506 s = SvPVX_mutable(sv);
1508 if (newlen > SvLEN(sv)) { /* need more room? */
1509 STRLEN minlen = SvCUR(sv);
1510 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1511 if (newlen < minlen)
1513 #ifndef Perl_safesysmalloc_size
1514 newlen = PERL_STRLEN_ROUNDUP(newlen);
1516 if (SvLEN(sv) && s) {
1517 s = (char*)saferealloc(s, newlen);
1520 s = (char*)safemalloc(newlen);
1521 if (SvPVX_const(sv) && SvCUR(sv)) {
1522 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1526 #ifdef Perl_safesysmalloc_size
1527 /* Do this here, do it once, do it right, and then we will never get
1528 called back into sv_grow() unless there really is some growing
1530 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1532 SvLEN_set(sv, newlen);
1539 =for apidoc sv_setiv
1541 Copies an integer into the given SV, upgrading first if necessary.
1542 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1548 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1552 PERL_ARGS_ASSERT_SV_SETIV;
1554 SV_CHECK_THINKFIRST_COW_DROP(sv);
1555 switch (SvTYPE(sv)) {
1558 sv_upgrade(sv, SVt_IV);
1561 sv_upgrade(sv, SVt_PVIV);
1565 if (!isGV_with_GP(sv))
1572 /* diag_listed_as: Can't coerce %s to %s in %s */
1573 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1577 (void)SvIOK_only(sv); /* validate number */
1583 =for apidoc sv_setiv_mg
1585 Like C<sv_setiv>, but also handles 'set' magic.
1591 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1593 PERL_ARGS_ASSERT_SV_SETIV_MG;
1600 =for apidoc sv_setuv
1602 Copies an unsigned integer into the given SV, upgrading first if necessary.
1603 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1609 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1611 PERL_ARGS_ASSERT_SV_SETUV;
1613 /* With the if statement to ensure that integers are stored as IVs whenever
1615 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1618 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1620 If you wish to remove the following if statement, so that this routine
1621 (and its callers) always return UVs, please benchmark to see what the
1622 effect is. Modern CPUs may be different. Or may not :-)
1624 if (u <= (UV)IV_MAX) {
1625 sv_setiv(sv, (IV)u);
1634 =for apidoc sv_setuv_mg
1636 Like C<sv_setuv>, but also handles 'set' magic.
1642 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1644 PERL_ARGS_ASSERT_SV_SETUV_MG;
1651 =for apidoc sv_setnv
1653 Copies a double into the given SV, upgrading first if necessary.
1654 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1660 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1664 PERL_ARGS_ASSERT_SV_SETNV;
1666 SV_CHECK_THINKFIRST_COW_DROP(sv);
1667 switch (SvTYPE(sv)) {
1670 sv_upgrade(sv, SVt_NV);
1674 sv_upgrade(sv, SVt_PVNV);
1678 if (!isGV_with_GP(sv))
1685 /* diag_listed_as: Can't coerce %s to %s in %s */
1686 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1691 (void)SvNOK_only(sv); /* validate number */
1696 =for apidoc sv_setnv_mg
1698 Like C<sv_setnv>, but also handles 'set' magic.
1704 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1706 PERL_ARGS_ASSERT_SV_SETNV_MG;
1712 /* Print an "isn't numeric" warning, using a cleaned-up,
1713 * printable version of the offending string
1717 S_not_a_number(pTHX_ SV *const sv)
1724 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1727 dsv = newSVpvs_flags("", SVs_TEMP);
1728 pv = sv_uni_display(dsv, sv, 10, UNI_DISPLAY_ISPRINT);
1731 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1732 /* each *s can expand to 4 chars + "...\0",
1733 i.e. need room for 8 chars */
1735 const char *s = SvPVX_const(sv);
1736 const char * const end = s + SvCUR(sv);
1737 for ( ; s < end && d < limit; s++ ) {
1739 if (ch & 128 && !isPRINT_LC(ch)) {
1748 else if (ch == '\r') {
1752 else if (ch == '\f') {
1756 else if (ch == '\\') {
1760 else if (ch == '\0') {
1764 else if (isPRINT_LC(ch))
1781 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1782 /* diag_listed_as: Argument "%s" isn't numeric%s */
1783 "Argument \"%s\" isn't numeric in %s", pv,
1786 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1787 /* diag_listed_as: Argument "%s" isn't numeric%s */
1788 "Argument \"%s\" isn't numeric", pv);
1792 =for apidoc looks_like_number
1794 Test if the content of an SV looks like a number (or is a number).
1795 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1796 non-numeric warning), even if your atof() doesn't grok them. Get-magic is
1803 Perl_looks_like_number(pTHX_ SV *const sv)
1805 register const char *sbegin;
1808 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1810 if (SvPOK(sv) || SvPOKp(sv)) {
1811 sbegin = SvPV_nomg_const(sv, len);
1814 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1815 return grok_number(sbegin, len, NULL);
1819 S_glob_2number(pTHX_ GV * const gv)
1821 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1823 /* We know that all GVs stringify to something that is not-a-number,
1824 so no need to test that. */
1825 if (ckWARN(WARN_NUMERIC))
1827 SV *const buffer = sv_newmortal();
1828 gv_efullname3(buffer, gv, "*");
1829 not_a_number(buffer);
1831 /* We just want something true to return, so that S_sv_2iuv_common
1832 can tail call us and return true. */
1836 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1837 until proven guilty, assume that things are not that bad... */
1842 As 64 bit platforms often have an NV that doesn't preserve all bits of
1843 an IV (an assumption perl has been based on to date) it becomes necessary
1844 to remove the assumption that the NV always carries enough precision to
1845 recreate the IV whenever needed, and that the NV is the canonical form.
1846 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1847 precision as a side effect of conversion (which would lead to insanity
1848 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1849 1) to distinguish between IV/UV/NV slots that have cached a valid
1850 conversion where precision was lost and IV/UV/NV slots that have a
1851 valid conversion which has lost no precision
1852 2) to ensure that if a numeric conversion to one form is requested that
1853 would lose precision, the precise conversion (or differently
1854 imprecise conversion) is also performed and cached, to prevent
1855 requests for different numeric formats on the same SV causing
1856 lossy conversion chains. (lossless conversion chains are perfectly
1861 SvIOKp is true if the IV slot contains a valid value
1862 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1863 SvNOKp is true if the NV slot contains a valid value
1864 SvNOK is true only if the NV value is accurate
1867 while converting from PV to NV, check to see if converting that NV to an
1868 IV(or UV) would lose accuracy over a direct conversion from PV to
1869 IV(or UV). If it would, cache both conversions, return NV, but mark
1870 SV as IOK NOKp (ie not NOK).
1872 While converting from PV to IV, check to see if converting that IV to an
1873 NV would lose accuracy over a direct conversion from PV to NV. If it
1874 would, cache both conversions, flag similarly.
1876 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1877 correctly because if IV & NV were set NV *always* overruled.
1878 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1879 changes - now IV and NV together means that the two are interchangeable:
1880 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1882 The benefit of this is that operations such as pp_add know that if
1883 SvIOK is true for both left and right operands, then integer addition
1884 can be used instead of floating point (for cases where the result won't
1885 overflow). Before, floating point was always used, which could lead to
1886 loss of precision compared with integer addition.
1888 * making IV and NV equal status should make maths accurate on 64 bit
1890 * may speed up maths somewhat if pp_add and friends start to use
1891 integers when possible instead of fp. (Hopefully the overhead in
1892 looking for SvIOK and checking for overflow will not outweigh the
1893 fp to integer speedup)
1894 * will slow down integer operations (callers of SvIV) on "inaccurate"
1895 values, as the change from SvIOK to SvIOKp will cause a call into
1896 sv_2iv each time rather than a macro access direct to the IV slot
1897 * should speed up number->string conversion on integers as IV is
1898 favoured when IV and NV are equally accurate
1900 ####################################################################
1901 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1902 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1903 On the other hand, SvUOK is true iff UV.
1904 ####################################################################
1906 Your mileage will vary depending your CPU's relative fp to integer
1910 #ifndef NV_PRESERVES_UV
1911 # define IS_NUMBER_UNDERFLOW_IV 1
1912 # define IS_NUMBER_UNDERFLOW_UV 2
1913 # define IS_NUMBER_IV_AND_UV 2
1914 # define IS_NUMBER_OVERFLOW_IV 4
1915 # define IS_NUMBER_OVERFLOW_UV 5
1917 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1919 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1921 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1929 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1931 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));
1932 if (SvNVX(sv) < (NV)IV_MIN) {
1933 (void)SvIOKp_on(sv);
1935 SvIV_set(sv, IV_MIN);
1936 return IS_NUMBER_UNDERFLOW_IV;
1938 if (SvNVX(sv) > (NV)UV_MAX) {
1939 (void)SvIOKp_on(sv);
1942 SvUV_set(sv, UV_MAX);
1943 return IS_NUMBER_OVERFLOW_UV;
1945 (void)SvIOKp_on(sv);
1947 /* Can't use strtol etc to convert this string. (See truth table in
1949 if (SvNVX(sv) <= (UV)IV_MAX) {
1950 SvIV_set(sv, I_V(SvNVX(sv)));
1951 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1952 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1954 /* Integer is imprecise. NOK, IOKp */
1956 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1959 SvUV_set(sv, U_V(SvNVX(sv)));
1960 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1961 if (SvUVX(sv) == UV_MAX) {
1962 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1963 possibly be preserved by NV. Hence, it must be overflow.
1965 return IS_NUMBER_OVERFLOW_UV;
1967 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1969 /* Integer is imprecise. NOK, IOKp */
1971 return IS_NUMBER_OVERFLOW_IV;
1973 #endif /* !NV_PRESERVES_UV*/
1976 S_sv_2iuv_common(pTHX_ SV *const sv)
1980 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1983 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1984 * without also getting a cached IV/UV from it at the same time
1985 * (ie PV->NV conversion should detect loss of accuracy and cache
1986 * IV or UV at same time to avoid this. */
1987 /* IV-over-UV optimisation - choose to cache IV if possible */
1989 if (SvTYPE(sv) == SVt_NV)
1990 sv_upgrade(sv, SVt_PVNV);
1992 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1993 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1994 certainly cast into the IV range at IV_MAX, whereas the correct
1995 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1997 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1998 if (Perl_isnan(SvNVX(sv))) {
2004 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2005 SvIV_set(sv, I_V(SvNVX(sv)));
2006 if (SvNVX(sv) == (NV) SvIVX(sv)
2007 #ifndef NV_PRESERVES_UV
2008 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2009 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2010 /* Don't flag it as "accurately an integer" if the number
2011 came from a (by definition imprecise) NV operation, and
2012 we're outside the range of NV integer precision */
2016 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2018 /* scalar has trailing garbage, eg "42a" */
2020 DEBUG_c(PerlIO_printf(Perl_debug_log,
2021 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2027 /* IV not precise. No need to convert from PV, as NV
2028 conversion would already have cached IV if it detected
2029 that PV->IV would be better than PV->NV->IV
2030 flags already correct - don't set public IOK. */
2031 DEBUG_c(PerlIO_printf(Perl_debug_log,
2032 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2037 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2038 but the cast (NV)IV_MIN rounds to a the value less (more
2039 negative) than IV_MIN which happens to be equal to SvNVX ??
2040 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2041 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2042 (NV)UVX == NVX are both true, but the values differ. :-(
2043 Hopefully for 2s complement IV_MIN is something like
2044 0x8000000000000000 which will be exact. NWC */
2047 SvUV_set(sv, U_V(SvNVX(sv)));
2049 (SvNVX(sv) == (NV) SvUVX(sv))
2050 #ifndef NV_PRESERVES_UV
2051 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2052 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2053 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2054 /* Don't flag it as "accurately an integer" if the number
2055 came from a (by definition imprecise) NV operation, and
2056 we're outside the range of NV integer precision */
2062 DEBUG_c(PerlIO_printf(Perl_debug_log,
2063 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2069 else if (SvPOKp(sv) && SvLEN(sv)) {
2071 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2072 /* We want to avoid a possible problem when we cache an IV/ a UV which
2073 may be later translated to an NV, and the resulting NV is not
2074 the same as the direct translation of the initial string
2075 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2076 be careful to ensure that the value with the .456 is around if the
2077 NV value is requested in the future).
2079 This means that if we cache such an IV/a UV, we need to cache the
2080 NV as well. Moreover, we trade speed for space, and do not
2081 cache the NV if we are sure it's not needed.
2084 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2085 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2086 == IS_NUMBER_IN_UV) {
2087 /* It's definitely an integer, only upgrade to PVIV */
2088 if (SvTYPE(sv) < SVt_PVIV)
2089 sv_upgrade(sv, SVt_PVIV);
2091 } else if (SvTYPE(sv) < SVt_PVNV)
2092 sv_upgrade(sv, SVt_PVNV);
2094 /* If NVs preserve UVs then we only use the UV value if we know that
2095 we aren't going to call atof() below. If NVs don't preserve UVs
2096 then the value returned may have more precision than atof() will
2097 return, even though value isn't perfectly accurate. */
2098 if ((numtype & (IS_NUMBER_IN_UV
2099 #ifdef NV_PRESERVES_UV
2102 )) == IS_NUMBER_IN_UV) {
2103 /* This won't turn off the public IOK flag if it was set above */
2104 (void)SvIOKp_on(sv);
2106 if (!(numtype & IS_NUMBER_NEG)) {
2108 if (value <= (UV)IV_MAX) {
2109 SvIV_set(sv, (IV)value);
2111 /* it didn't overflow, and it was positive. */
2112 SvUV_set(sv, value);
2116 /* 2s complement assumption */
2117 if (value <= (UV)IV_MIN) {
2118 SvIV_set(sv, -(IV)value);
2120 /* Too negative for an IV. This is a double upgrade, but
2121 I'm assuming it will be rare. */
2122 if (SvTYPE(sv) < SVt_PVNV)
2123 sv_upgrade(sv, SVt_PVNV);
2127 SvNV_set(sv, -(NV)value);
2128 SvIV_set(sv, IV_MIN);
2132 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2133 will be in the previous block to set the IV slot, and the next
2134 block to set the NV slot. So no else here. */
2136 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2137 != IS_NUMBER_IN_UV) {
2138 /* It wasn't an (integer that doesn't overflow the UV). */
2139 SvNV_set(sv, Atof(SvPVX_const(sv)));
2141 if (! numtype && ckWARN(WARN_NUMERIC))
2144 #if defined(USE_LONG_DOUBLE)
2145 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2146 PTR2UV(sv), SvNVX(sv)));
2148 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2149 PTR2UV(sv), SvNVX(sv)));
2152 #ifdef NV_PRESERVES_UV
2153 (void)SvIOKp_on(sv);
2155 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2156 SvIV_set(sv, I_V(SvNVX(sv)));
2157 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2160 NOOP; /* Integer is imprecise. NOK, IOKp */
2162 /* UV will not work better than IV */
2164 if (SvNVX(sv) > (NV)UV_MAX) {
2166 /* Integer is inaccurate. NOK, IOKp, is UV */
2167 SvUV_set(sv, UV_MAX);
2169 SvUV_set(sv, U_V(SvNVX(sv)));
2170 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2171 NV preservse UV so can do correct comparison. */
2172 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2175 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2180 #else /* NV_PRESERVES_UV */
2181 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2182 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2183 /* The IV/UV slot will have been set from value returned by
2184 grok_number above. The NV slot has just been set using
2187 assert (SvIOKp(sv));
2189 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2190 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2191 /* Small enough to preserve all bits. */
2192 (void)SvIOKp_on(sv);
2194 SvIV_set(sv, I_V(SvNVX(sv)));
2195 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2197 /* Assumption: first non-preserved integer is < IV_MAX,
2198 this NV is in the preserved range, therefore: */
2199 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2201 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);
2205 0 0 already failed to read UV.
2206 0 1 already failed to read UV.
2207 1 0 you won't get here in this case. IV/UV
2208 slot set, public IOK, Atof() unneeded.
2209 1 1 already read UV.
2210 so there's no point in sv_2iuv_non_preserve() attempting
2211 to use atol, strtol, strtoul etc. */
2213 sv_2iuv_non_preserve (sv, numtype);
2215 sv_2iuv_non_preserve (sv);
2219 #endif /* NV_PRESERVES_UV */
2220 /* It might be more code efficient to go through the entire logic above
2221 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2222 gets complex and potentially buggy, so more programmer efficient
2223 to do it this way, by turning off the public flags: */
2225 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2229 if (isGV_with_GP(sv))
2230 return glob_2number(MUTABLE_GV(sv));
2232 if (!SvPADTMP(sv)) {
2233 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2236 if (SvTYPE(sv) < SVt_IV)
2237 /* Typically the caller expects that sv_any is not NULL now. */
2238 sv_upgrade(sv, SVt_IV);
2239 /* Return 0 from the caller. */
2246 =for apidoc sv_2iv_flags
2248 Return the integer value of an SV, doing any necessary string
2249 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2250 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2256 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2261 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2262 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2263 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2264 In practice they are extremely unlikely to actually get anywhere
2265 accessible by user Perl code - the only way that I'm aware of is when
2266 a constant subroutine which is used as the second argument to index.
2268 if (flags & SV_GMAGIC)
2273 return I_V(SvNVX(sv));
2275 if (SvPOKp(sv) && SvLEN(sv)) {
2278 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2281 == IS_NUMBER_IN_UV) {
2282 /* It's definitely an integer */
2283 if (numtype & IS_NUMBER_NEG) {
2284 if (value < (UV)IV_MIN)
2287 if (value < (UV)IV_MAX)
2292 if (ckWARN(WARN_NUMERIC))
2295 return I_V(Atof(SvPVX_const(sv)));
2300 assert(SvTYPE(sv) >= SVt_PVMG);
2301 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2302 } else if (SvTHINKFIRST(sv)) {
2307 if (flags & SV_SKIP_OVERLOAD)
2309 tmpstr = AMG_CALLunary(sv, numer_amg);
2310 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2311 return SvIV(tmpstr);
2314 return PTR2IV(SvRV(sv));
2317 sv_force_normal_flags(sv, 0);
2319 if (SvREADONLY(sv) && !SvOK(sv)) {
2320 if (ckWARN(WARN_UNINITIALIZED))
2326 if (S_sv_2iuv_common(aTHX_ sv))
2329 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2330 PTR2UV(sv),SvIVX(sv)));
2331 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2335 =for apidoc sv_gmagical_2iv_please
2337 Used internally by C<SvIV_please_nomg>, this function sets the C<SvIVX>
2338 slot if C<sv_2iv> would have made the scalar C<SvIOK> had it not been
2339 magical. In that case it returns true.
2345 Perl_sv_gmagical_2iv_please(pTHX_ register SV *sv)
2348 PERL_ARGS_ASSERT_SV_GMAGICAL_2IV_PLEASE;
2349 assert(SvGMAGICAL(sv) && !SvIOKp(sv) && (SvNOKp(sv) || SvPOKp(sv)));
2350 if (S_sv_2iuv_common(aTHX_ sv)) { SvNIOK_off(sv); return 0; }
2351 has_int = !!SvIOK(sv);
2352 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2357 =for apidoc sv_2uv_flags
2359 Return the unsigned integer value of an SV, doing any necessary string
2360 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2361 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2367 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2372 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2373 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2374 the same flag bit as SVf_IVisUV, so must not let them cache IVs. */
2375 if (flags & SV_GMAGIC)
2380 return U_V(SvNVX(sv));
2381 if (SvPOKp(sv) && SvLEN(sv)) {
2384 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2386 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2387 == IS_NUMBER_IN_UV) {
2388 /* It's definitely an integer */
2389 if (!(numtype & IS_NUMBER_NEG))
2393 if (ckWARN(WARN_NUMERIC))
2396 return U_V(Atof(SvPVX_const(sv)));
2401 assert(SvTYPE(sv) >= SVt_PVMG);
2402 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2403 } else if (SvTHINKFIRST(sv)) {
2408 if (flags & SV_SKIP_OVERLOAD)
2410 tmpstr = AMG_CALLunary(sv, numer_amg);
2411 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2412 return SvUV(tmpstr);
2415 return PTR2UV(SvRV(sv));
2418 sv_force_normal_flags(sv, 0);
2420 if (SvREADONLY(sv) && !SvOK(sv)) {
2421 if (ckWARN(WARN_UNINITIALIZED))
2427 if (S_sv_2iuv_common(aTHX_ sv))
2431 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2432 PTR2UV(sv),SvUVX(sv)));
2433 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2437 =for apidoc sv_2nv_flags
2439 Return the num value of an SV, doing any necessary string or integer
2440 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2441 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2447 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2452 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2453 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2454 the same flag bit as SVf_IVisUV, so must not let them cache NVs. */
2455 if (flags & SV_GMAGIC)
2459 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2460 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2461 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2463 return Atof(SvPVX_const(sv));
2467 return (NV)SvUVX(sv);
2469 return (NV)SvIVX(sv);
2474 assert(SvTYPE(sv) >= SVt_PVMG);
2475 /* This falls through to the report_uninit near the end of the
2477 } else if (SvTHINKFIRST(sv)) {
2482 if (flags & SV_SKIP_OVERLOAD)
2484 tmpstr = AMG_CALLunary(sv, numer_amg);
2485 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2486 return SvNV(tmpstr);
2489 return PTR2NV(SvRV(sv));
2492 sv_force_normal_flags(sv, 0);
2494 if (SvREADONLY(sv) && !SvOK(sv)) {
2495 if (ckWARN(WARN_UNINITIALIZED))
2500 if (SvTYPE(sv) < SVt_NV) {
2501 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2502 sv_upgrade(sv, SVt_NV);
2503 #ifdef USE_LONG_DOUBLE
2505 STORE_NUMERIC_LOCAL_SET_STANDARD();
2506 PerlIO_printf(Perl_debug_log,
2507 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2508 PTR2UV(sv), SvNVX(sv));
2509 RESTORE_NUMERIC_LOCAL();
2513 STORE_NUMERIC_LOCAL_SET_STANDARD();
2514 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2515 PTR2UV(sv), SvNVX(sv));
2516 RESTORE_NUMERIC_LOCAL();
2520 else if (SvTYPE(sv) < SVt_PVNV)
2521 sv_upgrade(sv, SVt_PVNV);
2526 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2527 #ifdef NV_PRESERVES_UV
2533 /* Only set the public NV OK flag if this NV preserves the IV */
2534 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2536 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2537 : (SvIVX(sv) == I_V(SvNVX(sv))))
2543 else if (SvPOKp(sv) && SvLEN(sv)) {
2545 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2546 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2548 #ifdef NV_PRESERVES_UV
2549 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2550 == IS_NUMBER_IN_UV) {
2551 /* It's definitely an integer */
2552 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2554 SvNV_set(sv, Atof(SvPVX_const(sv)));
2560 SvNV_set(sv, Atof(SvPVX_const(sv)));
2561 /* Only set the public NV OK flag if this NV preserves the value in
2562 the PV at least as well as an IV/UV would.
2563 Not sure how to do this 100% reliably. */
2564 /* if that shift count is out of range then Configure's test is
2565 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2567 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2568 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2569 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2570 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2571 /* Can't use strtol etc to convert this string, so don't try.
2572 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2575 /* value has been set. It may not be precise. */
2576 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2577 /* 2s complement assumption for (UV)IV_MIN */
2578 SvNOK_on(sv); /* Integer is too negative. */
2583 if (numtype & IS_NUMBER_NEG) {
2584 SvIV_set(sv, -(IV)value);
2585 } else if (value <= (UV)IV_MAX) {
2586 SvIV_set(sv, (IV)value);
2588 SvUV_set(sv, value);
2592 if (numtype & IS_NUMBER_NOT_INT) {
2593 /* I believe that even if the original PV had decimals,
2594 they are lost beyond the limit of the FP precision.
2595 However, neither is canonical, so both only get p
2596 flags. NWC, 2000/11/25 */
2597 /* Both already have p flags, so do nothing */
2599 const NV nv = SvNVX(sv);
2600 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2601 if (SvIVX(sv) == I_V(nv)) {
2604 /* It had no "." so it must be integer. */
2608 /* between IV_MAX and NV(UV_MAX).
2609 Could be slightly > UV_MAX */
2611 if (numtype & IS_NUMBER_NOT_INT) {
2612 /* UV and NV both imprecise. */
2614 const UV nv_as_uv = U_V(nv);
2616 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2625 /* It might be more code efficient to go through the entire logic above
2626 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2627 gets complex and potentially buggy, so more programmer efficient
2628 to do it this way, by turning off the public flags: */
2630 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2631 #endif /* NV_PRESERVES_UV */
2634 if (isGV_with_GP(sv)) {
2635 glob_2number(MUTABLE_GV(sv));
2639 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2641 assert (SvTYPE(sv) >= SVt_NV);
2642 /* Typically the caller expects that sv_any is not NULL now. */
2643 /* XXX Ilya implies that this is a bug in callers that assume this
2644 and ideally should be fixed. */
2647 #if defined(USE_LONG_DOUBLE)
2649 STORE_NUMERIC_LOCAL_SET_STANDARD();
2650 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2651 PTR2UV(sv), SvNVX(sv));
2652 RESTORE_NUMERIC_LOCAL();
2656 STORE_NUMERIC_LOCAL_SET_STANDARD();
2657 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2658 PTR2UV(sv), SvNVX(sv));
2659 RESTORE_NUMERIC_LOCAL();
2668 Return an SV with the numeric value of the source SV, doing any necessary
2669 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2670 access this function.
2676 Perl_sv_2num(pTHX_ register SV *const sv)
2678 PERL_ARGS_ASSERT_SV_2NUM;
2683 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2684 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2685 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2686 return sv_2num(tmpsv);
2688 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2691 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2692 * UV as a string towards the end of buf, and return pointers to start and
2695 * We assume that buf is at least TYPE_CHARS(UV) long.
2699 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2701 char *ptr = buf + TYPE_CHARS(UV);
2702 char * const ebuf = ptr;
2705 PERL_ARGS_ASSERT_UIV_2BUF;
2717 *--ptr = '0' + (char)(uv % 10);
2726 =for apidoc sv_2pv_flags
2728 Returns a pointer to the string value of an SV, and sets *lp to its length.
2729 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2730 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2731 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2737 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2747 if (SvGMAGICAL(sv)) {
2748 if (flags & SV_GMAGIC)
2753 if (flags & SV_MUTABLE_RETURN)
2754 return SvPVX_mutable(sv);
2755 if (flags & SV_CONST_RETURN)
2756 return (char *)SvPVX_const(sv);
2759 if (SvIOKp(sv) || SvNOKp(sv)) {
2760 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2765 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2766 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2767 } else if(SvNVX(sv) == 0.0) {
2772 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2779 SvUPGRADE(sv, SVt_PV);
2782 s = SvGROW_mutable(sv, len + 1);
2785 return (char*)memcpy(s, tbuf, len + 1);
2791 assert(SvTYPE(sv) >= SVt_PVMG);
2792 /* This falls through to the report_uninit near the end of the
2794 } else if (SvTHINKFIRST(sv)) {
2799 if (flags & SV_SKIP_OVERLOAD)
2801 tmpstr = AMG_CALLunary(sv, string_amg);
2802 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2803 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2805 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2809 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2810 if (flags & SV_CONST_RETURN) {
2811 pv = (char *) SvPVX_const(tmpstr);
2813 pv = (flags & SV_MUTABLE_RETURN)
2814 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2817 *lp = SvCUR(tmpstr);
2819 pv = sv_2pv_flags(tmpstr, lp, flags);
2832 SV *const referent = SvRV(sv);
2836 retval = buffer = savepvn("NULLREF", len);
2837 } else if (SvTYPE(referent) == SVt_REGEXP && (
2838 !(PL_curcop->cop_hints & HINT_NO_AMAGIC)
2839 || amagic_is_enabled(string_amg)
2841 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2845 /* If the regex is UTF-8 we want the containing scalar to
2846 have an UTF-8 flag too */
2853 *lp = RX_WRAPLEN(re);
2855 return RX_WRAPPED(re);
2857 const char *const typestr = sv_reftype(referent, 0);
2858 const STRLEN typelen = strlen(typestr);
2859 UV addr = PTR2UV(referent);
2860 const char *stashname = NULL;
2861 STRLEN stashnamelen = 0; /* hush, gcc */
2862 const char *buffer_end;
2864 if (SvOBJECT(referent)) {
2865 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2868 stashname = HEK_KEY(name);
2869 stashnamelen = HEK_LEN(name);
2871 if (HEK_UTF8(name)) {
2877 stashname = "__ANON__";
2880 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2881 + 2 * sizeof(UV) + 2 /* )\0 */;
2883 len = typelen + 3 /* (0x */
2884 + 2 * sizeof(UV) + 2 /* )\0 */;
2887 Newx(buffer, len, char);
2888 buffer_end = retval = buffer + len;
2890 /* Working backwards */
2894 *--retval = PL_hexdigit[addr & 15];
2895 } while (addr >>= 4);
2901 memcpy(retval, typestr, typelen);
2905 retval -= stashnamelen;
2906 memcpy(retval, stashname, stashnamelen);
2908 /* retval may not necessarily have reached the start of the
2910 assert (retval >= buffer);
2912 len = buffer_end - retval - 1; /* -1 for that \0 */
2920 if (SvREADONLY(sv) && !SvOK(sv)) {
2923 if (flags & SV_UNDEF_RETURNS_NULL)
2925 if (ckWARN(WARN_UNINITIALIZED))
2930 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2931 /* I'm assuming that if both IV and NV are equally valid then
2932 converting the IV is going to be more efficient */
2933 const U32 isUIOK = SvIsUV(sv);
2934 char buf[TYPE_CHARS(UV)];
2938 if (SvTYPE(sv) < SVt_PVIV)
2939 sv_upgrade(sv, SVt_PVIV);
2940 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2942 /* inlined from sv_setpvn */
2943 s = SvGROW_mutable(sv, len + 1);
2944 Move(ptr, s, len, char);
2948 else if (SvNOKp(sv)) {
2949 if (SvTYPE(sv) < SVt_PVNV)
2950 sv_upgrade(sv, SVt_PVNV);
2951 if (SvNVX(sv) == 0.0) {
2952 s = SvGROW_mutable(sv, 2);
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 */
2960 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2970 if (isGV_with_GP(sv)) {
2971 GV *const gv = MUTABLE_GV(sv);
2972 SV *const buffer = sv_newmortal();
2974 gv_efullname3(buffer, gv, "*");
2976 assert(SvPOK(buffer));
2978 *lp = SvCUR(buffer);
2980 if ( SvUTF8(buffer) ) SvUTF8_on(sv);
2981 return SvPVX(buffer);
2986 if (flags & SV_UNDEF_RETURNS_NULL)
2988 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2990 if (SvTYPE(sv) < SVt_PV)
2991 /* Typically the caller expects that sv_any is not NULL now. */
2992 sv_upgrade(sv, SVt_PV);
2996 const STRLEN len = s - SvPVX_const(sv);
3002 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3003 PTR2UV(sv),SvPVX_const(sv)));
3004 if (flags & SV_CONST_RETURN)
3005 return (char *)SvPVX_const(sv);
3006 if (flags & SV_MUTABLE_RETURN)
3007 return SvPVX_mutable(sv);
3012 =for apidoc sv_copypv
3014 Copies a stringified representation of the source SV into the
3015 destination SV. Automatically performs any necessary mg_get and
3016 coercion of numeric values into strings. Guaranteed to preserve
3017 UTF8 flag even from overloaded objects. Similar in nature to
3018 sv_2pv[_flags] but operates directly on an SV instead of just the
3019 string. Mostly uses sv_2pv_flags to do its work, except when that
3020 would lose the UTF-8'ness of the PV.
3026 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3029 const char * const s = SvPV_const(ssv,len);
3031 PERL_ARGS_ASSERT_SV_COPYPV;
3033 sv_setpvn(dsv,s,len);
3041 =for apidoc sv_2pvbyte
3043 Return a pointer to the byte-encoded representation of the SV, and set *lp
3044 to its length. May cause the SV to be downgraded from UTF-8 as a
3047 Usually accessed via the C<SvPVbyte> macro.
3053 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *const lp)
3055 PERL_ARGS_ASSERT_SV_2PVBYTE;
3057 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv)) {
3058 SV *sv2 = sv_newmortal();
3062 else SvGETMAGIC(sv);
3063 sv_utf8_downgrade(sv,0);
3064 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3068 =for apidoc sv_2pvutf8
3070 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3071 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3073 Usually accessed via the C<SvPVutf8> macro.
3079 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *const lp)
3081 PERL_ARGS_ASSERT_SV_2PVUTF8;
3083 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv))
3084 sv = sv_mortalcopy(sv);
3085 sv_utf8_upgrade(sv);
3086 if (SvGMAGICAL(sv)) SvFLAGS(sv) &= ~SVf_POK;
3088 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3093 =for apidoc sv_2bool
3095 This macro is only used by sv_true() or its macro equivalent, and only if
3096 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3097 It calls sv_2bool_flags with the SV_GMAGIC flag.
3099 =for apidoc sv_2bool_flags
3101 This function is only used by sv_true() and friends, and only if
3102 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3103 contain SV_GMAGIC, then it does an mg_get() first.
3110 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3114 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3116 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3122 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3123 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3124 return cBOOL(SvTRUE(tmpsv));
3126 return SvRV(sv) != 0;
3129 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3131 (*sv->sv_u.svu_pv > '0' ||
3132 Xpvtmp->xpv_cur > 1 ||
3133 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3140 return SvIVX(sv) != 0;
3143 return SvNVX(sv) != 0.0;
3145 if (isGV_with_GP(sv))
3155 =for apidoc sv_utf8_upgrade
3157 Converts the PV of an SV to its UTF-8-encoded form.
3158 Forces the SV to string form if it is not already.
3159 Will C<mg_get> on C<sv> if appropriate.
3160 Always sets the SvUTF8 flag to avoid future validity checks even
3161 if the whole string is the same in UTF-8 as not.
3162 Returns the number of bytes in the converted string
3164 This is not as a general purpose byte encoding to Unicode interface:
3165 use the Encode extension for that.
3167 =for apidoc sv_utf8_upgrade_nomg
3169 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3171 =for apidoc sv_utf8_upgrade_flags
3173 Converts the PV of an SV to its UTF-8-encoded form.
3174 Forces the SV to string form if it is not already.
3175 Always sets the SvUTF8 flag to avoid future validity checks even
3176 if all the bytes are invariant in UTF-8.
3177 If C<flags> has C<SV_GMAGIC> bit set,
3178 will C<mg_get> on C<sv> if appropriate, else not.
3179 Returns the number of bytes in the converted string
3180 C<sv_utf8_upgrade> and
3181 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3183 This is not as a general purpose byte encoding to Unicode interface:
3184 use the Encode extension for that.
3188 The grow version is currently not externally documented. It adds a parameter,
3189 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3190 have free after it upon return. This allows the caller to reserve extra space
3191 that it intends to fill, to avoid extra grows.
3193 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3194 which can be used to tell this function to not first check to see if there are
3195 any characters that are different in UTF-8 (variant characters) which would
3196 force it to allocate a new string to sv, but to assume there are. Typically
3197 this flag is used by a routine that has already parsed the string to find that
3198 there are such characters, and passes this information on so that the work
3199 doesn't have to be repeated.
3201 (One might think that the calling routine could pass in the position of the
3202 first such variant, so it wouldn't have to be found again. But that is not the
3203 case, because typically when the caller is likely to use this flag, it won't be
3204 calling this routine unless it finds something that won't fit into a byte.
3205 Otherwise it tries to not upgrade and just use bytes. But some things that
3206 do fit into a byte are variants in utf8, and the caller may not have been
3207 keeping track of these.)
3209 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3210 isn't guaranteed due to having other routines do the work in some input cases,
3211 or if the input is already flagged as being in utf8.
3213 The speed of this could perhaps be improved for many cases if someone wanted to
3214 write a fast function that counts the number of variant characters in a string,
3215 especially if it could return the position of the first one.
3220 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3224 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3226 if (sv == &PL_sv_undef)
3230 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3231 (void) sv_2pv_flags(sv,&len, flags);
3233 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3237 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3242 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3247 sv_force_normal_flags(sv, 0);
3250 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3251 sv_recode_to_utf8(sv, PL_encoding);
3252 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3256 if (SvCUR(sv) == 0) {
3257 if (extra) SvGROW(sv, extra);
3258 } else { /* Assume Latin-1/EBCDIC */
3259 /* This function could be much more efficient if we
3260 * had a FLAG in SVs to signal if there are any variant
3261 * chars in the PV. Given that there isn't such a flag
3262 * make the loop as fast as possible (although there are certainly ways
3263 * to speed this up, eg. through vectorization) */
3264 U8 * s = (U8 *) SvPVX_const(sv);
3265 U8 * e = (U8 *) SvEND(sv);
3267 STRLEN two_byte_count = 0;
3269 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3271 /* See if really will need to convert to utf8. We mustn't rely on our
3272 * incoming SV being well formed and having a trailing '\0', as certain
3273 * code in pp_formline can send us partially built SVs. */
3277 if (NATIVE_IS_INVARIANT(ch)) continue;
3279 t--; /* t already incremented; re-point to first variant */
3284 /* utf8 conversion not needed because all are invariants. Mark as
3285 * UTF-8 even if no variant - saves scanning loop */
3287 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3292 /* Here, the string should be converted to utf8, either because of an
3293 * input flag (two_byte_count = 0), or because a character that
3294 * requires 2 bytes was found (two_byte_count = 1). t points either to
3295 * the beginning of the string (if we didn't examine anything), or to
3296 * the first variant. In either case, everything from s to t - 1 will
3297 * occupy only 1 byte each on output.
3299 * There are two main ways to convert. One is to create a new string
3300 * and go through the input starting from the beginning, appending each
3301 * converted value onto the new string as we go along. It's probably
3302 * best to allocate enough space in the string for the worst possible
3303 * case rather than possibly running out of space and having to
3304 * reallocate and then copy what we've done so far. Since everything
3305 * from s to t - 1 is invariant, the destination can be initialized
3306 * with these using a fast memory copy
3308 * The other way is to figure out exactly how big the string should be
3309 * by parsing the entire input. Then you don't have to make it big
3310 * enough to handle the worst possible case, and more importantly, if
3311 * the string you already have is large enough, you don't have to
3312 * allocate a new string, you can copy the last character in the input
3313 * string to the final position(s) that will be occupied by the
3314 * converted string and go backwards, stopping at t, since everything
3315 * before that is invariant.
3317 * There are advantages and disadvantages to each method.
3319 * In the first method, we can allocate a new string, do the memory
3320 * copy from the s to t - 1, and then proceed through the rest of the
3321 * string byte-by-byte.
3323 * In the second method, we proceed through the rest of the input
3324 * string just calculating how big the converted string will be. Then
3325 * there are two cases:
3326 * 1) if the string has enough extra space to handle the converted
3327 * value. We go backwards through the string, converting until we
3328 * get to the position we are at now, and then stop. If this
3329 * position is far enough along in the string, this method is
3330 * faster than the other method. If the memory copy were the same
3331 * speed as the byte-by-byte loop, that position would be about
3332 * half-way, as at the half-way mark, parsing to the end and back
3333 * is one complete string's parse, the same amount as starting
3334 * over and going all the way through. Actually, it would be
3335 * somewhat less than half-way, as it's faster to just count bytes
3336 * than to also copy, and we don't have the overhead of allocating
3337 * a new string, changing the scalar to use it, and freeing the
3338 * existing one. But if the memory copy is fast, the break-even
3339 * point is somewhere after half way. The counting loop could be
3340 * sped up by vectorization, etc, to move the break-even point
3341 * further towards the beginning.
3342 * 2) if the string doesn't have enough space to handle the converted
3343 * value. A new string will have to be allocated, and one might
3344 * as well, given that, start from the beginning doing the first
3345 * method. We've spent extra time parsing the string and in
3346 * exchange all we've gotten is that we know precisely how big to
3347 * make the new one. Perl is more optimized for time than space,
3348 * so this case is a loser.
3349 * So what I've decided to do is not use the 2nd method unless it is
3350 * guaranteed that a new string won't have to be allocated, assuming
3351 * the worst case. I also decided not to put any more conditions on it
3352 * than this, for now. It seems likely that, since the worst case is
3353 * twice as big as the unknown portion of the string (plus 1), we won't
3354 * be guaranteed enough space, causing us to go to the first method,
3355 * unless the string is short, or the first variant character is near
3356 * the end of it. In either of these cases, it seems best to use the
3357 * 2nd method. The only circumstance I can think of where this would
3358 * be really slower is if the string had once had much more data in it
3359 * than it does now, but there is still a substantial amount in it */
3362 STRLEN invariant_head = t - s;
3363 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3364 if (SvLEN(sv) < size) {
3366 /* Here, have decided to allocate a new string */
3371 Newx(dst, size, U8);
3373 /* If no known invariants at the beginning of the input string,
3374 * set so starts from there. Otherwise, can use memory copy to
3375 * get up to where we are now, and then start from here */
3377 if (invariant_head <= 0) {
3380 Copy(s, dst, invariant_head, char);
3381 d = dst + invariant_head;
3385 const UV uv = NATIVE8_TO_UNI(*t++);
3386 if (UNI_IS_INVARIANT(uv))
3387 *d++ = (U8)UNI_TO_NATIVE(uv);
3389 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3390 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3394 SvPV_free(sv); /* No longer using pre-existing string */
3395 SvPV_set(sv, (char*)dst);
3396 SvCUR_set(sv, d - dst);
3397 SvLEN_set(sv, size);
3400 /* Here, have decided to get the exact size of the string.
3401 * Currently this happens only when we know that there is
3402 * guaranteed enough space to fit the converted string, so
3403 * don't have to worry about growing. If two_byte_count is 0,
3404 * then t points to the first byte of the string which hasn't
3405 * been examined yet. Otherwise two_byte_count is 1, and t
3406 * points to the first byte in the string that will expand to
3407 * two. Depending on this, start examining at t or 1 after t.
3410 U8 *d = t + two_byte_count;
3413 /* Count up the remaining bytes that expand to two */
3416 const U8 chr = *d++;
3417 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3420 /* The string will expand by just the number of bytes that
3421 * occupy two positions. But we are one afterwards because of
3422 * the increment just above. This is the place to put the
3423 * trailing NUL, and to set the length before we decrement */
3425 d += two_byte_count;
3426 SvCUR_set(sv, d - s);
3430 /* Having decremented d, it points to the position to put the
3431 * very last byte of the expanded string. Go backwards through
3432 * the string, copying and expanding as we go, stopping when we
3433 * get to the part that is invariant the rest of the way down */
3437 const U8 ch = NATIVE8_TO_UNI(*e--);
3438 if (UNI_IS_INVARIANT(ch)) {
3439 *d-- = UNI_TO_NATIVE(ch);
3441 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3442 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3447 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3448 /* Update pos. We do it at the end rather than during
3449 * the upgrade, to avoid slowing down the common case
3450 * (upgrade without pos) */
3451 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3453 I32 pos = mg->mg_len;
3454 if (pos > 0 && (U32)pos > invariant_head) {
3455 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3456 STRLEN n = (U32)pos - invariant_head;
3458 if (UTF8_IS_START(*d))
3463 mg->mg_len = d - (U8*)SvPVX(sv);
3466 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3467 magic_setutf8(sv,mg); /* clear UTF8 cache */
3472 /* Mark as UTF-8 even if no variant - saves scanning loop */
3478 =for apidoc sv_utf8_downgrade
3480 Attempts to convert the PV of an SV from characters to bytes.
3481 If the PV contains a character that cannot fit
3482 in a byte, this conversion will fail;
3483 in this case, either returns false or, if C<fail_ok> is not
3486 This is not as a general purpose Unicode to byte encoding interface:
3487 use the Encode extension for that.
3493 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3497 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3499 if (SvPOKp(sv) && SvUTF8(sv)) {
3503 int mg_flags = SV_GMAGIC;
3506 sv_force_normal_flags(sv, 0);
3508 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3510 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3512 I32 pos = mg->mg_len;
3514 sv_pos_b2u(sv, &pos);
3515 mg_flags = 0; /* sv_pos_b2u does get magic */
3519 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3520 magic_setutf8(sv,mg); /* clear UTF8 cache */
3523 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3525 if (!utf8_to_bytes(s, &len)) {
3530 Perl_croak(aTHX_ "Wide character in %s",
3533 Perl_croak(aTHX_ "Wide character");
3544 =for apidoc sv_utf8_encode
3546 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3547 flag off so that it looks like octets again.
3553 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3555 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3557 if (SvREADONLY(sv)) {
3558 sv_force_normal_flags(sv, 0);
3560 (void) sv_utf8_upgrade(sv);
3565 =for apidoc sv_utf8_decode
3567 If the PV of the SV is an octet sequence in UTF-8
3568 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3569 so that it looks like a character. If the PV contains only single-byte
3570 characters, the C<SvUTF8> flag stays off.
3571 Scans PV for validity and returns false if the PV is invalid UTF-8.
3577 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3579 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3582 const U8 *start, *c;
3585 /* The octets may have got themselves encoded - get them back as
3588 if (!sv_utf8_downgrade(sv, TRUE))
3591 /* it is actually just a matter of turning the utf8 flag on, but
3592 * we want to make sure everything inside is valid utf8 first.
3594 c = start = (const U8 *) SvPVX_const(sv);
3595 if (!is_utf8_string(c, SvCUR(sv)))
3597 e = (const U8 *) SvEND(sv);
3600 if (!UTF8_IS_INVARIANT(ch)) {
3605 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3606 /* adjust pos to the start of a UTF8 char sequence */
3607 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3609 I32 pos = mg->mg_len;
3611 for (c = start + pos; c > start; c--) {
3612 if (UTF8_IS_START(*c))
3615 mg->mg_len = c - start;
3618 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3619 magic_setutf8(sv,mg); /* clear UTF8 cache */
3626 =for apidoc sv_setsv
3628 Copies the contents of the source SV C<ssv> into the destination SV
3629 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3630 function if the source SV needs to be reused. Does not handle 'set' magic.
3631 Loosely speaking, it performs a copy-by-value, obliterating any previous
3632 content of the destination.
3634 You probably want to use one of the assortment of wrappers, such as
3635 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3636 C<SvSetMagicSV_nosteal>.
3638 =for apidoc sv_setsv_flags
3640 Copies the contents of the source SV C<ssv> into the destination SV
3641 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3642 function if the source SV needs to be reused. Does not handle 'set' magic.
3643 Loosely speaking, it performs a copy-by-value, obliterating any previous
3644 content of the destination.
3645 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3646 C<ssv> if appropriate, else not. If the C<flags>
3647 parameter has the C<NOSTEAL> bit set then the
3648 buffers of temps will not be stolen. <sv_setsv>
3649 and C<sv_setsv_nomg> are implemented in terms of this function.
3651 You probably want to use one of the assortment of wrappers, such as
3652 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3653 C<SvSetMagicSV_nosteal>.
3655 This is the primary function for copying scalars, and most other
3656 copy-ish functions and macros use this underneath.
3662 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3664 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3665 HV *old_stash = NULL;
3667 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3669 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3670 const char * const name = GvNAME(sstr);
3671 const STRLEN len = GvNAMELEN(sstr);
3673 if (dtype >= SVt_PV) {
3679 SvUPGRADE(dstr, SVt_PVGV);
3680 (void)SvOK_off(dstr);
3681 /* We have to turn this on here, even though we turn it off
3682 below, as GvSTASH will fail an assertion otherwise. */
3683 isGV_with_GP_on(dstr);
3685 GvSTASH(dstr) = GvSTASH(sstr);
3687 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3688 gv_name_set(MUTABLE_GV(dstr), name, len,
3689 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3690 SvFAKE_on(dstr); /* can coerce to non-glob */
3693 if(GvGP(MUTABLE_GV(sstr))) {
3694 /* If source has method cache entry, clear it */
3696 SvREFCNT_dec(GvCV(sstr));
3697 GvCV_set(sstr, NULL);
3700 /* If source has a real method, then a method is
3703 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3709 /* If dest already had a real method, that's a change as well */
3711 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3712 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3717 /* We don't need to check the name of the destination if it was not a
3718 glob to begin with. */
3719 if(dtype == SVt_PVGV) {
3720 const char * const name = GvNAME((const GV *)dstr);
3723 /* The stash may have been detached from the symbol table, so
3725 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3726 && GvAV((const GV *)sstr)
3730 const STRLEN len = GvNAMELEN(dstr);
3731 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3732 || (len == 1 && name[0] == ':')) {
3735 /* Set aside the old stash, so we can reset isa caches on
3737 if((old_stash = GvHV(dstr)))
3738 /* Make sure we do not lose it early. */
3739 SvREFCNT_inc_simple_void_NN(
3740 sv_2mortal((SV *)old_stash)
3746 gp_free(MUTABLE_GV(dstr));
3747 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3748 (void)SvOK_off(dstr);
3749 isGV_with_GP_on(dstr);
3750 GvINTRO_off(dstr); /* one-shot flag */
3751 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3752 if (SvTAINTED(sstr))
3754 if (GvIMPORTED(dstr) != GVf_IMPORTED
3755 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3757 GvIMPORTED_on(dstr);
3760 if(mro_changes == 2) {
3762 SV * const sref = (SV *)GvAV((const GV *)dstr);
3763 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3764 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3765 AV * const ary = newAV();
3766 av_push(ary, mg->mg_obj); /* takes the refcount */
3767 mg->mg_obj = (SV *)ary;
3769 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3771 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3772 mro_isa_changed_in(GvSTASH(dstr));
3774 else if(mro_changes == 3) {
3775 HV * const stash = GvHV(dstr);
3776 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3782 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3787 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3789 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3791 const int intro = GvINTRO(dstr);
3794 const U32 stype = SvTYPE(sref);
3796 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3799 GvINTRO_off(dstr); /* one-shot flag */
3800 GvLINE(dstr) = CopLINE(PL_curcop);
3801 GvEGV(dstr) = MUTABLE_GV(dstr);
3806 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3807 import_flag = GVf_IMPORTED_CV;
3810 location = (SV **) &GvHV(dstr);
3811 import_flag = GVf_IMPORTED_HV;
3814 location = (SV **) &GvAV(dstr);
3815 import_flag = GVf_IMPORTED_AV;
3818 location = (SV **) &GvIOp(dstr);
3821 location = (SV **) &GvFORM(dstr);
3824 location = &GvSV(dstr);
3825 import_flag = GVf_IMPORTED_SV;
3828 if (stype == SVt_PVCV) {
3829 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3830 if (GvCVGEN(dstr)) {
3831 SvREFCNT_dec(GvCV(dstr));
3832 GvCV_set(dstr, NULL);
3833 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3836 SAVEGENERICSV(*location);
3840 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3841 CV* const cv = MUTABLE_CV(*location);
3843 if (!GvCVGEN((const GV *)dstr) &&
3844 (CvROOT(cv) || CvXSUB(cv)) &&
3845 /* redundant check that avoids creating the extra SV
3846 most of the time: */
3847 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3849 SV * const new_const_sv =
3850 CvCONST((const CV *)sref)
3851 ? cv_const_sv((const CV *)sref)
3853 report_redefined_cv(
3854 sv_2mortal(Perl_newSVpvf(aTHX_
3857 HvNAME_HEK(GvSTASH((const GV *)dstr))
3859 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3862 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3866 cv_ckproto_len_flags(cv, (const GV *)dstr,
3867 SvPOK(sref) ? CvPROTO(sref) : NULL,
3868 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3869 SvPOK(sref) ? SvUTF8(sref) : 0);
3871 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3872 GvASSUMECV_on(dstr);
3873 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3876 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3877 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3878 GvFLAGS(dstr) |= import_flag;
3880 if (stype == SVt_PVHV) {
3881 const char * const name = GvNAME((GV*)dstr);
3882 const STRLEN len = GvNAMELEN(dstr);
3885 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3886 || (len == 1 && name[0] == ':')
3888 && (!dref || HvENAME_get(dref))
3891 (HV *)sref, (HV *)dref,
3897 stype == SVt_PVAV && sref != dref
3898 && strEQ(GvNAME((GV*)dstr), "ISA")
3899 /* The stash may have been detached from the symbol table, so
3900 check its name before doing anything. */
3901 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3904 MAGIC * const omg = dref && SvSMAGICAL(dref)
3905 ? mg_find(dref, PERL_MAGIC_isa)
3907 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3908 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3909 AV * const ary = newAV();
3910 av_push(ary, mg->mg_obj); /* takes the refcount */
3911 mg->mg_obj = (SV *)ary;
3914 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3915 SV **svp = AvARRAY((AV *)omg->mg_obj);
3916 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3920 SvREFCNT_inc_simple_NN(*svp++)
3926 SvREFCNT_inc_simple_NN(omg->mg_obj)
3930 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3935 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3937 mg = mg_find(sref, PERL_MAGIC_isa);
3939 /* Since the *ISA assignment could have affected more than
3940 one stash, don't call mro_isa_changed_in directly, but let
3941 magic_clearisa do it for us, as it already has the logic for
3942 dealing with globs vs arrays of globs. */
3944 Perl_magic_clearisa(aTHX_ NULL, mg);
3949 if (SvTAINTED(sstr))
3955 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3958 register U32 sflags;
3960 register svtype stype;
3962 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3967 if (SvIS_FREED(dstr)) {
3968 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3969 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3971 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3973 sstr = &PL_sv_undef;
3974 if (SvIS_FREED(sstr)) {
3975 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3976 (void*)sstr, (void*)dstr);
3978 stype = SvTYPE(sstr);
3979 dtype = SvTYPE(dstr);
3983 /* need to nuke the magic */
3984 sv_unmagic(dstr, PERL_MAGIC_vstring);
3987 /* There's a lot of redundancy below but we're going for speed here */
3992 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3993 (void)SvOK_off(dstr);
4001 sv_upgrade(dstr, SVt_IV);
4005 sv_upgrade(dstr, SVt_PVIV);
4009 goto end_of_first_switch;
4011 (void)SvIOK_only(dstr);
4012 SvIV_set(dstr, SvIVX(sstr));
4015 /* SvTAINTED can only be true if the SV has taint magic, which in
4016 turn means that the SV type is PVMG (or greater). This is the
4017 case statement for SVt_IV, so this cannot be true (whatever gcov
4019 assert(!SvTAINTED(sstr));
4024 if (dtype < SVt_PV && dtype != SVt_IV)
4025 sv_upgrade(dstr, SVt_IV);
4033 sv_upgrade(dstr, SVt_NV);
4037 sv_upgrade(dstr, SVt_PVNV);
4041 goto end_of_first_switch;
4043 SvNV_set(dstr, SvNVX(sstr));
4044 (void)SvNOK_only(dstr);
4045 /* SvTAINTED can only be true if the SV has taint magic, which in
4046 turn means that the SV type is PVMG (or greater). This is the
4047 case statement for SVt_NV, so this cannot be true (whatever gcov
4049 assert(!SvTAINTED(sstr));
4055 #ifdef PERL_OLD_COPY_ON_WRITE
4056 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4057 if (dtype < SVt_PVIV)
4058 sv_upgrade(dstr, SVt_PVIV);
4065 sv_upgrade(dstr, SVt_PV);
4068 if (dtype < SVt_PVIV)
4069 sv_upgrade(dstr, SVt_PVIV);
4072 if (dtype < SVt_PVNV)
4073 sv_upgrade(dstr, SVt_PVNV);
4077 const char * const type = sv_reftype(sstr,0);
4079 /* diag_listed_as: Bizarre copy of %s */
4080 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4082 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4087 if (dtype < SVt_REGEXP)
4088 sv_upgrade(dstr, SVt_REGEXP);
4091 /* case SVt_BIND: */
4095 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4097 if (SvTYPE(sstr) != stype)
4098 stype = SvTYPE(sstr);
4100 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4101 glob_assign_glob(dstr, sstr, dtype);
4104 if (stype == SVt_PVLV)
4105 SvUPGRADE(dstr, SVt_PVNV);
4107 SvUPGRADE(dstr, (svtype)stype);
4109 end_of_first_switch:
4111 /* dstr may have been upgraded. */
4112 dtype = SvTYPE(dstr);
4113 sflags = SvFLAGS(sstr);
4115 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4116 /* Assigning to a subroutine sets the prototype. */
4119 const char *const ptr = SvPV_const(sstr, len);
4121 SvGROW(dstr, len + 1);
4122 Copy(ptr, SvPVX(dstr), len + 1, char);
4123 SvCUR_set(dstr, len);
4125 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4126 CvAUTOLOAD_off(dstr);
4130 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4131 const char * const type = sv_reftype(dstr,0);
4133 /* diag_listed_as: Cannot copy to %s */
4134 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4136 Perl_croak(aTHX_ "Cannot copy to %s", type);
4137 } else if (sflags & SVf_ROK) {
4138 if (isGV_with_GP(dstr)
4139 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4142 if (GvIMPORTED(dstr) != GVf_IMPORTED
4143 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4145 GvIMPORTED_on(dstr);
4150 glob_assign_glob(dstr, sstr, dtype);
4154 if (dtype >= SVt_PV) {
4155 if (isGV_with_GP(dstr)) {
4156 glob_assign_ref(dstr, sstr);
4159 if (SvPVX_const(dstr)) {
4165 (void)SvOK_off(dstr);
4166 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4167 SvFLAGS(dstr) |= sflags & SVf_ROK;
4168 assert(!(sflags & SVp_NOK));
4169 assert(!(sflags & SVp_IOK));
4170 assert(!(sflags & SVf_NOK));
4171 assert(!(sflags & SVf_IOK));
4173 else if (isGV_with_GP(dstr)) {
4174 if (!(sflags & SVf_OK)) {
4175 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4176 "Undefined value assigned to typeglob");
4179 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4180 if (dstr != (const SV *)gv) {
4181 const char * const name = GvNAME((const GV *)dstr);
4182 const STRLEN len = GvNAMELEN(dstr);
4183 HV *old_stash = NULL;
4184 bool reset_isa = FALSE;
4185 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4186 || (len == 1 && name[0] == ':')) {
4187 /* Set aside the old stash, so we can reset isa caches
4188 on its subclasses. */
4189 if((old_stash = GvHV(dstr))) {
4190 /* Make sure we do not lose it early. */
4191 SvREFCNT_inc_simple_void_NN(
4192 sv_2mortal((SV *)old_stash)
4199 gp_free(MUTABLE_GV(dstr));
4200 GvGP_set(dstr, gp_ref(GvGP(gv)));
4203 HV * const stash = GvHV(dstr);
4205 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4215 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4216 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4218 else if (sflags & SVp_POK) {
4222 * Check to see if we can just swipe the string. If so, it's a
4223 * possible small lose on short strings, but a big win on long ones.
4224 * It might even be a win on short strings if SvPVX_const(dstr)
4225 * has to be allocated and SvPVX_const(sstr) has to be freed.
4226 * Likewise if we can set up COW rather than doing an actual copy, we
4227 * drop to the else clause, as the swipe code and the COW setup code
4228 * have much in common.
4231 /* Whichever path we take through the next code, we want this true,
4232 and doing it now facilitates the COW check. */
4233 (void)SvPOK_only(dstr);
4236 /* If we're already COW then this clause is not true, and if COW
4237 is allowed then we drop down to the else and make dest COW
4238 with us. If caller hasn't said that we're allowed to COW
4239 shared hash keys then we don't do the COW setup, even if the
4240 source scalar is a shared hash key scalar. */
4241 (((flags & SV_COW_SHARED_HASH_KEYS)
4242 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4243 : 1 /* If making a COW copy is forbidden then the behaviour we
4244 desire is as if the source SV isn't actually already
4245 COW, even if it is. So we act as if the source flags
4246 are not COW, rather than actually testing them. */
4248 #ifndef PERL_OLD_COPY_ON_WRITE
4249 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4250 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4251 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4252 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4253 but in turn, it's somewhat dead code, never expected to go
4254 live, but more kept as a placeholder on how to do it better
4255 in a newer implementation. */
4256 /* If we are COW and dstr is a suitable target then we drop down
4257 into the else and make dest a COW of us. */
4258 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4263 (sflags & SVs_TEMP) && /* slated for free anyway? */
4264 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4265 (!(flags & SV_NOSTEAL)) &&
4266 /* and we're allowed to steal temps */
4267 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4268 SvLEN(sstr)) /* and really is a string */
4269 #ifdef PERL_OLD_COPY_ON_WRITE
4270 && ((flags & SV_COW_SHARED_HASH_KEYS)
4271 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4272 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4273 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4277 /* Failed the swipe test, and it's not a shared hash key either.
4278 Have to copy the string. */
4279 STRLEN len = SvCUR(sstr);
4280 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4281 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4282 SvCUR_set(dstr, len);
4283 *SvEND(dstr) = '\0';
4285 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4287 /* Either it's a shared hash key, or it's suitable for
4288 copy-on-write or we can swipe the string. */
4290 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4294 #ifdef PERL_OLD_COPY_ON_WRITE
4296 if ((sflags & (SVf_FAKE | SVf_READONLY))
4297 != (SVf_FAKE | SVf_READONLY)) {
4298 SvREADONLY_on(sstr);
4300 /* Make the source SV into a loop of 1.
4301 (about to become 2) */
4302 SV_COW_NEXT_SV_SET(sstr, sstr);
4306 /* Initial code is common. */
4307 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4312 /* making another shared SV. */
4313 STRLEN cur = SvCUR(sstr);
4314 STRLEN len = SvLEN(sstr);
4315 #ifdef PERL_OLD_COPY_ON_WRITE
4317 assert (SvTYPE(dstr) >= SVt_PVIV);
4318 /* SvIsCOW_normal */
4319 /* splice us in between source and next-after-source. */
4320 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4321 SV_COW_NEXT_SV_SET(sstr, dstr);
4322 SvPV_set(dstr, SvPVX_mutable(sstr));
4326 /* SvIsCOW_shared_hash */
4327 DEBUG_C(PerlIO_printf(Perl_debug_log,
4328 "Copy on write: Sharing hash\n"));
4330 assert (SvTYPE(dstr) >= SVt_PV);
4332 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4334 SvLEN_set(dstr, len);
4335 SvCUR_set(dstr, cur);
4336 SvREADONLY_on(dstr);
4340 { /* Passes the swipe test. */
4341 SvPV_set(dstr, SvPVX_mutable(sstr));
4342 SvLEN_set(dstr, SvLEN(sstr));
4343 SvCUR_set(dstr, SvCUR(sstr));
4346 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4347 SvPV_set(sstr, NULL);
4353 if (sflags & SVp_NOK) {
4354 SvNV_set(dstr, SvNVX(sstr));
4356 if (sflags & SVp_IOK) {
4357 SvIV_set(dstr, SvIVX(sstr));
4358 /* Must do this otherwise some other overloaded use of 0x80000000
4359 gets confused. I guess SVpbm_VALID */
4360 if (sflags & SVf_IVisUV)
4363 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4365 const MAGIC * const smg = SvVSTRING_mg(sstr);
4367 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4368 smg->mg_ptr, smg->mg_len);
4369 SvRMAGICAL_on(dstr);
4373 else if (sflags & (SVp_IOK|SVp_NOK)) {
4374 (void)SvOK_off(dstr);
4375 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4376 if (sflags & SVp_IOK) {
4377 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4378 SvIV_set(dstr, SvIVX(sstr));
4380 if (sflags & SVp_NOK) {
4381 SvNV_set(dstr, SvNVX(sstr));
4385 if (isGV_with_GP(sstr)) {
4386 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4389 (void)SvOK_off(dstr);
4391 if (SvTAINTED(sstr))
4396 =for apidoc sv_setsv_mg
4398 Like C<sv_setsv>, but also handles 'set' magic.
4404 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4406 PERL_ARGS_ASSERT_SV_SETSV_MG;
4408 sv_setsv(dstr,sstr);
4412 #ifdef PERL_OLD_COPY_ON_WRITE
4414 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4416 STRLEN cur = SvCUR(sstr);
4417 STRLEN len = SvLEN(sstr);
4418 register char *new_pv;
4420 PERL_ARGS_ASSERT_SV_SETSV_COW;
4423 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4424 (void*)sstr, (void*)dstr);
4431 if (SvTHINKFIRST(dstr))
4432 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4433 else if (SvPVX_const(dstr))
4434 Safefree(SvPVX_const(dstr));
4438 SvUPGRADE(dstr, SVt_PVIV);
4440 assert (SvPOK(sstr));
4441 assert (SvPOKp(sstr));
4442 assert (!SvIOK(sstr));
4443 assert (!SvIOKp(sstr));
4444 assert (!SvNOK(sstr));
4445 assert (!SvNOKp(sstr));
4447 if (SvIsCOW(sstr)) {
4449 if (SvLEN(sstr) == 0) {
4450 /* source is a COW shared hash key. */
4451 DEBUG_C(PerlIO_printf(Perl_debug_log,
4452 "Fast copy on write: Sharing hash\n"));
4453 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4456 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4458 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4459 SvUPGRADE(sstr, SVt_PVIV);
4460 SvREADONLY_on(sstr);
4462 DEBUG_C(PerlIO_printf(Perl_debug_log,
4463 "Fast copy on write: Converting sstr to COW\n"));
4464 SV_COW_NEXT_SV_SET(dstr, sstr);
4466 SV_COW_NEXT_SV_SET(sstr, dstr);
4467 new_pv = SvPVX_mutable(sstr);
4470 SvPV_set(dstr, new_pv);
4471 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4474 SvLEN_set(dstr, len);
4475 SvCUR_set(dstr, cur);
4484 =for apidoc sv_setpvn
4486 Copies a string into an SV. The C<len> parameter indicates the number of
4487 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4488 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4494 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4497 register char *dptr;
4499 PERL_ARGS_ASSERT_SV_SETPVN;
4501 SV_CHECK_THINKFIRST_COW_DROP(sv);
4507 /* len is STRLEN which is unsigned, need to copy to signed */
4510 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4513 SvUPGRADE(sv, SVt_PV);
4515 dptr = SvGROW(sv, len + 1);
4516 Move(ptr,dptr,len,char);
4519 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4521 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4525 =for apidoc sv_setpvn_mg
4527 Like C<sv_setpvn>, but also handles 'set' magic.
4533 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4535 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4537 sv_setpvn(sv,ptr,len);
4542 =for apidoc sv_setpv
4544 Copies a string into an SV. The string must be null-terminated. Does not
4545 handle 'set' magic. See C<sv_setpv_mg>.
4551 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4554 register STRLEN len;
4556 PERL_ARGS_ASSERT_SV_SETPV;
4558 SV_CHECK_THINKFIRST_COW_DROP(sv);
4564 SvUPGRADE(sv, SVt_PV);
4566 SvGROW(sv, len + 1);
4567 Move(ptr,SvPVX(sv),len+1,char);
4569 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4571 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4575 =for apidoc sv_setpv_mg
4577 Like C<sv_setpv>, but also handles 'set' magic.
4583 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4585 PERL_ARGS_ASSERT_SV_SETPV_MG;
4592 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4596 PERL_ARGS_ASSERT_SV_SETHEK;
4602 if (HEK_LEN(hek) == HEf_SVKEY) {
4603 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4606 const int flags = HEK_FLAGS(hek);
4607 if (flags & HVhek_WASUTF8) {
4608 STRLEN utf8_len = HEK_LEN(hek);
4609 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4610 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4613 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4614 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4617 else SvUTF8_off(sv);
4621 SV_CHECK_THINKFIRST_COW_DROP(sv);
4622 SvUPGRADE(sv, SVt_PV);
4623 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4624 SvCUR_set(sv, HEK_LEN(hek));
4631 else SvUTF8_off(sv);
4639 =for apidoc sv_usepvn_flags
4641 Tells an SV to use C<ptr> to find its string value. Normally the
4642 string is stored inside the SV but sv_usepvn allows the SV to use an
4643 outside string. The C<ptr> should point to memory that was allocated
4644 by C<malloc>. It must be the start of a mallocked block
4645 of memory, and not a pointer to the middle of it. The
4646 string length, C<len>, must be supplied. By default
4647 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4648 so that pointer should not be freed or used by the programmer after
4649 giving it to sv_usepvn, and neither should any pointers from "behind"
4650 that pointer (e.g. ptr + 1) be used.
4652 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4653 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4654 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4655 C<len>, and already meets the requirements for storing in C<SvPVX>).
4661 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4666 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4668 SV_CHECK_THINKFIRST_COW_DROP(sv);
4669 SvUPGRADE(sv, SVt_PV);
4672 if (flags & SV_SMAGIC)
4676 if (SvPVX_const(sv))
4680 if (flags & SV_HAS_TRAILING_NUL)
4681 assert(ptr[len] == '\0');
4684 allocate = (flags & SV_HAS_TRAILING_NUL)
4686 #ifdef Perl_safesysmalloc_size
4689 PERL_STRLEN_ROUNDUP(len + 1);
4691 if (flags & SV_HAS_TRAILING_NUL) {
4692 /* It's long enough - do nothing.
4693 Specifically Perl_newCONSTSUB is relying on this. */
4696 /* Force a move to shake out bugs in callers. */
4697 char *new_ptr = (char*)safemalloc(allocate);
4698 Copy(ptr, new_ptr, len, char);
4699 PoisonFree(ptr,len,char);
4703 ptr = (char*) saferealloc (ptr, allocate);
4706 #ifdef Perl_safesysmalloc_size
4707 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4709 SvLEN_set(sv, allocate);
4713 if (!(flags & SV_HAS_TRAILING_NUL)) {
4716 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4718 if (flags & SV_SMAGIC)
4722 #ifdef PERL_OLD_COPY_ON_WRITE
4723 /* Need to do this *after* making the SV normal, as we need the buffer
4724 pointer to remain valid until after we've copied it. If we let go too early,
4725 another thread could invalidate it by unsharing last of the same hash key
4726 (which it can do by means other than releasing copy-on-write Svs)
4727 or by changing the other copy-on-write SVs in the loop. */
4729 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4731 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4733 { /* this SV was SvIsCOW_normal(sv) */
4734 /* we need to find the SV pointing to us. */
4735 SV *current = SV_COW_NEXT_SV(after);
4737 if (current == sv) {
4738 /* The SV we point to points back to us (there were only two of us
4740 Hence other SV is no longer copy on write either. */
4742 SvREADONLY_off(after);
4744 /* We need to follow the pointers around the loop. */
4746 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4749 /* don't loop forever if the structure is bust, and we have
4750 a pointer into a closed loop. */
4751 assert (current != after);
4752 assert (SvPVX_const(current) == pvx);
4754 /* Make the SV before us point to the SV after us. */
4755 SV_COW_NEXT_SV_SET(current, after);
4761 =for apidoc sv_force_normal_flags
4763 Undo various types of fakery on an SV: if the PV is a shared string, make
4764 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4765 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4766 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4767 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4768 SvPOK_off rather than making a copy. (Used where this
4769 scalar is about to be set to some other value.) In addition,
4770 the C<flags> parameter gets passed to C<sv_unref_flags()>
4771 when unreffing. C<sv_force_normal> calls this function
4772 with flags set to 0.
4778 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4782 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4784 #ifdef PERL_OLD_COPY_ON_WRITE
4785 if (SvREADONLY(sv)) {
4787 const char * const pvx = SvPVX_const(sv);
4788 const STRLEN len = SvLEN(sv);
4789 const STRLEN cur = SvCUR(sv);
4790 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4791 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4792 we'll fail an assertion. */
4793 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4796 PerlIO_printf(Perl_debug_log,
4797 "Copy on write: Force normal %ld\n",
4803 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4806 if (flags & SV_COW_DROP_PV) {
4807 /* OK, so we don't need to copy our buffer. */
4810 SvGROW(sv, cur + 1);
4811 Move(pvx,SvPVX(sv),cur,char);
4816 sv_release_COW(sv, pvx, next);
4818 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4824 else if (IN_PERL_RUNTIME)
4825 Perl_croak_no_modify(aTHX);
4828 if (SvREADONLY(sv)) {
4830 const char * const pvx = SvPVX_const(sv);
4831 const STRLEN len = SvCUR(sv);
4836 if (flags & SV_COW_DROP_PV) {
4837 /* OK, so we don't need to copy our buffer. */
4840 SvGROW(sv, len + 1);
4841 Move(pvx,SvPVX(sv),len,char);
4844 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4846 else if (IN_PERL_RUNTIME)
4847 Perl_croak_no_modify(aTHX);
4851 sv_unref_flags(sv, flags);
4852 else if (SvFAKE(sv) && isGV_with_GP(sv))
4853 sv_unglob(sv, flags);
4854 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4855 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4856 to sv_unglob. We only need it here, so inline it. */
4857 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4858 SV *const temp = newSV_type(new_type);
4859 void *const temp_p = SvANY(sv);
4861 if (new_type == SVt_PVMG) {
4862 SvMAGIC_set(temp, SvMAGIC(sv));
4863 SvMAGIC_set(sv, NULL);
4864 SvSTASH_set(temp, SvSTASH(sv));
4865 SvSTASH_set(sv, NULL);
4867 SvCUR_set(temp, SvCUR(sv));
4868 /* Remember that SvPVX is in the head, not the body. */
4870 SvLEN_set(temp, SvLEN(sv));
4871 /* This signals "buffer is owned by someone else" in sv_clear,
4872 which is the least effort way to stop it freeing the buffer.
4874 SvLEN_set(sv, SvLEN(sv)+1);
4876 /* Their buffer is already owned by someone else. */
4877 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4878 SvLEN_set(temp, SvCUR(sv)+1);
4881 /* Now swap the rest of the bodies. */
4883 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4884 SvFLAGS(sv) |= new_type;
4885 SvANY(sv) = SvANY(temp);
4887 SvFLAGS(temp) &= ~(SVTYPEMASK);
4888 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4889 SvANY(temp) = temp_p;
4898 Efficient removal of characters from the beginning of the string buffer.
4899 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4900 the string buffer. The C<ptr> becomes the first character of the adjusted
4901 string. Uses the "OOK hack".
4903 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4904 refer to the same chunk of data.
4906 The unfortunate similarity of this function's name to that of Perl's C<chop>
4907 operator is strictly coincidental. This function works from the left;
4908 C<chop> works from the right.
4914 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4925 PERL_ARGS_ASSERT_SV_CHOP;
4927 if (!ptr || !SvPOKp(sv))
4929 delta = ptr - SvPVX_const(sv);
4931 /* Nothing to do. */
4934 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4935 if (delta > max_delta)
4936 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4937 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4938 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4939 SV_CHECK_THINKFIRST(sv);
4942 if (!SvLEN(sv)) { /* make copy of shared string */
4943 const char *pvx = SvPVX_const(sv);
4944 const STRLEN len = SvCUR(sv);
4945 SvGROW(sv, len + 1);
4946 Move(pvx,SvPVX(sv),len,char);
4952 SvOOK_offset(sv, old_delta);
4954 SvLEN_set(sv, SvLEN(sv) - delta);
4955 SvCUR_set(sv, SvCUR(sv) - delta);
4956 SvPV_set(sv, SvPVX(sv) + delta);
4958 p = (U8 *)SvPVX_const(sv);
4961 /* how many bytes were evacuated? we will fill them with sentinel
4962 bytes, except for the part holding the new offset of course. */
4965 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4967 assert(evacn <= delta + old_delta);
4973 if (delta < 0x100) {
4977 p -= sizeof(STRLEN);
4978 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4982 /* Fill the preceding buffer with sentinals to verify that no-one is
4992 =for apidoc sv_catpvn
4994 Concatenates the string onto the end of the string which is in the SV. The
4995 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4996 status set, then the bytes appended should be valid UTF-8.
4997 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4999 =for apidoc sv_catpvn_flags
5001 Concatenates the string onto the end of the string which is in the SV. The
5002 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5003 status set, then the bytes appended should be valid UTF-8.
5004 If C<flags> has the C<SV_SMAGIC> bit set, will
5005 C<mg_set> on C<dsv> afterwards if appropriate.
5006 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5007 in terms of this function.
5013 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
5017 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
5019 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
5020 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
5022 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
5023 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5024 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5027 else SvGROW(dsv, dlen + slen + 1);
5029 sstr = SvPVX_const(dsv);
5030 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5031 SvCUR_set(dsv, SvCUR(dsv) + slen);
5034 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5035 const char * const send = sstr + slen;
5038 /* Something this code does not account for, which I think is
5039 impossible; it would require the same pv to be treated as
5040 bytes *and* utf8, which would indicate a bug elsewhere. */
5041 assert(sstr != dstr);
5043 SvGROW(dsv, dlen + slen * 2 + 1);
5044 d = (U8 *)SvPVX(dsv) + dlen;
5046 while (sstr < send) {
5047 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5048 if (UNI_IS_INVARIANT(uv))
5049 *d++ = (U8)UTF_TO_NATIVE(uv);
5051 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5052 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5055 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5058 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5060 if (flags & SV_SMAGIC)
5065 =for apidoc sv_catsv
5067 Concatenates the string from SV C<ssv> onto the end of the string in
5068 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5069 not 'set' magic. See C<sv_catsv_mg>.
5071 =for apidoc sv_catsv_flags
5073 Concatenates the string from SV C<ssv> onto the end of the string in
5074 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5075 bit set, will C<mg_get> on the C<ssv>, if appropriate, before
5076 reading it. If the C<flags> contain C<SV_SMAGIC>, C<mg_set> will be
5077 called on the modified SV afterward, if appropriate. C<sv_catsv>
5078 and C<sv_catsv_nomg> are implemented in terms of this function.
5083 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5087 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5091 const char *spv = SvPV_flags_const(ssv, slen, flags);
5093 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5095 sv_catpvn_flags(dsv, spv, slen,
5096 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5099 if (flags & SV_SMAGIC)
5104 =for apidoc sv_catpv
5106 Concatenates the string onto the end of the string which is in the SV.
5107 If the SV has the UTF-8 status set, then the bytes appended should be
5108 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5113 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5116 register STRLEN len;
5120 PERL_ARGS_ASSERT_SV_CATPV;
5124 junk = SvPV_force(sv, tlen);
5126 SvGROW(sv, tlen + len + 1);
5128 ptr = SvPVX_const(sv);
5129 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5130 SvCUR_set(sv, SvCUR(sv) + len);
5131 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5136 =for apidoc sv_catpv_flags
5138 Concatenates the string onto the end of the string which is in the SV.
5139 If the SV has the UTF-8 status set, then the bytes appended should
5140 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5141 on the modified SV if appropriate.
5147 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5149 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5150 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5154 =for apidoc sv_catpv_mg
5156 Like C<sv_catpv>, but also handles 'set' magic.
5162 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5164 PERL_ARGS_ASSERT_SV_CATPV_MG;
5173 Creates a new SV. A non-zero C<len> parameter indicates the number of
5174 bytes of preallocated string space the SV should have. An extra byte for a
5175 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5176 space is allocated.) The reference count for the new SV is set to 1.
5178 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5179 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5180 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5181 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5182 modules supporting older perls.
5188 Perl_newSV(pTHX_ const STRLEN len)
5195 sv_upgrade(sv, SVt_PV);
5196 SvGROW(sv, len + 1);
5201 =for apidoc sv_magicext
5203 Adds magic to an SV, upgrading it if necessary. Applies the
5204 supplied vtable and returns a pointer to the magic added.
5206 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5207 In particular, you can add magic to SvREADONLY SVs, and add more than
5208 one instance of the same 'how'.
5210 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5211 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5212 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5213 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5215 (This is now used as a subroutine by C<sv_magic>.)
5220 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5221 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5226 PERL_ARGS_ASSERT_SV_MAGICEXT;
5228 SvUPGRADE(sv, SVt_PVMG);
5229 Newxz(mg, 1, MAGIC);
5230 mg->mg_moremagic = SvMAGIC(sv);
5231 SvMAGIC_set(sv, mg);
5233 /* Sometimes a magic contains a reference loop, where the sv and
5234 object refer to each other. To prevent a reference loop that
5235 would prevent such objects being freed, we look for such loops
5236 and if we find one we avoid incrementing the object refcount.
5238 Note we cannot do this to avoid self-tie loops as intervening RV must
5239 have its REFCNT incremented to keep it in existence.
5242 if (!obj || obj == sv ||
5243 how == PERL_MAGIC_arylen ||
5244 how == PERL_MAGIC_symtab ||
5245 (SvTYPE(obj) == SVt_PVGV &&
5246 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5247 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5248 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5253 mg->mg_obj = SvREFCNT_inc_simple(obj);
5254 mg->mg_flags |= MGf_REFCOUNTED;
5257 /* Normal self-ties simply pass a null object, and instead of
5258 using mg_obj directly, use the SvTIED_obj macro to produce a
5259 new RV as needed. For glob "self-ties", we are tieing the PVIO
5260 with an RV obj pointing to the glob containing the PVIO. In
5261 this case, to avoid a reference loop, we need to weaken the
5265 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5266 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5272 mg->mg_len = namlen;
5275 mg->mg_ptr = savepvn(name, namlen);
5276 else if (namlen == HEf_SVKEY) {
5277 /* Yes, this is casting away const. This is only for the case of
5278 HEf_SVKEY. I think we need to document this aberation of the
5279 constness of the API, rather than making name non-const, as
5280 that change propagating outwards a long way. */
5281 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5283 mg->mg_ptr = (char *) name;
5285 mg->mg_virtual = (MGVTBL *) vtable;
5289 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5294 =for apidoc sv_magic
5296 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5297 necessary, then adds a new magic item of type C<how> to the head of the
5300 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5301 handling of the C<name> and C<namlen> arguments.
5303 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5304 to add more than one instance of the same 'how'.
5310 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5311 const char *const name, const I32 namlen)
5314 const MGVTBL *vtable;
5317 unsigned int vtable_index;
5319 PERL_ARGS_ASSERT_SV_MAGIC;
5321 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5322 || ((flags = PL_magic_data[how]),
5323 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5324 > magic_vtable_max))
5325 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5327 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5328 Useful for attaching extension internal data to perl vars.
5329 Note that multiple extensions may clash if magical scalars
5330 etc holding private data from one are passed to another. */
5332 vtable = (vtable_index == magic_vtable_max)
5333 ? NULL : PL_magic_vtables + vtable_index;
5335 #ifdef PERL_OLD_COPY_ON_WRITE
5337 sv_force_normal_flags(sv, 0);
5339 if (SvREADONLY(sv)) {
5341 /* its okay to attach magic to shared strings */
5345 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5348 Perl_croak_no_modify(aTHX);
5351 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5352 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5353 /* sv_magic() refuses to add a magic of the same 'how' as an
5356 if (how == PERL_MAGIC_taint) {
5358 /* Any scalar which already had taint magic on which someone
5359 (erroneously?) did SvIOK_on() or similar will now be
5360 incorrectly sporting public "OK" flags. */
5361 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5367 /* Rest of work is done else where */
5368 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5371 case PERL_MAGIC_taint:
5374 case PERL_MAGIC_ext:
5375 case PERL_MAGIC_dbfile:
5382 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5389 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5391 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5392 for (mg = *mgp; mg; mg = *mgp) {
5393 const MGVTBL* const virt = mg->mg_virtual;
5394 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5395 *mgp = mg->mg_moremagic;
5396 if (virt && virt->svt_free)
5397 virt->svt_free(aTHX_ sv, mg);
5398 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5400 Safefree(mg->mg_ptr);
5401 else if (mg->mg_len == HEf_SVKEY)
5402 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5403 else if (mg->mg_type == PERL_MAGIC_utf8)
5404 Safefree(mg->mg_ptr);
5406 if (mg->mg_flags & MGf_REFCOUNTED)
5407 SvREFCNT_dec(mg->mg_obj);
5411 mgp = &mg->mg_moremagic;
5414 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5415 mg_magical(sv); /* else fix the flags now */
5419 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5425 =for apidoc sv_unmagic
5427 Removes all magic of type C<type> from an SV.
5433 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5435 PERL_ARGS_ASSERT_SV_UNMAGIC;
5436 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5440 =for apidoc sv_unmagicext
5442 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5448 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5450 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5451 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5455 =for apidoc sv_rvweaken
5457 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5458 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5459 push a back-reference to this RV onto the array of backreferences
5460 associated with that magic. If the RV is magical, set magic will be
5461 called after the RV is cleared.
5467 Perl_sv_rvweaken(pTHX_ SV *const sv)
5471 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5473 if (!SvOK(sv)) /* let undefs pass */
5476 Perl_croak(aTHX_ "Can't weaken a nonreference");
5477 else if (SvWEAKREF(sv)) {
5478 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5481 else if (SvREADONLY(sv)) croak_no_modify();
5483 Perl_sv_add_backref(aTHX_ tsv, sv);
5489 /* Give tsv backref magic if it hasn't already got it, then push a
5490 * back-reference to sv onto the array associated with the backref magic.
5492 * As an optimisation, if there's only one backref and it's not an AV,
5493 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5494 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5498 /* A discussion about the backreferences array and its refcount:
5500 * The AV holding the backreferences is pointed to either as the mg_obj of
5501 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5502 * xhv_backreferences field. The array is created with a refcount
5503 * of 2. This means that if during global destruction the array gets
5504 * picked on before its parent to have its refcount decremented by the
5505 * random zapper, it won't actually be freed, meaning it's still there for
5506 * when its parent gets freed.
5508 * When the parent SV is freed, the extra ref is killed by
5509 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5510 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5512 * When a single backref SV is stored directly, it is not reference
5517 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5524 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5526 /* find slot to store array or singleton backref */
5528 if (SvTYPE(tsv) == SVt_PVHV) {
5529 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5532 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5534 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5535 mg = mg_find(tsv, PERL_MAGIC_backref);
5537 svp = &(mg->mg_obj);
5540 /* create or retrieve the array */
5542 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5543 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5548 SvREFCNT_inc_simple_void(av);
5549 /* av now has a refcnt of 2; see discussion above */
5551 /* move single existing backref to the array */
5553 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5557 mg->mg_flags |= MGf_REFCOUNTED;
5560 av = MUTABLE_AV(*svp);
5563 /* optimisation: store single backref directly in HvAUX or mg_obj */
5567 /* push new backref */
5568 assert(SvTYPE(av) == SVt_PVAV);
5569 if (AvFILLp(av) >= AvMAX(av)) {
5570 av_extend(av, AvFILLp(av)+1);
5572 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5575 /* delete a back-reference to ourselves from the backref magic associated
5576 * with the SV we point to.
5580 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5585 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5587 if (SvTYPE(tsv) == SVt_PVHV) {
5589 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5591 else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5592 /* It's possible for the the last (strong) reference to tsv to have
5593 become freed *before* the last thing holding a weak reference.
5594 If both survive longer than the backreferences array, then when
5595 the referent's reference count drops to 0 and it is freed, it's
5596 not able to chase the backreferences, so they aren't NULLed.
5598 For example, a CV holds a weak reference to its stash. If both the
5599 CV and the stash survive longer than the backreferences array,
5600 and the CV gets picked for the SvBREAK() treatment first,
5601 *and* it turns out that the stash is only being kept alive because
5602 of an our variable in the pad of the CV, then midway during CV
5603 destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5604 It ends up pointing to the freed HV. Hence it's chased in here, and
5605 if this block wasn't here, it would hit the !svp panic just below.
5607 I don't believe that "better" destruction ordering is going to help
5608 here - during global destruction there's always going to be the
5609 chance that something goes out of order. We've tried to make it
5610 foolproof before, and it only resulted in evolutionary pressure on
5611 fools. Which made us look foolish for our hubris. :-(
5617 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5618 svp = mg ? &(mg->mg_obj) : NULL;
5622 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5624 /* It's possible that sv is being freed recursively part way through the
5625 freeing of tsv. If this happens, the backreferences array of tsv has
5626 already been freed, and so svp will be NULL. If this is the case,
5627 we should not panic. Instead, nothing needs doing, so return. */
5628 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5630 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5631 *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5634 if (SvTYPE(*svp) == SVt_PVAV) {
5638 AV * const av = (AV*)*svp;
5640 assert(!SvIS_FREED(av));
5644 /* for an SV with N weak references to it, if all those
5645 * weak refs are deleted, then sv_del_backref will be called
5646 * N times and O(N^2) compares will be done within the backref
5647 * array. To ameliorate this potential slowness, we:
5648 * 1) make sure this code is as tight as possible;
5649 * 2) when looking for SV, look for it at both the head and tail of the
5650 * array first before searching the rest, since some create/destroy
5651 * patterns will cause the backrefs to be freed in order.
5658 SV **p = &svp[fill];
5659 SV *const topsv = *p;
5666 /* We weren't the last entry.
5667 An unordered list has this property that you
5668 can take the last element off the end to fill
5669 the hole, and it's still an unordered list :-)
5675 break; /* should only be one */
5682 AvFILLp(av) = fill-1;
5684 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5685 /* freed AV; skip */
5688 /* optimisation: only a single backref, stored directly */
5690 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5697 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5703 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5708 /* after multiple passes through Perl_sv_clean_all() for a thinngy
5709 * that has badly leaked, the backref array may have gotten freed,
5710 * since we only protect it against 1 round of cleanup */
5711 if (SvIS_FREED(av)) {
5712 if (PL_in_clean_all) /* All is fair */
5715 "panic: magic_killbackrefs (freed backref AV/SV)");
5719 is_array = (SvTYPE(av) == SVt_PVAV);
5721 assert(!SvIS_FREED(av));
5724 last = svp + AvFILLp(av);
5727 /* optimisation: only a single backref, stored directly */
5733 while (svp <= last) {
5735 SV *const referrer = *svp;
5736 if (SvWEAKREF(referrer)) {
5737 /* XXX Should we check that it hasn't changed? */
5738 assert(SvROK(referrer));
5739 SvRV_set(referrer, 0);
5741 SvWEAKREF_off(referrer);
5742 SvSETMAGIC(referrer);
5743 } else if (SvTYPE(referrer) == SVt_PVGV ||
5744 SvTYPE(referrer) == SVt_PVLV) {
5745 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5746 /* You lookin' at me? */
5747 assert(GvSTASH(referrer));
5748 assert(GvSTASH(referrer) == (const HV *)sv);
5749 GvSTASH(referrer) = 0;
5750 } else if (SvTYPE(referrer) == SVt_PVCV ||
5751 SvTYPE(referrer) == SVt_PVFM) {
5752 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5753 /* You lookin' at me? */
5754 assert(CvSTASH(referrer));
5755 assert(CvSTASH(referrer) == (const HV *)sv);
5756 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5759 assert(SvTYPE(sv) == SVt_PVGV);
5760 /* You lookin' at me? */
5761 assert(CvGV(referrer));
5762 assert(CvGV(referrer) == (const GV *)sv);
5763 anonymise_cv_maybe(MUTABLE_GV(sv),
5764 MUTABLE_CV(referrer));
5769 "panic: magic_killbackrefs (flags=%"UVxf")",
5770 (UV)SvFLAGS(referrer));
5781 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5787 =for apidoc sv_insert
5789 Inserts a string at the specified offset/length within the SV. Similar to
5790 the Perl substr() function. Handles get magic.
5792 =for apidoc sv_insert_flags
5794 Same as C<sv_insert>, but the extra C<flags> are passed to the
5795 C<SvPV_force_flags> that applies to C<bigstr>.
5801 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5806 register char *midend;
5807 register char *bigend;
5808 register SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5811 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5814 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5815 SvPV_force_flags(bigstr, curlen, flags);
5816 (void)SvPOK_only_UTF8(bigstr);
5817 if (offset + len > curlen) {
5818 SvGROW(bigstr, offset+len+1);
5819 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5820 SvCUR_set(bigstr, offset+len);
5824 i = littlelen - len;
5825 if (i > 0) { /* string might grow */
5826 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5827 mid = big + offset + len;
5828 midend = bigend = big + SvCUR(bigstr);
5831 while (midend > mid) /* shove everything down */
5832 *--bigend = *--midend;
5833 Move(little,big+offset,littlelen,char);
5834 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5839 Move(little,SvPVX(bigstr)+offset,len,char);
5844 big = SvPVX(bigstr);
5847 bigend = big + SvCUR(bigstr);
5849 if (midend > bigend)
5850 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5853 if (mid - big > bigend - midend) { /* faster to shorten from end */
5855 Move(little, mid, littlelen,char);
5858 i = bigend - midend;
5860 Move(midend, mid, i,char);
5864 SvCUR_set(bigstr, mid - big);
5866 else if ((i = mid - big)) { /* faster from front */
5867 midend -= littlelen;
5869 Move(big, midend - i, i, char);
5870 sv_chop(bigstr,midend-i);
5872 Move(little, mid, littlelen,char);
5874 else if (littlelen) {
5875 midend -= littlelen;
5876 sv_chop(bigstr,midend);
5877 Move(little,midend,littlelen,char);
5880 sv_chop(bigstr,midend);
5886 =for apidoc sv_replace
5888 Make the first argument a copy of the second, then delete the original.
5889 The target SV physically takes over ownership of the body of the source SV
5890 and inherits its flags; however, the target keeps any magic it owns,
5891 and any magic in the source is discarded.
5892 Note that this is a rather specialist SV copying operation; most of the
5893 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5899 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5902 const U32 refcnt = SvREFCNT(sv);
5904 PERL_ARGS_ASSERT_SV_REPLACE;
5906 SV_CHECK_THINKFIRST_COW_DROP(sv);
5907 if (SvREFCNT(nsv) != 1) {
5908 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5909 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5911 if (SvMAGICAL(sv)) {
5915 sv_upgrade(nsv, SVt_PVMG);
5916 SvMAGIC_set(nsv, SvMAGIC(sv));
5917 SvFLAGS(nsv) |= SvMAGICAL(sv);
5919 SvMAGIC_set(sv, NULL);
5923 assert(!SvREFCNT(sv));
5924 #ifdef DEBUG_LEAKING_SCALARS
5925 sv->sv_flags = nsv->sv_flags;
5926 sv->sv_any = nsv->sv_any;
5927 sv->sv_refcnt = nsv->sv_refcnt;
5928 sv->sv_u = nsv->sv_u;
5930 StructCopy(nsv,sv,SV);
5932 if(SvTYPE(sv) == SVt_IV) {
5934 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5938 #ifdef PERL_OLD_COPY_ON_WRITE
5939 if (SvIsCOW_normal(nsv)) {
5940 /* We need to follow the pointers around the loop to make the
5941 previous SV point to sv, rather than nsv. */
5944 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5947 assert(SvPVX_const(current) == SvPVX_const(nsv));
5949 /* Make the SV before us point to the SV after us. */
5951 PerlIO_printf(Perl_debug_log, "previous is\n");
5953 PerlIO_printf(Perl_debug_log,
5954 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5955 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5957 SV_COW_NEXT_SV_SET(current, sv);
5960 SvREFCNT(sv) = refcnt;
5961 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5966 /* We're about to free a GV which has a CV that refers back to us.
5967 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5971 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5976 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5979 assert(SvREFCNT(gv) == 0);
5980 assert(isGV(gv) && isGV_with_GP(gv));
5982 assert(!CvANON(cv));
5983 assert(CvGV(cv) == gv);
5985 /* will the CV shortly be freed by gp_free() ? */
5986 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5987 SvANY(cv)->xcv_gv = NULL;
5991 /* if not, anonymise: */
5992 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5993 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5994 : newSVpvn_flags( "__ANON__", 8, 0 );
5995 sv_catpvs(gvname, "::__ANON__");
5996 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5997 SvREFCNT_dec(gvname);
6001 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
6006 =for apidoc sv_clear
6008 Clear an SV: call any destructors, free up any memory used by the body,
6009 and free the body itself. The SV's head is I<not> freed, although
6010 its type is set to all 1's so that it won't inadvertently be assumed
6011 to be live during global destruction etc.
6012 This function should only be called when REFCNT is zero. Most of the time
6013 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
6020 Perl_sv_clear(pTHX_ SV *const orig_sv)
6025 const struct body_details *sv_type_details;
6028 register SV *sv = orig_sv;
6031 PERL_ARGS_ASSERT_SV_CLEAR;
6033 /* within this loop, sv is the SV currently being freed, and
6034 * iter_sv is the most recent AV or whatever that's being iterated
6035 * over to provide more SVs */
6041 assert(SvREFCNT(sv) == 0);
6042 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6044 if (type <= SVt_IV) {
6045 /* See the comment in sv.h about the collusion between this
6046 * early return and the overloading of the NULL slots in the
6050 SvFLAGS(sv) &= SVf_BREAK;
6051 SvFLAGS(sv) |= SVTYPEMASK;
6055 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6057 if (type >= SVt_PVMG) {
6059 if (!curse(sv, 1)) goto get_next_sv;
6060 type = SvTYPE(sv); /* destructor may have changed it */
6062 /* Free back-references before magic, in case the magic calls
6063 * Perl code that has weak references to sv. */
6064 if (type == SVt_PVHV) {
6065 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6069 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6070 SvREFCNT_dec(SvOURSTASH(sv));
6071 } else if (SvMAGIC(sv)) {
6072 /* Free back-references before other types of magic. */
6073 sv_unmagic(sv, PERL_MAGIC_backref);
6077 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6078 SvREFCNT_dec(SvSTASH(sv));
6081 /* case SVt_BIND: */
6084 IoIFP(sv) != PerlIO_stdin() &&
6085 IoIFP(sv) != PerlIO_stdout() &&
6086 IoIFP(sv) != PerlIO_stderr() &&
6087 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6089 io_close(MUTABLE_IO(sv), FALSE);
6091 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6092 PerlDir_close(IoDIRP(sv));
6093 IoDIRP(sv) = (DIR*)NULL;
6094 Safefree(IoTOP_NAME(sv));
6095 Safefree(IoFMT_NAME(sv));
6096 Safefree(IoBOTTOM_NAME(sv));
6097 if ((const GV *)sv == PL_statgv)
6101 /* FIXME for plugins */
6102 pregfree2((REGEXP*) sv);
6106 cv_undef(MUTABLE_CV(sv));
6107 /* If we're in a stash, we don't own a reference to it.
6108 * However it does have a back reference to us, which needs to
6110 if ((stash = CvSTASH(sv)))
6111 sv_del_backref(MUTABLE_SV(stash), sv);
6114 if (PL_last_swash_hv == (const HV *)sv) {
6115 PL_last_swash_hv = NULL;
6117 if (HvTOTALKEYS((HV*)sv) > 0) {
6119 /* this statement should match the one at the beginning of
6120 * hv_undef_flags() */
6121 if ( PL_phase != PERL_PHASE_DESTRUCT
6122 && (name = HvNAME((HV*)sv)))
6125 (void)hv_delete(PL_stashcache, name,
6126 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6127 hv_name_set((HV*)sv, NULL, 0, 0);
6130 /* save old iter_sv in unused SvSTASH field */
6131 assert(!SvOBJECT(sv));
6132 SvSTASH(sv) = (HV*)iter_sv;
6135 /* save old hash_index in unused SvMAGIC field */
6136 assert(!SvMAGICAL(sv));
6137 assert(!SvMAGIC(sv));
6138 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6141 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6142 goto get_next_sv; /* process this new sv */
6144 /* free empty hash */
6145 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6146 assert(!HvARRAY((HV*)sv));
6150 AV* av = MUTABLE_AV(sv);
6151 if (PL_comppad == av) {
6155 if (AvREAL(av) && AvFILLp(av) > -1) {
6156 next_sv = AvARRAY(av)[AvFILLp(av)--];
6157 /* save old iter_sv in top-most slot of AV,
6158 * and pray that it doesn't get wiped in the meantime */
6159 AvARRAY(av)[AvMAX(av)] = iter_sv;
6161 goto get_next_sv; /* process this new sv */
6163 Safefree(AvALLOC(av));
6168 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6169 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6170 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6171 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6173 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6174 SvREFCNT_dec(LvTARG(sv));
6176 if (isGV_with_GP(sv)) {
6177 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6178 && HvENAME_get(stash))
6179 mro_method_changed_in(stash);
6180 gp_free(MUTABLE_GV(sv));
6182 unshare_hek(GvNAME_HEK(sv));
6183 /* If we're in a stash, we don't own a reference to it.
6184 * However it does have a back reference to us, which
6185 * needs to be cleared. */
6186 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6187 sv_del_backref(MUTABLE_SV(stash), sv);
6189 /* FIXME. There are probably more unreferenced pointers to SVs
6190 * in the interpreter struct that we should check and tidy in
6191 * a similar fashion to this: */
6192 /* See also S_sv_unglob, which does the same thing. */
6193 if ((const GV *)sv == PL_last_in_gv)
6194 PL_last_in_gv = NULL;
6195 else if ((const GV *)sv == PL_statgv)
6202 /* Don't bother with SvOOK_off(sv); as we're only going to
6206 SvOOK_offset(sv, offset);
6207 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6208 /* Don't even bother with turning off the OOK flag. */
6213 SV * const target = SvRV(sv);
6215 sv_del_backref(target, sv);
6220 #ifdef PERL_OLD_COPY_ON_WRITE
6221 else if (SvPVX_const(sv)
6222 && !(SvTYPE(sv) == SVt_PVIO
6223 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6227 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6231 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6233 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6237 } else if (SvLEN(sv)) {
6238 Safefree(SvPVX_const(sv));
6242 else if (SvPVX_const(sv) && SvLEN(sv)
6243 && !(SvTYPE(sv) == SVt_PVIO
6244 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6245 Safefree(SvPVX_mutable(sv));
6246 else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6247 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6258 SvFLAGS(sv) &= SVf_BREAK;
6259 SvFLAGS(sv) |= SVTYPEMASK;
6261 sv_type_details = bodies_by_type + type;
6262 if (sv_type_details->arena) {
6263 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6264 &PL_body_roots[type]);
6266 else if (sv_type_details->body_size) {
6267 safefree(SvANY(sv));
6271 /* caller is responsible for freeing the head of the original sv */
6272 if (sv != orig_sv && !SvREFCNT(sv))
6275 /* grab and free next sv, if any */
6283 else if (!iter_sv) {
6285 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6286 AV *const av = (AV*)iter_sv;
6287 if (AvFILLp(av) > -1) {
6288 sv = AvARRAY(av)[AvFILLp(av)--];
6290 else { /* no more elements of current AV to free */
6293 /* restore previous value, squirrelled away */
6294 iter_sv = AvARRAY(av)[AvMAX(av)];
6295 Safefree(AvALLOC(av));
6298 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6299 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6300 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6301 /* no more elements of current HV to free */
6304 /* Restore previous values of iter_sv and hash_index,
6305 * squirrelled away */
6306 assert(!SvOBJECT(sv));
6307 iter_sv = (SV*)SvSTASH(sv);
6308 assert(!SvMAGICAL(sv));
6309 hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6311 /* free any remaining detritus from the hash struct */
6312 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6313 assert(!HvARRAY((HV*)sv));
6318 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6322 if (!SvREFCNT(sv)) {
6326 if (--(SvREFCNT(sv)))
6330 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6331 "Attempt to free temp prematurely: SV 0x%"UVxf
6332 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6336 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6337 /* make sure SvREFCNT(sv)==0 happens very seldom */
6338 SvREFCNT(sv) = (~(U32)0)/2;
6347 /* This routine curses the sv itself, not the object referenced by sv. So
6348 sv does not have to be ROK. */
6351 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6354 PERL_ARGS_ASSERT_CURSE;
6355 assert(SvOBJECT(sv));
6357 if (PL_defstash && /* Still have a symbol table? */
6364 stash = SvSTASH(sv);
6365 destructor = StashHANDLER(stash,DESTROY);
6367 /* A constant subroutine can have no side effects, so
6368 don't bother calling it. */
6369 && !CvCONST(destructor)
6370 /* Don't bother calling an empty destructor or one that
6371 returns immediately. */
6372 && (CvISXSUB(destructor)
6373 || (CvSTART(destructor)
6374 && (CvSTART(destructor)->op_next->op_type
6376 && (CvSTART(destructor)->op_next->op_type
6378 || CvSTART(destructor)->op_next->op_next->op_type
6384 SV* const tmpref = newRV(sv);
6385 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6387 PUSHSTACKi(PERLSI_DESTROY);
6392 call_sv(MUTABLE_SV(destructor),
6393 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6397 if(SvREFCNT(tmpref) < 2) {
6398 /* tmpref is not kept alive! */
6400 SvRV_set(tmpref, NULL);
6403 SvREFCNT_dec(tmpref);
6405 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6408 if (check_refcnt && SvREFCNT(sv)) {
6409 if (PL_in_clean_objs)
6411 "DESTROY created new reference to dead object '%"HEKf"'",
6412 HEKfARG(HvNAME_HEK(stash)));
6413 /* DESTROY gave object new lease on life */
6419 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6420 SvOBJECT_off(sv); /* Curse the object. */
6421 if (SvTYPE(sv) != SVt_PVIO)
6422 --PL_sv_objcount;/* XXX Might want something more general */
6428 =for apidoc sv_newref
6430 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6437 Perl_sv_newref(pTHX_ SV *const sv)
6439 PERL_UNUSED_CONTEXT;
6448 Decrement an SV's reference count, and if it drops to zero, call
6449 C<sv_clear> to invoke destructors and free up any memory used by
6450 the body; finally, deallocate the SV's head itself.
6451 Normally called via a wrapper macro C<SvREFCNT_dec>.
6457 Perl_sv_free(pTHX_ SV *const sv)
6462 if (SvREFCNT(sv) == 0) {
6463 if (SvFLAGS(sv) & SVf_BREAK)
6464 /* this SV's refcnt has been artificially decremented to
6465 * trigger cleanup */
6467 if (PL_in_clean_all) /* All is fair */
6469 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6470 /* make sure SvREFCNT(sv)==0 happens very seldom */
6471 SvREFCNT(sv) = (~(U32)0)/2;
6474 if (ckWARN_d(WARN_INTERNAL)) {
6475 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6476 Perl_dump_sv_child(aTHX_ sv);
6478 #ifdef DEBUG_LEAKING_SCALARS
6481 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6482 if (PL_warnhook == PERL_WARNHOOK_FATAL
6483 || ckDEAD(packWARN(WARN_INTERNAL))) {
6484 /* Don't let Perl_warner cause us to escape our fate: */
6488 /* This may not return: */
6489 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6490 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6491 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6494 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6499 if (--(SvREFCNT(sv)) > 0)
6501 Perl_sv_free2(aTHX_ sv);
6505 Perl_sv_free2(pTHX_ SV *const sv)
6509 PERL_ARGS_ASSERT_SV_FREE2;
6513 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6514 "Attempt to free temp prematurely: SV 0x%"UVxf
6515 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6519 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6520 /* make sure SvREFCNT(sv)==0 happens very seldom */
6521 SvREFCNT(sv) = (~(U32)0)/2;
6532 Returns the length of the string in the SV. Handles magic and type
6533 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6539 Perl_sv_len(pTHX_ register SV *const sv)
6547 len = mg_length(sv);
6549 (void)SvPV_const(sv, len);
6554 =for apidoc sv_len_utf8
6556 Returns the number of characters in the string in an SV, counting wide
6557 UTF-8 bytes as a single character. Handles magic and type coercion.
6563 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6564 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6565 * (Note that the mg_len is not the length of the mg_ptr field.
6566 * This allows the cache to store the character length of the string without
6567 * needing to malloc() extra storage to attach to the mg_ptr.)
6572 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6578 return mg_length(sv);
6582 const U8 *s = (U8*)SvPV_const(sv, len);
6586 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6588 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6589 if (mg->mg_len != -1)
6592 /* We can use the offset cache for a headstart.
6593 The longer value is stored in the first pair. */
6594 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6596 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6600 if (PL_utf8cache < 0) {
6601 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6602 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6606 ulen = Perl_utf8_length(aTHX_ s, s + len);
6607 utf8_mg_len_cache_update(sv, &mg, ulen);
6611 return Perl_utf8_length(aTHX_ s, s + len);
6615 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6618 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6619 STRLEN *const uoffset_p, bool *const at_end)
6621 const U8 *s = start;
6622 STRLEN uoffset = *uoffset_p;
6624 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6626 while (s < send && uoffset) {
6633 else if (s > send) {
6635 /* This is the existing behaviour. Possibly it should be a croak, as
6636 it's actually a bounds error */
6639 *uoffset_p -= uoffset;
6643 /* Given the length of the string in both bytes and UTF-8 characters, decide
6644 whether to walk forwards or backwards to find the byte corresponding to
6645 the passed in UTF-8 offset. */
6647 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6648 STRLEN uoffset, const STRLEN uend)
6650 STRLEN backw = uend - uoffset;
6652 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6654 if (uoffset < 2 * backw) {
6655 /* The assumption is that going forwards is twice the speed of going
6656 forward (that's where the 2 * backw comes from).
6657 (The real figure of course depends on the UTF-8 data.) */
6658 const U8 *s = start;
6660 while (s < send && uoffset--)
6670 while (UTF8_IS_CONTINUATION(*send))
6673 return send - start;
6676 /* For the string representation of the given scalar, find the byte
6677 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6678 give another position in the string, *before* the sought offset, which
6679 (which is always true, as 0, 0 is a valid pair of positions), which should
6680 help reduce the amount of linear searching.
6681 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6682 will be used to reduce the amount of linear searching. The cache will be
6683 created if necessary, and the found value offered to it for update. */
6685 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6686 const U8 *const send, STRLEN uoffset,
6687 STRLEN uoffset0, STRLEN boffset0)
6689 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6691 bool at_end = FALSE;
6693 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6695 assert (uoffset >= uoffset0);
6702 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6703 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6704 if ((*mgp)->mg_ptr) {
6705 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6706 if (cache[0] == uoffset) {
6707 /* An exact match. */
6710 if (cache[2] == uoffset) {
6711 /* An exact match. */
6715 if (cache[0] < uoffset) {
6716 /* The cache already knows part of the way. */
6717 if (cache[0] > uoffset0) {
6718 /* The cache knows more than the passed in pair */
6719 uoffset0 = cache[0];
6720 boffset0 = cache[1];
6722 if ((*mgp)->mg_len != -1) {
6723 /* And we know the end too. */
6725 + sv_pos_u2b_midway(start + boffset0, send,
6727 (*mgp)->mg_len - uoffset0);
6729 uoffset -= uoffset0;
6731 + sv_pos_u2b_forwards(start + boffset0,
6732 send, &uoffset, &at_end);
6733 uoffset += uoffset0;
6736 else if (cache[2] < uoffset) {
6737 /* We're between the two cache entries. */
6738 if (cache[2] > uoffset0) {
6739 /* and the cache knows more than the passed in pair */
6740 uoffset0 = cache[2];
6741 boffset0 = cache[3];
6745 + sv_pos_u2b_midway(start + boffset0,
6748 cache[0] - uoffset0);
6751 + sv_pos_u2b_midway(start + boffset0,
6754 cache[2] - uoffset0);
6758 else if ((*mgp)->mg_len != -1) {
6759 /* If we can take advantage of a passed in offset, do so. */
6760 /* In fact, offset0 is either 0, or less than offset, so don't
6761 need to worry about the other possibility. */
6763 + sv_pos_u2b_midway(start + boffset0, send,
6765 (*mgp)->mg_len - uoffset0);
6770 if (!found || PL_utf8cache < 0) {
6771 STRLEN real_boffset;
6772 uoffset -= uoffset0;
6773 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6774 send, &uoffset, &at_end);
6775 uoffset += uoffset0;
6777 if (found && PL_utf8cache < 0)
6778 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6780 boffset = real_boffset;
6785 utf8_mg_len_cache_update(sv, mgp, uoffset);
6787 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6794 =for apidoc sv_pos_u2b_flags
6796 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6797 the start of the string, to a count of the equivalent number of bytes; if
6798 lenp is non-zero, it does the same to lenp, but this time starting from
6799 the offset, rather than from the start
6800 of the string. Handles type coercion.
6801 I<flags> is passed to C<SvPV_flags>, and usually should be
6802 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6808 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6809 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6810 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6815 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6822 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6824 start = (U8*)SvPV_flags(sv, len, flags);
6826 const U8 * const send = start + len;
6828 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6831 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6832 is 0, and *lenp is already set to that. */) {
6833 /* Convert the relative offset to absolute. */
6834 const STRLEN uoffset2 = uoffset + *lenp;
6835 const STRLEN boffset2
6836 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6837 uoffset, boffset) - boffset;
6851 =for apidoc sv_pos_u2b
6853 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6854 the start of the string, to a count of the equivalent number of bytes; if
6855 lenp is non-zero, it does the same to lenp, but this time starting from
6856 the offset, rather than from the start of the string. Handles magic and
6859 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6866 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6867 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6868 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6872 /* This function is subject to size and sign problems */
6875 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6877 PERL_ARGS_ASSERT_SV_POS_U2B;
6880 STRLEN ulen = (STRLEN)*lenp;
6881 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6882 SV_GMAGIC|SV_CONST_RETURN);
6885 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6886 SV_GMAGIC|SV_CONST_RETURN);
6891 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6894 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6898 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6899 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6900 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6904 (*mgp)->mg_len = ulen;
6905 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6906 if (ulen != (STRLEN) (*mgp)->mg_len)
6907 (*mgp)->mg_len = -1;
6910 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6911 byte length pairing. The (byte) length of the total SV is passed in too,
6912 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6913 may not have updated SvCUR, so we can't rely on reading it directly.
6915 The proffered utf8/byte length pairing isn't used if the cache already has
6916 two pairs, and swapping either for the proffered pair would increase the
6917 RMS of the intervals between known byte offsets.
6919 The cache itself consists of 4 STRLEN values
6920 0: larger UTF-8 offset
6921 1: corresponding byte offset
6922 2: smaller UTF-8 offset
6923 3: corresponding byte offset
6925 Unused cache pairs have the value 0, 0.
6926 Keeping the cache "backwards" means that the invariant of
6927 cache[0] >= cache[2] is maintained even with empty slots, which means that
6928 the code that uses it doesn't need to worry if only 1 entry has actually
6929 been set to non-zero. It also makes the "position beyond the end of the
6930 cache" logic much simpler, as the first slot is always the one to start
6934 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6935 const STRLEN utf8, const STRLEN blen)
6939 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6944 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6945 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6946 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6948 (*mgp)->mg_len = -1;
6952 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6953 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6954 (*mgp)->mg_ptr = (char *) cache;
6958 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6959 /* SvPOKp() because it's possible that sv has string overloading, and
6960 therefore is a reference, hence SvPVX() is actually a pointer.
6961 This cures the (very real) symptoms of RT 69422, but I'm not actually
6962 sure whether we should even be caching the results of UTF-8
6963 operations on overloading, given that nothing stops overloading
6964 returning a different value every time it's called. */
6965 const U8 *start = (const U8 *) SvPVX_const(sv);
6966 const STRLEN realutf8 = utf8_length(start, start + byte);
6968 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6972 /* Cache is held with the later position first, to simplify the code
6973 that deals with unbounded ends. */
6975 ASSERT_UTF8_CACHE(cache);
6976 if (cache[1] == 0) {
6977 /* Cache is totally empty */
6980 } else if (cache[3] == 0) {
6981 if (byte > cache[1]) {
6982 /* New one is larger, so goes first. */
6983 cache[2] = cache[0];
6984 cache[3] = cache[1];
6992 #define THREEWAY_SQUARE(a,b,c,d) \
6993 ((float)((d) - (c))) * ((float)((d) - (c))) \
6994 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6995 + ((float)((b) - (a))) * ((float)((b) - (a)))
6997 /* Cache has 2 slots in use, and we know three potential pairs.
6998 Keep the two that give the lowest RMS distance. Do the
6999 calculation in bytes simply because we always know the byte
7000 length. squareroot has the same ordering as the positive value,
7001 so don't bother with the actual square root. */
7002 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
7003 if (byte > cache[1]) {
7004 /* New position is after the existing pair of pairs. */
7005 const float keep_earlier
7006 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7007 const float keep_later
7008 = THREEWAY_SQUARE(0, cache[1], byte, blen);
7010 if (keep_later < keep_earlier) {
7011 if (keep_later < existing) {
7012 cache[2] = cache[0];
7013 cache[3] = cache[1];
7019 if (keep_earlier < existing) {
7025 else if (byte > cache[3]) {
7026 /* New position is between the existing pair of pairs. */
7027 const float keep_earlier
7028 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7029 const float keep_later
7030 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7032 if (keep_later < keep_earlier) {
7033 if (keep_later < existing) {
7039 if (keep_earlier < existing) {
7046 /* New position is before the existing pair of pairs. */
7047 const float keep_earlier
7048 = THREEWAY_SQUARE(0, byte, cache[3], blen);
7049 const float keep_later
7050 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7052 if (keep_later < keep_earlier) {
7053 if (keep_later < existing) {
7059 if (keep_earlier < existing) {
7060 cache[0] = cache[2];
7061 cache[1] = cache[3];
7068 ASSERT_UTF8_CACHE(cache);
7071 /* We already know all of the way, now we may be able to walk back. The same
7072 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7073 backward is half the speed of walking forward. */
7075 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7076 const U8 *end, STRLEN endu)
7078 const STRLEN forw = target - s;
7079 STRLEN backw = end - target;
7081 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7083 if (forw < 2 * backw) {
7084 return utf8_length(s, target);
7087 while (end > target) {
7089 while (UTF8_IS_CONTINUATION(*end)) {
7098 =for apidoc sv_pos_b2u
7100 Converts the value pointed to by offsetp from a count of bytes from the
7101 start of the string, to a count of the equivalent number of UTF-8 chars.
7102 Handles magic and type coercion.
7108 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7109 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7114 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7117 const STRLEN byte = *offsetp;
7118 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7124 PERL_ARGS_ASSERT_SV_POS_B2U;
7129 s = (const U8*)SvPV_const(sv, blen);
7132 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7133 ", byte=%"UVuf, (UV)blen, (UV)byte);
7139 && SvTYPE(sv) >= SVt_PVMG
7140 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7143 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7144 if (cache[1] == byte) {
7145 /* An exact match. */
7146 *offsetp = cache[0];
7149 if (cache[3] == byte) {
7150 /* An exact match. */
7151 *offsetp = cache[2];
7155 if (cache[1] < byte) {
7156 /* We already know part of the way. */
7157 if (mg->mg_len != -1) {
7158 /* Actually, we know the end too. */
7160 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7161 s + blen, mg->mg_len - cache[0]);
7163 len = cache[0] + utf8_length(s + cache[1], send);
7166 else if (cache[3] < byte) {
7167 /* We're between the two cached pairs, so we do the calculation
7168 offset by the byte/utf-8 positions for the earlier pair,
7169 then add the utf-8 characters from the string start to
7171 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7172 s + cache[1], cache[0] - cache[2])
7176 else { /* cache[3] > byte */
7177 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7181 ASSERT_UTF8_CACHE(cache);
7183 } else if (mg->mg_len != -1) {
7184 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7188 if (!found || PL_utf8cache < 0) {
7189 const STRLEN real_len = utf8_length(s, send);
7191 if (found && PL_utf8cache < 0)
7192 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7199 utf8_mg_len_cache_update(sv, &mg, len);
7201 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7206 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7207 STRLEN real, SV *const sv)
7209 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7211 /* As this is debugging only code, save space by keeping this test here,
7212 rather than inlining it in all the callers. */
7213 if (from_cache == real)
7216 /* Need to turn the assertions off otherwise we may recurse infinitely
7217 while printing error messages. */
7218 SAVEI8(PL_utf8cache);
7220 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7221 func, (UV) from_cache, (UV) real, SVfARG(sv));
7227 Returns a boolean indicating whether the strings in the two SVs are
7228 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7229 coerce its args to strings if necessary.
7231 =for apidoc sv_eq_flags
7233 Returns a boolean indicating whether the strings in the two SVs are
7234 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7235 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7241 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7249 SV* svrecode = NULL;
7256 /* if pv1 and pv2 are the same, second SvPV_const call may
7257 * invalidate pv1 (if we are handling magic), so we may need to
7259 if (sv1 == sv2 && flags & SV_GMAGIC
7260 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7261 pv1 = SvPV_const(sv1, cur1);
7262 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7264 pv1 = SvPV_flags_const(sv1, cur1, flags);
7272 pv2 = SvPV_flags_const(sv2, cur2, flags);
7274 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7275 /* Differing utf8ness.
7276 * Do not UTF8size the comparands as a side-effect. */
7279 svrecode = newSVpvn(pv2, cur2);
7280 sv_recode_to_utf8(svrecode, PL_encoding);
7281 pv2 = SvPV_const(svrecode, cur2);
7284 svrecode = newSVpvn(pv1, cur1);
7285 sv_recode_to_utf8(svrecode, PL_encoding);
7286 pv1 = SvPV_const(svrecode, cur1);
7288 /* Now both are in UTF-8. */
7290 SvREFCNT_dec(svrecode);
7296 /* sv1 is the UTF-8 one */
7297 return bytes_cmp_utf8((const U8*)pv2, cur2,
7298 (const U8*)pv1, cur1) == 0;
7301 /* sv2 is the UTF-8 one */
7302 return bytes_cmp_utf8((const U8*)pv1, cur1,
7303 (const U8*)pv2, cur2) == 0;
7309 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7311 SvREFCNT_dec(svrecode);
7319 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7320 string in C<sv1> is less than, equal to, or greater than the string in
7321 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7322 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7324 =for apidoc sv_cmp_flags
7326 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7327 string in C<sv1> is less than, equal to, or greater than the string in
7328 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7329 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7330 also C<sv_cmp_locale_flags>.
7336 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7338 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7342 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7347 const char *pv1, *pv2;
7350 SV *svrecode = NULL;
7357 pv1 = SvPV_flags_const(sv1, cur1, flags);
7364 pv2 = SvPV_flags_const(sv2, cur2, flags);
7366 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7367 /* Differing utf8ness.
7368 * Do not UTF8size the comparands as a side-effect. */
7371 svrecode = newSVpvn(pv2, cur2);
7372 sv_recode_to_utf8(svrecode, PL_encoding);
7373 pv2 = SvPV_const(svrecode, cur2);
7376 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7377 (const U8*)pv1, cur1);
7378 return retval ? retval < 0 ? -1 : +1 : 0;
7383 svrecode = newSVpvn(pv1, cur1);
7384 sv_recode_to_utf8(svrecode, PL_encoding);
7385 pv1 = SvPV_const(svrecode, cur1);
7388 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7389 (const U8*)pv2, cur2);
7390 return retval ? retval < 0 ? -1 : +1 : 0;
7396 cmp = cur2 ? -1 : 0;
7400 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7403 cmp = retval < 0 ? -1 : 1;
7404 } else if (cur1 == cur2) {
7407 cmp = cur1 < cur2 ? -1 : 1;
7411 SvREFCNT_dec(svrecode);
7419 =for apidoc sv_cmp_locale
7421 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7422 'use bytes' aware, handles get magic, and will coerce its args to strings
7423 if necessary. See also C<sv_cmp>.
7425 =for apidoc sv_cmp_locale_flags
7427 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7428 'use bytes' aware and will coerce its args to strings if necessary. If the
7429 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7435 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7437 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7441 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7445 #ifdef USE_LOCALE_COLLATE
7451 if (PL_collation_standard)
7455 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7457 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7459 if (!pv1 || !len1) {
7470 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7473 return retval < 0 ? -1 : 1;
7476 * When the result of collation is equality, that doesn't mean
7477 * that there are no differences -- some locales exclude some
7478 * characters from consideration. So to avoid false equalities,
7479 * we use the raw string as a tiebreaker.
7485 #endif /* USE_LOCALE_COLLATE */
7487 return sv_cmp(sv1, sv2);
7491 #ifdef USE_LOCALE_COLLATE
7494 =for apidoc sv_collxfrm
7496 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7497 C<sv_collxfrm_flags>.
7499 =for apidoc sv_collxfrm_flags
7501 Add Collate Transform magic to an SV if it doesn't already have it. If the
7502 flags contain SV_GMAGIC, it handles get-magic.
7504 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7505 scalar data of the variable, but transformed to such a format that a normal
7506 memory comparison can be used to compare the data according to the locale
7513 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7518 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7520 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7521 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7527 Safefree(mg->mg_ptr);
7528 s = SvPV_flags_const(sv, len, flags);
7529 if ((xf = mem_collxfrm(s, len, &xlen))) {
7531 #ifdef PERL_OLD_COPY_ON_WRITE
7533 sv_force_normal_flags(sv, 0);
7535 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7549 if (mg && mg->mg_ptr) {
7551 return mg->mg_ptr + sizeof(PL_collation_ix);
7559 #endif /* USE_LOCALE_COLLATE */
7562 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7564 SV * const tsv = newSV(0);
7567 sv_gets(tsv, fp, 0);
7568 sv_utf8_upgrade_nomg(tsv);
7569 SvCUR_set(sv,append);
7572 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7576 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7579 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7580 /* Grab the size of the record we're getting */
7581 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7588 /* VMS wants read instead of fread, because fread doesn't respect */
7589 /* RMS record boundaries. This is not necessarily a good thing to be */
7590 /* doing, but we've got no other real choice - except avoid stdio
7591 as implementation - perhaps write a :vms layer ?
7593 fd = PerlIO_fileno(fp);
7595 bytesread = PerlLIO_read(fd, buffer, recsize);
7597 else /* in-memory file from PerlIO::Scalar */
7600 bytesread = PerlIO_read(fp, buffer, recsize);
7605 SvCUR_set(sv, bytesread + append);
7606 buffer[bytesread] = '\0';
7607 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7613 Get a line from the filehandle and store it into the SV, optionally
7614 appending to the currently-stored string.
7620 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7625 register STDCHAR rslast;
7626 register STDCHAR *bp;
7631 PERL_ARGS_ASSERT_SV_GETS;
7633 if (SvTHINKFIRST(sv))
7634 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7635 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7637 However, perlbench says it's slower, because the existing swipe code
7638 is faster than copy on write.
7639 Swings and roundabouts. */
7640 SvUPGRADE(sv, SVt_PV);
7643 if (PerlIO_isutf8(fp)) {
7645 sv_utf8_upgrade_nomg(sv);
7646 sv_pos_u2b(sv,&append,0);
7648 } else if (SvUTF8(sv)) {
7649 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7657 if (PerlIO_isutf8(fp))
7660 if (IN_PERL_COMPILETIME) {
7661 /* we always read code in line mode */
7665 else if (RsSNARF(PL_rs)) {
7666 /* If it is a regular disk file use size from stat() as estimate
7667 of amount we are going to read -- may result in mallocing
7668 more memory than we really need if the layers below reduce
7669 the size we read (e.g. CRLF or a gzip layer).
7672 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7673 const Off_t offset = PerlIO_tell(fp);
7674 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7675 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7681 else if (RsRECORD(PL_rs)) {
7682 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7684 else if (RsPARA(PL_rs)) {
7690 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7691 if (PerlIO_isutf8(fp)) {
7692 rsptr = SvPVutf8(PL_rs, rslen);
7695 if (SvUTF8(PL_rs)) {
7696 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7697 Perl_croak(aTHX_ "Wide character in $/");
7700 rsptr = SvPV_const(PL_rs, rslen);
7704 rslast = rslen ? rsptr[rslen - 1] : '\0';
7706 if (rspara) { /* have to do this both before and after */
7707 do { /* to make sure file boundaries work right */
7710 i = PerlIO_getc(fp);
7714 PerlIO_ungetc(fp,i);
7720 /* See if we know enough about I/O mechanism to cheat it ! */
7722 /* This used to be #ifdef test - it is made run-time test for ease
7723 of abstracting out stdio interface. One call should be cheap
7724 enough here - and may even be a macro allowing compile
7728 if (PerlIO_fast_gets(fp)) {
7731 * We're going to steal some values from the stdio struct
7732 * and put EVERYTHING in the innermost loop into registers.
7734 register STDCHAR *ptr;
7738 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7739 /* An ungetc()d char is handled separately from the regular
7740 * buffer, so we getc() it back out and stuff it in the buffer.
7742 i = PerlIO_getc(fp);
7743 if (i == EOF) return 0;
7744 *(--((*fp)->_ptr)) = (unsigned char) i;
7748 /* Here is some breathtakingly efficient cheating */
7750 cnt = PerlIO_get_cnt(fp); /* get count into register */
7751 /* make sure we have the room */
7752 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7753 /* Not room for all of it
7754 if we are looking for a separator and room for some
7756 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7757 /* just process what we have room for */
7758 shortbuffered = cnt - SvLEN(sv) + append + 1;
7759 cnt -= shortbuffered;
7763 /* remember that cnt can be negative */
7764 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7769 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7770 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7771 DEBUG_P(PerlIO_printf(Perl_debug_log,
7772 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7773 DEBUG_P(PerlIO_printf(Perl_debug_log,
7774 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7775 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7776 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7781 while (cnt > 0) { /* this | eat */
7783 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7784 goto thats_all_folks; /* screams | sed :-) */
7788 Copy(ptr, bp, cnt, char); /* this | eat */
7789 bp += cnt; /* screams | dust */
7790 ptr += cnt; /* louder | sed :-) */
7792 assert (!shortbuffered);
7793 goto cannot_be_shortbuffered;
7797 if (shortbuffered) { /* oh well, must extend */
7798 cnt = shortbuffered;
7800 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7802 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7803 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7807 cannot_be_shortbuffered:
7808 DEBUG_P(PerlIO_printf(Perl_debug_log,
7809 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7810 PTR2UV(ptr),(long)cnt));
7811 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7813 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7814 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7815 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7816 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7818 /* This used to call 'filbuf' in stdio form, but as that behaves like
7819 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7820 another abstraction. */
7821 i = PerlIO_getc(fp); /* get more characters */
7823 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7824 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7825 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7826 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7828 cnt = PerlIO_get_cnt(fp);
7829 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7830 DEBUG_P(PerlIO_printf(Perl_debug_log,
7831 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7833 if (i == EOF) /* all done for ever? */
7834 goto thats_really_all_folks;
7836 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7838 SvGROW(sv, bpx + cnt + 2);
7839 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7841 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7843 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7844 goto thats_all_folks;
7848 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7849 memNE((char*)bp - rslen, rsptr, rslen))
7850 goto screamer; /* go back to the fray */
7851 thats_really_all_folks:
7853 cnt += shortbuffered;
7854 DEBUG_P(PerlIO_printf(Perl_debug_log,
7855 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7856 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7857 DEBUG_P(PerlIO_printf(Perl_debug_log,
7858 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7859 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7860 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7862 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7863 DEBUG_P(PerlIO_printf(Perl_debug_log,
7864 "Screamer: done, len=%ld, string=|%.*s|\n",
7865 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7869 /*The big, slow, and stupid way. */
7870 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7871 STDCHAR *buf = NULL;
7872 Newx(buf, 8192, STDCHAR);
7880 register const STDCHAR * const bpe = buf + sizeof(buf);
7882 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7883 ; /* keep reading */
7887 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7888 /* Accommodate broken VAXC compiler, which applies U8 cast to
7889 * both args of ?: operator, causing EOF to change into 255
7892 i = (U8)buf[cnt - 1];
7898 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7900 sv_catpvn(sv, (char *) buf, cnt);
7902 sv_setpvn(sv, (char *) buf, cnt);
7904 if (i != EOF && /* joy */
7906 SvCUR(sv) < rslen ||
7907 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7911 * If we're reading from a TTY and we get a short read,
7912 * indicating that the user hit his EOF character, we need
7913 * to notice it now, because if we try to read from the TTY
7914 * again, the EOF condition will disappear.
7916 * The comparison of cnt to sizeof(buf) is an optimization
7917 * that prevents unnecessary calls to feof().
7921 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7925 #ifdef USE_HEAP_INSTEAD_OF_STACK
7930 if (rspara) { /* have to do this both before and after */
7931 while (i != EOF) { /* to make sure file boundaries work right */
7932 i = PerlIO_getc(fp);
7934 PerlIO_ungetc(fp,i);
7940 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7946 Auto-increment of the value in the SV, doing string to numeric conversion
7947 if necessary. Handles 'get' magic and operator overloading.
7953 Perl_sv_inc(pTHX_ register SV *const sv)
7962 =for apidoc sv_inc_nomg
7964 Auto-increment of the value in the SV, doing string to numeric conversion
7965 if necessary. Handles operator overloading. Skips handling 'get' magic.
7971 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7979 if (SvTHINKFIRST(sv)) {
7980 if (SvIsCOW(sv) || isGV_with_GP(sv))
7981 sv_force_normal_flags(sv, 0);
7982 if (SvREADONLY(sv)) {
7983 if (IN_PERL_RUNTIME)
7984 Perl_croak_no_modify(aTHX);
7988 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7990 i = PTR2IV(SvRV(sv));
7995 flags = SvFLAGS(sv);
7996 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7997 /* It's (privately or publicly) a float, but not tested as an
7998 integer, so test it to see. */
8000 flags = SvFLAGS(sv);
8002 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8003 /* It's publicly an integer, or privately an integer-not-float */
8004 #ifdef PERL_PRESERVE_IVUV
8008 if (SvUVX(sv) == UV_MAX)
8009 sv_setnv(sv, UV_MAX_P1);
8011 (void)SvIOK_only_UV(sv);
8012 SvUV_set(sv, SvUVX(sv) + 1);
8014 if (SvIVX(sv) == IV_MAX)
8015 sv_setuv(sv, (UV)IV_MAX + 1);
8017 (void)SvIOK_only(sv);
8018 SvIV_set(sv, SvIVX(sv) + 1);
8023 if (flags & SVp_NOK) {
8024 const NV was = SvNVX(sv);
8025 if (NV_OVERFLOWS_INTEGERS_AT &&
8026 was >= NV_OVERFLOWS_INTEGERS_AT) {
8027 /* diag_listed_as: Lost precision when %s %f by 1 */
8028 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8029 "Lost precision when incrementing %" NVff " by 1",
8032 (void)SvNOK_only(sv);
8033 SvNV_set(sv, was + 1.0);
8037 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
8038 if ((flags & SVTYPEMASK) < SVt_PVIV)
8039 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
8040 (void)SvIOK_only(sv);
8045 while (isALPHA(*d)) d++;
8046 while (isDIGIT(*d)) d++;
8047 if (d < SvEND(sv)) {
8048 #ifdef PERL_PRESERVE_IVUV
8049 /* Got to punt this as an integer if needs be, but we don't issue
8050 warnings. Probably ought to make the sv_iv_please() that does
8051 the conversion if possible, and silently. */
8052 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8053 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8054 /* Need to try really hard to see if it's an integer.
8055 9.22337203685478e+18 is an integer.
8056 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8057 so $a="9.22337203685478e+18"; $a+0; $a++
8058 needs to be the same as $a="9.22337203685478e+18"; $a++
8065 /* sv_2iv *should* have made this an NV */
8066 if (flags & SVp_NOK) {
8067 (void)SvNOK_only(sv);
8068 SvNV_set(sv, SvNVX(sv) + 1.0);
8071 /* I don't think we can get here. Maybe I should assert this
8072 And if we do get here I suspect that sv_setnv will croak. NWC
8074 #if defined(USE_LONG_DOUBLE)
8075 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",
8076 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8078 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8079 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8082 #endif /* PERL_PRESERVE_IVUV */
8083 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8087 while (d >= SvPVX_const(sv)) {
8095 /* MKS: The original code here died if letters weren't consecutive.
8096 * at least it didn't have to worry about non-C locales. The
8097 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8098 * arranged in order (although not consecutively) and that only
8099 * [A-Za-z] are accepted by isALPHA in the C locale.
8101 if (*d != 'z' && *d != 'Z') {
8102 do { ++*d; } while (!isALPHA(*d));
8105 *(d--) -= 'z' - 'a';
8110 *(d--) -= 'z' - 'a' + 1;
8114 /* oh,oh, the number grew */
8115 SvGROW(sv, SvCUR(sv) + 2);
8116 SvCUR_set(sv, SvCUR(sv) + 1);
8117 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8128 Auto-decrement of the value in the SV, doing string to numeric conversion
8129 if necessary. Handles 'get' magic and operator overloading.
8135 Perl_sv_dec(pTHX_ register SV *const sv)
8145 =for apidoc sv_dec_nomg
8147 Auto-decrement of the value in the SV, doing string to numeric conversion
8148 if necessary. Handles operator overloading. Skips handling 'get' magic.
8154 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8161 if (SvTHINKFIRST(sv)) {
8162 if (SvIsCOW(sv) || isGV_with_GP(sv))
8163 sv_force_normal_flags(sv, 0);
8164 if (SvREADONLY(sv)) {
8165 if (IN_PERL_RUNTIME)
8166 Perl_croak_no_modify(aTHX);
8170 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8172 i = PTR2IV(SvRV(sv));
8177 /* Unlike sv_inc we don't have to worry about string-never-numbers
8178 and keeping them magic. But we mustn't warn on punting */
8179 flags = SvFLAGS(sv);
8180 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8181 /* It's publicly an integer, or privately an integer-not-float */
8182 #ifdef PERL_PRESERVE_IVUV
8186 if (SvUVX(sv) == 0) {
8187 (void)SvIOK_only(sv);
8191 (void)SvIOK_only_UV(sv);
8192 SvUV_set(sv, SvUVX(sv) - 1);
8195 if (SvIVX(sv) == IV_MIN) {
8196 sv_setnv(sv, (NV)IV_MIN);
8200 (void)SvIOK_only(sv);
8201 SvIV_set(sv, SvIVX(sv) - 1);
8206 if (flags & SVp_NOK) {
8209 const NV was = SvNVX(sv);
8210 if (NV_OVERFLOWS_INTEGERS_AT &&
8211 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8212 /* diag_listed_as: Lost precision when %s %f by 1 */
8213 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8214 "Lost precision when decrementing %" NVff " by 1",
8217 (void)SvNOK_only(sv);
8218 SvNV_set(sv, was - 1.0);
8222 if (!(flags & SVp_POK)) {
8223 if ((flags & SVTYPEMASK) < SVt_PVIV)
8224 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8226 (void)SvIOK_only(sv);
8229 #ifdef PERL_PRESERVE_IVUV
8231 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8232 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8233 /* Need to try really hard to see if it's an integer.
8234 9.22337203685478e+18 is an integer.
8235 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8236 so $a="9.22337203685478e+18"; $a+0; $a--
8237 needs to be the same as $a="9.22337203685478e+18"; $a--
8244 /* sv_2iv *should* have made this an NV */
8245 if (flags & SVp_NOK) {
8246 (void)SvNOK_only(sv);
8247 SvNV_set(sv, SvNVX(sv) - 1.0);
8250 /* I don't think we can get here. Maybe I should assert this
8251 And if we do get here I suspect that sv_setnv will croak. NWC
8253 #if defined(USE_LONG_DOUBLE)
8254 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",
8255 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8257 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8258 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8262 #endif /* PERL_PRESERVE_IVUV */
8263 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8266 /* this define is used to eliminate a chunk of duplicated but shared logic
8267 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8268 * used anywhere but here - yves
8270 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8273 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8277 =for apidoc sv_mortalcopy
8279 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8280 The new SV is marked as mortal. It will be destroyed "soon", either by an
8281 explicit call to FREETMPS, or by an implicit call at places such as
8282 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8287 /* Make a string that will exist for the duration of the expression
8288 * evaluation. Actually, it may have to last longer than that, but
8289 * hopefully we won't free it until it has been assigned to a
8290 * permanent location. */
8293 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8299 sv_setsv(sv,oldstr);
8300 PUSH_EXTEND_MORTAL__SV_C(sv);
8306 =for apidoc sv_newmortal
8308 Creates a new null SV which is mortal. The reference count of the SV is
8309 set to 1. It will be destroyed "soon", either by an explicit call to
8310 FREETMPS, or by an implicit call at places such as statement boundaries.
8311 See also C<sv_mortalcopy> and C<sv_2mortal>.
8317 Perl_sv_newmortal(pTHX)
8323 SvFLAGS(sv) = SVs_TEMP;
8324 PUSH_EXTEND_MORTAL__SV_C(sv);
8330 =for apidoc newSVpvn_flags
8332 Creates a new SV and copies a string into it. The reference count for the
8333 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8334 string. You are responsible for ensuring that the source string is at least
8335 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8336 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8337 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8338 returning. If C<SVf_UTF8> is set, C<s>
8339 is considered to be in UTF-8 and the
8340 C<SVf_UTF8> flag will be set on the new SV.
8341 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8343 #define newSVpvn_utf8(s, len, u) \
8344 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8350 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8355 /* All the flags we don't support must be zero.
8356 And we're new code so I'm going to assert this from the start. */
8357 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8359 sv_setpvn(sv,s,len);
8361 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8362 * and do what it does ourselves here.
8363 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8364 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8365 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8366 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8369 SvFLAGS(sv) |= flags;
8371 if(flags & SVs_TEMP){
8372 PUSH_EXTEND_MORTAL__SV_C(sv);
8379 =for apidoc sv_2mortal
8381 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8382 by an explicit call to FREETMPS, or by an implicit call at places such as
8383 statement boundaries. SvTEMP() is turned on which means that the SV's
8384 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8385 and C<sv_mortalcopy>.
8391 Perl_sv_2mortal(pTHX_ register SV *const sv)
8396 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8398 PUSH_EXTEND_MORTAL__SV_C(sv);
8406 Creates a new SV and copies a string into it. The reference count for the
8407 SV is set to 1. If C<len> is zero, Perl will compute the length using
8408 strlen(). For efficiency, consider using C<newSVpvn> instead.
8414 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8420 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8425 =for apidoc newSVpvn
8427 Creates a new SV and copies a buffer into it, which may contain NUL characters
8428 (C<\0>) and other binary data. The reference count for the SV is set to 1.
8429 Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
8430 are responsible for ensuring that the source buffer is at least
8431 C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
8438 Perl_newSVpvn(pTHX_ const char *const buffer, const STRLEN len)
8444 sv_setpvn(sv,buffer,len);
8449 =for apidoc newSVhek
8451 Creates a new SV from the hash key structure. It will generate scalars that
8452 point to the shared string table where possible. Returns a new (undefined)
8453 SV if the hek is NULL.
8459 Perl_newSVhek(pTHX_ const HEK *const hek)
8469 if (HEK_LEN(hek) == HEf_SVKEY) {
8470 return newSVsv(*(SV**)HEK_KEY(hek));
8472 const int flags = HEK_FLAGS(hek);
8473 if (flags & HVhek_WASUTF8) {
8475 Andreas would like keys he put in as utf8 to come back as utf8
8477 STRLEN utf8_len = HEK_LEN(hek);
8478 SV * const sv = newSV_type(SVt_PV);
8479 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8480 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8481 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8484 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8485 /* We don't have a pointer to the hv, so we have to replicate the
8486 flag into every HEK. This hv is using custom a hasing
8487 algorithm. Hence we can't return a shared string scalar, as
8488 that would contain the (wrong) hash value, and might get passed
8489 into an hv routine with a regular hash.
8490 Similarly, a hash that isn't using shared hash keys has to have
8491 the flag in every key so that we know not to try to call
8492 share_hek_hek on it. */
8494 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8499 /* This will be overwhelminly the most common case. */
8501 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8502 more efficient than sharepvn(). */
8506 sv_upgrade(sv, SVt_PV);
8507 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8508 SvCUR_set(sv, HEK_LEN(hek));
8521 =for apidoc newSVpvn_share
8523 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8524 table. If the string does not already exist in the table, it is
8525 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8526 is non-zero, that value is used; otherwise the hash is computed.
8527 The string's hash can later be retrieved from the SV
8528 with the C<SvSHARED_HASH()> macro. The idea here is
8529 that as the string table is used for shared hash keys these strings will have
8530 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8536 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8540 bool is_utf8 = FALSE;
8541 const char *const orig_src = src;
8544 STRLEN tmplen = -len;
8546 /* See the note in hv.c:hv_fetch() --jhi */
8547 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8551 PERL_HASH(hash, src, len);
8553 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8554 changes here, update it there too. */
8555 sv_upgrade(sv, SVt_PV);
8556 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8564 if (src != orig_src)
8570 =for apidoc newSVpv_share
8572 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8579 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8581 return newSVpvn_share(src, strlen(src), hash);
8584 #if defined(PERL_IMPLICIT_CONTEXT)
8586 /* pTHX_ magic can't cope with varargs, so this is a no-context
8587 * version of the main function, (which may itself be aliased to us).
8588 * Don't access this version directly.
8592 Perl_newSVpvf_nocontext(const char *const pat, ...)
8598 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8600 va_start(args, pat);
8601 sv = vnewSVpvf(pat, &args);
8608 =for apidoc newSVpvf
8610 Creates a new SV and initializes it with the string formatted like
8617 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8622 PERL_ARGS_ASSERT_NEWSVPVF;
8624 va_start(args, pat);
8625 sv = vnewSVpvf(pat, &args);
8630 /* backend for newSVpvf() and newSVpvf_nocontext() */
8633 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8638 PERL_ARGS_ASSERT_VNEWSVPVF;
8641 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8648 Creates a new SV and copies a floating point value into it.
8649 The reference count for the SV is set to 1.
8655 Perl_newSVnv(pTHX_ const NV n)
8668 Creates a new SV and copies an integer into it. The reference count for the
8675 Perl_newSViv(pTHX_ const IV i)
8688 Creates a new SV and copies an unsigned integer into it.
8689 The reference count for the SV is set to 1.
8695 Perl_newSVuv(pTHX_ const UV u)
8706 =for apidoc newSV_type
8708 Creates a new SV, of the type specified. The reference count for the new SV
8715 Perl_newSV_type(pTHX_ const svtype type)
8720 sv_upgrade(sv, type);
8725 =for apidoc newRV_noinc
8727 Creates an RV wrapper for an SV. The reference count for the original
8728 SV is B<not> incremented.
8734 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8737 register SV *sv = newSV_type(SVt_IV);
8739 PERL_ARGS_ASSERT_NEWRV_NOINC;
8742 SvRV_set(sv, tmpRef);
8747 /* newRV_inc is the official function name to use now.
8748 * newRV_inc is in fact #defined to newRV in sv.h
8752 Perl_newRV(pTHX_ SV *const sv)
8756 PERL_ARGS_ASSERT_NEWRV;
8758 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8764 Creates a new SV which is an exact duplicate of the original SV.
8771 Perl_newSVsv(pTHX_ register SV *const old)
8778 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8779 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8783 /* SV_GMAGIC is the default for sv_setv()
8784 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8785 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8786 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8791 =for apidoc sv_reset
8793 Underlying implementation for the C<reset> Perl function.
8794 Note that the perl-level function is vaguely deprecated.
8800 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8803 char todo[PERL_UCHAR_MAX+1];
8805 PERL_ARGS_ASSERT_SV_RESET;
8810 if (!*s) { /* reset ?? searches */
8811 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8813 const U32 count = mg->mg_len / sizeof(PMOP**);
8814 PMOP **pmp = (PMOP**) mg->mg_ptr;
8815 PMOP *const *const end = pmp + count;
8819 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8821 (*pmp)->op_pmflags &= ~PMf_USED;
8829 /* reset variables */
8831 if (!HvARRAY(stash))
8834 Zero(todo, 256, char);
8837 I32 i = (unsigned char)*s;
8841 max = (unsigned char)*s++;
8842 for ( ; i <= max; i++) {
8845 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8847 for (entry = HvARRAY(stash)[i];
8849 entry = HeNEXT(entry))
8854 if (!todo[(U8)*HeKEY(entry)])
8856 gv = MUTABLE_GV(HeVAL(entry));
8859 if (SvTHINKFIRST(sv)) {
8860 if (!SvREADONLY(sv) && SvROK(sv))
8862 /* XXX Is this continue a bug? Why should THINKFIRST
8863 exempt us from resetting arrays and hashes? */
8867 if (SvTYPE(sv) >= SVt_PV) {
8869 if (SvPVX_const(sv) != NULL)
8877 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8879 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8882 # if defined(USE_ENVIRON_ARRAY)
8885 # endif /* USE_ENVIRON_ARRAY */
8896 Using various gambits, try to get an IO from an SV: the IO slot if its a
8897 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8898 named after the PV if we're a string.
8900 'Get' magic is ignored on the sv passed in, but will be called on
8901 C<SvRV(sv)> if sv is an RV.
8907 Perl_sv_2io(pTHX_ SV *const sv)
8912 PERL_ARGS_ASSERT_SV_2IO;
8914 switch (SvTYPE(sv)) {
8916 io = MUTABLE_IO(sv);
8920 if (isGV_with_GP(sv)) {
8921 gv = MUTABLE_GV(sv);
8924 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8925 HEKfARG(GvNAME_HEK(gv)));
8931 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8933 SvGETMAGIC(SvRV(sv));
8934 return sv_2io(SvRV(sv));
8936 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8943 if (SvGMAGICAL(sv)) {
8944 newsv = sv_newmortal();
8945 sv_setsv_nomg(newsv, sv);
8947 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8957 Using various gambits, try to get a CV from an SV; in addition, try if
8958 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8959 The flags in C<lref> are passed to gv_fetchsv.
8965 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8971 PERL_ARGS_ASSERT_SV_2CV;
8978 switch (SvTYPE(sv)) {
8982 return MUTABLE_CV(sv);
8992 sv = amagic_deref_call(sv, to_cv_amg);
8995 if (SvTYPE(sv) == SVt_PVCV) {
8996 cv = MUTABLE_CV(sv);
9001 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
9002 gv = MUTABLE_GV(sv);
9004 Perl_croak(aTHX_ "Not a subroutine reference");
9006 else if (isGV_with_GP(sv)) {
9007 gv = MUTABLE_GV(sv);
9010 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
9017 /* Some flags to gv_fetchsv mean don't really create the GV */
9018 if (!isGV_with_GP(gv)) {
9023 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
9027 gv_efullname3(tmpsv, gv, NULL);
9028 /* XXX this is probably not what they think they're getting.
9029 * It has the same effect as "sub name;", i.e. just a forward
9031 newSUB(start_subparse(FALSE, 0),
9032 newSVOP(OP_CONST, 0, tmpsv),
9036 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
9037 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
9046 Returns true if the SV has a true value by Perl's rules.
9047 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
9048 instead use an in-line version.
9054 Perl_sv_true(pTHX_ register SV *const sv)
9059 register const XPV* const tXpv = (XPV*)SvANY(sv);
9061 (tXpv->xpv_cur > 1 ||
9062 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9069 return SvIVX(sv) != 0;
9072 return SvNVX(sv) != 0.0;
9074 return sv_2bool(sv);
9080 =for apidoc sv_pvn_force
9082 Get a sensible string out of the SV somehow.
9083 A private implementation of the C<SvPV_force> macro for compilers which
9084 can't cope with complex macro expressions. Always use the macro instead.
9086 =for apidoc sv_pvn_force_flags
9088 Get a sensible string out of the SV somehow.
9089 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9090 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9091 implemented in terms of this function.
9092 You normally want to use the various wrapper macros instead: see
9093 C<SvPV_force> and C<SvPV_force_nomg>
9099 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9103 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9105 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9106 if (SvTHINKFIRST(sv) && !SvROK(sv))
9107 sv_force_normal_flags(sv, 0);
9117 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9118 const char * const ref = sv_reftype(sv,0);
9120 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9121 ref, OP_DESC(PL_op));
9123 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9125 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9126 || isGV_with_GP(sv))
9127 /* diag_listed_as: Can't coerce %s to %s in %s */
9128 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9130 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9137 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9140 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9141 SvGROW(sv, len + 1);
9142 Move(s,SvPVX(sv),len,char);
9144 SvPVX(sv)[len] = '\0';
9147 SvPOK_on(sv); /* validate pointer */
9149 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9150 PTR2UV(sv),SvPVX_const(sv)));
9153 return SvPVX_mutable(sv);
9157 =for apidoc sv_pvbyten_force
9159 The backend for the C<SvPVbytex_force> macro. Always use the macro
9166 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9168 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9170 sv_pvn_force(sv,lp);
9171 sv_utf8_downgrade(sv,0);
9177 =for apidoc sv_pvutf8n_force
9179 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9186 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9188 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9190 sv_pvn_force(sv,lp);
9191 sv_utf8_upgrade(sv);
9197 =for apidoc sv_reftype
9199 Returns a string describing what the SV is a reference to.
9205 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9207 PERL_ARGS_ASSERT_SV_REFTYPE;
9208 if (ob && SvOBJECT(sv)) {
9209 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9212 switch (SvTYPE(sv)) {
9227 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9228 /* tied lvalues should appear to be
9229 * scalars for backwards compatibility */
9230 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9231 ? "SCALAR" : "LVALUE");
9232 case SVt_PVAV: return "ARRAY";
9233 case SVt_PVHV: return "HASH";
9234 case SVt_PVCV: return "CODE";
9235 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9236 ? "GLOB" : "SCALAR");
9237 case SVt_PVFM: return "FORMAT";
9238 case SVt_PVIO: return "IO";
9239 case SVt_BIND: return "BIND";
9240 case SVt_REGEXP: return "REGEXP";
9241 default: return "UNKNOWN";
9249 Returns a SV describing what the SV passed in is a reference to.
9255 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9257 PERL_ARGS_ASSERT_SV_REF;
9260 dst = sv_newmortal();
9262 if (ob && SvOBJECT(sv)) {
9263 HvNAME_get(SvSTASH(sv))
9264 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9265 : sv_setpvn(dst, "__ANON__", 8);
9268 const char * reftype = sv_reftype(sv, 0);
9269 sv_setpv(dst, reftype);
9275 =for apidoc sv_isobject
9277 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9278 object. If the SV is not an RV, or if the object is not blessed, then this
9285 Perl_sv_isobject(pTHX_ SV *sv)
9301 Returns a boolean indicating whether the SV is blessed into the specified
9302 class. This does not check for subtypes; use C<sv_derived_from> to verify
9303 an inheritance relationship.
9309 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9313 PERL_ARGS_ASSERT_SV_ISA;
9323 hvname = HvNAME_get(SvSTASH(sv));
9327 return strEQ(hvname, name);
9333 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9334 it will be upgraded to one. If C<classname> is non-null then the new SV will
9335 be blessed in the specified package. The new SV is returned and its
9336 reference count is 1.
9342 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9347 PERL_ARGS_ASSERT_NEWSVRV;
9351 SV_CHECK_THINKFIRST_COW_DROP(rv);
9353 if (SvTYPE(rv) >= SVt_PVMG) {
9354 const U32 refcnt = SvREFCNT(rv);
9358 SvREFCNT(rv) = refcnt;
9360 sv_upgrade(rv, SVt_IV);
9361 } else if (SvROK(rv)) {
9362 SvREFCNT_dec(SvRV(rv));
9364 prepare_SV_for_RV(rv);
9372 HV* const stash = gv_stashpv(classname, GV_ADD);
9373 (void)sv_bless(rv, stash);
9379 =for apidoc sv_setref_pv
9381 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9382 argument will be upgraded to an RV. That RV will be modified to point to
9383 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9384 into the SV. The C<classname> argument indicates the package for the
9385 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9386 will have a reference count of 1, and the RV will be returned.
9388 Do not use with other Perl types such as HV, AV, SV, CV, because those
9389 objects will become corrupted by the pointer copy process.
9391 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9397 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9401 PERL_ARGS_ASSERT_SV_SETREF_PV;
9404 sv_setsv(rv, &PL_sv_undef);
9408 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9413 =for apidoc sv_setref_iv
9415 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9416 argument will be upgraded to an RV. That RV will be modified to point to
9417 the new SV. The C<classname> argument indicates the package for the
9418 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9419 will have a reference count of 1, and the RV will be returned.
9425 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9427 PERL_ARGS_ASSERT_SV_SETREF_IV;
9429 sv_setiv(newSVrv(rv,classname), iv);
9434 =for apidoc sv_setref_uv
9436 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9437 argument will be upgraded to an RV. That RV will be modified to point to
9438 the new SV. The C<classname> argument indicates the package for the
9439 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9440 will have a reference count of 1, and the RV will be returned.
9446 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9448 PERL_ARGS_ASSERT_SV_SETREF_UV;
9450 sv_setuv(newSVrv(rv,classname), uv);
9455 =for apidoc sv_setref_nv
9457 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9458 argument will be upgraded to an RV. That RV will be modified to point to
9459 the new SV. The C<classname> argument indicates the package for the
9460 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9461 will have a reference count of 1, and the RV will be returned.
9467 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9469 PERL_ARGS_ASSERT_SV_SETREF_NV;
9471 sv_setnv(newSVrv(rv,classname), nv);
9476 =for apidoc sv_setref_pvn
9478 Copies a string into a new SV, optionally blessing the SV. The length of the
9479 string must be specified with C<n>. The C<rv> argument will be upgraded to
9480 an RV. That RV will be modified to point to the new SV. The C<classname>
9481 argument indicates the package for the blessing. Set C<classname> to
9482 C<NULL> to avoid the blessing. The new SV will have a reference count
9483 of 1, and the RV will be returned.
9485 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9491 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9492 const char *const pv, const STRLEN n)
9494 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9496 sv_setpvn(newSVrv(rv,classname), pv, n);
9501 =for apidoc sv_bless
9503 Blesses an SV into a specified package. The SV must be an RV. The package
9504 must be designated by its stash (see C<gv_stashpv()>). The reference count
9505 of the SV is unaffected.
9511 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9516 PERL_ARGS_ASSERT_SV_BLESS;
9519 Perl_croak(aTHX_ "Can't bless non-reference value");
9521 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9522 if (SvIsCOW(tmpRef))
9523 sv_force_normal_flags(tmpRef, 0);
9524 if (SvREADONLY(tmpRef))
9525 Perl_croak_no_modify(aTHX);
9526 if (SvOBJECT(tmpRef)) {
9527 if (SvTYPE(tmpRef) != SVt_PVIO)
9529 SvREFCNT_dec(SvSTASH(tmpRef));
9532 SvOBJECT_on(tmpRef);
9533 if (SvTYPE(tmpRef) != SVt_PVIO)
9535 SvUPGRADE(tmpRef, SVt_PVMG);
9536 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9538 if(SvSMAGICAL(tmpRef))
9539 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9547 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9548 * as it is after unglobbing it.
9551 PERL_STATIC_INLINE void
9552 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9557 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9559 PERL_ARGS_ASSERT_SV_UNGLOB;
9561 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9563 if (!(flags & SV_COW_DROP_PV))
9564 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9567 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9568 && HvNAME_get(stash))
9569 mro_method_changed_in(stash);
9570 gp_free(MUTABLE_GV(sv));
9573 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9577 if (GvNAME_HEK(sv)) {
9578 unshare_hek(GvNAME_HEK(sv));
9580 isGV_with_GP_off(sv);
9582 if(SvTYPE(sv) == SVt_PVGV) {
9583 /* need to keep SvANY(sv) in the right arena */
9584 xpvmg = new_XPVMG();
9585 StructCopy(SvANY(sv), xpvmg, XPVMG);
9586 del_XPVGV(SvANY(sv));
9589 SvFLAGS(sv) &= ~SVTYPEMASK;
9590 SvFLAGS(sv) |= SVt_PVMG;
9593 /* Intentionally not calling any local SET magic, as this isn't so much a
9594 set operation as merely an internal storage change. */
9595 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9596 else sv_setsv_flags(sv, temp, 0);
9598 if ((const GV *)sv == PL_last_in_gv)
9599 PL_last_in_gv = NULL;
9600 else if ((const GV *)sv == PL_statgv)
9605 =for apidoc sv_unref_flags
9607 Unsets the RV status of the SV, and decrements the reference count of
9608 whatever was being referenced by the RV. This can almost be thought of
9609 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9610 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9611 (otherwise the decrementing is conditional on the reference count being
9612 different from one or the reference being a readonly SV).
9619 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9621 SV* const target = SvRV(ref);
9623 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9625 if (SvWEAKREF(ref)) {
9626 sv_del_backref(target, ref);
9628 SvRV_set(ref, NULL);
9631 SvRV_set(ref, NULL);
9633 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9634 assigned to as BEGIN {$a = \"Foo"} will fail. */
9635 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9636 SvREFCNT_dec(target);
9637 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9638 sv_2mortal(target); /* Schedule for freeing later */
9642 =for apidoc sv_untaint
9644 Untaint an SV. Use C<SvTAINTED_off> instead.
9650 Perl_sv_untaint(pTHX_ SV *const sv)
9652 PERL_ARGS_ASSERT_SV_UNTAINT;
9654 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9655 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9662 =for apidoc sv_tainted
9664 Test an SV for taintedness. Use C<SvTAINTED> instead.
9670 Perl_sv_tainted(pTHX_ SV *const sv)
9672 PERL_ARGS_ASSERT_SV_TAINTED;
9674 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9675 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9676 if (mg && (mg->mg_len & 1) )
9683 =for apidoc sv_setpviv
9685 Copies an integer into the given SV, also updating its string value.
9686 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9692 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9694 char buf[TYPE_CHARS(UV)];
9696 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9698 PERL_ARGS_ASSERT_SV_SETPVIV;
9700 sv_setpvn(sv, ptr, ebuf - ptr);
9704 =for apidoc sv_setpviv_mg
9706 Like C<sv_setpviv>, but also handles 'set' magic.
9712 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9714 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9720 #if defined(PERL_IMPLICIT_CONTEXT)
9722 /* pTHX_ magic can't cope with varargs, so this is a no-context
9723 * version of the main function, (which may itself be aliased to us).
9724 * Don't access this version directly.
9728 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9733 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9735 va_start(args, pat);
9736 sv_vsetpvf(sv, pat, &args);
9740 /* pTHX_ magic can't cope with varargs, so this is a no-context
9741 * version of the main function, (which may itself be aliased to us).
9742 * Don't access this version directly.
9746 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9751 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9753 va_start(args, pat);
9754 sv_vsetpvf_mg(sv, pat, &args);
9760 =for apidoc sv_setpvf
9762 Works like C<sv_catpvf> but copies the text into the SV instead of
9763 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9769 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9773 PERL_ARGS_ASSERT_SV_SETPVF;
9775 va_start(args, pat);
9776 sv_vsetpvf(sv, pat, &args);
9781 =for apidoc sv_vsetpvf
9783 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9784 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9786 Usually used via its frontend C<sv_setpvf>.
9792 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9794 PERL_ARGS_ASSERT_SV_VSETPVF;
9796 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9800 =for apidoc sv_setpvf_mg
9802 Like C<sv_setpvf>, but also handles 'set' magic.
9808 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9812 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9814 va_start(args, pat);
9815 sv_vsetpvf_mg(sv, pat, &args);
9820 =for apidoc sv_vsetpvf_mg
9822 Like C<sv_vsetpvf>, but also handles 'set' magic.
9824 Usually used via its frontend C<sv_setpvf_mg>.
9830 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9832 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9834 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9838 #if defined(PERL_IMPLICIT_CONTEXT)
9840 /* pTHX_ magic can't cope with varargs, so this is a no-context
9841 * version of the main function, (which may itself be aliased to us).
9842 * Don't access this version directly.
9846 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9851 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9853 va_start(args, pat);
9854 sv_vcatpvf(sv, pat, &args);
9858 /* pTHX_ magic can't cope with varargs, so this is a no-context
9859 * version of the main function, (which may itself be aliased to us).
9860 * Don't access this version directly.
9864 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9869 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9871 va_start(args, pat);
9872 sv_vcatpvf_mg(sv, pat, &args);
9878 =for apidoc sv_catpvf
9880 Processes its arguments like C<sprintf> and appends the formatted
9881 output to an SV. If the appended data contains "wide" characters
9882 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9883 and characters >255 formatted with %c), the original SV might get
9884 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9885 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9886 valid UTF-8; if the original SV was bytes, the pattern should be too.
9891 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9895 PERL_ARGS_ASSERT_SV_CATPVF;
9897 va_start(args, pat);
9898 sv_vcatpvf(sv, pat, &args);
9903 =for apidoc sv_vcatpvf
9905 Processes its arguments like C<vsprintf> and appends the formatted output
9906 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9908 Usually used via its frontend C<sv_catpvf>.
9914 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9916 PERL_ARGS_ASSERT_SV_VCATPVF;
9918 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9922 =for apidoc sv_catpvf_mg
9924 Like C<sv_catpvf>, but also handles 'set' magic.
9930 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9934 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9936 va_start(args, pat);
9937 sv_vcatpvf_mg(sv, pat, &args);
9942 =for apidoc sv_vcatpvf_mg
9944 Like C<sv_vcatpvf>, but also handles 'set' magic.
9946 Usually used via its frontend C<sv_catpvf_mg>.
9952 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9954 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9956 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9961 =for apidoc sv_vsetpvfn
9963 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9966 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9972 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9973 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9975 PERL_ARGS_ASSERT_SV_VSETPVFN;
9978 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9983 * Warn of missing argument to sprintf, and then return a defined value
9984 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9986 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9988 S_vcatpvfn_missing_argument(pTHX) {
9989 if (ckWARN(WARN_MISSING)) {
9990 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9991 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9998 S_expect_number(pTHX_ char **const pattern)
10003 PERL_ARGS_ASSERT_EXPECT_NUMBER;
10005 switch (**pattern) {
10006 case '1': case '2': case '3':
10007 case '4': case '5': case '6':
10008 case '7': case '8': case '9':
10009 var = *(*pattern)++ - '0';
10010 while (isDIGIT(**pattern)) {
10011 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
10013 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
10021 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
10023 const int neg = nv < 0;
10026 PERL_ARGS_ASSERT_F0CONVERT;
10034 if (uv & 1 && uv == nv)
10035 uv--; /* Round to even */
10037 const unsigned dig = uv % 10;
10039 } while (uv /= 10);
10050 =for apidoc sv_vcatpvfn
10052 Processes its arguments like C<vsprintf> and appends the formatted output
10053 to an SV. Uses an array of SVs if the C style variable argument list is
10054 missing (NULL). When running with taint checks enabled, indicates via
10055 C<maybe_tainted> if results are untrustworthy (often due to the use of
10058 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10064 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10065 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10066 vec_utf8 = DO_UTF8(vecsv);
10068 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10071 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10072 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10077 const char *patend;
10080 static const char nullstr[] = "(null)";
10082 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10083 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10085 /* Times 4: a decimal digit takes more than 3 binary digits.
10086 * NV_DIG: mantissa takes than many decimal digits.
10087 * Plus 32: Playing safe. */
10088 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10089 /* large enough for "%#.#f" --chip */
10090 /* what about long double NVs? --jhi */
10092 PERL_ARGS_ASSERT_SV_VCATPVFN;
10093 PERL_UNUSED_ARG(maybe_tainted);
10095 /* no matter what, this is a string now */
10096 (void)SvPV_force(sv, origlen);
10098 /* special-case "", "%s", and "%-p" (SVf - see below) */
10101 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10103 const char * const s = va_arg(*args, char*);
10104 sv_catpv(sv, s ? s : nullstr);
10106 else if (svix < svmax) {
10107 sv_catsv(sv, *svargs);
10110 S_vcatpvfn_missing_argument(aTHX);
10113 if (args && patlen == 3 && pat[0] == '%' &&
10114 pat[1] == '-' && pat[2] == 'p') {
10115 argsv = MUTABLE_SV(va_arg(*args, void*));
10116 sv_catsv(sv, argsv);
10120 #ifndef USE_LONG_DOUBLE
10121 /* special-case "%.<number>[gf]" */
10122 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10123 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10124 unsigned digits = 0;
10128 while (*pp >= '0' && *pp <= '9')
10129 digits = 10 * digits + (*pp++ - '0');
10130 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10131 const NV nv = SvNV(*svargs);
10133 /* Add check for digits != 0 because it seems that some
10134 gconverts are buggy in this case, and we don't yet have
10135 a Configure test for this. */
10136 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10137 /* 0, point, slack */
10138 Gconvert(nv, (int)digits, 0, ebuf);
10139 sv_catpv(sv, ebuf);
10140 if (*ebuf) /* May return an empty string for digits==0 */
10143 } else if (!digits) {
10146 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10147 sv_catpvn(sv, p, l);
10153 #endif /* !USE_LONG_DOUBLE */
10155 if (!args && svix < svmax && DO_UTF8(*svargs))
10158 patend = (char*)pat + patlen;
10159 for (p = (char*)pat; p < patend; p = q) {
10162 bool vectorize = FALSE;
10163 bool vectorarg = FALSE;
10164 bool vec_utf8 = FALSE;
10170 bool has_precis = FALSE;
10172 const I32 osvix = svix;
10173 bool is_utf8 = FALSE; /* is this item utf8? */
10174 #ifdef HAS_LDBL_SPRINTF_BUG
10175 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10176 with sfio - Allen <allens@cpan.org> */
10177 bool fix_ldbl_sprintf_bug = FALSE;
10181 U8 utf8buf[UTF8_MAXBYTES+1];
10182 STRLEN esignlen = 0;
10184 const char *eptr = NULL;
10185 const char *fmtstart;
10188 const U8 *vecstr = NULL;
10195 /* we need a long double target in case HAS_LONG_DOUBLE but
10196 not USE_LONG_DOUBLE
10198 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10206 const char *dotstr = ".";
10207 STRLEN dotstrlen = 1;
10208 I32 efix = 0; /* explicit format parameter index */
10209 I32 ewix = 0; /* explicit width index */
10210 I32 epix = 0; /* explicit precision index */
10211 I32 evix = 0; /* explicit vector index */
10212 bool asterisk = FALSE;
10214 /* echo everything up to the next format specification */
10215 for (q = p; q < patend && *q != '%'; ++q) ;
10217 if (has_utf8 && !pat_utf8)
10218 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10220 sv_catpvn(sv, p, q - p);
10229 We allow format specification elements in this order:
10230 \d+\$ explicit format parameter index
10232 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10233 0 flag (as above): repeated to allow "v02"
10234 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10235 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10237 [%bcdefginopsuxDFOUX] format (mandatory)
10242 As of perl5.9.3, printf format checking is on by default.
10243 Internally, perl uses %p formats to provide an escape to
10244 some extended formatting. This block deals with those
10245 extensions: if it does not match, (char*)q is reset and
10246 the normal format processing code is used.
10248 Currently defined extensions are:
10249 %p include pointer address (standard)
10250 %-p (SVf) include an SV (previously %_)
10251 %-<num>p include an SV with precision <num>
10253 %3p include a HEK with precision of 256
10254 %<num>p (where num != 2 or 3) reserved for future
10257 Robin Barker 2005-07-14 (but modified since)
10259 %1p (VDf) removed. RMB 2007-10-19
10266 n = expect_number(&q);
10268 if (sv) { /* SVf */
10273 argsv = MUTABLE_SV(va_arg(*args, void*));
10274 eptr = SvPV_const(argsv, elen);
10275 if (DO_UTF8(argsv))
10279 else if (n==2 || n==3) { /* HEKf */
10280 HEK * const hek = va_arg(*args, HEK *);
10281 eptr = HEK_KEY(hek);
10282 elen = HEK_LEN(hek);
10283 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10284 if (n==3) precis = 256, has_precis = TRUE;
10288 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10289 "internal %%<num>p might conflict with future printf extensions");
10295 if ( (width = expect_number(&q)) ) {
10310 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10339 if ( (ewix = expect_number(&q)) )
10348 if ((vectorarg = asterisk)) {
10361 width = expect_number(&q);
10364 if (vectorize && vectorarg) {
10365 /* vectorizing, but not with the default "." */
10367 vecsv = va_arg(*args, SV*);
10369 vecsv = (evix > 0 && evix <= svmax)
10370 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10372 vecsv = svix < svmax
10373 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10375 dotstr = SvPV_const(vecsv, dotstrlen);
10376 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10377 bad with tied or overloaded values that return UTF8. */
10378 if (DO_UTF8(vecsv))
10380 else if (has_utf8) {
10381 vecsv = sv_mortalcopy(vecsv);
10382 sv_utf8_upgrade(vecsv);
10383 dotstr = SvPV_const(vecsv, dotstrlen);
10390 i = va_arg(*args, int);
10392 i = (ewix ? ewix <= svmax : svix < svmax) ?
10393 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10395 width = (i < 0) ? -i : i;
10405 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10407 /* XXX: todo, support specified precision parameter */
10411 i = va_arg(*args, int);
10413 i = (ewix ? ewix <= svmax : svix < svmax)
10414 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10416 has_precis = !(i < 0);
10420 while (isDIGIT(*q))
10421 precis = precis * 10 + (*q++ - '0');
10430 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10431 vecsv = svargs[efix ? efix-1 : svix++];
10432 vecstr = (U8*)SvPV_const(vecsv,veclen);
10433 vec_utf8 = DO_UTF8(vecsv);
10435 /* if this is a version object, we need to convert
10436 * back into v-string notation and then let the
10437 * vectorize happen normally
10439 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10440 char *version = savesvpv(vecsv);
10441 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10442 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10443 "vector argument not supported with alpha versions");
10446 vecsv = sv_newmortal();
10447 scan_vstring(version, version + veclen, vecsv);
10448 vecstr = (U8*)SvPV_const(vecsv, veclen);
10449 vec_utf8 = DO_UTF8(vecsv);
10463 case 'I': /* Ix, I32x, and I64x */
10465 if (q[1] == '6' && q[2] == '4') {
10471 if (q[1] == '3' && q[2] == '2') {
10481 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10493 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10494 if (*q == 'l') { /* lld, llf */
10503 if (*++q == 'h') { /* hhd, hhu */
10532 if (!vectorize && !args) {
10534 const I32 i = efix-1;
10535 argsv = (i >= 0 && i < svmax)
10536 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10538 argsv = (svix >= 0 && svix < svmax)
10539 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10543 switch (c = *q++) {
10550 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10552 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10554 eptr = (char*)utf8buf;
10555 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10569 eptr = va_arg(*args, char*);
10571 elen = strlen(eptr);
10573 eptr = (char *)nullstr;
10574 elen = sizeof nullstr - 1;
10578 eptr = SvPV_const(argsv, elen);
10579 if (DO_UTF8(argsv)) {
10580 STRLEN old_precis = precis;
10581 if (has_precis && precis < elen) {
10582 STRLEN ulen = sv_len_utf8(argsv);
10583 I32 p = precis > ulen ? ulen : precis;
10584 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10587 if (width) { /* fudge width (can't fudge elen) */
10588 if (has_precis && precis < elen)
10589 width += precis - old_precis;
10591 width += elen - sv_len_utf8(argsv);
10598 if (has_precis && precis < elen)
10605 if (alt || vectorize)
10607 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10628 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10637 esignbuf[esignlen++] = plus;
10641 case 'c': iv = (char)va_arg(*args, int); break;
10642 case 'h': iv = (short)va_arg(*args, int); break;
10643 case 'l': iv = va_arg(*args, long); break;
10644 case 'V': iv = va_arg(*args, IV); break;
10645 case 'z': iv = va_arg(*args, SSize_t); break;
10646 case 't': iv = va_arg(*args, ptrdiff_t); break;
10647 default: iv = va_arg(*args, int); break;
10649 case 'j': iv = va_arg(*args, intmax_t); break;
10653 iv = va_arg(*args, Quad_t); break;
10660 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10662 case 'c': iv = (char)tiv; break;
10663 case 'h': iv = (short)tiv; break;
10664 case 'l': iv = (long)tiv; break;
10666 default: iv = tiv; break;
10669 iv = (Quad_t)tiv; break;
10675 if ( !vectorize ) /* we already set uv above */
10680 esignbuf[esignlen++] = plus;
10684 esignbuf[esignlen++] = '-';
10728 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10739 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10740 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10741 case 'l': uv = va_arg(*args, unsigned long); break;
10742 case 'V': uv = va_arg(*args, UV); break;
10743 case 'z': uv = va_arg(*args, Size_t); break;
10744 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10746 case 'j': uv = va_arg(*args, uintmax_t); break;
10748 default: uv = va_arg(*args, unsigned); break;
10751 uv = va_arg(*args, Uquad_t); break;
10758 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10760 case 'c': uv = (unsigned char)tuv; break;
10761 case 'h': uv = (unsigned short)tuv; break;
10762 case 'l': uv = (unsigned long)tuv; break;
10764 default: uv = tuv; break;
10767 uv = (Uquad_t)tuv; break;
10776 char *ptr = ebuf + sizeof ebuf;
10777 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10783 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10787 } while (uv >>= 4);
10789 esignbuf[esignlen++] = '0';
10790 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10796 *--ptr = '0' + dig;
10797 } while (uv >>= 3);
10798 if (alt && *ptr != '0')
10804 *--ptr = '0' + dig;
10805 } while (uv >>= 1);
10807 esignbuf[esignlen++] = '0';
10808 esignbuf[esignlen++] = c;
10811 default: /* it had better be ten or less */
10814 *--ptr = '0' + dig;
10815 } while (uv /= base);
10818 elen = (ebuf + sizeof ebuf) - ptr;
10822 zeros = precis - elen;
10823 else if (precis == 0 && elen == 1 && *eptr == '0'
10824 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10827 /* a precision nullifies the 0 flag. */
10834 /* FLOATING POINT */
10837 c = 'f'; /* maybe %F isn't supported here */
10839 case 'e': case 'E':
10841 case 'g': case 'G':
10845 /* This is evil, but floating point is even more evil */
10847 /* for SV-style calling, we can only get NV
10848 for C-style calling, we assume %f is double;
10849 for simplicity we allow any of %Lf, %llf, %qf for long double
10853 #if defined(USE_LONG_DOUBLE)
10857 /* [perl #20339] - we should accept and ignore %lf rather than die */
10861 #if defined(USE_LONG_DOUBLE)
10862 intsize = args ? 0 : 'q';
10866 #if defined(HAS_LONG_DOUBLE)
10879 /* now we need (long double) if intsize == 'q', else (double) */
10881 #if LONG_DOUBLESIZE > DOUBLESIZE
10883 va_arg(*args, long double) :
10884 va_arg(*args, double)
10886 va_arg(*args, double)
10891 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10892 else. frexp() has some unspecified behaviour for those three */
10893 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10895 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10896 will cast our (long double) to (double) */
10897 (void)Perl_frexp(nv, &i);
10898 if (i == PERL_INT_MIN)
10899 Perl_die(aTHX_ "panic: frexp");
10901 need = BIT_DIGITS(i);
10903 need += has_precis ? precis : 6; /* known default */
10908 #ifdef HAS_LDBL_SPRINTF_BUG
10909 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10910 with sfio - Allen <allens@cpan.org> */
10913 # define MY_DBL_MAX DBL_MAX
10914 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10915 # if DOUBLESIZE >= 8
10916 # define MY_DBL_MAX 1.7976931348623157E+308L
10918 # define MY_DBL_MAX 3.40282347E+38L
10922 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10923 # define MY_DBL_MAX_BUG 1L
10925 # define MY_DBL_MAX_BUG MY_DBL_MAX
10929 # define MY_DBL_MIN DBL_MIN
10930 # else /* XXX guessing! -Allen */
10931 # if DOUBLESIZE >= 8
10932 # define MY_DBL_MIN 2.2250738585072014E-308L
10934 # define MY_DBL_MIN 1.17549435E-38L
10938 if ((intsize == 'q') && (c == 'f') &&
10939 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10940 (need < DBL_DIG)) {
10941 /* it's going to be short enough that
10942 * long double precision is not needed */
10944 if ((nv <= 0L) && (nv >= -0L))
10945 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10947 /* would use Perl_fp_class as a double-check but not
10948 * functional on IRIX - see perl.h comments */
10950 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10951 /* It's within the range that a double can represent */
10952 #if defined(DBL_MAX) && !defined(DBL_MIN)
10953 if ((nv >= ((long double)1/DBL_MAX)) ||
10954 (nv <= (-(long double)1/DBL_MAX)))
10956 fix_ldbl_sprintf_bug = TRUE;
10959 if (fix_ldbl_sprintf_bug == TRUE) {
10969 # undef MY_DBL_MAX_BUG
10972 #endif /* HAS_LDBL_SPRINTF_BUG */
10974 need += 20; /* fudge factor */
10975 if (PL_efloatsize < need) {
10976 Safefree(PL_efloatbuf);
10977 PL_efloatsize = need + 20; /* more fudge */
10978 Newx(PL_efloatbuf, PL_efloatsize, char);
10979 PL_efloatbuf[0] = '\0';
10982 if ( !(width || left || plus || alt) && fill != '0'
10983 && has_precis && intsize != 'q' ) { /* Shortcuts */
10984 /* See earlier comment about buggy Gconvert when digits,
10986 if ( c == 'g' && precis) {
10987 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10988 /* May return an empty string for digits==0 */
10989 if (*PL_efloatbuf) {
10990 elen = strlen(PL_efloatbuf);
10991 goto float_converted;
10993 } else if ( c == 'f' && !precis) {
10994 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10999 char *ptr = ebuf + sizeof ebuf;
11002 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
11003 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
11004 if (intsize == 'q') {
11005 /* Copy the one or more characters in a long double
11006 * format before the 'base' ([efgEFG]) character to
11007 * the format string. */
11008 static char const prifldbl[] = PERL_PRIfldbl;
11009 char const *p = prifldbl + sizeof(prifldbl) - 3;
11010 while (p >= prifldbl) { *--ptr = *p--; }
11015 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11020 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11032 /* No taint. Otherwise we are in the strange situation
11033 * where printf() taints but print($float) doesn't.
11035 #if defined(HAS_LONG_DOUBLE)
11036 elen = ((intsize == 'q')
11037 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
11038 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
11040 elen = my_sprintf(PL_efloatbuf, ptr, nv);
11044 eptr = PL_efloatbuf;
11052 i = SvCUR(sv) - origlen;
11055 case 'c': *(va_arg(*args, char*)) = i; break;
11056 case 'h': *(va_arg(*args, short*)) = i; break;
11057 default: *(va_arg(*args, int*)) = i; break;
11058 case 'l': *(va_arg(*args, long*)) = i; break;
11059 case 'V': *(va_arg(*args, IV*)) = i; break;
11060 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11061 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11063 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11067 *(va_arg(*args, Quad_t*)) = i; break;
11074 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11075 continue; /* not "break" */
11082 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11083 && ckWARN(WARN_PRINTF))
11085 SV * const msg = sv_newmortal();
11086 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11087 (PL_op->op_type == OP_PRTF) ? "" : "s");
11088 if (fmtstart < patend) {
11089 const char * const fmtend = q < patend ? q : patend;
11091 sv_catpvs(msg, "\"%");
11092 for (f = fmtstart; f < fmtend; f++) {
11094 sv_catpvn(msg, f, 1);
11096 Perl_sv_catpvf(aTHX_ msg,
11097 "\\%03"UVof, (UV)*f & 0xFF);
11100 sv_catpvs(msg, "\"");
11102 sv_catpvs(msg, "end of string");
11104 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11107 /* output mangled stuff ... */
11113 /* ... right here, because formatting flags should not apply */
11114 SvGROW(sv, SvCUR(sv) + elen + 1);
11116 Copy(eptr, p, elen, char);
11119 SvCUR_set(sv, p - SvPVX_const(sv));
11121 continue; /* not "break" */
11124 if (is_utf8 != has_utf8) {
11127 sv_utf8_upgrade(sv);
11130 const STRLEN old_elen = elen;
11131 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11132 sv_utf8_upgrade(nsv);
11133 eptr = SvPVX_const(nsv);
11136 if (width) { /* fudge width (can't fudge elen) */
11137 width += elen - old_elen;
11143 have = esignlen + zeros + elen;
11145 Perl_croak_nocontext("%s", PL_memory_wrap);
11147 need = (have > width ? have : width);
11150 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11151 Perl_croak_nocontext("%s", PL_memory_wrap);
11152 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11154 if (esignlen && fill == '0') {
11156 for (i = 0; i < (int)esignlen; i++)
11157 *p++ = esignbuf[i];
11159 if (gap && !left) {
11160 memset(p, fill, gap);
11163 if (esignlen && fill != '0') {
11165 for (i = 0; i < (int)esignlen; i++)
11166 *p++ = esignbuf[i];
11170 for (i = zeros; i; i--)
11174 Copy(eptr, p, elen, char);
11178 memset(p, ' ', gap);
11183 Copy(dotstr, p, dotstrlen, char);
11187 vectorize = FALSE; /* done iterating over vecstr */
11194 SvCUR_set(sv, p - SvPVX_const(sv));
11203 /* =========================================================================
11205 =head1 Cloning an interpreter
11207 All the macros and functions in this section are for the private use of
11208 the main function, perl_clone().
11210 The foo_dup() functions make an exact copy of an existing foo thingy.
11211 During the course of a cloning, a hash table is used to map old addresses
11212 to new addresses. The table is created and manipulated with the
11213 ptr_table_* functions.
11217 * =========================================================================*/
11220 #if defined(USE_ITHREADS)
11222 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11223 #ifndef GpREFCNT_inc
11224 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11228 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11229 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11230 If this changes, please unmerge ss_dup.
11231 Likewise, sv_dup_inc_multiple() relies on this fact. */
11232 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11233 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11234 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11235 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11236 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11237 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11238 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11239 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11240 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11241 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11242 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11243 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11244 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11246 /* clone a parser */
11249 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11253 PERL_ARGS_ASSERT_PARSER_DUP;
11258 /* look for it in the table first */
11259 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11263 /* create anew and remember what it is */
11264 Newxz(parser, 1, yy_parser);
11265 ptr_table_store(PL_ptr_table, proto, parser);
11267 /* XXX these not yet duped */
11268 parser->old_parser = NULL;
11269 parser->stack = NULL;
11271 parser->stack_size = 0;
11272 /* XXX parser->stack->state = 0; */
11274 /* XXX eventually, just Copy() most of the parser struct ? */
11276 parser->lex_brackets = proto->lex_brackets;
11277 parser->lex_casemods = proto->lex_casemods;
11278 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11279 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11280 parser->lex_casestack = savepvn(proto->lex_casestack,
11281 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11282 parser->lex_defer = proto->lex_defer;
11283 parser->lex_dojoin = proto->lex_dojoin;
11284 parser->lex_expect = proto->lex_expect;
11285 parser->lex_formbrack = proto->lex_formbrack;
11286 parser->lex_inpat = proto->lex_inpat;
11287 parser->lex_inwhat = proto->lex_inwhat;
11288 parser->lex_op = proto->lex_op;
11289 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11290 parser->lex_starts = proto->lex_starts;
11291 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11292 parser->multi_close = proto->multi_close;
11293 parser->multi_open = proto->multi_open;
11294 parser->multi_start = proto->multi_start;
11295 parser->multi_end = proto->multi_end;
11296 parser->pending_ident = proto->pending_ident;
11297 parser->preambled = proto->preambled;
11298 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11299 parser->linestr = sv_dup_inc(proto->linestr, param);
11300 parser->expect = proto->expect;
11301 parser->copline = proto->copline;
11302 parser->last_lop_op = proto->last_lop_op;
11303 parser->lex_state = proto->lex_state;
11304 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11305 /* rsfp_filters entries have fake IoDIRP() */
11306 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11307 parser->in_my = proto->in_my;
11308 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11309 parser->error_count = proto->error_count;
11312 parser->linestr = sv_dup_inc(proto->linestr, param);
11315 char * const ols = SvPVX(proto->linestr);
11316 char * const ls = SvPVX(parser->linestr);
11318 parser->bufptr = ls + (proto->bufptr >= ols ?
11319 proto->bufptr - ols : 0);
11320 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11321 proto->oldbufptr - ols : 0);
11322 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11323 proto->oldoldbufptr - ols : 0);
11324 parser->linestart = ls + (proto->linestart >= ols ?
11325 proto->linestart - ols : 0);
11326 parser->last_uni = ls + (proto->last_uni >= ols ?
11327 proto->last_uni - ols : 0);
11328 parser->last_lop = ls + (proto->last_lop >= ols ?
11329 proto->last_lop - ols : 0);
11331 parser->bufend = ls + SvCUR(parser->linestr);
11334 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11338 parser->endwhite = proto->endwhite;
11339 parser->faketokens = proto->faketokens;
11340 parser->lasttoke = proto->lasttoke;
11341 parser->nextwhite = proto->nextwhite;
11342 parser->realtokenstart = proto->realtokenstart;
11343 parser->skipwhite = proto->skipwhite;
11344 parser->thisclose = proto->thisclose;
11345 parser->thismad = proto->thismad;
11346 parser->thisopen = proto->thisopen;
11347 parser->thisstuff = proto->thisstuff;
11348 parser->thistoken = proto->thistoken;
11349 parser->thiswhite = proto->thiswhite;
11351 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11352 parser->curforce = proto->curforce;
11354 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11355 Copy(proto->nexttype, parser->nexttype, 5, I32);
11356 parser->nexttoke = proto->nexttoke;
11359 /* XXX should clone saved_curcop here, but we aren't passed
11360 * proto_perl; so do it in perl_clone_using instead */
11366 /* duplicate a file handle */
11369 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11373 PERL_ARGS_ASSERT_FP_DUP;
11374 PERL_UNUSED_ARG(type);
11377 return (PerlIO*)NULL;
11379 /* look for it in the table first */
11380 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11384 /* create anew and remember what it is */
11385 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11386 ptr_table_store(PL_ptr_table, fp, ret);
11390 /* duplicate a directory handle */
11393 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11399 register const Direntry_t *dirent;
11400 char smallbuf[256];
11406 PERL_UNUSED_CONTEXT;
11407 PERL_ARGS_ASSERT_DIRP_DUP;
11412 /* look for it in the table first */
11413 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11419 PERL_UNUSED_ARG(param);
11423 /* open the current directory (so we can switch back) */
11424 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11426 /* chdir to our dir handle and open the present working directory */
11427 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11428 PerlDir_close(pwd);
11429 return (DIR *)NULL;
11431 /* Now we should have two dir handles pointing to the same dir. */
11433 /* Be nice to the calling code and chdir back to where we were. */
11434 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11436 /* We have no need of the pwd handle any more. */
11437 PerlDir_close(pwd);
11440 # define d_namlen(d) (d)->d_namlen
11442 # define d_namlen(d) strlen((d)->d_name)
11444 /* Iterate once through dp, to get the file name at the current posi-
11445 tion. Then step back. */
11446 pos = PerlDir_tell(dp);
11447 if ((dirent = PerlDir_read(dp))) {
11448 len = d_namlen(dirent);
11449 if (len <= sizeof smallbuf) name = smallbuf;
11450 else Newx(name, len, char);
11451 Move(dirent->d_name, name, len, char);
11453 PerlDir_seek(dp, pos);
11455 /* Iterate through the new dir handle, till we find a file with the
11457 if (!dirent) /* just before the end */
11459 pos = PerlDir_tell(ret);
11460 if (PerlDir_read(ret)) continue; /* not there yet */
11461 PerlDir_seek(ret, pos); /* step back */
11465 const long pos0 = PerlDir_tell(ret);
11467 pos = PerlDir_tell(ret);
11468 if ((dirent = PerlDir_read(ret))) {
11469 if (len == d_namlen(dirent)
11470 && memEQ(name, dirent->d_name, len)) {
11472 PerlDir_seek(ret, pos); /* step back */
11475 /* else we are not there yet; keep iterating */
11477 else { /* This is not meant to happen. The best we can do is
11478 reset the iterator to the beginning. */
11479 PerlDir_seek(ret, pos0);
11486 if (name && name != smallbuf)
11491 ret = win32_dirp_dup(dp, param);
11494 /* pop it in the pointer table */
11496 ptr_table_store(PL_ptr_table, dp, ret);
11501 /* duplicate a typeglob */
11504 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11508 PERL_ARGS_ASSERT_GP_DUP;
11512 /* look for it in the table first */
11513 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11517 /* create anew and remember what it is */
11519 ptr_table_store(PL_ptr_table, gp, ret);
11522 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11523 on Newxz() to do this for us. */
11524 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11525 ret->gp_io = io_dup_inc(gp->gp_io, param);
11526 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11527 ret->gp_av = av_dup_inc(gp->gp_av, param);
11528 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11529 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11530 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11531 ret->gp_cvgen = gp->gp_cvgen;
11532 ret->gp_line = gp->gp_line;
11533 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11537 /* duplicate a chain of magic */
11540 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11542 MAGIC *mgret = NULL;
11543 MAGIC **mgprev_p = &mgret;
11545 PERL_ARGS_ASSERT_MG_DUP;
11547 for (; mg; mg = mg->mg_moremagic) {
11550 if ((param->flags & CLONEf_JOIN_IN)
11551 && mg->mg_type == PERL_MAGIC_backref)
11552 /* when joining, we let the individual SVs add themselves to
11553 * backref as needed. */
11556 Newx(nmg, 1, MAGIC);
11558 mgprev_p = &(nmg->mg_moremagic);
11560 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11561 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11562 from the original commit adding Perl_mg_dup() - revision 4538.
11563 Similarly there is the annotation "XXX random ptr?" next to the
11564 assignment to nmg->mg_ptr. */
11567 /* FIXME for plugins
11568 if (nmg->mg_type == PERL_MAGIC_qr) {
11569 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11573 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11574 ? nmg->mg_type == PERL_MAGIC_backref
11575 /* The backref AV has its reference
11576 * count deliberately bumped by 1 */
11577 ? SvREFCNT_inc(av_dup_inc((const AV *)
11578 nmg->mg_obj, param))
11579 : sv_dup_inc(nmg->mg_obj, param)
11580 : sv_dup(nmg->mg_obj, param);
11582 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11583 if (nmg->mg_len > 0) {
11584 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11585 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11586 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11588 AMT * const namtp = (AMT*)nmg->mg_ptr;
11589 sv_dup_inc_multiple((SV**)(namtp->table),
11590 (SV**)(namtp->table), NofAMmeth, param);
11593 else if (nmg->mg_len == HEf_SVKEY)
11594 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11596 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11597 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11603 #endif /* USE_ITHREADS */
11605 struct ptr_tbl_arena {
11606 struct ptr_tbl_arena *next;
11607 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11610 /* create a new pointer-mapping table */
11613 Perl_ptr_table_new(pTHX)
11616 PERL_UNUSED_CONTEXT;
11618 Newx(tbl, 1, PTR_TBL_t);
11619 tbl->tbl_max = 511;
11620 tbl->tbl_items = 0;
11621 tbl->tbl_arena = NULL;
11622 tbl->tbl_arena_next = NULL;
11623 tbl->tbl_arena_end = NULL;
11624 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11628 #define PTR_TABLE_HASH(ptr) \
11629 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11631 /* map an existing pointer using a table */
11633 STATIC PTR_TBL_ENT_t *
11634 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11636 PTR_TBL_ENT_t *tblent;
11637 const UV hash = PTR_TABLE_HASH(sv);
11639 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11641 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11642 for (; tblent; tblent = tblent->next) {
11643 if (tblent->oldval == sv)
11650 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11652 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11654 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11655 PERL_UNUSED_CONTEXT;
11657 return tblent ? tblent->newval : NULL;
11660 /* add a new entry to a pointer-mapping table */
11663 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11665 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11667 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11668 PERL_UNUSED_CONTEXT;
11671 tblent->newval = newsv;
11673 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11675 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11676 struct ptr_tbl_arena *new_arena;
11678 Newx(new_arena, 1, struct ptr_tbl_arena);
11679 new_arena->next = tbl->tbl_arena;
11680 tbl->tbl_arena = new_arena;
11681 tbl->tbl_arena_next = new_arena->array;
11682 tbl->tbl_arena_end = new_arena->array
11683 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11686 tblent = tbl->tbl_arena_next++;
11688 tblent->oldval = oldsv;
11689 tblent->newval = newsv;
11690 tblent->next = tbl->tbl_ary[entry];
11691 tbl->tbl_ary[entry] = tblent;
11693 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11694 ptr_table_split(tbl);
11698 /* double the hash bucket size of an existing ptr table */
11701 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11703 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11704 const UV oldsize = tbl->tbl_max + 1;
11705 UV newsize = oldsize * 2;
11708 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11709 PERL_UNUSED_CONTEXT;
11711 Renew(ary, newsize, PTR_TBL_ENT_t*);
11712 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11713 tbl->tbl_max = --newsize;
11714 tbl->tbl_ary = ary;
11715 for (i=0; i < oldsize; i++, ary++) {
11716 PTR_TBL_ENT_t **entp = ary;
11717 PTR_TBL_ENT_t *ent = *ary;
11718 PTR_TBL_ENT_t **curentp;
11721 curentp = ary + oldsize;
11723 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11725 ent->next = *curentp;
11735 /* remove all the entries from a ptr table */
11736 /* Deprecated - will be removed post 5.14 */
11739 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11741 if (tbl && tbl->tbl_items) {
11742 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11744 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11747 struct ptr_tbl_arena *next = arena->next;
11753 tbl->tbl_items = 0;
11754 tbl->tbl_arena = NULL;
11755 tbl->tbl_arena_next = NULL;
11756 tbl->tbl_arena_end = NULL;
11760 /* clear and free a ptr table */
11763 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11765 struct ptr_tbl_arena *arena;
11771 arena = tbl->tbl_arena;
11774 struct ptr_tbl_arena *next = arena->next;
11780 Safefree(tbl->tbl_ary);
11784 #if defined(USE_ITHREADS)
11787 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11789 PERL_ARGS_ASSERT_RVPV_DUP;
11792 if (SvWEAKREF(sstr)) {
11793 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11794 if (param->flags & CLONEf_JOIN_IN) {
11795 /* if joining, we add any back references individually rather
11796 * than copying the whole backref array */
11797 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11801 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11803 else if (SvPVX_const(sstr)) {
11804 /* Has something there */
11806 /* Normal PV - clone whole allocated space */
11807 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11808 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11809 /* Not that normal - actually sstr is copy on write.
11810 But we are a true, independent SV, so: */
11811 SvREADONLY_off(dstr);
11816 /* Special case - not normally malloced for some reason */
11817 if (isGV_with_GP(sstr)) {
11818 /* Don't need to do anything here. */
11820 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11821 /* A "shared" PV - clone it as "shared" PV */
11823 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11827 /* Some other special case - random pointer */
11828 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11833 /* Copy the NULL */
11834 SvPV_set(dstr, NULL);
11838 /* duplicate a list of SVs. source and dest may point to the same memory. */
11840 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11841 SSize_t items, CLONE_PARAMS *const param)
11843 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11845 while (items-- > 0) {
11846 *dest++ = sv_dup_inc(*source++, param);
11852 /* duplicate an SV of any type (including AV, HV etc) */
11855 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11860 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11862 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11863 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11868 /* look for it in the table first */
11869 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11873 if(param->flags & CLONEf_JOIN_IN) {
11874 /** We are joining here so we don't want do clone
11875 something that is bad **/
11876 if (SvTYPE(sstr) == SVt_PVHV) {
11877 const HEK * const hvname = HvNAME_HEK(sstr);
11879 /** don't clone stashes if they already exist **/
11880 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11881 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11882 ptr_table_store(PL_ptr_table, sstr, dstr);
11886 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
11887 HV *stash = GvSTASH(sstr);
11888 const HEK * hvname;
11889 if (stash && (hvname = HvNAME_HEK(stash))) {
11890 /** don't clone GVs if they already exist **/
11892 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11893 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
11895 stash, GvNAME(sstr),
11901 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
11902 ptr_table_store(PL_ptr_table, sstr, *svp);
11909 /* create anew and remember what it is */
11912 #ifdef DEBUG_LEAKING_SCALARS
11913 dstr->sv_debug_optype = sstr->sv_debug_optype;
11914 dstr->sv_debug_line = sstr->sv_debug_line;
11915 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11916 dstr->sv_debug_parent = (SV*)sstr;
11917 FREE_SV_DEBUG_FILE(dstr);
11918 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11921 ptr_table_store(PL_ptr_table, sstr, dstr);
11924 SvFLAGS(dstr) = SvFLAGS(sstr);
11925 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11926 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11929 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11930 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11931 (void*)PL_watch_pvx, SvPVX_const(sstr));
11934 /* don't clone objects whose class has asked us not to */
11935 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11940 switch (SvTYPE(sstr)) {
11942 SvANY(dstr) = NULL;
11945 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11947 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11949 SvIV_set(dstr, SvIVX(sstr));
11953 SvANY(dstr) = new_XNV();
11954 SvNV_set(dstr, SvNVX(sstr));
11956 /* case SVt_BIND: */
11959 /* These are all the types that need complex bodies allocating. */
11961 const svtype sv_type = SvTYPE(sstr);
11962 const struct body_details *const sv_type_details
11963 = bodies_by_type + sv_type;
11967 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11982 assert(sv_type_details->body_size);
11983 if (sv_type_details->arena) {
11984 new_body_inline(new_body, sv_type);
11986 = (void*)((char*)new_body - sv_type_details->offset);
11988 new_body = new_NOARENA(sv_type_details);
11992 SvANY(dstr) = new_body;
11995 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11996 ((char*)SvANY(dstr)) + sv_type_details->offset,
11997 sv_type_details->copy, char);
11999 Copy(((char*)SvANY(sstr)),
12000 ((char*)SvANY(dstr)),
12001 sv_type_details->body_size + sv_type_details->offset, char);
12004 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
12005 && !isGV_with_GP(dstr)
12006 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
12007 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
12009 /* The Copy above means that all the source (unduplicated) pointers
12010 are now in the destination. We can check the flags and the
12011 pointers in either, but it's possible that there's less cache
12012 missing by always going for the destination.
12013 FIXME - instrument and check that assumption */
12014 if (sv_type >= SVt_PVMG) {
12015 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
12016 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
12017 } else if (SvMAGIC(dstr))
12018 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
12020 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
12023 /* The cast silences a GCC warning about unhandled types. */
12024 switch ((int)sv_type) {
12034 /* FIXME for plugins */
12035 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
12038 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
12039 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
12040 LvTARG(dstr) = dstr;
12041 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
12042 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
12044 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
12046 /* non-GP case already handled above */
12047 if(isGV_with_GP(sstr)) {
12048 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12049 /* Don't call sv_add_backref here as it's going to be
12050 created as part of the magic cloning of the symbol
12051 table--unless this is during a join and the stash
12052 is not actually being cloned. */
12053 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12054 at the point of this comment. */
12055 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12056 if (param->flags & CLONEf_JOIN_IN)
12057 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12058 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12059 (void)GpREFCNT_inc(GvGP(dstr));
12063 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12064 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12065 /* I have no idea why fake dirp (rsfps)
12066 should be treated differently but otherwise
12067 we end up with leaks -- sky*/
12068 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12069 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12070 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12072 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12073 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12074 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12075 if (IoDIRP(dstr)) {
12076 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12079 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12081 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12083 if (IoOFP(dstr) == IoIFP(sstr))
12084 IoOFP(dstr) = IoIFP(dstr);
12086 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12087 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12088 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12089 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12092 /* avoid cloning an empty array */
12093 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12094 SV **dst_ary, **src_ary;
12095 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12097 src_ary = AvARRAY((const AV *)sstr);
12098 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12099 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12100 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12101 AvALLOC((const AV *)dstr) = dst_ary;
12102 if (AvREAL((const AV *)sstr)) {
12103 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12107 while (items-- > 0)
12108 *dst_ary++ = sv_dup(*src_ary++, param);
12110 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12111 while (items-- > 0) {
12112 *dst_ary++ = &PL_sv_undef;
12116 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12117 AvALLOC((const AV *)dstr) = (SV**)NULL;
12118 AvMAX( (const AV *)dstr) = -1;
12119 AvFILLp((const AV *)dstr) = -1;
12123 if (HvARRAY((const HV *)sstr)) {
12125 const bool sharekeys = !!HvSHAREKEYS(sstr);
12126 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12127 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12129 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12130 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12132 HvARRAY(dstr) = (HE**)darray;
12133 while (i <= sxhv->xhv_max) {
12134 const HE * const source = HvARRAY(sstr)[i];
12135 HvARRAY(dstr)[i] = source
12136 ? he_dup(source, sharekeys, param) : 0;
12140 const struct xpvhv_aux * const saux = HvAUX(sstr);
12141 struct xpvhv_aux * const daux = HvAUX(dstr);
12142 /* This flag isn't copied. */
12145 if (saux->xhv_name_count) {
12146 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12148 = saux->xhv_name_count < 0
12149 ? -saux->xhv_name_count
12150 : saux->xhv_name_count;
12151 HEK **shekp = sname + count;
12153 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12154 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12155 while (shekp-- > sname) {
12157 *dhekp = hek_dup(*shekp, param);
12161 daux->xhv_name_u.xhvnameu_name
12162 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12165 daux->xhv_name_count = saux->xhv_name_count;
12167 daux->xhv_riter = saux->xhv_riter;
12168 daux->xhv_eiter = saux->xhv_eiter
12169 ? he_dup(saux->xhv_eiter,
12170 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12171 /* backref array needs refcnt=2; see sv_add_backref */
12172 daux->xhv_backreferences =
12173 (param->flags & CLONEf_JOIN_IN)
12174 /* when joining, we let the individual GVs and
12175 * CVs add themselves to backref as
12176 * needed. This avoids pulling in stuff
12177 * that isn't required, and simplifies the
12178 * case where stashes aren't cloned back
12179 * if they already exist in the parent
12182 : saux->xhv_backreferences
12183 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12184 ? MUTABLE_AV(SvREFCNT_inc(
12185 sv_dup_inc((const SV *)
12186 saux->xhv_backreferences, param)))
12187 : MUTABLE_AV(sv_dup((const SV *)
12188 saux->xhv_backreferences, param))
12191 daux->xhv_mro_meta = saux->xhv_mro_meta
12192 ? mro_meta_dup(saux->xhv_mro_meta, param)
12195 /* Record stashes for possible cloning in Perl_clone(). */
12197 av_push(param->stashes, dstr);
12201 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12204 if (!(param->flags & CLONEf_COPY_STACKS)) {
12209 /* NOTE: not refcounted */
12210 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12211 hv_dup(CvSTASH(dstr), param);
12212 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12213 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12214 if (!CvISXSUB(dstr)) {
12216 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12218 } else if (CvCONST(dstr)) {
12219 CvXSUBANY(dstr).any_ptr =
12220 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12222 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12223 /* don't dup if copying back - CvGV isn't refcounted, so the
12224 * duped GV may never be freed. A bit of a hack! DAPM */
12225 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12227 ? gv_dup_inc(CvGV(sstr), param)
12228 : (param->flags & CLONEf_JOIN_IN)
12230 : gv_dup(CvGV(sstr), param);
12232 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12234 CvWEAKOUTSIDE(sstr)
12235 ? cv_dup( CvOUTSIDE(dstr), param)
12236 : cv_dup_inc(CvOUTSIDE(dstr), param);
12242 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12249 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12251 PERL_ARGS_ASSERT_SV_DUP_INC;
12252 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12256 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12258 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12259 PERL_ARGS_ASSERT_SV_DUP;
12261 /* Track every SV that (at least initially) had a reference count of 0.
12262 We need to do this by holding an actual reference to it in this array.
12263 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12264 (akin to the stashes hash, and the perl stack), we come unstuck if
12265 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12266 thread) is manipulated in a CLONE method, because CLONE runs before the
12267 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12268 (and fix things up by giving each a reference via the temps stack).
12269 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12270 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12271 before the walk of unreferenced happens and a reference to that is SV
12272 added to the temps stack. At which point we have the same SV considered
12273 to be in use, and free to be re-used. Not good.
12275 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12276 assert(param->unreferenced);
12277 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12283 /* duplicate a context */
12286 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12288 PERL_CONTEXT *ncxs;
12290 PERL_ARGS_ASSERT_CX_DUP;
12293 return (PERL_CONTEXT*)NULL;
12295 /* look for it in the table first */
12296 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12300 /* create anew and remember what it is */
12301 Newx(ncxs, max + 1, PERL_CONTEXT);
12302 ptr_table_store(PL_ptr_table, cxs, ncxs);
12303 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12306 PERL_CONTEXT * const ncx = &ncxs[ix];
12307 if (CxTYPE(ncx) == CXt_SUBST) {
12308 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12311 ncx->blk_oldcop = (COP*)any_dup(ncx->blk_oldcop, param->proto_perl);
12312 switch (CxTYPE(ncx)) {
12314 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12315 ? cv_dup_inc(ncx->blk_sub.cv, param)
12316 : cv_dup(ncx->blk_sub.cv,param));
12317 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12318 ? av_dup_inc(ncx->blk_sub.argarray,
12321 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12323 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12324 ncx->blk_sub.oldcomppad);
12327 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12329 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12330 ncx->blk_eval.cv = cv_dup(ncx->blk_eval.cv, param);
12332 case CXt_LOOP_LAZYSV:
12333 ncx->blk_loop.state_u.lazysv.end
12334 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12335 /* We are taking advantage of av_dup_inc and sv_dup_inc
12336 actually being the same function, and order equivalence of
12338 We can assert the later [but only at run time :-(] */
12339 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12340 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12342 ncx->blk_loop.state_u.ary.ary
12343 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12344 case CXt_LOOP_LAZYIV:
12345 case CXt_LOOP_PLAIN:
12346 if (CxPADLOOP(ncx)) {
12347 ncx->blk_loop.itervar_u.oldcomppad
12348 = (PAD*)ptr_table_fetch(PL_ptr_table,
12349 ncx->blk_loop.itervar_u.oldcomppad);
12351 ncx->blk_loop.itervar_u.gv
12352 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12357 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12358 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12359 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12374 /* duplicate a stack info structure */
12377 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12381 PERL_ARGS_ASSERT_SI_DUP;
12384 return (PERL_SI*)NULL;
12386 /* look for it in the table first */
12387 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12391 /* create anew and remember what it is */
12392 Newxz(nsi, 1, PERL_SI);
12393 ptr_table_store(PL_ptr_table, si, nsi);
12395 nsi->si_stack = av_dup_inc(si->si_stack, param);
12396 nsi->si_cxix = si->si_cxix;
12397 nsi->si_cxmax = si->si_cxmax;
12398 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12399 nsi->si_type = si->si_type;
12400 nsi->si_prev = si_dup(si->si_prev, param);
12401 nsi->si_next = si_dup(si->si_next, param);
12402 nsi->si_markoff = si->si_markoff;
12407 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12408 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12409 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12410 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12411 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12412 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12413 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12414 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12415 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12416 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12417 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12418 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12419 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12420 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12421 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12422 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12425 #define pv_dup_inc(p) SAVEPV(p)
12426 #define pv_dup(p) SAVEPV(p)
12427 #define svp_dup_inc(p,pp) any_dup(p,pp)
12429 /* map any object to the new equivent - either something in the
12430 * ptr table, or something in the interpreter structure
12434 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12438 PERL_ARGS_ASSERT_ANY_DUP;
12441 return (void*)NULL;
12443 /* look for it in the table first */
12444 ret = ptr_table_fetch(PL_ptr_table, v);
12448 /* see if it is part of the interpreter structure */
12449 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12450 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12458 /* duplicate the save stack */
12461 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12464 ANY * const ss = proto_perl->Isavestack;
12465 const I32 max = proto_perl->Isavestack_max;
12466 I32 ix = proto_perl->Isavestack_ix;
12479 void (*dptr) (void*);
12480 void (*dxptr) (pTHX_ void*);
12482 PERL_ARGS_ASSERT_SS_DUP;
12484 Newxz(nss, max, ANY);
12487 const UV uv = POPUV(ss,ix);
12488 const U8 type = (U8)uv & SAVE_MASK;
12490 TOPUV(nss,ix) = uv;
12492 case SAVEt_CLEARSV:
12494 case SAVEt_HELEM: /* hash element */
12495 sv = (const SV *)POPPTR(ss,ix);
12496 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12498 case SAVEt_ITEM: /* normal string */
12499 case SAVEt_GVSV: /* scalar slot in GV */
12500 case SAVEt_SV: /* scalar reference */
12501 sv = (const SV *)POPPTR(ss,ix);
12502 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12505 case SAVEt_MORTALIZESV:
12506 sv = (const SV *)POPPTR(ss,ix);
12507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12509 case SAVEt_SHARED_PVREF: /* char* in shared space */
12510 c = (char*)POPPTR(ss,ix);
12511 TOPPTR(nss,ix) = savesharedpv(c);
12512 ptr = POPPTR(ss,ix);
12513 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12515 case SAVEt_GENERIC_SVREF: /* generic sv */
12516 case SAVEt_SVREF: /* scalar reference */
12517 sv = (const SV *)POPPTR(ss,ix);
12518 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12519 ptr = POPPTR(ss,ix);
12520 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12522 case SAVEt_HV: /* hash reference */
12523 case SAVEt_AV: /* array reference */
12524 sv = (const SV *) POPPTR(ss,ix);
12525 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12527 case SAVEt_COMPPAD:
12529 sv = (const SV *) POPPTR(ss,ix);
12530 TOPPTR(nss,ix) = sv_dup(sv, param);
12532 case SAVEt_INT: /* int reference */
12533 ptr = POPPTR(ss,ix);
12534 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12535 intval = (int)POPINT(ss,ix);
12536 TOPINT(nss,ix) = intval;
12538 case SAVEt_LONG: /* long reference */
12539 ptr = POPPTR(ss,ix);
12540 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12541 longval = (long)POPLONG(ss,ix);
12542 TOPLONG(nss,ix) = longval;
12544 case SAVEt_I32: /* I32 reference */
12545 ptr = POPPTR(ss,ix);
12546 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12548 TOPINT(nss,ix) = i;
12550 case SAVEt_IV: /* IV reference */
12551 ptr = POPPTR(ss,ix);
12552 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12554 TOPIV(nss,ix) = iv;
12556 case SAVEt_HPTR: /* HV* reference */
12557 case SAVEt_APTR: /* AV* reference */
12558 case SAVEt_SPTR: /* SV* reference */
12559 ptr = POPPTR(ss,ix);
12560 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12561 sv = (const SV *)POPPTR(ss,ix);
12562 TOPPTR(nss,ix) = sv_dup(sv, param);
12564 case SAVEt_VPTR: /* random* reference */
12565 ptr = POPPTR(ss,ix);
12566 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12568 case SAVEt_INT_SMALL:
12569 case SAVEt_I32_SMALL:
12570 case SAVEt_I16: /* I16 reference */
12571 case SAVEt_I8: /* I8 reference */
12573 ptr = POPPTR(ss,ix);
12574 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12576 case SAVEt_GENERIC_PVREF: /* generic char* */
12577 case SAVEt_PPTR: /* char* reference */
12578 ptr = POPPTR(ss,ix);
12579 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12580 c = (char*)POPPTR(ss,ix);
12581 TOPPTR(nss,ix) = pv_dup(c);
12583 case SAVEt_GP: /* scalar reference */
12584 gp = (GP*)POPPTR(ss,ix);
12585 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12586 (void)GpREFCNT_inc(gp);
12587 gv = (const GV *)POPPTR(ss,ix);
12588 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12591 ptr = POPPTR(ss,ix);
12592 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12593 /* these are assumed to be refcounted properly */
12595 switch (((OP*)ptr)->op_type) {
12597 case OP_LEAVESUBLV:
12601 case OP_LEAVEWRITE:
12602 TOPPTR(nss,ix) = ptr;
12605 (void) OpREFCNT_inc(o);
12609 TOPPTR(nss,ix) = NULL;
12614 TOPPTR(nss,ix) = NULL;
12616 case SAVEt_FREECOPHH:
12617 ptr = POPPTR(ss,ix);
12618 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12621 hv = (const HV *)POPPTR(ss,ix);
12622 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12624 TOPINT(nss,ix) = i;
12627 c = (char*)POPPTR(ss,ix);
12628 TOPPTR(nss,ix) = pv_dup_inc(c);
12630 case SAVEt_STACK_POS: /* Position on Perl stack */
12632 TOPINT(nss,ix) = i;
12634 case SAVEt_DESTRUCTOR:
12635 ptr = POPPTR(ss,ix);
12636 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12637 dptr = POPDPTR(ss,ix);
12638 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12639 any_dup(FPTR2DPTR(void *, dptr),
12642 case SAVEt_DESTRUCTOR_X:
12643 ptr = POPPTR(ss,ix);
12644 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12645 dxptr = POPDXPTR(ss,ix);
12646 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12647 any_dup(FPTR2DPTR(void *, dxptr),
12650 case SAVEt_REGCONTEXT:
12652 ix -= uv >> SAVE_TIGHT_SHIFT;
12654 case SAVEt_AELEM: /* array element */
12655 sv = (const SV *)POPPTR(ss,ix);
12656 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12658 TOPINT(nss,ix) = i;
12659 av = (const AV *)POPPTR(ss,ix);
12660 TOPPTR(nss,ix) = av_dup_inc(av, param);
12663 ptr = POPPTR(ss,ix);
12664 TOPPTR(nss,ix) = ptr;
12667 ptr = POPPTR(ss,ix);
12668 ptr = cophh_copy((COPHH*)ptr);
12669 TOPPTR(nss,ix) = ptr;
12671 TOPINT(nss,ix) = i;
12672 if (i & HINT_LOCALIZE_HH) {
12673 hv = (const HV *)POPPTR(ss,ix);
12674 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12677 case SAVEt_PADSV_AND_MORTALIZE:
12678 longval = (long)POPLONG(ss,ix);
12679 TOPLONG(nss,ix) = longval;
12680 ptr = POPPTR(ss,ix);
12681 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12682 sv = (const SV *)POPPTR(ss,ix);
12683 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12685 case SAVEt_SET_SVFLAGS:
12687 TOPINT(nss,ix) = i;
12689 TOPINT(nss,ix) = i;
12690 sv = (const SV *)POPPTR(ss,ix);
12691 TOPPTR(nss,ix) = sv_dup(sv, param);
12693 case SAVEt_RE_STATE:
12695 const struct re_save_state *const old_state
12696 = (struct re_save_state *)
12697 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12698 struct re_save_state *const new_state
12699 = (struct re_save_state *)
12700 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12702 Copy(old_state, new_state, 1, struct re_save_state);
12703 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12705 new_state->re_state_bostr
12706 = pv_dup(old_state->re_state_bostr);
12707 new_state->re_state_reginput
12708 = pv_dup(old_state->re_state_reginput);
12709 new_state->re_state_regeol
12710 = pv_dup(old_state->re_state_regeol);
12711 #ifdef PERL_OLD_COPY_ON_WRITE
12712 new_state->re_state_nrs
12713 = sv_dup(old_state->re_state_nrs, param);
12715 new_state->re_state_reg_magic
12716 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12718 new_state->re_state_reg_oldcurpm
12719 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12721 new_state->re_state_reg_curpm
12722 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12724 new_state->re_state_reg_oldsaved
12725 = pv_dup(old_state->re_state_reg_oldsaved);
12726 new_state->re_state_reg_poscache
12727 = pv_dup(old_state->re_state_reg_poscache);
12728 new_state->re_state_reg_starttry
12729 = pv_dup(old_state->re_state_reg_starttry);
12732 case SAVEt_COMPILE_WARNINGS:
12733 ptr = POPPTR(ss,ix);
12734 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12737 ptr = POPPTR(ss,ix);
12738 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12742 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12750 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12751 * flag to the result. This is done for each stash before cloning starts,
12752 * so we know which stashes want their objects cloned */
12755 do_mark_cloneable_stash(pTHX_ SV *const sv)
12757 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12759 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12760 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12761 if (cloner && GvCV(cloner)) {
12768 mXPUSHs(newSVhek(hvname));
12770 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12777 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12785 =for apidoc perl_clone
12787 Create and return a new interpreter by cloning the current one.
12789 perl_clone takes these flags as parameters:
12791 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12792 without it we only clone the data and zero the stacks,
12793 with it we copy the stacks and the new perl interpreter is
12794 ready to run at the exact same point as the previous one.
12795 The pseudo-fork code uses COPY_STACKS while the
12796 threads->create doesn't.
12798 CLONEf_KEEP_PTR_TABLE -
12799 perl_clone keeps a ptr_table with the pointer of the old
12800 variable as a key and the new variable as a value,
12801 this allows it to check if something has been cloned and not
12802 clone it again but rather just use the value and increase the
12803 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12804 the ptr_table using the function
12805 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12806 reason to keep it around is if you want to dup some of your own
12807 variable who are outside the graph perl scans, example of this
12808 code is in threads.xs create.
12810 CLONEf_CLONE_HOST -
12811 This is a win32 thing, it is ignored on unix, it tells perls
12812 win32host code (which is c++) to clone itself, this is needed on
12813 win32 if you want to run two threads at the same time,
12814 if you just want to do some stuff in a separate perl interpreter
12815 and then throw it away and return to the original one,
12816 you don't need to do anything.
12821 /* XXX the above needs expanding by someone who actually understands it ! */
12822 EXTERN_C PerlInterpreter *
12823 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12826 perl_clone(PerlInterpreter *proto_perl, UV flags)
12829 #ifdef PERL_IMPLICIT_SYS
12831 PERL_ARGS_ASSERT_PERL_CLONE;
12833 /* perlhost.h so we need to call into it
12834 to clone the host, CPerlHost should have a c interface, sky */
12836 if (flags & CLONEf_CLONE_HOST) {
12837 return perl_clone_host(proto_perl,flags);
12839 return perl_clone_using(proto_perl, flags,
12841 proto_perl->IMemShared,
12842 proto_perl->IMemParse,
12844 proto_perl->IStdIO,
12848 proto_perl->IProc);
12852 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12853 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12854 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12855 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12856 struct IPerlDir* ipD, struct IPerlSock* ipS,
12857 struct IPerlProc* ipP)
12859 /* XXX many of the string copies here can be optimized if they're
12860 * constants; they need to be allocated as common memory and just
12861 * their pointers copied. */
12864 CLONE_PARAMS clone_params;
12865 CLONE_PARAMS* const param = &clone_params;
12867 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12869 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12870 #else /* !PERL_IMPLICIT_SYS */
12872 CLONE_PARAMS clone_params;
12873 CLONE_PARAMS* param = &clone_params;
12874 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12876 PERL_ARGS_ASSERT_PERL_CLONE;
12877 #endif /* PERL_IMPLICIT_SYS */
12879 /* for each stash, determine whether its objects should be cloned */
12880 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12881 PERL_SET_THX(my_perl);
12884 PoisonNew(my_perl, 1, PerlInterpreter);
12887 PL_defstash = NULL; /* may be used by perl malloc() */
12890 PL_scopestack_name = 0;
12892 PL_savestack_ix = 0;
12893 PL_savestack_max = -1;
12894 PL_sig_pending = 0;
12896 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12897 # ifdef DEBUG_LEAKING_SCALARS
12898 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12900 #else /* !DEBUGGING */
12901 Zero(my_perl, 1, PerlInterpreter);
12902 #endif /* DEBUGGING */
12904 #ifdef PERL_IMPLICIT_SYS
12905 /* host pointers */
12907 PL_MemShared = ipMS;
12908 PL_MemParse = ipMP;
12915 #endif /* PERL_IMPLICIT_SYS */
12917 param->flags = flags;
12918 /* Nothing in the core code uses this, but we make it available to
12919 extensions (using mg_dup). */
12920 param->proto_perl = proto_perl;
12921 /* Likely nothing will use this, but it is initialised to be consistent
12922 with Perl_clone_params_new(). */
12923 param->new_perl = my_perl;
12924 param->unreferenced = NULL;
12926 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12928 PL_body_arenas = NULL;
12929 Zero(&PL_body_roots, 1, PL_body_roots);
12932 PL_sv_objcount = 0;
12934 PL_sv_arenaroot = NULL;
12936 PL_debug = proto_perl->Idebug;
12938 PL_hash_seed = proto_perl->Ihash_seed;
12939 PL_rehash_seed = proto_perl->Irehash_seed;
12941 SvANY(&PL_sv_undef) = NULL;
12942 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12943 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12944 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12945 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12946 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12948 SvANY(&PL_sv_yes) = new_XPVNV();
12949 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12950 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12951 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12953 /* dbargs array probably holds garbage */
12956 PL_compiling = proto_perl->Icompiling;
12958 #ifdef PERL_DEBUG_READONLY_OPS
12963 /* pseudo environmental stuff */
12964 PL_origargc = proto_perl->Iorigargc;
12965 PL_origargv = proto_perl->Iorigargv;
12967 /* Set tainting stuff before PerlIO_debug can possibly get called */
12968 PL_tainting = proto_perl->Itainting;
12969 PL_taint_warn = proto_perl->Itaint_warn;
12971 PL_minus_c = proto_perl->Iminus_c;
12973 PL_localpatches = proto_perl->Ilocalpatches;
12974 PL_splitstr = proto_perl->Isplitstr;
12975 PL_minus_n = proto_perl->Iminus_n;
12976 PL_minus_p = proto_perl->Iminus_p;
12977 PL_minus_l = proto_perl->Iminus_l;
12978 PL_minus_a = proto_perl->Iminus_a;
12979 PL_minus_E = proto_perl->Iminus_E;
12980 PL_minus_F = proto_perl->Iminus_F;
12981 PL_doswitches = proto_perl->Idoswitches;
12982 PL_dowarn = proto_perl->Idowarn;
12983 PL_sawampersand = proto_perl->Isawampersand;
12984 PL_unsafe = proto_perl->Iunsafe;
12985 PL_perldb = proto_perl->Iperldb;
12986 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12987 PL_exit_flags = proto_perl->Iexit_flags;
12989 /* XXX time(&PL_basetime) when asked for? */
12990 PL_basetime = proto_perl->Ibasetime;
12992 PL_maxsysfd = proto_perl->Imaxsysfd;
12993 PL_statusvalue = proto_perl->Istatusvalue;
12995 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12997 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
13000 /* RE engine related */
13001 Zero(&PL_reg_state, 1, struct re_save_state);
13002 PL_regmatch_slab = NULL;
13004 PL_sub_generation = proto_perl->Isub_generation;
13006 /* funky return mechanisms */
13007 PL_forkprocess = proto_perl->Iforkprocess;
13009 /* internal state */
13010 PL_maxo = proto_perl->Imaxo;
13012 PL_main_start = proto_perl->Imain_start;
13013 PL_eval_root = proto_perl->Ieval_root;
13014 PL_eval_start = proto_perl->Ieval_start;
13016 PL_filemode = proto_perl->Ifilemode;
13017 PL_lastfd = proto_perl->Ilastfd;
13018 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13021 PL_gensym = proto_perl->Igensym;
13023 PL_laststatval = proto_perl->Ilaststatval;
13024 PL_laststype = proto_perl->Ilaststype;
13027 PL_profiledata = NULL;
13029 PL_generation = proto_perl->Igeneration;
13031 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13032 PL_in_clean_all = proto_perl->Iin_clean_all;
13034 PL_delaymagic_uid = proto_perl->Idelaymagic_uid;
13035 PL_delaymagic_euid = proto_perl->Idelaymagic_euid;
13036 PL_delaymagic_gid = proto_perl->Idelaymagic_gid;
13037 PL_delaymagic_egid = proto_perl->Idelaymagic_egid;
13038 PL_nomemok = proto_perl->Inomemok;
13039 PL_an = proto_perl->Ian;
13040 PL_evalseq = proto_perl->Ievalseq;
13041 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13042 PL_origalen = proto_perl->Iorigalen;
13044 PL_sighandlerp = proto_perl->Isighandlerp;
13046 PL_runops = proto_perl->Irunops;
13048 PL_subline = proto_perl->Isubline;
13051 PL_cryptseen = proto_perl->Icryptseen;
13054 PL_hints = proto_perl->Ihints;
13056 #ifdef USE_LOCALE_COLLATE
13057 PL_collation_ix = proto_perl->Icollation_ix;
13058 PL_collation_standard = proto_perl->Icollation_standard;
13059 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13060 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13061 #endif /* USE_LOCALE_COLLATE */
13063 #ifdef USE_LOCALE_NUMERIC
13064 PL_numeric_standard = proto_perl->Inumeric_standard;
13065 PL_numeric_local = proto_perl->Inumeric_local;
13066 #endif /* !USE_LOCALE_NUMERIC */
13068 /* Did the locale setup indicate UTF-8? */
13069 PL_utf8locale = proto_perl->Iutf8locale;
13070 /* Unicode features (see perlrun/-C) */
13071 PL_unicode = proto_perl->Iunicode;
13073 /* Pre-5.8 signals control */
13074 PL_signals = proto_perl->Isignals;
13076 /* times() ticks per second */
13077 PL_clocktick = proto_perl->Iclocktick;
13079 /* Recursion stopper for PerlIO_find_layer */
13080 PL_in_load_module = proto_perl->Iin_load_module;
13082 /* sort() routine */
13083 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13085 /* Not really needed/useful since the reenrant_retint is "volatile",
13086 * but do it for consistency's sake. */
13087 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13089 /* Hooks to shared SVs and locks. */
13090 PL_sharehook = proto_perl->Isharehook;
13091 PL_lockhook = proto_perl->Ilockhook;
13092 PL_unlockhook = proto_perl->Iunlockhook;
13093 PL_threadhook = proto_perl->Ithreadhook;
13094 PL_destroyhook = proto_perl->Idestroyhook;
13095 PL_signalhook = proto_perl->Isignalhook;
13097 PL_globhook = proto_perl->Iglobhook;
13100 PL_last_swash_hv = NULL; /* reinits on demand */
13101 PL_last_swash_klen = 0;
13102 PL_last_swash_key[0]= '\0';
13103 PL_last_swash_tmps = (U8*)NULL;
13104 PL_last_swash_slen = 0;
13106 PL_glob_index = proto_perl->Iglob_index;
13107 PL_srand_called = proto_perl->Isrand_called;
13109 if (flags & CLONEf_COPY_STACKS) {
13110 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13111 PL_tmps_ix = proto_perl->Itmps_ix;
13112 PL_tmps_max = proto_perl->Itmps_max;
13113 PL_tmps_floor = proto_perl->Itmps_floor;
13115 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13116 * NOTE: unlike the others! */
13117 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13118 PL_scopestack_max = proto_perl->Iscopestack_max;
13120 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13121 * NOTE: unlike the others! */
13122 PL_savestack_ix = proto_perl->Isavestack_ix;
13123 PL_savestack_max = proto_perl->Isavestack_max;
13126 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13127 PL_top_env = &PL_start_env;
13129 PL_op = proto_perl->Iop;
13132 PL_Xpv = (XPV*)NULL;
13133 my_perl->Ina = proto_perl->Ina;
13135 PL_statbuf = proto_perl->Istatbuf;
13136 PL_statcache = proto_perl->Istatcache;
13139 PL_timesbuf = proto_perl->Itimesbuf;
13142 PL_tainted = proto_perl->Itainted;
13143 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13145 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13147 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13148 PL_restartop = proto_perl->Irestartop;
13149 PL_in_eval = proto_perl->Iin_eval;
13150 PL_delaymagic = proto_perl->Idelaymagic;
13151 PL_phase = proto_perl->Iphase;
13152 PL_localizing = proto_perl->Ilocalizing;
13154 PL_hv_fetch_ent_mh = NULL;
13155 PL_modcount = proto_perl->Imodcount;
13156 PL_lastgotoprobe = NULL;
13157 PL_dumpindent = proto_perl->Idumpindent;
13159 PL_efloatbuf = NULL; /* reinits on demand */
13160 PL_efloatsize = 0; /* reinits on demand */
13164 PL_regdummy = proto_perl->Iregdummy;
13165 PL_colorset = 0; /* reinits PL_colors[] */
13166 /*PL_colors[6] = {0,0,0,0,0,0};*/
13168 /* Pluggable optimizer */
13169 PL_peepp = proto_perl->Ipeepp;
13170 PL_rpeepp = proto_perl->Irpeepp;
13171 /* op_free() hook */
13172 PL_opfreehook = proto_perl->Iopfreehook;
13174 #ifdef USE_REENTRANT_API
13175 /* XXX: things like -Dm will segfault here in perlio, but doing
13176 * PERL_SET_CONTEXT(proto_perl);
13177 * breaks too many other things
13179 Perl_reentrant_init(aTHX);
13182 /* create SV map for pointer relocation */
13183 PL_ptr_table = ptr_table_new();
13185 /* initialize these special pointers as early as possible */
13186 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13188 SvANY(&PL_sv_no) = new_XPVNV();
13189 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13190 SvCUR_set(&PL_sv_no, 0);
13191 SvLEN_set(&PL_sv_no, 1);
13192 SvIV_set(&PL_sv_no, 0);
13193 SvNV_set(&PL_sv_no, 0);
13194 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13196 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13197 SvCUR_set(&PL_sv_yes, 1);
13198 SvLEN_set(&PL_sv_yes, 2);
13199 SvIV_set(&PL_sv_yes, 1);
13200 SvNV_set(&PL_sv_yes, 1);
13201 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13203 /* create (a non-shared!) shared string table */
13204 PL_strtab = newHV();
13205 HvSHAREKEYS_off(PL_strtab);
13206 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13207 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13209 /* This PV will be free'd special way so must set it same way op.c does */
13210 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13211 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13213 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13214 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13215 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13216 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13218 param->stashes = newAV(); /* Setup array of objects to call clone on */
13219 /* This makes no difference to the implementation, as it always pushes
13220 and shifts pointers to other SVs without changing their reference
13221 count, with the array becoming empty before it is freed. However, it
13222 makes it conceptually clear what is going on, and will avoid some
13223 work inside av.c, filling slots between AvFILL() and AvMAX() with
13224 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13225 AvREAL_off(param->stashes);
13227 if (!(flags & CLONEf_COPY_STACKS)) {
13228 param->unreferenced = newAV();
13231 #ifdef PERLIO_LAYERS
13232 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13233 PerlIO_clone(aTHX_ proto_perl, param);
13236 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13237 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13238 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13239 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13240 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13241 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13244 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13245 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13246 PL_inplace = SAVEPV(proto_perl->Iinplace);
13247 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13249 /* magical thingies */
13250 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
13252 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13254 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13255 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13256 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13259 /* Clone the regex array */
13260 /* ORANGE FIXME for plugins, probably in the SV dup code.
13261 newSViv(PTR2IV(CALLREGDUPE(
13262 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13264 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13265 PL_regex_pad = AvARRAY(PL_regex_padav);
13267 PL_stashpadmax = proto_perl->Istashpadmax;
13268 PL_stashpadix = proto_perl->Istashpadix ;
13269 Newx(PL_stashpad, PL_stashpadmax, HV *);
13272 for (; o < PL_stashpadmax; ++o)
13273 PL_stashpad[o] = hv_dup(proto_perl->Istashpad[o], param);
13276 /* shortcuts to various I/O objects */
13277 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13278 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13279 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13280 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13281 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13282 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13283 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13285 /* shortcuts to regexp stuff */
13286 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13288 /* shortcuts to misc objects */
13289 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13291 /* shortcuts to debugging objects */
13292 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13293 PL_DBline = gv_dup(proto_perl->IDBline, param);
13294 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13295 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13296 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13297 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13299 /* symbol tables */
13300 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13301 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13302 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13303 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13304 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13306 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13307 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13308 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13309 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13310 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13311 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13312 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13313 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13315 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13317 /* subprocess state */
13318 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13320 if (proto_perl->Iop_mask)
13321 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13324 /* PL_asserting = proto_perl->Iasserting; */
13326 /* current interpreter roots */
13327 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13329 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13332 /* runtime control stuff */
13333 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13335 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13337 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13339 /* interpreter atexit processing */
13340 PL_exitlistlen = proto_perl->Iexitlistlen;
13341 if (PL_exitlistlen) {
13342 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13343 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13346 PL_exitlist = (PerlExitListEntry*)NULL;
13348 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13349 if (PL_my_cxt_size) {
13350 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13351 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13352 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13353 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13354 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13358 PL_my_cxt_list = (void**)NULL;
13359 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13360 PL_my_cxt_keys = (const char**)NULL;
13363 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13364 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13365 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13366 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13368 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13370 PAD_CLONE_VARS(proto_perl, param);
13372 #ifdef HAVE_INTERP_INTERN
13373 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13376 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13378 #ifdef PERL_USES_PL_PIDSTATUS
13379 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13381 PL_osname = SAVEPV(proto_perl->Iosname);
13382 PL_parser = parser_dup(proto_perl->Iparser, param);
13384 /* XXX this only works if the saved cop has already been cloned */
13385 if (proto_perl->Iparser) {
13386 PL_parser->saved_curcop = (COP*)any_dup(
13387 proto_perl->Iparser->saved_curcop,
13391 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13393 #ifdef USE_LOCALE_COLLATE
13394 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13395 #endif /* USE_LOCALE_COLLATE */
13397 #ifdef USE_LOCALE_NUMERIC
13398 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13399 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13400 #endif /* !USE_LOCALE_NUMERIC */
13402 /* Unicode inversion lists */
13403 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13404 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13406 PL_PerlSpace = sv_dup_inc(proto_perl->IPerlSpace, param);
13407 PL_XPerlSpace = sv_dup_inc(proto_perl->IXPerlSpace, param);
13409 PL_L1PosixAlnum = sv_dup_inc(proto_perl->IL1PosixAlnum, param);
13410 PL_PosixAlnum = sv_dup_inc(proto_perl->IPosixAlnum, param);
13412 PL_L1PosixAlpha = sv_dup_inc(proto_perl->IL1PosixAlpha, param);
13413 PL_PosixAlpha = sv_dup_inc(proto_perl->IPosixAlpha, param);
13415 PL_PosixBlank = sv_dup_inc(proto_perl->IPosixBlank, param);
13416 PL_XPosixBlank = sv_dup_inc(proto_perl->IXPosixBlank, param);
13418 PL_L1Cased = sv_dup_inc(proto_perl->IL1Cased, param);
13420 PL_PosixCntrl = sv_dup_inc(proto_perl->IPosixCntrl, param);
13421 PL_XPosixCntrl = sv_dup_inc(proto_perl->IXPosixCntrl, param);
13423 PL_PosixDigit = sv_dup_inc(proto_perl->IPosixDigit, param);
13425 PL_L1PosixGraph = sv_dup_inc(proto_perl->IL1PosixGraph, param);
13426 PL_PosixGraph = sv_dup_inc(proto_perl->IPosixGraph, param);
13428 PL_L1PosixLower = sv_dup_inc(proto_perl->IL1PosixLower, param);
13429 PL_PosixLower = sv_dup_inc(proto_perl->IPosixLower, param);
13431 PL_L1PosixPrint = sv_dup_inc(proto_perl->IL1PosixPrint, param);
13432 PL_PosixPrint = sv_dup_inc(proto_perl->IPosixPrint, param);
13434 PL_L1PosixPunct = sv_dup_inc(proto_perl->IL1PosixPunct, param);
13435 PL_PosixPunct = sv_dup_inc(proto_perl->IPosixPunct, param);
13437 PL_PosixSpace = sv_dup_inc(proto_perl->IPosixSpace, param);
13438 PL_XPosixSpace = sv_dup_inc(proto_perl->IXPosixSpace, param);
13440 PL_L1PosixUpper = sv_dup_inc(proto_perl->IL1PosixUpper, param);
13441 PL_PosixUpper = sv_dup_inc(proto_perl->IPosixUpper, param);
13443 PL_L1PosixWord = sv_dup_inc(proto_perl->IL1PosixWord, param);
13444 PL_PosixWord = sv_dup_inc(proto_perl->IPosixWord, param);
13446 PL_PosixXDigit = sv_dup_inc(proto_perl->IPosixXDigit, param);
13447 PL_XPosixXDigit = sv_dup_inc(proto_perl->IXPosixXDigit, param);
13449 PL_VertSpace = sv_dup_inc(proto_perl->IVertSpace, param);
13451 /* utf8 character class swashes */
13452 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13453 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13454 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13455 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13456 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13457 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13458 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13459 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13460 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13461 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13462 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13463 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13464 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13465 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13466 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13467 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13468 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13469 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13470 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13471 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13472 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13473 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13474 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13475 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13476 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13477 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13478 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13479 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13480 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13481 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13482 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13483 PL_utf8_quotemeta = sv_dup_inc(proto_perl->Iutf8_quotemeta, param);
13484 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13485 PL_AboveLatin1 = sv_dup_inc(proto_perl->IAboveLatin1, param);
13486 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13489 if (proto_perl->Ipsig_pend) {
13490 Newxz(PL_psig_pend, SIG_SIZE, int);
13493 PL_psig_pend = (int*)NULL;
13496 if (proto_perl->Ipsig_name) {
13497 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13498 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13500 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13503 PL_psig_ptr = (SV**)NULL;
13504 PL_psig_name = (SV**)NULL;
13507 if (flags & CLONEf_COPY_STACKS) {
13508 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13509 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13510 PL_tmps_ix+1, param);
13512 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13513 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13514 Newxz(PL_markstack, i, I32);
13515 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13516 - proto_perl->Imarkstack);
13517 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13518 - proto_perl->Imarkstack);
13519 Copy(proto_perl->Imarkstack, PL_markstack,
13520 PL_markstack_ptr - PL_markstack + 1, I32);
13522 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13523 * NOTE: unlike the others! */
13524 Newxz(PL_scopestack, PL_scopestack_max, I32);
13525 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13528 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13529 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13531 /* NOTE: si_dup() looks at PL_markstack */
13532 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13534 /* PL_curstack = PL_curstackinfo->si_stack; */
13535 PL_curstack = av_dup(proto_perl->Icurstack, param);
13536 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13538 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13539 PL_stack_base = AvARRAY(PL_curstack);
13540 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13541 - proto_perl->Istack_base);
13542 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13544 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13545 PL_savestack = ss_dup(proto_perl, param);
13549 ENTER; /* perl_destruct() wants to LEAVE; */
13552 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13553 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13555 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13556 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13557 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13558 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13559 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13560 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13562 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13564 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13565 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13566 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13567 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13569 PL_stashcache = newHV();
13571 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13572 proto_perl->Iwatchaddr);
13573 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13574 if (PL_debug && PL_watchaddr) {
13575 PerlIO_printf(Perl_debug_log,
13576 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13577 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13578 PTR2UV(PL_watchok));
13581 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13582 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13583 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13585 /* Call the ->CLONE method, if it exists, for each of the stashes
13586 identified by sv_dup() above.
13588 while(av_len(param->stashes) != -1) {
13589 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13590 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13591 if (cloner && GvCV(cloner)) {
13596 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13598 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13604 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13605 ptr_table_free(PL_ptr_table);
13606 PL_ptr_table = NULL;
13609 if (!(flags & CLONEf_COPY_STACKS)) {
13610 unreferenced_to_tmp_stack(param->unreferenced);
13613 SvREFCNT_dec(param->stashes);
13615 /* orphaned? eg threads->new inside BEGIN or use */
13616 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13617 SvREFCNT_inc_simple_void(PL_compcv);
13618 SAVEFREESV(PL_compcv);
13625 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13627 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13629 if (AvFILLp(unreferenced) > -1) {
13630 SV **svp = AvARRAY(unreferenced);
13631 SV **const last = svp + AvFILLp(unreferenced);
13635 if (SvREFCNT(*svp) == 1)
13637 } while (++svp <= last);
13639 EXTEND_MORTAL(count);
13640 svp = AvARRAY(unreferenced);
13643 if (SvREFCNT(*svp) == 1) {
13644 /* Our reference is the only one to this SV. This means that
13645 in this thread, the scalar effectively has a 0 reference.
13646 That doesn't work (cleanup never happens), so donate our
13647 reference to it onto the save stack. */
13648 PL_tmps_stack[++PL_tmps_ix] = *svp;
13650 /* As an optimisation, because we are already walking the
13651 entire array, instead of above doing either
13652 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13653 release our reference to the scalar, so that at the end of
13654 the array owns zero references to the scalars it happens to
13655 point to. We are effectively converting the array from
13656 AvREAL() on to AvREAL() off. This saves the av_clear()
13657 (triggered by the SvREFCNT_dec(unreferenced) below) from
13658 walking the array a second time. */
13659 SvREFCNT_dec(*svp);
13662 } while (++svp <= last);
13663 AvREAL_off(unreferenced);
13665 SvREFCNT_dec(unreferenced);
13669 Perl_clone_params_del(CLONE_PARAMS *param)
13671 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13673 PerlInterpreter *const to = param->new_perl;
13675 PerlInterpreter *const was = PERL_GET_THX;
13677 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13683 SvREFCNT_dec(param->stashes);
13684 if (param->unreferenced)
13685 unreferenced_to_tmp_stack(param->unreferenced);
13695 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13698 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13699 does a dTHX; to get the context from thread local storage.
13700 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13701 a version that passes in my_perl. */
13702 PerlInterpreter *const was = PERL_GET_THX;
13703 CLONE_PARAMS *param;
13705 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13711 /* Given that we've set the context, we can do this unshared. */
13712 Newx(param, 1, CLONE_PARAMS);
13715 param->proto_perl = from;
13716 param->new_perl = to;
13717 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13718 AvREAL_off(param->stashes);
13719 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13727 #endif /* USE_ITHREADS */
13730 =head1 Unicode Support
13732 =for apidoc sv_recode_to_utf8
13734 The encoding is assumed to be an Encode object, on entry the PV
13735 of the sv is assumed to be octets in that encoding, and the sv
13736 will be converted into Unicode (and UTF-8).
13738 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13739 is not a reference, nothing is done to the sv. If the encoding is not
13740 an C<Encode::XS> Encoding object, bad things will happen.
13741 (See F<lib/encoding.pm> and L<Encode>.)
13743 The PV of the sv is returned.
13748 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13752 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13754 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13768 Passing sv_yes is wrong - it needs to be or'ed set of constants
13769 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13770 remove converted chars from source.
13772 Both will default the value - let them.
13774 XPUSHs(&PL_sv_yes);
13777 call_method("decode", G_SCALAR);
13781 s = SvPV_const(uni, len);
13782 if (s != SvPVX_const(sv)) {
13783 SvGROW(sv, len + 1);
13784 Move(s, SvPVX(sv), len + 1, char);
13785 SvCUR_set(sv, len);
13789 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13790 /* clear pos and any utf8 cache */
13791 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13794 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13795 magic_setutf8(sv,mg); /* clear UTF8 cache */
13800 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13804 =for apidoc sv_cat_decode
13806 The encoding is assumed to be an Encode object, the PV of the ssv is
13807 assumed to be octets in that encoding and decoding the input starts
13808 from the position which (PV + *offset) pointed to. The dsv will be
13809 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13810 when the string tstr appears in decoding output or the input ends on
13811 the PV of the ssv. The value which the offset points will be modified
13812 to the last input position on the ssv.
13814 Returns TRUE if the terminator was found, else returns FALSE.
13819 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13820 SV *ssv, int *offset, char *tstr, int tlen)
13825 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13827 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13838 offsv = newSViv(*offset);
13840 mXPUSHp(tstr, tlen);
13842 call_method("cat_decode", G_SCALAR);
13844 ret = SvTRUE(TOPs);
13845 *offset = SvIV(offsv);
13851 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13856 /* ---------------------------------------------------------------------
13858 * support functions for report_uninit()
13861 /* the maxiumum size of array or hash where we will scan looking
13862 * for the undefined element that triggered the warning */
13864 #define FUV_MAX_SEARCH_SIZE 1000
13866 /* Look for an entry in the hash whose value has the same SV as val;
13867 * If so, return a mortal copy of the key. */
13870 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13873 register HE **array;
13876 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13878 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13879 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13882 array = HvARRAY(hv);
13884 for (i=HvMAX(hv); i>0; i--) {
13885 register HE *entry;
13886 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13887 if (HeVAL(entry) != val)
13889 if ( HeVAL(entry) == &PL_sv_undef ||
13890 HeVAL(entry) == &PL_sv_placeholder)
13894 if (HeKLEN(entry) == HEf_SVKEY)
13895 return sv_mortalcopy(HeKEY_sv(entry));
13896 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13902 /* Look for an entry in the array whose value has the same SV as val;
13903 * If so, return the index, otherwise return -1. */
13906 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13910 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13912 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13913 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13916 if (val != &PL_sv_undef) {
13917 SV ** const svp = AvARRAY(av);
13920 for (i=AvFILLp(av); i>=0; i--)
13927 /* S_varname(): return the name of a variable, optionally with a subscript.
13928 * If gv is non-zero, use the name of that global, along with gvtype (one
13929 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13930 * targ. Depending on the value of the subscript_type flag, return:
13933 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13934 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13935 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13936 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13939 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13940 const SV *const keyname, I32 aindex, int subscript_type)
13943 SV * const name = sv_newmortal();
13944 if (gv && isGV(gv)) {
13946 buffer[0] = gvtype;
13949 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13951 gv_fullname4(name, gv, buffer, 0);
13953 if ((unsigned int)SvPVX(name)[1] <= 26) {
13955 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13957 /* Swap the 1 unprintable control character for the 2 byte pretty
13958 version - ie substr($name, 1, 1) = $buffer; */
13959 sv_insert(name, 1, 1, buffer, 2);
13963 CV * const cv = gv ? ((CV *)gv) : find_runcv(NULL);
13967 assert(!cv || SvTYPE(cv) == SVt_PVCV);
13969 if (!cv || !CvPADLIST(cv))
13971 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13972 sv = *av_fetch(av, targ, FALSE);
13973 sv_setsv(name, sv);
13976 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13977 SV * const sv = newSV(0);
13978 *SvPVX(name) = '$';
13979 Perl_sv_catpvf(aTHX_ name, "{%s}",
13980 pv_pretty(sv, SvPVX_const(keyname), SvCUR(keyname), 32, NULL, NULL,
13981 PERL_PV_PRETTY_DUMP | PERL_PV_ESCAPE_UNI_DETECT ));
13984 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13985 *SvPVX(name) = '$';
13986 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13988 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13989 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13990 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
13998 =for apidoc find_uninit_var
14000 Find the name of the undefined variable (if any) that caused the operator
14001 to issue a "Use of uninitialized value" warning.
14002 If match is true, only return a name if its value matches uninit_sv.
14003 So roughly speaking, if a unary operator (such as OP_COS) generates a
14004 warning, then following the direct child of the op may yield an
14005 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
14006 other hand, with OP_ADD there are two branches to follow, so we only print
14007 the variable name if we get an exact match.
14009 The name is returned as a mortal SV.
14011 Assumes that PL_op is the op that originally triggered the error, and that
14012 PL_comppad/PL_curpad points to the currently executing pad.
14018 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
14024 const OP *o, *o2, *kid;
14026 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
14027 uninit_sv == &PL_sv_placeholder)))
14030 switch (obase->op_type) {
14037 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
14038 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
14041 int subscript_type = FUV_SUBSCRIPT_WITHIN;
14043 if (pad) { /* @lex, %lex */
14044 sv = PAD_SVl(obase->op_targ);
14048 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14049 /* @global, %global */
14050 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14053 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
14055 else if (obase == PL_op) /* @{expr}, %{expr} */
14056 return find_uninit_var(cUNOPx(obase)->op_first,
14058 else /* @{expr}, %{expr} as a sub-expression */
14062 /* attempt to find a match within the aggregate */
14064 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14066 subscript_type = FUV_SUBSCRIPT_HASH;
14069 index = find_array_subscript((const AV *)sv, uninit_sv);
14071 subscript_type = FUV_SUBSCRIPT_ARRAY;
14074 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
14077 return varname(gv, hash ? '%' : '@', obase->op_targ,
14078 keysv, index, subscript_type);
14082 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14084 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14085 if (!gv || !GvSTASH(gv))
14087 if (match && (GvSV(gv) != uninit_sv))
14089 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14092 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14095 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14097 return varname(NULL, '$', obase->op_targ,
14098 NULL, 0, FUV_SUBSCRIPT_NONE);
14101 gv = cGVOPx_gv(obase);
14102 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14104 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14106 case OP_AELEMFAST_LEX:
14109 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14110 if (!av || SvRMAGICAL(av))
14112 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14113 if (!svp || *svp != uninit_sv)
14116 return varname(NULL, '$', obase->op_targ,
14117 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14120 gv = cGVOPx_gv(obase);
14125 AV *const av = GvAV(gv);
14126 if (!av || SvRMAGICAL(av))
14128 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14129 if (!svp || *svp != uninit_sv)
14132 return varname(gv, '$', 0,
14133 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14138 o = cUNOPx(obase)->op_first;
14139 if (!o || o->op_type != OP_NULL ||
14140 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14142 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14147 bool negate = FALSE;
14149 if (PL_op == obase)
14150 /* $a[uninit_expr] or $h{uninit_expr} */
14151 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14154 o = cBINOPx(obase)->op_first;
14155 kid = cBINOPx(obase)->op_last;
14157 /* get the av or hv, and optionally the gv */
14159 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14160 sv = PAD_SV(o->op_targ);
14162 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14163 && cUNOPo->op_first->op_type == OP_GV)
14165 gv = cGVOPx_gv(cUNOPo->op_first);
14169 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14174 if (kid && kid->op_type == OP_NEGATE) {
14176 kid = cUNOPx(kid)->op_first;
14179 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14180 /* index is constant */
14183 kidsv = sv_2mortal(newSVpvs("-"));
14184 sv_catsv(kidsv, cSVOPx_sv(kid));
14187 kidsv = cSVOPx_sv(kid);
14191 if (obase->op_type == OP_HELEM) {
14192 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14193 if (!he || HeVAL(he) != uninit_sv)
14197 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14198 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14200 if (!svp || *svp != uninit_sv)
14204 if (obase->op_type == OP_HELEM)
14205 return varname(gv, '%', o->op_targ,
14206 kidsv, 0, FUV_SUBSCRIPT_HASH);
14208 return varname(gv, '@', o->op_targ, NULL,
14209 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14210 FUV_SUBSCRIPT_ARRAY);
14213 /* index is an expression;
14214 * attempt to find a match within the aggregate */
14215 if (obase->op_type == OP_HELEM) {
14216 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14218 return varname(gv, '%', o->op_targ,
14219 keysv, 0, FUV_SUBSCRIPT_HASH);
14223 = find_array_subscript((const AV *)sv, uninit_sv);
14225 return varname(gv, '@', o->op_targ,
14226 NULL, index, FUV_SUBSCRIPT_ARRAY);
14231 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14233 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14239 /* only examine RHS */
14240 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14243 o = cUNOPx(obase)->op_first;
14244 if (o->op_type == OP_PUSHMARK)
14247 if (!o->op_sibling) {
14248 /* one-arg version of open is highly magical */
14250 if (o->op_type == OP_GV) { /* open FOO; */
14252 if (match && GvSV(gv) != uninit_sv)
14254 return varname(gv, '$', 0,
14255 NULL, 0, FUV_SUBSCRIPT_NONE);
14257 /* other possibilities not handled are:
14258 * open $x; or open my $x; should return '${*$x}'
14259 * open expr; should return '$'.expr ideally
14265 /* ops where $_ may be an implicit arg */
14270 if ( !(obase->op_flags & OPf_STACKED)) {
14271 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14272 ? PAD_SVl(obase->op_targ)
14275 sv = sv_newmortal();
14276 sv_setpvs(sv, "$_");
14285 match = 1; /* print etc can return undef on defined args */
14286 /* skip filehandle as it can't produce 'undef' warning */
14287 o = cUNOPx(obase)->op_first;
14288 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14289 o = o->op_sibling->op_sibling;
14293 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14294 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14296 /* the following ops are capable of returning PL_sv_undef even for
14297 * defined arg(s) */
14316 case OP_GETPEERNAME:
14364 case OP_SMARTMATCH:
14373 /* XXX tmp hack: these two may call an XS sub, and currently
14374 XS subs don't have a SUB entry on the context stack, so CV and
14375 pad determination goes wrong, and BAD things happen. So, just
14376 don't try to determine the value under those circumstances.
14377 Need a better fix at dome point. DAPM 11/2007 */
14383 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14384 if (gv && GvSV(gv) == uninit_sv)
14385 return newSVpvs_flags("$.", SVs_TEMP);
14390 /* def-ness of rval pos() is independent of the def-ness of its arg */
14391 if ( !(obase->op_flags & OPf_MOD))
14396 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14397 return newSVpvs_flags("${$/}", SVs_TEMP);
14402 if (!(obase->op_flags & OPf_KIDS))
14404 o = cUNOPx(obase)->op_first;
14410 /* This loop checks all the kid ops, skipping any that cannot pos-
14411 * sibly be responsible for the uninitialized value; i.e., defined
14412 * constants and ops that return nothing. If there is only one op
14413 * left that is not skipped, then we *know* it is responsible for
14414 * the uninitialized value. If there is more than one op left, we
14415 * have to look for an exact match in the while() loop below.
14418 for (kid=o; kid; kid = kid->op_sibling) {
14420 const OPCODE type = kid->op_type;
14421 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14422 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14423 || (type == OP_PUSHMARK)
14427 if (o2) { /* more than one found */
14434 return find_uninit_var(o2, uninit_sv, match);
14436 /* scan all args */
14438 sv = find_uninit_var(o, uninit_sv, 1);
14450 =for apidoc report_uninit
14452 Print appropriate "Use of uninitialized variable" warning.
14458 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14462 SV* varname = NULL;
14463 if (uninit_sv && PL_curpad) {
14464 varname = find_uninit_var(PL_op, uninit_sv,0);
14466 sv_insert(varname, 0, 0, " ", 1);
14468 /* diag_listed_as: Use of uninitialized value%s */
14469 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14470 SVfARG(varname ? varname : &PL_sv_no),
14471 " in ", OP_DESC(PL_op));
14474 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14480 * c-indentation-style: bsd
14481 * c-basic-offset: 4
14482 * indent-tabs-mode: nil
14485 * ex: set ts=8 sts=4 sw=4 et: