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 SV *const buffer = sv_newmortal();
1823 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1825 gv_efullname3(buffer, gv, "*");
1827 /* We know that all GVs stringify to something that is not-a-number,
1828 so no need to test that. */
1829 if (ckWARN(WARN_NUMERIC))
1830 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_2uv_flags
2337 Return the unsigned integer value of an SV, doing any necessary string
2338 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2339 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2345 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2350 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2351 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2352 the same flag bit as SVf_IVisUV, so must not let them cache IVs. */
2353 if (flags & SV_GMAGIC)
2358 return U_V(SvNVX(sv));
2359 if (SvPOKp(sv) && SvLEN(sv)) {
2362 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2364 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2365 == IS_NUMBER_IN_UV) {
2366 /* It's definitely an integer */
2367 if (!(numtype & IS_NUMBER_NEG))
2371 if (ckWARN(WARN_NUMERIC))
2374 return U_V(Atof(SvPVX_const(sv)));
2379 assert(SvTYPE(sv) >= SVt_PVMG);
2380 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2381 } else if (SvTHINKFIRST(sv)) {
2386 if (flags & SV_SKIP_OVERLOAD)
2388 tmpstr = AMG_CALLunary(sv, numer_amg);
2389 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2390 return SvUV(tmpstr);
2393 return PTR2UV(SvRV(sv));
2396 sv_force_normal_flags(sv, 0);
2398 if (SvREADONLY(sv) && !SvOK(sv)) {
2399 if (ckWARN(WARN_UNINITIALIZED))
2405 if (S_sv_2iuv_common(aTHX_ sv))
2409 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2410 PTR2UV(sv),SvUVX(sv)));
2411 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2415 =for apidoc sv_2nv_flags
2417 Return the num value of an SV, doing any necessary string or integer
2418 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2419 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2425 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2430 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2431 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2432 the same flag bit as SVf_IVisUV, so must not let them cache NVs. */
2433 if (flags & SV_GMAGIC)
2437 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2438 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2439 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2441 return Atof(SvPVX_const(sv));
2445 return (NV)SvUVX(sv);
2447 return (NV)SvIVX(sv);
2452 assert(SvTYPE(sv) >= SVt_PVMG);
2453 /* This falls through to the report_uninit near the end of the
2455 } else if (SvTHINKFIRST(sv)) {
2460 if (flags & SV_SKIP_OVERLOAD)
2462 tmpstr = AMG_CALLunary(sv, numer_amg);
2463 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2464 return SvNV(tmpstr);
2467 return PTR2NV(SvRV(sv));
2470 sv_force_normal_flags(sv, 0);
2472 if (SvREADONLY(sv) && !SvOK(sv)) {
2473 if (ckWARN(WARN_UNINITIALIZED))
2478 if (SvTYPE(sv) < SVt_NV) {
2479 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2480 sv_upgrade(sv, SVt_NV);
2481 #ifdef USE_LONG_DOUBLE
2483 STORE_NUMERIC_LOCAL_SET_STANDARD();
2484 PerlIO_printf(Perl_debug_log,
2485 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2486 PTR2UV(sv), SvNVX(sv));
2487 RESTORE_NUMERIC_LOCAL();
2491 STORE_NUMERIC_LOCAL_SET_STANDARD();
2492 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2493 PTR2UV(sv), SvNVX(sv));
2494 RESTORE_NUMERIC_LOCAL();
2498 else if (SvTYPE(sv) < SVt_PVNV)
2499 sv_upgrade(sv, SVt_PVNV);
2504 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2505 #ifdef NV_PRESERVES_UV
2511 /* Only set the public NV OK flag if this NV preserves the IV */
2512 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2514 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2515 : (SvIVX(sv) == I_V(SvNVX(sv))))
2521 else if (SvPOKp(sv) && SvLEN(sv)) {
2523 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2524 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2526 #ifdef NV_PRESERVES_UV
2527 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2528 == IS_NUMBER_IN_UV) {
2529 /* It's definitely an integer */
2530 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2532 SvNV_set(sv, Atof(SvPVX_const(sv)));
2538 SvNV_set(sv, Atof(SvPVX_const(sv)));
2539 /* Only set the public NV OK flag if this NV preserves the value in
2540 the PV at least as well as an IV/UV would.
2541 Not sure how to do this 100% reliably. */
2542 /* if that shift count is out of range then Configure's test is
2543 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2545 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2546 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2547 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2548 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2549 /* Can't use strtol etc to convert this string, so don't try.
2550 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2553 /* value has been set. It may not be precise. */
2554 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2555 /* 2s complement assumption for (UV)IV_MIN */
2556 SvNOK_on(sv); /* Integer is too negative. */
2561 if (numtype & IS_NUMBER_NEG) {
2562 SvIV_set(sv, -(IV)value);
2563 } else if (value <= (UV)IV_MAX) {
2564 SvIV_set(sv, (IV)value);
2566 SvUV_set(sv, value);
2570 if (numtype & IS_NUMBER_NOT_INT) {
2571 /* I believe that even if the original PV had decimals,
2572 they are lost beyond the limit of the FP precision.
2573 However, neither is canonical, so both only get p
2574 flags. NWC, 2000/11/25 */
2575 /* Both already have p flags, so do nothing */
2577 const NV nv = SvNVX(sv);
2578 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2579 if (SvIVX(sv) == I_V(nv)) {
2582 /* It had no "." so it must be integer. */
2586 /* between IV_MAX and NV(UV_MAX).
2587 Could be slightly > UV_MAX */
2589 if (numtype & IS_NUMBER_NOT_INT) {
2590 /* UV and NV both imprecise. */
2592 const UV nv_as_uv = U_V(nv);
2594 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2603 /* It might be more code efficient to go through the entire logic above
2604 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2605 gets complex and potentially buggy, so more programmer efficient
2606 to do it this way, by turning off the public flags: */
2608 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2609 #endif /* NV_PRESERVES_UV */
2612 if (isGV_with_GP(sv)) {
2613 glob_2number(MUTABLE_GV(sv));
2617 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2619 assert (SvTYPE(sv) >= SVt_NV);
2620 /* Typically the caller expects that sv_any is not NULL now. */
2621 /* XXX Ilya implies that this is a bug in callers that assume this
2622 and ideally should be fixed. */
2625 #if defined(USE_LONG_DOUBLE)
2627 STORE_NUMERIC_LOCAL_SET_STANDARD();
2628 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2629 PTR2UV(sv), SvNVX(sv));
2630 RESTORE_NUMERIC_LOCAL();
2634 STORE_NUMERIC_LOCAL_SET_STANDARD();
2635 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2636 PTR2UV(sv), SvNVX(sv));
2637 RESTORE_NUMERIC_LOCAL();
2646 Return an SV with the numeric value of the source SV, doing any necessary
2647 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2648 access this function.
2654 Perl_sv_2num(pTHX_ register SV *const sv)
2656 PERL_ARGS_ASSERT_SV_2NUM;
2661 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2662 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2663 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2664 return sv_2num(tmpsv);
2666 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2669 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2670 * UV as a string towards the end of buf, and return pointers to start and
2673 * We assume that buf is at least TYPE_CHARS(UV) long.
2677 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2679 char *ptr = buf + TYPE_CHARS(UV);
2680 char * const ebuf = ptr;
2683 PERL_ARGS_ASSERT_UIV_2BUF;
2695 *--ptr = '0' + (char)(uv % 10);
2704 =for apidoc sv_2pv_flags
2706 Returns a pointer to the string value of an SV, and sets *lp to its length.
2707 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2708 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2709 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2715 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2725 if (SvGMAGICAL(sv)) {
2726 if (flags & SV_GMAGIC)
2731 if (flags & SV_MUTABLE_RETURN)
2732 return SvPVX_mutable(sv);
2733 if (flags & SV_CONST_RETURN)
2734 return (char *)SvPVX_const(sv);
2737 if (SvIOKp(sv) || SvNOKp(sv)) {
2738 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2743 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2744 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2745 } else if(SvNVX(sv) == 0.0) {
2750 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2757 SvUPGRADE(sv, SVt_PV);
2760 s = SvGROW_mutable(sv, len + 1);
2763 return (char*)memcpy(s, tbuf, len + 1);
2769 assert(SvTYPE(sv) >= SVt_PVMG);
2770 /* This falls through to the report_uninit near the end of the
2772 } else if (SvTHINKFIRST(sv)) {
2777 if (flags & SV_SKIP_OVERLOAD)
2779 tmpstr = AMG_CALLunary(sv, string_amg);
2780 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2781 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2783 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2787 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2788 if (flags & SV_CONST_RETURN) {
2789 pv = (char *) SvPVX_const(tmpstr);
2791 pv = (flags & SV_MUTABLE_RETURN)
2792 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2795 *lp = SvCUR(tmpstr);
2797 pv = sv_2pv_flags(tmpstr, lp, flags);
2810 SV *const referent = SvRV(sv);
2814 retval = buffer = savepvn("NULLREF", len);
2815 } else if (SvTYPE(referent) == SVt_REGEXP && (
2816 !(PL_curcop->cop_hints & HINT_NO_AMAGIC)
2817 || amagic_is_enabled(string_amg)
2819 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2824 /* If the regex is UTF-8 we want the containing scalar to
2825 have an UTF-8 flag too */
2831 if ((seen_evals = RX_SEEN_EVALS(re)))
2832 PL_reginterp_cnt += seen_evals;
2835 *lp = RX_WRAPLEN(re);
2837 return RX_WRAPPED(re);
2839 const char *const typestr = sv_reftype(referent, 0);
2840 const STRLEN typelen = strlen(typestr);
2841 UV addr = PTR2UV(referent);
2842 const char *stashname = NULL;
2843 STRLEN stashnamelen = 0; /* hush, gcc */
2844 const char *buffer_end;
2846 if (SvOBJECT(referent)) {
2847 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2850 stashname = HEK_KEY(name);
2851 stashnamelen = HEK_LEN(name);
2853 if (HEK_UTF8(name)) {
2859 stashname = "__ANON__";
2862 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2863 + 2 * sizeof(UV) + 2 /* )\0 */;
2865 len = typelen + 3 /* (0x */
2866 + 2 * sizeof(UV) + 2 /* )\0 */;
2869 Newx(buffer, len, char);
2870 buffer_end = retval = buffer + len;
2872 /* Working backwards */
2876 *--retval = PL_hexdigit[addr & 15];
2877 } while (addr >>= 4);
2883 memcpy(retval, typestr, typelen);
2887 retval -= stashnamelen;
2888 memcpy(retval, stashname, stashnamelen);
2890 /* retval may not necessarily have reached the start of the
2892 assert (retval >= buffer);
2894 len = buffer_end - retval - 1; /* -1 for that \0 */
2902 if (SvREADONLY(sv) && !SvOK(sv)) {
2905 if (flags & SV_UNDEF_RETURNS_NULL)
2907 if (ckWARN(WARN_UNINITIALIZED))
2912 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2913 /* I'm assuming that if both IV and NV are equally valid then
2914 converting the IV is going to be more efficient */
2915 const U32 isUIOK = SvIsUV(sv);
2916 char buf[TYPE_CHARS(UV)];
2920 if (SvTYPE(sv) < SVt_PVIV)
2921 sv_upgrade(sv, SVt_PVIV);
2922 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2924 /* inlined from sv_setpvn */
2925 s = SvGROW_mutable(sv, len + 1);
2926 Move(ptr, s, len, char);
2930 else if (SvNOKp(sv)) {
2931 if (SvTYPE(sv) < SVt_PVNV)
2932 sv_upgrade(sv, SVt_PVNV);
2933 if (SvNVX(sv) == 0.0) {
2934 s = SvGROW_mutable(sv, 2);
2939 /* The +20 is pure guesswork. Configure test needed. --jhi */
2940 s = SvGROW_mutable(sv, NV_DIG + 20);
2941 /* some Xenix systems wipe out errno here */
2942 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2952 if (isGV_with_GP(sv)) {
2953 GV *const gv = MUTABLE_GV(sv);
2954 SV *const buffer = sv_newmortal();
2956 gv_efullname3(buffer, gv, "*");
2958 assert(SvPOK(buffer));
2960 *lp = SvCUR(buffer);
2962 if ( SvUTF8(buffer) ) SvUTF8_on(sv);
2963 return SvPVX(buffer);
2968 if (flags & SV_UNDEF_RETURNS_NULL)
2970 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2972 if (SvTYPE(sv) < SVt_PV)
2973 /* Typically the caller expects that sv_any is not NULL now. */
2974 sv_upgrade(sv, SVt_PV);
2978 const STRLEN len = s - SvPVX_const(sv);
2984 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2985 PTR2UV(sv),SvPVX_const(sv)));
2986 if (flags & SV_CONST_RETURN)
2987 return (char *)SvPVX_const(sv);
2988 if (flags & SV_MUTABLE_RETURN)
2989 return SvPVX_mutable(sv);
2994 =for apidoc sv_copypv
2996 Copies a stringified representation of the source SV into the
2997 destination SV. Automatically performs any necessary mg_get and
2998 coercion of numeric values into strings. Guaranteed to preserve
2999 UTF8 flag even from overloaded objects. Similar in nature to
3000 sv_2pv[_flags] but operates directly on an SV instead of just the
3001 string. Mostly uses sv_2pv_flags to do its work, except when that
3002 would lose the UTF-8'ness of the PV.
3008 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3011 const char * const s = SvPV_const(ssv,len);
3013 PERL_ARGS_ASSERT_SV_COPYPV;
3015 sv_setpvn(dsv,s,len);
3023 =for apidoc sv_2pvbyte
3025 Return a pointer to the byte-encoded representation of the SV, and set *lp
3026 to its length. May cause the SV to be downgraded from UTF-8 as a
3029 Usually accessed via the C<SvPVbyte> macro.
3035 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *const lp)
3037 PERL_ARGS_ASSERT_SV_2PVBYTE;
3039 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv)) {
3040 SV *sv2 = sv_newmortal();
3044 else SvGETMAGIC(sv);
3045 sv_utf8_downgrade(sv,0);
3046 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3050 =for apidoc sv_2pvutf8
3052 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3053 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3055 Usually accessed via the C<SvPVutf8> macro.
3061 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *const lp)
3063 PERL_ARGS_ASSERT_SV_2PVUTF8;
3065 if ((SvTHINKFIRST(sv) && !SvIsCOW(sv)) || isGV_with_GP(sv))
3066 sv = sv_mortalcopy(sv);
3067 sv_utf8_upgrade(sv);
3068 if (SvGMAGICAL(sv)) SvFLAGS(sv) &= ~SVf_POK;
3070 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3075 =for apidoc sv_2bool
3077 This macro is only used by sv_true() or its macro equivalent, and only if
3078 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3079 It calls sv_2bool_flags with the SV_GMAGIC flag.
3081 =for apidoc sv_2bool_flags
3083 This function is only used by sv_true() and friends, and only if
3084 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3085 contain SV_GMAGIC, then it does an mg_get() first.
3092 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3096 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3098 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3104 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3105 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3106 return cBOOL(SvTRUE(tmpsv));
3108 return SvRV(sv) != 0;
3111 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3113 (*sv->sv_u.svu_pv > '0' ||
3114 Xpvtmp->xpv_cur > 1 ||
3115 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3122 return SvIVX(sv) != 0;
3125 return SvNVX(sv) != 0.0;
3127 if (isGV_with_GP(sv))
3137 =for apidoc sv_utf8_upgrade
3139 Converts the PV of an SV to its UTF-8-encoded form.
3140 Forces the SV to string form if it is not already.
3141 Will C<mg_get> on C<sv> if appropriate.
3142 Always sets the SvUTF8 flag to avoid future validity checks even
3143 if the whole string is the same in UTF-8 as not.
3144 Returns the number of bytes in the converted string
3146 This is not as a general purpose byte encoding to Unicode interface:
3147 use the Encode extension for that.
3149 =for apidoc sv_utf8_upgrade_nomg
3151 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3153 =for apidoc sv_utf8_upgrade_flags
3155 Converts the PV of an SV to its UTF-8-encoded form.
3156 Forces the SV to string form if it is not already.
3157 Always sets the SvUTF8 flag to avoid future validity checks even
3158 if all the bytes are invariant in UTF-8.
3159 If C<flags> has C<SV_GMAGIC> bit set,
3160 will C<mg_get> on C<sv> if appropriate, else not.
3161 Returns the number of bytes in the converted string
3162 C<sv_utf8_upgrade> and
3163 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3165 This is not as a general purpose byte encoding to Unicode interface:
3166 use the Encode extension for that.
3170 The grow version is currently not externally documented. It adds a parameter,
3171 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3172 have free after it upon return. This allows the caller to reserve extra space
3173 that it intends to fill, to avoid extra grows.
3175 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3176 which can be used to tell this function to not first check to see if there are
3177 any characters that are different in UTF-8 (variant characters) which would
3178 force it to allocate a new string to sv, but to assume there are. Typically
3179 this flag is used by a routine that has already parsed the string to find that
3180 there are such characters, and passes this information on so that the work
3181 doesn't have to be repeated.
3183 (One might think that the calling routine could pass in the position of the
3184 first such variant, so it wouldn't have to be found again. But that is not the
3185 case, because typically when the caller is likely to use this flag, it won't be
3186 calling this routine unless it finds something that won't fit into a byte.
3187 Otherwise it tries to not upgrade and just use bytes. But some things that
3188 do fit into a byte are variants in utf8, and the caller may not have been
3189 keeping track of these.)
3191 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3192 isn't guaranteed due to having other routines do the work in some input cases,
3193 or if the input is already flagged as being in utf8.
3195 The speed of this could perhaps be improved for many cases if someone wanted to
3196 write a fast function that counts the number of variant characters in a string,
3197 especially if it could return the position of the first one.
3202 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3206 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3208 if (sv == &PL_sv_undef)
3212 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3213 (void) sv_2pv_flags(sv,&len, flags);
3215 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3219 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3224 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3229 sv_force_normal_flags(sv, 0);
3232 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3233 sv_recode_to_utf8(sv, PL_encoding);
3234 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3238 if (SvCUR(sv) == 0) {
3239 if (extra) SvGROW(sv, extra);
3240 } else { /* Assume Latin-1/EBCDIC */
3241 /* This function could be much more efficient if we
3242 * had a FLAG in SVs to signal if there are any variant
3243 * chars in the PV. Given that there isn't such a flag
3244 * make the loop as fast as possible (although there are certainly ways
3245 * to speed this up, eg. through vectorization) */
3246 U8 * s = (U8 *) SvPVX_const(sv);
3247 U8 * e = (U8 *) SvEND(sv);
3249 STRLEN two_byte_count = 0;
3251 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3253 /* See if really will need to convert to utf8. We mustn't rely on our
3254 * incoming SV being well formed and having a trailing '\0', as certain
3255 * code in pp_formline can send us partially built SVs. */
3259 if (NATIVE_IS_INVARIANT(ch)) continue;
3261 t--; /* t already incremented; re-point to first variant */
3266 /* utf8 conversion not needed because all are invariants. Mark as
3267 * UTF-8 even if no variant - saves scanning loop */
3269 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3274 /* Here, the string should be converted to utf8, either because of an
3275 * input flag (two_byte_count = 0), or because a character that
3276 * requires 2 bytes was found (two_byte_count = 1). t points either to
3277 * the beginning of the string (if we didn't examine anything), or to
3278 * the first variant. In either case, everything from s to t - 1 will
3279 * occupy only 1 byte each on output.
3281 * There are two main ways to convert. One is to create a new string
3282 * and go through the input starting from the beginning, appending each
3283 * converted value onto the new string as we go along. It's probably
3284 * best to allocate enough space in the string for the worst possible
3285 * case rather than possibly running out of space and having to
3286 * reallocate and then copy what we've done so far. Since everything
3287 * from s to t - 1 is invariant, the destination can be initialized
3288 * with these using a fast memory copy
3290 * The other way is to figure out exactly how big the string should be
3291 * by parsing the entire input. Then you don't have to make it big
3292 * enough to handle the worst possible case, and more importantly, if
3293 * the string you already have is large enough, you don't have to
3294 * allocate a new string, you can copy the last character in the input
3295 * string to the final position(s) that will be occupied by the
3296 * converted string and go backwards, stopping at t, since everything
3297 * before that is invariant.
3299 * There are advantages and disadvantages to each method.
3301 * In the first method, we can allocate a new string, do the memory
3302 * copy from the s to t - 1, and then proceed through the rest of the
3303 * string byte-by-byte.
3305 * In the second method, we proceed through the rest of the input
3306 * string just calculating how big the converted string will be. Then
3307 * there are two cases:
3308 * 1) if the string has enough extra space to handle the converted
3309 * value. We go backwards through the string, converting until we
3310 * get to the position we are at now, and then stop. If this
3311 * position is far enough along in the string, this method is
3312 * faster than the other method. If the memory copy were the same
3313 * speed as the byte-by-byte loop, that position would be about
3314 * half-way, as at the half-way mark, parsing to the end and back
3315 * is one complete string's parse, the same amount as starting
3316 * over and going all the way through. Actually, it would be
3317 * somewhat less than half-way, as it's faster to just count bytes
3318 * than to also copy, and we don't have the overhead of allocating
3319 * a new string, changing the scalar to use it, and freeing the
3320 * existing one. But if the memory copy is fast, the break-even
3321 * point is somewhere after half way. The counting loop could be
3322 * sped up by vectorization, etc, to move the break-even point
3323 * further towards the beginning.
3324 * 2) if the string doesn't have enough space to handle the converted
3325 * value. A new string will have to be allocated, and one might
3326 * as well, given that, start from the beginning doing the first
3327 * method. We've spent extra time parsing the string and in
3328 * exchange all we've gotten is that we know precisely how big to
3329 * make the new one. Perl is more optimized for time than space,
3330 * so this case is a loser.
3331 * So what I've decided to do is not use the 2nd method unless it is
3332 * guaranteed that a new string won't have to be allocated, assuming
3333 * the worst case. I also decided not to put any more conditions on it
3334 * than this, for now. It seems likely that, since the worst case is
3335 * twice as big as the unknown portion of the string (plus 1), we won't
3336 * be guaranteed enough space, causing us to go to the first method,
3337 * unless the string is short, or the first variant character is near
3338 * the end of it. In either of these cases, it seems best to use the
3339 * 2nd method. The only circumstance I can think of where this would
3340 * be really slower is if the string had once had much more data in it
3341 * than it does now, but there is still a substantial amount in it */
3344 STRLEN invariant_head = t - s;
3345 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3346 if (SvLEN(sv) < size) {
3348 /* Here, have decided to allocate a new string */
3353 Newx(dst, size, U8);
3355 /* If no known invariants at the beginning of the input string,
3356 * set so starts from there. Otherwise, can use memory copy to
3357 * get up to where we are now, and then start from here */
3359 if (invariant_head <= 0) {
3362 Copy(s, dst, invariant_head, char);
3363 d = dst + invariant_head;
3367 const UV uv = NATIVE8_TO_UNI(*t++);
3368 if (UNI_IS_INVARIANT(uv))
3369 *d++ = (U8)UNI_TO_NATIVE(uv);
3371 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3372 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3376 SvPV_free(sv); /* No longer using pre-existing string */
3377 SvPV_set(sv, (char*)dst);
3378 SvCUR_set(sv, d - dst);
3379 SvLEN_set(sv, size);
3382 /* Here, have decided to get the exact size of the string.
3383 * Currently this happens only when we know that there is
3384 * guaranteed enough space to fit the converted string, so
3385 * don't have to worry about growing. If two_byte_count is 0,
3386 * then t points to the first byte of the string which hasn't
3387 * been examined yet. Otherwise two_byte_count is 1, and t
3388 * points to the first byte in the string that will expand to
3389 * two. Depending on this, start examining at t or 1 after t.
3392 U8 *d = t + two_byte_count;
3395 /* Count up the remaining bytes that expand to two */
3398 const U8 chr = *d++;
3399 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3402 /* The string will expand by just the number of bytes that
3403 * occupy two positions. But we are one afterwards because of
3404 * the increment just above. This is the place to put the
3405 * trailing NUL, and to set the length before we decrement */
3407 d += two_byte_count;
3408 SvCUR_set(sv, d - s);
3412 /* Having decremented d, it points to the position to put the
3413 * very last byte of the expanded string. Go backwards through
3414 * the string, copying and expanding as we go, stopping when we
3415 * get to the part that is invariant the rest of the way down */
3419 const U8 ch = NATIVE8_TO_UNI(*e--);
3420 if (UNI_IS_INVARIANT(ch)) {
3421 *d-- = UNI_TO_NATIVE(ch);
3423 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3424 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3429 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3430 /* Update pos. We do it at the end rather than during
3431 * the upgrade, to avoid slowing down the common case
3432 * (upgrade without pos) */
3433 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3435 I32 pos = mg->mg_len;
3436 if (pos > 0 && (U32)pos > invariant_head) {
3437 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3438 STRLEN n = (U32)pos - invariant_head;
3440 if (UTF8_IS_START(*d))
3445 mg->mg_len = d - (U8*)SvPVX(sv);
3448 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3449 magic_setutf8(sv,mg); /* clear UTF8 cache */
3454 /* Mark as UTF-8 even if no variant - saves scanning loop */
3460 =for apidoc sv_utf8_downgrade
3462 Attempts to convert the PV of an SV from characters to bytes.
3463 If the PV contains a character that cannot fit
3464 in a byte, this conversion will fail;
3465 in this case, either returns false or, if C<fail_ok> is not
3468 This is not as a general purpose Unicode to byte encoding interface:
3469 use the Encode extension for that.
3475 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3479 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3481 if (SvPOKp(sv) && SvUTF8(sv)) {
3485 int mg_flags = SV_GMAGIC;
3488 sv_force_normal_flags(sv, 0);
3490 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3492 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3494 I32 pos = mg->mg_len;
3496 sv_pos_b2u(sv, &pos);
3497 mg_flags = 0; /* sv_pos_b2u does get magic */
3501 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3502 magic_setutf8(sv,mg); /* clear UTF8 cache */
3505 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3507 if (!utf8_to_bytes(s, &len)) {
3512 Perl_croak(aTHX_ "Wide character in %s",
3515 Perl_croak(aTHX_ "Wide character");
3526 =for apidoc sv_utf8_encode
3528 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3529 flag off so that it looks like octets again.
3535 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3537 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3539 if (SvREADONLY(sv)) {
3540 sv_force_normal_flags(sv, 0);
3542 (void) sv_utf8_upgrade(sv);
3547 =for apidoc sv_utf8_decode
3549 If the PV of the SV is an octet sequence in UTF-8
3550 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3551 so that it looks like a character. If the PV contains only single-byte
3552 characters, the C<SvUTF8> flag stays off.
3553 Scans PV for validity and returns false if the PV is invalid UTF-8.
3559 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3561 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3564 const U8 *start, *c;
3567 /* The octets may have got themselves encoded - get them back as
3570 if (!sv_utf8_downgrade(sv, TRUE))
3573 /* it is actually just a matter of turning the utf8 flag on, but
3574 * we want to make sure everything inside is valid utf8 first.
3576 c = start = (const U8 *) SvPVX_const(sv);
3577 if (!is_utf8_string(c, SvCUR(sv)))
3579 e = (const U8 *) SvEND(sv);
3582 if (!UTF8_IS_INVARIANT(ch)) {
3587 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3588 /* adjust pos to the start of a UTF8 char sequence */
3589 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3591 I32 pos = mg->mg_len;
3593 for (c = start + pos; c > start; c--) {
3594 if (UTF8_IS_START(*c))
3597 mg->mg_len = c - start;
3600 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3601 magic_setutf8(sv,mg); /* clear UTF8 cache */
3608 =for apidoc sv_setsv
3610 Copies the contents of the source SV C<ssv> into the destination SV
3611 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3612 function if the source SV needs to be reused. Does not handle 'set' magic.
3613 Loosely speaking, it performs a copy-by-value, obliterating any previous
3614 content of the destination.
3616 You probably want to use one of the assortment of wrappers, such as
3617 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3618 C<SvSetMagicSV_nosteal>.
3620 =for apidoc sv_setsv_flags
3622 Copies the contents of the source SV C<ssv> into the destination SV
3623 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3624 function if the source SV needs to be reused. Does not handle 'set' magic.
3625 Loosely speaking, it performs a copy-by-value, obliterating any previous
3626 content of the destination.
3627 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3628 C<ssv> if appropriate, else not. If the C<flags>
3629 parameter has the C<NOSTEAL> bit set then the
3630 buffers of temps will not be stolen. <sv_setsv>
3631 and C<sv_setsv_nomg> are implemented in terms of this function.
3633 You probably want to use one of the assortment of wrappers, such as
3634 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3635 C<SvSetMagicSV_nosteal>.
3637 This is the primary function for copying scalars, and most other
3638 copy-ish functions and macros use this underneath.
3644 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3646 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3647 HV *old_stash = NULL;
3649 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3651 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3652 const char * const name = GvNAME(sstr);
3653 const STRLEN len = GvNAMELEN(sstr);
3655 if (dtype >= SVt_PV) {
3661 SvUPGRADE(dstr, SVt_PVGV);
3662 (void)SvOK_off(dstr);
3663 /* We have to turn this on here, even though we turn it off
3664 below, as GvSTASH will fail an assertion otherwise. */
3665 isGV_with_GP_on(dstr);
3667 GvSTASH(dstr) = GvSTASH(sstr);
3669 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3670 gv_name_set(MUTABLE_GV(dstr), name, len,
3671 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3672 SvFAKE_on(dstr); /* can coerce to non-glob */
3675 if(GvGP(MUTABLE_GV(sstr))) {
3676 /* If source has method cache entry, clear it */
3678 SvREFCNT_dec(GvCV(sstr));
3679 GvCV_set(sstr, NULL);
3682 /* If source has a real method, then a method is
3685 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3691 /* If dest already had a real method, that's a change as well */
3693 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3694 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3699 /* We don't need to check the name of the destination if it was not a
3700 glob to begin with. */
3701 if(dtype == SVt_PVGV) {
3702 const char * const name = GvNAME((const GV *)dstr);
3705 /* The stash may have been detached from the symbol table, so
3707 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3708 && GvAV((const GV *)sstr)
3712 const STRLEN len = GvNAMELEN(dstr);
3713 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3714 || (len == 1 && name[0] == ':')) {
3717 /* Set aside the old stash, so we can reset isa caches on
3719 if((old_stash = GvHV(dstr)))
3720 /* Make sure we do not lose it early. */
3721 SvREFCNT_inc_simple_void_NN(
3722 sv_2mortal((SV *)old_stash)
3728 gp_free(MUTABLE_GV(dstr));
3729 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3730 (void)SvOK_off(dstr);
3731 isGV_with_GP_on(dstr);
3732 GvINTRO_off(dstr); /* one-shot flag */
3733 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3734 if (SvTAINTED(sstr))
3736 if (GvIMPORTED(dstr) != GVf_IMPORTED
3737 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3739 GvIMPORTED_on(dstr);
3742 if(mro_changes == 2) {
3744 SV * const sref = (SV *)GvAV((const GV *)dstr);
3745 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3746 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3747 AV * const ary = newAV();
3748 av_push(ary, mg->mg_obj); /* takes the refcount */
3749 mg->mg_obj = (SV *)ary;
3751 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3753 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3754 mro_isa_changed_in(GvSTASH(dstr));
3756 else if(mro_changes == 3) {
3757 HV * const stash = GvHV(dstr);
3758 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3764 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3769 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3771 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3773 const int intro = GvINTRO(dstr);
3776 const U32 stype = SvTYPE(sref);
3778 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3781 GvINTRO_off(dstr); /* one-shot flag */
3782 GvLINE(dstr) = CopLINE(PL_curcop);
3783 GvEGV(dstr) = MUTABLE_GV(dstr);
3788 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3789 import_flag = GVf_IMPORTED_CV;
3792 location = (SV **) &GvHV(dstr);
3793 import_flag = GVf_IMPORTED_HV;
3796 location = (SV **) &GvAV(dstr);
3797 import_flag = GVf_IMPORTED_AV;
3800 location = (SV **) &GvIOp(dstr);
3803 location = (SV **) &GvFORM(dstr);
3806 location = &GvSV(dstr);
3807 import_flag = GVf_IMPORTED_SV;
3810 if (stype == SVt_PVCV) {
3811 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3812 if (GvCVGEN(dstr)) {
3813 SvREFCNT_dec(GvCV(dstr));
3814 GvCV_set(dstr, NULL);
3815 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3818 SAVEGENERICSV(*location);
3822 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3823 CV* const cv = MUTABLE_CV(*location);
3825 if (!GvCVGEN((const GV *)dstr) &&
3826 (CvROOT(cv) || CvXSUB(cv)) &&
3827 /* redundant check that avoids creating the extra SV
3828 most of the time: */
3829 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3831 SV * const new_const_sv =
3832 CvCONST((const CV *)sref)
3833 ? cv_const_sv((const CV *)sref)
3835 report_redefined_cv(
3836 sv_2mortal(Perl_newSVpvf(aTHX_
3839 HvNAME_HEK(GvSTASH((const GV *)dstr))
3841 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3844 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3848 cv_ckproto_len_flags(cv, (const GV *)dstr,
3849 SvPOK(sref) ? CvPROTO(sref) : NULL,
3850 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3851 SvPOK(sref) ? SvUTF8(sref) : 0);
3853 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3854 GvASSUMECV_on(dstr);
3855 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3858 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3859 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3860 GvFLAGS(dstr) |= import_flag;
3862 if (stype == SVt_PVHV) {
3863 const char * const name = GvNAME((GV*)dstr);
3864 const STRLEN len = GvNAMELEN(dstr);
3867 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3868 || (len == 1 && name[0] == ':')
3870 && (!dref || HvENAME_get(dref))
3873 (HV *)sref, (HV *)dref,
3879 stype == SVt_PVAV && sref != dref
3880 && strEQ(GvNAME((GV*)dstr), "ISA")
3881 /* The stash may have been detached from the symbol table, so
3882 check its name before doing anything. */
3883 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3886 MAGIC * const omg = dref && SvSMAGICAL(dref)
3887 ? mg_find(dref, PERL_MAGIC_isa)
3889 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3890 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3891 AV * const ary = newAV();
3892 av_push(ary, mg->mg_obj); /* takes the refcount */
3893 mg->mg_obj = (SV *)ary;
3896 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3897 SV **svp = AvARRAY((AV *)omg->mg_obj);
3898 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3902 SvREFCNT_inc_simple_NN(*svp++)
3908 SvREFCNT_inc_simple_NN(omg->mg_obj)
3912 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3917 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3919 mg = mg_find(sref, PERL_MAGIC_isa);
3921 /* Since the *ISA assignment could have affected more than
3922 one stash, don't call mro_isa_changed_in directly, but let
3923 magic_clearisa do it for us, as it already has the logic for
3924 dealing with globs vs arrays of globs. */
3926 Perl_magic_clearisa(aTHX_ NULL, mg);
3931 if (SvTAINTED(sstr))
3937 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3940 register U32 sflags;
3942 register svtype stype;
3944 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3949 if (SvIS_FREED(dstr)) {
3950 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3951 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3953 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3955 sstr = &PL_sv_undef;
3956 if (SvIS_FREED(sstr)) {
3957 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3958 (void*)sstr, (void*)dstr);
3960 stype = SvTYPE(sstr);
3961 dtype = SvTYPE(dstr);
3963 (void)SvAMAGIC_off(dstr);
3966 /* need to nuke the magic */
3967 sv_unmagic(dstr, PERL_MAGIC_vstring);
3970 /* There's a lot of redundancy below but we're going for speed here */
3975 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3976 (void)SvOK_off(dstr);
3984 sv_upgrade(dstr, SVt_IV);
3988 sv_upgrade(dstr, SVt_PVIV);
3992 goto end_of_first_switch;
3994 (void)SvIOK_only(dstr);
3995 SvIV_set(dstr, SvIVX(sstr));
3998 /* SvTAINTED can only be true if the SV has taint magic, which in
3999 turn means that the SV type is PVMG (or greater). This is the
4000 case statement for SVt_IV, so this cannot be true (whatever gcov
4002 assert(!SvTAINTED(sstr));
4007 if (dtype < SVt_PV && dtype != SVt_IV)
4008 sv_upgrade(dstr, SVt_IV);
4016 sv_upgrade(dstr, SVt_NV);
4020 sv_upgrade(dstr, SVt_PVNV);
4024 goto end_of_first_switch;
4026 SvNV_set(dstr, SvNVX(sstr));
4027 (void)SvNOK_only(dstr);
4028 /* SvTAINTED can only be true if the SV has taint magic, which in
4029 turn means that the SV type is PVMG (or greater). This is the
4030 case statement for SVt_NV, so this cannot be true (whatever gcov
4032 assert(!SvTAINTED(sstr));
4038 #ifdef PERL_OLD_COPY_ON_WRITE
4039 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4040 if (dtype < SVt_PVIV)
4041 sv_upgrade(dstr, SVt_PVIV);
4048 sv_upgrade(dstr, SVt_PV);
4051 if (dtype < SVt_PVIV)
4052 sv_upgrade(dstr, SVt_PVIV);
4055 if (dtype < SVt_PVNV)
4056 sv_upgrade(dstr, SVt_PVNV);
4060 const char * const type = sv_reftype(sstr,0);
4062 /* diag_listed_as: Bizarre copy of %s */
4063 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4065 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4070 if (dtype < SVt_REGEXP)
4071 sv_upgrade(dstr, SVt_REGEXP);
4074 /* case SVt_BIND: */
4078 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4080 if (SvTYPE(sstr) != stype)
4081 stype = SvTYPE(sstr);
4083 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4084 glob_assign_glob(dstr, sstr, dtype);
4087 if (stype == SVt_PVLV)
4088 SvUPGRADE(dstr, SVt_PVNV);
4090 SvUPGRADE(dstr, (svtype)stype);
4092 end_of_first_switch:
4094 /* dstr may have been upgraded. */
4095 dtype = SvTYPE(dstr);
4096 sflags = SvFLAGS(sstr);
4098 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4099 /* Assigning to a subroutine sets the prototype. */
4102 const char *const ptr = SvPV_const(sstr, len);
4104 SvGROW(dstr, len + 1);
4105 Copy(ptr, SvPVX(dstr), len + 1, char);
4106 SvCUR_set(dstr, len);
4108 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4109 CvAUTOLOAD_off(dstr);
4113 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4114 const char * const type = sv_reftype(dstr,0);
4116 /* diag_listed_as: Cannot copy to %s */
4117 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4119 Perl_croak(aTHX_ "Cannot copy to %s", type);
4120 } else if (sflags & SVf_ROK) {
4121 if (isGV_with_GP(dstr)
4122 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4125 if (GvIMPORTED(dstr) != GVf_IMPORTED
4126 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4128 GvIMPORTED_on(dstr);
4133 glob_assign_glob(dstr, sstr, dtype);
4137 if (dtype >= SVt_PV) {
4138 if (isGV_with_GP(dstr)) {
4139 glob_assign_ref(dstr, sstr);
4142 if (SvPVX_const(dstr)) {
4148 (void)SvOK_off(dstr);
4149 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4150 SvFLAGS(dstr) |= sflags & SVf_ROK;
4151 assert(!(sflags & SVp_NOK));
4152 assert(!(sflags & SVp_IOK));
4153 assert(!(sflags & SVf_NOK));
4154 assert(!(sflags & SVf_IOK));
4156 else if (isGV_with_GP(dstr)) {
4157 if (!(sflags & SVf_OK)) {
4158 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4159 "Undefined value assigned to typeglob");
4162 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4163 if (dstr != (const SV *)gv) {
4164 const char * const name = GvNAME((const GV *)dstr);
4165 const STRLEN len = GvNAMELEN(dstr);
4166 HV *old_stash = NULL;
4167 bool reset_isa = FALSE;
4168 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4169 || (len == 1 && name[0] == ':')) {
4170 /* Set aside the old stash, so we can reset isa caches
4171 on its subclasses. */
4172 if((old_stash = GvHV(dstr))) {
4173 /* Make sure we do not lose it early. */
4174 SvREFCNT_inc_simple_void_NN(
4175 sv_2mortal((SV *)old_stash)
4182 gp_free(MUTABLE_GV(dstr));
4183 GvGP_set(dstr, gp_ref(GvGP(gv)));
4186 HV * const stash = GvHV(dstr);
4188 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4198 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4199 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4201 else if (sflags & SVp_POK) {
4205 * Check to see if we can just swipe the string. If so, it's a
4206 * possible small lose on short strings, but a big win on long ones.
4207 * It might even be a win on short strings if SvPVX_const(dstr)
4208 * has to be allocated and SvPVX_const(sstr) has to be freed.
4209 * Likewise if we can set up COW rather than doing an actual copy, we
4210 * drop to the else clause, as the swipe code and the COW setup code
4211 * have much in common.
4214 /* Whichever path we take through the next code, we want this true,
4215 and doing it now facilitates the COW check. */
4216 (void)SvPOK_only(dstr);
4219 /* If we're already COW then this clause is not true, and if COW
4220 is allowed then we drop down to the else and make dest COW
4221 with us. If caller hasn't said that we're allowed to COW
4222 shared hash keys then we don't do the COW setup, even if the
4223 source scalar is a shared hash key scalar. */
4224 (((flags & SV_COW_SHARED_HASH_KEYS)
4225 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4226 : 1 /* If making a COW copy is forbidden then the behaviour we
4227 desire is as if the source SV isn't actually already
4228 COW, even if it is. So we act as if the source flags
4229 are not COW, rather than actually testing them. */
4231 #ifndef PERL_OLD_COPY_ON_WRITE
4232 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4233 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4234 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4235 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4236 but in turn, it's somewhat dead code, never expected to go
4237 live, but more kept as a placeholder on how to do it better
4238 in a newer implementation. */
4239 /* If we are COW and dstr is a suitable target then we drop down
4240 into the else and make dest a COW of us. */
4241 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4246 (sflags & SVs_TEMP) && /* slated for free anyway? */
4247 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4248 (!(flags & SV_NOSTEAL)) &&
4249 /* and we're allowed to steal temps */
4250 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4251 SvLEN(sstr)) /* and really is a string */
4252 #ifdef PERL_OLD_COPY_ON_WRITE
4253 && ((flags & SV_COW_SHARED_HASH_KEYS)
4254 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4255 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4256 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4260 /* Failed the swipe test, and it's not a shared hash key either.
4261 Have to copy the string. */
4262 STRLEN len = SvCUR(sstr);
4263 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4264 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4265 SvCUR_set(dstr, len);
4266 *SvEND(dstr) = '\0';
4268 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4270 /* Either it's a shared hash key, or it's suitable for
4271 copy-on-write or we can swipe the string. */
4273 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4277 #ifdef PERL_OLD_COPY_ON_WRITE
4279 if ((sflags & (SVf_FAKE | SVf_READONLY))
4280 != (SVf_FAKE | SVf_READONLY)) {
4281 SvREADONLY_on(sstr);
4283 /* Make the source SV into a loop of 1.
4284 (about to become 2) */
4285 SV_COW_NEXT_SV_SET(sstr, sstr);
4289 /* Initial code is common. */
4290 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4295 /* making another shared SV. */
4296 STRLEN cur = SvCUR(sstr);
4297 STRLEN len = SvLEN(sstr);
4298 #ifdef PERL_OLD_COPY_ON_WRITE
4300 assert (SvTYPE(dstr) >= SVt_PVIV);
4301 /* SvIsCOW_normal */
4302 /* splice us in between source and next-after-source. */
4303 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4304 SV_COW_NEXT_SV_SET(sstr, dstr);
4305 SvPV_set(dstr, SvPVX_mutable(sstr));
4309 /* SvIsCOW_shared_hash */
4310 DEBUG_C(PerlIO_printf(Perl_debug_log,
4311 "Copy on write: Sharing hash\n"));
4313 assert (SvTYPE(dstr) >= SVt_PV);
4315 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4317 SvLEN_set(dstr, len);
4318 SvCUR_set(dstr, cur);
4319 SvREADONLY_on(dstr);
4323 { /* Passes the swipe test. */
4324 SvPV_set(dstr, SvPVX_mutable(sstr));
4325 SvLEN_set(dstr, SvLEN(sstr));
4326 SvCUR_set(dstr, SvCUR(sstr));
4329 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4330 SvPV_set(sstr, NULL);
4336 if (sflags & SVp_NOK) {
4337 SvNV_set(dstr, SvNVX(sstr));
4339 if (sflags & SVp_IOK) {
4340 SvIV_set(dstr, SvIVX(sstr));
4341 /* Must do this otherwise some other overloaded use of 0x80000000
4342 gets confused. I guess SVpbm_VALID */
4343 if (sflags & SVf_IVisUV)
4346 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4348 const MAGIC * const smg = SvVSTRING_mg(sstr);
4350 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4351 smg->mg_ptr, smg->mg_len);
4352 SvRMAGICAL_on(dstr);
4356 else if (sflags & (SVp_IOK|SVp_NOK)) {
4357 (void)SvOK_off(dstr);
4358 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4359 if (sflags & SVp_IOK) {
4360 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4361 SvIV_set(dstr, SvIVX(sstr));
4363 if (sflags & SVp_NOK) {
4364 SvNV_set(dstr, SvNVX(sstr));
4368 if (isGV_with_GP(sstr)) {
4369 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4372 (void)SvOK_off(dstr);
4374 if (SvTAINTED(sstr))
4379 =for apidoc sv_setsv_mg
4381 Like C<sv_setsv>, but also handles 'set' magic.
4387 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4389 PERL_ARGS_ASSERT_SV_SETSV_MG;
4391 sv_setsv(dstr,sstr);
4395 #ifdef PERL_OLD_COPY_ON_WRITE
4397 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4399 STRLEN cur = SvCUR(sstr);
4400 STRLEN len = SvLEN(sstr);
4401 register char *new_pv;
4403 PERL_ARGS_ASSERT_SV_SETSV_COW;
4406 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4407 (void*)sstr, (void*)dstr);
4414 if (SvTHINKFIRST(dstr))
4415 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4416 else if (SvPVX_const(dstr))
4417 Safefree(SvPVX_const(dstr));
4421 SvUPGRADE(dstr, SVt_PVIV);
4423 assert (SvPOK(sstr));
4424 assert (SvPOKp(sstr));
4425 assert (!SvIOK(sstr));
4426 assert (!SvIOKp(sstr));
4427 assert (!SvNOK(sstr));
4428 assert (!SvNOKp(sstr));
4430 if (SvIsCOW(sstr)) {
4432 if (SvLEN(sstr) == 0) {
4433 /* source is a COW shared hash key. */
4434 DEBUG_C(PerlIO_printf(Perl_debug_log,
4435 "Fast copy on write: Sharing hash\n"));
4436 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4439 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4441 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4442 SvUPGRADE(sstr, SVt_PVIV);
4443 SvREADONLY_on(sstr);
4445 DEBUG_C(PerlIO_printf(Perl_debug_log,
4446 "Fast copy on write: Converting sstr to COW\n"));
4447 SV_COW_NEXT_SV_SET(dstr, sstr);
4449 SV_COW_NEXT_SV_SET(sstr, dstr);
4450 new_pv = SvPVX_mutable(sstr);
4453 SvPV_set(dstr, new_pv);
4454 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4457 SvLEN_set(dstr, len);
4458 SvCUR_set(dstr, cur);
4467 =for apidoc sv_setpvn
4469 Copies a string into an SV. The C<len> parameter indicates the number of
4470 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4471 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4477 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4480 register char *dptr;
4482 PERL_ARGS_ASSERT_SV_SETPVN;
4484 SV_CHECK_THINKFIRST_COW_DROP(sv);
4490 /* len is STRLEN which is unsigned, need to copy to signed */
4493 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4496 SvUPGRADE(sv, SVt_PV);
4498 dptr = SvGROW(sv, len + 1);
4499 Move(ptr,dptr,len,char);
4502 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4504 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4508 =for apidoc sv_setpvn_mg
4510 Like C<sv_setpvn>, but also handles 'set' magic.
4516 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4518 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4520 sv_setpvn(sv,ptr,len);
4525 =for apidoc sv_setpv
4527 Copies a string into an SV. The string must be null-terminated. Does not
4528 handle 'set' magic. See C<sv_setpv_mg>.
4534 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4537 register STRLEN len;
4539 PERL_ARGS_ASSERT_SV_SETPV;
4541 SV_CHECK_THINKFIRST_COW_DROP(sv);
4547 SvUPGRADE(sv, SVt_PV);
4549 SvGROW(sv, len + 1);
4550 Move(ptr,SvPVX(sv),len+1,char);
4552 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4554 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4558 =for apidoc sv_setpv_mg
4560 Like C<sv_setpv>, but also handles 'set' magic.
4566 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4568 PERL_ARGS_ASSERT_SV_SETPV_MG;
4575 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4579 PERL_ARGS_ASSERT_SV_SETHEK;
4585 if (HEK_LEN(hek) == HEf_SVKEY) {
4586 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4589 const int flags = HEK_FLAGS(hek);
4590 if (flags & HVhek_WASUTF8) {
4591 STRLEN utf8_len = HEK_LEN(hek);
4592 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4593 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4596 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4597 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4600 else SvUTF8_off(sv);
4604 SV_CHECK_THINKFIRST_COW_DROP(sv);
4605 SvUPGRADE(sv, SVt_PV);
4606 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4607 SvCUR_set(sv, HEK_LEN(hek));
4614 else SvUTF8_off(sv);
4622 =for apidoc sv_usepvn_flags
4624 Tells an SV to use C<ptr> to find its string value. Normally the
4625 string is stored inside the SV but sv_usepvn allows the SV to use an
4626 outside string. The C<ptr> should point to memory that was allocated
4627 by C<malloc>. It must be the start of a mallocked block
4628 of memory, and not a pointer to the middle of it. The
4629 string length, C<len>, must be supplied. By default
4630 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4631 so that pointer should not be freed or used by the programmer after
4632 giving it to sv_usepvn, and neither should any pointers from "behind"
4633 that pointer (e.g. ptr + 1) be used.
4635 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4636 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4637 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4638 C<len>, and already meets the requirements for storing in C<SvPVX>).
4644 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4649 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4651 SV_CHECK_THINKFIRST_COW_DROP(sv);
4652 SvUPGRADE(sv, SVt_PV);
4655 if (flags & SV_SMAGIC)
4659 if (SvPVX_const(sv))
4663 if (flags & SV_HAS_TRAILING_NUL)
4664 assert(ptr[len] == '\0');
4667 allocate = (flags & SV_HAS_TRAILING_NUL)
4669 #ifdef Perl_safesysmalloc_size
4672 PERL_STRLEN_ROUNDUP(len + 1);
4674 if (flags & SV_HAS_TRAILING_NUL) {
4675 /* It's long enough - do nothing.
4676 Specifically Perl_newCONSTSUB is relying on this. */
4679 /* Force a move to shake out bugs in callers. */
4680 char *new_ptr = (char*)safemalloc(allocate);
4681 Copy(ptr, new_ptr, len, char);
4682 PoisonFree(ptr,len,char);
4686 ptr = (char*) saferealloc (ptr, allocate);
4689 #ifdef Perl_safesysmalloc_size
4690 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4692 SvLEN_set(sv, allocate);
4696 if (!(flags & SV_HAS_TRAILING_NUL)) {
4699 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4701 if (flags & SV_SMAGIC)
4705 #ifdef PERL_OLD_COPY_ON_WRITE
4706 /* Need to do this *after* making the SV normal, as we need the buffer
4707 pointer to remain valid until after we've copied it. If we let go too early,
4708 another thread could invalidate it by unsharing last of the same hash key
4709 (which it can do by means other than releasing copy-on-write Svs)
4710 or by changing the other copy-on-write SVs in the loop. */
4712 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4714 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4716 { /* this SV was SvIsCOW_normal(sv) */
4717 /* we need to find the SV pointing to us. */
4718 SV *current = SV_COW_NEXT_SV(after);
4720 if (current == sv) {
4721 /* The SV we point to points back to us (there were only two of us
4723 Hence other SV is no longer copy on write either. */
4725 SvREADONLY_off(after);
4727 /* We need to follow the pointers around the loop. */
4729 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4732 /* don't loop forever if the structure is bust, and we have
4733 a pointer into a closed loop. */
4734 assert (current != after);
4735 assert (SvPVX_const(current) == pvx);
4737 /* Make the SV before us point to the SV after us. */
4738 SV_COW_NEXT_SV_SET(current, after);
4744 =for apidoc sv_force_normal_flags
4746 Undo various types of fakery on an SV: if the PV is a shared string, make
4747 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4748 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4749 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4750 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4751 SvPOK_off rather than making a copy. (Used where this
4752 scalar is about to be set to some other value.) In addition,
4753 the C<flags> parameter gets passed to C<sv_unref_flags()>
4754 when unreffing. C<sv_force_normal> calls this function
4755 with flags set to 0.
4761 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4765 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4767 #ifdef PERL_OLD_COPY_ON_WRITE
4768 if (SvREADONLY(sv)) {
4770 const char * const pvx = SvPVX_const(sv);
4771 const STRLEN len = SvLEN(sv);
4772 const STRLEN cur = SvCUR(sv);
4773 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4774 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4775 we'll fail an assertion. */
4776 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4779 PerlIO_printf(Perl_debug_log,
4780 "Copy on write: Force normal %ld\n",
4786 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4789 if (flags & SV_COW_DROP_PV) {
4790 /* OK, so we don't need to copy our buffer. */
4793 SvGROW(sv, cur + 1);
4794 Move(pvx,SvPVX(sv),cur,char);
4799 sv_release_COW(sv, pvx, next);
4801 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4807 else if (IN_PERL_RUNTIME)
4808 Perl_croak_no_modify(aTHX);
4811 if (SvREADONLY(sv)) {
4813 const char * const pvx = SvPVX_const(sv);
4814 const STRLEN len = SvCUR(sv);
4819 if (flags & SV_COW_DROP_PV) {
4820 /* OK, so we don't need to copy our buffer. */
4823 SvGROW(sv, len + 1);
4824 Move(pvx,SvPVX(sv),len,char);
4827 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4829 else if (IN_PERL_RUNTIME)
4830 Perl_croak_no_modify(aTHX);
4834 sv_unref_flags(sv, flags);
4835 else if (SvFAKE(sv) && isGV_with_GP(sv))
4836 sv_unglob(sv, flags);
4837 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4838 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4839 to sv_unglob. We only need it here, so inline it. */
4840 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4841 SV *const temp = newSV_type(new_type);
4842 void *const temp_p = SvANY(sv);
4844 if (new_type == SVt_PVMG) {
4845 SvMAGIC_set(temp, SvMAGIC(sv));
4846 SvMAGIC_set(sv, NULL);
4847 SvSTASH_set(temp, SvSTASH(sv));
4848 SvSTASH_set(sv, NULL);
4850 SvCUR_set(temp, SvCUR(sv));
4851 /* Remember that SvPVX is in the head, not the body. */
4853 SvLEN_set(temp, SvLEN(sv));
4854 /* This signals "buffer is owned by someone else" in sv_clear,
4855 which is the least effort way to stop it freeing the buffer.
4857 SvLEN_set(sv, SvLEN(sv)+1);
4859 /* Their buffer is already owned by someone else. */
4860 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4861 SvLEN_set(temp, SvCUR(sv)+1);
4864 /* Now swap the rest of the bodies. */
4866 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4867 SvFLAGS(sv) |= new_type;
4868 SvANY(sv) = SvANY(temp);
4870 SvFLAGS(temp) &= ~(SVTYPEMASK);
4871 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4872 SvANY(temp) = temp_p;
4881 Efficient removal of characters from the beginning of the string buffer.
4882 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4883 the string buffer. The C<ptr> becomes the first character of the adjusted
4884 string. Uses the "OOK hack".
4886 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4887 refer to the same chunk of data.
4889 The unfortunate similarity of this function's name to that of Perl's C<chop>
4890 operator is strictly coincidental. This function works from the left;
4891 C<chop> works from the right.
4897 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4908 PERL_ARGS_ASSERT_SV_CHOP;
4910 if (!ptr || !SvPOKp(sv))
4912 delta = ptr - SvPVX_const(sv);
4914 /* Nothing to do. */
4917 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4918 if (delta > max_delta)
4919 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4920 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4921 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4922 SV_CHECK_THINKFIRST(sv);
4925 if (!SvLEN(sv)) { /* make copy of shared string */
4926 const char *pvx = SvPVX_const(sv);
4927 const STRLEN len = SvCUR(sv);
4928 SvGROW(sv, len + 1);
4929 Move(pvx,SvPVX(sv),len,char);
4935 SvOOK_offset(sv, old_delta);
4937 SvLEN_set(sv, SvLEN(sv) - delta);
4938 SvCUR_set(sv, SvCUR(sv) - delta);
4939 SvPV_set(sv, SvPVX(sv) + delta);
4941 p = (U8 *)SvPVX_const(sv);
4944 /* how many bytes were evacuated? we will fill them with sentinel
4945 bytes, except for the part holding the new offset of course. */
4948 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4950 assert(evacn <= delta + old_delta);
4956 if (delta < 0x100) {
4960 p -= sizeof(STRLEN);
4961 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4965 /* Fill the preceding buffer with sentinals to verify that no-one is
4975 =for apidoc sv_catpvn
4977 Concatenates the string onto the end of the string which is in the SV. The
4978 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4979 status set, then the bytes appended should be valid UTF-8.
4980 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4982 =for apidoc sv_catpvn_flags
4984 Concatenates the string onto the end of the string which is in the SV. The
4985 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4986 status set, then the bytes appended should be valid UTF-8.
4987 If C<flags> has the C<SV_SMAGIC> bit set, will
4988 C<mg_set> on C<dsv> afterwards if appropriate.
4989 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4990 in terms of this function.
4996 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
5000 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
5002 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
5003 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
5005 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
5006 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5007 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5010 else SvGROW(dsv, dlen + slen + 1);
5012 sstr = SvPVX_const(dsv);
5013 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5014 SvCUR_set(dsv, SvCUR(dsv) + slen);
5017 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5018 const char * const send = sstr + slen;
5021 /* Something this code does not account for, which I think is
5022 impossible; it would require the same pv to be treated as
5023 bytes *and* utf8, which would indicate a bug elsewhere. */
5024 assert(sstr != dstr);
5026 SvGROW(dsv, dlen + slen * 2 + 1);
5027 d = (U8 *)SvPVX(dsv) + dlen;
5029 while (sstr < send) {
5030 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5031 if (UNI_IS_INVARIANT(uv))
5032 *d++ = (U8)UTF_TO_NATIVE(uv);
5034 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5035 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5038 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5041 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5043 if (flags & SV_SMAGIC)
5048 =for apidoc sv_catsv
5050 Concatenates the string from SV C<ssv> onto the end of the string in
5051 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5052 not 'set' magic. See C<sv_catsv_mg>.
5054 =for apidoc sv_catsv_flags
5056 Concatenates the string from SV C<ssv> onto the end of the string in
5057 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5058 bit set, will C<mg_get> on the C<ssv>, if appropriate, before
5059 reading it. If the C<flags> contain C<SV_SMAGIC>, C<mg_set> will be
5060 called on the modified SV afterward, if appropriate. C<sv_catsv>
5061 and C<sv_catsv_nomg> are implemented in terms of this function.
5066 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5070 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5074 const char *spv = SvPV_flags_const(ssv, slen, flags);
5076 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5078 sv_catpvn_flags(dsv, spv, slen,
5079 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5082 if (flags & SV_SMAGIC)
5087 =for apidoc sv_catpv
5089 Concatenates the string onto the end of the string which is in the SV.
5090 If the SV has the UTF-8 status set, then the bytes appended should be
5091 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5096 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5099 register STRLEN len;
5103 PERL_ARGS_ASSERT_SV_CATPV;
5107 junk = SvPV_force(sv, tlen);
5109 SvGROW(sv, tlen + len + 1);
5111 ptr = SvPVX_const(sv);
5112 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5113 SvCUR_set(sv, SvCUR(sv) + len);
5114 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5119 =for apidoc sv_catpv_flags
5121 Concatenates the string onto the end of the string which is in the SV.
5122 If the SV has the UTF-8 status set, then the bytes appended should
5123 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5124 on the modified SV if appropriate.
5130 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5132 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5133 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5137 =for apidoc sv_catpv_mg
5139 Like C<sv_catpv>, but also handles 'set' magic.
5145 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5147 PERL_ARGS_ASSERT_SV_CATPV_MG;
5156 Creates a new SV. A non-zero C<len> parameter indicates the number of
5157 bytes of preallocated string space the SV should have. An extra byte for a
5158 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5159 space is allocated.) The reference count for the new SV is set to 1.
5161 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5162 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5163 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5164 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5165 modules supporting older perls.
5171 Perl_newSV(pTHX_ const STRLEN len)
5178 sv_upgrade(sv, SVt_PV);
5179 SvGROW(sv, len + 1);
5184 =for apidoc sv_magicext
5186 Adds magic to an SV, upgrading it if necessary. Applies the
5187 supplied vtable and returns a pointer to the magic added.
5189 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5190 In particular, you can add magic to SvREADONLY SVs, and add more than
5191 one instance of the same 'how'.
5193 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5194 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5195 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5196 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5198 (This is now used as a subroutine by C<sv_magic>.)
5203 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5204 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5209 PERL_ARGS_ASSERT_SV_MAGICEXT;
5211 SvUPGRADE(sv, SVt_PVMG);
5212 Newxz(mg, 1, MAGIC);
5213 mg->mg_moremagic = SvMAGIC(sv);
5214 SvMAGIC_set(sv, mg);
5216 /* Sometimes a magic contains a reference loop, where the sv and
5217 object refer to each other. To prevent a reference loop that
5218 would prevent such objects being freed, we look for such loops
5219 and if we find one we avoid incrementing the object refcount.
5221 Note we cannot do this to avoid self-tie loops as intervening RV must
5222 have its REFCNT incremented to keep it in existence.
5225 if (!obj || obj == sv ||
5226 how == PERL_MAGIC_arylen ||
5227 how == PERL_MAGIC_symtab ||
5228 (SvTYPE(obj) == SVt_PVGV &&
5229 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5230 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5231 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5236 mg->mg_obj = SvREFCNT_inc_simple(obj);
5237 mg->mg_flags |= MGf_REFCOUNTED;
5240 /* Normal self-ties simply pass a null object, and instead of
5241 using mg_obj directly, use the SvTIED_obj macro to produce a
5242 new RV as needed. For glob "self-ties", we are tieing the PVIO
5243 with an RV obj pointing to the glob containing the PVIO. In
5244 this case, to avoid a reference loop, we need to weaken the
5248 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5249 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5255 mg->mg_len = namlen;
5258 mg->mg_ptr = savepvn(name, namlen);
5259 else if (namlen == HEf_SVKEY) {
5260 /* Yes, this is casting away const. This is only for the case of
5261 HEf_SVKEY. I think we need to document this aberation of the
5262 constness of the API, rather than making name non-const, as
5263 that change propagating outwards a long way. */
5264 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5266 mg->mg_ptr = (char *) name;
5268 mg->mg_virtual = (MGVTBL *) vtable;
5272 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5277 =for apidoc sv_magic
5279 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5280 necessary, then adds a new magic item of type C<how> to the head of the
5283 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5284 handling of the C<name> and C<namlen> arguments.
5286 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5287 to add more than one instance of the same 'how'.
5293 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5294 const char *const name, const I32 namlen)
5297 const MGVTBL *vtable;
5300 unsigned int vtable_index;
5302 PERL_ARGS_ASSERT_SV_MAGIC;
5304 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5305 || ((flags = PL_magic_data[how]),
5306 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5307 > magic_vtable_max))
5308 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5310 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5311 Useful for attaching extension internal data to perl vars.
5312 Note that multiple extensions may clash if magical scalars
5313 etc holding private data from one are passed to another. */
5315 vtable = (vtable_index == magic_vtable_max)
5316 ? NULL : PL_magic_vtables + vtable_index;
5318 #ifdef PERL_OLD_COPY_ON_WRITE
5320 sv_force_normal_flags(sv, 0);
5322 if (SvREADONLY(sv)) {
5324 /* its okay to attach magic to shared strings */
5328 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5331 Perl_croak_no_modify(aTHX);
5334 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5335 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5336 /* sv_magic() refuses to add a magic of the same 'how' as an
5339 if (how == PERL_MAGIC_taint) {
5341 /* Any scalar which already had taint magic on which someone
5342 (erroneously?) did SvIOK_on() or similar will now be
5343 incorrectly sporting public "OK" flags. */
5344 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5350 /* Rest of work is done else where */
5351 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5354 case PERL_MAGIC_taint:
5357 case PERL_MAGIC_ext:
5358 case PERL_MAGIC_dbfile:
5365 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5372 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5374 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5375 for (mg = *mgp; mg; mg = *mgp) {
5376 const MGVTBL* const virt = mg->mg_virtual;
5377 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5378 *mgp = mg->mg_moremagic;
5379 if (virt && virt->svt_free)
5380 virt->svt_free(aTHX_ sv, mg);
5381 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5383 Safefree(mg->mg_ptr);
5384 else if (mg->mg_len == HEf_SVKEY)
5385 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5386 else if (mg->mg_type == PERL_MAGIC_utf8)
5387 Safefree(mg->mg_ptr);
5389 if (mg->mg_flags & MGf_REFCOUNTED)
5390 SvREFCNT_dec(mg->mg_obj);
5394 mgp = &mg->mg_moremagic;
5397 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5398 mg_magical(sv); /* else fix the flags now */
5402 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5408 =for apidoc sv_unmagic
5410 Removes all magic of type C<type> from an SV.
5416 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5418 PERL_ARGS_ASSERT_SV_UNMAGIC;
5419 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5423 =for apidoc sv_unmagicext
5425 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5431 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5433 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5434 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5438 =for apidoc sv_rvweaken
5440 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5441 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5442 push a back-reference to this RV onto the array of backreferences
5443 associated with that magic. If the RV is magical, set magic will be
5444 called after the RV is cleared.
5450 Perl_sv_rvweaken(pTHX_ SV *const sv)
5454 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5456 if (!SvOK(sv)) /* let undefs pass */
5459 Perl_croak(aTHX_ "Can't weaken a nonreference");
5460 else if (SvWEAKREF(sv)) {
5461 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5464 else if (SvREADONLY(sv)) croak_no_modify();
5466 Perl_sv_add_backref(aTHX_ tsv, sv);
5472 /* Give tsv backref magic if it hasn't already got it, then push a
5473 * back-reference to sv onto the array associated with the backref magic.
5475 * As an optimisation, if there's only one backref and it's not an AV,
5476 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5477 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5481 /* A discussion about the backreferences array and its refcount:
5483 * The AV holding the backreferences is pointed to either as the mg_obj of
5484 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5485 * xhv_backreferences field. The array is created with a refcount
5486 * of 2. This means that if during global destruction the array gets
5487 * picked on before its parent to have its refcount decremented by the
5488 * random zapper, it won't actually be freed, meaning it's still there for
5489 * when its parent gets freed.
5491 * When the parent SV is freed, the extra ref is killed by
5492 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5493 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5495 * When a single backref SV is stored directly, it is not reference
5500 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5507 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5509 /* find slot to store array or singleton backref */
5511 if (SvTYPE(tsv) == SVt_PVHV) {
5512 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5515 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5517 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5518 mg = mg_find(tsv, PERL_MAGIC_backref);
5520 svp = &(mg->mg_obj);
5523 /* create or retrieve the array */
5525 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5526 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5531 SvREFCNT_inc_simple_void(av);
5532 /* av now has a refcnt of 2; see discussion above */
5534 /* move single existing backref to the array */
5536 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5540 mg->mg_flags |= MGf_REFCOUNTED;
5543 av = MUTABLE_AV(*svp);
5546 /* optimisation: store single backref directly in HvAUX or mg_obj */
5550 /* push new backref */
5551 assert(SvTYPE(av) == SVt_PVAV);
5552 if (AvFILLp(av) >= AvMAX(av)) {
5553 av_extend(av, AvFILLp(av)+1);
5555 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5558 /* delete a back-reference to ourselves from the backref magic associated
5559 * with the SV we point to.
5563 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5568 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5570 if (SvTYPE(tsv) == SVt_PVHV) {
5572 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5574 else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5575 /* It's possible for the the last (strong) reference to tsv to have
5576 become freed *before* the last thing holding a weak reference.
5577 If both survive longer than the backreferences array, then when
5578 the referent's reference count drops to 0 and it is freed, it's
5579 not able to chase the backreferences, so they aren't NULLed.
5581 For example, a CV holds a weak reference to its stash. If both the
5582 CV and the stash survive longer than the backreferences array,
5583 and the CV gets picked for the SvBREAK() treatment first,
5584 *and* it turns out that the stash is only being kept alive because
5585 of an our variable in the pad of the CV, then midway during CV
5586 destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5587 It ends up pointing to the freed HV. Hence it's chased in here, and
5588 if this block wasn't here, it would hit the !svp panic just below.
5590 I don't believe that "better" destruction ordering is going to help
5591 here - during global destruction there's always going to be the
5592 chance that something goes out of order. We've tried to make it
5593 foolproof before, and it only resulted in evolutionary pressure on
5594 fools. Which made us look foolish for our hubris. :-(
5600 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5601 svp = mg ? &(mg->mg_obj) : NULL;
5605 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5607 /* It's possible that sv is being freed recursively part way through the
5608 freeing of tsv. If this happens, the backreferences array of tsv has
5609 already been freed, and so svp will be NULL. If this is the case,
5610 we should not panic. Instead, nothing needs doing, so return. */
5611 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5613 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5614 *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5617 if (SvTYPE(*svp) == SVt_PVAV) {
5621 AV * const av = (AV*)*svp;
5623 assert(!SvIS_FREED(av));
5627 /* for an SV with N weak references to it, if all those
5628 * weak refs are deleted, then sv_del_backref will be called
5629 * N times and O(N^2) compares will be done within the backref
5630 * array. To ameliorate this potential slowness, we:
5631 * 1) make sure this code is as tight as possible;
5632 * 2) when looking for SV, look for it at both the head and tail of the
5633 * array first before searching the rest, since some create/destroy
5634 * patterns will cause the backrefs to be freed in order.
5641 SV **p = &svp[fill];
5642 SV *const topsv = *p;
5649 /* We weren't the last entry.
5650 An unordered list has this property that you
5651 can take the last element off the end to fill
5652 the hole, and it's still an unordered list :-)
5658 break; /* should only be one */
5665 AvFILLp(av) = fill-1;
5667 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5668 /* freed AV; skip */
5671 /* optimisation: only a single backref, stored directly */
5673 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5680 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5686 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5691 /* after multiple passes through Perl_sv_clean_all() for a thinngy
5692 * that has badly leaked, the backref array may have gotten freed,
5693 * since we only protect it against 1 round of cleanup */
5694 if (SvIS_FREED(av)) {
5695 if (PL_in_clean_all) /* All is fair */
5698 "panic: magic_killbackrefs (freed backref AV/SV)");
5702 is_array = (SvTYPE(av) == SVt_PVAV);
5704 assert(!SvIS_FREED(av));
5707 last = svp + AvFILLp(av);
5710 /* optimisation: only a single backref, stored directly */
5716 while (svp <= last) {
5718 SV *const referrer = *svp;
5719 if (SvWEAKREF(referrer)) {
5720 /* XXX Should we check that it hasn't changed? */
5721 assert(SvROK(referrer));
5722 SvRV_set(referrer, 0);
5724 SvWEAKREF_off(referrer);
5725 SvSETMAGIC(referrer);
5726 } else if (SvTYPE(referrer) == SVt_PVGV ||
5727 SvTYPE(referrer) == SVt_PVLV) {
5728 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5729 /* You lookin' at me? */
5730 assert(GvSTASH(referrer));
5731 assert(GvSTASH(referrer) == (const HV *)sv);
5732 GvSTASH(referrer) = 0;
5733 } else if (SvTYPE(referrer) == SVt_PVCV ||
5734 SvTYPE(referrer) == SVt_PVFM) {
5735 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5736 /* You lookin' at me? */
5737 assert(CvSTASH(referrer));
5738 assert(CvSTASH(referrer) == (const HV *)sv);
5739 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5742 assert(SvTYPE(sv) == SVt_PVGV);
5743 /* You lookin' at me? */
5744 assert(CvGV(referrer));
5745 assert(CvGV(referrer) == (const GV *)sv);
5746 anonymise_cv_maybe(MUTABLE_GV(sv),
5747 MUTABLE_CV(referrer));
5752 "panic: magic_killbackrefs (flags=%"UVxf")",
5753 (UV)SvFLAGS(referrer));
5764 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5770 =for apidoc sv_insert
5772 Inserts a string at the specified offset/length within the SV. Similar to
5773 the Perl substr() function. Handles get magic.
5775 =for apidoc sv_insert_flags
5777 Same as C<sv_insert>, but the extra C<flags> are passed to the
5778 C<SvPV_force_flags> that applies to C<bigstr>.
5784 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5789 register char *midend;
5790 register char *bigend;
5791 register SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5794 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5797 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5798 SvPV_force_flags(bigstr, curlen, flags);
5799 (void)SvPOK_only_UTF8(bigstr);
5800 if (offset + len > curlen) {
5801 SvGROW(bigstr, offset+len+1);
5802 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5803 SvCUR_set(bigstr, offset+len);
5807 i = littlelen - len;
5808 if (i > 0) { /* string might grow */
5809 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5810 mid = big + offset + len;
5811 midend = bigend = big + SvCUR(bigstr);
5814 while (midend > mid) /* shove everything down */
5815 *--bigend = *--midend;
5816 Move(little,big+offset,littlelen,char);
5817 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5822 Move(little,SvPVX(bigstr)+offset,len,char);
5827 big = SvPVX(bigstr);
5830 bigend = big + SvCUR(bigstr);
5832 if (midend > bigend)
5833 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5836 if (mid - big > bigend - midend) { /* faster to shorten from end */
5838 Move(little, mid, littlelen,char);
5841 i = bigend - midend;
5843 Move(midend, mid, i,char);
5847 SvCUR_set(bigstr, mid - big);
5849 else if ((i = mid - big)) { /* faster from front */
5850 midend -= littlelen;
5852 Move(big, midend - i, i, char);
5853 sv_chop(bigstr,midend-i);
5855 Move(little, mid, littlelen,char);
5857 else if (littlelen) {
5858 midend -= littlelen;
5859 sv_chop(bigstr,midend);
5860 Move(little,midend,littlelen,char);
5863 sv_chop(bigstr,midend);
5869 =for apidoc sv_replace
5871 Make the first argument a copy of the second, then delete the original.
5872 The target SV physically takes over ownership of the body of the source SV
5873 and inherits its flags; however, the target keeps any magic it owns,
5874 and any magic in the source is discarded.
5875 Note that this is a rather specialist SV copying operation; most of the
5876 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5882 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5885 const U32 refcnt = SvREFCNT(sv);
5887 PERL_ARGS_ASSERT_SV_REPLACE;
5889 SV_CHECK_THINKFIRST_COW_DROP(sv);
5890 if (SvREFCNT(nsv) != 1) {
5891 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5892 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5894 if (SvMAGICAL(sv)) {
5898 sv_upgrade(nsv, SVt_PVMG);
5899 SvMAGIC_set(nsv, SvMAGIC(sv));
5900 SvFLAGS(nsv) |= SvMAGICAL(sv);
5902 SvMAGIC_set(sv, NULL);
5906 assert(!SvREFCNT(sv));
5907 #ifdef DEBUG_LEAKING_SCALARS
5908 sv->sv_flags = nsv->sv_flags;
5909 sv->sv_any = nsv->sv_any;
5910 sv->sv_refcnt = nsv->sv_refcnt;
5911 sv->sv_u = nsv->sv_u;
5913 StructCopy(nsv,sv,SV);
5915 if(SvTYPE(sv) == SVt_IV) {
5917 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5921 #ifdef PERL_OLD_COPY_ON_WRITE
5922 if (SvIsCOW_normal(nsv)) {
5923 /* We need to follow the pointers around the loop to make the
5924 previous SV point to sv, rather than nsv. */
5927 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5930 assert(SvPVX_const(current) == SvPVX_const(nsv));
5932 /* Make the SV before us point to the SV after us. */
5934 PerlIO_printf(Perl_debug_log, "previous is\n");
5936 PerlIO_printf(Perl_debug_log,
5937 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5938 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5940 SV_COW_NEXT_SV_SET(current, sv);
5943 SvREFCNT(sv) = refcnt;
5944 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5949 /* We're about to free a GV which has a CV that refers back to us.
5950 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5954 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5959 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5962 assert(SvREFCNT(gv) == 0);
5963 assert(isGV(gv) && isGV_with_GP(gv));
5965 assert(!CvANON(cv));
5966 assert(CvGV(cv) == gv);
5968 /* will the CV shortly be freed by gp_free() ? */
5969 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5970 SvANY(cv)->xcv_gv = NULL;
5974 /* if not, anonymise: */
5975 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5976 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5977 : newSVpvn_flags( "__ANON__", 8, 0 );
5978 sv_catpvs(gvname, "::__ANON__");
5979 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5980 SvREFCNT_dec(gvname);
5984 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5989 =for apidoc sv_clear
5991 Clear an SV: call any destructors, free up any memory used by the body,
5992 and free the body itself. The SV's head is I<not> freed, although
5993 its type is set to all 1's so that it won't inadvertently be assumed
5994 to be live during global destruction etc.
5995 This function should only be called when REFCNT is zero. Most of the time
5996 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
6003 Perl_sv_clear(pTHX_ SV *const orig_sv)
6008 const struct body_details *sv_type_details;
6011 register SV *sv = orig_sv;
6014 PERL_ARGS_ASSERT_SV_CLEAR;
6016 /* within this loop, sv is the SV currently being freed, and
6017 * iter_sv is the most recent AV or whatever that's being iterated
6018 * over to provide more SVs */
6024 assert(SvREFCNT(sv) == 0);
6025 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6027 if (type <= SVt_IV) {
6028 /* See the comment in sv.h about the collusion between this
6029 * early return and the overloading of the NULL slots in the
6033 SvFLAGS(sv) &= SVf_BREAK;
6034 SvFLAGS(sv) |= SVTYPEMASK;
6038 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6040 if (type >= SVt_PVMG) {
6042 if (!curse(sv, 1)) goto get_next_sv;
6043 type = SvTYPE(sv); /* destructor may have changed it */
6045 /* Free back-references before magic, in case the magic calls
6046 * Perl code that has weak references to sv. */
6047 if (type == SVt_PVHV) {
6048 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6052 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6053 SvREFCNT_dec(SvOURSTASH(sv));
6054 } else if (SvMAGIC(sv)) {
6055 /* Free back-references before other types of magic. */
6056 sv_unmagic(sv, PERL_MAGIC_backref);
6059 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6060 SvREFCNT_dec(SvSTASH(sv));
6063 /* case SVt_BIND: */
6066 IoIFP(sv) != PerlIO_stdin() &&
6067 IoIFP(sv) != PerlIO_stdout() &&
6068 IoIFP(sv) != PerlIO_stderr() &&
6069 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6071 io_close(MUTABLE_IO(sv), FALSE);
6073 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6074 PerlDir_close(IoDIRP(sv));
6075 IoDIRP(sv) = (DIR*)NULL;
6076 Safefree(IoTOP_NAME(sv));
6077 Safefree(IoFMT_NAME(sv));
6078 Safefree(IoBOTTOM_NAME(sv));
6079 if ((const GV *)sv == PL_statgv)
6083 /* FIXME for plugins */
6084 pregfree2((REGEXP*) sv);
6088 cv_undef(MUTABLE_CV(sv));
6089 /* If we're in a stash, we don't own a reference to it.
6090 * However it does have a back reference to us, which needs to
6092 if ((stash = CvSTASH(sv)))
6093 sv_del_backref(MUTABLE_SV(stash), sv);
6096 if (PL_last_swash_hv == (const HV *)sv) {
6097 PL_last_swash_hv = NULL;
6099 if (HvTOTALKEYS((HV*)sv) > 0) {
6101 /* this statement should match the one at the beginning of
6102 * hv_undef_flags() */
6103 if ( PL_phase != PERL_PHASE_DESTRUCT
6104 && (name = HvNAME((HV*)sv)))
6107 (void)hv_delete(PL_stashcache, name,
6108 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6109 hv_name_set((HV*)sv, NULL, 0, 0);
6112 /* save old iter_sv in unused SvSTASH field */
6113 assert(!SvOBJECT(sv));
6114 SvSTASH(sv) = (HV*)iter_sv;
6117 /* save old hash_index in unused SvMAGIC field */
6118 assert(!SvMAGICAL(sv));
6119 assert(!SvMAGIC(sv));
6120 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6123 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6124 goto get_next_sv; /* process this new sv */
6126 /* free empty hash */
6127 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6128 assert(!HvARRAY((HV*)sv));
6132 AV* av = MUTABLE_AV(sv);
6133 if (PL_comppad == av) {
6137 if (AvREAL(av) && AvFILLp(av) > -1) {
6138 next_sv = AvARRAY(av)[AvFILLp(av)--];
6139 /* save old iter_sv in top-most slot of AV,
6140 * and pray that it doesn't get wiped in the meantime */
6141 AvARRAY(av)[AvMAX(av)] = iter_sv;
6143 goto get_next_sv; /* process this new sv */
6145 Safefree(AvALLOC(av));
6150 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6151 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6152 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6153 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6155 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6156 SvREFCNT_dec(LvTARG(sv));
6158 if (isGV_with_GP(sv)) {
6159 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6160 && HvENAME_get(stash))
6161 mro_method_changed_in(stash);
6162 gp_free(MUTABLE_GV(sv));
6164 unshare_hek(GvNAME_HEK(sv));
6165 /* If we're in a stash, we don't own a reference to it.
6166 * However it does have a back reference to us, which
6167 * needs to be cleared. */
6168 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6169 sv_del_backref(MUTABLE_SV(stash), sv);
6171 /* FIXME. There are probably more unreferenced pointers to SVs
6172 * in the interpreter struct that we should check and tidy in
6173 * a similar fashion to this: */
6174 /* See also S_sv_unglob, which does the same thing. */
6175 if ((const GV *)sv == PL_last_in_gv)
6176 PL_last_in_gv = NULL;
6177 else if ((const GV *)sv == PL_statgv)
6184 /* Don't bother with SvOOK_off(sv); as we're only going to
6188 SvOOK_offset(sv, offset);
6189 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6190 /* Don't even bother with turning off the OOK flag. */
6195 SV * const target = SvRV(sv);
6197 sv_del_backref(target, sv);
6202 #ifdef PERL_OLD_COPY_ON_WRITE
6203 else if (SvPVX_const(sv)
6204 && !(SvTYPE(sv) == SVt_PVIO
6205 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6209 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6213 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6215 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6219 } else if (SvLEN(sv)) {
6220 Safefree(SvPVX_const(sv));
6224 else if (SvPVX_const(sv) && SvLEN(sv)
6225 && !(SvTYPE(sv) == SVt_PVIO
6226 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6227 Safefree(SvPVX_mutable(sv));
6228 else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6229 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6240 SvFLAGS(sv) &= SVf_BREAK;
6241 SvFLAGS(sv) |= SVTYPEMASK;
6243 sv_type_details = bodies_by_type + type;
6244 if (sv_type_details->arena) {
6245 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6246 &PL_body_roots[type]);
6248 else if (sv_type_details->body_size) {
6249 safefree(SvANY(sv));
6253 /* caller is responsible for freeing the head of the original sv */
6254 if (sv != orig_sv && !SvREFCNT(sv))
6257 /* grab and free next sv, if any */
6265 else if (!iter_sv) {
6267 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6268 AV *const av = (AV*)iter_sv;
6269 if (AvFILLp(av) > -1) {
6270 sv = AvARRAY(av)[AvFILLp(av)--];
6272 else { /* no more elements of current AV to free */
6275 /* restore previous value, squirrelled away */
6276 iter_sv = AvARRAY(av)[AvMAX(av)];
6277 Safefree(AvALLOC(av));
6280 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6281 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6282 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6283 /* no more elements of current HV to free */
6286 /* Restore previous values of iter_sv and hash_index,
6287 * squirrelled away */
6288 assert(!SvOBJECT(sv));
6289 iter_sv = (SV*)SvSTASH(sv);
6290 assert(!SvMAGICAL(sv));
6291 hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6293 /* free any remaining detritus from the hash struct */
6294 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6295 assert(!HvARRAY((HV*)sv));
6300 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6304 if (!SvREFCNT(sv)) {
6308 if (--(SvREFCNT(sv)))
6312 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6313 "Attempt to free temp prematurely: SV 0x%"UVxf
6314 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6318 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6319 /* make sure SvREFCNT(sv)==0 happens very seldom */
6320 SvREFCNT(sv) = (~(U32)0)/2;
6329 /* This routine curses the sv itself, not the object referenced by sv. So
6330 sv does not have to be ROK. */
6333 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6336 PERL_ARGS_ASSERT_CURSE;
6337 assert(SvOBJECT(sv));
6339 if (PL_defstash && /* Still have a symbol table? */
6346 stash = SvSTASH(sv);
6347 destructor = StashHANDLER(stash,DESTROY);
6349 /* A constant subroutine can have no side effects, so
6350 don't bother calling it. */
6351 && !CvCONST(destructor)
6352 /* Don't bother calling an empty destructor or one that
6353 returns immediately. */
6354 && (CvISXSUB(destructor)
6355 || (CvSTART(destructor)
6356 && (CvSTART(destructor)->op_next->op_type
6358 && (CvSTART(destructor)->op_next->op_type
6360 || CvSTART(destructor)->op_next->op_next->op_type
6366 SV* const tmpref = newRV(sv);
6367 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6369 PUSHSTACKi(PERLSI_DESTROY);
6374 call_sv(MUTABLE_SV(destructor),
6375 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6379 if(SvREFCNT(tmpref) < 2) {
6380 /* tmpref is not kept alive! */
6382 SvRV_set(tmpref, NULL);
6385 SvREFCNT_dec(tmpref);
6387 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6390 if (check_refcnt && SvREFCNT(sv)) {
6391 if (PL_in_clean_objs)
6393 "DESTROY created new reference to dead object '%"HEKf"'",
6394 HEKfARG(HvNAME_HEK(stash)));
6395 /* DESTROY gave object new lease on life */
6401 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6402 SvOBJECT_off(sv); /* Curse the object. */
6403 if (SvTYPE(sv) != SVt_PVIO)
6404 --PL_sv_objcount;/* XXX Might want something more general */
6410 =for apidoc sv_newref
6412 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6419 Perl_sv_newref(pTHX_ SV *const sv)
6421 PERL_UNUSED_CONTEXT;
6430 Decrement an SV's reference count, and if it drops to zero, call
6431 C<sv_clear> to invoke destructors and free up any memory used by
6432 the body; finally, deallocate the SV's head itself.
6433 Normally called via a wrapper macro C<SvREFCNT_dec>.
6439 Perl_sv_free(pTHX_ SV *const sv)
6444 if (SvREFCNT(sv) == 0) {
6445 if (SvFLAGS(sv) & SVf_BREAK)
6446 /* this SV's refcnt has been artificially decremented to
6447 * trigger cleanup */
6449 if (PL_in_clean_all) /* All is fair */
6451 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6452 /* make sure SvREFCNT(sv)==0 happens very seldom */
6453 SvREFCNT(sv) = (~(U32)0)/2;
6456 if (ckWARN_d(WARN_INTERNAL)) {
6457 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6458 Perl_dump_sv_child(aTHX_ sv);
6460 #ifdef DEBUG_LEAKING_SCALARS
6463 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6464 if (PL_warnhook == PERL_WARNHOOK_FATAL
6465 || ckDEAD(packWARN(WARN_INTERNAL))) {
6466 /* Don't let Perl_warner cause us to escape our fate: */
6470 /* This may not return: */
6471 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6472 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6473 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6476 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6481 if (--(SvREFCNT(sv)) > 0)
6483 Perl_sv_free2(aTHX_ sv);
6487 Perl_sv_free2(pTHX_ SV *const sv)
6491 PERL_ARGS_ASSERT_SV_FREE2;
6495 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6496 "Attempt to free temp prematurely: SV 0x%"UVxf
6497 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6501 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6502 /* make sure SvREFCNT(sv)==0 happens very seldom */
6503 SvREFCNT(sv) = (~(U32)0)/2;
6514 Returns the length of the string in the SV. Handles magic and type
6515 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6521 Perl_sv_len(pTHX_ register SV *const sv)
6529 len = mg_length(sv);
6531 (void)SvPV_const(sv, len);
6536 =for apidoc sv_len_utf8
6538 Returns the number of characters in the string in an SV, counting wide
6539 UTF-8 bytes as a single character. Handles magic and type coercion.
6545 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6546 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6547 * (Note that the mg_len is not the length of the mg_ptr field.
6548 * This allows the cache to store the character length of the string without
6549 * needing to malloc() extra storage to attach to the mg_ptr.)
6554 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6560 return mg_length(sv);
6564 const U8 *s = (U8*)SvPV_const(sv, len);
6568 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6570 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6571 if (mg->mg_len != -1)
6574 /* We can use the offset cache for a headstart.
6575 The longer value is stored in the first pair. */
6576 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6578 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6582 if (PL_utf8cache < 0) {
6583 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6584 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6588 ulen = Perl_utf8_length(aTHX_ s, s + len);
6589 utf8_mg_len_cache_update(sv, &mg, ulen);
6593 return Perl_utf8_length(aTHX_ s, s + len);
6597 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6600 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6601 STRLEN *const uoffset_p, bool *const at_end)
6603 const U8 *s = start;
6604 STRLEN uoffset = *uoffset_p;
6606 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6608 while (s < send && uoffset) {
6615 else if (s > send) {
6617 /* This is the existing behaviour. Possibly it should be a croak, as
6618 it's actually a bounds error */
6621 *uoffset_p -= uoffset;
6625 /* Given the length of the string in both bytes and UTF-8 characters, decide
6626 whether to walk forwards or backwards to find the byte corresponding to
6627 the passed in UTF-8 offset. */
6629 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6630 STRLEN uoffset, const STRLEN uend)
6632 STRLEN backw = uend - uoffset;
6634 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6636 if (uoffset < 2 * backw) {
6637 /* The assumption is that going forwards is twice the speed of going
6638 forward (that's where the 2 * backw comes from).
6639 (The real figure of course depends on the UTF-8 data.) */
6640 const U8 *s = start;
6642 while (s < send && uoffset--)
6652 while (UTF8_IS_CONTINUATION(*send))
6655 return send - start;
6658 /* For the string representation of the given scalar, find the byte
6659 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6660 give another position in the string, *before* the sought offset, which
6661 (which is always true, as 0, 0 is a valid pair of positions), which should
6662 help reduce the amount of linear searching.
6663 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6664 will be used to reduce the amount of linear searching. The cache will be
6665 created if necessary, and the found value offered to it for update. */
6667 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6668 const U8 *const send, STRLEN uoffset,
6669 STRLEN uoffset0, STRLEN boffset0)
6671 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6673 bool at_end = FALSE;
6675 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6677 assert (uoffset >= uoffset0);
6684 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6685 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6686 if ((*mgp)->mg_ptr) {
6687 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6688 if (cache[0] == uoffset) {
6689 /* An exact match. */
6692 if (cache[2] == uoffset) {
6693 /* An exact match. */
6697 if (cache[0] < uoffset) {
6698 /* The cache already knows part of the way. */
6699 if (cache[0] > uoffset0) {
6700 /* The cache knows more than the passed in pair */
6701 uoffset0 = cache[0];
6702 boffset0 = cache[1];
6704 if ((*mgp)->mg_len != -1) {
6705 /* And we know the end too. */
6707 + sv_pos_u2b_midway(start + boffset0, send,
6709 (*mgp)->mg_len - uoffset0);
6711 uoffset -= uoffset0;
6713 + sv_pos_u2b_forwards(start + boffset0,
6714 send, &uoffset, &at_end);
6715 uoffset += uoffset0;
6718 else if (cache[2] < uoffset) {
6719 /* We're between the two cache entries. */
6720 if (cache[2] > uoffset0) {
6721 /* and the cache knows more than the passed in pair */
6722 uoffset0 = cache[2];
6723 boffset0 = cache[3];
6727 + sv_pos_u2b_midway(start + boffset0,
6730 cache[0] - uoffset0);
6733 + sv_pos_u2b_midway(start + boffset0,
6736 cache[2] - uoffset0);
6740 else if ((*mgp)->mg_len != -1) {
6741 /* If we can take advantage of a passed in offset, do so. */
6742 /* In fact, offset0 is either 0, or less than offset, so don't
6743 need to worry about the other possibility. */
6745 + sv_pos_u2b_midway(start + boffset0, send,
6747 (*mgp)->mg_len - uoffset0);
6752 if (!found || PL_utf8cache < 0) {
6753 STRLEN real_boffset;
6754 uoffset -= uoffset0;
6755 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6756 send, &uoffset, &at_end);
6757 uoffset += uoffset0;
6759 if (found && PL_utf8cache < 0)
6760 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6762 boffset = real_boffset;
6767 utf8_mg_len_cache_update(sv, mgp, uoffset);
6769 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6776 =for apidoc sv_pos_u2b_flags
6778 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6779 the start of the string, to a count of the equivalent number of bytes; if
6780 lenp is non-zero, it does the same to lenp, but this time starting from
6781 the offset, rather than from the start
6782 of the string. Handles type coercion.
6783 I<flags> is passed to C<SvPV_flags>, and usually should be
6784 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6790 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6791 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6792 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6797 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6804 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6806 start = (U8*)SvPV_flags(sv, len, flags);
6808 const U8 * const send = start + len;
6810 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6813 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6814 is 0, and *lenp is already set to that. */) {
6815 /* Convert the relative offset to absolute. */
6816 const STRLEN uoffset2 = uoffset + *lenp;
6817 const STRLEN boffset2
6818 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6819 uoffset, boffset) - boffset;
6833 =for apidoc sv_pos_u2b
6835 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6836 the start of the string, to a count of the equivalent number of bytes; if
6837 lenp is non-zero, it does the same to lenp, but this time starting from
6838 the offset, rather than from the start of the string. Handles magic and
6841 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6848 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6849 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6850 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6854 /* This function is subject to size and sign problems */
6857 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6859 PERL_ARGS_ASSERT_SV_POS_U2B;
6862 STRLEN ulen = (STRLEN)*lenp;
6863 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6864 SV_GMAGIC|SV_CONST_RETURN);
6867 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6868 SV_GMAGIC|SV_CONST_RETURN);
6873 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6876 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6880 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6881 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6882 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6886 (*mgp)->mg_len = ulen;
6887 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6888 if (ulen != (STRLEN) (*mgp)->mg_len)
6889 (*mgp)->mg_len = -1;
6892 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6893 byte length pairing. The (byte) length of the total SV is passed in too,
6894 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6895 may not have updated SvCUR, so we can't rely on reading it directly.
6897 The proffered utf8/byte length pairing isn't used if the cache already has
6898 two pairs, and swapping either for the proffered pair would increase the
6899 RMS of the intervals between known byte offsets.
6901 The cache itself consists of 4 STRLEN values
6902 0: larger UTF-8 offset
6903 1: corresponding byte offset
6904 2: smaller UTF-8 offset
6905 3: corresponding byte offset
6907 Unused cache pairs have the value 0, 0.
6908 Keeping the cache "backwards" means that the invariant of
6909 cache[0] >= cache[2] is maintained even with empty slots, which means that
6910 the code that uses it doesn't need to worry if only 1 entry has actually
6911 been set to non-zero. It also makes the "position beyond the end of the
6912 cache" logic much simpler, as the first slot is always the one to start
6916 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6917 const STRLEN utf8, const STRLEN blen)
6921 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6926 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6927 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6928 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6930 (*mgp)->mg_len = -1;
6934 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6935 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6936 (*mgp)->mg_ptr = (char *) cache;
6940 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6941 /* SvPOKp() because it's possible that sv has string overloading, and
6942 therefore is a reference, hence SvPVX() is actually a pointer.
6943 This cures the (very real) symptoms of RT 69422, but I'm not actually
6944 sure whether we should even be caching the results of UTF-8
6945 operations on overloading, given that nothing stops overloading
6946 returning a different value every time it's called. */
6947 const U8 *start = (const U8 *) SvPVX_const(sv);
6948 const STRLEN realutf8 = utf8_length(start, start + byte);
6950 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6954 /* Cache is held with the later position first, to simplify the code
6955 that deals with unbounded ends. */
6957 ASSERT_UTF8_CACHE(cache);
6958 if (cache[1] == 0) {
6959 /* Cache is totally empty */
6962 } else if (cache[3] == 0) {
6963 if (byte > cache[1]) {
6964 /* New one is larger, so goes first. */
6965 cache[2] = cache[0];
6966 cache[3] = cache[1];
6974 #define THREEWAY_SQUARE(a,b,c,d) \
6975 ((float)((d) - (c))) * ((float)((d) - (c))) \
6976 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6977 + ((float)((b) - (a))) * ((float)((b) - (a)))
6979 /* Cache has 2 slots in use, and we know three potential pairs.
6980 Keep the two that give the lowest RMS distance. Do the
6981 calculation in bytes simply because we always know the byte
6982 length. squareroot has the same ordering as the positive value,
6983 so don't bother with the actual square root. */
6984 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6985 if (byte > cache[1]) {
6986 /* New position is after the existing pair of pairs. */
6987 const float keep_earlier
6988 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6989 const float keep_later
6990 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6992 if (keep_later < keep_earlier) {
6993 if (keep_later < existing) {
6994 cache[2] = cache[0];
6995 cache[3] = cache[1];
7001 if (keep_earlier < existing) {
7007 else if (byte > cache[3]) {
7008 /* New position is between 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, byte, cache[1], blen);
7014 if (keep_later < keep_earlier) {
7015 if (keep_later < existing) {
7021 if (keep_earlier < existing) {
7028 /* New position is before the existing pair of pairs. */
7029 const float keep_earlier
7030 = THREEWAY_SQUARE(0, byte, cache[3], blen);
7031 const float keep_later
7032 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7034 if (keep_later < keep_earlier) {
7035 if (keep_later < existing) {
7041 if (keep_earlier < existing) {
7042 cache[0] = cache[2];
7043 cache[1] = cache[3];
7050 ASSERT_UTF8_CACHE(cache);
7053 /* We already know all of the way, now we may be able to walk back. The same
7054 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7055 backward is half the speed of walking forward. */
7057 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7058 const U8 *end, STRLEN endu)
7060 const STRLEN forw = target - s;
7061 STRLEN backw = end - target;
7063 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7065 if (forw < 2 * backw) {
7066 return utf8_length(s, target);
7069 while (end > target) {
7071 while (UTF8_IS_CONTINUATION(*end)) {
7080 =for apidoc sv_pos_b2u
7082 Converts the value pointed to by offsetp from a count of bytes from the
7083 start of the string, to a count of the equivalent number of UTF-8 chars.
7084 Handles magic and type coercion.
7090 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7091 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7096 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7099 const STRLEN byte = *offsetp;
7100 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7106 PERL_ARGS_ASSERT_SV_POS_B2U;
7111 s = (const U8*)SvPV_const(sv, blen);
7114 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7115 ", byte=%"UVuf, (UV)blen, (UV)byte);
7121 && SvTYPE(sv) >= SVt_PVMG
7122 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7125 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7126 if (cache[1] == byte) {
7127 /* An exact match. */
7128 *offsetp = cache[0];
7131 if (cache[3] == byte) {
7132 /* An exact match. */
7133 *offsetp = cache[2];
7137 if (cache[1] < byte) {
7138 /* We already know part of the way. */
7139 if (mg->mg_len != -1) {
7140 /* Actually, we know the end too. */
7142 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7143 s + blen, mg->mg_len - cache[0]);
7145 len = cache[0] + utf8_length(s + cache[1], send);
7148 else if (cache[3] < byte) {
7149 /* We're between the two cached pairs, so we do the calculation
7150 offset by the byte/utf-8 positions for the earlier pair,
7151 then add the utf-8 characters from the string start to
7153 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7154 s + cache[1], cache[0] - cache[2])
7158 else { /* cache[3] > byte */
7159 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7163 ASSERT_UTF8_CACHE(cache);
7165 } else if (mg->mg_len != -1) {
7166 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7170 if (!found || PL_utf8cache < 0) {
7171 const STRLEN real_len = utf8_length(s, send);
7173 if (found && PL_utf8cache < 0)
7174 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7181 utf8_mg_len_cache_update(sv, &mg, len);
7183 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7188 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7189 STRLEN real, SV *const sv)
7191 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7193 /* As this is debugging only code, save space by keeping this test here,
7194 rather than inlining it in all the callers. */
7195 if (from_cache == real)
7198 /* Need to turn the assertions off otherwise we may recurse infinitely
7199 while printing error messages. */
7200 SAVEI8(PL_utf8cache);
7202 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7203 func, (UV) from_cache, (UV) real, SVfARG(sv));
7209 Returns a boolean indicating whether the strings in the two SVs are
7210 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7211 coerce its args to strings if necessary.
7213 =for apidoc sv_eq_flags
7215 Returns a boolean indicating whether the strings in the two SVs are
7216 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7217 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7223 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7231 SV* svrecode = NULL;
7238 /* if pv1 and pv2 are the same, second SvPV_const call may
7239 * invalidate pv1 (if we are handling magic), so we may need to
7241 if (sv1 == sv2 && flags & SV_GMAGIC
7242 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7243 pv1 = SvPV_const(sv1, cur1);
7244 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7246 pv1 = SvPV_flags_const(sv1, cur1, flags);
7254 pv2 = SvPV_flags_const(sv2, cur2, flags);
7256 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7257 /* Differing utf8ness.
7258 * Do not UTF8size the comparands as a side-effect. */
7261 svrecode = newSVpvn(pv2, cur2);
7262 sv_recode_to_utf8(svrecode, PL_encoding);
7263 pv2 = SvPV_const(svrecode, cur2);
7266 svrecode = newSVpvn(pv1, cur1);
7267 sv_recode_to_utf8(svrecode, PL_encoding);
7268 pv1 = SvPV_const(svrecode, cur1);
7270 /* Now both are in UTF-8. */
7272 SvREFCNT_dec(svrecode);
7278 /* sv1 is the UTF-8 one */
7279 return bytes_cmp_utf8((const U8*)pv2, cur2,
7280 (const U8*)pv1, cur1) == 0;
7283 /* sv2 is the UTF-8 one */
7284 return bytes_cmp_utf8((const U8*)pv1, cur1,
7285 (const U8*)pv2, cur2) == 0;
7291 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7293 SvREFCNT_dec(svrecode);
7301 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7302 string in C<sv1> is less than, equal to, or greater than the string in
7303 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7304 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7306 =for apidoc sv_cmp_flags
7308 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7309 string in C<sv1> is less than, equal to, or greater than the string in
7310 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7311 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7312 also C<sv_cmp_locale_flags>.
7318 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7320 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7324 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7329 const char *pv1, *pv2;
7332 SV *svrecode = NULL;
7339 pv1 = SvPV_flags_const(sv1, cur1, flags);
7346 pv2 = SvPV_flags_const(sv2, cur2, flags);
7348 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7349 /* Differing utf8ness.
7350 * Do not UTF8size the comparands as a side-effect. */
7353 svrecode = newSVpvn(pv2, cur2);
7354 sv_recode_to_utf8(svrecode, PL_encoding);
7355 pv2 = SvPV_const(svrecode, cur2);
7358 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7359 (const U8*)pv1, cur1);
7360 return retval ? retval < 0 ? -1 : +1 : 0;
7365 svrecode = newSVpvn(pv1, cur1);
7366 sv_recode_to_utf8(svrecode, PL_encoding);
7367 pv1 = SvPV_const(svrecode, cur1);
7370 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7371 (const U8*)pv2, cur2);
7372 return retval ? retval < 0 ? -1 : +1 : 0;
7378 cmp = cur2 ? -1 : 0;
7382 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7385 cmp = retval < 0 ? -1 : 1;
7386 } else if (cur1 == cur2) {
7389 cmp = cur1 < cur2 ? -1 : 1;
7393 SvREFCNT_dec(svrecode);
7401 =for apidoc sv_cmp_locale
7403 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7404 'use bytes' aware, handles get magic, and will coerce its args to strings
7405 if necessary. See also C<sv_cmp>.
7407 =for apidoc sv_cmp_locale_flags
7409 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7410 'use bytes' aware and will coerce its args to strings if necessary. If the
7411 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7417 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7419 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7423 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7427 #ifdef USE_LOCALE_COLLATE
7433 if (PL_collation_standard)
7437 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7439 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7441 if (!pv1 || !len1) {
7452 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7455 return retval < 0 ? -1 : 1;
7458 * When the result of collation is equality, that doesn't mean
7459 * that there are no differences -- some locales exclude some
7460 * characters from consideration. So to avoid false equalities,
7461 * we use the raw string as a tiebreaker.
7467 #endif /* USE_LOCALE_COLLATE */
7469 return sv_cmp(sv1, sv2);
7473 #ifdef USE_LOCALE_COLLATE
7476 =for apidoc sv_collxfrm
7478 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7479 C<sv_collxfrm_flags>.
7481 =for apidoc sv_collxfrm_flags
7483 Add Collate Transform magic to an SV if it doesn't already have it. If the
7484 flags contain SV_GMAGIC, it handles get-magic.
7486 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7487 scalar data of the variable, but transformed to such a format that a normal
7488 memory comparison can be used to compare the data according to the locale
7495 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7500 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7502 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7503 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7509 Safefree(mg->mg_ptr);
7510 s = SvPV_flags_const(sv, len, flags);
7511 if ((xf = mem_collxfrm(s, len, &xlen))) {
7513 #ifdef PERL_OLD_COPY_ON_WRITE
7515 sv_force_normal_flags(sv, 0);
7517 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7531 if (mg && mg->mg_ptr) {
7533 return mg->mg_ptr + sizeof(PL_collation_ix);
7541 #endif /* USE_LOCALE_COLLATE */
7544 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7546 SV * const tsv = newSV(0);
7549 sv_gets(tsv, fp, 0);
7550 sv_utf8_upgrade_nomg(tsv);
7551 SvCUR_set(sv,append);
7554 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7558 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7561 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7562 /* Grab the size of the record we're getting */
7563 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7570 /* VMS wants read instead of fread, because fread doesn't respect */
7571 /* RMS record boundaries. This is not necessarily a good thing to be */
7572 /* doing, but we've got no other real choice - except avoid stdio
7573 as implementation - perhaps write a :vms layer ?
7575 fd = PerlIO_fileno(fp);
7577 bytesread = PerlLIO_read(fd, buffer, recsize);
7579 else /* in-memory file from PerlIO::Scalar */
7582 bytesread = PerlIO_read(fp, buffer, recsize);
7587 SvCUR_set(sv, bytesread + append);
7588 buffer[bytesread] = '\0';
7589 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7595 Get a line from the filehandle and store it into the SV, optionally
7596 appending to the currently-stored string.
7602 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7607 register STDCHAR rslast;
7608 register STDCHAR *bp;
7613 PERL_ARGS_ASSERT_SV_GETS;
7615 if (SvTHINKFIRST(sv))
7616 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7617 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7619 However, perlbench says it's slower, because the existing swipe code
7620 is faster than copy on write.
7621 Swings and roundabouts. */
7622 SvUPGRADE(sv, SVt_PV);
7627 if (PerlIO_isutf8(fp)) {
7629 sv_utf8_upgrade_nomg(sv);
7630 sv_pos_u2b(sv,&append,0);
7632 } else if (SvUTF8(sv)) {
7633 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7641 if (PerlIO_isutf8(fp))
7644 if (IN_PERL_COMPILETIME) {
7645 /* we always read code in line mode */
7649 else if (RsSNARF(PL_rs)) {
7650 /* If it is a regular disk file use size from stat() as estimate
7651 of amount we are going to read -- may result in mallocing
7652 more memory than we really need if the layers below reduce
7653 the size we read (e.g. CRLF or a gzip layer).
7656 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7657 const Off_t offset = PerlIO_tell(fp);
7658 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7659 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7665 else if (RsRECORD(PL_rs)) {
7666 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7668 else if (RsPARA(PL_rs)) {
7674 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7675 if (PerlIO_isutf8(fp)) {
7676 rsptr = SvPVutf8(PL_rs, rslen);
7679 if (SvUTF8(PL_rs)) {
7680 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7681 Perl_croak(aTHX_ "Wide character in $/");
7684 rsptr = SvPV_const(PL_rs, rslen);
7688 rslast = rslen ? rsptr[rslen - 1] : '\0';
7690 if (rspara) { /* have to do this both before and after */
7691 do { /* to make sure file boundaries work right */
7694 i = PerlIO_getc(fp);
7698 PerlIO_ungetc(fp,i);
7704 /* See if we know enough about I/O mechanism to cheat it ! */
7706 /* This used to be #ifdef test - it is made run-time test for ease
7707 of abstracting out stdio interface. One call should be cheap
7708 enough here - and may even be a macro allowing compile
7712 if (PerlIO_fast_gets(fp)) {
7715 * We're going to steal some values from the stdio struct
7716 * and put EVERYTHING in the innermost loop into registers.
7718 register STDCHAR *ptr;
7722 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7723 /* An ungetc()d char is handled separately from the regular
7724 * buffer, so we getc() it back out and stuff it in the buffer.
7726 i = PerlIO_getc(fp);
7727 if (i == EOF) return 0;
7728 *(--((*fp)->_ptr)) = (unsigned char) i;
7732 /* Here is some breathtakingly efficient cheating */
7734 cnt = PerlIO_get_cnt(fp); /* get count into register */
7735 /* make sure we have the room */
7736 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7737 /* Not room for all of it
7738 if we are looking for a separator and room for some
7740 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7741 /* just process what we have room for */
7742 shortbuffered = cnt - SvLEN(sv) + append + 1;
7743 cnt -= shortbuffered;
7747 /* remember that cnt can be negative */
7748 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7753 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7754 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7755 DEBUG_P(PerlIO_printf(Perl_debug_log,
7756 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7757 DEBUG_P(PerlIO_printf(Perl_debug_log,
7758 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7759 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7760 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7765 while (cnt > 0) { /* this | eat */
7767 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7768 goto thats_all_folks; /* screams | sed :-) */
7772 Copy(ptr, bp, cnt, char); /* this | eat */
7773 bp += cnt; /* screams | dust */
7774 ptr += cnt; /* louder | sed :-) */
7776 assert (!shortbuffered);
7777 goto cannot_be_shortbuffered;
7781 if (shortbuffered) { /* oh well, must extend */
7782 cnt = shortbuffered;
7784 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7786 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7787 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7791 cannot_be_shortbuffered:
7792 DEBUG_P(PerlIO_printf(Perl_debug_log,
7793 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7794 PTR2UV(ptr),(long)cnt));
7795 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7797 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7798 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7799 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7800 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7802 /* This used to call 'filbuf' in stdio form, but as that behaves like
7803 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7804 another abstraction. */
7805 i = PerlIO_getc(fp); /* get more characters */
7807 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7808 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7809 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7810 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7812 cnt = PerlIO_get_cnt(fp);
7813 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7814 DEBUG_P(PerlIO_printf(Perl_debug_log,
7815 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7817 if (i == EOF) /* all done for ever? */
7818 goto thats_really_all_folks;
7820 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7822 SvGROW(sv, bpx + cnt + 2);
7823 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7825 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7827 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7828 goto thats_all_folks;
7832 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7833 memNE((char*)bp - rslen, rsptr, rslen))
7834 goto screamer; /* go back to the fray */
7835 thats_really_all_folks:
7837 cnt += shortbuffered;
7838 DEBUG_P(PerlIO_printf(Perl_debug_log,
7839 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7840 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7841 DEBUG_P(PerlIO_printf(Perl_debug_log,
7842 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7843 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7844 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7846 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7847 DEBUG_P(PerlIO_printf(Perl_debug_log,
7848 "Screamer: done, len=%ld, string=|%.*s|\n",
7849 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7853 /*The big, slow, and stupid way. */
7854 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7855 STDCHAR *buf = NULL;
7856 Newx(buf, 8192, STDCHAR);
7864 register const STDCHAR * const bpe = buf + sizeof(buf);
7866 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7867 ; /* keep reading */
7871 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7872 /* Accommodate broken VAXC compiler, which applies U8 cast to
7873 * both args of ?: operator, causing EOF to change into 255
7876 i = (U8)buf[cnt - 1];
7882 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7884 sv_catpvn(sv, (char *) buf, cnt);
7886 sv_setpvn(sv, (char *) buf, cnt);
7888 if (i != EOF && /* joy */
7890 SvCUR(sv) < rslen ||
7891 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7895 * If we're reading from a TTY and we get a short read,
7896 * indicating that the user hit his EOF character, we need
7897 * to notice it now, because if we try to read from the TTY
7898 * again, the EOF condition will disappear.
7900 * The comparison of cnt to sizeof(buf) is an optimization
7901 * that prevents unnecessary calls to feof().
7905 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7909 #ifdef USE_HEAP_INSTEAD_OF_STACK
7914 if (rspara) { /* have to do this both before and after */
7915 while (i != EOF) { /* to make sure file boundaries work right */
7916 i = PerlIO_getc(fp);
7918 PerlIO_ungetc(fp,i);
7924 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7930 Auto-increment of the value in the SV, doing string to numeric conversion
7931 if necessary. Handles 'get' magic and operator overloading.
7937 Perl_sv_inc(pTHX_ register SV *const sv)
7946 =for apidoc sv_inc_nomg
7948 Auto-increment of the value in the SV, doing string to numeric conversion
7949 if necessary. Handles operator overloading. Skips handling 'get' magic.
7955 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7963 if (SvTHINKFIRST(sv)) {
7964 if (SvIsCOW(sv) || isGV_with_GP(sv))
7965 sv_force_normal_flags(sv, 0);
7966 if (SvREADONLY(sv)) {
7967 if (IN_PERL_RUNTIME)
7968 Perl_croak_no_modify(aTHX);
7972 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7974 i = PTR2IV(SvRV(sv));
7979 flags = SvFLAGS(sv);
7980 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7981 /* It's (privately or publicly) a float, but not tested as an
7982 integer, so test it to see. */
7984 flags = SvFLAGS(sv);
7986 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7987 /* It's publicly an integer, or privately an integer-not-float */
7988 #ifdef PERL_PRESERVE_IVUV
7992 if (SvUVX(sv) == UV_MAX)
7993 sv_setnv(sv, UV_MAX_P1);
7995 (void)SvIOK_only_UV(sv);
7996 SvUV_set(sv, SvUVX(sv) + 1);
7998 if (SvIVX(sv) == IV_MAX)
7999 sv_setuv(sv, (UV)IV_MAX + 1);
8001 (void)SvIOK_only(sv);
8002 SvIV_set(sv, SvIVX(sv) + 1);
8007 if (flags & SVp_NOK) {
8008 const NV was = SvNVX(sv);
8009 if (NV_OVERFLOWS_INTEGERS_AT &&
8010 was >= NV_OVERFLOWS_INTEGERS_AT) {
8011 /* diag_listed_as: Lost precision when %s %f by 1 */
8012 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8013 "Lost precision when incrementing %" NVff " by 1",
8016 (void)SvNOK_only(sv);
8017 SvNV_set(sv, was + 1.0);
8021 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
8022 if ((flags & SVTYPEMASK) < SVt_PVIV)
8023 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
8024 (void)SvIOK_only(sv);
8029 while (isALPHA(*d)) d++;
8030 while (isDIGIT(*d)) d++;
8031 if (d < SvEND(sv)) {
8032 #ifdef PERL_PRESERVE_IVUV
8033 /* Got to punt this as an integer if needs be, but we don't issue
8034 warnings. Probably ought to make the sv_iv_please() that does
8035 the conversion if possible, and silently. */
8036 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8037 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8038 /* Need to try really hard to see if it's an integer.
8039 9.22337203685478e+18 is an integer.
8040 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8041 so $a="9.22337203685478e+18"; $a+0; $a++
8042 needs to be the same as $a="9.22337203685478e+18"; $a++
8049 /* sv_2iv *should* have made this an NV */
8050 if (flags & SVp_NOK) {
8051 (void)SvNOK_only(sv);
8052 SvNV_set(sv, SvNVX(sv) + 1.0);
8055 /* I don't think we can get here. Maybe I should assert this
8056 And if we do get here I suspect that sv_setnv will croak. NWC
8058 #if defined(USE_LONG_DOUBLE)
8059 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",
8060 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8062 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8063 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8066 #endif /* PERL_PRESERVE_IVUV */
8067 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8071 while (d >= SvPVX_const(sv)) {
8079 /* MKS: The original code here died if letters weren't consecutive.
8080 * at least it didn't have to worry about non-C locales. The
8081 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8082 * arranged in order (although not consecutively) and that only
8083 * [A-Za-z] are accepted by isALPHA in the C locale.
8085 if (*d != 'z' && *d != 'Z') {
8086 do { ++*d; } while (!isALPHA(*d));
8089 *(d--) -= 'z' - 'a';
8094 *(d--) -= 'z' - 'a' + 1;
8098 /* oh,oh, the number grew */
8099 SvGROW(sv, SvCUR(sv) + 2);
8100 SvCUR_set(sv, SvCUR(sv) + 1);
8101 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8112 Auto-decrement of the value in the SV, doing string to numeric conversion
8113 if necessary. Handles 'get' magic and operator overloading.
8119 Perl_sv_dec(pTHX_ register SV *const sv)
8129 =for apidoc sv_dec_nomg
8131 Auto-decrement of the value in the SV, doing string to numeric conversion
8132 if necessary. Handles operator overloading. Skips handling 'get' magic.
8138 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8145 if (SvTHINKFIRST(sv)) {
8146 if (SvIsCOW(sv) || isGV_with_GP(sv))
8147 sv_force_normal_flags(sv, 0);
8148 if (SvREADONLY(sv)) {
8149 if (IN_PERL_RUNTIME)
8150 Perl_croak_no_modify(aTHX);
8154 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8156 i = PTR2IV(SvRV(sv));
8161 /* Unlike sv_inc we don't have to worry about string-never-numbers
8162 and keeping them magic. But we mustn't warn on punting */
8163 flags = SvFLAGS(sv);
8164 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8165 /* It's publicly an integer, or privately an integer-not-float */
8166 #ifdef PERL_PRESERVE_IVUV
8170 if (SvUVX(sv) == 0) {
8171 (void)SvIOK_only(sv);
8175 (void)SvIOK_only_UV(sv);
8176 SvUV_set(sv, SvUVX(sv) - 1);
8179 if (SvIVX(sv) == IV_MIN) {
8180 sv_setnv(sv, (NV)IV_MIN);
8184 (void)SvIOK_only(sv);
8185 SvIV_set(sv, SvIVX(sv) - 1);
8190 if (flags & SVp_NOK) {
8193 const NV was = SvNVX(sv);
8194 if (NV_OVERFLOWS_INTEGERS_AT &&
8195 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8196 /* diag_listed_as: Lost precision when %s %f by 1 */
8197 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8198 "Lost precision when decrementing %" NVff " by 1",
8201 (void)SvNOK_only(sv);
8202 SvNV_set(sv, was - 1.0);
8206 if (!(flags & SVp_POK)) {
8207 if ((flags & SVTYPEMASK) < SVt_PVIV)
8208 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8210 (void)SvIOK_only(sv);
8213 #ifdef PERL_PRESERVE_IVUV
8215 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8216 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8217 /* Need to try really hard to see if it's an integer.
8218 9.22337203685478e+18 is an integer.
8219 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8220 so $a="9.22337203685478e+18"; $a+0; $a--
8221 needs to be the same as $a="9.22337203685478e+18"; $a--
8228 /* sv_2iv *should* have made this an NV */
8229 if (flags & SVp_NOK) {
8230 (void)SvNOK_only(sv);
8231 SvNV_set(sv, SvNVX(sv) - 1.0);
8234 /* I don't think we can get here. Maybe I should assert this
8235 And if we do get here I suspect that sv_setnv will croak. NWC
8237 #if defined(USE_LONG_DOUBLE)
8238 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",
8239 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8241 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8242 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8246 #endif /* PERL_PRESERVE_IVUV */
8247 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8250 /* this define is used to eliminate a chunk of duplicated but shared logic
8251 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8252 * used anywhere but here - yves
8254 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8257 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8261 =for apidoc sv_mortalcopy
8263 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8264 The new SV is marked as mortal. It will be destroyed "soon", either by an
8265 explicit call to FREETMPS, or by an implicit call at places such as
8266 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8271 /* Make a string that will exist for the duration of the expression
8272 * evaluation. Actually, it may have to last longer than that, but
8273 * hopefully we won't free it until it has been assigned to a
8274 * permanent location. */
8277 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8283 sv_setsv(sv,oldstr);
8284 PUSH_EXTEND_MORTAL__SV_C(sv);
8290 =for apidoc sv_newmortal
8292 Creates a new null SV which is mortal. The reference count of the SV is
8293 set to 1. It will be destroyed "soon", either by an explicit call to
8294 FREETMPS, or by an implicit call at places such as statement boundaries.
8295 See also C<sv_mortalcopy> and C<sv_2mortal>.
8301 Perl_sv_newmortal(pTHX)
8307 SvFLAGS(sv) = SVs_TEMP;
8308 PUSH_EXTEND_MORTAL__SV_C(sv);
8314 =for apidoc newSVpvn_flags
8316 Creates a new SV and copies a string into it. The reference count for the
8317 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8318 string. You are responsible for ensuring that the source string is at least
8319 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8320 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8321 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8322 returning. If C<SVf_UTF8> is set, C<s>
8323 is considered to be in UTF-8 and the
8324 C<SVf_UTF8> flag will be set on the new SV.
8325 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8327 #define newSVpvn_utf8(s, len, u) \
8328 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8334 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8339 /* All the flags we don't support must be zero.
8340 And we're new code so I'm going to assert this from the start. */
8341 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8343 sv_setpvn(sv,s,len);
8345 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8346 * and do what it does ourselves here.
8347 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8348 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8349 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8350 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8353 SvFLAGS(sv) |= flags;
8355 if(flags & SVs_TEMP){
8356 PUSH_EXTEND_MORTAL__SV_C(sv);
8363 =for apidoc sv_2mortal
8365 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8366 by an explicit call to FREETMPS, or by an implicit call at places such as
8367 statement boundaries. SvTEMP() is turned on which means that the SV's
8368 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8369 and C<sv_mortalcopy>.
8375 Perl_sv_2mortal(pTHX_ register SV *const sv)
8380 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8382 PUSH_EXTEND_MORTAL__SV_C(sv);
8390 Creates a new SV and copies a string into it. The reference count for the
8391 SV is set to 1. If C<len> is zero, Perl will compute the length using
8392 strlen(). For efficiency, consider using C<newSVpvn> instead.
8398 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8404 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8409 =for apidoc newSVpvn
8411 Creates a new SV and copies a buffer into it, which may contain NUL characters
8412 (C<\0>) and other binary data. The reference count for the SV is set to 1.
8413 Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
8414 are responsible for ensuring that the source buffer is at least
8415 C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
8422 Perl_newSVpvn(pTHX_ const char *const buffer, const STRLEN len)
8428 sv_setpvn(sv,buffer,len);
8433 =for apidoc newSVhek
8435 Creates a new SV from the hash key structure. It will generate scalars that
8436 point to the shared string table where possible. Returns a new (undefined)
8437 SV if the hek is NULL.
8443 Perl_newSVhek(pTHX_ const HEK *const hek)
8453 if (HEK_LEN(hek) == HEf_SVKEY) {
8454 return newSVsv(*(SV**)HEK_KEY(hek));
8456 const int flags = HEK_FLAGS(hek);
8457 if (flags & HVhek_WASUTF8) {
8459 Andreas would like keys he put in as utf8 to come back as utf8
8461 STRLEN utf8_len = HEK_LEN(hek);
8462 SV * const sv = newSV_type(SVt_PV);
8463 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8464 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8465 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8468 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8469 /* We don't have a pointer to the hv, so we have to replicate the
8470 flag into every HEK. This hv is using custom a hasing
8471 algorithm. Hence we can't return a shared string scalar, as
8472 that would contain the (wrong) hash value, and might get passed
8473 into an hv routine with a regular hash.
8474 Similarly, a hash that isn't using shared hash keys has to have
8475 the flag in every key so that we know not to try to call
8476 share_hek_hek on it. */
8478 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8483 /* This will be overwhelminly the most common case. */
8485 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8486 more efficient than sharepvn(). */
8490 sv_upgrade(sv, SVt_PV);
8491 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8492 SvCUR_set(sv, HEK_LEN(hek));
8505 =for apidoc newSVpvn_share
8507 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8508 table. If the string does not already exist in the table, it is
8509 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8510 is non-zero, that value is used; otherwise the hash is computed.
8511 The string's hash can later be retrieved from the SV
8512 with the C<SvSHARED_HASH()> macro. The idea here is
8513 that as the string table is used for shared hash keys these strings will have
8514 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8520 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8524 bool is_utf8 = FALSE;
8525 const char *const orig_src = src;
8528 STRLEN tmplen = -len;
8530 /* See the note in hv.c:hv_fetch() --jhi */
8531 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8535 PERL_HASH(hash, src, len);
8537 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8538 changes here, update it there too. */
8539 sv_upgrade(sv, SVt_PV);
8540 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8548 if (src != orig_src)
8554 =for apidoc newSVpv_share
8556 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8563 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8565 return newSVpvn_share(src, strlen(src), hash);
8568 #if defined(PERL_IMPLICIT_CONTEXT)
8570 /* pTHX_ magic can't cope with varargs, so this is a no-context
8571 * version of the main function, (which may itself be aliased to us).
8572 * Don't access this version directly.
8576 Perl_newSVpvf_nocontext(const char *const pat, ...)
8582 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8584 va_start(args, pat);
8585 sv = vnewSVpvf(pat, &args);
8592 =for apidoc newSVpvf
8594 Creates a new SV and initializes it with the string formatted like
8601 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8606 PERL_ARGS_ASSERT_NEWSVPVF;
8608 va_start(args, pat);
8609 sv = vnewSVpvf(pat, &args);
8614 /* backend for newSVpvf() and newSVpvf_nocontext() */
8617 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8622 PERL_ARGS_ASSERT_VNEWSVPVF;
8625 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8632 Creates a new SV and copies a floating point value into it.
8633 The reference count for the SV is set to 1.
8639 Perl_newSVnv(pTHX_ const NV n)
8652 Creates a new SV and copies an integer into it. The reference count for the
8659 Perl_newSViv(pTHX_ const IV i)
8672 Creates a new SV and copies an unsigned integer into it.
8673 The reference count for the SV is set to 1.
8679 Perl_newSVuv(pTHX_ const UV u)
8690 =for apidoc newSV_type
8692 Creates a new SV, of the type specified. The reference count for the new SV
8699 Perl_newSV_type(pTHX_ const svtype type)
8704 sv_upgrade(sv, type);
8709 =for apidoc newRV_noinc
8711 Creates an RV wrapper for an SV. The reference count for the original
8712 SV is B<not> incremented.
8718 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8721 register SV *sv = newSV_type(SVt_IV);
8723 PERL_ARGS_ASSERT_NEWRV_NOINC;
8726 SvRV_set(sv, tmpRef);
8731 /* newRV_inc is the official function name to use now.
8732 * newRV_inc is in fact #defined to newRV in sv.h
8736 Perl_newRV(pTHX_ SV *const sv)
8740 PERL_ARGS_ASSERT_NEWRV;
8742 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8748 Creates a new SV which is an exact duplicate of the original SV.
8755 Perl_newSVsv(pTHX_ register SV *const old)
8762 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8763 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8767 /* SV_GMAGIC is the default for sv_setv()
8768 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8769 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8770 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8775 =for apidoc sv_reset
8777 Underlying implementation for the C<reset> Perl function.
8778 Note that the perl-level function is vaguely deprecated.
8784 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8787 char todo[PERL_UCHAR_MAX+1];
8789 PERL_ARGS_ASSERT_SV_RESET;
8794 if (!*s) { /* reset ?? searches */
8795 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8797 const U32 count = mg->mg_len / sizeof(PMOP**);
8798 PMOP **pmp = (PMOP**) mg->mg_ptr;
8799 PMOP *const *const end = pmp + count;
8803 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8805 (*pmp)->op_pmflags &= ~PMf_USED;
8813 /* reset variables */
8815 if (!HvARRAY(stash))
8818 Zero(todo, 256, char);
8821 I32 i = (unsigned char)*s;
8825 max = (unsigned char)*s++;
8826 for ( ; i <= max; i++) {
8829 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8831 for (entry = HvARRAY(stash)[i];
8833 entry = HeNEXT(entry))
8838 if (!todo[(U8)*HeKEY(entry)])
8840 gv = MUTABLE_GV(HeVAL(entry));
8843 if (SvTHINKFIRST(sv)) {
8844 if (!SvREADONLY(sv) && SvROK(sv))
8846 /* XXX Is this continue a bug? Why should THINKFIRST
8847 exempt us from resetting arrays and hashes? */
8851 if (SvTYPE(sv) >= SVt_PV) {
8853 if (SvPVX_const(sv) != NULL)
8861 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8863 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8866 # if defined(USE_ENVIRON_ARRAY)
8869 # endif /* USE_ENVIRON_ARRAY */
8880 Using various gambits, try to get an IO from an SV: the IO slot if its a
8881 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8882 named after the PV if we're a string.
8884 'Get' magic is ignored on the sv passed in, but will be called on
8885 C<SvRV(sv)> if sv is an RV.
8891 Perl_sv_2io(pTHX_ SV *const sv)
8896 PERL_ARGS_ASSERT_SV_2IO;
8898 switch (SvTYPE(sv)) {
8900 io = MUTABLE_IO(sv);
8904 if (isGV_with_GP(sv)) {
8905 gv = MUTABLE_GV(sv);
8908 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8909 HEKfARG(GvNAME_HEK(gv)));
8915 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8917 SvGETMAGIC(SvRV(sv));
8918 return sv_2io(SvRV(sv));
8920 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8927 if (SvGMAGICAL(sv)) {
8928 newsv = sv_newmortal();
8929 sv_setsv_nomg(newsv, sv);
8931 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8941 Using various gambits, try to get a CV from an SV; in addition, try if
8942 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8943 The flags in C<lref> are passed to gv_fetchsv.
8949 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8955 PERL_ARGS_ASSERT_SV_2CV;
8962 switch (SvTYPE(sv)) {
8966 return MUTABLE_CV(sv);
8976 sv = amagic_deref_call(sv, to_cv_amg);
8979 if (SvTYPE(sv) == SVt_PVCV) {
8980 cv = MUTABLE_CV(sv);
8985 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
8986 gv = MUTABLE_GV(sv);
8988 Perl_croak(aTHX_ "Not a subroutine reference");
8990 else if (isGV_with_GP(sv)) {
8991 gv = MUTABLE_GV(sv);
8994 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
9001 /* Some flags to gv_fetchsv mean don't really create the GV */
9002 if (!isGV_with_GP(gv)) {
9007 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
9011 gv_efullname3(tmpsv, gv, NULL);
9012 /* XXX this is probably not what they think they're getting.
9013 * It has the same effect as "sub name;", i.e. just a forward
9015 newSUB(start_subparse(FALSE, 0),
9016 newSVOP(OP_CONST, 0, tmpsv),
9020 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
9021 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
9030 Returns true if the SV has a true value by Perl's rules.
9031 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
9032 instead use an in-line version.
9038 Perl_sv_true(pTHX_ register SV *const sv)
9043 register const XPV* const tXpv = (XPV*)SvANY(sv);
9045 (tXpv->xpv_cur > 1 ||
9046 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9053 return SvIVX(sv) != 0;
9056 return SvNVX(sv) != 0.0;
9058 return sv_2bool(sv);
9064 =for apidoc sv_pvn_force
9066 Get a sensible string out of the SV somehow.
9067 A private implementation of the C<SvPV_force> macro for compilers which
9068 can't cope with complex macro expressions. Always use the macro instead.
9070 =for apidoc sv_pvn_force_flags
9072 Get a sensible string out of the SV somehow.
9073 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9074 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9075 implemented in terms of this function.
9076 You normally want to use the various wrapper macros instead: see
9077 C<SvPV_force> and C<SvPV_force_nomg>
9083 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9087 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9089 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9090 if (SvTHINKFIRST(sv) && !SvROK(sv))
9091 sv_force_normal_flags(sv, 0);
9101 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9102 const char * const ref = sv_reftype(sv,0);
9104 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9105 ref, OP_DESC(PL_op));
9107 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9109 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9110 || isGV_with_GP(sv))
9111 /* diag_listed_as: Can't coerce %s to %s in %s */
9112 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9114 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9118 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9121 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9122 SvGROW(sv, len + 1);
9123 Move(s,SvPVX(sv),len,char);
9125 SvPVX(sv)[len] = '\0';
9128 SvPOK_on(sv); /* validate pointer */
9130 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9131 PTR2UV(sv),SvPVX_const(sv)));
9134 return SvPVX_mutable(sv);
9138 =for apidoc sv_pvbyten_force
9140 The backend for the C<SvPVbytex_force> macro. Always use the macro
9147 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9149 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9151 sv_pvn_force(sv,lp);
9152 sv_utf8_downgrade(sv,0);
9158 =for apidoc sv_pvutf8n_force
9160 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9167 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9169 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9171 sv_pvn_force(sv,lp);
9172 sv_utf8_upgrade(sv);
9178 =for apidoc sv_reftype
9180 Returns a string describing what the SV is a reference to.
9186 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9188 PERL_ARGS_ASSERT_SV_REFTYPE;
9189 if (ob && SvOBJECT(sv)) {
9190 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9193 switch (SvTYPE(sv)) {
9208 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9209 /* tied lvalues should appear to be
9210 * scalars for backwards compatibility */
9211 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9212 ? "SCALAR" : "LVALUE");
9213 case SVt_PVAV: return "ARRAY";
9214 case SVt_PVHV: return "HASH";
9215 case SVt_PVCV: return "CODE";
9216 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9217 ? "GLOB" : "SCALAR");
9218 case SVt_PVFM: return "FORMAT";
9219 case SVt_PVIO: return "IO";
9220 case SVt_BIND: return "BIND";
9221 case SVt_REGEXP: return "REGEXP";
9222 default: return "UNKNOWN";
9230 Returns a SV describing what the SV passed in is a reference to.
9236 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9238 PERL_ARGS_ASSERT_SV_REF;
9241 dst = sv_newmortal();
9243 if (ob && SvOBJECT(sv)) {
9244 HvNAME_get(SvSTASH(sv))
9245 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9246 : sv_setpvn(dst, "__ANON__", 8);
9249 const char * reftype = sv_reftype(sv, 0);
9250 sv_setpv(dst, reftype);
9256 =for apidoc sv_isobject
9258 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9259 object. If the SV is not an RV, or if the object is not blessed, then this
9266 Perl_sv_isobject(pTHX_ SV *sv)
9282 Returns a boolean indicating whether the SV is blessed into the specified
9283 class. This does not check for subtypes; use C<sv_derived_from> to verify
9284 an inheritance relationship.
9290 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9294 PERL_ARGS_ASSERT_SV_ISA;
9304 hvname = HvNAME_get(SvSTASH(sv));
9308 return strEQ(hvname, name);
9314 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9315 it will be upgraded to one. If C<classname> is non-null then the new SV will
9316 be blessed in the specified package. The new SV is returned and its
9317 reference count is 1.
9323 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9328 PERL_ARGS_ASSERT_NEWSVRV;
9332 SV_CHECK_THINKFIRST_COW_DROP(rv);
9333 (void)SvAMAGIC_off(rv);
9335 if (SvTYPE(rv) >= SVt_PVMG) {
9336 const U32 refcnt = SvREFCNT(rv);
9340 SvREFCNT(rv) = refcnt;
9342 sv_upgrade(rv, SVt_IV);
9343 } else if (SvROK(rv)) {
9344 SvREFCNT_dec(SvRV(rv));
9346 prepare_SV_for_RV(rv);
9354 HV* const stash = gv_stashpv(classname, GV_ADD);
9355 (void)sv_bless(rv, stash);
9361 =for apidoc sv_setref_pv
9363 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9364 argument will be upgraded to an RV. That RV will be modified to point to
9365 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9366 into the SV. The C<classname> argument indicates the package for the
9367 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9368 will have a reference count of 1, and the RV will be returned.
9370 Do not use with other Perl types such as HV, AV, SV, CV, because those
9371 objects will become corrupted by the pointer copy process.
9373 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9379 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9383 PERL_ARGS_ASSERT_SV_SETREF_PV;
9386 sv_setsv(rv, &PL_sv_undef);
9390 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9395 =for apidoc sv_setref_iv
9397 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9398 argument will be upgraded to an RV. That RV will be modified to point to
9399 the new SV. The C<classname> argument indicates the package for the
9400 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9401 will have a reference count of 1, and the RV will be returned.
9407 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9409 PERL_ARGS_ASSERT_SV_SETREF_IV;
9411 sv_setiv(newSVrv(rv,classname), iv);
9416 =for apidoc sv_setref_uv
9418 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9419 argument will be upgraded to an RV. That RV will be modified to point to
9420 the new SV. The C<classname> argument indicates the package for the
9421 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9422 will have a reference count of 1, and the RV will be returned.
9428 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9430 PERL_ARGS_ASSERT_SV_SETREF_UV;
9432 sv_setuv(newSVrv(rv,classname), uv);
9437 =for apidoc sv_setref_nv
9439 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9440 argument will be upgraded to an RV. That RV will be modified to point to
9441 the new SV. The C<classname> argument indicates the package for the
9442 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9443 will have a reference count of 1, and the RV will be returned.
9449 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9451 PERL_ARGS_ASSERT_SV_SETREF_NV;
9453 sv_setnv(newSVrv(rv,classname), nv);
9458 =for apidoc sv_setref_pvn
9460 Copies a string into a new SV, optionally blessing the SV. The length of the
9461 string must be specified with C<n>. The C<rv> argument will be upgraded to
9462 an RV. That RV will be modified to point to the new SV. The C<classname>
9463 argument indicates the package for the blessing. Set C<classname> to
9464 C<NULL> to avoid the blessing. The new SV will have a reference count
9465 of 1, and the RV will be returned.
9467 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9473 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9474 const char *const pv, const STRLEN n)
9476 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9478 sv_setpvn(newSVrv(rv,classname), pv, n);
9483 =for apidoc sv_bless
9485 Blesses an SV into a specified package. The SV must be an RV. The package
9486 must be designated by its stash (see C<gv_stashpv()>). The reference count
9487 of the SV is unaffected.
9493 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9498 PERL_ARGS_ASSERT_SV_BLESS;
9501 Perl_croak(aTHX_ "Can't bless non-reference value");
9503 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9504 if (SvIsCOW(tmpRef))
9505 sv_force_normal_flags(tmpRef, 0);
9506 if (SvREADONLY(tmpRef))
9507 Perl_croak_no_modify(aTHX);
9508 if (SvOBJECT(tmpRef)) {
9509 if (SvTYPE(tmpRef) != SVt_PVIO)
9511 SvREFCNT_dec(SvSTASH(tmpRef));
9514 SvOBJECT_on(tmpRef);
9515 if (SvTYPE(tmpRef) != SVt_PVIO)
9517 SvUPGRADE(tmpRef, SVt_PVMG);
9518 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9523 (void)SvAMAGIC_off(sv);
9525 if(SvSMAGICAL(tmpRef))
9526 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9534 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9535 * as it is after unglobbing it.
9538 PERL_STATIC_INLINE void
9539 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9544 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9546 PERL_ARGS_ASSERT_SV_UNGLOB;
9548 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9550 if (!(flags & SV_COW_DROP_PV))
9551 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9554 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9555 && HvNAME_get(stash))
9556 mro_method_changed_in(stash);
9557 gp_free(MUTABLE_GV(sv));
9560 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9564 if (GvNAME_HEK(sv)) {
9565 unshare_hek(GvNAME_HEK(sv));
9567 isGV_with_GP_off(sv);
9569 if(SvTYPE(sv) == SVt_PVGV) {
9570 /* need to keep SvANY(sv) in the right arena */
9571 xpvmg = new_XPVMG();
9572 StructCopy(SvANY(sv), xpvmg, XPVMG);
9573 del_XPVGV(SvANY(sv));
9576 SvFLAGS(sv) &= ~SVTYPEMASK;
9577 SvFLAGS(sv) |= SVt_PVMG;
9580 /* Intentionally not calling any local SET magic, as this isn't so much a
9581 set operation as merely an internal storage change. */
9582 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9583 else sv_setsv_flags(sv, temp, 0);
9585 if ((const GV *)sv == PL_last_in_gv)
9586 PL_last_in_gv = NULL;
9587 else if ((const GV *)sv == PL_statgv)
9592 =for apidoc sv_unref_flags
9594 Unsets the RV status of the SV, and decrements the reference count of
9595 whatever was being referenced by the RV. This can almost be thought of
9596 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9597 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9598 (otherwise the decrementing is conditional on the reference count being
9599 different from one or the reference being a readonly SV).
9606 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9608 SV* const target = SvRV(ref);
9610 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9612 if (SvWEAKREF(ref)) {
9613 sv_del_backref(target, ref);
9615 SvRV_set(ref, NULL);
9618 SvRV_set(ref, NULL);
9620 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9621 assigned to as BEGIN {$a = \"Foo"} will fail. */
9622 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9623 SvREFCNT_dec(target);
9624 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9625 sv_2mortal(target); /* Schedule for freeing later */
9629 =for apidoc sv_untaint
9631 Untaint an SV. Use C<SvTAINTED_off> instead.
9637 Perl_sv_untaint(pTHX_ SV *const sv)
9639 PERL_ARGS_ASSERT_SV_UNTAINT;
9641 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9642 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9649 =for apidoc sv_tainted
9651 Test an SV for taintedness. Use C<SvTAINTED> instead.
9657 Perl_sv_tainted(pTHX_ SV *const sv)
9659 PERL_ARGS_ASSERT_SV_TAINTED;
9661 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9662 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9663 if (mg && (mg->mg_len & 1) )
9670 =for apidoc sv_setpviv
9672 Copies an integer into the given SV, also updating its string value.
9673 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9679 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9681 char buf[TYPE_CHARS(UV)];
9683 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9685 PERL_ARGS_ASSERT_SV_SETPVIV;
9687 sv_setpvn(sv, ptr, ebuf - ptr);
9691 =for apidoc sv_setpviv_mg
9693 Like C<sv_setpviv>, but also handles 'set' magic.
9699 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9701 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9707 #if defined(PERL_IMPLICIT_CONTEXT)
9709 /* pTHX_ magic can't cope with varargs, so this is a no-context
9710 * version of the main function, (which may itself be aliased to us).
9711 * Don't access this version directly.
9715 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9720 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9722 va_start(args, pat);
9723 sv_vsetpvf(sv, pat, &args);
9727 /* pTHX_ magic can't cope with varargs, so this is a no-context
9728 * version of the main function, (which may itself be aliased to us).
9729 * Don't access this version directly.
9733 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9738 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9740 va_start(args, pat);
9741 sv_vsetpvf_mg(sv, pat, &args);
9747 =for apidoc sv_setpvf
9749 Works like C<sv_catpvf> but copies the text into the SV instead of
9750 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9756 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9760 PERL_ARGS_ASSERT_SV_SETPVF;
9762 va_start(args, pat);
9763 sv_vsetpvf(sv, pat, &args);
9768 =for apidoc sv_vsetpvf
9770 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9771 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9773 Usually used via its frontend C<sv_setpvf>.
9779 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9781 PERL_ARGS_ASSERT_SV_VSETPVF;
9783 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9787 =for apidoc sv_setpvf_mg
9789 Like C<sv_setpvf>, but also handles 'set' magic.
9795 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9799 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9801 va_start(args, pat);
9802 sv_vsetpvf_mg(sv, pat, &args);
9807 =for apidoc sv_vsetpvf_mg
9809 Like C<sv_vsetpvf>, but also handles 'set' magic.
9811 Usually used via its frontend C<sv_setpvf_mg>.
9817 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9819 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9821 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9825 #if defined(PERL_IMPLICIT_CONTEXT)
9827 /* pTHX_ magic can't cope with varargs, so this is a no-context
9828 * version of the main function, (which may itself be aliased to us).
9829 * Don't access this version directly.
9833 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9838 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9840 va_start(args, pat);
9841 sv_vcatpvf(sv, pat, &args);
9845 /* pTHX_ magic can't cope with varargs, so this is a no-context
9846 * version of the main function, (which may itself be aliased to us).
9847 * Don't access this version directly.
9851 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9856 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9858 va_start(args, pat);
9859 sv_vcatpvf_mg(sv, pat, &args);
9865 =for apidoc sv_catpvf
9867 Processes its arguments like C<sprintf> and appends the formatted
9868 output to an SV. If the appended data contains "wide" characters
9869 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9870 and characters >255 formatted with %c), the original SV might get
9871 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9872 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9873 valid UTF-8; if the original SV was bytes, the pattern should be too.
9878 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9882 PERL_ARGS_ASSERT_SV_CATPVF;
9884 va_start(args, pat);
9885 sv_vcatpvf(sv, pat, &args);
9890 =for apidoc sv_vcatpvf
9892 Processes its arguments like C<vsprintf> and appends the formatted output
9893 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9895 Usually used via its frontend C<sv_catpvf>.
9901 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9903 PERL_ARGS_ASSERT_SV_VCATPVF;
9905 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9909 =for apidoc sv_catpvf_mg
9911 Like C<sv_catpvf>, but also handles 'set' magic.
9917 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9921 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9923 va_start(args, pat);
9924 sv_vcatpvf_mg(sv, pat, &args);
9929 =for apidoc sv_vcatpvf_mg
9931 Like C<sv_vcatpvf>, but also handles 'set' magic.
9933 Usually used via its frontend C<sv_catpvf_mg>.
9939 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9941 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9943 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9948 =for apidoc sv_vsetpvfn
9950 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9953 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9959 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9960 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9962 PERL_ARGS_ASSERT_SV_VSETPVFN;
9965 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9970 * Warn of missing argument to sprintf, and then return a defined value
9971 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9973 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9975 S_vcatpvfn_missing_argument(pTHX) {
9976 if (ckWARN(WARN_MISSING)) {
9977 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9978 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9985 S_expect_number(pTHX_ char **const pattern)
9990 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9992 switch (**pattern) {
9993 case '1': case '2': case '3':
9994 case '4': case '5': case '6':
9995 case '7': case '8': case '9':
9996 var = *(*pattern)++ - '0';
9997 while (isDIGIT(**pattern)) {
9998 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
10000 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
10008 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
10010 const int neg = nv < 0;
10013 PERL_ARGS_ASSERT_F0CONVERT;
10021 if (uv & 1 && uv == nv)
10022 uv--; /* Round to even */
10024 const unsigned dig = uv % 10;
10026 } while (uv /= 10);
10037 =for apidoc sv_vcatpvfn
10039 Processes its arguments like C<vsprintf> and appends the formatted output
10040 to an SV. Uses an array of SVs if the C style variable argument list is
10041 missing (NULL). When running with taint checks enabled, indicates via
10042 C<maybe_tainted> if results are untrustworthy (often due to the use of
10045 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10051 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10052 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10053 vec_utf8 = DO_UTF8(vecsv);
10055 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10058 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10059 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10064 const char *patend;
10067 static const char nullstr[] = "(null)";
10069 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10070 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10072 /* Times 4: a decimal digit takes more than 3 binary digits.
10073 * NV_DIG: mantissa takes than many decimal digits.
10074 * Plus 32: Playing safe. */
10075 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10076 /* large enough for "%#.#f" --chip */
10077 /* what about long double NVs? --jhi */
10079 PERL_ARGS_ASSERT_SV_VCATPVFN;
10080 PERL_UNUSED_ARG(maybe_tainted);
10082 /* no matter what, this is a string now */
10083 (void)SvPV_force(sv, origlen);
10085 /* special-case "", "%s", and "%-p" (SVf - see below) */
10088 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10090 const char * const s = va_arg(*args, char*);
10091 sv_catpv(sv, s ? s : nullstr);
10093 else if (svix < svmax) {
10094 sv_catsv(sv, *svargs);
10097 S_vcatpvfn_missing_argument(aTHX);
10100 if (args && patlen == 3 && pat[0] == '%' &&
10101 pat[1] == '-' && pat[2] == 'p') {
10102 argsv = MUTABLE_SV(va_arg(*args, void*));
10103 sv_catsv(sv, argsv);
10107 #ifndef USE_LONG_DOUBLE
10108 /* special-case "%.<number>[gf]" */
10109 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10110 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10111 unsigned digits = 0;
10115 while (*pp >= '0' && *pp <= '9')
10116 digits = 10 * digits + (*pp++ - '0');
10117 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10118 const NV nv = SvNV(*svargs);
10120 /* Add check for digits != 0 because it seems that some
10121 gconverts are buggy in this case, and we don't yet have
10122 a Configure test for this. */
10123 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10124 /* 0, point, slack */
10125 Gconvert(nv, (int)digits, 0, ebuf);
10126 sv_catpv(sv, ebuf);
10127 if (*ebuf) /* May return an empty string for digits==0 */
10130 } else if (!digits) {
10133 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10134 sv_catpvn(sv, p, l);
10140 #endif /* !USE_LONG_DOUBLE */
10142 if (!args && svix < svmax && DO_UTF8(*svargs))
10145 patend = (char*)pat + patlen;
10146 for (p = (char*)pat; p < patend; p = q) {
10149 bool vectorize = FALSE;
10150 bool vectorarg = FALSE;
10151 bool vec_utf8 = FALSE;
10157 bool has_precis = FALSE;
10159 const I32 osvix = svix;
10160 bool is_utf8 = FALSE; /* is this item utf8? */
10161 #ifdef HAS_LDBL_SPRINTF_BUG
10162 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10163 with sfio - Allen <allens@cpan.org> */
10164 bool fix_ldbl_sprintf_bug = FALSE;
10168 U8 utf8buf[UTF8_MAXBYTES+1];
10169 STRLEN esignlen = 0;
10171 const char *eptr = NULL;
10172 const char *fmtstart;
10175 const U8 *vecstr = NULL;
10182 /* we need a long double target in case HAS_LONG_DOUBLE but
10183 not USE_LONG_DOUBLE
10185 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10193 const char *dotstr = ".";
10194 STRLEN dotstrlen = 1;
10195 I32 efix = 0; /* explicit format parameter index */
10196 I32 ewix = 0; /* explicit width index */
10197 I32 epix = 0; /* explicit precision index */
10198 I32 evix = 0; /* explicit vector index */
10199 bool asterisk = FALSE;
10201 /* echo everything up to the next format specification */
10202 for (q = p; q < patend && *q != '%'; ++q) ;
10204 if (has_utf8 && !pat_utf8)
10205 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10207 sv_catpvn(sv, p, q - p);
10216 We allow format specification elements in this order:
10217 \d+\$ explicit format parameter index
10219 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10220 0 flag (as above): repeated to allow "v02"
10221 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10222 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10224 [%bcdefginopsuxDFOUX] format (mandatory)
10229 As of perl5.9.3, printf format checking is on by default.
10230 Internally, perl uses %p formats to provide an escape to
10231 some extended formatting. This block deals with those
10232 extensions: if it does not match, (char*)q is reset and
10233 the normal format processing code is used.
10235 Currently defined extensions are:
10236 %p include pointer address (standard)
10237 %-p (SVf) include an SV (previously %_)
10238 %-<num>p include an SV with precision <num>
10240 %3p include a HEK with precision of 256
10241 %<num>p (where num != 2 or 3) reserved for future
10244 Robin Barker 2005-07-14 (but modified since)
10246 %1p (VDf) removed. RMB 2007-10-19
10253 n = expect_number(&q);
10255 if (sv) { /* SVf */
10260 argsv = MUTABLE_SV(va_arg(*args, void*));
10261 eptr = SvPV_const(argsv, elen);
10262 if (DO_UTF8(argsv))
10266 else if (n==2 || n==3) { /* HEKf */
10267 HEK * const hek = va_arg(*args, HEK *);
10268 eptr = HEK_KEY(hek);
10269 elen = HEK_LEN(hek);
10270 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10271 if (n==3) precis = 256, has_precis = TRUE;
10275 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10276 "internal %%<num>p might conflict with future printf extensions");
10282 if ( (width = expect_number(&q)) ) {
10297 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10326 if ( (ewix = expect_number(&q)) )
10335 if ((vectorarg = asterisk)) {
10348 width = expect_number(&q);
10351 if (vectorize && vectorarg) {
10352 /* vectorizing, but not with the default "." */
10354 vecsv = va_arg(*args, SV*);
10356 vecsv = (evix > 0 && evix <= svmax)
10357 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10359 vecsv = svix < svmax
10360 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10362 dotstr = SvPV_const(vecsv, dotstrlen);
10363 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10364 bad with tied or overloaded values that return UTF8. */
10365 if (DO_UTF8(vecsv))
10367 else if (has_utf8) {
10368 vecsv = sv_mortalcopy(vecsv);
10369 sv_utf8_upgrade(vecsv);
10370 dotstr = SvPV_const(vecsv, dotstrlen);
10377 i = va_arg(*args, int);
10379 i = (ewix ? ewix <= svmax : svix < svmax) ?
10380 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10382 width = (i < 0) ? -i : i;
10392 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10394 /* XXX: todo, support specified precision parameter */
10398 i = va_arg(*args, int);
10400 i = (ewix ? ewix <= svmax : svix < svmax)
10401 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10403 has_precis = !(i < 0);
10407 while (isDIGIT(*q))
10408 precis = precis * 10 + (*q++ - '0');
10417 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10418 vecsv = svargs[efix ? efix-1 : svix++];
10419 vecstr = (U8*)SvPV_const(vecsv,veclen);
10420 vec_utf8 = DO_UTF8(vecsv);
10422 /* if this is a version object, we need to convert
10423 * back into v-string notation and then let the
10424 * vectorize happen normally
10426 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10427 char *version = savesvpv(vecsv);
10428 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10429 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10430 "vector argument not supported with alpha versions");
10433 vecsv = sv_newmortal();
10434 scan_vstring(version, version + veclen, vecsv);
10435 vecstr = (U8*)SvPV_const(vecsv, veclen);
10436 vec_utf8 = DO_UTF8(vecsv);
10450 case 'I': /* Ix, I32x, and I64x */
10452 if (q[1] == '6' && q[2] == '4') {
10458 if (q[1] == '3' && q[2] == '2') {
10468 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10480 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10481 if (*q == 'l') { /* lld, llf */
10490 if (*++q == 'h') { /* hhd, hhu */
10519 if (!vectorize && !args) {
10521 const I32 i = efix-1;
10522 argsv = (i >= 0 && i < svmax)
10523 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10525 argsv = (svix >= 0 && svix < svmax)
10526 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10530 switch (c = *q++) {
10537 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10539 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10541 eptr = (char*)utf8buf;
10542 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10556 eptr = va_arg(*args, char*);
10558 elen = strlen(eptr);
10560 eptr = (char *)nullstr;
10561 elen = sizeof nullstr - 1;
10565 eptr = SvPV_const(argsv, elen);
10566 if (DO_UTF8(argsv)) {
10567 STRLEN old_precis = precis;
10568 if (has_precis && precis < elen) {
10569 STRLEN ulen = sv_len_utf8(argsv);
10570 I32 p = precis > ulen ? ulen : precis;
10571 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10574 if (width) { /* fudge width (can't fudge elen) */
10575 if (has_precis && precis < elen)
10576 width += precis - old_precis;
10578 width += elen - sv_len_utf8(argsv);
10585 if (has_precis && precis < elen)
10592 if (alt || vectorize)
10594 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10615 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10624 esignbuf[esignlen++] = plus;
10628 case 'c': iv = (char)va_arg(*args, int); break;
10629 case 'h': iv = (short)va_arg(*args, int); break;
10630 case 'l': iv = va_arg(*args, long); break;
10631 case 'V': iv = va_arg(*args, IV); break;
10632 case 'z': iv = va_arg(*args, SSize_t); break;
10633 case 't': iv = va_arg(*args, ptrdiff_t); break;
10634 default: iv = va_arg(*args, int); break;
10636 case 'j': iv = va_arg(*args, intmax_t); break;
10640 iv = va_arg(*args, Quad_t); break;
10647 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10649 case 'c': iv = (char)tiv; break;
10650 case 'h': iv = (short)tiv; break;
10651 case 'l': iv = (long)tiv; break;
10653 default: iv = tiv; break;
10656 iv = (Quad_t)tiv; break;
10662 if ( !vectorize ) /* we already set uv above */
10667 esignbuf[esignlen++] = plus;
10671 esignbuf[esignlen++] = '-';
10715 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10726 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10727 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10728 case 'l': uv = va_arg(*args, unsigned long); break;
10729 case 'V': uv = va_arg(*args, UV); break;
10730 case 'z': uv = va_arg(*args, Size_t); break;
10731 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10733 case 'j': uv = va_arg(*args, uintmax_t); break;
10735 default: uv = va_arg(*args, unsigned); break;
10738 uv = va_arg(*args, Uquad_t); break;
10745 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10747 case 'c': uv = (unsigned char)tuv; break;
10748 case 'h': uv = (unsigned short)tuv; break;
10749 case 'l': uv = (unsigned long)tuv; break;
10751 default: uv = tuv; break;
10754 uv = (Uquad_t)tuv; break;
10763 char *ptr = ebuf + sizeof ebuf;
10764 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10770 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10774 } while (uv >>= 4);
10776 esignbuf[esignlen++] = '0';
10777 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10783 *--ptr = '0' + dig;
10784 } while (uv >>= 3);
10785 if (alt && *ptr != '0')
10791 *--ptr = '0' + dig;
10792 } while (uv >>= 1);
10794 esignbuf[esignlen++] = '0';
10795 esignbuf[esignlen++] = c;
10798 default: /* it had better be ten or less */
10801 *--ptr = '0' + dig;
10802 } while (uv /= base);
10805 elen = (ebuf + sizeof ebuf) - ptr;
10809 zeros = precis - elen;
10810 else if (precis == 0 && elen == 1 && *eptr == '0'
10811 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10814 /* a precision nullifies the 0 flag. */
10821 /* FLOATING POINT */
10824 c = 'f'; /* maybe %F isn't supported here */
10826 case 'e': case 'E':
10828 case 'g': case 'G':
10832 /* This is evil, but floating point is even more evil */
10834 /* for SV-style calling, we can only get NV
10835 for C-style calling, we assume %f is double;
10836 for simplicity we allow any of %Lf, %llf, %qf for long double
10840 #if defined(USE_LONG_DOUBLE)
10844 /* [perl #20339] - we should accept and ignore %lf rather than die */
10848 #if defined(USE_LONG_DOUBLE)
10849 intsize = args ? 0 : 'q';
10853 #if defined(HAS_LONG_DOUBLE)
10866 /* now we need (long double) if intsize == 'q', else (double) */
10868 #if LONG_DOUBLESIZE > DOUBLESIZE
10870 va_arg(*args, long double) :
10871 va_arg(*args, double)
10873 va_arg(*args, double)
10878 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10879 else. frexp() has some unspecified behaviour for those three */
10880 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10882 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10883 will cast our (long double) to (double) */
10884 (void)Perl_frexp(nv, &i);
10885 if (i == PERL_INT_MIN)
10886 Perl_die(aTHX_ "panic: frexp");
10888 need = BIT_DIGITS(i);
10890 need += has_precis ? precis : 6; /* known default */
10895 #ifdef HAS_LDBL_SPRINTF_BUG
10896 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10897 with sfio - Allen <allens@cpan.org> */
10900 # define MY_DBL_MAX DBL_MAX
10901 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10902 # if DOUBLESIZE >= 8
10903 # define MY_DBL_MAX 1.7976931348623157E+308L
10905 # define MY_DBL_MAX 3.40282347E+38L
10909 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10910 # define MY_DBL_MAX_BUG 1L
10912 # define MY_DBL_MAX_BUG MY_DBL_MAX
10916 # define MY_DBL_MIN DBL_MIN
10917 # else /* XXX guessing! -Allen */
10918 # if DOUBLESIZE >= 8
10919 # define MY_DBL_MIN 2.2250738585072014E-308L
10921 # define MY_DBL_MIN 1.17549435E-38L
10925 if ((intsize == 'q') && (c == 'f') &&
10926 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10927 (need < DBL_DIG)) {
10928 /* it's going to be short enough that
10929 * long double precision is not needed */
10931 if ((nv <= 0L) && (nv >= -0L))
10932 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10934 /* would use Perl_fp_class as a double-check but not
10935 * functional on IRIX - see perl.h comments */
10937 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10938 /* It's within the range that a double can represent */
10939 #if defined(DBL_MAX) && !defined(DBL_MIN)
10940 if ((nv >= ((long double)1/DBL_MAX)) ||
10941 (nv <= (-(long double)1/DBL_MAX)))
10943 fix_ldbl_sprintf_bug = TRUE;
10946 if (fix_ldbl_sprintf_bug == TRUE) {
10956 # undef MY_DBL_MAX_BUG
10959 #endif /* HAS_LDBL_SPRINTF_BUG */
10961 need += 20; /* fudge factor */
10962 if (PL_efloatsize < need) {
10963 Safefree(PL_efloatbuf);
10964 PL_efloatsize = need + 20; /* more fudge */
10965 Newx(PL_efloatbuf, PL_efloatsize, char);
10966 PL_efloatbuf[0] = '\0';
10969 if ( !(width || left || plus || alt) && fill != '0'
10970 && has_precis && intsize != 'q' ) { /* Shortcuts */
10971 /* See earlier comment about buggy Gconvert when digits,
10973 if ( c == 'g' && precis) {
10974 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10975 /* May return an empty string for digits==0 */
10976 if (*PL_efloatbuf) {
10977 elen = strlen(PL_efloatbuf);
10978 goto float_converted;
10980 } else if ( c == 'f' && !precis) {
10981 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10986 char *ptr = ebuf + sizeof ebuf;
10989 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10990 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10991 if (intsize == 'q') {
10992 /* Copy the one or more characters in a long double
10993 * format before the 'base' ([efgEFG]) character to
10994 * the format string. */
10995 static char const prifldbl[] = PERL_PRIfldbl;
10996 char const *p = prifldbl + sizeof(prifldbl) - 3;
10997 while (p >= prifldbl) { *--ptr = *p--; }
11002 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11007 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11019 /* No taint. Otherwise we are in the strange situation
11020 * where printf() taints but print($float) doesn't.
11022 #if defined(HAS_LONG_DOUBLE)
11023 elen = ((intsize == 'q')
11024 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
11025 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
11027 elen = my_sprintf(PL_efloatbuf, ptr, nv);
11031 eptr = PL_efloatbuf;
11039 i = SvCUR(sv) - origlen;
11042 case 'c': *(va_arg(*args, char*)) = i; break;
11043 case 'h': *(va_arg(*args, short*)) = i; break;
11044 default: *(va_arg(*args, int*)) = i; break;
11045 case 'l': *(va_arg(*args, long*)) = i; break;
11046 case 'V': *(va_arg(*args, IV*)) = i; break;
11047 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11048 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11050 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11054 *(va_arg(*args, Quad_t*)) = i; break;
11061 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11062 continue; /* not "break" */
11069 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11070 && ckWARN(WARN_PRINTF))
11072 SV * const msg = sv_newmortal();
11073 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11074 (PL_op->op_type == OP_PRTF) ? "" : "s");
11075 if (fmtstart < patend) {
11076 const char * const fmtend = q < patend ? q : patend;
11078 sv_catpvs(msg, "\"%");
11079 for (f = fmtstart; f < fmtend; f++) {
11081 sv_catpvn(msg, f, 1);
11083 Perl_sv_catpvf(aTHX_ msg,
11084 "\\%03"UVof, (UV)*f & 0xFF);
11087 sv_catpvs(msg, "\"");
11089 sv_catpvs(msg, "end of string");
11091 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11094 /* output mangled stuff ... */
11100 /* ... right here, because formatting flags should not apply */
11101 SvGROW(sv, SvCUR(sv) + elen + 1);
11103 Copy(eptr, p, elen, char);
11106 SvCUR_set(sv, p - SvPVX_const(sv));
11108 continue; /* not "break" */
11111 if (is_utf8 != has_utf8) {
11114 sv_utf8_upgrade(sv);
11117 const STRLEN old_elen = elen;
11118 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11119 sv_utf8_upgrade(nsv);
11120 eptr = SvPVX_const(nsv);
11123 if (width) { /* fudge width (can't fudge elen) */
11124 width += elen - old_elen;
11130 have = esignlen + zeros + elen;
11132 Perl_croak_nocontext("%s", PL_memory_wrap);
11134 need = (have > width ? have : width);
11137 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11138 Perl_croak_nocontext("%s", PL_memory_wrap);
11139 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11141 if (esignlen && fill == '0') {
11143 for (i = 0; i < (int)esignlen; i++)
11144 *p++ = esignbuf[i];
11146 if (gap && !left) {
11147 memset(p, fill, gap);
11150 if (esignlen && fill != '0') {
11152 for (i = 0; i < (int)esignlen; i++)
11153 *p++ = esignbuf[i];
11157 for (i = zeros; i; i--)
11161 Copy(eptr, p, elen, char);
11165 memset(p, ' ', gap);
11170 Copy(dotstr, p, dotstrlen, char);
11174 vectorize = FALSE; /* done iterating over vecstr */
11181 SvCUR_set(sv, p - SvPVX_const(sv));
11190 /* =========================================================================
11192 =head1 Cloning an interpreter
11194 All the macros and functions in this section are for the private use of
11195 the main function, perl_clone().
11197 The foo_dup() functions make an exact copy of an existing foo thingy.
11198 During the course of a cloning, a hash table is used to map old addresses
11199 to new addresses. The table is created and manipulated with the
11200 ptr_table_* functions.
11204 * =========================================================================*/
11207 #if defined(USE_ITHREADS)
11209 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11210 #ifndef GpREFCNT_inc
11211 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11215 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11216 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11217 If this changes, please unmerge ss_dup.
11218 Likewise, sv_dup_inc_multiple() relies on this fact. */
11219 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11220 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11221 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11222 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11223 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11224 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11225 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11226 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11227 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11228 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11229 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11230 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11231 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11233 /* clone a parser */
11236 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11240 PERL_ARGS_ASSERT_PARSER_DUP;
11245 /* look for it in the table first */
11246 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11250 /* create anew and remember what it is */
11251 Newxz(parser, 1, yy_parser);
11252 ptr_table_store(PL_ptr_table, proto, parser);
11254 /* XXX these not yet duped */
11255 parser->old_parser = NULL;
11256 parser->stack = NULL;
11258 parser->stack_size = 0;
11259 /* XXX parser->stack->state = 0; */
11261 /* XXX eventually, just Copy() most of the parser struct ? */
11263 parser->lex_brackets = proto->lex_brackets;
11264 parser->lex_casemods = proto->lex_casemods;
11265 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11266 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11267 parser->lex_casestack = savepvn(proto->lex_casestack,
11268 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11269 parser->lex_defer = proto->lex_defer;
11270 parser->lex_dojoin = proto->lex_dojoin;
11271 parser->lex_expect = proto->lex_expect;
11272 parser->lex_formbrack = proto->lex_formbrack;
11273 parser->lex_inpat = proto->lex_inpat;
11274 parser->lex_inwhat = proto->lex_inwhat;
11275 parser->lex_op = proto->lex_op;
11276 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11277 parser->lex_starts = proto->lex_starts;
11278 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11279 parser->multi_close = proto->multi_close;
11280 parser->multi_open = proto->multi_open;
11281 parser->multi_start = proto->multi_start;
11282 parser->multi_end = proto->multi_end;
11283 parser->pending_ident = proto->pending_ident;
11284 parser->preambled = proto->preambled;
11285 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11286 parser->linestr = sv_dup_inc(proto->linestr, param);
11287 parser->expect = proto->expect;
11288 parser->copline = proto->copline;
11289 parser->last_lop_op = proto->last_lop_op;
11290 parser->lex_state = proto->lex_state;
11291 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11292 /* rsfp_filters entries have fake IoDIRP() */
11293 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11294 parser->in_my = proto->in_my;
11295 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11296 parser->error_count = proto->error_count;
11299 parser->linestr = sv_dup_inc(proto->linestr, param);
11302 char * const ols = SvPVX(proto->linestr);
11303 char * const ls = SvPVX(parser->linestr);
11305 parser->bufptr = ls + (proto->bufptr >= ols ?
11306 proto->bufptr - ols : 0);
11307 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11308 proto->oldbufptr - ols : 0);
11309 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11310 proto->oldoldbufptr - ols : 0);
11311 parser->linestart = ls + (proto->linestart >= ols ?
11312 proto->linestart - ols : 0);
11313 parser->last_uni = ls + (proto->last_uni >= ols ?
11314 proto->last_uni - ols : 0);
11315 parser->last_lop = ls + (proto->last_lop >= ols ?
11316 proto->last_lop - ols : 0);
11318 parser->bufend = ls + SvCUR(parser->linestr);
11321 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11325 parser->endwhite = proto->endwhite;
11326 parser->faketokens = proto->faketokens;
11327 parser->lasttoke = proto->lasttoke;
11328 parser->nextwhite = proto->nextwhite;
11329 parser->realtokenstart = proto->realtokenstart;
11330 parser->skipwhite = proto->skipwhite;
11331 parser->thisclose = proto->thisclose;
11332 parser->thismad = proto->thismad;
11333 parser->thisopen = proto->thisopen;
11334 parser->thisstuff = proto->thisstuff;
11335 parser->thistoken = proto->thistoken;
11336 parser->thiswhite = proto->thiswhite;
11338 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11339 parser->curforce = proto->curforce;
11341 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11342 Copy(proto->nexttype, parser->nexttype, 5, I32);
11343 parser->nexttoke = proto->nexttoke;
11346 /* XXX should clone saved_curcop here, but we aren't passed
11347 * proto_perl; so do it in perl_clone_using instead */
11353 /* duplicate a file handle */
11356 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11360 PERL_ARGS_ASSERT_FP_DUP;
11361 PERL_UNUSED_ARG(type);
11364 return (PerlIO*)NULL;
11366 /* look for it in the table first */
11367 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11371 /* create anew and remember what it is */
11372 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11373 ptr_table_store(PL_ptr_table, fp, ret);
11377 /* duplicate a directory handle */
11380 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11386 register const Direntry_t *dirent;
11387 char smallbuf[256];
11393 PERL_UNUSED_CONTEXT;
11394 PERL_ARGS_ASSERT_DIRP_DUP;
11399 /* look for it in the table first */
11400 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11406 PERL_UNUSED_ARG(param);
11410 /* open the current directory (so we can switch back) */
11411 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11413 /* chdir to our dir handle and open the present working directory */
11414 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11415 PerlDir_close(pwd);
11416 return (DIR *)NULL;
11418 /* Now we should have two dir handles pointing to the same dir. */
11420 /* Be nice to the calling code and chdir back to where we were. */
11421 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11423 /* We have no need of the pwd handle any more. */
11424 PerlDir_close(pwd);
11427 # define d_namlen(d) (d)->d_namlen
11429 # define d_namlen(d) strlen((d)->d_name)
11431 /* Iterate once through dp, to get the file name at the current posi-
11432 tion. Then step back. */
11433 pos = PerlDir_tell(dp);
11434 if ((dirent = PerlDir_read(dp))) {
11435 len = d_namlen(dirent);
11436 if (len <= sizeof smallbuf) name = smallbuf;
11437 else Newx(name, len, char);
11438 Move(dirent->d_name, name, len, char);
11440 PerlDir_seek(dp, pos);
11442 /* Iterate through the new dir handle, till we find a file with the
11444 if (!dirent) /* just before the end */
11446 pos = PerlDir_tell(ret);
11447 if (PerlDir_read(ret)) continue; /* not there yet */
11448 PerlDir_seek(ret, pos); /* step back */
11452 const long pos0 = PerlDir_tell(ret);
11454 pos = PerlDir_tell(ret);
11455 if ((dirent = PerlDir_read(ret))) {
11456 if (len == d_namlen(dirent)
11457 && memEQ(name, dirent->d_name, len)) {
11459 PerlDir_seek(ret, pos); /* step back */
11462 /* else we are not there yet; keep iterating */
11464 else { /* This is not meant to happen. The best we can do is
11465 reset the iterator to the beginning. */
11466 PerlDir_seek(ret, pos0);
11473 if (name && name != smallbuf)
11478 ret = win32_dirp_dup(dp, param);
11481 /* pop it in the pointer table */
11483 ptr_table_store(PL_ptr_table, dp, ret);
11488 /* duplicate a typeglob */
11491 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11495 PERL_ARGS_ASSERT_GP_DUP;
11499 /* look for it in the table first */
11500 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11504 /* create anew and remember what it is */
11506 ptr_table_store(PL_ptr_table, gp, ret);
11509 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11510 on Newxz() to do this for us. */
11511 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11512 ret->gp_io = io_dup_inc(gp->gp_io, param);
11513 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11514 ret->gp_av = av_dup_inc(gp->gp_av, param);
11515 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11516 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11517 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11518 ret->gp_cvgen = gp->gp_cvgen;
11519 ret->gp_line = gp->gp_line;
11520 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11524 /* duplicate a chain of magic */
11527 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11529 MAGIC *mgret = NULL;
11530 MAGIC **mgprev_p = &mgret;
11532 PERL_ARGS_ASSERT_MG_DUP;
11534 for (; mg; mg = mg->mg_moremagic) {
11537 if ((param->flags & CLONEf_JOIN_IN)
11538 && mg->mg_type == PERL_MAGIC_backref)
11539 /* when joining, we let the individual SVs add themselves to
11540 * backref as needed. */
11543 Newx(nmg, 1, MAGIC);
11545 mgprev_p = &(nmg->mg_moremagic);
11547 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11548 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11549 from the original commit adding Perl_mg_dup() - revision 4538.
11550 Similarly there is the annotation "XXX random ptr?" next to the
11551 assignment to nmg->mg_ptr. */
11554 /* FIXME for plugins
11555 if (nmg->mg_type == PERL_MAGIC_qr) {
11556 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11560 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11561 ? nmg->mg_type == PERL_MAGIC_backref
11562 /* The backref AV has its reference
11563 * count deliberately bumped by 1 */
11564 ? SvREFCNT_inc(av_dup_inc((const AV *)
11565 nmg->mg_obj, param))
11566 : sv_dup_inc(nmg->mg_obj, param)
11567 : sv_dup(nmg->mg_obj, param);
11569 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11570 if (nmg->mg_len > 0) {
11571 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11572 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11573 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11575 AMT * const namtp = (AMT*)nmg->mg_ptr;
11576 sv_dup_inc_multiple((SV**)(namtp->table),
11577 (SV**)(namtp->table), NofAMmeth, param);
11580 else if (nmg->mg_len == HEf_SVKEY)
11581 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11583 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11584 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11590 #endif /* USE_ITHREADS */
11592 struct ptr_tbl_arena {
11593 struct ptr_tbl_arena *next;
11594 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11597 /* create a new pointer-mapping table */
11600 Perl_ptr_table_new(pTHX)
11603 PERL_UNUSED_CONTEXT;
11605 Newx(tbl, 1, PTR_TBL_t);
11606 tbl->tbl_max = 511;
11607 tbl->tbl_items = 0;
11608 tbl->tbl_arena = NULL;
11609 tbl->tbl_arena_next = NULL;
11610 tbl->tbl_arena_end = NULL;
11611 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11615 #define PTR_TABLE_HASH(ptr) \
11616 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11618 /* map an existing pointer using a table */
11620 STATIC PTR_TBL_ENT_t *
11621 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11623 PTR_TBL_ENT_t *tblent;
11624 const UV hash = PTR_TABLE_HASH(sv);
11626 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11628 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11629 for (; tblent; tblent = tblent->next) {
11630 if (tblent->oldval == sv)
11637 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11639 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11641 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11642 PERL_UNUSED_CONTEXT;
11644 return tblent ? tblent->newval : NULL;
11647 /* add a new entry to a pointer-mapping table */
11650 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11652 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11654 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11655 PERL_UNUSED_CONTEXT;
11658 tblent->newval = newsv;
11660 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11662 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11663 struct ptr_tbl_arena *new_arena;
11665 Newx(new_arena, 1, struct ptr_tbl_arena);
11666 new_arena->next = tbl->tbl_arena;
11667 tbl->tbl_arena = new_arena;
11668 tbl->tbl_arena_next = new_arena->array;
11669 tbl->tbl_arena_end = new_arena->array
11670 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11673 tblent = tbl->tbl_arena_next++;
11675 tblent->oldval = oldsv;
11676 tblent->newval = newsv;
11677 tblent->next = tbl->tbl_ary[entry];
11678 tbl->tbl_ary[entry] = tblent;
11680 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11681 ptr_table_split(tbl);
11685 /* double the hash bucket size of an existing ptr table */
11688 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11690 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11691 const UV oldsize = tbl->tbl_max + 1;
11692 UV newsize = oldsize * 2;
11695 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11696 PERL_UNUSED_CONTEXT;
11698 Renew(ary, newsize, PTR_TBL_ENT_t*);
11699 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11700 tbl->tbl_max = --newsize;
11701 tbl->tbl_ary = ary;
11702 for (i=0; i < oldsize; i++, ary++) {
11703 PTR_TBL_ENT_t **entp = ary;
11704 PTR_TBL_ENT_t *ent = *ary;
11705 PTR_TBL_ENT_t **curentp;
11708 curentp = ary + oldsize;
11710 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11712 ent->next = *curentp;
11722 /* remove all the entries from a ptr table */
11723 /* Deprecated - will be removed post 5.14 */
11726 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11728 if (tbl && tbl->tbl_items) {
11729 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11731 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11734 struct ptr_tbl_arena *next = arena->next;
11740 tbl->tbl_items = 0;
11741 tbl->tbl_arena = NULL;
11742 tbl->tbl_arena_next = NULL;
11743 tbl->tbl_arena_end = NULL;
11747 /* clear and free a ptr table */
11750 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11752 struct ptr_tbl_arena *arena;
11758 arena = tbl->tbl_arena;
11761 struct ptr_tbl_arena *next = arena->next;
11767 Safefree(tbl->tbl_ary);
11771 #if defined(USE_ITHREADS)
11774 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11776 PERL_ARGS_ASSERT_RVPV_DUP;
11779 if (SvWEAKREF(sstr)) {
11780 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11781 if (param->flags & CLONEf_JOIN_IN) {
11782 /* if joining, we add any back references individually rather
11783 * than copying the whole backref array */
11784 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11788 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11790 else if (SvPVX_const(sstr)) {
11791 /* Has something there */
11793 /* Normal PV - clone whole allocated space */
11794 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11795 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11796 /* Not that normal - actually sstr is copy on write.
11797 But we are a true, independent SV, so: */
11798 SvREADONLY_off(dstr);
11803 /* Special case - not normally malloced for some reason */
11804 if (isGV_with_GP(sstr)) {
11805 /* Don't need to do anything here. */
11807 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11808 /* A "shared" PV - clone it as "shared" PV */
11810 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11814 /* Some other special case - random pointer */
11815 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11820 /* Copy the NULL */
11821 SvPV_set(dstr, NULL);
11825 /* duplicate a list of SVs. source and dest may point to the same memory. */
11827 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11828 SSize_t items, CLONE_PARAMS *const param)
11830 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11832 while (items-- > 0) {
11833 *dest++ = sv_dup_inc(*source++, param);
11839 /* duplicate an SV of any type (including AV, HV etc) */
11842 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11847 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11849 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11850 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11855 /* look for it in the table first */
11856 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11860 if(param->flags & CLONEf_JOIN_IN) {
11861 /** We are joining here so we don't want do clone
11862 something that is bad **/
11863 if (SvTYPE(sstr) == SVt_PVHV) {
11864 const HEK * const hvname = HvNAME_HEK(sstr);
11866 /** don't clone stashes if they already exist **/
11867 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11868 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11869 ptr_table_store(PL_ptr_table, sstr, dstr);
11873 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
11874 HV *stash = GvSTASH(sstr);
11875 const HEK * hvname;
11876 if (stash && (hvname = HvNAME_HEK(stash))) {
11877 /** don't clone GVs if they already exist **/
11879 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11880 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
11882 stash, GvNAME(sstr),
11888 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
11889 ptr_table_store(PL_ptr_table, sstr, *svp);
11896 /* create anew and remember what it is */
11899 #ifdef DEBUG_LEAKING_SCALARS
11900 dstr->sv_debug_optype = sstr->sv_debug_optype;
11901 dstr->sv_debug_line = sstr->sv_debug_line;
11902 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11903 dstr->sv_debug_parent = (SV*)sstr;
11904 FREE_SV_DEBUG_FILE(dstr);
11905 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11908 ptr_table_store(PL_ptr_table, sstr, dstr);
11911 SvFLAGS(dstr) = SvFLAGS(sstr);
11912 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11913 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11916 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11917 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11918 (void*)PL_watch_pvx, SvPVX_const(sstr));
11921 /* don't clone objects whose class has asked us not to */
11922 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11927 switch (SvTYPE(sstr)) {
11929 SvANY(dstr) = NULL;
11932 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11934 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11936 SvIV_set(dstr, SvIVX(sstr));
11940 SvANY(dstr) = new_XNV();
11941 SvNV_set(dstr, SvNVX(sstr));
11943 /* case SVt_BIND: */
11946 /* These are all the types that need complex bodies allocating. */
11948 const svtype sv_type = SvTYPE(sstr);
11949 const struct body_details *const sv_type_details
11950 = bodies_by_type + sv_type;
11954 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11969 assert(sv_type_details->body_size);
11970 if (sv_type_details->arena) {
11971 new_body_inline(new_body, sv_type);
11973 = (void*)((char*)new_body - sv_type_details->offset);
11975 new_body = new_NOARENA(sv_type_details);
11979 SvANY(dstr) = new_body;
11982 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11983 ((char*)SvANY(dstr)) + sv_type_details->offset,
11984 sv_type_details->copy, char);
11986 Copy(((char*)SvANY(sstr)),
11987 ((char*)SvANY(dstr)),
11988 sv_type_details->body_size + sv_type_details->offset, char);
11991 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11992 && !isGV_with_GP(dstr)
11993 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11994 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11996 /* The Copy above means that all the source (unduplicated) pointers
11997 are now in the destination. We can check the flags and the
11998 pointers in either, but it's possible that there's less cache
11999 missing by always going for the destination.
12000 FIXME - instrument and check that assumption */
12001 if (sv_type >= SVt_PVMG) {
12002 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
12003 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
12004 } else if (SvMAGIC(dstr))
12005 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
12007 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
12010 /* The cast silences a GCC warning about unhandled types. */
12011 switch ((int)sv_type) {
12021 /* FIXME for plugins */
12022 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
12025 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
12026 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
12027 LvTARG(dstr) = dstr;
12028 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
12029 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
12031 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
12033 /* non-GP case already handled above */
12034 if(isGV_with_GP(sstr)) {
12035 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12036 /* Don't call sv_add_backref here as it's going to be
12037 created as part of the magic cloning of the symbol
12038 table--unless this is during a join and the stash
12039 is not actually being cloned. */
12040 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12041 at the point of this comment. */
12042 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12043 if (param->flags & CLONEf_JOIN_IN)
12044 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12045 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12046 (void)GpREFCNT_inc(GvGP(dstr));
12050 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12051 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12052 /* I have no idea why fake dirp (rsfps)
12053 should be treated differently but otherwise
12054 we end up with leaks -- sky*/
12055 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12056 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12057 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12059 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12060 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12061 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12062 if (IoDIRP(dstr)) {
12063 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12066 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12068 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12070 if (IoOFP(dstr) == IoIFP(sstr))
12071 IoOFP(dstr) = IoIFP(dstr);
12073 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12074 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12075 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12076 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12079 /* avoid cloning an empty array */
12080 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12081 SV **dst_ary, **src_ary;
12082 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12084 src_ary = AvARRAY((const AV *)sstr);
12085 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12086 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12087 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12088 AvALLOC((const AV *)dstr) = dst_ary;
12089 if (AvREAL((const AV *)sstr)) {
12090 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12094 while (items-- > 0)
12095 *dst_ary++ = sv_dup(*src_ary++, param);
12097 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12098 while (items-- > 0) {
12099 *dst_ary++ = &PL_sv_undef;
12103 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12104 AvALLOC((const AV *)dstr) = (SV**)NULL;
12105 AvMAX( (const AV *)dstr) = -1;
12106 AvFILLp((const AV *)dstr) = -1;
12110 if (HvARRAY((const HV *)sstr)) {
12112 const bool sharekeys = !!HvSHAREKEYS(sstr);
12113 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12114 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12116 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12117 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12119 HvARRAY(dstr) = (HE**)darray;
12120 while (i <= sxhv->xhv_max) {
12121 const HE * const source = HvARRAY(sstr)[i];
12122 HvARRAY(dstr)[i] = source
12123 ? he_dup(source, sharekeys, param) : 0;
12127 const struct xpvhv_aux * const saux = HvAUX(sstr);
12128 struct xpvhv_aux * const daux = HvAUX(dstr);
12129 /* This flag isn't copied. */
12132 if (saux->xhv_name_count) {
12133 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12135 = saux->xhv_name_count < 0
12136 ? -saux->xhv_name_count
12137 : saux->xhv_name_count;
12138 HEK **shekp = sname + count;
12140 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12141 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12142 while (shekp-- > sname) {
12144 *dhekp = hek_dup(*shekp, param);
12148 daux->xhv_name_u.xhvnameu_name
12149 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12152 daux->xhv_name_count = saux->xhv_name_count;
12154 daux->xhv_riter = saux->xhv_riter;
12155 daux->xhv_eiter = saux->xhv_eiter
12156 ? he_dup(saux->xhv_eiter,
12157 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12158 /* backref array needs refcnt=2; see sv_add_backref */
12159 daux->xhv_backreferences =
12160 (param->flags & CLONEf_JOIN_IN)
12161 /* when joining, we let the individual GVs and
12162 * CVs add themselves to backref as
12163 * needed. This avoids pulling in stuff
12164 * that isn't required, and simplifies the
12165 * case where stashes aren't cloned back
12166 * if they already exist in the parent
12169 : saux->xhv_backreferences
12170 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12171 ? MUTABLE_AV(SvREFCNT_inc(
12172 sv_dup_inc((const SV *)
12173 saux->xhv_backreferences, param)))
12174 : MUTABLE_AV(sv_dup((const SV *)
12175 saux->xhv_backreferences, param))
12178 daux->xhv_mro_meta = saux->xhv_mro_meta
12179 ? mro_meta_dup(saux->xhv_mro_meta, param)
12182 /* Record stashes for possible cloning in Perl_clone(). */
12184 av_push(param->stashes, dstr);
12188 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12191 if (!(param->flags & CLONEf_COPY_STACKS)) {
12196 /* NOTE: not refcounted */
12197 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12198 hv_dup(CvSTASH(dstr), param);
12199 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12200 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12201 if (!CvISXSUB(dstr)) {
12203 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12205 } else if (CvCONST(dstr)) {
12206 CvXSUBANY(dstr).any_ptr =
12207 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12209 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12210 /* don't dup if copying back - CvGV isn't refcounted, so the
12211 * duped GV may never be freed. A bit of a hack! DAPM */
12212 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12214 ? gv_dup_inc(CvGV(sstr), param)
12215 : (param->flags & CLONEf_JOIN_IN)
12217 : gv_dup(CvGV(sstr), param);
12219 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12221 CvWEAKOUTSIDE(sstr)
12222 ? cv_dup( CvOUTSIDE(dstr), param)
12223 : cv_dup_inc(CvOUTSIDE(dstr), param);
12229 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12236 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12238 PERL_ARGS_ASSERT_SV_DUP_INC;
12239 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12243 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12245 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12246 PERL_ARGS_ASSERT_SV_DUP;
12248 /* Track every SV that (at least initially) had a reference count of 0.
12249 We need to do this by holding an actual reference to it in this array.
12250 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12251 (akin to the stashes hash, and the perl stack), we come unstuck if
12252 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12253 thread) is manipulated in a CLONE method, because CLONE runs before the
12254 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12255 (and fix things up by giving each a reference via the temps stack).
12256 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12257 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12258 before the walk of unreferenced happens and a reference to that is SV
12259 added to the temps stack. At which point we have the same SV considered
12260 to be in use, and free to be re-used. Not good.
12262 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12263 assert(param->unreferenced);
12264 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12270 /* duplicate a context */
12273 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12275 PERL_CONTEXT *ncxs;
12277 PERL_ARGS_ASSERT_CX_DUP;
12280 return (PERL_CONTEXT*)NULL;
12282 /* look for it in the table first */
12283 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12287 /* create anew and remember what it is */
12288 Newx(ncxs, max + 1, PERL_CONTEXT);
12289 ptr_table_store(PL_ptr_table, cxs, ncxs);
12290 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12293 PERL_CONTEXT * const ncx = &ncxs[ix];
12294 if (CxTYPE(ncx) == CXt_SUBST) {
12295 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12298 switch (CxTYPE(ncx)) {
12300 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12301 ? cv_dup_inc(ncx->blk_sub.cv, param)
12302 : cv_dup(ncx->blk_sub.cv,param));
12303 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12304 ? av_dup_inc(ncx->blk_sub.argarray,
12307 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12309 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12310 ncx->blk_sub.oldcomppad);
12313 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12315 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12316 ncx->blk_eval.cv = cv_dup(ncx->blk_eval.cv, param);
12318 case CXt_LOOP_LAZYSV:
12319 ncx->blk_loop.state_u.lazysv.end
12320 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12321 /* We are taking advantage of av_dup_inc and sv_dup_inc
12322 actually being the same function, and order equivalence of
12324 We can assert the later [but only at run time :-(] */
12325 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12326 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12328 ncx->blk_loop.state_u.ary.ary
12329 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12330 case CXt_LOOP_LAZYIV:
12331 case CXt_LOOP_PLAIN:
12332 if (CxPADLOOP(ncx)) {
12333 ncx->blk_loop.itervar_u.oldcomppad
12334 = (PAD*)ptr_table_fetch(PL_ptr_table,
12335 ncx->blk_loop.itervar_u.oldcomppad);
12337 ncx->blk_loop.itervar_u.gv
12338 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12343 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12344 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12345 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12360 /* duplicate a stack info structure */
12363 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12367 PERL_ARGS_ASSERT_SI_DUP;
12370 return (PERL_SI*)NULL;
12372 /* look for it in the table first */
12373 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12377 /* create anew and remember what it is */
12378 Newxz(nsi, 1, PERL_SI);
12379 ptr_table_store(PL_ptr_table, si, nsi);
12381 nsi->si_stack = av_dup_inc(si->si_stack, param);
12382 nsi->si_cxix = si->si_cxix;
12383 nsi->si_cxmax = si->si_cxmax;
12384 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12385 nsi->si_type = si->si_type;
12386 nsi->si_prev = si_dup(si->si_prev, param);
12387 nsi->si_next = si_dup(si->si_next, param);
12388 nsi->si_markoff = si->si_markoff;
12393 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12394 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12395 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12396 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12397 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12398 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12399 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12400 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12401 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12402 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12403 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12404 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12405 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12406 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12407 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12408 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12411 #define pv_dup_inc(p) SAVEPV(p)
12412 #define pv_dup(p) SAVEPV(p)
12413 #define svp_dup_inc(p,pp) any_dup(p,pp)
12415 /* map any object to the new equivent - either something in the
12416 * ptr table, or something in the interpreter structure
12420 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12424 PERL_ARGS_ASSERT_ANY_DUP;
12427 return (void*)NULL;
12429 /* look for it in the table first */
12430 ret = ptr_table_fetch(PL_ptr_table, v);
12434 /* see if it is part of the interpreter structure */
12435 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12436 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12444 /* duplicate the save stack */
12447 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12450 ANY * const ss = proto_perl->Isavestack;
12451 const I32 max = proto_perl->Isavestack_max;
12452 I32 ix = proto_perl->Isavestack_ix;
12465 void (*dptr) (void*);
12466 void (*dxptr) (pTHX_ void*);
12468 PERL_ARGS_ASSERT_SS_DUP;
12470 Newxz(nss, max, ANY);
12473 const UV uv = POPUV(ss,ix);
12474 const U8 type = (U8)uv & SAVE_MASK;
12476 TOPUV(nss,ix) = uv;
12478 case SAVEt_CLEARSV:
12480 case SAVEt_HELEM: /* hash element */
12481 sv = (const SV *)POPPTR(ss,ix);
12482 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12484 case SAVEt_ITEM: /* normal string */
12485 case SAVEt_GVSV: /* scalar slot in GV */
12486 case SAVEt_SV: /* scalar reference */
12487 sv = (const SV *)POPPTR(ss,ix);
12488 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12491 case SAVEt_MORTALIZESV:
12492 sv = (const SV *)POPPTR(ss,ix);
12493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12495 case SAVEt_SHARED_PVREF: /* char* in shared space */
12496 c = (char*)POPPTR(ss,ix);
12497 TOPPTR(nss,ix) = savesharedpv(c);
12498 ptr = POPPTR(ss,ix);
12499 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12501 case SAVEt_GENERIC_SVREF: /* generic sv */
12502 case SAVEt_SVREF: /* scalar reference */
12503 sv = (const SV *)POPPTR(ss,ix);
12504 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12505 ptr = POPPTR(ss,ix);
12506 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12508 case SAVEt_HV: /* hash reference */
12509 case SAVEt_AV: /* array reference */
12510 sv = (const SV *) POPPTR(ss,ix);
12511 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12513 case SAVEt_COMPPAD:
12515 sv = (const SV *) POPPTR(ss,ix);
12516 TOPPTR(nss,ix) = sv_dup(sv, param);
12518 case SAVEt_INT: /* int reference */
12519 ptr = POPPTR(ss,ix);
12520 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12521 intval = (int)POPINT(ss,ix);
12522 TOPINT(nss,ix) = intval;
12524 case SAVEt_LONG: /* long reference */
12525 ptr = POPPTR(ss,ix);
12526 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12527 longval = (long)POPLONG(ss,ix);
12528 TOPLONG(nss,ix) = longval;
12530 case SAVEt_I32: /* I32 reference */
12531 ptr = POPPTR(ss,ix);
12532 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12534 TOPINT(nss,ix) = i;
12536 case SAVEt_IV: /* IV reference */
12537 ptr = POPPTR(ss,ix);
12538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12540 TOPIV(nss,ix) = iv;
12542 case SAVEt_HPTR: /* HV* reference */
12543 case SAVEt_APTR: /* AV* reference */
12544 case SAVEt_SPTR: /* SV* reference */
12545 ptr = POPPTR(ss,ix);
12546 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12547 sv = (const SV *)POPPTR(ss,ix);
12548 TOPPTR(nss,ix) = sv_dup(sv, param);
12550 case SAVEt_VPTR: /* random* reference */
12551 ptr = POPPTR(ss,ix);
12552 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12554 case SAVEt_INT_SMALL:
12555 case SAVEt_I32_SMALL:
12556 case SAVEt_I16: /* I16 reference */
12557 case SAVEt_I8: /* I8 reference */
12559 ptr = POPPTR(ss,ix);
12560 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12562 case SAVEt_GENERIC_PVREF: /* generic char* */
12563 case SAVEt_PPTR: /* char* reference */
12564 ptr = POPPTR(ss,ix);
12565 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12566 c = (char*)POPPTR(ss,ix);
12567 TOPPTR(nss,ix) = pv_dup(c);
12569 case SAVEt_GP: /* scalar reference */
12570 gp = (GP*)POPPTR(ss,ix);
12571 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12572 (void)GpREFCNT_inc(gp);
12573 gv = (const GV *)POPPTR(ss,ix);
12574 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12577 ptr = POPPTR(ss,ix);
12578 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12579 /* these are assumed to be refcounted properly */
12581 switch (((OP*)ptr)->op_type) {
12583 case OP_LEAVESUBLV:
12587 case OP_LEAVEWRITE:
12588 TOPPTR(nss,ix) = ptr;
12591 (void) OpREFCNT_inc(o);
12595 TOPPTR(nss,ix) = NULL;
12600 TOPPTR(nss,ix) = NULL;
12602 case SAVEt_FREECOPHH:
12603 ptr = POPPTR(ss,ix);
12604 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12607 hv = (const HV *)POPPTR(ss,ix);
12608 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12610 TOPINT(nss,ix) = i;
12613 c = (char*)POPPTR(ss,ix);
12614 TOPPTR(nss,ix) = pv_dup_inc(c);
12616 case SAVEt_STACK_POS: /* Position on Perl stack */
12618 TOPINT(nss,ix) = i;
12620 case SAVEt_DESTRUCTOR:
12621 ptr = POPPTR(ss,ix);
12622 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12623 dptr = POPDPTR(ss,ix);
12624 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12625 any_dup(FPTR2DPTR(void *, dptr),
12628 case SAVEt_DESTRUCTOR_X:
12629 ptr = POPPTR(ss,ix);
12630 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12631 dxptr = POPDXPTR(ss,ix);
12632 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12633 any_dup(FPTR2DPTR(void *, dxptr),
12636 case SAVEt_REGCONTEXT:
12638 ix -= uv >> SAVE_TIGHT_SHIFT;
12640 case SAVEt_AELEM: /* array element */
12641 sv = (const SV *)POPPTR(ss,ix);
12642 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12644 TOPINT(nss,ix) = i;
12645 av = (const AV *)POPPTR(ss,ix);
12646 TOPPTR(nss,ix) = av_dup_inc(av, param);
12649 ptr = POPPTR(ss,ix);
12650 TOPPTR(nss,ix) = ptr;
12653 ptr = POPPTR(ss,ix);
12654 ptr = cophh_copy((COPHH*)ptr);
12655 TOPPTR(nss,ix) = ptr;
12657 TOPINT(nss,ix) = i;
12658 if (i & HINT_LOCALIZE_HH) {
12659 hv = (const HV *)POPPTR(ss,ix);
12660 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12663 case SAVEt_PADSV_AND_MORTALIZE:
12664 longval = (long)POPLONG(ss,ix);
12665 TOPLONG(nss,ix) = longval;
12666 ptr = POPPTR(ss,ix);
12667 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12668 sv = (const SV *)POPPTR(ss,ix);
12669 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12671 case SAVEt_SET_SVFLAGS:
12673 TOPINT(nss,ix) = i;
12675 TOPINT(nss,ix) = i;
12676 sv = (const SV *)POPPTR(ss,ix);
12677 TOPPTR(nss,ix) = sv_dup(sv, param);
12679 case SAVEt_RE_STATE:
12681 const struct re_save_state *const old_state
12682 = (struct re_save_state *)
12683 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12684 struct re_save_state *const new_state
12685 = (struct re_save_state *)
12686 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12688 Copy(old_state, new_state, 1, struct re_save_state);
12689 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12691 new_state->re_state_bostr
12692 = pv_dup(old_state->re_state_bostr);
12693 new_state->re_state_reginput
12694 = pv_dup(old_state->re_state_reginput);
12695 new_state->re_state_regeol
12696 = pv_dup(old_state->re_state_regeol);
12697 new_state->re_state_regoffs
12698 = (regexp_paren_pair*)
12699 any_dup(old_state->re_state_regoffs, proto_perl);
12700 new_state->re_state_reglastparen
12701 = (U32*) any_dup(old_state->re_state_reglastparen,
12703 new_state->re_state_reglastcloseparen
12704 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12706 /* XXX This just has to be broken. The old save_re_context
12707 code did SAVEGENERICPV(PL_reg_start_tmp);
12708 PL_reg_start_tmp is char **.
12709 Look above to what the dup code does for
12710 SAVEt_GENERIC_PVREF
12711 It can never have worked.
12712 So this is merely a faithful copy of the exiting bug: */
12713 new_state->re_state_reg_start_tmp
12714 = (char **) pv_dup((char *)
12715 old_state->re_state_reg_start_tmp);
12716 /* I assume that it only ever "worked" because no-one called
12717 (pseudo)fork while the regexp engine had re-entered itself.
12719 #ifdef PERL_OLD_COPY_ON_WRITE
12720 new_state->re_state_nrs
12721 = sv_dup(old_state->re_state_nrs, param);
12723 new_state->re_state_reg_magic
12724 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12726 new_state->re_state_reg_oldcurpm
12727 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12729 new_state->re_state_reg_curpm
12730 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12732 new_state->re_state_reg_oldsaved
12733 = pv_dup(old_state->re_state_reg_oldsaved);
12734 new_state->re_state_reg_poscache
12735 = pv_dup(old_state->re_state_reg_poscache);
12736 new_state->re_state_reg_starttry
12737 = pv_dup(old_state->re_state_reg_starttry);
12740 case SAVEt_COMPILE_WARNINGS:
12741 ptr = POPPTR(ss,ix);
12742 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12745 ptr = POPPTR(ss,ix);
12746 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12750 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12758 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12759 * flag to the result. This is done for each stash before cloning starts,
12760 * so we know which stashes want their objects cloned */
12763 do_mark_cloneable_stash(pTHX_ SV *const sv)
12765 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12767 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12768 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12769 if (cloner && GvCV(cloner)) {
12776 mXPUSHs(newSVhek(hvname));
12778 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12785 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12793 =for apidoc perl_clone
12795 Create and return a new interpreter by cloning the current one.
12797 perl_clone takes these flags as parameters:
12799 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12800 without it we only clone the data and zero the stacks,
12801 with it we copy the stacks and the new perl interpreter is
12802 ready to run at the exact same point as the previous one.
12803 The pseudo-fork code uses COPY_STACKS while the
12804 threads->create doesn't.
12806 CLONEf_KEEP_PTR_TABLE -
12807 perl_clone keeps a ptr_table with the pointer of the old
12808 variable as a key and the new variable as a value,
12809 this allows it to check if something has been cloned and not
12810 clone it again but rather just use the value and increase the
12811 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12812 the ptr_table using the function
12813 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12814 reason to keep it around is if you want to dup some of your own
12815 variable who are outside the graph perl scans, example of this
12816 code is in threads.xs create.
12818 CLONEf_CLONE_HOST -
12819 This is a win32 thing, it is ignored on unix, it tells perls
12820 win32host code (which is c++) to clone itself, this is needed on
12821 win32 if you want to run two threads at the same time,
12822 if you just want to do some stuff in a separate perl interpreter
12823 and then throw it away and return to the original one,
12824 you don't need to do anything.
12829 /* XXX the above needs expanding by someone who actually understands it ! */
12830 EXTERN_C PerlInterpreter *
12831 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12834 perl_clone(PerlInterpreter *proto_perl, UV flags)
12837 #ifdef PERL_IMPLICIT_SYS
12839 PERL_ARGS_ASSERT_PERL_CLONE;
12841 /* perlhost.h so we need to call into it
12842 to clone the host, CPerlHost should have a c interface, sky */
12844 if (flags & CLONEf_CLONE_HOST) {
12845 return perl_clone_host(proto_perl,flags);
12847 return perl_clone_using(proto_perl, flags,
12849 proto_perl->IMemShared,
12850 proto_perl->IMemParse,
12852 proto_perl->IStdIO,
12856 proto_perl->IProc);
12860 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12861 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12862 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12863 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12864 struct IPerlDir* ipD, struct IPerlSock* ipS,
12865 struct IPerlProc* ipP)
12867 /* XXX many of the string copies here can be optimized if they're
12868 * constants; they need to be allocated as common memory and just
12869 * their pointers copied. */
12872 CLONE_PARAMS clone_params;
12873 CLONE_PARAMS* const param = &clone_params;
12875 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12877 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12878 #else /* !PERL_IMPLICIT_SYS */
12880 CLONE_PARAMS clone_params;
12881 CLONE_PARAMS* param = &clone_params;
12882 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12884 PERL_ARGS_ASSERT_PERL_CLONE;
12885 #endif /* PERL_IMPLICIT_SYS */
12887 /* for each stash, determine whether its objects should be cloned */
12888 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12889 PERL_SET_THX(my_perl);
12892 PoisonNew(my_perl, 1, PerlInterpreter);
12895 PL_defstash = NULL; /* may be used by perl malloc() */
12898 PL_scopestack_name = 0;
12900 PL_savestack_ix = 0;
12901 PL_savestack_max = -1;
12902 PL_sig_pending = 0;
12904 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12905 # ifdef DEBUG_LEAKING_SCALARS
12906 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12908 #else /* !DEBUGGING */
12909 Zero(my_perl, 1, PerlInterpreter);
12910 #endif /* DEBUGGING */
12912 #ifdef PERL_IMPLICIT_SYS
12913 /* host pointers */
12915 PL_MemShared = ipMS;
12916 PL_MemParse = ipMP;
12923 #endif /* PERL_IMPLICIT_SYS */
12925 param->flags = flags;
12926 /* Nothing in the core code uses this, but we make it available to
12927 extensions (using mg_dup). */
12928 param->proto_perl = proto_perl;
12929 /* Likely nothing will use this, but it is initialised to be consistent
12930 with Perl_clone_params_new(). */
12931 param->new_perl = my_perl;
12932 param->unreferenced = NULL;
12934 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12936 PL_body_arenas = NULL;
12937 Zero(&PL_body_roots, 1, PL_body_roots);
12940 PL_sv_objcount = 0;
12942 PL_sv_arenaroot = NULL;
12944 PL_debug = proto_perl->Idebug;
12946 PL_hash_seed = proto_perl->Ihash_seed;
12947 PL_rehash_seed = proto_perl->Irehash_seed;
12949 SvANY(&PL_sv_undef) = NULL;
12950 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12951 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12952 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12953 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12954 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12956 SvANY(&PL_sv_yes) = new_XPVNV();
12957 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12958 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12959 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12961 /* dbargs array probably holds garbage */
12964 PL_compiling = proto_perl->Icompiling;
12966 #ifdef PERL_DEBUG_READONLY_OPS
12971 /* pseudo environmental stuff */
12972 PL_origargc = proto_perl->Iorigargc;
12973 PL_origargv = proto_perl->Iorigargv;
12975 /* Set tainting stuff before PerlIO_debug can possibly get called */
12976 PL_tainting = proto_perl->Itainting;
12977 PL_taint_warn = proto_perl->Itaint_warn;
12979 PL_minus_c = proto_perl->Iminus_c;
12981 PL_localpatches = proto_perl->Ilocalpatches;
12982 PL_splitstr = proto_perl->Isplitstr;
12983 PL_minus_n = proto_perl->Iminus_n;
12984 PL_minus_p = proto_perl->Iminus_p;
12985 PL_minus_l = proto_perl->Iminus_l;
12986 PL_minus_a = proto_perl->Iminus_a;
12987 PL_minus_E = proto_perl->Iminus_E;
12988 PL_minus_F = proto_perl->Iminus_F;
12989 PL_doswitches = proto_perl->Idoswitches;
12990 PL_dowarn = proto_perl->Idowarn;
12991 PL_sawampersand = proto_perl->Isawampersand;
12992 PL_unsafe = proto_perl->Iunsafe;
12993 PL_perldb = proto_perl->Iperldb;
12994 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12995 PL_exit_flags = proto_perl->Iexit_flags;
12997 /* XXX time(&PL_basetime) when asked for? */
12998 PL_basetime = proto_perl->Ibasetime;
13000 PL_maxsysfd = proto_perl->Imaxsysfd;
13001 PL_statusvalue = proto_perl->Istatusvalue;
13003 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
13005 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
13008 /* RE engine related */
13009 Zero(&PL_reg_state, 1, struct re_save_state);
13010 PL_reginterp_cnt = 0;
13011 PL_regmatch_slab = NULL;
13013 PL_sub_generation = proto_perl->Isub_generation;
13015 /* funky return mechanisms */
13016 PL_forkprocess = proto_perl->Iforkprocess;
13018 /* internal state */
13019 PL_maxo = proto_perl->Imaxo;
13021 PL_main_start = proto_perl->Imain_start;
13022 PL_eval_root = proto_perl->Ieval_root;
13023 PL_eval_start = proto_perl->Ieval_start;
13025 PL_filemode = proto_perl->Ifilemode;
13026 PL_lastfd = proto_perl->Ilastfd;
13027 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13030 PL_gensym = proto_perl->Igensym;
13032 PL_laststatval = proto_perl->Ilaststatval;
13033 PL_laststype = proto_perl->Ilaststype;
13036 PL_profiledata = NULL;
13038 PL_generation = proto_perl->Igeneration;
13040 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13041 PL_in_clean_all = proto_perl->Iin_clean_all;
13043 PL_delaymagic_uid = proto_perl->Idelaymagic_uid;
13044 PL_delaymagic_euid = proto_perl->Idelaymagic_euid;
13045 PL_delaymagic_gid = proto_perl->Idelaymagic_gid;
13046 PL_delaymagic_egid = proto_perl->Idelaymagic_egid;
13047 PL_nomemok = proto_perl->Inomemok;
13048 PL_an = proto_perl->Ian;
13049 PL_evalseq = proto_perl->Ievalseq;
13050 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13051 PL_origalen = proto_perl->Iorigalen;
13053 PL_sighandlerp = proto_perl->Isighandlerp;
13055 PL_runops = proto_perl->Irunops;
13057 PL_subline = proto_perl->Isubline;
13060 PL_cryptseen = proto_perl->Icryptseen;
13063 PL_hints = proto_perl->Ihints;
13065 PL_amagic_generation = proto_perl->Iamagic_generation;
13067 #ifdef USE_LOCALE_COLLATE
13068 PL_collation_ix = proto_perl->Icollation_ix;
13069 PL_collation_standard = proto_perl->Icollation_standard;
13070 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13071 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13072 #endif /* USE_LOCALE_COLLATE */
13074 #ifdef USE_LOCALE_NUMERIC
13075 PL_numeric_standard = proto_perl->Inumeric_standard;
13076 PL_numeric_local = proto_perl->Inumeric_local;
13077 #endif /* !USE_LOCALE_NUMERIC */
13079 /* Did the locale setup indicate UTF-8? */
13080 PL_utf8locale = proto_perl->Iutf8locale;
13081 /* Unicode features (see perlrun/-C) */
13082 PL_unicode = proto_perl->Iunicode;
13084 /* Pre-5.8 signals control */
13085 PL_signals = proto_perl->Isignals;
13087 /* times() ticks per second */
13088 PL_clocktick = proto_perl->Iclocktick;
13090 /* Recursion stopper for PerlIO_find_layer */
13091 PL_in_load_module = proto_perl->Iin_load_module;
13093 /* sort() routine */
13094 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13096 /* Not really needed/useful since the reenrant_retint is "volatile",
13097 * but do it for consistency's sake. */
13098 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13100 /* Hooks to shared SVs and locks. */
13101 PL_sharehook = proto_perl->Isharehook;
13102 PL_lockhook = proto_perl->Ilockhook;
13103 PL_unlockhook = proto_perl->Iunlockhook;
13104 PL_threadhook = proto_perl->Ithreadhook;
13105 PL_destroyhook = proto_perl->Idestroyhook;
13106 PL_signalhook = proto_perl->Isignalhook;
13108 PL_globhook = proto_perl->Iglobhook;
13111 PL_last_swash_hv = NULL; /* reinits on demand */
13112 PL_last_swash_klen = 0;
13113 PL_last_swash_key[0]= '\0';
13114 PL_last_swash_tmps = (U8*)NULL;
13115 PL_last_swash_slen = 0;
13117 PL_glob_index = proto_perl->Iglob_index;
13118 PL_srand_called = proto_perl->Isrand_called;
13120 if (flags & CLONEf_COPY_STACKS) {
13121 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13122 PL_tmps_ix = proto_perl->Itmps_ix;
13123 PL_tmps_max = proto_perl->Itmps_max;
13124 PL_tmps_floor = proto_perl->Itmps_floor;
13126 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13127 * NOTE: unlike the others! */
13128 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13129 PL_scopestack_max = proto_perl->Iscopestack_max;
13131 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13132 * NOTE: unlike the others! */
13133 PL_savestack_ix = proto_perl->Isavestack_ix;
13134 PL_savestack_max = proto_perl->Isavestack_max;
13137 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13138 PL_top_env = &PL_start_env;
13140 PL_op = proto_perl->Iop;
13143 PL_Xpv = (XPV*)NULL;
13144 my_perl->Ina = proto_perl->Ina;
13146 PL_statbuf = proto_perl->Istatbuf;
13147 PL_statcache = proto_perl->Istatcache;
13150 PL_timesbuf = proto_perl->Itimesbuf;
13153 PL_tainted = proto_perl->Itainted;
13154 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13156 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13158 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13159 PL_restartop = proto_perl->Irestartop;
13160 PL_in_eval = proto_perl->Iin_eval;
13161 PL_delaymagic = proto_perl->Idelaymagic;
13162 PL_phase = proto_perl->Iphase;
13163 PL_localizing = proto_perl->Ilocalizing;
13165 PL_hv_fetch_ent_mh = NULL;
13166 PL_modcount = proto_perl->Imodcount;
13167 PL_lastgotoprobe = NULL;
13168 PL_dumpindent = proto_perl->Idumpindent;
13170 PL_efloatbuf = NULL; /* reinits on demand */
13171 PL_efloatsize = 0; /* reinits on demand */
13175 PL_regdummy = proto_perl->Iregdummy;
13176 PL_colorset = 0; /* reinits PL_colors[] */
13177 /*PL_colors[6] = {0,0,0,0,0,0};*/
13179 /* Pluggable optimizer */
13180 PL_peepp = proto_perl->Ipeepp;
13181 PL_rpeepp = proto_perl->Irpeepp;
13182 /* op_free() hook */
13183 PL_opfreehook = proto_perl->Iopfreehook;
13185 #ifdef USE_REENTRANT_API
13186 /* XXX: things like -Dm will segfault here in perlio, but doing
13187 * PERL_SET_CONTEXT(proto_perl);
13188 * breaks too many other things
13190 Perl_reentrant_init(aTHX);
13193 /* create SV map for pointer relocation */
13194 PL_ptr_table = ptr_table_new();
13196 /* initialize these special pointers as early as possible */
13197 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13199 SvANY(&PL_sv_no) = new_XPVNV();
13200 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13201 SvCUR_set(&PL_sv_no, 0);
13202 SvLEN_set(&PL_sv_no, 1);
13203 SvIV_set(&PL_sv_no, 0);
13204 SvNV_set(&PL_sv_no, 0);
13205 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13207 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13208 SvCUR_set(&PL_sv_yes, 1);
13209 SvLEN_set(&PL_sv_yes, 2);
13210 SvIV_set(&PL_sv_yes, 1);
13211 SvNV_set(&PL_sv_yes, 1);
13212 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13214 /* create (a non-shared!) shared string table */
13215 PL_strtab = newHV();
13216 HvSHAREKEYS_off(PL_strtab);
13217 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13218 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13220 /* These two PVs will be free'd special way so must set them same way op.c does */
13221 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
13222 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
13224 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13225 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13227 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13228 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13229 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13230 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13232 param->stashes = newAV(); /* Setup array of objects to call clone on */
13233 /* This makes no difference to the implementation, as it always pushes
13234 and shifts pointers to other SVs without changing their reference
13235 count, with the array becoming empty before it is freed. However, it
13236 makes it conceptually clear what is going on, and will avoid some
13237 work inside av.c, filling slots between AvFILL() and AvMAX() with
13238 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13239 AvREAL_off(param->stashes);
13241 if (!(flags & CLONEf_COPY_STACKS)) {
13242 param->unreferenced = newAV();
13245 #ifdef PERLIO_LAYERS
13246 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13247 PerlIO_clone(aTHX_ proto_perl, param);
13250 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13251 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13252 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13253 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13254 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13255 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13258 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13259 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13260 PL_inplace = SAVEPV(proto_perl->Iinplace);
13261 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13263 /* magical thingies */
13264 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
13266 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13268 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13269 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13270 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13273 /* Clone the regex array */
13274 /* ORANGE FIXME for plugins, probably in the SV dup code.
13275 newSViv(PTR2IV(CALLREGDUPE(
13276 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13278 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13279 PL_regex_pad = AvARRAY(PL_regex_padav);
13281 /* shortcuts to various I/O objects */
13282 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13283 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13284 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13285 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13286 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13287 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13288 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13290 /* shortcuts to regexp stuff */
13291 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13293 /* shortcuts to misc objects */
13294 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13296 /* shortcuts to debugging objects */
13297 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13298 PL_DBline = gv_dup(proto_perl->IDBline, param);
13299 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13300 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13301 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13302 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13304 /* symbol tables */
13305 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13306 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13307 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13308 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13309 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13311 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13312 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13313 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13314 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13315 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13316 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13317 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13318 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13320 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13322 /* subprocess state */
13323 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13325 if (proto_perl->Iop_mask)
13326 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13329 /* PL_asserting = proto_perl->Iasserting; */
13331 /* current interpreter roots */
13332 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13334 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13337 /* runtime control stuff */
13338 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13340 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13342 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13344 /* interpreter atexit processing */
13345 PL_exitlistlen = proto_perl->Iexitlistlen;
13346 if (PL_exitlistlen) {
13347 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13348 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13351 PL_exitlist = (PerlExitListEntry*)NULL;
13353 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13354 if (PL_my_cxt_size) {
13355 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13356 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13357 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13358 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13359 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13363 PL_my_cxt_list = (void**)NULL;
13364 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13365 PL_my_cxt_keys = (const char**)NULL;
13368 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13369 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13370 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13371 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13373 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13375 PAD_CLONE_VARS(proto_perl, param);
13377 #ifdef HAVE_INTERP_INTERN
13378 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13381 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13383 #ifdef PERL_USES_PL_PIDSTATUS
13384 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13386 PL_osname = SAVEPV(proto_perl->Iosname);
13387 PL_parser = parser_dup(proto_perl->Iparser, param);
13389 /* XXX this only works if the saved cop has already been cloned */
13390 if (proto_perl->Iparser) {
13391 PL_parser->saved_curcop = (COP*)any_dup(
13392 proto_perl->Iparser->saved_curcop,
13396 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13398 #ifdef USE_LOCALE_COLLATE
13399 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13400 #endif /* USE_LOCALE_COLLATE */
13402 #ifdef USE_LOCALE_NUMERIC
13403 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13404 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13405 #endif /* !USE_LOCALE_NUMERIC */
13407 /* Unicode inversion lists */
13408 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13409 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13411 PL_PerlSpace = sv_dup_inc(proto_perl->IPerlSpace, param);
13412 PL_XPerlSpace = sv_dup_inc(proto_perl->IXPerlSpace, param);
13414 PL_L1PosixAlnum = sv_dup_inc(proto_perl->IL1PosixAlnum, param);
13415 PL_PosixAlnum = sv_dup_inc(proto_perl->IPosixAlnum, param);
13417 PL_L1PosixAlpha = sv_dup_inc(proto_perl->IL1PosixAlpha, param);
13418 PL_PosixAlpha = sv_dup_inc(proto_perl->IPosixAlpha, param);
13420 PL_PosixBlank = sv_dup_inc(proto_perl->IPosixBlank, param);
13421 PL_XPosixBlank = sv_dup_inc(proto_perl->IXPosixBlank, param);
13423 PL_L1Cased = sv_dup_inc(proto_perl->IL1Cased, param);
13425 PL_PosixCntrl = sv_dup_inc(proto_perl->IPosixCntrl, param);
13426 PL_XPosixCntrl = sv_dup_inc(proto_perl->IXPosixCntrl, param);
13428 PL_PosixDigit = sv_dup_inc(proto_perl->IPosixDigit, param);
13430 PL_L1PosixGraph = sv_dup_inc(proto_perl->IL1PosixGraph, param);
13431 PL_PosixGraph = sv_dup_inc(proto_perl->IPosixGraph, param);
13433 PL_L1PosixLower = sv_dup_inc(proto_perl->IL1PosixLower, param);
13434 PL_PosixLower = sv_dup_inc(proto_perl->IPosixLower, param);
13436 PL_L1PosixPrint = sv_dup_inc(proto_perl->IL1PosixPrint, param);
13437 PL_PosixPrint = sv_dup_inc(proto_perl->IPosixPrint, param);
13439 PL_L1PosixPunct = sv_dup_inc(proto_perl->IL1PosixPunct, param);
13440 PL_PosixPunct = sv_dup_inc(proto_perl->IPosixPunct, param);
13442 PL_PosixSpace = sv_dup_inc(proto_perl->IPosixSpace, param);
13443 PL_XPosixSpace = sv_dup_inc(proto_perl->IXPosixSpace, param);
13445 PL_L1PosixUpper = sv_dup_inc(proto_perl->IL1PosixUpper, param);
13446 PL_PosixUpper = sv_dup_inc(proto_perl->IPosixUpper, param);
13448 PL_L1PosixWord = sv_dup_inc(proto_perl->IL1PosixWord, param);
13449 PL_PosixWord = sv_dup_inc(proto_perl->IPosixWord, param);
13451 PL_PosixXDigit = sv_dup_inc(proto_perl->IPosixXDigit, param);
13452 PL_XPosixXDigit = sv_dup_inc(proto_perl->IXPosixXDigit, param);
13454 PL_VertSpace = sv_dup_inc(proto_perl->IVertSpace, param);
13456 /* utf8 character class swashes */
13457 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13458 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13459 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13460 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13461 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13462 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13463 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13464 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13465 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13466 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13467 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13468 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13469 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13470 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13471 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13472 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13473 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13474 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13475 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13476 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13477 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13478 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13479 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13480 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13481 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13482 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13483 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13484 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13485 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13486 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13487 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13488 PL_utf8_quotemeta = sv_dup_inc(proto_perl->Iutf8_quotemeta, param);
13489 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13490 PL_AboveLatin1 = sv_dup_inc(proto_perl->IAboveLatin1, param);
13491 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13494 if (proto_perl->Ipsig_pend) {
13495 Newxz(PL_psig_pend, SIG_SIZE, int);
13498 PL_psig_pend = (int*)NULL;
13501 if (proto_perl->Ipsig_name) {
13502 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13503 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13505 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13508 PL_psig_ptr = (SV**)NULL;
13509 PL_psig_name = (SV**)NULL;
13512 if (flags & CLONEf_COPY_STACKS) {
13513 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13514 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13515 PL_tmps_ix+1, param);
13517 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13518 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13519 Newxz(PL_markstack, i, I32);
13520 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13521 - proto_perl->Imarkstack);
13522 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13523 - proto_perl->Imarkstack);
13524 Copy(proto_perl->Imarkstack, PL_markstack,
13525 PL_markstack_ptr - PL_markstack + 1, I32);
13527 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13528 * NOTE: unlike the others! */
13529 Newxz(PL_scopestack, PL_scopestack_max, I32);
13530 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13533 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13534 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13536 /* NOTE: si_dup() looks at PL_markstack */
13537 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13539 /* PL_curstack = PL_curstackinfo->si_stack; */
13540 PL_curstack = av_dup(proto_perl->Icurstack, param);
13541 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13543 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13544 PL_stack_base = AvARRAY(PL_curstack);
13545 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13546 - proto_perl->Istack_base);
13547 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13549 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13550 PL_savestack = ss_dup(proto_perl, param);
13554 ENTER; /* perl_destruct() wants to LEAVE; */
13557 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13558 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13560 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13561 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13562 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13563 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13564 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13565 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13567 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13569 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13570 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13571 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13572 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13574 PL_stashcache = newHV();
13576 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13577 proto_perl->Iwatchaddr);
13578 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13579 if (PL_debug && PL_watchaddr) {
13580 PerlIO_printf(Perl_debug_log,
13581 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13582 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13583 PTR2UV(PL_watchok));
13586 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13587 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13588 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13590 /* Call the ->CLONE method, if it exists, for each of the stashes
13591 identified by sv_dup() above.
13593 while(av_len(param->stashes) != -1) {
13594 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13595 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13596 if (cloner && GvCV(cloner)) {
13601 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13603 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13609 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13610 ptr_table_free(PL_ptr_table);
13611 PL_ptr_table = NULL;
13614 if (!(flags & CLONEf_COPY_STACKS)) {
13615 unreferenced_to_tmp_stack(param->unreferenced);
13618 SvREFCNT_dec(param->stashes);
13620 /* orphaned? eg threads->new inside BEGIN or use */
13621 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13622 SvREFCNT_inc_simple_void(PL_compcv);
13623 SAVEFREESV(PL_compcv);
13630 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13632 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13634 if (AvFILLp(unreferenced) > -1) {
13635 SV **svp = AvARRAY(unreferenced);
13636 SV **const last = svp + AvFILLp(unreferenced);
13640 if (SvREFCNT(*svp) == 1)
13642 } while (++svp <= last);
13644 EXTEND_MORTAL(count);
13645 svp = AvARRAY(unreferenced);
13648 if (SvREFCNT(*svp) == 1) {
13649 /* Our reference is the only one to this SV. This means that
13650 in this thread, the scalar effectively has a 0 reference.
13651 That doesn't work (cleanup never happens), so donate our
13652 reference to it onto the save stack. */
13653 PL_tmps_stack[++PL_tmps_ix] = *svp;
13655 /* As an optimisation, because we are already walking the
13656 entire array, instead of above doing either
13657 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13658 release our reference to the scalar, so that at the end of
13659 the array owns zero references to the scalars it happens to
13660 point to. We are effectively converting the array from
13661 AvREAL() on to AvREAL() off. This saves the av_clear()
13662 (triggered by the SvREFCNT_dec(unreferenced) below) from
13663 walking the array a second time. */
13664 SvREFCNT_dec(*svp);
13667 } while (++svp <= last);
13668 AvREAL_off(unreferenced);
13670 SvREFCNT_dec(unreferenced);
13674 Perl_clone_params_del(CLONE_PARAMS *param)
13676 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13678 PerlInterpreter *const to = param->new_perl;
13680 PerlInterpreter *const was = PERL_GET_THX;
13682 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13688 SvREFCNT_dec(param->stashes);
13689 if (param->unreferenced)
13690 unreferenced_to_tmp_stack(param->unreferenced);
13700 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13703 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13704 does a dTHX; to get the context from thread local storage.
13705 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13706 a version that passes in my_perl. */
13707 PerlInterpreter *const was = PERL_GET_THX;
13708 CLONE_PARAMS *param;
13710 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13716 /* Given that we've set the context, we can do this unshared. */
13717 Newx(param, 1, CLONE_PARAMS);
13720 param->proto_perl = from;
13721 param->new_perl = to;
13722 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13723 AvREAL_off(param->stashes);
13724 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13732 #endif /* USE_ITHREADS */
13735 =head1 Unicode Support
13737 =for apidoc sv_recode_to_utf8
13739 The encoding is assumed to be an Encode object, on entry the PV
13740 of the sv is assumed to be octets in that encoding, and the sv
13741 will be converted into Unicode (and UTF-8).
13743 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13744 is not a reference, nothing is done to the sv. If the encoding is not
13745 an C<Encode::XS> Encoding object, bad things will happen.
13746 (See F<lib/encoding.pm> and L<Encode>.)
13748 The PV of the sv is returned.
13753 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13757 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13759 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13773 Passing sv_yes is wrong - it needs to be or'ed set of constants
13774 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13775 remove converted chars from source.
13777 Both will default the value - let them.
13779 XPUSHs(&PL_sv_yes);
13782 call_method("decode", G_SCALAR);
13786 s = SvPV_const(uni, len);
13787 if (s != SvPVX_const(sv)) {
13788 SvGROW(sv, len + 1);
13789 Move(s, SvPVX(sv), len + 1, char);
13790 SvCUR_set(sv, len);
13794 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13795 /* clear pos and any utf8 cache */
13796 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13799 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13800 magic_setutf8(sv,mg); /* clear UTF8 cache */
13805 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13809 =for apidoc sv_cat_decode
13811 The encoding is assumed to be an Encode object, the PV of the ssv is
13812 assumed to be octets in that encoding and decoding the input starts
13813 from the position which (PV + *offset) pointed to. The dsv will be
13814 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13815 when the string tstr appears in decoding output or the input ends on
13816 the PV of the ssv. The value which the offset points will be modified
13817 to the last input position on the ssv.
13819 Returns TRUE if the terminator was found, else returns FALSE.
13824 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13825 SV *ssv, int *offset, char *tstr, int tlen)
13830 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13832 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13843 offsv = newSViv(*offset);
13845 mXPUSHp(tstr, tlen);
13847 call_method("cat_decode", G_SCALAR);
13849 ret = SvTRUE(TOPs);
13850 *offset = SvIV(offsv);
13856 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13861 /* ---------------------------------------------------------------------
13863 * support functions for report_uninit()
13866 /* the maxiumum size of array or hash where we will scan looking
13867 * for the undefined element that triggered the warning */
13869 #define FUV_MAX_SEARCH_SIZE 1000
13871 /* Look for an entry in the hash whose value has the same SV as val;
13872 * If so, return a mortal copy of the key. */
13875 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13878 register HE **array;
13881 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13883 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13884 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13887 array = HvARRAY(hv);
13889 for (i=HvMAX(hv); i>0; i--) {
13890 register HE *entry;
13891 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13892 if (HeVAL(entry) != val)
13894 if ( HeVAL(entry) == &PL_sv_undef ||
13895 HeVAL(entry) == &PL_sv_placeholder)
13899 if (HeKLEN(entry) == HEf_SVKEY)
13900 return sv_mortalcopy(HeKEY_sv(entry));
13901 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13907 /* Look for an entry in the array whose value has the same SV as val;
13908 * If so, return the index, otherwise return -1. */
13911 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13915 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13917 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13918 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13921 if (val != &PL_sv_undef) {
13922 SV ** const svp = AvARRAY(av);
13925 for (i=AvFILLp(av); i>=0; i--)
13932 /* S_varname(): return the name of a variable, optionally with a subscript.
13933 * If gv is non-zero, use the name of that global, along with gvtype (one
13934 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13935 * targ. Depending on the value of the subscript_type flag, return:
13938 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13939 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13940 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13941 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13944 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13945 const SV *const keyname, I32 aindex, int subscript_type)
13948 SV * const name = sv_newmortal();
13949 if (gv && isGV(gv)) {
13951 buffer[0] = gvtype;
13954 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13956 gv_fullname4(name, gv, buffer, 0);
13958 if ((unsigned int)SvPVX(name)[1] <= 26) {
13960 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13962 /* Swap the 1 unprintable control character for the 2 byte pretty
13963 version - ie substr($name, 1, 1) = $buffer; */
13964 sv_insert(name, 1, 1, buffer, 2);
13968 CV * const cv = gv ? (CV *)gv : find_runcv(NULL);
13972 assert(!cv || SvTYPE(cv) == SVt_PVCV);
13974 if (!cv || !CvPADLIST(cv))
13976 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13977 sv = *av_fetch(av, targ, FALSE);
13978 sv_setsv(name, sv);
13981 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13982 SV * const sv = newSV(0);
13983 *SvPVX(name) = '$';
13984 Perl_sv_catpvf(aTHX_ name, "{%s}",
13985 pv_pretty(sv, SvPVX_const(keyname), SvCUR(keyname), 32, NULL, NULL,
13986 PERL_PV_PRETTY_DUMP | PERL_PV_ESCAPE_UNI_DETECT ));
13989 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13990 *SvPVX(name) = '$';
13991 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13993 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13994 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13995 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
14003 =for apidoc find_uninit_var
14005 Find the name of the undefined variable (if any) that caused the operator
14006 to issue a "Use of uninitialized value" warning.
14007 If match is true, only return a name if its value matches uninit_sv.
14008 So roughly speaking, if a unary operator (such as OP_COS) generates a
14009 warning, then following the direct child of the op may yield an
14010 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
14011 other hand, with OP_ADD there are two branches to follow, so we only print
14012 the variable name if we get an exact match.
14014 The name is returned as a mortal SV.
14016 Assumes that PL_op is the op that originally triggered the error, and that
14017 PL_comppad/PL_curpad points to the currently executing pad.
14023 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
14029 const OP *o, *o2, *kid;
14031 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
14032 uninit_sv == &PL_sv_placeholder)))
14035 switch (obase->op_type) {
14042 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
14043 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
14046 int subscript_type = FUV_SUBSCRIPT_WITHIN;
14048 if (pad) { /* @lex, %lex */
14049 sv = PAD_SVl(obase->op_targ);
14053 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14054 /* @global, %global */
14055 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14058 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
14060 else if (obase == PL_op) /* @{expr}, %{expr} */
14061 return find_uninit_var(cUNOPx(obase)->op_first,
14063 else /* @{expr}, %{expr} as a sub-expression */
14067 /* attempt to find a match within the aggregate */
14069 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14071 subscript_type = FUV_SUBSCRIPT_HASH;
14074 index = find_array_subscript((const AV *)sv, uninit_sv);
14076 subscript_type = FUV_SUBSCRIPT_ARRAY;
14079 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
14082 return varname(gv, hash ? '%' : '@', obase->op_targ,
14083 keysv, index, subscript_type);
14087 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14089 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14090 if (!gv || !GvSTASH(gv))
14092 if (match && (GvSV(gv) != uninit_sv))
14094 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14097 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14100 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14102 return varname(NULL, '$', obase->op_targ,
14103 NULL, 0, FUV_SUBSCRIPT_NONE);
14106 gv = cGVOPx_gv(obase);
14107 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14109 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14111 case OP_AELEMFAST_LEX:
14114 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14115 if (!av || SvRMAGICAL(av))
14117 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14118 if (!svp || *svp != uninit_sv)
14121 return varname(NULL, '$', obase->op_targ,
14122 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14125 gv = cGVOPx_gv(obase);
14130 AV *const av = GvAV(gv);
14131 if (!av || SvRMAGICAL(av))
14133 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14134 if (!svp || *svp != uninit_sv)
14137 return varname(gv, '$', 0,
14138 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14143 o = cUNOPx(obase)->op_first;
14144 if (!o || o->op_type != OP_NULL ||
14145 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14147 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14152 bool negate = FALSE;
14154 if (PL_op == obase)
14155 /* $a[uninit_expr] or $h{uninit_expr} */
14156 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14159 o = cBINOPx(obase)->op_first;
14160 kid = cBINOPx(obase)->op_last;
14162 /* get the av or hv, and optionally the gv */
14164 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14165 sv = PAD_SV(o->op_targ);
14167 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14168 && cUNOPo->op_first->op_type == OP_GV)
14170 gv = cGVOPx_gv(cUNOPo->op_first);
14174 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14179 if (kid && kid->op_type == OP_NEGATE) {
14181 kid = cUNOPx(kid)->op_first;
14184 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14185 /* index is constant */
14188 kidsv = sv_2mortal(newSVpvs("-"));
14189 sv_catsv(kidsv, cSVOPx_sv(kid));
14192 kidsv = cSVOPx_sv(kid);
14196 if (obase->op_type == OP_HELEM) {
14197 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14198 if (!he || HeVAL(he) != uninit_sv)
14202 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14203 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14205 if (!svp || *svp != uninit_sv)
14209 if (obase->op_type == OP_HELEM)
14210 return varname(gv, '%', o->op_targ,
14211 kidsv, 0, FUV_SUBSCRIPT_HASH);
14213 return varname(gv, '@', o->op_targ, NULL,
14214 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14215 FUV_SUBSCRIPT_ARRAY);
14218 /* index is an expression;
14219 * attempt to find a match within the aggregate */
14220 if (obase->op_type == OP_HELEM) {
14221 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14223 return varname(gv, '%', o->op_targ,
14224 keysv, 0, FUV_SUBSCRIPT_HASH);
14228 = find_array_subscript((const AV *)sv, uninit_sv);
14230 return varname(gv, '@', o->op_targ,
14231 NULL, index, FUV_SUBSCRIPT_ARRAY);
14236 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14238 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14244 /* only examine RHS */
14245 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14248 o = cUNOPx(obase)->op_first;
14249 if (o->op_type == OP_PUSHMARK)
14252 if (!o->op_sibling) {
14253 /* one-arg version of open is highly magical */
14255 if (o->op_type == OP_GV) { /* open FOO; */
14257 if (match && GvSV(gv) != uninit_sv)
14259 return varname(gv, '$', 0,
14260 NULL, 0, FUV_SUBSCRIPT_NONE);
14262 /* other possibilities not handled are:
14263 * open $x; or open my $x; should return '${*$x}'
14264 * open expr; should return '$'.expr ideally
14270 /* ops where $_ may be an implicit arg */
14275 if ( !(obase->op_flags & OPf_STACKED)) {
14276 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14277 ? PAD_SVl(obase->op_targ)
14280 sv = sv_newmortal();
14281 sv_setpvs(sv, "$_");
14290 match = 1; /* print etc can return undef on defined args */
14291 /* skip filehandle as it can't produce 'undef' warning */
14292 o = cUNOPx(obase)->op_first;
14293 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14294 o = o->op_sibling->op_sibling;
14298 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14299 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14301 /* the following ops are capable of returning PL_sv_undef even for
14302 * defined arg(s) */
14321 case OP_GETPEERNAME:
14369 case OP_SMARTMATCH:
14378 /* XXX tmp hack: these two may call an XS sub, and currently
14379 XS subs don't have a SUB entry on the context stack, so CV and
14380 pad determination goes wrong, and BAD things happen. So, just
14381 don't try to determine the value under those circumstances.
14382 Need a better fix at dome point. DAPM 11/2007 */
14388 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14389 if (gv && GvSV(gv) == uninit_sv)
14390 return newSVpvs_flags("$.", SVs_TEMP);
14395 /* def-ness of rval pos() is independent of the def-ness of its arg */
14396 if ( !(obase->op_flags & OPf_MOD))
14401 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14402 return newSVpvs_flags("${$/}", SVs_TEMP);
14407 if (!(obase->op_flags & OPf_KIDS))
14409 o = cUNOPx(obase)->op_first;
14415 /* This loop checks all the kid ops, skipping any that cannot pos-
14416 * sibly be responsible for the uninitialized value; i.e., defined
14417 * constants and ops that return nothing. If there is only one op
14418 * left that is not skipped, then we *know* it is responsible for
14419 * the uninitialized value. If there is more than one op left, we
14420 * have to look for an exact match in the while() loop below.
14423 for (kid=o; kid; kid = kid->op_sibling) {
14425 const OPCODE type = kid->op_type;
14426 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14427 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14428 || (type == OP_PUSHMARK)
14432 if (o2) { /* more than one found */
14439 return find_uninit_var(o2, uninit_sv, match);
14441 /* scan all args */
14443 sv = find_uninit_var(o, uninit_sv, 1);
14455 =for apidoc report_uninit
14457 Print appropriate "Use of uninitialized variable" warning.
14463 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14467 SV* varname = NULL;
14468 if (uninit_sv && PL_curpad) {
14469 varname = find_uninit_var(PL_op, uninit_sv,0);
14471 sv_insert(varname, 0, 0, " ", 1);
14473 /* diag_listed_as: Use of uninitialized value%s */
14474 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14475 SVfARG(varname ? varname : &PL_sv_no),
14476 " in ", OP_DESC(PL_op));
14479 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14485 * c-indentation-style: bsd
14486 * c-basic-offset: 4
14487 * indent-tabs-mode: t
14490 * ex: set ts=8 sts=4 sw=4 noet: