3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
250 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
251 sv->sv_debug_inpad = 0;
252 sv->sv_debug_cloned = 0;
253 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
257 # define new_SV(p) (p)=S_new_SV(aTHX)
265 (p) = S_more_sv(aTHX); \
273 /* del_SV(): return an empty SV head to the free list */
286 S_del_sv(pTHX_ SV *p)
292 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
293 const SV * const sv = sva + 1;
294 const SV * const svend = &sva[SvREFCNT(sva)];
295 if (p >= sv && p < svend) {
301 if (ckWARN_d(WARN_INTERNAL))
302 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
303 "Attempt to free non-arena SV: 0x%"UVxf
304 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
311 #else /* ! DEBUGGING */
313 #define del_SV(p) plant_SV(p)
315 #endif /* DEBUGGING */
319 =head1 SV Manipulation Functions
321 =for apidoc sv_add_arena
323 Given a chunk of memory, link it to the head of the list of arenas,
324 and split it into a list of free SVs.
330 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
333 SV* const sva = (SV*)ptr;
337 /* The first SV in an arena isn't an SV. */
338 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
339 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
340 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
342 PL_sv_arenaroot = sva;
343 PL_sv_root = sva + 1;
345 svend = &sva[SvREFCNT(sva) - 1];
348 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
352 /* Must always set typemask because it's awlays checked in on cleanup
353 when the arenas are walked looking for objects. */
354 SvFLAGS(sv) = SVTYPEMASK;
357 SvARENA_CHAIN(sv) = 0;
361 SvFLAGS(sv) = SVTYPEMASK;
364 /* visit(): call the named function for each non-free SV in the arenas
365 * whose flags field matches the flags/mask args. */
368 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
374 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
375 register const SV * const svend = &sva[SvREFCNT(sva)];
377 for (sv = sva + 1; sv < svend; ++sv) {
378 if (SvTYPE(sv) != SVTYPEMASK
379 && (sv->sv_flags & mask) == flags
392 /* called by sv_report_used() for each live SV */
395 do_report_used(pTHX_ SV *sv)
397 if (SvTYPE(sv) != SVTYPEMASK) {
398 PerlIO_printf(Perl_debug_log, "****\n");
405 =for apidoc sv_report_used
407 Dump the contents of all SVs not yet freed. (Debugging aid).
413 Perl_sv_report_used(pTHX)
416 visit(do_report_used, 0, 0);
422 /* called by sv_clean_objs() for each live SV */
425 do_clean_objs(pTHX_ SV *ref)
430 SV * const target = SvRV(ref);
431 if (SvOBJECT(target)) {
432 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
433 if (SvWEAKREF(ref)) {
434 sv_del_backref(target, ref);
440 SvREFCNT_dec(target);
445 /* XXX Might want to check arrays, etc. */
448 /* called by sv_clean_objs() for each live SV */
450 #ifndef DISABLE_DESTRUCTOR_KLUDGE
452 do_clean_named_objs(pTHX_ SV *sv)
455 assert(SvTYPE(sv) == SVt_PVGV);
456 assert(isGV_with_GP(sv));
459 #ifdef PERL_DONT_CREATE_GVSV
462 SvOBJECT(GvSV(sv))) ||
463 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
464 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
465 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
466 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
468 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
469 SvFLAGS(sv) |= SVf_BREAK;
477 =for apidoc sv_clean_objs
479 Attempt to destroy all objects not yet freed
485 Perl_sv_clean_objs(pTHX)
488 PL_in_clean_objs = TRUE;
489 visit(do_clean_objs, SVf_ROK, SVf_ROK);
490 #ifndef DISABLE_DESTRUCTOR_KLUDGE
491 /* some barnacles may yet remain, clinging to typeglobs */
492 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
494 PL_in_clean_objs = FALSE;
497 /* called by sv_clean_all() for each live SV */
500 do_clean_all(pTHX_ SV *sv)
503 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
504 SvFLAGS(sv) |= SVf_BREAK;
509 =for apidoc sv_clean_all
511 Decrement the refcnt of each remaining SV, possibly triggering a
512 cleanup. This function may have to be called multiple times to free
513 SVs which are in complex self-referential hierarchies.
519 Perl_sv_clean_all(pTHX)
523 PL_in_clean_all = TRUE;
524 cleaned = visit(do_clean_all, 0,0);
525 PL_in_clean_all = FALSE;
530 ARENASETS: a meta-arena implementation which separates arena-info
531 into struct arena_set, which contains an array of struct
532 arena_descs, each holding info for a single arena. By separating
533 the meta-info from the arena, we recover the 1st slot, formerly
534 borrowed for list management. The arena_set is about the size of an
535 arena, avoiding the needless malloc overhead of a naive linked-list.
537 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
538 memory in the last arena-set (1/2 on average). In trade, we get
539 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
540 smaller types). The recovery of the wasted space allows use of
541 small arenas for large, rare body types,
544 char *arena; /* the raw storage, allocated aligned */
545 size_t size; /* its size ~4k typ */
546 U32 misc; /* type, and in future other things. */
551 /* Get the maximum number of elements in set[] such that struct arena_set
552 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
553 therefore likely to be 1 aligned memory page. */
555 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
556 - 2 * sizeof(int)) / sizeof (struct arena_desc))
559 struct arena_set* next;
560 unsigned int set_size; /* ie ARENAS_PER_SET */
561 unsigned int curr; /* index of next available arena-desc */
562 struct arena_desc set[ARENAS_PER_SET];
566 =for apidoc sv_free_arenas
568 Deallocate the memory used by all arenas. Note that all the individual SV
569 heads and bodies within the arenas must already have been freed.
574 Perl_sv_free_arenas(pTHX)
581 /* Free arenas here, but be careful about fake ones. (We assume
582 contiguity of the fake ones with the corresponding real ones.) */
584 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
585 svanext = (SV*) SvANY(sva);
586 while (svanext && SvFAKE(svanext))
587 svanext = (SV*) SvANY(svanext);
594 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
597 struct arena_set *current = aroot;
600 assert(aroot->set[i].arena);
601 Safefree(aroot->set[i].arena);
609 i = PERL_ARENA_ROOTS_SIZE;
611 PL_body_roots[i] = 0;
613 Safefree(PL_nice_chunk);
614 PL_nice_chunk = NULL;
615 PL_nice_chunk_size = 0;
621 Here are mid-level routines that manage the allocation of bodies out
622 of the various arenas. There are 5 kinds of arenas:
624 1. SV-head arenas, which are discussed and handled above
625 2. regular body arenas
626 3. arenas for reduced-size bodies
628 5. pte arenas (thread related)
630 Arena types 2 & 3 are chained by body-type off an array of
631 arena-root pointers, which is indexed by svtype. Some of the
632 larger/less used body types are malloced singly, since a large
633 unused block of them is wasteful. Also, several svtypes dont have
634 bodies; the data fits into the sv-head itself. The arena-root
635 pointer thus has a few unused root-pointers (which may be hijacked
636 later for arena types 4,5)
638 3 differs from 2 as an optimization; some body types have several
639 unused fields in the front of the structure (which are kept in-place
640 for consistency). These bodies can be allocated in smaller chunks,
641 because the leading fields arent accessed. Pointers to such bodies
642 are decremented to point at the unused 'ghost' memory, knowing that
643 the pointers are used with offsets to the real memory.
645 HE, HEK arenas are managed separately, with separate code, but may
646 be merge-able later..
648 PTE arenas are not sv-bodies, but they share these mid-level
649 mechanics, so are considered here. The new mid-level mechanics rely
650 on the sv_type of the body being allocated, so we just reserve one
651 of the unused body-slots for PTEs, then use it in those (2) PTE
652 contexts below (line ~10k)
655 /* get_arena(size): this creates custom-sized arenas
656 TBD: export properly for hv.c: S_more_he().
659 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
662 struct arena_desc* adesc;
663 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
666 /* shouldnt need this
667 if (!arena_size) arena_size = PERL_ARENA_SIZE;
670 /* may need new arena-set to hold new arena */
671 if (!aroot || aroot->curr >= aroot->set_size) {
672 struct arena_set *newroot;
673 Newxz(newroot, 1, struct arena_set);
674 newroot->set_size = ARENAS_PER_SET;
675 newroot->next = aroot;
677 PL_body_arenas = (void *) newroot;
678 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
681 /* ok, now have arena-set with at least 1 empty/available arena-desc */
682 curr = aroot->curr++;
683 adesc = &(aroot->set[curr]);
684 assert(!adesc->arena);
686 Newx(adesc->arena, arena_size, char);
687 adesc->size = arena_size;
689 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
690 curr, (void*)adesc->arena, (UV)arena_size));
696 /* return a thing to the free list */
698 #define del_body(thing, root) \
700 void ** const thing_copy = (void **)thing;\
701 *thing_copy = *root; \
702 *root = (void*)thing_copy; \
707 =head1 SV-Body Allocation
709 Allocation of SV-bodies is similar to SV-heads, differing as follows;
710 the allocation mechanism is used for many body types, so is somewhat
711 more complicated, it uses arena-sets, and has no need for still-live
714 At the outermost level, (new|del)_X*V macros return bodies of the
715 appropriate type. These macros call either (new|del)_body_type or
716 (new|del)_body_allocated macro pairs, depending on specifics of the
717 type. Most body types use the former pair, the latter pair is used to
718 allocate body types with "ghost fields".
720 "ghost fields" are fields that are unused in certain types, and
721 consequently dont need to actually exist. They are declared because
722 they're part of a "base type", which allows use of functions as
723 methods. The simplest examples are AVs and HVs, 2 aggregate types
724 which don't use the fields which support SCALAR semantics.
726 For these types, the arenas are carved up into *_allocated size
727 chunks, we thus avoid wasted memory for those unaccessed members.
728 When bodies are allocated, we adjust the pointer back in memory by the
729 size of the bit not allocated, so it's as if we allocated the full
730 structure. (But things will all go boom if you write to the part that
731 is "not there", because you'll be overwriting the last members of the
732 preceding structure in memory.)
734 We calculate the correction using the STRUCT_OFFSET macro. For
735 example, if xpv_allocated is the same structure as XPV then the two
736 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
737 structure is smaller (no initial NV actually allocated) then the net
738 effect is to subtract the size of the NV from the pointer, to return a
739 new pointer as if an initial NV were actually allocated.
741 This is the same trick as was used for NV and IV bodies. Ironically it
742 doesn't need to be used for NV bodies any more, because NV is now at
743 the start of the structure. IV bodies don't need it either, because
744 they are no longer allocated.
746 In turn, the new_body_* allocators call S_new_body(), which invokes
747 new_body_inline macro, which takes a lock, and takes a body off the
748 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
749 necessary to refresh an empty list. Then the lock is released, and
750 the body is returned.
752 S_more_bodies calls get_arena(), and carves it up into an array of N
753 bodies, which it strings into a linked list. It looks up arena-size
754 and body-size from the body_details table described below, thus
755 supporting the multiple body-types.
757 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
758 the (new|del)_X*V macros are mapped directly to malloc/free.
764 For each sv-type, struct body_details bodies_by_type[] carries
765 parameters which control these aspects of SV handling:
767 Arena_size determines whether arenas are used for this body type, and if
768 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
769 zero, forcing individual mallocs and frees.
771 Body_size determines how big a body is, and therefore how many fit into
772 each arena. Offset carries the body-pointer adjustment needed for
773 *_allocated body types, and is used in *_allocated macros.
775 But its main purpose is to parameterize info needed in
776 Perl_sv_upgrade(). The info here dramatically simplifies the function
777 vs the implementation in 5.8.7, making it table-driven. All fields
778 are used for this, except for arena_size.
780 For the sv-types that have no bodies, arenas are not used, so those
781 PL_body_roots[sv_type] are unused, and can be overloaded. In
782 something of a special case, SVt_NULL is borrowed for HE arenas;
783 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
784 bodies_by_type[SVt_NULL] slot is not used, as the table is not
787 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
788 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
789 they can just use the same allocation semantics. At first, PTEs were
790 also overloaded to a non-body sv-type, but this yielded hard-to-find
791 malloc bugs, so was simplified by claiming a new slot. This choice
792 has no consequence at this time.
796 struct body_details {
797 U8 body_size; /* Size to allocate */
798 U8 copy; /* Size of structure to copy (may be shorter) */
800 unsigned int type : 4; /* We have space for a sanity check. */
801 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
802 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
803 unsigned int arena : 1; /* Allocated from an arena */
804 size_t arena_size; /* Size of arena to allocate */
812 /* With -DPURFIY we allocate everything directly, and don't use arenas.
813 This seems a rather elegant way to simplify some of the code below. */
814 #define HASARENA FALSE
816 #define HASARENA TRUE
818 #define NOARENA FALSE
820 /* Size the arenas to exactly fit a given number of bodies. A count
821 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
822 simplifying the default. If count > 0, the arena is sized to fit
823 only that many bodies, allowing arenas to be used for large, rare
824 bodies (XPVFM, XPVIO) without undue waste. The arena size is
825 limited by PERL_ARENA_SIZE, so we can safely oversize the
828 #define FIT_ARENA0(body_size) \
829 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
830 #define FIT_ARENAn(count,body_size) \
831 ( count * body_size <= PERL_ARENA_SIZE) \
832 ? count * body_size \
833 : FIT_ARENA0 (body_size)
834 #define FIT_ARENA(count,body_size) \
836 ? FIT_ARENAn (count, body_size) \
837 : FIT_ARENA0 (body_size)
839 /* A macro to work out the offset needed to subtract from a pointer to (say)
846 to make its members accessible via a pointer to (say)
856 #define relative_STRUCT_OFFSET(longer, shorter, member) \
857 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
859 /* Calculate the length to copy. Specifically work out the length less any
860 final padding the compiler needed to add. See the comment in sv_upgrade
861 for why copying the padding proved to be a bug. */
863 #define copy_length(type, last_member) \
864 STRUCT_OFFSET(type, last_member) \
865 + sizeof (((type*)SvANY((SV*)0))->last_member)
867 static const struct body_details bodies_by_type[] = {
868 { sizeof(HE), 0, 0, SVt_NULL,
869 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
871 /* The bind placeholder pretends to be an RV for now.
872 Also it's marked as "can't upgrade" top stop anyone using it before it's
874 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
876 /* IVs are in the head, so the allocation size is 0.
877 However, the slot is overloaded for PTEs. */
878 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
879 sizeof(IV), /* This is used to copy out the IV body. */
880 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
881 NOARENA /* IVS don't need an arena */,
882 /* But PTEs need to know the size of their arena */
883 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
886 /* 8 bytes on most ILP32 with IEEE doubles */
887 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
888 FIT_ARENA(0, sizeof(NV)) },
890 /* RVs are in the head now. */
891 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(xpv_allocated),
895 copy_length(XPV, xpv_len)
896 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
897 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
898 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
901 { sizeof(xpviv_allocated),
902 copy_length(XPVIV, xiv_u)
903 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
904 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
905 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
908 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
909 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
912 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
916 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
920 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
921 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
923 { sizeof(xpvav_allocated),
924 copy_length(XPVAV, xmg_stash)
925 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
926 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
927 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
929 { sizeof(xpvhv_allocated),
930 copy_length(XPVHV, xmg_stash)
931 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
932 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
933 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
936 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
937 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
938 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
940 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
941 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
942 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
944 /* XPVIO is 84 bytes, fits 48x */
945 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
946 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
949 #define new_body_type(sv_type) \
950 (void *)((char *)S_new_body(aTHX_ sv_type))
952 #define del_body_type(p, sv_type) \
953 del_body(p, &PL_body_roots[sv_type])
956 #define new_body_allocated(sv_type) \
957 (void *)((char *)S_new_body(aTHX_ sv_type) \
958 - bodies_by_type[sv_type].offset)
960 #define del_body_allocated(p, sv_type) \
961 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
964 #define my_safemalloc(s) (void*)safemalloc(s)
965 #define my_safecalloc(s) (void*)safecalloc(s, 1)
966 #define my_safefree(p) safefree((char*)p)
970 #define new_XNV() my_safemalloc(sizeof(XPVNV))
971 #define del_XNV(p) my_safefree(p)
973 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
974 #define del_XPVNV(p) my_safefree(p)
976 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
977 #define del_XPVAV(p) my_safefree(p)
979 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
980 #define del_XPVHV(p) my_safefree(p)
982 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
983 #define del_XPVMG(p) my_safefree(p)
985 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
986 #define del_XPVGV(p) my_safefree(p)
990 #define new_XNV() new_body_type(SVt_NV)
991 #define del_XNV(p) del_body_type(p, SVt_NV)
993 #define new_XPVNV() new_body_type(SVt_PVNV)
994 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
996 #define new_XPVAV() new_body_allocated(SVt_PVAV)
997 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
999 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1000 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1002 #define new_XPVMG() new_body_type(SVt_PVMG)
1003 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1005 #define new_XPVGV() new_body_type(SVt_PVGV)
1006 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1010 /* no arena for you! */
1012 #define new_NOARENA(details) \
1013 my_safemalloc((details)->body_size + (details)->offset)
1014 #define new_NOARENAZ(details) \
1015 my_safecalloc((details)->body_size + (details)->offset)
1018 S_more_bodies (pTHX_ svtype sv_type)
1021 void ** const root = &PL_body_roots[sv_type];
1022 const struct body_details * const bdp = &bodies_by_type[sv_type];
1023 const size_t body_size = bdp->body_size;
1026 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1027 static bool done_sanity_check;
1029 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1030 * variables like done_sanity_check. */
1031 if (!done_sanity_check) {
1032 unsigned int i = SVt_LAST;
1034 done_sanity_check = TRUE;
1037 assert (bodies_by_type[i].type == i);
1041 assert(bdp->arena_size);
1043 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1045 end = start + bdp->arena_size - body_size;
1047 /* computed count doesnt reflect the 1st slot reservation */
1048 DEBUG_m(PerlIO_printf(Perl_debug_log,
1049 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1050 (void*)start, (void*)end,
1051 (int)bdp->arena_size, sv_type, (int)body_size,
1052 (int)bdp->arena_size / (int)body_size));
1054 *root = (void *)start;
1056 while (start < end) {
1057 char * const next = start + body_size;
1058 *(void**) start = (void *)next;
1061 *(void **)start = 0;
1066 /* grab a new thing from the free list, allocating more if necessary.
1067 The inline version is used for speed in hot routines, and the
1068 function using it serves the rest (unless PURIFY).
1070 #define new_body_inline(xpv, sv_type) \
1072 void ** const r3wt = &PL_body_roots[sv_type]; \
1073 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1074 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1075 *(r3wt) = *(void**)(xpv); \
1081 S_new_body(pTHX_ svtype sv_type)
1085 new_body_inline(xpv, sv_type);
1092 =for apidoc sv_upgrade
1094 Upgrade an SV to a more complex form. Generally adds a new body type to the
1095 SV, then copies across as much information as possible from the old body.
1096 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1102 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1107 const svtype old_type = SvTYPE(sv);
1108 const struct body_details *new_type_details;
1109 const struct body_details *const old_type_details
1110 = bodies_by_type + old_type;
1112 if (new_type != SVt_PV && SvIsCOW(sv)) {
1113 sv_force_normal_flags(sv, 0);
1116 if (old_type == new_type)
1119 if (old_type > new_type)
1120 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1121 (int)old_type, (int)new_type);
1124 old_body = SvANY(sv);
1126 /* Copying structures onto other structures that have been neatly zeroed
1127 has a subtle gotcha. Consider XPVMG
1129 +------+------+------+------+------+-------+-------+
1130 | NV | CUR | LEN | IV | MAGIC | STASH |
1131 +------+------+------+------+------+-------+-------+
1132 0 4 8 12 16 20 24 28
1134 where NVs are aligned to 8 bytes, so that sizeof that structure is
1135 actually 32 bytes long, with 4 bytes of padding at the end:
1137 +------+------+------+------+------+-------+-------+------+
1138 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1139 +------+------+------+------+------+-------+-------+------+
1140 0 4 8 12 16 20 24 28 32
1142 so what happens if you allocate memory for this structure:
1144 +------+------+------+------+------+-------+-------+------+------+...
1145 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1146 +------+------+------+------+------+-------+-------+------+------+...
1147 0 4 8 12 16 20 24 28 32 36
1149 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1150 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1151 started out as zero once, but it's quite possible that it isn't. So now,
1152 rather than a nicely zeroed GP, you have it pointing somewhere random.
1155 (In fact, GP ends up pointing at a previous GP structure, because the
1156 principle cause of the padding in XPVMG getting garbage is a copy of
1157 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1158 this happens to be moot because XPVGV has been re-ordered, with GP
1159 no longer after STASH)
1161 So we are careful and work out the size of used parts of all the
1168 if (new_type < SVt_PVIV) {
1169 new_type = (new_type == SVt_NV)
1170 ? SVt_PVNV : SVt_PVIV;
1174 if (new_type < SVt_PVNV) {
1175 new_type = SVt_PVNV;
1181 assert(new_type > SVt_PV);
1182 assert(SVt_IV < SVt_PV);
1183 assert(SVt_NV < SVt_PV);
1190 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1191 there's no way that it can be safely upgraded, because perl.c
1192 expects to Safefree(SvANY(PL_mess_sv)) */
1193 assert(sv != PL_mess_sv);
1194 /* This flag bit is used to mean other things in other scalar types.
1195 Given that it only has meaning inside the pad, it shouldn't be set
1196 on anything that can get upgraded. */
1197 assert(!SvPAD_TYPED(sv));
1200 if (old_type_details->cant_upgrade)
1201 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1202 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1204 new_type_details = bodies_by_type + new_type;
1206 SvFLAGS(sv) &= ~SVTYPEMASK;
1207 SvFLAGS(sv) |= new_type;
1209 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1210 the return statements above will have triggered. */
1211 assert (new_type != SVt_NULL);
1214 assert(old_type == SVt_NULL);
1215 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1219 assert(old_type == SVt_NULL);
1220 SvANY(sv) = new_XNV();
1224 assert(old_type == SVt_NULL);
1225 SvANY(sv) = &sv->sv_u.svu_rv;
1230 assert(new_type_details->body_size);
1233 assert(new_type_details->arena);
1234 assert(new_type_details->arena_size);
1235 /* This points to the start of the allocated area. */
1236 new_body_inline(new_body, new_type);
1237 Zero(new_body, new_type_details->body_size, char);
1238 new_body = ((char *)new_body) - new_type_details->offset;
1240 /* We always allocated the full length item with PURIFY. To do this
1241 we fake things so that arena is false for all 16 types.. */
1242 new_body = new_NOARENAZ(new_type_details);
1244 SvANY(sv) = new_body;
1245 if (new_type == SVt_PVAV) {
1251 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1252 The target created by newSVrv also is, and it can have magic.
1253 However, it never has SvPVX set.
1255 if (old_type >= SVt_RV) {
1256 assert(SvPVX_const(sv) == 0);
1259 if (old_type >= SVt_PVMG) {
1260 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1261 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1263 sv->sv_u.svu_array = NULL; /* or svu_hash */
1269 /* XXX Is this still needed? Was it ever needed? Surely as there is
1270 no route from NV to PVIV, NOK can never be true */
1271 assert(!SvNOKp(sv));
1282 assert(new_type_details->body_size);
1283 /* We always allocated the full length item with PURIFY. To do this
1284 we fake things so that arena is false for all 16 types.. */
1285 if(new_type_details->arena) {
1286 /* This points to the start of the allocated area. */
1287 new_body_inline(new_body, new_type);
1288 Zero(new_body, new_type_details->body_size, char);
1289 new_body = ((char *)new_body) - new_type_details->offset;
1291 new_body = new_NOARENAZ(new_type_details);
1293 SvANY(sv) = new_body;
1295 if (old_type_details->copy) {
1296 /* There is now the potential for an upgrade from something without
1297 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1298 int offset = old_type_details->offset;
1299 int length = old_type_details->copy;
1301 if (new_type_details->offset > old_type_details->offset) {
1302 const int difference
1303 = new_type_details->offset - old_type_details->offset;
1304 offset += difference;
1305 length -= difference;
1307 assert (length >= 0);
1309 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1313 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1314 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1315 * correct 0.0 for us. Otherwise, if the old body didn't have an
1316 * NV slot, but the new one does, then we need to initialise the
1317 * freshly created NV slot with whatever the correct bit pattern is
1319 if (old_type_details->zero_nv && !new_type_details->zero_nv
1320 && !isGV_with_GP(sv))
1324 if (new_type == SVt_PVIO)
1325 IoPAGE_LEN(sv) = 60;
1326 if (old_type < SVt_RV)
1330 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1331 (unsigned long)new_type);
1334 if (old_type_details->arena) {
1335 /* If there was an old body, then we need to free it.
1336 Note that there is an assumption that all bodies of types that
1337 can be upgraded came from arenas. Only the more complex non-
1338 upgradable types are allowed to be directly malloc()ed. */
1340 my_safefree(old_body);
1342 del_body((void*)((char*)old_body + old_type_details->offset),
1343 &PL_body_roots[old_type]);
1349 =for apidoc sv_backoff
1351 Remove any string offset. You should normally use the C<SvOOK_off> macro
1358 Perl_sv_backoff(pTHX_ register SV *sv)
1360 PERL_UNUSED_CONTEXT;
1362 assert(SvTYPE(sv) != SVt_PVHV);
1363 assert(SvTYPE(sv) != SVt_PVAV);
1365 const char * const s = SvPVX_const(sv);
1366 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1367 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1369 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1371 SvFLAGS(sv) &= ~SVf_OOK;
1378 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1379 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1380 Use the C<SvGROW> wrapper instead.
1386 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1390 if (PL_madskills && newlen >= 0x100000) {
1391 PerlIO_printf(Perl_debug_log,
1392 "Allocation too large: %"UVxf"\n", (UV)newlen);
1394 #ifdef HAS_64K_LIMIT
1395 if (newlen >= 0x10000) {
1396 PerlIO_printf(Perl_debug_log,
1397 "Allocation too large: %"UVxf"\n", (UV)newlen);
1400 #endif /* HAS_64K_LIMIT */
1403 if (SvTYPE(sv) < SVt_PV) {
1404 sv_upgrade(sv, SVt_PV);
1405 s = SvPVX_mutable(sv);
1407 else if (SvOOK(sv)) { /* pv is offset? */
1409 s = SvPVX_mutable(sv);
1410 if (newlen > SvLEN(sv))
1411 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1412 #ifdef HAS_64K_LIMIT
1413 if (newlen >= 0x10000)
1418 s = SvPVX_mutable(sv);
1420 if (newlen > SvLEN(sv)) { /* need more room? */
1421 newlen = PERL_STRLEN_ROUNDUP(newlen);
1422 if (SvLEN(sv) && s) {
1424 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1430 s = (char*)saferealloc(s, newlen);
1433 s = (char*)safemalloc(newlen);
1434 if (SvPVX_const(sv) && SvCUR(sv)) {
1435 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1439 SvLEN_set(sv, newlen);
1445 =for apidoc sv_setiv
1447 Copies an integer into the given SV, upgrading first if necessary.
1448 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1454 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1457 SV_CHECK_THINKFIRST_COW_DROP(sv);
1458 switch (SvTYPE(sv)) {
1460 sv_upgrade(sv, SVt_IV);
1463 sv_upgrade(sv, SVt_PVNV);
1467 sv_upgrade(sv, SVt_PVIV);
1476 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1480 (void)SvIOK_only(sv); /* validate number */
1486 =for apidoc sv_setiv_mg
1488 Like C<sv_setiv>, but also handles 'set' magic.
1494 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1501 =for apidoc sv_setuv
1503 Copies an unsigned integer into the given SV, upgrading first if necessary.
1504 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1510 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1512 /* With these two if statements:
1513 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1516 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1518 If you wish to remove them, please benchmark to see what the effect is
1520 if (u <= (UV)IV_MAX) {
1521 sv_setiv(sv, (IV)u);
1530 =for apidoc sv_setuv_mg
1532 Like C<sv_setuv>, but also handles 'set' magic.
1538 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1545 =for apidoc sv_setnv
1547 Copies a double into the given SV, upgrading first if necessary.
1548 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1554 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1557 SV_CHECK_THINKFIRST_COW_DROP(sv);
1558 switch (SvTYPE(sv)) {
1561 sv_upgrade(sv, SVt_NV);
1566 sv_upgrade(sv, SVt_PVNV);
1575 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1580 (void)SvNOK_only(sv); /* validate number */
1585 =for apidoc sv_setnv_mg
1587 Like C<sv_setnv>, but also handles 'set' magic.
1593 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1599 /* Print an "isn't numeric" warning, using a cleaned-up,
1600 * printable version of the offending string
1604 S_not_a_number(pTHX_ SV *sv)
1612 dsv = sv_2mortal(newSVpvs(""));
1613 pv = sv_uni_display(dsv, sv, 10, 0);
1616 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1617 /* each *s can expand to 4 chars + "...\0",
1618 i.e. need room for 8 chars */
1620 const char *s = SvPVX_const(sv);
1621 const char * const end = s + SvCUR(sv);
1622 for ( ; s < end && d < limit; s++ ) {
1624 if (ch & 128 && !isPRINT_LC(ch)) {
1633 else if (ch == '\r') {
1637 else if (ch == '\f') {
1641 else if (ch == '\\') {
1645 else if (ch == '\0') {
1649 else if (isPRINT_LC(ch))
1666 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1667 "Argument \"%s\" isn't numeric in %s", pv,
1670 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1671 "Argument \"%s\" isn't numeric", pv);
1675 =for apidoc looks_like_number
1677 Test if the content of an SV looks like a number (or is a number).
1678 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1679 non-numeric warning), even if your atof() doesn't grok them.
1685 Perl_looks_like_number(pTHX_ SV *sv)
1687 register const char *sbegin;
1691 sbegin = SvPVX_const(sv);
1694 else if (SvPOKp(sv))
1695 sbegin = SvPV_const(sv, len);
1697 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1698 return grok_number(sbegin, len, NULL);
1702 S_glob_2number(pTHX_ GV * const gv)
1704 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1705 SV *const buffer = sv_newmortal();
1707 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1710 gv_efullname3(buffer, gv, "*");
1711 SvFLAGS(gv) |= wasfake;
1713 /* We know that all GVs stringify to something that is not-a-number,
1714 so no need to test that. */
1715 if (ckWARN(WARN_NUMERIC))
1716 not_a_number(buffer);
1717 /* We just want something true to return, so that S_sv_2iuv_common
1718 can tail call us and return true. */
1723 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1725 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1726 SV *const buffer = sv_newmortal();
1728 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1731 gv_efullname3(buffer, gv, "*");
1732 SvFLAGS(gv) |= wasfake;
1734 assert(SvPOK(buffer));
1736 *len = SvCUR(buffer);
1738 return SvPVX(buffer);
1741 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1742 until proven guilty, assume that things are not that bad... */
1747 As 64 bit platforms often have an NV that doesn't preserve all bits of
1748 an IV (an assumption perl has been based on to date) it becomes necessary
1749 to remove the assumption that the NV always carries enough precision to
1750 recreate the IV whenever needed, and that the NV is the canonical form.
1751 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1752 precision as a side effect of conversion (which would lead to insanity
1753 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1754 1) to distinguish between IV/UV/NV slots that have cached a valid
1755 conversion where precision was lost and IV/UV/NV slots that have a
1756 valid conversion which has lost no precision
1757 2) to ensure that if a numeric conversion to one form is requested that
1758 would lose precision, the precise conversion (or differently
1759 imprecise conversion) is also performed and cached, to prevent
1760 requests for different numeric formats on the same SV causing
1761 lossy conversion chains. (lossless conversion chains are perfectly
1766 SvIOKp is true if the IV slot contains a valid value
1767 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1768 SvNOKp is true if the NV slot contains a valid value
1769 SvNOK is true only if the NV value is accurate
1772 while converting from PV to NV, check to see if converting that NV to an
1773 IV(or UV) would lose accuracy over a direct conversion from PV to
1774 IV(or UV). If it would, cache both conversions, return NV, but mark
1775 SV as IOK NOKp (ie not NOK).
1777 While converting from PV to IV, check to see if converting that IV to an
1778 NV would lose accuracy over a direct conversion from PV to NV. If it
1779 would, cache both conversions, flag similarly.
1781 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1782 correctly because if IV & NV were set NV *always* overruled.
1783 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1784 changes - now IV and NV together means that the two are interchangeable:
1785 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1787 The benefit of this is that operations such as pp_add know that if
1788 SvIOK is true for both left and right operands, then integer addition
1789 can be used instead of floating point (for cases where the result won't
1790 overflow). Before, floating point was always used, which could lead to
1791 loss of precision compared with integer addition.
1793 * making IV and NV equal status should make maths accurate on 64 bit
1795 * may speed up maths somewhat if pp_add and friends start to use
1796 integers when possible instead of fp. (Hopefully the overhead in
1797 looking for SvIOK and checking for overflow will not outweigh the
1798 fp to integer speedup)
1799 * will slow down integer operations (callers of SvIV) on "inaccurate"
1800 values, as the change from SvIOK to SvIOKp will cause a call into
1801 sv_2iv each time rather than a macro access direct to the IV slot
1802 * should speed up number->string conversion on integers as IV is
1803 favoured when IV and NV are equally accurate
1805 ####################################################################
1806 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1807 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1808 On the other hand, SvUOK is true iff UV.
1809 ####################################################################
1811 Your mileage will vary depending your CPU's relative fp to integer
1815 #ifndef NV_PRESERVES_UV
1816 # define IS_NUMBER_UNDERFLOW_IV 1
1817 # define IS_NUMBER_UNDERFLOW_UV 2
1818 # define IS_NUMBER_IV_AND_UV 2
1819 # define IS_NUMBER_OVERFLOW_IV 4
1820 # define IS_NUMBER_OVERFLOW_UV 5
1822 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1824 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1826 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1829 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1830 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));
1831 if (SvNVX(sv) < (NV)IV_MIN) {
1832 (void)SvIOKp_on(sv);
1834 SvIV_set(sv, IV_MIN);
1835 return IS_NUMBER_UNDERFLOW_IV;
1837 if (SvNVX(sv) > (NV)UV_MAX) {
1838 (void)SvIOKp_on(sv);
1841 SvUV_set(sv, UV_MAX);
1842 return IS_NUMBER_OVERFLOW_UV;
1844 (void)SvIOKp_on(sv);
1846 /* Can't use strtol etc to convert this string. (See truth table in
1848 if (SvNVX(sv) <= (UV)IV_MAX) {
1849 SvIV_set(sv, I_V(SvNVX(sv)));
1850 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1851 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1853 /* Integer is imprecise. NOK, IOKp */
1855 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1858 SvUV_set(sv, U_V(SvNVX(sv)));
1859 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1860 if (SvUVX(sv) == UV_MAX) {
1861 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1862 possibly be preserved by NV. Hence, it must be overflow.
1864 return IS_NUMBER_OVERFLOW_UV;
1866 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1868 /* Integer is imprecise. NOK, IOKp */
1870 return IS_NUMBER_OVERFLOW_IV;
1872 #endif /* !NV_PRESERVES_UV*/
1875 S_sv_2iuv_common(pTHX_ SV *sv) {
1878 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1879 * without also getting a cached IV/UV from it at the same time
1880 * (ie PV->NV conversion should detect loss of accuracy and cache
1881 * IV or UV at same time to avoid this. */
1882 /* IV-over-UV optimisation - choose to cache IV if possible */
1884 if (SvTYPE(sv) == SVt_NV)
1885 sv_upgrade(sv, SVt_PVNV);
1887 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1888 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1889 certainly cast into the IV range at IV_MAX, whereas the correct
1890 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1892 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1893 if (Perl_isnan(SvNVX(sv))) {
1899 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1900 SvIV_set(sv, I_V(SvNVX(sv)));
1901 if (SvNVX(sv) == (NV) SvIVX(sv)
1902 #ifndef NV_PRESERVES_UV
1903 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1904 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1905 /* Don't flag it as "accurately an integer" if the number
1906 came from a (by definition imprecise) NV operation, and
1907 we're outside the range of NV integer precision */
1910 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1911 DEBUG_c(PerlIO_printf(Perl_debug_log,
1912 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1918 /* IV not precise. No need to convert from PV, as NV
1919 conversion would already have cached IV if it detected
1920 that PV->IV would be better than PV->NV->IV
1921 flags already correct - don't set public IOK. */
1922 DEBUG_c(PerlIO_printf(Perl_debug_log,
1923 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1928 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1929 but the cast (NV)IV_MIN rounds to a the value less (more
1930 negative) than IV_MIN which happens to be equal to SvNVX ??
1931 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1932 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1933 (NV)UVX == NVX are both true, but the values differ. :-(
1934 Hopefully for 2s complement IV_MIN is something like
1935 0x8000000000000000 which will be exact. NWC */
1938 SvUV_set(sv, U_V(SvNVX(sv)));
1940 (SvNVX(sv) == (NV) SvUVX(sv))
1941 #ifndef NV_PRESERVES_UV
1942 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1943 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1944 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1945 /* Don't flag it as "accurately an integer" if the number
1946 came from a (by definition imprecise) NV operation, and
1947 we're outside the range of NV integer precision */
1952 DEBUG_c(PerlIO_printf(Perl_debug_log,
1953 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1959 else if (SvPOKp(sv) && SvLEN(sv)) {
1961 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1962 /* We want to avoid a possible problem when we cache an IV/ a UV which
1963 may be later translated to an NV, and the resulting NV is not
1964 the same as the direct translation of the initial string
1965 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1966 be careful to ensure that the value with the .456 is around if the
1967 NV value is requested in the future).
1969 This means that if we cache such an IV/a UV, we need to cache the
1970 NV as well. Moreover, we trade speed for space, and do not
1971 cache the NV if we are sure it's not needed.
1974 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1975 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1976 == IS_NUMBER_IN_UV) {
1977 /* It's definitely an integer, only upgrade to PVIV */
1978 if (SvTYPE(sv) < SVt_PVIV)
1979 sv_upgrade(sv, SVt_PVIV);
1981 } else if (SvTYPE(sv) < SVt_PVNV)
1982 sv_upgrade(sv, SVt_PVNV);
1984 /* If NVs preserve UVs then we only use the UV value if we know that
1985 we aren't going to call atof() below. If NVs don't preserve UVs
1986 then the value returned may have more precision than atof() will
1987 return, even though value isn't perfectly accurate. */
1988 if ((numtype & (IS_NUMBER_IN_UV
1989 #ifdef NV_PRESERVES_UV
1992 )) == IS_NUMBER_IN_UV) {
1993 /* This won't turn off the public IOK flag if it was set above */
1994 (void)SvIOKp_on(sv);
1996 if (!(numtype & IS_NUMBER_NEG)) {
1998 if (value <= (UV)IV_MAX) {
1999 SvIV_set(sv, (IV)value);
2001 /* it didn't overflow, and it was positive. */
2002 SvUV_set(sv, value);
2006 /* 2s complement assumption */
2007 if (value <= (UV)IV_MIN) {
2008 SvIV_set(sv, -(IV)value);
2010 /* Too negative for an IV. This is a double upgrade, but
2011 I'm assuming it will be rare. */
2012 if (SvTYPE(sv) < SVt_PVNV)
2013 sv_upgrade(sv, SVt_PVNV);
2017 SvNV_set(sv, -(NV)value);
2018 SvIV_set(sv, IV_MIN);
2022 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2023 will be in the previous block to set the IV slot, and the next
2024 block to set the NV slot. So no else here. */
2026 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2027 != IS_NUMBER_IN_UV) {
2028 /* It wasn't an (integer that doesn't overflow the UV). */
2029 SvNV_set(sv, Atof(SvPVX_const(sv)));
2031 if (! numtype && ckWARN(WARN_NUMERIC))
2034 #if defined(USE_LONG_DOUBLE)
2035 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2036 PTR2UV(sv), SvNVX(sv)));
2038 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2039 PTR2UV(sv), SvNVX(sv)));
2042 #ifdef NV_PRESERVES_UV
2043 (void)SvIOKp_on(sv);
2045 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2046 SvIV_set(sv, I_V(SvNVX(sv)));
2047 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2050 NOOP; /* Integer is imprecise. NOK, IOKp */
2052 /* UV will not work better than IV */
2054 if (SvNVX(sv) > (NV)UV_MAX) {
2056 /* Integer is inaccurate. NOK, IOKp, is UV */
2057 SvUV_set(sv, UV_MAX);
2059 SvUV_set(sv, U_V(SvNVX(sv)));
2060 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2061 NV preservse UV so can do correct comparison. */
2062 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2065 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2070 #else /* NV_PRESERVES_UV */
2071 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2072 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2073 /* The IV/UV slot will have been set from value returned by
2074 grok_number above. The NV slot has just been set using
2077 assert (SvIOKp(sv));
2079 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2080 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2081 /* Small enough to preserve all bits. */
2082 (void)SvIOKp_on(sv);
2084 SvIV_set(sv, I_V(SvNVX(sv)));
2085 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2087 /* Assumption: first non-preserved integer is < IV_MAX,
2088 this NV is in the preserved range, therefore: */
2089 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2091 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);
2095 0 0 already failed to read UV.
2096 0 1 already failed to read UV.
2097 1 0 you won't get here in this case. IV/UV
2098 slot set, public IOK, Atof() unneeded.
2099 1 1 already read UV.
2100 so there's no point in sv_2iuv_non_preserve() attempting
2101 to use atol, strtol, strtoul etc. */
2102 sv_2iuv_non_preserve (sv, numtype);
2105 #endif /* NV_PRESERVES_UV */
2109 if (isGV_with_GP(sv))
2110 return glob_2number((GV *)sv);
2112 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2113 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2116 if (SvTYPE(sv) < SVt_IV)
2117 /* Typically the caller expects that sv_any is not NULL now. */
2118 sv_upgrade(sv, SVt_IV);
2119 /* Return 0 from the caller. */
2126 =for apidoc sv_2iv_flags
2128 Return the integer value of an SV, doing any necessary string
2129 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2130 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2136 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2141 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2142 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2143 cache IVs just in case. In practice it seems that they never
2144 actually anywhere accessible by user Perl code, let alone get used
2145 in anything other than a string context. */
2146 if (flags & SV_GMAGIC)
2151 return I_V(SvNVX(sv));
2153 if (SvPOKp(sv) && SvLEN(sv)) {
2156 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2158 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2159 == IS_NUMBER_IN_UV) {
2160 /* It's definitely an integer */
2161 if (numtype & IS_NUMBER_NEG) {
2162 if (value < (UV)IV_MIN)
2165 if (value < (UV)IV_MAX)
2170 if (ckWARN(WARN_NUMERIC))
2173 return I_V(Atof(SvPVX_const(sv)));
2178 assert(SvTYPE(sv) >= SVt_PVMG);
2179 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2180 } else if (SvTHINKFIRST(sv)) {
2184 SV * const tmpstr=AMG_CALLun(sv,numer);
2185 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2186 return SvIV(tmpstr);
2189 return PTR2IV(SvRV(sv));
2192 sv_force_normal_flags(sv, 0);
2194 if (SvREADONLY(sv) && !SvOK(sv)) {
2195 if (ckWARN(WARN_UNINITIALIZED))
2201 if (S_sv_2iuv_common(aTHX_ sv))
2204 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2205 PTR2UV(sv),SvIVX(sv)));
2206 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2210 =for apidoc sv_2uv_flags
2212 Return the unsigned integer value of an SV, doing any necessary string
2213 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2214 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2220 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2225 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2226 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2227 cache IVs just in case. */
2228 if (flags & SV_GMAGIC)
2233 return U_V(SvNVX(sv));
2234 if (SvPOKp(sv) && SvLEN(sv)) {
2237 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2239 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2240 == IS_NUMBER_IN_UV) {
2241 /* It's definitely an integer */
2242 if (!(numtype & IS_NUMBER_NEG))
2246 if (ckWARN(WARN_NUMERIC))
2249 return U_V(Atof(SvPVX_const(sv)));
2254 assert(SvTYPE(sv) >= SVt_PVMG);
2255 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2256 } else if (SvTHINKFIRST(sv)) {
2260 SV *const tmpstr = AMG_CALLun(sv,numer);
2261 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2262 return SvUV(tmpstr);
2265 return PTR2UV(SvRV(sv));
2268 sv_force_normal_flags(sv, 0);
2270 if (SvREADONLY(sv) && !SvOK(sv)) {
2271 if (ckWARN(WARN_UNINITIALIZED))
2277 if (S_sv_2iuv_common(aTHX_ sv))
2281 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2282 PTR2UV(sv),SvUVX(sv)));
2283 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2289 Return the num value of an SV, doing any necessary string or integer
2290 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2297 Perl_sv_2nv(pTHX_ register SV *sv)
2302 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2303 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2304 cache IVs just in case. */
2308 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2309 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2310 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2312 return Atof(SvPVX_const(sv));
2316 return (NV)SvUVX(sv);
2318 return (NV)SvIVX(sv);
2323 assert(SvTYPE(sv) >= SVt_PVMG);
2324 /* This falls through to the report_uninit near the end of the
2326 } else if (SvTHINKFIRST(sv)) {
2330 SV *const tmpstr = AMG_CALLun(sv,numer);
2331 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2332 return SvNV(tmpstr);
2335 return PTR2NV(SvRV(sv));
2338 sv_force_normal_flags(sv, 0);
2340 if (SvREADONLY(sv) && !SvOK(sv)) {
2341 if (ckWARN(WARN_UNINITIALIZED))
2346 if (SvTYPE(sv) < SVt_NV) {
2347 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2348 sv_upgrade(sv, SVt_NV);
2349 #ifdef USE_LONG_DOUBLE
2351 STORE_NUMERIC_LOCAL_SET_STANDARD();
2352 PerlIO_printf(Perl_debug_log,
2353 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2354 PTR2UV(sv), SvNVX(sv));
2355 RESTORE_NUMERIC_LOCAL();
2359 STORE_NUMERIC_LOCAL_SET_STANDARD();
2360 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2361 PTR2UV(sv), SvNVX(sv));
2362 RESTORE_NUMERIC_LOCAL();
2366 else if (SvTYPE(sv) < SVt_PVNV)
2367 sv_upgrade(sv, SVt_PVNV);
2372 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2373 #ifdef NV_PRESERVES_UV
2376 /* Only set the public NV OK flag if this NV preserves the IV */
2377 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2378 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2379 : (SvIVX(sv) == I_V(SvNVX(sv))))
2385 else if (SvPOKp(sv) && SvLEN(sv)) {
2387 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2388 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2390 #ifdef NV_PRESERVES_UV
2391 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2392 == IS_NUMBER_IN_UV) {
2393 /* It's definitely an integer */
2394 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2396 SvNV_set(sv, Atof(SvPVX_const(sv)));
2399 SvNV_set(sv, Atof(SvPVX_const(sv)));
2400 /* Only set the public NV OK flag if this NV preserves the value in
2401 the PV at least as well as an IV/UV would.
2402 Not sure how to do this 100% reliably. */
2403 /* if that shift count is out of range then Configure's test is
2404 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2406 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2407 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2408 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2409 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2410 /* Can't use strtol etc to convert this string, so don't try.
2411 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2414 /* value has been set. It may not be precise. */
2415 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2416 /* 2s complement assumption for (UV)IV_MIN */
2417 SvNOK_on(sv); /* Integer is too negative. */
2422 if (numtype & IS_NUMBER_NEG) {
2423 SvIV_set(sv, -(IV)value);
2424 } else if (value <= (UV)IV_MAX) {
2425 SvIV_set(sv, (IV)value);
2427 SvUV_set(sv, value);
2431 if (numtype & IS_NUMBER_NOT_INT) {
2432 /* I believe that even if the original PV had decimals,
2433 they are lost beyond the limit of the FP precision.
2434 However, neither is canonical, so both only get p
2435 flags. NWC, 2000/11/25 */
2436 /* Both already have p flags, so do nothing */
2438 const NV nv = SvNVX(sv);
2439 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2440 if (SvIVX(sv) == I_V(nv)) {
2443 /* It had no "." so it must be integer. */
2447 /* between IV_MAX and NV(UV_MAX).
2448 Could be slightly > UV_MAX */
2450 if (numtype & IS_NUMBER_NOT_INT) {
2451 /* UV and NV both imprecise. */
2453 const UV nv_as_uv = U_V(nv);
2455 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2464 #endif /* NV_PRESERVES_UV */
2467 if (isGV_with_GP(sv)) {
2468 glob_2number((GV *)sv);
2472 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2474 assert (SvTYPE(sv) >= SVt_NV);
2475 /* Typically the caller expects that sv_any is not NULL now. */
2476 /* XXX Ilya implies that this is a bug in callers that assume this
2477 and ideally should be fixed. */
2480 #if defined(USE_LONG_DOUBLE)
2482 STORE_NUMERIC_LOCAL_SET_STANDARD();
2483 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2484 PTR2UV(sv), SvNVX(sv));
2485 RESTORE_NUMERIC_LOCAL();
2489 STORE_NUMERIC_LOCAL_SET_STANDARD();
2490 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2491 PTR2UV(sv), SvNVX(sv));
2492 RESTORE_NUMERIC_LOCAL();
2498 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2499 * UV as a string towards the end of buf, and return pointers to start and
2502 * We assume that buf is at least TYPE_CHARS(UV) long.
2506 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2508 char *ptr = buf + TYPE_CHARS(UV);
2509 char * const ebuf = ptr;
2522 *--ptr = '0' + (char)(uv % 10);
2531 =for apidoc sv_2pv_flags
2533 Returns a pointer to the string value of an SV, and sets *lp to its length.
2534 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2536 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2537 usually end up here too.
2543 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2553 if (SvGMAGICAL(sv)) {
2554 if (flags & SV_GMAGIC)
2559 if (flags & SV_MUTABLE_RETURN)
2560 return SvPVX_mutable(sv);
2561 if (flags & SV_CONST_RETURN)
2562 return (char *)SvPVX_const(sv);
2565 if (SvIOKp(sv) || SvNOKp(sv)) {
2566 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2571 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2572 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2574 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2581 #ifdef FIXNEGATIVEZERO
2582 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2588 SvUPGRADE(sv, SVt_PV);
2591 s = SvGROW_mutable(sv, len + 1);
2594 return (char*)memcpy(s, tbuf, len + 1);
2600 assert(SvTYPE(sv) >= SVt_PVMG);
2601 /* This falls through to the report_uninit near the end of the
2603 } else if (SvTHINKFIRST(sv)) {
2607 SV *const tmpstr = AMG_CALLun(sv,string);
2608 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2610 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2614 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2615 if (flags & SV_CONST_RETURN) {
2616 pv = (char *) SvPVX_const(tmpstr);
2618 pv = (flags & SV_MUTABLE_RETURN)
2619 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2622 *lp = SvCUR(tmpstr);
2624 pv = sv_2pv_flags(tmpstr, lp, flags);
2638 const SV *const referent = (SV*)SvRV(sv);
2642 retval = buffer = savepvn("NULLREF", len);
2643 } else if (SvTYPE(referent) == SVt_PVMG
2644 && ((SvFLAGS(referent) &
2645 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2646 == (SVs_OBJECT|SVs_SMG))
2647 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2652 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2657 PL_reginterp_cnt += haseval;
2660 const char *const typestr = sv_reftype(referent, 0);
2661 const STRLEN typelen = strlen(typestr);
2662 UV addr = PTR2UV(referent);
2663 const char *stashname = NULL;
2664 STRLEN stashnamelen = 0; /* hush, gcc */
2665 const char *buffer_end;
2667 if (SvOBJECT(referent)) {
2668 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2671 stashname = HEK_KEY(name);
2672 stashnamelen = HEK_LEN(name);
2674 if (HEK_UTF8(name)) {
2680 stashname = "__ANON__";
2683 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2684 + 2 * sizeof(UV) + 2 /* )\0 */;
2686 len = typelen + 3 /* (0x */
2687 + 2 * sizeof(UV) + 2 /* )\0 */;
2690 Newx(buffer, len, char);
2691 buffer_end = retval = buffer + len;
2693 /* Working backwards */
2697 *--retval = PL_hexdigit[addr & 15];
2698 } while (addr >>= 4);
2704 memcpy(retval, typestr, typelen);
2708 retval -= stashnamelen;
2709 memcpy(retval, stashname, stashnamelen);
2711 /* retval may not neccesarily have reached the start of the
2713 assert (retval >= buffer);
2715 len = buffer_end - retval - 1; /* -1 for that \0 */
2723 if (SvREADONLY(sv) && !SvOK(sv)) {
2724 if (ckWARN(WARN_UNINITIALIZED))
2731 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2732 /* I'm assuming that if both IV and NV are equally valid then
2733 converting the IV is going to be more efficient */
2734 const U32 isUIOK = SvIsUV(sv);
2735 char buf[TYPE_CHARS(UV)];
2738 if (SvTYPE(sv) < SVt_PVIV)
2739 sv_upgrade(sv, SVt_PVIV);
2740 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2741 /* inlined from sv_setpvn */
2742 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2743 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2744 SvCUR_set(sv, ebuf - ptr);
2748 else if (SvNOKp(sv)) {
2749 const int olderrno = errno;
2750 if (SvTYPE(sv) < SVt_PVNV)
2751 sv_upgrade(sv, SVt_PVNV);
2752 /* The +20 is pure guesswork. Configure test needed. --jhi */
2753 s = SvGROW_mutable(sv, NV_DIG + 20);
2754 /* some Xenix systems wipe out errno here */
2756 if (SvNVX(sv) == 0.0)
2757 my_strlcpy(s, "0", SvLEN(sv));
2761 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2764 #ifdef FIXNEGATIVEZERO
2765 if (*s == '-' && s[1] == '0' && !s[2])
2766 my_strlcpy(s, "0", SvLEN(s));
2775 if (isGV_with_GP(sv))
2776 return glob_2pv((GV *)sv, lp);
2778 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2782 if (SvTYPE(sv) < SVt_PV)
2783 /* Typically the caller expects that sv_any is not NULL now. */
2784 sv_upgrade(sv, SVt_PV);
2788 const STRLEN len = s - SvPVX_const(sv);
2794 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2795 PTR2UV(sv),SvPVX_const(sv)));
2796 if (flags & SV_CONST_RETURN)
2797 return (char *)SvPVX_const(sv);
2798 if (flags & SV_MUTABLE_RETURN)
2799 return SvPVX_mutable(sv);
2804 =for apidoc sv_copypv
2806 Copies a stringified representation of the source SV into the
2807 destination SV. Automatically performs any necessary mg_get and
2808 coercion of numeric values into strings. Guaranteed to preserve
2809 UTF8 flag even from overloaded objects. Similar in nature to
2810 sv_2pv[_flags] but operates directly on an SV instead of just the
2811 string. Mostly uses sv_2pv_flags to do its work, except when that
2812 would lose the UTF-8'ness of the PV.
2818 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2821 const char * const s = SvPV_const(ssv,len);
2822 sv_setpvn(dsv,s,len);
2830 =for apidoc sv_2pvbyte
2832 Return a pointer to the byte-encoded representation of the SV, and set *lp
2833 to its length. May cause the SV to be downgraded from UTF-8 as a
2836 Usually accessed via the C<SvPVbyte> macro.
2842 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2844 sv_utf8_downgrade(sv,0);
2845 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2849 =for apidoc sv_2pvutf8
2851 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2852 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2854 Usually accessed via the C<SvPVutf8> macro.
2860 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2862 sv_utf8_upgrade(sv);
2863 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2868 =for apidoc sv_2bool
2870 This function is only called on magical items, and is only used by
2871 sv_true() or its macro equivalent.
2877 Perl_sv_2bool(pTHX_ register SV *sv)
2886 SV * const tmpsv = AMG_CALLun(sv,bool_);
2887 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2888 return (bool)SvTRUE(tmpsv);
2890 return SvRV(sv) != 0;
2893 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2895 (*sv->sv_u.svu_pv > '0' ||
2896 Xpvtmp->xpv_cur > 1 ||
2897 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2904 return SvIVX(sv) != 0;
2907 return SvNVX(sv) != 0.0;
2909 if (isGV_with_GP(sv))
2919 =for apidoc sv_utf8_upgrade
2921 Converts the PV of an SV to its UTF-8-encoded form.
2922 Forces the SV to string form if it is not already.
2923 Always sets the SvUTF8 flag to avoid future validity checks even
2924 if all the bytes have hibit clear.
2926 This is not as a general purpose byte encoding to Unicode interface:
2927 use the Encode extension for that.
2929 =for apidoc sv_utf8_upgrade_flags
2931 Converts the PV of an SV to its UTF-8-encoded form.
2932 Forces the SV to string form if it is not already.
2933 Always sets the SvUTF8 flag to avoid future validity checks even
2934 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2935 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2936 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2938 This is not as a general purpose byte encoding to Unicode interface:
2939 use the Encode extension for that.
2945 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2948 if (sv == &PL_sv_undef)
2952 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2953 (void) sv_2pv_flags(sv,&len, flags);
2957 (void) SvPV_force(sv,len);
2966 sv_force_normal_flags(sv, 0);
2969 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2970 sv_recode_to_utf8(sv, PL_encoding);
2971 else { /* Assume Latin-1/EBCDIC */
2972 /* This function could be much more efficient if we
2973 * had a FLAG in SVs to signal if there are any hibit
2974 * chars in the PV. Given that there isn't such a flag
2975 * make the loop as fast as possible. */
2976 const U8 * const s = (U8 *) SvPVX_const(sv);
2977 const U8 * const e = (U8 *) SvEND(sv);
2982 /* Check for hi bit */
2983 if (!NATIVE_IS_INVARIANT(ch)) {
2984 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2985 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2987 SvPV_free(sv); /* No longer using what was there before. */
2988 SvPV_set(sv, (char*)recoded);
2989 SvCUR_set(sv, len - 1);
2990 SvLEN_set(sv, len); /* No longer know the real size. */
2994 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3001 =for apidoc sv_utf8_downgrade
3003 Attempts to convert the PV of an SV from characters to bytes.
3004 If the PV contains a character beyond byte, this conversion will fail;
3005 in this case, either returns false or, if C<fail_ok> is not
3008 This is not as a general purpose Unicode to byte encoding interface:
3009 use the Encode extension for that.
3015 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3018 if (SvPOKp(sv) && SvUTF8(sv)) {
3024 sv_force_normal_flags(sv, 0);
3026 s = (U8 *) SvPV(sv, len);
3027 if (!utf8_to_bytes(s, &len)) {
3032 Perl_croak(aTHX_ "Wide character in %s",
3035 Perl_croak(aTHX_ "Wide character");
3046 =for apidoc sv_utf8_encode
3048 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3049 flag off so that it looks like octets again.
3055 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3058 sv_force_normal_flags(sv, 0);
3060 if (SvREADONLY(sv)) {
3061 Perl_croak(aTHX_ PL_no_modify);
3063 (void) sv_utf8_upgrade(sv);
3068 =for apidoc sv_utf8_decode
3070 If the PV of the SV is an octet sequence in UTF-8
3071 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3072 so that it looks like a character. If the PV contains only single-byte
3073 characters, the C<SvUTF8> flag stays being off.
3074 Scans PV for validity and returns false if the PV is invalid UTF-8.
3080 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3086 /* The octets may have got themselves encoded - get them back as
3089 if (!sv_utf8_downgrade(sv, TRUE))
3092 /* it is actually just a matter of turning the utf8 flag on, but
3093 * we want to make sure everything inside is valid utf8 first.
3095 c = (const U8 *) SvPVX_const(sv);
3096 if (!is_utf8_string(c, SvCUR(sv)+1))
3098 e = (const U8 *) SvEND(sv);
3101 if (!UTF8_IS_INVARIANT(ch)) {
3111 =for apidoc sv_setsv
3113 Copies the contents of the source SV C<ssv> into the destination SV
3114 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3115 function if the source SV needs to be reused. Does not handle 'set' magic.
3116 Loosely speaking, it performs a copy-by-value, obliterating any previous
3117 content of the destination.
3119 You probably want to use one of the assortment of wrappers, such as
3120 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3121 C<SvSetMagicSV_nosteal>.
3123 =for apidoc sv_setsv_flags
3125 Copies the contents of the source SV C<ssv> into the destination SV
3126 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3127 function if the source SV needs to be reused. Does not handle 'set' magic.
3128 Loosely speaking, it performs a copy-by-value, obliterating any previous
3129 content of the destination.
3130 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3131 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3132 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3133 and C<sv_setsv_nomg> are implemented in terms of this function.
3135 You probably want to use one of the assortment of wrappers, such as
3136 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3137 C<SvSetMagicSV_nosteal>.
3139 This is the primary function for copying scalars, and most other
3140 copy-ish functions and macros use this underneath.
3146 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3148 if (dtype != SVt_PVGV) {
3149 const char * const name = GvNAME(sstr);
3150 const STRLEN len = GvNAMELEN(sstr);
3152 if (dtype >= SVt_PV) {
3158 SvUPGRADE(dstr, SVt_PVGV);
3159 (void)SvOK_off(dstr);
3160 /* FIXME - why are we doing this, then turning it off and on again
3162 isGV_with_GP_on(dstr);
3164 GvSTASH(dstr) = GvSTASH(sstr);
3166 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3167 gv_name_set((GV *)dstr, name, len, GV_ADD);
3168 SvFAKE_on(dstr); /* can coerce to non-glob */
3171 #ifdef GV_UNIQUE_CHECK
3172 if (GvUNIQUE((GV*)dstr)) {
3173 Perl_croak(aTHX_ PL_no_modify);
3178 isGV_with_GP_off(dstr);
3179 (void)SvOK_off(dstr);
3180 isGV_with_GP_on(dstr);
3181 GvINTRO_off(dstr); /* one-shot flag */
3182 GvGP(dstr) = gp_ref(GvGP(sstr));
3183 if (SvTAINTED(sstr))
3185 if (GvIMPORTED(dstr) != GVf_IMPORTED
3186 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3188 GvIMPORTED_on(dstr);
3195 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3196 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3198 const int intro = GvINTRO(dstr);
3201 const U32 stype = SvTYPE(sref);
3204 #ifdef GV_UNIQUE_CHECK
3205 if (GvUNIQUE((GV*)dstr)) {
3206 Perl_croak(aTHX_ PL_no_modify);
3211 GvINTRO_off(dstr); /* one-shot flag */
3212 GvLINE(dstr) = CopLINE(PL_curcop);
3213 GvEGV(dstr) = (GV*)dstr;
3218 location = (SV **) &GvCV(dstr);
3219 import_flag = GVf_IMPORTED_CV;
3222 location = (SV **) &GvHV(dstr);
3223 import_flag = GVf_IMPORTED_HV;
3226 location = (SV **) &GvAV(dstr);
3227 import_flag = GVf_IMPORTED_AV;
3230 location = (SV **) &GvIOp(dstr);
3233 location = (SV **) &GvFORM(dstr);
3235 location = &GvSV(dstr);
3236 import_flag = GVf_IMPORTED_SV;
3239 if (stype == SVt_PVCV) {
3240 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3241 SvREFCNT_dec(GvCV(dstr));
3243 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3244 mro_method_changed_in(GvSTASH(dstr));
3247 SAVEGENERICSV(*location);
3251 if (stype == SVt_PVCV && *location != sref) {
3252 CV* const cv = (CV*)*location;
3254 if (!GvCVGEN((GV*)dstr) &&
3255 (CvROOT(cv) || CvXSUB(cv)))
3257 /* Redefining a sub - warning is mandatory if
3258 it was a const and its value changed. */
3259 if (CvCONST(cv) && CvCONST((CV*)sref)
3260 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3262 /* They are 2 constant subroutines generated from
3263 the same constant. This probably means that
3264 they are really the "same" proxy subroutine
3265 instantiated in 2 places. Most likely this is
3266 when a constant is exported twice. Don't warn.
3269 else if (ckWARN(WARN_REDEFINE)
3271 && (!CvCONST((CV*)sref)
3272 || sv_cmp(cv_const_sv(cv),
3273 cv_const_sv((CV*)sref))))) {
3274 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3277 ? "Constant subroutine %s::%s redefined"
3278 : "Subroutine %s::%s redefined"),
3279 HvNAME_get(GvSTASH((GV*)dstr)),
3280 GvENAME((GV*)dstr));
3284 cv_ckproto_len(cv, (GV*)dstr,
3285 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3286 SvPOK(sref) ? SvCUR(sref) : 0);
3288 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3289 GvASSUMECV_on(dstr);
3290 mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3293 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3294 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3295 GvFLAGS(dstr) |= import_flag;
3300 if (SvTAINTED(sstr))
3306 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3309 register U32 sflags;
3311 register svtype stype;
3316 if (SvIS_FREED(dstr)) {
3317 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3318 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3320 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3322 sstr = &PL_sv_undef;
3323 if (SvIS_FREED(sstr)) {
3324 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3325 (void*)sstr, (void*)dstr);
3327 stype = SvTYPE(sstr);
3328 dtype = SvTYPE(dstr);
3330 (void)SvAMAGIC_off(dstr);
3333 /* need to nuke the magic */
3335 SvRMAGICAL_off(dstr);
3338 /* There's a lot of redundancy below but we're going for speed here */
3343 if (dtype != SVt_PVGV) {
3344 (void)SvOK_off(dstr);
3352 sv_upgrade(dstr, SVt_IV);
3357 sv_upgrade(dstr, SVt_PVIV);
3360 goto end_of_first_switch;
3362 (void)SvIOK_only(dstr);
3363 SvIV_set(dstr, SvIVX(sstr));
3366 /* SvTAINTED can only be true if the SV has taint magic, which in
3367 turn means that the SV type is PVMG (or greater). This is the
3368 case statement for SVt_IV, so this cannot be true (whatever gcov
3370 assert(!SvTAINTED(sstr));
3380 sv_upgrade(dstr, SVt_NV);
3385 sv_upgrade(dstr, SVt_PVNV);
3388 goto end_of_first_switch;
3390 SvNV_set(dstr, SvNVX(sstr));
3391 (void)SvNOK_only(dstr);
3392 /* SvTAINTED can only be true if the SV has taint magic, which in
3393 turn means that the SV type is PVMG (or greater). This is the
3394 case statement for SVt_NV, so this cannot be true (whatever gcov
3396 assert(!SvTAINTED(sstr));
3403 sv_upgrade(dstr, SVt_RV);
3406 #ifdef PERL_OLD_COPY_ON_WRITE
3407 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3408 if (dtype < SVt_PVIV)
3409 sv_upgrade(dstr, SVt_PVIV);
3416 sv_upgrade(dstr, SVt_PV);
3419 if (dtype < SVt_PVIV)
3420 sv_upgrade(dstr, SVt_PVIV);
3423 if (dtype < SVt_PVNV)
3424 sv_upgrade(dstr, SVt_PVNV);
3428 const char * const type = sv_reftype(sstr,0);
3430 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3432 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3436 /* case SVt_BIND: */
3439 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3440 glob_assign_glob(dstr, sstr, dtype);
3443 /* SvVALID means that this PVGV is playing at being an FBM. */
3447 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3449 if (SvTYPE(sstr) != stype) {
3450 stype = SvTYPE(sstr);
3451 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3452 glob_assign_glob(dstr, sstr, dtype);
3457 if (stype == SVt_PVLV)
3458 SvUPGRADE(dstr, SVt_PVNV);
3460 SvUPGRADE(dstr, (svtype)stype);
3462 end_of_first_switch:
3464 /* dstr may have been upgraded. */
3465 dtype = SvTYPE(dstr);
3466 sflags = SvFLAGS(sstr);
3468 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3469 /* Assigning to a subroutine sets the prototype. */
3472 const char *const ptr = SvPV_const(sstr, len);
3474 SvGROW(dstr, len + 1);
3475 Copy(ptr, SvPVX(dstr), len + 1, char);
3476 SvCUR_set(dstr, len);
3478 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3482 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3483 const char * const type = sv_reftype(dstr,0);
3485 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3487 Perl_croak(aTHX_ "Cannot copy to %s", type);
3488 } else if (sflags & SVf_ROK) {
3489 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3490 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3493 if (GvIMPORTED(dstr) != GVf_IMPORTED
3494 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3496 GvIMPORTED_on(dstr);
3501 glob_assign_glob(dstr, sstr, dtype);
3505 if (dtype >= SVt_PV) {
3506 if (dtype == SVt_PVGV) {
3507 glob_assign_ref(dstr, sstr);
3510 if (SvPVX_const(dstr)) {
3516 (void)SvOK_off(dstr);
3517 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3518 SvFLAGS(dstr) |= sflags & SVf_ROK;
3519 assert(!(sflags & SVp_NOK));
3520 assert(!(sflags & SVp_IOK));
3521 assert(!(sflags & SVf_NOK));
3522 assert(!(sflags & SVf_IOK));
3524 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3525 if (!(sflags & SVf_OK)) {
3526 if (ckWARN(WARN_MISC))
3527 Perl_warner(aTHX_ packWARN(WARN_MISC),
3528 "Undefined value assigned to typeglob");
3531 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3532 if (dstr != (SV*)gv) {
3535 GvGP(dstr) = gp_ref(GvGP(gv));
3539 else if (sflags & SVp_POK) {
3543 * Check to see if we can just swipe the string. If so, it's a
3544 * possible small lose on short strings, but a big win on long ones.
3545 * It might even be a win on short strings if SvPVX_const(dstr)
3546 * has to be allocated and SvPVX_const(sstr) has to be freed.
3547 * Likewise if we can set up COW rather than doing an actual copy, we
3548 * drop to the else clause, as the swipe code and the COW setup code
3549 * have much in common.
3552 /* Whichever path we take through the next code, we want this true,
3553 and doing it now facilitates the COW check. */
3554 (void)SvPOK_only(dstr);
3557 /* If we're already COW then this clause is not true, and if COW
3558 is allowed then we drop down to the else and make dest COW
3559 with us. If caller hasn't said that we're allowed to COW
3560 shared hash keys then we don't do the COW setup, even if the
3561 source scalar is a shared hash key scalar. */
3562 (((flags & SV_COW_SHARED_HASH_KEYS)
3563 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3564 : 1 /* If making a COW copy is forbidden then the behaviour we
3565 desire is as if the source SV isn't actually already
3566 COW, even if it is. So we act as if the source flags
3567 are not COW, rather than actually testing them. */
3569 #ifndef PERL_OLD_COPY_ON_WRITE
3570 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3571 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3572 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3573 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3574 but in turn, it's somewhat dead code, never expected to go
3575 live, but more kept as a placeholder on how to do it better
3576 in a newer implementation. */
3577 /* If we are COW and dstr is a suitable target then we drop down
3578 into the else and make dest a COW of us. */
3579 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3584 (sflags & SVs_TEMP) && /* slated for free anyway? */
3585 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3586 (!(flags & SV_NOSTEAL)) &&
3587 /* and we're allowed to steal temps */
3588 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3589 SvLEN(sstr) && /* and really is a string */
3590 /* and won't be needed again, potentially */
3591 !(PL_op && PL_op->op_type == OP_AASSIGN))
3592 #ifdef PERL_OLD_COPY_ON_WRITE
3593 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3594 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3595 && SvTYPE(sstr) >= SVt_PVIV)
3598 /* Failed the swipe test, and it's not a shared hash key either.
3599 Have to copy the string. */
3600 STRLEN len = SvCUR(sstr);
3601 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3602 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3603 SvCUR_set(dstr, len);
3604 *SvEND(dstr) = '\0';
3606 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3608 /* Either it's a shared hash key, or it's suitable for
3609 copy-on-write or we can swipe the string. */
3611 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3615 #ifdef PERL_OLD_COPY_ON_WRITE
3617 /* I believe I should acquire a global SV mutex if
3618 it's a COW sv (not a shared hash key) to stop
3619 it going un copy-on-write.
3620 If the source SV has gone un copy on write between up there
3621 and down here, then (assert() that) it is of the correct
3622 form to make it copy on write again */
3623 if ((sflags & (SVf_FAKE | SVf_READONLY))
3624 != (SVf_FAKE | SVf_READONLY)) {
3625 SvREADONLY_on(sstr);
3627 /* Make the source SV into a loop of 1.
3628 (about to become 2) */
3629 SV_COW_NEXT_SV_SET(sstr, sstr);
3633 /* Initial code is common. */
3634 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3639 /* making another shared SV. */
3640 STRLEN cur = SvCUR(sstr);
3641 STRLEN len = SvLEN(sstr);
3642 #ifdef PERL_OLD_COPY_ON_WRITE
3644 assert (SvTYPE(dstr) >= SVt_PVIV);
3645 /* SvIsCOW_normal */
3646 /* splice us in between source and next-after-source. */
3647 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3648 SV_COW_NEXT_SV_SET(sstr, dstr);
3649 SvPV_set(dstr, SvPVX_mutable(sstr));
3653 /* SvIsCOW_shared_hash */
3654 DEBUG_C(PerlIO_printf(Perl_debug_log,
3655 "Copy on write: Sharing hash\n"));
3657 assert (SvTYPE(dstr) >= SVt_PV);
3659 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3661 SvLEN_set(dstr, len);
3662 SvCUR_set(dstr, cur);
3663 SvREADONLY_on(dstr);
3665 /* Relesase a global SV mutex. */
3668 { /* Passes the swipe test. */
3669 SvPV_set(dstr, SvPVX_mutable(sstr));
3670 SvLEN_set(dstr, SvLEN(sstr));
3671 SvCUR_set(dstr, SvCUR(sstr));
3674 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3675 SvPV_set(sstr, NULL);
3681 if (sflags & SVp_NOK) {
3682 SvNV_set(dstr, SvNVX(sstr));
3684 if (sflags & SVp_IOK) {
3686 SvIV_set(dstr, SvIVX(sstr));
3687 /* Must do this otherwise some other overloaded use of 0x80000000
3688 gets confused. I guess SVpbm_VALID */
3689 if (sflags & SVf_IVisUV)
3692 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3694 const MAGIC * const smg = SvVSTRING_mg(sstr);
3696 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3697 smg->mg_ptr, smg->mg_len);
3698 SvRMAGICAL_on(dstr);
3702 else if (sflags & (SVp_IOK|SVp_NOK)) {
3703 (void)SvOK_off(dstr);
3704 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3705 if (sflags & SVp_IOK) {
3706 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3707 SvIV_set(dstr, SvIVX(sstr));
3709 if (sflags & SVp_NOK) {
3710 SvNV_set(dstr, SvNVX(sstr));
3714 if (isGV_with_GP(sstr)) {
3715 /* This stringification rule for globs is spread in 3 places.
3716 This feels bad. FIXME. */
3717 const U32 wasfake = sflags & SVf_FAKE;
3719 /* FAKE globs can get coerced, so need to turn this off
3720 temporarily if it is on. */
3722 gv_efullname3(dstr, (GV *)sstr, "*");
3723 SvFLAGS(sstr) |= wasfake;
3726 (void)SvOK_off(dstr);
3728 if (SvTAINTED(sstr))
3733 =for apidoc sv_setsv_mg
3735 Like C<sv_setsv>, but also handles 'set' magic.
3741 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3743 sv_setsv(dstr,sstr);
3747 #ifdef PERL_OLD_COPY_ON_WRITE
3749 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3751 STRLEN cur = SvCUR(sstr);
3752 STRLEN len = SvLEN(sstr);
3753 register char *new_pv;
3756 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3757 (void*)sstr, (void*)dstr);
3764 if (SvTHINKFIRST(dstr))
3765 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3766 else if (SvPVX_const(dstr))
3767 Safefree(SvPVX_const(dstr));
3771 SvUPGRADE(dstr, SVt_PVIV);
3773 assert (SvPOK(sstr));
3774 assert (SvPOKp(sstr));
3775 assert (!SvIOK(sstr));
3776 assert (!SvIOKp(sstr));
3777 assert (!SvNOK(sstr));
3778 assert (!SvNOKp(sstr));
3780 if (SvIsCOW(sstr)) {
3782 if (SvLEN(sstr) == 0) {
3783 /* source is a COW shared hash key. */
3784 DEBUG_C(PerlIO_printf(Perl_debug_log,
3785 "Fast copy on write: Sharing hash\n"));
3786 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3789 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3791 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3792 SvUPGRADE(sstr, SVt_PVIV);
3793 SvREADONLY_on(sstr);
3795 DEBUG_C(PerlIO_printf(Perl_debug_log,
3796 "Fast copy on write: Converting sstr to COW\n"));
3797 SV_COW_NEXT_SV_SET(dstr, sstr);
3799 SV_COW_NEXT_SV_SET(sstr, dstr);
3800 new_pv = SvPVX_mutable(sstr);
3803 SvPV_set(dstr, new_pv);
3804 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3807 SvLEN_set(dstr, len);
3808 SvCUR_set(dstr, cur);
3817 =for apidoc sv_setpvn
3819 Copies a string into an SV. The C<len> parameter indicates the number of
3820 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3821 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3827 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3830 register char *dptr;
3832 SV_CHECK_THINKFIRST_COW_DROP(sv);
3838 /* len is STRLEN which is unsigned, need to copy to signed */
3841 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3843 SvUPGRADE(sv, SVt_PV);
3845 dptr = SvGROW(sv, len + 1);
3846 Move(ptr,dptr,len,char);
3849 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3854 =for apidoc sv_setpvn_mg
3856 Like C<sv_setpvn>, but also handles 'set' magic.
3862 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3864 sv_setpvn(sv,ptr,len);
3869 =for apidoc sv_setpv
3871 Copies a string into an SV. The string must be null-terminated. Does not
3872 handle 'set' magic. See C<sv_setpv_mg>.
3878 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3881 register STRLEN len;
3883 SV_CHECK_THINKFIRST_COW_DROP(sv);
3889 SvUPGRADE(sv, SVt_PV);
3891 SvGROW(sv, len + 1);
3892 Move(ptr,SvPVX(sv),len+1,char);
3894 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3899 =for apidoc sv_setpv_mg
3901 Like C<sv_setpv>, but also handles 'set' magic.
3907 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3914 =for apidoc sv_usepvn_flags
3916 Tells an SV to use C<ptr> to find its string value. Normally the
3917 string is stored inside the SV but sv_usepvn allows the SV to use an
3918 outside string. The C<ptr> should point to memory that was allocated
3919 by C<malloc>. The string length, C<len>, must be supplied. By default
3920 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3921 so that pointer should not be freed or used by the programmer after
3922 giving it to sv_usepvn, and neither should any pointers from "behind"
3923 that pointer (e.g. ptr + 1) be used.
3925 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3926 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3927 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3928 C<len>, and already meets the requirements for storing in C<SvPVX>)
3934 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3938 SV_CHECK_THINKFIRST_COW_DROP(sv);
3939 SvUPGRADE(sv, SVt_PV);
3942 if (flags & SV_SMAGIC)
3946 if (SvPVX_const(sv))
3950 if (flags & SV_HAS_TRAILING_NUL)
3951 assert(ptr[len] == '\0');
3954 allocate = (flags & SV_HAS_TRAILING_NUL)
3955 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3956 if (flags & SV_HAS_TRAILING_NUL) {
3957 /* It's long enough - do nothing.
3958 Specfically Perl_newCONSTSUB is relying on this. */
3961 /* Force a move to shake out bugs in callers. */
3962 char *new_ptr = (char*)safemalloc(allocate);
3963 Copy(ptr, new_ptr, len, char);
3964 PoisonFree(ptr,len,char);
3968 ptr = (char*) saferealloc (ptr, allocate);
3973 SvLEN_set(sv, allocate);
3974 if (!(flags & SV_HAS_TRAILING_NUL)) {
3977 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3979 if (flags & SV_SMAGIC)
3983 #ifdef PERL_OLD_COPY_ON_WRITE
3984 /* Need to do this *after* making the SV normal, as we need the buffer
3985 pointer to remain valid until after we've copied it. If we let go too early,
3986 another thread could invalidate it by unsharing last of the same hash key
3987 (which it can do by means other than releasing copy-on-write Svs)
3988 or by changing the other copy-on-write SVs in the loop. */
3990 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
3992 { /* this SV was SvIsCOW_normal(sv) */
3993 /* we need to find the SV pointing to us. */
3994 SV *current = SV_COW_NEXT_SV(after);
3996 if (current == sv) {
3997 /* The SV we point to points back to us (there were only two of us
3999 Hence other SV is no longer copy on write either. */
4001 SvREADONLY_off(after);
4003 /* We need to follow the pointers around the loop. */
4005 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4008 /* don't loop forever if the structure is bust, and we have
4009 a pointer into a closed loop. */
4010 assert (current != after);
4011 assert (SvPVX_const(current) == pvx);
4013 /* Make the SV before us point to the SV after us. */
4014 SV_COW_NEXT_SV_SET(current, after);
4020 =for apidoc sv_force_normal_flags
4022 Undo various types of fakery on an SV: if the PV is a shared string, make
4023 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4024 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4025 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4026 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4027 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4028 set to some other value.) In addition, the C<flags> parameter gets passed to
4029 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4030 with flags set to 0.
4036 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4039 #ifdef PERL_OLD_COPY_ON_WRITE
4040 if (SvREADONLY(sv)) {
4041 /* At this point I believe I should acquire a global SV mutex. */
4043 const char * const pvx = SvPVX_const(sv);
4044 const STRLEN len = SvLEN(sv);
4045 const STRLEN cur = SvCUR(sv);
4046 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4047 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4048 we'll fail an assertion. */
4049 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4052 PerlIO_printf(Perl_debug_log,
4053 "Copy on write: Force normal %ld\n",
4059 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4062 if (flags & SV_COW_DROP_PV) {
4063 /* OK, so we don't need to copy our buffer. */
4066 SvGROW(sv, cur + 1);
4067 Move(pvx,SvPVX(sv),cur,char);
4072 sv_release_COW(sv, pvx, next);
4074 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4080 else if (IN_PERL_RUNTIME)
4081 Perl_croak(aTHX_ PL_no_modify);
4082 /* At this point I believe that I can drop the global SV mutex. */
4085 if (SvREADONLY(sv)) {
4087 const char * const pvx = SvPVX_const(sv);
4088 const STRLEN len = SvCUR(sv);
4093 SvGROW(sv, len + 1);
4094 Move(pvx,SvPVX(sv),len,char);
4096 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4098 else if (IN_PERL_RUNTIME)
4099 Perl_croak(aTHX_ PL_no_modify);
4103 sv_unref_flags(sv, flags);
4104 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4111 Efficient removal of characters from the beginning of the string buffer.
4112 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4113 the string buffer. The C<ptr> becomes the first character of the adjusted
4114 string. Uses the "OOK hack".
4115 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4116 refer to the same chunk of data.
4122 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4124 register STRLEN delta;
4125 if (!ptr || !SvPOKp(sv))
4127 delta = ptr - SvPVX_const(sv);
4128 SV_CHECK_THINKFIRST(sv);
4129 if (SvTYPE(sv) < SVt_PVIV)
4130 sv_upgrade(sv,SVt_PVIV);
4133 if (!SvLEN(sv)) { /* make copy of shared string */
4134 const char *pvx = SvPVX_const(sv);
4135 const STRLEN len = SvCUR(sv);
4136 SvGROW(sv, len + 1);
4137 Move(pvx,SvPVX(sv),len,char);
4141 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4142 and we do that anyway inside the SvNIOK_off
4144 SvFLAGS(sv) |= SVf_OOK;
4147 SvLEN_set(sv, SvLEN(sv) - delta);
4148 SvCUR_set(sv, SvCUR(sv) - delta);
4149 SvPV_set(sv, SvPVX(sv) + delta);
4150 SvIV_set(sv, SvIVX(sv) + delta);
4154 =for apidoc sv_catpvn
4156 Concatenates the string onto the end of the string which is in the SV. The
4157 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4158 status set, then the bytes appended should be valid UTF-8.
4159 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4161 =for apidoc sv_catpvn_flags
4163 Concatenates the string onto the end of the string which is in the SV. The
4164 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4165 status set, then the bytes appended should be valid UTF-8.
4166 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4167 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4168 in terms of this function.
4174 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4178 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4180 SvGROW(dsv, dlen + slen + 1);
4182 sstr = SvPVX_const(dsv);
4183 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4184 SvCUR_set(dsv, SvCUR(dsv) + slen);
4186 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4188 if (flags & SV_SMAGIC)
4193 =for apidoc sv_catsv
4195 Concatenates the string from SV C<ssv> onto the end of the string in
4196 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4197 not 'set' magic. See C<sv_catsv_mg>.
4199 =for apidoc sv_catsv_flags
4201 Concatenates the string from SV C<ssv> onto the end of the string in
4202 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4203 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4204 and C<sv_catsv_nomg> are implemented in terms of this function.
4209 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4214 const char *spv = SvPV_const(ssv, slen);
4216 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4217 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4218 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4219 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4220 dsv->sv_flags doesn't have that bit set.
4221 Andy Dougherty 12 Oct 2001
4223 const I32 sutf8 = DO_UTF8(ssv);
4226 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4228 dutf8 = DO_UTF8(dsv);
4230 if (dutf8 != sutf8) {
4232 /* Not modifying source SV, so taking a temporary copy. */
4233 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4235 sv_utf8_upgrade(csv);
4236 spv = SvPV_const(csv, slen);
4239 sv_utf8_upgrade_nomg(dsv);
4241 sv_catpvn_nomg(dsv, spv, slen);
4244 if (flags & SV_SMAGIC)
4249 =for apidoc sv_catpv
4251 Concatenates the string onto the end of the string which is in the SV.
4252 If the SV has the UTF-8 status set, then the bytes appended should be
4253 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4258 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4261 register STRLEN len;
4267 junk = SvPV_force(sv, tlen);
4269 SvGROW(sv, tlen + len + 1);
4271 ptr = SvPVX_const(sv);
4272 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4273 SvCUR_set(sv, SvCUR(sv) + len);
4274 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4279 =for apidoc sv_catpv_mg
4281 Like C<sv_catpv>, but also handles 'set' magic.
4287 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4296 Creates a new SV. A non-zero C<len> parameter indicates the number of
4297 bytes of preallocated string space the SV should have. An extra byte for a
4298 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4299 space is allocated.) The reference count for the new SV is set to 1.
4301 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4302 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4303 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4304 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4305 modules supporting older perls.
4311 Perl_newSV(pTHX_ STRLEN len)
4318 sv_upgrade(sv, SVt_PV);
4319 SvGROW(sv, len + 1);
4324 =for apidoc sv_magicext
4326 Adds magic to an SV, upgrading it if necessary. Applies the
4327 supplied vtable and returns a pointer to the magic added.
4329 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4330 In particular, you can add magic to SvREADONLY SVs, and add more than
4331 one instance of the same 'how'.
4333 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4334 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4335 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4336 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4338 (This is now used as a subroutine by C<sv_magic>.)
4343 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4344 const char* name, I32 namlen)
4349 SvUPGRADE(sv, SVt_PVMG);
4350 Newxz(mg, 1, MAGIC);
4351 mg->mg_moremagic = SvMAGIC(sv);
4352 SvMAGIC_set(sv, mg);
4354 /* Sometimes a magic contains a reference loop, where the sv and
4355 object refer to each other. To prevent a reference loop that
4356 would prevent such objects being freed, we look for such loops
4357 and if we find one we avoid incrementing the object refcount.
4359 Note we cannot do this to avoid self-tie loops as intervening RV must
4360 have its REFCNT incremented to keep it in existence.
4363 if (!obj || obj == sv ||
4364 how == PERL_MAGIC_arylen ||
4365 how == PERL_MAGIC_qr ||
4366 how == PERL_MAGIC_symtab ||
4367 (SvTYPE(obj) == SVt_PVGV &&
4368 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4369 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4370 GvFORM(obj) == (CV*)sv)))
4375 mg->mg_obj = SvREFCNT_inc_simple(obj);
4376 mg->mg_flags |= MGf_REFCOUNTED;
4379 /* Normal self-ties simply pass a null object, and instead of
4380 using mg_obj directly, use the SvTIED_obj macro to produce a
4381 new RV as needed. For glob "self-ties", we are tieing the PVIO
4382 with an RV obj pointing to the glob containing the PVIO. In
4383 this case, to avoid a reference loop, we need to weaken the
4387 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4388 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4394 mg->mg_len = namlen;
4397 mg->mg_ptr = savepvn(name, namlen);
4398 else if (namlen == HEf_SVKEY)
4399 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4401 mg->mg_ptr = (char *) name;
4403 mg->mg_virtual = (MGVTBL *) vtable;
4407 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4412 =for apidoc sv_magic
4414 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4415 then adds a new magic item of type C<how> to the head of the magic list.
4417 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4418 handling of the C<name> and C<namlen> arguments.
4420 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4421 to add more than one instance of the same 'how'.
4427 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4430 const MGVTBL *vtable;
4433 #ifdef PERL_OLD_COPY_ON_WRITE
4435 sv_force_normal_flags(sv, 0);
4437 if (SvREADONLY(sv)) {
4439 /* its okay to attach magic to shared strings; the subsequent
4440 * upgrade to PVMG will unshare the string */
4441 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4444 && how != PERL_MAGIC_regex_global
4445 && how != PERL_MAGIC_bm
4446 && how != PERL_MAGIC_fm
4447 && how != PERL_MAGIC_sv
4448 && how != PERL_MAGIC_backref
4451 Perl_croak(aTHX_ PL_no_modify);
4454 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4455 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4456 /* sv_magic() refuses to add a magic of the same 'how' as an
4459 if (how == PERL_MAGIC_taint) {
4461 /* Any scalar which already had taint magic on which someone
4462 (erroneously?) did SvIOK_on() or similar will now be
4463 incorrectly sporting public "OK" flags. */
4464 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4472 vtable = &PL_vtbl_sv;
4474 case PERL_MAGIC_overload:
4475 vtable = &PL_vtbl_amagic;
4477 case PERL_MAGIC_overload_elem:
4478 vtable = &PL_vtbl_amagicelem;
4480 case PERL_MAGIC_overload_table:
4481 vtable = &PL_vtbl_ovrld;
4484 vtable = &PL_vtbl_bm;
4486 case PERL_MAGIC_regdata:
4487 vtable = &PL_vtbl_regdata;
4489 case PERL_MAGIC_regdatum:
4490 vtable = &PL_vtbl_regdatum;
4492 case PERL_MAGIC_env:
4493 vtable = &PL_vtbl_env;
4496 vtable = &PL_vtbl_fm;
4498 case PERL_MAGIC_envelem:
4499 vtable = &PL_vtbl_envelem;
4501 case PERL_MAGIC_regex_global:
4502 vtable = &PL_vtbl_mglob;
4504 case PERL_MAGIC_isa:
4505 vtable = &PL_vtbl_isa;
4507 case PERL_MAGIC_isaelem:
4508 vtable = &PL_vtbl_isaelem;
4510 case PERL_MAGIC_nkeys:
4511 vtable = &PL_vtbl_nkeys;
4513 case PERL_MAGIC_dbfile:
4516 case PERL_MAGIC_dbline:
4517 vtable = &PL_vtbl_dbline;
4519 #ifdef USE_LOCALE_COLLATE
4520 case PERL_MAGIC_collxfrm:
4521 vtable = &PL_vtbl_collxfrm;
4523 #endif /* USE_LOCALE_COLLATE */
4524 case PERL_MAGIC_tied:
4525 vtable = &PL_vtbl_pack;
4527 case PERL_MAGIC_tiedelem:
4528 case PERL_MAGIC_tiedscalar:
4529 vtable = &PL_vtbl_packelem;
4532 vtable = &PL_vtbl_regexp;
4534 case PERL_MAGIC_hints:
4535 /* As this vtable is all NULL, we can reuse it. */
4536 case PERL_MAGIC_sig:
4537 vtable = &PL_vtbl_sig;
4539 case PERL_MAGIC_sigelem:
4540 vtable = &PL_vtbl_sigelem;
4542 case PERL_MAGIC_taint:
4543 vtable = &PL_vtbl_taint;
4545 case PERL_MAGIC_uvar:
4546 vtable = &PL_vtbl_uvar;
4548 case PERL_MAGIC_vec:
4549 vtable = &PL_vtbl_vec;
4551 case PERL_MAGIC_arylen_p:
4552 case PERL_MAGIC_rhash:
4553 case PERL_MAGIC_symtab:
4554 case PERL_MAGIC_vstring:
4557 case PERL_MAGIC_utf8:
4558 vtable = &PL_vtbl_utf8;
4560 case PERL_MAGIC_substr:
4561 vtable = &PL_vtbl_substr;
4563 case PERL_MAGIC_defelem:
4564 vtable = &PL_vtbl_defelem;
4566 case PERL_MAGIC_arylen:
4567 vtable = &PL_vtbl_arylen;
4569 case PERL_MAGIC_pos:
4570 vtable = &PL_vtbl_pos;
4572 case PERL_MAGIC_backref:
4573 vtable = &PL_vtbl_backref;
4575 case PERL_MAGIC_hintselem:
4576 vtable = &PL_vtbl_hintselem;
4578 case PERL_MAGIC_ext:
4579 /* Reserved for use by extensions not perl internals. */
4580 /* Useful for attaching extension internal data to perl vars. */
4581 /* Note that multiple extensions may clash if magical scalars */
4582 /* etc holding private data from one are passed to another. */
4586 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4589 /* Rest of work is done else where */
4590 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4593 case PERL_MAGIC_taint:
4596 case PERL_MAGIC_ext:
4597 case PERL_MAGIC_dbfile:
4604 =for apidoc sv_unmagic
4606 Removes all magic of type C<type> from an SV.
4612 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4616 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4618 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4619 for (mg = *mgp; mg; mg = *mgp) {
4620 if (mg->mg_type == type) {
4621 const MGVTBL* const vtbl = mg->mg_virtual;
4622 *mgp = mg->mg_moremagic;
4623 if (vtbl && vtbl->svt_free)
4624 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4625 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4627 Safefree(mg->mg_ptr);
4628 else if (mg->mg_len == HEf_SVKEY)
4629 SvREFCNT_dec((SV*)mg->mg_ptr);
4630 else if (mg->mg_type == PERL_MAGIC_utf8)
4631 Safefree(mg->mg_ptr);
4633 if (mg->mg_flags & MGf_REFCOUNTED)
4634 SvREFCNT_dec(mg->mg_obj);
4638 mgp = &mg->mg_moremagic;
4642 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4643 SvMAGIC_set(sv, NULL);
4650 =for apidoc sv_rvweaken
4652 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4653 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4654 push a back-reference to this RV onto the array of backreferences
4655 associated with that magic. If the RV is magical, set magic will be
4656 called after the RV is cleared.
4662 Perl_sv_rvweaken(pTHX_ SV *sv)
4665 if (!SvOK(sv)) /* let undefs pass */
4668 Perl_croak(aTHX_ "Can't weaken a nonreference");
4669 else if (SvWEAKREF(sv)) {
4670 if (ckWARN(WARN_MISC))
4671 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4675 Perl_sv_add_backref(aTHX_ tsv, sv);
4681 /* Give tsv backref magic if it hasn't already got it, then push a
4682 * back-reference to sv onto the array associated with the backref magic.
4686 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4691 if (SvTYPE(tsv) == SVt_PVHV) {
4692 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4696 /* There is no AV in the offical place - try a fixup. */
4697 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4700 /* Aha. They've got it stowed in magic. Bring it back. */
4701 av = (AV*)mg->mg_obj;
4702 /* Stop mg_free decreasing the refernce count. */
4704 /* Stop mg_free even calling the destructor, given that
4705 there's no AV to free up. */
4707 sv_unmagic(tsv, PERL_MAGIC_backref);
4711 SvREFCNT_inc_simple_void(av);
4716 const MAGIC *const mg
4717 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4719 av = (AV*)mg->mg_obj;
4723 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4724 /* av now has a refcnt of 2, which avoids it getting freed
4725 * before us during global cleanup. The extra ref is removed
4726 * by magic_killbackrefs() when tsv is being freed */
4729 if (AvFILLp(av) >= AvMAX(av)) {
4730 av_extend(av, AvFILLp(av)+1);
4732 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4735 /* delete a back-reference to ourselves from the backref magic associated
4736 * with the SV we point to.
4740 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4747 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4748 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4749 /* We mustn't attempt to "fix up" the hash here by moving the
4750 backreference array back to the hv_aux structure, as that is stored
4751 in the main HvARRAY(), and hfreentries assumes that no-one
4752 reallocates HvARRAY() while it is running. */
4755 const MAGIC *const mg
4756 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4758 av = (AV *)mg->mg_obj;
4761 if (PL_in_clean_all)
4763 Perl_croak(aTHX_ "panic: del_backref");
4770 /* We shouldn't be in here more than once, but for paranoia reasons lets
4772 for (i = AvFILLp(av); i >= 0; i--) {
4774 const SSize_t fill = AvFILLp(av);
4776 /* We weren't the last entry.
4777 An unordered list has this property that you can take the
4778 last element off the end to fill the hole, and it's still
4779 an unordered list :-)
4784 AvFILLp(av) = fill - 1;
4790 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4792 SV **svp = AvARRAY(av);
4794 PERL_UNUSED_ARG(sv);
4796 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4797 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4798 if (svp && !SvIS_FREED(av)) {
4799 SV *const *const last = svp + AvFILLp(av);
4801 while (svp <= last) {
4803 SV *const referrer = *svp;
4804 if (SvWEAKREF(referrer)) {
4805 /* XXX Should we check that it hasn't changed? */
4806 SvRV_set(referrer, 0);
4808 SvWEAKREF_off(referrer);
4809 SvSETMAGIC(referrer);
4810 } else if (SvTYPE(referrer) == SVt_PVGV ||
4811 SvTYPE(referrer) == SVt_PVLV) {
4812 /* You lookin' at me? */
4813 assert(GvSTASH(referrer));
4814 assert(GvSTASH(referrer) == (HV*)sv);
4815 GvSTASH(referrer) = 0;
4818 "panic: magic_killbackrefs (flags=%"UVxf")",
4819 (UV)SvFLAGS(referrer));
4827 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4832 =for apidoc sv_insert
4834 Inserts a string at the specified offset/length within the SV. Similar to
4835 the Perl substr() function.
4841 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4846 register char *midend;
4847 register char *bigend;
4853 Perl_croak(aTHX_ "Can't modify non-existent substring");
4854 SvPV_force(bigstr, curlen);
4855 (void)SvPOK_only_UTF8(bigstr);
4856 if (offset + len > curlen) {
4857 SvGROW(bigstr, offset+len+1);
4858 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4859 SvCUR_set(bigstr, offset+len);
4863 i = littlelen - len;
4864 if (i > 0) { /* string might grow */
4865 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4866 mid = big + offset + len;
4867 midend = bigend = big + SvCUR(bigstr);
4870 while (midend > mid) /* shove everything down */
4871 *--bigend = *--midend;
4872 Move(little,big+offset,littlelen,char);
4873 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4878 Move(little,SvPVX(bigstr)+offset,len,char);
4883 big = SvPVX(bigstr);
4886 bigend = big + SvCUR(bigstr);
4888 if (midend > bigend)
4889 Perl_croak(aTHX_ "panic: sv_insert");
4891 if (mid - big > bigend - midend) { /* faster to shorten from end */
4893 Move(little, mid, littlelen,char);
4896 i = bigend - midend;
4898 Move(midend, mid, i,char);
4902 SvCUR_set(bigstr, mid - big);
4904 else if ((i = mid - big)) { /* faster from front */
4905 midend -= littlelen;
4907 sv_chop(bigstr,midend-i);
4912 Move(little, mid, littlelen,char);
4914 else if (littlelen) {
4915 midend -= littlelen;
4916 sv_chop(bigstr,midend);
4917 Move(little,midend,littlelen,char);
4920 sv_chop(bigstr,midend);
4926 =for apidoc sv_replace
4928 Make the first argument a copy of the second, then delete the original.
4929 The target SV physically takes over ownership of the body of the source SV
4930 and inherits its flags; however, the target keeps any magic it owns,
4931 and any magic in the source is discarded.
4932 Note that this is a rather specialist SV copying operation; most of the
4933 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4939 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4942 const U32 refcnt = SvREFCNT(sv);
4943 SV_CHECK_THINKFIRST_COW_DROP(sv);
4944 if (SvREFCNT(nsv) != 1) {
4945 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4946 UVuf " != 1)", (UV) SvREFCNT(nsv));
4948 if (SvMAGICAL(sv)) {
4952 sv_upgrade(nsv, SVt_PVMG);
4953 SvMAGIC_set(nsv, SvMAGIC(sv));
4954 SvFLAGS(nsv) |= SvMAGICAL(sv);
4956 SvMAGIC_set(sv, NULL);
4960 assert(!SvREFCNT(sv));
4961 #ifdef DEBUG_LEAKING_SCALARS
4962 sv->sv_flags = nsv->sv_flags;
4963 sv->sv_any = nsv->sv_any;
4964 sv->sv_refcnt = nsv->sv_refcnt;
4965 sv->sv_u = nsv->sv_u;
4967 StructCopy(nsv,sv,SV);
4969 /* Currently could join these into one piece of pointer arithmetic, but
4970 it would be unclear. */
4971 if(SvTYPE(sv) == SVt_IV)
4973 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4974 else if (SvTYPE(sv) == SVt_RV) {
4975 SvANY(sv) = &sv->sv_u.svu_rv;
4979 #ifdef PERL_OLD_COPY_ON_WRITE
4980 if (SvIsCOW_normal(nsv)) {
4981 /* We need to follow the pointers around the loop to make the
4982 previous SV point to sv, rather than nsv. */
4985 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4988 assert(SvPVX_const(current) == SvPVX_const(nsv));
4990 /* Make the SV before us point to the SV after us. */
4992 PerlIO_printf(Perl_debug_log, "previous is\n");
4994 PerlIO_printf(Perl_debug_log,
4995 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4996 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4998 SV_COW_NEXT_SV_SET(current, sv);
5001 SvREFCNT(sv) = refcnt;
5002 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5008 =for apidoc sv_clear
5010 Clear an SV: call any destructors, free up any memory used by the body,
5011 and free the body itself. The SV's head is I<not> freed, although
5012 its type is set to all 1's so that it won't inadvertently be assumed
5013 to be live during global destruction etc.
5014 This function should only be called when REFCNT is zero. Most of the time
5015 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5022 Perl_sv_clear(pTHX_ register SV *sv)
5025 const U32 type = SvTYPE(sv);
5026 const struct body_details *const sv_type_details
5027 = bodies_by_type + type;
5030 assert(SvREFCNT(sv) == 0);
5032 if (type <= SVt_IV) {
5033 /* See the comment in sv.h about the collusion between this early
5034 return and the overloading of the NULL and IV slots in the size
5040 if (PL_defstash) { /* Still have a symbol table? */
5045 stash = SvSTASH(sv);
5046 destructor = StashHANDLER(stash,DESTROY);
5048 SV* const tmpref = newRV(sv);
5049 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5051 PUSHSTACKi(PERLSI_DESTROY);
5056 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5062 if(SvREFCNT(tmpref) < 2) {
5063 /* tmpref is not kept alive! */
5065 SvRV_set(tmpref, NULL);
5068 SvREFCNT_dec(tmpref);
5070 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5074 if (PL_in_clean_objs)
5075 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5077 /* DESTROY gave object new lease on life */
5083 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5084 SvOBJECT_off(sv); /* Curse the object. */
5085 if (type != SVt_PVIO)
5086 --PL_sv_objcount; /* XXX Might want something more general */
5089 if (type >= SVt_PVMG) {
5090 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5091 SvREFCNT_dec(SvOURSTASH(sv));
5092 } else if (SvMAGIC(sv))
5094 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5095 SvREFCNT_dec(SvSTASH(sv));
5098 /* case SVt_BIND: */
5101 IoIFP(sv) != PerlIO_stdin() &&
5102 IoIFP(sv) != PerlIO_stdout() &&
5103 IoIFP(sv) != PerlIO_stderr())
5105 io_close((IO*)sv, FALSE);
5107 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5108 PerlDir_close(IoDIRP(sv));
5109 IoDIRP(sv) = (DIR*)NULL;
5110 Safefree(IoTOP_NAME(sv));
5111 Safefree(IoFMT_NAME(sv));
5112 Safefree(IoBOTTOM_NAME(sv));
5119 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5123 if (PL_comppad == (AV*)sv) {
5130 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5131 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5132 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5133 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5135 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5136 SvREFCNT_dec(LvTARG(sv));
5138 if (isGV_with_GP(sv)) {
5141 unshare_hek(GvNAME_HEK(sv));
5142 /* If we're in a stash, we don't own a reference to it. However it does
5143 have a back reference to us, which needs to be cleared. */
5144 if (!SvVALID(sv) && GvSTASH(sv))
5145 sv_del_backref((SV*)GvSTASH(sv), sv);
5147 /* FIXME. There are probably more unreferenced pointers to SVs in the
5148 interpreter struct that we should check and tidy in a similar
5150 if ((GV*)sv == PL_last_in_gv)
5151 PL_last_in_gv = NULL;
5156 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5158 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5159 /* Don't even bother with turning off the OOK flag. */
5164 SV * const target = SvRV(sv);
5166 sv_del_backref(target, sv);
5168 SvREFCNT_dec(target);
5170 #ifdef PERL_OLD_COPY_ON_WRITE
5171 else if (SvPVX_const(sv)) {
5173 /* I believe I need to grab the global SV mutex here and
5174 then recheck the COW status. */
5176 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5180 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5182 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5185 /* And drop it here. */
5187 } else if (SvLEN(sv)) {
5188 Safefree(SvPVX_const(sv));
5192 else if (SvPVX_const(sv) && SvLEN(sv))
5193 Safefree(SvPVX_mutable(sv));
5194 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5195 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5204 SvFLAGS(sv) &= SVf_BREAK;
5205 SvFLAGS(sv) |= SVTYPEMASK;
5207 if (sv_type_details->arena) {
5208 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5209 &PL_body_roots[type]);
5211 else if (sv_type_details->body_size) {
5212 my_safefree(SvANY(sv));
5217 =for apidoc sv_newref
5219 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5226 Perl_sv_newref(pTHX_ SV *sv)
5228 PERL_UNUSED_CONTEXT;
5237 Decrement an SV's reference count, and if it drops to zero, call
5238 C<sv_clear> to invoke destructors and free up any memory used by
5239 the body; finally, deallocate the SV's head itself.
5240 Normally called via a wrapper macro C<SvREFCNT_dec>.
5246 Perl_sv_free(pTHX_ SV *sv)
5251 if (SvREFCNT(sv) == 0) {
5252 if (SvFLAGS(sv) & SVf_BREAK)
5253 /* this SV's refcnt has been artificially decremented to
5254 * trigger cleanup */
5256 if (PL_in_clean_all) /* All is fair */
5258 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5259 /* make sure SvREFCNT(sv)==0 happens very seldom */
5260 SvREFCNT(sv) = (~(U32)0)/2;
5263 if (ckWARN_d(WARN_INTERNAL)) {
5264 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5265 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5266 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5267 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5268 Perl_dump_sv_child(aTHX_ sv);
5270 #ifdef DEBUG_LEAKING_SCALARS
5277 if (--(SvREFCNT(sv)) > 0)
5279 Perl_sv_free2(aTHX_ sv);
5283 Perl_sv_free2(pTHX_ SV *sv)
5288 if (ckWARN_d(WARN_DEBUGGING))
5289 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5290 "Attempt to free temp prematurely: SV 0x%"UVxf
5291 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5295 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5296 /* make sure SvREFCNT(sv)==0 happens very seldom */
5297 SvREFCNT(sv) = (~(U32)0)/2;
5308 Returns the length of the string in the SV. Handles magic and type
5309 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5315 Perl_sv_len(pTHX_ register SV *sv)
5323 len = mg_length(sv);
5325 (void)SvPV_const(sv, len);
5330 =for apidoc sv_len_utf8
5332 Returns the number of characters in the string in an SV, counting wide
5333 UTF-8 bytes as a single character. Handles magic and type coercion.
5339 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5340 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5341 * (Note that the mg_len is not the length of the mg_ptr field.
5342 * This allows the cache to store the character length of the string without
5343 * needing to malloc() extra storage to attach to the mg_ptr.)
5348 Perl_sv_len_utf8(pTHX_ register SV *sv)
5354 return mg_length(sv);
5358 const U8 *s = (U8*)SvPV_const(sv, len);
5362 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5364 if (mg && mg->mg_len != -1) {
5366 if (PL_utf8cache < 0) {
5367 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5369 /* Need to turn the assertions off otherwise we may
5370 recurse infinitely while printing error messages.
5372 SAVEI8(PL_utf8cache);
5374 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5375 " real %"UVuf" for %"SVf,
5376 (UV) ulen, (UV) real, SVfARG(sv));
5381 ulen = Perl_utf8_length(aTHX_ s, s + len);
5382 if (!SvREADONLY(sv)) {
5384 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5385 &PL_vtbl_utf8, 0, 0);
5393 return Perl_utf8_length(aTHX_ s, s + len);
5397 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5400 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5403 const U8 *s = start;
5405 while (s < send && uoffset--)
5408 /* This is the existing behaviour. Possibly it should be a croak, as
5409 it's actually a bounds error */
5415 /* Given the length of the string in both bytes and UTF-8 characters, decide
5416 whether to walk forwards or backwards to find the byte corresponding to
5417 the passed in UTF-8 offset. */
5419 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5420 STRLEN uoffset, STRLEN uend)
5422 STRLEN backw = uend - uoffset;
5423 if (uoffset < 2 * backw) {
5424 /* The assumption is that going forwards is twice the speed of going
5425 forward (that's where the 2 * backw comes from).
5426 (The real figure of course depends on the UTF-8 data.) */
5427 return sv_pos_u2b_forwards(start, send, uoffset);
5432 while (UTF8_IS_CONTINUATION(*send))
5435 return send - start;
5438 /* For the string representation of the given scalar, find the byte
5439 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5440 give another position in the string, *before* the sought offset, which
5441 (which is always true, as 0, 0 is a valid pair of positions), which should
5442 help reduce the amount of linear searching.
5443 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5444 will be used to reduce the amount of linear searching. The cache will be
5445 created if necessary, and the found value offered to it for update. */
5447 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5448 const U8 *const send, STRLEN uoffset,
5449 STRLEN uoffset0, STRLEN boffset0) {
5450 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5453 assert (uoffset >= uoffset0);
5455 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5456 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5457 if ((*mgp)->mg_ptr) {
5458 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5459 if (cache[0] == uoffset) {
5460 /* An exact match. */
5463 if (cache[2] == uoffset) {
5464 /* An exact match. */
5468 if (cache[0] < uoffset) {
5469 /* The cache already knows part of the way. */
5470 if (cache[0] > uoffset0) {
5471 /* The cache knows more than the passed in pair */
5472 uoffset0 = cache[0];
5473 boffset0 = cache[1];
5475 if ((*mgp)->mg_len != -1) {
5476 /* And we know the end too. */
5478 + sv_pos_u2b_midway(start + boffset0, send,
5480 (*mgp)->mg_len - uoffset0);
5483 + sv_pos_u2b_forwards(start + boffset0,
5484 send, uoffset - uoffset0);
5487 else if (cache[2] < uoffset) {
5488 /* We're between the two cache entries. */
5489 if (cache[2] > uoffset0) {
5490 /* and the cache knows more than the passed in pair */
5491 uoffset0 = cache[2];
5492 boffset0 = cache[3];
5496 + sv_pos_u2b_midway(start + boffset0,
5499 cache[0] - uoffset0);
5502 + sv_pos_u2b_midway(start + boffset0,
5505 cache[2] - uoffset0);
5509 else if ((*mgp)->mg_len != -1) {
5510 /* If we can take advantage of a passed in offset, do so. */
5511 /* In fact, offset0 is either 0, or less than offset, so don't
5512 need to worry about the other possibility. */
5514 + sv_pos_u2b_midway(start + boffset0, send,
5516 (*mgp)->mg_len - uoffset0);
5521 if (!found || PL_utf8cache < 0) {
5522 const STRLEN real_boffset
5523 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5524 send, uoffset - uoffset0);
5526 if (found && PL_utf8cache < 0) {
5527 if (real_boffset != boffset) {
5528 /* Need to turn the assertions off otherwise we may recurse
5529 infinitely while printing error messages. */
5530 SAVEI8(PL_utf8cache);
5532 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5533 " real %"UVuf" for %"SVf,
5534 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5537 boffset = real_boffset;
5540 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5546 =for apidoc sv_pos_u2b
5548 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5549 the start of the string, to a count of the equivalent number of bytes; if
5550 lenp is non-zero, it does the same to lenp, but this time starting from
5551 the offset, rather than from the start of the string. Handles magic and
5558 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5559 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5560 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5565 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5573 start = (U8*)SvPV_const(sv, len);
5575 STRLEN uoffset = (STRLEN) *offsetp;
5576 const U8 * const send = start + len;
5578 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5581 *offsetp = (I32) boffset;
5584 /* Convert the relative offset to absolute. */
5585 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5586 const STRLEN boffset2
5587 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5588 uoffset, boffset) - boffset;
5602 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5603 byte length pairing. The (byte) length of the total SV is passed in too,
5604 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5605 may not have updated SvCUR, so we can't rely on reading it directly.
5607 The proffered utf8/byte length pairing isn't used if the cache already has
5608 two pairs, and swapping either for the proffered pair would increase the
5609 RMS of the intervals between known byte offsets.
5611 The cache itself consists of 4 STRLEN values
5612 0: larger UTF-8 offset
5613 1: corresponding byte offset
5614 2: smaller UTF-8 offset
5615 3: corresponding byte offset
5617 Unused cache pairs have the value 0, 0.
5618 Keeping the cache "backwards" means that the invariant of
5619 cache[0] >= cache[2] is maintained even with empty slots, which means that
5620 the code that uses it doesn't need to worry if only 1 entry has actually
5621 been set to non-zero. It also makes the "position beyond the end of the
5622 cache" logic much simpler, as the first slot is always the one to start
5626 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5634 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5636 (*mgp)->mg_len = -1;
5640 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5641 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5642 (*mgp)->mg_ptr = (char *) cache;
5646 if (PL_utf8cache < 0) {
5647 const U8 *start = (const U8 *) SvPVX_const(sv);
5648 const STRLEN realutf8 = utf8_length(start, start + byte);
5650 if (realutf8 != utf8) {
5651 /* Need to turn the assertions off otherwise we may recurse
5652 infinitely while printing error messages. */
5653 SAVEI8(PL_utf8cache);
5655 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5656 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5660 /* Cache is held with the later position first, to simplify the code
5661 that deals with unbounded ends. */
5663 ASSERT_UTF8_CACHE(cache);
5664 if (cache[1] == 0) {
5665 /* Cache is totally empty */
5668 } else if (cache[3] == 0) {
5669 if (byte > cache[1]) {
5670 /* New one is larger, so goes first. */
5671 cache[2] = cache[0];
5672 cache[3] = cache[1];
5680 #define THREEWAY_SQUARE(a,b,c,d) \
5681 ((float)((d) - (c))) * ((float)((d) - (c))) \
5682 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5683 + ((float)((b) - (a))) * ((float)((b) - (a)))
5685 /* Cache has 2 slots in use, and we know three potential pairs.
5686 Keep the two that give the lowest RMS distance. Do the
5687 calcualation in bytes simply because we always know the byte
5688 length. squareroot has the same ordering as the positive value,
5689 so don't bother with the actual square root. */
5690 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5691 if (byte > cache[1]) {
5692 /* New position is after the existing pair of pairs. */
5693 const float keep_earlier
5694 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5695 const float keep_later
5696 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5698 if (keep_later < keep_earlier) {
5699 if (keep_later < existing) {
5700 cache[2] = cache[0];
5701 cache[3] = cache[1];
5707 if (keep_earlier < existing) {
5713 else if (byte > cache[3]) {
5714 /* New position is between the existing pair of pairs. */
5715 const float keep_earlier
5716 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5717 const float keep_later
5718 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5720 if (keep_later < keep_earlier) {
5721 if (keep_later < existing) {
5727 if (keep_earlier < existing) {
5734 /* New position is before the existing pair of pairs. */
5735 const float keep_earlier
5736 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5737 const float keep_later
5738 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5740 if (keep_later < keep_earlier) {
5741 if (keep_later < existing) {
5747 if (keep_earlier < existing) {
5748 cache[0] = cache[2];
5749 cache[1] = cache[3];
5756 ASSERT_UTF8_CACHE(cache);
5759 /* We already know all of the way, now we may be able to walk back. The same
5760 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5761 backward is half the speed of walking forward. */
5763 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5766 const STRLEN forw = target - s;
5767 STRLEN backw = end - target;
5769 if (forw < 2 * backw) {
5770 return utf8_length(s, target);
5773 while (end > target) {
5775 while (UTF8_IS_CONTINUATION(*end)) {
5784 =for apidoc sv_pos_b2u
5786 Converts the value pointed to by offsetp from a count of bytes from the
5787 start of the string, to a count of the equivalent number of UTF-8 chars.
5788 Handles magic and type coercion.
5794 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5795 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5800 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5803 const STRLEN byte = *offsetp;
5804 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5813 s = (const U8*)SvPV_const(sv, blen);
5816 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5820 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5821 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5823 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5824 if (cache[1] == byte) {
5825 /* An exact match. */
5826 *offsetp = cache[0];
5829 if (cache[3] == byte) {
5830 /* An exact match. */
5831 *offsetp = cache[2];
5835 if (cache[1] < byte) {
5836 /* We already know part of the way. */
5837 if (mg->mg_len != -1) {
5838 /* Actually, we know the end too. */
5840 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5841 s + blen, mg->mg_len - cache[0]);
5843 len = cache[0] + utf8_length(s + cache[1], send);
5846 else if (cache[3] < byte) {
5847 /* We're between the two cached pairs, so we do the calculation
5848 offset by the byte/utf-8 positions for the earlier pair,
5849 then add the utf-8 characters from the string start to
5851 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5852 s + cache[1], cache[0] - cache[2])
5856 else { /* cache[3] > byte */
5857 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5861 ASSERT_UTF8_CACHE(cache);
5863 } else if (mg->mg_len != -1) {
5864 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5868 if (!found || PL_utf8cache < 0) {
5869 const STRLEN real_len = utf8_length(s, send);
5871 if (found && PL_utf8cache < 0) {
5872 if (len != real_len) {
5873 /* Need to turn the assertions off otherwise we may recurse
5874 infinitely while printing error messages. */
5875 SAVEI8(PL_utf8cache);
5877 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5878 " real %"UVuf" for %"SVf,
5879 (UV) len, (UV) real_len, SVfARG(sv));
5886 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5892 Returns a boolean indicating whether the strings in the two SVs are
5893 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5894 coerce its args to strings if necessary.
5900 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5909 SV* svrecode = NULL;
5916 /* if pv1 and pv2 are the same, second SvPV_const call may
5917 * invalidate pv1, so we may need to make a copy */
5918 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5919 pv1 = SvPV_const(sv1, cur1);
5920 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5921 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5923 pv1 = SvPV_const(sv1, cur1);
5931 pv2 = SvPV_const(sv2, cur2);
5933 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5934 /* Differing utf8ness.
5935 * Do not UTF8size the comparands as a side-effect. */
5938 svrecode = newSVpvn(pv2, cur2);
5939 sv_recode_to_utf8(svrecode, PL_encoding);
5940 pv2 = SvPV_const(svrecode, cur2);
5943 svrecode = newSVpvn(pv1, cur1);
5944 sv_recode_to_utf8(svrecode, PL_encoding);
5945 pv1 = SvPV_const(svrecode, cur1);
5947 /* Now both are in UTF-8. */
5949 SvREFCNT_dec(svrecode);
5954 bool is_utf8 = TRUE;
5957 /* sv1 is the UTF-8 one,
5958 * if is equal it must be downgrade-able */
5959 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5965 /* sv2 is the UTF-8 one,
5966 * if is equal it must be downgrade-able */
5967 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5973 /* Downgrade not possible - cannot be eq */
5981 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5983 SvREFCNT_dec(svrecode);
5993 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5994 string in C<sv1> is less than, equal to, or greater than the string in
5995 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5996 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6002 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6006 const char *pv1, *pv2;
6009 SV *svrecode = NULL;
6016 pv1 = SvPV_const(sv1, cur1);
6023 pv2 = SvPV_const(sv2, cur2);
6025 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6026 /* Differing utf8ness.
6027 * Do not UTF8size the comparands as a side-effect. */
6030 svrecode = newSVpvn(pv2, cur2);
6031 sv_recode_to_utf8(svrecode, PL_encoding);
6032 pv2 = SvPV_const(svrecode, cur2);
6035 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6040 svrecode = newSVpvn(pv1, cur1);
6041 sv_recode_to_utf8(svrecode, PL_encoding);
6042 pv1 = SvPV_const(svrecode, cur1);
6045 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6051 cmp = cur2 ? -1 : 0;
6055 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6058 cmp = retval < 0 ? -1 : 1;
6059 } else if (cur1 == cur2) {
6062 cmp = cur1 < cur2 ? -1 : 1;
6066 SvREFCNT_dec(svrecode);
6074 =for apidoc sv_cmp_locale
6076 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6077 'use bytes' aware, handles get magic, and will coerce its args to strings
6078 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6084 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6087 #ifdef USE_LOCALE_COLLATE
6093 if (PL_collation_standard)
6097 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6099 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6101 if (!pv1 || !len1) {
6112 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6115 return retval < 0 ? -1 : 1;
6118 * When the result of collation is equality, that doesn't mean
6119 * that there are no differences -- some locales exclude some
6120 * characters from consideration. So to avoid false equalities,
6121 * we use the raw string as a tiebreaker.
6127 #endif /* USE_LOCALE_COLLATE */
6129 return sv_cmp(sv1, sv2);
6133 #ifdef USE_LOCALE_COLLATE
6136 =for apidoc sv_collxfrm
6138 Add Collate Transform magic to an SV if it doesn't already have it.
6140 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6141 scalar data of the variable, but transformed to such a format that a normal
6142 memory comparison can be used to compare the data according to the locale
6149 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6154 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6155 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6161 Safefree(mg->mg_ptr);
6162 s = SvPV_const(sv, len);
6163 if ((xf = mem_collxfrm(s, len, &xlen))) {
6164 if (SvREADONLY(sv)) {
6167 return xf + sizeof(PL_collation_ix);
6170 #ifdef PERL_OLD_COPY_ON_WRITE
6172 sv_force_normal_flags(sv, 0);
6174 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6188 if (mg && mg->mg_ptr) {
6190 return mg->mg_ptr + sizeof(PL_collation_ix);
6198 #endif /* USE_LOCALE_COLLATE */
6203 Get a line from the filehandle and store it into the SV, optionally
6204 appending to the currently-stored string.
6210 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6215 register STDCHAR rslast;
6216 register STDCHAR *bp;
6221 if (SvTHINKFIRST(sv))
6222 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6223 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6225 However, perlbench says it's slower, because the existing swipe code
6226 is faster than copy on write.
6227 Swings and roundabouts. */
6228 SvUPGRADE(sv, SVt_PV);
6233 if (PerlIO_isutf8(fp)) {
6235 sv_utf8_upgrade_nomg(sv);
6236 sv_pos_u2b(sv,&append,0);
6238 } else if (SvUTF8(sv)) {
6239 SV * const tsv = newSV(0);
6240 sv_gets(tsv, fp, 0);
6241 sv_utf8_upgrade_nomg(tsv);
6242 SvCUR_set(sv,append);
6245 goto return_string_or_null;
6250 if (PerlIO_isutf8(fp))
6253 if (IN_PERL_COMPILETIME) {
6254 /* we always read code in line mode */
6258 else if (RsSNARF(PL_rs)) {
6259 /* If it is a regular disk file use size from stat() as estimate
6260 of amount we are going to read -- may result in mallocing
6261 more memory than we really need if the layers below reduce
6262 the size we read (e.g. CRLF or a gzip layer).
6265 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6266 const Off_t offset = PerlIO_tell(fp);
6267 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6268 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6274 else if (RsRECORD(PL_rs)) {
6279 /* Grab the size of the record we're getting */
6280 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6281 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6284 /* VMS wants read instead of fread, because fread doesn't respect */
6285 /* RMS record boundaries. This is not necessarily a good thing to be */
6286 /* doing, but we've got no other real choice - except avoid stdio
6287 as implementation - perhaps write a :vms layer ?
6289 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6291 bytesread = PerlIO_read(fp, buffer, recsize);
6295 SvCUR_set(sv, bytesread += append);
6296 buffer[bytesread] = '\0';
6297 goto return_string_or_null;
6299 else if (RsPARA(PL_rs)) {
6305 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6306 if (PerlIO_isutf8(fp)) {
6307 rsptr = SvPVutf8(PL_rs, rslen);
6310 if (SvUTF8(PL_rs)) {
6311 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6312 Perl_croak(aTHX_ "Wide character in $/");
6315 rsptr = SvPV_const(PL_rs, rslen);
6319 rslast = rslen ? rsptr[rslen - 1] : '\0';
6321 if (rspara) { /* have to do this both before and after */
6322 do { /* to make sure file boundaries work right */
6325 i = PerlIO_getc(fp);
6329 PerlIO_ungetc(fp,i);
6335 /* See if we know enough about I/O mechanism to cheat it ! */
6337 /* This used to be #ifdef test - it is made run-time test for ease
6338 of abstracting out stdio interface. One call should be cheap
6339 enough here - and may even be a macro allowing compile
6343 if (PerlIO_fast_gets(fp)) {
6346 * We're going to steal some values from the stdio struct
6347 * and put EVERYTHING in the innermost loop into registers.
6349 register STDCHAR *ptr;
6353 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6354 /* An ungetc()d char is handled separately from the regular
6355 * buffer, so we getc() it back out and stuff it in the buffer.
6357 i = PerlIO_getc(fp);
6358 if (i == EOF) return 0;
6359 *(--((*fp)->_ptr)) = (unsigned char) i;
6363 /* Here is some breathtakingly efficient cheating */
6365 cnt = PerlIO_get_cnt(fp); /* get count into register */
6366 /* make sure we have the room */
6367 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6368 /* Not room for all of it
6369 if we are looking for a separator and room for some
6371 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6372 /* just process what we have room for */
6373 shortbuffered = cnt - SvLEN(sv) + append + 1;
6374 cnt -= shortbuffered;
6378 /* remember that cnt can be negative */
6379 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6384 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6385 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
6387 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6388 DEBUG_P(PerlIO_printf(Perl_debug_log,
6389 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6390 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6391 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6396 while (cnt > 0) { /* this | eat */
6398 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6399 goto thats_all_folks; /* screams | sed :-) */
6403 Copy(ptr, bp, cnt, char); /* this | eat */
6404 bp += cnt; /* screams | dust */
6405 ptr += cnt; /* louder | sed :-) */
6410 if (shortbuffered) { /* oh well, must extend */
6411 cnt = shortbuffered;
6413 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6415 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6416 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6420 DEBUG_P(PerlIO_printf(Perl_debug_log,
6421 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6422 PTR2UV(ptr),(long)cnt));
6423 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6425 DEBUG_P(PerlIO_printf(Perl_debug_log,
6426 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6427 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6428 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6430 /* This used to call 'filbuf' in stdio form, but as that behaves like
6431 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6432 another abstraction. */
6433 i = PerlIO_getc(fp); /* get more characters */
6435 DEBUG_P(PerlIO_printf(Perl_debug_log,
6436 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6437 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6438 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6440 cnt = PerlIO_get_cnt(fp);
6441 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6442 DEBUG_P(PerlIO_printf(Perl_debug_log,
6443 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6445 if (i == EOF) /* all done for ever? */
6446 goto thats_really_all_folks;
6448 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6450 SvGROW(sv, bpx + cnt + 2);
6451 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6453 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6455 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6456 goto thats_all_folks;
6460 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6461 memNE((char*)bp - rslen, rsptr, rslen))
6462 goto screamer; /* go back to the fray */
6463 thats_really_all_folks:
6465 cnt += shortbuffered;
6466 DEBUG_P(PerlIO_printf(Perl_debug_log,
6467 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6468 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6469 DEBUG_P(PerlIO_printf(Perl_debug_log,
6470 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6471 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6472 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6474 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6475 DEBUG_P(PerlIO_printf(Perl_debug_log,
6476 "Screamer: done, len=%ld, string=|%.*s|\n",
6477 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6481 /*The big, slow, and stupid way. */
6482 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6483 STDCHAR *buf = NULL;
6484 Newx(buf, 8192, STDCHAR);
6492 register const STDCHAR * const bpe = buf + sizeof(buf);
6494 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6495 ; /* keep reading */
6499 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6500 /* Accomodate broken VAXC compiler, which applies U8 cast to
6501 * both args of ?: operator, causing EOF to change into 255
6504 i = (U8)buf[cnt - 1];
6510 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6512 sv_catpvn(sv, (char *) buf, cnt);
6514 sv_setpvn(sv, (char *) buf, cnt);
6516 if (i != EOF && /* joy */
6518 SvCUR(sv) < rslen ||
6519 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6523 * If we're reading from a TTY and we get a short read,
6524 * indicating that the user hit his EOF character, we need
6525 * to notice it now, because if we try to read from the TTY
6526 * again, the EOF condition will disappear.
6528 * The comparison of cnt to sizeof(buf) is an optimization
6529 * that prevents unnecessary calls to feof().
6533 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6537 #ifdef USE_HEAP_INSTEAD_OF_STACK
6542 if (rspara) { /* have to do this both before and after */
6543 while (i != EOF) { /* to make sure file boundaries work right */
6544 i = PerlIO_getc(fp);
6546 PerlIO_ungetc(fp,i);
6552 return_string_or_null:
6553 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6559 Auto-increment of the value in the SV, doing string to numeric conversion
6560 if necessary. Handles 'get' magic.
6566 Perl_sv_inc(pTHX_ register SV *sv)
6575 if (SvTHINKFIRST(sv)) {
6577 sv_force_normal_flags(sv, 0);
6578 if (SvREADONLY(sv)) {
6579 if (IN_PERL_RUNTIME)
6580 Perl_croak(aTHX_ PL_no_modify);
6584 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6586 i = PTR2IV(SvRV(sv));
6591 flags = SvFLAGS(sv);
6592 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6593 /* It's (privately or publicly) a float, but not tested as an
6594 integer, so test it to see. */
6596 flags = SvFLAGS(sv);
6598 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6599 /* It's publicly an integer, or privately an integer-not-float */
6600 #ifdef PERL_PRESERVE_IVUV
6604 if (SvUVX(sv) == UV_MAX)
6605 sv_setnv(sv, UV_MAX_P1);
6607 (void)SvIOK_only_UV(sv);
6608 SvUV_set(sv, SvUVX(sv) + 1);
6610 if (SvIVX(sv) == IV_MAX)
6611 sv_setuv(sv, (UV)IV_MAX + 1);
6613 (void)SvIOK_only(sv);
6614 SvIV_set(sv, SvIVX(sv) + 1);
6619 if (flags & SVp_NOK) {
6620 (void)SvNOK_only(sv);
6621 SvNV_set(sv, SvNVX(sv) + 1.0);
6625 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6626 if ((flags & SVTYPEMASK) < SVt_PVIV)
6627 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6628 (void)SvIOK_only(sv);
6633 while (isALPHA(*d)) d++;
6634 while (isDIGIT(*d)) d++;
6636 #ifdef PERL_PRESERVE_IVUV
6637 /* Got to punt this as an integer if needs be, but we don't issue
6638 warnings. Probably ought to make the sv_iv_please() that does
6639 the conversion if possible, and silently. */
6640 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6641 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6642 /* Need to try really hard to see if it's an integer.
6643 9.22337203685478e+18 is an integer.
6644 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6645 so $a="9.22337203685478e+18"; $a+0; $a++
6646 needs to be the same as $a="9.22337203685478e+18"; $a++
6653 /* sv_2iv *should* have made this an NV */
6654 if (flags & SVp_NOK) {
6655 (void)SvNOK_only(sv);
6656 SvNV_set(sv, SvNVX(sv) + 1.0);
6659 /* I don't think we can get here. Maybe I should assert this
6660 And if we do get here I suspect that sv_setnv will croak. NWC
6662 #if defined(USE_LONG_DOUBLE)
6663 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",
6664 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6666 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6667 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6670 #endif /* PERL_PRESERVE_IVUV */
6671 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6675 while (d >= SvPVX_const(sv)) {
6683 /* MKS: The original code here died if letters weren't consecutive.
6684 * at least it didn't have to worry about non-C locales. The
6685 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6686 * arranged in order (although not consecutively) and that only
6687 * [A-Za-z] are accepted by isALPHA in the C locale.
6689 if (*d != 'z' && *d != 'Z') {
6690 do { ++*d; } while (!isALPHA(*d));
6693 *(d--) -= 'z' - 'a';
6698 *(d--) -= 'z' - 'a' + 1;
6702 /* oh,oh, the number grew */
6703 SvGROW(sv, SvCUR(sv) + 2);
6704 SvCUR_set(sv, SvCUR(sv) + 1);
6705 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6716 Auto-decrement of the value in the SV, doing string to numeric conversion
6717 if necessary. Handles 'get' magic.
6723 Perl_sv_dec(pTHX_ register SV *sv)
6731 if (SvTHINKFIRST(sv)) {
6733 sv_force_normal_flags(sv, 0);
6734 if (SvREADONLY(sv)) {
6735 if (IN_PERL_RUNTIME)
6736 Perl_croak(aTHX_ PL_no_modify);
6740 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6742 i = PTR2IV(SvRV(sv));
6747 /* Unlike sv_inc we don't have to worry about string-never-numbers
6748 and keeping them magic. But we mustn't warn on punting */
6749 flags = SvFLAGS(sv);
6750 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6751 /* It's publicly an integer, or privately an integer-not-float */
6752 #ifdef PERL_PRESERVE_IVUV
6756 if (SvUVX(sv) == 0) {
6757 (void)SvIOK_only(sv);
6761 (void)SvIOK_only_UV(sv);
6762 SvUV_set(sv, SvUVX(sv) - 1);
6765 if (SvIVX(sv) == IV_MIN)
6766 sv_setnv(sv, (NV)IV_MIN - 1.0);
6768 (void)SvIOK_only(sv);
6769 SvIV_set(sv, SvIVX(sv) - 1);
6774 if (flags & SVp_NOK) {
6775 SvNV_set(sv, SvNVX(sv) - 1.0);
6776 (void)SvNOK_only(sv);
6779 if (!(flags & SVp_POK)) {
6780 if ((flags & SVTYPEMASK) < SVt_PVIV)
6781 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6783 (void)SvIOK_only(sv);
6786 #ifdef PERL_PRESERVE_IVUV
6788 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6789 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6790 /* Need to try really hard to see if it's an integer.
6791 9.22337203685478e+18 is an integer.
6792 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6793 so $a="9.22337203685478e+18"; $a+0; $a--
6794 needs to be the same as $a="9.22337203685478e+18"; $a--
6801 /* sv_2iv *should* have made this an NV */
6802 if (flags & SVp_NOK) {
6803 (void)SvNOK_only(sv);
6804 SvNV_set(sv, SvNVX(sv) - 1.0);
6807 /* I don't think we can get here. Maybe I should assert this
6808 And if we do get here I suspect that sv_setnv will croak. NWC
6810 #if defined(USE_LONG_DOUBLE)
6811 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",
6812 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6814 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6815 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6819 #endif /* PERL_PRESERVE_IVUV */
6820 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6824 =for apidoc sv_mortalcopy
6826 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6827 The new SV is marked as mortal. It will be destroyed "soon", either by an
6828 explicit call to FREETMPS, or by an implicit call at places such as
6829 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6834 /* Make a string that will exist for the duration of the expression
6835 * evaluation. Actually, it may have to last longer than that, but
6836 * hopefully we won't free it until it has been assigned to a
6837 * permanent location. */
6840 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6846 sv_setsv(sv,oldstr);
6848 PL_tmps_stack[++PL_tmps_ix] = sv;
6854 =for apidoc sv_newmortal
6856 Creates a new null SV which is mortal. The reference count of the SV is
6857 set to 1. It will be destroyed "soon", either by an explicit call to
6858 FREETMPS, or by an implicit call at places such as statement boundaries.
6859 See also C<sv_mortalcopy> and C<sv_2mortal>.
6865 Perl_sv_newmortal(pTHX)
6871 SvFLAGS(sv) = SVs_TEMP;
6873 PL_tmps_stack[++PL_tmps_ix] = sv;
6878 =for apidoc sv_2mortal
6880 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6881 by an explicit call to FREETMPS, or by an implicit call at places such as
6882 statement boundaries. SvTEMP() is turned on which means that the SV's
6883 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6884 and C<sv_mortalcopy>.
6890 Perl_sv_2mortal(pTHX_ register SV *sv)
6895 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6898 PL_tmps_stack[++PL_tmps_ix] = sv;
6906 Creates a new SV and copies a string into it. The reference count for the
6907 SV is set to 1. If C<len> is zero, Perl will compute the length using
6908 strlen(). For efficiency, consider using C<newSVpvn> instead.
6914 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6920 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6925 =for apidoc newSVpvn
6927 Creates a new SV and copies a string into it. The reference count for the
6928 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6929 string. You are responsible for ensuring that the source string is at least
6930 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6936 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6942 sv_setpvn(sv,s,len);
6948 =for apidoc newSVhek
6950 Creates a new SV from the hash key structure. It will generate scalars that
6951 point to the shared string table where possible. Returns a new (undefined)
6952 SV if the hek is NULL.
6958 Perl_newSVhek(pTHX_ const HEK *hek)
6968 if (HEK_LEN(hek) == HEf_SVKEY) {
6969 return newSVsv(*(SV**)HEK_KEY(hek));
6971 const int flags = HEK_FLAGS(hek);
6972 if (flags & HVhek_WASUTF8) {
6974 Andreas would like keys he put in as utf8 to come back as utf8
6976 STRLEN utf8_len = HEK_LEN(hek);
6977 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6978 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6981 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6983 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6984 /* We don't have a pointer to the hv, so we have to replicate the
6985 flag into every HEK. This hv is using custom a hasing
6986 algorithm. Hence we can't return a shared string scalar, as
6987 that would contain the (wrong) hash value, and might get passed
6988 into an hv routine with a regular hash.
6989 Similarly, a hash that isn't using shared hash keys has to have
6990 the flag in every key so that we know not to try to call
6991 share_hek_kek on it. */
6993 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6998 /* This will be overwhelminly the most common case. */
7000 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7001 more efficient than sharepvn(). */
7005 sv_upgrade(sv, SVt_PV);
7006 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7007 SvCUR_set(sv, HEK_LEN(hek));
7020 =for apidoc newSVpvn_share
7022 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7023 table. If the string does not already exist in the table, it is created
7024 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7025 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7026 otherwise the hash is computed. The idea here is that as the string table
7027 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7028 hash lookup will avoid string compare.
7034 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7038 bool is_utf8 = FALSE;
7039 const char *const orig_src = src;
7042 STRLEN tmplen = -len;
7044 /* See the note in hv.c:hv_fetch() --jhi */
7045 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7049 PERL_HASH(hash, src, len);
7051 sv_upgrade(sv, SVt_PV);
7052 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7060 if (src != orig_src)
7066 #if defined(PERL_IMPLICIT_CONTEXT)
7068 /* pTHX_ magic can't cope with varargs, so this is a no-context
7069 * version of the main function, (which may itself be aliased to us).
7070 * Don't access this version directly.
7074 Perl_newSVpvf_nocontext(const char* pat, ...)
7079 va_start(args, pat);
7080 sv = vnewSVpvf(pat, &args);
7087 =for apidoc newSVpvf
7089 Creates a new SV and initializes it with the string formatted like
7096 Perl_newSVpvf(pTHX_ const char* pat, ...)
7100 va_start(args, pat);
7101 sv = vnewSVpvf(pat, &args);
7106 /* backend for newSVpvf() and newSVpvf_nocontext() */
7109 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7114 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7121 Creates a new SV and copies a floating point value into it.
7122 The reference count for the SV is set to 1.
7128 Perl_newSVnv(pTHX_ NV n)
7141 Creates a new SV and copies an integer into it. The reference count for the
7148 Perl_newSViv(pTHX_ IV i)
7161 Creates a new SV and copies an unsigned integer into it.
7162 The reference count for the SV is set to 1.
7168 Perl_newSVuv(pTHX_ UV u)
7179 =for apidoc newSV_type
7181 Creates a new SV, of the type specificied. The reference count for the new SV
7188 Perl_newSV_type(pTHX_ svtype type)
7193 sv_upgrade(sv, type);
7198 =for apidoc newRV_noinc
7200 Creates an RV wrapper for an SV. The reference count for the original
7201 SV is B<not> incremented.
7207 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7210 register SV *sv = newSV_type(SVt_RV);
7212 SvRV_set(sv, tmpRef);
7217 /* newRV_inc is the official function name to use now.
7218 * newRV_inc is in fact #defined to newRV in sv.h
7222 Perl_newRV(pTHX_ SV *sv)
7225 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7231 Creates a new SV which is an exact duplicate of the original SV.
7238 Perl_newSVsv(pTHX_ register SV *old)
7245 if (SvTYPE(old) == SVTYPEMASK) {
7246 if (ckWARN_d(WARN_INTERNAL))
7247 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7251 /* SV_GMAGIC is the default for sv_setv()
7252 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7253 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7254 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7259 =for apidoc sv_reset
7261 Underlying implementation for the C<reset> Perl function.
7262 Note that the perl-level function is vaguely deprecated.
7268 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7271 char todo[PERL_UCHAR_MAX+1];
7276 if (!*s) { /* reset ?? searches */
7277 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7279 const U32 count = mg->mg_len / sizeof(PMOP**);
7280 PMOP **pmp = (PMOP**) mg->mg_ptr;
7281 PMOP *const *const end = pmp + count;
7285 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7287 (*pmp)->op_pmflags &= ~PMf_USED;
7295 /* reset variables */
7297 if (!HvARRAY(stash))
7300 Zero(todo, 256, char);
7303 I32 i = (unsigned char)*s;
7307 max = (unsigned char)*s++;
7308 for ( ; i <= max; i++) {
7311 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7313 for (entry = HvARRAY(stash)[i];
7315 entry = HeNEXT(entry))
7320 if (!todo[(U8)*HeKEY(entry)])
7322 gv = (GV*)HeVAL(entry);
7325 if (SvTHINKFIRST(sv)) {
7326 if (!SvREADONLY(sv) && SvROK(sv))
7328 /* XXX Is this continue a bug? Why should THINKFIRST
7329 exempt us from resetting arrays and hashes? */
7333 if (SvTYPE(sv) >= SVt_PV) {
7335 if (SvPVX_const(sv) != NULL)
7343 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7345 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7348 # if defined(USE_ENVIRON_ARRAY)
7351 # endif /* USE_ENVIRON_ARRAY */
7362 Using various gambits, try to get an IO from an SV: the IO slot if its a
7363 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7364 named after the PV if we're a string.
7370 Perl_sv_2io(pTHX_ SV *sv)
7375 switch (SvTYPE(sv)) {
7383 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7387 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7389 return sv_2io(SvRV(sv));
7390 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7396 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7405 Using various gambits, try to get a CV from an SV; in addition, try if
7406 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7407 The flags in C<lref> are passed to sv_fetchsv.
7413 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7424 switch (SvTYPE(sv)) {
7443 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7444 tryAMAGICunDEREF(to_cv);
7447 if (SvTYPE(sv) == SVt_PVCV) {
7456 Perl_croak(aTHX_ "Not a subroutine reference");
7461 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7467 /* Some flags to gv_fetchsv mean don't really create the GV */
7468 if (SvTYPE(gv) != SVt_PVGV) {
7474 if (lref && !GvCVu(gv)) {
7478 gv_efullname3(tmpsv, gv, NULL);
7479 /* XXX this is probably not what they think they're getting.
7480 * It has the same effect as "sub name;", i.e. just a forward
7482 newSUB(start_subparse(FALSE, 0),
7483 newSVOP(OP_CONST, 0, tmpsv),
7487 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7497 Returns true if the SV has a true value by Perl's rules.
7498 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7499 instead use an in-line version.
7505 Perl_sv_true(pTHX_ register SV *sv)
7510 register const XPV* const tXpv = (XPV*)SvANY(sv);
7512 (tXpv->xpv_cur > 1 ||
7513 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7520 return SvIVX(sv) != 0;
7523 return SvNVX(sv) != 0.0;
7525 return sv_2bool(sv);
7531 =for apidoc sv_pvn_force
7533 Get a sensible string out of the SV somehow.
7534 A private implementation of the C<SvPV_force> macro for compilers which
7535 can't cope with complex macro expressions. Always use the macro instead.
7537 =for apidoc sv_pvn_force_flags
7539 Get a sensible string out of the SV somehow.
7540 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7541 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7542 implemented in terms of this function.
7543 You normally want to use the various wrapper macros instead: see
7544 C<SvPV_force> and C<SvPV_force_nomg>
7550 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7553 if (SvTHINKFIRST(sv) && !SvROK(sv))
7554 sv_force_normal_flags(sv, 0);
7564 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7565 const char * const ref = sv_reftype(sv,0);
7567 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7568 ref, OP_NAME(PL_op));
7570 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7572 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7573 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7575 s = sv_2pv_flags(sv, &len, flags);
7579 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7582 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7583 SvGROW(sv, len + 1);
7584 Move(s,SvPVX(sv),len,char);
7589 SvPOK_on(sv); /* validate pointer */
7591 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7592 PTR2UV(sv),SvPVX_const(sv)));
7595 return SvPVX_mutable(sv);
7599 =for apidoc sv_pvbyten_force
7601 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7607 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7609 sv_pvn_force(sv,lp);
7610 sv_utf8_downgrade(sv,0);
7616 =for apidoc sv_pvutf8n_force
7618 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7624 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7626 sv_pvn_force(sv,lp);
7627 sv_utf8_upgrade(sv);
7633 =for apidoc sv_reftype
7635 Returns a string describing what the SV is a reference to.
7641 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7643 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7644 inside return suggests a const propagation bug in g++. */
7645 if (ob && SvOBJECT(sv)) {
7646 char * const name = HvNAME_get(SvSTASH(sv));
7647 return name ? name : (char *) "__ANON__";
7650 switch (SvTYPE(sv)) {
7666 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7667 /* tied lvalues should appear to be
7668 * scalars for backwards compatitbility */
7669 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7670 ? "SCALAR" : "LVALUE");
7671 case SVt_PVAV: return "ARRAY";
7672 case SVt_PVHV: return "HASH";
7673 case SVt_PVCV: return "CODE";
7674 case SVt_PVGV: return "GLOB";
7675 case SVt_PVFM: return "FORMAT";
7676 case SVt_PVIO: return "IO";
7677 case SVt_BIND: return "BIND";
7678 default: return "UNKNOWN";
7684 =for apidoc sv_isobject
7686 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7687 object. If the SV is not an RV, or if the object is not blessed, then this
7694 Perl_sv_isobject(pTHX_ SV *sv)
7710 Returns a boolean indicating whether the SV is blessed into the specified
7711 class. This does not check for subtypes; use C<sv_derived_from> to verify
7712 an inheritance relationship.
7718 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7729 hvname = HvNAME_get(SvSTASH(sv));
7733 return strEQ(hvname, name);
7739 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7740 it will be upgraded to one. If C<classname> is non-null then the new SV will
7741 be blessed in the specified package. The new SV is returned and its
7742 reference count is 1.
7748 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7755 SV_CHECK_THINKFIRST_COW_DROP(rv);
7756 (void)SvAMAGIC_off(rv);
7758 if (SvTYPE(rv) >= SVt_PVMG) {
7759 const U32 refcnt = SvREFCNT(rv);
7763 SvREFCNT(rv) = refcnt;
7765 sv_upgrade(rv, SVt_RV);
7766 } else if (SvROK(rv)) {
7767 SvREFCNT_dec(SvRV(rv));
7768 } else if (SvTYPE(rv) < SVt_RV)
7769 sv_upgrade(rv, SVt_RV);
7770 else if (SvTYPE(rv) > SVt_RV) {
7781 HV* const stash = gv_stashpv(classname, GV_ADD);
7782 (void)sv_bless(rv, stash);
7788 =for apidoc sv_setref_pv
7790 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7791 argument will be upgraded to an RV. That RV will be modified to point to
7792 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7793 into the SV. The C<classname> argument indicates the package for the
7794 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7795 will have a reference count of 1, and the RV will be returned.
7797 Do not use with other Perl types such as HV, AV, SV, CV, because those
7798 objects will become corrupted by the pointer copy process.
7800 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7806 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7810 sv_setsv(rv, &PL_sv_undef);
7814 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7819 =for apidoc sv_setref_iv
7821 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7822 argument will be upgraded to an RV. That RV will be modified to point to
7823 the new SV. The C<classname> argument indicates the package for the
7824 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7825 will have a reference count of 1, and the RV will be returned.
7831 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7833 sv_setiv(newSVrv(rv,classname), iv);
7838 =for apidoc sv_setref_uv
7840 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7841 argument will be upgraded to an RV. That RV will be modified to point to
7842 the new SV. The C<classname> argument indicates the package for the
7843 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7844 will have a reference count of 1, and the RV will be returned.
7850 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7852 sv_setuv(newSVrv(rv,classname), uv);
7857 =for apidoc sv_setref_nv
7859 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7860 argument will be upgraded to an RV. That RV will be modified to point to
7861 the new SV. The C<classname> argument indicates the package for the
7862 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7863 will have a reference count of 1, and the RV will be returned.
7869 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7871 sv_setnv(newSVrv(rv,classname), nv);
7876 =for apidoc sv_setref_pvn
7878 Copies a string into a new SV, optionally blessing the SV. The length of the
7879 string must be specified with C<n>. The C<rv> argument will be upgraded to
7880 an RV. That RV will be modified to point to the new SV. The C<classname>
7881 argument indicates the package for the blessing. Set C<classname> to
7882 C<NULL> to avoid the blessing. The new SV will have a reference count
7883 of 1, and the RV will be returned.
7885 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7891 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7893 sv_setpvn(newSVrv(rv,classname), pv, n);
7898 =for apidoc sv_bless
7900 Blesses an SV into a specified package. The SV must be an RV. The package
7901 must be designated by its stash (see C<gv_stashpv()>). The reference count
7902 of the SV is unaffected.
7908 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7913 Perl_croak(aTHX_ "Can't bless non-reference value");
7915 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7916 if (SvREADONLY(tmpRef))
7917 Perl_croak(aTHX_ PL_no_modify);
7918 if (SvOBJECT(tmpRef)) {
7919 if (SvTYPE(tmpRef) != SVt_PVIO)
7921 SvREFCNT_dec(SvSTASH(tmpRef));
7924 SvOBJECT_on(tmpRef);
7925 if (SvTYPE(tmpRef) != SVt_PVIO)
7927 SvUPGRADE(tmpRef, SVt_PVMG);
7928 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7933 (void)SvAMAGIC_off(sv);
7935 if(SvSMAGICAL(tmpRef))
7936 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7944 /* Downgrades a PVGV to a PVMG.
7948 S_sv_unglob(pTHX_ SV *sv)
7952 SV * const temp = sv_newmortal();
7954 assert(SvTYPE(sv) == SVt_PVGV);
7956 gv_efullname3(temp, (GV *) sv, "*");
7962 sv_del_backref((SV*)GvSTASH(sv), sv);
7966 if (GvNAME_HEK(sv)) {
7967 unshare_hek(GvNAME_HEK(sv));
7969 isGV_with_GP_off(sv);
7971 /* need to keep SvANY(sv) in the right arena */
7972 xpvmg = new_XPVMG();
7973 StructCopy(SvANY(sv), xpvmg, XPVMG);
7974 del_XPVGV(SvANY(sv));
7977 SvFLAGS(sv) &= ~SVTYPEMASK;
7978 SvFLAGS(sv) |= SVt_PVMG;
7980 /* Intentionally not calling any local SET magic, as this isn't so much a
7981 set operation as merely an internal storage change. */
7982 sv_setsv_flags(sv, temp, 0);
7986 =for apidoc sv_unref_flags
7988 Unsets the RV status of the SV, and decrements the reference count of
7989 whatever was being referenced by the RV. This can almost be thought of
7990 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7991 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7992 (otherwise the decrementing is conditional on the reference count being
7993 different from one or the reference being a readonly SV).
8000 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8002 SV* const target = SvRV(ref);
8004 if (SvWEAKREF(ref)) {
8005 sv_del_backref(target, ref);
8007 SvRV_set(ref, NULL);
8010 SvRV_set(ref, NULL);
8012 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8013 assigned to as BEGIN {$a = \"Foo"} will fail. */
8014 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8015 SvREFCNT_dec(target);
8016 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8017 sv_2mortal(target); /* Schedule for freeing later */
8021 =for apidoc sv_untaint
8023 Untaint an SV. Use C<SvTAINTED_off> instead.
8028 Perl_sv_untaint(pTHX_ SV *sv)
8030 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8031 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8038 =for apidoc sv_tainted
8040 Test an SV for taintedness. Use C<SvTAINTED> instead.
8045 Perl_sv_tainted(pTHX_ SV *sv)
8047 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8048 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8049 if (mg && (mg->mg_len & 1) )
8056 =for apidoc sv_setpviv
8058 Copies an integer into the given SV, also updating its string value.
8059 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8065 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8067 char buf[TYPE_CHARS(UV)];
8069 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8071 sv_setpvn(sv, ptr, ebuf - ptr);
8075 =for apidoc sv_setpviv_mg
8077 Like C<sv_setpviv>, but also handles 'set' magic.
8083 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8089 #if defined(PERL_IMPLICIT_CONTEXT)
8091 /* pTHX_ magic can't cope with varargs, so this is a no-context
8092 * version of the main function, (which may itself be aliased to us).
8093 * Don't access this version directly.
8097 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8101 va_start(args, pat);
8102 sv_vsetpvf(sv, pat, &args);
8106 /* pTHX_ magic can't cope with varargs, so this is a no-context
8107 * version of the main function, (which may itself be aliased to us).
8108 * Don't access this version directly.
8112 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8116 va_start(args, pat);
8117 sv_vsetpvf_mg(sv, pat, &args);
8123 =for apidoc sv_setpvf
8125 Works like C<sv_catpvf> but copies the text into the SV instead of
8126 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8132 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8135 va_start(args, pat);
8136 sv_vsetpvf(sv, pat, &args);
8141 =for apidoc sv_vsetpvf
8143 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8144 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8146 Usually used via its frontend C<sv_setpvf>.
8152 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8154 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8158 =for apidoc sv_setpvf_mg
8160 Like C<sv_setpvf>, but also handles 'set' magic.
8166 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8169 va_start(args, pat);
8170 sv_vsetpvf_mg(sv, pat, &args);
8175 =for apidoc sv_vsetpvf_mg
8177 Like C<sv_vsetpvf>, but also handles 'set' magic.
8179 Usually used via its frontend C<sv_setpvf_mg>.
8185 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8187 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8191 #if defined(PERL_IMPLICIT_CONTEXT)
8193 /* pTHX_ magic can't cope with varargs, so this is a no-context
8194 * version of the main function, (which may itself be aliased to us).
8195 * Don't access this version directly.
8199 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8203 va_start(args, pat);
8204 sv_vcatpvf(sv, pat, &args);
8208 /* pTHX_ magic can't cope with varargs, so this is a no-context
8209 * version of the main function, (which may itself be aliased to us).
8210 * Don't access this version directly.
8214 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8218 va_start(args, pat);
8219 sv_vcatpvf_mg(sv, pat, &args);
8225 =for apidoc sv_catpvf
8227 Processes its arguments like C<sprintf> and appends the formatted
8228 output to an SV. If the appended data contains "wide" characters
8229 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8230 and characters >255 formatted with %c), the original SV might get
8231 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8232 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8233 valid UTF-8; if the original SV was bytes, the pattern should be too.
8238 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8241 va_start(args, pat);
8242 sv_vcatpvf(sv, pat, &args);
8247 =for apidoc sv_vcatpvf
8249 Processes its arguments like C<vsprintf> and appends the formatted output
8250 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8252 Usually used via its frontend C<sv_catpvf>.
8258 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8260 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8264 =for apidoc sv_catpvf_mg
8266 Like C<sv_catpvf>, but also handles 'set' magic.
8272 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8275 va_start(args, pat);
8276 sv_vcatpvf_mg(sv, pat, &args);
8281 =for apidoc sv_vcatpvf_mg
8283 Like C<sv_vcatpvf>, but also handles 'set' magic.
8285 Usually used via its frontend C<sv_catpvf_mg>.
8291 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8293 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8298 =for apidoc sv_vsetpvfn
8300 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8303 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8309 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8311 sv_setpvn(sv, "", 0);
8312 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8316 S_expect_number(pTHX_ char** pattern)
8320 switch (**pattern) {
8321 case '1': case '2': case '3':
8322 case '4': case '5': case '6':
8323 case '7': case '8': case '9':
8324 var = *(*pattern)++ - '0';
8325 while (isDIGIT(**pattern)) {
8326 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8328 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8336 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8338 const int neg = nv < 0;
8347 if (uv & 1 && uv == nv)
8348 uv--; /* Round to even */
8350 const unsigned dig = uv % 10;
8363 =for apidoc sv_vcatpvfn
8365 Processes its arguments like C<vsprintf> and appends the formatted output
8366 to an SV. Uses an array of SVs if the C style variable argument list is
8367 missing (NULL). When running with taint checks enabled, indicates via
8368 C<maybe_tainted> if results are untrustworthy (often due to the use of
8371 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8377 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8378 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8379 vec_utf8 = DO_UTF8(vecsv);
8381 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8384 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8392 static const char nullstr[] = "(null)";
8394 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8395 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8397 /* Times 4: a decimal digit takes more than 3 binary digits.
8398 * NV_DIG: mantissa takes than many decimal digits.
8399 * Plus 32: Playing safe. */
8400 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8401 /* large enough for "%#.#f" --chip */
8402 /* what about long double NVs? --jhi */
8404 PERL_UNUSED_ARG(maybe_tainted);
8406 /* no matter what, this is a string now */
8407 (void)SvPV_force(sv, origlen);
8409 /* special-case "", "%s", and "%-p" (SVf - see below) */
8412 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8414 const char * const s = va_arg(*args, char*);
8415 sv_catpv(sv, s ? s : nullstr);
8417 else if (svix < svmax) {
8418 sv_catsv(sv, *svargs);
8422 if (args && patlen == 3 && pat[0] == '%' &&
8423 pat[1] == '-' && pat[2] == 'p') {
8424 argsv = (SV*)va_arg(*args, void*);
8425 sv_catsv(sv, argsv);
8429 #ifndef USE_LONG_DOUBLE
8430 /* special-case "%.<number>[gf]" */
8431 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8432 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8433 unsigned digits = 0;
8437 while (*pp >= '0' && *pp <= '9')
8438 digits = 10 * digits + (*pp++ - '0');
8439 if (pp - pat == (int)patlen - 1) {
8447 /* Add check for digits != 0 because it seems that some
8448 gconverts are buggy in this case, and we don't yet have
8449 a Configure test for this. */
8450 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8451 /* 0, point, slack */
8452 Gconvert(nv, (int)digits, 0, ebuf);
8454 if (*ebuf) /* May return an empty string for digits==0 */
8457 } else if (!digits) {
8460 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8461 sv_catpvn(sv, p, l);
8467 #endif /* !USE_LONG_DOUBLE */
8469 if (!args && svix < svmax && DO_UTF8(*svargs))
8472 patend = (char*)pat + patlen;
8473 for (p = (char*)pat; p < patend; p = q) {
8476 bool vectorize = FALSE;
8477 bool vectorarg = FALSE;
8478 bool vec_utf8 = FALSE;
8484 bool has_precis = FALSE;
8486 const I32 osvix = svix;
8487 bool is_utf8 = FALSE; /* is this item utf8? */
8488 #ifdef HAS_LDBL_SPRINTF_BUG
8489 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8490 with sfio - Allen <allens@cpan.org> */
8491 bool fix_ldbl_sprintf_bug = FALSE;
8495 U8 utf8buf[UTF8_MAXBYTES+1];
8496 STRLEN esignlen = 0;
8498 const char *eptr = NULL;
8501 const U8 *vecstr = NULL;
8508 /* we need a long double target in case HAS_LONG_DOUBLE but
8511 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8519 const char *dotstr = ".";
8520 STRLEN dotstrlen = 1;
8521 I32 efix = 0; /* explicit format parameter index */
8522 I32 ewix = 0; /* explicit width index */
8523 I32 epix = 0; /* explicit precision index */
8524 I32 evix = 0; /* explicit vector index */
8525 bool asterisk = FALSE;
8527 /* echo everything up to the next format specification */
8528 for (q = p; q < patend && *q != '%'; ++q) ;
8530 if (has_utf8 && !pat_utf8)
8531 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8533 sv_catpvn(sv, p, q - p);
8540 We allow format specification elements in this order:
8541 \d+\$ explicit format parameter index
8543 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8544 0 flag (as above): repeated to allow "v02"
8545 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8546 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8548 [%bcdefginopsuxDFOUX] format (mandatory)
8553 As of perl5.9.3, printf format checking is on by default.
8554 Internally, perl uses %p formats to provide an escape to
8555 some extended formatting. This block deals with those
8556 extensions: if it does not match, (char*)q is reset and
8557 the normal format processing code is used.
8559 Currently defined extensions are:
8560 %p include pointer address (standard)
8561 %-p (SVf) include an SV (previously %_)
8562 %-<num>p include an SV with precision <num>
8563 %1p (VDf) include a v-string (as %vd)
8564 %<num>p reserved for future extensions
8566 Robin Barker 2005-07-14
8573 n = expect_number(&q);
8580 argsv = (SV*)va_arg(*args, void*);
8581 eptr = SvPVx_const(argsv, elen);
8587 else if (n == vdNUMBER) { /* VDf */
8594 if (ckWARN_d(WARN_INTERNAL))
8595 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8596 "internal %%<num>p might conflict with future printf extensions");
8602 if ( (width = expect_number(&q)) ) {
8617 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8646 if ( (ewix = expect_number(&q)) )
8655 if ((vectorarg = asterisk)) {
8668 width = expect_number(&q);
8674 vecsv = va_arg(*args, SV*);
8676 vecsv = (evix > 0 && evix <= svmax)
8677 ? svargs[evix-1] : &PL_sv_undef;
8679 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8681 dotstr = SvPV_const(vecsv, dotstrlen);
8682 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8683 bad with tied or overloaded values that return UTF8. */
8686 else if (has_utf8) {
8687 vecsv = sv_mortalcopy(vecsv);
8688 sv_utf8_upgrade(vecsv);
8689 dotstr = SvPV_const(vecsv, dotstrlen);
8696 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8697 vecsv = svargs[efix ? efix-1 : svix++];
8698 vecstr = (U8*)SvPV_const(vecsv,veclen);
8699 vec_utf8 = DO_UTF8(vecsv);
8701 /* if this is a version object, we need to convert
8702 * back into v-string notation and then let the
8703 * vectorize happen normally
8705 if (sv_derived_from(vecsv, "version")) {
8706 char *version = savesvpv(vecsv);
8707 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8708 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8709 "vector argument not supported with alpha versions");
8712 vecsv = sv_newmortal();
8713 scan_vstring(version, version + veclen, vecsv);
8714 vecstr = (U8*)SvPV_const(vecsv, veclen);
8715 vec_utf8 = DO_UTF8(vecsv);
8727 i = va_arg(*args, int);
8729 i = (ewix ? ewix <= svmax : svix < svmax) ?
8730 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8732 width = (i < 0) ? -i : i;
8742 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8744 /* XXX: todo, support specified precision parameter */
8748 i = va_arg(*args, int);
8750 i = (ewix ? ewix <= svmax : svix < svmax)
8751 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8753 has_precis = !(i < 0);
8758 precis = precis * 10 + (*q++ - '0');
8767 case 'I': /* Ix, I32x, and I64x */
8769 if (q[1] == '6' && q[2] == '4') {
8775 if (q[1] == '3' && q[2] == '2') {
8785 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8796 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8797 if (*(q + 1) == 'l') { /* lld, llf */
8823 if (!vectorize && !args) {
8825 const I32 i = efix-1;
8826 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8828 argsv = (svix >= 0 && svix < svmax)
8829 ? svargs[svix++] : &PL_sv_undef;
8840 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8842 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8844 eptr = (char*)utf8buf;
8845 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8859 eptr = va_arg(*args, char*);
8861 #ifdef MACOS_TRADITIONAL
8862 /* On MacOS, %#s format is used for Pascal strings */
8867 elen = strlen(eptr);
8869 eptr = (char *)nullstr;
8870 elen = sizeof nullstr - 1;
8874 eptr = SvPVx_const(argsv, elen);
8875 if (DO_UTF8(argsv)) {
8876 I32 old_precis = precis;
8877 if (has_precis && precis < elen) {
8879 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8882 if (width) { /* fudge width (can't fudge elen) */
8883 if (has_precis && precis < elen)
8884 width += precis - old_precis;
8886 width += elen - sv_len_utf8(argsv);
8893 if (has_precis && elen > precis)
8900 if (alt || vectorize)
8902 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8923 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8932 esignbuf[esignlen++] = plus;
8936 case 'h': iv = (short)va_arg(*args, int); break;
8937 case 'l': iv = va_arg(*args, long); break;
8938 case 'V': iv = va_arg(*args, IV); break;
8939 default: iv = va_arg(*args, int); break;
8941 case 'q': iv = va_arg(*args, Quad_t); break;
8946 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8948 case 'h': iv = (short)tiv; break;
8949 case 'l': iv = (long)tiv; break;
8951 default: iv = tiv; break;
8953 case 'q': iv = (Quad_t)tiv; break;
8957 if ( !vectorize ) /* we already set uv above */
8962 esignbuf[esignlen++] = plus;
8966 esignbuf[esignlen++] = '-';
9010 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9021 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9022 case 'l': uv = va_arg(*args, unsigned long); break;
9023 case 'V': uv = va_arg(*args, UV); break;
9024 default: uv = va_arg(*args, unsigned); break;
9026 case 'q': uv = va_arg(*args, Uquad_t); break;
9031 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9033 case 'h': uv = (unsigned short)tuv; break;
9034 case 'l': uv = (unsigned long)tuv; break;
9036 default: uv = tuv; break;
9038 case 'q': uv = (Uquad_t)tuv; break;
9045 char *ptr = ebuf + sizeof ebuf;
9046 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9052 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9058 esignbuf[esignlen++] = '0';
9059 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9067 if (alt && *ptr != '0')
9076 esignbuf[esignlen++] = '0';
9077 esignbuf[esignlen++] = c;
9080 default: /* it had better be ten or less */
9084 } while (uv /= base);
9087 elen = (ebuf + sizeof ebuf) - ptr;
9091 zeros = precis - elen;
9092 else if (precis == 0 && elen == 1 && *eptr == '0'
9093 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9096 /* a precision nullifies the 0 flag. */
9103 /* FLOATING POINT */
9106 c = 'f'; /* maybe %F isn't supported here */
9114 /* This is evil, but floating point is even more evil */
9116 /* for SV-style calling, we can only get NV
9117 for C-style calling, we assume %f is double;
9118 for simplicity we allow any of %Lf, %llf, %qf for long double
9122 #if defined(USE_LONG_DOUBLE)
9126 /* [perl #20339] - we should accept and ignore %lf rather than die */
9130 #if defined(USE_LONG_DOUBLE)
9131 intsize = args ? 0 : 'q';
9135 #if defined(HAS_LONG_DOUBLE)
9144 /* now we need (long double) if intsize == 'q', else (double) */
9146 #if LONG_DOUBLESIZE > DOUBLESIZE
9148 va_arg(*args, long double) :
9149 va_arg(*args, double)
9151 va_arg(*args, double)
9156 if (c != 'e' && c != 'E') {
9158 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9159 will cast our (long double) to (double) */
9160 (void)Perl_frexp(nv, &i);
9161 if (i == PERL_INT_MIN)
9162 Perl_die(aTHX_ "panic: frexp");
9164 need = BIT_DIGITS(i);
9166 need += has_precis ? precis : 6; /* known default */
9171 #ifdef HAS_LDBL_SPRINTF_BUG
9172 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9173 with sfio - Allen <allens@cpan.org> */
9176 # define MY_DBL_MAX DBL_MAX
9177 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9178 # if DOUBLESIZE >= 8
9179 # define MY_DBL_MAX 1.7976931348623157E+308L
9181 # define MY_DBL_MAX 3.40282347E+38L
9185 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9186 # define MY_DBL_MAX_BUG 1L
9188 # define MY_DBL_MAX_BUG MY_DBL_MAX
9192 # define MY_DBL_MIN DBL_MIN
9193 # else /* XXX guessing! -Allen */
9194 # if DOUBLESIZE >= 8
9195 # define MY_DBL_MIN 2.2250738585072014E-308L
9197 # define MY_DBL_MIN 1.17549435E-38L
9201 if ((intsize == 'q') && (c == 'f') &&
9202 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9204 /* it's going to be short enough that
9205 * long double precision is not needed */
9207 if ((nv <= 0L) && (nv >= -0L))
9208 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9210 /* would use Perl_fp_class as a double-check but not
9211 * functional on IRIX - see perl.h comments */
9213 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9214 /* It's within the range that a double can represent */
9215 #if defined(DBL_MAX) && !defined(DBL_MIN)
9216 if ((nv >= ((long double)1/DBL_MAX)) ||
9217 (nv <= (-(long double)1/DBL_MAX)))
9219 fix_ldbl_sprintf_bug = TRUE;
9222 if (fix_ldbl_sprintf_bug == TRUE) {
9232 # undef MY_DBL_MAX_BUG
9235 #endif /* HAS_LDBL_SPRINTF_BUG */
9237 need += 20; /* fudge factor */
9238 if (PL_efloatsize < need) {
9239 Safefree(PL_efloatbuf);
9240 PL_efloatsize = need + 20; /* more fudge */
9241 Newx(PL_efloatbuf, PL_efloatsize, char);
9242 PL_efloatbuf[0] = '\0';
9245 if ( !(width || left || plus || alt) && fill != '0'
9246 && has_precis && intsize != 'q' ) { /* Shortcuts */
9247 /* See earlier comment about buggy Gconvert when digits,
9249 if ( c == 'g' && precis) {
9250 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9251 /* May return an empty string for digits==0 */
9252 if (*PL_efloatbuf) {
9253 elen = strlen(PL_efloatbuf);
9254 goto float_converted;
9256 } else if ( c == 'f' && !precis) {
9257 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9262 char *ptr = ebuf + sizeof ebuf;
9265 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9266 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9267 if (intsize == 'q') {
9268 /* Copy the one or more characters in a long double
9269 * format before the 'base' ([efgEFG]) character to
9270 * the format string. */
9271 static char const prifldbl[] = PERL_PRIfldbl;
9272 char const *p = prifldbl + sizeof(prifldbl) - 3;
9273 while (p >= prifldbl) { *--ptr = *p--; }
9278 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9283 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9295 /* No taint. Otherwise we are in the strange situation
9296 * where printf() taints but print($float) doesn't.
9298 #if defined(HAS_LONG_DOUBLE)
9299 elen = ((intsize == 'q')
9300 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9301 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9303 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9307 eptr = PL_efloatbuf;
9315 i = SvCUR(sv) - origlen;
9318 case 'h': *(va_arg(*args, short*)) = i; break;
9319 default: *(va_arg(*args, int*)) = i; break;
9320 case 'l': *(va_arg(*args, long*)) = i; break;
9321 case 'V': *(va_arg(*args, IV*)) = i; break;
9323 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9328 sv_setuv_mg(argsv, (UV)i);
9329 continue; /* not "break" */
9336 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9337 && ckWARN(WARN_PRINTF))
9339 SV * const msg = sv_newmortal();
9340 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9341 (PL_op->op_type == OP_PRTF) ? "" : "s");
9344 Perl_sv_catpvf(aTHX_ msg,
9345 "\"%%%c\"", c & 0xFF);
9347 Perl_sv_catpvf(aTHX_ msg,
9348 "\"%%\\%03"UVof"\"",
9351 sv_catpvs(msg, "end of string");
9352 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9355 /* output mangled stuff ... */
9361 /* ... right here, because formatting flags should not apply */
9362 SvGROW(sv, SvCUR(sv) + elen + 1);
9364 Copy(eptr, p, elen, char);
9367 SvCUR_set(sv, p - SvPVX_const(sv));
9369 continue; /* not "break" */
9372 if (is_utf8 != has_utf8) {
9375 sv_utf8_upgrade(sv);
9378 const STRLEN old_elen = elen;
9379 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9380 sv_utf8_upgrade(nsv);
9381 eptr = SvPVX_const(nsv);
9384 if (width) { /* fudge width (can't fudge elen) */
9385 width += elen - old_elen;
9391 have = esignlen + zeros + elen;
9393 Perl_croak_nocontext(PL_memory_wrap);
9395 need = (have > width ? have : width);
9398 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9399 Perl_croak_nocontext(PL_memory_wrap);
9400 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9402 if (esignlen && fill == '0') {
9404 for (i = 0; i < (int)esignlen; i++)
9408 memset(p, fill, gap);
9411 if (esignlen && fill != '0') {
9413 for (i = 0; i < (int)esignlen; i++)
9418 for (i = zeros; i; i--)
9422 Copy(eptr, p, elen, char);
9426 memset(p, ' ', gap);
9431 Copy(dotstr, p, dotstrlen, char);
9435 vectorize = FALSE; /* done iterating over vecstr */
9442 SvCUR_set(sv, p - SvPVX_const(sv));
9450 /* =========================================================================
9452 =head1 Cloning an interpreter
9454 All the macros and functions in this section are for the private use of
9455 the main function, perl_clone().
9457 The foo_dup() functions make an exact copy of an existing foo thinngy.
9458 During the course of a cloning, a hash table is used to map old addresses
9459 to new addresses. The table is created and manipulated with the
9460 ptr_table_* functions.
9464 ============================================================================*/
9467 #if defined(USE_ITHREADS)
9469 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9470 #ifndef GpREFCNT_inc
9471 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9475 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9476 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9477 If this changes, please unmerge ss_dup. */
9478 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9479 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9480 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9481 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9482 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9483 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9484 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9485 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9486 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9487 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9488 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9489 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9490 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9491 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9493 /* clone a parser */
9496 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9503 /* look for it in the table first */
9504 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9508 /* create anew and remember what it is */
9509 Newxz(parser, 1, yy_parser);
9510 ptr_table_store(PL_ptr_table, proto, parser);
9512 parser->yyerrstatus = 0;
9513 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9515 /* XXX these not yet duped */
9516 parser->old_parser = NULL;
9517 parser->stack = NULL;
9519 parser->stack_size = 0;
9520 /* XXX parser->stack->state = 0; */
9522 /* XXX eventually, just Copy() most of the parser struct ? */
9524 parser->lex_brackets = proto->lex_brackets;
9525 parser->lex_casemods = proto->lex_casemods;
9526 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9527 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9528 parser->lex_casestack = savepvn(proto->lex_casestack,
9529 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9530 parser->lex_defer = proto->lex_defer;
9531 parser->lex_dojoin = proto->lex_dojoin;
9532 parser->lex_expect = proto->lex_expect;
9533 parser->lex_formbrack = proto->lex_formbrack;
9534 parser->lex_inpat = proto->lex_inpat;
9535 parser->lex_inwhat = proto->lex_inwhat;
9536 parser->lex_op = proto->lex_op;
9537 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9538 parser->lex_starts = proto->lex_starts;
9539 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9540 parser->multi_close = proto->multi_close;
9541 parser->multi_open = proto->multi_open;
9542 parser->multi_start = proto->multi_start;
9543 parser->pending_ident = proto->pending_ident;
9544 parser->preambled = proto->preambled;
9545 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9548 parser->endwhite = proto->endwhite;
9549 parser->faketokens = proto->faketokens;
9550 parser->lasttoke = proto->lasttoke;
9551 parser->nextwhite = proto->nextwhite;
9552 parser->realtokenstart = proto->realtokenstart;
9553 parser->skipwhite = proto->skipwhite;
9554 parser->thisclose = proto->thisclose;
9555 parser->thismad = proto->thismad;
9556 parser->thisopen = proto->thisopen;
9557 parser->thisstuff = proto->thisstuff;
9558 parser->thistoken = proto->thistoken;
9559 parser->thiswhite = proto->thiswhite;
9565 /* duplicate a file handle */
9568 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9572 PERL_UNUSED_ARG(type);
9575 return (PerlIO*)NULL;
9577 /* look for it in the table first */
9578 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9582 /* create anew and remember what it is */
9583 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9584 ptr_table_store(PL_ptr_table, fp, ret);
9588 /* duplicate a directory handle */
9591 Perl_dirp_dup(pTHX_ DIR *dp)
9593 PERL_UNUSED_CONTEXT;
9600 /* duplicate a typeglob */
9603 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9609 /* look for it in the table first */
9610 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9614 /* create anew and remember what it is */
9616 ptr_table_store(PL_ptr_table, gp, ret);
9619 ret->gp_refcnt = 0; /* must be before any other dups! */
9620 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9621 ret->gp_io = io_dup_inc(gp->gp_io, param);
9622 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9623 ret->gp_av = av_dup_inc(gp->gp_av, param);
9624 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9625 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9626 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9627 ret->gp_cvgen = gp->gp_cvgen;
9628 ret->gp_line = gp->gp_line;
9629 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9633 /* duplicate a chain of magic */
9636 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9638 MAGIC *mgprev = (MAGIC*)NULL;
9641 return (MAGIC*)NULL;
9642 /* look for it in the table first */
9643 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9647 for (; mg; mg = mg->mg_moremagic) {
9649 Newxz(nmg, 1, MAGIC);
9651 mgprev->mg_moremagic = nmg;
9654 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9655 nmg->mg_private = mg->mg_private;
9656 nmg->mg_type = mg->mg_type;
9657 nmg->mg_flags = mg->mg_flags;
9658 if (mg->mg_type == PERL_MAGIC_qr) {
9659 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9661 else if(mg->mg_type == PERL_MAGIC_backref) {
9662 /* The backref AV has its reference count deliberately bumped by
9664 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9667 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9668 ? sv_dup_inc(mg->mg_obj, param)
9669 : sv_dup(mg->mg_obj, param);
9671 nmg->mg_len = mg->mg_len;
9672 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9673 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9674 if (mg->mg_len > 0) {
9675 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9676 if (mg->mg_type == PERL_MAGIC_overload_table &&
9677 AMT_AMAGIC((AMT*)mg->mg_ptr))
9679 const AMT * const amtp = (AMT*)mg->mg_ptr;
9680 AMT * const namtp = (AMT*)nmg->mg_ptr;
9682 for (i = 1; i < NofAMmeth; i++) {
9683 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9687 else if (mg->mg_len == HEf_SVKEY)
9688 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9690 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9691 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9698 #endif /* USE_ITHREADS */
9700 /* create a new pointer-mapping table */
9703 Perl_ptr_table_new(pTHX)
9706 PERL_UNUSED_CONTEXT;
9708 Newxz(tbl, 1, PTR_TBL_t);
9711 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9715 #define PTR_TABLE_HASH(ptr) \
9716 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9719 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9720 following define) and at call to new_body_inline made below in
9721 Perl_ptr_table_store()
9724 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9726 /* map an existing pointer using a table */
9728 STATIC PTR_TBL_ENT_t *
9729 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9730 PTR_TBL_ENT_t *tblent;
9731 const UV hash = PTR_TABLE_HASH(sv);
9733 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9734 for (; tblent; tblent = tblent->next) {
9735 if (tblent->oldval == sv)
9742 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9744 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9745 PERL_UNUSED_CONTEXT;
9746 return tblent ? tblent->newval : NULL;
9749 /* add a new entry to a pointer-mapping table */
9752 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9754 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9755 PERL_UNUSED_CONTEXT;
9758 tblent->newval = newsv;
9760 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9762 new_body_inline(tblent, PTE_SVSLOT);
9764 tblent->oldval = oldsv;
9765 tblent->newval = newsv;
9766 tblent->next = tbl->tbl_ary[entry];
9767 tbl->tbl_ary[entry] = tblent;
9769 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9770 ptr_table_split(tbl);
9774 /* double the hash bucket size of an existing ptr table */
9777 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9779 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9780 const UV oldsize = tbl->tbl_max + 1;
9781 UV newsize = oldsize * 2;
9783 PERL_UNUSED_CONTEXT;
9785 Renew(ary, newsize, PTR_TBL_ENT_t*);
9786 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9787 tbl->tbl_max = --newsize;
9789 for (i=0; i < oldsize; i++, ary++) {
9790 PTR_TBL_ENT_t **curentp, **entp, *ent;
9793 curentp = ary + oldsize;
9794 for (entp = ary, ent = *ary; ent; ent = *entp) {
9795 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9797 ent->next = *curentp;
9807 /* remove all the entries from a ptr table */
9810 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9812 if (tbl && tbl->tbl_items) {
9813 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9814 UV riter = tbl->tbl_max;
9817 PTR_TBL_ENT_t *entry = array[riter];
9820 PTR_TBL_ENT_t * const oentry = entry;
9821 entry = entry->next;
9830 /* clear and free a ptr table */
9833 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9838 ptr_table_clear(tbl);
9839 Safefree(tbl->tbl_ary);
9843 #if defined(USE_ITHREADS)
9846 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9849 SvRV_set(dstr, SvWEAKREF(sstr)
9850 ? sv_dup(SvRV(sstr), param)
9851 : sv_dup_inc(SvRV(sstr), param));
9854 else if (SvPVX_const(sstr)) {
9855 /* Has something there */
9857 /* Normal PV - clone whole allocated space */
9858 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9859 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9860 /* Not that normal - actually sstr is copy on write.
9861 But we are a true, independant SV, so: */
9862 SvREADONLY_off(dstr);
9867 /* Special case - not normally malloced for some reason */
9868 if (isGV_with_GP(sstr)) {
9869 /* Don't need to do anything here. */
9871 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9872 /* A "shared" PV - clone it as "shared" PV */
9874 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9878 /* Some other special case - random pointer */
9879 SvPV_set(dstr, SvPVX(sstr));
9885 if (SvTYPE(dstr) == SVt_RV)
9886 SvRV_set(dstr, NULL);
9888 SvPV_set(dstr, NULL);
9892 /* duplicate an SV of any type (including AV, HV etc) */
9895 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9900 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9902 /* look for it in the table first */
9903 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9907 if(param->flags & CLONEf_JOIN_IN) {
9908 /** We are joining here so we don't want do clone
9909 something that is bad **/
9910 if (SvTYPE(sstr) == SVt_PVHV) {
9911 const char * const hvname = HvNAME_get(sstr);
9913 /** don't clone stashes if they already exist **/
9914 return (SV*)gv_stashpv(hvname,0);
9918 /* create anew and remember what it is */
9921 #ifdef DEBUG_LEAKING_SCALARS
9922 dstr->sv_debug_optype = sstr->sv_debug_optype;
9923 dstr->sv_debug_line = sstr->sv_debug_line;
9924 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9925 dstr->sv_debug_cloned = 1;
9926 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9929 ptr_table_store(PL_ptr_table, sstr, dstr);
9932 SvFLAGS(dstr) = SvFLAGS(sstr);
9933 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9934 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9937 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9938 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9939 (void*)PL_watch_pvx, SvPVX_const(sstr));
9942 /* don't clone objects whose class has asked us not to */
9943 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9944 SvFLAGS(dstr) &= ~SVTYPEMASK;
9949 switch (SvTYPE(sstr)) {
9954 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9955 SvIV_set(dstr, SvIVX(sstr));
9958 SvANY(dstr) = new_XNV();
9959 SvNV_set(dstr, SvNVX(sstr));
9962 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9963 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9965 /* case SVt_BIND: */
9968 /* These are all the types that need complex bodies allocating. */
9970 const svtype sv_type = SvTYPE(sstr);
9971 const struct body_details *const sv_type_details
9972 = bodies_by_type + sv_type;
9976 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9980 if (GvUNIQUE((GV*)sstr)) {
9981 NOOP; /* Do sharing here, and fall through */
9993 assert(sv_type_details->body_size);
9994 if (sv_type_details->arena) {
9995 new_body_inline(new_body, sv_type);
9997 = (void*)((char*)new_body - sv_type_details->offset);
9999 new_body = new_NOARENA(sv_type_details);
10003 SvANY(dstr) = new_body;
10006 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10007 ((char*)SvANY(dstr)) + sv_type_details->offset,
10008 sv_type_details->copy, char);
10010 Copy(((char*)SvANY(sstr)),
10011 ((char*)SvANY(dstr)),
10012 sv_type_details->body_size + sv_type_details->offset, char);
10015 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10016 && !isGV_with_GP(dstr))
10017 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10019 /* The Copy above means that all the source (unduplicated) pointers
10020 are now in the destination. We can check the flags and the
10021 pointers in either, but it's possible that there's less cache
10022 missing by always going for the destination.
10023 FIXME - instrument and check that assumption */
10024 if (sv_type >= SVt_PVMG) {
10025 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10026 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10027 } else if (SvMAGIC(dstr))
10028 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10030 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10033 /* The cast silences a GCC warning about unhandled types. */
10034 switch ((int)sv_type) {
10044 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10045 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10046 LvTARG(dstr) = dstr;
10047 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10048 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10050 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10052 if(isGV_with_GP(sstr)) {
10053 if (GvNAME_HEK(dstr))
10054 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10055 /* Don't call sv_add_backref here as it's going to be
10056 created as part of the magic cloning of the symbol
10058 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10059 at the point of this comment. */
10060 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10061 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10062 (void)GpREFCNT_inc(GvGP(dstr));
10064 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10067 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10068 if (IoOFP(dstr) == IoIFP(sstr))
10069 IoOFP(dstr) = IoIFP(dstr);
10071 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10072 /* PL_rsfp_filters entries have fake IoDIRP() */
10073 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10074 /* I have no idea why fake dirp (rsfps)
10075 should be treated differently but otherwise
10076 we end up with leaks -- sky*/
10077 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10078 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10079 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10081 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10082 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10083 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10084 if (IoDIRP(dstr)) {
10085 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10088 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10091 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10092 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10093 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10096 if (AvARRAY((AV*)sstr)) {
10097 SV **dst_ary, **src_ary;
10098 SSize_t items = AvFILLp((AV*)sstr) + 1;
10100 src_ary = AvARRAY((AV*)sstr);
10101 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10102 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10103 AvARRAY((AV*)dstr) = dst_ary;
10104 AvALLOC((AV*)dstr) = dst_ary;
10105 if (AvREAL((AV*)sstr)) {
10106 while (items-- > 0)
10107 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10110 while (items-- > 0)
10111 *dst_ary++ = sv_dup(*src_ary++, param);
10113 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10114 while (items-- > 0) {
10115 *dst_ary++ = &PL_sv_undef;
10119 AvARRAY((AV*)dstr) = NULL;
10120 AvALLOC((AV*)dstr) = (SV**)NULL;
10124 if (HvARRAY((HV*)sstr)) {
10126 const bool sharekeys = !!HvSHAREKEYS(sstr);
10127 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10128 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10130 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10131 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10133 HvARRAY(dstr) = (HE**)darray;
10134 while (i <= sxhv->xhv_max) {
10135 const HE * const source = HvARRAY(sstr)[i];
10136 HvARRAY(dstr)[i] = source
10137 ? he_dup(source, sharekeys, param) : 0;
10142 const struct xpvhv_aux * const saux = HvAUX(sstr);
10143 struct xpvhv_aux * const daux = HvAUX(dstr);
10144 /* This flag isn't copied. */
10145 /* SvOOK_on(hv) attacks the IV flags. */
10146 SvFLAGS(dstr) |= SVf_OOK;
10148 hvname = saux->xhv_name;
10149 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10151 daux->xhv_riter = saux->xhv_riter;
10152 daux->xhv_eiter = saux->xhv_eiter
10153 ? he_dup(saux->xhv_eiter,
10154 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10155 daux->xhv_backreferences =
10156 saux->xhv_backreferences
10157 ? (AV*) SvREFCNT_inc(
10158 sv_dup((SV*)saux->xhv_backreferences, param))
10161 daux->xhv_mro_meta = saux->xhv_mro_meta
10162 ? mro_meta_dup(saux->xhv_mro_meta, param)
10165 /* Record stashes for possible cloning in Perl_clone(). */
10167 av_push(param->stashes, dstr);
10171 HvARRAY((HV*)dstr) = NULL;
10174 if (!(param->flags & CLONEf_COPY_STACKS)) {
10178 /* NOTE: not refcounted */
10179 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10181 if (!CvISXSUB(dstr))
10182 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10184 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10185 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10186 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10187 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10189 /* don't dup if copying back - CvGV isn't refcounted, so the
10190 * duped GV may never be freed. A bit of a hack! DAPM */
10191 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10192 NULL : gv_dup(CvGV(dstr), param) ;
10193 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10195 CvWEAKOUTSIDE(sstr)
10196 ? cv_dup( CvOUTSIDE(dstr), param)
10197 : cv_dup_inc(CvOUTSIDE(dstr), param);
10198 if (!CvISXSUB(dstr))
10199 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10205 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10211 /* duplicate a context */
10214 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10216 PERL_CONTEXT *ncxs;
10219 return (PERL_CONTEXT*)NULL;
10221 /* look for it in the table first */
10222 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10226 /* create anew and remember what it is */
10227 Newxz(ncxs, max + 1, PERL_CONTEXT);
10228 ptr_table_store(PL_ptr_table, cxs, ncxs);
10231 PERL_CONTEXT * const cx = &cxs[ix];
10232 PERL_CONTEXT * const ncx = &ncxs[ix];
10233 ncx->cx_type = cx->cx_type;
10234 if (CxTYPE(cx) == CXt_SUBST) {
10235 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10238 ncx->blk_oldsp = cx->blk_oldsp;
10239 ncx->blk_oldcop = cx->blk_oldcop;
10240 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10241 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10242 ncx->blk_oldpm = cx->blk_oldpm;
10243 ncx->blk_gimme = cx->blk_gimme;
10244 switch (CxTYPE(cx)) {
10246 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10247 ? cv_dup_inc(cx->blk_sub.cv, param)
10248 : cv_dup(cx->blk_sub.cv,param));
10249 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10250 ? av_dup_inc(cx->blk_sub.argarray, param)
10252 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10253 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10254 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10255 ncx->blk_sub.lval = cx->blk_sub.lval;
10256 ncx->blk_sub.retop = cx->blk_sub.retop;
10257 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10258 cx->blk_sub.oldcomppad);
10261 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10262 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10263 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10264 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10265 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10266 ncx->blk_eval.retop = cx->blk_eval.retop;
10269 ncx->blk_loop.label = cx->blk_loop.label;
10270 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10271 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10272 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10273 ? cx->blk_loop.iterdata
10274 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10275 ncx->blk_loop.oldcomppad
10276 = (PAD*)ptr_table_fetch(PL_ptr_table,
10277 cx->blk_loop.oldcomppad);
10278 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10279 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10280 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10281 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10282 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10285 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10286 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10287 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10288 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10289 ncx->blk_sub.retop = cx->blk_sub.retop;
10301 /* duplicate a stack info structure */
10304 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10309 return (PERL_SI*)NULL;
10311 /* look for it in the table first */
10312 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10316 /* create anew and remember what it is */
10317 Newxz(nsi, 1, PERL_SI);
10318 ptr_table_store(PL_ptr_table, si, nsi);
10320 nsi->si_stack = av_dup_inc(si->si_stack, param);
10321 nsi->si_cxix = si->si_cxix;
10322 nsi->si_cxmax = si->si_cxmax;
10323 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10324 nsi->si_type = si->si_type;
10325 nsi->si_prev = si_dup(si->si_prev, param);
10326 nsi->si_next = si_dup(si->si_next, param);
10327 nsi->si_markoff = si->si_markoff;
10332 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10333 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10334 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10335 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10336 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10337 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10338 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10339 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10340 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10341 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10342 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10343 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10344 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10345 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10348 #define pv_dup_inc(p) SAVEPV(p)
10349 #define pv_dup(p) SAVEPV(p)
10350 #define svp_dup_inc(p,pp) any_dup(p,pp)
10352 /* map any object to the new equivent - either something in the
10353 * ptr table, or something in the interpreter structure
10357 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10362 return (void*)NULL;
10364 /* look for it in the table first */
10365 ret = ptr_table_fetch(PL_ptr_table, v);
10369 /* see if it is part of the interpreter structure */
10370 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10371 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10379 /* duplicate the save stack */
10382 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10385 ANY * const ss = proto_perl->Tsavestack;
10386 const I32 max = proto_perl->Tsavestack_max;
10387 I32 ix = proto_perl->Tsavestack_ix;
10400 void (*dptr) (void*);
10401 void (*dxptr) (pTHX_ void*);
10403 Newxz(nss, max, ANY);
10406 const I32 type = POPINT(ss,ix);
10407 TOPINT(nss,ix) = type;
10409 case SAVEt_HELEM: /* hash element */
10410 sv = (SV*)POPPTR(ss,ix);
10411 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10413 case SAVEt_ITEM: /* normal string */
10414 case SAVEt_SV: /* scalar reference */
10415 sv = (SV*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10419 case SAVEt_MORTALIZESV:
10420 sv = (SV*)POPPTR(ss,ix);
10421 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10423 case SAVEt_SHARED_PVREF: /* char* in shared space */
10424 c = (char*)POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = savesharedpv(c);
10426 ptr = POPPTR(ss,ix);
10427 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10429 case SAVEt_GENERIC_SVREF: /* generic sv */
10430 case SAVEt_SVREF: /* scalar reference */
10431 sv = (SV*)POPPTR(ss,ix);
10432 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10433 ptr = POPPTR(ss,ix);
10434 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10436 case SAVEt_HV: /* hash reference */
10437 case SAVEt_AV: /* array reference */
10438 sv = (SV*) POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10441 case SAVEt_COMPPAD:
10443 sv = (SV*) POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = sv_dup(sv, param);
10446 case SAVEt_INT: /* int reference */
10447 ptr = POPPTR(ss,ix);
10448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10449 intval = (int)POPINT(ss,ix);
10450 TOPINT(nss,ix) = intval;
10452 case SAVEt_LONG: /* long reference */
10453 ptr = POPPTR(ss,ix);
10454 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10456 case SAVEt_CLEARSV:
10457 longval = (long)POPLONG(ss,ix);
10458 TOPLONG(nss,ix) = longval;
10460 case SAVEt_I32: /* I32 reference */
10461 case SAVEt_I16: /* I16 reference */
10462 case SAVEt_I8: /* I8 reference */
10463 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10464 ptr = POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10467 TOPINT(nss,ix) = i;
10469 case SAVEt_IV: /* IV reference */
10470 ptr = POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10473 TOPIV(nss,ix) = iv;
10475 case SAVEt_HPTR: /* HV* reference */
10476 case SAVEt_APTR: /* AV* reference */
10477 case SAVEt_SPTR: /* SV* reference */
10478 ptr = POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10480 sv = (SV*)POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = sv_dup(sv, param);
10483 case SAVEt_VPTR: /* random* reference */
10484 ptr = POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 ptr = POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10489 case SAVEt_GENERIC_PVREF: /* generic char* */
10490 case SAVEt_PPTR: /* char* reference */
10491 ptr = POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10493 c = (char*)POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = pv_dup(c);
10496 case SAVEt_GP: /* scalar reference */
10497 gp = (GP*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10499 (void)GpREFCNT_inc(gp);
10500 gv = (GV*)POPPTR(ss,ix);
10501 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10504 ptr = POPPTR(ss,ix);
10505 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10506 /* these are assumed to be refcounted properly */
10508 switch (((OP*)ptr)->op_type) {
10510 case OP_LEAVESUBLV:
10514 case OP_LEAVEWRITE:
10515 TOPPTR(nss,ix) = ptr;
10518 (void) OpREFCNT_inc(o);
10522 TOPPTR(nss,ix) = NULL;
10527 TOPPTR(nss,ix) = NULL;
10530 c = (char*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = pv_dup_inc(c);
10534 hv = (HV*)POPPTR(ss,ix);
10535 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10536 c = (char*)POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = pv_dup_inc(c);
10539 case SAVEt_STACK_POS: /* Position on Perl stack */
10541 TOPINT(nss,ix) = i;
10543 case SAVEt_DESTRUCTOR:
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10546 dptr = POPDPTR(ss,ix);
10547 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10548 any_dup(FPTR2DPTR(void *, dptr),
10551 case SAVEt_DESTRUCTOR_X:
10552 ptr = POPPTR(ss,ix);
10553 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10554 dxptr = POPDXPTR(ss,ix);
10555 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10556 any_dup(FPTR2DPTR(void *, dxptr),
10559 case SAVEt_REGCONTEXT:
10562 TOPINT(nss,ix) = i;
10565 case SAVEt_AELEM: /* array element */
10566 sv = (SV*)POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10569 TOPINT(nss,ix) = i;
10570 av = (AV*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = av_dup_inc(av, param);
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = ptr;
10579 TOPINT(nss,ix) = i;
10580 ptr = POPPTR(ss,ix);
10583 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10584 HINTS_REFCNT_UNLOCK;
10586 TOPPTR(nss,ix) = ptr;
10587 if (i & HINT_LOCALIZE_HH) {
10588 hv = (HV*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10593 longval = (long)POPLONG(ss,ix);
10594 TOPLONG(nss,ix) = longval;
10595 ptr = POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 sv = (SV*)POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = sv_dup(sv, param);
10601 ptr = POPPTR(ss,ix);
10602 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10603 longval = (long)POPBOOL(ss,ix);
10604 TOPBOOL(nss,ix) = (bool)longval;
10606 case SAVEt_SET_SVFLAGS:
10608 TOPINT(nss,ix) = i;
10610 TOPINT(nss,ix) = i;
10611 sv = (SV*)POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = sv_dup(sv, param);
10614 case SAVEt_RE_STATE:
10616 const struct re_save_state *const old_state
10617 = (struct re_save_state *)
10618 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10619 struct re_save_state *const new_state
10620 = (struct re_save_state *)
10621 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10623 Copy(old_state, new_state, 1, struct re_save_state);
10624 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10626 new_state->re_state_bostr
10627 = pv_dup(old_state->re_state_bostr);
10628 new_state->re_state_reginput
10629 = pv_dup(old_state->re_state_reginput);
10630 new_state->re_state_regeol
10631 = pv_dup(old_state->re_state_regeol);
10632 new_state->re_state_regoffs
10633 = (regexp_paren_pair*)
10634 any_dup(old_state->re_state_regoffs, proto_perl);
10635 new_state->re_state_reglastparen
10636 = (U32*) any_dup(old_state->re_state_reglastparen,
10638 new_state->re_state_reglastcloseparen
10639 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10641 /* XXX This just has to be broken. The old save_re_context
10642 code did SAVEGENERICPV(PL_reg_start_tmp);
10643 PL_reg_start_tmp is char **.
10644 Look above to what the dup code does for
10645 SAVEt_GENERIC_PVREF
10646 It can never have worked.
10647 So this is merely a faithful copy of the exiting bug: */
10648 new_state->re_state_reg_start_tmp
10649 = (char **) pv_dup((char *)
10650 old_state->re_state_reg_start_tmp);
10651 /* I assume that it only ever "worked" because no-one called
10652 (pseudo)fork while the regexp engine had re-entered itself.
10654 #ifdef PERL_OLD_COPY_ON_WRITE
10655 new_state->re_state_nrs
10656 = sv_dup(old_state->re_state_nrs, param);
10658 new_state->re_state_reg_magic
10659 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10661 new_state->re_state_reg_oldcurpm
10662 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10664 new_state->re_state_reg_curpm
10665 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10667 new_state->re_state_reg_oldsaved
10668 = pv_dup(old_state->re_state_reg_oldsaved);
10669 new_state->re_state_reg_poscache
10670 = pv_dup(old_state->re_state_reg_poscache);
10671 new_state->re_state_reg_starttry
10672 = pv_dup(old_state->re_state_reg_starttry);
10675 case SAVEt_COMPILE_WARNINGS:
10676 ptr = POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10680 ptr = POPPTR(ss,ix);
10681 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10685 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10693 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10694 * flag to the result. This is done for each stash before cloning starts,
10695 * so we know which stashes want their objects cloned */
10698 do_mark_cloneable_stash(pTHX_ SV *sv)
10700 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10702 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10703 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10704 if (cloner && GvCV(cloner)) {
10711 XPUSHs(sv_2mortal(newSVhek(hvname)));
10713 call_sv((SV*)GvCV(cloner), G_SCALAR);
10720 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10728 =for apidoc perl_clone
10730 Create and return a new interpreter by cloning the current one.
10732 perl_clone takes these flags as parameters:
10734 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10735 without it we only clone the data and zero the stacks,
10736 with it we copy the stacks and the new perl interpreter is
10737 ready to run at the exact same point as the previous one.
10738 The pseudo-fork code uses COPY_STACKS while the
10739 threads->create doesn't.
10741 CLONEf_KEEP_PTR_TABLE
10742 perl_clone keeps a ptr_table with the pointer of the old
10743 variable as a key and the new variable as a value,
10744 this allows it to check if something has been cloned and not
10745 clone it again but rather just use the value and increase the
10746 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10747 the ptr_table using the function
10748 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10749 reason to keep it around is if you want to dup some of your own
10750 variable who are outside the graph perl scans, example of this
10751 code is in threads.xs create
10754 This is a win32 thing, it is ignored on unix, it tells perls
10755 win32host code (which is c++) to clone itself, this is needed on
10756 win32 if you want to run two threads at the same time,
10757 if you just want to do some stuff in a separate perl interpreter
10758 and then throw it away and return to the original one,
10759 you don't need to do anything.
10764 /* XXX the above needs expanding by someone who actually understands it ! */
10765 EXTERN_C PerlInterpreter *
10766 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10769 perl_clone(PerlInterpreter *proto_perl, UV flags)
10772 #ifdef PERL_IMPLICIT_SYS
10774 /* perlhost.h so we need to call into it
10775 to clone the host, CPerlHost should have a c interface, sky */
10777 if (flags & CLONEf_CLONE_HOST) {
10778 return perl_clone_host(proto_perl,flags);
10780 return perl_clone_using(proto_perl, flags,
10782 proto_perl->IMemShared,
10783 proto_perl->IMemParse,
10785 proto_perl->IStdIO,
10789 proto_perl->IProc);
10793 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10794 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10795 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10796 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10797 struct IPerlDir* ipD, struct IPerlSock* ipS,
10798 struct IPerlProc* ipP)
10800 /* XXX many of the string copies here can be optimized if they're
10801 * constants; they need to be allocated as common memory and just
10802 * their pointers copied. */
10805 CLONE_PARAMS clone_params;
10806 CLONE_PARAMS* const param = &clone_params;
10808 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10809 /* for each stash, determine whether its objects should be cloned */
10810 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10811 PERL_SET_THX(my_perl);
10814 PoisonNew(my_perl, 1, PerlInterpreter);
10820 PL_savestack_ix = 0;
10821 PL_savestack_max = -1;
10822 PL_sig_pending = 0;
10823 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10824 # else /* !DEBUGGING */
10825 Zero(my_perl, 1, PerlInterpreter);
10826 # endif /* DEBUGGING */
10828 /* host pointers */
10830 PL_MemShared = ipMS;
10831 PL_MemParse = ipMP;
10838 #else /* !PERL_IMPLICIT_SYS */
10840 CLONE_PARAMS clone_params;
10841 CLONE_PARAMS* param = &clone_params;
10842 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10843 /* for each stash, determine whether its objects should be cloned */
10844 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10845 PERL_SET_THX(my_perl);
10848 PoisonNew(my_perl, 1, PerlInterpreter);
10854 PL_savestack_ix = 0;
10855 PL_savestack_max = -1;
10856 PL_sig_pending = 0;
10857 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10858 # else /* !DEBUGGING */
10859 Zero(my_perl, 1, PerlInterpreter);
10860 # endif /* DEBUGGING */
10861 #endif /* PERL_IMPLICIT_SYS */
10862 param->flags = flags;
10863 param->proto_perl = proto_perl;
10865 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10867 PL_body_arenas = NULL;
10868 Zero(&PL_body_roots, 1, PL_body_roots);
10870 PL_nice_chunk = NULL;
10871 PL_nice_chunk_size = 0;
10873 PL_sv_objcount = 0;
10875 PL_sv_arenaroot = NULL;
10877 PL_debug = proto_perl->Idebug;
10879 PL_hash_seed = proto_perl->Ihash_seed;
10880 PL_rehash_seed = proto_perl->Irehash_seed;
10882 #ifdef USE_REENTRANT_API
10883 /* XXX: things like -Dm will segfault here in perlio, but doing
10884 * PERL_SET_CONTEXT(proto_perl);
10885 * breaks too many other things
10887 Perl_reentrant_init(aTHX);
10890 /* create SV map for pointer relocation */
10891 PL_ptr_table = ptr_table_new();
10893 /* initialize these special pointers as early as possible */
10894 SvANY(&PL_sv_undef) = NULL;
10895 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10896 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10897 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10899 SvANY(&PL_sv_no) = new_XPVNV();
10900 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10901 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10902 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10903 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10904 SvCUR_set(&PL_sv_no, 0);
10905 SvLEN_set(&PL_sv_no, 1);
10906 SvIV_set(&PL_sv_no, 0);
10907 SvNV_set(&PL_sv_no, 0);
10908 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10910 SvANY(&PL_sv_yes) = new_XPVNV();
10911 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10912 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10913 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10914 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10915 SvCUR_set(&PL_sv_yes, 1);
10916 SvLEN_set(&PL_sv_yes, 2);
10917 SvIV_set(&PL_sv_yes, 1);
10918 SvNV_set(&PL_sv_yes, 1);
10919 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10921 /* create (a non-shared!) shared string table */
10922 PL_strtab = newHV();
10923 HvSHAREKEYS_off(PL_strtab);
10924 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10925 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10927 PL_compiling = proto_perl->Icompiling;
10929 /* These two PVs will be free'd special way so must set them same way op.c does */
10930 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10931 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10933 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10934 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10936 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10937 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10938 if (PL_compiling.cop_hints_hash) {
10940 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10941 HINTS_REFCNT_UNLOCK;
10943 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10944 #ifdef PERL_DEBUG_READONLY_OPS
10949 /* pseudo environmental stuff */
10950 PL_origargc = proto_perl->Iorigargc;
10951 PL_origargv = proto_perl->Iorigargv;
10953 param->stashes = newAV(); /* Setup array of objects to call clone on */
10955 /* Set tainting stuff before PerlIO_debug can possibly get called */
10956 PL_tainting = proto_perl->Itainting;
10957 PL_taint_warn = proto_perl->Itaint_warn;
10959 #ifdef PERLIO_LAYERS
10960 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10961 PerlIO_clone(aTHX_ proto_perl, param);
10964 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10965 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10966 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10967 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10968 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10969 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10972 PL_minus_c = proto_perl->Iminus_c;
10973 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10974 PL_localpatches = proto_perl->Ilocalpatches;
10975 PL_splitstr = proto_perl->Isplitstr;
10976 PL_preprocess = proto_perl->Ipreprocess;
10977 PL_minus_n = proto_perl->Iminus_n;
10978 PL_minus_p = proto_perl->Iminus_p;
10979 PL_minus_l = proto_perl->Iminus_l;
10980 PL_minus_a = proto_perl->Iminus_a;
10981 PL_minus_E = proto_perl->Iminus_E;
10982 PL_minus_F = proto_perl->Iminus_F;
10983 PL_doswitches = proto_perl->Idoswitches;
10984 PL_dowarn = proto_perl->Idowarn;
10985 PL_doextract = proto_perl->Idoextract;
10986 PL_sawampersand = proto_perl->Isawampersand;
10987 PL_unsafe = proto_perl->Iunsafe;
10988 PL_inplace = SAVEPV(proto_perl->Iinplace);
10989 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10990 PL_perldb = proto_perl->Iperldb;
10991 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10992 PL_exit_flags = proto_perl->Iexit_flags;
10994 /* magical thingies */
10995 /* XXX time(&PL_basetime) when asked for? */
10996 PL_basetime = proto_perl->Ibasetime;
10997 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10999 PL_maxsysfd = proto_perl->Imaxsysfd;
11000 PL_statusvalue = proto_perl->Istatusvalue;
11002 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11004 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11006 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11008 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11009 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11010 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11013 /* RE engine related */
11014 Zero(&PL_reg_state, 1, struct re_save_state);
11015 PL_reginterp_cnt = 0;
11016 PL_regmatch_slab = NULL;
11018 /* Clone the regex array */
11019 PL_regex_padav = newAV();
11021 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11022 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11024 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11025 for(i = 1; i <= len; i++) {
11026 const SV * const regex = regexen[i];
11029 ? sv_dup_inc(regex, param)
11031 newSViv(PTR2IV(CALLREGDUPE(
11032 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11034 if (SvFLAGS(regex) & SVf_BREAK)
11035 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11036 av_push(PL_regex_padav, sv);
11039 PL_regex_pad = AvARRAY(PL_regex_padav);
11041 /* shortcuts to various I/O objects */
11042 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11043 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11044 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11045 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11046 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11047 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11049 /* shortcuts to regexp stuff */
11050 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11052 /* shortcuts to misc objects */
11053 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11055 /* shortcuts to debugging objects */
11056 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11057 PL_DBline = gv_dup(proto_perl->IDBline, param);
11058 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11059 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11060 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11061 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11062 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11063 PL_lineary = av_dup(proto_perl->Ilineary, param);
11064 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11066 /* symbol tables */
11067 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11068 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11069 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11070 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11071 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11073 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11074 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11075 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11076 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11077 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11078 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11079 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11080 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11082 PL_sub_generation = proto_perl->Isub_generation;
11084 /* funky return mechanisms */
11085 PL_forkprocess = proto_perl->Iforkprocess;
11087 /* subprocess state */
11088 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11090 /* internal state */
11091 PL_maxo = proto_perl->Imaxo;
11092 if (proto_perl->Iop_mask)
11093 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11096 /* PL_asserting = proto_perl->Iasserting; */
11098 /* current interpreter roots */
11099 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11101 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11103 PL_main_start = proto_perl->Imain_start;
11104 PL_eval_root = proto_perl->Ieval_root;
11105 PL_eval_start = proto_perl->Ieval_start;
11107 /* runtime control stuff */
11108 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11109 PL_copline = proto_perl->Icopline;
11111 PL_filemode = proto_perl->Ifilemode;
11112 PL_lastfd = proto_perl->Ilastfd;
11113 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11116 PL_gensym = proto_perl->Igensym;
11117 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11118 PL_laststatval = proto_perl->Ilaststatval;
11119 PL_laststype = proto_perl->Ilaststype;
11122 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11124 /* interpreter atexit processing */
11125 PL_exitlistlen = proto_perl->Iexitlistlen;
11126 if (PL_exitlistlen) {
11127 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11128 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11131 PL_exitlist = (PerlExitListEntry*)NULL;
11133 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11134 if (PL_my_cxt_size) {
11135 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11136 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11137 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11138 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11139 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11143 PL_my_cxt_list = (void**)NULL;
11144 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11145 PL_my_cxt_keys = (const char**)NULL;
11148 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11149 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11150 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11152 PL_profiledata = NULL;
11153 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11154 /* PL_rsfp_filters entries have fake IoDIRP() */
11155 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11157 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11159 PAD_CLONE_VARS(proto_perl, param);
11161 #ifdef HAVE_INTERP_INTERN
11162 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11165 /* more statics moved here */
11166 PL_generation = proto_perl->Igeneration;
11167 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11169 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11170 PL_in_clean_all = proto_perl->Iin_clean_all;
11172 PL_uid = proto_perl->Iuid;
11173 PL_euid = proto_perl->Ieuid;
11174 PL_gid = proto_perl->Igid;
11175 PL_egid = proto_perl->Iegid;
11176 PL_nomemok = proto_perl->Inomemok;
11177 PL_an = proto_perl->Ian;
11178 PL_evalseq = proto_perl->Ievalseq;
11179 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11180 PL_origalen = proto_perl->Iorigalen;
11181 #ifdef PERL_USES_PL_PIDSTATUS
11182 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11184 PL_osname = SAVEPV(proto_perl->Iosname);
11185 PL_sighandlerp = proto_perl->Isighandlerp;
11187 PL_runops = proto_perl->Irunops;
11189 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11192 PL_cshlen = proto_perl->Icshlen;
11193 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11196 PL_parser = parser_dup(proto_perl->Iparser, param);
11198 PL_lex_state = proto_perl->Ilex_state;
11201 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11202 PL_curforce = proto_perl->Icurforce;
11204 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11205 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11206 PL_nexttoke = proto_perl->Inexttoke;
11209 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11210 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11211 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11213 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11214 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11215 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11216 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11217 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11218 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11220 PL_expect = proto_perl->Iexpect;
11222 PL_multi_end = proto_perl->Imulti_end;
11224 PL_error_count = proto_perl->Ierror_count;
11225 PL_subline = proto_perl->Isubline;
11226 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11228 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11229 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11230 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11231 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11232 PL_last_lop_op = proto_perl->Ilast_lop_op;
11233 PL_in_my = proto_perl->Iin_my;
11234 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11236 PL_cryptseen = proto_perl->Icryptseen;
11239 PL_hints = proto_perl->Ihints;
11241 PL_amagic_generation = proto_perl->Iamagic_generation;
11243 #ifdef USE_LOCALE_COLLATE
11244 PL_collation_ix = proto_perl->Icollation_ix;
11245 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11246 PL_collation_standard = proto_perl->Icollation_standard;
11247 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11248 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11249 #endif /* USE_LOCALE_COLLATE */
11251 #ifdef USE_LOCALE_NUMERIC
11252 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11253 PL_numeric_standard = proto_perl->Inumeric_standard;
11254 PL_numeric_local = proto_perl->Inumeric_local;
11255 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11256 #endif /* !USE_LOCALE_NUMERIC */
11258 /* utf8 character classes */
11259 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11260 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11261 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11262 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11263 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11264 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11265 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11266 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11267 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11268 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11269 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11270 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11271 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11272 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11273 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11274 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11275 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11276 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11277 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11278 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11280 /* Did the locale setup indicate UTF-8? */
11281 PL_utf8locale = proto_perl->Iutf8locale;
11282 /* Unicode features (see perlrun/-C) */
11283 PL_unicode = proto_perl->Iunicode;
11285 /* Pre-5.8 signals control */
11286 PL_signals = proto_perl->Isignals;
11288 /* times() ticks per second */
11289 PL_clocktick = proto_perl->Iclocktick;
11291 /* Recursion stopper for PerlIO_find_layer */
11292 PL_in_load_module = proto_perl->Iin_load_module;
11294 /* sort() routine */
11295 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11297 /* Not really needed/useful since the reenrant_retint is "volatile",
11298 * but do it for consistency's sake. */
11299 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11301 /* Hooks to shared SVs and locks. */
11302 PL_sharehook = proto_perl->Isharehook;
11303 PL_lockhook = proto_perl->Ilockhook;
11304 PL_unlockhook = proto_perl->Iunlockhook;
11305 PL_threadhook = proto_perl->Ithreadhook;
11307 PL_runops_std = proto_perl->Irunops_std;
11308 PL_runops_dbg = proto_perl->Irunops_dbg;
11310 #ifdef THREADS_HAVE_PIDS
11311 PL_ppid = proto_perl->Ippid;
11315 PL_last_swash_hv = NULL; /* reinits on demand */
11316 PL_last_swash_klen = 0;
11317 PL_last_swash_key[0]= '\0';
11318 PL_last_swash_tmps = (U8*)NULL;
11319 PL_last_swash_slen = 0;
11321 PL_glob_index = proto_perl->Iglob_index;
11322 PL_srand_called = proto_perl->Isrand_called;
11323 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11324 PL_bitcount = NULL; /* reinits on demand */
11326 if (proto_perl->Ipsig_pend) {
11327 Newxz(PL_psig_pend, SIG_SIZE, int);
11330 PL_psig_pend = (int*)NULL;
11333 if (proto_perl->Ipsig_ptr) {
11334 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11335 Newxz(PL_psig_name, SIG_SIZE, SV*);
11336 for (i = 1; i < SIG_SIZE; i++) {
11337 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11338 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11342 PL_psig_ptr = (SV**)NULL;
11343 PL_psig_name = (SV**)NULL;
11346 /* thrdvar.h stuff */
11348 if (flags & CLONEf_COPY_STACKS) {
11349 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11350 PL_tmps_ix = proto_perl->Ttmps_ix;
11351 PL_tmps_max = proto_perl->Ttmps_max;
11352 PL_tmps_floor = proto_perl->Ttmps_floor;
11353 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11355 while (i <= PL_tmps_ix) {
11356 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11360 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11361 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11362 Newxz(PL_markstack, i, I32);
11363 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11364 - proto_perl->Tmarkstack);
11365 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11366 - proto_perl->Tmarkstack);
11367 Copy(proto_perl->Tmarkstack, PL_markstack,
11368 PL_markstack_ptr - PL_markstack + 1, I32);
11370 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11371 * NOTE: unlike the others! */
11372 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11373 PL_scopestack_max = proto_perl->Tscopestack_max;
11374 Newxz(PL_scopestack, PL_scopestack_max, I32);
11375 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11377 /* NOTE: si_dup() looks at PL_markstack */
11378 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11380 /* PL_curstack = PL_curstackinfo->si_stack; */
11381 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11382 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11384 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11385 PL_stack_base = AvARRAY(PL_curstack);
11386 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11387 - proto_perl->Tstack_base);
11388 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11390 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11391 * NOTE: unlike the others! */
11392 PL_savestack_ix = proto_perl->Tsavestack_ix;
11393 PL_savestack_max = proto_perl->Tsavestack_max;
11394 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11395 PL_savestack = ss_dup(proto_perl, param);
11399 ENTER; /* perl_destruct() wants to LEAVE; */
11401 /* although we're not duplicating the tmps stack, we should still
11402 * add entries for any SVs on the tmps stack that got cloned by a
11403 * non-refcount means (eg a temp in @_); otherwise they will be
11406 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11407 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11408 proto_perl->Ttmps_stack[i]);
11409 if (nsv && !SvREFCNT(nsv)) {
11411 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11416 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11417 PL_top_env = &PL_start_env;
11419 PL_op = proto_perl->Top;
11422 PL_Xpv = (XPV*)NULL;
11423 PL_na = proto_perl->Tna;
11425 PL_statbuf = proto_perl->Tstatbuf;
11426 PL_statcache = proto_perl->Tstatcache;
11427 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11428 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11430 PL_timesbuf = proto_perl->Ttimesbuf;
11433 PL_tainted = proto_perl->Ttainted;
11434 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11435 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11436 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11437 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11438 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11439 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11440 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11441 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11442 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11444 PL_restartop = proto_perl->Trestartop;
11445 PL_in_eval = proto_perl->Tin_eval;
11446 PL_delaymagic = proto_perl->Tdelaymagic;
11447 PL_dirty = proto_perl->Tdirty;
11448 PL_localizing = proto_perl->Tlocalizing;
11450 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11451 PL_hv_fetch_ent_mh = NULL;
11452 PL_modcount = proto_perl->Tmodcount;
11453 PL_lastgotoprobe = NULL;
11454 PL_dumpindent = proto_perl->Tdumpindent;
11456 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11457 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11458 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11459 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11460 PL_efloatbuf = NULL; /* reinits on demand */
11461 PL_efloatsize = 0; /* reinits on demand */
11465 PL_screamfirst = NULL;
11466 PL_screamnext = NULL;
11467 PL_maxscream = -1; /* reinits on demand */
11468 PL_lastscream = NULL;
11471 PL_regdummy = proto_perl->Tregdummy;
11472 PL_colorset = 0; /* reinits PL_colors[] */
11473 /*PL_colors[6] = {0,0,0,0,0,0};*/
11477 /* Pluggable optimizer */
11478 PL_peepp = proto_perl->Tpeepp;
11480 PL_stashcache = newHV();
11482 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11483 proto_perl->Twatchaddr);
11484 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11485 if (PL_debug && PL_watchaddr) {
11486 PerlIO_printf(Perl_debug_log,
11487 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11488 PTR2UV(proto_perl->Twatchaddr), PTR2UV(PL_watchaddr),
11489 PTR2UV(PL_watchok));
11492 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11493 ptr_table_free(PL_ptr_table);
11494 PL_ptr_table = NULL;
11497 /* Call the ->CLONE method, if it exists, for each of the stashes
11498 identified by sv_dup() above.
11500 while(av_len(param->stashes) != -1) {
11501 HV* const stash = (HV*) av_shift(param->stashes);
11502 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11503 if (cloner && GvCV(cloner)) {
11508 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11510 call_sv((SV*)GvCV(cloner), G_DISCARD);
11516 SvREFCNT_dec(param->stashes);
11518 /* orphaned? eg threads->new inside BEGIN or use */
11519 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11520 SvREFCNT_inc_simple_void(PL_compcv);
11521 SAVEFREESV(PL_compcv);
11527 #endif /* USE_ITHREADS */
11530 =head1 Unicode Support
11532 =for apidoc sv_recode_to_utf8
11534 The encoding is assumed to be an Encode object, on entry the PV
11535 of the sv is assumed to be octets in that encoding, and the sv
11536 will be converted into Unicode (and UTF-8).
11538 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11539 is not a reference, nothing is done to the sv. If the encoding is not
11540 an C<Encode::XS> Encoding object, bad things will happen.
11541 (See F<lib/encoding.pm> and L<Encode>).
11543 The PV of the sv is returned.
11548 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11551 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11565 Passing sv_yes is wrong - it needs to be or'ed set of constants
11566 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11567 remove converted chars from source.
11569 Both will default the value - let them.
11571 XPUSHs(&PL_sv_yes);
11574 call_method("decode", G_SCALAR);
11578 s = SvPV_const(uni, len);
11579 if (s != SvPVX_const(sv)) {
11580 SvGROW(sv, len + 1);
11581 Move(s, SvPVX(sv), len + 1, char);
11582 SvCUR_set(sv, len);
11589 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11593 =for apidoc sv_cat_decode
11595 The encoding is assumed to be an Encode object, the PV of the ssv is
11596 assumed to be octets in that encoding and decoding the input starts
11597 from the position which (PV + *offset) pointed to. The dsv will be
11598 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11599 when the string tstr appears in decoding output or the input ends on
11600 the PV of the ssv. The value which the offset points will be modified
11601 to the last input position on the ssv.
11603 Returns TRUE if the terminator was found, else returns FALSE.
11608 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11609 SV *ssv, int *offset, char *tstr, int tlen)
11613 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11624 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11625 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11627 call_method("cat_decode", G_SCALAR);
11629 ret = SvTRUE(TOPs);
11630 *offset = SvIV(offsv);
11636 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11641 /* ---------------------------------------------------------------------
11643 * support functions for report_uninit()
11646 /* the maxiumum size of array or hash where we will scan looking
11647 * for the undefined element that triggered the warning */
11649 #define FUV_MAX_SEARCH_SIZE 1000
11651 /* Look for an entry in the hash whose value has the same SV as val;
11652 * If so, return a mortal copy of the key. */
11655 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11658 register HE **array;
11661 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11662 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11665 array = HvARRAY(hv);
11667 for (i=HvMAX(hv); i>0; i--) {
11668 register HE *entry;
11669 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11670 if (HeVAL(entry) != val)
11672 if ( HeVAL(entry) == &PL_sv_undef ||
11673 HeVAL(entry) == &PL_sv_placeholder)
11677 if (HeKLEN(entry) == HEf_SVKEY)
11678 return sv_mortalcopy(HeKEY_sv(entry));
11679 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11685 /* Look for an entry in the array whose value has the same SV as val;
11686 * If so, return the index, otherwise return -1. */
11689 S_find_array_subscript(pTHX_ AV *av, SV* val)
11692 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11693 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11696 if (val != &PL_sv_undef) {
11697 SV ** const svp = AvARRAY(av);
11700 for (i=AvFILLp(av); i>=0; i--)
11707 /* S_varname(): return the name of a variable, optionally with a subscript.
11708 * If gv is non-zero, use the name of that global, along with gvtype (one
11709 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11710 * targ. Depending on the value of the subscript_type flag, return:
11713 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11714 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11715 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11716 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11719 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11720 SV* keyname, I32 aindex, int subscript_type)
11723 SV * const name = sv_newmortal();
11726 buffer[0] = gvtype;
11729 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11731 gv_fullname4(name, gv, buffer, 0);
11733 if ((unsigned int)SvPVX(name)[1] <= 26) {
11735 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11737 /* Swap the 1 unprintable control character for the 2 byte pretty
11738 version - ie substr($name, 1, 1) = $buffer; */
11739 sv_insert(name, 1, 1, buffer, 2);
11744 CV * const cv = find_runcv(&unused);
11748 if (!cv || !CvPADLIST(cv))
11750 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11751 sv = *av_fetch(av, targ, FALSE);
11752 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11755 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11756 SV * const sv = newSV(0);
11757 *SvPVX(name) = '$';
11758 Perl_sv_catpvf(aTHX_ name, "{%s}",
11759 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11762 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11763 *SvPVX(name) = '$';
11764 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11766 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11767 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11774 =for apidoc find_uninit_var
11776 Find the name of the undefined variable (if any) that caused the operator o
11777 to issue a "Use of uninitialized value" warning.
11778 If match is true, only return a name if it's value matches uninit_sv.
11779 So roughly speaking, if a unary operator (such as OP_COS) generates a
11780 warning, then following the direct child of the op may yield an
11781 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11782 other hand, with OP_ADD there are two branches to follow, so we only print
11783 the variable name if we get an exact match.
11785 The name is returned as a mortal SV.
11787 Assumes that PL_op is the op that originally triggered the error, and that
11788 PL_comppad/PL_curpad points to the currently executing pad.
11794 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11802 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11803 uninit_sv == &PL_sv_placeholder)))
11806 switch (obase->op_type) {
11813 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11814 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11817 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11819 if (pad) { /* @lex, %lex */
11820 sv = PAD_SVl(obase->op_targ);
11824 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11825 /* @global, %global */
11826 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11829 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11831 else /* @{expr}, %{expr} */
11832 return find_uninit_var(cUNOPx(obase)->op_first,
11836 /* attempt to find a match within the aggregate */
11838 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11840 subscript_type = FUV_SUBSCRIPT_HASH;
11843 index = find_array_subscript((AV*)sv, uninit_sv);
11845 subscript_type = FUV_SUBSCRIPT_ARRAY;
11848 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11851 return varname(gv, hash ? '%' : '@', obase->op_targ,
11852 keysv, index, subscript_type);
11856 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11858 return varname(NULL, '$', obase->op_targ,
11859 NULL, 0, FUV_SUBSCRIPT_NONE);
11862 gv = cGVOPx_gv(obase);
11863 if (!gv || (match && GvSV(gv) != uninit_sv))
11865 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11868 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11871 av = (AV*)PAD_SV(obase->op_targ);
11872 if (!av || SvRMAGICAL(av))
11874 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11875 if (!svp || *svp != uninit_sv)
11878 return varname(NULL, '$', obase->op_targ,
11879 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11882 gv = cGVOPx_gv(obase);
11888 if (!av || SvRMAGICAL(av))
11890 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11891 if (!svp || *svp != uninit_sv)
11894 return varname(gv, '$', 0,
11895 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11900 o = cUNOPx(obase)->op_first;
11901 if (!o || o->op_type != OP_NULL ||
11902 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11904 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11908 if (PL_op == obase)
11909 /* $a[uninit_expr] or $h{uninit_expr} */
11910 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11913 o = cBINOPx(obase)->op_first;
11914 kid = cBINOPx(obase)->op_last;
11916 /* get the av or hv, and optionally the gv */
11918 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11919 sv = PAD_SV(o->op_targ);
11921 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11922 && cUNOPo->op_first->op_type == OP_GV)
11924 gv = cGVOPx_gv(cUNOPo->op_first);
11927 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11932 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11933 /* index is constant */
11937 if (obase->op_type == OP_HELEM) {
11938 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11939 if (!he || HeVAL(he) != uninit_sv)
11943 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11944 if (!svp || *svp != uninit_sv)
11948 if (obase->op_type == OP_HELEM)
11949 return varname(gv, '%', o->op_targ,
11950 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11952 return varname(gv, '@', o->op_targ, NULL,
11953 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11956 /* index is an expression;
11957 * attempt to find a match within the aggregate */
11958 if (obase->op_type == OP_HELEM) {
11959 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11961 return varname(gv, '%', o->op_targ,
11962 keysv, 0, FUV_SUBSCRIPT_HASH);
11965 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11967 return varname(gv, '@', o->op_targ,
11968 NULL, index, FUV_SUBSCRIPT_ARRAY);
11973 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11975 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11980 /* only examine RHS */
11981 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11984 o = cUNOPx(obase)->op_first;
11985 if (o->op_type == OP_PUSHMARK)
11988 if (!o->op_sibling) {
11989 /* one-arg version of open is highly magical */
11991 if (o->op_type == OP_GV) { /* open FOO; */
11993 if (match && GvSV(gv) != uninit_sv)
11995 return varname(gv, '$', 0,
11996 NULL, 0, FUV_SUBSCRIPT_NONE);
11998 /* other possibilities not handled are:
11999 * open $x; or open my $x; should return '${*$x}'
12000 * open expr; should return '$'.expr ideally
12006 /* ops where $_ may be an implicit arg */
12010 if ( !(obase->op_flags & OPf_STACKED)) {
12011 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12012 ? PAD_SVl(obase->op_targ)
12015 sv = sv_newmortal();
12016 sv_setpvn(sv, "$_", 2);
12025 /* skip filehandle as it can't produce 'undef' warning */
12026 o = cUNOPx(obase)->op_first;
12027 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12028 o = o->op_sibling->op_sibling;
12035 match = 1; /* XS or custom code could trigger random warnings */
12040 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12041 return sv_2mortal(newSVpvs("${$/}"));
12046 if (!(obase->op_flags & OPf_KIDS))
12048 o = cUNOPx(obase)->op_first;
12054 /* if all except one arg are constant, or have no side-effects,
12055 * or are optimized away, then it's unambiguous */
12057 for (kid=o; kid; kid = kid->op_sibling) {
12059 const OPCODE type = kid->op_type;
12060 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12061 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12062 || (type == OP_PUSHMARK)
12066 if (o2) { /* more than one found */
12073 return find_uninit_var(o2, uninit_sv, match);
12075 /* scan all args */
12077 sv = find_uninit_var(o, uninit_sv, 1);
12089 =for apidoc report_uninit
12091 Print appropriate "Use of uninitialized variable" warning
12097 Perl_report_uninit(pTHX_ SV* uninit_sv)
12101 SV* varname = NULL;
12103 varname = find_uninit_var(PL_op, uninit_sv,0);
12105 sv_insert(varname, 0, 0, " ", 1);
12107 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12108 varname ? SvPV_nolen_const(varname) : "",
12109 " in ", OP_DESC(PL_op));
12112 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12118 * c-indentation-style: bsd
12119 * c-basic-offset: 4
12120 * indent-tabs-mode: t
12123 * ex: set ts=8 sts=4 sw=4 noet: