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 /* diag_listed_as: Argument "%s" isn't numeric%s */
1780 "Argument \"%s\" isn't numeric in %s", pv,
1783 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1784 /* diag_listed_as: Argument "%s" isn't numeric%s */
1785 "Argument \"%s\" isn't numeric", pv);
1789 =for apidoc looks_like_number
1791 Test if the content of an SV looks like a number (or is a number).
1792 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1793 non-numeric warning), even if your atof() doesn't grok them. Get-magic is
1800 Perl_looks_like_number(pTHX_ SV *const sv)
1802 register const char *sbegin;
1805 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1807 if (SvPOK(sv) || SvPOKp(sv)) {
1808 sbegin = SvPV_nomg_const(sv, len);
1811 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1812 return grok_number(sbegin, len, NULL);
1816 S_glob_2number(pTHX_ GV * const gv)
1818 SV *const buffer = sv_newmortal();
1820 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1822 gv_efullname3(buffer, gv, "*");
1824 /* We know that all GVs stringify to something that is not-a-number,
1825 so no need to test that. */
1826 if (ckWARN(WARN_NUMERIC))
1827 not_a_number(buffer);
1828 /* We just want something true to return, so that S_sv_2iuv_common
1829 can tail call us and return true. */
1833 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1834 until proven guilty, assume that things are not that bad... */
1839 As 64 bit platforms often have an NV that doesn't preserve all bits of
1840 an IV (an assumption perl has been based on to date) it becomes necessary
1841 to remove the assumption that the NV always carries enough precision to
1842 recreate the IV whenever needed, and that the NV is the canonical form.
1843 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1844 precision as a side effect of conversion (which would lead to insanity
1845 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1846 1) to distinguish between IV/UV/NV slots that have cached a valid
1847 conversion where precision was lost and IV/UV/NV slots that have a
1848 valid conversion which has lost no precision
1849 2) to ensure that if a numeric conversion to one form is requested that
1850 would lose precision, the precise conversion (or differently
1851 imprecise conversion) is also performed and cached, to prevent
1852 requests for different numeric formats on the same SV causing
1853 lossy conversion chains. (lossless conversion chains are perfectly
1858 SvIOKp is true if the IV slot contains a valid value
1859 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1860 SvNOKp is true if the NV slot contains a valid value
1861 SvNOK is true only if the NV value is accurate
1864 while converting from PV to NV, check to see if converting that NV to an
1865 IV(or UV) would lose accuracy over a direct conversion from PV to
1866 IV(or UV). If it would, cache both conversions, return NV, but mark
1867 SV as IOK NOKp (ie not NOK).
1869 While converting from PV to IV, check to see if converting that IV to an
1870 NV would lose accuracy over a direct conversion from PV to NV. If it
1871 would, cache both conversions, flag similarly.
1873 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1874 correctly because if IV & NV were set NV *always* overruled.
1875 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1876 changes - now IV and NV together means that the two are interchangeable:
1877 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1879 The benefit of this is that operations such as pp_add know that if
1880 SvIOK is true for both left and right operands, then integer addition
1881 can be used instead of floating point (for cases where the result won't
1882 overflow). Before, floating point was always used, which could lead to
1883 loss of precision compared with integer addition.
1885 * making IV and NV equal status should make maths accurate on 64 bit
1887 * may speed up maths somewhat if pp_add and friends start to use
1888 integers when possible instead of fp. (Hopefully the overhead in
1889 looking for SvIOK and checking for overflow will not outweigh the
1890 fp to integer speedup)
1891 * will slow down integer operations (callers of SvIV) on "inaccurate"
1892 values, as the change from SvIOK to SvIOKp will cause a call into
1893 sv_2iv each time rather than a macro access direct to the IV slot
1894 * should speed up number->string conversion on integers as IV is
1895 favoured when IV and NV are equally accurate
1897 ####################################################################
1898 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1899 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1900 On the other hand, SvUOK is true iff UV.
1901 ####################################################################
1903 Your mileage will vary depending your CPU's relative fp to integer
1907 #ifndef NV_PRESERVES_UV
1908 # define IS_NUMBER_UNDERFLOW_IV 1
1909 # define IS_NUMBER_UNDERFLOW_UV 2
1910 # define IS_NUMBER_IV_AND_UV 2
1911 # define IS_NUMBER_OVERFLOW_IV 4
1912 # define IS_NUMBER_OVERFLOW_UV 5
1914 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1916 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1918 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1926 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1928 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));
1929 if (SvNVX(sv) < (NV)IV_MIN) {
1930 (void)SvIOKp_on(sv);
1932 SvIV_set(sv, IV_MIN);
1933 return IS_NUMBER_UNDERFLOW_IV;
1935 if (SvNVX(sv) > (NV)UV_MAX) {
1936 (void)SvIOKp_on(sv);
1939 SvUV_set(sv, UV_MAX);
1940 return IS_NUMBER_OVERFLOW_UV;
1942 (void)SvIOKp_on(sv);
1944 /* Can't use strtol etc to convert this string. (See truth table in
1946 if (SvNVX(sv) <= (UV)IV_MAX) {
1947 SvIV_set(sv, I_V(SvNVX(sv)));
1948 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1949 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1951 /* Integer is imprecise. NOK, IOKp */
1953 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1956 SvUV_set(sv, U_V(SvNVX(sv)));
1957 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1958 if (SvUVX(sv) == UV_MAX) {
1959 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1960 possibly be preserved by NV. Hence, it must be overflow.
1962 return IS_NUMBER_OVERFLOW_UV;
1964 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1966 /* Integer is imprecise. NOK, IOKp */
1968 return IS_NUMBER_OVERFLOW_IV;
1970 #endif /* !NV_PRESERVES_UV*/
1973 S_sv_2iuv_common(pTHX_ SV *const sv)
1977 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1980 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1981 * without also getting a cached IV/UV from it at the same time
1982 * (ie PV->NV conversion should detect loss of accuracy and cache
1983 * IV or UV at same time to avoid this. */
1984 /* IV-over-UV optimisation - choose to cache IV if possible */
1986 if (SvTYPE(sv) == SVt_NV)
1987 sv_upgrade(sv, SVt_PVNV);
1989 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1990 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1991 certainly cast into the IV range at IV_MAX, whereas the correct
1992 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1994 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1995 if (Perl_isnan(SvNVX(sv))) {
2001 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2002 SvIV_set(sv, I_V(SvNVX(sv)));
2003 if (SvNVX(sv) == (NV) SvIVX(sv)
2004 #ifndef NV_PRESERVES_UV
2005 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2006 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2007 /* Don't flag it as "accurately an integer" if the number
2008 came from a (by definition imprecise) NV operation, and
2009 we're outside the range of NV integer precision */
2013 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2015 /* scalar has trailing garbage, eg "42a" */
2017 DEBUG_c(PerlIO_printf(Perl_debug_log,
2018 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2024 /* IV not precise. No need to convert from PV, as NV
2025 conversion would already have cached IV if it detected
2026 that PV->IV would be better than PV->NV->IV
2027 flags already correct - don't set public IOK. */
2028 DEBUG_c(PerlIO_printf(Perl_debug_log,
2029 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2034 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2035 but the cast (NV)IV_MIN rounds to a the value less (more
2036 negative) than IV_MIN which happens to be equal to SvNVX ??
2037 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2038 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2039 (NV)UVX == NVX are both true, but the values differ. :-(
2040 Hopefully for 2s complement IV_MIN is something like
2041 0x8000000000000000 which will be exact. NWC */
2044 SvUV_set(sv, U_V(SvNVX(sv)));
2046 (SvNVX(sv) == (NV) SvUVX(sv))
2047 #ifndef NV_PRESERVES_UV
2048 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2049 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2050 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2051 /* Don't flag it as "accurately an integer" if the number
2052 came from a (by definition imprecise) NV operation, and
2053 we're outside the range of NV integer precision */
2059 DEBUG_c(PerlIO_printf(Perl_debug_log,
2060 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2066 else if (SvPOKp(sv) && SvLEN(sv)) {
2068 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2069 /* We want to avoid a possible problem when we cache an IV/ a UV which
2070 may be later translated to an NV, and the resulting NV is not
2071 the same as the direct translation of the initial string
2072 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2073 be careful to ensure that the value with the .456 is around if the
2074 NV value is requested in the future).
2076 This means that if we cache such an IV/a UV, we need to cache the
2077 NV as well. Moreover, we trade speed for space, and do not
2078 cache the NV if we are sure it's not needed.
2081 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2082 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2083 == IS_NUMBER_IN_UV) {
2084 /* It's definitely an integer, only upgrade to PVIV */
2085 if (SvTYPE(sv) < SVt_PVIV)
2086 sv_upgrade(sv, SVt_PVIV);
2088 } else if (SvTYPE(sv) < SVt_PVNV)
2089 sv_upgrade(sv, SVt_PVNV);
2091 /* If NVs preserve UVs then we only use the UV value if we know that
2092 we aren't going to call atof() below. If NVs don't preserve UVs
2093 then the value returned may have more precision than atof() will
2094 return, even though value isn't perfectly accurate. */
2095 if ((numtype & (IS_NUMBER_IN_UV
2096 #ifdef NV_PRESERVES_UV
2099 )) == IS_NUMBER_IN_UV) {
2100 /* This won't turn off the public IOK flag if it was set above */
2101 (void)SvIOKp_on(sv);
2103 if (!(numtype & IS_NUMBER_NEG)) {
2105 if (value <= (UV)IV_MAX) {
2106 SvIV_set(sv, (IV)value);
2108 /* it didn't overflow, and it was positive. */
2109 SvUV_set(sv, value);
2113 /* 2s complement assumption */
2114 if (value <= (UV)IV_MIN) {
2115 SvIV_set(sv, -(IV)value);
2117 /* Too negative for an IV. This is a double upgrade, but
2118 I'm assuming it will be rare. */
2119 if (SvTYPE(sv) < SVt_PVNV)
2120 sv_upgrade(sv, SVt_PVNV);
2124 SvNV_set(sv, -(NV)value);
2125 SvIV_set(sv, IV_MIN);
2129 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2130 will be in the previous block to set the IV slot, and the next
2131 block to set the NV slot. So no else here. */
2133 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2134 != IS_NUMBER_IN_UV) {
2135 /* It wasn't an (integer that doesn't overflow the UV). */
2136 SvNV_set(sv, Atof(SvPVX_const(sv)));
2138 if (! numtype && ckWARN(WARN_NUMERIC))
2141 #if defined(USE_LONG_DOUBLE)
2142 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2143 PTR2UV(sv), SvNVX(sv)));
2145 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2146 PTR2UV(sv), SvNVX(sv)));
2149 #ifdef NV_PRESERVES_UV
2150 (void)SvIOKp_on(sv);
2152 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2153 SvIV_set(sv, I_V(SvNVX(sv)));
2154 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2157 NOOP; /* Integer is imprecise. NOK, IOKp */
2159 /* UV will not work better than IV */
2161 if (SvNVX(sv) > (NV)UV_MAX) {
2163 /* Integer is inaccurate. NOK, IOKp, is UV */
2164 SvUV_set(sv, UV_MAX);
2166 SvUV_set(sv, U_V(SvNVX(sv)));
2167 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2168 NV preservse UV so can do correct comparison. */
2169 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2172 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2177 #else /* NV_PRESERVES_UV */
2178 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2179 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2180 /* The IV/UV slot will have been set from value returned by
2181 grok_number above. The NV slot has just been set using
2184 assert (SvIOKp(sv));
2186 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2187 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2188 /* Small enough to preserve all bits. */
2189 (void)SvIOKp_on(sv);
2191 SvIV_set(sv, I_V(SvNVX(sv)));
2192 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2194 /* Assumption: first non-preserved integer is < IV_MAX,
2195 this NV is in the preserved range, therefore: */
2196 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2198 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);
2202 0 0 already failed to read UV.
2203 0 1 already failed to read UV.
2204 1 0 you won't get here in this case. IV/UV
2205 slot set, public IOK, Atof() unneeded.
2206 1 1 already read UV.
2207 so there's no point in sv_2iuv_non_preserve() attempting
2208 to use atol, strtol, strtoul etc. */
2210 sv_2iuv_non_preserve (sv, numtype);
2212 sv_2iuv_non_preserve (sv);
2216 #endif /* NV_PRESERVES_UV */
2217 /* It might be more code efficient to go through the entire logic above
2218 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2219 gets complex and potentially buggy, so more programmer efficient
2220 to do it this way, by turning off the public flags: */
2222 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2226 if (isGV_with_GP(sv))
2227 return glob_2number(MUTABLE_GV(sv));
2229 if (!SvPADTMP(sv)) {
2230 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2233 if (SvTYPE(sv) < SVt_IV)
2234 /* Typically the caller expects that sv_any is not NULL now. */
2235 sv_upgrade(sv, SVt_IV);
2236 /* Return 0 from the caller. */
2243 =for apidoc sv_2iv_flags
2245 Return the integer value of an SV, doing any necessary string
2246 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2247 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2253 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2258 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2259 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2260 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2261 In practice they are extremely unlikely to actually get anywhere
2262 accessible by user Perl code - the only way that I'm aware of is when
2263 a constant subroutine which is used as the second argument to index.
2265 if (flags & SV_GMAGIC)
2270 return I_V(SvNVX(sv));
2272 if (SvPOKp(sv) && SvLEN(sv)) {
2275 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2278 == IS_NUMBER_IN_UV) {
2279 /* It's definitely an integer */
2280 if (numtype & IS_NUMBER_NEG) {
2281 if (value < (UV)IV_MIN)
2284 if (value < (UV)IV_MAX)
2289 if (ckWARN(WARN_NUMERIC))
2292 return I_V(Atof(SvPVX_const(sv)));
2297 assert(SvTYPE(sv) >= SVt_PVMG);
2298 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2299 } else if (SvTHINKFIRST(sv)) {
2304 if (flags & SV_SKIP_OVERLOAD)
2306 tmpstr = AMG_CALLunary(sv, numer_amg);
2307 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2308 return SvIV(tmpstr);
2311 return PTR2IV(SvRV(sv));
2314 sv_force_normal_flags(sv, 0);
2316 if (SvREADONLY(sv) && !SvOK(sv)) {
2317 if (ckWARN(WARN_UNINITIALIZED))
2323 if (S_sv_2iuv_common(aTHX_ sv))
2326 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2327 PTR2UV(sv),SvIVX(sv)));
2328 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2332 =for apidoc sv_2uv_flags
2334 Return the unsigned integer value of an SV, doing any necessary string
2335 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2336 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2342 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2347 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2348 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2349 the same flag bit as SVf_IVisUV, so must not let them cache IVs. */
2350 if (flags & SV_GMAGIC)
2355 return U_V(SvNVX(sv));
2356 if (SvPOKp(sv) && SvLEN(sv)) {
2359 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2361 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2362 == IS_NUMBER_IN_UV) {
2363 /* It's definitely an integer */
2364 if (!(numtype & IS_NUMBER_NEG))
2368 if (ckWARN(WARN_NUMERIC))
2371 return U_V(Atof(SvPVX_const(sv)));
2376 assert(SvTYPE(sv) >= SVt_PVMG);
2377 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2378 } else if (SvTHINKFIRST(sv)) {
2383 if (flags & SV_SKIP_OVERLOAD)
2385 tmpstr = AMG_CALLunary(sv, numer_amg);
2386 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2387 return SvUV(tmpstr);
2390 return PTR2UV(SvRV(sv));
2393 sv_force_normal_flags(sv, 0);
2395 if (SvREADONLY(sv) && !SvOK(sv)) {
2396 if (ckWARN(WARN_UNINITIALIZED))
2402 if (S_sv_2iuv_common(aTHX_ sv))
2406 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2407 PTR2UV(sv),SvUVX(sv)));
2408 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2412 =for apidoc sv_2nv_flags
2414 Return the num value of an SV, doing any necessary string or integer
2415 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2416 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2422 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2427 if (SvGMAGICAL(sv) || SvVALID(sv)) {
2428 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2429 the same flag bit as SVf_IVisUV, so must not let them cache NVs. */
2430 if (flags & SV_GMAGIC)
2434 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2435 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2436 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2438 return Atof(SvPVX_const(sv));
2442 return (NV)SvUVX(sv);
2444 return (NV)SvIVX(sv);
2449 assert(SvTYPE(sv) >= SVt_PVMG);
2450 /* This falls through to the report_uninit near the end of the
2452 } else if (SvTHINKFIRST(sv)) {
2457 if (flags & SV_SKIP_OVERLOAD)
2459 tmpstr = AMG_CALLunary(sv, numer_amg);
2460 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2461 return SvNV(tmpstr);
2464 return PTR2NV(SvRV(sv));
2467 sv_force_normal_flags(sv, 0);
2469 if (SvREADONLY(sv) && !SvOK(sv)) {
2470 if (ckWARN(WARN_UNINITIALIZED))
2475 if (SvTYPE(sv) < SVt_NV) {
2476 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2477 sv_upgrade(sv, SVt_NV);
2478 #ifdef USE_LONG_DOUBLE
2480 STORE_NUMERIC_LOCAL_SET_STANDARD();
2481 PerlIO_printf(Perl_debug_log,
2482 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
2489 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2490 PTR2UV(sv), SvNVX(sv));
2491 RESTORE_NUMERIC_LOCAL();
2495 else if (SvTYPE(sv) < SVt_PVNV)
2496 sv_upgrade(sv, SVt_PVNV);
2501 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2502 #ifdef NV_PRESERVES_UV
2508 /* Only set the public NV OK flag if this NV preserves the IV */
2509 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2511 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2512 : (SvIVX(sv) == I_V(SvNVX(sv))))
2518 else if (SvPOKp(sv) && SvLEN(sv)) {
2520 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2521 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2523 #ifdef NV_PRESERVES_UV
2524 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2525 == IS_NUMBER_IN_UV) {
2526 /* It's definitely an integer */
2527 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2529 SvNV_set(sv, Atof(SvPVX_const(sv)));
2535 SvNV_set(sv, Atof(SvPVX_const(sv)));
2536 /* Only set the public NV OK flag if this NV preserves the value in
2537 the PV at least as well as an IV/UV would.
2538 Not sure how to do this 100% reliably. */
2539 /* if that shift count is out of range then Configure's test is
2540 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2542 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2543 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2544 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2545 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2546 /* Can't use strtol etc to convert this string, so don't try.
2547 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2550 /* value has been set. It may not be precise. */
2551 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2552 /* 2s complement assumption for (UV)IV_MIN */
2553 SvNOK_on(sv); /* Integer is too negative. */
2558 if (numtype & IS_NUMBER_NEG) {
2559 SvIV_set(sv, -(IV)value);
2560 } else if (value <= (UV)IV_MAX) {
2561 SvIV_set(sv, (IV)value);
2563 SvUV_set(sv, value);
2567 if (numtype & IS_NUMBER_NOT_INT) {
2568 /* I believe that even if the original PV had decimals,
2569 they are lost beyond the limit of the FP precision.
2570 However, neither is canonical, so both only get p
2571 flags. NWC, 2000/11/25 */
2572 /* Both already have p flags, so do nothing */
2574 const NV nv = SvNVX(sv);
2575 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2576 if (SvIVX(sv) == I_V(nv)) {
2579 /* It had no "." so it must be integer. */
2583 /* between IV_MAX and NV(UV_MAX).
2584 Could be slightly > UV_MAX */
2586 if (numtype & IS_NUMBER_NOT_INT) {
2587 /* UV and NV both imprecise. */
2589 const UV nv_as_uv = U_V(nv);
2591 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2600 /* It might be more code efficient to go through the entire logic above
2601 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2602 gets complex and potentially buggy, so more programmer efficient
2603 to do it this way, by turning off the public flags: */
2605 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2606 #endif /* NV_PRESERVES_UV */
2609 if (isGV_with_GP(sv)) {
2610 glob_2number(MUTABLE_GV(sv));
2614 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2616 assert (SvTYPE(sv) >= SVt_NV);
2617 /* Typically the caller expects that sv_any is not NULL now. */
2618 /* XXX Ilya implies that this is a bug in callers that assume this
2619 and ideally should be fixed. */
2622 #if defined(USE_LONG_DOUBLE)
2624 STORE_NUMERIC_LOCAL_SET_STANDARD();
2625 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2626 PTR2UV(sv), SvNVX(sv));
2627 RESTORE_NUMERIC_LOCAL();
2631 STORE_NUMERIC_LOCAL_SET_STANDARD();
2632 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2633 PTR2UV(sv), SvNVX(sv));
2634 RESTORE_NUMERIC_LOCAL();
2643 Return an SV with the numeric value of the source SV, doing any necessary
2644 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2645 access this function.
2651 Perl_sv_2num(pTHX_ register SV *const sv)
2653 PERL_ARGS_ASSERT_SV_2NUM;
2658 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2659 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2660 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2661 return sv_2num(tmpsv);
2663 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2666 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2667 * UV as a string towards the end of buf, and return pointers to start and
2670 * We assume that buf is at least TYPE_CHARS(UV) long.
2674 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2676 char *ptr = buf + TYPE_CHARS(UV);
2677 char * const ebuf = ptr;
2680 PERL_ARGS_ASSERT_UIV_2BUF;
2692 *--ptr = '0' + (char)(uv % 10);
2701 =for apidoc sv_2pv_flags
2703 Returns a pointer to the string value of an SV, and sets *lp to its length.
2704 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2705 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2706 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2712 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2722 if (SvGMAGICAL(sv)) {
2723 if (flags & SV_GMAGIC)
2728 if (flags & SV_MUTABLE_RETURN)
2729 return SvPVX_mutable(sv);
2730 if (flags & SV_CONST_RETURN)
2731 return (char *)SvPVX_const(sv);
2734 if (SvIOKp(sv) || SvNOKp(sv)) {
2735 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2740 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2741 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2742 } else if(SvNVX(sv) == 0.0) {
2747 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2754 SvUPGRADE(sv, SVt_PV);
2757 s = SvGROW_mutable(sv, len + 1);
2760 return (char*)memcpy(s, tbuf, len + 1);
2766 assert(SvTYPE(sv) >= SVt_PVMG);
2767 /* This falls through to the report_uninit near the end of the
2769 } else if (SvTHINKFIRST(sv)) {
2774 if (flags & SV_SKIP_OVERLOAD)
2776 tmpstr = AMG_CALLunary(sv, string_amg);
2777 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2778 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2780 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2784 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2785 if (flags & SV_CONST_RETURN) {
2786 pv = (char *) SvPVX_const(tmpstr);
2788 pv = (flags & SV_MUTABLE_RETURN)
2789 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2792 *lp = SvCUR(tmpstr);
2794 pv = sv_2pv_flags(tmpstr, lp, flags);
2807 SV *const referent = SvRV(sv);
2811 retval = buffer = savepvn("NULLREF", len);
2812 } else if (SvTYPE(referent) == SVt_REGEXP) {
2813 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2818 /* If the regex is UTF-8 we want the containing scalar to
2819 have an UTF-8 flag too */
2825 if ((seen_evals = RX_SEEN_EVALS(re)))
2826 PL_reginterp_cnt += seen_evals;
2829 *lp = RX_WRAPLEN(re);
2831 return RX_WRAPPED(re);
2833 const char *const typestr = sv_reftype(referent, 0);
2834 const STRLEN typelen = strlen(typestr);
2835 UV addr = PTR2UV(referent);
2836 const char *stashname = NULL;
2837 STRLEN stashnamelen = 0; /* hush, gcc */
2838 const char *buffer_end;
2840 if (SvOBJECT(referent)) {
2841 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2844 stashname = HEK_KEY(name);
2845 stashnamelen = HEK_LEN(name);
2847 if (HEK_UTF8(name)) {
2853 stashname = "__ANON__";
2856 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2857 + 2 * sizeof(UV) + 2 /* )\0 */;
2859 len = typelen + 3 /* (0x */
2860 + 2 * sizeof(UV) + 2 /* )\0 */;
2863 Newx(buffer, len, char);
2864 buffer_end = retval = buffer + len;
2866 /* Working backwards */
2870 *--retval = PL_hexdigit[addr & 15];
2871 } while (addr >>= 4);
2877 memcpy(retval, typestr, typelen);
2881 retval -= stashnamelen;
2882 memcpy(retval, stashname, stashnamelen);
2884 /* retval may not necessarily have reached the start of the
2886 assert (retval >= buffer);
2888 len = buffer_end - retval - 1; /* -1 for that \0 */
2896 if (SvREADONLY(sv) && !SvOK(sv)) {
2899 if (flags & SV_UNDEF_RETURNS_NULL)
2901 if (ckWARN(WARN_UNINITIALIZED))
2906 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2907 /* I'm assuming that if both IV and NV are equally valid then
2908 converting the IV is going to be more efficient */
2909 const U32 isUIOK = SvIsUV(sv);
2910 char buf[TYPE_CHARS(UV)];
2914 if (SvTYPE(sv) < SVt_PVIV)
2915 sv_upgrade(sv, SVt_PVIV);
2916 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2918 /* inlined from sv_setpvn */
2919 s = SvGROW_mutable(sv, len + 1);
2920 Move(ptr, s, len, char);
2924 else if (SvNOKp(sv)) {
2925 if (SvTYPE(sv) < SVt_PVNV)
2926 sv_upgrade(sv, SVt_PVNV);
2927 if (SvNVX(sv) == 0.0) {
2928 s = SvGROW_mutable(sv, 2);
2933 /* The +20 is pure guesswork. Configure test needed. --jhi */
2934 s = SvGROW_mutable(sv, NV_DIG + 20);
2935 /* some Xenix systems wipe out errno here */
2936 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2946 if (isGV_with_GP(sv)) {
2947 GV *const gv = MUTABLE_GV(sv);
2948 SV *const buffer = sv_newmortal();
2950 gv_efullname3(buffer, gv, "*");
2952 assert(SvPOK(buffer));
2954 *lp = SvCUR(buffer);
2956 if ( SvUTF8(buffer) ) SvUTF8_on(sv);
2957 return SvPVX(buffer);
2962 if (flags & SV_UNDEF_RETURNS_NULL)
2964 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2966 if (SvTYPE(sv) < SVt_PV)
2967 /* Typically the caller expects that sv_any is not NULL now. */
2968 sv_upgrade(sv, SVt_PV);
2972 const STRLEN len = s - SvPVX_const(sv);
2978 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2979 PTR2UV(sv),SvPVX_const(sv)));
2980 if (flags & SV_CONST_RETURN)
2981 return (char *)SvPVX_const(sv);
2982 if (flags & SV_MUTABLE_RETURN)
2983 return SvPVX_mutable(sv);
2988 =for apidoc sv_copypv
2990 Copies a stringified representation of the source SV into the
2991 destination SV. Automatically performs any necessary mg_get and
2992 coercion of numeric values into strings. Guaranteed to preserve
2993 UTF8 flag even from overloaded objects. Similar in nature to
2994 sv_2pv[_flags] but operates directly on an SV instead of just the
2995 string. Mostly uses sv_2pv_flags to do its work, except when that
2996 would lose the UTF-8'ness of the PV.
3002 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3005 const char * const s = SvPV_const(ssv,len);
3007 PERL_ARGS_ASSERT_SV_COPYPV;
3009 sv_setpvn(dsv,s,len);
3017 =for apidoc sv_2pvbyte
3019 Return a pointer to the byte-encoded representation of the SV, and set *lp
3020 to its length. May cause the SV to be downgraded from UTF-8 as a
3023 Usually accessed via the C<SvPVbyte> macro.
3029 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3031 PERL_ARGS_ASSERT_SV_2PVBYTE;
3034 sv_utf8_downgrade(sv,0);
3035 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3039 =for apidoc sv_2pvutf8
3041 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3042 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3044 Usually accessed via the C<SvPVutf8> macro.
3050 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3052 PERL_ARGS_ASSERT_SV_2PVUTF8;
3054 sv_utf8_upgrade(sv);
3055 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3060 =for apidoc sv_2bool
3062 This macro is only used by sv_true() or its macro equivalent, and only if
3063 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3064 It calls sv_2bool_flags with the SV_GMAGIC flag.
3066 =for apidoc sv_2bool_flags
3068 This function is only used by sv_true() and friends, and only if
3069 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3070 contain SV_GMAGIC, then it does an mg_get() first.
3077 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3081 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3083 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3089 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3090 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3091 return cBOOL(SvTRUE(tmpsv));
3093 return SvRV(sv) != 0;
3096 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3098 (*sv->sv_u.svu_pv > '0' ||
3099 Xpvtmp->xpv_cur > 1 ||
3100 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3107 return SvIVX(sv) != 0;
3110 return SvNVX(sv) != 0.0;
3112 if (isGV_with_GP(sv))
3122 =for apidoc sv_utf8_upgrade
3124 Converts the PV of an SV to its UTF-8-encoded form.
3125 Forces the SV to string form if it is not already.
3126 Will C<mg_get> on C<sv> if appropriate.
3127 Always sets the SvUTF8 flag to avoid future validity checks even
3128 if the whole string is the same in UTF-8 as not.
3129 Returns the number of bytes in the converted string
3131 This is not as a general purpose byte encoding to Unicode interface:
3132 use the Encode extension for that.
3134 =for apidoc sv_utf8_upgrade_nomg
3136 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3138 =for apidoc sv_utf8_upgrade_flags
3140 Converts the PV of an SV to its UTF-8-encoded form.
3141 Forces the SV to string form if it is not already.
3142 Always sets the SvUTF8 flag to avoid future validity checks even
3143 if all the bytes are invariant in UTF-8.
3144 If C<flags> has C<SV_GMAGIC> bit set,
3145 will C<mg_get> on C<sv> if appropriate, else not.
3146 Returns the number of bytes in the converted string
3147 C<sv_utf8_upgrade> and
3148 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3150 This is not as a general purpose byte encoding to Unicode interface:
3151 use the Encode extension for that.
3155 The grow version is currently not externally documented. It adds a parameter,
3156 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3157 have free after it upon return. This allows the caller to reserve extra space
3158 that it intends to fill, to avoid extra grows.
3160 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3161 which can be used to tell this function to not first check to see if there are
3162 any characters that are different in UTF-8 (variant characters) which would
3163 force it to allocate a new string to sv, but to assume there are. Typically
3164 this flag is used by a routine that has already parsed the string to find that
3165 there are such characters, and passes this information on so that the work
3166 doesn't have to be repeated.
3168 (One might think that the calling routine could pass in the position of the
3169 first such variant, so it wouldn't have to be found again. But that is not the
3170 case, because typically when the caller is likely to use this flag, it won't be
3171 calling this routine unless it finds something that won't fit into a byte.
3172 Otherwise it tries to not upgrade and just use bytes. But some things that
3173 do fit into a byte are variants in utf8, and the caller may not have been
3174 keeping track of these.)
3176 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3177 isn't guaranteed due to having other routines do the work in some input cases,
3178 or if the input is already flagged as being in utf8.
3180 The speed of this could perhaps be improved for many cases if someone wanted to
3181 write a fast function that counts the number of variant characters in a string,
3182 especially if it could return the position of the first one.
3187 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3191 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3193 if (sv == &PL_sv_undef)
3197 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3198 (void) sv_2pv_flags(sv,&len, flags);
3200 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3204 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3209 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3214 sv_force_normal_flags(sv, 0);
3217 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3218 sv_recode_to_utf8(sv, PL_encoding);
3219 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3223 if (SvCUR(sv) == 0) {
3224 if (extra) SvGROW(sv, extra);
3225 } else { /* Assume Latin-1/EBCDIC */
3226 /* This function could be much more efficient if we
3227 * had a FLAG in SVs to signal if there are any variant
3228 * chars in the PV. Given that there isn't such a flag
3229 * make the loop as fast as possible (although there are certainly ways
3230 * to speed this up, eg. through vectorization) */
3231 U8 * s = (U8 *) SvPVX_const(sv);
3232 U8 * e = (U8 *) SvEND(sv);
3234 STRLEN two_byte_count = 0;
3236 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3238 /* See if really will need to convert to utf8. We mustn't rely on our
3239 * incoming SV being well formed and having a trailing '\0', as certain
3240 * code in pp_formline can send us partially built SVs. */
3244 if (NATIVE_IS_INVARIANT(ch)) continue;
3246 t--; /* t already incremented; re-point to first variant */
3251 /* utf8 conversion not needed because all are invariants. Mark as
3252 * UTF-8 even if no variant - saves scanning loop */
3254 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3259 /* Here, the string should be converted to utf8, either because of an
3260 * input flag (two_byte_count = 0), or because a character that
3261 * requires 2 bytes was found (two_byte_count = 1). t points either to
3262 * the beginning of the string (if we didn't examine anything), or to
3263 * the first variant. In either case, everything from s to t - 1 will
3264 * occupy only 1 byte each on output.
3266 * There are two main ways to convert. One is to create a new string
3267 * and go through the input starting from the beginning, appending each
3268 * converted value onto the new string as we go along. It's probably
3269 * best to allocate enough space in the string for the worst possible
3270 * case rather than possibly running out of space and having to
3271 * reallocate and then copy what we've done so far. Since everything
3272 * from s to t - 1 is invariant, the destination can be initialized
3273 * with these using a fast memory copy
3275 * The other way is to figure out exactly how big the string should be
3276 * by parsing the entire input. Then you don't have to make it big
3277 * enough to handle the worst possible case, and more importantly, if
3278 * the string you already have is large enough, you don't have to
3279 * allocate a new string, you can copy the last character in the input
3280 * string to the final position(s) that will be occupied by the
3281 * converted string and go backwards, stopping at t, since everything
3282 * before that is invariant.
3284 * There are advantages and disadvantages to each method.
3286 * In the first method, we can allocate a new string, do the memory
3287 * copy from the s to t - 1, and then proceed through the rest of the
3288 * string byte-by-byte.
3290 * In the second method, we proceed through the rest of the input
3291 * string just calculating how big the converted string will be. Then
3292 * there are two cases:
3293 * 1) if the string has enough extra space to handle the converted
3294 * value. We go backwards through the string, converting until we
3295 * get to the position we are at now, and then stop. If this
3296 * position is far enough along in the string, this method is
3297 * faster than the other method. If the memory copy were the same
3298 * speed as the byte-by-byte loop, that position would be about
3299 * half-way, as at the half-way mark, parsing to the end and back
3300 * is one complete string's parse, the same amount as starting
3301 * over and going all the way through. Actually, it would be
3302 * somewhat less than half-way, as it's faster to just count bytes
3303 * than to also copy, and we don't have the overhead of allocating
3304 * a new string, changing the scalar to use it, and freeing the
3305 * existing one. But if the memory copy is fast, the break-even
3306 * point is somewhere after half way. The counting loop could be
3307 * sped up by vectorization, etc, to move the break-even point
3308 * further towards the beginning.
3309 * 2) if the string doesn't have enough space to handle the converted
3310 * value. A new string will have to be allocated, and one might
3311 * as well, given that, start from the beginning doing the first
3312 * method. We've spent extra time parsing the string and in
3313 * exchange all we've gotten is that we know precisely how big to
3314 * make the new one. Perl is more optimized for time than space,
3315 * so this case is a loser.
3316 * So what I've decided to do is not use the 2nd method unless it is
3317 * guaranteed that a new string won't have to be allocated, assuming
3318 * the worst case. I also decided not to put any more conditions on it
3319 * than this, for now. It seems likely that, since the worst case is
3320 * twice as big as the unknown portion of the string (plus 1), we won't
3321 * be guaranteed enough space, causing us to go to the first method,
3322 * unless the string is short, or the first variant character is near
3323 * the end of it. In either of these cases, it seems best to use the
3324 * 2nd method. The only circumstance I can think of where this would
3325 * be really slower is if the string had once had much more data in it
3326 * than it does now, but there is still a substantial amount in it */
3329 STRLEN invariant_head = t - s;
3330 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3331 if (SvLEN(sv) < size) {
3333 /* Here, have decided to allocate a new string */
3338 Newx(dst, size, U8);
3340 /* If no known invariants at the beginning of the input string,
3341 * set so starts from there. Otherwise, can use memory copy to
3342 * get up to where we are now, and then start from here */
3344 if (invariant_head <= 0) {
3347 Copy(s, dst, invariant_head, char);
3348 d = dst + invariant_head;
3352 const UV uv = NATIVE8_TO_UNI(*t++);
3353 if (UNI_IS_INVARIANT(uv))
3354 *d++ = (U8)UNI_TO_NATIVE(uv);
3356 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3357 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3361 SvPV_free(sv); /* No longer using pre-existing string */
3362 SvPV_set(sv, (char*)dst);
3363 SvCUR_set(sv, d - dst);
3364 SvLEN_set(sv, size);
3367 /* Here, have decided to get the exact size of the string.
3368 * Currently this happens only when we know that there is
3369 * guaranteed enough space to fit the converted string, so
3370 * don't have to worry about growing. If two_byte_count is 0,
3371 * then t points to the first byte of the string which hasn't
3372 * been examined yet. Otherwise two_byte_count is 1, and t
3373 * points to the first byte in the string that will expand to
3374 * two. Depending on this, start examining at t or 1 after t.
3377 U8 *d = t + two_byte_count;
3380 /* Count up the remaining bytes that expand to two */
3383 const U8 chr = *d++;
3384 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3387 /* The string will expand by just the number of bytes that
3388 * occupy two positions. But we are one afterwards because of
3389 * the increment just above. This is the place to put the
3390 * trailing NUL, and to set the length before we decrement */
3392 d += two_byte_count;
3393 SvCUR_set(sv, d - s);
3397 /* Having decremented d, it points to the position to put the
3398 * very last byte of the expanded string. Go backwards through
3399 * the string, copying and expanding as we go, stopping when we
3400 * get to the part that is invariant the rest of the way down */
3404 const U8 ch = NATIVE8_TO_UNI(*e--);
3405 if (UNI_IS_INVARIANT(ch)) {
3406 *d-- = UNI_TO_NATIVE(ch);
3408 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3409 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3414 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3415 /* Update pos. We do it at the end rather than during
3416 * the upgrade, to avoid slowing down the common case
3417 * (upgrade without pos) */
3418 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3420 I32 pos = mg->mg_len;
3421 if (pos > 0 && (U32)pos > invariant_head) {
3422 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3423 STRLEN n = (U32)pos - invariant_head;
3425 if (UTF8_IS_START(*d))
3430 mg->mg_len = d - (U8*)SvPVX(sv);
3433 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3434 magic_setutf8(sv,mg); /* clear UTF8 cache */
3439 /* Mark as UTF-8 even if no variant - saves scanning loop */
3445 =for apidoc sv_utf8_downgrade
3447 Attempts to convert the PV of an SV from characters to bytes.
3448 If the PV contains a character that cannot fit
3449 in a byte, this conversion will fail;
3450 in this case, either returns false or, if C<fail_ok> is not
3453 This is not as a general purpose Unicode to byte encoding interface:
3454 use the Encode extension for that.
3460 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3464 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3466 if (SvPOKp(sv) && SvUTF8(sv)) {
3470 int mg_flags = SV_GMAGIC;
3473 sv_force_normal_flags(sv, 0);
3475 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3477 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3479 I32 pos = mg->mg_len;
3481 sv_pos_b2u(sv, &pos);
3482 mg_flags = 0; /* sv_pos_b2u does get magic */
3486 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3487 magic_setutf8(sv,mg); /* clear UTF8 cache */
3490 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3492 if (!utf8_to_bytes(s, &len)) {
3497 Perl_croak(aTHX_ "Wide character in %s",
3500 Perl_croak(aTHX_ "Wide character");
3511 =for apidoc sv_utf8_encode
3513 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3514 flag off so that it looks like octets again.
3520 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3522 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3525 sv_force_normal_flags(sv, 0);
3527 if (SvREADONLY(sv)) {
3528 Perl_croak_no_modify(aTHX);
3530 (void) sv_utf8_upgrade(sv);
3535 =for apidoc sv_utf8_decode
3537 If the PV of the SV is an octet sequence in UTF-8
3538 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3539 so that it looks like a character. If the PV contains only single-byte
3540 characters, the C<SvUTF8> flag stays off.
3541 Scans PV for validity and returns false if the PV is invalid UTF-8.
3547 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3549 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3552 const U8 *start, *c;
3555 /* The octets may have got themselves encoded - get them back as
3558 if (!sv_utf8_downgrade(sv, TRUE))
3561 /* it is actually just a matter of turning the utf8 flag on, but
3562 * we want to make sure everything inside is valid utf8 first.
3564 c = start = (const U8 *) SvPVX_const(sv);
3565 if (!is_utf8_string(c, SvCUR(sv)+1))
3567 e = (const U8 *) SvEND(sv);
3570 if (!UTF8_IS_INVARIANT(ch)) {
3575 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3576 /* adjust pos to the start of a UTF8 char sequence */
3577 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3579 I32 pos = mg->mg_len;
3581 for (c = start + pos; c > start; c--) {
3582 if (UTF8_IS_START(*c))
3585 mg->mg_len = c - start;
3588 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3589 magic_setutf8(sv,mg); /* clear UTF8 cache */
3596 =for apidoc sv_setsv
3598 Copies the contents of the source SV C<ssv> into the destination SV
3599 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3600 function if the source SV needs to be reused. Does not handle 'set' magic.
3601 Loosely speaking, it performs a copy-by-value, obliterating any previous
3602 content of the destination.
3604 You probably want to use one of the assortment of wrappers, such as
3605 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3606 C<SvSetMagicSV_nosteal>.
3608 =for apidoc sv_setsv_flags
3610 Copies the contents of the source SV C<ssv> into the destination SV
3611 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3612 function if the source SV needs to be reused. Does not handle 'set' magic.
3613 Loosely speaking, it performs a copy-by-value, obliterating any previous
3614 content of the destination.
3615 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3616 C<ssv> if appropriate, else not. If the C<flags>
3617 parameter has the C<NOSTEAL> bit set then the
3618 buffers of temps will not be stolen. <sv_setsv>
3619 and C<sv_setsv_nomg> are implemented in terms of this function.
3621 You probably want to use one of the assortment of wrappers, such as
3622 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3623 C<SvSetMagicSV_nosteal>.
3625 This is the primary function for copying scalars, and most other
3626 copy-ish functions and macros use this underneath.
3632 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3634 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3635 HV *old_stash = NULL;
3637 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3639 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3640 const char * const name = GvNAME(sstr);
3641 const STRLEN len = GvNAMELEN(sstr);
3643 if (dtype >= SVt_PV) {
3649 SvUPGRADE(dstr, SVt_PVGV);
3650 (void)SvOK_off(dstr);
3651 /* We have to turn this on here, even though we turn it off
3652 below, as GvSTASH will fail an assertion otherwise. */
3653 isGV_with_GP_on(dstr);
3655 GvSTASH(dstr) = GvSTASH(sstr);
3657 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3658 gv_name_set(MUTABLE_GV(dstr), name, len,
3659 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3660 SvFAKE_on(dstr); /* can coerce to non-glob */
3663 if(GvGP(MUTABLE_GV(sstr))) {
3664 /* If source has method cache entry, clear it */
3666 SvREFCNT_dec(GvCV(sstr));
3667 GvCV_set(sstr, NULL);
3670 /* If source has a real method, then a method is
3673 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3679 /* If dest already had a real method, that's a change as well */
3681 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3682 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3687 /* We don't need to check the name of the destination if it was not a
3688 glob to begin with. */
3689 if(dtype == SVt_PVGV) {
3690 const char * const name = GvNAME((const GV *)dstr);
3693 /* The stash may have been detached from the symbol table, so
3695 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3696 && GvAV((const GV *)sstr)
3700 const STRLEN len = GvNAMELEN(dstr);
3701 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3702 || (len == 1 && name[0] == ':')) {
3705 /* Set aside the old stash, so we can reset isa caches on
3707 if((old_stash = GvHV(dstr)))
3708 /* Make sure we do not lose it early. */
3709 SvREFCNT_inc_simple_void_NN(
3710 sv_2mortal((SV *)old_stash)
3716 gp_free(MUTABLE_GV(dstr));
3717 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3718 (void)SvOK_off(dstr);
3719 isGV_with_GP_on(dstr);
3720 GvINTRO_off(dstr); /* one-shot flag */
3721 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3722 if (SvTAINTED(sstr))
3724 if (GvIMPORTED(dstr) != GVf_IMPORTED
3725 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3727 GvIMPORTED_on(dstr);
3730 if(mro_changes == 2) {
3732 SV * const sref = (SV *)GvAV((const GV *)dstr);
3733 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3734 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3735 AV * const ary = newAV();
3736 av_push(ary, mg->mg_obj); /* takes the refcount */
3737 mg->mg_obj = (SV *)ary;
3739 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3741 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3742 mro_isa_changed_in(GvSTASH(dstr));
3744 else if(mro_changes == 3) {
3745 HV * const stash = GvHV(dstr);
3746 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3752 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3757 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3759 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3761 const int intro = GvINTRO(dstr);
3764 const U32 stype = SvTYPE(sref);
3766 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3769 GvINTRO_off(dstr); /* one-shot flag */
3770 GvLINE(dstr) = CopLINE(PL_curcop);
3771 GvEGV(dstr) = MUTABLE_GV(dstr);
3776 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3777 import_flag = GVf_IMPORTED_CV;
3780 location = (SV **) &GvHV(dstr);
3781 import_flag = GVf_IMPORTED_HV;
3784 location = (SV **) &GvAV(dstr);
3785 import_flag = GVf_IMPORTED_AV;
3788 location = (SV **) &GvIOp(dstr);
3791 location = (SV **) &GvFORM(dstr);
3794 location = &GvSV(dstr);
3795 import_flag = GVf_IMPORTED_SV;
3798 if (stype == SVt_PVCV) {
3799 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3800 if (GvCVGEN(dstr)) {
3801 SvREFCNT_dec(GvCV(dstr));
3802 GvCV_set(dstr, NULL);
3803 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3806 SAVEGENERICSV(*location);
3810 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3811 CV* const cv = MUTABLE_CV(*location);
3813 if (!GvCVGEN((const GV *)dstr) &&
3814 (CvROOT(cv) || CvXSUB(cv)) &&
3815 /* redundant check that avoids creating the extra SV
3816 most of the time: */
3817 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3819 SV * const new_const_sv =
3820 CvCONST((const CV *)sref)
3821 ? cv_const_sv((const CV *)sref)
3823 report_redefined_cv(
3824 sv_2mortal(Perl_newSVpvf(aTHX_
3827 HvNAME_HEK(GvSTASH((const GV *)dstr))
3829 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3832 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3836 cv_ckproto_len_flags(cv, (const GV *)dstr,
3837 SvPOK(sref) ? CvPROTO(sref) : NULL,
3838 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3839 SvPOK(sref) ? SvUTF8(sref) : 0);
3841 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3842 GvASSUMECV_on(dstr);
3843 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3846 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3847 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3848 GvFLAGS(dstr) |= import_flag;
3850 if (stype == SVt_PVHV) {
3851 const char * const name = GvNAME((GV*)dstr);
3852 const STRLEN len = GvNAMELEN(dstr);
3855 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3856 || (len == 1 && name[0] == ':')
3858 && (!dref || HvENAME_get(dref))
3861 (HV *)sref, (HV *)dref,
3867 stype == SVt_PVAV && sref != dref
3868 && strEQ(GvNAME((GV*)dstr), "ISA")
3869 /* The stash may have been detached from the symbol table, so
3870 check its name before doing anything. */
3871 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3874 MAGIC * const omg = dref && SvSMAGICAL(dref)
3875 ? mg_find(dref, PERL_MAGIC_isa)
3877 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3878 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3879 AV * const ary = newAV();
3880 av_push(ary, mg->mg_obj); /* takes the refcount */
3881 mg->mg_obj = (SV *)ary;
3884 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3885 SV **svp = AvARRAY((AV *)omg->mg_obj);
3886 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3890 SvREFCNT_inc_simple_NN(*svp++)
3896 SvREFCNT_inc_simple_NN(omg->mg_obj)
3900 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3905 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3907 mg = mg_find(sref, PERL_MAGIC_isa);
3909 /* Since the *ISA assignment could have affected more than
3910 one stash, don't call mro_isa_changed_in directly, but let
3911 magic_clearisa do it for us, as it already has the logic for
3912 dealing with globs vs arrays of globs. */
3914 Perl_magic_clearisa(aTHX_ NULL, mg);
3919 if (SvTAINTED(sstr))
3925 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3928 register U32 sflags;
3930 register svtype stype;
3932 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3937 if (SvIS_FREED(dstr)) {
3938 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3939 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3941 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3943 sstr = &PL_sv_undef;
3944 if (SvIS_FREED(sstr)) {
3945 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3946 (void*)sstr, (void*)dstr);
3948 stype = SvTYPE(sstr);
3949 dtype = SvTYPE(dstr);
3951 (void)SvAMAGIC_off(dstr);
3954 /* need to nuke the magic */
3955 sv_unmagic(dstr, PERL_MAGIC_vstring);
3958 /* There's a lot of redundancy below but we're going for speed here */
3963 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3964 (void)SvOK_off(dstr);
3972 sv_upgrade(dstr, SVt_IV);
3976 sv_upgrade(dstr, SVt_PVIV);
3980 goto end_of_first_switch;
3982 (void)SvIOK_only(dstr);
3983 SvIV_set(dstr, SvIVX(sstr));
3986 /* SvTAINTED can only be true if the SV has taint magic, which in
3987 turn means that the SV type is PVMG (or greater). This is the
3988 case statement for SVt_IV, so this cannot be true (whatever gcov
3990 assert(!SvTAINTED(sstr));
3995 if (dtype < SVt_PV && dtype != SVt_IV)
3996 sv_upgrade(dstr, SVt_IV);
4004 sv_upgrade(dstr, SVt_NV);
4008 sv_upgrade(dstr, SVt_PVNV);
4012 goto end_of_first_switch;
4014 SvNV_set(dstr, SvNVX(sstr));
4015 (void)SvNOK_only(dstr);
4016 /* SvTAINTED can only be true if the SV has taint magic, which in
4017 turn means that the SV type is PVMG (or greater). This is the
4018 case statement for SVt_NV, so this cannot be true (whatever gcov
4020 assert(!SvTAINTED(sstr));
4026 #ifdef PERL_OLD_COPY_ON_WRITE
4027 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4028 if (dtype < SVt_PVIV)
4029 sv_upgrade(dstr, SVt_PVIV);
4036 sv_upgrade(dstr, SVt_PV);
4039 if (dtype < SVt_PVIV)
4040 sv_upgrade(dstr, SVt_PVIV);
4043 if (dtype < SVt_PVNV)
4044 sv_upgrade(dstr, SVt_PVNV);
4048 const char * const type = sv_reftype(sstr,0);
4050 /* diag_listed_as: Bizarre copy of %s */
4051 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4053 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4058 if (dtype < SVt_REGEXP)
4059 sv_upgrade(dstr, SVt_REGEXP);
4062 /* case SVt_BIND: */
4066 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4068 if (SvTYPE(sstr) != stype)
4069 stype = SvTYPE(sstr);
4071 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4072 glob_assign_glob(dstr, sstr, dtype);
4075 if (stype == SVt_PVLV)
4076 SvUPGRADE(dstr, SVt_PVNV);
4078 SvUPGRADE(dstr, (svtype)stype);
4080 end_of_first_switch:
4082 /* dstr may have been upgraded. */
4083 dtype = SvTYPE(dstr);
4084 sflags = SvFLAGS(sstr);
4086 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4087 /* Assigning to a subroutine sets the prototype. */
4090 const char *const ptr = SvPV_const(sstr, len);
4092 SvGROW(dstr, len + 1);
4093 Copy(ptr, SvPVX(dstr), len + 1, char);
4094 SvCUR_set(dstr, len);
4096 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4097 CvAUTOLOAD_off(dstr);
4101 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4102 const char * const type = sv_reftype(dstr,0);
4104 /* diag_listed_as: Cannot copy to %s */
4105 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4107 Perl_croak(aTHX_ "Cannot copy to %s", type);
4108 } else if (sflags & SVf_ROK) {
4109 if (isGV_with_GP(dstr)
4110 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4113 if (GvIMPORTED(dstr) != GVf_IMPORTED
4114 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4116 GvIMPORTED_on(dstr);
4121 glob_assign_glob(dstr, sstr, dtype);
4125 if (dtype >= SVt_PV) {
4126 if (isGV_with_GP(dstr)) {
4127 glob_assign_ref(dstr, sstr);
4130 if (SvPVX_const(dstr)) {
4136 (void)SvOK_off(dstr);
4137 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4138 SvFLAGS(dstr) |= sflags & SVf_ROK;
4139 assert(!(sflags & SVp_NOK));
4140 assert(!(sflags & SVp_IOK));
4141 assert(!(sflags & SVf_NOK));
4142 assert(!(sflags & SVf_IOK));
4144 else if (isGV_with_GP(dstr)) {
4145 if (!(sflags & SVf_OK)) {
4146 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4147 "Undefined value assigned to typeglob");
4150 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4151 if (dstr != (const SV *)gv) {
4152 const char * const name = GvNAME((const GV *)dstr);
4153 const STRLEN len = GvNAMELEN(dstr);
4154 HV *old_stash = NULL;
4155 bool reset_isa = FALSE;
4156 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4157 || (len == 1 && name[0] == ':')) {
4158 /* Set aside the old stash, so we can reset isa caches
4159 on its subclasses. */
4160 if((old_stash = GvHV(dstr))) {
4161 /* Make sure we do not lose it early. */
4162 SvREFCNT_inc_simple_void_NN(
4163 sv_2mortal((SV *)old_stash)
4170 gp_free(MUTABLE_GV(dstr));
4171 GvGP_set(dstr, gp_ref(GvGP(gv)));
4174 HV * const stash = GvHV(dstr);
4176 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4186 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4187 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4189 else if (sflags & SVp_POK) {
4193 * Check to see if we can just swipe the string. If so, it's a
4194 * possible small lose on short strings, but a big win on long ones.
4195 * It might even be a win on short strings if SvPVX_const(dstr)
4196 * has to be allocated and SvPVX_const(sstr) has to be freed.
4197 * Likewise if we can set up COW rather than doing an actual copy, we
4198 * drop to the else clause, as the swipe code and the COW setup code
4199 * have much in common.
4202 /* Whichever path we take through the next code, we want this true,
4203 and doing it now facilitates the COW check. */
4204 (void)SvPOK_only(dstr);
4207 /* If we're already COW then this clause is not true, and if COW
4208 is allowed then we drop down to the else and make dest COW
4209 with us. If caller hasn't said that we're allowed to COW
4210 shared hash keys then we don't do the COW setup, even if the
4211 source scalar is a shared hash key scalar. */
4212 (((flags & SV_COW_SHARED_HASH_KEYS)
4213 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4214 : 1 /* If making a COW copy is forbidden then the behaviour we
4215 desire is as if the source SV isn't actually already
4216 COW, even if it is. So we act as if the source flags
4217 are not COW, rather than actually testing them. */
4219 #ifndef PERL_OLD_COPY_ON_WRITE
4220 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4221 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4222 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4223 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4224 but in turn, it's somewhat dead code, never expected to go
4225 live, but more kept as a placeholder on how to do it better
4226 in a newer implementation. */
4227 /* If we are COW and dstr is a suitable target then we drop down
4228 into the else and make dest a COW of us. */
4229 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4234 (sflags & SVs_TEMP) && /* slated for free anyway? */
4235 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4236 (!(flags & SV_NOSTEAL)) &&
4237 /* and we're allowed to steal temps */
4238 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4239 SvLEN(sstr)) /* and really is a string */
4240 #ifdef PERL_OLD_COPY_ON_WRITE
4241 && ((flags & SV_COW_SHARED_HASH_KEYS)
4242 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4243 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4244 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4248 /* Failed the swipe test, and it's not a shared hash key either.
4249 Have to copy the string. */
4250 STRLEN len = SvCUR(sstr);
4251 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4252 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4253 SvCUR_set(dstr, len);
4254 *SvEND(dstr) = '\0';
4256 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4258 /* Either it's a shared hash key, or it's suitable for
4259 copy-on-write or we can swipe the string. */
4261 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4265 #ifdef PERL_OLD_COPY_ON_WRITE
4267 if ((sflags & (SVf_FAKE | SVf_READONLY))
4268 != (SVf_FAKE | SVf_READONLY)) {
4269 SvREADONLY_on(sstr);
4271 /* Make the source SV into a loop of 1.
4272 (about to become 2) */
4273 SV_COW_NEXT_SV_SET(sstr, sstr);
4277 /* Initial code is common. */
4278 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4283 /* making another shared SV. */
4284 STRLEN cur = SvCUR(sstr);
4285 STRLEN len = SvLEN(sstr);
4286 #ifdef PERL_OLD_COPY_ON_WRITE
4288 assert (SvTYPE(dstr) >= SVt_PVIV);
4289 /* SvIsCOW_normal */
4290 /* splice us in between source and next-after-source. */
4291 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4292 SV_COW_NEXT_SV_SET(sstr, dstr);
4293 SvPV_set(dstr, SvPVX_mutable(sstr));
4297 /* SvIsCOW_shared_hash */
4298 DEBUG_C(PerlIO_printf(Perl_debug_log,
4299 "Copy on write: Sharing hash\n"));
4301 assert (SvTYPE(dstr) >= SVt_PV);
4303 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4305 SvLEN_set(dstr, len);
4306 SvCUR_set(dstr, cur);
4307 SvREADONLY_on(dstr);
4311 { /* Passes the swipe test. */
4312 SvPV_set(dstr, SvPVX_mutable(sstr));
4313 SvLEN_set(dstr, SvLEN(sstr));
4314 SvCUR_set(dstr, SvCUR(sstr));
4317 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4318 SvPV_set(sstr, NULL);
4324 if (sflags & SVp_NOK) {
4325 SvNV_set(dstr, SvNVX(sstr));
4327 if (sflags & SVp_IOK) {
4328 SvIV_set(dstr, SvIVX(sstr));
4329 /* Must do this otherwise some other overloaded use of 0x80000000
4330 gets confused. I guess SVpbm_VALID */
4331 if (sflags & SVf_IVisUV)
4334 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4336 const MAGIC * const smg = SvVSTRING_mg(sstr);
4338 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4339 smg->mg_ptr, smg->mg_len);
4340 SvRMAGICAL_on(dstr);
4344 else if (sflags & (SVp_IOK|SVp_NOK)) {
4345 (void)SvOK_off(dstr);
4346 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4347 if (sflags & SVp_IOK) {
4348 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4349 SvIV_set(dstr, SvIVX(sstr));
4351 if (sflags & SVp_NOK) {
4352 SvNV_set(dstr, SvNVX(sstr));
4356 if (isGV_with_GP(sstr)) {
4357 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4360 (void)SvOK_off(dstr);
4362 if (SvTAINTED(sstr))
4367 =for apidoc sv_setsv_mg
4369 Like C<sv_setsv>, but also handles 'set' magic.
4375 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4377 PERL_ARGS_ASSERT_SV_SETSV_MG;
4379 sv_setsv(dstr,sstr);
4383 #ifdef PERL_OLD_COPY_ON_WRITE
4385 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4387 STRLEN cur = SvCUR(sstr);
4388 STRLEN len = SvLEN(sstr);
4389 register char *new_pv;
4391 PERL_ARGS_ASSERT_SV_SETSV_COW;
4394 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4395 (void*)sstr, (void*)dstr);
4402 if (SvTHINKFIRST(dstr))
4403 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4404 else if (SvPVX_const(dstr))
4405 Safefree(SvPVX_const(dstr));
4409 SvUPGRADE(dstr, SVt_PVIV);
4411 assert (SvPOK(sstr));
4412 assert (SvPOKp(sstr));
4413 assert (!SvIOK(sstr));
4414 assert (!SvIOKp(sstr));
4415 assert (!SvNOK(sstr));
4416 assert (!SvNOKp(sstr));
4418 if (SvIsCOW(sstr)) {
4420 if (SvLEN(sstr) == 0) {
4421 /* source is a COW shared hash key. */
4422 DEBUG_C(PerlIO_printf(Perl_debug_log,
4423 "Fast copy on write: Sharing hash\n"));
4424 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4427 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4429 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4430 SvUPGRADE(sstr, SVt_PVIV);
4431 SvREADONLY_on(sstr);
4433 DEBUG_C(PerlIO_printf(Perl_debug_log,
4434 "Fast copy on write: Converting sstr to COW\n"));
4435 SV_COW_NEXT_SV_SET(dstr, sstr);
4437 SV_COW_NEXT_SV_SET(sstr, dstr);
4438 new_pv = SvPVX_mutable(sstr);
4441 SvPV_set(dstr, new_pv);
4442 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4445 SvLEN_set(dstr, len);
4446 SvCUR_set(dstr, cur);
4455 =for apidoc sv_setpvn
4457 Copies a string into an SV. The C<len> parameter indicates the number of
4458 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4459 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4465 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4468 register char *dptr;
4470 PERL_ARGS_ASSERT_SV_SETPVN;
4472 SV_CHECK_THINKFIRST_COW_DROP(sv);
4478 /* len is STRLEN which is unsigned, need to copy to signed */
4481 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4484 SvUPGRADE(sv, SVt_PV);
4486 dptr = SvGROW(sv, len + 1);
4487 Move(ptr,dptr,len,char);
4490 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4492 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4496 =for apidoc sv_setpvn_mg
4498 Like C<sv_setpvn>, but also handles 'set' magic.
4504 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4506 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4508 sv_setpvn(sv,ptr,len);
4513 =for apidoc sv_setpv
4515 Copies a string into an SV. The string must be null-terminated. Does not
4516 handle 'set' magic. See C<sv_setpv_mg>.
4522 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4525 register STRLEN len;
4527 PERL_ARGS_ASSERT_SV_SETPV;
4529 SV_CHECK_THINKFIRST_COW_DROP(sv);
4535 SvUPGRADE(sv, SVt_PV);
4537 SvGROW(sv, len + 1);
4538 Move(ptr,SvPVX(sv),len+1,char);
4540 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4542 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4546 =for apidoc sv_setpv_mg
4548 Like C<sv_setpv>, but also handles 'set' magic.
4554 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4556 PERL_ARGS_ASSERT_SV_SETPV_MG;
4563 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4567 PERL_ARGS_ASSERT_SV_SETHEK;
4573 if (HEK_LEN(hek) == HEf_SVKEY) {
4574 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4577 const int flags = HEK_FLAGS(hek);
4578 if (flags & HVhek_WASUTF8) {
4579 STRLEN utf8_len = HEK_LEN(hek);
4580 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4581 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4584 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4585 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4588 else SvUTF8_off(sv);
4592 SV_CHECK_THINKFIRST_COW_DROP(sv);
4593 SvUPGRADE(sv, SVt_PV);
4594 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4595 SvCUR_set(sv, HEK_LEN(hek));
4602 else SvUTF8_off(sv);
4610 =for apidoc sv_usepvn_flags
4612 Tells an SV to use C<ptr> to find its string value. Normally the
4613 string is stored inside the SV but sv_usepvn allows the SV to use an
4614 outside string. The C<ptr> should point to memory that was allocated
4615 by C<malloc>. It must be the start of a mallocked block
4616 of memory, and not a pointer to the middle of it. The
4617 string length, C<len>, must be supplied. By default
4618 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4619 so that pointer should not be freed or used by the programmer after
4620 giving it to sv_usepvn, and neither should any pointers from "behind"
4621 that pointer (e.g. ptr + 1) be used.
4623 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4624 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4625 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4626 C<len>, and already meets the requirements for storing in C<SvPVX>).
4632 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4637 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4639 SV_CHECK_THINKFIRST_COW_DROP(sv);
4640 SvUPGRADE(sv, SVt_PV);
4643 if (flags & SV_SMAGIC)
4647 if (SvPVX_const(sv))
4651 if (flags & SV_HAS_TRAILING_NUL)
4652 assert(ptr[len] == '\0');
4655 allocate = (flags & SV_HAS_TRAILING_NUL)
4657 #ifdef Perl_safesysmalloc_size
4660 PERL_STRLEN_ROUNDUP(len + 1);
4662 if (flags & SV_HAS_TRAILING_NUL) {
4663 /* It's long enough - do nothing.
4664 Specifically Perl_newCONSTSUB is relying on this. */
4667 /* Force a move to shake out bugs in callers. */
4668 char *new_ptr = (char*)safemalloc(allocate);
4669 Copy(ptr, new_ptr, len, char);
4670 PoisonFree(ptr,len,char);
4674 ptr = (char*) saferealloc (ptr, allocate);
4677 #ifdef Perl_safesysmalloc_size
4678 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4680 SvLEN_set(sv, allocate);
4684 if (!(flags & SV_HAS_TRAILING_NUL)) {
4687 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4689 if (flags & SV_SMAGIC)
4693 #ifdef PERL_OLD_COPY_ON_WRITE
4694 /* Need to do this *after* making the SV normal, as we need the buffer
4695 pointer to remain valid until after we've copied it. If we let go too early,
4696 another thread could invalidate it by unsharing last of the same hash key
4697 (which it can do by means other than releasing copy-on-write Svs)
4698 or by changing the other copy-on-write SVs in the loop. */
4700 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4702 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4704 { /* this SV was SvIsCOW_normal(sv) */
4705 /* we need to find the SV pointing to us. */
4706 SV *current = SV_COW_NEXT_SV(after);
4708 if (current == sv) {
4709 /* The SV we point to points back to us (there were only two of us
4711 Hence other SV is no longer copy on write either. */
4713 SvREADONLY_off(after);
4715 /* We need to follow the pointers around the loop. */
4717 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4720 /* don't loop forever if the structure is bust, and we have
4721 a pointer into a closed loop. */
4722 assert (current != after);
4723 assert (SvPVX_const(current) == pvx);
4725 /* Make the SV before us point to the SV after us. */
4726 SV_COW_NEXT_SV_SET(current, after);
4732 =for apidoc sv_force_normal_flags
4734 Undo various types of fakery on an SV: if the PV is a shared string, make
4735 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4736 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4737 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4738 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4739 SvPOK_off rather than making a copy. (Used where this
4740 scalar is about to be set to some other value.) In addition,
4741 the C<flags> parameter gets passed to C<sv_unref_flags()>
4742 when unreffing. C<sv_force_normal> calls this function
4743 with flags set to 0.
4749 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4753 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4755 #ifdef PERL_OLD_COPY_ON_WRITE
4756 if (SvREADONLY(sv)) {
4758 const char * const pvx = SvPVX_const(sv);
4759 const STRLEN len = SvLEN(sv);
4760 const STRLEN cur = SvCUR(sv);
4761 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4762 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4763 we'll fail an assertion. */
4764 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4767 PerlIO_printf(Perl_debug_log,
4768 "Copy on write: Force normal %ld\n",
4774 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4777 if (flags & SV_COW_DROP_PV) {
4778 /* OK, so we don't need to copy our buffer. */
4781 SvGROW(sv, cur + 1);
4782 Move(pvx,SvPVX(sv),cur,char);
4787 sv_release_COW(sv, pvx, next);
4789 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4795 else if (IN_PERL_RUNTIME)
4796 Perl_croak_no_modify(aTHX);
4799 if (SvREADONLY(sv)) {
4800 if (SvFAKE(sv) && !isGV_with_GP(sv)) {
4801 const char * const pvx = SvPVX_const(sv);
4802 const STRLEN len = SvCUR(sv);
4807 if (flags & SV_COW_DROP_PV) {
4808 /* OK, so we don't need to copy our buffer. */
4811 SvGROW(sv, len + 1);
4812 Move(pvx,SvPVX(sv),len,char);
4815 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4817 else if (IN_PERL_RUNTIME)
4818 Perl_croak_no_modify(aTHX);
4822 sv_unref_flags(sv, flags);
4823 else if (SvFAKE(sv) && isGV_with_GP(sv))
4824 sv_unglob(sv, flags);
4825 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4826 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4827 to sv_unglob. We only need it here, so inline it. */
4828 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4829 SV *const temp = newSV_type(new_type);
4830 void *const temp_p = SvANY(sv);
4832 if (new_type == SVt_PVMG) {
4833 SvMAGIC_set(temp, SvMAGIC(sv));
4834 SvMAGIC_set(sv, NULL);
4835 SvSTASH_set(temp, SvSTASH(sv));
4836 SvSTASH_set(sv, NULL);
4838 SvCUR_set(temp, SvCUR(sv));
4839 /* Remember that SvPVX is in the head, not the body. */
4841 SvLEN_set(temp, SvLEN(sv));
4842 /* This signals "buffer is owned by someone else" in sv_clear,
4843 which is the least effort way to stop it freeing the buffer.
4845 SvLEN_set(sv, SvLEN(sv)+1);
4847 /* Their buffer is already owned by someone else. */
4848 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4849 SvLEN_set(temp, SvCUR(sv)+1);
4852 /* Now swap the rest of the bodies. */
4854 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4855 SvFLAGS(sv) |= new_type;
4856 SvANY(sv) = SvANY(temp);
4858 SvFLAGS(temp) &= ~(SVTYPEMASK);
4859 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4860 SvANY(temp) = temp_p;
4869 Efficient removal of characters from the beginning of the string buffer.
4870 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4871 the string buffer. The C<ptr> becomes the first character of the adjusted
4872 string. Uses the "OOK hack".
4874 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4875 refer to the same chunk of data.
4877 The unfortunate similarity of this function's name to that of Perl's C<chop>
4878 operator is strictly coincidental. This function works from the left;
4879 C<chop> works from the right.
4885 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4896 PERL_ARGS_ASSERT_SV_CHOP;
4898 if (!ptr || !SvPOKp(sv))
4900 delta = ptr - SvPVX_const(sv);
4902 /* Nothing to do. */
4905 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4906 if (delta > max_delta)
4907 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4908 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4909 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4910 SV_CHECK_THINKFIRST(sv);
4913 if (!SvLEN(sv)) { /* make copy of shared string */
4914 const char *pvx = SvPVX_const(sv);
4915 const STRLEN len = SvCUR(sv);
4916 SvGROW(sv, len + 1);
4917 Move(pvx,SvPVX(sv),len,char);
4923 SvOOK_offset(sv, old_delta);
4925 SvLEN_set(sv, SvLEN(sv) - delta);
4926 SvCUR_set(sv, SvCUR(sv) - delta);
4927 SvPV_set(sv, SvPVX(sv) + delta);
4929 p = (U8 *)SvPVX_const(sv);
4932 /* how many bytes were evacuated? we will fill them with sentinel
4933 bytes, except for the part holding the new offset of course. */
4936 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4938 assert(evacn <= delta + old_delta);
4944 if (delta < 0x100) {
4948 p -= sizeof(STRLEN);
4949 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4953 /* Fill the preceding buffer with sentinals to verify that no-one is
4963 =for apidoc sv_catpvn
4965 Concatenates the string onto the end of the string which is in the SV. The
4966 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4967 status set, then the bytes appended should be valid UTF-8.
4968 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4970 =for apidoc sv_catpvn_flags
4972 Concatenates the string onto the end of the string which is in the SV. The
4973 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4974 status set, then the bytes appended should be valid UTF-8.
4975 If C<flags> has the C<SV_SMAGIC> bit set, will
4976 C<mg_set> on C<dsv> afterwards if appropriate.
4977 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4978 in terms of this function.
4984 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4988 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4990 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4991 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
4993 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
4994 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
4995 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
4998 else SvGROW(dsv, dlen + slen + 1);
5000 sstr = SvPVX_const(dsv);
5001 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5002 SvCUR_set(dsv, SvCUR(dsv) + slen);
5005 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5006 const char * const send = sstr + slen;
5009 /* Something this code does not account for, which I think is
5010 impossible; it would require the same pv to be treated as
5011 bytes *and* utf8, which would indicate a bug elsewhere. */
5012 assert(sstr != dstr);
5014 SvGROW(dsv, dlen + slen * 2 + 1);
5015 d = (U8 *)SvPVX(dsv) + dlen;
5017 while (sstr < send) {
5018 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5019 if (UNI_IS_INVARIANT(uv))
5020 *d++ = (U8)UTF_TO_NATIVE(uv);
5022 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5023 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5026 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5029 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5031 if (flags & SV_SMAGIC)
5036 =for apidoc sv_catsv
5038 Concatenates the string from SV C<ssv> onto the end of the string in
5039 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5040 not 'set' magic. See C<sv_catsv_mg>.
5042 =for apidoc sv_catsv_flags
5044 Concatenates the string from SV C<ssv> onto the end of the string in
5045 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5046 bit set, will C<mg_get> on the C<ssv>, if appropriate, before
5047 reading it. If the C<flags> contain C<SV_SMAGIC>, C<mg_set> will be
5048 called on the modified SV afterward, if appropriate. C<sv_catsv>
5049 and C<sv_catsv_nomg> are implemented in terms of this function.
5054 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5058 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5062 const char *spv = SvPV_flags_const(ssv, slen, flags);
5064 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5066 sv_catpvn_flags(dsv, spv, slen,
5067 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5070 if (flags & SV_SMAGIC)
5075 =for apidoc sv_catpv
5077 Concatenates the string onto the end of the string which is in the SV.
5078 If the SV has the UTF-8 status set, then the bytes appended should be
5079 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5084 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5087 register STRLEN len;
5091 PERL_ARGS_ASSERT_SV_CATPV;
5095 junk = SvPV_force(sv, tlen);
5097 SvGROW(sv, tlen + len + 1);
5099 ptr = SvPVX_const(sv);
5100 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5101 SvCUR_set(sv, SvCUR(sv) + len);
5102 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5107 =for apidoc sv_catpv_flags
5109 Concatenates the string onto the end of the string which is in the SV.
5110 If the SV has the UTF-8 status set, then the bytes appended should
5111 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5112 on the modified SV if appropriate.
5118 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5120 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5121 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5125 =for apidoc sv_catpv_mg
5127 Like C<sv_catpv>, but also handles 'set' magic.
5133 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5135 PERL_ARGS_ASSERT_SV_CATPV_MG;
5144 Creates a new SV. A non-zero C<len> parameter indicates the number of
5145 bytes of preallocated string space the SV should have. An extra byte for a
5146 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5147 space is allocated.) The reference count for the new SV is set to 1.
5149 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5150 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5151 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5152 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5153 modules supporting older perls.
5159 Perl_newSV(pTHX_ const STRLEN len)
5166 sv_upgrade(sv, SVt_PV);
5167 SvGROW(sv, len + 1);
5172 =for apidoc sv_magicext
5174 Adds magic to an SV, upgrading it if necessary. Applies the
5175 supplied vtable and returns a pointer to the magic added.
5177 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5178 In particular, you can add magic to SvREADONLY SVs, and add more than
5179 one instance of the same 'how'.
5181 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5182 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5183 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5184 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5186 (This is now used as a subroutine by C<sv_magic>.)
5191 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5192 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5197 PERL_ARGS_ASSERT_SV_MAGICEXT;
5199 SvUPGRADE(sv, SVt_PVMG);
5200 Newxz(mg, 1, MAGIC);
5201 mg->mg_moremagic = SvMAGIC(sv);
5202 SvMAGIC_set(sv, mg);
5204 /* Sometimes a magic contains a reference loop, where the sv and
5205 object refer to each other. To prevent a reference loop that
5206 would prevent such objects being freed, we look for such loops
5207 and if we find one we avoid incrementing the object refcount.
5209 Note we cannot do this to avoid self-tie loops as intervening RV must
5210 have its REFCNT incremented to keep it in existence.
5213 if (!obj || obj == sv ||
5214 how == PERL_MAGIC_arylen ||
5215 how == PERL_MAGIC_symtab ||
5216 (SvTYPE(obj) == SVt_PVGV &&
5217 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5218 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5219 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5224 mg->mg_obj = SvREFCNT_inc_simple(obj);
5225 mg->mg_flags |= MGf_REFCOUNTED;
5228 /* Normal self-ties simply pass a null object, and instead of
5229 using mg_obj directly, use the SvTIED_obj macro to produce a
5230 new RV as needed. For glob "self-ties", we are tieing the PVIO
5231 with an RV obj pointing to the glob containing the PVIO. In
5232 this case, to avoid a reference loop, we need to weaken the
5236 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5237 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5243 mg->mg_len = namlen;
5246 mg->mg_ptr = savepvn(name, namlen);
5247 else if (namlen == HEf_SVKEY) {
5248 /* Yes, this is casting away const. This is only for the case of
5249 HEf_SVKEY. I think we need to document this aberation of the
5250 constness of the API, rather than making name non-const, as
5251 that change propagating outwards a long way. */
5252 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5254 mg->mg_ptr = (char *) name;
5256 mg->mg_virtual = (MGVTBL *) vtable;
5260 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5265 =for apidoc sv_magic
5267 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5268 necessary, then adds a new magic item of type C<how> to the head of the
5271 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5272 handling of the C<name> and C<namlen> arguments.
5274 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5275 to add more than one instance of the same 'how'.
5281 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5282 const char *const name, const I32 namlen)
5285 const MGVTBL *vtable;
5288 unsigned int vtable_index;
5290 PERL_ARGS_ASSERT_SV_MAGIC;
5292 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5293 || ((flags = PL_magic_data[how]),
5294 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5295 > magic_vtable_max))
5296 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5298 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5299 Useful for attaching extension internal data to perl vars.
5300 Note that multiple extensions may clash if magical scalars
5301 etc holding private data from one are passed to another. */
5303 vtable = (vtable_index == magic_vtable_max)
5304 ? NULL : PL_magic_vtables + vtable_index;
5306 #ifdef PERL_OLD_COPY_ON_WRITE
5308 sv_force_normal_flags(sv, 0);
5310 if (SvREADONLY(sv)) {
5312 /* its okay to attach magic to shared strings */
5313 (!SvFAKE(sv) || isGV_with_GP(sv))
5316 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5319 Perl_croak_no_modify(aTHX);
5322 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5323 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5324 /* sv_magic() refuses to add a magic of the same 'how' as an
5327 if (how == PERL_MAGIC_taint) {
5329 /* Any scalar which already had taint magic on which someone
5330 (erroneously?) did SvIOK_on() or similar will now be
5331 incorrectly sporting public "OK" flags. */
5332 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5338 /* Rest of work is done else where */
5339 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5342 case PERL_MAGIC_taint:
5345 case PERL_MAGIC_ext:
5346 case PERL_MAGIC_dbfile:
5353 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5360 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5362 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5363 for (mg = *mgp; mg; mg = *mgp) {
5364 const MGVTBL* const virt = mg->mg_virtual;
5365 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5366 *mgp = mg->mg_moremagic;
5367 if (virt && virt->svt_free)
5368 virt->svt_free(aTHX_ sv, mg);
5369 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5371 Safefree(mg->mg_ptr);
5372 else if (mg->mg_len == HEf_SVKEY)
5373 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5374 else if (mg->mg_type == PERL_MAGIC_utf8)
5375 Safefree(mg->mg_ptr);
5377 if (mg->mg_flags & MGf_REFCOUNTED)
5378 SvREFCNT_dec(mg->mg_obj);
5382 mgp = &mg->mg_moremagic;
5385 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5386 mg_magical(sv); /* else fix the flags now */
5390 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5396 =for apidoc sv_unmagic
5398 Removes all magic of type C<type> from an SV.
5404 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5406 PERL_ARGS_ASSERT_SV_UNMAGIC;
5407 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5411 =for apidoc sv_unmagicext
5413 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5419 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5421 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5422 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5426 =for apidoc sv_rvweaken
5428 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5429 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5430 push a back-reference to this RV onto the array of backreferences
5431 associated with that magic. If the RV is magical, set magic will be
5432 called after the RV is cleared.
5438 Perl_sv_rvweaken(pTHX_ SV *const sv)
5442 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5444 if (!SvOK(sv)) /* let undefs pass */
5447 Perl_croak(aTHX_ "Can't weaken a nonreference");
5448 else if (SvWEAKREF(sv)) {
5449 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5452 else if (SvREADONLY(sv)) croak_no_modify();
5454 Perl_sv_add_backref(aTHX_ tsv, sv);
5460 /* Give tsv backref magic if it hasn't already got it, then push a
5461 * back-reference to sv onto the array associated with the backref magic.
5463 * As an optimisation, if there's only one backref and it's not an AV,
5464 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5465 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5469 /* A discussion about the backreferences array and its refcount:
5471 * The AV holding the backreferences is pointed to either as the mg_obj of
5472 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5473 * xhv_backreferences field. The array is created with a refcount
5474 * of 2. This means that if during global destruction the array gets
5475 * picked on before its parent to have its refcount decremented by the
5476 * random zapper, it won't actually be freed, meaning it's still there for
5477 * when its parent gets freed.
5479 * When the parent SV is freed, the extra ref is killed by
5480 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5481 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5483 * When a single backref SV is stored directly, it is not reference
5488 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5495 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5497 /* find slot to store array or singleton backref */
5499 if (SvTYPE(tsv) == SVt_PVHV) {
5500 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5503 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5505 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5506 mg = mg_find(tsv, PERL_MAGIC_backref);
5508 svp = &(mg->mg_obj);
5511 /* create or retrieve the array */
5513 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5514 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5519 SvREFCNT_inc_simple_void(av);
5520 /* av now has a refcnt of 2; see discussion above */
5522 /* move single existing backref to the array */
5524 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5528 mg->mg_flags |= MGf_REFCOUNTED;
5531 av = MUTABLE_AV(*svp);
5534 /* optimisation: store single backref directly in HvAUX or mg_obj */
5538 /* push new backref */
5539 assert(SvTYPE(av) == SVt_PVAV);
5540 if (AvFILLp(av) >= AvMAX(av)) {
5541 av_extend(av, AvFILLp(av)+1);
5543 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5546 /* delete a back-reference to ourselves from the backref magic associated
5547 * with the SV we point to.
5551 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5556 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5558 if (SvTYPE(tsv) == SVt_PVHV) {
5560 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5564 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5565 svp = mg ? &(mg->mg_obj) : NULL;
5569 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5571 /* It's possible that sv is being freed recursively part way through the
5572 freeing of tsv. If this happens, the backreferences array of tsv has
5573 already been freed, and so svp will be NULL. If this is the case,
5574 we should not panic. Instead, nothing needs doing, so return. */
5575 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5577 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5578 *svp, PL_phase_names[PL_phase], SvREFCNT(tsv));
5581 if (SvTYPE(*svp) == SVt_PVAV) {
5585 AV * const av = (AV*)*svp;
5587 assert(!SvIS_FREED(av));
5591 /* for an SV with N weak references to it, if all those
5592 * weak refs are deleted, then sv_del_backref will be called
5593 * N times and O(N^2) compares will be done within the backref
5594 * array. To ameliorate this potential slowness, we:
5595 * 1) make sure this code is as tight as possible;
5596 * 2) when looking for SV, look for it at both the head and tail of the
5597 * array first before searching the rest, since some create/destroy
5598 * patterns will cause the backrefs to be freed in order.
5605 SV **p = &svp[fill];
5606 SV *const topsv = *p;
5613 /* We weren't the last entry.
5614 An unordered list has this property that you
5615 can take the last element off the end to fill
5616 the hole, and it's still an unordered list :-)
5622 break; /* should only be one */
5629 AvFILLp(av) = fill-1;
5631 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5632 /* freed AV; skip */
5635 /* optimisation: only a single backref, stored directly */
5637 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5644 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5650 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5655 /* after multiple passes through Perl_sv_clean_all() for a thinngy
5656 * that has badly leaked, the backref array may have gotten freed,
5657 * since we only protect it against 1 round of cleanup */
5658 if (SvIS_FREED(av)) {
5659 if (PL_in_clean_all) /* All is fair */
5662 "panic: magic_killbackrefs (freed backref AV/SV)");
5666 is_array = (SvTYPE(av) == SVt_PVAV);
5668 assert(!SvIS_FREED(av));
5671 last = svp + AvFILLp(av);
5674 /* optimisation: only a single backref, stored directly */
5680 while (svp <= last) {
5682 SV *const referrer = *svp;
5683 if (SvWEAKREF(referrer)) {
5684 /* XXX Should we check that it hasn't changed? */
5685 assert(SvROK(referrer));
5686 SvRV_set(referrer, 0);
5688 SvWEAKREF_off(referrer);
5689 SvSETMAGIC(referrer);
5690 } else if (SvTYPE(referrer) == SVt_PVGV ||
5691 SvTYPE(referrer) == SVt_PVLV) {
5692 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5693 /* You lookin' at me? */
5694 assert(GvSTASH(referrer));
5695 assert(GvSTASH(referrer) == (const HV *)sv);
5696 GvSTASH(referrer) = 0;
5697 } else if (SvTYPE(referrer) == SVt_PVCV ||
5698 SvTYPE(referrer) == SVt_PVFM) {
5699 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5700 /* You lookin' at me? */
5701 assert(CvSTASH(referrer));
5702 assert(CvSTASH(referrer) == (const HV *)sv);
5703 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5706 assert(SvTYPE(sv) == SVt_PVGV);
5707 /* You lookin' at me? */
5708 assert(CvGV(referrer));
5709 assert(CvGV(referrer) == (const GV *)sv);
5710 anonymise_cv_maybe(MUTABLE_GV(sv),
5711 MUTABLE_CV(referrer));
5716 "panic: magic_killbackrefs (flags=%"UVxf")",
5717 (UV)SvFLAGS(referrer));
5728 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5734 =for apidoc sv_insert
5736 Inserts a string at the specified offset/length within the SV. Similar to
5737 the Perl substr() function. Handles get magic.
5739 =for apidoc sv_insert_flags
5741 Same as C<sv_insert>, but the extra C<flags> are passed to the
5742 C<SvPV_force_flags> that applies to C<bigstr>.
5748 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5753 register char *midend;
5754 register char *bigend;
5755 register SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5758 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5761 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5762 SvPV_force_flags(bigstr, curlen, flags);
5763 (void)SvPOK_only_UTF8(bigstr);
5764 if (offset + len > curlen) {
5765 SvGROW(bigstr, offset+len+1);
5766 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5767 SvCUR_set(bigstr, offset+len);
5771 i = littlelen - len;
5772 if (i > 0) { /* string might grow */
5773 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5774 mid = big + offset + len;
5775 midend = bigend = big + SvCUR(bigstr);
5778 while (midend > mid) /* shove everything down */
5779 *--bigend = *--midend;
5780 Move(little,big+offset,littlelen,char);
5781 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5786 Move(little,SvPVX(bigstr)+offset,len,char);
5791 big = SvPVX(bigstr);
5794 bigend = big + SvCUR(bigstr);
5796 if (midend > bigend)
5797 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5800 if (mid - big > bigend - midend) { /* faster to shorten from end */
5802 Move(little, mid, littlelen,char);
5805 i = bigend - midend;
5807 Move(midend, mid, i,char);
5811 SvCUR_set(bigstr, mid - big);
5813 else if ((i = mid - big)) { /* faster from front */
5814 midend -= littlelen;
5816 Move(big, midend - i, i, char);
5817 sv_chop(bigstr,midend-i);
5819 Move(little, mid, littlelen,char);
5821 else if (littlelen) {
5822 midend -= littlelen;
5823 sv_chop(bigstr,midend);
5824 Move(little,midend,littlelen,char);
5827 sv_chop(bigstr,midend);
5833 =for apidoc sv_replace
5835 Make the first argument a copy of the second, then delete the original.
5836 The target SV physically takes over ownership of the body of the source SV
5837 and inherits its flags; however, the target keeps any magic it owns,
5838 and any magic in the source is discarded.
5839 Note that this is a rather specialist SV copying operation; most of the
5840 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5846 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5849 const U32 refcnt = SvREFCNT(sv);
5851 PERL_ARGS_ASSERT_SV_REPLACE;
5853 SV_CHECK_THINKFIRST_COW_DROP(sv);
5854 if (SvREFCNT(nsv) != 1) {
5855 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5856 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5858 if (SvMAGICAL(sv)) {
5862 sv_upgrade(nsv, SVt_PVMG);
5863 SvMAGIC_set(nsv, SvMAGIC(sv));
5864 SvFLAGS(nsv) |= SvMAGICAL(sv);
5866 SvMAGIC_set(sv, NULL);
5870 assert(!SvREFCNT(sv));
5871 #ifdef DEBUG_LEAKING_SCALARS
5872 sv->sv_flags = nsv->sv_flags;
5873 sv->sv_any = nsv->sv_any;
5874 sv->sv_refcnt = nsv->sv_refcnt;
5875 sv->sv_u = nsv->sv_u;
5877 StructCopy(nsv,sv,SV);
5879 if(SvTYPE(sv) == SVt_IV) {
5881 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5885 #ifdef PERL_OLD_COPY_ON_WRITE
5886 if (SvIsCOW_normal(nsv)) {
5887 /* We need to follow the pointers around the loop to make the
5888 previous SV point to sv, rather than nsv. */
5891 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5894 assert(SvPVX_const(current) == SvPVX_const(nsv));
5896 /* Make the SV before us point to the SV after us. */
5898 PerlIO_printf(Perl_debug_log, "previous is\n");
5900 PerlIO_printf(Perl_debug_log,
5901 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5902 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5904 SV_COW_NEXT_SV_SET(current, sv);
5907 SvREFCNT(sv) = refcnt;
5908 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5913 /* We're about to free a GV which has a CV that refers back to us.
5914 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5918 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5923 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5926 assert(SvREFCNT(gv) == 0);
5927 assert(isGV(gv) && isGV_with_GP(gv));
5929 assert(!CvANON(cv));
5930 assert(CvGV(cv) == gv);
5932 /* will the CV shortly be freed by gp_free() ? */
5933 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5934 SvANY(cv)->xcv_gv = NULL;
5938 /* if not, anonymise: */
5939 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5940 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5941 : newSVpvn_flags( "__ANON__", 8, 0 );
5942 sv_catpvs(gvname, "::__ANON__");
5943 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5944 SvREFCNT_dec(gvname);
5948 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5953 =for apidoc sv_clear
5955 Clear an SV: call any destructors, free up any memory used by the body,
5956 and free the body itself. The SV's head is I<not> freed, although
5957 its type is set to all 1's so that it won't inadvertently be assumed
5958 to be live during global destruction etc.
5959 This function should only be called when REFCNT is zero. Most of the time
5960 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5967 Perl_sv_clear(pTHX_ SV *const orig_sv)
5972 const struct body_details *sv_type_details;
5975 register SV *sv = orig_sv;
5978 PERL_ARGS_ASSERT_SV_CLEAR;
5980 /* within this loop, sv is the SV currently being freed, and
5981 * iter_sv is the most recent AV or whatever that's being iterated
5982 * over to provide more SVs */
5988 assert(SvREFCNT(sv) == 0);
5989 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
5991 if (type <= SVt_IV) {
5992 /* See the comment in sv.h about the collusion between this
5993 * early return and the overloading of the NULL slots in the
5997 SvFLAGS(sv) &= SVf_BREAK;
5998 SvFLAGS(sv) |= SVTYPEMASK;
6002 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6004 if (type >= SVt_PVMG) {
6006 if (!curse(sv, 1)) goto get_next_sv;
6007 type = SvTYPE(sv); /* destructor may have changed it */
6009 /* Free back-references before magic, in case the magic calls
6010 * Perl code that has weak references to sv. */
6011 if (type == SVt_PVHV) {
6012 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6016 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6017 SvREFCNT_dec(SvOURSTASH(sv));
6018 } else if (SvMAGIC(sv)) {
6019 /* Free back-references before other types of magic. */
6020 sv_unmagic(sv, PERL_MAGIC_backref);
6023 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6024 SvREFCNT_dec(SvSTASH(sv));
6027 /* case SVt_BIND: */
6030 IoIFP(sv) != PerlIO_stdin() &&
6031 IoIFP(sv) != PerlIO_stdout() &&
6032 IoIFP(sv) != PerlIO_stderr() &&
6033 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6035 io_close(MUTABLE_IO(sv), FALSE);
6037 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6038 PerlDir_close(IoDIRP(sv));
6039 IoDIRP(sv) = (DIR*)NULL;
6040 Safefree(IoTOP_NAME(sv));
6041 Safefree(IoFMT_NAME(sv));
6042 Safefree(IoBOTTOM_NAME(sv));
6043 if ((const GV *)sv == PL_statgv)
6047 /* FIXME for plugins */
6048 pregfree2((REGEXP*) sv);
6052 cv_undef(MUTABLE_CV(sv));
6053 /* If we're in a stash, we don't own a reference to it.
6054 * However it does have a back reference to us, which needs to
6056 if ((stash = CvSTASH(sv)))
6057 sv_del_backref(MUTABLE_SV(stash), sv);
6060 if (PL_last_swash_hv == (const HV *)sv) {
6061 PL_last_swash_hv = NULL;
6063 if (HvTOTALKEYS((HV*)sv) > 0) {
6065 /* this statement should match the one at the beginning of
6066 * hv_undef_flags() */
6067 if ( PL_phase != PERL_PHASE_DESTRUCT
6068 && (name = HvNAME((HV*)sv)))
6071 (void)hv_delete(PL_stashcache, name,
6072 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6073 hv_name_set((HV*)sv, NULL, 0, 0);
6076 /* save old iter_sv in unused SvSTASH field */
6077 assert(!SvOBJECT(sv));
6078 SvSTASH(sv) = (HV*)iter_sv;
6081 /* XXX ideally we should save the old value of hash_index
6082 * too, but I can't think of any place to hide it. The
6083 * effect of not saving it is that for freeing hashes of
6084 * hashes, we become quadratic in scanning the HvARRAY of
6085 * the top hash looking for new entries to free; but
6086 * hopefully this will be dwarfed by the freeing of all
6087 * the nested hashes. */
6089 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6090 goto get_next_sv; /* process this new sv */
6092 /* free empty hash */
6093 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6094 assert(!HvARRAY((HV*)sv));
6098 AV* av = MUTABLE_AV(sv);
6099 if (PL_comppad == av) {
6103 if (AvREAL(av) && AvFILLp(av) > -1) {
6104 next_sv = AvARRAY(av)[AvFILLp(av)--];
6105 /* save old iter_sv in top-most slot of AV,
6106 * and pray that it doesn't get wiped in the meantime */
6107 AvARRAY(av)[AvMAX(av)] = iter_sv;
6109 goto get_next_sv; /* process this new sv */
6111 Safefree(AvALLOC(av));
6116 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6117 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6118 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6119 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6121 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6122 SvREFCNT_dec(LvTARG(sv));
6124 if (isGV_with_GP(sv)) {
6125 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6126 && HvENAME_get(stash))
6127 mro_method_changed_in(stash);
6128 gp_free(MUTABLE_GV(sv));
6130 unshare_hek(GvNAME_HEK(sv));
6131 /* If we're in a stash, we don't own a reference to it.
6132 * However it does have a back reference to us, which
6133 * needs to be cleared. */
6134 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6135 sv_del_backref(MUTABLE_SV(stash), sv);
6137 /* FIXME. There are probably more unreferenced pointers to SVs
6138 * in the interpreter struct that we should check and tidy in
6139 * a similar fashion to this: */
6140 /* See also S_sv_unglob, which does the same thing. */
6141 if ((const GV *)sv == PL_last_in_gv)
6142 PL_last_in_gv = NULL;
6143 else if ((const GV *)sv == PL_statgv)
6150 /* Don't bother with SvOOK_off(sv); as we're only going to
6154 SvOOK_offset(sv, offset);
6155 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6156 /* Don't even bother with turning off the OOK flag. */
6161 SV * const target = SvRV(sv);
6163 sv_del_backref(target, sv);
6168 #ifdef PERL_OLD_COPY_ON_WRITE
6169 else if (SvPVX_const(sv)
6170 && !(SvTYPE(sv) == SVt_PVIO
6171 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6175 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6179 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6181 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6185 } else if (SvLEN(sv)) {
6186 Safefree(SvPVX_const(sv));
6190 else if (SvPVX_const(sv) && SvLEN(sv)
6191 && !(SvTYPE(sv) == SVt_PVIO
6192 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6193 Safefree(SvPVX_mutable(sv));
6194 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6195 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6206 SvFLAGS(sv) &= SVf_BREAK;
6207 SvFLAGS(sv) |= SVTYPEMASK;
6209 sv_type_details = bodies_by_type + type;
6210 if (sv_type_details->arena) {
6211 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6212 &PL_body_roots[type]);
6214 else if (sv_type_details->body_size) {
6215 safefree(SvANY(sv));
6219 /* caller is responsible for freeing the head of the original sv */
6220 if (sv != orig_sv && !SvREFCNT(sv))
6223 /* grab and free next sv, if any */
6231 else if (!iter_sv) {
6233 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6234 AV *const av = (AV*)iter_sv;
6235 if (AvFILLp(av) > -1) {
6236 sv = AvARRAY(av)[AvFILLp(av)--];
6238 else { /* no more elements of current AV to free */
6241 /* restore previous value, squirrelled away */
6242 iter_sv = AvARRAY(av)[AvMAX(av)];
6243 Safefree(AvALLOC(av));
6246 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6247 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6248 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6249 /* no more elements of current HV to free */
6252 /* Restore previous value of iter_sv, squirrelled away */
6253 assert(!SvOBJECT(sv));
6254 iter_sv = (SV*)SvSTASH(sv);
6256 /* ideally we should restore the old hash_index here,
6257 * but we don't currently save the old value */
6260 /* free any remaining detritus from the hash struct */
6261 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6262 assert(!HvARRAY((HV*)sv));
6267 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6271 if (!SvREFCNT(sv)) {
6275 if (--(SvREFCNT(sv)))
6279 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6280 "Attempt to free temp prematurely: SV 0x%"UVxf
6281 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6285 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6286 /* make sure SvREFCNT(sv)==0 happens very seldom */
6287 SvREFCNT(sv) = (~(U32)0)/2;
6296 /* This routine curses the sv itself, not the object referenced by sv. So
6297 sv does not have to be ROK. */
6300 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6303 PERL_ARGS_ASSERT_CURSE;
6304 assert(SvOBJECT(sv));
6306 if (PL_defstash && /* Still have a symbol table? */
6313 stash = SvSTASH(sv);
6314 destructor = StashHANDLER(stash,DESTROY);
6316 /* A constant subroutine can have no side effects, so
6317 don't bother calling it. */
6318 && !CvCONST(destructor)
6319 /* Don't bother calling an empty destructor or one that
6320 returns immediately. */
6321 && (CvISXSUB(destructor)
6322 || (CvSTART(destructor)
6323 && (CvSTART(destructor)->op_next->op_type
6325 && (CvSTART(destructor)->op_next->op_type
6327 || CvSTART(destructor)->op_next->op_next->op_type
6333 SV* const tmpref = newRV(sv);
6334 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6336 PUSHSTACKi(PERLSI_DESTROY);
6341 call_sv(MUTABLE_SV(destructor),
6342 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6346 if(SvREFCNT(tmpref) < 2) {
6347 /* tmpref is not kept alive! */
6349 SvRV_set(tmpref, NULL);
6352 SvREFCNT_dec(tmpref);
6354 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6357 if (check_refcnt && SvREFCNT(sv)) {
6358 if (PL_in_clean_objs)
6360 "DESTROY created new reference to dead object '%"HEKf"'",
6361 HEKfARG(HvNAME_HEK(stash)));
6362 /* DESTROY gave object new lease on life */
6368 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6369 SvOBJECT_off(sv); /* Curse the object. */
6370 if (SvTYPE(sv) != SVt_PVIO)
6371 --PL_sv_objcount;/* XXX Might want something more general */
6377 =for apidoc sv_newref
6379 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6386 Perl_sv_newref(pTHX_ SV *const sv)
6388 PERL_UNUSED_CONTEXT;
6397 Decrement an SV's reference count, and if it drops to zero, call
6398 C<sv_clear> to invoke destructors and free up any memory used by
6399 the body; finally, deallocate the SV's head itself.
6400 Normally called via a wrapper macro C<SvREFCNT_dec>.
6406 Perl_sv_free(pTHX_ SV *const sv)
6411 if (SvREFCNT(sv) == 0) {
6412 if (SvFLAGS(sv) & SVf_BREAK)
6413 /* this SV's refcnt has been artificially decremented to
6414 * trigger cleanup */
6416 if (PL_in_clean_all) /* All is fair */
6418 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6419 /* make sure SvREFCNT(sv)==0 happens very seldom */
6420 SvREFCNT(sv) = (~(U32)0)/2;
6423 if (ckWARN_d(WARN_INTERNAL)) {
6424 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6425 Perl_dump_sv_child(aTHX_ sv);
6427 #ifdef DEBUG_LEAKING_SCALARS
6430 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6431 if (PL_warnhook == PERL_WARNHOOK_FATAL
6432 || ckDEAD(packWARN(WARN_INTERNAL))) {
6433 /* Don't let Perl_warner cause us to escape our fate: */
6437 /* This may not return: */
6438 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6439 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6440 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6443 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6448 if (--(SvREFCNT(sv)) > 0)
6450 Perl_sv_free2(aTHX_ sv);
6454 Perl_sv_free2(pTHX_ SV *const sv)
6458 PERL_ARGS_ASSERT_SV_FREE2;
6462 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6463 "Attempt to free temp prematurely: SV 0x%"UVxf
6464 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6468 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6469 /* make sure SvREFCNT(sv)==0 happens very seldom */
6470 SvREFCNT(sv) = (~(U32)0)/2;
6481 Returns the length of the string in the SV. Handles magic and type
6482 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6488 Perl_sv_len(pTHX_ register SV *const sv)
6496 len = mg_length(sv);
6498 (void)SvPV_const(sv, len);
6503 =for apidoc sv_len_utf8
6505 Returns the number of characters in the string in an SV, counting wide
6506 UTF-8 bytes as a single character. Handles magic and type coercion.
6512 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6513 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6514 * (Note that the mg_len is not the length of the mg_ptr field.
6515 * This allows the cache to store the character length of the string without
6516 * needing to malloc() extra storage to attach to the mg_ptr.)
6521 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6527 return mg_length(sv);
6531 const U8 *s = (U8*)SvPV_const(sv, len);
6535 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6537 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6538 if (mg->mg_len != -1)
6541 /* We can use the offset cache for a headstart.
6542 The longer value is stored in the first pair. */
6543 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6545 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6549 if (PL_utf8cache < 0) {
6550 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6551 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6555 ulen = Perl_utf8_length(aTHX_ s, s + len);
6556 utf8_mg_len_cache_update(sv, &mg, ulen);
6560 return Perl_utf8_length(aTHX_ s, s + len);
6564 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6567 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6568 STRLEN *const uoffset_p, bool *const at_end)
6570 const U8 *s = start;
6571 STRLEN uoffset = *uoffset_p;
6573 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6575 while (s < send && uoffset) {
6582 else if (s > send) {
6584 /* This is the existing behaviour. Possibly it should be a croak, as
6585 it's actually a bounds error */
6588 *uoffset_p -= uoffset;
6592 /* Given the length of the string in both bytes and UTF-8 characters, decide
6593 whether to walk forwards or backwards to find the byte corresponding to
6594 the passed in UTF-8 offset. */
6596 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6597 STRLEN uoffset, const STRLEN uend)
6599 STRLEN backw = uend - uoffset;
6601 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6603 if (uoffset < 2 * backw) {
6604 /* The assumption is that going forwards is twice the speed of going
6605 forward (that's where the 2 * backw comes from).
6606 (The real figure of course depends on the UTF-8 data.) */
6607 const U8 *s = start;
6609 while (s < send && uoffset--)
6619 while (UTF8_IS_CONTINUATION(*send))
6622 return send - start;
6625 /* For the string representation of the given scalar, find the byte
6626 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6627 give another position in the string, *before* the sought offset, which
6628 (which is always true, as 0, 0 is a valid pair of positions), which should
6629 help reduce the amount of linear searching.
6630 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6631 will be used to reduce the amount of linear searching. The cache will be
6632 created if necessary, and the found value offered to it for update. */
6634 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6635 const U8 *const send, STRLEN uoffset,
6636 STRLEN uoffset0, STRLEN boffset0)
6638 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6640 bool at_end = FALSE;
6642 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6644 assert (uoffset >= uoffset0);
6651 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6652 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6653 if ((*mgp)->mg_ptr) {
6654 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6655 if (cache[0] == uoffset) {
6656 /* An exact match. */
6659 if (cache[2] == uoffset) {
6660 /* An exact match. */
6664 if (cache[0] < uoffset) {
6665 /* The cache already knows part of the way. */
6666 if (cache[0] > uoffset0) {
6667 /* The cache knows more than the passed in pair */
6668 uoffset0 = cache[0];
6669 boffset0 = cache[1];
6671 if ((*mgp)->mg_len != -1) {
6672 /* And we know the end too. */
6674 + sv_pos_u2b_midway(start + boffset0, send,
6676 (*mgp)->mg_len - uoffset0);
6678 uoffset -= uoffset0;
6680 + sv_pos_u2b_forwards(start + boffset0,
6681 send, &uoffset, &at_end);
6682 uoffset += uoffset0;
6685 else if (cache[2] < uoffset) {
6686 /* We're between the two cache entries. */
6687 if (cache[2] > uoffset0) {
6688 /* and the cache knows more than the passed in pair */
6689 uoffset0 = cache[2];
6690 boffset0 = cache[3];
6694 + sv_pos_u2b_midway(start + boffset0,
6697 cache[0] - uoffset0);
6700 + sv_pos_u2b_midway(start + boffset0,
6703 cache[2] - uoffset0);
6707 else if ((*mgp)->mg_len != -1) {
6708 /* If we can take advantage of a passed in offset, do so. */
6709 /* In fact, offset0 is either 0, or less than offset, so don't
6710 need to worry about the other possibility. */
6712 + sv_pos_u2b_midway(start + boffset0, send,
6714 (*mgp)->mg_len - uoffset0);
6719 if (!found || PL_utf8cache < 0) {
6720 STRLEN real_boffset;
6721 uoffset -= uoffset0;
6722 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6723 send, &uoffset, &at_end);
6724 uoffset += uoffset0;
6726 if (found && PL_utf8cache < 0)
6727 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6729 boffset = real_boffset;
6734 utf8_mg_len_cache_update(sv, mgp, uoffset);
6736 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6743 =for apidoc sv_pos_u2b_flags
6745 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6746 the start of the string, to a count of the equivalent number of bytes; if
6747 lenp is non-zero, it does the same to lenp, but this time starting from
6748 the offset, rather than from the start
6749 of the string. Handles type coercion.
6750 I<flags> is passed to C<SvPV_flags>, and usually should be
6751 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6757 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6758 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6759 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6764 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6771 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6773 start = (U8*)SvPV_flags(sv, len, flags);
6775 const U8 * const send = start + len;
6777 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6780 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6781 is 0, and *lenp is already set to that. */) {
6782 /* Convert the relative offset to absolute. */
6783 const STRLEN uoffset2 = uoffset + *lenp;
6784 const STRLEN boffset2
6785 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6786 uoffset, boffset) - boffset;
6800 =for apidoc sv_pos_u2b
6802 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6803 the start of the string, to a count of the equivalent number of bytes; if
6804 lenp is non-zero, it does the same to lenp, but this time starting from
6805 the offset, rather than from the start of the string. Handles magic and
6808 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6815 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6816 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6817 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6821 /* This function is subject to size and sign problems */
6824 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6826 PERL_ARGS_ASSERT_SV_POS_U2B;
6829 STRLEN ulen = (STRLEN)*lenp;
6830 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6831 SV_GMAGIC|SV_CONST_RETURN);
6834 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6835 SV_GMAGIC|SV_CONST_RETURN);
6840 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6843 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6847 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6848 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6849 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6853 (*mgp)->mg_len = ulen;
6854 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6855 if (ulen != (STRLEN) (*mgp)->mg_len)
6856 (*mgp)->mg_len = -1;
6859 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6860 byte length pairing. The (byte) length of the total SV is passed in too,
6861 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6862 may not have updated SvCUR, so we can't rely on reading it directly.
6864 The proffered utf8/byte length pairing isn't used if the cache already has
6865 two pairs, and swapping either for the proffered pair would increase the
6866 RMS of the intervals between known byte offsets.
6868 The cache itself consists of 4 STRLEN values
6869 0: larger UTF-8 offset
6870 1: corresponding byte offset
6871 2: smaller UTF-8 offset
6872 3: corresponding byte offset
6874 Unused cache pairs have the value 0, 0.
6875 Keeping the cache "backwards" means that the invariant of
6876 cache[0] >= cache[2] is maintained even with empty slots, which means that
6877 the code that uses it doesn't need to worry if only 1 entry has actually
6878 been set to non-zero. It also makes the "position beyond the end of the
6879 cache" logic much simpler, as the first slot is always the one to start
6883 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6884 const STRLEN utf8, const STRLEN blen)
6888 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6893 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6894 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6895 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6897 (*mgp)->mg_len = -1;
6901 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6902 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6903 (*mgp)->mg_ptr = (char *) cache;
6907 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6908 /* SvPOKp() because it's possible that sv has string overloading, and
6909 therefore is a reference, hence SvPVX() is actually a pointer.
6910 This cures the (very real) symptoms of RT 69422, but I'm not actually
6911 sure whether we should even be caching the results of UTF-8
6912 operations on overloading, given that nothing stops overloading
6913 returning a different value every time it's called. */
6914 const U8 *start = (const U8 *) SvPVX_const(sv);
6915 const STRLEN realutf8 = utf8_length(start, start + byte);
6917 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6921 /* Cache is held with the later position first, to simplify the code
6922 that deals with unbounded ends. */
6924 ASSERT_UTF8_CACHE(cache);
6925 if (cache[1] == 0) {
6926 /* Cache is totally empty */
6929 } else if (cache[3] == 0) {
6930 if (byte > cache[1]) {
6931 /* New one is larger, so goes first. */
6932 cache[2] = cache[0];
6933 cache[3] = cache[1];
6941 #define THREEWAY_SQUARE(a,b,c,d) \
6942 ((float)((d) - (c))) * ((float)((d) - (c))) \
6943 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6944 + ((float)((b) - (a))) * ((float)((b) - (a)))
6946 /* Cache has 2 slots in use, and we know three potential pairs.
6947 Keep the two that give the lowest RMS distance. Do the
6948 calculation in bytes simply because we always know the byte
6949 length. squareroot has the same ordering as the positive value,
6950 so don't bother with the actual square root. */
6951 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6952 if (byte > cache[1]) {
6953 /* New position is after the existing pair of pairs. */
6954 const float keep_earlier
6955 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6956 const float keep_later
6957 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6959 if (keep_later < keep_earlier) {
6960 if (keep_later < existing) {
6961 cache[2] = cache[0];
6962 cache[3] = cache[1];
6968 if (keep_earlier < existing) {
6974 else if (byte > cache[3]) {
6975 /* New position is between the existing pair of pairs. */
6976 const float keep_earlier
6977 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6978 const float keep_later
6979 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6981 if (keep_later < keep_earlier) {
6982 if (keep_later < existing) {
6988 if (keep_earlier < existing) {
6995 /* New position is before the existing pair of pairs. */
6996 const float keep_earlier
6997 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6998 const float keep_later
6999 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7001 if (keep_later < keep_earlier) {
7002 if (keep_later < existing) {
7008 if (keep_earlier < existing) {
7009 cache[0] = cache[2];
7010 cache[1] = cache[3];
7017 ASSERT_UTF8_CACHE(cache);
7020 /* We already know all of the way, now we may be able to walk back. The same
7021 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7022 backward is half the speed of walking forward. */
7024 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7025 const U8 *end, STRLEN endu)
7027 const STRLEN forw = target - s;
7028 STRLEN backw = end - target;
7030 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7032 if (forw < 2 * backw) {
7033 return utf8_length(s, target);
7036 while (end > target) {
7038 while (UTF8_IS_CONTINUATION(*end)) {
7047 =for apidoc sv_pos_b2u
7049 Converts the value pointed to by offsetp from a count of bytes from the
7050 start of the string, to a count of the equivalent number of UTF-8 chars.
7051 Handles magic and type coercion.
7057 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7058 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7063 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7066 const STRLEN byte = *offsetp;
7067 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7073 PERL_ARGS_ASSERT_SV_POS_B2U;
7078 s = (const U8*)SvPV_const(sv, blen);
7081 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7082 ", byte=%"UVuf, (UV)blen, (UV)byte);
7088 && SvTYPE(sv) >= SVt_PVMG
7089 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7092 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7093 if (cache[1] == byte) {
7094 /* An exact match. */
7095 *offsetp = cache[0];
7098 if (cache[3] == byte) {
7099 /* An exact match. */
7100 *offsetp = cache[2];
7104 if (cache[1] < byte) {
7105 /* We already know part of the way. */
7106 if (mg->mg_len != -1) {
7107 /* Actually, we know the end too. */
7109 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7110 s + blen, mg->mg_len - cache[0]);
7112 len = cache[0] + utf8_length(s + cache[1], send);
7115 else if (cache[3] < byte) {
7116 /* We're between the two cached pairs, so we do the calculation
7117 offset by the byte/utf-8 positions for the earlier pair,
7118 then add the utf-8 characters from the string start to
7120 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7121 s + cache[1], cache[0] - cache[2])
7125 else { /* cache[3] > byte */
7126 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7130 ASSERT_UTF8_CACHE(cache);
7132 } else if (mg->mg_len != -1) {
7133 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7137 if (!found || PL_utf8cache < 0) {
7138 const STRLEN real_len = utf8_length(s, send);
7140 if (found && PL_utf8cache < 0)
7141 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7148 utf8_mg_len_cache_update(sv, &mg, len);
7150 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7155 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7156 STRLEN real, SV *const sv)
7158 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7160 /* As this is debugging only code, save space by keeping this test here,
7161 rather than inlining it in all the callers. */
7162 if (from_cache == real)
7165 /* Need to turn the assertions off otherwise we may recurse infinitely
7166 while printing error messages. */
7167 SAVEI8(PL_utf8cache);
7169 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7170 func, (UV) from_cache, (UV) real, SVfARG(sv));
7176 Returns a boolean indicating whether the strings in the two SVs are
7177 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7178 coerce its args to strings if necessary.
7180 =for apidoc sv_eq_flags
7182 Returns a boolean indicating whether the strings in the two SVs are
7183 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7184 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7190 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7198 SV* svrecode = NULL;
7205 /* if pv1 and pv2 are the same, second SvPV_const call may
7206 * invalidate pv1 (if we are handling magic), so we may need to
7208 if (sv1 == sv2 && flags & SV_GMAGIC
7209 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7210 pv1 = SvPV_const(sv1, cur1);
7211 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7213 pv1 = SvPV_flags_const(sv1, cur1, flags);
7221 pv2 = SvPV_flags_const(sv2, cur2, flags);
7223 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7224 /* Differing utf8ness.
7225 * Do not UTF8size the comparands as a side-effect. */
7228 svrecode = newSVpvn(pv2, cur2);
7229 sv_recode_to_utf8(svrecode, PL_encoding);
7230 pv2 = SvPV_const(svrecode, cur2);
7233 svrecode = newSVpvn(pv1, cur1);
7234 sv_recode_to_utf8(svrecode, PL_encoding);
7235 pv1 = SvPV_const(svrecode, cur1);
7237 /* Now both are in UTF-8. */
7239 SvREFCNT_dec(svrecode);
7245 /* sv1 is the UTF-8 one */
7246 return bytes_cmp_utf8((const U8*)pv2, cur2,
7247 (const U8*)pv1, cur1) == 0;
7250 /* sv2 is the UTF-8 one */
7251 return bytes_cmp_utf8((const U8*)pv1, cur1,
7252 (const U8*)pv2, cur2) == 0;
7258 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7260 SvREFCNT_dec(svrecode);
7268 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7269 string in C<sv1> is less than, equal to, or greater than the string in
7270 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7271 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7273 =for apidoc sv_cmp_flags
7275 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7276 string in C<sv1> is less than, equal to, or greater than the string in
7277 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7278 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7279 also C<sv_cmp_locale_flags>.
7285 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7287 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7291 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7296 const char *pv1, *pv2;
7299 SV *svrecode = NULL;
7306 pv1 = SvPV_flags_const(sv1, cur1, flags);
7313 pv2 = SvPV_flags_const(sv2, cur2, flags);
7315 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7316 /* Differing utf8ness.
7317 * Do not UTF8size the comparands as a side-effect. */
7320 svrecode = newSVpvn(pv2, cur2);
7321 sv_recode_to_utf8(svrecode, PL_encoding);
7322 pv2 = SvPV_const(svrecode, cur2);
7325 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7326 (const U8*)pv1, cur1);
7327 return retval ? retval < 0 ? -1 : +1 : 0;
7332 svrecode = newSVpvn(pv1, cur1);
7333 sv_recode_to_utf8(svrecode, PL_encoding);
7334 pv1 = SvPV_const(svrecode, cur1);
7337 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7338 (const U8*)pv2, cur2);
7339 return retval ? retval < 0 ? -1 : +1 : 0;
7345 cmp = cur2 ? -1 : 0;
7349 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7352 cmp = retval < 0 ? -1 : 1;
7353 } else if (cur1 == cur2) {
7356 cmp = cur1 < cur2 ? -1 : 1;
7360 SvREFCNT_dec(svrecode);
7368 =for apidoc sv_cmp_locale
7370 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7371 'use bytes' aware, handles get magic, and will coerce its args to strings
7372 if necessary. See also C<sv_cmp>.
7374 =for apidoc sv_cmp_locale_flags
7376 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7377 'use bytes' aware and will coerce its args to strings if necessary. If the
7378 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7384 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7386 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7390 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7394 #ifdef USE_LOCALE_COLLATE
7400 if (PL_collation_standard)
7404 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7406 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7408 if (!pv1 || !len1) {
7419 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7422 return retval < 0 ? -1 : 1;
7425 * When the result of collation is equality, that doesn't mean
7426 * that there are no differences -- some locales exclude some
7427 * characters from consideration. So to avoid false equalities,
7428 * we use the raw string as a tiebreaker.
7434 #endif /* USE_LOCALE_COLLATE */
7436 return sv_cmp(sv1, sv2);
7440 #ifdef USE_LOCALE_COLLATE
7443 =for apidoc sv_collxfrm
7445 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7446 C<sv_collxfrm_flags>.
7448 =for apidoc sv_collxfrm_flags
7450 Add Collate Transform magic to an SV if it doesn't already have it. If the
7451 flags contain SV_GMAGIC, it handles get-magic.
7453 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7454 scalar data of the variable, but transformed to such a format that a normal
7455 memory comparison can be used to compare the data according to the locale
7462 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7467 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7469 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7470 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7476 Safefree(mg->mg_ptr);
7477 s = SvPV_flags_const(sv, len, flags);
7478 if ((xf = mem_collxfrm(s, len, &xlen))) {
7480 #ifdef PERL_OLD_COPY_ON_WRITE
7482 sv_force_normal_flags(sv, 0);
7484 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7498 if (mg && mg->mg_ptr) {
7500 return mg->mg_ptr + sizeof(PL_collation_ix);
7508 #endif /* USE_LOCALE_COLLATE */
7511 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7513 SV * const tsv = newSV(0);
7516 sv_gets(tsv, fp, 0);
7517 sv_utf8_upgrade_nomg(tsv);
7518 SvCUR_set(sv,append);
7521 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7525 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7528 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7529 /* Grab the size of the record we're getting */
7530 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7537 /* VMS wants read instead of fread, because fread doesn't respect */
7538 /* RMS record boundaries. This is not necessarily a good thing to be */
7539 /* doing, but we've got no other real choice - except avoid stdio
7540 as implementation - perhaps write a :vms layer ?
7542 fd = PerlIO_fileno(fp);
7544 bytesread = PerlLIO_read(fd, buffer, recsize);
7546 else /* in-memory file from PerlIO::Scalar */
7549 bytesread = PerlIO_read(fp, buffer, recsize);
7554 SvCUR_set(sv, bytesread + append);
7555 buffer[bytesread] = '\0';
7556 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7562 Get a line from the filehandle and store it into the SV, optionally
7563 appending to the currently-stored string.
7569 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7574 register STDCHAR rslast;
7575 register STDCHAR *bp;
7580 PERL_ARGS_ASSERT_SV_GETS;
7582 if (SvTHINKFIRST(sv))
7583 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7584 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7586 However, perlbench says it's slower, because the existing swipe code
7587 is faster than copy on write.
7588 Swings and roundabouts. */
7589 SvUPGRADE(sv, SVt_PV);
7594 if (PerlIO_isutf8(fp)) {
7596 sv_utf8_upgrade_nomg(sv);
7597 sv_pos_u2b(sv,&append,0);
7599 } else if (SvUTF8(sv)) {
7600 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7608 if (PerlIO_isutf8(fp))
7611 if (IN_PERL_COMPILETIME) {
7612 /* we always read code in line mode */
7616 else if (RsSNARF(PL_rs)) {
7617 /* If it is a regular disk file use size from stat() as estimate
7618 of amount we are going to read -- may result in mallocing
7619 more memory than we really need if the layers below reduce
7620 the size we read (e.g. CRLF or a gzip layer).
7623 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7624 const Off_t offset = PerlIO_tell(fp);
7625 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7626 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7632 else if (RsRECORD(PL_rs)) {
7633 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7635 else if (RsPARA(PL_rs)) {
7641 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7642 if (PerlIO_isutf8(fp)) {
7643 rsptr = SvPVutf8(PL_rs, rslen);
7646 if (SvUTF8(PL_rs)) {
7647 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7648 Perl_croak(aTHX_ "Wide character in $/");
7651 rsptr = SvPV_const(PL_rs, rslen);
7655 rslast = rslen ? rsptr[rslen - 1] : '\0';
7657 if (rspara) { /* have to do this both before and after */
7658 do { /* to make sure file boundaries work right */
7661 i = PerlIO_getc(fp);
7665 PerlIO_ungetc(fp,i);
7671 /* See if we know enough about I/O mechanism to cheat it ! */
7673 /* This used to be #ifdef test - it is made run-time test for ease
7674 of abstracting out stdio interface. One call should be cheap
7675 enough here - and may even be a macro allowing compile
7679 if (PerlIO_fast_gets(fp)) {
7682 * We're going to steal some values from the stdio struct
7683 * and put EVERYTHING in the innermost loop into registers.
7685 register STDCHAR *ptr;
7689 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7690 /* An ungetc()d char is handled separately from the regular
7691 * buffer, so we getc() it back out and stuff it in the buffer.
7693 i = PerlIO_getc(fp);
7694 if (i == EOF) return 0;
7695 *(--((*fp)->_ptr)) = (unsigned char) i;
7699 /* Here is some breathtakingly efficient cheating */
7701 cnt = PerlIO_get_cnt(fp); /* get count into register */
7702 /* make sure we have the room */
7703 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7704 /* Not room for all of it
7705 if we are looking for a separator and room for some
7707 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7708 /* just process what we have room for */
7709 shortbuffered = cnt - SvLEN(sv) + append + 1;
7710 cnt -= shortbuffered;
7714 /* remember that cnt can be negative */
7715 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7720 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7721 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7722 DEBUG_P(PerlIO_printf(Perl_debug_log,
7723 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7724 DEBUG_P(PerlIO_printf(Perl_debug_log,
7725 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7726 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7727 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7732 while (cnt > 0) { /* this | eat */
7734 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7735 goto thats_all_folks; /* screams | sed :-) */
7739 Copy(ptr, bp, cnt, char); /* this | eat */
7740 bp += cnt; /* screams | dust */
7741 ptr += cnt; /* louder | sed :-) */
7743 assert (!shortbuffered);
7744 goto cannot_be_shortbuffered;
7748 if (shortbuffered) { /* oh well, must extend */
7749 cnt = shortbuffered;
7751 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7753 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7754 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7758 cannot_be_shortbuffered:
7759 DEBUG_P(PerlIO_printf(Perl_debug_log,
7760 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7761 PTR2UV(ptr),(long)cnt));
7762 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7764 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7765 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7766 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7767 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7769 /* This used to call 'filbuf' in stdio form, but as that behaves like
7770 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7771 another abstraction. */
7772 i = PerlIO_getc(fp); /* get more characters */
7774 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7775 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7776 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7777 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7779 cnt = PerlIO_get_cnt(fp);
7780 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7781 DEBUG_P(PerlIO_printf(Perl_debug_log,
7782 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7784 if (i == EOF) /* all done for ever? */
7785 goto thats_really_all_folks;
7787 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7789 SvGROW(sv, bpx + cnt + 2);
7790 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7792 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7794 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7795 goto thats_all_folks;
7799 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7800 memNE((char*)bp - rslen, rsptr, rslen))
7801 goto screamer; /* go back to the fray */
7802 thats_really_all_folks:
7804 cnt += shortbuffered;
7805 DEBUG_P(PerlIO_printf(Perl_debug_log,
7806 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7807 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7808 DEBUG_P(PerlIO_printf(Perl_debug_log,
7809 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7810 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7811 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7813 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7814 DEBUG_P(PerlIO_printf(Perl_debug_log,
7815 "Screamer: done, len=%ld, string=|%.*s|\n",
7816 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7820 /*The big, slow, and stupid way. */
7821 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7822 STDCHAR *buf = NULL;
7823 Newx(buf, 8192, STDCHAR);
7831 register const STDCHAR * const bpe = buf + sizeof(buf);
7833 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7834 ; /* keep reading */
7838 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7839 /* Accommodate broken VAXC compiler, which applies U8 cast to
7840 * both args of ?: operator, causing EOF to change into 255
7843 i = (U8)buf[cnt - 1];
7849 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7851 sv_catpvn(sv, (char *) buf, cnt);
7853 sv_setpvn(sv, (char *) buf, cnt);
7855 if (i != EOF && /* joy */
7857 SvCUR(sv) < rslen ||
7858 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7862 * If we're reading from a TTY and we get a short read,
7863 * indicating that the user hit his EOF character, we need
7864 * to notice it now, because if we try to read from the TTY
7865 * again, the EOF condition will disappear.
7867 * The comparison of cnt to sizeof(buf) is an optimization
7868 * that prevents unnecessary calls to feof().
7872 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7876 #ifdef USE_HEAP_INSTEAD_OF_STACK
7881 if (rspara) { /* have to do this both before and after */
7882 while (i != EOF) { /* to make sure file boundaries work right */
7883 i = PerlIO_getc(fp);
7885 PerlIO_ungetc(fp,i);
7891 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7897 Auto-increment of the value in the SV, doing string to numeric conversion
7898 if necessary. Handles 'get' magic and operator overloading.
7904 Perl_sv_inc(pTHX_ register SV *const sv)
7913 =for apidoc sv_inc_nomg
7915 Auto-increment of the value in the SV, doing string to numeric conversion
7916 if necessary. Handles operator overloading. Skips handling 'get' magic.
7922 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7930 if (SvTHINKFIRST(sv)) {
7931 if (SvIsCOW(sv) || isGV_with_GP(sv))
7932 sv_force_normal_flags(sv, 0);
7933 if (SvREADONLY(sv)) {
7934 if (IN_PERL_RUNTIME)
7935 Perl_croak_no_modify(aTHX);
7939 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7941 i = PTR2IV(SvRV(sv));
7946 flags = SvFLAGS(sv);
7947 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7948 /* It's (privately or publicly) a float, but not tested as an
7949 integer, so test it to see. */
7951 flags = SvFLAGS(sv);
7953 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7954 /* It's publicly an integer, or privately an integer-not-float */
7955 #ifdef PERL_PRESERVE_IVUV
7959 if (SvUVX(sv) == UV_MAX)
7960 sv_setnv(sv, UV_MAX_P1);
7962 (void)SvIOK_only_UV(sv);
7963 SvUV_set(sv, SvUVX(sv) + 1);
7965 if (SvIVX(sv) == IV_MAX)
7966 sv_setuv(sv, (UV)IV_MAX + 1);
7968 (void)SvIOK_only(sv);
7969 SvIV_set(sv, SvIVX(sv) + 1);
7974 if (flags & SVp_NOK) {
7975 const NV was = SvNVX(sv);
7976 if (NV_OVERFLOWS_INTEGERS_AT &&
7977 was >= NV_OVERFLOWS_INTEGERS_AT) {
7978 /* diag_listed_as: Lost precision when %s %f by 1 */
7979 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7980 "Lost precision when incrementing %" NVff " by 1",
7983 (void)SvNOK_only(sv);
7984 SvNV_set(sv, was + 1.0);
7988 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7989 if ((flags & SVTYPEMASK) < SVt_PVIV)
7990 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7991 (void)SvIOK_only(sv);
7996 while (isALPHA(*d)) d++;
7997 while (isDIGIT(*d)) d++;
7998 if (d < SvEND(sv)) {
7999 #ifdef PERL_PRESERVE_IVUV
8000 /* Got to punt this as an integer if needs be, but we don't issue
8001 warnings. Probably ought to make the sv_iv_please() that does
8002 the conversion if possible, and silently. */
8003 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8004 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8005 /* Need to try really hard to see if it's an integer.
8006 9.22337203685478e+18 is an integer.
8007 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8008 so $a="9.22337203685478e+18"; $a+0; $a++
8009 needs to be the same as $a="9.22337203685478e+18"; $a++
8016 /* sv_2iv *should* have made this an NV */
8017 if (flags & SVp_NOK) {
8018 (void)SvNOK_only(sv);
8019 SvNV_set(sv, SvNVX(sv) + 1.0);
8022 /* I don't think we can get here. Maybe I should assert this
8023 And if we do get here I suspect that sv_setnv will croak. NWC
8025 #if defined(USE_LONG_DOUBLE)
8026 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",
8027 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8029 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8030 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8033 #endif /* PERL_PRESERVE_IVUV */
8034 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8038 while (d >= SvPVX_const(sv)) {
8046 /* MKS: The original code here died if letters weren't consecutive.
8047 * at least it didn't have to worry about non-C locales. The
8048 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8049 * arranged in order (although not consecutively) and that only
8050 * [A-Za-z] are accepted by isALPHA in the C locale.
8052 if (*d != 'z' && *d != 'Z') {
8053 do { ++*d; } while (!isALPHA(*d));
8056 *(d--) -= 'z' - 'a';
8061 *(d--) -= 'z' - 'a' + 1;
8065 /* oh,oh, the number grew */
8066 SvGROW(sv, SvCUR(sv) + 2);
8067 SvCUR_set(sv, SvCUR(sv) + 1);
8068 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8079 Auto-decrement of the value in the SV, doing string to numeric conversion
8080 if necessary. Handles 'get' magic and operator overloading.
8086 Perl_sv_dec(pTHX_ register SV *const sv)
8096 =for apidoc sv_dec_nomg
8098 Auto-decrement of the value in the SV, doing string to numeric conversion
8099 if necessary. Handles operator overloading. Skips handling 'get' magic.
8105 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8112 if (SvTHINKFIRST(sv)) {
8113 if (SvIsCOW(sv) || isGV_with_GP(sv))
8114 sv_force_normal_flags(sv, 0);
8115 if (SvREADONLY(sv)) {
8116 if (IN_PERL_RUNTIME)
8117 Perl_croak_no_modify(aTHX);
8121 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8123 i = PTR2IV(SvRV(sv));
8128 /* Unlike sv_inc we don't have to worry about string-never-numbers
8129 and keeping them magic. But we mustn't warn on punting */
8130 flags = SvFLAGS(sv);
8131 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8132 /* It's publicly an integer, or privately an integer-not-float */
8133 #ifdef PERL_PRESERVE_IVUV
8137 if (SvUVX(sv) == 0) {
8138 (void)SvIOK_only(sv);
8142 (void)SvIOK_only_UV(sv);
8143 SvUV_set(sv, SvUVX(sv) - 1);
8146 if (SvIVX(sv) == IV_MIN) {
8147 sv_setnv(sv, (NV)IV_MIN);
8151 (void)SvIOK_only(sv);
8152 SvIV_set(sv, SvIVX(sv) - 1);
8157 if (flags & SVp_NOK) {
8160 const NV was = SvNVX(sv);
8161 if (NV_OVERFLOWS_INTEGERS_AT &&
8162 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8163 /* diag_listed_as: Lost precision when %s %f by 1 */
8164 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8165 "Lost precision when decrementing %" NVff " by 1",
8168 (void)SvNOK_only(sv);
8169 SvNV_set(sv, was - 1.0);
8173 if (!(flags & SVp_POK)) {
8174 if ((flags & SVTYPEMASK) < SVt_PVIV)
8175 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8177 (void)SvIOK_only(sv);
8180 #ifdef PERL_PRESERVE_IVUV
8182 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8183 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8184 /* Need to try really hard to see if it's an integer.
8185 9.22337203685478e+18 is an integer.
8186 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8187 so $a="9.22337203685478e+18"; $a+0; $a--
8188 needs to be the same as $a="9.22337203685478e+18"; $a--
8195 /* sv_2iv *should* have made this an NV */
8196 if (flags & SVp_NOK) {
8197 (void)SvNOK_only(sv);
8198 SvNV_set(sv, SvNVX(sv) - 1.0);
8201 /* I don't think we can get here. Maybe I should assert this
8202 And if we do get here I suspect that sv_setnv will croak. NWC
8204 #if defined(USE_LONG_DOUBLE)
8205 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",
8206 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8208 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8209 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8213 #endif /* PERL_PRESERVE_IVUV */
8214 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8217 /* this define is used to eliminate a chunk of duplicated but shared logic
8218 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8219 * used anywhere but here - yves
8221 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8224 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8228 =for apidoc sv_mortalcopy
8230 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8231 The new SV is marked as mortal. It will be destroyed "soon", either by an
8232 explicit call to FREETMPS, or by an implicit call at places such as
8233 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8238 /* Make a string that will exist for the duration of the expression
8239 * evaluation. Actually, it may have to last longer than that, but
8240 * hopefully we won't free it until it has been assigned to a
8241 * permanent location. */
8244 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8250 sv_setsv(sv,oldstr);
8251 PUSH_EXTEND_MORTAL__SV_C(sv);
8257 =for apidoc sv_newmortal
8259 Creates a new null SV which is mortal. The reference count of the SV is
8260 set to 1. It will be destroyed "soon", either by an explicit call to
8261 FREETMPS, or by an implicit call at places such as statement boundaries.
8262 See also C<sv_mortalcopy> and C<sv_2mortal>.
8268 Perl_sv_newmortal(pTHX)
8274 SvFLAGS(sv) = SVs_TEMP;
8275 PUSH_EXTEND_MORTAL__SV_C(sv);
8281 =for apidoc newSVpvn_flags
8283 Creates a new SV and copies a string into it. The reference count for the
8284 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8285 string. You are responsible for ensuring that the source string is at least
8286 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8287 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8288 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8289 returning. If C<SVf_UTF8> is set, C<s>
8290 is considered to be in UTF-8 and the
8291 C<SVf_UTF8> flag will be set on the new SV.
8292 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8294 #define newSVpvn_utf8(s, len, u) \
8295 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8301 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8306 /* All the flags we don't support must be zero.
8307 And we're new code so I'm going to assert this from the start. */
8308 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8310 sv_setpvn(sv,s,len);
8312 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8313 * and do what it does ourselves here.
8314 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8315 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8316 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8317 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8320 SvFLAGS(sv) |= flags;
8322 if(flags & SVs_TEMP){
8323 PUSH_EXTEND_MORTAL__SV_C(sv);
8330 =for apidoc sv_2mortal
8332 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8333 by an explicit call to FREETMPS, or by an implicit call at places such as
8334 statement boundaries. SvTEMP() is turned on which means that the SV's
8335 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8336 and C<sv_mortalcopy>.
8342 Perl_sv_2mortal(pTHX_ register SV *const sv)
8347 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8349 PUSH_EXTEND_MORTAL__SV_C(sv);
8357 Creates a new SV and copies a string into it. The reference count for the
8358 SV is set to 1. If C<len> is zero, Perl will compute the length using
8359 strlen(). For efficiency, consider using C<newSVpvn> instead.
8365 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8371 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8376 =for apidoc newSVpvn
8378 Creates a new SV and copies a string into it. The reference count for the
8379 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8380 string. You are responsible for ensuring that the source string is at least
8381 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8387 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
8393 sv_setpvn(sv,s,len);
8398 =for apidoc newSVhek
8400 Creates a new SV from the hash key structure. It will generate scalars that
8401 point to the shared string table where possible. Returns a new (undefined)
8402 SV if the hek is NULL.
8408 Perl_newSVhek(pTHX_ const HEK *const hek)
8418 if (HEK_LEN(hek) == HEf_SVKEY) {
8419 return newSVsv(*(SV**)HEK_KEY(hek));
8421 const int flags = HEK_FLAGS(hek);
8422 if (flags & HVhek_WASUTF8) {
8424 Andreas would like keys he put in as utf8 to come back as utf8
8426 STRLEN utf8_len = HEK_LEN(hek);
8427 SV * const sv = newSV_type(SVt_PV);
8428 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8429 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8430 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8433 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8434 /* We don't have a pointer to the hv, so we have to replicate the
8435 flag into every HEK. This hv is using custom a hasing
8436 algorithm. Hence we can't return a shared string scalar, as
8437 that would contain the (wrong) hash value, and might get passed
8438 into an hv routine with a regular hash.
8439 Similarly, a hash that isn't using shared hash keys has to have
8440 the flag in every key so that we know not to try to call
8441 share_hek_hek on it. */
8443 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8448 /* This will be overwhelminly the most common case. */
8450 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8451 more efficient than sharepvn(). */
8455 sv_upgrade(sv, SVt_PV);
8456 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8457 SvCUR_set(sv, HEK_LEN(hek));
8470 =for apidoc newSVpvn_share
8472 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8473 table. If the string does not already exist in the table, it is
8474 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8475 is non-zero, that value is used; otherwise the hash is computed.
8476 The string's hash can later be retrieved from the SV
8477 with the C<SvSHARED_HASH()> macro. The idea here is
8478 that as the string table is used for shared hash keys these strings will have
8479 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8485 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8489 bool is_utf8 = FALSE;
8490 const char *const orig_src = src;
8493 STRLEN tmplen = -len;
8495 /* See the note in hv.c:hv_fetch() --jhi */
8496 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8500 PERL_HASH(hash, src, len);
8502 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8503 changes here, update it there too. */
8504 sv_upgrade(sv, SVt_PV);
8505 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8513 if (src != orig_src)
8519 =for apidoc newSVpv_share
8521 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8528 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8530 return newSVpvn_share(src, strlen(src), hash);
8533 #if defined(PERL_IMPLICIT_CONTEXT)
8535 /* pTHX_ magic can't cope with varargs, so this is a no-context
8536 * version of the main function, (which may itself be aliased to us).
8537 * Don't access this version directly.
8541 Perl_newSVpvf_nocontext(const char *const pat, ...)
8547 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8549 va_start(args, pat);
8550 sv = vnewSVpvf(pat, &args);
8557 =for apidoc newSVpvf
8559 Creates a new SV and initializes it with the string formatted like
8566 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8571 PERL_ARGS_ASSERT_NEWSVPVF;
8573 va_start(args, pat);
8574 sv = vnewSVpvf(pat, &args);
8579 /* backend for newSVpvf() and newSVpvf_nocontext() */
8582 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8587 PERL_ARGS_ASSERT_VNEWSVPVF;
8590 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8597 Creates a new SV and copies a floating point value into it.
8598 The reference count for the SV is set to 1.
8604 Perl_newSVnv(pTHX_ const NV n)
8617 Creates a new SV and copies an integer into it. The reference count for the
8624 Perl_newSViv(pTHX_ const IV i)
8637 Creates a new SV and copies an unsigned integer into it.
8638 The reference count for the SV is set to 1.
8644 Perl_newSVuv(pTHX_ const UV u)
8655 =for apidoc newSV_type
8657 Creates a new SV, of the type specified. The reference count for the new SV
8664 Perl_newSV_type(pTHX_ const svtype type)
8669 sv_upgrade(sv, type);
8674 =for apidoc newRV_noinc
8676 Creates an RV wrapper for an SV. The reference count for the original
8677 SV is B<not> incremented.
8683 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8686 register SV *sv = newSV_type(SVt_IV);
8688 PERL_ARGS_ASSERT_NEWRV_NOINC;
8691 SvRV_set(sv, tmpRef);
8696 /* newRV_inc is the official function name to use now.
8697 * newRV_inc is in fact #defined to newRV in sv.h
8701 Perl_newRV(pTHX_ SV *const sv)
8705 PERL_ARGS_ASSERT_NEWRV;
8707 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8713 Creates a new SV which is an exact duplicate of the original SV.
8720 Perl_newSVsv(pTHX_ register SV *const old)
8727 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8728 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8732 /* SV_GMAGIC is the default for sv_setv()
8733 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8734 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8735 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8740 =for apidoc sv_reset
8742 Underlying implementation for the C<reset> Perl function.
8743 Note that the perl-level function is vaguely deprecated.
8749 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8752 char todo[PERL_UCHAR_MAX+1];
8754 PERL_ARGS_ASSERT_SV_RESET;
8759 if (!*s) { /* reset ?? searches */
8760 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8762 const U32 count = mg->mg_len / sizeof(PMOP**);
8763 PMOP **pmp = (PMOP**) mg->mg_ptr;
8764 PMOP *const *const end = pmp + count;
8768 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8770 (*pmp)->op_pmflags &= ~PMf_USED;
8778 /* reset variables */
8780 if (!HvARRAY(stash))
8783 Zero(todo, 256, char);
8786 I32 i = (unsigned char)*s;
8790 max = (unsigned char)*s++;
8791 for ( ; i <= max; i++) {
8794 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8796 for (entry = HvARRAY(stash)[i];
8798 entry = HeNEXT(entry))
8803 if (!todo[(U8)*HeKEY(entry)])
8805 gv = MUTABLE_GV(HeVAL(entry));
8808 if (SvTHINKFIRST(sv)) {
8809 if (!SvREADONLY(sv) && SvROK(sv))
8811 /* XXX Is this continue a bug? Why should THINKFIRST
8812 exempt us from resetting arrays and hashes? */
8816 if (SvTYPE(sv) >= SVt_PV) {
8818 if (SvPVX_const(sv) != NULL)
8826 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8828 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8831 # if defined(USE_ENVIRON_ARRAY)
8834 # endif /* USE_ENVIRON_ARRAY */
8845 Using various gambits, try to get an IO from an SV: the IO slot if its a
8846 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8847 named after the PV if we're a string.
8849 'Get' magic is ignored on the sv passed in, but will be called on
8850 C<SvRV(sv)> if sv is an RV.
8856 Perl_sv_2io(pTHX_ SV *const sv)
8861 PERL_ARGS_ASSERT_SV_2IO;
8863 switch (SvTYPE(sv)) {
8865 io = MUTABLE_IO(sv);
8869 if (isGV_with_GP(sv)) {
8870 gv = MUTABLE_GV(sv);
8873 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8874 HEKfARG(GvNAME_HEK(gv)));
8880 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8882 SvGETMAGIC(SvRV(sv));
8883 return sv_2io(SvRV(sv));
8885 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8892 if (SvGMAGICAL(sv)) {
8893 newsv = sv_newmortal();
8894 sv_setsv_nomg(newsv, sv);
8896 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8906 Using various gambits, try to get a CV from an SV; in addition, try if
8907 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8908 The flags in C<lref> are passed to gv_fetchsv.
8914 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8920 PERL_ARGS_ASSERT_SV_2CV;
8927 switch (SvTYPE(sv)) {
8931 return MUTABLE_CV(sv);
8941 sv = amagic_deref_call(sv, to_cv_amg);
8944 if (SvTYPE(sv) == SVt_PVCV) {
8945 cv = MUTABLE_CV(sv);
8950 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
8951 gv = MUTABLE_GV(sv);
8953 Perl_croak(aTHX_ "Not a subroutine reference");
8955 else if (isGV_with_GP(sv)) {
8956 gv = MUTABLE_GV(sv);
8959 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
8966 /* Some flags to gv_fetchsv mean don't really create the GV */
8967 if (!isGV_with_GP(gv)) {
8972 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
8976 gv_efullname3(tmpsv, gv, NULL);
8977 /* XXX this is probably not what they think they're getting.
8978 * It has the same effect as "sub name;", i.e. just a forward
8980 newSUB(start_subparse(FALSE, 0),
8981 newSVOP(OP_CONST, 0, tmpsv),
8985 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8986 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8995 Returns true if the SV has a true value by Perl's rules.
8996 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8997 instead use an in-line version.
9003 Perl_sv_true(pTHX_ register SV *const sv)
9008 register const XPV* const tXpv = (XPV*)SvANY(sv);
9010 (tXpv->xpv_cur > 1 ||
9011 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9018 return SvIVX(sv) != 0;
9021 return SvNVX(sv) != 0.0;
9023 return sv_2bool(sv);
9029 =for apidoc sv_pvn_force
9031 Get a sensible string out of the SV somehow.
9032 A private implementation of the C<SvPV_force> macro for compilers which
9033 can't cope with complex macro expressions. Always use the macro instead.
9035 =for apidoc sv_pvn_force_flags
9037 Get a sensible string out of the SV somehow.
9038 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9039 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9040 implemented in terms of this function.
9041 You normally want to use the various wrapper macros instead: see
9042 C<SvPV_force> and C<SvPV_force_nomg>
9048 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9052 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9054 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9055 if (SvTHINKFIRST(sv) && !SvROK(sv))
9056 sv_force_normal_flags(sv, 0);
9066 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9067 const char * const ref = sv_reftype(sv,0);
9069 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9070 ref, OP_DESC(PL_op));
9072 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9074 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9075 || isGV_with_GP(sv))
9076 /* diag_listed_as: Can't coerce %s to %s in %s */
9077 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9079 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9083 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9086 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9087 SvGROW(sv, len + 1);
9088 Move(s,SvPVX(sv),len,char);
9090 SvPVX(sv)[len] = '\0';
9093 SvPOK_on(sv); /* validate pointer */
9095 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9096 PTR2UV(sv),SvPVX_const(sv)));
9099 return SvPVX_mutable(sv);
9103 =for apidoc sv_pvbyten_force
9105 The backend for the C<SvPVbytex_force> macro. Always use the macro
9112 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9114 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9116 sv_pvn_force(sv,lp);
9117 sv_utf8_downgrade(sv,0);
9123 =for apidoc sv_pvutf8n_force
9125 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9132 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9134 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9136 sv_pvn_force(sv,lp);
9137 sv_utf8_upgrade(sv);
9143 =for apidoc sv_reftype
9145 Returns a string describing what the SV is a reference to.
9151 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9153 PERL_ARGS_ASSERT_SV_REFTYPE;
9154 if (ob && SvOBJECT(sv)) {
9155 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9158 switch (SvTYPE(sv)) {
9173 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9174 /* tied lvalues should appear to be
9175 * scalars for backwards compatibility */
9176 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9177 ? "SCALAR" : "LVALUE");
9178 case SVt_PVAV: return "ARRAY";
9179 case SVt_PVHV: return "HASH";
9180 case SVt_PVCV: return "CODE";
9181 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9182 ? "GLOB" : "SCALAR");
9183 case SVt_PVFM: return "FORMAT";
9184 case SVt_PVIO: return "IO";
9185 case SVt_BIND: return "BIND";
9186 case SVt_REGEXP: return "REGEXP";
9187 default: return "UNKNOWN";
9195 Returns a SV describing what the SV passed in is a reference to.
9201 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9203 PERL_ARGS_ASSERT_SV_REF;
9206 dst = sv_newmortal();
9208 if (ob && SvOBJECT(sv)) {
9209 HvNAME_get(SvSTASH(sv))
9210 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9211 : sv_setpvn(dst, "__ANON__", 8);
9214 const char * reftype = sv_reftype(sv, 0);
9215 sv_setpv(dst, reftype);
9221 =for apidoc sv_isobject
9223 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9224 object. If the SV is not an RV, or if the object is not blessed, then this
9231 Perl_sv_isobject(pTHX_ SV *sv)
9247 Returns a boolean indicating whether the SV is blessed into the specified
9248 class. This does not check for subtypes; use C<sv_derived_from> to verify
9249 an inheritance relationship.
9255 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9259 PERL_ARGS_ASSERT_SV_ISA;
9269 hvname = HvNAME_get(SvSTASH(sv));
9273 return strEQ(hvname, name);
9279 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9280 it will be upgraded to one. If C<classname> is non-null then the new SV will
9281 be blessed in the specified package. The new SV is returned and its
9282 reference count is 1.
9288 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9293 PERL_ARGS_ASSERT_NEWSVRV;
9297 SV_CHECK_THINKFIRST_COW_DROP(rv);
9298 (void)SvAMAGIC_off(rv);
9300 if (SvTYPE(rv) >= SVt_PVMG) {
9301 const U32 refcnt = SvREFCNT(rv);
9305 SvREFCNT(rv) = refcnt;
9307 sv_upgrade(rv, SVt_IV);
9308 } else if (SvROK(rv)) {
9309 SvREFCNT_dec(SvRV(rv));
9311 prepare_SV_for_RV(rv);
9319 HV* const stash = gv_stashpv(classname, GV_ADD);
9320 (void)sv_bless(rv, stash);
9326 =for apidoc sv_setref_pv
9328 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9329 argument will be upgraded to an RV. That RV will be modified to point to
9330 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9331 into the SV. The C<classname> argument indicates the package for the
9332 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9333 will have a reference count of 1, and the RV will be returned.
9335 Do not use with other Perl types such as HV, AV, SV, CV, because those
9336 objects will become corrupted by the pointer copy process.
9338 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9344 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9348 PERL_ARGS_ASSERT_SV_SETREF_PV;
9351 sv_setsv(rv, &PL_sv_undef);
9355 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9360 =for apidoc sv_setref_iv
9362 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9363 argument will be upgraded to an RV. That RV will be modified to point to
9364 the new SV. The C<classname> argument indicates the package for the
9365 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9366 will have a reference count of 1, and the RV will be returned.
9372 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9374 PERL_ARGS_ASSERT_SV_SETREF_IV;
9376 sv_setiv(newSVrv(rv,classname), iv);
9381 =for apidoc sv_setref_uv
9383 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9384 argument will be upgraded to an RV. That RV will be modified to point to
9385 the new SV. The C<classname> argument indicates the package for the
9386 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9387 will have a reference count of 1, and the RV will be returned.
9393 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9395 PERL_ARGS_ASSERT_SV_SETREF_UV;
9397 sv_setuv(newSVrv(rv,classname), uv);
9402 =for apidoc sv_setref_nv
9404 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9405 argument will be upgraded to an RV. That RV will be modified to point to
9406 the new SV. The C<classname> argument indicates the package for the
9407 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9408 will have a reference count of 1, and the RV will be returned.
9414 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9416 PERL_ARGS_ASSERT_SV_SETREF_NV;
9418 sv_setnv(newSVrv(rv,classname), nv);
9423 =for apidoc sv_setref_pvn
9425 Copies a string into a new SV, optionally blessing the SV. The length of the
9426 string must be specified with C<n>. The C<rv> argument will be upgraded to
9427 an RV. That RV will be modified to point to the new SV. The C<classname>
9428 argument indicates the package for the blessing. Set C<classname> to
9429 C<NULL> to avoid the blessing. The new SV will have a reference count
9430 of 1, and the RV will be returned.
9432 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9438 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9439 const char *const pv, const STRLEN n)
9441 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9443 sv_setpvn(newSVrv(rv,classname), pv, n);
9448 =for apidoc sv_bless
9450 Blesses an SV into a specified package. The SV must be an RV. The package
9451 must be designated by its stash (see C<gv_stashpv()>). The reference count
9452 of the SV is unaffected.
9458 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9463 PERL_ARGS_ASSERT_SV_BLESS;
9466 Perl_croak(aTHX_ "Can't bless non-reference value");
9468 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9469 if (SvIsCOW(tmpRef))
9470 sv_force_normal_flags(tmpRef, 0);
9471 if (SvREADONLY(tmpRef))
9472 Perl_croak_no_modify(aTHX);
9473 if (SvOBJECT(tmpRef)) {
9474 if (SvTYPE(tmpRef) != SVt_PVIO)
9476 SvREFCNT_dec(SvSTASH(tmpRef));
9479 SvOBJECT_on(tmpRef);
9480 if (SvTYPE(tmpRef) != SVt_PVIO)
9482 SvUPGRADE(tmpRef, SVt_PVMG);
9483 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9488 (void)SvAMAGIC_off(sv);
9490 if(SvSMAGICAL(tmpRef))
9491 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9499 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9500 * as it is after unglobbing it.
9503 PERL_STATIC_INLINE void
9504 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9509 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9511 PERL_ARGS_ASSERT_SV_UNGLOB;
9513 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9515 if (!(flags & SV_COW_DROP_PV))
9516 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9519 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9520 && HvNAME_get(stash))
9521 mro_method_changed_in(stash);
9522 gp_free(MUTABLE_GV(sv));
9525 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9529 if (GvNAME_HEK(sv)) {
9530 unshare_hek(GvNAME_HEK(sv));
9532 isGV_with_GP_off(sv);
9534 if(SvTYPE(sv) == SVt_PVGV) {
9535 /* need to keep SvANY(sv) in the right arena */
9536 xpvmg = new_XPVMG();
9537 StructCopy(SvANY(sv), xpvmg, XPVMG);
9538 del_XPVGV(SvANY(sv));
9541 SvFLAGS(sv) &= ~SVTYPEMASK;
9542 SvFLAGS(sv) |= SVt_PVMG;
9545 /* Intentionally not calling any local SET magic, as this isn't so much a
9546 set operation as merely an internal storage change. */
9547 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9548 else sv_setsv_flags(sv, temp, 0);
9550 if ((const GV *)sv == PL_last_in_gv)
9551 PL_last_in_gv = NULL;
9552 else if ((const GV *)sv == PL_statgv)
9557 =for apidoc sv_unref_flags
9559 Unsets the RV status of the SV, and decrements the reference count of
9560 whatever was being referenced by the RV. This can almost be thought of
9561 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9562 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9563 (otherwise the decrementing is conditional on the reference count being
9564 different from one or the reference being a readonly SV).
9571 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9573 SV* const target = SvRV(ref);
9575 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9577 if (SvWEAKREF(ref)) {
9578 sv_del_backref(target, ref);
9580 SvRV_set(ref, NULL);
9583 SvRV_set(ref, NULL);
9585 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9586 assigned to as BEGIN {$a = \"Foo"} will fail. */
9587 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9588 SvREFCNT_dec(target);
9589 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9590 sv_2mortal(target); /* Schedule for freeing later */
9594 =for apidoc sv_untaint
9596 Untaint an SV. Use C<SvTAINTED_off> instead.
9602 Perl_sv_untaint(pTHX_ SV *const sv)
9604 PERL_ARGS_ASSERT_SV_UNTAINT;
9606 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9607 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9614 =for apidoc sv_tainted
9616 Test an SV for taintedness. Use C<SvTAINTED> instead.
9622 Perl_sv_tainted(pTHX_ SV *const sv)
9624 PERL_ARGS_ASSERT_SV_TAINTED;
9626 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9627 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9628 if (mg && (mg->mg_len & 1) )
9635 =for apidoc sv_setpviv
9637 Copies an integer into the given SV, also updating its string value.
9638 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9644 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9646 char buf[TYPE_CHARS(UV)];
9648 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9650 PERL_ARGS_ASSERT_SV_SETPVIV;
9652 sv_setpvn(sv, ptr, ebuf - ptr);
9656 =for apidoc sv_setpviv_mg
9658 Like C<sv_setpviv>, but also handles 'set' magic.
9664 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9666 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9672 #if defined(PERL_IMPLICIT_CONTEXT)
9674 /* pTHX_ magic can't cope with varargs, so this is a no-context
9675 * version of the main function, (which may itself be aliased to us).
9676 * Don't access this version directly.
9680 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9685 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9687 va_start(args, pat);
9688 sv_vsetpvf(sv, pat, &args);
9692 /* pTHX_ magic can't cope with varargs, so this is a no-context
9693 * version of the main function, (which may itself be aliased to us).
9694 * Don't access this version directly.
9698 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9703 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9705 va_start(args, pat);
9706 sv_vsetpvf_mg(sv, pat, &args);
9712 =for apidoc sv_setpvf
9714 Works like C<sv_catpvf> but copies the text into the SV instead of
9715 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9721 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9725 PERL_ARGS_ASSERT_SV_SETPVF;
9727 va_start(args, pat);
9728 sv_vsetpvf(sv, pat, &args);
9733 =for apidoc sv_vsetpvf
9735 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9736 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9738 Usually used via its frontend C<sv_setpvf>.
9744 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9746 PERL_ARGS_ASSERT_SV_VSETPVF;
9748 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9752 =for apidoc sv_setpvf_mg
9754 Like C<sv_setpvf>, but also handles 'set' magic.
9760 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9764 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9766 va_start(args, pat);
9767 sv_vsetpvf_mg(sv, pat, &args);
9772 =for apidoc sv_vsetpvf_mg
9774 Like C<sv_vsetpvf>, but also handles 'set' magic.
9776 Usually used via its frontend C<sv_setpvf_mg>.
9782 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9784 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9786 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9790 #if defined(PERL_IMPLICIT_CONTEXT)
9792 /* pTHX_ magic can't cope with varargs, so this is a no-context
9793 * version of the main function, (which may itself be aliased to us).
9794 * Don't access this version directly.
9798 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9803 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9805 va_start(args, pat);
9806 sv_vcatpvf(sv, pat, &args);
9810 /* pTHX_ magic can't cope with varargs, so this is a no-context
9811 * version of the main function, (which may itself be aliased to us).
9812 * Don't access this version directly.
9816 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9821 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9823 va_start(args, pat);
9824 sv_vcatpvf_mg(sv, pat, &args);
9830 =for apidoc sv_catpvf
9832 Processes its arguments like C<sprintf> and appends the formatted
9833 output to an SV. If the appended data contains "wide" characters
9834 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9835 and characters >255 formatted with %c), the original SV might get
9836 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9837 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9838 valid UTF-8; if the original SV was bytes, the pattern should be too.
9843 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9847 PERL_ARGS_ASSERT_SV_CATPVF;
9849 va_start(args, pat);
9850 sv_vcatpvf(sv, pat, &args);
9855 =for apidoc sv_vcatpvf
9857 Processes its arguments like C<vsprintf> and appends the formatted output
9858 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9860 Usually used via its frontend C<sv_catpvf>.
9866 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9868 PERL_ARGS_ASSERT_SV_VCATPVF;
9870 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9874 =for apidoc sv_catpvf_mg
9876 Like C<sv_catpvf>, but also handles 'set' magic.
9882 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9886 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9888 va_start(args, pat);
9889 sv_vcatpvf_mg(sv, pat, &args);
9894 =for apidoc sv_vcatpvf_mg
9896 Like C<sv_vcatpvf>, but also handles 'set' magic.
9898 Usually used via its frontend C<sv_catpvf_mg>.
9904 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9906 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9908 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9913 =for apidoc sv_vsetpvfn
9915 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9918 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9924 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9925 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9927 PERL_ARGS_ASSERT_SV_VSETPVFN;
9930 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9935 * Warn of missing argument to sprintf, and then return a defined value
9936 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9938 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9940 S_vcatpvfn_missing_argument(pTHX) {
9941 if (ckWARN(WARN_MISSING)) {
9942 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9943 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9950 S_expect_number(pTHX_ char **const pattern)
9955 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9957 switch (**pattern) {
9958 case '1': case '2': case '3':
9959 case '4': case '5': case '6':
9960 case '7': case '8': case '9':
9961 var = *(*pattern)++ - '0';
9962 while (isDIGIT(**pattern)) {
9963 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9965 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9973 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9975 const int neg = nv < 0;
9978 PERL_ARGS_ASSERT_F0CONVERT;
9986 if (uv & 1 && uv == nv)
9987 uv--; /* Round to even */
9989 const unsigned dig = uv % 10;
10002 =for apidoc sv_vcatpvfn
10004 Processes its arguments like C<vsprintf> and appends the formatted output
10005 to an SV. Uses an array of SVs if the C style variable argument list is
10006 missing (NULL). When running with taint checks enabled, indicates via
10007 C<maybe_tainted> if results are untrustworthy (often due to the use of
10010 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10016 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10017 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10018 vec_utf8 = DO_UTF8(vecsv);
10020 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10023 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10024 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10029 const char *patend;
10032 static const char nullstr[] = "(null)";
10034 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10035 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10037 /* Times 4: a decimal digit takes more than 3 binary digits.
10038 * NV_DIG: mantissa takes than many decimal digits.
10039 * Plus 32: Playing safe. */
10040 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10041 /* large enough for "%#.#f" --chip */
10042 /* what about long double NVs? --jhi */
10044 PERL_ARGS_ASSERT_SV_VCATPVFN;
10045 PERL_UNUSED_ARG(maybe_tainted);
10047 /* no matter what, this is a string now */
10048 (void)SvPV_force(sv, origlen);
10050 /* special-case "", "%s", and "%-p" (SVf - see below) */
10053 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10055 const char * const s = va_arg(*args, char*);
10056 sv_catpv(sv, s ? s : nullstr);
10058 else if (svix < svmax) {
10059 sv_catsv(sv, *svargs);
10062 S_vcatpvfn_missing_argument(aTHX);
10065 if (args && patlen == 3 && pat[0] == '%' &&
10066 pat[1] == '-' && pat[2] == 'p') {
10067 argsv = MUTABLE_SV(va_arg(*args, void*));
10068 sv_catsv(sv, argsv);
10072 #ifndef USE_LONG_DOUBLE
10073 /* special-case "%.<number>[gf]" */
10074 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10075 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10076 unsigned digits = 0;
10080 while (*pp >= '0' && *pp <= '9')
10081 digits = 10 * digits + (*pp++ - '0');
10082 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10083 const NV nv = SvNV(*svargs);
10085 /* Add check for digits != 0 because it seems that some
10086 gconverts are buggy in this case, and we don't yet have
10087 a Configure test for this. */
10088 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10089 /* 0, point, slack */
10090 Gconvert(nv, (int)digits, 0, ebuf);
10091 sv_catpv(sv, ebuf);
10092 if (*ebuf) /* May return an empty string for digits==0 */
10095 } else if (!digits) {
10098 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10099 sv_catpvn(sv, p, l);
10105 #endif /* !USE_LONG_DOUBLE */
10107 if (!args && svix < svmax && DO_UTF8(*svargs))
10110 patend = (char*)pat + patlen;
10111 for (p = (char*)pat; p < patend; p = q) {
10114 bool vectorize = FALSE;
10115 bool vectorarg = FALSE;
10116 bool vec_utf8 = FALSE;
10122 bool has_precis = FALSE;
10124 const I32 osvix = svix;
10125 bool is_utf8 = FALSE; /* is this item utf8? */
10126 #ifdef HAS_LDBL_SPRINTF_BUG
10127 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10128 with sfio - Allen <allens@cpan.org> */
10129 bool fix_ldbl_sprintf_bug = FALSE;
10133 U8 utf8buf[UTF8_MAXBYTES+1];
10134 STRLEN esignlen = 0;
10136 const char *eptr = NULL;
10137 const char *fmtstart;
10140 const U8 *vecstr = NULL;
10147 /* we need a long double target in case HAS_LONG_DOUBLE but
10148 not USE_LONG_DOUBLE
10150 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10158 const char *dotstr = ".";
10159 STRLEN dotstrlen = 1;
10160 I32 efix = 0; /* explicit format parameter index */
10161 I32 ewix = 0; /* explicit width index */
10162 I32 epix = 0; /* explicit precision index */
10163 I32 evix = 0; /* explicit vector index */
10164 bool asterisk = FALSE;
10166 /* echo everything up to the next format specification */
10167 for (q = p; q < patend && *q != '%'; ++q) ;
10169 if (has_utf8 && !pat_utf8)
10170 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10172 sv_catpvn(sv, p, q - p);
10181 We allow format specification elements in this order:
10182 \d+\$ explicit format parameter index
10184 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10185 0 flag (as above): repeated to allow "v02"
10186 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10187 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10189 [%bcdefginopsuxDFOUX] format (mandatory)
10194 As of perl5.9.3, printf format checking is on by default.
10195 Internally, perl uses %p formats to provide an escape to
10196 some extended formatting. This block deals with those
10197 extensions: if it does not match, (char*)q is reset and
10198 the normal format processing code is used.
10200 Currently defined extensions are:
10201 %p include pointer address (standard)
10202 %-p (SVf) include an SV (previously %_)
10203 %-<num>p include an SV with precision <num>
10205 %3p include a HEK with precision of 256
10206 %<num>p (where num != 2 or 3) reserved for future
10209 Robin Barker 2005-07-14 (but modified since)
10211 %1p (VDf) removed. RMB 2007-10-19
10218 n = expect_number(&q);
10220 if (sv) { /* SVf */
10225 argsv = MUTABLE_SV(va_arg(*args, void*));
10226 eptr = SvPV_const(argsv, elen);
10227 if (DO_UTF8(argsv))
10231 else if (n==2 || n==3) { /* HEKf */
10232 HEK * const hek = va_arg(*args, HEK *);
10233 eptr = HEK_KEY(hek);
10234 elen = HEK_LEN(hek);
10235 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10236 if (n==3) precis = 256, has_precis = TRUE;
10240 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10241 "internal %%<num>p might conflict with future printf extensions");
10247 if ( (width = expect_number(&q)) ) {
10262 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10291 if ( (ewix = expect_number(&q)) )
10300 if ((vectorarg = asterisk)) {
10313 width = expect_number(&q);
10316 if (vectorize && vectorarg) {
10317 /* vectorizing, but not with the default "." */
10319 vecsv = va_arg(*args, SV*);
10321 vecsv = (evix > 0 && evix <= svmax)
10322 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10324 vecsv = svix < svmax
10325 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10327 dotstr = SvPV_const(vecsv, dotstrlen);
10328 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10329 bad with tied or overloaded values that return UTF8. */
10330 if (DO_UTF8(vecsv))
10332 else if (has_utf8) {
10333 vecsv = sv_mortalcopy(vecsv);
10334 sv_utf8_upgrade(vecsv);
10335 dotstr = SvPV_const(vecsv, dotstrlen);
10342 i = va_arg(*args, int);
10344 i = (ewix ? ewix <= svmax : svix < svmax) ?
10345 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10347 width = (i < 0) ? -i : i;
10357 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10359 /* XXX: todo, support specified precision parameter */
10363 i = va_arg(*args, int);
10365 i = (ewix ? ewix <= svmax : svix < svmax)
10366 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10368 has_precis = !(i < 0);
10372 while (isDIGIT(*q))
10373 precis = precis * 10 + (*q++ - '0');
10382 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10383 vecsv = svargs[efix ? efix-1 : svix++];
10384 vecstr = (U8*)SvPV_const(vecsv,veclen);
10385 vec_utf8 = DO_UTF8(vecsv);
10387 /* if this is a version object, we need to convert
10388 * back into v-string notation and then let the
10389 * vectorize happen normally
10391 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10392 char *version = savesvpv(vecsv);
10393 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10394 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10395 "vector argument not supported with alpha versions");
10398 vecsv = sv_newmortal();
10399 scan_vstring(version, version + veclen, vecsv);
10400 vecstr = (U8*)SvPV_const(vecsv, veclen);
10401 vec_utf8 = DO_UTF8(vecsv);
10415 case 'I': /* Ix, I32x, and I64x */
10417 if (q[1] == '6' && q[2] == '4') {
10423 if (q[1] == '3' && q[2] == '2') {
10433 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10445 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10446 if (*q == 'l') { /* lld, llf */
10455 if (*++q == 'h') { /* hhd, hhu */
10484 if (!vectorize && !args) {
10486 const I32 i = efix-1;
10487 argsv = (i >= 0 && i < svmax)
10488 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10490 argsv = (svix >= 0 && svix < svmax)
10491 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10495 switch (c = *q++) {
10502 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10504 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10506 eptr = (char*)utf8buf;
10507 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10521 eptr = va_arg(*args, char*);
10523 elen = strlen(eptr);
10525 eptr = (char *)nullstr;
10526 elen = sizeof nullstr - 1;
10530 eptr = SvPV_const(argsv, elen);
10531 if (DO_UTF8(argsv)) {
10532 STRLEN old_precis = precis;
10533 if (has_precis && precis < elen) {
10534 STRLEN ulen = sv_len_utf8(argsv);
10535 I32 p = precis > ulen ? ulen : precis;
10536 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10539 if (width) { /* fudge width (can't fudge elen) */
10540 if (has_precis && precis < elen)
10541 width += precis - old_precis;
10543 width += elen - sv_len_utf8(argsv);
10550 if (has_precis && precis < elen)
10557 if (alt || vectorize)
10559 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10580 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10589 esignbuf[esignlen++] = plus;
10593 case 'c': iv = (char)va_arg(*args, int); break;
10594 case 'h': iv = (short)va_arg(*args, int); break;
10595 case 'l': iv = va_arg(*args, long); break;
10596 case 'V': iv = va_arg(*args, IV); break;
10597 case 'z': iv = va_arg(*args, SSize_t); break;
10598 case 't': iv = va_arg(*args, ptrdiff_t); break;
10599 default: iv = va_arg(*args, int); break;
10601 case 'j': iv = va_arg(*args, intmax_t); break;
10605 iv = va_arg(*args, Quad_t); break;
10612 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10614 case 'c': iv = (char)tiv; break;
10615 case 'h': iv = (short)tiv; break;
10616 case 'l': iv = (long)tiv; break;
10618 default: iv = tiv; break;
10621 iv = (Quad_t)tiv; break;
10627 if ( !vectorize ) /* we already set uv above */
10632 esignbuf[esignlen++] = plus;
10636 esignbuf[esignlen++] = '-';
10680 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10691 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10692 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10693 case 'l': uv = va_arg(*args, unsigned long); break;
10694 case 'V': uv = va_arg(*args, UV); break;
10695 case 'z': uv = va_arg(*args, Size_t); break;
10696 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10698 case 'j': uv = va_arg(*args, uintmax_t); break;
10700 default: uv = va_arg(*args, unsigned); break;
10703 uv = va_arg(*args, Uquad_t); break;
10710 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10712 case 'c': uv = (unsigned char)tuv; break;
10713 case 'h': uv = (unsigned short)tuv; break;
10714 case 'l': uv = (unsigned long)tuv; break;
10716 default: uv = tuv; break;
10719 uv = (Uquad_t)tuv; break;
10728 char *ptr = ebuf + sizeof ebuf;
10729 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10735 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10739 } while (uv >>= 4);
10741 esignbuf[esignlen++] = '0';
10742 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10748 *--ptr = '0' + dig;
10749 } while (uv >>= 3);
10750 if (alt && *ptr != '0')
10756 *--ptr = '0' + dig;
10757 } while (uv >>= 1);
10759 esignbuf[esignlen++] = '0';
10760 esignbuf[esignlen++] = c;
10763 default: /* it had better be ten or less */
10766 *--ptr = '0' + dig;
10767 } while (uv /= base);
10770 elen = (ebuf + sizeof ebuf) - ptr;
10774 zeros = precis - elen;
10775 else if (precis == 0 && elen == 1 && *eptr == '0'
10776 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10779 /* a precision nullifies the 0 flag. */
10786 /* FLOATING POINT */
10789 c = 'f'; /* maybe %F isn't supported here */
10791 case 'e': case 'E':
10793 case 'g': case 'G':
10797 /* This is evil, but floating point is even more evil */
10799 /* for SV-style calling, we can only get NV
10800 for C-style calling, we assume %f is double;
10801 for simplicity we allow any of %Lf, %llf, %qf for long double
10805 #if defined(USE_LONG_DOUBLE)
10809 /* [perl #20339] - we should accept and ignore %lf rather than die */
10813 #if defined(USE_LONG_DOUBLE)
10814 intsize = args ? 0 : 'q';
10818 #if defined(HAS_LONG_DOUBLE)
10831 /* now we need (long double) if intsize == 'q', else (double) */
10833 #if LONG_DOUBLESIZE > DOUBLESIZE
10835 va_arg(*args, long double) :
10836 va_arg(*args, double)
10838 va_arg(*args, double)
10843 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10844 else. frexp() has some unspecified behaviour for those three */
10845 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10847 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10848 will cast our (long double) to (double) */
10849 (void)Perl_frexp(nv, &i);
10850 if (i == PERL_INT_MIN)
10851 Perl_die(aTHX_ "panic: frexp");
10853 need = BIT_DIGITS(i);
10855 need += has_precis ? precis : 6; /* known default */
10860 #ifdef HAS_LDBL_SPRINTF_BUG
10861 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10862 with sfio - Allen <allens@cpan.org> */
10865 # define MY_DBL_MAX DBL_MAX
10866 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10867 # if DOUBLESIZE >= 8
10868 # define MY_DBL_MAX 1.7976931348623157E+308L
10870 # define MY_DBL_MAX 3.40282347E+38L
10874 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10875 # define MY_DBL_MAX_BUG 1L
10877 # define MY_DBL_MAX_BUG MY_DBL_MAX
10881 # define MY_DBL_MIN DBL_MIN
10882 # else /* XXX guessing! -Allen */
10883 # if DOUBLESIZE >= 8
10884 # define MY_DBL_MIN 2.2250738585072014E-308L
10886 # define MY_DBL_MIN 1.17549435E-38L
10890 if ((intsize == 'q') && (c == 'f') &&
10891 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10892 (need < DBL_DIG)) {
10893 /* it's going to be short enough that
10894 * long double precision is not needed */
10896 if ((nv <= 0L) && (nv >= -0L))
10897 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10899 /* would use Perl_fp_class as a double-check but not
10900 * functional on IRIX - see perl.h comments */
10902 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10903 /* It's within the range that a double can represent */
10904 #if defined(DBL_MAX) && !defined(DBL_MIN)
10905 if ((nv >= ((long double)1/DBL_MAX)) ||
10906 (nv <= (-(long double)1/DBL_MAX)))
10908 fix_ldbl_sprintf_bug = TRUE;
10911 if (fix_ldbl_sprintf_bug == TRUE) {
10921 # undef MY_DBL_MAX_BUG
10924 #endif /* HAS_LDBL_SPRINTF_BUG */
10926 need += 20; /* fudge factor */
10927 if (PL_efloatsize < need) {
10928 Safefree(PL_efloatbuf);
10929 PL_efloatsize = need + 20; /* more fudge */
10930 Newx(PL_efloatbuf, PL_efloatsize, char);
10931 PL_efloatbuf[0] = '\0';
10934 if ( !(width || left || plus || alt) && fill != '0'
10935 && has_precis && intsize != 'q' ) { /* Shortcuts */
10936 /* See earlier comment about buggy Gconvert when digits,
10938 if ( c == 'g' && precis) {
10939 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10940 /* May return an empty string for digits==0 */
10941 if (*PL_efloatbuf) {
10942 elen = strlen(PL_efloatbuf);
10943 goto float_converted;
10945 } else if ( c == 'f' && !precis) {
10946 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10951 char *ptr = ebuf + sizeof ebuf;
10954 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10955 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10956 if (intsize == 'q') {
10957 /* Copy the one or more characters in a long double
10958 * format before the 'base' ([efgEFG]) character to
10959 * the format string. */
10960 static char const prifldbl[] = PERL_PRIfldbl;
10961 char const *p = prifldbl + sizeof(prifldbl) - 3;
10962 while (p >= prifldbl) { *--ptr = *p--; }
10967 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10972 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10984 /* No taint. Otherwise we are in the strange situation
10985 * where printf() taints but print($float) doesn't.
10987 #if defined(HAS_LONG_DOUBLE)
10988 elen = ((intsize == 'q')
10989 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10990 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10992 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10996 eptr = PL_efloatbuf;
11004 i = SvCUR(sv) - origlen;
11007 case 'c': *(va_arg(*args, char*)) = i; break;
11008 case 'h': *(va_arg(*args, short*)) = i; break;
11009 default: *(va_arg(*args, int*)) = i; break;
11010 case 'l': *(va_arg(*args, long*)) = i; break;
11011 case 'V': *(va_arg(*args, IV*)) = i; break;
11012 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11013 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11015 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11019 *(va_arg(*args, Quad_t*)) = i; break;
11026 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11027 continue; /* not "break" */
11034 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11035 && ckWARN(WARN_PRINTF))
11037 SV * const msg = sv_newmortal();
11038 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11039 (PL_op->op_type == OP_PRTF) ? "" : "s");
11040 if (fmtstart < patend) {
11041 const char * const fmtend = q < patend ? q : patend;
11043 sv_catpvs(msg, "\"%");
11044 for (f = fmtstart; f < fmtend; f++) {
11046 sv_catpvn(msg, f, 1);
11048 Perl_sv_catpvf(aTHX_ msg,
11049 "\\%03"UVof, (UV)*f & 0xFF);
11052 sv_catpvs(msg, "\"");
11054 sv_catpvs(msg, "end of string");
11056 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11059 /* output mangled stuff ... */
11065 /* ... right here, because formatting flags should not apply */
11066 SvGROW(sv, SvCUR(sv) + elen + 1);
11068 Copy(eptr, p, elen, char);
11071 SvCUR_set(sv, p - SvPVX_const(sv));
11073 continue; /* not "break" */
11076 if (is_utf8 != has_utf8) {
11079 sv_utf8_upgrade(sv);
11082 const STRLEN old_elen = elen;
11083 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11084 sv_utf8_upgrade(nsv);
11085 eptr = SvPVX_const(nsv);
11088 if (width) { /* fudge width (can't fudge elen) */
11089 width += elen - old_elen;
11095 have = esignlen + zeros + elen;
11097 Perl_croak_nocontext("%s", PL_memory_wrap);
11099 need = (have > width ? have : width);
11102 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11103 Perl_croak_nocontext("%s", PL_memory_wrap);
11104 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11106 if (esignlen && fill == '0') {
11108 for (i = 0; i < (int)esignlen; i++)
11109 *p++ = esignbuf[i];
11111 if (gap && !left) {
11112 memset(p, fill, gap);
11115 if (esignlen && fill != '0') {
11117 for (i = 0; i < (int)esignlen; i++)
11118 *p++ = esignbuf[i];
11122 for (i = zeros; i; i--)
11126 Copy(eptr, p, elen, char);
11130 memset(p, ' ', gap);
11135 Copy(dotstr, p, dotstrlen, char);
11139 vectorize = FALSE; /* done iterating over vecstr */
11146 SvCUR_set(sv, p - SvPVX_const(sv));
11155 /* =========================================================================
11157 =head1 Cloning an interpreter
11159 All the macros and functions in this section are for the private use of
11160 the main function, perl_clone().
11162 The foo_dup() functions make an exact copy of an existing foo thingy.
11163 During the course of a cloning, a hash table is used to map old addresses
11164 to new addresses. The table is created and manipulated with the
11165 ptr_table_* functions.
11169 * =========================================================================*/
11172 #if defined(USE_ITHREADS)
11174 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11175 #ifndef GpREFCNT_inc
11176 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11180 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11181 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11182 If this changes, please unmerge ss_dup.
11183 Likewise, sv_dup_inc_multiple() relies on this fact. */
11184 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11185 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11186 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11187 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11188 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11189 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11190 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11191 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11192 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11193 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11194 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11195 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11196 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11198 /* clone a parser */
11201 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11205 PERL_ARGS_ASSERT_PARSER_DUP;
11210 /* look for it in the table first */
11211 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11215 /* create anew and remember what it is */
11216 Newxz(parser, 1, yy_parser);
11217 ptr_table_store(PL_ptr_table, proto, parser);
11219 /* XXX these not yet duped */
11220 parser->old_parser = NULL;
11221 parser->stack = NULL;
11223 parser->stack_size = 0;
11224 /* XXX parser->stack->state = 0; */
11226 /* XXX eventually, just Copy() most of the parser struct ? */
11228 parser->lex_brackets = proto->lex_brackets;
11229 parser->lex_casemods = proto->lex_casemods;
11230 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11231 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11232 parser->lex_casestack = savepvn(proto->lex_casestack,
11233 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11234 parser->lex_defer = proto->lex_defer;
11235 parser->lex_dojoin = proto->lex_dojoin;
11236 parser->lex_expect = proto->lex_expect;
11237 parser->lex_formbrack = proto->lex_formbrack;
11238 parser->lex_inpat = proto->lex_inpat;
11239 parser->lex_inwhat = proto->lex_inwhat;
11240 parser->lex_op = proto->lex_op;
11241 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11242 parser->lex_starts = proto->lex_starts;
11243 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11244 parser->multi_close = proto->multi_close;
11245 parser->multi_open = proto->multi_open;
11246 parser->multi_start = proto->multi_start;
11247 parser->multi_end = proto->multi_end;
11248 parser->pending_ident = proto->pending_ident;
11249 parser->preambled = proto->preambled;
11250 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11251 parser->linestr = sv_dup_inc(proto->linestr, param);
11252 parser->expect = proto->expect;
11253 parser->copline = proto->copline;
11254 parser->last_lop_op = proto->last_lop_op;
11255 parser->lex_state = proto->lex_state;
11256 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11257 /* rsfp_filters entries have fake IoDIRP() */
11258 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11259 parser->in_my = proto->in_my;
11260 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11261 parser->error_count = proto->error_count;
11264 parser->linestr = sv_dup_inc(proto->linestr, param);
11267 char * const ols = SvPVX(proto->linestr);
11268 char * const ls = SvPVX(parser->linestr);
11270 parser->bufptr = ls + (proto->bufptr >= ols ?
11271 proto->bufptr - ols : 0);
11272 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11273 proto->oldbufptr - ols : 0);
11274 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11275 proto->oldoldbufptr - ols : 0);
11276 parser->linestart = ls + (proto->linestart >= ols ?
11277 proto->linestart - ols : 0);
11278 parser->last_uni = ls + (proto->last_uni >= ols ?
11279 proto->last_uni - ols : 0);
11280 parser->last_lop = ls + (proto->last_lop >= ols ?
11281 proto->last_lop - ols : 0);
11283 parser->bufend = ls + SvCUR(parser->linestr);
11286 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11290 parser->endwhite = proto->endwhite;
11291 parser->faketokens = proto->faketokens;
11292 parser->lasttoke = proto->lasttoke;
11293 parser->nextwhite = proto->nextwhite;
11294 parser->realtokenstart = proto->realtokenstart;
11295 parser->skipwhite = proto->skipwhite;
11296 parser->thisclose = proto->thisclose;
11297 parser->thismad = proto->thismad;
11298 parser->thisopen = proto->thisopen;
11299 parser->thisstuff = proto->thisstuff;
11300 parser->thistoken = proto->thistoken;
11301 parser->thiswhite = proto->thiswhite;
11303 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11304 parser->curforce = proto->curforce;
11306 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11307 Copy(proto->nexttype, parser->nexttype, 5, I32);
11308 parser->nexttoke = proto->nexttoke;
11311 /* XXX should clone saved_curcop here, but we aren't passed
11312 * proto_perl; so do it in perl_clone_using instead */
11318 /* duplicate a file handle */
11321 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11325 PERL_ARGS_ASSERT_FP_DUP;
11326 PERL_UNUSED_ARG(type);
11329 return (PerlIO*)NULL;
11331 /* look for it in the table first */
11332 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11336 /* create anew and remember what it is */
11337 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11338 ptr_table_store(PL_ptr_table, fp, ret);
11342 /* duplicate a directory handle */
11345 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11351 register const Direntry_t *dirent;
11352 char smallbuf[256];
11358 PERL_UNUSED_CONTEXT;
11359 PERL_ARGS_ASSERT_DIRP_DUP;
11364 /* look for it in the table first */
11365 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11371 PERL_UNUSED_ARG(param);
11375 /* open the current directory (so we can switch back) */
11376 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11378 /* chdir to our dir handle and open the present working directory */
11379 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11380 PerlDir_close(pwd);
11381 return (DIR *)NULL;
11383 /* Now we should have two dir handles pointing to the same dir. */
11385 /* Be nice to the calling code and chdir back to where we were. */
11386 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11388 /* We have no need of the pwd handle any more. */
11389 PerlDir_close(pwd);
11392 # define d_namlen(d) (d)->d_namlen
11394 # define d_namlen(d) strlen((d)->d_name)
11396 /* Iterate once through dp, to get the file name at the current posi-
11397 tion. Then step back. */
11398 pos = PerlDir_tell(dp);
11399 if ((dirent = PerlDir_read(dp))) {
11400 len = d_namlen(dirent);
11401 if (len <= sizeof smallbuf) name = smallbuf;
11402 else Newx(name, len, char);
11403 Move(dirent->d_name, name, len, char);
11405 PerlDir_seek(dp, pos);
11407 /* Iterate through the new dir handle, till we find a file with the
11409 if (!dirent) /* just before the end */
11411 pos = PerlDir_tell(ret);
11412 if (PerlDir_read(ret)) continue; /* not there yet */
11413 PerlDir_seek(ret, pos); /* step back */
11417 const long pos0 = PerlDir_tell(ret);
11419 pos = PerlDir_tell(ret);
11420 if ((dirent = PerlDir_read(ret))) {
11421 if (len == d_namlen(dirent)
11422 && memEQ(name, dirent->d_name, len)) {
11424 PerlDir_seek(ret, pos); /* step back */
11427 /* else we are not there yet; keep iterating */
11429 else { /* This is not meant to happen. The best we can do is
11430 reset the iterator to the beginning. */
11431 PerlDir_seek(ret, pos0);
11438 if (name && name != smallbuf)
11443 ret = win32_dirp_dup(dp, param);
11446 /* pop it in the pointer table */
11448 ptr_table_store(PL_ptr_table, dp, ret);
11453 /* duplicate a typeglob */
11456 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11460 PERL_ARGS_ASSERT_GP_DUP;
11464 /* look for it in the table first */
11465 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11469 /* create anew and remember what it is */
11471 ptr_table_store(PL_ptr_table, gp, ret);
11474 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11475 on Newxz() to do this for us. */
11476 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11477 ret->gp_io = io_dup_inc(gp->gp_io, param);
11478 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11479 ret->gp_av = av_dup_inc(gp->gp_av, param);
11480 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11481 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11482 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11483 ret->gp_cvgen = gp->gp_cvgen;
11484 ret->gp_line = gp->gp_line;
11485 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11489 /* duplicate a chain of magic */
11492 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11494 MAGIC *mgret = NULL;
11495 MAGIC **mgprev_p = &mgret;
11497 PERL_ARGS_ASSERT_MG_DUP;
11499 for (; mg; mg = mg->mg_moremagic) {
11502 if ((param->flags & CLONEf_JOIN_IN)
11503 && mg->mg_type == PERL_MAGIC_backref)
11504 /* when joining, we let the individual SVs add themselves to
11505 * backref as needed. */
11508 Newx(nmg, 1, MAGIC);
11510 mgprev_p = &(nmg->mg_moremagic);
11512 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11513 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11514 from the original commit adding Perl_mg_dup() - revision 4538.
11515 Similarly there is the annotation "XXX random ptr?" next to the
11516 assignment to nmg->mg_ptr. */
11519 /* FIXME for plugins
11520 if (nmg->mg_type == PERL_MAGIC_qr) {
11521 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11525 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11526 ? nmg->mg_type == PERL_MAGIC_backref
11527 /* The backref AV has its reference
11528 * count deliberately bumped by 1 */
11529 ? SvREFCNT_inc(av_dup_inc((const AV *)
11530 nmg->mg_obj, param))
11531 : sv_dup_inc(nmg->mg_obj, param)
11532 : sv_dup(nmg->mg_obj, param);
11534 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11535 if (nmg->mg_len > 0) {
11536 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11537 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11538 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11540 AMT * const namtp = (AMT*)nmg->mg_ptr;
11541 sv_dup_inc_multiple((SV**)(namtp->table),
11542 (SV**)(namtp->table), NofAMmeth, param);
11545 else if (nmg->mg_len == HEf_SVKEY)
11546 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11548 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11549 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11555 #endif /* USE_ITHREADS */
11557 struct ptr_tbl_arena {
11558 struct ptr_tbl_arena *next;
11559 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11562 /* create a new pointer-mapping table */
11565 Perl_ptr_table_new(pTHX)
11568 PERL_UNUSED_CONTEXT;
11570 Newx(tbl, 1, PTR_TBL_t);
11571 tbl->tbl_max = 511;
11572 tbl->tbl_items = 0;
11573 tbl->tbl_arena = NULL;
11574 tbl->tbl_arena_next = NULL;
11575 tbl->tbl_arena_end = NULL;
11576 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11580 #define PTR_TABLE_HASH(ptr) \
11581 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11583 /* map an existing pointer using a table */
11585 STATIC PTR_TBL_ENT_t *
11586 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11588 PTR_TBL_ENT_t *tblent;
11589 const UV hash = PTR_TABLE_HASH(sv);
11591 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11593 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11594 for (; tblent; tblent = tblent->next) {
11595 if (tblent->oldval == sv)
11602 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11604 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11606 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11607 PERL_UNUSED_CONTEXT;
11609 return tblent ? tblent->newval : NULL;
11612 /* add a new entry to a pointer-mapping table */
11615 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11617 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11619 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11620 PERL_UNUSED_CONTEXT;
11623 tblent->newval = newsv;
11625 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11627 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11628 struct ptr_tbl_arena *new_arena;
11630 Newx(new_arena, 1, struct ptr_tbl_arena);
11631 new_arena->next = tbl->tbl_arena;
11632 tbl->tbl_arena = new_arena;
11633 tbl->tbl_arena_next = new_arena->array;
11634 tbl->tbl_arena_end = new_arena->array
11635 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11638 tblent = tbl->tbl_arena_next++;
11640 tblent->oldval = oldsv;
11641 tblent->newval = newsv;
11642 tblent->next = tbl->tbl_ary[entry];
11643 tbl->tbl_ary[entry] = tblent;
11645 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11646 ptr_table_split(tbl);
11650 /* double the hash bucket size of an existing ptr table */
11653 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11655 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11656 const UV oldsize = tbl->tbl_max + 1;
11657 UV newsize = oldsize * 2;
11660 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11661 PERL_UNUSED_CONTEXT;
11663 Renew(ary, newsize, PTR_TBL_ENT_t*);
11664 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11665 tbl->tbl_max = --newsize;
11666 tbl->tbl_ary = ary;
11667 for (i=0; i < oldsize; i++, ary++) {
11668 PTR_TBL_ENT_t **entp = ary;
11669 PTR_TBL_ENT_t *ent = *ary;
11670 PTR_TBL_ENT_t **curentp;
11673 curentp = ary + oldsize;
11675 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11677 ent->next = *curentp;
11687 /* remove all the entries from a ptr table */
11688 /* Deprecated - will be removed post 5.14 */
11691 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11693 if (tbl && tbl->tbl_items) {
11694 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11696 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11699 struct ptr_tbl_arena *next = arena->next;
11705 tbl->tbl_items = 0;
11706 tbl->tbl_arena = NULL;
11707 tbl->tbl_arena_next = NULL;
11708 tbl->tbl_arena_end = NULL;
11712 /* clear and free a ptr table */
11715 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11717 struct ptr_tbl_arena *arena;
11723 arena = tbl->tbl_arena;
11726 struct ptr_tbl_arena *next = arena->next;
11732 Safefree(tbl->tbl_ary);
11736 #if defined(USE_ITHREADS)
11739 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11741 PERL_ARGS_ASSERT_RVPV_DUP;
11744 if (SvWEAKREF(sstr)) {
11745 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11746 if (param->flags & CLONEf_JOIN_IN) {
11747 /* if joining, we add any back references individually rather
11748 * than copying the whole backref array */
11749 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11753 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11755 else if (SvPVX_const(sstr)) {
11756 /* Has something there */
11758 /* Normal PV - clone whole allocated space */
11759 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11760 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11761 /* Not that normal - actually sstr is copy on write.
11762 But we are a true, independent SV, so: */
11763 SvREADONLY_off(dstr);
11768 /* Special case - not normally malloced for some reason */
11769 if (isGV_with_GP(sstr)) {
11770 /* Don't need to do anything here. */
11772 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11773 /* A "shared" PV - clone it as "shared" PV */
11775 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11779 /* Some other special case - random pointer */
11780 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11785 /* Copy the NULL */
11786 SvPV_set(dstr, NULL);
11790 /* duplicate a list of SVs. source and dest may point to the same memory. */
11792 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11793 SSize_t items, CLONE_PARAMS *const param)
11795 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11797 while (items-- > 0) {
11798 *dest++ = sv_dup_inc(*source++, param);
11804 /* duplicate an SV of any type (including AV, HV etc) */
11807 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11812 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11814 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11815 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11820 /* look for it in the table first */
11821 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11825 if(param->flags & CLONEf_JOIN_IN) {
11826 /** We are joining here so we don't want do clone
11827 something that is bad **/
11828 if (SvTYPE(sstr) == SVt_PVHV) {
11829 const HEK * const hvname = HvNAME_HEK(sstr);
11831 /** don't clone stashes if they already exist **/
11832 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11833 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11834 ptr_table_store(PL_ptr_table, sstr, dstr);
11838 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
11839 HV *stash = GvSTASH(sstr);
11840 const HEK * hvname;
11841 if (stash && (hvname = HvNAME_HEK(stash))) {
11842 /** don't clone GVs if they already exist **/
11844 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11845 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
11847 stash, GvNAME(sstr),
11853 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
11854 ptr_table_store(PL_ptr_table, sstr, *svp);
11861 /* create anew and remember what it is */
11864 #ifdef DEBUG_LEAKING_SCALARS
11865 dstr->sv_debug_optype = sstr->sv_debug_optype;
11866 dstr->sv_debug_line = sstr->sv_debug_line;
11867 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11868 dstr->sv_debug_parent = (SV*)sstr;
11869 FREE_SV_DEBUG_FILE(dstr);
11870 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11873 ptr_table_store(PL_ptr_table, sstr, dstr);
11876 SvFLAGS(dstr) = SvFLAGS(sstr);
11877 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11878 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11881 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11882 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11883 (void*)PL_watch_pvx, SvPVX_const(sstr));
11886 /* don't clone objects whose class has asked us not to */
11887 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11892 switch (SvTYPE(sstr)) {
11894 SvANY(dstr) = NULL;
11897 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11899 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11901 SvIV_set(dstr, SvIVX(sstr));
11905 SvANY(dstr) = new_XNV();
11906 SvNV_set(dstr, SvNVX(sstr));
11908 /* case SVt_BIND: */
11911 /* These are all the types that need complex bodies allocating. */
11913 const svtype sv_type = SvTYPE(sstr);
11914 const struct body_details *const sv_type_details
11915 = bodies_by_type + sv_type;
11919 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11934 assert(sv_type_details->body_size);
11935 if (sv_type_details->arena) {
11936 new_body_inline(new_body, sv_type);
11938 = (void*)((char*)new_body - sv_type_details->offset);
11940 new_body = new_NOARENA(sv_type_details);
11944 SvANY(dstr) = new_body;
11947 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11948 ((char*)SvANY(dstr)) + sv_type_details->offset,
11949 sv_type_details->copy, char);
11951 Copy(((char*)SvANY(sstr)),
11952 ((char*)SvANY(dstr)),
11953 sv_type_details->body_size + sv_type_details->offset, char);
11956 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11957 && !isGV_with_GP(dstr)
11958 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11959 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11961 /* The Copy above means that all the source (unduplicated) pointers
11962 are now in the destination. We can check the flags and the
11963 pointers in either, but it's possible that there's less cache
11964 missing by always going for the destination.
11965 FIXME - instrument and check that assumption */
11966 if (sv_type >= SVt_PVMG) {
11967 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11968 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11969 } else if (SvMAGIC(dstr))
11970 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11972 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11975 /* The cast silences a GCC warning about unhandled types. */
11976 switch ((int)sv_type) {
11986 /* FIXME for plugins */
11987 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11990 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11991 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11992 LvTARG(dstr) = dstr;
11993 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11994 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11996 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11998 /* non-GP case already handled above */
11999 if(isGV_with_GP(sstr)) {
12000 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12001 /* Don't call sv_add_backref here as it's going to be
12002 created as part of the magic cloning of the symbol
12003 table--unless this is during a join and the stash
12004 is not actually being cloned. */
12005 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12006 at the point of this comment. */
12007 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12008 if (param->flags & CLONEf_JOIN_IN)
12009 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12010 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12011 (void)GpREFCNT_inc(GvGP(dstr));
12015 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12016 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12017 /* I have no idea why fake dirp (rsfps)
12018 should be treated differently but otherwise
12019 we end up with leaks -- sky*/
12020 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12021 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12022 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12024 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12025 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12026 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12027 if (IoDIRP(dstr)) {
12028 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12031 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12033 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12035 if (IoOFP(dstr) == IoIFP(sstr))
12036 IoOFP(dstr) = IoIFP(dstr);
12038 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12039 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12040 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12041 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12044 /* avoid cloning an empty array */
12045 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12046 SV **dst_ary, **src_ary;
12047 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12049 src_ary = AvARRAY((const AV *)sstr);
12050 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12051 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12052 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12053 AvALLOC((const AV *)dstr) = dst_ary;
12054 if (AvREAL((const AV *)sstr)) {
12055 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12059 while (items-- > 0)
12060 *dst_ary++ = sv_dup(*src_ary++, param);
12062 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12063 while (items-- > 0) {
12064 *dst_ary++ = &PL_sv_undef;
12068 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12069 AvALLOC((const AV *)dstr) = (SV**)NULL;
12070 AvMAX( (const AV *)dstr) = -1;
12071 AvFILLp((const AV *)dstr) = -1;
12075 if (HvARRAY((const HV *)sstr)) {
12077 const bool sharekeys = !!HvSHAREKEYS(sstr);
12078 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12079 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12081 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12082 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12084 HvARRAY(dstr) = (HE**)darray;
12085 while (i <= sxhv->xhv_max) {
12086 const HE * const source = HvARRAY(sstr)[i];
12087 HvARRAY(dstr)[i] = source
12088 ? he_dup(source, sharekeys, param) : 0;
12092 const struct xpvhv_aux * const saux = HvAUX(sstr);
12093 struct xpvhv_aux * const daux = HvAUX(dstr);
12094 /* This flag isn't copied. */
12097 if (saux->xhv_name_count) {
12098 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12100 = saux->xhv_name_count < 0
12101 ? -saux->xhv_name_count
12102 : saux->xhv_name_count;
12103 HEK **shekp = sname + count;
12105 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12106 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12107 while (shekp-- > sname) {
12109 *dhekp = hek_dup(*shekp, param);
12113 daux->xhv_name_u.xhvnameu_name
12114 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12117 daux->xhv_name_count = saux->xhv_name_count;
12119 daux->xhv_riter = saux->xhv_riter;
12120 daux->xhv_eiter = saux->xhv_eiter
12121 ? he_dup(saux->xhv_eiter,
12122 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12123 /* backref array needs refcnt=2; see sv_add_backref */
12124 daux->xhv_backreferences =
12125 (param->flags & CLONEf_JOIN_IN)
12126 /* when joining, we let the individual GVs and
12127 * CVs add themselves to backref as
12128 * needed. This avoids pulling in stuff
12129 * that isn't required, and simplifies the
12130 * case where stashes aren't cloned back
12131 * if they already exist in the parent
12134 : saux->xhv_backreferences
12135 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12136 ? MUTABLE_AV(SvREFCNT_inc(
12137 sv_dup_inc((const SV *)
12138 saux->xhv_backreferences, param)))
12139 : MUTABLE_AV(sv_dup((const SV *)
12140 saux->xhv_backreferences, param))
12143 daux->xhv_mro_meta = saux->xhv_mro_meta
12144 ? mro_meta_dup(saux->xhv_mro_meta, param)
12147 /* Record stashes for possible cloning in Perl_clone(). */
12149 av_push(param->stashes, dstr);
12153 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12156 if (!(param->flags & CLONEf_COPY_STACKS)) {
12161 /* NOTE: not refcounted */
12162 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12163 hv_dup(CvSTASH(dstr), param);
12164 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12165 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12166 if (!CvISXSUB(dstr)) {
12168 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12170 } else if (CvCONST(dstr)) {
12171 CvXSUBANY(dstr).any_ptr =
12172 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12174 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12175 /* don't dup if copying back - CvGV isn't refcounted, so the
12176 * duped GV may never be freed. A bit of a hack! DAPM */
12177 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12179 ? gv_dup_inc(CvGV(sstr), param)
12180 : (param->flags & CLONEf_JOIN_IN)
12182 : gv_dup(CvGV(sstr), param);
12184 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12186 CvWEAKOUTSIDE(sstr)
12187 ? cv_dup( CvOUTSIDE(dstr), param)
12188 : cv_dup_inc(CvOUTSIDE(dstr), param);
12194 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12201 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12203 PERL_ARGS_ASSERT_SV_DUP_INC;
12204 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12208 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12210 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12211 PERL_ARGS_ASSERT_SV_DUP;
12213 /* Track every SV that (at least initially) had a reference count of 0.
12214 We need to do this by holding an actual reference to it in this array.
12215 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12216 (akin to the stashes hash, and the perl stack), we come unstuck if
12217 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12218 thread) is manipulated in a CLONE method, because CLONE runs before the
12219 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12220 (and fix things up by giving each a reference via the temps stack).
12221 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12222 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12223 before the walk of unreferenced happens and a reference to that is SV
12224 added to the temps stack. At which point we have the same SV considered
12225 to be in use, and free to be re-used. Not good.
12227 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12228 assert(param->unreferenced);
12229 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12235 /* duplicate a context */
12238 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12240 PERL_CONTEXT *ncxs;
12242 PERL_ARGS_ASSERT_CX_DUP;
12245 return (PERL_CONTEXT*)NULL;
12247 /* look for it in the table first */
12248 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12252 /* create anew and remember what it is */
12253 Newx(ncxs, max + 1, PERL_CONTEXT);
12254 ptr_table_store(PL_ptr_table, cxs, ncxs);
12255 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12258 PERL_CONTEXT * const ncx = &ncxs[ix];
12259 if (CxTYPE(ncx) == CXt_SUBST) {
12260 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12263 switch (CxTYPE(ncx)) {
12265 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12266 ? cv_dup_inc(ncx->blk_sub.cv, param)
12267 : cv_dup(ncx->blk_sub.cv,param));
12268 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12269 ? av_dup_inc(ncx->blk_sub.argarray,
12272 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12274 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12275 ncx->blk_sub.oldcomppad);
12278 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12280 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12282 case CXt_LOOP_LAZYSV:
12283 ncx->blk_loop.state_u.lazysv.end
12284 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12285 /* We are taking advantage of av_dup_inc and sv_dup_inc
12286 actually being the same function, and order equivalence of
12288 We can assert the later [but only at run time :-(] */
12289 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12290 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12292 ncx->blk_loop.state_u.ary.ary
12293 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12294 case CXt_LOOP_LAZYIV:
12295 case CXt_LOOP_PLAIN:
12296 if (CxPADLOOP(ncx)) {
12297 ncx->blk_loop.itervar_u.oldcomppad
12298 = (PAD*)ptr_table_fetch(PL_ptr_table,
12299 ncx->blk_loop.itervar_u.oldcomppad);
12301 ncx->blk_loop.itervar_u.gv
12302 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12307 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12308 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12309 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12322 /* duplicate a stack info structure */
12325 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12329 PERL_ARGS_ASSERT_SI_DUP;
12332 return (PERL_SI*)NULL;
12334 /* look for it in the table first */
12335 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12339 /* create anew and remember what it is */
12340 Newxz(nsi, 1, PERL_SI);
12341 ptr_table_store(PL_ptr_table, si, nsi);
12343 nsi->si_stack = av_dup_inc(si->si_stack, param);
12344 nsi->si_cxix = si->si_cxix;
12345 nsi->si_cxmax = si->si_cxmax;
12346 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12347 nsi->si_type = si->si_type;
12348 nsi->si_prev = si_dup(si->si_prev, param);
12349 nsi->si_next = si_dup(si->si_next, param);
12350 nsi->si_markoff = si->si_markoff;
12355 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12356 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12357 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12358 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12359 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12360 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12361 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12362 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12363 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12364 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12365 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12366 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12367 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12368 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12369 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12370 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12373 #define pv_dup_inc(p) SAVEPV(p)
12374 #define pv_dup(p) SAVEPV(p)
12375 #define svp_dup_inc(p,pp) any_dup(p,pp)
12377 /* map any object to the new equivent - either something in the
12378 * ptr table, or something in the interpreter structure
12382 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12386 PERL_ARGS_ASSERT_ANY_DUP;
12389 return (void*)NULL;
12391 /* look for it in the table first */
12392 ret = ptr_table_fetch(PL_ptr_table, v);
12396 /* see if it is part of the interpreter structure */
12397 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12398 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12406 /* duplicate the save stack */
12409 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12412 ANY * const ss = proto_perl->Isavestack;
12413 const I32 max = proto_perl->Isavestack_max;
12414 I32 ix = proto_perl->Isavestack_ix;
12427 void (*dptr) (void*);
12428 void (*dxptr) (pTHX_ void*);
12430 PERL_ARGS_ASSERT_SS_DUP;
12432 Newxz(nss, max, ANY);
12435 const UV uv = POPUV(ss,ix);
12436 const U8 type = (U8)uv & SAVE_MASK;
12438 TOPUV(nss,ix) = uv;
12440 case SAVEt_CLEARSV:
12442 case SAVEt_HELEM: /* hash element */
12443 sv = (const SV *)POPPTR(ss,ix);
12444 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12446 case SAVEt_ITEM: /* normal string */
12447 case SAVEt_GVSV: /* scalar slot in GV */
12448 case SAVEt_SV: /* scalar reference */
12449 sv = (const SV *)POPPTR(ss,ix);
12450 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12453 case SAVEt_MORTALIZESV:
12454 sv = (const SV *)POPPTR(ss,ix);
12455 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12457 case SAVEt_SHARED_PVREF: /* char* in shared space */
12458 c = (char*)POPPTR(ss,ix);
12459 TOPPTR(nss,ix) = savesharedpv(c);
12460 ptr = POPPTR(ss,ix);
12461 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12463 case SAVEt_GENERIC_SVREF: /* generic sv */
12464 case SAVEt_SVREF: /* scalar reference */
12465 sv = (const SV *)POPPTR(ss,ix);
12466 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12467 ptr = POPPTR(ss,ix);
12468 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12470 case SAVEt_HV: /* hash reference */
12471 case SAVEt_AV: /* array reference */
12472 sv = (const SV *) POPPTR(ss,ix);
12473 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12475 case SAVEt_COMPPAD:
12477 sv = (const SV *) POPPTR(ss,ix);
12478 TOPPTR(nss,ix) = sv_dup(sv, param);
12480 case SAVEt_INT: /* int reference */
12481 ptr = POPPTR(ss,ix);
12482 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12483 intval = (int)POPINT(ss,ix);
12484 TOPINT(nss,ix) = intval;
12486 case SAVEt_LONG: /* long reference */
12487 ptr = POPPTR(ss,ix);
12488 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12489 longval = (long)POPLONG(ss,ix);
12490 TOPLONG(nss,ix) = longval;
12492 case SAVEt_I32: /* I32 reference */
12493 ptr = POPPTR(ss,ix);
12494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12496 TOPINT(nss,ix) = i;
12498 case SAVEt_IV: /* IV reference */
12499 ptr = POPPTR(ss,ix);
12500 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12502 TOPIV(nss,ix) = iv;
12504 case SAVEt_HPTR: /* HV* reference */
12505 case SAVEt_APTR: /* AV* reference */
12506 case SAVEt_SPTR: /* SV* reference */
12507 ptr = POPPTR(ss,ix);
12508 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12509 sv = (const SV *)POPPTR(ss,ix);
12510 TOPPTR(nss,ix) = sv_dup(sv, param);
12512 case SAVEt_VPTR: /* random* reference */
12513 ptr = POPPTR(ss,ix);
12514 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12516 case SAVEt_INT_SMALL:
12517 case SAVEt_I32_SMALL:
12518 case SAVEt_I16: /* I16 reference */
12519 case SAVEt_I8: /* I8 reference */
12521 ptr = POPPTR(ss,ix);
12522 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12524 case SAVEt_GENERIC_PVREF: /* generic char* */
12525 case SAVEt_PPTR: /* char* reference */
12526 ptr = POPPTR(ss,ix);
12527 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12528 c = (char*)POPPTR(ss,ix);
12529 TOPPTR(nss,ix) = pv_dup(c);
12531 case SAVEt_GP: /* scalar reference */
12532 gp = (GP*)POPPTR(ss,ix);
12533 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12534 (void)GpREFCNT_inc(gp);
12535 gv = (const GV *)POPPTR(ss,ix);
12536 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12539 ptr = POPPTR(ss,ix);
12540 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12541 /* these are assumed to be refcounted properly */
12543 switch (((OP*)ptr)->op_type) {
12545 case OP_LEAVESUBLV:
12549 case OP_LEAVEWRITE:
12550 TOPPTR(nss,ix) = ptr;
12553 (void) OpREFCNT_inc(o);
12557 TOPPTR(nss,ix) = NULL;
12562 TOPPTR(nss,ix) = NULL;
12564 case SAVEt_FREECOPHH:
12565 ptr = POPPTR(ss,ix);
12566 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12569 hv = (const HV *)POPPTR(ss,ix);
12570 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12572 TOPINT(nss,ix) = i;
12575 c = (char*)POPPTR(ss,ix);
12576 TOPPTR(nss,ix) = pv_dup_inc(c);
12578 case SAVEt_STACK_POS: /* Position on Perl stack */
12580 TOPINT(nss,ix) = i;
12582 case SAVEt_DESTRUCTOR:
12583 ptr = POPPTR(ss,ix);
12584 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12585 dptr = POPDPTR(ss,ix);
12586 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12587 any_dup(FPTR2DPTR(void *, dptr),
12590 case SAVEt_DESTRUCTOR_X:
12591 ptr = POPPTR(ss,ix);
12592 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12593 dxptr = POPDXPTR(ss,ix);
12594 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12595 any_dup(FPTR2DPTR(void *, dxptr),
12598 case SAVEt_REGCONTEXT:
12600 ix -= uv >> SAVE_TIGHT_SHIFT;
12602 case SAVEt_AELEM: /* array element */
12603 sv = (const SV *)POPPTR(ss,ix);
12604 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12606 TOPINT(nss,ix) = i;
12607 av = (const AV *)POPPTR(ss,ix);
12608 TOPPTR(nss,ix) = av_dup_inc(av, param);
12611 ptr = POPPTR(ss,ix);
12612 TOPPTR(nss,ix) = ptr;
12615 ptr = POPPTR(ss,ix);
12616 ptr = cophh_copy((COPHH*)ptr);
12617 TOPPTR(nss,ix) = ptr;
12619 TOPINT(nss,ix) = i;
12620 if (i & HINT_LOCALIZE_HH) {
12621 hv = (const HV *)POPPTR(ss,ix);
12622 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12625 case SAVEt_PADSV_AND_MORTALIZE:
12626 longval = (long)POPLONG(ss,ix);
12627 TOPLONG(nss,ix) = longval;
12628 ptr = POPPTR(ss,ix);
12629 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12630 sv = (const SV *)POPPTR(ss,ix);
12631 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12633 case SAVEt_SET_SVFLAGS:
12635 TOPINT(nss,ix) = i;
12637 TOPINT(nss,ix) = i;
12638 sv = (const SV *)POPPTR(ss,ix);
12639 TOPPTR(nss,ix) = sv_dup(sv, param);
12641 case SAVEt_RE_STATE:
12643 const struct re_save_state *const old_state
12644 = (struct re_save_state *)
12645 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12646 struct re_save_state *const new_state
12647 = (struct re_save_state *)
12648 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12650 Copy(old_state, new_state, 1, struct re_save_state);
12651 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12653 new_state->re_state_bostr
12654 = pv_dup(old_state->re_state_bostr);
12655 new_state->re_state_reginput
12656 = pv_dup(old_state->re_state_reginput);
12657 new_state->re_state_regeol
12658 = pv_dup(old_state->re_state_regeol);
12659 new_state->re_state_regoffs
12660 = (regexp_paren_pair*)
12661 any_dup(old_state->re_state_regoffs, proto_perl);
12662 new_state->re_state_reglastparen
12663 = (U32*) any_dup(old_state->re_state_reglastparen,
12665 new_state->re_state_reglastcloseparen
12666 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12668 /* XXX This just has to be broken. The old save_re_context
12669 code did SAVEGENERICPV(PL_reg_start_tmp);
12670 PL_reg_start_tmp is char **.
12671 Look above to what the dup code does for
12672 SAVEt_GENERIC_PVREF
12673 It can never have worked.
12674 So this is merely a faithful copy of the exiting bug: */
12675 new_state->re_state_reg_start_tmp
12676 = (char **) pv_dup((char *)
12677 old_state->re_state_reg_start_tmp);
12678 /* I assume that it only ever "worked" because no-one called
12679 (pseudo)fork while the regexp engine had re-entered itself.
12681 #ifdef PERL_OLD_COPY_ON_WRITE
12682 new_state->re_state_nrs
12683 = sv_dup(old_state->re_state_nrs, param);
12685 new_state->re_state_reg_magic
12686 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12688 new_state->re_state_reg_oldcurpm
12689 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12691 new_state->re_state_reg_curpm
12692 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12694 new_state->re_state_reg_oldsaved
12695 = pv_dup(old_state->re_state_reg_oldsaved);
12696 new_state->re_state_reg_poscache
12697 = pv_dup(old_state->re_state_reg_poscache);
12698 new_state->re_state_reg_starttry
12699 = pv_dup(old_state->re_state_reg_starttry);
12702 case SAVEt_COMPILE_WARNINGS:
12703 ptr = POPPTR(ss,ix);
12704 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12707 ptr = POPPTR(ss,ix);
12708 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12712 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12720 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12721 * flag to the result. This is done for each stash before cloning starts,
12722 * so we know which stashes want their objects cloned */
12725 do_mark_cloneable_stash(pTHX_ SV *const sv)
12727 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12729 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12730 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12731 if (cloner && GvCV(cloner)) {
12738 mXPUSHs(newSVhek(hvname));
12740 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12747 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12755 =for apidoc perl_clone
12757 Create and return a new interpreter by cloning the current one.
12759 perl_clone takes these flags as parameters:
12761 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12762 without it we only clone the data and zero the stacks,
12763 with it we copy the stacks and the new perl interpreter is
12764 ready to run at the exact same point as the previous one.
12765 The pseudo-fork code uses COPY_STACKS while the
12766 threads->create doesn't.
12768 CLONEf_KEEP_PTR_TABLE -
12769 perl_clone keeps a ptr_table with the pointer of the old
12770 variable as a key and the new variable as a value,
12771 this allows it to check if something has been cloned and not
12772 clone it again but rather just use the value and increase the
12773 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12774 the ptr_table using the function
12775 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12776 reason to keep it around is if you want to dup some of your own
12777 variable who are outside the graph perl scans, example of this
12778 code is in threads.xs create.
12780 CLONEf_CLONE_HOST -
12781 This is a win32 thing, it is ignored on unix, it tells perls
12782 win32host code (which is c++) to clone itself, this is needed on
12783 win32 if you want to run two threads at the same time,
12784 if you just want to do some stuff in a separate perl interpreter
12785 and then throw it away and return to the original one,
12786 you don't need to do anything.
12791 /* XXX the above needs expanding by someone who actually understands it ! */
12792 EXTERN_C PerlInterpreter *
12793 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12796 perl_clone(PerlInterpreter *proto_perl, UV flags)
12799 #ifdef PERL_IMPLICIT_SYS
12801 PERL_ARGS_ASSERT_PERL_CLONE;
12803 /* perlhost.h so we need to call into it
12804 to clone the host, CPerlHost should have a c interface, sky */
12806 if (flags & CLONEf_CLONE_HOST) {
12807 return perl_clone_host(proto_perl,flags);
12809 return perl_clone_using(proto_perl, flags,
12811 proto_perl->IMemShared,
12812 proto_perl->IMemParse,
12814 proto_perl->IStdIO,
12818 proto_perl->IProc);
12822 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12823 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12824 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12825 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12826 struct IPerlDir* ipD, struct IPerlSock* ipS,
12827 struct IPerlProc* ipP)
12829 /* XXX many of the string copies here can be optimized if they're
12830 * constants; they need to be allocated as common memory and just
12831 * their pointers copied. */
12834 CLONE_PARAMS clone_params;
12835 CLONE_PARAMS* const param = &clone_params;
12837 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12839 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12840 #else /* !PERL_IMPLICIT_SYS */
12842 CLONE_PARAMS clone_params;
12843 CLONE_PARAMS* param = &clone_params;
12844 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12846 PERL_ARGS_ASSERT_PERL_CLONE;
12847 #endif /* PERL_IMPLICIT_SYS */
12849 /* for each stash, determine whether its objects should be cloned */
12850 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12851 PERL_SET_THX(my_perl);
12854 PoisonNew(my_perl, 1, PerlInterpreter);
12857 PL_defstash = NULL; /* may be used by perl malloc() */
12860 PL_scopestack_name = 0;
12862 PL_savestack_ix = 0;
12863 PL_savestack_max = -1;
12864 PL_sig_pending = 0;
12866 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12867 # ifdef DEBUG_LEAKING_SCALARS
12868 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12870 #else /* !DEBUGGING */
12871 Zero(my_perl, 1, PerlInterpreter);
12872 #endif /* DEBUGGING */
12874 #ifdef PERL_IMPLICIT_SYS
12875 /* host pointers */
12877 PL_MemShared = ipMS;
12878 PL_MemParse = ipMP;
12885 #endif /* PERL_IMPLICIT_SYS */
12887 param->flags = flags;
12888 /* Nothing in the core code uses this, but we make it available to
12889 extensions (using mg_dup). */
12890 param->proto_perl = proto_perl;
12891 /* Likely nothing will use this, but it is initialised to be consistent
12892 with Perl_clone_params_new(). */
12893 param->new_perl = my_perl;
12894 param->unreferenced = NULL;
12896 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12898 PL_body_arenas = NULL;
12899 Zero(&PL_body_roots, 1, PL_body_roots);
12902 PL_sv_objcount = 0;
12904 PL_sv_arenaroot = NULL;
12906 PL_debug = proto_perl->Idebug;
12908 PL_hash_seed = proto_perl->Ihash_seed;
12909 PL_rehash_seed = proto_perl->Irehash_seed;
12911 SvANY(&PL_sv_undef) = NULL;
12912 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12913 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12914 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12915 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12916 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12918 SvANY(&PL_sv_yes) = new_XPVNV();
12919 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12920 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12921 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12923 /* dbargs array probably holds garbage */
12926 PL_compiling = proto_perl->Icompiling;
12928 #ifdef PERL_DEBUG_READONLY_OPS
12933 /* pseudo environmental stuff */
12934 PL_origargc = proto_perl->Iorigargc;
12935 PL_origargv = proto_perl->Iorigargv;
12937 /* Set tainting stuff before PerlIO_debug can possibly get called */
12938 PL_tainting = proto_perl->Itainting;
12939 PL_taint_warn = proto_perl->Itaint_warn;
12941 PL_minus_c = proto_perl->Iminus_c;
12943 PL_localpatches = proto_perl->Ilocalpatches;
12944 PL_splitstr = proto_perl->Isplitstr;
12945 PL_minus_n = proto_perl->Iminus_n;
12946 PL_minus_p = proto_perl->Iminus_p;
12947 PL_minus_l = proto_perl->Iminus_l;
12948 PL_minus_a = proto_perl->Iminus_a;
12949 PL_minus_E = proto_perl->Iminus_E;
12950 PL_minus_F = proto_perl->Iminus_F;
12951 PL_doswitches = proto_perl->Idoswitches;
12952 PL_dowarn = proto_perl->Idowarn;
12953 PL_sawampersand = proto_perl->Isawampersand;
12954 PL_unsafe = proto_perl->Iunsafe;
12955 PL_perldb = proto_perl->Iperldb;
12956 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12957 PL_exit_flags = proto_perl->Iexit_flags;
12959 /* XXX time(&PL_basetime) when asked for? */
12960 PL_basetime = proto_perl->Ibasetime;
12962 PL_maxsysfd = proto_perl->Imaxsysfd;
12963 PL_statusvalue = proto_perl->Istatusvalue;
12965 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12967 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12970 /* RE engine related */
12971 Zero(&PL_reg_state, 1, struct re_save_state);
12972 PL_reginterp_cnt = 0;
12973 PL_regmatch_slab = NULL;
12975 PL_sub_generation = proto_perl->Isub_generation;
12977 /* funky return mechanisms */
12978 PL_forkprocess = proto_perl->Iforkprocess;
12980 /* internal state */
12981 PL_maxo = proto_perl->Imaxo;
12983 PL_main_start = proto_perl->Imain_start;
12984 PL_eval_root = proto_perl->Ieval_root;
12985 PL_eval_start = proto_perl->Ieval_start;
12987 PL_filemode = proto_perl->Ifilemode;
12988 PL_lastfd = proto_perl->Ilastfd;
12989 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
12992 PL_gensym = proto_perl->Igensym;
12994 PL_laststatval = proto_perl->Ilaststatval;
12995 PL_laststype = proto_perl->Ilaststype;
12998 PL_profiledata = NULL;
13000 PL_generation = proto_perl->Igeneration;
13002 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13003 PL_in_clean_all = proto_perl->Iin_clean_all;
13005 PL_uid = proto_perl->Iuid;
13006 PL_euid = proto_perl->Ieuid;
13007 PL_gid = proto_perl->Igid;
13008 PL_egid = proto_perl->Iegid;
13009 PL_nomemok = proto_perl->Inomemok;
13010 PL_an = proto_perl->Ian;
13011 PL_evalseq = proto_perl->Ievalseq;
13012 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13013 PL_origalen = proto_perl->Iorigalen;
13015 PL_sighandlerp = proto_perl->Isighandlerp;
13017 PL_runops = proto_perl->Irunops;
13019 PL_subline = proto_perl->Isubline;
13022 PL_cryptseen = proto_perl->Icryptseen;
13025 PL_hints = proto_perl->Ihints;
13027 PL_amagic_generation = proto_perl->Iamagic_generation;
13029 #ifdef USE_LOCALE_COLLATE
13030 PL_collation_ix = proto_perl->Icollation_ix;
13031 PL_collation_standard = proto_perl->Icollation_standard;
13032 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13033 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13034 #endif /* USE_LOCALE_COLLATE */
13036 #ifdef USE_LOCALE_NUMERIC
13037 PL_numeric_standard = proto_perl->Inumeric_standard;
13038 PL_numeric_local = proto_perl->Inumeric_local;
13039 #endif /* !USE_LOCALE_NUMERIC */
13041 /* Did the locale setup indicate UTF-8? */
13042 PL_utf8locale = proto_perl->Iutf8locale;
13043 /* Unicode features (see perlrun/-C) */
13044 PL_unicode = proto_perl->Iunicode;
13046 /* Pre-5.8 signals control */
13047 PL_signals = proto_perl->Isignals;
13049 /* times() ticks per second */
13050 PL_clocktick = proto_perl->Iclocktick;
13052 /* Recursion stopper for PerlIO_find_layer */
13053 PL_in_load_module = proto_perl->Iin_load_module;
13055 /* sort() routine */
13056 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13058 /* Not really needed/useful since the reenrant_retint is "volatile",
13059 * but do it for consistency's sake. */
13060 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13062 /* Hooks to shared SVs and locks. */
13063 PL_sharehook = proto_perl->Isharehook;
13064 PL_lockhook = proto_perl->Ilockhook;
13065 PL_unlockhook = proto_perl->Iunlockhook;
13066 PL_threadhook = proto_perl->Ithreadhook;
13067 PL_destroyhook = proto_perl->Idestroyhook;
13068 PL_signalhook = proto_perl->Isignalhook;
13070 PL_globhook = proto_perl->Iglobhook;
13072 #ifdef THREADS_HAVE_PIDS
13073 PL_ppid = proto_perl->Ippid;
13077 PL_last_swash_hv = NULL; /* reinits on demand */
13078 PL_last_swash_klen = 0;
13079 PL_last_swash_key[0]= '\0';
13080 PL_last_swash_tmps = (U8*)NULL;
13081 PL_last_swash_slen = 0;
13083 PL_glob_index = proto_perl->Iglob_index;
13084 PL_srand_called = proto_perl->Isrand_called;
13086 if (flags & CLONEf_COPY_STACKS) {
13087 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13088 PL_tmps_ix = proto_perl->Itmps_ix;
13089 PL_tmps_max = proto_perl->Itmps_max;
13090 PL_tmps_floor = proto_perl->Itmps_floor;
13092 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13093 * NOTE: unlike the others! */
13094 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13095 PL_scopestack_max = proto_perl->Iscopestack_max;
13097 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13098 * NOTE: unlike the others! */
13099 PL_savestack_ix = proto_perl->Isavestack_ix;
13100 PL_savestack_max = proto_perl->Isavestack_max;
13103 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13104 PL_top_env = &PL_start_env;
13106 PL_op = proto_perl->Iop;
13109 PL_Xpv = (XPV*)NULL;
13110 my_perl->Ina = proto_perl->Ina;
13112 PL_statbuf = proto_perl->Istatbuf;
13113 PL_statcache = proto_perl->Istatcache;
13116 PL_timesbuf = proto_perl->Itimesbuf;
13119 PL_tainted = proto_perl->Itainted;
13120 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13122 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13124 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13125 PL_restartop = proto_perl->Irestartop;
13126 PL_in_eval = proto_perl->Iin_eval;
13127 PL_delaymagic = proto_perl->Idelaymagic;
13128 PL_phase = proto_perl->Iphase;
13129 PL_localizing = proto_perl->Ilocalizing;
13131 PL_hv_fetch_ent_mh = NULL;
13132 PL_modcount = proto_perl->Imodcount;
13133 PL_lastgotoprobe = NULL;
13134 PL_dumpindent = proto_perl->Idumpindent;
13136 PL_efloatbuf = NULL; /* reinits on demand */
13137 PL_efloatsize = 0; /* reinits on demand */
13141 PL_regdummy = proto_perl->Iregdummy;
13142 PL_colorset = 0; /* reinits PL_colors[] */
13143 /*PL_colors[6] = {0,0,0,0,0,0};*/
13145 /* Pluggable optimizer */
13146 PL_peepp = proto_perl->Ipeepp;
13147 PL_rpeepp = proto_perl->Irpeepp;
13148 /* op_free() hook */
13149 PL_opfreehook = proto_perl->Iopfreehook;
13151 #ifdef USE_REENTRANT_API
13152 /* XXX: things like -Dm will segfault here in perlio, but doing
13153 * PERL_SET_CONTEXT(proto_perl);
13154 * breaks too many other things
13156 Perl_reentrant_init(aTHX);
13159 /* create SV map for pointer relocation */
13160 PL_ptr_table = ptr_table_new();
13162 /* initialize these special pointers as early as possible */
13163 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13165 SvANY(&PL_sv_no) = new_XPVNV();
13166 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
13167 SvCUR_set(&PL_sv_no, 0);
13168 SvLEN_set(&PL_sv_no, 1);
13169 SvIV_set(&PL_sv_no, 0);
13170 SvNV_set(&PL_sv_no, 0);
13171 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13173 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
13174 SvCUR_set(&PL_sv_yes, 1);
13175 SvLEN_set(&PL_sv_yes, 2);
13176 SvIV_set(&PL_sv_yes, 1);
13177 SvNV_set(&PL_sv_yes, 1);
13178 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13180 /* create (a non-shared!) shared string table */
13181 PL_strtab = newHV();
13182 HvSHAREKEYS_off(PL_strtab);
13183 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13184 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13186 /* These two PVs will be free'd special way so must set them same way op.c does */
13187 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
13188 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
13190 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13191 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13193 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13194 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13195 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13196 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13198 param->stashes = newAV(); /* Setup array of objects to call clone on */
13199 /* This makes no difference to the implementation, as it always pushes
13200 and shifts pointers to other SVs without changing their reference
13201 count, with the array becoming empty before it is freed. However, it
13202 makes it conceptually clear what is going on, and will avoid some
13203 work inside av.c, filling slots between AvFILL() and AvMAX() with
13204 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13205 AvREAL_off(param->stashes);
13207 if (!(flags & CLONEf_COPY_STACKS)) {
13208 param->unreferenced = newAV();
13211 #ifdef PERLIO_LAYERS
13212 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13213 PerlIO_clone(aTHX_ proto_perl, param);
13216 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13217 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13218 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13219 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13220 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13221 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13224 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13225 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13226 PL_inplace = SAVEPV(proto_perl->Iinplace);
13227 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13229 /* magical thingies */
13230 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
13232 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13234 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13235 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13236 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13239 /* Clone the regex array */
13240 /* ORANGE FIXME for plugins, probably in the SV dup code.
13241 newSViv(PTR2IV(CALLREGDUPE(
13242 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13244 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13245 PL_regex_pad = AvARRAY(PL_regex_padav);
13247 /* shortcuts to various I/O objects */
13248 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13249 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13250 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13251 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13252 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13253 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13254 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13256 /* shortcuts to regexp stuff */
13257 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13259 /* shortcuts to misc objects */
13260 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13262 /* shortcuts to debugging objects */
13263 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13264 PL_DBline = gv_dup(proto_perl->IDBline, param);
13265 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13266 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13267 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13268 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13270 /* symbol tables */
13271 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13272 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13273 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13274 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13275 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13277 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13278 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13279 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13280 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13281 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13282 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13283 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13284 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13286 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13288 /* subprocess state */
13289 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13291 if (proto_perl->Iop_mask)
13292 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13295 /* PL_asserting = proto_perl->Iasserting; */
13297 /* current interpreter roots */
13298 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13300 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13303 /* runtime control stuff */
13304 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13306 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13308 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13310 /* interpreter atexit processing */
13311 PL_exitlistlen = proto_perl->Iexitlistlen;
13312 if (PL_exitlistlen) {
13313 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13314 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13317 PL_exitlist = (PerlExitListEntry*)NULL;
13319 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13320 if (PL_my_cxt_size) {
13321 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13322 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13323 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13324 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13325 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13329 PL_my_cxt_list = (void**)NULL;
13330 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13331 PL_my_cxt_keys = (const char**)NULL;
13334 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13335 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13336 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13337 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13339 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13341 PAD_CLONE_VARS(proto_perl, param);
13343 #ifdef HAVE_INTERP_INTERN
13344 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13347 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13349 #ifdef PERL_USES_PL_PIDSTATUS
13350 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13352 PL_osname = SAVEPV(proto_perl->Iosname);
13353 PL_parser = parser_dup(proto_perl->Iparser, param);
13355 /* XXX this only works if the saved cop has already been cloned */
13356 if (proto_perl->Iparser) {
13357 PL_parser->saved_curcop = (COP*)any_dup(
13358 proto_perl->Iparser->saved_curcop,
13362 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13364 #ifdef USE_LOCALE_COLLATE
13365 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13366 #endif /* USE_LOCALE_COLLATE */
13368 #ifdef USE_LOCALE_NUMERIC
13369 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13370 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13371 #endif /* !USE_LOCALE_NUMERIC */
13373 /* utf8 character classes */
13374 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13375 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13376 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13377 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13378 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13379 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13380 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13381 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13382 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13383 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13384 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13385 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13386 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13387 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13388 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13389 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13390 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13391 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13392 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13393 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13394 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13395 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13396 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13397 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13398 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13399 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13400 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13401 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13402 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13403 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13404 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13407 if (proto_perl->Ipsig_pend) {
13408 Newxz(PL_psig_pend, SIG_SIZE, int);
13411 PL_psig_pend = (int*)NULL;
13414 if (proto_perl->Ipsig_name) {
13415 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13416 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13418 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13421 PL_psig_ptr = (SV**)NULL;
13422 PL_psig_name = (SV**)NULL;
13425 if (flags & CLONEf_COPY_STACKS) {
13426 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13427 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13428 PL_tmps_ix+1, param);
13430 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13431 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13432 Newxz(PL_markstack, i, I32);
13433 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13434 - proto_perl->Imarkstack);
13435 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13436 - proto_perl->Imarkstack);
13437 Copy(proto_perl->Imarkstack, PL_markstack,
13438 PL_markstack_ptr - PL_markstack + 1, I32);
13440 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13441 * NOTE: unlike the others! */
13442 Newxz(PL_scopestack, PL_scopestack_max, I32);
13443 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13446 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13447 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13449 /* NOTE: si_dup() looks at PL_markstack */
13450 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13452 /* PL_curstack = PL_curstackinfo->si_stack; */
13453 PL_curstack = av_dup(proto_perl->Icurstack, param);
13454 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13456 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13457 PL_stack_base = AvARRAY(PL_curstack);
13458 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13459 - proto_perl->Istack_base);
13460 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13462 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13463 PL_savestack = ss_dup(proto_perl, param);
13467 ENTER; /* perl_destruct() wants to LEAVE; */
13470 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13471 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13473 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13474 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13475 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13476 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13477 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13478 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13480 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13482 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13483 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13484 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13485 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13487 PL_stashcache = newHV();
13489 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13490 proto_perl->Iwatchaddr);
13491 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13492 if (PL_debug && PL_watchaddr) {
13493 PerlIO_printf(Perl_debug_log,
13494 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13495 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13496 PTR2UV(PL_watchok));
13499 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13500 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13501 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13503 /* Call the ->CLONE method, if it exists, for each of the stashes
13504 identified by sv_dup() above.
13506 while(av_len(param->stashes) != -1) {
13507 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13508 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13509 if (cloner && GvCV(cloner)) {
13514 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13516 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13522 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13523 ptr_table_free(PL_ptr_table);
13524 PL_ptr_table = NULL;
13527 if (!(flags & CLONEf_COPY_STACKS)) {
13528 unreferenced_to_tmp_stack(param->unreferenced);
13531 SvREFCNT_dec(param->stashes);
13533 /* orphaned? eg threads->new inside BEGIN or use */
13534 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13535 SvREFCNT_inc_simple_void(PL_compcv);
13536 SAVEFREESV(PL_compcv);
13543 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13545 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13547 if (AvFILLp(unreferenced) > -1) {
13548 SV **svp = AvARRAY(unreferenced);
13549 SV **const last = svp + AvFILLp(unreferenced);
13553 if (SvREFCNT(*svp) == 1)
13555 } while (++svp <= last);
13557 EXTEND_MORTAL(count);
13558 svp = AvARRAY(unreferenced);
13561 if (SvREFCNT(*svp) == 1) {
13562 /* Our reference is the only one to this SV. This means that
13563 in this thread, the scalar effectively has a 0 reference.
13564 That doesn't work (cleanup never happens), so donate our
13565 reference to it onto the save stack. */
13566 PL_tmps_stack[++PL_tmps_ix] = *svp;
13568 /* As an optimisation, because we are already walking the
13569 entire array, instead of above doing either
13570 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13571 release our reference to the scalar, so that at the end of
13572 the array owns zero references to the scalars it happens to
13573 point to. We are effectively converting the array from
13574 AvREAL() on to AvREAL() off. This saves the av_clear()
13575 (triggered by the SvREFCNT_dec(unreferenced) below) from
13576 walking the array a second time. */
13577 SvREFCNT_dec(*svp);
13580 } while (++svp <= last);
13581 AvREAL_off(unreferenced);
13583 SvREFCNT_dec(unreferenced);
13587 Perl_clone_params_del(CLONE_PARAMS *param)
13589 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13591 PerlInterpreter *const to = param->new_perl;
13593 PerlInterpreter *const was = PERL_GET_THX;
13595 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13601 SvREFCNT_dec(param->stashes);
13602 if (param->unreferenced)
13603 unreferenced_to_tmp_stack(param->unreferenced);
13613 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13616 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13617 does a dTHX; to get the context from thread local storage.
13618 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13619 a version that passes in my_perl. */
13620 PerlInterpreter *const was = PERL_GET_THX;
13621 CLONE_PARAMS *param;
13623 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13629 /* Given that we've set the context, we can do this unshared. */
13630 Newx(param, 1, CLONE_PARAMS);
13633 param->proto_perl = from;
13634 param->new_perl = to;
13635 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13636 AvREAL_off(param->stashes);
13637 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13645 #endif /* USE_ITHREADS */
13648 =head1 Unicode Support
13650 =for apidoc sv_recode_to_utf8
13652 The encoding is assumed to be an Encode object, on entry the PV
13653 of the sv is assumed to be octets in that encoding, and the sv
13654 will be converted into Unicode (and UTF-8).
13656 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13657 is not a reference, nothing is done to the sv. If the encoding is not
13658 an C<Encode::XS> Encoding object, bad things will happen.
13659 (See F<lib/encoding.pm> and L<Encode>.)
13661 The PV of the sv is returned.
13666 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13670 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13672 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13686 Passing sv_yes is wrong - it needs to be or'ed set of constants
13687 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13688 remove converted chars from source.
13690 Both will default the value - let them.
13692 XPUSHs(&PL_sv_yes);
13695 call_method("decode", G_SCALAR);
13699 s = SvPV_const(uni, len);
13700 if (s != SvPVX_const(sv)) {
13701 SvGROW(sv, len + 1);
13702 Move(s, SvPVX(sv), len + 1, char);
13703 SvCUR_set(sv, len);
13707 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13708 /* clear pos and any utf8 cache */
13709 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13712 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13713 magic_setutf8(sv,mg); /* clear UTF8 cache */
13718 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13722 =for apidoc sv_cat_decode
13724 The encoding is assumed to be an Encode object, the PV of the ssv is
13725 assumed to be octets in that encoding and decoding the input starts
13726 from the position which (PV + *offset) pointed to. The dsv will be
13727 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13728 when the string tstr appears in decoding output or the input ends on
13729 the PV of the ssv. The value which the offset points will be modified
13730 to the last input position on the ssv.
13732 Returns TRUE if the terminator was found, else returns FALSE.
13737 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13738 SV *ssv, int *offset, char *tstr, int tlen)
13743 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13745 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13756 offsv = newSViv(*offset);
13758 mXPUSHp(tstr, tlen);
13760 call_method("cat_decode", G_SCALAR);
13762 ret = SvTRUE(TOPs);
13763 *offset = SvIV(offsv);
13769 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13774 /* ---------------------------------------------------------------------
13776 * support functions for report_uninit()
13779 /* the maxiumum size of array or hash where we will scan looking
13780 * for the undefined element that triggered the warning */
13782 #define FUV_MAX_SEARCH_SIZE 1000
13784 /* Look for an entry in the hash whose value has the same SV as val;
13785 * If so, return a mortal copy of the key. */
13788 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13791 register HE **array;
13794 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13796 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13797 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13800 array = HvARRAY(hv);
13802 for (i=HvMAX(hv); i>0; i--) {
13803 register HE *entry;
13804 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13805 if (HeVAL(entry) != val)
13807 if ( HeVAL(entry) == &PL_sv_undef ||
13808 HeVAL(entry) == &PL_sv_placeholder)
13812 if (HeKLEN(entry) == HEf_SVKEY)
13813 return sv_mortalcopy(HeKEY_sv(entry));
13814 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13820 /* Look for an entry in the array whose value has the same SV as val;
13821 * If so, return the index, otherwise return -1. */
13824 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13828 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13830 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13831 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13834 if (val != &PL_sv_undef) {
13835 SV ** const svp = AvARRAY(av);
13838 for (i=AvFILLp(av); i>=0; i--)
13845 /* S_varname(): return the name of a variable, optionally with a subscript.
13846 * If gv is non-zero, use the name of that global, along with gvtype (one
13847 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13848 * targ. Depending on the value of the subscript_type flag, return:
13851 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13852 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13853 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13854 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13857 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13858 const SV *const keyname, I32 aindex, int subscript_type)
13861 SV * const name = sv_newmortal();
13862 if (gv && isGV(gv)) {
13864 buffer[0] = gvtype;
13867 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13869 gv_fullname4(name, gv, buffer, 0);
13871 if ((unsigned int)SvPVX(name)[1] <= 26) {
13873 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13875 /* Swap the 1 unprintable control character for the 2 byte pretty
13876 version - ie substr($name, 1, 1) = $buffer; */
13877 sv_insert(name, 1, 1, buffer, 2);
13881 CV * const cv = gv ? (CV *)gv : find_runcv(NULL);
13885 assert(!cv || SvTYPE(cv) == SVt_PVCV);
13887 if (!cv || !CvPADLIST(cv))
13889 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13890 sv = *av_fetch(av, targ, FALSE);
13891 sv_setsv(name, sv);
13894 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13895 SV * const sv = newSV(0);
13896 *SvPVX(name) = '$';
13897 Perl_sv_catpvf(aTHX_ name, "{%s}",
13898 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
13901 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13902 *SvPVX(name) = '$';
13903 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13905 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13906 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13907 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
13915 =for apidoc find_uninit_var
13917 Find the name of the undefined variable (if any) that caused the operator
13918 to issue a "Use of uninitialized value" warning.
13919 If match is true, only return a name if its value matches uninit_sv.
13920 So roughly speaking, if a unary operator (such as OP_COS) generates a
13921 warning, then following the direct child of the op may yield an
13922 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
13923 other hand, with OP_ADD there are two branches to follow, so we only print
13924 the variable name if we get an exact match.
13926 The name is returned as a mortal SV.
13928 Assumes that PL_op is the op that originally triggered the error, and that
13929 PL_comppad/PL_curpad points to the currently executing pad.
13935 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
13941 const OP *o, *o2, *kid;
13943 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
13944 uninit_sv == &PL_sv_placeholder)))
13947 switch (obase->op_type) {
13954 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
13955 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
13958 int subscript_type = FUV_SUBSCRIPT_WITHIN;
13960 if (pad) { /* @lex, %lex */
13961 sv = PAD_SVl(obase->op_targ);
13965 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13966 /* @global, %global */
13967 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13970 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
13972 else if (obase == PL_op) /* @{expr}, %{expr} */
13973 return find_uninit_var(cUNOPx(obase)->op_first,
13975 else /* @{expr}, %{expr} as a sub-expression */
13979 /* attempt to find a match within the aggregate */
13981 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13983 subscript_type = FUV_SUBSCRIPT_HASH;
13986 index = find_array_subscript((const AV *)sv, uninit_sv);
13988 subscript_type = FUV_SUBSCRIPT_ARRAY;
13991 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
13994 return varname(gv, hash ? '%' : '@', obase->op_targ,
13995 keysv, index, subscript_type);
13999 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14001 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14002 if (!gv || !GvSTASH(gv))
14004 if (match && (GvSV(gv) != uninit_sv))
14006 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14009 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14012 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14014 return varname(NULL, '$', obase->op_targ,
14015 NULL, 0, FUV_SUBSCRIPT_NONE);
14018 gv = cGVOPx_gv(obase);
14019 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14021 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14023 case OP_AELEMFAST_LEX:
14026 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14027 if (!av || SvRMAGICAL(av))
14029 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14030 if (!svp || *svp != uninit_sv)
14033 return varname(NULL, '$', obase->op_targ,
14034 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14037 gv = cGVOPx_gv(obase);
14042 AV *const av = GvAV(gv);
14043 if (!av || SvRMAGICAL(av))
14045 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14046 if (!svp || *svp != uninit_sv)
14049 return varname(gv, '$', 0,
14050 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14055 o = cUNOPx(obase)->op_first;
14056 if (!o || o->op_type != OP_NULL ||
14057 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14059 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14064 bool negate = FALSE;
14066 if (PL_op == obase)
14067 /* $a[uninit_expr] or $h{uninit_expr} */
14068 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14071 o = cBINOPx(obase)->op_first;
14072 kid = cBINOPx(obase)->op_last;
14074 /* get the av or hv, and optionally the gv */
14076 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14077 sv = PAD_SV(o->op_targ);
14079 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14080 && cUNOPo->op_first->op_type == OP_GV)
14082 gv = cGVOPx_gv(cUNOPo->op_first);
14086 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14091 if (kid && kid->op_type == OP_NEGATE) {
14093 kid = cUNOPx(kid)->op_first;
14096 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14097 /* index is constant */
14100 kidsv = sv_2mortal(newSVpvs("-"));
14101 sv_catsv(kidsv, cSVOPx_sv(kid));
14104 kidsv = cSVOPx_sv(kid);
14108 if (obase->op_type == OP_HELEM) {
14109 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14110 if (!he || HeVAL(he) != uninit_sv)
14114 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14115 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14117 if (!svp || *svp != uninit_sv)
14121 if (obase->op_type == OP_HELEM)
14122 return varname(gv, '%', o->op_targ,
14123 kidsv, 0, FUV_SUBSCRIPT_HASH);
14125 return varname(gv, '@', o->op_targ, NULL,
14126 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14127 FUV_SUBSCRIPT_ARRAY);
14130 /* index is an expression;
14131 * attempt to find a match within the aggregate */
14132 if (obase->op_type == OP_HELEM) {
14133 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14135 return varname(gv, '%', o->op_targ,
14136 keysv, 0, FUV_SUBSCRIPT_HASH);
14140 = find_array_subscript((const AV *)sv, uninit_sv);
14142 return varname(gv, '@', o->op_targ,
14143 NULL, index, FUV_SUBSCRIPT_ARRAY);
14148 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14150 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14156 /* only examine RHS */
14157 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14160 o = cUNOPx(obase)->op_first;
14161 if (o->op_type == OP_PUSHMARK)
14164 if (!o->op_sibling) {
14165 /* one-arg version of open is highly magical */
14167 if (o->op_type == OP_GV) { /* open FOO; */
14169 if (match && GvSV(gv) != uninit_sv)
14171 return varname(gv, '$', 0,
14172 NULL, 0, FUV_SUBSCRIPT_NONE);
14174 /* other possibilities not handled are:
14175 * open $x; or open my $x; should return '${*$x}'
14176 * open expr; should return '$'.expr ideally
14182 /* ops where $_ may be an implicit arg */
14187 if ( !(obase->op_flags & OPf_STACKED)) {
14188 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14189 ? PAD_SVl(obase->op_targ)
14192 sv = sv_newmortal();
14193 sv_setpvs(sv, "$_");
14202 match = 1; /* print etc can return undef on defined args */
14203 /* skip filehandle as it can't produce 'undef' warning */
14204 o = cUNOPx(obase)->op_first;
14205 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14206 o = o->op_sibling->op_sibling;
14210 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14211 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14213 /* the following ops are capable of returning PL_sv_undef even for
14214 * defined arg(s) */
14233 case OP_GETPEERNAME:
14281 case OP_SMARTMATCH:
14290 /* XXX tmp hack: these two may call an XS sub, and currently
14291 XS subs don't have a SUB entry on the context stack, so CV and
14292 pad determination goes wrong, and BAD things happen. So, just
14293 don't try to determine the value under those circumstances.
14294 Need a better fix at dome point. DAPM 11/2007 */
14300 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14301 if (gv && GvSV(gv) == uninit_sv)
14302 return newSVpvs_flags("$.", SVs_TEMP);
14307 /* def-ness of rval pos() is independent of the def-ness of its arg */
14308 if ( !(obase->op_flags & OPf_MOD))
14313 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14314 return newSVpvs_flags("${$/}", SVs_TEMP);
14319 if (!(obase->op_flags & OPf_KIDS))
14321 o = cUNOPx(obase)->op_first;
14327 /* This loop checks all the kid ops, skipping any that cannot pos-
14328 * sibly be responsible for the uninitialized value; i.e., defined
14329 * constants and ops that return nothing. If there is only one op
14330 * left that is not skipped, then we *know* it is responsible for
14331 * the uninitialized value. If there is more than one op left, we
14332 * have to look for an exact match in the while() loop below.
14335 for (kid=o; kid; kid = kid->op_sibling) {
14337 const OPCODE type = kid->op_type;
14338 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14339 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14340 || (type == OP_PUSHMARK)
14344 if (o2) { /* more than one found */
14351 return find_uninit_var(o2, uninit_sv, match);
14353 /* scan all args */
14355 sv = find_uninit_var(o, uninit_sv, 1);
14367 =for apidoc report_uninit
14369 Print appropriate "Use of uninitialized variable" warning.
14375 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14379 SV* varname = NULL;
14380 if (uninit_sv && PL_curpad) {
14381 varname = find_uninit_var(PL_op, uninit_sv,0);
14383 sv_insert(varname, 0, 0, " ", 1);
14385 /* diag_listed_as: Use of uninitialized value%s */
14386 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14387 SVfARG(varname ? varname : &PL_sv_no),
14388 " in ", OP_DESC(PL_op));
14391 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14397 * c-indentation-style: bsd
14398 * c-basic-offset: 4
14399 * indent-tabs-mode: t
14402 * ex: set ts=8 sts=4 sw=4 noet: