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);
2846 /* If the regex is UTF-8 we want the containing scalar to
2847 have an UTF-8 flag too */
2853 if ((seen_evals = RX_SEEN_EVALS(re)))
2854 PL_reginterp_cnt += seen_evals;
2857 *lp = RX_WRAPLEN(re);
2859 return RX_WRAPPED(re);
2861 const char *const typestr = sv_reftype(referent, 0);
2862 const STRLEN typelen = strlen(typestr);
2863 UV addr = PTR2UV(referent);
2864 const char *stashname = NULL;
2865 STRLEN stashnamelen = 0; /* hush, gcc */
2866 const char *buffer_end;
2868 if (SvOBJECT(referent)) {
2869 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2872 stashname = HEK_KEY(name);
2873 stashnamelen = HEK_LEN(name);
2875 if (HEK_UTF8(name)) {
2881 stashname = "__ANON__";
2884 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2885 + 2 * sizeof(UV) + 2 /* )\0 */;
2887 len = typelen + 3 /* (0x */
2888 + 2 * sizeof(UV) + 2 /* )\0 */;
2891 Newx(buffer, len, char);
2892 buffer_end = retval = buffer + len;
2894 /* Working backwards */
2898 *--retval = PL_hexdigit[addr & 15];
2899 } while (addr >>= 4);
2905 memcpy(retval, typestr, typelen);
2909 retval -= stashnamelen;
2910 memcpy(retval, stashname, stashnamelen);
2912 /* retval may not necessarily have reached the start of the
2914 assert (retval >= buffer);
2916 len = buffer_end - retval - 1; /* -1 for that \0 */
2924 if (SvREADONLY(sv) && !SvOK(sv)) {
2927 if (flags & SV_UNDEF_RETURNS_NULL)
2929 if (ckWARN(WARN_UNINITIALIZED))
2934 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2935 /* I'm assuming that if both IV and NV are equally valid then
2936 converting the IV is going to be more efficient */
2937 const U32 isUIOK = SvIsUV(sv);
2938 char buf[TYPE_CHARS(UV)];
2942 if (SvTYPE(sv) < SVt_PVIV)
2943 sv_upgrade(sv, SVt_PVIV);
2944 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2946 /* inlined from sv_setpvn */
2947 s = SvGROW_mutable(sv, len + 1);
2948 Move(ptr, s, len, char);
2952 else if (SvNOKp(sv)) {
2953 if (SvTYPE(sv) < SVt_PVNV)
2954 sv_upgrade(sv, SVt_PVNV);
2955 if (SvNVX(sv) == 0.0) {
2956 s = SvGROW_mutable(sv, 2);
2961 /* The +20 is pure guesswork. Configure test needed. --jhi */
2962 s = SvGROW_mutable(sv, NV_DIG + 20);
2963 /* some Xenix systems wipe out errno here */
2964 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2974 if (isGV_with_GP(sv)) {
2975 GV *const gv = MUTABLE_GV(sv);
2976 SV *const buffer = sv_newmortal();
2978 gv_efullname3(buffer, gv, "*");
2980 assert(SvPOK(buffer));
2982 *lp = SvCUR(buffer);
2984 if ( SvUTF8(buffer) ) SvUTF8_on(sv);
2985 return SvPVX(buffer);
2990 if (flags & SV_UNDEF_RETURNS_NULL)
2992 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2994 if (SvTYPE(sv) < SVt_PV)
2995 /* Typically the caller expects that sv_any is not NULL now. */
2996 sv_upgrade(sv, SVt_PV);
3000 const STRLEN len = s - SvPVX_const(sv);
3006 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3007 PTR2UV(sv),SvPVX_const(sv)));
3008 if (flags & SV_CONST_RETURN)
3009 return (char *)SvPVX_const(sv);
3010 if (flags & SV_MUTABLE_RETURN)
3011 return SvPVX_mutable(sv);
3016 =for apidoc sv_copypv
3018 Copies a stringified representation of the source SV into the
3019 destination SV. Automatically performs any necessary mg_get and
3020 coercion of numeric values into strings. Guaranteed to preserve
3021 UTF8 flag even from overloaded objects. Similar in nature to
3022 sv_2pv[_flags] but operates directly on an SV instead of just the
3023 string. Mostly uses sv_2pv_flags to do its work, except when that
3024 would lose the UTF-8'ness of the PV.
3030 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3033 const char * const s = SvPV_const(ssv,len);
3035 PERL_ARGS_ASSERT_SV_COPYPV;
3037 sv_setpvn(dsv,s,len);
3045 =for apidoc sv_2pvbyte
3047 Return a pointer to the byte-encoded representation of the SV, and set *lp
3048 to its length. May cause the SV to be downgraded from UTF-8 as a
3051 Usually accessed via the C<SvPVbyte> macro.
3057 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *const lp)
3059 PERL_ARGS_ASSERT_SV_2PVBYTE;
3061 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv)) {
3062 SV *sv2 = sv_newmortal();
3066 else SvGETMAGIC(sv);
3067 sv_utf8_downgrade(sv,0);
3068 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3072 =for apidoc sv_2pvutf8
3074 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3075 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3077 Usually accessed via the C<SvPVutf8> macro.
3083 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *const lp)
3085 PERL_ARGS_ASSERT_SV_2PVUTF8;
3087 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv))
3088 sv = sv_mortalcopy(sv);
3089 sv_utf8_upgrade(sv);
3090 if (SvGMAGICAL(sv)) SvFLAGS(sv) &= ~SVf_POK;
3092 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3097 =for apidoc sv_2bool
3099 This macro is only used by sv_true() or its macro equivalent, and only if
3100 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3101 It calls sv_2bool_flags with the SV_GMAGIC flag.
3103 =for apidoc sv_2bool_flags
3105 This function is only used by sv_true() and friends, and only if
3106 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3107 contain SV_GMAGIC, then it does an mg_get() first.
3114 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3118 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3120 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3126 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3127 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3128 return cBOOL(SvTRUE(tmpsv));
3130 return SvRV(sv) != 0;
3133 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3135 (*sv->sv_u.svu_pv > '0' ||
3136 Xpvtmp->xpv_cur > 1 ||
3137 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3144 return SvIVX(sv) != 0;
3147 return SvNVX(sv) != 0.0;
3149 if (isGV_with_GP(sv))
3159 =for apidoc sv_utf8_upgrade
3161 Converts the PV of an SV to its UTF-8-encoded form.
3162 Forces the SV to string form if it is not already.
3163 Will C<mg_get> on C<sv> if appropriate.
3164 Always sets the SvUTF8 flag to avoid future validity checks even
3165 if the whole string is the same in UTF-8 as not.
3166 Returns the number of bytes in the converted string
3168 This is not as a general purpose byte encoding to Unicode interface:
3169 use the Encode extension for that.
3171 =for apidoc sv_utf8_upgrade_nomg
3173 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3175 =for apidoc sv_utf8_upgrade_flags
3177 Converts the PV of an SV to its UTF-8-encoded form.
3178 Forces the SV to string form if it is not already.
3179 Always sets the SvUTF8 flag to avoid future validity checks even
3180 if all the bytes are invariant in UTF-8.
3181 If C<flags> has C<SV_GMAGIC> bit set,
3182 will C<mg_get> on C<sv> if appropriate, else not.
3183 Returns the number of bytes in the converted string
3184 C<sv_utf8_upgrade> and
3185 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3187 This is not as a general purpose byte encoding to Unicode interface:
3188 use the Encode extension for that.
3192 The grow version is currently not externally documented. It adds a parameter,
3193 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3194 have free after it upon return. This allows the caller to reserve extra space
3195 that it intends to fill, to avoid extra grows.
3197 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3198 which can be used to tell this function to not first check to see if there are
3199 any characters that are different in UTF-8 (variant characters) which would
3200 force it to allocate a new string to sv, but to assume there are. Typically
3201 this flag is used by a routine that has already parsed the string to find that
3202 there are such characters, and passes this information on so that the work
3203 doesn't have to be repeated.
3205 (One might think that the calling routine could pass in the position of the
3206 first such variant, so it wouldn't have to be found again. But that is not the
3207 case, because typically when the caller is likely to use this flag, it won't be
3208 calling this routine unless it finds something that won't fit into a byte.
3209 Otherwise it tries to not upgrade and just use bytes. But some things that
3210 do fit into a byte are variants in utf8, and the caller may not have been
3211 keeping track of these.)
3213 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3214 isn't guaranteed due to having other routines do the work in some input cases,
3215 or if the input is already flagged as being in utf8.
3217 The speed of this could perhaps be improved for many cases if someone wanted to
3218 write a fast function that counts the number of variant characters in a string,
3219 especially if it could return the position of the first one.
3224 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3228 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3230 if (sv == &PL_sv_undef)
3234 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3235 (void) sv_2pv_flags(sv,&len, flags);
3237 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3241 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3246 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3251 sv_force_normal_flags(sv, 0);
3254 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3255 sv_recode_to_utf8(sv, PL_encoding);
3256 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3260 if (SvCUR(sv) == 0) {
3261 if (extra) SvGROW(sv, extra);
3262 } else { /* Assume Latin-1/EBCDIC */
3263 /* This function could be much more efficient if we
3264 * had a FLAG in SVs to signal if there are any variant
3265 * chars in the PV. Given that there isn't such a flag
3266 * make the loop as fast as possible (although there are certainly ways
3267 * to speed this up, eg. through vectorization) */
3268 U8 * s = (U8 *) SvPVX_const(sv);
3269 U8 * e = (U8 *) SvEND(sv);
3271 STRLEN two_byte_count = 0;
3273 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3275 /* See if really will need to convert to utf8. We mustn't rely on our
3276 * incoming SV being well formed and having a trailing '\0', as certain
3277 * code in pp_formline can send us partially built SVs. */
3281 if (NATIVE_IS_INVARIANT(ch)) continue;
3283 t--; /* t already incremented; re-point to first variant */
3288 /* utf8 conversion not needed because all are invariants. Mark as
3289 * UTF-8 even if no variant - saves scanning loop */
3291 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3296 /* Here, the string should be converted to utf8, either because of an
3297 * input flag (two_byte_count = 0), or because a character that
3298 * requires 2 bytes was found (two_byte_count = 1). t points either to
3299 * the beginning of the string (if we didn't examine anything), or to
3300 * the first variant. In either case, everything from s to t - 1 will
3301 * occupy only 1 byte each on output.
3303 * There are two main ways to convert. One is to create a new string
3304 * and go through the input starting from the beginning, appending each
3305 * converted value onto the new string as we go along. It's probably
3306 * best to allocate enough space in the string for the worst possible
3307 * case rather than possibly running out of space and having to
3308 * reallocate and then copy what we've done so far. Since everything
3309 * from s to t - 1 is invariant, the destination can be initialized
3310 * with these using a fast memory copy
3312 * The other way is to figure out exactly how big the string should be
3313 * by parsing the entire input. Then you don't have to make it big
3314 * enough to handle the worst possible case, and more importantly, if
3315 * the string you already have is large enough, you don't have to
3316 * allocate a new string, you can copy the last character in the input
3317 * string to the final position(s) that will be occupied by the
3318 * converted string and go backwards, stopping at t, since everything
3319 * before that is invariant.
3321 * There are advantages and disadvantages to each method.
3323 * In the first method, we can allocate a new string, do the memory
3324 * copy from the s to t - 1, and then proceed through the rest of the
3325 * string byte-by-byte.
3327 * In the second method, we proceed through the rest of the input
3328 * string just calculating how big the converted string will be. Then
3329 * there are two cases:
3330 * 1) if the string has enough extra space to handle the converted
3331 * value. We go backwards through the string, converting until we
3332 * get to the position we are at now, and then stop. If this
3333 * position is far enough along in the string, this method is
3334 * faster than the other method. If the memory copy were the same
3335 * speed as the byte-by-byte loop, that position would be about
3336 * half-way, as at the half-way mark, parsing to the end and back
3337 * is one complete string's parse, the same amount as starting
3338 * over and going all the way through. Actually, it would be
3339 * somewhat less than half-way, as it's faster to just count bytes
3340 * than to also copy, and we don't have the overhead of allocating
3341 * a new string, changing the scalar to use it, and freeing the
3342 * existing one. But if the memory copy is fast, the break-even
3343 * point is somewhere after half way. The counting loop could be
3344 * sped up by vectorization, etc, to move the break-even point
3345 * further towards the beginning.
3346 * 2) if the string doesn't have enough space to handle the converted
3347 * value. A new string will have to be allocated, and one might
3348 * as well, given that, start from the beginning doing the first
3349 * method. We've spent extra time parsing the string and in
3350 * exchange all we've gotten is that we know precisely how big to
3351 * make the new one. Perl is more optimized for time than space,
3352 * so this case is a loser.
3353 * So what I've decided to do is not use the 2nd method unless it is
3354 * guaranteed that a new string won't have to be allocated, assuming
3355 * the worst case. I also decided not to put any more conditions on it
3356 * than this, for now. It seems likely that, since the worst case is
3357 * twice as big as the unknown portion of the string (plus 1), we won't
3358 * be guaranteed enough space, causing us to go to the first method,
3359 * unless the string is short, or the first variant character is near
3360 * the end of it. In either of these cases, it seems best to use the
3361 * 2nd method. The only circumstance I can think of where this would
3362 * be really slower is if the string had once had much more data in it
3363 * than it does now, but there is still a substantial amount in it */
3366 STRLEN invariant_head = t - s;
3367 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3368 if (SvLEN(sv) < size) {
3370 /* Here, have decided to allocate a new string */
3375 Newx(dst, size, U8);
3377 /* If no known invariants at the beginning of the input string,
3378 * set so starts from there. Otherwise, can use memory copy to
3379 * get up to where we are now, and then start from here */
3381 if (invariant_head <= 0) {
3384 Copy(s, dst, invariant_head, char);
3385 d = dst + invariant_head;
3389 const UV uv = NATIVE8_TO_UNI(*t++);
3390 if (UNI_IS_INVARIANT(uv))
3391 *d++ = (U8)UNI_TO_NATIVE(uv);
3393 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3394 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3398 SvPV_free(sv); /* No longer using pre-existing string */
3399 SvPV_set(sv, (char*)dst);
3400 SvCUR_set(sv, d - dst);
3401 SvLEN_set(sv, size);
3404 /* Here, have decided to get the exact size of the string.
3405 * Currently this happens only when we know that there is
3406 * guaranteed enough space to fit the converted string, so
3407 * don't have to worry about growing. If two_byte_count is 0,
3408 * then t points to the first byte of the string which hasn't
3409 * been examined yet. Otherwise two_byte_count is 1, and t
3410 * points to the first byte in the string that will expand to
3411 * two. Depending on this, start examining at t or 1 after t.
3414 U8 *d = t + two_byte_count;
3417 /* Count up the remaining bytes that expand to two */
3420 const U8 chr = *d++;
3421 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3424 /* The string will expand by just the number of bytes that
3425 * occupy two positions. But we are one afterwards because of
3426 * the increment just above. This is the place to put the
3427 * trailing NUL, and to set the length before we decrement */
3429 d += two_byte_count;
3430 SvCUR_set(sv, d - s);
3434 /* Having decremented d, it points to the position to put the
3435 * very last byte of the expanded string. Go backwards through
3436 * the string, copying and expanding as we go, stopping when we
3437 * get to the part that is invariant the rest of the way down */
3441 const U8 ch = NATIVE8_TO_UNI(*e--);
3442 if (UNI_IS_INVARIANT(ch)) {
3443 *d-- = UNI_TO_NATIVE(ch);
3445 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3446 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3451 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3452 /* Update pos. We do it at the end rather than during
3453 * the upgrade, to avoid slowing down the common case
3454 * (upgrade without pos) */
3455 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3457 I32 pos = mg->mg_len;
3458 if (pos > 0 && (U32)pos > invariant_head) {
3459 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3460 STRLEN n = (U32)pos - invariant_head;
3462 if (UTF8_IS_START(*d))
3467 mg->mg_len = d - (U8*)SvPVX(sv);
3470 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3471 magic_setutf8(sv,mg); /* clear UTF8 cache */
3476 /* Mark as UTF-8 even if no variant - saves scanning loop */
3482 =for apidoc sv_utf8_downgrade
3484 Attempts to convert the PV of an SV from characters to bytes.
3485 If the PV contains a character that cannot fit
3486 in a byte, this conversion will fail;
3487 in this case, either returns false or, if C<fail_ok> is not
3490 This is not as a general purpose Unicode to byte encoding interface:
3491 use the Encode extension for that.
3497 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3501 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3503 if (SvPOKp(sv) && SvUTF8(sv)) {
3507 int mg_flags = SV_GMAGIC;
3510 sv_force_normal_flags(sv, 0);
3512 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3514 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3516 I32 pos = mg->mg_len;
3518 sv_pos_b2u(sv, &pos);
3519 mg_flags = 0; /* sv_pos_b2u does get magic */
3523 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3524 magic_setutf8(sv,mg); /* clear UTF8 cache */
3527 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3529 if (!utf8_to_bytes(s, &len)) {
3534 Perl_croak(aTHX_ "Wide character in %s",
3537 Perl_croak(aTHX_ "Wide character");
3548 =for apidoc sv_utf8_encode
3550 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3551 flag off so that it looks like octets again.
3557 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3559 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3561 if (SvREADONLY(sv)) {
3562 sv_force_normal_flags(sv, 0);
3564 (void) sv_utf8_upgrade(sv);
3569 =for apidoc sv_utf8_decode
3571 If the PV of the SV is an octet sequence in UTF-8
3572 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3573 so that it looks like a character. If the PV contains only single-byte
3574 characters, the C<SvUTF8> flag stays off.
3575 Scans PV for validity and returns false if the PV is invalid UTF-8.
3581 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3583 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3586 const U8 *start, *c;
3589 /* The octets may have got themselves encoded - get them back as
3592 if (!sv_utf8_downgrade(sv, TRUE))
3595 /* it is actually just a matter of turning the utf8 flag on, but
3596 * we want to make sure everything inside is valid utf8 first.
3598 c = start = (const U8 *) SvPVX_const(sv);
3599 if (!is_utf8_string(c, SvCUR(sv)))
3601 e = (const U8 *) SvEND(sv);
3604 if (!UTF8_IS_INVARIANT(ch)) {
3609 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3610 /* adjust pos to the start of a UTF8 char sequence */
3611 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3613 I32 pos = mg->mg_len;
3615 for (c = start + pos; c > start; c--) {
3616 if (UTF8_IS_START(*c))
3619 mg->mg_len = c - start;
3622 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3623 magic_setutf8(sv,mg); /* clear UTF8 cache */
3630 =for apidoc sv_setsv
3632 Copies the contents of the source SV C<ssv> into the destination SV
3633 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3634 function if the source SV needs to be reused. Does not handle 'set' magic.
3635 Loosely speaking, it performs a copy-by-value, obliterating any previous
3636 content of the destination.
3638 You probably want to use one of the assortment of wrappers, such as
3639 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3640 C<SvSetMagicSV_nosteal>.
3642 =for apidoc sv_setsv_flags
3644 Copies the contents of the source SV C<ssv> into the destination SV
3645 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3646 function if the source SV needs to be reused. Does not handle 'set' magic.
3647 Loosely speaking, it performs a copy-by-value, obliterating any previous
3648 content of the destination.
3649 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3650 C<ssv> if appropriate, else not. If the C<flags>
3651 parameter has the C<NOSTEAL> bit set then the
3652 buffers of temps will not be stolen. <sv_setsv>
3653 and C<sv_setsv_nomg> are implemented in terms of this function.
3655 You probably want to use one of the assortment of wrappers, such as
3656 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3657 C<SvSetMagicSV_nosteal>.
3659 This is the primary function for copying scalars, and most other
3660 copy-ish functions and macros use this underneath.
3666 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3668 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3669 HV *old_stash = NULL;
3671 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3673 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3674 const char * const name = GvNAME(sstr);
3675 const STRLEN len = GvNAMELEN(sstr);
3677 if (dtype >= SVt_PV) {
3683 SvUPGRADE(dstr, SVt_PVGV);
3684 (void)SvOK_off(dstr);
3685 /* We have to turn this on here, even though we turn it off
3686 below, as GvSTASH will fail an assertion otherwise. */
3687 isGV_with_GP_on(dstr);
3689 GvSTASH(dstr) = GvSTASH(sstr);
3691 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3692 gv_name_set(MUTABLE_GV(dstr), name, len,
3693 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3694 SvFAKE_on(dstr); /* can coerce to non-glob */
3697 if(GvGP(MUTABLE_GV(sstr))) {
3698 /* If source has method cache entry, clear it */
3700 SvREFCNT_dec(GvCV(sstr));
3701 GvCV_set(sstr, NULL);
3704 /* If source has a real method, then a method is
3707 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3713 /* If dest already had a real method, that's a change as well */
3715 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3716 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3721 /* We don't need to check the name of the destination if it was not a
3722 glob to begin with. */
3723 if(dtype == SVt_PVGV) {
3724 const char * const name = GvNAME((const GV *)dstr);
3727 /* The stash may have been detached from the symbol table, so
3729 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3730 && GvAV((const GV *)sstr)
3734 const STRLEN len = GvNAMELEN(dstr);
3735 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3736 || (len == 1 && name[0] == ':')) {
3739 /* Set aside the old stash, so we can reset isa caches on
3741 if((old_stash = GvHV(dstr)))
3742 /* Make sure we do not lose it early. */
3743 SvREFCNT_inc_simple_void_NN(
3744 sv_2mortal((SV *)old_stash)
3750 gp_free(MUTABLE_GV(dstr));
3751 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3752 (void)SvOK_off(dstr);
3753 isGV_with_GP_on(dstr);
3754 GvINTRO_off(dstr); /* one-shot flag */
3755 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3756 if (SvTAINTED(sstr))
3758 if (GvIMPORTED(dstr) != GVf_IMPORTED
3759 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3761 GvIMPORTED_on(dstr);
3764 if(mro_changes == 2) {
3766 SV * const sref = (SV *)GvAV((const GV *)dstr);
3767 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3768 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3769 AV * const ary = newAV();
3770 av_push(ary, mg->mg_obj); /* takes the refcount */
3771 mg->mg_obj = (SV *)ary;
3773 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3775 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3776 mro_isa_changed_in(GvSTASH(dstr));
3778 else if(mro_changes == 3) {
3779 HV * const stash = GvHV(dstr);
3780 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3786 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3791 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3793 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3795 const int intro = GvINTRO(dstr);
3798 const U32 stype = SvTYPE(sref);
3800 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3803 GvINTRO_off(dstr); /* one-shot flag */
3804 GvLINE(dstr) = CopLINE(PL_curcop);
3805 GvEGV(dstr) = MUTABLE_GV(dstr);
3810 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3811 import_flag = GVf_IMPORTED_CV;
3814 location = (SV **) &GvHV(dstr);
3815 import_flag = GVf_IMPORTED_HV;
3818 location = (SV **) &GvAV(dstr);
3819 import_flag = GVf_IMPORTED_AV;
3822 location = (SV **) &GvIOp(dstr);
3825 location = (SV **) &GvFORM(dstr);
3828 location = &GvSV(dstr);
3829 import_flag = GVf_IMPORTED_SV;
3832 if (stype == SVt_PVCV) {
3833 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3834 if (GvCVGEN(dstr)) {
3835 SvREFCNT_dec(GvCV(dstr));
3836 GvCV_set(dstr, NULL);
3837 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3840 SAVEGENERICSV(*location);
3844 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3845 CV* const cv = MUTABLE_CV(*location);
3847 if (!GvCVGEN((const GV *)dstr) &&
3848 (CvROOT(cv) || CvXSUB(cv)) &&
3849 /* redundant check that avoids creating the extra SV
3850 most of the time: */
3851 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3853 SV * const new_const_sv =
3854 CvCONST((const CV *)sref)
3855 ? cv_const_sv((const CV *)sref)
3857 report_redefined_cv(
3858 sv_2mortal(Perl_newSVpvf(aTHX_
3861 HvNAME_HEK(GvSTASH((const GV *)dstr))
3863 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3866 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3870 cv_ckproto_len_flags(cv, (const GV *)dstr,
3871 SvPOK(sref) ? CvPROTO(sref) : NULL,
3872 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3873 SvPOK(sref) ? SvUTF8(sref) : 0);
3875 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3876 GvASSUMECV_on(dstr);
3877 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3880 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3881 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3882 GvFLAGS(dstr) |= import_flag;
3884 if (stype == SVt_PVHV) {
3885 const char * const name = GvNAME((GV*)dstr);
3886 const STRLEN len = GvNAMELEN(dstr);
3889 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3890 || (len == 1 && name[0] == ':')
3892 && (!dref || HvENAME_get(dref))
3895 (HV *)sref, (HV *)dref,
3901 stype == SVt_PVAV && sref != dref
3902 && strEQ(GvNAME((GV*)dstr), "ISA")
3903 /* The stash may have been detached from the symbol table, so
3904 check its name before doing anything. */
3905 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3908 MAGIC * const omg = dref && SvSMAGICAL(dref)
3909 ? mg_find(dref, PERL_MAGIC_isa)
3911 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3912 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3913 AV * const ary = newAV();
3914 av_push(ary, mg->mg_obj); /* takes the refcount */
3915 mg->mg_obj = (SV *)ary;
3918 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3919 SV **svp = AvARRAY((AV *)omg->mg_obj);
3920 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3924 SvREFCNT_inc_simple_NN(*svp++)
3930 SvREFCNT_inc_simple_NN(omg->mg_obj)
3934 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3939 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3941 mg = mg_find(sref, PERL_MAGIC_isa);
3943 /* Since the *ISA assignment could have affected more than
3944 one stash, don't call mro_isa_changed_in directly, but let
3945 magic_clearisa do it for us, as it already has the logic for
3946 dealing with globs vs arrays of globs. */
3948 Perl_magic_clearisa(aTHX_ NULL, mg);
3953 if (SvTAINTED(sstr))
3959 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3962 register U32 sflags;
3964 register svtype stype;
3966 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3971 if (SvIS_FREED(dstr)) {
3972 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3973 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3975 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3977 sstr = &PL_sv_undef;
3978 if (SvIS_FREED(sstr)) {
3979 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3980 (void*)sstr, (void*)dstr);
3982 stype = SvTYPE(sstr);
3983 dtype = SvTYPE(dstr);
3987 /* need to nuke the magic */
3988 sv_unmagic(dstr, PERL_MAGIC_vstring);
3991 /* There's a lot of redundancy below but we're going for speed here */
3996 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3997 (void)SvOK_off(dstr);
4005 sv_upgrade(dstr, SVt_IV);
4009 sv_upgrade(dstr, SVt_PVIV);
4013 goto end_of_first_switch;
4015 (void)SvIOK_only(dstr);
4016 SvIV_set(dstr, SvIVX(sstr));
4019 /* SvTAINTED can only be true if the SV has taint magic, which in
4020 turn means that the SV type is PVMG (or greater). This is the
4021 case statement for SVt_IV, so this cannot be true (whatever gcov
4023 assert(!SvTAINTED(sstr));
4028 if (dtype < SVt_PV && dtype != SVt_IV)
4029 sv_upgrade(dstr, SVt_IV);
4037 sv_upgrade(dstr, SVt_NV);
4041 sv_upgrade(dstr, SVt_PVNV);
4045 goto end_of_first_switch;
4047 SvNV_set(dstr, SvNVX(sstr));
4048 (void)SvNOK_only(dstr);
4049 /* SvTAINTED can only be true if the SV has taint magic, which in
4050 turn means that the SV type is PVMG (or greater). This is the
4051 case statement for SVt_NV, so this cannot be true (whatever gcov
4053 assert(!SvTAINTED(sstr));
4059 #ifdef PERL_OLD_COPY_ON_WRITE
4060 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4061 if (dtype < SVt_PVIV)
4062 sv_upgrade(dstr, SVt_PVIV);
4069 sv_upgrade(dstr, SVt_PV);
4072 if (dtype < SVt_PVIV)
4073 sv_upgrade(dstr, SVt_PVIV);
4076 if (dtype < SVt_PVNV)
4077 sv_upgrade(dstr, SVt_PVNV);
4081 const char * const type = sv_reftype(sstr,0);
4083 /* diag_listed_as: Bizarre copy of %s */
4084 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4086 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4091 if (dtype < SVt_REGEXP)
4092 sv_upgrade(dstr, SVt_REGEXP);
4095 /* case SVt_BIND: */
4099 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4101 if (SvTYPE(sstr) != stype)
4102 stype = SvTYPE(sstr);
4104 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4105 glob_assign_glob(dstr, sstr, dtype);
4108 if (stype == SVt_PVLV)
4109 SvUPGRADE(dstr, SVt_PVNV);
4111 SvUPGRADE(dstr, (svtype)stype);
4113 end_of_first_switch:
4115 /* dstr may have been upgraded. */
4116 dtype = SvTYPE(dstr);
4117 sflags = SvFLAGS(sstr);
4119 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4120 /* Assigning to a subroutine sets the prototype. */
4123 const char *const ptr = SvPV_const(sstr, len);
4125 SvGROW(dstr, len + 1);
4126 Copy(ptr, SvPVX(dstr), len + 1, char);
4127 SvCUR_set(dstr, len);
4129 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4130 CvAUTOLOAD_off(dstr);
4134 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4135 const char * const type = sv_reftype(dstr,0);
4137 /* diag_listed_as: Cannot copy to %s */
4138 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4140 Perl_croak(aTHX_ "Cannot copy to %s", type);
4141 } else if (sflags & SVf_ROK) {
4142 if (isGV_with_GP(dstr)
4143 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4146 if (GvIMPORTED(dstr) != GVf_IMPORTED
4147 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4149 GvIMPORTED_on(dstr);
4154 glob_assign_glob(dstr, sstr, dtype);
4158 if (dtype >= SVt_PV) {
4159 if (isGV_with_GP(dstr)) {
4160 glob_assign_ref(dstr, sstr);
4163 if (SvPVX_const(dstr)) {
4169 (void)SvOK_off(dstr);
4170 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4171 SvFLAGS(dstr) |= sflags & SVf_ROK;
4172 assert(!(sflags & SVp_NOK));
4173 assert(!(sflags & SVp_IOK));
4174 assert(!(sflags & SVf_NOK));
4175 assert(!(sflags & SVf_IOK));
4177 else if (isGV_with_GP(dstr)) {
4178 if (!(sflags & SVf_OK)) {
4179 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4180 "Undefined value assigned to typeglob");
4183 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4184 if (dstr != (const SV *)gv) {
4185 const char * const name = GvNAME((const GV *)dstr);
4186 const STRLEN len = GvNAMELEN(dstr);
4187 HV *old_stash = NULL;
4188 bool reset_isa = FALSE;
4189 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4190 || (len == 1 && name[0] == ':')) {
4191 /* Set aside the old stash, so we can reset isa caches
4192 on its subclasses. */
4193 if((old_stash = GvHV(dstr))) {
4194 /* Make sure we do not lose it early. */
4195 SvREFCNT_inc_simple_void_NN(
4196 sv_2mortal((SV *)old_stash)
4203 gp_free(MUTABLE_GV(dstr));
4204 GvGP_set(dstr, gp_ref(GvGP(gv)));
4207 HV * const stash = GvHV(dstr);
4209 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4219 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4220 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4222 else if (sflags & SVp_POK) {
4226 * Check to see if we can just swipe the string. If so, it's a
4227 * possible small lose on short strings, but a big win on long ones.
4228 * It might even be a win on short strings if SvPVX_const(dstr)
4229 * has to be allocated and SvPVX_const(sstr) has to be freed.
4230 * Likewise if we can set up COW rather than doing an actual copy, we
4231 * drop to the else clause, as the swipe code and the COW setup code
4232 * have much in common.
4235 /* Whichever path we take through the next code, we want this true,
4236 and doing it now facilitates the COW check. */
4237 (void)SvPOK_only(dstr);
4240 /* If we're already COW then this clause is not true, and if COW
4241 is allowed then we drop down to the else and make dest COW
4242 with us. If caller hasn't said that we're allowed to COW
4243 shared hash keys then we don't do the COW setup, even if the
4244 source scalar is a shared hash key scalar. */
4245 (((flags & SV_COW_SHARED_HASH_KEYS)
4246 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4247 : 1 /* If making a COW copy is forbidden then the behaviour we
4248 desire is as if the source SV isn't actually already
4249 COW, even if it is. So we act as if the source flags
4250 are not COW, rather than actually testing them. */
4252 #ifndef PERL_OLD_COPY_ON_WRITE
4253 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4254 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4255 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4256 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4257 but in turn, it's somewhat dead code, never expected to go
4258 live, but more kept as a placeholder on how to do it better
4259 in a newer implementation. */
4260 /* If we are COW and dstr is a suitable target then we drop down
4261 into the else and make dest a COW of us. */
4262 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4267 (sflags & SVs_TEMP) && /* slated for free anyway? */
4268 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4269 (!(flags & SV_NOSTEAL)) &&
4270 /* and we're allowed to steal temps */
4271 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4272 SvLEN(sstr)) /* and really is a string */
4273 #ifdef PERL_OLD_COPY_ON_WRITE
4274 && ((flags & SV_COW_SHARED_HASH_KEYS)
4275 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4276 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4277 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4281 /* Failed the swipe test, and it's not a shared hash key either.
4282 Have to copy the string. */
4283 STRLEN len = SvCUR(sstr);
4284 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4285 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4286 SvCUR_set(dstr, len);
4287 *SvEND(dstr) = '\0';
4289 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4291 /* Either it's a shared hash key, or it's suitable for
4292 copy-on-write or we can swipe the string. */
4294 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4298 #ifdef PERL_OLD_COPY_ON_WRITE
4300 if ((sflags & (SVf_FAKE | SVf_READONLY))
4301 != (SVf_FAKE | SVf_READONLY)) {
4302 SvREADONLY_on(sstr);
4304 /* Make the source SV into a loop of 1.
4305 (about to become 2) */
4306 SV_COW_NEXT_SV_SET(sstr, sstr);
4310 /* Initial code is common. */
4311 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4316 /* making another shared SV. */
4317 STRLEN cur = SvCUR(sstr);
4318 STRLEN len = SvLEN(sstr);
4319 #ifdef PERL_OLD_COPY_ON_WRITE
4321 assert (SvTYPE(dstr) >= SVt_PVIV);
4322 /* SvIsCOW_normal */
4323 /* splice us in between source and next-after-source. */
4324 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4325 SV_COW_NEXT_SV_SET(sstr, dstr);
4326 SvPV_set(dstr, SvPVX_mutable(sstr));
4330 /* SvIsCOW_shared_hash */
4331 DEBUG_C(PerlIO_printf(Perl_debug_log,
4332 "Copy on write: Sharing hash\n"));
4334 assert (SvTYPE(dstr) >= SVt_PV);
4336 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4338 SvLEN_set(dstr, len);
4339 SvCUR_set(dstr, cur);
4340 SvREADONLY_on(dstr);
4344 { /* Passes the swipe test. */
4345 SvPV_set(dstr, SvPVX_mutable(sstr));
4346 SvLEN_set(dstr, SvLEN(sstr));
4347 SvCUR_set(dstr, SvCUR(sstr));
4350 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4351 SvPV_set(sstr, NULL);
4357 if (sflags & SVp_NOK) {
4358 SvNV_set(dstr, SvNVX(sstr));
4360 if (sflags & SVp_IOK) {
4361 SvIV_set(dstr, SvIVX(sstr));
4362 /* Must do this otherwise some other overloaded use of 0x80000000
4363 gets confused. I guess SVpbm_VALID */
4364 if (sflags & SVf_IVisUV)
4367 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4369 const MAGIC * const smg = SvVSTRING_mg(sstr);
4371 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4372 smg->mg_ptr, smg->mg_len);
4373 SvRMAGICAL_on(dstr);
4377 else if (sflags & (SVp_IOK|SVp_NOK)) {
4378 (void)SvOK_off(dstr);
4379 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4380 if (sflags & SVp_IOK) {
4381 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4382 SvIV_set(dstr, SvIVX(sstr));
4384 if (sflags & SVp_NOK) {
4385 SvNV_set(dstr, SvNVX(sstr));
4389 if (isGV_with_GP(sstr)) {
4390 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4393 (void)SvOK_off(dstr);
4395 if (SvTAINTED(sstr))
4400 =for apidoc sv_setsv_mg
4402 Like C<sv_setsv>, but also handles 'set' magic.
4408 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4410 PERL_ARGS_ASSERT_SV_SETSV_MG;
4412 sv_setsv(dstr,sstr);
4416 #ifdef PERL_OLD_COPY_ON_WRITE
4418 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4420 STRLEN cur = SvCUR(sstr);
4421 STRLEN len = SvLEN(sstr);
4422 register char *new_pv;
4424 PERL_ARGS_ASSERT_SV_SETSV_COW;
4427 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4428 (void*)sstr, (void*)dstr);
4435 if (SvTHINKFIRST(dstr))
4436 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4437 else if (SvPVX_const(dstr))
4438 Safefree(SvPVX_const(dstr));
4442 SvUPGRADE(dstr, SVt_PVIV);
4444 assert (SvPOK(sstr));
4445 assert (SvPOKp(sstr));
4446 assert (!SvIOK(sstr));
4447 assert (!SvIOKp(sstr));
4448 assert (!SvNOK(sstr));
4449 assert (!SvNOKp(sstr));
4451 if (SvIsCOW(sstr)) {
4453 if (SvLEN(sstr) == 0) {
4454 /* source is a COW shared hash key. */
4455 DEBUG_C(PerlIO_printf(Perl_debug_log,
4456 "Fast copy on write: Sharing hash\n"));
4457 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4460 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4462 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4463 SvUPGRADE(sstr, SVt_PVIV);
4464 SvREADONLY_on(sstr);
4466 DEBUG_C(PerlIO_printf(Perl_debug_log,
4467 "Fast copy on write: Converting sstr to COW\n"));
4468 SV_COW_NEXT_SV_SET(dstr, sstr);
4470 SV_COW_NEXT_SV_SET(sstr, dstr);
4471 new_pv = SvPVX_mutable(sstr);
4474 SvPV_set(dstr, new_pv);
4475 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4478 SvLEN_set(dstr, len);
4479 SvCUR_set(dstr, cur);
4488 =for apidoc sv_setpvn
4490 Copies a string into an SV. The C<len> parameter indicates the number of
4491 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4492 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4498 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4501 register char *dptr;
4503 PERL_ARGS_ASSERT_SV_SETPVN;
4505 SV_CHECK_THINKFIRST_COW_DROP(sv);
4511 /* len is STRLEN which is unsigned, need to copy to signed */
4514 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4517 SvUPGRADE(sv, SVt_PV);
4519 dptr = SvGROW(sv, len + 1);
4520 Move(ptr,dptr,len,char);
4523 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4525 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4529 =for apidoc sv_setpvn_mg
4531 Like C<sv_setpvn>, but also handles 'set' magic.
4537 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4539 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4541 sv_setpvn(sv,ptr,len);
4546 =for apidoc sv_setpv
4548 Copies a string into an SV. The string must be null-terminated. Does not
4549 handle 'set' magic. See C<sv_setpv_mg>.
4555 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4558 register STRLEN len;
4560 PERL_ARGS_ASSERT_SV_SETPV;
4562 SV_CHECK_THINKFIRST_COW_DROP(sv);
4568 SvUPGRADE(sv, SVt_PV);
4570 SvGROW(sv, len + 1);
4571 Move(ptr,SvPVX(sv),len+1,char);
4573 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4575 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4579 =for apidoc sv_setpv_mg
4581 Like C<sv_setpv>, but also handles 'set' magic.
4587 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4589 PERL_ARGS_ASSERT_SV_SETPV_MG;
4596 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4600 PERL_ARGS_ASSERT_SV_SETHEK;
4606 if (HEK_LEN(hek) == HEf_SVKEY) {
4607 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4610 const int flags = HEK_FLAGS(hek);
4611 if (flags & HVhek_WASUTF8) {
4612 STRLEN utf8_len = HEK_LEN(hek);
4613 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4614 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4617 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4618 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4621 else SvUTF8_off(sv);
4625 SV_CHECK_THINKFIRST_COW_DROP(sv);
4626 SvUPGRADE(sv, SVt_PV);
4627 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4628 SvCUR_set(sv, HEK_LEN(hek));
4635 else SvUTF8_off(sv);
4643 =for apidoc sv_usepvn_flags
4645 Tells an SV to use C<ptr> to find its string value. Normally the
4646 string is stored inside the SV but sv_usepvn allows the SV to use an
4647 outside string. The C<ptr> should point to memory that was allocated
4648 by C<malloc>. It must be the start of a mallocked block
4649 of memory, and not a pointer to the middle of it. The
4650 string length, C<len>, must be supplied. By default
4651 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4652 so that pointer should not be freed or used by the programmer after
4653 giving it to sv_usepvn, and neither should any pointers from "behind"
4654 that pointer (e.g. ptr + 1) be used.
4656 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4657 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4658 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4659 C<len>, and already meets the requirements for storing in C<SvPVX>).
4665 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4670 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4672 SV_CHECK_THINKFIRST_COW_DROP(sv);
4673 SvUPGRADE(sv, SVt_PV);
4676 if (flags & SV_SMAGIC)
4680 if (SvPVX_const(sv))
4684 if (flags & SV_HAS_TRAILING_NUL)
4685 assert(ptr[len] == '\0');
4688 allocate = (flags & SV_HAS_TRAILING_NUL)
4690 #ifdef Perl_safesysmalloc_size
4693 PERL_STRLEN_ROUNDUP(len + 1);
4695 if (flags & SV_HAS_TRAILING_NUL) {
4696 /* It's long enough - do nothing.
4697 Specifically Perl_newCONSTSUB is relying on this. */
4700 /* Force a move to shake out bugs in callers. */
4701 char *new_ptr = (char*)safemalloc(allocate);
4702 Copy(ptr, new_ptr, len, char);
4703 PoisonFree(ptr,len,char);
4707 ptr = (char*) saferealloc (ptr, allocate);
4710 #ifdef Perl_safesysmalloc_size
4711 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4713 SvLEN_set(sv, allocate);
4717 if (!(flags & SV_HAS_TRAILING_NUL)) {
4720 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4722 if (flags & SV_SMAGIC)
4726 #ifdef PERL_OLD_COPY_ON_WRITE
4727 /* Need to do this *after* making the SV normal, as we need the buffer
4728 pointer to remain valid until after we've copied it. If we let go too early,
4729 another thread could invalidate it by unsharing last of the same hash key
4730 (which it can do by means other than releasing copy-on-write Svs)
4731 or by changing the other copy-on-write SVs in the loop. */
4733 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4735 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4737 { /* this SV was SvIsCOW_normal(sv) */
4738 /* we need to find the SV pointing to us. */
4739 SV *current = SV_COW_NEXT_SV(after);
4741 if (current == sv) {
4742 /* The SV we point to points back to us (there were only two of us
4744 Hence other SV is no longer copy on write either. */
4746 SvREADONLY_off(after);
4748 /* We need to follow the pointers around the loop. */
4750 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4753 /* don't loop forever if the structure is bust, and we have
4754 a pointer into a closed loop. */
4755 assert (current != after);
4756 assert (SvPVX_const(current) == pvx);
4758 /* Make the SV before us point to the SV after us. */
4759 SV_COW_NEXT_SV_SET(current, after);
4765 =for apidoc sv_force_normal_flags
4767 Undo various types of fakery on an SV: if the PV is a shared string, make
4768 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4769 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4770 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4771 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4772 SvPOK_off rather than making a copy. (Used where this
4773 scalar is about to be set to some other value.) In addition,
4774 the C<flags> parameter gets passed to C<sv_unref_flags()>
4775 when unreffing. C<sv_force_normal> calls this function
4776 with flags set to 0.
4782 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4786 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4788 #ifdef PERL_OLD_COPY_ON_WRITE
4789 if (SvREADONLY(sv)) {
4791 const char * const pvx = SvPVX_const(sv);
4792 const STRLEN len = SvLEN(sv);
4793 const STRLEN cur = SvCUR(sv);
4794 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4795 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4796 we'll fail an assertion. */
4797 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4800 PerlIO_printf(Perl_debug_log,
4801 "Copy on write: Force normal %ld\n",
4807 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4810 if (flags & SV_COW_DROP_PV) {
4811 /* OK, so we don't need to copy our buffer. */
4814 SvGROW(sv, cur + 1);
4815 Move(pvx,SvPVX(sv),cur,char);
4820 sv_release_COW(sv, pvx, next);
4822 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4828 else if (IN_PERL_RUNTIME)
4829 Perl_croak_no_modify(aTHX);
4832 if (SvREADONLY(sv)) {
4834 const char * const pvx = SvPVX_const(sv);
4835 const STRLEN len = SvCUR(sv);
4840 if (flags & SV_COW_DROP_PV) {
4841 /* OK, so we don't need to copy our buffer. */
4844 SvGROW(sv, len + 1);
4845 Move(pvx,SvPVX(sv),len,char);
4848 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4850 else if (IN_PERL_RUNTIME)
4851 Perl_croak_no_modify(aTHX);
4855 sv_unref_flags(sv, flags);
4856 else if (SvFAKE(sv) && isGV_with_GP(sv))
4857 sv_unglob(sv, flags);
4858 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4859 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4860 to sv_unglob. We only need it here, so inline it. */
4861 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4862 SV *const temp = newSV_type(new_type);
4863 void *const temp_p = SvANY(sv);
4865 if (new_type == SVt_PVMG) {
4866 SvMAGIC_set(temp, SvMAGIC(sv));
4867 SvMAGIC_set(sv, NULL);
4868 SvSTASH_set(temp, SvSTASH(sv));
4869 SvSTASH_set(sv, NULL);
4871 SvCUR_set(temp, SvCUR(sv));
4872 /* Remember that SvPVX is in the head, not the body. */
4874 SvLEN_set(temp, SvLEN(sv));
4875 /* This signals "buffer is owned by someone else" in sv_clear,
4876 which is the least effort way to stop it freeing the buffer.
4878 SvLEN_set(sv, SvLEN(sv)+1);
4880 /* Their buffer is already owned by someone else. */
4881 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4882 SvLEN_set(temp, SvCUR(sv)+1);
4885 /* Now swap the rest of the bodies. */
4887 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4888 SvFLAGS(sv) |= new_type;
4889 SvANY(sv) = SvANY(temp);
4891 SvFLAGS(temp) &= ~(SVTYPEMASK);
4892 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4893 SvANY(temp) = temp_p;
4902 Efficient removal of characters from the beginning of the string buffer.
4903 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4904 the string buffer. The C<ptr> becomes the first character of the adjusted
4905 string. Uses the "OOK hack".
4907 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4908 refer to the same chunk of data.
4910 The unfortunate similarity of this function's name to that of Perl's C<chop>
4911 operator is strictly coincidental. This function works from the left;
4912 C<chop> works from the right.
4918 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4929 PERL_ARGS_ASSERT_SV_CHOP;
4931 if (!ptr || !SvPOKp(sv))
4933 delta = ptr - SvPVX_const(sv);
4935 /* Nothing to do. */
4938 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4939 if (delta > max_delta)
4940 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4941 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4942 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4943 SV_CHECK_THINKFIRST(sv);
4946 if (!SvLEN(sv)) { /* make copy of shared string */
4947 const char *pvx = SvPVX_const(sv);
4948 const STRLEN len = SvCUR(sv);
4949 SvGROW(sv, len + 1);
4950 Move(pvx,SvPVX(sv),len,char);
4956 SvOOK_offset(sv, old_delta);
4958 SvLEN_set(sv, SvLEN(sv) - delta);
4959 SvCUR_set(sv, SvCUR(sv) - delta);
4960 SvPV_set(sv, SvPVX(sv) + delta);
4962 p = (U8 *)SvPVX_const(sv);
4965 /* how many bytes were evacuated? we will fill them with sentinel
4966 bytes, except for the part holding the new offset of course. */
4969 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4971 assert(evacn <= delta + old_delta);
4977 if (delta < 0x100) {
4981 p -= sizeof(STRLEN);
4982 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4986 /* Fill the preceding buffer with sentinals to verify that no-one is
4996 =for apidoc sv_catpvn
4998 Concatenates the string onto the end of the string which is in the SV. The
4999 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5000 status set, then the bytes appended should be valid UTF-8.
5001 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5003 =for apidoc sv_catpvn_flags
5005 Concatenates the string onto the end of the string which is in the SV. The
5006 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5007 status set, then the bytes appended should be valid UTF-8.
5008 If C<flags> has the C<SV_SMAGIC> bit set, will
5009 C<mg_set> on C<dsv> afterwards if appropriate.
5010 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5011 in terms of this function.
5017 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
5021 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
5023 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
5024 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
5026 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
5027 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5028 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5031 else SvGROW(dsv, dlen + slen + 1);
5033 sstr = SvPVX_const(dsv);
5034 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5035 SvCUR_set(dsv, SvCUR(dsv) + slen);
5038 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5039 const char * const send = sstr + slen;
5042 /* Something this code does not account for, which I think is
5043 impossible; it would require the same pv to be treated as
5044 bytes *and* utf8, which would indicate a bug elsewhere. */
5045 assert(sstr != dstr);
5047 SvGROW(dsv, dlen + slen * 2 + 1);
5048 d = (U8 *)SvPVX(dsv) + dlen;
5050 while (sstr < send) {
5051 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5052 if (UNI_IS_INVARIANT(uv))
5053 *d++ = (U8)UTF_TO_NATIVE(uv);
5055 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5056 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5059 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5062 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5064 if (flags & SV_SMAGIC)
5069 =for apidoc sv_catsv
5071 Concatenates the string from SV C<ssv> onto the end of the string in
5072 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5073 not 'set' magic. See C<sv_catsv_mg>.
5075 =for apidoc sv_catsv_flags
5077 Concatenates the string from SV C<ssv> onto the end of the string in
5078 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5079 bit set, will C<mg_get> on the C<ssv>, if appropriate, before
5080 reading it. If the C<flags> contain C<SV_SMAGIC>, C<mg_set> will be
5081 called on the modified SV afterward, if appropriate. C<sv_catsv>
5082 and C<sv_catsv_nomg> are implemented in terms of this function.
5087 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5091 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5095 const char *spv = SvPV_flags_const(ssv, slen, flags);
5097 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5099 sv_catpvn_flags(dsv, spv, slen,
5100 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5103 if (flags & SV_SMAGIC)
5108 =for apidoc sv_catpv
5110 Concatenates the string onto the end of the string which is in the SV.
5111 If the SV has the UTF-8 status set, then the bytes appended should be
5112 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5117 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5120 register STRLEN len;
5124 PERL_ARGS_ASSERT_SV_CATPV;
5128 junk = SvPV_force(sv, tlen);
5130 SvGROW(sv, tlen + len + 1);
5132 ptr = SvPVX_const(sv);
5133 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5134 SvCUR_set(sv, SvCUR(sv) + len);
5135 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5140 =for apidoc sv_catpv_flags
5142 Concatenates the string onto the end of the string which is in the SV.
5143 If the SV has the UTF-8 status set, then the bytes appended should
5144 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5145 on the modified SV if appropriate.
5151 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5153 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5154 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5158 =for apidoc sv_catpv_mg
5160 Like C<sv_catpv>, but also handles 'set' magic.
5166 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5168 PERL_ARGS_ASSERT_SV_CATPV_MG;
5177 Creates a new SV. A non-zero C<len> parameter indicates the number of
5178 bytes of preallocated string space the SV should have. An extra byte for a
5179 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5180 space is allocated.) The reference count for the new SV is set to 1.
5182 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5183 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5184 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5185 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5186 modules supporting older perls.
5192 Perl_newSV(pTHX_ const STRLEN len)
5199 sv_upgrade(sv, SVt_PV);
5200 SvGROW(sv, len + 1);
5205 =for apidoc sv_magicext
5207 Adds magic to an SV, upgrading it if necessary. Applies the
5208 supplied vtable and returns a pointer to the magic added.
5210 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5211 In particular, you can add magic to SvREADONLY SVs, and add more than
5212 one instance of the same 'how'.
5214 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5215 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5216 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5217 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5219 (This is now used as a subroutine by C<sv_magic>.)
5224 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5225 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5230 PERL_ARGS_ASSERT_SV_MAGICEXT;
5232 SvUPGRADE(sv, SVt_PVMG);
5233 Newxz(mg, 1, MAGIC);
5234 mg->mg_moremagic = SvMAGIC(sv);
5235 SvMAGIC_set(sv, mg);
5237 /* Sometimes a magic contains a reference loop, where the sv and
5238 object refer to each other. To prevent a reference loop that
5239 would prevent such objects being freed, we look for such loops
5240 and if we find one we avoid incrementing the object refcount.
5242 Note we cannot do this to avoid self-tie loops as intervening RV must
5243 have its REFCNT incremented to keep it in existence.
5246 if (!obj || obj == sv ||
5247 how == PERL_MAGIC_arylen ||
5248 how == PERL_MAGIC_symtab ||
5249 (SvTYPE(obj) == SVt_PVGV &&
5250 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5251 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5252 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5257 mg->mg_obj = SvREFCNT_inc_simple(obj);
5258 mg->mg_flags |= MGf_REFCOUNTED;
5261 /* Normal self-ties simply pass a null object, and instead of
5262 using mg_obj directly, use the SvTIED_obj macro to produce a
5263 new RV as needed. For glob "self-ties", we are tieing the PVIO
5264 with an RV obj pointing to the glob containing the PVIO. In
5265 this case, to avoid a reference loop, we need to weaken the
5269 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5270 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5276 mg->mg_len = namlen;
5279 mg->mg_ptr = savepvn(name, namlen);
5280 else if (namlen == HEf_SVKEY) {
5281 /* Yes, this is casting away const. This is only for the case of
5282 HEf_SVKEY. I think we need to document this aberation of the
5283 constness of the API, rather than making name non-const, as
5284 that change propagating outwards a long way. */
5285 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5287 mg->mg_ptr = (char *) name;
5289 mg->mg_virtual = (MGVTBL *) vtable;
5293 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5298 =for apidoc sv_magic
5300 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5301 necessary, then adds a new magic item of type C<how> to the head of the
5304 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5305 handling of the C<name> and C<namlen> arguments.
5307 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5308 to add more than one instance of the same 'how'.
5314 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5315 const char *const name, const I32 namlen)
5318 const MGVTBL *vtable;
5321 unsigned int vtable_index;
5323 PERL_ARGS_ASSERT_SV_MAGIC;
5325 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5326 || ((flags = PL_magic_data[how]),
5327 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5328 > magic_vtable_max))
5329 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5331 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5332 Useful for attaching extension internal data to perl vars.
5333 Note that multiple extensions may clash if magical scalars
5334 etc holding private data from one are passed to another. */
5336 vtable = (vtable_index == magic_vtable_max)
5337 ? NULL : PL_magic_vtables + vtable_index;
5339 #ifdef PERL_OLD_COPY_ON_WRITE
5341 sv_force_normal_flags(sv, 0);
5343 if (SvREADONLY(sv)) {
5345 /* its okay to attach magic to shared strings */
5349 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5352 Perl_croak_no_modify(aTHX);
5355 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5356 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5357 /* sv_magic() refuses to add a magic of the same 'how' as an
5360 if (how == PERL_MAGIC_taint) {
5362 /* Any scalar which already had taint magic on which someone
5363 (erroneously?) did SvIOK_on() or similar will now be
5364 incorrectly sporting public "OK" flags. */
5365 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5371 /* Rest of work is done else where */
5372 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5375 case PERL_MAGIC_taint:
5378 case PERL_MAGIC_ext:
5379 case PERL_MAGIC_dbfile:
5386 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5393 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5395 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5396 for (mg = *mgp; mg; mg = *mgp) {
5397 const MGVTBL* const virt = mg->mg_virtual;
5398 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5399 *mgp = mg->mg_moremagic;
5400 if (virt && virt->svt_free)
5401 virt->svt_free(aTHX_ sv, mg);
5402 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5404 Safefree(mg->mg_ptr);
5405 else if (mg->mg_len == HEf_SVKEY)
5406 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5407 else if (mg->mg_type == PERL_MAGIC_utf8)
5408 Safefree(mg->mg_ptr);
5410 if (mg->mg_flags & MGf_REFCOUNTED)
5411 SvREFCNT_dec(mg->mg_obj);
5415 mgp = &mg->mg_moremagic;
5418 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5419 mg_magical(sv); /* else fix the flags now */
5423 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5429 =for apidoc sv_unmagic
5431 Removes all magic of type C<type> from an SV.
5437 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5439 PERL_ARGS_ASSERT_SV_UNMAGIC;
5440 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5444 =for apidoc sv_unmagicext
5446 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5452 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5454 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5455 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5459 =for apidoc sv_rvweaken
5461 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5462 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5463 push a back-reference to this RV onto the array of backreferences
5464 associated with that magic. If the RV is magical, set magic will be
5465 called after the RV is cleared.
5471 Perl_sv_rvweaken(pTHX_ SV *const sv)
5475 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5477 if (!SvOK(sv)) /* let undefs pass */
5480 Perl_croak(aTHX_ "Can't weaken a nonreference");
5481 else if (SvWEAKREF(sv)) {
5482 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5485 else if (SvREADONLY(sv)) croak_no_modify();
5487 Perl_sv_add_backref(aTHX_ tsv, sv);
5493 /* Give tsv backref magic if it hasn't already got it, then push a
5494 * back-reference to sv onto the array associated with the backref magic.
5496 * As an optimisation, if there's only one backref and it's not an AV,
5497 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5498 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5502 /* A discussion about the backreferences array and its refcount:
5504 * The AV holding the backreferences is pointed to either as the mg_obj of
5505 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5506 * xhv_backreferences field. The array is created with a refcount
5507 * of 2. This means that if during global destruction the array gets
5508 * picked on before its parent to have its refcount decremented by the
5509 * random zapper, it won't actually be freed, meaning it's still there for
5510 * when its parent gets freed.
5512 * When the parent SV is freed, the extra ref is killed by
5513 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5514 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5516 * When a single backref SV is stored directly, it is not reference
5521 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5528 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5530 /* find slot to store array or singleton backref */
5532 if (SvTYPE(tsv) == SVt_PVHV) {
5533 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5536 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5538 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5539 mg = mg_find(tsv, PERL_MAGIC_backref);
5541 svp = &(mg->mg_obj);
5544 /* create or retrieve the array */
5546 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5547 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5552 SvREFCNT_inc_simple_void(av);
5553 /* av now has a refcnt of 2; see discussion above */
5555 /* move single existing backref to the array */
5557 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5561 mg->mg_flags |= MGf_REFCOUNTED;
5564 av = MUTABLE_AV(*svp);
5567 /* optimisation: store single backref directly in HvAUX or mg_obj */
5571 /* push new backref */
5572 assert(SvTYPE(av) == SVt_PVAV);
5573 if (AvFILLp(av) >= AvMAX(av)) {
5574 av_extend(av, AvFILLp(av)+1);
5576 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5579 /* delete a back-reference to ourselves from the backref magic associated
5580 * with the SV we point to.
5584 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5589 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5591 if (SvTYPE(tsv) == SVt_PVHV) {
5593 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5595 else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5596 /* It's possible for the the last (strong) reference to tsv to have
5597 become freed *before* the last thing holding a weak reference.
5598 If both survive longer than the backreferences array, then when
5599 the referent's reference count drops to 0 and it is freed, it's
5600 not able to chase the backreferences, so they aren't NULLed.
5602 For example, a CV holds a weak reference to its stash. If both the
5603 CV and the stash survive longer than the backreferences array,
5604 and the CV gets picked for the SvBREAK() treatment first,
5605 *and* it turns out that the stash is only being kept alive because
5606 of an our variable in the pad of the CV, then midway during CV
5607 destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5608 It ends up pointing to the freed HV. Hence it's chased in here, and
5609 if this block wasn't here, it would hit the !svp panic just below.
5611 I don't believe that "better" destruction ordering is going to help
5612 here - during global destruction there's always going to be the
5613 chance that something goes out of order. We've tried to make it
5614 foolproof before, and it only resulted in evolutionary pressure on
5615 fools. Which made us look foolish for our hubris. :-(
5621 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5622 svp = mg ? &(mg->mg_obj) : NULL;
5626 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5628 /* It's possible that sv is being freed recursively part way through the
5629 freeing of tsv. If this happens, the backreferences array of tsv has
5630 already been freed, and so svp will be NULL. If this is the case,
5631 we should not panic. Instead, nothing needs doing, so return. */
5632 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5634 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5635 *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5638 if (SvTYPE(*svp) == SVt_PVAV) {
5642 AV * const av = (AV*)*svp;
5644 assert(!SvIS_FREED(av));
5648 /* for an SV with N weak references to it, if all those
5649 * weak refs are deleted, then sv_del_backref will be called
5650 * N times and O(N^2) compares will be done within the backref
5651 * array. To ameliorate this potential slowness, we:
5652 * 1) make sure this code is as tight as possible;
5653 * 2) when looking for SV, look for it at both the head and tail of the
5654 * array first before searching the rest, since some create/destroy
5655 * patterns will cause the backrefs to be freed in order.
5662 SV **p = &svp[fill];
5663 SV *const topsv = *p;
5670 /* We weren't the last entry.
5671 An unordered list has this property that you
5672 can take the last element off the end to fill
5673 the hole, and it's still an unordered list :-)
5679 break; /* should only be one */
5686 AvFILLp(av) = fill-1;
5688 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5689 /* freed AV; skip */
5692 /* optimisation: only a single backref, stored directly */
5694 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5701 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5707 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5712 /* after multiple passes through Perl_sv_clean_all() for a thinngy
5713 * that has badly leaked, the backref array may have gotten freed,
5714 * since we only protect it against 1 round of cleanup */
5715 if (SvIS_FREED(av)) {
5716 if (PL_in_clean_all) /* All is fair */
5719 "panic: magic_killbackrefs (freed backref AV/SV)");
5723 is_array = (SvTYPE(av) == SVt_PVAV);
5725 assert(!SvIS_FREED(av));
5728 last = svp + AvFILLp(av);
5731 /* optimisation: only a single backref, stored directly */
5737 while (svp <= last) {
5739 SV *const referrer = *svp;
5740 if (SvWEAKREF(referrer)) {
5741 /* XXX Should we check that it hasn't changed? */
5742 assert(SvROK(referrer));
5743 SvRV_set(referrer, 0);
5745 SvWEAKREF_off(referrer);
5746 SvSETMAGIC(referrer);
5747 } else if (SvTYPE(referrer) == SVt_PVGV ||
5748 SvTYPE(referrer) == SVt_PVLV) {
5749 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5750 /* You lookin' at me? */
5751 assert(GvSTASH(referrer));
5752 assert(GvSTASH(referrer) == (const HV *)sv);
5753 GvSTASH(referrer) = 0;
5754 } else if (SvTYPE(referrer) == SVt_PVCV ||
5755 SvTYPE(referrer) == SVt_PVFM) {
5756 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5757 /* You lookin' at me? */
5758 assert(CvSTASH(referrer));
5759 assert(CvSTASH(referrer) == (const HV *)sv);
5760 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5763 assert(SvTYPE(sv) == SVt_PVGV);
5764 /* You lookin' at me? */
5765 assert(CvGV(referrer));
5766 assert(CvGV(referrer) == (const GV *)sv);
5767 anonymise_cv_maybe(MUTABLE_GV(sv),
5768 MUTABLE_CV(referrer));
5773 "panic: magic_killbackrefs (flags=%"UVxf")",
5774 (UV)SvFLAGS(referrer));
5785 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5791 =for apidoc sv_insert
5793 Inserts a string at the specified offset/length within the SV. Similar to
5794 the Perl substr() function. Handles get magic.
5796 =for apidoc sv_insert_flags
5798 Same as C<sv_insert>, but the extra C<flags> are passed to the
5799 C<SvPV_force_flags> that applies to C<bigstr>.
5805 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5810 register char *midend;
5811 register char *bigend;
5812 register SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5815 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5818 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5819 SvPV_force_flags(bigstr, curlen, flags);
5820 (void)SvPOK_only_UTF8(bigstr);
5821 if (offset + len > curlen) {
5822 SvGROW(bigstr, offset+len+1);
5823 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5824 SvCUR_set(bigstr, offset+len);
5828 i = littlelen - len;
5829 if (i > 0) { /* string might grow */
5830 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5831 mid = big + offset + len;
5832 midend = bigend = big + SvCUR(bigstr);
5835 while (midend > mid) /* shove everything down */
5836 *--bigend = *--midend;
5837 Move(little,big+offset,littlelen,char);
5838 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5843 Move(little,SvPVX(bigstr)+offset,len,char);
5848 big = SvPVX(bigstr);
5851 bigend = big + SvCUR(bigstr);
5853 if (midend > bigend)
5854 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5857 if (mid - big > bigend - midend) { /* faster to shorten from end */
5859 Move(little, mid, littlelen,char);
5862 i = bigend - midend;
5864 Move(midend, mid, i,char);
5868 SvCUR_set(bigstr, mid - big);
5870 else if ((i = mid - big)) { /* faster from front */
5871 midend -= littlelen;
5873 Move(big, midend - i, i, char);
5874 sv_chop(bigstr,midend-i);
5876 Move(little, mid, littlelen,char);
5878 else if (littlelen) {
5879 midend -= littlelen;
5880 sv_chop(bigstr,midend);
5881 Move(little,midend,littlelen,char);
5884 sv_chop(bigstr,midend);
5890 =for apidoc sv_replace
5892 Make the first argument a copy of the second, then delete the original.
5893 The target SV physically takes over ownership of the body of the source SV
5894 and inherits its flags; however, the target keeps any magic it owns,
5895 and any magic in the source is discarded.
5896 Note that this is a rather specialist SV copying operation; most of the
5897 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5903 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5906 const U32 refcnt = SvREFCNT(sv);
5908 PERL_ARGS_ASSERT_SV_REPLACE;
5910 SV_CHECK_THINKFIRST_COW_DROP(sv);
5911 if (SvREFCNT(nsv) != 1) {
5912 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5913 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5915 if (SvMAGICAL(sv)) {
5919 sv_upgrade(nsv, SVt_PVMG);
5920 SvMAGIC_set(nsv, SvMAGIC(sv));
5921 SvFLAGS(nsv) |= SvMAGICAL(sv);
5923 SvMAGIC_set(sv, NULL);
5927 assert(!SvREFCNT(sv));
5928 #ifdef DEBUG_LEAKING_SCALARS
5929 sv->sv_flags = nsv->sv_flags;
5930 sv->sv_any = nsv->sv_any;
5931 sv->sv_refcnt = nsv->sv_refcnt;
5932 sv->sv_u = nsv->sv_u;
5934 StructCopy(nsv,sv,SV);
5936 if(SvTYPE(sv) == SVt_IV) {
5938 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5942 #ifdef PERL_OLD_COPY_ON_WRITE
5943 if (SvIsCOW_normal(nsv)) {
5944 /* We need to follow the pointers around the loop to make the
5945 previous SV point to sv, rather than nsv. */
5948 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5951 assert(SvPVX_const(current) == SvPVX_const(nsv));
5953 /* Make the SV before us point to the SV after us. */
5955 PerlIO_printf(Perl_debug_log, "previous is\n");
5957 PerlIO_printf(Perl_debug_log,
5958 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5959 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5961 SV_COW_NEXT_SV_SET(current, sv);
5964 SvREFCNT(sv) = refcnt;
5965 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5970 /* We're about to free a GV which has a CV that refers back to us.
5971 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5975 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5980 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5983 assert(SvREFCNT(gv) == 0);
5984 assert(isGV(gv) && isGV_with_GP(gv));
5986 assert(!CvANON(cv));
5987 assert(CvGV(cv) == gv);
5989 /* will the CV shortly be freed by gp_free() ? */
5990 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5991 SvANY(cv)->xcv_gv = NULL;
5995 /* if not, anonymise: */
5996 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5997 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5998 : newSVpvn_flags( "__ANON__", 8, 0 );
5999 sv_catpvs(gvname, "::__ANON__");
6000 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
6001 SvREFCNT_dec(gvname);
6005 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
6010 =for apidoc sv_clear
6012 Clear an SV: call any destructors, free up any memory used by the body,
6013 and free the body itself. The SV's head is I<not> freed, although
6014 its type is set to all 1's so that it won't inadvertently be assumed
6015 to be live during global destruction etc.
6016 This function should only be called when REFCNT is zero. Most of the time
6017 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
6024 Perl_sv_clear(pTHX_ SV *const orig_sv)
6029 const struct body_details *sv_type_details;
6032 register SV *sv = orig_sv;
6035 PERL_ARGS_ASSERT_SV_CLEAR;
6037 /* within this loop, sv is the SV currently being freed, and
6038 * iter_sv is the most recent AV or whatever that's being iterated
6039 * over to provide more SVs */
6045 assert(SvREFCNT(sv) == 0);
6046 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6048 if (type <= SVt_IV) {
6049 /* See the comment in sv.h about the collusion between this
6050 * early return and the overloading of the NULL slots in the
6054 SvFLAGS(sv) &= SVf_BREAK;
6055 SvFLAGS(sv) |= SVTYPEMASK;
6059 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6061 if (type >= SVt_PVMG) {
6063 if (!curse(sv, 1)) goto get_next_sv;
6064 type = SvTYPE(sv); /* destructor may have changed it */
6066 /* Free back-references before magic, in case the magic calls
6067 * Perl code that has weak references to sv. */
6068 if (type == SVt_PVHV) {
6069 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6073 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6074 SvREFCNT_dec(SvOURSTASH(sv));
6075 } else if (SvMAGIC(sv)) {
6076 /* Free back-references before other types of magic. */
6077 sv_unmagic(sv, PERL_MAGIC_backref);
6081 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6082 SvREFCNT_dec(SvSTASH(sv));
6085 /* case SVt_BIND: */
6088 IoIFP(sv) != PerlIO_stdin() &&
6089 IoIFP(sv) != PerlIO_stdout() &&
6090 IoIFP(sv) != PerlIO_stderr() &&
6091 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6093 io_close(MUTABLE_IO(sv), FALSE);
6095 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6096 PerlDir_close(IoDIRP(sv));
6097 IoDIRP(sv) = (DIR*)NULL;
6098 Safefree(IoTOP_NAME(sv));
6099 Safefree(IoFMT_NAME(sv));
6100 Safefree(IoBOTTOM_NAME(sv));
6101 if ((const GV *)sv == PL_statgv)
6105 /* FIXME for plugins */
6106 pregfree2((REGEXP*) sv);
6110 cv_undef(MUTABLE_CV(sv));
6111 /* If we're in a stash, we don't own a reference to it.
6112 * However it does have a back reference to us, which needs to
6114 if ((stash = CvSTASH(sv)))
6115 sv_del_backref(MUTABLE_SV(stash), sv);
6118 if (PL_last_swash_hv == (const HV *)sv) {
6119 PL_last_swash_hv = NULL;
6121 if (HvTOTALKEYS((HV*)sv) > 0) {
6123 /* this statement should match the one at the beginning of
6124 * hv_undef_flags() */
6125 if ( PL_phase != PERL_PHASE_DESTRUCT
6126 && (name = HvNAME((HV*)sv)))
6129 (void)hv_delete(PL_stashcache, name,
6130 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6131 hv_name_set((HV*)sv, NULL, 0, 0);
6134 /* save old iter_sv in unused SvSTASH field */
6135 assert(!SvOBJECT(sv));
6136 SvSTASH(sv) = (HV*)iter_sv;
6139 /* save old hash_index in unused SvMAGIC field */
6140 assert(!SvMAGICAL(sv));
6141 assert(!SvMAGIC(sv));
6142 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6145 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6146 goto get_next_sv; /* process this new sv */
6148 /* free empty hash */
6149 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6150 assert(!HvARRAY((HV*)sv));
6154 AV* av = MUTABLE_AV(sv);
6155 if (PL_comppad == av) {
6159 if (AvREAL(av) && AvFILLp(av) > -1) {
6160 next_sv = AvARRAY(av)[AvFILLp(av)--];
6161 /* save old iter_sv in top-most slot of AV,
6162 * and pray that it doesn't get wiped in the meantime */
6163 AvARRAY(av)[AvMAX(av)] = iter_sv;
6165 goto get_next_sv; /* process this new sv */
6167 Safefree(AvALLOC(av));
6172 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6173 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6174 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6175 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6177 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6178 SvREFCNT_dec(LvTARG(sv));
6180 if (isGV_with_GP(sv)) {
6181 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6182 && HvENAME_get(stash))
6183 mro_method_changed_in(stash);
6184 gp_free(MUTABLE_GV(sv));
6186 unshare_hek(GvNAME_HEK(sv));
6187 /* If we're in a stash, we don't own a reference to it.
6188 * However it does have a back reference to us, which
6189 * needs to be cleared. */
6190 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6191 sv_del_backref(MUTABLE_SV(stash), sv);
6193 /* FIXME. There are probably more unreferenced pointers to SVs
6194 * in the interpreter struct that we should check and tidy in
6195 * a similar fashion to this: */
6196 /* See also S_sv_unglob, which does the same thing. */
6197 if ((const GV *)sv == PL_last_in_gv)
6198 PL_last_in_gv = NULL;
6199 else if ((const GV *)sv == PL_statgv)
6206 /* Don't bother with SvOOK_off(sv); as we're only going to
6210 SvOOK_offset(sv, offset);
6211 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6212 /* Don't even bother with turning off the OOK flag. */
6217 SV * const target = SvRV(sv);
6219 sv_del_backref(target, sv);
6224 #ifdef PERL_OLD_COPY_ON_WRITE
6225 else if (SvPVX_const(sv)
6226 && !(SvTYPE(sv) == SVt_PVIO
6227 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6231 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6235 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6237 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6241 } else if (SvLEN(sv)) {
6242 Safefree(SvPVX_const(sv));
6246 else if (SvPVX_const(sv) && SvLEN(sv)
6247 && !(SvTYPE(sv) == SVt_PVIO
6248 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6249 Safefree(SvPVX_mutable(sv));
6250 else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6251 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6262 SvFLAGS(sv) &= SVf_BREAK;
6263 SvFLAGS(sv) |= SVTYPEMASK;
6265 sv_type_details = bodies_by_type + type;
6266 if (sv_type_details->arena) {
6267 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6268 &PL_body_roots[type]);
6270 else if (sv_type_details->body_size) {
6271 safefree(SvANY(sv));
6275 /* caller is responsible for freeing the head of the original sv */
6276 if (sv != orig_sv && !SvREFCNT(sv))
6279 /* grab and free next sv, if any */
6287 else if (!iter_sv) {
6289 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6290 AV *const av = (AV*)iter_sv;
6291 if (AvFILLp(av) > -1) {
6292 sv = AvARRAY(av)[AvFILLp(av)--];
6294 else { /* no more elements of current AV to free */
6297 /* restore previous value, squirrelled away */
6298 iter_sv = AvARRAY(av)[AvMAX(av)];
6299 Safefree(AvALLOC(av));
6302 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6303 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6304 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6305 /* no more elements of current HV to free */
6308 /* Restore previous values of iter_sv and hash_index,
6309 * squirrelled away */
6310 assert(!SvOBJECT(sv));
6311 iter_sv = (SV*)SvSTASH(sv);
6312 assert(!SvMAGICAL(sv));
6313 hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6315 /* free any remaining detritus from the hash struct */
6316 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6317 assert(!HvARRAY((HV*)sv));
6322 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6326 if (!SvREFCNT(sv)) {
6330 if (--(SvREFCNT(sv)))
6334 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6335 "Attempt to free temp prematurely: SV 0x%"UVxf
6336 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6340 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6341 /* make sure SvREFCNT(sv)==0 happens very seldom */
6342 SvREFCNT(sv) = (~(U32)0)/2;
6351 /* This routine curses the sv itself, not the object referenced by sv. So
6352 sv does not have to be ROK. */
6355 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6358 PERL_ARGS_ASSERT_CURSE;
6359 assert(SvOBJECT(sv));
6361 if (PL_defstash && /* Still have a symbol table? */
6368 stash = SvSTASH(sv);
6369 destructor = StashHANDLER(stash,DESTROY);
6371 /* A constant subroutine can have no side effects, so
6372 don't bother calling it. */
6373 && !CvCONST(destructor)
6374 /* Don't bother calling an empty destructor or one that
6375 returns immediately. */
6376 && (CvISXSUB(destructor)
6377 || (CvSTART(destructor)
6378 && (CvSTART(destructor)->op_next->op_type
6380 && (CvSTART(destructor)->op_next->op_type
6382 || CvSTART(destructor)->op_next->op_next->op_type
6388 SV* const tmpref = newRV(sv);
6389 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6391 PUSHSTACKi(PERLSI_DESTROY);
6396 call_sv(MUTABLE_SV(destructor),
6397 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6401 if(SvREFCNT(tmpref) < 2) {
6402 /* tmpref is not kept alive! */
6404 SvRV_set(tmpref, NULL);
6407 SvREFCNT_dec(tmpref);
6409 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6412 if (check_refcnt && SvREFCNT(sv)) {
6413 if (PL_in_clean_objs)
6415 "DESTROY created new reference to dead object '%"HEKf"'",
6416 HEKfARG(HvNAME_HEK(stash)));
6417 /* DESTROY gave object new lease on life */
6423 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6424 SvOBJECT_off(sv); /* Curse the object. */
6425 if (SvTYPE(sv) != SVt_PVIO)
6426 --PL_sv_objcount;/* XXX Might want something more general */
6432 =for apidoc sv_newref
6434 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6441 Perl_sv_newref(pTHX_ SV *const sv)
6443 PERL_UNUSED_CONTEXT;
6452 Decrement an SV's reference count, and if it drops to zero, call
6453 C<sv_clear> to invoke destructors and free up any memory used by
6454 the body; finally, deallocate the SV's head itself.
6455 Normally called via a wrapper macro C<SvREFCNT_dec>.
6461 Perl_sv_free(pTHX_ SV *const sv)
6466 if (SvREFCNT(sv) == 0) {
6467 if (SvFLAGS(sv) & SVf_BREAK)
6468 /* this SV's refcnt has been artificially decremented to
6469 * trigger cleanup */
6471 if (PL_in_clean_all) /* All is fair */
6473 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6474 /* make sure SvREFCNT(sv)==0 happens very seldom */
6475 SvREFCNT(sv) = (~(U32)0)/2;
6478 if (ckWARN_d(WARN_INTERNAL)) {
6479 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6480 Perl_dump_sv_child(aTHX_ sv);
6482 #ifdef DEBUG_LEAKING_SCALARS
6485 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6486 if (PL_warnhook == PERL_WARNHOOK_FATAL
6487 || ckDEAD(packWARN(WARN_INTERNAL))) {
6488 /* Don't let Perl_warner cause us to escape our fate: */
6492 /* This may not return: */
6493 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6494 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6495 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6498 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6503 if (--(SvREFCNT(sv)) > 0)
6505 Perl_sv_free2(aTHX_ sv);
6509 Perl_sv_free2(pTHX_ SV *const sv)
6513 PERL_ARGS_ASSERT_SV_FREE2;
6517 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6518 "Attempt to free temp prematurely: SV 0x%"UVxf
6519 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6523 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6524 /* make sure SvREFCNT(sv)==0 happens very seldom */
6525 SvREFCNT(sv) = (~(U32)0)/2;
6536 Returns the length of the string in the SV. Handles magic and type
6537 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6543 Perl_sv_len(pTHX_ register SV *const sv)
6551 len = mg_length(sv);
6553 (void)SvPV_const(sv, len);
6558 =for apidoc sv_len_utf8
6560 Returns the number of characters in the string in an SV, counting wide
6561 UTF-8 bytes as a single character. Handles magic and type coercion.
6567 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6568 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6569 * (Note that the mg_len is not the length of the mg_ptr field.
6570 * This allows the cache to store the character length of the string without
6571 * needing to malloc() extra storage to attach to the mg_ptr.)
6576 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6582 return mg_length(sv);
6586 const U8 *s = (U8*)SvPV_const(sv, len);
6590 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6592 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6593 if (mg->mg_len != -1)
6596 /* We can use the offset cache for a headstart.
6597 The longer value is stored in the first pair. */
6598 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6600 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6604 if (PL_utf8cache < 0) {
6605 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6606 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6610 ulen = Perl_utf8_length(aTHX_ s, s + len);
6611 utf8_mg_len_cache_update(sv, &mg, ulen);
6615 return Perl_utf8_length(aTHX_ s, s + len);
6619 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6622 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6623 STRLEN *const uoffset_p, bool *const at_end)
6625 const U8 *s = start;
6626 STRLEN uoffset = *uoffset_p;
6628 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6630 while (s < send && uoffset) {
6637 else if (s > send) {
6639 /* This is the existing behaviour. Possibly it should be a croak, as
6640 it's actually a bounds error */
6643 *uoffset_p -= uoffset;
6647 /* Given the length of the string in both bytes and UTF-8 characters, decide
6648 whether to walk forwards or backwards to find the byte corresponding to
6649 the passed in UTF-8 offset. */
6651 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6652 STRLEN uoffset, const STRLEN uend)
6654 STRLEN backw = uend - uoffset;
6656 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6658 if (uoffset < 2 * backw) {
6659 /* The assumption is that going forwards is twice the speed of going
6660 forward (that's where the 2 * backw comes from).
6661 (The real figure of course depends on the UTF-8 data.) */
6662 const U8 *s = start;
6664 while (s < send && uoffset--)
6674 while (UTF8_IS_CONTINUATION(*send))
6677 return send - start;
6680 /* For the string representation of the given scalar, find the byte
6681 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6682 give another position in the string, *before* the sought offset, which
6683 (which is always true, as 0, 0 is a valid pair of positions), which should
6684 help reduce the amount of linear searching.
6685 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6686 will be used to reduce the amount of linear searching. The cache will be
6687 created if necessary, and the found value offered to it for update. */
6689 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6690 const U8 *const send, STRLEN uoffset,
6691 STRLEN uoffset0, STRLEN boffset0)
6693 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6695 bool at_end = FALSE;
6697 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6699 assert (uoffset >= uoffset0);
6706 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6707 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6708 if ((*mgp)->mg_ptr) {
6709 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6710 if (cache[0] == uoffset) {
6711 /* An exact match. */
6714 if (cache[2] == uoffset) {
6715 /* An exact match. */
6719 if (cache[0] < uoffset) {
6720 /* The cache already knows part of the way. */
6721 if (cache[0] > uoffset0) {
6722 /* The cache knows more than the passed in pair */
6723 uoffset0 = cache[0];
6724 boffset0 = cache[1];
6726 if ((*mgp)->mg_len != -1) {
6727 /* And we know the end too. */
6729 + sv_pos_u2b_midway(start + boffset0, send,
6731 (*mgp)->mg_len - uoffset0);
6733 uoffset -= uoffset0;
6735 + sv_pos_u2b_forwards(start + boffset0,
6736 send, &uoffset, &at_end);
6737 uoffset += uoffset0;
6740 else if (cache[2] < uoffset) {
6741 /* We're between the two cache entries. */
6742 if (cache[2] > uoffset0) {
6743 /* and the cache knows more than the passed in pair */
6744 uoffset0 = cache[2];
6745 boffset0 = cache[3];
6749 + sv_pos_u2b_midway(start + boffset0,
6752 cache[0] - uoffset0);
6755 + sv_pos_u2b_midway(start + boffset0,
6758 cache[2] - uoffset0);
6762 else if ((*mgp)->mg_len != -1) {
6763 /* If we can take advantage of a passed in offset, do so. */
6764 /* In fact, offset0 is either 0, or less than offset, so don't
6765 need to worry about the other possibility. */
6767 + sv_pos_u2b_midway(start + boffset0, send,
6769 (*mgp)->mg_len - uoffset0);
6774 if (!found || PL_utf8cache < 0) {
6775 STRLEN real_boffset;
6776 uoffset -= uoffset0;
6777 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6778 send, &uoffset, &at_end);
6779 uoffset += uoffset0;
6781 if (found && PL_utf8cache < 0)
6782 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6784 boffset = real_boffset;
6789 utf8_mg_len_cache_update(sv, mgp, uoffset);
6791 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6798 =for apidoc sv_pos_u2b_flags
6800 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6801 the start of the string, to a count of the equivalent number of bytes; if
6802 lenp is non-zero, it does the same to lenp, but this time starting from
6803 the offset, rather than from the start
6804 of the string. Handles type coercion.
6805 I<flags> is passed to C<SvPV_flags>, and usually should be
6806 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6812 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6813 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6814 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6819 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6826 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6828 start = (U8*)SvPV_flags(sv, len, flags);
6830 const U8 * const send = start + len;
6832 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6835 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6836 is 0, and *lenp is already set to that. */) {
6837 /* Convert the relative offset to absolute. */
6838 const STRLEN uoffset2 = uoffset + *lenp;
6839 const STRLEN boffset2
6840 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6841 uoffset, boffset) - boffset;
6855 =for apidoc sv_pos_u2b
6857 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6858 the start of the string, to a count of the equivalent number of bytes; if
6859 lenp is non-zero, it does the same to lenp, but this time starting from
6860 the offset, rather than from the start of the string. Handles magic and
6863 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6870 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6871 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6872 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6876 /* This function is subject to size and sign problems */
6879 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6881 PERL_ARGS_ASSERT_SV_POS_U2B;
6884 STRLEN ulen = (STRLEN)*lenp;
6885 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6886 SV_GMAGIC|SV_CONST_RETURN);
6889 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6890 SV_GMAGIC|SV_CONST_RETURN);
6895 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6898 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6902 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6903 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6904 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6908 (*mgp)->mg_len = ulen;
6909 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6910 if (ulen != (STRLEN) (*mgp)->mg_len)
6911 (*mgp)->mg_len = -1;
6914 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6915 byte length pairing. The (byte) length of the total SV is passed in too,
6916 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6917 may not have updated SvCUR, so we can't rely on reading it directly.
6919 The proffered utf8/byte length pairing isn't used if the cache already has
6920 two pairs, and swapping either for the proffered pair would increase the
6921 RMS of the intervals between known byte offsets.
6923 The cache itself consists of 4 STRLEN values
6924 0: larger UTF-8 offset
6925 1: corresponding byte offset
6926 2: smaller UTF-8 offset
6927 3: corresponding byte offset
6929 Unused cache pairs have the value 0, 0.
6930 Keeping the cache "backwards" means that the invariant of
6931 cache[0] >= cache[2] is maintained even with empty slots, which means that
6932 the code that uses it doesn't need to worry if only 1 entry has actually
6933 been set to non-zero. It also makes the "position beyond the end of the
6934 cache" logic much simpler, as the first slot is always the one to start
6938 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6939 const STRLEN utf8, const STRLEN blen)
6943 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6948 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6949 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6950 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6952 (*mgp)->mg_len = -1;
6956 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6957 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6958 (*mgp)->mg_ptr = (char *) cache;
6962 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6963 /* SvPOKp() because it's possible that sv has string overloading, and
6964 therefore is a reference, hence SvPVX() is actually a pointer.
6965 This cures the (very real) symptoms of RT 69422, but I'm not actually
6966 sure whether we should even be caching the results of UTF-8
6967 operations on overloading, given that nothing stops overloading
6968 returning a different value every time it's called. */
6969 const U8 *start = (const U8 *) SvPVX_const(sv);
6970 const STRLEN realutf8 = utf8_length(start, start + byte);
6972 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6976 /* Cache is held with the later position first, to simplify the code
6977 that deals with unbounded ends. */
6979 ASSERT_UTF8_CACHE(cache);
6980 if (cache[1] == 0) {
6981 /* Cache is totally empty */
6984 } else if (cache[3] == 0) {
6985 if (byte > cache[1]) {
6986 /* New one is larger, so goes first. */
6987 cache[2] = cache[0];
6988 cache[3] = cache[1];
6996 #define THREEWAY_SQUARE(a,b,c,d) \
6997 ((float)((d) - (c))) * ((float)((d) - (c))) \
6998 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6999 + ((float)((b) - (a))) * ((float)((b) - (a)))
7001 /* Cache has 2 slots in use, and we know three potential pairs.
7002 Keep the two that give the lowest RMS distance. Do the
7003 calculation in bytes simply because we always know the byte
7004 length. squareroot has the same ordering as the positive value,
7005 so don't bother with the actual square root. */
7006 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
7007 if (byte > cache[1]) {
7008 /* New position is after the existing pair of pairs. */
7009 const float keep_earlier
7010 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7011 const float keep_later
7012 = THREEWAY_SQUARE(0, cache[1], byte, blen);
7014 if (keep_later < keep_earlier) {
7015 if (keep_later < existing) {
7016 cache[2] = cache[0];
7017 cache[3] = cache[1];
7023 if (keep_earlier < existing) {
7029 else if (byte > cache[3]) {
7030 /* New position is between the existing pair of pairs. */
7031 const float keep_earlier
7032 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7033 const float keep_later
7034 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7036 if (keep_later < keep_earlier) {
7037 if (keep_later < existing) {
7043 if (keep_earlier < existing) {
7050 /* New position is before the existing pair of pairs. */
7051 const float keep_earlier
7052 = THREEWAY_SQUARE(0, byte, cache[3], blen);
7053 const float keep_later
7054 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7056 if (keep_later < keep_earlier) {
7057 if (keep_later < existing) {
7063 if (keep_earlier < existing) {
7064 cache[0] = cache[2];
7065 cache[1] = cache[3];
7072 ASSERT_UTF8_CACHE(cache);
7075 /* We already know all of the way, now we may be able to walk back. The same
7076 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7077 backward is half the speed of walking forward. */
7079 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7080 const U8 *end, STRLEN endu)
7082 const STRLEN forw = target - s;
7083 STRLEN backw = end - target;
7085 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7087 if (forw < 2 * backw) {
7088 return utf8_length(s, target);
7091 while (end > target) {
7093 while (UTF8_IS_CONTINUATION(*end)) {
7102 =for apidoc sv_pos_b2u
7104 Converts the value pointed to by offsetp from a count of bytes from the
7105 start of the string, to a count of the equivalent number of UTF-8 chars.
7106 Handles magic and type coercion.
7112 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7113 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7118 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7121 const STRLEN byte = *offsetp;
7122 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7128 PERL_ARGS_ASSERT_SV_POS_B2U;
7133 s = (const U8*)SvPV_const(sv, blen);
7136 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7137 ", byte=%"UVuf, (UV)blen, (UV)byte);
7143 && SvTYPE(sv) >= SVt_PVMG
7144 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7147 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7148 if (cache[1] == byte) {
7149 /* An exact match. */
7150 *offsetp = cache[0];
7153 if (cache[3] == byte) {
7154 /* An exact match. */
7155 *offsetp = cache[2];
7159 if (cache[1] < byte) {
7160 /* We already know part of the way. */
7161 if (mg->mg_len != -1) {
7162 /* Actually, we know the end too. */
7164 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7165 s + blen, mg->mg_len - cache[0]);
7167 len = cache[0] + utf8_length(s + cache[1], send);
7170 else if (cache[3] < byte) {
7171 /* We're between the two cached pairs, so we do the calculation
7172 offset by the byte/utf-8 positions for the earlier pair,
7173 then add the utf-8 characters from the string start to
7175 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7176 s + cache[1], cache[0] - cache[2])
7180 else { /* cache[3] > byte */
7181 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7185 ASSERT_UTF8_CACHE(cache);
7187 } else if (mg->mg_len != -1) {
7188 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7192 if (!found || PL_utf8cache < 0) {
7193 const STRLEN real_len = utf8_length(s, send);
7195 if (found && PL_utf8cache < 0)
7196 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7203 utf8_mg_len_cache_update(sv, &mg, len);
7205 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7210 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7211 STRLEN real, SV *const sv)
7213 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7215 /* As this is debugging only code, save space by keeping this test here,
7216 rather than inlining it in all the callers. */
7217 if (from_cache == real)
7220 /* Need to turn the assertions off otherwise we may recurse infinitely
7221 while printing error messages. */
7222 SAVEI8(PL_utf8cache);
7224 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7225 func, (UV) from_cache, (UV) real, SVfARG(sv));
7231 Returns a boolean indicating whether the strings in the two SVs are
7232 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7233 coerce its args to strings if necessary.
7235 =for apidoc sv_eq_flags
7237 Returns a boolean indicating whether the strings in the two SVs are
7238 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7239 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7245 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7253 SV* svrecode = NULL;
7260 /* if pv1 and pv2 are the same, second SvPV_const call may
7261 * invalidate pv1 (if we are handling magic), so we may need to
7263 if (sv1 == sv2 && flags & SV_GMAGIC
7264 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7265 pv1 = SvPV_const(sv1, cur1);
7266 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7268 pv1 = SvPV_flags_const(sv1, cur1, flags);
7276 pv2 = SvPV_flags_const(sv2, cur2, flags);
7278 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7279 /* Differing utf8ness.
7280 * Do not UTF8size the comparands as a side-effect. */
7283 svrecode = newSVpvn(pv2, cur2);
7284 sv_recode_to_utf8(svrecode, PL_encoding);
7285 pv2 = SvPV_const(svrecode, cur2);
7288 svrecode = newSVpvn(pv1, cur1);
7289 sv_recode_to_utf8(svrecode, PL_encoding);
7290 pv1 = SvPV_const(svrecode, cur1);
7292 /* Now both are in UTF-8. */
7294 SvREFCNT_dec(svrecode);
7300 /* sv1 is the UTF-8 one */
7301 return bytes_cmp_utf8((const U8*)pv2, cur2,
7302 (const U8*)pv1, cur1) == 0;
7305 /* sv2 is the UTF-8 one */
7306 return bytes_cmp_utf8((const U8*)pv1, cur1,
7307 (const U8*)pv2, cur2) == 0;
7313 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7315 SvREFCNT_dec(svrecode);
7323 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7324 string in C<sv1> is less than, equal to, or greater than the string in
7325 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7326 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7328 =for apidoc sv_cmp_flags
7330 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7331 string in C<sv1> is less than, equal to, or greater than the string in
7332 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7333 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7334 also C<sv_cmp_locale_flags>.
7340 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7342 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7346 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7351 const char *pv1, *pv2;
7354 SV *svrecode = NULL;
7361 pv1 = SvPV_flags_const(sv1, cur1, flags);
7368 pv2 = SvPV_flags_const(sv2, cur2, flags);
7370 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7371 /* Differing utf8ness.
7372 * Do not UTF8size the comparands as a side-effect. */
7375 svrecode = newSVpvn(pv2, cur2);
7376 sv_recode_to_utf8(svrecode, PL_encoding);
7377 pv2 = SvPV_const(svrecode, cur2);
7380 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7381 (const U8*)pv1, cur1);
7382 return retval ? retval < 0 ? -1 : +1 : 0;
7387 svrecode = newSVpvn(pv1, cur1);
7388 sv_recode_to_utf8(svrecode, PL_encoding);
7389 pv1 = SvPV_const(svrecode, cur1);
7392 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7393 (const U8*)pv2, cur2);
7394 return retval ? retval < 0 ? -1 : +1 : 0;
7400 cmp = cur2 ? -1 : 0;
7404 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7407 cmp = retval < 0 ? -1 : 1;
7408 } else if (cur1 == cur2) {
7411 cmp = cur1 < cur2 ? -1 : 1;
7415 SvREFCNT_dec(svrecode);
7423 =for apidoc sv_cmp_locale
7425 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7426 'use bytes' aware, handles get magic, and will coerce its args to strings
7427 if necessary. See also C<sv_cmp>.
7429 =for apidoc sv_cmp_locale_flags
7431 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7432 'use bytes' aware and will coerce its args to strings if necessary. If the
7433 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7439 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7441 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7445 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7449 #ifdef USE_LOCALE_COLLATE
7455 if (PL_collation_standard)
7459 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7461 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7463 if (!pv1 || !len1) {
7474 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7477 return retval < 0 ? -1 : 1;
7480 * When the result of collation is equality, that doesn't mean
7481 * that there are no differences -- some locales exclude some
7482 * characters from consideration. So to avoid false equalities,
7483 * we use the raw string as a tiebreaker.
7489 #endif /* USE_LOCALE_COLLATE */
7491 return sv_cmp(sv1, sv2);
7495 #ifdef USE_LOCALE_COLLATE
7498 =for apidoc sv_collxfrm
7500 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7501 C<sv_collxfrm_flags>.
7503 =for apidoc sv_collxfrm_flags
7505 Add Collate Transform magic to an SV if it doesn't already have it. If the
7506 flags contain SV_GMAGIC, it handles get-magic.
7508 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7509 scalar data of the variable, but transformed to such a format that a normal
7510 memory comparison can be used to compare the data according to the locale
7517 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7522 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7524 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7525 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7531 Safefree(mg->mg_ptr);
7532 s = SvPV_flags_const(sv, len, flags);
7533 if ((xf = mem_collxfrm(s, len, &xlen))) {
7535 #ifdef PERL_OLD_COPY_ON_WRITE
7537 sv_force_normal_flags(sv, 0);
7539 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7553 if (mg && mg->mg_ptr) {
7555 return mg->mg_ptr + sizeof(PL_collation_ix);
7563 #endif /* USE_LOCALE_COLLATE */
7566 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7568 SV * const tsv = newSV(0);
7571 sv_gets(tsv, fp, 0);
7572 sv_utf8_upgrade_nomg(tsv);
7573 SvCUR_set(sv,append);
7576 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7580 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7583 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7584 /* Grab the size of the record we're getting */
7585 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7592 /* VMS wants read instead of fread, because fread doesn't respect */
7593 /* RMS record boundaries. This is not necessarily a good thing to be */
7594 /* doing, but we've got no other real choice - except avoid stdio
7595 as implementation - perhaps write a :vms layer ?
7597 fd = PerlIO_fileno(fp);
7599 bytesread = PerlLIO_read(fd, buffer, recsize);
7601 else /* in-memory file from PerlIO::Scalar */
7604 bytesread = PerlIO_read(fp, buffer, recsize);
7609 SvCUR_set(sv, bytesread + append);
7610 buffer[bytesread] = '\0';
7611 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7617 Get a line from the filehandle and store it into the SV, optionally
7618 appending to the currently-stored string.
7624 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7629 register STDCHAR rslast;
7630 register STDCHAR *bp;
7635 PERL_ARGS_ASSERT_SV_GETS;
7637 if (SvTHINKFIRST(sv))
7638 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7639 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7641 However, perlbench says it's slower, because the existing swipe code
7642 is faster than copy on write.
7643 Swings and roundabouts. */
7644 SvUPGRADE(sv, SVt_PV);
7647 if (PerlIO_isutf8(fp)) {
7649 sv_utf8_upgrade_nomg(sv);
7650 sv_pos_u2b(sv,&append,0);
7652 } else if (SvUTF8(sv)) {
7653 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7661 if (PerlIO_isutf8(fp))
7664 if (IN_PERL_COMPILETIME) {
7665 /* we always read code in line mode */
7669 else if (RsSNARF(PL_rs)) {
7670 /* If it is a regular disk file use size from stat() as estimate
7671 of amount we are going to read -- may result in mallocing
7672 more memory than we really need if the layers below reduce
7673 the size we read (e.g. CRLF or a gzip layer).
7676 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7677 const Off_t offset = PerlIO_tell(fp);
7678 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7679 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7685 else if (RsRECORD(PL_rs)) {
7686 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7688 else if (RsPARA(PL_rs)) {
7694 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7695 if (PerlIO_isutf8(fp)) {
7696 rsptr = SvPVutf8(PL_rs, rslen);
7699 if (SvUTF8(PL_rs)) {
7700 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7701 Perl_croak(aTHX_ "Wide character in $/");
7704 rsptr = SvPV_const(PL_rs, rslen);
7708 rslast = rslen ? rsptr[rslen - 1] : '\0';
7710 if (rspara) { /* have to do this both before and after */
7711 do { /* to make sure file boundaries work right */
7714 i = PerlIO_getc(fp);
7718 PerlIO_ungetc(fp,i);
7724 /* See if we know enough about I/O mechanism to cheat it ! */
7726 /* This used to be #ifdef test - it is made run-time test for ease
7727 of abstracting out stdio interface. One call should be cheap
7728 enough here - and may even be a macro allowing compile
7732 if (PerlIO_fast_gets(fp)) {
7735 * We're going to steal some values from the stdio struct
7736 * and put EVERYTHING in the innermost loop into registers.
7738 register STDCHAR *ptr;
7742 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7743 /* An ungetc()d char is handled separately from the regular
7744 * buffer, so we getc() it back out and stuff it in the buffer.
7746 i = PerlIO_getc(fp);
7747 if (i == EOF) return 0;
7748 *(--((*fp)->_ptr)) = (unsigned char) i;
7752 /* Here is some breathtakingly efficient cheating */
7754 cnt = PerlIO_get_cnt(fp); /* get count into register */
7755 /* make sure we have the room */
7756 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7757 /* Not room for all of it
7758 if we are looking for a separator and room for some
7760 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7761 /* just process what we have room for */
7762 shortbuffered = cnt - SvLEN(sv) + append + 1;
7763 cnt -= shortbuffered;
7767 /* remember that cnt can be negative */
7768 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7773 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7774 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7775 DEBUG_P(PerlIO_printf(Perl_debug_log,
7776 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7777 DEBUG_P(PerlIO_printf(Perl_debug_log,
7778 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7779 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7780 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7785 while (cnt > 0) { /* this | eat */
7787 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7788 goto thats_all_folks; /* screams | sed :-) */
7792 Copy(ptr, bp, cnt, char); /* this | eat */
7793 bp += cnt; /* screams | dust */
7794 ptr += cnt; /* louder | sed :-) */
7796 assert (!shortbuffered);
7797 goto cannot_be_shortbuffered;
7801 if (shortbuffered) { /* oh well, must extend */
7802 cnt = shortbuffered;
7804 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7806 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7807 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7811 cannot_be_shortbuffered:
7812 DEBUG_P(PerlIO_printf(Perl_debug_log,
7813 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7814 PTR2UV(ptr),(long)cnt));
7815 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7817 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7818 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7819 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7820 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7822 /* This used to call 'filbuf' in stdio form, but as that behaves like
7823 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7824 another abstraction. */
7825 i = PerlIO_getc(fp); /* get more characters */
7827 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7828 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7829 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7830 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7832 cnt = PerlIO_get_cnt(fp);
7833 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7834 DEBUG_P(PerlIO_printf(Perl_debug_log,
7835 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7837 if (i == EOF) /* all done for ever? */
7838 goto thats_really_all_folks;
7840 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7842 SvGROW(sv, bpx + cnt + 2);
7843 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7845 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7847 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7848 goto thats_all_folks;
7852 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7853 memNE((char*)bp - rslen, rsptr, rslen))
7854 goto screamer; /* go back to the fray */
7855 thats_really_all_folks:
7857 cnt += shortbuffered;
7858 DEBUG_P(PerlIO_printf(Perl_debug_log,
7859 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7860 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7861 DEBUG_P(PerlIO_printf(Perl_debug_log,
7862 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7863 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7864 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7866 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7867 DEBUG_P(PerlIO_printf(Perl_debug_log,
7868 "Screamer: done, len=%ld, string=|%.*s|\n",
7869 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7873 /*The big, slow, and stupid way. */
7874 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7875 STDCHAR *buf = NULL;
7876 Newx(buf, 8192, STDCHAR);
7884 register const STDCHAR * const bpe = buf + sizeof(buf);
7886 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7887 ; /* keep reading */
7891 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7892 /* Accommodate broken VAXC compiler, which applies U8 cast to
7893 * both args of ?: operator, causing EOF to change into 255
7896 i = (U8)buf[cnt - 1];
7902 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7904 sv_catpvn(sv, (char *) buf, cnt);
7906 sv_setpvn(sv, (char *) buf, cnt);
7908 if (i != EOF && /* joy */
7910 SvCUR(sv) < rslen ||
7911 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7915 * If we're reading from a TTY and we get a short read,
7916 * indicating that the user hit his EOF character, we need
7917 * to notice it now, because if we try to read from the TTY
7918 * again, the EOF condition will disappear.
7920 * The comparison of cnt to sizeof(buf) is an optimization
7921 * that prevents unnecessary calls to feof().
7925 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7929 #ifdef USE_HEAP_INSTEAD_OF_STACK
7934 if (rspara) { /* have to do this both before and after */
7935 while (i != EOF) { /* to make sure file boundaries work right */
7936 i = PerlIO_getc(fp);
7938 PerlIO_ungetc(fp,i);
7944 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7950 Auto-increment of the value in the SV, doing string to numeric conversion
7951 if necessary. Handles 'get' magic and operator overloading.
7957 Perl_sv_inc(pTHX_ register SV *const sv)
7966 =for apidoc sv_inc_nomg
7968 Auto-increment of the value in the SV, doing string to numeric conversion
7969 if necessary. Handles operator overloading. Skips handling 'get' magic.
7975 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7983 if (SvTHINKFIRST(sv)) {
7984 if (SvIsCOW(sv) || isGV_with_GP(sv))
7985 sv_force_normal_flags(sv, 0);
7986 if (SvREADONLY(sv)) {
7987 if (IN_PERL_RUNTIME)
7988 Perl_croak_no_modify(aTHX);
7992 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7994 i = PTR2IV(SvRV(sv));
7999 flags = SvFLAGS(sv);
8000 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
8001 /* It's (privately or publicly) a float, but not tested as an
8002 integer, so test it to see. */
8004 flags = SvFLAGS(sv);
8006 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8007 /* It's publicly an integer, or privately an integer-not-float */
8008 #ifdef PERL_PRESERVE_IVUV
8012 if (SvUVX(sv) == UV_MAX)
8013 sv_setnv(sv, UV_MAX_P1);
8015 (void)SvIOK_only_UV(sv);
8016 SvUV_set(sv, SvUVX(sv) + 1);
8018 if (SvIVX(sv) == IV_MAX)
8019 sv_setuv(sv, (UV)IV_MAX + 1);
8021 (void)SvIOK_only(sv);
8022 SvIV_set(sv, SvIVX(sv) + 1);
8027 if (flags & SVp_NOK) {
8028 const NV was = SvNVX(sv);
8029 if (NV_OVERFLOWS_INTEGERS_AT &&
8030 was >= NV_OVERFLOWS_INTEGERS_AT) {
8031 /* diag_listed_as: Lost precision when %s %f by 1 */
8032 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8033 "Lost precision when incrementing %" NVff " by 1",
8036 (void)SvNOK_only(sv);
8037 SvNV_set(sv, was + 1.0);
8041 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
8042 if ((flags & SVTYPEMASK) < SVt_PVIV)
8043 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
8044 (void)SvIOK_only(sv);
8049 while (isALPHA(*d)) d++;
8050 while (isDIGIT(*d)) d++;
8051 if (d < SvEND(sv)) {
8052 #ifdef PERL_PRESERVE_IVUV
8053 /* Got to punt this as an integer if needs be, but we don't issue
8054 warnings. Probably ought to make the sv_iv_please() that does
8055 the conversion if possible, and silently. */
8056 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8057 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8058 /* Need to try really hard to see if it's an integer.
8059 9.22337203685478e+18 is an integer.
8060 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8061 so $a="9.22337203685478e+18"; $a+0; $a++
8062 needs to be the same as $a="9.22337203685478e+18"; $a++
8069 /* sv_2iv *should* have made this an NV */
8070 if (flags & SVp_NOK) {
8071 (void)SvNOK_only(sv);
8072 SvNV_set(sv, SvNVX(sv) + 1.0);
8075 /* I don't think we can get here. Maybe I should assert this
8076 And if we do get here I suspect that sv_setnv will croak. NWC
8078 #if defined(USE_LONG_DOUBLE)
8079 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",
8080 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8082 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8083 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8086 #endif /* PERL_PRESERVE_IVUV */
8087 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8091 while (d >= SvPVX_const(sv)) {
8099 /* MKS: The original code here died if letters weren't consecutive.
8100 * at least it didn't have to worry about non-C locales. The
8101 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8102 * arranged in order (although not consecutively) and that only
8103 * [A-Za-z] are accepted by isALPHA in the C locale.
8105 if (*d != 'z' && *d != 'Z') {
8106 do { ++*d; } while (!isALPHA(*d));
8109 *(d--) -= 'z' - 'a';
8114 *(d--) -= 'z' - 'a' + 1;
8118 /* oh,oh, the number grew */
8119 SvGROW(sv, SvCUR(sv) + 2);
8120 SvCUR_set(sv, SvCUR(sv) + 1);
8121 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8132 Auto-decrement of the value in the SV, doing string to numeric conversion
8133 if necessary. Handles 'get' magic and operator overloading.
8139 Perl_sv_dec(pTHX_ register SV *const sv)
8149 =for apidoc sv_dec_nomg
8151 Auto-decrement of the value in the SV, doing string to numeric conversion
8152 if necessary. Handles operator overloading. Skips handling 'get' magic.
8158 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8165 if (SvTHINKFIRST(sv)) {
8166 if (SvIsCOW(sv) || isGV_with_GP(sv))
8167 sv_force_normal_flags(sv, 0);
8168 if (SvREADONLY(sv)) {
8169 if (IN_PERL_RUNTIME)
8170 Perl_croak_no_modify(aTHX);
8174 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8176 i = PTR2IV(SvRV(sv));
8181 /* Unlike sv_inc we don't have to worry about string-never-numbers
8182 and keeping them magic. But we mustn't warn on punting */
8183 flags = SvFLAGS(sv);
8184 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8185 /* It's publicly an integer, or privately an integer-not-float */
8186 #ifdef PERL_PRESERVE_IVUV
8190 if (SvUVX(sv) == 0) {
8191 (void)SvIOK_only(sv);
8195 (void)SvIOK_only_UV(sv);
8196 SvUV_set(sv, SvUVX(sv) - 1);
8199 if (SvIVX(sv) == IV_MIN) {
8200 sv_setnv(sv, (NV)IV_MIN);
8204 (void)SvIOK_only(sv);
8205 SvIV_set(sv, SvIVX(sv) - 1);
8210 if (flags & SVp_NOK) {
8213 const NV was = SvNVX(sv);
8214 if (NV_OVERFLOWS_INTEGERS_AT &&
8215 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8216 /* diag_listed_as: Lost precision when %s %f by 1 */
8217 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8218 "Lost precision when decrementing %" NVff " by 1",
8221 (void)SvNOK_only(sv);
8222 SvNV_set(sv, was - 1.0);
8226 if (!(flags & SVp_POK)) {
8227 if ((flags & SVTYPEMASK) < SVt_PVIV)
8228 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8230 (void)SvIOK_only(sv);
8233 #ifdef PERL_PRESERVE_IVUV
8235 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8236 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8237 /* Need to try really hard to see if it's an integer.
8238 9.22337203685478e+18 is an integer.
8239 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8240 so $a="9.22337203685478e+18"; $a+0; $a--
8241 needs to be the same as $a="9.22337203685478e+18"; $a--
8248 /* sv_2iv *should* have made this an NV */
8249 if (flags & SVp_NOK) {
8250 (void)SvNOK_only(sv);
8251 SvNV_set(sv, SvNVX(sv) - 1.0);
8254 /* I don't think we can get here. Maybe I should assert this
8255 And if we do get here I suspect that sv_setnv will croak. NWC
8257 #if defined(USE_LONG_DOUBLE)
8258 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",
8259 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8261 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8262 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8266 #endif /* PERL_PRESERVE_IVUV */
8267 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8270 /* this define is used to eliminate a chunk of duplicated but shared logic
8271 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8272 * used anywhere but here - yves
8274 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8277 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8281 =for apidoc sv_mortalcopy
8283 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8284 The new SV is marked as mortal. It will be destroyed "soon", either by an
8285 explicit call to FREETMPS, or by an implicit call at places such as
8286 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8291 /* Make a string that will exist for the duration of the expression
8292 * evaluation. Actually, it may have to last longer than that, but
8293 * hopefully we won't free it until it has been assigned to a
8294 * permanent location. */
8297 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8303 sv_setsv(sv,oldstr);
8304 PUSH_EXTEND_MORTAL__SV_C(sv);
8310 =for apidoc sv_newmortal
8312 Creates a new null SV which is mortal. The reference count of the SV is
8313 set to 1. It will be destroyed "soon", either by an explicit call to
8314 FREETMPS, or by an implicit call at places such as statement boundaries.
8315 See also C<sv_mortalcopy> and C<sv_2mortal>.
8321 Perl_sv_newmortal(pTHX)
8327 SvFLAGS(sv) = SVs_TEMP;
8328 PUSH_EXTEND_MORTAL__SV_C(sv);
8334 =for apidoc newSVpvn_flags
8336 Creates a new SV and copies a string into it. The reference count for the
8337 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8338 string. You are responsible for ensuring that the source string is at least
8339 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8340 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8341 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8342 returning. If C<SVf_UTF8> is set, C<s>
8343 is considered to be in UTF-8 and the
8344 C<SVf_UTF8> flag will be set on the new SV.
8345 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8347 #define newSVpvn_utf8(s, len, u) \
8348 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8354 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8359 /* All the flags we don't support must be zero.
8360 And we're new code so I'm going to assert this from the start. */
8361 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8363 sv_setpvn(sv,s,len);
8365 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8366 * and do what it does ourselves here.
8367 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8368 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8369 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8370 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8373 SvFLAGS(sv) |= flags;
8375 if(flags & SVs_TEMP){
8376 PUSH_EXTEND_MORTAL__SV_C(sv);
8383 =for apidoc sv_2mortal
8385 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8386 by an explicit call to FREETMPS, or by an implicit call at places such as
8387 statement boundaries. SvTEMP() is turned on which means that the SV's
8388 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8389 and C<sv_mortalcopy>.
8395 Perl_sv_2mortal(pTHX_ register SV *const sv)
8400 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8402 PUSH_EXTEND_MORTAL__SV_C(sv);
8410 Creates a new SV and copies a string into it. The reference count for the
8411 SV is set to 1. If C<len> is zero, Perl will compute the length using
8412 strlen(). For efficiency, consider using C<newSVpvn> instead.
8418 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8424 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8429 =for apidoc newSVpvn
8431 Creates a new SV and copies a buffer into it, which may contain NUL characters
8432 (C<\0>) and other binary data. The reference count for the SV is set to 1.
8433 Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
8434 are responsible for ensuring that the source buffer is at least
8435 C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
8442 Perl_newSVpvn(pTHX_ const char *const buffer, const STRLEN len)
8448 sv_setpvn(sv,buffer,len);
8453 =for apidoc newSVhek
8455 Creates a new SV from the hash key structure. It will generate scalars that
8456 point to the shared string table where possible. Returns a new (undefined)
8457 SV if the hek is NULL.
8463 Perl_newSVhek(pTHX_ const HEK *const hek)
8473 if (HEK_LEN(hek) == HEf_SVKEY) {
8474 return newSVsv(*(SV**)HEK_KEY(hek));
8476 const int flags = HEK_FLAGS(hek);
8477 if (flags & HVhek_WASUTF8) {
8479 Andreas would like keys he put in as utf8 to come back as utf8
8481 STRLEN utf8_len = HEK_LEN(hek);
8482 SV * const sv = newSV_type(SVt_PV);
8483 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8484 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8485 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8488 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8489 /* We don't have a pointer to the hv, so we have to replicate the
8490 flag into every HEK. This hv is using custom a hasing
8491 algorithm. Hence we can't return a shared string scalar, as
8492 that would contain the (wrong) hash value, and might get passed
8493 into an hv routine with a regular hash.
8494 Similarly, a hash that isn't using shared hash keys has to have
8495 the flag in every key so that we know not to try to call
8496 share_hek_hek on it. */
8498 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8503 /* This will be overwhelminly the most common case. */
8505 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8506 more efficient than sharepvn(). */
8510 sv_upgrade(sv, SVt_PV);
8511 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8512 SvCUR_set(sv, HEK_LEN(hek));
8525 =for apidoc newSVpvn_share
8527 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8528 table. If the string does not already exist in the table, it is
8529 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8530 is non-zero, that value is used; otherwise the hash is computed.
8531 The string's hash can later be retrieved from the SV
8532 with the C<SvSHARED_HASH()> macro. The idea here is
8533 that as the string table is used for shared hash keys these strings will have
8534 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8540 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8544 bool is_utf8 = FALSE;
8545 const char *const orig_src = src;
8548 STRLEN tmplen = -len;
8550 /* See the note in hv.c:hv_fetch() --jhi */
8551 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8555 PERL_HASH(hash, src, len);
8557 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8558 changes here, update it there too. */
8559 sv_upgrade(sv, SVt_PV);
8560 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8568 if (src != orig_src)
8574 =for apidoc newSVpv_share
8576 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8583 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8585 return newSVpvn_share(src, strlen(src), hash);
8588 #if defined(PERL_IMPLICIT_CONTEXT)
8590 /* pTHX_ magic can't cope with varargs, so this is a no-context
8591 * version of the main function, (which may itself be aliased to us).
8592 * Don't access this version directly.
8596 Perl_newSVpvf_nocontext(const char *const pat, ...)
8602 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8604 va_start(args, pat);
8605 sv = vnewSVpvf(pat, &args);
8612 =for apidoc newSVpvf
8614 Creates a new SV and initializes it with the string formatted like
8621 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8626 PERL_ARGS_ASSERT_NEWSVPVF;
8628 va_start(args, pat);
8629 sv = vnewSVpvf(pat, &args);
8634 /* backend for newSVpvf() and newSVpvf_nocontext() */
8637 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8642 PERL_ARGS_ASSERT_VNEWSVPVF;
8645 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8652 Creates a new SV and copies a floating point value into it.
8653 The reference count for the SV is set to 1.
8659 Perl_newSVnv(pTHX_ const NV n)
8672 Creates a new SV and copies an integer into it. The reference count for the
8679 Perl_newSViv(pTHX_ const IV i)
8692 Creates a new SV and copies an unsigned integer into it.
8693 The reference count for the SV is set to 1.
8699 Perl_newSVuv(pTHX_ const UV u)
8710 =for apidoc newSV_type
8712 Creates a new SV, of the type specified. The reference count for the new SV
8719 Perl_newSV_type(pTHX_ const svtype type)
8724 sv_upgrade(sv, type);
8729 =for apidoc newRV_noinc
8731 Creates an RV wrapper for an SV. The reference count for the original
8732 SV is B<not> incremented.
8738 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8741 register SV *sv = newSV_type(SVt_IV);
8743 PERL_ARGS_ASSERT_NEWRV_NOINC;
8746 SvRV_set(sv, tmpRef);
8751 /* newRV_inc is the official function name to use now.
8752 * newRV_inc is in fact #defined to newRV in sv.h
8756 Perl_newRV(pTHX_ SV *const sv)
8760 PERL_ARGS_ASSERT_NEWRV;
8762 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8768 Creates a new SV which is an exact duplicate of the original SV.
8775 Perl_newSVsv(pTHX_ register SV *const old)
8782 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8783 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8787 /* SV_GMAGIC is the default for sv_setv()
8788 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8789 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8790 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8795 =for apidoc sv_reset
8797 Underlying implementation for the C<reset> Perl function.
8798 Note that the perl-level function is vaguely deprecated.
8804 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8807 char todo[PERL_UCHAR_MAX+1];
8809 PERL_ARGS_ASSERT_SV_RESET;
8814 if (!*s) { /* reset ?? searches */
8815 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8817 const U32 count = mg->mg_len / sizeof(PMOP**);
8818 PMOP **pmp = (PMOP**) mg->mg_ptr;
8819 PMOP *const *const end = pmp + count;
8823 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8825 (*pmp)->op_pmflags &= ~PMf_USED;
8833 /* reset variables */
8835 if (!HvARRAY(stash))
8838 Zero(todo, 256, char);
8841 I32 i = (unsigned char)*s;
8845 max = (unsigned char)*s++;
8846 for ( ; i <= max; i++) {
8849 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8851 for (entry = HvARRAY(stash)[i];
8853 entry = HeNEXT(entry))
8858 if (!todo[(U8)*HeKEY(entry)])
8860 gv = MUTABLE_GV(HeVAL(entry));
8863 if (SvTHINKFIRST(sv)) {
8864 if (!SvREADONLY(sv) && SvROK(sv))
8866 /* XXX Is this continue a bug? Why should THINKFIRST
8867 exempt us from resetting arrays and hashes? */
8871 if (SvTYPE(sv) >= SVt_PV) {
8873 if (SvPVX_const(sv) != NULL)
8881 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8883 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8886 # if defined(USE_ENVIRON_ARRAY)
8889 # endif /* USE_ENVIRON_ARRAY */
8900 Using various gambits, try to get an IO from an SV: the IO slot if its a
8901 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8902 named after the PV if we're a string.
8904 'Get' magic is ignored on the sv passed in, but will be called on
8905 C<SvRV(sv)> if sv is an RV.
8911 Perl_sv_2io(pTHX_ SV *const sv)
8916 PERL_ARGS_ASSERT_SV_2IO;
8918 switch (SvTYPE(sv)) {
8920 io = MUTABLE_IO(sv);
8924 if (isGV_with_GP(sv)) {
8925 gv = MUTABLE_GV(sv);
8928 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8929 HEKfARG(GvNAME_HEK(gv)));
8935 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8937 SvGETMAGIC(SvRV(sv));
8938 return sv_2io(SvRV(sv));
8940 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8947 if (SvGMAGICAL(sv)) {
8948 newsv = sv_newmortal();
8949 sv_setsv_nomg(newsv, sv);
8951 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8961 Using various gambits, try to get a CV from an SV; in addition, try if
8962 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8963 The flags in C<lref> are passed to gv_fetchsv.
8969 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8975 PERL_ARGS_ASSERT_SV_2CV;
8982 switch (SvTYPE(sv)) {
8986 return MUTABLE_CV(sv);
8996 sv = amagic_deref_call(sv, to_cv_amg);
8999 if (SvTYPE(sv) == SVt_PVCV) {
9000 cv = MUTABLE_CV(sv);
9005 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
9006 gv = MUTABLE_GV(sv);
9008 Perl_croak(aTHX_ "Not a subroutine reference");
9010 else if (isGV_with_GP(sv)) {
9011 gv = MUTABLE_GV(sv);
9014 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
9021 /* Some flags to gv_fetchsv mean don't really create the GV */
9022 if (!isGV_with_GP(gv)) {
9027 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
9031 gv_efullname3(tmpsv, gv, NULL);
9032 /* XXX this is probably not what they think they're getting.
9033 * It has the same effect as "sub name;", i.e. just a forward
9035 newSUB(start_subparse(FALSE, 0),
9036 newSVOP(OP_CONST, 0, tmpsv),
9040 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
9041 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
9050 Returns true if the SV has a true value by Perl's rules.
9051 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
9052 instead use an in-line version.
9058 Perl_sv_true(pTHX_ register SV *const sv)
9063 register const XPV* const tXpv = (XPV*)SvANY(sv);
9065 (tXpv->xpv_cur > 1 ||
9066 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9073 return SvIVX(sv) != 0;
9076 return SvNVX(sv) != 0.0;
9078 return sv_2bool(sv);
9084 =for apidoc sv_pvn_force
9086 Get a sensible string out of the SV somehow.
9087 A private implementation of the C<SvPV_force> macro for compilers which
9088 can't cope with complex macro expressions. Always use the macro instead.
9090 =for apidoc sv_pvn_force_flags
9092 Get a sensible string out of the SV somehow.
9093 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9094 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9095 implemented in terms of this function.
9096 You normally want to use the various wrapper macros instead: see
9097 C<SvPV_force> and C<SvPV_force_nomg>
9103 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9107 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9109 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9110 if (SvTHINKFIRST(sv) && !SvROK(sv))
9111 sv_force_normal_flags(sv, 0);
9121 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9122 const char * const ref = sv_reftype(sv,0);
9124 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9125 ref, OP_DESC(PL_op));
9127 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9129 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9130 || isGV_with_GP(sv))
9131 /* diag_listed_as: Can't coerce %s to %s in %s */
9132 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9134 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9141 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9144 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9145 SvGROW(sv, len + 1);
9146 Move(s,SvPVX(sv),len,char);
9148 SvPVX(sv)[len] = '\0';
9151 SvPOK_on(sv); /* validate pointer */
9153 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9154 PTR2UV(sv),SvPVX_const(sv)));
9157 return SvPVX_mutable(sv);
9161 =for apidoc sv_pvbyten_force
9163 The backend for the C<SvPVbytex_force> macro. Always use the macro
9170 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9172 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9174 sv_pvn_force(sv,lp);
9175 sv_utf8_downgrade(sv,0);
9181 =for apidoc sv_pvutf8n_force
9183 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9190 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9192 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9194 sv_pvn_force(sv,lp);
9195 sv_utf8_upgrade(sv);
9201 =for apidoc sv_reftype
9203 Returns a string describing what the SV is a reference to.
9209 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9211 PERL_ARGS_ASSERT_SV_REFTYPE;
9212 if (ob && SvOBJECT(sv)) {
9213 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9216 switch (SvTYPE(sv)) {
9231 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9232 /* tied lvalues should appear to be
9233 * scalars for backwards compatibility */
9234 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9235 ? "SCALAR" : "LVALUE");
9236 case SVt_PVAV: return "ARRAY";
9237 case SVt_PVHV: return "HASH";
9238 case SVt_PVCV: return "CODE";
9239 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9240 ? "GLOB" : "SCALAR");
9241 case SVt_PVFM: return "FORMAT";
9242 case SVt_PVIO: return "IO";
9243 case SVt_BIND: return "BIND";
9244 case SVt_REGEXP: return "REGEXP";
9245 default: return "UNKNOWN";
9253 Returns a SV describing what the SV passed in is a reference to.
9259 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9261 PERL_ARGS_ASSERT_SV_REF;
9264 dst = sv_newmortal();
9266 if (ob && SvOBJECT(sv)) {
9267 HvNAME_get(SvSTASH(sv))
9268 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9269 : sv_setpvn(dst, "__ANON__", 8);
9272 const char * reftype = sv_reftype(sv, 0);
9273 sv_setpv(dst, reftype);
9279 =for apidoc sv_isobject
9281 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9282 object. If the SV is not an RV, or if the object is not blessed, then this
9289 Perl_sv_isobject(pTHX_ SV *sv)
9305 Returns a boolean indicating whether the SV is blessed into the specified
9306 class. This does not check for subtypes; use C<sv_derived_from> to verify
9307 an inheritance relationship.
9313 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9317 PERL_ARGS_ASSERT_SV_ISA;
9327 hvname = HvNAME_get(SvSTASH(sv));
9331 return strEQ(hvname, name);
9337 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9338 it will be upgraded to one. If C<classname> is non-null then the new SV will
9339 be blessed in the specified package. The new SV is returned and its
9340 reference count is 1.
9346 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9351 PERL_ARGS_ASSERT_NEWSVRV;
9355 SV_CHECK_THINKFIRST_COW_DROP(rv);
9357 if (SvTYPE(rv) >= SVt_PVMG) {
9358 const U32 refcnt = SvREFCNT(rv);
9362 SvREFCNT(rv) = refcnt;
9364 sv_upgrade(rv, SVt_IV);
9365 } else if (SvROK(rv)) {
9366 SvREFCNT_dec(SvRV(rv));
9368 prepare_SV_for_RV(rv);
9376 HV* const stash = gv_stashpv(classname, GV_ADD);
9377 (void)sv_bless(rv, stash);
9383 =for apidoc sv_setref_pv
9385 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9386 argument will be upgraded to an RV. That RV will be modified to point to
9387 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9388 into the SV. The C<classname> argument indicates the package for the
9389 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9390 will have a reference count of 1, and the RV will be returned.
9392 Do not use with other Perl types such as HV, AV, SV, CV, because those
9393 objects will become corrupted by the pointer copy process.
9395 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9401 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9405 PERL_ARGS_ASSERT_SV_SETREF_PV;
9408 sv_setsv(rv, &PL_sv_undef);
9412 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9417 =for apidoc sv_setref_iv
9419 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9420 argument will be upgraded to an RV. That RV will be modified to point to
9421 the new SV. The C<classname> argument indicates the package for the
9422 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9423 will have a reference count of 1, and the RV will be returned.
9429 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9431 PERL_ARGS_ASSERT_SV_SETREF_IV;
9433 sv_setiv(newSVrv(rv,classname), iv);
9438 =for apidoc sv_setref_uv
9440 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9441 argument will be upgraded to an RV. That RV will be modified to point to
9442 the new SV. The C<classname> argument indicates the package for the
9443 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9444 will have a reference count of 1, and the RV will be returned.
9450 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9452 PERL_ARGS_ASSERT_SV_SETREF_UV;
9454 sv_setuv(newSVrv(rv,classname), uv);
9459 =for apidoc sv_setref_nv
9461 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9462 argument will be upgraded to an RV. That RV will be modified to point to
9463 the new SV. The C<classname> argument indicates the package for the
9464 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9465 will have a reference count of 1, and the RV will be returned.
9471 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9473 PERL_ARGS_ASSERT_SV_SETREF_NV;
9475 sv_setnv(newSVrv(rv,classname), nv);
9480 =for apidoc sv_setref_pvn
9482 Copies a string into a new SV, optionally blessing the SV. The length of the
9483 string must be specified with C<n>. The C<rv> argument will be upgraded to
9484 an RV. That RV will be modified to point to the new SV. The C<classname>
9485 argument indicates the package for the blessing. Set C<classname> to
9486 C<NULL> to avoid the blessing. The new SV will have a reference count
9487 of 1, and the RV will be returned.
9489 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9495 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9496 const char *const pv, const STRLEN n)
9498 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9500 sv_setpvn(newSVrv(rv,classname), pv, n);
9505 =for apidoc sv_bless
9507 Blesses an SV into a specified package. The SV must be an RV. The package
9508 must be designated by its stash (see C<gv_stashpv()>). The reference count
9509 of the SV is unaffected.
9515 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9520 PERL_ARGS_ASSERT_SV_BLESS;
9523 Perl_croak(aTHX_ "Can't bless non-reference value");
9525 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9526 if (SvIsCOW(tmpRef))
9527 sv_force_normal_flags(tmpRef, 0);
9528 if (SvREADONLY(tmpRef))
9529 Perl_croak_no_modify(aTHX);
9530 if (SvOBJECT(tmpRef)) {
9531 if (SvTYPE(tmpRef) != SVt_PVIO)
9533 SvREFCNT_dec(SvSTASH(tmpRef));
9536 SvOBJECT_on(tmpRef);
9537 if (SvTYPE(tmpRef) != SVt_PVIO)
9539 SvUPGRADE(tmpRef, SVt_PVMG);
9540 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9542 if(SvSMAGICAL(tmpRef))
9543 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9551 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9552 * as it is after unglobbing it.
9555 PERL_STATIC_INLINE void
9556 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9561 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9563 PERL_ARGS_ASSERT_SV_UNGLOB;
9565 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9567 if (!(flags & SV_COW_DROP_PV))
9568 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9571 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9572 && HvNAME_get(stash))
9573 mro_method_changed_in(stash);
9574 gp_free(MUTABLE_GV(sv));
9577 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9581 if (GvNAME_HEK(sv)) {
9582 unshare_hek(GvNAME_HEK(sv));
9584 isGV_with_GP_off(sv);
9586 if(SvTYPE(sv) == SVt_PVGV) {
9587 /* need to keep SvANY(sv) in the right arena */
9588 xpvmg = new_XPVMG();
9589 StructCopy(SvANY(sv), xpvmg, XPVMG);
9590 del_XPVGV(SvANY(sv));
9593 SvFLAGS(sv) &= ~SVTYPEMASK;
9594 SvFLAGS(sv) |= SVt_PVMG;
9597 /* Intentionally not calling any local SET magic, as this isn't so much a
9598 set operation as merely an internal storage change. */
9599 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9600 else sv_setsv_flags(sv, temp, 0);
9602 if ((const GV *)sv == PL_last_in_gv)
9603 PL_last_in_gv = NULL;
9604 else if ((const GV *)sv == PL_statgv)
9609 =for apidoc sv_unref_flags
9611 Unsets the RV status of the SV, and decrements the reference count of
9612 whatever was being referenced by the RV. This can almost be thought of
9613 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9614 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9615 (otherwise the decrementing is conditional on the reference count being
9616 different from one or the reference being a readonly SV).
9623 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9625 SV* const target = SvRV(ref);
9627 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9629 if (SvWEAKREF(ref)) {
9630 sv_del_backref(target, ref);
9632 SvRV_set(ref, NULL);
9635 SvRV_set(ref, NULL);
9637 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9638 assigned to as BEGIN {$a = \"Foo"} will fail. */
9639 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9640 SvREFCNT_dec(target);
9641 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9642 sv_2mortal(target); /* Schedule for freeing later */
9646 =for apidoc sv_untaint
9648 Untaint an SV. Use C<SvTAINTED_off> instead.
9654 Perl_sv_untaint(pTHX_ SV *const sv)
9656 PERL_ARGS_ASSERT_SV_UNTAINT;
9658 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9659 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9666 =for apidoc sv_tainted
9668 Test an SV for taintedness. Use C<SvTAINTED> instead.
9674 Perl_sv_tainted(pTHX_ SV *const sv)
9676 PERL_ARGS_ASSERT_SV_TAINTED;
9678 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9679 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9680 if (mg && (mg->mg_len & 1) )
9687 =for apidoc sv_setpviv
9689 Copies an integer into the given SV, also updating its string value.
9690 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9696 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9698 char buf[TYPE_CHARS(UV)];
9700 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9702 PERL_ARGS_ASSERT_SV_SETPVIV;
9704 sv_setpvn(sv, ptr, ebuf - ptr);
9708 =for apidoc sv_setpviv_mg
9710 Like C<sv_setpviv>, but also handles 'set' magic.
9716 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9718 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9724 #if defined(PERL_IMPLICIT_CONTEXT)
9726 /* pTHX_ magic can't cope with varargs, so this is a no-context
9727 * version of the main function, (which may itself be aliased to us).
9728 * Don't access this version directly.
9732 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9737 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9739 va_start(args, pat);
9740 sv_vsetpvf(sv, pat, &args);
9744 /* pTHX_ magic can't cope with varargs, so this is a no-context
9745 * version of the main function, (which may itself be aliased to us).
9746 * Don't access this version directly.
9750 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9755 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9757 va_start(args, pat);
9758 sv_vsetpvf_mg(sv, pat, &args);
9764 =for apidoc sv_setpvf
9766 Works like C<sv_catpvf> but copies the text into the SV instead of
9767 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9773 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9777 PERL_ARGS_ASSERT_SV_SETPVF;
9779 va_start(args, pat);
9780 sv_vsetpvf(sv, pat, &args);
9785 =for apidoc sv_vsetpvf
9787 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9788 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9790 Usually used via its frontend C<sv_setpvf>.
9796 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9798 PERL_ARGS_ASSERT_SV_VSETPVF;
9800 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9804 =for apidoc sv_setpvf_mg
9806 Like C<sv_setpvf>, but also handles 'set' magic.
9812 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9816 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9818 va_start(args, pat);
9819 sv_vsetpvf_mg(sv, pat, &args);
9824 =for apidoc sv_vsetpvf_mg
9826 Like C<sv_vsetpvf>, but also handles 'set' magic.
9828 Usually used via its frontend C<sv_setpvf_mg>.
9834 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9836 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9838 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9842 #if defined(PERL_IMPLICIT_CONTEXT)
9844 /* pTHX_ magic can't cope with varargs, so this is a no-context
9845 * version of the main function, (which may itself be aliased to us).
9846 * Don't access this version directly.
9850 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9855 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9857 va_start(args, pat);
9858 sv_vcatpvf(sv, pat, &args);
9862 /* pTHX_ magic can't cope with varargs, so this is a no-context
9863 * version of the main function, (which may itself be aliased to us).
9864 * Don't access this version directly.
9868 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9873 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9875 va_start(args, pat);
9876 sv_vcatpvf_mg(sv, pat, &args);
9882 =for apidoc sv_catpvf
9884 Processes its arguments like C<sprintf> and appends the formatted
9885 output to an SV. If the appended data contains "wide" characters
9886 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9887 and characters >255 formatted with %c), the original SV might get
9888 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9889 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9890 valid UTF-8; if the original SV was bytes, the pattern should be too.
9895 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9899 PERL_ARGS_ASSERT_SV_CATPVF;
9901 va_start(args, pat);
9902 sv_vcatpvf(sv, pat, &args);
9907 =for apidoc sv_vcatpvf
9909 Processes its arguments like C<vsprintf> and appends the formatted output
9910 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9912 Usually used via its frontend C<sv_catpvf>.
9918 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9920 PERL_ARGS_ASSERT_SV_VCATPVF;
9922 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9926 =for apidoc sv_catpvf_mg
9928 Like C<sv_catpvf>, but also handles 'set' magic.
9934 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9938 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9940 va_start(args, pat);
9941 sv_vcatpvf_mg(sv, pat, &args);
9946 =for apidoc sv_vcatpvf_mg
9948 Like C<sv_vcatpvf>, but also handles 'set' magic.
9950 Usually used via its frontend C<sv_catpvf_mg>.
9956 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9958 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9960 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9965 =for apidoc sv_vsetpvfn
9967 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9970 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9976 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9977 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9979 PERL_ARGS_ASSERT_SV_VSETPVFN;
9982 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9987 * Warn of missing argument to sprintf, and then return a defined value
9988 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9990 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9992 S_vcatpvfn_missing_argument(pTHX) {
9993 if (ckWARN(WARN_MISSING)) {
9994 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9995 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
10002 S_expect_number(pTHX_ char **const pattern)
10007 PERL_ARGS_ASSERT_EXPECT_NUMBER;
10009 switch (**pattern) {
10010 case '1': case '2': case '3':
10011 case '4': case '5': case '6':
10012 case '7': case '8': case '9':
10013 var = *(*pattern)++ - '0';
10014 while (isDIGIT(**pattern)) {
10015 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
10017 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
10025 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
10027 const int neg = nv < 0;
10030 PERL_ARGS_ASSERT_F0CONVERT;
10038 if (uv & 1 && uv == nv)
10039 uv--; /* Round to even */
10041 const unsigned dig = uv % 10;
10043 } while (uv /= 10);
10054 =for apidoc sv_vcatpvfn
10056 Processes its arguments like C<vsprintf> and appends the formatted output
10057 to an SV. Uses an array of SVs if the C style variable argument list is
10058 missing (NULL). When running with taint checks enabled, indicates via
10059 C<maybe_tainted> if results are untrustworthy (often due to the use of
10062 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10068 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10069 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10070 vec_utf8 = DO_UTF8(vecsv);
10072 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10075 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10076 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10081 const char *patend;
10084 static const char nullstr[] = "(null)";
10086 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10087 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10089 /* Times 4: a decimal digit takes more than 3 binary digits.
10090 * NV_DIG: mantissa takes than many decimal digits.
10091 * Plus 32: Playing safe. */
10092 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10093 /* large enough for "%#.#f" --chip */
10094 /* what about long double NVs? --jhi */
10096 PERL_ARGS_ASSERT_SV_VCATPVFN;
10097 PERL_UNUSED_ARG(maybe_tainted);
10099 /* no matter what, this is a string now */
10100 (void)SvPV_force(sv, origlen);
10102 /* special-case "", "%s", and "%-p" (SVf - see below) */
10105 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10107 const char * const s = va_arg(*args, char*);
10108 sv_catpv(sv, s ? s : nullstr);
10110 else if (svix < svmax) {
10111 sv_catsv(sv, *svargs);
10114 S_vcatpvfn_missing_argument(aTHX);
10117 if (args && patlen == 3 && pat[0] == '%' &&
10118 pat[1] == '-' && pat[2] == 'p') {
10119 argsv = MUTABLE_SV(va_arg(*args, void*));
10120 sv_catsv(sv, argsv);
10124 #ifndef USE_LONG_DOUBLE
10125 /* special-case "%.<number>[gf]" */
10126 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10127 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10128 unsigned digits = 0;
10132 while (*pp >= '0' && *pp <= '9')
10133 digits = 10 * digits + (*pp++ - '0');
10134 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10135 const NV nv = SvNV(*svargs);
10137 /* Add check for digits != 0 because it seems that some
10138 gconverts are buggy in this case, and we don't yet have
10139 a Configure test for this. */
10140 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10141 /* 0, point, slack */
10142 Gconvert(nv, (int)digits, 0, ebuf);
10143 sv_catpv(sv, ebuf);
10144 if (*ebuf) /* May return an empty string for digits==0 */
10147 } else if (!digits) {
10150 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10151 sv_catpvn(sv, p, l);
10157 #endif /* !USE_LONG_DOUBLE */
10159 if (!args && svix < svmax && DO_UTF8(*svargs))
10162 patend = (char*)pat + patlen;
10163 for (p = (char*)pat; p < patend; p = q) {
10166 bool vectorize = FALSE;
10167 bool vectorarg = FALSE;
10168 bool vec_utf8 = FALSE;
10174 bool has_precis = FALSE;
10176 const I32 osvix = svix;
10177 bool is_utf8 = FALSE; /* is this item utf8? */
10178 #ifdef HAS_LDBL_SPRINTF_BUG
10179 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10180 with sfio - Allen <allens@cpan.org> */
10181 bool fix_ldbl_sprintf_bug = FALSE;
10185 U8 utf8buf[UTF8_MAXBYTES+1];
10186 STRLEN esignlen = 0;
10188 const char *eptr = NULL;
10189 const char *fmtstart;
10192 const U8 *vecstr = NULL;
10199 /* we need a long double target in case HAS_LONG_DOUBLE but
10200 not USE_LONG_DOUBLE
10202 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10210 const char *dotstr = ".";
10211 STRLEN dotstrlen = 1;
10212 I32 efix = 0; /* explicit format parameter index */
10213 I32 ewix = 0; /* explicit width index */
10214 I32 epix = 0; /* explicit precision index */
10215 I32 evix = 0; /* explicit vector index */
10216 bool asterisk = FALSE;
10218 /* echo everything up to the next format specification */
10219 for (q = p; q < patend && *q != '%'; ++q) ;
10221 if (has_utf8 && !pat_utf8)
10222 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10224 sv_catpvn(sv, p, q - p);
10233 We allow format specification elements in this order:
10234 \d+\$ explicit format parameter index
10236 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10237 0 flag (as above): repeated to allow "v02"
10238 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10239 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10241 [%bcdefginopsuxDFOUX] format (mandatory)
10246 As of perl5.9.3, printf format checking is on by default.
10247 Internally, perl uses %p formats to provide an escape to
10248 some extended formatting. This block deals with those
10249 extensions: if it does not match, (char*)q is reset and
10250 the normal format processing code is used.
10252 Currently defined extensions are:
10253 %p include pointer address (standard)
10254 %-p (SVf) include an SV (previously %_)
10255 %-<num>p include an SV with precision <num>
10257 %3p include a HEK with precision of 256
10258 %<num>p (where num != 2 or 3) reserved for future
10261 Robin Barker 2005-07-14 (but modified since)
10263 %1p (VDf) removed. RMB 2007-10-19
10270 n = expect_number(&q);
10272 if (sv) { /* SVf */
10277 argsv = MUTABLE_SV(va_arg(*args, void*));
10278 eptr = SvPV_const(argsv, elen);
10279 if (DO_UTF8(argsv))
10283 else if (n==2 || n==3) { /* HEKf */
10284 HEK * const hek = va_arg(*args, HEK *);
10285 eptr = HEK_KEY(hek);
10286 elen = HEK_LEN(hek);
10287 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10288 if (n==3) precis = 256, has_precis = TRUE;
10292 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10293 "internal %%<num>p might conflict with future printf extensions");
10299 if ( (width = expect_number(&q)) ) {
10314 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10343 if ( (ewix = expect_number(&q)) )
10352 if ((vectorarg = asterisk)) {
10365 width = expect_number(&q);
10368 if (vectorize && vectorarg) {
10369 /* vectorizing, but not with the default "." */
10371 vecsv = va_arg(*args, SV*);
10373 vecsv = (evix > 0 && evix <= svmax)
10374 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10376 vecsv = svix < svmax
10377 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10379 dotstr = SvPV_const(vecsv, dotstrlen);
10380 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10381 bad with tied or overloaded values that return UTF8. */
10382 if (DO_UTF8(vecsv))
10384 else if (has_utf8) {
10385 vecsv = sv_mortalcopy(vecsv);
10386 sv_utf8_upgrade(vecsv);
10387 dotstr = SvPV_const(vecsv, dotstrlen);
10394 i = va_arg(*args, int);
10396 i = (ewix ? ewix <= svmax : svix < svmax) ?
10397 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10399 width = (i < 0) ? -i : i;
10409 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10411 /* XXX: todo, support specified precision parameter */
10415 i = va_arg(*args, int);
10417 i = (ewix ? ewix <= svmax : svix < svmax)
10418 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10420 has_precis = !(i < 0);
10424 while (isDIGIT(*q))
10425 precis = precis * 10 + (*q++ - '0');
10434 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10435 vecsv = svargs[efix ? efix-1 : svix++];
10436 vecstr = (U8*)SvPV_const(vecsv,veclen);
10437 vec_utf8 = DO_UTF8(vecsv);
10439 /* if this is a version object, we need to convert
10440 * back into v-string notation and then let the
10441 * vectorize happen normally
10443 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10444 char *version = savesvpv(vecsv);
10445 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10446 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10447 "vector argument not supported with alpha versions");
10450 vecsv = sv_newmortal();
10451 scan_vstring(version, version + veclen, vecsv);
10452 vecstr = (U8*)SvPV_const(vecsv, veclen);
10453 vec_utf8 = DO_UTF8(vecsv);
10467 case 'I': /* Ix, I32x, and I64x */
10469 if (q[1] == '6' && q[2] == '4') {
10475 if (q[1] == '3' && q[2] == '2') {
10485 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10497 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10498 if (*q == 'l') { /* lld, llf */
10507 if (*++q == 'h') { /* hhd, hhu */
10536 if (!vectorize && !args) {
10538 const I32 i = efix-1;
10539 argsv = (i >= 0 && i < svmax)
10540 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10542 argsv = (svix >= 0 && svix < svmax)
10543 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10547 switch (c = *q++) {
10554 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10556 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10558 eptr = (char*)utf8buf;
10559 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10573 eptr = va_arg(*args, char*);
10575 elen = strlen(eptr);
10577 eptr = (char *)nullstr;
10578 elen = sizeof nullstr - 1;
10582 eptr = SvPV_const(argsv, elen);
10583 if (DO_UTF8(argsv)) {
10584 STRLEN old_precis = precis;
10585 if (has_precis && precis < elen) {
10586 STRLEN ulen = sv_len_utf8(argsv);
10587 I32 p = precis > ulen ? ulen : precis;
10588 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10591 if (width) { /* fudge width (can't fudge elen) */
10592 if (has_precis && precis < elen)
10593 width += precis - old_precis;
10595 width += elen - sv_len_utf8(argsv);
10602 if (has_precis && precis < elen)
10609 if (alt || vectorize)
10611 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10632 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10641 esignbuf[esignlen++] = plus;
10645 case 'c': iv = (char)va_arg(*args, int); break;
10646 case 'h': iv = (short)va_arg(*args, int); break;
10647 case 'l': iv = va_arg(*args, long); break;
10648 case 'V': iv = va_arg(*args, IV); break;
10649 case 'z': iv = va_arg(*args, SSize_t); break;
10650 case 't': iv = va_arg(*args, ptrdiff_t); break;
10651 default: iv = va_arg(*args, int); break;
10653 case 'j': iv = va_arg(*args, intmax_t); break;
10657 iv = va_arg(*args, Quad_t); break;
10664 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10666 case 'c': iv = (char)tiv; break;
10667 case 'h': iv = (short)tiv; break;
10668 case 'l': iv = (long)tiv; break;
10670 default: iv = tiv; break;
10673 iv = (Quad_t)tiv; break;
10679 if ( !vectorize ) /* we already set uv above */
10684 esignbuf[esignlen++] = plus;
10688 esignbuf[esignlen++] = '-';
10732 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10743 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10744 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10745 case 'l': uv = va_arg(*args, unsigned long); break;
10746 case 'V': uv = va_arg(*args, UV); break;
10747 case 'z': uv = va_arg(*args, Size_t); break;
10748 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10750 case 'j': uv = va_arg(*args, uintmax_t); break;
10752 default: uv = va_arg(*args, unsigned); break;
10755 uv = va_arg(*args, Uquad_t); break;
10762 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10764 case 'c': uv = (unsigned char)tuv; break;
10765 case 'h': uv = (unsigned short)tuv; break;
10766 case 'l': uv = (unsigned long)tuv; break;
10768 default: uv = tuv; break;
10771 uv = (Uquad_t)tuv; break;
10780 char *ptr = ebuf + sizeof ebuf;
10781 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10787 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10791 } while (uv >>= 4);
10793 esignbuf[esignlen++] = '0';
10794 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10800 *--ptr = '0' + dig;
10801 } while (uv >>= 3);
10802 if (alt && *ptr != '0')
10808 *--ptr = '0' + dig;
10809 } while (uv >>= 1);
10811 esignbuf[esignlen++] = '0';
10812 esignbuf[esignlen++] = c;
10815 default: /* it had better be ten or less */
10818 *--ptr = '0' + dig;
10819 } while (uv /= base);
10822 elen = (ebuf + sizeof ebuf) - ptr;
10826 zeros = precis - elen;
10827 else if (precis == 0 && elen == 1 && *eptr == '0'
10828 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10831 /* a precision nullifies the 0 flag. */
10838 /* FLOATING POINT */
10841 c = 'f'; /* maybe %F isn't supported here */
10843 case 'e': case 'E':
10845 case 'g': case 'G':
10849 /* This is evil, but floating point is even more evil */
10851 /* for SV-style calling, we can only get NV
10852 for C-style calling, we assume %f is double;
10853 for simplicity we allow any of %Lf, %llf, %qf for long double
10857 #if defined(USE_LONG_DOUBLE)
10861 /* [perl #20339] - we should accept and ignore %lf rather than die */
10865 #if defined(USE_LONG_DOUBLE)
10866 intsize = args ? 0 : 'q';
10870 #if defined(HAS_LONG_DOUBLE)
10883 /* now we need (long double) if intsize == 'q', else (double) */
10885 #if LONG_DOUBLESIZE > DOUBLESIZE
10887 va_arg(*args, long double) :
10888 va_arg(*args, double)
10890 va_arg(*args, double)
10895 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10896 else. frexp() has some unspecified behaviour for those three */
10897 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10899 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10900 will cast our (long double) to (double) */
10901 (void)Perl_frexp(nv, &i);
10902 if (i == PERL_INT_MIN)
10903 Perl_die(aTHX_ "panic: frexp");
10905 need = BIT_DIGITS(i);
10907 need += has_precis ? precis : 6; /* known default */
10912 #ifdef HAS_LDBL_SPRINTF_BUG
10913 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10914 with sfio - Allen <allens@cpan.org> */
10917 # define MY_DBL_MAX DBL_MAX
10918 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10919 # if DOUBLESIZE >= 8
10920 # define MY_DBL_MAX 1.7976931348623157E+308L
10922 # define MY_DBL_MAX 3.40282347E+38L
10926 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10927 # define MY_DBL_MAX_BUG 1L
10929 # define MY_DBL_MAX_BUG MY_DBL_MAX
10933 # define MY_DBL_MIN DBL_MIN
10934 # else /* XXX guessing! -Allen */
10935 # if DOUBLESIZE >= 8
10936 # define MY_DBL_MIN 2.2250738585072014E-308L
10938 # define MY_DBL_MIN 1.17549435E-38L
10942 if ((intsize == 'q') && (c == 'f') &&
10943 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10944 (need < DBL_DIG)) {
10945 /* it's going to be short enough that
10946 * long double precision is not needed */
10948 if ((nv <= 0L) && (nv >= -0L))
10949 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10951 /* would use Perl_fp_class as a double-check but not
10952 * functional on IRIX - see perl.h comments */
10954 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10955 /* It's within the range that a double can represent */
10956 #if defined(DBL_MAX) && !defined(DBL_MIN)
10957 if ((nv >= ((long double)1/DBL_MAX)) ||
10958 (nv <= (-(long double)1/DBL_MAX)))
10960 fix_ldbl_sprintf_bug = TRUE;
10963 if (fix_ldbl_sprintf_bug == TRUE) {
10973 # undef MY_DBL_MAX_BUG
10976 #endif /* HAS_LDBL_SPRINTF_BUG */
10978 need += 20; /* fudge factor */
10979 if (PL_efloatsize < need) {
10980 Safefree(PL_efloatbuf);
10981 PL_efloatsize = need + 20; /* more fudge */
10982 Newx(PL_efloatbuf, PL_efloatsize, char);
10983 PL_efloatbuf[0] = '\0';
10986 if ( !(width || left || plus || alt) && fill != '0'
10987 && has_precis && intsize != 'q' ) { /* Shortcuts */
10988 /* See earlier comment about buggy Gconvert when digits,
10990 if ( c == 'g' && precis) {
10991 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10992 /* May return an empty string for digits==0 */
10993 if (*PL_efloatbuf) {
10994 elen = strlen(PL_efloatbuf);
10995 goto float_converted;
10997 } else if ( c == 'f' && !precis) {
10998 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
11003 char *ptr = ebuf + sizeof ebuf;
11006 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
11007 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
11008 if (intsize == 'q') {
11009 /* Copy the one or more characters in a long double
11010 * format before the 'base' ([efgEFG]) character to
11011 * the format string. */
11012 static char const prifldbl[] = PERL_PRIfldbl;
11013 char const *p = prifldbl + sizeof(prifldbl) - 3;
11014 while (p >= prifldbl) { *--ptr = *p--; }
11019 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11024 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11036 /* No taint. Otherwise we are in the strange situation
11037 * where printf() taints but print($float) doesn't.
11039 #if defined(HAS_LONG_DOUBLE)
11040 elen = ((intsize == 'q')
11041 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
11042 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
11044 elen = my_sprintf(PL_efloatbuf, ptr, nv);
11048 eptr = PL_efloatbuf;
11056 i = SvCUR(sv) - origlen;
11059 case 'c': *(va_arg(*args, char*)) = i; break;
11060 case 'h': *(va_arg(*args, short*)) = i; break;
11061 default: *(va_arg(*args, int*)) = i; break;
11062 case 'l': *(va_arg(*args, long*)) = i; break;
11063 case 'V': *(va_arg(*args, IV*)) = i; break;
11064 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11065 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11067 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11071 *(va_arg(*args, Quad_t*)) = i; break;
11078 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11079 continue; /* not "break" */
11086 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11087 && ckWARN(WARN_PRINTF))
11089 SV * const msg = sv_newmortal();
11090 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11091 (PL_op->op_type == OP_PRTF) ? "" : "s");
11092 if (fmtstart < patend) {
11093 const char * const fmtend = q < patend ? q : patend;
11095 sv_catpvs(msg, "\"%");
11096 for (f = fmtstart; f < fmtend; f++) {
11098 sv_catpvn(msg, f, 1);
11100 Perl_sv_catpvf(aTHX_ msg,
11101 "\\%03"UVof, (UV)*f & 0xFF);
11104 sv_catpvs(msg, "\"");
11106 sv_catpvs(msg, "end of string");
11108 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11111 /* output mangled stuff ... */
11117 /* ... right here, because formatting flags should not apply */
11118 SvGROW(sv, SvCUR(sv) + elen + 1);
11120 Copy(eptr, p, elen, char);
11123 SvCUR_set(sv, p - SvPVX_const(sv));
11125 continue; /* not "break" */
11128 if (is_utf8 != has_utf8) {
11131 sv_utf8_upgrade(sv);
11134 const STRLEN old_elen = elen;
11135 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11136 sv_utf8_upgrade(nsv);
11137 eptr = SvPVX_const(nsv);
11140 if (width) { /* fudge width (can't fudge elen) */
11141 width += elen - old_elen;
11147 have = esignlen + zeros + elen;
11149 Perl_croak_nocontext("%s", PL_memory_wrap);
11151 need = (have > width ? have : width);
11154 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11155 Perl_croak_nocontext("%s", PL_memory_wrap);
11156 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11158 if (esignlen && fill == '0') {
11160 for (i = 0; i < (int)esignlen; i++)
11161 *p++ = esignbuf[i];
11163 if (gap && !left) {
11164 memset(p, fill, gap);
11167 if (esignlen && fill != '0') {
11169 for (i = 0; i < (int)esignlen; i++)
11170 *p++ = esignbuf[i];
11174 for (i = zeros; i; i--)
11178 Copy(eptr, p, elen, char);
11182 memset(p, ' ', gap);
11187 Copy(dotstr, p, dotstrlen, char);
11191 vectorize = FALSE; /* done iterating over vecstr */
11198 SvCUR_set(sv, p - SvPVX_const(sv));
11207 /* =========================================================================
11209 =head1 Cloning an interpreter
11211 All the macros and functions in this section are for the private use of
11212 the main function, perl_clone().
11214 The foo_dup() functions make an exact copy of an existing foo thingy.
11215 During the course of a cloning, a hash table is used to map old addresses
11216 to new addresses. The table is created and manipulated with the
11217 ptr_table_* functions.
11221 * =========================================================================*/
11224 #if defined(USE_ITHREADS)
11226 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11227 #ifndef GpREFCNT_inc
11228 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11232 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11233 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11234 If this changes, please unmerge ss_dup.
11235 Likewise, sv_dup_inc_multiple() relies on this fact. */
11236 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11237 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11238 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11239 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11240 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11241 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11242 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11243 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11244 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11245 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11246 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11247 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11248 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11250 /* clone a parser */
11253 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11257 PERL_ARGS_ASSERT_PARSER_DUP;
11262 /* look for it in the table first */
11263 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11267 /* create anew and remember what it is */
11268 Newxz(parser, 1, yy_parser);
11269 ptr_table_store(PL_ptr_table, proto, parser);
11271 /* XXX these not yet duped */
11272 parser->old_parser = NULL;
11273 parser->stack = NULL;
11275 parser->stack_size = 0;
11276 /* XXX parser->stack->state = 0; */
11278 /* XXX eventually, just Copy() most of the parser struct ? */
11280 parser->lex_brackets = proto->lex_brackets;
11281 parser->lex_casemods = proto->lex_casemods;
11282 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11283 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11284 parser->lex_casestack = savepvn(proto->lex_casestack,
11285 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11286 parser->lex_defer = proto->lex_defer;
11287 parser->lex_dojoin = proto->lex_dojoin;
11288 parser->lex_expect = proto->lex_expect;
11289 parser->lex_formbrack = proto->lex_formbrack;
11290 parser->lex_inpat = proto->lex_inpat;
11291 parser->lex_inwhat = proto->lex_inwhat;
11292 parser->lex_op = proto->lex_op;
11293 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11294 parser->lex_starts = proto->lex_starts;
11295 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11296 parser->multi_close = proto->multi_close;
11297 parser->multi_open = proto->multi_open;
11298 parser->multi_start = proto->multi_start;
11299 parser->multi_end = proto->multi_end;
11300 parser->pending_ident = proto->pending_ident;
11301 parser->preambled = proto->preambled;
11302 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11303 parser->linestr = sv_dup_inc(proto->linestr, param);
11304 parser->expect = proto->expect;
11305 parser->copline = proto->copline;
11306 parser->last_lop_op = proto->last_lop_op;
11307 parser->lex_state = proto->lex_state;
11308 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11309 /* rsfp_filters entries have fake IoDIRP() */
11310 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11311 parser->in_my = proto->in_my;
11312 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11313 parser->error_count = proto->error_count;
11316 parser->linestr = sv_dup_inc(proto->linestr, param);
11319 char * const ols = SvPVX(proto->linestr);
11320 char * const ls = SvPVX(parser->linestr);
11322 parser->bufptr = ls + (proto->bufptr >= ols ?
11323 proto->bufptr - ols : 0);
11324 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11325 proto->oldbufptr - ols : 0);
11326 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11327 proto->oldoldbufptr - ols : 0);
11328 parser->linestart = ls + (proto->linestart >= ols ?
11329 proto->linestart - ols : 0);
11330 parser->last_uni = ls + (proto->last_uni >= ols ?
11331 proto->last_uni - ols : 0);
11332 parser->last_lop = ls + (proto->last_lop >= ols ?
11333 proto->last_lop - ols : 0);
11335 parser->bufend = ls + SvCUR(parser->linestr);
11338 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11342 parser->endwhite = proto->endwhite;
11343 parser->faketokens = proto->faketokens;
11344 parser->lasttoke = proto->lasttoke;
11345 parser->nextwhite = proto->nextwhite;
11346 parser->realtokenstart = proto->realtokenstart;
11347 parser->skipwhite = proto->skipwhite;
11348 parser->thisclose = proto->thisclose;
11349 parser->thismad = proto->thismad;
11350 parser->thisopen = proto->thisopen;
11351 parser->thisstuff = proto->thisstuff;
11352 parser->thistoken = proto->thistoken;
11353 parser->thiswhite = proto->thiswhite;
11355 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11356 parser->curforce = proto->curforce;
11358 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11359 Copy(proto->nexttype, parser->nexttype, 5, I32);
11360 parser->nexttoke = proto->nexttoke;
11363 /* XXX should clone saved_curcop here, but we aren't passed
11364 * proto_perl; so do it in perl_clone_using instead */
11370 /* duplicate a file handle */
11373 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11377 PERL_ARGS_ASSERT_FP_DUP;
11378 PERL_UNUSED_ARG(type);
11381 return (PerlIO*)NULL;
11383 /* look for it in the table first */
11384 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11388 /* create anew and remember what it is */
11389 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11390 ptr_table_store(PL_ptr_table, fp, ret);
11394 /* duplicate a directory handle */
11397 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11403 register const Direntry_t *dirent;
11404 char smallbuf[256];
11410 PERL_UNUSED_CONTEXT;
11411 PERL_ARGS_ASSERT_DIRP_DUP;
11416 /* look for it in the table first */
11417 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11423 PERL_UNUSED_ARG(param);
11427 /* open the current directory (so we can switch back) */
11428 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11430 /* chdir to our dir handle and open the present working directory */
11431 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11432 PerlDir_close(pwd);
11433 return (DIR *)NULL;
11435 /* Now we should have two dir handles pointing to the same dir. */
11437 /* Be nice to the calling code and chdir back to where we were. */
11438 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11440 /* We have no need of the pwd handle any more. */
11441 PerlDir_close(pwd);
11444 # define d_namlen(d) (d)->d_namlen
11446 # define d_namlen(d) strlen((d)->d_name)
11448 /* Iterate once through dp, to get the file name at the current posi-
11449 tion. Then step back. */
11450 pos = PerlDir_tell(dp);
11451 if ((dirent = PerlDir_read(dp))) {
11452 len = d_namlen(dirent);
11453 if (len <= sizeof smallbuf) name = smallbuf;
11454 else Newx(name, len, char);
11455 Move(dirent->d_name, name, len, char);
11457 PerlDir_seek(dp, pos);
11459 /* Iterate through the new dir handle, till we find a file with the
11461 if (!dirent) /* just before the end */
11463 pos = PerlDir_tell(ret);
11464 if (PerlDir_read(ret)) continue; /* not there yet */
11465 PerlDir_seek(ret, pos); /* step back */
11469 const long pos0 = PerlDir_tell(ret);
11471 pos = PerlDir_tell(ret);
11472 if ((dirent = PerlDir_read(ret))) {
11473 if (len == d_namlen(dirent)
11474 && memEQ(name, dirent->d_name, len)) {
11476 PerlDir_seek(ret, pos); /* step back */
11479 /* else we are not there yet; keep iterating */
11481 else { /* This is not meant to happen. The best we can do is
11482 reset the iterator to the beginning. */
11483 PerlDir_seek(ret, pos0);
11490 if (name && name != smallbuf)
11495 ret = win32_dirp_dup(dp, param);
11498 /* pop it in the pointer table */
11500 ptr_table_store(PL_ptr_table, dp, ret);
11505 /* duplicate a typeglob */
11508 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11512 PERL_ARGS_ASSERT_GP_DUP;
11516 /* look for it in the table first */
11517 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11521 /* create anew and remember what it is */
11523 ptr_table_store(PL_ptr_table, gp, ret);
11526 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11527 on Newxz() to do this for us. */
11528 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11529 ret->gp_io = io_dup_inc(gp->gp_io, param);
11530 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11531 ret->gp_av = av_dup_inc(gp->gp_av, param);
11532 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11533 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11534 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11535 ret->gp_cvgen = gp->gp_cvgen;
11536 ret->gp_line = gp->gp_line;
11537 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11541 /* duplicate a chain of magic */
11544 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11546 MAGIC *mgret = NULL;
11547 MAGIC **mgprev_p = &mgret;
11549 PERL_ARGS_ASSERT_MG_DUP;
11551 for (; mg; mg = mg->mg_moremagic) {
11554 if ((param->flags & CLONEf_JOIN_IN)
11555 && mg->mg_type == PERL_MAGIC_backref)
11556 /* when joining, we let the individual SVs add themselves to
11557 * backref as needed. */
11560 Newx(nmg, 1, MAGIC);
11562 mgprev_p = &(nmg->mg_moremagic);
11564 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11565 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11566 from the original commit adding Perl_mg_dup() - revision 4538.
11567 Similarly there is the annotation "XXX random ptr?" next to the
11568 assignment to nmg->mg_ptr. */
11571 /* FIXME for plugins
11572 if (nmg->mg_type == PERL_MAGIC_qr) {
11573 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11577 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11578 ? nmg->mg_type == PERL_MAGIC_backref
11579 /* The backref AV has its reference
11580 * count deliberately bumped by 1 */
11581 ? SvREFCNT_inc(av_dup_inc((const AV *)
11582 nmg->mg_obj, param))
11583 : sv_dup_inc(nmg->mg_obj, param)
11584 : sv_dup(nmg->mg_obj, param);
11586 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11587 if (nmg->mg_len > 0) {
11588 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11589 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11590 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11592 AMT * const namtp = (AMT*)nmg->mg_ptr;
11593 sv_dup_inc_multiple((SV**)(namtp->table),
11594 (SV**)(namtp->table), NofAMmeth, param);
11597 else if (nmg->mg_len == HEf_SVKEY)
11598 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11600 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11601 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11607 #endif /* USE_ITHREADS */
11609 struct ptr_tbl_arena {
11610 struct ptr_tbl_arena *next;
11611 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11614 /* create a new pointer-mapping table */
11617 Perl_ptr_table_new(pTHX)
11620 PERL_UNUSED_CONTEXT;
11622 Newx(tbl, 1, PTR_TBL_t);
11623 tbl->tbl_max = 511;
11624 tbl->tbl_items = 0;
11625 tbl->tbl_arena = NULL;
11626 tbl->tbl_arena_next = NULL;
11627 tbl->tbl_arena_end = NULL;
11628 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11632 #define PTR_TABLE_HASH(ptr) \
11633 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11635 /* map an existing pointer using a table */
11637 STATIC PTR_TBL_ENT_t *
11638 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11640 PTR_TBL_ENT_t *tblent;
11641 const UV hash = PTR_TABLE_HASH(sv);
11643 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11645 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11646 for (; tblent; tblent = tblent->next) {
11647 if (tblent->oldval == sv)
11654 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11656 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11658 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11659 PERL_UNUSED_CONTEXT;
11661 return tblent ? tblent->newval : NULL;
11664 /* add a new entry to a pointer-mapping table */
11667 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11669 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11671 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11672 PERL_UNUSED_CONTEXT;
11675 tblent->newval = newsv;
11677 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11679 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11680 struct ptr_tbl_arena *new_arena;
11682 Newx(new_arena, 1, struct ptr_tbl_arena);
11683 new_arena->next = tbl->tbl_arena;
11684 tbl->tbl_arena = new_arena;
11685 tbl->tbl_arena_next = new_arena->array;
11686 tbl->tbl_arena_end = new_arena->array
11687 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11690 tblent = tbl->tbl_arena_next++;
11692 tblent->oldval = oldsv;
11693 tblent->newval = newsv;
11694 tblent->next = tbl->tbl_ary[entry];
11695 tbl->tbl_ary[entry] = tblent;
11697 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11698 ptr_table_split(tbl);
11702 /* double the hash bucket size of an existing ptr table */
11705 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11707 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11708 const UV oldsize = tbl->tbl_max + 1;
11709 UV newsize = oldsize * 2;
11712 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11713 PERL_UNUSED_CONTEXT;
11715 Renew(ary, newsize, PTR_TBL_ENT_t*);
11716 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11717 tbl->tbl_max = --newsize;
11718 tbl->tbl_ary = ary;
11719 for (i=0; i < oldsize; i++, ary++) {
11720 PTR_TBL_ENT_t **entp = ary;
11721 PTR_TBL_ENT_t *ent = *ary;
11722 PTR_TBL_ENT_t **curentp;
11725 curentp = ary + oldsize;
11727 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11729 ent->next = *curentp;
11739 /* remove all the entries from a ptr table */
11740 /* Deprecated - will be removed post 5.14 */
11743 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11745 if (tbl && tbl->tbl_items) {
11746 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11748 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11751 struct ptr_tbl_arena *next = arena->next;
11757 tbl->tbl_items = 0;
11758 tbl->tbl_arena = NULL;
11759 tbl->tbl_arena_next = NULL;
11760 tbl->tbl_arena_end = NULL;
11764 /* clear and free a ptr table */
11767 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11769 struct ptr_tbl_arena *arena;
11775 arena = tbl->tbl_arena;
11778 struct ptr_tbl_arena *next = arena->next;
11784 Safefree(tbl->tbl_ary);
11788 #if defined(USE_ITHREADS)
11791 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11793 PERL_ARGS_ASSERT_RVPV_DUP;
11796 if (SvWEAKREF(sstr)) {
11797 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11798 if (param->flags & CLONEf_JOIN_IN) {
11799 /* if joining, we add any back references individually rather
11800 * than copying the whole backref array */
11801 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11805 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11807 else if (SvPVX_const(sstr)) {
11808 /* Has something there */
11810 /* Normal PV - clone whole allocated space */
11811 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11812 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11813 /* Not that normal - actually sstr is copy on write.
11814 But we are a true, independent SV, so: */
11815 SvREADONLY_off(dstr);
11820 /* Special case - not normally malloced for some reason */
11821 if (isGV_with_GP(sstr)) {
11822 /* Don't need to do anything here. */
11824 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11825 /* A "shared" PV - clone it as "shared" PV */
11827 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11831 /* Some other special case - random pointer */
11832 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11837 /* Copy the NULL */
11838 SvPV_set(dstr, NULL);
11842 /* duplicate a list of SVs. source and dest may point to the same memory. */
11844 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11845 SSize_t items, CLONE_PARAMS *const param)
11847 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11849 while (items-- > 0) {
11850 *dest++ = sv_dup_inc(*source++, param);
11856 /* duplicate an SV of any type (including AV, HV etc) */
11859 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11864 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11866 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11867 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11872 /* look for it in the table first */
11873 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11877 if(param->flags & CLONEf_JOIN_IN) {
11878 /** We are joining here so we don't want do clone
11879 something that is bad **/
11880 if (SvTYPE(sstr) == SVt_PVHV) {
11881 const HEK * const hvname = HvNAME_HEK(sstr);
11883 /** don't clone stashes if they already exist **/
11884 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11885 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11886 ptr_table_store(PL_ptr_table, sstr, dstr);
11890 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
11891 HV *stash = GvSTASH(sstr);
11892 const HEK * hvname;
11893 if (stash && (hvname = HvNAME_HEK(stash))) {
11894 /** don't clone GVs if they already exist **/
11896 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11897 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
11899 stash, GvNAME(sstr),
11905 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
11906 ptr_table_store(PL_ptr_table, sstr, *svp);
11913 /* create anew and remember what it is */
11916 #ifdef DEBUG_LEAKING_SCALARS
11917 dstr->sv_debug_optype = sstr->sv_debug_optype;
11918 dstr->sv_debug_line = sstr->sv_debug_line;
11919 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11920 dstr->sv_debug_parent = (SV*)sstr;
11921 FREE_SV_DEBUG_FILE(dstr);
11922 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11925 ptr_table_store(PL_ptr_table, sstr, dstr);
11928 SvFLAGS(dstr) = SvFLAGS(sstr);
11929 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11930 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11933 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11934 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11935 (void*)PL_watch_pvx, SvPVX_const(sstr));
11938 /* don't clone objects whose class has asked us not to */
11939 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11944 switch (SvTYPE(sstr)) {
11946 SvANY(dstr) = NULL;
11949 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11951 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11953 SvIV_set(dstr, SvIVX(sstr));
11957 SvANY(dstr) = new_XNV();
11958 SvNV_set(dstr, SvNVX(sstr));
11960 /* case SVt_BIND: */
11963 /* These are all the types that need complex bodies allocating. */
11965 const svtype sv_type = SvTYPE(sstr);
11966 const struct body_details *const sv_type_details
11967 = bodies_by_type + sv_type;
11971 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11986 assert(sv_type_details->body_size);
11987 if (sv_type_details->arena) {
11988 new_body_inline(new_body, sv_type);
11990 = (void*)((char*)new_body - sv_type_details->offset);
11992 new_body = new_NOARENA(sv_type_details);
11996 SvANY(dstr) = new_body;
11999 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
12000 ((char*)SvANY(dstr)) + sv_type_details->offset,
12001 sv_type_details->copy, char);
12003 Copy(((char*)SvANY(sstr)),
12004 ((char*)SvANY(dstr)),
12005 sv_type_details->body_size + sv_type_details->offset, char);
12008 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
12009 && !isGV_with_GP(dstr)
12010 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
12011 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
12013 /* The Copy above means that all the source (unduplicated) pointers
12014 are now in the destination. We can check the flags and the
12015 pointers in either, but it's possible that there's less cache
12016 missing by always going for the destination.
12017 FIXME - instrument and check that assumption */
12018 if (sv_type >= SVt_PVMG) {
12019 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
12020 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
12021 } else if (SvMAGIC(dstr))
12022 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
12024 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
12027 /* The cast silences a GCC warning about unhandled types. */
12028 switch ((int)sv_type) {
12038 /* FIXME for plugins */
12039 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
12042 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
12043 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
12044 LvTARG(dstr) = dstr;
12045 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
12046 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
12048 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
12050 /* non-GP case already handled above */
12051 if(isGV_with_GP(sstr)) {
12052 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12053 /* Don't call sv_add_backref here as it's going to be
12054 created as part of the magic cloning of the symbol
12055 table--unless this is during a join and the stash
12056 is not actually being cloned. */
12057 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12058 at the point of this comment. */
12059 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12060 if (param->flags & CLONEf_JOIN_IN)
12061 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12062 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12063 (void)GpREFCNT_inc(GvGP(dstr));
12067 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12068 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12069 /* I have no idea why fake dirp (rsfps)
12070 should be treated differently but otherwise
12071 we end up with leaks -- sky*/
12072 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12073 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12074 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12076 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12077 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12078 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12079 if (IoDIRP(dstr)) {
12080 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12083 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12085 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12087 if (IoOFP(dstr) == IoIFP(sstr))
12088 IoOFP(dstr) = IoIFP(dstr);
12090 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12091 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12092 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12093 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12096 /* avoid cloning an empty array */
12097 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12098 SV **dst_ary, **src_ary;
12099 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12101 src_ary = AvARRAY((const AV *)sstr);
12102 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12103 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12104 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12105 AvALLOC((const AV *)dstr) = dst_ary;
12106 if (AvREAL((const AV *)sstr)) {
12107 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12111 while (items-- > 0)
12112 *dst_ary++ = sv_dup(*src_ary++, param);
12114 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12115 while (items-- > 0) {
12116 *dst_ary++ = &PL_sv_undef;
12120 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12121 AvALLOC((const AV *)dstr) = (SV**)NULL;
12122 AvMAX( (const AV *)dstr) = -1;
12123 AvFILLp((const AV *)dstr) = -1;
12127 if (HvARRAY((const HV *)sstr)) {
12129 const bool sharekeys = !!HvSHAREKEYS(sstr);
12130 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12131 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12133 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12134 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12136 HvARRAY(dstr) = (HE**)darray;
12137 while (i <= sxhv->xhv_max) {
12138 const HE * const source = HvARRAY(sstr)[i];
12139 HvARRAY(dstr)[i] = source
12140 ? he_dup(source, sharekeys, param) : 0;
12144 const struct xpvhv_aux * const saux = HvAUX(sstr);
12145 struct xpvhv_aux * const daux = HvAUX(dstr);
12146 /* This flag isn't copied. */
12149 if (saux->xhv_name_count) {
12150 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12152 = saux->xhv_name_count < 0
12153 ? -saux->xhv_name_count
12154 : saux->xhv_name_count;
12155 HEK **shekp = sname + count;
12157 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12158 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12159 while (shekp-- > sname) {
12161 *dhekp = hek_dup(*shekp, param);
12165 daux->xhv_name_u.xhvnameu_name
12166 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12169 daux->xhv_name_count = saux->xhv_name_count;
12171 daux->xhv_riter = saux->xhv_riter;
12172 daux->xhv_eiter = saux->xhv_eiter
12173 ? he_dup(saux->xhv_eiter,
12174 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12175 /* backref array needs refcnt=2; see sv_add_backref */
12176 daux->xhv_backreferences =
12177 (param->flags & CLONEf_JOIN_IN)
12178 /* when joining, we let the individual GVs and
12179 * CVs add themselves to backref as
12180 * needed. This avoids pulling in stuff
12181 * that isn't required, and simplifies the
12182 * case where stashes aren't cloned back
12183 * if they already exist in the parent
12186 : saux->xhv_backreferences
12187 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12188 ? MUTABLE_AV(SvREFCNT_inc(
12189 sv_dup_inc((const SV *)
12190 saux->xhv_backreferences, param)))
12191 : MUTABLE_AV(sv_dup((const SV *)
12192 saux->xhv_backreferences, param))
12195 daux->xhv_mro_meta = saux->xhv_mro_meta
12196 ? mro_meta_dup(saux->xhv_mro_meta, param)
12199 /* Record stashes for possible cloning in Perl_clone(). */
12201 av_push(param->stashes, dstr);
12205 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12208 if (!(param->flags & CLONEf_COPY_STACKS)) {
12213 /* NOTE: not refcounted */
12214 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12215 hv_dup(CvSTASH(dstr), param);
12216 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12217 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12218 if (!CvISXSUB(dstr)) {
12220 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12222 } else if (CvCONST(dstr)) {
12223 CvXSUBANY(dstr).any_ptr =
12224 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12226 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12227 /* don't dup if copying back - CvGV isn't refcounted, so the
12228 * duped GV may never be freed. A bit of a hack! DAPM */
12229 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12231 ? gv_dup_inc(CvGV(sstr), param)
12232 : (param->flags & CLONEf_JOIN_IN)
12234 : gv_dup(CvGV(sstr), param);
12236 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12238 CvWEAKOUTSIDE(sstr)
12239 ? cv_dup( CvOUTSIDE(dstr), param)
12240 : cv_dup_inc(CvOUTSIDE(dstr), param);
12246 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12253 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12255 PERL_ARGS_ASSERT_SV_DUP_INC;
12256 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12260 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12262 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12263 PERL_ARGS_ASSERT_SV_DUP;
12265 /* Track every SV that (at least initially) had a reference count of 0.
12266 We need to do this by holding an actual reference to it in this array.
12267 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12268 (akin to the stashes hash, and the perl stack), we come unstuck if
12269 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12270 thread) is manipulated in a CLONE method, because CLONE runs before the
12271 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12272 (and fix things up by giving each a reference via the temps stack).
12273 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12274 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12275 before the walk of unreferenced happens and a reference to that is SV
12276 added to the temps stack. At which point we have the same SV considered
12277 to be in use, and free to be re-used. Not good.
12279 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12280 assert(param->unreferenced);
12281 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12287 /* duplicate a context */
12290 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12292 PERL_CONTEXT *ncxs;
12294 PERL_ARGS_ASSERT_CX_DUP;
12297 return (PERL_CONTEXT*)NULL;
12299 /* look for it in the table first */
12300 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12304 /* create anew and remember what it is */
12305 Newx(ncxs, max + 1, PERL_CONTEXT);
12306 ptr_table_store(PL_ptr_table, cxs, ncxs);
12307 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12310 PERL_CONTEXT * const ncx = &ncxs[ix];
12311 if (CxTYPE(ncx) == CXt_SUBST) {
12312 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12315 ncx->blk_oldcop = (COP*)any_dup(ncx->blk_oldcop, param->proto_perl);
12316 switch (CxTYPE(ncx)) {
12318 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12319 ? cv_dup_inc(ncx->blk_sub.cv, param)
12320 : cv_dup(ncx->blk_sub.cv,param));
12321 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12322 ? av_dup_inc(ncx->blk_sub.argarray,
12325 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12327 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12328 ncx->blk_sub.oldcomppad);
12331 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12333 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12334 ncx->blk_eval.cv = cv_dup(ncx->blk_eval.cv, param);
12336 case CXt_LOOP_LAZYSV:
12337 ncx->blk_loop.state_u.lazysv.end
12338 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12339 /* We are taking advantage of av_dup_inc and sv_dup_inc
12340 actually being the same function, and order equivalence of
12342 We can assert the later [but only at run time :-(] */
12343 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12344 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12346 ncx->blk_loop.state_u.ary.ary
12347 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12348 case CXt_LOOP_LAZYIV:
12349 case CXt_LOOP_PLAIN:
12350 if (CxPADLOOP(ncx)) {
12351 ncx->blk_loop.itervar_u.oldcomppad
12352 = (PAD*)ptr_table_fetch(PL_ptr_table,
12353 ncx->blk_loop.itervar_u.oldcomppad);
12355 ncx->blk_loop.itervar_u.gv
12356 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12361 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12362 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12363 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12378 /* duplicate a stack info structure */
12381 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12385 PERL_ARGS_ASSERT_SI_DUP;
12388 return (PERL_SI*)NULL;
12390 /* look for it in the table first */
12391 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12395 /* create anew and remember what it is */
12396 Newxz(nsi, 1, PERL_SI);
12397 ptr_table_store(PL_ptr_table, si, nsi);
12399 nsi->si_stack = av_dup_inc(si->si_stack, param);
12400 nsi->si_cxix = si->si_cxix;
12401 nsi->si_cxmax = si->si_cxmax;
12402 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12403 nsi->si_type = si->si_type;
12404 nsi->si_prev = si_dup(si->si_prev, param);
12405 nsi->si_next = si_dup(si->si_next, param);
12406 nsi->si_markoff = si->si_markoff;
12411 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12412 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12413 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12414 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12415 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12416 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12417 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12418 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12419 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12420 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12421 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12422 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12423 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12424 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12425 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12426 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12429 #define pv_dup_inc(p) SAVEPV(p)
12430 #define pv_dup(p) SAVEPV(p)
12431 #define svp_dup_inc(p,pp) any_dup(p,pp)
12433 /* map any object to the new equivent - either something in the
12434 * ptr table, or something in the interpreter structure
12438 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12442 PERL_ARGS_ASSERT_ANY_DUP;
12445 return (void*)NULL;
12447 /* look for it in the table first */
12448 ret = ptr_table_fetch(PL_ptr_table, v);
12452 /* see if it is part of the interpreter structure */
12453 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12454 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12462 /* duplicate the save stack */
12465 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12468 ANY * const ss = proto_perl->Isavestack;
12469 const I32 max = proto_perl->Isavestack_max;
12470 I32 ix = proto_perl->Isavestack_ix;
12483 void (*dptr) (void*);
12484 void (*dxptr) (pTHX_ void*);
12486 PERL_ARGS_ASSERT_SS_DUP;
12488 Newxz(nss, max, ANY);
12491 const UV uv = POPUV(ss,ix);
12492 const U8 type = (U8)uv & SAVE_MASK;
12494 TOPUV(nss,ix) = uv;
12496 case SAVEt_CLEARSV:
12498 case SAVEt_HELEM: /* hash element */
12499 sv = (const SV *)POPPTR(ss,ix);
12500 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12502 case SAVEt_ITEM: /* normal string */
12503 case SAVEt_GVSV: /* scalar slot in GV */
12504 case SAVEt_SV: /* scalar reference */
12505 sv = (const SV *)POPPTR(ss,ix);
12506 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12509 case SAVEt_MORTALIZESV:
12510 sv = (const SV *)POPPTR(ss,ix);
12511 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12513 case SAVEt_SHARED_PVREF: /* char* in shared space */
12514 c = (char*)POPPTR(ss,ix);
12515 TOPPTR(nss,ix) = savesharedpv(c);
12516 ptr = POPPTR(ss,ix);
12517 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12519 case SAVEt_GENERIC_SVREF: /* generic sv */
12520 case SAVEt_SVREF: /* scalar reference */
12521 sv = (const SV *)POPPTR(ss,ix);
12522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12523 ptr = POPPTR(ss,ix);
12524 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12526 case SAVEt_HV: /* hash reference */
12527 case SAVEt_AV: /* array reference */
12528 sv = (const SV *) POPPTR(ss,ix);
12529 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12531 case SAVEt_COMPPAD:
12533 sv = (const SV *) POPPTR(ss,ix);
12534 TOPPTR(nss,ix) = sv_dup(sv, param);
12536 case SAVEt_INT: /* int reference */
12537 ptr = POPPTR(ss,ix);
12538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12539 intval = (int)POPINT(ss,ix);
12540 TOPINT(nss,ix) = intval;
12542 case SAVEt_LONG: /* long reference */
12543 ptr = POPPTR(ss,ix);
12544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12545 longval = (long)POPLONG(ss,ix);
12546 TOPLONG(nss,ix) = longval;
12548 case SAVEt_I32: /* I32 reference */
12549 ptr = POPPTR(ss,ix);
12550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12552 TOPINT(nss,ix) = i;
12554 case SAVEt_IV: /* IV reference */
12555 ptr = POPPTR(ss,ix);
12556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12558 TOPIV(nss,ix) = iv;
12560 case SAVEt_HPTR: /* HV* reference */
12561 case SAVEt_APTR: /* AV* reference */
12562 case SAVEt_SPTR: /* SV* reference */
12563 ptr = POPPTR(ss,ix);
12564 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12565 sv = (const SV *)POPPTR(ss,ix);
12566 TOPPTR(nss,ix) = sv_dup(sv, param);
12568 case SAVEt_VPTR: /* random* reference */
12569 ptr = POPPTR(ss,ix);
12570 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12572 case SAVEt_INT_SMALL:
12573 case SAVEt_I32_SMALL:
12574 case SAVEt_I16: /* I16 reference */
12575 case SAVEt_I8: /* I8 reference */
12577 ptr = POPPTR(ss,ix);
12578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12580 case SAVEt_GENERIC_PVREF: /* generic char* */
12581 case SAVEt_PPTR: /* char* reference */
12582 ptr = POPPTR(ss,ix);
12583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12584 c = (char*)POPPTR(ss,ix);
12585 TOPPTR(nss,ix) = pv_dup(c);
12587 case SAVEt_GP: /* scalar reference */
12588 gp = (GP*)POPPTR(ss,ix);
12589 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12590 (void)GpREFCNT_inc(gp);
12591 gv = (const GV *)POPPTR(ss,ix);
12592 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12595 ptr = POPPTR(ss,ix);
12596 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12597 /* these are assumed to be refcounted properly */
12599 switch (((OP*)ptr)->op_type) {
12601 case OP_LEAVESUBLV:
12605 case OP_LEAVEWRITE:
12606 TOPPTR(nss,ix) = ptr;
12609 (void) OpREFCNT_inc(o);
12613 TOPPTR(nss,ix) = NULL;
12618 TOPPTR(nss,ix) = NULL;
12620 case SAVEt_FREECOPHH:
12621 ptr = POPPTR(ss,ix);
12622 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12625 hv = (const HV *)POPPTR(ss,ix);
12626 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12628 TOPINT(nss,ix) = i;
12631 c = (char*)POPPTR(ss,ix);
12632 TOPPTR(nss,ix) = pv_dup_inc(c);
12634 case SAVEt_STACK_POS: /* Position on Perl stack */
12636 TOPINT(nss,ix) = i;
12638 case SAVEt_DESTRUCTOR:
12639 ptr = POPPTR(ss,ix);
12640 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12641 dptr = POPDPTR(ss,ix);
12642 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12643 any_dup(FPTR2DPTR(void *, dptr),
12646 case SAVEt_DESTRUCTOR_X:
12647 ptr = POPPTR(ss,ix);
12648 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12649 dxptr = POPDXPTR(ss,ix);
12650 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12651 any_dup(FPTR2DPTR(void *, dxptr),
12654 case SAVEt_REGCONTEXT:
12656 ix -= uv >> SAVE_TIGHT_SHIFT;
12658 case SAVEt_AELEM: /* array element */
12659 sv = (const SV *)POPPTR(ss,ix);
12660 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12662 TOPINT(nss,ix) = i;
12663 av = (const AV *)POPPTR(ss,ix);
12664 TOPPTR(nss,ix) = av_dup_inc(av, param);
12667 ptr = POPPTR(ss,ix);
12668 TOPPTR(nss,ix) = ptr;
12671 ptr = POPPTR(ss,ix);
12672 ptr = cophh_copy((COPHH*)ptr);
12673 TOPPTR(nss,ix) = ptr;
12675 TOPINT(nss,ix) = i;
12676 if (i & HINT_LOCALIZE_HH) {
12677 hv = (const HV *)POPPTR(ss,ix);
12678 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12681 case SAVEt_PADSV_AND_MORTALIZE:
12682 longval = (long)POPLONG(ss,ix);
12683 TOPLONG(nss,ix) = longval;
12684 ptr = POPPTR(ss,ix);
12685 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12686 sv = (const SV *)POPPTR(ss,ix);
12687 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12689 case SAVEt_SET_SVFLAGS:
12691 TOPINT(nss,ix) = i;
12693 TOPINT(nss,ix) = i;
12694 sv = (const SV *)POPPTR(ss,ix);
12695 TOPPTR(nss,ix) = sv_dup(sv, param);
12697 case SAVEt_RE_STATE:
12699 const struct re_save_state *const old_state
12700 = (struct re_save_state *)
12701 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12702 struct re_save_state *const new_state
12703 = (struct re_save_state *)
12704 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12706 Copy(old_state, new_state, 1, struct re_save_state);
12707 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12709 new_state->re_state_bostr
12710 = pv_dup(old_state->re_state_bostr);
12711 new_state->re_state_reginput
12712 = pv_dup(old_state->re_state_reginput);
12713 new_state->re_state_regeol
12714 = pv_dup(old_state->re_state_regeol);
12715 new_state->re_state_regoffs
12716 = (regexp_paren_pair*)
12717 any_dup(old_state->re_state_regoffs, proto_perl);
12718 new_state->re_state_reglastparen
12719 = (U32*) any_dup(old_state->re_state_reglastparen,
12721 new_state->re_state_reglastcloseparen
12722 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12724 /* XXX This just has to be broken. The old save_re_context
12725 code did SAVEGENERICPV(PL_reg_start_tmp);
12726 PL_reg_start_tmp is char **.
12727 Look above to what the dup code does for
12728 SAVEt_GENERIC_PVREF
12729 It can never have worked.
12730 So this is merely a faithful copy of the exiting bug: */
12731 new_state->re_state_reg_start_tmp
12732 = (char **) pv_dup((char *)
12733 old_state->re_state_reg_start_tmp);
12734 /* I assume that it only ever "worked" because no-one called
12735 (pseudo)fork while the regexp engine had re-entered itself.
12737 #ifdef PERL_OLD_COPY_ON_WRITE
12738 new_state->re_state_nrs
12739 = sv_dup(old_state->re_state_nrs, param);
12741 new_state->re_state_reg_magic
12742 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12744 new_state->re_state_reg_oldcurpm
12745 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12747 new_state->re_state_reg_curpm
12748 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12750 new_state->re_state_reg_oldsaved
12751 = pv_dup(old_state->re_state_reg_oldsaved);
12752 new_state->re_state_reg_poscache
12753 = pv_dup(old_state->re_state_reg_poscache);
12754 new_state->re_state_reg_starttry
12755 = pv_dup(old_state->re_state_reg_starttry);
12758 case SAVEt_COMPILE_WARNINGS:
12759 ptr = POPPTR(ss,ix);
12760 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12763 ptr = POPPTR(ss,ix);
12764 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12768 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12776 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12777 * flag to the result. This is done for each stash before cloning starts,
12778 * so we know which stashes want their objects cloned */
12781 do_mark_cloneable_stash(pTHX_ SV *const sv)
12783 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12785 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12786 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12787 if (cloner && GvCV(cloner)) {
12794 mXPUSHs(newSVhek(hvname));
12796 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12803 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12811 =for apidoc perl_clone
12813 Create and return a new interpreter by cloning the current one.
12815 perl_clone takes these flags as parameters:
12817 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12818 without it we only clone the data and zero the stacks,
12819 with it we copy the stacks and the new perl interpreter is
12820 ready to run at the exact same point as the previous one.
12821 The pseudo-fork code uses COPY_STACKS while the
12822 threads->create doesn't.
12824 CLONEf_KEEP_PTR_TABLE -
12825 perl_clone keeps a ptr_table with the pointer of the old
12826 variable as a key and the new variable as a value,
12827 this allows it to check if something has been cloned and not
12828 clone it again but rather just use the value and increase the
12829 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12830 the ptr_table using the function
12831 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12832 reason to keep it around is if you want to dup some of your own
12833 variable who are outside the graph perl scans, example of this
12834 code is in threads.xs create.
12836 CLONEf_CLONE_HOST -
12837 This is a win32 thing, it is ignored on unix, it tells perls
12838 win32host code (which is c++) to clone itself, this is needed on
12839 win32 if you want to run two threads at the same time,
12840 if you just want to do some stuff in a separate perl interpreter
12841 and then throw it away and return to the original one,
12842 you don't need to do anything.
12847 /* XXX the above needs expanding by someone who actually understands it ! */
12848 EXTERN_C PerlInterpreter *
12849 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12852 perl_clone(PerlInterpreter *proto_perl, UV flags)
12855 #ifdef PERL_IMPLICIT_SYS
12857 PERL_ARGS_ASSERT_PERL_CLONE;
12859 /* perlhost.h so we need to call into it
12860 to clone the host, CPerlHost should have a c interface, sky */
12862 if (flags & CLONEf_CLONE_HOST) {
12863 return perl_clone_host(proto_perl,flags);
12865 return perl_clone_using(proto_perl, flags,
12867 proto_perl->IMemShared,
12868 proto_perl->IMemParse,
12870 proto_perl->IStdIO,
12874 proto_perl->IProc);
12878 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12879 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12880 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12881 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12882 struct IPerlDir* ipD, struct IPerlSock* ipS,
12883 struct IPerlProc* ipP)
12885 /* XXX many of the string copies here can be optimized if they're
12886 * constants; they need to be allocated as common memory and just
12887 * their pointers copied. */
12890 CLONE_PARAMS clone_params;
12891 CLONE_PARAMS* const param = &clone_params;
12893 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12895 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12896 #else /* !PERL_IMPLICIT_SYS */
12898 CLONE_PARAMS clone_params;
12899 CLONE_PARAMS* param = &clone_params;
12900 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12902 PERL_ARGS_ASSERT_PERL_CLONE;
12903 #endif /* PERL_IMPLICIT_SYS */
12905 /* for each stash, determine whether its objects should be cloned */
12906 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12907 PERL_SET_THX(my_perl);
12910 PoisonNew(my_perl, 1, PerlInterpreter);
12913 PL_defstash = NULL; /* may be used by perl malloc() */
12916 PL_scopestack_name = 0;
12918 PL_savestack_ix = 0;
12919 PL_savestack_max = -1;
12920 PL_sig_pending = 0;
12922 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12923 # ifdef DEBUG_LEAKING_SCALARS
12924 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12926 #else /* !DEBUGGING */
12927 Zero(my_perl, 1, PerlInterpreter);
12928 #endif /* DEBUGGING */
12930 #ifdef PERL_IMPLICIT_SYS
12931 /* host pointers */
12933 PL_MemShared = ipMS;
12934 PL_MemParse = ipMP;
12941 #endif /* PERL_IMPLICIT_SYS */
12943 param->flags = flags;
12944 /* Nothing in the core code uses this, but we make it available to
12945 extensions (using mg_dup). */
12946 param->proto_perl = proto_perl;
12947 /* Likely nothing will use this, but it is initialised to be consistent
12948 with Perl_clone_params_new(). */
12949 param->new_perl = my_perl;
12950 param->unreferenced = NULL;
12952 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12954 PL_body_arenas = NULL;
12955 Zero(&PL_body_roots, 1, PL_body_roots);
12958 PL_sv_objcount = 0;
12960 PL_sv_arenaroot = NULL;
12962 PL_debug = proto_perl->Idebug;
12964 PL_hash_seed = proto_perl->Ihash_seed;
12965 PL_rehash_seed = proto_perl->Irehash_seed;
12967 SvANY(&PL_sv_undef) = NULL;
12968 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12969 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12970 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12971 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12972 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12974 SvANY(&PL_sv_yes) = new_XPVNV();
12975 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12976 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12977 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12979 /* dbargs array probably holds garbage */
12982 PL_compiling = proto_perl->Icompiling;
12984 #ifdef PERL_DEBUG_READONLY_OPS
12989 /* pseudo environmental stuff */
12990 PL_origargc = proto_perl->Iorigargc;
12991 PL_origargv = proto_perl->Iorigargv;
12993 /* Set tainting stuff before PerlIO_debug can possibly get called */
12994 PL_tainting = proto_perl->Itainting;
12995 PL_taint_warn = proto_perl->Itaint_warn;
12997 PL_minus_c = proto_perl->Iminus_c;
12999 PL_localpatches = proto_perl->Ilocalpatches;
13000 PL_splitstr = proto_perl->Isplitstr;
13001 PL_minus_n = proto_perl->Iminus_n;
13002 PL_minus_p = proto_perl->Iminus_p;
13003 PL_minus_l = proto_perl->Iminus_l;
13004 PL_minus_a = proto_perl->Iminus_a;
13005 PL_minus_E = proto_perl->Iminus_E;
13006 PL_minus_F = proto_perl->Iminus_F;
13007 PL_doswitches = proto_perl->Idoswitches;
13008 PL_dowarn = proto_perl->Idowarn;
13009 PL_sawampersand = proto_perl->Isawampersand;
13010 PL_unsafe = proto_perl->Iunsafe;
13011 PL_perldb = proto_perl->Iperldb;
13012 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
13013 PL_exit_flags = proto_perl->Iexit_flags;
13015 /* XXX time(&PL_basetime) when asked for? */
13016 PL_basetime = proto_perl->Ibasetime;
13018 PL_maxsysfd = proto_perl->Imaxsysfd;
13019 PL_statusvalue = proto_perl->Istatusvalue;
13021 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
13023 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
13026 /* RE engine related */
13027 Zero(&PL_reg_state, 1, struct re_save_state);
13028 PL_reginterp_cnt = 0;
13029 PL_regmatch_slab = NULL;
13031 PL_sub_generation = proto_perl->Isub_generation;
13033 /* funky return mechanisms */
13034 PL_forkprocess = proto_perl->Iforkprocess;
13036 /* internal state */
13037 PL_maxo = proto_perl->Imaxo;
13039 PL_main_start = proto_perl->Imain_start;
13040 PL_eval_root = proto_perl->Ieval_root;
13041 PL_eval_start = proto_perl->Ieval_start;
13043 PL_filemode = proto_perl->Ifilemode;
13044 PL_lastfd = proto_perl->Ilastfd;
13045 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13048 PL_gensym = proto_perl->Igensym;
13050 PL_laststatval = proto_perl->Ilaststatval;
13051 PL_laststype = proto_perl->Ilaststype;
13054 PL_profiledata = NULL;
13056 PL_generation = proto_perl->Igeneration;
13058 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13059 PL_in_clean_all = proto_perl->Iin_clean_all;
13061 PL_delaymagic_uid = proto_perl->Idelaymagic_uid;
13062 PL_delaymagic_euid = proto_perl->Idelaymagic_euid;
13063 PL_delaymagic_gid = proto_perl->Idelaymagic_gid;
13064 PL_delaymagic_egid = proto_perl->Idelaymagic_egid;
13065 PL_nomemok = proto_perl->Inomemok;
13066 PL_an = proto_perl->Ian;
13067 PL_evalseq = proto_perl->Ievalseq;
13068 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13069 PL_origalen = proto_perl->Iorigalen;
13071 PL_sighandlerp = proto_perl->Isighandlerp;
13073 PL_runops = proto_perl->Irunops;
13075 PL_subline = proto_perl->Isubline;
13078 PL_cryptseen = proto_perl->Icryptseen;
13081 PL_hints = proto_perl->Ihints;
13083 #ifdef USE_LOCALE_COLLATE
13084 PL_collation_ix = proto_perl->Icollation_ix;
13085 PL_collation_standard = proto_perl->Icollation_standard;
13086 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13087 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13088 #endif /* USE_LOCALE_COLLATE */
13090 #ifdef USE_LOCALE_NUMERIC
13091 PL_numeric_standard = proto_perl->Inumeric_standard;
13092 PL_numeric_local = proto_perl->Inumeric_local;
13093 #endif /* !USE_LOCALE_NUMERIC */
13095 /* Did the locale setup indicate UTF-8? */
13096 PL_utf8locale = proto_perl->Iutf8locale;
13097 /* Unicode features (see perlrun/-C) */
13098 PL_unicode = proto_perl->Iunicode;
13100 /* Pre-5.8 signals control */
13101 PL_signals = proto_perl->Isignals;
13103 /* times() ticks per second */
13104 PL_clocktick = proto_perl->Iclocktick;
13106 /* Recursion stopper for PerlIO_find_layer */
13107 PL_in_load_module = proto_perl->Iin_load_module;
13109 /* sort() routine */
13110 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13112 /* Not really needed/useful since the reenrant_retint is "volatile",
13113 * but do it for consistency's sake. */
13114 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13116 /* Hooks to shared SVs and locks. */
13117 PL_sharehook = proto_perl->Isharehook;
13118 PL_lockhook = proto_perl->Ilockhook;
13119 PL_unlockhook = proto_perl->Iunlockhook;
13120 PL_threadhook = proto_perl->Ithreadhook;
13121 PL_destroyhook = proto_perl->Idestroyhook;
13122 PL_signalhook = proto_perl->Isignalhook;
13124 PL_globhook = proto_perl->Iglobhook;
13127 PL_last_swash_hv = NULL; /* reinits on demand */
13128 PL_last_swash_klen = 0;
13129 PL_last_swash_key[0]= '\0';
13130 PL_last_swash_tmps = (U8*)NULL;
13131 PL_last_swash_slen = 0;
13133 PL_glob_index = proto_perl->Iglob_index;
13134 PL_srand_called = proto_perl->Isrand_called;
13136 if (flags & CLONEf_COPY_STACKS) {
13137 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13138 PL_tmps_ix = proto_perl->Itmps_ix;
13139 PL_tmps_max = proto_perl->Itmps_max;
13140 PL_tmps_floor = proto_perl->Itmps_floor;
13142 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13143 * NOTE: unlike the others! */
13144 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13145 PL_scopestack_max = proto_perl->Iscopestack_max;
13147 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13148 * NOTE: unlike the others! */
13149 PL_savestack_ix = proto_perl->Isavestack_ix;
13150 PL_savestack_max = proto_perl->Isavestack_max;
13153 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13154 PL_top_env = &PL_start_env;
13156 PL_op = proto_perl->Iop;
13159 PL_Xpv = (XPV*)NULL;
13160 my_perl->Ina = proto_perl->Ina;
13162 PL_statbuf = proto_perl->Istatbuf;
13163 PL_statcache = proto_perl->Istatcache;
13166 PL_timesbuf = proto_perl->Itimesbuf;
13169 PL_tainted = proto_perl->Itainted;
13170 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13172 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13174 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13175 PL_restartop = proto_perl->Irestartop;
13176 PL_in_eval = proto_perl->Iin_eval;
13177 PL_delaymagic = proto_perl->Idelaymagic;
13178 PL_phase = proto_perl->Iphase;
13179 PL_localizing = proto_perl->Ilocalizing;
13181 PL_hv_fetch_ent_mh = NULL;
13182 PL_modcount = proto_perl->Imodcount;
13183 PL_lastgotoprobe = NULL;
13184 PL_dumpindent = proto_perl->Idumpindent;
13186 PL_efloatbuf = NULL; /* reinits on demand */
13187 PL_efloatsize = 0; /* reinits on demand */
13191 PL_regdummy = proto_perl->Iregdummy;
13192 PL_colorset = 0; /* reinits PL_colors[] */
13193 /*PL_colors[6] = {0,0,0,0,0,0};*/
13195 /* Pluggable optimizer */
13196 PL_peepp = proto_perl->Ipeepp;
13197 PL_rpeepp = proto_perl->Irpeepp;
13198 /* op_free() hook */
13199 PL_opfreehook = proto_perl->Iopfreehook;
13201 #ifdef USE_REENTRANT_API
13202 /* XXX: things like -Dm will segfault here in perlio, but doing
13203 * PERL_SET_CONTEXT(proto_perl);
13204 * breaks too many other things
13206 Perl_reentrant_init(aTHX);
13209 /* create SV map for pointer relocation */
13210 PL_ptr_table = ptr_table_new();
13212 /* initialize these special pointers as early as possible */
13213 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13215 SvANY(&PL_sv_no) = new_XPVNV();
13216 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13217 SvCUR_set(&PL_sv_no, 0);
13218 SvLEN_set(&PL_sv_no, 1);
13219 SvIV_set(&PL_sv_no, 0);
13220 SvNV_set(&PL_sv_no, 0);
13221 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13223 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13224 SvCUR_set(&PL_sv_yes, 1);
13225 SvLEN_set(&PL_sv_yes, 2);
13226 SvIV_set(&PL_sv_yes, 1);
13227 SvNV_set(&PL_sv_yes, 1);
13228 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13230 /* create (a non-shared!) shared string table */
13231 PL_strtab = newHV();
13232 HvSHAREKEYS_off(PL_strtab);
13233 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13234 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13236 /* This PV will be free'd special way so must set it same way op.c does */
13237 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13238 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13240 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13241 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13242 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13243 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13245 param->stashes = newAV(); /* Setup array of objects to call clone on */
13246 /* This makes no difference to the implementation, as it always pushes
13247 and shifts pointers to other SVs without changing their reference
13248 count, with the array becoming empty before it is freed. However, it
13249 makes it conceptually clear what is going on, and will avoid some
13250 work inside av.c, filling slots between AvFILL() and AvMAX() with
13251 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13252 AvREAL_off(param->stashes);
13254 if (!(flags & CLONEf_COPY_STACKS)) {
13255 param->unreferenced = newAV();
13258 #ifdef PERLIO_LAYERS
13259 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13260 PerlIO_clone(aTHX_ proto_perl, param);
13263 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13264 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13265 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13266 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13267 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13268 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13271 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13272 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13273 PL_inplace = SAVEPV(proto_perl->Iinplace);
13274 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13276 /* magical thingies */
13277 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
13279 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13281 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13282 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13283 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13286 /* Clone the regex array */
13287 /* ORANGE FIXME for plugins, probably in the SV dup code.
13288 newSViv(PTR2IV(CALLREGDUPE(
13289 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13291 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13292 PL_regex_pad = AvARRAY(PL_regex_padav);
13294 PL_stashpadmax = proto_perl->Istashpadmax;
13295 PL_stashpadix = proto_perl->Istashpadix ;
13296 Newx(PL_stashpad, PL_stashpadmax, HV *);
13299 for (; o < PL_stashpadmax; ++o)
13300 PL_stashpad[o] = hv_dup(proto_perl->Istashpad[o], param);
13303 /* shortcuts to various I/O objects */
13304 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13305 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13306 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13307 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13308 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13309 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13310 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13312 /* shortcuts to regexp stuff */
13313 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13315 /* shortcuts to misc objects */
13316 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13318 /* shortcuts to debugging objects */
13319 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13320 PL_DBline = gv_dup(proto_perl->IDBline, param);
13321 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13322 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13323 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13324 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13326 /* symbol tables */
13327 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13328 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13329 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13330 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13331 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13333 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13334 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13335 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13336 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13337 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13338 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13339 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13340 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13342 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13344 /* subprocess state */
13345 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13347 if (proto_perl->Iop_mask)
13348 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13351 /* PL_asserting = proto_perl->Iasserting; */
13353 /* current interpreter roots */
13354 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13356 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13359 /* runtime control stuff */
13360 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13362 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13364 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13366 /* interpreter atexit processing */
13367 PL_exitlistlen = proto_perl->Iexitlistlen;
13368 if (PL_exitlistlen) {
13369 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13370 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13373 PL_exitlist = (PerlExitListEntry*)NULL;
13375 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13376 if (PL_my_cxt_size) {
13377 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13378 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13379 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13380 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13381 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13385 PL_my_cxt_list = (void**)NULL;
13386 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13387 PL_my_cxt_keys = (const char**)NULL;
13390 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13391 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13392 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13393 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13395 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13397 PAD_CLONE_VARS(proto_perl, param);
13399 #ifdef HAVE_INTERP_INTERN
13400 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13403 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13405 #ifdef PERL_USES_PL_PIDSTATUS
13406 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13408 PL_osname = SAVEPV(proto_perl->Iosname);
13409 PL_parser = parser_dup(proto_perl->Iparser, param);
13411 /* XXX this only works if the saved cop has already been cloned */
13412 if (proto_perl->Iparser) {
13413 PL_parser->saved_curcop = (COP*)any_dup(
13414 proto_perl->Iparser->saved_curcop,
13418 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13420 #ifdef USE_LOCALE_COLLATE
13421 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13422 #endif /* USE_LOCALE_COLLATE */
13424 #ifdef USE_LOCALE_NUMERIC
13425 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13426 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13427 #endif /* !USE_LOCALE_NUMERIC */
13429 /* Unicode inversion lists */
13430 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13431 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13433 PL_PerlSpace = sv_dup_inc(proto_perl->IPerlSpace, param);
13434 PL_XPerlSpace = sv_dup_inc(proto_perl->IXPerlSpace, param);
13436 PL_L1PosixAlnum = sv_dup_inc(proto_perl->IL1PosixAlnum, param);
13437 PL_PosixAlnum = sv_dup_inc(proto_perl->IPosixAlnum, param);
13439 PL_L1PosixAlpha = sv_dup_inc(proto_perl->IL1PosixAlpha, param);
13440 PL_PosixAlpha = sv_dup_inc(proto_perl->IPosixAlpha, param);
13442 PL_PosixBlank = sv_dup_inc(proto_perl->IPosixBlank, param);
13443 PL_XPosixBlank = sv_dup_inc(proto_perl->IXPosixBlank, param);
13445 PL_L1Cased = sv_dup_inc(proto_perl->IL1Cased, param);
13447 PL_PosixCntrl = sv_dup_inc(proto_perl->IPosixCntrl, param);
13448 PL_XPosixCntrl = sv_dup_inc(proto_perl->IXPosixCntrl, param);
13450 PL_PosixDigit = sv_dup_inc(proto_perl->IPosixDigit, param);
13452 PL_L1PosixGraph = sv_dup_inc(proto_perl->IL1PosixGraph, param);
13453 PL_PosixGraph = sv_dup_inc(proto_perl->IPosixGraph, param);
13455 PL_L1PosixLower = sv_dup_inc(proto_perl->IL1PosixLower, param);
13456 PL_PosixLower = sv_dup_inc(proto_perl->IPosixLower, param);
13458 PL_L1PosixPrint = sv_dup_inc(proto_perl->IL1PosixPrint, param);
13459 PL_PosixPrint = sv_dup_inc(proto_perl->IPosixPrint, param);
13461 PL_L1PosixPunct = sv_dup_inc(proto_perl->IL1PosixPunct, param);
13462 PL_PosixPunct = sv_dup_inc(proto_perl->IPosixPunct, param);
13464 PL_PosixSpace = sv_dup_inc(proto_perl->IPosixSpace, param);
13465 PL_XPosixSpace = sv_dup_inc(proto_perl->IXPosixSpace, param);
13467 PL_L1PosixUpper = sv_dup_inc(proto_perl->IL1PosixUpper, param);
13468 PL_PosixUpper = sv_dup_inc(proto_perl->IPosixUpper, param);
13470 PL_L1PosixWord = sv_dup_inc(proto_perl->IL1PosixWord, param);
13471 PL_PosixWord = sv_dup_inc(proto_perl->IPosixWord, param);
13473 PL_PosixXDigit = sv_dup_inc(proto_perl->IPosixXDigit, param);
13474 PL_XPosixXDigit = sv_dup_inc(proto_perl->IXPosixXDigit, param);
13476 PL_VertSpace = sv_dup_inc(proto_perl->IVertSpace, param);
13478 /* utf8 character class swashes */
13479 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13480 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13481 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13482 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13483 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13484 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13485 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13486 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13487 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13488 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13489 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13490 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13491 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13492 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13493 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13494 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13495 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13496 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13497 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13498 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13499 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13500 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13501 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13502 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13503 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13504 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13505 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13506 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13507 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13508 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13509 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13510 PL_utf8_quotemeta = sv_dup_inc(proto_perl->Iutf8_quotemeta, param);
13511 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13512 PL_AboveLatin1 = sv_dup_inc(proto_perl->IAboveLatin1, param);
13513 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13516 if (proto_perl->Ipsig_pend) {
13517 Newxz(PL_psig_pend, SIG_SIZE, int);
13520 PL_psig_pend = (int*)NULL;
13523 if (proto_perl->Ipsig_name) {
13524 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13525 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13527 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13530 PL_psig_ptr = (SV**)NULL;
13531 PL_psig_name = (SV**)NULL;
13534 if (flags & CLONEf_COPY_STACKS) {
13535 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13536 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13537 PL_tmps_ix+1, param);
13539 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13540 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13541 Newxz(PL_markstack, i, I32);
13542 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13543 - proto_perl->Imarkstack);
13544 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13545 - proto_perl->Imarkstack);
13546 Copy(proto_perl->Imarkstack, PL_markstack,
13547 PL_markstack_ptr - PL_markstack + 1, I32);
13549 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13550 * NOTE: unlike the others! */
13551 Newxz(PL_scopestack, PL_scopestack_max, I32);
13552 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13555 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13556 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13558 /* NOTE: si_dup() looks at PL_markstack */
13559 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13561 /* PL_curstack = PL_curstackinfo->si_stack; */
13562 PL_curstack = av_dup(proto_perl->Icurstack, param);
13563 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13565 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13566 PL_stack_base = AvARRAY(PL_curstack);
13567 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13568 - proto_perl->Istack_base);
13569 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13571 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13572 PL_savestack = ss_dup(proto_perl, param);
13576 ENTER; /* perl_destruct() wants to LEAVE; */
13579 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13580 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13582 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13583 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13584 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13585 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13586 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13587 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13589 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13591 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13592 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13593 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13594 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13596 PL_stashcache = newHV();
13598 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13599 proto_perl->Iwatchaddr);
13600 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13601 if (PL_debug && PL_watchaddr) {
13602 PerlIO_printf(Perl_debug_log,
13603 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13604 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13605 PTR2UV(PL_watchok));
13608 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13609 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13610 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13612 /* Call the ->CLONE method, if it exists, for each of the stashes
13613 identified by sv_dup() above.
13615 while(av_len(param->stashes) != -1) {
13616 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13617 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13618 if (cloner && GvCV(cloner)) {
13623 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13625 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13631 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13632 ptr_table_free(PL_ptr_table);
13633 PL_ptr_table = NULL;
13636 if (!(flags & CLONEf_COPY_STACKS)) {
13637 unreferenced_to_tmp_stack(param->unreferenced);
13640 SvREFCNT_dec(param->stashes);
13642 /* orphaned? eg threads->new inside BEGIN or use */
13643 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13644 SvREFCNT_inc_simple_void(PL_compcv);
13645 SAVEFREESV(PL_compcv);
13652 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13654 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13656 if (AvFILLp(unreferenced) > -1) {
13657 SV **svp = AvARRAY(unreferenced);
13658 SV **const last = svp + AvFILLp(unreferenced);
13662 if (SvREFCNT(*svp) == 1)
13664 } while (++svp <= last);
13666 EXTEND_MORTAL(count);
13667 svp = AvARRAY(unreferenced);
13670 if (SvREFCNT(*svp) == 1) {
13671 /* Our reference is the only one to this SV. This means that
13672 in this thread, the scalar effectively has a 0 reference.
13673 That doesn't work (cleanup never happens), so donate our
13674 reference to it onto the save stack. */
13675 PL_tmps_stack[++PL_tmps_ix] = *svp;
13677 /* As an optimisation, because we are already walking the
13678 entire array, instead of above doing either
13679 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13680 release our reference to the scalar, so that at the end of
13681 the array owns zero references to the scalars it happens to
13682 point to. We are effectively converting the array from
13683 AvREAL() on to AvREAL() off. This saves the av_clear()
13684 (triggered by the SvREFCNT_dec(unreferenced) below) from
13685 walking the array a second time. */
13686 SvREFCNT_dec(*svp);
13689 } while (++svp <= last);
13690 AvREAL_off(unreferenced);
13692 SvREFCNT_dec(unreferenced);
13696 Perl_clone_params_del(CLONE_PARAMS *param)
13698 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13700 PerlInterpreter *const to = param->new_perl;
13702 PerlInterpreter *const was = PERL_GET_THX;
13704 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13710 SvREFCNT_dec(param->stashes);
13711 if (param->unreferenced)
13712 unreferenced_to_tmp_stack(param->unreferenced);
13722 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13725 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13726 does a dTHX; to get the context from thread local storage.
13727 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13728 a version that passes in my_perl. */
13729 PerlInterpreter *const was = PERL_GET_THX;
13730 CLONE_PARAMS *param;
13732 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13738 /* Given that we've set the context, we can do this unshared. */
13739 Newx(param, 1, CLONE_PARAMS);
13742 param->proto_perl = from;
13743 param->new_perl = to;
13744 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13745 AvREAL_off(param->stashes);
13746 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13754 #endif /* USE_ITHREADS */
13757 =head1 Unicode Support
13759 =for apidoc sv_recode_to_utf8
13761 The encoding is assumed to be an Encode object, on entry the PV
13762 of the sv is assumed to be octets in that encoding, and the sv
13763 will be converted into Unicode (and UTF-8).
13765 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13766 is not a reference, nothing is done to the sv. If the encoding is not
13767 an C<Encode::XS> Encoding object, bad things will happen.
13768 (See F<lib/encoding.pm> and L<Encode>.)
13770 The PV of the sv is returned.
13775 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13779 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13781 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13795 Passing sv_yes is wrong - it needs to be or'ed set of constants
13796 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13797 remove converted chars from source.
13799 Both will default the value - let them.
13801 XPUSHs(&PL_sv_yes);
13804 call_method("decode", G_SCALAR);
13808 s = SvPV_const(uni, len);
13809 if (s != SvPVX_const(sv)) {
13810 SvGROW(sv, len + 1);
13811 Move(s, SvPVX(sv), len + 1, char);
13812 SvCUR_set(sv, len);
13816 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13817 /* clear pos and any utf8 cache */
13818 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13821 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13822 magic_setutf8(sv,mg); /* clear UTF8 cache */
13827 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13831 =for apidoc sv_cat_decode
13833 The encoding is assumed to be an Encode object, the PV of the ssv is
13834 assumed to be octets in that encoding and decoding the input starts
13835 from the position which (PV + *offset) pointed to. The dsv will be
13836 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13837 when the string tstr appears in decoding output or the input ends on
13838 the PV of the ssv. The value which the offset points will be modified
13839 to the last input position on the ssv.
13841 Returns TRUE if the terminator was found, else returns FALSE.
13846 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13847 SV *ssv, int *offset, char *tstr, int tlen)
13852 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13854 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13865 offsv = newSViv(*offset);
13867 mXPUSHp(tstr, tlen);
13869 call_method("cat_decode", G_SCALAR);
13871 ret = SvTRUE(TOPs);
13872 *offset = SvIV(offsv);
13878 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13883 /* ---------------------------------------------------------------------
13885 * support functions for report_uninit()
13888 /* the maxiumum size of array or hash where we will scan looking
13889 * for the undefined element that triggered the warning */
13891 #define FUV_MAX_SEARCH_SIZE 1000
13893 /* Look for an entry in the hash whose value has the same SV as val;
13894 * If so, return a mortal copy of the key. */
13897 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13900 register HE **array;
13903 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13905 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13906 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13909 array = HvARRAY(hv);
13911 for (i=HvMAX(hv); i>0; i--) {
13912 register HE *entry;
13913 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13914 if (HeVAL(entry) != val)
13916 if ( HeVAL(entry) == &PL_sv_undef ||
13917 HeVAL(entry) == &PL_sv_placeholder)
13921 if (HeKLEN(entry) == HEf_SVKEY)
13922 return sv_mortalcopy(HeKEY_sv(entry));
13923 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13929 /* Look for an entry in the array whose value has the same SV as val;
13930 * If so, return the index, otherwise return -1. */
13933 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13937 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13939 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13940 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13943 if (val != &PL_sv_undef) {
13944 SV ** const svp = AvARRAY(av);
13947 for (i=AvFILLp(av); i>=0; i--)
13954 /* S_varname(): return the name of a variable, optionally with a subscript.
13955 * If gv is non-zero, use the name of that global, along with gvtype (one
13956 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13957 * targ. Depending on the value of the subscript_type flag, return:
13960 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13961 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13962 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13963 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13966 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13967 const SV *const keyname, I32 aindex, int subscript_type)
13970 SV * const name = sv_newmortal();
13971 if (gv && isGV(gv)) {
13973 buffer[0] = gvtype;
13976 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13978 gv_fullname4(name, gv, buffer, 0);
13980 if ((unsigned int)SvPVX(name)[1] <= 26) {
13982 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13984 /* Swap the 1 unprintable control character for the 2 byte pretty
13985 version - ie substr($name, 1, 1) = $buffer; */
13986 sv_insert(name, 1, 1, buffer, 2);
13990 CV * const cv = gv ? ((CV *)gv) : find_runcv(NULL);
13994 assert(!cv || SvTYPE(cv) == SVt_PVCV);
13996 if (!cv || !CvPADLIST(cv))
13998 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13999 sv = *av_fetch(av, targ, FALSE);
14000 sv_setsv(name, sv);
14003 if (subscript_type == FUV_SUBSCRIPT_HASH) {
14004 SV * const sv = newSV(0);
14005 *SvPVX(name) = '$';
14006 Perl_sv_catpvf(aTHX_ name, "{%s}",
14007 pv_pretty(sv, SvPVX_const(keyname), SvCUR(keyname), 32, NULL, NULL,
14008 PERL_PV_PRETTY_DUMP | PERL_PV_ESCAPE_UNI_DETECT ));
14011 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
14012 *SvPVX(name) = '$';
14013 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
14015 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
14016 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
14017 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
14025 =for apidoc find_uninit_var
14027 Find the name of the undefined variable (if any) that caused the operator
14028 to issue a "Use of uninitialized value" warning.
14029 If match is true, only return a name if its value matches uninit_sv.
14030 So roughly speaking, if a unary operator (such as OP_COS) generates a
14031 warning, then following the direct child of the op may yield an
14032 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
14033 other hand, with OP_ADD there are two branches to follow, so we only print
14034 the variable name if we get an exact match.
14036 The name is returned as a mortal SV.
14038 Assumes that PL_op is the op that originally triggered the error, and that
14039 PL_comppad/PL_curpad points to the currently executing pad.
14045 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
14051 const OP *o, *o2, *kid;
14053 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
14054 uninit_sv == &PL_sv_placeholder)))
14057 switch (obase->op_type) {
14064 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
14065 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
14068 int subscript_type = FUV_SUBSCRIPT_WITHIN;
14070 if (pad) { /* @lex, %lex */
14071 sv = PAD_SVl(obase->op_targ);
14075 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14076 /* @global, %global */
14077 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14080 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
14082 else if (obase == PL_op) /* @{expr}, %{expr} */
14083 return find_uninit_var(cUNOPx(obase)->op_first,
14085 else /* @{expr}, %{expr} as a sub-expression */
14089 /* attempt to find a match within the aggregate */
14091 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14093 subscript_type = FUV_SUBSCRIPT_HASH;
14096 index = find_array_subscript((const AV *)sv, uninit_sv);
14098 subscript_type = FUV_SUBSCRIPT_ARRAY;
14101 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
14104 return varname(gv, hash ? '%' : '@', obase->op_targ,
14105 keysv, index, subscript_type);
14109 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14111 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14112 if (!gv || !GvSTASH(gv))
14114 if (match && (GvSV(gv) != uninit_sv))
14116 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14119 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14122 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14124 return varname(NULL, '$', obase->op_targ,
14125 NULL, 0, FUV_SUBSCRIPT_NONE);
14128 gv = cGVOPx_gv(obase);
14129 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14131 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14133 case OP_AELEMFAST_LEX:
14136 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14137 if (!av || SvRMAGICAL(av))
14139 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14140 if (!svp || *svp != uninit_sv)
14143 return varname(NULL, '$', obase->op_targ,
14144 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14147 gv = cGVOPx_gv(obase);
14152 AV *const av = GvAV(gv);
14153 if (!av || SvRMAGICAL(av))
14155 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14156 if (!svp || *svp != uninit_sv)
14159 return varname(gv, '$', 0,
14160 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14165 o = cUNOPx(obase)->op_first;
14166 if (!o || o->op_type != OP_NULL ||
14167 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14169 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14174 bool negate = FALSE;
14176 if (PL_op == obase)
14177 /* $a[uninit_expr] or $h{uninit_expr} */
14178 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14181 o = cBINOPx(obase)->op_first;
14182 kid = cBINOPx(obase)->op_last;
14184 /* get the av or hv, and optionally the gv */
14186 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14187 sv = PAD_SV(o->op_targ);
14189 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14190 && cUNOPo->op_first->op_type == OP_GV)
14192 gv = cGVOPx_gv(cUNOPo->op_first);
14196 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14201 if (kid && kid->op_type == OP_NEGATE) {
14203 kid = cUNOPx(kid)->op_first;
14206 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14207 /* index is constant */
14210 kidsv = sv_2mortal(newSVpvs("-"));
14211 sv_catsv(kidsv, cSVOPx_sv(kid));
14214 kidsv = cSVOPx_sv(kid);
14218 if (obase->op_type == OP_HELEM) {
14219 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14220 if (!he || HeVAL(he) != uninit_sv)
14224 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14225 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14227 if (!svp || *svp != uninit_sv)
14231 if (obase->op_type == OP_HELEM)
14232 return varname(gv, '%', o->op_targ,
14233 kidsv, 0, FUV_SUBSCRIPT_HASH);
14235 return varname(gv, '@', o->op_targ, NULL,
14236 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14237 FUV_SUBSCRIPT_ARRAY);
14240 /* index is an expression;
14241 * attempt to find a match within the aggregate */
14242 if (obase->op_type == OP_HELEM) {
14243 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14245 return varname(gv, '%', o->op_targ,
14246 keysv, 0, FUV_SUBSCRIPT_HASH);
14250 = find_array_subscript((const AV *)sv, uninit_sv);
14252 return varname(gv, '@', o->op_targ,
14253 NULL, index, FUV_SUBSCRIPT_ARRAY);
14258 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14260 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14266 /* only examine RHS */
14267 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14270 o = cUNOPx(obase)->op_first;
14271 if (o->op_type == OP_PUSHMARK)
14274 if (!o->op_sibling) {
14275 /* one-arg version of open is highly magical */
14277 if (o->op_type == OP_GV) { /* open FOO; */
14279 if (match && GvSV(gv) != uninit_sv)
14281 return varname(gv, '$', 0,
14282 NULL, 0, FUV_SUBSCRIPT_NONE);
14284 /* other possibilities not handled are:
14285 * open $x; or open my $x; should return '${*$x}'
14286 * open expr; should return '$'.expr ideally
14292 /* ops where $_ may be an implicit arg */
14297 if ( !(obase->op_flags & OPf_STACKED)) {
14298 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14299 ? PAD_SVl(obase->op_targ)
14302 sv = sv_newmortal();
14303 sv_setpvs(sv, "$_");
14312 match = 1; /* print etc can return undef on defined args */
14313 /* skip filehandle as it can't produce 'undef' warning */
14314 o = cUNOPx(obase)->op_first;
14315 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14316 o = o->op_sibling->op_sibling;
14320 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14321 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14323 /* the following ops are capable of returning PL_sv_undef even for
14324 * defined arg(s) */
14343 case OP_GETPEERNAME:
14391 case OP_SMARTMATCH:
14400 /* XXX tmp hack: these two may call an XS sub, and currently
14401 XS subs don't have a SUB entry on the context stack, so CV and
14402 pad determination goes wrong, and BAD things happen. So, just
14403 don't try to determine the value under those circumstances.
14404 Need a better fix at dome point. DAPM 11/2007 */
14410 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14411 if (gv && GvSV(gv) == uninit_sv)
14412 return newSVpvs_flags("$.", SVs_TEMP);
14417 /* def-ness of rval pos() is independent of the def-ness of its arg */
14418 if ( !(obase->op_flags & OPf_MOD))
14423 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14424 return newSVpvs_flags("${$/}", SVs_TEMP);
14429 if (!(obase->op_flags & OPf_KIDS))
14431 o = cUNOPx(obase)->op_first;
14437 /* This loop checks all the kid ops, skipping any that cannot pos-
14438 * sibly be responsible for the uninitialized value; i.e., defined
14439 * constants and ops that return nothing. If there is only one op
14440 * left that is not skipped, then we *know* it is responsible for
14441 * the uninitialized value. If there is more than one op left, we
14442 * have to look for an exact match in the while() loop below.
14445 for (kid=o; kid; kid = kid->op_sibling) {
14447 const OPCODE type = kid->op_type;
14448 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14449 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14450 || (type == OP_PUSHMARK)
14454 if (o2) { /* more than one found */
14461 return find_uninit_var(o2, uninit_sv, match);
14463 /* scan all args */
14465 sv = find_uninit_var(o, uninit_sv, 1);
14477 =for apidoc report_uninit
14479 Print appropriate "Use of uninitialized variable" warning.
14485 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14489 SV* varname = NULL;
14490 if (uninit_sv && PL_curpad) {
14491 varname = find_uninit_var(PL_op, uninit_sv,0);
14493 sv_insert(varname, 0, 0, " ", 1);
14495 /* diag_listed_as: Use of uninitialized value%s */
14496 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14497 SVfARG(varname ? varname : &PL_sv_no),
14498 " in ", OP_DESC(PL_op));
14501 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14507 * c-indentation-style: bsd
14508 * c-basic-offset: 4
14509 * indent-tabs-mode: nil
14512 * ex: set ts=8 sts=4 sw=4 et: