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_parser && PL_parser->copline == NOLINE) ?
250 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_parser->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 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3150 if (dtype != SVt_PVGV) {
3151 const char * const name = GvNAME(sstr);
3152 const STRLEN len = GvNAMELEN(sstr);
3154 if (dtype >= SVt_PV) {
3160 SvUPGRADE(dstr, SVt_PVGV);
3161 (void)SvOK_off(dstr);
3162 /* FIXME - why are we doing this, then turning it off and on again
3164 isGV_with_GP_on(dstr);
3166 GvSTASH(dstr) = GvSTASH(sstr);
3168 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3169 gv_name_set((GV *)dstr, name, len, GV_ADD);
3170 SvFAKE_on(dstr); /* can coerce to non-glob */
3173 #ifdef GV_UNIQUE_CHECK
3174 if (GvUNIQUE((GV*)dstr)) {
3175 Perl_croak(aTHX_ PL_no_modify);
3179 if(GvGP((GV*)sstr)) {
3180 /* If source has method cache entry, clear it */
3182 SvREFCNT_dec(GvCV(sstr));
3186 /* If source has a real method, then a method is
3188 else if(GvCV((GV*)sstr)) {
3193 /* If dest already had a real method, that's a change as well */
3194 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3198 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3202 isGV_with_GP_off(dstr);
3203 (void)SvOK_off(dstr);
3204 isGV_with_GP_on(dstr);
3205 GvINTRO_off(dstr); /* one-shot flag */
3206 GvGP(dstr) = gp_ref(GvGP(sstr));
3207 if (SvTAINTED(sstr))
3209 if (GvIMPORTED(dstr) != GVf_IMPORTED
3210 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3212 GvIMPORTED_on(dstr);
3215 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3216 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3221 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3222 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3224 const int intro = GvINTRO(dstr);
3227 const U32 stype = SvTYPE(sref);
3230 #ifdef GV_UNIQUE_CHECK
3231 if (GvUNIQUE((GV*)dstr)) {
3232 Perl_croak(aTHX_ PL_no_modify);
3237 GvINTRO_off(dstr); /* one-shot flag */
3238 GvLINE(dstr) = CopLINE(PL_curcop);
3239 GvEGV(dstr) = (GV*)dstr;
3244 location = (SV **) &GvCV(dstr);
3245 import_flag = GVf_IMPORTED_CV;
3248 location = (SV **) &GvHV(dstr);
3249 import_flag = GVf_IMPORTED_HV;
3252 location = (SV **) &GvAV(dstr);
3253 import_flag = GVf_IMPORTED_AV;
3256 location = (SV **) &GvIOp(dstr);
3259 location = (SV **) &GvFORM(dstr);
3261 location = &GvSV(dstr);
3262 import_flag = GVf_IMPORTED_SV;
3265 if (stype == SVt_PVCV) {
3266 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3267 if (GvCVGEN(dstr)) {
3268 SvREFCNT_dec(GvCV(dstr));
3270 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3273 SAVEGENERICSV(*location);
3277 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3278 CV* const cv = (CV*)*location;
3280 if (!GvCVGEN((GV*)dstr) &&
3281 (CvROOT(cv) || CvXSUB(cv)))
3283 /* Redefining a sub - warning is mandatory if
3284 it was a const and its value changed. */
3285 if (CvCONST(cv) && CvCONST((CV*)sref)
3286 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3288 /* They are 2 constant subroutines generated from
3289 the same constant. This probably means that
3290 they are really the "same" proxy subroutine
3291 instantiated in 2 places. Most likely this is
3292 when a constant is exported twice. Don't warn.
3295 else if (ckWARN(WARN_REDEFINE)
3297 && (!CvCONST((CV*)sref)
3298 || sv_cmp(cv_const_sv(cv),
3299 cv_const_sv((CV*)sref))))) {
3300 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3303 ? "Constant subroutine %s::%s redefined"
3304 : "Subroutine %s::%s redefined"),
3305 HvNAME_get(GvSTASH((GV*)dstr)),
3306 GvENAME((GV*)dstr));
3310 cv_ckproto_len(cv, (GV*)dstr,
3311 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3312 SvPOK(sref) ? SvCUR(sref) : 0);
3314 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3315 GvASSUMECV_on(dstr);
3316 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3319 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3320 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3321 GvFLAGS(dstr) |= import_flag;
3326 if (SvTAINTED(sstr))
3332 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3335 register U32 sflags;
3337 register svtype stype;
3342 if (SvIS_FREED(dstr)) {
3343 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3344 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3346 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3348 sstr = &PL_sv_undef;
3349 if (SvIS_FREED(sstr)) {
3350 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3351 (void*)sstr, (void*)dstr);
3353 stype = SvTYPE(sstr);
3354 dtype = SvTYPE(dstr);
3356 (void)SvAMAGIC_off(dstr);
3359 /* need to nuke the magic */
3361 SvRMAGICAL_off(dstr);
3364 /* There's a lot of redundancy below but we're going for speed here */
3369 if (dtype != SVt_PVGV) {
3370 (void)SvOK_off(dstr);
3378 sv_upgrade(dstr, SVt_IV);
3383 sv_upgrade(dstr, SVt_PVIV);
3386 goto end_of_first_switch;
3388 (void)SvIOK_only(dstr);
3389 SvIV_set(dstr, SvIVX(sstr));
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_IV, so this cannot be true (whatever gcov
3396 assert(!SvTAINTED(sstr));
3406 sv_upgrade(dstr, SVt_NV);
3411 sv_upgrade(dstr, SVt_PVNV);
3414 goto end_of_first_switch;
3416 SvNV_set(dstr, SvNVX(sstr));
3417 (void)SvNOK_only(dstr);
3418 /* SvTAINTED can only be true if the SV has taint magic, which in
3419 turn means that the SV type is PVMG (or greater). This is the
3420 case statement for SVt_NV, so this cannot be true (whatever gcov
3422 assert(!SvTAINTED(sstr));
3429 sv_upgrade(dstr, SVt_RV);
3432 #ifdef PERL_OLD_COPY_ON_WRITE
3433 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3434 if (dtype < SVt_PVIV)
3435 sv_upgrade(dstr, SVt_PVIV);
3442 sv_upgrade(dstr, SVt_PV);
3445 if (dtype < SVt_PVIV)
3446 sv_upgrade(dstr, SVt_PVIV);
3449 if (dtype < SVt_PVNV)
3450 sv_upgrade(dstr, SVt_PVNV);
3454 const char * const type = sv_reftype(sstr,0);
3456 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3458 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3462 /* case SVt_BIND: */
3465 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3466 glob_assign_glob(dstr, sstr, dtype);
3469 /* SvVALID means that this PVGV is playing at being an FBM. */
3473 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3475 if (SvTYPE(sstr) != stype) {
3476 stype = SvTYPE(sstr);
3477 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3478 glob_assign_glob(dstr, sstr, dtype);
3483 if (stype == SVt_PVLV)
3484 SvUPGRADE(dstr, SVt_PVNV);
3486 SvUPGRADE(dstr, (svtype)stype);
3488 end_of_first_switch:
3490 /* dstr may have been upgraded. */
3491 dtype = SvTYPE(dstr);
3492 sflags = SvFLAGS(sstr);
3494 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3495 /* Assigning to a subroutine sets the prototype. */
3498 const char *const ptr = SvPV_const(sstr, len);
3500 SvGROW(dstr, len + 1);
3501 Copy(ptr, SvPVX(dstr), len + 1, char);
3502 SvCUR_set(dstr, len);
3504 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3508 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3509 const char * const type = sv_reftype(dstr,0);
3511 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3513 Perl_croak(aTHX_ "Cannot copy to %s", type);
3514 } else if (sflags & SVf_ROK) {
3515 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3516 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3519 if (GvIMPORTED(dstr) != GVf_IMPORTED
3520 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3522 GvIMPORTED_on(dstr);
3527 glob_assign_glob(dstr, sstr, dtype);
3531 if (dtype >= SVt_PV) {
3532 if (dtype == SVt_PVGV) {
3533 glob_assign_ref(dstr, sstr);
3536 if (SvPVX_const(dstr)) {
3542 (void)SvOK_off(dstr);
3543 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3544 SvFLAGS(dstr) |= sflags & SVf_ROK;
3545 assert(!(sflags & SVp_NOK));
3546 assert(!(sflags & SVp_IOK));
3547 assert(!(sflags & SVf_NOK));
3548 assert(!(sflags & SVf_IOK));
3550 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3551 if (!(sflags & SVf_OK)) {
3552 if (ckWARN(WARN_MISC))
3553 Perl_warner(aTHX_ packWARN(WARN_MISC),
3554 "Undefined value assigned to typeglob");
3557 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3558 if (dstr != (SV*)gv) {
3561 GvGP(dstr) = gp_ref(GvGP(gv));
3565 else if (sflags & SVp_POK) {
3569 * Check to see if we can just swipe the string. If so, it's a
3570 * possible small lose on short strings, but a big win on long ones.
3571 * It might even be a win on short strings if SvPVX_const(dstr)
3572 * has to be allocated and SvPVX_const(sstr) has to be freed.
3573 * Likewise if we can set up COW rather than doing an actual copy, we
3574 * drop to the else clause, as the swipe code and the COW setup code
3575 * have much in common.
3578 /* Whichever path we take through the next code, we want this true,
3579 and doing it now facilitates the COW check. */
3580 (void)SvPOK_only(dstr);
3583 /* If we're already COW then this clause is not true, and if COW
3584 is allowed then we drop down to the else and make dest COW
3585 with us. If caller hasn't said that we're allowed to COW
3586 shared hash keys then we don't do the COW setup, even if the
3587 source scalar is a shared hash key scalar. */
3588 (((flags & SV_COW_SHARED_HASH_KEYS)
3589 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3590 : 1 /* If making a COW copy is forbidden then the behaviour we
3591 desire is as if the source SV isn't actually already
3592 COW, even if it is. So we act as if the source flags
3593 are not COW, rather than actually testing them. */
3595 #ifndef PERL_OLD_COPY_ON_WRITE
3596 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3597 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3598 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3599 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3600 but in turn, it's somewhat dead code, never expected to go
3601 live, but more kept as a placeholder on how to do it better
3602 in a newer implementation. */
3603 /* If we are COW and dstr is a suitable target then we drop down
3604 into the else and make dest a COW of us. */
3605 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3610 (sflags & SVs_TEMP) && /* slated for free anyway? */
3611 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3612 (!(flags & SV_NOSTEAL)) &&
3613 /* and we're allowed to steal temps */
3614 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3615 SvLEN(sstr) && /* and really is a string */
3616 /* and won't be needed again, potentially */
3617 !(PL_op && PL_op->op_type == OP_AASSIGN))
3618 #ifdef PERL_OLD_COPY_ON_WRITE
3619 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3620 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3621 && SvTYPE(sstr) >= SVt_PVIV)
3624 /* Failed the swipe test, and it's not a shared hash key either.
3625 Have to copy the string. */
3626 STRLEN len = SvCUR(sstr);
3627 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3628 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3629 SvCUR_set(dstr, len);
3630 *SvEND(dstr) = '\0';
3632 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3634 /* Either it's a shared hash key, or it's suitable for
3635 copy-on-write or we can swipe the string. */
3637 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3641 #ifdef PERL_OLD_COPY_ON_WRITE
3643 /* I believe I should acquire a global SV mutex if
3644 it's a COW sv (not a shared hash key) to stop
3645 it going un copy-on-write.
3646 If the source SV has gone un copy on write between up there
3647 and down here, then (assert() that) it is of the correct
3648 form to make it copy on write again */
3649 if ((sflags & (SVf_FAKE | SVf_READONLY))
3650 != (SVf_FAKE | SVf_READONLY)) {
3651 SvREADONLY_on(sstr);
3653 /* Make the source SV into a loop of 1.
3654 (about to become 2) */
3655 SV_COW_NEXT_SV_SET(sstr, sstr);
3659 /* Initial code is common. */
3660 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3665 /* making another shared SV. */
3666 STRLEN cur = SvCUR(sstr);
3667 STRLEN len = SvLEN(sstr);
3668 #ifdef PERL_OLD_COPY_ON_WRITE
3670 assert (SvTYPE(dstr) >= SVt_PVIV);
3671 /* SvIsCOW_normal */
3672 /* splice us in between source and next-after-source. */
3673 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3674 SV_COW_NEXT_SV_SET(sstr, dstr);
3675 SvPV_set(dstr, SvPVX_mutable(sstr));
3679 /* SvIsCOW_shared_hash */
3680 DEBUG_C(PerlIO_printf(Perl_debug_log,
3681 "Copy on write: Sharing hash\n"));
3683 assert (SvTYPE(dstr) >= SVt_PV);
3685 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3687 SvLEN_set(dstr, len);
3688 SvCUR_set(dstr, cur);
3689 SvREADONLY_on(dstr);
3691 /* Relesase a global SV mutex. */
3694 { /* Passes the swipe test. */
3695 SvPV_set(dstr, SvPVX_mutable(sstr));
3696 SvLEN_set(dstr, SvLEN(sstr));
3697 SvCUR_set(dstr, SvCUR(sstr));
3700 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3701 SvPV_set(sstr, NULL);
3707 if (sflags & SVp_NOK) {
3708 SvNV_set(dstr, SvNVX(sstr));
3710 if (sflags & SVp_IOK) {
3712 SvIV_set(dstr, SvIVX(sstr));
3713 /* Must do this otherwise some other overloaded use of 0x80000000
3714 gets confused. I guess SVpbm_VALID */
3715 if (sflags & SVf_IVisUV)
3718 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3720 const MAGIC * const smg = SvVSTRING_mg(sstr);
3722 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3723 smg->mg_ptr, smg->mg_len);
3724 SvRMAGICAL_on(dstr);
3728 else if (sflags & (SVp_IOK|SVp_NOK)) {
3729 (void)SvOK_off(dstr);
3730 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3731 if (sflags & SVp_IOK) {
3732 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3733 SvIV_set(dstr, SvIVX(sstr));
3735 if (sflags & SVp_NOK) {
3736 SvNV_set(dstr, SvNVX(sstr));
3740 if (isGV_with_GP(sstr)) {
3741 /* This stringification rule for globs is spread in 3 places.
3742 This feels bad. FIXME. */
3743 const U32 wasfake = sflags & SVf_FAKE;
3745 /* FAKE globs can get coerced, so need to turn this off
3746 temporarily if it is on. */
3748 gv_efullname3(dstr, (GV *)sstr, "*");
3749 SvFLAGS(sstr) |= wasfake;
3752 (void)SvOK_off(dstr);
3754 if (SvTAINTED(sstr))
3759 =for apidoc sv_setsv_mg
3761 Like C<sv_setsv>, but also handles 'set' magic.
3767 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3769 sv_setsv(dstr,sstr);
3773 #ifdef PERL_OLD_COPY_ON_WRITE
3775 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3777 STRLEN cur = SvCUR(sstr);
3778 STRLEN len = SvLEN(sstr);
3779 register char *new_pv;
3782 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3783 (void*)sstr, (void*)dstr);
3790 if (SvTHINKFIRST(dstr))
3791 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3792 else if (SvPVX_const(dstr))
3793 Safefree(SvPVX_const(dstr));
3797 SvUPGRADE(dstr, SVt_PVIV);
3799 assert (SvPOK(sstr));
3800 assert (SvPOKp(sstr));
3801 assert (!SvIOK(sstr));
3802 assert (!SvIOKp(sstr));
3803 assert (!SvNOK(sstr));
3804 assert (!SvNOKp(sstr));
3806 if (SvIsCOW(sstr)) {
3808 if (SvLEN(sstr) == 0) {
3809 /* source is a COW shared hash key. */
3810 DEBUG_C(PerlIO_printf(Perl_debug_log,
3811 "Fast copy on write: Sharing hash\n"));
3812 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3815 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3817 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3818 SvUPGRADE(sstr, SVt_PVIV);
3819 SvREADONLY_on(sstr);
3821 DEBUG_C(PerlIO_printf(Perl_debug_log,
3822 "Fast copy on write: Converting sstr to COW\n"));
3823 SV_COW_NEXT_SV_SET(dstr, sstr);
3825 SV_COW_NEXT_SV_SET(sstr, dstr);
3826 new_pv = SvPVX_mutable(sstr);
3829 SvPV_set(dstr, new_pv);
3830 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3833 SvLEN_set(dstr, len);
3834 SvCUR_set(dstr, cur);
3843 =for apidoc sv_setpvn
3845 Copies a string into an SV. The C<len> parameter indicates the number of
3846 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3847 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3853 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3856 register char *dptr;
3858 SV_CHECK_THINKFIRST_COW_DROP(sv);
3864 /* len is STRLEN which is unsigned, need to copy to signed */
3867 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3869 SvUPGRADE(sv, SVt_PV);
3871 dptr = SvGROW(sv, len + 1);
3872 Move(ptr,dptr,len,char);
3875 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3880 =for apidoc sv_setpvn_mg
3882 Like C<sv_setpvn>, but also handles 'set' magic.
3888 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3890 sv_setpvn(sv,ptr,len);
3895 =for apidoc sv_setpv
3897 Copies a string into an SV. The string must be null-terminated. Does not
3898 handle 'set' magic. See C<sv_setpv_mg>.
3904 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3907 register STRLEN len;
3909 SV_CHECK_THINKFIRST_COW_DROP(sv);
3915 SvUPGRADE(sv, SVt_PV);
3917 SvGROW(sv, len + 1);
3918 Move(ptr,SvPVX(sv),len+1,char);
3920 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3925 =for apidoc sv_setpv_mg
3927 Like C<sv_setpv>, but also handles 'set' magic.
3933 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3940 =for apidoc sv_usepvn_flags
3942 Tells an SV to use C<ptr> to find its string value. Normally the
3943 string is stored inside the SV but sv_usepvn allows the SV to use an
3944 outside string. The C<ptr> should point to memory that was allocated
3945 by C<malloc>. The string length, C<len>, must be supplied. By default
3946 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3947 so that pointer should not be freed or used by the programmer after
3948 giving it to sv_usepvn, and neither should any pointers from "behind"
3949 that pointer (e.g. ptr + 1) be used.
3951 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3952 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3953 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3954 C<len>, and already meets the requirements for storing in C<SvPVX>)
3960 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3964 SV_CHECK_THINKFIRST_COW_DROP(sv);
3965 SvUPGRADE(sv, SVt_PV);
3968 if (flags & SV_SMAGIC)
3972 if (SvPVX_const(sv))
3976 if (flags & SV_HAS_TRAILING_NUL)
3977 assert(ptr[len] == '\0');
3980 allocate = (flags & SV_HAS_TRAILING_NUL)
3981 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3982 if (flags & SV_HAS_TRAILING_NUL) {
3983 /* It's long enough - do nothing.
3984 Specfically Perl_newCONSTSUB is relying on this. */
3987 /* Force a move to shake out bugs in callers. */
3988 char *new_ptr = (char*)safemalloc(allocate);
3989 Copy(ptr, new_ptr, len, char);
3990 PoisonFree(ptr,len,char);
3994 ptr = (char*) saferealloc (ptr, allocate);
3999 SvLEN_set(sv, allocate);
4000 if (!(flags & SV_HAS_TRAILING_NUL)) {
4003 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4005 if (flags & SV_SMAGIC)
4009 #ifdef PERL_OLD_COPY_ON_WRITE
4010 /* Need to do this *after* making the SV normal, as we need the buffer
4011 pointer to remain valid until after we've copied it. If we let go too early,
4012 another thread could invalidate it by unsharing last of the same hash key
4013 (which it can do by means other than releasing copy-on-write Svs)
4014 or by changing the other copy-on-write SVs in the loop. */
4016 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4018 { /* this SV was SvIsCOW_normal(sv) */
4019 /* we need to find the SV pointing to us. */
4020 SV *current = SV_COW_NEXT_SV(after);
4022 if (current == sv) {
4023 /* The SV we point to points back to us (there were only two of us
4025 Hence other SV is no longer copy on write either. */
4027 SvREADONLY_off(after);
4029 /* We need to follow the pointers around the loop. */
4031 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4034 /* don't loop forever if the structure is bust, and we have
4035 a pointer into a closed loop. */
4036 assert (current != after);
4037 assert (SvPVX_const(current) == pvx);
4039 /* Make the SV before us point to the SV after us. */
4040 SV_COW_NEXT_SV_SET(current, after);
4046 =for apidoc sv_force_normal_flags
4048 Undo various types of fakery on an SV: if the PV is a shared string, make
4049 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4050 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4051 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4052 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4053 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4054 set to some other value.) In addition, the C<flags> parameter gets passed to
4055 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4056 with flags set to 0.
4062 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4065 #ifdef PERL_OLD_COPY_ON_WRITE
4066 if (SvREADONLY(sv)) {
4067 /* At this point I believe I should acquire a global SV mutex. */
4069 const char * const pvx = SvPVX_const(sv);
4070 const STRLEN len = SvLEN(sv);
4071 const STRLEN cur = SvCUR(sv);
4072 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4073 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4074 we'll fail an assertion. */
4075 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4078 PerlIO_printf(Perl_debug_log,
4079 "Copy on write: Force normal %ld\n",
4085 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4088 if (flags & SV_COW_DROP_PV) {
4089 /* OK, so we don't need to copy our buffer. */
4092 SvGROW(sv, cur + 1);
4093 Move(pvx,SvPVX(sv),cur,char);
4098 sv_release_COW(sv, pvx, next);
4100 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4106 else if (IN_PERL_RUNTIME)
4107 Perl_croak(aTHX_ PL_no_modify);
4108 /* At this point I believe that I can drop the global SV mutex. */
4111 if (SvREADONLY(sv)) {
4113 const char * const pvx = SvPVX_const(sv);
4114 const STRLEN len = SvCUR(sv);
4119 SvGROW(sv, len + 1);
4120 Move(pvx,SvPVX(sv),len,char);
4122 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4124 else if (IN_PERL_RUNTIME)
4125 Perl_croak(aTHX_ PL_no_modify);
4129 sv_unref_flags(sv, flags);
4130 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4137 Efficient removal of characters from the beginning of the string buffer.
4138 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4139 the string buffer. The C<ptr> becomes the first character of the adjusted
4140 string. Uses the "OOK hack".
4141 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4142 refer to the same chunk of data.
4148 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4150 register STRLEN delta;
4151 if (!ptr || !SvPOKp(sv))
4153 delta = ptr - SvPVX_const(sv);
4154 SV_CHECK_THINKFIRST(sv);
4155 if (SvTYPE(sv) < SVt_PVIV)
4156 sv_upgrade(sv,SVt_PVIV);
4159 if (!SvLEN(sv)) { /* make copy of shared string */
4160 const char *pvx = SvPVX_const(sv);
4161 const STRLEN len = SvCUR(sv);
4162 SvGROW(sv, len + 1);
4163 Move(pvx,SvPVX(sv),len,char);
4167 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4168 and we do that anyway inside the SvNIOK_off
4170 SvFLAGS(sv) |= SVf_OOK;
4173 SvLEN_set(sv, SvLEN(sv) - delta);
4174 SvCUR_set(sv, SvCUR(sv) - delta);
4175 SvPV_set(sv, SvPVX(sv) + delta);
4176 SvIV_set(sv, SvIVX(sv) + delta);
4180 =for apidoc sv_catpvn
4182 Concatenates the string onto the end of the string which is in the SV. The
4183 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4184 status set, then the bytes appended should be valid UTF-8.
4185 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4187 =for apidoc sv_catpvn_flags
4189 Concatenates the string onto the end of the string which is in the SV. The
4190 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4191 status set, then the bytes appended should be valid UTF-8.
4192 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4193 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4194 in terms of this function.
4200 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4204 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4206 SvGROW(dsv, dlen + slen + 1);
4208 sstr = SvPVX_const(dsv);
4209 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4210 SvCUR_set(dsv, SvCUR(dsv) + slen);
4212 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4214 if (flags & SV_SMAGIC)
4219 =for apidoc sv_catsv
4221 Concatenates the string from SV C<ssv> onto the end of the string in
4222 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4223 not 'set' magic. See C<sv_catsv_mg>.
4225 =for apidoc sv_catsv_flags
4227 Concatenates the string from SV C<ssv> onto the end of the string in
4228 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4229 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4230 and C<sv_catsv_nomg> are implemented in terms of this function.
4235 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4240 const char *spv = SvPV_const(ssv, slen);
4242 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4243 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4244 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4245 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4246 dsv->sv_flags doesn't have that bit set.
4247 Andy Dougherty 12 Oct 2001
4249 const I32 sutf8 = DO_UTF8(ssv);
4252 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4254 dutf8 = DO_UTF8(dsv);
4256 if (dutf8 != sutf8) {
4258 /* Not modifying source SV, so taking a temporary copy. */
4259 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4261 sv_utf8_upgrade(csv);
4262 spv = SvPV_const(csv, slen);
4265 sv_utf8_upgrade_nomg(dsv);
4267 sv_catpvn_nomg(dsv, spv, slen);
4270 if (flags & SV_SMAGIC)
4275 =for apidoc sv_catpv
4277 Concatenates the string onto the end of the string which is in the SV.
4278 If the SV has the UTF-8 status set, then the bytes appended should be
4279 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4284 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4287 register STRLEN len;
4293 junk = SvPV_force(sv, tlen);
4295 SvGROW(sv, tlen + len + 1);
4297 ptr = SvPVX_const(sv);
4298 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4299 SvCUR_set(sv, SvCUR(sv) + len);
4300 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4305 =for apidoc sv_catpv_mg
4307 Like C<sv_catpv>, but also handles 'set' magic.
4313 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4322 Creates a new SV. A non-zero C<len> parameter indicates the number of
4323 bytes of preallocated string space the SV should have. An extra byte for a
4324 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4325 space is allocated.) The reference count for the new SV is set to 1.
4327 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4328 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4329 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4330 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4331 modules supporting older perls.
4337 Perl_newSV(pTHX_ STRLEN len)
4344 sv_upgrade(sv, SVt_PV);
4345 SvGROW(sv, len + 1);
4350 =for apidoc sv_magicext
4352 Adds magic to an SV, upgrading it if necessary. Applies the
4353 supplied vtable and returns a pointer to the magic added.
4355 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4356 In particular, you can add magic to SvREADONLY SVs, and add more than
4357 one instance of the same 'how'.
4359 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4360 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4361 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4362 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4364 (This is now used as a subroutine by C<sv_magic>.)
4369 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4370 const char* name, I32 namlen)
4375 SvUPGRADE(sv, SVt_PVMG);
4376 Newxz(mg, 1, MAGIC);
4377 mg->mg_moremagic = SvMAGIC(sv);
4378 SvMAGIC_set(sv, mg);
4380 /* Sometimes a magic contains a reference loop, where the sv and
4381 object refer to each other. To prevent a reference loop that
4382 would prevent such objects being freed, we look for such loops
4383 and if we find one we avoid incrementing the object refcount.
4385 Note we cannot do this to avoid self-tie loops as intervening RV must
4386 have its REFCNT incremented to keep it in existence.
4389 if (!obj || obj == sv ||
4390 how == PERL_MAGIC_arylen ||
4391 how == PERL_MAGIC_qr ||
4392 how == PERL_MAGIC_symtab ||
4393 (SvTYPE(obj) == SVt_PVGV &&
4394 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4395 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4396 GvFORM(obj) == (CV*)sv)))
4401 mg->mg_obj = SvREFCNT_inc_simple(obj);
4402 mg->mg_flags |= MGf_REFCOUNTED;
4405 /* Normal self-ties simply pass a null object, and instead of
4406 using mg_obj directly, use the SvTIED_obj macro to produce a
4407 new RV as needed. For glob "self-ties", we are tieing the PVIO
4408 with an RV obj pointing to the glob containing the PVIO. In
4409 this case, to avoid a reference loop, we need to weaken the
4413 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4414 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4420 mg->mg_len = namlen;
4423 mg->mg_ptr = savepvn(name, namlen);
4424 else if (namlen == HEf_SVKEY)
4425 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4427 mg->mg_ptr = (char *) name;
4429 mg->mg_virtual = (MGVTBL *) vtable;
4433 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4438 =for apidoc sv_magic
4440 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4441 then adds a new magic item of type C<how> to the head of the magic list.
4443 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4444 handling of the C<name> and C<namlen> arguments.
4446 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4447 to add more than one instance of the same 'how'.
4453 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4456 const MGVTBL *vtable;
4459 #ifdef PERL_OLD_COPY_ON_WRITE
4461 sv_force_normal_flags(sv, 0);
4463 if (SvREADONLY(sv)) {
4465 /* its okay to attach magic to shared strings; the subsequent
4466 * upgrade to PVMG will unshare the string */
4467 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4470 && how != PERL_MAGIC_regex_global
4471 && how != PERL_MAGIC_bm
4472 && how != PERL_MAGIC_fm
4473 && how != PERL_MAGIC_sv
4474 && how != PERL_MAGIC_backref
4477 Perl_croak(aTHX_ PL_no_modify);
4480 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4481 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4482 /* sv_magic() refuses to add a magic of the same 'how' as an
4485 if (how == PERL_MAGIC_taint) {
4487 /* Any scalar which already had taint magic on which someone
4488 (erroneously?) did SvIOK_on() or similar will now be
4489 incorrectly sporting public "OK" flags. */
4490 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4498 vtable = &PL_vtbl_sv;
4500 case PERL_MAGIC_overload:
4501 vtable = &PL_vtbl_amagic;
4503 case PERL_MAGIC_overload_elem:
4504 vtable = &PL_vtbl_amagicelem;
4506 case PERL_MAGIC_overload_table:
4507 vtable = &PL_vtbl_ovrld;
4510 vtable = &PL_vtbl_bm;
4512 case PERL_MAGIC_regdata:
4513 vtable = &PL_vtbl_regdata;
4515 case PERL_MAGIC_regdatum:
4516 vtable = &PL_vtbl_regdatum;
4518 case PERL_MAGIC_env:
4519 vtable = &PL_vtbl_env;
4522 vtable = &PL_vtbl_fm;
4524 case PERL_MAGIC_envelem:
4525 vtable = &PL_vtbl_envelem;
4527 case PERL_MAGIC_regex_global:
4528 vtable = &PL_vtbl_mglob;
4530 case PERL_MAGIC_isa:
4531 vtable = &PL_vtbl_isa;
4533 case PERL_MAGIC_isaelem:
4534 vtable = &PL_vtbl_isaelem;
4536 case PERL_MAGIC_nkeys:
4537 vtable = &PL_vtbl_nkeys;
4539 case PERL_MAGIC_dbfile:
4542 case PERL_MAGIC_dbline:
4543 vtable = &PL_vtbl_dbline;
4545 #ifdef USE_LOCALE_COLLATE
4546 case PERL_MAGIC_collxfrm:
4547 vtable = &PL_vtbl_collxfrm;
4549 #endif /* USE_LOCALE_COLLATE */
4550 case PERL_MAGIC_tied:
4551 vtable = &PL_vtbl_pack;
4553 case PERL_MAGIC_tiedelem:
4554 case PERL_MAGIC_tiedscalar:
4555 vtable = &PL_vtbl_packelem;
4558 vtable = &PL_vtbl_regexp;
4560 case PERL_MAGIC_hints:
4561 /* As this vtable is all NULL, we can reuse it. */
4562 case PERL_MAGIC_sig:
4563 vtable = &PL_vtbl_sig;
4565 case PERL_MAGIC_sigelem:
4566 vtable = &PL_vtbl_sigelem;
4568 case PERL_MAGIC_taint:
4569 vtable = &PL_vtbl_taint;
4571 case PERL_MAGIC_uvar:
4572 vtable = &PL_vtbl_uvar;
4574 case PERL_MAGIC_vec:
4575 vtable = &PL_vtbl_vec;
4577 case PERL_MAGIC_arylen_p:
4578 case PERL_MAGIC_rhash:
4579 case PERL_MAGIC_symtab:
4580 case PERL_MAGIC_vstring:
4583 case PERL_MAGIC_utf8:
4584 vtable = &PL_vtbl_utf8;
4586 case PERL_MAGIC_substr:
4587 vtable = &PL_vtbl_substr;
4589 case PERL_MAGIC_defelem:
4590 vtable = &PL_vtbl_defelem;
4592 case PERL_MAGIC_arylen:
4593 vtable = &PL_vtbl_arylen;
4595 case PERL_MAGIC_pos:
4596 vtable = &PL_vtbl_pos;
4598 case PERL_MAGIC_backref:
4599 vtable = &PL_vtbl_backref;
4601 case PERL_MAGIC_hintselem:
4602 vtable = &PL_vtbl_hintselem;
4604 case PERL_MAGIC_ext:
4605 /* Reserved for use by extensions not perl internals. */
4606 /* Useful for attaching extension internal data to perl vars. */
4607 /* Note that multiple extensions may clash if magical scalars */
4608 /* etc holding private data from one are passed to another. */
4612 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4615 /* Rest of work is done else where */
4616 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4619 case PERL_MAGIC_taint:
4622 case PERL_MAGIC_ext:
4623 case PERL_MAGIC_dbfile:
4630 =for apidoc sv_unmagic
4632 Removes all magic of type C<type> from an SV.
4638 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4642 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4644 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4645 for (mg = *mgp; mg; mg = *mgp) {
4646 if (mg->mg_type == type) {
4647 const MGVTBL* const vtbl = mg->mg_virtual;
4648 *mgp = mg->mg_moremagic;
4649 if (vtbl && vtbl->svt_free)
4650 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4651 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4653 Safefree(mg->mg_ptr);
4654 else if (mg->mg_len == HEf_SVKEY)
4655 SvREFCNT_dec((SV*)mg->mg_ptr);
4656 else if (mg->mg_type == PERL_MAGIC_utf8)
4657 Safefree(mg->mg_ptr);
4659 if (mg->mg_flags & MGf_REFCOUNTED)
4660 SvREFCNT_dec(mg->mg_obj);
4664 mgp = &mg->mg_moremagic;
4668 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4669 SvMAGIC_set(sv, NULL);
4676 =for apidoc sv_rvweaken
4678 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4679 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4680 push a back-reference to this RV onto the array of backreferences
4681 associated with that magic. If the RV is magical, set magic will be
4682 called after the RV is cleared.
4688 Perl_sv_rvweaken(pTHX_ SV *sv)
4691 if (!SvOK(sv)) /* let undefs pass */
4694 Perl_croak(aTHX_ "Can't weaken a nonreference");
4695 else if (SvWEAKREF(sv)) {
4696 if (ckWARN(WARN_MISC))
4697 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4701 Perl_sv_add_backref(aTHX_ tsv, sv);
4707 /* Give tsv backref magic if it hasn't already got it, then push a
4708 * back-reference to sv onto the array associated with the backref magic.
4712 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4717 if (SvTYPE(tsv) == SVt_PVHV) {
4718 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4722 /* There is no AV in the offical place - try a fixup. */
4723 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4726 /* Aha. They've got it stowed in magic. Bring it back. */
4727 av = (AV*)mg->mg_obj;
4728 /* Stop mg_free decreasing the refernce count. */
4730 /* Stop mg_free even calling the destructor, given that
4731 there's no AV to free up. */
4733 sv_unmagic(tsv, PERL_MAGIC_backref);
4737 SvREFCNT_inc_simple_void(av);
4742 const MAGIC *const mg
4743 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4745 av = (AV*)mg->mg_obj;
4749 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4750 /* av now has a refcnt of 2, which avoids it getting freed
4751 * before us during global cleanup. The extra ref is removed
4752 * by magic_killbackrefs() when tsv is being freed */
4755 if (AvFILLp(av) >= AvMAX(av)) {
4756 av_extend(av, AvFILLp(av)+1);
4758 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4761 /* delete a back-reference to ourselves from the backref magic associated
4762 * with the SV we point to.
4766 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4773 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4774 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4775 /* We mustn't attempt to "fix up" the hash here by moving the
4776 backreference array back to the hv_aux structure, as that is stored
4777 in the main HvARRAY(), and hfreentries assumes that no-one
4778 reallocates HvARRAY() while it is running. */
4781 const MAGIC *const mg
4782 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4784 av = (AV *)mg->mg_obj;
4787 if (PL_in_clean_all)
4789 Perl_croak(aTHX_ "panic: del_backref");
4796 /* We shouldn't be in here more than once, but for paranoia reasons lets
4798 for (i = AvFILLp(av); i >= 0; i--) {
4800 const SSize_t fill = AvFILLp(av);
4802 /* We weren't the last entry.
4803 An unordered list has this property that you can take the
4804 last element off the end to fill the hole, and it's still
4805 an unordered list :-)
4810 AvFILLp(av) = fill - 1;
4816 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4818 SV **svp = AvARRAY(av);
4820 PERL_UNUSED_ARG(sv);
4822 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4823 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4824 if (svp && !SvIS_FREED(av)) {
4825 SV *const *const last = svp + AvFILLp(av);
4827 while (svp <= last) {
4829 SV *const referrer = *svp;
4830 if (SvWEAKREF(referrer)) {
4831 /* XXX Should we check that it hasn't changed? */
4832 SvRV_set(referrer, 0);
4834 SvWEAKREF_off(referrer);
4835 SvSETMAGIC(referrer);
4836 } else if (SvTYPE(referrer) == SVt_PVGV ||
4837 SvTYPE(referrer) == SVt_PVLV) {
4838 /* You lookin' at me? */
4839 assert(GvSTASH(referrer));
4840 assert(GvSTASH(referrer) == (HV*)sv);
4841 GvSTASH(referrer) = 0;
4844 "panic: magic_killbackrefs (flags=%"UVxf")",
4845 (UV)SvFLAGS(referrer));
4853 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4858 =for apidoc sv_insert
4860 Inserts a string at the specified offset/length within the SV. Similar to
4861 the Perl substr() function.
4867 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4872 register char *midend;
4873 register char *bigend;
4879 Perl_croak(aTHX_ "Can't modify non-existent substring");
4880 SvPV_force(bigstr, curlen);
4881 (void)SvPOK_only_UTF8(bigstr);
4882 if (offset + len > curlen) {
4883 SvGROW(bigstr, offset+len+1);
4884 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4885 SvCUR_set(bigstr, offset+len);
4889 i = littlelen - len;
4890 if (i > 0) { /* string might grow */
4891 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4892 mid = big + offset + len;
4893 midend = bigend = big + SvCUR(bigstr);
4896 while (midend > mid) /* shove everything down */
4897 *--bigend = *--midend;
4898 Move(little,big+offset,littlelen,char);
4899 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4904 Move(little,SvPVX(bigstr)+offset,len,char);
4909 big = SvPVX(bigstr);
4912 bigend = big + SvCUR(bigstr);
4914 if (midend > bigend)
4915 Perl_croak(aTHX_ "panic: sv_insert");
4917 if (mid - big > bigend - midend) { /* faster to shorten from end */
4919 Move(little, mid, littlelen,char);
4922 i = bigend - midend;
4924 Move(midend, mid, i,char);
4928 SvCUR_set(bigstr, mid - big);
4930 else if ((i = mid - big)) { /* faster from front */
4931 midend -= littlelen;
4933 sv_chop(bigstr,midend-i);
4938 Move(little, mid, littlelen,char);
4940 else if (littlelen) {
4941 midend -= littlelen;
4942 sv_chop(bigstr,midend);
4943 Move(little,midend,littlelen,char);
4946 sv_chop(bigstr,midend);
4952 =for apidoc sv_replace
4954 Make the first argument a copy of the second, then delete the original.
4955 The target SV physically takes over ownership of the body of the source SV
4956 and inherits its flags; however, the target keeps any magic it owns,
4957 and any magic in the source is discarded.
4958 Note that this is a rather specialist SV copying operation; most of the
4959 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4965 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4968 const U32 refcnt = SvREFCNT(sv);
4969 SV_CHECK_THINKFIRST_COW_DROP(sv);
4970 if (SvREFCNT(nsv) != 1) {
4971 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4972 UVuf " != 1)", (UV) SvREFCNT(nsv));
4974 if (SvMAGICAL(sv)) {
4978 sv_upgrade(nsv, SVt_PVMG);
4979 SvMAGIC_set(nsv, SvMAGIC(sv));
4980 SvFLAGS(nsv) |= SvMAGICAL(sv);
4982 SvMAGIC_set(sv, NULL);
4986 assert(!SvREFCNT(sv));
4987 #ifdef DEBUG_LEAKING_SCALARS
4988 sv->sv_flags = nsv->sv_flags;
4989 sv->sv_any = nsv->sv_any;
4990 sv->sv_refcnt = nsv->sv_refcnt;
4991 sv->sv_u = nsv->sv_u;
4993 StructCopy(nsv,sv,SV);
4995 /* Currently could join these into one piece of pointer arithmetic, but
4996 it would be unclear. */
4997 if(SvTYPE(sv) == SVt_IV)
4999 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5000 else if (SvTYPE(sv) == SVt_RV) {
5001 SvANY(sv) = &sv->sv_u.svu_rv;
5005 #ifdef PERL_OLD_COPY_ON_WRITE
5006 if (SvIsCOW_normal(nsv)) {
5007 /* We need to follow the pointers around the loop to make the
5008 previous SV point to sv, rather than nsv. */
5011 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5014 assert(SvPVX_const(current) == SvPVX_const(nsv));
5016 /* Make the SV before us point to the SV after us. */
5018 PerlIO_printf(Perl_debug_log, "previous is\n");
5020 PerlIO_printf(Perl_debug_log,
5021 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5022 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5024 SV_COW_NEXT_SV_SET(current, sv);
5027 SvREFCNT(sv) = refcnt;
5028 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5034 =for apidoc sv_clear
5036 Clear an SV: call any destructors, free up any memory used by the body,
5037 and free the body itself. The SV's head is I<not> freed, although
5038 its type is set to all 1's so that it won't inadvertently be assumed
5039 to be live during global destruction etc.
5040 This function should only be called when REFCNT is zero. Most of the time
5041 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5048 Perl_sv_clear(pTHX_ register SV *sv)
5051 const U32 type = SvTYPE(sv);
5052 const struct body_details *const sv_type_details
5053 = bodies_by_type + type;
5057 assert(SvREFCNT(sv) == 0);
5059 if (type <= SVt_IV) {
5060 /* See the comment in sv.h about the collusion between this early
5061 return and the overloading of the NULL and IV slots in the size
5067 if (PL_defstash) { /* Still have a symbol table? */
5072 stash = SvSTASH(sv);
5073 destructor = StashHANDLER(stash,DESTROY);
5075 SV* const tmpref = newRV(sv);
5076 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5078 PUSHSTACKi(PERLSI_DESTROY);
5083 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5089 if(SvREFCNT(tmpref) < 2) {
5090 /* tmpref is not kept alive! */
5092 SvRV_set(tmpref, NULL);
5095 SvREFCNT_dec(tmpref);
5097 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5101 if (PL_in_clean_objs)
5102 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5104 /* DESTROY gave object new lease on life */
5110 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5111 SvOBJECT_off(sv); /* Curse the object. */
5112 if (type != SVt_PVIO)
5113 --PL_sv_objcount; /* XXX Might want something more general */
5116 if (type >= SVt_PVMG) {
5117 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5118 SvREFCNT_dec(SvOURSTASH(sv));
5119 } else if (SvMAGIC(sv))
5121 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5122 SvREFCNT_dec(SvSTASH(sv));
5125 /* case SVt_BIND: */
5128 IoIFP(sv) != PerlIO_stdin() &&
5129 IoIFP(sv) != PerlIO_stdout() &&
5130 IoIFP(sv) != PerlIO_stderr())
5132 io_close((IO*)sv, FALSE);
5134 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5135 PerlDir_close(IoDIRP(sv));
5136 IoDIRP(sv) = (DIR*)NULL;
5137 Safefree(IoTOP_NAME(sv));
5138 Safefree(IoFMT_NAME(sv));
5139 Safefree(IoBOTTOM_NAME(sv));
5146 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5150 if (PL_comppad == (AV*)sv) {
5157 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5158 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5159 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5160 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5162 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5163 SvREFCNT_dec(LvTARG(sv));
5165 if (isGV_with_GP(sv)) {
5166 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5167 mro_method_changed_in(stash);
5170 unshare_hek(GvNAME_HEK(sv));
5171 /* If we're in a stash, we don't own a reference to it. However it does
5172 have a back reference to us, which needs to be cleared. */
5173 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5174 sv_del_backref((SV*)stash, sv);
5176 /* FIXME. There are probably more unreferenced pointers to SVs in the
5177 interpreter struct that we should check and tidy in a similar
5179 if ((GV*)sv == PL_last_in_gv)
5180 PL_last_in_gv = NULL;
5185 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5187 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5188 /* Don't even bother with turning off the OOK flag. */
5193 SV * const target = SvRV(sv);
5195 sv_del_backref(target, sv);
5197 SvREFCNT_dec(target);
5199 #ifdef PERL_OLD_COPY_ON_WRITE
5200 else if (SvPVX_const(sv)) {
5202 /* I believe I need to grab the global SV mutex here and
5203 then recheck the COW status. */
5205 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5209 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5211 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5214 /* And drop it here. */
5216 } else if (SvLEN(sv)) {
5217 Safefree(SvPVX_const(sv));
5221 else if (SvPVX_const(sv) && SvLEN(sv))
5222 Safefree(SvPVX_mutable(sv));
5223 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5224 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5233 SvFLAGS(sv) &= SVf_BREAK;
5234 SvFLAGS(sv) |= SVTYPEMASK;
5236 if (sv_type_details->arena) {
5237 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5238 &PL_body_roots[type]);
5240 else if (sv_type_details->body_size) {
5241 my_safefree(SvANY(sv));
5246 =for apidoc sv_newref
5248 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5255 Perl_sv_newref(pTHX_ SV *sv)
5257 PERL_UNUSED_CONTEXT;
5266 Decrement an SV's reference count, and if it drops to zero, call
5267 C<sv_clear> to invoke destructors and free up any memory used by
5268 the body; finally, deallocate the SV's head itself.
5269 Normally called via a wrapper macro C<SvREFCNT_dec>.
5275 Perl_sv_free(pTHX_ SV *sv)
5280 if (SvREFCNT(sv) == 0) {
5281 if (SvFLAGS(sv) & SVf_BREAK)
5282 /* this SV's refcnt has been artificially decremented to
5283 * trigger cleanup */
5285 if (PL_in_clean_all) /* All is fair */
5287 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5288 /* make sure SvREFCNT(sv)==0 happens very seldom */
5289 SvREFCNT(sv) = (~(U32)0)/2;
5292 if (ckWARN_d(WARN_INTERNAL)) {
5293 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5294 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5295 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5296 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5297 Perl_dump_sv_child(aTHX_ sv);
5299 #ifdef DEBUG_LEAKING_SCALARS
5306 if (--(SvREFCNT(sv)) > 0)
5308 Perl_sv_free2(aTHX_ sv);
5312 Perl_sv_free2(pTHX_ SV *sv)
5317 if (ckWARN_d(WARN_DEBUGGING))
5318 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5319 "Attempt to free temp prematurely: SV 0x%"UVxf
5320 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5324 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5325 /* make sure SvREFCNT(sv)==0 happens very seldom */
5326 SvREFCNT(sv) = (~(U32)0)/2;
5337 Returns the length of the string in the SV. Handles magic and type
5338 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5344 Perl_sv_len(pTHX_ register SV *sv)
5352 len = mg_length(sv);
5354 (void)SvPV_const(sv, len);
5359 =for apidoc sv_len_utf8
5361 Returns the number of characters in the string in an SV, counting wide
5362 UTF-8 bytes as a single character. Handles magic and type coercion.
5368 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5369 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5370 * (Note that the mg_len is not the length of the mg_ptr field.
5371 * This allows the cache to store the character length of the string without
5372 * needing to malloc() extra storage to attach to the mg_ptr.)
5377 Perl_sv_len_utf8(pTHX_ register SV *sv)
5383 return mg_length(sv);
5387 const U8 *s = (U8*)SvPV_const(sv, len);
5391 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5393 if (mg && mg->mg_len != -1) {
5395 if (PL_utf8cache < 0) {
5396 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5398 /* Need to turn the assertions off otherwise we may
5399 recurse infinitely while printing error messages.
5401 SAVEI8(PL_utf8cache);
5403 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5404 " real %"UVuf" for %"SVf,
5405 (UV) ulen, (UV) real, SVfARG(sv));
5410 ulen = Perl_utf8_length(aTHX_ s, s + len);
5411 if (!SvREADONLY(sv)) {
5413 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5414 &PL_vtbl_utf8, 0, 0);
5422 return Perl_utf8_length(aTHX_ s, s + len);
5426 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5429 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5432 const U8 *s = start;
5434 while (s < send && uoffset--)
5437 /* This is the existing behaviour. Possibly it should be a croak, as
5438 it's actually a bounds error */
5444 /* Given the length of the string in both bytes and UTF-8 characters, decide
5445 whether to walk forwards or backwards to find the byte corresponding to
5446 the passed in UTF-8 offset. */
5448 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5449 STRLEN uoffset, STRLEN uend)
5451 STRLEN backw = uend - uoffset;
5452 if (uoffset < 2 * backw) {
5453 /* The assumption is that going forwards is twice the speed of going
5454 forward (that's where the 2 * backw comes from).
5455 (The real figure of course depends on the UTF-8 data.) */
5456 return sv_pos_u2b_forwards(start, send, uoffset);
5461 while (UTF8_IS_CONTINUATION(*send))
5464 return send - start;
5467 /* For the string representation of the given scalar, find the byte
5468 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5469 give another position in the string, *before* the sought offset, which
5470 (which is always true, as 0, 0 is a valid pair of positions), which should
5471 help reduce the amount of linear searching.
5472 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5473 will be used to reduce the amount of linear searching. The cache will be
5474 created if necessary, and the found value offered to it for update. */
5476 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5477 const U8 *const send, STRLEN uoffset,
5478 STRLEN uoffset0, STRLEN boffset0) {
5479 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5482 assert (uoffset >= uoffset0);
5484 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5485 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5486 if ((*mgp)->mg_ptr) {
5487 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5488 if (cache[0] == uoffset) {
5489 /* An exact match. */
5492 if (cache[2] == uoffset) {
5493 /* An exact match. */
5497 if (cache[0] < uoffset) {
5498 /* The cache already knows part of the way. */
5499 if (cache[0] > uoffset0) {
5500 /* The cache knows more than the passed in pair */
5501 uoffset0 = cache[0];
5502 boffset0 = cache[1];
5504 if ((*mgp)->mg_len != -1) {
5505 /* And we know the end too. */
5507 + sv_pos_u2b_midway(start + boffset0, send,
5509 (*mgp)->mg_len - uoffset0);
5512 + sv_pos_u2b_forwards(start + boffset0,
5513 send, uoffset - uoffset0);
5516 else if (cache[2] < uoffset) {
5517 /* We're between the two cache entries. */
5518 if (cache[2] > uoffset0) {
5519 /* and the cache knows more than the passed in pair */
5520 uoffset0 = cache[2];
5521 boffset0 = cache[3];
5525 + sv_pos_u2b_midway(start + boffset0,
5528 cache[0] - uoffset0);
5531 + sv_pos_u2b_midway(start + boffset0,
5534 cache[2] - uoffset0);
5538 else if ((*mgp)->mg_len != -1) {
5539 /* If we can take advantage of a passed in offset, do so. */
5540 /* In fact, offset0 is either 0, or less than offset, so don't
5541 need to worry about the other possibility. */
5543 + sv_pos_u2b_midway(start + boffset0, send,
5545 (*mgp)->mg_len - uoffset0);
5550 if (!found || PL_utf8cache < 0) {
5551 const STRLEN real_boffset
5552 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5553 send, uoffset - uoffset0);
5555 if (found && PL_utf8cache < 0) {
5556 if (real_boffset != boffset) {
5557 /* Need to turn the assertions off otherwise we may recurse
5558 infinitely while printing error messages. */
5559 SAVEI8(PL_utf8cache);
5561 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5562 " real %"UVuf" for %"SVf,
5563 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5566 boffset = real_boffset;
5569 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5575 =for apidoc sv_pos_u2b
5577 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5578 the start of the string, to a count of the equivalent number of bytes; if
5579 lenp is non-zero, it does the same to lenp, but this time starting from
5580 the offset, rather than from the start of the string. Handles magic and
5587 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5588 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5589 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5594 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5602 start = (U8*)SvPV_const(sv, len);
5604 STRLEN uoffset = (STRLEN) *offsetp;
5605 const U8 * const send = start + len;
5607 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5610 *offsetp = (I32) boffset;
5613 /* Convert the relative offset to absolute. */
5614 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5615 const STRLEN boffset2
5616 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5617 uoffset, boffset) - boffset;
5631 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5632 byte length pairing. The (byte) length of the total SV is passed in too,
5633 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5634 may not have updated SvCUR, so we can't rely on reading it directly.
5636 The proffered utf8/byte length pairing isn't used if the cache already has
5637 two pairs, and swapping either for the proffered pair would increase the
5638 RMS of the intervals between known byte offsets.
5640 The cache itself consists of 4 STRLEN values
5641 0: larger UTF-8 offset
5642 1: corresponding byte offset
5643 2: smaller UTF-8 offset
5644 3: corresponding byte offset
5646 Unused cache pairs have the value 0, 0.
5647 Keeping the cache "backwards" means that the invariant of
5648 cache[0] >= cache[2] is maintained even with empty slots, which means that
5649 the code that uses it doesn't need to worry if only 1 entry has actually
5650 been set to non-zero. It also makes the "position beyond the end of the
5651 cache" logic much simpler, as the first slot is always the one to start
5655 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5663 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5665 (*mgp)->mg_len = -1;
5669 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5670 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5671 (*mgp)->mg_ptr = (char *) cache;
5675 if (PL_utf8cache < 0) {
5676 const U8 *start = (const U8 *) SvPVX_const(sv);
5677 const STRLEN realutf8 = utf8_length(start, start + byte);
5679 if (realutf8 != utf8) {
5680 /* Need to turn the assertions off otherwise we may recurse
5681 infinitely while printing error messages. */
5682 SAVEI8(PL_utf8cache);
5684 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5685 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5689 /* Cache is held with the later position first, to simplify the code
5690 that deals with unbounded ends. */
5692 ASSERT_UTF8_CACHE(cache);
5693 if (cache[1] == 0) {
5694 /* Cache is totally empty */
5697 } else if (cache[3] == 0) {
5698 if (byte > cache[1]) {
5699 /* New one is larger, so goes first. */
5700 cache[2] = cache[0];
5701 cache[3] = cache[1];
5709 #define THREEWAY_SQUARE(a,b,c,d) \
5710 ((float)((d) - (c))) * ((float)((d) - (c))) \
5711 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5712 + ((float)((b) - (a))) * ((float)((b) - (a)))
5714 /* Cache has 2 slots in use, and we know three potential pairs.
5715 Keep the two that give the lowest RMS distance. Do the
5716 calcualation in bytes simply because we always know the byte
5717 length. squareroot has the same ordering as the positive value,
5718 so don't bother with the actual square root. */
5719 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5720 if (byte > cache[1]) {
5721 /* New position is after the existing pair of pairs. */
5722 const float keep_earlier
5723 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5724 const float keep_later
5725 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5727 if (keep_later < keep_earlier) {
5728 if (keep_later < existing) {
5729 cache[2] = cache[0];
5730 cache[3] = cache[1];
5736 if (keep_earlier < existing) {
5742 else if (byte > cache[3]) {
5743 /* New position is between the existing pair of pairs. */
5744 const float keep_earlier
5745 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5746 const float keep_later
5747 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5749 if (keep_later < keep_earlier) {
5750 if (keep_later < existing) {
5756 if (keep_earlier < existing) {
5763 /* New position is before the existing pair of pairs. */
5764 const float keep_earlier
5765 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5766 const float keep_later
5767 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5769 if (keep_later < keep_earlier) {
5770 if (keep_later < existing) {
5776 if (keep_earlier < existing) {
5777 cache[0] = cache[2];
5778 cache[1] = cache[3];
5785 ASSERT_UTF8_CACHE(cache);
5788 /* We already know all of the way, now we may be able to walk back. The same
5789 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5790 backward is half the speed of walking forward. */
5792 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5795 const STRLEN forw = target - s;
5796 STRLEN backw = end - target;
5798 if (forw < 2 * backw) {
5799 return utf8_length(s, target);
5802 while (end > target) {
5804 while (UTF8_IS_CONTINUATION(*end)) {
5813 =for apidoc sv_pos_b2u
5815 Converts the value pointed to by offsetp from a count of bytes from the
5816 start of the string, to a count of the equivalent number of UTF-8 chars.
5817 Handles magic and type coercion.
5823 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5824 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5829 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5832 const STRLEN byte = *offsetp;
5833 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5842 s = (const U8*)SvPV_const(sv, blen);
5845 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5849 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5850 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5852 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5853 if (cache[1] == byte) {
5854 /* An exact match. */
5855 *offsetp = cache[0];
5858 if (cache[3] == byte) {
5859 /* An exact match. */
5860 *offsetp = cache[2];
5864 if (cache[1] < byte) {
5865 /* We already know part of the way. */
5866 if (mg->mg_len != -1) {
5867 /* Actually, we know the end too. */
5869 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5870 s + blen, mg->mg_len - cache[0]);
5872 len = cache[0] + utf8_length(s + cache[1], send);
5875 else if (cache[3] < byte) {
5876 /* We're between the two cached pairs, so we do the calculation
5877 offset by the byte/utf-8 positions for the earlier pair,
5878 then add the utf-8 characters from the string start to
5880 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5881 s + cache[1], cache[0] - cache[2])
5885 else { /* cache[3] > byte */
5886 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5890 ASSERT_UTF8_CACHE(cache);
5892 } else if (mg->mg_len != -1) {
5893 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5897 if (!found || PL_utf8cache < 0) {
5898 const STRLEN real_len = utf8_length(s, send);
5900 if (found && PL_utf8cache < 0) {
5901 if (len != real_len) {
5902 /* Need to turn the assertions off otherwise we may recurse
5903 infinitely while printing error messages. */
5904 SAVEI8(PL_utf8cache);
5906 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5907 " real %"UVuf" for %"SVf,
5908 (UV) len, (UV) real_len, SVfARG(sv));
5915 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5921 Returns a boolean indicating whether the strings in the two SVs are
5922 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5923 coerce its args to strings if necessary.
5929 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5938 SV* svrecode = NULL;
5945 /* if pv1 and pv2 are the same, second SvPV_const call may
5946 * invalidate pv1, so we may need to make a copy */
5947 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5948 pv1 = SvPV_const(sv1, cur1);
5949 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5950 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5952 pv1 = SvPV_const(sv1, cur1);
5960 pv2 = SvPV_const(sv2, cur2);
5962 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5963 /* Differing utf8ness.
5964 * Do not UTF8size the comparands as a side-effect. */
5967 svrecode = newSVpvn(pv2, cur2);
5968 sv_recode_to_utf8(svrecode, PL_encoding);
5969 pv2 = SvPV_const(svrecode, cur2);
5972 svrecode = newSVpvn(pv1, cur1);
5973 sv_recode_to_utf8(svrecode, PL_encoding);
5974 pv1 = SvPV_const(svrecode, cur1);
5976 /* Now both are in UTF-8. */
5978 SvREFCNT_dec(svrecode);
5983 bool is_utf8 = TRUE;
5986 /* sv1 is the UTF-8 one,
5987 * if is equal it must be downgrade-able */
5988 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5994 /* sv2 is the UTF-8 one,
5995 * if is equal it must be downgrade-able */
5996 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6002 /* Downgrade not possible - cannot be eq */
6010 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6012 SvREFCNT_dec(svrecode);
6022 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6023 string in C<sv1> is less than, equal to, or greater than the string in
6024 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6025 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6031 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6035 const char *pv1, *pv2;
6038 SV *svrecode = NULL;
6045 pv1 = SvPV_const(sv1, cur1);
6052 pv2 = SvPV_const(sv2, cur2);
6054 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6055 /* Differing utf8ness.
6056 * Do not UTF8size the comparands as a side-effect. */
6059 svrecode = newSVpvn(pv2, cur2);
6060 sv_recode_to_utf8(svrecode, PL_encoding);
6061 pv2 = SvPV_const(svrecode, cur2);
6064 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6069 svrecode = newSVpvn(pv1, cur1);
6070 sv_recode_to_utf8(svrecode, PL_encoding);
6071 pv1 = SvPV_const(svrecode, cur1);
6074 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6080 cmp = cur2 ? -1 : 0;
6084 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6087 cmp = retval < 0 ? -1 : 1;
6088 } else if (cur1 == cur2) {
6091 cmp = cur1 < cur2 ? -1 : 1;
6095 SvREFCNT_dec(svrecode);
6103 =for apidoc sv_cmp_locale
6105 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6106 'use bytes' aware, handles get magic, and will coerce its args to strings
6107 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6113 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6116 #ifdef USE_LOCALE_COLLATE
6122 if (PL_collation_standard)
6126 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6128 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6130 if (!pv1 || !len1) {
6141 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6144 return retval < 0 ? -1 : 1;
6147 * When the result of collation is equality, that doesn't mean
6148 * that there are no differences -- some locales exclude some
6149 * characters from consideration. So to avoid false equalities,
6150 * we use the raw string as a tiebreaker.
6156 #endif /* USE_LOCALE_COLLATE */
6158 return sv_cmp(sv1, sv2);
6162 #ifdef USE_LOCALE_COLLATE
6165 =for apidoc sv_collxfrm
6167 Add Collate Transform magic to an SV if it doesn't already have it.
6169 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6170 scalar data of the variable, but transformed to such a format that a normal
6171 memory comparison can be used to compare the data according to the locale
6178 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6183 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6184 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6190 Safefree(mg->mg_ptr);
6191 s = SvPV_const(sv, len);
6192 if ((xf = mem_collxfrm(s, len, &xlen))) {
6193 if (SvREADONLY(sv)) {
6196 return xf + sizeof(PL_collation_ix);
6199 #ifdef PERL_OLD_COPY_ON_WRITE
6201 sv_force_normal_flags(sv, 0);
6203 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6217 if (mg && mg->mg_ptr) {
6219 return mg->mg_ptr + sizeof(PL_collation_ix);
6227 #endif /* USE_LOCALE_COLLATE */
6232 Get a line from the filehandle and store it into the SV, optionally
6233 appending to the currently-stored string.
6239 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6244 register STDCHAR rslast;
6245 register STDCHAR *bp;
6250 if (SvTHINKFIRST(sv))
6251 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6252 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6254 However, perlbench says it's slower, because the existing swipe code
6255 is faster than copy on write.
6256 Swings and roundabouts. */
6257 SvUPGRADE(sv, SVt_PV);
6262 if (PerlIO_isutf8(fp)) {
6264 sv_utf8_upgrade_nomg(sv);
6265 sv_pos_u2b(sv,&append,0);
6267 } else if (SvUTF8(sv)) {
6268 SV * const tsv = newSV(0);
6269 sv_gets(tsv, fp, 0);
6270 sv_utf8_upgrade_nomg(tsv);
6271 SvCUR_set(sv,append);
6274 goto return_string_or_null;
6279 if (PerlIO_isutf8(fp))
6282 if (IN_PERL_COMPILETIME) {
6283 /* we always read code in line mode */
6287 else if (RsSNARF(PL_rs)) {
6288 /* If it is a regular disk file use size from stat() as estimate
6289 of amount we are going to read -- may result in mallocing
6290 more memory than we really need if the layers below reduce
6291 the size we read (e.g. CRLF or a gzip layer).
6294 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6295 const Off_t offset = PerlIO_tell(fp);
6296 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6297 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6303 else if (RsRECORD(PL_rs)) {
6308 /* Grab the size of the record we're getting */
6309 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6310 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6313 /* VMS wants read instead of fread, because fread doesn't respect */
6314 /* RMS record boundaries. This is not necessarily a good thing to be */
6315 /* doing, but we've got no other real choice - except avoid stdio
6316 as implementation - perhaps write a :vms layer ?
6318 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6320 bytesread = PerlIO_read(fp, buffer, recsize);
6324 SvCUR_set(sv, bytesread += append);
6325 buffer[bytesread] = '\0';
6326 goto return_string_or_null;
6328 else if (RsPARA(PL_rs)) {
6334 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6335 if (PerlIO_isutf8(fp)) {
6336 rsptr = SvPVutf8(PL_rs, rslen);
6339 if (SvUTF8(PL_rs)) {
6340 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6341 Perl_croak(aTHX_ "Wide character in $/");
6344 rsptr = SvPV_const(PL_rs, rslen);
6348 rslast = rslen ? rsptr[rslen - 1] : '\0';
6350 if (rspara) { /* have to do this both before and after */
6351 do { /* to make sure file boundaries work right */
6354 i = PerlIO_getc(fp);
6358 PerlIO_ungetc(fp,i);
6364 /* See if we know enough about I/O mechanism to cheat it ! */
6366 /* This used to be #ifdef test - it is made run-time test for ease
6367 of abstracting out stdio interface. One call should be cheap
6368 enough here - and may even be a macro allowing compile
6372 if (PerlIO_fast_gets(fp)) {
6375 * We're going to steal some values from the stdio struct
6376 * and put EVERYTHING in the innermost loop into registers.
6378 register STDCHAR *ptr;
6382 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6383 /* An ungetc()d char is handled separately from the regular
6384 * buffer, so we getc() it back out and stuff it in the buffer.
6386 i = PerlIO_getc(fp);
6387 if (i == EOF) return 0;
6388 *(--((*fp)->_ptr)) = (unsigned char) i;
6392 /* Here is some breathtakingly efficient cheating */
6394 cnt = PerlIO_get_cnt(fp); /* get count into register */
6395 /* make sure we have the room */
6396 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6397 /* Not room for all of it
6398 if we are looking for a separator and room for some
6400 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6401 /* just process what we have room for */
6402 shortbuffered = cnt - SvLEN(sv) + append + 1;
6403 cnt -= shortbuffered;
6407 /* remember that cnt can be negative */
6408 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6413 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6414 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6415 DEBUG_P(PerlIO_printf(Perl_debug_log,
6416 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6417 DEBUG_P(PerlIO_printf(Perl_debug_log,
6418 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6419 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6420 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6425 while (cnt > 0) { /* this | eat */
6427 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6428 goto thats_all_folks; /* screams | sed :-) */
6432 Copy(ptr, bp, cnt, char); /* this | eat */
6433 bp += cnt; /* screams | dust */
6434 ptr += cnt; /* louder | sed :-) */
6439 if (shortbuffered) { /* oh well, must extend */
6440 cnt = shortbuffered;
6442 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6444 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6445 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6449 DEBUG_P(PerlIO_printf(Perl_debug_log,
6450 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6451 PTR2UV(ptr),(long)cnt));
6452 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6454 DEBUG_P(PerlIO_printf(Perl_debug_log,
6455 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6456 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6457 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6459 /* This used to call 'filbuf' in stdio form, but as that behaves like
6460 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6461 another abstraction. */
6462 i = PerlIO_getc(fp); /* get more characters */
6464 DEBUG_P(PerlIO_printf(Perl_debug_log,
6465 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6466 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6467 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6469 cnt = PerlIO_get_cnt(fp);
6470 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6471 DEBUG_P(PerlIO_printf(Perl_debug_log,
6472 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6474 if (i == EOF) /* all done for ever? */
6475 goto thats_really_all_folks;
6477 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6479 SvGROW(sv, bpx + cnt + 2);
6480 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6482 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6484 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6485 goto thats_all_folks;
6489 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6490 memNE((char*)bp - rslen, rsptr, rslen))
6491 goto screamer; /* go back to the fray */
6492 thats_really_all_folks:
6494 cnt += shortbuffered;
6495 DEBUG_P(PerlIO_printf(Perl_debug_log,
6496 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6497 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6498 DEBUG_P(PerlIO_printf(Perl_debug_log,
6499 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6500 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6501 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6503 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6504 DEBUG_P(PerlIO_printf(Perl_debug_log,
6505 "Screamer: done, len=%ld, string=|%.*s|\n",
6506 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6510 /*The big, slow, and stupid way. */
6511 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6512 STDCHAR *buf = NULL;
6513 Newx(buf, 8192, STDCHAR);
6521 register const STDCHAR * const bpe = buf + sizeof(buf);
6523 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6524 ; /* keep reading */
6528 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6529 /* Accomodate broken VAXC compiler, which applies U8 cast to
6530 * both args of ?: operator, causing EOF to change into 255
6533 i = (U8)buf[cnt - 1];
6539 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6541 sv_catpvn(sv, (char *) buf, cnt);
6543 sv_setpvn(sv, (char *) buf, cnt);
6545 if (i != EOF && /* joy */
6547 SvCUR(sv) < rslen ||
6548 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6552 * If we're reading from a TTY and we get a short read,
6553 * indicating that the user hit his EOF character, we need
6554 * to notice it now, because if we try to read from the TTY
6555 * again, the EOF condition will disappear.
6557 * The comparison of cnt to sizeof(buf) is an optimization
6558 * that prevents unnecessary calls to feof().
6562 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6566 #ifdef USE_HEAP_INSTEAD_OF_STACK
6571 if (rspara) { /* have to do this both before and after */
6572 while (i != EOF) { /* to make sure file boundaries work right */
6573 i = PerlIO_getc(fp);
6575 PerlIO_ungetc(fp,i);
6581 return_string_or_null:
6582 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6588 Auto-increment of the value in the SV, doing string to numeric conversion
6589 if necessary. Handles 'get' magic.
6595 Perl_sv_inc(pTHX_ register SV *sv)
6604 if (SvTHINKFIRST(sv)) {
6606 sv_force_normal_flags(sv, 0);
6607 if (SvREADONLY(sv)) {
6608 if (IN_PERL_RUNTIME)
6609 Perl_croak(aTHX_ PL_no_modify);
6613 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6615 i = PTR2IV(SvRV(sv));
6620 flags = SvFLAGS(sv);
6621 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6622 /* It's (privately or publicly) a float, but not tested as an
6623 integer, so test it to see. */
6625 flags = SvFLAGS(sv);
6627 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6628 /* It's publicly an integer, or privately an integer-not-float */
6629 #ifdef PERL_PRESERVE_IVUV
6633 if (SvUVX(sv) == UV_MAX)
6634 sv_setnv(sv, UV_MAX_P1);
6636 (void)SvIOK_only_UV(sv);
6637 SvUV_set(sv, SvUVX(sv) + 1);
6639 if (SvIVX(sv) == IV_MAX)
6640 sv_setuv(sv, (UV)IV_MAX + 1);
6642 (void)SvIOK_only(sv);
6643 SvIV_set(sv, SvIVX(sv) + 1);
6648 if (flags & SVp_NOK) {
6649 (void)SvNOK_only(sv);
6650 SvNV_set(sv, SvNVX(sv) + 1.0);
6654 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6655 if ((flags & SVTYPEMASK) < SVt_PVIV)
6656 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6657 (void)SvIOK_only(sv);
6662 while (isALPHA(*d)) d++;
6663 while (isDIGIT(*d)) d++;
6665 #ifdef PERL_PRESERVE_IVUV
6666 /* Got to punt this as an integer if needs be, but we don't issue
6667 warnings. Probably ought to make the sv_iv_please() that does
6668 the conversion if possible, and silently. */
6669 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6670 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6671 /* Need to try really hard to see if it's an integer.
6672 9.22337203685478e+18 is an integer.
6673 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6674 so $a="9.22337203685478e+18"; $a+0; $a++
6675 needs to be the same as $a="9.22337203685478e+18"; $a++
6682 /* sv_2iv *should* have made this an NV */
6683 if (flags & SVp_NOK) {
6684 (void)SvNOK_only(sv);
6685 SvNV_set(sv, SvNVX(sv) + 1.0);
6688 /* I don't think we can get here. Maybe I should assert this
6689 And if we do get here I suspect that sv_setnv will croak. NWC
6691 #if defined(USE_LONG_DOUBLE)
6692 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",
6693 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6695 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6696 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6699 #endif /* PERL_PRESERVE_IVUV */
6700 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6704 while (d >= SvPVX_const(sv)) {
6712 /* MKS: The original code here died if letters weren't consecutive.
6713 * at least it didn't have to worry about non-C locales. The
6714 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6715 * arranged in order (although not consecutively) and that only
6716 * [A-Za-z] are accepted by isALPHA in the C locale.
6718 if (*d != 'z' && *d != 'Z') {
6719 do { ++*d; } while (!isALPHA(*d));
6722 *(d--) -= 'z' - 'a';
6727 *(d--) -= 'z' - 'a' + 1;
6731 /* oh,oh, the number grew */
6732 SvGROW(sv, SvCUR(sv) + 2);
6733 SvCUR_set(sv, SvCUR(sv) + 1);
6734 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6745 Auto-decrement of the value in the SV, doing string to numeric conversion
6746 if necessary. Handles 'get' magic.
6752 Perl_sv_dec(pTHX_ register SV *sv)
6760 if (SvTHINKFIRST(sv)) {
6762 sv_force_normal_flags(sv, 0);
6763 if (SvREADONLY(sv)) {
6764 if (IN_PERL_RUNTIME)
6765 Perl_croak(aTHX_ PL_no_modify);
6769 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6771 i = PTR2IV(SvRV(sv));
6776 /* Unlike sv_inc we don't have to worry about string-never-numbers
6777 and keeping them magic. But we mustn't warn on punting */
6778 flags = SvFLAGS(sv);
6779 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6780 /* It's publicly an integer, or privately an integer-not-float */
6781 #ifdef PERL_PRESERVE_IVUV
6785 if (SvUVX(sv) == 0) {
6786 (void)SvIOK_only(sv);
6790 (void)SvIOK_only_UV(sv);
6791 SvUV_set(sv, SvUVX(sv) - 1);
6794 if (SvIVX(sv) == IV_MIN)
6795 sv_setnv(sv, (NV)IV_MIN - 1.0);
6797 (void)SvIOK_only(sv);
6798 SvIV_set(sv, SvIVX(sv) - 1);
6803 if (flags & SVp_NOK) {
6804 SvNV_set(sv, SvNVX(sv) - 1.0);
6805 (void)SvNOK_only(sv);
6808 if (!(flags & SVp_POK)) {
6809 if ((flags & SVTYPEMASK) < SVt_PVIV)
6810 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6812 (void)SvIOK_only(sv);
6815 #ifdef PERL_PRESERVE_IVUV
6817 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6818 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6819 /* Need to try really hard to see if it's an integer.
6820 9.22337203685478e+18 is an integer.
6821 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6822 so $a="9.22337203685478e+18"; $a+0; $a--
6823 needs to be the same as $a="9.22337203685478e+18"; $a--
6830 /* sv_2iv *should* have made this an NV */
6831 if (flags & SVp_NOK) {
6832 (void)SvNOK_only(sv);
6833 SvNV_set(sv, SvNVX(sv) - 1.0);
6836 /* I don't think we can get here. Maybe I should assert this
6837 And if we do get here I suspect that sv_setnv will croak. NWC
6839 #if defined(USE_LONG_DOUBLE)
6840 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",
6841 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6843 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6844 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6848 #endif /* PERL_PRESERVE_IVUV */
6849 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6853 =for apidoc sv_mortalcopy
6855 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6856 The new SV is marked as mortal. It will be destroyed "soon", either by an
6857 explicit call to FREETMPS, or by an implicit call at places such as
6858 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6863 /* Make a string that will exist for the duration of the expression
6864 * evaluation. Actually, it may have to last longer than that, but
6865 * hopefully we won't free it until it has been assigned to a
6866 * permanent location. */
6869 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6875 sv_setsv(sv,oldstr);
6877 PL_tmps_stack[++PL_tmps_ix] = sv;
6883 =for apidoc sv_newmortal
6885 Creates a new null SV which is mortal. The reference count of the SV is
6886 set to 1. It will be destroyed "soon", either by an explicit call to
6887 FREETMPS, or by an implicit call at places such as statement boundaries.
6888 See also C<sv_mortalcopy> and C<sv_2mortal>.
6894 Perl_sv_newmortal(pTHX)
6900 SvFLAGS(sv) = SVs_TEMP;
6902 PL_tmps_stack[++PL_tmps_ix] = sv;
6907 =for apidoc sv_2mortal
6909 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6910 by an explicit call to FREETMPS, or by an implicit call at places such as
6911 statement boundaries. SvTEMP() is turned on which means that the SV's
6912 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6913 and C<sv_mortalcopy>.
6919 Perl_sv_2mortal(pTHX_ register SV *sv)
6924 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6927 PL_tmps_stack[++PL_tmps_ix] = sv;
6935 Creates a new SV and copies a string into it. The reference count for the
6936 SV is set to 1. If C<len> is zero, Perl will compute the length using
6937 strlen(). For efficiency, consider using C<newSVpvn> instead.
6943 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6949 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6954 =for apidoc newSVpvn
6956 Creates a new SV and copies a string into it. The reference count for the
6957 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6958 string. You are responsible for ensuring that the source string is at least
6959 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6965 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6971 sv_setpvn(sv,s,len);
6977 =for apidoc newSVhek
6979 Creates a new SV from the hash key structure. It will generate scalars that
6980 point to the shared string table where possible. Returns a new (undefined)
6981 SV if the hek is NULL.
6987 Perl_newSVhek(pTHX_ const HEK *hek)
6997 if (HEK_LEN(hek) == HEf_SVKEY) {
6998 return newSVsv(*(SV**)HEK_KEY(hek));
7000 const int flags = HEK_FLAGS(hek);
7001 if (flags & HVhek_WASUTF8) {
7003 Andreas would like keys he put in as utf8 to come back as utf8
7005 STRLEN utf8_len = HEK_LEN(hek);
7006 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7007 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7010 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7012 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7013 /* We don't have a pointer to the hv, so we have to replicate the
7014 flag into every HEK. This hv is using custom a hasing
7015 algorithm. Hence we can't return a shared string scalar, as
7016 that would contain the (wrong) hash value, and might get passed
7017 into an hv routine with a regular hash.
7018 Similarly, a hash that isn't using shared hash keys has to have
7019 the flag in every key so that we know not to try to call
7020 share_hek_kek on it. */
7022 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7027 /* This will be overwhelminly the most common case. */
7029 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7030 more efficient than sharepvn(). */
7034 sv_upgrade(sv, SVt_PV);
7035 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7036 SvCUR_set(sv, HEK_LEN(hek));
7049 =for apidoc newSVpvn_share
7051 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7052 table. If the string does not already exist in the table, it is created
7053 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7054 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7055 otherwise the hash is computed. The idea here is that as the string table
7056 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7057 hash lookup will avoid string compare.
7063 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7067 bool is_utf8 = FALSE;
7068 const char *const orig_src = src;
7071 STRLEN tmplen = -len;
7073 /* See the note in hv.c:hv_fetch() --jhi */
7074 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7078 PERL_HASH(hash, src, len);
7080 sv_upgrade(sv, SVt_PV);
7081 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7089 if (src != orig_src)
7095 #if defined(PERL_IMPLICIT_CONTEXT)
7097 /* pTHX_ magic can't cope with varargs, so this is a no-context
7098 * version of the main function, (which may itself be aliased to us).
7099 * Don't access this version directly.
7103 Perl_newSVpvf_nocontext(const char* pat, ...)
7108 va_start(args, pat);
7109 sv = vnewSVpvf(pat, &args);
7116 =for apidoc newSVpvf
7118 Creates a new SV and initializes it with the string formatted like
7125 Perl_newSVpvf(pTHX_ const char* pat, ...)
7129 va_start(args, pat);
7130 sv = vnewSVpvf(pat, &args);
7135 /* backend for newSVpvf() and newSVpvf_nocontext() */
7138 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7143 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7150 Creates a new SV and copies a floating point value into it.
7151 The reference count for the SV is set to 1.
7157 Perl_newSVnv(pTHX_ NV n)
7170 Creates a new SV and copies an integer into it. The reference count for the
7177 Perl_newSViv(pTHX_ IV i)
7190 Creates a new SV and copies an unsigned integer into it.
7191 The reference count for the SV is set to 1.
7197 Perl_newSVuv(pTHX_ UV u)
7208 =for apidoc newSV_type
7210 Creates a new SV, of the type specificied. The reference count for the new SV
7217 Perl_newSV_type(pTHX_ svtype type)
7222 sv_upgrade(sv, type);
7227 =for apidoc newRV_noinc
7229 Creates an RV wrapper for an SV. The reference count for the original
7230 SV is B<not> incremented.
7236 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7239 register SV *sv = newSV_type(SVt_RV);
7241 SvRV_set(sv, tmpRef);
7246 /* newRV_inc is the official function name to use now.
7247 * newRV_inc is in fact #defined to newRV in sv.h
7251 Perl_newRV(pTHX_ SV *sv)
7254 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7260 Creates a new SV which is an exact duplicate of the original SV.
7267 Perl_newSVsv(pTHX_ register SV *old)
7274 if (SvTYPE(old) == SVTYPEMASK) {
7275 if (ckWARN_d(WARN_INTERNAL))
7276 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7280 /* SV_GMAGIC is the default for sv_setv()
7281 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7282 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7283 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7288 =for apidoc sv_reset
7290 Underlying implementation for the C<reset> Perl function.
7291 Note that the perl-level function is vaguely deprecated.
7297 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7300 char todo[PERL_UCHAR_MAX+1];
7305 if (!*s) { /* reset ?? searches */
7306 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7308 const U32 count = mg->mg_len / sizeof(PMOP**);
7309 PMOP **pmp = (PMOP**) mg->mg_ptr;
7310 PMOP *const *const end = pmp + count;
7314 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7316 (*pmp)->op_pmflags &= ~PMf_USED;
7324 /* reset variables */
7326 if (!HvARRAY(stash))
7329 Zero(todo, 256, char);
7332 I32 i = (unsigned char)*s;
7336 max = (unsigned char)*s++;
7337 for ( ; i <= max; i++) {
7340 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7342 for (entry = HvARRAY(stash)[i];
7344 entry = HeNEXT(entry))
7349 if (!todo[(U8)*HeKEY(entry)])
7351 gv = (GV*)HeVAL(entry);
7354 if (SvTHINKFIRST(sv)) {
7355 if (!SvREADONLY(sv) && SvROK(sv))
7357 /* XXX Is this continue a bug? Why should THINKFIRST
7358 exempt us from resetting arrays and hashes? */
7362 if (SvTYPE(sv) >= SVt_PV) {
7364 if (SvPVX_const(sv) != NULL)
7372 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7374 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7377 # if defined(USE_ENVIRON_ARRAY)
7380 # endif /* USE_ENVIRON_ARRAY */
7391 Using various gambits, try to get an IO from an SV: the IO slot if its a
7392 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7393 named after the PV if we're a string.
7399 Perl_sv_2io(pTHX_ SV *sv)
7404 switch (SvTYPE(sv)) {
7412 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7416 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7418 return sv_2io(SvRV(sv));
7419 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7425 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7434 Using various gambits, try to get a CV from an SV; in addition, try if
7435 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7436 The flags in C<lref> are passed to sv_fetchsv.
7442 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7453 switch (SvTYPE(sv)) {
7472 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7473 tryAMAGICunDEREF(to_cv);
7476 if (SvTYPE(sv) == SVt_PVCV) {
7485 Perl_croak(aTHX_ "Not a subroutine reference");
7490 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7496 /* Some flags to gv_fetchsv mean don't really create the GV */
7497 if (SvTYPE(gv) != SVt_PVGV) {
7503 if (lref && !GvCVu(gv)) {
7507 gv_efullname3(tmpsv, gv, NULL);
7508 /* XXX this is probably not what they think they're getting.
7509 * It has the same effect as "sub name;", i.e. just a forward
7511 newSUB(start_subparse(FALSE, 0),
7512 newSVOP(OP_CONST, 0, tmpsv),
7516 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7526 Returns true if the SV has a true value by Perl's rules.
7527 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7528 instead use an in-line version.
7534 Perl_sv_true(pTHX_ register SV *sv)
7539 register const XPV* const tXpv = (XPV*)SvANY(sv);
7541 (tXpv->xpv_cur > 1 ||
7542 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7549 return SvIVX(sv) != 0;
7552 return SvNVX(sv) != 0.0;
7554 return sv_2bool(sv);
7560 =for apidoc sv_pvn_force
7562 Get a sensible string out of the SV somehow.
7563 A private implementation of the C<SvPV_force> macro for compilers which
7564 can't cope with complex macro expressions. Always use the macro instead.
7566 =for apidoc sv_pvn_force_flags
7568 Get a sensible string out of the SV somehow.
7569 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7570 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7571 implemented in terms of this function.
7572 You normally want to use the various wrapper macros instead: see
7573 C<SvPV_force> and C<SvPV_force_nomg>
7579 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7582 if (SvTHINKFIRST(sv) && !SvROK(sv))
7583 sv_force_normal_flags(sv, 0);
7593 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7594 const char * const ref = sv_reftype(sv,0);
7596 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7597 ref, OP_NAME(PL_op));
7599 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7601 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7602 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7604 s = sv_2pv_flags(sv, &len, flags);
7608 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7611 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7612 SvGROW(sv, len + 1);
7613 Move(s,SvPVX(sv),len,char);
7618 SvPOK_on(sv); /* validate pointer */
7620 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7621 PTR2UV(sv),SvPVX_const(sv)));
7624 return SvPVX_mutable(sv);
7628 =for apidoc sv_pvbyten_force
7630 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7636 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7638 sv_pvn_force(sv,lp);
7639 sv_utf8_downgrade(sv,0);
7645 =for apidoc sv_pvutf8n_force
7647 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7653 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7655 sv_pvn_force(sv,lp);
7656 sv_utf8_upgrade(sv);
7662 =for apidoc sv_reftype
7664 Returns a string describing what the SV is a reference to.
7670 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7672 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7673 inside return suggests a const propagation bug in g++. */
7674 if (ob && SvOBJECT(sv)) {
7675 char * const name = HvNAME_get(SvSTASH(sv));
7676 return name ? name : (char *) "__ANON__";
7679 switch (SvTYPE(sv)) {
7695 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7696 /* tied lvalues should appear to be
7697 * scalars for backwards compatitbility */
7698 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7699 ? "SCALAR" : "LVALUE");
7700 case SVt_PVAV: return "ARRAY";
7701 case SVt_PVHV: return "HASH";
7702 case SVt_PVCV: return "CODE";
7703 case SVt_PVGV: return "GLOB";
7704 case SVt_PVFM: return "FORMAT";
7705 case SVt_PVIO: return "IO";
7706 case SVt_BIND: return "BIND";
7707 default: return "UNKNOWN";
7713 =for apidoc sv_isobject
7715 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7716 object. If the SV is not an RV, or if the object is not blessed, then this
7723 Perl_sv_isobject(pTHX_ SV *sv)
7739 Returns a boolean indicating whether the SV is blessed into the specified
7740 class. This does not check for subtypes; use C<sv_derived_from> to verify
7741 an inheritance relationship.
7747 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7758 hvname = HvNAME_get(SvSTASH(sv));
7762 return strEQ(hvname, name);
7768 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7769 it will be upgraded to one. If C<classname> is non-null then the new SV will
7770 be blessed in the specified package. The new SV is returned and its
7771 reference count is 1.
7777 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7784 SV_CHECK_THINKFIRST_COW_DROP(rv);
7785 (void)SvAMAGIC_off(rv);
7787 if (SvTYPE(rv) >= SVt_PVMG) {
7788 const U32 refcnt = SvREFCNT(rv);
7792 SvREFCNT(rv) = refcnt;
7794 sv_upgrade(rv, SVt_RV);
7795 } else if (SvROK(rv)) {
7796 SvREFCNT_dec(SvRV(rv));
7797 } else if (SvTYPE(rv) < SVt_RV)
7798 sv_upgrade(rv, SVt_RV);
7799 else if (SvTYPE(rv) > SVt_RV) {
7810 HV* const stash = gv_stashpv(classname, GV_ADD);
7811 (void)sv_bless(rv, stash);
7817 =for apidoc sv_setref_pv
7819 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7820 argument will be upgraded to an RV. That RV will be modified to point to
7821 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7822 into the SV. The C<classname> argument indicates the package for the
7823 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7824 will have a reference count of 1, and the RV will be returned.
7826 Do not use with other Perl types such as HV, AV, SV, CV, because those
7827 objects will become corrupted by the pointer copy process.
7829 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7835 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7839 sv_setsv(rv, &PL_sv_undef);
7843 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7848 =for apidoc sv_setref_iv
7850 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7851 argument will be upgraded to an RV. That RV will be modified to point to
7852 the new SV. The C<classname> argument indicates the package for the
7853 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7854 will have a reference count of 1, and the RV will be returned.
7860 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7862 sv_setiv(newSVrv(rv,classname), iv);
7867 =for apidoc sv_setref_uv
7869 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7870 argument will be upgraded to an RV. That RV will be modified to point to
7871 the new SV. The C<classname> argument indicates the package for the
7872 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7873 will have a reference count of 1, and the RV will be returned.
7879 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7881 sv_setuv(newSVrv(rv,classname), uv);
7886 =for apidoc sv_setref_nv
7888 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7889 argument will be upgraded to an RV. That RV will be modified to point to
7890 the new SV. The C<classname> argument indicates the package for the
7891 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7892 will have a reference count of 1, and the RV will be returned.
7898 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7900 sv_setnv(newSVrv(rv,classname), nv);
7905 =for apidoc sv_setref_pvn
7907 Copies a string into a new SV, optionally blessing the SV. The length of the
7908 string must be specified with C<n>. The C<rv> argument will be upgraded to
7909 an RV. That RV will be modified to point to the new SV. The C<classname>
7910 argument indicates the package for the blessing. Set C<classname> to
7911 C<NULL> to avoid the blessing. The new SV will have a reference count
7912 of 1, and the RV will be returned.
7914 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7920 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7922 sv_setpvn(newSVrv(rv,classname), pv, n);
7927 =for apidoc sv_bless
7929 Blesses an SV into a specified package. The SV must be an RV. The package
7930 must be designated by its stash (see C<gv_stashpv()>). The reference count
7931 of the SV is unaffected.
7937 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7942 Perl_croak(aTHX_ "Can't bless non-reference value");
7944 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7945 if (SvREADONLY(tmpRef))
7946 Perl_croak(aTHX_ PL_no_modify);
7947 if (SvOBJECT(tmpRef)) {
7948 if (SvTYPE(tmpRef) != SVt_PVIO)
7950 SvREFCNT_dec(SvSTASH(tmpRef));
7953 SvOBJECT_on(tmpRef);
7954 if (SvTYPE(tmpRef) != SVt_PVIO)
7956 SvUPGRADE(tmpRef, SVt_PVMG);
7957 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7962 (void)SvAMAGIC_off(sv);
7964 if(SvSMAGICAL(tmpRef))
7965 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7973 /* Downgrades a PVGV to a PVMG.
7977 S_sv_unglob(pTHX_ SV *sv)
7982 SV * const temp = sv_newmortal();
7984 assert(SvTYPE(sv) == SVt_PVGV);
7986 gv_efullname3(temp, (GV *) sv, "*");
7989 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
7990 mro_method_changed_in(stash);
7994 sv_del_backref((SV*)GvSTASH(sv), sv);
7998 if (GvNAME_HEK(sv)) {
7999 unshare_hek(GvNAME_HEK(sv));
8001 isGV_with_GP_off(sv);
8003 /* need to keep SvANY(sv) in the right arena */
8004 xpvmg = new_XPVMG();
8005 StructCopy(SvANY(sv), xpvmg, XPVMG);
8006 del_XPVGV(SvANY(sv));
8009 SvFLAGS(sv) &= ~SVTYPEMASK;
8010 SvFLAGS(sv) |= SVt_PVMG;
8012 /* Intentionally not calling any local SET magic, as this isn't so much a
8013 set operation as merely an internal storage change. */
8014 sv_setsv_flags(sv, temp, 0);
8018 =for apidoc sv_unref_flags
8020 Unsets the RV status of the SV, and decrements the reference count of
8021 whatever was being referenced by the RV. This can almost be thought of
8022 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8023 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8024 (otherwise the decrementing is conditional on the reference count being
8025 different from one or the reference being a readonly SV).
8032 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8034 SV* const target = SvRV(ref);
8036 if (SvWEAKREF(ref)) {
8037 sv_del_backref(target, ref);
8039 SvRV_set(ref, NULL);
8042 SvRV_set(ref, NULL);
8044 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8045 assigned to as BEGIN {$a = \"Foo"} will fail. */
8046 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8047 SvREFCNT_dec(target);
8048 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8049 sv_2mortal(target); /* Schedule for freeing later */
8053 =for apidoc sv_untaint
8055 Untaint an SV. Use C<SvTAINTED_off> instead.
8060 Perl_sv_untaint(pTHX_ SV *sv)
8062 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8063 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8070 =for apidoc sv_tainted
8072 Test an SV for taintedness. Use C<SvTAINTED> instead.
8077 Perl_sv_tainted(pTHX_ SV *sv)
8079 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8080 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8081 if (mg && (mg->mg_len & 1) )
8088 =for apidoc sv_setpviv
8090 Copies an integer into the given SV, also updating its string value.
8091 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8097 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8099 char buf[TYPE_CHARS(UV)];
8101 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8103 sv_setpvn(sv, ptr, ebuf - ptr);
8107 =for apidoc sv_setpviv_mg
8109 Like C<sv_setpviv>, but also handles 'set' magic.
8115 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8121 #if defined(PERL_IMPLICIT_CONTEXT)
8123 /* pTHX_ magic can't cope with varargs, so this is a no-context
8124 * version of the main function, (which may itself be aliased to us).
8125 * Don't access this version directly.
8129 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8133 va_start(args, pat);
8134 sv_vsetpvf(sv, pat, &args);
8138 /* pTHX_ magic can't cope with varargs, so this is a no-context
8139 * version of the main function, (which may itself be aliased to us).
8140 * Don't access this version directly.
8144 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8148 va_start(args, pat);
8149 sv_vsetpvf_mg(sv, pat, &args);
8155 =for apidoc sv_setpvf
8157 Works like C<sv_catpvf> but copies the text into the SV instead of
8158 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8164 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8167 va_start(args, pat);
8168 sv_vsetpvf(sv, pat, &args);
8173 =for apidoc sv_vsetpvf
8175 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8176 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8178 Usually used via its frontend C<sv_setpvf>.
8184 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8186 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8190 =for apidoc sv_setpvf_mg
8192 Like C<sv_setpvf>, but also handles 'set' magic.
8198 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8201 va_start(args, pat);
8202 sv_vsetpvf_mg(sv, pat, &args);
8207 =for apidoc sv_vsetpvf_mg
8209 Like C<sv_vsetpvf>, but also handles 'set' magic.
8211 Usually used via its frontend C<sv_setpvf_mg>.
8217 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8219 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8223 #if defined(PERL_IMPLICIT_CONTEXT)
8225 /* pTHX_ magic can't cope with varargs, so this is a no-context
8226 * version of the main function, (which may itself be aliased to us).
8227 * Don't access this version directly.
8231 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8235 va_start(args, pat);
8236 sv_vcatpvf(sv, pat, &args);
8240 /* pTHX_ magic can't cope with varargs, so this is a no-context
8241 * version of the main function, (which may itself be aliased to us).
8242 * Don't access this version directly.
8246 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8250 va_start(args, pat);
8251 sv_vcatpvf_mg(sv, pat, &args);
8257 =for apidoc sv_catpvf
8259 Processes its arguments like C<sprintf> and appends the formatted
8260 output to an SV. If the appended data contains "wide" characters
8261 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8262 and characters >255 formatted with %c), the original SV might get
8263 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8264 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8265 valid UTF-8; if the original SV was bytes, the pattern should be too.
8270 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8273 va_start(args, pat);
8274 sv_vcatpvf(sv, pat, &args);
8279 =for apidoc sv_vcatpvf
8281 Processes its arguments like C<vsprintf> and appends the formatted output
8282 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8284 Usually used via its frontend C<sv_catpvf>.
8290 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8292 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8296 =for apidoc sv_catpvf_mg
8298 Like C<sv_catpvf>, but also handles 'set' magic.
8304 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8307 va_start(args, pat);
8308 sv_vcatpvf_mg(sv, pat, &args);
8313 =for apidoc sv_vcatpvf_mg
8315 Like C<sv_vcatpvf>, but also handles 'set' magic.
8317 Usually used via its frontend C<sv_catpvf_mg>.
8323 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8325 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8330 =for apidoc sv_vsetpvfn
8332 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8335 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8341 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8343 sv_setpvn(sv, "", 0);
8344 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8348 S_expect_number(pTHX_ char** pattern)
8352 switch (**pattern) {
8353 case '1': case '2': case '3':
8354 case '4': case '5': case '6':
8355 case '7': case '8': case '9':
8356 var = *(*pattern)++ - '0';
8357 while (isDIGIT(**pattern)) {
8358 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8360 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8368 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8370 const int neg = nv < 0;
8379 if (uv & 1 && uv == nv)
8380 uv--; /* Round to even */
8382 const unsigned dig = uv % 10;
8395 =for apidoc sv_vcatpvfn
8397 Processes its arguments like C<vsprintf> and appends the formatted output
8398 to an SV. Uses an array of SVs if the C style variable argument list is
8399 missing (NULL). When running with taint checks enabled, indicates via
8400 C<maybe_tainted> if results are untrustworthy (often due to the use of
8403 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8409 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8410 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8411 vec_utf8 = DO_UTF8(vecsv);
8413 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8416 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8424 static const char nullstr[] = "(null)";
8426 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8427 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8429 /* Times 4: a decimal digit takes more than 3 binary digits.
8430 * NV_DIG: mantissa takes than many decimal digits.
8431 * Plus 32: Playing safe. */
8432 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8433 /* large enough for "%#.#f" --chip */
8434 /* what about long double NVs? --jhi */
8436 PERL_UNUSED_ARG(maybe_tainted);
8438 /* no matter what, this is a string now */
8439 (void)SvPV_force(sv, origlen);
8441 /* special-case "", "%s", and "%-p" (SVf - see below) */
8444 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8446 const char * const s = va_arg(*args, char*);
8447 sv_catpv(sv, s ? s : nullstr);
8449 else if (svix < svmax) {
8450 sv_catsv(sv, *svargs);
8454 if (args && patlen == 3 && pat[0] == '%' &&
8455 pat[1] == '-' && pat[2] == 'p') {
8456 argsv = (SV*)va_arg(*args, void*);
8457 sv_catsv(sv, argsv);
8461 #ifndef USE_LONG_DOUBLE
8462 /* special-case "%.<number>[gf]" */
8463 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8464 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8465 unsigned digits = 0;
8469 while (*pp >= '0' && *pp <= '9')
8470 digits = 10 * digits + (*pp++ - '0');
8471 if (pp - pat == (int)patlen - 1) {
8479 /* Add check for digits != 0 because it seems that some
8480 gconverts are buggy in this case, and we don't yet have
8481 a Configure test for this. */
8482 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8483 /* 0, point, slack */
8484 Gconvert(nv, (int)digits, 0, ebuf);
8486 if (*ebuf) /* May return an empty string for digits==0 */
8489 } else if (!digits) {
8492 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8493 sv_catpvn(sv, p, l);
8499 #endif /* !USE_LONG_DOUBLE */
8501 if (!args && svix < svmax && DO_UTF8(*svargs))
8504 patend = (char*)pat + patlen;
8505 for (p = (char*)pat; p < patend; p = q) {
8508 bool vectorize = FALSE;
8509 bool vectorarg = FALSE;
8510 bool vec_utf8 = FALSE;
8516 bool has_precis = FALSE;
8518 const I32 osvix = svix;
8519 bool is_utf8 = FALSE; /* is this item utf8? */
8520 #ifdef HAS_LDBL_SPRINTF_BUG
8521 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8522 with sfio - Allen <allens@cpan.org> */
8523 bool fix_ldbl_sprintf_bug = FALSE;
8527 U8 utf8buf[UTF8_MAXBYTES+1];
8528 STRLEN esignlen = 0;
8530 const char *eptr = NULL;
8533 const U8 *vecstr = NULL;
8540 /* we need a long double target in case HAS_LONG_DOUBLE but
8543 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8551 const char *dotstr = ".";
8552 STRLEN dotstrlen = 1;
8553 I32 efix = 0; /* explicit format parameter index */
8554 I32 ewix = 0; /* explicit width index */
8555 I32 epix = 0; /* explicit precision index */
8556 I32 evix = 0; /* explicit vector index */
8557 bool asterisk = FALSE;
8559 /* echo everything up to the next format specification */
8560 for (q = p; q < patend && *q != '%'; ++q) ;
8562 if (has_utf8 && !pat_utf8)
8563 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8565 sv_catpvn(sv, p, q - p);
8572 We allow format specification elements in this order:
8573 \d+\$ explicit format parameter index
8575 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8576 0 flag (as above): repeated to allow "v02"
8577 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8578 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8580 [%bcdefginopsuxDFOUX] format (mandatory)
8585 As of perl5.9.3, printf format checking is on by default.
8586 Internally, perl uses %p formats to provide an escape to
8587 some extended formatting. This block deals with those
8588 extensions: if it does not match, (char*)q is reset and
8589 the normal format processing code is used.
8591 Currently defined extensions are:
8592 %p include pointer address (standard)
8593 %-p (SVf) include an SV (previously %_)
8594 %-<num>p include an SV with precision <num>
8595 %1p (VDf) include a v-string (as %vd)
8596 %<num>p reserved for future extensions
8598 Robin Barker 2005-07-14
8605 n = expect_number(&q);
8612 argsv = (SV*)va_arg(*args, void*);
8613 eptr = SvPV_const(argsv, elen);
8619 else if (n == vdNUMBER) { /* VDf */
8626 if (ckWARN_d(WARN_INTERNAL))
8627 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8628 "internal %%<num>p might conflict with future printf extensions");
8634 if ( (width = expect_number(&q)) ) {
8649 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8678 if ( (ewix = expect_number(&q)) )
8687 if ((vectorarg = asterisk)) {
8700 width = expect_number(&q);
8706 vecsv = va_arg(*args, SV*);
8708 vecsv = (evix > 0 && evix <= svmax)
8709 ? svargs[evix-1] : &PL_sv_undef;
8711 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8713 dotstr = SvPV_const(vecsv, dotstrlen);
8714 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8715 bad with tied or overloaded values that return UTF8. */
8718 else if (has_utf8) {
8719 vecsv = sv_mortalcopy(vecsv);
8720 sv_utf8_upgrade(vecsv);
8721 dotstr = SvPV_const(vecsv, dotstrlen);
8728 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8729 vecsv = svargs[efix ? efix-1 : svix++];
8730 vecstr = (U8*)SvPV_const(vecsv,veclen);
8731 vec_utf8 = DO_UTF8(vecsv);
8733 /* if this is a version object, we need to convert
8734 * back into v-string notation and then let the
8735 * vectorize happen normally
8737 if (sv_derived_from(vecsv, "version")) {
8738 char *version = savesvpv(vecsv);
8739 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8740 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8741 "vector argument not supported with alpha versions");
8744 vecsv = sv_newmortal();
8745 scan_vstring(version, version + veclen, vecsv);
8746 vecstr = (U8*)SvPV_const(vecsv, veclen);
8747 vec_utf8 = DO_UTF8(vecsv);
8759 i = va_arg(*args, int);
8761 i = (ewix ? ewix <= svmax : svix < svmax) ?
8762 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8764 width = (i < 0) ? -i : i;
8774 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8776 /* XXX: todo, support specified precision parameter */
8780 i = va_arg(*args, int);
8782 i = (ewix ? ewix <= svmax : svix < svmax)
8783 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8785 has_precis = !(i < 0);
8790 precis = precis * 10 + (*q++ - '0');
8799 case 'I': /* Ix, I32x, and I64x */
8801 if (q[1] == '6' && q[2] == '4') {
8807 if (q[1] == '3' && q[2] == '2') {
8817 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8828 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8829 if (*(q + 1) == 'l') { /* lld, llf */
8855 if (!vectorize && !args) {
8857 const I32 i = efix-1;
8858 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8860 argsv = (svix >= 0 && svix < svmax)
8861 ? svargs[svix++] : &PL_sv_undef;
8872 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8874 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8876 eptr = (char*)utf8buf;
8877 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8891 eptr = va_arg(*args, char*);
8893 #ifdef MACOS_TRADITIONAL
8894 /* On MacOS, %#s format is used for Pascal strings */
8899 elen = strlen(eptr);
8901 eptr = (char *)nullstr;
8902 elen = sizeof nullstr - 1;
8906 eptr = SvPV_const(argsv, elen);
8907 if (DO_UTF8(argsv)) {
8908 I32 old_precis = precis;
8909 if (has_precis && precis < elen) {
8911 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8914 if (width) { /* fudge width (can't fudge elen) */
8915 if (has_precis && precis < elen)
8916 width += precis - old_precis;
8918 width += elen - sv_len_utf8(argsv);
8925 if (has_precis && elen > precis)
8932 if (alt || vectorize)
8934 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8955 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8964 esignbuf[esignlen++] = plus;
8968 case 'h': iv = (short)va_arg(*args, int); break;
8969 case 'l': iv = va_arg(*args, long); break;
8970 case 'V': iv = va_arg(*args, IV); break;
8971 default: iv = va_arg(*args, int); break;
8973 case 'q': iv = va_arg(*args, Quad_t); break;
8978 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
8980 case 'h': iv = (short)tiv; break;
8981 case 'l': iv = (long)tiv; break;
8983 default: iv = tiv; break;
8985 case 'q': iv = (Quad_t)tiv; break;
8989 if ( !vectorize ) /* we already set uv above */
8994 esignbuf[esignlen++] = plus;
8998 esignbuf[esignlen++] = '-';
9042 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9053 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9054 case 'l': uv = va_arg(*args, unsigned long); break;
9055 case 'V': uv = va_arg(*args, UV); break;
9056 default: uv = va_arg(*args, unsigned); break;
9058 case 'q': uv = va_arg(*args, Uquad_t); break;
9063 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9065 case 'h': uv = (unsigned short)tuv; break;
9066 case 'l': uv = (unsigned long)tuv; break;
9068 default: uv = tuv; break;
9070 case 'q': uv = (Uquad_t)tuv; break;
9077 char *ptr = ebuf + sizeof ebuf;
9078 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9084 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9090 esignbuf[esignlen++] = '0';
9091 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9099 if (alt && *ptr != '0')
9108 esignbuf[esignlen++] = '0';
9109 esignbuf[esignlen++] = c;
9112 default: /* it had better be ten or less */
9116 } while (uv /= base);
9119 elen = (ebuf + sizeof ebuf) - ptr;
9123 zeros = precis - elen;
9124 else if (precis == 0 && elen == 1 && *eptr == '0'
9125 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9128 /* a precision nullifies the 0 flag. */
9135 /* FLOATING POINT */
9138 c = 'f'; /* maybe %F isn't supported here */
9146 /* This is evil, but floating point is even more evil */
9148 /* for SV-style calling, we can only get NV
9149 for C-style calling, we assume %f is double;
9150 for simplicity we allow any of %Lf, %llf, %qf for long double
9154 #if defined(USE_LONG_DOUBLE)
9158 /* [perl #20339] - we should accept and ignore %lf rather than die */
9162 #if defined(USE_LONG_DOUBLE)
9163 intsize = args ? 0 : 'q';
9167 #if defined(HAS_LONG_DOUBLE)
9176 /* now we need (long double) if intsize == 'q', else (double) */
9178 #if LONG_DOUBLESIZE > DOUBLESIZE
9180 va_arg(*args, long double) :
9181 va_arg(*args, double)
9183 va_arg(*args, double)
9188 if (c != 'e' && c != 'E') {
9190 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9191 will cast our (long double) to (double) */
9192 (void)Perl_frexp(nv, &i);
9193 if (i == PERL_INT_MIN)
9194 Perl_die(aTHX_ "panic: frexp");
9196 need = BIT_DIGITS(i);
9198 need += has_precis ? precis : 6; /* known default */
9203 #ifdef HAS_LDBL_SPRINTF_BUG
9204 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9205 with sfio - Allen <allens@cpan.org> */
9208 # define MY_DBL_MAX DBL_MAX
9209 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9210 # if DOUBLESIZE >= 8
9211 # define MY_DBL_MAX 1.7976931348623157E+308L
9213 # define MY_DBL_MAX 3.40282347E+38L
9217 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9218 # define MY_DBL_MAX_BUG 1L
9220 # define MY_DBL_MAX_BUG MY_DBL_MAX
9224 # define MY_DBL_MIN DBL_MIN
9225 # else /* XXX guessing! -Allen */
9226 # if DOUBLESIZE >= 8
9227 # define MY_DBL_MIN 2.2250738585072014E-308L
9229 # define MY_DBL_MIN 1.17549435E-38L
9233 if ((intsize == 'q') && (c == 'f') &&
9234 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9236 /* it's going to be short enough that
9237 * long double precision is not needed */
9239 if ((nv <= 0L) && (nv >= -0L))
9240 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9242 /* would use Perl_fp_class as a double-check but not
9243 * functional on IRIX - see perl.h comments */
9245 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9246 /* It's within the range that a double can represent */
9247 #if defined(DBL_MAX) && !defined(DBL_MIN)
9248 if ((nv >= ((long double)1/DBL_MAX)) ||
9249 (nv <= (-(long double)1/DBL_MAX)))
9251 fix_ldbl_sprintf_bug = TRUE;
9254 if (fix_ldbl_sprintf_bug == TRUE) {
9264 # undef MY_DBL_MAX_BUG
9267 #endif /* HAS_LDBL_SPRINTF_BUG */
9269 need += 20; /* fudge factor */
9270 if (PL_efloatsize < need) {
9271 Safefree(PL_efloatbuf);
9272 PL_efloatsize = need + 20; /* more fudge */
9273 Newx(PL_efloatbuf, PL_efloatsize, char);
9274 PL_efloatbuf[0] = '\0';
9277 if ( !(width || left || plus || alt) && fill != '0'
9278 && has_precis && intsize != 'q' ) { /* Shortcuts */
9279 /* See earlier comment about buggy Gconvert when digits,
9281 if ( c == 'g' && precis) {
9282 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9283 /* May return an empty string for digits==0 */
9284 if (*PL_efloatbuf) {
9285 elen = strlen(PL_efloatbuf);
9286 goto float_converted;
9288 } else if ( c == 'f' && !precis) {
9289 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9294 char *ptr = ebuf + sizeof ebuf;
9297 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9298 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9299 if (intsize == 'q') {
9300 /* Copy the one or more characters in a long double
9301 * format before the 'base' ([efgEFG]) character to
9302 * the format string. */
9303 static char const prifldbl[] = PERL_PRIfldbl;
9304 char const *p = prifldbl + sizeof(prifldbl) - 3;
9305 while (p >= prifldbl) { *--ptr = *p--; }
9310 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9315 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9327 /* No taint. Otherwise we are in the strange situation
9328 * where printf() taints but print($float) doesn't.
9330 #if defined(HAS_LONG_DOUBLE)
9331 elen = ((intsize == 'q')
9332 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9333 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9335 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9339 eptr = PL_efloatbuf;
9347 i = SvCUR(sv) - origlen;
9350 case 'h': *(va_arg(*args, short*)) = i; break;
9351 default: *(va_arg(*args, int*)) = i; break;
9352 case 'l': *(va_arg(*args, long*)) = i; break;
9353 case 'V': *(va_arg(*args, IV*)) = i; break;
9355 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9360 sv_setuv_mg(argsv, (UV)i);
9361 continue; /* not "break" */
9368 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9369 && ckWARN(WARN_PRINTF))
9371 SV * const msg = sv_newmortal();
9372 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9373 (PL_op->op_type == OP_PRTF) ? "" : "s");
9376 Perl_sv_catpvf(aTHX_ msg,
9377 "\"%%%c\"", c & 0xFF);
9379 Perl_sv_catpvf(aTHX_ msg,
9380 "\"%%\\%03"UVof"\"",
9383 sv_catpvs(msg, "end of string");
9384 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9387 /* output mangled stuff ... */
9393 /* ... right here, because formatting flags should not apply */
9394 SvGROW(sv, SvCUR(sv) + elen + 1);
9396 Copy(eptr, p, elen, char);
9399 SvCUR_set(sv, p - SvPVX_const(sv));
9401 continue; /* not "break" */
9404 if (is_utf8 != has_utf8) {
9407 sv_utf8_upgrade(sv);
9410 const STRLEN old_elen = elen;
9411 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9412 sv_utf8_upgrade(nsv);
9413 eptr = SvPVX_const(nsv);
9416 if (width) { /* fudge width (can't fudge elen) */
9417 width += elen - old_elen;
9423 have = esignlen + zeros + elen;
9425 Perl_croak_nocontext(PL_memory_wrap);
9427 need = (have > width ? have : width);
9430 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9431 Perl_croak_nocontext(PL_memory_wrap);
9432 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9434 if (esignlen && fill == '0') {
9436 for (i = 0; i < (int)esignlen; i++)
9440 memset(p, fill, gap);
9443 if (esignlen && fill != '0') {
9445 for (i = 0; i < (int)esignlen; i++)
9450 for (i = zeros; i; i--)
9454 Copy(eptr, p, elen, char);
9458 memset(p, ' ', gap);
9463 Copy(dotstr, p, dotstrlen, char);
9467 vectorize = FALSE; /* done iterating over vecstr */
9474 SvCUR_set(sv, p - SvPVX_const(sv));
9482 /* =========================================================================
9484 =head1 Cloning an interpreter
9486 All the macros and functions in this section are for the private use of
9487 the main function, perl_clone().
9489 The foo_dup() functions make an exact copy of an existing foo thinngy.
9490 During the course of a cloning, a hash table is used to map old addresses
9491 to new addresses. The table is created and manipulated with the
9492 ptr_table_* functions.
9496 ============================================================================*/
9499 #if defined(USE_ITHREADS)
9501 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9502 #ifndef GpREFCNT_inc
9503 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9507 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9508 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9509 If this changes, please unmerge ss_dup. */
9510 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9511 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9512 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9513 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9514 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9515 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9516 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9517 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9518 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9519 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9520 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9521 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9522 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9523 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9525 /* clone a parser */
9528 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9535 /* look for it in the table first */
9536 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9540 /* create anew and remember what it is */
9541 Newxz(parser, 1, yy_parser);
9542 ptr_table_store(PL_ptr_table, proto, parser);
9544 parser->yyerrstatus = 0;
9545 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9547 /* XXX these not yet duped */
9548 parser->old_parser = NULL;
9549 parser->stack = NULL;
9551 parser->stack_size = 0;
9552 /* XXX parser->stack->state = 0; */
9554 /* XXX eventually, just Copy() most of the parser struct ? */
9556 parser->lex_brackets = proto->lex_brackets;
9557 parser->lex_casemods = proto->lex_casemods;
9558 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9559 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9560 parser->lex_casestack = savepvn(proto->lex_casestack,
9561 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9562 parser->lex_defer = proto->lex_defer;
9563 parser->lex_dojoin = proto->lex_dojoin;
9564 parser->lex_expect = proto->lex_expect;
9565 parser->lex_formbrack = proto->lex_formbrack;
9566 parser->lex_inpat = proto->lex_inpat;
9567 parser->lex_inwhat = proto->lex_inwhat;
9568 parser->lex_op = proto->lex_op;
9569 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9570 parser->lex_starts = proto->lex_starts;
9571 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9572 parser->multi_close = proto->multi_close;
9573 parser->multi_open = proto->multi_open;
9574 parser->multi_start = proto->multi_start;
9575 parser->multi_end = proto->multi_end;
9576 parser->pending_ident = proto->pending_ident;
9577 parser->preambled = proto->preambled;
9578 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9579 parser->linestr = sv_dup_inc(proto->linestr, param);
9580 parser->expect = proto->expect;
9581 parser->copline = proto->copline;
9582 parser->last_lop_op = proto->last_lop_op;
9583 parser->lex_state = proto->lex_state;
9584 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9585 /* rsfp_filters entries have fake IoDIRP() */
9586 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9587 parser->in_my = proto->in_my;
9588 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9589 parser->error_count = proto->error_count;
9592 parser->linestr = sv_dup_inc(proto->linestr, param);
9595 char * const ols = SvPVX(proto->linestr);
9596 char * const ls = SvPVX(parser->linestr);
9598 parser->bufptr = ls + (proto->bufptr >= ols ?
9599 proto->bufptr - ols : 0);
9600 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9601 proto->oldbufptr - ols : 0);
9602 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9603 proto->oldoldbufptr - ols : 0);
9604 parser->linestart = ls + (proto->linestart >= ols ?
9605 proto->linestart - ols : 0);
9606 parser->last_uni = ls + (proto->last_uni >= ols ?
9607 proto->last_uni - ols : 0);
9608 parser->last_lop = ls + (proto->last_lop >= ols ?
9609 proto->last_lop - ols : 0);
9611 parser->bufend = ls + SvCUR(parser->linestr);
9614 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9618 parser->endwhite = proto->endwhite;
9619 parser->faketokens = proto->faketokens;
9620 parser->lasttoke = proto->lasttoke;
9621 parser->nextwhite = proto->nextwhite;
9622 parser->realtokenstart = proto->realtokenstart;
9623 parser->skipwhite = proto->skipwhite;
9624 parser->thisclose = proto->thisclose;
9625 parser->thismad = proto->thismad;
9626 parser->thisopen = proto->thisopen;
9627 parser->thisstuff = proto->thisstuff;
9628 parser->thistoken = proto->thistoken;
9629 parser->thiswhite = proto->thiswhite;
9631 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9632 parser->curforce = proto->curforce;
9634 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9635 Copy(proto->nexttype, parser->nexttype, 5, I32);
9636 parser->nexttoke = proto->nexttoke;
9642 /* duplicate a file handle */
9645 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9649 PERL_UNUSED_ARG(type);
9652 return (PerlIO*)NULL;
9654 /* look for it in the table first */
9655 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9659 /* create anew and remember what it is */
9660 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9661 ptr_table_store(PL_ptr_table, fp, ret);
9665 /* duplicate a directory handle */
9668 Perl_dirp_dup(pTHX_ DIR *dp)
9670 PERL_UNUSED_CONTEXT;
9677 /* duplicate a typeglob */
9680 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9686 /* look for it in the table first */
9687 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9691 /* create anew and remember what it is */
9693 ptr_table_store(PL_ptr_table, gp, ret);
9696 ret->gp_refcnt = 0; /* must be before any other dups! */
9697 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9698 ret->gp_io = io_dup_inc(gp->gp_io, param);
9699 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9700 ret->gp_av = av_dup_inc(gp->gp_av, param);
9701 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9702 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9703 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9704 ret->gp_cvgen = gp->gp_cvgen;
9705 ret->gp_line = gp->gp_line;
9706 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9710 /* duplicate a chain of magic */
9713 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9715 MAGIC *mgprev = (MAGIC*)NULL;
9718 return (MAGIC*)NULL;
9719 /* look for it in the table first */
9720 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9724 for (; mg; mg = mg->mg_moremagic) {
9726 Newxz(nmg, 1, MAGIC);
9728 mgprev->mg_moremagic = nmg;
9731 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9732 nmg->mg_private = mg->mg_private;
9733 nmg->mg_type = mg->mg_type;
9734 nmg->mg_flags = mg->mg_flags;
9735 if (mg->mg_type == PERL_MAGIC_qr) {
9736 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9738 else if(mg->mg_type == PERL_MAGIC_backref) {
9739 /* The backref AV has its reference count deliberately bumped by
9741 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9744 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9745 ? sv_dup_inc(mg->mg_obj, param)
9746 : sv_dup(mg->mg_obj, param);
9748 nmg->mg_len = mg->mg_len;
9749 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9750 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9751 if (mg->mg_len > 0) {
9752 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9753 if (mg->mg_type == PERL_MAGIC_overload_table &&
9754 AMT_AMAGIC((AMT*)mg->mg_ptr))
9756 const AMT * const amtp = (AMT*)mg->mg_ptr;
9757 AMT * const namtp = (AMT*)nmg->mg_ptr;
9759 for (i = 1; i < NofAMmeth; i++) {
9760 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9764 else if (mg->mg_len == HEf_SVKEY)
9765 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9767 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9768 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9775 #endif /* USE_ITHREADS */
9777 /* create a new pointer-mapping table */
9780 Perl_ptr_table_new(pTHX)
9783 PERL_UNUSED_CONTEXT;
9785 Newxz(tbl, 1, PTR_TBL_t);
9788 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9792 #define PTR_TABLE_HASH(ptr) \
9793 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9796 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9797 following define) and at call to new_body_inline made below in
9798 Perl_ptr_table_store()
9801 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9803 /* map an existing pointer using a table */
9805 STATIC PTR_TBL_ENT_t *
9806 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9807 PTR_TBL_ENT_t *tblent;
9808 const UV hash = PTR_TABLE_HASH(sv);
9810 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9811 for (; tblent; tblent = tblent->next) {
9812 if (tblent->oldval == sv)
9819 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9821 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9822 PERL_UNUSED_CONTEXT;
9823 return tblent ? tblent->newval : NULL;
9826 /* add a new entry to a pointer-mapping table */
9829 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9831 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9832 PERL_UNUSED_CONTEXT;
9835 tblent->newval = newsv;
9837 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9839 new_body_inline(tblent, PTE_SVSLOT);
9841 tblent->oldval = oldsv;
9842 tblent->newval = newsv;
9843 tblent->next = tbl->tbl_ary[entry];
9844 tbl->tbl_ary[entry] = tblent;
9846 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9847 ptr_table_split(tbl);
9851 /* double the hash bucket size of an existing ptr table */
9854 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9856 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9857 const UV oldsize = tbl->tbl_max + 1;
9858 UV newsize = oldsize * 2;
9860 PERL_UNUSED_CONTEXT;
9862 Renew(ary, newsize, PTR_TBL_ENT_t*);
9863 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9864 tbl->tbl_max = --newsize;
9866 for (i=0; i < oldsize; i++, ary++) {
9867 PTR_TBL_ENT_t **curentp, **entp, *ent;
9870 curentp = ary + oldsize;
9871 for (entp = ary, ent = *ary; ent; ent = *entp) {
9872 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9874 ent->next = *curentp;
9884 /* remove all the entries from a ptr table */
9887 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9889 if (tbl && tbl->tbl_items) {
9890 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9891 UV riter = tbl->tbl_max;
9894 PTR_TBL_ENT_t *entry = array[riter];
9897 PTR_TBL_ENT_t * const oentry = entry;
9898 entry = entry->next;
9907 /* clear and free a ptr table */
9910 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9915 ptr_table_clear(tbl);
9916 Safefree(tbl->tbl_ary);
9920 #if defined(USE_ITHREADS)
9923 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9926 SvRV_set(dstr, SvWEAKREF(sstr)
9927 ? sv_dup(SvRV(sstr), param)
9928 : sv_dup_inc(SvRV(sstr), param));
9931 else if (SvPVX_const(sstr)) {
9932 /* Has something there */
9934 /* Normal PV - clone whole allocated space */
9935 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9936 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9937 /* Not that normal - actually sstr is copy on write.
9938 But we are a true, independant SV, so: */
9939 SvREADONLY_off(dstr);
9944 /* Special case - not normally malloced for some reason */
9945 if (isGV_with_GP(sstr)) {
9946 /* Don't need to do anything here. */
9948 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9949 /* A "shared" PV - clone it as "shared" PV */
9951 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9955 /* Some other special case - random pointer */
9956 SvPV_set(dstr, SvPVX(sstr));
9962 if (SvTYPE(dstr) == SVt_RV)
9963 SvRV_set(dstr, NULL);
9965 SvPV_set(dstr, NULL);
9969 /* duplicate an SV of any type (including AV, HV etc) */
9972 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9977 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9979 /* look for it in the table first */
9980 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9984 if(param->flags & CLONEf_JOIN_IN) {
9985 /** We are joining here so we don't want do clone
9986 something that is bad **/
9987 if (SvTYPE(sstr) == SVt_PVHV) {
9988 const char * const hvname = HvNAME_get(sstr);
9990 /** don't clone stashes if they already exist **/
9991 return (SV*)gv_stashpv(hvname,0);
9995 /* create anew and remember what it is */
9998 #ifdef DEBUG_LEAKING_SCALARS
9999 dstr->sv_debug_optype = sstr->sv_debug_optype;
10000 dstr->sv_debug_line = sstr->sv_debug_line;
10001 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10002 dstr->sv_debug_cloned = 1;
10003 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10006 ptr_table_store(PL_ptr_table, sstr, dstr);
10009 SvFLAGS(dstr) = SvFLAGS(sstr);
10010 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10011 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10014 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10015 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10016 (void*)PL_watch_pvx, SvPVX_const(sstr));
10019 /* don't clone objects whose class has asked us not to */
10020 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10021 SvFLAGS(dstr) &= ~SVTYPEMASK;
10022 SvOBJECT_off(dstr);
10026 switch (SvTYPE(sstr)) {
10028 SvANY(dstr) = NULL;
10031 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10032 SvIV_set(dstr, SvIVX(sstr));
10035 SvANY(dstr) = new_XNV();
10036 SvNV_set(dstr, SvNVX(sstr));
10039 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10040 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10042 /* case SVt_BIND: */
10045 /* These are all the types that need complex bodies allocating. */
10047 const svtype sv_type = SvTYPE(sstr);
10048 const struct body_details *const sv_type_details
10049 = bodies_by_type + sv_type;
10053 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10057 if (GvUNIQUE((GV*)sstr)) {
10058 NOOP; /* Do sharing here, and fall through */
10070 assert(sv_type_details->body_size);
10071 if (sv_type_details->arena) {
10072 new_body_inline(new_body, sv_type);
10074 = (void*)((char*)new_body - sv_type_details->offset);
10076 new_body = new_NOARENA(sv_type_details);
10080 SvANY(dstr) = new_body;
10083 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10084 ((char*)SvANY(dstr)) + sv_type_details->offset,
10085 sv_type_details->copy, char);
10087 Copy(((char*)SvANY(sstr)),
10088 ((char*)SvANY(dstr)),
10089 sv_type_details->body_size + sv_type_details->offset, char);
10092 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10093 && !isGV_with_GP(dstr))
10094 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10096 /* The Copy above means that all the source (unduplicated) pointers
10097 are now in the destination. We can check the flags and the
10098 pointers in either, but it's possible that there's less cache
10099 missing by always going for the destination.
10100 FIXME - instrument and check that assumption */
10101 if (sv_type >= SVt_PVMG) {
10102 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10103 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10104 } else if (SvMAGIC(dstr))
10105 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10107 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10110 /* The cast silences a GCC warning about unhandled types. */
10111 switch ((int)sv_type) {
10121 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10122 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10123 LvTARG(dstr) = dstr;
10124 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10125 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10127 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10129 if(isGV_with_GP(sstr)) {
10130 if (GvNAME_HEK(dstr))
10131 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10132 /* Don't call sv_add_backref here as it's going to be
10133 created as part of the magic cloning of the symbol
10135 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10136 at the point of this comment. */
10137 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10138 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10139 (void)GpREFCNT_inc(GvGP(dstr));
10141 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10144 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10145 if (IoOFP(dstr) == IoIFP(sstr))
10146 IoOFP(dstr) = IoIFP(dstr);
10148 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10149 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10150 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10151 /* I have no idea why fake dirp (rsfps)
10152 should be treated differently but otherwise
10153 we end up with leaks -- sky*/
10154 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10155 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10156 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10158 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10159 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10160 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10161 if (IoDIRP(dstr)) {
10162 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10165 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10168 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10169 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10170 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10173 if (AvARRAY((AV*)sstr)) {
10174 SV **dst_ary, **src_ary;
10175 SSize_t items = AvFILLp((AV*)sstr) + 1;
10177 src_ary = AvARRAY((AV*)sstr);
10178 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10179 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10180 AvARRAY((AV*)dstr) = dst_ary;
10181 AvALLOC((AV*)dstr) = dst_ary;
10182 if (AvREAL((AV*)sstr)) {
10183 while (items-- > 0)
10184 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10187 while (items-- > 0)
10188 *dst_ary++ = sv_dup(*src_ary++, param);
10190 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10191 while (items-- > 0) {
10192 *dst_ary++ = &PL_sv_undef;
10196 AvARRAY((AV*)dstr) = NULL;
10197 AvALLOC((AV*)dstr) = (SV**)NULL;
10201 if (HvARRAY((HV*)sstr)) {
10203 const bool sharekeys = !!HvSHAREKEYS(sstr);
10204 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10205 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10207 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10208 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10210 HvARRAY(dstr) = (HE**)darray;
10211 while (i <= sxhv->xhv_max) {
10212 const HE * const source = HvARRAY(sstr)[i];
10213 HvARRAY(dstr)[i] = source
10214 ? he_dup(source, sharekeys, param) : 0;
10219 const struct xpvhv_aux * const saux = HvAUX(sstr);
10220 struct xpvhv_aux * const daux = HvAUX(dstr);
10221 /* This flag isn't copied. */
10222 /* SvOOK_on(hv) attacks the IV flags. */
10223 SvFLAGS(dstr) |= SVf_OOK;
10225 hvname = saux->xhv_name;
10226 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10228 daux->xhv_riter = saux->xhv_riter;
10229 daux->xhv_eiter = saux->xhv_eiter
10230 ? he_dup(saux->xhv_eiter,
10231 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10232 daux->xhv_backreferences =
10233 saux->xhv_backreferences
10234 ? (AV*) SvREFCNT_inc(
10235 sv_dup((SV*)saux->xhv_backreferences, param))
10238 daux->xhv_mro_meta = saux->xhv_mro_meta
10239 ? mro_meta_dup(saux->xhv_mro_meta, param)
10242 /* Record stashes for possible cloning in Perl_clone(). */
10244 av_push(param->stashes, dstr);
10248 HvARRAY((HV*)dstr) = NULL;
10251 if (!(param->flags & CLONEf_COPY_STACKS)) {
10255 /* NOTE: not refcounted */
10256 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10258 if (!CvISXSUB(dstr))
10259 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10261 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10262 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10263 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10264 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10266 /* don't dup if copying back - CvGV isn't refcounted, so the
10267 * duped GV may never be freed. A bit of a hack! DAPM */
10268 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10269 NULL : gv_dup(CvGV(dstr), param) ;
10270 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10272 CvWEAKOUTSIDE(sstr)
10273 ? cv_dup( CvOUTSIDE(dstr), param)
10274 : cv_dup_inc(CvOUTSIDE(dstr), param);
10275 if (!CvISXSUB(dstr))
10276 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10282 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10288 /* duplicate a context */
10291 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10293 PERL_CONTEXT *ncxs;
10296 return (PERL_CONTEXT*)NULL;
10298 /* look for it in the table first */
10299 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10303 /* create anew and remember what it is */
10304 Newxz(ncxs, max + 1, PERL_CONTEXT);
10305 ptr_table_store(PL_ptr_table, cxs, ncxs);
10308 PERL_CONTEXT * const cx = &cxs[ix];
10309 PERL_CONTEXT * const ncx = &ncxs[ix];
10310 ncx->cx_type = cx->cx_type;
10311 if (CxTYPE(cx) == CXt_SUBST) {
10312 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10315 ncx->blk_oldsp = cx->blk_oldsp;
10316 ncx->blk_oldcop = cx->blk_oldcop;
10317 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10318 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10319 ncx->blk_oldpm = cx->blk_oldpm;
10320 ncx->blk_gimme = cx->blk_gimme;
10321 switch (CxTYPE(cx)) {
10323 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10324 ? cv_dup_inc(cx->blk_sub.cv, param)
10325 : cv_dup(cx->blk_sub.cv,param));
10326 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10327 ? av_dup_inc(cx->blk_sub.argarray, param)
10329 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10330 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10331 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10332 ncx->blk_sub.lval = cx->blk_sub.lval;
10333 ncx->blk_sub.retop = cx->blk_sub.retop;
10334 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10335 cx->blk_sub.oldcomppad);
10338 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10339 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10340 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10341 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10342 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10343 ncx->blk_eval.retop = cx->blk_eval.retop;
10346 ncx->blk_loop.label = cx->blk_loop.label;
10347 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10348 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10349 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10350 ? cx->blk_loop.iterdata
10351 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10352 ncx->blk_loop.oldcomppad
10353 = (PAD*)ptr_table_fetch(PL_ptr_table,
10354 cx->blk_loop.oldcomppad);
10355 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10356 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10357 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10358 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10359 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10362 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10363 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10364 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10365 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10366 ncx->blk_sub.retop = cx->blk_sub.retop;
10378 /* duplicate a stack info structure */
10381 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10386 return (PERL_SI*)NULL;
10388 /* look for it in the table first */
10389 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10393 /* create anew and remember what it is */
10394 Newxz(nsi, 1, PERL_SI);
10395 ptr_table_store(PL_ptr_table, si, nsi);
10397 nsi->si_stack = av_dup_inc(si->si_stack, param);
10398 nsi->si_cxix = si->si_cxix;
10399 nsi->si_cxmax = si->si_cxmax;
10400 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10401 nsi->si_type = si->si_type;
10402 nsi->si_prev = si_dup(si->si_prev, param);
10403 nsi->si_next = si_dup(si->si_next, param);
10404 nsi->si_markoff = si->si_markoff;
10409 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10410 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10411 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10412 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10413 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10414 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10415 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10416 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10417 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10418 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10419 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10420 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10421 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10422 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10425 #define pv_dup_inc(p) SAVEPV(p)
10426 #define pv_dup(p) SAVEPV(p)
10427 #define svp_dup_inc(p,pp) any_dup(p,pp)
10429 /* map any object to the new equivent - either something in the
10430 * ptr table, or something in the interpreter structure
10434 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10439 return (void*)NULL;
10441 /* look for it in the table first */
10442 ret = ptr_table_fetch(PL_ptr_table, v);
10446 /* see if it is part of the interpreter structure */
10447 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10448 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10456 /* duplicate the save stack */
10459 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10462 ANY * const ss = proto_perl->Isavestack;
10463 const I32 max = proto_perl->Isavestack_max;
10464 I32 ix = proto_perl->Isavestack_ix;
10477 void (*dptr) (void*);
10478 void (*dxptr) (pTHX_ void*);
10480 Newxz(nss, max, ANY);
10483 const I32 type = POPINT(ss,ix);
10484 TOPINT(nss,ix) = type;
10486 case SAVEt_HELEM: /* hash element */
10487 sv = (SV*)POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10490 case SAVEt_ITEM: /* normal string */
10491 case SAVEt_SV: /* scalar reference */
10492 sv = (SV*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10496 case SAVEt_MORTALIZESV:
10497 sv = (SV*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10500 case SAVEt_SHARED_PVREF: /* char* in shared space */
10501 c = (char*)POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = savesharedpv(c);
10503 ptr = POPPTR(ss,ix);
10504 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10506 case SAVEt_GENERIC_SVREF: /* generic sv */
10507 case SAVEt_SVREF: /* scalar reference */
10508 sv = (SV*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10510 ptr = POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10513 case SAVEt_HV: /* hash reference */
10514 case SAVEt_AV: /* array reference */
10515 sv = (SV*) POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10518 case SAVEt_COMPPAD:
10520 sv = (SV*) POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = sv_dup(sv, param);
10523 case SAVEt_INT: /* int reference */
10524 ptr = POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10526 intval = (int)POPINT(ss,ix);
10527 TOPINT(nss,ix) = intval;
10529 case SAVEt_LONG: /* long reference */
10530 ptr = POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10533 case SAVEt_CLEARSV:
10534 longval = (long)POPLONG(ss,ix);
10535 TOPLONG(nss,ix) = longval;
10537 case SAVEt_I32: /* I32 reference */
10538 case SAVEt_I16: /* I16 reference */
10539 case SAVEt_I8: /* I8 reference */
10540 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10541 ptr = POPPTR(ss,ix);
10542 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10544 TOPINT(nss,ix) = i;
10546 case SAVEt_IV: /* IV reference */
10547 ptr = POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10550 TOPIV(nss,ix) = iv;
10552 case SAVEt_HPTR: /* HV* reference */
10553 case SAVEt_APTR: /* AV* reference */
10554 case SAVEt_SPTR: /* SV* reference */
10555 ptr = POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10557 sv = (SV*)POPPTR(ss,ix);
10558 TOPPTR(nss,ix) = sv_dup(sv, param);
10560 case SAVEt_VPTR: /* random* reference */
10561 ptr = POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10563 ptr = POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10566 case SAVEt_GENERIC_PVREF: /* generic char* */
10567 case SAVEt_PPTR: /* char* reference */
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10570 c = (char*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = pv_dup(c);
10573 case SAVEt_GP: /* scalar reference */
10574 gp = (GP*)POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10576 (void)GpREFCNT_inc(gp);
10577 gv = (GV*)POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10581 ptr = POPPTR(ss,ix);
10582 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10583 /* these are assumed to be refcounted properly */
10585 switch (((OP*)ptr)->op_type) {
10587 case OP_LEAVESUBLV:
10591 case OP_LEAVEWRITE:
10592 TOPPTR(nss,ix) = ptr;
10595 (void) OpREFCNT_inc(o);
10599 TOPPTR(nss,ix) = NULL;
10604 TOPPTR(nss,ix) = NULL;
10607 c = (char*)POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = pv_dup_inc(c);
10611 hv = (HV*)POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10613 c = (char*)POPPTR(ss,ix);
10614 TOPPTR(nss,ix) = pv_dup_inc(c);
10616 case SAVEt_STACK_POS: /* Position on Perl stack */
10618 TOPINT(nss,ix) = i;
10620 case SAVEt_DESTRUCTOR:
10621 ptr = POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10623 dptr = POPDPTR(ss,ix);
10624 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10625 any_dup(FPTR2DPTR(void *, dptr),
10628 case SAVEt_DESTRUCTOR_X:
10629 ptr = POPPTR(ss,ix);
10630 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10631 dxptr = POPDXPTR(ss,ix);
10632 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10633 any_dup(FPTR2DPTR(void *, dxptr),
10636 case SAVEt_REGCONTEXT:
10639 TOPINT(nss,ix) = i;
10642 case SAVEt_AELEM: /* array element */
10643 sv = (SV*)POPPTR(ss,ix);
10644 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10646 TOPINT(nss,ix) = i;
10647 av = (AV*)POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = av_dup_inc(av, param);
10651 ptr = POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = ptr;
10656 TOPINT(nss,ix) = i;
10657 ptr = POPPTR(ss,ix);
10660 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10661 HINTS_REFCNT_UNLOCK;
10663 TOPPTR(nss,ix) = ptr;
10664 if (i & HINT_LOCALIZE_HH) {
10665 hv = (HV*)POPPTR(ss,ix);
10666 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10670 longval = (long)POPLONG(ss,ix);
10671 TOPLONG(nss,ix) = longval;
10672 ptr = POPPTR(ss,ix);
10673 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10674 sv = (SV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = sv_dup(sv, param);
10678 ptr = POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10680 longval = (long)POPBOOL(ss,ix);
10681 TOPBOOL(nss,ix) = (bool)longval;
10683 case SAVEt_SET_SVFLAGS:
10685 TOPINT(nss,ix) = i;
10687 TOPINT(nss,ix) = i;
10688 sv = (SV*)POPPTR(ss,ix);
10689 TOPPTR(nss,ix) = sv_dup(sv, param);
10691 case SAVEt_RE_STATE:
10693 const struct re_save_state *const old_state
10694 = (struct re_save_state *)
10695 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10696 struct re_save_state *const new_state
10697 = (struct re_save_state *)
10698 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10700 Copy(old_state, new_state, 1, struct re_save_state);
10701 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10703 new_state->re_state_bostr
10704 = pv_dup(old_state->re_state_bostr);
10705 new_state->re_state_reginput
10706 = pv_dup(old_state->re_state_reginput);
10707 new_state->re_state_regeol
10708 = pv_dup(old_state->re_state_regeol);
10709 new_state->re_state_regoffs
10710 = (regexp_paren_pair*)
10711 any_dup(old_state->re_state_regoffs, proto_perl);
10712 new_state->re_state_reglastparen
10713 = (U32*) any_dup(old_state->re_state_reglastparen,
10715 new_state->re_state_reglastcloseparen
10716 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10718 /* XXX This just has to be broken. The old save_re_context
10719 code did SAVEGENERICPV(PL_reg_start_tmp);
10720 PL_reg_start_tmp is char **.
10721 Look above to what the dup code does for
10722 SAVEt_GENERIC_PVREF
10723 It can never have worked.
10724 So this is merely a faithful copy of the exiting bug: */
10725 new_state->re_state_reg_start_tmp
10726 = (char **) pv_dup((char *)
10727 old_state->re_state_reg_start_tmp);
10728 /* I assume that it only ever "worked" because no-one called
10729 (pseudo)fork while the regexp engine had re-entered itself.
10731 #ifdef PERL_OLD_COPY_ON_WRITE
10732 new_state->re_state_nrs
10733 = sv_dup(old_state->re_state_nrs, param);
10735 new_state->re_state_reg_magic
10736 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10738 new_state->re_state_reg_oldcurpm
10739 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10741 new_state->re_state_reg_curpm
10742 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10744 new_state->re_state_reg_oldsaved
10745 = pv_dup(old_state->re_state_reg_oldsaved);
10746 new_state->re_state_reg_poscache
10747 = pv_dup(old_state->re_state_reg_poscache);
10748 new_state->re_state_reg_starttry
10749 = pv_dup(old_state->re_state_reg_starttry);
10752 case SAVEt_COMPILE_WARNINGS:
10753 ptr = POPPTR(ss,ix);
10754 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10757 ptr = POPPTR(ss,ix);
10758 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10762 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10770 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10771 * flag to the result. This is done for each stash before cloning starts,
10772 * so we know which stashes want their objects cloned */
10775 do_mark_cloneable_stash(pTHX_ SV *sv)
10777 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10779 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10780 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10781 if (cloner && GvCV(cloner)) {
10788 XPUSHs(sv_2mortal(newSVhek(hvname)));
10790 call_sv((SV*)GvCV(cloner), G_SCALAR);
10797 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10805 =for apidoc perl_clone
10807 Create and return a new interpreter by cloning the current one.
10809 perl_clone takes these flags as parameters:
10811 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10812 without it we only clone the data and zero the stacks,
10813 with it we copy the stacks and the new perl interpreter is
10814 ready to run at the exact same point as the previous one.
10815 The pseudo-fork code uses COPY_STACKS while the
10816 threads->create doesn't.
10818 CLONEf_KEEP_PTR_TABLE
10819 perl_clone keeps a ptr_table with the pointer of the old
10820 variable as a key and the new variable as a value,
10821 this allows it to check if something has been cloned and not
10822 clone it again but rather just use the value and increase the
10823 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10824 the ptr_table using the function
10825 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10826 reason to keep it around is if you want to dup some of your own
10827 variable who are outside the graph perl scans, example of this
10828 code is in threads.xs create
10831 This is a win32 thing, it is ignored on unix, it tells perls
10832 win32host code (which is c++) to clone itself, this is needed on
10833 win32 if you want to run two threads at the same time,
10834 if you just want to do some stuff in a separate perl interpreter
10835 and then throw it away and return to the original one,
10836 you don't need to do anything.
10841 /* XXX the above needs expanding by someone who actually understands it ! */
10842 EXTERN_C PerlInterpreter *
10843 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10846 perl_clone(PerlInterpreter *proto_perl, UV flags)
10849 #ifdef PERL_IMPLICIT_SYS
10851 /* perlhost.h so we need to call into it
10852 to clone the host, CPerlHost should have a c interface, sky */
10854 if (flags & CLONEf_CLONE_HOST) {
10855 return perl_clone_host(proto_perl,flags);
10857 return perl_clone_using(proto_perl, flags,
10859 proto_perl->IMemShared,
10860 proto_perl->IMemParse,
10862 proto_perl->IStdIO,
10866 proto_perl->IProc);
10870 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10871 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10872 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10873 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10874 struct IPerlDir* ipD, struct IPerlSock* ipS,
10875 struct IPerlProc* ipP)
10877 /* XXX many of the string copies here can be optimized if they're
10878 * constants; they need to be allocated as common memory and just
10879 * their pointers copied. */
10882 CLONE_PARAMS clone_params;
10883 CLONE_PARAMS* const param = &clone_params;
10885 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10886 /* for each stash, determine whether its objects should be cloned */
10887 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10888 PERL_SET_THX(my_perl);
10891 PoisonNew(my_perl, 1, PerlInterpreter);
10897 PL_savestack_ix = 0;
10898 PL_savestack_max = -1;
10899 PL_sig_pending = 0;
10900 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10901 # else /* !DEBUGGING */
10902 Zero(my_perl, 1, PerlInterpreter);
10903 # endif /* DEBUGGING */
10905 /* host pointers */
10907 PL_MemShared = ipMS;
10908 PL_MemParse = ipMP;
10915 #else /* !PERL_IMPLICIT_SYS */
10917 CLONE_PARAMS clone_params;
10918 CLONE_PARAMS* param = &clone_params;
10919 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10920 /* for each stash, determine whether its objects should be cloned */
10921 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10922 PERL_SET_THX(my_perl);
10925 PoisonNew(my_perl, 1, PerlInterpreter);
10931 PL_savestack_ix = 0;
10932 PL_savestack_max = -1;
10933 PL_sig_pending = 0;
10934 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10935 # else /* !DEBUGGING */
10936 Zero(my_perl, 1, PerlInterpreter);
10937 # endif /* DEBUGGING */
10938 #endif /* PERL_IMPLICIT_SYS */
10939 param->flags = flags;
10940 param->proto_perl = proto_perl;
10942 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10944 PL_body_arenas = NULL;
10945 Zero(&PL_body_roots, 1, PL_body_roots);
10947 PL_nice_chunk = NULL;
10948 PL_nice_chunk_size = 0;
10950 PL_sv_objcount = 0;
10952 PL_sv_arenaroot = NULL;
10954 PL_debug = proto_perl->Idebug;
10956 PL_hash_seed = proto_perl->Ihash_seed;
10957 PL_rehash_seed = proto_perl->Irehash_seed;
10959 #ifdef USE_REENTRANT_API
10960 /* XXX: things like -Dm will segfault here in perlio, but doing
10961 * PERL_SET_CONTEXT(proto_perl);
10962 * breaks too many other things
10964 Perl_reentrant_init(aTHX);
10967 /* create SV map for pointer relocation */
10968 PL_ptr_table = ptr_table_new();
10970 /* initialize these special pointers as early as possible */
10971 SvANY(&PL_sv_undef) = NULL;
10972 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10973 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10974 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10976 SvANY(&PL_sv_no) = new_XPVNV();
10977 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10978 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10979 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10980 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10981 SvCUR_set(&PL_sv_no, 0);
10982 SvLEN_set(&PL_sv_no, 1);
10983 SvIV_set(&PL_sv_no, 0);
10984 SvNV_set(&PL_sv_no, 0);
10985 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10987 SvANY(&PL_sv_yes) = new_XPVNV();
10988 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10989 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10990 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10991 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10992 SvCUR_set(&PL_sv_yes, 1);
10993 SvLEN_set(&PL_sv_yes, 2);
10994 SvIV_set(&PL_sv_yes, 1);
10995 SvNV_set(&PL_sv_yes, 1);
10996 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10998 /* create (a non-shared!) shared string table */
10999 PL_strtab = newHV();
11000 HvSHAREKEYS_off(PL_strtab);
11001 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11002 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11004 PL_compiling = proto_perl->Icompiling;
11006 /* These two PVs will be free'd special way so must set them same way op.c does */
11007 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11008 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11010 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11011 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11013 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11014 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11015 if (PL_compiling.cop_hints_hash) {
11017 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11018 HINTS_REFCNT_UNLOCK;
11020 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11021 #ifdef PERL_DEBUG_READONLY_OPS
11026 /* pseudo environmental stuff */
11027 PL_origargc = proto_perl->Iorigargc;
11028 PL_origargv = proto_perl->Iorigargv;
11030 param->stashes = newAV(); /* Setup array of objects to call clone on */
11032 /* Set tainting stuff before PerlIO_debug can possibly get called */
11033 PL_tainting = proto_perl->Itainting;
11034 PL_taint_warn = proto_perl->Itaint_warn;
11036 #ifdef PERLIO_LAYERS
11037 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11038 PerlIO_clone(aTHX_ proto_perl, param);
11041 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11042 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11043 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11044 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11045 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11046 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11049 PL_minus_c = proto_perl->Iminus_c;
11050 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11051 PL_localpatches = proto_perl->Ilocalpatches;
11052 PL_splitstr = proto_perl->Isplitstr;
11053 PL_preprocess = proto_perl->Ipreprocess;
11054 PL_minus_n = proto_perl->Iminus_n;
11055 PL_minus_p = proto_perl->Iminus_p;
11056 PL_minus_l = proto_perl->Iminus_l;
11057 PL_minus_a = proto_perl->Iminus_a;
11058 PL_minus_E = proto_perl->Iminus_E;
11059 PL_minus_F = proto_perl->Iminus_F;
11060 PL_doswitches = proto_perl->Idoswitches;
11061 PL_dowarn = proto_perl->Idowarn;
11062 PL_doextract = proto_perl->Idoextract;
11063 PL_sawampersand = proto_perl->Isawampersand;
11064 PL_unsafe = proto_perl->Iunsafe;
11065 PL_inplace = SAVEPV(proto_perl->Iinplace);
11066 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11067 PL_perldb = proto_perl->Iperldb;
11068 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11069 PL_exit_flags = proto_perl->Iexit_flags;
11071 /* magical thingies */
11072 /* XXX time(&PL_basetime) when asked for? */
11073 PL_basetime = proto_perl->Ibasetime;
11074 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11076 PL_maxsysfd = proto_perl->Imaxsysfd;
11077 PL_statusvalue = proto_perl->Istatusvalue;
11079 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11081 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11083 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11085 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11086 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11087 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11090 /* RE engine related */
11091 Zero(&PL_reg_state, 1, struct re_save_state);
11092 PL_reginterp_cnt = 0;
11093 PL_regmatch_slab = NULL;
11095 /* Clone the regex array */
11096 PL_regex_padav = newAV();
11098 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11099 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11101 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11102 for(i = 1; i <= len; i++) {
11103 const SV * const regex = regexen[i];
11106 ? sv_dup_inc(regex, param)
11108 newSViv(PTR2IV(CALLREGDUPE(
11109 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11111 if (SvFLAGS(regex) & SVf_BREAK)
11112 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11113 av_push(PL_regex_padav, sv);
11116 PL_regex_pad = AvARRAY(PL_regex_padav);
11118 /* shortcuts to various I/O objects */
11119 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11120 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11121 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11122 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11123 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11124 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11126 /* shortcuts to regexp stuff */
11127 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11129 /* shortcuts to misc objects */
11130 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11132 /* shortcuts to debugging objects */
11133 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11134 PL_DBline = gv_dup(proto_perl->IDBline, param);
11135 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11136 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11137 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11138 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11139 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11140 PL_lineary = av_dup(proto_perl->Ilineary, param);
11141 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11143 /* symbol tables */
11144 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11145 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11146 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11147 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11148 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11150 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11151 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11152 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11153 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11154 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11155 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11156 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11157 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11159 PL_sub_generation = proto_perl->Isub_generation;
11160 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11161 PL_delayedisa = hv_dup_inc(proto_perl->Idelayedisa, param);
11163 /* funky return mechanisms */
11164 PL_forkprocess = proto_perl->Iforkprocess;
11166 /* subprocess state */
11167 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11169 /* internal state */
11170 PL_maxo = proto_perl->Imaxo;
11171 if (proto_perl->Iop_mask)
11172 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11175 /* PL_asserting = proto_perl->Iasserting; */
11177 /* current interpreter roots */
11178 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11180 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11182 PL_main_start = proto_perl->Imain_start;
11183 PL_eval_root = proto_perl->Ieval_root;
11184 PL_eval_start = proto_perl->Ieval_start;
11186 /* runtime control stuff */
11187 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11189 PL_filemode = proto_perl->Ifilemode;
11190 PL_lastfd = proto_perl->Ilastfd;
11191 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11194 PL_gensym = proto_perl->Igensym;
11195 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11196 PL_laststatval = proto_perl->Ilaststatval;
11197 PL_laststype = proto_perl->Ilaststype;
11200 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11202 /* interpreter atexit processing */
11203 PL_exitlistlen = proto_perl->Iexitlistlen;
11204 if (PL_exitlistlen) {
11205 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11206 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11209 PL_exitlist = (PerlExitListEntry*)NULL;
11211 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11212 if (PL_my_cxt_size) {
11213 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11214 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11215 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11216 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11217 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11221 PL_my_cxt_list = (void**)NULL;
11222 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11223 PL_my_cxt_keys = (const char**)NULL;
11226 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11227 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11228 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11230 PL_profiledata = NULL;
11232 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11234 PAD_CLONE_VARS(proto_perl, param);
11236 #ifdef HAVE_INTERP_INTERN
11237 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11240 /* more statics moved here */
11241 PL_generation = proto_perl->Igeneration;
11242 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11244 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11245 PL_in_clean_all = proto_perl->Iin_clean_all;
11247 PL_uid = proto_perl->Iuid;
11248 PL_euid = proto_perl->Ieuid;
11249 PL_gid = proto_perl->Igid;
11250 PL_egid = proto_perl->Iegid;
11251 PL_nomemok = proto_perl->Inomemok;
11252 PL_an = proto_perl->Ian;
11253 PL_evalseq = proto_perl->Ievalseq;
11254 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11255 PL_origalen = proto_perl->Iorigalen;
11256 #ifdef PERL_USES_PL_PIDSTATUS
11257 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11259 PL_osname = SAVEPV(proto_perl->Iosname);
11260 PL_sighandlerp = proto_perl->Isighandlerp;
11262 PL_runops = proto_perl->Irunops;
11265 PL_cshlen = proto_perl->Icshlen;
11266 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11269 PL_parser = parser_dup(proto_perl->Iparser, param);
11271 PL_subline = proto_perl->Isubline;
11272 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11275 PL_cryptseen = proto_perl->Icryptseen;
11278 PL_hints = proto_perl->Ihints;
11280 PL_amagic_generation = proto_perl->Iamagic_generation;
11282 #ifdef USE_LOCALE_COLLATE
11283 PL_collation_ix = proto_perl->Icollation_ix;
11284 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11285 PL_collation_standard = proto_perl->Icollation_standard;
11286 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11287 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11288 #endif /* USE_LOCALE_COLLATE */
11290 #ifdef USE_LOCALE_NUMERIC
11291 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11292 PL_numeric_standard = proto_perl->Inumeric_standard;
11293 PL_numeric_local = proto_perl->Inumeric_local;
11294 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11295 #endif /* !USE_LOCALE_NUMERIC */
11297 /* utf8 character classes */
11298 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11299 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11300 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11301 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11302 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11303 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11304 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11305 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11306 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11307 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11308 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11309 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11310 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11311 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11312 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11313 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11314 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11315 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11316 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11317 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11319 /* Did the locale setup indicate UTF-8? */
11320 PL_utf8locale = proto_perl->Iutf8locale;
11321 /* Unicode features (see perlrun/-C) */
11322 PL_unicode = proto_perl->Iunicode;
11324 /* Pre-5.8 signals control */
11325 PL_signals = proto_perl->Isignals;
11327 /* times() ticks per second */
11328 PL_clocktick = proto_perl->Iclocktick;
11330 /* Recursion stopper for PerlIO_find_layer */
11331 PL_in_load_module = proto_perl->Iin_load_module;
11333 /* sort() routine */
11334 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11336 /* Not really needed/useful since the reenrant_retint is "volatile",
11337 * but do it for consistency's sake. */
11338 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11340 /* Hooks to shared SVs and locks. */
11341 PL_sharehook = proto_perl->Isharehook;
11342 PL_lockhook = proto_perl->Ilockhook;
11343 PL_unlockhook = proto_perl->Iunlockhook;
11344 PL_threadhook = proto_perl->Ithreadhook;
11346 PL_runops_std = proto_perl->Irunops_std;
11347 PL_runops_dbg = proto_perl->Irunops_dbg;
11349 #ifdef THREADS_HAVE_PIDS
11350 PL_ppid = proto_perl->Ippid;
11354 PL_last_swash_hv = NULL; /* reinits on demand */
11355 PL_last_swash_klen = 0;
11356 PL_last_swash_key[0]= '\0';
11357 PL_last_swash_tmps = (U8*)NULL;
11358 PL_last_swash_slen = 0;
11360 PL_glob_index = proto_perl->Iglob_index;
11361 PL_srand_called = proto_perl->Isrand_called;
11362 PL_bitcount = NULL; /* reinits on demand */
11364 if (proto_perl->Ipsig_pend) {
11365 Newxz(PL_psig_pend, SIG_SIZE, int);
11368 PL_psig_pend = (int*)NULL;
11371 if (proto_perl->Ipsig_ptr) {
11372 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11373 Newxz(PL_psig_name, SIG_SIZE, SV*);
11374 for (i = 1; i < SIG_SIZE; i++) {
11375 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11376 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11380 PL_psig_ptr = (SV**)NULL;
11381 PL_psig_name = (SV**)NULL;
11384 /* intrpvar.h stuff */
11386 if (flags & CLONEf_COPY_STACKS) {
11387 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11388 PL_tmps_ix = proto_perl->Itmps_ix;
11389 PL_tmps_max = proto_perl->Itmps_max;
11390 PL_tmps_floor = proto_perl->Itmps_floor;
11391 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11393 while (i <= PL_tmps_ix) {
11394 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11398 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11399 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11400 Newxz(PL_markstack, i, I32);
11401 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11402 - proto_perl->Imarkstack);
11403 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11404 - proto_perl->Imarkstack);
11405 Copy(proto_perl->Imarkstack, PL_markstack,
11406 PL_markstack_ptr - PL_markstack + 1, I32);
11408 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11409 * NOTE: unlike the others! */
11410 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11411 PL_scopestack_max = proto_perl->Iscopestack_max;
11412 Newxz(PL_scopestack, PL_scopestack_max, I32);
11413 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11415 /* NOTE: si_dup() looks at PL_markstack */
11416 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11418 /* PL_curstack = PL_curstackinfo->si_stack; */
11419 PL_curstack = av_dup(proto_perl->Icurstack, param);
11420 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11422 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11423 PL_stack_base = AvARRAY(PL_curstack);
11424 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11425 - proto_perl->Istack_base);
11426 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11428 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11429 * NOTE: unlike the others! */
11430 PL_savestack_ix = proto_perl->Isavestack_ix;
11431 PL_savestack_max = proto_perl->Isavestack_max;
11432 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11433 PL_savestack = ss_dup(proto_perl, param);
11437 ENTER; /* perl_destruct() wants to LEAVE; */
11439 /* although we're not duplicating the tmps stack, we should still
11440 * add entries for any SVs on the tmps stack that got cloned by a
11441 * non-refcount means (eg a temp in @_); otherwise they will be
11444 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11445 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11446 proto_perl->Itmps_stack[i]);
11447 if (nsv && !SvREFCNT(nsv)) {
11449 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11454 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11455 PL_top_env = &PL_start_env;
11457 PL_op = proto_perl->Iop;
11460 PL_Xpv = (XPV*)NULL;
11461 PL_na = proto_perl->Ina;
11463 PL_statbuf = proto_perl->Istatbuf;
11464 PL_statcache = proto_perl->Istatcache;
11465 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11466 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11468 PL_timesbuf = proto_perl->Itimesbuf;
11471 PL_tainted = proto_perl->Itainted;
11472 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11473 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11474 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11475 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11476 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11477 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11478 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11479 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11480 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11482 PL_restartop = proto_perl->Irestartop;
11483 PL_in_eval = proto_perl->Iin_eval;
11484 PL_delaymagic = proto_perl->Idelaymagic;
11485 PL_dirty = proto_perl->Idirty;
11486 PL_localizing = proto_perl->Ilocalizing;
11488 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11489 PL_hv_fetch_ent_mh = NULL;
11490 PL_modcount = proto_perl->Imodcount;
11491 PL_lastgotoprobe = NULL;
11492 PL_dumpindent = proto_perl->Idumpindent;
11494 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11495 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11496 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11497 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11498 PL_efloatbuf = NULL; /* reinits on demand */
11499 PL_efloatsize = 0; /* reinits on demand */
11503 PL_screamfirst = NULL;
11504 PL_screamnext = NULL;
11505 PL_maxscream = -1; /* reinits on demand */
11506 PL_lastscream = NULL;
11509 PL_regdummy = proto_perl->Iregdummy;
11510 PL_colorset = 0; /* reinits PL_colors[] */
11511 /*PL_colors[6] = {0,0,0,0,0,0};*/
11515 /* Pluggable optimizer */
11516 PL_peepp = proto_perl->Ipeepp;
11518 PL_stashcache = newHV();
11520 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11521 proto_perl->Iwatchaddr);
11522 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11523 if (PL_debug && PL_watchaddr) {
11524 PerlIO_printf(Perl_debug_log,
11525 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11526 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11527 PTR2UV(PL_watchok));
11530 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11531 ptr_table_free(PL_ptr_table);
11532 PL_ptr_table = NULL;
11535 /* Call the ->CLONE method, if it exists, for each of the stashes
11536 identified by sv_dup() above.
11538 while(av_len(param->stashes) != -1) {
11539 HV* const stash = (HV*) av_shift(param->stashes);
11540 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11541 if (cloner && GvCV(cloner)) {
11546 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11548 call_sv((SV*)GvCV(cloner), G_DISCARD);
11554 SvREFCNT_dec(param->stashes);
11556 /* orphaned? eg threads->new inside BEGIN or use */
11557 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11558 SvREFCNT_inc_simple_void(PL_compcv);
11559 SAVEFREESV(PL_compcv);
11565 #endif /* USE_ITHREADS */
11568 =head1 Unicode Support
11570 =for apidoc sv_recode_to_utf8
11572 The encoding is assumed to be an Encode object, on entry the PV
11573 of the sv is assumed to be octets in that encoding, and the sv
11574 will be converted into Unicode (and UTF-8).
11576 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11577 is not a reference, nothing is done to the sv. If the encoding is not
11578 an C<Encode::XS> Encoding object, bad things will happen.
11579 (See F<lib/encoding.pm> and L<Encode>).
11581 The PV of the sv is returned.
11586 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11589 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11603 Passing sv_yes is wrong - it needs to be or'ed set of constants
11604 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11605 remove converted chars from source.
11607 Both will default the value - let them.
11609 XPUSHs(&PL_sv_yes);
11612 call_method("decode", G_SCALAR);
11616 s = SvPV_const(uni, len);
11617 if (s != SvPVX_const(sv)) {
11618 SvGROW(sv, len + 1);
11619 Move(s, SvPVX(sv), len + 1, char);
11620 SvCUR_set(sv, len);
11627 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11631 =for apidoc sv_cat_decode
11633 The encoding is assumed to be an Encode object, the PV of the ssv is
11634 assumed to be octets in that encoding and decoding the input starts
11635 from the position which (PV + *offset) pointed to. The dsv will be
11636 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11637 when the string tstr appears in decoding output or the input ends on
11638 the PV of the ssv. The value which the offset points will be modified
11639 to the last input position on the ssv.
11641 Returns TRUE if the terminator was found, else returns FALSE.
11646 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11647 SV *ssv, int *offset, char *tstr, int tlen)
11651 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11662 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11663 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11665 call_method("cat_decode", G_SCALAR);
11667 ret = SvTRUE(TOPs);
11668 *offset = SvIV(offsv);
11674 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11679 /* ---------------------------------------------------------------------
11681 * support functions for report_uninit()
11684 /* the maxiumum size of array or hash where we will scan looking
11685 * for the undefined element that triggered the warning */
11687 #define FUV_MAX_SEARCH_SIZE 1000
11689 /* Look for an entry in the hash whose value has the same SV as val;
11690 * If so, return a mortal copy of the key. */
11693 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11696 register HE **array;
11699 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11700 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11703 array = HvARRAY(hv);
11705 for (i=HvMAX(hv); i>0; i--) {
11706 register HE *entry;
11707 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11708 if (HeVAL(entry) != val)
11710 if ( HeVAL(entry) == &PL_sv_undef ||
11711 HeVAL(entry) == &PL_sv_placeholder)
11715 if (HeKLEN(entry) == HEf_SVKEY)
11716 return sv_mortalcopy(HeKEY_sv(entry));
11717 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11723 /* Look for an entry in the array whose value has the same SV as val;
11724 * If so, return the index, otherwise return -1. */
11727 S_find_array_subscript(pTHX_ AV *av, SV* val)
11730 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11731 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11734 if (val != &PL_sv_undef) {
11735 SV ** const svp = AvARRAY(av);
11738 for (i=AvFILLp(av); i>=0; i--)
11745 /* S_varname(): return the name of a variable, optionally with a subscript.
11746 * If gv is non-zero, use the name of that global, along with gvtype (one
11747 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11748 * targ. Depending on the value of the subscript_type flag, return:
11751 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11752 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11753 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11754 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11757 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11758 SV* keyname, I32 aindex, int subscript_type)
11761 SV * const name = sv_newmortal();
11764 buffer[0] = gvtype;
11767 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11769 gv_fullname4(name, gv, buffer, 0);
11771 if ((unsigned int)SvPVX(name)[1] <= 26) {
11773 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11775 /* Swap the 1 unprintable control character for the 2 byte pretty
11776 version - ie substr($name, 1, 1) = $buffer; */
11777 sv_insert(name, 1, 1, buffer, 2);
11781 CV * const cv = find_runcv(NULL);
11785 if (!cv || !CvPADLIST(cv))
11787 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11788 sv = *av_fetch(av, targ, FALSE);
11789 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11792 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11793 SV * const sv = newSV(0);
11794 *SvPVX(name) = '$';
11795 Perl_sv_catpvf(aTHX_ name, "{%s}",
11796 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11799 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11800 *SvPVX(name) = '$';
11801 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11803 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11804 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11811 =for apidoc find_uninit_var
11813 Find the name of the undefined variable (if any) that caused the operator o
11814 to issue a "Use of uninitialized value" warning.
11815 If match is true, only return a name if it's value matches uninit_sv.
11816 So roughly speaking, if a unary operator (such as OP_COS) generates a
11817 warning, then following the direct child of the op may yield an
11818 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11819 other hand, with OP_ADD there are two branches to follow, so we only print
11820 the variable name if we get an exact match.
11822 The name is returned as a mortal SV.
11824 Assumes that PL_op is the op that originally triggered the error, and that
11825 PL_comppad/PL_curpad points to the currently executing pad.
11831 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11839 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11840 uninit_sv == &PL_sv_placeholder)))
11843 switch (obase->op_type) {
11850 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11851 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11854 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11856 if (pad) { /* @lex, %lex */
11857 sv = PAD_SVl(obase->op_targ);
11861 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11862 /* @global, %global */
11863 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11866 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11868 else /* @{expr}, %{expr} */
11869 return find_uninit_var(cUNOPx(obase)->op_first,
11873 /* attempt to find a match within the aggregate */
11875 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11877 subscript_type = FUV_SUBSCRIPT_HASH;
11880 index = find_array_subscript((AV*)sv, uninit_sv);
11882 subscript_type = FUV_SUBSCRIPT_ARRAY;
11885 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11888 return varname(gv, hash ? '%' : '@', obase->op_targ,
11889 keysv, index, subscript_type);
11893 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11895 return varname(NULL, '$', obase->op_targ,
11896 NULL, 0, FUV_SUBSCRIPT_NONE);
11899 gv = cGVOPx_gv(obase);
11900 if (!gv || (match && GvSV(gv) != uninit_sv))
11902 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11905 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11908 av = (AV*)PAD_SV(obase->op_targ);
11909 if (!av || SvRMAGICAL(av))
11911 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11912 if (!svp || *svp != uninit_sv)
11915 return varname(NULL, '$', obase->op_targ,
11916 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11919 gv = cGVOPx_gv(obase);
11925 if (!av || SvRMAGICAL(av))
11927 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11928 if (!svp || *svp != uninit_sv)
11931 return varname(gv, '$', 0,
11932 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11937 o = cUNOPx(obase)->op_first;
11938 if (!o || o->op_type != OP_NULL ||
11939 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11941 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11945 if (PL_op == obase)
11946 /* $a[uninit_expr] or $h{uninit_expr} */
11947 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11950 o = cBINOPx(obase)->op_first;
11951 kid = cBINOPx(obase)->op_last;
11953 /* get the av or hv, and optionally the gv */
11955 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11956 sv = PAD_SV(o->op_targ);
11958 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11959 && cUNOPo->op_first->op_type == OP_GV)
11961 gv = cGVOPx_gv(cUNOPo->op_first);
11964 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11969 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11970 /* index is constant */
11974 if (obase->op_type == OP_HELEM) {
11975 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11976 if (!he || HeVAL(he) != uninit_sv)
11980 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11981 if (!svp || *svp != uninit_sv)
11985 if (obase->op_type == OP_HELEM)
11986 return varname(gv, '%', o->op_targ,
11987 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11989 return varname(gv, '@', o->op_targ, NULL,
11990 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11993 /* index is an expression;
11994 * attempt to find a match within the aggregate */
11995 if (obase->op_type == OP_HELEM) {
11996 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11998 return varname(gv, '%', o->op_targ,
11999 keysv, 0, FUV_SUBSCRIPT_HASH);
12002 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12004 return varname(gv, '@', o->op_targ,
12005 NULL, index, FUV_SUBSCRIPT_ARRAY);
12010 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12012 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12017 /* only examine RHS */
12018 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12021 o = cUNOPx(obase)->op_first;
12022 if (o->op_type == OP_PUSHMARK)
12025 if (!o->op_sibling) {
12026 /* one-arg version of open is highly magical */
12028 if (o->op_type == OP_GV) { /* open FOO; */
12030 if (match && GvSV(gv) != uninit_sv)
12032 return varname(gv, '$', 0,
12033 NULL, 0, FUV_SUBSCRIPT_NONE);
12035 /* other possibilities not handled are:
12036 * open $x; or open my $x; should return '${*$x}'
12037 * open expr; should return '$'.expr ideally
12043 /* ops where $_ may be an implicit arg */
12047 if ( !(obase->op_flags & OPf_STACKED)) {
12048 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12049 ? PAD_SVl(obase->op_targ)
12052 sv = sv_newmortal();
12053 sv_setpvn(sv, "$_", 2);
12062 /* skip filehandle as it can't produce 'undef' warning */
12063 o = cUNOPx(obase)->op_first;
12064 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12065 o = o->op_sibling->op_sibling;
12072 match = 1; /* XS or custom code could trigger random warnings */
12077 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12078 return sv_2mortal(newSVpvs("${$/}"));
12083 if (!(obase->op_flags & OPf_KIDS))
12085 o = cUNOPx(obase)->op_first;
12091 /* if all except one arg are constant, or have no side-effects,
12092 * or are optimized away, then it's unambiguous */
12094 for (kid=o; kid; kid = kid->op_sibling) {
12096 const OPCODE type = kid->op_type;
12097 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12098 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12099 || (type == OP_PUSHMARK)
12103 if (o2) { /* more than one found */
12110 return find_uninit_var(o2, uninit_sv, match);
12112 /* scan all args */
12114 sv = find_uninit_var(o, uninit_sv, 1);
12126 =for apidoc report_uninit
12128 Print appropriate "Use of uninitialized variable" warning
12134 Perl_report_uninit(pTHX_ SV* uninit_sv)
12138 SV* varname = NULL;
12140 varname = find_uninit_var(PL_op, uninit_sv,0);
12142 sv_insert(varname, 0, 0, " ", 1);
12144 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12145 varname ? SvPV_nolen_const(varname) : "",
12146 " in ", OP_DESC(PL_op));
12149 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12155 * c-indentation-style: bsd
12156 * c-basic-offset: 4
12157 * indent-tabs-mode: t
12160 * ex: set ts=8 sts=4 sw=4 noet: