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))
71 /* ============================================================================
73 =head1 Allocation and deallocation of SVs.
75 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
76 sv, av, hv...) contains type and reference count information, and for
77 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
78 contains fields specific to each type. Some types store all they need
79 in the head, so don't have a body.
81 In all but the most memory-paranoid configurations (ex: PURIFY), heads
82 and bodies are allocated out of arenas, which by default are
83 approximately 4K chunks of memory parcelled up into N heads or bodies.
84 Sv-bodies are allocated by their sv-type, guaranteeing size
85 consistency needed to allocate safely from arrays.
87 For SV-heads, the first slot in each arena is reserved, and holds a
88 link to the next arena, some flags, and a note of the number of slots.
89 Snaked through each arena chain is a linked list of free items; when
90 this becomes empty, an extra arena is allocated and divided up into N
91 items which are threaded into the free list.
93 SV-bodies are similar, but they use arena-sets by default, which
94 separate the link and info from the arena itself, and reclaim the 1st
95 slot in the arena. SV-bodies are further described later.
97 The following global variables are associated with arenas:
99 PL_sv_arenaroot pointer to list of SV arenas
100 PL_sv_root pointer to list of free SV structures
102 PL_body_arenas head of linked-list of body arenas
103 PL_body_roots[] array of pointers to list of free bodies of svtype
104 arrays are indexed by the svtype needed
106 A few special SV heads are not allocated from an arena, but are
107 instead directly created in the interpreter structure, eg PL_sv_undef.
108 The size of arenas can be changed from the default by setting
109 PERL_ARENA_SIZE appropriately at compile time.
111 The SV arena serves the secondary purpose of allowing still-live SVs
112 to be located and destroyed during final cleanup.
114 At the lowest level, the macros new_SV() and del_SV() grab and free
115 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
116 to return the SV to the free list with error checking.) new_SV() calls
117 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
118 SVs in the free list have their SvTYPE field set to all ones.
120 At the time of very final cleanup, sv_free_arenas() is called from
121 perl_destruct() to physically free all the arenas allocated since the
122 start of the interpreter.
124 The function visit() scans the SV arenas list, and calls a specified
125 function for each SV it finds which is still live - ie which has an SvTYPE
126 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
127 following functions (specified as [function that calls visit()] / [function
128 called by visit() for each SV]):
130 sv_report_used() / do_report_used()
131 dump all remaining SVs (debugging aid)
133 sv_clean_objs() / do_clean_objs(),do_clean_named_objs(),
134 do_clean_named_io_objs(),do_curse()
135 Attempt to free all objects pointed to by RVs,
136 try to do the same for all objects indir-
137 ectly referenced by typeglobs too, and
138 then do a final sweep, cursing any
139 objects that remain. Called once from
140 perl_destruct(), prior to calling sv_clean_all()
143 sv_clean_all() / do_clean_all()
144 SvREFCNT_dec(sv) each remaining SV, possibly
145 triggering an sv_free(). It also sets the
146 SVf_BREAK flag on the SV to indicate that the
147 refcnt has been artificially lowered, and thus
148 stopping sv_free() from giving spurious warnings
149 about SVs which unexpectedly have a refcnt
150 of zero. called repeatedly from perl_destruct()
151 until there are no SVs left.
153 =head2 Arena allocator API Summary
155 Private API to rest of sv.c
159 new_XPVNV(), del_XPVGV(),
164 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
168 * ========================================================================= */
171 * "A time to plant, and a time to uproot what was planted..."
175 # define MEM_LOG_NEW_SV(sv, file, line, func) \
176 Perl_mem_log_new_sv(sv, file, line, func)
177 # define MEM_LOG_DEL_SV(sv, file, line, func) \
178 Perl_mem_log_del_sv(sv, file, line, func)
180 # define MEM_LOG_NEW_SV(sv, file, line, func) NOOP
181 # define MEM_LOG_DEL_SV(sv, file, line, func) NOOP
184 #ifdef DEBUG_LEAKING_SCALARS
185 # define FREE_SV_DEBUG_FILE(sv) STMT_START { \
186 if ((sv)->sv_debug_file) PerlMemShared_free((sv)->sv_debug_file); \
188 # define DEBUG_SV_SERIAL(sv) \
189 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) del_SV\n", \
190 PTR2UV(sv), (long)(sv)->sv_debug_serial))
192 # define FREE_SV_DEBUG_FILE(sv)
193 # define DEBUG_SV_SERIAL(sv) NOOP
197 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
198 # define SvARENA_CHAIN_SET(sv,val) (sv)->sv_u.svu_rv = MUTABLE_SV((val))
199 /* Whilst I'd love to do this, it seems that things like to check on
201 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
203 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
204 PoisonNew(&SvREFCNT(sv), 1, U32)
206 # define SvARENA_CHAIN(sv) SvANY(sv)
207 # define SvARENA_CHAIN_SET(sv,val) SvANY(sv) = (void *)(val)
208 # define POSION_SV_HEAD(sv)
211 /* Mark an SV head as unused, and add to free list.
213 * If SVf_BREAK is set, skip adding it to the free list, as this SV had
214 * its refcount artificially decremented during global destruction, so
215 * there may be dangling pointers to it. The last thing we want in that
216 * case is for it to be reused. */
218 #define plant_SV(p) \
220 const U32 old_flags = SvFLAGS(p); \
221 MEM_LOG_DEL_SV(p, __FILE__, __LINE__, FUNCTION__); \
222 DEBUG_SV_SERIAL(p); \
223 FREE_SV_DEBUG_FILE(p); \
225 SvFLAGS(p) = SVTYPEMASK; \
226 if (!(old_flags & SVf_BREAK)) { \
227 SvARENA_CHAIN_SET(p, PL_sv_root); \
233 #define uproot_SV(p) \
236 PL_sv_root = MUTABLE_SV(SvARENA_CHAIN(p)); \
241 /* make some more SVs by adding another arena */
248 char *chunk; /* must use New here to match call to */
249 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
250 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
260 S_new_SV(pTHX_ const char *file, int line, const char *func)
267 sv = S_more_sv(aTHX);
271 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
272 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_parent = NULL;
280 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
282 sv->sv_debug_serial = PL_sv_serial++;
284 MEM_LOG_NEW_SV(sv, file, line, func);
285 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) new_SV (from %s:%d [%s])\n",
286 PTR2UV(sv), (long)sv->sv_debug_serial, file, line, func));
290 # define new_SV(p) (p)=S_new_SV(aTHX_ __FILE__, __LINE__, FUNCTION__)
298 (p) = S_more_sv(aTHX); \
302 MEM_LOG_NEW_SV(p, __FILE__, __LINE__, FUNCTION__); \
307 /* del_SV(): return an empty SV head to the free list */
320 S_del_sv(pTHX_ SV *p)
324 PERL_ARGS_ASSERT_DEL_SV;
329 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
330 const SV * const sv = sva + 1;
331 const SV * const svend = &sva[SvREFCNT(sva)];
332 if (p >= sv && p < svend) {
338 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
339 "Attempt to free non-arena SV: 0x%"UVxf
340 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
347 #else /* ! DEBUGGING */
349 #define del_SV(p) plant_SV(p)
351 #endif /* DEBUGGING */
355 =head1 SV Manipulation Functions
357 =for apidoc sv_add_arena
359 Given a chunk of memory, link it to the head of the list of arenas,
360 and split it into a list of free SVs.
366 S_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
369 SV *const sva = MUTABLE_SV(ptr);
373 PERL_ARGS_ASSERT_SV_ADD_ARENA;
375 /* The first SV in an arena isn't an SV. */
376 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
377 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
378 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
380 PL_sv_arenaroot = sva;
381 PL_sv_root = sva + 1;
383 svend = &sva[SvREFCNT(sva) - 1];
386 SvARENA_CHAIN_SET(sv, (sv + 1));
390 /* Must always set typemask because it's always checked in on cleanup
391 when the arenas are walked looking for objects. */
392 SvFLAGS(sv) = SVTYPEMASK;
395 SvARENA_CHAIN_SET(sv, 0);
399 SvFLAGS(sv) = SVTYPEMASK;
402 /* visit(): call the named function for each non-free SV in the arenas
403 * whose flags field matches the flags/mask args. */
406 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
412 PERL_ARGS_ASSERT_VISIT;
414 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
415 const SV * const svend = &sva[SvREFCNT(sva)];
417 for (sv = sva + 1; sv < svend; ++sv) {
418 if (SvTYPE(sv) != (svtype)SVTYPEMASK
419 && (sv->sv_flags & mask) == flags
432 /* called by sv_report_used() for each live SV */
435 do_report_used(pTHX_ SV *const sv)
437 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
438 PerlIO_printf(Perl_debug_log, "****\n");
445 =for apidoc sv_report_used
447 Dump the contents of all SVs not yet freed (debugging aid).
453 Perl_sv_report_used(pTHX)
456 visit(do_report_used, 0, 0);
462 /* called by sv_clean_objs() for each live SV */
465 do_clean_objs(pTHX_ SV *const ref)
470 SV * const target = SvRV(ref);
471 if (SvOBJECT(target)) {
472 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
473 if (SvWEAKREF(ref)) {
474 sv_del_backref(target, ref);
480 SvREFCNT_dec_NN(target);
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)));
508 SvREFCNT_dec_NN(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)));
514 SvREFCNT_dec_NN(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)));
520 SvREFCNT_dec_NN(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)));
526 SvREFCNT_dec_NN(obj);
528 SvREFCNT_dec_NN(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)));
549 SvREFCNT_dec_NN(obj);
551 SvREFCNT_dec_NN(sv); /* undo the inc above */
554 /* Void wrapper to pass to visit() */
556 do_curse(pTHX_ SV * const sv) {
557 if ((PL_stderrgv && GvGP(PL_stderrgv) && (SV*)GvIO(PL_stderrgv) == sv)
558 || (PL_defoutgv && GvGP(PL_defoutgv) && (SV*)GvIO(PL_defoutgv) == sv))
564 =for apidoc sv_clean_objs
566 Attempt to destroy all objects not yet freed.
572 Perl_sv_clean_objs(pTHX)
576 PL_in_clean_objs = TRUE;
577 visit(do_clean_objs, SVf_ROK, SVf_ROK);
578 /* Some barnacles may yet remain, clinging to typeglobs.
579 * Run the non-IO destructors first: they may want to output
580 * error messages, close files etc */
581 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
582 visit(do_clean_named_io_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
583 /* And if there are some very tenacious barnacles clinging to arrays,
584 closures, or what have you.... */
585 visit(do_curse, SVs_OBJECT, SVs_OBJECT);
586 olddef = PL_defoutgv;
587 PL_defoutgv = NULL; /* disable skip of PL_defoutgv */
588 if (olddef && isGV_with_GP(olddef))
589 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olddef));
590 olderr = PL_stderrgv;
591 PL_stderrgv = NULL; /* disable skip of PL_stderrgv */
592 if (olderr && isGV_with_GP(olderr))
593 do_clean_named_io_objs(aTHX_ MUTABLE_SV(olderr));
594 SvREFCNT_dec(olddef);
595 PL_in_clean_objs = FALSE;
598 /* called by sv_clean_all() for each live SV */
601 do_clean_all(pTHX_ SV *const sv)
604 if (sv == (const SV *) PL_fdpid || sv == (const SV *)PL_strtab) {
605 /* don't clean pid table and strtab */
608 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
609 SvFLAGS(sv) |= SVf_BREAK;
614 =for apidoc sv_clean_all
616 Decrement the refcnt of each remaining SV, possibly triggering a
617 cleanup. This function may have to be called multiple times to free
618 SVs which are in complex self-referential hierarchies.
624 Perl_sv_clean_all(pTHX)
628 PL_in_clean_all = TRUE;
629 cleaned = visit(do_clean_all, 0,0);
634 ARENASETS: a meta-arena implementation which separates arena-info
635 into struct arena_set, which contains an array of struct
636 arena_descs, each holding info for a single arena. By separating
637 the meta-info from the arena, we recover the 1st slot, formerly
638 borrowed for list management. The arena_set is about the size of an
639 arena, avoiding the needless malloc overhead of a naive linked-list.
641 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
642 memory in the last arena-set (1/2 on average). In trade, we get
643 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
644 smaller types). The recovery of the wasted space allows use of
645 small arenas for large, rare body types, by changing array* fields
646 in body_details_by_type[] below.
649 char *arena; /* the raw storage, allocated aligned */
650 size_t size; /* its size ~4k typ */
651 svtype utype; /* bodytype stored in arena */
656 /* Get the maximum number of elements in set[] such that struct arena_set
657 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
658 therefore likely to be 1 aligned memory page. */
660 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
661 - 2 * sizeof(int)) / sizeof (struct arena_desc))
664 struct arena_set* next;
665 unsigned int set_size; /* ie ARENAS_PER_SET */
666 unsigned int curr; /* index of next available arena-desc */
667 struct arena_desc set[ARENAS_PER_SET];
671 =for apidoc sv_free_arenas
673 Deallocate the memory used by all arenas. Note that all the individual SV
674 heads and bodies within the arenas must already have been freed.
679 Perl_sv_free_arenas(pTHX)
686 /* Free arenas here, but be careful about fake ones. (We assume
687 contiguity of the fake ones with the corresponding real ones.) */
689 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
690 svanext = MUTABLE_SV(SvANY(sva));
691 while (svanext && SvFAKE(svanext))
692 svanext = MUTABLE_SV(SvANY(svanext));
699 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
702 struct arena_set *current = aroot;
705 assert(aroot->set[i].arena);
706 Safefree(aroot->set[i].arena);
714 i = PERL_ARENA_ROOTS_SIZE;
716 PL_body_roots[i] = 0;
723 Here are mid-level routines that manage the allocation of bodies out
724 of the various arenas. There are 5 kinds of arenas:
726 1. SV-head arenas, which are discussed and handled above
727 2. regular body arenas
728 3. arenas for reduced-size bodies
731 Arena types 2 & 3 are chained by body-type off an array of
732 arena-root pointers, which is indexed by svtype. Some of the
733 larger/less used body types are malloced singly, since a large
734 unused block of them is wasteful. Also, several svtypes dont have
735 bodies; the data fits into the sv-head itself. The arena-root
736 pointer thus has a few unused root-pointers (which may be hijacked
737 later for arena types 4,5)
739 3 differs from 2 as an optimization; some body types have several
740 unused fields in the front of the structure (which are kept in-place
741 for consistency). These bodies can be allocated in smaller chunks,
742 because the leading fields arent accessed. Pointers to such bodies
743 are decremented to point at the unused 'ghost' memory, knowing that
744 the pointers are used with offsets to the real memory.
747 =head1 SV-Body Allocation
749 Allocation of SV-bodies is similar to SV-heads, differing as follows;
750 the allocation mechanism is used for many body types, so is somewhat
751 more complicated, it uses arena-sets, and has no need for still-live
754 At the outermost level, (new|del)_X*V macros return bodies of the
755 appropriate type. These macros call either (new|del)_body_type or
756 (new|del)_body_allocated macro pairs, depending on specifics of the
757 type. Most body types use the former pair, the latter pair is used to
758 allocate body types with "ghost fields".
760 "ghost fields" are fields that are unused in certain types, and
761 consequently don't need to actually exist. They are declared because
762 they're part of a "base type", which allows use of functions as
763 methods. The simplest examples are AVs and HVs, 2 aggregate types
764 which don't use the fields which support SCALAR semantics.
766 For these types, the arenas are carved up into appropriately sized
767 chunks, we thus avoid wasted memory for those unaccessed members.
768 When bodies are allocated, we adjust the pointer back in memory by the
769 size of the part not allocated, so it's as if we allocated the full
770 structure. (But things will all go boom if you write to the part that
771 is "not there", because you'll be overwriting the last members of the
772 preceding structure in memory.)
774 We calculate the correction using the STRUCT_OFFSET macro on the first
775 member present. If the allocated structure is smaller (no initial NV
776 actually allocated) then the net effect is to subtract the size of the NV
777 from the pointer, to return a new pointer as if an initial NV were actually
778 allocated. (We were using structures named *_allocated for this, but
779 this turned out to be a subtle bug, because a structure without an NV
780 could have a lower alignment constraint, but the compiler is allowed to
781 optimised accesses based on the alignment constraint of the actual pointer
782 to the full structure, for example, using a single 64 bit load instruction
783 because it "knows" that two adjacent 32 bit members will be 8-byte aligned.)
785 This is the same trick as was used for NV and IV bodies. Ironically it
786 doesn't need to be used for NV bodies any more, because NV is now at
787 the start of the structure. IV bodies don't need it either, because
788 they are no longer allocated.
790 In turn, the new_body_* allocators call S_new_body(), which invokes
791 new_body_inline macro, which takes a lock, and takes a body off the
792 linked list at PL_body_roots[sv_type], calling Perl_more_bodies() if
793 necessary to refresh an empty list. Then the lock is released, and
794 the body is returned.
796 Perl_more_bodies allocates a new arena, and carves it up into an array of N
797 bodies, which it strings into a linked list. It looks up arena-size
798 and body-size from the body_details table described below, thus
799 supporting the multiple body-types.
801 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
802 the (new|del)_X*V macros are mapped directly to malloc/free.
804 For each sv-type, struct body_details bodies_by_type[] carries
805 parameters which control these aspects of SV handling:
807 Arena_size determines whether arenas are used for this body type, and if
808 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
809 zero, forcing individual mallocs and frees.
811 Body_size determines how big a body is, and therefore how many fit into
812 each arena. Offset carries the body-pointer adjustment needed for
813 "ghost fields", and is used in *_allocated macros.
815 But its main purpose is to parameterize info needed in
816 Perl_sv_upgrade(). The info here dramatically simplifies the function
817 vs the implementation in 5.8.8, making it table-driven. All fields
818 are used for this, except for arena_size.
820 For the sv-types that have no bodies, arenas are not used, so those
821 PL_body_roots[sv_type] are unused, and can be overloaded. In
822 something of a special case, SVt_NULL is borrowed for HE arenas;
823 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
824 bodies_by_type[SVt_NULL] slot is not used, as the table is not
829 struct body_details {
830 U8 body_size; /* Size to allocate */
831 U8 copy; /* Size of structure to copy (may be shorter) */
833 unsigned int type : 4; /* We have space for a sanity check. */
834 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
835 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
836 unsigned int arena : 1; /* Allocated from an arena */
837 size_t arena_size; /* Size of arena to allocate */
845 /* With -DPURFIY we allocate everything directly, and don't use arenas.
846 This seems a rather elegant way to simplify some of the code below. */
847 #define HASARENA FALSE
849 #define HASARENA TRUE
851 #define NOARENA FALSE
853 /* Size the arenas to exactly fit a given number of bodies. A count
854 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
855 simplifying the default. If count > 0, the arena is sized to fit
856 only that many bodies, allowing arenas to be used for large, rare
857 bodies (XPVFM, XPVIO) without undue waste. The arena size is
858 limited by PERL_ARENA_SIZE, so we can safely oversize the
861 #define FIT_ARENA0(body_size) \
862 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
863 #define FIT_ARENAn(count,body_size) \
864 ( count * body_size <= PERL_ARENA_SIZE) \
865 ? count * body_size \
866 : FIT_ARENA0 (body_size)
867 #define FIT_ARENA(count,body_size) \
869 ? FIT_ARENAn (count, body_size) \
870 : FIT_ARENA0 (body_size)
872 /* Calculate the length to copy. Specifically work out the length less any
873 final padding the compiler needed to add. See the comment in sv_upgrade
874 for why copying the padding proved to be a bug. */
876 #define copy_length(type, last_member) \
877 STRUCT_OFFSET(type, last_member) \
878 + sizeof (((type*)SvANY((const SV *)0))->last_member)
880 static const struct body_details bodies_by_type[] = {
881 /* HEs use this offset for their arena. */
882 { 0, 0, 0, SVt_NULL, FALSE, NONV, NOARENA, 0 },
884 /* The bind placeholder pretends to be an RV for now.
885 Also it's marked as "can't upgrade" to stop anyone using it before it's
887 { 0, 0, 0, SVt_DUMMY, TRUE, NONV, NOARENA, 0 },
889 /* IVs are in the head, so the allocation size is 0. */
891 sizeof(IV), /* This is used to copy out the IV body. */
892 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
893 NOARENA /* IVS don't need an arena */, 0
896 { sizeof(NV), sizeof(NV),
897 STRUCT_OFFSET(XPVNV, xnv_u),
898 SVt_NV, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(NV)) },
900 { sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur),
901 copy_length(XPV, xpv_len) - STRUCT_OFFSET(XPV, xpv_cur),
902 + STRUCT_OFFSET(XPV, xpv_cur),
903 SVt_PV, FALSE, NONV, HASARENA,
904 FIT_ARENA(0, sizeof(XPV) - STRUCT_OFFSET(XPV, xpv_cur)) },
906 { sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur),
907 copy_length(XPVIV, xiv_u) - STRUCT_OFFSET(XPV, xpv_cur),
908 + STRUCT_OFFSET(XPV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA,
910 FIT_ARENA(0, sizeof(XPVIV) - STRUCT_OFFSET(XPV, xpv_cur)) },
912 { sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur),
913 copy_length(XPVNV, xnv_u) - STRUCT_OFFSET(XPV, xpv_cur),
914 + STRUCT_OFFSET(XPV, xpv_cur),
915 SVt_PVNV, FALSE, HADNV, HASARENA,
916 FIT_ARENA(0, sizeof(XPVNV) - STRUCT_OFFSET(XPV, xpv_cur)) },
918 { sizeof(XPVMG), copy_length(XPVMG, xnv_u), 0, SVt_PVMG, FALSE, HADNV,
919 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
924 SVt_REGEXP, TRUE, NONV, HASARENA,
925 FIT_ARENA(0, sizeof(regexp))
928 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
935 copy_length(XPVAV, xav_alloc),
937 SVt_PVAV, TRUE, NONV, HASARENA,
938 FIT_ARENA(0, sizeof(XPVAV)) },
941 copy_length(XPVHV, xhv_max),
943 SVt_PVHV, TRUE, NONV, HASARENA,
944 FIT_ARENA(0, sizeof(XPVHV)) },
949 SVt_PVCV, TRUE, NONV, HASARENA,
950 FIT_ARENA(0, sizeof(XPVCV)) },
955 SVt_PVFM, TRUE, NONV, NOARENA,
956 FIT_ARENA(20, sizeof(XPVFM)) },
961 SVt_PVIO, TRUE, NONV, HASARENA,
962 FIT_ARENA(24, sizeof(XPVIO)) },
965 #define new_body_allocated(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ sv_type) \
967 - bodies_by_type[sv_type].offset)
969 /* return a thing to the free list */
971 #define del_body(thing, root) \
973 void ** const thing_copy = (void **)thing; \
974 *thing_copy = *root; \
975 *root = (void*)thing_copy; \
980 #define new_XNV() safemalloc(sizeof(XPVNV))
981 #define new_XPVNV() safemalloc(sizeof(XPVNV))
982 #define new_XPVMG() safemalloc(sizeof(XPVMG))
984 #define del_XPVGV(p) safefree(p)
988 #define new_XNV() new_body_allocated(SVt_NV)
989 #define new_XPVNV() new_body_allocated(SVt_PVNV)
990 #define new_XPVMG() new_body_allocated(SVt_PVMG)
992 #define del_XPVGV(p) del_body(p + bodies_by_type[SVt_PVGV].offset, \
993 &PL_body_roots[SVt_PVGV])
997 /* no arena for you! */
999 #define new_NOARENA(details) \
1000 safemalloc((details)->body_size + (details)->offset)
1001 #define new_NOARENAZ(details) \
1002 safecalloc((details)->body_size + (details)->offset, 1)
1005 Perl_more_bodies (pTHX_ const svtype sv_type, const size_t body_size,
1006 const size_t arena_size)
1009 void ** const root = &PL_body_roots[sv_type];
1010 struct arena_desc *adesc;
1011 struct arena_set *aroot = (struct arena_set *) PL_body_arenas;
1015 const size_t good_arena_size = Perl_malloc_good_size(arena_size);
1016 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1017 static bool done_sanity_check;
1019 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1020 * variables like done_sanity_check. */
1021 if (!done_sanity_check) {
1022 unsigned int i = SVt_LAST;
1024 done_sanity_check = TRUE;
1027 assert (bodies_by_type[i].type == i);
1033 /* may need new arena-set to hold new arena */
1034 if (!aroot || aroot->curr >= aroot->set_size) {
1035 struct arena_set *newroot;
1036 Newxz(newroot, 1, struct arena_set);
1037 newroot->set_size = ARENAS_PER_SET;
1038 newroot->next = aroot;
1040 PL_body_arenas = (void *) newroot;
1041 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
1044 /* ok, now have arena-set with at least 1 empty/available arena-desc */
1045 curr = aroot->curr++;
1046 adesc = &(aroot->set[curr]);
1047 assert(!adesc->arena);
1049 Newx(adesc->arena, good_arena_size, char);
1050 adesc->size = good_arena_size;
1051 adesc->utype = sv_type;
1052 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
1053 curr, (void*)adesc->arena, (UV)good_arena_size));
1055 start = (char *) adesc->arena;
1057 /* Get the address of the byte after the end of the last body we can fit.
1058 Remember, this is integer division: */
1059 end = start + good_arena_size / body_size * body_size;
1061 /* computed count doesn't reflect the 1st slot reservation */
1062 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1063 DEBUG_m(PerlIO_printf(Perl_debug_log,
1064 "arena %p end %p arena-size %d (from %d) type %d "
1066 (void*)start, (void*)end, (int)good_arena_size,
1067 (int)arena_size, sv_type, (int)body_size,
1068 (int)good_arena_size / (int)body_size));
1070 DEBUG_m(PerlIO_printf(Perl_debug_log,
1071 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (void*)start, (void*)end,
1073 (int)arena_size, sv_type, (int)body_size,
1074 (int)good_arena_size / (int)body_size));
1076 *root = (void *)start;
1079 /* Where the next body would start: */
1080 char * const next = start + body_size;
1083 /* This is the last body: */
1084 assert(next == end);
1086 *(void **)start = 0;
1090 *(void**) start = (void *)next;
1095 /* grab a new thing from the free list, allocating more if necessary.
1096 The inline version is used for speed in hot routines, and the
1097 function using it serves the rest (unless PURIFY).
1099 #define new_body_inline(xpv, sv_type) \
1101 void ** const r3wt = &PL_body_roots[sv_type]; \
1102 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1103 ? *((void **)(r3wt)) : Perl_more_bodies(aTHX_ sv_type, \
1104 bodies_by_type[sv_type].body_size,\
1105 bodies_by_type[sv_type].arena_size)); \
1106 *(r3wt) = *(void**)(xpv); \
1112 S_new_body(pTHX_ const svtype sv_type)
1116 new_body_inline(xpv, sv_type);
1122 static const struct body_details fake_rv =
1123 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1126 =for apidoc sv_upgrade
1128 Upgrade an SV to a more complex form. Generally adds a new body type to the
1129 SV, then copies across as much information as possible from the old body.
1130 It croaks if the SV is already in a more complex form than requested. You
1131 generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
1132 before calling C<sv_upgrade>, and hence does not croak. See also
1139 Perl_sv_upgrade(pTHX_ SV *const sv, svtype new_type)
1144 const svtype old_type = SvTYPE(sv);
1145 const struct body_details *new_type_details;
1146 const struct body_details *old_type_details
1147 = bodies_by_type + old_type;
1148 SV *referant = NULL;
1150 PERL_ARGS_ASSERT_SV_UPGRADE;
1152 if (old_type == new_type)
1155 /* This clause was purposefully added ahead of the early return above to
1156 the shared string hackery for (sort {$a <=> $b} keys %hash), with the
1157 inference by Nick I-S that it would fix other troublesome cases. See
1158 changes 7162, 7163 (f130fd4589cf5fbb24149cd4db4137c8326f49c1 and parent)
1160 Given that shared hash key scalars are no longer PVIV, but PV, there is
1161 no longer need to unshare so as to free up the IVX slot for its proper
1162 purpose. So it's safe to move the early return earlier. */
1164 if (new_type > SVt_PVMG && SvIsCOW(sv)) {
1165 sv_force_normal_flags(sv, 0);
1168 old_body = SvANY(sv);
1170 /* Copying structures onto other structures that have been neatly zeroed
1171 has a subtle gotcha. Consider XPVMG
1173 +------+------+------+------+------+-------+-------+
1174 | NV | CUR | LEN | IV | MAGIC | STASH |
1175 +------+------+------+------+------+-------+-------+
1176 0 4 8 12 16 20 24 28
1178 where NVs are aligned to 8 bytes, so that sizeof that structure is
1179 actually 32 bytes long, with 4 bytes of padding at the end:
1181 +------+------+------+------+------+-------+-------+------+
1182 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1183 +------+------+------+------+------+-------+-------+------+
1184 0 4 8 12 16 20 24 28 32
1186 so what happens if you allocate memory for this structure:
1188 +------+------+------+------+------+-------+-------+------+------+...
1189 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1190 +------+------+------+------+------+-------+-------+------+------+...
1191 0 4 8 12 16 20 24 28 32 36
1193 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1194 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1195 started out as zero once, but it's quite possible that it isn't. So now,
1196 rather than a nicely zeroed GP, you have it pointing somewhere random.
1199 (In fact, GP ends up pointing at a previous GP structure, because the
1200 principle cause of the padding in XPVMG getting garbage is a copy of
1201 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1202 this happens to be moot because XPVGV has been re-ordered, with GP
1203 no longer after STASH)
1205 So we are careful and work out the size of used parts of all the
1213 referant = SvRV(sv);
1214 old_type_details = &fake_rv;
1215 if (new_type == SVt_NV)
1216 new_type = SVt_PVNV;
1218 if (new_type < SVt_PVIV) {
1219 new_type = (new_type == SVt_NV)
1220 ? SVt_PVNV : SVt_PVIV;
1225 if (new_type < SVt_PVNV) {
1226 new_type = SVt_PVNV;
1230 assert(new_type > SVt_PV);
1231 assert(SVt_IV < SVt_PV);
1232 assert(SVt_NV < SVt_PV);
1239 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1240 there's no way that it can be safely upgraded, because perl.c
1241 expects to Safefree(SvANY(PL_mess_sv)) */
1242 assert(sv != PL_mess_sv);
1243 /* This flag bit is used to mean other things in other scalar types.
1244 Given that it only has meaning inside the pad, it shouldn't be set
1245 on anything that can get upgraded. */
1246 assert(!SvPAD_TYPED(sv));
1249 if (UNLIKELY(old_type_details->cant_upgrade))
1250 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1251 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1254 if (UNLIKELY(old_type > new_type))
1255 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1256 (int)old_type, (int)new_type);
1258 new_type_details = bodies_by_type + new_type;
1260 SvFLAGS(sv) &= ~SVTYPEMASK;
1261 SvFLAGS(sv) |= new_type;
1263 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1264 the return statements above will have triggered. */
1265 assert (new_type != SVt_NULL);
1268 assert(old_type == SVt_NULL);
1269 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1273 assert(old_type == SVt_NULL);
1274 SvANY(sv) = new_XNV();
1279 assert(new_type_details->body_size);
1282 assert(new_type_details->arena);
1283 assert(new_type_details->arena_size);
1284 /* This points to the start of the allocated area. */
1285 new_body_inline(new_body, new_type);
1286 Zero(new_body, new_type_details->body_size, char);
1287 new_body = ((char *)new_body) - new_type_details->offset;
1289 /* We always allocated the full length item with PURIFY. To do this
1290 we fake things so that arena is false for all 16 types.. */
1291 new_body = new_NOARENAZ(new_type_details);
1293 SvANY(sv) = new_body;
1294 if (new_type == SVt_PVAV) {
1298 if (old_type_details->body_size) {
1301 /* It will have been zeroed when the new body was allocated.
1302 Lets not write to it, in case it confuses a write-back
1308 #ifndef NODEFAULT_SHAREKEYS
1309 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1311 /* start with PERL_HASH_DEFAULT_HvMAX+1 buckets: */
1312 HvMAX(sv) = PERL_HASH_DEFAULT_HvMAX;
1315 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1316 The target created by newSVrv also is, and it can have magic.
1317 However, it never has SvPVX set.
1319 if (old_type == SVt_IV) {
1321 } else if (old_type >= SVt_PV) {
1322 assert(SvPVX_const(sv) == 0);
1325 if (old_type >= SVt_PVMG) {
1326 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1327 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1329 sv->sv_u.svu_array = NULL; /* or svu_hash */
1334 /* XXX Is this still needed? Was it ever needed? Surely as there is
1335 no route from NV to PVIV, NOK can never be true */
1336 assert(!SvNOKp(sv));
1348 assert(new_type_details->body_size);
1349 /* We always allocated the full length item with PURIFY. To do this
1350 we fake things so that arena is false for all 16 types.. */
1351 if(new_type_details->arena) {
1352 /* This points to the start of the allocated area. */
1353 new_body_inline(new_body, new_type);
1354 Zero(new_body, new_type_details->body_size, char);
1355 new_body = ((char *)new_body) - new_type_details->offset;
1357 new_body = new_NOARENAZ(new_type_details);
1359 SvANY(sv) = new_body;
1361 if (old_type_details->copy) {
1362 /* There is now the potential for an upgrade from something without
1363 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1364 int offset = old_type_details->offset;
1365 int length = old_type_details->copy;
1367 if (new_type_details->offset > old_type_details->offset) {
1368 const int difference
1369 = new_type_details->offset - old_type_details->offset;
1370 offset += difference;
1371 length -= difference;
1373 assert (length >= 0);
1375 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1379 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1380 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1381 * correct 0.0 for us. Otherwise, if the old body didn't have an
1382 * NV slot, but the new one does, then we need to initialise the
1383 * freshly created NV slot with whatever the correct bit pattern is
1385 if (old_type_details->zero_nv && !new_type_details->zero_nv
1386 && !isGV_with_GP(sv))
1390 if (UNLIKELY(new_type == SVt_PVIO)) {
1391 IO * const io = MUTABLE_IO(sv);
1392 GV *iogv = gv_fetchpvs("IO::File::", GV_ADD, SVt_PVHV);
1395 /* Clear the stashcache because a new IO could overrule a package
1397 DEBUG_o(Perl_deb(aTHX_ "sv_upgrade clearing PL_stashcache\n"));
1398 hv_clear(PL_stashcache);
1400 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1401 IoPAGE_LEN(sv) = 60;
1403 if (UNLIKELY(new_type == SVt_REGEXP))
1404 sv->sv_u.svu_rx = (regexp *)new_body;
1405 else if (old_type < SVt_PV) {
1406 /* referant will be NULL unless the old type was SVt_IV emulating
1408 sv->sv_u.svu_rv = referant;
1412 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1413 (unsigned long)new_type);
1416 if (old_type > SVt_IV) {
1420 /* Note that there is an assumption that all bodies of types that
1421 can be upgraded came from arenas. Only the more complex non-
1422 upgradable types are allowed to be directly malloc()ed. */
1423 assert(old_type_details->arena);
1424 del_body((void*)((char*)old_body + old_type_details->offset),
1425 &PL_body_roots[old_type]);
1431 =for apidoc sv_backoff
1433 Remove any string offset. You should normally use the C<SvOOK_off> macro
1440 Perl_sv_backoff(pTHX_ SV *const sv)
1443 const char * const s = SvPVX_const(sv);
1445 PERL_ARGS_ASSERT_SV_BACKOFF;
1446 PERL_UNUSED_CONTEXT;
1449 assert(SvTYPE(sv) != SVt_PVHV);
1450 assert(SvTYPE(sv) != SVt_PVAV);
1452 SvOOK_offset(sv, delta);
1454 SvLEN_set(sv, SvLEN(sv) + delta);
1455 SvPV_set(sv, SvPVX(sv) - delta);
1456 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1457 SvFLAGS(sv) &= ~SVf_OOK;
1464 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1465 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1466 Use the C<SvGROW> wrapper instead.
1472 Perl_sv_grow(pTHX_ SV *const sv, STRLEN newlen)
1476 PERL_ARGS_ASSERT_SV_GROW;
1478 #ifdef HAS_64K_LIMIT
1479 if (newlen >= 0x10000) {
1480 PerlIO_printf(Perl_debug_log,
1481 "Allocation too large: %"UVxf"\n", (UV)newlen);
1484 #endif /* HAS_64K_LIMIT */
1487 if (SvTYPE(sv) < SVt_PV) {
1488 sv_upgrade(sv, SVt_PV);
1489 s = SvPVX_mutable(sv);
1491 else if (SvOOK(sv)) { /* pv is offset? */
1493 s = SvPVX_mutable(sv);
1494 if (newlen > SvLEN(sv))
1495 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1496 #ifdef HAS_64K_LIMIT
1497 if (newlen >= 0x10000)
1503 if (SvIsCOW(sv)) sv_force_normal(sv);
1504 s = SvPVX_mutable(sv);
1507 #ifdef PERL_NEW_COPY_ON_WRITE
1508 /* the new COW scheme uses SvPVX(sv)[SvLEN(sv)-1] (if spare)
1509 * to store the COW count. So in general, allocate one more byte than
1510 * asked for, to make it likely this byte is always spare: and thus
1511 * make more strings COW-able.
1512 * If the new size is a big power of two, don't bother: we assume the
1513 * caller wanted a nice 2^N sized block and will be annoyed at getting
1519 if (newlen > SvLEN(sv)) { /* need more room? */
1520 STRLEN minlen = SvCUR(sv);
1521 minlen += (minlen >> PERL_STRLEN_EXPAND_SHIFT) + 10;
1522 if (newlen < minlen)
1524 #ifndef Perl_safesysmalloc_size
1525 newlen = PERL_STRLEN_ROUNDUP(newlen);
1527 if (SvLEN(sv) && s) {
1528 s = (char*)saferealloc(s, newlen);
1531 s = (char*)safemalloc(newlen);
1532 if (SvPVX_const(sv) && SvCUR(sv)) {
1533 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1537 #ifdef Perl_safesysmalloc_size
1538 /* Do this here, do it once, do it right, and then we will never get
1539 called back into sv_grow() unless there really is some growing
1541 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1543 SvLEN_set(sv, newlen);
1550 =for apidoc sv_setiv
1552 Copies an integer into the given SV, upgrading first if necessary.
1553 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1559 Perl_sv_setiv(pTHX_ SV *const sv, const IV i)
1563 PERL_ARGS_ASSERT_SV_SETIV;
1565 SV_CHECK_THINKFIRST_COW_DROP(sv);
1566 switch (SvTYPE(sv)) {
1569 sv_upgrade(sv, SVt_IV);
1572 sv_upgrade(sv, SVt_PVIV);
1576 if (!isGV_with_GP(sv))
1583 /* diag_listed_as: Can't coerce %s to %s in %s */
1584 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1588 (void)SvIOK_only(sv); /* validate number */
1594 =for apidoc sv_setiv_mg
1596 Like C<sv_setiv>, but also handles 'set' magic.
1602 Perl_sv_setiv_mg(pTHX_ SV *const sv, const IV i)
1604 PERL_ARGS_ASSERT_SV_SETIV_MG;
1611 =for apidoc sv_setuv
1613 Copies an unsigned integer into the given SV, upgrading first if necessary.
1614 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1620 Perl_sv_setuv(pTHX_ SV *const sv, const UV u)
1622 PERL_ARGS_ASSERT_SV_SETUV;
1624 /* With the if statement to ensure that integers are stored as IVs whenever
1626 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1629 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1631 If you wish to remove the following if statement, so that this routine
1632 (and its callers) always return UVs, please benchmark to see what the
1633 effect is. Modern CPUs may be different. Or may not :-)
1635 if (u <= (UV)IV_MAX) {
1636 sv_setiv(sv, (IV)u);
1645 =for apidoc sv_setuv_mg
1647 Like C<sv_setuv>, but also handles 'set' magic.
1653 Perl_sv_setuv_mg(pTHX_ SV *const sv, const UV u)
1655 PERL_ARGS_ASSERT_SV_SETUV_MG;
1662 =for apidoc sv_setnv
1664 Copies a double into the given SV, upgrading first if necessary.
1665 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1671 Perl_sv_setnv(pTHX_ SV *const sv, const NV num)
1675 PERL_ARGS_ASSERT_SV_SETNV;
1677 SV_CHECK_THINKFIRST_COW_DROP(sv);
1678 switch (SvTYPE(sv)) {
1681 sv_upgrade(sv, SVt_NV);
1685 sv_upgrade(sv, SVt_PVNV);
1689 if (!isGV_with_GP(sv))
1696 /* diag_listed_as: Can't coerce %s to %s in %s */
1697 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1702 (void)SvNOK_only(sv); /* validate number */
1707 =for apidoc sv_setnv_mg
1709 Like C<sv_setnv>, but also handles 'set' magic.
1715 Perl_sv_setnv_mg(pTHX_ SV *const sv, const NV num)
1717 PERL_ARGS_ASSERT_SV_SETNV_MG;
1723 /* Print an "isn't numeric" warning, using a cleaned-up,
1724 * printable version of the offending string
1728 S_not_a_number(pTHX_ SV *const sv)
1735 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1738 dsv = newSVpvs_flags("", SVs_TEMP);
1739 pv = sv_uni_display(dsv, sv, 10, UNI_DISPLAY_ISPRINT);
1742 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1743 /* each *s can expand to 4 chars + "...\0",
1744 i.e. need room for 8 chars */
1746 const char *s = SvPVX_const(sv);
1747 const char * const end = s + SvCUR(sv);
1748 for ( ; s < end && d < limit; s++ ) {
1750 if (ch & 128 && !isPRINT_LC(ch)) {
1759 else if (ch == '\r') {
1763 else if (ch == '\f') {
1767 else if (ch == '\\') {
1771 else if (ch == '\0') {
1775 else if (isPRINT_LC(ch))
1792 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1793 /* diag_listed_as: Argument "%s" isn't numeric%s */
1794 "Argument \"%s\" isn't numeric in %s", pv,
1797 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1798 /* diag_listed_as: Argument "%s" isn't numeric%s */
1799 "Argument \"%s\" isn't numeric", pv);
1803 =for apidoc looks_like_number
1805 Test if the content of an SV looks like a number (or is a number).
1806 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1807 non-numeric warning), even if your atof() doesn't grok them. Get-magic is
1814 Perl_looks_like_number(pTHX_ SV *const sv)
1819 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1821 if (SvPOK(sv) || SvPOKp(sv)) {
1822 sbegin = SvPV_nomg_const(sv, len);
1825 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1826 return grok_number(sbegin, len, NULL);
1830 S_glob_2number(pTHX_ GV * const gv)
1832 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1834 /* We know that all GVs stringify to something that is not-a-number,
1835 so no need to test that. */
1836 if (ckWARN(WARN_NUMERIC))
1838 SV *const buffer = sv_newmortal();
1839 gv_efullname3(buffer, gv, "*");
1840 not_a_number(buffer);
1842 /* We just want something true to return, so that S_sv_2iuv_common
1843 can tail call us and return true. */
1847 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1848 until proven guilty, assume that things are not that bad... */
1853 As 64 bit platforms often have an NV that doesn't preserve all bits of
1854 an IV (an assumption perl has been based on to date) it becomes necessary
1855 to remove the assumption that the NV always carries enough precision to
1856 recreate the IV whenever needed, and that the NV is the canonical form.
1857 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1858 precision as a side effect of conversion (which would lead to insanity
1859 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1860 1) to distinguish between IV/UV/NV slots that have cached a valid
1861 conversion where precision was lost and IV/UV/NV slots that have a
1862 valid conversion which has lost no precision
1863 2) to ensure that if a numeric conversion to one form is requested that
1864 would lose precision, the precise conversion (or differently
1865 imprecise conversion) is also performed and cached, to prevent
1866 requests for different numeric formats on the same SV causing
1867 lossy conversion chains. (lossless conversion chains are perfectly
1872 SvIOKp is true if the IV slot contains a valid value
1873 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1874 SvNOKp is true if the NV slot contains a valid value
1875 SvNOK is true only if the NV value is accurate
1878 while converting from PV to NV, check to see if converting that NV to an
1879 IV(or UV) would lose accuracy over a direct conversion from PV to
1880 IV(or UV). If it would, cache both conversions, return NV, but mark
1881 SV as IOK NOKp (ie not NOK).
1883 While converting from PV to IV, check to see if converting that IV to an
1884 NV would lose accuracy over a direct conversion from PV to NV. If it
1885 would, cache both conversions, flag similarly.
1887 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1888 correctly because if IV & NV were set NV *always* overruled.
1889 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1890 changes - now IV and NV together means that the two are interchangeable:
1891 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1893 The benefit of this is that operations such as pp_add know that if
1894 SvIOK is true for both left and right operands, then integer addition
1895 can be used instead of floating point (for cases where the result won't
1896 overflow). Before, floating point was always used, which could lead to
1897 loss of precision compared with integer addition.
1899 * making IV and NV equal status should make maths accurate on 64 bit
1901 * may speed up maths somewhat if pp_add and friends start to use
1902 integers when possible instead of fp. (Hopefully the overhead in
1903 looking for SvIOK and checking for overflow will not outweigh the
1904 fp to integer speedup)
1905 * will slow down integer operations (callers of SvIV) on "inaccurate"
1906 values, as the change from SvIOK to SvIOKp will cause a call into
1907 sv_2iv each time rather than a macro access direct to the IV slot
1908 * should speed up number->string conversion on integers as IV is
1909 favoured when IV and NV are equally accurate
1911 ####################################################################
1912 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1913 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1914 On the other hand, SvUOK is true iff UV.
1915 ####################################################################
1917 Your mileage will vary depending your CPU's relative fp to integer
1921 #ifndef NV_PRESERVES_UV
1922 # define IS_NUMBER_UNDERFLOW_IV 1
1923 # define IS_NUMBER_UNDERFLOW_UV 2
1924 # define IS_NUMBER_IV_AND_UV 2
1925 # define IS_NUMBER_OVERFLOW_IV 4
1926 # define IS_NUMBER_OVERFLOW_UV 5
1928 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1930 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1932 S_sv_2iuv_non_preserve(pTHX_ SV *const sv
1940 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1942 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));
1943 if (SvNVX(sv) < (NV)IV_MIN) {
1944 (void)SvIOKp_on(sv);
1946 SvIV_set(sv, IV_MIN);
1947 return IS_NUMBER_UNDERFLOW_IV;
1949 if (SvNVX(sv) > (NV)UV_MAX) {
1950 (void)SvIOKp_on(sv);
1953 SvUV_set(sv, UV_MAX);
1954 return IS_NUMBER_OVERFLOW_UV;
1956 (void)SvIOKp_on(sv);
1958 /* Can't use strtol etc to convert this string. (See truth table in
1960 if (SvNVX(sv) <= (UV)IV_MAX) {
1961 SvIV_set(sv, I_V(SvNVX(sv)));
1962 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1963 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1965 /* Integer is imprecise. NOK, IOKp */
1967 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1970 SvUV_set(sv, U_V(SvNVX(sv)));
1971 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1972 if (SvUVX(sv) == UV_MAX) {
1973 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1974 possibly be preserved by NV. Hence, it must be overflow.
1976 return IS_NUMBER_OVERFLOW_UV;
1978 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1980 /* Integer is imprecise. NOK, IOKp */
1982 return IS_NUMBER_OVERFLOW_IV;
1984 #endif /* !NV_PRESERVES_UV*/
1987 S_sv_2iuv_common(pTHX_ SV *const sv)
1991 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1994 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1995 * without also getting a cached IV/UV from it at the same time
1996 * (ie PV->NV conversion should detect loss of accuracy and cache
1997 * IV or UV at same time to avoid this. */
1998 /* IV-over-UV optimisation - choose to cache IV if possible */
2000 if (SvTYPE(sv) == SVt_NV)
2001 sv_upgrade(sv, SVt_PVNV);
2003 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2004 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2005 certainly cast into the IV range at IV_MAX, whereas the correct
2006 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2008 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2009 if (Perl_isnan(SvNVX(sv))) {
2015 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2016 SvIV_set(sv, I_V(SvNVX(sv)));
2017 if (SvNVX(sv) == (NV) SvIVX(sv)
2018 #ifndef NV_PRESERVES_UV
2019 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2020 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2021 /* Don't flag it as "accurately an integer" if the number
2022 came from a (by definition imprecise) NV operation, and
2023 we're outside the range of NV integer precision */
2027 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2029 /* scalar has trailing garbage, eg "42a" */
2031 DEBUG_c(PerlIO_printf(Perl_debug_log,
2032 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2038 /* IV not precise. No need to convert from PV, as NV
2039 conversion would already have cached IV if it detected
2040 that PV->IV would be better than PV->NV->IV
2041 flags already correct - don't set public IOK. */
2042 DEBUG_c(PerlIO_printf(Perl_debug_log,
2043 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2048 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2049 but the cast (NV)IV_MIN rounds to a the value less (more
2050 negative) than IV_MIN which happens to be equal to SvNVX ??
2051 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2052 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2053 (NV)UVX == NVX are both true, but the values differ. :-(
2054 Hopefully for 2s complement IV_MIN is something like
2055 0x8000000000000000 which will be exact. NWC */
2058 SvUV_set(sv, U_V(SvNVX(sv)));
2060 (SvNVX(sv) == (NV) SvUVX(sv))
2061 #ifndef NV_PRESERVES_UV
2062 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2063 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2064 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2065 /* Don't flag it as "accurately an integer" if the number
2066 came from a (by definition imprecise) NV operation, and
2067 we're outside the range of NV integer precision */
2073 DEBUG_c(PerlIO_printf(Perl_debug_log,
2074 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2080 else if (SvPOKp(sv)) {
2082 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2083 /* We want to avoid a possible problem when we cache an IV/ a UV which
2084 may be later translated to an NV, and the resulting NV is not
2085 the same as the direct translation of the initial string
2086 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2087 be careful to ensure that the value with the .456 is around if the
2088 NV value is requested in the future).
2090 This means that if we cache such an IV/a UV, we need to cache the
2091 NV as well. Moreover, we trade speed for space, and do not
2092 cache the NV if we are sure it's not needed.
2095 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == IS_NUMBER_IN_UV) {
2098 /* It's definitely an integer, only upgrade to PVIV */
2099 if (SvTYPE(sv) < SVt_PVIV)
2100 sv_upgrade(sv, SVt_PVIV);
2102 } else if (SvTYPE(sv) < SVt_PVNV)
2103 sv_upgrade(sv, SVt_PVNV);
2105 /* If NVs preserve UVs then we only use the UV value if we know that
2106 we aren't going to call atof() below. If NVs don't preserve UVs
2107 then the value returned may have more precision than atof() will
2108 return, even though value isn't perfectly accurate. */
2109 if ((numtype & (IS_NUMBER_IN_UV
2110 #ifdef NV_PRESERVES_UV
2113 )) == IS_NUMBER_IN_UV) {
2114 /* This won't turn off the public IOK flag if it was set above */
2115 (void)SvIOKp_on(sv);
2117 if (!(numtype & IS_NUMBER_NEG)) {
2119 if (value <= (UV)IV_MAX) {
2120 SvIV_set(sv, (IV)value);
2122 /* it didn't overflow, and it was positive. */
2123 SvUV_set(sv, value);
2127 /* 2s complement assumption */
2128 if (value <= (UV)IV_MIN) {
2129 SvIV_set(sv, -(IV)value);
2131 /* Too negative for an IV. This is a double upgrade, but
2132 I'm assuming it will be rare. */
2133 if (SvTYPE(sv) < SVt_PVNV)
2134 sv_upgrade(sv, SVt_PVNV);
2138 SvNV_set(sv, -(NV)value);
2139 SvIV_set(sv, IV_MIN);
2143 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2144 will be in the previous block to set the IV slot, and the next
2145 block to set the NV slot. So no else here. */
2147 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2148 != IS_NUMBER_IN_UV) {
2149 /* It wasn't an (integer that doesn't overflow the UV). */
2150 SvNV_set(sv, Atof(SvPVX_const(sv)));
2152 if (! numtype && ckWARN(WARN_NUMERIC))
2155 #if defined(USE_LONG_DOUBLE)
2156 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2157 PTR2UV(sv), SvNVX(sv)));
2159 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2160 PTR2UV(sv), SvNVX(sv)));
2163 #ifdef NV_PRESERVES_UV
2164 (void)SvIOKp_on(sv);
2166 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2167 SvIV_set(sv, I_V(SvNVX(sv)));
2168 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2171 NOOP; /* Integer is imprecise. NOK, IOKp */
2173 /* UV will not work better than IV */
2175 if (SvNVX(sv) > (NV)UV_MAX) {
2177 /* Integer is inaccurate. NOK, IOKp, is UV */
2178 SvUV_set(sv, UV_MAX);
2180 SvUV_set(sv, U_V(SvNVX(sv)));
2181 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2182 NV preservse UV so can do correct comparison. */
2183 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2186 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2191 #else /* NV_PRESERVES_UV */
2192 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2193 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2194 /* The IV/UV slot will have been set from value returned by
2195 grok_number above. The NV slot has just been set using
2198 assert (SvIOKp(sv));
2200 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2201 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2202 /* Small enough to preserve all bits. */
2203 (void)SvIOKp_on(sv);
2205 SvIV_set(sv, I_V(SvNVX(sv)));
2206 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2208 /* Assumption: first non-preserved integer is < IV_MAX,
2209 this NV is in the preserved range, therefore: */
2210 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2212 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);
2216 0 0 already failed to read UV.
2217 0 1 already failed to read UV.
2218 1 0 you won't get here in this case. IV/UV
2219 slot set, public IOK, Atof() unneeded.
2220 1 1 already read UV.
2221 so there's no point in sv_2iuv_non_preserve() attempting
2222 to use atol, strtol, strtoul etc. */
2224 sv_2iuv_non_preserve (sv, numtype);
2226 sv_2iuv_non_preserve (sv);
2230 #endif /* NV_PRESERVES_UV */
2231 /* It might be more code efficient to go through the entire logic above
2232 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2233 gets complex and potentially buggy, so more programmer efficient
2234 to do it this way, by turning off the public flags: */
2236 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2240 if (isGV_with_GP(sv))
2241 return glob_2number(MUTABLE_GV(sv));
2243 if (!SvPADTMP(sv)) {
2244 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2247 if (SvTYPE(sv) < SVt_IV)
2248 /* Typically the caller expects that sv_any is not NULL now. */
2249 sv_upgrade(sv, SVt_IV);
2250 /* Return 0 from the caller. */
2257 =for apidoc sv_2iv_flags
2259 Return the integer value of an SV, doing any necessary string
2260 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2261 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2267 Perl_sv_2iv_flags(pTHX_ SV *const sv, const I32 flags)
2274 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2280 if (flags & SV_SKIP_OVERLOAD)
2282 tmpstr = AMG_CALLunary(sv, numer_amg);
2283 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2284 return SvIV(tmpstr);
2287 return PTR2IV(SvRV(sv));
2290 if (SvVALID(sv) || isREGEXP(sv)) {
2291 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2292 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2293 In practice they are extremely unlikely to actually get anywhere
2294 accessible by user Perl code - the only way that I'm aware of is when
2295 a constant subroutine which is used as the second argument to index.
2297 Regexps have no SvIVX and SvNVX fields.
2299 assert(isREGEXP(sv) || SvPOKp(sv));
2302 const char * const ptr =
2303 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2305 = grok_number(ptr, SvCUR(sv), &value);
2307 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2308 == IS_NUMBER_IN_UV) {
2309 /* It's definitely an integer */
2310 if (numtype & IS_NUMBER_NEG) {
2311 if (value < (UV)IV_MIN)
2314 if (value < (UV)IV_MAX)
2319 if (ckWARN(WARN_NUMERIC))
2322 return I_V(Atof(ptr));
2326 if (SvTHINKFIRST(sv)) {
2327 #ifdef PERL_OLD_COPY_ON_WRITE
2329 sv_force_normal_flags(sv, 0);
2332 if (SvREADONLY(sv) && !SvOK(sv)) {
2333 if (ckWARN(WARN_UNINITIALIZED))
2340 if (S_sv_2iuv_common(aTHX_ sv))
2344 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2345 PTR2UV(sv),SvIVX(sv)));
2346 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2350 =for apidoc sv_2uv_flags
2352 Return the unsigned integer value of an SV, doing any necessary string
2353 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2354 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2360 Perl_sv_2uv_flags(pTHX_ SV *const sv, const I32 flags)
2367 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2373 if (flags & SV_SKIP_OVERLOAD)
2375 tmpstr = AMG_CALLunary(sv, numer_amg);
2376 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2377 return SvUV(tmpstr);
2380 return PTR2UV(SvRV(sv));
2383 if (SvVALID(sv) || isREGEXP(sv)) {
2384 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2385 the same flag bit as SVf_IVisUV, so must not let them cache IVs.
2386 Regexps have no SvIVX and SvNVX fields. */
2387 assert(isREGEXP(sv) || SvPOKp(sv));
2390 const char * const ptr =
2391 isREGEXP(sv) ? RX_WRAPPED((REGEXP*)sv) : SvPVX_const(sv);
2393 = grok_number(ptr, SvCUR(sv), &value);
2395 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2396 == IS_NUMBER_IN_UV) {
2397 /* It's definitely an integer */
2398 if (!(numtype & IS_NUMBER_NEG))
2402 if (ckWARN(WARN_NUMERIC))
2405 return U_V(Atof(ptr));
2409 if (SvTHINKFIRST(sv)) {
2410 #ifdef PERL_OLD_COPY_ON_WRITE
2412 sv_force_normal_flags(sv, 0);
2415 if (SvREADONLY(sv) && !SvOK(sv)) {
2416 if (ckWARN(WARN_UNINITIALIZED))
2423 if (S_sv_2iuv_common(aTHX_ sv))
2427 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2428 PTR2UV(sv),SvUVX(sv)));
2429 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2433 =for apidoc sv_2nv_flags
2435 Return the num value of an SV, doing any necessary string or integer
2436 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2437 Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
2443 Perl_sv_2nv_flags(pTHX_ SV *const sv, const I32 flags)
2448 if (SvGMAGICAL(sv) || SvVALID(sv) || isREGEXP(sv)) {
2449 /* FBMs use the space for SvIVX and SvNVX for other purposes, and use
2450 the same flag bit as SVf_IVisUV, so must not let them cache NVs.
2451 Regexps have no SvIVX and SvNVX fields. */
2453 if (flags & SV_GMAGIC)
2457 if (SvPOKp(sv) && !SvIOKp(sv)) {
2458 ptr = SvPVX_const(sv);
2460 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2461 !grok_number(ptr, SvCUR(sv), NULL))
2467 return (NV)SvUVX(sv);
2469 return (NV)SvIVX(sv);
2475 ptr = RX_WRAPPED((REGEXP *)sv);
2478 assert(SvTYPE(sv) >= SVt_PVMG);
2479 /* This falls through to the report_uninit near the end of the
2481 } else if (SvTHINKFIRST(sv)) {
2486 if (flags & SV_SKIP_OVERLOAD)
2488 tmpstr = AMG_CALLunary(sv, numer_amg);
2489 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2490 return SvNV(tmpstr);
2493 return PTR2NV(SvRV(sv));
2495 #ifdef PERL_OLD_COPY_ON_WRITE
2497 sv_force_normal_flags(sv, 0);
2500 if (SvREADONLY(sv) && !SvOK(sv)) {
2501 if (ckWARN(WARN_UNINITIALIZED))
2506 if (SvTYPE(sv) < SVt_NV) {
2507 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2508 sv_upgrade(sv, SVt_NV);
2509 #ifdef USE_LONG_DOUBLE
2511 STORE_NUMERIC_LOCAL_SET_STANDARD();
2512 PerlIO_printf(Perl_debug_log,
2513 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2514 PTR2UV(sv), SvNVX(sv));
2515 RESTORE_NUMERIC_LOCAL();
2519 STORE_NUMERIC_LOCAL_SET_STANDARD();
2520 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2521 PTR2UV(sv), SvNVX(sv));
2522 RESTORE_NUMERIC_LOCAL();
2526 else if (SvTYPE(sv) < SVt_PVNV)
2527 sv_upgrade(sv, SVt_PVNV);
2532 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2533 #ifdef NV_PRESERVES_UV
2539 /* Only set the public NV OK flag if this NV preserves the IV */
2540 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2542 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2543 : (SvIVX(sv) == I_V(SvNVX(sv))))
2549 else if (SvPOKp(sv)) {
2551 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2552 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2554 #ifdef NV_PRESERVES_UV
2555 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2556 == IS_NUMBER_IN_UV) {
2557 /* It's definitely an integer */
2558 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2560 SvNV_set(sv, Atof(SvPVX_const(sv)));
2566 SvNV_set(sv, Atof(SvPVX_const(sv)));
2567 /* Only set the public NV OK flag if this NV preserves the value in
2568 the PV at least as well as an IV/UV would.
2569 Not sure how to do this 100% reliably. */
2570 /* if that shift count is out of range then Configure's test is
2571 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2573 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2574 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2575 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2576 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2577 /* Can't use strtol etc to convert this string, so don't try.
2578 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2581 /* value has been set. It may not be precise. */
2582 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2583 /* 2s complement assumption for (UV)IV_MIN */
2584 SvNOK_on(sv); /* Integer is too negative. */
2589 if (numtype & IS_NUMBER_NEG) {
2590 SvIV_set(sv, -(IV)value);
2591 } else if (value <= (UV)IV_MAX) {
2592 SvIV_set(sv, (IV)value);
2594 SvUV_set(sv, value);
2598 if (numtype & IS_NUMBER_NOT_INT) {
2599 /* I believe that even if the original PV had decimals,
2600 they are lost beyond the limit of the FP precision.
2601 However, neither is canonical, so both only get p
2602 flags. NWC, 2000/11/25 */
2603 /* Both already have p flags, so do nothing */
2605 const NV nv = SvNVX(sv);
2606 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2607 if (SvIVX(sv) == I_V(nv)) {
2610 /* It had no "." so it must be integer. */
2614 /* between IV_MAX and NV(UV_MAX).
2615 Could be slightly > UV_MAX */
2617 if (numtype & IS_NUMBER_NOT_INT) {
2618 /* UV and NV both imprecise. */
2620 const UV nv_as_uv = U_V(nv);
2622 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2631 /* It might be more code efficient to go through the entire logic above
2632 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2633 gets complex and potentially buggy, so more programmer efficient
2634 to do it this way, by turning off the public flags: */
2636 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2637 #endif /* NV_PRESERVES_UV */
2640 if (isGV_with_GP(sv)) {
2641 glob_2number(MUTABLE_GV(sv));
2645 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2647 assert (SvTYPE(sv) >= SVt_NV);
2648 /* Typically the caller expects that sv_any is not NULL now. */
2649 /* XXX Ilya implies that this is a bug in callers that assume this
2650 and ideally should be fixed. */
2653 #if defined(USE_LONG_DOUBLE)
2655 STORE_NUMERIC_LOCAL_SET_STANDARD();
2656 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2657 PTR2UV(sv), SvNVX(sv));
2658 RESTORE_NUMERIC_LOCAL();
2662 STORE_NUMERIC_LOCAL_SET_STANDARD();
2663 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2664 PTR2UV(sv), SvNVX(sv));
2665 RESTORE_NUMERIC_LOCAL();
2674 Return an SV with the numeric value of the source SV, doing any necessary
2675 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2676 access this function.
2682 Perl_sv_2num(pTHX_ SV *const sv)
2684 PERL_ARGS_ASSERT_SV_2NUM;
2689 SV * const tmpsv = AMG_CALLunary(sv, numer_amg);
2690 TAINT_IF(tmpsv && SvTAINTED(tmpsv));
2691 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2692 return sv_2num(tmpsv);
2694 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2697 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2698 * UV as a string towards the end of buf, and return pointers to start and
2701 * We assume that buf is at least TYPE_CHARS(UV) long.
2705 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2707 char *ptr = buf + TYPE_CHARS(UV);
2708 char * const ebuf = ptr;
2711 PERL_ARGS_ASSERT_UIV_2BUF;
2723 *--ptr = '0' + (char)(uv % 10);
2732 =for apidoc sv_2pv_flags
2734 Returns a pointer to the string value of an SV, and sets *lp to its length.
2735 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
2736 string if necessary. Normally invoked via the C<SvPV_flags> macro.
2737 C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
2743 Perl_sv_2pv_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
2753 if (SvGMAGICAL(sv) && (flags & SV_GMAGIC))
2758 if (flags & SV_SKIP_OVERLOAD)
2760 tmpstr = AMG_CALLunary(sv, string_amg);
2761 TAINT_IF(tmpstr && SvTAINTED(tmpstr));
2762 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2764 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2768 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2769 if (flags & SV_CONST_RETURN) {
2770 pv = (char *) SvPVX_const(tmpstr);
2772 pv = (flags & SV_MUTABLE_RETURN)
2773 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2776 *lp = SvCUR(tmpstr);
2778 pv = sv_2pv_flags(tmpstr, lp, flags);
2791 SV *const referent = SvRV(sv);
2795 retval = buffer = savepvn("NULLREF", len);
2796 } else if (SvTYPE(referent) == SVt_REGEXP &&
2797 (!(PL_curcop->cop_hints & HINT_NO_AMAGIC) ||
2798 amagic_is_enabled(string_amg))) {
2799 REGEXP * const re = (REGEXP *)MUTABLE_PTR(referent);
2803 /* If the regex is UTF-8 we want the containing scalar to
2804 have an UTF-8 flag too */
2811 *lp = RX_WRAPLEN(re);
2813 return RX_WRAPPED(re);
2815 const char *const typestr = sv_reftype(referent, 0);
2816 const STRLEN typelen = strlen(typestr);
2817 UV addr = PTR2UV(referent);
2818 const char *stashname = NULL;
2819 STRLEN stashnamelen = 0; /* hush, gcc */
2820 const char *buffer_end;
2822 if (SvOBJECT(referent)) {
2823 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2826 stashname = HEK_KEY(name);
2827 stashnamelen = HEK_LEN(name);
2829 if (HEK_UTF8(name)) {
2835 stashname = "__ANON__";
2838 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2839 + 2 * sizeof(UV) + 2 /* )\0 */;
2841 len = typelen + 3 /* (0x */
2842 + 2 * sizeof(UV) + 2 /* )\0 */;
2845 Newx(buffer, len, char);
2846 buffer_end = retval = buffer + len;
2848 /* Working backwards */
2852 *--retval = PL_hexdigit[addr & 15];
2853 } while (addr >>= 4);
2859 memcpy(retval, typestr, typelen);
2863 retval -= stashnamelen;
2864 memcpy(retval, stashname, stashnamelen);
2866 /* retval may not necessarily have reached the start of the
2868 assert (retval >= buffer);
2870 len = buffer_end - retval - 1; /* -1 for that \0 */
2882 if (flags & SV_MUTABLE_RETURN)
2883 return SvPVX_mutable(sv);
2884 if (flags & SV_CONST_RETURN)
2885 return (char *)SvPVX_const(sv);
2890 /* I'm assuming that if both IV and NV are equally valid then
2891 converting the IV is going to be more efficient */
2892 const U32 isUIOK = SvIsUV(sv);
2893 char buf[TYPE_CHARS(UV)];
2897 if (SvTYPE(sv) < SVt_PVIV)
2898 sv_upgrade(sv, SVt_PVIV);
2899 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2901 /* inlined from sv_setpvn */
2902 s = SvGROW_mutable(sv, len + 1);
2903 Move(ptr, s, len, char);
2908 else if (SvNOK(sv)) {
2909 if (SvTYPE(sv) < SVt_PVNV)
2910 sv_upgrade(sv, SVt_PVNV);
2911 if (SvNVX(sv) == 0.0) {
2912 s = SvGROW_mutable(sv, 2);
2917 /* The +20 is pure guesswork. Configure test needed. --jhi */
2918 s = SvGROW_mutable(sv, NV_DIG + 20);
2919 /* some Xenix systems wipe out errno here */
2921 #ifndef USE_LOCALE_NUMERIC
2922 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2925 /* Gconvert always uses the current locale. That's the right thing
2926 * to do if we're supposed to be using locales. But otherwise, we
2927 * want the result to be based on the C locale, so we need to
2928 * change to the C locale during the Gconvert and then change back.
2929 * But if we're already in the C locale (PL_numeric_standard is
2930 * TRUE in that case), no need to do any changing */
2931 if (PL_numeric_standard || IN_LOCALE_RUNTIME) {
2932 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2935 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
2936 setlocale(LC_NUMERIC, "C");
2937 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2938 setlocale(LC_NUMERIC, loc);
2942 /* We don't call SvPOK_on(), because it may come to pass that the
2943 * locale changes so that the stringification we just did is no
2944 * longer correct. We will have to re-stringify every time it is
2955 else if (isGV_with_GP(sv)) {
2956 GV *const gv = MUTABLE_GV(sv);
2957 SV *const buffer = sv_newmortal();
2959 gv_efullname3(buffer, gv, "*");
2961 assert(SvPOK(buffer));
2965 *lp = SvCUR(buffer);
2966 return SvPVX(buffer);
2968 else if (isREGEXP(sv)) {
2969 if (lp) *lp = RX_WRAPLEN((REGEXP *)sv);
2970 return RX_WRAPPED((REGEXP *)sv);
2975 if (flags & SV_UNDEF_RETURNS_NULL)
2977 if (!PL_localizing && !SvPADTMP(sv) && ckWARN(WARN_UNINITIALIZED))
2979 /* Typically the caller expects that sv_any is not NULL now. */
2980 if (!SvREADONLY(sv) && SvTYPE(sv) < SVt_PV)
2981 sv_upgrade(sv, SVt_PV);
2986 const STRLEN len = s - SvPVX_const(sv);
2991 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2992 PTR2UV(sv),SvPVX_const(sv)));
2993 if (flags & SV_CONST_RETURN)
2994 return (char *)SvPVX_const(sv);
2995 if (flags & SV_MUTABLE_RETURN)
2996 return SvPVX_mutable(sv);
3001 =for apidoc sv_copypv
3003 Copies a stringified representation of the source SV into the
3004 destination SV. Automatically performs any necessary mg_get and
3005 coercion of numeric values into strings. Guaranteed to preserve
3006 UTF8 flag even from overloaded objects. Similar in nature to
3007 sv_2pv[_flags] but operates directly on an SV instead of just the
3008 string. Mostly uses sv_2pv_flags to do its work, except when that
3009 would lose the UTF-8'ness of the PV.
3011 =for apidoc sv_copypv_nomg
3013 Like sv_copypv, but doesn't invoke get magic first.
3015 =for apidoc sv_copypv_flags
3017 Implementation of sv_copypv and sv_copypv_nomg. Calls get magic iff flags
3024 Perl_sv_copypv(pTHX_ SV *const dsv, SV *const ssv)
3026 PERL_ARGS_ASSERT_SV_COPYPV;
3028 sv_copypv_flags(dsv, ssv, 0);
3032 Perl_sv_copypv_flags(pTHX_ SV *const dsv, SV *const ssv, const I32 flags)
3037 PERL_ARGS_ASSERT_SV_COPYPV_FLAGS;
3039 if ((flags & SV_GMAGIC) && SvGMAGICAL(ssv))
3041 s = SvPV_nomg_const(ssv,len);
3042 sv_setpvn(dsv,s,len);
3050 =for apidoc sv_2pvbyte
3052 Return a pointer to the byte-encoded representation of the SV, and set *lp
3053 to its length. May cause the SV to be downgraded from UTF-8 as a
3056 Usually accessed via the C<SvPVbyte> macro.
3062 Perl_sv_2pvbyte(pTHX_ SV *sv, STRLEN *const lp)
3064 PERL_ARGS_ASSERT_SV_2PVBYTE;
3066 if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3067 || isGV_with_GP(sv) || SvROK(sv)) {
3068 SV *sv2 = sv_newmortal();
3072 else SvGETMAGIC(sv);
3073 sv_utf8_downgrade(sv,0);
3074 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3078 =for apidoc sv_2pvutf8
3080 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3081 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3083 Usually accessed via the C<SvPVutf8> macro.
3089 Perl_sv_2pvutf8(pTHX_ SV *sv, STRLEN *const lp)
3091 PERL_ARGS_ASSERT_SV_2PVUTF8;
3093 if (((SvREADONLY(sv) || SvFAKE(sv)) && !SvIsCOW(sv))
3094 || isGV_with_GP(sv) || SvROK(sv))
3095 sv = sv_mortalcopy(sv);
3098 sv_utf8_upgrade_nomg(sv);
3099 return lp ? SvPV_nomg(sv,*lp) : SvPV_nomg_nolen(sv);
3104 =for apidoc sv_2bool
3106 This macro is only used by sv_true() or its macro equivalent, and only if
3107 the latter's argument is neither SvPOK, SvIOK nor SvNOK.
3108 It calls sv_2bool_flags with the SV_GMAGIC flag.
3110 =for apidoc sv_2bool_flags
3112 This function is only used by sv_true() and friends, and only if
3113 the latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flags
3114 contain SV_GMAGIC, then it does an mg_get() first.
3121 Perl_sv_2bool_flags(pTHX_ SV *const sv, const I32 flags)
3125 PERL_ARGS_ASSERT_SV_2BOOL_FLAGS;
3127 if(flags & SV_GMAGIC) SvGETMAGIC(sv);
3133 SV * const tmpsv = AMG_CALLunary(sv, bool__amg);
3134 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3135 return cBOOL(SvTRUE(tmpsv));
3137 return SvRV(sv) != 0;
3139 return SvTRUE_common(sv, isGV_with_GP(sv) ? 1 : 0);
3143 =for apidoc sv_utf8_upgrade
3145 Converts the PV of an SV to its UTF-8-encoded form.
3146 Forces the SV to string form if it is not already.
3147 Will C<mg_get> on C<sv> if appropriate.
3148 Always sets the SvUTF8 flag to avoid future validity checks even
3149 if the whole string is the same in UTF-8 as not.
3150 Returns the number of bytes in the converted string
3152 This is not a general purpose byte encoding to Unicode interface:
3153 use the Encode extension for that.
3155 =for apidoc sv_utf8_upgrade_nomg
3157 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
3159 =for apidoc sv_utf8_upgrade_flags
3161 Converts the PV of an SV to its UTF-8-encoded form.
3162 Forces the SV to string form if it is not already.
3163 Always sets the SvUTF8 flag to avoid future validity checks even
3164 if all the bytes are invariant in UTF-8.
3165 If C<flags> has C<SV_GMAGIC> bit set,
3166 will C<mg_get> on C<sv> if appropriate, else not.
3167 Returns the number of bytes in the converted string
3168 C<sv_utf8_upgrade> and
3169 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3171 This is not a general purpose byte encoding to Unicode interface:
3172 use the Encode extension for that.
3176 The grow version is currently not externally documented. It adds a parameter,
3177 extra, which is the number of unused bytes the string of 'sv' is guaranteed to
3178 have free after it upon return. This allows the caller to reserve extra space
3179 that it intends to fill, to avoid extra grows.
3181 Also externally undocumented for the moment is the flag SV_FORCE_UTF8_UPGRADE,
3182 which can be used to tell this function to not first check to see if there are
3183 any characters that are different in UTF-8 (variant characters) which would
3184 force it to allocate a new string to sv, but to assume there are. Typically
3185 this flag is used by a routine that has already parsed the string to find that
3186 there are such characters, and passes this information on so that the work
3187 doesn't have to be repeated.
3189 (One might think that the calling routine could pass in the position of the
3190 first such variant, so it wouldn't have to be found again. But that is not the
3191 case, because typically when the caller is likely to use this flag, it won't be
3192 calling this routine unless it finds something that won't fit into a byte.
3193 Otherwise it tries to not upgrade and just use bytes. But some things that
3194 do fit into a byte are variants in utf8, and the caller may not have been
3195 keeping track of these.)
3197 If the routine itself changes the string, it adds a trailing NUL. Such a NUL
3198 isn't guaranteed due to having other routines do the work in some input cases,
3199 or if the input is already flagged as being in utf8.
3201 The speed of this could perhaps be improved for many cases if someone wanted to
3202 write a fast function that counts the number of variant characters in a string,
3203 especially if it could return the position of the first one.
3208 Perl_sv_utf8_upgrade_flags_grow(pTHX_ SV *const sv, const I32 flags, STRLEN extra)
3212 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS_GROW;
3214 if (sv == &PL_sv_undef)
3216 if (!SvPOK_nog(sv)) {
3218 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3219 (void) sv_2pv_flags(sv,&len, flags);
3221 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3225 (void) SvPV_force_flags(sv,len,flags & SV_GMAGIC);
3230 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3235 sv_force_normal_flags(sv, 0);
3238 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING)) {
3239 sv_recode_to_utf8(sv, PL_encoding);
3240 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3244 if (SvCUR(sv) == 0) {
3245 if (extra) SvGROW(sv, extra);
3246 } else { /* Assume Latin-1/EBCDIC */
3247 /* This function could be much more efficient if we
3248 * had a FLAG in SVs to signal if there are any variant
3249 * chars in the PV. Given that there isn't such a flag
3250 * make the loop as fast as possible (although there are certainly ways
3251 * to speed this up, eg. through vectorization) */
3252 U8 * s = (U8 *) SvPVX_const(sv);
3253 U8 * e = (U8 *) SvEND(sv);
3255 STRLEN two_byte_count = 0;
3257 if (flags & SV_FORCE_UTF8_UPGRADE) goto must_be_utf8;
3259 /* See if really will need to convert to utf8. We mustn't rely on our
3260 * incoming SV being well formed and having a trailing '\0', as certain
3261 * code in pp_formline can send us partially built SVs. */
3265 if (NATIVE_IS_INVARIANT(ch)) continue;
3267 t--; /* t already incremented; re-point to first variant */
3272 /* utf8 conversion not needed because all are invariants. Mark as
3273 * UTF-8 even if no variant - saves scanning loop */
3275 if (extra) SvGROW(sv, SvCUR(sv) + extra);
3280 /* Here, the string should be converted to utf8, either because of an
3281 * input flag (two_byte_count = 0), or because a character that
3282 * requires 2 bytes was found (two_byte_count = 1). t points either to
3283 * the beginning of the string (if we didn't examine anything), or to
3284 * the first variant. In either case, everything from s to t - 1 will
3285 * occupy only 1 byte each on output.
3287 * There are two main ways to convert. One is to create a new string
3288 * and go through the input starting from the beginning, appending each
3289 * converted value onto the new string as we go along. It's probably
3290 * best to allocate enough space in the string for the worst possible
3291 * case rather than possibly running out of space and having to
3292 * reallocate and then copy what we've done so far. Since everything
3293 * from s to t - 1 is invariant, the destination can be initialized
3294 * with these using a fast memory copy
3296 * The other way is to figure out exactly how big the string should be
3297 * by parsing the entire input. Then you don't have to make it big
3298 * enough to handle the worst possible case, and more importantly, if
3299 * the string you already have is large enough, you don't have to
3300 * allocate a new string, you can copy the last character in the input
3301 * string to the final position(s) that will be occupied by the
3302 * converted string and go backwards, stopping at t, since everything
3303 * before that is invariant.
3305 * There are advantages and disadvantages to each method.
3307 * In the first method, we can allocate a new string, do the memory
3308 * copy from the s to t - 1, and then proceed through the rest of the
3309 * string byte-by-byte.
3311 * In the second method, we proceed through the rest of the input
3312 * string just calculating how big the converted string will be. Then
3313 * there are two cases:
3314 * 1) if the string has enough extra space to handle the converted
3315 * value. We go backwards through the string, converting until we
3316 * get to the position we are at now, and then stop. If this
3317 * position is far enough along in the string, this method is
3318 * faster than the other method. If the memory copy were the same
3319 * speed as the byte-by-byte loop, that position would be about
3320 * half-way, as at the half-way mark, parsing to the end and back
3321 * is one complete string's parse, the same amount as starting
3322 * over and going all the way through. Actually, it would be
3323 * somewhat less than half-way, as it's faster to just count bytes
3324 * than to also copy, and we don't have the overhead of allocating
3325 * a new string, changing the scalar to use it, and freeing the
3326 * existing one. But if the memory copy is fast, the break-even
3327 * point is somewhere after half way. The counting loop could be
3328 * sped up by vectorization, etc, to move the break-even point
3329 * further towards the beginning.
3330 * 2) if the string doesn't have enough space to handle the converted
3331 * value. A new string will have to be allocated, and one might
3332 * as well, given that, start from the beginning doing the first
3333 * method. We've spent extra time parsing the string and in
3334 * exchange all we've gotten is that we know precisely how big to
3335 * make the new one. Perl is more optimized for time than space,
3336 * so this case is a loser.
3337 * So what I've decided to do is not use the 2nd method unless it is
3338 * guaranteed that a new string won't have to be allocated, assuming
3339 * the worst case. I also decided not to put any more conditions on it
3340 * than this, for now. It seems likely that, since the worst case is
3341 * twice as big as the unknown portion of the string (plus 1), we won't
3342 * be guaranteed enough space, causing us to go to the first method,
3343 * unless the string is short, or the first variant character is near
3344 * the end of it. In either of these cases, it seems best to use the
3345 * 2nd method. The only circumstance I can think of where this would
3346 * be really slower is if the string had once had much more data in it
3347 * than it does now, but there is still a substantial amount in it */
3350 STRLEN invariant_head = t - s;
3351 STRLEN size = invariant_head + (e - t) * 2 + 1 + extra;
3352 if (SvLEN(sv) < size) {
3354 /* Here, have decided to allocate a new string */
3359 Newx(dst, size, U8);
3361 /* If no known invariants at the beginning of the input string,
3362 * set so starts from there. Otherwise, can use memory copy to
3363 * get up to where we are now, and then start from here */
3365 if (invariant_head <= 0) {
3368 Copy(s, dst, invariant_head, char);
3369 d = dst + invariant_head;
3373 const UV uv = NATIVE8_TO_UNI(*t++);
3374 if (UNI_IS_INVARIANT(uv))
3375 *d++ = (U8)UNI_TO_NATIVE(uv);
3377 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
3378 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
3382 SvPV_free(sv); /* No longer using pre-existing string */
3383 SvPV_set(sv, (char*)dst);
3384 SvCUR_set(sv, d - dst);
3385 SvLEN_set(sv, size);
3388 /* Here, have decided to get the exact size of the string.
3389 * Currently this happens only when we know that there is
3390 * guaranteed enough space to fit the converted string, so
3391 * don't have to worry about growing. If two_byte_count is 0,
3392 * then t points to the first byte of the string which hasn't
3393 * been examined yet. Otherwise two_byte_count is 1, and t
3394 * points to the first byte in the string that will expand to
3395 * two. Depending on this, start examining at t or 1 after t.
3398 U8 *d = t + two_byte_count;
3401 /* Count up the remaining bytes that expand to two */
3404 const U8 chr = *d++;
3405 if (! NATIVE_IS_INVARIANT(chr)) two_byte_count++;
3408 /* The string will expand by just the number of bytes that
3409 * occupy two positions. But we are one afterwards because of
3410 * the increment just above. This is the place to put the
3411 * trailing NUL, and to set the length before we decrement */
3413 d += two_byte_count;
3414 SvCUR_set(sv, d - s);
3418 /* Having decremented d, it points to the position to put the
3419 * very last byte of the expanded string. Go backwards through
3420 * the string, copying and expanding as we go, stopping when we
3421 * get to the part that is invariant the rest of the way down */
3425 const U8 ch = NATIVE8_TO_UNI(*e--);
3426 if (UNI_IS_INVARIANT(ch)) {
3427 *d-- = UNI_TO_NATIVE(ch);
3429 *d-- = (U8)UTF8_EIGHT_BIT_LO(ch);
3430 *d-- = (U8)UTF8_EIGHT_BIT_HI(ch);
3435 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3436 /* Update pos. We do it at the end rather than during
3437 * the upgrade, to avoid slowing down the common case
3438 * (upgrade without pos) */
3439 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3441 I32 pos = mg->mg_len;
3442 if (pos > 0 && (U32)pos > invariant_head) {
3443 U8 *d = (U8*) SvPVX(sv) + invariant_head;
3444 STRLEN n = (U32)pos - invariant_head;
3446 if (UTF8_IS_START(*d))
3451 mg->mg_len = d - (U8*)SvPVX(sv);
3454 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3455 magic_setutf8(sv,mg); /* clear UTF8 cache */
3460 /* Mark as UTF-8 even if no variant - saves scanning loop */
3466 =for apidoc sv_utf8_downgrade
3468 Attempts to convert the PV of an SV from characters to bytes.
3469 If the PV contains a character that cannot fit
3470 in a byte, this conversion will fail;
3471 in this case, either returns false or, if C<fail_ok> is not
3474 This is not a general purpose Unicode to byte encoding interface:
3475 use the Encode extension for that.
3481 Perl_sv_utf8_downgrade(pTHX_ SV *const sv, const bool fail_ok)
3485 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3487 if (SvPOKp(sv) && SvUTF8(sv)) {
3491 int mg_flags = SV_GMAGIC;
3494 sv_force_normal_flags(sv, 0);
3496 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3498 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3500 I32 pos = mg->mg_len;
3502 sv_pos_b2u(sv, &pos);
3503 mg_flags = 0; /* sv_pos_b2u does get magic */
3507 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3508 magic_setutf8(sv,mg); /* clear UTF8 cache */
3511 s = (U8 *) SvPV_flags(sv, len, mg_flags);
3513 if (!utf8_to_bytes(s, &len)) {
3518 Perl_croak(aTHX_ "Wide character in %s",
3521 Perl_croak(aTHX_ "Wide character");
3532 =for apidoc sv_utf8_encode
3534 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3535 flag off so that it looks like octets again.
3541 Perl_sv_utf8_encode(pTHX_ SV *const sv)
3543 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3545 if (SvREADONLY(sv)) {
3546 sv_force_normal_flags(sv, 0);
3548 (void) sv_utf8_upgrade(sv);
3553 =for apidoc sv_utf8_decode
3555 If the PV of the SV is an octet sequence in UTF-8
3556 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3557 so that it looks like a character. If the PV contains only single-byte
3558 characters, the C<SvUTF8> flag stays off.
3559 Scans PV for validity and returns false if the PV is invalid UTF-8.
3565 Perl_sv_utf8_decode(pTHX_ SV *const sv)
3567 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3570 const U8 *start, *c;
3573 /* The octets may have got themselves encoded - get them back as
3576 if (!sv_utf8_downgrade(sv, TRUE))
3579 /* it is actually just a matter of turning the utf8 flag on, but
3580 * we want to make sure everything inside is valid utf8 first.
3582 c = start = (const U8 *) SvPVX_const(sv);
3583 if (!is_utf8_string(c, SvCUR(sv)))
3585 e = (const U8 *) SvEND(sv);
3588 if (!UTF8_IS_INVARIANT(ch)) {
3593 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
3594 /* adjust pos to the start of a UTF8 char sequence */
3595 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
3597 I32 pos = mg->mg_len;
3599 for (c = start + pos; c > start; c--) {
3600 if (UTF8_IS_START(*c))
3603 mg->mg_len = c - start;
3606 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
3607 magic_setutf8(sv,mg); /* clear UTF8 cache */
3614 =for apidoc sv_setsv
3616 Copies the contents of the source SV C<ssv> into the destination SV
3617 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3618 function if the source SV needs to be reused. Does not handle 'set' magic.
3619 Loosely speaking, it performs a copy-by-value, obliterating any previous
3620 content of the destination.
3622 You probably want to use one of the assortment of wrappers, such as
3623 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3624 C<SvSetMagicSV_nosteal>.
3626 =for apidoc sv_setsv_flags
3628 Copies the contents of the source SV C<ssv> into the destination SV
3629 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3630 function if the source SV needs to be reused. Does not handle 'set' magic.
3631 Loosely speaking, it performs a copy-by-value, obliterating any previous
3632 content of the destination.
3633 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3634 C<ssv> if appropriate, else not. If the C<flags>
3635 parameter has the C<NOSTEAL> bit set then the
3636 buffers of temps will not be stolen. <sv_setsv>
3637 and C<sv_setsv_nomg> are implemented in terms of this function.
3639 You probably want to use one of the assortment of wrappers, such as
3640 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3641 C<SvSetMagicSV_nosteal>.
3643 This is the primary function for copying scalars, and most other
3644 copy-ish functions and macros use this underneath.
3650 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3652 I32 mro_changes = 0; /* 1 = method, 2 = isa, 3 = recursive isa */
3653 HV *old_stash = NULL;
3655 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3657 if (dtype != SVt_PVGV && !isGV_with_GP(dstr)) {
3658 const char * const name = GvNAME(sstr);
3659 const STRLEN len = GvNAMELEN(sstr);
3661 if (dtype >= SVt_PV) {
3667 SvUPGRADE(dstr, SVt_PVGV);
3668 (void)SvOK_off(dstr);
3669 /* We have to turn this on here, even though we turn it off
3670 below, as GvSTASH will fail an assertion otherwise. */
3671 isGV_with_GP_on(dstr);
3673 GvSTASH(dstr) = GvSTASH(sstr);
3675 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
3676 gv_name_set(MUTABLE_GV(dstr), name, len,
3677 GV_ADD | (GvNAMEUTF8(sstr) ? SVf_UTF8 : 0 ));
3678 SvFAKE_on(dstr); /* can coerce to non-glob */
3681 if(GvGP(MUTABLE_GV(sstr))) {
3682 /* If source has method cache entry, clear it */
3684 SvREFCNT_dec(GvCV(sstr));
3685 GvCV_set(sstr, NULL);
3688 /* If source has a real method, then a method is
3691 GvCV((const GV *)sstr) && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3697 /* If dest already had a real method, that's a change as well */
3699 !mro_changes && GvGP(MUTABLE_GV(dstr)) && GvCVu((const GV *)dstr)
3700 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3705 /* We don't need to check the name of the destination if it was not a
3706 glob to begin with. */
3707 if(dtype == SVt_PVGV) {
3708 const char * const name = GvNAME((const GV *)dstr);
3711 /* The stash may have been detached from the symbol table, so
3713 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3717 const STRLEN len = GvNAMELEN(dstr);
3718 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
3719 || (len == 1 && name[0] == ':')) {
3722 /* Set aside the old stash, so we can reset isa caches on
3724 if((old_stash = GvHV(dstr)))
3725 /* Make sure we do not lose it early. */
3726 SvREFCNT_inc_simple_void_NN(
3727 sv_2mortal((SV *)old_stash)
3733 gp_free(MUTABLE_GV(dstr));
3734 isGV_with_GP_off(dstr); /* SvOK_off does not like globs. */
3735 (void)SvOK_off(dstr);
3736 isGV_with_GP_on(dstr);
3737 GvINTRO_off(dstr); /* one-shot flag */
3738 GvGP_set(dstr, gp_ref(GvGP(sstr)));
3739 if (SvTAINTED(sstr))
3741 if (GvIMPORTED(dstr) != GVf_IMPORTED
3742 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3744 GvIMPORTED_on(dstr);
3747 if(mro_changes == 2) {
3748 if (GvAV((const GV *)sstr)) {
3750 SV * const sref = (SV *)GvAV((const GV *)dstr);
3751 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3752 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3753 AV * const ary = newAV();
3754 av_push(ary, mg->mg_obj); /* takes the refcount */
3755 mg->mg_obj = (SV *)ary;
3757 av_push((AV *)mg->mg_obj, SvREFCNT_inc_simple_NN(dstr));
3759 else sv_magic(sref, dstr, PERL_MAGIC_isa, NULL, 0);
3761 mro_isa_changed_in(GvSTASH(dstr));
3763 else if(mro_changes == 3) {
3764 HV * const stash = GvHV(dstr);
3765 if(old_stash ? (HV *)HvENAME_get(old_stash) : stash)
3771 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3772 if (GvIO(dstr) && dtype == SVt_PVGV) {
3773 DEBUG_o(Perl_deb(aTHX_
3774 "glob_assign_glob clearing PL_stashcache\n"));
3775 /* It's a cache. It will rebuild itself quite happily.
3776 It's a lot of effort to work out exactly which key (or keys)
3777 might be invalidated by the creation of the this file handle.
3779 hv_clear(PL_stashcache);
3785 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3787 SV * const sref = SvRV(sstr);
3789 const int intro = GvINTRO(dstr);
3792 const U32 stype = SvTYPE(sref);
3794 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3797 GvINTRO_off(dstr); /* one-shot flag */
3798 GvLINE(dstr) = CopLINE(PL_curcop);
3799 GvEGV(dstr) = MUTABLE_GV(dstr);
3804 location = (SV **) &(GvGP(dstr)->gp_cv); /* XXX bypassing GvCV_set */
3805 import_flag = GVf_IMPORTED_CV;
3808 location = (SV **) &GvHV(dstr);
3809 import_flag = GVf_IMPORTED_HV;
3812 location = (SV **) &GvAV(dstr);
3813 import_flag = GVf_IMPORTED_AV;
3816 location = (SV **) &GvIOp(dstr);
3819 location = (SV **) &GvFORM(dstr);
3822 location = &GvSV(dstr);
3823 import_flag = GVf_IMPORTED_SV;
3826 if (stype == SVt_PVCV) {
3827 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (const CV *)sref || GvCVGEN(dstr))) {*/
3828 if (GvCVGEN(dstr)) {
3829 SvREFCNT_dec(GvCV(dstr));
3830 GvCV_set(dstr, NULL);
3831 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3834 /* SAVEt_GVSLOT takes more room on the savestack and has more
3835 overhead in leave_scope than SAVEt_GENERIC_SV. But for CVs
3836 leave_scope needs access to the GV so it can reset method
3837 caches. We must use SAVEt_GVSLOT whenever the type is
3838 SVt_PVCV, even if the stash is anonymous, as the stash may
3839 gain a name somehow before leave_scope. */
3840 if (stype == SVt_PVCV) {
3841 /* There is no save_pushptrptrptr. Creating it for this
3842 one call site would be overkill. So inline the ss add
3846 SS_ADD_PTR(location);
3847 SS_ADD_PTR(SvREFCNT_inc(*location));
3848 SS_ADD_UV(SAVEt_GVSLOT);
3851 else SAVEGENERICSV(*location);
3854 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3855 CV* const cv = MUTABLE_CV(*location);
3857 if (!GvCVGEN((const GV *)dstr) &&
3858 (CvROOT(cv) || CvXSUB(cv)) &&
3859 /* redundant check that avoids creating the extra SV
3860 most of the time: */
3861 (CvCONST(cv) || ckWARN(WARN_REDEFINE)))
3863 SV * const new_const_sv =
3864 CvCONST((const CV *)sref)
3865 ? cv_const_sv((const CV *)sref)
3867 report_redefined_cv(
3868 sv_2mortal(Perl_newSVpvf(aTHX_
3871 HvNAME_HEK(GvSTASH((const GV *)dstr))
3873 HEKfARG(GvENAME_HEK(MUTABLE_GV(dstr)))
3876 CvCONST((const CV *)sref) ? &new_const_sv : NULL
3880 cv_ckproto_len_flags(cv, (const GV *)dstr,
3881 SvPOK(sref) ? CvPROTO(sref) : NULL,
3882 SvPOK(sref) ? CvPROTOLEN(sref) : 0,
3883 SvPOK(sref) ? SvUTF8(sref) : 0);
3885 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3886 GvASSUMECV_on(dstr);
3887 if(GvSTASH(dstr)) gv_method_changed(dstr); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3889 *location = SvREFCNT_inc_simple_NN(sref);
3890 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3891 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3892 GvFLAGS(dstr) |= import_flag;
3894 if (stype == SVt_PVHV) {
3895 const char * const name = GvNAME((GV*)dstr);
3896 const STRLEN len = GvNAMELEN(dstr);
3899 (len > 1 && name[len-2] == ':' && name[len-1] == ':')
3900 || (len == 1 && name[0] == ':')
3902 && (!dref || HvENAME_get(dref))
3905 (HV *)sref, (HV *)dref,
3911 stype == SVt_PVAV && sref != dref
3912 && strEQ(GvNAME((GV*)dstr), "ISA")
3913 /* The stash may have been detached from the symbol table, so
3914 check its name before doing anything. */
3915 && GvSTASH(dstr) && HvENAME(GvSTASH(dstr))
3918 MAGIC * const omg = dref && SvSMAGICAL(dref)
3919 ? mg_find(dref, PERL_MAGIC_isa)
3921 if (SvSMAGICAL(sref) && (mg = mg_find(sref, PERL_MAGIC_isa))) {
3922 if (SvTYPE(mg->mg_obj) != SVt_PVAV) {
3923 AV * const ary = newAV();
3924 av_push(ary, mg->mg_obj); /* takes the refcount */
3925 mg->mg_obj = (SV *)ary;
3928 if (SvTYPE(omg->mg_obj) == SVt_PVAV) {
3929 SV **svp = AvARRAY((AV *)omg->mg_obj);
3930 I32 items = AvFILLp((AV *)omg->mg_obj) + 1;
3934 SvREFCNT_inc_simple_NN(*svp++)
3940 SvREFCNT_inc_simple_NN(omg->mg_obj)
3944 av_push((AV *)mg->mg_obj,SvREFCNT_inc_simple_NN(dstr));
3949 sref, omg ? omg->mg_obj : dstr, PERL_MAGIC_isa, NULL, 0
3951 mg = mg_find(sref, PERL_MAGIC_isa);
3953 /* Since the *ISA assignment could have affected more than
3954 one stash, don't call mro_isa_changed_in directly, but let
3955 magic_clearisa do it for us, as it already has the logic for
3956 dealing with globs vs arrays of globs. */
3958 Perl_magic_clearisa(aTHX_ NULL, mg);
3960 else if (stype == SVt_PVIO) {
3961 DEBUG_o(Perl_deb(aTHX_ "glob_assign_ref clearing PL_stashcache\n"));
3962 /* It's a cache. It will rebuild itself quite happily.
3963 It's a lot of effort to work out exactly which key (or keys)
3964 might be invalidated by the creation of the this file handle.
3966 hv_clear(PL_stashcache);
3970 if (!intro) SvREFCNT_dec(dref);
3971 if (SvTAINTED(sstr))
3976 /* Work around compiler warnings about unsigned >= THRESHOLD when thres-
3978 #if SV_COW_THRESHOLD
3979 # define GE_COW_THRESHOLD(len) ((len) >= SV_COW_THRESHOLD)
3981 # define GE_COW_THRESHOLD(len) 1
3983 #if SV_COWBUF_THRESHOLD
3984 # define GE_COWBUF_THRESHOLD(len) ((len) >= SV_COWBUF_THRESHOLD)
3986 # define GE_COWBUF_THRESHOLD(len) 1
3990 Perl_sv_setsv_flags(pTHX_ SV *dstr, SV* sstr, const I32 flags)
3997 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
4002 if (SvIS_FREED(dstr)) {
4003 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
4004 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
4006 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4008 sstr = &PL_sv_undef;
4009 if (SvIS_FREED(sstr)) {
4010 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
4011 (void*)sstr, (void*)dstr);
4013 stype = SvTYPE(sstr);
4014 dtype = SvTYPE(dstr);
4016 /* There's a lot of redundancy below but we're going for speed here */
4021 if (dtype != SVt_PVGV && dtype != SVt_PVLV) {
4022 (void)SvOK_off(dstr);
4030 sv_upgrade(dstr, SVt_IV);
4034 sv_upgrade(dstr, SVt_PVIV);
4038 goto end_of_first_switch;
4040 (void)SvIOK_only(dstr);
4041 SvIV_set(dstr, SvIVX(sstr));
4044 /* SvTAINTED can only be true if the SV has taint magic, which in
4045 turn means that the SV type is PVMG (or greater). This is the
4046 case statement for SVt_IV, so this cannot be true (whatever gcov
4048 assert(!SvTAINTED(sstr));
4053 if (dtype < SVt_PV && dtype != SVt_IV)
4054 sv_upgrade(dstr, SVt_IV);
4062 sv_upgrade(dstr, SVt_NV);
4066 sv_upgrade(dstr, SVt_PVNV);
4070 goto end_of_first_switch;
4072 SvNV_set(dstr, SvNVX(sstr));
4073 (void)SvNOK_only(dstr);
4074 /* SvTAINTED can only be true if the SV has taint magic, which in
4075 turn means that the SV type is PVMG (or greater). This is the
4076 case statement for SVt_NV, so this cannot be true (whatever gcov
4078 assert(!SvTAINTED(sstr));
4085 sv_upgrade(dstr, SVt_PV);
4088 if (dtype < SVt_PVIV)
4089 sv_upgrade(dstr, SVt_PVIV);
4092 if (dtype < SVt_PVNV)
4093 sv_upgrade(dstr, SVt_PVNV);
4097 const char * const type = sv_reftype(sstr,0);
4099 /* diag_listed_as: Bizarre copy of %s */
4100 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_DESC(PL_op));
4102 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4108 if (dtype < SVt_REGEXP)
4110 if (dtype >= SVt_PV) {
4116 sv_upgrade(dstr, SVt_REGEXP);
4120 /* case SVt_DUMMY: */
4124 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4126 if (SvTYPE(sstr) != stype)
4127 stype = SvTYPE(sstr);
4129 if (isGV_with_GP(sstr) && dtype <= SVt_PVLV) {
4130 glob_assign_glob(dstr, sstr, dtype);
4133 if (stype == SVt_PVLV)
4135 if (isREGEXP(sstr)) goto upgregexp;
4136 SvUPGRADE(dstr, SVt_PVNV);
4139 SvUPGRADE(dstr, (svtype)stype);
4141 end_of_first_switch:
4143 /* dstr may have been upgraded. */
4144 dtype = SvTYPE(dstr);
4145 sflags = SvFLAGS(sstr);
4147 if (dtype == SVt_PVCV) {
4148 /* Assigning to a subroutine sets the prototype. */
4151 const char *const ptr = SvPV_const(sstr, len);
4153 SvGROW(dstr, len + 1);
4154 Copy(ptr, SvPVX(dstr), len + 1, char);
4155 SvCUR_set(dstr, len);
4157 SvFLAGS(dstr) |= sflags & SVf_UTF8;
4158 CvAUTOLOAD_off(dstr);
4163 else if (dtype == SVt_PVAV || dtype == SVt_PVHV || dtype == SVt_PVFM) {
4164 const char * const type = sv_reftype(dstr,0);
4166 /* diag_listed_as: Cannot copy to %s */
4167 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_DESC(PL_op));
4169 Perl_croak(aTHX_ "Cannot copy to %s", type);
4170 } else if (sflags & SVf_ROK) {
4171 if (isGV_with_GP(dstr)
4172 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
4175 if (GvIMPORTED(dstr) != GVf_IMPORTED
4176 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4178 GvIMPORTED_on(dstr);
4183 glob_assign_glob(dstr, sstr, dtype);
4187 if (dtype >= SVt_PV) {
4188 if (isGV_with_GP(dstr)) {
4189 glob_assign_ref(dstr, sstr);
4192 if (SvPVX_const(dstr)) {
4198 (void)SvOK_off(dstr);
4199 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4200 SvFLAGS(dstr) |= sflags & SVf_ROK;
4201 assert(!(sflags & SVp_NOK));
4202 assert(!(sflags & SVp_IOK));
4203 assert(!(sflags & SVf_NOK));
4204 assert(!(sflags & SVf_IOK));
4206 else if (isGV_with_GP(dstr)) {
4207 if (!(sflags & SVf_OK)) {
4208 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4209 "Undefined value assigned to typeglob");
4212 GV *gv = gv_fetchsv_nomg(sstr, GV_ADD, SVt_PVGV);
4213 if (dstr != (const SV *)gv) {
4214 const char * const name = GvNAME((const GV *)dstr);
4215 const STRLEN len = GvNAMELEN(dstr);
4216 HV *old_stash = NULL;
4217 bool reset_isa = FALSE;
4218 if ((len > 1 && name[len-2] == ':' && name[len-1] == ':')
4219 || (len == 1 && name[0] == ':')) {
4220 /* Set aside the old stash, so we can reset isa caches
4221 on its subclasses. */
4222 if((old_stash = GvHV(dstr))) {
4223 /* Make sure we do not lose it early. */
4224 SvREFCNT_inc_simple_void_NN(
4225 sv_2mortal((SV *)old_stash)
4232 gp_free(MUTABLE_GV(dstr));
4233 GvGP_set(dstr, gp_ref(GvGP(gv)));
4236 HV * const stash = GvHV(dstr);
4238 old_stash ? (HV *)HvENAME_get(old_stash) : stash
4248 else if ((dtype == SVt_REGEXP || dtype == SVt_PVLV)
4249 && (stype == SVt_REGEXP || isREGEXP(sstr))) {
4250 reg_temp_copy((REGEXP*)dstr, (REGEXP*)sstr);
4252 else if (sflags & SVp_POK) {
4254 const STRLEN cur = SvCUR(sstr);
4255 const STRLEN len = SvLEN(sstr);
4258 * Check to see if we can just swipe the string. If so, it's a
4259 * possible small lose on short strings, but a big win on long ones.
4260 * It might even be a win on short strings if SvPVX_const(dstr)
4261 * has to be allocated and SvPVX_const(sstr) has to be freed.
4262 * Likewise if we can set up COW rather than doing an actual copy, we
4263 * drop to the else clause, as the swipe code and the COW setup code
4264 * have much in common.
4267 /* Whichever path we take through the next code, we want this true,
4268 and doing it now facilitates the COW check. */
4269 (void)SvPOK_only(dstr);
4272 /* If we're already COW then this clause is not true, and if COW
4273 is allowed then we drop down to the else and make dest COW
4274 with us. If caller hasn't said that we're allowed to COW
4275 shared hash keys then we don't do the COW setup, even if the
4276 source scalar is a shared hash key scalar. */
4277 (((flags & SV_COW_SHARED_HASH_KEYS)
4278 ? !(sflags & SVf_IsCOW)
4279 #ifdef PERL_NEW_COPY_ON_WRITE
4281 ((!GE_COWBUF_THRESHOLD(cur) && SvLEN(dstr) > cur)
4282 /* If this is a regular (non-hek) COW, only so many COW
4283 "copies" are possible. */
4284 || CowREFCNT(sstr) == SV_COW_REFCNT_MAX))
4286 : 1 /* If making a COW copy is forbidden then the behaviour we
4287 desire is as if the source SV isn't actually already
4288 COW, even if it is. So we act as if the source flags
4289 are not COW, rather than actually testing them. */
4291 #ifndef PERL_ANY_COW
4292 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
4293 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
4294 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
4295 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
4296 but in turn, it's somewhat dead code, never expected to go
4297 live, but more kept as a placeholder on how to do it better
4298 in a newer implementation. */
4299 /* If we are COW and dstr is a suitable target then we drop down
4300 into the else and make dest a COW of us. */
4301 || (SvFLAGS(dstr) & SVf_BREAK)
4306 #ifdef PERL_NEW_COPY_ON_WRITE
4307 /* slated for free anyway (and not COW)? */
4308 (sflags & (SVs_TEMP|SVf_IsCOW)) == SVs_TEMP &&
4310 (sflags & SVs_TEMP) && /* slated for free anyway? */
4312 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4313 (!(flags & SV_NOSTEAL)) &&
4314 /* and we're allowed to steal temps */
4315 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4316 len) /* and really is a string */
4318 && ((flags & SV_COW_SHARED_HASH_KEYS)
4319 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4320 # ifdef PERL_OLD_COPY_ON_WRITE
4321 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4322 && SvTYPE(sstr) >= SVt_PVIV
4324 && !(SvFLAGS(dstr) & SVf_BREAK)
4325 && !(sflags & SVf_IsCOW)
4326 && GE_COW_THRESHOLD(cur) && cur+1 < len
4327 && (GE_COWBUF_THRESHOLD(cur) || SvLEN(dstr) < cur+1)
4333 /* Failed the swipe test, and it's not a shared hash key either.
4334 Have to copy the string. */
4335 SvGROW(dstr, cur + 1); /* inlined from sv_setpvn */
4336 Move(SvPVX_const(sstr),SvPVX(dstr),cur,char);
4337 SvCUR_set(dstr, cur);
4338 *SvEND(dstr) = '\0';
4340 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4342 /* Either it's a shared hash key, or it's suitable for
4343 copy-on-write or we can swipe the string. */
4345 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4351 if (!(sflags & SVf_IsCOW)) {
4353 # ifdef PERL_OLD_COPY_ON_WRITE
4354 /* Make the source SV into a loop of 1.
4355 (about to become 2) */
4356 SV_COW_NEXT_SV_SET(sstr, sstr);
4358 CowREFCNT(sstr) = 0;
4363 /* Initial code is common. */
4364 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4369 /* making another shared SV. */
4372 # ifdef PERL_OLD_COPY_ON_WRITE
4373 assert (SvTYPE(dstr) >= SVt_PVIV);
4374 /* SvIsCOW_normal */
4375 /* splice us in between source and next-after-source. */
4376 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4377 SV_COW_NEXT_SV_SET(sstr, dstr);
4381 SvPV_set(dstr, SvPVX_mutable(sstr));
4385 /* SvIsCOW_shared_hash */
4386 DEBUG_C(PerlIO_printf(Perl_debug_log,
4387 "Copy on write: Sharing hash\n"));
4389 assert (SvTYPE(dstr) >= SVt_PV);
4391 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4393 SvLEN_set(dstr, len);
4394 SvCUR_set(dstr, cur);
4398 { /* Passes the swipe test. */
4399 SvPV_set(dstr, SvPVX_mutable(sstr));
4400 SvLEN_set(dstr, SvLEN(sstr));
4401 SvCUR_set(dstr, SvCUR(sstr));
4404 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4405 SvPV_set(sstr, NULL);
4411 if (sflags & SVp_NOK) {
4412 SvNV_set(dstr, SvNVX(sstr));
4414 if (sflags & SVp_IOK) {
4415 SvIV_set(dstr, SvIVX(sstr));
4416 /* Must do this otherwise some other overloaded use of 0x80000000
4417 gets confused. I guess SVpbm_VALID */
4418 if (sflags & SVf_IVisUV)
4421 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
4423 const MAGIC * const smg = SvVSTRING_mg(sstr);
4425 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4426 smg->mg_ptr, smg->mg_len);
4427 SvRMAGICAL_on(dstr);
4431 else if (sflags & (SVp_IOK|SVp_NOK)) {
4432 (void)SvOK_off(dstr);
4433 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
4434 if (sflags & SVp_IOK) {
4435 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4436 SvIV_set(dstr, SvIVX(sstr));
4438 if (sflags & SVp_NOK) {
4439 SvNV_set(dstr, SvNVX(sstr));
4443 if (isGV_with_GP(sstr)) {
4444 gv_efullname3(dstr, MUTABLE_GV(sstr), "*");
4447 (void)SvOK_off(dstr);
4449 if (SvTAINTED(sstr))
4454 =for apidoc sv_setsv_mg
4456 Like C<sv_setsv>, but also handles 'set' magic.
4462 Perl_sv_setsv_mg(pTHX_ SV *const dstr, SV *const sstr)
4464 PERL_ARGS_ASSERT_SV_SETSV_MG;
4466 sv_setsv(dstr,sstr);
4471 # ifdef PERL_OLD_COPY_ON_WRITE
4472 # define SVt_COW SVt_PVIV
4474 # define SVt_COW SVt_PV
4477 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4479 STRLEN cur = SvCUR(sstr);
4480 STRLEN len = SvLEN(sstr);
4483 PERL_ARGS_ASSERT_SV_SETSV_COW;
4486 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4487 (void*)sstr, (void*)dstr);
4494 if (SvTHINKFIRST(dstr))
4495 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4496 else if (SvPVX_const(dstr))
4497 Safefree(SvPVX_mutable(dstr));
4501 SvUPGRADE(dstr, SVt_COW);
4503 assert (SvPOK(sstr));
4504 assert (SvPOKp(sstr));
4505 # ifdef PERL_OLD_COPY_ON_WRITE
4506 assert (!SvIOK(sstr));
4507 assert (!SvIOKp(sstr));
4508 assert (!SvNOK(sstr));
4509 assert (!SvNOKp(sstr));
4512 if (SvIsCOW(sstr)) {
4514 if (SvLEN(sstr) == 0) {
4515 /* source is a COW shared hash key. */
4516 DEBUG_C(PerlIO_printf(Perl_debug_log,
4517 "Fast copy on write: Sharing hash\n"));
4518 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4521 # ifdef PERL_OLD_COPY_ON_WRITE
4522 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4524 assert(SvCUR(sstr)+1 < SvLEN(sstr));
4525 assert(CowREFCNT(sstr) < SV_COW_REFCNT_MAX);
4528 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4529 SvUPGRADE(sstr, SVt_COW);
4531 DEBUG_C(PerlIO_printf(Perl_debug_log,
4532 "Fast copy on write: Converting sstr to COW\n"));
4533 # ifdef PERL_OLD_COPY_ON_WRITE
4534 SV_COW_NEXT_SV_SET(dstr, sstr);
4536 CowREFCNT(sstr) = 0;
4539 # ifdef PERL_OLD_COPY_ON_WRITE
4540 SV_COW_NEXT_SV_SET(sstr, dstr);
4544 new_pv = SvPVX_mutable(sstr);
4547 SvPV_set(dstr, new_pv);
4548 SvFLAGS(dstr) = (SVt_COW|SVf_POK|SVp_POK|SVf_IsCOW);
4551 SvLEN_set(dstr, len);
4552 SvCUR_set(dstr, cur);
4561 =for apidoc sv_setpvn
4563 Copies a string into an SV. The C<len> parameter indicates the number of
4564 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4565 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4571 Perl_sv_setpvn(pTHX_ SV *const sv, const char *const ptr, const STRLEN len)
4576 PERL_ARGS_ASSERT_SV_SETPVN;
4578 SV_CHECK_THINKFIRST_COW_DROP(sv);
4584 /* len is STRLEN which is unsigned, need to copy to signed */
4587 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen %"
4590 SvUPGRADE(sv, SVt_PV);
4592 dptr = SvGROW(sv, len + 1);
4593 Move(ptr,dptr,len,char);
4596 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4598 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4602 =for apidoc sv_setpvn_mg
4604 Like C<sv_setpvn>, but also handles 'set' magic.
4610 Perl_sv_setpvn_mg(pTHX_ SV *const sv, const char *const ptr, const STRLEN len)
4612 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4614 sv_setpvn(sv,ptr,len);
4619 =for apidoc sv_setpv
4621 Copies a string into an SV. The string must be null-terminated. Does not
4622 handle 'set' magic. See C<sv_setpv_mg>.
4628 Perl_sv_setpv(pTHX_ SV *const sv, const char *const ptr)
4633 PERL_ARGS_ASSERT_SV_SETPV;
4635 SV_CHECK_THINKFIRST_COW_DROP(sv);
4641 SvUPGRADE(sv, SVt_PV);
4643 SvGROW(sv, len + 1);
4644 Move(ptr,SvPVX(sv),len+1,char);
4646 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4648 if (SvTYPE(sv) == SVt_PVCV) CvAUTOLOAD_off(sv);
4652 =for apidoc sv_setpv_mg
4654 Like C<sv_setpv>, but also handles 'set' magic.
4660 Perl_sv_setpv_mg(pTHX_ SV *const sv, const char *const ptr)
4662 PERL_ARGS_ASSERT_SV_SETPV_MG;
4669 Perl_sv_sethek(pTHX_ SV *const sv, const HEK *const hek)
4673 PERL_ARGS_ASSERT_SV_SETHEK;
4679 if (HEK_LEN(hek) == HEf_SVKEY) {
4680 sv_setsv(sv, *(SV**)HEK_KEY(hek));
4683 const int flags = HEK_FLAGS(hek);
4684 if (flags & HVhek_WASUTF8) {
4685 STRLEN utf8_len = HEK_LEN(hek);
4686 char *as_utf8 = (char *)bytes_to_utf8((U8*)HEK_KEY(hek), &utf8_len);
4687 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
4690 } else if (flags & HVhek_UNSHARED) {
4691 sv_setpvn(sv, HEK_KEY(hek), HEK_LEN(hek));
4694 else SvUTF8_off(sv);
4698 SV_CHECK_THINKFIRST_COW_DROP(sv);
4699 SvUPGRADE(sv, SVt_PV);
4700 Safefree(SvPVX(sv));
4701 SvPV_set(sv,(char *)HEK_KEY(share_hek_hek(hek)));
4702 SvCUR_set(sv, HEK_LEN(hek));
4708 else SvUTF8_off(sv);
4716 =for apidoc sv_usepvn_flags
4718 Tells an SV to use C<ptr> to find its string value. Normally the
4719 string is stored inside the SV but sv_usepvn allows the SV to use an
4720 outside string. The C<ptr> should point to memory that was allocated
4721 by C<malloc>. It must be the start of a mallocked block
4722 of memory, and not a pointer to the middle of it. The
4723 string length, C<len>, must be supplied. By default
4724 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4725 so that pointer should not be freed or used by the programmer after
4726 giving it to sv_usepvn, and neither should any pointers from "behind"
4727 that pointer (e.g. ptr + 1) be used.
4729 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4730 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4731 will be skipped (i.e. the buffer is actually at least 1 byte longer than
4732 C<len>, and already meets the requirements for storing in C<SvPVX>).
4738 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4743 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4745 SV_CHECK_THINKFIRST_COW_DROP(sv);
4746 SvUPGRADE(sv, SVt_PV);
4749 if (flags & SV_SMAGIC)
4753 if (SvPVX_const(sv))
4757 if (flags & SV_HAS_TRAILING_NUL)
4758 assert(ptr[len] == '\0');
4761 allocate = (flags & SV_HAS_TRAILING_NUL)
4763 #ifdef Perl_safesysmalloc_size
4766 PERL_STRLEN_ROUNDUP(len + 1);
4768 if (flags & SV_HAS_TRAILING_NUL) {
4769 /* It's long enough - do nothing.
4770 Specifically Perl_newCONSTSUB is relying on this. */
4773 /* Force a move to shake out bugs in callers. */
4774 char *new_ptr = (char*)safemalloc(allocate);
4775 Copy(ptr, new_ptr, len, char);
4776 PoisonFree(ptr,len,char);
4780 ptr = (char*) saferealloc (ptr, allocate);
4783 #ifdef Perl_safesysmalloc_size
4784 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4786 SvLEN_set(sv, allocate);
4790 if (!(flags & SV_HAS_TRAILING_NUL)) {
4793 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4795 if (flags & SV_SMAGIC)
4799 #ifdef PERL_OLD_COPY_ON_WRITE
4800 /* Need to do this *after* making the SV normal, as we need the buffer
4801 pointer to remain valid until after we've copied it. If we let go too early,
4802 another thread could invalidate it by unsharing last of the same hash key
4803 (which it can do by means other than releasing copy-on-write Svs)
4804 or by changing the other copy-on-write SVs in the loop. */
4806 S_sv_release_COW(pTHX_ SV *sv, const char *pvx, SV *after)
4808 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4810 { /* this SV was SvIsCOW_normal(sv) */
4811 /* we need to find the SV pointing to us. */
4812 SV *current = SV_COW_NEXT_SV(after);
4814 if (current == sv) {
4815 /* The SV we point to points back to us (there were only two of us
4817 Hence other SV is no longer copy on write either. */
4820 /* We need to follow the pointers around the loop. */
4822 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4825 /* don't loop forever if the structure is bust, and we have
4826 a pointer into a closed loop. */
4827 assert (current != after);
4828 assert (SvPVX_const(current) == pvx);
4830 /* Make the SV before us point to the SV after us. */
4831 SV_COW_NEXT_SV_SET(current, after);
4837 =for apidoc sv_force_normal_flags
4839 Undo various types of fakery on an SV, where fakery means
4840 "more than" a string: if the PV is a shared string, make
4841 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4842 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4843 we do the copy, and is also used locally; if this is a
4844 vstring, drop the vstring magic. If C<SV_COW_DROP_PV> is set
4845 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4846 SvPOK_off rather than making a copy. (Used where this
4847 scalar is about to be set to some other value.) In addition,
4848 the C<flags> parameter gets passed to C<sv_unref_flags()>
4849 when unreffing. C<sv_force_normal> calls this function
4850 with flags set to 0.
4856 Perl_sv_force_normal_flags(pTHX_ SV *const sv, const U32 flags)
4860 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4863 if (SvREADONLY(sv)) {
4864 Perl_croak_no_modify();
4866 else if (SvIsCOW(sv)) {
4867 const char * const pvx = SvPVX_const(sv);
4868 const STRLEN len = SvLEN(sv);
4869 const STRLEN cur = SvCUR(sv);
4870 # ifdef PERL_OLD_COPY_ON_WRITE
4871 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4872 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4873 we'll fail an assertion. */
4874 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4878 PerlIO_printf(Perl_debug_log,
4879 "Copy on write: Force normal %ld\n",
4884 # ifdef PERL_NEW_COPY_ON_WRITE
4885 if (len && CowREFCNT(sv) == 0)
4886 /* We own the buffer ourselves. */
4892 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4893 # ifdef PERL_NEW_COPY_ON_WRITE
4894 /* Must do this first, since the macro uses SvPVX. */
4895 if (len) CowREFCNT(sv)--;
4899 if (flags & SV_COW_DROP_PV) {
4900 /* OK, so we don't need to copy our buffer. */
4903 SvGROW(sv, cur + 1);
4904 Move(pvx,SvPVX(sv),cur,char);
4909 # ifdef PERL_OLD_COPY_ON_WRITE
4910 sv_release_COW(sv, pvx, next);
4913 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4921 if (SvREADONLY(sv)) {
4922 Perl_croak_no_modify();
4926 const char * const pvx = SvPVX_const(sv);
4927 const STRLEN len = SvCUR(sv);
4931 if (flags & SV_COW_DROP_PV) {
4932 /* OK, so we don't need to copy our buffer. */
4935 SvGROW(sv, len + 1);
4936 Move(pvx,SvPVX(sv),len,char);
4939 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4943 sv_unref_flags(sv, flags);
4944 else if (SvFAKE(sv) && isGV_with_GP(sv))
4945 sv_unglob(sv, flags);
4946 else if (SvFAKE(sv) && isREGEXP(sv)) {
4947 /* Need to downgrade the REGEXP to a simple(r) scalar. This is analogous
4948 to sv_unglob. We only need it here, so inline it. */
4949 const bool islv = SvTYPE(sv) == SVt_PVLV;
4950 const svtype new_type =
4951 islv ? SVt_NULL : SvMAGIC(sv) || SvSTASH(sv) ? SVt_PVMG : SVt_PV;
4952 SV *const temp = newSV_type(new_type);
4953 regexp *const temp_p = ReANY((REGEXP *)sv);
4955 if (new_type == SVt_PVMG) {
4956 SvMAGIC_set(temp, SvMAGIC(sv));
4957 SvMAGIC_set(sv, NULL);
4958 SvSTASH_set(temp, SvSTASH(sv));
4959 SvSTASH_set(sv, NULL);
4961 if (!islv) SvCUR_set(temp, SvCUR(sv));
4962 /* Remember that SvPVX is in the head, not the body. But
4963 RX_WRAPPED is in the body. */
4964 assert(ReANY((REGEXP *)sv)->mother_re);
4965 /* Their buffer is already owned by someone else. */
4966 if (flags & SV_COW_DROP_PV) {
4967 /* SvLEN is already 0. For SVt_REGEXP, we have a brand new
4968 zeroed body. For SVt_PVLV, it should have been set to 0
4969 before turning into a regexp. */
4970 assert(!SvLEN(islv ? sv : temp));
4971 sv->sv_u.svu_pv = 0;
4974 sv->sv_u.svu_pv = savepvn(RX_WRAPPED((REGEXP *)sv), SvCUR(sv));
4975 SvLEN_set(islv ? sv : temp, SvCUR(sv)+1);
4979 /* Now swap the rest of the bodies. */
4983 SvFLAGS(sv) &= ~SVTYPEMASK;
4984 SvFLAGS(sv) |= new_type;
4985 SvANY(sv) = SvANY(temp);
4988 SvFLAGS(temp) &= ~(SVTYPEMASK);
4989 SvFLAGS(temp) |= SVt_REGEXP|SVf_FAKE;
4990 SvANY(temp) = temp_p;
4991 temp->sv_u.svu_rx = (regexp *)temp_p;
4993 SvREFCNT_dec_NN(temp);
4995 else if (SvVOK(sv)) sv_unmagic(sv, PERL_MAGIC_vstring);
5001 Efficient removal of characters from the beginning of the string buffer.
5002 SvPOK(sv), or at least SvPOKp(sv), must be true and the C<ptr> must be a
5003 pointer to somewhere inside the string buffer. The C<ptr> becomes the first
5004 character of the adjusted string. Uses the "OOK hack". On return, only
5005 SvPOK(sv) and SvPOKp(sv) among the OK flags will be true.
5007 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
5008 refer to the same chunk of data.
5010 The unfortunate similarity of this function's name to that of Perl's C<chop>
5011 operator is strictly coincidental. This function works from the left;
5012 C<chop> works from the right.
5018 Perl_sv_chop(pTHX_ SV *const sv, const char *const ptr)
5029 PERL_ARGS_ASSERT_SV_CHOP;
5031 if (!ptr || !SvPOKp(sv))
5033 delta = ptr - SvPVX_const(sv);
5035 /* Nothing to do. */
5038 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
5039 if (delta > max_delta)
5040 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
5041 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
5042 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), so don't use ptr any more */
5043 SV_CHECK_THINKFIRST(sv);
5044 SvPOK_only_UTF8(sv);
5047 if (!SvLEN(sv)) { /* make copy of shared string */
5048 const char *pvx = SvPVX_const(sv);
5049 const STRLEN len = SvCUR(sv);
5050 SvGROW(sv, len + 1);
5051 Move(pvx,SvPVX(sv),len,char);
5057 SvOOK_offset(sv, old_delta);
5059 SvLEN_set(sv, SvLEN(sv) - delta);
5060 SvCUR_set(sv, SvCUR(sv) - delta);
5061 SvPV_set(sv, SvPVX(sv) + delta);
5063 p = (U8 *)SvPVX_const(sv);
5066 /* how many bytes were evacuated? we will fill them with sentinel
5067 bytes, except for the part holding the new offset of course. */
5070 evacn += (old_delta < 0x100 ? 1 : 1 + sizeof(STRLEN));
5072 assert(evacn <= delta + old_delta);
5078 if (delta < 0x100) {
5082 p -= sizeof(STRLEN);
5083 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
5087 /* Fill the preceding buffer with sentinals to verify that no-one is
5097 =for apidoc sv_catpvn
5099 Concatenates the string onto the end of the string which is in the SV. The
5100 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5101 status set, then the bytes appended should be valid UTF-8.
5102 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5104 =for apidoc sv_catpvn_flags
5106 Concatenates the string onto the end of the string which is in the SV. The
5107 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5108 status set, then the bytes appended should be valid UTF-8.
5109 If C<flags> has the C<SV_SMAGIC> bit set, will
5110 C<mg_set> on C<dsv> afterwards if appropriate.
5111 C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5112 in terms of this function.
5118 Perl_sv_catpvn_flags(pTHX_ SV *const dsv, const char *sstr, const STRLEN slen, const I32 flags)
5122 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
5124 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
5125 assert((flags & (SV_CATBYTES|SV_CATUTF8)) != (SV_CATBYTES|SV_CATUTF8));
5127 if (!(flags & SV_CATBYTES) || !SvUTF8(dsv)) {
5128 if (flags & SV_CATUTF8 && !SvUTF8(dsv)) {
5129 sv_utf8_upgrade_flags_grow(dsv, 0, slen + 1);
5132 else SvGROW(dsv, dlen + slen + 1);
5134 sstr = SvPVX_const(dsv);
5135 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5136 SvCUR_set(dsv, SvCUR(dsv) + slen);
5139 /* We inline bytes_to_utf8, to avoid an extra malloc. */
5140 const char * const send = sstr + slen;
5143 /* Something this code does not account for, which I think is
5144 impossible; it would require the same pv to be treated as
5145 bytes *and* utf8, which would indicate a bug elsewhere. */
5146 assert(sstr != dstr);
5148 SvGROW(dsv, dlen + slen * 2 + 1);
5149 d = (U8 *)SvPVX(dsv) + dlen;
5151 while (sstr < send) {
5152 const UV uv = NATIVE_TO_ASCII((U8)*sstr++);
5153 if (UNI_IS_INVARIANT(uv))
5154 *d++ = (U8)UTF_TO_NATIVE(uv);
5156 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
5157 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
5160 SvCUR_set(dsv, d-(const U8 *)SvPVX(dsv));
5163 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5165 if (flags & SV_SMAGIC)
5170 =for apidoc sv_catsv
5172 Concatenates the string from SV C<ssv> onto the end of the string in SV
5173 C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5174 Handles 'get' magic on both SVs, but no 'set' magic. See C<sv_catsv_mg> and
5177 =for apidoc sv_catsv_flags
5179 Concatenates the string from SV C<ssv> onto the end of the string in SV
5180 C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
5181 If C<flags> include C<SV_GMAGIC> bit set, will call C<mg_get> on both SVs if
5182 appropriate. If C<flags> include C<SV_SMAGIC>, C<mg_set> will be called on
5183 the modified SV afterward, if appropriate. C<sv_catsv>, C<sv_catsv_nomg>,
5184 and C<sv_catsv_mg> are implemented in terms of this function.
5189 Perl_sv_catsv_flags(pTHX_ SV *const dsv, SV *const ssv, const I32 flags)
5193 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
5197 const char *spv = SvPV_flags_const(ssv, slen, flags);
5199 if (flags & SV_GMAGIC)
5201 sv_catpvn_flags(dsv, spv, slen,
5202 DO_UTF8(ssv) ? SV_CATUTF8 : SV_CATBYTES);
5203 if (flags & SV_SMAGIC)
5210 =for apidoc sv_catpv
5212 Concatenates the string onto the end of the string which is in the SV.
5213 If the SV has the UTF-8 status set, then the bytes appended should be
5214 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5219 Perl_sv_catpv(pTHX_ SV *const sv, const char *ptr)
5226 PERL_ARGS_ASSERT_SV_CATPV;
5230 junk = SvPV_force(sv, tlen);
5232 SvGROW(sv, tlen + len + 1);
5234 ptr = SvPVX_const(sv);
5235 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5236 SvCUR_set(sv, SvCUR(sv) + len);
5237 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5242 =for apidoc sv_catpv_flags
5244 Concatenates the string onto the end of the string which is in the SV.
5245 If the SV has the UTF-8 status set, then the bytes appended should
5246 be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
5247 on the modified SV if appropriate.
5253 Perl_sv_catpv_flags(pTHX_ SV *dstr, const char *sstr, const I32 flags)
5255 PERL_ARGS_ASSERT_SV_CATPV_FLAGS;
5256 sv_catpvn_flags(dstr, sstr, strlen(sstr), flags);
5260 =for apidoc sv_catpv_mg
5262 Like C<sv_catpv>, but also handles 'set' magic.
5268 Perl_sv_catpv_mg(pTHX_ SV *const sv, const char *const ptr)
5270 PERL_ARGS_ASSERT_SV_CATPV_MG;
5279 Creates a new SV. A non-zero C<len> parameter indicates the number of
5280 bytes of preallocated string space the SV should have. An extra byte for a
5281 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
5282 space is allocated.) The reference count for the new SV is set to 1.
5284 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5285 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5286 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5287 L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
5288 modules supporting older perls.
5294 Perl_newSV(pTHX_ const STRLEN len)
5301 sv_upgrade(sv, SVt_PV);
5302 SvGROW(sv, len + 1);
5307 =for apidoc sv_magicext
5309 Adds magic to an SV, upgrading it if necessary. Applies the
5310 supplied vtable and returns a pointer to the magic added.
5312 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5313 In particular, you can add magic to SvREADONLY SVs, and add more than
5314 one instance of the same 'how'.
5316 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5317 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5318 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5319 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5321 (This is now used as a subroutine by C<sv_magic>.)
5326 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
5327 const MGVTBL *const vtable, const char *const name, const I32 namlen)
5332 PERL_ARGS_ASSERT_SV_MAGICEXT;
5334 SvUPGRADE(sv, SVt_PVMG);
5335 Newxz(mg, 1, MAGIC);
5336 mg->mg_moremagic = SvMAGIC(sv);
5337 SvMAGIC_set(sv, mg);
5339 /* Sometimes a magic contains a reference loop, where the sv and
5340 object refer to each other. To prevent a reference loop that
5341 would prevent such objects being freed, we look for such loops
5342 and if we find one we avoid incrementing the object refcount.
5344 Note we cannot do this to avoid self-tie loops as intervening RV must
5345 have its REFCNT incremented to keep it in existence.
5348 if (!obj || obj == sv ||
5349 how == PERL_MAGIC_arylen ||
5350 how == PERL_MAGIC_symtab ||
5351 (SvTYPE(obj) == SVt_PVGV &&
5352 (GvSV(obj) == sv || GvHV(obj) == (const HV *)sv
5353 || GvAV(obj) == (const AV *)sv || GvCV(obj) == (const CV *)sv
5354 || GvIOp(obj) == (const IO *)sv || GvFORM(obj) == (const CV *)sv)))
5359 mg->mg_obj = SvREFCNT_inc_simple(obj);
5360 mg->mg_flags |= MGf_REFCOUNTED;
5363 /* Normal self-ties simply pass a null object, and instead of
5364 using mg_obj directly, use the SvTIED_obj macro to produce a
5365 new RV as needed. For glob "self-ties", we are tieing the PVIO
5366 with an RV obj pointing to the glob containing the PVIO. In
5367 this case, to avoid a reference loop, we need to weaken the
5371 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5372 obj && SvROK(obj) && GvIO(SvRV(obj)) == (const IO *)sv)
5378 mg->mg_len = namlen;
5381 mg->mg_ptr = savepvn(name, namlen);
5382 else if (namlen == HEf_SVKEY) {
5383 /* Yes, this is casting away const. This is only for the case of
5384 HEf_SVKEY. I think we need to document this aberation of the
5385 constness of the API, rather than making name non-const, as
5386 that change propagating outwards a long way. */
5387 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV *)name);
5389 mg->mg_ptr = (char *) name;
5391 mg->mg_virtual = (MGVTBL *) vtable;
5398 =for apidoc sv_magic
5400 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
5401 necessary, then adds a new magic item of type C<how> to the head of the
5404 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5405 handling of the C<name> and C<namlen> arguments.
5407 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5408 to add more than one instance of the same 'how'.
5414 Perl_sv_magic(pTHX_ SV *const sv, SV *const obj, const int how,
5415 const char *const name, const I32 namlen)
5418 const MGVTBL *vtable;
5421 unsigned int vtable_index;
5423 PERL_ARGS_ASSERT_SV_MAGIC;
5425 if (how < 0 || (unsigned)how > C_ARRAY_LENGTH(PL_magic_data)
5426 || ((flags = PL_magic_data[how]),
5427 (vtable_index = flags & PERL_MAGIC_VTABLE_MASK)
5428 > magic_vtable_max))
5429 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5431 /* PERL_MAGIC_ext is reserved for use by extensions not perl internals.
5432 Useful for attaching extension internal data to perl vars.
5433 Note that multiple extensions may clash if magical scalars
5434 etc holding private data from one are passed to another. */
5436 vtable = (vtable_index == magic_vtable_max)
5437 ? NULL : PL_magic_vtables + vtable_index;
5439 #ifdef PERL_OLD_COPY_ON_WRITE
5441 sv_force_normal_flags(sv, 0);
5443 if (SvREADONLY(sv)) {
5445 /* its okay to attach magic to shared strings */
5449 && !PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(how)
5452 Perl_croak_no_modify();
5455 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5456 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5457 /* sv_magic() refuses to add a magic of the same 'how' as an
5460 if (how == PERL_MAGIC_taint)
5466 /* Rest of work is done else where */
5467 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5470 case PERL_MAGIC_taint:
5473 case PERL_MAGIC_ext:
5474 case PERL_MAGIC_dbfile:
5481 S_sv_unmagicext_flags(pTHX_ SV *const sv, const int type, MGVTBL *vtbl, const U32 flags)
5488 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5490 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
5491 for (mg = *mgp; mg; mg = *mgp) {
5492 const MGVTBL* const virt = mg->mg_virtual;
5493 if (mg->mg_type == type && (!flags || virt == vtbl)) {
5494 *mgp = mg->mg_moremagic;
5495 if (virt && virt->svt_free)
5496 virt->svt_free(aTHX_ sv, mg);
5497 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5499 Safefree(mg->mg_ptr);
5500 else if (mg->mg_len == HEf_SVKEY)
5501 SvREFCNT_dec(MUTABLE_SV(mg->mg_ptr));
5502 else if (mg->mg_type == PERL_MAGIC_utf8)
5503 Safefree(mg->mg_ptr);
5505 if (mg->mg_flags & MGf_REFCOUNTED)
5506 SvREFCNT_dec(mg->mg_obj);
5510 mgp = &mg->mg_moremagic;
5513 if (SvMAGICAL(sv)) /* if we're under save_magic, wait for restore_magic; */
5514 mg_magical(sv); /* else fix the flags now */
5518 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5524 =for apidoc sv_unmagic
5526 Removes all magic of type C<type> from an SV.
5532 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
5534 PERL_ARGS_ASSERT_SV_UNMAGIC;
5535 return S_sv_unmagicext_flags(aTHX_ sv, type, NULL, 0);
5539 =for apidoc sv_unmagicext
5541 Removes all magic of type C<type> with the specified C<vtbl> from an SV.
5547 Perl_sv_unmagicext(pTHX_ SV *const sv, const int type, MGVTBL *vtbl)
5549 PERL_ARGS_ASSERT_SV_UNMAGICEXT;
5550 return S_sv_unmagicext_flags(aTHX_ sv, type, vtbl, 1);
5554 =for apidoc sv_rvweaken
5556 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5557 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5558 push a back-reference to this RV onto the array of backreferences
5559 associated with that magic. If the RV is magical, set magic will be
5560 called after the RV is cleared.
5566 Perl_sv_rvweaken(pTHX_ SV *const sv)
5570 PERL_ARGS_ASSERT_SV_RVWEAKEN;
5572 if (!SvOK(sv)) /* let undefs pass */
5575 Perl_croak(aTHX_ "Can't weaken a nonreference");
5576 else if (SvWEAKREF(sv)) {
5577 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5580 else if (SvREADONLY(sv)) croak_no_modify();
5582 Perl_sv_add_backref(aTHX_ tsv, sv);
5584 SvREFCNT_dec_NN(tsv);
5588 /* Give tsv backref magic if it hasn't already got it, then push a
5589 * back-reference to sv onto the array associated with the backref magic.
5591 * As an optimisation, if there's only one backref and it's not an AV,
5592 * store it directly in the HvAUX or mg_obj slot, avoiding the need to
5593 * allocate an AV. (Whether the slot holds an AV tells us whether this is
5597 /* A discussion about the backreferences array and its refcount:
5599 * The AV holding the backreferences is pointed to either as the mg_obj of
5600 * PERL_MAGIC_backref, or in the specific case of a HV, from the
5601 * xhv_backreferences field. The array is created with a refcount
5602 * of 2. This means that if during global destruction the array gets
5603 * picked on before its parent to have its refcount decremented by the
5604 * random zapper, it won't actually be freed, meaning it's still there for
5605 * when its parent gets freed.
5607 * When the parent SV is freed, the extra ref is killed by
5608 * Perl_sv_kill_backrefs. The other ref is killed, in the case of magic,
5609 * by mg_free() / MGf_REFCOUNTED, or for a hash, by Perl_hv_kill_backrefs.
5611 * When a single backref SV is stored directly, it is not reference
5616 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5623 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5625 /* find slot to store array or singleton backref */
5627 if (SvTYPE(tsv) == SVt_PVHV) {
5628 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5631 (SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL))))
5633 sv_magic(tsv, NULL, PERL_MAGIC_backref, NULL, 0);
5634 mg = mg_find(tsv, PERL_MAGIC_backref);
5636 svp = &(mg->mg_obj);
5639 /* create or retrieve the array */
5641 if ( (!*svp && SvTYPE(sv) == SVt_PVAV)
5642 || (*svp && SvTYPE(*svp) != SVt_PVAV)
5647 SvREFCNT_inc_simple_void(av);
5648 /* av now has a refcnt of 2; see discussion above */
5650 /* move single existing backref to the array */
5652 AvARRAY(av)[++AvFILLp(av)] = *svp; /* av_push() */
5656 mg->mg_flags |= MGf_REFCOUNTED;
5659 av = MUTABLE_AV(*svp);
5662 /* optimisation: store single backref directly in HvAUX or mg_obj */
5666 /* push new backref */
5667 assert(SvTYPE(av) == SVt_PVAV);
5668 if (AvFILLp(av) >= AvMAX(av)) {
5669 av_extend(av, AvFILLp(av)+1);
5671 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5674 /* delete a back-reference to ourselves from the backref magic associated
5675 * with the SV we point to.
5679 Perl_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5684 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5686 if (SvTYPE(tsv) == SVt_PVHV) {
5688 svp = (SV**)Perl_hv_backreferences_p(aTHX_ MUTABLE_HV(tsv));
5690 else if (SvIS_FREED(tsv) && PL_phase == PERL_PHASE_DESTRUCT) {
5691 /* It's possible for the the last (strong) reference to tsv to have
5692 become freed *before* the last thing holding a weak reference.
5693 If both survive longer than the backreferences array, then when
5694 the referent's reference count drops to 0 and it is freed, it's
5695 not able to chase the backreferences, so they aren't NULLed.
5697 For example, a CV holds a weak reference to its stash. If both the
5698 CV and the stash survive longer than the backreferences array,
5699 and the CV gets picked for the SvBREAK() treatment first,
5700 *and* it turns out that the stash is only being kept alive because
5701 of an our variable in the pad of the CV, then midway during CV
5702 destruction the stash gets freed, but CvSTASH() isn't set to NULL.
5703 It ends up pointing to the freed HV. Hence it's chased in here, and
5704 if this block wasn't here, it would hit the !svp panic just below.
5706 I don't believe that "better" destruction ordering is going to help
5707 here - during global destruction there's always going to be the
5708 chance that something goes out of order. We've tried to make it
5709 foolproof before, and it only resulted in evolutionary pressure on
5710 fools. Which made us look foolish for our hubris. :-(
5716 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5717 svp = mg ? &(mg->mg_obj) : NULL;
5721 Perl_croak(aTHX_ "panic: del_backref, svp=0");
5723 /* It's possible that sv is being freed recursively part way through the
5724 freeing of tsv. If this happens, the backreferences array of tsv has
5725 already been freed, and so svp will be NULL. If this is the case,
5726 we should not panic. Instead, nothing needs doing, so return. */
5727 if (PL_phase == PERL_PHASE_DESTRUCT && SvREFCNT(tsv) == 0)
5729 Perl_croak(aTHX_ "panic: del_backref, *svp=%p phase=%s refcnt=%" UVuf,
5730 *svp, PL_phase_names[PL_phase], (UV)SvREFCNT(tsv));
5733 if (SvTYPE(*svp) == SVt_PVAV) {
5737 AV * const av = (AV*)*svp;
5739 assert(!SvIS_FREED(av));
5743 /* for an SV with N weak references to it, if all those
5744 * weak refs are deleted, then sv_del_backref will be called
5745 * N times and O(N^2) compares will be done within the backref
5746 * array. To ameliorate this potential slowness, we:
5747 * 1) make sure this code is as tight as possible;
5748 * 2) when looking for SV, look for it at both the head and tail of the
5749 * array first before searching the rest, since some create/destroy
5750 * patterns will cause the backrefs to be freed in order.
5757 SV **p = &svp[fill];
5758 SV *const topsv = *p;
5765 /* We weren't the last entry.
5766 An unordered list has this property that you
5767 can take the last element off the end to fill
5768 the hole, and it's still an unordered list :-)
5774 break; /* should only be one */
5781 AvFILLp(av) = fill-1;
5783 else if (SvIS_FREED(*svp) && PL_phase == PERL_PHASE_DESTRUCT) {
5784 /* freed AV; skip */
5787 /* optimisation: only a single backref, stored directly */
5789 Perl_croak(aTHX_ "panic: del_backref, *svp=%p, sv=%p", *svp, sv);
5796 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5802 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5807 /* after multiple passes through Perl_sv_clean_all() for a thingy
5808 * that has badly leaked, the backref array may have gotten freed,
5809 * since we only protect it against 1 round of cleanup */
5810 if (SvIS_FREED(av)) {
5811 if (PL_in_clean_all) /* All is fair */
5814 "panic: magic_killbackrefs (freed backref AV/SV)");
5818 is_array = (SvTYPE(av) == SVt_PVAV);
5820 assert(!SvIS_FREED(av));
5823 last = svp + AvFILLp(av);
5826 /* optimisation: only a single backref, stored directly */
5832 while (svp <= last) {
5834 SV *const referrer = *svp;
5835 if (SvWEAKREF(referrer)) {
5836 /* XXX Should we check that it hasn't changed? */
5837 assert(SvROK(referrer));
5838 SvRV_set(referrer, 0);
5840 SvWEAKREF_off(referrer);
5841 SvSETMAGIC(referrer);
5842 } else if (SvTYPE(referrer) == SVt_PVGV ||
5843 SvTYPE(referrer) == SVt_PVLV) {
5844 assert(SvTYPE(sv) == SVt_PVHV); /* stash backref */
5845 /* You lookin' at me? */
5846 assert(GvSTASH(referrer));
5847 assert(GvSTASH(referrer) == (const HV *)sv);
5848 GvSTASH(referrer) = 0;
5849 } else if (SvTYPE(referrer) == SVt_PVCV ||
5850 SvTYPE(referrer) == SVt_PVFM) {
5851 if (SvTYPE(sv) == SVt_PVHV) { /* stash backref */
5852 /* You lookin' at me? */
5853 assert(CvSTASH(referrer));
5854 assert(CvSTASH(referrer) == (const HV *)sv);
5855 SvANY(MUTABLE_CV(referrer))->xcv_stash = 0;
5858 assert(SvTYPE(sv) == SVt_PVGV);
5859 /* You lookin' at me? */
5860 assert(CvGV(referrer));
5861 assert(CvGV(referrer) == (const GV *)sv);
5862 anonymise_cv_maybe(MUTABLE_GV(sv),
5863 MUTABLE_CV(referrer));
5868 "panic: magic_killbackrefs (flags=%"UVxf")",
5869 (UV)SvFLAGS(referrer));
5880 SvREFCNT_dec_NN(av); /* remove extra count added by sv_add_backref() */
5886 =for apidoc sv_insert
5888 Inserts a string at the specified offset/length within the SV. Similar to
5889 the Perl substr() function. Handles get magic.
5891 =for apidoc sv_insert_flags
5893 Same as C<sv_insert>, but the extra C<flags> are passed to the
5894 C<SvPV_force_flags> that applies to C<bigstr>.
5900 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5907 SSize_t i; /* better be sizeof(STRLEN) or bad things happen */
5910 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5913 Perl_croak(aTHX_ "Can't modify nonexistent substring");
5914 SvPV_force_flags(bigstr, curlen, flags);
5915 (void)SvPOK_only_UTF8(bigstr);
5916 if (offset + len > curlen) {
5917 SvGROW(bigstr, offset+len+1);
5918 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5919 SvCUR_set(bigstr, offset+len);
5923 i = littlelen - len;
5924 if (i > 0) { /* string might grow */
5925 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5926 mid = big + offset + len;
5927 midend = bigend = big + SvCUR(bigstr);
5930 while (midend > mid) /* shove everything down */
5931 *--bigend = *--midend;
5932 Move(little,big+offset,littlelen,char);
5933 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5938 Move(little,SvPVX(bigstr)+offset,len,char);
5943 big = SvPVX(bigstr);
5946 bigend = big + SvCUR(bigstr);
5948 if (midend > bigend)
5949 Perl_croak(aTHX_ "panic: sv_insert, midend=%p, bigend=%p",
5952 if (mid - big > bigend - midend) { /* faster to shorten from end */
5954 Move(little, mid, littlelen,char);
5957 i = bigend - midend;
5959 Move(midend, mid, i,char);
5963 SvCUR_set(bigstr, mid - big);
5965 else if ((i = mid - big)) { /* faster from front */
5966 midend -= littlelen;
5968 Move(big, midend - i, i, char);
5969 sv_chop(bigstr,midend-i);
5971 Move(little, mid, littlelen,char);
5973 else if (littlelen) {
5974 midend -= littlelen;
5975 sv_chop(bigstr,midend);
5976 Move(little,midend,littlelen,char);
5979 sv_chop(bigstr,midend);
5985 =for apidoc sv_replace
5987 Make the first argument a copy of the second, then delete the original.
5988 The target SV physically takes over ownership of the body of the source SV
5989 and inherits its flags; however, the target keeps any magic it owns,
5990 and any magic in the source is discarded.
5991 Note that this is a rather specialist SV copying operation; most of the
5992 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5998 Perl_sv_replace(pTHX_ SV *const sv, SV *const nsv)
6001 const U32 refcnt = SvREFCNT(sv);
6003 PERL_ARGS_ASSERT_SV_REPLACE;
6005 SV_CHECK_THINKFIRST_COW_DROP(sv);
6006 if (SvREFCNT(nsv) != 1) {
6007 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace()"
6008 " (%" UVuf " != 1)", (UV) SvREFCNT(nsv));
6010 if (SvMAGICAL(sv)) {
6014 sv_upgrade(nsv, SVt_PVMG);
6015 SvMAGIC_set(nsv, SvMAGIC(sv));
6016 SvFLAGS(nsv) |= SvMAGICAL(sv);
6018 SvMAGIC_set(sv, NULL);
6022 assert(!SvREFCNT(sv));
6023 #ifdef DEBUG_LEAKING_SCALARS
6024 sv->sv_flags = nsv->sv_flags;
6025 sv->sv_any = nsv->sv_any;
6026 sv->sv_refcnt = nsv->sv_refcnt;
6027 sv->sv_u = nsv->sv_u;
6029 StructCopy(nsv,sv,SV);
6031 if(SvTYPE(sv) == SVt_IV) {
6033 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
6037 #ifdef PERL_OLD_COPY_ON_WRITE
6038 if (SvIsCOW_normal(nsv)) {
6039 /* We need to follow the pointers around the loop to make the
6040 previous SV point to sv, rather than nsv. */
6043 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
6046 assert(SvPVX_const(current) == SvPVX_const(nsv));
6048 /* Make the SV before us point to the SV after us. */
6050 PerlIO_printf(Perl_debug_log, "previous is\n");
6052 PerlIO_printf(Perl_debug_log,
6053 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
6054 (UV) SV_COW_NEXT_SV(current), (UV) sv);
6056 SV_COW_NEXT_SV_SET(current, sv);
6059 SvREFCNT(sv) = refcnt;
6060 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
6065 /* We're about to free a GV which has a CV that refers back to us.
6066 * If that CV will outlive us, make it anonymous (i.e. fix up its CvGV
6070 S_anonymise_cv_maybe(pTHX_ GV *gv, CV* cv)
6075 PERL_ARGS_ASSERT_ANONYMISE_CV_MAYBE;
6078 assert(SvREFCNT(gv) == 0);
6079 assert(isGV(gv) && isGV_with_GP(gv));
6081 assert(!CvANON(cv));
6082 assert(CvGV(cv) == gv);
6083 assert(!CvNAMED(cv));
6085 /* will the CV shortly be freed by gp_free() ? */
6086 if (GvCV(gv) == cv && GvGP(gv)->gp_refcnt < 2 && SvREFCNT(cv) < 2) {
6087 SvANY(cv)->xcv_gv_u.xcv_gv = NULL;
6091 /* if not, anonymise: */
6092 gvname = (GvSTASH(gv) && HvNAME(GvSTASH(gv)) && HvENAME(GvSTASH(gv)))
6093 ? newSVhek(HvENAME_HEK(GvSTASH(gv)))
6094 : newSVpvn_flags( "__ANON__", 8, 0 );
6095 sv_catpvs(gvname, "::__ANON__");
6096 anongv = gv_fetchsv(gvname, GV_ADDMULTI, SVt_PVCV);
6097 SvREFCNT_dec_NN(gvname);
6101 SvANY(cv)->xcv_gv_u.xcv_gv = MUTABLE_GV(SvREFCNT_inc(anongv));
6106 =for apidoc sv_clear
6108 Clear an SV: call any destructors, free up any memory used by the body,
6109 and free the body itself. The SV's head is I<not> freed, although
6110 its type is set to all 1's so that it won't inadvertently be assumed
6111 to be live during global destruction etc.
6112 This function should only be called when REFCNT is zero. Most of the time
6113 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
6120 Perl_sv_clear(pTHX_ SV *const orig_sv)
6125 const struct body_details *sv_type_details;
6131 PERL_ARGS_ASSERT_SV_CLEAR;
6133 /* within this loop, sv is the SV currently being freed, and
6134 * iter_sv is the most recent AV or whatever that's being iterated
6135 * over to provide more SVs */
6141 assert(SvREFCNT(sv) == 0);
6142 assert(SvTYPE(sv) != (svtype)SVTYPEMASK);
6144 if (type <= SVt_IV) {
6145 /* See the comment in sv.h about the collusion between this
6146 * early return and the overloading of the NULL slots in the
6150 SvFLAGS(sv) &= SVf_BREAK;
6151 SvFLAGS(sv) |= SVTYPEMASK;
6155 assert(!SvOBJECT(sv) || type >= SVt_PVMG); /* objs are always >= MG */
6157 if (type >= SVt_PVMG) {
6159 if (!curse(sv, 1)) goto get_next_sv;
6160 type = SvTYPE(sv); /* destructor may have changed it */
6162 /* Free back-references before magic, in case the magic calls
6163 * Perl code that has weak references to sv. */
6164 if (type == SVt_PVHV) {
6165 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
6169 else if (type == SVt_PVMG && SvPAD_OUR(sv)) {
6170 SvREFCNT_dec(SvOURSTASH(sv));
6171 } else if (SvMAGIC(sv)) {
6172 /* Free back-references before other types of magic. */
6173 sv_unmagic(sv, PERL_MAGIC_backref);
6177 if (type == SVt_PVMG && SvPAD_TYPED(sv))
6178 SvREFCNT_dec(SvSTASH(sv));
6181 /* case SVt_DUMMY: */
6184 IoIFP(sv) != PerlIO_stdin() &&
6185 IoIFP(sv) != PerlIO_stdout() &&
6186 IoIFP(sv) != PerlIO_stderr() &&
6187 !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6189 io_close(MUTABLE_IO(sv), FALSE);
6191 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
6192 PerlDir_close(IoDIRP(sv));
6193 IoDIRP(sv) = (DIR*)NULL;
6194 Safefree(IoTOP_NAME(sv));
6195 Safefree(IoFMT_NAME(sv));
6196 Safefree(IoBOTTOM_NAME(sv));
6197 if ((const GV *)sv == PL_statgv)
6201 /* FIXME for plugins */
6203 pregfree2((REGEXP*) sv);
6207 cv_undef(MUTABLE_CV(sv));
6208 /* If we're in a stash, we don't own a reference to it.
6209 * However it does have a back reference to us, which needs to
6211 if ((stash = CvSTASH(sv)))
6212 sv_del_backref(MUTABLE_SV(stash), sv);
6215 if (PL_last_swash_hv == (const HV *)sv) {
6216 PL_last_swash_hv = NULL;
6218 if (HvTOTALKEYS((HV*)sv) > 0) {
6220 /* this statement should match the one at the beginning of
6221 * hv_undef_flags() */
6222 if ( PL_phase != PERL_PHASE_DESTRUCT
6223 && (name = HvNAME((HV*)sv)))
6225 if (PL_stashcache) {
6226 DEBUG_o(Perl_deb(aTHX_ "sv_clear clearing PL_stashcache for '%"SVf"'\n",
6228 (void)hv_delete(PL_stashcache, name,
6229 HvNAMEUTF8((HV*)sv) ? -HvNAMELEN_get((HV*)sv) : HvNAMELEN_get((HV*)sv), G_DISCARD);
6231 hv_name_set((HV*)sv, NULL, 0, 0);
6234 /* save old iter_sv in unused SvSTASH field */
6235 assert(!SvOBJECT(sv));
6236 SvSTASH(sv) = (HV*)iter_sv;
6239 /* save old hash_index in unused SvMAGIC field */
6240 assert(!SvMAGICAL(sv));
6241 assert(!SvMAGIC(sv));
6242 ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index = hash_index;
6245 next_sv = Perl_hfree_next_entry(aTHX_ (HV*)sv, &hash_index);
6246 goto get_next_sv; /* process this new sv */
6248 /* free empty hash */
6249 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6250 assert(!HvARRAY((HV*)sv));
6254 AV* av = MUTABLE_AV(sv);
6255 if (PL_comppad == av) {
6259 if (AvREAL(av) && AvFILLp(av) > -1) {
6260 next_sv = AvARRAY(av)[AvFILLp(av)--];
6261 /* save old iter_sv in top-most slot of AV,
6262 * and pray that it doesn't get wiped in the meantime */
6263 AvARRAY(av)[AvMAX(av)] = iter_sv;
6265 goto get_next_sv; /* process this new sv */
6267 Safefree(AvALLOC(av));
6272 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
6273 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
6274 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
6275 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
6277 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
6278 SvREFCNT_dec(LvTARG(sv));
6279 if (isREGEXP(sv)) goto freeregexp;
6281 if (isGV_with_GP(sv)) {
6282 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
6283 && HvENAME_get(stash))
6284 mro_method_changed_in(stash);
6285 gp_free(MUTABLE_GV(sv));
6287 unshare_hek(GvNAME_HEK(sv));
6288 /* If we're in a stash, we don't own a reference to it.
6289 * However it does have a back reference to us, which
6290 * needs to be cleared. */
6291 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
6292 sv_del_backref(MUTABLE_SV(stash), sv);
6294 /* FIXME. There are probably more unreferenced pointers to SVs
6295 * in the interpreter struct that we should check and tidy in
6296 * a similar fashion to this: */
6297 /* See also S_sv_unglob, which does the same thing. */
6298 if ((const GV *)sv == PL_last_in_gv)
6299 PL_last_in_gv = NULL;
6300 else if ((const GV *)sv == PL_statgv)
6302 else if ((const GV *)sv == PL_stderrgv)
6309 /* Don't bother with SvOOK_off(sv); as we're only going to
6313 SvOOK_offset(sv, offset);
6314 SvPV_set(sv, SvPVX_mutable(sv) - offset);
6315 /* Don't even bother with turning off the OOK flag. */
6320 SV * const target = SvRV(sv);
6322 sv_del_backref(target, sv);
6328 else if (SvPVX_const(sv)
6329 && !(SvTYPE(sv) == SVt_PVIO
6330 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6334 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6338 # ifdef PERL_OLD_COPY_ON_WRITE
6339 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
6341 if (CowREFCNT(sv)) {
6347 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6351 # ifdef PERL_OLD_COPY_ON_WRITE
6355 Safefree(SvPVX_mutable(sv));
6359 else if (SvPVX_const(sv) && SvLEN(sv)
6360 && !(SvTYPE(sv) == SVt_PVIO
6361 && !(IoFLAGS(sv) & IOf_FAKE_DIRP)))
6362 Safefree(SvPVX_mutable(sv));
6363 else if (SvPVX_const(sv) && SvIsCOW(sv)) {
6364 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
6374 SvFLAGS(sv) &= SVf_BREAK;
6375 SvFLAGS(sv) |= SVTYPEMASK;
6377 sv_type_details = bodies_by_type + type;
6378 if (sv_type_details->arena) {
6379 del_body(((char *)SvANY(sv) + sv_type_details->offset),
6380 &PL_body_roots[type]);
6382 else if (sv_type_details->body_size) {
6383 safefree(SvANY(sv));
6387 /* caller is responsible for freeing the head of the original sv */
6388 if (sv != orig_sv && !SvREFCNT(sv))
6391 /* grab and free next sv, if any */
6399 else if (!iter_sv) {
6401 } else if (SvTYPE(iter_sv) == SVt_PVAV) {
6402 AV *const av = (AV*)iter_sv;
6403 if (AvFILLp(av) > -1) {
6404 sv = AvARRAY(av)[AvFILLp(av)--];
6406 else { /* no more elements of current AV to free */
6409 /* restore previous value, squirrelled away */
6410 iter_sv = AvARRAY(av)[AvMAX(av)];
6411 Safefree(AvALLOC(av));
6414 } else if (SvTYPE(iter_sv) == SVt_PVHV) {
6415 sv = Perl_hfree_next_entry(aTHX_ (HV*)iter_sv, &hash_index);
6416 if (!sv && !HvTOTALKEYS((HV *)iter_sv)) {
6417 /* no more elements of current HV to free */
6420 /* Restore previous values of iter_sv and hash_index,
6421 * squirrelled away */
6422 assert(!SvOBJECT(sv));
6423 iter_sv = (SV*)SvSTASH(sv);
6424 assert(!SvMAGICAL(sv));
6425 hash_index = ((XPVMG*) SvANY(sv))->xmg_u.xmg_hash_index;
6427 /* perl -DA does not like rubbish in SvMAGIC. */
6431 /* free any remaining detritus from the hash struct */
6432 Perl_hv_undef_flags(aTHX_ MUTABLE_HV(sv), HV_NAME_SETALL);
6433 assert(!HvARRAY((HV*)sv));
6438 /* unrolled SvREFCNT_dec and sv_free2 follows: */
6442 if (!SvREFCNT(sv)) {
6446 if (--(SvREFCNT(sv)))
6450 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6451 "Attempt to free temp prematurely: SV 0x%"UVxf
6452 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6456 if (SvIMMORTAL(sv)) {
6457 /* make sure SvREFCNT(sv)==0 happens very seldom */
6458 SvREFCNT(sv) = SvREFCNT_IMMORTAL;
6467 /* This routine curses the sv itself, not the object referenced by sv. So
6468 sv does not have to be ROK. */
6471 S_curse(pTHX_ SV * const sv, const bool check_refcnt) {
6474 PERL_ARGS_ASSERT_CURSE;
6475 assert(SvOBJECT(sv));
6477 if (PL_defstash && /* Still have a symbol table? */
6483 stash = SvSTASH(sv);
6484 assert(SvTYPE(stash) == SVt_PVHV);
6485 if (HvNAME(stash)) {
6486 CV* destructor = NULL;
6487 if (!SvOBJECT(stash)) destructor = (CV *)SvSTASH(stash);
6490 gv_fetchmeth_autoload(stash, "DESTROY", 7, 0);
6491 if (gv) destructor = GvCV(gv);
6492 if (!SvOBJECT(stash))
6494 destructor ? (HV *)destructor : ((HV *)0)+1;
6496 assert(!destructor || destructor == ((CV *)0)+1
6497 || SvTYPE(destructor) == SVt_PVCV);
6498 if (destructor && destructor != ((CV *)0)+1
6499 /* A constant subroutine can have no side effects, so
6500 don't bother calling it. */
6501 && !CvCONST(destructor)
6502 /* Don't bother calling an empty destructor or one that
6503 returns immediately. */
6504 && (CvISXSUB(destructor)
6505 || (CvSTART(destructor)
6506 && (CvSTART(destructor)->op_next->op_type
6508 && (CvSTART(destructor)->op_next->op_type
6510 || CvSTART(destructor)->op_next->op_next->op_type
6516 SV* const tmpref = newRV(sv);
6517 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
6519 PUSHSTACKi(PERLSI_DESTROY);
6524 call_sv(MUTABLE_SV(destructor),
6525 G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
6529 if(SvREFCNT(tmpref) < 2) {
6530 /* tmpref is not kept alive! */
6532 SvRV_set(tmpref, NULL);
6535 SvREFCNT_dec_NN(tmpref);
6538 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
6541 if (check_refcnt && SvREFCNT(sv)) {
6542 if (PL_in_clean_objs)
6544 "DESTROY created new reference to dead object '%"HEKf"'",
6545 HEKfARG(HvNAME_HEK(stash)));
6546 /* DESTROY gave object new lease on life */
6552 HV * const stash = SvSTASH(sv);
6553 /* Curse before freeing the stash, as freeing the stash could cause
6554 a recursive call into S_curse. */
6555 SvOBJECT_off(sv); /* Curse the object. */
6556 SvSTASH_set(sv,0); /* SvREFCNT_dec may try to read this */
6557 SvREFCNT_dec(stash); /* possibly of changed persuasion */
6563 =for apidoc sv_newref
6565 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6572 Perl_sv_newref(pTHX_ SV *const sv)
6574 PERL_UNUSED_CONTEXT;
6583 Decrement an SV's reference count, and if it drops to zero, call
6584 C<sv_clear> to invoke destructors and free up any memory used by
6585 the body; finally, deallocate the SV's head itself.
6586 Normally called via a wrapper macro C<SvREFCNT_dec>.
6592 Perl_sv_free(pTHX_ SV *const sv)
6598 /* Private helper function for SvREFCNT_dec().
6599 * Called with rc set to original SvREFCNT(sv), where rc == 0 or 1 */
6602 Perl_sv_free2(pTHX_ SV *const sv, const U32 rc)
6606 PERL_ARGS_ASSERT_SV_FREE2;
6608 if (LIKELY( rc == 1 )) {
6614 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEBUGGING),
6615 "Attempt to free temp prematurely: SV 0x%"UVxf
6616 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6620 if (SvIMMORTAL(sv)) {
6621 /* make sure SvREFCNT(sv)==0 happens very seldom */
6622 SvREFCNT(sv) = SvREFCNT_IMMORTAL;
6626 if (! SvREFCNT(sv)) /* may have have been resurrected */
6631 /* handle exceptional cases */
6635 if (SvFLAGS(sv) & SVf_BREAK)
6636 /* this SV's refcnt has been artificially decremented to
6637 * trigger cleanup */
6639 if (PL_in_clean_all) /* All is fair */
6641 if (SvIMMORTAL(sv)) {
6642 /* make sure SvREFCNT(sv)==0 happens very seldom */
6643 SvREFCNT(sv) = SvREFCNT_IMMORTAL;
6646 if (ckWARN_d(WARN_INTERNAL)) {
6647 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
6648 Perl_dump_sv_child(aTHX_ sv);
6650 #ifdef DEBUG_LEAKING_SCALARS
6653 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6654 if (PL_warnhook == PERL_WARNHOOK_FATAL
6655 || ckDEAD(packWARN(WARN_INTERNAL))) {
6656 /* Don't let Perl_warner cause us to escape our fate: */
6660 /* This may not return: */
6661 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6662 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6663 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6666 #ifdef DEBUG_LEAKING_SCALARS_ABORT
6676 Returns the length of the string in the SV. Handles magic and type
6677 coercion and sets the UTF8 flag appropriately. See also C<SvCUR>, which
6678 gives raw access to the xpv_cur slot.
6684 Perl_sv_len(pTHX_ SV *const sv)
6691 (void)SvPV_const(sv, len);
6696 =for apidoc sv_len_utf8
6698 Returns the number of characters in the string in an SV, counting wide
6699 UTF-8 bytes as a single character. Handles magic and type coercion.
6705 * The length is cached in PERL_MAGIC_utf8, in the mg_len field. Also the
6706 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
6707 * (Note that the mg_len is not the length of the mg_ptr field.
6708 * This allows the cache to store the character length of the string without
6709 * needing to malloc() extra storage to attach to the mg_ptr.)
6714 Perl_sv_len_utf8(pTHX_ SV *const sv)
6720 return sv_len_utf8_nomg(sv);
6724 Perl_sv_len_utf8_nomg(pTHX_ SV * const sv)
6728 const U8 *s = (U8*)SvPV_nomg_const(sv, len);
6730 PERL_ARGS_ASSERT_SV_LEN_UTF8_NOMG;
6732 if (PL_utf8cache && SvUTF8(sv)) {
6734 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
6736 if (mg && (mg->mg_len != -1 || mg->mg_ptr)) {
6737 if (mg->mg_len != -1)
6740 /* We can use the offset cache for a headstart.
6741 The longer value is stored in the first pair. */
6742 STRLEN *cache = (STRLEN *) mg->mg_ptr;
6744 ulen = cache[0] + Perl_utf8_length(aTHX_ s + cache[1],
6748 if (PL_utf8cache < 0) {
6749 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
6750 assert_uft8_cache_coherent("sv_len_utf8", ulen, real, sv);
6754 ulen = Perl_utf8_length(aTHX_ s, s + len);
6755 utf8_mg_len_cache_update(sv, &mg, ulen);
6759 return SvUTF8(sv) ? Perl_utf8_length(aTHX_ s, s + len) : len;
6762 /* Walk forwards to find the byte corresponding to the passed in UTF-8
6765 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
6766 STRLEN *const uoffset_p, bool *const at_end)
6768 const U8 *s = start;
6769 STRLEN uoffset = *uoffset_p;
6771 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
6773 while (s < send && uoffset) {
6780 else if (s > send) {
6782 /* This is the existing behaviour. Possibly it should be a croak, as
6783 it's actually a bounds error */
6786 *uoffset_p -= uoffset;
6790 /* Given the length of the string in both bytes and UTF-8 characters, decide
6791 whether to walk forwards or backwards to find the byte corresponding to
6792 the passed in UTF-8 offset. */
6794 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
6795 STRLEN uoffset, const STRLEN uend)
6797 STRLEN backw = uend - uoffset;
6799 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
6801 if (uoffset < 2 * backw) {
6802 /* The assumption is that going forwards is twice the speed of going
6803 forward (that's where the 2 * backw comes from).
6804 (The real figure of course depends on the UTF-8 data.) */
6805 const U8 *s = start;
6807 while (s < send && uoffset--)
6817 while (UTF8_IS_CONTINUATION(*send))
6820 return send - start;
6823 /* For the string representation of the given scalar, find the byte
6824 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
6825 give another position in the string, *before* the sought offset, which
6826 (which is always true, as 0, 0 is a valid pair of positions), which should
6827 help reduce the amount of linear searching.
6828 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
6829 will be used to reduce the amount of linear searching. The cache will be
6830 created if necessary, and the found value offered to it for update. */
6832 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
6833 const U8 *const send, STRLEN uoffset,
6834 STRLEN uoffset0, STRLEN boffset0)
6836 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
6838 bool at_end = FALSE;
6840 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
6842 assert (uoffset >= uoffset0);
6847 if (!SvREADONLY(sv) && !SvGMAGICAL(sv) && SvPOK(sv)
6849 && (*mgp || (SvTYPE(sv) >= SVt_PVMG &&
6850 (*mgp = mg_find(sv, PERL_MAGIC_utf8))))) {
6851 if ((*mgp)->mg_ptr) {
6852 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
6853 if (cache[0] == uoffset) {
6854 /* An exact match. */
6857 if (cache[2] == uoffset) {
6858 /* An exact match. */
6862 if (cache[0] < uoffset) {
6863 /* The cache already knows part of the way. */
6864 if (cache[0] > uoffset0) {
6865 /* The cache knows more than the passed in pair */
6866 uoffset0 = cache[0];
6867 boffset0 = cache[1];
6869 if ((*mgp)->mg_len != -1) {
6870 /* And we know the end too. */
6872 + sv_pos_u2b_midway(start + boffset0, send,
6874 (*mgp)->mg_len - uoffset0);
6876 uoffset -= uoffset0;
6878 + sv_pos_u2b_forwards(start + boffset0,
6879 send, &uoffset, &at_end);
6880 uoffset += uoffset0;
6883 else if (cache[2] < uoffset) {
6884 /* We're between the two cache entries. */
6885 if (cache[2] > uoffset0) {
6886 /* and the cache knows more than the passed in pair */
6887 uoffset0 = cache[2];
6888 boffset0 = cache[3];
6892 + sv_pos_u2b_midway(start + boffset0,
6895 cache[0] - uoffset0);
6898 + sv_pos_u2b_midway(start + boffset0,
6901 cache[2] - uoffset0);
6905 else if ((*mgp)->mg_len != -1) {
6906 /* If we can take advantage of a passed in offset, do so. */
6907 /* In fact, offset0 is either 0, or less than offset, so don't
6908 need to worry about the other possibility. */
6910 + sv_pos_u2b_midway(start + boffset0, send,
6912 (*mgp)->mg_len - uoffset0);
6917 if (!found || PL_utf8cache < 0) {
6918 STRLEN real_boffset;
6919 uoffset -= uoffset0;
6920 real_boffset = boffset0 + sv_pos_u2b_forwards(start + boffset0,
6921 send, &uoffset, &at_end);
6922 uoffset += uoffset0;
6924 if (found && PL_utf8cache < 0)
6925 assert_uft8_cache_coherent("sv_pos_u2b_cache", boffset,
6927 boffset = real_boffset;
6930 if (PL_utf8cache && !SvGMAGICAL(sv) && SvPOK(sv)) {
6932 utf8_mg_len_cache_update(sv, mgp, uoffset);
6934 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
6941 =for apidoc sv_pos_u2b_flags
6943 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6944 the start of the string, to a count of the equivalent number of bytes; if
6945 lenp is non-zero, it does the same to lenp, but this time starting from
6946 the offset, rather than from the start
6947 of the string. Handles type coercion.
6948 I<flags> is passed to C<SvPV_flags>, and usually should be
6949 C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
6955 * sv_pos_u2b_flags() uses, like sv_pos_b2u(), the mg_ptr of the potential
6956 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
6957 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
6962 Perl_sv_pos_u2b_flags(pTHX_ SV *const sv, STRLEN uoffset, STRLEN *const lenp,
6969 PERL_ARGS_ASSERT_SV_POS_U2B_FLAGS;
6971 start = (U8*)SvPV_flags(sv, len, flags);
6973 const U8 * const send = start + len;
6975 boffset = sv_pos_u2b_cached(sv, &mg, start, send, uoffset, 0, 0);
6978 && *lenp /* don't bother doing work for 0, as its bytes equivalent
6979 is 0, and *lenp is already set to that. */) {
6980 /* Convert the relative offset to absolute. */
6981 const STRLEN uoffset2 = uoffset + *lenp;
6982 const STRLEN boffset2
6983 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
6984 uoffset, boffset) - boffset;
6998 =for apidoc sv_pos_u2b
7000 Converts the value pointed to by offsetp from a count of UTF-8 chars from
7001 the start of the string, to a count of the equivalent number of bytes; if
7002 lenp is non-zero, it does the same to lenp, but this time starting from
7003 the offset, rather than from the start of the string. Handles magic and
7006 Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
7013 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
7014 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7015 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
7019 /* This function is subject to size and sign problems */
7022 Perl_sv_pos_u2b(pTHX_ SV *const sv, I32 *const offsetp, I32 *const lenp)
7024 PERL_ARGS_ASSERT_SV_POS_U2B;
7027 STRLEN ulen = (STRLEN)*lenp;
7028 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, &ulen,
7029 SV_GMAGIC|SV_CONST_RETURN);
7032 *offsetp = (I32)sv_pos_u2b_flags(sv, (STRLEN)*offsetp, NULL,
7033 SV_GMAGIC|SV_CONST_RETURN);
7038 S_utf8_mg_len_cache_update(pTHX_ SV *const sv, MAGIC **const mgp,
7041 PERL_ARGS_ASSERT_UTF8_MG_LEN_CACHE_UPDATE;
7042 if (SvREADONLY(sv) || SvGMAGICAL(sv) || !SvPOK(sv))
7045 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
7046 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
7047 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
7051 (*mgp)->mg_len = ulen;
7052 /* For now, treat "overflowed" as "still unknown". See RT #72924. */
7053 if (ulen != (STRLEN) (*mgp)->mg_len)
7054 (*mgp)->mg_len = -1;
7057 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
7058 byte length pairing. The (byte) length of the total SV is passed in too,
7059 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
7060 may not have updated SvCUR, so we can't rely on reading it directly.
7062 The proffered utf8/byte length pairing isn't used if the cache already has
7063 two pairs, and swapping either for the proffered pair would increase the
7064 RMS of the intervals between known byte offsets.
7066 The cache itself consists of 4 STRLEN values
7067 0: larger UTF-8 offset
7068 1: corresponding byte offset
7069 2: smaller UTF-8 offset
7070 3: corresponding byte offset
7072 Unused cache pairs have the value 0, 0.
7073 Keeping the cache "backwards" means that the invariant of
7074 cache[0] >= cache[2] is maintained even with empty slots, which means that
7075 the code that uses it doesn't need to worry if only 1 entry has actually
7076 been set to non-zero. It also makes the "position beyond the end of the
7077 cache" logic much simpler, as the first slot is always the one to start
7081 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
7082 const STRLEN utf8, const STRLEN blen)
7086 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
7091 if (!*mgp && (SvTYPE(sv) < SVt_PVMG ||
7092 !(*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
7093 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
7095 (*mgp)->mg_len = -1;
7099 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
7100 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
7101 (*mgp)->mg_ptr = (char *) cache;
7105 if (PL_utf8cache < 0 && SvPOKp(sv)) {
7106 /* SvPOKp() because it's possible that sv has string overloading, and
7107 therefore is a reference, hence SvPVX() is actually a pointer.
7108 This cures the (very real) symptoms of RT 69422, but I'm not actually
7109 sure whether we should even be caching the results of UTF-8
7110 operations on overloading, given that nothing stops overloading
7111 returning a different value every time it's called. */
7112 const U8 *start = (const U8 *) SvPVX_const(sv);
7113 const STRLEN realutf8 = utf8_length(start, start + byte);
7115 assert_uft8_cache_coherent("utf8_mg_pos_cache_update", utf8, realutf8,
7119 /* Cache is held with the later position first, to simplify the code
7120 that deals with unbounded ends. */
7122 ASSERT_UTF8_CACHE(cache);
7123 if (cache[1] == 0) {
7124 /* Cache is totally empty */
7127 } else if (cache[3] == 0) {
7128 if (byte > cache[1]) {
7129 /* New one is larger, so goes first. */
7130 cache[2] = cache[0];
7131 cache[3] = cache[1];
7139 #define THREEWAY_SQUARE(a,b,c,d) \
7140 ((float)((d) - (c))) * ((float)((d) - (c))) \
7141 + ((float)((c) - (b))) * ((float)((c) - (b))) \
7142 + ((float)((b) - (a))) * ((float)((b) - (a)))
7144 /* Cache has 2 slots in use, and we know three potential pairs.
7145 Keep the two that give the lowest RMS distance. Do the
7146 calculation in bytes simply because we always know the byte
7147 length. squareroot has the same ordering as the positive value,
7148 so don't bother with the actual square root. */
7149 if (byte > cache[1]) {
7150 /* New position is after the existing pair of pairs. */
7151 const float keep_earlier
7152 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7153 const float keep_later
7154 = THREEWAY_SQUARE(0, cache[1], byte, blen);
7156 if (keep_later < keep_earlier) {
7157 cache[2] = cache[0];
7158 cache[3] = cache[1];
7167 else if (byte > cache[3]) {
7168 /* New position is between the existing pair of pairs. */
7169 const float keep_earlier
7170 = THREEWAY_SQUARE(0, cache[3], byte, blen);
7171 const float keep_later
7172 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7174 if (keep_later < keep_earlier) {
7184 /* New position is before the existing pair of pairs. */
7185 const float keep_earlier
7186 = THREEWAY_SQUARE(0, byte, cache[3], blen);
7187 const float keep_later
7188 = THREEWAY_SQUARE(0, byte, cache[1], blen);
7190 if (keep_later < keep_earlier) {
7195 cache[0] = cache[2];
7196 cache[1] = cache[3];
7202 ASSERT_UTF8_CACHE(cache);
7205 /* We already know all of the way, now we may be able to walk back. The same
7206 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
7207 backward is half the speed of walking forward. */
7209 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
7210 const U8 *end, STRLEN endu)
7212 const STRLEN forw = target - s;
7213 STRLEN backw = end - target;
7215 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
7217 if (forw < 2 * backw) {
7218 return utf8_length(s, target);
7221 while (end > target) {
7223 while (UTF8_IS_CONTINUATION(*end)) {
7232 =for apidoc sv_pos_b2u
7234 Converts the value pointed to by offsetp from a count of bytes from the
7235 start of the string, to a count of the equivalent number of UTF-8 chars.
7236 Handles magic and type coercion.
7242 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
7243 * PERL_MAGIC_utf8 of the sv to store the mapping between UTF-8 and
7248 Perl_sv_pos_b2u(pTHX_ SV *const sv, I32 *const offsetp)
7251 const STRLEN byte = *offsetp;
7252 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
7258 PERL_ARGS_ASSERT_SV_POS_B2U;
7263 s = (const U8*)SvPV_const(sv, blen);
7266 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset, blen=%"UVuf
7267 ", byte=%"UVuf, (UV)blen, (UV)byte);
7273 && SvTYPE(sv) >= SVt_PVMG
7274 && (mg = mg_find(sv, PERL_MAGIC_utf8)))
7277 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
7278 if (cache[1] == byte) {
7279 /* An exact match. */
7280 *offsetp = cache[0];
7283 if (cache[3] == byte) {
7284 /* An exact match. */
7285 *offsetp = cache[2];
7289 if (cache[1] < byte) {
7290 /* We already know part of the way. */
7291 if (mg->mg_len != -1) {
7292 /* Actually, we know the end too. */
7294 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
7295 s + blen, mg->mg_len - cache[0]);
7297 len = cache[0] + utf8_length(s + cache[1], send);
7300 else if (cache[3] < byte) {
7301 /* We're between the two cached pairs, so we do the calculation
7302 offset by the byte/utf-8 positions for the earlier pair,
7303 then add the utf-8 characters from the string start to
7305 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
7306 s + cache[1], cache[0] - cache[2])
7310 else { /* cache[3] > byte */
7311 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
7315 ASSERT_UTF8_CACHE(cache);
7317 } else if (mg->mg_len != -1) {
7318 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
7322 if (!found || PL_utf8cache < 0) {
7323 const STRLEN real_len = utf8_length(s, send);
7325 if (found && PL_utf8cache < 0)
7326 assert_uft8_cache_coherent("sv_pos_b2u", len, real_len, sv);
7333 utf8_mg_len_cache_update(sv, &mg, len);
7335 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
7340 S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
7341 STRLEN real, SV *const sv)
7343 PERL_ARGS_ASSERT_ASSERT_UFT8_CACHE_COHERENT;
7345 /* As this is debugging only code, save space by keeping this test here,
7346 rather than inlining it in all the callers. */
7347 if (from_cache == real)
7350 /* Need to turn the assertions off otherwise we may recurse infinitely
7351 while printing error messages. */
7352 SAVEI8(PL_utf8cache);
7354 Perl_croak(aTHX_ "panic: %s cache %"UVuf" real %"UVuf" for %"SVf,
7355 func, (UV) from_cache, (UV) real, SVfARG(sv));
7361 Returns a boolean indicating whether the strings in the two SVs are
7362 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7363 coerce its args to strings if necessary.
7365 =for apidoc sv_eq_flags
7367 Returns a boolean indicating whether the strings in the two SVs are
7368 identical. Is UTF-8 and 'use bytes' aware and coerces its args to strings
7369 if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
7375 Perl_sv_eq_flags(pTHX_ SV *sv1, SV *sv2, const U32 flags)
7383 SV* svrecode = NULL;
7390 /* if pv1 and pv2 are the same, second SvPV_const call may
7391 * invalidate pv1 (if we are handling magic), so we may need to
7393 if (sv1 == sv2 && flags & SV_GMAGIC
7394 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
7395 pv1 = SvPV_const(sv1, cur1);
7396 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
7398 pv1 = SvPV_flags_const(sv1, cur1, flags);
7406 pv2 = SvPV_flags_const(sv2, cur2, flags);
7408 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7409 /* Differing utf8ness.
7410 * Do not UTF8size the comparands as a side-effect. */
7413 svrecode = newSVpvn(pv2, cur2);
7414 sv_recode_to_utf8(svrecode, PL_encoding);
7415 pv2 = SvPV_const(svrecode, cur2);
7418 svrecode = newSVpvn(pv1, cur1);
7419 sv_recode_to_utf8(svrecode, PL_encoding);
7420 pv1 = SvPV_const(svrecode, cur1);
7422 /* Now both are in UTF-8. */
7424 SvREFCNT_dec_NN(svrecode);
7430 /* sv1 is the UTF-8 one */
7431 return bytes_cmp_utf8((const U8*)pv2, cur2,
7432 (const U8*)pv1, cur1) == 0;
7435 /* sv2 is the UTF-8 one */
7436 return bytes_cmp_utf8((const U8*)pv1, cur1,
7437 (const U8*)pv2, cur2) == 0;
7443 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
7445 SvREFCNT_dec(svrecode);
7453 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7454 string in C<sv1> is less than, equal to, or greater than the string in
7455 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
7456 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
7458 =for apidoc sv_cmp_flags
7460 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
7461 string in C<sv1> is less than, equal to, or greater than the string in
7462 C<sv2>. Is UTF-8 and 'use bytes' aware and will coerce its args to strings
7463 if necessary. If the flags include SV_GMAGIC, it handles get magic. See
7464 also C<sv_cmp_locale_flags>.
7470 Perl_sv_cmp(pTHX_ SV *const sv1, SV *const sv2)
7472 return sv_cmp_flags(sv1, sv2, SV_GMAGIC);
7476 Perl_sv_cmp_flags(pTHX_ SV *const sv1, SV *const sv2,
7481 const char *pv1, *pv2;
7483 SV *svrecode = NULL;
7490 pv1 = SvPV_flags_const(sv1, cur1, flags);
7497 pv2 = SvPV_flags_const(sv2, cur2, flags);
7499 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
7500 /* Differing utf8ness.
7501 * Do not UTF8size the comparands as a side-effect. */
7504 svrecode = newSVpvn(pv2, cur2);
7505 sv_recode_to_utf8(svrecode, PL_encoding);
7506 pv2 = SvPV_const(svrecode, cur2);
7509 const int retval = -bytes_cmp_utf8((const U8*)pv2, cur2,
7510 (const U8*)pv1, cur1);
7511 return retval ? retval < 0 ? -1 : +1 : 0;
7516 svrecode = newSVpvn(pv1, cur1);
7517 sv_recode_to_utf8(svrecode, PL_encoding);
7518 pv1 = SvPV_const(svrecode, cur1);
7521 const int retval = bytes_cmp_utf8((const U8*)pv1, cur1,
7522 (const U8*)pv2, cur2);
7523 return retval ? retval < 0 ? -1 : +1 : 0;
7529 cmp = cur2 ? -1 : 0;
7533 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
7536 cmp = retval < 0 ? -1 : 1;
7537 } else if (cur1 == cur2) {
7540 cmp = cur1 < cur2 ? -1 : 1;
7544 SvREFCNT_dec(svrecode);
7550 =for apidoc sv_cmp_locale
7552 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7553 'use bytes' aware, handles get magic, and will coerce its args to strings
7554 if necessary. See also C<sv_cmp>.
7556 =for apidoc sv_cmp_locale_flags
7558 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
7559 'use bytes' aware and will coerce its args to strings if necessary. If the
7560 flags contain SV_GMAGIC, it handles get magic. See also C<sv_cmp_flags>.
7566 Perl_sv_cmp_locale(pTHX_ SV *const sv1, SV *const sv2)
7568 return sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC);
7572 Perl_sv_cmp_locale_flags(pTHX_ SV *const sv1, SV *const sv2,
7576 #ifdef USE_LOCALE_COLLATE
7582 if (PL_collation_standard)
7586 pv1 = sv1 ? sv_collxfrm_flags(sv1, &len1, flags) : (char *) NULL;
7588 pv2 = sv2 ? sv_collxfrm_flags(sv2, &len2, flags) : (char *) NULL;
7590 if (!pv1 || !len1) {
7601 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
7604 return retval < 0 ? -1 : 1;
7607 * When the result of collation is equality, that doesn't mean
7608 * that there are no differences -- some locales exclude some
7609 * characters from consideration. So to avoid false equalities,
7610 * we use the raw string as a tiebreaker.
7616 #endif /* USE_LOCALE_COLLATE */
7618 return sv_cmp(sv1, sv2);
7622 #ifdef USE_LOCALE_COLLATE
7625 =for apidoc sv_collxfrm
7627 This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
7628 C<sv_collxfrm_flags>.
7630 =for apidoc sv_collxfrm_flags
7632 Add Collate Transform magic to an SV if it doesn't already have it. If the
7633 flags contain SV_GMAGIC, it handles get-magic.
7635 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
7636 scalar data of the variable, but transformed to such a format that a normal
7637 memory comparison can be used to compare the data according to the locale
7644 Perl_sv_collxfrm_flags(pTHX_ SV *const sv, STRLEN *const nxp, const I32 flags)
7649 PERL_ARGS_ASSERT_SV_COLLXFRM_FLAGS;
7651 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
7652 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
7658 Safefree(mg->mg_ptr);
7659 s = SvPV_flags_const(sv, len, flags);
7660 if ((xf = mem_collxfrm(s, len, &xlen))) {
7662 #ifdef PERL_OLD_COPY_ON_WRITE
7664 sv_force_normal_flags(sv, 0);
7666 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
7680 if (mg && mg->mg_ptr) {
7682 return mg->mg_ptr + sizeof(PL_collation_ix);
7690 #endif /* USE_LOCALE_COLLATE */
7693 S_sv_gets_append_to_utf8(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7695 SV * const tsv = newSV(0);
7698 sv_gets(tsv, fp, 0);
7699 sv_utf8_upgrade_nomg(tsv);
7700 SvCUR_set(sv,append);
7703 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7707 S_sv_gets_read_record(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7710 const STRLEN recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
7711 /* Grab the size of the record we're getting */
7712 char *buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
7720 /* With a true, record-oriented file on VMS, we need to use read directly
7721 * to ensure that we respect RMS record boundaries. The user is responsible
7722 * for providing a PL_rs value that corresponds to the FAB$W_MRS (maximum
7723 * record size) field. N.B. This is likely to produce invalid results on
7724 * varying-width character data when a record ends mid-character.
7726 fd = PerlIO_fileno(fp);
7728 && PerlLIO_fstat(fd, &st) == 0
7729 && (st.st_fab_rfm == FAB$C_VAR
7730 || st.st_fab_rfm == FAB$C_VFC
7731 || st.st_fab_rfm == FAB$C_FIX)) {
7733 bytesread = PerlLIO_read(fd, buffer, recsize);
7735 else /* in-memory file from PerlIO::Scalar
7736 * or not a record-oriented file
7740 bytesread = PerlIO_read(fp, buffer, recsize);
7742 /* At this point, the logic in sv_get() means that sv will
7743 be treated as utf-8 if the handle is utf8.
7745 if (PerlIO_isutf8(fp) && bytesread > 0) {
7746 char *bend = buffer + bytesread;
7747 char *bufp = buffer;
7748 size_t charcount = 0;
7749 bool charstart = TRUE;
7752 while (charcount < recsize) {
7753 /* count accumulated characters */
7754 while (bufp < bend) {
7756 skip = UTF8SKIP(bufp);
7758 if (bufp + skip > bend) {
7759 /* partial at the end */
7770 if (charcount < recsize) {
7772 STRLEN bufp_offset = bufp - buffer;
7773 SSize_t morebytesread;
7775 /* originally I read enough to fill any incomplete
7776 character and the first byte of the next
7777 character if needed, but if there's many
7778 multi-byte encoded characters we're going to be
7779 making a read call for every character beyond
7780 the original read size.
7782 So instead, read the rest of the character if
7783 any, and enough bytes to match at least the
7784 start bytes for each character we're going to
7788 readsize = recsize - charcount;
7790 readsize = skip - (bend - bufp) + recsize - charcount - 1;
7791 buffer = SvGROW(sv, append + bytesread + readsize + 1) + append;
7792 bend = buffer + bytesread;
7793 morebytesread = PerlIO_read(fp, bend, readsize);
7794 if (morebytesread <= 0) {
7795 /* we're done, if we still have incomplete
7796 characters the check code in sv_gets() will
7799 I'd originally considered doing
7800 PerlIO_ungetc() on all but the lead
7801 character of the incomplete character, but
7802 read() doesn't do that, so I don't.
7807 /* prepare to scan some more */
7808 bytesread += morebytesread;
7809 bend = buffer + bytesread;
7810 bufp = buffer + bufp_offset;
7818 SvCUR_set(sv, bytesread + append);
7819 buffer[bytesread] = '\0';
7820 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
7826 Get a line from the filehandle and store it into the SV, optionally
7827 appending to the currently-stored string. If C<append> is not 0, the
7828 line is appended to the SV instead of overwriting it. C<append> should
7829 be set to the byte offset that the appended string should start at
7830 in the SV (typically, C<SvCUR(sv)> is a suitable choice).
7836 Perl_sv_gets(pTHX_ SV *const sv, PerlIO *const fp, I32 append)
7847 PERL_ARGS_ASSERT_SV_GETS;
7849 if (SvTHINKFIRST(sv))
7850 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
7851 /* XXX. If you make this PVIV, then copy on write can copy scalars read
7853 However, perlbench says it's slower, because the existing swipe code
7854 is faster than copy on write.
7855 Swings and roundabouts. */
7856 SvUPGRADE(sv, SVt_PV);
7859 if (PerlIO_isutf8(fp)) {
7861 sv_utf8_upgrade_nomg(sv);
7862 sv_pos_u2b(sv,&append,0);
7864 } else if (SvUTF8(sv)) {
7865 return S_sv_gets_append_to_utf8(aTHX_ sv, fp, append);
7873 if (PerlIO_isutf8(fp))
7876 if (IN_PERL_COMPILETIME) {
7877 /* we always read code in line mode */
7881 else if (RsSNARF(PL_rs)) {
7882 /* If it is a regular disk file use size from stat() as estimate
7883 of amount we are going to read -- may result in mallocing
7884 more memory than we really need if the layers below reduce
7885 the size we read (e.g. CRLF or a gzip layer).
7888 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
7889 const Off_t offset = PerlIO_tell(fp);
7890 if (offset != (Off_t) -1 && st.st_size + append > offset) {
7891 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
7897 else if (RsRECORD(PL_rs)) {
7898 return S_sv_gets_read_record(aTHX_ sv, fp, append);
7900 else if (RsPARA(PL_rs)) {
7906 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7907 if (PerlIO_isutf8(fp)) {
7908 rsptr = SvPVutf8(PL_rs, rslen);
7911 if (SvUTF8(PL_rs)) {
7912 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7913 Perl_croak(aTHX_ "Wide character in $/");
7916 rsptr = SvPV_const(PL_rs, rslen);
7920 rslast = rslen ? rsptr[rslen - 1] : '\0';
7922 if (rspara) { /* have to do this both before and after */
7923 do { /* to make sure file boundaries work right */
7926 i = PerlIO_getc(fp);
7930 PerlIO_ungetc(fp,i);
7936 /* See if we know enough about I/O mechanism to cheat it ! */
7938 /* This used to be #ifdef test - it is made run-time test for ease
7939 of abstracting out stdio interface. One call should be cheap
7940 enough here - and may even be a macro allowing compile
7944 if (PerlIO_fast_gets(fp)) {
7947 * We're going to steal some values from the stdio struct
7948 * and put EVERYTHING in the innermost loop into registers.
7954 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7955 /* An ungetc()d char is handled separately from the regular
7956 * buffer, so we getc() it back out and stuff it in the buffer.
7958 i = PerlIO_getc(fp);
7959 if (i == EOF) return 0;
7960 *(--((*fp)->_ptr)) = (unsigned char) i;
7964 /* Here is some breathtakingly efficient cheating */
7966 cnt = PerlIO_get_cnt(fp); /* get count into register */
7967 /* make sure we have the room */
7968 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7969 /* Not room for all of it
7970 if we are looking for a separator and room for some
7972 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7973 /* just process what we have room for */
7974 shortbuffered = cnt - SvLEN(sv) + append + 1;
7975 cnt -= shortbuffered;
7979 /* remember that cnt can be negative */
7980 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7985 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
7986 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7987 DEBUG_P(PerlIO_printf(Perl_debug_log,
7988 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7989 DEBUG_P(PerlIO_printf(Perl_debug_log,
7990 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7991 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7992 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7997 while (cnt > 0) { /* this | eat */
7999 if ((*bp++ = *ptr++) == rslast) /* really | dust */
8000 goto thats_all_folks; /* screams | sed :-) */
8004 Copy(ptr, bp, cnt, char); /* this | eat */
8005 bp += cnt; /* screams | dust */
8006 ptr += cnt; /* louder | sed :-) */
8008 assert (!shortbuffered);
8009 goto cannot_be_shortbuffered;
8013 if (shortbuffered) { /* oh well, must extend */
8014 cnt = shortbuffered;
8016 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
8018 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
8019 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
8023 cannot_be_shortbuffered:
8024 DEBUG_P(PerlIO_printf(Perl_debug_log,
8025 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
8026 PTR2UV(ptr),(long)cnt));
8027 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
8029 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
8030 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
8031 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
8032 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
8034 /* This used to call 'filbuf' in stdio form, but as that behaves like
8035 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
8036 another abstraction. */
8037 i = PerlIO_getc(fp); /* get more characters */
8039 DEBUG_Pv(PerlIO_printf(Perl_debug_log,
8040 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
8041 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
8042 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
8044 cnt = PerlIO_get_cnt(fp);
8045 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
8046 DEBUG_P(PerlIO_printf(Perl_debug_log,
8047 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
8049 if (i == EOF) /* all done for ever? */
8050 goto thats_really_all_folks;
8052 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
8054 SvGROW(sv, bpx + cnt + 2);
8055 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
8057 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
8059 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
8060 goto thats_all_folks;
8064 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
8065 memNE((char*)bp - rslen, rsptr, rslen))
8066 goto screamer; /* go back to the fray */
8067 thats_really_all_folks:
8069 cnt += shortbuffered;
8070 DEBUG_P(PerlIO_printf(Perl_debug_log,
8071 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
8072 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
8073 DEBUG_P(PerlIO_printf(Perl_debug_log,
8074 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
8075 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
8076 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
8078 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
8079 DEBUG_P(PerlIO_printf(Perl_debug_log,
8080 "Screamer: done, len=%ld, string=|%.*s|\n",
8081 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
8085 /*The big, slow, and stupid way. */
8086 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
8087 STDCHAR *buf = NULL;
8088 Newx(buf, 8192, STDCHAR);
8096 const STDCHAR * const bpe = buf + sizeof(buf);
8098 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
8099 ; /* keep reading */
8103 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
8104 /* Accommodate broken VAXC compiler, which applies U8 cast to
8105 * both args of ?: operator, causing EOF to change into 255
8108 i = (U8)buf[cnt - 1];
8114 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
8116 sv_catpvn_nomg(sv, (char *) buf, cnt);
8118 sv_setpvn(sv, (char *) buf, cnt); /* "nomg" is implied */
8120 if (i != EOF && /* joy */
8122 SvCUR(sv) < rslen ||
8123 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
8127 * If we're reading from a TTY and we get a short read,
8128 * indicating that the user hit his EOF character, we need
8129 * to notice it now, because if we try to read from the TTY
8130 * again, the EOF condition will disappear.
8132 * The comparison of cnt to sizeof(buf) is an optimization
8133 * that prevents unnecessary calls to feof().
8137 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
8141 #ifdef USE_HEAP_INSTEAD_OF_STACK
8146 if (rspara) { /* have to do this both before and after */
8147 while (i != EOF) { /* to make sure file boundaries work right */
8148 i = PerlIO_getc(fp);
8150 PerlIO_ungetc(fp,i);
8156 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
8162 Auto-increment of the value in the SV, doing string to numeric conversion
8163 if necessary. Handles 'get' magic and operator overloading.
8169 Perl_sv_inc(pTHX_ SV *const sv)
8178 =for apidoc sv_inc_nomg
8180 Auto-increment of the value in the SV, doing string to numeric conversion
8181 if necessary. Handles operator overloading. Skips handling 'get' magic.
8187 Perl_sv_inc_nomg(pTHX_ SV *const sv)
8195 if (SvTHINKFIRST(sv)) {
8196 if (SvIsCOW(sv) || isGV_with_GP(sv))
8197 sv_force_normal_flags(sv, 0);
8198 if (SvREADONLY(sv)) {
8199 if (IN_PERL_RUNTIME)
8200 Perl_croak_no_modify();
8204 if (SvAMAGIC(sv) && AMG_CALLunary(sv, inc_amg))
8206 i = PTR2IV(SvRV(sv));
8211 flags = SvFLAGS(sv);
8212 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
8213 /* It's (privately or publicly) a float, but not tested as an
8214 integer, so test it to see. */
8216 flags = SvFLAGS(sv);
8218 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8219 /* It's publicly an integer, or privately an integer-not-float */
8220 #ifdef PERL_PRESERVE_IVUV
8224 if (SvUVX(sv) == UV_MAX)
8225 sv_setnv(sv, UV_MAX_P1);
8227 (void)SvIOK_only_UV(sv);
8228 SvUV_set(sv, SvUVX(sv) + 1);
8230 if (SvIVX(sv) == IV_MAX)
8231 sv_setuv(sv, (UV)IV_MAX + 1);
8233 (void)SvIOK_only(sv);
8234 SvIV_set(sv, SvIVX(sv) + 1);
8239 if (flags & SVp_NOK) {
8240 const NV was = SvNVX(sv);
8241 if (NV_OVERFLOWS_INTEGERS_AT &&
8242 was >= NV_OVERFLOWS_INTEGERS_AT) {
8243 /* diag_listed_as: Lost precision when %s %f by 1 */
8244 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8245 "Lost precision when incrementing %" NVff " by 1",
8248 (void)SvNOK_only(sv);
8249 SvNV_set(sv, was + 1.0);
8253 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
8254 if ((flags & SVTYPEMASK) < SVt_PVIV)
8255 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
8256 (void)SvIOK_only(sv);
8261 while (isALPHA(*d)) d++;
8262 while (isDIGIT(*d)) d++;
8263 if (d < SvEND(sv)) {
8264 #ifdef PERL_PRESERVE_IVUV
8265 /* Got to punt this as an integer if needs be, but we don't issue
8266 warnings. Probably ought to make the sv_iv_please() that does
8267 the conversion if possible, and silently. */
8268 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8269 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8270 /* Need to try really hard to see if it's an integer.
8271 9.22337203685478e+18 is an integer.
8272 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8273 so $a="9.22337203685478e+18"; $a+0; $a++
8274 needs to be the same as $a="9.22337203685478e+18"; $a++
8281 /* sv_2iv *should* have made this an NV */
8282 if (flags & SVp_NOK) {
8283 (void)SvNOK_only(sv);
8284 SvNV_set(sv, SvNVX(sv) + 1.0);
8287 /* I don't think we can get here. Maybe I should assert this
8288 And if we do get here I suspect that sv_setnv will croak. NWC
8290 #if defined(USE_LONG_DOUBLE)
8291 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",
8292 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8294 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8295 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8298 #endif /* PERL_PRESERVE_IVUV */
8299 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
8303 while (d >= SvPVX_const(sv)) {
8311 /* MKS: The original code here died if letters weren't consecutive.
8312 * at least it didn't have to worry about non-C locales. The
8313 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
8314 * arranged in order (although not consecutively) and that only
8315 * [A-Za-z] are accepted by isALPHA in the C locale.
8317 if (*d != 'z' && *d != 'Z') {
8318 do { ++*d; } while (!isALPHA(*d));
8321 *(d--) -= 'z' - 'a';
8326 *(d--) -= 'z' - 'a' + 1;
8330 /* oh,oh, the number grew */
8331 SvGROW(sv, SvCUR(sv) + 2);
8332 SvCUR_set(sv, SvCUR(sv) + 1);
8333 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
8344 Auto-decrement of the value in the SV, doing string to numeric conversion
8345 if necessary. Handles 'get' magic and operator overloading.
8351 Perl_sv_dec(pTHX_ SV *const sv)
8361 =for apidoc sv_dec_nomg
8363 Auto-decrement of the value in the SV, doing string to numeric conversion
8364 if necessary. Handles operator overloading. Skips handling 'get' magic.
8370 Perl_sv_dec_nomg(pTHX_ SV *const sv)
8377 if (SvTHINKFIRST(sv)) {
8378 if (SvIsCOW(sv) || isGV_with_GP(sv))
8379 sv_force_normal_flags(sv, 0);
8380 if (SvREADONLY(sv)) {
8381 if (IN_PERL_RUNTIME)
8382 Perl_croak_no_modify();
8386 if (SvAMAGIC(sv) && AMG_CALLunary(sv, dec_amg))
8388 i = PTR2IV(SvRV(sv));
8393 /* Unlike sv_inc we don't have to worry about string-never-numbers
8394 and keeping them magic. But we mustn't warn on punting */
8395 flags = SvFLAGS(sv);
8396 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
8397 /* It's publicly an integer, or privately an integer-not-float */
8398 #ifdef PERL_PRESERVE_IVUV
8402 if (SvUVX(sv) == 0) {
8403 (void)SvIOK_only(sv);
8407 (void)SvIOK_only_UV(sv);
8408 SvUV_set(sv, SvUVX(sv) - 1);
8411 if (SvIVX(sv) == IV_MIN) {
8412 sv_setnv(sv, (NV)IV_MIN);
8416 (void)SvIOK_only(sv);
8417 SvIV_set(sv, SvIVX(sv) - 1);
8422 if (flags & SVp_NOK) {
8425 const NV was = SvNVX(sv);
8426 if (NV_OVERFLOWS_INTEGERS_AT &&
8427 was <= -NV_OVERFLOWS_INTEGERS_AT) {
8428 /* diag_listed_as: Lost precision when %s %f by 1 */
8429 Perl_ck_warner(aTHX_ packWARN(WARN_IMPRECISION),
8430 "Lost precision when decrementing %" NVff " by 1",
8433 (void)SvNOK_only(sv);
8434 SvNV_set(sv, was - 1.0);
8438 if (!(flags & SVp_POK)) {
8439 if ((flags & SVTYPEMASK) < SVt_PVIV)
8440 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
8442 (void)SvIOK_only(sv);
8445 #ifdef PERL_PRESERVE_IVUV
8447 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
8448 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
8449 /* Need to try really hard to see if it's an integer.
8450 9.22337203685478e+18 is an integer.
8451 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
8452 so $a="9.22337203685478e+18"; $a+0; $a--
8453 needs to be the same as $a="9.22337203685478e+18"; $a--
8460 /* sv_2iv *should* have made this an NV */
8461 if (flags & SVp_NOK) {
8462 (void)SvNOK_only(sv);
8463 SvNV_set(sv, SvNVX(sv) - 1.0);
8466 /* I don't think we can get here. Maybe I should assert this
8467 And if we do get here I suspect that sv_setnv will croak. NWC
8469 #if defined(USE_LONG_DOUBLE)
8470 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",
8471 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8473 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
8474 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
8478 #endif /* PERL_PRESERVE_IVUV */
8479 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
8482 /* this define is used to eliminate a chunk of duplicated but shared logic
8483 * it has the suffix __SV_C to signal that it isnt API, and isnt meant to be
8484 * used anywhere but here - yves
8486 #define PUSH_EXTEND_MORTAL__SV_C(AnSv) \
8489 PL_tmps_stack[++PL_tmps_ix] = (AnSv); \
8493 =for apidoc sv_mortalcopy
8495 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
8496 The new SV is marked as mortal. It will be destroyed "soon", either by an
8497 explicit call to FREETMPS, or by an implicit call at places such as
8498 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
8503 /* Make a string that will exist for the duration of the expression
8504 * evaluation. Actually, it may have to last longer than that, but
8505 * hopefully we won't free it until it has been assigned to a
8506 * permanent location. */
8509 Perl_sv_mortalcopy_flags(pTHX_ SV *const oldstr, U32 flags)
8514 if (flags & SV_GMAGIC)
8515 SvGETMAGIC(oldstr); /* before new_SV, in case it dies */
8517 sv_setsv_flags(sv,oldstr,flags & ~SV_GMAGIC);
8518 PUSH_EXTEND_MORTAL__SV_C(sv);
8524 =for apidoc sv_newmortal
8526 Creates a new null SV which is mortal. The reference count of the SV is
8527 set to 1. It will be destroyed "soon", either by an explicit call to
8528 FREETMPS, or by an implicit call at places such as statement boundaries.
8529 See also C<sv_mortalcopy> and C<sv_2mortal>.
8535 Perl_sv_newmortal(pTHX)
8541 SvFLAGS(sv) = SVs_TEMP;
8542 PUSH_EXTEND_MORTAL__SV_C(sv);
8548 =for apidoc newSVpvn_flags
8550 Creates a new SV and copies a string into it. The reference count for the
8551 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
8552 string. You are responsible for ensuring that the source string is at least
8553 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
8554 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
8555 If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
8556 returning. If C<SVf_UTF8> is set, C<s>
8557 is considered to be in UTF-8 and the
8558 C<SVf_UTF8> flag will be set on the new SV.
8559 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
8561 #define newSVpvn_utf8(s, len, u) \
8562 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
8568 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
8573 /* All the flags we don't support must be zero.
8574 And we're new code so I'm going to assert this from the start. */
8575 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
8577 sv_setpvn(sv,s,len);
8579 /* This code used to a sv_2mortal(), however we now unroll the call to sv_2mortal()
8580 * and do what it does ourselves here.
8581 * Since we have asserted that flags can only have the SVf_UTF8 and/or SVs_TEMP flags
8582 * set above we can use it to enable the sv flags directly (bypassing SvTEMP_on), which
8583 * in turn means we dont need to mask out the SVf_UTF8 flag below, which means that we
8584 * eliminate quite a few steps than it looks - Yves (explaining patch by gfx)
8587 SvFLAGS(sv) |= flags;
8589 if(flags & SVs_TEMP){
8590 PUSH_EXTEND_MORTAL__SV_C(sv);
8597 =for apidoc sv_2mortal
8599 Marks an existing SV as mortal. The SV will be destroyed "soon", either
8600 by an explicit call to FREETMPS, or by an implicit call at places such as
8601 statement boundaries. SvTEMP() is turned on which means that the SV's
8602 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
8603 and C<sv_mortalcopy>.
8609 Perl_sv_2mortal(pTHX_ SV *const sv)
8616 PUSH_EXTEND_MORTAL__SV_C(sv);
8624 Creates a new SV and copies a string into it. The reference count for the
8625 SV is set to 1. If C<len> is zero, Perl will compute the length using
8626 strlen(). For efficiency, consider using C<newSVpvn> instead.
8632 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
8638 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
8643 =for apidoc newSVpvn
8645 Creates a new SV and copies a buffer into it, which may contain NUL characters
8646 (C<\0>) and other binary data. The reference count for the SV is set to 1.
8647 Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
8648 are responsible for ensuring that the source buffer is at least
8649 C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
8656 Perl_newSVpvn(pTHX_ const char *const buffer, const STRLEN len)
8662 sv_setpvn(sv,buffer,len);
8667 =for apidoc newSVhek
8669 Creates a new SV from the hash key structure. It will generate scalars that
8670 point to the shared string table where possible. Returns a new (undefined)
8671 SV if the hek is NULL.
8677 Perl_newSVhek(pTHX_ const HEK *const hek)
8687 if (HEK_LEN(hek) == HEf_SVKEY) {
8688 return newSVsv(*(SV**)HEK_KEY(hek));
8690 const int flags = HEK_FLAGS(hek);
8691 if (flags & HVhek_WASUTF8) {
8693 Andreas would like keys he put in as utf8 to come back as utf8
8695 STRLEN utf8_len = HEK_LEN(hek);
8696 SV * const sv = newSV_type(SVt_PV);
8697 char *as_utf8 = (char *)bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
8698 /* bytes_to_utf8() allocates a new string, which we can repurpose: */
8699 sv_usepvn_flags(sv, as_utf8, utf8_len, SV_HAS_TRAILING_NUL);
8702 } else if (flags & HVhek_UNSHARED) {
8703 /* A hash that isn't using shared hash keys has to have
8704 the flag in every key so that we know not to try to call
8705 share_hek_hek on it. */
8707 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
8712 /* This will be overwhelminly the most common case. */
8714 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
8715 more efficient than sharepvn(). */
8719 sv_upgrade(sv, SVt_PV);
8720 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
8721 SvCUR_set(sv, HEK_LEN(hek));
8733 =for apidoc newSVpvn_share
8735 Creates a new SV with its SvPVX_const pointing to a shared string in the string
8736 table. If the string does not already exist in the table, it is
8737 created first. Turns on the SvIsCOW flag (or READONLY
8738 and FAKE in 5.16 and earlier). If the C<hash> parameter
8739 is non-zero, that value is used; otherwise the hash is computed.
8740 The string's hash can later be retrieved from the SV
8741 with the C<SvSHARED_HASH()> macro. The idea here is
8742 that as the string table is used for shared hash keys these strings will have
8743 SvPVX_const == HeKEY and hash lookup will avoid string compare.
8749 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
8753 bool is_utf8 = FALSE;
8754 const char *const orig_src = src;
8757 STRLEN tmplen = -len;
8759 /* See the note in hv.c:hv_fetch() --jhi */
8760 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
8764 PERL_HASH(hash, src, len);
8766 /* The logic for this is inlined in S_mro_get_linear_isa_dfs(), so if it
8767 changes here, update it there too. */
8768 sv_upgrade(sv, SVt_PV);
8769 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
8776 if (src != orig_src)
8782 =for apidoc newSVpv_share
8784 Like C<newSVpvn_share>, but takes a nul-terminated string instead of a
8791 Perl_newSVpv_share(pTHX_ const char *src, U32 hash)
8793 return newSVpvn_share(src, strlen(src), hash);
8796 #if defined(PERL_IMPLICIT_CONTEXT)
8798 /* pTHX_ magic can't cope with varargs, so this is a no-context
8799 * version of the main function, (which may itself be aliased to us).
8800 * Don't access this version directly.
8804 Perl_newSVpvf_nocontext(const char *const pat, ...)
8810 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
8812 va_start(args, pat);
8813 sv = vnewSVpvf(pat, &args);
8820 =for apidoc newSVpvf
8822 Creates a new SV and initializes it with the string formatted like
8829 Perl_newSVpvf(pTHX_ const char *const pat, ...)
8834 PERL_ARGS_ASSERT_NEWSVPVF;
8836 va_start(args, pat);
8837 sv = vnewSVpvf(pat, &args);
8842 /* backend for newSVpvf() and newSVpvf_nocontext() */
8845 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
8850 PERL_ARGS_ASSERT_VNEWSVPVF;
8853 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8860 Creates a new SV and copies a floating point value into it.
8861 The reference count for the SV is set to 1.
8867 Perl_newSVnv(pTHX_ const NV n)
8880 Creates a new SV and copies an integer into it. The reference count for the
8887 Perl_newSViv(pTHX_ const IV i)
8900 Creates a new SV and copies an unsigned integer into it.
8901 The reference count for the SV is set to 1.
8907 Perl_newSVuv(pTHX_ const UV u)
8918 =for apidoc newSV_type
8920 Creates a new SV, of the type specified. The reference count for the new SV
8927 Perl_newSV_type(pTHX_ const svtype type)
8932 sv_upgrade(sv, type);
8937 =for apidoc newRV_noinc
8939 Creates an RV wrapper for an SV. The reference count for the original
8940 SV is B<not> incremented.
8946 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
8949 SV *sv = newSV_type(SVt_IV);
8951 PERL_ARGS_ASSERT_NEWRV_NOINC;
8954 SvRV_set(sv, tmpRef);
8959 /* newRV_inc is the official function name to use now.
8960 * newRV_inc is in fact #defined to newRV in sv.h
8964 Perl_newRV(pTHX_ SV *const sv)
8968 PERL_ARGS_ASSERT_NEWRV;
8970 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
8976 Creates a new SV which is an exact duplicate of the original SV.
8983 Perl_newSVsv(pTHX_ SV *const old)
8990 if (SvTYPE(old) == (svtype)SVTYPEMASK) {
8991 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
8994 /* Do this here, otherwise we leak the new SV if this croaks. */
8997 /* SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
8998 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
8999 sv_setsv_flags(sv, old, SV_NOSTEAL);
9004 =for apidoc sv_reset
9006 Underlying implementation for the C<reset> Perl function.
9007 Note that the perl-level function is vaguely deprecated.
9013 Perl_sv_reset(pTHX_ const char *s, HV *const stash)
9015 PERL_ARGS_ASSERT_SV_RESET;
9017 sv_resetpvn(*s ? s : NULL, strlen(s), stash);
9021 Perl_sv_resetpvn(pTHX_ const char *s, STRLEN len, HV * const stash)
9024 char todo[PERL_UCHAR_MAX+1];
9027 if (!stash || SvTYPE(stash) != SVt_PVHV)
9030 if (!s) { /* reset ?? searches */
9031 MAGIC * const mg = mg_find((const SV *)stash, PERL_MAGIC_symtab);
9033 const U32 count = mg->mg_len / sizeof(PMOP**);
9034 PMOP **pmp = (PMOP**) mg->mg_ptr;
9035 PMOP *const *const end = pmp + count;
9039 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
9041 (*pmp)->op_pmflags &= ~PMf_USED;
9049 /* reset variables */
9051 if (!HvARRAY(stash))
9054 Zero(todo, 256, char);
9058 I32 i = (unsigned char)*s;
9062 max = (unsigned char)*s++;
9063 for ( ; i <= max; i++) {
9066 for (i = 0; i <= (I32) HvMAX(stash); i++) {
9068 for (entry = HvARRAY(stash)[i];
9070 entry = HeNEXT(entry))
9075 if (!todo[(U8)*HeKEY(entry)])
9077 gv = MUTABLE_GV(HeVAL(entry));
9080 if (SvTHINKFIRST(sv)) {
9081 if (!SvREADONLY(sv) && SvROK(sv))
9083 /* XXX Is this continue a bug? Why should THINKFIRST
9084 exempt us from resetting arrays and hashes? */
9088 if (SvTYPE(sv) >= SVt_PV) {
9090 if (SvPVX_const(sv) != NULL)
9098 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
9100 Perl_die(aTHX_ "Can't reset %%ENV on this system");
9103 # if defined(USE_ENVIRON_ARRAY)
9106 # endif /* USE_ENVIRON_ARRAY */
9117 Using various gambits, try to get an IO from an SV: the IO slot if its a
9118 GV; or the recursive result if we're an RV; or the IO slot of the symbol
9119 named after the PV if we're a string.
9121 'Get' magic is ignored on the sv passed in, but will be called on
9122 C<SvRV(sv)> if sv is an RV.
9128 Perl_sv_2io(pTHX_ SV *const sv)
9133 PERL_ARGS_ASSERT_SV_2IO;
9135 switch (SvTYPE(sv)) {
9137 io = MUTABLE_IO(sv);
9141 if (isGV_with_GP(sv)) {
9142 gv = MUTABLE_GV(sv);
9145 Perl_croak(aTHX_ "Bad filehandle: %"HEKf,
9146 HEKfARG(GvNAME_HEK(gv)));
9152 Perl_croak(aTHX_ PL_no_usym, "filehandle");
9154 SvGETMAGIC(SvRV(sv));
9155 return sv_2io(SvRV(sv));
9157 gv = gv_fetchsv_nomg(sv, 0, SVt_PVIO);
9164 if (SvGMAGICAL(sv)) {
9165 newsv = sv_newmortal();
9166 sv_setsv_nomg(newsv, sv);
9168 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(newsv));
9178 Using various gambits, try to get a CV from an SV; in addition, try if
9179 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
9180 The flags in C<lref> are passed to gv_fetchsv.
9186 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
9192 PERL_ARGS_ASSERT_SV_2CV;
9199 switch (SvTYPE(sv)) {
9203 return MUTABLE_CV(sv);
9213 sv = amagic_deref_call(sv, to_cv_amg);
9216 if (SvTYPE(sv) == SVt_PVCV) {
9217 cv = MUTABLE_CV(sv);
9222 else if(SvGETMAGIC(sv), isGV_with_GP(sv))
9223 gv = MUTABLE_GV(sv);
9225 Perl_croak(aTHX_ "Not a subroutine reference");
9227 else if (isGV_with_GP(sv)) {
9228 gv = MUTABLE_GV(sv);
9231 gv = gv_fetchsv_nomg(sv, lref, SVt_PVCV);
9238 /* Some flags to gv_fetchsv mean don't really create the GV */
9239 if (!isGV_with_GP(gv)) {
9244 if (lref & ~GV_ADDMG && !GvCVu(gv)) {
9245 /* XXX this is probably not what they think they're getting.
9246 * It has the same effect as "sub name;", i.e. just a forward
9257 Returns true if the SV has a true value by Perl's rules.
9258 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
9259 instead use an in-line version.
9265 Perl_sv_true(pTHX_ SV *const sv)
9270 const XPV* const tXpv = (XPV*)SvANY(sv);
9272 (tXpv->xpv_cur > 1 ||
9273 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
9280 return SvIVX(sv) != 0;
9283 return SvNVX(sv) != 0.0;
9285 return sv_2bool(sv);
9291 =for apidoc sv_pvn_force
9293 Get a sensible string out of the SV somehow.
9294 A private implementation of the C<SvPV_force> macro for compilers which
9295 can't cope with complex macro expressions. Always use the macro instead.
9297 =for apidoc sv_pvn_force_flags
9299 Get a sensible string out of the SV somehow.
9300 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
9301 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
9302 implemented in terms of this function.
9303 You normally want to use the various wrapper macros instead: see
9304 C<SvPV_force> and C<SvPV_force_nomg>
9310 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
9314 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
9316 if (flags & SV_GMAGIC) SvGETMAGIC(sv);
9317 if (SvTHINKFIRST(sv) && (!SvROK(sv) || SvREADONLY(sv)))
9318 sv_force_normal_flags(sv, 0);
9328 if (SvTYPE(sv) > SVt_PVLV
9329 || isGV_with_GP(sv))
9330 /* diag_listed_as: Can't coerce %s to %s in %s */
9331 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
9333 s = sv_2pv_flags(sv, &len, flags &~ SV_GMAGIC);
9340 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
9343 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
9344 SvGROW(sv, len + 1);
9345 Move(s,SvPVX(sv),len,char);
9347 SvPVX(sv)[len] = '\0';
9350 SvPOK_on(sv); /* validate pointer */
9352 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
9353 PTR2UV(sv),SvPVX_const(sv)));
9356 (void)SvPOK_only_UTF8(sv);
9357 return SvPVX_mutable(sv);
9361 =for apidoc sv_pvbyten_force
9363 The backend for the C<SvPVbytex_force> macro. Always use the macro
9370 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
9372 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
9374 sv_pvn_force(sv,lp);
9375 sv_utf8_downgrade(sv,0);
9381 =for apidoc sv_pvutf8n_force
9383 The backend for the C<SvPVutf8x_force> macro. Always use the macro
9390 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
9392 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
9395 sv_utf8_upgrade_nomg(sv);
9401 =for apidoc sv_reftype
9403 Returns a string describing what the SV is a reference to.
9409 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
9411 PERL_ARGS_ASSERT_SV_REFTYPE;
9412 if (ob && SvOBJECT(sv)) {
9413 return SvPV_nolen_const(sv_ref(NULL, sv, ob));
9416 switch (SvTYPE(sv)) {
9431 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
9432 /* tied lvalues should appear to be
9433 * scalars for backwards compatibility */
9434 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
9435 ? "SCALAR" : "LVALUE");
9436 case SVt_PVAV: return "ARRAY";
9437 case SVt_PVHV: return "HASH";
9438 case SVt_PVCV: return "CODE";
9439 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
9440 ? "GLOB" : "SCALAR");
9441 case SVt_PVFM: return "FORMAT";
9442 case SVt_PVIO: return "IO";
9443 case SVt_DUMMY: return "DUMMY";
9444 case SVt_REGEXP: return "REGEXP";
9445 default: return "UNKNOWN";
9453 Returns a SV describing what the SV passed in is a reference to.
9459 Perl_sv_ref(pTHX_ SV *dst, const SV *const sv, const int ob)
9461 PERL_ARGS_ASSERT_SV_REF;
9464 dst = sv_newmortal();
9466 if (ob && SvOBJECT(sv)) {
9467 HvNAME_get(SvSTASH(sv))
9468 ? sv_sethek(dst, HvNAME_HEK(SvSTASH(sv)))
9469 : sv_setpvn(dst, "__ANON__", 8);
9472 const char * reftype = sv_reftype(sv, 0);
9473 sv_setpv(dst, reftype);
9479 =for apidoc sv_isobject
9481 Returns a boolean indicating whether the SV is an RV pointing to a blessed
9482 object. If the SV is not an RV, or if the object is not blessed, then this
9489 Perl_sv_isobject(pTHX_ SV *sv)
9505 Returns a boolean indicating whether the SV is blessed into the specified
9506 class. This does not check for subtypes; use C<sv_derived_from> to verify
9507 an inheritance relationship.
9513 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
9517 PERL_ARGS_ASSERT_SV_ISA;
9527 hvname = HvNAME_get(SvSTASH(sv));
9531 return strEQ(hvname, name);
9537 Creates a new SV for the existing RV, C<rv>, to point to. If C<rv> is not an
9538 RV then it will be upgraded to one. If C<classname> is non-null then the new
9539 SV will be blessed in the specified package. The new SV is returned and its
9540 reference count is 1. The reference count 1 is owned by C<rv>.
9546 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
9551 PERL_ARGS_ASSERT_NEWSVRV;
9555 SV_CHECK_THINKFIRST_COW_DROP(rv);
9557 if (SvTYPE(rv) >= SVt_PVMG) {
9558 const U32 refcnt = SvREFCNT(rv);
9562 SvREFCNT(rv) = refcnt;
9564 sv_upgrade(rv, SVt_IV);
9565 } else if (SvROK(rv)) {
9566 SvREFCNT_dec(SvRV(rv));
9568 prepare_SV_for_RV(rv);
9576 HV* const stash = gv_stashpv(classname, GV_ADD);
9577 (void)sv_bless(rv, stash);
9583 =for apidoc sv_setref_pv
9585 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
9586 argument will be upgraded to an RV. That RV will be modified to point to
9587 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
9588 into the SV. The C<classname> argument indicates the package for the
9589 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9590 will have a reference count of 1, and the RV will be returned.
9592 Do not use with other Perl types such as HV, AV, SV, CV, because those
9593 objects will become corrupted by the pointer copy process.
9595 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
9601 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
9605 PERL_ARGS_ASSERT_SV_SETREF_PV;
9608 sv_setsv(rv, &PL_sv_undef);
9612 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
9617 =for apidoc sv_setref_iv
9619 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
9620 argument will be upgraded to an RV. That RV will be modified to point to
9621 the new SV. The C<classname> argument indicates the package for the
9622 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9623 will have a reference count of 1, and the RV will be returned.
9629 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
9631 PERL_ARGS_ASSERT_SV_SETREF_IV;
9633 sv_setiv(newSVrv(rv,classname), iv);
9638 =for apidoc sv_setref_uv
9640 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
9641 argument will be upgraded to an RV. That RV will be modified to point to
9642 the new SV. The C<classname> argument indicates the package for the
9643 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9644 will have a reference count of 1, and the RV will be returned.
9650 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
9652 PERL_ARGS_ASSERT_SV_SETREF_UV;
9654 sv_setuv(newSVrv(rv,classname), uv);
9659 =for apidoc sv_setref_nv
9661 Copies a double into a new SV, optionally blessing the SV. The C<rv>
9662 argument will be upgraded to an RV. That RV will be modified to point to
9663 the new SV. The C<classname> argument indicates the package for the
9664 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
9665 will have a reference count of 1, and the RV will be returned.
9671 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
9673 PERL_ARGS_ASSERT_SV_SETREF_NV;
9675 sv_setnv(newSVrv(rv,classname), nv);
9680 =for apidoc sv_setref_pvn
9682 Copies a string into a new SV, optionally blessing the SV. The length of the
9683 string must be specified with C<n>. The C<rv> argument will be upgraded to
9684 an RV. That RV will be modified to point to the new SV. The C<classname>
9685 argument indicates the package for the blessing. Set C<classname> to
9686 C<NULL> to avoid the blessing. The new SV will have a reference count
9687 of 1, and the RV will be returned.
9689 Note that C<sv_setref_pv> copies the pointer while this copies the string.
9695 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
9696 const char *const pv, const STRLEN n)
9698 PERL_ARGS_ASSERT_SV_SETREF_PVN;
9700 sv_setpvn(newSVrv(rv,classname), pv, n);
9705 =for apidoc sv_bless
9707 Blesses an SV into a specified package. The SV must be an RV. The package
9708 must be designated by its stash (see C<gv_stashpv()>). The reference count
9709 of the SV is unaffected.
9715 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
9720 PERL_ARGS_ASSERT_SV_BLESS;
9723 Perl_croak(aTHX_ "Can't bless non-reference value");
9725 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
9726 if (SvREADONLY(tmpRef) && !SvIsCOW(tmpRef))
9727 Perl_croak_no_modify();
9728 if (SvOBJECT(tmpRef)) {
9729 SvREFCNT_dec(SvSTASH(tmpRef));
9732 SvOBJECT_on(tmpRef);
9733 SvUPGRADE(tmpRef, SVt_PVMG);
9734 SvSTASH_set(tmpRef, MUTABLE_HV(SvREFCNT_inc_simple(stash)));
9736 if(SvSMAGICAL(tmpRef))
9737 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
9745 /* Downgrades a PVGV to a PVMG. If it's actually a PVLV, we leave the type
9746 * as it is after unglobbing it.
9749 PERL_STATIC_INLINE void
9750 S_sv_unglob(pTHX_ SV *const sv, U32 flags)
9755 SV * const temp = flags & SV_COW_DROP_PV ? NULL : sv_newmortal();
9757 PERL_ARGS_ASSERT_SV_UNGLOB;
9759 assert(SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV);
9761 if (!(flags & SV_COW_DROP_PV))
9762 gv_efullname3(temp, MUTABLE_GV(sv), "*");
9765 if(GvCVu((const GV *)sv) && (stash = GvSTASH(MUTABLE_GV(sv)))
9766 && HvNAME_get(stash))
9767 mro_method_changed_in(stash);
9768 gp_free(MUTABLE_GV(sv));
9771 sv_del_backref(MUTABLE_SV(GvSTASH(sv)), sv);
9775 if (GvNAME_HEK(sv)) {
9776 unshare_hek(GvNAME_HEK(sv));
9778 isGV_with_GP_off(sv);
9780 if(SvTYPE(sv) == SVt_PVGV) {
9781 /* need to keep SvANY(sv) in the right arena */
9782 xpvmg = new_XPVMG();
9783 StructCopy(SvANY(sv), xpvmg, XPVMG);
9784 del_XPVGV(SvANY(sv));
9787 SvFLAGS(sv) &= ~SVTYPEMASK;
9788 SvFLAGS(sv) |= SVt_PVMG;
9791 /* Intentionally not calling any local SET magic, as this isn't so much a
9792 set operation as merely an internal storage change. */
9793 if (flags & SV_COW_DROP_PV) SvOK_off(sv);
9794 else sv_setsv_flags(sv, temp, 0);
9796 if ((const GV *)sv == PL_last_in_gv)
9797 PL_last_in_gv = NULL;
9798 else if ((const GV *)sv == PL_statgv)
9803 =for apidoc sv_unref_flags
9805 Unsets the RV status of the SV, and decrements the reference count of
9806 whatever was being referenced by the RV. This can almost be thought of
9807 as a reversal of C<newSVrv>. The C<cflags> argument can contain
9808 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
9809 (otherwise the decrementing is conditional on the reference count being
9810 different from one or the reference being a readonly SV).
9817 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
9819 SV* const target = SvRV(ref);
9821 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
9823 if (SvWEAKREF(ref)) {
9824 sv_del_backref(target, ref);
9826 SvRV_set(ref, NULL);
9829 SvRV_set(ref, NULL);
9831 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
9832 assigned to as BEGIN {$a = \"Foo"} will fail. */
9833 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
9834 SvREFCNT_dec_NN(target);
9835 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
9836 sv_2mortal(target); /* Schedule for freeing later */
9840 =for apidoc sv_untaint
9842 Untaint an SV. Use C<SvTAINTED_off> instead.
9848 Perl_sv_untaint(pTHX_ SV *const sv)
9850 PERL_ARGS_ASSERT_SV_UNTAINT;
9852 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9853 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9860 =for apidoc sv_tainted
9862 Test an SV for taintedness. Use C<SvTAINTED> instead.
9868 Perl_sv_tainted(pTHX_ SV *const sv)
9870 PERL_ARGS_ASSERT_SV_TAINTED;
9872 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
9873 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
9874 if (mg && (mg->mg_len & 1) )
9881 =for apidoc sv_setpviv
9883 Copies an integer into the given SV, also updating its string value.
9884 Does not handle 'set' magic. See C<sv_setpviv_mg>.
9890 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
9892 char buf[TYPE_CHARS(UV)];
9894 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
9896 PERL_ARGS_ASSERT_SV_SETPVIV;
9898 sv_setpvn(sv, ptr, ebuf - ptr);
9902 =for apidoc sv_setpviv_mg
9904 Like C<sv_setpviv>, but also handles 'set' magic.
9910 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
9912 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
9918 #if defined(PERL_IMPLICIT_CONTEXT)
9920 /* pTHX_ magic can't cope with varargs, so this is a no-context
9921 * version of the main function, (which may itself be aliased to us).
9922 * Don't access this version directly.
9926 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
9931 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
9933 va_start(args, pat);
9934 sv_vsetpvf(sv, pat, &args);
9938 /* pTHX_ magic can't cope with varargs, so this is a no-context
9939 * version of the main function, (which may itself be aliased to us).
9940 * Don't access this version directly.
9944 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
9949 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
9951 va_start(args, pat);
9952 sv_vsetpvf_mg(sv, pat, &args);
9958 =for apidoc sv_setpvf
9960 Works like C<sv_catpvf> but copies the text into the SV instead of
9961 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
9967 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
9971 PERL_ARGS_ASSERT_SV_SETPVF;
9973 va_start(args, pat);
9974 sv_vsetpvf(sv, pat, &args);
9979 =for apidoc sv_vsetpvf
9981 Works like C<sv_vcatpvf> but copies the text into the SV instead of
9982 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
9984 Usually used via its frontend C<sv_setpvf>.
9990 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
9992 PERL_ARGS_ASSERT_SV_VSETPVF;
9994 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
9998 =for apidoc sv_setpvf_mg
10000 Like C<sv_setpvf>, but also handles 'set' magic.
10006 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
10010 PERL_ARGS_ASSERT_SV_SETPVF_MG;
10012 va_start(args, pat);
10013 sv_vsetpvf_mg(sv, pat, &args);
10018 =for apidoc sv_vsetpvf_mg
10020 Like C<sv_vsetpvf>, but also handles 'set' magic.
10022 Usually used via its frontend C<sv_setpvf_mg>.
10028 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
10030 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
10032 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
10036 #if defined(PERL_IMPLICIT_CONTEXT)
10038 /* pTHX_ magic can't cope with varargs, so this is a no-context
10039 * version of the main function, (which may itself be aliased to us).
10040 * Don't access this version directly.
10044 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
10049 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
10051 va_start(args, pat);
10052 sv_vcatpvf(sv, pat, &args);
10056 /* pTHX_ magic can't cope with varargs, so this is a no-context
10057 * version of the main function, (which may itself be aliased to us).
10058 * Don't access this version directly.
10062 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
10067 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
10069 va_start(args, pat);
10070 sv_vcatpvf_mg(sv, pat, &args);
10076 =for apidoc sv_catpvf
10078 Processes its arguments like C<sprintf> and appends the formatted
10079 output to an SV. If the appended data contains "wide" characters
10080 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
10081 and characters >255 formatted with %c), the original SV might get
10082 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
10083 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
10084 valid UTF-8; if the original SV was bytes, the pattern should be too.
10089 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
10093 PERL_ARGS_ASSERT_SV_CATPVF;
10095 va_start(args, pat);
10096 sv_vcatpvf(sv, pat, &args);
10101 =for apidoc sv_vcatpvf
10103 Processes its arguments like C<vsprintf> and appends the formatted output
10104 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
10106 Usually used via its frontend C<sv_catpvf>.
10112 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
10114 PERL_ARGS_ASSERT_SV_VCATPVF;
10116 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
10120 =for apidoc sv_catpvf_mg
10122 Like C<sv_catpvf>, but also handles 'set' magic.
10128 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
10132 PERL_ARGS_ASSERT_SV_CATPVF_MG;
10134 va_start(args, pat);
10135 sv_vcatpvf_mg(sv, pat, &args);
10140 =for apidoc sv_vcatpvf_mg
10142 Like C<sv_vcatpvf>, but also handles 'set' magic.
10144 Usually used via its frontend C<sv_catpvf_mg>.
10150 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
10152 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
10154 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
10159 =for apidoc sv_vsetpvfn
10161 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
10164 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
10170 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10171 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10173 PERL_ARGS_ASSERT_SV_VSETPVFN;
10176 sv_vcatpvfn_flags(sv, pat, patlen, args, svargs, svmax, maybe_tainted, 0);
10181 * Warn of missing argument to sprintf, and then return a defined value
10182 * to avoid inappropriate "use of uninit" warnings [perl #71000].
10184 #define WARN_MISSING WARN_UNINITIALIZED /* Not sure we want a new category */
10186 S_vcatpvfn_missing_argument(pTHX) {
10187 if (ckWARN(WARN_MISSING)) {
10188 Perl_warner(aTHX_ packWARN(WARN_MISSING), "Missing argument in %s",
10189 PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn()");
10196 S_expect_number(pTHX_ char **const pattern)
10201 PERL_ARGS_ASSERT_EXPECT_NUMBER;
10203 switch (**pattern) {
10204 case '1': case '2': case '3':
10205 case '4': case '5': case '6':
10206 case '7': case '8': case '9':
10207 var = *(*pattern)++ - '0';
10208 while (isDIGIT(**pattern)) {
10209 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
10211 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_DESC(PL_op) : "sv_vcatpvfn"));
10219 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
10221 const int neg = nv < 0;
10224 PERL_ARGS_ASSERT_F0CONVERT;
10232 if (uv & 1 && uv == nv)
10233 uv--; /* Round to even */
10235 const unsigned dig = uv % 10;
10237 } while (uv /= 10);
10248 =for apidoc sv_vcatpvfn
10250 =for apidoc sv_vcatpvfn_flags
10252 Processes its arguments like C<vsprintf> and appends the formatted output
10253 to an SV. Uses an array of SVs if the C style variable argument list is
10254 missing (NULL). When running with taint checks enabled, indicates via
10255 C<maybe_tainted> if results are untrustworthy (often due to the use of
10258 If called as C<sv_vcatpvfn> or flags include C<SV_GMAGIC>, calls get magic.
10260 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
10265 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
10266 vecstr = (U8*)SvPV_const(vecsv,veclen);\
10267 vec_utf8 = DO_UTF8(vecsv);
10269 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
10272 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10273 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
10275 PERL_ARGS_ASSERT_SV_VCATPVFN;
10277 sv_vcatpvfn_flags(sv, pat, patlen, args, svargs, svmax, maybe_tainted, SV_GMAGIC|SV_SMAGIC);
10281 Perl_sv_vcatpvfn_flags(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
10282 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted,
10288 const char *patend;
10291 static const char nullstr[] = "(null)";
10293 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
10294 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
10296 /* Times 4: a decimal digit takes more than 3 binary digits.
10297 * NV_DIG: mantissa takes than many decimal digits.
10298 * Plus 32: Playing safe. */
10299 char ebuf[IV_DIG * 4 + NV_DIG + 32];
10300 /* large enough for "%#.#f" --chip */
10301 /* what about long double NVs? --jhi */
10303 PERL_ARGS_ASSERT_SV_VCATPVFN_FLAGS;
10304 PERL_UNUSED_ARG(maybe_tainted);
10306 if (flags & SV_GMAGIC)
10309 /* no matter what, this is a string now */
10310 (void)SvPV_force_nomg(sv, origlen);
10312 /* special-case "", "%s", and "%-p" (SVf - see below) */
10315 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
10317 const char * const s = va_arg(*args, char*);
10318 sv_catpv_nomg(sv, s ? s : nullstr);
10320 else if (svix < svmax) {
10321 /* we want get magic on the source but not the target. sv_catsv can't do that, though */
10322 SvGETMAGIC(*svargs);
10323 sv_catsv_nomg(sv, *svargs);
10326 S_vcatpvfn_missing_argument(aTHX);
10329 if (args && patlen == 3 && pat[0] == '%' &&
10330 pat[1] == '-' && pat[2] == 'p') {
10331 argsv = MUTABLE_SV(va_arg(*args, void*));
10332 sv_catsv_nomg(sv, argsv);
10336 #ifndef USE_LONG_DOUBLE
10337 /* special-case "%.<number>[gf]" */
10338 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
10339 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
10340 unsigned digits = 0;
10344 while (*pp >= '0' && *pp <= '9')
10345 digits = 10 * digits + (*pp++ - '0');
10346 if (pp - pat == (int)patlen - 1 && svix < svmax) {
10347 const NV nv = SvNV(*svargs);
10349 /* Add check for digits != 0 because it seems that some
10350 gconverts are buggy in this case, and we don't yet have
10351 a Configure test for this. */
10352 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
10353 /* 0, point, slack */
10354 Gconvert(nv, (int)digits, 0, ebuf);
10355 sv_catpv_nomg(sv, ebuf);
10356 if (*ebuf) /* May return an empty string for digits==0 */
10359 } else if (!digits) {
10362 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
10363 sv_catpvn_nomg(sv, p, l);
10369 #endif /* !USE_LONG_DOUBLE */
10371 if (!args && svix < svmax && DO_UTF8(*svargs))
10374 patend = (char*)pat + patlen;
10375 for (p = (char*)pat; p < patend; p = q) {
10378 bool vectorize = FALSE;
10379 bool vectorarg = FALSE;
10380 bool vec_utf8 = FALSE;
10386 bool has_precis = FALSE;
10388 const I32 osvix = svix;
10389 bool is_utf8 = FALSE; /* is this item utf8? */
10390 #ifdef HAS_LDBL_SPRINTF_BUG
10391 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
10392 with sfio - Allen <allens@cpan.org> */
10393 bool fix_ldbl_sprintf_bug = FALSE;
10397 U8 utf8buf[UTF8_MAXBYTES+1];
10398 STRLEN esignlen = 0;
10400 const char *eptr = NULL;
10401 const char *fmtstart;
10404 const U8 *vecstr = NULL;
10411 /* we need a long double target in case HAS_LONG_DOUBLE but
10412 not USE_LONG_DOUBLE
10414 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
10422 const char *dotstr = ".";
10423 STRLEN dotstrlen = 1;
10424 I32 efix = 0; /* explicit format parameter index */
10425 I32 ewix = 0; /* explicit width index */
10426 I32 epix = 0; /* explicit precision index */
10427 I32 evix = 0; /* explicit vector index */
10428 bool asterisk = FALSE;
10430 /* echo everything up to the next format specification */
10431 for (q = p; q < patend && *q != '%'; ++q) ;
10433 if (has_utf8 && !pat_utf8)
10434 sv_catpvn_nomg_utf8_upgrade(sv, p, q - p, nsv);
10436 sv_catpvn_nomg(sv, p, q - p);
10445 We allow format specification elements in this order:
10446 \d+\$ explicit format parameter index
10448 v|\*(\d+\$)?v vector with optional (optionally specified) arg
10449 0 flag (as above): repeated to allow "v02"
10450 \d+|\*(\d+\$)? width using optional (optionally specified) arg
10451 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
10453 [%bcdefginopsuxDFOUX] format (mandatory)
10458 As of perl5.9.3, printf format checking is on by default.
10459 Internally, perl uses %p formats to provide an escape to
10460 some extended formatting. This block deals with those
10461 extensions: if it does not match, (char*)q is reset and
10462 the normal format processing code is used.
10464 Currently defined extensions are:
10465 %p include pointer address (standard)
10466 %-p (SVf) include an SV (previously %_)
10467 %-<num>p include an SV with precision <num>
10469 %3p include a HEK with precision of 256
10470 %4p char* preceded by utf8 flag and length
10471 %<num>p (where num is 1 or > 4) reserved for future
10474 Robin Barker 2005-07-14 (but modified since)
10476 %1p (VDf) removed. RMB 2007-10-19
10483 else if (strnEQ(q, UTF8f, sizeof(UTF8f)-1)) { /* UTF8f */
10484 is_utf8 = cBOOL(va_arg(*args, UV));
10485 elen = va_arg(*args, STRLEN);
10486 eptr = va_arg(*args, char *);
10487 q += sizeof(UTF8f)-1;
10490 n = expect_number(&q);
10492 if (sv) { /* SVf */
10497 argsv = MUTABLE_SV(va_arg(*args, void*));
10498 eptr = SvPV_const(argsv, elen);
10499 if (DO_UTF8(argsv))
10503 else if (n==2 || n==3) { /* HEKf */
10504 HEK * const hek = va_arg(*args, HEK *);
10505 eptr = HEK_KEY(hek);
10506 elen = HEK_LEN(hek);
10507 if (HEK_UTF8(hek)) is_utf8 = TRUE;
10508 if (n==3) precis = 256, has_precis = TRUE;
10512 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
10513 "internal %%<num>p might conflict with future printf extensions");
10519 if ( (width = expect_number(&q)) ) {
10534 if (plus == '+' && *q == ' ') /* '+' over ' ' */
10563 if ( (ewix = expect_number(&q)) )
10572 if ((vectorarg = asterisk)) {
10585 width = expect_number(&q);
10588 if (vectorize && vectorarg) {
10589 /* vectorizing, but not with the default "." */
10591 vecsv = va_arg(*args, SV*);
10593 vecsv = (evix > 0 && evix <= svmax)
10594 ? svargs[evix-1] : S_vcatpvfn_missing_argument(aTHX);
10596 vecsv = svix < svmax
10597 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10599 dotstr = SvPV_const(vecsv, dotstrlen);
10600 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
10601 bad with tied or overloaded values that return UTF8. */
10602 if (DO_UTF8(vecsv))
10604 else if (has_utf8) {
10605 vecsv = sv_mortalcopy(vecsv);
10606 sv_utf8_upgrade(vecsv);
10607 dotstr = SvPV_const(vecsv, dotstrlen);
10614 i = va_arg(*args, int);
10616 i = (ewix ? ewix <= svmax : svix < svmax) ?
10617 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10619 width = (i < 0) ? -i : i;
10629 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
10631 /* XXX: todo, support specified precision parameter */
10635 i = va_arg(*args, int);
10637 i = (ewix ? ewix <= svmax : svix < svmax)
10638 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
10640 has_precis = !(i < 0);
10644 while (isDIGIT(*q))
10645 precis = precis * 10 + (*q++ - '0');
10654 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
10655 vecsv = svargs[efix ? efix-1 : svix++];
10656 vecstr = (U8*)SvPV_const(vecsv,veclen);
10657 vec_utf8 = DO_UTF8(vecsv);
10659 /* if this is a version object, we need to convert
10660 * back into v-string notation and then let the
10661 * vectorize happen normally
10663 if (sv_isobject(vecsv) && sv_derived_from(vecsv, "version")) {
10664 if ( hv_exists(MUTABLE_HV(SvRV(vecsv)), "alpha", 5 ) ) {
10665 Perl_ck_warner_d(aTHX_ packWARN(WARN_PRINTF),
10666 "vector argument not supported with alpha versions");
10669 vecsv = sv_newmortal();
10670 scan_vstring((char *)vecstr, (char *)vecstr + veclen,
10672 vecstr = (U8*)SvPV_const(vecsv, veclen);
10673 vec_utf8 = DO_UTF8(vecsv);
10687 case 'I': /* Ix, I32x, and I64x */
10688 # ifdef USE_64_BIT_INT
10689 if (q[1] == '6' && q[2] == '4') {
10695 if (q[1] == '3' && q[2] == '2') {
10699 # ifdef USE_64_BIT_INT
10705 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10717 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
10718 if (*q == 'l') { /* lld, llf */
10727 if (*++q == 'h') { /* hhd, hhu */
10756 if (!vectorize && !args) {
10758 const I32 i = efix-1;
10759 argsv = (i >= 0 && i < svmax)
10760 ? svargs[i] : S_vcatpvfn_missing_argument(aTHX);
10762 argsv = (svix >= 0 && svix < svmax)
10763 ? svargs[svix++] : S_vcatpvfn_missing_argument(aTHX);
10767 switch (c = *q++) {
10774 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
10776 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
10778 eptr = (char*)utf8buf;
10779 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
10793 eptr = va_arg(*args, char*);
10795 elen = strlen(eptr);
10797 eptr = (char *)nullstr;
10798 elen = sizeof nullstr - 1;
10802 eptr = SvPV_const(argsv, elen);
10803 if (DO_UTF8(argsv)) {
10804 STRLEN old_precis = precis;
10805 if (has_precis && precis < elen) {
10806 STRLEN ulen = sv_or_pv_len_utf8(argsv, eptr, elen);
10807 STRLEN p = precis > ulen ? ulen : precis;
10808 precis = sv_or_pv_pos_u2b(argsv, eptr, p, 0);
10809 /* sticks at end */
10811 if (width) { /* fudge width (can't fudge elen) */
10812 if (has_precis && precis < elen)
10813 width += precis - old_precis;
10816 elen - sv_or_pv_len_utf8(argsv,eptr,elen);
10823 if (has_precis && precis < elen)
10830 if (alt || vectorize)
10832 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
10853 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10862 esignbuf[esignlen++] = plus;
10866 case 'c': iv = (char)va_arg(*args, int); break;
10867 case 'h': iv = (short)va_arg(*args, int); break;
10868 case 'l': iv = va_arg(*args, long); break;
10869 case 'V': iv = va_arg(*args, IV); break;
10870 case 'z': iv = va_arg(*args, SSize_t); break;
10871 case 't': iv = va_arg(*args, ptrdiff_t); break;
10872 default: iv = va_arg(*args, int); break;
10874 case 'j': iv = va_arg(*args, intmax_t); break;
10878 iv = va_arg(*args, Quad_t); break;
10885 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
10887 case 'c': iv = (char)tiv; break;
10888 case 'h': iv = (short)tiv; break;
10889 case 'l': iv = (long)tiv; break;
10891 default: iv = tiv; break;
10894 iv = (Quad_t)tiv; break;
10900 if ( !vectorize ) /* we already set uv above */
10905 esignbuf[esignlen++] = plus;
10909 esignbuf[esignlen++] = '-';
10953 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
10964 case 'c': uv = (unsigned char)va_arg(*args, unsigned); break;
10965 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
10966 case 'l': uv = va_arg(*args, unsigned long); break;
10967 case 'V': uv = va_arg(*args, UV); break;
10968 case 'z': uv = va_arg(*args, Size_t); break;
10969 case 't': uv = va_arg(*args, ptrdiff_t); break; /* will sign extend, but there is no uptrdiff_t, so oh well */
10971 case 'j': uv = va_arg(*args, uintmax_t); break;
10973 default: uv = va_arg(*args, unsigned); break;
10976 uv = va_arg(*args, Uquad_t); break;
10983 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
10985 case 'c': uv = (unsigned char)tuv; break;
10986 case 'h': uv = (unsigned short)tuv; break;
10987 case 'l': uv = (unsigned long)tuv; break;
10989 default: uv = tuv; break;
10992 uv = (Uquad_t)tuv; break;
11001 char *ptr = ebuf + sizeof ebuf;
11002 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
11008 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
11012 } while (uv >>= 4);
11014 esignbuf[esignlen++] = '0';
11015 esignbuf[esignlen++] = c; /* 'x' or 'X' */
11021 *--ptr = '0' + dig;
11022 } while (uv >>= 3);
11023 if (alt && *ptr != '0')
11029 *--ptr = '0' + dig;
11030 } while (uv >>= 1);
11032 esignbuf[esignlen++] = '0';
11033 esignbuf[esignlen++] = c;
11036 default: /* it had better be ten or less */
11039 *--ptr = '0' + dig;
11040 } while (uv /= base);
11043 elen = (ebuf + sizeof ebuf) - ptr;
11047 zeros = precis - elen;
11048 else if (precis == 0 && elen == 1 && *eptr == '0'
11049 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
11052 /* a precision nullifies the 0 flag. */
11059 /* FLOATING POINT */
11062 c = 'f'; /* maybe %F isn't supported here */
11064 case 'e': case 'E':
11066 case 'g': case 'G':
11070 /* This is evil, but floating point is even more evil */
11072 /* for SV-style calling, we can only get NV
11073 for C-style calling, we assume %f is double;
11074 for simplicity we allow any of %Lf, %llf, %qf for long double
11078 #if defined(USE_LONG_DOUBLE)
11082 /* [perl #20339] - we should accept and ignore %lf rather than die */
11086 #if defined(USE_LONG_DOUBLE)
11087 intsize = args ? 0 : 'q';
11091 #if defined(HAS_LONG_DOUBLE)
11104 /* now we need (long double) if intsize == 'q', else (double) */
11106 #if LONG_DOUBLESIZE > DOUBLESIZE
11108 va_arg(*args, long double) :
11109 va_arg(*args, double)
11111 va_arg(*args, double)
11116 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
11117 else. frexp() has some unspecified behaviour for those three */
11118 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
11120 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
11121 will cast our (long double) to (double) */
11122 (void)Perl_frexp(nv, &i);
11123 if (i == PERL_INT_MIN)
11124 Perl_die(aTHX_ "panic: frexp");
11126 need = BIT_DIGITS(i);
11128 need += has_precis ? precis : 6; /* known default */
11133 #ifdef HAS_LDBL_SPRINTF_BUG
11134 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
11135 with sfio - Allen <allens@cpan.org> */
11138 # define MY_DBL_MAX DBL_MAX
11139 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
11140 # if DOUBLESIZE >= 8
11141 # define MY_DBL_MAX 1.7976931348623157E+308L
11143 # define MY_DBL_MAX 3.40282347E+38L
11147 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
11148 # define MY_DBL_MAX_BUG 1L
11150 # define MY_DBL_MAX_BUG MY_DBL_MAX
11154 # define MY_DBL_MIN DBL_MIN
11155 # else /* XXX guessing! -Allen */
11156 # if DOUBLESIZE >= 8
11157 # define MY_DBL_MIN 2.2250738585072014E-308L
11159 # define MY_DBL_MIN 1.17549435E-38L
11163 if ((intsize == 'q') && (c == 'f') &&
11164 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
11165 (need < DBL_DIG)) {
11166 /* it's going to be short enough that
11167 * long double precision is not needed */
11169 if ((nv <= 0L) && (nv >= -0L))
11170 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
11172 /* would use Perl_fp_class as a double-check but not
11173 * functional on IRIX - see perl.h comments */
11175 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
11176 /* It's within the range that a double can represent */
11177 #if defined(DBL_MAX) && !defined(DBL_MIN)
11178 if ((nv >= ((long double)1/DBL_MAX)) ||
11179 (nv <= (-(long double)1/DBL_MAX)))
11181 fix_ldbl_sprintf_bug = TRUE;
11184 if (fix_ldbl_sprintf_bug == TRUE) {
11194 # undef MY_DBL_MAX_BUG
11197 #endif /* HAS_LDBL_SPRINTF_BUG */
11199 need += 20; /* fudge factor */
11200 if (PL_efloatsize < need) {
11201 Safefree(PL_efloatbuf);
11202 PL_efloatsize = need + 20; /* more fudge */
11203 Newx(PL_efloatbuf, PL_efloatsize, char);
11204 PL_efloatbuf[0] = '\0';
11207 if ( !(width || left || plus || alt) && fill != '0'
11208 && has_precis && intsize != 'q' ) { /* Shortcuts */
11209 /* See earlier comment about buggy Gconvert when digits,
11211 if ( c == 'g' && precis) {
11212 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
11213 /* May return an empty string for digits==0 */
11214 if (*PL_efloatbuf) {
11215 elen = strlen(PL_efloatbuf);
11216 goto float_converted;
11218 } else if ( c == 'f' && !precis) {
11219 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
11224 char *ptr = ebuf + sizeof ebuf;
11227 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
11228 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
11229 if (intsize == 'q') {
11230 /* Copy the one or more characters in a long double
11231 * format before the 'base' ([efgEFG]) character to
11232 * the format string. */
11233 static char const prifldbl[] = PERL_PRIfldbl;
11234 char const *p = prifldbl + sizeof(prifldbl) - 3;
11235 while (p >= prifldbl) { *--ptr = *p--; }
11240 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11245 do { *--ptr = '0' + (base % 10); } while (base /= 10);
11257 /* No taint. Otherwise we are in the strange situation
11258 * where printf() taints but print($float) doesn't.
11260 #if defined(HAS_LONG_DOUBLE)
11261 elen = ((intsize == 'q')
11262 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
11263 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
11265 elen = my_sprintf(PL_efloatbuf, ptr, nv);
11269 eptr = PL_efloatbuf;
11277 i = SvCUR(sv) - origlen;
11280 case 'c': *(va_arg(*args, char*)) = i; break;
11281 case 'h': *(va_arg(*args, short*)) = i; break;
11282 default: *(va_arg(*args, int*)) = i; break;
11283 case 'l': *(va_arg(*args, long*)) = i; break;
11284 case 'V': *(va_arg(*args, IV*)) = i; break;
11285 case 'z': *(va_arg(*args, SSize_t*)) = i; break;
11286 case 't': *(va_arg(*args, ptrdiff_t*)) = i; break;
11288 case 'j': *(va_arg(*args, intmax_t*)) = i; break;
11292 *(va_arg(*args, Quad_t*)) = i; break;
11299 sv_setuv_mg(argsv, has_utf8 ? (UV)sv_len_utf8(sv) : (UV)i);
11300 continue; /* not "break" */
11307 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
11308 && ckWARN(WARN_PRINTF))
11310 SV * const msg = sv_newmortal();
11311 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
11312 (PL_op->op_type == OP_PRTF) ? "" : "s");
11313 if (fmtstart < patend) {
11314 const char * const fmtend = q < patend ? q : patend;
11316 sv_catpvs(msg, "\"%");
11317 for (f = fmtstart; f < fmtend; f++) {
11319 sv_catpvn_nomg(msg, f, 1);
11321 Perl_sv_catpvf(aTHX_ msg,
11322 "\\%03"UVof, (UV)*f & 0xFF);
11325 sv_catpvs(msg, "\"");
11327 sv_catpvs(msg, "end of string");
11329 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
11332 /* output mangled stuff ... */
11338 /* ... right here, because formatting flags should not apply */
11339 SvGROW(sv, SvCUR(sv) + elen + 1);
11341 Copy(eptr, p, elen, char);
11344 SvCUR_set(sv, p - SvPVX_const(sv));
11346 continue; /* not "break" */
11349 if (is_utf8 != has_utf8) {
11352 sv_utf8_upgrade(sv);
11355 const STRLEN old_elen = elen;
11356 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
11357 sv_utf8_upgrade(nsv);
11358 eptr = SvPVX_const(nsv);
11361 if (width) { /* fudge width (can't fudge elen) */
11362 width += elen - old_elen;
11368 have = esignlen + zeros + elen;
11370 Perl_croak_memory_wrap();
11372 need = (have > width ? have : width);
11375 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
11376 Perl_croak_memory_wrap();
11377 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
11379 if (esignlen && fill == '0') {
11381 for (i = 0; i < (int)esignlen; i++)
11382 *p++ = esignbuf[i];
11384 if (gap && !left) {
11385 memset(p, fill, gap);
11388 if (esignlen && fill != '0') {
11390 for (i = 0; i < (int)esignlen; i++)
11391 *p++ = esignbuf[i];
11395 for (i = zeros; i; i--)
11399 Copy(eptr, p, elen, char);
11403 memset(p, ' ', gap);
11408 Copy(dotstr, p, dotstrlen, char);
11412 vectorize = FALSE; /* done iterating over vecstr */
11419 SvCUR_set(sv, p - SvPVX_const(sv));
11428 /* =========================================================================
11430 =head1 Cloning an interpreter
11432 All the macros and functions in this section are for the private use of
11433 the main function, perl_clone().
11435 The foo_dup() functions make an exact copy of an existing foo thingy.
11436 During the course of a cloning, a hash table is used to map old addresses
11437 to new addresses. The table is created and manipulated with the
11438 ptr_table_* functions.
11442 * =========================================================================*/
11445 #if defined(USE_ITHREADS)
11447 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
11448 #ifndef GpREFCNT_inc
11449 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
11453 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
11454 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
11455 If this changes, please unmerge ss_dup.
11456 Likewise, sv_dup_inc_multiple() relies on this fact. */
11457 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup_inc(s,t))
11458 #define av_dup(s,t) MUTABLE_AV(sv_dup((const SV *)s,t))
11459 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11460 #define hv_dup(s,t) MUTABLE_HV(sv_dup((const SV *)s,t))
11461 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11462 #define cv_dup(s,t) MUTABLE_CV(sv_dup((const SV *)s,t))
11463 #define cv_dup_inc(s,t) MUTABLE_CV(sv_dup_inc((const SV *)s,t))
11464 #define io_dup(s,t) MUTABLE_IO(sv_dup((const SV *)s,t))
11465 #define io_dup_inc(s,t) MUTABLE_IO(sv_dup_inc((const SV *)s,t))
11466 #define gv_dup(s,t) MUTABLE_GV(sv_dup((const SV *)s,t))
11467 #define gv_dup_inc(s,t) MUTABLE_GV(sv_dup_inc((const SV *)s,t))
11468 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
11469 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
11471 /* clone a parser */
11474 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
11478 PERL_ARGS_ASSERT_PARSER_DUP;
11483 /* look for it in the table first */
11484 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
11488 /* create anew and remember what it is */
11489 Newxz(parser, 1, yy_parser);
11490 ptr_table_store(PL_ptr_table, proto, parser);
11492 /* XXX these not yet duped */
11493 parser->old_parser = NULL;
11494 parser->stack = NULL;
11496 parser->stack_size = 0;
11497 /* XXX parser->stack->state = 0; */
11499 /* XXX eventually, just Copy() most of the parser struct ? */
11501 parser->lex_brackets = proto->lex_brackets;
11502 parser->lex_casemods = proto->lex_casemods;
11503 parser->lex_brackstack = savepvn(proto->lex_brackstack,
11504 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
11505 parser->lex_casestack = savepvn(proto->lex_casestack,
11506 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
11507 parser->lex_defer = proto->lex_defer;
11508 parser->lex_dojoin = proto->lex_dojoin;
11509 parser->lex_expect = proto->lex_expect;
11510 parser->lex_formbrack = proto->lex_formbrack;
11511 parser->lex_inpat = proto->lex_inpat;
11512 parser->lex_inwhat = proto->lex_inwhat;
11513 parser->lex_op = proto->lex_op;
11514 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
11515 parser->lex_starts = proto->lex_starts;
11516 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
11517 parser->multi_close = proto->multi_close;
11518 parser->multi_open = proto->multi_open;
11519 parser->multi_start = proto->multi_start;
11520 parser->multi_end = proto->multi_end;
11521 parser->preambled = proto->preambled;
11522 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
11523 parser->linestr = sv_dup_inc(proto->linestr, param);
11524 parser->expect = proto->expect;
11525 parser->copline = proto->copline;
11526 parser->last_lop_op = proto->last_lop_op;
11527 parser->lex_state = proto->lex_state;
11528 parser->rsfp = fp_dup(proto->rsfp, '<', param);
11529 /* rsfp_filters entries have fake IoDIRP() */
11530 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
11531 parser->in_my = proto->in_my;
11532 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
11533 parser->error_count = proto->error_count;
11536 parser->linestr = sv_dup_inc(proto->linestr, param);
11539 char * const ols = SvPVX(proto->linestr);
11540 char * const ls = SvPVX(parser->linestr);
11542 parser->bufptr = ls + (proto->bufptr >= ols ?
11543 proto->bufptr - ols : 0);
11544 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
11545 proto->oldbufptr - ols : 0);
11546 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
11547 proto->oldoldbufptr - ols : 0);
11548 parser->linestart = ls + (proto->linestart >= ols ?
11549 proto->linestart - ols : 0);
11550 parser->last_uni = ls + (proto->last_uni >= ols ?
11551 proto->last_uni - ols : 0);
11552 parser->last_lop = ls + (proto->last_lop >= ols ?
11553 proto->last_lop - ols : 0);
11555 parser->bufend = ls + SvCUR(parser->linestr);
11558 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
11562 parser->endwhite = proto->endwhite;
11563 parser->faketokens = proto->faketokens;
11564 parser->lasttoke = proto->lasttoke;
11565 parser->nextwhite = proto->nextwhite;
11566 parser->realtokenstart = proto->realtokenstart;
11567 parser->skipwhite = proto->skipwhite;
11568 parser->thisclose = proto->thisclose;
11569 parser->thismad = proto->thismad;
11570 parser->thisopen = proto->thisopen;
11571 parser->thisstuff = proto->thisstuff;
11572 parser->thistoken = proto->thistoken;
11573 parser->thiswhite = proto->thiswhite;
11575 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
11576 parser->curforce = proto->curforce;
11578 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
11579 Copy(proto->nexttype, parser->nexttype, 5, I32);
11580 parser->nexttoke = proto->nexttoke;
11583 /* XXX should clone saved_curcop here, but we aren't passed
11584 * proto_perl; so do it in perl_clone_using instead */
11590 /* duplicate a file handle */
11593 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
11597 PERL_ARGS_ASSERT_FP_DUP;
11598 PERL_UNUSED_ARG(type);
11601 return (PerlIO*)NULL;
11603 /* look for it in the table first */
11604 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
11608 /* create anew and remember what it is */
11609 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
11610 ptr_table_store(PL_ptr_table, fp, ret);
11614 /* duplicate a directory handle */
11617 Perl_dirp_dup(pTHX_ DIR *const dp, CLONE_PARAMS *const param)
11623 const Direntry_t *dirent;
11624 char smallbuf[256];
11630 PERL_UNUSED_CONTEXT;
11631 PERL_ARGS_ASSERT_DIRP_DUP;
11636 /* look for it in the table first */
11637 ret = (DIR*)ptr_table_fetch(PL_ptr_table, dp);
11643 PERL_UNUSED_ARG(param);
11647 /* open the current directory (so we can switch back) */
11648 if (!(pwd = PerlDir_open("."))) return (DIR *)NULL;
11650 /* chdir to our dir handle and open the present working directory */
11651 if (fchdir(my_dirfd(dp)) < 0 || !(ret = PerlDir_open("."))) {
11652 PerlDir_close(pwd);
11653 return (DIR *)NULL;
11655 /* Now we should have two dir handles pointing to the same dir. */
11657 /* Be nice to the calling code and chdir back to where we were. */
11658 fchdir(my_dirfd(pwd)); /* If this fails, then what? */
11660 /* We have no need of the pwd handle any more. */
11661 PerlDir_close(pwd);
11664 # define d_namlen(d) (d)->d_namlen
11666 # define d_namlen(d) strlen((d)->d_name)
11668 /* Iterate once through dp, to get the file name at the current posi-
11669 tion. Then step back. */
11670 pos = PerlDir_tell(dp);
11671 if ((dirent = PerlDir_read(dp))) {
11672 len = d_namlen(dirent);
11673 if (len <= sizeof smallbuf) name = smallbuf;
11674 else Newx(name, len, char);
11675 Move(dirent->d_name, name, len, char);
11677 PerlDir_seek(dp, pos);
11679 /* Iterate through the new dir handle, till we find a file with the
11681 if (!dirent) /* just before the end */
11683 pos = PerlDir_tell(ret);
11684 if (PerlDir_read(ret)) continue; /* not there yet */
11685 PerlDir_seek(ret, pos); /* step back */
11689 const long pos0 = PerlDir_tell(ret);
11691 pos = PerlDir_tell(ret);
11692 if ((dirent = PerlDir_read(ret))) {
11693 if (len == d_namlen(dirent)
11694 && memEQ(name, dirent->d_name, len)) {
11696 PerlDir_seek(ret, pos); /* step back */
11699 /* else we are not there yet; keep iterating */
11701 else { /* This is not meant to happen. The best we can do is
11702 reset the iterator to the beginning. */
11703 PerlDir_seek(ret, pos0);
11710 if (name && name != smallbuf)
11715 ret = win32_dirp_dup(dp, param);
11718 /* pop it in the pointer table */
11720 ptr_table_store(PL_ptr_table, dp, ret);
11725 /* duplicate a typeglob */
11728 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
11732 PERL_ARGS_ASSERT_GP_DUP;
11736 /* look for it in the table first */
11737 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
11741 /* create anew and remember what it is */
11743 ptr_table_store(PL_ptr_table, gp, ret);
11746 /* ret->gp_refcnt must be 0 before any other dups are called. We're relying
11747 on Newxz() to do this for us. */
11748 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
11749 ret->gp_io = io_dup_inc(gp->gp_io, param);
11750 ret->gp_form = cv_dup_inc(gp->gp_form, param);
11751 ret->gp_av = av_dup_inc(gp->gp_av, param);
11752 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
11753 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
11754 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
11755 ret->gp_cvgen = gp->gp_cvgen;
11756 ret->gp_line = gp->gp_line;
11757 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
11761 /* duplicate a chain of magic */
11764 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
11766 MAGIC *mgret = NULL;
11767 MAGIC **mgprev_p = &mgret;
11769 PERL_ARGS_ASSERT_MG_DUP;
11771 for (; mg; mg = mg->mg_moremagic) {
11774 if ((param->flags & CLONEf_JOIN_IN)
11775 && mg->mg_type == PERL_MAGIC_backref)
11776 /* when joining, we let the individual SVs add themselves to
11777 * backref as needed. */
11780 Newx(nmg, 1, MAGIC);
11782 mgprev_p = &(nmg->mg_moremagic);
11784 /* There was a comment "XXX copy dynamic vtable?" but as we don't have
11785 dynamic vtables, I'm not sure why Sarathy wrote it. The comment dates
11786 from the original commit adding Perl_mg_dup() - revision 4538.
11787 Similarly there is the annotation "XXX random ptr?" next to the
11788 assignment to nmg->mg_ptr. */
11791 /* FIXME for plugins
11792 if (nmg->mg_type == PERL_MAGIC_qr) {
11793 nmg->mg_obj = MUTABLE_SV(CALLREGDUPE((REGEXP*)nmg->mg_obj, param));
11797 nmg->mg_obj = (nmg->mg_flags & MGf_REFCOUNTED)
11798 ? nmg->mg_type == PERL_MAGIC_backref
11799 /* The backref AV has its reference
11800 * count deliberately bumped by 1 */
11801 ? SvREFCNT_inc(av_dup_inc((const AV *)
11802 nmg->mg_obj, param))
11803 : sv_dup_inc(nmg->mg_obj, param)
11804 : sv_dup(nmg->mg_obj, param);
11806 if (nmg->mg_ptr && nmg->mg_type != PERL_MAGIC_regex_global) {
11807 if (nmg->mg_len > 0) {
11808 nmg->mg_ptr = SAVEPVN(nmg->mg_ptr, nmg->mg_len);
11809 if (nmg->mg_type == PERL_MAGIC_overload_table &&
11810 AMT_AMAGIC((AMT*)nmg->mg_ptr))
11812 AMT * const namtp = (AMT*)nmg->mg_ptr;
11813 sv_dup_inc_multiple((SV**)(namtp->table),
11814 (SV**)(namtp->table), NofAMmeth, param);
11817 else if (nmg->mg_len == HEf_SVKEY)
11818 nmg->mg_ptr = (char*)sv_dup_inc((const SV *)nmg->mg_ptr, param);
11820 if ((nmg->mg_flags & MGf_DUP) && nmg->mg_virtual && nmg->mg_virtual->svt_dup) {
11821 nmg->mg_virtual->svt_dup(aTHX_ nmg, param);
11827 #endif /* USE_ITHREADS */
11829 struct ptr_tbl_arena {
11830 struct ptr_tbl_arena *next;
11831 struct ptr_tbl_ent array[1023/3]; /* as ptr_tbl_ent has 3 pointers. */
11834 /* create a new pointer-mapping table */
11837 Perl_ptr_table_new(pTHX)
11840 PERL_UNUSED_CONTEXT;
11842 Newx(tbl, 1, PTR_TBL_t);
11843 tbl->tbl_max = 511;
11844 tbl->tbl_items = 0;
11845 tbl->tbl_arena = NULL;
11846 tbl->tbl_arena_next = NULL;
11847 tbl->tbl_arena_end = NULL;
11848 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
11852 #define PTR_TABLE_HASH(ptr) \
11853 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
11855 /* map an existing pointer using a table */
11857 STATIC PTR_TBL_ENT_t *
11858 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
11860 PTR_TBL_ENT_t *tblent;
11861 const UV hash = PTR_TABLE_HASH(sv);
11863 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
11865 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
11866 for (; tblent; tblent = tblent->next) {
11867 if (tblent->oldval == sv)
11874 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
11876 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
11878 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
11879 PERL_UNUSED_CONTEXT;
11881 return tblent ? tblent->newval : NULL;
11884 /* add a new entry to a pointer-mapping table */
11887 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
11889 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
11891 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
11892 PERL_UNUSED_CONTEXT;
11895 tblent->newval = newsv;
11897 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
11899 if (tbl->tbl_arena_next == tbl->tbl_arena_end) {
11900 struct ptr_tbl_arena *new_arena;
11902 Newx(new_arena, 1, struct ptr_tbl_arena);
11903 new_arena->next = tbl->tbl_arena;
11904 tbl->tbl_arena = new_arena;
11905 tbl->tbl_arena_next = new_arena->array;
11906 tbl->tbl_arena_end = new_arena->array
11907 + sizeof(new_arena->array) / sizeof(new_arena->array[0]);
11910 tblent = tbl->tbl_arena_next++;
11912 tblent->oldval = oldsv;
11913 tblent->newval = newsv;
11914 tblent->next = tbl->tbl_ary[entry];
11915 tbl->tbl_ary[entry] = tblent;
11917 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
11918 ptr_table_split(tbl);
11922 /* double the hash bucket size of an existing ptr table */
11925 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
11927 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
11928 const UV oldsize = tbl->tbl_max + 1;
11929 UV newsize = oldsize * 2;
11932 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
11933 PERL_UNUSED_CONTEXT;
11935 Renew(ary, newsize, PTR_TBL_ENT_t*);
11936 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
11937 tbl->tbl_max = --newsize;
11938 tbl->tbl_ary = ary;
11939 for (i=0; i < oldsize; i++, ary++) {
11940 PTR_TBL_ENT_t **entp = ary;
11941 PTR_TBL_ENT_t *ent = *ary;
11942 PTR_TBL_ENT_t **curentp;
11945 curentp = ary + oldsize;
11947 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
11949 ent->next = *curentp;
11959 /* remove all the entries from a ptr table */
11960 /* Deprecated - will be removed post 5.14 */
11963 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
11965 if (tbl && tbl->tbl_items) {
11966 struct ptr_tbl_arena *arena = tbl->tbl_arena;
11968 Zero(tbl->tbl_ary, tbl->tbl_max + 1, struct ptr_tbl_ent **);
11971 struct ptr_tbl_arena *next = arena->next;
11977 tbl->tbl_items = 0;
11978 tbl->tbl_arena = NULL;
11979 tbl->tbl_arena_next = NULL;
11980 tbl->tbl_arena_end = NULL;
11984 /* clear and free a ptr table */
11987 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
11989 struct ptr_tbl_arena *arena;
11995 arena = tbl->tbl_arena;
11998 struct ptr_tbl_arena *next = arena->next;
12004 Safefree(tbl->tbl_ary);
12008 #if defined(USE_ITHREADS)
12011 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
12013 PERL_ARGS_ASSERT_RVPV_DUP;
12015 assert(!isREGEXP(sstr));
12017 if (SvWEAKREF(sstr)) {
12018 SvRV_set(dstr, sv_dup(SvRV_const(sstr), param));
12019 if (param->flags & CLONEf_JOIN_IN) {
12020 /* if joining, we add any back references individually rather
12021 * than copying the whole backref array */
12022 Perl_sv_add_backref(aTHX_ SvRV(dstr), dstr);
12026 SvRV_set(dstr, sv_dup_inc(SvRV_const(sstr), param));
12028 else if (SvPVX_const(sstr)) {
12029 /* Has something there */
12031 /* Normal PV - clone whole allocated space */
12032 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
12033 /* sstr may not be that normal, but actually copy on write.
12034 But we are a true, independent SV, so: */
12038 /* Special case - not normally malloced for some reason */
12039 if (isGV_with_GP(sstr)) {
12040 /* Don't need to do anything here. */
12042 else if ((SvIsCOW(sstr))) {
12043 /* A "shared" PV - clone it as "shared" PV */
12045 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
12049 /* Some other special case - random pointer */
12050 SvPV_set(dstr, (char *) SvPVX_const(sstr));
12055 /* Copy the NULL */
12056 SvPV_set(dstr, NULL);
12060 /* duplicate a list of SVs. source and dest may point to the same memory. */
12062 S_sv_dup_inc_multiple(pTHX_ SV *const *source, SV **dest,
12063 SSize_t items, CLONE_PARAMS *const param)
12065 PERL_ARGS_ASSERT_SV_DUP_INC_MULTIPLE;
12067 while (items-- > 0) {
12068 *dest++ = sv_dup_inc(*source++, param);
12074 /* duplicate an SV of any type (including AV, HV etc) */
12077 S_sv_dup_common(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12082 PERL_ARGS_ASSERT_SV_DUP_COMMON;
12084 if (SvTYPE(sstr) == (svtype)SVTYPEMASK) {
12085 #ifdef DEBUG_LEAKING_SCALARS_ABORT
12090 /* look for it in the table first */
12091 dstr = MUTABLE_SV(ptr_table_fetch(PL_ptr_table, sstr));
12095 if(param->flags & CLONEf_JOIN_IN) {
12096 /** We are joining here so we don't want do clone
12097 something that is bad **/
12098 if (SvTYPE(sstr) == SVt_PVHV) {
12099 const HEK * const hvname = HvNAME_HEK(sstr);
12101 /** don't clone stashes if they already exist **/
12102 dstr = MUTABLE_SV(gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
12103 HEK_UTF8(hvname) ? SVf_UTF8 : 0));
12104 ptr_table_store(PL_ptr_table, sstr, dstr);
12108 else if (SvTYPE(sstr) == SVt_PVGV && !SvFAKE(sstr)) {
12109 HV *stash = GvSTASH(sstr);
12110 const HEK * hvname;
12111 if (stash && (hvname = HvNAME_HEK(stash))) {
12112 /** don't clone GVs if they already exist **/
12114 stash = gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname),
12115 HEK_UTF8(hvname) ? SVf_UTF8 : 0);
12117 stash, GvNAME(sstr),
12123 if (svp && *svp && SvTYPE(*svp) == SVt_PVGV) {
12124 ptr_table_store(PL_ptr_table, sstr, *svp);
12131 /* create anew and remember what it is */
12134 #ifdef DEBUG_LEAKING_SCALARS
12135 dstr->sv_debug_optype = sstr->sv_debug_optype;
12136 dstr->sv_debug_line = sstr->sv_debug_line;
12137 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
12138 dstr->sv_debug_parent = (SV*)sstr;
12139 FREE_SV_DEBUG_FILE(dstr);
12140 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
12143 ptr_table_store(PL_ptr_table, sstr, dstr);
12146 SvFLAGS(dstr) = SvFLAGS(sstr);
12147 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
12148 SvREFCNT(dstr) = 0; /* must be before any other dups! */
12151 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
12152 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
12153 (void*)PL_watch_pvx, SvPVX_const(sstr));
12156 /* don't clone objects whose class has asked us not to */
12157 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
12162 switch (SvTYPE(sstr)) {
12164 SvANY(dstr) = NULL;
12167 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
12169 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
12171 SvIV_set(dstr, SvIVX(sstr));
12175 SvANY(dstr) = new_XNV();
12176 SvNV_set(dstr, SvNVX(sstr));
12178 /* case SVt_DUMMY: */
12181 /* These are all the types that need complex bodies allocating. */
12183 const svtype sv_type = SvTYPE(sstr);
12184 const struct body_details *const sv_type_details
12185 = bodies_by_type + sv_type;
12189 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
12204 assert(sv_type_details->body_size);
12205 if (sv_type_details->arena) {
12206 new_body_inline(new_body, sv_type);
12208 = (void*)((char*)new_body - sv_type_details->offset);
12210 new_body = new_NOARENA(sv_type_details);
12214 SvANY(dstr) = new_body;
12217 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
12218 ((char*)SvANY(dstr)) + sv_type_details->offset,
12219 sv_type_details->copy, char);
12221 Copy(((char*)SvANY(sstr)),
12222 ((char*)SvANY(dstr)),
12223 sv_type_details->body_size + sv_type_details->offset, char);
12226 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
12227 && !isGV_with_GP(dstr)
12229 && !(sv_type == SVt_PVIO && !(IoFLAGS(dstr) & IOf_FAKE_DIRP)))
12230 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
12232 /* The Copy above means that all the source (unduplicated) pointers
12233 are now in the destination. We can check the flags and the
12234 pointers in either, but it's possible that there's less cache
12235 missing by always going for the destination.
12236 FIXME - instrument and check that assumption */
12237 if (sv_type >= SVt_PVMG) {
12238 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
12239 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
12240 } else if (SvMAGIC(dstr))
12241 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
12242 if (SvOBJECT(dstr) && SvSTASH(dstr))
12243 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
12244 else SvSTASH_set(dstr, 0); /* don't copy DESTROY cache */
12247 /* The cast silences a GCC warning about unhandled types. */
12248 switch ((int)sv_type) {
12259 /* FIXME for plugins */
12260 dstr->sv_u.svu_rx = ((REGEXP *)dstr)->sv_any;
12261 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
12264 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
12265 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
12266 LvTARG(dstr) = dstr;
12267 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
12268 LvTARG(dstr) = MUTABLE_SV(he_dup((HE*)LvTARG(dstr), 0, param));
12270 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
12271 if (isREGEXP(sstr)) goto duprex;
12273 /* non-GP case already handled above */
12274 if(isGV_with_GP(sstr)) {
12275 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
12276 /* Don't call sv_add_backref here as it's going to be
12277 created as part of the magic cloning of the symbol
12278 table--unless this is during a join and the stash
12279 is not actually being cloned. */
12280 /* Danger Will Robinson - GvGP(dstr) isn't initialised
12281 at the point of this comment. */
12282 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
12283 if (param->flags & CLONEf_JOIN_IN)
12284 Perl_sv_add_backref(aTHX_ MUTABLE_SV(GvSTASH(dstr)), dstr);
12285 GvGP_set(dstr, gp_dup(GvGP(sstr), param));
12286 (void)GpREFCNT_inc(GvGP(dstr));
12290 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
12291 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
12292 /* I have no idea why fake dirp (rsfps)
12293 should be treated differently but otherwise
12294 we end up with leaks -- sky*/
12295 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
12296 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
12297 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
12299 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
12300 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
12301 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
12302 if (IoDIRP(dstr)) {
12303 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr), param);
12306 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
12308 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(dstr), param);
12310 if (IoOFP(dstr) == IoIFP(sstr))
12311 IoOFP(dstr) = IoIFP(dstr);
12313 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
12314 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
12315 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
12316 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
12319 /* avoid cloning an empty array */
12320 if (AvARRAY((const AV *)sstr) && AvFILLp((const AV *)sstr) >= 0) {
12321 SV **dst_ary, **src_ary;
12322 SSize_t items = AvFILLp((const AV *)sstr) + 1;
12324 src_ary = AvARRAY((const AV *)sstr);
12325 Newxz(dst_ary, AvMAX((const AV *)sstr)+1, SV*);
12326 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
12327 AvARRAY(MUTABLE_AV(dstr)) = dst_ary;
12328 AvALLOC((const AV *)dstr) = dst_ary;
12329 if (AvREAL((const AV *)sstr)) {
12330 dst_ary = sv_dup_inc_multiple(src_ary, dst_ary, items,
12334 while (items-- > 0)
12335 *dst_ary++ = sv_dup(*src_ary++, param);
12337 items = AvMAX((const AV *)sstr) - AvFILLp((const AV *)sstr);
12338 while (items-- > 0) {
12339 *dst_ary++ = &PL_sv_undef;
12343 AvARRAY(MUTABLE_AV(dstr)) = NULL;
12344 AvALLOC((const AV *)dstr) = (SV**)NULL;
12345 AvMAX( (const AV *)dstr) = -1;
12346 AvFILLp((const AV *)dstr) = -1;
12350 if (HvARRAY((const HV *)sstr)) {
12352 const bool sharekeys = !!HvSHAREKEYS(sstr);
12353 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
12354 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
12356 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
12357 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
12359 HvARRAY(dstr) = (HE**)darray;
12360 while (i <= sxhv->xhv_max) {
12361 const HE * const source = HvARRAY(sstr)[i];
12362 HvARRAY(dstr)[i] = source
12363 ? he_dup(source, sharekeys, param) : 0;
12367 const struct xpvhv_aux * const saux = HvAUX(sstr);
12368 struct xpvhv_aux * const daux = HvAUX(dstr);
12369 /* This flag isn't copied. */
12372 if (saux->xhv_name_count) {
12373 HEK ** const sname = saux->xhv_name_u.xhvnameu_names;
12375 = saux->xhv_name_count < 0
12376 ? -saux->xhv_name_count
12377 : saux->xhv_name_count;
12378 HEK **shekp = sname + count;
12380 Newx(daux->xhv_name_u.xhvnameu_names, count, HEK *);
12381 dhekp = daux->xhv_name_u.xhvnameu_names + count;
12382 while (shekp-- > sname) {
12384 *dhekp = hek_dup(*shekp, param);
12388 daux->xhv_name_u.xhvnameu_name
12389 = hek_dup(saux->xhv_name_u.xhvnameu_name,
12392 daux->xhv_name_count = saux->xhv_name_count;
12394 daux->xhv_fill_lazy = saux->xhv_fill_lazy;
12395 daux->xhv_riter = saux->xhv_riter;
12396 daux->xhv_eiter = saux->xhv_eiter
12397 ? he_dup(saux->xhv_eiter,
12398 cBOOL(HvSHAREKEYS(sstr)), param) : 0;
12399 /* backref array needs refcnt=2; see sv_add_backref */
12400 daux->xhv_backreferences =
12401 (param->flags & CLONEf_JOIN_IN)
12402 /* when joining, we let the individual GVs and
12403 * CVs add themselves to backref as
12404 * needed. This avoids pulling in stuff
12405 * that isn't required, and simplifies the
12406 * case where stashes aren't cloned back
12407 * if they already exist in the parent
12410 : saux->xhv_backreferences
12411 ? (SvTYPE(saux->xhv_backreferences) == SVt_PVAV)
12412 ? MUTABLE_AV(SvREFCNT_inc(
12413 sv_dup_inc((const SV *)
12414 saux->xhv_backreferences, param)))
12415 : MUTABLE_AV(sv_dup((const SV *)
12416 saux->xhv_backreferences, param))
12419 daux->xhv_mro_meta = saux->xhv_mro_meta
12420 ? mro_meta_dup(saux->xhv_mro_meta, param)
12422 daux->xhv_super = NULL;
12424 /* Record stashes for possible cloning in Perl_clone(). */
12426 av_push(param->stashes, dstr);
12430 HvARRAY(MUTABLE_HV(dstr)) = NULL;
12433 if (!(param->flags & CLONEf_COPY_STACKS)) {
12438 /* NOTE: not refcounted */
12439 SvANY(MUTABLE_CV(dstr))->xcv_stash =
12440 hv_dup(CvSTASH(dstr), param);
12441 if ((param->flags & CLONEf_JOIN_IN) && CvSTASH(dstr))
12442 Perl_sv_add_backref(aTHX_ MUTABLE_SV(CvSTASH(dstr)), dstr);
12443 if (!CvISXSUB(dstr)) {
12445 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
12447 CvSLABBED_off(dstr);
12448 } else if (CvCONST(dstr)) {
12449 CvXSUBANY(dstr).any_ptr =
12450 sv_dup_inc((const SV *)CvXSUBANY(dstr).any_ptr, param);
12452 assert(!CvSLABBED(dstr));
12453 if (CvDYNFILE(dstr)) CvFILE(dstr) = SAVEPV(CvFILE(dstr));
12455 SvANY((CV *)dstr)->xcv_gv_u.xcv_hek =
12456 share_hek_hek(CvNAME_HEK((CV *)sstr));
12457 /* don't dup if copying back - CvGV isn't refcounted, so the
12458 * duped GV may never be freed. A bit of a hack! DAPM */
12460 SvANY(MUTABLE_CV(dstr))->xcv_gv_u.xcv_gv =
12462 ? gv_dup_inc(CvGV(sstr), param)
12463 : (param->flags & CLONEf_JOIN_IN)
12465 : gv_dup(CvGV(sstr), param);
12467 CvPADLIST(dstr) = padlist_dup(CvPADLIST(sstr), param);
12469 CvWEAKOUTSIDE(sstr)
12470 ? cv_dup( CvOUTSIDE(dstr), param)
12471 : cv_dup_inc(CvOUTSIDE(dstr), param);
12481 Perl_sv_dup_inc(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12483 PERL_ARGS_ASSERT_SV_DUP_INC;
12484 return sstr ? SvREFCNT_inc(sv_dup_common(sstr, param)) : NULL;
12488 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
12490 SV *dstr = sstr ? sv_dup_common(sstr, param) : NULL;
12491 PERL_ARGS_ASSERT_SV_DUP;
12493 /* Track every SV that (at least initially) had a reference count of 0.
12494 We need to do this by holding an actual reference to it in this array.
12495 If we attempt to cheat, turn AvREAL_off(), and store only pointers
12496 (akin to the stashes hash, and the perl stack), we come unstuck if
12497 a weak reference (or other SV legitimately SvREFCNT() == 0 for this
12498 thread) is manipulated in a CLONE method, because CLONE runs before the
12499 unreferenced array is walked to find SVs still with SvREFCNT() == 0
12500 (and fix things up by giving each a reference via the temps stack).
12501 Instead, during CLONE, if the 0-referenced SV has SvREFCNT_inc() and
12502 then SvREFCNT_dec(), it will be cleaned up (and added to the free list)
12503 before the walk of unreferenced happens and a reference to that is SV
12504 added to the temps stack. At which point we have the same SV considered
12505 to be in use, and free to be re-used. Not good.
12507 if (dstr && !(param->flags & CLONEf_COPY_STACKS) && !SvREFCNT(dstr)) {
12508 assert(param->unreferenced);
12509 av_push(param->unreferenced, SvREFCNT_inc(dstr));
12515 /* duplicate a context */
12518 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
12520 PERL_CONTEXT *ncxs;
12522 PERL_ARGS_ASSERT_CX_DUP;
12525 return (PERL_CONTEXT*)NULL;
12527 /* look for it in the table first */
12528 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
12532 /* create anew and remember what it is */
12533 Newx(ncxs, max + 1, PERL_CONTEXT);
12534 ptr_table_store(PL_ptr_table, cxs, ncxs);
12535 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
12538 PERL_CONTEXT * const ncx = &ncxs[ix];
12539 if (CxTYPE(ncx) == CXt_SUBST) {
12540 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
12543 ncx->blk_oldcop = (COP*)any_dup(ncx->blk_oldcop, param->proto_perl);
12544 switch (CxTYPE(ncx)) {
12546 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
12547 ? cv_dup_inc(ncx->blk_sub.cv, param)
12548 : cv_dup(ncx->blk_sub.cv,param));
12549 ncx->blk_sub.argarray = (CxHASARGS(ncx)
12550 ? av_dup_inc(ncx->blk_sub.argarray,
12553 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
12555 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
12556 ncx->blk_sub.oldcomppad);
12559 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
12561 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
12562 ncx->blk_eval.cv = cv_dup(ncx->blk_eval.cv, param);
12564 case CXt_LOOP_LAZYSV:
12565 ncx->blk_loop.state_u.lazysv.end
12566 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
12567 /* We are taking advantage of av_dup_inc and sv_dup_inc
12568 actually being the same function, and order equivalence of
12570 We can assert the later [but only at run time :-(] */
12571 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
12572 (void *) &ncx->blk_loop.state_u.lazysv.cur);
12574 ncx->blk_loop.state_u.ary.ary
12575 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
12576 case CXt_LOOP_LAZYIV:
12577 case CXt_LOOP_PLAIN:
12578 if (CxPADLOOP(ncx)) {
12579 ncx->blk_loop.itervar_u.oldcomppad
12580 = (PAD*)ptr_table_fetch(PL_ptr_table,
12581 ncx->blk_loop.itervar_u.oldcomppad);
12583 ncx->blk_loop.itervar_u.gv
12584 = gv_dup((const GV *)ncx->blk_loop.itervar_u.gv,
12589 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
12590 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
12591 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
12606 /* duplicate a stack info structure */
12609 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
12613 PERL_ARGS_ASSERT_SI_DUP;
12616 return (PERL_SI*)NULL;
12618 /* look for it in the table first */
12619 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
12623 /* create anew and remember what it is */
12624 Newxz(nsi, 1, PERL_SI);
12625 ptr_table_store(PL_ptr_table, si, nsi);
12627 nsi->si_stack = av_dup_inc(si->si_stack, param);
12628 nsi->si_cxix = si->si_cxix;
12629 nsi->si_cxmax = si->si_cxmax;
12630 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
12631 nsi->si_type = si->si_type;
12632 nsi->si_prev = si_dup(si->si_prev, param);
12633 nsi->si_next = si_dup(si->si_next, param);
12634 nsi->si_markoff = si->si_markoff;
12639 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
12640 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
12641 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
12642 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
12643 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
12644 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
12645 #define POPUV(ss,ix) ((ss)[--(ix)].any_uv)
12646 #define TOPUV(ss,ix) ((ss)[ix].any_uv)
12647 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
12648 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
12649 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
12650 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
12651 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
12652 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
12653 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
12654 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
12657 #define pv_dup_inc(p) SAVEPV(p)
12658 #define pv_dup(p) SAVEPV(p)
12659 #define svp_dup_inc(p,pp) any_dup(p,pp)
12661 /* map any object to the new equivent - either something in the
12662 * ptr table, or something in the interpreter structure
12666 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
12670 PERL_ARGS_ASSERT_ANY_DUP;
12673 return (void*)NULL;
12675 /* look for it in the table first */
12676 ret = ptr_table_fetch(PL_ptr_table, v);
12680 /* see if it is part of the interpreter structure */
12681 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
12682 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
12690 /* duplicate the save stack */
12693 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
12696 ANY * const ss = proto_perl->Isavestack;
12697 const I32 max = proto_perl->Isavestack_max;
12698 I32 ix = proto_perl->Isavestack_ix;
12711 void (*dptr) (void*);
12712 void (*dxptr) (pTHX_ void*);
12714 PERL_ARGS_ASSERT_SS_DUP;
12716 Newxz(nss, max, ANY);
12719 const UV uv = POPUV(ss,ix);
12720 const U8 type = (U8)uv & SAVE_MASK;
12722 TOPUV(nss,ix) = uv;
12724 case SAVEt_CLEARSV:
12725 case SAVEt_CLEARPADRANGE:
12727 case SAVEt_HELEM: /* hash element */
12728 sv = (const SV *)POPPTR(ss,ix);
12729 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12731 case SAVEt_ITEM: /* normal string */
12732 case SAVEt_GVSV: /* scalar slot in GV */
12733 case SAVEt_SV: /* scalar reference */
12734 sv = (const SV *)POPPTR(ss,ix);
12735 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12738 case SAVEt_MORTALIZESV:
12739 sv = (const SV *)POPPTR(ss,ix);
12740 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12742 case SAVEt_SHARED_PVREF: /* char* in shared space */
12743 c = (char*)POPPTR(ss,ix);
12744 TOPPTR(nss,ix) = savesharedpv(c);
12745 ptr = POPPTR(ss,ix);
12746 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12748 case SAVEt_GENERIC_SVREF: /* generic sv */
12749 case SAVEt_SVREF: /* scalar reference */
12750 sv = (const SV *)POPPTR(ss,ix);
12751 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12752 ptr = POPPTR(ss,ix);
12753 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12755 case SAVEt_GVSLOT: /* any slot in GV */
12756 sv = (const SV *)POPPTR(ss,ix);
12757 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12758 ptr = POPPTR(ss,ix);
12759 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
12760 sv = (const SV *)POPPTR(ss,ix);
12761 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12763 case SAVEt_HV: /* hash reference */
12764 case SAVEt_AV: /* array reference */
12765 sv = (const SV *) POPPTR(ss,ix);
12766 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12768 case SAVEt_COMPPAD:
12770 sv = (const SV *) POPPTR(ss,ix);
12771 TOPPTR(nss,ix) = sv_dup(sv, param);
12773 case SAVEt_INT: /* int reference */
12774 ptr = POPPTR(ss,ix);
12775 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12776 intval = (int)POPINT(ss,ix);
12777 TOPINT(nss,ix) = intval;
12779 case SAVEt_LONG: /* long reference */
12780 ptr = POPPTR(ss,ix);
12781 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12782 longval = (long)POPLONG(ss,ix);
12783 TOPLONG(nss,ix) = longval;
12785 case SAVEt_I32: /* I32 reference */
12786 ptr = POPPTR(ss,ix);
12787 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12789 TOPINT(nss,ix) = i;
12791 case SAVEt_IV: /* IV reference */
12792 ptr = POPPTR(ss,ix);
12793 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12795 TOPIV(nss,ix) = iv;
12797 case SAVEt_HPTR: /* HV* reference */
12798 case SAVEt_APTR: /* AV* reference */
12799 case SAVEt_SPTR: /* SV* reference */
12800 ptr = POPPTR(ss,ix);
12801 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12802 sv = (const SV *)POPPTR(ss,ix);
12803 TOPPTR(nss,ix) = sv_dup(sv, param);
12805 case SAVEt_VPTR: /* random* reference */
12806 ptr = POPPTR(ss,ix);
12807 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12809 case SAVEt_INT_SMALL:
12810 case SAVEt_I32_SMALL:
12811 case SAVEt_I16: /* I16 reference */
12812 case SAVEt_I8: /* I8 reference */
12814 ptr = POPPTR(ss,ix);
12815 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12817 case SAVEt_GENERIC_PVREF: /* generic char* */
12818 case SAVEt_PPTR: /* char* reference */
12819 ptr = POPPTR(ss,ix);
12820 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12821 c = (char*)POPPTR(ss,ix);
12822 TOPPTR(nss,ix) = pv_dup(c);
12824 case SAVEt_GP: /* scalar reference */
12825 gp = (GP*)POPPTR(ss,ix);
12826 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
12827 (void)GpREFCNT_inc(gp);
12828 gv = (const GV *)POPPTR(ss,ix);
12829 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
12832 ptr = POPPTR(ss,ix);
12833 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
12834 /* these are assumed to be refcounted properly */
12836 switch (((OP*)ptr)->op_type) {
12838 case OP_LEAVESUBLV:
12842 case OP_LEAVEWRITE:
12843 TOPPTR(nss,ix) = ptr;
12846 (void) OpREFCNT_inc(o);
12850 TOPPTR(nss,ix) = NULL;
12855 TOPPTR(nss,ix) = NULL;
12857 case SAVEt_FREECOPHH:
12858 ptr = POPPTR(ss,ix);
12859 TOPPTR(nss,ix) = cophh_copy((COPHH *)ptr);
12862 hv = (const HV *)POPPTR(ss,ix);
12863 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12865 TOPINT(nss,ix) = i;
12868 c = (char*)POPPTR(ss,ix);
12869 TOPPTR(nss,ix) = pv_dup_inc(c);
12871 case SAVEt_STACK_POS: /* Position on Perl stack */
12873 TOPINT(nss,ix) = i;
12875 case SAVEt_DESTRUCTOR:
12876 ptr = POPPTR(ss,ix);
12877 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12878 dptr = POPDPTR(ss,ix);
12879 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
12880 any_dup(FPTR2DPTR(void *, dptr),
12883 case SAVEt_DESTRUCTOR_X:
12884 ptr = POPPTR(ss,ix);
12885 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
12886 dxptr = POPDXPTR(ss,ix);
12887 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
12888 any_dup(FPTR2DPTR(void *, dxptr),
12891 case SAVEt_REGCONTEXT:
12893 ix -= uv >> SAVE_TIGHT_SHIFT;
12895 case SAVEt_AELEM: /* array element */
12896 sv = (const SV *)POPPTR(ss,ix);
12897 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12899 TOPINT(nss,ix) = i;
12900 av = (const AV *)POPPTR(ss,ix);
12901 TOPPTR(nss,ix) = av_dup_inc(av, param);
12904 ptr = POPPTR(ss,ix);
12905 TOPPTR(nss,ix) = ptr;
12908 ptr = POPPTR(ss,ix);
12909 ptr = cophh_copy((COPHH*)ptr);
12910 TOPPTR(nss,ix) = ptr;
12912 TOPINT(nss,ix) = i;
12913 if (i & HINT_LOCALIZE_HH) {
12914 hv = (const HV *)POPPTR(ss,ix);
12915 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
12918 case SAVEt_PADSV_AND_MORTALIZE:
12919 longval = (long)POPLONG(ss,ix);
12920 TOPLONG(nss,ix) = longval;
12921 ptr = POPPTR(ss,ix);
12922 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
12923 sv = (const SV *)POPPTR(ss,ix);
12924 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
12926 case SAVEt_SET_SVFLAGS:
12928 TOPINT(nss,ix) = i;
12930 TOPINT(nss,ix) = i;
12931 sv = (const SV *)POPPTR(ss,ix);
12932 TOPPTR(nss,ix) = sv_dup(sv, param);
12934 case SAVEt_COMPILE_WARNINGS:
12935 ptr = POPPTR(ss,ix);
12936 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
12939 ptr = POPPTR(ss,ix);
12940 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
12944 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
12952 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
12953 * flag to the result. This is done for each stash before cloning starts,
12954 * so we know which stashes want their objects cloned */
12957 do_mark_cloneable_stash(pTHX_ SV *const sv)
12959 const HEK * const hvname = HvNAME_HEK((const HV *)sv);
12961 GV* const cloner = gv_fetchmethod_autoload(MUTABLE_HV(sv), "CLONE_SKIP", 0);
12962 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
12963 if (cloner && GvCV(cloner)) {
12970 mXPUSHs(newSVhek(hvname));
12972 call_sv(MUTABLE_SV(GvCV(cloner)), G_SCALAR);
12979 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
12987 =for apidoc perl_clone
12989 Create and return a new interpreter by cloning the current one.
12991 perl_clone takes these flags as parameters:
12993 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
12994 without it we only clone the data and zero the stacks,
12995 with it we copy the stacks and the new perl interpreter is
12996 ready to run at the exact same point as the previous one.
12997 The pseudo-fork code uses COPY_STACKS while the
12998 threads->create doesn't.
13000 CLONEf_KEEP_PTR_TABLE -
13001 perl_clone keeps a ptr_table with the pointer of the old
13002 variable as a key and the new variable as a value,
13003 this allows it to check if something has been cloned and not
13004 clone it again but rather just use the value and increase the
13005 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
13006 the ptr_table using the function
13007 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
13008 reason to keep it around is if you want to dup some of your own
13009 variable who are outside the graph perl scans, example of this
13010 code is in threads.xs create.
13012 CLONEf_CLONE_HOST -
13013 This is a win32 thing, it is ignored on unix, it tells perls
13014 win32host code (which is c++) to clone itself, this is needed on
13015 win32 if you want to run two threads at the same time,
13016 if you just want to do some stuff in a separate perl interpreter
13017 and then throw it away and return to the original one,
13018 you don't need to do anything.
13023 /* XXX the above needs expanding by someone who actually understands it ! */
13024 EXTERN_C PerlInterpreter *
13025 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
13028 perl_clone(PerlInterpreter *proto_perl, UV flags)
13031 #ifdef PERL_IMPLICIT_SYS
13033 PERL_ARGS_ASSERT_PERL_CLONE;
13035 /* perlhost.h so we need to call into it
13036 to clone the host, CPerlHost should have a c interface, sky */
13038 if (flags & CLONEf_CLONE_HOST) {
13039 return perl_clone_host(proto_perl,flags);
13041 return perl_clone_using(proto_perl, flags,
13043 proto_perl->IMemShared,
13044 proto_perl->IMemParse,
13046 proto_perl->IStdIO,
13050 proto_perl->IProc);
13054 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
13055 struct IPerlMem* ipM, struct IPerlMem* ipMS,
13056 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
13057 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
13058 struct IPerlDir* ipD, struct IPerlSock* ipS,
13059 struct IPerlProc* ipP)
13061 /* XXX many of the string copies here can be optimized if they're
13062 * constants; they need to be allocated as common memory and just
13063 * their pointers copied. */
13066 CLONE_PARAMS clone_params;
13067 CLONE_PARAMS* const param = &clone_params;
13069 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
13071 PERL_ARGS_ASSERT_PERL_CLONE_USING;
13072 #else /* !PERL_IMPLICIT_SYS */
13074 CLONE_PARAMS clone_params;
13075 CLONE_PARAMS* param = &clone_params;
13076 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
13078 PERL_ARGS_ASSERT_PERL_CLONE;
13079 #endif /* PERL_IMPLICIT_SYS */
13081 /* for each stash, determine whether its objects should be cloned */
13082 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
13083 PERL_SET_THX(my_perl);
13086 PoisonNew(my_perl, 1, PerlInterpreter);
13089 PL_defstash = NULL; /* may be used by perl malloc() */
13092 PL_scopestack_name = 0;
13094 PL_savestack_ix = 0;
13095 PL_savestack_max = -1;
13096 PL_sig_pending = 0;
13098 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
13099 # ifdef DEBUG_LEAKING_SCALARS
13100 PL_sv_serial = (((UV)my_perl >> 2) & 0xfff) * 1000000;
13102 #else /* !DEBUGGING */
13103 Zero(my_perl, 1, PerlInterpreter);
13104 #endif /* DEBUGGING */
13106 #ifdef PERL_IMPLICIT_SYS
13107 /* host pointers */
13109 PL_MemShared = ipMS;
13110 PL_MemParse = ipMP;
13117 #endif /* PERL_IMPLICIT_SYS */
13120 param->flags = flags;
13121 /* Nothing in the core code uses this, but we make it available to
13122 extensions (using mg_dup). */
13123 param->proto_perl = proto_perl;
13124 /* Likely nothing will use this, but it is initialised to be consistent
13125 with Perl_clone_params_new(). */
13126 param->new_perl = my_perl;
13127 param->unreferenced = NULL;
13130 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
13132 PL_body_arenas = NULL;
13133 Zero(&PL_body_roots, 1, PL_body_roots);
13137 PL_sv_arenaroot = NULL;
13139 PL_debug = proto_perl->Idebug;
13141 /* dbargs array probably holds garbage */
13144 PL_compiling = proto_perl->Icompiling;
13146 /* pseudo environmental stuff */
13147 PL_origargc = proto_perl->Iorigargc;
13148 PL_origargv = proto_perl->Iorigargv;
13150 #if !NO_TAINT_SUPPORT
13151 /* Set tainting stuff before PerlIO_debug can possibly get called */
13152 PL_tainting = proto_perl->Itainting;
13153 PL_taint_warn = proto_perl->Itaint_warn;
13155 PL_tainting = FALSE;
13156 PL_taint_warn = FALSE;
13159 PL_minus_c = proto_perl->Iminus_c;
13161 PL_localpatches = proto_perl->Ilocalpatches;
13162 PL_splitstr = proto_perl->Isplitstr;
13163 PL_minus_n = proto_perl->Iminus_n;
13164 PL_minus_p = proto_perl->Iminus_p;
13165 PL_minus_l = proto_perl->Iminus_l;
13166 PL_minus_a = proto_perl->Iminus_a;
13167 PL_minus_E = proto_perl->Iminus_E;
13168 PL_minus_F = proto_perl->Iminus_F;
13169 PL_doswitches = proto_perl->Idoswitches;
13170 PL_dowarn = proto_perl->Idowarn;
13171 #ifdef PERL_SAWAMPERSAND
13172 PL_sawampersand = proto_perl->Isawampersand;
13174 PL_unsafe = proto_perl->Iunsafe;
13175 PL_perldb = proto_perl->Iperldb;
13176 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
13177 PL_exit_flags = proto_perl->Iexit_flags;
13179 /* XXX time(&PL_basetime) when asked for? */
13180 PL_basetime = proto_perl->Ibasetime;
13182 PL_maxsysfd = proto_perl->Imaxsysfd;
13183 PL_statusvalue = proto_perl->Istatusvalue;
13185 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
13187 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
13190 /* RE engine related */
13191 PL_regmatch_slab = NULL;
13192 PL_reg_curpm = NULL;
13194 PL_sub_generation = proto_perl->Isub_generation;
13196 /* funky return mechanisms */
13197 PL_forkprocess = proto_perl->Iforkprocess;
13199 /* internal state */
13200 PL_maxo = proto_perl->Imaxo;
13202 PL_main_start = proto_perl->Imain_start;
13203 PL_eval_root = proto_perl->Ieval_root;
13204 PL_eval_start = proto_perl->Ieval_start;
13206 PL_filemode = proto_perl->Ifilemode;
13207 PL_lastfd = proto_perl->Ilastfd;
13208 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
13211 PL_gensym = proto_perl->Igensym;
13213 PL_laststatval = proto_perl->Ilaststatval;
13214 PL_laststype = proto_perl->Ilaststype;
13217 PL_profiledata = NULL;
13219 PL_generation = proto_perl->Igeneration;
13221 PL_in_clean_objs = proto_perl->Iin_clean_objs;
13222 PL_in_clean_all = proto_perl->Iin_clean_all;
13224 PL_delaymagic_uid = proto_perl->Idelaymagic_uid;
13225 PL_delaymagic_euid = proto_perl->Idelaymagic_euid;
13226 PL_delaymagic_gid = proto_perl->Idelaymagic_gid;
13227 PL_delaymagic_egid = proto_perl->Idelaymagic_egid;
13228 PL_nomemok = proto_perl->Inomemok;
13229 PL_an = proto_perl->Ian;
13230 PL_evalseq = proto_perl->Ievalseq;
13231 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
13232 PL_origalen = proto_perl->Iorigalen;
13234 PL_sighandlerp = proto_perl->Isighandlerp;
13236 PL_runops = proto_perl->Irunops;
13238 PL_subline = proto_perl->Isubline;
13241 PL_cryptseen = proto_perl->Icryptseen;
13244 PL_hints = proto_perl->Ihints;
13246 #ifdef USE_LOCALE_COLLATE
13247 PL_collation_ix = proto_perl->Icollation_ix;
13248 PL_collation_standard = proto_perl->Icollation_standard;
13249 PL_collxfrm_base = proto_perl->Icollxfrm_base;
13250 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
13251 #endif /* USE_LOCALE_COLLATE */
13253 #ifdef USE_LOCALE_NUMERIC
13254 PL_numeric_standard = proto_perl->Inumeric_standard;
13255 PL_numeric_local = proto_perl->Inumeric_local;
13256 #endif /* !USE_LOCALE_NUMERIC */
13258 /* Did the locale setup indicate UTF-8? */
13259 PL_utf8locale = proto_perl->Iutf8locale;
13260 /* Unicode features (see perlrun/-C) */
13261 PL_unicode = proto_perl->Iunicode;
13263 /* Pre-5.8 signals control */
13264 PL_signals = proto_perl->Isignals;
13266 /* times() ticks per second */
13267 PL_clocktick = proto_perl->Iclocktick;
13269 /* Recursion stopper for PerlIO_find_layer */
13270 PL_in_load_module = proto_perl->Iin_load_module;
13272 /* sort() routine */
13273 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
13275 /* Not really needed/useful since the reenrant_retint is "volatile",
13276 * but do it for consistency's sake. */
13277 PL_reentrant_retint = proto_perl->Ireentrant_retint;
13279 /* Hooks to shared SVs and locks. */
13280 PL_sharehook = proto_perl->Isharehook;
13281 PL_lockhook = proto_perl->Ilockhook;
13282 PL_unlockhook = proto_perl->Iunlockhook;
13283 PL_threadhook = proto_perl->Ithreadhook;
13284 PL_destroyhook = proto_perl->Idestroyhook;
13285 PL_signalhook = proto_perl->Isignalhook;
13287 PL_globhook = proto_perl->Iglobhook;
13290 PL_last_swash_hv = NULL; /* reinits on demand */
13291 PL_last_swash_klen = 0;
13292 PL_last_swash_key[0]= '\0';
13293 PL_last_swash_tmps = (U8*)NULL;
13294 PL_last_swash_slen = 0;
13296 PL_srand_called = proto_perl->Isrand_called;
13298 if (flags & CLONEf_COPY_STACKS) {
13299 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
13300 PL_tmps_ix = proto_perl->Itmps_ix;
13301 PL_tmps_max = proto_perl->Itmps_max;
13302 PL_tmps_floor = proto_perl->Itmps_floor;
13304 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13305 * NOTE: unlike the others! */
13306 PL_scopestack_ix = proto_perl->Iscopestack_ix;
13307 PL_scopestack_max = proto_perl->Iscopestack_max;
13309 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
13310 * NOTE: unlike the others! */
13311 PL_savestack_ix = proto_perl->Isavestack_ix;
13312 PL_savestack_max = proto_perl->Isavestack_max;
13315 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
13316 PL_top_env = &PL_start_env;
13318 PL_op = proto_perl->Iop;
13321 PL_Xpv = (XPV*)NULL;
13322 my_perl->Ina = proto_perl->Ina;
13324 PL_statbuf = proto_perl->Istatbuf;
13325 PL_statcache = proto_perl->Istatcache;
13328 PL_timesbuf = proto_perl->Itimesbuf;
13331 #if !NO_TAINT_SUPPORT
13332 PL_tainted = proto_perl->Itainted;
13334 PL_tainted = FALSE;
13336 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
13338 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
13340 PL_restartjmpenv = proto_perl->Irestartjmpenv;
13341 PL_restartop = proto_perl->Irestartop;
13342 PL_in_eval = proto_perl->Iin_eval;
13343 PL_delaymagic = proto_perl->Idelaymagic;
13344 PL_phase = proto_perl->Iphase;
13345 PL_localizing = proto_perl->Ilocalizing;
13347 PL_hv_fetch_ent_mh = NULL;
13348 PL_modcount = proto_perl->Imodcount;
13349 PL_lastgotoprobe = NULL;
13350 PL_dumpindent = proto_perl->Idumpindent;
13352 PL_efloatbuf = NULL; /* reinits on demand */
13353 PL_efloatsize = 0; /* reinits on demand */
13357 PL_colorset = 0; /* reinits PL_colors[] */
13358 /*PL_colors[6] = {0,0,0,0,0,0};*/
13360 /* Pluggable optimizer */
13361 PL_peepp = proto_perl->Ipeepp;
13362 PL_rpeepp = proto_perl->Irpeepp;
13363 /* op_free() hook */
13364 PL_opfreehook = proto_perl->Iopfreehook;
13366 #ifdef USE_REENTRANT_API
13367 /* XXX: things like -Dm will segfault here in perlio, but doing
13368 * PERL_SET_CONTEXT(proto_perl);
13369 * breaks too many other things
13371 Perl_reentrant_init(aTHX);
13374 /* create SV map for pointer relocation */
13375 PL_ptr_table = ptr_table_new();
13377 /* initialize these special pointers as early as possible */
13379 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
13380 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
13381 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
13383 /* create (a non-shared!) shared string table */
13384 PL_strtab = newHV();
13385 HvSHAREKEYS_off(PL_strtab);
13386 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
13387 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
13389 /* This PV will be free'd special way so must set it same way op.c does */
13390 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
13391 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
13393 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
13394 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
13395 CopHINTHASH_set(&PL_compiling, cophh_copy(CopHINTHASH_get(&PL_compiling)));
13396 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
13398 param->stashes = newAV(); /* Setup array of objects to call clone on */
13399 /* This makes no difference to the implementation, as it always pushes
13400 and shifts pointers to other SVs without changing their reference
13401 count, with the array becoming empty before it is freed. However, it
13402 makes it conceptually clear what is going on, and will avoid some
13403 work inside av.c, filling slots between AvFILL() and AvMAX() with
13404 &PL_sv_undef, and SvREFCNT_dec()ing those. */
13405 AvREAL_off(param->stashes);
13407 if (!(flags & CLONEf_COPY_STACKS)) {
13408 param->unreferenced = newAV();
13411 #ifdef PERLIO_LAYERS
13412 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
13413 PerlIO_clone(aTHX_ proto_perl, param);
13416 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
13417 PL_incgv = gv_dup(proto_perl->Iincgv, param);
13418 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
13419 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
13420 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
13421 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
13424 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
13425 PL_apiversion = sv_dup_inc(proto_perl->Iapiversion, param);
13426 PL_inplace = SAVEPV(proto_perl->Iinplace);
13427 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
13429 /* magical thingies */
13431 PL_encoding = sv_dup(proto_perl->Iencoding, param);
13433 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
13434 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
13435 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
13438 /* Clone the regex array */
13439 /* ORANGE FIXME for plugins, probably in the SV dup code.
13440 newSViv(PTR2IV(CALLREGDUPE(
13441 INT2PTR(REGEXP *, SvIVX(regex)), param))))
13443 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
13444 PL_regex_pad = AvARRAY(PL_regex_padav);
13446 PL_stashpadmax = proto_perl->Istashpadmax;
13447 PL_stashpadix = proto_perl->Istashpadix ;
13448 Newx(PL_stashpad, PL_stashpadmax, HV *);
13451 for (; o < PL_stashpadmax; ++o)
13452 PL_stashpad[o] = hv_dup(proto_perl->Istashpad[o], param);
13455 /* shortcuts to various I/O objects */
13456 PL_ofsgv = gv_dup_inc(proto_perl->Iofsgv, param);
13457 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
13458 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
13459 PL_defgv = gv_dup(proto_perl->Idefgv, param);
13460 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
13461 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
13462 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
13464 /* shortcuts to regexp stuff */
13465 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
13467 /* shortcuts to misc objects */
13468 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
13470 /* shortcuts to debugging objects */
13471 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
13472 PL_DBline = gv_dup(proto_perl->IDBline, param);
13473 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
13474 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
13475 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
13476 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
13478 /* symbol tables */
13479 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
13480 PL_curstash = hv_dup_inc(proto_perl->Icurstash, param);
13481 PL_debstash = hv_dup(proto_perl->Idebstash, param);
13482 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
13483 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
13485 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
13486 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
13487 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
13488 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
13489 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
13490 PL_endav = av_dup_inc(proto_perl->Iendav, param);
13491 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
13492 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
13494 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
13496 /* subprocess state */
13497 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
13499 if (proto_perl->Iop_mask)
13500 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
13503 /* PL_asserting = proto_perl->Iasserting; */
13505 /* current interpreter roots */
13506 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
13508 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
13511 /* runtime control stuff */
13512 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
13514 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
13516 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
13518 /* interpreter atexit processing */
13519 PL_exitlistlen = proto_perl->Iexitlistlen;
13520 if (PL_exitlistlen) {
13521 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13522 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
13525 PL_exitlist = (PerlExitListEntry*)NULL;
13527 PL_my_cxt_size = proto_perl->Imy_cxt_size;
13528 if (PL_my_cxt_size) {
13529 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
13530 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
13531 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13532 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
13533 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
13537 PL_my_cxt_list = (void**)NULL;
13538 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
13539 PL_my_cxt_keys = (const char**)NULL;
13542 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
13543 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
13544 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
13545 PL_custom_ops = hv_dup_inc(proto_perl->Icustom_ops, param);
13547 PL_compcv = cv_dup(proto_perl->Icompcv, param);
13549 PAD_CLONE_VARS(proto_perl, param);
13551 #ifdef HAVE_INTERP_INTERN
13552 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
13555 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
13557 #ifdef PERL_USES_PL_PIDSTATUS
13558 PL_pidstatus = newHV(); /* XXX flag for cloning? */
13560 PL_osname = SAVEPV(proto_perl->Iosname);
13561 PL_parser = parser_dup(proto_perl->Iparser, param);
13563 /* XXX this only works if the saved cop has already been cloned */
13564 if (proto_perl->Iparser) {
13565 PL_parser->saved_curcop = (COP*)any_dup(
13566 proto_perl->Iparser->saved_curcop,
13570 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
13572 #ifdef USE_LOCALE_COLLATE
13573 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
13574 #endif /* USE_LOCALE_COLLATE */
13576 #ifdef USE_LOCALE_NUMERIC
13577 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
13578 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
13579 #endif /* !USE_LOCALE_NUMERIC */
13581 /* Unicode inversion lists */
13582 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13583 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13585 PL_NonL1NonFinalFold = sv_dup_inc(proto_perl->INonL1NonFinalFold, param);
13586 PL_HasMultiCharFold= sv_dup_inc(proto_perl->IHasMultiCharFold, param);
13588 /* utf8 character class swashes */
13589 for (i = 0; i < POSIX_SWASH_COUNT; i++) {
13590 PL_utf8_swash_ptrs[i] = sv_dup_inc(proto_perl->Iutf8_swash_ptrs[i], param);
13592 for (i = 0; i < POSIX_CC_COUNT; i++) {
13593 PL_Posix_ptrs[i] = sv_dup_inc(proto_perl->IPosix_ptrs[i], param);
13594 PL_L1Posix_ptrs[i] = sv_dup_inc(proto_perl->IL1Posix_ptrs[i], param);
13595 PL_XPosix_ptrs[i] = sv_dup_inc(proto_perl->IXPosix_ptrs[i], param);
13597 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
13598 PL_utf8_X_regular_begin = sv_dup_inc(proto_perl->Iutf8_X_regular_begin, param);
13599 PL_utf8_X_extend = sv_dup_inc(proto_perl->Iutf8_X_extend, param);
13600 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
13601 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
13602 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
13603 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
13604 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
13605 PL_utf8_xidstart = sv_dup_inc(proto_perl->Iutf8_xidstart, param);
13606 PL_utf8_perl_idstart = sv_dup_inc(proto_perl->Iutf8_perl_idstart, param);
13607 PL_utf8_perl_idcont = sv_dup_inc(proto_perl->Iutf8_perl_idcont, param);
13608 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
13609 PL_utf8_xidcont = sv_dup_inc(proto_perl->Iutf8_xidcont, param);
13610 PL_utf8_foldable = sv_dup_inc(proto_perl->Iutf8_foldable, param);
13611 PL_utf8_charname_begin = sv_dup_inc(proto_perl->Iutf8_charname_begin, param);
13612 PL_utf8_charname_continue = sv_dup_inc(proto_perl->Iutf8_charname_continue, param);
13613 PL_ASCII = sv_dup_inc(proto_perl->IASCII, param);
13614 PL_AboveLatin1 = sv_dup_inc(proto_perl->IAboveLatin1, param);
13615 PL_Latin1 = sv_dup_inc(proto_perl->ILatin1, param);
13617 if (proto_perl->Ipsig_pend) {
13618 Newxz(PL_psig_pend, SIG_SIZE, int);
13621 PL_psig_pend = (int*)NULL;
13624 if (proto_perl->Ipsig_name) {
13625 Newx(PL_psig_name, 2 * SIG_SIZE, SV*);
13626 sv_dup_inc_multiple(proto_perl->Ipsig_name, PL_psig_name, 2 * SIG_SIZE,
13628 PL_psig_ptr = PL_psig_name + SIG_SIZE;
13631 PL_psig_ptr = (SV**)NULL;
13632 PL_psig_name = (SV**)NULL;
13635 if (flags & CLONEf_COPY_STACKS) {
13636 Newx(PL_tmps_stack, PL_tmps_max, SV*);
13637 sv_dup_inc_multiple(proto_perl->Itmps_stack, PL_tmps_stack,
13638 PL_tmps_ix+1, param);
13640 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
13641 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
13642 Newxz(PL_markstack, i, I32);
13643 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
13644 - proto_perl->Imarkstack);
13645 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
13646 - proto_perl->Imarkstack);
13647 Copy(proto_perl->Imarkstack, PL_markstack,
13648 PL_markstack_ptr - PL_markstack + 1, I32);
13650 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
13651 * NOTE: unlike the others! */
13652 Newxz(PL_scopestack, PL_scopestack_max, I32);
13653 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
13656 Newxz(PL_scopestack_name, PL_scopestack_max, const char *);
13657 Copy(proto_perl->Iscopestack_name, PL_scopestack_name, PL_scopestack_ix, const char *);
13659 /* reset stack AV to correct length before its duped via
13660 * PL_curstackinfo */
13661 AvFILLp(proto_perl->Icurstack) =
13662 proto_perl->Istack_sp - proto_perl->Istack_base;
13664 /* NOTE: si_dup() looks at PL_markstack */
13665 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
13667 /* PL_curstack = PL_curstackinfo->si_stack; */
13668 PL_curstack = av_dup(proto_perl->Icurstack, param);
13669 PL_mainstack = av_dup(proto_perl->Imainstack, param);
13671 /* next PUSHs() etc. set *(PL_stack_sp+1) */
13672 PL_stack_base = AvARRAY(PL_curstack);
13673 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
13674 - proto_perl->Istack_base);
13675 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
13677 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
13678 PL_savestack = ss_dup(proto_perl, param);
13682 ENTER; /* perl_destruct() wants to LEAVE; */
13685 PL_statgv = gv_dup(proto_perl->Istatgv, param);
13686 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
13688 PL_rs = sv_dup_inc(proto_perl->Irs, param);
13689 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
13690 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
13691 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
13692 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
13693 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
13695 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
13697 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
13698 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
13699 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
13701 PL_stashcache = newHV();
13703 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
13704 proto_perl->Iwatchaddr);
13705 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
13706 if (PL_debug && PL_watchaddr) {
13707 PerlIO_printf(Perl_debug_log,
13708 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
13709 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
13710 PTR2UV(PL_watchok));
13713 PL_registered_mros = hv_dup_inc(proto_perl->Iregistered_mros, param);
13714 PL_blockhooks = av_dup_inc(proto_perl->Iblockhooks, param);
13715 PL_utf8_foldclosures = hv_dup_inc(proto_perl->Iutf8_foldclosures, param);
13717 /* Call the ->CLONE method, if it exists, for each of the stashes
13718 identified by sv_dup() above.
13720 while(av_len(param->stashes) != -1) {
13721 HV* const stash = MUTABLE_HV(av_shift(param->stashes));
13722 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
13723 if (cloner && GvCV(cloner)) {
13728 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
13730 call_sv(MUTABLE_SV(GvCV(cloner)), G_DISCARD);
13736 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
13737 ptr_table_free(PL_ptr_table);
13738 PL_ptr_table = NULL;
13741 if (!(flags & CLONEf_COPY_STACKS)) {
13742 unreferenced_to_tmp_stack(param->unreferenced);
13745 SvREFCNT_dec(param->stashes);
13747 /* orphaned? eg threads->new inside BEGIN or use */
13748 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
13749 SvREFCNT_inc_simple_void(PL_compcv);
13750 SAVEFREESV(PL_compcv);
13757 S_unreferenced_to_tmp_stack(pTHX_ AV *const unreferenced)
13759 PERL_ARGS_ASSERT_UNREFERENCED_TO_TMP_STACK;
13761 if (AvFILLp(unreferenced) > -1) {
13762 SV **svp = AvARRAY(unreferenced);
13763 SV **const last = svp + AvFILLp(unreferenced);
13767 if (SvREFCNT(*svp) == 1)
13769 } while (++svp <= last);
13771 EXTEND_MORTAL(count);
13772 svp = AvARRAY(unreferenced);
13775 if (SvREFCNT(*svp) == 1) {
13776 /* Our reference is the only one to this SV. This means that
13777 in this thread, the scalar effectively has a 0 reference.
13778 That doesn't work (cleanup never happens), so donate our
13779 reference to it onto the save stack. */
13780 PL_tmps_stack[++PL_tmps_ix] = *svp;
13782 /* As an optimisation, because we are already walking the
13783 entire array, instead of above doing either
13784 SvREFCNT_inc(*svp) or *svp = &PL_sv_undef, we can instead
13785 release our reference to the scalar, so that at the end of
13786 the array owns zero references to the scalars it happens to
13787 point to. We are effectively converting the array from
13788 AvREAL() on to AvREAL() off. This saves the av_clear()
13789 (triggered by the SvREFCNT_dec(unreferenced) below) from
13790 walking the array a second time. */
13791 SvREFCNT_dec(*svp);
13794 } while (++svp <= last);
13795 AvREAL_off(unreferenced);
13797 SvREFCNT_dec_NN(unreferenced);
13801 Perl_clone_params_del(CLONE_PARAMS *param)
13803 /* This seemingly funky ordering keeps the build with PERL_GLOBAL_STRUCT
13805 PerlInterpreter *const to = param->new_perl;
13807 PerlInterpreter *const was = PERL_GET_THX;
13809 PERL_ARGS_ASSERT_CLONE_PARAMS_DEL;
13815 SvREFCNT_dec(param->stashes);
13816 if (param->unreferenced)
13817 unreferenced_to_tmp_stack(param->unreferenced);
13827 Perl_clone_params_new(PerlInterpreter *const from, PerlInterpreter *const to)
13830 /* Need to play this game, as newAV() can call safesysmalloc(), and that
13831 does a dTHX; to get the context from thread local storage.
13832 FIXME - under PERL_CORE Newx(), Safefree() and friends should expand to
13833 a version that passes in my_perl. */
13834 PerlInterpreter *const was = PERL_GET_THX;
13835 CLONE_PARAMS *param;
13837 PERL_ARGS_ASSERT_CLONE_PARAMS_NEW;
13843 /* Given that we've set the context, we can do this unshared. */
13844 Newx(param, 1, CLONE_PARAMS);
13847 param->proto_perl = from;
13848 param->new_perl = to;
13849 param->stashes = (AV *)Perl_newSV_type(to, SVt_PVAV);
13850 AvREAL_off(param->stashes);
13851 param->unreferenced = (AV *)Perl_newSV_type(to, SVt_PVAV);
13859 #endif /* USE_ITHREADS */
13862 Perl_init_constants(pTHX)
13864 SvREFCNT(&PL_sv_undef) = SvREFCNT_IMMORTAL;
13865 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
13866 SvANY(&PL_sv_undef) = NULL;
13868 SvANY(&PL_sv_no) = new_XPVNV();
13869 SvREFCNT(&PL_sv_no) = SvREFCNT_IMMORTAL;
13870 SvFLAGS(&PL_sv_no) = SVt_PVNV|SVf_READONLY
13871 |SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
13874 SvANY(&PL_sv_yes) = new_XPVNV();
13875 SvREFCNT(&PL_sv_yes) = SvREFCNT_IMMORTAL;
13876 SvFLAGS(&PL_sv_yes) = SVt_PVNV|SVf_READONLY
13877 |SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
13880 SvPV_set(&PL_sv_no, (char*)PL_No);
13881 SvCUR_set(&PL_sv_no, 0);
13882 SvLEN_set(&PL_sv_no, 0);
13883 SvIV_set(&PL_sv_no, 0);
13884 SvNV_set(&PL_sv_no, 0);
13886 SvPV_set(&PL_sv_yes, (char*)PL_Yes);
13887 SvCUR_set(&PL_sv_yes, 1);
13888 SvLEN_set(&PL_sv_yes, 0);
13889 SvIV_set(&PL_sv_yes, 1);
13890 SvNV_set(&PL_sv_yes, 1);
13894 =head1 Unicode Support
13896 =for apidoc sv_recode_to_utf8
13898 The encoding is assumed to be an Encode object, on entry the PV
13899 of the sv is assumed to be octets in that encoding, and the sv
13900 will be converted into Unicode (and UTF-8).
13902 If the sv already is UTF-8 (or if it is not POK), or if the encoding
13903 is not a reference, nothing is done to the sv. If the encoding is not
13904 an C<Encode::XS> Encoding object, bad things will happen.
13905 (See F<lib/encoding.pm> and L<Encode>.)
13907 The PV of the sv is returned.
13912 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
13916 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
13918 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
13932 Passing sv_yes is wrong - it needs to be or'ed set of constants
13933 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
13934 remove converted chars from source.
13936 Both will default the value - let them.
13938 XPUSHs(&PL_sv_yes);
13941 call_method("decode", G_SCALAR);
13945 s = SvPV_const(uni, len);
13946 if (s != SvPVX_const(sv)) {
13947 SvGROW(sv, len + 1);
13948 Move(s, SvPVX(sv), len + 1, char);
13949 SvCUR_set(sv, len);
13953 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
13954 /* clear pos and any utf8 cache */
13955 MAGIC * mg = mg_find(sv, PERL_MAGIC_regex_global);
13958 if ((mg = mg_find(sv, PERL_MAGIC_utf8)))
13959 magic_setutf8(sv,mg); /* clear UTF8 cache */
13964 return SvPOKp(sv) ? SvPVX(sv) : NULL;
13968 =for apidoc sv_cat_decode
13970 The encoding is assumed to be an Encode object, the PV of the ssv is
13971 assumed to be octets in that encoding and decoding the input starts
13972 from the position which (PV + *offset) pointed to. The dsv will be
13973 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
13974 when the string tstr appears in decoding output or the input ends on
13975 the PV of the ssv. The value which the offset points will be modified
13976 to the last input position on the ssv.
13978 Returns TRUE if the terminator was found, else returns FALSE.
13983 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
13984 SV *ssv, int *offset, char *tstr, int tlen)
13989 PERL_ARGS_ASSERT_SV_CAT_DECODE;
13991 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
14002 offsv = newSViv(*offset);
14004 mPUSHp(tstr, tlen);
14006 call_method("cat_decode", G_SCALAR);
14008 ret = SvTRUE(TOPs);
14009 *offset = SvIV(offsv);
14015 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
14020 /* ---------------------------------------------------------------------
14022 * support functions for report_uninit()
14025 /* the maxiumum size of array or hash where we will scan looking
14026 * for the undefined element that triggered the warning */
14028 #define FUV_MAX_SEARCH_SIZE 1000
14030 /* Look for an entry in the hash whose value has the same SV as val;
14031 * If so, return a mortal copy of the key. */
14034 S_find_hash_subscript(pTHX_ const HV *const hv, const SV *const val)
14040 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
14042 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
14043 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
14046 array = HvARRAY(hv);
14048 for (i=HvMAX(hv); i>=0; i--) {
14050 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
14051 if (HeVAL(entry) != val)
14053 if ( HeVAL(entry) == &PL_sv_undef ||
14054 HeVAL(entry) == &PL_sv_placeholder)
14058 if (HeKLEN(entry) == HEf_SVKEY)
14059 return sv_mortalcopy(HeKEY_sv(entry));
14060 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
14066 /* Look for an entry in the array whose value has the same SV as val;
14067 * If so, return the index, otherwise return -1. */
14070 S_find_array_subscript(pTHX_ const AV *const av, const SV *const val)
14074 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
14076 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
14077 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
14080 if (val != &PL_sv_undef) {
14081 SV ** const svp = AvARRAY(av);
14084 for (i=AvFILLp(av); i>=0; i--)
14091 /* varname(): return the name of a variable, optionally with a subscript.
14092 * If gv is non-zero, use the name of that global, along with gvtype (one
14093 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
14094 * targ. Depending on the value of the subscript_type flag, return:
14097 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
14098 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
14099 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
14100 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
14103 Perl_varname(pTHX_ const GV *const gv, const char gvtype, PADOFFSET targ,
14104 const SV *const keyname, I32 aindex, int subscript_type)
14107 SV * const name = sv_newmortal();
14108 if (gv && isGV(gv)) {
14110 buffer[0] = gvtype;
14113 /* as gv_fullname4(), but add literal '^' for $^FOO names */
14115 gv_fullname4(name, gv, buffer, 0);
14117 if ((unsigned int)SvPVX(name)[1] <= 26) {
14119 buffer[1] = SvPVX(name)[1] + 'A' - 1;
14121 /* Swap the 1 unprintable control character for the 2 byte pretty
14122 version - ie substr($name, 1, 1) = $buffer; */
14123 sv_insert(name, 1, 1, buffer, 2);
14127 CV * const cv = gv ? ((CV *)gv) : find_runcv(NULL);
14131 assert(!cv || SvTYPE(cv) == SVt_PVCV || SvTYPE(cv) == SVt_PVFM);
14133 if (!cv || !CvPADLIST(cv))
14135 av = *PadlistARRAY(CvPADLIST(cv));
14136 sv = *av_fetch(av, targ, FALSE);
14137 sv_setsv_flags(name, sv, 0);
14140 if (subscript_type == FUV_SUBSCRIPT_HASH) {
14141 SV * const sv = newSV(0);
14142 *SvPVX(name) = '$';
14143 Perl_sv_catpvf(aTHX_ name, "{%s}",
14144 pv_pretty(sv, SvPVX_const(keyname), SvCUR(keyname), 32, NULL, NULL,
14145 PERL_PV_PRETTY_DUMP | PERL_PV_ESCAPE_UNI_DETECT ));
14146 SvREFCNT_dec_NN(sv);
14148 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
14149 *SvPVX(name) = '$';
14150 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
14152 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
14153 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
14154 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
14162 =for apidoc find_uninit_var
14164 Find the name of the undefined variable (if any) that caused the operator
14165 to issue a "Use of uninitialized value" warning.
14166 If match is true, only return a name if its value matches uninit_sv.
14167 So roughly speaking, if a unary operator (such as OP_COS) generates a
14168 warning, then following the direct child of the op may yield an
14169 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
14170 other hand, with OP_ADD there are two branches to follow, so we only print
14171 the variable name if we get an exact match.
14173 The name is returned as a mortal SV.
14175 Assumes that PL_op is the op that originally triggered the error, and that
14176 PL_comppad/PL_curpad points to the currently executing pad.
14182 S_find_uninit_var(pTHX_ const OP *const obase, const SV *const uninit_sv,
14188 const OP *o, *o2, *kid;
14190 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
14191 uninit_sv == &PL_sv_placeholder)))
14194 switch (obase->op_type) {
14201 const bool pad = ( obase->op_type == OP_PADAV
14202 || obase->op_type == OP_PADHV
14203 || obase->op_type == OP_PADRANGE
14206 const bool hash = ( obase->op_type == OP_PADHV
14207 || obase->op_type == OP_RV2HV
14208 || (obase->op_type == OP_PADRANGE
14209 && SvTYPE(PAD_SVl(obase->op_targ)) == SVt_PVHV)
14213 int subscript_type = FUV_SUBSCRIPT_WITHIN;
14215 if (pad) { /* @lex, %lex */
14216 sv = PAD_SVl(obase->op_targ);
14220 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14221 /* @global, %global */
14222 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14225 sv = hash ? MUTABLE_SV(GvHV(gv)): MUTABLE_SV(GvAV(gv));
14227 else if (obase == PL_op) /* @{expr}, %{expr} */
14228 return find_uninit_var(cUNOPx(obase)->op_first,
14230 else /* @{expr}, %{expr} as a sub-expression */
14234 /* attempt to find a match within the aggregate */
14236 keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14238 subscript_type = FUV_SUBSCRIPT_HASH;
14241 index = find_array_subscript((const AV *)sv, uninit_sv);
14243 subscript_type = FUV_SUBSCRIPT_ARRAY;
14246 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
14249 return varname(gv, hash ? '%' : '@', obase->op_targ,
14250 keysv, index, subscript_type);
14254 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
14256 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
14257 if (!gv || !GvSTASH(gv))
14259 if (match && (GvSV(gv) != uninit_sv))
14261 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14264 return find_uninit_var(cUNOPx(obase)->op_first, uninit_sv, 1);
14267 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
14269 return varname(NULL, '$', obase->op_targ,
14270 NULL, 0, FUV_SUBSCRIPT_NONE);
14273 gv = cGVOPx_gv(obase);
14274 if (!gv || (match && GvSV(gv) != uninit_sv) || !GvSTASH(gv))
14276 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
14278 case OP_AELEMFAST_LEX:
14281 AV *av = MUTABLE_AV(PAD_SV(obase->op_targ));
14282 if (!av || SvRMAGICAL(av))
14284 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14285 if (!svp || *svp != uninit_sv)
14288 return varname(NULL, '$', obase->op_targ,
14289 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14292 gv = cGVOPx_gv(obase);
14297 AV *const av = GvAV(gv);
14298 if (!av || SvRMAGICAL(av))
14300 svp = av_fetch(av, (I32)obase->op_private, FALSE);
14301 if (!svp || *svp != uninit_sv)
14304 return varname(gv, '$', 0,
14305 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
14310 o = cUNOPx(obase)->op_first;
14311 if (!o || o->op_type != OP_NULL ||
14312 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
14314 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
14319 bool negate = FALSE;
14321 if (PL_op == obase)
14322 /* $a[uninit_expr] or $h{uninit_expr} */
14323 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
14326 o = cBINOPx(obase)->op_first;
14327 kid = cBINOPx(obase)->op_last;
14329 /* get the av or hv, and optionally the gv */
14331 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
14332 sv = PAD_SV(o->op_targ);
14334 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
14335 && cUNOPo->op_first->op_type == OP_GV)
14337 gv = cGVOPx_gv(cUNOPo->op_first);
14341 == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(GvAV(gv));
14346 if (kid && kid->op_type == OP_NEGATE) {
14348 kid = cUNOPx(kid)->op_first;
14351 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
14352 /* index is constant */
14355 kidsv = sv_2mortal(newSVpvs("-"));
14356 sv_catsv(kidsv, cSVOPx_sv(kid));
14359 kidsv = cSVOPx_sv(kid);
14363 if (obase->op_type == OP_HELEM) {
14364 HE* he = hv_fetch_ent(MUTABLE_HV(sv), kidsv, 0, 0);
14365 if (!he || HeVAL(he) != uninit_sv)
14369 SV * const * const svp = av_fetch(MUTABLE_AV(sv),
14370 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14372 if (!svp || *svp != uninit_sv)
14376 if (obase->op_type == OP_HELEM)
14377 return varname(gv, '%', o->op_targ,
14378 kidsv, 0, FUV_SUBSCRIPT_HASH);
14380 return varname(gv, '@', o->op_targ, NULL,
14381 negate ? - SvIV(cSVOPx_sv(kid)) : SvIV(cSVOPx_sv(kid)),
14382 FUV_SUBSCRIPT_ARRAY);
14385 /* index is an expression;
14386 * attempt to find a match within the aggregate */
14387 if (obase->op_type == OP_HELEM) {
14388 SV * const keysv = find_hash_subscript((const HV*)sv, uninit_sv);
14390 return varname(gv, '%', o->op_targ,
14391 keysv, 0, FUV_SUBSCRIPT_HASH);
14395 = find_array_subscript((const AV *)sv, uninit_sv);
14397 return varname(gv, '@', o->op_targ,
14398 NULL, index, FUV_SUBSCRIPT_ARRAY);
14403 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
14405 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
14411 /* only examine RHS */
14412 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
14415 o = cUNOPx(obase)->op_first;
14416 if ( o->op_type == OP_PUSHMARK
14417 || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
14421 if (!o->op_sibling) {
14422 /* one-arg version of open is highly magical */
14424 if (o->op_type == OP_GV) { /* open FOO; */
14426 if (match && GvSV(gv) != uninit_sv)
14428 return varname(gv, '$', 0,
14429 NULL, 0, FUV_SUBSCRIPT_NONE);
14431 /* other possibilities not handled are:
14432 * open $x; or open my $x; should return '${*$x}'
14433 * open expr; should return '$'.expr ideally
14439 /* ops where $_ may be an implicit arg */
14444 if ( !(obase->op_flags & OPf_STACKED)) {
14445 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
14446 ? PAD_SVl(obase->op_targ)
14449 sv = sv_newmortal();
14450 sv_setpvs(sv, "$_");
14459 match = 1; /* print etc can return undef on defined args */
14460 /* skip filehandle as it can't produce 'undef' warning */
14461 o = cUNOPx(obase)->op_first;
14462 if ((obase->op_flags & OPf_STACKED)
14464 ( o->op_type == OP_PUSHMARK
14465 || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)))
14466 o = o->op_sibling->op_sibling;
14470 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
14471 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
14473 /* the following ops are capable of returning PL_sv_undef even for
14474 * defined arg(s) */
14493 case OP_GETPEERNAME:
14541 case OP_SMARTMATCH:
14550 /* XXX tmp hack: these two may call an XS sub, and currently
14551 XS subs don't have a SUB entry on the context stack, so CV and
14552 pad determination goes wrong, and BAD things happen. So, just
14553 don't try to determine the value under those circumstances.
14554 Need a better fix at dome point. DAPM 11/2007 */
14560 GV * const gv = gv_fetchpvs(".", GV_NOTQUAL, SVt_PV);
14561 if (gv && GvSV(gv) == uninit_sv)
14562 return newSVpvs_flags("$.", SVs_TEMP);
14567 /* def-ness of rval pos() is independent of the def-ness of its arg */
14568 if ( !(obase->op_flags & OPf_MOD))
14573 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
14574 return newSVpvs_flags("${$/}", SVs_TEMP);
14579 if (!(obase->op_flags & OPf_KIDS))
14581 o = cUNOPx(obase)->op_first;
14587 /* This loop checks all the kid ops, skipping any that cannot pos-
14588 * sibly be responsible for the uninitialized value; i.e., defined
14589 * constants and ops that return nothing. If there is only one op
14590 * left that is not skipped, then we *know* it is responsible for
14591 * the uninitialized value. If there is more than one op left, we
14592 * have to look for an exact match in the while() loop below.
14593 * Note that we skip padrange, because the individual pad ops that
14594 * it replaced are still in the tree, so we work on them instead.
14597 for (kid=o; kid; kid = kid->op_sibling) {
14599 const OPCODE type = kid->op_type;
14600 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
14601 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
14602 || (type == OP_PUSHMARK)
14603 || (type == OP_PADRANGE)
14607 if (o2) { /* more than one found */
14614 return find_uninit_var(o2, uninit_sv, match);
14616 /* scan all args */
14618 sv = find_uninit_var(o, uninit_sv, 1);
14630 =for apidoc report_uninit
14632 Print appropriate "Use of uninitialized variable" warning.
14638 Perl_report_uninit(pTHX_ const SV *uninit_sv)
14642 SV* varname = NULL;
14643 if (uninit_sv && PL_curpad) {
14644 varname = find_uninit_var(PL_op, uninit_sv,0);
14646 sv_insert(varname, 0, 0, " ", 1);
14648 /* diag_listed_as: Use of uninitialized value%s */
14649 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit_sv,
14650 SVfARG(varname ? varname : &PL_sv_no),
14651 " in ", OP_DESC(PL_op));
14654 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
14660 * c-indentation-style: bsd
14661 * c-basic-offset: 4
14662 * indent-tabs-mode: nil
14665 * ex: set ts=8 sts=4 sw=4 et: