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 configuations (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 */
555 =for apidoc sv_clean_objs
557 Attempt to destroy all objects not yet freed
563 Perl_sv_clean_objs(pTHX)
567 PL_in_clean_objs = TRUE;
568 visit(do_clean_objs, SVf_ROK, SVf_ROK);
569 /* Some barnacles may yet remain, clinging to typeglobs.
570 * Run the non-IO destructors first: they may want to output
571 * error messages, close files etc */
572 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
573 visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
574 olddef = PL_defoutgv;
575 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
576 if (olddef && isGV_with_GP(olddef))
577 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
578 olderr = PL_stderrgv;
579 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
580 if (olderr && isGV_with_GP(olderr))
581 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
582 SvREFCNT_dec(olddef);
583 PL_in_clean_objs = FALSE;
586 /* called by sv_clean_all() for each live SV */
589 do_clean_all(pTHX_ SV *const sv)
592 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
593 /* don't clean pid table and strtab */
596 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
597 SvFLAGS(sv) |= SVf_BREAK;
602 =for apidoc sv_clean_all
604 Decrement the refcnt of each remaining SV, possibly triggering a
605 cleanup. This function may have to be called multiple times to free
606 SVs which are in complex self-referential hierarchies.
612 Perl_sv_clean_all(pTHX)
616 PL_in_clean_all = TRUE;
617 cleaned = visit(do_clean_all, 0,0);
622 ARENASETS: a meta-arena implementation which separates arena-info
623 into struct arena_set, which contains an array of struct
624 arena_descs, each holding info for a single arena. By separating
625 the meta-info from the arena, we recover the 1st slot, formerly
626 borrowed for list management. The arena_set is about the size of an
627 arena, avoiding the needless malloc overhead of a naive linked-list.
629 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
630 memory in the last arena-set (1/2 on average). In trade, we get
631 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
632 smaller types). The recovery of the wasted space allows use of
633 small arenas for large, rare body types, by changing array* fields
634 in body_details_by_type[] below.
637 char *arena; /* the raw storage, allocated aligned */
638 size_t size; /* its size ~4k typ */
639 svtype utype; /* bodytype stored in arena */
644 /* Get the maximum number of elements in set[] such that struct arena_set
645 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
646 therefore likely to be 1 aligned memory page. */
648 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
649 - 2 * sizeof(int)) / sizeof (struct arena_desc))
652 struct arena_set* next;
653 unsigned int set_size; /* ie ARENAS_PER_SET */
654 unsigned int curr; /* index of next available arena-desc */
655 struct arena_desc set[ARENAS_PER_SET];
659 =for apidoc sv_free_arenas
661 Deallocate the memory used by all arenas. Note that all the individual SV
662 heads and bodies within the arenas must already have been freed.
667 Perl_sv_free_arenas(pTHX)
674 /* Free arenas here, but be careful about fake ones. (We assume
675 contiguity of the fake ones with the corresponding real ones.) */
677 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
678 svanext = MUTABLE_SV(SvANY(sva));
679 while (svanext && SvFAKE(svanext))
680 svanext = MUTABLE_SV(SvANY(svanext));
687 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
690 struct arena_set *current = aroot;
693 assert(aroot->set[i].arena);
694 Safefree(aroot->set[i].arena);
702 i = PERL_ARENA_ROOTS_SIZE;
704 PL_body_roots[i] = 0;
711 Here are mid-level routines that manage the allocation of bodies out
712 of the various arenas. There are 5 kinds of arenas:
714 1. SV-head arenas, which are discussed and handled above
715 2. regular body arenas
716 3. arenas for reduced-size bodies
719 Arena types 2 & 3 are chained by body-type off an array of
720 arena-root pointers, which is indexed by svtype. Some of the
721 larger/less used body types are malloced singly, since a large
722 unused block of them is wasteful. Also, several svtypes dont have
723 bodies; the data fits into the sv-head itself. The arena-root
724 pointer thus has a few unused root-pointers (which may be hijacked
725 later for arena types 4,5)
727 3 differs from 2 as an optimization; some body types have several
728 unused fields in the front of the structure (which are kept in-place
729 for consistency). These bodies can be allocated in smaller chunks,
730 because the leading fields arent accessed. Pointers to such bodies
731 are decremented to point at the unused 'ghost' memory, knowing that
732 the pointers are used with offsets to the real memory.
735 =head1 SV-Body Allocation
737 Allocation of SV-bodies is similar to SV-heads, differing as follows;
738 the allocation mechanism is used for many body types, so is somewhat
739 more complicated, it uses arena-sets, and has no need for still-live
742 At the outermost level, (new|del)_X*V macros return bodies of the
743 appropriate type. These macros call either (new|del)_body_type or
744 (new|del)_body_allocated macro pairs, depending on specifics of the
745 type. Most body types use the former pair, the latter pair is used to
746 allocate body types with "ghost fields".
748 "ghost fields" are fields that are unused in certain types, and
749 consequently don't need to actually exist. They are declared because
750 they're part of a "base type", which allows use of functions as
751 methods. The simplest examples are AVs and HVs, 2 aggregate types
752 which don't use the fields which support SCALAR semantics.
754 For these types, the arenas are carved up into appropriately sized
755 chunks, we thus avoid wasted memory for those unaccessed members.
756 When bodies are allocated, we adjust the pointer back in memory by the
757 size of the part not allocated, so it's as if we allocated the full
758 structure. (But things will all go boom if you write to the part that
759 is "not there", because you'll be overwriting the last members of the
760 preceding structure in memory.)
762 We calculate the correction using the STRUCT_OFFSET macro on the first
763 member present. If the allocated structure is smaller (no initial NV
764 actually allocated) then the net effect is to subtract the size of the NV
765 from the pointer, to return a new pointer as if an initial NV were actually
766 allocated. (We were using structures named *_allocated for this, but
767 this turned out to be a subtle bug, because a structure without an NV
768 could have a lower alignment constraint, but the compiler is allowed to
769 optimised accesses based on the alignment constraint of the actual pointer
770 to the full structure, for example, using a single 64 bit load instruction
771 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
773 This is the same trick as was used for NV and IV bodies. Ironically it
774 doesn't need to be used for NV bodies any more, because NV is now at
775 the start of the structure. IV bodies don't need it either, because
776 they are no longer allocated.
778 In turn, the new_body_* allocators call S_new_body(), which invokes
779 new_body_inline macro, which takes a lock, and takes a body off the
780 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
781 necessary to refresh an empty list. Then the lock is released, and
782 the body is returned.
784 Perl_more_bodies allocates a new arena, and carves it up into an array of N
785 bodies, which it strings into a linked list. It looks up arena-size
786 and body-size from the body_details table described below, thus
787 supporting the multiple body-types.
789 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
790 the (new|del)_X*V macros are mapped directly to malloc/free.
792 For each sv-type, struct body_details bodies_by_type[] carries
793 parameters which control these aspects of SV handling:
795 Arena_size determines whether arenas are used for this body type, and if
796 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
797 zero, forcing individual mallocs and frees.
799 Body_size determines how big a body is, and therefore how many fit into
800 each arena. Offset carries the body-pointer adjustment needed for
801 "ghost fields", and is used in *_allocated macros.
803 But its main purpose is to parameterize info needed in
804 Perl_sv_upgrade(). The info here dramatically simplifies the function
805 vs the implementation in 5.8.8, making it table-driven. All fields
806 are used for this, except for arena_size.
808 For the sv-types that have no bodies, arenas are not used, so those
809 PL_body_roots[sv_type] are unused, and can be overloaded. In
810 something of a special case, SVt_NULL is borrowed for HE arenas;
811 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
812 bodies_by_type[SVt_NULL] slot is not used, as the table is not
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* Calculate the length to copy. Specifically work out the length less any
861 final padding the compiler needed to add. See the comment in sv_upgrade
862 for why copying the padding proved to be a bug. */
864 #define copy_length(type, last_member) \
865 STRUCT_OFFSET(type, last_member) \
866 + sizeof (((type*)SvANY((const SV *)0))->last_member)
868 static const struct body_details bodies_by_type[] = {
869 /* HEs use this offset for their arena. */
870 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
872 /* The bind placeholder pretends to be an RV for now.
873 Also it's marked as "can't upgrade" to stop anyone using it before it's
875 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
877 /* IVs are in the head, so the allocation size is 0. */
879 sizeof(IV), /* This is used to copy out the IV body. */
880 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
881 NOARENA /* IVS don't need an arena */, 0
884 /* 8 bytes on most ILP32 with IEEE doubles */
885 { sizeof(NV), sizeof(NV),
886 STRUCT_OFFSET(XPVNV, xnv_u),
887 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
889 /* 8 bytes on most ILP32 with IEEE doubles */
890 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
891 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
892 + STRUCT_OFFSET(XPV, xpv_cur),
893 SVt_PV, FALSE, NONV, HASARENA,
894 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
897 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
898 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
899 + STRUCT_OFFSET(XPV, xpv_cur),
900 SVt_PVIV, FALSE, NONV, HASARENA,
901 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
904 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
905 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
906 + STRUCT_OFFSET(XPV, xpv_cur),
907 SVt_PVNV, FALSE, HADNV, HASARENA,
908 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
911 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
912 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
918 SVt_REGEXP, FALSE, NONV, HASARENA,
919 FIT_ARENA(0, sizeof(regexp))
923 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
924 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
927 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
931 copy_length(XPVAV, xav_alloc),
933 SVt_PVAV, TRUE, NONV, HASARENA,
934 FIT_ARENA(0, sizeof(XPVAV)) },
937 copy_length(XPVHV, xhv_max),
939 SVt_PVHV, TRUE, NONV, HASARENA,
940 FIT_ARENA(0, sizeof(XPVHV)) },
946 SVt_PVCV, TRUE, NONV, HASARENA,
947 FIT_ARENA(0, sizeof(XPVCV)) },
952 SVt_PVFM, TRUE, NONV, NOARENA,
953 FIT_ARENA(20, sizeof(XPVFM)) },
955 /* XPVIO is 84 bytes, fits 48x */
959 SVt_PVIO, TRUE, NONV, HASARENA,
960 FIT_ARENA(24, sizeof(XPVIO)) },
963 #define new_body_allocated(sv_type) \
964 (void *)((char *)S_new_body(aTHX_ sv_type) \
965 - bodies_by_type[sv_type].offset)
967 /* return a thing to the free list */
969 #define del_body(thing, root) \
971 void ** const thing_copy = (void **)thing; \
972 *thing_copy = *root; \
973 *root = (void*)thing_copy; \
978 #define new_XNV() safemalloc(sizeof(XPVNV))
979 #define new_XPVNV() safemalloc(sizeof(XPVNV))
980 #define new_XPVMG() safemalloc(sizeof(XPVMG))
982 #define del_XPVGV(p) safefree(p)
986 #define new_XNV() new_body_allocated(SVt_NV)
987 #define new_XPVNV() new_body_allocated(SVt_PVNV)
988 #define new_XPVMG() new_body_allocated(SVt_PVMG)
990 #define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
991 &PL_body_roots[SVt_PVGV])
995 /* no arena for you! */
997 #define new_NOARENA(details) \
998 safemalloc((details)->body_size + (details)->offset)
999 #define new_NOARENAZ(details) \
1000 safecalloc((details)->body_size + (details)->offset, 1)
1003 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1004 const size_t arena_size)
1007 void ** const root = &PL_body_roots[sv_type];
1008 struct arena_desc *adesc;
1009 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1013 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1014 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1015 static bool done_sanity_check;
1017 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1018 * variables like done_sanity_check. */
1019 if (!done_sanity_check) {
1020 unsigned int i = SVt_LAST;
1022 done_sanity_check = TRUE;
1025 assert (bodies_by_type[i].type == i);
1031 /* may need new arena-set to hold new arena */
1032 if (!aroot || aroot->curr >= aroot->set_size) {
1033 struct arena_set *newroot;
1034 Newxz(newroot, 1, struct arena_set);
1035 newroot->set_size = ARENAS_PER_SET;
1036 newroot->next = aroot;
1038 PL_body_arenas = (void *) newroot;
1039 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1042 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1043 curr = aroot->curr++;
1044 adesc = &(aroot->set[curr]);
1045 assert(!adesc->arena);
1047 Newx(adesc->arena, good_arena_size, char);
1048 adesc->size = good_arena_size;
1049 adesc->utype = sv_type;
1050 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1051 curr, (void*)adesc->arena, (UV)good_arena_size));
1053 start = (char *) adesc->arena;
1055 /* Get the address of the byte after the end of the last body we can fit.
1056 Remember, this is integer division: */
1057 end = start + good_arena_size / body_size * body_size;
1059 /* computed count doesnt reflect the 1st slot reservation */
1060 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1061 DEBUG_m(PerlIO_printf(Perl_debug_log,
1062 "arena %p end %p arena-size %d (from %d) type %d "
1064 (void*)start, (void*)end, (int)good_arena_size,
1065 (int)arena_size, sv_type, (int)body_size,
1066 (int)good_arena_size / (int)body_size));
1068 DEBUG_m(PerlIO_printf(Perl_debug_log,
1069 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1070 (void*)start, (void*)end,
1071 (int)arena_size, sv_type, (int)body_size,
1072 (int)good_arena_size / (int)body_size));
1074 *root = (void *)start;
1077 /* Where the next body would start: */
1078 char * const next = start + body_size;
1081 /* This is the last body: */
1082 assert(next == end);
1084 *(void **)start = 0;
1088 *(void**) start = (void *)next;
1093 /* grab a new thing from the free list, allocating more if necessary.
1094 The inline version is used for speed in hot routines, and the
1095 function using it serves the rest (unless PURIFY).
1097 #define new_body_inline(xpv, sv_type) \
1099 void ** const r3wt = &PL_body_roots[sv_type]; \
1100 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1101 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1102 bodies_by_type[sv_type].body_size,\
1103 bodies_by_type[sv_type].arena_size)); \
1104 *(r3wt) = *(void**)(xpv); \
1110 S_new_body(pTHX_ const svtype sv_type)
1114 new_body_inline(xpv, sv_type);
1120 static const struct body_details fake_rv =
1121 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1124 =for apidoc sv_upgrade
1126 Upgrade an SV to a more complex form. Generally adds a new body type to the
1127 SV, then copies across as much information as possible from the old body.
1128 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1134 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1139 const svtype old_type = SvTYPE(sv);
1140 const struct body_details *new_type_details;
1141 const struct body_details *old_type_details
1142 = bodies_by_type + old_type;
1143 SV *referant = NULL;
1145 PERL_ARGS_ASSERT_SV_UPGRADE;
1147 if (old_type == new_type)
1150 /* This clause was purposefully added ahead of the early return above to
1151 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1152 inference by Nick I-S that it would fix other troublesome cases. See
1153 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1155 Given that shared hash key scalars are no longer PVIV, but PV, there is
1156 no longer need to unshare so as to free up the IVX slot for its proper
1157 purpose. So it's safe to move the early return earlier. */
1159 if (new_type != SVt_PV && SvIsCOW(sv)) {
1160 sv_force_normal_flags(sv, 0);
1163 old_body = SvANY(sv);
1165 /* Copying structures onto other structures that have been neatly zeroed
1166 has a subtle gotcha. Consider XPVMG
1168 +------+------+------+------+------+-------+-------+
1169 | NV | CUR | LEN | IV | MAGIC | STASH |
1170 +------+------+------+------+------+-------+-------+
1171 0 4 8 12 16 20 24 28
1173 where NVs are aligned to 8 bytes, so that sizeof that structure is
1174 actually 32 bytes long, with 4 bytes of padding at the end:
1176 +------+------+------+------+------+-------+-------+------+
1177 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1178 +------+------+------+------+------+-------+-------+------+
1179 0 4 8 12 16 20 24 28 32
1181 so what happens if you allocate memory for this structure:
1183 +------+------+------+------+------+-------+-------+------+------+...
1184 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1185 +------+------+------+------+------+-------+-------+------+------+...
1186 0 4 8 12 16 20 24 28 32 36
1188 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1189 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1190 started out as zero once, but it's quite possible that it isn't. So now,
1191 rather than a nicely zeroed GP, you have it pointing somewhere random.
1194 (In fact, GP ends up pointing at a previous GP structure, because the
1195 principle cause of the padding in XPVMG getting garbage is a copy of
1196 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1197 this happens to be moot because XPVGV has been re-ordered, with GP
1198 no longer after STASH)
1200 So we are careful and work out the size of used parts of all the
1208 referant = SvRV(sv);
1209 old_type_details = &fake_rv;
1210 if (new_type == SVt_NV)
1211 new_type = SVt_PVNV;
1213 if (new_type < SVt_PVIV) {
1214 new_type = (new_type == SVt_NV)
1215 ? SVt_PVNV : SVt_PVIV;
1220 if (new_type < SVt_PVNV) {
1221 new_type = SVt_PVNV;
1225 assert(new_type > SVt_PV);
1226 assert(SVt_IV < SVt_PV);
1227 assert(SVt_NV < SVt_PV);
1234 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1235 there's no way that it can be safely upgraded, because perl.c
1236 expects to Safefree(SvANY(PL_mess_sv)) */
1237 assert(sv != PL_mess_sv);
1238 /* This flag bit is used to mean other things in other scalar types.
1239 Given that it only has meaning inside the pad, it shouldn't be set
1240 on anything that can get upgraded. */
1241 assert(!SvPAD_TYPED(sv));
1244 if (old_type_details->cant_upgrade)
1245 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1246 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1249 if (old_type > new_type)
1250 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1251 (int)old_type, (int)new_type);
1253 new_type_details = bodies_by_type + new_type;
1255 SvFLAGS(sv) &= ~SVTYPEMASK;
1256 SvFLAGS(sv) |= new_type;
1258 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1259 the return statements above will have triggered. */
1260 assert (new_type != SVt_NULL);
1263 assert(old_type == SVt_NULL);
1264 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1268 assert(old_type == SVt_NULL);
1269 SvANY(sv) = new_XNV();
1274 assert(new_type_details->body_size);
1277 assert(new_type_details->arena);
1278 assert(new_type_details->arena_size);
1279 /* This points to the start of the allocated area. */
1280 new_body_inline(new_body, new_type);
1281 Zero(new_body, new_type_details->body_size, char);
1282 new_body = ((char *)new_body) - new_type_details->offset;
1284 /* We always allocated the full length item with PURIFY. To do this
1285 we fake things so that arena is false for all 16 types.. */
1286 new_body = new_NOARENAZ(new_type_details);
1288 SvANY(sv) = new_body;
1289 if (new_type == SVt_PVAV) {
1293 if (old_type_details->body_size) {
1296 /* It will have been zeroed when the new body was allocated.
1297 Lets not write to it, in case it confuses a write-back
1303 #ifndef NODEFAULT_SHAREKEYS
1304 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1306 HvMAX(sv) = 7; /* (start with 8 buckets) */
1309 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1310 The target created by newSVrv also is, and it can have magic.
1311 However, it never has SvPVX set.
1313 if (old_type == SVt_IV) {
1315 } else if (old_type >= SVt_PV) {
1316 assert(SvPVX_const(sv) == 0);
1319 if (old_type >= SVt_PVMG) {
1320 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1321 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1323 sv->sv_u.svu_array = NULL; /* or svu_hash */
1329 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
1330 sv_force_normal_flags(sv) is called. */
1333 /* XXX Is this still needed? Was it ever needed? Surely as there is
1334 no route from NV to PVIV, NOK can never be true */
1335 assert(!SvNOKp(sv));
1346 assert(new_type_details->body_size);
1347 /* We always allocated the full length item with PURIFY. To do this
1348 we fake things so that arena is false for all 16 types.. */
1349 if(new_type_details->arena) {
1350 /* This points to the start of the allocated area. */
1351 new_body_inline(new_body, new_type);
1352 Zero(new_body, new_type_details->body_size, char);
1353 new_body = ((char *)new_body) - new_type_details->offset;
1355 new_body = new_NOARENAZ(new_type_details);
1357 SvANY(sv) = new_body;
1359 if (old_type_details->copy) {
1360 /* There is now the potential for an upgrade from something without
1361 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1362 int offset = old_type_details->offset;
1363 int length = old_type_details->copy;
1365 if (new_type_details->offset > old_type_details->offset) {
1366 const int difference
1367 = new_type_details->offset - old_type_details->offset;
1368 offset += difference;
1369 length -= difference;
1371 assert (length >= 0);
1373 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1378 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1379 * correct 0.0 for us. Otherwise, if the old body didn't have an
1380 * NV slot, but the new one does, then we need to initialise the
1381 * freshly created NV slot with whatever the correct bit pattern is
1383 if (old_type_details->zero_nv && !new_type_details->zero_nv
1384 && !isGV_with_GP(sv))
1388 if (new_type == SVt_PVIO) {
1389 IO * const io = MUTABLE_IO(sv);
1390 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1393 /* Clear the stashcache because a new IO could overrule a package
1395 hv_clear(PL_stashcache);
1397 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1398 IoPAGE_LEN(sv) = 60;
1400 if (old_type < SVt_PV) {
1401 /* referant will be NULL unless the old type was SVt_IV emulating
1403 sv->sv_u.svu_rv = referant;
1407 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1408 (unsigned long)new_type);
1411 if (old_type > SVt_IV) {
1415 /* Note that there is an assumption that all bodies of types that
1416 can be upgraded came from arenas. Only the more complex non-
1417 upgradable types are allowed to be directly malloc()ed. */
1418 assert(old_type_details->arena);
1419 del_body((void*)((char*)old_body + old_type_details->offset),
1420 &PL_body_roots[old_type]);
1426 =for apidoc sv_backoff
1428 Remove any string offset. You should normally use the C<SvOOK_off> macro
1435 Perl_sv_backoff(pTHX_ register SV *const sv)
1438 const char * const s = SvPVX_const(sv);
1440 PERL_ARGS_ASSERT_SV_BACKOFF;
1441 PERL_UNUSED_CONTEXT;
1444 assert(SvTYPE(sv) != SVt_PVHV);
1445 assert(SvTYPE(sv) != SVt_PVAV);
1447 SvOOK_offset(sv, delta);
1449 SvLEN_set(sv, SvLEN(sv) + delta);
1450 SvPV_set(sv, SvPVX(sv) - delta);
1451 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1452 SvFLAGS(sv) &= ~SVf_OOK;
1459 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1460 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1461 Use the C<SvGROW> wrapper instead.
1467 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1471 PERL_ARGS_ASSERT_SV_GROW;
1473 if (PL_madskills && newlen >= 0x100000) {
1474 PerlIO_printf(Perl_debug_log,
1475 "Allocation too large: %"UVxf"\n", (UV)newlen);
1477 #ifdef HAS_64K_LIMIT
1478 if (newlen >= 0x10000) {
1479 PerlIO_printf(Perl_debug_log,
1480 "Allocation too large: %"UVxf"\n", (UV)newlen);
1483 #endif /* HAS_64K_LIMIT */
1486 if (SvTYPE(sv) < SVt_PV) {
1487 sv_upgrade(sv, SVt_PV);
1488 s = SvPVX_mutable(sv);
1490 else if (SvOOK(sv)) { /* pv is offset? */
1492 s = SvPVX_mutable(sv);
1493 if (newlen > SvLEN(sv))
1494 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1495 #ifdef HAS_64K_LIMIT
1496 if (newlen >= 0x10000)
1501 s = SvPVX_mutable(sv);
1503 if (newlen > SvLEN(sv)) { /* need more room? */
1504 STRLEN minlen = SvCUR(sv);
1505 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1506 if (newlen < minlen)
1508 #ifndef Perl_safesysmalloc_size
1509 newlen = PERL_STRLEN_ROUNDUP(newlen);
1511 if (SvLEN(sv) && s) {
1512 s = (char*)saferealloc(s, newlen);
1515 s = (char*)safemalloc(newlen);
1516 if (SvPVX_const(sv) && SvCUR(sv)) {
1517 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1521 #ifdef Perl_safesysmalloc_size
1522 /* Do this here, do it once, do it right, and then we will never get
1523 called back into sv_grow() unless there really is some growing
1525 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1527 SvLEN_set(sv, newlen);
1534 =for apidoc sv_setiv
1536 Copies an integer into the given SV, upgrading first if necessary.
1537 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1543 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1547 PERL_ARGS_ASSERT_SV_SETIV;
1549 SV_CHECK_THINKFIRST_COW_DROP(sv);
1550 switch (SvTYPE(sv)) {
1553 sv_upgrade(sv, SVt_IV);
1556 sv_upgrade(sv, SVt_PVIV);
1560 if (!isGV_with_GP(sv))
1567 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1571 (void)SvIOK_only(sv); /* validate number */
1577 =for apidoc sv_setiv_mg
1579 Like C<sv_setiv>, but also handles 'set' magic.
1585 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1587 PERL_ARGS_ASSERT_SV_SETIV_MG;
1594 =for apidoc sv_setuv
1596 Copies an unsigned integer into the given SV, upgrading first if necessary.
1597 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1603 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1605 PERL_ARGS_ASSERT_SV_SETUV;
1607 /* With these two if statements:
1608 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1611 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1613 If you wish to remove them, please benchmark to see what the effect is
1615 if (u <= (UV)IV_MAX) {
1616 sv_setiv(sv, (IV)u);
1625 =for apidoc sv_setuv_mg
1627 Like C<sv_setuv>, but also handles 'set' magic.
1633 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1635 PERL_ARGS_ASSERT_SV_SETUV_MG;
1642 =for apidoc sv_setnv
1644 Copies a double into the given SV, upgrading first if necessary.
1645 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1651 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1655 PERL_ARGS_ASSERT_SV_SETNV;
1657 SV_CHECK_THINKFIRST_COW_DROP(sv);
1658 switch (SvTYPE(sv)) {
1661 sv_upgrade(sv, SVt_NV);
1665 sv_upgrade(sv, SVt_PVNV);
1669 if (!isGV_with_GP(sv))
1676 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1681 (void)SvNOK_only(sv); /* validate number */
1686 =for apidoc sv_setnv_mg
1688 Like C<sv_setnv>, but also handles 'set' magic.
1694 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1696 PERL_ARGS_ASSERT_SV_SETNV_MG;
1702 /* Print an "isn't numeric" warning, using a cleaned-up,
1703 * printable version of the offending string
1707 S_not_a_number(pTHX_ SV *const sv)
1714 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1717 dsv = newSVpvs_flags("", SVs_TEMP);
1718 pv = sv_uni_display(dsv, sv, 10, 0);
1721 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1722 /* each *s can expand to 4 chars + "...\0",
1723 i.e. need room for 8 chars */
1725 const char *s = SvPVX_const(sv);
1726 const char * const end = s + SvCUR(sv);
1727 for ( ; s < end && d < limit; s++ ) {
1729 if (ch & 128 && !isPRINT_LC(ch)) {
1738 else if (ch == '\r') {
1742 else if (ch == '\f') {
1746 else if (ch == '\\') {
1750 else if (ch == '\0') {
1754 else if (isPRINT_LC(ch))
1771 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1772 "Argument \"%s\" isn't numeric in %s", pv,
1775 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1776 "Argument \"%s\" isn't numeric", pv);
1780 =for apidoc looks_like_number
1782 Test if the content of an SV looks like a number (or is a number).
1783 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1784 non-numeric warning), even if your atof() doesn't grok them.
1790 Perl_looks_like_number(pTHX_ SV *const sv)
1792 register const char *sbegin;
1795 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1798 sbegin = SvPVX_const(sv);
1801 else if (SvPOKp(sv))
1802 sbegin = SvPV_const(sv, len);
1804 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1805 return grok_number(sbegin, len, NULL);
1809 S_glob_2number(pTHX_ GV * const gv)
1811 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1812 SV *const buffer = sv_newmortal();
1814 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1816 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1819 gv_efullname3(buffer, gv, "*");
1820 SvFLAGS(gv) |= wasfake;
1822 /* We know that all GVs stringify to something that is not-a-number,
1823 so no need to test that. */
1824 if (ckWARN(WARN_NUMERIC))
1825 not_a_number(buffer);
1826 /* We just want something true to return, so that S_sv_2iuv_common
1827 can tail call us and return true. */
1831 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1832 until proven guilty, assume that things are not that bad... */
1837 As 64 bit platforms often have an NV that doesn't preserve all bits of
1838 an IV (an assumption perl has been based on to date) it becomes necessary
1839 to remove the assumption that the NV always carries enough precision to
1840 recreate the IV whenever needed, and that the NV is the canonical form.
1841 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1842 precision as a side effect of conversion (which would lead to insanity
1843 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1844 1) to distinguish between IV/UV/NV slots that have cached a valid
1845 conversion where precision was lost and IV/UV/NV slots that have a
1846 valid conversion which has lost no precision
1847 2) to ensure that if a numeric conversion to one form is requested that
1848 would lose precision, the precise conversion (or differently
1849 imprecise conversion) is also performed and cached, to prevent
1850 requests for different numeric formats on the same SV causing
1851 lossy conversion chains. (lossless conversion chains are perfectly
1856 SvIOKp is true if the IV slot contains a valid value
1857 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1858 SvNOKp is true if the NV slot contains a valid value
1859 SvNOK is true only if the NV value is accurate
1862 while converting from PV to NV, check to see if converting that NV to an
1863 IV(or UV) would lose accuracy over a direct conversion from PV to
1864 IV(or UV). If it would, cache both conversions, return NV, but mark
1865 SV as IOK NOKp (ie not NOK).
1867 While converting from PV to IV, check to see if converting that IV to an
1868 NV would lose accuracy over a direct conversion from PV to NV. If it
1869 would, cache both conversions, flag similarly.
1871 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1872 correctly because if IV & NV were set NV *always* overruled.
1873 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1874 changes - now IV and NV together means that the two are interchangeable:
1875 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1877 The benefit of this is that operations such as pp_add know that if
1878 SvIOK is true for both left and right operands, then integer addition
1879 can be used instead of floating point (for cases where the result won't
1880 overflow). Before, floating point was always used, which could lead to
1881 loss of precision compared with integer addition.
1883 * making IV and NV equal status should make maths accurate on 64 bit
1885 * may speed up maths somewhat if pp_add and friends start to use
1886 integers when possible instead of fp. (Hopefully the overhead in
1887 looking for SvIOK and checking for overflow will not outweigh the
1888 fp to integer speedup)
1889 * will slow down integer operations (callers of SvIV) on "inaccurate"
1890 values, as the change from SvIOK to SvIOKp will cause a call into
1891 sv_2iv each time rather than a macro access direct to the IV slot
1892 * should speed up number->string conversion on integers as IV is
1893 favoured when IV and NV are equally accurate
1895 ####################################################################
1896 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1897 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1898 On the other hand, SvUOK is true iff UV.
1899 ####################################################################
1901 Your mileage will vary depending your CPU's relative fp to integer
1905 #ifndef NV_PRESERVES_UV
1906 # define IS_NUMBER_UNDERFLOW_IV 1
1907 # define IS_NUMBER_UNDERFLOW_UV 2
1908 # define IS_NUMBER_IV_AND_UV 2
1909 # define IS_NUMBER_OVERFLOW_IV 4
1910 # define IS_NUMBER_OVERFLOW_UV 5
1912 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1914 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1916 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1924 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1926 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1927 if (SvNVX(sv) < (NV)IV_MIN) {
1928 (void)SvIOKp_on(sv);
1930 SvIV_set(sv, IV_MIN);
1931 return IS_NUMBER_UNDERFLOW_IV;
1933 if (SvNVX(sv) > (NV)UV_MAX) {
1934 (void)SvIOKp_on(sv);
1937 SvUV_set(sv, UV_MAX);
1938 return IS_NUMBER_OVERFLOW_UV;
1940 (void)SvIOKp_on(sv);
1942 /* Can't use strtol etc to convert this string. (See truth table in
1944 if (SvNVX(sv) <= (UV)IV_MAX) {
1945 SvIV_set(sv, I_V(SvNVX(sv)));
1946 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1947 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1949 /* Integer is imprecise. NOK, IOKp */
1951 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1954 SvUV_set(sv, U_V(SvNVX(sv)));
1955 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1956 if (SvUVX(sv) == UV_MAX) {
1957 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1958 possibly be preserved by NV. Hence, it must be overflow.
1960 return IS_NUMBER_OVERFLOW_UV;
1962 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1964 /* Integer is imprecise. NOK, IOKp */
1966 return IS_NUMBER_OVERFLOW_IV;
1968 #endif /* !NV_PRESERVES_UV*/
1971 S_sv_2iuv_common(pTHX_ SV *const sv)
1975 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1978 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1979 * without also getting a cached IV/UV from it at the same time
1980 * (ie PV->NV conversion should detect loss of accuracy and cache
1981 * IV or UV at same time to avoid this. */
1982 /* IV-over-UV optimisation - choose to cache IV if possible */
1984 if (SvTYPE(sv) == SVt_NV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1988 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1989 certainly cast into the IV range at IV_MAX, whereas the correct
1990 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1992 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1993 if (Perl_isnan(SvNVX(sv))) {
1999 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2000 SvIV_set(sv, I_V(SvNVX(sv)));
2001 if (SvNVX(sv) == (NV) SvIVX(sv)
2002 #ifndef NV_PRESERVES_UV
2003 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2004 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2005 /* Don't flag it as "accurately an integer" if the number
2006 came from a (by definition imprecise) NV operation, and
2007 we're outside the range of NV integer precision */
2011 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2013 /* scalar has trailing garbage, eg "42a" */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2022 /* IV not precise. No need to convert from PV, as NV
2023 conversion would already have cached IV if it detected
2024 that PV->IV would be better than PV->NV->IV
2025 flags already correct - don't set public IOK. */
2026 DEBUG_c(PerlIO_printf(Perl_debug_log,
2027 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2032 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2033 but the cast (NV)IV_MIN rounds to a the value less (more
2034 negative) than IV_MIN which happens to be equal to SvNVX ??
2035 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2036 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2037 (NV)UVX == NVX are both true, but the values differ. :-(
2038 Hopefully for 2s complement IV_MIN is something like
2039 0x8000000000000000 which will be exact. NWC */
2042 SvUV_set(sv, U_V(SvNVX(sv)));
2044 (SvNVX(sv) == (NV) SvUVX(sv))
2045 #ifndef NV_PRESERVES_UV
2046 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2047 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2048 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2049 /* Don't flag it as "accurately an integer" if the number
2050 came from a (by definition imprecise) NV operation, and
2051 we're outside the range of NV integer precision */
2057 DEBUG_c(PerlIO_printf(Perl_debug_log,
2058 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2064 else if (SvPOKp(sv) && SvLEN(sv)) {
2066 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2067 /* We want to avoid a possible problem when we cache an IV/ a UV which
2068 may be later translated to an NV, and the resulting NV is not
2069 the same as the direct translation of the initial string
2070 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2071 be careful to ensure that the value with the .456 is around if the
2072 NV value is requested in the future).
2074 This means that if we cache such an IV/a UV, we need to cache the
2075 NV as well. Moreover, we trade speed for space, and do not
2076 cache the NV if we are sure it's not needed.
2079 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2080 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2081 == IS_NUMBER_IN_UV) {
2082 /* It's definitely an integer, only upgrade to PVIV */
2083 if (SvTYPE(sv) < SVt_PVIV)
2084 sv_upgrade(sv, SVt_PVIV);
2086 } else if (SvTYPE(sv) < SVt_PVNV)
2087 sv_upgrade(sv, SVt_PVNV);
2089 /* If NVs preserve UVs then we only use the UV value if we know that
2090 we aren't going to call atof() below. If NVs don't preserve UVs
2091 then the value returned may have more precision than atof() will
2092 return, even though value isn't perfectly accurate. */
2093 if ((numtype & (IS_NUMBER_IN_UV
2094 #ifdef NV_PRESERVES_UV
2097 )) == IS_NUMBER_IN_UV) {
2098 /* This won't turn off the public IOK flag if it was set above */
2099 (void)SvIOKp_on(sv);
2101 if (!(numtype & IS_NUMBER_NEG)) {
2103 if (value <= (UV)IV_MAX) {
2104 SvIV_set(sv, (IV)value);
2106 /* it didn't overflow, and it was positive. */
2107 SvUV_set(sv, value);
2111 /* 2s complement assumption */
2112 if (value <= (UV)IV_MIN) {
2113 SvIV_set(sv, -(IV)value);
2115 /* Too negative for an IV. This is a double upgrade, but
2116 I'm assuming it will be rare. */
2117 if (SvTYPE(sv) < SVt_PVNV)
2118 sv_upgrade(sv, SVt_PVNV);
2122 SvNV_set(sv, -(NV)value);
2123 SvIV_set(sv, IV_MIN);
2127 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2128 will be in the previous block to set the IV slot, and the next
2129 block to set the NV slot. So no else here. */
2131 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2132 != IS_NUMBER_IN_UV) {
2133 /* It wasn't an (integer that doesn't overflow the UV). */
2134 SvNV_set(sv, Atof(SvPVX_const(sv)));
2136 if (! numtype && ckWARN(WARN_NUMERIC))
2139 #if defined(USE_LONG_DOUBLE)
2140 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2141 PTR2UV(sv), SvNVX(sv)));
2143 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2144 PTR2UV(sv), SvNVX(sv)));
2147 #ifdef NV_PRESERVES_UV
2148 (void)SvIOKp_on(sv);
2150 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2151 SvIV_set(sv, I_V(SvNVX(sv)));
2152 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2155 NOOP; /* Integer is imprecise. NOK, IOKp */
2157 /* UV will not work better than IV */
2159 if (SvNVX(sv) > (NV)UV_MAX) {
2161 /* Integer is inaccurate. NOK, IOKp, is UV */
2162 SvUV_set(sv, UV_MAX);
2164 SvUV_set(sv, U_V(SvNVX(sv)));
2165 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2166 NV preservse UV so can do correct comparison. */
2167 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2170 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2175 #else /* NV_PRESERVES_UV */
2176 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2177 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2178 /* The IV/UV slot will have been set from value returned by
2179 grok_number above. The NV slot has just been set using
2182 assert (SvIOKp(sv));
2184 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2185 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2186 /* Small enough to preserve all bits. */
2187 (void)SvIOKp_on(sv);
2189 SvIV_set(sv, I_V(SvNVX(sv)));
2190 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2192 /* Assumption: first non-preserved integer is < IV_MAX,
2193 this NV is in the preserved range, therefore: */
2194 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2196 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2200 0 0 already failed to read UV.
2201 0 1 already failed to read UV.
2202 1 0 you won't get here in this case. IV/UV
2203 slot set, public IOK, Atof() unneeded.
2204 1 1 already read UV.
2205 so there's no point in sv_2iuv_non_preserve() attempting
2206 to use atol, strtol, strtoul etc. */
2208 sv_2iuv_non_preserve (sv, numtype);
2210 sv_2iuv_non_preserve (sv);
2214 #endif /* NV_PRESERVES_UV */
2215 /* It might be more code efficient to go through the entire logic above
2216 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2217 gets complex and potentially buggy, so more programmer efficient
2218 to do it this way, by turning off the public flags: */
2220 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2224 if (isGV_with_GP(sv))
2225 return glob_2number(MUTABLE_GV(sv));
2227 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2228 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2231 if (SvTYPE(sv) < SVt_IV)
2232 /* Typically the caller expects that sv_any is not NULL now. */
2233 sv_upgrade(sv, SVt_IV);
2234 /* Return 0 from the caller. */
2241 =for apidoc sv_2iv_flags
2243 Return the integer value of an SV, doing any necessary string
2244 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2245 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2251 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2256 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2257 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2258 cache IVs just in case. In practice it seems that they never
2259 actually anywhere accessible by user Perl code, let alone get used
2260 in anything other than a string context. */
2261 if (flags & SV_GMAGIC)
2266 return I_V(SvNVX(sv));
2268 if (SvPOKp(sv) && SvLEN(sv)) {
2271 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2273 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2274 == IS_NUMBER_IN_UV) {
2275 /* It's definitely an integer */
2276 if (numtype & IS_NUMBER_NEG) {
2277 if (value < (UV)IV_MIN)
2280 if (value < (UV)IV_MAX)
2285 if (ckWARN(WARN_NUMERIC))
2288 return I_V(Atof(SvPVX_const(sv)));
2293 assert(SvTYPE(sv) >= SVt_PVMG);
2294 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2295 } else if (SvTHINKFIRST(sv)) {
2300 if (flags & SV_SKIP_OVERLOAD)
2302 tmpstr = AMG_CALLunary(sv, numer_amg);
2303 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2304 return SvIV(tmpstr);
2307 return PTR2IV(SvRV(sv));
2310 sv_force_normal_flags(sv, 0);
2312 if (SvREADONLY(sv) && !SvOK(sv)) {
2313 if (ckWARN(WARN_UNINITIALIZED))
2319 if (S_sv_2iuv_common(aTHX_ sv))
2322 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2323 PTR2UV(sv),SvIVX(sv)));
2324 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2328 =for apidoc sv_2uv_flags
2330 Return the unsigned integer value of an SV, doing any necessary string
2331 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2332 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2338 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2343 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2344 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2345 cache IVs just in case. */
2346 if (flags & SV_GMAGIC)
2351 return U_V(SvNVX(sv));
2352 if (SvPOKp(sv) && SvLEN(sv)) {
2355 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2357 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2358 == IS_NUMBER_IN_UV) {
2359 /* It's definitely an integer */
2360 if (!(numtype & IS_NUMBER_NEG))
2364 if (ckWARN(WARN_NUMERIC))
2367 return U_V(Atof(SvPVX_const(sv)));
2372 assert(SvTYPE(sv) >= SVt_PVMG);
2373 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2374 } else if (SvTHINKFIRST(sv)) {
2379 if (flags & SV_SKIP_OVERLOAD)
2381 tmpstr = AMG_CALLunary(sv, numer_amg);
2382 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2383 return SvUV(tmpstr);
2386 return PTR2UV(SvRV(sv));
2389 sv_force_normal_flags(sv, 0);
2391 if (SvREADONLY(sv) && !SvOK(sv)) {
2392 if (ckWARN(WARN_UNINITIALIZED))
2398 if (S_sv_2iuv_common(aTHX_ sv))
2402 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2403 PTR2UV(sv),SvUVX(sv)));
2404 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2408 =for apidoc sv_2nv_flags
2410 Return the num value of an SV, doing any necessary string or integer
2411 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2412 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2418 Perl_sv_2nv_flags(pTHX_ register SV *const sv, const I32 flags)
2423 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2424 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2425 cache IVs just in case. */
2426 if (flags & SV_GMAGIC)
2430 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2431 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2432 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2434 return Atof(SvPVX_const(sv));
2438 return (NV)SvUVX(sv);
2440 return (NV)SvIVX(sv);
2445 assert(SvTYPE(sv) >= SVt_PVMG);
2446 /* This falls through to the report_uninit near the end of the
2448 } else if (SvTHINKFIRST(sv)) {
2453 if (flags & SV_SKIP_OVERLOAD)
2455 tmpstr = AMG_CALLunary(sv, numer_amg);
2456 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2457 return SvNV(tmpstr);
2460 return PTR2NV(SvRV(sv));
2463 sv_force_normal_flags(sv, 0);
2465 if (SvREADONLY(sv) && !SvOK(sv)) {
2466 if (ckWARN(WARN_UNINITIALIZED))
2471 if (SvTYPE(sv) < SVt_NV) {
2472 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2473 sv_upgrade(sv, SVt_NV);
2474 #ifdef USE_LONG_DOUBLE
2476 STORE_NUMERIC_LOCAL_SET_STANDARD();
2477 PerlIO_printf(Perl_debug_log,
2478 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2479 PTR2UV(sv), SvNVX(sv));
2480 RESTORE_NUMERIC_LOCAL();
2484 STORE_NUMERIC_LOCAL_SET_STANDARD();
2485 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2486 PTR2UV(sv), SvNVX(sv));
2487 RESTORE_NUMERIC_LOCAL();
2491 else if (SvTYPE(sv) < SVt_PVNV)
2492 sv_upgrade(sv, SVt_PVNV);
2497 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2498 #ifdef NV_PRESERVES_UV
2504 /* Only set the public NV OK flag if this NV preserves the IV */
2505 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2507 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2508 : (SvIVX(sv) == I_V(SvNVX(sv))))
2514 else if (SvPOKp(sv) && SvLEN(sv)) {
2516 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2517 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2519 #ifdef NV_PRESERVES_UV
2520 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2521 == IS_NUMBER_IN_UV) {
2522 /* It's definitely an integer */
2523 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2525 SvNV_set(sv, Atof(SvPVX_const(sv)));
2531 SvNV_set(sv, Atof(SvPVX_const(sv)));
2532 /* Only set the public NV OK flag if this NV preserves the value in
2533 the PV at least as well as an IV/UV would.
2534 Not sure how to do this 100% reliably. */
2535 /* if that shift count is out of range then Configure's test is
2536 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2538 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2539 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2540 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2541 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2542 /* Can't use strtol etc to convert this string, so don't try.
2543 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2546 /* value has been set. It may not be precise. */
2547 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2548 /* 2s complement assumption for (UV)IV_MIN */
2549 SvNOK_on(sv); /* Integer is too negative. */
2554 if (numtype & IS_NUMBER_NEG) {
2555 SvIV_set(sv, -(IV)value);
2556 } else if (value <= (UV)IV_MAX) {
2557 SvIV_set(sv, (IV)value);
2559 SvUV_set(sv, value);
2563 if (numtype & IS_NUMBER_NOT_INT) {
2564 /* I believe that even if the original PV had decimals,
2565 they are lost beyond the limit of the FP precision.
2566 However, neither is canonical, so both only get p
2567 flags. NWC, 2000/11/25 */
2568 /* Both already have p flags, so do nothing */
2570 const NV nv = SvNVX(sv);
2571 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2572 if (SvIVX(sv) == I_V(nv)) {
2575 /* It had no "." so it must be integer. */
2579 /* between IV_MAX and NV(UV_MAX).
2580 Could be slightly > UV_MAX */
2582 if (numtype & IS_NUMBER_NOT_INT) {
2583 /* UV and NV both imprecise. */
2585 const UV nv_as_uv = U_V(nv);
2587 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2596 /* It might be more code efficient to go through the entire logic above
2597 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2598 gets complex and potentially buggy, so more programmer efficient
2599 to do it this way, by turning off the public flags: */
2601 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2602 #endif /* NV_PRESERVES_UV */
2605 if (isGV_with_GP(sv)) {
2606 glob_2number(MUTABLE_GV(sv));
2610 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2612 assert (SvTYPE(sv) >= SVt_NV);
2613 /* Typically the caller expects that sv_any is not NULL now. */
2614 /* XXX Ilya implies that this is a bug in callers that assume this
2615 and ideally should be fixed. */
2618 #if defined(USE_LONG_DOUBLE)
2620 STORE_NUMERIC_LOCAL_SET_STANDARD();
2621 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2622 PTR2UV(sv), SvNVX(sv));
2623 RESTORE_NUMERIC_LOCAL();
2627 STORE_NUMERIC_LOCAL_SET_STANDARD();
2628 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2629 PTR2UV(sv), SvNVX(sv));
2630 RESTORE_NUMERIC_LOCAL();
2639 Return an SV with the numeric value of the source SV, doing any necessary
2640 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2641 access this function.
2647 Perl_sv_2num(pTHX_ register SV *const sv)
2649 PERL_ARGS_ASSERT_SV_2NUM;
2654 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2655 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2656 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2657 return sv_2num(tmpsv);
2659 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2662 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2663 * UV as a string towards the end of buf, and return pointers to start and
2666 * We assume that buf is at least TYPE_CHARS(UV) long.
2670 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2672 char *ptr = buf + TYPE_CHARS(UV);
2673 char * const ebuf = ptr;
2676 PERL_ARGS_ASSERT_UIV_2BUF;
2688 *--ptr = '0' + (char)(uv % 10);
2697 =for apidoc sv_2pv_flags
2699 Returns a pointer to the string value of an SV, and sets *lp to its length.
2700 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2702 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2703 usually end up here too.
2709 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2719 if (SvGMAGICAL(sv)) {
2720 if (flags & SV_GMAGIC)
2725 if (flags & SV_MUTABLE_RETURN)
2726 return SvPVX_mutable(sv);
2727 if (flags & SV_CONST_RETURN)
2728 return (char *)SvPVX_const(sv);
2731 if (SvIOKp(sv) || SvNOKp(sv)) {
2732 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2737 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2738 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2739 } else if(SvNVX(sv) == 0.0) {
2744 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2751 SvUPGRADE(sv, SVt_PV);
2754 s = SvGROW_mutable(sv, len + 1);
2757 return (char*)memcpy(s, tbuf, len + 1);
2763 assert(SvTYPE(sv) >= SVt_PVMG);
2764 /* This falls through to the report_uninit near the end of the
2766 } else if (SvTHINKFIRST(sv)) {
2771 if (flags & SV_SKIP_OVERLOAD)
2773 tmpstr = AMG_CALLunary(sv, string_amg);
2774 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2775 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2777 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2781 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2782 if (flags & SV_CONST_RETURN) {
2783 pv = (char *) SvPVX_const(tmpstr);
2785 pv = (flags & SV_MUTABLE_RETURN)
2786 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2789 *lp = SvCUR(tmpstr);
2791 pv = sv_2pv_flags(tmpstr, lp, flags);
2804 SV *const referent = SvRV(sv);
2808 retval = buffer = savepvn("NULLREF", len);
2809 } else if (SvTYPE(referent) == SVt_REGEXP) {
2810 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2815 /* If the regex is UTF-8 we want the containing scalar to
2816 have an UTF-8 flag too */
2822 if ((seen_evals = RX_SEEN_EVALS(re)))
2823 PL_reginterp_cnt += seen_evals;
2826 *lp = RX_WRAPLEN(re);
2828 return RX_WRAPPED(re);
2830 const char *const typestr = sv_reftype(referent, 0);
2831 const STRLEN typelen = strlen(typestr);
2832 UV addr = PTR2UV(referent);
2833 const char *stashname = NULL;
2834 STRLEN stashnamelen = 0; /* hush, gcc */
2835 const char *buffer_end;
2837 if (SvOBJECT(referent)) {
2838 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2841 stashname = HEK_KEY(name);
2842 stashnamelen = HEK_LEN(name);
2844 if (HEK_UTF8(name)) {
2850 stashname = "__ANON__";
2853 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2854 + 2 * sizeof(UV) + 2 /* )\0 */;
2856 len = typelen + 3 /* (0x */
2857 + 2 * sizeof(UV) + 2 /* )\0 */;
2860 Newx(buffer, len, char);
2861 buffer_end = retval = buffer + len;
2863 /* Working backwards */
2867 *--retval = PL_hexdigit[addr & 15];
2868 } while (addr >>= 4);
2874 memcpy(retval, typestr, typelen);
2878 retval -= stashnamelen;
2879 memcpy(retval, stashname, stashnamelen);
2881 /* retval may not neccesarily have reached the start of the
2883 assert (retval >= buffer);
2885 len = buffer_end - retval - 1; /* -1 for that \0 */
2893 if (SvREADONLY(sv) && !SvOK(sv)) {
2896 if (flags & SV_UNDEF_RETURNS_NULL)
2898 if (ckWARN(WARN_UNINITIALIZED))
2903 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2904 /* I'm assuming that if both IV and NV are equally valid then
2905 converting the IV is going to be more efficient */
2906 const U32 isUIOK = SvIsUV(sv);
2907 char buf[TYPE_CHARS(UV)];
2911 if (SvTYPE(sv) < SVt_PVIV)
2912 sv_upgrade(sv, SVt_PVIV);
2913 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2915 /* inlined from sv_setpvn */
2916 s = SvGROW_mutable(sv, len + 1);
2917 Move(ptr, s, len, char);
2921 else if (SvNOKp(sv)) {
2922 if (SvTYPE(sv) < SVt_PVNV)
2923 sv_upgrade(sv, SVt_PVNV);
2924 if (SvNVX(sv) == 0.0) {
2925 s = SvGROW_mutable(sv, 2);
2930 /* The +20 is pure guesswork. Configure test needed. --jhi */
2931 s = SvGROW_mutable(sv, NV_DIG + 20);
2932 /* some Xenix systems wipe out errno here */
2933 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2943 if (isGV_with_GP(sv)) {
2944 GV *const gv = MUTABLE_GV(sv);
2945 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
2946 SV *const buffer = sv_newmortal();
2948 /* FAKE globs can get coerced, so need to turn this off temporarily
2951 gv_efullname3(buffer, gv, "*");
2952 SvFLAGS(gv) |= wasfake;
2954 if (SvPOK(buffer)) {
2956 *lp = SvCUR(buffer);
2958 return SvPVX(buffer);
2969 if (flags & SV_UNDEF_RETURNS_NULL)
2971 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2973 if (SvTYPE(sv) < SVt_PV)
2974 /* Typically the caller expects that sv_any is not NULL now. */
2975 sv_upgrade(sv, SVt_PV);
2979 const STRLEN len = s - SvPVX_const(sv);
2985 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2986 PTR2UV(sv),SvPVX_const(sv)));
2987 if (flags & SV_CONST_RETURN)
2988 return (char *)SvPVX_const(sv);
2989 if (flags & SV_MUTABLE_RETURN)
2990 return SvPVX_mutable(sv);
2995 =for apidoc sv_copypv
2997 Copies a stringified representation of the source SV into the
2998 destination SV. Automatically performs any necessary mg_get and
2999 coercion of numeric values into strings. Guaranteed to preserve
3000 UTF8 flag even from overloaded objects. Similar in nature to
3001 sv_2pv[_flags] but operates directly on an SV instead of just the
3002 string. Mostly uses sv_2pv_flags to do its work, except when that
3003 would lose the UTF-8'ness of the PV.
3009 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
3012 const char * const s = SvPV_const(ssv,len);
3014 PERL_ARGS_ASSERT_SV_COPYPV;
3016 sv_setpvn(dsv,s,len);
3024 =for apidoc sv_2pvbyte
3026 Return a pointer to the byte-encoded representation of the SV, and set *lp
3027 to its length. May cause the SV to be downgraded from UTF-8 as a
3030 Usually accessed via the C<SvPVbyte> macro.
3036 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3038 PERL_ARGS_ASSERT_SV_2PVBYTE;
3041 sv_utf8_downgrade(sv,0);
3042 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3046 =for apidoc sv_2pvutf8
3048 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3049 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3051 Usually accessed via the C<SvPVutf8> macro.
3057 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3059 PERL_ARGS_ASSERT_SV_2PVUTF8;
3061 sv_utf8_upgrade(sv);
3062 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3067 =for apidoc sv_2bool
3069 This macro is only used by sv_true() or its macro equivalent, and only if
3070 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3071 It calls sv_2bool_flags with the SV_GMAGIC flag.
3073 =for apidoc sv_2bool_flags
3075 This function is only used by sv_true() and friends, and only if
3076 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3077 contain SV_GMAGIC, then it does an mg_get() first.
3084 Perl_sv_2bool_flags(pTHX_ register SV *const sv, const I32 flags)
3088 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3090 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3096 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3097 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3098 return cBOOL(SvTRUE(tmpsv));
3100 return SvRV(sv) != 0;
3103 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3105 (*sv->sv_u.svu_pv > '0' ||
3106 Xpvtmp->xpv_cur > 1 ||
3107 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3114 return SvIVX(sv) != 0;
3117 return SvNVX(sv) != 0.0;
3119 if (isGV_with_GP(sv))
3129 =for apidoc sv_utf8_upgrade
3131 Converts the PV of an SV to its UTF-8-encoded form.
3132 Forces the SV to string form if it is not already.
3133 Will C<mg_get> on C<sv> if appropriate.
3134 Always sets the SvUTF8 flag to avoid future validity checks even
3135 if the whole string is the same in UTF-8 as not.
3136 Returns the number of bytes in the converted string
3138 This is not as a general purpose byte encoding to Unicode interface:
3139 use the Encode extension for that.
3141 =for apidoc sv_utf8_upgrade_nomg
3143 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
3145 =for apidoc sv_utf8_upgrade_flags
3147 Converts the PV of an SV to its UTF-8-encoded form.
3148 Forces the SV to string form if it is not already.
3149 Always sets the SvUTF8 flag to avoid future validity checks even
3150 if all the bytes are invariant in UTF-8. If C<flags> has C<SV_GMAGIC> bit set,
3151 will C<mg_get> on C<sv> if appropriate, else not.
3152 Returns the number of bytes in the converted string
3153 C<sv_utf8_upgrade> and
3154 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3156 This is not as a general purpose byte encoding to Unicode interface:
3157 use the Encode extension for that.
3161 The grow version is currently not externally documented. It adds a parameter,
3162 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3163 have free after it upon return. This allows the caller to reserve extra space
3164 that it intends to fill, to avoid extra grows.
3166 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3167 which can be used to tell this function to not first check to see if there are
3168 any characters that are different in UTF-8 (variant characters) which would
3169 force it to allocate a new string to sv, but to assume there are. Typically
3170 this flag is used by a routine that has already parsed the string to find that
3171 there are such characters, and passes this information on so that the work
3172 doesn't have to be repeated.
3174 (One might think that the calling routine could pass in the position of the
3175 first such variant, so it wouldn't have to be found again. But that is not the
3176 case, because typically when the caller is likely to use this flag, it won't be
3177 calling this routine unless it finds something that won't fit into a byte.
3178 Otherwise it tries to not upgrade and just use bytes. But some things that
3179 do fit into a byte are variants in utf8, and the caller may not have been
3180 keeping track of these.)
3182 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3183 isn't guaranteed due to having other routines do the work in some input cases,
3184 or if the input is already flagged as being in utf8.
3186 The speed of this could perhaps be improved for many cases if someone wanted to
3187 write a fast function that counts the number of variant characters in a string,
3188 especially if it could return the position of the first one.
3193 Perl_sv_utf8_upgrade_flags_grow(pTHX_ register SV *const sv, const I32 flags, STRLEN extra)
3197 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3199 if (sv == &PL_sv_undef)
3203 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3204 (void) sv_2pv_flags(sv,&len, flags);
3206 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3210 (void) SvPV_force(sv,len);
3215 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3220 sv_force_normal_flags(sv, 0);
3223 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3224 sv_recode_to_utf8(sv, PL_encoding);
3225 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3229 if (SvCUR(sv) == 0) {
3230 if (extra) SvGROW(sv, extra);
3231 } else { /* Assume Latin-1/EBCDIC */
3232 /* This function could be much more efficient if we
3233 * had a FLAG in SVs to signal if there are any variant
3234 * chars in the PV. Given that there isn't such a flag
3235 * make the loop as fast as possible (although there are certainly ways
3236 * to speed this up, eg. through vectorization) */
3237 U8 * s = (U8 *) SvPVX_const(sv);
3238 U8 * e = (U8 *) SvEND(sv);
3240 STRLEN two_byte_count = 0;
3242 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3244 /* See if really will need to convert to utf8. We mustn't rely on our
3245 * incoming SV being well formed and having a trailing '\0', as certain
3246 * code in pp_formline can send us partially built SVs. */
3250 if (NATIVE_IS_INVARIANT(ch)) continue;
3252 t--; /* t already incremented; re-point to first variant */
3257 /* utf8 conversion not needed because all are invariants. Mark as
3258 * UTF-8 even if no variant - saves scanning loop */
3264 /* Here, the string should be converted to utf8, either because of an
3265 * input flag (two_byte_count = 0), or because a character that
3266 * requires 2 bytes was found (two_byte_count = 1). t points either to
3267 * the beginning of the string (if we didn't examine anything), or to
3268 * the first variant. In either case, everything from s to t - 1 will
3269 * occupy only 1 byte each on output.
3271 * There are two main ways to convert. One is to create a new string
3272 * and go through the input starting from the beginning, appending each
3273 * converted value onto the new string as we go along. It's probably
3274 * best to allocate enough space in the string for the worst possible
3275 * case rather than possibly running out of space and having to
3276 * reallocate and then copy what we've done so far. Since everything
3277 * from s to t - 1 is invariant, the destination can be initialized
3278 * with these using a fast memory copy
3280 * The other way is to figure out exactly how big the string should be
3281 * by parsing the entire input. Then you don't have to make it big
3282 * enough to handle the worst possible case, and more importantly, if
3283 * the string you already have is large enough, you don't have to
3284 * allocate a new string, you can copy the last character in the input
3285 * string to the final position(s) that will be occupied by the
3286 * converted string and go backwards, stopping at t, since everything
3287 * before that is invariant.
3289 * There are advantages and disadvantages to each method.
3291 * In the first method, we can allocate a new string, do the memory
3292 * copy from the s to t - 1, and then proceed through the rest of the
3293 * string byte-by-byte.
3295 * In the second method, we proceed through the rest of the input
3296 * string just calculating how big the converted string will be. Then
3297 * there are two cases:
3298 * 1) if the string has enough extra space to handle the converted
3299 * value. We go backwards through the string, converting until we
3300 * get to the position we are at now, and then stop. If this
3301 * position is far enough along in the string, this method is
3302 * faster than the other method. If the memory copy were the same
3303 * speed as the byte-by-byte loop, that position would be about
3304 * half-way, as at the half-way mark, parsing to the end and back
3305 * is one complete string's parse, the same amount as starting
3306 * over and going all the way through. Actually, it would be
3307 * somewhat less than half-way, as it's faster to just count bytes
3308 * than to also copy, and we don't have the overhead of allocating
3309 * a new string, changing the scalar to use it, and freeing the
3310 * existing one. But if the memory copy is fast, the break-even
3311 * point is somewhere after half way. The counting loop could be
3312 * sped up by vectorization, etc, to move the break-even point
3313 * further towards the beginning.
3314 * 2) if the string doesn't have enough space to handle the converted
3315 * value. A new string will have to be allocated, and one might
3316 * as well, given that, start from the beginning doing the first
3317 * method. We've spent extra time parsing the string and in
3318 * exchange all we've gotten is that we know precisely how big to
3319 * make the new one. Perl is more optimized for time than space,
3320 * so this case is a loser.
3321 * So what I've decided to do is not use the 2nd method unless it is
3322 * guaranteed that a new string won't have to be allocated, assuming
3323 * the worst case. I also decided not to put any more conditions on it
3324 * than this, for now. It seems likely that, since the worst case is
3325 * twice as big as the unknown portion of the string (plus 1), we won't
3326 * be guaranteed enough space, causing us to go to the first method,
3327 * unless the string is short, or the first variant character is near
3328 * the end of it. In either of these cases, it seems best to use the
3329 * 2nd method. The only circumstance I can think of where this would
3330 * be really slower is if the string had once had much more data in it
3331 * than it does now, but there is still a substantial amount in it */
3334 STRLEN invariant_head = t - s;
3335 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3336 if (SvLEN(sv) < size) {
3338 /* Here, have decided to allocate a new string */
3343 Newx(dst, size, U8);
3345 /* If no known invariants at the beginning of the input string,
3346 * set so starts from there. Otherwise, can use memory copy to
3347 * get up to where we are now, and then start from here */
3349 if (invariant_head <= 0) {
3352 Copy(s, dst, invariant_head, char);
3353 d = dst + invariant_head;
3357 const UV uv = NATIVE8_TO_UNI(*t++);
3358 if (UNI_IS_INVARIANT(uv))
3359 *d++ = (U8)UNI_TO_NATIVE(uv);
3361 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3362 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3366 SvPV_free(sv); /* No longer using pre-existing string */
3367 SvPV_set(sv, (char*)dst);
3368 SvCUR_set(sv, d - dst);
3369 SvLEN_set(sv, size);
3372 /* Here, have decided to get the exact size of the string.
3373 * Currently this happens only when we know that there is
3374 * guaranteed enough space to fit the converted string, so
3375 * don't have to worry about growing. If two_byte_count is 0,
3376 * then t points to the first byte of the string which hasn't
3377 * been examined yet. Otherwise two_byte_count is 1, and t
3378 * points to the first byte in the string that will expand to
3379 * two. Depending on this, start examining at t or 1 after t.
3382 U8 *d = t + two_byte_count;
3385 /* Count up the remaining bytes that expand to two */
3388 const U8 chr = *d++;
3389 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3392 /* The string will expand by just the number of bytes that
3393 * occupy two positions. But we are one afterwards because of
3394 * the increment just above. This is the place to put the
3395 * trailing NUL, and to set the length before we decrement */
3397 d += two_byte_count;
3398 SvCUR_set(sv, d - s);
3402 /* Having decremented d, it points to the position to put the
3403 * very last byte of the expanded string. Go backwards through
3404 * the string, copying and expanding as we go, stopping when we
3405 * get to the part that is invariant the rest of the way down */
3409 const U8 ch = NATIVE8_TO_UNI(*e--);
3410 if (UNI_IS_INVARIANT(ch)) {
3411 *d-- = UNI_TO_NATIVE(ch);
3413 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3414 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3421 /* Mark as UTF-8 even if no variant - saves scanning loop */
3427 =for apidoc sv_utf8_downgrade
3429 Attempts to convert the PV of an SV from characters to bytes.
3430 If the PV contains a character that cannot fit
3431 in a byte, this conversion will fail;
3432 in this case, either returns false or, if C<fail_ok> is not
3435 This is not as a general purpose Unicode to byte encoding interface:
3436 use the Encode extension for that.
3442 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3446 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3448 if (SvPOKp(sv) && SvUTF8(sv)) {
3454 sv_force_normal_flags(sv, 0);
3456 s = (U8 *) SvPV(sv, len);
3457 if (!utf8_to_bytes(s, &len)) {
3462 Perl_croak(aTHX_ "Wide character in %s",
3465 Perl_croak(aTHX_ "Wide character");
3476 =for apidoc sv_utf8_encode
3478 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3479 flag off so that it looks like octets again.
3485 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3487 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3490 sv_force_normal_flags(sv, 0);
3492 if (SvREADONLY(sv)) {
3493 Perl_croak_no_modify(aTHX);
3495 (void) sv_utf8_upgrade(sv);
3500 =for apidoc sv_utf8_decode
3502 If the PV of the SV is an octet sequence in UTF-8
3503 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3504 so that it looks like a character. If the PV contains only single-byte
3505 characters, the C<SvUTF8> flag stays being off.
3506 Scans PV for validity and returns false if the PV is invalid UTF-8.
3512 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3514 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3520 /* The octets may have got themselves encoded - get them back as
3523 if (!sv_utf8_downgrade(sv, TRUE))
3526 /* it is actually just a matter of turning the utf8 flag on, but
3527 * we want to make sure everything inside is valid utf8 first.
3529 c = (const U8 *) SvPVX_const(sv);
3530 if (!is_utf8_string(c, SvCUR(sv)+1))
3532 e = (const U8 *) SvEND(sv);
3535 if (!UTF8_IS_INVARIANT(ch)) {
3545 =for apidoc sv_setsv
3547 Copies the contents of the source SV C<ssv> into the destination SV
3548 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3549 function if the source SV needs to be reused. Does not handle 'set' magic.
3550 Loosely speaking, it performs a copy-by-value, obliterating any previous
3551 content of the destination.
3553 You probably want to use one of the assortment of wrappers, such as
3554 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3555 C<SvSetMagicSV_nosteal>.
3557 =for apidoc sv_setsv_flags
3559 Copies the contents of the source SV C<ssv> into the destination SV
3560 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3561 function if the source SV needs to be reused. Does not handle 'set' magic.
3562 Loosely speaking, it performs a copy-by-value, obliterating any previous
3563 content of the destination.
3564 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3565 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3566 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3567 and C<sv_setsv_nomg> are implemented in terms of this function.
3569 You probably want to use one of the assortment of wrappers, such as
3570 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3571 C<SvSetMagicSV_nosteal>.
3573 This is the primary function for copying scalars, and most other
3574 copy-ish functions and macros use this underneath.
3580 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3582 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3583 HV *old_stash = NULL;
3585 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3587 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3588 const char * const name = GvNAME(sstr);
3589 const STRLEN len = GvNAMELEN(sstr);
3591 if (dtype >= SVt_PV) {
3597 SvUPGRADE(dstr, SVt_PVGV);
3598 (void)SvOK_off(dstr);
3599 /* FIXME - why are we doing this, then turning it off and on again
3601 isGV_with_GP_on(dstr);
3603 GvSTASH(dstr) = GvSTASH(sstr);
3605 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3606 gv_name_set(MUTABLE_GV(dstr), name, len, GV_ADD);
3607 SvFAKE_on(dstr); /* can coerce to non-glob */
3610 if(GvGP(MUTABLE_GV(sstr))) {
3611 /* If source has method cache entry, clear it */
3613 SvREFCNT_dec(GvCV(sstr));
3617 /* If source has a real method, then a method is
3620 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3626 /* If dest already had a real method, that's a change as well */
3628 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3629 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3634 /* We don’t need to check the name of the destination if it was not a
3635 glob to begin with. */
3636 if(dtype == SVt_PVGV) {
3637 const char * const name = GvNAME((const GV *)dstr);
3640 /* The stash may have been detached from the symbol table, so
3642 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3643 && GvAV((const GV *)sstr)
3647 const STRLEN len = GvNAMELEN(dstr);
3648 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
3651 /* Set aside the old stash, so we can reset isa caches on
3653 if((old_stash = GvHV(dstr)))
3654 /* Make sure we do not lose it early. */
3655 SvREFCNT_inc_simple_void_NN(
3656 sv_2mortal((SV *)old_stash)
3662 gp_free(MUTABLE_GV(dstr));
3663 isGV_with_GP_off(dstr);
3664 (void)SvOK_off(dstr);
3665 isGV_with_GP_on(dstr);
3666 GvINTRO_off(dstr); /* one-shot flag */
3667 GvGP(dstr) = gp_ref(GvGP(sstr));
3668 if (SvTAINTED(sstr))
3670 if (GvIMPORTED(dstr) != GVf_IMPORTED
3671 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3673 GvIMPORTED_on(dstr);
3676 if(mro_changes == 2) {
3678 SV * const sref = (SV *)GvAV((const GV *)dstr);
3679 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3680 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3681 AV * const ary = newAV();
3682 av_push(ary, mg->mg_obj); /* takes the refcount */
3683 mg->mg_obj = (SV *)ary;
3685 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3687 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3688 mro_isa_changed_in(GvSTASH(dstr));
3690 else if(mro_changes == 3) {
3691 HV * const stash = GvHV(dstr);
3692 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3698 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3703 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3705 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3707 const int intro = GvINTRO(dstr);
3710 const U32 stype = SvTYPE(sref);
3712 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3715 GvINTRO_off(dstr); /* one-shot flag */
3716 GvLINE(dstr) = CopLINE(PL_curcop);
3717 GvEGV(dstr) = MUTABLE_GV(dstr);
3722 location = (SV **) &GvCV(dstr);
3723 import_flag = GVf_IMPORTED_CV;
3726 location = (SV **) &GvHV(dstr);
3727 import_flag = GVf_IMPORTED_HV;
3730 location = (SV **) &GvAV(dstr);
3731 import_flag = GVf_IMPORTED_AV;
3734 location = (SV **) &GvIOp(dstr);
3737 location = (SV **) &GvFORM(dstr);
3740 location = &GvSV(dstr);
3741 import_flag = GVf_IMPORTED_SV;
3744 if (stype == SVt_PVCV) {
3745 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3746 if (GvCVGEN(dstr)) {
3747 SvREFCNT_dec(GvCV(dstr));
3749 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3752 SAVEGENERICSV(*location);
3756 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3757 CV* const cv = MUTABLE_CV(*location);
3759 if (!GvCVGEN((const GV *)dstr) &&
3760 (CvROOT(cv) || CvXSUB(cv)))
3762 /* Redefining a sub - warning is mandatory if
3763 it was a const and its value changed. */
3764 if (CvCONST(cv) && CvCONST((const CV *)sref)
3766 == cv_const_sv((const CV *)sref)) {
3768 /* They are 2 constant subroutines generated from
3769 the same constant. This probably means that
3770 they are really the "same" proxy subroutine
3771 instantiated in 2 places. Most likely this is
3772 when a constant is exported twice. Don't warn.
3775 else if (ckWARN(WARN_REDEFINE)
3777 && (!CvCONST((const CV *)sref)
3778 || sv_cmp(cv_const_sv(cv),
3779 cv_const_sv((const CV *)
3781 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3784 ? "Constant subroutine %s::%s redefined"
3785 : "Subroutine %s::%s redefined"),
3786 HvNAME_get(GvSTASH((const GV *)dstr)),
3787 GvENAME(MUTABLE_GV(dstr)));
3791 cv_ckproto_len(cv, (const GV *)dstr,
3792 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3793 SvPOK(sref) ? SvCUR(sref) : 0);
3795 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3796 GvASSUMECV_on(dstr);
3797 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3800 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3801 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3802 GvFLAGS(dstr) |= import_flag;
3804 if (stype == SVt_PVHV) {
3805 const char * const name = GvNAME((GV*)dstr);
3806 const STRLEN len = GvNAMELEN(dstr);
3808 len > 1 && name[len-2] == ':' && name[len-1] == ':'
3809 && (!dref || HvENAME_get(dref))
3812 (HV *)sref, (HV *)dref,
3818 stype == SVt_PVAV && sref != dref
3819 && strEQ(GvNAME((GV*)dstr), "ISA")
3820 /* The stash may have been detached from the symbol table, so
3821 check its name before doing anything. */
3822 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3825 MAGIC * const omg = dref && SvSMAGICAL(dref)
3826 ? mg_find(dref, PERL_MAGIC_isa)
3828 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3829 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3830 AV * const ary = newAV();
3831 av_push(ary, mg->mg_obj); /* takes the refcount */
3832 mg->mg_obj = (SV *)ary;
3835 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3836 SV **svp = AvARRAY((AV *)omg->mg_obj);
3837 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3841 SvREFCNT_inc_simple_NN(*svp++)
3847 SvREFCNT_inc_simple_NN(omg->mg_obj)
3851 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3856 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3858 mg = mg_find(sref, PERL_MAGIC_isa);
3860 /* Since the *ISA assignment could have affected more than
3861 one stash, don’t call mro_isa_changed_in directly, but let
3862 magic_clearisa do it for us, as it already has the logic for
3863 dealing with globs vs arrays of globs. */
3865 Perl_magic_clearisa(aTHX_ NULL, mg);
3870 if (SvTAINTED(sstr))
3876 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3879 register U32 sflags;
3881 register svtype stype;
3883 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3888 if (SvIS_FREED(dstr)) {
3889 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3890 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3892 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3894 sstr = &PL_sv_undef;
3895 if (SvIS_FREED(sstr)) {
3896 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3897 (void*)sstr, (void*)dstr);
3899 stype = SvTYPE(sstr);
3900 dtype = SvTYPE(dstr);
3902 (void)SvAMAGIC_off(dstr);
3905 /* need to nuke the magic */
3909 /* There's a lot of redundancy below but we're going for speed here */
3914 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
3915 (void)SvOK_off(dstr);
3923 sv_upgrade(dstr, SVt_IV);
3927 sv_upgrade(dstr, SVt_PVIV);
3931 goto end_of_first_switch;
3933 (void)SvIOK_only(dstr);
3934 SvIV_set(dstr, SvIVX(sstr));
3937 /* SvTAINTED can only be true if the SV has taint magic, which in
3938 turn means that the SV type is PVMG (or greater). This is the
3939 case statement for SVt_IV, so this cannot be true (whatever gcov
3941 assert(!SvTAINTED(sstr));
3946 if (dtype < SVt_PV && dtype != SVt_IV)
3947 sv_upgrade(dstr, SVt_IV);
3955 sv_upgrade(dstr, SVt_NV);
3959 sv_upgrade(dstr, SVt_PVNV);
3963 goto end_of_first_switch;
3965 SvNV_set(dstr, SvNVX(sstr));
3966 (void)SvNOK_only(dstr);
3967 /* SvTAINTED can only be true if the SV has taint magic, which in
3968 turn means that the SV type is PVMG (or greater). This is the
3969 case statement for SVt_NV, so this cannot be true (whatever gcov
3971 assert(!SvTAINTED(sstr));
3977 #ifdef PERL_OLD_COPY_ON_WRITE
3978 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3979 if (dtype < SVt_PVIV)
3980 sv_upgrade(dstr, SVt_PVIV);
3987 sv_upgrade(dstr, SVt_PV);
3990 if (dtype < SVt_PVIV)
3991 sv_upgrade(dstr, SVt_PVIV);
3994 if (dtype < SVt_PVNV)
3995 sv_upgrade(dstr, SVt_PVNV);
3999 const char * const type = sv_reftype(sstr,0);
4001 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4003 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4008 if (dtype < SVt_REGEXP)
4009 sv_upgrade(dstr, SVt_REGEXP);
4012 /* case SVt_BIND: */
4015 /* SvVALID means that this PVGV is playing at being an FBM. */
4018 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4020 if (SvTYPE(sstr) != stype)
4021 stype = SvTYPE(sstr);
4023 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4024 glob_assign_glob(dstr, sstr, dtype);
4027 if (stype == SVt_PVLV)
4028 SvUPGRADE(dstr, SVt_PVNV);
4030 SvUPGRADE(dstr, (svtype)stype);
4032 end_of_first_switch:
4034 /* dstr may have been upgraded. */
4035 dtype = SvTYPE(dstr);
4036 sflags = SvFLAGS(sstr);
4038 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
4039 /* Assigning to a subroutine sets the prototype. */
4042 const char *const ptr = SvPV_const(sstr, len);
4044 SvGROW(dstr, len + 1);
4045 Copy(ptr, SvPVX(dstr), len + 1, char);
4046 SvCUR_set(dstr, len);
4048 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4052 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
4053 const char * const type = sv_reftype(dstr,0);
4055 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4057 Perl_croak(aTHX_ "Cannot copy to %s", type);
4058 } else if (sflags & SVf_ROK) {
4059 if (isGV_with_GP(dstr)
4060 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4063 if (GvIMPORTED(dstr) != GVf_IMPORTED
4064 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4066 GvIMPORTED_on(dstr);
4071 glob_assign_glob(dstr, sstr, dtype);
4075 if (dtype >= SVt_PV) {
4076 if (isGV_with_GP(dstr)) {
4077 glob_assign_ref(dstr, sstr);
4080 if (SvPVX_const(dstr)) {
4086 (void)SvOK_off(dstr);
4087 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4088 SvFLAGS(dstr) |= sflags & SVf_ROK;
4089 assert(!(sflags & SVp_NOK));
4090 assert(!(sflags & SVp_IOK));
4091 assert(!(sflags & SVf_NOK));
4092 assert(!(sflags & SVf_IOK));
4094 else if (isGV_with_GP(dstr)) {
4095 if (!(sflags & SVf_OK)) {
4096 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4097 "Undefined value assigned to typeglob");
4100 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
4101 if (dstr != (const SV *)gv) {
4102 const char * const name = GvNAME((const GV *)dstr);
4103 const STRLEN len = GvNAMELEN(dstr);
4104 HV *old_stash = NULL;
4105 bool reset_isa = FALSE;
4106 if (len > 1 && name[len-2] == ':' && name[len-1] == ':') {
4107 /* Set aside the old stash, so we can reset isa caches
4108 on its subclasses. */
4109 if((old_stash = GvHV(dstr))) {
4110 /* Make sure we do not lose it early. */
4111 SvREFCNT_inc_simple_void_NN(
4112 sv_2mortal((SV *)old_stash)
4119 gp_free(MUTABLE_GV(dstr));
4120 GvGP(dstr) = gp_ref(GvGP(gv));
4123 HV * const stash = GvHV(dstr);
4125 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4135 else if (dtype == SVt_REGEXP && stype == SVt_REGEXP) {
4136 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4138 else if (sflags & SVp_POK) {
4142 * Check to see if we can just swipe the string. If so, it's a
4143 * possible small lose on short strings, but a big win on long ones.
4144 * It might even be a win on short strings if SvPVX_const(dstr)
4145 * has to be allocated and SvPVX_const(sstr) has to be freed.
4146 * Likewise if we can set up COW rather than doing an actual copy, we
4147 * drop to the else clause, as the swipe code and the COW setup code
4148 * have much in common.
4151 /* Whichever path we take through the next code, we want this true,
4152 and doing it now facilitates the COW check. */
4153 (void)SvPOK_only(dstr);
4156 /* If we're already COW then this clause is not true, and if COW
4157 is allowed then we drop down to the else and make dest COW
4158 with us. If caller hasn't said that we're allowed to COW
4159 shared hash keys then we don't do the COW setup, even if the
4160 source scalar is a shared hash key scalar. */
4161 (((flags & SV_COW_SHARED_HASH_KEYS)
4162 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
4163 : 1 /* If making a COW copy is forbidden then the behaviour we
4164 desire is as if the source SV isn't actually already
4165 COW, even if it is. So we act as if the source flags
4166 are not COW, rather than actually testing them. */
4168 #ifndef PERL_OLD_COPY_ON_WRITE
4169 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4170 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4171 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4172 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4173 but in turn, it's somewhat dead code, never expected to go
4174 live, but more kept as a placeholder on how to do it better
4175 in a newer implementation. */
4176 /* If we are COW and dstr is a suitable target then we drop down
4177 into the else and make dest a COW of us. */
4178 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4183 (sflags & SVs_TEMP) && /* slated for free anyway? */
4184 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4185 (!(flags & SV_NOSTEAL)) &&
4186 /* and we're allowed to steal temps */
4187 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4188 SvLEN(sstr)) /* and really is a string */
4189 #ifdef PERL_OLD_COPY_ON_WRITE
4190 && ((flags & SV_COW_SHARED_HASH_KEYS)
4191 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4192 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4193 && SvTYPE(sstr) >= SVt_PVIV && SvTYPE(sstr) != SVt_PVFM))
4197 /* Failed the swipe test, and it's not a shared hash key either.
4198 Have to copy the string. */
4199 STRLEN len = SvCUR(sstr);
4200 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4201 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4202 SvCUR_set(dstr, len);
4203 *SvEND(dstr) = '\0';
4205 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4207 /* Either it's a shared hash key, or it's suitable for
4208 copy-on-write or we can swipe the string. */
4210 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4214 #ifdef PERL_OLD_COPY_ON_WRITE
4216 if ((sflags & (SVf_FAKE | SVf_READONLY))
4217 != (SVf_FAKE | SVf_READONLY)) {
4218 SvREADONLY_on(sstr);
4220 /* Make the source SV into a loop of 1.
4221 (about to become 2) */
4222 SV_COW_NEXT_SV_SET(sstr, sstr);
4226 /* Initial code is common. */
4227 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4232 /* making another shared SV. */
4233 STRLEN cur = SvCUR(sstr);
4234 STRLEN len = SvLEN(sstr);
4235 #ifdef PERL_OLD_COPY_ON_WRITE
4237 assert (SvTYPE(dstr) >= SVt_PVIV);
4238 /* SvIsCOW_normal */
4239 /* splice us in between source and next-after-source. */
4240 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4241 SV_COW_NEXT_SV_SET(sstr, dstr);
4242 SvPV_set(dstr, SvPVX_mutable(sstr));
4246 /* SvIsCOW_shared_hash */
4247 DEBUG_C(PerlIO_printf(Perl_debug_log,
4248 "Copy on write: Sharing hash\n"));
4250 assert (SvTYPE(dstr) >= SVt_PV);
4252 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4254 SvLEN_set(dstr, len);
4255 SvCUR_set(dstr, cur);
4256 SvREADONLY_on(dstr);
4260 { /* Passes the swipe test. */
4261 SvPV_set(dstr, SvPVX_mutable(sstr));
4262 SvLEN_set(dstr, SvLEN(sstr));
4263 SvCUR_set(dstr, SvCUR(sstr));
4266 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4267 SvPV_set(sstr, NULL);
4273 if (sflags & SVp_NOK) {
4274 SvNV_set(dstr, SvNVX(sstr));
4276 if (sflags & SVp_IOK) {
4277 SvIV_set(dstr, SvIVX(sstr));
4278 /* Must do this otherwise some other overloaded use of 0x80000000
4279 gets confused. I guess SVpbm_VALID */
4280 if (sflags & SVf_IVisUV)
4283 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4285 const MAGIC * const smg = SvVSTRING_mg(sstr);
4287 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4288 smg->mg_ptr, smg->mg_len);
4289 SvRMAGICAL_on(dstr);
4293 else if (sflags & (SVp_IOK|SVp_NOK)) {
4294 (void)SvOK_off(dstr);
4295 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4296 if (sflags & SVp_IOK) {
4297 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4298 SvIV_set(dstr, SvIVX(sstr));
4300 if (sflags & SVp_NOK) {
4301 SvNV_set(dstr, SvNVX(sstr));
4305 if (isGV_with_GP(sstr)) {
4306 /* This stringification rule for globs is spread in 3 places.
4307 This feels bad. FIXME. */
4308 const U32 wasfake = sflags & SVf_FAKE;
4310 /* FAKE globs can get coerced, so need to turn this off
4311 temporarily if it is on. */
4313 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4314 SvFLAGS(sstr) |= wasfake;
4317 (void)SvOK_off(dstr);
4319 if (SvTAINTED(sstr))
4324 =for apidoc sv_setsv_mg
4326 Like C<sv_setsv>, but also handles 'set' magic.
4332 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
4334 PERL_ARGS_ASSERT_SV_SETSV_MG;
4336 sv_setsv(dstr,sstr);
4340 #ifdef PERL_OLD_COPY_ON_WRITE
4342 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4344 STRLEN cur = SvCUR(sstr);
4345 STRLEN len = SvLEN(sstr);
4346 register char *new_pv;
4348 PERL_ARGS_ASSERT_SV_SETSV_COW;
4351 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4352 (void*)sstr, (void*)dstr);
4359 if (SvTHINKFIRST(dstr))
4360 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4361 else if (SvPVX_const(dstr))
4362 Safefree(SvPVX_const(dstr));
4366 SvUPGRADE(dstr, SVt_PVIV);
4368 assert (SvPOK(sstr));
4369 assert (SvPOKp(sstr));
4370 assert (!SvIOK(sstr));
4371 assert (!SvIOKp(sstr));
4372 assert (!SvNOK(sstr));
4373 assert (!SvNOKp(sstr));
4375 if (SvIsCOW(sstr)) {
4377 if (SvLEN(sstr) == 0) {
4378 /* source is a COW shared hash key. */
4379 DEBUG_C(PerlIO_printf(Perl_debug_log,
4380 "Fast copy on write: Sharing hash\n"));
4381 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4384 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4386 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4387 SvUPGRADE(sstr, SVt_PVIV);
4388 SvREADONLY_on(sstr);
4390 DEBUG_C(PerlIO_printf(Perl_debug_log,
4391 "Fast copy on write: Converting sstr to COW\n"));
4392 SV_COW_NEXT_SV_SET(dstr, sstr);
4394 SV_COW_NEXT_SV_SET(sstr, dstr);
4395 new_pv = SvPVX_mutable(sstr);
4398 SvPV_set(dstr, new_pv);
4399 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4402 SvLEN_set(dstr, len);
4403 SvCUR_set(dstr, cur);
4412 =for apidoc sv_setpvn
4414 Copies a string into an SV. The C<len> parameter indicates the number of
4415 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4416 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4422 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4425 register char *dptr;
4427 PERL_ARGS_ASSERT_SV_SETPVN;
4429 SV_CHECK_THINKFIRST_COW_DROP(sv);
4435 /* len is STRLEN which is unsigned, need to copy to signed */
4438 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4440 SvUPGRADE(sv, SVt_PV);
4442 dptr = SvGROW(sv, len + 1);
4443 Move(ptr,dptr,len,char);
4446 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4451 =for apidoc sv_setpvn_mg
4453 Like C<sv_setpvn>, but also handles 'set' magic.
4459 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4461 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4463 sv_setpvn(sv,ptr,len);
4468 =for apidoc sv_setpv
4470 Copies a string into an SV. The string must be null-terminated. Does not
4471 handle 'set' magic. See C<sv_setpv_mg>.
4477 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4480 register STRLEN len;
4482 PERL_ARGS_ASSERT_SV_SETPV;
4484 SV_CHECK_THINKFIRST_COW_DROP(sv);
4490 SvUPGRADE(sv, SVt_PV);
4492 SvGROW(sv, len + 1);
4493 Move(ptr,SvPVX(sv),len+1,char);
4495 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4500 =for apidoc sv_setpv_mg
4502 Like C<sv_setpv>, but also handles 'set' magic.
4508 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4510 PERL_ARGS_ASSERT_SV_SETPV_MG;
4517 =for apidoc sv_usepvn_flags
4519 Tells an SV to use C<ptr> to find its string value. Normally the
4520 string is stored inside the SV but sv_usepvn allows the SV to use an
4521 outside string. The C<ptr> should point to memory that was allocated
4522 by C<malloc>. The string length, C<len>, must be supplied. By default
4523 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4524 so that pointer should not be freed or used by the programmer after
4525 giving it to sv_usepvn, and neither should any pointers from "behind"
4526 that pointer (e.g. ptr + 1) be used.
4528 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4529 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4530 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4531 C<len>, and already meets the requirements for storing in C<SvPVX>)
4537 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4542 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4544 SV_CHECK_THINKFIRST_COW_DROP(sv);
4545 SvUPGRADE(sv, SVt_PV);
4548 if (flags & SV_SMAGIC)
4552 if (SvPVX_const(sv))
4556 if (flags & SV_HAS_TRAILING_NUL)
4557 assert(ptr[len] == '\0');
4560 allocate = (flags & SV_HAS_TRAILING_NUL)
4562 #ifdef Perl_safesysmalloc_size
4565 PERL_STRLEN_ROUNDUP(len + 1);
4567 if (flags & SV_HAS_TRAILING_NUL) {
4568 /* It's long enough - do nothing.
4569 Specfically Perl_newCONSTSUB is relying on this. */
4572 /* Force a move to shake out bugs in callers. */
4573 char *new_ptr = (char*)safemalloc(allocate);
4574 Copy(ptr, new_ptr, len, char);
4575 PoisonFree(ptr,len,char);
4579 ptr = (char*) saferealloc (ptr, allocate);
4582 #ifdef Perl_safesysmalloc_size
4583 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4585 SvLEN_set(sv, allocate);
4589 if (!(flags & SV_HAS_TRAILING_NUL)) {
4592 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4594 if (flags & SV_SMAGIC)
4598 #ifdef PERL_OLD_COPY_ON_WRITE
4599 /* Need to do this *after* making the SV normal, as we need the buffer
4600 pointer to remain valid until after we've copied it. If we let go too early,
4601 another thread could invalidate it by unsharing last of the same hash key
4602 (which it can do by means other than releasing copy-on-write Svs)
4603 or by changing the other copy-on-write SVs in the loop. */
4605 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4607 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4609 { /* this SV was SvIsCOW_normal(sv) */
4610 /* we need to find the SV pointing to us. */
4611 SV *current = SV_COW_NEXT_SV(after);
4613 if (current == sv) {
4614 /* The SV we point to points back to us (there were only two of us
4616 Hence other SV is no longer copy on write either. */
4618 SvREADONLY_off(after);
4620 /* We need to follow the pointers around the loop. */
4622 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4625 /* don't loop forever if the structure is bust, and we have
4626 a pointer into a closed loop. */
4627 assert (current != after);
4628 assert (SvPVX_const(current) == pvx);
4630 /* Make the SV before us point to the SV after us. */
4631 SV_COW_NEXT_SV_SET(current, after);
4637 =for apidoc sv_force_normal_flags
4639 Undo various types of fakery on an SV: if the PV is a shared string, make
4640 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4641 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4642 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4643 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4644 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4645 set to some other value.) In addition, the C<flags> parameter gets passed to
4646 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4647 with flags set to 0.
4653 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4657 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4659 #ifdef PERL_OLD_COPY_ON_WRITE
4660 if (SvREADONLY(sv)) {
4662 const char * const pvx = SvPVX_const(sv);
4663 const STRLEN len = SvLEN(sv);
4664 const STRLEN cur = SvCUR(sv);
4665 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4666 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4667 we'll fail an assertion. */
4668 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4671 PerlIO_printf(Perl_debug_log,
4672 "Copy on write: Force normal %ld\n",
4678 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4681 if (flags & SV_COW_DROP_PV) {
4682 /* OK, so we don't need to copy our buffer. */
4685 SvGROW(sv, cur + 1);
4686 Move(pvx,SvPVX(sv),cur,char);
4691 sv_release_COW(sv, pvx, next);
4693 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4699 else if (IN_PERL_RUNTIME)
4700 Perl_croak_no_modify(aTHX);
4703 if (SvREADONLY(sv)) {
4705 const char * const pvx = SvPVX_const(sv);
4706 const STRLEN len = SvCUR(sv);
4711 SvGROW(sv, len + 1);
4712 Move(pvx,SvPVX(sv),len,char);
4714 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4716 else if (IN_PERL_RUNTIME)
4717 Perl_croak_no_modify(aTHX);
4721 sv_unref_flags(sv, flags);
4722 else if (SvFAKE(sv) && isGV_with_GP(sv))
4724 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_REGEXP) {
4725 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analagous
4726 to sv_unglob. We only need it here, so inline it. */
4727 const svtype new_type = SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4728 SV *const temp = newSV_type(new_type);
4729 void *const temp_p = SvANY(sv);
4731 if (new_type == SVt_PVMG) {
4732 SvMAGIC_set(temp, SvMAGIC(sv));
4733 SvMAGIC_set(sv, NULL);
4734 SvSTASH_set(temp, SvSTASH(sv));
4735 SvSTASH_set(sv, NULL);
4737 SvCUR_set(temp, SvCUR(sv));
4738 /* Remember that SvPVX is in the head, not the body. */
4740 SvLEN_set(temp, SvLEN(sv));
4741 /* This signals "buffer is owned by someone else" in sv_clear,
4742 which is the least effort way to stop it freeing the buffer.
4744 SvLEN_set(sv, SvLEN(sv)+1);
4746 /* Their buffer is already owned by someone else. */
4747 SvPVX(sv) = savepvn(SvPVX(sv), SvCUR(sv));
4748 SvLEN_set(temp, SvCUR(sv)+1);
4751 /* Now swap the rest of the bodies. */
4753 SvFLAGS(sv) &= ~(SVf_FAKE|SVTYPEMASK);
4754 SvFLAGS(sv) |= new_type;
4755 SvANY(sv) = SvANY(temp);
4757 SvFLAGS(temp) &= ~(SVTYPEMASK);
4758 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4759 SvANY(temp) = temp_p;
4768 Efficient removal of characters from the beginning of the string buffer.
4769 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4770 the string buffer. The C<ptr> becomes the first character of the adjusted
4771 string. Uses the "OOK hack".
4772 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4773 refer to the same chunk of data.
4779 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4785 const U8 *real_start;
4789 PERL_ARGS_ASSERT_SV_CHOP;
4791 if (!ptr || !SvPOKp(sv))
4793 delta = ptr - SvPVX_const(sv);
4795 /* Nothing to do. */
4798 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4799 nothing uses the value of ptr any more. */
4800 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4801 if (ptr <= SvPVX_const(sv))
4802 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4803 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4804 SV_CHECK_THINKFIRST(sv);
4805 if (delta > max_delta)
4806 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4807 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4808 SvPVX_const(sv) + max_delta);
4811 if (!SvLEN(sv)) { /* make copy of shared string */
4812 const char *pvx = SvPVX_const(sv);
4813 const STRLEN len = SvCUR(sv);
4814 SvGROW(sv, len + 1);
4815 Move(pvx,SvPVX(sv),len,char);
4818 SvFLAGS(sv) |= SVf_OOK;
4821 SvOOK_offset(sv, old_delta);
4823 SvLEN_set(sv, SvLEN(sv) - delta);
4824 SvCUR_set(sv, SvCUR(sv) - delta);
4825 SvPV_set(sv, SvPVX(sv) + delta);
4827 p = (U8 *)SvPVX_const(sv);
4832 real_start = p - delta;
4836 if (delta < 0x100) {
4840 p -= sizeof(STRLEN);
4841 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4845 /* Fill the preceding buffer with sentinals to verify that no-one is
4847 while (p > real_start) {
4855 =for apidoc sv_catpvn
4857 Concatenates the string onto the end of the string which is in the SV. The
4858 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4859 status set, then the bytes appended should be valid UTF-8.
4860 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4862 =for apidoc sv_catpvn_flags
4864 Concatenates the string onto the end of the string which is in the SV. The
4865 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4866 status set, then the bytes appended should be valid UTF-8.
4867 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4868 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4869 in terms of this function.
4875 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4879 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4881 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4883 SvGROW(dsv, dlen + slen + 1);
4885 sstr = SvPVX_const(dsv);
4886 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4887 SvCUR_set(dsv, SvCUR(dsv) + slen);
4889 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4891 if (flags & SV_SMAGIC)
4896 =for apidoc sv_catsv
4898 Concatenates the string from SV C<ssv> onto the end of the string in
4899 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4900 not 'set' magic. See C<sv_catsv_mg>.
4902 =for apidoc sv_catsv_flags
4904 Concatenates the string from SV C<ssv> onto the end of the string in
4905 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4906 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4907 and C<sv_catsv_nomg> are implemented in terms of this function.
4912 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4916 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4920 const char *spv = SvPV_flags_const(ssv, slen, flags);
4922 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4923 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4924 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4925 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4926 dsv->sv_flags doesn't have that bit set.
4927 Andy Dougherty 12 Oct 2001
4929 const I32 sutf8 = DO_UTF8(ssv);
4932 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4934 dutf8 = DO_UTF8(dsv);
4936 if (dutf8 != sutf8) {
4938 /* Not modifying source SV, so taking a temporary copy. */
4939 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4941 sv_utf8_upgrade(csv);
4942 spv = SvPV_const(csv, slen);
4945 /* Leave enough space for the cat that's about to happen */
4946 sv_utf8_upgrade_flags_grow(dsv, 0, slen);
4948 sv_catpvn_nomg(dsv, spv, slen);
4951 if (flags & SV_SMAGIC)
4956 =for apidoc sv_catpv
4958 Concatenates the string onto the end of the string which is in the SV.
4959 If the SV has the UTF-8 status set, then the bytes appended should be
4960 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4965 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4968 register STRLEN len;
4972 PERL_ARGS_ASSERT_SV_CATPV;
4976 junk = SvPV_force(sv, tlen);
4978 SvGROW(sv, tlen + len + 1);
4980 ptr = SvPVX_const(sv);
4981 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4982 SvCUR_set(sv, SvCUR(sv) + len);
4983 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4988 =for apidoc sv_catpv_flags
4990 Concatenates the string onto the end of the string which is in the SV.
4991 If the SV has the UTF-8 status set, then the bytes appended should
4992 be valid UTF-8. If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get>
4993 on the SVs if appropriate, else not.
4999 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5001 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5002 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5006 =for apidoc sv_catpv_mg
5008 Like C<sv_catpv>, but also handles 'set' magic.
5014 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
5016 PERL_ARGS_ASSERT_SV_CATPV_MG;
5025 Creates a new SV. A non-zero C<len> parameter indicates the number of
5026 bytes of preallocated string space the SV should have. An extra byte for a
5027 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5028 space is allocated.) The reference count for the new SV is set to 1.
5030 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5031 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5032 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5033 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
5034 modules supporting older perls.
5040 Perl_newSV(pTHX_ const STRLEN len)
5047 sv_upgrade(sv, SVt_PV);
5048 SvGROW(sv, len + 1);
5053 =for apidoc sv_magicext
5055 Adds magic to an SV, upgrading it if necessary. Applies the
5056 supplied vtable and returns a pointer to the magic added.
5058 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5059 In particular, you can add magic to SvREADONLY SVs, and add more than
5060 one instance of the same 'how'.
5062 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5063 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5064 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5065 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5067 (This is now used as a subroutine by C<sv_magic>.)
5072 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5073 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5078 PERL_ARGS_ASSERT_SV_MAGICEXT;
5080 SvUPGRADE(sv, SVt_PVMG);
5081 Newxz(mg, 1, MAGIC);
5082 mg->mg_moremagic = SvMAGIC(sv);
5083 SvMAGIC_set(sv, mg);
5085 /* Sometimes a magic contains a reference loop, where the sv and
5086 object refer to each other. To prevent a reference loop that
5087 would prevent such objects being freed, we look for such loops
5088 and if we find one we avoid incrementing the object refcount.
5090 Note we cannot do this to avoid self-tie loops as intervening RV must
5091 have its REFCNT incremented to keep it in existence.
5094 if (!obj || obj == sv ||
5095 how == PERL_MAGIC_arylen ||
5096 how == PERL_MAGIC_symtab ||
5097 (SvTYPE(obj) == SVt_PVGV &&
5098 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5099 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5100 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5105 mg->mg_obj = SvREFCNT_inc_simple(obj);
5106 mg->mg_flags |= MGf_REFCOUNTED;
5109 /* Normal self-ties simply pass a null object, and instead of
5110 using mg_obj directly, use the SvTIED_obj macro to produce a
5111 new RV as needed. For glob "self-ties", we are tieing the PVIO
5112 with an RV obj pointing to the glob containing the PVIO. In
5113 this case, to avoid a reference loop, we need to weaken the
5117 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5118 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5124 mg->mg_len = namlen;
5127 mg->mg_ptr = savepvn(name, namlen);
5128 else if (namlen == HEf_SVKEY) {
5129 /* Yes, this is casting away const. This is only for the case of
5130 HEf_SVKEY. I think we need to document this abberation of the
5131 constness of the API, rather than making name non-const, as
5132 that change propagating outwards a long way. */
5133 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5135 mg->mg_ptr = (char *) name;
5137 mg->mg_virtual = (MGVTBL *) vtable;
5141 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5146 =for apidoc sv_magic
5148 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5149 then adds a new magic item of type C<how> to the head of the magic list.
5151 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5152 handling of the C<name> and C<namlen> arguments.
5154 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5155 to add more than one instance of the same 'how'.
5161 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
5162 const char *const name, const I32 namlen)
5165 const MGVTBL *vtable;
5168 PERL_ARGS_ASSERT_SV_MAGIC;
5170 #ifdef PERL_OLD_COPY_ON_WRITE
5172 sv_force_normal_flags(sv, 0);
5174 if (SvREADONLY(sv)) {
5176 /* its okay to attach magic to shared strings; the subsequent
5177 * upgrade to PVMG will unshare the string */
5178 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
5181 && how != PERL_MAGIC_regex_global
5182 && how != PERL_MAGIC_bm
5183 && how != PERL_MAGIC_fm
5184 && how != PERL_MAGIC_sv
5185 && how != PERL_MAGIC_backref
5188 Perl_croak_no_modify(aTHX);
5191 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5192 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5193 /* sv_magic() refuses to add a magic of the same 'how' as an
5196 if (how == PERL_MAGIC_taint) {
5198 /* Any scalar which already had taint magic on which someone
5199 (erroneously?) did SvIOK_on() or similar will now be
5200 incorrectly sporting public "OK" flags. */
5201 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5209 vtable = &PL_vtbl_sv;
5211 case PERL_MAGIC_overload:
5212 vtable = &PL_vtbl_amagic;
5214 case PERL_MAGIC_overload_elem:
5215 vtable = &PL_vtbl_amagicelem;
5217 case PERL_MAGIC_overload_table:
5218 vtable = &PL_vtbl_ovrld;
5221 vtable = &PL_vtbl_bm;
5223 case PERL_MAGIC_regdata:
5224 vtable = &PL_vtbl_regdata;
5226 case PERL_MAGIC_regdatum:
5227 vtable = &PL_vtbl_regdatum;
5229 case PERL_MAGIC_env:
5230 vtable = &PL_vtbl_env;
5233 vtable = &PL_vtbl_fm;
5235 case PERL_MAGIC_envelem:
5236 vtable = &PL_vtbl_envelem;
5238 case PERL_MAGIC_regex_global:
5239 vtable = &PL_vtbl_mglob;
5241 case PERL_MAGIC_isa:
5242 vtable = &PL_vtbl_isa;
5244 case PERL_MAGIC_isaelem:
5245 vtable = &PL_vtbl_isaelem;
5247 case PERL_MAGIC_nkeys:
5248 vtable = &PL_vtbl_nkeys;
5250 case PERL_MAGIC_dbfile:
5253 case PERL_MAGIC_dbline:
5254 vtable = &PL_vtbl_dbline;
5256 #ifdef USE_LOCALE_COLLATE
5257 case PERL_MAGIC_collxfrm:
5258 vtable = &PL_vtbl_collxfrm;
5260 #endif /* USE_LOCALE_COLLATE */
5261 case PERL_MAGIC_tied:
5262 vtable = &PL_vtbl_pack;
5264 case PERL_MAGIC_tiedelem:
5265 case PERL_MAGIC_tiedscalar:
5266 vtable = &PL_vtbl_packelem;
5269 vtable = &PL_vtbl_regexp;
5271 case PERL_MAGIC_sig:
5272 vtable = &PL_vtbl_sig;
5274 case PERL_MAGIC_sigelem:
5275 vtable = &PL_vtbl_sigelem;
5277 case PERL_MAGIC_taint:
5278 vtable = &PL_vtbl_taint;
5280 case PERL_MAGIC_uvar:
5281 vtable = &PL_vtbl_uvar;
5283 case PERL_MAGIC_vec:
5284 vtable = &PL_vtbl_vec;
5286 case PERL_MAGIC_arylen_p:
5287 case PERL_MAGIC_rhash:
5288 case PERL_MAGIC_symtab:
5289 case PERL_MAGIC_vstring:
5290 case PERL_MAGIC_checkcall:
5293 case PERL_MAGIC_utf8:
5294 vtable = &PL_vtbl_utf8;
5296 case PERL_MAGIC_substr:
5297 vtable = &PL_vtbl_substr;
5299 case PERL_MAGIC_defelem:
5300 vtable = &PL_vtbl_defelem;
5302 case PERL_MAGIC_arylen:
5303 vtable = &PL_vtbl_arylen;
5305 case PERL_MAGIC_pos:
5306 vtable = &PL_vtbl_pos;
5308 case PERL_MAGIC_backref:
5309 vtable = &PL_vtbl_backref;
5311 case PERL_MAGIC_hintselem:
5312 vtable = &PL_vtbl_hintselem;
5314 case PERL_MAGIC_hints:
5315 vtable = &PL_vtbl_hints;
5317 case PERL_MAGIC_ext:
5318 /* Reserved for use by extensions not perl internals. */
5319 /* Useful for attaching extension internal data to perl vars. */
5320 /* Note that multiple extensions may clash if magical scalars */
5321 /* etc holding private data from one are passed to another. */
5325 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5328 /* Rest of work is done else where */
5329 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5332 case PERL_MAGIC_taint:
5335 case PERL_MAGIC_ext:
5336 case PERL_MAGIC_dbfile:
5343 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5350 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5352 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5353 for (mg = *mgp; mg; mg = *mgp) {
5354 const MGVTBL* const virt = mg->mg_virtual;
5355 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5356 *mgp = mg->mg_moremagic;
5357 if (virt && virt->svt_free)
5358 virt->svt_free(aTHX_ sv, mg);
5359 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5361 Safefree(mg->mg_ptr);
5362 else if (mg->mg_len == HEf_SVKEY)
5363 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5364 else if (mg->mg_type == PERL_MAGIC_utf8)
5365 Safefree(mg->mg_ptr);
5367 if (mg->mg_flags & MGf_REFCOUNTED)
5368 SvREFCNT_dec(mg->mg_obj);
5372 mgp = &mg->mg_moremagic;
5375 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5376 mg_magical(sv); /* else fix the flags now */
5380 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5386 =for apidoc sv_unmagic
5388 Removes all magic of type C<type> from an SV.
5394 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5396 PERL_ARGS_ASSERT_SV_UNMAGIC;
5397 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5401 =for apidoc sv_unmagicext
5403 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5409 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5411 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5412 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5416 =for apidoc sv_rvweaken
5418 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5419 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5420 push a back-reference to this RV onto the array of backreferences
5421 associated with that magic. If the RV is magical, set magic will be
5422 called after the RV is cleared.
5428 Perl_sv_rvweaken(pTHX_ SV *const sv)
5432 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5434 if (!SvOK(sv)) /* let undefs pass */
5437 Perl_croak(aTHX_ "Can't weaken a nonreference");
5438 else if (SvWEAKREF(sv)) {
5439 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5443 Perl_sv_add_backref(aTHX_ tsv, sv);
5449 /* Give tsv backref magic if it hasn't already got it, then push a
5450 * back-reference to sv onto the array associated with the backref magic.
5452 * As an optimisation, if there's only one backref and it's not an AV,
5453 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5454 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5457 * If an HV's backref is stored in magic, it is moved back to HvAUX.
5460 /* A discussion about the backreferences array and its refcount:
5462 * The AV holding the backreferences is pointed to either as the mg_obj of
5463 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5464 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5465 * have the standard magic instead.) The array is created with a refcount
5466 * of 2. This means that if during global destruction the array gets
5467 * picked on before its parent to have its refcount decremented by the
5468 * random zapper, it won't actually be freed, meaning it's still there for
5469 * when its parent gets freed.
5471 * When the parent SV is freed, the extra ref is killed by
5472 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5473 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5475 * When a single backref SV is stored directly, it is not reference
5480 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5487 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5489 /* find slot to store array or singleton backref */
5491 if (SvTYPE(tsv) == SVt_PVHV) {
5492 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5495 if ((mg = mg_find(tsv, PERL_MAGIC_backref))) {
5496 /* Aha. They've got it stowed in magic instead.
5497 * Move it back to xhv_backreferences */
5499 /* Stop mg_free decreasing the reference count. */
5501 /* Stop mg_free even calling the destructor, given that
5502 there's no AV to free up. */
5504 sv_unmagic(tsv, PERL_MAGIC_backref);
5510 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5512 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5513 mg = mg_find(tsv, PERL_MAGIC_backref);
5515 svp = &(mg->mg_obj);
5518 /* create or retrieve the array */
5520 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5521 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5526 SvREFCNT_inc_simple_void(av);
5527 /* av now has a refcnt of 2; see discussion above */
5529 /* move single existing backref to the array */
5531 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5535 mg->mg_flags |= MGf_REFCOUNTED;
5538 av = MUTABLE_AV(*svp);
5541 /* optimisation: store single backref directly in HvAUX or mg_obj */
5545 /* push new backref */
5546 assert(SvTYPE(av) == SVt_PVAV);
5547 if (AvFILLp(av) >= AvMAX(av)) {
5548 av_extend(av, AvFILLp(av)+1);
5550 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5553 /* delete a back-reference to ourselves from the backref magic associated
5554 * with the SV we point to.
5558 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5563 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5565 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5566 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5568 if (!svp || !*svp) {
5570 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5571 svp = mg ? &(mg->mg_obj) : NULL;
5575 Perl_croak(aTHX_ "panic: del_backref");
5577 if (SvTYPE(*svp) == SVt_PVAV) {
5581 AV * const av = (AV*)*svp;
5583 assert(!SvIS_FREED(av));
5587 /* for an SV with N weak references to it, if all those
5588 * weak refs are deleted, then sv_del_backref will be called
5589 * N times and O(N^2) compares will be done within the backref
5590 * array. To ameliorate this potential slowness, we:
5591 * 1) make sure this code is as tight as possible;
5592 * 2) when looking for SV, look for it at both the head and tail of the
5593 * array first before searching the rest, since some create/destroy
5594 * patterns will cause the backrefs to be freed in order.
5601 SV **p = &svp[fill];
5602 SV *const topsv = *p;
5609 /* We weren't the last entry.
5610 An unordered list has this property that you
5611 can take the last element off the end to fill
5612 the hole, and it's still an unordered list :-)
5618 break; /* should only be one */
5625 AvFILLp(av) = fill-1;
5628 /* optimisation: only a single backref, stored directly */
5630 Perl_croak(aTHX_ "panic: del_backref");
5637 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5643 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5648 is_array = (SvTYPE(av) == SVt_PVAV);
5650 assert(!SvIS_FREED(av));
5653 last = svp + AvFILLp(av);
5656 /* optimisation: only a single backref, stored directly */
5662 while (svp <= last) {
5664 SV *const referrer = *svp;
5665 if (SvWEAKREF(referrer)) {
5666 /* XXX Should we check that it hasn't changed? */
5667 assert(SvROK(referrer));
5668 SvRV_set(referrer, 0);
5670 SvWEAKREF_off(referrer);
5671 SvSETMAGIC(referrer);
5672 } else if (SvTYPE(referrer) == SVt_PVGV ||
5673 SvTYPE(referrer) == SVt_PVLV) {
5674 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5675 /* You lookin' at me? */
5676 assert(GvSTASH(referrer));
5677 assert(GvSTASH(referrer) == (const HV *)sv);
5678 GvSTASH(referrer) = 0;
5679 } else if (SvTYPE(referrer) == SVt_PVCV ||
5680 SvTYPE(referrer) == SVt_PVFM) {
5681 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5682 /* You lookin' at me? */
5683 assert(CvSTASH(referrer));
5684 assert(CvSTASH(referrer) == (const HV *)sv);
5685 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5688 assert(SvTYPE(sv) == SVt_PVGV);
5689 /* You lookin' at me? */
5690 assert(CvGV(referrer));
5691 assert(CvGV(referrer) == (const GV *)sv);
5692 anonymise_cv_maybe(MUTABLE_GV(sv),
5693 MUTABLE_CV(referrer));
5698 "panic: magic_killbackrefs (flags=%"UVxf")",
5699 (UV)SvFLAGS(referrer));
5710 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5716 =for apidoc sv_insert
5718 Inserts a string at the specified offset/length within the SV. Similar to
5719 the Perl substr() function. Handles get magic.
5721 =for apidoc sv_insert_flags
5723 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5729 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5734 register char *midend;
5735 register char *bigend;
5739 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5742 Perl_croak(aTHX_ "Can't modify non-existent substring");
5743 SvPV_force_flags(bigstr, curlen, flags);
5744 (void)SvPOK_only_UTF8(bigstr);
5745 if (offset + len > curlen) {
5746 SvGROW(bigstr, offset+len+1);
5747 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5748 SvCUR_set(bigstr, offset+len);
5752 i = littlelen - len;
5753 if (i > 0) { /* string might grow */
5754 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5755 mid = big + offset + len;
5756 midend = bigend = big + SvCUR(bigstr);
5759 while (midend > mid) /* shove everything down */
5760 *--bigend = *--midend;
5761 Move(little,big+offset,littlelen,char);
5762 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5767 Move(little,SvPVX(bigstr)+offset,len,char);
5772 big = SvPVX(bigstr);
5775 bigend = big + SvCUR(bigstr);
5777 if (midend > bigend)
5778 Perl_croak(aTHX_ "panic: sv_insert");
5780 if (mid - big > bigend - midend) { /* faster to shorten from end */
5782 Move(little, mid, littlelen,char);
5785 i = bigend - midend;
5787 Move(midend, mid, i,char);
5791 SvCUR_set(bigstr, mid - big);
5793 else if ((i = mid - big)) { /* faster from front */
5794 midend -= littlelen;
5796 Move(big, midend - i, i, char);
5797 sv_chop(bigstr,midend-i);
5799 Move(little, mid, littlelen,char);
5801 else if (littlelen) {
5802 midend -= littlelen;
5803 sv_chop(bigstr,midend);
5804 Move(little,midend,littlelen,char);
5807 sv_chop(bigstr,midend);
5813 =for apidoc sv_replace
5815 Make the first argument a copy of the second, then delete the original.
5816 The target SV physically takes over ownership of the body of the source SV
5817 and inherits its flags; however, the target keeps any magic it owns,
5818 and any magic in the source is discarded.
5819 Note that this is a rather specialist SV copying operation; most of the
5820 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5826 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5829 const U32 refcnt = SvREFCNT(sv);
5831 PERL_ARGS_ASSERT_SV_REPLACE;
5833 SV_CHECK_THINKFIRST_COW_DROP(sv);
5834 if (SvREFCNT(nsv) != 1) {
5835 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
5836 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
5838 if (SvMAGICAL(sv)) {
5842 sv_upgrade(nsv, SVt_PVMG);
5843 SvMAGIC_set(nsv, SvMAGIC(sv));
5844 SvFLAGS(nsv) |= SvMAGICAL(sv);
5846 SvMAGIC_set(sv, NULL);
5850 assert(!SvREFCNT(sv));
5851 #ifdef DEBUG_LEAKING_SCALARS
5852 sv->sv_flags = nsv->sv_flags;
5853 sv->sv_any = nsv->sv_any;
5854 sv->sv_refcnt = nsv->sv_refcnt;
5855 sv->sv_u = nsv->sv_u;
5857 StructCopy(nsv,sv,SV);
5859 if(SvTYPE(sv) == SVt_IV) {
5861 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5865 #ifdef PERL_OLD_COPY_ON_WRITE
5866 if (SvIsCOW_normal(nsv)) {
5867 /* We need to follow the pointers around the loop to make the
5868 previous SV point to sv, rather than nsv. */
5871 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5874 assert(SvPVX_const(current) == SvPVX_const(nsv));
5876 /* Make the SV before us point to the SV after us. */
5878 PerlIO_printf(Perl_debug_log, "previous is\n");
5880 PerlIO_printf(Perl_debug_log,
5881 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5882 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5884 SV_COW_NEXT_SV_SET(current, sv);
5887 SvREFCNT(sv) = refcnt;
5888 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5893 /* We're about to free a GV which has a CV that refers back to us.
5894 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
5898 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
5904 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
5907 assert(SvREFCNT(gv) == 0);
5908 assert(isGV(gv) && isGV_with_GP(gv));
5910 assert(!CvANON(cv));
5911 assert(CvGV(cv) == gv);
5913 /* will the CV shortly be freed by gp_free() ? */
5914 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
5915 SvANY(cv)->xcv_gv = NULL;
5919 /* if not, anonymise: */
5920 stash = GvSTASH(gv) ? HvNAME(GvSTASH(gv)) : NULL;
5921 gvname = Perl_newSVpvf(aTHX_ "%s::__ANON__",
5922 stash ? stash : "__ANON__");
5923 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
5924 SvREFCNT_dec(gvname);
5928 SvANY(cv)->xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
5933 =for apidoc sv_clear
5935 Clear an SV: call any destructors, free up any memory used by the body,
5936 and free the body itself. The SV's head is I<not> freed, although
5937 its type is set to all 1's so that it won't inadvertently be assumed
5938 to be live during global destruction etc.
5939 This function should only be called when REFCNT is zero. Most of the time
5940 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5947 Perl_sv_clear(pTHX_ SV *const orig_sv)
5952 const struct body_details *sv_type_details;
5955 register SV *sv = orig_sv;
5957 PERL_ARGS_ASSERT_SV_CLEAR;
5959 /* within this loop, sv is the SV currently being freed, and
5960 * iter_sv is the most recent AV or whatever that's being iterated
5961 * over to provide more SVs */
5967 assert(SvREFCNT(sv) == 0);
5968 assert(SvTYPE(sv) != SVTYPEMASK);
5970 if (type <= SVt_IV) {
5971 /* See the comment in sv.h about the collusion between this
5972 * early return and the overloading of the NULL slots in the
5976 SvFLAGS(sv) &= SVf_BREAK;
5977 SvFLAGS(sv) |= SVTYPEMASK;
5982 if (PL_defstash && /* Still have a symbol table? */
5989 stash = SvSTASH(sv);
5990 destructor = StashHANDLER(stash,DESTROY);
5992 /* A constant subroutine can have no side effects, so
5993 don't bother calling it. */
5994 && !CvCONST(destructor)
5995 /* Don't bother calling an empty destructor */
5996 && (CvISXSUB(destructor)
5997 || (CvSTART(destructor)
5998 && (CvSTART(destructor)->op_next->op_type
6001 SV* const tmpref = newRV(sv);
6002 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6004 PUSHSTACKi(PERLSI_DESTROY);
6009 call_sv(MUTABLE_SV(destructor),
6010 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6014 if(SvREFCNT(tmpref) < 2) {
6015 /* tmpref is not kept alive! */
6017 SvRV_set(tmpref, NULL);
6020 SvREFCNT_dec(tmpref);
6022 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6026 if (PL_in_clean_objs)
6028 "DESTROY created new reference to dead object '%s'",
6030 /* DESTROY gave object new lease on life */
6036 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
6037 SvOBJECT_off(sv); /* Curse the object. */
6038 if (type != SVt_PVIO)
6039 --PL_sv_objcount;/* XXX Might want something more general */
6042 if (type >= SVt_PVMG) {
6043 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6044 SvREFCNT_dec(SvOURSTASH(sv));
6045 } else if (SvMAGIC(sv))
6047 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6048 SvREFCNT_dec(SvSTASH(sv));
6051 /* case SVt_BIND: */
6054 IoIFP(sv) != PerlIO_stdin() &&
6055 IoIFP(sv) != PerlIO_stdout() &&
6056 IoIFP(sv) != PerlIO_stderr() &&
6057 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6059 io_close(MUTABLE_IO(sv), FALSE);
6061 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6062 PerlDir_close(IoDIRP(sv));
6063 IoDIRP(sv) = (DIR*)NULL;
6064 Safefree(IoTOP_NAME(sv));
6065 Safefree(IoFMT_NAME(sv));
6066 Safefree(IoBOTTOM_NAME(sv));
6069 /* FIXME for plugins */
6070 pregfree2((REGEXP*) sv);
6074 cv_undef(MUTABLE_CV(sv));
6075 /* If we're in a stash, we don't own a reference to it.
6076 * However it does have a back reference to us, which needs to
6078 if ((stash = CvSTASH(sv)))
6079 sv_del_backref(MUTABLE_SV(stash), sv);
6082 if (PL_last_swash_hv == (const HV *)sv) {
6083 PL_last_swash_hv = NULL;
6085 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6086 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6090 AV* av = MUTABLE_AV(sv);
6091 if (PL_comppad == av) {
6095 if (AvREAL(av) && AvFILLp(av) > -1) {
6096 next_sv = AvARRAY(av)[AvFILLp(av)--];
6097 /* save old iter_sv in top-most slot of AV,
6098 * and pray that it doesn't get wiped in the meantime */
6099 AvARRAY(av)[AvMAX(av)] = iter_sv;
6101 goto get_next_sv; /* process this new sv */
6103 Safefree(AvALLOC(av));
6108 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6109 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6110 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6111 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6113 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6114 SvREFCNT_dec(LvTARG(sv));
6116 if (isGV_with_GP(sv)) {
6117 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6118 && HvENAME_get(stash))
6119 mro_method_changed_in(stash);
6120 gp_free(MUTABLE_GV(sv));
6122 unshare_hek(GvNAME_HEK(sv));
6123 /* If we're in a stash, we don't own a reference to it.
6124 * However it does have a back reference to us, which
6125 * needs to be cleared. */
6126 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6127 sv_del_backref(MUTABLE_SV(stash), sv);
6129 /* FIXME. There are probably more unreferenced pointers to SVs
6130 * in the interpreter struct that we should check and tidy in
6131 * a similar fashion to this: */
6132 if ((const GV *)sv == PL_last_in_gv)
6133 PL_last_in_gv = NULL;
6139 /* Don't bother with SvOOK_off(sv); as we're only going to
6143 SvOOK_offset(sv, offset);
6144 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6145 /* Don't even bother with turning off the OOK flag. */
6150 SV * const target = SvRV(sv);
6152 sv_del_backref(target, sv);
6157 #ifdef PERL_OLD_COPY_ON_WRITE
6158 else if (SvPVX_const(sv)
6159 && !(SvTYPE(sv) == SVt_PVIO
6160 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6164 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6168 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6170 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6174 } else if (SvLEN(sv)) {
6175 Safefree(SvPVX_const(sv));
6179 else if (SvPVX_const(sv) && SvLEN(sv)
6180 && !(SvTYPE(sv) == SVt_PVIO
6181 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6182 Safefree(SvPVX_mutable(sv));
6183 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6184 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6195 SvFLAGS(sv) &= SVf_BREAK;
6196 SvFLAGS(sv) |= SVTYPEMASK;
6198 sv_type_details = bodies_by_type + type;
6199 if (sv_type_details->arena) {
6200 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6201 &PL_body_roots[type]);
6203 else if (sv_type_details->body_size) {
6204 safefree(SvANY(sv));
6208 /* caller is responsible for freeing the head of the original sv */
6209 if (sv != orig_sv && !SvREFCNT(sv))
6212 /* grab and free next sv, if any */
6220 else if (!iter_sv) {
6222 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6223 AV *const av = (AV*)iter_sv;
6224 if (AvFILLp(av) > -1) {
6225 sv = AvARRAY(av)[AvFILLp(av)--];
6227 else { /* no more elements of current AV to free */
6230 /* restore previous value, squirrelled away */
6231 iter_sv = AvARRAY(av)[AvMAX(av)];
6232 Safefree(AvALLOC(av));
6237 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6241 if (!SvREFCNT(sv)) {
6245 if (--(SvREFCNT(sv)))
6249 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6250 "Attempt to free temp prematurely: SV 0x%"UVxf
6251 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6255 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6256 /* make sure SvREFCNT(sv)==0 happens very seldom */
6257 SvREFCNT(sv) = (~(U32)0)/2;
6267 =for apidoc sv_newref
6269 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6276 Perl_sv_newref(pTHX_ SV *const sv)
6278 PERL_UNUSED_CONTEXT;
6287 Decrement an SV's reference count, and if it drops to zero, call
6288 C<sv_clear> to invoke destructors and free up any memory used by
6289 the body; finally, deallocate the SV's head itself.
6290 Normally called via a wrapper macro C<SvREFCNT_dec>.
6296 Perl_sv_free(pTHX_ SV *const sv)
6301 if (SvREFCNT(sv) == 0) {
6302 if (SvFLAGS(sv) & SVf_BREAK)
6303 /* this SV's refcnt has been artificially decremented to
6304 * trigger cleanup */
6306 if (PL_in_clean_all) /* All is fair */
6308 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6309 /* make sure SvREFCNT(sv)==0 happens very seldom */
6310 SvREFCNT(sv) = (~(U32)0)/2;
6313 if (ckWARN_d(WARN_INTERNAL)) {
6314 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6315 Perl_dump_sv_child(aTHX_ sv);
6317 #ifdef DEBUG_LEAKING_SCALARS
6320 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6321 if (PL_warnhook == PERL_WARNHOOK_FATAL
6322 || ckDEAD(packWARN(WARN_INTERNAL))) {
6323 /* Don't let Perl_warner cause us to escape our fate: */
6327 /* This may not return: */
6328 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6329 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6330 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6333 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6338 if (--(SvREFCNT(sv)) > 0)
6340 Perl_sv_free2(aTHX_ sv);
6344 Perl_sv_free2(pTHX_ SV *const sv)
6348 PERL_ARGS_ASSERT_SV_FREE2;
6352 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6353 "Attempt to free temp prematurely: SV 0x%"UVxf
6354 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6358 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6359 /* make sure SvREFCNT(sv)==0 happens very seldom */
6360 SvREFCNT(sv) = (~(U32)0)/2;
6371 Returns the length of the string in the SV. Handles magic and type
6372 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6378 Perl_sv_len(pTHX_ register SV *const sv)
6386 len = mg_length(sv);
6388 (void)SvPV_const(sv, len);
6393 =for apidoc sv_len_utf8
6395 Returns the number of characters in the string in an SV, counting wide
6396 UTF-8 bytes as a single character. Handles magic and type coercion.
6402 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6403 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6404 * (Note that the mg_len is not the length of the mg_ptr field.
6405 * This allows the cache to store the character length of the string without
6406 * needing to malloc() extra storage to attach to the mg_ptr.)
6411 Perl_sv_len_utf8(pTHX_ register SV *const sv)
6417 return mg_length(sv);
6421 const U8 *s = (U8*)SvPV_const(sv, len);
6425 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6427 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6428 if (mg->mg_len != -1)
6431 /* We can use the offset cache for a headstart.
6432 The longer value is stored in the first pair. */
6433 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6435 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6439 if (PL_utf8cache < 0) {
6440 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6441 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6445 ulen = Perl_utf8_length(aTHX_ s, s + len);
6446 utf8_mg_len_cache_update(sv, &mg, ulen);
6450 return Perl_utf8_length(aTHX_ s, s + len);
6454 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6457 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6458 STRLEN *const uoffset_p, bool *const at_end)
6460 const U8 *s = start;
6461 STRLEN uoffset = *uoffset_p;
6463 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6465 while (s < send && uoffset) {
6472 else if (s > send) {
6474 /* This is the existing behaviour. Possibly it should be a croak, as
6475 it's actually a bounds error */
6478 *uoffset_p -= uoffset;
6482 /* Given the length of the string in both bytes and UTF-8 characters, decide
6483 whether to walk forwards or backwards to find the byte corresponding to
6484 the passed in UTF-8 offset. */
6486 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6487 STRLEN uoffset, const STRLEN uend)
6489 STRLEN backw = uend - uoffset;
6491 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6493 if (uoffset < 2 * backw) {
6494 /* The assumption is that going forwards is twice the speed of going
6495 forward (that's where the 2 * backw comes from).
6496 (The real figure of course depends on the UTF-8 data.) */
6497 const U8 *s = start;
6499 while (s < send && uoffset--)
6509 while (UTF8_IS_CONTINUATION(*send))
6512 return send - start;
6515 /* For the string representation of the given scalar, find the byte
6516 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6517 give another position in the string, *before* the sought offset, which
6518 (which is always true, as 0, 0 is a valid pair of positions), which should
6519 help reduce the amount of linear searching.
6520 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6521 will be used to reduce the amount of linear searching. The cache will be
6522 created if necessary, and the found value offered to it for update. */
6524 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6525 const U8 *const send, STRLEN uoffset,
6526 STRLEN uoffset0, STRLEN boffset0)
6528 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6530 bool at_end = FALSE;
6532 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6534 assert (uoffset >= uoffset0);
6541 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6542 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6543 if ((*mgp)->mg_ptr) {
6544 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6545 if (cache[0] == uoffset) {
6546 /* An exact match. */
6549 if (cache[2] == uoffset) {
6550 /* An exact match. */
6554 if (cache[0] < uoffset) {
6555 /* The cache already knows part of the way. */
6556 if (cache[0] > uoffset0) {
6557 /* The cache knows more than the passed in pair */
6558 uoffset0 = cache[0];
6559 boffset0 = cache[1];
6561 if ((*mgp)->mg_len != -1) {
6562 /* And we know the end too. */
6564 + sv_pos_u2b_midway(start + boffset0, send,
6566 (*mgp)->mg_len - uoffset0);
6568 uoffset -= uoffset0;
6570 + sv_pos_u2b_forwards(start + boffset0,
6571 send, &uoffset, &at_end);
6572 uoffset += uoffset0;
6575 else if (cache[2] < uoffset) {
6576 /* We're between the two cache entries. */
6577 if (cache[2] > uoffset0) {
6578 /* and the cache knows more than the passed in pair */
6579 uoffset0 = cache[2];
6580 boffset0 = cache[3];
6584 + sv_pos_u2b_midway(start + boffset0,
6587 cache[0] - uoffset0);
6590 + sv_pos_u2b_midway(start + boffset0,
6593 cache[2] - uoffset0);
6597 else if ((*mgp)->mg_len != -1) {
6598 /* If we can take advantage of a passed in offset, do so. */
6599 /* In fact, offset0 is either 0, or less than offset, so don't
6600 need to worry about the other possibility. */
6602 + sv_pos_u2b_midway(start + boffset0, send,
6604 (*mgp)->mg_len - uoffset0);
6609 if (!found || PL_utf8cache < 0) {
6610 STRLEN real_boffset;
6611 uoffset -= uoffset0;
6612 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6613 send, &uoffset, &at_end);
6614 uoffset += uoffset0;
6616 if (found && PL_utf8cache < 0)
6617 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6619 boffset = real_boffset;
6624 utf8_mg_len_cache_update(sv, mgp, uoffset);
6626 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6633 =for apidoc sv_pos_u2b_flags
6635 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6636 the start of the string, to a count of the equivalent number of bytes; if
6637 lenp is non-zero, it does the same to lenp, but this time starting from
6638 the offset, rather than from the start of the string. Handles type coercion.
6639 I<flags> is passed to C<SvPV_flags>, and usually should be
6640 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6646 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6647 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6648 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6653 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6660 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6662 start = (U8*)SvPV_flags(sv, len, flags);
6664 const U8 * const send = start + len;
6666 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6669 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6670 is 0, and *lenp is already set to that. */) {
6671 /* Convert the relative offset to absolute. */
6672 const STRLEN uoffset2 = uoffset + *lenp;
6673 const STRLEN boffset2
6674 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6675 uoffset, boffset) - boffset;
6689 =for apidoc sv_pos_u2b
6691 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6692 the start of the string, to a count of the equivalent number of bytes; if
6693 lenp is non-zero, it does the same to lenp, but this time starting from
6694 the offset, rather than from the start of the string. Handles magic and
6697 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
6704 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6705 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6706 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6710 /* This function is subject to size and sign problems */
6713 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
6715 PERL_ARGS_ASSERT_SV_POS_U2B;
6718 STRLEN ulen = (STRLEN)*lenp;
6719 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
6720 SV_GMAGIC|SV_CONST_RETURN);
6723 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
6724 SV_GMAGIC|SV_CONST_RETURN);
6729 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
6732 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
6736 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6737 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6738 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6742 (*mgp)->mg_len = ulen;
6743 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
6744 if (ulen != (STRLEN) (*mgp)->mg_len)
6745 (*mgp)->mg_len = -1;
6748 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
6749 byte length pairing. The (byte) length of the total SV is passed in too,
6750 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
6751 may not have updated SvCUR, so we can't rely on reading it directly.
6753 The proffered utf8/byte length pairing isn't used if the cache already has
6754 two pairs, and swapping either for the proffered pair would increase the
6755 RMS of the intervals between known byte offsets.
6757 The cache itself consists of 4 STRLEN values
6758 0: larger UTF-8 offset
6759 1: corresponding byte offset
6760 2: smaller UTF-8 offset
6761 3: corresponding byte offset
6763 Unused cache pairs have the value 0, 0.
6764 Keeping the cache "backwards" means that the invariant of
6765 cache[0] >= cache[2] is maintained even with empty slots, which means that
6766 the code that uses it doesn't need to worry if only 1 entry has actually
6767 been set to non-zero. It also makes the "position beyond the end of the
6768 cache" logic much simpler, as the first slot is always the one to start
6772 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6773 const STRLEN utf8, const STRLEN blen)
6777 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6782 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
6783 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
6784 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6786 (*mgp)->mg_len = -1;
6790 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6791 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6792 (*mgp)->mg_ptr = (char *) cache;
6796 if (PL_utf8cache < 0 && SvPOKp(sv)) {
6797 /* SvPOKp() because it's possible that sv has string overloading, and
6798 therefore is a reference, hence SvPVX() is actually a pointer.
6799 This cures the (very real) symptoms of RT 69422, but I'm not actually
6800 sure whether we should even be caching the results of UTF-8
6801 operations on overloading, given that nothing stops overloading
6802 returning a different value every time it's called. */
6803 const U8 *start = (const U8 *) SvPVX_const(sv);
6804 const STRLEN realutf8 = utf8_length(start, start + byte);
6806 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
6810 /* Cache is held with the later position first, to simplify the code
6811 that deals with unbounded ends. */
6813 ASSERT_UTF8_CACHE(cache);
6814 if (cache[1] == 0) {
6815 /* Cache is totally empty */
6818 } else if (cache[3] == 0) {
6819 if (byte > cache[1]) {
6820 /* New one is larger, so goes first. */
6821 cache[2] = cache[0];
6822 cache[3] = cache[1];
6830 #define THREEWAY_SQUARE(a,b,c,d) \
6831 ((float)((d) - (c))) * ((float)((d) - (c))) \
6832 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6833 + ((float)((b) - (a))) * ((float)((b) - (a)))
6835 /* Cache has 2 slots in use, and we know three potential pairs.
6836 Keep the two that give the lowest RMS distance. Do the
6837 calcualation in bytes simply because we always know the byte
6838 length. squareroot has the same ordering as the positive value,
6839 so don't bother with the actual square root. */
6840 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6841 if (byte > cache[1]) {
6842 /* New position is after the existing pair of pairs. */
6843 const float keep_earlier
6844 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6845 const float keep_later
6846 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6848 if (keep_later < keep_earlier) {
6849 if (keep_later < existing) {
6850 cache[2] = cache[0];
6851 cache[3] = cache[1];
6857 if (keep_earlier < existing) {
6863 else if (byte > cache[3]) {
6864 /* New position is between the existing pair of pairs. */
6865 const float keep_earlier
6866 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6867 const float keep_later
6868 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6870 if (keep_later < keep_earlier) {
6871 if (keep_later < existing) {
6877 if (keep_earlier < existing) {
6884 /* New position is before the existing pair of pairs. */
6885 const float keep_earlier
6886 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6887 const float keep_later
6888 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6890 if (keep_later < keep_earlier) {
6891 if (keep_later < existing) {
6897 if (keep_earlier < existing) {
6898 cache[0] = cache[2];
6899 cache[1] = cache[3];
6906 ASSERT_UTF8_CACHE(cache);
6909 /* We already know all of the way, now we may be able to walk back. The same
6910 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6911 backward is half the speed of walking forward. */
6913 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6914 const U8 *end, STRLEN endu)
6916 const STRLEN forw = target - s;
6917 STRLEN backw = end - target;
6919 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6921 if (forw < 2 * backw) {
6922 return utf8_length(s, target);
6925 while (end > target) {
6927 while (UTF8_IS_CONTINUATION(*end)) {
6936 =for apidoc sv_pos_b2u
6938 Converts the value pointed to by offsetp from a count of bytes from the
6939 start of the string, to a count of the equivalent number of UTF-8 chars.
6940 Handles magic and type coercion.
6946 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6947 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6952 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6955 const STRLEN byte = *offsetp;
6956 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6962 PERL_ARGS_ASSERT_SV_POS_B2U;
6967 s = (const U8*)SvPV_const(sv, blen);
6970 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6976 && SvTYPE(sv) >= SVt_PVMG
6977 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
6980 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6981 if (cache[1] == byte) {
6982 /* An exact match. */
6983 *offsetp = cache[0];
6986 if (cache[3] == byte) {
6987 /* An exact match. */
6988 *offsetp = cache[2];
6992 if (cache[1] < byte) {
6993 /* We already know part of the way. */
6994 if (mg->mg_len != -1) {
6995 /* Actually, we know the end too. */
6997 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6998 s + blen, mg->mg_len - cache[0]);
7000 len = cache[0] + utf8_length(s + cache[1], send);
7003 else if (cache[3] < byte) {
7004 /* We're between the two cached pairs, so we do the calculation
7005 offset by the byte/utf-8 positions for the earlier pair,
7006 then add the utf-8 characters from the string start to
7008 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7009 s + cache[1], cache[0] - cache[2])
7013 else { /* cache[3] > byte */
7014 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7018 ASSERT_UTF8_CACHE(cache);
7020 } else if (mg->mg_len != -1) {
7021 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7025 if (!found || PL_utf8cache < 0) {
7026 const STRLEN real_len = utf8_length(s, send);
7028 if (found && PL_utf8cache < 0)
7029 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7036 utf8_mg_len_cache_update(sv, &mg, len);
7038 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7043 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7044 STRLEN real, SV *const sv)
7046 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7048 /* As this is debugging only code, save space by keeping this test here,
7049 rather than inlining it in all the callers. */
7050 if (from_cache == real)
7053 /* Need to turn the assertions off otherwise we may recurse infinitely
7054 while printing error messages. */
7055 SAVEI8(PL_utf8cache);
7057 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7058 func, (UV) from_cache, (UV) real, SVfARG(sv));
7064 Returns a boolean indicating whether the strings in the two SVs are
7065 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7066 coerce its args to strings if necessary.
7068 =for apidoc sv_eq_flags
7070 Returns a boolean indicating whether the strings in the two SVs are
7071 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7072 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7078 Perl_sv_eq_flags(pTHX_ register SV *sv1, register SV *sv2, const U32 flags)
7087 SV* svrecode = NULL;
7094 /* if pv1 and pv2 are the same, second SvPV_const call may
7095 * invalidate pv1 (if we are handling magic), so we may need to
7097 if (sv1 == sv2 && flags & SV_GMAGIC
7098 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7099 pv1 = SvPV_const(sv1, cur1);
7100 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7102 pv1 = SvPV_flags_const(sv1, cur1, flags);
7110 pv2 = SvPV_flags_const(sv2, cur2, flags);
7112 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7113 /* Differing utf8ness.
7114 * Do not UTF8size the comparands as a side-effect. */
7117 svrecode = newSVpvn(pv2, cur2);
7118 sv_recode_to_utf8(svrecode, PL_encoding);
7119 pv2 = SvPV_const(svrecode, cur2);
7122 svrecode = newSVpvn(pv1, cur1);
7123 sv_recode_to_utf8(svrecode, PL_encoding);
7124 pv1 = SvPV_const(svrecode, cur1);
7126 /* Now both are in UTF-8. */
7128 SvREFCNT_dec(svrecode);
7134 /* sv1 is the UTF-8 one */
7135 return bytes_cmp_utf8((const U8*)pv2, cur2,
7136 (const U8*)pv1, cur1) == 0;
7139 /* sv2 is the UTF-8 one */
7140 return bytes_cmp_utf8((const U8*)pv1, cur1,
7141 (const U8*)pv2, cur2) == 0;
7147 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7149 SvREFCNT_dec(svrecode);
7159 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7160 string in C<sv1> is less than, equal to, or greater than the string in
7161 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7162 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7164 =for apidoc sv_cmp_flags
7166 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7167 string in C<sv1> is less than, equal to, or greater than the string in
7168 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7169 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7170 also C<sv_cmp_locale_flags>.
7176 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
7178 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7182 Perl_sv_cmp_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7187 const char *pv1, *pv2;
7190 SV *svrecode = NULL;
7197 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 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7217 (const U8*)pv1, cur1);
7218 return retval ? retval < 0 ? -1 : +1 : 0;
7223 svrecode = newSVpvn(pv1, cur1);
7224 sv_recode_to_utf8(svrecode, PL_encoding);
7225 pv1 = SvPV_const(svrecode, cur1);
7228 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7229 (const U8*)pv2, cur2);
7230 return retval ? retval < 0 ? -1 : +1 : 0;
7236 cmp = cur2 ? -1 : 0;
7240 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7243 cmp = retval < 0 ? -1 : 1;
7244 } else if (cur1 == cur2) {
7247 cmp = cur1 < cur2 ? -1 : 1;
7251 SvREFCNT_dec(svrecode);
7259 =for apidoc sv_cmp_locale
7261 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7262 'use bytes' aware, handles get magic, and will coerce its args to strings
7263 if necessary. See also C<sv_cmp>.
7265 =for apidoc sv_cmp_locale_flags
7267 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7268 'use bytes' aware and will coerce its args to strings if necessary. If the
7269 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7275 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
7277 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7281 Perl_sv_cmp_locale_flags(pTHX_ register SV *const sv1, register SV *const sv2,
7285 #ifdef USE_LOCALE_COLLATE
7291 if (PL_collation_standard)
7295 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7297 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7299 if (!pv1 || !len1) {
7310 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7313 return retval < 0 ? -1 : 1;
7316 * When the result of collation is equality, that doesn't mean
7317 * that there are no differences -- some locales exclude some
7318 * characters from consideration. So to avoid false equalities,
7319 * we use the raw string as a tiebreaker.
7325 #endif /* USE_LOCALE_COLLATE */
7327 return sv_cmp(sv1, sv2);
7331 #ifdef USE_LOCALE_COLLATE
7334 =for apidoc sv_collxfrm
7336 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7337 C<sv_collxfrm_flags>.
7339 =for apidoc sv_collxfrm_flags
7341 Add Collate Transform magic to an SV if it doesn't already have it. If the
7342 flags contain SV_GMAGIC, it handles get-magic.
7344 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7345 scalar data of the variable, but transformed to such a format that a normal
7346 memory comparison can be used to compare the data according to the locale
7353 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7358 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7360 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7361 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7367 Safefree(mg->mg_ptr);
7368 s = SvPV_flags_const(sv, len, flags);
7369 if ((xf = mem_collxfrm(s, len, &xlen))) {
7371 #ifdef PERL_OLD_COPY_ON_WRITE
7373 sv_force_normal_flags(sv, 0);
7375 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7389 if (mg && mg->mg_ptr) {
7391 return mg->mg_ptr + sizeof(PL_collation_ix);
7399 #endif /* USE_LOCALE_COLLATE */
7402 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7404 SV * const tsv = newSV(0);
7407 sv_gets(tsv, fp, 0);
7408 sv_utf8_upgrade_nomg(tsv);
7409 SvCUR_set(sv,append);
7412 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7416 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7419 const U32 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7420 /* Grab the size of the record we're getting */
7421 char *const buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7428 /* VMS wants read instead of fread, because fread doesn't respect */
7429 /* RMS record boundaries. This is not necessarily a good thing to be */
7430 /* doing, but we've got no other real choice - except avoid stdio
7431 as implementation - perhaps write a :vms layer ?
7433 fd = PerlIO_fileno(fp);
7435 bytesread = PerlLIO_read(fd, buffer, recsize);
7437 else /* in-memory file from PerlIO::Scalar */
7440 bytesread = PerlIO_read(fp, buffer, recsize);
7445 SvCUR_set(sv, bytesread + append);
7446 buffer[bytesread] = '\0';
7447 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7453 Get a line from the filehandle and store it into the SV, optionally
7454 appending to the currently-stored string.
7460 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
7465 register STDCHAR rslast;
7466 register STDCHAR *bp;
7471 PERL_ARGS_ASSERT_SV_GETS;
7473 if (SvTHINKFIRST(sv))
7474 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7475 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7477 However, perlbench says it's slower, because the existing swipe code
7478 is faster than copy on write.
7479 Swings and roundabouts. */
7480 SvUPGRADE(sv, SVt_PV);
7485 if (PerlIO_isutf8(fp)) {
7487 sv_utf8_upgrade_nomg(sv);
7488 sv_pos_u2b(sv,&append,0);
7490 } else if (SvUTF8(sv)) {
7491 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7499 if (PerlIO_isutf8(fp))
7502 if (IN_PERL_COMPILETIME) {
7503 /* we always read code in line mode */
7507 else if (RsSNARF(PL_rs)) {
7508 /* If it is a regular disk file use size from stat() as estimate
7509 of amount we are going to read -- may result in mallocing
7510 more memory than we really need if the layers below reduce
7511 the size we read (e.g. CRLF or a gzip layer).
7514 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7515 const Off_t offset = PerlIO_tell(fp);
7516 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7517 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7523 else if (RsRECORD(PL_rs)) {
7524 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7526 else if (RsPARA(PL_rs)) {
7532 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7533 if (PerlIO_isutf8(fp)) {
7534 rsptr = SvPVutf8(PL_rs, rslen);
7537 if (SvUTF8(PL_rs)) {
7538 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7539 Perl_croak(aTHX_ "Wide character in $/");
7542 rsptr = SvPV_const(PL_rs, rslen);
7546 rslast = rslen ? rsptr[rslen - 1] : '\0';
7548 if (rspara) { /* have to do this both before and after */
7549 do { /* to make sure file boundaries work right */
7552 i = PerlIO_getc(fp);
7556 PerlIO_ungetc(fp,i);
7562 /* See if we know enough about I/O mechanism to cheat it ! */
7564 /* This used to be #ifdef test - it is made run-time test for ease
7565 of abstracting out stdio interface. One call should be cheap
7566 enough here - and may even be a macro allowing compile
7570 if (PerlIO_fast_gets(fp)) {
7573 * We're going to steal some values from the stdio struct
7574 * and put EVERYTHING in the innermost loop into registers.
7576 register STDCHAR *ptr;
7580 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7581 /* An ungetc()d char is handled separately from the regular
7582 * buffer, so we getc() it back out and stuff it in the buffer.
7584 i = PerlIO_getc(fp);
7585 if (i == EOF) return 0;
7586 *(--((*fp)->_ptr)) = (unsigned char) i;
7590 /* Here is some breathtakingly efficient cheating */
7592 cnt = PerlIO_get_cnt(fp); /* get count into register */
7593 /* make sure we have the room */
7594 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7595 /* Not room for all of it
7596 if we are looking for a separator and room for some
7598 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7599 /* just process what we have room for */
7600 shortbuffered = cnt - SvLEN(sv) + append + 1;
7601 cnt -= shortbuffered;
7605 /* remember that cnt can be negative */
7606 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7611 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7612 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7613 DEBUG_P(PerlIO_printf(Perl_debug_log,
7614 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7615 DEBUG_P(PerlIO_printf(Perl_debug_log,
7616 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7617 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7618 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7623 while (cnt > 0) { /* this | eat */
7625 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7626 goto thats_all_folks; /* screams | sed :-) */
7630 Copy(ptr, bp, cnt, char); /* this | eat */
7631 bp += cnt; /* screams | dust */
7632 ptr += cnt; /* louder | sed :-) */
7634 assert (!shortbuffered);
7635 goto cannot_be_shortbuffered;
7639 if (shortbuffered) { /* oh well, must extend */
7640 cnt = shortbuffered;
7642 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7644 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7645 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7649 cannot_be_shortbuffered:
7650 DEBUG_P(PerlIO_printf(Perl_debug_log,
7651 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7652 PTR2UV(ptr),(long)cnt));
7653 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7655 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7656 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7657 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7658 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7660 /* This used to call 'filbuf' in stdio form, but as that behaves like
7661 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7662 another abstraction. */
7663 i = PerlIO_getc(fp); /* get more characters */
7665 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
7666 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7667 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7668 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7670 cnt = PerlIO_get_cnt(fp);
7671 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7672 DEBUG_P(PerlIO_printf(Perl_debug_log,
7673 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7675 if (i == EOF) /* all done for ever? */
7676 goto thats_really_all_folks;
7678 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
7680 SvGROW(sv, bpx + cnt + 2);
7681 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
7683 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7685 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7686 goto thats_all_folks;
7690 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
7691 memNE((char*)bp - rslen, rsptr, rslen))
7692 goto screamer; /* go back to the fray */
7693 thats_really_all_folks:
7695 cnt += shortbuffered;
7696 DEBUG_P(PerlIO_printf(Perl_debug_log,
7697 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7698 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7699 DEBUG_P(PerlIO_printf(Perl_debug_log,
7700 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7701 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7702 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7704 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
7705 DEBUG_P(PerlIO_printf(Perl_debug_log,
7706 "Screamer: done, len=%ld, string=|%.*s|\n",
7707 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
7711 /*The big, slow, and stupid way. */
7712 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7713 STDCHAR *buf = NULL;
7714 Newx(buf, 8192, STDCHAR);
7722 register const STDCHAR * const bpe = buf + sizeof(buf);
7724 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7725 ; /* keep reading */
7729 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7730 /* Accomodate broken VAXC compiler, which applies U8 cast to
7731 * both args of ?: operator, causing EOF to change into 255
7734 i = (U8)buf[cnt - 1];
7740 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7742 sv_catpvn(sv, (char *) buf, cnt);
7744 sv_setpvn(sv, (char *) buf, cnt);
7746 if (i != EOF && /* joy */
7748 SvCUR(sv) < rslen ||
7749 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7753 * If we're reading from a TTY and we get a short read,
7754 * indicating that the user hit his EOF character, we need
7755 * to notice it now, because if we try to read from the TTY
7756 * again, the EOF condition will disappear.
7758 * The comparison of cnt to sizeof(buf) is an optimization
7759 * that prevents unnecessary calls to feof().
7763 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
7767 #ifdef USE_HEAP_INSTEAD_OF_STACK
7772 if (rspara) { /* have to do this both before and after */
7773 while (i != EOF) { /* to make sure file boundaries work right */
7774 i = PerlIO_getc(fp);
7776 PerlIO_ungetc(fp,i);
7782 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7788 Auto-increment of the value in the SV, doing string to numeric conversion
7789 if necessary. Handles 'get' magic and operator overloading.
7795 Perl_sv_inc(pTHX_ register SV *const sv)
7804 =for apidoc sv_inc_nomg
7806 Auto-increment of the value in the SV, doing string to numeric conversion
7807 if necessary. Handles operator overloading. Skips handling 'get' magic.
7813 Perl_sv_inc_nomg(pTHX_ register SV *const sv)
7821 if (SvTHINKFIRST(sv)) {
7823 sv_force_normal_flags(sv, 0);
7824 if (SvREADONLY(sv)) {
7825 if (IN_PERL_RUNTIME)
7826 Perl_croak_no_modify(aTHX);
7830 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
7832 i = PTR2IV(SvRV(sv));
7837 flags = SvFLAGS(sv);
7838 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7839 /* It's (privately or publicly) a float, but not tested as an
7840 integer, so test it to see. */
7842 flags = SvFLAGS(sv);
7844 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7845 /* It's publicly an integer, or privately an integer-not-float */
7846 #ifdef PERL_PRESERVE_IVUV
7850 if (SvUVX(sv) == UV_MAX)
7851 sv_setnv(sv, UV_MAX_P1);
7853 (void)SvIOK_only_UV(sv);
7854 SvUV_set(sv, SvUVX(sv) + 1);
7856 if (SvIVX(sv) == IV_MAX)
7857 sv_setuv(sv, (UV)IV_MAX + 1);
7859 (void)SvIOK_only(sv);
7860 SvIV_set(sv, SvIVX(sv) + 1);
7865 if (flags & SVp_NOK) {
7866 const NV was = SvNVX(sv);
7867 if (NV_OVERFLOWS_INTEGERS_AT &&
7868 was >= NV_OVERFLOWS_INTEGERS_AT) {
7869 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
7870 "Lost precision when incrementing %" NVff " by 1",
7873 (void)SvNOK_only(sv);
7874 SvNV_set(sv, was + 1.0);
7878 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7879 if ((flags & SVTYPEMASK) < SVt_PVIV)
7880 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7881 (void)SvIOK_only(sv);
7886 while (isALPHA(*d)) d++;
7887 while (isDIGIT(*d)) d++;
7888 if (d < SvEND(sv)) {
7889 #ifdef PERL_PRESERVE_IVUV
7890 /* Got to punt this as an integer if needs be, but we don't issue
7891 warnings. Probably ought to make the sv_iv_please() that does
7892 the conversion if possible, and silently. */
7893 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7894 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7895 /* Need to try really hard to see if it's an integer.
7896 9.22337203685478e+18 is an integer.
7897 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7898 so $a="9.22337203685478e+18"; $a+0; $a++
7899 needs to be the same as $a="9.22337203685478e+18"; $a++
7906 /* sv_2iv *should* have made this an NV */
7907 if (flags & SVp_NOK) {
7908 (void)SvNOK_only(sv);
7909 SvNV_set(sv, SvNVX(sv) + 1.0);
7912 /* I don't think we can get here. Maybe I should assert this
7913 And if we do get here I suspect that sv_setnv will croak. NWC
7915 #if defined(USE_LONG_DOUBLE)
7916 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",
7917 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7919 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7920 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7923 #endif /* PERL_PRESERVE_IVUV */
7924 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7928 while (d >= SvPVX_const(sv)) {
7936 /* MKS: The original code here died if letters weren't consecutive.
7937 * at least it didn't have to worry about non-C locales. The
7938 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7939 * arranged in order (although not consecutively) and that only
7940 * [A-Za-z] are accepted by isALPHA in the C locale.
7942 if (*d != 'z' && *d != 'Z') {
7943 do { ++*d; } while (!isALPHA(*d));
7946 *(d--) -= 'z' - 'a';
7951 *(d--) -= 'z' - 'a' + 1;
7955 /* oh,oh, the number grew */
7956 SvGROW(sv, SvCUR(sv) + 2);
7957 SvCUR_set(sv, SvCUR(sv) + 1);
7958 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7969 Auto-decrement of the value in the SV, doing string to numeric conversion
7970 if necessary. Handles 'get' magic and operator overloading.
7976 Perl_sv_dec(pTHX_ register SV *const sv)
7986 =for apidoc sv_dec_nomg
7988 Auto-decrement of the value in the SV, doing string to numeric conversion
7989 if necessary. Handles operator overloading. Skips handling 'get' magic.
7995 Perl_sv_dec_nomg(pTHX_ register SV *const sv)
8002 if (SvTHINKFIRST(sv)) {
8004 sv_force_normal_flags(sv, 0);
8005 if (SvREADONLY(sv)) {
8006 if (IN_PERL_RUNTIME)
8007 Perl_croak_no_modify(aTHX);
8011 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8013 i = PTR2IV(SvRV(sv));
8018 /* Unlike sv_inc we don't have to worry about string-never-numbers
8019 and keeping them magic. But we mustn't warn on punting */
8020 flags = SvFLAGS(sv);
8021 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8022 /* It's publicly an integer, or privately an integer-not-float */
8023 #ifdef PERL_PRESERVE_IVUV
8027 if (SvUVX(sv) == 0) {
8028 (void)SvIOK_only(sv);
8032 (void)SvIOK_only_UV(sv);
8033 SvUV_set(sv, SvUVX(sv) - 1);
8036 if (SvIVX(sv) == IV_MIN) {
8037 sv_setnv(sv, (NV)IV_MIN);
8041 (void)SvIOK_only(sv);
8042 SvIV_set(sv, SvIVX(sv) - 1);
8047 if (flags & SVp_NOK) {
8050 const NV was = SvNVX(sv);
8051 if (NV_OVERFLOWS_INTEGERS_AT &&
8052 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8053 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8054 "Lost precision when decrementing %" NVff " by 1",
8057 (void)SvNOK_only(sv);
8058 SvNV_set(sv, was - 1.0);
8062 if (!(flags & SVp_POK)) {
8063 if ((flags & SVTYPEMASK) < SVt_PVIV)
8064 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8066 (void)SvIOK_only(sv);
8069 #ifdef PERL_PRESERVE_IVUV
8071 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8072 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8073 /* Need to try really hard to see if it's an integer.
8074 9.22337203685478e+18 is an integer.
8075 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8076 so $a="9.22337203685478e+18"; $a+0; $a--
8077 needs to be the same as $a="9.22337203685478e+18"; $a--
8084 /* sv_2iv *should* have made this an NV */
8085 if (flags & SVp_NOK) {
8086 (void)SvNOK_only(sv);
8087 SvNV_set(sv, SvNVX(sv) - 1.0);
8090 /* I don't think we can get here. Maybe I should assert this
8091 And if we do get here I suspect that sv_setnv will croak. NWC
8093 #if defined(USE_LONG_DOUBLE)
8094 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",
8095 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8097 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8098 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8102 #endif /* PERL_PRESERVE_IVUV */
8103 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8106 /* this define is used to eliminate a chunk of duplicated but shared logic
8107 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8108 * used anywhere but here - yves
8110 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8113 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8117 =for apidoc sv_mortalcopy
8119 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8120 The new SV is marked as mortal. It will be destroyed "soon", either by an
8121 explicit call to FREETMPS, or by an implicit call at places such as
8122 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8127 /* Make a string that will exist for the duration of the expression
8128 * evaluation. Actually, it may have to last longer than that, but
8129 * hopefully we won't free it until it has been assigned to a
8130 * permanent location. */
8133 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
8139 sv_setsv(sv,oldstr);
8140 PUSH_EXTEND_MORTAL__SV_C(sv);
8146 =for apidoc sv_newmortal
8148 Creates a new null SV which is mortal. The reference count of the SV is
8149 set to 1. It will be destroyed "soon", either by an explicit call to
8150 FREETMPS, or by an implicit call at places such as statement boundaries.
8151 See also C<sv_mortalcopy> and C<sv_2mortal>.
8157 Perl_sv_newmortal(pTHX)
8163 SvFLAGS(sv) = SVs_TEMP;
8164 PUSH_EXTEND_MORTAL__SV_C(sv);
8170 =for apidoc newSVpvn_flags
8172 Creates a new SV and copies a string into it. The reference count for the
8173 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8174 string. You are responsible for ensuring that the source string is at least
8175 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8176 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8177 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8178 returning. If C<SVf_UTF8> is set, C<s> is considered to be in UTF-8 and the
8179 C<SVf_UTF8> flag will be set on the new SV.
8180 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8182 #define newSVpvn_utf8(s, len, u) \
8183 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8189 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8194 /* All the flags we don't support must be zero.
8195 And we're new code so I'm going to assert this from the start. */
8196 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8198 sv_setpvn(sv,s,len);
8200 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8201 * and do what it does outselves here.
8202 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8203 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8204 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8205 * eleminate quite a few steps than it looks - Yves (explaining patch by gfx)
8208 SvFLAGS(sv) |= flags;
8210 if(flags & SVs_TEMP){
8211 PUSH_EXTEND_MORTAL__SV_C(sv);
8218 =for apidoc sv_2mortal
8220 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8221 by an explicit call to FREETMPS, or by an implicit call at places such as
8222 statement boundaries. SvTEMP() is turned on which means that the SV's
8223 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8224 and C<sv_mortalcopy>.
8230 Perl_sv_2mortal(pTHX_ register SV *const sv)
8235 if (SvREADONLY(sv) && SvIMMORTAL(sv))
8237 PUSH_EXTEND_MORTAL__SV_C(sv);
8245 Creates a new SV and copies a string into it. The reference count for the
8246 SV is set to 1. If C<len> is zero, Perl will compute the length using
8247 strlen(). For efficiency, consider using C<newSVpvn> instead.
8253 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8259 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8264 =for apidoc newSVpvn
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.
8275 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
8281 sv_setpvn(sv,s,len);
8286 =for apidoc newSVhek
8288 Creates a new SV from the hash key structure. It will generate scalars that
8289 point to the shared string table where possible. Returns a new (undefined)
8290 SV if the hek is NULL.
8296 Perl_newSVhek(pTHX_ const HEK *const hek)
8306 if (HEK_LEN(hek) == HEf_SVKEY) {
8307 return newSVsv(*(SV**)HEK_KEY(hek));
8309 const int flags = HEK_FLAGS(hek);
8310 if (flags & HVhek_WASUTF8) {
8312 Andreas would like keys he put in as utf8 to come back as utf8
8314 STRLEN utf8_len = HEK_LEN(hek);
8315 SV * const sv = newSV_type(SVt_PV);
8316 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8317 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8318 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8321 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
8322 /* We don't have a pointer to the hv, so we have to replicate the
8323 flag into every HEK. This hv is using custom a hasing
8324 algorithm. Hence we can't return a shared string scalar, as
8325 that would contain the (wrong) hash value, and might get passed
8326 into an hv routine with a regular hash.
8327 Similarly, a hash that isn't using shared hash keys has to have
8328 the flag in every key so that we know not to try to call
8329 share_hek_kek on it. */
8331 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8336 /* This will be overwhelminly the most common case. */
8338 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8339 more efficient than sharepvn(). */
8343 sv_upgrade(sv, SVt_PV);
8344 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8345 SvCUR_set(sv, HEK_LEN(hek));
8358 =for apidoc newSVpvn_share
8360 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8361 table. If the string does not already exist in the table, it is created
8362 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
8363 value is used; otherwise the hash is computed. The string's hash can be later
8364 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
8365 that as the string table is used for shared hash keys these strings will have
8366 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8372 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8376 bool is_utf8 = FALSE;
8377 const char *const orig_src = src;
8380 STRLEN tmplen = -len;
8382 /* See the note in hv.c:hv_fetch() --jhi */
8383 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8387 PERL_HASH(hash, src, len);
8389 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8390 changes here, update it there too. */
8391 sv_upgrade(sv, SVt_PV);
8392 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8400 if (src != orig_src)
8406 =for apidoc newSVpv_share
8408 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8415 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8417 return newSVpvn_share(src, strlen(src), hash);
8420 #if defined(PERL_IMPLICIT_CONTEXT)
8422 /* pTHX_ magic can't cope with varargs, so this is a no-context
8423 * version of the main function, (which may itself be aliased to us).
8424 * Don't access this version directly.
8428 Perl_newSVpvf_nocontext(const char *const pat, ...)
8434 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8436 va_start(args, pat);
8437 sv = vnewSVpvf(pat, &args);
8444 =for apidoc newSVpvf
8446 Creates a new SV and initializes it with the string formatted like
8453 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8458 PERL_ARGS_ASSERT_NEWSVPVF;
8460 va_start(args, pat);
8461 sv = vnewSVpvf(pat, &args);
8466 /* backend for newSVpvf() and newSVpvf_nocontext() */
8469 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8474 PERL_ARGS_ASSERT_VNEWSVPVF;
8477 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8484 Creates a new SV and copies a floating point value into it.
8485 The reference count for the SV is set to 1.
8491 Perl_newSVnv(pTHX_ const NV n)
8504 Creates a new SV and copies an integer into it. The reference count for the
8511 Perl_newSViv(pTHX_ const IV i)
8524 Creates a new SV and copies an unsigned integer into it.
8525 The reference count for the SV is set to 1.
8531 Perl_newSVuv(pTHX_ const UV u)
8542 =for apidoc newSV_type
8544 Creates a new SV, of the type specified. The reference count for the new SV
8551 Perl_newSV_type(pTHX_ const svtype type)
8556 sv_upgrade(sv, type);
8561 =for apidoc newRV_noinc
8563 Creates an RV wrapper for an SV. The reference count for the original
8564 SV is B<not> incremented.
8570 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8573 register SV *sv = newSV_type(SVt_IV);
8575 PERL_ARGS_ASSERT_NEWRV_NOINC;
8578 SvRV_set(sv, tmpRef);
8583 /* newRV_inc is the official function name to use now.
8584 * newRV_inc is in fact #defined to newRV in sv.h
8588 Perl_newRV(pTHX_ SV *const sv)
8592 PERL_ARGS_ASSERT_NEWRV;
8594 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8600 Creates a new SV which is an exact duplicate of the original SV.
8607 Perl_newSVsv(pTHX_ register SV *const old)
8614 if (SvTYPE(old) == SVTYPEMASK) {
8615 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8619 /* SV_GMAGIC is the default for sv_setv()
8620 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8621 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8622 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
8627 =for apidoc sv_reset
8629 Underlying implementation for the C<reset> Perl function.
8630 Note that the perl-level function is vaguely deprecated.
8636 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
8639 char todo[PERL_UCHAR_MAX+1];
8641 PERL_ARGS_ASSERT_SV_RESET;
8646 if (!*s) { /* reset ?? searches */
8647 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
8649 const U32 count = mg->mg_len / sizeof(PMOP**);
8650 PMOP **pmp = (PMOP**) mg->mg_ptr;
8651 PMOP *const *const end = pmp + count;
8655 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
8657 (*pmp)->op_pmflags &= ~PMf_USED;
8665 /* reset variables */
8667 if (!HvARRAY(stash))
8670 Zero(todo, 256, char);
8673 I32 i = (unsigned char)*s;
8677 max = (unsigned char)*s++;
8678 for ( ; i <= max; i++) {
8681 for (i = 0; i <= (I32) HvMAX(stash); i++) {
8683 for (entry = HvARRAY(stash)[i];
8685 entry = HeNEXT(entry))
8690 if (!todo[(U8)*HeKEY(entry)])
8692 gv = MUTABLE_GV(HeVAL(entry));
8695 if (SvTHINKFIRST(sv)) {
8696 if (!SvREADONLY(sv) && SvROK(sv))
8698 /* XXX Is this continue a bug? Why should THINKFIRST
8699 exempt us from resetting arrays and hashes? */
8703 if (SvTYPE(sv) >= SVt_PV) {
8705 if (SvPVX_const(sv) != NULL)
8713 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
8715 Perl_die(aTHX_ "Can't reset %%ENV on this system");
8718 # if defined(USE_ENVIRON_ARRAY)
8721 # endif /* USE_ENVIRON_ARRAY */
8732 Using various gambits, try to get an IO from an SV: the IO slot if its a
8733 GV; or the recursive result if we're an RV; or the IO slot of the symbol
8734 named after the PV if we're a string.
8740 Perl_sv_2io(pTHX_ SV *const sv)
8745 PERL_ARGS_ASSERT_SV_2IO;
8747 switch (SvTYPE(sv)) {
8749 io = MUTABLE_IO(sv);
8753 if (isGV_with_GP(sv)) {
8754 gv = MUTABLE_GV(sv);
8757 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
8763 Perl_croak(aTHX_ PL_no_usym, "filehandle");
8765 return sv_2io(SvRV(sv));
8766 gv = gv_fetchsv(sv, 0, SVt_PVIO);
8772 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
8781 Using various gambits, try to get a CV from an SV; in addition, try if
8782 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8783 The flags in C<lref> are passed to gv_fetchsv.
8789 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
8795 PERL_ARGS_ASSERT_SV_2CV;
8802 switch (SvTYPE(sv)) {
8806 return MUTABLE_CV(sv);
8813 if (isGV_with_GP(sv)) {
8814 gv = MUTABLE_GV(sv);
8825 sv = amagic_deref_call(sv, to_cv_amg);
8826 /* At this point I'd like to do SPAGAIN, but really I need to
8827 force it upon my callers. Hmmm. This is a mess... */
8830 if (SvTYPE(sv) == SVt_PVCV) {
8831 cv = MUTABLE_CV(sv);
8836 else if(isGV_with_GP(sv))
8837 gv = MUTABLE_GV(sv);
8839 Perl_croak(aTHX_ "Not a subroutine reference");
8841 else if (isGV_with_GP(sv)) {
8843 gv = MUTABLE_GV(sv);
8846 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
8852 /* Some flags to gv_fetchsv mean don't really create the GV */
8853 if (!isGV_with_GP(gv)) {
8859 if (lref && !GvCVu(gv)) {
8863 gv_efullname3(tmpsv, gv, NULL);
8864 /* XXX this is probably not what they think they're getting.
8865 * It has the same effect as "sub name;", i.e. just a forward
8867 newSUB(start_subparse(FALSE, 0),
8868 newSVOP(OP_CONST, 0, tmpsv),
8872 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8873 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
8882 Returns true if the SV has a true value by Perl's rules.
8883 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8884 instead use an in-line version.
8890 Perl_sv_true(pTHX_ register SV *const sv)
8895 register const XPV* const tXpv = (XPV*)SvANY(sv);
8897 (tXpv->xpv_cur > 1 ||
8898 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8905 return SvIVX(sv) != 0;
8908 return SvNVX(sv) != 0.0;
8910 return sv_2bool(sv);
8916 =for apidoc sv_pvn_force
8918 Get a sensible string out of the SV somehow.
8919 A private implementation of the C<SvPV_force> macro for compilers which
8920 can't cope with complex macro expressions. Always use the macro instead.
8922 =for apidoc sv_pvn_force_flags
8924 Get a sensible string out of the SV somehow.
8925 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8926 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8927 implemented in terms of this function.
8928 You normally want to use the various wrapper macros instead: see
8929 C<SvPV_force> and C<SvPV_force_nomg>
8935 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8939 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8941 if (SvTHINKFIRST(sv) && !SvROK(sv))
8942 sv_force_normal_flags(sv, 0);
8952 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8953 const char * const ref = sv_reftype(sv,0);
8955 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8956 ref, OP_DESC(PL_op));
8958 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8960 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8961 || isGV_with_GP(sv))
8962 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8964 s = sv_2pv_flags(sv, &len, flags);
8968 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8971 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8972 SvGROW(sv, len + 1);
8973 Move(s,SvPVX(sv),len,char);
8975 SvPVX(sv)[len] = '\0';
8978 SvPOK_on(sv); /* validate pointer */
8980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8981 PTR2UV(sv),SvPVX_const(sv)));
8984 return SvPVX_mutable(sv);
8988 =for apidoc sv_pvbyten_force
8990 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8996 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8998 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9000 sv_pvn_force(sv,lp);
9001 sv_utf8_downgrade(sv,0);
9007 =for apidoc sv_pvutf8n_force
9009 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
9015 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9017 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9019 sv_pvn_force(sv,lp);
9020 sv_utf8_upgrade(sv);
9026 =for apidoc sv_reftype
9028 Returns a string describing what the SV is a reference to.
9034 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9036 PERL_ARGS_ASSERT_SV_REFTYPE;
9038 /* The fact that I don't need to downcast to char * everywhere, only in ?:
9039 inside return suggests a const propagation bug in g++. */
9040 if (ob && SvOBJECT(sv)) {
9041 char * const name = HvNAME_get(SvSTASH(sv));
9042 return name ? name : (char *) "__ANON__";
9045 switch (SvTYPE(sv)) {
9060 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9061 /* tied lvalues should appear to be
9062 * scalars for backwards compatitbility */
9063 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9064 ? "SCALAR" : "LVALUE");
9065 case SVt_PVAV: return "ARRAY";
9066 case SVt_PVHV: return "HASH";
9067 case SVt_PVCV: return "CODE";
9068 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9069 ? "GLOB" : "SCALAR");
9070 case SVt_PVFM: return "FORMAT";
9071 case SVt_PVIO: return "IO";
9072 case SVt_BIND: return "BIND";
9073 case SVt_REGEXP: return "REGEXP";
9074 default: return "UNKNOWN";
9080 =for apidoc sv_isobject
9082 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9083 object. If the SV is not an RV, or if the object is not blessed, then this
9090 Perl_sv_isobject(pTHX_ SV *sv)
9106 Returns a boolean indicating whether the SV is blessed into the specified
9107 class. This does not check for subtypes; use C<sv_derived_from> to verify
9108 an inheritance relationship.
9114 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9118 PERL_ARGS_ASSERT_SV_ISA;
9128 hvname = HvNAME_get(SvSTASH(sv));
9132 return strEQ(hvname, name);
9138 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
9139 it will be upgraded to one. If C<classname> is non-null then the new SV will
9140 be blessed in the specified package. The new SV is returned and its
9141 reference count is 1.
9147 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9152 PERL_ARGS_ASSERT_NEWSVRV;
9156 SV_CHECK_THINKFIRST_COW_DROP(rv);
9157 (void)SvAMAGIC_off(rv);
9159 if (SvTYPE(rv) >= SVt_PVMG) {
9160 const U32 refcnt = SvREFCNT(rv);
9164 SvREFCNT(rv) = refcnt;
9166 sv_upgrade(rv, SVt_IV);
9167 } else if (SvROK(rv)) {
9168 SvREFCNT_dec(SvRV(rv));
9170 prepare_SV_for_RV(rv);
9178 HV* const stash = gv_stashpv(classname, GV_ADD);
9179 (void)sv_bless(rv, stash);
9185 =for apidoc sv_setref_pv
9187 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9188 argument will be upgraded to an RV. That RV will be modified to point to
9189 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9190 into the SV. The C<classname> argument indicates the package for the
9191 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9192 will have a reference count of 1, and the RV will be returned.
9194 Do not use with other Perl types such as HV, AV, SV, CV, because those
9195 objects will become corrupted by the pointer copy process.
9197 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9203 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9207 PERL_ARGS_ASSERT_SV_SETREF_PV;
9210 sv_setsv(rv, &PL_sv_undef);
9214 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9219 =for apidoc sv_setref_iv
9221 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9222 argument will be upgraded to an RV. That RV will be modified to point to
9223 the new SV. The C<classname> argument indicates the package for the
9224 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9225 will have a reference count of 1, and the RV will be returned.
9231 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9233 PERL_ARGS_ASSERT_SV_SETREF_IV;
9235 sv_setiv(newSVrv(rv,classname), iv);
9240 =for apidoc sv_setref_uv
9242 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9243 argument will be upgraded to an RV. That RV will be modified to point to
9244 the new SV. The C<classname> argument indicates the package for the
9245 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9246 will have a reference count of 1, and the RV will be returned.
9252 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9254 PERL_ARGS_ASSERT_SV_SETREF_UV;
9256 sv_setuv(newSVrv(rv,classname), uv);
9261 =for apidoc sv_setref_nv
9263 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9264 argument will be upgraded to an RV. That RV will be modified to point to
9265 the new SV. The C<classname> argument indicates the package for the
9266 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9267 will have a reference count of 1, and the RV will be returned.
9273 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9275 PERL_ARGS_ASSERT_SV_SETREF_NV;
9277 sv_setnv(newSVrv(rv,classname), nv);
9282 =for apidoc sv_setref_pvn
9284 Copies a string into a new SV, optionally blessing the SV. The length of the
9285 string must be specified with C<n>. The C<rv> argument will be upgraded to
9286 an RV. That RV will be modified to point to the new SV. The C<classname>
9287 argument indicates the package for the blessing. Set C<classname> to
9288 C<NULL> to avoid the blessing. The new SV will have a reference count
9289 of 1, and the RV will be returned.
9291 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9297 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9298 const char *const pv, const STRLEN n)
9300 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9302 sv_setpvn(newSVrv(rv,classname), pv, n);
9307 =for apidoc sv_bless
9309 Blesses an SV into a specified package. The SV must be an RV. The package
9310 must be designated by its stash (see C<gv_stashpv()>). The reference count
9311 of the SV is unaffected.
9317 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9322 PERL_ARGS_ASSERT_SV_BLESS;
9325 Perl_croak(aTHX_ "Can't bless non-reference value");
9327 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9328 if (SvIsCOW(tmpRef))
9329 sv_force_normal_flags(tmpRef, 0);
9330 if (SvREADONLY(tmpRef))
9331 Perl_croak_no_modify(aTHX);
9332 if (SvOBJECT(tmpRef)) {
9333 if (SvTYPE(tmpRef) != SVt_PVIO)
9335 SvREFCNT_dec(SvSTASH(tmpRef));
9338 SvOBJECT_on(tmpRef);
9339 if (SvTYPE(tmpRef) != SVt_PVIO)
9341 SvUPGRADE(tmpRef, SVt_PVMG);
9342 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9347 (void)SvAMAGIC_off(sv);
9349 if(SvSMAGICAL(tmpRef))
9350 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9358 /* Downgrades a PVGV to a PVMG. If it’s actually a PVLV, we leave the type
9359 * as it is after unglobbing it.
9363 S_sv_unglob(pTHX_ SV *const sv)
9368 SV * const temp = sv_newmortal();
9370 PERL_ARGS_ASSERT_SV_UNGLOB;
9372 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9374 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9377 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9378 && HvNAME_get(stash))
9379 mro_method_changed_in(stash);
9380 gp_free(MUTABLE_GV(sv));
9383 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9387 if (GvNAME_HEK(sv)) {
9388 unshare_hek(GvNAME_HEK(sv));
9390 isGV_with_GP_off(sv);
9392 if(SvTYPE(sv) == SVt_PVGV) {
9393 /* need to keep SvANY(sv) in the right arena */
9394 xpvmg = new_XPVMG();
9395 StructCopy(SvANY(sv), xpvmg, XPVMG);
9396 del_XPVGV(SvANY(sv));
9399 SvFLAGS(sv) &= ~SVTYPEMASK;
9400 SvFLAGS(sv) |= SVt_PVMG;
9403 /* Intentionally not calling any local SET magic, as this isn't so much a
9404 set operation as merely an internal storage change. */
9405 sv_setsv_flags(sv, temp, 0);
9409 =for apidoc sv_unref_flags
9411 Unsets the RV status of the SV, and decrements the reference count of
9412 whatever was being referenced by the RV. This can almost be thought of
9413 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9414 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9415 (otherwise the decrementing is conditional on the reference count being
9416 different from one or the reference being a readonly SV).
9423 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9425 SV* const target = SvRV(ref);
9427 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9429 if (SvWEAKREF(ref)) {
9430 sv_del_backref(target, ref);
9432 SvRV_set(ref, NULL);
9435 SvRV_set(ref, NULL);
9437 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9438 assigned to as BEGIN {$a = \"Foo"} will fail. */
9439 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9440 SvREFCNT_dec(target);
9441 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9442 sv_2mortal(target); /* Schedule for freeing later */
9446 =for apidoc sv_untaint
9448 Untaint an SV. Use C<SvTAINTED_off> instead.
9453 Perl_sv_untaint(pTHX_ SV *const sv)
9455 PERL_ARGS_ASSERT_SV_UNTAINT;
9457 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9458 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9465 =for apidoc sv_tainted
9467 Test an SV for taintedness. Use C<SvTAINTED> instead.
9472 Perl_sv_tainted(pTHX_ SV *const sv)
9474 PERL_ARGS_ASSERT_SV_TAINTED;
9476 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9477 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9478 if (mg && (mg->mg_len & 1) )
9485 =for apidoc sv_setpviv
9487 Copies an integer into the given SV, also updating its string value.
9488 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9494 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9496 char buf[TYPE_CHARS(UV)];
9498 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9500 PERL_ARGS_ASSERT_SV_SETPVIV;
9502 sv_setpvn(sv, ptr, ebuf - ptr);
9506 =for apidoc sv_setpviv_mg
9508 Like C<sv_setpviv>, but also handles 'set' magic.
9514 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9516 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9522 #if defined(PERL_IMPLICIT_CONTEXT)
9524 /* pTHX_ magic can't cope with varargs, so this is a no-context
9525 * version of the main function, (which may itself be aliased to us).
9526 * Don't access this version directly.
9530 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9535 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9537 va_start(args, pat);
9538 sv_vsetpvf(sv, pat, &args);
9542 /* pTHX_ magic can't cope with varargs, so this is a no-context
9543 * version of the main function, (which may itself be aliased to us).
9544 * Don't access this version directly.
9548 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9553 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9555 va_start(args, pat);
9556 sv_vsetpvf_mg(sv, pat, &args);
9562 =for apidoc sv_setpvf
9564 Works like C<sv_catpvf> but copies the text into the SV instead of
9565 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9571 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9575 PERL_ARGS_ASSERT_SV_SETPVF;
9577 va_start(args, pat);
9578 sv_vsetpvf(sv, pat, &args);
9583 =for apidoc sv_vsetpvf
9585 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9586 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9588 Usually used via its frontend C<sv_setpvf>.
9594 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9596 PERL_ARGS_ASSERT_SV_VSETPVF;
9598 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9602 =for apidoc sv_setpvf_mg
9604 Like C<sv_setpvf>, but also handles 'set' magic.
9610 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9614 PERL_ARGS_ASSERT_SV_SETPVF_MG;
9616 va_start(args, pat);
9617 sv_vsetpvf_mg(sv, pat, &args);
9622 =for apidoc sv_vsetpvf_mg
9624 Like C<sv_vsetpvf>, but also handles 'set' magic.
9626 Usually used via its frontend C<sv_setpvf_mg>.
9632 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9634 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
9636 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9640 #if defined(PERL_IMPLICIT_CONTEXT)
9642 /* pTHX_ magic can't cope with varargs, so this is a no-context
9643 * version of the main function, (which may itself be aliased to us).
9644 * Don't access this version directly.
9648 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
9653 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
9655 va_start(args, pat);
9656 sv_vcatpvf(sv, pat, &args);
9660 /* pTHX_ magic can't cope with varargs, so this is a no-context
9661 * version of the main function, (which may itself be aliased to us).
9662 * Don't access this version directly.
9666 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9671 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
9673 va_start(args, pat);
9674 sv_vcatpvf_mg(sv, pat, &args);
9680 =for apidoc sv_catpvf
9682 Processes its arguments like C<sprintf> and appends the formatted
9683 output to an SV. If the appended data contains "wide" characters
9684 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9685 and characters >255 formatted with %c), the original SV might get
9686 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9687 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9688 valid UTF-8; if the original SV was bytes, the pattern should be too.
9693 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
9697 PERL_ARGS_ASSERT_SV_CATPVF;
9699 va_start(args, pat);
9700 sv_vcatpvf(sv, pat, &args);
9705 =for apidoc sv_vcatpvf
9707 Processes its arguments like C<vsprintf> and appends the formatted output
9708 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9710 Usually used via its frontend C<sv_catpvf>.
9716 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9718 PERL_ARGS_ASSERT_SV_VCATPVF;
9720 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9724 =for apidoc sv_catpvf_mg
9726 Like C<sv_catpvf>, but also handles 'set' magic.
9732 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
9736 PERL_ARGS_ASSERT_SV_CATPVF_MG;
9738 va_start(args, pat);
9739 sv_vcatpvf_mg(sv, pat, &args);
9744 =for apidoc sv_vcatpvf_mg
9746 Like C<sv_vcatpvf>, but also handles 'set' magic.
9748 Usually used via its frontend C<sv_catpvf_mg>.
9754 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9756 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
9758 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9763 =for apidoc sv_vsetpvfn
9765 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9768 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9774 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9775 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9777 PERL_ARGS_ASSERT_SV_VSETPVFN;
9780 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9785 * Warn of missing argument to sprintf, and then return a defined value
9786 * to avoid inappropriate "use of uninit" warnings [perl #71000].
9788 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
9790 S_vcatpvfn_missing_argument(pTHX) {
9791 if (ckWARN(WARN_MISSING)) {
9792 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
9793 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
9800 S_expect_number(pTHX_ char **const pattern)
9805 PERL_ARGS_ASSERT_EXPECT_NUMBER;
9807 switch (**pattern) {
9808 case '1': case '2': case '3':
9809 case '4': case '5': case '6':
9810 case '7': case '8': case '9':
9811 var = *(*pattern)++ - '0';
9812 while (isDIGIT(**pattern)) {
9813 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
9815 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
9823 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
9825 const int neg = nv < 0;
9828 PERL_ARGS_ASSERT_F0CONVERT;
9836 if (uv & 1 && uv == nv)
9837 uv--; /* Round to even */
9839 const unsigned dig = uv % 10;
9852 =for apidoc sv_vcatpvfn
9854 Processes its arguments like C<vsprintf> and appends the formatted output
9855 to an SV. Uses an array of SVs if the C style variable argument list is
9856 missing (NULL). When running with taint checks enabled, indicates via
9857 C<maybe_tainted> if results are untrustworthy (often due to the use of
9860 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9866 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
9867 vecstr = (U8*)SvPV_const(vecsv,veclen);\
9868 vec_utf8 = DO_UTF8(vecsv);
9870 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9873 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
9874 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
9882 static const char nullstr[] = "(null)";
9884 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9885 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
9887 /* Times 4: a decimal digit takes more than 3 binary digits.
9888 * NV_DIG: mantissa takes than many decimal digits.
9889 * Plus 32: Playing safe. */
9890 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9891 /* large enough for "%#.#f" --chip */
9892 /* what about long double NVs? --jhi */
9894 PERL_ARGS_ASSERT_SV_VCATPVFN;
9895 PERL_UNUSED_ARG(maybe_tainted);
9897 /* no matter what, this is a string now */
9898 (void)SvPV_force(sv, origlen);
9900 /* special-case "", "%s", and "%-p" (SVf - see below) */
9903 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
9905 const char * const s = va_arg(*args, char*);
9906 sv_catpv(sv, s ? s : nullstr);
9908 else if (svix < svmax) {
9909 sv_catsv(sv, *svargs);
9912 S_vcatpvfn_missing_argument(aTHX);
9915 if (args && patlen == 3 && pat[0] == '%' &&
9916 pat[1] == '-' && pat[2] == 'p') {
9917 argsv = MUTABLE_SV(va_arg(*args, void*));
9918 sv_catsv(sv, argsv);
9922 #ifndef USE_LONG_DOUBLE
9923 /* special-case "%.<number>[gf]" */
9924 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9925 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9926 unsigned digits = 0;
9930 while (*pp >= '0' && *pp <= '9')
9931 digits = 10 * digits + (*pp++ - '0');
9932 if (pp - pat == (int)patlen - 1 && svix < svmax) {
9933 const NV nv = SvNV(*svargs);
9935 /* Add check for digits != 0 because it seems that some
9936 gconverts are buggy in this case, and we don't yet have
9937 a Configure test for this. */
9938 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9939 /* 0, point, slack */
9940 Gconvert(nv, (int)digits, 0, ebuf);
9942 if (*ebuf) /* May return an empty string for digits==0 */
9945 } else if (!digits) {
9948 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9949 sv_catpvn(sv, p, l);
9955 #endif /* !USE_LONG_DOUBLE */
9957 if (!args && svix < svmax && DO_UTF8(*svargs))
9960 patend = (char*)pat + patlen;
9961 for (p = (char*)pat; p < patend; p = q) {
9964 bool vectorize = FALSE;
9965 bool vectorarg = FALSE;
9966 bool vec_utf8 = FALSE;
9972 bool has_precis = FALSE;
9974 const I32 osvix = svix;
9975 bool is_utf8 = FALSE; /* is this item utf8? */
9976 #ifdef HAS_LDBL_SPRINTF_BUG
9977 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9978 with sfio - Allen <allens@cpan.org> */
9979 bool fix_ldbl_sprintf_bug = FALSE;
9983 U8 utf8buf[UTF8_MAXBYTES+1];
9984 STRLEN esignlen = 0;
9986 const char *eptr = NULL;
9987 const char *fmtstart;
9990 const U8 *vecstr = NULL;
9997 /* we need a long double target in case HAS_LONG_DOUBLE but
10000 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10008 const char *dotstr = ".";
10009 STRLEN dotstrlen = 1;
10010 I32 efix = 0; /* explicit format parameter index */
10011 I32 ewix = 0; /* explicit width index */
10012 I32 epix = 0; /* explicit precision index */
10013 I32 evix = 0; /* explicit vector index */
10014 bool asterisk = FALSE;
10016 /* echo everything up to the next format specification */
10017 for (q = p; q < patend && *q != '%'; ++q) ;
10019 if (has_utf8 && !pat_utf8)
10020 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
10022 sv_catpvn(sv, p, q - p);
10031 We allow format specification elements in this order:
10032 \d+\$ explicit format parameter index
10034 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10035 0 flag (as above): repeated to allow "v02"
10036 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10037 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10039 [%bcdefginopsuxDFOUX] format (mandatory)
10044 As of perl5.9.3, printf format checking is on by default.
10045 Internally, perl uses %p formats to provide an escape to
10046 some extended formatting. This block deals with those
10047 extensions: if it does not match, (char*)q is reset and
10048 the normal format processing code is used.
10050 Currently defined extensions are:
10051 %p include pointer address (standard)
10052 %-p (SVf) include an SV (previously %_)
10053 %-<num>p include an SV with precision <num>
10054 %<num>p reserved for future extensions
10056 Robin Barker 2005-07-14
10058 %1p (VDf) removed. RMB 2007-10-19
10065 n = expect_number(&q);
10067 if (sv) { /* SVf */
10072 argsv = MUTABLE_SV(va_arg(*args, void*));
10073 eptr = SvPV_const(argsv, elen);
10074 if (DO_UTF8(argsv))
10079 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10080 "internal %%<num>p might conflict with future printf extensions");
10086 if ( (width = expect_number(&q)) ) {
10101 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10130 if ( (ewix = expect_number(&q)) )
10139 if ((vectorarg = asterisk)) {
10152 width = expect_number(&q);
10158 vecsv = va_arg(*args, SV*);
10160 vecsv = (evix > 0 && evix <= svmax)
10161 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10163 vecsv = svix < svmax
10164 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10166 dotstr = SvPV_const(vecsv, dotstrlen);
10167 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10168 bad with tied or overloaded values that return UTF8. */
10169 if (DO_UTF8(vecsv))
10171 else if (has_utf8) {
10172 vecsv = sv_mortalcopy(vecsv);
10173 sv_utf8_upgrade(vecsv);
10174 dotstr = SvPV_const(vecsv, dotstrlen);
10181 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10182 vecsv = svargs[efix ? efix-1 : svix++];
10183 vecstr = (U8*)SvPV_const(vecsv,veclen);
10184 vec_utf8 = DO_UTF8(vecsv);
10186 /* if this is a version object, we need to convert
10187 * back into v-string notation and then let the
10188 * vectorize happen normally
10190 if (sv_derived_from(vecsv, "version")) {
10191 char *version = savesvpv(vecsv);
10192 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10193 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
10194 "vector argument not supported with alpha versions");
10197 vecsv = sv_newmortal();
10198 scan_vstring(version, version + veclen, vecsv);
10199 vecstr = (U8*)SvPV_const(vecsv, veclen);
10200 vec_utf8 = DO_UTF8(vecsv);
10212 i = va_arg(*args, int);
10214 i = (ewix ? ewix <= svmax : svix < svmax) ?
10215 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10217 width = (i < 0) ? -i : i;
10227 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10229 /* XXX: todo, support specified precision parameter */
10233 i = va_arg(*args, int);
10235 i = (ewix ? ewix <= svmax : svix < svmax)
10236 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10238 has_precis = !(i < 0);
10242 while (isDIGIT(*q))
10243 precis = precis * 10 + (*q++ - '0');
10252 case 'I': /* Ix, I32x, and I64x */
10254 if (q[1] == '6' && q[2] == '4') {
10260 if (q[1] == '3' && q[2] == '2') {
10270 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10281 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10282 if (*++q == 'l') { /* lld, llf */
10291 if (*++q == 'h') { /* hhd, hhu */
10320 if (!vectorize && !args) {
10322 const I32 i = efix-1;
10323 argsv = (i >= 0 && i < svmax)
10324 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10326 argsv = (svix >= 0 && svix < svmax)
10327 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10331 switch (c = *q++) {
10338 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10340 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10342 eptr = (char*)utf8buf;
10343 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10357 eptr = va_arg(*args, char*);
10359 elen = strlen(eptr);
10361 eptr = (char *)nullstr;
10362 elen = sizeof nullstr - 1;
10366 eptr = SvPV_const(argsv, elen);
10367 if (DO_UTF8(argsv)) {
10368 STRLEN old_precis = precis;
10369 if (has_precis && precis < elen) {
10370 STRLEN ulen = sv_len_utf8(argsv);
10371 I32 p = precis > ulen ? ulen : precis;
10372 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
10375 if (width) { /* fudge width (can't fudge elen) */
10376 if (has_precis && precis < elen)
10377 width += precis - old_precis;
10379 width += elen - sv_len_utf8(argsv);
10386 if (has_precis && precis < elen)
10393 if (alt || vectorize)
10395 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10416 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10425 esignbuf[esignlen++] = plus;
10429 case 'c': iv = (char)va_arg(*args, int); break;
10430 case 'h': iv = (short)va_arg(*args, int); break;
10431 case 'l': iv = va_arg(*args, long); break;
10432 case 'V': iv = va_arg(*args, IV); break;
10433 case 'z': iv = va_arg(*args, SSize_t); break;
10434 case 't': iv = va_arg(*args, ptrdiff_t); break;
10435 default: iv = va_arg(*args, int); break;
10437 case 'j': iv = va_arg(*args, intmax_t); break;
10441 iv = va_arg(*args, Quad_t); break;
10448 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10450 case 'c': iv = (char)tiv; break;
10451 case 'h': iv = (short)tiv; break;
10452 case 'l': iv = (long)tiv; break;
10454 default: iv = tiv; break;
10457 iv = (Quad_t)tiv; break;
10463 if ( !vectorize ) /* we already set uv above */
10468 esignbuf[esignlen++] = plus;
10472 esignbuf[esignlen++] = '-';
10516 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10527 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10528 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10529 case 'l': uv = va_arg(*args, unsigned long); break;
10530 case 'V': uv = va_arg(*args, UV); break;
10531 case 'z': uv = va_arg(*args, Size_t); break;
10532 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10534 case 'j': uv = va_arg(*args, uintmax_t); break;
10536 default: uv = va_arg(*args, unsigned); break;
10539 uv = va_arg(*args, Uquad_t); break;
10546 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10548 case 'c': uv = (unsigned char)tuv; break;
10549 case 'h': uv = (unsigned short)tuv; break;
10550 case 'l': uv = (unsigned long)tuv; break;
10552 default: uv = tuv; break;
10555 uv = (Uquad_t)tuv; break;
10564 char *ptr = ebuf + sizeof ebuf;
10565 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
10571 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
10575 } while (uv >>= 4);
10577 esignbuf[esignlen++] = '0';
10578 esignbuf[esignlen++] = c; /* 'x' or 'X' */
10584 *--ptr = '0' + dig;
10585 } while (uv >>= 3);
10586 if (alt && *ptr != '0')
10592 *--ptr = '0' + dig;
10593 } while (uv >>= 1);
10595 esignbuf[esignlen++] = '0';
10596 esignbuf[esignlen++] = c;
10599 default: /* it had better be ten or less */
10602 *--ptr = '0' + dig;
10603 } while (uv /= base);
10606 elen = (ebuf + sizeof ebuf) - ptr;
10610 zeros = precis - elen;
10611 else if (precis == 0 && elen == 1 && *eptr == '0'
10612 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
10615 /* a precision nullifies the 0 flag. */
10622 /* FLOATING POINT */
10625 c = 'f'; /* maybe %F isn't supported here */
10627 case 'e': case 'E':
10629 case 'g': case 'G':
10633 /* This is evil, but floating point is even more evil */
10635 /* for SV-style calling, we can only get NV
10636 for C-style calling, we assume %f is double;
10637 for simplicity we allow any of %Lf, %llf, %qf for long double
10641 #if defined(USE_LONG_DOUBLE)
10645 /* [perl #20339] - we should accept and ignore %lf rather than die */
10649 #if defined(USE_LONG_DOUBLE)
10650 intsize = args ? 0 : 'q';
10654 #if defined(HAS_LONG_DOUBLE)
10667 /* now we need (long double) if intsize == 'q', else (double) */
10669 #if LONG_DOUBLESIZE > DOUBLESIZE
10671 va_arg(*args, long double) :
10672 va_arg(*args, double)
10674 va_arg(*args, double)
10679 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
10680 else. frexp() has some unspecified behaviour for those three */
10681 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
10683 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
10684 will cast our (long double) to (double) */
10685 (void)Perl_frexp(nv, &i);
10686 if (i == PERL_INT_MIN)
10687 Perl_die(aTHX_ "panic: frexp");
10689 need = BIT_DIGITS(i);
10691 need += has_precis ? precis : 6; /* known default */
10696 #ifdef HAS_LDBL_SPRINTF_BUG
10697 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10698 with sfio - Allen <allens@cpan.org> */
10701 # define MY_DBL_MAX DBL_MAX
10702 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
10703 # if DOUBLESIZE >= 8
10704 # define MY_DBL_MAX 1.7976931348623157E+308L
10706 # define MY_DBL_MAX 3.40282347E+38L
10710 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
10711 # define MY_DBL_MAX_BUG 1L
10713 # define MY_DBL_MAX_BUG MY_DBL_MAX
10717 # define MY_DBL_MIN DBL_MIN
10718 # else /* XXX guessing! -Allen */
10719 # if DOUBLESIZE >= 8
10720 # define MY_DBL_MIN 2.2250738585072014E-308L
10722 # define MY_DBL_MIN 1.17549435E-38L
10726 if ((intsize == 'q') && (c == 'f') &&
10727 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
10728 (need < DBL_DIG)) {
10729 /* it's going to be short enough that
10730 * long double precision is not needed */
10732 if ((nv <= 0L) && (nv >= -0L))
10733 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
10735 /* would use Perl_fp_class as a double-check but not
10736 * functional on IRIX - see perl.h comments */
10738 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
10739 /* It's within the range that a double can represent */
10740 #if defined(DBL_MAX) && !defined(DBL_MIN)
10741 if ((nv >= ((long double)1/DBL_MAX)) ||
10742 (nv <= (-(long double)1/DBL_MAX)))
10744 fix_ldbl_sprintf_bug = TRUE;
10747 if (fix_ldbl_sprintf_bug == TRUE) {
10757 # undef MY_DBL_MAX_BUG
10760 #endif /* HAS_LDBL_SPRINTF_BUG */
10762 need += 20; /* fudge factor */
10763 if (PL_efloatsize < need) {
10764 Safefree(PL_efloatbuf);
10765 PL_efloatsize = need + 20; /* more fudge */
10766 Newx(PL_efloatbuf, PL_efloatsize, char);
10767 PL_efloatbuf[0] = '\0';
10770 if ( !(width || left || plus || alt) && fill != '0'
10771 && has_precis && intsize != 'q' ) { /* Shortcuts */
10772 /* See earlier comment about buggy Gconvert when digits,
10774 if ( c == 'g' && precis) {
10775 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
10776 /* May return an empty string for digits==0 */
10777 if (*PL_efloatbuf) {
10778 elen = strlen(PL_efloatbuf);
10779 goto float_converted;
10781 } else if ( c == 'f' && !precis) {
10782 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
10787 char *ptr = ebuf + sizeof ebuf;
10790 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
10791 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
10792 if (intsize == 'q') {
10793 /* Copy the one or more characters in a long double
10794 * format before the 'base' ([efgEFG]) character to
10795 * the format string. */
10796 static char const prifldbl[] = PERL_PRIfldbl;
10797 char const *p = prifldbl + sizeof(prifldbl) - 3;
10798 while (p >= prifldbl) { *--ptr = *p--; }
10803 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10808 do { *--ptr = '0' + (base % 10); } while (base /= 10);
10820 /* No taint. Otherwise we are in the strange situation
10821 * where printf() taints but print($float) doesn't.
10823 #if defined(HAS_LONG_DOUBLE)
10824 elen = ((intsize == 'q')
10825 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
10826 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
10828 elen = my_sprintf(PL_efloatbuf, ptr, nv);
10832 eptr = PL_efloatbuf;
10840 i = SvCUR(sv) - origlen;
10843 case 'c': *(va_arg(*args, char*)) = i; break;
10844 case 'h': *(va_arg(*args, short*)) = i; break;
10845 default: *(va_arg(*args, int*)) = i; break;
10846 case 'l': *(va_arg(*args, long*)) = i; break;
10847 case 'V': *(va_arg(*args, IV*)) = i; break;
10848 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
10849 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
10851 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
10855 *(va_arg(*args, Quad_t*)) = i; break;
10862 sv_setuv_mg(argsv, (UV)i);
10863 continue; /* not "break" */
10870 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
10871 && ckWARN(WARN_PRINTF))
10873 SV * const msg = sv_newmortal();
10874 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10875 (PL_op->op_type == OP_PRTF) ? "" : "s");
10876 if (fmtstart < patend) {
10877 const char * const fmtend = q < patend ? q : patend;
10879 sv_catpvs(msg, "\"%");
10880 for (f = fmtstart; f < fmtend; f++) {
10882 sv_catpvn(msg, f, 1);
10884 Perl_sv_catpvf(aTHX_ msg,
10885 "\\%03"UVof, (UV)*f & 0xFF);
10888 sv_catpvs(msg, "\"");
10890 sv_catpvs(msg, "end of string");
10892 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
10895 /* output mangled stuff ... */
10901 /* ... right here, because formatting flags should not apply */
10902 SvGROW(sv, SvCUR(sv) + elen + 1);
10904 Copy(eptr, p, elen, char);
10907 SvCUR_set(sv, p - SvPVX_const(sv));
10909 continue; /* not "break" */
10912 if (is_utf8 != has_utf8) {
10915 sv_utf8_upgrade(sv);
10918 const STRLEN old_elen = elen;
10919 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
10920 sv_utf8_upgrade(nsv);
10921 eptr = SvPVX_const(nsv);
10924 if (width) { /* fudge width (can't fudge elen) */
10925 width += elen - old_elen;
10931 have = esignlen + zeros + elen;
10933 Perl_croak_nocontext("%s", PL_memory_wrap);
10935 need = (have > width ? have : width);
10938 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
10939 Perl_croak_nocontext("%s", PL_memory_wrap);
10940 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10942 if (esignlen && fill == '0') {
10944 for (i = 0; i < (int)esignlen; i++)
10945 *p++ = esignbuf[i];
10947 if (gap && !left) {
10948 memset(p, fill, gap);
10951 if (esignlen && fill != '0') {
10953 for (i = 0; i < (int)esignlen; i++)
10954 *p++ = esignbuf[i];
10958 for (i = zeros; i; i--)
10962 Copy(eptr, p, elen, char);
10966 memset(p, ' ', gap);
10971 Copy(dotstr, p, dotstrlen, char);
10975 vectorize = FALSE; /* done iterating over vecstr */
10982 SvCUR_set(sv, p - SvPVX_const(sv));
10991 /* =========================================================================
10993 =head1 Cloning an interpreter
10995 All the macros and functions in this section are for the private use of
10996 the main function, perl_clone().
10998 The foo_dup() functions make an exact copy of an existing foo thingy.
10999 During the course of a cloning, a hash table is used to map old addresses
11000 to new addresses. The table is created and manipulated with the
11001 ptr_table_* functions.
11005 * =========================================================================*/
11008 #if defined(USE_ITHREADS)
11010 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11011 #ifndef GpREFCNT_inc
11012 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11016 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11017 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11018 If this changes, please unmerge ss_dup.
11019 Likewise, sv_dup_inc_multiple() relies on this fact. */
11020 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11021 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11022 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11023 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11024 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11025 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11026 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11027 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11028 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11029 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11030 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11031 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11032 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11034 /* clone a parser */
11037 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11041 PERL_ARGS_ASSERT_PARSER_DUP;
11046 /* look for it in the table first */
11047 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11051 /* create anew and remember what it is */
11052 Newxz(parser, 1, yy_parser);
11053 ptr_table_store(PL_ptr_table, proto, parser);
11055 /* XXX these not yet duped */
11056 parser->old_parser = NULL;
11057 parser->stack = NULL;
11059 parser->stack_size = 0;
11060 /* XXX parser->stack->state = 0; */
11062 /* XXX eventually, just Copy() most of the parser struct ? */
11064 parser->lex_brackets = proto->lex_brackets;
11065 parser->lex_casemods = proto->lex_casemods;
11066 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11067 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11068 parser->lex_casestack = savepvn(proto->lex_casestack,
11069 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11070 parser->lex_defer = proto->lex_defer;
11071 parser->lex_dojoin = proto->lex_dojoin;
11072 parser->lex_expect = proto->lex_expect;
11073 parser->lex_formbrack = proto->lex_formbrack;
11074 parser->lex_inpat = proto->lex_inpat;
11075 parser->lex_inwhat = proto->lex_inwhat;
11076 parser->lex_op = proto->lex_op;
11077 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11078 parser->lex_starts = proto->lex_starts;
11079 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11080 parser->multi_close = proto->multi_close;
11081 parser->multi_open = proto->multi_open;
11082 parser->multi_start = proto->multi_start;
11083 parser->multi_end = proto->multi_end;
11084 parser->pending_ident = proto->pending_ident;
11085 parser->preambled = proto->preambled;
11086 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11087 parser->linestr = sv_dup_inc(proto->linestr, param);
11088 parser->expect = proto->expect;
11089 parser->copline = proto->copline;
11090 parser->last_lop_op = proto->last_lop_op;
11091 parser->lex_state = proto->lex_state;
11092 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11093 /* rsfp_filters entries have fake IoDIRP() */
11094 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11095 parser->in_my = proto->in_my;
11096 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11097 parser->error_count = proto->error_count;
11100 parser->linestr = sv_dup_inc(proto->linestr, param);
11103 char * const ols = SvPVX(proto->linestr);
11104 char * const ls = SvPVX(parser->linestr);
11106 parser->bufptr = ls + (proto->bufptr >= ols ?
11107 proto->bufptr - ols : 0);
11108 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11109 proto->oldbufptr - ols : 0);
11110 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11111 proto->oldoldbufptr - ols : 0);
11112 parser->linestart = ls + (proto->linestart >= ols ?
11113 proto->linestart - ols : 0);
11114 parser->last_uni = ls + (proto->last_uni >= ols ?
11115 proto->last_uni - ols : 0);
11116 parser->last_lop = ls + (proto->last_lop >= ols ?
11117 proto->last_lop - ols : 0);
11119 parser->bufend = ls + SvCUR(parser->linestr);
11122 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11126 parser->endwhite = proto->endwhite;
11127 parser->faketokens = proto->faketokens;
11128 parser->lasttoke = proto->lasttoke;
11129 parser->nextwhite = proto->nextwhite;
11130 parser->realtokenstart = proto->realtokenstart;
11131 parser->skipwhite = proto->skipwhite;
11132 parser->thisclose = proto->thisclose;
11133 parser->thismad = proto->thismad;
11134 parser->thisopen = proto->thisopen;
11135 parser->thisstuff = proto->thisstuff;
11136 parser->thistoken = proto->thistoken;
11137 parser->thiswhite = proto->thiswhite;
11139 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11140 parser->curforce = proto->curforce;
11142 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11143 Copy(proto->nexttype, parser->nexttype, 5, I32);
11144 parser->nexttoke = proto->nexttoke;
11147 /* XXX should clone saved_curcop here, but we aren't passed
11148 * proto_perl; so do it in perl_clone_using instead */
11154 /* duplicate a file handle */
11157 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11161 PERL_ARGS_ASSERT_FP_DUP;
11162 PERL_UNUSED_ARG(type);
11165 return (PerlIO*)NULL;
11167 /* look for it in the table first */
11168 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11172 /* create anew and remember what it is */
11173 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11174 ptr_table_store(PL_ptr_table, fp, ret);
11178 /* duplicate a directory handle */
11181 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11187 register const Direntry_t *dirent;
11188 char smallbuf[256];
11194 PERL_UNUSED_CONTEXT;
11195 PERL_ARGS_ASSERT_DIRP_DUP;
11200 /* look for it in the table first */
11201 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11207 PERL_UNUSED_ARG(param);
11211 /* open the current directory (so we can switch back) */
11212 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11214 /* chdir to our dir handle and open the present working directory */
11215 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11216 PerlDir_close(pwd);
11217 return (DIR *)NULL;
11219 /* Now we should have two dir handles pointing to the same dir. */
11221 /* Be nice to the calling code and chdir back to where we were. */
11222 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11224 /* We have no need of the pwd handle any more. */
11225 PerlDir_close(pwd);
11228 # define d_namlen(d) (d)->d_namlen
11230 # define d_namlen(d) strlen((d)->d_name)
11232 /* Iterate once through dp, to get the file name at the current posi-
11233 tion. Then step back. */
11234 pos = PerlDir_tell(dp);
11235 if ((dirent = PerlDir_read(dp))) {
11236 len = d_namlen(dirent);
11237 if (len <= sizeof smallbuf) name = smallbuf;
11238 else Newx(name, len, char);
11239 Move(dirent->d_name, name, len, char);
11241 PerlDir_seek(dp, pos);
11243 /* Iterate through the new dir handle, till we find a file with the
11245 if (!dirent) /* just before the end */
11247 pos = PerlDir_tell(ret);
11248 if (PerlDir_read(ret)) continue; /* not there yet */
11249 PerlDir_seek(ret, pos); /* step back */
11253 const long pos0 = PerlDir_tell(ret);
11255 pos = PerlDir_tell(ret);
11256 if ((dirent = PerlDir_read(ret))) {
11257 if (len == d_namlen(dirent)
11258 && memEQ(name, dirent->d_name, len)) {
11260 PerlDir_seek(ret, pos); /* step back */
11263 /* else we are not there yet; keep iterating */
11265 else { /* This is not meant to happen. The best we can do is
11266 reset the iterator to the beginning. */
11267 PerlDir_seek(ret, pos0);
11274 if (name && name != smallbuf)
11279 ret = win32_dirp_dup(dp, param);
11282 /* pop it in the pointer table */
11284 ptr_table_store(PL_ptr_table, dp, ret);
11289 /* duplicate a typeglob */
11292 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11296 PERL_ARGS_ASSERT_GP_DUP;
11300 /* look for it in the table first */
11301 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11305 /* create anew and remember what it is */
11307 ptr_table_store(PL_ptr_table, gp, ret);
11310 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11311 on Newxz() to do this for us. */
11312 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11313 ret->gp_io = io_dup_inc(gp->gp_io, param);
11314 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11315 ret->gp_av = av_dup_inc(gp->gp_av, param);
11316 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11317 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11318 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11319 ret->gp_cvgen = gp->gp_cvgen;
11320 ret->gp_line = gp->gp_line;
11321 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11325 /* duplicate a chain of magic */
11328 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11330 MAGIC *mgret = NULL;
11331 MAGIC **mgprev_p = &mgret;
11333 PERL_ARGS_ASSERT_MG_DUP;
11335 for (; mg; mg = mg->mg_moremagic) {
11338 if ((param->flags & CLONEf_JOIN_IN)
11339 && mg->mg_type == PERL_MAGIC_backref)
11340 /* when joining, we let the individual SVs add themselves to
11341 * backref as needed. */
11344 Newx(nmg, 1, MAGIC);
11346 mgprev_p = &(nmg->mg_moremagic);
11348 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11349 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11350 from the original commit adding Perl_mg_dup() - revision 4538.
11351 Similarly there is the annotation "XXX random ptr?" next to the
11352 assignment to nmg->mg_ptr. */
11355 /* FIXME for plugins
11356 if (nmg->mg_type == PERL_MAGIC_qr) {
11357 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11361 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11362 ? nmg->mg_type == PERL_MAGIC_backref
11363 /* The backref AV has its reference
11364 * count deliberately bumped by 1 */
11365 ? SvREFCNT_inc(av_dup_inc((const AV *)
11366 nmg->mg_obj, param))
11367 : sv_dup_inc(nmg->mg_obj, param)
11368 : sv_dup(nmg->mg_obj, param);
11370 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11371 if (nmg->mg_len > 0) {
11372 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11373 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11374 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11376 AMT * const namtp = (AMT*)nmg->mg_ptr;
11377 sv_dup_inc_multiple((SV**)(namtp->table),
11378 (SV**)(namtp->table), NofAMmeth, param);
11381 else if (nmg->mg_len == HEf_SVKEY)
11382 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11384 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11385 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11391 #endif /* USE_ITHREADS */
11393 struct ptr_tbl_arena {
11394 struct ptr_tbl_arena *next;
11395 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11398 /* create a new pointer-mapping table */
11401 Perl_ptr_table_new(pTHX)
11404 PERL_UNUSED_CONTEXT;
11406 Newx(tbl, 1, PTR_TBL_t);
11407 tbl->tbl_max = 511;
11408 tbl->tbl_items = 0;
11409 tbl->tbl_arena = NULL;
11410 tbl->tbl_arena_next = NULL;
11411 tbl->tbl_arena_end = NULL;
11412 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11416 #define PTR_TABLE_HASH(ptr) \
11417 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11419 /* map an existing pointer using a table */
11421 STATIC PTR_TBL_ENT_t *
11422 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11424 PTR_TBL_ENT_t *tblent;
11425 const UV hash = PTR_TABLE_HASH(sv);
11427 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11429 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11430 for (; tblent; tblent = tblent->next) {
11431 if (tblent->oldval == sv)
11438 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11440 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11442 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11443 PERL_UNUSED_CONTEXT;
11445 return tblent ? tblent->newval : NULL;
11448 /* add a new entry to a pointer-mapping table */
11451 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11453 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11455 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11456 PERL_UNUSED_CONTEXT;
11459 tblent->newval = newsv;
11461 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11463 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11464 struct ptr_tbl_arena *new_arena;
11466 Newx(new_arena, 1, struct ptr_tbl_arena);
11467 new_arena->next = tbl->tbl_arena;
11468 tbl->tbl_arena = new_arena;
11469 tbl->tbl_arena_next = new_arena->array;
11470 tbl->tbl_arena_end = new_arena->array
11471 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11474 tblent = tbl->tbl_arena_next++;
11476 tblent->oldval = oldsv;
11477 tblent->newval = newsv;
11478 tblent->next = tbl->tbl_ary[entry];
11479 tbl->tbl_ary[entry] = tblent;
11481 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11482 ptr_table_split(tbl);
11486 /* double the hash bucket size of an existing ptr table */
11489 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11491 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11492 const UV oldsize = tbl->tbl_max + 1;
11493 UV newsize = oldsize * 2;
11496 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11497 PERL_UNUSED_CONTEXT;
11499 Renew(ary, newsize, PTR_TBL_ENT_t*);
11500 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11501 tbl->tbl_max = --newsize;
11502 tbl->tbl_ary = ary;
11503 for (i=0; i < oldsize; i++, ary++) {
11504 PTR_TBL_ENT_t **entp = ary;
11505 PTR_TBL_ENT_t *ent = *ary;
11506 PTR_TBL_ENT_t **curentp;
11509 curentp = ary + oldsize;
11511 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11513 ent->next = *curentp;
11523 /* remove all the entries from a ptr table */
11524 /* Deprecated - will be removed post 5.14 */
11527 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11529 if (tbl && tbl->tbl_items) {
11530 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11532 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11535 struct ptr_tbl_arena *next = arena->next;
11541 tbl->tbl_items = 0;
11542 tbl->tbl_arena = NULL;
11543 tbl->tbl_arena_next = NULL;
11544 tbl->tbl_arena_end = NULL;
11548 /* clear and free a ptr table */
11551 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11553 struct ptr_tbl_arena *arena;
11559 arena = tbl->tbl_arena;
11562 struct ptr_tbl_arena *next = arena->next;
11568 Safefree(tbl->tbl_ary);
11572 #if defined(USE_ITHREADS)
11575 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
11577 PERL_ARGS_ASSERT_RVPV_DUP;
11580 if (SvWEAKREF(sstr)) {
11581 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
11582 if (param->flags & CLONEf_JOIN_IN) {
11583 /* if joining, we add any back references individually rather
11584 * than copying the whole backref array */
11585 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
11589 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
11591 else if (SvPVX_const(sstr)) {
11592 /* Has something there */
11594 /* Normal PV - clone whole allocated space */
11595 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
11596 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
11597 /* Not that normal - actually sstr is copy on write.
11598 But we are a true, independant SV, so: */
11599 SvREADONLY_off(dstr);
11604 /* Special case - not normally malloced for some reason */
11605 if (isGV_with_GP(sstr)) {
11606 /* Don't need to do anything here. */
11608 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
11609 /* A "shared" PV - clone it as "shared" PV */
11611 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
11615 /* Some other special case - random pointer */
11616 SvPV_set(dstr, (char *) SvPVX_const(sstr));
11621 /* Copy the NULL */
11622 SvPV_set(dstr, NULL);
11626 /* duplicate a list of SVs. source and dest may point to the same memory. */
11628 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
11629 SSize_t items, CLONE_PARAMS *const param)
11631 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
11633 while (items-- > 0) {
11634 *dest++ = sv_dup_inc(*source++, param);
11640 /* duplicate an SV of any type (including AV, HV etc) */
11643 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
11648 PERL_ARGS_ASSERT_SV_DUP_COMMON;
11650 if (SvTYPE(sstr) == SVTYPEMASK) {
11651 #ifdef DEBUG_LEAKING_SCALARS_ABORT
11656 /* look for it in the table first */
11657 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
11661 if(param->flags & CLONEf_JOIN_IN) {
11662 /** We are joining here so we don't want do clone
11663 something that is bad **/
11664 if (SvTYPE(sstr) == SVt_PVHV) {
11665 const HEK * const hvname = HvNAME_HEK(sstr);
11667 /** don't clone stashes if they already exist **/
11668 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0));
11669 ptr_table_store(PL_ptr_table, sstr, dstr);
11675 /* create anew and remember what it is */
11678 #ifdef DEBUG_LEAKING_SCALARS
11679 dstr->sv_debug_optype = sstr->sv_debug_optype;
11680 dstr->sv_debug_line = sstr->sv_debug_line;
11681 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
11682 dstr->sv_debug_parent = (SV*)sstr;
11683 FREE_SV_DEBUG_FILE(dstr);
11684 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
11687 ptr_table_store(PL_ptr_table, sstr, dstr);
11690 SvFLAGS(dstr) = SvFLAGS(sstr);
11691 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
11692 SvREFCNT(dstr) = 0; /* must be before any other dups! */
11695 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
11696 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
11697 (void*)PL_watch_pvx, SvPVX_const(sstr));
11700 /* don't clone objects whose class has asked us not to */
11701 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
11706 switch (SvTYPE(sstr)) {
11708 SvANY(dstr) = NULL;
11711 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
11713 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11715 SvIV_set(dstr, SvIVX(sstr));
11719 SvANY(dstr) = new_XNV();
11720 SvNV_set(dstr, SvNVX(sstr));
11722 /* case SVt_BIND: */
11725 /* These are all the types that need complex bodies allocating. */
11727 const svtype sv_type = SvTYPE(sstr);
11728 const struct body_details *const sv_type_details
11729 = bodies_by_type + sv_type;
11733 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11748 assert(sv_type_details->body_size);
11749 if (sv_type_details->arena) {
11750 new_body_inline(new_body, sv_type);
11752 = (void*)((char*)new_body - sv_type_details->offset);
11754 new_body = new_NOARENA(sv_type_details);
11758 SvANY(dstr) = new_body;
11761 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
11762 ((char*)SvANY(dstr)) + sv_type_details->offset,
11763 sv_type_details->copy, char);
11765 Copy(((char*)SvANY(sstr)),
11766 ((char*)SvANY(dstr)),
11767 sv_type_details->body_size + sv_type_details->offset, char);
11770 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
11771 && !isGV_with_GP(dstr)
11772 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
11773 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
11775 /* The Copy above means that all the source (unduplicated) pointers
11776 are now in the destination. We can check the flags and the
11777 pointers in either, but it's possible that there's less cache
11778 missing by always going for the destination.
11779 FIXME - instrument and check that assumption */
11780 if (sv_type >= SVt_PVMG) {
11781 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
11782 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
11783 } else if (SvMAGIC(dstr))
11784 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
11786 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
11789 /* The cast silences a GCC warning about unhandled types. */
11790 switch ((int)sv_type) {
11800 /* FIXME for plugins */
11801 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
11804 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
11805 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
11806 LvTARG(dstr) = dstr;
11807 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
11808 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
11810 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
11812 /* non-GP case already handled above */
11813 if(isGV_with_GP(sstr)) {
11814 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
11815 /* Don't call sv_add_backref here as it's going to be
11816 created as part of the magic cloning of the symbol
11817 table--unless this is during a join and the stash
11818 is not actually being cloned. */
11819 /* Danger Will Robinson - GvGP(dstr) isn't initialised
11820 at the point of this comment. */
11821 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
11822 if (param->flags & CLONEf_JOIN_IN)
11823 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
11824 GvGP(dstr) = gp_dup(GvGP(sstr), param);
11825 (void)GpREFCNT_inc(GvGP(dstr));
11829 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
11830 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
11831 /* I have no idea why fake dirp (rsfps)
11832 should be treated differently but otherwise
11833 we end up with leaks -- sky*/
11834 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
11835 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
11836 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
11838 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
11839 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
11840 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
11841 if (IoDIRP(dstr)) {
11842 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
11845 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
11847 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
11849 if (IoOFP(dstr) == IoIFP(sstr))
11850 IoOFP(dstr) = IoIFP(dstr);
11852 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
11853 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
11854 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
11855 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
11858 /* avoid cloning an empty array */
11859 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
11860 SV **dst_ary, **src_ary;
11861 SSize_t items = AvFILLp((const AV *)sstr) + 1;
11863 src_ary = AvARRAY((const AV *)sstr);
11864 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
11865 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
11866 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
11867 AvALLOC((const AV *)dstr) = dst_ary;
11868 if (AvREAL((const AV *)sstr)) {
11869 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
11873 while (items-- > 0)
11874 *dst_ary++ = sv_dup(*src_ary++, param);
11876 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
11877 while (items-- > 0) {
11878 *dst_ary++ = &PL_sv_undef;
11882 AvARRAY(MUTABLE_AV(dstr)) = NULL;
11883 AvALLOC((const AV *)dstr) = (SV**)NULL;
11884 AvMAX( (const AV *)dstr) = -1;
11885 AvFILLp((const AV *)dstr) = -1;
11889 if (HvARRAY((const HV *)sstr)) {
11891 const bool sharekeys = !!HvSHAREKEYS(sstr);
11892 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
11893 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
11895 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
11896 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
11898 HvARRAY(dstr) = (HE**)darray;
11899 while (i <= sxhv->xhv_max) {
11900 const HE * const source = HvARRAY(sstr)[i];
11901 HvARRAY(dstr)[i] = source
11902 ? he_dup(source, sharekeys, param) : 0;
11906 const struct xpvhv_aux * const saux = HvAUX(sstr);
11907 struct xpvhv_aux * const daux = HvAUX(dstr);
11908 /* This flag isn't copied. */
11909 /* SvOOK_on(hv) attacks the IV flags. */
11910 SvFLAGS(dstr) |= SVf_OOK;
11912 if (saux->xhv_name_count) {
11913 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
11915 = saux->xhv_name_count < 0
11916 ? -saux->xhv_name_count
11917 : saux->xhv_name_count;
11918 HEK **shekp = sname + count;
11920 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
11921 dhekp = daux->xhv_name_u.xhvnameu_names + count;
11922 while (shekp-- > sname) {
11924 *dhekp = hek_dup(*shekp, param);
11928 daux->xhv_name_u.xhvnameu_name
11929 = hek_dup(saux->xhv_name_u.xhvnameu_name,
11932 daux->xhv_name_count = saux->xhv_name_count;
11934 daux->xhv_riter = saux->xhv_riter;
11935 daux->xhv_eiter = saux->xhv_eiter
11936 ? he_dup(saux->xhv_eiter,
11937 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
11938 /* backref array needs refcnt=2; see sv_add_backref */
11939 daux->xhv_backreferences =
11940 (param->flags & CLONEf_JOIN_IN)
11941 /* when joining, we let the individual GVs and
11942 * CVs add themselves to backref as
11943 * needed. This avoids pulling in stuff
11944 * that isn't required, and simplifies the
11945 * case where stashes aren't cloned back
11946 * if they already exist in the parent
11949 : saux->xhv_backreferences
11950 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
11951 ? MUTABLE_AV(SvREFCNT_inc(
11952 sv_dup_inc((const SV *)
11953 saux->xhv_backreferences, param)))
11954 : MUTABLE_AV(sv_dup((const SV *)
11955 saux->xhv_backreferences, param))
11958 daux->xhv_mro_meta = saux->xhv_mro_meta
11959 ? mro_meta_dup(saux->xhv_mro_meta, param)
11962 /* Record stashes for possible cloning in Perl_clone(). */
11964 av_push(param->stashes, dstr);
11968 HvARRAY(MUTABLE_HV(dstr)) = NULL;
11971 if (!(param->flags & CLONEf_COPY_STACKS)) {
11976 /* NOTE: not refcounted */
11977 SvANY(MUTABLE_CV(dstr))->xcv_stash =
11978 hv_dup(CvSTASH(dstr), param);
11979 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
11980 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
11981 if (!CvISXSUB(dstr)) {
11983 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
11985 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
11986 } else if (CvCONST(dstr)) {
11987 CvXSUBANY(dstr).any_ptr =
11988 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
11990 /* don't dup if copying back - CvGV isn't refcounted, so the
11991 * duped GV may never be freed. A bit of a hack! DAPM */
11992 SvANY(MUTABLE_CV(dstr))->xcv_gv =
11994 ? gv_dup_inc(CvGV(sstr), param)
11995 : (param->flags & CLONEf_JOIN_IN)
11997 : gv_dup(CvGV(sstr), param);
11999 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12001 CvWEAKOUTSIDE(sstr)
12002 ? cv_dup( CvOUTSIDE(dstr), param)
12003 : cv_dup_inc(CvOUTSIDE(dstr), param);
12009 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
12016 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12018 PERL_ARGS_ASSERT_SV_DUP_INC;
12019 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12023 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12025 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12026 PERL_ARGS_ASSERT_SV_DUP;
12028 /* Track every SV that (at least initially) had a reference count of 0.
12029 We need to do this by holding an actual reference to it in this array.
12030 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12031 (akin to the stashes hash, and the perl stack), we come unstuck if
12032 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12033 thread) is manipulated in a CLONE method, because CLONE runs before the
12034 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12035 (and fix things up by giving each a reference via the temps stack).
12036 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12037 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12038 before the walk of unreferenced happens and a reference to that is SV
12039 added to the temps stack. At which point we have the same SV considered
12040 to be in use, and free to be re-used. Not good.
12042 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12043 assert(param->unreferenced);
12044 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12050 /* duplicate a context */
12053 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12055 PERL_CONTEXT *ncxs;
12057 PERL_ARGS_ASSERT_CX_DUP;
12060 return (PERL_CONTEXT*)NULL;
12062 /* look for it in the table first */
12063 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12067 /* create anew and remember what it is */
12068 Newx(ncxs, max + 1, PERL_CONTEXT);
12069 ptr_table_store(PL_ptr_table, cxs, ncxs);
12070 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12073 PERL_CONTEXT * const ncx = &ncxs[ix];
12074 if (CxTYPE(ncx) == CXt_SUBST) {
12075 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12078 switch (CxTYPE(ncx)) {
12080 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12081 ? cv_dup_inc(ncx->blk_sub.cv, param)
12082 : cv_dup(ncx->blk_sub.cv,param));
12083 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12084 ? av_dup_inc(ncx->blk_sub.argarray,
12087 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12089 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12090 ncx->blk_sub.oldcomppad);
12093 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12095 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12097 case CXt_LOOP_LAZYSV:
12098 ncx->blk_loop.state_u.lazysv.end
12099 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12100 /* We are taking advantage of av_dup_inc and sv_dup_inc
12101 actually being the same function, and order equivalance of
12103 We can assert the later [but only at run time :-(] */
12104 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12105 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12107 ncx->blk_loop.state_u.ary.ary
12108 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12109 case CXt_LOOP_LAZYIV:
12110 case CXt_LOOP_PLAIN:
12111 if (CxPADLOOP(ncx)) {
12112 ncx->blk_loop.itervar_u.oldcomppad
12113 = (PAD*)ptr_table_fetch(PL_ptr_table,
12114 ncx->blk_loop.itervar_u.oldcomppad);
12116 ncx->blk_loop.itervar_u.gv
12117 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12122 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12123 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12124 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12137 /* duplicate a stack info structure */
12140 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12144 PERL_ARGS_ASSERT_SI_DUP;
12147 return (PERL_SI*)NULL;
12149 /* look for it in the table first */
12150 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12154 /* create anew and remember what it is */
12155 Newxz(nsi, 1, PERL_SI);
12156 ptr_table_store(PL_ptr_table, si, nsi);
12158 nsi->si_stack = av_dup_inc(si->si_stack, param);
12159 nsi->si_cxix = si->si_cxix;
12160 nsi->si_cxmax = si->si_cxmax;
12161 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12162 nsi->si_type = si->si_type;
12163 nsi->si_prev = si_dup(si->si_prev, param);
12164 nsi->si_next = si_dup(si->si_next, param);
12165 nsi->si_markoff = si->si_markoff;
12170 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12171 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12172 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12173 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12174 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12175 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12176 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12177 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12178 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12179 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12180 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12181 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12182 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12183 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12184 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12185 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12188 #define pv_dup_inc(p) SAVEPV(p)
12189 #define pv_dup(p) SAVEPV(p)
12190 #define svp_dup_inc(p,pp) any_dup(p,pp)
12192 /* map any object to the new equivent - either something in the
12193 * ptr table, or something in the interpreter structure
12197 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12201 PERL_ARGS_ASSERT_ANY_DUP;
12204 return (void*)NULL;
12206 /* look for it in the table first */
12207 ret = ptr_table_fetch(PL_ptr_table, v);
12211 /* see if it is part of the interpreter structure */
12212 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12213 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12221 /* duplicate the save stack */
12224 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12227 ANY * const ss = proto_perl->Isavestack;
12228 const I32 max = proto_perl->Isavestack_max;
12229 I32 ix = proto_perl->Isavestack_ix;
12242 void (*dptr) (void*);
12243 void (*dxptr) (pTHX_ void*);
12245 PERL_ARGS_ASSERT_SS_DUP;
12247 Newxz(nss, max, ANY);
12250 const UV uv = POPUV(ss,ix);
12251 const U8 type = (U8)uv & SAVE_MASK;
12253 TOPUV(nss,ix) = uv;
12255 case SAVEt_CLEARSV:
12257 case SAVEt_HELEM: /* hash element */
12258 sv = (const SV *)POPPTR(ss,ix);
12259 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12261 case SAVEt_ITEM: /* normal string */
12262 case SAVEt_GVSV: /* scalar slot in GV */
12263 case SAVEt_SV: /* scalar reference */
12264 sv = (const SV *)POPPTR(ss,ix);
12265 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12268 case SAVEt_MORTALIZESV:
12269 sv = (const SV *)POPPTR(ss,ix);
12270 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12272 case SAVEt_SHARED_PVREF: /* char* in shared space */
12273 c = (char*)POPPTR(ss,ix);
12274 TOPPTR(nss,ix) = savesharedpv(c);
12275 ptr = POPPTR(ss,ix);
12276 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12278 case SAVEt_GENERIC_SVREF: /* generic sv */
12279 case SAVEt_SVREF: /* scalar reference */
12280 sv = (const SV *)POPPTR(ss,ix);
12281 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12282 ptr = POPPTR(ss,ix);
12283 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12285 case SAVEt_HV: /* hash reference */
12286 case SAVEt_AV: /* array reference */
12287 sv = (const SV *) POPPTR(ss,ix);
12288 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12290 case SAVEt_COMPPAD:
12292 sv = (const SV *) POPPTR(ss,ix);
12293 TOPPTR(nss,ix) = sv_dup(sv, param);
12295 case SAVEt_INT: /* int reference */
12296 ptr = POPPTR(ss,ix);
12297 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12298 intval = (int)POPINT(ss,ix);
12299 TOPINT(nss,ix) = intval;
12301 case SAVEt_LONG: /* long reference */
12302 ptr = POPPTR(ss,ix);
12303 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12304 longval = (long)POPLONG(ss,ix);
12305 TOPLONG(nss,ix) = longval;
12307 case SAVEt_I32: /* I32 reference */
12308 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
12309 ptr = POPPTR(ss,ix);
12310 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12312 TOPINT(nss,ix) = i;
12314 case SAVEt_IV: /* IV reference */
12315 ptr = POPPTR(ss,ix);
12316 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12318 TOPIV(nss,ix) = iv;
12320 case SAVEt_HPTR: /* HV* reference */
12321 case SAVEt_APTR: /* AV* reference */
12322 case SAVEt_SPTR: /* SV* reference */
12323 ptr = POPPTR(ss,ix);
12324 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12325 sv = (const SV *)POPPTR(ss,ix);
12326 TOPPTR(nss,ix) = sv_dup(sv, param);
12328 case SAVEt_VPTR: /* random* reference */
12329 ptr = POPPTR(ss,ix);
12330 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12332 case SAVEt_INT_SMALL:
12333 case SAVEt_I32_SMALL:
12334 case SAVEt_I16: /* I16 reference */
12335 case SAVEt_I8: /* I8 reference */
12337 ptr = POPPTR(ss,ix);
12338 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12340 case SAVEt_GENERIC_PVREF: /* generic char* */
12341 case SAVEt_PPTR: /* char* reference */
12342 ptr = POPPTR(ss,ix);
12343 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12344 c = (char*)POPPTR(ss,ix);
12345 TOPPTR(nss,ix) = pv_dup(c);
12347 case SAVEt_GP: /* scalar reference */
12348 gp = (GP*)POPPTR(ss,ix);
12349 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12350 (void)GpREFCNT_inc(gp);
12351 gv = (const GV *)POPPTR(ss,ix);
12352 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12355 ptr = POPPTR(ss,ix);
12356 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12357 /* these are assumed to be refcounted properly */
12359 switch (((OP*)ptr)->op_type) {
12361 case OP_LEAVESUBLV:
12365 case OP_LEAVEWRITE:
12366 TOPPTR(nss,ix) = ptr;
12369 (void) OpREFCNT_inc(o);
12373 TOPPTR(nss,ix) = NULL;
12378 TOPPTR(nss,ix) = NULL;
12380 case SAVEt_FREECOPHH:
12381 ptr = POPPTR(ss,ix);
12382 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12385 hv = (const HV *)POPPTR(ss,ix);
12386 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12388 TOPINT(nss,ix) = i;
12391 c = (char*)POPPTR(ss,ix);
12392 TOPPTR(nss,ix) = pv_dup_inc(c);
12394 case SAVEt_STACK_POS: /* Position on Perl stack */
12396 TOPINT(nss,ix) = i;
12398 case SAVEt_DESTRUCTOR:
12399 ptr = POPPTR(ss,ix);
12400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12401 dptr = POPDPTR(ss,ix);
12402 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12403 any_dup(FPTR2DPTR(void *, dptr),
12406 case SAVEt_DESTRUCTOR_X:
12407 ptr = POPPTR(ss,ix);
12408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12409 dxptr = POPDXPTR(ss,ix);
12410 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12411 any_dup(FPTR2DPTR(void *, dxptr),
12414 case SAVEt_REGCONTEXT:
12416 ix -= uv >> SAVE_TIGHT_SHIFT;
12418 case SAVEt_AELEM: /* array element */
12419 sv = (const SV *)POPPTR(ss,ix);
12420 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12422 TOPINT(nss,ix) = i;
12423 av = (const AV *)POPPTR(ss,ix);
12424 TOPPTR(nss,ix) = av_dup_inc(av, param);
12427 ptr = POPPTR(ss,ix);
12428 TOPPTR(nss,ix) = ptr;
12431 ptr = POPPTR(ss,ix);
12432 ptr = cophh_copy((COPHH*)ptr);
12433 TOPPTR(nss,ix) = ptr;
12435 TOPINT(nss,ix) = i;
12436 if (i & HINT_LOCALIZE_HH) {
12437 hv = (const HV *)POPPTR(ss,ix);
12438 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12441 case SAVEt_PADSV_AND_MORTALIZE:
12442 longval = (long)POPLONG(ss,ix);
12443 TOPLONG(nss,ix) = longval;
12444 ptr = POPPTR(ss,ix);
12445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12446 sv = (const SV *)POPPTR(ss,ix);
12447 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12449 case SAVEt_SET_SVFLAGS:
12451 TOPINT(nss,ix) = i;
12453 TOPINT(nss,ix) = i;
12454 sv = (const SV *)POPPTR(ss,ix);
12455 TOPPTR(nss,ix) = sv_dup(sv, param);
12457 case SAVEt_RE_STATE:
12459 const struct re_save_state *const old_state
12460 = (struct re_save_state *)
12461 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12462 struct re_save_state *const new_state
12463 = (struct re_save_state *)
12464 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
12466 Copy(old_state, new_state, 1, struct re_save_state);
12467 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12469 new_state->re_state_bostr
12470 = pv_dup(old_state->re_state_bostr);
12471 new_state->re_state_reginput
12472 = pv_dup(old_state->re_state_reginput);
12473 new_state->re_state_regeol
12474 = pv_dup(old_state->re_state_regeol);
12475 new_state->re_state_regoffs
12476 = (regexp_paren_pair*)
12477 any_dup(old_state->re_state_regoffs, proto_perl);
12478 new_state->re_state_reglastparen
12479 = (U32*) any_dup(old_state->re_state_reglastparen,
12481 new_state->re_state_reglastcloseparen
12482 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
12484 /* XXX This just has to be broken. The old save_re_context
12485 code did SAVEGENERICPV(PL_reg_start_tmp);
12486 PL_reg_start_tmp is char **.
12487 Look above to what the dup code does for
12488 SAVEt_GENERIC_PVREF
12489 It can never have worked.
12490 So this is merely a faithful copy of the exiting bug: */
12491 new_state->re_state_reg_start_tmp
12492 = (char **) pv_dup((char *)
12493 old_state->re_state_reg_start_tmp);
12494 /* I assume that it only ever "worked" because no-one called
12495 (pseudo)fork while the regexp engine had re-entered itself.
12497 #ifdef PERL_OLD_COPY_ON_WRITE
12498 new_state->re_state_nrs
12499 = sv_dup(old_state->re_state_nrs, param);
12501 new_state->re_state_reg_magic
12502 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
12504 new_state->re_state_reg_oldcurpm
12505 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
12507 new_state->re_state_reg_curpm
12508 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
12510 new_state->re_state_reg_oldsaved
12511 = pv_dup(old_state->re_state_reg_oldsaved);
12512 new_state->re_state_reg_poscache
12513 = pv_dup(old_state->re_state_reg_poscache);
12514 new_state->re_state_reg_starttry
12515 = pv_dup(old_state->re_state_reg_starttry);
12518 case SAVEt_COMPILE_WARNINGS:
12519 ptr = POPPTR(ss,ix);
12520 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12523 ptr = POPPTR(ss,ix);
12524 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12528 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12536 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12537 * flag to the result. This is done for each stash before cloning starts,
12538 * so we know which stashes want their objects cloned */
12541 do_mark_cloneable_stash(pTHX_ SV *const sv)
12543 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12545 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12546 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12547 if (cloner && GvCV(cloner)) {
12554 mXPUSHs(newSVhek(hvname));
12556 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12563 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12571 =for apidoc perl_clone
12573 Create and return a new interpreter by cloning the current one.
12575 perl_clone takes these flags as parameters:
12577 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12578 without it we only clone the data and zero the stacks,
12579 with it we copy the stacks and the new perl interpreter is
12580 ready to run at the exact same point as the previous one.
12581 The pseudo-fork code uses COPY_STACKS while the
12582 threads->create doesn't.
12584 CLONEf_KEEP_PTR_TABLE
12585 perl_clone keeps a ptr_table with the pointer of the old
12586 variable as a key and the new variable as a value,
12587 this allows it to check if something has been cloned and not
12588 clone it again but rather just use the value and increase the
12589 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
12590 the ptr_table using the function
12591 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
12592 reason to keep it around is if you want to dup some of your own
12593 variable who are outside the graph perl scans, example of this
12594 code is in threads.xs create
12597 This is a win32 thing, it is ignored on unix, it tells perls
12598 win32host code (which is c++) to clone itself, this is needed on
12599 win32 if you want to run two threads at the same time,
12600 if you just want to do some stuff in a separate perl interpreter
12601 and then throw it away and return to the original one,
12602 you don't need to do anything.
12607 /* XXX the above needs expanding by someone who actually understands it ! */
12608 EXTERN_C PerlInterpreter *
12609 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
12612 perl_clone(PerlInterpreter *proto_perl, UV flags)
12615 #ifdef PERL_IMPLICIT_SYS
12617 PERL_ARGS_ASSERT_PERL_CLONE;
12619 /* perlhost.h so we need to call into it
12620 to clone the host, CPerlHost should have a c interface, sky */
12622 if (flags & CLONEf_CLONE_HOST) {
12623 return perl_clone_host(proto_perl,flags);
12625 return perl_clone_using(proto_perl, flags,
12627 proto_perl->IMemShared,
12628 proto_perl->IMemParse,
12630 proto_perl->IStdIO,
12634 proto_perl->IProc);
12638 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
12639 struct IPerlMem* ipM, struct IPerlMem* ipMS,
12640 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
12641 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
12642 struct IPerlDir* ipD, struct IPerlSock* ipS,
12643 struct IPerlProc* ipP)
12645 /* XXX many of the string copies here can be optimized if they're
12646 * constants; they need to be allocated as common memory and just
12647 * their pointers copied. */
12650 CLONE_PARAMS clone_params;
12651 CLONE_PARAMS* const param = &clone_params;
12653 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
12655 PERL_ARGS_ASSERT_PERL_CLONE_USING;
12656 #else /* !PERL_IMPLICIT_SYS */
12658 CLONE_PARAMS clone_params;
12659 CLONE_PARAMS* param = &clone_params;
12660 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
12662 PERL_ARGS_ASSERT_PERL_CLONE;
12663 #endif /* PERL_IMPLICIT_SYS */
12665 /* for each stash, determine whether its objects should be cloned */
12666 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
12667 PERL_SET_THX(my_perl);
12670 PoisonNew(my_perl, 1, PerlInterpreter);
12675 PL_scopestack_name = 0;
12677 PL_savestack_ix = 0;
12678 PL_savestack_max = -1;
12679 PL_sig_pending = 0;
12681 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
12682 # ifdef DEBUG_LEAKING_SCALARS
12683 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
12685 #else /* !DEBUGGING */
12686 Zero(my_perl, 1, PerlInterpreter);
12687 #endif /* DEBUGGING */
12689 #ifdef PERL_IMPLICIT_SYS
12690 /* host pointers */
12692 PL_MemShared = ipMS;
12693 PL_MemParse = ipMP;
12700 #endif /* PERL_IMPLICIT_SYS */
12702 param->flags = flags;
12703 /* Nothing in the core code uses this, but we make it available to
12704 extensions (using mg_dup). */
12705 param->proto_perl = proto_perl;
12706 /* Likely nothing will use this, but it is initialised to be consistent
12707 with Perl_clone_params_new(). */
12708 param->new_perl = my_perl;
12709 param->unreferenced = NULL;
12711 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
12713 PL_body_arenas = NULL;
12714 Zero(&PL_body_roots, 1, PL_body_roots);
12717 PL_sv_objcount = 0;
12719 PL_sv_arenaroot = NULL;
12721 PL_debug = proto_perl->Idebug;
12723 PL_hash_seed = proto_perl->Ihash_seed;
12724 PL_rehash_seed = proto_perl->Irehash_seed;
12726 #ifdef USE_REENTRANT_API
12727 /* XXX: things like -Dm will segfault here in perlio, but doing
12728 * PERL_SET_CONTEXT(proto_perl);
12729 * breaks too many other things
12731 Perl_reentrant_init(aTHX);
12734 /* create SV map for pointer relocation */
12735 PL_ptr_table = ptr_table_new();
12737 /* initialize these special pointers as early as possible */
12738 SvANY(&PL_sv_undef) = NULL;
12739 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
12740 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
12741 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
12743 SvANY(&PL_sv_no) = new_XPVNV();
12744 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
12745 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12746 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12747 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
12748 SvCUR_set(&PL_sv_no, 0);
12749 SvLEN_set(&PL_sv_no, 1);
12750 SvIV_set(&PL_sv_no, 0);
12751 SvNV_set(&PL_sv_no, 0);
12752 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
12754 SvANY(&PL_sv_yes) = new_XPVNV();
12755 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
12756 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
12757 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
12758 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
12759 SvCUR_set(&PL_sv_yes, 1);
12760 SvLEN_set(&PL_sv_yes, 2);
12761 SvIV_set(&PL_sv_yes, 1);
12762 SvNV_set(&PL_sv_yes, 1);
12763 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
12765 /* dbargs array probably holds garbage */
12768 /* create (a non-shared!) shared string table */
12769 PL_strtab = newHV();
12770 HvSHAREKEYS_off(PL_strtab);
12771 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
12772 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
12774 PL_compiling = proto_perl->Icompiling;
12776 /* These two PVs will be free'd special way so must set them same way op.c does */
12777 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
12778 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
12780 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
12781 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
12783 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
12784 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
12785 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
12786 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
12787 #ifdef PERL_DEBUG_READONLY_OPS
12792 /* pseudo environmental stuff */
12793 PL_origargc = proto_perl->Iorigargc;
12794 PL_origargv = proto_perl->Iorigargv;
12796 param->stashes = newAV(); /* Setup array of objects to call clone on */
12797 /* This makes no difference to the implementation, as it always pushes
12798 and shifts pointers to other SVs without changing their reference
12799 count, with the array becoming empty before it is freed. However, it
12800 makes it conceptually clear what is going on, and will avoid some
12801 work inside av.c, filling slots between AvFILL() and AvMAX() with
12802 &PL_sv_undef, and SvREFCNT_dec()ing those. */
12803 AvREAL_off(param->stashes);
12805 if (!(flags & CLONEf_COPY_STACKS)) {
12806 param->unreferenced = newAV();
12809 /* Set tainting stuff before PerlIO_debug can possibly get called */
12810 PL_tainting = proto_perl->Itainting;
12811 PL_taint_warn = proto_perl->Itaint_warn;
12813 #ifdef PERLIO_LAYERS
12814 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
12815 PerlIO_clone(aTHX_ proto_perl, param);
12818 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
12819 PL_incgv = gv_dup(proto_perl->Iincgv, param);
12820 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
12821 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
12822 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
12823 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
12826 PL_minus_c = proto_perl->Iminus_c;
12827 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
12828 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
12829 PL_localpatches = proto_perl->Ilocalpatches;
12830 PL_splitstr = proto_perl->Isplitstr;
12831 PL_minus_n = proto_perl->Iminus_n;
12832 PL_minus_p = proto_perl->Iminus_p;
12833 PL_minus_l = proto_perl->Iminus_l;
12834 PL_minus_a = proto_perl->Iminus_a;
12835 PL_minus_E = proto_perl->Iminus_E;
12836 PL_minus_F = proto_perl->Iminus_F;
12837 PL_doswitches = proto_perl->Idoswitches;
12838 PL_dowarn = proto_perl->Idowarn;
12839 PL_sawampersand = proto_perl->Isawampersand;
12840 PL_unsafe = proto_perl->Iunsafe;
12841 PL_inplace = SAVEPV(proto_perl->Iinplace);
12842 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
12843 PL_perldb = proto_perl->Iperldb;
12844 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
12845 PL_exit_flags = proto_perl->Iexit_flags;
12847 /* magical thingies */
12848 /* XXX time(&PL_basetime) when asked for? */
12849 PL_basetime = proto_perl->Ibasetime;
12850 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
12852 PL_maxsysfd = proto_perl->Imaxsysfd;
12853 PL_statusvalue = proto_perl->Istatusvalue;
12855 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
12857 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
12859 PL_encoding = sv_dup(proto_perl->Iencoding, param);
12861 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
12862 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
12863 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
12866 /* RE engine related */
12867 Zero(&PL_reg_state, 1, struct re_save_state);
12868 PL_reginterp_cnt = 0;
12869 PL_regmatch_slab = NULL;
12871 /* Clone the regex array */
12872 /* ORANGE FIXME for plugins, probably in the SV dup code.
12873 newSViv(PTR2IV(CALLREGDUPE(
12874 INT2PTR(REGEXP *, SvIVX(regex)), param))))
12876 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
12877 PL_regex_pad = AvARRAY(PL_regex_padav);
12879 /* shortcuts to various I/O objects */
12880 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
12881 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
12882 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
12883 PL_defgv = gv_dup(proto_perl->Idefgv, param);
12884 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
12885 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
12886 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
12888 /* shortcuts to regexp stuff */
12889 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
12891 /* shortcuts to misc objects */
12892 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
12894 /* shortcuts to debugging objects */
12895 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
12896 PL_DBline = gv_dup(proto_perl->IDBline, param);
12897 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
12898 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
12899 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
12900 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
12902 /* symbol tables */
12903 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
12904 PL_curstash = hv_dup(proto_perl->Icurstash, param);
12905 PL_debstash = hv_dup(proto_perl->Idebstash, param);
12906 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
12907 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
12909 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
12910 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
12911 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
12912 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
12913 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
12914 PL_endav = av_dup_inc(proto_perl->Iendav, param);
12915 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
12916 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
12918 PL_sub_generation = proto_perl->Isub_generation;
12919 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
12921 /* funky return mechanisms */
12922 PL_forkprocess = proto_perl->Iforkprocess;
12924 /* subprocess state */
12925 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
12927 /* internal state */
12928 PL_maxo = proto_perl->Imaxo;
12929 if (proto_perl->Iop_mask)
12930 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
12933 /* PL_asserting = proto_perl->Iasserting; */
12935 /* current interpreter roots */
12936 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
12938 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
12940 PL_main_start = proto_perl->Imain_start;
12941 PL_eval_root = proto_perl->Ieval_root;
12942 PL_eval_start = proto_perl->Ieval_start;
12944 /* runtime control stuff */
12945 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
12947 PL_filemode = proto_perl->Ifilemode;
12948 PL_lastfd = proto_perl->Ilastfd;
12949 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
12952 PL_gensym = proto_perl->Igensym;
12953 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
12954 PL_laststatval = proto_perl->Ilaststatval;
12955 PL_laststype = proto_perl->Ilaststype;
12958 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
12960 /* interpreter atexit processing */
12961 PL_exitlistlen = proto_perl->Iexitlistlen;
12962 if (PL_exitlistlen) {
12963 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12964 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
12967 PL_exitlist = (PerlExitListEntry*)NULL;
12969 PL_my_cxt_size = proto_perl->Imy_cxt_size;
12970 if (PL_my_cxt_size) {
12971 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
12972 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
12973 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12974 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
12975 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
12979 PL_my_cxt_list = (void**)NULL;
12980 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
12981 PL_my_cxt_keys = (const char**)NULL;
12984 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
12985 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
12986 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
12987 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
12989 PL_profiledata = NULL;
12991 PL_compcv = cv_dup(proto_perl->Icompcv, param);
12993 PAD_CLONE_VARS(proto_perl, param);
12995 #ifdef HAVE_INTERP_INTERN
12996 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
12999 /* more statics moved here */
13000 PL_generation = proto_perl->Igeneration;
13001 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13003 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13004 PL_in_clean_all = proto_perl->Iin_clean_all;
13006 PL_uid = proto_perl->Iuid;
13007 PL_euid = proto_perl->Ieuid;
13008 PL_gid = proto_perl->Igid;
13009 PL_egid = proto_perl->Iegid;
13010 PL_nomemok = proto_perl->Inomemok;
13011 PL_an = proto_perl->Ian;
13012 PL_evalseq = proto_perl->Ievalseq;
13013 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13014 PL_origalen = proto_perl->Iorigalen;
13015 #ifdef PERL_USES_PL_PIDSTATUS
13016 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13018 PL_osname = SAVEPV(proto_perl->Iosname);
13019 PL_sighandlerp = proto_perl->Isighandlerp;
13021 PL_runops = proto_perl->Irunops;
13023 PL_parser = parser_dup(proto_perl->Iparser, param);
13025 /* XXX this only works if the saved cop has already been cloned */
13026 if (proto_perl->Iparser) {
13027 PL_parser->saved_curcop = (COP*)any_dup(
13028 proto_perl->Iparser->saved_curcop,
13032 PL_subline = proto_perl->Isubline;
13033 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13036 PL_cryptseen = proto_perl->Icryptseen;
13039 PL_hints = proto_perl->Ihints;
13041 PL_amagic_generation = proto_perl->Iamagic_generation;
13043 #ifdef USE_LOCALE_COLLATE
13044 PL_collation_ix = proto_perl->Icollation_ix;
13045 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13046 PL_collation_standard = proto_perl->Icollation_standard;
13047 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13048 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13049 #endif /* USE_LOCALE_COLLATE */
13051 #ifdef USE_LOCALE_NUMERIC
13052 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13053 PL_numeric_standard = proto_perl->Inumeric_standard;
13054 PL_numeric_local = proto_perl->Inumeric_local;
13055 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13056 #endif /* !USE_LOCALE_NUMERIC */
13058 /* utf8 character classes */
13059 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
13060 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
13061 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
13062 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
13063 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
13064 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
13065 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
13066 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
13067 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
13068 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
13069 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
13070 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
13071 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13072 PL_utf8_X_begin = sv_dup_inc(proto_perl->Iutf8_X_begin, param);
13073 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13074 PL_utf8_X_prepend = sv_dup_inc(proto_perl->Iutf8_X_prepend, param);
13075 PL_utf8_X_non_hangul = sv_dup_inc(proto_perl->Iutf8_X_non_hangul, param);
13076 PL_utf8_X_L = sv_dup_inc(proto_perl->Iutf8_X_L, param);
13077 PL_utf8_X_LV = sv_dup_inc(proto_perl->Iutf8_X_LV, param);
13078 PL_utf8_X_LVT = sv_dup_inc(proto_perl->Iutf8_X_LVT, param);
13079 PL_utf8_X_T = sv_dup_inc(proto_perl->Iutf8_X_T, param);
13080 PL_utf8_X_V = sv_dup_inc(proto_perl->Iutf8_X_V, param);
13081 PL_utf8_X_LV_LVT_V = sv_dup_inc(proto_perl->Iutf8_X_LV_LVT_V, param);
13082 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13083 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13084 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13085 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13086 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13087 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13089 /* Did the locale setup indicate UTF-8? */
13090 PL_utf8locale = proto_perl->Iutf8locale;
13091 /* Unicode features (see perlrun/-C) */
13092 PL_unicode = proto_perl->Iunicode;
13094 /* Pre-5.8 signals control */
13095 PL_signals = proto_perl->Isignals;
13097 /* times() ticks per second */
13098 PL_clocktick = proto_perl->Iclocktick;
13100 /* Recursion stopper for PerlIO_find_layer */
13101 PL_in_load_module = proto_perl->Iin_load_module;
13103 /* sort() routine */
13104 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13106 /* Not really needed/useful since the reenrant_retint is "volatile",
13107 * but do it for consistency's sake. */
13108 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13110 /* Hooks to shared SVs and locks. */
13111 PL_sharehook = proto_perl->Isharehook;
13112 PL_lockhook = proto_perl->Ilockhook;
13113 PL_unlockhook = proto_perl->Iunlockhook;
13114 PL_threadhook = proto_perl->Ithreadhook;
13115 PL_destroyhook = proto_perl->Idestroyhook;
13116 PL_signalhook = proto_perl->Isignalhook;
13118 #ifdef THREADS_HAVE_PIDS
13119 PL_ppid = proto_perl->Ippid;
13123 PL_last_swash_hv = NULL; /* reinits on demand */
13124 PL_last_swash_klen = 0;
13125 PL_last_swash_key[0]= '\0';
13126 PL_last_swash_tmps = (U8*)NULL;
13127 PL_last_swash_slen = 0;
13129 PL_glob_index = proto_perl->Iglob_index;
13130 PL_srand_called = proto_perl->Isrand_called;
13132 if (proto_perl->Ipsig_pend) {
13133 Newxz(PL_psig_pend, SIG_SIZE, int);
13136 PL_psig_pend = (int*)NULL;
13139 if (proto_perl->Ipsig_name) {
13140 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13141 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13143 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13146 PL_psig_ptr = (SV**)NULL;
13147 PL_psig_name = (SV**)NULL;
13150 /* intrpvar.h stuff */
13152 if (flags & CLONEf_COPY_STACKS) {
13153 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13154 PL_tmps_ix = proto_perl->Itmps_ix;
13155 PL_tmps_max = proto_perl->Itmps_max;
13156 PL_tmps_floor = proto_perl->Itmps_floor;
13157 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13158 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13159 PL_tmps_ix+1, param);
13161 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13162 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13163 Newxz(PL_markstack, i, I32);
13164 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13165 - proto_perl->Imarkstack);
13166 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13167 - proto_perl->Imarkstack);
13168 Copy(proto_perl->Imarkstack, PL_markstack,
13169 PL_markstack_ptr - PL_markstack + 1, I32);
13171 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13172 * NOTE: unlike the others! */
13173 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13174 PL_scopestack_max = proto_perl->Iscopestack_max;
13175 Newxz(PL_scopestack, PL_scopestack_max, I32);
13176 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13179 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13180 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13182 /* NOTE: si_dup() looks at PL_markstack */
13183 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13185 /* PL_curstack = PL_curstackinfo->si_stack; */
13186 PL_curstack = av_dup(proto_perl->Icurstack, param);
13187 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13189 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13190 PL_stack_base = AvARRAY(PL_curstack);
13191 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13192 - proto_perl->Istack_base);
13193 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13195 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13196 * NOTE: unlike the others! */
13197 PL_savestack_ix = proto_perl->Isavestack_ix;
13198 PL_savestack_max = proto_perl->Isavestack_max;
13199 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13200 PL_savestack = ss_dup(proto_perl, param);
13204 ENTER; /* perl_destruct() wants to LEAVE; */
13207 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13208 PL_top_env = &PL_start_env;
13210 PL_op = proto_perl->Iop;
13213 PL_Xpv = (XPV*)NULL;
13214 my_perl->Ina = proto_perl->Ina;
13216 PL_statbuf = proto_perl->Istatbuf;
13217 PL_statcache = proto_perl->Istatcache;
13218 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13219 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13221 PL_timesbuf = proto_perl->Itimesbuf;
13224 PL_tainted = proto_perl->Itainted;
13225 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13226 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13227 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13228 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13229 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13230 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13231 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13232 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13234 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13235 PL_restartop = proto_perl->Irestartop;
13236 PL_in_eval = proto_perl->Iin_eval;
13237 PL_delaymagic = proto_perl->Idelaymagic;
13238 PL_phase = proto_perl->Iphase;
13239 PL_localizing = proto_perl->Ilocalizing;
13241 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13242 PL_hv_fetch_ent_mh = NULL;
13243 PL_modcount = proto_perl->Imodcount;
13244 PL_lastgotoprobe = NULL;
13245 PL_dumpindent = proto_perl->Idumpindent;
13247 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13248 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
13249 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13250 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13251 PL_efloatbuf = NULL; /* reinits on demand */
13252 PL_efloatsize = 0; /* reinits on demand */
13256 PL_screamfirst = NULL;
13257 PL_screamnext = NULL;
13258 PL_maxscream = -1; /* reinits on demand */
13259 PL_lastscream = NULL;
13262 PL_regdummy = proto_perl->Iregdummy;
13263 PL_colorset = 0; /* reinits PL_colors[] */
13264 /*PL_colors[6] = {0,0,0,0,0,0};*/
13268 /* Pluggable optimizer */
13269 PL_peepp = proto_perl->Ipeepp;
13270 PL_rpeepp = proto_perl->Irpeepp;
13271 /* op_free() hook */
13272 PL_opfreehook = proto_perl->Iopfreehook;
13274 PL_stashcache = newHV();
13276 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13277 proto_perl->Iwatchaddr);
13278 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13279 if (PL_debug && PL_watchaddr) {
13280 PerlIO_printf(Perl_debug_log,
13281 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13282 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13283 PTR2UV(PL_watchok));
13286 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13287 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13288 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13290 /* Call the ->CLONE method, if it exists, for each of the stashes
13291 identified by sv_dup() above.
13293 while(av_len(param->stashes) != -1) {
13294 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13295 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13296 if (cloner && GvCV(cloner)) {
13301 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13303 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13309 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13310 ptr_table_free(PL_ptr_table);
13311 PL_ptr_table = NULL;
13314 if (!(flags & CLONEf_COPY_STACKS)) {
13315 unreferenced_to_tmp_stack(param->unreferenced);
13318 SvREFCNT_dec(param->stashes);
13320 /* orphaned? eg threads->new inside BEGIN or use */
13321 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13322 SvREFCNT_inc_simple_void(PL_compcv);
13323 SAVEFREESV(PL_compcv);
13330 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13332 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13334 if (AvFILLp(unreferenced) > -1) {
13335 SV **svp = AvARRAY(unreferenced);
13336 SV **const last = svp + AvFILLp(unreferenced);
13340 if (SvREFCNT(*svp) == 1)
13342 } while (++svp <= last);
13344 EXTEND_MORTAL(count);
13345 svp = AvARRAY(unreferenced);
13348 if (SvREFCNT(*svp) == 1) {
13349 /* Our reference is the only one to this SV. This means that
13350 in this thread, the scalar effectively has a 0 reference.
13351 That doesn't work (cleanup never happens), so donate our
13352 reference to it onto the save stack. */
13353 PL_tmps_stack[++PL_tmps_ix] = *svp;
13355 /* As an optimisation, because we are already walking the
13356 entire array, instead of above doing either
13357 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13358 release our reference to the scalar, so that at the end of
13359 the array owns zero references to the scalars it happens to
13360 point to. We are effectively converting the array from
13361 AvREAL() on to AvREAL() off. This saves the av_clear()
13362 (triggered by the SvREFCNT_dec(unreferenced) below) from
13363 walking the array a second time. */
13364 SvREFCNT_dec(*svp);
13367 } while (++svp <= last);
13368 AvREAL_off(unreferenced);
13370 SvREFCNT_dec(unreferenced);
13374 Perl_clone_params_del(CLONE_PARAMS *param)
13376 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13378 PerlInterpreter *const to = param->new_perl;
13380 PerlInterpreter *const was = PERL_GET_THX;
13382 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13388 SvREFCNT_dec(param->stashes);
13389 if (param->unreferenced)
13390 unreferenced_to_tmp_stack(param->unreferenced);
13400 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13403 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13404 does a dTHX; to get the context from thread local storage.
13405 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13406 a version that passes in my_perl. */
13407 PerlInterpreter *const was = PERL_GET_THX;
13408 CLONE_PARAMS *param;
13410 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13416 /* Given that we've set the context, we can do this unshared. */
13417 Newx(param, 1, CLONE_PARAMS);
13420 param->proto_perl = from;
13421 param->new_perl = to;
13422 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13423 AvREAL_off(param->stashes);
13424 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13432 #endif /* USE_ITHREADS */
13435 =head1 Unicode Support
13437 =for apidoc sv_recode_to_utf8
13439 The encoding is assumed to be an Encode object, on entry the PV
13440 of the sv is assumed to be octets in that encoding, and the sv
13441 will be converted into Unicode (and UTF-8).
13443 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13444 is not a reference, nothing is done to the sv. If the encoding is not
13445 an C<Encode::XS> Encoding object, bad things will happen.
13446 (See F<lib/encoding.pm> and L<Encode>).
13448 The PV of the sv is returned.
13453 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13457 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13459 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13473 Passing sv_yes is wrong - it needs to be or'ed set of constants
13474 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13475 remove converted chars from source.
13477 Both will default the value - let them.
13479 XPUSHs(&PL_sv_yes);
13482 call_method("decode", G_SCALAR);
13486 s = SvPV_const(uni, len);
13487 if (s != SvPVX_const(sv)) {
13488 SvGROW(sv, len + 1);
13489 Move(s, SvPVX(sv), len + 1, char);
13490 SvCUR_set(sv, len);
13497 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13501 =for apidoc sv_cat_decode
13503 The encoding is assumed to be an Encode object, the PV of the ssv is
13504 assumed to be octets in that encoding and decoding the input starts
13505 from the position which (PV + *offset) pointed to. The dsv will be
13506 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13507 when the string tstr appears in decoding output or the input ends on
13508 the PV of the ssv. The value which the offset points will be modified
13509 to the last input position on the ssv.
13511 Returns TRUE if the terminator was found, else returns FALSE.
13516 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13517 SV *ssv, int *offset, char *tstr, int tlen)
13522 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13524 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
13535 offsv = newSViv(*offset);
13537 mXPUSHp(tstr, tlen);
13539 call_method("cat_decode", G_SCALAR);
13541 ret = SvTRUE(TOPs);
13542 *offset = SvIV(offsv);
13548 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
13553 /* ---------------------------------------------------------------------
13555 * support functions for report_uninit()
13558 /* the maxiumum size of array or hash where we will scan looking
13559 * for the undefined element that triggered the warning */
13561 #define FUV_MAX_SEARCH_SIZE 1000
13563 /* Look for an entry in the hash whose value has the same SV as val;
13564 * If so, return a mortal copy of the key. */
13567 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
13570 register HE **array;
13573 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
13575 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
13576 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
13579 array = HvARRAY(hv);
13581 for (i=HvMAX(hv); i>0; i--) {
13582 register HE *entry;
13583 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
13584 if (HeVAL(entry) != val)
13586 if ( HeVAL(entry) == &PL_sv_undef ||
13587 HeVAL(entry) == &PL_sv_placeholder)
13591 if (HeKLEN(entry) == HEf_SVKEY)
13592 return sv_mortalcopy(HeKEY_sv(entry));
13593 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
13599 /* Look for an entry in the array whose value has the same SV as val;
13600 * If so, return the index, otherwise return -1. */
13603 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
13607 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
13609 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
13610 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
13613 if (val != &PL_sv_undef) {
13614 SV ** const svp = AvARRAY(av);
13617 for (i=AvFILLp(av); i>=0; i--)
13624 /* S_varname(): return the name of a variable, optionally with a subscript.
13625 * If gv is non-zero, use the name of that global, along with gvtype (one
13626 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
13627 * targ. Depending on the value of the subscript_type flag, return:
13630 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
13631 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
13632 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
13633 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
13636 S_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
13637 const SV *const keyname, I32 aindex, int subscript_type)
13640 SV * const name = sv_newmortal();
13643 buffer[0] = gvtype;
13646 /* as gv_fullname4(), but add literal '^' for $^FOO names */
13648 gv_fullname4(name, gv, buffer, 0);
13650 if ((unsigned int)SvPVX(name)[1] <= 26) {
13652 buffer[1] = SvPVX(name)[1] + 'A' - 1;
13654 /* Swap the 1 unprintable control character for the 2 byte pretty
13655 version - ie substr($name, 1, 1) = $buffer; */
13656 sv_insert(name, 1, 1, buffer, 2);
13660 CV * const cv = find_runcv(NULL);
13664 if (!cv || !CvPADLIST(cv))
13666 av = MUTABLE_AV((*av_fetch(CvPADLIST(cv), 0, FALSE)));
13667 sv = *av_fetch(av, targ, FALSE);
13668 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
13671 if (subscript_type == FUV_SUBSCRIPT_HASH) {
13672 SV * const sv = newSV(0);
13673 *SvPVX(name) = '$';
13674 Perl_sv_catpvf(aTHX_ name, "{%s}",
13675 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
13678 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
13679 *SvPVX(name) = '$';
13680 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
13682 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
13683 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
13684 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
13692 =for apidoc find_uninit_var
13694 Find the name of the undefined variable (if any) that caused the operator o
13695 to issue a "Use of uninitialized value" warning.
13696 If match is true, only return a name if it's value matches uninit_sv.
13697 So roughly speaking, if a unary operator (such as OP_COS) generates a
13698 warning, then following the direct child of the op may yield an
13699 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
13700 other hand, with OP_ADD there are two branches to follow, so we only print
13701 the variable name if we get an exact match.
13703 The name is returned as a mortal SV.
13705 Assumes that PL_op is the op that originally triggered the error, and that
13706 PL_comppad/PL_curpad points to the currently executing pad.
13712 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
13718 const OP *o, *o2, *kid;
13720 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
13721 uninit_sv == &PL_sv_placeholder)))
13724 switch (obase->op_type) {
13731 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
13732 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
13735 int subscript_type = FUV_SUBSCRIPT_WITHIN;
13737 if (pad) { /* @lex, %lex */
13738 sv = PAD_SVl(obase->op_targ);
13742 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
13743 /* @global, %global */
13744 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
13747 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
13749 else /* @{expr}, %{expr} */
13750 return find_uninit_var(cUNOPx(obase)->op_first,
13754 /* attempt to find a match within the aggregate */
13756 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13758 subscript_type = FUV_SUBSCRIPT_HASH;
13761 index = find_array_subscript((const AV *)sv, uninit_sv);
13763 subscript_type = FUV_SUBSCRIPT_ARRAY;
13766 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
13769 return varname(gv, hash ? '%' : '@', obase->op_targ,
13770 keysv, index, subscript_type);
13774 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
13776 return varname(NULL, '$', obase->op_targ,
13777 NULL, 0, FUV_SUBSCRIPT_NONE);
13780 gv = cGVOPx_gv(obase);
13781 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
13783 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
13786 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
13789 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
13790 if (!av || SvRMAGICAL(av))
13792 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13793 if (!svp || *svp != uninit_sv)
13796 return varname(NULL, '$', obase->op_targ,
13797 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13800 gv = cGVOPx_gv(obase);
13805 AV *const av = GvAV(gv);
13806 if (!av || SvRMAGICAL(av))
13808 svp = av_fetch(av, (I32)obase->op_private, FALSE);
13809 if (!svp || *svp != uninit_sv)
13812 return varname(gv, '$', 0,
13813 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
13818 o = cUNOPx(obase)->op_first;
13819 if (!o || o->op_type != OP_NULL ||
13820 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
13822 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
13826 if (PL_op == obase)
13827 /* $a[uninit_expr] or $h{uninit_expr} */
13828 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
13831 o = cBINOPx(obase)->op_first;
13832 kid = cBINOPx(obase)->op_last;
13834 /* get the av or hv, and optionally the gv */
13836 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
13837 sv = PAD_SV(o->op_targ);
13839 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
13840 && cUNOPo->op_first->op_type == OP_GV)
13842 gv = cGVOPx_gv(cUNOPo->op_first);
13846 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
13851 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
13852 /* index is constant */
13856 if (obase->op_type == OP_HELEM) {
13857 HE* he = hv_fetch_ent(MUTABLE_HV(sv), cSVOPx_sv(kid), 0, 0);
13858 if (!he || HeVAL(he) != uninit_sv)
13862 SV * const * const svp = av_fetch(MUTABLE_AV(sv), SvIV(cSVOPx_sv(kid)), FALSE);
13863 if (!svp || *svp != uninit_sv)
13867 if (obase->op_type == OP_HELEM)
13868 return varname(gv, '%', o->op_targ,
13869 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
13871 return varname(gv, '@', o->op_targ, NULL,
13872 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
13875 /* index is an expression;
13876 * attempt to find a match within the aggregate */
13877 if (obase->op_type == OP_HELEM) {
13878 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
13880 return varname(gv, '%', o->op_targ,
13881 keysv, 0, FUV_SUBSCRIPT_HASH);
13885 = find_array_subscript((const AV *)sv, uninit_sv);
13887 return varname(gv, '@', o->op_targ,
13888 NULL, index, FUV_SUBSCRIPT_ARRAY);
13893 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
13895 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
13900 /* only examine RHS */
13901 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
13904 o = cUNOPx(obase)->op_first;
13905 if (o->op_type == OP_PUSHMARK)
13908 if (!o->op_sibling) {
13909 /* one-arg version of open is highly magical */
13911 if (o->op_type == OP_GV) { /* open FOO; */
13913 if (match && GvSV(gv) != uninit_sv)
13915 return varname(gv, '$', 0,
13916 NULL, 0, FUV_SUBSCRIPT_NONE);
13918 /* other possibilities not handled are:
13919 * open $x; or open my $x; should return '${*$x}'
13920 * open expr; should return '$'.expr ideally
13926 /* ops where $_ may be an implicit arg */
13930 if ( !(obase->op_flags & OPf_STACKED)) {
13931 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
13932 ? PAD_SVl(obase->op_targ)
13935 sv = sv_newmortal();
13936 sv_setpvs(sv, "$_");
13945 match = 1; /* print etc can return undef on defined args */
13946 /* skip filehandle as it can't produce 'undef' warning */
13947 o = cUNOPx(obase)->op_first;
13948 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
13949 o = o->op_sibling->op_sibling;
13953 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
13955 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
13957 /* the following ops are capable of returning PL_sv_undef even for
13958 * defined arg(s) */
13977 case OP_GETPEERNAME:
14025 case OP_SMARTMATCH:
14034 /* XXX tmp hack: these two may call an XS sub, and currently
14035 XS subs don't have a SUB entry on the context stack, so CV and
14036 pad determination goes wrong, and BAD things happen. So, just
14037 don't try to determine the value under those circumstances.
14038 Need a better fix at dome point. DAPM 11/2007 */
14044 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14045 if (gv && GvSV(gv) == uninit_sv)
14046 return newSVpvs_flags("$.", SVs_TEMP);
14051 /* def-ness of rval pos() is independent of the def-ness of its arg */
14052 if ( !(obase->op_flags & OPf_MOD))
14057 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14058 return newSVpvs_flags("${$/}", SVs_TEMP);
14063 if (!(obase->op_flags & OPf_KIDS))
14065 o = cUNOPx(obase)->op_first;
14071 /* if all except one arg are constant, or have no side-effects,
14072 * or are optimized away, then it's unambiguous */
14074 for (kid=o; kid; kid = kid->op_sibling) {
14076 const OPCODE type = kid->op_type;
14077 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14078 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14079 || (type == OP_PUSHMARK)
14081 /* @$a and %$a, but not @a or %a */
14082 (type == OP_RV2AV || type == OP_RV2HV)
14083 && cUNOPx(kid)->op_first
14084 && cUNOPx(kid)->op_first->op_type != OP_GV
14089 if (o2) { /* more than one found */
14096 return find_uninit_var(o2, uninit_sv, match);
14098 /* scan all args */
14100 sv = find_uninit_var(o, uninit_sv, 1);
14112 =for apidoc report_uninit
14114 Print appropriate "Use of uninitialized variable" warning
14120 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14124 SV* varname = NULL;
14126 varname = find_uninit_var(PL_op, uninit_sv,0);
14128 sv_insert(varname, 0, 0, " ", 1);
14130 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14131 varname ? SvPV_nolen_const(varname) : "",
14132 " in ", OP_DESC(PL_op));
14135 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14141 * c-indentation-style: bsd
14142 * c-basic-offset: 4
14143 * indent-tabs-mode: t
14146 * ex: set ts=8 sts=4 sw=4 noet: