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) STMT_START { \
186 if ((sv)->sv_debug_file) PerlMemShared_free((sv)->sv_debug_file); \
188 # define DEBUG_SV_SERIAL(sv) \
189 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
190 PTR2UV(sv), (long)(sv)->sv_debug_serial))
192 # define FREE_SV_DEBUG_FILE(sv)
193 # define DEBUG_SV_SERIAL(sv) NOOP
197 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
198 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
199 /* Whilst I'd love to do this, it seems that things like to check on
201 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
203 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
204 PoisonNew(&SvREFCNT(sv), 1, U32)
206 # define SvARENA_CHAIN(sv) SvANY(sv)
207 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
208 # define POSION_SV_HEAD(sv)
211 /* Mark an SV head as unused, and add to free list.
213 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
214 * its refcount artificially decremented during global destruction, so
215 * there may be dangling pointers to it. The last thing we want in that
216 * case is for it to be reused. */
218 #define plant_SV(p) \
220 const U32 old_flags = SvFLAGS(p); \
221 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
222 DEBUG_SV_SERIAL(p); \
223 FREE_SV_DEBUG_FILE(p); \
225 SvFLAGS(p) = SVTYPEMASK; \
226 if (!(old_flags & SVf_BREAK)) { \
227 SvARENA_CHAIN_SET(p, PL_sv_root); \
233 #define uproot_SV(p) \
236 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
241 /* make some more SVs by adding another arena */
248 char *chunk; /* must use New here to match call to */
249 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
250 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
260 S_new_SV(pTHX_ const char *file, int line, const char *func)
267 sv = S_more_sv(aTHX);
271 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
272 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_parent = NULL;
280 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
282 sv->sv_debug_serial = PL_sv_serial++;
284 MEM_LOG_NEW_SV(sv, file, line, func);
285 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
286 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
290 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
298 (p) = S_more_sv(aTHX); \
302 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
307 /* del_SV(): return an empty SV head to the free list */
320 S_del_sv(pTHX_ SV *p)
324 PERL_ARGS_ASSERT_DEL_SV;
329 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
330 const SV * const sv = sva + 1;
331 const SV * const svend = &sva[SvREFCNT(sva)];
332 if (p >= sv && p < svend) {
338 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
339 "Attempt to free non-arena SV: 0x%"UVxf
340 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
347 #else /* ! DEBUGGING */
349 #define del_SV(p) plant_SV(p)
351 #endif /* DEBUGGING */
355 =head1 SV Manipulation Functions
357 =for apidoc sv_add_arena
359 Given a chunk of memory, link it to the head of the list of arenas,
360 and split it into a list of free SVs.
366 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
369 SV *const sva = MUTABLE_SV(ptr);
373 PERL_ARGS_ASSERT_SV_ADD_ARENA;
375 /* The first SV in an arena isn't an SV. */
376 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
377 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
378 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
380 PL_sv_arenaroot = sva;
381 PL_sv_root = sva + 1;
383 svend = &sva[SvREFCNT(sva) - 1];
386 SvARENA_CHAIN_SET(sv, (sv + 1));
390 /* Must always set typemask because it's always checked in on cleanup
391 when the arenas are walked looking for objects. */
392 SvFLAGS(sv) = SVTYPEMASK;
395 SvARENA_CHAIN_SET(sv, 0);
399 SvFLAGS(sv) = SVTYPEMASK;
402 /* visit(): call the named function for each non-free SV in the arenas
403 * whose flags field matches the flags/mask args. */
406 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
412 PERL_ARGS_ASSERT_VISIT;
414 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
415 const SV * const svend = &sva[SvREFCNT(sva)];
417 for (sv = sva + 1; sv < svend; ++sv) {
418 if (SvTYPE(sv) != (svtype)SVTYPEMASK
419 && (sv->sv_flags & mask) == flags
432 /* called by sv_report_used() for each live SV */
435 do_report_used(pTHX_ SV *const sv)
437 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
438 PerlIO_printf(Perl_debug_log, "****\n");
445 =for apidoc sv_report_used
447 Dump the contents of all SVs not yet freed (debugging aid).
453 Perl_sv_report_used(pTHX)
456 visit(do_report_used, 0, 0);
462 /* called by sv_clean_objs() for each live SV */
465 do_clean_objs(pTHX_ SV *const ref)
470 SV * const target = SvRV(ref);
471 if (SvOBJECT(target)) {
472 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
473 if (SvWEAKREF(ref)) {
474 sv_del_backref(target, ref);
480 SvREFCNT_dec(target);
485 /* XXX Might want to check arrays, etc. */
489 /* clear any slots in a GV which hold objects - except IO;
490 * called by sv_clean_objs() for each live GV */
493 do_clean_named_objs(pTHX_ SV *const sv)
497 assert(SvTYPE(sv) == SVt_PVGV);
498 assert(isGV_with_GP(sv));
502 /* freeing GP entries may indirectly free the current GV;
503 * hold onto it while we mess with the GP slots */
506 if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
507 DEBUG_D((PerlIO_printf(Perl_debug_log,
508 "Cleaning named glob SV object:\n "), sv_dump(obj)));
512 if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
513 DEBUG_D((PerlIO_printf(Perl_debug_log,
514 "Cleaning named glob AV object:\n "), sv_dump(obj)));
518 if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
519 DEBUG_D((PerlIO_printf(Perl_debug_log,
520 "Cleaning named glob HV object:\n "), sv_dump(obj)));
524 if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
525 DEBUG_D((PerlIO_printf(Perl_debug_log,
526 "Cleaning named glob CV object:\n "), sv_dump(obj)));
530 SvREFCNT_dec(sv); /* undo the inc above */
533 /* clear any IO slots in a GV which hold objects (except stderr, defout);
534 * called by sv_clean_objs() for each live GV */
537 do_clean_named_io_objs(pTHX_ SV *const sv)
541 assert(SvTYPE(sv) == SVt_PVGV);
542 assert(isGV_with_GP(sv));
543 if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
547 if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
548 DEBUG_D((PerlIO_printf(Perl_debug_log,
549 "Cleaning named glob IO object:\n "), sv_dump(obj)));
553 SvREFCNT_dec(sv); /* undo the inc above */
556 /* Void wrapper to pass to visit() */
558 do_curse(pTHX_ SV * const sv) {
559 if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
560 || (PL_defoutgv && GvGP(PL_defoutgv) && (SV*)GvIO(PL_defoutgv) == sv))
566 =for apidoc sv_clean_objs
568 Attempt to destroy all objects not yet freed.
574 Perl_sv_clean_objs(pTHX)
578 PL_in_clean_objs = TRUE;
579 visit(do_clean_objs, SVf_ROK, SVf_ROK);
580 /* Some barnacles may yet remain, clinging to typeglobs.
581 * Run the non-IO destructors first: they may want to output
582 * error messages, close files etc */
583 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
584 visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
585 /* And if there are some very tenacious barnacles clinging to arrays,
586 closures, or what have you.... */
587 visit(do_curse, SVs_OBJECT, SVs_OBJECT);
588 olddef = PL_defoutgv;
589 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
590 if (olddef && isGV_with_GP(olddef))
591 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
592 olderr = PL_stderrgv;
593 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
594 if (olderr && isGV_with_GP(olderr))
595 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
596 SvREFCNT_dec(olddef);
597 PL_in_clean_objs = FALSE;
600 /* called by sv_clean_all() for each live SV */
603 do_clean_all(pTHX_ SV *const sv)
606 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
607 /* don't clean pid table and strtab */
610 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
611 SvFLAGS(sv) |= SVf_BREAK;
616 =for apidoc sv_clean_all
618 Decrement the refcnt of each remaining SV, possibly triggering a
619 cleanup. This function may have to be called multiple times to free
620 SVs which are in complex self-referential hierarchies.
626 Perl_sv_clean_all(pTHX)
630 PL_in_clean_all = TRUE;
631 cleaned = visit(do_clean_all, 0,0);
636 ARENASETS: a meta-arena implementation which separates arena-info
637 into struct arena_set, which contains an array of struct
638 arena_descs, each holding info for a single arena. By separating
639 the meta-info from the arena, we recover the 1st slot, formerly
640 borrowed for list management. The arena_set is about the size of an
641 arena, avoiding the needless malloc overhead of a naive linked-list.
643 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
644 memory in the last arena-set (1/2 on average). In trade, we get
645 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
646 smaller types). The recovery of the wasted space allows use of
647 small arenas for large, rare body types, by changing array* fields
648 in body_details_by_type[] below.
651 char *arena; /* the raw storage, allocated aligned */
652 size_t size; /* its size ~4k typ */
653 svtype utype; /* bodytype stored in arena */
658 /* Get the maximum number of elements in set[] such that struct arena_set
659 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
660 therefore likely to be 1 aligned memory page. */
662 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
663 - 2 * sizeof(int)) / sizeof (struct arena_desc))
666 struct arena_set* next;
667 unsigned int set_size; /* ie ARENAS_PER_SET */
668 unsigned int curr; /* index of next available arena-desc */
669 struct arena_desc set[ARENAS_PER_SET];
673 =for apidoc sv_free_arenas
675 Deallocate the memory used by all arenas. Note that all the individual SV
676 heads and bodies within the arenas must already have been freed.
681 Perl_sv_free_arenas(pTHX)
688 /* Free arenas here, but be careful about fake ones. (We assume
689 contiguity of the fake ones with the corresponding real ones.) */
691 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
692 svanext = MUTABLE_SV(SvANY(sva));
693 while (svanext && SvFAKE(svanext))
694 svanext = MUTABLE_SV(SvANY(svanext));
701 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
704 struct arena_set *current = aroot;
707 assert(aroot->set[i].arena);
708 Safefree(aroot->set[i].arena);
716 i = PERL_ARENA_ROOTS_SIZE;
718 PL_body_roots[i] = 0;
725 Here are mid-level routines that manage the allocation of bodies out
726 of the various arenas. There are 5 kinds of arenas:
728 1. SV-head arenas, which are discussed and handled above
729 2. regular body arenas
730 3. arenas for reduced-size bodies
733 Arena types 2 & 3 are chained by body-type off an array of
734 arena-root pointers, which is indexed by svtype. Some of the
735 larger/less used body types are malloced singly, since a large
736 unused block of them is wasteful. Also, several svtypes dont have
737 bodies; the data fits into the sv-head itself. The arena-root
738 pointer thus has a few unused root-pointers (which may be hijacked
739 later for arena types 4,5)
741 3 differs from 2 as an optimization; some body types have several
742 unused fields in the front of the structure (which are kept in-place
743 for consistency). These bodies can be allocated in smaller chunks,
744 because the leading fields arent accessed. Pointers to such bodies
745 are decremented to point at the unused 'ghost' memory, knowing that
746 the pointers are used with offsets to the real memory.
749 =head1 SV-Body Allocation
751 Allocation of SV-bodies is similar to SV-heads, differing as follows;
752 the allocation mechanism is used for many body types, so is somewhat
753 more complicated, it uses arena-sets, and has no need for still-live
756 At the outermost level, (new|del)_X*V macros return bodies of the
757 appropriate type. These macros call either (new|del)_body_type or
758 (new|del)_body_allocated macro pairs, depending on specifics of the
759 type. Most body types use the former pair, the latter pair is used to
760 allocate body types with "ghost fields".
762 "ghost fields" are fields that are unused in certain types, and
763 consequently don't need to actually exist. They are declared because
764 they're part of a "base type", which allows use of functions as
765 methods. The simplest examples are AVs and HVs, 2 aggregate types
766 which don't use the fields which support SCALAR semantics.
768 For these types, the arenas are carved up into appropriately sized
769 chunks, we thus avoid wasted memory for those unaccessed members.
770 When bodies are allocated, we adjust the pointer back in memory by the
771 size of the part not allocated, so it's as if we allocated the full
772 structure. (But things will all go boom if you write to the part that
773 is "not there", because you'll be overwriting the last members of the
774 preceding structure in memory.)
776 We calculate the correction using the STRUCT_OFFSET macro on the first
777 member present. If the allocated structure is smaller (no initial NV
778 actually allocated) then the net effect is to subtract the size of the NV
779 from the pointer, to return a new pointer as if an initial NV were actually
780 allocated. (We were using structures named *_allocated for this, but
781 this turned out to be a subtle bug, because a structure without an NV
782 could have a lower alignment constraint, but the compiler is allowed to
783 optimised accesses based on the alignment constraint of the actual pointer
784 to the full structure, for example, using a single 64 bit load instruction
785 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
787 This is the same trick as was used for NV and IV bodies. Ironically it
788 doesn't need to be used for NV bodies any more, because NV is now at
789 the start of the structure. IV bodies don't need it either, because
790 they are no longer allocated.
792 In turn, the new_body_* allocators call S_new_body(), which invokes
793 new_body_inline macro, which takes a lock, and takes a body off the
794 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
795 necessary to refresh an empty list. Then the lock is released, and
796 the body is returned.
798 Perl_more_bodies allocates a new arena, and carves it up into an array of N
799 bodies, which it strings into a linked list. It looks up arena-size
800 and body-size from the body_details table described below, thus
801 supporting the multiple body-types.
803 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
804 the (new|del)_X*V macros are mapped directly to malloc/free.
806 For each sv-type, struct body_details bodies_by_type[] carries
807 parameters which control these aspects of SV handling:
809 Arena_size determines whether arenas are used for this body type, and if
810 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
811 zero, forcing individual mallocs and frees.
813 Body_size determines how big a body is, and therefore how many fit into
814 each arena. Offset carries the body-pointer adjustment needed for
815 "ghost fields", and is used in *_allocated macros.
817 But its main purpose is to parameterize info needed in
818 Perl_sv_upgrade(). The info here dramatically simplifies the function
819 vs the implementation in 5.8.8, making it table-driven. All fields
820 are used for this, except for arena_size.
822 For the sv-types that have no bodies, arenas are not used, so those
823 PL_body_roots[sv_type] are unused, and can be overloaded. In
824 something of a special case, SVt_NULL is borrowed for HE arenas;
825 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
826 bodies_by_type[SVt_NULL] slot is not used, as the table is not
831 struct body_details {
832 U8 body_size; /* Size to allocate */
833 U8 copy; /* Size of structure to copy (may be shorter) */
835 unsigned int type : 4; /* We have space for a sanity check. */
836 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
837 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
838 unsigned int arena : 1; /* Allocated from an arena */
839 size_t arena_size; /* Size of arena to allocate */
847 /* With -DPURFIY we allocate everything directly, and don't use arenas.
848 This seems a rather elegant way to simplify some of the code below. */
849 #define HASARENA FALSE
851 #define HASARENA TRUE
853 #define NOARENA FALSE
855 /* Size the arenas to exactly fit a given number of bodies. A count
856 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
857 simplifying the default. If count > 0, the arena is sized to fit
858 only that many bodies, allowing arenas to be used for large, rare
859 bodies (XPVFM, XPVIO) without undue waste. The arena size is
860 limited by PERL_ARENA_SIZE, so we can safely oversize the
863 #define FIT_ARENA0(body_size) \
864 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
865 #define FIT_ARENAn(count,body_size) \
866 ( count * body_size <= PERL_ARENA_SIZE) \
867 ? count * body_size \
868 : FIT_ARENA0 (body_size)
869 #define FIT_ARENA(count,body_size) \
871 ? FIT_ARENAn (count, body_size) \
872 : FIT_ARENA0 (body_size)
874 /* Calculate the length to copy. Specifically work out the length less any
875 final padding the compiler needed to add. See the comment in sv_upgrade
876 for why copying the padding proved to be a bug. */
878 #define copy_length(type, last_member) \
879 STRUCT_OFFSET(type, last_member) \
880 + sizeof (((type*)SvANY((const SV *)0))->last_member)
882 static const struct body_details bodies_by_type[] = {
883 /* HEs use this offset for their arena. */
884 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
886 /* The bind placeholder pretends to be an RV for now.
887 Also it's marked as "can't upgrade" to stop anyone using it before it's
889 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
891 /* IVs are in the head, so the allocation size is 0. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */, 0
898 { sizeof(NV), sizeof(NV),
899 STRUCT_OFFSET(XPVNV, xnv_u),
900 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
902 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
903 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
904 + STRUCT_OFFSET(XPV, xpv_cur),
905 SVt_PV, FALSE, NONV, HASARENA,
906 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
908 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
909 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
910 + STRUCT_OFFSET(XPV, xpv_cur),
911 SVt_PVIV, FALSE, NONV, HASARENA,
912 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
914 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
915 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
916 + STRUCT_OFFSET(XPV, xpv_cur),
917 SVt_PVNV, FALSE, HADNV, HASARENA,
918 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
920 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
921 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
926 SVt_REGEXP, FALSE, NONV, HASARENA,
927 FIT_ARENA(0, sizeof(regexp))
930 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
933 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
934 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
937 copy_length(XPVAV, xav_alloc),
939 SVt_PVAV, TRUE, NONV, HASARENA,
940 FIT_ARENA(0, sizeof(XPVAV)) },
943 copy_length(XPVHV, xhv_max),
945 SVt_PVHV, TRUE, NONV, HASARENA,
946 FIT_ARENA(0, sizeof(XPVHV)) },
951 SVt_PVCV, TRUE, NONV, HASARENA,
952 FIT_ARENA(0, sizeof(XPVCV)) },
957 SVt_PVFM, TRUE, NONV, NOARENA,
958 FIT_ARENA(20, sizeof(XPVFM)) },
963 SVt_PVIO, TRUE, NONV, HASARENA,
964 FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_allocated(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type) \
969 - bodies_by_type[sv_type].offset)
971 /* return a thing to the free list */
973 #define del_body(thing, root) \
975 void ** const thing_copy = (void **)thing; \
976 *thing_copy = *root; \
977 *root = (void*)thing_copy; \
982 #define new_XNV() safemalloc(sizeof(XPVNV))
983 #define new_XPVNV() safemalloc(sizeof(XPVNV))
984 #define new_XPVMG() safemalloc(sizeof(XPVMG))
986 #define del_XPVGV(p) safefree(p)
990 #define new_XNV() new_body_allocated(SVt_NV)
991 #define new_XPVNV() new_body_allocated(SVt_PVNV)
992 #define new_XPVMG() new_body_allocated(SVt_PVMG)
994 #define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
995 &PL_body_roots[SVt_PVGV])
999 /* no arena for you! */
1001 #define new_NOARENA(details) \
1002 safemalloc((details)->body_size + (details)->offset)
1003 #define new_NOARENAZ(details) \
1004 safecalloc((details)->body_size + (details)->offset, 1)
1007 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1008 const size_t arena_size)
1011 void ** const root = &PL_body_roots[sv_type];
1012 struct arena_desc *adesc;
1013 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1017 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1018 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1019 static bool done_sanity_check;
1021 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1022 * variables like done_sanity_check. */
1023 if (!done_sanity_check) {
1024 unsigned int i = SVt_LAST;
1026 done_sanity_check = TRUE;
1029 assert (bodies_by_type[i].type == i);
1035 /* may need new arena-set to hold new arena */
1036 if (!aroot || aroot->curr >= aroot->set_size) {
1037 struct arena_set *newroot;
1038 Newxz(newroot, 1, struct arena_set);
1039 newroot->set_size = ARENAS_PER_SET;
1040 newroot->next = aroot;
1042 PL_body_arenas = (void *) newroot;
1043 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1046 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1047 curr = aroot->curr++;
1048 adesc = &(aroot->set[curr]);
1049 assert(!adesc->arena);
1051 Newx(adesc->arena, good_arena_size, char);
1052 adesc->size = good_arena_size;
1053 adesc->utype = sv_type;
1054 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1055 curr, (void*)adesc->arena, (UV)good_arena_size));
1057 start = (char *) adesc->arena;
1059 /* Get the address of the byte after the end of the last body we can fit.
1060 Remember, this is integer division: */
1061 end = start + good_arena_size / body_size * body_size;
1063 /* computed count doesn't reflect the 1st slot reservation */
1064 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1065 DEBUG_m(PerlIO_printf(Perl_debug_log,
1066 "arena %p end %p arena-size %d (from %d) type %d "
1068 (void*)start, (void*)end, (int)good_arena_size,
1069 (int)arena_size, sv_type, (int)body_size,
1070 (int)good_arena_size / (int)body_size));
1072 DEBUG_m(PerlIO_printf(Perl_debug_log,
1073 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1074 (void*)start, (void*)end,
1075 (int)arena_size, sv_type, (int)body_size,
1076 (int)good_arena_size / (int)body_size));
1078 *root = (void *)start;
1081 /* Where the next body would start: */
1082 char * const next = start + body_size;
1085 /* This is the last body: */
1086 assert(next == end);
1088 *(void **)start = 0;
1092 *(void**) start = (void *)next;
1097 /* grab a new thing from the free list, allocating more if necessary.
1098 The inline version is used for speed in hot routines, and the
1099 function using it serves the rest (unless PURIFY).
1101 #define new_body_inline(xpv, sv_type) \
1103 void ** const r3wt = &PL_body_roots[sv_type]; \
1104 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1105 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1106 bodies_by_type[sv_type].body_size,\
1107 bodies_by_type[sv_type].arena_size)); \
1108 *(r3wt) = *(void**)(xpv); \
1114 S_new_body(pTHX_ const svtype sv_type)
1118 new_body_inline(xpv, sv_type);
1124 static const struct body_details fake_rv =
1125 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1128 =for apidoc sv_upgrade
1130 Upgrade an SV to a more complex form. Generally adds a new body type to the
1131 SV, then copies across as much information as possible from the old body.
1132 It croaks if the SV is already in a more complex form than requested. You
1133 generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
1134 before calling C<sv_upgrade>, and hence does not croak. See also
1141 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1146 const svtype old_type = SvTYPE(sv);
1147 const struct body_details *new_type_details;
1148 const struct body_details *old_type_details
1149 = bodies_by_type + old_type;
1150 SV *referant = NULL;
1152 PERL_ARGS_ASSERT_SV_UPGRADE;
1154 if (old_type == new_type)
1157 /* This clause was purposefully added ahead of the early return above to
1158 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1159 inference by Nick I-S that it would fix other troublesome cases. See
1160 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1162 Given that shared hash key scalars are no longer PVIV, but PV, there is
1163 no longer need to unshare so as to free up the IVX slot for its proper
1164 purpose. So it's safe to move the early return earlier. */
1166 if (new_type > SVt_PVMG && SvIsCOW(sv)) {
1167 sv_force_normal_flags(sv, 0);
1170 old_body = SvANY(sv);
1172 /* Copying structures onto other structures that have been neatly zeroed
1173 has a subtle gotcha. Consider XPVMG
1175 +------+------+------+------+------+-------+-------+
1176 | NV | CUR | LEN | IV | MAGIC | STASH |
1177 +------+------+------+------+------+-------+-------+
1178 0 4 8 12 16 20 24 28
1180 where NVs are aligned to 8 bytes, so that sizeof that structure is
1181 actually 32 bytes long, with 4 bytes of padding at the end:
1183 +------+------+------+------+------+-------+-------+------+
1184 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1185 +------+------+------+------+------+-------+-------+------+
1186 0 4 8 12 16 20 24 28 32
1188 so what happens if you allocate memory for this structure:
1190 +------+------+------+------+------+-------+-------+------+------+...
1191 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1192 +------+------+------+------+------+-------+-------+------+------+...
1193 0 4 8 12 16 20 24 28 32 36
1195 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1196 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1197 started out as zero once, but it's quite possible that it isn't. So now,
1198 rather than a nicely zeroed GP, you have it pointing somewhere random.
1201 (In fact, GP ends up pointing at a previous GP structure, because the
1202 principle cause of the padding in XPVMG getting garbage is a copy of
1203 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1204 this happens to be moot because XPVGV has been re-ordered, with GP
1205 no longer after STASH)
1207 So we are careful and work out the size of used parts of all the
1215 referant = SvRV(sv);
1216 old_type_details = &fake_rv;
1217 if (new_type == SVt_NV)
1218 new_type = SVt_PVNV;
1220 if (new_type < SVt_PVIV) {
1221 new_type = (new_type == SVt_NV)
1222 ? SVt_PVNV : SVt_PVIV;
1227 if (new_type < SVt_PVNV) {
1228 new_type = SVt_PVNV;
1232 assert(new_type > SVt_PV);
1233 assert(SVt_IV < SVt_PV);
1234 assert(SVt_NV < SVt_PV);
1241 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1242 there's no way that it can be safely upgraded, because perl.c
1243 expects to Safefree(SvANY(PL_mess_sv)) */
1244 assert(sv != PL_mess_sv);
1245 /* This flag bit is used to mean other things in other scalar types.
1246 Given that it only has meaning inside the pad, it shouldn't be set
1247 on anything that can get upgraded. */
1248 assert(!SvPAD_TYPED(sv));
1251 if (old_type_details->cant_upgrade)
1252 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1253 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1256 if (old_type > new_type)
1257 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1258 (int)old_type, (int)new_type);
1260 new_type_details = bodies_by_type + new_type;
1262 SvFLAGS(sv) &= ~SVTYPEMASK;
1263 SvFLAGS(sv) |= new_type;
1265 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1266 the return statements above will have triggered. */
1267 assert (new_type != SVt_NULL);
1270 assert(old_type == SVt_NULL);
1271 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1275 assert(old_type == SVt_NULL);
1276 SvANY(sv) = new_XNV();
1281 assert(new_type_details->body_size);
1284 assert(new_type_details->arena);
1285 assert(new_type_details->arena_size);
1286 /* This points to the start of the allocated area. */
1287 new_body_inline(new_body, new_type);
1288 Zero(new_body, new_type_details->body_size, char);
1289 new_body = ((char *)new_body) - new_type_details->offset;
1291 /* We always allocated the full length item with PURIFY. To do this
1292 we fake things so that arena is false for all 16 types.. */
1293 new_body = new_NOARENAZ(new_type_details);
1295 SvANY(sv) = new_body;
1296 if (new_type == SVt_PVAV) {
1300 if (old_type_details->body_size) {
1303 /* It will have been zeroed when the new body was allocated.
1304 Lets not write to it, in case it confuses a write-back
1310 #ifndef NODEFAULT_SHAREKEYS
1311 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1313 HvMAX(sv) = 7; /* (start with 8 buckets) */
1316 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1317 The target created by newSVrv also is, and it can have magic.
1318 However, it never has SvPVX set.
1320 if (old_type == SVt_IV) {
1322 } else if (old_type >= SVt_PV) {
1323 assert(SvPVX_const(sv) == 0);
1326 if (old_type >= SVt_PVMG) {
1327 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1328 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1330 sv->sv_u.svu_array = NULL; /* or svu_hash */
1335 /* XXX Is this still needed? Was it ever needed? Surely as there is
1336 no route from NV to PVIV, NOK can never be true */
1337 assert(!SvNOKp(sv));
1349 assert(new_type_details->body_size);
1350 /* We always allocated the full length item with PURIFY. To do this
1351 we fake things so that arena is false for all 16 types.. */
1352 if(new_type_details->arena) {
1353 /* This points to the start of the allocated area. */
1354 new_body_inline(new_body, new_type);
1355 Zero(new_body, new_type_details->body_size, char);
1356 new_body = ((char *)new_body) - new_type_details->offset;
1358 new_body = new_NOARENAZ(new_type_details);
1360 SvANY(sv) = new_body;
1362 if (old_type_details->copy) {
1363 /* There is now the potential for an upgrade from something without
1364 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1365 int offset = old_type_details->offset;
1366 int length = old_type_details->copy;
1368 if (new_type_details->offset > old_type_details->offset) {
1369 const int difference
1370 = new_type_details->offset - old_type_details->offset;
1371 offset += difference;
1372 length -= difference;
1374 assert (length >= 0);
1376 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1380 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1381 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1382 * correct 0.0 for us. Otherwise, if the old body didn't have an
1383 * NV slot, but the new one does, then we need to initialise the
1384 * freshly created NV slot with whatever the correct bit pattern is
1386 if (old_type_details->zero_nv && !new_type_details->zero_nv
1387 && !isGV_with_GP(sv))
1391 if (new_type == SVt_PVIO) {
1392 IO * const io = MUTABLE_IO(sv);
1393 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1396 /* Clear the stashcache because a new IO could overrule a package
1398 DEBUG_o(Perl_deb(aTHX_ "sv_upgrade clearing PL_stashcache\n"));
1399 hv_clear(PL_stashcache);
1401 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1402 IoPAGE_LEN(sv) = 60;
1404 if (new_type == SVt_REGEXP)
1405 sv->sv_u.svu_rx = (regexp *)new_body;
1406 else if (old_type < SVt_PV) {
1407 /* referant will be NULL unless the old type was SVt_IV emulating
1409 sv->sv_u.svu_rv = referant;
1413 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1414 (unsigned long)new_type);
1417 if (old_type > SVt_IV) {
1421 /* Note that there is an assumption that all bodies of types that
1422 can be upgraded came from arenas. Only the more complex non-
1423 upgradable types are allowed to be directly malloc()ed. */
1424 assert(old_type_details->arena);
1425 del_body((void*)((char*)old_body + old_type_details->offset),
1426 &PL_body_roots[old_type]);
1432 =for apidoc sv_backoff
1434 Remove any string offset. You should normally use the C<SvOOK_off> macro
1441 Perl_sv_backoff(pTHX_ register SV *const sv)
1444 const char * const s = SvPVX_const(sv);
1446 PERL_ARGS_ASSERT_SV_BACKOFF;
1447 PERL_UNUSED_CONTEXT;
1450 assert(SvTYPE(sv) != SVt_PVHV);
1451 assert(SvTYPE(sv) != SVt_PVAV);
1453 SvOOK_offset(sv, delta);
1455 SvLEN_set(sv, SvLEN(sv) + delta);
1456 SvPV_set(sv, SvPVX(sv) - delta);
1457 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1458 SvFLAGS(sv) &= ~SVf_OOK;
1465 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1466 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1467 Use the C<SvGROW> wrapper instead.
1473 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1477 PERL_ARGS_ASSERT_SV_GROW;
1479 if (PL_madskills && newlen >= 0x100000) {
1480 PerlIO_printf(Perl_debug_log,
1481 "Allocation too large: %"UVxf"\n", (UV)newlen);
1483 #ifdef HAS_64K_LIMIT
1484 if (newlen >= 0x10000) {
1485 PerlIO_printf(Perl_debug_log,
1486 "Allocation too large: %"UVxf"\n", (UV)newlen);
1489 #endif /* HAS_64K_LIMIT */
1492 if (SvTYPE(sv) < SVt_PV) {
1493 sv_upgrade(sv, SVt_PV);
1494 s = SvPVX_mutable(sv);
1496 else if (SvOOK(sv)) { /* pv is offset? */
1498 s = SvPVX_mutable(sv);
1499 if (newlen > SvLEN(sv))
1500 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1501 #ifdef HAS_64K_LIMIT
1502 if (newlen >= 0x10000)
1507 s = SvPVX_mutable(sv);
1509 if (newlen > SvLEN(sv)) { /* need more room? */
1510 STRLEN minlen = SvCUR(sv);
1511 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1512 if (newlen < minlen)
1514 #ifndef Perl_safesysmalloc_size
1515 newlen = PERL_STRLEN_ROUNDUP(newlen);
1517 if (SvLEN(sv) && s) {
1518 s = (char*)saferealloc(s, newlen);
1521 s = (char*)safemalloc(newlen);
1522 if (SvPVX_const(sv) && SvCUR(sv)) {
1523 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1527 #ifdef Perl_safesysmalloc_size
1528 /* Do this here, do it once, do it right, and then we will never get
1529 called back into sv_grow() unless there really is some growing
1531 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1533 SvLEN_set(sv, newlen);
1540 =for apidoc sv_setiv
1542 Copies an integer into the given SV, upgrading first if necessary.
1543 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1549 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1553 PERL_ARGS_ASSERT_SV_SETIV;
1555 SV_CHECK_THINKFIRST_COW_DROP(sv);
1556 switch (SvTYPE(sv)) {
1559 sv_upgrade(sv, SVt_IV);
1562 sv_upgrade(sv, SVt_PVIV);
1566 if (!isGV_with_GP(sv))
1573 /* diag_listed_as: Can't coerce %s to %s in %s */
1574 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1578 (void)SvIOK_only(sv); /* validate number */
1584 =for apidoc sv_setiv_mg
1586 Like C<sv_setiv>, but also handles 'set' magic.
1592 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1594 PERL_ARGS_ASSERT_SV_SETIV_MG;
1601 =for apidoc sv_setuv
1603 Copies an unsigned integer into the given SV, upgrading first if necessary.
1604 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1610 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1612 PERL_ARGS_ASSERT_SV_SETUV;
1614 /* With the if statement to ensure that integers are stored as IVs whenever
1616 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1619 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1621 If you wish to remove the following if statement, so that this routine
1622 (and its callers) always return UVs, please benchmark to see what the
1623 effect is. Modern CPUs may be different. Or may not :-)
1625 if (u <= (UV)IV_MAX) {
1626 sv_setiv(sv, (IV)u);
1635 =for apidoc sv_setuv_mg
1637 Like C<sv_setuv>, but also handles 'set' magic.
1643 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1645 PERL_ARGS_ASSERT_SV_SETUV_MG;
1652 =for apidoc sv_setnv
1654 Copies a double into the given SV, upgrading first if necessary.
1655 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1661 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1665 PERL_ARGS_ASSERT_SV_SETNV;
1667 SV_CHECK_THINKFIRST_COW_DROP(sv);
1668 switch (SvTYPE(sv)) {
1671 sv_upgrade(sv, SVt_NV);
1675 sv_upgrade(sv, SVt_PVNV);
1679 if (!isGV_with_GP(sv))
1686 /* diag_listed_as: Can't coerce %s to %s in %s */
1687 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1692 (void)SvNOK_only(sv); /* validate number */
1697 =for apidoc sv_setnv_mg
1699 Like C<sv_setnv>, but also handles 'set' magic.
1705 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1707 PERL_ARGS_ASSERT_SV_SETNV_MG;
1713 /* Print an "isn't numeric" warning, using a cleaned-up,
1714 * printable version of the offending string
1718 S_not_a_number(pTHX_ SV *const sv)
1725 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1728 dsv = newSVpvs_flags("", SVs_TEMP);
1729 pv = sv_uni_display(dsv, sv, 10, UNI_DISPLAY_ISPRINT);
1732 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1733 /* each *s can expand to 4 chars + "...\0",
1734 i.e. need room for 8 chars */
1736 const char *s = SvPVX_const(sv);
1737 const char * const end = s + SvCUR(sv);
1738 for ( ; s < end && d < limit; s++ ) {
1740 if (ch & 128 && !isPRINT_LC(ch)) {
1749 else if (ch == '\r') {
1753 else if (ch == '\f') {
1757 else if (ch == '\\') {
1761 else if (ch == '\0') {
1765 else if (isPRINT_LC(ch))
1782 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1783 /* diag_listed_as: Argument "%s" isn't numeric%s */
1784 "Argument \"%s\" isn't numeric in %s", pv,
1787 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1788 /* diag_listed_as: Argument "%s" isn't numeric%s */
1789 "Argument \"%s\" isn't numeric", pv);
1793 =for apidoc looks_like_number
1795 Test if the content of an SV looks like a number (or is a number).
1796 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1797 non-numeric warning), even if your atof() doesn't grok them. Get-magic is
1804 Perl_looks_like_number(pTHX_ SV *const sv)
1809 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1811 if (SvPOK(sv) || SvPOKp(sv)) {
1812 sbegin = SvPV_nomg_const(sv, len);
1815 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1816 return grok_number(sbegin, len, NULL);
1820 S_glob_2number(pTHX_ GV * const gv)
1822 PERL_ARGS_ASSERT_GLOB_2NUMBER;
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))
1828 SV *const buffer = sv_newmortal();
1829 gv_efullname3(buffer, gv, "*");
1830 not_a_number(buffer);
1832 /* We just want something true to return, so that S_sv_2iuv_common
1833 can tail call us and return true. */
1837 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1838 until proven guilty, assume that things are not that bad... */
1843 As 64 bit platforms often have an NV that doesn't preserve all bits of
1844 an IV (an assumption perl has been based on to date) it becomes necessary
1845 to remove the assumption that the NV always carries enough precision to
1846 recreate the IV whenever needed, and that the NV is the canonical form.
1847 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1848 precision as a side effect of conversion (which would lead to insanity
1849 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1850 1) to distinguish between IV/UV/NV slots that have cached a valid
1851 conversion where precision was lost and IV/UV/NV slots that have a
1852 valid conversion which has lost no precision
1853 2) to ensure that if a numeric conversion to one form is requested that
1854 would lose precision, the precise conversion (or differently
1855 imprecise conversion) is also performed and cached, to prevent
1856 requests for different numeric formats on the same SV causing
1857 lossy conversion chains. (lossless conversion chains are perfectly
1862 SvIOKp is true if the IV slot contains a valid value
1863 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1864 SvNOKp is true if the NV slot contains a valid value
1865 SvNOK is true only if the NV value is accurate
1868 while converting from PV to NV, check to see if converting that NV to an
1869 IV(or UV) would lose accuracy over a direct conversion from PV to
1870 IV(or UV). If it would, cache both conversions, return NV, but mark
1871 SV as IOK NOKp (ie not NOK).
1873 While converting from PV to IV, check to see if converting that IV to an
1874 NV would lose accuracy over a direct conversion from PV to NV. If it
1875 would, cache both conversions, flag similarly.
1877 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1878 correctly because if IV & NV were set NV *always* overruled.
1879 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1880 changes - now IV and NV together means that the two are interchangeable:
1881 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1883 The benefit of this is that operations such as pp_add know that if
1884 SvIOK is true for both left and right operands, then integer addition
1885 can be used instead of floating point (for cases where the result won't
1886 overflow). Before, floating point was always used, which could lead to
1887 loss of precision compared with integer addition.
1889 * making IV and NV equal status should make maths accurate on 64 bit
1891 * may speed up maths somewhat if pp_add and friends start to use
1892 integers when possible instead of fp. (Hopefully the overhead in
1893 looking for SvIOK and checking for overflow will not outweigh the
1894 fp to integer speedup)
1895 * will slow down integer operations (callers of SvIV) on "inaccurate"
1896 values, as the change from SvIOK to SvIOKp will cause a call into
1897 sv_2iv each time rather than a macro access direct to the IV slot
1898 * should speed up number->string conversion on integers as IV is
1899 favoured when IV and NV are equally accurate
1901 ####################################################################
1902 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1903 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1904 On the other hand, SvUOK is true iff UV.
1905 ####################################################################
1907 Your mileage will vary depending your CPU's relative fp to integer
1911 #ifndef NV_PRESERVES_UV
1912 # define IS_NUMBER_UNDERFLOW_IV 1
1913 # define IS_NUMBER_UNDERFLOW_UV 2
1914 # define IS_NUMBER_IV_AND_UV 2
1915 # define IS_NUMBER_OVERFLOW_IV 4
1916 # define IS_NUMBER_OVERFLOW_UV 5
1918 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1920 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1922 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1930 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1932 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));
1933 if (SvNVX(sv) < (NV)IV_MIN) {
1934 (void)SvIOKp_on(sv);
1936 SvIV_set(sv, IV_MIN);
1937 return IS_NUMBER_UNDERFLOW_IV;
1939 if (SvNVX(sv) > (NV)UV_MAX) {
1940 (void)SvIOKp_on(sv);
1943 SvUV_set(sv, UV_MAX);
1944 return IS_NUMBER_OVERFLOW_UV;
1946 (void)SvIOKp_on(sv);
1948 /* Can't use strtol etc to convert this string. (See truth table in
1950 if (SvNVX(sv) <= (UV)IV_MAX) {
1951 SvIV_set(sv, I_V(SvNVX(sv)));
1952 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1953 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1955 /* Integer is imprecise. NOK, IOKp */
1957 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1960 SvUV_set(sv, U_V(SvNVX(sv)));
1961 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1962 if (SvUVX(sv) == UV_MAX) {
1963 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1964 possibly be preserved by NV. Hence, it must be overflow.
1966 return IS_NUMBER_OVERFLOW_UV;
1968 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1970 /* Integer is imprecise. NOK, IOKp */
1972 return IS_NUMBER_OVERFLOW_IV;
1974 #endif /* !NV_PRESERVES_UV*/
1977 S_sv_2iuv_common(pTHX_ SV *const sv)
1981 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1984 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1985 * without also getting a cached IV/UV from it at the same time
1986 * (ie PV->NV conversion should detect loss of accuracy and cache
1987 * IV or UV at same time to avoid this. */
1988 /* IV-over-UV optimisation - choose to cache IV if possible */
1990 if (SvTYPE(sv) == SVt_NV)
1991 sv_upgrade(sv, SVt_PVNV);
1993 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1994 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1995 certainly cast into the IV range at IV_MAX, whereas the correct
1996 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1998 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1999 if (Perl_isnan(SvNVX(sv))) {
2005 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2006 SvIV_set(sv, I_V(SvNVX(sv)));
2007 if (SvNVX(sv) == (NV) SvIVX(sv)
2008 #ifndef NV_PRESERVES_UV
2009 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2010 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2011 /* Don't flag it as "accurately an integer" if the number
2012 came from a (by definition imprecise) NV operation, and
2013 we're outside the range of NV integer precision */
2017 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2019 /* scalar has trailing garbage, eg "42a" */
2021 DEBUG_c(PerlIO_printf(Perl_debug_log,
2022 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2028 /* IV not precise. No need to convert from PV, as NV
2029 conversion would already have cached IV if it detected
2030 that PV->IV would be better than PV->NV->IV
2031 flags already correct - don't set public IOK. */
2032 DEBUG_c(PerlIO_printf(Perl_debug_log,
2033 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2038 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2039 but the cast (NV)IV_MIN rounds to a the value less (more
2040 negative) than IV_MIN which happens to be equal to SvNVX ??
2041 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2042 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2043 (NV)UVX == NVX are both true, but the values differ. :-(
2044 Hopefully for 2s complement IV_MIN is something like
2045 0x8000000000000000 which will be exact. NWC */
2048 SvUV_set(sv, U_V(SvNVX(sv)));
2050 (SvNVX(sv) == (NV) SvUVX(sv))
2051 #ifndef NV_PRESERVES_UV
2052 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2053 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2054 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2055 /* Don't flag it as "accurately an integer" if the number
2056 came from a (by definition imprecise) NV operation, and
2057 we're outside the range of NV integer precision */
2063 DEBUG_c(PerlIO_printf(Perl_debug_log,
2064 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2070 else if (SvPOKp(sv)) {
2072 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2073 /* We want to avoid a possible problem when we cache an IV/ a UV which
2074 may be later translated to an NV, and the resulting NV is not
2075 the same as the direct translation of the initial string
2076 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2077 be careful to ensure that the value with the .456 is around if the
2078 NV value is requested in the future).
2080 This means that if we cache such an IV/a UV, we need to cache the
2081 NV as well. Moreover, we trade speed for space, and do not
2082 cache the NV if we are sure it's not needed.
2085 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2086 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2087 == IS_NUMBER_IN_UV) {
2088 /* It's definitely an integer, only upgrade to PVIV */
2089 if (SvTYPE(sv) < SVt_PVIV)
2090 sv_upgrade(sv, SVt_PVIV);
2092 } else if (SvTYPE(sv) < SVt_PVNV)
2093 sv_upgrade(sv, SVt_PVNV);
2095 /* If NVs preserve UVs then we only use the UV value if we know that
2096 we aren't going to call atof() below. If NVs don't preserve UVs
2097 then the value returned may have more precision than atof() will
2098 return, even though value isn't perfectly accurate. */
2099 if ((numtype & (IS_NUMBER_IN_UV
2100 #ifdef NV_PRESERVES_UV
2103 )) == IS_NUMBER_IN_UV) {
2104 /* This won't turn off the public IOK flag if it was set above */
2105 (void)SvIOKp_on(sv);
2107 if (!(numtype & IS_NUMBER_NEG)) {
2109 if (value <= (UV)IV_MAX) {
2110 SvIV_set(sv, (IV)value);
2112 /* it didn't overflow, and it was positive. */
2113 SvUV_set(sv, value);
2117 /* 2s complement assumption */
2118 if (value <= (UV)IV_MIN) {
2119 SvIV_set(sv, -(IV)value);
2121 /* Too negative for an IV. This is a double upgrade, but
2122 I'm assuming it will be rare. */
2123 if (SvTYPE(sv) < SVt_PVNV)
2124 sv_upgrade(sv, SVt_PVNV);
2128 SvNV_set(sv, -(NV)value);
2129 SvIV_set(sv, IV_MIN);
2133 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2134 will be in the previous block to set the IV slot, and the next
2135 block to set the NV slot. So no else here. */
2137 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2138 != IS_NUMBER_IN_UV) {
2139 /* It wasn't an (integer that doesn't overflow the UV). */
2140 SvNV_set(sv, Atof(SvPVX_const(sv)));
2142 if (! numtype && ckWARN(WARN_NUMERIC))
2145 #if defined(USE_LONG_DOUBLE)
2146 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2147 PTR2UV(sv), SvNVX(sv)));
2149 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2150 PTR2UV(sv), SvNVX(sv)));
2153 #ifdef NV_PRESERVES_UV
2154 (void)SvIOKp_on(sv);
2156 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2157 SvIV_set(sv, I_V(SvNVX(sv)));
2158 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2161 NOOP; /* Integer is imprecise. NOK, IOKp */
2163 /* UV will not work better than IV */
2165 if (SvNVX(sv) > (NV)UV_MAX) {
2167 /* Integer is inaccurate. NOK, IOKp, is UV */
2168 SvUV_set(sv, UV_MAX);
2170 SvUV_set(sv, U_V(SvNVX(sv)));
2171 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2172 NV preservse UV so can do correct comparison. */
2173 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2176 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2181 #else /* NV_PRESERVES_UV */
2182 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2183 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2184 /* The IV/UV slot will have been set from value returned by
2185 grok_number above. The NV slot has just been set using
2188 assert (SvIOKp(sv));
2190 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2191 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2192 /* Small enough to preserve all bits. */
2193 (void)SvIOKp_on(sv);
2195 SvIV_set(sv, I_V(SvNVX(sv)));
2196 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2198 /* Assumption: first non-preserved integer is < IV_MAX,
2199 this NV is in the preserved range, therefore: */
2200 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2202 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);
2206 0 0 already failed to read UV.
2207 0 1 already failed to read UV.
2208 1 0 you won't get here in this case. IV/UV
2209 slot set, public IOK, Atof() unneeded.
2210 1 1 already read UV.
2211 so there's no point in sv_2iuv_non_preserve() attempting
2212 to use atol, strtol, strtoul etc. */
2214 sv_2iuv_non_preserve (sv, numtype);
2216 sv_2iuv_non_preserve (sv);
2220 #endif /* NV_PRESERVES_UV */
2221 /* It might be more code efficient to go through the entire logic above
2222 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2223 gets complex and potentially buggy, so more programmer efficient
2224 to do it this way, by turning off the public flags: */
2226 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2230 if (isGV_with_GP(sv))
2231 return glob_2number(MUTABLE_GV(sv));
2233 if (!SvPADTMP(sv)) {
2234 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2237 if (SvTYPE(sv) < SVt_IV)
2238 /* Typically the caller expects that sv_any is not NULL now. */
2239 sv_upgrade(sv, SVt_IV);
2240 /* Return 0 from the caller. */
2247 =for apidoc sv_2iv_flags
2249 Return the integer value of an SV, doing any necessary string
2250 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2251 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2257 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2264 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2270 if (flags & SV_SKIP_OVERLOAD)
2272 tmpstr = AMG_CALLunary(sv, numer_amg);
2273 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2274 return SvIV(tmpstr);
2277 return PTR2IV(SvRV(sv));
2280 if (SvVALID(sv) || isREGEXP(sv)) {
2281 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2282 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2283 In practice they are extremely unlikely to actually get anywhere
2284 accessible by user Perl code - the only way that I'm aware of is when
2285 a constant subroutine which is used as the second argument to index.
2287 Regexps have no SvIVX and SvNVX fields.
2289 assert(isREGEXP(sv) || SvPOKp(sv));
2292 const char * const ptr =
2293 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2295 = grok_number(ptr, SvCUR(sv), &value);
2297 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2298 == IS_NUMBER_IN_UV) {
2299 /* It's definitely an integer */
2300 if (numtype & IS_NUMBER_NEG) {
2301 if (value < (UV)IV_MIN)
2304 if (value < (UV)IV_MAX)
2309 if (ckWARN(WARN_NUMERIC))
2312 return I_V(Atof(ptr));
2316 if (SvTHINKFIRST(sv)) {
2317 #ifdef PERL_OLD_COPY_ON_WRITE
2319 sv_force_normal_flags(sv, 0);
2322 if (SvREADONLY(sv) && !SvOK(sv)) {
2323 if (ckWARN(WARN_UNINITIALIZED))
2330 if (S_sv_2iuv_common(aTHX_ sv))
2334 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2335 PTR2UV(sv),SvIVX(sv)));
2336 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2340 =for apidoc sv_2uv_flags
2342 Return the unsigned integer value of an SV, doing any necessary string
2343 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2344 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2350 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2357 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2363 if (flags & SV_SKIP_OVERLOAD)
2365 tmpstr = AMG_CALLunary(sv, numer_amg);
2366 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2367 return SvUV(tmpstr);
2370 return PTR2UV(SvRV(sv));
2373 if (SvVALID(sv) || isREGEXP(sv)) {
2374 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2375 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2376 Regexps have no SvIVX and SvNVX fields. */
2377 assert(isREGEXP(sv) || SvPOKp(sv));
2380 const char * const ptr =
2381 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2383 = grok_number(ptr, SvCUR(sv), &value);
2385 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2386 == IS_NUMBER_IN_UV) {
2387 /* It's definitely an integer */
2388 if (!(numtype & IS_NUMBER_NEG))
2392 if (ckWARN(WARN_NUMERIC))
2395 return U_V(Atof(ptr));
2399 if (SvTHINKFIRST(sv)) {
2400 #ifdef PERL_OLD_COPY_ON_WRITE
2402 sv_force_normal_flags(sv, 0);
2405 if (SvREADONLY(sv) && !SvOK(sv)) {
2406 if (ckWARN(WARN_UNINITIALIZED))
2413 if (S_sv_2iuv_common(aTHX_ sv))
2417 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2418 PTR2UV(sv),SvUVX(sv)));
2419 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2423 =for apidoc sv_2nv_flags
2425 Return the num value of an SV, doing any necessary string or integer
2426 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2427 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2433 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2438 if (SvGMAGICAL(sv) || SvVALID(sv) || isREGEXP(sv)) {
2439 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2440 the same flag bit as SVf_IVisUV, so must not let them cache NVs.
2441 Regexps have no SvIVX and SvNVX fields. */
2443 if (flags & SV_GMAGIC)
2447 if (SvPOKp(sv) && !SvIOKp(sv)) {
2448 ptr = SvPVX_const(sv);
2450 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2451 !grok_number(ptr, SvCUR(sv), NULL))
2457 return (NV)SvUVX(sv);
2459 return (NV)SvIVX(sv);
2465 ptr = RX_WRAPPED((REGEXP *)sv);
2468 assert(SvTYPE(sv) >= SVt_PVMG);
2469 /* This falls through to the report_uninit near the end of the
2471 } else if (SvTHINKFIRST(sv)) {
2476 if (flags & SV_SKIP_OVERLOAD)
2478 tmpstr = AMG_CALLunary(sv, numer_amg);
2479 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2480 return SvNV(tmpstr);
2483 return PTR2NV(SvRV(sv));
2485 #ifdef PERL_OLD_COPY_ON_WRITE
2487 sv_force_normal_flags(sv, 0);
2490 if (SvREADONLY(sv) && !SvOK(sv)) {
2491 if (ckWARN(WARN_UNINITIALIZED))
2496 if (SvTYPE(sv) < SVt_NV) {
2497 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2498 sv_upgrade(sv, SVt_NV);
2499 #ifdef USE_LONG_DOUBLE
2501 STORE_NUMERIC_LOCAL_SET_STANDARD();
2502 PerlIO_printf(Perl_debug_log,
2503 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2504 PTR2UV(sv), SvNVX(sv));
2505 RESTORE_NUMERIC_LOCAL();
2509 STORE_NUMERIC_LOCAL_SET_STANDARD();
2510 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2511 PTR2UV(sv), SvNVX(sv));
2512 RESTORE_NUMERIC_LOCAL();
2516 else if (SvTYPE(sv) < SVt_PVNV)
2517 sv_upgrade(sv, SVt_PVNV);
2522 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2523 #ifdef NV_PRESERVES_UV
2529 /* Only set the public NV OK flag if this NV preserves the IV */
2530 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2532 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2533 : (SvIVX(sv) == I_V(SvNVX(sv))))
2539 else if (SvPOKp(sv)) {
2541 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2542 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2544 #ifdef NV_PRESERVES_UV
2545 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2546 == IS_NUMBER_IN_UV) {
2547 /* It's definitely an integer */
2548 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2550 SvNV_set(sv, Atof(SvPVX_const(sv)));
2556 SvNV_set(sv, Atof(SvPVX_const(sv)));
2557 /* Only set the public NV OK flag if this NV preserves the value in
2558 the PV at least as well as an IV/UV would.
2559 Not sure how to do this 100% reliably. */
2560 /* if that shift count is out of range then Configure's test is
2561 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2563 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2564 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2565 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2566 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2567 /* Can't use strtol etc to convert this string, so don't try.
2568 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2571 /* value has been set. It may not be precise. */
2572 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2573 /* 2s complement assumption for (UV)IV_MIN */
2574 SvNOK_on(sv); /* Integer is too negative. */
2579 if (numtype & IS_NUMBER_NEG) {
2580 SvIV_set(sv, -(IV)value);
2581 } else if (value <= (UV)IV_MAX) {
2582 SvIV_set(sv, (IV)value);
2584 SvUV_set(sv, value);
2588 if (numtype & IS_NUMBER_NOT_INT) {
2589 /* I believe that even if the original PV had decimals,
2590 they are lost beyond the limit of the FP precision.
2591 However, neither is canonical, so both only get p
2592 flags. NWC, 2000/11/25 */
2593 /* Both already have p flags, so do nothing */
2595 const NV nv = SvNVX(sv);
2596 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2597 if (SvIVX(sv) == I_V(nv)) {
2600 /* It had no "." so it must be integer. */
2604 /* between IV_MAX and NV(UV_MAX).
2605 Could be slightly > UV_MAX */
2607 if (numtype & IS_NUMBER_NOT_INT) {
2608 /* UV and NV both imprecise. */
2610 const UV nv_as_uv = U_V(nv);
2612 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2621 /* It might be more code efficient to go through the entire logic above
2622 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2623 gets complex and potentially buggy, so more programmer efficient
2624 to do it this way, by turning off the public flags: */
2626 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2627 #endif /* NV_PRESERVES_UV */
2630 if (isGV_with_GP(sv)) {
2631 glob_2number(MUTABLE_GV(sv));
2635 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2637 assert (SvTYPE(sv) >= SVt_NV);
2638 /* Typically the caller expects that sv_any is not NULL now. */
2639 /* XXX Ilya implies that this is a bug in callers that assume this
2640 and ideally should be fixed. */
2643 #if defined(USE_LONG_DOUBLE)
2645 STORE_NUMERIC_LOCAL_SET_STANDARD();
2646 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2647 PTR2UV(sv), SvNVX(sv));
2648 RESTORE_NUMERIC_LOCAL();
2652 STORE_NUMERIC_LOCAL_SET_STANDARD();
2653 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2654 PTR2UV(sv), SvNVX(sv));
2655 RESTORE_NUMERIC_LOCAL();
2664 Return an SV with the numeric value of the source SV, doing any necessary
2665 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2666 access this function.
2672 Perl_sv_2num(pTHX_ register SV *const sv)
2674 PERL_ARGS_ASSERT_SV_2NUM;
2679 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2680 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2681 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2682 return sv_2num(tmpsv);
2684 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2687 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2688 * UV as a string towards the end of buf, and return pointers to start and
2691 * We assume that buf is at least TYPE_CHARS(UV) long.
2695 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2697 char *ptr = buf + TYPE_CHARS(UV);
2698 char * const ebuf = ptr;
2701 PERL_ARGS_ASSERT_UIV_2BUF;
2713 *--ptr = '0' + (char)(uv % 10);
2722 =for apidoc sv_2pv_flags
2724 Returns a pointer to the string value of an SV, and sets *lp to its length.
2725 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2726 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2727 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2733 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2743 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2748 if (flags & SV_SKIP_OVERLOAD)
2750 tmpstr = AMG_CALLunary(sv, string_amg);
2751 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2752 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2754 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2758 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2759 if (flags & SV_CONST_RETURN) {
2760 pv = (char *) SvPVX_const(tmpstr);
2762 pv = (flags & SV_MUTABLE_RETURN)
2763 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2766 *lp = SvCUR(tmpstr);
2768 pv = sv_2pv_flags(tmpstr, lp, flags);
2781 SV *const referent = SvRV(sv);
2785 retval = buffer = savepvn("NULLREF", len);
2786 } else if (SvTYPE(referent) == SVt_REGEXP &&
2787 (!(PL_curcop->cop_hints & HINT_NO_AMAGIC) ||
2788 amagic_is_enabled(string_amg))) {
2789 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2793 /* If the regex is UTF-8 we want the containing scalar to
2794 have an UTF-8 flag too */
2801 *lp = RX_WRAPLEN(re);
2803 return RX_WRAPPED(re);
2805 const char *const typestr = sv_reftype(referent, 0);
2806 const STRLEN typelen = strlen(typestr);
2807 UV addr = PTR2UV(referent);
2808 const char *stashname = NULL;
2809 STRLEN stashnamelen = 0; /* hush, gcc */
2810 const char *buffer_end;
2812 if (SvOBJECT(referent)) {
2813 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2816 stashname = HEK_KEY(name);
2817 stashnamelen = HEK_LEN(name);
2819 if (HEK_UTF8(name)) {
2825 stashname = "__ANON__";
2828 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2829 + 2 * sizeof(UV) + 2 /* )\0 */;
2831 len = typelen + 3 /* (0x */
2832 + 2 * sizeof(UV) + 2 /* )\0 */;
2835 Newx(buffer, len, char);
2836 buffer_end = retval = buffer + len;
2838 /* Working backwards */
2842 *--retval = PL_hexdigit[addr & 15];
2843 } while (addr >>= 4);
2849 memcpy(retval, typestr, typelen);
2853 retval -= stashnamelen;
2854 memcpy(retval, stashname, stashnamelen);
2856 /* retval may not necessarily have reached the start of the
2858 assert (retval >= buffer);
2860 len = buffer_end - retval - 1; /* -1 for that \0 */
2872 if (flags & SV_MUTABLE_RETURN)
2873 return SvPVX_mutable(sv);
2874 if (flags & SV_CONST_RETURN)
2875 return (char *)SvPVX_const(sv);
2880 /* I'm assuming that if both IV and NV are equally valid then
2881 converting the IV is going to be more efficient */
2882 const U32 isUIOK = SvIsUV(sv);
2883 char buf[TYPE_CHARS(UV)];
2887 if (SvTYPE(sv) < SVt_PVIV)
2888 sv_upgrade(sv, SVt_PVIV);
2889 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2891 /* inlined from sv_setpvn */
2892 s = SvGROW_mutable(sv, len + 1);
2893 Move(ptr, s, len, char);
2897 else if (SvNOK(sv)) {
2898 if (SvTYPE(sv) < SVt_PVNV)
2899 sv_upgrade(sv, SVt_PVNV);
2900 if (SvNVX(sv) == 0.0) {
2901 s = SvGROW_mutable(sv, 2);
2906 /* The +20 is pure guesswork. Configure test needed. --jhi */
2907 s = SvGROW_mutable(sv, NV_DIG + 20);
2908 /* some Xenix systems wipe out errno here */
2909 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2918 else if (isGV_with_GP(sv)) {
2919 GV *const gv = MUTABLE_GV(sv);
2920 SV *const buffer = sv_newmortal();
2922 gv_efullname3(buffer, gv, "*");
2924 assert(SvPOK(buffer));
2928 *lp = SvCUR(buffer);
2929 return SvPVX(buffer);
2931 else if (isREGEXP(sv)) {
2932 if (lp) *lp = RX_WRAPLEN((REGEXP *)sv);
2933 return RX_WRAPPED((REGEXP *)sv);
2938 if (flags & SV_UNDEF_RETURNS_NULL)
2940 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2942 /* Typically the caller expects that sv_any is not NULL now. */
2943 if (!SvREADONLY(sv) && SvTYPE(sv) < SVt_PV)
2944 sv_upgrade(sv, SVt_PV);
2949 const STRLEN len = s - SvPVX_const(sv);
2955 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2956 PTR2UV(sv),SvPVX_const(sv)));
2957 if (flags & SV_CONST_RETURN)
2958 return (char *)SvPVX_const(sv);
2959 if (flags & SV_MUTABLE_RETURN)
2960 return SvPVX_mutable(sv);
2965 =for apidoc sv_copypv
2967 Copies a stringified representation of the source SV into the
2968 destination SV. Automatically performs any necessary mg_get and
2969 coercion of numeric values into strings. Guaranteed to preserve
2970 UTF8 flag even from overloaded objects. Similar in nature to
2971 sv_2pv[_flags] but operates directly on an SV instead of just the
2972 string. Mostly uses sv_2pv_flags to do its work, except when that
2973 would lose the UTF-8'ness of the PV.
2975 =for apidoc sv_copypv_nomg
2977 Like sv_copypv, but doesn't invoke get magic first.
2979 =for apidoc sv_copypv_flags
2981 Implementation of sv_copypv and sv_copypv_nomg. Calls get magic iff flags
2988 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2990 PERL_ARGS_ASSERT_SV_COPYPV;
2992 sv_copypv_flags(dsv, ssv, 0);
2996 Perl_sv_copypv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
3001 PERL_ARGS_ASSERT_SV_COPYPV_FLAGS;
3003 if ((flags & SV_GMAGIC) && SvGMAGICAL(ssv))
3005 s = SvPV_nomg_const(ssv,len);
3006 sv_setpvn(dsv,s,len);
3014 =for apidoc sv_2pvbyte
3016 Return a pointer to the byte-encoded representation of the SV, and set *lp
3017 to its length. May cause the SV to be downgraded from UTF-8 as a
3020 Usually accessed via the C<SvPVbyte> macro.
3026 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *const lp)
3028 PERL_ARGS_ASSERT_SV_2PVBYTE;
3030 if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3031 || isGV_with_GP(sv) || SvROK(sv)) {
3032 SV *sv2 = sv_newmortal();
3036 else SvGETMAGIC(sv);
3037 sv_utf8_downgrade(sv,0);
3038 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3042 =for apidoc sv_2pvutf8
3044 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3045 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3047 Usually accessed via the C<SvPVutf8> macro.
3053 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *const lp)
3055 PERL_ARGS_ASSERT_SV_2PVUTF8;
3057 if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3058 || isGV_with_GP(sv) || SvROK(sv))
3059 sv = sv_mortalcopy(sv);
3062 sv_utf8_upgrade_nomg(sv);
3063 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3068 =for apidoc sv_2bool
3070 This macro is only used by sv_true() or its macro equivalent, and only if
3071 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3072 It calls sv_2bool_flags with the SV_GMAGIC flag.
3074 =for apidoc sv_2bool_flags
3076 This function is only used by sv_true() and friends, and only if
3077 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3078 contain SV_GMAGIC, then it does an mg_get() first.
3085 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3089 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3091 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3097 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3098 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3099 return cBOOL(SvTRUE(tmpsv));
3101 return SvRV(sv) != 0;
3103 return SvTRUE_common(sv, isGV_with_GP(sv) ? 1 : 0);
3107 =for apidoc sv_utf8_upgrade
3109 Converts the PV of an SV to its UTF-8-encoded form.
3110 Forces the SV to string form if it is not already.
3111 Will C<mg_get> on C<sv> if appropriate.
3112 Always sets the SvUTF8 flag to avoid future validity checks even
3113 if the whole string is the same in UTF-8 as not.
3114 Returns the number of bytes in the converted string
3116 This is not a general purpose byte encoding to Unicode interface:
3117 use the Encode extension for that.
3119 =for apidoc sv_utf8_upgrade_nomg
3121 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3123 =for apidoc sv_utf8_upgrade_flags
3125 Converts the PV of an SV to its UTF-8-encoded form.
3126 Forces the SV to string form if it is not already.
3127 Always sets the SvUTF8 flag to avoid future validity checks even
3128 if all the bytes are invariant in UTF-8.
3129 If C<flags> has C<SV_GMAGIC> bit set,
3130 will C<mg_get> on C<sv> if appropriate, else not.
3131 Returns the number of bytes in the converted string
3132 C<sv_utf8_upgrade> and
3133 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3135 This is not a general purpose byte encoding to Unicode interface:
3136 use the Encode extension for that.
3140 The grow version is currently not externally documented. It adds a parameter,
3141 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3142 have free after it upon return. This allows the caller to reserve extra space
3143 that it intends to fill, to avoid extra grows.
3145 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3146 which can be used to tell this function to not first check to see if there are
3147 any characters that are different in UTF-8 (variant characters) which would
3148 force it to allocate a new string to sv, but to assume there are. Typically
3149 this flag is used by a routine that has already parsed the string to find that
3150 there are such characters, and passes this information on so that the work
3151 doesn't have to be repeated.
3153 (One might think that the calling routine could pass in the position of the
3154 first such variant, so it wouldn't have to be found again. But that is not the
3155 case, because typically when the caller is likely to use this flag, it won't be
3156 calling this routine unless it finds something that won't fit into a byte.
3157 Otherwise it tries to not upgrade and just use bytes. But some things that
3158 do fit into a byte are variants in utf8, and the caller may not have been
3159 keeping track of these.)
3161 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3162 isn't guaranteed due to having other routines do the work in some input cases,
3163 or if the input is already flagged as being in utf8.
3165 The speed of this could perhaps be improved for many cases if someone wanted to
3166 write a fast function that counts the number of variant characters in a string,
3167 especially if it could return the position of the first one.
3172 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3176 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3178 if (sv == &PL_sv_undef)
3180 if (!SvPOK_nog(sv)) {
3182 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3183 (void) sv_2pv_flags(sv,&len, flags);
3185 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3189 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3194 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3199 sv_force_normal_flags(sv, 0);
3202 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3203 sv_recode_to_utf8(sv, PL_encoding);
3204 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3208 if (SvCUR(sv) == 0) {
3209 if (extra) SvGROW(sv, extra);
3210 } else { /* Assume Latin-1/EBCDIC */
3211 /* This function could be much more efficient if we
3212 * had a FLAG in SVs to signal if there are any variant
3213 * chars in the PV. Given that there isn't such a flag
3214 * make the loop as fast as possible (although there are certainly ways
3215 * to speed this up, eg. through vectorization) */
3216 U8 * s = (U8 *) SvPVX_const(sv);
3217 U8 * e = (U8 *) SvEND(sv);
3219 STRLEN two_byte_count = 0;
3221 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3223 /* See if really will need to convert to utf8. We mustn't rely on our
3224 * incoming SV being well formed and having a trailing '\0', as certain
3225 * code in pp_formline can send us partially built SVs. */
3229 if (NATIVE_IS_INVARIANT(ch)) continue;
3231 t--; /* t already incremented; re-point to first variant */
3236 /* utf8 conversion not needed because all are invariants. Mark as
3237 * UTF-8 even if no variant - saves scanning loop */
3239 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3244 /* Here, the string should be converted to utf8, either because of an
3245 * input flag (two_byte_count = 0), or because a character that
3246 * requires 2 bytes was found (two_byte_count = 1). t points either to
3247 * the beginning of the string (if we didn't examine anything), or to
3248 * the first variant. In either case, everything from s to t - 1 will
3249 * occupy only 1 byte each on output.
3251 * There are two main ways to convert. One is to create a new string
3252 * and go through the input starting from the beginning, appending each
3253 * converted value onto the new string as we go along. It's probably
3254 * best to allocate enough space in the string for the worst possible
3255 * case rather than possibly running out of space and having to
3256 * reallocate and then copy what we've done so far. Since everything
3257 * from s to t - 1 is invariant, the destination can be initialized
3258 * with these using a fast memory copy
3260 * The other way is to figure out exactly how big the string should be
3261 * by parsing the entire input. Then you don't have to make it big
3262 * enough to handle the worst possible case, and more importantly, if
3263 * the string you already have is large enough, you don't have to
3264 * allocate a new string, you can copy the last character in the input
3265 * string to the final position(s) that will be occupied by the
3266 * converted string and go backwards, stopping at t, since everything
3267 * before that is invariant.
3269 * There are advantages and disadvantages to each method.
3271 * In the first method, we can allocate a new string, do the memory
3272 * copy from the s to t - 1, and then proceed through the rest of the
3273 * string byte-by-byte.
3275 * In the second method, we proceed through the rest of the input
3276 * string just calculating how big the converted string will be. Then
3277 * there are two cases:
3278 * 1) if the string has enough extra space to handle the converted
3279 * value. We go backwards through the string, converting until we
3280 * get to the position we are at now, and then stop. If this
3281 * position is far enough along in the string, this method is
3282 * faster than the other method. If the memory copy were the same
3283 * speed as the byte-by-byte loop, that position would be about
3284 * half-way, as at the half-way mark, parsing to the end and back
3285 * is one complete string's parse, the same amount as starting
3286 * over and going all the way through. Actually, it would be
3287 * somewhat less than half-way, as it's faster to just count bytes
3288 * than to also copy, and we don't have the overhead of allocating
3289 * a new string, changing the scalar to use it, and freeing the
3290 * existing one. But if the memory copy is fast, the break-even
3291 * point is somewhere after half way. The counting loop could be
3292 * sped up by vectorization, etc, to move the break-even point
3293 * further towards the beginning.
3294 * 2) if the string doesn't have enough space to handle the converted
3295 * value. A new string will have to be allocated, and one might
3296 * as well, given that, start from the beginning doing the first
3297 * method. We've spent extra time parsing the string and in
3298 * exchange all we've gotten is that we know precisely how big to
3299 * make the new one. Perl is more optimized for time than space,
3300 * so this case is a loser.
3301 * So what I've decided to do is not use the 2nd method unless it is
3302 * guaranteed that a new string won't have to be allocated, assuming
3303 * the worst case. I also decided not to put any more conditions on it
3304 * than this, for now. It seems likely that, since the worst case is
3305 * twice as big as the unknown portion of the string (plus 1), we won't
3306 * be guaranteed enough space, causing us to go to the first method,
3307 * unless the string is short, or the first variant character is near
3308 * the end of it. In either of these cases, it seems best to use the
3309 * 2nd method. The only circumstance I can think of where this would
3310 * be really slower is if the string had once had much more data in it
3311 * than it does now, but there is still a substantial amount in it */
3314 STRLEN invariant_head = t - s;
3315 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3316 if (SvLEN(sv) < size) {
3318 /* Here, have decided to allocate a new string */
3323 Newx(dst, size, U8);
3325 /* If no known invariants at the beginning of the input string,
3326 * set so starts from there. Otherwise, can use memory copy to
3327 * get up to where we are now, and then start from here */
3329 if (invariant_head <= 0) {
3332 Copy(s, dst, invariant_head, char);
3333 d = dst + invariant_head;
3337 const UV uv = NATIVE8_TO_UNI(*t++);
3338 if (UNI_IS_INVARIANT(uv))
3339 *d++ = (U8)UNI_TO_NATIVE(uv);
3341 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3342 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3346 SvPV_free(sv); /* No longer using pre-existing string */
3347 SvPV_set(sv, (char*)dst);
3348 SvCUR_set(sv, d - dst);
3349 SvLEN_set(sv, size);
3352 /* Here, have decided to get the exact size of the string.
3353 * Currently this happens only when we know that there is
3354 * guaranteed enough space to fit the converted string, so
3355 * don't have to worry about growing. If two_byte_count is 0,
3356 * then t points to the first byte of the string which hasn't
3357 * been examined yet. Otherwise two_byte_count is 1, and t
3358 * points to the first byte in the string that will expand to
3359 * two. Depending on this, start examining at t or 1 after t.
3362 U8 *d = t + two_byte_count;
3365 /* Count up the remaining bytes that expand to two */
3368 const U8 chr = *d++;
3369 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3372 /* The string will expand by just the number of bytes that
3373 * occupy two positions. But we are one afterwards because of
3374 * the increment just above. This is the place to put the
3375 * trailing NUL, and to set the length before we decrement */
3377 d += two_byte_count;
3378 SvCUR_set(sv, d - s);
3382 /* Having decremented d, it points to the position to put the
3383 * very last byte of the expanded string. Go backwards through
3384 * the string, copying and expanding as we go, stopping when we
3385 * get to the part that is invariant the rest of the way down */
3389 const U8 ch = NATIVE8_TO_UNI(*e--);
3390 if (UNI_IS_INVARIANT(ch)) {
3391 *d-- = UNI_TO_NATIVE(ch);
3393 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3394 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3399 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3400 /* Update pos. We do it at the end rather than during
3401 * the upgrade, to avoid slowing down the common case
3402 * (upgrade without pos) */
3403 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3405 I32 pos = mg->mg_len;
3406 if (pos > 0 && (U32)pos > invariant_head) {
3407 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3408 STRLEN n = (U32)pos - invariant_head;
3410 if (UTF8_IS_START(*d))
3415 mg->mg_len = d - (U8*)SvPVX(sv);
3418 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3419 magic_setutf8(sv,mg); /* clear UTF8 cache */
3424 /* Mark as UTF-8 even if no variant - saves scanning loop */
3430 =for apidoc sv_utf8_downgrade
3432 Attempts to convert the PV of an SV from characters to bytes.
3433 If the PV contains a character that cannot fit
3434 in a byte, this conversion will fail;
3435 in this case, either returns false or, if C<fail_ok> is not
3438 This is not a general purpose Unicode to byte encoding interface:
3439 use the Encode extension for that.
3445 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3449 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3451 if (SvPOKp(sv) && SvUTF8(sv)) {
3455 int mg_flags = SV_GMAGIC;
3458 sv_force_normal_flags(sv, 0);
3460 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3462 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3464 I32 pos = mg->mg_len;
3466 sv_pos_b2u(sv, &pos);
3467 mg_flags = 0; /* sv_pos_b2u does get magic */
3471 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3472 magic_setutf8(sv,mg); /* clear UTF8 cache */
3475 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3477 if (!utf8_to_bytes(s, &len)) {
3482 Perl_croak(aTHX_ "Wide character in %s",
3485 Perl_croak(aTHX_ "Wide character");
3496 =for apidoc sv_utf8_encode
3498 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3499 flag off so that it looks like octets again.
3505 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3507 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3509 if (SvREADONLY(sv)) {
3510 sv_force_normal_flags(sv, 0);
3512 (void) sv_utf8_upgrade(sv);
3517 =for apidoc sv_utf8_decode
3519 If the PV of the SV is an octet sequence in UTF-8
3520 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3521 so that it looks like a character. If the PV contains only single-byte
3522 characters, the C<SvUTF8> flag stays off.
3523 Scans PV for validity and returns false if the PV is invalid UTF-8.
3529 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3531 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3534 const U8 *start, *c;
3537 /* The octets may have got themselves encoded - get them back as
3540 if (!sv_utf8_downgrade(sv, TRUE))
3543 /* it is actually just a matter of turning the utf8 flag on, but
3544 * we want to make sure everything inside is valid utf8 first.
3546 c = start = (const U8 *) SvPVX_const(sv);
3547 if (!is_utf8_string(c, SvCUR(sv)))
3549 e = (const U8 *) SvEND(sv);
3552 if (!UTF8_IS_INVARIANT(ch)) {
3557 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3558 /* adjust pos to the start of a UTF8 char sequence */
3559 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3561 I32 pos = mg->mg_len;
3563 for (c = start + pos; c > start; c--) {
3564 if (UTF8_IS_START(*c))
3567 mg->mg_len = c - start;
3570 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3571 magic_setutf8(sv,mg); /* clear UTF8 cache */
3578 =for apidoc sv_setsv
3580 Copies the contents of the source SV C<ssv> into the destination SV
3581 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3582 function if the source SV needs to be reused. Does not handle 'set' magic.
3583 Loosely speaking, it performs a copy-by-value, obliterating any previous
3584 content of the destination.
3586 You probably want to use one of the assortment of wrappers, such as
3587 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3588 C<SvSetMagicSV_nosteal>.
3590 =for apidoc sv_setsv_flags
3592 Copies the contents of the source SV C<ssv> into the destination SV
3593 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3594 function if the source SV needs to be reused. Does not handle 'set' magic.
3595 Loosely speaking, it performs a copy-by-value, obliterating any previous
3596 content of the destination.
3597 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3598 C<ssv> if appropriate, else not. If the C<flags>
3599 parameter has the C<NOSTEAL> bit set then the
3600 buffers of temps will not be stolen. <sv_setsv>
3601 and C<sv_setsv_nomg> are implemented in terms of this function.
3603 You probably want to use one of the assortment of wrappers, such as
3604 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3605 C<SvSetMagicSV_nosteal>.
3607 This is the primary function for copying scalars, and most other
3608 copy-ish functions and macros use this underneath.
3614 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3616 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3617 HV *old_stash = NULL;
3619 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3621 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3622 const char * const name = GvNAME(sstr);
3623 const STRLEN len = GvNAMELEN(sstr);
3625 if (dtype >= SVt_PV) {
3631 SvUPGRADE(dstr, SVt_PVGV);
3632 (void)SvOK_off(dstr);
3633 /* We have to turn this on here, even though we turn it off
3634 below, as GvSTASH will fail an assertion otherwise. */
3635 isGV_with_GP_on(dstr);
3637 GvSTASH(dstr) = GvSTASH(sstr);
3639 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3640 gv_name_set(MUTABLE_GV(dstr), name, len,
3641 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3642 SvFAKE_on(dstr); /* can coerce to non-glob */
3645 if(GvGP(MUTABLE_GV(sstr))) {
3646 /* If source has method cache entry, clear it */
3648 SvREFCNT_dec(GvCV(sstr));
3649 GvCV_set(sstr, NULL);
3652 /* If source has a real method, then a method is
3655 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3661 /* If dest already had a real method, that's a change as well */
3663 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3664 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3669 /* We don't need to check the name of the destination if it was not a
3670 glob to begin with. */
3671 if(dtype == SVt_PVGV) {
3672 const char * const name = GvNAME((const GV *)dstr);
3675 /* The stash may have been detached from the symbol table, so
3677 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3681 const STRLEN len = GvNAMELEN(dstr);
3682 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3683 || (len == 1 && name[0] == ':')) {
3686 /* Set aside the old stash, so we can reset isa caches on
3688 if((old_stash = GvHV(dstr)))
3689 /* Make sure we do not lose it early. */
3690 SvREFCNT_inc_simple_void_NN(
3691 sv_2mortal((SV *)old_stash)
3697 gp_free(MUTABLE_GV(dstr));
3698 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3699 (void)SvOK_off(dstr);
3700 isGV_with_GP_on(dstr);
3701 GvINTRO_off(dstr); /* one-shot flag */
3702 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3703 if (SvTAINTED(sstr))
3705 if (GvIMPORTED(dstr) != GVf_IMPORTED
3706 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3708 GvIMPORTED_on(dstr);
3711 if(mro_changes == 2) {
3712 if (GvAV((const GV *)sstr)) {
3714 SV * const sref = (SV *)GvAV((const GV *)dstr);
3715 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3716 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3717 AV * const ary = newAV();
3718 av_push(ary, mg->mg_obj); /* takes the refcount */
3719 mg->mg_obj = (SV *)ary;
3721 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3723 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3725 mro_isa_changed_in(GvSTASH(dstr));
3727 else if(mro_changes == 3) {
3728 HV * const stash = GvHV(dstr);
3729 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3735 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3740 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3742 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3744 const int intro = GvINTRO(dstr);
3747 const U32 stype = SvTYPE(sref);
3749 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3752 GvINTRO_off(dstr); /* one-shot flag */
3753 GvLINE(dstr) = CopLINE(PL_curcop);
3754 GvEGV(dstr) = MUTABLE_GV(dstr);
3759 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3760 import_flag = GVf_IMPORTED_CV;
3763 location = (SV **) &GvHV(dstr);
3764 import_flag = GVf_IMPORTED_HV;
3767 location = (SV **) &GvAV(dstr);
3768 import_flag = GVf_IMPORTED_AV;
3771 location = (SV **) &GvIOp(dstr);
3774 location = (SV **) &GvFORM(dstr);
3777 location = &GvSV(dstr);
3778 import_flag = GVf_IMPORTED_SV;
3781 if (stype == SVt_PVCV) {
3782 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3783 if (GvCVGEN(dstr)) {
3784 SvREFCNT_dec(GvCV(dstr));
3785 GvCV_set(dstr, NULL);
3786 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3789 SAVEGENERICSV(*location);
3793 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3794 CV* const cv = MUTABLE_CV(*location);
3796 if (!GvCVGEN((const GV *)dstr) &&
3797 (CvROOT(cv) || CvXSUB(cv)) &&
3798 /* redundant check that avoids creating the extra SV
3799 most of the time: */
3800 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3802 SV * const new_const_sv =
3803 CvCONST((const CV *)sref)
3804 ? cv_const_sv((const CV *)sref)
3806 report_redefined_cv(
3807 sv_2mortal(Perl_newSVpvf(aTHX_
3810 HvNAME_HEK(GvSTASH((const GV *)dstr))
3812 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3815 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3819 cv_ckproto_len_flags(cv, (const GV *)dstr,
3820 SvPOK(sref) ? CvPROTO(sref) : NULL,
3821 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3822 SvPOK(sref) ? SvUTF8(sref) : 0);
3824 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3825 GvASSUMECV_on(dstr);
3826 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3829 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3830 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3831 GvFLAGS(dstr) |= import_flag;
3833 if (stype == SVt_PVHV) {
3834 const char * const name = GvNAME((GV*)dstr);
3835 const STRLEN len = GvNAMELEN(dstr);
3838 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3839 || (len == 1 && name[0] == ':')
3841 && (!dref || HvENAME_get(dref))
3844 (HV *)sref, (HV *)dref,
3850 stype == SVt_PVAV && sref != dref
3851 && strEQ(GvNAME((GV*)dstr), "ISA")
3852 /* The stash may have been detached from the symbol table, so
3853 check its name before doing anything. */
3854 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3857 MAGIC * const omg = dref && SvSMAGICAL(dref)
3858 ? mg_find(dref, PERL_MAGIC_isa)
3860 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3861 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3862 AV * const ary = newAV();
3863 av_push(ary, mg->mg_obj); /* takes the refcount */
3864 mg->mg_obj = (SV *)ary;
3867 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3868 SV **svp = AvARRAY((AV *)omg->mg_obj);
3869 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3873 SvREFCNT_inc_simple_NN(*svp++)
3879 SvREFCNT_inc_simple_NN(omg->mg_obj)
3883 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3888 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3890 mg = mg_find(sref, PERL_MAGIC_isa);
3892 /* Since the *ISA assignment could have affected more than
3893 one stash, don't call mro_isa_changed_in directly, but let
3894 magic_clearisa do it for us, as it already has the logic for
3895 dealing with globs vs arrays of globs. */
3897 Perl_magic_clearisa(aTHX_ NULL, mg);
3899 else if (stype == SVt_PVIO) {
3900 DEBUG_o(Perl_deb(aTHX_ "glob_assign_ref clearing PL_stashcache\n"));
3901 /* It's a cache. It will rebuild itself quite happily.
3902 It's a lot of effort to work out exactly which key (or keys)
3903 might be invalidated by the creation of the this file handle.
3905 hv_clear(PL_stashcache);
3910 if (SvTAINTED(sstr))
3916 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3923 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3928 if (SvIS_FREED(dstr)) {
3929 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3930 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3932 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3934 sstr = &PL_sv_undef;
3935 if (SvIS_FREED(sstr)) {
3936 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3937 (void*)sstr, (void*)dstr);
3939 stype = SvTYPE(sstr);
3940 dtype = SvTYPE(dstr);
3942 /* There's a lot of redundancy below but we're going for speed here */
3947 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3948 (void)SvOK_off(dstr);
3956 sv_upgrade(dstr, SVt_IV);
3960 sv_upgrade(dstr, SVt_PVIV);
3964 goto end_of_first_switch;
3966 (void)SvIOK_only(dstr);
3967 SvIV_set(dstr, SvIVX(sstr));
3970 /* SvTAINTED can only be true if the SV has taint magic, which in
3971 turn means that the SV type is PVMG (or greater). This is the
3972 case statement for SVt_IV, so this cannot be true (whatever gcov
3974 assert(!SvTAINTED(sstr));
3979 if (dtype < SVt_PV && dtype != SVt_IV)
3980 sv_upgrade(dstr, SVt_IV);
3988 sv_upgrade(dstr, SVt_NV);
3992 sv_upgrade(dstr, SVt_PVNV);
3996 goto end_of_first_switch;
3998 SvNV_set(dstr, SvNVX(sstr));
3999 (void)SvNOK_only(dstr);
4000 /* SvTAINTED can only be true if the SV has taint magic, which in
4001 turn means that the SV type is PVMG (or greater). This is the
4002 case statement for SVt_NV, so this cannot be true (whatever gcov
4004 assert(!SvTAINTED(sstr));
4011 sv_upgrade(dstr, SVt_PV);
4014 if (dtype < SVt_PVIV)
4015 sv_upgrade(dstr, SVt_PVIV);
4018 if (dtype < SVt_PVNV)
4019 sv_upgrade(dstr, SVt_PVNV);
4023 const char * const type = sv_reftype(sstr,0);
4025 /* diag_listed_as: Bizarre copy of %s */
4026 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4028 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4034 if (dtype < SVt_REGEXP)
4036 if (dtype >= SVt_PV) {
4042 sv_upgrade(dstr, SVt_REGEXP);
4046 /* case SVt_BIND: */
4050 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4052 if (SvTYPE(sstr) != stype)
4053 stype = SvTYPE(sstr);
4055 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4056 glob_assign_glob(dstr, sstr, dtype);
4059 if (stype == SVt_PVLV)
4061 if (isREGEXP(sstr)) goto upgregexp;
4062 SvUPGRADE(dstr, SVt_PVNV);
4065 SvUPGRADE(dstr, (svtype)stype);
4067 end_of_first_switch:
4069 /* dstr may have been upgraded. */
4070 dtype = SvTYPE(dstr);
4071 sflags = SvFLAGS(sstr);
4073 if (dtype == SVt_PVCV) {
4074 /* Assigning to a subroutine sets the prototype. */
4077 const char *const ptr = SvPV_const(sstr, len);
4079 SvGROW(dstr, len + 1);
4080 Copy(ptr, SvPVX(dstr), len + 1, char);
4081 SvCUR_set(dstr, len);
4083 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4084 CvAUTOLOAD_off(dstr);
4089 else if (dtype == SVt_PVAV || dtype == SVt_PVHV || dtype == SVt_PVFM) {
4090 const char * const type = sv_reftype(dstr,0);
4092 /* diag_listed_as: Cannot copy to %s */
4093 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4095 Perl_croak(aTHX_ "Cannot copy to %s", type);
4096 } else if (sflags & SVf_ROK) {
4097 if (isGV_with_GP(dstr)
4098 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4101 if (GvIMPORTED(dstr) != GVf_IMPORTED
4102 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4104 GvIMPORTED_on(dstr);
4109 glob_assign_glob(dstr, sstr, dtype);
4113 if (dtype >= SVt_PV) {
4114 if (isGV_with_GP(dstr)) {
4115 glob_assign_ref(dstr, sstr);
4118 if (SvPVX_const(dstr)) {
4124 (void)SvOK_off(dstr);
4125 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4126 SvFLAGS(dstr) |= sflags & SVf_ROK;
4127 assert(!(sflags & SVp_NOK));
4128 assert(!(sflags & SVp_IOK));
4129 assert(!(sflags & SVf_NOK));
4130 assert(!(sflags & SVf_IOK));
4132 else if (isGV_with_GP(dstr)) {
4133 if (!(sflags & SVf_OK)) {
4134 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4135 "Undefined value assigned to typeglob");
4138 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4139 if (dstr != (const SV *)gv) {
4140 const char * const name = GvNAME((const GV *)dstr);
4141 const STRLEN len = GvNAMELEN(dstr);
4142 HV *old_stash = NULL;
4143 bool reset_isa = FALSE;
4144 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4145 || (len == 1 && name[0] == ':')) {
4146 /* Set aside the old stash, so we can reset isa caches
4147 on its subclasses. */
4148 if((old_stash = GvHV(dstr))) {
4149 /* Make sure we do not lose it early. */
4150 SvREFCNT_inc_simple_void_NN(
4151 sv_2mortal((SV *)old_stash)
4158 gp_free(MUTABLE_GV(dstr));
4159 GvGP_set(dstr, gp_ref(GvGP(gv)));
4162 HV * const stash = GvHV(dstr);
4164 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4174 else if ((dtype == SVt_REGEXP || dtype == SVt_PVLV)
4175 && (stype == SVt_REGEXP || isREGEXP(sstr))) {
4176 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4178 else if (sflags & SVp_POK) {
4182 * Check to see if we can just swipe the string. If so, it's a
4183 * possible small lose on short strings, but a big win on long ones.
4184 * It might even be a win on short strings if SvPVX_const(dstr)
4185 * has to be allocated and SvPVX_const(sstr) has to be freed.
4186 * Likewise if we can set up COW rather than doing an actual copy, we
4187 * drop to the else clause, as the swipe code and the COW setup code
4188 * have much in common.
4191 /* Whichever path we take through the next code, we want this true,
4192 and doing it now facilitates the COW check. */
4193 (void)SvPOK_only(dstr);
4196 /* If we're already COW then this clause is not true, and if COW
4197 is allowed then we drop down to the else and make dest COW
4198 with us. If caller hasn't said that we're allowed to COW
4199 shared hash keys then we don't do the COW setup, even if the
4200 source scalar is a shared hash key scalar. */
4201 (((flags & SV_COW_SHARED_HASH_KEYS)
4202 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4203 : 1 /* If making a COW copy is forbidden then the behaviour we
4204 desire is as if the source SV isn't actually already
4205 COW, even if it is. So we act as if the source flags
4206 are not COW, rather than actually testing them. */
4208 #ifndef PERL_OLD_COPY_ON_WRITE
4209 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4210 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4211 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4212 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4213 but in turn, it's somewhat dead code, never expected to go
4214 live, but more kept as a placeholder on how to do it better
4215 in a newer implementation. */
4216 /* If we are COW and dstr is a suitable target then we drop down
4217 into the else and make dest a COW of us. */
4218 || (SvFLAGS(dstr) & SVf_BREAK)
4223 (sflags & SVs_TEMP) && /* slated for free anyway? */
4224 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4225 (!(flags & SV_NOSTEAL)) &&
4226 /* and we're allowed to steal temps */
4227 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4228 SvLEN(sstr)) /* and really is a string */
4229 #ifdef PERL_OLD_COPY_ON_WRITE
4230 && ((flags & SV_COW_SHARED_HASH_KEYS)
4231 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4232 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4233 && SvTYPE(sstr) >= SVt_PVIV))
4237 /* Failed the swipe test, and it's not a shared hash key either.
4238 Have to copy the string. */
4239 STRLEN len = SvCUR(sstr);
4240 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4241 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4242 SvCUR_set(dstr, len);
4243 *SvEND(dstr) = '\0';
4245 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4247 /* Either it's a shared hash key, or it's suitable for
4248 copy-on-write or we can swipe the string. */
4250 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4254 #ifdef PERL_OLD_COPY_ON_WRITE
4256 if ((sflags & (SVf_FAKE | SVf_READONLY))
4257 != (SVf_FAKE | SVf_READONLY)) {
4258 SvREADONLY_on(sstr);
4260 /* Make the source SV into a loop of 1.
4261 (about to become 2) */
4262 SV_COW_NEXT_SV_SET(sstr, sstr);
4266 /* Initial code is common. */
4267 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4272 /* making another shared SV. */
4273 STRLEN cur = SvCUR(sstr);
4274 STRLEN len = SvLEN(sstr);
4275 #ifdef PERL_OLD_COPY_ON_WRITE
4277 assert (SvTYPE(dstr) >= SVt_PVIV);
4278 /* SvIsCOW_normal */
4279 /* splice us in between source and next-after-source. */
4280 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4281 SV_COW_NEXT_SV_SET(sstr, dstr);
4282 SvPV_set(dstr, SvPVX_mutable(sstr));
4286 /* SvIsCOW_shared_hash */
4287 DEBUG_C(PerlIO_printf(Perl_debug_log,
4288 "Copy on write: Sharing hash\n"));
4290 assert (SvTYPE(dstr) >= SVt_PV);
4292 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4294 SvLEN_set(dstr, len);
4295 SvCUR_set(dstr, cur);
4296 SvREADONLY_on(dstr);
4300 { /* Passes the swipe test. */
4301 SvPV_set(dstr, SvPVX_mutable(sstr));
4302 SvLEN_set(dstr, SvLEN(sstr));
4303 SvCUR_set(dstr, SvCUR(sstr));
4306 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4307 SvPV_set(sstr, NULL);
4313 if (sflags & SVp_NOK) {
4314 SvNV_set(dstr, SvNVX(sstr));
4316 if (sflags & SVp_IOK) {
4317 SvIV_set(dstr, SvIVX(sstr));
4318 /* Must do this otherwise some other overloaded use of 0x80000000
4319 gets confused. I guess SVpbm_VALID */
4320 if (sflags & SVf_IVisUV)
4323 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4325 const MAGIC * const smg = SvVSTRING_mg(sstr);
4327 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4328 smg->mg_ptr, smg->mg_len);
4329 SvRMAGICAL_on(dstr);
4333 else if (sflags & (SVp_IOK|SVp_NOK)) {
4334 (void)SvOK_off(dstr);
4335 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4336 if (sflags & SVp_IOK) {
4337 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4338 SvIV_set(dstr, SvIVX(sstr));
4340 if (sflags & SVp_NOK) {
4341 SvNV_set(dstr, SvNVX(sstr));
4345 if (isGV_with_GP(sstr)) {
4346 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4349 (void)SvOK_off(dstr);
4351 if (SvTAINTED(sstr))
4356 =for apidoc sv_setsv_mg
4358 Like C<sv_setsv>, but also handles 'set' magic.
4364 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4366 PERL_ARGS_ASSERT_SV_SETSV_MG;
4368 sv_setsv(dstr,sstr);
4372 #ifdef PERL_OLD_COPY_ON_WRITE
4374 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4376 STRLEN cur = SvCUR(sstr);
4377 STRLEN len = SvLEN(sstr);
4380 PERL_ARGS_ASSERT_SV_SETSV_COW;
4383 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4384 (void*)sstr, (void*)dstr);
4391 if (SvTHINKFIRST(dstr))
4392 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4393 else if (SvPVX_const(dstr))
4394 Safefree(SvPVX_mutable(dstr));
4398 SvUPGRADE(dstr, SVt_PVIV);
4400 assert (SvPOK(sstr));
4401 assert (SvPOKp(sstr));
4402 assert (!SvIOK(sstr));
4403 assert (!SvIOKp(sstr));
4404 assert (!SvNOK(sstr));
4405 assert (!SvNOKp(sstr));
4407 if (SvIsCOW(sstr)) {
4409 if (SvLEN(sstr) == 0) {
4410 /* source is a COW shared hash key. */
4411 DEBUG_C(PerlIO_printf(Perl_debug_log,
4412 "Fast copy on write: Sharing hash\n"));
4413 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4416 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4418 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4419 SvUPGRADE(sstr, SVt_PVIV);
4420 SvREADONLY_on(sstr);
4422 DEBUG_C(PerlIO_printf(Perl_debug_log,
4423 "Fast copy on write: Converting sstr to COW\n"));
4424 SV_COW_NEXT_SV_SET(dstr, sstr);
4426 SV_COW_NEXT_SV_SET(sstr, dstr);
4427 new_pv = SvPVX_mutable(sstr);
4430 SvPV_set(dstr, new_pv);
4431 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4434 SvLEN_set(dstr, len);
4435 SvCUR_set(dstr, cur);
4444 =for apidoc sv_setpvn
4446 Copies a string into an SV. The C<len> parameter indicates the number of
4447 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4448 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4454 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4459 PERL_ARGS_ASSERT_SV_SETPVN;
4461 SV_CHECK_THINKFIRST_COW_DROP(sv);
4467 /* len is STRLEN which is unsigned, need to copy to signed */
4470 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4473 SvUPGRADE(sv, SVt_PV);
4475 dptr = SvGROW(sv, len + 1);
4476 Move(ptr,dptr,len,char);
4479 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4481 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4485 =for apidoc sv_setpvn_mg
4487 Like C<sv_setpvn>, but also handles 'set' magic.
4493 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4495 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4497 sv_setpvn(sv,ptr,len);
4502 =for apidoc sv_setpv
4504 Copies a string into an SV. The string must be null-terminated. Does not
4505 handle 'set' magic. See C<sv_setpv_mg>.
4511 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4516 PERL_ARGS_ASSERT_SV_SETPV;
4518 SV_CHECK_THINKFIRST_COW_DROP(sv);
4524 SvUPGRADE(sv, SVt_PV);
4526 SvGROW(sv, len + 1);
4527 Move(ptr,SvPVX(sv),len+1,char);
4529 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4531 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4535 =for apidoc sv_setpv_mg
4537 Like C<sv_setpv>, but also handles 'set' magic.
4543 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4545 PERL_ARGS_ASSERT_SV_SETPV_MG;
4552 Perl_sv_sethek(pTHX_ register SV *const sv, const HEK *const hek)
4556 PERL_ARGS_ASSERT_SV_SETHEK;
4562 if (HEK_LEN(hek) == HEf_SVKEY) {
4563 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4566 const int flags = HEK_FLAGS(hek);
4567 if (flags & HVhek_WASUTF8) {
4568 STRLEN utf8_len = HEK_LEN(hek);
4569 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4570 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4573 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
4574 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4577 else SvUTF8_off(sv);
4581 SV_CHECK_THINKFIRST_COW_DROP(sv);
4582 SvUPGRADE(sv, SVt_PV);
4583 Safefree(SvPVX(sv));
4584 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4585 SvCUR_set(sv, HEK_LEN(hek));
4592 else SvUTF8_off(sv);
4600 =for apidoc sv_usepvn_flags
4602 Tells an SV to use C<ptr> to find its string value. Normally the
4603 string is stored inside the SV but sv_usepvn allows the SV to use an
4604 outside string. The C<ptr> should point to memory that was allocated
4605 by C<malloc>. It must be the start of a mallocked block
4606 of memory, and not a pointer to the middle of it. The
4607 string length, C<len>, must be supplied. By default
4608 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4609 so that pointer should not be freed or used by the programmer after
4610 giving it to sv_usepvn, and neither should any pointers from "behind"
4611 that pointer (e.g. ptr + 1) be used.
4613 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4614 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4615 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4616 C<len>, and already meets the requirements for storing in C<SvPVX>).
4622 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4627 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4629 SV_CHECK_THINKFIRST_COW_DROP(sv);
4630 SvUPGRADE(sv, SVt_PV);
4633 if (flags & SV_SMAGIC)
4637 if (SvPVX_const(sv))
4641 if (flags & SV_HAS_TRAILING_NUL)
4642 assert(ptr[len] == '\0');
4645 allocate = (flags & SV_HAS_TRAILING_NUL)
4647 #ifdef Perl_safesysmalloc_size
4650 PERL_STRLEN_ROUNDUP(len + 1);
4652 if (flags & SV_HAS_TRAILING_NUL) {
4653 /* It's long enough - do nothing.
4654 Specifically Perl_newCONSTSUB is relying on this. */
4657 /* Force a move to shake out bugs in callers. */
4658 char *new_ptr = (char*)safemalloc(allocate);
4659 Copy(ptr, new_ptr, len, char);
4660 PoisonFree(ptr,len,char);
4664 ptr = (char*) saferealloc (ptr, allocate);
4667 #ifdef Perl_safesysmalloc_size
4668 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4670 SvLEN_set(sv, allocate);
4674 if (!(flags & SV_HAS_TRAILING_NUL)) {
4677 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4679 if (flags & SV_SMAGIC)
4683 #ifdef PERL_OLD_COPY_ON_WRITE
4684 /* Need to do this *after* making the SV normal, as we need the buffer
4685 pointer to remain valid until after we've copied it. If we let go too early,
4686 another thread could invalidate it by unsharing last of the same hash key
4687 (which it can do by means other than releasing copy-on-write Svs)
4688 or by changing the other copy-on-write SVs in the loop. */
4690 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4692 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4694 { /* this SV was SvIsCOW_normal(sv) */
4695 /* we need to find the SV pointing to us. */
4696 SV *current = SV_COW_NEXT_SV(after);
4698 if (current == sv) {
4699 /* The SV we point to points back to us (there were only two of us
4701 Hence other SV is no longer copy on write either. */
4703 SvREADONLY_off(after);
4705 /* We need to follow the pointers around the loop. */
4707 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4710 /* don't loop forever if the structure is bust, and we have
4711 a pointer into a closed loop. */
4712 assert (current != after);
4713 assert (SvPVX_const(current) == pvx);
4715 /* Make the SV before us point to the SV after us. */
4716 SV_COW_NEXT_SV_SET(current, after);
4722 =for apidoc sv_force_normal_flags
4724 Undo various types of fakery on an SV, where fakery means
4725 "more than" a string: if the PV is a shared string, make
4726 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4727 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4728 we do the copy, and is also used locally; if this is a
4729 vstring, drop the vstring magic. If C<SV_COW_DROP_PV> is set
4730 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4731 SvPOK_off rather than making a copy. (Used where this
4732 scalar is about to be set to some other value.) In addition,
4733 the C<flags> parameter gets passed to C<sv_unref_flags()>
4734 when unreffing. C<sv_force_normal> calls this function
4735 with flags set to 0.
4741 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4745 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4747 #ifdef PERL_OLD_COPY_ON_WRITE
4748 if (SvREADONLY(sv)) {
4750 const char * const pvx = SvPVX_const(sv);
4751 const STRLEN len = SvLEN(sv);
4752 const STRLEN cur = SvCUR(sv);
4753 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4754 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4755 we'll fail an assertion. */
4756 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4759 PerlIO_printf(Perl_debug_log,
4760 "Copy on write: Force normal %ld\n",
4766 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4769 if (flags & SV_COW_DROP_PV) {
4770 /* OK, so we don't need to copy our buffer. */
4773 SvGROW(sv, cur + 1);
4774 Move(pvx,SvPVX(sv),cur,char);
4779 sv_release_COW(sv, pvx, next);
4781 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4787 else if (IN_PERL_RUNTIME)
4788 Perl_croak_no_modify(aTHX);
4791 if (SvREADONLY(sv)) {
4793 const char * const pvx = SvPVX_const(sv);
4794 const STRLEN len = SvCUR(sv);
4799 if (flags & SV_COW_DROP_PV) {
4800 /* OK, so we don't need to copy our buffer. */
4803 SvGROW(sv, len + 1);
4804 Move(pvx,SvPVX(sv),len,char);
4807 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4809 else if (IN_PERL_RUNTIME)
4810 Perl_croak_no_modify(aTHX);
4814 sv_unref_flags(sv, flags);
4815 else if (SvFAKE(sv) && isGV_with_GP(sv))
4816 sv_unglob(sv, flags);
4817 else if (SvFAKE(sv) && isREGEXP(sv)) {
4818 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4819 to sv_unglob. We only need it here, so inline it. */
4820 const bool islv = SvTYPE(sv) == SVt_PVLV;
4821 const svtype new_type =
4822 islv ? SVt_NULL : SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4823 SV *const temp = newSV_type(new_type);
4824 regexp *const temp_p = ReANY((REGEXP *)sv);
4826 if (new_type == SVt_PVMG) {
4827 SvMAGIC_set(temp, SvMAGIC(sv));
4828 SvMAGIC_set(sv, NULL);
4829 SvSTASH_set(temp, SvSTASH(sv));
4830 SvSTASH_set(sv, NULL);
4832 if (!islv) SvCUR_set(temp, SvCUR(sv));
4833 /* Remember that SvPVX is in the head, not the body. But
4834 RX_WRAPPED is in the body. */
4835 assert(ReANY((REGEXP *)sv)->mother_re);
4836 /* Their buffer is already owned by someone else. */
4837 if (flags & SV_COW_DROP_PV) {
4838 /* SvLEN is already 0. For SVt_REGEXP, we have a brand new
4839 zeroed body. For SVt_PVLV, it should have been set to 0
4840 before turning into a regexp. */
4841 assert(!SvLEN(islv ? sv : temp));
4842 sv->sv_u.svu_pv = 0;
4845 sv->sv_u.svu_pv = savepvn(RX_WRAPPED((REGEXP *)sv), SvCUR(sv));
4846 SvLEN_set(islv ? sv : temp, SvCUR(sv)+1);
4850 /* Now swap the rest of the bodies. */
4854 SvFLAGS(sv) &= ~SVTYPEMASK;
4855 SvFLAGS(sv) |= new_type;
4856 SvANY(sv) = SvANY(temp);
4859 SvFLAGS(temp) &= ~(SVTYPEMASK);
4860 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4861 SvANY(temp) = temp_p;
4862 temp->sv_u.svu_rx = (regexp *)temp_p;
4866 else if (SvVOK(sv)) sv_unmagic(sv, PERL_MAGIC_vstring);
4872 Efficient removal of characters from the beginning of the string buffer.
4873 SvPOK(sv), or at least SvPOKp(sv), must be true and the C<ptr> must be a
4874 pointer to somewhere inside the string buffer. The C<ptr> becomes the first
4875 character of the adjusted string. Uses the "OOK hack". On return, only
4876 SvPOK(sv) and SvPOKp(sv) among the OK flags will be true.
4878 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4879 refer to the same chunk of data.
4881 The unfortunate similarity of this function's name to that of Perl's C<chop>
4882 operator is strictly coincidental. This function works from the left;
4883 C<chop> works from the right.
4889 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4900 PERL_ARGS_ASSERT_SV_CHOP;
4902 if (!ptr || !SvPOKp(sv))
4904 delta = ptr - SvPVX_const(sv);
4906 /* Nothing to do. */
4909 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4910 if (delta > max_delta)
4911 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4912 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4913 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
4914 SV_CHECK_THINKFIRST(sv);
4915 SvPOK_only_UTF8(sv);
4918 if (!SvLEN(sv)) { /* make copy of shared string */
4919 const char *pvx = SvPVX_const(sv);
4920 const STRLEN len = SvCUR(sv);
4921 SvGROW(sv, len + 1);
4922 Move(pvx,SvPVX(sv),len,char);
4928 SvOOK_offset(sv, old_delta);
4930 SvLEN_set(sv, SvLEN(sv) - delta);
4931 SvCUR_set(sv, SvCUR(sv) - delta);
4932 SvPV_set(sv, SvPVX(sv) + delta);
4934 p = (U8 *)SvPVX_const(sv);
4937 /* how many bytes were evacuated? we will fill them with sentinel
4938 bytes, except for the part holding the new offset of course. */
4941 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
4943 assert(evacn <= delta + old_delta);
4949 if (delta < 0x100) {
4953 p -= sizeof(STRLEN);
4954 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4958 /* Fill the preceding buffer with sentinals to verify that no-one is
4968 =for apidoc sv_catpvn
4970 Concatenates the string onto the end of the string which is in the SV. The
4971 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4972 status set, then the bytes appended should be valid UTF-8.
4973 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4975 =for apidoc sv_catpvn_flags
4977 Concatenates the string onto the end of the string which is in the SV. The
4978 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4979 status set, then the bytes appended should be valid UTF-8.
4980 If C<flags> has the C<SV_SMAGIC> bit set, will
4981 C<mg_set> on C<dsv> afterwards if appropriate.
4982 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4983 in terms of this function.
4989 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4993 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4995 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4996 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
4998 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
4999 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5000 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5003 else SvGROW(dsv, dlen + slen + 1);
5005 sstr = SvPVX_const(dsv);
5006 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5007 SvCUR_set(dsv, SvCUR(dsv) + slen);
5010 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5011 const char * const send = sstr + slen;
5014 /* Something this code does not account for, which I think is
5015 impossible; it would require the same pv to be treated as
5016 bytes *and* utf8, which would indicate a bug elsewhere. */
5017 assert(sstr != dstr);
5019 SvGROW(dsv, dlen + slen * 2 + 1);
5020 d = (U8 *)SvPVX(dsv) + dlen;
5022 while (sstr < send) {
5023 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5024 if (UNI_IS_INVARIANT(uv))
5025 *d++ = (U8)UTF_TO_NATIVE(uv);
5027 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5028 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5031 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5034 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5036 if (flags & SV_SMAGIC)
5041 =for apidoc sv_catsv
5043 Concatenates the string from SV C<ssv> onto the end of the string in SV
5044 C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5045 Handles 'get' magic on both SVs, but no 'set' magic. See C<sv_catsv_mg> and
5048 =for apidoc sv_catsv_flags
5050 Concatenates the string from SV C<ssv> onto the end of the string in SV
5051 C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5052 If C<flags> include C<SV_GMAGIC> bit set, will call C<mg_get> on both SVs if
5053 appropriate. If C<flags> include C<SV_SMAGIC>, C<mg_set> will be called on
5054 the modified SV afterward, if appropriate. C<sv_catsv>, C<sv_catsv_nomg>,
5055 and C<sv_catsv_mg> are implemented in terms of this function.
5060 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
5064 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5068 const char *spv = SvPV_flags_const(ssv, slen, flags);
5070 if (flags & SV_GMAGIC)
5072 sv_catpvn_flags(dsv, spv, slen,
5073 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5074 if (flags & SV_SMAGIC)
5081 =for apidoc sv_catpv
5083 Concatenates the string onto the end of the string which is in the SV.
5084 If the SV has the UTF-8 status set, then the bytes appended should be
5085 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5090 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5097 PERL_ARGS_ASSERT_SV_CATPV;
5101 junk = SvPV_force(sv, tlen);
5103 SvGROW(sv, tlen + len + 1);
5105 ptr = SvPVX_const(sv);
5106 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5107 SvCUR_set(sv, SvCUR(sv) + len);
5108 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5113 =for apidoc sv_catpv_flags
5115 Concatenates the string onto the end of the string which is in the SV.
5116 If the SV has the UTF-8 status set, then the bytes appended should
5117 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5118 on the modified SV if appropriate.
5124 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5126 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5127 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5131 =for apidoc sv_catpv_mg
5133 Like C<sv_catpv>, but also handles 'set' magic.
5139 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5141 PERL_ARGS_ASSERT_SV_CATPV_MG;
5150 Creates a new SV. A non-zero C<len> parameter indicates the number of
5151 bytes of preallocated string space the SV should have. An extra byte for a
5152 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5153 space is allocated.) The reference count for the new SV is set to 1.
5155 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5156 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5157 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5158 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5159 modules supporting older perls.
5165 Perl_newSV(pTHX_ const STRLEN len)
5172 sv_upgrade(sv, SVt_PV);
5173 SvGROW(sv, len + 1);
5178 =for apidoc sv_magicext
5180 Adds magic to an SV, upgrading it if necessary. Applies the
5181 supplied vtable and returns a pointer to the magic added.
5183 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5184 In particular, you can add magic to SvREADONLY SVs, and add more than
5185 one instance of the same 'how'.
5187 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5188 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5189 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5190 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5192 (This is now used as a subroutine by C<sv_magic>.)
5197 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5198 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5203 PERL_ARGS_ASSERT_SV_MAGICEXT;
5205 SvUPGRADE(sv, SVt_PVMG);
5206 Newxz(mg, 1, MAGIC);
5207 mg->mg_moremagic = SvMAGIC(sv);
5208 SvMAGIC_set(sv, mg);
5210 /* Sometimes a magic contains a reference loop, where the sv and
5211 object refer to each other. To prevent a reference loop that
5212 would prevent such objects being freed, we look for such loops
5213 and if we find one we avoid incrementing the object refcount.
5215 Note we cannot do this to avoid self-tie loops as intervening RV must
5216 have its REFCNT incremented to keep it in existence.
5219 if (!obj || obj == sv ||
5220 how == PERL_MAGIC_arylen ||
5221 how == PERL_MAGIC_symtab ||
5222 (SvTYPE(obj) == SVt_PVGV &&
5223 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5224 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5225 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5230 mg->mg_obj = SvREFCNT_inc_simple(obj);
5231 mg->mg_flags |= MGf_REFCOUNTED;
5234 /* Normal self-ties simply pass a null object, and instead of
5235 using mg_obj directly, use the SvTIED_obj macro to produce a
5236 new RV as needed. For glob "self-ties", we are tieing the PVIO
5237 with an RV obj pointing to the glob containing the PVIO. In
5238 this case, to avoid a reference loop, we need to weaken the
5242 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5243 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5249 mg->mg_len = namlen;
5252 mg->mg_ptr = savepvn(name, namlen);
5253 else if (namlen == HEf_SVKEY) {
5254 /* Yes, this is casting away const. This is only for the case of
5255 HEf_SVKEY. I think we need to document this aberation of the
5256 constness of the API, rather than making name non-const, as
5257 that change propagating outwards a long way. */
5258 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5260 mg->mg_ptr = (char *) name;
5262 mg->mg_virtual = (MGVTBL *) vtable;
5269 =for apidoc sv_magic
5271 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5272 necessary, then adds a new magic item of type C<how> to the head of the
5275 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5276 handling of the C<name> and C<namlen> arguments.
5278 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5279 to add more than one instance of the same 'how'.
5285 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5286 const char *const name, const I32 namlen)
5289 const MGVTBL *vtable;
5292 unsigned int vtable_index;
5294 PERL_ARGS_ASSERT_SV_MAGIC;
5296 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5297 || ((flags = PL_magic_data[how]),
5298 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5299 > magic_vtable_max))
5300 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5302 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5303 Useful for attaching extension internal data to perl vars.
5304 Note that multiple extensions may clash if magical scalars
5305 etc holding private data from one are passed to another. */
5307 vtable = (vtable_index == magic_vtable_max)
5308 ? NULL : PL_magic_vtables + vtable_index;
5310 #ifdef PERL_OLD_COPY_ON_WRITE
5312 sv_force_normal_flags(sv, 0);
5314 if (SvREADONLY(sv)) {
5316 /* its okay to attach magic to shared strings */
5320 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5323 Perl_croak_no_modify(aTHX);
5326 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5327 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5328 /* sv_magic() refuses to add a magic of the same 'how' as an
5331 if (how == PERL_MAGIC_taint)
5337 /* Rest of work is done else where */
5338 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5341 case PERL_MAGIC_taint:
5344 case PERL_MAGIC_ext:
5345 case PERL_MAGIC_dbfile:
5352 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5359 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5361 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5362 for (mg = *mgp; mg; mg = *mgp) {
5363 const MGVTBL* const virt = mg->mg_virtual;
5364 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5365 *mgp = mg->mg_moremagic;
5366 if (virt && virt->svt_free)
5367 virt->svt_free(aTHX_ sv, mg);
5368 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5370 Safefree(mg->mg_ptr);
5371 else if (mg->mg_len == HEf_SVKEY)
5372 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5373 else if (mg->mg_type == PERL_MAGIC_utf8)
5374 Safefree(mg->mg_ptr);
5376 if (mg->mg_flags & MGf_REFCOUNTED)
5377 SvREFCNT_dec(mg->mg_obj);
5381 mgp = &mg->mg_moremagic;
5384 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5385 mg_magical(sv); /* else fix the flags now */
5389 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5395 =for apidoc sv_unmagic
5397 Removes all magic of type C<type> from an SV.
5403 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5405 PERL_ARGS_ASSERT_SV_UNMAGIC;
5406 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5410 =for apidoc sv_unmagicext
5412 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5418 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5420 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5421 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5425 =for apidoc sv_rvweaken
5427 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5428 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5429 push a back-reference to this RV onto the array of backreferences
5430 associated with that magic. If the RV is magical, set magic will be
5431 called after the RV is cleared.
5437 Perl_sv_rvweaken(pTHX_ SV *const sv)
5441 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5443 if (!SvOK(sv)) /* let undefs pass */
5446 Perl_croak(aTHX_ "Can't weaken a nonreference");
5447 else if (SvWEAKREF(sv)) {
5448 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5451 else if (SvREADONLY(sv)) croak_no_modify();
5453 Perl_sv_add_backref(aTHX_ tsv, sv);
5459 /* Give tsv backref magic if it hasn't already got it, then push a
5460 * back-reference to sv onto the array associated with the backref magic.
5462 * As an optimisation, if there's only one backref and it's not an AV,
5463 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5464 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5468 /* A discussion about the backreferences array and its refcount:
5470 * The AV holding the backreferences is pointed to either as the mg_obj of
5471 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5472 * xhv_backreferences field. The array is created with a refcount
5473 * of 2. This means that if during global destruction the array gets
5474 * picked on before its parent to have its refcount decremented by the
5475 * random zapper, it won't actually be freed, meaning it's still there for
5476 * when its parent gets freed.
5478 * When the parent SV is freed, the extra ref is killed by
5479 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5480 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5482 * When a single backref SV is stored directly, it is not reference
5487 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5494 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5496 /* find slot to store array or singleton backref */
5498 if (SvTYPE(tsv) == SVt_PVHV) {
5499 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5502 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5504 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5505 mg = mg_find(tsv, PERL_MAGIC_backref);
5507 svp = &(mg->mg_obj);
5510 /* create or retrieve the array */
5512 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5513 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5518 SvREFCNT_inc_simple_void(av);
5519 /* av now has a refcnt of 2; see discussion above */
5521 /* move single existing backref to the array */
5523 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5527 mg->mg_flags |= MGf_REFCOUNTED;
5530 av = MUTABLE_AV(*svp);
5533 /* optimisation: store single backref directly in HvAUX or mg_obj */
5537 /* push new backref */
5538 assert(SvTYPE(av) == SVt_PVAV);
5539 if (AvFILLp(av) >= AvMAX(av)) {
5540 av_extend(av, AvFILLp(av)+1);
5542 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5545 /* delete a back-reference to ourselves from the backref magic associated
5546 * with the SV we point to.
5550 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5555 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5557 if (SvTYPE(tsv) == SVt_PVHV) {
5559 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5561 else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5562 /* It's possible for the the last (strong) reference to tsv to have
5563 become freed *before* the last thing holding a weak reference.
5564 If both survive longer than the backreferences array, then when
5565 the referent's reference count drops to 0 and it is freed, it's
5566 not able to chase the backreferences, so they aren't NULLed.
5568 For example, a CV holds a weak reference to its stash. If both the
5569 CV and the stash survive longer than the backreferences array,
5570 and the CV gets picked for the SvBREAK() treatment first,
5571 *and* it turns out that the stash is only being kept alive because
5572 of an our variable in the pad of the CV, then midway during CV
5573 destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5574 It ends up pointing to the freed HV. Hence it's chased in here, and
5575 if this block wasn't here, it would hit the !svp panic just below.
5577 I don't believe that "better" destruction ordering is going to help
5578 here - during global destruction there's always going to be the
5579 chance that something goes out of order. We've tried to make it
5580 foolproof before, and it only resulted in evolutionary pressure on
5581 fools. Which made us look foolish for our hubris. :-(
5587 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5588 svp = mg ? &(mg->mg_obj) : NULL;
5592 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5594 /* It's possible that sv is being freed recursively part way through the
5595 freeing of tsv. If this happens, the backreferences array of tsv has
5596 already been freed, and so svp will be NULL. If this is the case,
5597 we should not panic. Instead, nothing needs doing, so return. */
5598 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5600 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5601 *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5604 if (SvTYPE(*svp) == SVt_PVAV) {
5608 AV * const av = (AV*)*svp;
5610 assert(!SvIS_FREED(av));
5614 /* for an SV with N weak references to it, if all those
5615 * weak refs are deleted, then sv_del_backref will be called
5616 * N times and O(N^2) compares will be done within the backref
5617 * array. To ameliorate this potential slowness, we:
5618 * 1) make sure this code is as tight as possible;
5619 * 2) when looking for SV, look for it at both the head and tail of the
5620 * array first before searching the rest, since some create/destroy
5621 * patterns will cause the backrefs to be freed in order.
5628 SV **p = &svp[fill];
5629 SV *const topsv = *p;
5636 /* We weren't the last entry.
5637 An unordered list has this property that you
5638 can take the last element off the end to fill
5639 the hole, and it's still an unordered list :-)
5645 break; /* should only be one */
5652 AvFILLp(av) = fill-1;
5654 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5655 /* freed AV; skip */
5658 /* optimisation: only a single backref, stored directly */
5660 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5667 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5673 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5678 /* after multiple passes through Perl_sv_clean_all() for a thingy
5679 * that has badly leaked, the backref array may have gotten freed,
5680 * since we only protect it against 1 round of cleanup */
5681 if (SvIS_FREED(av)) {
5682 if (PL_in_clean_all) /* All is fair */
5685 "panic: magic_killbackrefs (freed backref AV/SV)");
5689 is_array = (SvTYPE(av) == SVt_PVAV);
5691 assert(!SvIS_FREED(av));
5694 last = svp + AvFILLp(av);
5697 /* optimisation: only a single backref, stored directly */
5703 while (svp <= last) {
5705 SV *const referrer = *svp;
5706 if (SvWEAKREF(referrer)) {
5707 /* XXX Should we check that it hasn't changed? */
5708 assert(SvROK(referrer));
5709 SvRV_set(referrer, 0);
5711 SvWEAKREF_off(referrer);
5712 SvSETMAGIC(referrer);
5713 } else if (SvTYPE(referrer) == SVt_PVGV ||
5714 SvTYPE(referrer) == SVt_PVLV) {
5715 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5716 /* You lookin' at me? */
5717 assert(GvSTASH(referrer));
5718 assert(GvSTASH(referrer) == (const HV *)sv);
5719 GvSTASH(referrer) = 0;
5720 } else if (SvTYPE(referrer) == SVt_PVCV ||
5721 SvTYPE(referrer) == SVt_PVFM) {
5722 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5723 /* You lookin' at me? */
5724 assert(CvSTASH(referrer));
5725 assert(CvSTASH(referrer) == (const HV *)sv);
5726 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5729 assert(SvTYPE(sv) == SVt_PVGV);
5730 /* You lookin' at me? */
5731 assert(CvGV(referrer));
5732 assert(CvGV(referrer) == (const GV *)sv);
5733 anonymise_cv_maybe(MUTABLE_GV(sv),
5734 MUTABLE_CV(referrer));
5739 "panic: magic_killbackrefs (flags=%"UVxf")",
5740 (UV)SvFLAGS(referrer));
5751 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5757 =for apidoc sv_insert
5759 Inserts a string at the specified offset/length within the SV. Similar to
5760 the Perl substr() function. Handles get magic.
5762 =for apidoc sv_insert_flags
5764 Same as C<sv_insert>, but the extra C<flags> are passed to the
5765 C<SvPV_force_flags> that applies to C<bigstr>.
5771 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5778 SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5781 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5784 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5785 SvPV_force_flags(bigstr, curlen, flags);
5786 (void)SvPOK_only_UTF8(bigstr);
5787 if (offset + len > curlen) {
5788 SvGROW(bigstr, offset+len+1);
5789 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5790 SvCUR_set(bigstr, offset+len);
5794 i = littlelen - len;
5795 if (i > 0) { /* string might grow */
5796 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5797 mid = big + offset + len;
5798 midend = bigend = big + SvCUR(bigstr);
5801 while (midend > mid) /* shove everything down */
5802 *--bigend = *--midend;
5803 Move(little,big+offset,littlelen,char);
5804 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5809 Move(little,SvPVX(bigstr)+offset,len,char);
5814 big = SvPVX(bigstr);
5817 bigend = big + SvCUR(bigstr);
5819 if (midend > bigend)
5820 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5823 if (mid - big > bigend - midend) { /* faster to shorten from end */
5825 Move(little, mid, littlelen,char);
5828 i = bigend - midend;
5830 Move(midend, mid, i,char);
5834 SvCUR_set(bigstr, mid - big);
5836 else if ((i = mid - big)) { /* faster from front */
5837 midend -= littlelen;
5839 Move(big, midend - i, i, char);
5840 sv_chop(bigstr,midend-i);
5842 Move(little, mid, littlelen,char);
5844 else if (littlelen) {
5845 midend -= littlelen;
5846 sv_chop(bigstr,midend);
5847 Move(little,midend,littlelen,char);
5850 sv_chop(bigstr,midend);
5856 =for apidoc sv_replace
5858 Make the first argument a copy of the second, then delete the original.
5859 The target SV physically takes over ownership of the body of the source SV
5860 and inherits its flags; however, the target keeps any magic it owns,
5861 and any magic in the source is discarded.
5862 Note that this is a rather specialist SV copying operation; most of the
5863 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5869 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5872 const U32 refcnt = SvREFCNT(sv);
5874 PERL_ARGS_ASSERT_SV_REPLACE;
5876 SV_CHECK_THINKFIRST_COW_DROP(sv);
5877 if (SvREFCNT(nsv) != 1) {
5878 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5879 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5881 if (SvMAGICAL(sv)) {
5885 sv_upgrade(nsv, SVt_PVMG);
5886 SvMAGIC_set(nsv, SvMAGIC(sv));
5887 SvFLAGS(nsv) |= SvMAGICAL(sv);
5889 SvMAGIC_set(sv, NULL);
5893 assert(!SvREFCNT(sv));
5894 #ifdef DEBUG_LEAKING_SCALARS
5895 sv->sv_flags = nsv->sv_flags;
5896 sv->sv_any = nsv->sv_any;
5897 sv->sv_refcnt = nsv->sv_refcnt;
5898 sv->sv_u = nsv->sv_u;
5900 StructCopy(nsv,sv,SV);
5902 if(SvTYPE(sv) == SVt_IV) {
5904 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5908 #ifdef PERL_OLD_COPY_ON_WRITE
5909 if (SvIsCOW_normal(nsv)) {
5910 /* We need to follow the pointers around the loop to make the
5911 previous SV point to sv, rather than nsv. */
5914 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5917 assert(SvPVX_const(current) == SvPVX_const(nsv));
5919 /* Make the SV before us point to the SV after us. */
5921 PerlIO_printf(Perl_debug_log, "previous is\n");
5923 PerlIO_printf(Perl_debug_log,
5924 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5925 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5927 SV_COW_NEXT_SV_SET(current, sv);
5930 SvREFCNT(sv) = refcnt;
5931 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5936 /* We're about to free a GV which has a CV that refers back to us.
5937 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5941 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5946 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5949 assert(SvREFCNT(gv) == 0);
5950 assert(isGV(gv) && isGV_with_GP(gv));
5952 assert(!CvANON(cv));
5953 assert(CvGV(cv) == gv);
5954 assert(!CvNAMED(cv));
5956 /* will the CV shortly be freed by gp_free() ? */
5957 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5958 SvANY(cv)->xcv_gv_u.xcv_gv = NULL;
5962 /* if not, anonymise: */
5963 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
5964 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
5965 : newSVpvn_flags( "__ANON__", 8, 0 );
5966 sv_catpvs(gvname, "::__ANON__");
5967 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5968 SvREFCNT_dec(gvname);
5972 SvANY(cv)->xcv_gv_u.xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5977 =for apidoc sv_clear
5979 Clear an SV: call any destructors, free up any memory used by the body,
5980 and free the body itself. The SV's head is I<not> freed, although
5981 its type is set to all 1's so that it won't inadvertently be assumed
5982 to be live during global destruction etc.
5983 This function should only be called when REFCNT is zero. Most of the time
5984 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5991 Perl_sv_clear(pTHX_ SV *const orig_sv)
5996 const struct body_details *sv_type_details;
6002 PERL_ARGS_ASSERT_SV_CLEAR;
6004 /* within this loop, sv is the SV currently being freed, and
6005 * iter_sv is the most recent AV or whatever that's being iterated
6006 * over to provide more SVs */
6012 assert(SvREFCNT(sv) == 0);
6013 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6015 if (type <= SVt_IV) {
6016 /* See the comment in sv.h about the collusion between this
6017 * early return and the overloading of the NULL slots in the
6021 SvFLAGS(sv) &= SVf_BREAK;
6022 SvFLAGS(sv) |= SVTYPEMASK;
6026 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6028 if (type >= SVt_PVMG) {
6030 if (!curse(sv, 1)) goto get_next_sv;
6031 type = SvTYPE(sv); /* destructor may have changed it */
6033 /* Free back-references before magic, in case the magic calls
6034 * Perl code that has weak references to sv. */
6035 if (type == SVt_PVHV) {
6036 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6040 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6041 SvREFCNT_dec(SvOURSTASH(sv));
6042 } else if (SvMAGIC(sv)) {
6043 /* Free back-references before other types of magic. */
6044 sv_unmagic(sv, PERL_MAGIC_backref);
6048 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6049 SvREFCNT_dec(SvSTASH(sv));
6052 /* case SVt_BIND: */
6055 IoIFP(sv) != PerlIO_stdin() &&
6056 IoIFP(sv) != PerlIO_stdout() &&
6057 IoIFP(sv) != PerlIO_stderr() &&
6058 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6060 io_close(MUTABLE_IO(sv), FALSE);
6062 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6063 PerlDir_close(IoDIRP(sv));
6064 IoDIRP(sv) = (DIR*)NULL;
6065 Safefree(IoTOP_NAME(sv));
6066 Safefree(IoFMT_NAME(sv));
6067 Safefree(IoBOTTOM_NAME(sv));
6068 if ((const GV *)sv == PL_statgv)
6072 /* FIXME for plugins */
6074 pregfree2((REGEXP*) sv);
6078 cv_undef(MUTABLE_CV(sv));
6079 /* If we're in a stash, we don't own a reference to it.
6080 * However it does have a back reference to us, which needs to
6082 if ((stash = CvSTASH(sv)))
6083 sv_del_backref(MUTABLE_SV(stash), sv);
6086 if (PL_last_swash_hv == (const HV *)sv) {
6087 PL_last_swash_hv = NULL;
6089 if (HvTOTALKEYS((HV*)sv) > 0) {
6091 /* this statement should match the one at the beginning of
6092 * hv_undef_flags() */
6093 if ( PL_phase != PERL_PHASE_DESTRUCT
6094 && (name = HvNAME((HV*)sv)))
6096 if (PL_stashcache) {
6097 DEBUG_o(Perl_deb(aTHX_ "sv_clear clearing PL_stashcache for '%"SVf"'\n",
6099 (void)hv_delete(PL_stashcache, name,
6100 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6102 hv_name_set((HV*)sv, NULL, 0, 0);
6105 /* save old iter_sv in unused SvSTASH field */
6106 assert(!SvOBJECT(sv));
6107 SvSTASH(sv) = (HV*)iter_sv;
6110 /* save old hash_index in unused SvMAGIC field */
6111 assert(!SvMAGICAL(sv));
6112 assert(!SvMAGIC(sv));
6113 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6116 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6117 goto get_next_sv; /* process this new sv */
6119 /* free empty hash */
6120 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6121 assert(!HvARRAY((HV*)sv));
6125 AV* av = MUTABLE_AV(sv);
6126 if (PL_comppad == av) {
6130 if (AvREAL(av) && AvFILLp(av) > -1) {
6131 next_sv = AvARRAY(av)[AvFILLp(av)--];
6132 /* save old iter_sv in top-most slot of AV,
6133 * and pray that it doesn't get wiped in the meantime */
6134 AvARRAY(av)[AvMAX(av)] = iter_sv;
6136 goto get_next_sv; /* process this new sv */
6138 Safefree(AvALLOC(av));
6143 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6144 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6145 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6146 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6148 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6149 SvREFCNT_dec(LvTARG(sv));
6150 if (isREGEXP(sv)) goto freeregexp;
6152 if (isGV_with_GP(sv)) {
6153 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6154 && HvENAME_get(stash))
6155 mro_method_changed_in(stash);
6156 gp_free(MUTABLE_GV(sv));
6158 unshare_hek(GvNAME_HEK(sv));
6159 /* If we're in a stash, we don't own a reference to it.
6160 * However it does have a back reference to us, which
6161 * needs to be cleared. */
6162 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6163 sv_del_backref(MUTABLE_SV(stash), sv);
6165 /* FIXME. There are probably more unreferenced pointers to SVs
6166 * in the interpreter struct that we should check and tidy in
6167 * a similar fashion to this: */
6168 /* See also S_sv_unglob, which does the same thing. */
6169 if ((const GV *)sv == PL_last_in_gv)
6170 PL_last_in_gv = NULL;
6171 else if ((const GV *)sv == PL_statgv)
6178 /* Don't bother with SvOOK_off(sv); as we're only going to
6182 SvOOK_offset(sv, offset);
6183 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6184 /* Don't even bother with turning off the OOK flag. */
6189 SV * const target = SvRV(sv);
6191 sv_del_backref(target, sv);
6196 #ifdef PERL_OLD_COPY_ON_WRITE
6197 else if (SvPVX_const(sv)
6198 && !(SvTYPE(sv) == SVt_PVIO
6199 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6203 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6207 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6209 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6213 } else if (SvLEN(sv)) {
6214 Safefree(SvPVX_mutable(sv));
6218 else if (SvPVX_const(sv) && SvLEN(sv)
6219 && !(SvTYPE(sv) == SVt_PVIO
6220 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6221 Safefree(SvPVX_mutable(sv));
6222 else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6223 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6234 SvFLAGS(sv) &= SVf_BREAK;
6235 SvFLAGS(sv) |= SVTYPEMASK;
6237 sv_type_details = bodies_by_type + type;
6238 if (sv_type_details->arena) {
6239 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6240 &PL_body_roots[type]);
6242 else if (sv_type_details->body_size) {
6243 safefree(SvANY(sv));
6247 /* caller is responsible for freeing the head of the original sv */
6248 if (sv != orig_sv && !SvREFCNT(sv))
6251 /* grab and free next sv, if any */
6259 else if (!iter_sv) {
6261 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6262 AV *const av = (AV*)iter_sv;
6263 if (AvFILLp(av) > -1) {
6264 sv = AvARRAY(av)[AvFILLp(av)--];
6266 else { /* no more elements of current AV to free */
6269 /* restore previous value, squirrelled away */
6270 iter_sv = AvARRAY(av)[AvMAX(av)];
6271 Safefree(AvALLOC(av));
6274 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6275 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6276 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6277 /* no more elements of current HV to free */
6280 /* Restore previous values of iter_sv and hash_index,
6281 * squirrelled away */
6282 assert(!SvOBJECT(sv));
6283 iter_sv = (SV*)SvSTASH(sv);
6284 assert(!SvMAGICAL(sv));
6285 hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6287 /* perl -DA does not like rubbish in SvMAGIC. */
6291 /* free any remaining detritus from the hash struct */
6292 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6293 assert(!HvARRAY((HV*)sv));
6298 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6302 if (!SvREFCNT(sv)) {
6306 if (--(SvREFCNT(sv)))
6310 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6311 "Attempt to free temp prematurely: SV 0x%"UVxf
6312 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6316 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6317 /* make sure SvREFCNT(sv)==0 happens very seldom */
6318 SvREFCNT(sv) = (~(U32)0)/2;
6327 /* This routine curses the sv itself, not the object referenced by sv. So
6328 sv does not have to be ROK. */
6331 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6334 PERL_ARGS_ASSERT_CURSE;
6335 assert(SvOBJECT(sv));
6337 if (PL_defstash && /* Still have a symbol table? */
6344 stash = SvSTASH(sv);
6345 destructor = StashHANDLER(stash,DESTROY);
6347 /* A constant subroutine can have no side effects, so
6348 don't bother calling it. */
6349 && !CvCONST(destructor)
6350 /* Don't bother calling an empty destructor or one that
6351 returns immediately. */
6352 && (CvISXSUB(destructor)
6353 || (CvSTART(destructor)
6354 && (CvSTART(destructor)->op_next->op_type
6356 && (CvSTART(destructor)->op_next->op_type
6358 || CvSTART(destructor)->op_next->op_next->op_type
6364 SV* const tmpref = newRV(sv);
6365 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6367 PUSHSTACKi(PERLSI_DESTROY);
6372 call_sv(MUTABLE_SV(destructor),
6373 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6377 if(SvREFCNT(tmpref) < 2) {
6378 /* tmpref is not kept alive! */
6380 SvRV_set(tmpref, NULL);
6383 SvREFCNT_dec(tmpref);
6385 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6388 if (check_refcnt && SvREFCNT(sv)) {
6389 if (PL_in_clean_objs)
6391 "DESTROY created new reference to dead object '%"HEKf"'",
6392 HEKfARG(HvNAME_HEK(stash)));
6393 /* DESTROY gave object new lease on life */
6399 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6400 SvOBJECT_off(sv); /* Curse the object. */
6401 if (SvTYPE(sv) != SVt_PVIO)
6402 --PL_sv_objcount;/* XXX Might want something more general */
6408 =for apidoc sv_newref
6410 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6417 Perl_sv_newref(pTHX_ SV *const sv)
6419 PERL_UNUSED_CONTEXT;
6428 Decrement an SV's reference count, and if it drops to zero, call
6429 C<sv_clear> to invoke destructors and free up any memory used by
6430 the body; finally, deallocate the SV's head itself.
6431 Normally called via a wrapper macro C<SvREFCNT_dec>.
6437 Perl_sv_free(pTHX_ SV *const sv)
6442 if (SvREFCNT(sv) == 0) {
6443 if (SvFLAGS(sv) & SVf_BREAK)
6444 /* this SV's refcnt has been artificially decremented to
6445 * trigger cleanup */
6447 if (PL_in_clean_all) /* All is fair */
6449 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6450 /* make sure SvREFCNT(sv)==0 happens very seldom */
6451 SvREFCNT(sv) = (~(U32)0)/2;
6454 if (ckWARN_d(WARN_INTERNAL)) {
6455 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6456 Perl_dump_sv_child(aTHX_ sv);
6458 #ifdef DEBUG_LEAKING_SCALARS
6461 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6462 if (PL_warnhook == PERL_WARNHOOK_FATAL
6463 || ckDEAD(packWARN(WARN_INTERNAL))) {
6464 /* Don't let Perl_warner cause us to escape our fate: */
6468 /* This may not return: */
6469 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6470 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6471 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6474 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6479 if (--(SvREFCNT(sv)) > 0)
6481 Perl_sv_free2(aTHX_ sv);
6485 Perl_sv_free2(pTHX_ SV *const sv)
6489 PERL_ARGS_ASSERT_SV_FREE2;
6493 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6494 "Attempt to free temp prematurely: SV 0x%"UVxf
6495 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6499 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6500 /* make sure SvREFCNT(sv)==0 happens very seldom */
6501 SvREFCNT(sv) = (~(U32)0)/2;
6512 Returns the length of the string in the SV. Handles magic and type
6513 coercion and sets the UTF8 flag appropriately. See also C<SvCUR>, which
6514 gives raw access to the xpv_cur slot.
6520 Perl_sv_len(pTHX_ register SV *const sv)
6527 (void)SvPV_const(sv, len);
6532 =for apidoc sv_len_utf8
6534 Returns the number of characters in the string in an SV, counting wide
6535 UTF-8 bytes as a single character. Handles magic and type coercion.
6541 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6542 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6543 * (Note that the mg_len is not the length of the mg_ptr field.
6544 * This allows the cache to store the character length of the string without
6545 * needing to malloc() extra storage to attach to the mg_ptr.)
6550 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6556 return sv_len_utf8_nomg(sv);
6560 Perl_sv_len_utf8_nomg(pTHX_ SV * const sv)
6564 const U8 *s = (U8*)SvPV_nomg_const(sv, len);
6566 PERL_ARGS_ASSERT_SV_LEN_UTF8_NOMG;
6568 if (PL_utf8cache && SvUTF8(sv)) {
6570 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6572 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6573 if (mg->mg_len != -1)
6576 /* We can use the offset cache for a headstart.
6577 The longer value is stored in the first pair. */
6578 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6580 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6584 if (PL_utf8cache < 0) {
6585 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6586 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6590 ulen = Perl_utf8_length(aTHX_ s, s + len);
6591 utf8_mg_len_cache_update(sv, &mg, ulen);
6595 return SvUTF8(sv) ? Perl_utf8_length(aTHX_ s, s + len) : len;
6598 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6601 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6602 STRLEN *const uoffset_p, bool *const at_end)
6604 const U8 *s = start;
6605 STRLEN uoffset = *uoffset_p;
6607 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6609 while (s < send && uoffset) {
6616 else if (s > send) {
6618 /* This is the existing behaviour. Possibly it should be a croak, as
6619 it's actually a bounds error */
6622 *uoffset_p -= uoffset;
6626 /* Given the length of the string in both bytes and UTF-8 characters, decide
6627 whether to walk forwards or backwards to find the byte corresponding to
6628 the passed in UTF-8 offset. */
6630 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6631 STRLEN uoffset, const STRLEN uend)
6633 STRLEN backw = uend - uoffset;
6635 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6637 if (uoffset < 2 * backw) {
6638 /* The assumption is that going forwards is twice the speed of going
6639 forward (that's where the 2 * backw comes from).
6640 (The real figure of course depends on the UTF-8 data.) */
6641 const U8 *s = start;
6643 while (s < send && uoffset--)
6653 while (UTF8_IS_CONTINUATION(*send))
6656 return send - start;
6659 /* For the string representation of the given scalar, find the byte
6660 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6661 give another position in the string, *before* the sought offset, which
6662 (which is always true, as 0, 0 is a valid pair of positions), which should
6663 help reduce the amount of linear searching.
6664 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6665 will be used to reduce the amount of linear searching. The cache will be
6666 created if necessary, and the found value offered to it for update. */
6668 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6669 const U8 *const send, STRLEN uoffset,
6670 STRLEN uoffset0, STRLEN boffset0)
6672 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6674 bool at_end = FALSE;
6676 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6678 assert (uoffset >= uoffset0);
6683 if (!SvREADONLY(sv) && !SvGMAGICAL(sv) && SvPOK(sv)
6685 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6686 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6687 if ((*mgp)->mg_ptr) {
6688 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6689 if (cache[0] == uoffset) {
6690 /* An exact match. */
6693 if (cache[2] == uoffset) {
6694 /* An exact match. */
6698 if (cache[0] < uoffset) {
6699 /* The cache already knows part of the way. */
6700 if (cache[0] > uoffset0) {
6701 /* The cache knows more than the passed in pair */
6702 uoffset0 = cache[0];
6703 boffset0 = cache[1];
6705 if ((*mgp)->mg_len != -1) {
6706 /* And we know the end too. */
6708 + sv_pos_u2b_midway(start + boffset0, send,
6710 (*mgp)->mg_len - uoffset0);
6712 uoffset -= uoffset0;
6714 + sv_pos_u2b_forwards(start + boffset0,
6715 send, &uoffset, &at_end);
6716 uoffset += uoffset0;
6719 else if (cache[2] < uoffset) {
6720 /* We're between the two cache entries. */
6721 if (cache[2] > uoffset0) {
6722 /* and the cache knows more than the passed in pair */
6723 uoffset0 = cache[2];
6724 boffset0 = cache[3];
6728 + sv_pos_u2b_midway(start + boffset0,
6731 cache[0] - uoffset0);
6734 + sv_pos_u2b_midway(start + boffset0,
6737 cache[2] - uoffset0);
6741 else if ((*mgp)->mg_len != -1) {
6742 /* If we can take advantage of a passed in offset, do so. */
6743 /* In fact, offset0 is either 0, or less than offset, so don't
6744 need to worry about the other possibility. */
6746 + sv_pos_u2b_midway(start + boffset0, send,
6748 (*mgp)->mg_len - uoffset0);
6753 if (!found || PL_utf8cache < 0) {
6754 STRLEN real_boffset;
6755 uoffset -= uoffset0;
6756 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6757 send, &uoffset, &at_end);
6758 uoffset += uoffset0;
6760 if (found && PL_utf8cache < 0)
6761 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6763 boffset = real_boffset;
6766 if (PL_utf8cache && !SvGMAGICAL(sv) && SvPOK(sv)) {
6768 utf8_mg_len_cache_update(sv, mgp, uoffset);
6770 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6777 =for apidoc sv_pos_u2b_flags
6779 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6780 the start of the string, to a count of the equivalent number of bytes; if
6781 lenp is non-zero, it does the same to lenp, but this time starting from
6782 the offset, rather than from the start
6783 of the string. Handles type coercion.
6784 I<flags> is passed to C<SvPV_flags>, and usually should be
6785 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6791 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6792 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6793 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6798 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6805 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6807 start = (U8*)SvPV_flags(sv, len, flags);
6809 const U8 * const send = start + len;
6811 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6814 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6815 is 0, and *lenp is already set to that. */) {
6816 /* Convert the relative offset to absolute. */
6817 const STRLEN uoffset2 = uoffset + *lenp;
6818 const STRLEN boffset2
6819 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6820 uoffset, boffset) - boffset;
6834 =for apidoc sv_pos_u2b
6836 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6837 the start of the string, to a count of the equivalent number of bytes; if
6838 lenp is non-zero, it does the same to lenp, but this time starting from
6839 the offset, rather than from the start of the string. Handles magic and
6842 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6849 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6850 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6851 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6855 /* This function is subject to size and sign problems */
6858 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6860 PERL_ARGS_ASSERT_SV_POS_U2B;
6863 STRLEN ulen = (STRLEN)*lenp;
6864 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6865 SV_GMAGIC|SV_CONST_RETURN);
6868 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6869 SV_GMAGIC|SV_CONST_RETURN);
6874 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6877 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6878 if (SvREADONLY(sv) || SvGMAGICAL(sv) || !SvPOK(sv))
6881 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6882 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6883 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6887 (*mgp)->mg_len = ulen;
6888 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6889 if (ulen != (STRLEN) (*mgp)->mg_len)
6890 (*mgp)->mg_len = -1;
6893 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6894 byte length pairing. The (byte) length of the total SV is passed in too,
6895 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6896 may not have updated SvCUR, so we can't rely on reading it directly.
6898 The proffered utf8/byte length pairing isn't used if the cache already has
6899 two pairs, and swapping either for the proffered pair would increase the
6900 RMS of the intervals between known byte offsets.
6902 The cache itself consists of 4 STRLEN values
6903 0: larger UTF-8 offset
6904 1: corresponding byte offset
6905 2: smaller UTF-8 offset
6906 3: corresponding byte offset
6908 Unused cache pairs have the value 0, 0.
6909 Keeping the cache "backwards" means that the invariant of
6910 cache[0] >= cache[2] is maintained even with empty slots, which means that
6911 the code that uses it doesn't need to worry if only 1 entry has actually
6912 been set to non-zero. It also makes the "position beyond the end of the
6913 cache" logic much simpler, as the first slot is always the one to start
6917 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6918 const STRLEN utf8, const STRLEN blen)
6922 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6927 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6928 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6929 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6931 (*mgp)->mg_len = -1;
6935 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6936 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6937 (*mgp)->mg_ptr = (char *) cache;
6941 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6942 /* SvPOKp() because it's possible that sv has string overloading, and
6943 therefore is a reference, hence SvPVX() is actually a pointer.
6944 This cures the (very real) symptoms of RT 69422, but I'm not actually
6945 sure whether we should even be caching the results of UTF-8
6946 operations on overloading, given that nothing stops overloading
6947 returning a different value every time it's called. */
6948 const U8 *start = (const U8 *) SvPVX_const(sv);
6949 const STRLEN realutf8 = utf8_length(start, start + byte);
6951 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6955 /* Cache is held with the later position first, to simplify the code
6956 that deals with unbounded ends. */
6958 ASSERT_UTF8_CACHE(cache);
6959 if (cache[1] == 0) {
6960 /* Cache is totally empty */
6963 } else if (cache[3] == 0) {
6964 if (byte > cache[1]) {
6965 /* New one is larger, so goes first. */
6966 cache[2] = cache[0];
6967 cache[3] = cache[1];
6975 #define THREEWAY_SQUARE(a,b,c,d) \
6976 ((float)((d) - (c))) * ((float)((d) - (c))) \
6977 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6978 + ((float)((b) - (a))) * ((float)((b) - (a)))
6980 /* Cache has 2 slots in use, and we know three potential pairs.
6981 Keep the two that give the lowest RMS distance. Do the
6982 calculation in bytes simply because we always know the byte
6983 length. squareroot has the same ordering as the positive value,
6984 so don't bother with the actual square root. */
6985 if (byte > cache[1]) {
6986 /* New position is after the existing pair of pairs. */
6987 const float keep_earlier
6988 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6989 const float keep_later
6990 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6992 if (keep_later < keep_earlier) {
6993 cache[2] = cache[0];
6994 cache[3] = cache[1];
7003 else if (byte > cache[3]) {
7004 /* New position is between the existing pair of pairs. */
7005 const float keep_earlier
7006 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7007 const float keep_later
7008 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7010 if (keep_later < keep_earlier) {
7020 /* New position is before the existing pair of pairs. */
7021 const float keep_earlier
7022 = THREEWAY_SQUARE(0, byte, cache[3], blen);
7023 const float keep_later
7024 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7026 if (keep_later < keep_earlier) {
7031 cache[0] = cache[2];
7032 cache[1] = cache[3];
7038 ASSERT_UTF8_CACHE(cache);
7041 /* We already know all of the way, now we may be able to walk back. The same
7042 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7043 backward is half the speed of walking forward. */
7045 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7046 const U8 *end, STRLEN endu)
7048 const STRLEN forw = target - s;
7049 STRLEN backw = end - target;
7051 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7053 if (forw < 2 * backw) {
7054 return utf8_length(s, target);
7057 while (end > target) {
7059 while (UTF8_IS_CONTINUATION(*end)) {
7068 =for apidoc sv_pos_b2u
7070 Converts the value pointed to by offsetp from a count of bytes from the
7071 start of the string, to a count of the equivalent number of UTF-8 chars.
7072 Handles magic and type coercion.
7078 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7079 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7084 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7087 const STRLEN byte = *offsetp;
7088 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7094 PERL_ARGS_ASSERT_SV_POS_B2U;
7099 s = (const U8*)SvPV_const(sv, blen);
7102 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7103 ", byte=%"UVuf, (UV)blen, (UV)byte);
7109 && SvTYPE(sv) >= SVt_PVMG
7110 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7113 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7114 if (cache[1] == byte) {
7115 /* An exact match. */
7116 *offsetp = cache[0];
7119 if (cache[3] == byte) {
7120 /* An exact match. */
7121 *offsetp = cache[2];
7125 if (cache[1] < byte) {
7126 /* We already know part of the way. */
7127 if (mg->mg_len != -1) {
7128 /* Actually, we know the end too. */
7130 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7131 s + blen, mg->mg_len - cache[0]);
7133 len = cache[0] + utf8_length(s + cache[1], send);
7136 else if (cache[3] < byte) {
7137 /* We're between the two cached pairs, so we do the calculation
7138 offset by the byte/utf-8 positions for the earlier pair,
7139 then add the utf-8 characters from the string start to
7141 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7142 s + cache[1], cache[0] - cache[2])
7146 else { /* cache[3] > byte */
7147 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7151 ASSERT_UTF8_CACHE(cache);
7153 } else if (mg->mg_len != -1) {
7154 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7158 if (!found || PL_utf8cache < 0) {
7159 const STRLEN real_len = utf8_length(s, send);
7161 if (found && PL_utf8cache < 0)
7162 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7169 utf8_mg_len_cache_update(sv, &mg, len);
7171 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7176 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7177 STRLEN real, SV *const sv)
7179 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7181 /* As this is debugging only code, save space by keeping this test here,
7182 rather than inlining it in all the callers. */
7183 if (from_cache == real)
7186 /* Need to turn the assertions off otherwise we may recurse infinitely
7187 while printing error messages. */
7188 SAVEI8(PL_utf8cache);
7190 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7191 func, (UV) from_cache, (UV) real, SVfARG(sv));
7197 Returns a boolean indicating whether the strings in the two SVs are
7198 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7199 coerce its args to strings if necessary.
7201 =for apidoc sv_eq_flags
7203 Returns a boolean indicating whether the strings in the two SVs are
7204 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7205 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7211 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7219 SV* svrecode = NULL;
7226 /* if pv1 and pv2 are the same, second SvPV_const call may
7227 * invalidate pv1 (if we are handling magic), so we may need to
7229 if (sv1 == sv2 && flags & SV_GMAGIC
7230 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7231 pv1 = SvPV_const(sv1, cur1);
7232 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7234 pv1 = SvPV_flags_const(sv1, cur1, flags);
7242 pv2 = SvPV_flags_const(sv2, cur2, flags);
7244 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7245 /* Differing utf8ness.
7246 * Do not UTF8size the comparands as a side-effect. */
7249 svrecode = newSVpvn(pv2, cur2);
7250 sv_recode_to_utf8(svrecode, PL_encoding);
7251 pv2 = SvPV_const(svrecode, cur2);
7254 svrecode = newSVpvn(pv1, cur1);
7255 sv_recode_to_utf8(svrecode, PL_encoding);
7256 pv1 = SvPV_const(svrecode, cur1);
7258 /* Now both are in UTF-8. */
7260 SvREFCNT_dec(svrecode);
7266 /* sv1 is the UTF-8 one */
7267 return bytes_cmp_utf8((const U8*)pv2, cur2,
7268 (const U8*)pv1, cur1) == 0;
7271 /* sv2 is the UTF-8 one */
7272 return bytes_cmp_utf8((const U8*)pv1, cur1,
7273 (const U8*)pv2, cur2) == 0;
7279 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7281 SvREFCNT_dec(svrecode);
7289 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7290 string in C<sv1> is less than, equal to, or greater than the string in
7291 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7292 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7294 =for apidoc sv_cmp_flags
7296 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7297 string in C<sv1> is less than, equal to, or greater than the string in
7298 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7299 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7300 also C<sv_cmp_locale_flags>.
7306 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7308 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7312 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7317 const char *pv1, *pv2;
7320 SV *svrecode = NULL;
7327 pv1 = SvPV_flags_const(sv1, cur1, flags);
7334 pv2 = SvPV_flags_const(sv2, cur2, flags);
7336 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7337 /* Differing utf8ness.
7338 * Do not UTF8size the comparands as a side-effect. */
7341 svrecode = newSVpvn(pv2, cur2);
7342 sv_recode_to_utf8(svrecode, PL_encoding);
7343 pv2 = SvPV_const(svrecode, cur2);
7346 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7347 (const U8*)pv1, cur1);
7348 return retval ? retval < 0 ? -1 : +1 : 0;
7353 svrecode = newSVpvn(pv1, cur1);
7354 sv_recode_to_utf8(svrecode, PL_encoding);
7355 pv1 = SvPV_const(svrecode, cur1);
7358 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7359 (const U8*)pv2, cur2);
7360 return retval ? retval < 0 ? -1 : +1 : 0;
7366 cmp = cur2 ? -1 : 0;
7370 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7373 cmp = retval < 0 ? -1 : 1;
7374 } else if (cur1 == cur2) {
7377 cmp = cur1 < cur2 ? -1 : 1;
7381 SvREFCNT_dec(svrecode);
7389 =for apidoc sv_cmp_locale
7391 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7392 'use bytes' aware, handles get magic, and will coerce its args to strings
7393 if necessary. See also C<sv_cmp>.
7395 =for apidoc sv_cmp_locale_flags
7397 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7398 'use bytes' aware and will coerce its args to strings if necessary. If the
7399 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7405 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7407 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7411 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7415 #ifdef USE_LOCALE_COLLATE
7421 if (PL_collation_standard)
7425 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7427 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7429 if (!pv1 || !len1) {
7440 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7443 return retval < 0 ? -1 : 1;
7446 * When the result of collation is equality, that doesn't mean
7447 * that there are no differences -- some locales exclude some
7448 * characters from consideration. So to avoid false equalities,
7449 * we use the raw string as a tiebreaker.
7455 #endif /* USE_LOCALE_COLLATE */
7457 return sv_cmp(sv1, sv2);
7461 #ifdef USE_LOCALE_COLLATE
7464 =for apidoc sv_collxfrm
7466 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7467 C<sv_collxfrm_flags>.
7469 =for apidoc sv_collxfrm_flags
7471 Add Collate Transform magic to an SV if it doesn't already have it. If the
7472 flags contain SV_GMAGIC, it handles get-magic.
7474 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7475 scalar data of the variable, but transformed to such a format that a normal
7476 memory comparison can be used to compare the data according to the locale
7483 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7488 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7490 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7491 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7497 Safefree(mg->mg_ptr);
7498 s = SvPV_flags_const(sv, len, flags);
7499 if ((xf = mem_collxfrm(s, len, &xlen))) {
7501 #ifdef PERL_OLD_COPY_ON_WRITE
7503 sv_force_normal_flags(sv, 0);
7505 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7519 if (mg && mg->mg_ptr) {
7521 return mg->mg_ptr + sizeof(PL_collation_ix);
7529 #endif /* USE_LOCALE_COLLATE */
7532 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7534 SV * const tsv = newSV(0);
7537 sv_gets(tsv, fp, 0);
7538 sv_utf8_upgrade_nomg(tsv);
7539 SvCUR_set(sv,append);
7542 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7546 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7549 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7550 /* Grab the size of the record we're getting */
7551 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7558 /* VMS wants read instead of fread, because fread doesn't respect */
7559 /* RMS record boundaries. This is not necessarily a good thing to be */
7560 /* doing, but we've got no other real choice - except avoid stdio
7561 as implementation - perhaps write a :vms layer ?
7563 fd = PerlIO_fileno(fp);
7565 bytesread = PerlLIO_read(fd, buffer, recsize);
7567 else /* in-memory file from PerlIO::Scalar */
7570 bytesread = PerlIO_read(fp, buffer, recsize);
7575 SvCUR_set(sv, bytesread + append);
7576 buffer[bytesread] = '\0';
7577 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7583 Get a line from the filehandle and store it into the SV, optionally
7584 appending to the currently-stored string. If C<append> is not 0, the
7585 line is appended to the SV instead of overwriting it. C<append> should
7586 be set to the byte offset that the appended string should start at
7587 in the SV (typically, C<SvCUR(sv)> is a suitable choice).
7593 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7604 PERL_ARGS_ASSERT_SV_GETS;
7606 if (SvTHINKFIRST(sv))
7607 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7608 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7610 However, perlbench says it's slower, because the existing swipe code
7611 is faster than copy on write.
7612 Swings and roundabouts. */
7613 SvUPGRADE(sv, SVt_PV);
7616 if (PerlIO_isutf8(fp)) {
7618 sv_utf8_upgrade_nomg(sv);
7619 sv_pos_u2b(sv,&append,0);
7621 } else if (SvUTF8(sv)) {
7622 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7630 if (PerlIO_isutf8(fp))
7633 if (IN_PERL_COMPILETIME) {
7634 /* we always read code in line mode */
7638 else if (RsSNARF(PL_rs)) {
7639 /* If it is a regular disk file use size from stat() as estimate
7640 of amount we are going to read -- may result in mallocing
7641 more memory than we really need if the layers below reduce
7642 the size we read (e.g. CRLF or a gzip layer).
7645 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7646 const Off_t offset = PerlIO_tell(fp);
7647 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7648 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7654 else if (RsRECORD(PL_rs)) {
7655 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7657 else if (RsPARA(PL_rs)) {
7663 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7664 if (PerlIO_isutf8(fp)) {
7665 rsptr = SvPVutf8(PL_rs, rslen);
7668 if (SvUTF8(PL_rs)) {
7669 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7670 Perl_croak(aTHX_ "Wide character in $/");
7673 rsptr = SvPV_const(PL_rs, rslen);
7677 rslast = rslen ? rsptr[rslen - 1] : '\0';
7679 if (rspara) { /* have to do this both before and after */
7680 do { /* to make sure file boundaries work right */
7683 i = PerlIO_getc(fp);
7687 PerlIO_ungetc(fp,i);
7693 /* See if we know enough about I/O mechanism to cheat it ! */
7695 /* This used to be #ifdef test - it is made run-time test for ease
7696 of abstracting out stdio interface. One call should be cheap
7697 enough here - and may even be a macro allowing compile
7701 if (PerlIO_fast_gets(fp)) {
7704 * We're going to steal some values from the stdio struct
7705 * and put EVERYTHING in the innermost loop into registers.
7711 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7712 /* An ungetc()d char is handled separately from the regular
7713 * buffer, so we getc() it back out and stuff it in the buffer.
7715 i = PerlIO_getc(fp);
7716 if (i == EOF) return 0;
7717 *(--((*fp)->_ptr)) = (unsigned char) i;
7721 /* Here is some breathtakingly efficient cheating */
7723 cnt = PerlIO_get_cnt(fp); /* get count into register */
7724 /* make sure we have the room */
7725 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7726 /* Not room for all of it
7727 if we are looking for a separator and room for some
7729 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7730 /* just process what we have room for */
7731 shortbuffered = cnt - SvLEN(sv) + append + 1;
7732 cnt -= shortbuffered;
7736 /* remember that cnt can be negative */
7737 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7742 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7743 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7744 DEBUG_P(PerlIO_printf(Perl_debug_log,
7745 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7746 DEBUG_P(PerlIO_printf(Perl_debug_log,
7747 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7748 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7749 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7754 while (cnt > 0) { /* this | eat */
7756 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7757 goto thats_all_folks; /* screams | sed :-) */
7761 Copy(ptr, bp, cnt, char); /* this | eat */
7762 bp += cnt; /* screams | dust */
7763 ptr += cnt; /* louder | sed :-) */
7765 assert (!shortbuffered);
7766 goto cannot_be_shortbuffered;
7770 if (shortbuffered) { /* oh well, must extend */
7771 cnt = shortbuffered;
7773 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7775 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7776 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7780 cannot_be_shortbuffered:
7781 DEBUG_P(PerlIO_printf(Perl_debug_log,
7782 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7783 PTR2UV(ptr),(long)cnt));
7784 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7786 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7787 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7788 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7789 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7791 /* This used to call 'filbuf' in stdio form, but as that behaves like
7792 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7793 another abstraction. */
7794 i = PerlIO_getc(fp); /* get more characters */
7796 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7797 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7798 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7799 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7801 cnt = PerlIO_get_cnt(fp);
7802 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7803 DEBUG_P(PerlIO_printf(Perl_debug_log,
7804 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7806 if (i == EOF) /* all done for ever? */
7807 goto thats_really_all_folks;
7809 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7811 SvGROW(sv, bpx + cnt + 2);
7812 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7814 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7816 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7817 goto thats_all_folks;
7821 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7822 memNE((char*)bp - rslen, rsptr, rslen))
7823 goto screamer; /* go back to the fray */
7824 thats_really_all_folks:
7826 cnt += shortbuffered;
7827 DEBUG_P(PerlIO_printf(Perl_debug_log,
7828 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7829 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7830 DEBUG_P(PerlIO_printf(Perl_debug_log,
7831 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7832 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7833 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7835 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7836 DEBUG_P(PerlIO_printf(Perl_debug_log,
7837 "Screamer: done, len=%ld, string=|%.*s|\n",
7838 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7842 /*The big, slow, and stupid way. */
7843 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7844 STDCHAR *buf = NULL;
7845 Newx(buf, 8192, STDCHAR);
7853 const STDCHAR * const bpe = buf + sizeof(buf);
7855 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7856 ; /* keep reading */
7860 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7861 /* Accommodate broken VAXC compiler, which applies U8 cast to
7862 * both args of ?: operator, causing EOF to change into 255
7865 i = (U8)buf[cnt - 1];
7871 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7873 sv_catpvn_nomg(sv, (char *) buf, cnt);
7875 sv_setpvn(sv, (char *) buf, cnt); /* "nomg" is implied */
7877 if (i != EOF && /* joy */
7879 SvCUR(sv) < rslen ||
7880 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7884 * If we're reading from a TTY and we get a short read,
7885 * indicating that the user hit his EOF character, we need
7886 * to notice it now, because if we try to read from the TTY
7887 * again, the EOF condition will disappear.
7889 * The comparison of cnt to sizeof(buf) is an optimization
7890 * that prevents unnecessary calls to feof().
7894 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7898 #ifdef USE_HEAP_INSTEAD_OF_STACK
7903 if (rspara) { /* have to do this both before and after */
7904 while (i != EOF) { /* to make sure file boundaries work right */
7905 i = PerlIO_getc(fp);
7907 PerlIO_ungetc(fp,i);
7913 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7919 Auto-increment of the value in the SV, doing string to numeric conversion
7920 if necessary. Handles 'get' magic and operator overloading.
7926 Perl_sv_inc(pTHX_ register SV *const sv)
7935 =for apidoc sv_inc_nomg
7937 Auto-increment of the value in the SV, doing string to numeric conversion
7938 if necessary. Handles operator overloading. Skips handling 'get' magic.
7944 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7952 if (SvTHINKFIRST(sv)) {
7953 if (SvIsCOW(sv) || isGV_with_GP(sv))
7954 sv_force_normal_flags(sv, 0);
7955 if (SvREADONLY(sv)) {
7956 if (IN_PERL_RUNTIME)
7957 Perl_croak_no_modify(aTHX);
7961 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7963 i = PTR2IV(SvRV(sv));
7968 flags = SvFLAGS(sv);
7969 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7970 /* It's (privately or publicly) a float, but not tested as an
7971 integer, so test it to see. */
7973 flags = SvFLAGS(sv);
7975 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7976 /* It's publicly an integer, or privately an integer-not-float */
7977 #ifdef PERL_PRESERVE_IVUV
7981 if (SvUVX(sv) == UV_MAX)
7982 sv_setnv(sv, UV_MAX_P1);
7984 (void)SvIOK_only_UV(sv);
7985 SvUV_set(sv, SvUVX(sv) + 1);
7987 if (SvIVX(sv) == IV_MAX)
7988 sv_setuv(sv, (UV)IV_MAX + 1);
7990 (void)SvIOK_only(sv);
7991 SvIV_set(sv, SvIVX(sv) + 1);
7996 if (flags & SVp_NOK) {
7997 const NV was = SvNVX(sv);
7998 if (NV_OVERFLOWS_INTEGERS_AT &&
7999 was >= NV_OVERFLOWS_INTEGERS_AT) {
8000 /* diag_listed_as: Lost precision when %s %f by 1 */
8001 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8002 "Lost precision when incrementing %" NVff " by 1",
8005 (void)SvNOK_only(sv);
8006 SvNV_set(sv, was + 1.0);
8010 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
8011 if ((flags & SVTYPEMASK) < SVt_PVIV)
8012 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
8013 (void)SvIOK_only(sv);
8018 while (isALPHA(*d)) d++;
8019 while (isDIGIT(*d)) d++;
8020 if (d < SvEND(sv)) {
8021 #ifdef PERL_PRESERVE_IVUV
8022 /* Got to punt this as an integer if needs be, but we don't issue
8023 warnings. Probably ought to make the sv_iv_please() that does
8024 the conversion if possible, and silently. */
8025 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8026 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8027 /* Need to try really hard to see if it's an integer.
8028 9.22337203685478e+18 is an integer.
8029 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8030 so $a="9.22337203685478e+18"; $a+0; $a++
8031 needs to be the same as $a="9.22337203685478e+18"; $a++
8038 /* sv_2iv *should* have made this an NV */
8039 if (flags & SVp_NOK) {
8040 (void)SvNOK_only(sv);
8041 SvNV_set(sv, SvNVX(sv) + 1.0);
8044 /* I don't think we can get here. Maybe I should assert this
8045 And if we do get here I suspect that sv_setnv will croak. NWC
8047 #if defined(USE_LONG_DOUBLE)
8048 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",
8049 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8051 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8052 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8055 #endif /* PERL_PRESERVE_IVUV */
8056 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8060 while (d >= SvPVX_const(sv)) {
8068 /* MKS: The original code here died if letters weren't consecutive.
8069 * at least it didn't have to worry about non-C locales. The
8070 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8071 * arranged in order (although not consecutively) and that only
8072 * [A-Za-z] are accepted by isALPHA in the C locale.
8074 if (*d != 'z' && *d != 'Z') {
8075 do { ++*d; } while (!isALPHA(*d));
8078 *(d--) -= 'z' - 'a';
8083 *(d--) -= 'z' - 'a' + 1;
8087 /* oh,oh, the number grew */
8088 SvGROW(sv, SvCUR(sv) + 2);
8089 SvCUR_set(sv, SvCUR(sv) + 1);
8090 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8101 Auto-decrement of the value in the SV, doing string to numeric conversion
8102 if necessary. Handles 'get' magic and operator overloading.
8108 Perl_sv_dec(pTHX_ register SV *const sv)
8118 =for apidoc sv_dec_nomg
8120 Auto-decrement of the value in the SV, doing string to numeric conversion
8121 if necessary. Handles operator overloading. Skips handling 'get' magic.
8127 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8134 if (SvTHINKFIRST(sv)) {
8135 if (SvIsCOW(sv) || isGV_with_GP(sv))
8136 sv_force_normal_flags(sv, 0);
8137 if (SvREADONLY(sv)) {
8138 if (IN_PERL_RUNTIME)
8139 Perl_croak_no_modify(aTHX);
8143 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8145 i = PTR2IV(SvRV(sv));
8150 /* Unlike sv_inc we don't have to worry about string-never-numbers
8151 and keeping them magic. But we mustn't warn on punting */
8152 flags = SvFLAGS(sv);
8153 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8154 /* It's publicly an integer, or privately an integer-not-float */
8155 #ifdef PERL_PRESERVE_IVUV
8159 if (SvUVX(sv) == 0) {
8160 (void)SvIOK_only(sv);
8164 (void)SvIOK_only_UV(sv);
8165 SvUV_set(sv, SvUVX(sv) - 1);
8168 if (SvIVX(sv) == IV_MIN) {
8169 sv_setnv(sv, (NV)IV_MIN);
8173 (void)SvIOK_only(sv);
8174 SvIV_set(sv, SvIVX(sv) - 1);
8179 if (flags & SVp_NOK) {
8182 const NV was = SvNVX(sv);
8183 if (NV_OVERFLOWS_INTEGERS_AT &&
8184 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8185 /* diag_listed_as: Lost precision when %s %f by 1 */
8186 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8187 "Lost precision when decrementing %" NVff " by 1",
8190 (void)SvNOK_only(sv);
8191 SvNV_set(sv, was - 1.0);
8195 if (!(flags & SVp_POK)) {
8196 if ((flags & SVTYPEMASK) < SVt_PVIV)
8197 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8199 (void)SvIOK_only(sv);
8202 #ifdef PERL_PRESERVE_IVUV
8204 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8205 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8206 /* Need to try really hard to see if it's an integer.
8207 9.22337203685478e+18 is an integer.
8208 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8209 so $a="9.22337203685478e+18"; $a+0; $a--
8210 needs to be the same as $a="9.22337203685478e+18"; $a--
8217 /* sv_2iv *should* have made this an NV */
8218 if (flags & SVp_NOK) {
8219 (void)SvNOK_only(sv);
8220 SvNV_set(sv, SvNVX(sv) - 1.0);
8223 /* I don't think we can get here. Maybe I should assert this
8224 And if we do get here I suspect that sv_setnv will croak. NWC
8226 #if defined(USE_LONG_DOUBLE)
8227 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",
8228 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8230 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8231 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8235 #endif /* PERL_PRESERVE_IVUV */
8236 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8239 /* this define is used to eliminate a chunk of duplicated but shared logic
8240 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8241 * used anywhere but here - yves
8243 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8246 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8250 =for apidoc sv_mortalcopy
8252 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8253 The new SV is marked as mortal. It will be destroyed "soon", either by an
8254 explicit call to FREETMPS, or by an implicit call at places such as
8255 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8260 /* Make a string that will exist for the duration of the expression
8261 * evaluation. Actually, it may have to last longer than that, but
8262 * hopefully we won't free it until it has been assigned to a
8263 * permanent location. */
8266 Perl_sv_mortalcopy_flags(pTHX_ SV *const oldstr, U32 flags)
8271 if (flags & SV_GMAGIC)
8272 SvGETMAGIC(oldstr); /* before new_SV, in case it dies */
8274 sv_setsv_flags(sv,oldstr,flags & ~SV_GMAGIC);
8275 PUSH_EXTEND_MORTAL__SV_C(sv);
8281 =for apidoc sv_newmortal
8283 Creates a new null SV which is mortal. The reference count of the SV is
8284 set to 1. It will be destroyed "soon", either by an explicit call to
8285 FREETMPS, or by an implicit call at places such as statement boundaries.
8286 See also C<sv_mortalcopy> and C<sv_2mortal>.
8292 Perl_sv_newmortal(pTHX)
8298 SvFLAGS(sv) = SVs_TEMP;
8299 PUSH_EXTEND_MORTAL__SV_C(sv);
8305 =for apidoc newSVpvn_flags
8307 Creates a new SV and copies a string into it. The reference count for the
8308 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8309 string. You are responsible for ensuring that the source string is at least
8310 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8311 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8312 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8313 returning. If C<SVf_UTF8> is set, C<s>
8314 is considered to be in UTF-8 and the
8315 C<SVf_UTF8> flag will be set on the new SV.
8316 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8318 #define newSVpvn_utf8(s, len, u) \
8319 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8325 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8330 /* All the flags we don't support must be zero.
8331 And we're new code so I'm going to assert this from the start. */
8332 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8334 sv_setpvn(sv,s,len);
8336 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8337 * and do what it does ourselves here.
8338 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8339 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8340 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8341 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8344 SvFLAGS(sv) |= flags;
8346 if(flags & SVs_TEMP){
8347 PUSH_EXTEND_MORTAL__SV_C(sv);
8354 =for apidoc sv_2mortal
8356 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8357 by an explicit call to FREETMPS, or by an implicit call at places such as
8358 statement boundaries. SvTEMP() is turned on which means that the SV's
8359 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8360 and C<sv_mortalcopy>.
8366 Perl_sv_2mortal(pTHX_ register SV *const sv)
8371 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8373 PUSH_EXTEND_MORTAL__SV_C(sv);
8381 Creates a new SV and copies a string into it. The reference count for the
8382 SV is set to 1. If C<len> is zero, Perl will compute the length using
8383 strlen(). For efficiency, consider using C<newSVpvn> instead.
8389 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8395 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8400 =for apidoc newSVpvn
8402 Creates a new SV and copies a buffer into it, which may contain NUL characters
8403 (C<\0>) and other binary data. The reference count for the SV is set to 1.
8404 Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
8405 are responsible for ensuring that the source buffer is at least
8406 C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
8413 Perl_newSVpvn(pTHX_ const char *const buffer, const STRLEN len)
8419 sv_setpvn(sv,buffer,len);
8424 =for apidoc newSVhek
8426 Creates a new SV from the hash key structure. It will generate scalars that
8427 point to the shared string table where possible. Returns a new (undefined)
8428 SV if the hek is NULL.
8434 Perl_newSVhek(pTHX_ const HEK *const hek)
8444 if (HEK_LEN(hek) == HEf_SVKEY) {
8445 return newSVsv(*(SV**)HEK_KEY(hek));
8447 const int flags = HEK_FLAGS(hek);
8448 if (flags & HVhek_WASUTF8) {
8450 Andreas would like keys he put in as utf8 to come back as utf8
8452 STRLEN utf8_len = HEK_LEN(hek);
8453 SV * const sv = newSV_type(SVt_PV);
8454 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8455 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8456 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8459 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8460 /* We don't have a pointer to the hv, so we have to replicate the
8461 flag into every HEK. This hv is using custom a hasing
8462 algorithm. Hence we can't return a shared string scalar, as
8463 that would contain the (wrong) hash value, and might get passed
8464 into an hv routine with a regular hash.
8465 Similarly, a hash that isn't using shared hash keys has to have
8466 the flag in every key so that we know not to try to call
8467 share_hek_hek on it. */
8469 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8474 /* This will be overwhelminly the most common case. */
8476 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8477 more efficient than sharepvn(). */
8481 sv_upgrade(sv, SVt_PV);
8482 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8483 SvCUR_set(sv, HEK_LEN(hek));
8496 =for apidoc newSVpvn_share
8498 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8499 table. If the string does not already exist in the table, it is
8500 created first. Turns on READONLY and FAKE. If the C<hash> parameter
8501 is non-zero, that value is used; otherwise the hash is computed.
8502 The string's hash can later be retrieved from the SV
8503 with the C<SvSHARED_HASH()> macro. The idea here is
8504 that as the string table is used for shared hash keys these strings will have
8505 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8511 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8515 bool is_utf8 = FALSE;
8516 const char *const orig_src = src;
8519 STRLEN tmplen = -len;
8521 /* See the note in hv.c:hv_fetch() --jhi */
8522 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8526 PERL_HASH(hash, src, len);
8528 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8529 changes here, update it there too. */
8530 sv_upgrade(sv, SVt_PV);
8531 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8539 if (src != orig_src)
8545 =for apidoc newSVpv_share
8547 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8554 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8556 return newSVpvn_share(src, strlen(src), hash);
8559 #if defined(PERL_IMPLICIT_CONTEXT)
8561 /* pTHX_ magic can't cope with varargs, so this is a no-context
8562 * version of the main function, (which may itself be aliased to us).
8563 * Don't access this version directly.
8567 Perl_newSVpvf_nocontext(const char *const pat, ...)
8573 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8575 va_start(args, pat);
8576 sv = vnewSVpvf(pat, &args);
8583 =for apidoc newSVpvf
8585 Creates a new SV and initializes it with the string formatted like
8592 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8597 PERL_ARGS_ASSERT_NEWSVPVF;
8599 va_start(args, pat);
8600 sv = vnewSVpvf(pat, &args);
8605 /* backend for newSVpvf() and newSVpvf_nocontext() */
8608 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8613 PERL_ARGS_ASSERT_VNEWSVPVF;
8616 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8623 Creates a new SV and copies a floating point value into it.
8624 The reference count for the SV is set to 1.
8630 Perl_newSVnv(pTHX_ const NV n)
8643 Creates a new SV and copies an integer into it. The reference count for the
8650 Perl_newSViv(pTHX_ const IV i)
8663 Creates a new SV and copies an unsigned integer into it.
8664 The reference count for the SV is set to 1.
8670 Perl_newSVuv(pTHX_ const UV u)
8681 =for apidoc newSV_type
8683 Creates a new SV, of the type specified. The reference count for the new SV
8690 Perl_newSV_type(pTHX_ const svtype type)
8695 sv_upgrade(sv, type);
8700 =for apidoc newRV_noinc
8702 Creates an RV wrapper for an SV. The reference count for the original
8703 SV is B<not> incremented.
8709 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8712 SV *sv = newSV_type(SVt_IV);
8714 PERL_ARGS_ASSERT_NEWRV_NOINC;
8717 SvRV_set(sv, tmpRef);
8722 /* newRV_inc is the official function name to use now.
8723 * newRV_inc is in fact #defined to newRV in sv.h
8727 Perl_newRV(pTHX_ SV *const sv)
8731 PERL_ARGS_ASSERT_NEWRV;
8733 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8739 Creates a new SV which is an exact duplicate of the original SV.
8746 Perl_newSVsv(pTHX_ register SV *const old)
8753 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8754 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8757 /* Do this here, otherwise we leak the new SV if this croaks. */
8760 /* SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8761 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8762 sv_setsv_flags(sv, old, SV_NOSTEAL);
8767 =for apidoc sv_reset
8769 Underlying implementation for the C<reset> Perl function.
8770 Note that the perl-level function is vaguely deprecated.
8776 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8778 PERL_ARGS_ASSERT_SV_RESET;
8780 sv_resetpvn(*s ? s : NULL, strlen(s), stash);
8784 Perl_sv_resetpvn(pTHX_ const char *s, STRLEN len, HV * const stash)
8787 char todo[PERL_UCHAR_MAX+1];
8793 if (!s) { /* reset ?? searches */
8794 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8796 const U32 count = mg->mg_len / sizeof(PMOP**);
8797 PMOP **pmp = (PMOP**) mg->mg_ptr;
8798 PMOP *const *const end = pmp + count;
8802 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8804 (*pmp)->op_pmflags &= ~PMf_USED;
8812 /* reset variables */
8814 if (!HvARRAY(stash))
8817 Zero(todo, 256, char);
8821 I32 i = (unsigned char)*s;
8825 max = (unsigned char)*s++;
8826 for ( ; i <= max; i++) {
8829 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8831 for (entry = HvARRAY(stash)[i];
8833 entry = HeNEXT(entry))
8838 if (!todo[(U8)*HeKEY(entry)])
8840 gv = MUTABLE_GV(HeVAL(entry));
8843 if (SvTHINKFIRST(sv)) {
8844 if (!SvREADONLY(sv) && SvROK(sv))
8846 /* XXX Is this continue a bug? Why should THINKFIRST
8847 exempt us from resetting arrays and hashes? */
8851 if (SvTYPE(sv) >= SVt_PV) {
8853 if (SvPVX_const(sv) != NULL)
8861 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8863 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8866 # if defined(USE_ENVIRON_ARRAY)
8869 # endif /* USE_ENVIRON_ARRAY */
8880 Using various gambits, try to get an IO from an SV: the IO slot if its a
8881 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8882 named after the PV if we're a string.
8884 'Get' magic is ignored on the sv passed in, but will be called on
8885 C<SvRV(sv)> if sv is an RV.
8891 Perl_sv_2io(pTHX_ SV *const sv)
8896 PERL_ARGS_ASSERT_SV_2IO;
8898 switch (SvTYPE(sv)) {
8900 io = MUTABLE_IO(sv);
8904 if (isGV_with_GP(sv)) {
8905 gv = MUTABLE_GV(sv);
8908 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
8909 HEKfARG(GvNAME_HEK(gv)));
8915 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8917 SvGETMAGIC(SvRV(sv));
8918 return sv_2io(SvRV(sv));
8920 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
8927 if (SvGMAGICAL(sv)) {
8928 newsv = sv_newmortal();
8929 sv_setsv_nomg(newsv, sv);
8931 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
8941 Using various gambits, try to get a CV from an SV; in addition, try if
8942 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8943 The flags in C<lref> are passed to gv_fetchsv.
8949 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8955 PERL_ARGS_ASSERT_SV_2CV;
8962 switch (SvTYPE(sv)) {
8966 return MUTABLE_CV(sv);
8976 sv = amagic_deref_call(sv, to_cv_amg);
8979 if (SvTYPE(sv) == SVt_PVCV) {
8980 cv = MUTABLE_CV(sv);
8985 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
8986 gv = MUTABLE_GV(sv);
8988 Perl_croak(aTHX_ "Not a subroutine reference");
8990 else if (isGV_with_GP(sv)) {
8991 gv = MUTABLE_GV(sv);
8994 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
9001 /* Some flags to gv_fetchsv mean don't really create the GV */
9002 if (!isGV_with_GP(gv)) {
9007 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
9008 /* XXX this is probably not what they think they're getting.
9009 * It has the same effect as "sub name;", i.e. just a forward
9020 Returns true if the SV has a true value by Perl's rules.
9021 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
9022 instead use an in-line version.
9028 Perl_sv_true(pTHX_ register SV *const sv)
9033 const XPV* const tXpv = (XPV*)SvANY(sv);
9035 (tXpv->xpv_cur > 1 ||
9036 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9043 return SvIVX(sv) != 0;
9046 return SvNVX(sv) != 0.0;
9048 return sv_2bool(sv);
9054 =for apidoc sv_pvn_force
9056 Get a sensible string out of the SV somehow.
9057 A private implementation of the C<SvPV_force> macro for compilers which
9058 can't cope with complex macro expressions. Always use the macro instead.
9060 =for apidoc sv_pvn_force_flags
9062 Get a sensible string out of the SV somehow.
9063 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9064 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9065 implemented in terms of this function.
9066 You normally want to use the various wrapper macros instead: see
9067 C<SvPV_force> and C<SvPV_force_nomg>
9073 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9077 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9079 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9080 if (SvTHINKFIRST(sv) && !SvROK(sv))
9081 sv_force_normal_flags(sv, 0);
9091 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9092 const char * const ref = sv_reftype(sv,0);
9094 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9095 ref, OP_DESC(PL_op));
9097 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9099 if (SvTYPE(sv) > SVt_PVLV
9100 || isGV_with_GP(sv))
9101 /* diag_listed_as: Can't coerce %s to %s in %s */
9102 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9104 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9111 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9114 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9115 SvGROW(sv, len + 1);
9116 Move(s,SvPVX(sv),len,char);
9118 SvPVX(sv)[len] = '\0';
9121 SvPOK_on(sv); /* validate pointer */
9123 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9124 PTR2UV(sv),SvPVX_const(sv)));
9127 (void)SvPOK_only_UTF8(sv);
9128 return SvPVX_mutable(sv);
9132 =for apidoc sv_pvbyten_force
9134 The backend for the C<SvPVbytex_force> macro. Always use the macro
9141 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9143 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9145 sv_pvn_force(sv,lp);
9146 sv_utf8_downgrade(sv,0);
9152 =for apidoc sv_pvutf8n_force
9154 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9161 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9163 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9166 sv_utf8_upgrade_nomg(sv);
9172 =for apidoc sv_reftype
9174 Returns a string describing what the SV is a reference to.
9180 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9182 PERL_ARGS_ASSERT_SV_REFTYPE;
9183 if (ob && SvOBJECT(sv)) {
9184 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9187 switch (SvTYPE(sv)) {
9202 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9203 /* tied lvalues should appear to be
9204 * scalars for backwards compatibility */
9205 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9206 ? "SCALAR" : "LVALUE");
9207 case SVt_PVAV: return "ARRAY";
9208 case SVt_PVHV: return "HASH";
9209 case SVt_PVCV: return "CODE";
9210 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9211 ? "GLOB" : "SCALAR");
9212 case SVt_PVFM: return "FORMAT";
9213 case SVt_PVIO: return "IO";
9214 case SVt_BIND: return "BIND";
9215 case SVt_REGEXP: return "REGEXP";
9216 default: return "UNKNOWN";
9224 Returns a SV describing what the SV passed in is a reference to.
9230 Perl_sv_ref(pTHX_ register SV *dst, const SV *const sv, const int ob)
9232 PERL_ARGS_ASSERT_SV_REF;
9235 dst = sv_newmortal();
9237 if (ob && SvOBJECT(sv)) {
9238 HvNAME_get(SvSTASH(sv))
9239 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9240 : sv_setpvn(dst, "__ANON__", 8);
9243 const char * reftype = sv_reftype(sv, 0);
9244 sv_setpv(dst, reftype);
9250 =for apidoc sv_isobject
9252 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9253 object. If the SV is not an RV, or if the object is not blessed, then this
9260 Perl_sv_isobject(pTHX_ SV *sv)
9276 Returns a boolean indicating whether the SV is blessed into the specified
9277 class. This does not check for subtypes; use C<sv_derived_from> to verify
9278 an inheritance relationship.
9284 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9288 PERL_ARGS_ASSERT_SV_ISA;
9298 hvname = HvNAME_get(SvSTASH(sv));
9302 return strEQ(hvname, name);
9308 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9309 it will be upgraded to one. If C<classname> is non-null then the new SV will
9310 be blessed in the specified package. The new SV is returned and its
9311 reference count is 1.
9317 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9322 PERL_ARGS_ASSERT_NEWSVRV;
9326 SV_CHECK_THINKFIRST_COW_DROP(rv);
9328 if (SvTYPE(rv) >= SVt_PVMG) {
9329 const U32 refcnt = SvREFCNT(rv);
9333 SvREFCNT(rv) = refcnt;
9335 sv_upgrade(rv, SVt_IV);
9336 } else if (SvROK(rv)) {
9337 SvREFCNT_dec(SvRV(rv));
9339 prepare_SV_for_RV(rv);
9347 HV* const stash = gv_stashpv(classname, GV_ADD);
9348 (void)sv_bless(rv, stash);
9354 =for apidoc sv_setref_pv
9356 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9357 argument will be upgraded to an RV. That RV will be modified to point to
9358 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9359 into the SV. The C<classname> argument indicates the package for the
9360 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9361 will have a reference count of 1, and the RV will be returned.
9363 Do not use with other Perl types such as HV, AV, SV, CV, because those
9364 objects will become corrupted by the pointer copy process.
9366 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9372 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9376 PERL_ARGS_ASSERT_SV_SETREF_PV;
9379 sv_setsv(rv, &PL_sv_undef);
9383 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9388 =for apidoc sv_setref_iv
9390 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9391 argument will be upgraded to an RV. That RV will be modified to point to
9392 the new SV. The C<classname> argument indicates the package for the
9393 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9394 will have a reference count of 1, and the RV will be returned.
9400 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9402 PERL_ARGS_ASSERT_SV_SETREF_IV;
9404 sv_setiv(newSVrv(rv,classname), iv);
9409 =for apidoc sv_setref_uv
9411 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9412 argument will be upgraded to an RV. That RV will be modified to point to
9413 the new SV. The C<classname> argument indicates the package for the
9414 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9415 will have a reference count of 1, and the RV will be returned.
9421 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9423 PERL_ARGS_ASSERT_SV_SETREF_UV;
9425 sv_setuv(newSVrv(rv,classname), uv);
9430 =for apidoc sv_setref_nv
9432 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9433 argument will be upgraded to an RV. That RV will be modified to point to
9434 the new SV. The C<classname> argument indicates the package for the
9435 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9436 will have a reference count of 1, and the RV will be returned.
9442 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9444 PERL_ARGS_ASSERT_SV_SETREF_NV;
9446 sv_setnv(newSVrv(rv,classname), nv);
9451 =for apidoc sv_setref_pvn
9453 Copies a string into a new SV, optionally blessing the SV. The length of the
9454 string must be specified with C<n>. The C<rv> argument will be upgraded to
9455 an RV. That RV will be modified to point to the new SV. The C<classname>
9456 argument indicates the package for the blessing. Set C<classname> to
9457 C<NULL> to avoid the blessing. The new SV will have a reference count
9458 of 1, and the RV will be returned.
9460 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9466 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9467 const char *const pv, const STRLEN n)
9469 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9471 sv_setpvn(newSVrv(rv,classname), pv, n);
9476 =for apidoc sv_bless
9478 Blesses an SV into a specified package. The SV must be an RV. The package
9479 must be designated by its stash (see C<gv_stashpv()>). The reference count
9480 of the SV is unaffected.
9486 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9491 PERL_ARGS_ASSERT_SV_BLESS;
9494 Perl_croak(aTHX_ "Can't bless non-reference value");
9496 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9497 if (SvREADONLY(tmpRef) && !SvIsCOW(tmpRef))
9498 Perl_croak_no_modify(aTHX);
9499 if (SvOBJECT(tmpRef)) {
9500 if (SvTYPE(tmpRef) != SVt_PVIO)
9502 SvREFCNT_dec(SvSTASH(tmpRef));
9505 SvOBJECT_on(tmpRef);
9506 if (SvTYPE(tmpRef) != SVt_PVIO)
9508 SvUPGRADE(tmpRef, SVt_PVMG);
9509 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9511 if(SvSMAGICAL(tmpRef))
9512 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9520 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9521 * as it is after unglobbing it.
9524 PERL_STATIC_INLINE void
9525 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9530 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9532 PERL_ARGS_ASSERT_SV_UNGLOB;
9534 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9536 if (!(flags & SV_COW_DROP_PV))
9537 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9540 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9541 && HvNAME_get(stash))
9542 mro_method_changed_in(stash);
9543 gp_free(MUTABLE_GV(sv));
9546 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9550 if (GvNAME_HEK(sv)) {
9551 unshare_hek(GvNAME_HEK(sv));
9553 isGV_with_GP_off(sv);
9555 if(SvTYPE(sv) == SVt_PVGV) {
9556 /* need to keep SvANY(sv) in the right arena */
9557 xpvmg = new_XPVMG();
9558 StructCopy(SvANY(sv), xpvmg, XPVMG);
9559 del_XPVGV(SvANY(sv));
9562 SvFLAGS(sv) &= ~SVTYPEMASK;
9563 SvFLAGS(sv) |= SVt_PVMG;
9566 /* Intentionally not calling any local SET magic, as this isn't so much a
9567 set operation as merely an internal storage change. */
9568 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9569 else sv_setsv_flags(sv, temp, 0);
9571 if ((const GV *)sv == PL_last_in_gv)
9572 PL_last_in_gv = NULL;
9573 else if ((const GV *)sv == PL_statgv)
9578 =for apidoc sv_unref_flags
9580 Unsets the RV status of the SV, and decrements the reference count of
9581 whatever was being referenced by the RV. This can almost be thought of
9582 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9583 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9584 (otherwise the decrementing is conditional on the reference count being
9585 different from one or the reference being a readonly SV).
9592 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9594 SV* const target = SvRV(ref);
9596 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9598 if (SvWEAKREF(ref)) {
9599 sv_del_backref(target, ref);
9601 SvRV_set(ref, NULL);
9604 SvRV_set(ref, NULL);
9606 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9607 assigned to as BEGIN {$a = \"Foo"} will fail. */
9608 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9609 SvREFCNT_dec(target);
9610 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9611 sv_2mortal(target); /* Schedule for freeing later */
9615 =for apidoc sv_untaint
9617 Untaint an SV. Use C<SvTAINTED_off> instead.
9623 Perl_sv_untaint(pTHX_ SV *const sv)
9625 PERL_ARGS_ASSERT_SV_UNTAINT;
9627 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9628 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9635 =for apidoc sv_tainted
9637 Test an SV for taintedness. Use C<SvTAINTED> instead.
9643 Perl_sv_tainted(pTHX_ SV *const sv)
9645 PERL_ARGS_ASSERT_SV_TAINTED;
9647 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9648 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9649 if (mg && (mg->mg_len & 1) )
9656 =for apidoc sv_setpviv
9658 Copies an integer into the given SV, also updating its string value.
9659 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9665 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9667 char buf[TYPE_CHARS(UV)];
9669 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9671 PERL_ARGS_ASSERT_SV_SETPVIV;
9673 sv_setpvn(sv, ptr, ebuf - ptr);
9677 =for apidoc sv_setpviv_mg
9679 Like C<sv_setpviv>, but also handles 'set' magic.
9685 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9687 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9693 #if defined(PERL_IMPLICIT_CONTEXT)
9695 /* pTHX_ magic can't cope with varargs, so this is a no-context
9696 * version of the main function, (which may itself be aliased to us).
9697 * Don't access this version directly.
9701 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9706 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9708 va_start(args, pat);
9709 sv_vsetpvf(sv, pat, &args);
9713 /* pTHX_ magic can't cope with varargs, so this is a no-context
9714 * version of the main function, (which may itself be aliased to us).
9715 * Don't access this version directly.
9719 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9724 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9726 va_start(args, pat);
9727 sv_vsetpvf_mg(sv, pat, &args);
9733 =for apidoc sv_setpvf
9735 Works like C<sv_catpvf> but copies the text into the SV instead of
9736 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9742 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9746 PERL_ARGS_ASSERT_SV_SETPVF;
9748 va_start(args, pat);
9749 sv_vsetpvf(sv, pat, &args);
9754 =for apidoc sv_vsetpvf
9756 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9757 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9759 Usually used via its frontend C<sv_setpvf>.
9765 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9767 PERL_ARGS_ASSERT_SV_VSETPVF;
9769 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9773 =for apidoc sv_setpvf_mg
9775 Like C<sv_setpvf>, but also handles 'set' magic.
9781 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9785 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9787 va_start(args, pat);
9788 sv_vsetpvf_mg(sv, pat, &args);
9793 =for apidoc sv_vsetpvf_mg
9795 Like C<sv_vsetpvf>, but also handles 'set' magic.
9797 Usually used via its frontend C<sv_setpvf_mg>.
9803 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9805 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9807 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9811 #if defined(PERL_IMPLICIT_CONTEXT)
9813 /* pTHX_ magic can't cope with varargs, so this is a no-context
9814 * version of the main function, (which may itself be aliased to us).
9815 * Don't access this version directly.
9819 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9824 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9826 va_start(args, pat);
9827 sv_vcatpvf(sv, pat, &args);
9831 /* pTHX_ magic can't cope with varargs, so this is a no-context
9832 * version of the main function, (which may itself be aliased to us).
9833 * Don't access this version directly.
9837 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9842 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9844 va_start(args, pat);
9845 sv_vcatpvf_mg(sv, pat, &args);
9851 =for apidoc sv_catpvf
9853 Processes its arguments like C<sprintf> and appends the formatted
9854 output to an SV. If the appended data contains "wide" characters
9855 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9856 and characters >255 formatted with %c), the original SV might get
9857 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9858 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9859 valid UTF-8; if the original SV was bytes, the pattern should be too.
9864 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9868 PERL_ARGS_ASSERT_SV_CATPVF;
9870 va_start(args, pat);
9871 sv_vcatpvf(sv, pat, &args);
9876 =for apidoc sv_vcatpvf
9878 Processes its arguments like C<vsprintf> and appends the formatted output
9879 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9881 Usually used via its frontend C<sv_catpvf>.
9887 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9889 PERL_ARGS_ASSERT_SV_VCATPVF;
9891 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9895 =for apidoc sv_catpvf_mg
9897 Like C<sv_catpvf>, but also handles 'set' magic.
9903 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9907 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9909 va_start(args, pat);
9910 sv_vcatpvf_mg(sv, pat, &args);
9915 =for apidoc sv_vcatpvf_mg
9917 Like C<sv_vcatpvf>, but also handles 'set' magic.
9919 Usually used via its frontend C<sv_catpvf_mg>.
9925 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9927 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9929 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9934 =for apidoc sv_vsetpvfn
9936 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9939 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9945 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9946 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9948 PERL_ARGS_ASSERT_SV_VSETPVFN;
9951 sv_vcatpvfn_flags(sv, pat, patlen, args, svargs, svmax, maybe_tainted, 0);
9956 * Warn of missing argument to sprintf, and then return a defined value
9957 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9959 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9961 S_vcatpvfn_missing_argument(pTHX) {
9962 if (ckWARN(WARN_MISSING)) {
9963 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9964 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9971 S_expect_number(pTHX_ char **const pattern)
9976 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9978 switch (**pattern) {
9979 case '1': case '2': case '3':
9980 case '4': case '5': case '6':
9981 case '7': case '8': case '9':
9982 var = *(*pattern)++ - '0';
9983 while (isDIGIT(**pattern)) {
9984 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9986 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9994 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9996 const int neg = nv < 0;
9999 PERL_ARGS_ASSERT_F0CONVERT;
10007 if (uv & 1 && uv == nv)
10008 uv--; /* Round to even */
10010 const unsigned dig = uv % 10;
10012 } while (uv /= 10);
10023 =for apidoc sv_vcatpvfn
10025 =for apidoc sv_vcatpvfn_flags
10027 Processes its arguments like C<vsprintf> and appends the formatted output
10028 to an SV. Uses an array of SVs if the C style variable argument list is
10029 missing (NULL). When running with taint checks enabled, indicates via
10030 C<maybe_tainted> if results are untrustworthy (often due to the use of
10033 If called as C<sv_vcatpvfn> or flags include C<SV_GMAGIC>, calls get magic.
10035 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10040 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10041 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10042 vec_utf8 = DO_UTF8(vecsv);
10044 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10047 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10048 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10050 PERL_ARGS_ASSERT_SV_VCATPVFN;
10052 sv_vcatpvfn_flags(sv, pat, patlen, args, svargs, svmax, maybe_tainted, SV_GMAGIC|SV_SMAGIC);
10056 Perl_sv_vcatpvfn_flags(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10057 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted,
10063 const char *patend;
10066 static const char nullstr[] = "(null)";
10068 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10069 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10071 /* Times 4: a decimal digit takes more than 3 binary digits.
10072 * NV_DIG: mantissa takes than many decimal digits.
10073 * Plus 32: Playing safe. */
10074 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10075 /* large enough for "%#.#f" --chip */
10076 /* what about long double NVs? --jhi */
10078 PERL_ARGS_ASSERT_SV_VCATPVFN_FLAGS;
10079 PERL_UNUSED_ARG(maybe_tainted);
10081 if (flags & SV_GMAGIC)
10084 /* no matter what, this is a string now */
10085 (void)SvPV_force_nomg(sv, origlen);
10087 /* special-case "", "%s", and "%-p" (SVf - see below) */
10090 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10092 const char * const s = va_arg(*args, char*);
10093 sv_catpv_nomg(sv, s ? s : nullstr);
10095 else if (svix < svmax) {
10096 /* we want get magic on the source but not the target. sv_catsv can't do that, though */
10097 SvGETMAGIC(*svargs);
10098 sv_catsv_nomg(sv, *svargs);
10101 S_vcatpvfn_missing_argument(aTHX);
10104 if (args && patlen == 3 && pat[0] == '%' &&
10105 pat[1] == '-' && pat[2] == 'p') {
10106 argsv = MUTABLE_SV(va_arg(*args, void*));
10107 sv_catsv_nomg(sv, argsv);
10111 #ifndef USE_LONG_DOUBLE
10112 /* special-case "%.<number>[gf]" */
10113 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10114 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10115 unsigned digits = 0;
10119 while (*pp >= '0' && *pp <= '9')
10120 digits = 10 * digits + (*pp++ - '0');
10121 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10122 const NV nv = SvNV(*svargs);
10124 /* Add check for digits != 0 because it seems that some
10125 gconverts are buggy in this case, and we don't yet have
10126 a Configure test for this. */
10127 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10128 /* 0, point, slack */
10129 Gconvert(nv, (int)digits, 0, ebuf);
10130 sv_catpv_nomg(sv, ebuf);
10131 if (*ebuf) /* May return an empty string for digits==0 */
10134 } else if (!digits) {
10137 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10138 sv_catpvn_nomg(sv, p, l);
10144 #endif /* !USE_LONG_DOUBLE */
10146 if (!args && svix < svmax && DO_UTF8(*svargs))
10149 patend = (char*)pat + patlen;
10150 for (p = (char*)pat; p < patend; p = q) {
10153 bool vectorize = FALSE;
10154 bool vectorarg = FALSE;
10155 bool vec_utf8 = FALSE;
10161 bool has_precis = FALSE;
10163 const I32 osvix = svix;
10164 bool is_utf8 = FALSE; /* is this item utf8? */
10165 #ifdef HAS_LDBL_SPRINTF_BUG
10166 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10167 with sfio - Allen <allens@cpan.org> */
10168 bool fix_ldbl_sprintf_bug = FALSE;
10172 U8 utf8buf[UTF8_MAXBYTES+1];
10173 STRLEN esignlen = 0;
10175 const char *eptr = NULL;
10176 const char *fmtstart;
10179 const U8 *vecstr = NULL;
10186 /* we need a long double target in case HAS_LONG_DOUBLE but
10187 not USE_LONG_DOUBLE
10189 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10197 const char *dotstr = ".";
10198 STRLEN dotstrlen = 1;
10199 I32 efix = 0; /* explicit format parameter index */
10200 I32 ewix = 0; /* explicit width index */
10201 I32 epix = 0; /* explicit precision index */
10202 I32 evix = 0; /* explicit vector index */
10203 bool asterisk = FALSE;
10205 /* echo everything up to the next format specification */
10206 for (q = p; q < patend && *q != '%'; ++q) ;
10208 if (has_utf8 && !pat_utf8)
10209 sv_catpvn_nomg_utf8_upgrade(sv, p, q - p, nsv);
10211 sv_catpvn_nomg(sv, p, q - p);
10220 We allow format specification elements in this order:
10221 \d+\$ explicit format parameter index
10223 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10224 0 flag (as above): repeated to allow "v02"
10225 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10226 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10228 [%bcdefginopsuxDFOUX] format (mandatory)
10233 As of perl5.9.3, printf format checking is on by default.
10234 Internally, perl uses %p formats to provide an escape to
10235 some extended formatting. This block deals with those
10236 extensions: if it does not match, (char*)q is reset and
10237 the normal format processing code is used.
10239 Currently defined extensions are:
10240 %p include pointer address (standard)
10241 %-p (SVf) include an SV (previously %_)
10242 %-<num>p include an SV with precision <num>
10244 %3p include a HEK with precision of 256
10245 %<num>p (where num != 2 or 3) reserved for future
10248 Robin Barker 2005-07-14 (but modified since)
10250 %1p (VDf) removed. RMB 2007-10-19
10257 n = expect_number(&q);
10259 if (sv) { /* SVf */
10264 argsv = MUTABLE_SV(va_arg(*args, void*));
10265 eptr = SvPV_const(argsv, elen);
10266 if (DO_UTF8(argsv))
10270 else if (n==2 || n==3) { /* HEKf */
10271 HEK * const hek = va_arg(*args, HEK *);
10272 eptr = HEK_KEY(hek);
10273 elen = HEK_LEN(hek);
10274 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10275 if (n==3) precis = 256, has_precis = TRUE;
10279 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10280 "internal %%<num>p might conflict with future printf extensions");
10286 if ( (width = expect_number(&q)) ) {
10301 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10330 if ( (ewix = expect_number(&q)) )
10339 if ((vectorarg = asterisk)) {
10352 width = expect_number(&q);
10355 if (vectorize && vectorarg) {
10356 /* vectorizing, but not with the default "." */
10358 vecsv = va_arg(*args, SV*);
10360 vecsv = (evix > 0 && evix <= svmax)
10361 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10363 vecsv = svix < svmax
10364 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10366 dotstr = SvPV_const(vecsv, dotstrlen);
10367 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10368 bad with tied or overloaded values that return UTF8. */
10369 if (DO_UTF8(vecsv))
10371 else if (has_utf8) {
10372 vecsv = sv_mortalcopy(vecsv);
10373 sv_utf8_upgrade(vecsv);
10374 dotstr = SvPV_const(vecsv, dotstrlen);
10381 i = va_arg(*args, int);
10383 i = (ewix ? ewix <= svmax : svix < svmax) ?
10384 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10386 width = (i < 0) ? -i : i;
10396 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10398 /* XXX: todo, support specified precision parameter */
10402 i = va_arg(*args, int);
10404 i = (ewix ? ewix <= svmax : svix < svmax)
10405 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10407 has_precis = !(i < 0);
10411 while (isDIGIT(*q))
10412 precis = precis * 10 + (*q++ - '0');
10421 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10422 vecsv = svargs[efix ? efix-1 : svix++];
10423 vecstr = (U8*)SvPV_const(vecsv,veclen);
10424 vec_utf8 = DO_UTF8(vecsv);
10426 /* if this is a version object, we need to convert
10427 * back into v-string notation and then let the
10428 * vectorize happen normally
10430 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10431 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10432 Perl_ck_warner_d(aTHX_ packWARN(WARN_PRINTF),
10433 "vector argument not supported with alpha versions");
10436 vecsv = sv_newmortal();
10437 scan_vstring((char *)vecstr, (char *)vecstr + veclen,
10439 vecstr = (U8*)SvPV_const(vecsv, veclen);
10440 vec_utf8 = DO_UTF8(vecsv);
10454 case 'I': /* Ix, I32x, and I64x */
10455 # ifdef USE_64_BIT_INT
10456 if (q[1] == '6' && q[2] == '4') {
10462 if (q[1] == '3' && q[2] == '2') {
10466 # ifdef USE_64_BIT_INT
10472 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10484 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10485 if (*q == 'l') { /* lld, llf */
10494 if (*++q == 'h') { /* hhd, hhu */
10523 if (!vectorize && !args) {
10525 const I32 i = efix-1;
10526 argsv = (i >= 0 && i < svmax)
10527 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10529 argsv = (svix >= 0 && svix < svmax)
10530 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10534 switch (c = *q++) {
10541 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10543 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10545 eptr = (char*)utf8buf;
10546 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10560 eptr = va_arg(*args, char*);
10562 elen = strlen(eptr);
10564 eptr = (char *)nullstr;
10565 elen = sizeof nullstr - 1;
10569 eptr = SvPV_const(argsv, elen);
10570 if (DO_UTF8(argsv)) {
10571 STRLEN old_precis = precis;
10572 if (has_precis && precis < elen) {
10573 STRLEN ulen = sv_or_pv_len_utf8(argsv, eptr, elen);
10574 STRLEN p = precis > ulen ? ulen : precis;
10575 precis = sv_or_pv_pos_u2b(argsv, eptr, p, 0);
10576 /* sticks at end */
10578 if (width) { /* fudge width (can't fudge elen) */
10579 if (has_precis && precis < elen)
10580 width += precis - old_precis;
10583 elen - sv_or_pv_len_utf8(argsv,eptr,elen);
10590 if (has_precis && precis < elen)
10597 if (alt || vectorize)
10599 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10620 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10629 esignbuf[esignlen++] = plus;
10633 case 'c': iv = (char)va_arg(*args, int); break;
10634 case 'h': iv = (short)va_arg(*args, int); break;
10635 case 'l': iv = va_arg(*args, long); break;
10636 case 'V': iv = va_arg(*args, IV); break;
10637 case 'z': iv = va_arg(*args, SSize_t); break;
10638 case 't': iv = va_arg(*args, ptrdiff_t); break;
10639 default: iv = va_arg(*args, int); break;
10641 case 'j': iv = va_arg(*args, intmax_t); break;
10645 iv = va_arg(*args, Quad_t); break;
10652 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10654 case 'c': iv = (char)tiv; break;
10655 case 'h': iv = (short)tiv; break;
10656 case 'l': iv = (long)tiv; break;
10658 default: iv = tiv; break;
10661 iv = (Quad_t)tiv; break;
10667 if ( !vectorize ) /* we already set uv above */
10672 esignbuf[esignlen++] = plus;
10676 esignbuf[esignlen++] = '-';
10720 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10731 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10732 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10733 case 'l': uv = va_arg(*args, unsigned long); break;
10734 case 'V': uv = va_arg(*args, UV); break;
10735 case 'z': uv = va_arg(*args, Size_t); break;
10736 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10738 case 'j': uv = va_arg(*args, uintmax_t); break;
10740 default: uv = va_arg(*args, unsigned); break;
10743 uv = va_arg(*args, Uquad_t); break;
10750 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10752 case 'c': uv = (unsigned char)tuv; break;
10753 case 'h': uv = (unsigned short)tuv; break;
10754 case 'l': uv = (unsigned long)tuv; break;
10756 default: uv = tuv; break;
10759 uv = (Uquad_t)tuv; break;
10768 char *ptr = ebuf + sizeof ebuf;
10769 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10775 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10779 } while (uv >>= 4);
10781 esignbuf[esignlen++] = '0';
10782 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10788 *--ptr = '0' + dig;
10789 } while (uv >>= 3);
10790 if (alt && *ptr != '0')
10796 *--ptr = '0' + dig;
10797 } while (uv >>= 1);
10799 esignbuf[esignlen++] = '0';
10800 esignbuf[esignlen++] = c;
10803 default: /* it had better be ten or less */
10806 *--ptr = '0' + dig;
10807 } while (uv /= base);
10810 elen = (ebuf + sizeof ebuf) - ptr;
10814 zeros = precis - elen;
10815 else if (precis == 0 && elen == 1 && *eptr == '0'
10816 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10819 /* a precision nullifies the 0 flag. */
10826 /* FLOATING POINT */
10829 c = 'f'; /* maybe %F isn't supported here */
10831 case 'e': case 'E':
10833 case 'g': case 'G':
10837 /* This is evil, but floating point is even more evil */
10839 /* for SV-style calling, we can only get NV
10840 for C-style calling, we assume %f is double;
10841 for simplicity we allow any of %Lf, %llf, %qf for long double
10845 #if defined(USE_LONG_DOUBLE)
10849 /* [perl #20339] - we should accept and ignore %lf rather than die */
10853 #if defined(USE_LONG_DOUBLE)
10854 intsize = args ? 0 : 'q';
10858 #if defined(HAS_LONG_DOUBLE)
10871 /* now we need (long double) if intsize == 'q', else (double) */
10873 #if LONG_DOUBLESIZE > DOUBLESIZE
10875 va_arg(*args, long double) :
10876 va_arg(*args, double)
10878 va_arg(*args, double)
10883 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10884 else. frexp() has some unspecified behaviour for those three */
10885 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10887 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10888 will cast our (long double) to (double) */
10889 (void)Perl_frexp(nv, &i);
10890 if (i == PERL_INT_MIN)
10891 Perl_die(aTHX_ "panic: frexp");
10893 need = BIT_DIGITS(i);
10895 need += has_precis ? precis : 6; /* known default */
10900 #ifdef HAS_LDBL_SPRINTF_BUG
10901 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10902 with sfio - Allen <allens@cpan.org> */
10905 # define MY_DBL_MAX DBL_MAX
10906 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10907 # if DOUBLESIZE >= 8
10908 # define MY_DBL_MAX 1.7976931348623157E+308L
10910 # define MY_DBL_MAX 3.40282347E+38L
10914 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10915 # define MY_DBL_MAX_BUG 1L
10917 # define MY_DBL_MAX_BUG MY_DBL_MAX
10921 # define MY_DBL_MIN DBL_MIN
10922 # else /* XXX guessing! -Allen */
10923 # if DOUBLESIZE >= 8
10924 # define MY_DBL_MIN 2.2250738585072014E-308L
10926 # define MY_DBL_MIN 1.17549435E-38L
10930 if ((intsize == 'q') && (c == 'f') &&
10931 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10932 (need < DBL_DIG)) {
10933 /* it's going to be short enough that
10934 * long double precision is not needed */
10936 if ((nv <= 0L) && (nv >= -0L))
10937 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10939 /* would use Perl_fp_class as a double-check but not
10940 * functional on IRIX - see perl.h comments */
10942 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10943 /* It's within the range that a double can represent */
10944 #if defined(DBL_MAX) && !defined(DBL_MIN)
10945 if ((nv >= ((long double)1/DBL_MAX)) ||
10946 (nv <= (-(long double)1/DBL_MAX)))
10948 fix_ldbl_sprintf_bug = TRUE;
10951 if (fix_ldbl_sprintf_bug == TRUE) {
10961 # undef MY_DBL_MAX_BUG
10964 #endif /* HAS_LDBL_SPRINTF_BUG */
10966 need += 20; /* fudge factor */
10967 if (PL_efloatsize < need) {
10968 Safefree(PL_efloatbuf);
10969 PL_efloatsize = need + 20; /* more fudge */
10970 Newx(PL_efloatbuf, PL_efloatsize, char);
10971 PL_efloatbuf[0] = '\0';
10974 if ( !(width || left || plus || alt) && fill != '0'
10975 && has_precis && intsize != 'q' ) { /* Shortcuts */
10976 /* See earlier comment about buggy Gconvert when digits,
10978 if ( c == 'g' && precis) {
10979 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10980 /* May return an empty string for digits==0 */
10981 if (*PL_efloatbuf) {
10982 elen = strlen(PL_efloatbuf);
10983 goto float_converted;
10985 } else if ( c == 'f' && !precis) {
10986 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10991 char *ptr = ebuf + sizeof ebuf;
10994 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10995 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10996 if (intsize == 'q') {
10997 /* Copy the one or more characters in a long double
10998 * format before the 'base' ([efgEFG]) character to
10999 * the format string. */
11000 static char const prifldbl[] = PERL_PRIfldbl;
11001 char const *p = prifldbl + sizeof(prifldbl) - 3;
11002 while (p >= prifldbl) { *--ptr = *p--; }
11007 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11012 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11024 /* No taint. Otherwise we are in the strange situation
11025 * where printf() taints but print($float) doesn't.
11027 #if defined(HAS_LONG_DOUBLE)
11028 elen = ((intsize == 'q')
11029 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
11030 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
11032 elen = my_sprintf(PL_efloatbuf, ptr, nv);
11036 eptr = PL_efloatbuf;
11044 i = SvCUR(sv) - origlen;
11047 case 'c': *(va_arg(*args, char*)) = i; break;
11048 case 'h': *(va_arg(*args, short*)) = i; break;
11049 default: *(va_arg(*args, int*)) = i; break;
11050 case 'l': *(va_arg(*args, long*)) = i; break;
11051 case 'V': *(va_arg(*args, IV*)) = i; break;
11052 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11053 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11055 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11059 *(va_arg(*args, Quad_t*)) = i; break;
11066 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11067 continue; /* not "break" */
11074 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11075 && ckWARN(WARN_PRINTF))
11077 SV * const msg = sv_newmortal();
11078 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11079 (PL_op->op_type == OP_PRTF) ? "" : "s");
11080 if (fmtstart < patend) {
11081 const char * const fmtend = q < patend ? q : patend;
11083 sv_catpvs(msg, "\"%");
11084 for (f = fmtstart; f < fmtend; f++) {
11086 sv_catpvn_nomg(msg, f, 1);
11088 Perl_sv_catpvf(aTHX_ msg,
11089 "\\%03"UVof, (UV)*f & 0xFF);
11092 sv_catpvs(msg, "\"");
11094 sv_catpvs(msg, "end of string");
11096 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11099 /* output mangled stuff ... */
11105 /* ... right here, because formatting flags should not apply */
11106 SvGROW(sv, SvCUR(sv) + elen + 1);
11108 Copy(eptr, p, elen, char);
11111 SvCUR_set(sv, p - SvPVX_const(sv));
11113 continue; /* not "break" */
11116 if (is_utf8 != has_utf8) {
11119 sv_utf8_upgrade(sv);
11122 const STRLEN old_elen = elen;
11123 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11124 sv_utf8_upgrade(nsv);
11125 eptr = SvPVX_const(nsv);
11128 if (width) { /* fudge width (can't fudge elen) */
11129 width += elen - old_elen;
11135 have = esignlen + zeros + elen;
11137 croak_memory_wrap();
11139 need = (have > width ? have : width);
11142 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11143 croak_memory_wrap();
11144 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11146 if (esignlen && fill == '0') {
11148 for (i = 0; i < (int)esignlen; i++)
11149 *p++ = esignbuf[i];
11151 if (gap && !left) {
11152 memset(p, fill, gap);
11155 if (esignlen && fill != '0') {
11157 for (i = 0; i < (int)esignlen; i++)
11158 *p++ = esignbuf[i];
11162 for (i = zeros; i; i--)
11166 Copy(eptr, p, elen, char);
11170 memset(p, ' ', gap);
11175 Copy(dotstr, p, dotstrlen, char);
11179 vectorize = FALSE; /* done iterating over vecstr */
11186 SvCUR_set(sv, p - SvPVX_const(sv));
11195 /* =========================================================================
11197 =head1 Cloning an interpreter
11199 All the macros and functions in this section are for the private use of
11200 the main function, perl_clone().
11202 The foo_dup() functions make an exact copy of an existing foo thingy.
11203 During the course of a cloning, a hash table is used to map old addresses
11204 to new addresses. The table is created and manipulated with the
11205 ptr_table_* functions.
11209 * =========================================================================*/
11212 #if defined(USE_ITHREADS)
11214 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11215 #ifndef GpREFCNT_inc
11216 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11220 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11221 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11222 If this changes, please unmerge ss_dup.
11223 Likewise, sv_dup_inc_multiple() relies on this fact. */
11224 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11225 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11226 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11227 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11228 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11229 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11230 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11231 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11232 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11233 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11234 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11235 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11236 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11238 /* clone a parser */
11241 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11245 PERL_ARGS_ASSERT_PARSER_DUP;
11250 /* look for it in the table first */
11251 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11255 /* create anew and remember what it is */
11256 Newxz(parser, 1, yy_parser);
11257 ptr_table_store(PL_ptr_table, proto, parser);
11259 /* XXX these not yet duped */
11260 parser->old_parser = NULL;
11261 parser->stack = NULL;
11263 parser->stack_size = 0;
11264 /* XXX parser->stack->state = 0; */
11266 /* XXX eventually, just Copy() most of the parser struct ? */
11268 parser->lex_brackets = proto->lex_brackets;
11269 parser->lex_casemods = proto->lex_casemods;
11270 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11271 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11272 parser->lex_casestack = savepvn(proto->lex_casestack,
11273 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11274 parser->lex_defer = proto->lex_defer;
11275 parser->lex_dojoin = proto->lex_dojoin;
11276 parser->lex_expect = proto->lex_expect;
11277 parser->lex_formbrack = proto->lex_formbrack;
11278 parser->lex_inpat = proto->lex_inpat;
11279 parser->lex_inwhat = proto->lex_inwhat;
11280 parser->lex_op = proto->lex_op;
11281 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11282 parser->lex_starts = proto->lex_starts;
11283 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11284 parser->multi_close = proto->multi_close;
11285 parser->multi_open = proto->multi_open;
11286 parser->multi_start = proto->multi_start;
11287 parser->multi_end = proto->multi_end;
11288 parser->preambled = proto->preambled;
11289 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11290 parser->linestr = sv_dup_inc(proto->linestr, param);
11291 parser->expect = proto->expect;
11292 parser->copline = proto->copline;
11293 parser->last_lop_op = proto->last_lop_op;
11294 parser->lex_state = proto->lex_state;
11295 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11296 /* rsfp_filters entries have fake IoDIRP() */
11297 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11298 parser->in_my = proto->in_my;
11299 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11300 parser->error_count = proto->error_count;
11303 parser->linestr = sv_dup_inc(proto->linestr, param);
11306 char * const ols = SvPVX(proto->linestr);
11307 char * const ls = SvPVX(parser->linestr);
11309 parser->bufptr = ls + (proto->bufptr >= ols ?
11310 proto->bufptr - ols : 0);
11311 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11312 proto->oldbufptr - ols : 0);
11313 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11314 proto->oldoldbufptr - ols : 0);
11315 parser->linestart = ls + (proto->linestart >= ols ?
11316 proto->linestart - ols : 0);
11317 parser->last_uni = ls + (proto->last_uni >= ols ?
11318 proto->last_uni - ols : 0);
11319 parser->last_lop = ls + (proto->last_lop >= ols ?
11320 proto->last_lop - ols : 0);
11322 parser->bufend = ls + SvCUR(parser->linestr);
11325 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11329 parser->endwhite = proto->endwhite;
11330 parser->faketokens = proto->faketokens;
11331 parser->lasttoke = proto->lasttoke;
11332 parser->nextwhite = proto->nextwhite;
11333 parser->realtokenstart = proto->realtokenstart;
11334 parser->skipwhite = proto->skipwhite;
11335 parser->thisclose = proto->thisclose;
11336 parser->thismad = proto->thismad;
11337 parser->thisopen = proto->thisopen;
11338 parser->thisstuff = proto->thisstuff;
11339 parser->thistoken = proto->thistoken;
11340 parser->thiswhite = proto->thiswhite;
11342 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11343 parser->curforce = proto->curforce;
11345 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11346 Copy(proto->nexttype, parser->nexttype, 5, I32);
11347 parser->nexttoke = proto->nexttoke;
11350 /* XXX should clone saved_curcop here, but we aren't passed
11351 * proto_perl; so do it in perl_clone_using instead */
11357 /* duplicate a file handle */
11360 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11364 PERL_ARGS_ASSERT_FP_DUP;
11365 PERL_UNUSED_ARG(type);
11368 return (PerlIO*)NULL;
11370 /* look for it in the table first */
11371 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11375 /* create anew and remember what it is */
11376 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11377 ptr_table_store(PL_ptr_table, fp, ret);
11381 /* duplicate a directory handle */
11384 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11390 const Direntry_t *dirent;
11391 char smallbuf[256];
11397 PERL_UNUSED_CONTEXT;
11398 PERL_ARGS_ASSERT_DIRP_DUP;
11403 /* look for it in the table first */
11404 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11410 PERL_UNUSED_ARG(param);
11414 /* open the current directory (so we can switch back) */
11415 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11417 /* chdir to our dir handle and open the present working directory */
11418 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11419 PerlDir_close(pwd);
11420 return (DIR *)NULL;
11422 /* Now we should have two dir handles pointing to the same dir. */
11424 /* Be nice to the calling code and chdir back to where we were. */
11425 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11427 /* We have no need of the pwd handle any more. */
11428 PerlDir_close(pwd);
11431 # define d_namlen(d) (d)->d_namlen
11433 # define d_namlen(d) strlen((d)->d_name)
11435 /* Iterate once through dp, to get the file name at the current posi-
11436 tion. Then step back. */
11437 pos = PerlDir_tell(dp);
11438 if ((dirent = PerlDir_read(dp))) {
11439 len = d_namlen(dirent);
11440 if (len <= sizeof smallbuf) name = smallbuf;
11441 else Newx(name, len, char);
11442 Move(dirent->d_name, name, len, char);
11444 PerlDir_seek(dp, pos);
11446 /* Iterate through the new dir handle, till we find a file with the
11448 if (!dirent) /* just before the end */
11450 pos = PerlDir_tell(ret);
11451 if (PerlDir_read(ret)) continue; /* not there yet */
11452 PerlDir_seek(ret, pos); /* step back */
11456 const long pos0 = PerlDir_tell(ret);
11458 pos = PerlDir_tell(ret);
11459 if ((dirent = PerlDir_read(ret))) {
11460 if (len == d_namlen(dirent)
11461 && memEQ(name, dirent->d_name, len)) {
11463 PerlDir_seek(ret, pos); /* step back */
11466 /* else we are not there yet; keep iterating */
11468 else { /* This is not meant to happen. The best we can do is
11469 reset the iterator to the beginning. */
11470 PerlDir_seek(ret, pos0);
11477 if (name && name != smallbuf)
11482 ret = win32_dirp_dup(dp, param);
11485 /* pop it in the pointer table */
11487 ptr_table_store(PL_ptr_table, dp, ret);
11492 /* duplicate a typeglob */
11495 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11499 PERL_ARGS_ASSERT_GP_DUP;
11503 /* look for it in the table first */
11504 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11508 /* create anew and remember what it is */
11510 ptr_table_store(PL_ptr_table, gp, ret);
11513 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11514 on Newxz() to do this for us. */
11515 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11516 ret->gp_io = io_dup_inc(gp->gp_io, param);
11517 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11518 ret->gp_av = av_dup_inc(gp->gp_av, param);
11519 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11520 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11521 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11522 ret->gp_cvgen = gp->gp_cvgen;
11523 ret->gp_line = gp->gp_line;
11524 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11528 /* duplicate a chain of magic */
11531 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11533 MAGIC *mgret = NULL;
11534 MAGIC **mgprev_p = &mgret;
11536 PERL_ARGS_ASSERT_MG_DUP;
11538 for (; mg; mg = mg->mg_moremagic) {
11541 if ((param->flags & CLONEf_JOIN_IN)
11542 && mg->mg_type == PERL_MAGIC_backref)
11543 /* when joining, we let the individual SVs add themselves to
11544 * backref as needed. */
11547 Newx(nmg, 1, MAGIC);
11549 mgprev_p = &(nmg->mg_moremagic);
11551 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11552 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11553 from the original commit adding Perl_mg_dup() - revision 4538.
11554 Similarly there is the annotation "XXX random ptr?" next to the
11555 assignment to nmg->mg_ptr. */
11558 /* FIXME for plugins
11559 if (nmg->mg_type == PERL_MAGIC_qr) {
11560 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11564 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11565 ? nmg->mg_type == PERL_MAGIC_backref
11566 /* The backref AV has its reference
11567 * count deliberately bumped by 1 */
11568 ? SvREFCNT_inc(av_dup_inc((const AV *)
11569 nmg->mg_obj, param))
11570 : sv_dup_inc(nmg->mg_obj, param)
11571 : sv_dup(nmg->mg_obj, param);
11573 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11574 if (nmg->mg_len > 0) {
11575 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11576 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11577 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11579 AMT * const namtp = (AMT*)nmg->mg_ptr;
11580 sv_dup_inc_multiple((SV**)(namtp->table),
11581 (SV**)(namtp->table), NofAMmeth, param);
11584 else if (nmg->mg_len == HEf_SVKEY)
11585 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11587 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11588 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11594 #endif /* USE_ITHREADS */
11596 struct ptr_tbl_arena {
11597 struct ptr_tbl_arena *next;
11598 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11601 /* create a new pointer-mapping table */
11604 Perl_ptr_table_new(pTHX)
11607 PERL_UNUSED_CONTEXT;
11609 Newx(tbl, 1, PTR_TBL_t);
11610 tbl->tbl_max = 511;
11611 tbl->tbl_items = 0;
11612 tbl->tbl_arena = NULL;
11613 tbl->tbl_arena_next = NULL;
11614 tbl->tbl_arena_end = NULL;
11615 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11619 #define PTR_TABLE_HASH(ptr) \
11620 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11622 /* map an existing pointer using a table */
11624 STATIC PTR_TBL_ENT_t *
11625 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11627 PTR_TBL_ENT_t *tblent;
11628 const UV hash = PTR_TABLE_HASH(sv);
11630 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11632 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11633 for (; tblent; tblent = tblent->next) {
11634 if (tblent->oldval == sv)
11641 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11643 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11645 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11646 PERL_UNUSED_CONTEXT;
11648 return tblent ? tblent->newval : NULL;
11651 /* add a new entry to a pointer-mapping table */
11654 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11656 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11658 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11659 PERL_UNUSED_CONTEXT;
11662 tblent->newval = newsv;
11664 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11666 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11667 struct ptr_tbl_arena *new_arena;
11669 Newx(new_arena, 1, struct ptr_tbl_arena);
11670 new_arena->next = tbl->tbl_arena;
11671 tbl->tbl_arena = new_arena;
11672 tbl->tbl_arena_next = new_arena->array;
11673 tbl->tbl_arena_end = new_arena->array
11674 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11677 tblent = tbl->tbl_arena_next++;
11679 tblent->oldval = oldsv;
11680 tblent->newval = newsv;
11681 tblent->next = tbl->tbl_ary[entry];
11682 tbl->tbl_ary[entry] = tblent;
11684 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11685 ptr_table_split(tbl);
11689 /* double the hash bucket size of an existing ptr table */
11692 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11694 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11695 const UV oldsize = tbl->tbl_max + 1;
11696 UV newsize = oldsize * 2;
11699 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11700 PERL_UNUSED_CONTEXT;
11702 Renew(ary, newsize, PTR_TBL_ENT_t*);
11703 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11704 tbl->tbl_max = --newsize;
11705 tbl->tbl_ary = ary;
11706 for (i=0; i < oldsize; i++, ary++) {
11707 PTR_TBL_ENT_t **entp = ary;
11708 PTR_TBL_ENT_t *ent = *ary;
11709 PTR_TBL_ENT_t **curentp;
11712 curentp = ary + oldsize;
11714 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11716 ent->next = *curentp;
11726 /* remove all the entries from a ptr table */
11727 /* Deprecated - will be removed post 5.14 */
11730 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11732 if (tbl && tbl->tbl_items) {
11733 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11735 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11738 struct ptr_tbl_arena *next = arena->next;
11744 tbl->tbl_items = 0;
11745 tbl->tbl_arena = NULL;
11746 tbl->tbl_arena_next = NULL;
11747 tbl->tbl_arena_end = NULL;
11751 /* clear and free a ptr table */
11754 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11756 struct ptr_tbl_arena *arena;
11762 arena = tbl->tbl_arena;
11765 struct ptr_tbl_arena *next = arena->next;
11771 Safefree(tbl->tbl_ary);
11775 #if defined(USE_ITHREADS)
11778 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11780 PERL_ARGS_ASSERT_RVPV_DUP;
11782 assert(!isREGEXP(sstr));
11784 if (SvWEAKREF(sstr)) {
11785 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11786 if (param->flags & CLONEf_JOIN_IN) {
11787 /* if joining, we add any back references individually rather
11788 * than copying the whole backref array */
11789 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11793 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11795 else if (SvPVX_const(sstr)) {
11796 /* Has something there */
11798 /* Normal PV - clone whole allocated space */
11799 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11800 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11801 /* Not that normal - actually sstr is copy on write.
11802 But we are a true, independent SV, so: */
11803 SvREADONLY_off(dstr);
11808 /* Special case - not normally malloced for some reason */
11809 if (isGV_with_GP(sstr)) {
11810 /* Don't need to do anything here. */
11812 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11813 /* A "shared" PV - clone it as "shared" PV */
11815 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11819 /* Some other special case - random pointer */
11820 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11825 /* Copy the NULL */
11826 SvPV_set(dstr, NULL);
11830 /* duplicate a list of SVs. source and dest may point to the same memory. */
11832 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11833 SSize_t items, CLONE_PARAMS *const param)
11835 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11837 while (items-- > 0) {
11838 *dest++ = sv_dup_inc(*source++, param);
11844 /* duplicate an SV of any type (including AV, HV etc) */
11847 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11852 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11854 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
11855 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11860 /* look for it in the table first */
11861 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11865 if(param->flags & CLONEf_JOIN_IN) {
11866 /** We are joining here so we don't want do clone
11867 something that is bad **/
11868 if (SvTYPE(sstr) == SVt_PVHV) {
11869 const HEK * const hvname = HvNAME_HEK(sstr);
11871 /** don't clone stashes if they already exist **/
11872 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11873 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
11874 ptr_table_store(PL_ptr_table, sstr, dstr);
11878 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
11879 HV *stash = GvSTASH(sstr);
11880 const HEK * hvname;
11881 if (stash && (hvname = HvNAME_HEK(stash))) {
11882 /** don't clone GVs if they already exist **/
11884 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
11885 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
11887 stash, GvNAME(sstr),
11893 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
11894 ptr_table_store(PL_ptr_table, sstr, *svp);
11901 /* create anew and remember what it is */
11904 #ifdef DEBUG_LEAKING_SCALARS
11905 dstr->sv_debug_optype = sstr->sv_debug_optype;
11906 dstr->sv_debug_line = sstr->sv_debug_line;
11907 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11908 dstr->sv_debug_parent = (SV*)sstr;
11909 FREE_SV_DEBUG_FILE(dstr);
11910 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
11913 ptr_table_store(PL_ptr_table, sstr, dstr);
11916 SvFLAGS(dstr) = SvFLAGS(sstr);
11917 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11918 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11921 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11922 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11923 (void*)PL_watch_pvx, SvPVX_const(sstr));
11926 /* don't clone objects whose class has asked us not to */
11927 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11932 switch (SvTYPE(sstr)) {
11934 SvANY(dstr) = NULL;
11937 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11939 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11941 SvIV_set(dstr, SvIVX(sstr));
11945 SvANY(dstr) = new_XNV();
11946 SvNV_set(dstr, SvNVX(sstr));
11948 /* case SVt_BIND: */
11951 /* These are all the types that need complex bodies allocating. */
11953 const svtype sv_type = SvTYPE(sstr);
11954 const struct body_details *const sv_type_details
11955 = bodies_by_type + sv_type;
11959 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11974 assert(sv_type_details->body_size);
11975 if (sv_type_details->arena) {
11976 new_body_inline(new_body, sv_type);
11978 = (void*)((char*)new_body - sv_type_details->offset);
11980 new_body = new_NOARENA(sv_type_details);
11984 SvANY(dstr) = new_body;
11987 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11988 ((char*)SvANY(dstr)) + sv_type_details->offset,
11989 sv_type_details->copy, char);
11991 Copy(((char*)SvANY(sstr)),
11992 ((char*)SvANY(dstr)),
11993 sv_type_details->body_size + sv_type_details->offset, char);
11996 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11997 && !isGV_with_GP(dstr)
11999 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
12000 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
12002 /* The Copy above means that all the source (unduplicated) pointers
12003 are now in the destination. We can check the flags and the
12004 pointers in either, but it's possible that there's less cache
12005 missing by always going for the destination.
12006 FIXME - instrument and check that assumption */
12007 if (sv_type >= SVt_PVMG) {
12008 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
12009 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
12010 } else if (SvMAGIC(dstr))
12011 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
12013 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
12016 /* The cast silences a GCC warning about unhandled types. */
12017 switch ((int)sv_type) {
12028 /* FIXME for plugins */
12029 dstr->sv_u.svu_rx = ((REGEXP *)dstr)->sv_any;
12030 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
12033 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
12034 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
12035 LvTARG(dstr) = dstr;
12036 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
12037 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
12039 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
12040 if (isREGEXP(sstr)) goto duprex;
12042 /* non-GP case already handled above */
12043 if(isGV_with_GP(sstr)) {
12044 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12045 /* Don't call sv_add_backref here as it's going to be
12046 created as part of the magic cloning of the symbol
12047 table--unless this is during a join and the stash
12048 is not actually being cloned. */
12049 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12050 at the point of this comment. */
12051 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12052 if (param->flags & CLONEf_JOIN_IN)
12053 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12054 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12055 (void)GpREFCNT_inc(GvGP(dstr));
12059 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12060 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12061 /* I have no idea why fake dirp (rsfps)
12062 should be treated differently but otherwise
12063 we end up with leaks -- sky*/
12064 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12065 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12066 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12068 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12069 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12070 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12071 if (IoDIRP(dstr)) {
12072 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12075 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12077 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12079 if (IoOFP(dstr) == IoIFP(sstr))
12080 IoOFP(dstr) = IoIFP(dstr);
12082 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12083 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12084 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12085 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12088 /* avoid cloning an empty array */
12089 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12090 SV **dst_ary, **src_ary;
12091 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12093 src_ary = AvARRAY((const AV *)sstr);
12094 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12095 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12096 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12097 AvALLOC((const AV *)dstr) = dst_ary;
12098 if (AvREAL((const AV *)sstr)) {
12099 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12103 while (items-- > 0)
12104 *dst_ary++ = sv_dup(*src_ary++, param);
12106 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12107 while (items-- > 0) {
12108 *dst_ary++ = &PL_sv_undef;
12112 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12113 AvALLOC((const AV *)dstr) = (SV**)NULL;
12114 AvMAX( (const AV *)dstr) = -1;
12115 AvFILLp((const AV *)dstr) = -1;
12119 if (HvARRAY((const HV *)sstr)) {
12121 const bool sharekeys = !!HvSHAREKEYS(sstr);
12122 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12123 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12125 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12126 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12128 HvARRAY(dstr) = (HE**)darray;
12129 while (i <= sxhv->xhv_max) {
12130 const HE * const source = HvARRAY(sstr)[i];
12131 HvARRAY(dstr)[i] = source
12132 ? he_dup(source, sharekeys, param) : 0;
12136 const struct xpvhv_aux * const saux = HvAUX(sstr);
12137 struct xpvhv_aux * const daux = HvAUX(dstr);
12138 /* This flag isn't copied. */
12141 if (saux->xhv_name_count) {
12142 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12144 = saux->xhv_name_count < 0
12145 ? -saux->xhv_name_count
12146 : saux->xhv_name_count;
12147 HEK **shekp = sname + count;
12149 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12150 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12151 while (shekp-- > sname) {
12153 *dhekp = hek_dup(*shekp, param);
12157 daux->xhv_name_u.xhvnameu_name
12158 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12161 daux->xhv_name_count = saux->xhv_name_count;
12163 daux->xhv_riter = saux->xhv_riter;
12164 daux->xhv_eiter = saux->xhv_eiter
12165 ? he_dup(saux->xhv_eiter,
12166 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12167 /* backref array needs refcnt=2; see sv_add_backref */
12168 daux->xhv_backreferences =
12169 (param->flags & CLONEf_JOIN_IN)
12170 /* when joining, we let the individual GVs and
12171 * CVs add themselves to backref as
12172 * needed. This avoids pulling in stuff
12173 * that isn't required, and simplifies the
12174 * case where stashes aren't cloned back
12175 * if they already exist in the parent
12178 : saux->xhv_backreferences
12179 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12180 ? MUTABLE_AV(SvREFCNT_inc(
12181 sv_dup_inc((const SV *)
12182 saux->xhv_backreferences, param)))
12183 : MUTABLE_AV(sv_dup((const SV *)
12184 saux->xhv_backreferences, param))
12187 daux->xhv_mro_meta = saux->xhv_mro_meta
12188 ? mro_meta_dup(saux->xhv_mro_meta, param)
12190 daux->xhv_super = NULL;
12192 /* Record stashes for possible cloning in Perl_clone(). */
12194 av_push(param->stashes, dstr);
12198 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12201 if (!(param->flags & CLONEf_COPY_STACKS)) {
12206 /* NOTE: not refcounted */
12207 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12208 hv_dup(CvSTASH(dstr), param);
12209 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12210 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12211 if (!CvISXSUB(dstr)) {
12213 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12215 CvSLABBED_off(dstr);
12216 } else if (CvCONST(dstr)) {
12217 CvXSUBANY(dstr).any_ptr =
12218 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12220 assert(!CvSLABBED(dstr));
12221 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12223 SvANY((CV *)dstr)->xcv_gv_u.xcv_hek =
12224 share_hek_hek(CvNAME_HEK((CV *)sstr));
12225 /* don't dup if copying back - CvGV isn't refcounted, so the
12226 * duped GV may never be freed. A bit of a hack! DAPM */
12228 SvANY(MUTABLE_CV(dstr))->xcv_gv_u.xcv_gv =
12230 ? gv_dup_inc(CvGV(sstr), param)
12231 : (param->flags & CLONEf_JOIN_IN)
12233 : gv_dup(CvGV(sstr), param);
12235 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12237 CvWEAKOUTSIDE(sstr)
12238 ? cv_dup( CvOUTSIDE(dstr), param)
12239 : cv_dup_inc(CvOUTSIDE(dstr), param);
12245 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12252 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12254 PERL_ARGS_ASSERT_SV_DUP_INC;
12255 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12259 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12261 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12262 PERL_ARGS_ASSERT_SV_DUP;
12264 /* Track every SV that (at least initially) had a reference count of 0.
12265 We need to do this by holding an actual reference to it in this array.
12266 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12267 (akin to the stashes hash, and the perl stack), we come unstuck if
12268 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12269 thread) is manipulated in a CLONE method, because CLONE runs before the
12270 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12271 (and fix things up by giving each a reference via the temps stack).
12272 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12273 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12274 before the walk of unreferenced happens and a reference to that is SV
12275 added to the temps stack. At which point we have the same SV considered
12276 to be in use, and free to be re-used. Not good.
12278 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12279 assert(param->unreferenced);
12280 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12286 /* duplicate a context */
12289 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12291 PERL_CONTEXT *ncxs;
12293 PERL_ARGS_ASSERT_CX_DUP;
12296 return (PERL_CONTEXT*)NULL;
12298 /* look for it in the table first */
12299 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12303 /* create anew and remember what it is */
12304 Newx(ncxs, max + 1, PERL_CONTEXT);
12305 ptr_table_store(PL_ptr_table, cxs, ncxs);
12306 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12309 PERL_CONTEXT * const ncx = &ncxs[ix];
12310 if (CxTYPE(ncx) == CXt_SUBST) {
12311 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12314 ncx->blk_oldcop = (COP*)any_dup(ncx->blk_oldcop, param->proto_perl);
12315 switch (CxTYPE(ncx)) {
12317 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12318 ? cv_dup_inc(ncx->blk_sub.cv, param)
12319 : cv_dup(ncx->blk_sub.cv,param));
12320 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12321 ? av_dup_inc(ncx->blk_sub.argarray,
12324 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12326 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12327 ncx->blk_sub.oldcomppad);
12330 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12332 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12333 ncx->blk_eval.cv = cv_dup(ncx->blk_eval.cv, param);
12335 case CXt_LOOP_LAZYSV:
12336 ncx->blk_loop.state_u.lazysv.end
12337 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12338 /* We are taking advantage of av_dup_inc and sv_dup_inc
12339 actually being the same function, and order equivalence of
12341 We can assert the later [but only at run time :-(] */
12342 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12343 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12345 ncx->blk_loop.state_u.ary.ary
12346 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12347 case CXt_LOOP_LAZYIV:
12348 case CXt_LOOP_PLAIN:
12349 if (CxPADLOOP(ncx)) {
12350 ncx->blk_loop.itervar_u.oldcomppad
12351 = (PAD*)ptr_table_fetch(PL_ptr_table,
12352 ncx->blk_loop.itervar_u.oldcomppad);
12354 ncx->blk_loop.itervar_u.gv
12355 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12360 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12361 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12362 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12377 /* duplicate a stack info structure */
12380 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12384 PERL_ARGS_ASSERT_SI_DUP;
12387 return (PERL_SI*)NULL;
12389 /* look for it in the table first */
12390 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12394 /* create anew and remember what it is */
12395 Newxz(nsi, 1, PERL_SI);
12396 ptr_table_store(PL_ptr_table, si, nsi);
12398 nsi->si_stack = av_dup_inc(si->si_stack, param);
12399 nsi->si_cxix = si->si_cxix;
12400 nsi->si_cxmax = si->si_cxmax;
12401 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12402 nsi->si_type = si->si_type;
12403 nsi->si_prev = si_dup(si->si_prev, param);
12404 nsi->si_next = si_dup(si->si_next, param);
12405 nsi->si_markoff = si->si_markoff;
12410 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12411 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12412 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12413 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12414 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12415 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12416 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12417 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12418 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12419 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12420 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12421 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12422 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12423 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12424 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12425 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12428 #define pv_dup_inc(p) SAVEPV(p)
12429 #define pv_dup(p) SAVEPV(p)
12430 #define svp_dup_inc(p,pp) any_dup(p,pp)
12432 /* map any object to the new equivent - either something in the
12433 * ptr table, or something in the interpreter structure
12437 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12441 PERL_ARGS_ASSERT_ANY_DUP;
12444 return (void*)NULL;
12446 /* look for it in the table first */
12447 ret = ptr_table_fetch(PL_ptr_table, v);
12451 /* see if it is part of the interpreter structure */
12452 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12453 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12461 /* duplicate the save stack */
12464 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12467 ANY * const ss = proto_perl->Isavestack;
12468 const I32 max = proto_perl->Isavestack_max;
12469 I32 ix = proto_perl->Isavestack_ix;
12482 void (*dptr) (void*);
12483 void (*dxptr) (pTHX_ void*);
12485 PERL_ARGS_ASSERT_SS_DUP;
12487 Newxz(nss, max, ANY);
12490 const UV uv = POPUV(ss,ix);
12491 const U8 type = (U8)uv & SAVE_MASK;
12493 TOPUV(nss,ix) = uv;
12495 case SAVEt_CLEARSV:
12496 case SAVEt_CLEARPADRANGE:
12498 case SAVEt_HELEM: /* hash element */
12499 sv = (const SV *)POPPTR(ss,ix);
12500 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12502 case SAVEt_ITEM: /* normal string */
12503 case SAVEt_GVSV: /* scalar slot in GV */
12504 case SAVEt_SV: /* scalar reference */
12505 sv = (const SV *)POPPTR(ss,ix);
12506 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12509 case SAVEt_MORTALIZESV:
12510 sv = (const SV *)POPPTR(ss,ix);
12511 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12513 case SAVEt_SHARED_PVREF: /* char* in shared space */
12514 c = (char*)POPPTR(ss,ix);
12515 TOPPTR(nss,ix) = savesharedpv(c);
12516 ptr = POPPTR(ss,ix);
12517 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12519 case SAVEt_GENERIC_SVREF: /* generic sv */
12520 case SAVEt_SVREF: /* scalar reference */
12521 sv = (const SV *)POPPTR(ss,ix);
12522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12523 ptr = POPPTR(ss,ix);
12524 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12526 case SAVEt_HV: /* hash reference */
12527 case SAVEt_AV: /* array reference */
12528 sv = (const SV *) POPPTR(ss,ix);
12529 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12531 case SAVEt_COMPPAD:
12533 sv = (const SV *) POPPTR(ss,ix);
12534 TOPPTR(nss,ix) = sv_dup(sv, param);
12536 case SAVEt_INT: /* int reference */
12537 ptr = POPPTR(ss,ix);
12538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12539 intval = (int)POPINT(ss,ix);
12540 TOPINT(nss,ix) = intval;
12542 case SAVEt_LONG: /* long reference */
12543 ptr = POPPTR(ss,ix);
12544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12545 longval = (long)POPLONG(ss,ix);
12546 TOPLONG(nss,ix) = longval;
12548 case SAVEt_I32: /* I32 reference */
12549 ptr = POPPTR(ss,ix);
12550 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12552 TOPINT(nss,ix) = i;
12554 case SAVEt_IV: /* IV reference */
12555 ptr = POPPTR(ss,ix);
12556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12558 TOPIV(nss,ix) = iv;
12560 case SAVEt_HPTR: /* HV* reference */
12561 case SAVEt_APTR: /* AV* reference */
12562 case SAVEt_SPTR: /* SV* reference */
12563 ptr = POPPTR(ss,ix);
12564 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12565 sv = (const SV *)POPPTR(ss,ix);
12566 TOPPTR(nss,ix) = sv_dup(sv, param);
12568 case SAVEt_VPTR: /* random* reference */
12569 ptr = POPPTR(ss,ix);
12570 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12572 case SAVEt_INT_SMALL:
12573 case SAVEt_I32_SMALL:
12574 case SAVEt_I16: /* I16 reference */
12575 case SAVEt_I8: /* I8 reference */
12577 ptr = POPPTR(ss,ix);
12578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12580 case SAVEt_GENERIC_PVREF: /* generic char* */
12581 case SAVEt_PPTR: /* char* reference */
12582 ptr = POPPTR(ss,ix);
12583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12584 c = (char*)POPPTR(ss,ix);
12585 TOPPTR(nss,ix) = pv_dup(c);
12587 case SAVEt_GP: /* scalar reference */
12588 gp = (GP*)POPPTR(ss,ix);
12589 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12590 (void)GpREFCNT_inc(gp);
12591 gv = (const GV *)POPPTR(ss,ix);
12592 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12595 ptr = POPPTR(ss,ix);
12596 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12597 /* these are assumed to be refcounted properly */
12599 switch (((OP*)ptr)->op_type) {
12601 case OP_LEAVESUBLV:
12605 case OP_LEAVEWRITE:
12606 TOPPTR(nss,ix) = ptr;
12609 (void) OpREFCNT_inc(o);
12613 TOPPTR(nss,ix) = NULL;
12618 TOPPTR(nss,ix) = NULL;
12620 case SAVEt_FREECOPHH:
12621 ptr = POPPTR(ss,ix);
12622 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12625 hv = (const HV *)POPPTR(ss,ix);
12626 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12628 TOPINT(nss,ix) = i;
12631 c = (char*)POPPTR(ss,ix);
12632 TOPPTR(nss,ix) = pv_dup_inc(c);
12634 case SAVEt_STACK_POS: /* Position on Perl stack */
12636 TOPINT(nss,ix) = i;
12638 case SAVEt_DESTRUCTOR:
12639 ptr = POPPTR(ss,ix);
12640 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12641 dptr = POPDPTR(ss,ix);
12642 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12643 any_dup(FPTR2DPTR(void *, dptr),
12646 case SAVEt_DESTRUCTOR_X:
12647 ptr = POPPTR(ss,ix);
12648 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12649 dxptr = POPDXPTR(ss,ix);
12650 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12651 any_dup(FPTR2DPTR(void *, dxptr),
12654 case SAVEt_REGCONTEXT:
12656 ix -= uv >> SAVE_TIGHT_SHIFT;
12658 case SAVEt_AELEM: /* array element */
12659 sv = (const SV *)POPPTR(ss,ix);
12660 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12662 TOPINT(nss,ix) = i;
12663 av = (const AV *)POPPTR(ss,ix);
12664 TOPPTR(nss,ix) = av_dup_inc(av, param);
12667 ptr = POPPTR(ss,ix);
12668 TOPPTR(nss,ix) = ptr;
12671 ptr = POPPTR(ss,ix);
12672 ptr = cophh_copy((COPHH*)ptr);
12673 TOPPTR(nss,ix) = ptr;
12675 TOPINT(nss,ix) = i;
12676 if (i & HINT_LOCALIZE_HH) {
12677 hv = (const HV *)POPPTR(ss,ix);
12678 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12681 case SAVEt_PADSV_AND_MORTALIZE:
12682 longval = (long)POPLONG(ss,ix);
12683 TOPLONG(nss,ix) = longval;
12684 ptr = POPPTR(ss,ix);
12685 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12686 sv = (const SV *)POPPTR(ss,ix);
12687 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12689 case SAVEt_SET_SVFLAGS:
12691 TOPINT(nss,ix) = i;
12693 TOPINT(nss,ix) = i;
12694 sv = (const SV *)POPPTR(ss,ix);
12695 TOPPTR(nss,ix) = sv_dup(sv, param);
12697 case SAVEt_RE_STATE:
12699 const struct re_save_state *const old_state
12700 = (struct re_save_state *)
12701 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12702 struct re_save_state *const new_state
12703 = (struct re_save_state *)
12704 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12706 Copy(old_state, new_state, 1, struct re_save_state);
12707 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12709 new_state->re_state_bostr
12710 = pv_dup(old_state->re_state_bostr);
12711 new_state->re_state_regeol
12712 = pv_dup(old_state->re_state_regeol);
12713 #ifdef PERL_OLD_COPY_ON_WRITE
12714 new_state->re_state_nrs
12715 = sv_dup(old_state->re_state_nrs, param);
12717 new_state->re_state_reg_magic
12718 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12720 new_state->re_state_reg_oldcurpm
12721 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12723 new_state->re_state_reg_curpm
12724 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12726 new_state->re_state_reg_oldsaved
12727 = pv_dup(old_state->re_state_reg_oldsaved);
12728 new_state->re_state_reg_poscache
12729 = pv_dup(old_state->re_state_reg_poscache);
12730 new_state->re_state_reg_starttry
12731 = pv_dup(old_state->re_state_reg_starttry);
12734 case SAVEt_COMPILE_WARNINGS:
12735 ptr = POPPTR(ss,ix);
12736 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12739 ptr = POPPTR(ss,ix);
12740 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12744 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12752 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12753 * flag to the result. This is done for each stash before cloning starts,
12754 * so we know which stashes want their objects cloned */
12757 do_mark_cloneable_stash(pTHX_ SV *const sv)
12759 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12761 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12762 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12763 if (cloner && GvCV(cloner)) {
12770 mXPUSHs(newSVhek(hvname));
12772 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12779 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12787 =for apidoc perl_clone
12789 Create and return a new interpreter by cloning the current one.
12791 perl_clone takes these flags as parameters:
12793 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12794 without it we only clone the data and zero the stacks,
12795 with it we copy the stacks and the new perl interpreter is
12796 ready to run at the exact same point as the previous one.
12797 The pseudo-fork code uses COPY_STACKS while the
12798 threads->create doesn't.
12800 CLONEf_KEEP_PTR_TABLE -
12801 perl_clone keeps a ptr_table with the pointer of the old
12802 variable as a key and the new variable as a value,
12803 this allows it to check if something has been cloned and not
12804 clone it again but rather just use the value and increase the
12805 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12806 the ptr_table using the function
12807 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12808 reason to keep it around is if you want to dup some of your own
12809 variable who are outside the graph perl scans, example of this
12810 code is in threads.xs create.
12812 CLONEf_CLONE_HOST -
12813 This is a win32 thing, it is ignored on unix, it tells perls
12814 win32host code (which is c++) to clone itself, this is needed on
12815 win32 if you want to run two threads at the same time,
12816 if you just want to do some stuff in a separate perl interpreter
12817 and then throw it away and return to the original one,
12818 you don't need to do anything.
12823 /* XXX the above needs expanding by someone who actually understands it ! */
12824 EXTERN_C PerlInterpreter *
12825 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12828 perl_clone(PerlInterpreter *proto_perl, UV flags)
12831 #ifdef PERL_IMPLICIT_SYS
12833 PERL_ARGS_ASSERT_PERL_CLONE;
12835 /* perlhost.h so we need to call into it
12836 to clone the host, CPerlHost should have a c interface, sky */
12838 if (flags & CLONEf_CLONE_HOST) {
12839 return perl_clone_host(proto_perl,flags);
12841 return perl_clone_using(proto_perl, flags,
12843 proto_perl->IMemShared,
12844 proto_perl->IMemParse,
12846 proto_perl->IStdIO,
12850 proto_perl->IProc);
12854 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12855 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12856 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12857 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12858 struct IPerlDir* ipD, struct IPerlSock* ipS,
12859 struct IPerlProc* ipP)
12861 /* XXX many of the string copies here can be optimized if they're
12862 * constants; they need to be allocated as common memory and just
12863 * their pointers copied. */
12866 CLONE_PARAMS clone_params;
12867 CLONE_PARAMS* const param = &clone_params;
12869 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12871 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12872 #else /* !PERL_IMPLICIT_SYS */
12874 CLONE_PARAMS clone_params;
12875 CLONE_PARAMS* param = &clone_params;
12876 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12878 PERL_ARGS_ASSERT_PERL_CLONE;
12879 #endif /* PERL_IMPLICIT_SYS */
12881 /* for each stash, determine whether its objects should be cloned */
12882 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12883 PERL_SET_THX(my_perl);
12886 PoisonNew(my_perl, 1, PerlInterpreter);
12889 PL_defstash = NULL; /* may be used by perl malloc() */
12892 PL_scopestack_name = 0;
12894 PL_savestack_ix = 0;
12895 PL_savestack_max = -1;
12896 PL_sig_pending = 0;
12898 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12899 # ifdef DEBUG_LEAKING_SCALARS
12900 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12902 #else /* !DEBUGGING */
12903 Zero(my_perl, 1, PerlInterpreter);
12904 #endif /* DEBUGGING */
12906 #ifdef PERL_IMPLICIT_SYS
12907 /* host pointers */
12909 PL_MemShared = ipMS;
12910 PL_MemParse = ipMP;
12917 #endif /* PERL_IMPLICIT_SYS */
12919 param->flags = flags;
12920 /* Nothing in the core code uses this, but we make it available to
12921 extensions (using mg_dup). */
12922 param->proto_perl = proto_perl;
12923 /* Likely nothing will use this, but it is initialised to be consistent
12924 with Perl_clone_params_new(). */
12925 param->new_perl = my_perl;
12926 param->unreferenced = NULL;
12928 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12930 PL_body_arenas = NULL;
12931 Zero(&PL_body_roots, 1, PL_body_roots);
12934 PL_sv_objcount = 0;
12936 PL_sv_arenaroot = NULL;
12938 PL_debug = proto_perl->Idebug;
12940 PL_hash_seed = proto_perl->Ihash_seed;
12941 PL_rehash_seed = proto_perl->Irehash_seed;
12943 /* dbargs array probably holds garbage */
12946 PL_compiling = proto_perl->Icompiling;
12948 /* pseudo environmental stuff */
12949 PL_origargc = proto_perl->Iorigargc;
12950 PL_origargv = proto_perl->Iorigargv;
12952 #if !NO_TAINT_SUPPORT
12953 /* Set tainting stuff before PerlIO_debug can possibly get called */
12954 PL_tainting = proto_perl->Itainting;
12955 PL_taint_warn = proto_perl->Itaint_warn;
12957 PL_tainting = FALSE;
12958 PL_taint_warn = FALSE;
12961 PL_minus_c = proto_perl->Iminus_c;
12963 PL_localpatches = proto_perl->Ilocalpatches;
12964 PL_splitstr = proto_perl->Isplitstr;
12965 PL_minus_n = proto_perl->Iminus_n;
12966 PL_minus_p = proto_perl->Iminus_p;
12967 PL_minus_l = proto_perl->Iminus_l;
12968 PL_minus_a = proto_perl->Iminus_a;
12969 PL_minus_E = proto_perl->Iminus_E;
12970 PL_minus_F = proto_perl->Iminus_F;
12971 PL_doswitches = proto_perl->Idoswitches;
12972 PL_dowarn = proto_perl->Idowarn;
12973 PL_sawampersand = proto_perl->Isawampersand;
12974 PL_unsafe = proto_perl->Iunsafe;
12975 PL_perldb = proto_perl->Iperldb;
12976 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12977 PL_exit_flags = proto_perl->Iexit_flags;
12979 /* XXX time(&PL_basetime) when asked for? */
12980 PL_basetime = proto_perl->Ibasetime;
12982 PL_maxsysfd = proto_perl->Imaxsysfd;
12983 PL_statusvalue = proto_perl->Istatusvalue;
12985 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12987 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12990 /* RE engine related */
12991 Zero(&PL_reg_state, 1, struct re_save_state);
12992 PL_regmatch_slab = NULL;
12994 PL_sub_generation = proto_perl->Isub_generation;
12996 /* funky return mechanisms */
12997 PL_forkprocess = proto_perl->Iforkprocess;
12999 /* internal state */
13000 PL_maxo = proto_perl->Imaxo;
13002 PL_main_start = proto_perl->Imain_start;
13003 PL_eval_root = proto_perl->Ieval_root;
13004 PL_eval_start = proto_perl->Ieval_start;
13006 PL_filemode = proto_perl->Ifilemode;
13007 PL_lastfd = proto_perl->Ilastfd;
13008 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13011 PL_gensym = proto_perl->Igensym;
13013 PL_laststatval = proto_perl->Ilaststatval;
13014 PL_laststype = proto_perl->Ilaststype;
13017 PL_profiledata = NULL;
13019 PL_generation = proto_perl->Igeneration;
13021 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13022 PL_in_clean_all = proto_perl->Iin_clean_all;
13024 PL_delaymagic_uid = proto_perl->Idelaymagic_uid;
13025 PL_delaymagic_euid = proto_perl->Idelaymagic_euid;
13026 PL_delaymagic_gid = proto_perl->Idelaymagic_gid;
13027 PL_delaymagic_egid = proto_perl->Idelaymagic_egid;
13028 PL_nomemok = proto_perl->Inomemok;
13029 PL_an = proto_perl->Ian;
13030 PL_evalseq = proto_perl->Ievalseq;
13031 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13032 PL_origalen = proto_perl->Iorigalen;
13034 PL_sighandlerp = proto_perl->Isighandlerp;
13036 PL_runops = proto_perl->Irunops;
13038 PL_subline = proto_perl->Isubline;
13041 PL_cryptseen = proto_perl->Icryptseen;
13044 PL_hints = proto_perl->Ihints;
13046 #ifdef USE_LOCALE_COLLATE
13047 PL_collation_ix = proto_perl->Icollation_ix;
13048 PL_collation_standard = proto_perl->Icollation_standard;
13049 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13050 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13051 #endif /* USE_LOCALE_COLLATE */
13053 #ifdef USE_LOCALE_NUMERIC
13054 PL_numeric_standard = proto_perl->Inumeric_standard;
13055 PL_numeric_local = proto_perl->Inumeric_local;
13056 #endif /* !USE_LOCALE_NUMERIC */
13058 /* Did the locale setup indicate UTF-8? */
13059 PL_utf8locale = proto_perl->Iutf8locale;
13060 /* Unicode features (see perlrun/-C) */
13061 PL_unicode = proto_perl->Iunicode;
13063 /* Pre-5.8 signals control */
13064 PL_signals = proto_perl->Isignals;
13066 /* times() ticks per second */
13067 PL_clocktick = proto_perl->Iclocktick;
13069 /* Recursion stopper for PerlIO_find_layer */
13070 PL_in_load_module = proto_perl->Iin_load_module;
13072 /* sort() routine */
13073 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13075 /* Not really needed/useful since the reenrant_retint is "volatile",
13076 * but do it for consistency's sake. */
13077 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13079 /* Hooks to shared SVs and locks. */
13080 PL_sharehook = proto_perl->Isharehook;
13081 PL_lockhook = proto_perl->Ilockhook;
13082 PL_unlockhook = proto_perl->Iunlockhook;
13083 PL_threadhook = proto_perl->Ithreadhook;
13084 PL_destroyhook = proto_perl->Idestroyhook;
13085 PL_signalhook = proto_perl->Isignalhook;
13087 PL_globhook = proto_perl->Iglobhook;
13090 PL_last_swash_hv = NULL; /* reinits on demand */
13091 PL_last_swash_klen = 0;
13092 PL_last_swash_key[0]= '\0';
13093 PL_last_swash_tmps = (U8*)NULL;
13094 PL_last_swash_slen = 0;
13096 PL_glob_index = proto_perl->Iglob_index;
13097 PL_srand_called = proto_perl->Isrand_called;
13099 if (flags & CLONEf_COPY_STACKS) {
13100 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13101 PL_tmps_ix = proto_perl->Itmps_ix;
13102 PL_tmps_max = proto_perl->Itmps_max;
13103 PL_tmps_floor = proto_perl->Itmps_floor;
13105 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13106 * NOTE: unlike the others! */
13107 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13108 PL_scopestack_max = proto_perl->Iscopestack_max;
13110 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13111 * NOTE: unlike the others! */
13112 PL_savestack_ix = proto_perl->Isavestack_ix;
13113 PL_savestack_max = proto_perl->Isavestack_max;
13116 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13117 PL_top_env = &PL_start_env;
13119 PL_op = proto_perl->Iop;
13122 PL_Xpv = (XPV*)NULL;
13123 my_perl->Ina = proto_perl->Ina;
13125 PL_statbuf = proto_perl->Istatbuf;
13126 PL_statcache = proto_perl->Istatcache;
13129 PL_timesbuf = proto_perl->Itimesbuf;
13132 #if !NO_TAINT_SUPPORT
13133 PL_tainted = proto_perl->Itainted;
13135 PL_tainted = FALSE;
13137 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13139 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13141 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13142 PL_restartop = proto_perl->Irestartop;
13143 PL_in_eval = proto_perl->Iin_eval;
13144 PL_delaymagic = proto_perl->Idelaymagic;
13145 PL_phase = proto_perl->Iphase;
13146 PL_localizing = proto_perl->Ilocalizing;
13148 PL_hv_fetch_ent_mh = NULL;
13149 PL_modcount = proto_perl->Imodcount;
13150 PL_lastgotoprobe = NULL;
13151 PL_dumpindent = proto_perl->Idumpindent;
13153 PL_efloatbuf = NULL; /* reinits on demand */
13154 PL_efloatsize = 0; /* reinits on demand */
13158 PL_regdummy = proto_perl->Iregdummy;
13159 PL_colorset = 0; /* reinits PL_colors[] */
13160 /*PL_colors[6] = {0,0,0,0,0,0};*/
13162 /* Pluggable optimizer */
13163 PL_peepp = proto_perl->Ipeepp;
13164 PL_rpeepp = proto_perl->Irpeepp;
13165 /* op_free() hook */
13166 PL_opfreehook = proto_perl->Iopfreehook;
13168 #ifdef USE_REENTRANT_API
13169 /* XXX: things like -Dm will segfault here in perlio, but doing
13170 * PERL_SET_CONTEXT(proto_perl);
13171 * breaks too many other things
13173 Perl_reentrant_init(aTHX);
13176 /* create SV map for pointer relocation */
13177 PL_ptr_table = ptr_table_new();
13179 /* initialize these special pointers as early as possible */
13181 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13182 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13183 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13185 /* create (a non-shared!) shared string table */
13186 PL_strtab = newHV();
13187 HvSHAREKEYS_off(PL_strtab);
13188 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13189 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13191 /* This PV will be free'd special way so must set it same way op.c does */
13192 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13193 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13195 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13196 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13197 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13198 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13200 param->stashes = newAV(); /* Setup array of objects to call clone on */
13201 /* This makes no difference to the implementation, as it always pushes
13202 and shifts pointers to other SVs without changing their reference
13203 count, with the array becoming empty before it is freed. However, it
13204 makes it conceptually clear what is going on, and will avoid some
13205 work inside av.c, filling slots between AvFILL() and AvMAX() with
13206 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13207 AvREAL_off(param->stashes);
13209 if (!(flags & CLONEf_COPY_STACKS)) {
13210 param->unreferenced = newAV();
13213 #ifdef PERLIO_LAYERS
13214 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13215 PerlIO_clone(aTHX_ proto_perl, param);
13218 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13219 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13220 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13221 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13222 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13223 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13226 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13227 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13228 PL_inplace = SAVEPV(proto_perl->Iinplace);
13229 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13231 /* magical thingies */
13233 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13235 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13236 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13237 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13240 /* Clone the regex array */
13241 /* ORANGE FIXME for plugins, probably in the SV dup code.
13242 newSViv(PTR2IV(CALLREGDUPE(
13243 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13245 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13246 PL_regex_pad = AvARRAY(PL_regex_padav);
13248 PL_stashpadmax = proto_perl->Istashpadmax;
13249 PL_stashpadix = proto_perl->Istashpadix ;
13250 Newx(PL_stashpad, PL_stashpadmax, HV *);
13253 for (; o < PL_stashpadmax; ++o)
13254 PL_stashpad[o] = hv_dup(proto_perl->Istashpad[o], param);
13257 /* shortcuts to various I/O objects */
13258 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13259 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13260 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13261 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13262 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13263 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13264 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13266 /* shortcuts to regexp stuff */
13267 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13269 /* shortcuts to misc objects */
13270 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13272 /* shortcuts to debugging objects */
13273 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13274 PL_DBline = gv_dup(proto_perl->IDBline, param);
13275 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13276 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13277 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13278 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13280 /* symbol tables */
13281 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13282 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13283 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13284 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13285 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13287 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13288 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13289 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13290 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13291 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13292 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13293 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13294 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13296 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13298 /* subprocess state */
13299 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13301 if (proto_perl->Iop_mask)
13302 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13305 /* PL_asserting = proto_perl->Iasserting; */
13307 /* current interpreter roots */
13308 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13310 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13313 /* runtime control stuff */
13314 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13316 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13318 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13320 /* interpreter atexit processing */
13321 PL_exitlistlen = proto_perl->Iexitlistlen;
13322 if (PL_exitlistlen) {
13323 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13324 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13327 PL_exitlist = (PerlExitListEntry*)NULL;
13329 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13330 if (PL_my_cxt_size) {
13331 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13332 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13333 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13334 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13335 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13339 PL_my_cxt_list = (void**)NULL;
13340 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13341 PL_my_cxt_keys = (const char**)NULL;
13344 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13345 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13346 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13347 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13349 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13351 PAD_CLONE_VARS(proto_perl, param);
13353 #ifdef HAVE_INTERP_INTERN
13354 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13357 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13359 #ifdef PERL_USES_PL_PIDSTATUS
13360 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13362 PL_osname = SAVEPV(proto_perl->Iosname);
13363 PL_parser = parser_dup(proto_perl->Iparser, param);
13365 /* XXX this only works if the saved cop has already been cloned */
13366 if (proto_perl->Iparser) {
13367 PL_parser->saved_curcop = (COP*)any_dup(
13368 proto_perl->Iparser->saved_curcop,
13372 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13374 #ifdef USE_LOCALE_COLLATE
13375 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13376 #endif /* USE_LOCALE_COLLATE */
13378 #ifdef USE_LOCALE_NUMERIC
13379 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13380 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13381 #endif /* !USE_LOCALE_NUMERIC */
13383 /* Unicode inversion lists */
13384 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13385 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13387 PL_PerlSpace = sv_dup_inc(proto_perl->IPerlSpace, param);
13388 PL_XPerlSpace = sv_dup_inc(proto_perl->IXPerlSpace, param);
13390 PL_L1PosixAlnum = sv_dup_inc(proto_perl->IL1PosixAlnum, param);
13391 PL_PosixAlnum = sv_dup_inc(proto_perl->IPosixAlnum, param);
13393 PL_L1PosixAlpha = sv_dup_inc(proto_perl->IL1PosixAlpha, param);
13394 PL_PosixAlpha = sv_dup_inc(proto_perl->IPosixAlpha, param);
13396 PL_PosixBlank = sv_dup_inc(proto_perl->IPosixBlank, param);
13397 PL_XPosixBlank = sv_dup_inc(proto_perl->IXPosixBlank, param);
13399 PL_L1Cased = sv_dup_inc(proto_perl->IL1Cased, param);
13401 PL_PosixCntrl = sv_dup_inc(proto_perl->IPosixCntrl, param);
13402 PL_XPosixCntrl = sv_dup_inc(proto_perl->IXPosixCntrl, param);
13404 PL_PosixDigit = sv_dup_inc(proto_perl->IPosixDigit, param);
13406 PL_L1PosixGraph = sv_dup_inc(proto_perl->IL1PosixGraph, param);
13407 PL_PosixGraph = sv_dup_inc(proto_perl->IPosixGraph, param);
13409 PL_L1PosixLower = sv_dup_inc(proto_perl->IL1PosixLower, param);
13410 PL_PosixLower = sv_dup_inc(proto_perl->IPosixLower, param);
13412 PL_L1PosixPrint = sv_dup_inc(proto_perl->IL1PosixPrint, param);
13413 PL_PosixPrint = sv_dup_inc(proto_perl->IPosixPrint, param);
13415 PL_L1PosixPunct = sv_dup_inc(proto_perl->IL1PosixPunct, param);
13416 PL_PosixPunct = sv_dup_inc(proto_perl->IPosixPunct, param);
13418 PL_PosixSpace = sv_dup_inc(proto_perl->IPosixSpace, param);
13419 PL_XPosixSpace = sv_dup_inc(proto_perl->IXPosixSpace, param);
13421 PL_L1PosixUpper = sv_dup_inc(proto_perl->IL1PosixUpper, param);
13422 PL_PosixUpper = sv_dup_inc(proto_perl->IPosixUpper, param);
13424 PL_L1PosixWord = sv_dup_inc(proto_perl->IL1PosixWord, param);
13425 PL_PosixWord = sv_dup_inc(proto_perl->IPosixWord, param);
13427 PL_PosixXDigit = sv_dup_inc(proto_perl->IPosixXDigit, param);
13428 PL_XPosixXDigit = sv_dup_inc(proto_perl->IXPosixXDigit, param);
13430 PL_VertSpace = sv_dup_inc(proto_perl->IVertSpace, param);
13432 PL_NonL1NonFinalFold = sv_dup_inc(proto_perl->INonL1NonFinalFold, param);
13433 PL_HasMultiCharFold= sv_dup_inc(proto_perl->IHasMultiCharFold, param);
13435 /* utf8 character class swashes */
13436 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13437 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13438 PL_utf8_blank = sv_dup_inc(proto_perl->Iutf8_blank, param);
13439 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13440 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13441 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13442 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13443 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13444 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13445 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13446 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13447 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13448 PL_utf8_X_regular_begin = sv_dup_inc(proto_perl->Iutf8_X_regular_begin, param);
13449 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13450 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13451 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13452 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13453 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13454 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13455 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13456 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13457 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13458 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13459 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13460 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13461 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13462 PL_AboveLatin1 = sv_dup_inc(proto_perl->IAboveLatin1, param);
13463 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13465 if (proto_perl->Ipsig_pend) {
13466 Newxz(PL_psig_pend, SIG_SIZE, int);
13469 PL_psig_pend = (int*)NULL;
13472 if (proto_perl->Ipsig_name) {
13473 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13474 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13476 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13479 PL_psig_ptr = (SV**)NULL;
13480 PL_psig_name = (SV**)NULL;
13483 if (flags & CLONEf_COPY_STACKS) {
13484 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13485 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13486 PL_tmps_ix+1, param);
13488 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13489 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13490 Newxz(PL_markstack, i, I32);
13491 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13492 - proto_perl->Imarkstack);
13493 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13494 - proto_perl->Imarkstack);
13495 Copy(proto_perl->Imarkstack, PL_markstack,
13496 PL_markstack_ptr - PL_markstack + 1, I32);
13498 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13499 * NOTE: unlike the others! */
13500 Newxz(PL_scopestack, PL_scopestack_max, I32);
13501 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13504 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13505 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13507 /* NOTE: si_dup() looks at PL_markstack */
13508 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13510 /* PL_curstack = PL_curstackinfo->si_stack; */
13511 PL_curstack = av_dup(proto_perl->Icurstack, param);
13512 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13514 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13515 PL_stack_base = AvARRAY(PL_curstack);
13516 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13517 - proto_perl->Istack_base);
13518 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13520 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13521 PL_savestack = ss_dup(proto_perl, param);
13525 ENTER; /* perl_destruct() wants to LEAVE; */
13528 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13529 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13531 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13532 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13533 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13534 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13535 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13536 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13538 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13540 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13541 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13542 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13543 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13545 PL_stashcache = newHV();
13547 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13548 proto_perl->Iwatchaddr);
13549 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13550 if (PL_debug && PL_watchaddr) {
13551 PerlIO_printf(Perl_debug_log,
13552 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13553 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13554 PTR2UV(PL_watchok));
13557 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13558 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13559 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13561 /* Call the ->CLONE method, if it exists, for each of the stashes
13562 identified by sv_dup() above.
13564 while(av_len(param->stashes) != -1) {
13565 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13566 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13567 if (cloner && GvCV(cloner)) {
13572 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13574 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13580 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13581 ptr_table_free(PL_ptr_table);
13582 PL_ptr_table = NULL;
13585 if (!(flags & CLONEf_COPY_STACKS)) {
13586 unreferenced_to_tmp_stack(param->unreferenced);
13589 SvREFCNT_dec(param->stashes);
13591 /* orphaned? eg threads->new inside BEGIN or use */
13592 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13593 SvREFCNT_inc_simple_void(PL_compcv);
13594 SAVEFREESV(PL_compcv);
13601 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13603 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13605 if (AvFILLp(unreferenced) > -1) {
13606 SV **svp = AvARRAY(unreferenced);
13607 SV **const last = svp + AvFILLp(unreferenced);
13611 if (SvREFCNT(*svp) == 1)
13613 } while (++svp <= last);
13615 EXTEND_MORTAL(count);
13616 svp = AvARRAY(unreferenced);
13619 if (SvREFCNT(*svp) == 1) {
13620 /* Our reference is the only one to this SV. This means that
13621 in this thread, the scalar effectively has a 0 reference.
13622 That doesn't work (cleanup never happens), so donate our
13623 reference to it onto the save stack. */
13624 PL_tmps_stack[++PL_tmps_ix] = *svp;
13626 /* As an optimisation, because we are already walking the
13627 entire array, instead of above doing either
13628 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13629 release our reference to the scalar, so that at the end of
13630 the array owns zero references to the scalars it happens to
13631 point to. We are effectively converting the array from
13632 AvREAL() on to AvREAL() off. This saves the av_clear()
13633 (triggered by the SvREFCNT_dec(unreferenced) below) from
13634 walking the array a second time. */
13635 SvREFCNT_dec(*svp);
13638 } while (++svp <= last);
13639 AvREAL_off(unreferenced);
13641 SvREFCNT_dec(unreferenced);
13645 Perl_clone_params_del(CLONE_PARAMS *param)
13647 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13649 PerlInterpreter *const to = param->new_perl;
13651 PerlInterpreter *const was = PERL_GET_THX;
13653 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13659 SvREFCNT_dec(param->stashes);
13660 if (param->unreferenced)
13661 unreferenced_to_tmp_stack(param->unreferenced);
13671 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13674 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13675 does a dTHX; to get the context from thread local storage.
13676 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13677 a version that passes in my_perl. */
13678 PerlInterpreter *const was = PERL_GET_THX;
13679 CLONE_PARAMS *param;
13681 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13687 /* Given that we've set the context, we can do this unshared. */
13688 Newx(param, 1, CLONE_PARAMS);
13691 param->proto_perl = from;
13692 param->new_perl = to;
13693 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13694 AvREAL_off(param->stashes);
13695 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13703 #endif /* USE_ITHREADS */
13706 Perl_init_constants(pTHX)
13708 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
13709 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
13710 SvANY(&PL_sv_undef) = NULL;
13712 SvANY(&PL_sv_no) = new_XPVNV();
13713 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
13714 SvFLAGS(&PL_sv_no) = SVt_PVNV|SVf_READONLY
13715 |SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
13718 SvANY(&PL_sv_yes) = new_XPVNV();
13719 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
13720 SvFLAGS(&PL_sv_yes) = SVt_PVNV|SVf_READONLY
13721 |SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
13724 SvPV_set(&PL_sv_no, (char*)PL_No);
13725 SvCUR_set(&PL_sv_no, 0);
13726 SvLEN_set(&PL_sv_no, 0);
13727 SvIV_set(&PL_sv_no, 0);
13728 SvNV_set(&PL_sv_no, 0);
13730 SvPV_set(&PL_sv_yes, (char*)PL_Yes);
13731 SvCUR_set(&PL_sv_yes, 1);
13732 SvLEN_set(&PL_sv_yes, 0);
13733 SvIV_set(&PL_sv_yes, 1);
13734 SvNV_set(&PL_sv_yes, 1);
13738 =head1 Unicode Support
13740 =for apidoc sv_recode_to_utf8
13742 The encoding is assumed to be an Encode object, on entry the PV
13743 of the sv is assumed to be octets in that encoding, and the sv
13744 will be converted into Unicode (and UTF-8).
13746 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13747 is not a reference, nothing is done to the sv. If the encoding is not
13748 an C<Encode::XS> Encoding object, bad things will happen.
13749 (See F<lib/encoding.pm> and L<Encode>.)
13751 The PV of the sv is returned.
13756 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13760 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13762 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13776 Passing sv_yes is wrong - it needs to be or'ed set of constants
13777 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13778 remove converted chars from source.
13780 Both will default the value - let them.
13782 XPUSHs(&PL_sv_yes);
13785 call_method("decode", G_SCALAR);
13789 s = SvPV_const(uni, len);
13790 if (s != SvPVX_const(sv)) {
13791 SvGROW(sv, len + 1);
13792 Move(s, SvPVX(sv), len + 1, char);
13793 SvCUR_set(sv, len);
13797 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13798 /* clear pos and any utf8 cache */
13799 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13802 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13803 magic_setutf8(sv,mg); /* clear UTF8 cache */
13808 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13812 =for apidoc sv_cat_decode
13814 The encoding is assumed to be an Encode object, the PV of the ssv is
13815 assumed to be octets in that encoding and decoding the input starts
13816 from the position which (PV + *offset) pointed to. The dsv will be
13817 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13818 when the string tstr appears in decoding output or the input ends on
13819 the PV of the ssv. The value which the offset points will be modified
13820 to the last input position on the ssv.
13822 Returns TRUE if the terminator was found, else returns FALSE.
13827 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13828 SV *ssv, int *offset, char *tstr, int tlen)
13833 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13835 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13846 offsv = newSViv(*offset);
13848 mPUSHp(tstr, tlen);
13850 call_method("cat_decode", G_SCALAR);
13852 ret = SvTRUE(TOPs);
13853 *offset = SvIV(offsv);
13859 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13864 /* ---------------------------------------------------------------------
13866 * support functions for report_uninit()
13869 /* the maxiumum size of array or hash where we will scan looking
13870 * for the undefined element that triggered the warning */
13872 #define FUV_MAX_SEARCH_SIZE 1000
13874 /* Look for an entry in the hash whose value has the same SV as val;
13875 * If so, return a mortal copy of the key. */
13878 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13884 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13886 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13887 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13890 array = HvARRAY(hv);
13892 for (i=HvMAX(hv); i>=0; i--) {
13894 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13895 if (HeVAL(entry) != val)
13897 if ( HeVAL(entry) == &PL_sv_undef ||
13898 HeVAL(entry) == &PL_sv_placeholder)
13902 if (HeKLEN(entry) == HEf_SVKEY)
13903 return sv_mortalcopy(HeKEY_sv(entry));
13904 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13910 /* Look for an entry in the array whose value has the same SV as val;
13911 * If so, return the index, otherwise return -1. */
13914 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13918 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13920 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13921 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13924 if (val != &PL_sv_undef) {
13925 SV ** const svp = AvARRAY(av);
13928 for (i=AvFILLp(av); i>=0; i--)
13935 /* varname(): return the name of a variable, optionally with a subscript.
13936 * If gv is non-zero, use the name of that global, along with gvtype (one
13937 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13938 * targ. Depending on the value of the subscript_type flag, return:
13941 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13942 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13943 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13944 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13947 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13948 const SV *const keyname, I32 aindex, int subscript_type)
13951 SV * const name = sv_newmortal();
13952 if (gv && isGV(gv)) {
13954 buffer[0] = gvtype;
13957 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13959 gv_fullname4(name, gv, buffer, 0);
13961 if ((unsigned int)SvPVX(name)[1] <= 26) {
13963 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13965 /* Swap the 1 unprintable control character for the 2 byte pretty
13966 version - ie substr($name, 1, 1) = $buffer; */
13967 sv_insert(name, 1, 1, buffer, 2);
13971 CV * const cv = gv ? ((CV *)gv) : find_runcv(NULL);
13975 assert(!cv || SvTYPE(cv) == SVt_PVCV || SvTYPE(cv) == SVt_PVFM);
13977 if (!cv || !CvPADLIST(cv))
13979 av = *PadlistARRAY(CvPADLIST(cv));
13980 sv = *av_fetch(av, targ, FALSE);
13981 sv_setsv_flags(name, sv, 0);
13984 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13985 SV * const sv = newSV(0);
13986 *SvPVX(name) = '$';
13987 Perl_sv_catpvf(aTHX_ name, "{%s}",
13988 pv_pretty(sv, SvPVX_const(keyname), SvCUR(keyname), 32, NULL, NULL,
13989 PERL_PV_PRETTY_DUMP | PERL_PV_ESCAPE_UNI_DETECT ));
13992 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13993 *SvPVX(name) = '$';
13994 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13996 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13997 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13998 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
14006 =for apidoc find_uninit_var
14008 Find the name of the undefined variable (if any) that caused the operator
14009 to issue a "Use of uninitialized value" warning.
14010 If match is true, only return a name if its value matches uninit_sv.
14011 So roughly speaking, if a unary operator (such as OP_COS) generates a
14012 warning, then following the direct child of the op may yield an
14013 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
14014 other hand, with OP_ADD there are two branches to follow, so we only print
14015 the variable name if we get an exact match.
14017 The name is returned as a mortal SV.
14019 Assumes that PL_op is the op that originally triggered the error, and that
14020 PL_comppad/PL_curpad points to the currently executing pad.
14026 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
14032 const OP *o, *o2, *kid;
14034 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
14035 uninit_sv == &PL_sv_placeholder)))
14038 switch (obase->op_type) {
14045 const bool pad = ( obase->op_type == OP_PADAV
14046 || obase->op_type == OP_PADHV
14047 || obase->op_type == OP_PADRANGE
14050 const bool hash = ( obase->op_type == OP_PADHV
14051 || obase->op_type == OP_RV2HV
14052 || (obase->op_type == OP_PADRANGE
14053 && SvTYPE(PAD_SVl(obase->op_targ)) == SVt_PVHV)
14057 int subscript_type = FUV_SUBSCRIPT_WITHIN;
14059 if (pad) { /* @lex, %lex */
14060 sv = PAD_SVl(obase->op_targ);
14064 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14065 /* @global, %global */
14066 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14069 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
14071 else if (obase == PL_op) /* @{expr}, %{expr} */
14072 return find_uninit_var(cUNOPx(obase)->op_first,
14074 else /* @{expr}, %{expr} as a sub-expression */
14078 /* attempt to find a match within the aggregate */
14080 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14082 subscript_type = FUV_SUBSCRIPT_HASH;
14085 index = find_array_subscript((const AV *)sv, uninit_sv);
14087 subscript_type = FUV_SUBSCRIPT_ARRAY;
14090 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
14093 return varname(gv, hash ? '%' : '@', obase->op_targ,
14094 keysv, index, subscript_type);
14098 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14100 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14101 if (!gv || !GvSTASH(gv))
14103 if (match && (GvSV(gv) != uninit_sv))
14105 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14108 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14111 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14113 return varname(NULL, '$', obase->op_targ,
14114 NULL, 0, FUV_SUBSCRIPT_NONE);
14117 gv = cGVOPx_gv(obase);
14118 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14120 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14122 case OP_AELEMFAST_LEX:
14125 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14126 if (!av || SvRMAGICAL(av))
14128 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14129 if (!svp || *svp != uninit_sv)
14132 return varname(NULL, '$', obase->op_targ,
14133 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14136 gv = cGVOPx_gv(obase);
14141 AV *const av = GvAV(gv);
14142 if (!av || SvRMAGICAL(av))
14144 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14145 if (!svp || *svp != uninit_sv)
14148 return varname(gv, '$', 0,
14149 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14154 o = cUNOPx(obase)->op_first;
14155 if (!o || o->op_type != OP_NULL ||
14156 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14158 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14163 bool negate = FALSE;
14165 if (PL_op == obase)
14166 /* $a[uninit_expr] or $h{uninit_expr} */
14167 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14170 o = cBINOPx(obase)->op_first;
14171 kid = cBINOPx(obase)->op_last;
14173 /* get the av or hv, and optionally the gv */
14175 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14176 sv = PAD_SV(o->op_targ);
14178 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14179 && cUNOPo->op_first->op_type == OP_GV)
14181 gv = cGVOPx_gv(cUNOPo->op_first);
14185 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14190 if (kid && kid->op_type == OP_NEGATE) {
14192 kid = cUNOPx(kid)->op_first;
14195 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14196 /* index is constant */
14199 kidsv = sv_2mortal(newSVpvs("-"));
14200 sv_catsv(kidsv, cSVOPx_sv(kid));
14203 kidsv = cSVOPx_sv(kid);
14207 if (obase->op_type == OP_HELEM) {
14208 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14209 if (!he || HeVAL(he) != uninit_sv)
14213 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14214 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14216 if (!svp || *svp != uninit_sv)
14220 if (obase->op_type == OP_HELEM)
14221 return varname(gv, '%', o->op_targ,
14222 kidsv, 0, FUV_SUBSCRIPT_HASH);
14224 return varname(gv, '@', o->op_targ, NULL,
14225 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14226 FUV_SUBSCRIPT_ARRAY);
14229 /* index is an expression;
14230 * attempt to find a match within the aggregate */
14231 if (obase->op_type == OP_HELEM) {
14232 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14234 return varname(gv, '%', o->op_targ,
14235 keysv, 0, FUV_SUBSCRIPT_HASH);
14239 = find_array_subscript((const AV *)sv, uninit_sv);
14241 return varname(gv, '@', o->op_targ,
14242 NULL, index, FUV_SUBSCRIPT_ARRAY);
14247 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14249 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14255 /* only examine RHS */
14256 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14259 o = cUNOPx(obase)->op_first;
14260 if ( o->op_type == OP_PUSHMARK
14261 || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
14265 if (!o->op_sibling) {
14266 /* one-arg version of open is highly magical */
14268 if (o->op_type == OP_GV) { /* open FOO; */
14270 if (match && GvSV(gv) != uninit_sv)
14272 return varname(gv, '$', 0,
14273 NULL, 0, FUV_SUBSCRIPT_NONE);
14275 /* other possibilities not handled are:
14276 * open $x; or open my $x; should return '${*$x}'
14277 * open expr; should return '$'.expr ideally
14283 /* ops where $_ may be an implicit arg */
14288 if ( !(obase->op_flags & OPf_STACKED)) {
14289 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14290 ? PAD_SVl(obase->op_targ)
14293 sv = sv_newmortal();
14294 sv_setpvs(sv, "$_");
14303 match = 1; /* print etc can return undef on defined args */
14304 /* skip filehandle as it can't produce 'undef' warning */
14305 o = cUNOPx(obase)->op_first;
14306 if ((obase->op_flags & OPf_STACKED)
14308 ( o->op_type == OP_PUSHMARK
14309 || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)))
14310 o = o->op_sibling->op_sibling;
14314 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14315 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14317 /* the following ops are capable of returning PL_sv_undef even for
14318 * defined arg(s) */
14337 case OP_GETPEERNAME:
14385 case OP_SMARTMATCH:
14394 /* XXX tmp hack: these two may call an XS sub, and currently
14395 XS subs don't have a SUB entry on the context stack, so CV and
14396 pad determination goes wrong, and BAD things happen. So, just
14397 don't try to determine the value under those circumstances.
14398 Need a better fix at dome point. DAPM 11/2007 */
14404 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14405 if (gv && GvSV(gv) == uninit_sv)
14406 return newSVpvs_flags("$.", SVs_TEMP);
14411 /* def-ness of rval pos() is independent of the def-ness of its arg */
14412 if ( !(obase->op_flags & OPf_MOD))
14417 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14418 return newSVpvs_flags("${$/}", SVs_TEMP);
14423 if (!(obase->op_flags & OPf_KIDS))
14425 o = cUNOPx(obase)->op_first;
14431 /* This loop checks all the kid ops, skipping any that cannot pos-
14432 * sibly be responsible for the uninitialized value; i.e., defined
14433 * constants and ops that return nothing. If there is only one op
14434 * left that is not skipped, then we *know* it is responsible for
14435 * the uninitialized value. If there is more than one op left, we
14436 * have to look for an exact match in the while() loop below.
14437 * Note that we skip padrange, because the individual pad ops that
14438 * it replaced are still in the tree, so we work on them instead.
14441 for (kid=o; kid; kid = kid->op_sibling) {
14443 const OPCODE type = kid->op_type;
14444 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14445 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14446 || (type == OP_PUSHMARK)
14447 || (type == OP_PADRANGE)
14451 if (o2) { /* more than one found */
14458 return find_uninit_var(o2, uninit_sv, match);
14460 /* scan all args */
14462 sv = find_uninit_var(o, uninit_sv, 1);
14474 =for apidoc report_uninit
14476 Print appropriate "Use of uninitialized variable" warning.
14482 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14486 SV* varname = NULL;
14487 if (uninit_sv && PL_curpad) {
14488 varname = find_uninit_var(PL_op, uninit_sv,0);
14490 sv_insert(varname, 0, 0, " ", 1);
14492 /* diag_listed_as: Use of uninitialized value%s */
14493 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14494 SVfARG(varname ? varname : &PL_sv_no),
14495 " in ", OP_DESC(PL_op));
14498 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14504 * c-indentation-style: bsd
14505 * c-basic-offset: 4
14506 * indent-tabs-mode: nil
14509 * ex: set ts=8 sts=4 sw=4 et: