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 these two if statements:
1614 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1617 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1619 If you wish to remove them, please benchmark to see what the effect is
1621 if (u <= (UV)IV_MAX) {
1622 sv_setiv(sv, (IV)u);
1631 =for apidoc sv_setuv_mg
1633 Like C<sv_setuv>, but also handles 'set' magic.
1639 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1641 PERL_ARGS_ASSERT_SV_SETUV_MG;
1648 =for apidoc sv_setnv
1650 Copies a double into the given SV, upgrading first if necessary.
1651 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1657 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1661 PERL_ARGS_ASSERT_SV_SETNV;
1663 SV_CHECK_THINKFIRST_COW_DROP(sv);
1664 switch (SvTYPE(sv)) {
1667 sv_upgrade(sv, SVt_NV);
1671 sv_upgrade(sv, SVt_PVNV);
1675 if (!isGV_with_GP(sv))
1682 /* diag_listed_as: Can't coerce %s to %s in %s */
1683 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1688 (void)SvNOK_only(sv); /* validate number */
1693 =for apidoc sv_setnv_mg
1695 Like C<sv_setnv>, but also handles 'set' magic.
1701 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1703 PERL_ARGS_ASSERT_SV_SETNV_MG;
1709 /* Print an "isn't numeric" warning, using a cleaned-up,
1710 * printable version of the offending string
1714 S_not_a_number(pTHX_ SV *const sv)
1721 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1724 dsv = newSVpvs_flags("", SVs_TEMP);
1725 pv = sv_uni_display(dsv, sv, 10, UNI_DISPLAY_ISPRINT);
1728 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1729 /* each *s can expand to 4 chars + "...\0",
1730 i.e. need room for 8 chars */
1732 const char *s = SvPVX_const(sv);
1733 const char * const end = s + SvCUR(sv);
1734 for ( ; s < end && d < limit; s++ ) {
1736 if (ch & 128 && !isPRINT_LC(ch)) {
1745 else if (ch == '\r') {
1749 else if (ch == '\f') {
1753 else if (ch == '\\') {
1757 else if (ch == '\0') {
1761 else if (isPRINT_LC(ch))
1778 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1779 "Argument \"%s\" isn't numeric in %s", pv,
1782 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1783 "Argument \"%s\" isn't numeric", pv);
1787 =for apidoc looks_like_number
1789 Test if the content of an SV looks like a number (or is a number).
1790 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1791 non-numeric warning), even if your atof() doesn't grok them. Get-magic is
1798 Perl_looks_like_number(pTHX_ SV *const sv)
1800 register const char *sbegin;
1803 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1805 if (SvPOK(sv) || SvPOKp(sv)) {
1806 sbegin = SvPV_nomg_const(sv, len);
1809 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1810 return grok_number(sbegin, len, NULL);
1814 S_glob_2number(pTHX_ GV * const gv)
1816 SV *const buffer = sv_newmortal();
1818 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1820 gv_efullname3(buffer, gv, "*");
1822 /* We know that all GVs stringify to something that is not-a-number,
1823 so no need to test that. */
1824 if (ckWARN(WARN_NUMERIC))
1825 not_a_number(buffer);
1826 /* We just want something true to return, so that S_sv_2iuv_common
1827 can tail call us and return true. */
1831 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1832 until proven guilty, assume that things are not that bad... */
1837 As 64 bit platforms often have an NV that doesn't preserve all bits of
1838 an IV (an assumption perl has been based on to date) it becomes necessary
1839 to remove the assumption that the NV always carries enough precision to
1840 recreate the IV whenever needed, and that the NV is the canonical form.
1841 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1842 precision as a side effect of conversion (which would lead to insanity
1843 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1844 1) to distinguish between IV/UV/NV slots that have cached a valid
1845 conversion where precision was lost and IV/UV/NV slots that have a
1846 valid conversion which has lost no precision
1847 2) to ensure that if a numeric conversion to one form is requested that
1848 would lose precision, the precise conversion (or differently
1849 imprecise conversion) is also performed and cached, to prevent
1850 requests for different numeric formats on the same SV causing
1851 lossy conversion chains. (lossless conversion chains are perfectly
1856 SvIOKp is true if the IV slot contains a valid value
1857 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1858 SvNOKp is true if the NV slot contains a valid value
1859 SvNOK is true only if the NV value is accurate
1862 while converting from PV to NV, check to see if converting that NV to an
1863 IV(or UV) would lose accuracy over a direct conversion from PV to
1864 IV(or UV). If it would, cache both conversions, return NV, but mark
1865 SV as IOK NOKp (ie not NOK).
1867 While converting from PV to IV, check to see if converting that IV to an
1868 NV would lose accuracy over a direct conversion from PV to NV. If it
1869 would, cache both conversions, flag similarly.
1871 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1872 correctly because if IV & NV were set NV *always* overruled.
1873 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1874 changes - now IV and NV together means that the two are interchangeable:
1875 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1877 The benefit of this is that operations such as pp_add know that if
1878 SvIOK is true for both left and right operands, then integer addition
1879 can be used instead of floating point (for cases where the result won't
1880 overflow). Before, floating point was always used, which could lead to
1881 loss of precision compared with integer addition.
1883 * making IV and NV equal status should make maths accurate on 64 bit
1885 * may speed up maths somewhat if pp_add and friends start to use
1886 integers when possible instead of fp. (Hopefully the overhead in
1887 looking for SvIOK and checking for overflow will not outweigh the
1888 fp to integer speedup)
1889 * will slow down integer operations (callers of SvIV) on "inaccurate"
1890 values, as the change from SvIOK to SvIOKp will cause a call into
1891 sv_2iv each time rather than a macro access direct to the IV slot
1892 * should speed up number->string conversion on integers as IV is
1893 favoured when IV and NV are equally accurate
1895 ####################################################################
1896 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1897 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1898 On the other hand, SvUOK is true iff UV.
1899 ####################################################################
1901 Your mileage will vary depending your CPU's relative fp to integer
1905 #ifndef NV_PRESERVES_UV
1906 # define IS_NUMBER_UNDERFLOW_IV 1
1907 # define IS_NUMBER_UNDERFLOW_UV 2
1908 # define IS_NUMBER_IV_AND_UV 2
1909 # define IS_NUMBER_OVERFLOW_IV 4
1910 # define IS_NUMBER_OVERFLOW_UV 5
1912 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1914 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1916 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1924 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1926 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));
1927 if (SvNVX(sv) < (NV)IV_MIN) {
1928 (void)SvIOKp_on(sv);
1930 SvIV_set(sv, IV_MIN);
1931 return IS_NUMBER_UNDERFLOW_IV;
1933 if (SvNVX(sv) > (NV)UV_MAX) {
1934 (void)SvIOKp_on(sv);
1937 SvUV_set(sv, UV_MAX);
1938 return IS_NUMBER_OVERFLOW_UV;
1940 (void)SvIOKp_on(sv);
1942 /* Can't use strtol etc to convert this string. (See truth table in
1944 if (SvNVX(sv) <= (UV)IV_MAX) {
1945 SvIV_set(sv, I_V(SvNVX(sv)));
1946 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1947 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1949 /* Integer is imprecise. NOK, IOKp */
1951 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1954 SvUV_set(sv, U_V(SvNVX(sv)));
1955 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1956 if (SvUVX(sv) == UV_MAX) {
1957 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1958 possibly be preserved by NV. Hence, it must be overflow.
1960 return IS_NUMBER_OVERFLOW_UV;
1962 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1964 /* Integer is imprecise. NOK, IOKp */
1966 return IS_NUMBER_OVERFLOW_IV;
1968 #endif /* !NV_PRESERVES_UV*/
1971 S_sv_2iuv_common(pTHX_ SV *const sv)
1975 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1978 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1979 * without also getting a cached IV/UV from it at the same time
1980 * (ie PV->NV conversion should detect loss of accuracy and cache
1981 * IV or UV at same time to avoid this. */
1982 /* IV-over-UV optimisation - choose to cache IV if possible */
1984 if (SvTYPE(sv) == SVt_NV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1988 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1989 certainly cast into the IV range at IV_MAX, whereas the correct
1990 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1992 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1993 if (Perl_isnan(SvNVX(sv))) {
1999 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2000 SvIV_set(sv, I_V(SvNVX(sv)));
2001 if (SvNVX(sv) == (NV) SvIVX(sv)
2002 #ifndef NV_PRESERVES_UV
2003 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2004 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2005 /* Don't flag it as "accurately an integer" if the number
2006 came from a (by definition imprecise) NV operation, and
2007 we're outside the range of NV integer precision */
2011 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2013 /* scalar has trailing garbage, eg "42a" */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2022 /* IV not precise. No need to convert from PV, as NV
2023 conversion would already have cached IV if it detected
2024 that PV->IV would be better than PV->NV->IV
2025 flags already correct - don't set public IOK. */
2026 DEBUG_c(PerlIO_printf(Perl_debug_log,
2027 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2032 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2033 but the cast (NV)IV_MIN rounds to a the value less (more
2034 negative) than IV_MIN which happens to be equal to SvNVX ??
2035 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2036 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2037 (NV)UVX == NVX are both true, but the values differ. :-(
2038 Hopefully for 2s complement IV_MIN is something like
2039 0x8000000000000000 which will be exact. NWC */
2042 SvUV_set(sv, U_V(SvNVX(sv)));
2044 (SvNVX(sv) == (NV) SvUVX(sv))
2045 #ifndef NV_PRESERVES_UV
2046 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2047 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2048 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2049 /* Don't flag it as "accurately an integer" if the number
2050 came from a (by definition imprecise) NV operation, and
2051 we're outside the range of NV integer precision */
2057 DEBUG_c(PerlIO_printf(Perl_debug_log,
2058 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2064 else if (SvPOKp(sv) && SvLEN(sv)) {
2066 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2067 /* We want to avoid a possible problem when we cache an IV/ a UV which
2068 may be later translated to an NV, and the resulting NV is not
2069 the same as the direct translation of the initial string
2070 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2071 be careful to ensure that the value with the .456 is around if the
2072 NV value is requested in the future).
2074 This means that if we cache such an IV/a UV, we need to cache the
2075 NV as well. Moreover, we trade speed for space, and do not
2076 cache the NV if we are sure it's not needed.
2079 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2080 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2081 == IS_NUMBER_IN_UV) {
2082 /* It's definitely an integer, only upgrade to PVIV */
2083 if (SvTYPE(sv) < SVt_PVIV)
2084 sv_upgrade(sv, SVt_PVIV);
2086 } else if (SvTYPE(sv) < SVt_PVNV)
2087 sv_upgrade(sv, SVt_PVNV);
2089 /* If NVs preserve UVs then we only use the UV value if we know that
2090 we aren't going to call atof() below. If NVs don't preserve UVs
2091 then the value returned may have more precision than atof() will
2092 return, even though value isn't perfectly accurate. */
2093 if ((numtype & (IS_NUMBER_IN_UV
2094 #ifdef NV_PRESERVES_UV
2097 )) == IS_NUMBER_IN_UV) {
2098 /* This won't turn off the public IOK flag if it was set above */
2099 (void)SvIOKp_on(sv);
2101 if (!(numtype & IS_NUMBER_NEG)) {
2103 if (value <= (UV)IV_MAX) {
2104 SvIV_set(sv, (IV)value);
2106 /* it didn't overflow, and it was positive. */
2107 SvUV_set(sv, value);
2111 /* 2s complement assumption */
2112 if (value <= (UV)IV_MIN) {
2113 SvIV_set(sv, -(IV)value);
2115 /* Too negative for an IV. This is a double upgrade, but
2116 I'm assuming it will be rare. */
2117 if (SvTYPE(sv) < SVt_PVNV)
2118 sv_upgrade(sv, SVt_PVNV);
2122 SvNV_set(sv, -(NV)value);
2123 SvIV_set(sv, IV_MIN);
2127 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2128 will be in the previous block to set the IV slot, and the next
2129 block to set the NV slot. So no else here. */
2131 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2132 != IS_NUMBER_IN_UV) {
2133 /* It wasn't an (integer that doesn't overflow the UV). */
2134 SvNV_set(sv, Atof(SvPVX_const(sv)));
2136 if (! numtype && ckWARN(WARN_NUMERIC))
2139 #if defined(USE_LONG_DOUBLE)
2140 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2141 PTR2UV(sv), SvNVX(sv)));
2143 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2144 PTR2UV(sv), SvNVX(sv)));
2147 #ifdef NV_PRESERVES_UV
2148 (void)SvIOKp_on(sv);
2150 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2151 SvIV_set(sv, I_V(SvNVX(sv)));
2152 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2155 NOOP; /* Integer is imprecise. NOK, IOKp */
2157 /* UV will not work better than IV */
2159 if (SvNVX(sv) > (NV)UV_MAX) {
2161 /* Integer is inaccurate. NOK, IOKp, is UV */
2162 SvUV_set(sv, UV_MAX);
2164 SvUV_set(sv, U_V(SvNVX(sv)));
2165 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2166 NV preservse UV so can do correct comparison. */
2167 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2170 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2175 #else /* NV_PRESERVES_UV */
2176 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2177 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2178 /* The IV/UV slot will have been set from value returned by
2179 grok_number above. The NV slot has just been set using
2182 assert (SvIOKp(sv));
2184 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2185 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2186 /* Small enough to preserve all bits. */
2187 (void)SvIOKp_on(sv);
2189 SvIV_set(sv, I_V(SvNVX(sv)));
2190 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2192 /* Assumption: first non-preserved integer is < IV_MAX,
2193 this NV is in the preserved range, therefore: */
2194 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2196 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);
2200 0 0 already failed to read UV.
2201 0 1 already failed to read UV.
2202 1 0 you won't get here in this case. IV/UV
2203 slot set, public IOK, Atof() unneeded.
2204 1 1 already read UV.
2205 so there's no point in sv_2iuv_non_preserve() attempting
2206 to use atol, strtol, strtoul etc. */
2208 sv_2iuv_non_preserve (sv, numtype);
2210 sv_2iuv_non_preserve (sv);
2214 #endif /* NV_PRESERVES_UV */
2215 /* It might be more code efficient to go through the entire logic above
2216 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2217 gets complex and potentially buggy, so more programmer efficient
2218 to do it this way, by turning off the public flags: */
2220 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2224 if (isGV_with_GP(sv))
2225 return glob_2number(MUTABLE_GV(sv));
2227 if (!SvPADTMP(sv)) {
2228 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2231 if (SvTYPE(sv) < SVt_IV)
2232 /* Typically the caller expects that sv_any is not NULL now. */
2233 sv_upgrade(sv, SVt_IV);
2234 /* Return 0 from the caller. */
2241 =for apidoc sv_2iv_flags
2243 Return the integer value of an SV, doing any necessary string
2244 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2245 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2251 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2256 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2257 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2258 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2259 In practice they are extremely unlikely to actually get anywhere
2260 accessible by user Perl code - the only way that I'm aware of is when
2261 a constant subroutine which is used as the second argument to index.
2263 if (flags & SV_GMAGIC)
2268 return I_V(SvNVX(sv));
2270 if (SvPOKp(sv) && SvLEN(sv)) {
2273 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2275 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2276 == IS_NUMBER_IN_UV) {
2277 /* It's definitely an integer */
2278 if (numtype & IS_NUMBER_NEG) {
2279 if (value < (UV)IV_MIN)
2282 if (value < (UV)IV_MAX)
2287 if (ckWARN(WARN_NUMERIC))
2290 return I_V(Atof(SvPVX_const(sv)));
2295 assert(SvTYPE(sv) >= SVt_PVMG);
2296 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2297 } else if (SvTHINKFIRST(sv)) {
2302 if (flags & SV_SKIP_OVERLOAD)
2304 tmpstr = AMG_CALLunary(sv, numer_amg);
2305 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2306 return SvIV(tmpstr);
2309 return PTR2IV(SvRV(sv));
2312 sv_force_normal_flags(sv, 0);
2314 if (SvREADONLY(sv) && !SvOK(sv)) {
2315 if (ckWARN(WARN_UNINITIALIZED))
2321 if (S_sv_2iuv_common(aTHX_ sv))
2324 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2325 PTR2UV(sv),SvIVX(sv)));
2326 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2330 =for apidoc sv_2uv_flags
2332 Return the unsigned integer value of an SV, doing any necessary string
2333 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2334 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2340 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2345 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2346 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2347 the same flag bit as SVf_IVisUV, so must not let them cache IVs. */
2348 if (flags & SV_GMAGIC)
2353 return U_V(SvNVX(sv));
2354 if (SvPOKp(sv) && SvLEN(sv)) {
2357 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2359 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2360 == IS_NUMBER_IN_UV) {
2361 /* It's definitely an integer */
2362 if (!(numtype & IS_NUMBER_NEG))
2366 if (ckWARN(WARN_NUMERIC))
2369 return U_V(Atof(SvPVX_const(sv)));
2374 assert(SvTYPE(sv) >= SVt_PVMG);
2375 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2376 } else if (SvTHINKFIRST(sv)) {
2381 if (flags & SV_SKIP_OVERLOAD)
2383 tmpstr = AMG_CALLunary(sv, numer_amg);
2384 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2385 return SvUV(tmpstr);
2388 return PTR2UV(SvRV(sv));
2391 sv_force_normal_flags(sv, 0);
2393 if (SvREADONLY(sv) && !SvOK(sv)) {
2394 if (ckWARN(WARN_UNINITIALIZED))
2400 if (S_sv_2iuv_common(aTHX_ sv))
2404 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2405 PTR2UV(sv),SvUVX(sv)));
2406 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2410 =for apidoc sv_2nv_flags
2412 Return the num value of an SV, doing any necessary string or integer
2413 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2414 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2420 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2425 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2426 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2427 the same flag bit as SVf_IVisUV, so must not let them cache NVs. */
2428 if (flags & SV_GMAGIC)
2432 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2433 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2434 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2436 return Atof(SvPVX_const(sv));
2440 return (NV)SvUVX(sv);
2442 return (NV)SvIVX(sv);
2447 assert(SvTYPE(sv) >= SVt_PVMG);
2448 /* This falls through to the report_uninit near the end of the
2450 } else if (SvTHINKFIRST(sv)) {
2455 if (flags & SV_SKIP_OVERLOAD)
2457 tmpstr = AMG_CALLunary(sv, numer_amg);
2458 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2459 return SvNV(tmpstr);
2462 return PTR2NV(SvRV(sv));
2465 sv_force_normal_flags(sv, 0);
2467 if (SvREADONLY(sv) && !SvOK(sv)) {
2468 if (ckWARN(WARN_UNINITIALIZED))
2473 if (SvTYPE(sv) < SVt_NV) {
2474 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2475 sv_upgrade(sv, SVt_NV);
2476 #ifdef USE_LONG_DOUBLE
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log,
2480 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2481 PTR2UV(sv), SvNVX(sv));
2482 RESTORE_NUMERIC_LOCAL();
2486 STORE_NUMERIC_LOCAL_SET_STANDARD();
2487 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2488 PTR2UV(sv), SvNVX(sv));
2489 RESTORE_NUMERIC_LOCAL();
2493 else if (SvTYPE(sv) < SVt_PVNV)
2494 sv_upgrade(sv, SVt_PVNV);
2499 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2500 #ifdef NV_PRESERVES_UV
2506 /* Only set the public NV OK flag if this NV preserves the IV */
2507 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2509 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2510 : (SvIVX(sv) == I_V(SvNVX(sv))))
2516 else if (SvPOKp(sv) && SvLEN(sv)) {
2518 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2519 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2521 #ifdef NV_PRESERVES_UV
2522 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2523 == IS_NUMBER_IN_UV) {
2524 /* It's definitely an integer */
2525 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2527 SvNV_set(sv, Atof(SvPVX_const(sv)));
2533 SvNV_set(sv, Atof(SvPVX_const(sv)));
2534 /* Only set the public NV OK flag if this NV preserves the value in
2535 the PV at least as well as an IV/UV would.
2536 Not sure how to do this 100% reliably. */
2537 /* if that shift count is out of range then Configure's test is
2538 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2540 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2541 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2542 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2543 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2544 /* Can't use strtol etc to convert this string, so don't try.
2545 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2548 /* value has been set. It may not be precise. */
2549 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2550 /* 2s complement assumption for (UV)IV_MIN */
2551 SvNOK_on(sv); /* Integer is too negative. */
2556 if (numtype & IS_NUMBER_NEG) {
2557 SvIV_set(sv, -(IV)value);
2558 } else if (value <= (UV)IV_MAX) {
2559 SvIV_set(sv, (IV)value);
2561 SvUV_set(sv, value);
2565 if (numtype & IS_NUMBER_NOT_INT) {
2566 /* I believe that even if the original PV had decimals,
2567 they are lost beyond the limit of the FP precision.
2568 However, neither is canonical, so both only get p
2569 flags. NWC, 2000/11/25 */
2570 /* Both already have p flags, so do nothing */
2572 const NV nv = SvNVX(sv);
2573 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2574 if (SvIVX(sv) == I_V(nv)) {
2577 /* It had no "." so it must be integer. */
2581 /* between IV_MAX and NV(UV_MAX).
2582 Could be slightly > UV_MAX */
2584 if (numtype & IS_NUMBER_NOT_INT) {
2585 /* UV and NV both imprecise. */
2587 const UV nv_as_uv = U_V(nv);
2589 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2598 /* It might be more code efficient to go through the entire logic above
2599 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2600 gets complex and potentially buggy, so more programmer efficient
2601 to do it this way, by turning off the public flags: */
2603 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2604 #endif /* NV_PRESERVES_UV */
2607 if (isGV_with_GP(sv)) {
2608 glob_2number(MUTABLE_GV(sv));
2612 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2614 assert (SvTYPE(sv) >= SVt_NV);
2615 /* Typically the caller expects that sv_any is not NULL now. */
2616 /* XXX Ilya implies that this is a bug in callers that assume this
2617 and ideally should be fixed. */
2620 #if defined(USE_LONG_DOUBLE)
2622 STORE_NUMERIC_LOCAL_SET_STANDARD();
2623 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2624 PTR2UV(sv), SvNVX(sv));
2625 RESTORE_NUMERIC_LOCAL();
2629 STORE_NUMERIC_LOCAL_SET_STANDARD();
2630 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2631 PTR2UV(sv), SvNVX(sv));
2632 RESTORE_NUMERIC_LOCAL();
2641 Return an SV with the numeric value of the source SV, doing any necessary
2642 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2643 access this function.
2649 Perl_sv_2num(pTHX_ register SV *const sv)
2651 PERL_ARGS_ASSERT_SV_2NUM;
2656 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2657 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2658 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2659 return sv_2num(tmpsv);
2661 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2664 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2665 * UV as a string towards the end of buf, and return pointers to start and
2668 * We assume that buf is at least TYPE_CHARS(UV) long.
2672 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2674 char *ptr = buf + TYPE_CHARS(UV);
2675 char * const ebuf = ptr;
2678 PERL_ARGS_ASSERT_UIV_2BUF;
2690 *--ptr = '0' + (char)(uv % 10);
2699 =for apidoc sv_2pv_flags
2701 Returns a pointer to the string value of an SV, and sets *lp to its length.
2702 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2703 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2704 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2710 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2720 if (SvGMAGICAL(sv)) {
2721 if (flags & SV_GMAGIC)
2726 if (flags & SV_MUTABLE_RETURN)
2727 return SvPVX_mutable(sv);
2728 if (flags & SV_CONST_RETURN)
2729 return (char *)SvPVX_const(sv);
2732 if (SvIOKp(sv) || SvNOKp(sv)) {
2733 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2738 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2739 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2740 } else if(SvNVX(sv) == 0.0) {
2745 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2752 SvUPGRADE(sv, SVt_PV);
2755 s = SvGROW_mutable(sv, len + 1);
2758 return (char*)memcpy(s, tbuf, len + 1);
2764 assert(SvTYPE(sv) >= SVt_PVMG);
2765 /* This falls through to the report_uninit near the end of the
2767 } else if (SvTHINKFIRST(sv)) {
2772 if (flags & SV_SKIP_OVERLOAD)
2774 tmpstr = AMG_CALLunary(sv, string_amg);
2775 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2776 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2778 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2782 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2783 if (flags & SV_CONST_RETURN) {
2784 pv = (char *) SvPVX_const(tmpstr);
2786 pv = (flags & SV_MUTABLE_RETURN)
2787 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2790 *lp = SvCUR(tmpstr);
2792 pv = sv_2pv_flags(tmpstr, lp, flags);
2805 SV *const referent = SvRV(sv);
2809 retval = buffer = savepvn("NULLREF", len);
2810 } else if (SvTYPE(referent) == SVt_REGEXP) {
2811 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2816 /* If the regex is UTF-8 we want the containing scalar to
2817 have an UTF-8 flag too */
2823 if ((seen_evals = RX_SEEN_EVALS(re)))
2824 PL_reginterp_cnt += seen_evals;
2827 *lp = RX_WRAPLEN(re);
2829 return RX_WRAPPED(re);
2831 const char *const typestr = sv_reftype(referent, 0);
2832 const STRLEN typelen = strlen(typestr);
2833 UV addr = PTR2UV(referent);
2834 const char *stashname = NULL;
2835 STRLEN stashnamelen = 0; /* hush, gcc */
2836 const char *buffer_end;
2838 if (SvOBJECT(referent)) {
2839 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2842 stashname = HEK_KEY(name);
2843 stashnamelen = HEK_LEN(name);
2845 if (HEK_UTF8(name)) {
2851 stashname = "__ANON__";
2854 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2855 + 2 * sizeof(UV) + 2 /* )\0 */;
2857 len = typelen + 3 /* (0x */
2858 + 2 * sizeof(UV) + 2 /* )\0 */;
2861 Newx(buffer, len, char);
2862 buffer_end = retval = buffer + len;
2864 /* Working backwards */
2868 *--retval = PL_hexdigit[addr & 15];
2869 } while (addr >>= 4);
2875 memcpy(retval, typestr, typelen);
2879 retval -= stashnamelen;
2880 memcpy(retval, stashname, stashnamelen);
2882 /* retval may not necessarily have reached the start of the
2884 assert (retval >= buffer);
2886 len = buffer_end - retval - 1; /* -1 for that \0 */
2894 if (SvREADONLY(sv) && !SvOK(sv)) {
2897 if (flags & SV_UNDEF_RETURNS_NULL)
2899 if (ckWARN(WARN_UNINITIALIZED))
2904 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2905 /* I'm assuming that if both IV and NV are equally valid then
2906 converting the IV is going to be more efficient */
2907 const U32 isUIOK = SvIsUV(sv);
2908 char buf[TYPE_CHARS(UV)];
2912 if (SvTYPE(sv) < SVt_PVIV)
2913 sv_upgrade(sv, SVt_PVIV);
2914 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2916 /* inlined from sv_setpvn */
2917 s = SvGROW_mutable(sv, len + 1);
2918 Move(ptr, s, len, char);
2922 else if (SvNOKp(sv)) {
2923 if (SvTYPE(sv) < SVt_PVNV)
2924 sv_upgrade(sv, SVt_PVNV);
2925 if (SvNVX(sv) == 0.0) {
2926 s = SvGROW_mutable(sv, 2);
2931 /* The +20 is pure guesswork. Configure test needed. --jhi */
2932 s = SvGROW_mutable(sv, NV_DIG + 20);
2933 /* some Xenix systems wipe out errno here */
2934 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2944 if (isGV_with_GP(sv)) {
2945 GV *const gv = MUTABLE_GV(sv);
2946 SV *const buffer = sv_newmortal();
2948 gv_efullname3(buffer, gv, "*");
2950 assert(SvPOK(buffer));
2952 *lp = SvCUR(buffer);
2954 if ( SvUTF8(buffer) ) SvUTF8_on(sv);
2955 return SvPVX(buffer);
2960 if (flags & SV_UNDEF_RETURNS_NULL)
2962 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2964 if (SvTYPE(sv) < SVt_PV)
2965 /* Typically the caller expects that sv_any is not NULL now. */
2966 sv_upgrade(sv, SVt_PV);
2970 const STRLEN len = s - SvPVX_const(sv);
2976 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2977 PTR2UV(sv),SvPVX_const(sv)));
2978 if (flags & SV_CONST_RETURN)
2979 return (char *)SvPVX_const(sv);
2980 if (flags & SV_MUTABLE_RETURN)
2981 return SvPVX_mutable(sv);
2986 =for apidoc sv_copypv
2988 Copies a stringified representation of the source SV into the
2989 destination SV. Automatically performs any necessary mg_get and
2990 coercion of numeric values into strings. Guaranteed to preserve
2991 UTF8 flag even from overloaded objects. Similar in nature to
2992 sv_2pv[_flags] but operates directly on an SV instead of just the
2993 string. Mostly uses sv_2pv_flags to do its work, except when that
2994 would lose the UTF-8'ness of the PV.
3000 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3003 const char * const s = SvPV_const(ssv,len);
3005 PERL_ARGS_ASSERT_SV_COPYPV;
3007 sv_setpvn(dsv,s,len);
3015 =for apidoc sv_2pvbyte
3017 Return a pointer to the byte-encoded representation of the SV, and set *lp
3018 to its length. May cause the SV to be downgraded from UTF-8 as a
3021 Usually accessed via the C<SvPVbyte> macro.
3027 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3029 PERL_ARGS_ASSERT_SV_2PVBYTE;
3032 sv_utf8_downgrade(sv,0);
3033 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3037 =for apidoc sv_2pvutf8
3039 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3040 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3042 Usually accessed via the C<SvPVutf8> macro.
3048 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3050 PERL_ARGS_ASSERT_SV_2PVUTF8;
3052 sv_utf8_upgrade(sv);
3053 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3058 =for apidoc sv_2bool
3060 This macro is only used by sv_true() or its macro equivalent, and only if
3061 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3062 It calls sv_2bool_flags with the SV_GMAGIC flag.
3064 =for apidoc sv_2bool_flags
3066 This function is only used by sv_true() and friends, and only if
3067 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3068 contain SV_GMAGIC, then it does an mg_get() first.
3075 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3079 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3081 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3087 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3088 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3089 return cBOOL(SvTRUE(tmpsv));
3091 return SvRV(sv) != 0;
3094 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3096 (*sv->sv_u.svu_pv > '0' ||
3097 Xpvtmp->xpv_cur > 1 ||
3098 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3105 return SvIVX(sv) != 0;
3108 return SvNVX(sv) != 0.0;
3110 if (isGV_with_GP(sv))
3120 =for apidoc sv_utf8_upgrade
3122 Converts the PV of an SV to its UTF-8-encoded form.
3123 Forces the SV to string form if it is not already.
3124 Will C<mg_get> on C<sv> if appropriate.
3125 Always sets the SvUTF8 flag to avoid future validity checks even
3126 if the whole string is the same in UTF-8 as not.
3127 Returns the number of bytes in the converted string
3129 This is not as a general purpose byte encoding to Unicode interface:
3130 use the Encode extension for that.
3132 =for apidoc sv_utf8_upgrade_nomg
3134 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3136 =for apidoc sv_utf8_upgrade_flags
3138 Converts the PV of an SV to its UTF-8-encoded form.
3139 Forces the SV to string form if it is not already.
3140 Always sets the SvUTF8 flag to avoid future validity checks even
3141 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3142 will C<mg_get> on C<sv> if appropriate, else not.
3143 Returns the number of bytes in the converted string
3144 C<sv_utf8_upgrade> and
3145 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3147 This is not as a general purpose byte encoding to Unicode interface:
3148 use the Encode extension for that.
3152 The grow version is currently not externally documented. It adds a parameter,
3153 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3154 have free after it upon return. This allows the caller to reserve extra space
3155 that it intends to fill, to avoid extra grows.
3157 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3158 which can be used to tell this function to not first check to see if there are
3159 any characters that are different in UTF-8 (variant characters) which would
3160 force it to allocate a new string to sv, but to assume there are. Typically
3161 this flag is used by a routine that has already parsed the string to find that
3162 there are such characters, and passes this information on so that the work
3163 doesn't have to be repeated.
3165 (One might think that the calling routine could pass in the position of the
3166 first such variant, so it wouldn't have to be found again. But that is not the
3167 case, because typically when the caller is likely to use this flag, it won't be
3168 calling this routine unless it finds something that won't fit into a byte.
3169 Otherwise it tries to not upgrade and just use bytes. But some things that
3170 do fit into a byte are variants in utf8, and the caller may not have been
3171 keeping track of these.)
3173 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3174 isn't guaranteed due to having other routines do the work in some input cases,
3175 or if the input is already flagged as being in utf8.
3177 The speed of this could perhaps be improved for many cases if someone wanted to
3178 write a fast function that counts the number of variant characters in a string,
3179 especially if it could return the position of the first one.
3184 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3188 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3190 if (sv == &PL_sv_undef)
3194 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3195 (void) sv_2pv_flags(sv,&len, flags);
3197 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3201 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3206 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3211 sv_force_normal_flags(sv, 0);
3214 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3215 sv_recode_to_utf8(sv, PL_encoding);
3216 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3220 if (SvCUR(sv) == 0) {
3221 if (extra) SvGROW(sv, extra);
3222 } else { /* Assume Latin-1/EBCDIC */
3223 /* This function could be much more efficient if we
3224 * had a FLAG in SVs to signal if there are any variant
3225 * chars in the PV. Given that there isn't such a flag
3226 * make the loop as fast as possible (although there are certainly ways
3227 * to speed this up, eg. through vectorization) */
3228 U8 * s = (U8 *) SvPVX_const(sv);
3229 U8 * e = (U8 *) SvEND(sv);
3231 STRLEN two_byte_count = 0;
3233 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3235 /* See if really will need to convert to utf8. We mustn't rely on our
3236 * incoming SV being well formed and having a trailing '\0', as certain
3237 * code in pp_formline can send us partially built SVs. */
3241 if (NATIVE_IS_INVARIANT(ch)) continue;
3243 t--; /* t already incremented; re-point to first variant */
3248 /* utf8 conversion not needed because all are invariants. Mark as
3249 * UTF-8 even if no variant - saves scanning loop */
3251 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3256 /* Here, the string should be converted to utf8, either because of an
3257 * input flag (two_byte_count = 0), or because a character that
3258 * requires 2 bytes was found (two_byte_count = 1). t points either to
3259 * the beginning of the string (if we didn't examine anything), or to
3260 * the first variant. In either case, everything from s to t - 1 will
3261 * occupy only 1 byte each on output.
3263 * There are two main ways to convert. One is to create a new string
3264 * and go through the input starting from the beginning, appending each
3265 * converted value onto the new string as we go along. It's probably
3266 * best to allocate enough space in the string for the worst possible
3267 * case rather than possibly running out of space and having to
3268 * reallocate and then copy what we've done so far. Since everything
3269 * from s to t - 1 is invariant, the destination can be initialized
3270 * with these using a fast memory copy
3272 * The other way is to figure out exactly how big the string should be
3273 * by parsing the entire input. Then you don't have to make it big
3274 * enough to handle the worst possible case, and more importantly, if
3275 * the string you already have is large enough, you don't have to
3276 * allocate a new string, you can copy the last character in the input
3277 * string to the final position(s) that will be occupied by the
3278 * converted string and go backwards, stopping at t, since everything
3279 * before that is invariant.
3281 * There are advantages and disadvantages to each method.
3283 * In the first method, we can allocate a new string, do the memory
3284 * copy from the s to t - 1, and then proceed through the rest of the
3285 * string byte-by-byte.
3287 * In the second method, we proceed through the rest of the input
3288 * string just calculating how big the converted string will be. Then
3289 * there are two cases:
3290 * 1) if the string has enough extra space to handle the converted
3291 * value. We go backwards through the string, converting until we
3292 * get to the position we are at now, and then stop. If this
3293 * position is far enough along in the string, this method is
3294 * faster than the other method. If the memory copy were the same
3295 * speed as the byte-by-byte loop, that position would be about
3296 * half-way, as at the half-way mark, parsing to the end and back
3297 * is one complete string's parse, the same amount as starting
3298 * over and going all the way through. Actually, it would be
3299 * somewhat less than half-way, as it's faster to just count bytes
3300 * than to also copy, and we don't have the overhead of allocating
3301 * a new string, changing the scalar to use it, and freeing the
3302 * existing one. But if the memory copy is fast, the break-even
3303 * point is somewhere after half way. The counting loop could be
3304 * sped up by vectorization, etc, to move the break-even point
3305 * further towards the beginning.
3306 * 2) if the string doesn't have enough space to handle the converted
3307 * value. A new string will have to be allocated, and one might
3308 * as well, given that, start from the beginning doing the first
3309 * method. We've spent extra time parsing the string and in
3310 * exchange all we've gotten is that we know precisely how big to
3311 * make the new one. Perl is more optimized for time than space,
3312 * so this case is a loser.
3313 * So what I've decided to do is not use the 2nd method unless it is
3314 * guaranteed that a new string won't have to be allocated, assuming
3315 * the worst case. I also decided not to put any more conditions on it
3316 * than this, for now. It seems likely that, since the worst case is
3317 * twice as big as the unknown portion of the string (plus 1), we won't
3318 * be guaranteed enough space, causing us to go to the first method,
3319 * unless the string is short, or the first variant character is near
3320 * the end of it. In either of these cases, it seems best to use the
3321 * 2nd method. The only circumstance I can think of where this would
3322 * be really slower is if the string had once had much more data in it
3323 * than it does now, but there is still a substantial amount in it */
3326 STRLEN invariant_head = t - s;
3327 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3328 if (SvLEN(sv) < size) {
3330 /* Here, have decided to allocate a new string */
3335 Newx(dst, size, U8);
3337 /* If no known invariants at the beginning of the input string,
3338 * set so starts from there. Otherwise, can use memory copy to
3339 * get up to where we are now, and then start from here */
3341 if (invariant_head <= 0) {
3344 Copy(s, dst, invariant_head, char);
3345 d = dst + invariant_head;
3349 const UV uv = NATIVE8_TO_UNI(*t++);
3350 if (UNI_IS_INVARIANT(uv))
3351 *d++ = (U8)UNI_TO_NATIVE(uv);
3353 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3354 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3358 SvPV_free(sv); /* No longer using pre-existing string */
3359 SvPV_set(sv, (char*)dst);
3360 SvCUR_set(sv, d - dst);
3361 SvLEN_set(sv, size);
3364 /* Here, have decided to get the exact size of the string.
3365 * Currently this happens only when we know that there is
3366 * guaranteed enough space to fit the converted string, so
3367 * don't have to worry about growing. If two_byte_count is 0,
3368 * then t points to the first byte of the string which hasn't
3369 * been examined yet. Otherwise two_byte_count is 1, and t
3370 * points to the first byte in the string that will expand to
3371 * two. Depending on this, start examining at t or 1 after t.
3374 U8 *d = t + two_byte_count;
3377 /* Count up the remaining bytes that expand to two */
3380 const U8 chr = *d++;
3381 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3384 /* The string will expand by just the number of bytes that
3385 * occupy two positions. But we are one afterwards because of
3386 * the increment just above. This is the place to put the
3387 * trailing NUL, and to set the length before we decrement */
3389 d += two_byte_count;
3390 SvCUR_set(sv, d - s);
3394 /* Having decremented d, it points to the position to put the
3395 * very last byte of the expanded string. Go backwards through
3396 * the string, copying and expanding as we go, stopping when we
3397 * get to the part that is invariant the rest of the way down */
3401 const U8 ch = NATIVE8_TO_UNI(*e--);
3402 if (UNI_IS_INVARIANT(ch)) {
3403 *d-- = UNI_TO_NATIVE(ch);
3405 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3406 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3411 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3412 /* Update pos. We do it at the end rather than during
3413 * the upgrade, to avoid slowing down the common case
3414 * (upgrade without pos) */
3415 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3417 I32 pos = mg->mg_len;
3418 if (pos > 0 && (U32)pos > invariant_head) {
3419 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3420 STRLEN n = (U32)pos - invariant_head;
3422 if (UTF8_IS_START(*d))
3427 mg->mg_len = d - (U8*)SvPVX(sv);
3430 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3431 magic_setutf8(sv,mg); /* clear UTF8 cache */
3436 /* Mark as UTF-8 even if no variant - saves scanning loop */
3442 =for apidoc sv_utf8_downgrade
3444 Attempts to convert the PV of an SV from characters to bytes.
3445 If the PV contains a character that cannot fit
3446 in a byte, this conversion will fail;
3447 in this case, either returns false or, if C<fail_ok> is not
3450 This is not as a general purpose Unicode to byte encoding interface:
3451 use the Encode extension for that.
3457 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3461 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3463 if (SvPOKp(sv) && SvUTF8(sv)) {
3467 int mg_flags = SV_GMAGIC;
3470 sv_force_normal_flags(sv, 0);
3472 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3474 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3476 I32 pos = mg->mg_len;
3478 sv_pos_b2u(sv, &pos);
3479 mg_flags = 0; /* sv_pos_b2u does get magic */
3483 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3484 magic_setutf8(sv,mg); /* clear UTF8 cache */
3487 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3489 if (!utf8_to_bytes(s, &len)) {
3494 Perl_croak(aTHX_ "Wide character in %s",
3497 Perl_croak(aTHX_ "Wide character");
3508 =for apidoc sv_utf8_encode
3510 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3511 flag off so that it looks like octets again.
3517 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3519 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3522 sv_force_normal_flags(sv, 0);
3524 if (SvREADONLY(sv)) {
3525 Perl_croak_no_modify(aTHX);
3527 (void) sv_utf8_upgrade(sv);
3532 =for apidoc sv_utf8_decode
3534 If the PV of the SV is an octet sequence in UTF-8
3535 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3536 so that it looks like a character. If the PV contains only single-byte
3537 characters, the C<SvUTF8> flag stays off.
3538 Scans PV for validity and returns false if the PV is invalid UTF-8.
3544 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3546 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3549 const U8 *start, *c;
3552 /* The octets may have got themselves encoded - get them back as
3555 if (!sv_utf8_downgrade(sv, TRUE))
3558 /* it is actually just a matter of turning the utf8 flag on, but
3559 * we want to make sure everything inside is valid utf8 first.
3561 c = start = (const U8 *) SvPVX_const(sv);
3562 if (!is_utf8_string(c, SvCUR(sv)+1))
3564 e = (const U8 *) SvEND(sv);
3567 if (!UTF8_IS_INVARIANT(ch)) {
3572 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3573 /* adjust pos to the start of a UTF8 char sequence */
3574 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3576 I32 pos = mg->mg_len;
3578 for (c = start + pos; c > start; c--) {
3579 if (UTF8_IS_START(*c))
3582 mg->mg_len = c - start;
3585 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3586 magic_setutf8(sv,mg); /* clear UTF8 cache */
3593 =for apidoc sv_setsv
3595 Copies the contents of the source SV C<ssv> into the destination SV
3596 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3597 function if the source SV needs to be reused. Does not handle 'set' magic.
3598 Loosely speaking, it performs a copy-by-value, obliterating any previous
3599 content of the destination.
3601 You probably want to use one of the assortment of wrappers, such as
3602 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3603 C<SvSetMagicSV_nosteal>.
3605 =for apidoc sv_setsv_flags
3607 Copies the contents of the source SV C<ssv> into the destination SV
3608 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3609 function if the source SV needs to be reused. Does not handle 'set' magic.
3610 Loosely speaking, it performs a copy-by-value, obliterating any previous
3611 content of the destination.
3612 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3613 C<ssv> if appropriate, else not. If the C<flags>
3614 parameter has the C<NOSTEAL> bit set then the
3615 buffers of temps will not be stolen. <sv_setsv>
3616 and C<sv_setsv_nomg> are implemented in terms of this function.
3618 You probably want to use one of the assortment of wrappers, such as
3619 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3620 C<SvSetMagicSV_nosteal>.
3622 This is the primary function for copying scalars, and most other
3623 copy-ish functions and macros use this underneath.
3629 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3631 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3632 HV *old_stash = NULL;
3634 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3636 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3637 const char * const name = GvNAME(sstr);
3638 const STRLEN len = GvNAMELEN(sstr);
3640 if (dtype >= SVt_PV) {
3646 SvUPGRADE(dstr, SVt_PVGV);
3647 (void)SvOK_off(dstr);
3648 /* We have to turn this on here, even though we turn it off
3649 below, as GvSTASH will fail an assertion otherwise. */
3650 isGV_with_GP_on(dstr);
3652 GvSTASH(dstr) = GvSTASH(sstr);
3654 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3655 gv_name_set(MUTABLE_GV(dstr), name, len,
3656 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3657 SvFAKE_on(dstr); /* can coerce to non-glob */
3660 if(GvGP(MUTABLE_GV(sstr))) {
3661 /* If source has method cache entry, clear it */
3663 SvREFCNT_dec(GvCV(sstr));
3664 GvCV_set(sstr, NULL);
3667 /* If source has a real method, then a method is
3670 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3676 /* If dest already had a real method, that's a change as well */
3678 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3679 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3684 /* We don't need to check the name of the destination if it was not a
3685 glob to begin with. */
3686 if(dtype == SVt_PVGV) {
3687 const char * const name = GvNAME((const GV *)dstr);
3690 /* The stash may have been detached from the symbol table, so
3692 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3693 && GvAV((const GV *)sstr)
3697 const STRLEN len = GvNAMELEN(dstr);
3698 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3699 || (len == 1 && name[0] == ':')) {
3702 /* Set aside the old stash, so we can reset isa caches on
3704 if((old_stash = GvHV(dstr)))
3705 /* Make sure we do not lose it early. */
3706 SvREFCNT_inc_simple_void_NN(
3707 sv_2mortal((SV *)old_stash)
3713 gp_free(MUTABLE_GV(dstr));
3714 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3715 (void)SvOK_off(dstr);
3716 isGV_with_GP_on(dstr);
3717 GvINTRO_off(dstr); /* one-shot flag */
3718 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3719 if (SvTAINTED(sstr))
3721 if (GvIMPORTED(dstr) != GVf_IMPORTED
3722 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3724 GvIMPORTED_on(dstr);
3727 if(mro_changes == 2) {
3729 SV * const sref = (SV *)GvAV((const GV *)dstr);
3730 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3731 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3732 AV * const ary = newAV();
3733 av_push(ary, mg->mg_obj); /* takes the refcount */
3734 mg->mg_obj = (SV *)ary;
3736 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3738 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3739 mro_isa_changed_in(GvSTASH(dstr));
3741 else if(mro_changes == 3) {
3742 HV * const stash = GvHV(dstr);
3743 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3749 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3754 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3756 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3758 const int intro = GvINTRO(dstr);
3761 const U32 stype = SvTYPE(sref);
3763 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3766 GvINTRO_off(dstr); /* one-shot flag */
3767 GvLINE(dstr) = CopLINE(PL_curcop);
3768 GvEGV(dstr) = MUTABLE_GV(dstr);
3773 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3774 import_flag = GVf_IMPORTED_CV;
3777 location = (SV **) &GvHV(dstr);
3778 import_flag = GVf_IMPORTED_HV;
3781 location = (SV **) &GvAV(dstr);
3782 import_flag = GVf_IMPORTED_AV;
3785 location = (SV **) &GvIOp(dstr);
3788 location = (SV **) &GvFORM(dstr);
3791 location = &GvSV(dstr);
3792 import_flag = GVf_IMPORTED_SV;
3795 if (stype == SVt_PVCV) {
3796 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3797 if (GvCVGEN(dstr)) {
3798 SvREFCNT_dec(GvCV(dstr));
3799 GvCV_set(dstr, NULL);
3800 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3803 SAVEGENERICSV(*location);
3807 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3808 CV* const cv = MUTABLE_CV(*location);
3810 if (!GvCVGEN((const GV *)dstr) &&
3811 (CvROOT(cv) || CvXSUB(cv)) &&
3812 /* redundant check that avoids creating the extra SV
3813 most of the time: */
3814 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3816 SV * const new_const_sv =
3817 CvCONST((const CV *)sref)
3818 ? cv_const_sv((const CV *)sref)
3820 report_redefined_cv(
3821 sv_2mortal(Perl_newSVpvf(aTHX_
3824 HvNAME_HEK(GvSTASH((const GV *)dstr))
3826 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3829 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3833 cv_ckproto_len_flags(cv, (const GV *)dstr,
3834 SvPOK(sref) ? CvPROTO(sref) : NULL,
3835 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3836 SvPOK(sref) ? SvUTF8(sref) : 0);
3838 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3839 GvASSUMECV_on(dstr);
3840 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3843 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3844 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3845 GvFLAGS(dstr) |= import_flag;
3847 if (stype == SVt_PVHV) {
3848 const char * const name = GvNAME((GV*)dstr);
3849 const STRLEN len = GvNAMELEN(dstr);
3852 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3853 || (len == 1 && name[0] == ':')
3855 && (!dref || HvENAME_get(dref))
3858 (HV *)sref, (HV *)dref,
3864 stype == SVt_PVAV && sref != dref
3865 && strEQ(GvNAME((GV*)dstr), "ISA")
3866 /* The stash may have been detached from the symbol table, so
3867 check its name before doing anything. */
3868 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3871 MAGIC * const omg = dref && SvSMAGICAL(dref)
3872 ? mg_find(dref, PERL_MAGIC_isa)
3874 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3875 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3876 AV * const ary = newAV();
3877 av_push(ary, mg->mg_obj); /* takes the refcount */
3878 mg->mg_obj = (SV *)ary;
3881 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3882 SV **svp = AvARRAY((AV *)omg->mg_obj);
3883 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3887 SvREFCNT_inc_simple_NN(*svp++)
3893 SvREFCNT_inc_simple_NN(omg->mg_obj)
3897 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3902 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3904 mg = mg_find(sref, PERL_MAGIC_isa);
3906 /* Since the *ISA assignment could have affected more than
3907 one stash, don't call mro_isa_changed_in directly, but let
3908 magic_clearisa do it for us, as it already has the logic for
3909 dealing with globs vs arrays of globs. */
3911 Perl_magic_clearisa(aTHX_ NULL, mg);
3916 if (SvTAINTED(sstr))
3922 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3925 register U32 sflags;
3927 register svtype stype;
3929 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3934 if (SvIS_FREED(dstr)) {
3935 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3936 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3938 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3940 sstr = &PL_sv_undef;
3941 if (SvIS_FREED(sstr)) {
3942 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3943 (void*)sstr, (void*)dstr);
3945 stype = SvTYPE(sstr);
3946 dtype = SvTYPE(dstr);
3948 (void)SvAMAGIC_off(dstr);
3951 /* need to nuke the magic */
3955 /* There's a lot of redundancy below but we're going for speed here */
3960 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3961 (void)SvOK_off(dstr);
3969 sv_upgrade(dstr, SVt_IV);
3973 sv_upgrade(dstr, SVt_PVIV);
3977 goto end_of_first_switch;
3979 (void)SvIOK_only(dstr);
3980 SvIV_set(dstr, SvIVX(sstr));
3983 /* SvTAINTED can only be true if the SV has taint magic, which in
3984 turn means that the SV type is PVMG (or greater). This is the
3985 case statement for SVt_IV, so this cannot be true (whatever gcov
3987 assert(!SvTAINTED(sstr));
3992 if (dtype < SVt_PV && dtype != SVt_IV)
3993 sv_upgrade(dstr, SVt_IV);
4001 sv_upgrade(dstr, SVt_NV);
4005 sv_upgrade(dstr, SVt_PVNV);
4009 goto end_of_first_switch;
4011 SvNV_set(dstr, SvNVX(sstr));
4012 (void)SvNOK_only(dstr);
4013 /* SvTAINTED can only be true if the SV has taint magic, which in
4014 turn means that the SV type is PVMG (or greater). This is the
4015 case statement for SVt_NV, so this cannot be true (whatever gcov
4017 assert(!SvTAINTED(sstr));
4023 #ifdef PERL_OLD_COPY_ON_WRITE
4024 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4025 if (dtype < SVt_PVIV)
4026 sv_upgrade(dstr, SVt_PVIV);
4033 sv_upgrade(dstr, SVt_PV);
4036 if (dtype < SVt_PVIV)
4037 sv_upgrade(dstr, SVt_PVIV);
4040 if (dtype < SVt_PVNV)
4041 sv_upgrade(dstr, SVt_PVNV);
4045 const char * const type = sv_reftype(sstr,0);
4047 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4049 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4054 if (dtype < SVt_REGEXP)
4055 sv_upgrade(dstr, SVt_REGEXP);
4058 /* case SVt_BIND: */
4062 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4064 if (SvTYPE(sstr) != stype)
4065 stype = SvTYPE(sstr);
4067 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4068 glob_assign_glob(dstr, sstr, dtype);
4071 if (stype == SVt_PVLV)
4072 SvUPGRADE(dstr, SVt_PVNV);
4074 SvUPGRADE(dstr, (svtype)stype);
4076 end_of_first_switch:
4078 /* dstr may have been upgraded. */
4079 dtype = SvTYPE(dstr);
4080 sflags = SvFLAGS(sstr);
4082 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4083 /* Assigning to a subroutine sets the prototype. */
4086 const char *const ptr = SvPV_const(sstr, len);
4088 SvGROW(dstr, len + 1);
4089 Copy(ptr, SvPVX(dstr), len + 1, char);
4090 SvCUR_set(dstr, len);
4092 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4093 CvAUTOLOAD_off(dstr);
4097 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4098 const char * const type = sv_reftype(dstr,0);
4100 /* diag_listed_as: Cannot copy to %s */
4101 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4103 Perl_croak(aTHX_ "Cannot copy to %s", type);
4104 } else if (sflags & SVf_ROK) {
4105 if (isGV_with_GP(dstr)
4106 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4109 if (GvIMPORTED(dstr) != GVf_IMPORTED
4110 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4112 GvIMPORTED_on(dstr);
4117 glob_assign_glob(dstr, sstr, dtype);
4121 if (dtype >= SVt_PV) {
4122 if (isGV_with_GP(dstr)) {
4123 glob_assign_ref(dstr, sstr);
4126 if (SvPVX_const(dstr)) {
4132 (void)SvOK_off(dstr);
4133 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4134 SvFLAGS(dstr) |= sflags & SVf_ROK;
4135 assert(!(sflags & SVp_NOK));
4136 assert(!(sflags & SVp_IOK));
4137 assert(!(sflags & SVf_NOK));
4138 assert(!(sflags & SVf_IOK));
4140 else if (isGV_with_GP(dstr)) {
4141 if (!(sflags & SVf_OK)) {
4142 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4143 "Undefined value assigned to typeglob");
4146 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4147 if (dstr != (const SV *)gv) {
4148 const char * const name = GvNAME((const GV *)dstr);
4149 const STRLEN len = GvNAMELEN(dstr);
4150 HV *old_stash = NULL;
4151 bool reset_isa = FALSE;
4152 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4153 || (len == 1 && name[0] == ':')) {
4154 /* Set aside the old stash, so we can reset isa caches
4155 on its subclasses. */
4156 if((old_stash = GvHV(dstr))) {
4157 /* Make sure we do not lose it early. */
4158 SvREFCNT_inc_simple_void_NN(
4159 sv_2mortal((SV *)old_stash)
4166 gp_free(MUTABLE_GV(dstr));
4167 GvGP_set(dstr, gp_ref(GvGP(gv)));
4170 HV * const stash = GvHV(dstr);
4172 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4182 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4183 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4185 else if (sflags & SVp_POK) {
4189 * Check to see if we can just swipe the string. If so, it's a
4190 * possible small lose on short strings, but a big win on long ones.
4191 * It might even be a win on short strings if SvPVX_const(dstr)
4192 * has to be allocated and SvPVX_const(sstr) has to be freed.
4193 * Likewise if we can set up COW rather than doing an actual copy, we
4194 * drop to the else clause, as the swipe code and the COW setup code
4195 * have much in common.
4198 /* Whichever path we take through the next code, we want this true,
4199 and doing it now facilitates the COW check. */
4200 (void)SvPOK_only(dstr);
4203 /* If we're already COW then this clause is not true, and if COW
4204 is allowed then we drop down to the else and make dest COW
4205 with us. If caller hasn't said that we're allowed to COW
4206 shared hash keys then we don't do the COW setup, even if the
4207 source scalar is a shared hash key scalar. */
4208 (((flags & SV_COW_SHARED_HASH_KEYS)
4209 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4210 : 1 /* If making a COW copy is forbidden then the behaviour we
4211 desire is as if the source SV isn't actually already
4212 COW, even if it is. So we act as if the source flags
4213 are not COW, rather than actually testing them. */
4215 #ifndef PERL_OLD_COPY_ON_WRITE
4216 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4217 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4218 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4219 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4220 but in turn, it's somewhat dead code, never expected to go
4221 live, but more kept as a placeholder on how to do it better
4222 in a newer implementation. */
4223 /* If we are COW and dstr is a suitable target then we drop down
4224 into the else and make dest a COW of us. */
4225 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4230 (sflags & SVs_TEMP) && /* slated for free anyway? */
4231 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4232 (!(flags & SV_NOSTEAL)) &&
4233 /* and we're allowed to steal temps */
4234 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4235 SvLEN(sstr)) /* and really is a string */
4236 #ifdef PERL_OLD_COPY_ON_WRITE
4237 && ((flags & SV_COW_SHARED_HASH_KEYS)
4238 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4239 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4240 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4244 /* Failed the swipe test, and it's not a shared hash key either.
4245 Have to copy the string. */
4246 STRLEN len = SvCUR(sstr);
4247 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4248 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4249 SvCUR_set(dstr, len);
4250 *SvEND(dstr) = '\0';
4252 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4254 /* Either it's a shared hash key, or it's suitable for
4255 copy-on-write or we can swipe the string. */
4257 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4261 #ifdef PERL_OLD_COPY_ON_WRITE
4263 if ((sflags & (SVf_FAKE | SVf_READONLY))
4264 != (SVf_FAKE | SVf_READONLY)) {
4265 SvREADONLY_on(sstr);
4267 /* Make the source SV into a loop of 1.
4268 (about to become 2) */
4269 SV_COW_NEXT_SV_SET(sstr, sstr);
4273 /* Initial code is common. */
4274 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4279 /* making another shared SV. */
4280 STRLEN cur = SvCUR(sstr);
4281 STRLEN len = SvLEN(sstr);
4282 #ifdef PERL_OLD_COPY_ON_WRITE
4284 assert (SvTYPE(dstr) >= SVt_PVIV);
4285 /* SvIsCOW_normal */
4286 /* splice us in between source and next-after-source. */
4287 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4288 SV_COW_NEXT_SV_SET(sstr, dstr);
4289 SvPV_set(dstr, SvPVX_mutable(sstr));
4293 /* SvIsCOW_shared_hash */
4294 DEBUG_C(PerlIO_printf(Perl_debug_log,
4295 "Copy on write: Sharing hash\n"));
4297 assert (SvTYPE(dstr) >= SVt_PV);
4299 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4301 SvLEN_set(dstr, len);
4302 SvCUR_set(dstr, cur);
4303 SvREADONLY_on(dstr);
4307 { /* Passes the swipe test. */
4308 SvPV_set(dstr, SvPVX_mutable(sstr));
4309 SvLEN_set(dstr, SvLEN(sstr));
4310 SvCUR_set(dstr, SvCUR(sstr));
4313 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4314 SvPV_set(sstr, NULL);
4320 if (sflags & SVp_NOK) {
4321 SvNV_set(dstr, SvNVX(sstr));
4323 if (sflags & SVp_IOK) {
4324 SvIV_set(dstr, SvIVX(sstr));
4325 /* Must do this otherwise some other overloaded use of 0x80000000
4326 gets confused. I guess SVpbm_VALID */
4327 if (sflags & SVf_IVisUV)
4330 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4332 const MAGIC * const smg = SvVSTRING_mg(sstr);
4334 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4335 smg->mg_ptr, smg->mg_len);
4336 SvRMAGICAL_on(dstr);
4340 else if (sflags & (SVp_IOK|SVp_NOK)) {
4341 (void)SvOK_off(dstr);
4342 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4343 if (sflags & SVp_IOK) {
4344 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4345 SvIV_set(dstr, SvIVX(sstr));
4347 if (sflags & SVp_NOK) {
4348 SvNV_set(dstr, SvNVX(sstr));
4352 if (isGV_with_GP(sstr)) {
4353 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4356 (void)SvOK_off(dstr);
4358 if (SvTAINTED(sstr))
4363 =for apidoc sv_setsv_mg
4365 Like C<sv_setsv>, but also handles 'set' magic.
4371 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4373 PERL_ARGS_ASSERT_SV_SETSV_MG;
4375 sv_setsv(dstr,sstr);
4379 #ifdef PERL_OLD_COPY_ON_WRITE
4381 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4383 STRLEN cur = SvCUR(sstr);
4384 STRLEN len = SvLEN(sstr);
4385 register char *new_pv;
4387 PERL_ARGS_ASSERT_SV_SETSV_COW;
4390 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4391 (void*)sstr, (void*)dstr);
4398 if (SvTHINKFIRST(dstr))
4399 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4400 else if (SvPVX_const(dstr))
4401 Safefree(SvPVX_const(dstr));
4405 SvUPGRADE(dstr, SVt_PVIV);
4407 assert (SvPOK(sstr));
4408 assert (SvPOKp(sstr));
4409 assert (!SvIOK(sstr));
4410 assert (!SvIOKp(sstr));
4411 assert (!SvNOK(sstr));
4412 assert (!SvNOKp(sstr));
4414 if (SvIsCOW(sstr)) {
4416 if (SvLEN(sstr) == 0) {
4417 /* source is a COW shared hash key. */
4418 DEBUG_C(PerlIO_printf(Perl_debug_log,
4419 "Fast copy on write: Sharing hash\n"));
4420 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4423 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4425 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4426 SvUPGRADE(sstr, SVt_PVIV);
4427 SvREADONLY_on(sstr);
4429 DEBUG_C(PerlIO_printf(Perl_debug_log,
4430 "Fast copy on write: Converting sstr to COW\n"));
4431 SV_COW_NEXT_SV_SET(dstr, sstr);
4433 SV_COW_NEXT_SV_SET(sstr, dstr);
4434 new_pv = SvPVX_mutable(sstr);
4437 SvPV_set(dstr, new_pv);
4438 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4441 SvLEN_set(dstr, len);
4442 SvCUR_set(dstr, cur);
4451 =for apidoc sv_setpvn
4453 Copies a string into an SV. The C<len> parameter indicates the number of
4454 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4455 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4461 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4464 register char *dptr;
4466 PERL_ARGS_ASSERT_SV_SETPVN;
4468 SV_CHECK_THINKFIRST_COW_DROP(sv);
4474 /* len is STRLEN which is unsigned, need to copy to signed */
4477 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4479 SvUPGRADE(sv, SVt_PV);
4481 dptr = SvGROW(sv, len + 1);
4482 Move(ptr,dptr,len,char);
4485 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4487 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4491 =for apidoc sv_setpvn_mg
4493 Like C<sv_setpvn>, but also handles 'set' magic.
4499 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4501 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4503 sv_setpvn(sv,ptr,len);
4508 =for apidoc sv_setpv
4510 Copies a string into an SV. The string must be null-terminated. Does not
4511 handle 'set' magic. See C<sv_setpv_mg>.
4517 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4520 register STRLEN len;
4522 PERL_ARGS_ASSERT_SV_SETPV;
4524 SV_CHECK_THINKFIRST_COW_DROP(sv);
4530 SvUPGRADE(sv, SVt_PV);
4532 SvGROW(sv, len + 1);
4533 Move(ptr,SvPVX(sv),len+1,char);
4535 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4537 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4541 =for apidoc sv_setpv_mg
4543 Like C<sv_setpv>, but also handles 'set' magic.
4549 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4551 PERL_ARGS_ASSERT_SV_SETPV_MG;
4558 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4562 PERL_ARGS_ASSERT_SV_SETHEK;
4568 if (HEK_LEN(hek) == HEf_SVKEY) {
4569 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4572 const int flags = HEK_FLAGS(hek);
4573 if (flags & HVhek_WASUTF8) {
4574 STRLEN utf8_len = HEK_LEN(hek);
4575 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4576 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4579 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4580 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4583 else SvUTF8_off(sv);
4587 SV_CHECK_THINKFIRST_COW_DROP(sv);
4588 SvUPGRADE(sv, SVt_PV);
4589 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4590 SvCUR_set(sv, HEK_LEN(hek));
4597 else SvUTF8_off(sv);
4605 =for apidoc sv_usepvn_flags
4607 Tells an SV to use C<ptr> to find its string value. Normally the
4608 string is stored inside the SV but sv_usepvn allows the SV to use an
4609 outside string. The C<ptr> should point to memory that was allocated
4610 by C<malloc>. It must be the start of a mallocked block
4611 of memory, and not a pointer to the middle of it. The
4612 string length, C<len>, must be supplied. By default
4613 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4614 so that pointer should not be freed or used by the programmer after
4615 giving it to sv_usepvn, and neither should any pointers from "behind"
4616 that pointer (e.g. ptr + 1) be used.
4618 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4619 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4620 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4621 C<len>, and already meets the requirements for storing in C<SvPVX>).
4627 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4632 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4634 SV_CHECK_THINKFIRST_COW_DROP(sv);
4635 SvUPGRADE(sv, SVt_PV);
4638 if (flags & SV_SMAGIC)
4642 if (SvPVX_const(sv))
4646 if (flags & SV_HAS_TRAILING_NUL)
4647 assert(ptr[len] == '\0');
4650 allocate = (flags & SV_HAS_TRAILING_NUL)
4652 #ifdef Perl_safesysmalloc_size
4655 PERL_STRLEN_ROUNDUP(len + 1);
4657 if (flags & SV_HAS_TRAILING_NUL) {
4658 /* It's long enough - do nothing.
4659 Specifically Perl_newCONSTSUB is relying on this. */
4662 /* Force a move to shake out bugs in callers. */
4663 char *new_ptr = (char*)safemalloc(allocate);
4664 Copy(ptr, new_ptr, len, char);
4665 PoisonFree(ptr,len,char);
4669 ptr = (char*) saferealloc (ptr, allocate);
4672 #ifdef Perl_safesysmalloc_size
4673 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4675 SvLEN_set(sv, allocate);
4679 if (!(flags & SV_HAS_TRAILING_NUL)) {
4682 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4684 if (flags & SV_SMAGIC)
4688 #ifdef PERL_OLD_COPY_ON_WRITE
4689 /* Need to do this *after* making the SV normal, as we need the buffer
4690 pointer to remain valid until after we've copied it. If we let go too early,
4691 another thread could invalidate it by unsharing last of the same hash key
4692 (which it can do by means other than releasing copy-on-write Svs)
4693 or by changing the other copy-on-write SVs in the loop. */
4695 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4697 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4699 { /* this SV was SvIsCOW_normal(sv) */
4700 /* we need to find the SV pointing to us. */
4701 SV *current = SV_COW_NEXT_SV(after);
4703 if (current == sv) {
4704 /* The SV we point to points back to us (there were only two of us
4706 Hence other SV is no longer copy on write either. */
4708 SvREADONLY_off(after);
4710 /* We need to follow the pointers around the loop. */
4712 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4715 /* don't loop forever if the structure is bust, and we have
4716 a pointer into a closed loop. */
4717 assert (current != after);
4718 assert (SvPVX_const(current) == pvx);
4720 /* Make the SV before us point to the SV after us. */
4721 SV_COW_NEXT_SV_SET(current, after);
4727 =for apidoc sv_force_normal_flags
4729 Undo various types of fakery on an SV: if the PV is a shared string, make
4730 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4731 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4732 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4733 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4734 SvPOK_off rather than making a copy. (Used where this
4735 scalar is about to be set to some other value.) In addition,
4736 the C<flags> parameter gets passed to C<sv_unref_flags()>
4737 when unreffing. C<sv_force_normal> calls this function
4738 with flags set to 0.
4744 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4748 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4750 #ifdef PERL_OLD_COPY_ON_WRITE
4751 if (SvREADONLY(sv)) {
4753 const char * const pvx = SvPVX_const(sv);
4754 const STRLEN len = SvLEN(sv);
4755 const STRLEN cur = SvCUR(sv);
4756 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4757 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4758 we'll fail an assertion. */
4759 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4762 PerlIO_printf(Perl_debug_log,
4763 "Copy on write: Force normal %ld\n",
4769 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4772 if (flags & SV_COW_DROP_PV) {
4773 /* OK, so we don't need to copy our buffer. */
4776 SvGROW(sv, cur + 1);
4777 Move(pvx,SvPVX(sv),cur,char);
4782 sv_release_COW(sv, pvx, next);
4784 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4790 else if (IN_PERL_RUNTIME)
4791 Perl_croak_no_modify(aTHX);
4794 if (SvREADONLY(sv)) {
4795 if (SvFAKE(sv) && !isGV_with_GP(sv)) {
4796 const char * const pvx = SvPVX_const(sv);
4797 const STRLEN len = SvCUR(sv);
4802 if (flags & SV_COW_DROP_PV) {
4803 /* OK, so we don't need to copy our buffer. */
4806 SvGROW(sv, len + 1);
4807 Move(pvx,SvPVX(sv),len,char);
4810 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4812 else if (IN_PERL_RUNTIME)
4813 Perl_croak_no_modify(aTHX);
4817 sv_unref_flags(sv, flags);
4818 else if (SvFAKE(sv) && isGV_with_GP(sv))
4819 sv_unglob(sv, flags);
4820 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4821 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4822 to sv_unglob. We only need it here, so inline it. */
4823 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4824 SV *const temp = newSV_type(new_type);
4825 void *const temp_p = SvANY(sv);
4827 if (new_type == SVt_PVMG) {
4828 SvMAGIC_set(temp, SvMAGIC(sv));
4829 SvMAGIC_set(sv, NULL);
4830 SvSTASH_set(temp, SvSTASH(sv));
4831 SvSTASH_set(sv, NULL);
4833 SvCUR_set(temp, SvCUR(sv));
4834 /* Remember that SvPVX is in the head, not the body. */
4836 SvLEN_set(temp, SvLEN(sv));
4837 /* This signals "buffer is owned by someone else" in sv_clear,
4838 which is the least effort way to stop it freeing the buffer.
4840 SvLEN_set(sv, SvLEN(sv)+1);
4842 /* Their buffer is already owned by someone else. */
4843 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4844 SvLEN_set(temp, SvCUR(sv)+1);
4847 /* Now swap the rest of the bodies. */
4849 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4850 SvFLAGS(sv) |= new_type;
4851 SvANY(sv) = SvANY(temp);
4853 SvFLAGS(temp) &= ~(SVTYPEMASK);
4854 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4855 SvANY(temp) = temp_p;
4864 Efficient removal of characters from the beginning of the string buffer.
4865 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4866 the string buffer. The C<ptr> becomes the first character of the adjusted
4867 string. Uses the "OOK hack".
4869 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4870 refer to the same chunk of data.
4872 The unfortunate similarity of this function's name to that of Perl's C<chop>
4873 operator is strictly coincidental. This function works from the left;
4874 C<chop> works from the right.
4880 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4891 PERL_ARGS_ASSERT_SV_CHOP;
4893 if (!ptr || !SvPOKp(sv))
4895 delta = ptr - SvPVX_const(sv);
4897 /* Nothing to do. */
4900 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4901 if (delta > max_delta)
4902 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4903 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4904 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4905 SV_CHECK_THINKFIRST(sv);
4908 if (!SvLEN(sv)) { /* make copy of shared string */
4909 const char *pvx = SvPVX_const(sv);
4910 const STRLEN len = SvCUR(sv);
4911 SvGROW(sv, len + 1);
4912 Move(pvx,SvPVX(sv),len,char);
4918 SvOOK_offset(sv, old_delta);
4920 SvLEN_set(sv, SvLEN(sv) - delta);
4921 SvCUR_set(sv, SvCUR(sv) - delta);
4922 SvPV_set(sv, SvPVX(sv) + delta);
4924 p = (U8 *)SvPVX_const(sv);
4927 /* how many bytes were evacuated? we will fill them with sentinel
4928 bytes, except for the part holding the new offset of course. */
4931 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4933 assert(evacn <= delta + old_delta);
4939 if (delta < 0x100) {
4943 p -= sizeof(STRLEN);
4944 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4948 /* Fill the preceding buffer with sentinals to verify that no-one is
4958 =for apidoc sv_catpvn
4960 Concatenates the string onto the end of the string which is in the SV. The
4961 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4962 status set, then the bytes appended should be valid UTF-8.
4963 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4965 =for apidoc sv_catpvn_flags
4967 Concatenates the string onto the end of the string which is in the SV. The
4968 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4969 status set, then the bytes appended should be valid UTF-8.
4970 If C<flags> has the C<SV_SMAGIC> bit set, will
4971 C<mg_set> on C<dsv> afterwards if appropriate.
4972 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4973 in terms of this function.
4979 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4983 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4985 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4986 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
4988 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
4989 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
4990 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
4993 else SvGROW(dsv, dlen + slen + 1);
4995 sstr = SvPVX_const(dsv);
4996 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4997 SvCUR_set(dsv, SvCUR(dsv) + slen);
5000 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5001 const char * const send = sstr + slen;
5004 /* Something this code does not account for, which I think is
5005 impossible; it would require the same pv to be treated as
5006 bytes *and* utf8, which would indicate a bug elsewhere. */
5007 assert(sstr != dstr);
5009 SvGROW(dsv, dlen + slen * 2 + 1);
5010 d = (U8 *)SvPVX(dsv) + dlen;
5012 while (sstr < send) {
5013 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5014 if (UNI_IS_INVARIANT(uv))
5015 *d++ = (U8)UTF_TO_NATIVE(uv);
5017 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5018 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5021 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5024 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5026 if (flags & SV_SMAGIC)
5031 =for apidoc sv_catsv
5033 Concatenates the string from SV C<ssv> onto the end of the string in
5034 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5035 not 'set' magic. See C<sv_catsv_mg>.
5037 =for apidoc sv_catsv_flags
5039 Concatenates the string from SV C<ssv> onto the end of the string in
5040 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5041 bit set, will C<mg_get> on the C<ssv>, if appropriate, before
5042 reading it. If the C<flags> contain C<SV_SMAGIC>, C<mg_set> will be
5043 called on the modified SV afterward, if appropriate. C<sv_catsv>
5044 and C<sv_catsv_nomg> are implemented in terms of this function.
5049 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5053 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5057 const char *spv = SvPV_flags_const(ssv, slen, flags);
5059 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5061 sv_catpvn_flags(dsv, spv, slen,
5062 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5065 if (flags & SV_SMAGIC)
5070 =for apidoc sv_catpv
5072 Concatenates the string onto the end of the string which is in the SV.
5073 If the SV has the UTF-8 status set, then the bytes appended should be
5074 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5079 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5082 register STRLEN len;
5086 PERL_ARGS_ASSERT_SV_CATPV;
5090 junk = SvPV_force(sv, tlen);
5092 SvGROW(sv, tlen + len + 1);
5094 ptr = SvPVX_const(sv);
5095 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5096 SvCUR_set(sv, SvCUR(sv) + len);
5097 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5102 =for apidoc sv_catpv_flags
5104 Concatenates the string onto the end of the string which is in the SV.
5105 If the SV has the UTF-8 status set, then the bytes appended should
5106 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5107 on the modified SV if appropriate.
5113 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5115 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5116 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5120 =for apidoc sv_catpv_mg
5122 Like C<sv_catpv>, but also handles 'set' magic.
5128 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5130 PERL_ARGS_ASSERT_SV_CATPV_MG;
5139 Creates a new SV. A non-zero C<len> parameter indicates the number of
5140 bytes of preallocated string space the SV should have. An extra byte for a
5141 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5142 space is allocated.) The reference count for the new SV is set to 1.
5144 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5145 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5146 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5147 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5148 modules supporting older perls.
5154 Perl_newSV(pTHX_ const STRLEN len)
5161 sv_upgrade(sv, SVt_PV);
5162 SvGROW(sv, len + 1);
5167 =for apidoc sv_magicext
5169 Adds magic to an SV, upgrading it if necessary. Applies the
5170 supplied vtable and returns a pointer to the magic added.
5172 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5173 In particular, you can add magic to SvREADONLY SVs, and add more than
5174 one instance of the same 'how'.
5176 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5177 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5178 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5179 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5181 (This is now used as a subroutine by C<sv_magic>.)
5186 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5187 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5192 PERL_ARGS_ASSERT_SV_MAGICEXT;
5194 SvUPGRADE(sv, SVt_PVMG);
5195 Newxz(mg, 1, MAGIC);
5196 mg->mg_moremagic = SvMAGIC(sv);
5197 SvMAGIC_set(sv, mg);
5199 /* Sometimes a magic contains a reference loop, where the sv and
5200 object refer to each other. To prevent a reference loop that
5201 would prevent such objects being freed, we look for such loops
5202 and if we find one we avoid incrementing the object refcount.
5204 Note we cannot do this to avoid self-tie loops as intervening RV must
5205 have its REFCNT incremented to keep it in existence.
5208 if (!obj || obj == sv ||
5209 how == PERL_MAGIC_arylen ||
5210 how == PERL_MAGIC_symtab ||
5211 (SvTYPE(obj) == SVt_PVGV &&
5212 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5213 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5214 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5219 mg->mg_obj = SvREFCNT_inc_simple(obj);
5220 mg->mg_flags |= MGf_REFCOUNTED;
5223 /* Normal self-ties simply pass a null object, and instead of
5224 using mg_obj directly, use the SvTIED_obj macro to produce a
5225 new RV as needed. For glob "self-ties", we are tieing the PVIO
5226 with an RV obj pointing to the glob containing the PVIO. In
5227 this case, to avoid a reference loop, we need to weaken the
5231 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5232 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5238 mg->mg_len = namlen;
5241 mg->mg_ptr = savepvn(name, namlen);
5242 else if (namlen == HEf_SVKEY) {
5243 /* Yes, this is casting away const. This is only for the case of
5244 HEf_SVKEY. I think we need to document this aberation of the
5245 constness of the API, rather than making name non-const, as
5246 that change propagating outwards a long way. */
5247 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5249 mg->mg_ptr = (char *) name;
5251 mg->mg_virtual = (MGVTBL *) vtable;
5255 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5260 =for apidoc sv_magic
5262 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5263 necessary, then adds a new magic item of type C<how> to the head of the
5266 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5267 handling of the C<name> and C<namlen> arguments.
5269 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5270 to add more than one instance of the same 'how'.
5276 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5277 const char *const name, const I32 namlen)
5280 const MGVTBL *vtable;
5283 unsigned int vtable_index;
5285 PERL_ARGS_ASSERT_SV_MAGIC;
5287 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5288 || ((flags = PL_magic_data[how]),
5289 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5290 > magic_vtable_max))
5291 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5293 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5294 Useful for attaching extension internal data to perl vars.
5295 Note that multiple extensions may clash if magical scalars
5296 etc holding private data from one are passed to another. */
5298 vtable = (vtable_index == magic_vtable_max)
5299 ? NULL : PL_magic_vtables + vtable_index;
5301 #ifdef PERL_OLD_COPY_ON_WRITE
5303 sv_force_normal_flags(sv, 0);
5305 if (SvREADONLY(sv)) {
5307 /* its okay to attach magic to shared strings */
5308 (!SvFAKE(sv) || isGV_with_GP(sv))
5311 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5314 Perl_croak_no_modify(aTHX);
5317 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5318 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5319 /* sv_magic() refuses to add a magic of the same 'how' as an
5322 if (how == PERL_MAGIC_taint) {
5324 /* Any scalar which already had taint magic on which someone
5325 (erroneously?) did SvIOK_on() or similar will now be
5326 incorrectly sporting public "OK" flags. */
5327 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5333 /* Rest of work is done else where */
5334 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5337 case PERL_MAGIC_taint:
5340 case PERL_MAGIC_ext:
5341 case PERL_MAGIC_dbfile:
5348 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5355 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5357 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5358 for (mg = *mgp; mg; mg = *mgp) {
5359 const MGVTBL* const virt = mg->mg_virtual;
5360 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5361 *mgp = mg->mg_moremagic;
5362 if (virt && virt->svt_free)
5363 virt->svt_free(aTHX_ sv, mg);
5364 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5366 Safefree(mg->mg_ptr);
5367 else if (mg->mg_len == HEf_SVKEY)
5368 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5369 else if (mg->mg_type == PERL_MAGIC_utf8)
5370 Safefree(mg->mg_ptr);
5372 if (mg->mg_flags & MGf_REFCOUNTED)
5373 SvREFCNT_dec(mg->mg_obj);
5377 mgp = &mg->mg_moremagic;
5380 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5381 mg_magical(sv); /* else fix the flags now */
5385 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5391 =for apidoc sv_unmagic
5393 Removes all magic of type C<type> from an SV.
5399 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5401 PERL_ARGS_ASSERT_SV_UNMAGIC;
5402 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5406 =for apidoc sv_unmagicext
5408 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5414 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5416 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5417 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5421 =for apidoc sv_rvweaken
5423 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5424 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5425 push a back-reference to this RV onto the array of backreferences
5426 associated with that magic. If the RV is magical, set magic will be
5427 called after the RV is cleared.
5433 Perl_sv_rvweaken(pTHX_ SV *const sv)
5437 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5439 if (!SvOK(sv)) /* let undefs pass */
5442 Perl_croak(aTHX_ "Can't weaken a nonreference");
5443 else if (SvWEAKREF(sv)) {
5444 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5447 else if (SvREADONLY(sv)) croak_no_modify();
5449 Perl_sv_add_backref(aTHX_ tsv, sv);
5455 /* Give tsv backref magic if it hasn't already got it, then push a
5456 * back-reference to sv onto the array associated with the backref magic.
5458 * As an optimisation, if there's only one backref and it's not an AV,
5459 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5460 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5464 /* A discussion about the backreferences array and its refcount:
5466 * The AV holding the backreferences is pointed to either as the mg_obj of
5467 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5468 * xhv_backreferences field. The array is created with a refcount
5469 * of 2. This means that if during global destruction the array gets
5470 * picked on before its parent to have its refcount decremented by the
5471 * random zapper, it won't actually be freed, meaning it's still there for
5472 * when its parent gets freed.
5474 * When the parent SV is freed, the extra ref is killed by
5475 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5476 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5478 * When a single backref SV is stored directly, it is not reference
5483 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5490 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5492 /* find slot to store array or singleton backref */
5494 if (SvTYPE(tsv) == SVt_PVHV) {
5495 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5498 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5500 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5501 mg = mg_find(tsv, PERL_MAGIC_backref);
5503 svp = &(mg->mg_obj);
5506 /* create or retrieve the array */
5508 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5509 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5514 SvREFCNT_inc_simple_void(av);
5515 /* av now has a refcnt of 2; see discussion above */
5517 /* move single existing backref to the array */
5519 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5523 mg->mg_flags |= MGf_REFCOUNTED;
5526 av = MUTABLE_AV(*svp);
5529 /* optimisation: store single backref directly in HvAUX or mg_obj */
5533 /* push new backref */
5534 assert(SvTYPE(av) == SVt_PVAV);
5535 if (AvFILLp(av) >= AvMAX(av)) {
5536 av_extend(av, AvFILLp(av)+1);
5538 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5541 /* delete a back-reference to ourselves from the backref magic associated
5542 * with the SV we point to.
5546 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5551 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5553 if (SvTYPE(tsv) == SVt_PVHV) {
5555 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5559 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5560 svp = mg ? &(mg->mg_obj) : NULL;
5564 Perl_croak(aTHX_ "panic: del_backref");
5566 if (SvTYPE(*svp) == SVt_PVAV) {
5570 AV * const av = (AV*)*svp;
5572 assert(!SvIS_FREED(av));
5576 /* for an SV with N weak references to it, if all those
5577 * weak refs are deleted, then sv_del_backref will be called
5578 * N times and O(N^2) compares will be done within the backref
5579 * array. To ameliorate this potential slowness, we:
5580 * 1) make sure this code is as tight as possible;
5581 * 2) when looking for SV, look for it at both the head and tail of the
5582 * array first before searching the rest, since some create/destroy
5583 * patterns will cause the backrefs to be freed in order.
5590 SV **p = &svp[fill];
5591 SV *const topsv = *p;
5598 /* We weren't the last entry.
5599 An unordered list has this property that you
5600 can take the last element off the end to fill
5601 the hole, and it's still an unordered list :-)
5607 break; /* should only be one */
5614 AvFILLp(av) = fill-1;
5617 /* optimisation: only a single backref, stored directly */
5619 Perl_croak(aTHX_ "panic: del_backref");
5626 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5632 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5637 /* after multiple passes through Perl_sv_clean_all() for a thinngy
5638 * that has badly leaked, the backref array may have gotten freed,
5639 * since we only protect it against 1 round of cleanup */
5640 if (SvIS_FREED(av)) {
5641 if (PL_in_clean_all) /* All is fair */
5644 "panic: magic_killbackrefs (freed backref AV/SV)");
5648 is_array = (SvTYPE(av) == SVt_PVAV);
5650 assert(!SvIS_FREED(av));
5653 last = svp + AvFILLp(av);
5656 /* optimisation: only a single backref, stored directly */
5662 while (svp <= last) {
5664 SV *const referrer = *svp;
5665 if (SvWEAKREF(referrer)) {
5666 /* XXX Should we check that it hasn't changed? */
5667 assert(SvROK(referrer));
5668 SvRV_set(referrer, 0);
5670 SvWEAKREF_off(referrer);
5671 SvSETMAGIC(referrer);
5672 } else if (SvTYPE(referrer) == SVt_PVGV ||
5673 SvTYPE(referrer) == SVt_PVLV) {
5674 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5675 /* You lookin' at me? */
5676 assert(GvSTASH(referrer));
5677 assert(GvSTASH(referrer) == (const HV *)sv);
5678 GvSTASH(referrer) = 0;
5679 } else if (SvTYPE(referrer) == SVt_PVCV ||
5680 SvTYPE(referrer) == SVt_PVFM) {
5681 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5682 /* You lookin' at me? */
5683 assert(CvSTASH(referrer));
5684 assert(CvSTASH(referrer) == (const HV *)sv);
5685 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5688 assert(SvTYPE(sv) == SVt_PVGV);
5689 /* You lookin' at me? */
5690 assert(CvGV(referrer));
5691 assert(CvGV(referrer) == (const GV *)sv);
5692 anonymise_cv_maybe(MUTABLE_GV(sv),
5693 MUTABLE_CV(referrer));
5698 "panic: magic_killbackrefs (flags=%"UVxf")",
5699 (UV)SvFLAGS(referrer));
5710 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5716 =for apidoc sv_insert
5718 Inserts a string at the specified offset/length within the SV. Similar to
5719 the Perl substr() function. Handles get magic.
5721 =for apidoc sv_insert_flags
5723 Same as C<sv_insert>, but the extra C<flags> are passed to the
5724 C<SvPV_force_flags> that applies to C<bigstr>.
5730 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5735 register char *midend;
5736 register char *bigend;
5737 register SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5740 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5743 Perl_croak(aTHX_ "Can't modify non-existent substring");
5744 SvPV_force_flags(bigstr, curlen, flags);
5745 (void)SvPOK_only_UTF8(bigstr);
5746 if (offset + len > curlen) {
5747 SvGROW(bigstr, offset+len+1);
5748 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5749 SvCUR_set(bigstr, offset+len);
5753 i = littlelen - len;
5754 if (i > 0) { /* string might grow */
5755 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5756 mid = big + offset + len;
5757 midend = bigend = big + SvCUR(bigstr);
5760 while (midend > mid) /* shove everything down */
5761 *--bigend = *--midend;
5762 Move(little,big+offset,littlelen,char);
5763 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5768 Move(little,SvPVX(bigstr)+offset,len,char);
5773 big = SvPVX(bigstr);
5776 bigend = big + SvCUR(bigstr);
5778 if (midend > bigend)
5779 Perl_croak(aTHX_ "panic: sv_insert");
5781 if (mid - big > bigend - midend) { /* faster to shorten from end */
5783 Move(little, mid, littlelen,char);
5786 i = bigend - midend;
5788 Move(midend, mid, i,char);
5792 SvCUR_set(bigstr, mid - big);
5794 else if ((i = mid - big)) { /* faster from front */
5795 midend -= littlelen;
5797 Move(big, midend - i, i, char);
5798 sv_chop(bigstr,midend-i);
5800 Move(little, mid, littlelen,char);
5802 else if (littlelen) {
5803 midend -= littlelen;
5804 sv_chop(bigstr,midend);
5805 Move(little,midend,littlelen,char);
5808 sv_chop(bigstr,midend);
5814 =for apidoc sv_replace
5816 Make the first argument a copy of the second, then delete the original.
5817 The target SV physically takes over ownership of the body of the source SV
5818 and inherits its flags; however, the target keeps any magic it owns,
5819 and any magic in the source is discarded.
5820 Note that this is a rather specialist SV copying operation; most of the
5821 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5827 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5830 const U32 refcnt = SvREFCNT(sv);
5832 PERL_ARGS_ASSERT_SV_REPLACE;
5834 SV_CHECK_THINKFIRST_COW_DROP(sv);
5835 if (SvREFCNT(nsv) != 1) {
5836 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5837 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5839 if (SvMAGICAL(sv)) {
5843 sv_upgrade(nsv, SVt_PVMG);
5844 SvMAGIC_set(nsv, SvMAGIC(sv));
5845 SvFLAGS(nsv) |= SvMAGICAL(sv);
5847 SvMAGIC_set(sv, NULL);
5851 assert(!SvREFCNT(sv));
5852 #ifdef DEBUG_LEAKING_SCALARS
5853 sv->sv_flags = nsv->sv_flags;
5854 sv->sv_any = nsv->sv_any;
5855 sv->sv_refcnt = nsv->sv_refcnt;
5856 sv->sv_u = nsv->sv_u;
5858 StructCopy(nsv,sv,SV);
5860 if(SvTYPE(sv) == SVt_IV) {
5862 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5866 #ifdef PERL_OLD_COPY_ON_WRITE
5867 if (SvIsCOW_normal(nsv)) {
5868 /* We need to follow the pointers around the loop to make the
5869 previous SV point to sv, rather than nsv. */
5872 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5875 assert(SvPVX_const(current) == SvPVX_const(nsv));
5877 /* Make the SV before us point to the SV after us. */
5879 PerlIO_printf(Perl_debug_log, "previous is\n");
5881 PerlIO_printf(Perl_debug_log,
5882 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5883 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5885 SV_COW_NEXT_SV_SET(current, sv);
5888 SvREFCNT(sv) = refcnt;
5889 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5894 /* We're about to free a GV which has a CV that refers back to us.
5895 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5899 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5904 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5907 assert(SvREFCNT(gv) == 0);
5908 assert(isGV(gv) && isGV_with_GP(gv));
5910 assert(!CvANON(cv));
5911 assert(CvGV(cv) == gv);
5913 /* will the CV shortly be freed by gp_free() ? */
5914 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5915 SvANY(cv)->xcv_gv = NULL;
5919 /* if not, anonymise: */
5920 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5921 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5922 : newSVpvn_flags( "__ANON__", 8, 0 );
5923 sv_catpvs(gvname, "::__ANON__");
5924 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5925 SvREFCNT_dec(gvname);
5929 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5934 =for apidoc sv_clear
5936 Clear an SV: call any destructors, free up any memory used by the body,
5937 and free the body itself. The SV's head is I<not> freed, although
5938 its type is set to all 1's so that it won't inadvertently be assumed
5939 to be live during global destruction etc.
5940 This function should only be called when REFCNT is zero. Most of the time
5941 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5948 Perl_sv_clear(pTHX_ SV *const orig_sv)
5953 const struct body_details *sv_type_details;
5956 register SV *sv = orig_sv;
5959 PERL_ARGS_ASSERT_SV_CLEAR;
5961 /* within this loop, sv is the SV currently being freed, and
5962 * iter_sv is the most recent AV or whatever that's being iterated
5963 * over to provide more SVs */
5969 assert(SvREFCNT(sv) == 0);
5970 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
5972 if (type <= SVt_IV) {
5973 /* See the comment in sv.h about the collusion between this
5974 * early return and the overloading of the NULL slots in the
5978 SvFLAGS(sv) &= SVf_BREAK;
5979 SvFLAGS(sv) |= SVTYPEMASK;
5983 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
5985 if (type >= SVt_PVMG) {
5987 if (!curse(sv, 1)) goto get_next_sv;
5988 type = SvTYPE(sv); /* destructor may have changed it */
5990 /* Free back-references before magic, in case the magic calls
5991 * Perl code that has weak references to sv. */
5992 if (type == SVt_PVHV) {
5993 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
5997 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5998 SvREFCNT_dec(SvOURSTASH(sv));
5999 } else if (SvMAGIC(sv)) {
6000 /* Free back-references before other types of magic. */
6001 sv_unmagic(sv, PERL_MAGIC_backref);
6004 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6005 SvREFCNT_dec(SvSTASH(sv));
6008 /* case SVt_BIND: */
6011 IoIFP(sv) != PerlIO_stdin() &&
6012 IoIFP(sv) != PerlIO_stdout() &&
6013 IoIFP(sv) != PerlIO_stderr() &&
6014 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6016 io_close(MUTABLE_IO(sv), FALSE);
6018 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6019 PerlDir_close(IoDIRP(sv));
6020 IoDIRP(sv) = (DIR*)NULL;
6021 Safefree(IoTOP_NAME(sv));
6022 Safefree(IoFMT_NAME(sv));
6023 Safefree(IoBOTTOM_NAME(sv));
6026 /* FIXME for plugins */
6027 pregfree2((REGEXP*) sv);
6031 cv_undef(MUTABLE_CV(sv));
6032 /* If we're in a stash, we don't own a reference to it.
6033 * However it does have a back reference to us, which needs to
6035 if ((stash = CvSTASH(sv)))
6036 sv_del_backref(MUTABLE_SV(stash), sv);
6039 if (PL_last_swash_hv == (const HV *)sv) {
6040 PL_last_swash_hv = NULL;
6042 if (HvTOTALKEYS((HV*)sv) > 0) {
6044 /* this statement should match the one at the beginning of
6045 * hv_undef_flags() */
6046 if ( PL_phase != PERL_PHASE_DESTRUCT
6047 && (name = HvNAME((HV*)sv)))
6050 (void)hv_delete(PL_stashcache, name,
6051 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6052 hv_name_set((HV*)sv, NULL, 0, 0);
6055 /* save old iter_sv in unused SvSTASH field */
6056 assert(!SvOBJECT(sv));
6057 SvSTASH(sv) = (HV*)iter_sv;
6060 /* XXX ideally we should save the old value of hash_index
6061 * too, but I can't think of any place to hide it. The
6062 * effect of not saving it is that for freeing hashes of
6063 * hashes, we become quadratic in scanning the HvARRAY of
6064 * the top hash looking for new entries to free; but
6065 * hopefully this will be dwarfed by the freeing of all
6066 * the nested hashes. */
6068 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6069 goto get_next_sv; /* process this new sv */
6071 /* free empty hash */
6072 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6073 assert(!HvARRAY((HV*)sv));
6077 AV* av = MUTABLE_AV(sv);
6078 if (PL_comppad == av) {
6082 if (AvREAL(av) && AvFILLp(av) > -1) {
6083 next_sv = AvARRAY(av)[AvFILLp(av)--];
6084 /* save old iter_sv in top-most slot of AV,
6085 * and pray that it doesn't get wiped in the meantime */
6086 AvARRAY(av)[AvMAX(av)] = iter_sv;
6088 goto get_next_sv; /* process this new sv */
6090 Safefree(AvALLOC(av));
6095 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6096 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6097 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6098 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6100 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6101 SvREFCNT_dec(LvTARG(sv));
6103 if (isGV_with_GP(sv)) {
6104 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6105 && HvENAME_get(stash))
6106 mro_method_changed_in(stash);
6107 gp_free(MUTABLE_GV(sv));
6109 unshare_hek(GvNAME_HEK(sv));
6110 /* If we're in a stash, we don't own a reference to it.
6111 * However it does have a back reference to us, which
6112 * needs to be cleared. */
6113 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6114 sv_del_backref(MUTABLE_SV(stash), sv);
6116 /* FIXME. There are probably more unreferenced pointers to SVs
6117 * in the interpreter struct that we should check and tidy in
6118 * a similar fashion to this: */
6119 /* See also S_sv_unglob, which does the same thing. */
6120 if ((const GV *)sv == PL_last_in_gv)
6121 PL_last_in_gv = NULL;
6127 /* Don't bother with SvOOK_off(sv); as we're only going to
6131 SvOOK_offset(sv, offset);
6132 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6133 /* Don't even bother with turning off the OOK flag. */
6138 SV * const target = SvRV(sv);
6140 sv_del_backref(target, sv);
6145 #ifdef PERL_OLD_COPY_ON_WRITE
6146 else if (SvPVX_const(sv)
6147 && !(SvTYPE(sv) == SVt_PVIO
6148 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6152 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6156 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6158 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6162 } else if (SvLEN(sv)) {
6163 Safefree(SvPVX_const(sv));
6167 else if (SvPVX_const(sv) && SvLEN(sv)
6168 && !(SvTYPE(sv) == SVt_PVIO
6169 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6170 Safefree(SvPVX_mutable(sv));
6171 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6172 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6183 SvFLAGS(sv) &= SVf_BREAK;
6184 SvFLAGS(sv) |= SVTYPEMASK;
6186 sv_type_details = bodies_by_type + type;
6187 if (sv_type_details->arena) {
6188 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6189 &PL_body_roots[type]);
6191 else if (sv_type_details->body_size) {
6192 safefree(SvANY(sv));
6196 /* caller is responsible for freeing the head of the original sv */
6197 if (sv != orig_sv && !SvREFCNT(sv))
6200 /* grab and free next sv, if any */
6208 else if (!iter_sv) {
6210 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6211 AV *const av = (AV*)iter_sv;
6212 if (AvFILLp(av) > -1) {
6213 sv = AvARRAY(av)[AvFILLp(av)--];
6215 else { /* no more elements of current AV to free */
6218 /* restore previous value, squirrelled away */
6219 iter_sv = AvARRAY(av)[AvMAX(av)];
6220 Safefree(AvALLOC(av));
6223 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6224 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6225 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6226 /* no more elements of current HV to free */
6229 /* Restore previous value of iter_sv, squirrelled away */
6230 assert(!SvOBJECT(sv));
6231 iter_sv = (SV*)SvSTASH(sv);
6233 /* ideally we should restore the old hash_index here,
6234 * but we don't currently save the old value */
6237 /* free any remaining detritus from the hash struct */
6238 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6239 assert(!HvARRAY((HV*)sv));
6244 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6248 if (!SvREFCNT(sv)) {
6252 if (--(SvREFCNT(sv)))
6256 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6257 "Attempt to free temp prematurely: SV 0x%"UVxf
6258 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6262 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6263 /* make sure SvREFCNT(sv)==0 happens very seldom */
6264 SvREFCNT(sv) = (~(U32)0)/2;
6273 /* This routine curses the sv itself, not the object referenced by sv. So
6274 sv does not have to be ROK. */
6277 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6280 PERL_ARGS_ASSERT_CURSE;
6281 assert(SvOBJECT(sv));
6283 if (PL_defstash && /* Still have a symbol table? */
6290 stash = SvSTASH(sv);
6291 destructor = StashHANDLER(stash,DESTROY);
6293 /* A constant subroutine can have no side effects, so
6294 don't bother calling it. */
6295 && !CvCONST(destructor)
6296 /* Don't bother calling an empty destructor or one that
6297 returns immediately. */
6298 && (CvISXSUB(destructor)
6299 || (CvSTART(destructor)
6300 && (CvSTART(destructor)->op_next->op_type
6302 && (CvSTART(destructor)->op_next->op_type
6304 || CvSTART(destructor)->op_next->op_next->op_type
6310 SV* const tmpref = newRV(sv);
6311 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6313 PUSHSTACKi(PERLSI_DESTROY);
6318 call_sv(MUTABLE_SV(destructor),
6319 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6323 if(SvREFCNT(tmpref) < 2) {
6324 /* tmpref is not kept alive! */
6326 SvRV_set(tmpref, NULL);
6329 SvREFCNT_dec(tmpref);
6331 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6334 if (check_refcnt && SvREFCNT(sv)) {
6335 if (PL_in_clean_objs)
6337 "DESTROY created new reference to dead object '%"HEKf"'",
6338 HEKfARG(HvNAME_HEK(stash)));
6339 /* DESTROY gave object new lease on life */
6345 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6346 SvOBJECT_off(sv); /* Curse the object. */
6347 if (SvTYPE(sv) != SVt_PVIO)
6348 --PL_sv_objcount;/* XXX Might want something more general */
6354 =for apidoc sv_newref
6356 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6363 Perl_sv_newref(pTHX_ SV *const sv)
6365 PERL_UNUSED_CONTEXT;
6374 Decrement an SV's reference count, and if it drops to zero, call
6375 C<sv_clear> to invoke destructors and free up any memory used by
6376 the body; finally, deallocate the SV's head itself.
6377 Normally called via a wrapper macro C<SvREFCNT_dec>.
6383 Perl_sv_free(pTHX_ SV *const sv)
6388 if (SvREFCNT(sv) == 0) {
6389 if (SvFLAGS(sv) & SVf_BREAK)
6390 /* this SV's refcnt has been artificially decremented to
6391 * trigger cleanup */
6393 if (PL_in_clean_all) /* All is fair */
6395 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6396 /* make sure SvREFCNT(sv)==0 happens very seldom */
6397 SvREFCNT(sv) = (~(U32)0)/2;
6400 if (ckWARN_d(WARN_INTERNAL)) {
6401 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6402 Perl_dump_sv_child(aTHX_ sv);
6404 #ifdef DEBUG_LEAKING_SCALARS
6407 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6408 if (PL_warnhook == PERL_WARNHOOK_FATAL
6409 || ckDEAD(packWARN(WARN_INTERNAL))) {
6410 /* Don't let Perl_warner cause us to escape our fate: */
6414 /* This may not return: */
6415 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6416 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6417 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6420 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6425 if (--(SvREFCNT(sv)) > 0)
6427 Perl_sv_free2(aTHX_ sv);
6431 Perl_sv_free2(pTHX_ SV *const sv)
6435 PERL_ARGS_ASSERT_SV_FREE2;
6439 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6440 "Attempt to free temp prematurely: SV 0x%"UVxf
6441 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6445 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6446 /* make sure SvREFCNT(sv)==0 happens very seldom */
6447 SvREFCNT(sv) = (~(U32)0)/2;
6458 Returns the length of the string in the SV. Handles magic and type
6459 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6465 Perl_sv_len(pTHX_ register SV *const sv)
6473 len = mg_length(sv);
6475 (void)SvPV_const(sv, len);
6480 =for apidoc sv_len_utf8
6482 Returns the number of characters in the string in an SV, counting wide
6483 UTF-8 bytes as a single character. Handles magic and type coercion.
6489 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6490 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6491 * (Note that the mg_len is not the length of the mg_ptr field.
6492 * This allows the cache to store the character length of the string without
6493 * needing to malloc() extra storage to attach to the mg_ptr.)
6498 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6504 return mg_length(sv);
6508 const U8 *s = (U8*)SvPV_const(sv, len);
6512 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6514 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6515 if (mg->mg_len != -1)
6518 /* We can use the offset cache for a headstart.
6519 The longer value is stored in the first pair. */
6520 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6522 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6526 if (PL_utf8cache < 0) {
6527 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6528 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6532 ulen = Perl_utf8_length(aTHX_ s, s + len);
6533 utf8_mg_len_cache_update(sv, &mg, ulen);
6537 return Perl_utf8_length(aTHX_ s, s + len);
6541 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6544 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6545 STRLEN *const uoffset_p, bool *const at_end)
6547 const U8 *s = start;
6548 STRLEN uoffset = *uoffset_p;
6550 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6552 while (s < send && uoffset) {
6559 else if (s > send) {
6561 /* This is the existing behaviour. Possibly it should be a croak, as
6562 it's actually a bounds error */
6565 *uoffset_p -= uoffset;
6569 /* Given the length of the string in both bytes and UTF-8 characters, decide
6570 whether to walk forwards or backwards to find the byte corresponding to
6571 the passed in UTF-8 offset. */
6573 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6574 STRLEN uoffset, const STRLEN uend)
6576 STRLEN backw = uend - uoffset;
6578 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6580 if (uoffset < 2 * backw) {
6581 /* The assumption is that going forwards is twice the speed of going
6582 forward (that's where the 2 * backw comes from).
6583 (The real figure of course depends on the UTF-8 data.) */
6584 const U8 *s = start;
6586 while (s < send && uoffset--)
6596 while (UTF8_IS_CONTINUATION(*send))
6599 return send - start;
6602 /* For the string representation of the given scalar, find the byte
6603 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6604 give another position in the string, *before* the sought offset, which
6605 (which is always true, as 0, 0 is a valid pair of positions), which should
6606 help reduce the amount of linear searching.
6607 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6608 will be used to reduce the amount of linear searching. The cache will be
6609 created if necessary, and the found value offered to it for update. */
6611 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6612 const U8 *const send, STRLEN uoffset,
6613 STRLEN uoffset0, STRLEN boffset0)
6615 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6617 bool at_end = FALSE;
6619 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6621 assert (uoffset >= uoffset0);
6628 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6629 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6630 if ((*mgp)->mg_ptr) {
6631 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6632 if (cache[0] == uoffset) {
6633 /* An exact match. */
6636 if (cache[2] == uoffset) {
6637 /* An exact match. */
6641 if (cache[0] < uoffset) {
6642 /* The cache already knows part of the way. */
6643 if (cache[0] > uoffset0) {
6644 /* The cache knows more than the passed in pair */
6645 uoffset0 = cache[0];
6646 boffset0 = cache[1];
6648 if ((*mgp)->mg_len != -1) {
6649 /* And we know the end too. */
6651 + sv_pos_u2b_midway(start + boffset0, send,
6653 (*mgp)->mg_len - uoffset0);
6655 uoffset -= uoffset0;
6657 + sv_pos_u2b_forwards(start + boffset0,
6658 send, &uoffset, &at_end);
6659 uoffset += uoffset0;
6662 else if (cache[2] < uoffset) {
6663 /* We're between the two cache entries. */
6664 if (cache[2] > uoffset0) {
6665 /* and the cache knows more than the passed in pair */
6666 uoffset0 = cache[2];
6667 boffset0 = cache[3];
6671 + sv_pos_u2b_midway(start + boffset0,
6674 cache[0] - uoffset0);
6677 + sv_pos_u2b_midway(start + boffset0,
6680 cache[2] - uoffset0);
6684 else if ((*mgp)->mg_len != -1) {
6685 /* If we can take advantage of a passed in offset, do so. */
6686 /* In fact, offset0 is either 0, or less than offset, so don't
6687 need to worry about the other possibility. */
6689 + sv_pos_u2b_midway(start + boffset0, send,
6691 (*mgp)->mg_len - uoffset0);
6696 if (!found || PL_utf8cache < 0) {
6697 STRLEN real_boffset;
6698 uoffset -= uoffset0;
6699 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6700 send, &uoffset, &at_end);
6701 uoffset += uoffset0;
6703 if (found && PL_utf8cache < 0)
6704 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6706 boffset = real_boffset;
6711 utf8_mg_len_cache_update(sv, mgp, uoffset);
6713 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6720 =for apidoc sv_pos_u2b_flags
6722 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6723 the start of the string, to a count of the equivalent number of bytes; if
6724 lenp is non-zero, it does the same to lenp, but this time starting from
6725 the offset, rather than from the start of the string. Handles type coercion.
6726 I<flags> is passed to C<SvPV_flags>, and usually should be
6727 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6733 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6734 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6735 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6740 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6747 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6749 start = (U8*)SvPV_flags(sv, len, flags);
6751 const U8 * const send = start + len;
6753 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6756 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6757 is 0, and *lenp is already set to that. */) {
6758 /* Convert the relative offset to absolute. */
6759 const STRLEN uoffset2 = uoffset + *lenp;
6760 const STRLEN boffset2
6761 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6762 uoffset, boffset) - boffset;
6776 =for apidoc sv_pos_u2b
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 of the string. Handles magic and
6784 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6791 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6792 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6793 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6797 /* This function is subject to size and sign problems */
6800 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6802 PERL_ARGS_ASSERT_SV_POS_U2B;
6805 STRLEN ulen = (STRLEN)*lenp;
6806 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6807 SV_GMAGIC|SV_CONST_RETURN);
6810 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6811 SV_GMAGIC|SV_CONST_RETURN);
6816 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6819 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6823 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6824 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6825 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6829 (*mgp)->mg_len = ulen;
6830 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6831 if (ulen != (STRLEN) (*mgp)->mg_len)
6832 (*mgp)->mg_len = -1;
6835 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6836 byte length pairing. The (byte) length of the total SV is passed in too,
6837 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6838 may not have updated SvCUR, so we can't rely on reading it directly.
6840 The proffered utf8/byte length pairing isn't used if the cache already has
6841 two pairs, and swapping either for the proffered pair would increase the
6842 RMS of the intervals between known byte offsets.
6844 The cache itself consists of 4 STRLEN values
6845 0: larger UTF-8 offset
6846 1: corresponding byte offset
6847 2: smaller UTF-8 offset
6848 3: corresponding byte offset
6850 Unused cache pairs have the value 0, 0.
6851 Keeping the cache "backwards" means that the invariant of
6852 cache[0] >= cache[2] is maintained even with empty slots, which means that
6853 the code that uses it doesn't need to worry if only 1 entry has actually
6854 been set to non-zero. It also makes the "position beyond the end of the
6855 cache" logic much simpler, as the first slot is always the one to start
6859 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6860 const STRLEN utf8, const STRLEN blen)
6864 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6869 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6870 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6871 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6873 (*mgp)->mg_len = -1;
6877 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6878 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6879 (*mgp)->mg_ptr = (char *) cache;
6883 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6884 /* SvPOKp() because it's possible that sv has string overloading, and
6885 therefore is a reference, hence SvPVX() is actually a pointer.
6886 This cures the (very real) symptoms of RT 69422, but I'm not actually
6887 sure whether we should even be caching the results of UTF-8
6888 operations on overloading, given that nothing stops overloading
6889 returning a different value every time it's called. */
6890 const U8 *start = (const U8 *) SvPVX_const(sv);
6891 const STRLEN realutf8 = utf8_length(start, start + byte);
6893 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6897 /* Cache is held with the later position first, to simplify the code
6898 that deals with unbounded ends. */
6900 ASSERT_UTF8_CACHE(cache);
6901 if (cache[1] == 0) {
6902 /* Cache is totally empty */
6905 } else if (cache[3] == 0) {
6906 if (byte > cache[1]) {
6907 /* New one is larger, so goes first. */
6908 cache[2] = cache[0];
6909 cache[3] = cache[1];
6917 #define THREEWAY_SQUARE(a,b,c,d) \
6918 ((float)((d) - (c))) * ((float)((d) - (c))) \
6919 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6920 + ((float)((b) - (a))) * ((float)((b) - (a)))
6922 /* Cache has 2 slots in use, and we know three potential pairs.
6923 Keep the two that give the lowest RMS distance. Do the
6924 calculation in bytes simply because we always know the byte
6925 length. squareroot has the same ordering as the positive value,
6926 so don't bother with the actual square root. */
6927 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6928 if (byte > cache[1]) {
6929 /* New position is after the existing pair of pairs. */
6930 const float keep_earlier
6931 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6932 const float keep_later
6933 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6935 if (keep_later < keep_earlier) {
6936 if (keep_later < existing) {
6937 cache[2] = cache[0];
6938 cache[3] = cache[1];
6944 if (keep_earlier < existing) {
6950 else if (byte > cache[3]) {
6951 /* New position is between the existing pair of pairs. */
6952 const float keep_earlier
6953 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6954 const float keep_later
6955 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6957 if (keep_later < keep_earlier) {
6958 if (keep_later < existing) {
6964 if (keep_earlier < existing) {
6971 /* New position is before the existing pair of pairs. */
6972 const float keep_earlier
6973 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6974 const float keep_later
6975 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6977 if (keep_later < keep_earlier) {
6978 if (keep_later < existing) {
6984 if (keep_earlier < existing) {
6985 cache[0] = cache[2];
6986 cache[1] = cache[3];
6993 ASSERT_UTF8_CACHE(cache);
6996 /* We already know all of the way, now we may be able to walk back. The same
6997 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6998 backward is half the speed of walking forward. */
7000 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7001 const U8 *end, STRLEN endu)
7003 const STRLEN forw = target - s;
7004 STRLEN backw = end - target;
7006 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7008 if (forw < 2 * backw) {
7009 return utf8_length(s, target);
7012 while (end > target) {
7014 while (UTF8_IS_CONTINUATION(*end)) {
7023 =for apidoc sv_pos_b2u
7025 Converts the value pointed to by offsetp from a count of bytes from the
7026 start of the string, to a count of the equivalent number of UTF-8 chars.
7027 Handles magic and type coercion.
7033 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7034 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7039 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7042 const STRLEN byte = *offsetp;
7043 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7049 PERL_ARGS_ASSERT_SV_POS_B2U;
7054 s = (const U8*)SvPV_const(sv, blen);
7057 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7063 && SvTYPE(sv) >= SVt_PVMG
7064 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7067 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7068 if (cache[1] == byte) {
7069 /* An exact match. */
7070 *offsetp = cache[0];
7073 if (cache[3] == byte) {
7074 /* An exact match. */
7075 *offsetp = cache[2];
7079 if (cache[1] < byte) {
7080 /* We already know part of the way. */
7081 if (mg->mg_len != -1) {
7082 /* Actually, we know the end too. */
7084 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7085 s + blen, mg->mg_len - cache[0]);
7087 len = cache[0] + utf8_length(s + cache[1], send);
7090 else if (cache[3] < byte) {
7091 /* We're between the two cached pairs, so we do the calculation
7092 offset by the byte/utf-8 positions for the earlier pair,
7093 then add the utf-8 characters from the string start to
7095 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7096 s + cache[1], cache[0] - cache[2])
7100 else { /* cache[3] > byte */
7101 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7105 ASSERT_UTF8_CACHE(cache);
7107 } else if (mg->mg_len != -1) {
7108 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7112 if (!found || PL_utf8cache < 0) {
7113 const STRLEN real_len = utf8_length(s, send);
7115 if (found && PL_utf8cache < 0)
7116 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7123 utf8_mg_len_cache_update(sv, &mg, len);
7125 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7130 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7131 STRLEN real, SV *const sv)
7133 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7135 /* As this is debugging only code, save space by keeping this test here,
7136 rather than inlining it in all the callers. */
7137 if (from_cache == real)
7140 /* Need to turn the assertions off otherwise we may recurse infinitely
7141 while printing error messages. */
7142 SAVEI8(PL_utf8cache);
7144 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7145 func, (UV) from_cache, (UV) real, SVfARG(sv));
7151 Returns a boolean indicating whether the strings in the two SVs are
7152 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7153 coerce its args to strings if necessary.
7155 =for apidoc sv_eq_flags
7157 Returns a boolean indicating whether the strings in the two SVs are
7158 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7159 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7165 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7173 SV* svrecode = NULL;
7180 /* if pv1 and pv2 are the same, second SvPV_const call may
7181 * invalidate pv1 (if we are handling magic), so we may need to
7183 if (sv1 == sv2 && flags & SV_GMAGIC
7184 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7185 pv1 = SvPV_const(sv1, cur1);
7186 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7188 pv1 = SvPV_flags_const(sv1, cur1, flags);
7196 pv2 = SvPV_flags_const(sv2, cur2, flags);
7198 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7199 /* Differing utf8ness.
7200 * Do not UTF8size the comparands as a side-effect. */
7203 svrecode = newSVpvn(pv2, cur2);
7204 sv_recode_to_utf8(svrecode, PL_encoding);
7205 pv2 = SvPV_const(svrecode, cur2);
7208 svrecode = newSVpvn(pv1, cur1);
7209 sv_recode_to_utf8(svrecode, PL_encoding);
7210 pv1 = SvPV_const(svrecode, cur1);
7212 /* Now both are in UTF-8. */
7214 SvREFCNT_dec(svrecode);
7220 /* sv1 is the UTF-8 one */
7221 return bytes_cmp_utf8((const U8*)pv2, cur2,
7222 (const U8*)pv1, cur1) == 0;
7225 /* sv2 is the UTF-8 one */
7226 return bytes_cmp_utf8((const U8*)pv1, cur1,
7227 (const U8*)pv2, cur2) == 0;
7233 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7235 SvREFCNT_dec(svrecode);
7243 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7244 string in C<sv1> is less than, equal to, or greater than the string in
7245 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7246 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7248 =for apidoc sv_cmp_flags
7250 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7251 string in C<sv1> is less than, equal to, or greater than the string in
7252 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7253 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7254 also C<sv_cmp_locale_flags>.
7260 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7262 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7266 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7271 const char *pv1, *pv2;
7274 SV *svrecode = NULL;
7281 pv1 = SvPV_flags_const(sv1, cur1, flags);
7288 pv2 = SvPV_flags_const(sv2, cur2, flags);
7290 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7291 /* Differing utf8ness.
7292 * Do not UTF8size the comparands as a side-effect. */
7295 svrecode = newSVpvn(pv2, cur2);
7296 sv_recode_to_utf8(svrecode, PL_encoding);
7297 pv2 = SvPV_const(svrecode, cur2);
7300 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7301 (const U8*)pv1, cur1);
7302 return retval ? retval < 0 ? -1 : +1 : 0;
7307 svrecode = newSVpvn(pv1, cur1);
7308 sv_recode_to_utf8(svrecode, PL_encoding);
7309 pv1 = SvPV_const(svrecode, cur1);
7312 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7313 (const U8*)pv2, cur2);
7314 return retval ? retval < 0 ? -1 : +1 : 0;
7320 cmp = cur2 ? -1 : 0;
7324 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7327 cmp = retval < 0 ? -1 : 1;
7328 } else if (cur1 == cur2) {
7331 cmp = cur1 < cur2 ? -1 : 1;
7335 SvREFCNT_dec(svrecode);
7343 =for apidoc sv_cmp_locale
7345 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7346 'use bytes' aware, handles get magic, and will coerce its args to strings
7347 if necessary. See also C<sv_cmp>.
7349 =for apidoc sv_cmp_locale_flags
7351 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7352 'use bytes' aware and will coerce its args to strings if necessary. If the
7353 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7359 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7361 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7365 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7369 #ifdef USE_LOCALE_COLLATE
7375 if (PL_collation_standard)
7379 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7381 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7383 if (!pv1 || !len1) {
7394 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7397 return retval < 0 ? -1 : 1;
7400 * When the result of collation is equality, that doesn't mean
7401 * that there are no differences -- some locales exclude some
7402 * characters from consideration. So to avoid false equalities,
7403 * we use the raw string as a tiebreaker.
7409 #endif /* USE_LOCALE_COLLATE */
7411 return sv_cmp(sv1, sv2);
7415 #ifdef USE_LOCALE_COLLATE
7418 =for apidoc sv_collxfrm
7420 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7421 C<sv_collxfrm_flags>.
7423 =for apidoc sv_collxfrm_flags
7425 Add Collate Transform magic to an SV if it doesn't already have it. If the
7426 flags contain SV_GMAGIC, it handles get-magic.
7428 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7429 scalar data of the variable, but transformed to such a format that a normal
7430 memory comparison can be used to compare the data according to the locale
7437 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7442 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7444 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7445 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7451 Safefree(mg->mg_ptr);
7452 s = SvPV_flags_const(sv, len, flags);
7453 if ((xf = mem_collxfrm(s, len, &xlen))) {
7455 #ifdef PERL_OLD_COPY_ON_WRITE
7457 sv_force_normal_flags(sv, 0);
7459 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7473 if (mg && mg->mg_ptr) {
7475 return mg->mg_ptr + sizeof(PL_collation_ix);
7483 #endif /* USE_LOCALE_COLLATE */
7486 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7488 SV * const tsv = newSV(0);
7491 sv_gets(tsv, fp, 0);
7492 sv_utf8_upgrade_nomg(tsv);
7493 SvCUR_set(sv,append);
7496 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7500 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7503 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7504 /* Grab the size of the record we're getting */
7505 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7512 /* VMS wants read instead of fread, because fread doesn't respect */
7513 /* RMS record boundaries. This is not necessarily a good thing to be */
7514 /* doing, but we've got no other real choice - except avoid stdio
7515 as implementation - perhaps write a :vms layer ?
7517 fd = PerlIO_fileno(fp);
7519 bytesread = PerlLIO_read(fd, buffer, recsize);
7521 else /* in-memory file from PerlIO::Scalar */
7524 bytesread = PerlIO_read(fp, buffer, recsize);
7529 SvCUR_set(sv, bytesread + append);
7530 buffer[bytesread] = '\0';
7531 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7537 Get a line from the filehandle and store it into the SV, optionally
7538 appending to the currently-stored string.
7544 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7549 register STDCHAR rslast;
7550 register STDCHAR *bp;
7555 PERL_ARGS_ASSERT_SV_GETS;
7557 if (SvTHINKFIRST(sv))
7558 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7559 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7561 However, perlbench says it's slower, because the existing swipe code
7562 is faster than copy on write.
7563 Swings and roundabouts. */
7564 SvUPGRADE(sv, SVt_PV);
7569 if (PerlIO_isutf8(fp)) {
7571 sv_utf8_upgrade_nomg(sv);
7572 sv_pos_u2b(sv,&append,0);
7574 } else if (SvUTF8(sv)) {
7575 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7583 if (PerlIO_isutf8(fp))
7586 if (IN_PERL_COMPILETIME) {
7587 /* we always read code in line mode */
7591 else if (RsSNARF(PL_rs)) {
7592 /* If it is a regular disk file use size from stat() as estimate
7593 of amount we are going to read -- may result in mallocing
7594 more memory than we really need if the layers below reduce
7595 the size we read (e.g. CRLF or a gzip layer).
7598 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7599 const Off_t offset = PerlIO_tell(fp);
7600 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7601 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7607 else if (RsRECORD(PL_rs)) {
7608 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7610 else if (RsPARA(PL_rs)) {
7616 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7617 if (PerlIO_isutf8(fp)) {
7618 rsptr = SvPVutf8(PL_rs, rslen);
7621 if (SvUTF8(PL_rs)) {
7622 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7623 Perl_croak(aTHX_ "Wide character in $/");
7626 rsptr = SvPV_const(PL_rs, rslen);
7630 rslast = rslen ? rsptr[rslen - 1] : '\0';
7632 if (rspara) { /* have to do this both before and after */
7633 do { /* to make sure file boundaries work right */
7636 i = PerlIO_getc(fp);
7640 PerlIO_ungetc(fp,i);
7646 /* See if we know enough about I/O mechanism to cheat it ! */
7648 /* This used to be #ifdef test - it is made run-time test for ease
7649 of abstracting out stdio interface. One call should be cheap
7650 enough here - and may even be a macro allowing compile
7654 if (PerlIO_fast_gets(fp)) {
7657 * We're going to steal some values from the stdio struct
7658 * and put EVERYTHING in the innermost loop into registers.
7660 register STDCHAR *ptr;
7664 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7665 /* An ungetc()d char is handled separately from the regular
7666 * buffer, so we getc() it back out and stuff it in the buffer.
7668 i = PerlIO_getc(fp);
7669 if (i == EOF) return 0;
7670 *(--((*fp)->_ptr)) = (unsigned char) i;
7674 /* Here is some breathtakingly efficient cheating */
7676 cnt = PerlIO_get_cnt(fp); /* get count into register */
7677 /* make sure we have the room */
7678 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7679 /* Not room for all of it
7680 if we are looking for a separator and room for some
7682 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7683 /* just process what we have room for */
7684 shortbuffered = cnt - SvLEN(sv) + append + 1;
7685 cnt -= shortbuffered;
7689 /* remember that cnt can be negative */
7690 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7695 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7696 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7697 DEBUG_P(PerlIO_printf(Perl_debug_log,
7698 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7699 DEBUG_P(PerlIO_printf(Perl_debug_log,
7700 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7701 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7702 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7707 while (cnt > 0) { /* this | eat */
7709 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7710 goto thats_all_folks; /* screams | sed :-) */
7714 Copy(ptr, bp, cnt, char); /* this | eat */
7715 bp += cnt; /* screams | dust */
7716 ptr += cnt; /* louder | sed :-) */
7718 assert (!shortbuffered);
7719 goto cannot_be_shortbuffered;
7723 if (shortbuffered) { /* oh well, must extend */
7724 cnt = shortbuffered;
7726 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7728 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7729 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7733 cannot_be_shortbuffered:
7734 DEBUG_P(PerlIO_printf(Perl_debug_log,
7735 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7736 PTR2UV(ptr),(long)cnt));
7737 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7739 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7740 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7741 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7742 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7744 /* This used to call 'filbuf' in stdio form, but as that behaves like
7745 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7746 another abstraction. */
7747 i = PerlIO_getc(fp); /* get more characters */
7749 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7750 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7751 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7752 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7754 cnt = PerlIO_get_cnt(fp);
7755 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7756 DEBUG_P(PerlIO_printf(Perl_debug_log,
7757 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7759 if (i == EOF) /* all done for ever? */
7760 goto thats_really_all_folks;
7762 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7764 SvGROW(sv, bpx + cnt + 2);
7765 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7767 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7769 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7770 goto thats_all_folks;
7774 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7775 memNE((char*)bp - rslen, rsptr, rslen))
7776 goto screamer; /* go back to the fray */
7777 thats_really_all_folks:
7779 cnt += shortbuffered;
7780 DEBUG_P(PerlIO_printf(Perl_debug_log,
7781 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7782 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7783 DEBUG_P(PerlIO_printf(Perl_debug_log,
7784 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7785 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7786 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7788 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7789 DEBUG_P(PerlIO_printf(Perl_debug_log,
7790 "Screamer: done, len=%ld, string=|%.*s|\n",
7791 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7795 /*The big, slow, and stupid way. */
7796 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7797 STDCHAR *buf = NULL;
7798 Newx(buf, 8192, STDCHAR);
7806 register const STDCHAR * const bpe = buf + sizeof(buf);
7808 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7809 ; /* keep reading */
7813 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7814 /* Accommodate broken VAXC compiler, which applies U8 cast to
7815 * both args of ?: operator, causing EOF to change into 255
7818 i = (U8)buf[cnt - 1];
7824 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7826 sv_catpvn(sv, (char *) buf, cnt);
7828 sv_setpvn(sv, (char *) buf, cnt);
7830 if (i != EOF && /* joy */
7832 SvCUR(sv) < rslen ||
7833 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7837 * If we're reading from a TTY and we get a short read,
7838 * indicating that the user hit his EOF character, we need
7839 * to notice it now, because if we try to read from the TTY
7840 * again, the EOF condition will disappear.
7842 * The comparison of cnt to sizeof(buf) is an optimization
7843 * that prevents unnecessary calls to feof().
7847 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7851 #ifdef USE_HEAP_INSTEAD_OF_STACK
7856 if (rspara) { /* have to do this both before and after */
7857 while (i != EOF) { /* to make sure file boundaries work right */
7858 i = PerlIO_getc(fp);
7860 PerlIO_ungetc(fp,i);
7866 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7872 Auto-increment of the value in the SV, doing string to numeric conversion
7873 if necessary. Handles 'get' magic and operator overloading.
7879 Perl_sv_inc(pTHX_ register SV *const sv)
7888 =for apidoc sv_inc_nomg
7890 Auto-increment of the value in the SV, doing string to numeric conversion
7891 if necessary. Handles operator overloading. Skips handling 'get' magic.
7897 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7905 if (SvTHINKFIRST(sv)) {
7906 if (SvIsCOW(sv) || isGV_with_GP(sv))
7907 sv_force_normal_flags(sv, 0);
7908 if (SvREADONLY(sv)) {
7909 if (IN_PERL_RUNTIME)
7910 Perl_croak_no_modify(aTHX);
7914 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7916 i = PTR2IV(SvRV(sv));
7921 flags = SvFLAGS(sv);
7922 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7923 /* It's (privately or publicly) a float, but not tested as an
7924 integer, so test it to see. */
7926 flags = SvFLAGS(sv);
7928 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7929 /* It's publicly an integer, or privately an integer-not-float */
7930 #ifdef PERL_PRESERVE_IVUV
7934 if (SvUVX(sv) == UV_MAX)
7935 sv_setnv(sv, UV_MAX_P1);
7937 (void)SvIOK_only_UV(sv);
7938 SvUV_set(sv, SvUVX(sv) + 1);
7940 if (SvIVX(sv) == IV_MAX)
7941 sv_setuv(sv, (UV)IV_MAX + 1);
7943 (void)SvIOK_only(sv);
7944 SvIV_set(sv, SvIVX(sv) + 1);
7949 if (flags & SVp_NOK) {
7950 const NV was = SvNVX(sv);
7951 if (NV_OVERFLOWS_INTEGERS_AT &&
7952 was >= NV_OVERFLOWS_INTEGERS_AT) {
7953 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7954 "Lost precision when incrementing %" NVff " by 1",
7957 (void)SvNOK_only(sv);
7958 SvNV_set(sv, was + 1.0);
7962 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7963 if ((flags & SVTYPEMASK) < SVt_PVIV)
7964 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7965 (void)SvIOK_only(sv);
7970 while (isALPHA(*d)) d++;
7971 while (isDIGIT(*d)) d++;
7972 if (d < SvEND(sv)) {
7973 #ifdef PERL_PRESERVE_IVUV
7974 /* Got to punt this as an integer if needs be, but we don't issue
7975 warnings. Probably ought to make the sv_iv_please() that does
7976 the conversion if possible, and silently. */
7977 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7978 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7979 /* Need to try really hard to see if it's an integer.
7980 9.22337203685478e+18 is an integer.
7981 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7982 so $a="9.22337203685478e+18"; $a+0; $a++
7983 needs to be the same as $a="9.22337203685478e+18"; $a++
7990 /* sv_2iv *should* have made this an NV */
7991 if (flags & SVp_NOK) {
7992 (void)SvNOK_only(sv);
7993 SvNV_set(sv, SvNVX(sv) + 1.0);
7996 /* I don't think we can get here. Maybe I should assert this
7997 And if we do get here I suspect that sv_setnv will croak. NWC
7999 #if defined(USE_LONG_DOUBLE)
8000 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",
8001 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8003 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8004 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8007 #endif /* PERL_PRESERVE_IVUV */
8008 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8012 while (d >= SvPVX_const(sv)) {
8020 /* MKS: The original code here died if letters weren't consecutive.
8021 * at least it didn't have to worry about non-C locales. The
8022 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8023 * arranged in order (although not consecutively) and that only
8024 * [A-Za-z] are accepted by isALPHA in the C locale.
8026 if (*d != 'z' && *d != 'Z') {
8027 do { ++*d; } while (!isALPHA(*d));
8030 *(d--) -= 'z' - 'a';
8035 *(d--) -= 'z' - 'a' + 1;
8039 /* oh,oh, the number grew */
8040 SvGROW(sv, SvCUR(sv) + 2);
8041 SvCUR_set(sv, SvCUR(sv) + 1);
8042 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8053 Auto-decrement of the value in the SV, doing string to numeric conversion
8054 if necessary. Handles 'get' magic and operator overloading.
8060 Perl_sv_dec(pTHX_ register SV *const sv)
8070 =for apidoc sv_dec_nomg
8072 Auto-decrement of the value in the SV, doing string to numeric conversion
8073 if necessary. Handles operator overloading. Skips handling 'get' magic.
8079 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8086 if (SvTHINKFIRST(sv)) {
8087 if (SvIsCOW(sv) || isGV_with_GP(sv))
8088 sv_force_normal_flags(sv, 0);
8089 if (SvREADONLY(sv)) {
8090 if (IN_PERL_RUNTIME)
8091 Perl_croak_no_modify(aTHX);
8095 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8097 i = PTR2IV(SvRV(sv));
8102 /* Unlike sv_inc we don't have to worry about string-never-numbers
8103 and keeping them magic. But we mustn't warn on punting */
8104 flags = SvFLAGS(sv);
8105 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8106 /* It's publicly an integer, or privately an integer-not-float */
8107 #ifdef PERL_PRESERVE_IVUV
8111 if (SvUVX(sv) == 0) {
8112 (void)SvIOK_only(sv);
8116 (void)SvIOK_only_UV(sv);
8117 SvUV_set(sv, SvUVX(sv) - 1);
8120 if (SvIVX(sv) == IV_MIN) {
8121 sv_setnv(sv, (NV)IV_MIN);
8125 (void)SvIOK_only(sv);
8126 SvIV_set(sv, SvIVX(sv) - 1);
8131 if (flags & SVp_NOK) {
8134 const NV was = SvNVX(sv);
8135 if (NV_OVERFLOWS_INTEGERS_AT &&
8136 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8137 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8138 "Lost precision when decrementing %" NVff " by 1",
8141 (void)SvNOK_only(sv);
8142 SvNV_set(sv, was - 1.0);
8146 if (!(flags & SVp_POK)) {
8147 if ((flags & SVTYPEMASK) < SVt_PVIV)
8148 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8150 (void)SvIOK_only(sv);
8153 #ifdef PERL_PRESERVE_IVUV
8155 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8156 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8157 /* Need to try really hard to see if it's an integer.
8158 9.22337203685478e+18 is an integer.
8159 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8160 so $a="9.22337203685478e+18"; $a+0; $a--
8161 needs to be the same as $a="9.22337203685478e+18"; $a--
8168 /* sv_2iv *should* have made this an NV */
8169 if (flags & SVp_NOK) {
8170 (void)SvNOK_only(sv);
8171 SvNV_set(sv, SvNVX(sv) - 1.0);
8174 /* I don't think we can get here. Maybe I should assert this
8175 And if we do get here I suspect that sv_setnv will croak. NWC
8177 #if defined(USE_LONG_DOUBLE)
8178 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",
8179 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8181 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8182 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8186 #endif /* PERL_PRESERVE_IVUV */
8187 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8190 /* this define is used to eliminate a chunk of duplicated but shared logic
8191 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8192 * used anywhere but here - yves
8194 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8197 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8201 =for apidoc sv_mortalcopy
8203 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8204 The new SV is marked as mortal. It will be destroyed "soon", either by an
8205 explicit call to FREETMPS, or by an implicit call at places such as
8206 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8211 /* Make a string that will exist for the duration of the expression
8212 * evaluation. Actually, it may have to last longer than that, but
8213 * hopefully we won't free it until it has been assigned to a
8214 * permanent location. */
8217 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8223 sv_setsv(sv,oldstr);
8224 PUSH_EXTEND_MORTAL__SV_C(sv);
8230 =for apidoc sv_newmortal
8232 Creates a new null SV which is mortal. The reference count of the SV is
8233 set to 1. It will be destroyed "soon", either by an explicit call to
8234 FREETMPS, or by an implicit call at places such as statement boundaries.
8235 See also C<sv_mortalcopy> and C<sv_2mortal>.
8241 Perl_sv_newmortal(pTHX)
8247 SvFLAGS(sv) = SVs_TEMP;
8248 PUSH_EXTEND_MORTAL__SV_C(sv);
8254 =for apidoc newSVpvn_flags
8256 Creates a new SV and copies a string into it. The reference count for the
8257 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8258 string. You are responsible for ensuring that the source string is at least
8259 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8260 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8261 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8262 returning. If C<SVf_UTF8> is set, C<s>
8263 is considered to be in UTF-8 and the
8264 C<SVf_UTF8> flag will be set on the new SV.
8265 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8267 #define newSVpvn_utf8(s, len, u) \
8268 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8274 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8279 /* All the flags we don't support must be zero.
8280 And we're new code so I'm going to assert this from the start. */
8281 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8283 sv_setpvn(sv,s,len);
8285 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8286 * and do what it does ourselves here.
8287 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8288 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8289 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8290 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8293 SvFLAGS(sv) |= flags;
8295 if(flags & SVs_TEMP){
8296 PUSH_EXTEND_MORTAL__SV_C(sv);
8303 =for apidoc sv_2mortal
8305 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8306 by an explicit call to FREETMPS, or by an implicit call at places such as
8307 statement boundaries. SvTEMP() is turned on which means that the SV's
8308 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8309 and C<sv_mortalcopy>.
8315 Perl_sv_2mortal(pTHX_ register SV *const sv)
8320 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8322 PUSH_EXTEND_MORTAL__SV_C(sv);
8330 Creates a new SV and copies a string into it. The reference count for the
8331 SV is set to 1. If C<len> is zero, Perl will compute the length using
8332 strlen(). For efficiency, consider using C<newSVpvn> instead.
8338 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8344 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8349 =for apidoc newSVpvn
8351 Creates a new SV and copies a string into it. The reference count for the
8352 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8353 string. You are responsible for ensuring that the source string is at least
8354 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8360 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
8366 sv_setpvn(sv,s,len);
8371 =for apidoc newSVhek
8373 Creates a new SV from the hash key structure. It will generate scalars that
8374 point to the shared string table where possible. Returns a new (undefined)
8375 SV if the hek is NULL.
8381 Perl_newSVhek(pTHX_ const HEK *const hek)
8391 if (HEK_LEN(hek) == HEf_SVKEY) {
8392 return newSVsv(*(SV**)HEK_KEY(hek));
8394 const int flags = HEK_FLAGS(hek);
8395 if (flags & HVhek_WASUTF8) {
8397 Andreas would like keys he put in as utf8 to come back as utf8
8399 STRLEN utf8_len = HEK_LEN(hek);
8400 SV * const sv = newSV_type(SVt_PV);
8401 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8402 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8403 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8406 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8407 /* We don't have a pointer to the hv, so we have to replicate the
8408 flag into every HEK. This hv is using custom a hasing
8409 algorithm. Hence we can't return a shared string scalar, as
8410 that would contain the (wrong) hash value, and might get passed
8411 into an hv routine with a regular hash.
8412 Similarly, a hash that isn't using shared hash keys has to have
8413 the flag in every key so that we know not to try to call
8414 share_hek_hek on it. */
8416 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8421 /* This will be overwhelminly the most common case. */
8423 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8424 more efficient than sharepvn(). */
8428 sv_upgrade(sv, SVt_PV);
8429 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8430 SvCUR_set(sv, HEK_LEN(hek));
8443 =for apidoc newSVpvn_share
8445 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8446 table. If the string does not already exist in the table, it is
8447 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8448 is non-zero, that value is used; otherwise the hash is computed.
8449 The string's hash can later be retrieved from the SV
8450 with the C<SvSHARED_HASH()> macro. The idea here is
8451 that as the string table is used for shared hash keys these strings will have
8452 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8458 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8462 bool is_utf8 = FALSE;
8463 const char *const orig_src = src;
8466 STRLEN tmplen = -len;
8468 /* See the note in hv.c:hv_fetch() --jhi */
8469 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8473 PERL_HASH(hash, src, len);
8475 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8476 changes here, update it there too. */
8477 sv_upgrade(sv, SVt_PV);
8478 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8486 if (src != orig_src)
8492 =for apidoc newSVpv_share
8494 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8501 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8503 return newSVpvn_share(src, strlen(src), hash);
8506 #if defined(PERL_IMPLICIT_CONTEXT)
8508 /* pTHX_ magic can't cope with varargs, so this is a no-context
8509 * version of the main function, (which may itself be aliased to us).
8510 * Don't access this version directly.
8514 Perl_newSVpvf_nocontext(const char *const pat, ...)
8520 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8522 va_start(args, pat);
8523 sv = vnewSVpvf(pat, &args);
8530 =for apidoc newSVpvf
8532 Creates a new SV and initializes it with the string formatted like
8539 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8544 PERL_ARGS_ASSERT_NEWSVPVF;
8546 va_start(args, pat);
8547 sv = vnewSVpvf(pat, &args);
8552 /* backend for newSVpvf() and newSVpvf_nocontext() */
8555 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8560 PERL_ARGS_ASSERT_VNEWSVPVF;
8563 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8570 Creates a new SV and copies a floating point value into it.
8571 The reference count for the SV is set to 1.
8577 Perl_newSVnv(pTHX_ const NV n)
8590 Creates a new SV and copies an integer into it. The reference count for the
8597 Perl_newSViv(pTHX_ const IV i)
8610 Creates a new SV and copies an unsigned integer into it.
8611 The reference count for the SV is set to 1.
8617 Perl_newSVuv(pTHX_ const UV u)
8628 =for apidoc newSV_type
8630 Creates a new SV, of the type specified. The reference count for the new SV
8637 Perl_newSV_type(pTHX_ const svtype type)
8642 sv_upgrade(sv, type);
8647 =for apidoc newRV_noinc
8649 Creates an RV wrapper for an SV. The reference count for the original
8650 SV is B<not> incremented.
8656 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8659 register SV *sv = newSV_type(SVt_IV);
8661 PERL_ARGS_ASSERT_NEWRV_NOINC;
8664 SvRV_set(sv, tmpRef);
8669 /* newRV_inc is the official function name to use now.
8670 * newRV_inc is in fact #defined to newRV in sv.h
8674 Perl_newRV(pTHX_ SV *const sv)
8678 PERL_ARGS_ASSERT_NEWRV;
8680 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8686 Creates a new SV which is an exact duplicate of the original SV.
8693 Perl_newSVsv(pTHX_ register SV *const old)
8700 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8701 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8705 /* SV_GMAGIC is the default for sv_setv()
8706 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8707 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8708 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8713 =for apidoc sv_reset
8715 Underlying implementation for the C<reset> Perl function.
8716 Note that the perl-level function is vaguely deprecated.
8722 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8725 char todo[PERL_UCHAR_MAX+1];
8727 PERL_ARGS_ASSERT_SV_RESET;
8732 if (!*s) { /* reset ?? searches */
8733 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8735 const U32 count = mg->mg_len / sizeof(PMOP**);
8736 PMOP **pmp = (PMOP**) mg->mg_ptr;
8737 PMOP *const *const end = pmp + count;
8741 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8743 (*pmp)->op_pmflags &= ~PMf_USED;
8751 /* reset variables */
8753 if (!HvARRAY(stash))
8756 Zero(todo, 256, char);
8759 I32 i = (unsigned char)*s;
8763 max = (unsigned char)*s++;
8764 for ( ; i <= max; i++) {
8767 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8769 for (entry = HvARRAY(stash)[i];
8771 entry = HeNEXT(entry))
8776 if (!todo[(U8)*HeKEY(entry)])
8778 gv = MUTABLE_GV(HeVAL(entry));
8781 if (SvTHINKFIRST(sv)) {
8782 if (!SvREADONLY(sv) && SvROK(sv))
8784 /* XXX Is this continue a bug? Why should THINKFIRST
8785 exempt us from resetting arrays and hashes? */
8789 if (SvTYPE(sv) >= SVt_PV) {
8791 if (SvPVX_const(sv) != NULL)
8799 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8801 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8804 # if defined(USE_ENVIRON_ARRAY)
8807 # endif /* USE_ENVIRON_ARRAY */
8818 Using various gambits, try to get an IO from an SV: the IO slot if its a
8819 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8820 named after the PV if we're a string.
8822 'Get' magic is ignored on the sv passed in, but will be called on
8823 C<SvRV(sv)> if sv is an RV.
8829 Perl_sv_2io(pTHX_ SV *const sv)
8834 PERL_ARGS_ASSERT_SV_2IO;
8836 switch (SvTYPE(sv)) {
8838 io = MUTABLE_IO(sv);
8842 if (isGV_with_GP(sv)) {
8843 gv = MUTABLE_GV(sv);
8846 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8847 HEKfARG(GvNAME_HEK(gv)));
8853 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8855 SvGETMAGIC(SvRV(sv));
8856 return sv_2io(SvRV(sv));
8858 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8865 if (SvGMAGICAL(sv)) {
8866 newsv = sv_newmortal();
8867 sv_setsv_nomg(newsv, sv);
8869 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8879 Using various gambits, try to get a CV from an SV; in addition, try if
8880 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8881 The flags in C<lref> are passed to gv_fetchsv.
8887 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8893 PERL_ARGS_ASSERT_SV_2CV;
8900 switch (SvTYPE(sv)) {
8904 return MUTABLE_CV(sv);
8914 sv = amagic_deref_call(sv, to_cv_amg);
8917 if (SvTYPE(sv) == SVt_PVCV) {
8918 cv = MUTABLE_CV(sv);
8923 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
8924 gv = MUTABLE_GV(sv);
8926 Perl_croak(aTHX_ "Not a subroutine reference");
8928 else if (isGV_with_GP(sv)) {
8929 gv = MUTABLE_GV(sv);
8932 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
8939 /* Some flags to gv_fetchsv mean don't really create the GV */
8940 if (!isGV_with_GP(gv)) {
8945 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
8949 gv_efullname3(tmpsv, gv, NULL);
8950 /* XXX this is probably not what they think they're getting.
8951 * It has the same effect as "sub name;", i.e. just a forward
8953 newSUB(start_subparse(FALSE, 0),
8954 newSVOP(OP_CONST, 0, tmpsv),
8958 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8959 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8968 Returns true if the SV has a true value by Perl's rules.
8969 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8970 instead use an in-line version.
8976 Perl_sv_true(pTHX_ register SV *const sv)
8981 register const XPV* const tXpv = (XPV*)SvANY(sv);
8983 (tXpv->xpv_cur > 1 ||
8984 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8991 return SvIVX(sv) != 0;
8994 return SvNVX(sv) != 0.0;
8996 return sv_2bool(sv);
9002 =for apidoc sv_pvn_force
9004 Get a sensible string out of the SV somehow.
9005 A private implementation of the C<SvPV_force> macro for compilers which
9006 can't cope with complex macro expressions. Always use the macro instead.
9008 =for apidoc sv_pvn_force_flags
9010 Get a sensible string out of the SV somehow.
9011 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9012 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9013 implemented in terms of this function.
9014 You normally want to use the various wrapper macros instead: see
9015 C<SvPV_force> and C<SvPV_force_nomg>
9021 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9025 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9027 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9028 if (SvTHINKFIRST(sv) && !SvROK(sv))
9029 sv_force_normal_flags(sv, 0);
9039 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9040 const char * const ref = sv_reftype(sv,0);
9042 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9043 ref, OP_DESC(PL_op));
9045 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9047 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9048 || isGV_with_GP(sv))
9049 /* diag_listed_as: Can't coerce %s to %s in %s */
9050 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9052 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9056 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9059 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9060 SvGROW(sv, len + 1);
9061 Move(s,SvPVX(sv),len,char);
9063 SvPVX(sv)[len] = '\0';
9066 SvPOK_on(sv); /* validate pointer */
9068 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9069 PTR2UV(sv),SvPVX_const(sv)));
9072 return SvPVX_mutable(sv);
9076 =for apidoc sv_pvbyten_force
9078 The backend for the C<SvPVbytex_force> macro. Always use the macro
9085 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9087 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9089 sv_pvn_force(sv,lp);
9090 sv_utf8_downgrade(sv,0);
9096 =for apidoc sv_pvutf8n_force
9098 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9105 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9107 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9109 sv_pvn_force(sv,lp);
9110 sv_utf8_upgrade(sv);
9116 =for apidoc sv_reftype
9118 Returns a string describing what the SV is a reference to.
9124 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9126 PERL_ARGS_ASSERT_SV_REFTYPE;
9127 if (ob && SvOBJECT(sv)) {
9128 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9131 switch (SvTYPE(sv)) {
9146 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9147 /* tied lvalues should appear to be
9148 * scalars for backwards compatibility */
9149 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9150 ? "SCALAR" : "LVALUE");
9151 case SVt_PVAV: return "ARRAY";
9152 case SVt_PVHV: return "HASH";
9153 case SVt_PVCV: return "CODE";
9154 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9155 ? "GLOB" : "SCALAR");
9156 case SVt_PVFM: return "FORMAT";
9157 case SVt_PVIO: return "IO";
9158 case SVt_BIND: return "BIND";
9159 case SVt_REGEXP: return "REGEXP";
9160 default: return "UNKNOWN";
9168 Returns a SV describing what the SV passed in is a reference to.
9174 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9176 PERL_ARGS_ASSERT_SV_REF;
9179 dst = sv_newmortal();
9181 if (ob && SvOBJECT(sv)) {
9182 HvNAME_get(SvSTASH(sv))
9183 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9184 : sv_setpvn(dst, "__ANON__", 8);
9187 const char * reftype = sv_reftype(sv, 0);
9188 sv_setpv(dst, reftype);
9194 =for apidoc sv_isobject
9196 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9197 object. If the SV is not an RV, or if the object is not blessed, then this
9204 Perl_sv_isobject(pTHX_ SV *sv)
9220 Returns a boolean indicating whether the SV is blessed into the specified
9221 class. This does not check for subtypes; use C<sv_derived_from> to verify
9222 an inheritance relationship.
9228 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9232 PERL_ARGS_ASSERT_SV_ISA;
9242 hvname = HvNAME_get(SvSTASH(sv));
9246 return strEQ(hvname, name);
9252 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9253 it will be upgraded to one. If C<classname> is non-null then the new SV will
9254 be blessed in the specified package. The new SV is returned and its
9255 reference count is 1.
9261 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9266 PERL_ARGS_ASSERT_NEWSVRV;
9270 SV_CHECK_THINKFIRST_COW_DROP(rv);
9271 (void)SvAMAGIC_off(rv);
9273 if (SvTYPE(rv) >= SVt_PVMG) {
9274 const U32 refcnt = SvREFCNT(rv);
9278 SvREFCNT(rv) = refcnt;
9280 sv_upgrade(rv, SVt_IV);
9281 } else if (SvROK(rv)) {
9282 SvREFCNT_dec(SvRV(rv));
9284 prepare_SV_for_RV(rv);
9292 HV* const stash = gv_stashpv(classname, GV_ADD);
9293 (void)sv_bless(rv, stash);
9299 =for apidoc sv_setref_pv
9301 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9302 argument will be upgraded to an RV. That RV will be modified to point to
9303 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9304 into the SV. The C<classname> argument indicates the package for the
9305 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9306 will have a reference count of 1, and the RV will be returned.
9308 Do not use with other Perl types such as HV, AV, SV, CV, because those
9309 objects will become corrupted by the pointer copy process.
9311 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9317 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9321 PERL_ARGS_ASSERT_SV_SETREF_PV;
9324 sv_setsv(rv, &PL_sv_undef);
9328 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9333 =for apidoc sv_setref_iv
9335 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9336 argument will be upgraded to an RV. That RV will be modified to point to
9337 the new SV. The C<classname> argument indicates the package for the
9338 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9339 will have a reference count of 1, and the RV will be returned.
9345 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9347 PERL_ARGS_ASSERT_SV_SETREF_IV;
9349 sv_setiv(newSVrv(rv,classname), iv);
9354 =for apidoc sv_setref_uv
9356 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9357 argument will be upgraded to an RV. That RV will be modified to point to
9358 the new SV. The C<classname> argument indicates the package for the
9359 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9360 will have a reference count of 1, and the RV will be returned.
9366 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9368 PERL_ARGS_ASSERT_SV_SETREF_UV;
9370 sv_setuv(newSVrv(rv,classname), uv);
9375 =for apidoc sv_setref_nv
9377 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9378 argument will be upgraded to an RV. That RV will be modified to point to
9379 the new SV. The C<classname> argument indicates the package for the
9380 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9381 will have a reference count of 1, and the RV will be returned.
9387 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9389 PERL_ARGS_ASSERT_SV_SETREF_NV;
9391 sv_setnv(newSVrv(rv,classname), nv);
9396 =for apidoc sv_setref_pvn
9398 Copies a string into a new SV, optionally blessing the SV. The length of the
9399 string must be specified with C<n>. The C<rv> argument will be upgraded to
9400 an RV. That RV will be modified to point to the new SV. The C<classname>
9401 argument indicates the package for the blessing. Set C<classname> to
9402 C<NULL> to avoid the blessing. The new SV will have a reference count
9403 of 1, and the RV will be returned.
9405 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9411 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9412 const char *const pv, const STRLEN n)
9414 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9416 sv_setpvn(newSVrv(rv,classname), pv, n);
9421 =for apidoc sv_bless
9423 Blesses an SV into a specified package. The SV must be an RV. The package
9424 must be designated by its stash (see C<gv_stashpv()>). The reference count
9425 of the SV is unaffected.
9431 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9436 PERL_ARGS_ASSERT_SV_BLESS;
9439 Perl_croak(aTHX_ "Can't bless non-reference value");
9441 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9442 if (SvIsCOW(tmpRef))
9443 sv_force_normal_flags(tmpRef, 0);
9444 if (SvREADONLY(tmpRef))
9445 Perl_croak_no_modify(aTHX);
9446 if (SvOBJECT(tmpRef)) {
9447 if (SvTYPE(tmpRef) != SVt_PVIO)
9449 SvREFCNT_dec(SvSTASH(tmpRef));
9452 SvOBJECT_on(tmpRef);
9453 if (SvTYPE(tmpRef) != SVt_PVIO)
9455 SvUPGRADE(tmpRef, SVt_PVMG);
9456 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9461 (void)SvAMAGIC_off(sv);
9463 if(SvSMAGICAL(tmpRef))
9464 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9472 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9473 * as it is after unglobbing it.
9476 PERL_STATIC_INLINE void
9477 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9482 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9484 PERL_ARGS_ASSERT_SV_UNGLOB;
9486 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9488 if (!(flags & SV_COW_DROP_PV))
9489 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9492 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9493 && HvNAME_get(stash))
9494 mro_method_changed_in(stash);
9495 gp_free(MUTABLE_GV(sv));
9498 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9502 if (GvNAME_HEK(sv)) {
9503 unshare_hek(GvNAME_HEK(sv));
9505 isGV_with_GP_off(sv);
9507 if(SvTYPE(sv) == SVt_PVGV) {
9508 /* need to keep SvANY(sv) in the right arena */
9509 xpvmg = new_XPVMG();
9510 StructCopy(SvANY(sv), xpvmg, XPVMG);
9511 del_XPVGV(SvANY(sv));
9514 SvFLAGS(sv) &= ~SVTYPEMASK;
9515 SvFLAGS(sv) |= SVt_PVMG;
9518 /* Intentionally not calling any local SET magic, as this isn't so much a
9519 set operation as merely an internal storage change. */
9520 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9521 else sv_setsv_flags(sv, temp, 0);
9523 if ((const GV *)sv == PL_last_in_gv)
9524 PL_last_in_gv = NULL;
9528 =for apidoc sv_unref_flags
9530 Unsets the RV status of the SV, and decrements the reference count of
9531 whatever was being referenced by the RV. This can almost be thought of
9532 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9533 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9534 (otherwise the decrementing is conditional on the reference count being
9535 different from one or the reference being a readonly SV).
9542 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9544 SV* const target = SvRV(ref);
9546 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9548 if (SvWEAKREF(ref)) {
9549 sv_del_backref(target, ref);
9551 SvRV_set(ref, NULL);
9554 SvRV_set(ref, NULL);
9556 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9557 assigned to as BEGIN {$a = \"Foo"} will fail. */
9558 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9559 SvREFCNT_dec(target);
9560 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9561 sv_2mortal(target); /* Schedule for freeing later */
9565 =for apidoc sv_untaint
9567 Untaint an SV. Use C<SvTAINTED_off> instead.
9573 Perl_sv_untaint(pTHX_ SV *const sv)
9575 PERL_ARGS_ASSERT_SV_UNTAINT;
9577 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9578 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9585 =for apidoc sv_tainted
9587 Test an SV for taintedness. Use C<SvTAINTED> instead.
9593 Perl_sv_tainted(pTHX_ SV *const sv)
9595 PERL_ARGS_ASSERT_SV_TAINTED;
9597 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9598 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9599 if (mg && (mg->mg_len & 1) )
9606 =for apidoc sv_setpviv
9608 Copies an integer into the given SV, also updating its string value.
9609 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9615 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9617 char buf[TYPE_CHARS(UV)];
9619 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9621 PERL_ARGS_ASSERT_SV_SETPVIV;
9623 sv_setpvn(sv, ptr, ebuf - ptr);
9627 =for apidoc sv_setpviv_mg
9629 Like C<sv_setpviv>, but also handles 'set' magic.
9635 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9637 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9643 #if defined(PERL_IMPLICIT_CONTEXT)
9645 /* pTHX_ magic can't cope with varargs, so this is a no-context
9646 * version of the main function, (which may itself be aliased to us).
9647 * Don't access this version directly.
9651 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9656 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9658 va_start(args, pat);
9659 sv_vsetpvf(sv, pat, &args);
9663 /* pTHX_ magic can't cope with varargs, so this is a no-context
9664 * version of the main function, (which may itself be aliased to us).
9665 * Don't access this version directly.
9669 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9674 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9676 va_start(args, pat);
9677 sv_vsetpvf_mg(sv, pat, &args);
9683 =for apidoc sv_setpvf
9685 Works like C<sv_catpvf> but copies the text into the SV instead of
9686 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9692 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9696 PERL_ARGS_ASSERT_SV_SETPVF;
9698 va_start(args, pat);
9699 sv_vsetpvf(sv, pat, &args);
9704 =for apidoc sv_vsetpvf
9706 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9707 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9709 Usually used via its frontend C<sv_setpvf>.
9715 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9717 PERL_ARGS_ASSERT_SV_VSETPVF;
9719 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9723 =for apidoc sv_setpvf_mg
9725 Like C<sv_setpvf>, but also handles 'set' magic.
9731 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9735 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9737 va_start(args, pat);
9738 sv_vsetpvf_mg(sv, pat, &args);
9743 =for apidoc sv_vsetpvf_mg
9745 Like C<sv_vsetpvf>, but also handles 'set' magic.
9747 Usually used via its frontend C<sv_setpvf_mg>.
9753 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9755 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9757 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9761 #if defined(PERL_IMPLICIT_CONTEXT)
9763 /* pTHX_ magic can't cope with varargs, so this is a no-context
9764 * version of the main function, (which may itself be aliased to us).
9765 * Don't access this version directly.
9769 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9774 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9776 va_start(args, pat);
9777 sv_vcatpvf(sv, pat, &args);
9781 /* pTHX_ magic can't cope with varargs, so this is a no-context
9782 * version of the main function, (which may itself be aliased to us).
9783 * Don't access this version directly.
9787 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9792 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9794 va_start(args, pat);
9795 sv_vcatpvf_mg(sv, pat, &args);
9801 =for apidoc sv_catpvf
9803 Processes its arguments like C<sprintf> and appends the formatted
9804 output to an SV. If the appended data contains "wide" characters
9805 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9806 and characters >255 formatted with %c), the original SV might get
9807 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9808 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9809 valid UTF-8; if the original SV was bytes, the pattern should be too.
9814 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9818 PERL_ARGS_ASSERT_SV_CATPVF;
9820 va_start(args, pat);
9821 sv_vcatpvf(sv, pat, &args);
9826 =for apidoc sv_vcatpvf
9828 Processes its arguments like C<vsprintf> and appends the formatted output
9829 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9831 Usually used via its frontend C<sv_catpvf>.
9837 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9839 PERL_ARGS_ASSERT_SV_VCATPVF;
9841 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9845 =for apidoc sv_catpvf_mg
9847 Like C<sv_catpvf>, but also handles 'set' magic.
9853 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9857 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9859 va_start(args, pat);
9860 sv_vcatpvf_mg(sv, pat, &args);
9865 =for apidoc sv_vcatpvf_mg
9867 Like C<sv_vcatpvf>, but also handles 'set' magic.
9869 Usually used via its frontend C<sv_catpvf_mg>.
9875 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9877 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9879 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9884 =for apidoc sv_vsetpvfn
9886 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9889 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9895 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9896 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9898 PERL_ARGS_ASSERT_SV_VSETPVFN;
9901 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9906 * Warn of missing argument to sprintf, and then return a defined value
9907 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9909 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9911 S_vcatpvfn_missing_argument(pTHX) {
9912 if (ckWARN(WARN_MISSING)) {
9913 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9914 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9921 S_expect_number(pTHX_ char **const pattern)
9926 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9928 switch (**pattern) {
9929 case '1': case '2': case '3':
9930 case '4': case '5': case '6':
9931 case '7': case '8': case '9':
9932 var = *(*pattern)++ - '0';
9933 while (isDIGIT(**pattern)) {
9934 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9936 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9944 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9946 const int neg = nv < 0;
9949 PERL_ARGS_ASSERT_F0CONVERT;
9957 if (uv & 1 && uv == nv)
9958 uv--; /* Round to even */
9960 const unsigned dig = uv % 10;
9973 =for apidoc sv_vcatpvfn
9975 Processes its arguments like C<vsprintf> and appends the formatted output
9976 to an SV. Uses an array of SVs if the C style variable argument list is
9977 missing (NULL). When running with taint checks enabled, indicates via
9978 C<maybe_tainted> if results are untrustworthy (often due to the use of
9981 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9987 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
9988 vecstr = (U8*)SvPV_const(vecsv,veclen);\
9989 vec_utf8 = DO_UTF8(vecsv);
9991 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9994 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9995 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10000 const char *patend;
10003 static const char nullstr[] = "(null)";
10005 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10006 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10008 /* Times 4: a decimal digit takes more than 3 binary digits.
10009 * NV_DIG: mantissa takes than many decimal digits.
10010 * Plus 32: Playing safe. */
10011 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10012 /* large enough for "%#.#f" --chip */
10013 /* what about long double NVs? --jhi */
10015 PERL_ARGS_ASSERT_SV_VCATPVFN;
10016 PERL_UNUSED_ARG(maybe_tainted);
10018 /* no matter what, this is a string now */
10019 (void)SvPV_force(sv, origlen);
10021 /* special-case "", "%s", and "%-p" (SVf - see below) */
10024 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10026 const char * const s = va_arg(*args, char*);
10027 sv_catpv(sv, s ? s : nullstr);
10029 else if (svix < svmax) {
10030 sv_catsv(sv, *svargs);
10033 S_vcatpvfn_missing_argument(aTHX);
10036 if (args && patlen == 3 && pat[0] == '%' &&
10037 pat[1] == '-' && pat[2] == 'p') {
10038 argsv = MUTABLE_SV(va_arg(*args, void*));
10039 sv_catsv(sv, argsv);
10043 #ifndef USE_LONG_DOUBLE
10044 /* special-case "%.<number>[gf]" */
10045 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10046 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10047 unsigned digits = 0;
10051 while (*pp >= '0' && *pp <= '9')
10052 digits = 10 * digits + (*pp++ - '0');
10053 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10054 const NV nv = SvNV(*svargs);
10056 /* Add check for digits != 0 because it seems that some
10057 gconverts are buggy in this case, and we don't yet have
10058 a Configure test for this. */
10059 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10060 /* 0, point, slack */
10061 Gconvert(nv, (int)digits, 0, ebuf);
10062 sv_catpv(sv, ebuf);
10063 if (*ebuf) /* May return an empty string for digits==0 */
10066 } else if (!digits) {
10069 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10070 sv_catpvn(sv, p, l);
10076 #endif /* !USE_LONG_DOUBLE */
10078 if (!args && svix < svmax && DO_UTF8(*svargs))
10081 patend = (char*)pat + patlen;
10082 for (p = (char*)pat; p < patend; p = q) {
10085 bool vectorize = FALSE;
10086 bool vectorarg = FALSE;
10087 bool vec_utf8 = FALSE;
10093 bool has_precis = FALSE;
10095 const I32 osvix = svix;
10096 bool is_utf8 = FALSE; /* is this item utf8? */
10097 #ifdef HAS_LDBL_SPRINTF_BUG
10098 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10099 with sfio - Allen <allens@cpan.org> */
10100 bool fix_ldbl_sprintf_bug = FALSE;
10104 U8 utf8buf[UTF8_MAXBYTES+1];
10105 STRLEN esignlen = 0;
10107 const char *eptr = NULL;
10108 const char *fmtstart;
10111 const U8 *vecstr = NULL;
10118 /* we need a long double target in case HAS_LONG_DOUBLE but
10119 not USE_LONG_DOUBLE
10121 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10129 const char *dotstr = ".";
10130 STRLEN dotstrlen = 1;
10131 I32 efix = 0; /* explicit format parameter index */
10132 I32 ewix = 0; /* explicit width index */
10133 I32 epix = 0; /* explicit precision index */
10134 I32 evix = 0; /* explicit vector index */
10135 bool asterisk = FALSE;
10137 /* echo everything up to the next format specification */
10138 for (q = p; q < patend && *q != '%'; ++q) ;
10140 if (has_utf8 && !pat_utf8)
10141 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10143 sv_catpvn(sv, p, q - p);
10152 We allow format specification elements in this order:
10153 \d+\$ explicit format parameter index
10155 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10156 0 flag (as above): repeated to allow "v02"
10157 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10158 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10160 [%bcdefginopsuxDFOUX] format (mandatory)
10165 As of perl5.9.3, printf format checking is on by default.
10166 Internally, perl uses %p formats to provide an escape to
10167 some extended formatting. This block deals with those
10168 extensions: if it does not match, (char*)q is reset and
10169 the normal format processing code is used.
10171 Currently defined extensions are:
10172 %p include pointer address (standard)
10173 %-p (SVf) include an SV (previously %_)
10174 %-<num>p include an SV with precision <num>
10176 %3p include a HEK with precision of 256
10177 %<num>p (where num != 2 or 3) reserved for future
10180 Robin Barker 2005-07-14 (but modified since)
10182 %1p (VDf) removed. RMB 2007-10-19
10189 n = expect_number(&q);
10191 if (sv) { /* SVf */
10196 argsv = MUTABLE_SV(va_arg(*args, void*));
10197 eptr = SvPV_const(argsv, elen);
10198 if (DO_UTF8(argsv))
10202 else if (n==2 || n==3) { /* HEKf */
10203 HEK * const hek = va_arg(*args, HEK *);
10204 eptr = HEK_KEY(hek);
10205 elen = HEK_LEN(hek);
10206 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10207 if (n==3) precis = 256, has_precis = TRUE;
10211 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10212 "internal %%<num>p might conflict with future printf extensions");
10218 if ( (width = expect_number(&q)) ) {
10233 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10262 if ( (ewix = expect_number(&q)) )
10271 if ((vectorarg = asterisk)) {
10284 width = expect_number(&q);
10287 if (vectorize && vectorarg) {
10288 /* vectorizing, but not with the default "." */
10290 vecsv = va_arg(*args, SV*);
10292 vecsv = (evix > 0 && evix <= svmax)
10293 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10295 vecsv = svix < svmax
10296 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10298 dotstr = SvPV_const(vecsv, dotstrlen);
10299 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10300 bad with tied or overloaded values that return UTF8. */
10301 if (DO_UTF8(vecsv))
10303 else if (has_utf8) {
10304 vecsv = sv_mortalcopy(vecsv);
10305 sv_utf8_upgrade(vecsv);
10306 dotstr = SvPV_const(vecsv, dotstrlen);
10313 i = va_arg(*args, int);
10315 i = (ewix ? ewix <= svmax : svix < svmax) ?
10316 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10318 width = (i < 0) ? -i : i;
10328 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10330 /* XXX: todo, support specified precision parameter */
10334 i = va_arg(*args, int);
10336 i = (ewix ? ewix <= svmax : svix < svmax)
10337 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10339 has_precis = !(i < 0);
10343 while (isDIGIT(*q))
10344 precis = precis * 10 + (*q++ - '0');
10353 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10354 vecsv = svargs[efix ? efix-1 : svix++];
10355 vecstr = (U8*)SvPV_const(vecsv,veclen);
10356 vec_utf8 = DO_UTF8(vecsv);
10358 /* if this is a version object, we need to convert
10359 * back into v-string notation and then let the
10360 * vectorize happen normally
10362 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10363 char *version = savesvpv(vecsv);
10364 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10365 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10366 "vector argument not supported with alpha versions");
10369 vecsv = sv_newmortal();
10370 scan_vstring(version, version + veclen, vecsv);
10371 vecstr = (U8*)SvPV_const(vecsv, veclen);
10372 vec_utf8 = DO_UTF8(vecsv);
10386 case 'I': /* Ix, I32x, and I64x */
10388 if (q[1] == '6' && q[2] == '4') {
10394 if (q[1] == '3' && q[2] == '2') {
10404 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10416 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10417 if (*q == 'l') { /* lld, llf */
10426 if (*++q == 'h') { /* hhd, hhu */
10455 if (!vectorize && !args) {
10457 const I32 i = efix-1;
10458 argsv = (i >= 0 && i < svmax)
10459 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10461 argsv = (svix >= 0 && svix < svmax)
10462 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10466 switch (c = *q++) {
10473 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10475 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10477 eptr = (char*)utf8buf;
10478 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10492 eptr = va_arg(*args, char*);
10494 elen = strlen(eptr);
10496 eptr = (char *)nullstr;
10497 elen = sizeof nullstr - 1;
10501 eptr = SvPV_const(argsv, elen);
10502 if (DO_UTF8(argsv)) {
10503 STRLEN old_precis = precis;
10504 if (has_precis && precis < elen) {
10505 STRLEN ulen = sv_len_utf8(argsv);
10506 I32 p = precis > ulen ? ulen : precis;
10507 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10510 if (width) { /* fudge width (can't fudge elen) */
10511 if (has_precis && precis < elen)
10512 width += precis - old_precis;
10514 width += elen - sv_len_utf8(argsv);
10521 if (has_precis && precis < elen)
10528 if (alt || vectorize)
10530 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10551 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10560 esignbuf[esignlen++] = plus;
10564 case 'c': iv = (char)va_arg(*args, int); break;
10565 case 'h': iv = (short)va_arg(*args, int); break;
10566 case 'l': iv = va_arg(*args, long); break;
10567 case 'V': iv = va_arg(*args, IV); break;
10568 case 'z': iv = va_arg(*args, SSize_t); break;
10569 case 't': iv = va_arg(*args, ptrdiff_t); break;
10570 default: iv = va_arg(*args, int); break;
10572 case 'j': iv = va_arg(*args, intmax_t); break;
10576 iv = va_arg(*args, Quad_t); break;
10583 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10585 case 'c': iv = (char)tiv; break;
10586 case 'h': iv = (short)tiv; break;
10587 case 'l': iv = (long)tiv; break;
10589 default: iv = tiv; break;
10592 iv = (Quad_t)tiv; break;
10598 if ( !vectorize ) /* we already set uv above */
10603 esignbuf[esignlen++] = plus;
10607 esignbuf[esignlen++] = '-';
10651 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10662 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10663 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10664 case 'l': uv = va_arg(*args, unsigned long); break;
10665 case 'V': uv = va_arg(*args, UV); break;
10666 case 'z': uv = va_arg(*args, Size_t); break;
10667 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10669 case 'j': uv = va_arg(*args, uintmax_t); break;
10671 default: uv = va_arg(*args, unsigned); break;
10674 uv = va_arg(*args, Uquad_t); break;
10681 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10683 case 'c': uv = (unsigned char)tuv; break;
10684 case 'h': uv = (unsigned short)tuv; break;
10685 case 'l': uv = (unsigned long)tuv; break;
10687 default: uv = tuv; break;
10690 uv = (Uquad_t)tuv; break;
10699 char *ptr = ebuf + sizeof ebuf;
10700 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10706 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10710 } while (uv >>= 4);
10712 esignbuf[esignlen++] = '0';
10713 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10719 *--ptr = '0' + dig;
10720 } while (uv >>= 3);
10721 if (alt && *ptr != '0')
10727 *--ptr = '0' + dig;
10728 } while (uv >>= 1);
10730 esignbuf[esignlen++] = '0';
10731 esignbuf[esignlen++] = c;
10734 default: /* it had better be ten or less */
10737 *--ptr = '0' + dig;
10738 } while (uv /= base);
10741 elen = (ebuf + sizeof ebuf) - ptr;
10745 zeros = precis - elen;
10746 else if (precis == 0 && elen == 1 && *eptr == '0'
10747 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10750 /* a precision nullifies the 0 flag. */
10757 /* FLOATING POINT */
10760 c = 'f'; /* maybe %F isn't supported here */
10762 case 'e': case 'E':
10764 case 'g': case 'G':
10768 /* This is evil, but floating point is even more evil */
10770 /* for SV-style calling, we can only get NV
10771 for C-style calling, we assume %f is double;
10772 for simplicity we allow any of %Lf, %llf, %qf for long double
10776 #if defined(USE_LONG_DOUBLE)
10780 /* [perl #20339] - we should accept and ignore %lf rather than die */
10784 #if defined(USE_LONG_DOUBLE)
10785 intsize = args ? 0 : 'q';
10789 #if defined(HAS_LONG_DOUBLE)
10802 /* now we need (long double) if intsize == 'q', else (double) */
10804 #if LONG_DOUBLESIZE > DOUBLESIZE
10806 va_arg(*args, long double) :
10807 va_arg(*args, double)
10809 va_arg(*args, double)
10814 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10815 else. frexp() has some unspecified behaviour for those three */
10816 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10818 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10819 will cast our (long double) to (double) */
10820 (void)Perl_frexp(nv, &i);
10821 if (i == PERL_INT_MIN)
10822 Perl_die(aTHX_ "panic: frexp");
10824 need = BIT_DIGITS(i);
10826 need += has_precis ? precis : 6; /* known default */
10831 #ifdef HAS_LDBL_SPRINTF_BUG
10832 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10833 with sfio - Allen <allens@cpan.org> */
10836 # define MY_DBL_MAX DBL_MAX
10837 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10838 # if DOUBLESIZE >= 8
10839 # define MY_DBL_MAX 1.7976931348623157E+308L
10841 # define MY_DBL_MAX 3.40282347E+38L
10845 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10846 # define MY_DBL_MAX_BUG 1L
10848 # define MY_DBL_MAX_BUG MY_DBL_MAX
10852 # define MY_DBL_MIN DBL_MIN
10853 # else /* XXX guessing! -Allen */
10854 # if DOUBLESIZE >= 8
10855 # define MY_DBL_MIN 2.2250738585072014E-308L
10857 # define MY_DBL_MIN 1.17549435E-38L
10861 if ((intsize == 'q') && (c == 'f') &&
10862 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10863 (need < DBL_DIG)) {
10864 /* it's going to be short enough that
10865 * long double precision is not needed */
10867 if ((nv <= 0L) && (nv >= -0L))
10868 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10870 /* would use Perl_fp_class as a double-check but not
10871 * functional on IRIX - see perl.h comments */
10873 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10874 /* It's within the range that a double can represent */
10875 #if defined(DBL_MAX) && !defined(DBL_MIN)
10876 if ((nv >= ((long double)1/DBL_MAX)) ||
10877 (nv <= (-(long double)1/DBL_MAX)))
10879 fix_ldbl_sprintf_bug = TRUE;
10882 if (fix_ldbl_sprintf_bug == TRUE) {
10892 # undef MY_DBL_MAX_BUG
10895 #endif /* HAS_LDBL_SPRINTF_BUG */
10897 need += 20; /* fudge factor */
10898 if (PL_efloatsize < need) {
10899 Safefree(PL_efloatbuf);
10900 PL_efloatsize = need + 20; /* more fudge */
10901 Newx(PL_efloatbuf, PL_efloatsize, char);
10902 PL_efloatbuf[0] = '\0';
10905 if ( !(width || left || plus || alt) && fill != '0'
10906 && has_precis && intsize != 'q' ) { /* Shortcuts */
10907 /* See earlier comment about buggy Gconvert when digits,
10909 if ( c == 'g' && precis) {
10910 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10911 /* May return an empty string for digits==0 */
10912 if (*PL_efloatbuf) {
10913 elen = strlen(PL_efloatbuf);
10914 goto float_converted;
10916 } else if ( c == 'f' && !precis) {
10917 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10922 char *ptr = ebuf + sizeof ebuf;
10925 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10926 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10927 if (intsize == 'q') {
10928 /* Copy the one or more characters in a long double
10929 * format before the 'base' ([efgEFG]) character to
10930 * the format string. */
10931 static char const prifldbl[] = PERL_PRIfldbl;
10932 char const *p = prifldbl + sizeof(prifldbl) - 3;
10933 while (p >= prifldbl) { *--ptr = *p--; }
10938 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10943 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10955 /* No taint. Otherwise we are in the strange situation
10956 * where printf() taints but print($float) doesn't.
10958 #if defined(HAS_LONG_DOUBLE)
10959 elen = ((intsize == 'q')
10960 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10961 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10963 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10967 eptr = PL_efloatbuf;
10975 i = SvCUR(sv) - origlen;
10978 case 'c': *(va_arg(*args, char*)) = i; break;
10979 case 'h': *(va_arg(*args, short*)) = i; break;
10980 default: *(va_arg(*args, int*)) = i; break;
10981 case 'l': *(va_arg(*args, long*)) = i; break;
10982 case 'V': *(va_arg(*args, IV*)) = i; break;
10983 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
10984 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
10986 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
10990 *(va_arg(*args, Quad_t*)) = i; break;
10997 sv_setuv_mg(argsv, (UV)i);
10998 continue; /* not "break" */
11005 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11006 && ckWARN(WARN_PRINTF))
11008 SV * const msg = sv_newmortal();
11009 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11010 (PL_op->op_type == OP_PRTF) ? "" : "s");
11011 if (fmtstart < patend) {
11012 const char * const fmtend = q < patend ? q : patend;
11014 sv_catpvs(msg, "\"%");
11015 for (f = fmtstart; f < fmtend; f++) {
11017 sv_catpvn(msg, f, 1);
11019 Perl_sv_catpvf(aTHX_ msg,
11020 "\\%03"UVof, (UV)*f & 0xFF);
11023 sv_catpvs(msg, "\"");
11025 sv_catpvs(msg, "end of string");
11027 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11030 /* output mangled stuff ... */
11036 /* ... right here, because formatting flags should not apply */
11037 SvGROW(sv, SvCUR(sv) + elen + 1);
11039 Copy(eptr, p, elen, char);
11042 SvCUR_set(sv, p - SvPVX_const(sv));
11044 continue; /* not "break" */
11047 if (is_utf8 != has_utf8) {
11050 sv_utf8_upgrade(sv);
11053 const STRLEN old_elen = elen;
11054 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11055 sv_utf8_upgrade(nsv);
11056 eptr = SvPVX_const(nsv);
11059 if (width) { /* fudge width (can't fudge elen) */
11060 width += elen - old_elen;
11066 have = esignlen + zeros + elen;
11068 Perl_croak_nocontext("%s", PL_memory_wrap);
11070 need = (have > width ? have : width);
11073 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11074 Perl_croak_nocontext("%s", PL_memory_wrap);
11075 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11077 if (esignlen && fill == '0') {
11079 for (i = 0; i < (int)esignlen; i++)
11080 *p++ = esignbuf[i];
11082 if (gap && !left) {
11083 memset(p, fill, gap);
11086 if (esignlen && fill != '0') {
11088 for (i = 0; i < (int)esignlen; i++)
11089 *p++ = esignbuf[i];
11093 for (i = zeros; i; i--)
11097 Copy(eptr, p, elen, char);
11101 memset(p, ' ', gap);
11106 Copy(dotstr, p, dotstrlen, char);
11110 vectorize = FALSE; /* done iterating over vecstr */
11117 SvCUR_set(sv, p - SvPVX_const(sv));
11126 /* =========================================================================
11128 =head1 Cloning an interpreter
11130 All the macros and functions in this section are for the private use of
11131 the main function, perl_clone().
11133 The foo_dup() functions make an exact copy of an existing foo thingy.
11134 During the course of a cloning, a hash table is used to map old addresses
11135 to new addresses. The table is created and manipulated with the
11136 ptr_table_* functions.
11140 * =========================================================================*/
11143 #if defined(USE_ITHREADS)
11145 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11146 #ifndef GpREFCNT_inc
11147 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11151 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11152 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11153 If this changes, please unmerge ss_dup.
11154 Likewise, sv_dup_inc_multiple() relies on this fact. */
11155 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11156 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11157 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11158 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11159 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11160 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11161 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11162 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11163 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11164 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11165 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11166 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11167 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11169 /* clone a parser */
11172 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11176 PERL_ARGS_ASSERT_PARSER_DUP;
11181 /* look for it in the table first */
11182 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11186 /* create anew and remember what it is */
11187 Newxz(parser, 1, yy_parser);
11188 ptr_table_store(PL_ptr_table, proto, parser);
11190 /* XXX these not yet duped */
11191 parser->old_parser = NULL;
11192 parser->stack = NULL;
11194 parser->stack_size = 0;
11195 /* XXX parser->stack->state = 0; */
11197 /* XXX eventually, just Copy() most of the parser struct ? */
11199 parser->lex_brackets = proto->lex_brackets;
11200 parser->lex_casemods = proto->lex_casemods;
11201 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11202 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11203 parser->lex_casestack = savepvn(proto->lex_casestack,
11204 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11205 parser->lex_defer = proto->lex_defer;
11206 parser->lex_dojoin = proto->lex_dojoin;
11207 parser->lex_expect = proto->lex_expect;
11208 parser->lex_formbrack = proto->lex_formbrack;
11209 parser->lex_inpat = proto->lex_inpat;
11210 parser->lex_inwhat = proto->lex_inwhat;
11211 parser->lex_op = proto->lex_op;
11212 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11213 parser->lex_starts = proto->lex_starts;
11214 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11215 parser->multi_close = proto->multi_close;
11216 parser->multi_open = proto->multi_open;
11217 parser->multi_start = proto->multi_start;
11218 parser->multi_end = proto->multi_end;
11219 parser->pending_ident = proto->pending_ident;
11220 parser->preambled = proto->preambled;
11221 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11222 parser->linestr = sv_dup_inc(proto->linestr, param);
11223 parser->expect = proto->expect;
11224 parser->copline = proto->copline;
11225 parser->last_lop_op = proto->last_lop_op;
11226 parser->lex_state = proto->lex_state;
11227 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11228 /* rsfp_filters entries have fake IoDIRP() */
11229 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11230 parser->in_my = proto->in_my;
11231 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11232 parser->error_count = proto->error_count;
11235 parser->linestr = sv_dup_inc(proto->linestr, param);
11238 char * const ols = SvPVX(proto->linestr);
11239 char * const ls = SvPVX(parser->linestr);
11241 parser->bufptr = ls + (proto->bufptr >= ols ?
11242 proto->bufptr - ols : 0);
11243 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11244 proto->oldbufptr - ols : 0);
11245 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11246 proto->oldoldbufptr - ols : 0);
11247 parser->linestart = ls + (proto->linestart >= ols ?
11248 proto->linestart - ols : 0);
11249 parser->last_uni = ls + (proto->last_uni >= ols ?
11250 proto->last_uni - ols : 0);
11251 parser->last_lop = ls + (proto->last_lop >= ols ?
11252 proto->last_lop - ols : 0);
11254 parser->bufend = ls + SvCUR(parser->linestr);
11257 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11261 parser->endwhite = proto->endwhite;
11262 parser->faketokens = proto->faketokens;
11263 parser->lasttoke = proto->lasttoke;
11264 parser->nextwhite = proto->nextwhite;
11265 parser->realtokenstart = proto->realtokenstart;
11266 parser->skipwhite = proto->skipwhite;
11267 parser->thisclose = proto->thisclose;
11268 parser->thismad = proto->thismad;
11269 parser->thisopen = proto->thisopen;
11270 parser->thisstuff = proto->thisstuff;
11271 parser->thistoken = proto->thistoken;
11272 parser->thiswhite = proto->thiswhite;
11274 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11275 parser->curforce = proto->curforce;
11277 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11278 Copy(proto->nexttype, parser->nexttype, 5, I32);
11279 parser->nexttoke = proto->nexttoke;
11282 /* XXX should clone saved_curcop here, but we aren't passed
11283 * proto_perl; so do it in perl_clone_using instead */
11289 /* duplicate a file handle */
11292 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11296 PERL_ARGS_ASSERT_FP_DUP;
11297 PERL_UNUSED_ARG(type);
11300 return (PerlIO*)NULL;
11302 /* look for it in the table first */
11303 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11307 /* create anew and remember what it is */
11308 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11309 ptr_table_store(PL_ptr_table, fp, ret);
11313 /* duplicate a directory handle */
11316 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11322 register const Direntry_t *dirent;
11323 char smallbuf[256];
11329 PERL_UNUSED_CONTEXT;
11330 PERL_ARGS_ASSERT_DIRP_DUP;
11335 /* look for it in the table first */
11336 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11342 PERL_UNUSED_ARG(param);
11346 /* open the current directory (so we can switch back) */
11347 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11349 /* chdir to our dir handle and open the present working directory */
11350 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11351 PerlDir_close(pwd);
11352 return (DIR *)NULL;
11354 /* Now we should have two dir handles pointing to the same dir. */
11356 /* Be nice to the calling code and chdir back to where we were. */
11357 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11359 /* We have no need of the pwd handle any more. */
11360 PerlDir_close(pwd);
11363 # define d_namlen(d) (d)->d_namlen
11365 # define d_namlen(d) strlen((d)->d_name)
11367 /* Iterate once through dp, to get the file name at the current posi-
11368 tion. Then step back. */
11369 pos = PerlDir_tell(dp);
11370 if ((dirent = PerlDir_read(dp))) {
11371 len = d_namlen(dirent);
11372 if (len <= sizeof smallbuf) name = smallbuf;
11373 else Newx(name, len, char);
11374 Move(dirent->d_name, name, len, char);
11376 PerlDir_seek(dp, pos);
11378 /* Iterate through the new dir handle, till we find a file with the
11380 if (!dirent) /* just before the end */
11382 pos = PerlDir_tell(ret);
11383 if (PerlDir_read(ret)) continue; /* not there yet */
11384 PerlDir_seek(ret, pos); /* step back */
11388 const long pos0 = PerlDir_tell(ret);
11390 pos = PerlDir_tell(ret);
11391 if ((dirent = PerlDir_read(ret))) {
11392 if (len == d_namlen(dirent)
11393 && memEQ(name, dirent->d_name, len)) {
11395 PerlDir_seek(ret, pos); /* step back */
11398 /* else we are not there yet; keep iterating */
11400 else { /* This is not meant to happen. The best we can do is
11401 reset the iterator to the beginning. */
11402 PerlDir_seek(ret, pos0);
11409 if (name && name != smallbuf)
11414 ret = win32_dirp_dup(dp, param);
11417 /* pop it in the pointer table */
11419 ptr_table_store(PL_ptr_table, dp, ret);
11424 /* duplicate a typeglob */
11427 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11431 PERL_ARGS_ASSERT_GP_DUP;
11435 /* look for it in the table first */
11436 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11440 /* create anew and remember what it is */
11442 ptr_table_store(PL_ptr_table, gp, ret);
11445 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11446 on Newxz() to do this for us. */
11447 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11448 ret->gp_io = io_dup_inc(gp->gp_io, param);
11449 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11450 ret->gp_av = av_dup_inc(gp->gp_av, param);
11451 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11452 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11453 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11454 ret->gp_cvgen = gp->gp_cvgen;
11455 ret->gp_line = gp->gp_line;
11456 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11460 /* duplicate a chain of magic */
11463 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11465 MAGIC *mgret = NULL;
11466 MAGIC **mgprev_p = &mgret;
11468 PERL_ARGS_ASSERT_MG_DUP;
11470 for (; mg; mg = mg->mg_moremagic) {
11473 if ((param->flags & CLONEf_JOIN_IN)
11474 && mg->mg_type == PERL_MAGIC_backref)
11475 /* when joining, we let the individual SVs add themselves to
11476 * backref as needed. */
11479 Newx(nmg, 1, MAGIC);
11481 mgprev_p = &(nmg->mg_moremagic);
11483 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11484 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11485 from the original commit adding Perl_mg_dup() - revision 4538.
11486 Similarly there is the annotation "XXX random ptr?" next to the
11487 assignment to nmg->mg_ptr. */
11490 /* FIXME for plugins
11491 if (nmg->mg_type == PERL_MAGIC_qr) {
11492 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11496 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11497 ? nmg->mg_type == PERL_MAGIC_backref
11498 /* The backref AV has its reference
11499 * count deliberately bumped by 1 */
11500 ? SvREFCNT_inc(av_dup_inc((const AV *)
11501 nmg->mg_obj, param))
11502 : sv_dup_inc(nmg->mg_obj, param)
11503 : sv_dup(nmg->mg_obj, param);
11505 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11506 if (nmg->mg_len > 0) {
11507 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11508 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11509 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11511 AMT * const namtp = (AMT*)nmg->mg_ptr;
11512 sv_dup_inc_multiple((SV**)(namtp->table),
11513 (SV**)(namtp->table), NofAMmeth, param);
11516 else if (nmg->mg_len == HEf_SVKEY)
11517 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11519 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11520 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11526 #endif /* USE_ITHREADS */
11528 struct ptr_tbl_arena {
11529 struct ptr_tbl_arena *next;
11530 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11533 /* create a new pointer-mapping table */
11536 Perl_ptr_table_new(pTHX)
11539 PERL_UNUSED_CONTEXT;
11541 Newx(tbl, 1, PTR_TBL_t);
11542 tbl->tbl_max = 511;
11543 tbl->tbl_items = 0;
11544 tbl->tbl_arena = NULL;
11545 tbl->tbl_arena_next = NULL;
11546 tbl->tbl_arena_end = NULL;
11547 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11551 #define PTR_TABLE_HASH(ptr) \
11552 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11554 /* map an existing pointer using a table */
11556 STATIC PTR_TBL_ENT_t *
11557 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11559 PTR_TBL_ENT_t *tblent;
11560 const UV hash = PTR_TABLE_HASH(sv);
11562 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11564 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11565 for (; tblent; tblent = tblent->next) {
11566 if (tblent->oldval == sv)
11573 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11575 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11577 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11578 PERL_UNUSED_CONTEXT;
11580 return tblent ? tblent->newval : NULL;
11583 /* add a new entry to a pointer-mapping table */
11586 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11588 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11590 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11591 PERL_UNUSED_CONTEXT;
11594 tblent->newval = newsv;
11596 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11598 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11599 struct ptr_tbl_arena *new_arena;
11601 Newx(new_arena, 1, struct ptr_tbl_arena);
11602 new_arena->next = tbl->tbl_arena;
11603 tbl->tbl_arena = new_arena;
11604 tbl->tbl_arena_next = new_arena->array;
11605 tbl->tbl_arena_end = new_arena->array
11606 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11609 tblent = tbl->tbl_arena_next++;
11611 tblent->oldval = oldsv;
11612 tblent->newval = newsv;
11613 tblent->next = tbl->tbl_ary[entry];
11614 tbl->tbl_ary[entry] = tblent;
11616 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11617 ptr_table_split(tbl);
11621 /* double the hash bucket size of an existing ptr table */
11624 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11626 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11627 const UV oldsize = tbl->tbl_max + 1;
11628 UV newsize = oldsize * 2;
11631 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11632 PERL_UNUSED_CONTEXT;
11634 Renew(ary, newsize, PTR_TBL_ENT_t*);
11635 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11636 tbl->tbl_max = --newsize;
11637 tbl->tbl_ary = ary;
11638 for (i=0; i < oldsize; i++, ary++) {
11639 PTR_TBL_ENT_t **entp = ary;
11640 PTR_TBL_ENT_t *ent = *ary;
11641 PTR_TBL_ENT_t **curentp;
11644 curentp = ary + oldsize;
11646 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11648 ent->next = *curentp;
11658 /* remove all the entries from a ptr table */
11659 /* Deprecated - will be removed post 5.14 */
11662 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11664 if (tbl && tbl->tbl_items) {
11665 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11667 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11670 struct ptr_tbl_arena *next = arena->next;
11676 tbl->tbl_items = 0;
11677 tbl->tbl_arena = NULL;
11678 tbl->tbl_arena_next = NULL;
11679 tbl->tbl_arena_end = NULL;
11683 /* clear and free a ptr table */
11686 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11688 struct ptr_tbl_arena *arena;
11694 arena = tbl->tbl_arena;
11697 struct ptr_tbl_arena *next = arena->next;
11703 Safefree(tbl->tbl_ary);
11707 #if defined(USE_ITHREADS)
11710 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11712 PERL_ARGS_ASSERT_RVPV_DUP;
11715 if (SvWEAKREF(sstr)) {
11716 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11717 if (param->flags & CLONEf_JOIN_IN) {
11718 /* if joining, we add any back references individually rather
11719 * than copying the whole backref array */
11720 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11724 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11726 else if (SvPVX_const(sstr)) {
11727 /* Has something there */
11729 /* Normal PV - clone whole allocated space */
11730 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11731 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11732 /* Not that normal - actually sstr is copy on write.
11733 But we are a true, independent SV, so: */
11734 SvREADONLY_off(dstr);
11739 /* Special case - not normally malloced for some reason */
11740 if (isGV_with_GP(sstr)) {
11741 /* Don't need to do anything here. */
11743 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11744 /* A "shared" PV - clone it as "shared" PV */
11746 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11750 /* Some other special case - random pointer */
11751 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11756 /* Copy the NULL */
11757 SvPV_set(dstr, NULL);
11761 /* duplicate a list of SVs. source and dest may point to the same memory. */
11763 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11764 SSize_t items, CLONE_PARAMS *const param)
11766 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11768 while (items-- > 0) {
11769 *dest++ = sv_dup_inc(*source++, param);
11775 /* duplicate an SV of any type (including AV, HV etc) */
11778 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11783 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11785 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11786 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11791 /* look for it in the table first */
11792 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11796 if(param->flags & CLONEf_JOIN_IN) {
11797 /** We are joining here so we don't want do clone
11798 something that is bad **/
11799 if (SvTYPE(sstr) == SVt_PVHV) {
11800 const HEK * const hvname = HvNAME_HEK(sstr);
11802 /** don't clone stashes if they already exist **/
11803 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11804 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11805 ptr_table_store(PL_ptr_table, sstr, dstr);
11811 /* create anew and remember what it is */
11814 #ifdef DEBUG_LEAKING_SCALARS
11815 dstr->sv_debug_optype = sstr->sv_debug_optype;
11816 dstr->sv_debug_line = sstr->sv_debug_line;
11817 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11818 dstr->sv_debug_parent = (SV*)sstr;
11819 FREE_SV_DEBUG_FILE(dstr);
11820 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11823 ptr_table_store(PL_ptr_table, sstr, dstr);
11826 SvFLAGS(dstr) = SvFLAGS(sstr);
11827 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11828 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11831 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11832 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11833 (void*)PL_watch_pvx, SvPVX_const(sstr));
11836 /* don't clone objects whose class has asked us not to */
11837 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11842 switch (SvTYPE(sstr)) {
11844 SvANY(dstr) = NULL;
11847 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11849 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11851 SvIV_set(dstr, SvIVX(sstr));
11855 SvANY(dstr) = new_XNV();
11856 SvNV_set(dstr, SvNVX(sstr));
11858 /* case SVt_BIND: */
11861 /* These are all the types that need complex bodies allocating. */
11863 const svtype sv_type = SvTYPE(sstr);
11864 const struct body_details *const sv_type_details
11865 = bodies_by_type + sv_type;
11869 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11884 assert(sv_type_details->body_size);
11885 if (sv_type_details->arena) {
11886 new_body_inline(new_body, sv_type);
11888 = (void*)((char*)new_body - sv_type_details->offset);
11890 new_body = new_NOARENA(sv_type_details);
11894 SvANY(dstr) = new_body;
11897 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11898 ((char*)SvANY(dstr)) + sv_type_details->offset,
11899 sv_type_details->copy, char);
11901 Copy(((char*)SvANY(sstr)),
11902 ((char*)SvANY(dstr)),
11903 sv_type_details->body_size + sv_type_details->offset, char);
11906 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11907 && !isGV_with_GP(dstr)
11908 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11909 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11911 /* The Copy above means that all the source (unduplicated) pointers
11912 are now in the destination. We can check the flags and the
11913 pointers in either, but it's possible that there's less cache
11914 missing by always going for the destination.
11915 FIXME - instrument and check that assumption */
11916 if (sv_type >= SVt_PVMG) {
11917 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11918 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11919 } else if (SvMAGIC(dstr))
11920 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11922 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11925 /* The cast silences a GCC warning about unhandled types. */
11926 switch ((int)sv_type) {
11936 /* FIXME for plugins */
11937 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11940 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11941 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11942 LvTARG(dstr) = dstr;
11943 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11944 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11946 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11948 /* non-GP case already handled above */
11949 if(isGV_with_GP(sstr)) {
11950 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11951 /* Don't call sv_add_backref here as it's going to be
11952 created as part of the magic cloning of the symbol
11953 table--unless this is during a join and the stash
11954 is not actually being cloned. */
11955 /* Danger Will Robinson - GvGP(dstr) isn't initialised
11956 at the point of this comment. */
11957 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11958 if (param->flags & CLONEf_JOIN_IN)
11959 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
11960 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
11961 (void)GpREFCNT_inc(GvGP(dstr));
11965 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11966 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11967 /* I have no idea why fake dirp (rsfps)
11968 should be treated differently but otherwise
11969 we end up with leaks -- sky*/
11970 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
11971 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
11972 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11974 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
11975 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
11976 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
11977 if (IoDIRP(dstr)) {
11978 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
11981 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
11983 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
11985 if (IoOFP(dstr) == IoIFP(sstr))
11986 IoOFP(dstr) = IoIFP(dstr);
11988 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11989 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
11990 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
11991 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
11994 /* avoid cloning an empty array */
11995 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11996 SV **dst_ary, **src_ary;
11997 SSize_t items = AvFILLp((const AV *)sstr) + 1;
11999 src_ary = AvARRAY((const AV *)sstr);
12000 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12001 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12002 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12003 AvALLOC((const AV *)dstr) = dst_ary;
12004 if (AvREAL((const AV *)sstr)) {
12005 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12009 while (items-- > 0)
12010 *dst_ary++ = sv_dup(*src_ary++, param);
12012 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12013 while (items-- > 0) {
12014 *dst_ary++ = &PL_sv_undef;
12018 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12019 AvALLOC((const AV *)dstr) = (SV**)NULL;
12020 AvMAX( (const AV *)dstr) = -1;
12021 AvFILLp((const AV *)dstr) = -1;
12025 if (HvARRAY((const HV *)sstr)) {
12027 const bool sharekeys = !!HvSHAREKEYS(sstr);
12028 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12029 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12031 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12032 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12034 HvARRAY(dstr) = (HE**)darray;
12035 while (i <= sxhv->xhv_max) {
12036 const HE * const source = HvARRAY(sstr)[i];
12037 HvARRAY(dstr)[i] = source
12038 ? he_dup(source, sharekeys, param) : 0;
12042 const struct xpvhv_aux * const saux = HvAUX(sstr);
12043 struct xpvhv_aux * const daux = HvAUX(dstr);
12044 /* This flag isn't copied. */
12047 if (saux->xhv_name_count) {
12048 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12050 = saux->xhv_name_count < 0
12051 ? -saux->xhv_name_count
12052 : saux->xhv_name_count;
12053 HEK **shekp = sname + count;
12055 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12056 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12057 while (shekp-- > sname) {
12059 *dhekp = hek_dup(*shekp, param);
12063 daux->xhv_name_u.xhvnameu_name
12064 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12067 daux->xhv_name_count = saux->xhv_name_count;
12069 daux->xhv_riter = saux->xhv_riter;
12070 daux->xhv_eiter = saux->xhv_eiter
12071 ? he_dup(saux->xhv_eiter,
12072 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12073 /* backref array needs refcnt=2; see sv_add_backref */
12074 daux->xhv_backreferences =
12075 (param->flags & CLONEf_JOIN_IN)
12076 /* when joining, we let the individual GVs and
12077 * CVs add themselves to backref as
12078 * needed. This avoids pulling in stuff
12079 * that isn't required, and simplifies the
12080 * case where stashes aren't cloned back
12081 * if they already exist in the parent
12084 : saux->xhv_backreferences
12085 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12086 ? MUTABLE_AV(SvREFCNT_inc(
12087 sv_dup_inc((const SV *)
12088 saux->xhv_backreferences, param)))
12089 : MUTABLE_AV(sv_dup((const SV *)
12090 saux->xhv_backreferences, param))
12093 daux->xhv_mro_meta = saux->xhv_mro_meta
12094 ? mro_meta_dup(saux->xhv_mro_meta, param)
12097 /* Record stashes for possible cloning in Perl_clone(). */
12099 av_push(param->stashes, dstr);
12103 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12106 if (!(param->flags & CLONEf_COPY_STACKS)) {
12111 /* NOTE: not refcounted */
12112 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12113 hv_dup(CvSTASH(dstr), param);
12114 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12115 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12116 if (!CvISXSUB(dstr)) {
12118 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12120 } else if (CvCONST(dstr)) {
12121 CvXSUBANY(dstr).any_ptr =
12122 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12124 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12125 /* don't dup if copying back - CvGV isn't refcounted, so the
12126 * duped GV may never be freed. A bit of a hack! DAPM */
12127 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12129 ? gv_dup_inc(CvGV(sstr), param)
12130 : (param->flags & CLONEf_JOIN_IN)
12132 : gv_dup(CvGV(sstr), param);
12134 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12136 CvWEAKOUTSIDE(sstr)
12137 ? cv_dup( CvOUTSIDE(dstr), param)
12138 : cv_dup_inc(CvOUTSIDE(dstr), param);
12144 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12151 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12153 PERL_ARGS_ASSERT_SV_DUP_INC;
12154 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12158 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12160 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12161 PERL_ARGS_ASSERT_SV_DUP;
12163 /* Track every SV that (at least initially) had a reference count of 0.
12164 We need to do this by holding an actual reference to it in this array.
12165 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12166 (akin to the stashes hash, and the perl stack), we come unstuck if
12167 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12168 thread) is manipulated in a CLONE method, because CLONE runs before the
12169 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12170 (and fix things up by giving each a reference via the temps stack).
12171 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12172 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12173 before the walk of unreferenced happens and a reference to that is SV
12174 added to the temps stack. At which point we have the same SV considered
12175 to be in use, and free to be re-used. Not good.
12177 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12178 assert(param->unreferenced);
12179 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12185 /* duplicate a context */
12188 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12190 PERL_CONTEXT *ncxs;
12192 PERL_ARGS_ASSERT_CX_DUP;
12195 return (PERL_CONTEXT*)NULL;
12197 /* look for it in the table first */
12198 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12202 /* create anew and remember what it is */
12203 Newx(ncxs, max + 1, PERL_CONTEXT);
12204 ptr_table_store(PL_ptr_table, cxs, ncxs);
12205 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12208 PERL_CONTEXT * const ncx = &ncxs[ix];
12209 if (CxTYPE(ncx) == CXt_SUBST) {
12210 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12213 switch (CxTYPE(ncx)) {
12215 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12216 ? cv_dup_inc(ncx->blk_sub.cv, param)
12217 : cv_dup(ncx->blk_sub.cv,param));
12218 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12219 ? av_dup_inc(ncx->blk_sub.argarray,
12222 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12224 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12225 ncx->blk_sub.oldcomppad);
12228 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12230 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12232 case CXt_LOOP_LAZYSV:
12233 ncx->blk_loop.state_u.lazysv.end
12234 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12235 /* We are taking advantage of av_dup_inc and sv_dup_inc
12236 actually being the same function, and order equivalence of
12238 We can assert the later [but only at run time :-(] */
12239 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12240 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12242 ncx->blk_loop.state_u.ary.ary
12243 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12244 case CXt_LOOP_LAZYIV:
12245 case CXt_LOOP_PLAIN:
12246 if (CxPADLOOP(ncx)) {
12247 ncx->blk_loop.itervar_u.oldcomppad
12248 = (PAD*)ptr_table_fetch(PL_ptr_table,
12249 ncx->blk_loop.itervar_u.oldcomppad);
12251 ncx->blk_loop.itervar_u.gv
12252 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12257 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12258 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12259 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12272 /* duplicate a stack info structure */
12275 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12279 PERL_ARGS_ASSERT_SI_DUP;
12282 return (PERL_SI*)NULL;
12284 /* look for it in the table first */
12285 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12289 /* create anew and remember what it is */
12290 Newxz(nsi, 1, PERL_SI);
12291 ptr_table_store(PL_ptr_table, si, nsi);
12293 nsi->si_stack = av_dup_inc(si->si_stack, param);
12294 nsi->si_cxix = si->si_cxix;
12295 nsi->si_cxmax = si->si_cxmax;
12296 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12297 nsi->si_type = si->si_type;
12298 nsi->si_prev = si_dup(si->si_prev, param);
12299 nsi->si_next = si_dup(si->si_next, param);
12300 nsi->si_markoff = si->si_markoff;
12305 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12306 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12307 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12308 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12309 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12310 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12311 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12312 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12313 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12314 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12315 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12316 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12317 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12318 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12319 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12320 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12323 #define pv_dup_inc(p) SAVEPV(p)
12324 #define pv_dup(p) SAVEPV(p)
12325 #define svp_dup_inc(p,pp) any_dup(p,pp)
12327 /* map any object to the new equivent - either something in the
12328 * ptr table, or something in the interpreter structure
12332 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12336 PERL_ARGS_ASSERT_ANY_DUP;
12339 return (void*)NULL;
12341 /* look for it in the table first */
12342 ret = ptr_table_fetch(PL_ptr_table, v);
12346 /* see if it is part of the interpreter structure */
12347 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12348 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12356 /* duplicate the save stack */
12359 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12362 ANY * const ss = proto_perl->Isavestack;
12363 const I32 max = proto_perl->Isavestack_max;
12364 I32 ix = proto_perl->Isavestack_ix;
12377 void (*dptr) (void*);
12378 void (*dxptr) (pTHX_ void*);
12380 PERL_ARGS_ASSERT_SS_DUP;
12382 Newxz(nss, max, ANY);
12385 const UV uv = POPUV(ss,ix);
12386 const U8 type = (U8)uv & SAVE_MASK;
12388 TOPUV(nss,ix) = uv;
12390 case SAVEt_CLEARSV:
12392 case SAVEt_HELEM: /* hash element */
12393 sv = (const SV *)POPPTR(ss,ix);
12394 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12396 case SAVEt_ITEM: /* normal string */
12397 case SAVEt_GVSV: /* scalar slot in GV */
12398 case SAVEt_SV: /* scalar reference */
12399 sv = (const SV *)POPPTR(ss,ix);
12400 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12403 case SAVEt_MORTALIZESV:
12404 sv = (const SV *)POPPTR(ss,ix);
12405 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12407 case SAVEt_SHARED_PVREF: /* char* in shared space */
12408 c = (char*)POPPTR(ss,ix);
12409 TOPPTR(nss,ix) = savesharedpv(c);
12410 ptr = POPPTR(ss,ix);
12411 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12413 case SAVEt_GENERIC_SVREF: /* generic sv */
12414 case SAVEt_SVREF: /* scalar reference */
12415 sv = (const SV *)POPPTR(ss,ix);
12416 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12417 ptr = POPPTR(ss,ix);
12418 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12420 case SAVEt_HV: /* hash reference */
12421 case SAVEt_AV: /* array reference */
12422 sv = (const SV *) POPPTR(ss,ix);
12423 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12425 case SAVEt_COMPPAD:
12427 sv = (const SV *) POPPTR(ss,ix);
12428 TOPPTR(nss,ix) = sv_dup(sv, param);
12430 case SAVEt_INT: /* int reference */
12431 ptr = POPPTR(ss,ix);
12432 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12433 intval = (int)POPINT(ss,ix);
12434 TOPINT(nss,ix) = intval;
12436 case SAVEt_LONG: /* long reference */
12437 ptr = POPPTR(ss,ix);
12438 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12439 longval = (long)POPLONG(ss,ix);
12440 TOPLONG(nss,ix) = longval;
12442 case SAVEt_I32: /* I32 reference */
12443 ptr = POPPTR(ss,ix);
12444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12446 TOPINT(nss,ix) = i;
12448 case SAVEt_IV: /* IV reference */
12449 ptr = POPPTR(ss,ix);
12450 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12452 TOPIV(nss,ix) = iv;
12454 case SAVEt_HPTR: /* HV* reference */
12455 case SAVEt_APTR: /* AV* reference */
12456 case SAVEt_SPTR: /* SV* reference */
12457 ptr = POPPTR(ss,ix);
12458 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12459 sv = (const SV *)POPPTR(ss,ix);
12460 TOPPTR(nss,ix) = sv_dup(sv, param);
12462 case SAVEt_VPTR: /* random* reference */
12463 ptr = POPPTR(ss,ix);
12464 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12466 case SAVEt_INT_SMALL:
12467 case SAVEt_I32_SMALL:
12468 case SAVEt_I16: /* I16 reference */
12469 case SAVEt_I8: /* I8 reference */
12471 ptr = POPPTR(ss,ix);
12472 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12474 case SAVEt_GENERIC_PVREF: /* generic char* */
12475 case SAVEt_PPTR: /* char* reference */
12476 ptr = POPPTR(ss,ix);
12477 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12478 c = (char*)POPPTR(ss,ix);
12479 TOPPTR(nss,ix) = pv_dup(c);
12481 case SAVEt_GP: /* scalar reference */
12482 gp = (GP*)POPPTR(ss,ix);
12483 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12484 (void)GpREFCNT_inc(gp);
12485 gv = (const GV *)POPPTR(ss,ix);
12486 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12489 ptr = POPPTR(ss,ix);
12490 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12491 /* these are assumed to be refcounted properly */
12493 switch (((OP*)ptr)->op_type) {
12495 case OP_LEAVESUBLV:
12499 case OP_LEAVEWRITE:
12500 TOPPTR(nss,ix) = ptr;
12503 (void) OpREFCNT_inc(o);
12507 TOPPTR(nss,ix) = NULL;
12512 TOPPTR(nss,ix) = NULL;
12514 case SAVEt_FREECOPHH:
12515 ptr = POPPTR(ss,ix);
12516 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12519 hv = (const HV *)POPPTR(ss,ix);
12520 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12522 TOPINT(nss,ix) = i;
12525 c = (char*)POPPTR(ss,ix);
12526 TOPPTR(nss,ix) = pv_dup_inc(c);
12528 case SAVEt_STACK_POS: /* Position on Perl stack */
12530 TOPINT(nss,ix) = i;
12532 case SAVEt_DESTRUCTOR:
12533 ptr = POPPTR(ss,ix);
12534 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12535 dptr = POPDPTR(ss,ix);
12536 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12537 any_dup(FPTR2DPTR(void *, dptr),
12540 case SAVEt_DESTRUCTOR_X:
12541 ptr = POPPTR(ss,ix);
12542 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12543 dxptr = POPDXPTR(ss,ix);
12544 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12545 any_dup(FPTR2DPTR(void *, dxptr),
12548 case SAVEt_REGCONTEXT:
12550 ix -= uv >> SAVE_TIGHT_SHIFT;
12552 case SAVEt_AELEM: /* array element */
12553 sv = (const SV *)POPPTR(ss,ix);
12554 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12556 TOPINT(nss,ix) = i;
12557 av = (const AV *)POPPTR(ss,ix);
12558 TOPPTR(nss,ix) = av_dup_inc(av, param);
12561 ptr = POPPTR(ss,ix);
12562 TOPPTR(nss,ix) = ptr;
12565 ptr = POPPTR(ss,ix);
12566 ptr = cophh_copy((COPHH*)ptr);
12567 TOPPTR(nss,ix) = ptr;
12569 TOPINT(nss,ix) = i;
12570 if (i & HINT_LOCALIZE_HH) {
12571 hv = (const HV *)POPPTR(ss,ix);
12572 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12575 case SAVEt_PADSV_AND_MORTALIZE:
12576 longval = (long)POPLONG(ss,ix);
12577 TOPLONG(nss,ix) = longval;
12578 ptr = POPPTR(ss,ix);
12579 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12580 sv = (const SV *)POPPTR(ss,ix);
12581 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12583 case SAVEt_SET_SVFLAGS:
12585 TOPINT(nss,ix) = i;
12587 TOPINT(nss,ix) = i;
12588 sv = (const SV *)POPPTR(ss,ix);
12589 TOPPTR(nss,ix) = sv_dup(sv, param);
12591 case SAVEt_RE_STATE:
12593 const struct re_save_state *const old_state
12594 = (struct re_save_state *)
12595 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12596 struct re_save_state *const new_state
12597 = (struct re_save_state *)
12598 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12600 Copy(old_state, new_state, 1, struct re_save_state);
12601 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12603 new_state->re_state_bostr
12604 = pv_dup(old_state->re_state_bostr);
12605 new_state->re_state_reginput
12606 = pv_dup(old_state->re_state_reginput);
12607 new_state->re_state_regeol
12608 = pv_dup(old_state->re_state_regeol);
12609 new_state->re_state_regoffs
12610 = (regexp_paren_pair*)
12611 any_dup(old_state->re_state_regoffs, proto_perl);
12612 new_state->re_state_reglastparen
12613 = (U32*) any_dup(old_state->re_state_reglastparen,
12615 new_state->re_state_reglastcloseparen
12616 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12618 /* XXX This just has to be broken. The old save_re_context
12619 code did SAVEGENERICPV(PL_reg_start_tmp);
12620 PL_reg_start_tmp is char **.
12621 Look above to what the dup code does for
12622 SAVEt_GENERIC_PVREF
12623 It can never have worked.
12624 So this is merely a faithful copy of the exiting bug: */
12625 new_state->re_state_reg_start_tmp
12626 = (char **) pv_dup((char *)
12627 old_state->re_state_reg_start_tmp);
12628 /* I assume that it only ever "worked" because no-one called
12629 (pseudo)fork while the regexp engine had re-entered itself.
12631 #ifdef PERL_OLD_COPY_ON_WRITE
12632 new_state->re_state_nrs
12633 = sv_dup(old_state->re_state_nrs, param);
12635 new_state->re_state_reg_magic
12636 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12638 new_state->re_state_reg_oldcurpm
12639 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12641 new_state->re_state_reg_curpm
12642 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12644 new_state->re_state_reg_oldsaved
12645 = pv_dup(old_state->re_state_reg_oldsaved);
12646 new_state->re_state_reg_poscache
12647 = pv_dup(old_state->re_state_reg_poscache);
12648 new_state->re_state_reg_starttry
12649 = pv_dup(old_state->re_state_reg_starttry);
12652 case SAVEt_COMPILE_WARNINGS:
12653 ptr = POPPTR(ss,ix);
12654 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12657 ptr = POPPTR(ss,ix);
12658 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12662 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12670 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12671 * flag to the result. This is done for each stash before cloning starts,
12672 * so we know which stashes want their objects cloned */
12675 do_mark_cloneable_stash(pTHX_ SV *const sv)
12677 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12679 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12680 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12681 if (cloner && GvCV(cloner)) {
12688 mXPUSHs(newSVhek(hvname));
12690 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12697 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12705 =for apidoc perl_clone
12707 Create and return a new interpreter by cloning the current one.
12709 perl_clone takes these flags as parameters:
12711 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12712 without it we only clone the data and zero the stacks,
12713 with it we copy the stacks and the new perl interpreter is
12714 ready to run at the exact same point as the previous one.
12715 The pseudo-fork code uses COPY_STACKS while the
12716 threads->create doesn't.
12718 CLONEf_KEEP_PTR_TABLE -
12719 perl_clone keeps a ptr_table with the pointer of the old
12720 variable as a key and the new variable as a value,
12721 this allows it to check if something has been cloned and not
12722 clone it again but rather just use the value and increase the
12723 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12724 the ptr_table using the function
12725 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12726 reason to keep it around is if you want to dup some of your own
12727 variable who are outside the graph perl scans, example of this
12728 code is in threads.xs create.
12730 CLONEf_CLONE_HOST -
12731 This is a win32 thing, it is ignored on unix, it tells perls
12732 win32host code (which is c++) to clone itself, this is needed on
12733 win32 if you want to run two threads at the same time,
12734 if you just want to do some stuff in a separate perl interpreter
12735 and then throw it away and return to the original one,
12736 you don't need to do anything.
12741 /* XXX the above needs expanding by someone who actually understands it ! */
12742 EXTERN_C PerlInterpreter *
12743 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12746 perl_clone(PerlInterpreter *proto_perl, UV flags)
12749 #ifdef PERL_IMPLICIT_SYS
12751 PERL_ARGS_ASSERT_PERL_CLONE;
12753 /* perlhost.h so we need to call into it
12754 to clone the host, CPerlHost should have a c interface, sky */
12756 if (flags & CLONEf_CLONE_HOST) {
12757 return perl_clone_host(proto_perl,flags);
12759 return perl_clone_using(proto_perl, flags,
12761 proto_perl->IMemShared,
12762 proto_perl->IMemParse,
12764 proto_perl->IStdIO,
12768 proto_perl->IProc);
12772 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12773 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12774 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12775 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12776 struct IPerlDir* ipD, struct IPerlSock* ipS,
12777 struct IPerlProc* ipP)
12779 /* XXX many of the string copies here can be optimized if they're
12780 * constants; they need to be allocated as common memory and just
12781 * their pointers copied. */
12784 CLONE_PARAMS clone_params;
12785 CLONE_PARAMS* const param = &clone_params;
12787 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12789 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12790 #else /* !PERL_IMPLICIT_SYS */
12792 CLONE_PARAMS clone_params;
12793 CLONE_PARAMS* param = &clone_params;
12794 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12796 PERL_ARGS_ASSERT_PERL_CLONE;
12797 #endif /* PERL_IMPLICIT_SYS */
12799 /* for each stash, determine whether its objects should be cloned */
12800 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12801 PERL_SET_THX(my_perl);
12804 PoisonNew(my_perl, 1, PerlInterpreter);
12807 PL_defstash = NULL; /* may be used by perl malloc() */
12810 PL_scopestack_name = 0;
12812 PL_savestack_ix = 0;
12813 PL_savestack_max = -1;
12814 PL_sig_pending = 0;
12816 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12817 # ifdef DEBUG_LEAKING_SCALARS
12818 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12820 #else /* !DEBUGGING */
12821 Zero(my_perl, 1, PerlInterpreter);
12822 #endif /* DEBUGGING */
12824 #ifdef PERL_IMPLICIT_SYS
12825 /* host pointers */
12827 PL_MemShared = ipMS;
12828 PL_MemParse = ipMP;
12835 #endif /* PERL_IMPLICIT_SYS */
12837 param->flags = flags;
12838 /* Nothing in the core code uses this, but we make it available to
12839 extensions (using mg_dup). */
12840 param->proto_perl = proto_perl;
12841 /* Likely nothing will use this, but it is initialised to be consistent
12842 with Perl_clone_params_new(). */
12843 param->new_perl = my_perl;
12844 param->unreferenced = NULL;
12846 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12848 PL_body_arenas = NULL;
12849 Zero(&PL_body_roots, 1, PL_body_roots);
12852 PL_sv_objcount = 0;
12854 PL_sv_arenaroot = NULL;
12856 PL_debug = proto_perl->Idebug;
12858 PL_hash_seed = proto_perl->Ihash_seed;
12859 PL_rehash_seed = proto_perl->Irehash_seed;
12861 SvANY(&PL_sv_undef) = NULL;
12862 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12863 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12864 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12865 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12866 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12868 SvANY(&PL_sv_yes) = new_XPVNV();
12869 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12870 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12871 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12873 /* dbargs array probably holds garbage */
12876 PL_compiling = proto_perl->Icompiling;
12878 #ifdef PERL_DEBUG_READONLY_OPS
12883 /* pseudo environmental stuff */
12884 PL_origargc = proto_perl->Iorigargc;
12885 PL_origargv = proto_perl->Iorigargv;
12887 /* Set tainting stuff before PerlIO_debug can possibly get called */
12888 PL_tainting = proto_perl->Itainting;
12889 PL_taint_warn = proto_perl->Itaint_warn;
12891 PL_minus_c = proto_perl->Iminus_c;
12893 PL_localpatches = proto_perl->Ilocalpatches;
12894 PL_splitstr = proto_perl->Isplitstr;
12895 PL_minus_n = proto_perl->Iminus_n;
12896 PL_minus_p = proto_perl->Iminus_p;
12897 PL_minus_l = proto_perl->Iminus_l;
12898 PL_minus_a = proto_perl->Iminus_a;
12899 PL_minus_E = proto_perl->Iminus_E;
12900 PL_minus_F = proto_perl->Iminus_F;
12901 PL_doswitches = proto_perl->Idoswitches;
12902 PL_dowarn = proto_perl->Idowarn;
12903 PL_sawampersand = proto_perl->Isawampersand;
12904 PL_unsafe = proto_perl->Iunsafe;
12905 PL_perldb = proto_perl->Iperldb;
12906 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12907 PL_exit_flags = proto_perl->Iexit_flags;
12909 /* XXX time(&PL_basetime) when asked for? */
12910 PL_basetime = proto_perl->Ibasetime;
12912 PL_maxsysfd = proto_perl->Imaxsysfd;
12913 PL_statusvalue = proto_perl->Istatusvalue;
12915 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12917 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12920 /* RE engine related */
12921 Zero(&PL_reg_state, 1, struct re_save_state);
12922 PL_reginterp_cnt = 0;
12923 PL_regmatch_slab = NULL;
12925 PL_sub_generation = proto_perl->Isub_generation;
12927 /* funky return mechanisms */
12928 PL_forkprocess = proto_perl->Iforkprocess;
12930 /* internal state */
12931 PL_maxo = proto_perl->Imaxo;
12933 PL_main_start = proto_perl->Imain_start;
12934 PL_eval_root = proto_perl->Ieval_root;
12935 PL_eval_start = proto_perl->Ieval_start;
12937 PL_filemode = proto_perl->Ifilemode;
12938 PL_lastfd = proto_perl->Ilastfd;
12939 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
12942 PL_gensym = proto_perl->Igensym;
12944 PL_laststatval = proto_perl->Ilaststatval;
12945 PL_laststype = proto_perl->Ilaststype;
12948 PL_profiledata = NULL;
12950 PL_generation = proto_perl->Igeneration;
12952 PL_in_clean_objs = proto_perl->Iin_clean_objs;
12953 PL_in_clean_all = proto_perl->Iin_clean_all;
12955 PL_uid = proto_perl->Iuid;
12956 PL_euid = proto_perl->Ieuid;
12957 PL_gid = proto_perl->Igid;
12958 PL_egid = proto_perl->Iegid;
12959 PL_nomemok = proto_perl->Inomemok;
12960 PL_an = proto_perl->Ian;
12961 PL_evalseq = proto_perl->Ievalseq;
12962 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12963 PL_origalen = proto_perl->Iorigalen;
12965 PL_sighandlerp = proto_perl->Isighandlerp;
12967 PL_runops = proto_perl->Irunops;
12969 PL_subline = proto_perl->Isubline;
12972 PL_cryptseen = proto_perl->Icryptseen;
12975 PL_hints = proto_perl->Ihints;
12977 PL_amagic_generation = proto_perl->Iamagic_generation;
12979 #ifdef USE_LOCALE_COLLATE
12980 PL_collation_ix = proto_perl->Icollation_ix;
12981 PL_collation_standard = proto_perl->Icollation_standard;
12982 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12983 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12984 #endif /* USE_LOCALE_COLLATE */
12986 #ifdef USE_LOCALE_NUMERIC
12987 PL_numeric_standard = proto_perl->Inumeric_standard;
12988 PL_numeric_local = proto_perl->Inumeric_local;
12989 #endif /* !USE_LOCALE_NUMERIC */
12991 /* Did the locale setup indicate UTF-8? */
12992 PL_utf8locale = proto_perl->Iutf8locale;
12993 /* Unicode features (see perlrun/-C) */
12994 PL_unicode = proto_perl->Iunicode;
12996 /* Pre-5.8 signals control */
12997 PL_signals = proto_perl->Isignals;
12999 /* times() ticks per second */
13000 PL_clocktick = proto_perl->Iclocktick;
13002 /* Recursion stopper for PerlIO_find_layer */
13003 PL_in_load_module = proto_perl->Iin_load_module;
13005 /* sort() routine */
13006 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13008 /* Not really needed/useful since the reenrant_retint is "volatile",
13009 * but do it for consistency's sake. */
13010 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13012 /* Hooks to shared SVs and locks. */
13013 PL_sharehook = proto_perl->Isharehook;
13014 PL_lockhook = proto_perl->Ilockhook;
13015 PL_unlockhook = proto_perl->Iunlockhook;
13016 PL_threadhook = proto_perl->Ithreadhook;
13017 PL_destroyhook = proto_perl->Idestroyhook;
13018 PL_signalhook = proto_perl->Isignalhook;
13020 PL_globhook = proto_perl->Iglobhook;
13022 #ifdef THREADS_HAVE_PIDS
13023 PL_ppid = proto_perl->Ippid;
13027 PL_last_swash_hv = NULL; /* reinits on demand */
13028 PL_last_swash_klen = 0;
13029 PL_last_swash_key[0]= '\0';
13030 PL_last_swash_tmps = (U8*)NULL;
13031 PL_last_swash_slen = 0;
13033 PL_glob_index = proto_perl->Iglob_index;
13034 PL_srand_called = proto_perl->Isrand_called;
13036 if (flags & CLONEf_COPY_STACKS) {
13037 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13038 PL_tmps_ix = proto_perl->Itmps_ix;
13039 PL_tmps_max = proto_perl->Itmps_max;
13040 PL_tmps_floor = proto_perl->Itmps_floor;
13042 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13043 * NOTE: unlike the others! */
13044 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13045 PL_scopestack_max = proto_perl->Iscopestack_max;
13047 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13048 * NOTE: unlike the others! */
13049 PL_savestack_ix = proto_perl->Isavestack_ix;
13050 PL_savestack_max = proto_perl->Isavestack_max;
13053 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13054 PL_top_env = &PL_start_env;
13056 PL_op = proto_perl->Iop;
13059 PL_Xpv = (XPV*)NULL;
13060 my_perl->Ina = proto_perl->Ina;
13062 PL_statbuf = proto_perl->Istatbuf;
13063 PL_statcache = proto_perl->Istatcache;
13066 PL_timesbuf = proto_perl->Itimesbuf;
13069 PL_tainted = proto_perl->Itainted;
13070 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13072 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13074 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13075 PL_restartop = proto_perl->Irestartop;
13076 PL_in_eval = proto_perl->Iin_eval;
13077 PL_delaymagic = proto_perl->Idelaymagic;
13078 PL_phase = proto_perl->Iphase;
13079 PL_localizing = proto_perl->Ilocalizing;
13081 PL_hv_fetch_ent_mh = NULL;
13082 PL_modcount = proto_perl->Imodcount;
13083 PL_lastgotoprobe = NULL;
13084 PL_dumpindent = proto_perl->Idumpindent;
13086 PL_efloatbuf = NULL; /* reinits on demand */
13087 PL_efloatsize = 0; /* reinits on demand */
13091 PL_regdummy = proto_perl->Iregdummy;
13092 PL_colorset = 0; /* reinits PL_colors[] */
13093 /*PL_colors[6] = {0,0,0,0,0,0};*/
13095 /* Pluggable optimizer */
13096 PL_peepp = proto_perl->Ipeepp;
13097 PL_rpeepp = proto_perl->Irpeepp;
13098 /* op_free() hook */
13099 PL_opfreehook = proto_perl->Iopfreehook;
13101 #ifdef USE_REENTRANT_API
13102 /* XXX: things like -Dm will segfault here in perlio, but doing
13103 * PERL_SET_CONTEXT(proto_perl);
13104 * breaks too many other things
13106 Perl_reentrant_init(aTHX);
13109 /* create SV map for pointer relocation */
13110 PL_ptr_table = ptr_table_new();
13112 /* initialize these special pointers as early as possible */
13113 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13115 SvANY(&PL_sv_no) = new_XPVNV();
13116 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13117 SvCUR_set(&PL_sv_no, 0);
13118 SvLEN_set(&PL_sv_no, 1);
13119 SvIV_set(&PL_sv_no, 0);
13120 SvNV_set(&PL_sv_no, 0);
13121 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13123 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13124 SvCUR_set(&PL_sv_yes, 1);
13125 SvLEN_set(&PL_sv_yes, 2);
13126 SvIV_set(&PL_sv_yes, 1);
13127 SvNV_set(&PL_sv_yes, 1);
13128 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13130 /* create (a non-shared!) shared string table */
13131 PL_strtab = newHV();
13132 HvSHAREKEYS_off(PL_strtab);
13133 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13134 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13136 /* These two PVs will be free'd special way so must set them same way op.c does */
13137 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
13138 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
13140 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13141 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13143 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13144 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13145 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13146 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13148 param->stashes = newAV(); /* Setup array of objects to call clone on */
13149 /* This makes no difference to the implementation, as it always pushes
13150 and shifts pointers to other SVs without changing their reference
13151 count, with the array becoming empty before it is freed. However, it
13152 makes it conceptually clear what is going on, and will avoid some
13153 work inside av.c, filling slots between AvFILL() and AvMAX() with
13154 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13155 AvREAL_off(param->stashes);
13157 if (!(flags & CLONEf_COPY_STACKS)) {
13158 param->unreferenced = newAV();
13161 #ifdef PERLIO_LAYERS
13162 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13163 PerlIO_clone(aTHX_ proto_perl, param);
13166 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13167 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13168 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13169 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13170 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13171 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13174 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13175 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13176 PL_inplace = SAVEPV(proto_perl->Iinplace);
13177 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13179 /* magical thingies */
13180 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
13182 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13184 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13185 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13186 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13189 /* Clone the regex array */
13190 /* ORANGE FIXME for plugins, probably in the SV dup code.
13191 newSViv(PTR2IV(CALLREGDUPE(
13192 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13194 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13195 PL_regex_pad = AvARRAY(PL_regex_padav);
13197 /* shortcuts to various I/O objects */
13198 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13199 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13200 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13201 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13202 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13203 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13204 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13206 /* shortcuts to regexp stuff */
13207 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13209 /* shortcuts to misc objects */
13210 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13212 /* shortcuts to debugging objects */
13213 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13214 PL_DBline = gv_dup(proto_perl->IDBline, param);
13215 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13216 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13217 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13218 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13220 /* symbol tables */
13221 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13222 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13223 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13224 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13225 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13227 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13228 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13229 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13230 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13231 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13232 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13233 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13234 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13236 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13238 /* subprocess state */
13239 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13241 if (proto_perl->Iop_mask)
13242 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13245 /* PL_asserting = proto_perl->Iasserting; */
13247 /* current interpreter roots */
13248 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13250 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13253 /* runtime control stuff */
13254 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13256 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13258 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13260 /* interpreter atexit processing */
13261 PL_exitlistlen = proto_perl->Iexitlistlen;
13262 if (PL_exitlistlen) {
13263 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13264 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13267 PL_exitlist = (PerlExitListEntry*)NULL;
13269 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13270 if (PL_my_cxt_size) {
13271 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13272 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13273 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13274 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13275 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13279 PL_my_cxt_list = (void**)NULL;
13280 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13281 PL_my_cxt_keys = (const char**)NULL;
13284 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13285 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13286 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13287 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13289 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13291 PAD_CLONE_VARS(proto_perl, param);
13293 #ifdef HAVE_INTERP_INTERN
13294 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13297 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13299 #ifdef PERL_USES_PL_PIDSTATUS
13300 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13302 PL_osname = SAVEPV(proto_perl->Iosname);
13303 PL_parser = parser_dup(proto_perl->Iparser, param);
13305 /* XXX this only works if the saved cop has already been cloned */
13306 if (proto_perl->Iparser) {
13307 PL_parser->saved_curcop = (COP*)any_dup(
13308 proto_perl->Iparser->saved_curcop,
13312 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13314 #ifdef USE_LOCALE_COLLATE
13315 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13316 #endif /* USE_LOCALE_COLLATE */
13318 #ifdef USE_LOCALE_NUMERIC
13319 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13320 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13321 #endif /* !USE_LOCALE_NUMERIC */
13323 /* utf8 character classes */
13324 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13325 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13326 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13327 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13328 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13329 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13330 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13331 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13332 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13333 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13334 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13335 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13336 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13337 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13338 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13339 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13340 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13341 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13342 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13343 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13344 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13345 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13346 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13347 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13348 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13349 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13350 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13351 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13352 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13353 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13354 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13357 if (proto_perl->Ipsig_pend) {
13358 Newxz(PL_psig_pend, SIG_SIZE, int);
13361 PL_psig_pend = (int*)NULL;
13364 if (proto_perl->Ipsig_name) {
13365 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13366 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13368 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13371 PL_psig_ptr = (SV**)NULL;
13372 PL_psig_name = (SV**)NULL;
13375 if (flags & CLONEf_COPY_STACKS) {
13376 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13377 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13378 PL_tmps_ix+1, param);
13380 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13381 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13382 Newxz(PL_markstack, i, I32);
13383 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13384 - proto_perl->Imarkstack);
13385 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13386 - proto_perl->Imarkstack);
13387 Copy(proto_perl->Imarkstack, PL_markstack,
13388 PL_markstack_ptr - PL_markstack + 1, I32);
13390 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13391 * NOTE: unlike the others! */
13392 Newxz(PL_scopestack, PL_scopestack_max, I32);
13393 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13396 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13397 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13399 /* NOTE: si_dup() looks at PL_markstack */
13400 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13402 /* PL_curstack = PL_curstackinfo->si_stack; */
13403 PL_curstack = av_dup(proto_perl->Icurstack, param);
13404 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13406 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13407 PL_stack_base = AvARRAY(PL_curstack);
13408 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13409 - proto_perl->Istack_base);
13410 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13412 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13413 PL_savestack = ss_dup(proto_perl, param);
13417 ENTER; /* perl_destruct() wants to LEAVE; */
13420 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13421 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13423 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13424 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13425 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13426 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13427 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13428 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13430 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13432 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13433 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13434 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13435 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13437 PL_stashcache = newHV();
13439 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13440 proto_perl->Iwatchaddr);
13441 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13442 if (PL_debug && PL_watchaddr) {
13443 PerlIO_printf(Perl_debug_log,
13444 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13445 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13446 PTR2UV(PL_watchok));
13449 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13450 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13451 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13453 /* Call the ->CLONE method, if it exists, for each of the stashes
13454 identified by sv_dup() above.
13456 while(av_len(param->stashes) != -1) {
13457 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13458 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13459 if (cloner && GvCV(cloner)) {
13464 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13466 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13472 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13473 ptr_table_free(PL_ptr_table);
13474 PL_ptr_table = NULL;
13477 if (!(flags & CLONEf_COPY_STACKS)) {
13478 unreferenced_to_tmp_stack(param->unreferenced);
13481 SvREFCNT_dec(param->stashes);
13483 /* orphaned? eg threads->new inside BEGIN or use */
13484 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13485 SvREFCNT_inc_simple_void(PL_compcv);
13486 SAVEFREESV(PL_compcv);
13493 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13495 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13497 if (AvFILLp(unreferenced) > -1) {
13498 SV **svp = AvARRAY(unreferenced);
13499 SV **const last = svp + AvFILLp(unreferenced);
13503 if (SvREFCNT(*svp) == 1)
13505 } while (++svp <= last);
13507 EXTEND_MORTAL(count);
13508 svp = AvARRAY(unreferenced);
13511 if (SvREFCNT(*svp) == 1) {
13512 /* Our reference is the only one to this SV. This means that
13513 in this thread, the scalar effectively has a 0 reference.
13514 That doesn't work (cleanup never happens), so donate our
13515 reference to it onto the save stack. */
13516 PL_tmps_stack[++PL_tmps_ix] = *svp;
13518 /* As an optimisation, because we are already walking the
13519 entire array, instead of above doing either
13520 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13521 release our reference to the scalar, so that at the end of
13522 the array owns zero references to the scalars it happens to
13523 point to. We are effectively converting the array from
13524 AvREAL() on to AvREAL() off. This saves the av_clear()
13525 (triggered by the SvREFCNT_dec(unreferenced) below) from
13526 walking the array a second time. */
13527 SvREFCNT_dec(*svp);
13530 } while (++svp <= last);
13531 AvREAL_off(unreferenced);
13533 SvREFCNT_dec(unreferenced);
13537 Perl_clone_params_del(CLONE_PARAMS *param)
13539 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13541 PerlInterpreter *const to = param->new_perl;
13543 PerlInterpreter *const was = PERL_GET_THX;
13545 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13551 SvREFCNT_dec(param->stashes);
13552 if (param->unreferenced)
13553 unreferenced_to_tmp_stack(param->unreferenced);
13563 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13566 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13567 does a dTHX; to get the context from thread local storage.
13568 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13569 a version that passes in my_perl. */
13570 PerlInterpreter *const was = PERL_GET_THX;
13571 CLONE_PARAMS *param;
13573 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13579 /* Given that we've set the context, we can do this unshared. */
13580 Newx(param, 1, CLONE_PARAMS);
13583 param->proto_perl = from;
13584 param->new_perl = to;
13585 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13586 AvREAL_off(param->stashes);
13587 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13595 #endif /* USE_ITHREADS */
13598 =head1 Unicode Support
13600 =for apidoc sv_recode_to_utf8
13602 The encoding is assumed to be an Encode object, on entry the PV
13603 of the sv is assumed to be octets in that encoding, and the sv
13604 will be converted into Unicode (and UTF-8).
13606 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13607 is not a reference, nothing is done to the sv. If the encoding is not
13608 an C<Encode::XS> Encoding object, bad things will happen.
13609 (See F<lib/encoding.pm> and L<Encode>.)
13611 The PV of the sv is returned.
13616 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13620 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13622 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13636 Passing sv_yes is wrong - it needs to be or'ed set of constants
13637 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13638 remove converted chars from source.
13640 Both will default the value - let them.
13642 XPUSHs(&PL_sv_yes);
13645 call_method("decode", G_SCALAR);
13649 s = SvPV_const(uni, len);
13650 if (s != SvPVX_const(sv)) {
13651 SvGROW(sv, len + 1);
13652 Move(s, SvPVX(sv), len + 1, char);
13653 SvCUR_set(sv, len);
13657 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13658 /* clear pos and any utf8 cache */
13659 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13662 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13663 magic_setutf8(sv,mg); /* clear UTF8 cache */
13668 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13672 =for apidoc sv_cat_decode
13674 The encoding is assumed to be an Encode object, the PV of the ssv is
13675 assumed to be octets in that encoding and decoding the input starts
13676 from the position which (PV + *offset) pointed to. The dsv will be
13677 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13678 when the string tstr appears in decoding output or the input ends on
13679 the PV of the ssv. The value which the offset points will be modified
13680 to the last input position on the ssv.
13682 Returns TRUE if the terminator was found, else returns FALSE.
13687 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13688 SV *ssv, int *offset, char *tstr, int tlen)
13693 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13695 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13706 offsv = newSViv(*offset);
13708 mXPUSHp(tstr, tlen);
13710 call_method("cat_decode", G_SCALAR);
13712 ret = SvTRUE(TOPs);
13713 *offset = SvIV(offsv);
13719 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13724 /* ---------------------------------------------------------------------
13726 * support functions for report_uninit()
13729 /* the maxiumum size of array or hash where we will scan looking
13730 * for the undefined element that triggered the warning */
13732 #define FUV_MAX_SEARCH_SIZE 1000
13734 /* Look for an entry in the hash whose value has the same SV as val;
13735 * If so, return a mortal copy of the key. */
13738 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13741 register HE **array;
13744 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13746 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13747 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13750 array = HvARRAY(hv);
13752 for (i=HvMAX(hv); i>0; i--) {
13753 register HE *entry;
13754 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13755 if (HeVAL(entry) != val)
13757 if ( HeVAL(entry) == &PL_sv_undef ||
13758 HeVAL(entry) == &PL_sv_placeholder)
13762 if (HeKLEN(entry) == HEf_SVKEY)
13763 return sv_mortalcopy(HeKEY_sv(entry));
13764 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13770 /* Look for an entry in the array whose value has the same SV as val;
13771 * If so, return the index, otherwise return -1. */
13774 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13778 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13780 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13781 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13784 if (val != &PL_sv_undef) {
13785 SV ** const svp = AvARRAY(av);
13788 for (i=AvFILLp(av); i>=0; i--)
13795 /* S_varname(): return the name of a variable, optionally with a subscript.
13796 * If gv is non-zero, use the name of that global, along with gvtype (one
13797 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13798 * targ. Depending on the value of the subscript_type flag, return:
13801 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13802 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13803 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13804 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13807 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13808 const SV *const keyname, I32 aindex, int subscript_type)
13811 SV * const name = sv_newmortal();
13814 buffer[0] = gvtype;
13817 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13819 gv_fullname4(name, gv, buffer, 0);
13821 if ((unsigned int)SvPVX(name)[1] <= 26) {
13823 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13825 /* Swap the 1 unprintable control character for the 2 byte pretty
13826 version - ie substr($name, 1, 1) = $buffer; */
13827 sv_insert(name, 1, 1, buffer, 2);
13831 CV * const cv = find_runcv(NULL);
13835 if (!cv || !CvPADLIST(cv))
13837 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13838 sv = *av_fetch(av, targ, FALSE);
13839 sv_setsv(name, sv);
13842 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13843 SV * const sv = newSV(0);
13844 *SvPVX(name) = '$';
13845 Perl_sv_catpvf(aTHX_ name, "{%s}",
13846 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
13849 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13850 *SvPVX(name) = '$';
13851 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13853 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13854 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13855 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
13863 =for apidoc find_uninit_var
13865 Find the name of the undefined variable (if any) that caused the operator
13866 to issue a "Use of uninitialized value" warning.
13867 If match is true, only return a name if its value matches uninit_sv.
13868 So roughly speaking, if a unary operator (such as OP_COS) generates a
13869 warning, then following the direct child of the op may yield an
13870 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
13871 other hand, with OP_ADD there are two branches to follow, so we only print
13872 the variable name if we get an exact match.
13874 The name is returned as a mortal SV.
13876 Assumes that PL_op is the op that originally triggered the error, and that
13877 PL_comppad/PL_curpad points to the currently executing pad.
13883 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
13889 const OP *o, *o2, *kid;
13891 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
13892 uninit_sv == &PL_sv_placeholder)))
13895 switch (obase->op_type) {
13902 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
13903 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
13906 int subscript_type = FUV_SUBSCRIPT_WITHIN;
13908 if (pad) { /* @lex, %lex */
13909 sv = PAD_SVl(obase->op_targ);
13913 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13914 /* @global, %global */
13915 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13918 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
13920 else if (obase == PL_op) /* @{expr}, %{expr} */
13921 return find_uninit_var(cUNOPx(obase)->op_first,
13923 else /* @{expr}, %{expr} as a sub-expression */
13927 /* attempt to find a match within the aggregate */
13929 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13931 subscript_type = FUV_SUBSCRIPT_HASH;
13934 index = find_array_subscript((const AV *)sv, uninit_sv);
13936 subscript_type = FUV_SUBSCRIPT_ARRAY;
13939 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
13942 return varname(gv, hash ? '%' : '@', obase->op_targ,
13943 keysv, index, subscript_type);
13947 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13949 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13950 if (!gv || !GvSTASH(gv))
13952 if (match && (GvSV(gv) != uninit_sv))
13954 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
13957 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
13960 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
13962 return varname(NULL, '$', obase->op_targ,
13963 NULL, 0, FUV_SUBSCRIPT_NONE);
13966 gv = cGVOPx_gv(obase);
13967 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
13969 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
13971 case OP_AELEMFAST_LEX:
13974 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
13975 if (!av || SvRMAGICAL(av))
13977 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13978 if (!svp || *svp != uninit_sv)
13981 return varname(NULL, '$', obase->op_targ,
13982 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13985 gv = cGVOPx_gv(obase);
13990 AV *const av = GvAV(gv);
13991 if (!av || SvRMAGICAL(av))
13993 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13994 if (!svp || *svp != uninit_sv)
13997 return varname(gv, '$', 0,
13998 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14003 o = cUNOPx(obase)->op_first;
14004 if (!o || o->op_type != OP_NULL ||
14005 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14007 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14012 bool negate = FALSE;
14014 if (PL_op == obase)
14015 /* $a[uninit_expr] or $h{uninit_expr} */
14016 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14019 o = cBINOPx(obase)->op_first;
14020 kid = cBINOPx(obase)->op_last;
14022 /* get the av or hv, and optionally the gv */
14024 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14025 sv = PAD_SV(o->op_targ);
14027 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14028 && cUNOPo->op_first->op_type == OP_GV)
14030 gv = cGVOPx_gv(cUNOPo->op_first);
14034 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14039 if (kid && kid->op_type == OP_NEGATE) {
14041 kid = cUNOPx(kid)->op_first;
14044 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14045 /* index is constant */
14048 kidsv = sv_2mortal(newSVpvs("-"));
14049 sv_catsv(kidsv, cSVOPx_sv(kid));
14052 kidsv = cSVOPx_sv(kid);
14056 if (obase->op_type == OP_HELEM) {
14057 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14058 if (!he || HeVAL(he) != uninit_sv)
14062 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14063 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14065 if (!svp || *svp != uninit_sv)
14069 if (obase->op_type == OP_HELEM)
14070 return varname(gv, '%', o->op_targ,
14071 kidsv, 0, FUV_SUBSCRIPT_HASH);
14073 return varname(gv, '@', o->op_targ, NULL,
14074 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14075 FUV_SUBSCRIPT_ARRAY);
14078 /* index is an expression;
14079 * attempt to find a match within the aggregate */
14080 if (obase->op_type == OP_HELEM) {
14081 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14083 return varname(gv, '%', o->op_targ,
14084 keysv, 0, FUV_SUBSCRIPT_HASH);
14088 = find_array_subscript((const AV *)sv, uninit_sv);
14090 return varname(gv, '@', o->op_targ,
14091 NULL, index, FUV_SUBSCRIPT_ARRAY);
14096 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14098 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14104 /* only examine RHS */
14105 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14108 o = cUNOPx(obase)->op_first;
14109 if (o->op_type == OP_PUSHMARK)
14112 if (!o->op_sibling) {
14113 /* one-arg version of open is highly magical */
14115 if (o->op_type == OP_GV) { /* open FOO; */
14117 if (match && GvSV(gv) != uninit_sv)
14119 return varname(gv, '$', 0,
14120 NULL, 0, FUV_SUBSCRIPT_NONE);
14122 /* other possibilities not handled are:
14123 * open $x; or open my $x; should return '${*$x}'
14124 * open expr; should return '$'.expr ideally
14130 /* ops where $_ may be an implicit arg */
14135 if ( !(obase->op_flags & OPf_STACKED)) {
14136 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14137 ? PAD_SVl(obase->op_targ)
14140 sv = sv_newmortal();
14141 sv_setpvs(sv, "$_");
14150 match = 1; /* print etc can return undef on defined args */
14151 /* skip filehandle as it can't produce 'undef' warning */
14152 o = cUNOPx(obase)->op_first;
14153 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14154 o = o->op_sibling->op_sibling;
14158 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14159 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14161 /* the following ops are capable of returning PL_sv_undef even for
14162 * defined arg(s) */
14181 case OP_GETPEERNAME:
14229 case OP_SMARTMATCH:
14238 /* XXX tmp hack: these two may call an XS sub, and currently
14239 XS subs don't have a SUB entry on the context stack, so CV and
14240 pad determination goes wrong, and BAD things happen. So, just
14241 don't try to determine the value under those circumstances.
14242 Need a better fix at dome point. DAPM 11/2007 */
14248 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14249 if (gv && GvSV(gv) == uninit_sv)
14250 return newSVpvs_flags("$.", SVs_TEMP);
14255 /* def-ness of rval pos() is independent of the def-ness of its arg */
14256 if ( !(obase->op_flags & OPf_MOD))
14261 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14262 return newSVpvs_flags("${$/}", SVs_TEMP);
14267 if (!(obase->op_flags & OPf_KIDS))
14269 o = cUNOPx(obase)->op_first;
14275 /* This loop checks all the kid ops, skipping any that cannot pos-
14276 * sibly be responsible for the uninitialized value; i.e., defined
14277 * constants and ops that return nothing. If there is only one op
14278 * left that is not skipped, then we *know* it is responsible for
14279 * the uninitialized value. If there is more than one op left, we
14280 * have to look for an exact match in the while() loop below.
14283 for (kid=o; kid; kid = kid->op_sibling) {
14285 const OPCODE type = kid->op_type;
14286 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14287 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14288 || (type == OP_PUSHMARK)
14292 if (o2) { /* more than one found */
14299 return find_uninit_var(o2, uninit_sv, match);
14301 /* scan all args */
14303 sv = find_uninit_var(o, uninit_sv, 1);
14315 =for apidoc report_uninit
14317 Print appropriate "Use of uninitialized variable" warning.
14323 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14327 SV* varname = NULL;
14328 if (uninit_sv && PL_curpad) {
14329 varname = find_uninit_var(PL_op, uninit_sv,0);
14331 sv_insert(varname, 0, 0, " ", 1);
14333 /* diag_listed_as: Use of uninitialized value%s */
14334 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14335 SVfARG(varname ? varname : &PL_sv_no),
14336 " in ", OP_DESC(PL_op));
14339 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14345 * c-indentation-style: bsd
14346 * c-basic-offset: 4
14347 * indent-tabs-mode: t
14350 * ex: set ts=8 sts=4 sw=4 noet: