3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall
7 * You may distribute under the terms of either the GNU General Public
8 * License or the Artistic License, as specified in the README file.
13 * 'I wonder what the Entish is for "yes" and "no",' he thought.
16 * [p.480 of _The Lord of the Rings_, III/iv: "Treebeard"]
22 * This file contains the code that creates, manipulates and destroys
23 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
24 * structure of an SV, so their creation and destruction is handled
25 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
26 * level functions (eg. substr, split, join) for each of the types are
36 # if __STDC_VERSION__ >= 199901L && !defined(VMS)
47 /* Missing proto on LynxOS */
48 char *gconvert(double, int, int, char *);
51 #ifdef PERL_UTF8_CACHE_ASSERT
52 /* if adding more checks watch out for the following tests:
53 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
54 * lib/utf8.t lib/Unicode/Collate/t/index.t
57 # define ASSERT_UTF8_CACHE(cache) \
58 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
59 assert((cache)[2] <= (cache)[3]); \
60 assert((cache)[3] <= (cache)[1]);} \
63 # define ASSERT_UTF8_CACHE(cache) NOOP
66 #ifdef PERL_OLD_COPY_ON_WRITE
67 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
68 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
69 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
73 /* ============================================================================
75 =head1 Allocation and deallocation of SVs.
77 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
78 sv, av, hv...) contains type and reference count information, and for
79 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
80 contains fields specific to each type. Some types store all they need
81 in the head, so don't have a body.
83 In all but the most memory-paranoid configurations (ex: PURIFY), heads
84 and bodies are allocated out of arenas, which by default are
85 approximately 4K chunks of memory parcelled up into N heads or bodies.
86 Sv-bodies are allocated by their sv-type, guaranteeing size
87 consistency needed to allocate safely from arrays.
89 For SV-heads, the first slot in each arena is reserved, and holds a
90 link to the next arena, some flags, and a note of the number of slots.
91 Snaked through each arena chain is a linked list of free items; when
92 this becomes empty, an extra arena is allocated and divided up into N
93 items which are threaded into the free list.
95 SV-bodies are similar, but they use arena-sets by default, which
96 separate the link and info from the arena itself, and reclaim the 1st
97 slot in the arena. SV-bodies are further described later.
99 The following global variables are associated with arenas:
101 PL_sv_arenaroot pointer to list of SV arenas
102 PL_sv_root pointer to list of free SV structures
104 PL_body_arenas head of linked-list of body arenas
105 PL_body_roots[] array of pointers to list of free bodies of svtype
106 arrays are indexed by the svtype needed
108 A few special SV heads are not allocated from an arena, but are
109 instead directly created in the interpreter structure, eg PL_sv_undef.
110 The size of arenas can be changed from the default by setting
111 PERL_ARENA_SIZE appropriately at compile time.
113 The SV arena serves the secondary purpose of allowing still-live SVs
114 to be located and destroyed during final cleanup.
116 At the lowest level, the macros new_SV() and del_SV() grab and free
117 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
118 to return the SV to the free list with error checking.) new_SV() calls
119 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
120 SVs in the free list have their SvTYPE field set to all ones.
122 At the time of very final cleanup, sv_free_arenas() is called from
123 perl_destruct() to physically free all the arenas allocated since the
124 start of the interpreter.
126 The function visit() scans the SV arenas list, and calls a specified
127 function for each SV it finds which is still live - ie which has an SvTYPE
128 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
129 following functions (specified as [function that calls visit()] / [function
130 called by visit() for each SV]):
132 sv_report_used() / do_report_used()
133 dump all remaining SVs (debugging aid)
135 sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
136 do_clean_named_io_objs()
137 Attempt to free all objects pointed to by RVs,
138 and try to do the same for all objects indirectly
139 referenced by typeglobs too. Called once from
140 perl_destruct(), prior to calling sv_clean_all()
143 sv_clean_all() / do_clean_all()
144 SvREFCNT_dec(sv) each remaining SV, possibly
145 triggering an sv_free(). It also sets the
146 SVf_BREAK flag on the SV to indicate that the
147 refcnt has been artificially lowered, and thus
148 stopping sv_free() from giving spurious warnings
149 about SVs which unexpectedly have a refcnt
150 of zero. called repeatedly from perl_destruct()
151 until there are no SVs left.
153 =head2 Arena allocator API Summary
155 Private API to rest of sv.c
159 new_XPVNV(), del_XPVGV(),
164 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
168 * ========================================================================= */
171 * "A time to plant, and a time to uproot what was planted..."
175 # define MEM_LOG_NEW_SV(sv, file, line, func) \
176 Perl_mem_log_new_sv(sv, file, line, func)
177 # define MEM_LOG_DEL_SV(sv, file, line, func) \
178 Perl_mem_log_del_sv(sv, file, line, func)
180 # define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
181 # define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
184 #ifdef DEBUG_LEAKING_SCALARS
185 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define DEBUG_SV_SERIAL(sv) \
187 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
188 PTR2UV(sv), (long)(sv)->sv_debug_serial))
190 # define FREE_SV_DEBUG_FILE(sv)
191 # define DEBUG_SV_SERIAL(sv) NOOP
195 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
196 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
197 /* Whilst I'd love to do this, it seems that things like to check on
199 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
201 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
202 PoisonNew(&SvREFCNT(sv), 1, U32)
204 # define SvARENA_CHAIN(sv) SvANY(sv)
205 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
206 # define POSION_SV_HEAD(sv)
209 /* Mark an SV head as unused, and add to free list.
211 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
212 * its refcount artificially decremented during global destruction, so
213 * there may be dangling pointers to it. The last thing we want in that
214 * case is for it to be reused. */
216 #define plant_SV(p) \
218 const U32 old_flags = SvFLAGS(p); \
219 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
220 DEBUG_SV_SERIAL(p); \
221 FREE_SV_DEBUG_FILE(p); \
223 SvFLAGS(p) = SVTYPEMASK; \
224 if (!(old_flags & SVf_BREAK)) { \
225 SvARENA_CHAIN_SET(p, PL_sv_root); \
231 #define uproot_SV(p) \
234 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
239 /* make some more SVs by adding another arena */
246 char *chunk; /* must use New here to match call to */
247 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
248 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
253 /* new_SV(): return a new, empty SV head */
255 #ifdef DEBUG_LEAKING_SCALARS
256 /* provide a real function for a debugger to play with */
258 S_new_SV(pTHX_ const char *file, int line, const char *func)
265 sv = S_more_sv(aTHX);
269 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
270 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_parent = NULL;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
280 sv->sv_debug_serial = PL_sv_serial++;
282 MEM_LOG_NEW_SV(sv, file, line, func);
283 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
284 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
288 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
296 (p) = S_more_sv(aTHX); \
300 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
305 /* del_SV(): return an empty SV head to the free list */
318 S_del_sv(pTHX_ SV *p)
322 PERL_ARGS_ASSERT_DEL_SV;
327 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
328 const SV * const sv = sva + 1;
329 const SV * const svend = &sva[SvREFCNT(sva)];
330 if (p >= sv && p < svend) {
336 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
337 "Attempt to free non-arena SV: 0x%"UVxf
338 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
345 #else /* ! DEBUGGING */
347 #define del_SV(p) plant_SV(p)
349 #endif /* DEBUGGING */
353 =head1 SV Manipulation Functions
355 =for apidoc sv_add_arena
357 Given a chunk of memory, link it to the head of the list of arenas,
358 and split it into a list of free SVs.
364 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
367 SV *const sva = MUTABLE_SV(ptr);
371 PERL_ARGS_ASSERT_SV_ADD_ARENA;
373 /* The first SV in an arena isn't an SV. */
374 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
375 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
376 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
378 PL_sv_arenaroot = sva;
379 PL_sv_root = sva + 1;
381 svend = &sva[SvREFCNT(sva) - 1];
384 SvARENA_CHAIN_SET(sv, (sv + 1));
388 /* Must always set typemask because it's always checked in on cleanup
389 when the arenas are walked looking for objects. */
390 SvFLAGS(sv) = SVTYPEMASK;
393 SvARENA_CHAIN_SET(sv, 0);
397 SvFLAGS(sv) = SVTYPEMASK;
400 /* visit(): call the named function for each non-free SV in the arenas
401 * whose flags field matches the flags/mask args. */
404 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
410 PERL_ARGS_ASSERT_VISIT;
412 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
413 register const SV * const svend = &sva[SvREFCNT(sva)];
415 for (sv = sva + 1; sv < svend; ++sv) {
416 if (SvTYPE(sv) != SVTYPEMASK
417 && (sv->sv_flags & mask) == flags
430 /* called by sv_report_used() for each live SV */
433 do_report_used(pTHX_ SV *const sv)
435 if (SvTYPE(sv) != SVTYPEMASK) {
436 PerlIO_printf(Perl_debug_log, "****\n");
443 =for apidoc sv_report_used
445 Dump the contents of all SVs not yet freed. (Debugging aid).
451 Perl_sv_report_used(pTHX)
454 visit(do_report_used, 0, 0);
460 /* called by sv_clean_objs() for each live SV */
463 do_clean_objs(pTHX_ SV *const ref)
468 SV * const target = SvRV(ref);
469 if (SvOBJECT(target)) {
470 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
471 if (SvWEAKREF(ref)) {
472 sv_del_backref(target, ref);
478 SvREFCNT_dec(target);
483 /* XXX Might want to check arrays, etc. */
487 /* clear any slots in a GV which hold objects - except IO;
488 * called by sv_clean_objs() for each live GV */
491 do_clean_named_objs(pTHX_ SV *const sv)
495 assert(SvTYPE(sv) == SVt_PVGV);
496 assert(isGV_with_GP(sv));
500 /* freeing GP entries may indirectly free the current GV;
501 * hold onto it while we mess with the GP slots */
504 if ( ((obj = GvSV(sv) )) && SvOBJECT(obj)) {
505 DEBUG_D((PerlIO_printf(Perl_debug_log,
506 "Cleaning named glob SV object:\n "), sv_dump(obj)));
510 if ( ((obj = MUTABLE_SV(GvAV(sv)) )) && SvOBJECT(obj)) {
511 DEBUG_D((PerlIO_printf(Perl_debug_log,
512 "Cleaning named glob AV object:\n "), sv_dump(obj)));
516 if ( ((obj = MUTABLE_SV(GvHV(sv)) )) && SvOBJECT(obj)) {
517 DEBUG_D((PerlIO_printf(Perl_debug_log,
518 "Cleaning named glob HV object:\n "), sv_dump(obj)));
522 if ( ((obj = MUTABLE_SV(GvCV(sv)) )) && SvOBJECT(obj)) {
523 DEBUG_D((PerlIO_printf(Perl_debug_log,
524 "Cleaning named glob CV object:\n "), sv_dump(obj)));
528 SvREFCNT_dec(sv); /* undo the inc above */
531 /* clear any IO slots in a GV which hold objects (except stderr, defout);
532 * called by sv_clean_objs() for each live GV */
535 do_clean_named_io_objs(pTHX_ SV *const sv)
539 assert(SvTYPE(sv) == SVt_PVGV);
540 assert(isGV_with_GP(sv));
541 if (!GvGP(sv) || sv == (SV*)PL_stderrgv || sv == (SV*)PL_defoutgv)
545 if ( ((obj = MUTABLE_SV(GvIO(sv)) )) && SvOBJECT(obj)) {
546 DEBUG_D((PerlIO_printf(Perl_debug_log,
547 "Cleaning named glob IO object:\n "), sv_dump(obj)));
551 SvREFCNT_dec(sv); /* undo the inc above */
554 /* Void wrapper to pass to visit() */
557 do_curse(pTHX_ SV * const sv) {
558 if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
559 || (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 /* XXX This line breaks Tk and Gtk2. See [perl #82542].
588 visit(do_curse, SVs_OBJECT, SVs_OBJECT);
590 olddef = PL_defoutgv;
591 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
592 if (olddef && isGV_with_GP(olddef))
593 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
594 olderr = PL_stderrgv;
595 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
596 if (olderr && isGV_with_GP(olderr))
597 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
598 SvREFCNT_dec(olddef);
599 PL_in_clean_objs = FALSE;
602 /* called by sv_clean_all() for each live SV */
605 do_clean_all(pTHX_ SV *const sv)
608 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
609 /* don't clean pid table and strtab */
612 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
613 SvFLAGS(sv) |= SVf_BREAK;
618 =for apidoc sv_clean_all
620 Decrement the refcnt of each remaining SV, possibly triggering a
621 cleanup. This function may have to be called multiple times to free
622 SVs which are in complex self-referential hierarchies.
628 Perl_sv_clean_all(pTHX)
632 PL_in_clean_all = TRUE;
633 cleaned = visit(do_clean_all, 0,0);
638 ARENASETS: a meta-arena implementation which separates arena-info
639 into struct arena_set, which contains an array of struct
640 arena_descs, each holding info for a single arena. By separating
641 the meta-info from the arena, we recover the 1st slot, formerly
642 borrowed for list management. The arena_set is about the size of an
643 arena, avoiding the needless malloc overhead of a naive linked-list.
645 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
646 memory in the last arena-set (1/2 on average). In trade, we get
647 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
648 smaller types). The recovery of the wasted space allows use of
649 small arenas for large, rare body types, by changing array* fields
650 in body_details_by_type[] below.
653 char *arena; /* the raw storage, allocated aligned */
654 size_t size; /* its size ~4k typ */
655 svtype utype; /* bodytype stored in arena */
660 /* Get the maximum number of elements in set[] such that struct arena_set
661 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
662 therefore likely to be 1 aligned memory page. */
664 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
665 - 2 * sizeof(int)) / sizeof (struct arena_desc))
668 struct arena_set* next;
669 unsigned int set_size; /* ie ARENAS_PER_SET */
670 unsigned int curr; /* index of next available arena-desc */
671 struct arena_desc set[ARENAS_PER_SET];
675 =for apidoc sv_free_arenas
677 Deallocate the memory used by all arenas. Note that all the individual SV
678 heads and bodies within the arenas must already have been freed.
683 Perl_sv_free_arenas(pTHX)
690 /* Free arenas here, but be careful about fake ones. (We assume
691 contiguity of the fake ones with the corresponding real ones.) */
693 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
694 svanext = MUTABLE_SV(SvANY(sva));
695 while (svanext && SvFAKE(svanext))
696 svanext = MUTABLE_SV(SvANY(svanext));
703 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
706 struct arena_set *current = aroot;
709 assert(aroot->set[i].arena);
710 Safefree(aroot->set[i].arena);
718 i = PERL_ARENA_ROOTS_SIZE;
720 PL_body_roots[i] = 0;
727 Here are mid-level routines that manage the allocation of bodies out
728 of the various arenas. There are 5 kinds of arenas:
730 1. SV-head arenas, which are discussed and handled above
731 2. regular body arenas
732 3. arenas for reduced-size bodies
735 Arena types 2 & 3 are chained by body-type off an array of
736 arena-root pointers, which is indexed by svtype. Some of the
737 larger/less used body types are malloced singly, since a large
738 unused block of them is wasteful. Also, several svtypes dont have
739 bodies; the data fits into the sv-head itself. The arena-root
740 pointer thus has a few unused root-pointers (which may be hijacked
741 later for arena types 4,5)
743 3 differs from 2 as an optimization; some body types have several
744 unused fields in the front of the structure (which are kept in-place
745 for consistency). These bodies can be allocated in smaller chunks,
746 because the leading fields arent accessed. Pointers to such bodies
747 are decremented to point at the unused 'ghost' memory, knowing that
748 the pointers are used with offsets to the real memory.
751 =head1 SV-Body Allocation
753 Allocation of SV-bodies is similar to SV-heads, differing as follows;
754 the allocation mechanism is used for many body types, so is somewhat
755 more complicated, it uses arena-sets, and has no need for still-live
758 At the outermost level, (new|del)_X*V macros return bodies of the
759 appropriate type. These macros call either (new|del)_body_type or
760 (new|del)_body_allocated macro pairs, depending on specifics of the
761 type. Most body types use the former pair, the latter pair is used to
762 allocate body types with "ghost fields".
764 "ghost fields" are fields that are unused in certain types, and
765 consequently don't need to actually exist. They are declared because
766 they're part of a "base type", which allows use of functions as
767 methods. The simplest examples are AVs and HVs, 2 aggregate types
768 which don't use the fields which support SCALAR semantics.
770 For these types, the arenas are carved up into appropriately sized
771 chunks, we thus avoid wasted memory for those unaccessed members.
772 When bodies are allocated, we adjust the pointer back in memory by the
773 size of the part not allocated, so it's as if we allocated the full
774 structure. (But things will all go boom if you write to the part that
775 is "not there", because you'll be overwriting the last members of the
776 preceding structure in memory.)
778 We calculate the correction using the STRUCT_OFFSET macro on the first
779 member present. If the allocated structure is smaller (no initial NV
780 actually allocated) then the net effect is to subtract the size of the NV
781 from the pointer, to return a new pointer as if an initial NV were actually
782 allocated. (We were using structures named *_allocated for this, but
783 this turned out to be a subtle bug, because a structure without an NV
784 could have a lower alignment constraint, but the compiler is allowed to
785 optimised accesses based on the alignment constraint of the actual pointer
786 to the full structure, for example, using a single 64 bit load instruction
787 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
789 This is the same trick as was used for NV and IV bodies. Ironically it
790 doesn't need to be used for NV bodies any more, because NV is now at
791 the start of the structure. IV bodies don't need it either, because
792 they are no longer allocated.
794 In turn, the new_body_* allocators call S_new_body(), which invokes
795 new_body_inline macro, which takes a lock, and takes a body off the
796 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
797 necessary to refresh an empty list. Then the lock is released, and
798 the body is returned.
800 Perl_more_bodies allocates a new arena, and carves it up into an array of N
801 bodies, which it strings into a linked list. It looks up arena-size
802 and body-size from the body_details table described below, thus
803 supporting the multiple body-types.
805 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
806 the (new|del)_X*V macros are mapped directly to malloc/free.
808 For each sv-type, struct body_details bodies_by_type[] carries
809 parameters which control these aspects of SV handling:
811 Arena_size determines whether arenas are used for this body type, and if
812 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
813 zero, forcing individual mallocs and frees.
815 Body_size determines how big a body is, and therefore how many fit into
816 each arena. Offset carries the body-pointer adjustment needed for
817 "ghost fields", and is used in *_allocated macros.
819 But its main purpose is to parameterize info needed in
820 Perl_sv_upgrade(). The info here dramatically simplifies the function
821 vs the implementation in 5.8.8, making it table-driven. All fields
822 are used for this, except for arena_size.
824 For the sv-types that have no bodies, arenas are not used, so those
825 PL_body_roots[sv_type] are unused, and can be overloaded. In
826 something of a special case, SVt_NULL is borrowed for HE arenas;
827 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
828 bodies_by_type[SVt_NULL] slot is not used, as the table is not
833 struct body_details {
834 U8 body_size; /* Size to allocate */
835 U8 copy; /* Size of structure to copy (may be shorter) */
837 unsigned int type : 4; /* We have space for a sanity check. */
838 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
839 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
840 unsigned int arena : 1; /* Allocated from an arena */
841 size_t arena_size; /* Size of arena to allocate */
849 /* With -DPURFIY we allocate everything directly, and don't use arenas.
850 This seems a rather elegant way to simplify some of the code below. */
851 #define HASARENA FALSE
853 #define HASARENA TRUE
855 #define NOARENA FALSE
857 /* Size the arenas to exactly fit a given number of bodies. A count
858 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
859 simplifying the default. If count > 0, the arena is sized to fit
860 only that many bodies, allowing arenas to be used for large, rare
861 bodies (XPVFM, XPVIO) without undue waste. The arena size is
862 limited by PERL_ARENA_SIZE, so we can safely oversize the
865 #define FIT_ARENA0(body_size) \
866 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
867 #define FIT_ARENAn(count,body_size) \
868 ( count * body_size <= PERL_ARENA_SIZE) \
869 ? count * body_size \
870 : FIT_ARENA0 (body_size)
871 #define FIT_ARENA(count,body_size) \
873 ? FIT_ARENAn (count, body_size) \
874 : FIT_ARENA0 (body_size)
876 /* Calculate the length to copy. Specifically work out the length less any
877 final padding the compiler needed to add. See the comment in sv_upgrade
878 for why copying the padding proved to be a bug. */
880 #define copy_length(type, last_member) \
881 STRUCT_OFFSET(type, last_member) \
882 + sizeof (((type*)SvANY((const SV *)0))->last_member)
884 static const struct body_details bodies_by_type[] = {
885 /* HEs use this offset for their arena. */
886 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
888 /* The bind placeholder pretends to be an RV for now.
889 Also it's marked as "can't upgrade" to stop anyone using it before it's
891 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
893 /* IVs are in the head, so the allocation size is 0. */
895 sizeof(IV), /* This is used to copy out the IV body. */
896 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
897 NOARENA /* IVS don't need an arena */, 0
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV),
902 STRUCT_OFFSET(XPVNV, xnv_u),
903 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
905 /* 8 bytes on most ILP32 with IEEE doubles */
906 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
907 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
908 + STRUCT_OFFSET(XPV, xpv_cur),
909 SVt_PV, FALSE, NONV, HASARENA,
910 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
913 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
914 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
915 + STRUCT_OFFSET(XPV, xpv_cur),
916 SVt_PVIV, FALSE, NONV, HASARENA,
917 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
920 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
921 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
922 + STRUCT_OFFSET(XPV, xpv_cur),
923 SVt_PVNV, FALSE, HADNV, HASARENA,
924 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
927 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
934 SVt_REGEXP, FALSE, NONV, HASARENA,
935 FIT_ARENA(0, sizeof(regexp))
939 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
940 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
943 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
944 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
947 copy_length(XPVAV, xav_alloc),
949 SVt_PVAV, TRUE, NONV, HASARENA,
950 FIT_ARENA(0, sizeof(XPVAV)) },
953 copy_length(XPVHV, xhv_max),
955 SVt_PVHV, TRUE, NONV, HASARENA,
956 FIT_ARENA(0, sizeof(XPVHV)) },
962 SVt_PVCV, TRUE, NONV, HASARENA,
963 FIT_ARENA(0, sizeof(XPVCV)) },
968 SVt_PVFM, TRUE, NONV, NOARENA,
969 FIT_ARENA(20, sizeof(XPVFM)) },
971 /* XPVIO is 84 bytes, fits 48x */
975 SVt_PVIO, TRUE, NONV, HASARENA,
976 FIT_ARENA(24, sizeof(XPVIO)) },
979 #define new_body_allocated(sv_type) \
980 (void *)((char *)S_new_body(aTHX_ sv_type) \
981 - bodies_by_type[sv_type].offset)
983 /* return a thing to the free list */
985 #define del_body(thing, root) \
987 void ** const thing_copy = (void **)thing; \
988 *thing_copy = *root; \
989 *root = (void*)thing_copy; \
994 #define new_XNV() safemalloc(sizeof(XPVNV))
995 #define new_XPVNV() safemalloc(sizeof(XPVNV))
996 #define new_XPVMG() safemalloc(sizeof(XPVMG))
998 #define del_XPVGV(p) safefree(p)
1002 #define new_XNV() new_body_allocated(SVt_NV)
1003 #define new_XPVNV() new_body_allocated(SVt_PVNV)
1004 #define new_XPVMG() new_body_allocated(SVt_PVMG)
1006 #define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
1007 &PL_body_roots[SVt_PVGV])
1011 /* no arena for you! */
1013 #define new_NOARENA(details) \
1014 safemalloc((details)->body_size + (details)->offset)
1015 #define new_NOARENAZ(details) \
1016 safecalloc((details)->body_size + (details)->offset, 1)
1019 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1020 const size_t arena_size)
1023 void ** const root = &PL_body_roots[sv_type];
1024 struct arena_desc *adesc;
1025 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1029 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1030 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1031 static bool done_sanity_check;
1033 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1034 * variables like done_sanity_check. */
1035 if (!done_sanity_check) {
1036 unsigned int i = SVt_LAST;
1038 done_sanity_check = TRUE;
1041 assert (bodies_by_type[i].type == i);
1047 /* may need new arena-set to hold new arena */
1048 if (!aroot || aroot->curr >= aroot->set_size) {
1049 struct arena_set *newroot;
1050 Newxz(newroot, 1, struct arena_set);
1051 newroot->set_size = ARENAS_PER_SET;
1052 newroot->next = aroot;
1054 PL_body_arenas = (void *) newroot;
1055 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1058 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1059 curr = aroot->curr++;
1060 adesc = &(aroot->set[curr]);
1061 assert(!adesc->arena);
1063 Newx(adesc->arena, good_arena_size, char);
1064 adesc->size = good_arena_size;
1065 adesc->utype = sv_type;
1066 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1067 curr, (void*)adesc->arena, (UV)good_arena_size));
1069 start = (char *) adesc->arena;
1071 /* Get the address of the byte after the end of the last body we can fit.
1072 Remember, this is integer division: */
1073 end = start + good_arena_size / body_size * body_size;
1075 /* computed count doesn't reflect the 1st slot reservation */
1076 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1077 DEBUG_m(PerlIO_printf(Perl_debug_log,
1078 "arena %p end %p arena-size %d (from %d) type %d "
1080 (void*)start, (void*)end, (int)good_arena_size,
1081 (int)arena_size, sv_type, (int)body_size,
1082 (int)good_arena_size / (int)body_size));
1084 DEBUG_m(PerlIO_printf(Perl_debug_log,
1085 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1086 (void*)start, (void*)end,
1087 (int)arena_size, sv_type, (int)body_size,
1088 (int)good_arena_size / (int)body_size));
1090 *root = (void *)start;
1093 /* Where the next body would start: */
1094 char * const next = start + body_size;
1097 /* This is the last body: */
1098 assert(next == end);
1100 *(void **)start = 0;
1104 *(void**) start = (void *)next;
1109 /* grab a new thing from the free list, allocating more if necessary.
1110 The inline version is used for speed in hot routines, and the
1111 function using it serves the rest (unless PURIFY).
1113 #define new_body_inline(xpv, sv_type) \
1115 void ** const r3wt = &PL_body_roots[sv_type]; \
1116 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1117 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1118 bodies_by_type[sv_type].body_size,\
1119 bodies_by_type[sv_type].arena_size)); \
1120 *(r3wt) = *(void**)(xpv); \
1126 S_new_body(pTHX_ const svtype sv_type)
1130 new_body_inline(xpv, sv_type);
1136 static const struct body_details fake_rv =
1137 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1140 =for apidoc sv_upgrade
1142 Upgrade an SV to a more complex form. Generally adds a new body type to the
1143 SV, then copies across as much information as possible from the old body.
1144 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1150 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1155 const svtype old_type = SvTYPE(sv);
1156 const struct body_details *new_type_details;
1157 const struct body_details *old_type_details
1158 = bodies_by_type + old_type;
1159 SV *referant = NULL;
1161 PERL_ARGS_ASSERT_SV_UPGRADE;
1163 if (old_type == new_type)
1166 /* This clause was purposefully added ahead of the early return above to
1167 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1168 inference by Nick I-S that it would fix other troublesome cases. See
1169 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1171 Given that shared hash key scalars are no longer PVIV, but PV, there is
1172 no longer need to unshare so as to free up the IVX slot for its proper
1173 purpose. So it's safe to move the early return earlier. */
1175 if (new_type != SVt_PV && SvIsCOW(sv)) {
1176 sv_force_normal_flags(sv, 0);
1179 old_body = SvANY(sv);
1181 /* Copying structures onto other structures that have been neatly zeroed
1182 has a subtle gotcha. Consider XPVMG
1184 +------+------+------+------+------+-------+-------+
1185 | NV | CUR | LEN | IV | MAGIC | STASH |
1186 +------+------+------+------+------+-------+-------+
1187 0 4 8 12 16 20 24 28
1189 where NVs are aligned to 8 bytes, so that sizeof that structure is
1190 actually 32 bytes long, with 4 bytes of padding at the end:
1192 +------+------+------+------+------+-------+-------+------+
1193 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1194 +------+------+------+------+------+-------+-------+------+
1195 0 4 8 12 16 20 24 28 32
1197 so what happens if you allocate memory for this structure:
1199 +------+------+------+------+------+-------+-------+------+------+...
1200 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1201 +------+------+------+------+------+-------+-------+------+------+...
1202 0 4 8 12 16 20 24 28 32 36
1204 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1205 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1206 started out as zero once, but it's quite possible that it isn't. So now,
1207 rather than a nicely zeroed GP, you have it pointing somewhere random.
1210 (In fact, GP ends up pointing at a previous GP structure, because the
1211 principle cause of the padding in XPVMG getting garbage is a copy of
1212 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1213 this happens to be moot because XPVGV has been re-ordered, with GP
1214 no longer after STASH)
1216 So we are careful and work out the size of used parts of all the
1224 referant = SvRV(sv);
1225 old_type_details = &fake_rv;
1226 if (new_type == SVt_NV)
1227 new_type = SVt_PVNV;
1229 if (new_type < SVt_PVIV) {
1230 new_type = (new_type == SVt_NV)
1231 ? SVt_PVNV : SVt_PVIV;
1236 if (new_type < SVt_PVNV) {
1237 new_type = SVt_PVNV;
1241 assert(new_type > SVt_PV);
1242 assert(SVt_IV < SVt_PV);
1243 assert(SVt_NV < SVt_PV);
1250 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1251 there's no way that it can be safely upgraded, because perl.c
1252 expects to Safefree(SvANY(PL_mess_sv)) */
1253 assert(sv != PL_mess_sv);
1254 /* This flag bit is used to mean other things in other scalar types.
1255 Given that it only has meaning inside the pad, it shouldn't be set
1256 on anything that can get upgraded. */
1257 assert(!SvPAD_TYPED(sv));
1260 if (old_type_details->cant_upgrade)
1261 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1262 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1265 if (old_type > new_type)
1266 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1267 (int)old_type, (int)new_type);
1269 new_type_details = bodies_by_type + new_type;
1271 SvFLAGS(sv) &= ~SVTYPEMASK;
1272 SvFLAGS(sv) |= new_type;
1274 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1275 the return statements above will have triggered. */
1276 assert (new_type != SVt_NULL);
1279 assert(old_type == SVt_NULL);
1280 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1284 assert(old_type == SVt_NULL);
1285 SvANY(sv) = new_XNV();
1290 assert(new_type_details->body_size);
1293 assert(new_type_details->arena);
1294 assert(new_type_details->arena_size);
1295 /* This points to the start of the allocated area. */
1296 new_body_inline(new_body, new_type);
1297 Zero(new_body, new_type_details->body_size, char);
1298 new_body = ((char *)new_body) - new_type_details->offset;
1300 /* We always allocated the full length item with PURIFY. To do this
1301 we fake things so that arena is false for all 16 types.. */
1302 new_body = new_NOARENAZ(new_type_details);
1304 SvANY(sv) = new_body;
1305 if (new_type == SVt_PVAV) {
1309 if (old_type_details->body_size) {
1312 /* It will have been zeroed when the new body was allocated.
1313 Lets not write to it, in case it confuses a write-back
1319 #ifndef NODEFAULT_SHAREKEYS
1320 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1322 HvMAX(sv) = 7; /* (start with 8 buckets) */
1325 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1326 The target created by newSVrv also is, and it can have magic.
1327 However, it never has SvPVX set.
1329 if (old_type == SVt_IV) {
1331 } else if (old_type >= SVt_PV) {
1332 assert(SvPVX_const(sv) == 0);
1335 if (old_type >= SVt_PVMG) {
1336 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1337 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1339 sv->sv_u.svu_array = NULL; /* or svu_hash */
1345 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1346 sv_force_normal_flags(sv) is called. */
1349 /* XXX Is this still needed? Was it ever needed? Surely as there is
1350 no route from NV to PVIV, NOK can never be true */
1351 assert(!SvNOKp(sv));
1362 assert(new_type_details->body_size);
1363 /* We always allocated the full length item with PURIFY. To do this
1364 we fake things so that arena is false for all 16 types.. */
1365 if(new_type_details->arena) {
1366 /* This points to the start of the allocated area. */
1367 new_body_inline(new_body, new_type);
1368 Zero(new_body, new_type_details->body_size, char);
1369 new_body = ((char *)new_body) - new_type_details->offset;
1371 new_body = new_NOARENAZ(new_type_details);
1373 SvANY(sv) = new_body;
1375 if (old_type_details->copy) {
1376 /* There is now the potential for an upgrade from something without
1377 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1378 int offset = old_type_details->offset;
1379 int length = old_type_details->copy;
1381 if (new_type_details->offset > old_type_details->offset) {
1382 const int difference
1383 = new_type_details->offset - old_type_details->offset;
1384 offset += difference;
1385 length -= difference;
1387 assert (length >= 0);
1389 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1393 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1394 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1395 * correct 0.0 for us. Otherwise, if the old body didn't have an
1396 * NV slot, but the new one does, then we need to initialise the
1397 * freshly created NV slot with whatever the correct bit pattern is
1399 if (old_type_details->zero_nv && !new_type_details->zero_nv
1400 && !isGV_with_GP(sv))
1404 if (new_type == SVt_PVIO) {
1405 IO * const io = MUTABLE_IO(sv);
1406 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1409 /* Clear the stashcache because a new IO could overrule a package
1411 hv_clear(PL_stashcache);
1413 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1414 IoPAGE_LEN(sv) = 60;
1416 if (old_type < SVt_PV) {
1417 /* referant will be NULL unless the old type was SVt_IV emulating
1419 sv->sv_u.svu_rv = referant;
1423 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1424 (unsigned long)new_type);
1427 if (old_type > SVt_IV) {
1431 /* Note that there is an assumption that all bodies of types that
1432 can be upgraded came from arenas. Only the more complex non-
1433 upgradable types are allowed to be directly malloc()ed. */
1434 assert(old_type_details->arena);
1435 del_body((void*)((char*)old_body + old_type_details->offset),
1436 &PL_body_roots[old_type]);
1442 =for apidoc sv_backoff
1444 Remove any string offset. You should normally use the C<SvOOK_off> macro
1451 Perl_sv_backoff(pTHX_ register SV *const sv)
1454 const char * const s = SvPVX_const(sv);
1456 PERL_ARGS_ASSERT_SV_BACKOFF;
1457 PERL_UNUSED_CONTEXT;
1460 assert(SvTYPE(sv) != SVt_PVHV);
1461 assert(SvTYPE(sv) != SVt_PVAV);
1463 SvOOK_offset(sv, delta);
1465 SvLEN_set(sv, SvLEN(sv) + delta);
1466 SvPV_set(sv, SvPVX(sv) - delta);
1467 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1468 SvFLAGS(sv) &= ~SVf_OOK;
1475 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1476 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1477 Use the C<SvGROW> wrapper instead.
1483 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1487 PERL_ARGS_ASSERT_SV_GROW;
1489 if (PL_madskills && newlen >= 0x100000) {
1490 PerlIO_printf(Perl_debug_log,
1491 "Allocation too large: %"UVxf"\n", (UV)newlen);
1493 #ifdef HAS_64K_LIMIT
1494 if (newlen >= 0x10000) {
1495 PerlIO_printf(Perl_debug_log,
1496 "Allocation too large: %"UVxf"\n", (UV)newlen);
1499 #endif /* HAS_64K_LIMIT */
1502 if (SvTYPE(sv) < SVt_PV) {
1503 sv_upgrade(sv, SVt_PV);
1504 s = SvPVX_mutable(sv);
1506 else if (SvOOK(sv)) { /* pv is offset? */
1508 s = SvPVX_mutable(sv);
1509 if (newlen > SvLEN(sv))
1510 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1511 #ifdef HAS_64K_LIMIT
1512 if (newlen >= 0x10000)
1517 s = SvPVX_mutable(sv);
1519 if (newlen > SvLEN(sv)) { /* need more room? */
1520 STRLEN minlen = SvCUR(sv);
1521 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1522 if (newlen < minlen)
1524 #ifndef Perl_safesysmalloc_size
1525 newlen = PERL_STRLEN_ROUNDUP(newlen);
1527 if (SvLEN(sv) && s) {
1528 s = (char*)saferealloc(s, newlen);
1531 s = (char*)safemalloc(newlen);
1532 if (SvPVX_const(sv) && SvCUR(sv)) {
1533 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1537 #ifdef Perl_safesysmalloc_size
1538 /* Do this here, do it once, do it right, and then we will never get
1539 called back into sv_grow() unless there really is some growing
1541 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1543 SvLEN_set(sv, newlen);
1550 =for apidoc sv_setiv
1552 Copies an integer into the given SV, upgrading first if necessary.
1553 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1559 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1563 PERL_ARGS_ASSERT_SV_SETIV;
1565 SV_CHECK_THINKFIRST_COW_DROP(sv);
1566 switch (SvTYPE(sv)) {
1569 sv_upgrade(sv, SVt_IV);
1572 sv_upgrade(sv, SVt_PVIV);
1576 if (!isGV_with_GP(sv))
1583 /* diag_listed_as: Can't coerce %s to %s in %s */
1584 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1588 (void)SvIOK_only(sv); /* validate number */
1594 =for apidoc sv_setiv_mg
1596 Like C<sv_setiv>, but also handles 'set' magic.
1602 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1604 PERL_ARGS_ASSERT_SV_SETIV_MG;
1611 =for apidoc sv_setuv
1613 Copies an unsigned integer into the given SV, upgrading first if necessary.
1614 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1620 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1622 PERL_ARGS_ASSERT_SV_SETUV;
1624 /* With these two if statements:
1625 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1628 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1630 If you wish to remove them, please benchmark to see what the effect is
1632 if (u <= (UV)IV_MAX) {
1633 sv_setiv(sv, (IV)u);
1642 =for apidoc sv_setuv_mg
1644 Like C<sv_setuv>, but also handles 'set' magic.
1650 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1652 PERL_ARGS_ASSERT_SV_SETUV_MG;
1659 =for apidoc sv_setnv
1661 Copies a double into the given SV, upgrading first if necessary.
1662 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1668 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1672 PERL_ARGS_ASSERT_SV_SETNV;
1674 SV_CHECK_THINKFIRST_COW_DROP(sv);
1675 switch (SvTYPE(sv)) {
1678 sv_upgrade(sv, SVt_NV);
1682 sv_upgrade(sv, SVt_PVNV);
1686 if (!isGV_with_GP(sv))
1693 /* diag_listed_as: Can't coerce %s to %s in %s */
1694 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1699 (void)SvNOK_only(sv); /* validate number */
1704 =for apidoc sv_setnv_mg
1706 Like C<sv_setnv>, but also handles 'set' magic.
1712 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1714 PERL_ARGS_ASSERT_SV_SETNV_MG;
1720 /* Print an "isn't numeric" warning, using a cleaned-up,
1721 * printable version of the offending string
1725 S_not_a_number(pTHX_ SV *const sv)
1732 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1735 dsv = newSVpvs_flags("", SVs_TEMP);
1736 pv = sv_uni_display(dsv, sv, 10, 0);
1739 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1740 /* each *s can expand to 4 chars + "...\0",
1741 i.e. need room for 8 chars */
1743 const char *s = SvPVX_const(sv);
1744 const char * const end = s + SvCUR(sv);
1745 for ( ; s < end && d < limit; s++ ) {
1747 if (ch & 128 && !isPRINT_LC(ch)) {
1756 else if (ch == '\r') {
1760 else if (ch == '\f') {
1764 else if (ch == '\\') {
1768 else if (ch == '\0') {
1772 else if (isPRINT_LC(ch))
1789 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1790 "Argument \"%s\" isn't numeric in %s", pv,
1793 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1794 "Argument \"%s\" isn't numeric", pv);
1798 =for apidoc looks_like_number
1800 Test if the content of an SV looks like a number (or is a number).
1801 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1802 non-numeric warning), even if your atof() doesn't grok them.
1808 Perl_looks_like_number(pTHX_ SV *const sv)
1810 register const char *sbegin;
1813 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1816 sbegin = SvPVX_const(sv);
1819 else if (SvPOKp(sv))
1820 sbegin = SvPV_const(sv, len);
1822 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1823 return grok_number(sbegin, len, NULL);
1827 S_glob_2number(pTHX_ GV * const gv)
1829 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1830 SV *const buffer = sv_newmortal();
1832 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1834 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1837 gv_efullname3(buffer, gv, "*");
1838 SvFLAGS(gv) |= wasfake;
1840 /* We know that all GVs stringify to something that is not-a-number,
1841 so no need to test that. */
1842 if (ckWARN(WARN_NUMERIC))
1843 not_a_number(buffer);
1844 /* We just want something true to return, so that S_sv_2iuv_common
1845 can tail call us and return true. */
1849 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1850 until proven guilty, assume that things are not that bad... */
1855 As 64 bit platforms often have an NV that doesn't preserve all bits of
1856 an IV (an assumption perl has been based on to date) it becomes necessary
1857 to remove the assumption that the NV always carries enough precision to
1858 recreate the IV whenever needed, and that the NV is the canonical form.
1859 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1860 precision as a side effect of conversion (which would lead to insanity
1861 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1862 1) to distinguish between IV/UV/NV slots that have cached a valid
1863 conversion where precision was lost and IV/UV/NV slots that have a
1864 valid conversion which has lost no precision
1865 2) to ensure that if a numeric conversion to one form is requested that
1866 would lose precision, the precise conversion (or differently
1867 imprecise conversion) is also performed and cached, to prevent
1868 requests for different numeric formats on the same SV causing
1869 lossy conversion chains. (lossless conversion chains are perfectly
1874 SvIOKp is true if the IV slot contains a valid value
1875 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1876 SvNOKp is true if the NV slot contains a valid value
1877 SvNOK is true only if the NV value is accurate
1880 while converting from PV to NV, check to see if converting that NV to an
1881 IV(or UV) would lose accuracy over a direct conversion from PV to
1882 IV(or UV). If it would, cache both conversions, return NV, but mark
1883 SV as IOK NOKp (ie not NOK).
1885 While converting from PV to IV, check to see if converting that IV to an
1886 NV would lose accuracy over a direct conversion from PV to NV. If it
1887 would, cache both conversions, flag similarly.
1889 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1890 correctly because if IV & NV were set NV *always* overruled.
1891 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1892 changes - now IV and NV together means that the two are interchangeable:
1893 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1895 The benefit of this is that operations such as pp_add know that if
1896 SvIOK is true for both left and right operands, then integer addition
1897 can be used instead of floating point (for cases where the result won't
1898 overflow). Before, floating point was always used, which could lead to
1899 loss of precision compared with integer addition.
1901 * making IV and NV equal status should make maths accurate on 64 bit
1903 * may speed up maths somewhat if pp_add and friends start to use
1904 integers when possible instead of fp. (Hopefully the overhead in
1905 looking for SvIOK and checking for overflow will not outweigh the
1906 fp to integer speedup)
1907 * will slow down integer operations (callers of SvIV) on "inaccurate"
1908 values, as the change from SvIOK to SvIOKp will cause a call into
1909 sv_2iv each time rather than a macro access direct to the IV slot
1910 * should speed up number->string conversion on integers as IV is
1911 favoured when IV and NV are equally accurate
1913 ####################################################################
1914 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1915 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1916 On the other hand, SvUOK is true iff UV.
1917 ####################################################################
1919 Your mileage will vary depending your CPU's relative fp to integer
1923 #ifndef NV_PRESERVES_UV
1924 # define IS_NUMBER_UNDERFLOW_IV 1
1925 # define IS_NUMBER_UNDERFLOW_UV 2
1926 # define IS_NUMBER_IV_AND_UV 2
1927 # define IS_NUMBER_OVERFLOW_IV 4
1928 # define IS_NUMBER_OVERFLOW_UV 5
1930 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1932 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1934 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1942 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1944 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));
1945 if (SvNVX(sv) < (NV)IV_MIN) {
1946 (void)SvIOKp_on(sv);
1948 SvIV_set(sv, IV_MIN);
1949 return IS_NUMBER_UNDERFLOW_IV;
1951 if (SvNVX(sv) > (NV)UV_MAX) {
1952 (void)SvIOKp_on(sv);
1955 SvUV_set(sv, UV_MAX);
1956 return IS_NUMBER_OVERFLOW_UV;
1958 (void)SvIOKp_on(sv);
1960 /* Can't use strtol etc to convert this string. (See truth table in
1962 if (SvNVX(sv) <= (UV)IV_MAX) {
1963 SvIV_set(sv, I_V(SvNVX(sv)));
1964 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1965 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1967 /* Integer is imprecise. NOK, IOKp */
1969 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1972 SvUV_set(sv, U_V(SvNVX(sv)));
1973 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1974 if (SvUVX(sv) == UV_MAX) {
1975 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1976 possibly be preserved by NV. Hence, it must be overflow.
1978 return IS_NUMBER_OVERFLOW_UV;
1980 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1982 /* Integer is imprecise. NOK, IOKp */
1984 return IS_NUMBER_OVERFLOW_IV;
1986 #endif /* !NV_PRESERVES_UV*/
1989 S_sv_2iuv_common(pTHX_ SV *const sv)
1993 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1996 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1997 * without also getting a cached IV/UV from it at the same time
1998 * (ie PV->NV conversion should detect loss of accuracy and cache
1999 * IV or UV at same time to avoid this. */
2000 /* IV-over-UV optimisation - choose to cache IV if possible */
2002 if (SvTYPE(sv) == SVt_NV)
2003 sv_upgrade(sv, SVt_PVNV);
2005 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2006 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2007 certainly cast into the IV range at IV_MAX, whereas the correct
2008 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2010 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2011 if (Perl_isnan(SvNVX(sv))) {
2017 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2018 SvIV_set(sv, I_V(SvNVX(sv)));
2019 if (SvNVX(sv) == (NV) SvIVX(sv)
2020 #ifndef NV_PRESERVES_UV
2021 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2022 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2023 /* Don't flag it as "accurately an integer" if the number
2024 came from a (by definition imprecise) NV operation, and
2025 we're outside the range of NV integer precision */
2029 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2031 /* scalar has trailing garbage, eg "42a" */
2033 DEBUG_c(PerlIO_printf(Perl_debug_log,
2034 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2040 /* IV not precise. No need to convert from PV, as NV
2041 conversion would already have cached IV if it detected
2042 that PV->IV would be better than PV->NV->IV
2043 flags already correct - don't set public IOK. */
2044 DEBUG_c(PerlIO_printf(Perl_debug_log,
2045 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2050 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2051 but the cast (NV)IV_MIN rounds to a the value less (more
2052 negative) than IV_MIN which happens to be equal to SvNVX ??
2053 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2054 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2055 (NV)UVX == NVX are both true, but the values differ. :-(
2056 Hopefully for 2s complement IV_MIN is something like
2057 0x8000000000000000 which will be exact. NWC */
2060 SvUV_set(sv, U_V(SvNVX(sv)));
2062 (SvNVX(sv) == (NV) SvUVX(sv))
2063 #ifndef NV_PRESERVES_UV
2064 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2065 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2066 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2067 /* Don't flag it as "accurately an integer" if the number
2068 came from a (by definition imprecise) NV operation, and
2069 we're outside the range of NV integer precision */
2075 DEBUG_c(PerlIO_printf(Perl_debug_log,
2076 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2082 else if (SvPOKp(sv) && SvLEN(sv)) {
2084 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2085 /* We want to avoid a possible problem when we cache an IV/ a UV which
2086 may be later translated to an NV, and the resulting NV is not
2087 the same as the direct translation of the initial string
2088 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2089 be careful to ensure that the value with the .456 is around if the
2090 NV value is requested in the future).
2092 This means that if we cache such an IV/a UV, we need to cache the
2093 NV as well. Moreover, we trade speed for space, and do not
2094 cache the NV if we are sure it's not needed.
2097 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2098 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2099 == IS_NUMBER_IN_UV) {
2100 /* It's definitely an integer, only upgrade to PVIV */
2101 if (SvTYPE(sv) < SVt_PVIV)
2102 sv_upgrade(sv, SVt_PVIV);
2104 } else if (SvTYPE(sv) < SVt_PVNV)
2105 sv_upgrade(sv, SVt_PVNV);
2107 /* If NVs preserve UVs then we only use the UV value if we know that
2108 we aren't going to call atof() below. If NVs don't preserve UVs
2109 then the value returned may have more precision than atof() will
2110 return, even though value isn't perfectly accurate. */
2111 if ((numtype & (IS_NUMBER_IN_UV
2112 #ifdef NV_PRESERVES_UV
2115 )) == IS_NUMBER_IN_UV) {
2116 /* This won't turn off the public IOK flag if it was set above */
2117 (void)SvIOKp_on(sv);
2119 if (!(numtype & IS_NUMBER_NEG)) {
2121 if (value <= (UV)IV_MAX) {
2122 SvIV_set(sv, (IV)value);
2124 /* it didn't overflow, and it was positive. */
2125 SvUV_set(sv, value);
2129 /* 2s complement assumption */
2130 if (value <= (UV)IV_MIN) {
2131 SvIV_set(sv, -(IV)value);
2133 /* Too negative for an IV. This is a double upgrade, but
2134 I'm assuming it will be rare. */
2135 if (SvTYPE(sv) < SVt_PVNV)
2136 sv_upgrade(sv, SVt_PVNV);
2140 SvNV_set(sv, -(NV)value);
2141 SvIV_set(sv, IV_MIN);
2145 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2146 will be in the previous block to set the IV slot, and the next
2147 block to set the NV slot. So no else here. */
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 != IS_NUMBER_IN_UV) {
2151 /* It wasn't an (integer that doesn't overflow the UV). */
2152 SvNV_set(sv, Atof(SvPVX_const(sv)));
2154 if (! numtype && ckWARN(WARN_NUMERIC))
2157 #if defined(USE_LONG_DOUBLE)
2158 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2159 PTR2UV(sv), SvNVX(sv)));
2161 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2162 PTR2UV(sv), SvNVX(sv)));
2165 #ifdef NV_PRESERVES_UV
2166 (void)SvIOKp_on(sv);
2168 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2169 SvIV_set(sv, I_V(SvNVX(sv)));
2170 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2173 NOOP; /* Integer is imprecise. NOK, IOKp */
2175 /* UV will not work better than IV */
2177 if (SvNVX(sv) > (NV)UV_MAX) {
2179 /* Integer is inaccurate. NOK, IOKp, is UV */
2180 SvUV_set(sv, UV_MAX);
2182 SvUV_set(sv, U_V(SvNVX(sv)));
2183 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2184 NV preservse UV so can do correct comparison. */
2185 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2188 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2193 #else /* NV_PRESERVES_UV */
2194 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2195 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2196 /* The IV/UV slot will have been set from value returned by
2197 grok_number above. The NV slot has just been set using
2200 assert (SvIOKp(sv));
2202 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2203 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2204 /* Small enough to preserve all bits. */
2205 (void)SvIOKp_on(sv);
2207 SvIV_set(sv, I_V(SvNVX(sv)));
2208 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2210 /* Assumption: first non-preserved integer is < IV_MAX,
2211 this NV is in the preserved range, therefore: */
2212 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2214 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);
2218 0 0 already failed to read UV.
2219 0 1 already failed to read UV.
2220 1 0 you won't get here in this case. IV/UV
2221 slot set, public IOK, Atof() unneeded.
2222 1 1 already read UV.
2223 so there's no point in sv_2iuv_non_preserve() attempting
2224 to use atol, strtol, strtoul etc. */
2226 sv_2iuv_non_preserve (sv, numtype);
2228 sv_2iuv_non_preserve (sv);
2232 #endif /* NV_PRESERVES_UV */
2233 /* It might be more code efficient to go through the entire logic above
2234 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2235 gets complex and potentially buggy, so more programmer efficient
2236 to do it this way, by turning off the public flags: */
2238 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2242 if (isGV_with_GP(sv))
2243 return glob_2number(MUTABLE_GV(sv));
2245 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2246 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2249 if (SvTYPE(sv) < SVt_IV)
2250 /* Typically the caller expects that sv_any is not NULL now. */
2251 sv_upgrade(sv, SVt_IV);
2252 /* Return 0 from the caller. */
2259 =for apidoc sv_2iv_flags
2261 Return the integer value of an SV, doing any necessary string
2262 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2263 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2269 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2274 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2275 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2276 cache IVs just in case. In practice it seems that they never
2277 actually anywhere accessible by user Perl code, let alone get used
2278 in anything other than a string context. */
2279 if (flags & SV_GMAGIC)
2284 return I_V(SvNVX(sv));
2286 if (SvPOKp(sv) && SvLEN(sv)) {
2289 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2291 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2292 == IS_NUMBER_IN_UV) {
2293 /* It's definitely an integer */
2294 if (numtype & IS_NUMBER_NEG) {
2295 if (value < (UV)IV_MIN)
2298 if (value < (UV)IV_MAX)
2303 if (ckWARN(WARN_NUMERIC))
2306 return I_V(Atof(SvPVX_const(sv)));
2311 assert(SvTYPE(sv) >= SVt_PVMG);
2312 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2313 } else if (SvTHINKFIRST(sv)) {
2318 if (flags & SV_SKIP_OVERLOAD)
2320 tmpstr = AMG_CALLunary(sv, numer_amg);
2321 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2322 return SvIV(tmpstr);
2325 return PTR2IV(SvRV(sv));
2328 sv_force_normal_flags(sv, 0);
2330 if (SvREADONLY(sv) && !SvOK(sv)) {
2331 if (ckWARN(WARN_UNINITIALIZED))
2337 if (S_sv_2iuv_common(aTHX_ sv))
2340 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2341 PTR2UV(sv),SvIVX(sv)));
2342 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2346 =for apidoc sv_2uv_flags
2348 Return the unsigned integer value of an SV, doing any necessary string
2349 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2350 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2356 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2361 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2362 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2363 cache IVs just in case. */
2364 if (flags & SV_GMAGIC)
2369 return U_V(SvNVX(sv));
2370 if (SvPOKp(sv) && SvLEN(sv)) {
2373 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2375 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2376 == IS_NUMBER_IN_UV) {
2377 /* It's definitely an integer */
2378 if (!(numtype & IS_NUMBER_NEG))
2382 if (ckWARN(WARN_NUMERIC))
2385 return U_V(Atof(SvPVX_const(sv)));
2390 assert(SvTYPE(sv) >= SVt_PVMG);
2391 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2392 } else if (SvTHINKFIRST(sv)) {
2397 if (flags & SV_SKIP_OVERLOAD)
2399 tmpstr = AMG_CALLunary(sv, numer_amg);
2400 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2401 return SvUV(tmpstr);
2404 return PTR2UV(SvRV(sv));
2407 sv_force_normal_flags(sv, 0);
2409 if (SvREADONLY(sv) && !SvOK(sv)) {
2410 if (ckWARN(WARN_UNINITIALIZED))
2416 if (S_sv_2iuv_common(aTHX_ sv))
2420 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2421 PTR2UV(sv),SvUVX(sv)));
2422 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2426 =for apidoc sv_2nv_flags
2428 Return the num value of an SV, doing any necessary string or integer
2429 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2430 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2436 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2441 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2442 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2443 cache IVs just in case. */
2444 if (flags & SV_GMAGIC)
2448 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2449 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2450 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2452 return Atof(SvPVX_const(sv));
2456 return (NV)SvUVX(sv);
2458 return (NV)SvIVX(sv);
2463 assert(SvTYPE(sv) >= SVt_PVMG);
2464 /* This falls through to the report_uninit near the end of the
2466 } else if (SvTHINKFIRST(sv)) {
2471 if (flags & SV_SKIP_OVERLOAD)
2473 tmpstr = AMG_CALLunary(sv, numer_amg);
2474 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2475 return SvNV(tmpstr);
2478 return PTR2NV(SvRV(sv));
2481 sv_force_normal_flags(sv, 0);
2483 if (SvREADONLY(sv) && !SvOK(sv)) {
2484 if (ckWARN(WARN_UNINITIALIZED))
2489 if (SvTYPE(sv) < SVt_NV) {
2490 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2491 sv_upgrade(sv, SVt_NV);
2492 #ifdef USE_LONG_DOUBLE
2494 STORE_NUMERIC_LOCAL_SET_STANDARD();
2495 PerlIO_printf(Perl_debug_log,
2496 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2497 PTR2UV(sv), SvNVX(sv));
2498 RESTORE_NUMERIC_LOCAL();
2502 STORE_NUMERIC_LOCAL_SET_STANDARD();
2503 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2504 PTR2UV(sv), SvNVX(sv));
2505 RESTORE_NUMERIC_LOCAL();
2509 else if (SvTYPE(sv) < SVt_PVNV)
2510 sv_upgrade(sv, SVt_PVNV);
2515 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2516 #ifdef NV_PRESERVES_UV
2522 /* Only set the public NV OK flag if this NV preserves the IV */
2523 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2525 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2526 : (SvIVX(sv) == I_V(SvNVX(sv))))
2532 else if (SvPOKp(sv) && SvLEN(sv)) {
2534 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2535 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2537 #ifdef NV_PRESERVES_UV
2538 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2539 == IS_NUMBER_IN_UV) {
2540 /* It's definitely an integer */
2541 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2543 SvNV_set(sv, Atof(SvPVX_const(sv)));
2549 SvNV_set(sv, Atof(SvPVX_const(sv)));
2550 /* Only set the public NV OK flag if this NV preserves the value in
2551 the PV at least as well as an IV/UV would.
2552 Not sure how to do this 100% reliably. */
2553 /* if that shift count is out of range then Configure's test is
2554 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2556 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2557 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2558 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2559 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2560 /* Can't use strtol etc to convert this string, so don't try.
2561 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2564 /* value has been set. It may not be precise. */
2565 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2566 /* 2s complement assumption for (UV)IV_MIN */
2567 SvNOK_on(sv); /* Integer is too negative. */
2572 if (numtype & IS_NUMBER_NEG) {
2573 SvIV_set(sv, -(IV)value);
2574 } else if (value <= (UV)IV_MAX) {
2575 SvIV_set(sv, (IV)value);
2577 SvUV_set(sv, value);
2581 if (numtype & IS_NUMBER_NOT_INT) {
2582 /* I believe that even if the original PV had decimals,
2583 they are lost beyond the limit of the FP precision.
2584 However, neither is canonical, so both only get p
2585 flags. NWC, 2000/11/25 */
2586 /* Both already have p flags, so do nothing */
2588 const NV nv = SvNVX(sv);
2589 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2590 if (SvIVX(sv) == I_V(nv)) {
2593 /* It had no "." so it must be integer. */
2597 /* between IV_MAX and NV(UV_MAX).
2598 Could be slightly > UV_MAX */
2600 if (numtype & IS_NUMBER_NOT_INT) {
2601 /* UV and NV both imprecise. */
2603 const UV nv_as_uv = U_V(nv);
2605 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2614 /* It might be more code efficient to go through the entire logic above
2615 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2616 gets complex and potentially buggy, so more programmer efficient
2617 to do it this way, by turning off the public flags: */
2619 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2620 #endif /* NV_PRESERVES_UV */
2623 if (isGV_with_GP(sv)) {
2624 glob_2number(MUTABLE_GV(sv));
2628 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2630 assert (SvTYPE(sv) >= SVt_NV);
2631 /* Typically the caller expects that sv_any is not NULL now. */
2632 /* XXX Ilya implies that this is a bug in callers that assume this
2633 and ideally should be fixed. */
2636 #if defined(USE_LONG_DOUBLE)
2638 STORE_NUMERIC_LOCAL_SET_STANDARD();
2639 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2640 PTR2UV(sv), SvNVX(sv));
2641 RESTORE_NUMERIC_LOCAL();
2645 STORE_NUMERIC_LOCAL_SET_STANDARD();
2646 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2647 PTR2UV(sv), SvNVX(sv));
2648 RESTORE_NUMERIC_LOCAL();
2657 Return an SV with the numeric value of the source SV, doing any necessary
2658 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2659 access this function.
2665 Perl_sv_2num(pTHX_ register SV *const sv)
2667 PERL_ARGS_ASSERT_SV_2NUM;
2672 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2673 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2674 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2675 return sv_2num(tmpsv);
2677 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2680 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2681 * UV as a string towards the end of buf, and return pointers to start and
2684 * We assume that buf is at least TYPE_CHARS(UV) long.
2688 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2690 char *ptr = buf + TYPE_CHARS(UV);
2691 char * const ebuf = ptr;
2694 PERL_ARGS_ASSERT_UIV_2BUF;
2706 *--ptr = '0' + (char)(uv % 10);
2715 =for apidoc sv_2pv_flags
2717 Returns a pointer to the string value of an SV, and sets *lp to its length.
2718 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2720 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2721 usually end up here too.
2727 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2737 if (SvGMAGICAL(sv)) {
2738 if (flags & SV_GMAGIC)
2743 if (flags & SV_MUTABLE_RETURN)
2744 return SvPVX_mutable(sv);
2745 if (flags & SV_CONST_RETURN)
2746 return (char *)SvPVX_const(sv);
2749 if (SvIOKp(sv) || SvNOKp(sv)) {
2750 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2755 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2756 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2757 } else if(SvNVX(sv) == 0.0) {
2762 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2769 SvUPGRADE(sv, SVt_PV);
2772 s = SvGROW_mutable(sv, len + 1);
2775 return (char*)memcpy(s, tbuf, len + 1);
2781 assert(SvTYPE(sv) >= SVt_PVMG);
2782 /* This falls through to the report_uninit near the end of the
2784 } else if (SvTHINKFIRST(sv)) {
2789 if (flags & SV_SKIP_OVERLOAD)
2791 tmpstr = AMG_CALLunary(sv, string_amg);
2792 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2793 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2795 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2799 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2800 if (flags & SV_CONST_RETURN) {
2801 pv = (char *) SvPVX_const(tmpstr);
2803 pv = (flags & SV_MUTABLE_RETURN)
2804 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2807 *lp = SvCUR(tmpstr);
2809 pv = sv_2pv_flags(tmpstr, lp, flags);
2822 SV *const referent = SvRV(sv);
2826 retval = buffer = savepvn("NULLREF", len);
2827 } else if (SvTYPE(referent) == SVt_REGEXP) {
2828 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2833 /* If the regex is UTF-8 we want the containing scalar to
2834 have an UTF-8 flag too */
2840 if ((seen_evals = RX_SEEN_EVALS(re)))
2841 PL_reginterp_cnt += seen_evals;
2844 *lp = RX_WRAPLEN(re);
2846 return RX_WRAPPED(re);
2848 const char *const typestr = sv_reftype(referent, 0);
2849 const STRLEN typelen = strlen(typestr);
2850 UV addr = PTR2UV(referent);
2851 const char *stashname = NULL;
2852 STRLEN stashnamelen = 0; /* hush, gcc */
2853 const char *buffer_end;
2855 if (SvOBJECT(referent)) {
2856 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2859 stashname = HEK_KEY(name);
2860 stashnamelen = HEK_LEN(name);
2862 if (HEK_UTF8(name)) {
2868 stashname = "__ANON__";
2871 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2872 + 2 * sizeof(UV) + 2 /* )\0 */;
2874 len = typelen + 3 /* (0x */
2875 + 2 * sizeof(UV) + 2 /* )\0 */;
2878 Newx(buffer, len, char);
2879 buffer_end = retval = buffer + len;
2881 /* Working backwards */
2885 *--retval = PL_hexdigit[addr & 15];
2886 } while (addr >>= 4);
2892 memcpy(retval, typestr, typelen);
2896 retval -= stashnamelen;
2897 memcpy(retval, stashname, stashnamelen);
2899 /* retval may not necessarily have reached the start of the
2901 assert (retval >= buffer);
2903 len = buffer_end - retval - 1; /* -1 for that \0 */
2911 if (SvREADONLY(sv) && !SvOK(sv)) {
2914 if (flags & SV_UNDEF_RETURNS_NULL)
2916 if (ckWARN(WARN_UNINITIALIZED))
2921 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2922 /* I'm assuming that if both IV and NV are equally valid then
2923 converting the IV is going to be more efficient */
2924 const U32 isUIOK = SvIsUV(sv);
2925 char buf[TYPE_CHARS(UV)];
2929 if (SvTYPE(sv) < SVt_PVIV)
2930 sv_upgrade(sv, SVt_PVIV);
2931 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2933 /* inlined from sv_setpvn */
2934 s = SvGROW_mutable(sv, len + 1);
2935 Move(ptr, s, len, char);
2939 else if (SvNOKp(sv)) {
2940 if (SvTYPE(sv) < SVt_PVNV)
2941 sv_upgrade(sv, SVt_PVNV);
2942 if (SvNVX(sv) == 0.0) {
2943 s = SvGROW_mutable(sv, 2);
2948 /* The +20 is pure guesswork. Configure test needed. --jhi */
2949 s = SvGROW_mutable(sv, NV_DIG + 20);
2950 /* some Xenix systems wipe out errno here */
2951 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2961 if (isGV_with_GP(sv)) {
2962 GV *const gv = MUTABLE_GV(sv);
2963 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2964 SV *const buffer = sv_newmortal();
2966 /* FAKE globs can get coerced, so need to turn this off temporarily
2969 gv_efullname3(buffer, gv, "*");
2970 SvFLAGS(gv) |= wasfake;
2972 if (SvPOK(buffer)) {
2974 *lp = SvCUR(buffer);
2976 return SvPVX(buffer);
2987 if (flags & SV_UNDEF_RETURNS_NULL)
2989 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2991 if (SvTYPE(sv) < SVt_PV)
2992 /* Typically the caller expects that sv_any is not NULL now. */
2993 sv_upgrade(sv, SVt_PV);
2997 const STRLEN len = s - SvPVX_const(sv);
3003 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3004 PTR2UV(sv),SvPVX_const(sv)));
3005 if (flags & SV_CONST_RETURN)
3006 return (char *)SvPVX_const(sv);
3007 if (flags & SV_MUTABLE_RETURN)
3008 return SvPVX_mutable(sv);
3013 =for apidoc sv_copypv
3015 Copies a stringified representation of the source SV into the
3016 destination SV. Automatically performs any necessary mg_get and
3017 coercion of numeric values into strings. Guaranteed to preserve
3018 UTF8 flag even from overloaded objects. Similar in nature to
3019 sv_2pv[_flags] but operates directly on an SV instead of just the
3020 string. Mostly uses sv_2pv_flags to do its work, except when that
3021 would lose the UTF-8'ness of the PV.
3027 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3030 const char * const s = SvPV_const(ssv,len);
3032 PERL_ARGS_ASSERT_SV_COPYPV;
3034 sv_setpvn(dsv,s,len);
3042 =for apidoc sv_2pvbyte
3044 Return a pointer to the byte-encoded representation of the SV, and set *lp
3045 to its length. May cause the SV to be downgraded from UTF-8 as a
3048 Usually accessed via the C<SvPVbyte> macro.
3054 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3056 PERL_ARGS_ASSERT_SV_2PVBYTE;
3059 sv_utf8_downgrade(sv,0);
3060 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3064 =for apidoc sv_2pvutf8
3066 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3067 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3069 Usually accessed via the C<SvPVutf8> macro.
3075 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3077 PERL_ARGS_ASSERT_SV_2PVUTF8;
3079 sv_utf8_upgrade(sv);
3080 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3085 =for apidoc sv_2bool
3087 This macro is only used by sv_true() or its macro equivalent, and only if
3088 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3089 It calls sv_2bool_flags with the SV_GMAGIC flag.
3091 =for apidoc sv_2bool_flags
3093 This function is only used by sv_true() and friends, and only if
3094 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3095 contain SV_GMAGIC, then it does an mg_get() first.
3102 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3106 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3108 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3114 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3115 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3116 return cBOOL(SvTRUE(tmpsv));
3118 return SvRV(sv) != 0;
3121 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3123 (*sv->sv_u.svu_pv > '0' ||
3124 Xpvtmp->xpv_cur > 1 ||
3125 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3132 return SvIVX(sv) != 0;
3135 return SvNVX(sv) != 0.0;
3137 if (isGV_with_GP(sv))
3147 =for apidoc sv_utf8_upgrade
3149 Converts the PV of an SV to its UTF-8-encoded form.
3150 Forces the SV to string form if it is not already.
3151 Will C<mg_get> on C<sv> if appropriate.
3152 Always sets the SvUTF8 flag to avoid future validity checks even
3153 if the whole string is the same in UTF-8 as not.
3154 Returns the number of bytes in the converted string
3156 This is not as a general purpose byte encoding to Unicode interface:
3157 use the Encode extension for that.
3159 =for apidoc sv_utf8_upgrade_nomg
3161 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3163 =for apidoc sv_utf8_upgrade_flags
3165 Converts the PV of an SV to its UTF-8-encoded form.
3166 Forces the SV to string form if it is not already.
3167 Always sets the SvUTF8 flag to avoid future validity checks even
3168 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3169 will C<mg_get> on C<sv> if appropriate, else not.
3170 Returns the number of bytes in the converted string
3171 C<sv_utf8_upgrade> and
3172 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3174 This is not as a general purpose byte encoding to Unicode interface:
3175 use the Encode extension for that.
3179 The grow version is currently not externally documented. It adds a parameter,
3180 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3181 have free after it upon return. This allows the caller to reserve extra space
3182 that it intends to fill, to avoid extra grows.
3184 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3185 which can be used to tell this function to not first check to see if there are
3186 any characters that are different in UTF-8 (variant characters) which would
3187 force it to allocate a new string to sv, but to assume there are. Typically
3188 this flag is used by a routine that has already parsed the string to find that
3189 there are such characters, and passes this information on so that the work
3190 doesn't have to be repeated.
3192 (One might think that the calling routine could pass in the position of the
3193 first such variant, so it wouldn't have to be found again. But that is not the
3194 case, because typically when the caller is likely to use this flag, it won't be
3195 calling this routine unless it finds something that won't fit into a byte.
3196 Otherwise it tries to not upgrade and just use bytes. But some things that
3197 do fit into a byte are variants in utf8, and the caller may not have been
3198 keeping track of these.)
3200 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3201 isn't guaranteed due to having other routines do the work in some input cases,
3202 or if the input is already flagged as being in utf8.
3204 The speed of this could perhaps be improved for many cases if someone wanted to
3205 write a fast function that counts the number of variant characters in a string,
3206 especially if it could return the position of the first one.
3211 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3215 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3217 if (sv == &PL_sv_undef)
3221 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3222 (void) sv_2pv_flags(sv,&len, flags);
3224 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3228 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3233 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3238 sv_force_normal_flags(sv, 0);
3241 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3242 sv_recode_to_utf8(sv, PL_encoding);
3243 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3247 if (SvCUR(sv) == 0) {
3248 if (extra) SvGROW(sv, extra);
3249 } else { /* Assume Latin-1/EBCDIC */
3250 /* This function could be much more efficient if we
3251 * had a FLAG in SVs to signal if there are any variant
3252 * chars in the PV. Given that there isn't such a flag
3253 * make the loop as fast as possible (although there are certainly ways
3254 * to speed this up, eg. through vectorization) */
3255 U8 * s = (U8 *) SvPVX_const(sv);
3256 U8 * e = (U8 *) SvEND(sv);
3258 STRLEN two_byte_count = 0;
3260 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3262 /* See if really will need to convert to utf8. We mustn't rely on our
3263 * incoming SV being well formed and having a trailing '\0', as certain
3264 * code in pp_formline can send us partially built SVs. */
3268 if (NATIVE_IS_INVARIANT(ch)) continue;
3270 t--; /* t already incremented; re-point to first variant */
3275 /* utf8 conversion not needed because all are invariants. Mark as
3276 * UTF-8 even if no variant - saves scanning loop */
3282 /* Here, the string should be converted to utf8, either because of an
3283 * input flag (two_byte_count = 0), or because a character that
3284 * requires 2 bytes was found (two_byte_count = 1). t points either to
3285 * the beginning of the string (if we didn't examine anything), or to
3286 * the first variant. In either case, everything from s to t - 1 will
3287 * occupy only 1 byte each on output.
3289 * There are two main ways to convert. One is to create a new string
3290 * and go through the input starting from the beginning, appending each
3291 * converted value onto the new string as we go along. It's probably
3292 * best to allocate enough space in the string for the worst possible
3293 * case rather than possibly running out of space and having to
3294 * reallocate and then copy what we've done so far. Since everything
3295 * from s to t - 1 is invariant, the destination can be initialized
3296 * with these using a fast memory copy
3298 * The other way is to figure out exactly how big the string should be
3299 * by parsing the entire input. Then you don't have to make it big
3300 * enough to handle the worst possible case, and more importantly, if
3301 * the string you already have is large enough, you don't have to
3302 * allocate a new string, you can copy the last character in the input
3303 * string to the final position(s) that will be occupied by the
3304 * converted string and go backwards, stopping at t, since everything
3305 * before that is invariant.
3307 * There are advantages and disadvantages to each method.
3309 * In the first method, we can allocate a new string, do the memory
3310 * copy from the s to t - 1, and then proceed through the rest of the
3311 * string byte-by-byte.
3313 * In the second method, we proceed through the rest of the input
3314 * string just calculating how big the converted string will be. Then
3315 * there are two cases:
3316 * 1) if the string has enough extra space to handle the converted
3317 * value. We go backwards through the string, converting until we
3318 * get to the position we are at now, and then stop. If this
3319 * position is far enough along in the string, this method is
3320 * faster than the other method. If the memory copy were the same
3321 * speed as the byte-by-byte loop, that position would be about
3322 * half-way, as at the half-way mark, parsing to the end and back
3323 * is one complete string's parse, the same amount as starting
3324 * over and going all the way through. Actually, it would be
3325 * somewhat less than half-way, as it's faster to just count bytes
3326 * than to also copy, and we don't have the overhead of allocating
3327 * a new string, changing the scalar to use it, and freeing the
3328 * existing one. But if the memory copy is fast, the break-even
3329 * point is somewhere after half way. The counting loop could be
3330 * sped up by vectorization, etc, to move the break-even point
3331 * further towards the beginning.
3332 * 2) if the string doesn't have enough space to handle the converted
3333 * value. A new string will have to be allocated, and one might
3334 * as well, given that, start from the beginning doing the first
3335 * method. We've spent extra time parsing the string and in
3336 * exchange all we've gotten is that we know precisely how big to
3337 * make the new one. Perl is more optimized for time than space,
3338 * so this case is a loser.
3339 * So what I've decided to do is not use the 2nd method unless it is
3340 * guaranteed that a new string won't have to be allocated, assuming
3341 * the worst case. I also decided not to put any more conditions on it
3342 * than this, for now. It seems likely that, since the worst case is
3343 * twice as big as the unknown portion of the string (plus 1), we won't
3344 * be guaranteed enough space, causing us to go to the first method,
3345 * unless the string is short, or the first variant character is near
3346 * the end of it. In either of these cases, it seems best to use the
3347 * 2nd method. The only circumstance I can think of where this would
3348 * be really slower is if the string had once had much more data in it
3349 * than it does now, but there is still a substantial amount in it */
3352 STRLEN invariant_head = t - s;
3353 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3354 if (SvLEN(sv) < size) {
3356 /* Here, have decided to allocate a new string */
3361 Newx(dst, size, U8);
3363 /* If no known invariants at the beginning of the input string,
3364 * set so starts from there. Otherwise, can use memory copy to
3365 * get up to where we are now, and then start from here */
3367 if (invariant_head <= 0) {
3370 Copy(s, dst, invariant_head, char);
3371 d = dst + invariant_head;
3375 const UV uv = NATIVE8_TO_UNI(*t++);
3376 if (UNI_IS_INVARIANT(uv))
3377 *d++ = (U8)UNI_TO_NATIVE(uv);
3379 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3380 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3384 SvPV_free(sv); /* No longer using pre-existing string */
3385 SvPV_set(sv, (char*)dst);
3386 SvCUR_set(sv, d - dst);
3387 SvLEN_set(sv, size);
3390 /* Here, have decided to get the exact size of the string.
3391 * Currently this happens only when we know that there is
3392 * guaranteed enough space to fit the converted string, so
3393 * don't have to worry about growing. If two_byte_count is 0,
3394 * then t points to the first byte of the string which hasn't
3395 * been examined yet. Otherwise two_byte_count is 1, and t
3396 * points to the first byte in the string that will expand to
3397 * two. Depending on this, start examining at t or 1 after t.
3400 U8 *d = t + two_byte_count;
3403 /* Count up the remaining bytes that expand to two */
3406 const U8 chr = *d++;
3407 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3410 /* The string will expand by just the number of bytes that
3411 * occupy two positions. But we are one afterwards because of
3412 * the increment just above. This is the place to put the
3413 * trailing NUL, and to set the length before we decrement */
3415 d += two_byte_count;
3416 SvCUR_set(sv, d - s);
3420 /* Having decremented d, it points to the position to put the
3421 * very last byte of the expanded string. Go backwards through
3422 * the string, copying and expanding as we go, stopping when we
3423 * get to the part that is invariant the rest of the way down */
3427 const U8 ch = NATIVE8_TO_UNI(*e--);
3428 if (UNI_IS_INVARIANT(ch)) {
3429 *d-- = UNI_TO_NATIVE(ch);
3431 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3432 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3437 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3438 /* Update pos. We do it at the end rather than during
3439 * the upgrade, to avoid slowing down the common case
3440 * (upgrade without pos) */
3441 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3443 I32 pos = mg->mg_len;
3444 if (pos > 0 && (U32)pos > invariant_head) {
3445 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3446 STRLEN n = (U32)pos - invariant_head;
3448 if (UTF8_IS_START(*d))
3453 mg->mg_len = d - (U8*)SvPVX(sv);
3456 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3457 magic_setutf8(sv,mg); /* clear UTF8 cache */
3462 /* Mark as UTF-8 even if no variant - saves scanning loop */
3468 =for apidoc sv_utf8_downgrade
3470 Attempts to convert the PV of an SV from characters to bytes.
3471 If the PV contains a character that cannot fit
3472 in a byte, this conversion will fail;
3473 in this case, either returns false or, if C<fail_ok> is not
3476 This is not as a general purpose Unicode to byte encoding interface:
3477 use the Encode extension for that.
3483 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3487 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3489 if (SvPOKp(sv) && SvUTF8(sv)) {
3493 int mg_flags = SV_GMAGIC;
3496 sv_force_normal_flags(sv, 0);
3498 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3500 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3502 I32 pos = mg->mg_len;
3504 sv_pos_b2u(sv, &pos);
3505 mg_flags = 0; /* sv_pos_b2u does get magic */
3509 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3510 magic_setutf8(sv,mg); /* clear UTF8 cache */
3513 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3515 if (!utf8_to_bytes(s, &len)) {
3520 Perl_croak(aTHX_ "Wide character in %s",
3523 Perl_croak(aTHX_ "Wide character");
3534 =for apidoc sv_utf8_encode
3536 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3537 flag off so that it looks like octets again.
3543 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3545 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3548 sv_force_normal_flags(sv, 0);
3550 if (SvREADONLY(sv)) {
3551 Perl_croak_no_modify(aTHX);
3553 (void) sv_utf8_upgrade(sv);
3558 =for apidoc sv_utf8_decode
3560 If the PV of the SV is an octet sequence in UTF-8
3561 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3562 so that it looks like a character. If the PV contains only single-byte
3563 characters, the C<SvUTF8> flag stays being off.
3564 Scans PV for validity and returns false if the PV is invalid UTF-8.
3570 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3572 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3575 const U8 *start, *c;
3578 /* The octets may have got themselves encoded - get them back as
3581 if (!sv_utf8_downgrade(sv, TRUE))
3584 /* it is actually just a matter of turning the utf8 flag on, but
3585 * we want to make sure everything inside is valid utf8 first.
3587 c = start = (const U8 *) SvPVX_const(sv);
3588 if (!is_utf8_string(c, SvCUR(sv)+1))
3590 e = (const U8 *) SvEND(sv);
3593 if (!UTF8_IS_INVARIANT(ch)) {
3598 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3599 /* adjust pos to the start of a UTF8 char sequence */
3600 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3602 I32 pos = mg->mg_len;
3604 for (c = start + pos; c > start; c--) {
3605 if (UTF8_IS_START(*c))
3608 mg->mg_len = c - start;
3611 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3612 magic_setutf8(sv,mg); /* clear UTF8 cache */
3619 =for apidoc sv_setsv
3621 Copies the contents of the source SV C<ssv> into the destination SV
3622 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3623 function if the source SV needs to be reused. Does not handle 'set' magic.
3624 Loosely speaking, it performs a copy-by-value, obliterating any previous
3625 content of the destination.
3627 You probably want to use one of the assortment of wrappers, such as
3628 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3629 C<SvSetMagicSV_nosteal>.
3631 =for apidoc sv_setsv_flags
3633 Copies the contents of the source SV C<ssv> into the destination SV
3634 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3635 function if the source SV needs to be reused. Does not handle 'set' magic.
3636 Loosely speaking, it performs a copy-by-value, obliterating any previous
3637 content of the destination.
3638 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3639 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3640 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3641 and C<sv_setsv_nomg> are implemented in terms of this function.
3643 You probably want to use one of the assortment of wrappers, such as
3644 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3645 C<SvSetMagicSV_nosteal>.
3647 This is the primary function for copying scalars, and most other
3648 copy-ish functions and macros use this underneath.
3654 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3656 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3657 HV *old_stash = NULL;
3659 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3661 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3662 const char * const name = GvNAME(sstr);
3663 const STRLEN len = GvNAMELEN(sstr);
3665 if (dtype >= SVt_PV) {
3671 SvUPGRADE(dstr, SVt_PVGV);
3672 (void)SvOK_off(dstr);
3673 /* FIXME - why are we doing this, then turning it off and on again
3675 isGV_with_GP_on(dstr);
3677 GvSTASH(dstr) = GvSTASH(sstr);
3679 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3680 gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3681 SvFAKE_on(dstr); /* can coerce to non-glob */
3684 if(GvGP(MUTABLE_GV(sstr))) {
3685 /* If source has method cache entry, clear it */
3687 SvREFCNT_dec(GvCV(sstr));
3688 GvCV_set(sstr, NULL);
3691 /* If source has a real method, then a method is
3694 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3700 /* If dest already had a real method, that's a change as well */
3702 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3703 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3708 /* We don’t need to check the name of the destination if it was not a
3709 glob to begin with. */
3710 if(dtype == SVt_PVGV) {
3711 const char * const name = GvNAME((const GV *)dstr);
3714 /* The stash may have been detached from the symbol table, so
3716 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3717 && GvAV((const GV *)sstr)
3721 const STRLEN len = GvNAMELEN(dstr);
3722 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
3725 /* Set aside the old stash, so we can reset isa caches on
3727 if((old_stash = GvHV(dstr)))
3728 /* Make sure we do not lose it early. */
3729 SvREFCNT_inc_simple_void_NN(
3730 sv_2mortal((SV *)old_stash)
3736 gp_free(MUTABLE_GV(dstr));
3737 isGV_with_GP_off(dstr);
3738 (void)SvOK_off(dstr);
3739 isGV_with_GP_on(dstr);
3740 GvINTRO_off(dstr); /* one-shot flag */
3741 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3742 if (SvTAINTED(sstr))
3744 if (GvIMPORTED(dstr) != GVf_IMPORTED
3745 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3747 GvIMPORTED_on(dstr);
3750 if(mro_changes == 2) {
3752 SV * const sref = (SV *)GvAV((const GV *)dstr);
3753 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3754 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3755 AV * const ary = newAV();
3756 av_push(ary, mg->mg_obj); /* takes the refcount */
3757 mg->mg_obj = (SV *)ary;
3759 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3761 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3762 mro_isa_changed_in(GvSTASH(dstr));
3764 else if(mro_changes == 3) {
3765 HV * const stash = GvHV(dstr);
3766 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3772 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3777 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3779 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3781 const int intro = GvINTRO(dstr);
3784 const U32 stype = SvTYPE(sref);
3786 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3789 GvINTRO_off(dstr); /* one-shot flag */
3790 GvLINE(dstr) = CopLINE(PL_curcop);
3791 GvEGV(dstr) = MUTABLE_GV(dstr);
3796 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3797 import_flag = GVf_IMPORTED_CV;
3800 location = (SV **) &GvHV(dstr);
3801 import_flag = GVf_IMPORTED_HV;
3804 location = (SV **) &GvAV(dstr);
3805 import_flag = GVf_IMPORTED_AV;
3808 location = (SV **) &GvIOp(dstr);
3811 location = (SV **) &GvFORM(dstr);
3814 location = &GvSV(dstr);
3815 import_flag = GVf_IMPORTED_SV;
3818 if (stype == SVt_PVCV) {
3819 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3820 if (GvCVGEN(dstr)) {
3821 SvREFCNT_dec(GvCV(dstr));
3822 GvCV_set(dstr, NULL);
3823 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3826 SAVEGENERICSV(*location);
3830 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3831 CV* const cv = MUTABLE_CV(*location);
3833 if (!GvCVGEN((const GV *)dstr) &&
3834 (CvROOT(cv) || CvXSUB(cv)))
3836 /* Redefining a sub - warning is mandatory if
3837 it was a const and its value changed. */
3838 if (CvCONST(cv) && CvCONST((const CV *)sref)
3840 == cv_const_sv((const CV *)sref)) {
3842 /* They are 2 constant subroutines generated from
3843 the same constant. This probably means that
3844 they are really the "same" proxy subroutine
3845 instantiated in 2 places. Most likely this is
3846 when a constant is exported twice. Don't warn.
3849 else if (ckWARN(WARN_REDEFINE)
3851 && (!CvCONST((const CV *)sref)
3852 || sv_cmp(cv_const_sv(cv),
3853 cv_const_sv((const CV *)
3855 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3858 ? "Constant subroutine %s::%s redefined"
3859 : "Subroutine %s::%s redefined"),
3860 HvNAME_get(GvSTASH((const GV *)dstr)),
3861 GvENAME(MUTABLE_GV(dstr)));
3865 cv_ckproto_len(cv, (const GV *)dstr,
3866 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3867 SvPOK(sref) ? SvCUR(sref) : 0);
3869 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3870 GvASSUMECV_on(dstr);
3871 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3874 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3875 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3876 GvFLAGS(dstr) |= import_flag;
3878 if (stype == SVt_PVHV) {
3879 const char * const name = GvNAME((GV*)dstr);
3880 const STRLEN len = GvNAMELEN(dstr);
3882 len > 1 && name[len-2] == ':' && name[len-1] == ':'
3883 && (!dref || HvENAME_get(dref))
3886 (HV *)sref, (HV *)dref,
3892 stype == SVt_PVAV && sref != dref
3893 && strEQ(GvNAME((GV*)dstr), "ISA")
3894 /* The stash may have been detached from the symbol table, so
3895 check its name before doing anything. */
3896 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3899 MAGIC * const omg = dref && SvSMAGICAL(dref)
3900 ? mg_find(dref, PERL_MAGIC_isa)
3902 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3903 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3904 AV * const ary = newAV();
3905 av_push(ary, mg->mg_obj); /* takes the refcount */
3906 mg->mg_obj = (SV *)ary;
3909 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3910 SV **svp = AvARRAY((AV *)omg->mg_obj);
3911 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3915 SvREFCNT_inc_simple_NN(*svp++)
3921 SvREFCNT_inc_simple_NN(omg->mg_obj)
3925 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3930 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3932 mg = mg_find(sref, PERL_MAGIC_isa);
3934 /* Since the *ISA assignment could have affected more than
3935 one stash, don’t call mro_isa_changed_in directly, but let
3936 magic_clearisa do it for us, as it already has the logic for
3937 dealing with globs vs arrays of globs. */
3939 Perl_magic_clearisa(aTHX_ NULL, mg);
3944 if (SvTAINTED(sstr))
3950 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3953 register U32 sflags;
3955 register svtype stype;
3957 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3962 if (SvIS_FREED(dstr)) {
3963 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3964 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3966 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3968 sstr = &PL_sv_undef;
3969 if (SvIS_FREED(sstr)) {
3970 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3971 (void*)sstr, (void*)dstr);
3973 stype = SvTYPE(sstr);
3974 dtype = SvTYPE(dstr);
3976 (void)SvAMAGIC_off(dstr);
3979 /* need to nuke the magic */
3983 /* There's a lot of redundancy below but we're going for speed here */
3988 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3989 (void)SvOK_off(dstr);
3997 sv_upgrade(dstr, SVt_IV);
4001 sv_upgrade(dstr, SVt_PVIV);
4005 goto end_of_first_switch;
4007 (void)SvIOK_only(dstr);
4008 SvIV_set(dstr, SvIVX(sstr));
4011 /* SvTAINTED can only be true if the SV has taint magic, which in
4012 turn means that the SV type is PVMG (or greater). This is the
4013 case statement for SVt_IV, so this cannot be true (whatever gcov
4015 assert(!SvTAINTED(sstr));
4020 if (dtype < SVt_PV && dtype != SVt_IV)
4021 sv_upgrade(dstr, SVt_IV);
4029 sv_upgrade(dstr, SVt_NV);
4033 sv_upgrade(dstr, SVt_PVNV);
4037 goto end_of_first_switch;
4039 SvNV_set(dstr, SvNVX(sstr));
4040 (void)SvNOK_only(dstr);
4041 /* SvTAINTED can only be true if the SV has taint magic, which in
4042 turn means that the SV type is PVMG (or greater). This is the
4043 case statement for SVt_NV, so this cannot be true (whatever gcov
4045 assert(!SvTAINTED(sstr));
4051 #ifdef PERL_OLD_COPY_ON_WRITE
4052 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4053 if (dtype < SVt_PVIV)
4054 sv_upgrade(dstr, SVt_PVIV);
4061 sv_upgrade(dstr, SVt_PV);
4064 if (dtype < SVt_PVIV)
4065 sv_upgrade(dstr, SVt_PVIV);
4068 if (dtype < SVt_PVNV)
4069 sv_upgrade(dstr, SVt_PVNV);
4073 const char * const type = sv_reftype(sstr,0);
4075 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4077 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4082 if (dtype < SVt_REGEXP)
4083 sv_upgrade(dstr, SVt_REGEXP);
4086 /* case SVt_BIND: */
4089 /* SvVALID means that this PVGV is playing at being an FBM. */
4092 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4094 if (SvTYPE(sstr) != stype)
4095 stype = SvTYPE(sstr);
4097 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4098 glob_assign_glob(dstr, sstr, dtype);
4101 if (stype == SVt_PVLV)
4102 SvUPGRADE(dstr, SVt_PVNV);
4104 SvUPGRADE(dstr, (svtype)stype);
4106 end_of_first_switch:
4108 /* dstr may have been upgraded. */
4109 dtype = SvTYPE(dstr);
4110 sflags = SvFLAGS(sstr);
4112 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4113 /* Assigning to a subroutine sets the prototype. */
4116 const char *const ptr = SvPV_const(sstr, len);
4118 SvGROW(dstr, len + 1);
4119 Copy(ptr, SvPVX(dstr), len + 1, char);
4120 SvCUR_set(dstr, len);
4122 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4126 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4127 const char * const type = sv_reftype(dstr,0);
4129 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4131 Perl_croak(aTHX_ "Cannot copy to %s", type);
4132 } else if (sflags & SVf_ROK) {
4133 if (isGV_with_GP(dstr)
4134 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4137 if (GvIMPORTED(dstr) != GVf_IMPORTED
4138 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4140 GvIMPORTED_on(dstr);
4145 glob_assign_glob(dstr, sstr, dtype);
4149 if (dtype >= SVt_PV) {
4150 if (isGV_with_GP(dstr)) {
4151 glob_assign_ref(dstr, sstr);
4154 if (SvPVX_const(dstr)) {
4160 (void)SvOK_off(dstr);
4161 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4162 SvFLAGS(dstr) |= sflags & SVf_ROK;
4163 assert(!(sflags & SVp_NOK));
4164 assert(!(sflags & SVp_IOK));
4165 assert(!(sflags & SVf_NOK));
4166 assert(!(sflags & SVf_IOK));
4168 else if (isGV_with_GP(dstr)) {
4169 if (!(sflags & SVf_OK)) {
4170 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4171 "Undefined value assigned to typeglob");
4174 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4175 if (dstr != (const SV *)gv) {
4176 const char * const name = GvNAME((const GV *)dstr);
4177 const STRLEN len = GvNAMELEN(dstr);
4178 HV *old_stash = NULL;
4179 bool reset_isa = FALSE;
4180 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
4181 /* Set aside the old stash, so we can reset isa caches
4182 on its subclasses. */
4183 if((old_stash = GvHV(dstr))) {
4184 /* Make sure we do not lose it early. */
4185 SvREFCNT_inc_simple_void_NN(
4186 sv_2mortal((SV *)old_stash)
4193 gp_free(MUTABLE_GV(dstr));
4194 GvGP_set(dstr, gp_ref(GvGP(gv)));
4197 HV * const stash = GvHV(dstr);
4199 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4209 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4210 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4212 else if (sflags & SVp_POK) {
4216 * Check to see if we can just swipe the string. If so, it's a
4217 * possible small lose on short strings, but a big win on long ones.
4218 * It might even be a win on short strings if SvPVX_const(dstr)
4219 * has to be allocated and SvPVX_const(sstr) has to be freed.
4220 * Likewise if we can set up COW rather than doing an actual copy, we
4221 * drop to the else clause, as the swipe code and the COW setup code
4222 * have much in common.
4225 /* Whichever path we take through the next code, we want this true,
4226 and doing it now facilitates the COW check. */
4227 (void)SvPOK_only(dstr);
4230 /* If we're already COW then this clause is not true, and if COW
4231 is allowed then we drop down to the else and make dest COW
4232 with us. If caller hasn't said that we're allowed to COW
4233 shared hash keys then we don't do the COW setup, even if the
4234 source scalar is a shared hash key scalar. */
4235 (((flags & SV_COW_SHARED_HASH_KEYS)
4236 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4237 : 1 /* If making a COW copy is forbidden then the behaviour we
4238 desire is as if the source SV isn't actually already
4239 COW, even if it is. So we act as if the source flags
4240 are not COW, rather than actually testing them. */
4242 #ifndef PERL_OLD_COPY_ON_WRITE
4243 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4244 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4245 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4246 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4247 but in turn, it's somewhat dead code, never expected to go
4248 live, but more kept as a placeholder on how to do it better
4249 in a newer implementation. */
4250 /* If we are COW and dstr is a suitable target then we drop down
4251 into the else and make dest a COW of us. */
4252 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4257 (sflags & SVs_TEMP) && /* slated for free anyway? */
4258 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4259 (!(flags & SV_NOSTEAL)) &&
4260 /* and we're allowed to steal temps */
4261 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4262 SvLEN(sstr)) /* and really is a string */
4263 #ifdef PERL_OLD_COPY_ON_WRITE
4264 && ((flags & SV_COW_SHARED_HASH_KEYS)
4265 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4266 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4267 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4271 /* Failed the swipe test, and it's not a shared hash key either.
4272 Have to copy the string. */
4273 STRLEN len = SvCUR(sstr);
4274 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4275 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4276 SvCUR_set(dstr, len);
4277 *SvEND(dstr) = '\0';
4279 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4281 /* Either it's a shared hash key, or it's suitable for
4282 copy-on-write or we can swipe the string. */
4284 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4288 #ifdef PERL_OLD_COPY_ON_WRITE
4290 if ((sflags & (SVf_FAKE | SVf_READONLY))
4291 != (SVf_FAKE | SVf_READONLY)) {
4292 SvREADONLY_on(sstr);
4294 /* Make the source SV into a loop of 1.
4295 (about to become 2) */
4296 SV_COW_NEXT_SV_SET(sstr, sstr);
4300 /* Initial code is common. */
4301 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4306 /* making another shared SV. */
4307 STRLEN cur = SvCUR(sstr);
4308 STRLEN len = SvLEN(sstr);
4309 #ifdef PERL_OLD_COPY_ON_WRITE
4311 assert (SvTYPE(dstr) >= SVt_PVIV);
4312 /* SvIsCOW_normal */
4313 /* splice us in between source and next-after-source. */
4314 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4315 SV_COW_NEXT_SV_SET(sstr, dstr);
4316 SvPV_set(dstr, SvPVX_mutable(sstr));
4320 /* SvIsCOW_shared_hash */
4321 DEBUG_C(PerlIO_printf(Perl_debug_log,
4322 "Copy on write: Sharing hash\n"));
4324 assert (SvTYPE(dstr) >= SVt_PV);
4326 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4328 SvLEN_set(dstr, len);
4329 SvCUR_set(dstr, cur);
4330 SvREADONLY_on(dstr);
4334 { /* Passes the swipe test. */
4335 SvPV_set(dstr, SvPVX_mutable(sstr));
4336 SvLEN_set(dstr, SvLEN(sstr));
4337 SvCUR_set(dstr, SvCUR(sstr));
4340 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4341 SvPV_set(sstr, NULL);
4347 if (sflags & SVp_NOK) {
4348 SvNV_set(dstr, SvNVX(sstr));
4350 if (sflags & SVp_IOK) {
4351 SvIV_set(dstr, SvIVX(sstr));
4352 /* Must do this otherwise some other overloaded use of 0x80000000
4353 gets confused. I guess SVpbm_VALID */
4354 if (sflags & SVf_IVisUV)
4357 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4359 const MAGIC * const smg = SvVSTRING_mg(sstr);
4361 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4362 smg->mg_ptr, smg->mg_len);
4363 SvRMAGICAL_on(dstr);
4367 else if (sflags & (SVp_IOK|SVp_NOK)) {
4368 (void)SvOK_off(dstr);
4369 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4370 if (sflags & SVp_IOK) {
4371 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4372 SvIV_set(dstr, SvIVX(sstr));
4374 if (sflags & SVp_NOK) {
4375 SvNV_set(dstr, SvNVX(sstr));
4379 if (isGV_with_GP(sstr)) {
4380 /* This stringification rule for globs is spread in 3 places.
4381 This feels bad. FIXME. */
4382 const U32 wasfake = sflags & SVf_FAKE;
4384 /* FAKE globs can get coerced, so need to turn this off
4385 temporarily if it is on. */
4387 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4388 SvFLAGS(sstr) |= wasfake;
4391 (void)SvOK_off(dstr);
4393 if (SvTAINTED(sstr))
4398 =for apidoc sv_setsv_mg
4400 Like C<sv_setsv>, but also handles 'set' magic.
4406 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4408 PERL_ARGS_ASSERT_SV_SETSV_MG;
4410 sv_setsv(dstr,sstr);
4414 #ifdef PERL_OLD_COPY_ON_WRITE
4416 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4418 STRLEN cur = SvCUR(sstr);
4419 STRLEN len = SvLEN(sstr);
4420 register char *new_pv;
4422 PERL_ARGS_ASSERT_SV_SETSV_COW;
4425 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4426 (void*)sstr, (void*)dstr);
4433 if (SvTHINKFIRST(dstr))
4434 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4435 else if (SvPVX_const(dstr))
4436 Safefree(SvPVX_const(dstr));
4440 SvUPGRADE(dstr, SVt_PVIV);
4442 assert (SvPOK(sstr));
4443 assert (SvPOKp(sstr));
4444 assert (!SvIOK(sstr));
4445 assert (!SvIOKp(sstr));
4446 assert (!SvNOK(sstr));
4447 assert (!SvNOKp(sstr));
4449 if (SvIsCOW(sstr)) {
4451 if (SvLEN(sstr) == 0) {
4452 /* source is a COW shared hash key. */
4453 DEBUG_C(PerlIO_printf(Perl_debug_log,
4454 "Fast copy on write: Sharing hash\n"));
4455 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4458 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4460 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4461 SvUPGRADE(sstr, SVt_PVIV);
4462 SvREADONLY_on(sstr);
4464 DEBUG_C(PerlIO_printf(Perl_debug_log,
4465 "Fast copy on write: Converting sstr to COW\n"));
4466 SV_COW_NEXT_SV_SET(dstr, sstr);
4468 SV_COW_NEXT_SV_SET(sstr, dstr);
4469 new_pv = SvPVX_mutable(sstr);
4472 SvPV_set(dstr, new_pv);
4473 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4476 SvLEN_set(dstr, len);
4477 SvCUR_set(dstr, cur);
4486 =for apidoc sv_setpvn
4488 Copies a string into an SV. The C<len> parameter indicates the number of
4489 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4490 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4496 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4499 register char *dptr;
4501 PERL_ARGS_ASSERT_SV_SETPVN;
4503 SV_CHECK_THINKFIRST_COW_DROP(sv);
4509 /* len is STRLEN which is unsigned, need to copy to signed */
4512 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4514 SvUPGRADE(sv, SVt_PV);
4516 dptr = SvGROW(sv, len + 1);
4517 Move(ptr,dptr,len,char);
4520 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4525 =for apidoc sv_setpvn_mg
4527 Like C<sv_setpvn>, but also handles 'set' magic.
4533 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4535 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4537 sv_setpvn(sv,ptr,len);
4542 =for apidoc sv_setpv
4544 Copies a string into an SV. The string must be null-terminated. Does not
4545 handle 'set' magic. See C<sv_setpv_mg>.
4551 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4554 register STRLEN len;
4556 PERL_ARGS_ASSERT_SV_SETPV;
4558 SV_CHECK_THINKFIRST_COW_DROP(sv);
4564 SvUPGRADE(sv, SVt_PV);
4566 SvGROW(sv, len + 1);
4567 Move(ptr,SvPVX(sv),len+1,char);
4569 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4574 =for apidoc sv_setpv_mg
4576 Like C<sv_setpv>, but also handles 'set' magic.
4582 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4584 PERL_ARGS_ASSERT_SV_SETPV_MG;
4591 =for apidoc sv_usepvn_flags
4593 Tells an SV to use C<ptr> to find its string value. Normally the
4594 string is stored inside the SV but sv_usepvn allows the SV to use an
4595 outside string. The C<ptr> should point to memory that was allocated
4596 by C<malloc>. The string length, C<len>, must be supplied. By default
4597 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4598 so that pointer should not be freed or used by the programmer after
4599 giving it to sv_usepvn, and neither should any pointers from "behind"
4600 that pointer (e.g. ptr + 1) be used.
4602 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4603 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4604 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4605 C<len>, and already meets the requirements for storing in C<SvPVX>)
4611 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4616 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4618 SV_CHECK_THINKFIRST_COW_DROP(sv);
4619 SvUPGRADE(sv, SVt_PV);
4622 if (flags & SV_SMAGIC)
4626 if (SvPVX_const(sv))
4630 if (flags & SV_HAS_TRAILING_NUL)
4631 assert(ptr[len] == '\0');
4634 allocate = (flags & SV_HAS_TRAILING_NUL)
4636 #ifdef Perl_safesysmalloc_size
4639 PERL_STRLEN_ROUNDUP(len + 1);
4641 if (flags & SV_HAS_TRAILING_NUL) {
4642 /* It's long enough - do nothing.
4643 Specifically Perl_newCONSTSUB is relying on this. */
4646 /* Force a move to shake out bugs in callers. */
4647 char *new_ptr = (char*)safemalloc(allocate);
4648 Copy(ptr, new_ptr, len, char);
4649 PoisonFree(ptr,len,char);
4653 ptr = (char*) saferealloc (ptr, allocate);
4656 #ifdef Perl_safesysmalloc_size
4657 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4659 SvLEN_set(sv, allocate);
4663 if (!(flags & SV_HAS_TRAILING_NUL)) {
4666 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4668 if (flags & SV_SMAGIC)
4672 #ifdef PERL_OLD_COPY_ON_WRITE
4673 /* Need to do this *after* making the SV normal, as we need the buffer
4674 pointer to remain valid until after we've copied it. If we let go too early,
4675 another thread could invalidate it by unsharing last of the same hash key
4676 (which it can do by means other than releasing copy-on-write Svs)
4677 or by changing the other copy-on-write SVs in the loop. */
4679 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4681 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4683 { /* this SV was SvIsCOW_normal(sv) */
4684 /* we need to find the SV pointing to us. */
4685 SV *current = SV_COW_NEXT_SV(after);
4687 if (current == sv) {
4688 /* The SV we point to points back to us (there were only two of us
4690 Hence other SV is no longer copy on write either. */
4692 SvREADONLY_off(after);
4694 /* We need to follow the pointers around the loop. */
4696 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4699 /* don't loop forever if the structure is bust, and we have
4700 a pointer into a closed loop. */
4701 assert (current != after);
4702 assert (SvPVX_const(current) == pvx);
4704 /* Make the SV before us point to the SV after us. */
4705 SV_COW_NEXT_SV_SET(current, after);
4711 =for apidoc sv_force_normal_flags
4713 Undo various types of fakery on an SV: if the PV is a shared string, make
4714 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4715 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4716 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4717 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4718 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4719 set to some other value.) In addition, the C<flags> parameter gets passed to
4720 C<sv_unref_flags()> when unreffing. C<sv_force_normal> calls this function
4721 with flags set to 0.
4727 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4731 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4733 #ifdef PERL_OLD_COPY_ON_WRITE
4734 if (SvREADONLY(sv)) {
4736 const char * const pvx = SvPVX_const(sv);
4737 const STRLEN len = SvLEN(sv);
4738 const STRLEN cur = SvCUR(sv);
4739 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4740 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4741 we'll fail an assertion. */
4742 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4745 PerlIO_printf(Perl_debug_log,
4746 "Copy on write: Force normal %ld\n",
4752 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4755 if (flags & SV_COW_DROP_PV) {
4756 /* OK, so we don't need to copy our buffer. */
4759 SvGROW(sv, cur + 1);
4760 Move(pvx,SvPVX(sv),cur,char);
4765 sv_release_COW(sv, pvx, next);
4767 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4773 else if (IN_PERL_RUNTIME)
4774 Perl_croak_no_modify(aTHX);
4777 if (SvREADONLY(sv)) {
4779 const char * const pvx = SvPVX_const(sv);
4780 const STRLEN len = SvCUR(sv);
4785 SvGROW(sv, len + 1);
4786 Move(pvx,SvPVX(sv),len,char);
4788 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4790 else if (IN_PERL_RUNTIME)
4791 Perl_croak_no_modify(aTHX);
4795 sv_unref_flags(sv, flags);
4796 else if (SvFAKE(sv) && isGV_with_GP(sv))
4798 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4799 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4800 to sv_unglob. We only need it here, so inline it. */
4801 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4802 SV *const temp = newSV_type(new_type);
4803 void *const temp_p = SvANY(sv);
4805 if (new_type == SVt_PVMG) {
4806 SvMAGIC_set(temp, SvMAGIC(sv));
4807 SvMAGIC_set(sv, NULL);
4808 SvSTASH_set(temp, SvSTASH(sv));
4809 SvSTASH_set(sv, NULL);
4811 SvCUR_set(temp, SvCUR(sv));
4812 /* Remember that SvPVX is in the head, not the body. */
4814 SvLEN_set(temp, SvLEN(sv));
4815 /* This signals "buffer is owned by someone else" in sv_clear,
4816 which is the least effort way to stop it freeing the buffer.
4818 SvLEN_set(sv, SvLEN(sv)+1);
4820 /* Their buffer is already owned by someone else. */
4821 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4822 SvLEN_set(temp, SvCUR(sv)+1);
4825 /* Now swap the rest of the bodies. */
4827 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4828 SvFLAGS(sv) |= new_type;
4829 SvANY(sv) = SvANY(temp);
4831 SvFLAGS(temp) &= ~(SVTYPEMASK);
4832 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4833 SvANY(temp) = temp_p;
4842 Efficient removal of characters from the beginning of the string buffer.
4843 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4844 the string buffer. The C<ptr> becomes the first character of the adjusted
4845 string. Uses the "OOK hack".
4846 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4847 refer to the same chunk of data.
4853 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4859 const U8 *real_start;
4863 PERL_ARGS_ASSERT_SV_CHOP;
4865 if (!ptr || !SvPOKp(sv))
4867 delta = ptr - SvPVX_const(sv);
4869 /* Nothing to do. */
4872 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4873 nothing uses the value of ptr any more. */
4874 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4875 if (ptr <= SvPVX_const(sv))
4876 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4877 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4878 SV_CHECK_THINKFIRST(sv);
4879 if (delta > max_delta)
4880 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4881 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4882 SvPVX_const(sv) + max_delta);
4885 if (!SvLEN(sv)) { /* make copy of shared string */
4886 const char *pvx = SvPVX_const(sv);
4887 const STRLEN len = SvCUR(sv);
4888 SvGROW(sv, len + 1);
4889 Move(pvx,SvPVX(sv),len,char);
4892 SvFLAGS(sv) |= SVf_OOK;
4895 SvOOK_offset(sv, old_delta);
4897 SvLEN_set(sv, SvLEN(sv) - delta);
4898 SvCUR_set(sv, SvCUR(sv) - delta);
4899 SvPV_set(sv, SvPVX(sv) + delta);
4901 p = (U8 *)SvPVX_const(sv);
4906 real_start = p - delta;
4910 if (delta < 0x100) {
4914 p -= sizeof(STRLEN);
4915 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4919 /* Fill the preceding buffer with sentinals to verify that no-one is
4921 while (p > real_start) {
4929 =for apidoc sv_catpvn
4931 Concatenates the string onto the end of the string which is in the SV. The
4932 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4933 status set, then the bytes appended should be valid UTF-8.
4934 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4936 =for apidoc sv_catpvn_flags
4938 Concatenates the string onto the end of the string which is in the SV. The
4939 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4940 status set, then the bytes appended should be valid UTF-8.
4941 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4942 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4943 in terms of this function.
4949 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4953 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4955 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4957 SvGROW(dsv, dlen + slen + 1);
4959 sstr = SvPVX_const(dsv);
4960 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4961 SvCUR_set(dsv, SvCUR(dsv) + slen);
4963 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4965 if (flags & SV_SMAGIC)
4970 =for apidoc sv_catsv
4972 Concatenates the string from SV C<ssv> onto the end of the string in
4973 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4974 not 'set' magic. See C<sv_catsv_mg>.
4976 =for apidoc sv_catsv_flags
4978 Concatenates the string from SV C<ssv> onto the end of the string in
4979 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4980 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4981 and C<sv_catsv_nomg> are implemented in terms of this function.
4986 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4990 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4994 const char *spv = SvPV_flags_const(ssv, slen, flags);
4996 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4997 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4998 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4999 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5000 dsv->sv_flags doesn't have that bit set.
5001 Andy Dougherty 12 Oct 2001
5003 const I32 sutf8 = DO_UTF8(ssv);
5006 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5008 dutf8 = DO_UTF8(dsv);
5010 if (dutf8 != sutf8) {
5012 /* Not modifying source SV, so taking a temporary copy. */
5013 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
5015 sv_utf8_upgrade(csv);
5016 spv = SvPV_const(csv, slen);
5019 /* Leave enough space for the cat that's about to happen */
5020 sv_utf8_upgrade_flags_grow(dsv, 0, slen);
5022 sv_catpvn_nomg(dsv, spv, slen);
5025 if (flags & SV_SMAGIC)
5030 =for apidoc sv_catpv
5032 Concatenates the string onto the end of the string which is in the SV.
5033 If the SV has the UTF-8 status set, then the bytes appended should be
5034 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5039 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
5042 register STRLEN len;
5046 PERL_ARGS_ASSERT_SV_CATPV;
5050 junk = SvPV_force(sv, tlen);
5052 SvGROW(sv, tlen + len + 1);
5054 ptr = SvPVX_const(sv);
5055 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5056 SvCUR_set(sv, SvCUR(sv) + len);
5057 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5062 =for apidoc sv_catpv_flags
5064 Concatenates the string onto the end of the string which is in the SV.
5065 If the SV has the UTF-8 status set, then the bytes appended should
5066 be valid UTF-8. If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get>
5067 on the SVs if appropriate, else not.
5073 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5075 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5076 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5080 =for apidoc sv_catpv_mg
5082 Like C<sv_catpv>, but also handles 'set' magic.
5088 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5090 PERL_ARGS_ASSERT_SV_CATPV_MG;
5099 Creates a new SV. A non-zero C<len> parameter indicates the number of
5100 bytes of preallocated string space the SV should have. An extra byte for a
5101 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5102 space is allocated.) The reference count for the new SV is set to 1.
5104 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5105 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5106 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5107 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5108 modules supporting older perls.
5114 Perl_newSV(pTHX_ const STRLEN len)
5121 sv_upgrade(sv, SVt_PV);
5122 SvGROW(sv, len + 1);
5127 =for apidoc sv_magicext
5129 Adds magic to an SV, upgrading it if necessary. Applies the
5130 supplied vtable and returns a pointer to the magic added.
5132 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5133 In particular, you can add magic to SvREADONLY SVs, and add more than
5134 one instance of the same 'how'.
5136 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5137 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5138 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5139 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5141 (This is now used as a subroutine by C<sv_magic>.)
5146 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5147 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5152 PERL_ARGS_ASSERT_SV_MAGICEXT;
5154 SvUPGRADE(sv, SVt_PVMG);
5155 Newxz(mg, 1, MAGIC);
5156 mg->mg_moremagic = SvMAGIC(sv);
5157 SvMAGIC_set(sv, mg);
5159 /* Sometimes a magic contains a reference loop, where the sv and
5160 object refer to each other. To prevent a reference loop that
5161 would prevent such objects being freed, we look for such loops
5162 and if we find one we avoid incrementing the object refcount.
5164 Note we cannot do this to avoid self-tie loops as intervening RV must
5165 have its REFCNT incremented to keep it in existence.
5168 if (!obj || obj == sv ||
5169 how == PERL_MAGIC_arylen ||
5170 how == PERL_MAGIC_symtab ||
5171 (SvTYPE(obj) == SVt_PVGV &&
5172 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5173 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5174 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5179 mg->mg_obj = SvREFCNT_inc_simple(obj);
5180 mg->mg_flags |= MGf_REFCOUNTED;
5183 /* Normal self-ties simply pass a null object, and instead of
5184 using mg_obj directly, use the SvTIED_obj macro to produce a
5185 new RV as needed. For glob "self-ties", we are tieing the PVIO
5186 with an RV obj pointing to the glob containing the PVIO. In
5187 this case, to avoid a reference loop, we need to weaken the
5191 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5192 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5198 mg->mg_len = namlen;
5201 mg->mg_ptr = savepvn(name, namlen);
5202 else if (namlen == HEf_SVKEY) {
5203 /* Yes, this is casting away const. This is only for the case of
5204 HEf_SVKEY. I think we need to document this aberation of the
5205 constness of the API, rather than making name non-const, as
5206 that change propagating outwards a long way. */
5207 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5209 mg->mg_ptr = (char *) name;
5211 mg->mg_virtual = (MGVTBL *) vtable;
5215 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5220 =for apidoc sv_magic
5222 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5223 then adds a new magic item of type C<how> to the head of the magic list.
5225 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5226 handling of the C<name> and C<namlen> arguments.
5228 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5229 to add more than one instance of the same 'how'.
5235 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5236 const char *const name, const I32 namlen)
5239 const MGVTBL *vtable;
5242 PERL_ARGS_ASSERT_SV_MAGIC;
5244 #ifdef PERL_OLD_COPY_ON_WRITE
5246 sv_force_normal_flags(sv, 0);
5248 if (SvREADONLY(sv)) {
5250 /* its okay to attach magic to shared strings; the subsequent
5251 * upgrade to PVMG will unshare the string */
5252 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5255 && how != PERL_MAGIC_regex_global
5256 && how != PERL_MAGIC_bm
5257 && how != PERL_MAGIC_fm
5258 && how != PERL_MAGIC_sv
5259 && how != PERL_MAGIC_backref
5262 Perl_croak_no_modify(aTHX);
5265 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5266 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5267 /* sv_magic() refuses to add a magic of the same 'how' as an
5270 if (how == PERL_MAGIC_taint) {
5272 /* Any scalar which already had taint magic on which someone
5273 (erroneously?) did SvIOK_on() or similar will now be
5274 incorrectly sporting public "OK" flags. */
5275 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5283 vtable = &PL_vtbl_sv;
5285 case PERL_MAGIC_overload:
5286 vtable = &PL_vtbl_amagic;
5288 case PERL_MAGIC_overload_elem:
5289 vtable = &PL_vtbl_amagicelem;
5291 case PERL_MAGIC_overload_table:
5292 vtable = &PL_vtbl_ovrld;
5295 vtable = &PL_vtbl_bm;
5297 case PERL_MAGIC_regdata:
5298 vtable = &PL_vtbl_regdata;
5300 case PERL_MAGIC_regdatum:
5301 vtable = &PL_vtbl_regdatum;
5303 case PERL_MAGIC_env:
5304 vtable = &PL_vtbl_env;
5307 vtable = &PL_vtbl_fm;
5309 case PERL_MAGIC_envelem:
5310 vtable = &PL_vtbl_envelem;
5312 case PERL_MAGIC_regex_global:
5313 vtable = &PL_vtbl_mglob;
5315 case PERL_MAGIC_isa:
5316 vtable = &PL_vtbl_isa;
5318 case PERL_MAGIC_isaelem:
5319 vtable = &PL_vtbl_isaelem;
5321 case PERL_MAGIC_nkeys:
5322 vtable = &PL_vtbl_nkeys;
5324 case PERL_MAGIC_dbfile:
5327 case PERL_MAGIC_dbline:
5328 vtable = &PL_vtbl_dbline;
5330 #ifdef USE_LOCALE_COLLATE
5331 case PERL_MAGIC_collxfrm:
5332 vtable = &PL_vtbl_collxfrm;
5334 #endif /* USE_LOCALE_COLLATE */
5335 case PERL_MAGIC_tied:
5336 vtable = &PL_vtbl_pack;
5338 case PERL_MAGIC_tiedelem:
5339 case PERL_MAGIC_tiedscalar:
5340 vtable = &PL_vtbl_packelem;
5343 vtable = &PL_vtbl_regexp;
5345 case PERL_MAGIC_sig:
5346 vtable = &PL_vtbl_sig;
5348 case PERL_MAGIC_sigelem:
5349 vtable = &PL_vtbl_sigelem;
5351 case PERL_MAGIC_taint:
5352 vtable = &PL_vtbl_taint;
5354 case PERL_MAGIC_uvar:
5355 vtable = &PL_vtbl_uvar;
5357 case PERL_MAGIC_vec:
5358 vtable = &PL_vtbl_vec;
5360 case PERL_MAGIC_arylen_p:
5361 case PERL_MAGIC_rhash:
5362 case PERL_MAGIC_symtab:
5363 case PERL_MAGIC_vstring:
5364 case PERL_MAGIC_checkcall:
5367 case PERL_MAGIC_utf8:
5368 vtable = &PL_vtbl_utf8;
5370 case PERL_MAGIC_substr:
5371 vtable = &PL_vtbl_substr;
5373 case PERL_MAGIC_defelem:
5374 vtable = &PL_vtbl_defelem;
5376 case PERL_MAGIC_arylen:
5377 vtable = &PL_vtbl_arylen;
5379 case PERL_MAGIC_pos:
5380 vtable = &PL_vtbl_pos;
5382 case PERL_MAGIC_backref:
5383 vtable = &PL_vtbl_backref;
5385 case PERL_MAGIC_hintselem:
5386 vtable = &PL_vtbl_hintselem;
5388 case PERL_MAGIC_hints:
5389 vtable = &PL_vtbl_hints;
5391 case PERL_MAGIC_ext:
5392 /* Reserved for use by extensions not perl internals. */
5393 /* Useful for attaching extension internal data to perl vars. */
5394 /* Note that multiple extensions may clash if magical scalars */
5395 /* etc holding private data from one are passed to another. */
5399 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5402 /* Rest of work is done else where */
5403 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5406 case PERL_MAGIC_taint:
5409 case PERL_MAGIC_ext:
5410 case PERL_MAGIC_dbfile:
5417 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5424 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5426 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5427 for (mg = *mgp; mg; mg = *mgp) {
5428 const MGVTBL* const virt = mg->mg_virtual;
5429 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5430 *mgp = mg->mg_moremagic;
5431 if (virt && virt->svt_free)
5432 virt->svt_free(aTHX_ sv, mg);
5433 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5435 Safefree(mg->mg_ptr);
5436 else if (mg->mg_len == HEf_SVKEY)
5437 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5438 else if (mg->mg_type == PERL_MAGIC_utf8)
5439 Safefree(mg->mg_ptr);
5441 if (mg->mg_flags & MGf_REFCOUNTED)
5442 SvREFCNT_dec(mg->mg_obj);
5446 mgp = &mg->mg_moremagic;
5449 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5450 mg_magical(sv); /* else fix the flags now */
5454 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5460 =for apidoc sv_unmagic
5462 Removes all magic of type C<type> from an SV.
5468 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5470 PERL_ARGS_ASSERT_SV_UNMAGIC;
5471 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5475 =for apidoc sv_unmagicext
5477 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5483 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5485 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5486 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5490 =for apidoc sv_rvweaken
5492 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5493 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5494 push a back-reference to this RV onto the array of backreferences
5495 associated with that magic. If the RV is magical, set magic will be
5496 called after the RV is cleared.
5502 Perl_sv_rvweaken(pTHX_ SV *const sv)
5506 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5508 if (!SvOK(sv)) /* let undefs pass */
5511 Perl_croak(aTHX_ "Can't weaken a nonreference");
5512 else if (SvWEAKREF(sv)) {
5513 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5517 Perl_sv_add_backref(aTHX_ tsv, sv);
5523 /* Give tsv backref magic if it hasn't already got it, then push a
5524 * back-reference to sv onto the array associated with the backref magic.
5526 * As an optimisation, if there's only one backref and it's not an AV,
5527 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5528 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5531 * If an HV's backref is stored in magic, it is moved back to HvAUX.
5534 /* A discussion about the backreferences array and its refcount:
5536 * The AV holding the backreferences is pointed to either as the mg_obj of
5537 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5538 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5539 * have the standard magic instead.) The array is created with a refcount
5540 * of 2. This means that if during global destruction the array gets
5541 * picked on before its parent to have its refcount decremented by the
5542 * random zapper, it won't actually be freed, meaning it's still there for
5543 * when its parent gets freed.
5545 * When the parent SV is freed, the extra ref is killed by
5546 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5547 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5549 * When a single backref SV is stored directly, it is not reference
5554 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5561 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5563 /* find slot to store array or singleton backref */
5565 if (SvTYPE(tsv) == SVt_PVHV) {
5566 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5569 if ((mg = mg_find(tsv, PERL_MAGIC_backref))) {
5570 /* Aha. They've got it stowed in magic instead.
5571 * Move it back to xhv_backreferences */
5573 /* Stop mg_free decreasing the reference count. */
5575 /* Stop mg_free even calling the destructor, given that
5576 there's no AV to free up. */
5578 sv_unmagic(tsv, PERL_MAGIC_backref);
5584 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5586 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5587 mg = mg_find(tsv, PERL_MAGIC_backref);
5589 svp = &(mg->mg_obj);
5592 /* create or retrieve the array */
5594 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5595 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5600 SvREFCNT_inc_simple_void(av);
5601 /* av now has a refcnt of 2; see discussion above */
5603 /* move single existing backref to the array */
5605 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5609 mg->mg_flags |= MGf_REFCOUNTED;
5612 av = MUTABLE_AV(*svp);
5615 /* optimisation: store single backref directly in HvAUX or mg_obj */
5619 /* push new backref */
5620 assert(SvTYPE(av) == SVt_PVAV);
5621 if (AvFILLp(av) >= AvMAX(av)) {
5622 av_extend(av, AvFILLp(av)+1);
5624 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5627 /* delete a back-reference to ourselves from the backref magic associated
5628 * with the SV we point to.
5632 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5637 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5639 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5640 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5642 if (!svp || !*svp) {
5644 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5645 svp = mg ? &(mg->mg_obj) : NULL;
5649 Perl_croak(aTHX_ "panic: del_backref");
5651 if (SvTYPE(*svp) == SVt_PVAV) {
5655 AV * const av = (AV*)*svp;
5657 assert(!SvIS_FREED(av));
5661 /* for an SV with N weak references to it, if all those
5662 * weak refs are deleted, then sv_del_backref will be called
5663 * N times and O(N^2) compares will be done within the backref
5664 * array. To ameliorate this potential slowness, we:
5665 * 1) make sure this code is as tight as possible;
5666 * 2) when looking for SV, look for it at both the head and tail of the
5667 * array first before searching the rest, since some create/destroy
5668 * patterns will cause the backrefs to be freed in order.
5675 SV **p = &svp[fill];
5676 SV *const topsv = *p;
5683 /* We weren't the last entry.
5684 An unordered list has this property that you
5685 can take the last element off the end to fill
5686 the hole, and it's still an unordered list :-)
5692 break; /* should only be one */
5699 AvFILLp(av) = fill-1;
5702 /* optimisation: only a single backref, stored directly */
5704 Perl_croak(aTHX_ "panic: del_backref");
5711 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5717 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5722 is_array = (SvTYPE(av) == SVt_PVAV);
5724 assert(!SvIS_FREED(av));
5727 last = svp + AvFILLp(av);
5730 /* optimisation: only a single backref, stored directly */
5736 while (svp <= last) {
5738 SV *const referrer = *svp;
5739 if (SvWEAKREF(referrer)) {
5740 /* XXX Should we check that it hasn't changed? */
5741 assert(SvROK(referrer));
5742 SvRV_set(referrer, 0);
5744 SvWEAKREF_off(referrer);
5745 SvSETMAGIC(referrer);
5746 } else if (SvTYPE(referrer) == SVt_PVGV ||
5747 SvTYPE(referrer) == SVt_PVLV) {
5748 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5749 /* You lookin' at me? */
5750 assert(GvSTASH(referrer));
5751 assert(GvSTASH(referrer) == (const HV *)sv);
5752 GvSTASH(referrer) = 0;
5753 } else if (SvTYPE(referrer) == SVt_PVCV ||
5754 SvTYPE(referrer) == SVt_PVFM) {
5755 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5756 /* You lookin' at me? */
5757 assert(CvSTASH(referrer));
5758 assert(CvSTASH(referrer) == (const HV *)sv);
5759 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5762 assert(SvTYPE(sv) == SVt_PVGV);
5763 /* You lookin' at me? */
5764 assert(CvGV(referrer));
5765 assert(CvGV(referrer) == (const GV *)sv);
5766 anonymise_cv_maybe(MUTABLE_GV(sv),
5767 MUTABLE_CV(referrer));
5772 "panic: magic_killbackrefs (flags=%"UVxf")",
5773 (UV)SvFLAGS(referrer));
5784 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5790 =for apidoc sv_insert
5792 Inserts a string at the specified offset/length within the SV. Similar to
5793 the Perl substr() function. Handles get magic.
5795 =for apidoc sv_insert_flags
5797 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5803 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5808 register char *midend;
5809 register char *bigend;
5813 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5816 Perl_croak(aTHX_ "Can't modify non-existent substring");
5817 SvPV_force_flags(bigstr, curlen, flags);
5818 (void)SvPOK_only_UTF8(bigstr);
5819 if (offset + len > curlen) {
5820 SvGROW(bigstr, offset+len+1);
5821 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5822 SvCUR_set(bigstr, offset+len);
5826 i = littlelen - len;
5827 if (i > 0) { /* string might grow */
5828 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5829 mid = big + offset + len;
5830 midend = bigend = big + SvCUR(bigstr);
5833 while (midend > mid) /* shove everything down */
5834 *--bigend = *--midend;
5835 Move(little,big+offset,littlelen,char);
5836 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5841 Move(little,SvPVX(bigstr)+offset,len,char);
5846 big = SvPVX(bigstr);
5849 bigend = big + SvCUR(bigstr);
5851 if (midend > bigend)
5852 Perl_croak(aTHX_ "panic: sv_insert");
5854 if (mid - big > bigend - midend) { /* faster to shorten from end */
5856 Move(little, mid, littlelen,char);
5859 i = bigend - midend;
5861 Move(midend, mid, i,char);
5865 SvCUR_set(bigstr, mid - big);
5867 else if ((i = mid - big)) { /* faster from front */
5868 midend -= littlelen;
5870 Move(big, midend - i, i, char);
5871 sv_chop(bigstr,midend-i);
5873 Move(little, mid, littlelen,char);
5875 else if (littlelen) {
5876 midend -= littlelen;
5877 sv_chop(bigstr,midend);
5878 Move(little,midend,littlelen,char);
5881 sv_chop(bigstr,midend);
5887 =for apidoc sv_replace
5889 Make the first argument a copy of the second, then delete the original.
5890 The target SV physically takes over ownership of the body of the source SV
5891 and inherits its flags; however, the target keeps any magic it owns,
5892 and any magic in the source is discarded.
5893 Note that this is a rather specialist SV copying operation; most of the
5894 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5900 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5903 const U32 refcnt = SvREFCNT(sv);
5905 PERL_ARGS_ASSERT_SV_REPLACE;
5907 SV_CHECK_THINKFIRST_COW_DROP(sv);
5908 if (SvREFCNT(nsv) != 1) {
5909 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5910 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5912 if (SvMAGICAL(sv)) {
5916 sv_upgrade(nsv, SVt_PVMG);
5917 SvMAGIC_set(nsv, SvMAGIC(sv));
5918 SvFLAGS(nsv) |= SvMAGICAL(sv);
5920 SvMAGIC_set(sv, NULL);
5924 assert(!SvREFCNT(sv));
5925 #ifdef DEBUG_LEAKING_SCALARS
5926 sv->sv_flags = nsv->sv_flags;
5927 sv->sv_any = nsv->sv_any;
5928 sv->sv_refcnt = nsv->sv_refcnt;
5929 sv->sv_u = nsv->sv_u;
5931 StructCopy(nsv,sv,SV);
5933 if(SvTYPE(sv) == SVt_IV) {
5935 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5939 #ifdef PERL_OLD_COPY_ON_WRITE
5940 if (SvIsCOW_normal(nsv)) {
5941 /* We need to follow the pointers around the loop to make the
5942 previous SV point to sv, rather than nsv. */
5945 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5948 assert(SvPVX_const(current) == SvPVX_const(nsv));
5950 /* Make the SV before us point to the SV after us. */
5952 PerlIO_printf(Perl_debug_log, "previous is\n");
5954 PerlIO_printf(Perl_debug_log,
5955 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5956 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5958 SV_COW_NEXT_SV_SET(current, sv);
5961 SvREFCNT(sv) = refcnt;
5962 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5967 /* We're about to free a GV which has a CV that refers back to us.
5968 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5972 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5978 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5981 assert(SvREFCNT(gv) == 0);
5982 assert(isGV(gv) && isGV_with_GP(gv));
5984 assert(!CvANON(cv));
5985 assert(CvGV(cv) == gv);
5987 /* will the CV shortly be freed by gp_free() ? */
5988 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5989 SvANY(cv)->xcv_gv = NULL;
5993 /* if not, anonymise: */
5994 stash = GvSTASH(gv) ? HvNAME(GvSTASH(gv)) : NULL;
5995 gvname = Perl_newSVpvf(aTHX_ "%s::__ANON__",
5996 stash ? stash : "__ANON__");
5997 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5998 SvREFCNT_dec(gvname);
6002 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
6007 =for apidoc sv_clear
6009 Clear an SV: call any destructors, free up any memory used by the body,
6010 and free the body itself. The SV's head is I<not> freed, although
6011 its type is set to all 1's so that it won't inadvertently be assumed
6012 to be live during global destruction etc.
6013 This function should only be called when REFCNT is zero. Most of the time
6014 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
6021 Perl_sv_clear(pTHX_ SV *const orig_sv)
6026 const struct body_details *sv_type_details;
6029 register SV *sv = orig_sv;
6031 PERL_ARGS_ASSERT_SV_CLEAR;
6033 /* within this loop, sv is the SV currently being freed, and
6034 * iter_sv is the most recent AV or whatever that's being iterated
6035 * over to provide more SVs */
6041 assert(SvREFCNT(sv) == 0);
6042 assert(SvTYPE(sv) != SVTYPEMASK);
6044 if (type <= SVt_IV) {
6045 /* See the comment in sv.h about the collusion between this
6046 * early return and the overloading of the NULL slots in the
6050 SvFLAGS(sv) &= SVf_BREAK;
6051 SvFLAGS(sv) |= SVTYPEMASK;
6056 if (!curse(sv, 1)) goto get_next_sv;
6058 if (type >= SVt_PVMG) {
6059 /* Free back-references before magic, in case the magic calls
6060 * Perl code that has weak references to sv. */
6061 if (type == SVt_PVHV)
6062 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6063 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6064 SvREFCNT_dec(SvOURSTASH(sv));
6065 } else if (SvMAGIC(sv)) {
6066 /* Free back-references before other types of magic. */
6067 sv_unmagic(sv, PERL_MAGIC_backref);
6070 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6071 SvREFCNT_dec(SvSTASH(sv));
6074 /* case SVt_BIND: */
6077 IoIFP(sv) != PerlIO_stdin() &&
6078 IoIFP(sv) != PerlIO_stdout() &&
6079 IoIFP(sv) != PerlIO_stderr() &&
6080 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6082 io_close(MUTABLE_IO(sv), FALSE);
6084 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6085 PerlDir_close(IoDIRP(sv));
6086 IoDIRP(sv) = (DIR*)NULL;
6087 Safefree(IoTOP_NAME(sv));
6088 Safefree(IoFMT_NAME(sv));
6089 Safefree(IoBOTTOM_NAME(sv));
6092 /* FIXME for plugins */
6093 pregfree2((REGEXP*) sv);
6097 cv_undef(MUTABLE_CV(sv));
6098 /* If we're in a stash, we don't own a reference to it.
6099 * However it does have a back reference to us, which needs to
6101 if ((stash = CvSTASH(sv)))
6102 sv_del_backref(MUTABLE_SV(stash), sv);
6105 if (PL_last_swash_hv == (const HV *)sv) {
6106 PL_last_swash_hv = NULL;
6108 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6112 AV* av = MUTABLE_AV(sv);
6113 if (PL_comppad == av) {
6117 if (AvREAL(av) && AvFILLp(av) > -1) {
6118 next_sv = AvARRAY(av)[AvFILLp(av)--];
6119 /* save old iter_sv in top-most slot of AV,
6120 * and pray that it doesn't get wiped in the meantime */
6121 AvARRAY(av)[AvMAX(av)] = iter_sv;
6123 goto get_next_sv; /* process this new sv */
6125 Safefree(AvALLOC(av));
6130 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6131 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6132 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6133 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6135 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6136 SvREFCNT_dec(LvTARG(sv));
6138 if (isGV_with_GP(sv)) {
6139 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6140 && HvENAME_get(stash))
6141 mro_method_changed_in(stash);
6142 gp_free(MUTABLE_GV(sv));
6144 unshare_hek(GvNAME_HEK(sv));
6145 /* If we're in a stash, we don't own a reference to it.
6146 * However it does have a back reference to us, which
6147 * needs to be cleared. */
6148 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6149 sv_del_backref(MUTABLE_SV(stash), sv);
6151 /* FIXME. There are probably more unreferenced pointers to SVs
6152 * in the interpreter struct that we should check and tidy in
6153 * a similar fashion to this: */
6154 if ((const GV *)sv == PL_last_in_gv)
6155 PL_last_in_gv = NULL;
6161 /* Don't bother with SvOOK_off(sv); as we're only going to
6165 SvOOK_offset(sv, offset);
6166 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6167 /* Don't even bother with turning off the OOK flag. */
6172 SV * const target = SvRV(sv);
6174 sv_del_backref(target, sv);
6179 #ifdef PERL_OLD_COPY_ON_WRITE
6180 else if (SvPVX_const(sv)
6181 && !(SvTYPE(sv) == SVt_PVIO
6182 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6186 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6190 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6192 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6196 } else if (SvLEN(sv)) {
6197 Safefree(SvPVX_const(sv));
6201 else if (SvPVX_const(sv) && SvLEN(sv)
6202 && !(SvTYPE(sv) == SVt_PVIO
6203 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6204 Safefree(SvPVX_mutable(sv));
6205 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6206 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6217 SvFLAGS(sv) &= SVf_BREAK;
6218 SvFLAGS(sv) |= SVTYPEMASK;
6220 sv_type_details = bodies_by_type + type;
6221 if (sv_type_details->arena) {
6222 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6223 &PL_body_roots[type]);
6225 else if (sv_type_details->body_size) {
6226 safefree(SvANY(sv));
6230 /* caller is responsible for freeing the head of the original sv */
6231 if (sv != orig_sv && !SvREFCNT(sv))
6234 /* grab and free next sv, if any */
6242 else if (!iter_sv) {
6244 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6245 AV *const av = (AV*)iter_sv;
6246 if (AvFILLp(av) > -1) {
6247 sv = AvARRAY(av)[AvFILLp(av)--];
6249 else { /* no more elements of current AV to free */
6252 /* restore previous value, squirrelled away */
6253 iter_sv = AvARRAY(av)[AvMAX(av)];
6254 Safefree(AvALLOC(av));
6259 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6263 if (!SvREFCNT(sv)) {
6267 if (--(SvREFCNT(sv)))
6271 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6272 "Attempt to free temp prematurely: SV 0x%"UVxf
6273 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6277 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6278 /* make sure SvREFCNT(sv)==0 happens very seldom */
6279 SvREFCNT(sv) = (~(U32)0)/2;
6288 /* This routine curses the sv itself, not the object referenced by sv. So
6289 sv does not have to be ROK. */
6292 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6295 PERL_ARGS_ASSERT_CURSE;
6296 assert(SvOBJECT(sv));
6298 if (PL_defstash && /* Still have a symbol table? */
6305 stash = SvSTASH(sv);
6306 destructor = StashHANDLER(stash,DESTROY);
6308 /* A constant subroutine can have no side effects, so
6309 don't bother calling it. */
6310 && !CvCONST(destructor)
6311 /* Don't bother calling an empty destructor */
6312 && (CvISXSUB(destructor)
6313 || (CvSTART(destructor)
6314 && (CvSTART(destructor)->op_next->op_type
6317 SV* const tmpref = newRV(sv);
6318 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6320 PUSHSTACKi(PERLSI_DESTROY);
6325 call_sv(MUTABLE_SV(destructor),
6326 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6330 if(SvREFCNT(tmpref) < 2) {
6331 /* tmpref is not kept alive! */
6333 SvRV_set(tmpref, NULL);
6336 SvREFCNT_dec(tmpref);
6338 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6341 if (check_refcnt && SvREFCNT(sv)) {
6342 if (PL_in_clean_objs)
6344 "DESTROY created new reference to dead object '%s'",
6346 /* DESTROY gave object new lease on life */
6352 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6353 SvOBJECT_off(sv); /* Curse the object. */
6354 if (SvTYPE(sv) != SVt_PVIO)
6355 --PL_sv_objcount;/* XXX Might want something more general */
6361 =for apidoc sv_newref
6363 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6370 Perl_sv_newref(pTHX_ SV *const sv)
6372 PERL_UNUSED_CONTEXT;
6381 Decrement an SV's reference count, and if it drops to zero, call
6382 C<sv_clear> to invoke destructors and free up any memory used by
6383 the body; finally, deallocate the SV's head itself.
6384 Normally called via a wrapper macro C<SvREFCNT_dec>.
6390 Perl_sv_free(pTHX_ SV *const sv)
6395 if (SvREFCNT(sv) == 0) {
6396 if (SvFLAGS(sv) & SVf_BREAK)
6397 /* this SV's refcnt has been artificially decremented to
6398 * trigger cleanup */
6400 if (PL_in_clean_all) /* All is fair */
6402 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6403 /* make sure SvREFCNT(sv)==0 happens very seldom */
6404 SvREFCNT(sv) = (~(U32)0)/2;
6407 if (ckWARN_d(WARN_INTERNAL)) {
6408 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6409 Perl_dump_sv_child(aTHX_ sv);
6411 #ifdef DEBUG_LEAKING_SCALARS
6414 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6415 if (PL_warnhook == PERL_WARNHOOK_FATAL
6416 || ckDEAD(packWARN(WARN_INTERNAL))) {
6417 /* Don't let Perl_warner cause us to escape our fate: */
6421 /* This may not return: */
6422 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6423 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6424 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6427 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6432 if (--(SvREFCNT(sv)) > 0)
6434 Perl_sv_free2(aTHX_ sv);
6438 Perl_sv_free2(pTHX_ SV *const sv)
6442 PERL_ARGS_ASSERT_SV_FREE2;
6446 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6447 "Attempt to free temp prematurely: SV 0x%"UVxf
6448 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6452 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6453 /* make sure SvREFCNT(sv)==0 happens very seldom */
6454 SvREFCNT(sv) = (~(U32)0)/2;
6465 Returns the length of the string in the SV. Handles magic and type
6466 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6472 Perl_sv_len(pTHX_ register SV *const sv)
6480 len = mg_length(sv);
6482 (void)SvPV_const(sv, len);
6487 =for apidoc sv_len_utf8
6489 Returns the number of characters in the string in an SV, counting wide
6490 UTF-8 bytes as a single character. Handles magic and type coercion.
6496 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6497 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6498 * (Note that the mg_len is not the length of the mg_ptr field.
6499 * This allows the cache to store the character length of the string without
6500 * needing to malloc() extra storage to attach to the mg_ptr.)
6505 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6511 return mg_length(sv);
6515 const U8 *s = (U8*)SvPV_const(sv, len);
6519 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6521 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6522 if (mg->mg_len != -1)
6525 /* We can use the offset cache for a headstart.
6526 The longer value is stored in the first pair. */
6527 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6529 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6533 if (PL_utf8cache < 0) {
6534 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6535 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6539 ulen = Perl_utf8_length(aTHX_ s, s + len);
6540 utf8_mg_len_cache_update(sv, &mg, ulen);
6544 return Perl_utf8_length(aTHX_ s, s + len);
6548 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6551 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6552 STRLEN *const uoffset_p, bool *const at_end)
6554 const U8 *s = start;
6555 STRLEN uoffset = *uoffset_p;
6557 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6559 while (s < send && uoffset) {
6566 else if (s > send) {
6568 /* This is the existing behaviour. Possibly it should be a croak, as
6569 it's actually a bounds error */
6572 *uoffset_p -= uoffset;
6576 /* Given the length of the string in both bytes and UTF-8 characters, decide
6577 whether to walk forwards or backwards to find the byte corresponding to
6578 the passed in UTF-8 offset. */
6580 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6581 STRLEN uoffset, const STRLEN uend)
6583 STRLEN backw = uend - uoffset;
6585 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6587 if (uoffset < 2 * backw) {
6588 /* The assumption is that going forwards is twice the speed of going
6589 forward (that's where the 2 * backw comes from).
6590 (The real figure of course depends on the UTF-8 data.) */
6591 const U8 *s = start;
6593 while (s < send && uoffset--)
6603 while (UTF8_IS_CONTINUATION(*send))
6606 return send - start;
6609 /* For the string representation of the given scalar, find the byte
6610 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6611 give another position in the string, *before* the sought offset, which
6612 (which is always true, as 0, 0 is a valid pair of positions), which should
6613 help reduce the amount of linear searching.
6614 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6615 will be used to reduce the amount of linear searching. The cache will be
6616 created if necessary, and the found value offered to it for update. */
6618 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6619 const U8 *const send, STRLEN uoffset,
6620 STRLEN uoffset0, STRLEN boffset0)
6622 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6624 bool at_end = FALSE;
6626 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6628 assert (uoffset >= uoffset0);
6635 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6636 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6637 if ((*mgp)->mg_ptr) {
6638 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6639 if (cache[0] == uoffset) {
6640 /* An exact match. */
6643 if (cache[2] == uoffset) {
6644 /* An exact match. */
6648 if (cache[0] < uoffset) {
6649 /* The cache already knows part of the way. */
6650 if (cache[0] > uoffset0) {
6651 /* The cache knows more than the passed in pair */
6652 uoffset0 = cache[0];
6653 boffset0 = cache[1];
6655 if ((*mgp)->mg_len != -1) {
6656 /* And we know the end too. */
6658 + sv_pos_u2b_midway(start + boffset0, send,
6660 (*mgp)->mg_len - uoffset0);
6662 uoffset -= uoffset0;
6664 + sv_pos_u2b_forwards(start + boffset0,
6665 send, &uoffset, &at_end);
6666 uoffset += uoffset0;
6669 else if (cache[2] < uoffset) {
6670 /* We're between the two cache entries. */
6671 if (cache[2] > uoffset0) {
6672 /* and the cache knows more than the passed in pair */
6673 uoffset0 = cache[2];
6674 boffset0 = cache[3];
6678 + sv_pos_u2b_midway(start + boffset0,
6681 cache[0] - uoffset0);
6684 + sv_pos_u2b_midway(start + boffset0,
6687 cache[2] - uoffset0);
6691 else if ((*mgp)->mg_len != -1) {
6692 /* If we can take advantage of a passed in offset, do so. */
6693 /* In fact, offset0 is either 0, or less than offset, so don't
6694 need to worry about the other possibility. */
6696 + sv_pos_u2b_midway(start + boffset0, send,
6698 (*mgp)->mg_len - uoffset0);
6703 if (!found || PL_utf8cache < 0) {
6704 STRLEN real_boffset;
6705 uoffset -= uoffset0;
6706 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6707 send, &uoffset, &at_end);
6708 uoffset += uoffset0;
6710 if (found && PL_utf8cache < 0)
6711 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6713 boffset = real_boffset;
6718 utf8_mg_len_cache_update(sv, mgp, uoffset);
6720 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6727 =for apidoc sv_pos_u2b_flags
6729 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6730 the start of the string, to a count of the equivalent number of bytes; if
6731 lenp is non-zero, it does the same to lenp, but this time starting from
6732 the offset, rather than from the start of the string. Handles type coercion.
6733 I<flags> is passed to C<SvPV_flags>, and usually should be
6734 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6740 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6741 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6742 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6747 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6754 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6756 start = (U8*)SvPV_flags(sv, len, flags);
6758 const U8 * const send = start + len;
6760 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6763 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6764 is 0, and *lenp is already set to that. */) {
6765 /* Convert the relative offset to absolute. */
6766 const STRLEN uoffset2 = uoffset + *lenp;
6767 const STRLEN boffset2
6768 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6769 uoffset, boffset) - boffset;
6783 =for apidoc sv_pos_u2b
6785 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6786 the start of the string, to a count of the equivalent number of bytes; if
6787 lenp is non-zero, it does the same to lenp, but this time starting from
6788 the offset, rather than from the start of the string. Handles magic and
6791 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6798 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6799 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6800 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6804 /* This function is subject to size and sign problems */
6807 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6809 PERL_ARGS_ASSERT_SV_POS_U2B;
6812 STRLEN ulen = (STRLEN)*lenp;
6813 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6814 SV_GMAGIC|SV_CONST_RETURN);
6817 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6818 SV_GMAGIC|SV_CONST_RETURN);
6823 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6826 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6830 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6831 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6832 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6836 (*mgp)->mg_len = ulen;
6837 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6838 if (ulen != (STRLEN) (*mgp)->mg_len)
6839 (*mgp)->mg_len = -1;
6842 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6843 byte length pairing. The (byte) length of the total SV is passed in too,
6844 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6845 may not have updated SvCUR, so we can't rely on reading it directly.
6847 The proffered utf8/byte length pairing isn't used if the cache already has
6848 two pairs, and swapping either for the proffered pair would increase the
6849 RMS of the intervals between known byte offsets.
6851 The cache itself consists of 4 STRLEN values
6852 0: larger UTF-8 offset
6853 1: corresponding byte offset
6854 2: smaller UTF-8 offset
6855 3: corresponding byte offset
6857 Unused cache pairs have the value 0, 0.
6858 Keeping the cache "backwards" means that the invariant of
6859 cache[0] >= cache[2] is maintained even with empty slots, which means that
6860 the code that uses it doesn't need to worry if only 1 entry has actually
6861 been set to non-zero. It also makes the "position beyond the end of the
6862 cache" logic much simpler, as the first slot is always the one to start
6866 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6867 const STRLEN utf8, const STRLEN blen)
6871 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6876 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6877 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6878 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6880 (*mgp)->mg_len = -1;
6884 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6885 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6886 (*mgp)->mg_ptr = (char *) cache;
6890 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6891 /* SvPOKp() because it's possible that sv has string overloading, and
6892 therefore is a reference, hence SvPVX() is actually a pointer.
6893 This cures the (very real) symptoms of RT 69422, but I'm not actually
6894 sure whether we should even be caching the results of UTF-8
6895 operations on overloading, given that nothing stops overloading
6896 returning a different value every time it's called. */
6897 const U8 *start = (const U8 *) SvPVX_const(sv);
6898 const STRLEN realutf8 = utf8_length(start, start + byte);
6900 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6904 /* Cache is held with the later position first, to simplify the code
6905 that deals with unbounded ends. */
6907 ASSERT_UTF8_CACHE(cache);
6908 if (cache[1] == 0) {
6909 /* Cache is totally empty */
6912 } else if (cache[3] == 0) {
6913 if (byte > cache[1]) {
6914 /* New one is larger, so goes first. */
6915 cache[2] = cache[0];
6916 cache[3] = cache[1];
6924 #define THREEWAY_SQUARE(a,b,c,d) \
6925 ((float)((d) - (c))) * ((float)((d) - (c))) \
6926 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6927 + ((float)((b) - (a))) * ((float)((b) - (a)))
6929 /* Cache has 2 slots in use, and we know three potential pairs.
6930 Keep the two that give the lowest RMS distance. Do the
6931 calculation in bytes simply because we always know the byte
6932 length. squareroot has the same ordering as the positive value,
6933 so don't bother with the actual square root. */
6934 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6935 if (byte > cache[1]) {
6936 /* New position is after the existing pair of pairs. */
6937 const float keep_earlier
6938 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6939 const float keep_later
6940 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6942 if (keep_later < keep_earlier) {
6943 if (keep_later < existing) {
6944 cache[2] = cache[0];
6945 cache[3] = cache[1];
6951 if (keep_earlier < existing) {
6957 else if (byte > cache[3]) {
6958 /* New position is between the existing pair of pairs. */
6959 const float keep_earlier
6960 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6961 const float keep_later
6962 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6964 if (keep_later < keep_earlier) {
6965 if (keep_later < existing) {
6971 if (keep_earlier < existing) {
6978 /* New position is before the existing pair of pairs. */
6979 const float keep_earlier
6980 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6981 const float keep_later
6982 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6984 if (keep_later < keep_earlier) {
6985 if (keep_later < existing) {
6991 if (keep_earlier < existing) {
6992 cache[0] = cache[2];
6993 cache[1] = cache[3];
7000 ASSERT_UTF8_CACHE(cache);
7003 /* We already know all of the way, now we may be able to walk back. The same
7004 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7005 backward is half the speed of walking forward. */
7007 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7008 const U8 *end, STRLEN endu)
7010 const STRLEN forw = target - s;
7011 STRLEN backw = end - target;
7013 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7015 if (forw < 2 * backw) {
7016 return utf8_length(s, target);
7019 while (end > target) {
7021 while (UTF8_IS_CONTINUATION(*end)) {
7030 =for apidoc sv_pos_b2u
7032 Converts the value pointed to by offsetp from a count of bytes from the
7033 start of the string, to a count of the equivalent number of UTF-8 chars.
7034 Handles magic and type coercion.
7040 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7041 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7046 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
7049 const STRLEN byte = *offsetp;
7050 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7056 PERL_ARGS_ASSERT_SV_POS_B2U;
7061 s = (const U8*)SvPV_const(sv, blen);
7064 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7070 && SvTYPE(sv) >= SVt_PVMG
7071 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7074 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7075 if (cache[1] == byte) {
7076 /* An exact match. */
7077 *offsetp = cache[0];
7080 if (cache[3] == byte) {
7081 /* An exact match. */
7082 *offsetp = cache[2];
7086 if (cache[1] < byte) {
7087 /* We already know part of the way. */
7088 if (mg->mg_len != -1) {
7089 /* Actually, we know the end too. */
7091 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7092 s + blen, mg->mg_len - cache[0]);
7094 len = cache[0] + utf8_length(s + cache[1], send);
7097 else if (cache[3] < byte) {
7098 /* We're between the two cached pairs, so we do the calculation
7099 offset by the byte/utf-8 positions for the earlier pair,
7100 then add the utf-8 characters from the string start to
7102 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7103 s + cache[1], cache[0] - cache[2])
7107 else { /* cache[3] > byte */
7108 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7112 ASSERT_UTF8_CACHE(cache);
7114 } else if (mg->mg_len != -1) {
7115 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7119 if (!found || PL_utf8cache < 0) {
7120 const STRLEN real_len = utf8_length(s, send);
7122 if (found && PL_utf8cache < 0)
7123 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7130 utf8_mg_len_cache_update(sv, &mg, len);
7132 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7137 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7138 STRLEN real, SV *const sv)
7140 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7142 /* As this is debugging only code, save space by keeping this test here,
7143 rather than inlining it in all the callers. */
7144 if (from_cache == real)
7147 /* Need to turn the assertions off otherwise we may recurse infinitely
7148 while printing error messages. */
7149 SAVEI8(PL_utf8cache);
7151 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7152 func, (UV) from_cache, (UV) real, SVfARG(sv));
7158 Returns a boolean indicating whether the strings in the two SVs are
7159 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7160 coerce its args to strings if necessary.
7162 =for apidoc sv_eq_flags
7164 Returns a boolean indicating whether the strings in the two SVs are
7165 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7166 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7172 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7181 SV* svrecode = NULL;
7188 /* if pv1 and pv2 are the same, second SvPV_const call may
7189 * invalidate pv1 (if we are handling magic), so we may need to
7191 if (sv1 == sv2 && flags & SV_GMAGIC
7192 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7193 pv1 = SvPV_const(sv1, cur1);
7194 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7196 pv1 = SvPV_flags_const(sv1, cur1, flags);
7204 pv2 = SvPV_flags_const(sv2, cur2, flags);
7206 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7207 /* Differing utf8ness.
7208 * Do not UTF8size the comparands as a side-effect. */
7211 svrecode = newSVpvn(pv2, cur2);
7212 sv_recode_to_utf8(svrecode, PL_encoding);
7213 pv2 = SvPV_const(svrecode, cur2);
7216 svrecode = newSVpvn(pv1, cur1);
7217 sv_recode_to_utf8(svrecode, PL_encoding);
7218 pv1 = SvPV_const(svrecode, cur1);
7220 /* Now both are in UTF-8. */
7222 SvREFCNT_dec(svrecode);
7228 /* sv1 is the UTF-8 one */
7229 return bytes_cmp_utf8((const U8*)pv2, cur2,
7230 (const U8*)pv1, cur1) == 0;
7233 /* sv2 is the UTF-8 one */
7234 return bytes_cmp_utf8((const U8*)pv1, cur1,
7235 (const U8*)pv2, cur2) == 0;
7241 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7243 SvREFCNT_dec(svrecode);
7253 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7254 string in C<sv1> is less than, equal to, or greater than the string in
7255 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7256 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7258 =for apidoc sv_cmp_flags
7260 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7261 string in C<sv1> is less than, equal to, or greater than the string in
7262 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7263 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7264 also C<sv_cmp_locale_flags>.
7270 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7272 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7276 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7281 const char *pv1, *pv2;
7284 SV *svrecode = NULL;
7291 pv1 = SvPV_flags_const(sv1, cur1, flags);
7298 pv2 = SvPV_flags_const(sv2, cur2, flags);
7300 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7301 /* Differing utf8ness.
7302 * Do not UTF8size the comparands as a side-effect. */
7305 svrecode = newSVpvn(pv2, cur2);
7306 sv_recode_to_utf8(svrecode, PL_encoding);
7307 pv2 = SvPV_const(svrecode, cur2);
7310 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7311 (const U8*)pv1, cur1);
7312 return retval ? retval < 0 ? -1 : +1 : 0;
7317 svrecode = newSVpvn(pv1, cur1);
7318 sv_recode_to_utf8(svrecode, PL_encoding);
7319 pv1 = SvPV_const(svrecode, cur1);
7322 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7323 (const U8*)pv2, cur2);
7324 return retval ? retval < 0 ? -1 : +1 : 0;
7330 cmp = cur2 ? -1 : 0;
7334 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7337 cmp = retval < 0 ? -1 : 1;
7338 } else if (cur1 == cur2) {
7341 cmp = cur1 < cur2 ? -1 : 1;
7345 SvREFCNT_dec(svrecode);
7353 =for apidoc sv_cmp_locale
7355 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7356 'use bytes' aware, handles get magic, and will coerce its args to strings
7357 if necessary. See also C<sv_cmp>.
7359 =for apidoc sv_cmp_locale_flags
7361 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7362 'use bytes' aware and will coerce its args to strings if necessary. If the
7363 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7369 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7371 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7375 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7379 #ifdef USE_LOCALE_COLLATE
7385 if (PL_collation_standard)
7389 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7391 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7393 if (!pv1 || !len1) {
7404 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7407 return retval < 0 ? -1 : 1;
7410 * When the result of collation is equality, that doesn't mean
7411 * that there are no differences -- some locales exclude some
7412 * characters from consideration. So to avoid false equalities,
7413 * we use the raw string as a tiebreaker.
7419 #endif /* USE_LOCALE_COLLATE */
7421 return sv_cmp(sv1, sv2);
7425 #ifdef USE_LOCALE_COLLATE
7428 =for apidoc sv_collxfrm
7430 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7431 C<sv_collxfrm_flags>.
7433 =for apidoc sv_collxfrm_flags
7435 Add Collate Transform magic to an SV if it doesn't already have it. If the
7436 flags contain SV_GMAGIC, it handles get-magic.
7438 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7439 scalar data of the variable, but transformed to such a format that a normal
7440 memory comparison can be used to compare the data according to the locale
7447 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7452 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7454 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7455 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7461 Safefree(mg->mg_ptr);
7462 s = SvPV_flags_const(sv, len, flags);
7463 if ((xf = mem_collxfrm(s, len, &xlen))) {
7465 #ifdef PERL_OLD_COPY_ON_WRITE
7467 sv_force_normal_flags(sv, 0);
7469 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7483 if (mg && mg->mg_ptr) {
7485 return mg->mg_ptr + sizeof(PL_collation_ix);
7493 #endif /* USE_LOCALE_COLLATE */
7496 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7498 SV * const tsv = newSV(0);
7501 sv_gets(tsv, fp, 0);
7502 sv_utf8_upgrade_nomg(tsv);
7503 SvCUR_set(sv,append);
7506 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7510 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7513 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7514 /* Grab the size of the record we're getting */
7515 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7522 /* VMS wants read instead of fread, because fread doesn't respect */
7523 /* RMS record boundaries. This is not necessarily a good thing to be */
7524 /* doing, but we've got no other real choice - except avoid stdio
7525 as implementation - perhaps write a :vms layer ?
7527 fd = PerlIO_fileno(fp);
7529 bytesread = PerlLIO_read(fd, buffer, recsize);
7531 else /* in-memory file from PerlIO::Scalar */
7534 bytesread = PerlIO_read(fp, buffer, recsize);
7539 SvCUR_set(sv, bytesread + append);
7540 buffer[bytesread] = '\0';
7541 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7547 Get a line from the filehandle and store it into the SV, optionally
7548 appending to the currently-stored string.
7554 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7559 register STDCHAR rslast;
7560 register STDCHAR *bp;
7565 PERL_ARGS_ASSERT_SV_GETS;
7567 if (SvTHINKFIRST(sv))
7568 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7569 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7571 However, perlbench says it's slower, because the existing swipe code
7572 is faster than copy on write.
7573 Swings and roundabouts. */
7574 SvUPGRADE(sv, SVt_PV);
7579 if (PerlIO_isutf8(fp)) {
7581 sv_utf8_upgrade_nomg(sv);
7582 sv_pos_u2b(sv,&append,0);
7584 } else if (SvUTF8(sv)) {
7585 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7593 if (PerlIO_isutf8(fp))
7596 if (IN_PERL_COMPILETIME) {
7597 /* we always read code in line mode */
7601 else if (RsSNARF(PL_rs)) {
7602 /* If it is a regular disk file use size from stat() as estimate
7603 of amount we are going to read -- may result in mallocing
7604 more memory than we really need if the layers below reduce
7605 the size we read (e.g. CRLF or a gzip layer).
7608 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7609 const Off_t offset = PerlIO_tell(fp);
7610 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7611 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7617 else if (RsRECORD(PL_rs)) {
7618 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7620 else if (RsPARA(PL_rs)) {
7626 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7627 if (PerlIO_isutf8(fp)) {
7628 rsptr = SvPVutf8(PL_rs, rslen);
7631 if (SvUTF8(PL_rs)) {
7632 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7633 Perl_croak(aTHX_ "Wide character in $/");
7636 rsptr = SvPV_const(PL_rs, rslen);
7640 rslast = rslen ? rsptr[rslen - 1] : '\0';
7642 if (rspara) { /* have to do this both before and after */
7643 do { /* to make sure file boundaries work right */
7646 i = PerlIO_getc(fp);
7650 PerlIO_ungetc(fp,i);
7656 /* See if we know enough about I/O mechanism to cheat it ! */
7658 /* This used to be #ifdef test - it is made run-time test for ease
7659 of abstracting out stdio interface. One call should be cheap
7660 enough here - and may even be a macro allowing compile
7664 if (PerlIO_fast_gets(fp)) {
7667 * We're going to steal some values from the stdio struct
7668 * and put EVERYTHING in the innermost loop into registers.
7670 register STDCHAR *ptr;
7674 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7675 /* An ungetc()d char is handled separately from the regular
7676 * buffer, so we getc() it back out and stuff it in the buffer.
7678 i = PerlIO_getc(fp);
7679 if (i == EOF) return 0;
7680 *(--((*fp)->_ptr)) = (unsigned char) i;
7684 /* Here is some breathtakingly efficient cheating */
7686 cnt = PerlIO_get_cnt(fp); /* get count into register */
7687 /* make sure we have the room */
7688 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7689 /* Not room for all of it
7690 if we are looking for a separator and room for some
7692 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7693 /* just process what we have room for */
7694 shortbuffered = cnt - SvLEN(sv) + append + 1;
7695 cnt -= shortbuffered;
7699 /* remember that cnt can be negative */
7700 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7705 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7706 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7707 DEBUG_P(PerlIO_printf(Perl_debug_log,
7708 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7709 DEBUG_P(PerlIO_printf(Perl_debug_log,
7710 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7711 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7712 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7717 while (cnt > 0) { /* this | eat */
7719 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7720 goto thats_all_folks; /* screams | sed :-) */
7724 Copy(ptr, bp, cnt, char); /* this | eat */
7725 bp += cnt; /* screams | dust */
7726 ptr += cnt; /* louder | sed :-) */
7728 assert (!shortbuffered);
7729 goto cannot_be_shortbuffered;
7733 if (shortbuffered) { /* oh well, must extend */
7734 cnt = shortbuffered;
7736 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7738 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7739 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7743 cannot_be_shortbuffered:
7744 DEBUG_P(PerlIO_printf(Perl_debug_log,
7745 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7746 PTR2UV(ptr),(long)cnt));
7747 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7749 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7750 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7751 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7752 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7754 /* This used to call 'filbuf' in stdio form, but as that behaves like
7755 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7756 another abstraction. */
7757 i = PerlIO_getc(fp); /* get more characters */
7759 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7760 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7761 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7762 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7764 cnt = PerlIO_get_cnt(fp);
7765 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7766 DEBUG_P(PerlIO_printf(Perl_debug_log,
7767 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7769 if (i == EOF) /* all done for ever? */
7770 goto thats_really_all_folks;
7772 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7774 SvGROW(sv, bpx + cnt + 2);
7775 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7777 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7779 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7780 goto thats_all_folks;
7784 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7785 memNE((char*)bp - rslen, rsptr, rslen))
7786 goto screamer; /* go back to the fray */
7787 thats_really_all_folks:
7789 cnt += shortbuffered;
7790 DEBUG_P(PerlIO_printf(Perl_debug_log,
7791 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7792 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7793 DEBUG_P(PerlIO_printf(Perl_debug_log,
7794 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7795 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7796 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7798 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7799 DEBUG_P(PerlIO_printf(Perl_debug_log,
7800 "Screamer: done, len=%ld, string=|%.*s|\n",
7801 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7805 /*The big, slow, and stupid way. */
7806 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7807 STDCHAR *buf = NULL;
7808 Newx(buf, 8192, STDCHAR);
7816 register const STDCHAR * const bpe = buf + sizeof(buf);
7818 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7819 ; /* keep reading */
7823 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7824 /* Accommodate broken VAXC compiler, which applies U8 cast to
7825 * both args of ?: operator, causing EOF to change into 255
7828 i = (U8)buf[cnt - 1];
7834 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7836 sv_catpvn(sv, (char *) buf, cnt);
7838 sv_setpvn(sv, (char *) buf, cnt);
7840 if (i != EOF && /* joy */
7842 SvCUR(sv) < rslen ||
7843 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7847 * If we're reading from a TTY and we get a short read,
7848 * indicating that the user hit his EOF character, we need
7849 * to notice it now, because if we try to read from the TTY
7850 * again, the EOF condition will disappear.
7852 * The comparison of cnt to sizeof(buf) is an optimization
7853 * that prevents unnecessary calls to feof().
7857 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7861 #ifdef USE_HEAP_INSTEAD_OF_STACK
7866 if (rspara) { /* have to do this both before and after */
7867 while (i != EOF) { /* to make sure file boundaries work right */
7868 i = PerlIO_getc(fp);
7870 PerlIO_ungetc(fp,i);
7876 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7882 Auto-increment of the value in the SV, doing string to numeric conversion
7883 if necessary. Handles 'get' magic and operator overloading.
7889 Perl_sv_inc(pTHX_ register SV *const sv)
7898 =for apidoc sv_inc_nomg
7900 Auto-increment of the value in the SV, doing string to numeric conversion
7901 if necessary. Handles operator overloading. Skips handling 'get' magic.
7907 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7915 if (SvTHINKFIRST(sv)) {
7917 sv_force_normal_flags(sv, 0);
7918 if (SvREADONLY(sv)) {
7919 if (IN_PERL_RUNTIME)
7920 Perl_croak_no_modify(aTHX);
7924 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7926 i = PTR2IV(SvRV(sv));
7931 flags = SvFLAGS(sv);
7932 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7933 /* It's (privately or publicly) a float, but not tested as an
7934 integer, so test it to see. */
7936 flags = SvFLAGS(sv);
7938 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7939 /* It's publicly an integer, or privately an integer-not-float */
7940 #ifdef PERL_PRESERVE_IVUV
7944 if (SvUVX(sv) == UV_MAX)
7945 sv_setnv(sv, UV_MAX_P1);
7947 (void)SvIOK_only_UV(sv);
7948 SvUV_set(sv, SvUVX(sv) + 1);
7950 if (SvIVX(sv) == IV_MAX)
7951 sv_setuv(sv, (UV)IV_MAX + 1);
7953 (void)SvIOK_only(sv);
7954 SvIV_set(sv, SvIVX(sv) + 1);
7959 if (flags & SVp_NOK) {
7960 const NV was = SvNVX(sv);
7961 if (NV_OVERFLOWS_INTEGERS_AT &&
7962 was >= NV_OVERFLOWS_INTEGERS_AT) {
7963 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7964 "Lost precision when incrementing %" NVff " by 1",
7967 (void)SvNOK_only(sv);
7968 SvNV_set(sv, was + 1.0);
7972 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7973 if ((flags & SVTYPEMASK) < SVt_PVIV)
7974 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7975 (void)SvIOK_only(sv);
7980 while (isALPHA(*d)) d++;
7981 while (isDIGIT(*d)) d++;
7982 if (d < SvEND(sv)) {
7983 #ifdef PERL_PRESERVE_IVUV
7984 /* Got to punt this as an integer if needs be, but we don't issue
7985 warnings. Probably ought to make the sv_iv_please() that does
7986 the conversion if possible, and silently. */
7987 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7988 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7989 /* Need to try really hard to see if it's an integer.
7990 9.22337203685478e+18 is an integer.
7991 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7992 so $a="9.22337203685478e+18"; $a+0; $a++
7993 needs to be the same as $a="9.22337203685478e+18"; $a++
8000 /* sv_2iv *should* have made this an NV */
8001 if (flags & SVp_NOK) {
8002 (void)SvNOK_only(sv);
8003 SvNV_set(sv, SvNVX(sv) + 1.0);
8006 /* I don't think we can get here. Maybe I should assert this
8007 And if we do get here I suspect that sv_setnv will croak. NWC
8009 #if defined(USE_LONG_DOUBLE)
8010 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",
8011 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8013 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8014 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8017 #endif /* PERL_PRESERVE_IVUV */
8018 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8022 while (d >= SvPVX_const(sv)) {
8030 /* MKS: The original code here died if letters weren't consecutive.
8031 * at least it didn't have to worry about non-C locales. The
8032 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8033 * arranged in order (although not consecutively) and that only
8034 * [A-Za-z] are accepted by isALPHA in the C locale.
8036 if (*d != 'z' && *d != 'Z') {
8037 do { ++*d; } while (!isALPHA(*d));
8040 *(d--) -= 'z' - 'a';
8045 *(d--) -= 'z' - 'a' + 1;
8049 /* oh,oh, the number grew */
8050 SvGROW(sv, SvCUR(sv) + 2);
8051 SvCUR_set(sv, SvCUR(sv) + 1);
8052 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8063 Auto-decrement of the value in the SV, doing string to numeric conversion
8064 if necessary. Handles 'get' magic and operator overloading.
8070 Perl_sv_dec(pTHX_ register SV *const sv)
8080 =for apidoc sv_dec_nomg
8082 Auto-decrement of the value in the SV, doing string to numeric conversion
8083 if necessary. Handles operator overloading. Skips handling 'get' magic.
8089 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8096 if (SvTHINKFIRST(sv)) {
8098 sv_force_normal_flags(sv, 0);
8099 if (SvREADONLY(sv)) {
8100 if (IN_PERL_RUNTIME)
8101 Perl_croak_no_modify(aTHX);
8105 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8107 i = PTR2IV(SvRV(sv));
8112 /* Unlike sv_inc we don't have to worry about string-never-numbers
8113 and keeping them magic. But we mustn't warn on punting */
8114 flags = SvFLAGS(sv);
8115 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8116 /* It's publicly an integer, or privately an integer-not-float */
8117 #ifdef PERL_PRESERVE_IVUV
8121 if (SvUVX(sv) == 0) {
8122 (void)SvIOK_only(sv);
8126 (void)SvIOK_only_UV(sv);
8127 SvUV_set(sv, SvUVX(sv) - 1);
8130 if (SvIVX(sv) == IV_MIN) {
8131 sv_setnv(sv, (NV)IV_MIN);
8135 (void)SvIOK_only(sv);
8136 SvIV_set(sv, SvIVX(sv) - 1);
8141 if (flags & SVp_NOK) {
8144 const NV was = SvNVX(sv);
8145 if (NV_OVERFLOWS_INTEGERS_AT &&
8146 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8147 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8148 "Lost precision when decrementing %" NVff " by 1",
8151 (void)SvNOK_only(sv);
8152 SvNV_set(sv, was - 1.0);
8156 if (!(flags & SVp_POK)) {
8157 if ((flags & SVTYPEMASK) < SVt_PVIV)
8158 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8160 (void)SvIOK_only(sv);
8163 #ifdef PERL_PRESERVE_IVUV
8165 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8166 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8167 /* Need to try really hard to see if it's an integer.
8168 9.22337203685478e+18 is an integer.
8169 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8170 so $a="9.22337203685478e+18"; $a+0; $a--
8171 needs to be the same as $a="9.22337203685478e+18"; $a--
8178 /* sv_2iv *should* have made this an NV */
8179 if (flags & SVp_NOK) {
8180 (void)SvNOK_only(sv);
8181 SvNV_set(sv, SvNVX(sv) - 1.0);
8184 /* I don't think we can get here. Maybe I should assert this
8185 And if we do get here I suspect that sv_setnv will croak. NWC
8187 #if defined(USE_LONG_DOUBLE)
8188 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",
8189 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8191 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8192 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8196 #endif /* PERL_PRESERVE_IVUV */
8197 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8200 /* this define is used to eliminate a chunk of duplicated but shared logic
8201 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8202 * used anywhere but here - yves
8204 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8207 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8211 =for apidoc sv_mortalcopy
8213 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8214 The new SV is marked as mortal. It will be destroyed "soon", either by an
8215 explicit call to FREETMPS, or by an implicit call at places such as
8216 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8221 /* Make a string that will exist for the duration of the expression
8222 * evaluation. Actually, it may have to last longer than that, but
8223 * hopefully we won't free it until it has been assigned to a
8224 * permanent location. */
8227 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8233 sv_setsv(sv,oldstr);
8234 PUSH_EXTEND_MORTAL__SV_C(sv);
8240 =for apidoc sv_newmortal
8242 Creates a new null SV which is mortal. The reference count of the SV is
8243 set to 1. It will be destroyed "soon", either by an explicit call to
8244 FREETMPS, or by an implicit call at places such as statement boundaries.
8245 See also C<sv_mortalcopy> and C<sv_2mortal>.
8251 Perl_sv_newmortal(pTHX)
8257 SvFLAGS(sv) = SVs_TEMP;
8258 PUSH_EXTEND_MORTAL__SV_C(sv);
8264 =for apidoc newSVpvn_flags
8266 Creates a new SV and copies a string into it. The reference count for the
8267 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8268 string. You are responsible for ensuring that the source string is at least
8269 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8270 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8271 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8272 returning. If C<SVf_UTF8> is set, C<s> is considered to be in UTF-8 and the
8273 C<SVf_UTF8> flag will be set on the new SV.
8274 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8276 #define newSVpvn_utf8(s, len, u) \
8277 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8283 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8288 /* All the flags we don't support must be zero.
8289 And we're new code so I'm going to assert this from the start. */
8290 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8292 sv_setpvn(sv,s,len);
8294 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8295 * and do what it does ourselves here.
8296 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8297 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8298 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8299 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8302 SvFLAGS(sv) |= flags;
8304 if(flags & SVs_TEMP){
8305 PUSH_EXTEND_MORTAL__SV_C(sv);
8312 =for apidoc sv_2mortal
8314 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8315 by an explicit call to FREETMPS, or by an implicit call at places such as
8316 statement boundaries. SvTEMP() is turned on which means that the SV's
8317 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8318 and C<sv_mortalcopy>.
8324 Perl_sv_2mortal(pTHX_ register SV *const sv)
8329 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8331 PUSH_EXTEND_MORTAL__SV_C(sv);
8339 Creates a new SV and copies a string into it. The reference count for the
8340 SV is set to 1. If C<len> is zero, Perl will compute the length using
8341 strlen(). For efficiency, consider using C<newSVpvn> instead.
8347 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8353 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8358 =for apidoc newSVpvn
8360 Creates a new SV and copies a string into it. The reference count for the
8361 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8362 string. You are responsible for ensuring that the source string is at least
8363 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8369 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
8375 sv_setpvn(sv,s,len);
8380 =for apidoc newSVhek
8382 Creates a new SV from the hash key structure. It will generate scalars that
8383 point to the shared string table where possible. Returns a new (undefined)
8384 SV if the hek is NULL.
8390 Perl_newSVhek(pTHX_ const HEK *const hek)
8400 if (HEK_LEN(hek) == HEf_SVKEY) {
8401 return newSVsv(*(SV**)HEK_KEY(hek));
8403 const int flags = HEK_FLAGS(hek);
8404 if (flags & HVhek_WASUTF8) {
8406 Andreas would like keys he put in as utf8 to come back as utf8
8408 STRLEN utf8_len = HEK_LEN(hek);
8409 SV * const sv = newSV_type(SVt_PV);
8410 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8411 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8412 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8415 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8416 /* We don't have a pointer to the hv, so we have to replicate the
8417 flag into every HEK. This hv is using custom a hasing
8418 algorithm. Hence we can't return a shared string scalar, as
8419 that would contain the (wrong) hash value, and might get passed
8420 into an hv routine with a regular hash.
8421 Similarly, a hash that isn't using shared hash keys has to have
8422 the flag in every key so that we know not to try to call
8423 share_hek_kek on it. */
8425 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8430 /* This will be overwhelminly the most common case. */
8432 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8433 more efficient than sharepvn(). */
8437 sv_upgrade(sv, SVt_PV);
8438 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8439 SvCUR_set(sv, HEK_LEN(hek));
8452 =for apidoc newSVpvn_share
8454 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8455 table. If the string does not already exist in the table, it is created
8456 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
8457 value is used; otherwise the hash is computed. The string's hash can be later
8458 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
8459 that as the string table is used for shared hash keys these strings will have
8460 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8466 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8470 bool is_utf8 = FALSE;
8471 const char *const orig_src = src;
8474 STRLEN tmplen = -len;
8476 /* See the note in hv.c:hv_fetch() --jhi */
8477 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8481 PERL_HASH(hash, src, len);
8483 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8484 changes here, update it there too. */
8485 sv_upgrade(sv, SVt_PV);
8486 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8494 if (src != orig_src)
8500 =for apidoc newSVpv_share
8502 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8509 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8511 return newSVpvn_share(src, strlen(src), hash);
8514 #if defined(PERL_IMPLICIT_CONTEXT)
8516 /* pTHX_ magic can't cope with varargs, so this is a no-context
8517 * version of the main function, (which may itself be aliased to us).
8518 * Don't access this version directly.
8522 Perl_newSVpvf_nocontext(const char *const pat, ...)
8528 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8530 va_start(args, pat);
8531 sv = vnewSVpvf(pat, &args);
8538 =for apidoc newSVpvf
8540 Creates a new SV and initializes it with the string formatted like
8547 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8552 PERL_ARGS_ASSERT_NEWSVPVF;
8554 va_start(args, pat);
8555 sv = vnewSVpvf(pat, &args);
8560 /* backend for newSVpvf() and newSVpvf_nocontext() */
8563 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8568 PERL_ARGS_ASSERT_VNEWSVPVF;
8571 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8578 Creates a new SV and copies a floating point value into it.
8579 The reference count for the SV is set to 1.
8585 Perl_newSVnv(pTHX_ const NV n)
8598 Creates a new SV and copies an integer into it. The reference count for the
8605 Perl_newSViv(pTHX_ const IV i)
8618 Creates a new SV and copies an unsigned integer into it.
8619 The reference count for the SV is set to 1.
8625 Perl_newSVuv(pTHX_ const UV u)
8636 =for apidoc newSV_type
8638 Creates a new SV, of the type specified. The reference count for the new SV
8645 Perl_newSV_type(pTHX_ const svtype type)
8650 sv_upgrade(sv, type);
8655 =for apidoc newRV_noinc
8657 Creates an RV wrapper for an SV. The reference count for the original
8658 SV is B<not> incremented.
8664 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8667 register SV *sv = newSV_type(SVt_IV);
8669 PERL_ARGS_ASSERT_NEWRV_NOINC;
8672 SvRV_set(sv, tmpRef);
8677 /* newRV_inc is the official function name to use now.
8678 * newRV_inc is in fact #defined to newRV in sv.h
8682 Perl_newRV(pTHX_ SV *const sv)
8686 PERL_ARGS_ASSERT_NEWRV;
8688 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8694 Creates a new SV which is an exact duplicate of the original SV.
8701 Perl_newSVsv(pTHX_ register SV *const old)
8708 if (SvTYPE(old) == SVTYPEMASK) {
8709 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8713 /* SV_GMAGIC is the default for sv_setv()
8714 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8715 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8716 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8721 =for apidoc sv_reset
8723 Underlying implementation for the C<reset> Perl function.
8724 Note that the perl-level function is vaguely deprecated.
8730 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8733 char todo[PERL_UCHAR_MAX+1];
8735 PERL_ARGS_ASSERT_SV_RESET;
8740 if (!*s) { /* reset ?? searches */
8741 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8743 const U32 count = mg->mg_len / sizeof(PMOP**);
8744 PMOP **pmp = (PMOP**) mg->mg_ptr;
8745 PMOP *const *const end = pmp + count;
8749 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8751 (*pmp)->op_pmflags &= ~PMf_USED;
8759 /* reset variables */
8761 if (!HvARRAY(stash))
8764 Zero(todo, 256, char);
8767 I32 i = (unsigned char)*s;
8771 max = (unsigned char)*s++;
8772 for ( ; i <= max; i++) {
8775 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8777 for (entry = HvARRAY(stash)[i];
8779 entry = HeNEXT(entry))
8784 if (!todo[(U8)*HeKEY(entry)])
8786 gv = MUTABLE_GV(HeVAL(entry));
8789 if (SvTHINKFIRST(sv)) {
8790 if (!SvREADONLY(sv) && SvROK(sv))
8792 /* XXX Is this continue a bug? Why should THINKFIRST
8793 exempt us from resetting arrays and hashes? */
8797 if (SvTYPE(sv) >= SVt_PV) {
8799 if (SvPVX_const(sv) != NULL)
8807 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8809 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8812 # if defined(USE_ENVIRON_ARRAY)
8815 # endif /* USE_ENVIRON_ARRAY */
8826 Using various gambits, try to get an IO from an SV: the IO slot if its a
8827 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8828 named after the PV if we're a string.
8834 Perl_sv_2io(pTHX_ SV *const sv)
8839 PERL_ARGS_ASSERT_SV_2IO;
8841 switch (SvTYPE(sv)) {
8843 io = MUTABLE_IO(sv);
8847 if (isGV_with_GP(sv)) {
8848 gv = MUTABLE_GV(sv);
8851 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8857 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8859 return sv_2io(SvRV(sv));
8860 gv = gv_fetchsv(sv, 0, SVt_PVIO);
8866 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
8875 Using various gambits, try to get a CV from an SV; in addition, try if
8876 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8877 The flags in C<lref> are passed to gv_fetchsv.
8883 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8889 PERL_ARGS_ASSERT_SV_2CV;
8896 switch (SvTYPE(sv)) {
8900 return MUTABLE_CV(sv);
8907 if (isGV_with_GP(sv)) {
8908 gv = MUTABLE_GV(sv);
8919 sv = amagic_deref_call(sv, to_cv_amg);
8920 /* At this point I'd like to do SPAGAIN, but really I need to
8921 force it upon my callers. Hmmm. This is a mess... */
8924 if (SvTYPE(sv) == SVt_PVCV) {
8925 cv = MUTABLE_CV(sv);
8930 else if(isGV_with_GP(sv))
8931 gv = MUTABLE_GV(sv);
8933 Perl_croak(aTHX_ "Not a subroutine reference");
8935 else if (isGV_with_GP(sv)) {
8937 gv = MUTABLE_GV(sv);
8940 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
8946 /* Some flags to gv_fetchsv mean don't really create the GV */
8947 if (!isGV_with_GP(gv)) {
8953 if (lref && !GvCVu(gv)) {
8957 gv_efullname3(tmpsv, gv, NULL);
8958 /* XXX this is probably not what they think they're getting.
8959 * It has the same effect as "sub name;", i.e. just a forward
8961 newSUB(start_subparse(FALSE, 0),
8962 newSVOP(OP_CONST, 0, tmpsv),
8966 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8967 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8976 Returns true if the SV has a true value by Perl's rules.
8977 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8978 instead use an in-line version.
8984 Perl_sv_true(pTHX_ register SV *const sv)
8989 register const XPV* const tXpv = (XPV*)SvANY(sv);
8991 (tXpv->xpv_cur > 1 ||
8992 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8999 return SvIVX(sv) != 0;
9002 return SvNVX(sv) != 0.0;
9004 return sv_2bool(sv);
9010 =for apidoc sv_pvn_force
9012 Get a sensible string out of the SV somehow.
9013 A private implementation of the C<SvPV_force> macro for compilers which
9014 can't cope with complex macro expressions. Always use the macro instead.
9016 =for apidoc sv_pvn_force_flags
9018 Get a sensible string out of the SV somehow.
9019 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9020 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9021 implemented in terms of this function.
9022 You normally want to use the various wrapper macros instead: see
9023 C<SvPV_force> and C<SvPV_force_nomg>
9029 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9033 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9035 if (SvTHINKFIRST(sv) && !SvROK(sv))
9036 sv_force_normal_flags(sv, 0);
9046 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
9047 const char * const ref = sv_reftype(sv,0);
9049 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
9050 ref, OP_DESC(PL_op));
9052 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
9054 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
9055 || isGV_with_GP(sv))
9056 /* diag_listed_as: Can't coerce %s to %s in %s */
9057 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9059 s = sv_2pv_flags(sv, &len, flags);
9063 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9066 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9067 SvGROW(sv, len + 1);
9068 Move(s,SvPVX(sv),len,char);
9070 SvPVX(sv)[len] = '\0';
9073 SvPOK_on(sv); /* validate pointer */
9075 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9076 PTR2UV(sv),SvPVX_const(sv)));
9079 return SvPVX_mutable(sv);
9083 =for apidoc sv_pvbyten_force
9085 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
9091 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9093 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9095 sv_pvn_force(sv,lp);
9096 sv_utf8_downgrade(sv,0);
9102 =for apidoc sv_pvutf8n_force
9104 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
9110 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9112 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9114 sv_pvn_force(sv,lp);
9115 sv_utf8_upgrade(sv);
9121 =for apidoc sv_reftype
9123 Returns a string describing what the SV is a reference to.
9129 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9131 PERL_ARGS_ASSERT_SV_REFTYPE;
9133 /* The fact that I don't need to downcast to char * everywhere, only in ?:
9134 inside return suggests a const propagation bug in g++. */
9135 if (ob && SvOBJECT(sv)) {
9136 char * const name = HvNAME_get(SvSTASH(sv));
9137 return name ? name : (char *) "__ANON__";
9140 switch (SvTYPE(sv)) {
9155 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9156 /* tied lvalues should appear to be
9157 * scalars for backwards compatibility */
9158 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9159 ? "SCALAR" : "LVALUE");
9160 case SVt_PVAV: return "ARRAY";
9161 case SVt_PVHV: return "HASH";
9162 case SVt_PVCV: return "CODE";
9163 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9164 ? "GLOB" : "SCALAR");
9165 case SVt_PVFM: return "FORMAT";
9166 case SVt_PVIO: return "IO";
9167 case SVt_BIND: return "BIND";
9168 case SVt_REGEXP: return "REGEXP";
9169 default: return "UNKNOWN";
9175 =for apidoc sv_isobject
9177 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9178 object. If the SV is not an RV, or if the object is not blessed, then this
9185 Perl_sv_isobject(pTHX_ SV *sv)
9201 Returns a boolean indicating whether the SV is blessed into the specified
9202 class. This does not check for subtypes; use C<sv_derived_from> to verify
9203 an inheritance relationship.
9209 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9213 PERL_ARGS_ASSERT_SV_ISA;
9223 hvname = HvNAME_get(SvSTASH(sv));
9227 return strEQ(hvname, name);
9233 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9234 it will be upgraded to one. If C<classname> is non-null then the new SV will
9235 be blessed in the specified package. The new SV is returned and its
9236 reference count is 1.
9242 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9247 PERL_ARGS_ASSERT_NEWSVRV;
9251 SV_CHECK_THINKFIRST_COW_DROP(rv);
9252 (void)SvAMAGIC_off(rv);
9254 if (SvTYPE(rv) >= SVt_PVMG) {
9255 const U32 refcnt = SvREFCNT(rv);
9259 SvREFCNT(rv) = refcnt;
9261 sv_upgrade(rv, SVt_IV);
9262 } else if (SvROK(rv)) {
9263 SvREFCNT_dec(SvRV(rv));
9265 prepare_SV_for_RV(rv);
9273 HV* const stash = gv_stashpv(classname, GV_ADD);
9274 (void)sv_bless(rv, stash);
9280 =for apidoc sv_setref_pv
9282 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9283 argument will be upgraded to an RV. That RV will be modified to point to
9284 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9285 into the SV. The C<classname> argument indicates the package for the
9286 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9287 will have a reference count of 1, and the RV will be returned.
9289 Do not use with other Perl types such as HV, AV, SV, CV, because those
9290 objects will become corrupted by the pointer copy process.
9292 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9298 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9302 PERL_ARGS_ASSERT_SV_SETREF_PV;
9305 sv_setsv(rv, &PL_sv_undef);
9309 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9314 =for apidoc sv_setref_iv
9316 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9317 argument will be upgraded to an RV. That RV will be modified to point to
9318 the new SV. The C<classname> argument indicates the package for the
9319 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9320 will have a reference count of 1, and the RV will be returned.
9326 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9328 PERL_ARGS_ASSERT_SV_SETREF_IV;
9330 sv_setiv(newSVrv(rv,classname), iv);
9335 =for apidoc sv_setref_uv
9337 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9338 argument will be upgraded to an RV. That RV will be modified to point to
9339 the new SV. The C<classname> argument indicates the package for the
9340 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9341 will have a reference count of 1, and the RV will be returned.
9347 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9349 PERL_ARGS_ASSERT_SV_SETREF_UV;
9351 sv_setuv(newSVrv(rv,classname), uv);
9356 =for apidoc sv_setref_nv
9358 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9359 argument will be upgraded to an RV. That RV will be modified to point to
9360 the new SV. The C<classname> argument indicates the package for the
9361 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9362 will have a reference count of 1, and the RV will be returned.
9368 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9370 PERL_ARGS_ASSERT_SV_SETREF_NV;
9372 sv_setnv(newSVrv(rv,classname), nv);
9377 =for apidoc sv_setref_pvn
9379 Copies a string into a new SV, optionally blessing the SV. The length of the
9380 string must be specified with C<n>. The C<rv> argument will be upgraded to
9381 an RV. That RV will be modified to point to the new SV. The C<classname>
9382 argument indicates the package for the blessing. Set C<classname> to
9383 C<NULL> to avoid the blessing. The new SV will have a reference count
9384 of 1, and the RV will be returned.
9386 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9392 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9393 const char *const pv, const STRLEN n)
9395 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9397 sv_setpvn(newSVrv(rv,classname), pv, n);
9402 =for apidoc sv_bless
9404 Blesses an SV into a specified package. The SV must be an RV. The package
9405 must be designated by its stash (see C<gv_stashpv()>). The reference count
9406 of the SV is unaffected.
9412 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9417 PERL_ARGS_ASSERT_SV_BLESS;
9420 Perl_croak(aTHX_ "Can't bless non-reference value");
9422 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9423 if (SvIsCOW(tmpRef))
9424 sv_force_normal_flags(tmpRef, 0);
9425 if (SvREADONLY(tmpRef))
9426 Perl_croak_no_modify(aTHX);
9427 if (SvOBJECT(tmpRef)) {
9428 if (SvTYPE(tmpRef) != SVt_PVIO)
9430 SvREFCNT_dec(SvSTASH(tmpRef));
9433 SvOBJECT_on(tmpRef);
9434 if (SvTYPE(tmpRef) != SVt_PVIO)
9436 SvUPGRADE(tmpRef, SVt_PVMG);
9437 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9442 (void)SvAMAGIC_off(sv);
9444 if(SvSMAGICAL(tmpRef))
9445 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9453 /* Downgrades a PVGV to a PVMG. If it’s actually a PVLV, we leave the type
9454 * as it is after unglobbing it.
9458 S_sv_unglob(pTHX_ SV *const sv)
9463 SV * const temp = sv_newmortal();
9465 PERL_ARGS_ASSERT_SV_UNGLOB;
9467 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9469 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9472 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9473 && HvNAME_get(stash))
9474 mro_method_changed_in(stash);
9475 gp_free(MUTABLE_GV(sv));
9478 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9482 if (GvNAME_HEK(sv)) {
9483 unshare_hek(GvNAME_HEK(sv));
9485 isGV_with_GP_off(sv);
9487 if(SvTYPE(sv) == SVt_PVGV) {
9488 /* need to keep SvANY(sv) in the right arena */
9489 xpvmg = new_XPVMG();
9490 StructCopy(SvANY(sv), xpvmg, XPVMG);
9491 del_XPVGV(SvANY(sv));
9494 SvFLAGS(sv) &= ~SVTYPEMASK;
9495 SvFLAGS(sv) |= SVt_PVMG;
9498 /* Intentionally not calling any local SET magic, as this isn't so much a
9499 set operation as merely an internal storage change. */
9500 sv_setsv_flags(sv, temp, 0);
9504 =for apidoc sv_unref_flags
9506 Unsets the RV status of the SV, and decrements the reference count of
9507 whatever was being referenced by the RV. This can almost be thought of
9508 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9509 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9510 (otherwise the decrementing is conditional on the reference count being
9511 different from one or the reference being a readonly SV).
9518 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9520 SV* const target = SvRV(ref);
9522 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9524 if (SvWEAKREF(ref)) {
9525 sv_del_backref(target, ref);
9527 SvRV_set(ref, NULL);
9530 SvRV_set(ref, NULL);
9532 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9533 assigned to as BEGIN {$a = \"Foo"} will fail. */
9534 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9535 SvREFCNT_dec(target);
9536 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9537 sv_2mortal(target); /* Schedule for freeing later */
9541 =for apidoc sv_untaint
9543 Untaint an SV. Use C<SvTAINTED_off> instead.
9548 Perl_sv_untaint(pTHX_ SV *const sv)
9550 PERL_ARGS_ASSERT_SV_UNTAINT;
9552 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9553 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9560 =for apidoc sv_tainted
9562 Test an SV for taintedness. Use C<SvTAINTED> instead.
9567 Perl_sv_tainted(pTHX_ SV *const sv)
9569 PERL_ARGS_ASSERT_SV_TAINTED;
9571 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9572 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9573 if (mg && (mg->mg_len & 1) )
9580 =for apidoc sv_setpviv
9582 Copies an integer into the given SV, also updating its string value.
9583 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9589 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9591 char buf[TYPE_CHARS(UV)];
9593 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9595 PERL_ARGS_ASSERT_SV_SETPVIV;
9597 sv_setpvn(sv, ptr, ebuf - ptr);
9601 =for apidoc sv_setpviv_mg
9603 Like C<sv_setpviv>, but also handles 'set' magic.
9609 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9611 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9617 #if defined(PERL_IMPLICIT_CONTEXT)
9619 /* pTHX_ magic can't cope with varargs, so this is a no-context
9620 * version of the main function, (which may itself be aliased to us).
9621 * Don't access this version directly.
9625 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9630 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9632 va_start(args, pat);
9633 sv_vsetpvf(sv, pat, &args);
9637 /* pTHX_ magic can't cope with varargs, so this is a no-context
9638 * version of the main function, (which may itself be aliased to us).
9639 * Don't access this version directly.
9643 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9648 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9650 va_start(args, pat);
9651 sv_vsetpvf_mg(sv, pat, &args);
9657 =for apidoc sv_setpvf
9659 Works like C<sv_catpvf> but copies the text into the SV instead of
9660 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9666 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9670 PERL_ARGS_ASSERT_SV_SETPVF;
9672 va_start(args, pat);
9673 sv_vsetpvf(sv, pat, &args);
9678 =for apidoc sv_vsetpvf
9680 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9681 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9683 Usually used via its frontend C<sv_setpvf>.
9689 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9691 PERL_ARGS_ASSERT_SV_VSETPVF;
9693 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9697 =for apidoc sv_setpvf_mg
9699 Like C<sv_setpvf>, but also handles 'set' magic.
9705 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9709 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9711 va_start(args, pat);
9712 sv_vsetpvf_mg(sv, pat, &args);
9717 =for apidoc sv_vsetpvf_mg
9719 Like C<sv_vsetpvf>, but also handles 'set' magic.
9721 Usually used via its frontend C<sv_setpvf_mg>.
9727 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9729 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9731 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9735 #if defined(PERL_IMPLICIT_CONTEXT)
9737 /* pTHX_ magic can't cope with varargs, so this is a no-context
9738 * version of the main function, (which may itself be aliased to us).
9739 * Don't access this version directly.
9743 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9748 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9750 va_start(args, pat);
9751 sv_vcatpvf(sv, pat, &args);
9755 /* pTHX_ magic can't cope with varargs, so this is a no-context
9756 * version of the main function, (which may itself be aliased to us).
9757 * Don't access this version directly.
9761 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9766 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9768 va_start(args, pat);
9769 sv_vcatpvf_mg(sv, pat, &args);
9775 =for apidoc sv_catpvf
9777 Processes its arguments like C<sprintf> and appends the formatted
9778 output to an SV. If the appended data contains "wide" characters
9779 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9780 and characters >255 formatted with %c), the original SV might get
9781 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9782 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9783 valid UTF-8; if the original SV was bytes, the pattern should be too.
9788 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9792 PERL_ARGS_ASSERT_SV_CATPVF;
9794 va_start(args, pat);
9795 sv_vcatpvf(sv, pat, &args);
9800 =for apidoc sv_vcatpvf
9802 Processes its arguments like C<vsprintf> and appends the formatted output
9803 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9805 Usually used via its frontend C<sv_catpvf>.
9811 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9813 PERL_ARGS_ASSERT_SV_VCATPVF;
9815 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9819 =for apidoc sv_catpvf_mg
9821 Like C<sv_catpvf>, but also handles 'set' magic.
9827 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9831 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9833 va_start(args, pat);
9834 sv_vcatpvf_mg(sv, pat, &args);
9839 =for apidoc sv_vcatpvf_mg
9841 Like C<sv_vcatpvf>, but also handles 'set' magic.
9843 Usually used via its frontend C<sv_catpvf_mg>.
9849 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9851 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9853 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9858 =for apidoc sv_vsetpvfn
9860 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9863 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9869 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9870 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9872 PERL_ARGS_ASSERT_SV_VSETPVFN;
9875 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9880 * Warn of missing argument to sprintf, and then return a defined value
9881 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9883 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9885 S_vcatpvfn_missing_argument(pTHX) {
9886 if (ckWARN(WARN_MISSING)) {
9887 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9888 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9895 S_expect_number(pTHX_ char **const pattern)
9900 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9902 switch (**pattern) {
9903 case '1': case '2': case '3':
9904 case '4': case '5': case '6':
9905 case '7': case '8': case '9':
9906 var = *(*pattern)++ - '0';
9907 while (isDIGIT(**pattern)) {
9908 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9910 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9918 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9920 const int neg = nv < 0;
9923 PERL_ARGS_ASSERT_F0CONVERT;
9931 if (uv & 1 && uv == nv)
9932 uv--; /* Round to even */
9934 const unsigned dig = uv % 10;
9947 =for apidoc sv_vcatpvfn
9949 Processes its arguments like C<vsprintf> and appends the formatted output
9950 to an SV. Uses an array of SVs if the C style variable argument list is
9951 missing (NULL). When running with taint checks enabled, indicates via
9952 C<maybe_tainted> if results are untrustworthy (often due to the use of
9955 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9961 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
9962 vecstr = (U8*)SvPV_const(vecsv,veclen);\
9963 vec_utf8 = DO_UTF8(vecsv);
9965 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9968 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9969 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9977 static const char nullstr[] = "(null)";
9979 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9980 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9982 /* Times 4: a decimal digit takes more than 3 binary digits.
9983 * NV_DIG: mantissa takes than many decimal digits.
9984 * Plus 32: Playing safe. */
9985 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9986 /* large enough for "%#.#f" --chip */
9987 /* what about long double NVs? --jhi */
9989 PERL_ARGS_ASSERT_SV_VCATPVFN;
9990 PERL_UNUSED_ARG(maybe_tainted);
9992 /* no matter what, this is a string now */
9993 (void)SvPV_force(sv, origlen);
9995 /* special-case "", "%s", and "%-p" (SVf - see below) */
9998 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10000 const char * const s = va_arg(*args, char*);
10001 sv_catpv(sv, s ? s : nullstr);
10003 else if (svix < svmax) {
10004 sv_catsv(sv, *svargs);
10007 S_vcatpvfn_missing_argument(aTHX);
10010 if (args && patlen == 3 && pat[0] == '%' &&
10011 pat[1] == '-' && pat[2] == 'p') {
10012 argsv = MUTABLE_SV(va_arg(*args, void*));
10013 sv_catsv(sv, argsv);
10017 #ifndef USE_LONG_DOUBLE
10018 /* special-case "%.<number>[gf]" */
10019 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10020 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10021 unsigned digits = 0;
10025 while (*pp >= '0' && *pp <= '9')
10026 digits = 10 * digits + (*pp++ - '0');
10027 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10028 const NV nv = SvNV(*svargs);
10030 /* Add check for digits != 0 because it seems that some
10031 gconverts are buggy in this case, and we don't yet have
10032 a Configure test for this. */
10033 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10034 /* 0, point, slack */
10035 Gconvert(nv, (int)digits, 0, ebuf);
10036 sv_catpv(sv, ebuf);
10037 if (*ebuf) /* May return an empty string for digits==0 */
10040 } else if (!digits) {
10043 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10044 sv_catpvn(sv, p, l);
10050 #endif /* !USE_LONG_DOUBLE */
10052 if (!args && svix < svmax && DO_UTF8(*svargs))
10055 patend = (char*)pat + patlen;
10056 for (p = (char*)pat; p < patend; p = q) {
10059 bool vectorize = FALSE;
10060 bool vectorarg = FALSE;
10061 bool vec_utf8 = FALSE;
10067 bool has_precis = FALSE;
10069 const I32 osvix = svix;
10070 bool is_utf8 = FALSE; /* is this item utf8? */
10071 #ifdef HAS_LDBL_SPRINTF_BUG
10072 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10073 with sfio - Allen <allens@cpan.org> */
10074 bool fix_ldbl_sprintf_bug = FALSE;
10078 U8 utf8buf[UTF8_MAXBYTES+1];
10079 STRLEN esignlen = 0;
10081 const char *eptr = NULL;
10082 const char *fmtstart;
10085 const U8 *vecstr = NULL;
10092 /* we need a long double target in case HAS_LONG_DOUBLE but
10093 not USE_LONG_DOUBLE
10095 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10103 const char *dotstr = ".";
10104 STRLEN dotstrlen = 1;
10105 I32 efix = 0; /* explicit format parameter index */
10106 I32 ewix = 0; /* explicit width index */
10107 I32 epix = 0; /* explicit precision index */
10108 I32 evix = 0; /* explicit vector index */
10109 bool asterisk = FALSE;
10111 /* echo everything up to the next format specification */
10112 for (q = p; q < patend && *q != '%'; ++q) ;
10114 if (has_utf8 && !pat_utf8)
10115 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10117 sv_catpvn(sv, p, q - p);
10126 We allow format specification elements in this order:
10127 \d+\$ explicit format parameter index
10129 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10130 0 flag (as above): repeated to allow "v02"
10131 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10132 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10134 [%bcdefginopsuxDFOUX] format (mandatory)
10139 As of perl5.9.3, printf format checking is on by default.
10140 Internally, perl uses %p formats to provide an escape to
10141 some extended formatting. This block deals with those
10142 extensions: if it does not match, (char*)q is reset and
10143 the normal format processing code is used.
10145 Currently defined extensions are:
10146 %p include pointer address (standard)
10147 %-p (SVf) include an SV (previously %_)
10148 %-<num>p include an SV with precision <num>
10149 %<num>p reserved for future extensions
10151 Robin Barker 2005-07-14
10153 %1p (VDf) removed. RMB 2007-10-19
10160 n = expect_number(&q);
10162 if (sv) { /* SVf */
10167 argsv = MUTABLE_SV(va_arg(*args, void*));
10168 eptr = SvPV_const(argsv, elen);
10169 if (DO_UTF8(argsv))
10174 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10175 "internal %%<num>p might conflict with future printf extensions");
10181 if ( (width = expect_number(&q)) ) {
10196 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10225 if ( (ewix = expect_number(&q)) )
10234 if ((vectorarg = asterisk)) {
10247 width = expect_number(&q);
10250 if (vectorize && vectorarg) {
10251 /* vectorizing, but not with the default "." */
10253 vecsv = va_arg(*args, SV*);
10255 vecsv = (evix > 0 && evix <= svmax)
10256 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10258 vecsv = svix < svmax
10259 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10261 dotstr = SvPV_const(vecsv, dotstrlen);
10262 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10263 bad with tied or overloaded values that return UTF8. */
10264 if (DO_UTF8(vecsv))
10266 else if (has_utf8) {
10267 vecsv = sv_mortalcopy(vecsv);
10268 sv_utf8_upgrade(vecsv);
10269 dotstr = SvPV_const(vecsv, dotstrlen);
10276 i = va_arg(*args, int);
10278 i = (ewix ? ewix <= svmax : svix < svmax) ?
10279 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10281 width = (i < 0) ? -i : i;
10291 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10293 /* XXX: todo, support specified precision parameter */
10297 i = va_arg(*args, int);
10299 i = (ewix ? ewix <= svmax : svix < svmax)
10300 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10302 has_precis = !(i < 0);
10306 while (isDIGIT(*q))
10307 precis = precis * 10 + (*q++ - '0');
10316 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10317 vecsv = svargs[efix ? efix-1 : svix++];
10318 vecstr = (U8*)SvPV_const(vecsv,veclen);
10319 vec_utf8 = DO_UTF8(vecsv);
10321 /* if this is a version object, we need to convert
10322 * back into v-string notation and then let the
10323 * vectorize happen normally
10325 if (sv_derived_from(vecsv, "version")) {
10326 char *version = savesvpv(vecsv);
10327 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10328 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10329 "vector argument not supported with alpha versions");
10332 vecsv = sv_newmortal();
10333 scan_vstring(version, version + veclen, vecsv);
10334 vecstr = (U8*)SvPV_const(vecsv, veclen);
10335 vec_utf8 = DO_UTF8(vecsv);
10349 case 'I': /* Ix, I32x, and I64x */
10351 if (q[1] == '6' && q[2] == '4') {
10357 if (q[1] == '3' && q[2] == '2') {
10367 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10378 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10379 if (*++q == 'l') { /* lld, llf */
10388 if (*++q == 'h') { /* hhd, hhu */
10417 if (!vectorize && !args) {
10419 const I32 i = efix-1;
10420 argsv = (i >= 0 && i < svmax)
10421 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10423 argsv = (svix >= 0 && svix < svmax)
10424 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10428 switch (c = *q++) {
10435 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10437 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10439 eptr = (char*)utf8buf;
10440 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10454 eptr = va_arg(*args, char*);
10456 elen = strlen(eptr);
10458 eptr = (char *)nullstr;
10459 elen = sizeof nullstr - 1;
10463 eptr = SvPV_const(argsv, elen);
10464 if (DO_UTF8(argsv)) {
10465 STRLEN old_precis = precis;
10466 if (has_precis && precis < elen) {
10467 STRLEN ulen = sv_len_utf8(argsv);
10468 I32 p = precis > ulen ? ulen : precis;
10469 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10472 if (width) { /* fudge width (can't fudge elen) */
10473 if (has_precis && precis < elen)
10474 width += precis - old_precis;
10476 width += elen - sv_len_utf8(argsv);
10483 if (has_precis && precis < elen)
10490 if (alt || vectorize)
10492 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10513 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10522 esignbuf[esignlen++] = plus;
10526 case 'c': iv = (char)va_arg(*args, int); break;
10527 case 'h': iv = (short)va_arg(*args, int); break;
10528 case 'l': iv = va_arg(*args, long); break;
10529 case 'V': iv = va_arg(*args, IV); break;
10530 case 'z': iv = va_arg(*args, SSize_t); break;
10531 case 't': iv = va_arg(*args, ptrdiff_t); break;
10532 default: iv = va_arg(*args, int); break;
10534 case 'j': iv = va_arg(*args, intmax_t); break;
10538 iv = va_arg(*args, Quad_t); break;
10545 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10547 case 'c': iv = (char)tiv; break;
10548 case 'h': iv = (short)tiv; break;
10549 case 'l': iv = (long)tiv; break;
10551 default: iv = tiv; break;
10554 iv = (Quad_t)tiv; break;
10560 if ( !vectorize ) /* we already set uv above */
10565 esignbuf[esignlen++] = plus;
10569 esignbuf[esignlen++] = '-';
10613 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10624 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10625 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10626 case 'l': uv = va_arg(*args, unsigned long); break;
10627 case 'V': uv = va_arg(*args, UV); break;
10628 case 'z': uv = va_arg(*args, Size_t); break;
10629 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10631 case 'j': uv = va_arg(*args, uintmax_t); break;
10633 default: uv = va_arg(*args, unsigned); break;
10636 uv = va_arg(*args, Uquad_t); break;
10643 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10645 case 'c': uv = (unsigned char)tuv; break;
10646 case 'h': uv = (unsigned short)tuv; break;
10647 case 'l': uv = (unsigned long)tuv; break;
10649 default: uv = tuv; break;
10652 uv = (Uquad_t)tuv; break;
10661 char *ptr = ebuf + sizeof ebuf;
10662 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10668 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10672 } while (uv >>= 4);
10674 esignbuf[esignlen++] = '0';
10675 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10681 *--ptr = '0' + dig;
10682 } while (uv >>= 3);
10683 if (alt && *ptr != '0')
10689 *--ptr = '0' + dig;
10690 } while (uv >>= 1);
10692 esignbuf[esignlen++] = '0';
10693 esignbuf[esignlen++] = c;
10696 default: /* it had better be ten or less */
10699 *--ptr = '0' + dig;
10700 } while (uv /= base);
10703 elen = (ebuf + sizeof ebuf) - ptr;
10707 zeros = precis - elen;
10708 else if (precis == 0 && elen == 1 && *eptr == '0'
10709 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10712 /* a precision nullifies the 0 flag. */
10719 /* FLOATING POINT */
10722 c = 'f'; /* maybe %F isn't supported here */
10724 case 'e': case 'E':
10726 case 'g': case 'G':
10730 /* This is evil, but floating point is even more evil */
10732 /* for SV-style calling, we can only get NV
10733 for C-style calling, we assume %f is double;
10734 for simplicity we allow any of %Lf, %llf, %qf for long double
10738 #if defined(USE_LONG_DOUBLE)
10742 /* [perl #20339] - we should accept and ignore %lf rather than die */
10746 #if defined(USE_LONG_DOUBLE)
10747 intsize = args ? 0 : 'q';
10751 #if defined(HAS_LONG_DOUBLE)
10764 /* now we need (long double) if intsize == 'q', else (double) */
10766 #if LONG_DOUBLESIZE > DOUBLESIZE
10768 va_arg(*args, long double) :
10769 va_arg(*args, double)
10771 va_arg(*args, double)
10776 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10777 else. frexp() has some unspecified behaviour for those three */
10778 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10780 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10781 will cast our (long double) to (double) */
10782 (void)Perl_frexp(nv, &i);
10783 if (i == PERL_INT_MIN)
10784 Perl_die(aTHX_ "panic: frexp");
10786 need = BIT_DIGITS(i);
10788 need += has_precis ? precis : 6; /* known default */
10793 #ifdef HAS_LDBL_SPRINTF_BUG
10794 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10795 with sfio - Allen <allens@cpan.org> */
10798 # define MY_DBL_MAX DBL_MAX
10799 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10800 # if DOUBLESIZE >= 8
10801 # define MY_DBL_MAX 1.7976931348623157E+308L
10803 # define MY_DBL_MAX 3.40282347E+38L
10807 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10808 # define MY_DBL_MAX_BUG 1L
10810 # define MY_DBL_MAX_BUG MY_DBL_MAX
10814 # define MY_DBL_MIN DBL_MIN
10815 # else /* XXX guessing! -Allen */
10816 # if DOUBLESIZE >= 8
10817 # define MY_DBL_MIN 2.2250738585072014E-308L
10819 # define MY_DBL_MIN 1.17549435E-38L
10823 if ((intsize == 'q') && (c == 'f') &&
10824 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10825 (need < DBL_DIG)) {
10826 /* it's going to be short enough that
10827 * long double precision is not needed */
10829 if ((nv <= 0L) && (nv >= -0L))
10830 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10832 /* would use Perl_fp_class as a double-check but not
10833 * functional on IRIX - see perl.h comments */
10835 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10836 /* It's within the range that a double can represent */
10837 #if defined(DBL_MAX) && !defined(DBL_MIN)
10838 if ((nv >= ((long double)1/DBL_MAX)) ||
10839 (nv <= (-(long double)1/DBL_MAX)))
10841 fix_ldbl_sprintf_bug = TRUE;
10844 if (fix_ldbl_sprintf_bug == TRUE) {
10854 # undef MY_DBL_MAX_BUG
10857 #endif /* HAS_LDBL_SPRINTF_BUG */
10859 need += 20; /* fudge factor */
10860 if (PL_efloatsize < need) {
10861 Safefree(PL_efloatbuf);
10862 PL_efloatsize = need + 20; /* more fudge */
10863 Newx(PL_efloatbuf, PL_efloatsize, char);
10864 PL_efloatbuf[0] = '\0';
10867 if ( !(width || left || plus || alt) && fill != '0'
10868 && has_precis && intsize != 'q' ) { /* Shortcuts */
10869 /* See earlier comment about buggy Gconvert when digits,
10871 if ( c == 'g' && precis) {
10872 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10873 /* May return an empty string for digits==0 */
10874 if (*PL_efloatbuf) {
10875 elen = strlen(PL_efloatbuf);
10876 goto float_converted;
10878 } else if ( c == 'f' && !precis) {
10879 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10884 char *ptr = ebuf + sizeof ebuf;
10887 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10888 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10889 if (intsize == 'q') {
10890 /* Copy the one or more characters in a long double
10891 * format before the 'base' ([efgEFG]) character to
10892 * the format string. */
10893 static char const prifldbl[] = PERL_PRIfldbl;
10894 char const *p = prifldbl + sizeof(prifldbl) - 3;
10895 while (p >= prifldbl) { *--ptr = *p--; }
10900 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10905 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10917 /* No taint. Otherwise we are in the strange situation
10918 * where printf() taints but print($float) doesn't.
10920 #if defined(HAS_LONG_DOUBLE)
10921 elen = ((intsize == 'q')
10922 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10923 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10925 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10929 eptr = PL_efloatbuf;
10937 i = SvCUR(sv) - origlen;
10940 case 'c': *(va_arg(*args, char*)) = i; break;
10941 case 'h': *(va_arg(*args, short*)) = i; break;
10942 default: *(va_arg(*args, int*)) = i; break;
10943 case 'l': *(va_arg(*args, long*)) = i; break;
10944 case 'V': *(va_arg(*args, IV*)) = i; break;
10945 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
10946 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
10948 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
10952 *(va_arg(*args, Quad_t*)) = i; break;
10959 sv_setuv_mg(argsv, (UV)i);
10960 continue; /* not "break" */
10967 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
10968 && ckWARN(WARN_PRINTF))
10970 SV * const msg = sv_newmortal();
10971 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10972 (PL_op->op_type == OP_PRTF) ? "" : "s");
10973 if (fmtstart < patend) {
10974 const char * const fmtend = q < patend ? q : patend;
10976 sv_catpvs(msg, "\"%");
10977 for (f = fmtstart; f < fmtend; f++) {
10979 sv_catpvn(msg, f, 1);
10981 Perl_sv_catpvf(aTHX_ msg,
10982 "\\%03"UVof, (UV)*f & 0xFF);
10985 sv_catpvs(msg, "\"");
10987 sv_catpvs(msg, "end of string");
10989 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
10992 /* output mangled stuff ... */
10998 /* ... right here, because formatting flags should not apply */
10999 SvGROW(sv, SvCUR(sv) + elen + 1);
11001 Copy(eptr, p, elen, char);
11004 SvCUR_set(sv, p - SvPVX_const(sv));
11006 continue; /* not "break" */
11009 if (is_utf8 != has_utf8) {
11012 sv_utf8_upgrade(sv);
11015 const STRLEN old_elen = elen;
11016 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11017 sv_utf8_upgrade(nsv);
11018 eptr = SvPVX_const(nsv);
11021 if (width) { /* fudge width (can't fudge elen) */
11022 width += elen - old_elen;
11028 have = esignlen + zeros + elen;
11030 Perl_croak_nocontext("%s", PL_memory_wrap);
11032 need = (have > width ? have : width);
11035 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11036 Perl_croak_nocontext("%s", PL_memory_wrap);
11037 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11039 if (esignlen && fill == '0') {
11041 for (i = 0; i < (int)esignlen; i++)
11042 *p++ = esignbuf[i];
11044 if (gap && !left) {
11045 memset(p, fill, gap);
11048 if (esignlen && fill != '0') {
11050 for (i = 0; i < (int)esignlen; i++)
11051 *p++ = esignbuf[i];
11055 for (i = zeros; i; i--)
11059 Copy(eptr, p, elen, char);
11063 memset(p, ' ', gap);
11068 Copy(dotstr, p, dotstrlen, char);
11072 vectorize = FALSE; /* done iterating over vecstr */
11079 SvCUR_set(sv, p - SvPVX_const(sv));
11088 /* =========================================================================
11090 =head1 Cloning an interpreter
11092 All the macros and functions in this section are for the private use of
11093 the main function, perl_clone().
11095 The foo_dup() functions make an exact copy of an existing foo thingy.
11096 During the course of a cloning, a hash table is used to map old addresses
11097 to new addresses. The table is created and manipulated with the
11098 ptr_table_* functions.
11102 * =========================================================================*/
11105 #if defined(USE_ITHREADS)
11107 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11108 #ifndef GpREFCNT_inc
11109 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11113 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11114 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11115 If this changes, please unmerge ss_dup.
11116 Likewise, sv_dup_inc_multiple() relies on this fact. */
11117 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11118 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11119 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11120 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11121 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11122 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11123 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11124 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11125 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11126 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11127 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11128 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11129 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11131 /* clone a parser */
11134 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11138 PERL_ARGS_ASSERT_PARSER_DUP;
11143 /* look for it in the table first */
11144 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11148 /* create anew and remember what it is */
11149 Newxz(parser, 1, yy_parser);
11150 ptr_table_store(PL_ptr_table, proto, parser);
11152 /* XXX these not yet duped */
11153 parser->old_parser = NULL;
11154 parser->stack = NULL;
11156 parser->stack_size = 0;
11157 /* XXX parser->stack->state = 0; */
11159 /* XXX eventually, just Copy() most of the parser struct ? */
11161 parser->lex_brackets = proto->lex_brackets;
11162 parser->lex_casemods = proto->lex_casemods;
11163 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11164 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11165 parser->lex_casestack = savepvn(proto->lex_casestack,
11166 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11167 parser->lex_defer = proto->lex_defer;
11168 parser->lex_dojoin = proto->lex_dojoin;
11169 parser->lex_expect = proto->lex_expect;
11170 parser->lex_formbrack = proto->lex_formbrack;
11171 parser->lex_inpat = proto->lex_inpat;
11172 parser->lex_inwhat = proto->lex_inwhat;
11173 parser->lex_op = proto->lex_op;
11174 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11175 parser->lex_starts = proto->lex_starts;
11176 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11177 parser->multi_close = proto->multi_close;
11178 parser->multi_open = proto->multi_open;
11179 parser->multi_start = proto->multi_start;
11180 parser->multi_end = proto->multi_end;
11181 parser->pending_ident = proto->pending_ident;
11182 parser->preambled = proto->preambled;
11183 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11184 parser->linestr = sv_dup_inc(proto->linestr, param);
11185 parser->expect = proto->expect;
11186 parser->copline = proto->copline;
11187 parser->last_lop_op = proto->last_lop_op;
11188 parser->lex_state = proto->lex_state;
11189 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11190 /* rsfp_filters entries have fake IoDIRP() */
11191 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11192 parser->in_my = proto->in_my;
11193 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11194 parser->error_count = proto->error_count;
11197 parser->linestr = sv_dup_inc(proto->linestr, param);
11200 char * const ols = SvPVX(proto->linestr);
11201 char * const ls = SvPVX(parser->linestr);
11203 parser->bufptr = ls + (proto->bufptr >= ols ?
11204 proto->bufptr - ols : 0);
11205 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11206 proto->oldbufptr - ols : 0);
11207 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11208 proto->oldoldbufptr - ols : 0);
11209 parser->linestart = ls + (proto->linestart >= ols ?
11210 proto->linestart - ols : 0);
11211 parser->last_uni = ls + (proto->last_uni >= ols ?
11212 proto->last_uni - ols : 0);
11213 parser->last_lop = ls + (proto->last_lop >= ols ?
11214 proto->last_lop - ols : 0);
11216 parser->bufend = ls + SvCUR(parser->linestr);
11219 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11223 parser->endwhite = proto->endwhite;
11224 parser->faketokens = proto->faketokens;
11225 parser->lasttoke = proto->lasttoke;
11226 parser->nextwhite = proto->nextwhite;
11227 parser->realtokenstart = proto->realtokenstart;
11228 parser->skipwhite = proto->skipwhite;
11229 parser->thisclose = proto->thisclose;
11230 parser->thismad = proto->thismad;
11231 parser->thisopen = proto->thisopen;
11232 parser->thisstuff = proto->thisstuff;
11233 parser->thistoken = proto->thistoken;
11234 parser->thiswhite = proto->thiswhite;
11236 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11237 parser->curforce = proto->curforce;
11239 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11240 Copy(proto->nexttype, parser->nexttype, 5, I32);
11241 parser->nexttoke = proto->nexttoke;
11244 /* XXX should clone saved_curcop here, but we aren't passed
11245 * proto_perl; so do it in perl_clone_using instead */
11251 /* duplicate a file handle */
11254 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11258 PERL_ARGS_ASSERT_FP_DUP;
11259 PERL_UNUSED_ARG(type);
11262 return (PerlIO*)NULL;
11264 /* look for it in the table first */
11265 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11269 /* create anew and remember what it is */
11270 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11271 ptr_table_store(PL_ptr_table, fp, ret);
11275 /* duplicate a directory handle */
11278 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11284 register const Direntry_t *dirent;
11285 char smallbuf[256];
11291 PERL_UNUSED_CONTEXT;
11292 PERL_ARGS_ASSERT_DIRP_DUP;
11297 /* look for it in the table first */
11298 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11304 PERL_UNUSED_ARG(param);
11308 /* open the current directory (so we can switch back) */
11309 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11311 /* chdir to our dir handle and open the present working directory */
11312 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11313 PerlDir_close(pwd);
11314 return (DIR *)NULL;
11316 /* Now we should have two dir handles pointing to the same dir. */
11318 /* Be nice to the calling code and chdir back to where we were. */
11319 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11321 /* We have no need of the pwd handle any more. */
11322 PerlDir_close(pwd);
11325 # define d_namlen(d) (d)->d_namlen
11327 # define d_namlen(d) strlen((d)->d_name)
11329 /* Iterate once through dp, to get the file name at the current posi-
11330 tion. Then step back. */
11331 pos = PerlDir_tell(dp);
11332 if ((dirent = PerlDir_read(dp))) {
11333 len = d_namlen(dirent);
11334 if (len <= sizeof smallbuf) name = smallbuf;
11335 else Newx(name, len, char);
11336 Move(dirent->d_name, name, len, char);
11338 PerlDir_seek(dp, pos);
11340 /* Iterate through the new dir handle, till we find a file with the
11342 if (!dirent) /* just before the end */
11344 pos = PerlDir_tell(ret);
11345 if (PerlDir_read(ret)) continue; /* not there yet */
11346 PerlDir_seek(ret, pos); /* step back */
11350 const long pos0 = PerlDir_tell(ret);
11352 pos = PerlDir_tell(ret);
11353 if ((dirent = PerlDir_read(ret))) {
11354 if (len == d_namlen(dirent)
11355 && memEQ(name, dirent->d_name, len)) {
11357 PerlDir_seek(ret, pos); /* step back */
11360 /* else we are not there yet; keep iterating */
11362 else { /* This is not meant to happen. The best we can do is
11363 reset the iterator to the beginning. */
11364 PerlDir_seek(ret, pos0);
11371 if (name && name != smallbuf)
11376 ret = win32_dirp_dup(dp, param);
11379 /* pop it in the pointer table */
11381 ptr_table_store(PL_ptr_table, dp, ret);
11386 /* duplicate a typeglob */
11389 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11393 PERL_ARGS_ASSERT_GP_DUP;
11397 /* look for it in the table first */
11398 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11402 /* create anew and remember what it is */
11404 ptr_table_store(PL_ptr_table, gp, ret);
11407 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11408 on Newxz() to do this for us. */
11409 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11410 ret->gp_io = io_dup_inc(gp->gp_io, param);
11411 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11412 ret->gp_av = av_dup_inc(gp->gp_av, param);
11413 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11414 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11415 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11416 ret->gp_cvgen = gp->gp_cvgen;
11417 ret->gp_line = gp->gp_line;
11418 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11422 /* duplicate a chain of magic */
11425 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11427 MAGIC *mgret = NULL;
11428 MAGIC **mgprev_p = &mgret;
11430 PERL_ARGS_ASSERT_MG_DUP;
11432 for (; mg; mg = mg->mg_moremagic) {
11435 if ((param->flags & CLONEf_JOIN_IN)
11436 && mg->mg_type == PERL_MAGIC_backref)
11437 /* when joining, we let the individual SVs add themselves to
11438 * backref as needed. */
11441 Newx(nmg, 1, MAGIC);
11443 mgprev_p = &(nmg->mg_moremagic);
11445 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11446 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11447 from the original commit adding Perl_mg_dup() - revision 4538.
11448 Similarly there is the annotation "XXX random ptr?" next to the
11449 assignment to nmg->mg_ptr. */
11452 /* FIXME for plugins
11453 if (nmg->mg_type == PERL_MAGIC_qr) {
11454 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11458 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11459 ? nmg->mg_type == PERL_MAGIC_backref
11460 /* The backref AV has its reference
11461 * count deliberately bumped by 1 */
11462 ? SvREFCNT_inc(av_dup_inc((const AV *)
11463 nmg->mg_obj, param))
11464 : sv_dup_inc(nmg->mg_obj, param)
11465 : sv_dup(nmg->mg_obj, param);
11467 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11468 if (nmg->mg_len > 0) {
11469 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11470 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11471 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11473 AMT * const namtp = (AMT*)nmg->mg_ptr;
11474 sv_dup_inc_multiple((SV**)(namtp->table),
11475 (SV**)(namtp->table), NofAMmeth, param);
11478 else if (nmg->mg_len == HEf_SVKEY)
11479 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11481 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11482 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11488 #endif /* USE_ITHREADS */
11490 struct ptr_tbl_arena {
11491 struct ptr_tbl_arena *next;
11492 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11495 /* create a new pointer-mapping table */
11498 Perl_ptr_table_new(pTHX)
11501 PERL_UNUSED_CONTEXT;
11503 Newx(tbl, 1, PTR_TBL_t);
11504 tbl->tbl_max = 511;
11505 tbl->tbl_items = 0;
11506 tbl->tbl_arena = NULL;
11507 tbl->tbl_arena_next = NULL;
11508 tbl->tbl_arena_end = NULL;
11509 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11513 #define PTR_TABLE_HASH(ptr) \
11514 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11516 /* map an existing pointer using a table */
11518 STATIC PTR_TBL_ENT_t *
11519 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11521 PTR_TBL_ENT_t *tblent;
11522 const UV hash = PTR_TABLE_HASH(sv);
11524 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11526 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11527 for (; tblent; tblent = tblent->next) {
11528 if (tblent->oldval == sv)
11535 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11537 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11539 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11540 PERL_UNUSED_CONTEXT;
11542 return tblent ? tblent->newval : NULL;
11545 /* add a new entry to a pointer-mapping table */
11548 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11550 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11552 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11553 PERL_UNUSED_CONTEXT;
11556 tblent->newval = newsv;
11558 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11560 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11561 struct ptr_tbl_arena *new_arena;
11563 Newx(new_arena, 1, struct ptr_tbl_arena);
11564 new_arena->next = tbl->tbl_arena;
11565 tbl->tbl_arena = new_arena;
11566 tbl->tbl_arena_next = new_arena->array;
11567 tbl->tbl_arena_end = new_arena->array
11568 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11571 tblent = tbl->tbl_arena_next++;
11573 tblent->oldval = oldsv;
11574 tblent->newval = newsv;
11575 tblent->next = tbl->tbl_ary[entry];
11576 tbl->tbl_ary[entry] = tblent;
11578 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11579 ptr_table_split(tbl);
11583 /* double the hash bucket size of an existing ptr table */
11586 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11588 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11589 const UV oldsize = tbl->tbl_max + 1;
11590 UV newsize = oldsize * 2;
11593 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11594 PERL_UNUSED_CONTEXT;
11596 Renew(ary, newsize, PTR_TBL_ENT_t*);
11597 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11598 tbl->tbl_max = --newsize;
11599 tbl->tbl_ary = ary;
11600 for (i=0; i < oldsize; i++, ary++) {
11601 PTR_TBL_ENT_t **entp = ary;
11602 PTR_TBL_ENT_t *ent = *ary;
11603 PTR_TBL_ENT_t **curentp;
11606 curentp = ary + oldsize;
11608 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11610 ent->next = *curentp;
11620 /* remove all the entries from a ptr table */
11621 /* Deprecated - will be removed post 5.14 */
11624 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11626 if (tbl && tbl->tbl_items) {
11627 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11629 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11632 struct ptr_tbl_arena *next = arena->next;
11638 tbl->tbl_items = 0;
11639 tbl->tbl_arena = NULL;
11640 tbl->tbl_arena_next = NULL;
11641 tbl->tbl_arena_end = NULL;
11645 /* clear and free a ptr table */
11648 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11650 struct ptr_tbl_arena *arena;
11656 arena = tbl->tbl_arena;
11659 struct ptr_tbl_arena *next = arena->next;
11665 Safefree(tbl->tbl_ary);
11669 #if defined(USE_ITHREADS)
11672 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11674 PERL_ARGS_ASSERT_RVPV_DUP;
11677 if (SvWEAKREF(sstr)) {
11678 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11679 if (param->flags & CLONEf_JOIN_IN) {
11680 /* if joining, we add any back references individually rather
11681 * than copying the whole backref array */
11682 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11686 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11688 else if (SvPVX_const(sstr)) {
11689 /* Has something there */
11691 /* Normal PV - clone whole allocated space */
11692 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11693 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11694 /* Not that normal - actually sstr is copy on write.
11695 But we are a true, independent SV, so: */
11696 SvREADONLY_off(dstr);
11701 /* Special case - not normally malloced for some reason */
11702 if (isGV_with_GP(sstr)) {
11703 /* Don't need to do anything here. */
11705 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11706 /* A "shared" PV - clone it as "shared" PV */
11708 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11712 /* Some other special case - random pointer */
11713 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11718 /* Copy the NULL */
11719 SvPV_set(dstr, NULL);
11723 /* duplicate a list of SVs. source and dest may point to the same memory. */
11725 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11726 SSize_t items, CLONE_PARAMS *const param)
11728 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11730 while (items-- > 0) {
11731 *dest++ = sv_dup_inc(*source++, param);
11737 /* duplicate an SV of any type (including AV, HV etc) */
11740 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11745 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11747 if (SvTYPE(sstr) == SVTYPEMASK) {
11748 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11753 /* look for it in the table first */
11754 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11758 if(param->flags & CLONEf_JOIN_IN) {
11759 /** We are joining here so we don't want do clone
11760 something that is bad **/
11761 if (SvTYPE(sstr) == SVt_PVHV) {
11762 const HEK * const hvname = HvNAME_HEK(sstr);
11764 /** don't clone stashes if they already exist **/
11765 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
11766 ptr_table_store(PL_ptr_table, sstr, dstr);
11772 /* create anew and remember what it is */
11775 #ifdef DEBUG_LEAKING_SCALARS
11776 dstr->sv_debug_optype = sstr->sv_debug_optype;
11777 dstr->sv_debug_line = sstr->sv_debug_line;
11778 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11779 dstr->sv_debug_parent = (SV*)sstr;
11780 FREE_SV_DEBUG_FILE(dstr);
11781 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11784 ptr_table_store(PL_ptr_table, sstr, dstr);
11787 SvFLAGS(dstr) = SvFLAGS(sstr);
11788 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11789 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11792 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11793 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11794 (void*)PL_watch_pvx, SvPVX_const(sstr));
11797 /* don't clone objects whose class has asked us not to */
11798 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11803 switch (SvTYPE(sstr)) {
11805 SvANY(dstr) = NULL;
11808 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11810 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11812 SvIV_set(dstr, SvIVX(sstr));
11816 SvANY(dstr) = new_XNV();
11817 SvNV_set(dstr, SvNVX(sstr));
11819 /* case SVt_BIND: */
11822 /* These are all the types that need complex bodies allocating. */
11824 const svtype sv_type = SvTYPE(sstr);
11825 const struct body_details *const sv_type_details
11826 = bodies_by_type + sv_type;
11830 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11845 assert(sv_type_details->body_size);
11846 if (sv_type_details->arena) {
11847 new_body_inline(new_body, sv_type);
11849 = (void*)((char*)new_body - sv_type_details->offset);
11851 new_body = new_NOARENA(sv_type_details);
11855 SvANY(dstr) = new_body;
11858 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11859 ((char*)SvANY(dstr)) + sv_type_details->offset,
11860 sv_type_details->copy, char);
11862 Copy(((char*)SvANY(sstr)),
11863 ((char*)SvANY(dstr)),
11864 sv_type_details->body_size + sv_type_details->offset, char);
11867 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11868 && !isGV_with_GP(dstr)
11869 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11870 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11872 /* The Copy above means that all the source (unduplicated) pointers
11873 are now in the destination. We can check the flags and the
11874 pointers in either, but it's possible that there's less cache
11875 missing by always going for the destination.
11876 FIXME - instrument and check that assumption */
11877 if (sv_type >= SVt_PVMG) {
11878 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11879 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11880 } else if (SvMAGIC(dstr))
11881 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11883 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11886 /* The cast silences a GCC warning about unhandled types. */
11887 switch ((int)sv_type) {
11897 /* FIXME for plugins */
11898 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11901 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11902 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11903 LvTARG(dstr) = dstr;
11904 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11905 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11907 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11909 /* non-GP case already handled above */
11910 if(isGV_with_GP(sstr)) {
11911 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11912 /* Don't call sv_add_backref here as it's going to be
11913 created as part of the magic cloning of the symbol
11914 table--unless this is during a join and the stash
11915 is not actually being cloned. */
11916 /* Danger Will Robinson - GvGP(dstr) isn't initialised
11917 at the point of this comment. */
11918 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11919 if (param->flags & CLONEf_JOIN_IN)
11920 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
11921 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
11922 (void)GpREFCNT_inc(GvGP(dstr));
11926 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11927 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11928 /* I have no idea why fake dirp (rsfps)
11929 should be treated differently but otherwise
11930 we end up with leaks -- sky*/
11931 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
11932 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
11933 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11935 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
11936 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
11937 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
11938 if (IoDIRP(dstr)) {
11939 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
11942 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
11944 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
11946 if (IoOFP(dstr) == IoIFP(sstr))
11947 IoOFP(dstr) = IoIFP(dstr);
11949 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11950 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
11951 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
11952 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
11955 /* avoid cloning an empty array */
11956 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11957 SV **dst_ary, **src_ary;
11958 SSize_t items = AvFILLp((const AV *)sstr) + 1;
11960 src_ary = AvARRAY((const AV *)sstr);
11961 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
11962 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11963 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
11964 AvALLOC((const AV *)dstr) = dst_ary;
11965 if (AvREAL((const AV *)sstr)) {
11966 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
11970 while (items-- > 0)
11971 *dst_ary++ = sv_dup(*src_ary++, param);
11973 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
11974 while (items-- > 0) {
11975 *dst_ary++ = &PL_sv_undef;
11979 AvARRAY(MUTABLE_AV(dstr)) = NULL;
11980 AvALLOC((const AV *)dstr) = (SV**)NULL;
11981 AvMAX( (const AV *)dstr) = -1;
11982 AvFILLp((const AV *)dstr) = -1;
11986 if (HvARRAY((const HV *)sstr)) {
11988 const bool sharekeys = !!HvSHAREKEYS(sstr);
11989 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11990 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11992 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11993 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
11995 HvARRAY(dstr) = (HE**)darray;
11996 while (i <= sxhv->xhv_max) {
11997 const HE * const source = HvARRAY(sstr)[i];
11998 HvARRAY(dstr)[i] = source
11999 ? he_dup(source, sharekeys, param) : 0;
12003 const struct xpvhv_aux * const saux = HvAUX(sstr);
12004 struct xpvhv_aux * const daux = HvAUX(dstr);
12005 /* This flag isn't copied. */
12006 /* SvOOK_on(hv) attacks the IV flags. */
12007 SvFLAGS(dstr) |= SVf_OOK;
12009 if (saux->xhv_name_count) {
12010 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12012 = saux->xhv_name_count < 0
12013 ? -saux->xhv_name_count
12014 : saux->xhv_name_count;
12015 HEK **shekp = sname + count;
12017 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12018 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12019 while (shekp-- > sname) {
12021 *dhekp = hek_dup(*shekp, param);
12025 daux->xhv_name_u.xhvnameu_name
12026 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12029 daux->xhv_name_count = saux->xhv_name_count;
12031 daux->xhv_riter = saux->xhv_riter;
12032 daux->xhv_eiter = saux->xhv_eiter
12033 ? he_dup(saux->xhv_eiter,
12034 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12035 /* backref array needs refcnt=2; see sv_add_backref */
12036 daux->xhv_backreferences =
12037 (param->flags & CLONEf_JOIN_IN)
12038 /* when joining, we let the individual GVs and
12039 * CVs add themselves to backref as
12040 * needed. This avoids pulling in stuff
12041 * that isn't required, and simplifies the
12042 * case where stashes aren't cloned back
12043 * if they already exist in the parent
12046 : saux->xhv_backreferences
12047 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12048 ? MUTABLE_AV(SvREFCNT_inc(
12049 sv_dup_inc((const SV *)
12050 saux->xhv_backreferences, param)))
12051 : MUTABLE_AV(sv_dup((const SV *)
12052 saux->xhv_backreferences, param))
12055 daux->xhv_mro_meta = saux->xhv_mro_meta
12056 ? mro_meta_dup(saux->xhv_mro_meta, param)
12059 /* Record stashes for possible cloning in Perl_clone(). */
12061 av_push(param->stashes, dstr);
12065 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12068 if (!(param->flags & CLONEf_COPY_STACKS)) {
12073 /* NOTE: not refcounted */
12074 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12075 hv_dup(CvSTASH(dstr), param);
12076 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12077 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12078 if (!CvISXSUB(dstr)) {
12080 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12082 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12083 } else if (CvCONST(dstr)) {
12084 CvXSUBANY(dstr).any_ptr =
12085 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12087 /* don't dup if copying back - CvGV isn't refcounted, so the
12088 * duped GV may never be freed. A bit of a hack! DAPM */
12089 SvANY(MUTABLE_CV(dstr))->xcv_gv =
12091 ? gv_dup_inc(CvGV(sstr), param)
12092 : (param->flags & CLONEf_JOIN_IN)
12094 : gv_dup(CvGV(sstr), param);
12096 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12098 CvWEAKOUTSIDE(sstr)
12099 ? cv_dup( CvOUTSIDE(dstr), param)
12100 : cv_dup_inc(CvOUTSIDE(dstr), param);
12106 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12113 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12115 PERL_ARGS_ASSERT_SV_DUP_INC;
12116 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12120 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12122 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12123 PERL_ARGS_ASSERT_SV_DUP;
12125 /* Track every SV that (at least initially) had a reference count of 0.
12126 We need to do this by holding an actual reference to it in this array.
12127 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12128 (akin to the stashes hash, and the perl stack), we come unstuck if
12129 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12130 thread) is manipulated in a CLONE method, because CLONE runs before the
12131 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12132 (and fix things up by giving each a reference via the temps stack).
12133 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12134 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12135 before the walk of unreferenced happens and a reference to that is SV
12136 added to the temps stack. At which point we have the same SV considered
12137 to be in use, and free to be re-used. Not good.
12139 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12140 assert(param->unreferenced);
12141 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12147 /* duplicate a context */
12150 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12152 PERL_CONTEXT *ncxs;
12154 PERL_ARGS_ASSERT_CX_DUP;
12157 return (PERL_CONTEXT*)NULL;
12159 /* look for it in the table first */
12160 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12164 /* create anew and remember what it is */
12165 Newx(ncxs, max + 1, PERL_CONTEXT);
12166 ptr_table_store(PL_ptr_table, cxs, ncxs);
12167 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12170 PERL_CONTEXT * const ncx = &ncxs[ix];
12171 if (CxTYPE(ncx) == CXt_SUBST) {
12172 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12175 switch (CxTYPE(ncx)) {
12177 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12178 ? cv_dup_inc(ncx->blk_sub.cv, param)
12179 : cv_dup(ncx->blk_sub.cv,param));
12180 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12181 ? av_dup_inc(ncx->blk_sub.argarray,
12184 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12186 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12187 ncx->blk_sub.oldcomppad);
12190 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12192 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12194 case CXt_LOOP_LAZYSV:
12195 ncx->blk_loop.state_u.lazysv.end
12196 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12197 /* We are taking advantage of av_dup_inc and sv_dup_inc
12198 actually being the same function, and order equivalence of
12200 We can assert the later [but only at run time :-(] */
12201 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12202 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12204 ncx->blk_loop.state_u.ary.ary
12205 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12206 case CXt_LOOP_LAZYIV:
12207 case CXt_LOOP_PLAIN:
12208 if (CxPADLOOP(ncx)) {
12209 ncx->blk_loop.itervar_u.oldcomppad
12210 = (PAD*)ptr_table_fetch(PL_ptr_table,
12211 ncx->blk_loop.itervar_u.oldcomppad);
12213 ncx->blk_loop.itervar_u.gv
12214 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12219 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12220 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12221 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12234 /* duplicate a stack info structure */
12237 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12241 PERL_ARGS_ASSERT_SI_DUP;
12244 return (PERL_SI*)NULL;
12246 /* look for it in the table first */
12247 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12251 /* create anew and remember what it is */
12252 Newxz(nsi, 1, PERL_SI);
12253 ptr_table_store(PL_ptr_table, si, nsi);
12255 nsi->si_stack = av_dup_inc(si->si_stack, param);
12256 nsi->si_cxix = si->si_cxix;
12257 nsi->si_cxmax = si->si_cxmax;
12258 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12259 nsi->si_type = si->si_type;
12260 nsi->si_prev = si_dup(si->si_prev, param);
12261 nsi->si_next = si_dup(si->si_next, param);
12262 nsi->si_markoff = si->si_markoff;
12267 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12268 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12269 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12270 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12271 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12272 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12273 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12274 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12275 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12276 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12277 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12278 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12279 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12280 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12281 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12282 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12285 #define pv_dup_inc(p) SAVEPV(p)
12286 #define pv_dup(p) SAVEPV(p)
12287 #define svp_dup_inc(p,pp) any_dup(p,pp)
12289 /* map any object to the new equivent - either something in the
12290 * ptr table, or something in the interpreter structure
12294 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12298 PERL_ARGS_ASSERT_ANY_DUP;
12301 return (void*)NULL;
12303 /* look for it in the table first */
12304 ret = ptr_table_fetch(PL_ptr_table, v);
12308 /* see if it is part of the interpreter structure */
12309 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12310 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12318 /* duplicate the save stack */
12321 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12324 ANY * const ss = proto_perl->Isavestack;
12325 const I32 max = proto_perl->Isavestack_max;
12326 I32 ix = proto_perl->Isavestack_ix;
12339 void (*dptr) (void*);
12340 void (*dxptr) (pTHX_ void*);
12342 PERL_ARGS_ASSERT_SS_DUP;
12344 Newxz(nss, max, ANY);
12347 const UV uv = POPUV(ss,ix);
12348 const U8 type = (U8)uv & SAVE_MASK;
12350 TOPUV(nss,ix) = uv;
12352 case SAVEt_CLEARSV:
12354 case SAVEt_HELEM: /* hash element */
12355 sv = (const SV *)POPPTR(ss,ix);
12356 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12358 case SAVEt_ITEM: /* normal string */
12359 case SAVEt_GVSV: /* scalar slot in GV */
12360 case SAVEt_SV: /* scalar reference */
12361 sv = (const SV *)POPPTR(ss,ix);
12362 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12365 case SAVEt_MORTALIZESV:
12366 sv = (const SV *)POPPTR(ss,ix);
12367 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12369 case SAVEt_SHARED_PVREF: /* char* in shared space */
12370 c = (char*)POPPTR(ss,ix);
12371 TOPPTR(nss,ix) = savesharedpv(c);
12372 ptr = POPPTR(ss,ix);
12373 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12375 case SAVEt_GENERIC_SVREF: /* generic sv */
12376 case SAVEt_SVREF: /* scalar reference */
12377 sv = (const SV *)POPPTR(ss,ix);
12378 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12379 ptr = POPPTR(ss,ix);
12380 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12382 case SAVEt_HV: /* hash reference */
12383 case SAVEt_AV: /* array reference */
12384 sv = (const SV *) POPPTR(ss,ix);
12385 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12387 case SAVEt_COMPPAD:
12389 sv = (const SV *) POPPTR(ss,ix);
12390 TOPPTR(nss,ix) = sv_dup(sv, param);
12392 case SAVEt_INT: /* int reference */
12393 ptr = POPPTR(ss,ix);
12394 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12395 intval = (int)POPINT(ss,ix);
12396 TOPINT(nss,ix) = intval;
12398 case SAVEt_LONG: /* long reference */
12399 ptr = POPPTR(ss,ix);
12400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12401 longval = (long)POPLONG(ss,ix);
12402 TOPLONG(nss,ix) = longval;
12404 case SAVEt_I32: /* I32 reference */
12405 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
12406 ptr = POPPTR(ss,ix);
12407 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12409 TOPINT(nss,ix) = i;
12411 case SAVEt_IV: /* IV reference */
12412 ptr = POPPTR(ss,ix);
12413 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12415 TOPIV(nss,ix) = iv;
12417 case SAVEt_HPTR: /* HV* reference */
12418 case SAVEt_APTR: /* AV* reference */
12419 case SAVEt_SPTR: /* SV* reference */
12420 ptr = POPPTR(ss,ix);
12421 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12422 sv = (const SV *)POPPTR(ss,ix);
12423 TOPPTR(nss,ix) = sv_dup(sv, param);
12425 case SAVEt_VPTR: /* random* reference */
12426 ptr = POPPTR(ss,ix);
12427 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12429 case SAVEt_INT_SMALL:
12430 case SAVEt_I32_SMALL:
12431 case SAVEt_I16: /* I16 reference */
12432 case SAVEt_I8: /* I8 reference */
12434 ptr = POPPTR(ss,ix);
12435 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12437 case SAVEt_GENERIC_PVREF: /* generic char* */
12438 case SAVEt_PPTR: /* char* reference */
12439 ptr = POPPTR(ss,ix);
12440 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12441 c = (char*)POPPTR(ss,ix);
12442 TOPPTR(nss,ix) = pv_dup(c);
12444 case SAVEt_GP: /* scalar reference */
12445 gp = (GP*)POPPTR(ss,ix);
12446 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12447 (void)GpREFCNT_inc(gp);
12448 gv = (const GV *)POPPTR(ss,ix);
12449 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12452 ptr = POPPTR(ss,ix);
12453 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12454 /* these are assumed to be refcounted properly */
12456 switch (((OP*)ptr)->op_type) {
12458 case OP_LEAVESUBLV:
12462 case OP_LEAVEWRITE:
12463 TOPPTR(nss,ix) = ptr;
12466 (void) OpREFCNT_inc(o);
12470 TOPPTR(nss,ix) = NULL;
12475 TOPPTR(nss,ix) = NULL;
12477 case SAVEt_FREECOPHH:
12478 ptr = POPPTR(ss,ix);
12479 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12482 hv = (const HV *)POPPTR(ss,ix);
12483 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12485 TOPINT(nss,ix) = i;
12488 c = (char*)POPPTR(ss,ix);
12489 TOPPTR(nss,ix) = pv_dup_inc(c);
12491 case SAVEt_STACK_POS: /* Position on Perl stack */
12493 TOPINT(nss,ix) = i;
12495 case SAVEt_DESTRUCTOR:
12496 ptr = POPPTR(ss,ix);
12497 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12498 dptr = POPDPTR(ss,ix);
12499 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12500 any_dup(FPTR2DPTR(void *, dptr),
12503 case SAVEt_DESTRUCTOR_X:
12504 ptr = POPPTR(ss,ix);
12505 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12506 dxptr = POPDXPTR(ss,ix);
12507 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12508 any_dup(FPTR2DPTR(void *, dxptr),
12511 case SAVEt_REGCONTEXT:
12513 ix -= uv >> SAVE_TIGHT_SHIFT;
12515 case SAVEt_AELEM: /* array element */
12516 sv = (const SV *)POPPTR(ss,ix);
12517 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12519 TOPINT(nss,ix) = i;
12520 av = (const AV *)POPPTR(ss,ix);
12521 TOPPTR(nss,ix) = av_dup_inc(av, param);
12524 ptr = POPPTR(ss,ix);
12525 TOPPTR(nss,ix) = ptr;
12528 ptr = POPPTR(ss,ix);
12529 ptr = cophh_copy((COPHH*)ptr);
12530 TOPPTR(nss,ix) = ptr;
12532 TOPINT(nss,ix) = i;
12533 if (i & HINT_LOCALIZE_HH) {
12534 hv = (const HV *)POPPTR(ss,ix);
12535 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12538 case SAVEt_PADSV_AND_MORTALIZE:
12539 longval = (long)POPLONG(ss,ix);
12540 TOPLONG(nss,ix) = longval;
12541 ptr = POPPTR(ss,ix);
12542 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12543 sv = (const SV *)POPPTR(ss,ix);
12544 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12546 case SAVEt_SET_SVFLAGS:
12548 TOPINT(nss,ix) = i;
12550 TOPINT(nss,ix) = i;
12551 sv = (const SV *)POPPTR(ss,ix);
12552 TOPPTR(nss,ix) = sv_dup(sv, param);
12554 case SAVEt_RE_STATE:
12556 const struct re_save_state *const old_state
12557 = (struct re_save_state *)
12558 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12559 struct re_save_state *const new_state
12560 = (struct re_save_state *)
12561 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12563 Copy(old_state, new_state, 1, struct re_save_state);
12564 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12566 new_state->re_state_bostr
12567 = pv_dup(old_state->re_state_bostr);
12568 new_state->re_state_reginput
12569 = pv_dup(old_state->re_state_reginput);
12570 new_state->re_state_regeol
12571 = pv_dup(old_state->re_state_regeol);
12572 new_state->re_state_regoffs
12573 = (regexp_paren_pair*)
12574 any_dup(old_state->re_state_regoffs, proto_perl);
12575 new_state->re_state_reglastparen
12576 = (U32*) any_dup(old_state->re_state_reglastparen,
12578 new_state->re_state_reglastcloseparen
12579 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12581 /* XXX This just has to be broken. The old save_re_context
12582 code did SAVEGENERICPV(PL_reg_start_tmp);
12583 PL_reg_start_tmp is char **.
12584 Look above to what the dup code does for
12585 SAVEt_GENERIC_PVREF
12586 It can never have worked.
12587 So this is merely a faithful copy of the exiting bug: */
12588 new_state->re_state_reg_start_tmp
12589 = (char **) pv_dup((char *)
12590 old_state->re_state_reg_start_tmp);
12591 /* I assume that it only ever "worked" because no-one called
12592 (pseudo)fork while the regexp engine had re-entered itself.
12594 #ifdef PERL_OLD_COPY_ON_WRITE
12595 new_state->re_state_nrs
12596 = sv_dup(old_state->re_state_nrs, param);
12598 new_state->re_state_reg_magic
12599 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12601 new_state->re_state_reg_oldcurpm
12602 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12604 new_state->re_state_reg_curpm
12605 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12607 new_state->re_state_reg_oldsaved
12608 = pv_dup(old_state->re_state_reg_oldsaved);
12609 new_state->re_state_reg_poscache
12610 = pv_dup(old_state->re_state_reg_poscache);
12611 new_state->re_state_reg_starttry
12612 = pv_dup(old_state->re_state_reg_starttry);
12615 case SAVEt_COMPILE_WARNINGS:
12616 ptr = POPPTR(ss,ix);
12617 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12620 ptr = POPPTR(ss,ix);
12621 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12625 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12633 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12634 * flag to the result. This is done for each stash before cloning starts,
12635 * so we know which stashes want their objects cloned */
12638 do_mark_cloneable_stash(pTHX_ SV *const sv)
12640 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12642 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12643 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12644 if (cloner && GvCV(cloner)) {
12651 mXPUSHs(newSVhek(hvname));
12653 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12660 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12668 =for apidoc perl_clone
12670 Create and return a new interpreter by cloning the current one.
12672 perl_clone takes these flags as parameters:
12674 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12675 without it we only clone the data and zero the stacks,
12676 with it we copy the stacks and the new perl interpreter is
12677 ready to run at the exact same point as the previous one.
12678 The pseudo-fork code uses COPY_STACKS while the
12679 threads->create doesn't.
12681 CLONEf_KEEP_PTR_TABLE
12682 perl_clone keeps a ptr_table with the pointer of the old
12683 variable as a key and the new variable as a value,
12684 this allows it to check if something has been cloned and not
12685 clone it again but rather just use the value and increase the
12686 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12687 the ptr_table using the function
12688 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12689 reason to keep it around is if you want to dup some of your own
12690 variable who are outside the graph perl scans, example of this
12691 code is in threads.xs create
12694 This is a win32 thing, it is ignored on unix, it tells perls
12695 win32host code (which is c++) to clone itself, this is needed on
12696 win32 if you want to run two threads at the same time,
12697 if you just want to do some stuff in a separate perl interpreter
12698 and then throw it away and return to the original one,
12699 you don't need to do anything.
12704 /* XXX the above needs expanding by someone who actually understands it ! */
12705 EXTERN_C PerlInterpreter *
12706 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12709 perl_clone(PerlInterpreter *proto_perl, UV flags)
12712 #ifdef PERL_IMPLICIT_SYS
12714 PERL_ARGS_ASSERT_PERL_CLONE;
12716 /* perlhost.h so we need to call into it
12717 to clone the host, CPerlHost should have a c interface, sky */
12719 if (flags & CLONEf_CLONE_HOST) {
12720 return perl_clone_host(proto_perl,flags);
12722 return perl_clone_using(proto_perl, flags,
12724 proto_perl->IMemShared,
12725 proto_perl->IMemParse,
12727 proto_perl->IStdIO,
12731 proto_perl->IProc);
12735 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12736 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12737 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12738 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12739 struct IPerlDir* ipD, struct IPerlSock* ipS,
12740 struct IPerlProc* ipP)
12742 /* XXX many of the string copies here can be optimized if they're
12743 * constants; they need to be allocated as common memory and just
12744 * their pointers copied. */
12747 CLONE_PARAMS clone_params;
12748 CLONE_PARAMS* const param = &clone_params;
12750 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12752 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12753 #else /* !PERL_IMPLICIT_SYS */
12755 CLONE_PARAMS clone_params;
12756 CLONE_PARAMS* param = &clone_params;
12757 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12759 PERL_ARGS_ASSERT_PERL_CLONE;
12760 #endif /* PERL_IMPLICIT_SYS */
12762 /* for each stash, determine whether its objects should be cloned */
12763 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12764 PERL_SET_THX(my_perl);
12767 PoisonNew(my_perl, 1, PerlInterpreter);
12772 PL_scopestack_name = 0;
12774 PL_savestack_ix = 0;
12775 PL_savestack_max = -1;
12776 PL_sig_pending = 0;
12778 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12779 # ifdef DEBUG_LEAKING_SCALARS
12780 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12782 #else /* !DEBUGGING */
12783 Zero(my_perl, 1, PerlInterpreter);
12784 #endif /* DEBUGGING */
12786 #ifdef PERL_IMPLICIT_SYS
12787 /* host pointers */
12789 PL_MemShared = ipMS;
12790 PL_MemParse = ipMP;
12797 #endif /* PERL_IMPLICIT_SYS */
12799 param->flags = flags;
12800 /* Nothing in the core code uses this, but we make it available to
12801 extensions (using mg_dup). */
12802 param->proto_perl = proto_perl;
12803 /* Likely nothing will use this, but it is initialised to be consistent
12804 with Perl_clone_params_new(). */
12805 param->new_perl = my_perl;
12806 param->unreferenced = NULL;
12808 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12810 PL_body_arenas = NULL;
12811 Zero(&PL_body_roots, 1, PL_body_roots);
12814 PL_sv_objcount = 0;
12816 PL_sv_arenaroot = NULL;
12818 PL_debug = proto_perl->Idebug;
12820 PL_hash_seed = proto_perl->Ihash_seed;
12821 PL_rehash_seed = proto_perl->Irehash_seed;
12823 #ifdef USE_REENTRANT_API
12824 /* XXX: things like -Dm will segfault here in perlio, but doing
12825 * PERL_SET_CONTEXT(proto_perl);
12826 * breaks too many other things
12828 Perl_reentrant_init(aTHX);
12831 /* create SV map for pointer relocation */
12832 PL_ptr_table = ptr_table_new();
12834 /* initialize these special pointers as early as possible */
12835 SvANY(&PL_sv_undef) = NULL;
12836 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12837 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12838 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
12840 SvANY(&PL_sv_no) = new_XPVNV();
12841 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12842 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12843 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12844 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
12845 SvCUR_set(&PL_sv_no, 0);
12846 SvLEN_set(&PL_sv_no, 1);
12847 SvIV_set(&PL_sv_no, 0);
12848 SvNV_set(&PL_sv_no, 0);
12849 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
12851 SvANY(&PL_sv_yes) = new_XPVNV();
12852 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12853 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12854 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12855 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
12856 SvCUR_set(&PL_sv_yes, 1);
12857 SvLEN_set(&PL_sv_yes, 2);
12858 SvIV_set(&PL_sv_yes, 1);
12859 SvNV_set(&PL_sv_yes, 1);
12860 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
12862 /* dbargs array probably holds garbage */
12865 /* create (a non-shared!) shared string table */
12866 PL_strtab = newHV();
12867 HvSHAREKEYS_off(PL_strtab);
12868 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
12869 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
12871 PL_compiling = proto_perl->Icompiling;
12873 /* These two PVs will be free'd special way so must set them same way op.c does */
12874 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
12875 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
12877 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
12878 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
12880 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
12881 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
12882 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
12883 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
12884 #ifdef PERL_DEBUG_READONLY_OPS
12889 /* pseudo environmental stuff */
12890 PL_origargc = proto_perl->Iorigargc;
12891 PL_origargv = proto_perl->Iorigargv;
12893 param->stashes = newAV(); /* Setup array of objects to call clone on */
12894 /* This makes no difference to the implementation, as it always pushes
12895 and shifts pointers to other SVs without changing their reference
12896 count, with the array becoming empty before it is freed. However, it
12897 makes it conceptually clear what is going on, and will avoid some
12898 work inside av.c, filling slots between AvFILL() and AvMAX() with
12899 &PL_sv_undef, and SvREFCNT_dec()ing those. */
12900 AvREAL_off(param->stashes);
12902 if (!(flags & CLONEf_COPY_STACKS)) {
12903 param->unreferenced = newAV();
12906 /* Set tainting stuff before PerlIO_debug can possibly get called */
12907 PL_tainting = proto_perl->Itainting;
12908 PL_taint_warn = proto_perl->Itaint_warn;
12910 #ifdef PERLIO_LAYERS
12911 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
12912 PerlIO_clone(aTHX_ proto_perl, param);
12915 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
12916 PL_incgv = gv_dup(proto_perl->Iincgv, param);
12917 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
12918 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
12919 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
12920 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
12923 PL_minus_c = proto_perl->Iminus_c;
12924 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
12925 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
12926 PL_localpatches = proto_perl->Ilocalpatches;
12927 PL_splitstr = proto_perl->Isplitstr;
12928 PL_minus_n = proto_perl->Iminus_n;
12929 PL_minus_p = proto_perl->Iminus_p;
12930 PL_minus_l = proto_perl->Iminus_l;
12931 PL_minus_a = proto_perl->Iminus_a;
12932 PL_minus_E = proto_perl->Iminus_E;
12933 PL_minus_F = proto_perl->Iminus_F;
12934 PL_doswitches = proto_perl->Idoswitches;
12935 PL_dowarn = proto_perl->Idowarn;
12936 PL_sawampersand = proto_perl->Isawampersand;
12937 PL_unsafe = proto_perl->Iunsafe;
12938 PL_inplace = SAVEPV(proto_perl->Iinplace);
12939 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
12940 PL_perldb = proto_perl->Iperldb;
12941 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12942 PL_exit_flags = proto_perl->Iexit_flags;
12944 /* magical thingies */
12945 /* XXX time(&PL_basetime) when asked for? */
12946 PL_basetime = proto_perl->Ibasetime;
12947 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
12949 PL_maxsysfd = proto_perl->Imaxsysfd;
12950 PL_statusvalue = proto_perl->Istatusvalue;
12952 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12954 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12956 PL_encoding = sv_dup(proto_perl->Iencoding, param);
12958 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
12959 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
12960 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
12963 /* RE engine related */
12964 Zero(&PL_reg_state, 1, struct re_save_state);
12965 PL_reginterp_cnt = 0;
12966 PL_regmatch_slab = NULL;
12968 /* Clone the regex array */
12969 /* ORANGE FIXME for plugins, probably in the SV dup code.
12970 newSViv(PTR2IV(CALLREGDUPE(
12971 INT2PTR(REGEXP *, SvIVX(regex)), param))))
12973 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
12974 PL_regex_pad = AvARRAY(PL_regex_padav);
12976 /* shortcuts to various I/O objects */
12977 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
12978 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
12979 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
12980 PL_defgv = gv_dup(proto_perl->Idefgv, param);
12981 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
12982 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
12983 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
12985 /* shortcuts to regexp stuff */
12986 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
12988 /* shortcuts to misc objects */
12989 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
12991 /* shortcuts to debugging objects */
12992 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
12993 PL_DBline = gv_dup(proto_perl->IDBline, param);
12994 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
12995 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
12996 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
12997 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
12999 /* symbol tables */
13000 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13001 PL_curstash = hv_dup(proto_perl->Icurstash, param);
13002 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13003 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13004 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13006 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13007 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13008 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13009 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13010 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13011 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13012 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13013 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13015 PL_sub_generation = proto_perl->Isub_generation;
13016 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13018 /* funky return mechanisms */
13019 PL_forkprocess = proto_perl->Iforkprocess;
13021 /* subprocess state */
13022 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13024 /* internal state */
13025 PL_maxo = proto_perl->Imaxo;
13026 if (proto_perl->Iop_mask)
13027 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13030 /* PL_asserting = proto_perl->Iasserting; */
13032 /* current interpreter roots */
13033 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13035 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13037 PL_main_start = proto_perl->Imain_start;
13038 PL_eval_root = proto_perl->Ieval_root;
13039 PL_eval_start = proto_perl->Ieval_start;
13041 /* runtime control stuff */
13042 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13044 PL_filemode = proto_perl->Ifilemode;
13045 PL_lastfd = proto_perl->Ilastfd;
13046 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13049 PL_gensym = proto_perl->Igensym;
13050 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13051 PL_laststatval = proto_perl->Ilaststatval;
13052 PL_laststype = proto_perl->Ilaststype;
13055 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13057 /* interpreter atexit processing */
13058 PL_exitlistlen = proto_perl->Iexitlistlen;
13059 if (PL_exitlistlen) {
13060 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13061 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13064 PL_exitlist = (PerlExitListEntry*)NULL;
13066 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13067 if (PL_my_cxt_size) {
13068 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13069 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13070 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13071 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13072 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13076 PL_my_cxt_list = (void**)NULL;
13077 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13078 PL_my_cxt_keys = (const char**)NULL;
13081 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13082 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13083 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13084 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13086 PL_profiledata = NULL;
13088 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13090 PAD_CLONE_VARS(proto_perl, param);
13092 #ifdef HAVE_INTERP_INTERN
13093 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13096 /* more statics moved here */
13097 PL_generation = proto_perl->Igeneration;
13098 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13100 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13101 PL_in_clean_all = proto_perl->Iin_clean_all;
13103 PL_uid = proto_perl->Iuid;
13104 PL_euid = proto_perl->Ieuid;
13105 PL_gid = proto_perl->Igid;
13106 PL_egid = proto_perl->Iegid;
13107 PL_nomemok = proto_perl->Inomemok;
13108 PL_an = proto_perl->Ian;
13109 PL_evalseq = proto_perl->Ievalseq;
13110 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13111 PL_origalen = proto_perl->Iorigalen;
13112 #ifdef PERL_USES_PL_PIDSTATUS
13113 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13115 PL_osname = SAVEPV(proto_perl->Iosname);
13116 PL_sighandlerp = proto_perl->Isighandlerp;
13118 PL_runops = proto_perl->Irunops;
13120 PL_parser = parser_dup(proto_perl->Iparser, param);
13122 /* XXX this only works if the saved cop has already been cloned */
13123 if (proto_perl->Iparser) {
13124 PL_parser->saved_curcop = (COP*)any_dup(
13125 proto_perl->Iparser->saved_curcop,
13129 PL_subline = proto_perl->Isubline;
13130 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13133 PL_cryptseen = proto_perl->Icryptseen;
13136 PL_hints = proto_perl->Ihints;
13138 PL_amagic_generation = proto_perl->Iamagic_generation;
13140 #ifdef USE_LOCALE_COLLATE
13141 PL_collation_ix = proto_perl->Icollation_ix;
13142 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13143 PL_collation_standard = proto_perl->Icollation_standard;
13144 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13145 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13146 #endif /* USE_LOCALE_COLLATE */
13148 #ifdef USE_LOCALE_NUMERIC
13149 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13150 PL_numeric_standard = proto_perl->Inumeric_standard;
13151 PL_numeric_local = proto_perl->Inumeric_local;
13152 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13153 #endif /* !USE_LOCALE_NUMERIC */
13155 /* utf8 character classes */
13156 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13157 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
13158 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13159 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13160 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
13161 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13162 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13163 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13164 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13165 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13166 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13167 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13168 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13169 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13170 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13171 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13172 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13173 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13174 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13175 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13176 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13177 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13178 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13179 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13180 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13181 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13182 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13183 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13184 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13185 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13186 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13187 PL_utf8_foldable = hv_dup_inc(proto_perl->Iutf8_foldable, param);
13189 /* Did the locale setup indicate UTF-8? */
13190 PL_utf8locale = proto_perl->Iutf8locale;
13191 /* Unicode features (see perlrun/-C) */
13192 PL_unicode = proto_perl->Iunicode;
13194 /* Pre-5.8 signals control */
13195 PL_signals = proto_perl->Isignals;
13197 /* times() ticks per second */
13198 PL_clocktick = proto_perl->Iclocktick;
13200 /* Recursion stopper for PerlIO_find_layer */
13201 PL_in_load_module = proto_perl->Iin_load_module;
13203 /* sort() routine */
13204 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13206 /* Not really needed/useful since the reenrant_retint is "volatile",
13207 * but do it for consistency's sake. */
13208 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13210 /* Hooks to shared SVs and locks. */
13211 PL_sharehook = proto_perl->Isharehook;
13212 PL_lockhook = proto_perl->Ilockhook;
13213 PL_unlockhook = proto_perl->Iunlockhook;
13214 PL_threadhook = proto_perl->Ithreadhook;
13215 PL_destroyhook = proto_perl->Idestroyhook;
13216 PL_signalhook = proto_perl->Isignalhook;
13218 #ifdef THREADS_HAVE_PIDS
13219 PL_ppid = proto_perl->Ippid;
13223 PL_last_swash_hv = NULL; /* reinits on demand */
13224 PL_last_swash_klen = 0;
13225 PL_last_swash_key[0]= '\0';
13226 PL_last_swash_tmps = (U8*)NULL;
13227 PL_last_swash_slen = 0;
13229 PL_glob_index = proto_perl->Iglob_index;
13230 PL_srand_called = proto_perl->Isrand_called;
13232 if (proto_perl->Ipsig_pend) {
13233 Newxz(PL_psig_pend, SIG_SIZE, int);
13236 PL_psig_pend = (int*)NULL;
13239 if (proto_perl->Ipsig_name) {
13240 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13241 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13243 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13246 PL_psig_ptr = (SV**)NULL;
13247 PL_psig_name = (SV**)NULL;
13250 /* intrpvar.h stuff */
13252 if (flags & CLONEf_COPY_STACKS) {
13253 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13254 PL_tmps_ix = proto_perl->Itmps_ix;
13255 PL_tmps_max = proto_perl->Itmps_max;
13256 PL_tmps_floor = proto_perl->Itmps_floor;
13257 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13258 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13259 PL_tmps_ix+1, param);
13261 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13262 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13263 Newxz(PL_markstack, i, I32);
13264 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13265 - proto_perl->Imarkstack);
13266 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13267 - proto_perl->Imarkstack);
13268 Copy(proto_perl->Imarkstack, PL_markstack,
13269 PL_markstack_ptr - PL_markstack + 1, I32);
13271 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13272 * NOTE: unlike the others! */
13273 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13274 PL_scopestack_max = proto_perl->Iscopestack_max;
13275 Newxz(PL_scopestack, PL_scopestack_max, I32);
13276 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13279 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13280 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13282 /* NOTE: si_dup() looks at PL_markstack */
13283 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13285 /* PL_curstack = PL_curstackinfo->si_stack; */
13286 PL_curstack = av_dup(proto_perl->Icurstack, param);
13287 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13289 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13290 PL_stack_base = AvARRAY(PL_curstack);
13291 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13292 - proto_perl->Istack_base);
13293 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13295 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13296 * NOTE: unlike the others! */
13297 PL_savestack_ix = proto_perl->Isavestack_ix;
13298 PL_savestack_max = proto_perl->Isavestack_max;
13299 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13300 PL_savestack = ss_dup(proto_perl, param);
13304 ENTER; /* perl_destruct() wants to LEAVE; */
13307 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13308 PL_top_env = &PL_start_env;
13310 PL_op = proto_perl->Iop;
13313 PL_Xpv = (XPV*)NULL;
13314 my_perl->Ina = proto_perl->Ina;
13316 PL_statbuf = proto_perl->Istatbuf;
13317 PL_statcache = proto_perl->Istatcache;
13318 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13319 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13321 PL_timesbuf = proto_perl->Itimesbuf;
13324 PL_tainted = proto_perl->Itainted;
13325 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13326 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13327 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13328 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13329 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13330 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13331 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13332 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13334 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13335 PL_restartop = proto_perl->Irestartop;
13336 PL_in_eval = proto_perl->Iin_eval;
13337 PL_delaymagic = proto_perl->Idelaymagic;
13338 PL_phase = proto_perl->Iphase;
13339 PL_localizing = proto_perl->Ilocalizing;
13341 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13342 PL_hv_fetch_ent_mh = NULL;
13343 PL_modcount = proto_perl->Imodcount;
13344 PL_lastgotoprobe = NULL;
13345 PL_dumpindent = proto_perl->Idumpindent;
13347 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13348 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13349 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13350 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13351 PL_efloatbuf = NULL; /* reinits on demand */
13352 PL_efloatsize = 0; /* reinits on demand */
13356 PL_screamfirst = NULL;
13357 PL_screamnext = NULL;
13358 PL_maxscream = -1; /* reinits on demand */
13359 PL_lastscream = NULL;
13362 PL_regdummy = proto_perl->Iregdummy;
13363 PL_colorset = 0; /* reinits PL_colors[] */
13364 /*PL_colors[6] = {0,0,0,0,0,0};*/
13368 /* Pluggable optimizer */
13369 PL_peepp = proto_perl->Ipeepp;
13370 PL_rpeepp = proto_perl->Irpeepp;
13371 /* op_free() hook */
13372 PL_opfreehook = proto_perl->Iopfreehook;
13374 PL_stashcache = newHV();
13376 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13377 proto_perl->Iwatchaddr);
13378 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13379 if (PL_debug && PL_watchaddr) {
13380 PerlIO_printf(Perl_debug_log,
13381 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13382 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13383 PTR2UV(PL_watchok));
13386 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13387 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13388 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13390 /* Call the ->CLONE method, if it exists, for each of the stashes
13391 identified by sv_dup() above.
13393 while(av_len(param->stashes) != -1) {
13394 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13395 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13396 if (cloner && GvCV(cloner)) {
13401 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13403 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13409 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13410 ptr_table_free(PL_ptr_table);
13411 PL_ptr_table = NULL;
13414 if (!(flags & CLONEf_COPY_STACKS)) {
13415 unreferenced_to_tmp_stack(param->unreferenced);
13418 SvREFCNT_dec(param->stashes);
13420 /* orphaned? eg threads->new inside BEGIN or use */
13421 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13422 SvREFCNT_inc_simple_void(PL_compcv);
13423 SAVEFREESV(PL_compcv);
13430 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13432 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13434 if (AvFILLp(unreferenced) > -1) {
13435 SV **svp = AvARRAY(unreferenced);
13436 SV **const last = svp + AvFILLp(unreferenced);
13440 if (SvREFCNT(*svp) == 1)
13442 } while (++svp <= last);
13444 EXTEND_MORTAL(count);
13445 svp = AvARRAY(unreferenced);
13448 if (SvREFCNT(*svp) == 1) {
13449 /* Our reference is the only one to this SV. This means that
13450 in this thread, the scalar effectively has a 0 reference.
13451 That doesn't work (cleanup never happens), so donate our
13452 reference to it onto the save stack. */
13453 PL_tmps_stack[++PL_tmps_ix] = *svp;
13455 /* As an optimisation, because we are already walking the
13456 entire array, instead of above doing either
13457 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13458 release our reference to the scalar, so that at the end of
13459 the array owns zero references to the scalars it happens to
13460 point to. We are effectively converting the array from
13461 AvREAL() on to AvREAL() off. This saves the av_clear()
13462 (triggered by the SvREFCNT_dec(unreferenced) below) from
13463 walking the array a second time. */
13464 SvREFCNT_dec(*svp);
13467 } while (++svp <= last);
13468 AvREAL_off(unreferenced);
13470 SvREFCNT_dec(unreferenced);
13474 Perl_clone_params_del(CLONE_PARAMS *param)
13476 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13478 PerlInterpreter *const to = param->new_perl;
13480 PerlInterpreter *const was = PERL_GET_THX;
13482 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13488 SvREFCNT_dec(param->stashes);
13489 if (param->unreferenced)
13490 unreferenced_to_tmp_stack(param->unreferenced);
13500 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13503 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13504 does a dTHX; to get the context from thread local storage.
13505 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13506 a version that passes in my_perl. */
13507 PerlInterpreter *const was = PERL_GET_THX;
13508 CLONE_PARAMS *param;
13510 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13516 /* Given that we've set the context, we can do this unshared. */
13517 Newx(param, 1, CLONE_PARAMS);
13520 param->proto_perl = from;
13521 param->new_perl = to;
13522 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13523 AvREAL_off(param->stashes);
13524 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13532 #endif /* USE_ITHREADS */
13535 =head1 Unicode Support
13537 =for apidoc sv_recode_to_utf8
13539 The encoding is assumed to be an Encode object, on entry the PV
13540 of the sv is assumed to be octets in that encoding, and the sv
13541 will be converted into Unicode (and UTF-8).
13543 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13544 is not a reference, nothing is done to the sv. If the encoding is not
13545 an C<Encode::XS> Encoding object, bad things will happen.
13546 (See F<lib/encoding.pm> and L<Encode>).
13548 The PV of the sv is returned.
13553 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13557 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13559 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13573 Passing sv_yes is wrong - it needs to be or'ed set of constants
13574 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13575 remove converted chars from source.
13577 Both will default the value - let them.
13579 XPUSHs(&PL_sv_yes);
13582 call_method("decode", G_SCALAR);
13586 s = SvPV_const(uni, len);
13587 if (s != SvPVX_const(sv)) {
13588 SvGROW(sv, len + 1);
13589 Move(s, SvPVX(sv), len + 1, char);
13590 SvCUR_set(sv, len);
13594 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13595 /* clear pos and any utf8 cache */
13596 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13599 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13600 magic_setutf8(sv,mg); /* clear UTF8 cache */
13605 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13609 =for apidoc sv_cat_decode
13611 The encoding is assumed to be an Encode object, the PV of the ssv is
13612 assumed to be octets in that encoding and decoding the input starts
13613 from the position which (PV + *offset) pointed to. The dsv will be
13614 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13615 when the string tstr appears in decoding output or the input ends on
13616 the PV of the ssv. The value which the offset points will be modified
13617 to the last input position on the ssv.
13619 Returns TRUE if the terminator was found, else returns FALSE.
13624 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13625 SV *ssv, int *offset, char *tstr, int tlen)
13630 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13632 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13643 offsv = newSViv(*offset);
13645 mXPUSHp(tstr, tlen);
13647 call_method("cat_decode", G_SCALAR);
13649 ret = SvTRUE(TOPs);
13650 *offset = SvIV(offsv);
13656 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13661 /* ---------------------------------------------------------------------
13663 * support functions for report_uninit()
13666 /* the maxiumum size of array or hash where we will scan looking
13667 * for the undefined element that triggered the warning */
13669 #define FUV_MAX_SEARCH_SIZE 1000
13671 /* Look for an entry in the hash whose value has the same SV as val;
13672 * If so, return a mortal copy of the key. */
13675 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13678 register HE **array;
13681 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13683 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13684 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13687 array = HvARRAY(hv);
13689 for (i=HvMAX(hv); i>0; i--) {
13690 register HE *entry;
13691 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13692 if (HeVAL(entry) != val)
13694 if ( HeVAL(entry) == &PL_sv_undef ||
13695 HeVAL(entry) == &PL_sv_placeholder)
13699 if (HeKLEN(entry) == HEf_SVKEY)
13700 return sv_mortalcopy(HeKEY_sv(entry));
13701 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13707 /* Look for an entry in the array whose value has the same SV as val;
13708 * If so, return the index, otherwise return -1. */
13711 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13715 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13717 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13718 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13721 if (val != &PL_sv_undef) {
13722 SV ** const svp = AvARRAY(av);
13725 for (i=AvFILLp(av); i>=0; i--)
13732 /* S_varname(): return the name of a variable, optionally with a subscript.
13733 * If gv is non-zero, use the name of that global, along with gvtype (one
13734 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13735 * targ. Depending on the value of the subscript_type flag, return:
13738 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13739 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13740 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13741 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13744 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13745 const SV *const keyname, I32 aindex, int subscript_type)
13748 SV * const name = sv_newmortal();
13751 buffer[0] = gvtype;
13754 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13756 gv_fullname4(name, gv, buffer, 0);
13758 if ((unsigned int)SvPVX(name)[1] <= 26) {
13760 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13762 /* Swap the 1 unprintable control character for the 2 byte pretty
13763 version - ie substr($name, 1, 1) = $buffer; */
13764 sv_insert(name, 1, 1, buffer, 2);
13768 CV * const cv = find_runcv(NULL);
13772 if (!cv || !CvPADLIST(cv))
13774 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13775 sv = *av_fetch(av, targ, FALSE);
13776 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
13779 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13780 SV * const sv = newSV(0);
13781 *SvPVX(name) = '$';
13782 Perl_sv_catpvf(aTHX_ name, "{%s}",
13783 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
13786 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13787 *SvPVX(name) = '$';
13788 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13790 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13791 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13792 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
13800 =for apidoc find_uninit_var
13802 Find the name of the undefined variable (if any) that caused the operator o
13803 to issue a "Use of uninitialized value" warning.
13804 If match is true, only return a name if it's value matches uninit_sv.
13805 So roughly speaking, if a unary operator (such as OP_COS) generates a
13806 warning, then following the direct child of the op may yield an
13807 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
13808 other hand, with OP_ADD there are two branches to follow, so we only print
13809 the variable name if we get an exact match.
13811 The name is returned as a mortal SV.
13813 Assumes that PL_op is the op that originally triggered the error, and that
13814 PL_comppad/PL_curpad points to the currently executing pad.
13820 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
13826 const OP *o, *o2, *kid;
13828 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
13829 uninit_sv == &PL_sv_placeholder)))
13832 switch (obase->op_type) {
13839 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
13840 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
13843 int subscript_type = FUV_SUBSCRIPT_WITHIN;
13845 if (pad) { /* @lex, %lex */
13846 sv = PAD_SVl(obase->op_targ);
13850 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13851 /* @global, %global */
13852 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13855 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
13857 else /* @{expr}, %{expr} */
13858 return find_uninit_var(cUNOPx(obase)->op_first,
13862 /* attempt to find a match within the aggregate */
13864 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13866 subscript_type = FUV_SUBSCRIPT_HASH;
13869 index = find_array_subscript((const AV *)sv, uninit_sv);
13871 subscript_type = FUV_SUBSCRIPT_ARRAY;
13874 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
13877 return varname(gv, hash ? '%' : '@', obase->op_targ,
13878 keysv, index, subscript_type);
13882 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
13884 return varname(NULL, '$', obase->op_targ,
13885 NULL, 0, FUV_SUBSCRIPT_NONE);
13888 gv = cGVOPx_gv(obase);
13889 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
13891 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
13894 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
13897 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
13898 if (!av || SvRMAGICAL(av))
13900 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13901 if (!svp || *svp != uninit_sv)
13904 return varname(NULL, '$', obase->op_targ,
13905 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13908 gv = cGVOPx_gv(obase);
13913 AV *const av = GvAV(gv);
13914 if (!av || SvRMAGICAL(av))
13916 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13917 if (!svp || *svp != uninit_sv)
13920 return varname(gv, '$', 0,
13921 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13926 o = cUNOPx(obase)->op_first;
13927 if (!o || o->op_type != OP_NULL ||
13928 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
13930 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
13934 if (PL_op == obase)
13935 /* $a[uninit_expr] or $h{uninit_expr} */
13936 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
13939 o = cBINOPx(obase)->op_first;
13940 kid = cBINOPx(obase)->op_last;
13942 /* get the av or hv, and optionally the gv */
13944 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
13945 sv = PAD_SV(o->op_targ);
13947 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
13948 && cUNOPo->op_first->op_type == OP_GV)
13950 gv = cGVOPx_gv(cUNOPo->op_first);
13954 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
13959 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
13960 /* index is constant */
13964 if (obase->op_type == OP_HELEM) {
13965 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
13966 if (!he || HeVAL(he) != uninit_sv)
13970 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
13971 if (!svp || *svp != uninit_sv)
13975 if (obase->op_type == OP_HELEM)
13976 return varname(gv, '%', o->op_targ,
13977 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
13979 return varname(gv, '@', o->op_targ, NULL,
13980 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
13983 /* index is an expression;
13984 * attempt to find a match within the aggregate */
13985 if (obase->op_type == OP_HELEM) {
13986 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13988 return varname(gv, '%', o->op_targ,
13989 keysv, 0, FUV_SUBSCRIPT_HASH);
13993 = find_array_subscript((const AV *)sv, uninit_sv);
13995 return varname(gv, '@', o->op_targ,
13996 NULL, index, FUV_SUBSCRIPT_ARRAY);
14001 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14003 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14008 /* only examine RHS */
14009 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14012 o = cUNOPx(obase)->op_first;
14013 if (o->op_type == OP_PUSHMARK)
14016 if (!o->op_sibling) {
14017 /* one-arg version of open is highly magical */
14019 if (o->op_type == OP_GV) { /* open FOO; */
14021 if (match && GvSV(gv) != uninit_sv)
14023 return varname(gv, '$', 0,
14024 NULL, 0, FUV_SUBSCRIPT_NONE);
14026 /* other possibilities not handled are:
14027 * open $x; or open my $x; should return '${*$x}'
14028 * open expr; should return '$'.expr ideally
14034 /* ops where $_ may be an implicit arg */
14038 if ( !(obase->op_flags & OPf_STACKED)) {
14039 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14040 ? PAD_SVl(obase->op_targ)
14043 sv = sv_newmortal();
14044 sv_setpvs(sv, "$_");
14053 match = 1; /* print etc can return undef on defined args */
14054 /* skip filehandle as it can't produce 'undef' warning */
14055 o = cUNOPx(obase)->op_first;
14056 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
14057 o = o->op_sibling->op_sibling;
14061 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14063 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14065 /* the following ops are capable of returning PL_sv_undef even for
14066 * defined arg(s) */
14085 case OP_GETPEERNAME:
14133 case OP_SMARTMATCH:
14142 /* XXX tmp hack: these two may call an XS sub, and currently
14143 XS subs don't have a SUB entry on the context stack, so CV and
14144 pad determination goes wrong, and BAD things happen. So, just
14145 don't try to determine the value under those circumstances.
14146 Need a better fix at dome point. DAPM 11/2007 */
14152 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14153 if (gv && GvSV(gv) == uninit_sv)
14154 return newSVpvs_flags("$.", SVs_TEMP);
14159 /* def-ness of rval pos() is independent of the def-ness of its arg */
14160 if ( !(obase->op_flags & OPf_MOD))
14165 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14166 return newSVpvs_flags("${$/}", SVs_TEMP);
14171 if (!(obase->op_flags & OPf_KIDS))
14173 o = cUNOPx(obase)->op_first;
14179 /* if all except one arg are constant, or have no side-effects,
14180 * or are optimized away, then it's unambiguous */
14182 for (kid=o; kid; kid = kid->op_sibling) {
14184 const OPCODE type = kid->op_type;
14185 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14186 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14187 || (type == OP_PUSHMARK)
14189 /* @$a and %$a, but not @a or %a */
14190 (type == OP_RV2AV || type == OP_RV2HV)
14191 && cUNOPx(kid)->op_first
14192 && cUNOPx(kid)->op_first->op_type != OP_GV
14197 if (o2) { /* more than one found */
14204 return find_uninit_var(o2, uninit_sv, match);
14206 /* scan all args */
14208 sv = find_uninit_var(o, uninit_sv, 1);
14220 =for apidoc report_uninit
14222 Print appropriate "Use of uninitialized variable" warning
14228 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14232 SV* varname = NULL;
14234 varname = find_uninit_var(PL_op, uninit_sv,0);
14236 sv_insert(varname, 0, 0, " ", 1);
14238 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14239 varname ? SvPV_nolen_const(varname) : "",
14240 " in ", OP_DESC(PL_op));
14243 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14249 * c-indentation-style: bsd
14250 * c-basic-offset: 4
14251 * indent-tabs-mode: t
14254 * ex: set ts=8 sts=4 sw=4 noet: