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 method_changed = 0;
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(!method_changed && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3199 isGV_with_GP_off(dstr);
3200 (void)SvOK_off(dstr);
3201 isGV_with_GP_on(dstr);
3202 GvINTRO_off(dstr); /* one-shot flag */
3203 GvGP(dstr) = gp_ref(GvGP(sstr));
3204 if (SvTAINTED(sstr))
3206 if (GvIMPORTED(dstr) != GVf_IMPORTED
3207 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3209 GvIMPORTED_on(dstr);
3212 if(method_changed) mro_method_changed_in(GvSTASH(dstr));
3217 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3218 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3220 const int intro = GvINTRO(dstr);
3223 const U32 stype = SvTYPE(sref);
3226 #ifdef GV_UNIQUE_CHECK
3227 if (GvUNIQUE((GV*)dstr)) {
3228 Perl_croak(aTHX_ PL_no_modify);
3233 GvINTRO_off(dstr); /* one-shot flag */
3234 GvLINE(dstr) = CopLINE(PL_curcop);
3235 GvEGV(dstr) = (GV*)dstr;
3240 location = (SV **) &GvCV(dstr);
3241 import_flag = GVf_IMPORTED_CV;
3244 location = (SV **) &GvHV(dstr);
3245 import_flag = GVf_IMPORTED_HV;
3248 location = (SV **) &GvAV(dstr);
3249 import_flag = GVf_IMPORTED_AV;
3252 location = (SV **) &GvIOp(dstr);
3255 location = (SV **) &GvFORM(dstr);
3257 location = &GvSV(dstr);
3258 import_flag = GVf_IMPORTED_SV;
3261 if (stype == SVt_PVCV) {
3262 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3263 if (GvCVGEN(dstr)) {
3264 SvREFCNT_dec(GvCV(dstr));
3266 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3269 SAVEGENERICSV(*location);
3273 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3274 CV* const cv = (CV*)*location;
3276 if (!GvCVGEN((GV*)dstr) &&
3277 (CvROOT(cv) || CvXSUB(cv)))
3279 /* Redefining a sub - warning is mandatory if
3280 it was a const and its value changed. */
3281 if (CvCONST(cv) && CvCONST((CV*)sref)
3282 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3284 /* They are 2 constant subroutines generated from
3285 the same constant. This probably means that
3286 they are really the "same" proxy subroutine
3287 instantiated in 2 places. Most likely this is
3288 when a constant is exported twice. Don't warn.
3291 else if (ckWARN(WARN_REDEFINE)
3293 && (!CvCONST((CV*)sref)
3294 || sv_cmp(cv_const_sv(cv),
3295 cv_const_sv((CV*)sref))))) {
3296 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3299 ? "Constant subroutine %s::%s redefined"
3300 : "Subroutine %s::%s redefined"),
3301 HvNAME_get(GvSTASH((GV*)dstr)),
3302 GvENAME((GV*)dstr));
3306 cv_ckproto_len(cv, (GV*)dstr,
3307 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3308 SvPOK(sref) ? SvCUR(sref) : 0);
3310 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3311 GvASSUMECV_on(dstr);
3312 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3315 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3316 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3317 GvFLAGS(dstr) |= import_flag;
3322 if (SvTAINTED(sstr))
3328 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3331 register U32 sflags;
3333 register svtype stype;
3338 if (SvIS_FREED(dstr)) {
3339 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3340 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3342 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3344 sstr = &PL_sv_undef;
3345 if (SvIS_FREED(sstr)) {
3346 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3347 (void*)sstr, (void*)dstr);
3349 stype = SvTYPE(sstr);
3350 dtype = SvTYPE(dstr);
3352 (void)SvAMAGIC_off(dstr);
3355 /* need to nuke the magic */
3357 SvRMAGICAL_off(dstr);
3360 /* There's a lot of redundancy below but we're going for speed here */
3365 if (dtype != SVt_PVGV) {
3366 (void)SvOK_off(dstr);
3374 sv_upgrade(dstr, SVt_IV);
3379 sv_upgrade(dstr, SVt_PVIV);
3382 goto end_of_first_switch;
3384 (void)SvIOK_only(dstr);
3385 SvIV_set(dstr, SvIVX(sstr));
3388 /* SvTAINTED can only be true if the SV has taint magic, which in
3389 turn means that the SV type is PVMG (or greater). This is the
3390 case statement for SVt_IV, so this cannot be true (whatever gcov
3392 assert(!SvTAINTED(sstr));
3402 sv_upgrade(dstr, SVt_NV);
3407 sv_upgrade(dstr, SVt_PVNV);
3410 goto end_of_first_switch;
3412 SvNV_set(dstr, SvNVX(sstr));
3413 (void)SvNOK_only(dstr);
3414 /* SvTAINTED can only be true if the SV has taint magic, which in
3415 turn means that the SV type is PVMG (or greater). This is the
3416 case statement for SVt_NV, so this cannot be true (whatever gcov
3418 assert(!SvTAINTED(sstr));
3425 sv_upgrade(dstr, SVt_RV);
3428 #ifdef PERL_OLD_COPY_ON_WRITE
3429 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3430 if (dtype < SVt_PVIV)
3431 sv_upgrade(dstr, SVt_PVIV);
3438 sv_upgrade(dstr, SVt_PV);
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3445 if (dtype < SVt_PVNV)
3446 sv_upgrade(dstr, SVt_PVNV);
3450 const char * const type = sv_reftype(sstr,0);
3452 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3454 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3458 /* case SVt_BIND: */
3461 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3462 glob_assign_glob(dstr, sstr, dtype);
3465 /* SvVALID means that this PVGV is playing at being an FBM. */
3469 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3471 if (SvTYPE(sstr) != stype) {
3472 stype = SvTYPE(sstr);
3473 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3474 glob_assign_glob(dstr, sstr, dtype);
3479 if (stype == SVt_PVLV)
3480 SvUPGRADE(dstr, SVt_PVNV);
3482 SvUPGRADE(dstr, (svtype)stype);
3484 end_of_first_switch:
3486 /* dstr may have been upgraded. */
3487 dtype = SvTYPE(dstr);
3488 sflags = SvFLAGS(sstr);
3490 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3491 /* Assigning to a subroutine sets the prototype. */
3494 const char *const ptr = SvPV_const(sstr, len);
3496 SvGROW(dstr, len + 1);
3497 Copy(ptr, SvPVX(dstr), len + 1, char);
3498 SvCUR_set(dstr, len);
3500 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3504 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3505 const char * const type = sv_reftype(dstr,0);
3507 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3509 Perl_croak(aTHX_ "Cannot copy to %s", type);
3510 } else if (sflags & SVf_ROK) {
3511 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3512 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3515 if (GvIMPORTED(dstr) != GVf_IMPORTED
3516 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3518 GvIMPORTED_on(dstr);
3523 glob_assign_glob(dstr, sstr, dtype);
3527 if (dtype >= SVt_PV) {
3528 if (dtype == SVt_PVGV) {
3529 glob_assign_ref(dstr, sstr);
3532 if (SvPVX_const(dstr)) {
3538 (void)SvOK_off(dstr);
3539 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3540 SvFLAGS(dstr) |= sflags & SVf_ROK;
3541 assert(!(sflags & SVp_NOK));
3542 assert(!(sflags & SVp_IOK));
3543 assert(!(sflags & SVf_NOK));
3544 assert(!(sflags & SVf_IOK));
3546 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3547 if (!(sflags & SVf_OK)) {
3548 if (ckWARN(WARN_MISC))
3549 Perl_warner(aTHX_ packWARN(WARN_MISC),
3550 "Undefined value assigned to typeglob");
3553 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3554 if (dstr != (SV*)gv) {
3557 GvGP(dstr) = gp_ref(GvGP(gv));
3561 else if (sflags & SVp_POK) {
3565 * Check to see if we can just swipe the string. If so, it's a
3566 * possible small lose on short strings, but a big win on long ones.
3567 * It might even be a win on short strings if SvPVX_const(dstr)
3568 * has to be allocated and SvPVX_const(sstr) has to be freed.
3569 * Likewise if we can set up COW rather than doing an actual copy, we
3570 * drop to the else clause, as the swipe code and the COW setup code
3571 * have much in common.
3574 /* Whichever path we take through the next code, we want this true,
3575 and doing it now facilitates the COW check. */
3576 (void)SvPOK_only(dstr);
3579 /* If we're already COW then this clause is not true, and if COW
3580 is allowed then we drop down to the else and make dest COW
3581 with us. If caller hasn't said that we're allowed to COW
3582 shared hash keys then we don't do the COW setup, even if the
3583 source scalar is a shared hash key scalar. */
3584 (((flags & SV_COW_SHARED_HASH_KEYS)
3585 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3586 : 1 /* If making a COW copy is forbidden then the behaviour we
3587 desire is as if the source SV isn't actually already
3588 COW, even if it is. So we act as if the source flags
3589 are not COW, rather than actually testing them. */
3591 #ifndef PERL_OLD_COPY_ON_WRITE
3592 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3593 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3594 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3595 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3596 but in turn, it's somewhat dead code, never expected to go
3597 live, but more kept as a placeholder on how to do it better
3598 in a newer implementation. */
3599 /* If we are COW and dstr is a suitable target then we drop down
3600 into the else and make dest a COW of us. */
3601 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3606 (sflags & SVs_TEMP) && /* slated for free anyway? */
3607 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3608 (!(flags & SV_NOSTEAL)) &&
3609 /* and we're allowed to steal temps */
3610 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3611 SvLEN(sstr) && /* and really is a string */
3612 /* and won't be needed again, potentially */
3613 !(PL_op && PL_op->op_type == OP_AASSIGN))
3614 #ifdef PERL_OLD_COPY_ON_WRITE
3615 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3616 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3617 && SvTYPE(sstr) >= SVt_PVIV)
3620 /* Failed the swipe test, and it's not a shared hash key either.
3621 Have to copy the string. */
3622 STRLEN len = SvCUR(sstr);
3623 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3624 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3625 SvCUR_set(dstr, len);
3626 *SvEND(dstr) = '\0';
3628 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3630 /* Either it's a shared hash key, or it's suitable for
3631 copy-on-write or we can swipe the string. */
3633 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3637 #ifdef PERL_OLD_COPY_ON_WRITE
3639 /* I believe I should acquire a global SV mutex if
3640 it's a COW sv (not a shared hash key) to stop
3641 it going un copy-on-write.
3642 If the source SV has gone un copy on write between up there
3643 and down here, then (assert() that) it is of the correct
3644 form to make it copy on write again */
3645 if ((sflags & (SVf_FAKE | SVf_READONLY))
3646 != (SVf_FAKE | SVf_READONLY)) {
3647 SvREADONLY_on(sstr);
3649 /* Make the source SV into a loop of 1.
3650 (about to become 2) */
3651 SV_COW_NEXT_SV_SET(sstr, sstr);
3655 /* Initial code is common. */
3656 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3661 /* making another shared SV. */
3662 STRLEN cur = SvCUR(sstr);
3663 STRLEN len = SvLEN(sstr);
3664 #ifdef PERL_OLD_COPY_ON_WRITE
3666 assert (SvTYPE(dstr) >= SVt_PVIV);
3667 /* SvIsCOW_normal */
3668 /* splice us in between source and next-after-source. */
3669 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3670 SV_COW_NEXT_SV_SET(sstr, dstr);
3671 SvPV_set(dstr, SvPVX_mutable(sstr));
3675 /* SvIsCOW_shared_hash */
3676 DEBUG_C(PerlIO_printf(Perl_debug_log,
3677 "Copy on write: Sharing hash\n"));
3679 assert (SvTYPE(dstr) >= SVt_PV);
3681 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3683 SvLEN_set(dstr, len);
3684 SvCUR_set(dstr, cur);
3685 SvREADONLY_on(dstr);
3687 /* Relesase a global SV mutex. */
3690 { /* Passes the swipe test. */
3691 SvPV_set(dstr, SvPVX_mutable(sstr));
3692 SvLEN_set(dstr, SvLEN(sstr));
3693 SvCUR_set(dstr, SvCUR(sstr));
3696 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3697 SvPV_set(sstr, NULL);
3703 if (sflags & SVp_NOK) {
3704 SvNV_set(dstr, SvNVX(sstr));
3706 if (sflags & SVp_IOK) {
3708 SvIV_set(dstr, SvIVX(sstr));
3709 /* Must do this otherwise some other overloaded use of 0x80000000
3710 gets confused. I guess SVpbm_VALID */
3711 if (sflags & SVf_IVisUV)
3714 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3716 const MAGIC * const smg = SvVSTRING_mg(sstr);
3718 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3719 smg->mg_ptr, smg->mg_len);
3720 SvRMAGICAL_on(dstr);
3724 else if (sflags & (SVp_IOK|SVp_NOK)) {
3725 (void)SvOK_off(dstr);
3726 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3727 if (sflags & SVp_IOK) {
3728 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3729 SvIV_set(dstr, SvIVX(sstr));
3731 if (sflags & SVp_NOK) {
3732 SvNV_set(dstr, SvNVX(sstr));
3736 if (isGV_with_GP(sstr)) {
3737 /* This stringification rule for globs is spread in 3 places.
3738 This feels bad. FIXME. */
3739 const U32 wasfake = sflags & SVf_FAKE;
3741 /* FAKE globs can get coerced, so need to turn this off
3742 temporarily if it is on. */
3744 gv_efullname3(dstr, (GV *)sstr, "*");
3745 SvFLAGS(sstr) |= wasfake;
3748 (void)SvOK_off(dstr);
3750 if (SvTAINTED(sstr))
3755 =for apidoc sv_setsv_mg
3757 Like C<sv_setsv>, but also handles 'set' magic.
3763 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3765 sv_setsv(dstr,sstr);
3769 #ifdef PERL_OLD_COPY_ON_WRITE
3771 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3773 STRLEN cur = SvCUR(sstr);
3774 STRLEN len = SvLEN(sstr);
3775 register char *new_pv;
3778 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3779 (void*)sstr, (void*)dstr);
3786 if (SvTHINKFIRST(dstr))
3787 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3788 else if (SvPVX_const(dstr))
3789 Safefree(SvPVX_const(dstr));
3793 SvUPGRADE(dstr, SVt_PVIV);
3795 assert (SvPOK(sstr));
3796 assert (SvPOKp(sstr));
3797 assert (!SvIOK(sstr));
3798 assert (!SvIOKp(sstr));
3799 assert (!SvNOK(sstr));
3800 assert (!SvNOKp(sstr));
3802 if (SvIsCOW(sstr)) {
3804 if (SvLEN(sstr) == 0) {
3805 /* source is a COW shared hash key. */
3806 DEBUG_C(PerlIO_printf(Perl_debug_log,
3807 "Fast copy on write: Sharing hash\n"));
3808 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3811 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3813 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3814 SvUPGRADE(sstr, SVt_PVIV);
3815 SvREADONLY_on(sstr);
3817 DEBUG_C(PerlIO_printf(Perl_debug_log,
3818 "Fast copy on write: Converting sstr to COW\n"));
3819 SV_COW_NEXT_SV_SET(dstr, sstr);
3821 SV_COW_NEXT_SV_SET(sstr, dstr);
3822 new_pv = SvPVX_mutable(sstr);
3825 SvPV_set(dstr, new_pv);
3826 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3829 SvLEN_set(dstr, len);
3830 SvCUR_set(dstr, cur);
3839 =for apidoc sv_setpvn
3841 Copies a string into an SV. The C<len> parameter indicates the number of
3842 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3843 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3849 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3852 register char *dptr;
3854 SV_CHECK_THINKFIRST_COW_DROP(sv);
3860 /* len is STRLEN which is unsigned, need to copy to signed */
3863 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3865 SvUPGRADE(sv, SVt_PV);
3867 dptr = SvGROW(sv, len + 1);
3868 Move(ptr,dptr,len,char);
3871 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3876 =for apidoc sv_setpvn_mg
3878 Like C<sv_setpvn>, but also handles 'set' magic.
3884 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3886 sv_setpvn(sv,ptr,len);
3891 =for apidoc sv_setpv
3893 Copies a string into an SV. The string must be null-terminated. Does not
3894 handle 'set' magic. See C<sv_setpv_mg>.
3900 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3903 register STRLEN len;
3905 SV_CHECK_THINKFIRST_COW_DROP(sv);
3911 SvUPGRADE(sv, SVt_PV);
3913 SvGROW(sv, len + 1);
3914 Move(ptr,SvPVX(sv),len+1,char);
3916 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3921 =for apidoc sv_setpv_mg
3923 Like C<sv_setpv>, but also handles 'set' magic.
3929 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3936 =for apidoc sv_usepvn_flags
3938 Tells an SV to use C<ptr> to find its string value. Normally the
3939 string is stored inside the SV but sv_usepvn allows the SV to use an
3940 outside string. The C<ptr> should point to memory that was allocated
3941 by C<malloc>. The string length, C<len>, must be supplied. By default
3942 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3943 so that pointer should not be freed or used by the programmer after
3944 giving it to sv_usepvn, and neither should any pointers from "behind"
3945 that pointer (e.g. ptr + 1) be used.
3947 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3948 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3949 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3950 C<len>, and already meets the requirements for storing in C<SvPVX>)
3956 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3960 SV_CHECK_THINKFIRST_COW_DROP(sv);
3961 SvUPGRADE(sv, SVt_PV);
3964 if (flags & SV_SMAGIC)
3968 if (SvPVX_const(sv))
3972 if (flags & SV_HAS_TRAILING_NUL)
3973 assert(ptr[len] == '\0');
3976 allocate = (flags & SV_HAS_TRAILING_NUL)
3977 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3978 if (flags & SV_HAS_TRAILING_NUL) {
3979 /* It's long enough - do nothing.
3980 Specfically Perl_newCONSTSUB is relying on this. */
3983 /* Force a move to shake out bugs in callers. */
3984 char *new_ptr = (char*)safemalloc(allocate);
3985 Copy(ptr, new_ptr, len, char);
3986 PoisonFree(ptr,len,char);
3990 ptr = (char*) saferealloc (ptr, allocate);
3995 SvLEN_set(sv, allocate);
3996 if (!(flags & SV_HAS_TRAILING_NUL)) {
3999 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4001 if (flags & SV_SMAGIC)
4005 #ifdef PERL_OLD_COPY_ON_WRITE
4006 /* Need to do this *after* making the SV normal, as we need the buffer
4007 pointer to remain valid until after we've copied it. If we let go too early,
4008 another thread could invalidate it by unsharing last of the same hash key
4009 (which it can do by means other than releasing copy-on-write Svs)
4010 or by changing the other copy-on-write SVs in the loop. */
4012 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4014 { /* this SV was SvIsCOW_normal(sv) */
4015 /* we need to find the SV pointing to us. */
4016 SV *current = SV_COW_NEXT_SV(after);
4018 if (current == sv) {
4019 /* The SV we point to points back to us (there were only two of us
4021 Hence other SV is no longer copy on write either. */
4023 SvREADONLY_off(after);
4025 /* We need to follow the pointers around the loop. */
4027 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4030 /* don't loop forever if the structure is bust, and we have
4031 a pointer into a closed loop. */
4032 assert (current != after);
4033 assert (SvPVX_const(current) == pvx);
4035 /* Make the SV before us point to the SV after us. */
4036 SV_COW_NEXT_SV_SET(current, after);
4042 =for apidoc sv_force_normal_flags
4044 Undo various types of fakery on an SV: if the PV is a shared string, make
4045 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4046 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4047 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4048 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4049 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4050 set to some other value.) In addition, the C<flags> parameter gets passed to
4051 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4052 with flags set to 0.
4058 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4061 #ifdef PERL_OLD_COPY_ON_WRITE
4062 if (SvREADONLY(sv)) {
4063 /* At this point I believe I should acquire a global SV mutex. */
4065 const char * const pvx = SvPVX_const(sv);
4066 const STRLEN len = SvLEN(sv);
4067 const STRLEN cur = SvCUR(sv);
4068 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4069 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4070 we'll fail an assertion. */
4071 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4074 PerlIO_printf(Perl_debug_log,
4075 "Copy on write: Force normal %ld\n",
4081 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4084 if (flags & SV_COW_DROP_PV) {
4085 /* OK, so we don't need to copy our buffer. */
4088 SvGROW(sv, cur + 1);
4089 Move(pvx,SvPVX(sv),cur,char);
4094 sv_release_COW(sv, pvx, next);
4096 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4102 else if (IN_PERL_RUNTIME)
4103 Perl_croak(aTHX_ PL_no_modify);
4104 /* At this point I believe that I can drop the global SV mutex. */
4107 if (SvREADONLY(sv)) {
4109 const char * const pvx = SvPVX_const(sv);
4110 const STRLEN len = SvCUR(sv);
4115 SvGROW(sv, len + 1);
4116 Move(pvx,SvPVX(sv),len,char);
4118 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4120 else if (IN_PERL_RUNTIME)
4121 Perl_croak(aTHX_ PL_no_modify);
4125 sv_unref_flags(sv, flags);
4126 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4133 Efficient removal of characters from the beginning of the string buffer.
4134 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4135 the string buffer. The C<ptr> becomes the first character of the adjusted
4136 string. Uses the "OOK hack".
4137 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4138 refer to the same chunk of data.
4144 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4146 register STRLEN delta;
4147 if (!ptr || !SvPOKp(sv))
4149 delta = ptr - SvPVX_const(sv);
4150 SV_CHECK_THINKFIRST(sv);
4151 if (SvTYPE(sv) < SVt_PVIV)
4152 sv_upgrade(sv,SVt_PVIV);
4155 if (!SvLEN(sv)) { /* make copy of shared string */
4156 const char *pvx = SvPVX_const(sv);
4157 const STRLEN len = SvCUR(sv);
4158 SvGROW(sv, len + 1);
4159 Move(pvx,SvPVX(sv),len,char);
4163 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4164 and we do that anyway inside the SvNIOK_off
4166 SvFLAGS(sv) |= SVf_OOK;
4169 SvLEN_set(sv, SvLEN(sv) - delta);
4170 SvCUR_set(sv, SvCUR(sv) - delta);
4171 SvPV_set(sv, SvPVX(sv) + delta);
4172 SvIV_set(sv, SvIVX(sv) + delta);
4176 =for apidoc sv_catpvn
4178 Concatenates the string onto the end of the string which is in the SV. The
4179 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4180 status set, then the bytes appended should be valid UTF-8.
4181 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4183 =for apidoc sv_catpvn_flags
4185 Concatenates the string onto the end of the string which is in the SV. The
4186 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4187 status set, then the bytes appended should be valid UTF-8.
4188 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4189 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4190 in terms of this function.
4196 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4200 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4202 SvGROW(dsv, dlen + slen + 1);
4204 sstr = SvPVX_const(dsv);
4205 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4206 SvCUR_set(dsv, SvCUR(dsv) + slen);
4208 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4210 if (flags & SV_SMAGIC)
4215 =for apidoc sv_catsv
4217 Concatenates the string from SV C<ssv> onto the end of the string in
4218 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4219 not 'set' magic. See C<sv_catsv_mg>.
4221 =for apidoc sv_catsv_flags
4223 Concatenates the string from SV C<ssv> onto the end of the string in
4224 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4225 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4226 and C<sv_catsv_nomg> are implemented in terms of this function.
4231 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4236 const char *spv = SvPV_const(ssv, slen);
4238 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4239 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4240 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4241 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4242 dsv->sv_flags doesn't have that bit set.
4243 Andy Dougherty 12 Oct 2001
4245 const I32 sutf8 = DO_UTF8(ssv);
4248 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4250 dutf8 = DO_UTF8(dsv);
4252 if (dutf8 != sutf8) {
4254 /* Not modifying source SV, so taking a temporary copy. */
4255 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4257 sv_utf8_upgrade(csv);
4258 spv = SvPV_const(csv, slen);
4261 sv_utf8_upgrade_nomg(dsv);
4263 sv_catpvn_nomg(dsv, spv, slen);
4266 if (flags & SV_SMAGIC)
4271 =for apidoc sv_catpv
4273 Concatenates the string onto the end of the string which is in the SV.
4274 If the SV has the UTF-8 status set, then the bytes appended should be
4275 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4280 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4283 register STRLEN len;
4289 junk = SvPV_force(sv, tlen);
4291 SvGROW(sv, tlen + len + 1);
4293 ptr = SvPVX_const(sv);
4294 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4295 SvCUR_set(sv, SvCUR(sv) + len);
4296 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4301 =for apidoc sv_catpv_mg
4303 Like C<sv_catpv>, but also handles 'set' magic.
4309 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4318 Creates a new SV. A non-zero C<len> parameter indicates the number of
4319 bytes of preallocated string space the SV should have. An extra byte for a
4320 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4321 space is allocated.) The reference count for the new SV is set to 1.
4323 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4324 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4325 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4326 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4327 modules supporting older perls.
4333 Perl_newSV(pTHX_ STRLEN len)
4340 sv_upgrade(sv, SVt_PV);
4341 SvGROW(sv, len + 1);
4346 =for apidoc sv_magicext
4348 Adds magic to an SV, upgrading it if necessary. Applies the
4349 supplied vtable and returns a pointer to the magic added.
4351 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4352 In particular, you can add magic to SvREADONLY SVs, and add more than
4353 one instance of the same 'how'.
4355 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4356 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4357 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4358 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4360 (This is now used as a subroutine by C<sv_magic>.)
4365 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4366 const char* name, I32 namlen)
4371 SvUPGRADE(sv, SVt_PVMG);
4372 Newxz(mg, 1, MAGIC);
4373 mg->mg_moremagic = SvMAGIC(sv);
4374 SvMAGIC_set(sv, mg);
4376 /* Sometimes a magic contains a reference loop, where the sv and
4377 object refer to each other. To prevent a reference loop that
4378 would prevent such objects being freed, we look for such loops
4379 and if we find one we avoid incrementing the object refcount.
4381 Note we cannot do this to avoid self-tie loops as intervening RV must
4382 have its REFCNT incremented to keep it in existence.
4385 if (!obj || obj == sv ||
4386 how == PERL_MAGIC_arylen ||
4387 how == PERL_MAGIC_qr ||
4388 how == PERL_MAGIC_symtab ||
4389 (SvTYPE(obj) == SVt_PVGV &&
4390 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4391 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4392 GvFORM(obj) == (CV*)sv)))
4397 mg->mg_obj = SvREFCNT_inc_simple(obj);
4398 mg->mg_flags |= MGf_REFCOUNTED;
4401 /* Normal self-ties simply pass a null object, and instead of
4402 using mg_obj directly, use the SvTIED_obj macro to produce a
4403 new RV as needed. For glob "self-ties", we are tieing the PVIO
4404 with an RV obj pointing to the glob containing the PVIO. In
4405 this case, to avoid a reference loop, we need to weaken the
4409 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4410 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4416 mg->mg_len = namlen;
4419 mg->mg_ptr = savepvn(name, namlen);
4420 else if (namlen == HEf_SVKEY)
4421 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4423 mg->mg_ptr = (char *) name;
4425 mg->mg_virtual = (MGVTBL *) vtable;
4429 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4434 =for apidoc sv_magic
4436 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4437 then adds a new magic item of type C<how> to the head of the magic list.
4439 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4440 handling of the C<name> and C<namlen> arguments.
4442 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4443 to add more than one instance of the same 'how'.
4449 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4452 const MGVTBL *vtable;
4455 #ifdef PERL_OLD_COPY_ON_WRITE
4457 sv_force_normal_flags(sv, 0);
4459 if (SvREADONLY(sv)) {
4461 /* its okay to attach magic to shared strings; the subsequent
4462 * upgrade to PVMG will unshare the string */
4463 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4466 && how != PERL_MAGIC_regex_global
4467 && how != PERL_MAGIC_bm
4468 && how != PERL_MAGIC_fm
4469 && how != PERL_MAGIC_sv
4470 && how != PERL_MAGIC_backref
4473 Perl_croak(aTHX_ PL_no_modify);
4476 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4477 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4478 /* sv_magic() refuses to add a magic of the same 'how' as an
4481 if (how == PERL_MAGIC_taint) {
4483 /* Any scalar which already had taint magic on which someone
4484 (erroneously?) did SvIOK_on() or similar will now be
4485 incorrectly sporting public "OK" flags. */
4486 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4494 vtable = &PL_vtbl_sv;
4496 case PERL_MAGIC_overload:
4497 vtable = &PL_vtbl_amagic;
4499 case PERL_MAGIC_overload_elem:
4500 vtable = &PL_vtbl_amagicelem;
4502 case PERL_MAGIC_overload_table:
4503 vtable = &PL_vtbl_ovrld;
4506 vtable = &PL_vtbl_bm;
4508 case PERL_MAGIC_regdata:
4509 vtable = &PL_vtbl_regdata;
4511 case PERL_MAGIC_regdatum:
4512 vtable = &PL_vtbl_regdatum;
4514 case PERL_MAGIC_env:
4515 vtable = &PL_vtbl_env;
4518 vtable = &PL_vtbl_fm;
4520 case PERL_MAGIC_envelem:
4521 vtable = &PL_vtbl_envelem;
4523 case PERL_MAGIC_regex_global:
4524 vtable = &PL_vtbl_mglob;
4526 case PERL_MAGIC_isa:
4527 vtable = &PL_vtbl_isa;
4529 case PERL_MAGIC_isaelem:
4530 vtable = &PL_vtbl_isaelem;
4532 case PERL_MAGIC_nkeys:
4533 vtable = &PL_vtbl_nkeys;
4535 case PERL_MAGIC_dbfile:
4538 case PERL_MAGIC_dbline:
4539 vtable = &PL_vtbl_dbline;
4541 #ifdef USE_LOCALE_COLLATE
4542 case PERL_MAGIC_collxfrm:
4543 vtable = &PL_vtbl_collxfrm;
4545 #endif /* USE_LOCALE_COLLATE */
4546 case PERL_MAGIC_tied:
4547 vtable = &PL_vtbl_pack;
4549 case PERL_MAGIC_tiedelem:
4550 case PERL_MAGIC_tiedscalar:
4551 vtable = &PL_vtbl_packelem;
4554 vtable = &PL_vtbl_regexp;
4556 case PERL_MAGIC_hints:
4557 /* As this vtable is all NULL, we can reuse it. */
4558 case PERL_MAGIC_sig:
4559 vtable = &PL_vtbl_sig;
4561 case PERL_MAGIC_sigelem:
4562 vtable = &PL_vtbl_sigelem;
4564 case PERL_MAGIC_taint:
4565 vtable = &PL_vtbl_taint;
4567 case PERL_MAGIC_uvar:
4568 vtable = &PL_vtbl_uvar;
4570 case PERL_MAGIC_vec:
4571 vtable = &PL_vtbl_vec;
4573 case PERL_MAGIC_arylen_p:
4574 case PERL_MAGIC_rhash:
4575 case PERL_MAGIC_symtab:
4576 case PERL_MAGIC_vstring:
4579 case PERL_MAGIC_utf8:
4580 vtable = &PL_vtbl_utf8;
4582 case PERL_MAGIC_substr:
4583 vtable = &PL_vtbl_substr;
4585 case PERL_MAGIC_defelem:
4586 vtable = &PL_vtbl_defelem;
4588 case PERL_MAGIC_arylen:
4589 vtable = &PL_vtbl_arylen;
4591 case PERL_MAGIC_pos:
4592 vtable = &PL_vtbl_pos;
4594 case PERL_MAGIC_backref:
4595 vtable = &PL_vtbl_backref;
4597 case PERL_MAGIC_hintselem:
4598 vtable = &PL_vtbl_hintselem;
4600 case PERL_MAGIC_ext:
4601 /* Reserved for use by extensions not perl internals. */
4602 /* Useful for attaching extension internal data to perl vars. */
4603 /* Note that multiple extensions may clash if magical scalars */
4604 /* etc holding private data from one are passed to another. */
4608 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4611 /* Rest of work is done else where */
4612 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4615 case PERL_MAGIC_taint:
4618 case PERL_MAGIC_ext:
4619 case PERL_MAGIC_dbfile:
4626 =for apidoc sv_unmagic
4628 Removes all magic of type C<type> from an SV.
4634 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4638 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4640 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4641 for (mg = *mgp; mg; mg = *mgp) {
4642 if (mg->mg_type == type) {
4643 const MGVTBL* const vtbl = mg->mg_virtual;
4644 *mgp = mg->mg_moremagic;
4645 if (vtbl && vtbl->svt_free)
4646 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4647 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4649 Safefree(mg->mg_ptr);
4650 else if (mg->mg_len == HEf_SVKEY)
4651 SvREFCNT_dec((SV*)mg->mg_ptr);
4652 else if (mg->mg_type == PERL_MAGIC_utf8)
4653 Safefree(mg->mg_ptr);
4655 if (mg->mg_flags & MGf_REFCOUNTED)
4656 SvREFCNT_dec(mg->mg_obj);
4660 mgp = &mg->mg_moremagic;
4664 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4665 SvMAGIC_set(sv, NULL);
4672 =for apidoc sv_rvweaken
4674 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4675 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4676 push a back-reference to this RV onto the array of backreferences
4677 associated with that magic. If the RV is magical, set magic will be
4678 called after the RV is cleared.
4684 Perl_sv_rvweaken(pTHX_ SV *sv)
4687 if (!SvOK(sv)) /* let undefs pass */
4690 Perl_croak(aTHX_ "Can't weaken a nonreference");
4691 else if (SvWEAKREF(sv)) {
4692 if (ckWARN(WARN_MISC))
4693 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4697 Perl_sv_add_backref(aTHX_ tsv, sv);
4703 /* Give tsv backref magic if it hasn't already got it, then push a
4704 * back-reference to sv onto the array associated with the backref magic.
4708 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4713 if (SvTYPE(tsv) == SVt_PVHV) {
4714 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4718 /* There is no AV in the offical place - try a fixup. */
4719 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4722 /* Aha. They've got it stowed in magic. Bring it back. */
4723 av = (AV*)mg->mg_obj;
4724 /* Stop mg_free decreasing the refernce count. */
4726 /* Stop mg_free even calling the destructor, given that
4727 there's no AV to free up. */
4729 sv_unmagic(tsv, PERL_MAGIC_backref);
4733 SvREFCNT_inc_simple_void(av);
4738 const MAGIC *const mg
4739 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4741 av = (AV*)mg->mg_obj;
4745 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4746 /* av now has a refcnt of 2, which avoids it getting freed
4747 * before us during global cleanup. The extra ref is removed
4748 * by magic_killbackrefs() when tsv is being freed */
4751 if (AvFILLp(av) >= AvMAX(av)) {
4752 av_extend(av, AvFILLp(av)+1);
4754 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4757 /* delete a back-reference to ourselves from the backref magic associated
4758 * with the SV we point to.
4762 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4769 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4770 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4771 /* We mustn't attempt to "fix up" the hash here by moving the
4772 backreference array back to the hv_aux structure, as that is stored
4773 in the main HvARRAY(), and hfreentries assumes that no-one
4774 reallocates HvARRAY() while it is running. */
4777 const MAGIC *const mg
4778 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4780 av = (AV *)mg->mg_obj;
4783 if (PL_in_clean_all)
4785 Perl_croak(aTHX_ "panic: del_backref");
4792 /* We shouldn't be in here more than once, but for paranoia reasons lets
4794 for (i = AvFILLp(av); i >= 0; i--) {
4796 const SSize_t fill = AvFILLp(av);
4798 /* We weren't the last entry.
4799 An unordered list has this property that you can take the
4800 last element off the end to fill the hole, and it's still
4801 an unordered list :-)
4806 AvFILLp(av) = fill - 1;
4812 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4814 SV **svp = AvARRAY(av);
4816 PERL_UNUSED_ARG(sv);
4818 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4819 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4820 if (svp && !SvIS_FREED(av)) {
4821 SV *const *const last = svp + AvFILLp(av);
4823 while (svp <= last) {
4825 SV *const referrer = *svp;
4826 if (SvWEAKREF(referrer)) {
4827 /* XXX Should we check that it hasn't changed? */
4828 SvRV_set(referrer, 0);
4830 SvWEAKREF_off(referrer);
4831 SvSETMAGIC(referrer);
4832 } else if (SvTYPE(referrer) == SVt_PVGV ||
4833 SvTYPE(referrer) == SVt_PVLV) {
4834 /* You lookin' at me? */
4835 assert(GvSTASH(referrer));
4836 assert(GvSTASH(referrer) == (HV*)sv);
4837 GvSTASH(referrer) = 0;
4840 "panic: magic_killbackrefs (flags=%"UVxf")",
4841 (UV)SvFLAGS(referrer));
4849 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4854 =for apidoc sv_insert
4856 Inserts a string at the specified offset/length within the SV. Similar to
4857 the Perl substr() function.
4863 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4868 register char *midend;
4869 register char *bigend;
4875 Perl_croak(aTHX_ "Can't modify non-existent substring");
4876 SvPV_force(bigstr, curlen);
4877 (void)SvPOK_only_UTF8(bigstr);
4878 if (offset + len > curlen) {
4879 SvGROW(bigstr, offset+len+1);
4880 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4881 SvCUR_set(bigstr, offset+len);
4885 i = littlelen - len;
4886 if (i > 0) { /* string might grow */
4887 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4888 mid = big + offset + len;
4889 midend = bigend = big + SvCUR(bigstr);
4892 while (midend > mid) /* shove everything down */
4893 *--bigend = *--midend;
4894 Move(little,big+offset,littlelen,char);
4895 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4900 Move(little,SvPVX(bigstr)+offset,len,char);
4905 big = SvPVX(bigstr);
4908 bigend = big + SvCUR(bigstr);
4910 if (midend > bigend)
4911 Perl_croak(aTHX_ "panic: sv_insert");
4913 if (mid - big > bigend - midend) { /* faster to shorten from end */
4915 Move(little, mid, littlelen,char);
4918 i = bigend - midend;
4920 Move(midend, mid, i,char);
4924 SvCUR_set(bigstr, mid - big);
4926 else if ((i = mid - big)) { /* faster from front */
4927 midend -= littlelen;
4929 sv_chop(bigstr,midend-i);
4934 Move(little, mid, littlelen,char);
4936 else if (littlelen) {
4937 midend -= littlelen;
4938 sv_chop(bigstr,midend);
4939 Move(little,midend,littlelen,char);
4942 sv_chop(bigstr,midend);
4948 =for apidoc sv_replace
4950 Make the first argument a copy of the second, then delete the original.
4951 The target SV physically takes over ownership of the body of the source SV
4952 and inherits its flags; however, the target keeps any magic it owns,
4953 and any magic in the source is discarded.
4954 Note that this is a rather specialist SV copying operation; most of the
4955 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4961 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4964 const U32 refcnt = SvREFCNT(sv);
4965 SV_CHECK_THINKFIRST_COW_DROP(sv);
4966 if (SvREFCNT(nsv) != 1) {
4967 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4968 UVuf " != 1)", (UV) SvREFCNT(nsv));
4970 if (SvMAGICAL(sv)) {
4974 sv_upgrade(nsv, SVt_PVMG);
4975 SvMAGIC_set(nsv, SvMAGIC(sv));
4976 SvFLAGS(nsv) |= SvMAGICAL(sv);
4978 SvMAGIC_set(sv, NULL);
4982 assert(!SvREFCNT(sv));
4983 #ifdef DEBUG_LEAKING_SCALARS
4984 sv->sv_flags = nsv->sv_flags;
4985 sv->sv_any = nsv->sv_any;
4986 sv->sv_refcnt = nsv->sv_refcnt;
4987 sv->sv_u = nsv->sv_u;
4989 StructCopy(nsv,sv,SV);
4991 /* Currently could join these into one piece of pointer arithmetic, but
4992 it would be unclear. */
4993 if(SvTYPE(sv) == SVt_IV)
4995 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4996 else if (SvTYPE(sv) == SVt_RV) {
4997 SvANY(sv) = &sv->sv_u.svu_rv;
5001 #ifdef PERL_OLD_COPY_ON_WRITE
5002 if (SvIsCOW_normal(nsv)) {
5003 /* We need to follow the pointers around the loop to make the
5004 previous SV point to sv, rather than nsv. */
5007 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5010 assert(SvPVX_const(current) == SvPVX_const(nsv));
5012 /* Make the SV before us point to the SV after us. */
5014 PerlIO_printf(Perl_debug_log, "previous is\n");
5016 PerlIO_printf(Perl_debug_log,
5017 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5018 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5020 SV_COW_NEXT_SV_SET(current, sv);
5023 SvREFCNT(sv) = refcnt;
5024 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5030 =for apidoc sv_clear
5032 Clear an SV: call any destructors, free up any memory used by the body,
5033 and free the body itself. The SV's head is I<not> freed, although
5034 its type is set to all 1's so that it won't inadvertently be assumed
5035 to be live during global destruction etc.
5036 This function should only be called when REFCNT is zero. Most of the time
5037 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5044 Perl_sv_clear(pTHX_ register SV *sv)
5047 const U32 type = SvTYPE(sv);
5048 const struct body_details *const sv_type_details
5049 = bodies_by_type + type;
5053 assert(SvREFCNT(sv) == 0);
5055 if (type <= SVt_IV) {
5056 /* See the comment in sv.h about the collusion between this early
5057 return and the overloading of the NULL and IV slots in the size
5063 if (PL_defstash) { /* Still have a symbol table? */
5068 stash = SvSTASH(sv);
5069 destructor = StashHANDLER(stash,DESTROY);
5071 SV* const tmpref = newRV(sv);
5072 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5074 PUSHSTACKi(PERLSI_DESTROY);
5079 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5085 if(SvREFCNT(tmpref) < 2) {
5086 /* tmpref is not kept alive! */
5088 SvRV_set(tmpref, NULL);
5091 SvREFCNT_dec(tmpref);
5093 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5097 if (PL_in_clean_objs)
5098 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5100 /* DESTROY gave object new lease on life */
5106 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5107 SvOBJECT_off(sv); /* Curse the object. */
5108 if (type != SVt_PVIO)
5109 --PL_sv_objcount; /* XXX Might want something more general */
5112 if (type >= SVt_PVMG) {
5113 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5114 SvREFCNT_dec(SvOURSTASH(sv));
5115 } else if (SvMAGIC(sv))
5117 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5118 SvREFCNT_dec(SvSTASH(sv));
5121 /* case SVt_BIND: */
5124 IoIFP(sv) != PerlIO_stdin() &&
5125 IoIFP(sv) != PerlIO_stdout() &&
5126 IoIFP(sv) != PerlIO_stderr())
5128 io_close((IO*)sv, FALSE);
5130 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5131 PerlDir_close(IoDIRP(sv));
5132 IoDIRP(sv) = (DIR*)NULL;
5133 Safefree(IoTOP_NAME(sv));
5134 Safefree(IoFMT_NAME(sv));
5135 Safefree(IoBOTTOM_NAME(sv));
5142 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5146 if (PL_comppad == (AV*)sv) {
5153 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5154 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5155 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5156 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5158 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5159 SvREFCNT_dec(LvTARG(sv));
5161 if (isGV_with_GP(sv)) {
5162 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5163 mro_method_changed_in(stash);
5166 unshare_hek(GvNAME_HEK(sv));
5167 /* If we're in a stash, we don't own a reference to it. However it does
5168 have a back reference to us, which needs to be cleared. */
5169 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5170 sv_del_backref((SV*)stash, sv);
5172 /* FIXME. There are probably more unreferenced pointers to SVs in the
5173 interpreter struct that we should check and tidy in a similar
5175 if ((GV*)sv == PL_last_in_gv)
5176 PL_last_in_gv = NULL;
5181 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5183 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5184 /* Don't even bother with turning off the OOK flag. */
5189 SV * const target = SvRV(sv);
5191 sv_del_backref(target, sv);
5193 SvREFCNT_dec(target);
5195 #ifdef PERL_OLD_COPY_ON_WRITE
5196 else if (SvPVX_const(sv)) {
5198 /* I believe I need to grab the global SV mutex here and
5199 then recheck the COW status. */
5201 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5205 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5207 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5210 /* And drop it here. */
5212 } else if (SvLEN(sv)) {
5213 Safefree(SvPVX_const(sv));
5217 else if (SvPVX_const(sv) && SvLEN(sv))
5218 Safefree(SvPVX_mutable(sv));
5219 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5220 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5229 SvFLAGS(sv) &= SVf_BREAK;
5230 SvFLAGS(sv) |= SVTYPEMASK;
5232 if (sv_type_details->arena) {
5233 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5234 &PL_body_roots[type]);
5236 else if (sv_type_details->body_size) {
5237 my_safefree(SvANY(sv));
5242 =for apidoc sv_newref
5244 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5251 Perl_sv_newref(pTHX_ SV *sv)
5253 PERL_UNUSED_CONTEXT;
5262 Decrement an SV's reference count, and if it drops to zero, call
5263 C<sv_clear> to invoke destructors and free up any memory used by
5264 the body; finally, deallocate the SV's head itself.
5265 Normally called via a wrapper macro C<SvREFCNT_dec>.
5271 Perl_sv_free(pTHX_ SV *sv)
5276 if (SvREFCNT(sv) == 0) {
5277 if (SvFLAGS(sv) & SVf_BREAK)
5278 /* this SV's refcnt has been artificially decremented to
5279 * trigger cleanup */
5281 if (PL_in_clean_all) /* All is fair */
5283 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5284 /* make sure SvREFCNT(sv)==0 happens very seldom */
5285 SvREFCNT(sv) = (~(U32)0)/2;
5288 if (ckWARN_d(WARN_INTERNAL)) {
5289 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5290 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5291 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5292 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5293 Perl_dump_sv_child(aTHX_ sv);
5295 #ifdef DEBUG_LEAKING_SCALARS
5302 if (--(SvREFCNT(sv)) > 0)
5304 Perl_sv_free2(aTHX_ sv);
5308 Perl_sv_free2(pTHX_ SV *sv)
5313 if (ckWARN_d(WARN_DEBUGGING))
5314 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5315 "Attempt to free temp prematurely: SV 0x%"UVxf
5316 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5320 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5321 /* make sure SvREFCNT(sv)==0 happens very seldom */
5322 SvREFCNT(sv) = (~(U32)0)/2;
5333 Returns the length of the string in the SV. Handles magic and type
5334 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5340 Perl_sv_len(pTHX_ register SV *sv)
5348 len = mg_length(sv);
5350 (void)SvPV_const(sv, len);
5355 =for apidoc sv_len_utf8
5357 Returns the number of characters in the string in an SV, counting wide
5358 UTF-8 bytes as a single character. Handles magic and type coercion.
5364 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5365 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5366 * (Note that the mg_len is not the length of the mg_ptr field.
5367 * This allows the cache to store the character length of the string without
5368 * needing to malloc() extra storage to attach to the mg_ptr.)
5373 Perl_sv_len_utf8(pTHX_ register SV *sv)
5379 return mg_length(sv);
5383 const U8 *s = (U8*)SvPV_const(sv, len);
5387 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5389 if (mg && mg->mg_len != -1) {
5391 if (PL_utf8cache < 0) {
5392 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5394 /* Need to turn the assertions off otherwise we may
5395 recurse infinitely while printing error messages.
5397 SAVEI8(PL_utf8cache);
5399 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5400 " real %"UVuf" for %"SVf,
5401 (UV) ulen, (UV) real, SVfARG(sv));
5406 ulen = Perl_utf8_length(aTHX_ s, s + len);
5407 if (!SvREADONLY(sv)) {
5409 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5410 &PL_vtbl_utf8, 0, 0);
5418 return Perl_utf8_length(aTHX_ s, s + len);
5422 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5425 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5428 const U8 *s = start;
5430 while (s < send && uoffset--)
5433 /* This is the existing behaviour. Possibly it should be a croak, as
5434 it's actually a bounds error */
5440 /* Given the length of the string in both bytes and UTF-8 characters, decide
5441 whether to walk forwards or backwards to find the byte corresponding to
5442 the passed in UTF-8 offset. */
5444 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5445 STRLEN uoffset, STRLEN uend)
5447 STRLEN backw = uend - uoffset;
5448 if (uoffset < 2 * backw) {
5449 /* The assumption is that going forwards is twice the speed of going
5450 forward (that's where the 2 * backw comes from).
5451 (The real figure of course depends on the UTF-8 data.) */
5452 return sv_pos_u2b_forwards(start, send, uoffset);
5457 while (UTF8_IS_CONTINUATION(*send))
5460 return send - start;
5463 /* For the string representation of the given scalar, find the byte
5464 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5465 give another position in the string, *before* the sought offset, which
5466 (which is always true, as 0, 0 is a valid pair of positions), which should
5467 help reduce the amount of linear searching.
5468 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5469 will be used to reduce the amount of linear searching. The cache will be
5470 created if necessary, and the found value offered to it for update. */
5472 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5473 const U8 *const send, STRLEN uoffset,
5474 STRLEN uoffset0, STRLEN boffset0) {
5475 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5478 assert (uoffset >= uoffset0);
5480 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5481 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5482 if ((*mgp)->mg_ptr) {
5483 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5484 if (cache[0] == uoffset) {
5485 /* An exact match. */
5488 if (cache[2] == uoffset) {
5489 /* An exact match. */
5493 if (cache[0] < uoffset) {
5494 /* The cache already knows part of the way. */
5495 if (cache[0] > uoffset0) {
5496 /* The cache knows more than the passed in pair */
5497 uoffset0 = cache[0];
5498 boffset0 = cache[1];
5500 if ((*mgp)->mg_len != -1) {
5501 /* And we know the end too. */
5503 + sv_pos_u2b_midway(start + boffset0, send,
5505 (*mgp)->mg_len - uoffset0);
5508 + sv_pos_u2b_forwards(start + boffset0,
5509 send, uoffset - uoffset0);
5512 else if (cache[2] < uoffset) {
5513 /* We're between the two cache entries. */
5514 if (cache[2] > uoffset0) {
5515 /* and the cache knows more than the passed in pair */
5516 uoffset0 = cache[2];
5517 boffset0 = cache[3];
5521 + sv_pos_u2b_midway(start + boffset0,
5524 cache[0] - uoffset0);
5527 + sv_pos_u2b_midway(start + boffset0,
5530 cache[2] - uoffset0);
5534 else if ((*mgp)->mg_len != -1) {
5535 /* If we can take advantage of a passed in offset, do so. */
5536 /* In fact, offset0 is either 0, or less than offset, so don't
5537 need to worry about the other possibility. */
5539 + sv_pos_u2b_midway(start + boffset0, send,
5541 (*mgp)->mg_len - uoffset0);
5546 if (!found || PL_utf8cache < 0) {
5547 const STRLEN real_boffset
5548 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5549 send, uoffset - uoffset0);
5551 if (found && PL_utf8cache < 0) {
5552 if (real_boffset != boffset) {
5553 /* Need to turn the assertions off otherwise we may recurse
5554 infinitely while printing error messages. */
5555 SAVEI8(PL_utf8cache);
5557 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5558 " real %"UVuf" for %"SVf,
5559 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5562 boffset = real_boffset;
5565 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5571 =for apidoc sv_pos_u2b
5573 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5574 the start of the string, to a count of the equivalent number of bytes; if
5575 lenp is non-zero, it does the same to lenp, but this time starting from
5576 the offset, rather than from the start of the string. Handles magic and
5583 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5584 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5585 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5590 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5598 start = (U8*)SvPV_const(sv, len);
5600 STRLEN uoffset = (STRLEN) *offsetp;
5601 const U8 * const send = start + len;
5603 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5606 *offsetp = (I32) boffset;
5609 /* Convert the relative offset to absolute. */
5610 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5611 const STRLEN boffset2
5612 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5613 uoffset, boffset) - boffset;
5627 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5628 byte length pairing. The (byte) length of the total SV is passed in too,
5629 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5630 may not have updated SvCUR, so we can't rely on reading it directly.
5632 The proffered utf8/byte length pairing isn't used if the cache already has
5633 two pairs, and swapping either for the proffered pair would increase the
5634 RMS of the intervals between known byte offsets.
5636 The cache itself consists of 4 STRLEN values
5637 0: larger UTF-8 offset
5638 1: corresponding byte offset
5639 2: smaller UTF-8 offset
5640 3: corresponding byte offset
5642 Unused cache pairs have the value 0, 0.
5643 Keeping the cache "backwards" means that the invariant of
5644 cache[0] >= cache[2] is maintained even with empty slots, which means that
5645 the code that uses it doesn't need to worry if only 1 entry has actually
5646 been set to non-zero. It also makes the "position beyond the end of the
5647 cache" logic much simpler, as the first slot is always the one to start
5651 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5659 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5661 (*mgp)->mg_len = -1;
5665 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5666 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5667 (*mgp)->mg_ptr = (char *) cache;
5671 if (PL_utf8cache < 0) {
5672 const U8 *start = (const U8 *) SvPVX_const(sv);
5673 const STRLEN realutf8 = utf8_length(start, start + byte);
5675 if (realutf8 != utf8) {
5676 /* Need to turn the assertions off otherwise we may recurse
5677 infinitely while printing error messages. */
5678 SAVEI8(PL_utf8cache);
5680 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5681 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5685 /* Cache is held with the later position first, to simplify the code
5686 that deals with unbounded ends. */
5688 ASSERT_UTF8_CACHE(cache);
5689 if (cache[1] == 0) {
5690 /* Cache is totally empty */
5693 } else if (cache[3] == 0) {
5694 if (byte > cache[1]) {
5695 /* New one is larger, so goes first. */
5696 cache[2] = cache[0];
5697 cache[3] = cache[1];
5705 #define THREEWAY_SQUARE(a,b,c,d) \
5706 ((float)((d) - (c))) * ((float)((d) - (c))) \
5707 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5708 + ((float)((b) - (a))) * ((float)((b) - (a)))
5710 /* Cache has 2 slots in use, and we know three potential pairs.
5711 Keep the two that give the lowest RMS distance. Do the
5712 calcualation in bytes simply because we always know the byte
5713 length. squareroot has the same ordering as the positive value,
5714 so don't bother with the actual square root. */
5715 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5716 if (byte > cache[1]) {
5717 /* New position is after the existing pair of pairs. */
5718 const float keep_earlier
5719 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5720 const float keep_later
5721 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5723 if (keep_later < keep_earlier) {
5724 if (keep_later < existing) {
5725 cache[2] = cache[0];
5726 cache[3] = cache[1];
5732 if (keep_earlier < existing) {
5738 else if (byte > cache[3]) {
5739 /* New position is between the existing pair of pairs. */
5740 const float keep_earlier
5741 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5742 const float keep_later
5743 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5745 if (keep_later < keep_earlier) {
5746 if (keep_later < existing) {
5752 if (keep_earlier < existing) {
5759 /* New position is before the existing pair of pairs. */
5760 const float keep_earlier
5761 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5762 const float keep_later
5763 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5765 if (keep_later < keep_earlier) {
5766 if (keep_later < existing) {
5772 if (keep_earlier < existing) {
5773 cache[0] = cache[2];
5774 cache[1] = cache[3];
5781 ASSERT_UTF8_CACHE(cache);
5784 /* We already know all of the way, now we may be able to walk back. The same
5785 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5786 backward is half the speed of walking forward. */
5788 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5791 const STRLEN forw = target - s;
5792 STRLEN backw = end - target;
5794 if (forw < 2 * backw) {
5795 return utf8_length(s, target);
5798 while (end > target) {
5800 while (UTF8_IS_CONTINUATION(*end)) {
5809 =for apidoc sv_pos_b2u
5811 Converts the value pointed to by offsetp from a count of bytes from the
5812 start of the string, to a count of the equivalent number of UTF-8 chars.
5813 Handles magic and type coercion.
5819 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5820 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5825 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5828 const STRLEN byte = *offsetp;
5829 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5838 s = (const U8*)SvPV_const(sv, blen);
5841 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5845 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5846 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5848 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5849 if (cache[1] == byte) {
5850 /* An exact match. */
5851 *offsetp = cache[0];
5854 if (cache[3] == byte) {
5855 /* An exact match. */
5856 *offsetp = cache[2];
5860 if (cache[1] < byte) {
5861 /* We already know part of the way. */
5862 if (mg->mg_len != -1) {
5863 /* Actually, we know the end too. */
5865 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5866 s + blen, mg->mg_len - cache[0]);
5868 len = cache[0] + utf8_length(s + cache[1], send);
5871 else if (cache[3] < byte) {
5872 /* We're between the two cached pairs, so we do the calculation
5873 offset by the byte/utf-8 positions for the earlier pair,
5874 then add the utf-8 characters from the string start to
5876 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5877 s + cache[1], cache[0] - cache[2])
5881 else { /* cache[3] > byte */
5882 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5886 ASSERT_UTF8_CACHE(cache);
5888 } else if (mg->mg_len != -1) {
5889 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5893 if (!found || PL_utf8cache < 0) {
5894 const STRLEN real_len = utf8_length(s, send);
5896 if (found && PL_utf8cache < 0) {
5897 if (len != real_len) {
5898 /* Need to turn the assertions off otherwise we may recurse
5899 infinitely while printing error messages. */
5900 SAVEI8(PL_utf8cache);
5902 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5903 " real %"UVuf" for %"SVf,
5904 (UV) len, (UV) real_len, SVfARG(sv));
5911 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5917 Returns a boolean indicating whether the strings in the two SVs are
5918 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5919 coerce its args to strings if necessary.
5925 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5934 SV* svrecode = NULL;
5941 /* if pv1 and pv2 are the same, second SvPV_const call may
5942 * invalidate pv1, so we may need to make a copy */
5943 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5944 pv1 = SvPV_const(sv1, cur1);
5945 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5946 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5948 pv1 = SvPV_const(sv1, cur1);
5956 pv2 = SvPV_const(sv2, cur2);
5958 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5959 /* Differing utf8ness.
5960 * Do not UTF8size the comparands as a side-effect. */
5963 svrecode = newSVpvn(pv2, cur2);
5964 sv_recode_to_utf8(svrecode, PL_encoding);
5965 pv2 = SvPV_const(svrecode, cur2);
5968 svrecode = newSVpvn(pv1, cur1);
5969 sv_recode_to_utf8(svrecode, PL_encoding);
5970 pv1 = SvPV_const(svrecode, cur1);
5972 /* Now both are in UTF-8. */
5974 SvREFCNT_dec(svrecode);
5979 bool is_utf8 = TRUE;
5982 /* sv1 is the UTF-8 one,
5983 * if is equal it must be downgrade-able */
5984 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5990 /* sv2 is the UTF-8 one,
5991 * if is equal it must be downgrade-able */
5992 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5998 /* Downgrade not possible - cannot be eq */
6006 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6008 SvREFCNT_dec(svrecode);
6018 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6019 string in C<sv1> is less than, equal to, or greater than the string in
6020 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6021 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6027 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6031 const char *pv1, *pv2;
6034 SV *svrecode = NULL;
6041 pv1 = SvPV_const(sv1, cur1);
6048 pv2 = SvPV_const(sv2, cur2);
6050 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6051 /* Differing utf8ness.
6052 * Do not UTF8size the comparands as a side-effect. */
6055 svrecode = newSVpvn(pv2, cur2);
6056 sv_recode_to_utf8(svrecode, PL_encoding);
6057 pv2 = SvPV_const(svrecode, cur2);
6060 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6065 svrecode = newSVpvn(pv1, cur1);
6066 sv_recode_to_utf8(svrecode, PL_encoding);
6067 pv1 = SvPV_const(svrecode, cur1);
6070 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6076 cmp = cur2 ? -1 : 0;
6080 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6083 cmp = retval < 0 ? -1 : 1;
6084 } else if (cur1 == cur2) {
6087 cmp = cur1 < cur2 ? -1 : 1;
6091 SvREFCNT_dec(svrecode);
6099 =for apidoc sv_cmp_locale
6101 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6102 'use bytes' aware, handles get magic, and will coerce its args to strings
6103 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6109 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6112 #ifdef USE_LOCALE_COLLATE
6118 if (PL_collation_standard)
6122 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6124 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6126 if (!pv1 || !len1) {
6137 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6140 return retval < 0 ? -1 : 1;
6143 * When the result of collation is equality, that doesn't mean
6144 * that there are no differences -- some locales exclude some
6145 * characters from consideration. So to avoid false equalities,
6146 * we use the raw string as a tiebreaker.
6152 #endif /* USE_LOCALE_COLLATE */
6154 return sv_cmp(sv1, sv2);
6158 #ifdef USE_LOCALE_COLLATE
6161 =for apidoc sv_collxfrm
6163 Add Collate Transform magic to an SV if it doesn't already have it.
6165 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6166 scalar data of the variable, but transformed to such a format that a normal
6167 memory comparison can be used to compare the data according to the locale
6174 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6179 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6180 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6186 Safefree(mg->mg_ptr);
6187 s = SvPV_const(sv, len);
6188 if ((xf = mem_collxfrm(s, len, &xlen))) {
6189 if (SvREADONLY(sv)) {
6192 return xf + sizeof(PL_collation_ix);
6195 #ifdef PERL_OLD_COPY_ON_WRITE
6197 sv_force_normal_flags(sv, 0);
6199 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6213 if (mg && mg->mg_ptr) {
6215 return mg->mg_ptr + sizeof(PL_collation_ix);
6223 #endif /* USE_LOCALE_COLLATE */
6228 Get a line from the filehandle and store it into the SV, optionally
6229 appending to the currently-stored string.
6235 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6240 register STDCHAR rslast;
6241 register STDCHAR *bp;
6246 if (SvTHINKFIRST(sv))
6247 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6248 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6250 However, perlbench says it's slower, because the existing swipe code
6251 is faster than copy on write.
6252 Swings and roundabouts. */
6253 SvUPGRADE(sv, SVt_PV);
6258 if (PerlIO_isutf8(fp)) {
6260 sv_utf8_upgrade_nomg(sv);
6261 sv_pos_u2b(sv,&append,0);
6263 } else if (SvUTF8(sv)) {
6264 SV * const tsv = newSV(0);
6265 sv_gets(tsv, fp, 0);
6266 sv_utf8_upgrade_nomg(tsv);
6267 SvCUR_set(sv,append);
6270 goto return_string_or_null;
6275 if (PerlIO_isutf8(fp))
6278 if (IN_PERL_COMPILETIME) {
6279 /* we always read code in line mode */
6283 else if (RsSNARF(PL_rs)) {
6284 /* If it is a regular disk file use size from stat() as estimate
6285 of amount we are going to read -- may result in mallocing
6286 more memory than we really need if the layers below reduce
6287 the size we read (e.g. CRLF or a gzip layer).
6290 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6291 const Off_t offset = PerlIO_tell(fp);
6292 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6293 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6299 else if (RsRECORD(PL_rs)) {
6304 /* Grab the size of the record we're getting */
6305 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6306 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6309 /* VMS wants read instead of fread, because fread doesn't respect */
6310 /* RMS record boundaries. This is not necessarily a good thing to be */
6311 /* doing, but we've got no other real choice - except avoid stdio
6312 as implementation - perhaps write a :vms layer ?
6314 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6316 bytesread = PerlIO_read(fp, buffer, recsize);
6320 SvCUR_set(sv, bytesread += append);
6321 buffer[bytesread] = '\0';
6322 goto return_string_or_null;
6324 else if (RsPARA(PL_rs)) {
6330 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6331 if (PerlIO_isutf8(fp)) {
6332 rsptr = SvPVutf8(PL_rs, rslen);
6335 if (SvUTF8(PL_rs)) {
6336 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6337 Perl_croak(aTHX_ "Wide character in $/");
6340 rsptr = SvPV_const(PL_rs, rslen);
6344 rslast = rslen ? rsptr[rslen - 1] : '\0';
6346 if (rspara) { /* have to do this both before and after */
6347 do { /* to make sure file boundaries work right */
6350 i = PerlIO_getc(fp);
6354 PerlIO_ungetc(fp,i);
6360 /* See if we know enough about I/O mechanism to cheat it ! */
6362 /* This used to be #ifdef test - it is made run-time test for ease
6363 of abstracting out stdio interface. One call should be cheap
6364 enough here - and may even be a macro allowing compile
6368 if (PerlIO_fast_gets(fp)) {
6371 * We're going to steal some values from the stdio struct
6372 * and put EVERYTHING in the innermost loop into registers.
6374 register STDCHAR *ptr;
6378 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6379 /* An ungetc()d char is handled separately from the regular
6380 * buffer, so we getc() it back out and stuff it in the buffer.
6382 i = PerlIO_getc(fp);
6383 if (i == EOF) return 0;
6384 *(--((*fp)->_ptr)) = (unsigned char) i;
6388 /* Here is some breathtakingly efficient cheating */
6390 cnt = PerlIO_get_cnt(fp); /* get count into register */
6391 /* make sure we have the room */
6392 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6393 /* Not room for all of it
6394 if we are looking for a separator and room for some
6396 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6397 /* just process what we have room for */
6398 shortbuffered = cnt - SvLEN(sv) + append + 1;
6399 cnt -= shortbuffered;
6403 /* remember that cnt can be negative */
6404 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6409 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6410 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6411 DEBUG_P(PerlIO_printf(Perl_debug_log,
6412 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6413 DEBUG_P(PerlIO_printf(Perl_debug_log,
6414 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6415 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6416 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6421 while (cnt > 0) { /* this | eat */
6423 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6424 goto thats_all_folks; /* screams | sed :-) */
6428 Copy(ptr, bp, cnt, char); /* this | eat */
6429 bp += cnt; /* screams | dust */
6430 ptr += cnt; /* louder | sed :-) */
6435 if (shortbuffered) { /* oh well, must extend */
6436 cnt = shortbuffered;
6438 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6440 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6441 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6445 DEBUG_P(PerlIO_printf(Perl_debug_log,
6446 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6447 PTR2UV(ptr),(long)cnt));
6448 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6450 DEBUG_P(PerlIO_printf(Perl_debug_log,
6451 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6452 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6453 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6455 /* This used to call 'filbuf' in stdio form, but as that behaves like
6456 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6457 another abstraction. */
6458 i = PerlIO_getc(fp); /* get more characters */
6460 DEBUG_P(PerlIO_printf(Perl_debug_log,
6461 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6462 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6463 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6465 cnt = PerlIO_get_cnt(fp);
6466 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6467 DEBUG_P(PerlIO_printf(Perl_debug_log,
6468 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6470 if (i == EOF) /* all done for ever? */
6471 goto thats_really_all_folks;
6473 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6475 SvGROW(sv, bpx + cnt + 2);
6476 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6478 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6480 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6481 goto thats_all_folks;
6485 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6486 memNE((char*)bp - rslen, rsptr, rslen))
6487 goto screamer; /* go back to the fray */
6488 thats_really_all_folks:
6490 cnt += shortbuffered;
6491 DEBUG_P(PerlIO_printf(Perl_debug_log,
6492 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6493 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6494 DEBUG_P(PerlIO_printf(Perl_debug_log,
6495 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6496 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6497 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6499 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6500 DEBUG_P(PerlIO_printf(Perl_debug_log,
6501 "Screamer: done, len=%ld, string=|%.*s|\n",
6502 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6506 /*The big, slow, and stupid way. */
6507 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6508 STDCHAR *buf = NULL;
6509 Newx(buf, 8192, STDCHAR);
6517 register const STDCHAR * const bpe = buf + sizeof(buf);
6519 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6520 ; /* keep reading */
6524 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6525 /* Accomodate broken VAXC compiler, which applies U8 cast to
6526 * both args of ?: operator, causing EOF to change into 255
6529 i = (U8)buf[cnt - 1];
6535 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6537 sv_catpvn(sv, (char *) buf, cnt);
6539 sv_setpvn(sv, (char *) buf, cnt);
6541 if (i != EOF && /* joy */
6543 SvCUR(sv) < rslen ||
6544 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6548 * If we're reading from a TTY and we get a short read,
6549 * indicating that the user hit his EOF character, we need
6550 * to notice it now, because if we try to read from the TTY
6551 * again, the EOF condition will disappear.
6553 * The comparison of cnt to sizeof(buf) is an optimization
6554 * that prevents unnecessary calls to feof().
6558 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6562 #ifdef USE_HEAP_INSTEAD_OF_STACK
6567 if (rspara) { /* have to do this both before and after */
6568 while (i != EOF) { /* to make sure file boundaries work right */
6569 i = PerlIO_getc(fp);
6571 PerlIO_ungetc(fp,i);
6577 return_string_or_null:
6578 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6584 Auto-increment of the value in the SV, doing string to numeric conversion
6585 if necessary. Handles 'get' magic.
6591 Perl_sv_inc(pTHX_ register SV *sv)
6600 if (SvTHINKFIRST(sv)) {
6602 sv_force_normal_flags(sv, 0);
6603 if (SvREADONLY(sv)) {
6604 if (IN_PERL_RUNTIME)
6605 Perl_croak(aTHX_ PL_no_modify);
6609 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6611 i = PTR2IV(SvRV(sv));
6616 flags = SvFLAGS(sv);
6617 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6618 /* It's (privately or publicly) a float, but not tested as an
6619 integer, so test it to see. */
6621 flags = SvFLAGS(sv);
6623 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6624 /* It's publicly an integer, or privately an integer-not-float */
6625 #ifdef PERL_PRESERVE_IVUV
6629 if (SvUVX(sv) == UV_MAX)
6630 sv_setnv(sv, UV_MAX_P1);
6632 (void)SvIOK_only_UV(sv);
6633 SvUV_set(sv, SvUVX(sv) + 1);
6635 if (SvIVX(sv) == IV_MAX)
6636 sv_setuv(sv, (UV)IV_MAX + 1);
6638 (void)SvIOK_only(sv);
6639 SvIV_set(sv, SvIVX(sv) + 1);
6644 if (flags & SVp_NOK) {
6645 (void)SvNOK_only(sv);
6646 SvNV_set(sv, SvNVX(sv) + 1.0);
6650 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6651 if ((flags & SVTYPEMASK) < SVt_PVIV)
6652 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6653 (void)SvIOK_only(sv);
6658 while (isALPHA(*d)) d++;
6659 while (isDIGIT(*d)) d++;
6661 #ifdef PERL_PRESERVE_IVUV
6662 /* Got to punt this as an integer if needs be, but we don't issue
6663 warnings. Probably ought to make the sv_iv_please() that does
6664 the conversion if possible, and silently. */
6665 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6666 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6667 /* Need to try really hard to see if it's an integer.
6668 9.22337203685478e+18 is an integer.
6669 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6670 so $a="9.22337203685478e+18"; $a+0; $a++
6671 needs to be the same as $a="9.22337203685478e+18"; $a++
6678 /* sv_2iv *should* have made this an NV */
6679 if (flags & SVp_NOK) {
6680 (void)SvNOK_only(sv);
6681 SvNV_set(sv, SvNVX(sv) + 1.0);
6684 /* I don't think we can get here. Maybe I should assert this
6685 And if we do get here I suspect that sv_setnv will croak. NWC
6687 #if defined(USE_LONG_DOUBLE)
6688 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",
6689 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6691 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6692 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6695 #endif /* PERL_PRESERVE_IVUV */
6696 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6700 while (d >= SvPVX_const(sv)) {
6708 /* MKS: The original code here died if letters weren't consecutive.
6709 * at least it didn't have to worry about non-C locales. The
6710 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6711 * arranged in order (although not consecutively) and that only
6712 * [A-Za-z] are accepted by isALPHA in the C locale.
6714 if (*d != 'z' && *d != 'Z') {
6715 do { ++*d; } while (!isALPHA(*d));
6718 *(d--) -= 'z' - 'a';
6723 *(d--) -= 'z' - 'a' + 1;
6727 /* oh,oh, the number grew */
6728 SvGROW(sv, SvCUR(sv) + 2);
6729 SvCUR_set(sv, SvCUR(sv) + 1);
6730 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6741 Auto-decrement of the value in the SV, doing string to numeric conversion
6742 if necessary. Handles 'get' magic.
6748 Perl_sv_dec(pTHX_ register SV *sv)
6756 if (SvTHINKFIRST(sv)) {
6758 sv_force_normal_flags(sv, 0);
6759 if (SvREADONLY(sv)) {
6760 if (IN_PERL_RUNTIME)
6761 Perl_croak(aTHX_ PL_no_modify);
6765 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6767 i = PTR2IV(SvRV(sv));
6772 /* Unlike sv_inc we don't have to worry about string-never-numbers
6773 and keeping them magic. But we mustn't warn on punting */
6774 flags = SvFLAGS(sv);
6775 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6776 /* It's publicly an integer, or privately an integer-not-float */
6777 #ifdef PERL_PRESERVE_IVUV
6781 if (SvUVX(sv) == 0) {
6782 (void)SvIOK_only(sv);
6786 (void)SvIOK_only_UV(sv);
6787 SvUV_set(sv, SvUVX(sv) - 1);
6790 if (SvIVX(sv) == IV_MIN)
6791 sv_setnv(sv, (NV)IV_MIN - 1.0);
6793 (void)SvIOK_only(sv);
6794 SvIV_set(sv, SvIVX(sv) - 1);
6799 if (flags & SVp_NOK) {
6800 SvNV_set(sv, SvNVX(sv) - 1.0);
6801 (void)SvNOK_only(sv);
6804 if (!(flags & SVp_POK)) {
6805 if ((flags & SVTYPEMASK) < SVt_PVIV)
6806 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6808 (void)SvIOK_only(sv);
6811 #ifdef PERL_PRESERVE_IVUV
6813 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6814 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6815 /* Need to try really hard to see if it's an integer.
6816 9.22337203685478e+18 is an integer.
6817 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6818 so $a="9.22337203685478e+18"; $a+0; $a--
6819 needs to be the same as $a="9.22337203685478e+18"; $a--
6826 /* sv_2iv *should* have made this an NV */
6827 if (flags & SVp_NOK) {
6828 (void)SvNOK_only(sv);
6829 SvNV_set(sv, SvNVX(sv) - 1.0);
6832 /* I don't think we can get here. Maybe I should assert this
6833 And if we do get here I suspect that sv_setnv will croak. NWC
6835 #if defined(USE_LONG_DOUBLE)
6836 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",
6837 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6839 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6840 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6844 #endif /* PERL_PRESERVE_IVUV */
6845 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6849 =for apidoc sv_mortalcopy
6851 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6852 The new SV is marked as mortal. It will be destroyed "soon", either by an
6853 explicit call to FREETMPS, or by an implicit call at places such as
6854 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6859 /* Make a string that will exist for the duration of the expression
6860 * evaluation. Actually, it may have to last longer than that, but
6861 * hopefully we won't free it until it has been assigned to a
6862 * permanent location. */
6865 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6871 sv_setsv(sv,oldstr);
6873 PL_tmps_stack[++PL_tmps_ix] = sv;
6879 =for apidoc sv_newmortal
6881 Creates a new null SV which is mortal. The reference count of the SV is
6882 set to 1. It will be destroyed "soon", either by an explicit call to
6883 FREETMPS, or by an implicit call at places such as statement boundaries.
6884 See also C<sv_mortalcopy> and C<sv_2mortal>.
6890 Perl_sv_newmortal(pTHX)
6896 SvFLAGS(sv) = SVs_TEMP;
6898 PL_tmps_stack[++PL_tmps_ix] = sv;
6903 =for apidoc sv_2mortal
6905 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6906 by an explicit call to FREETMPS, or by an implicit call at places such as
6907 statement boundaries. SvTEMP() is turned on which means that the SV's
6908 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6909 and C<sv_mortalcopy>.
6915 Perl_sv_2mortal(pTHX_ register SV *sv)
6920 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6923 PL_tmps_stack[++PL_tmps_ix] = sv;
6931 Creates a new SV and copies a string into it. The reference count for the
6932 SV is set to 1. If C<len> is zero, Perl will compute the length using
6933 strlen(). For efficiency, consider using C<newSVpvn> instead.
6939 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6945 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6950 =for apidoc newSVpvn
6952 Creates a new SV and copies a string into it. The reference count for the
6953 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6954 string. You are responsible for ensuring that the source string is at least
6955 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6961 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6967 sv_setpvn(sv,s,len);
6973 =for apidoc newSVhek
6975 Creates a new SV from the hash key structure. It will generate scalars that
6976 point to the shared string table where possible. Returns a new (undefined)
6977 SV if the hek is NULL.
6983 Perl_newSVhek(pTHX_ const HEK *hek)
6993 if (HEK_LEN(hek) == HEf_SVKEY) {
6994 return newSVsv(*(SV**)HEK_KEY(hek));
6996 const int flags = HEK_FLAGS(hek);
6997 if (flags & HVhek_WASUTF8) {
6999 Andreas would like keys he put in as utf8 to come back as utf8
7001 STRLEN utf8_len = HEK_LEN(hek);
7002 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7003 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7006 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7008 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7009 /* We don't have a pointer to the hv, so we have to replicate the
7010 flag into every HEK. This hv is using custom a hasing
7011 algorithm. Hence we can't return a shared string scalar, as
7012 that would contain the (wrong) hash value, and might get passed
7013 into an hv routine with a regular hash.
7014 Similarly, a hash that isn't using shared hash keys has to have
7015 the flag in every key so that we know not to try to call
7016 share_hek_kek on it. */
7018 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7023 /* This will be overwhelminly the most common case. */
7025 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7026 more efficient than sharepvn(). */
7030 sv_upgrade(sv, SVt_PV);
7031 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7032 SvCUR_set(sv, HEK_LEN(hek));
7045 =for apidoc newSVpvn_share
7047 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7048 table. If the string does not already exist in the table, it is created
7049 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7050 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7051 otherwise the hash is computed. The idea here is that as the string table
7052 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7053 hash lookup will avoid string compare.
7059 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7063 bool is_utf8 = FALSE;
7064 const char *const orig_src = src;
7067 STRLEN tmplen = -len;
7069 /* See the note in hv.c:hv_fetch() --jhi */
7070 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7074 PERL_HASH(hash, src, len);
7076 sv_upgrade(sv, SVt_PV);
7077 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7085 if (src != orig_src)
7091 #if defined(PERL_IMPLICIT_CONTEXT)
7093 /* pTHX_ magic can't cope with varargs, so this is a no-context
7094 * version of the main function, (which may itself be aliased to us).
7095 * Don't access this version directly.
7099 Perl_newSVpvf_nocontext(const char* pat, ...)
7104 va_start(args, pat);
7105 sv = vnewSVpvf(pat, &args);
7112 =for apidoc newSVpvf
7114 Creates a new SV and initializes it with the string formatted like
7121 Perl_newSVpvf(pTHX_ const char* pat, ...)
7125 va_start(args, pat);
7126 sv = vnewSVpvf(pat, &args);
7131 /* backend for newSVpvf() and newSVpvf_nocontext() */
7134 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7139 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7146 Creates a new SV and copies a floating point value into it.
7147 The reference count for the SV is set to 1.
7153 Perl_newSVnv(pTHX_ NV n)
7166 Creates a new SV and copies an integer into it. The reference count for the
7173 Perl_newSViv(pTHX_ IV i)
7186 Creates a new SV and copies an unsigned integer into it.
7187 The reference count for the SV is set to 1.
7193 Perl_newSVuv(pTHX_ UV u)
7204 =for apidoc newSV_type
7206 Creates a new SV, of the type specificied. The reference count for the new SV
7213 Perl_newSV_type(pTHX_ svtype type)
7218 sv_upgrade(sv, type);
7223 =for apidoc newRV_noinc
7225 Creates an RV wrapper for an SV. The reference count for the original
7226 SV is B<not> incremented.
7232 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7235 register SV *sv = newSV_type(SVt_RV);
7237 SvRV_set(sv, tmpRef);
7242 /* newRV_inc is the official function name to use now.
7243 * newRV_inc is in fact #defined to newRV in sv.h
7247 Perl_newRV(pTHX_ SV *sv)
7250 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7256 Creates a new SV which is an exact duplicate of the original SV.
7263 Perl_newSVsv(pTHX_ register SV *old)
7270 if (SvTYPE(old) == SVTYPEMASK) {
7271 if (ckWARN_d(WARN_INTERNAL))
7272 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7276 /* SV_GMAGIC is the default for sv_setv()
7277 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7278 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7279 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7284 =for apidoc sv_reset
7286 Underlying implementation for the C<reset> Perl function.
7287 Note that the perl-level function is vaguely deprecated.
7293 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7296 char todo[PERL_UCHAR_MAX+1];
7301 if (!*s) { /* reset ?? searches */
7302 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7304 const U32 count = mg->mg_len / sizeof(PMOP**);
7305 PMOP **pmp = (PMOP**) mg->mg_ptr;
7306 PMOP *const *const end = pmp + count;
7310 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7312 (*pmp)->op_pmflags &= ~PMf_USED;
7320 /* reset variables */
7322 if (!HvARRAY(stash))
7325 Zero(todo, 256, char);
7328 I32 i = (unsigned char)*s;
7332 max = (unsigned char)*s++;
7333 for ( ; i <= max; i++) {
7336 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7338 for (entry = HvARRAY(stash)[i];
7340 entry = HeNEXT(entry))
7345 if (!todo[(U8)*HeKEY(entry)])
7347 gv = (GV*)HeVAL(entry);
7350 if (SvTHINKFIRST(sv)) {
7351 if (!SvREADONLY(sv) && SvROK(sv))
7353 /* XXX Is this continue a bug? Why should THINKFIRST
7354 exempt us from resetting arrays and hashes? */
7358 if (SvTYPE(sv) >= SVt_PV) {
7360 if (SvPVX_const(sv) != NULL)
7368 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7370 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7373 # if defined(USE_ENVIRON_ARRAY)
7376 # endif /* USE_ENVIRON_ARRAY */
7387 Using various gambits, try to get an IO from an SV: the IO slot if its a
7388 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7389 named after the PV if we're a string.
7395 Perl_sv_2io(pTHX_ SV *sv)
7400 switch (SvTYPE(sv)) {
7408 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7412 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7414 return sv_2io(SvRV(sv));
7415 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7421 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7430 Using various gambits, try to get a CV from an SV; in addition, try if
7431 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7432 The flags in C<lref> are passed to sv_fetchsv.
7438 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7449 switch (SvTYPE(sv)) {
7468 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7469 tryAMAGICunDEREF(to_cv);
7472 if (SvTYPE(sv) == SVt_PVCV) {
7481 Perl_croak(aTHX_ "Not a subroutine reference");
7486 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7492 /* Some flags to gv_fetchsv mean don't really create the GV */
7493 if (SvTYPE(gv) != SVt_PVGV) {
7499 if (lref && !GvCVu(gv)) {
7503 gv_efullname3(tmpsv, gv, NULL);
7504 /* XXX this is probably not what they think they're getting.
7505 * It has the same effect as "sub name;", i.e. just a forward
7507 newSUB(start_subparse(FALSE, 0),
7508 newSVOP(OP_CONST, 0, tmpsv),
7512 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7522 Returns true if the SV has a true value by Perl's rules.
7523 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7524 instead use an in-line version.
7530 Perl_sv_true(pTHX_ register SV *sv)
7535 register const XPV* const tXpv = (XPV*)SvANY(sv);
7537 (tXpv->xpv_cur > 1 ||
7538 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7545 return SvIVX(sv) != 0;
7548 return SvNVX(sv) != 0.0;
7550 return sv_2bool(sv);
7556 =for apidoc sv_pvn_force
7558 Get a sensible string out of the SV somehow.
7559 A private implementation of the C<SvPV_force> macro for compilers which
7560 can't cope with complex macro expressions. Always use the macro instead.
7562 =for apidoc sv_pvn_force_flags
7564 Get a sensible string out of the SV somehow.
7565 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7566 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7567 implemented in terms of this function.
7568 You normally want to use the various wrapper macros instead: see
7569 C<SvPV_force> and C<SvPV_force_nomg>
7575 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7578 if (SvTHINKFIRST(sv) && !SvROK(sv))
7579 sv_force_normal_flags(sv, 0);
7589 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7590 const char * const ref = sv_reftype(sv,0);
7592 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7593 ref, OP_NAME(PL_op));
7595 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7597 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7598 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7600 s = sv_2pv_flags(sv, &len, flags);
7604 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7607 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7608 SvGROW(sv, len + 1);
7609 Move(s,SvPVX(sv),len,char);
7614 SvPOK_on(sv); /* validate pointer */
7616 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7617 PTR2UV(sv),SvPVX_const(sv)));
7620 return SvPVX_mutable(sv);
7624 =for apidoc sv_pvbyten_force
7626 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7632 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7634 sv_pvn_force(sv,lp);
7635 sv_utf8_downgrade(sv,0);
7641 =for apidoc sv_pvutf8n_force
7643 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7649 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7651 sv_pvn_force(sv,lp);
7652 sv_utf8_upgrade(sv);
7658 =for apidoc sv_reftype
7660 Returns a string describing what the SV is a reference to.
7666 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7668 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7669 inside return suggests a const propagation bug in g++. */
7670 if (ob && SvOBJECT(sv)) {
7671 char * const name = HvNAME_get(SvSTASH(sv));
7672 return name ? name : (char *) "__ANON__";
7675 switch (SvTYPE(sv)) {
7691 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7692 /* tied lvalues should appear to be
7693 * scalars for backwards compatitbility */
7694 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7695 ? "SCALAR" : "LVALUE");
7696 case SVt_PVAV: return "ARRAY";
7697 case SVt_PVHV: return "HASH";
7698 case SVt_PVCV: return "CODE";
7699 case SVt_PVGV: return "GLOB";
7700 case SVt_PVFM: return "FORMAT";
7701 case SVt_PVIO: return "IO";
7702 case SVt_BIND: return "BIND";
7703 default: return "UNKNOWN";
7709 =for apidoc sv_isobject
7711 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7712 object. If the SV is not an RV, or if the object is not blessed, then this
7719 Perl_sv_isobject(pTHX_ SV *sv)
7735 Returns a boolean indicating whether the SV is blessed into the specified
7736 class. This does not check for subtypes; use C<sv_derived_from> to verify
7737 an inheritance relationship.
7743 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7754 hvname = HvNAME_get(SvSTASH(sv));
7758 return strEQ(hvname, name);
7764 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7765 it will be upgraded to one. If C<classname> is non-null then the new SV will
7766 be blessed in the specified package. The new SV is returned and its
7767 reference count is 1.
7773 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7780 SV_CHECK_THINKFIRST_COW_DROP(rv);
7781 (void)SvAMAGIC_off(rv);
7783 if (SvTYPE(rv) >= SVt_PVMG) {
7784 const U32 refcnt = SvREFCNT(rv);
7788 SvREFCNT(rv) = refcnt;
7790 sv_upgrade(rv, SVt_RV);
7791 } else if (SvROK(rv)) {
7792 SvREFCNT_dec(SvRV(rv));
7793 } else if (SvTYPE(rv) < SVt_RV)
7794 sv_upgrade(rv, SVt_RV);
7795 else if (SvTYPE(rv) > SVt_RV) {
7806 HV* const stash = gv_stashpv(classname, GV_ADD);
7807 (void)sv_bless(rv, stash);
7813 =for apidoc sv_setref_pv
7815 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7816 argument will be upgraded to an RV. That RV will be modified to point to
7817 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7818 into the SV. The C<classname> argument indicates the package for the
7819 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7820 will have a reference count of 1, and the RV will be returned.
7822 Do not use with other Perl types such as HV, AV, SV, CV, because those
7823 objects will become corrupted by the pointer copy process.
7825 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7831 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7835 sv_setsv(rv, &PL_sv_undef);
7839 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7844 =for apidoc sv_setref_iv
7846 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7847 argument will be upgraded to an RV. That RV will be modified to point to
7848 the new SV. The C<classname> argument indicates the package for the
7849 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7850 will have a reference count of 1, and the RV will be returned.
7856 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7858 sv_setiv(newSVrv(rv,classname), iv);
7863 =for apidoc sv_setref_uv
7865 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7866 argument will be upgraded to an RV. That RV will be modified to point to
7867 the new SV. The C<classname> argument indicates the package for the
7868 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7869 will have a reference count of 1, and the RV will be returned.
7875 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7877 sv_setuv(newSVrv(rv,classname), uv);
7882 =for apidoc sv_setref_nv
7884 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7885 argument will be upgraded to an RV. That RV will be modified to point to
7886 the new SV. The C<classname> argument indicates the package for the
7887 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7888 will have a reference count of 1, and the RV will be returned.
7894 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7896 sv_setnv(newSVrv(rv,classname), nv);
7901 =for apidoc sv_setref_pvn
7903 Copies a string into a new SV, optionally blessing the SV. The length of the
7904 string must be specified with C<n>. The C<rv> argument will be upgraded to
7905 an RV. That RV will be modified to point to the new SV. The C<classname>
7906 argument indicates the package for the blessing. Set C<classname> to
7907 C<NULL> to avoid the blessing. The new SV will have a reference count
7908 of 1, and the RV will be returned.
7910 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7916 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7918 sv_setpvn(newSVrv(rv,classname), pv, n);
7923 =for apidoc sv_bless
7925 Blesses an SV into a specified package. The SV must be an RV. The package
7926 must be designated by its stash (see C<gv_stashpv()>). The reference count
7927 of the SV is unaffected.
7933 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7938 Perl_croak(aTHX_ "Can't bless non-reference value");
7940 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7941 if (SvREADONLY(tmpRef))
7942 Perl_croak(aTHX_ PL_no_modify);
7943 if (SvOBJECT(tmpRef)) {
7944 if (SvTYPE(tmpRef) != SVt_PVIO)
7946 SvREFCNT_dec(SvSTASH(tmpRef));
7949 SvOBJECT_on(tmpRef);
7950 if (SvTYPE(tmpRef) != SVt_PVIO)
7952 SvUPGRADE(tmpRef, SVt_PVMG);
7953 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7958 (void)SvAMAGIC_off(sv);
7960 if(SvSMAGICAL(tmpRef))
7961 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7969 /* Downgrades a PVGV to a PVMG.
7973 S_sv_unglob(pTHX_ SV *sv)
7978 SV * const temp = sv_newmortal();
7980 assert(SvTYPE(sv) == SVt_PVGV);
7982 gv_efullname3(temp, (GV *) sv, "*");
7985 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
7986 mro_method_changed_in(stash);
7990 sv_del_backref((SV*)GvSTASH(sv), sv);
7994 if (GvNAME_HEK(sv)) {
7995 unshare_hek(GvNAME_HEK(sv));
7997 isGV_with_GP_off(sv);
7999 /* need to keep SvANY(sv) in the right arena */
8000 xpvmg = new_XPVMG();
8001 StructCopy(SvANY(sv), xpvmg, XPVMG);
8002 del_XPVGV(SvANY(sv));
8005 SvFLAGS(sv) &= ~SVTYPEMASK;
8006 SvFLAGS(sv) |= SVt_PVMG;
8008 /* Intentionally not calling any local SET magic, as this isn't so much a
8009 set operation as merely an internal storage change. */
8010 sv_setsv_flags(sv, temp, 0);
8014 =for apidoc sv_unref_flags
8016 Unsets the RV status of the SV, and decrements the reference count of
8017 whatever was being referenced by the RV. This can almost be thought of
8018 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8019 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8020 (otherwise the decrementing is conditional on the reference count being
8021 different from one or the reference being a readonly SV).
8028 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8030 SV* const target = SvRV(ref);
8032 if (SvWEAKREF(ref)) {
8033 sv_del_backref(target, ref);
8035 SvRV_set(ref, NULL);
8038 SvRV_set(ref, NULL);
8040 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8041 assigned to as BEGIN {$a = \"Foo"} will fail. */
8042 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8043 SvREFCNT_dec(target);
8044 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8045 sv_2mortal(target); /* Schedule for freeing later */
8049 =for apidoc sv_untaint
8051 Untaint an SV. Use C<SvTAINTED_off> instead.
8056 Perl_sv_untaint(pTHX_ SV *sv)
8058 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8059 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8066 =for apidoc sv_tainted
8068 Test an SV for taintedness. Use C<SvTAINTED> instead.
8073 Perl_sv_tainted(pTHX_ SV *sv)
8075 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8076 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8077 if (mg && (mg->mg_len & 1) )
8084 =for apidoc sv_setpviv
8086 Copies an integer into the given SV, also updating its string value.
8087 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8093 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8095 char buf[TYPE_CHARS(UV)];
8097 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8099 sv_setpvn(sv, ptr, ebuf - ptr);
8103 =for apidoc sv_setpviv_mg
8105 Like C<sv_setpviv>, but also handles 'set' magic.
8111 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8117 #if defined(PERL_IMPLICIT_CONTEXT)
8119 /* pTHX_ magic can't cope with varargs, so this is a no-context
8120 * version of the main function, (which may itself be aliased to us).
8121 * Don't access this version directly.
8125 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8129 va_start(args, pat);
8130 sv_vsetpvf(sv, pat, &args);
8134 /* pTHX_ magic can't cope with varargs, so this is a no-context
8135 * version of the main function, (which may itself be aliased to us).
8136 * Don't access this version directly.
8140 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8144 va_start(args, pat);
8145 sv_vsetpvf_mg(sv, pat, &args);
8151 =for apidoc sv_setpvf
8153 Works like C<sv_catpvf> but copies the text into the SV instead of
8154 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8160 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8163 va_start(args, pat);
8164 sv_vsetpvf(sv, pat, &args);
8169 =for apidoc sv_vsetpvf
8171 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8172 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8174 Usually used via its frontend C<sv_setpvf>.
8180 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8182 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8186 =for apidoc sv_setpvf_mg
8188 Like C<sv_setpvf>, but also handles 'set' magic.
8194 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8197 va_start(args, pat);
8198 sv_vsetpvf_mg(sv, pat, &args);
8203 =for apidoc sv_vsetpvf_mg
8205 Like C<sv_vsetpvf>, but also handles 'set' magic.
8207 Usually used via its frontend C<sv_setpvf_mg>.
8213 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8215 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8219 #if defined(PERL_IMPLICIT_CONTEXT)
8221 /* pTHX_ magic can't cope with varargs, so this is a no-context
8222 * version of the main function, (which may itself be aliased to us).
8223 * Don't access this version directly.
8227 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8231 va_start(args, pat);
8232 sv_vcatpvf(sv, pat, &args);
8236 /* pTHX_ magic can't cope with varargs, so this is a no-context
8237 * version of the main function, (which may itself be aliased to us).
8238 * Don't access this version directly.
8242 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8246 va_start(args, pat);
8247 sv_vcatpvf_mg(sv, pat, &args);
8253 =for apidoc sv_catpvf
8255 Processes its arguments like C<sprintf> and appends the formatted
8256 output to an SV. If the appended data contains "wide" characters
8257 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8258 and characters >255 formatted with %c), the original SV might get
8259 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8260 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8261 valid UTF-8; if the original SV was bytes, the pattern should be too.
8266 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8269 va_start(args, pat);
8270 sv_vcatpvf(sv, pat, &args);
8275 =for apidoc sv_vcatpvf
8277 Processes its arguments like C<vsprintf> and appends the formatted output
8278 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8280 Usually used via its frontend C<sv_catpvf>.
8286 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8288 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8292 =for apidoc sv_catpvf_mg
8294 Like C<sv_catpvf>, but also handles 'set' magic.
8300 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8303 va_start(args, pat);
8304 sv_vcatpvf_mg(sv, pat, &args);
8309 =for apidoc sv_vcatpvf_mg
8311 Like C<sv_vcatpvf>, but also handles 'set' magic.
8313 Usually used via its frontend C<sv_catpvf_mg>.
8319 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8321 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8326 =for apidoc sv_vsetpvfn
8328 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8331 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8337 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8339 sv_setpvn(sv, "", 0);
8340 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8344 S_expect_number(pTHX_ char** pattern)
8348 switch (**pattern) {
8349 case '1': case '2': case '3':
8350 case '4': case '5': case '6':
8351 case '7': case '8': case '9':
8352 var = *(*pattern)++ - '0';
8353 while (isDIGIT(**pattern)) {
8354 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8356 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8364 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8366 const int neg = nv < 0;
8375 if (uv & 1 && uv == nv)
8376 uv--; /* Round to even */
8378 const unsigned dig = uv % 10;
8391 =for apidoc sv_vcatpvfn
8393 Processes its arguments like C<vsprintf> and appends the formatted output
8394 to an SV. Uses an array of SVs if the C style variable argument list is
8395 missing (NULL). When running with taint checks enabled, indicates via
8396 C<maybe_tainted> if results are untrustworthy (often due to the use of
8399 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8405 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8406 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8407 vec_utf8 = DO_UTF8(vecsv);
8409 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8412 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8420 static const char nullstr[] = "(null)";
8422 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8423 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8425 /* Times 4: a decimal digit takes more than 3 binary digits.
8426 * NV_DIG: mantissa takes than many decimal digits.
8427 * Plus 32: Playing safe. */
8428 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8429 /* large enough for "%#.#f" --chip */
8430 /* what about long double NVs? --jhi */
8432 PERL_UNUSED_ARG(maybe_tainted);
8434 /* no matter what, this is a string now */
8435 (void)SvPV_force(sv, origlen);
8437 /* special-case "", "%s", and "%-p" (SVf - see below) */
8440 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8442 const char * const s = va_arg(*args, char*);
8443 sv_catpv(sv, s ? s : nullstr);
8445 else if (svix < svmax) {
8446 sv_catsv(sv, *svargs);
8450 if (args && patlen == 3 && pat[0] == '%' &&
8451 pat[1] == '-' && pat[2] == 'p') {
8452 argsv = (SV*)va_arg(*args, void*);
8453 sv_catsv(sv, argsv);
8457 #ifndef USE_LONG_DOUBLE
8458 /* special-case "%.<number>[gf]" */
8459 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8460 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8461 unsigned digits = 0;
8465 while (*pp >= '0' && *pp <= '9')
8466 digits = 10 * digits + (*pp++ - '0');
8467 if (pp - pat == (int)patlen - 1) {
8475 /* Add check for digits != 0 because it seems that some
8476 gconverts are buggy in this case, and we don't yet have
8477 a Configure test for this. */
8478 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8479 /* 0, point, slack */
8480 Gconvert(nv, (int)digits, 0, ebuf);
8482 if (*ebuf) /* May return an empty string for digits==0 */
8485 } else if (!digits) {
8488 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8489 sv_catpvn(sv, p, l);
8495 #endif /* !USE_LONG_DOUBLE */
8497 if (!args && svix < svmax && DO_UTF8(*svargs))
8500 patend = (char*)pat + patlen;
8501 for (p = (char*)pat; p < patend; p = q) {
8504 bool vectorize = FALSE;
8505 bool vectorarg = FALSE;
8506 bool vec_utf8 = FALSE;
8512 bool has_precis = FALSE;
8514 const I32 osvix = svix;
8515 bool is_utf8 = FALSE; /* is this item utf8? */
8516 #ifdef HAS_LDBL_SPRINTF_BUG
8517 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8518 with sfio - Allen <allens@cpan.org> */
8519 bool fix_ldbl_sprintf_bug = FALSE;
8523 U8 utf8buf[UTF8_MAXBYTES+1];
8524 STRLEN esignlen = 0;
8526 const char *eptr = NULL;
8529 const U8 *vecstr = NULL;
8536 /* we need a long double target in case HAS_LONG_DOUBLE but
8539 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8547 const char *dotstr = ".";
8548 STRLEN dotstrlen = 1;
8549 I32 efix = 0; /* explicit format parameter index */
8550 I32 ewix = 0; /* explicit width index */
8551 I32 epix = 0; /* explicit precision index */
8552 I32 evix = 0; /* explicit vector index */
8553 bool asterisk = FALSE;
8555 /* echo everything up to the next format specification */
8556 for (q = p; q < patend && *q != '%'; ++q) ;
8558 if (has_utf8 && !pat_utf8)
8559 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8561 sv_catpvn(sv, p, q - p);
8568 We allow format specification elements in this order:
8569 \d+\$ explicit format parameter index
8571 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8572 0 flag (as above): repeated to allow "v02"
8573 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8574 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8576 [%bcdefginopsuxDFOUX] format (mandatory)
8581 As of perl5.9.3, printf format checking is on by default.
8582 Internally, perl uses %p formats to provide an escape to
8583 some extended formatting. This block deals with those
8584 extensions: if it does not match, (char*)q is reset and
8585 the normal format processing code is used.
8587 Currently defined extensions are:
8588 %p include pointer address (standard)
8589 %-p (SVf) include an SV (previously %_)
8590 %-<num>p include an SV with precision <num>
8591 %1p (VDf) include a v-string (as %vd)
8592 %<num>p reserved for future extensions
8594 Robin Barker 2005-07-14
8601 n = expect_number(&q);
8608 argsv = (SV*)va_arg(*args, void*);
8609 eptr = SvPV_const(argsv, elen);
8615 else if (n == vdNUMBER) { /* VDf */
8622 if (ckWARN_d(WARN_INTERNAL))
8623 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8624 "internal %%<num>p might conflict with future printf extensions");
8630 if ( (width = expect_number(&q)) ) {
8645 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8674 if ( (ewix = expect_number(&q)) )
8683 if ((vectorarg = asterisk)) {
8696 width = expect_number(&q);
8702 vecsv = va_arg(*args, SV*);
8704 vecsv = (evix > 0 && evix <= svmax)
8705 ? svargs[evix-1] : &PL_sv_undef;
8707 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8709 dotstr = SvPV_const(vecsv, dotstrlen);
8710 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8711 bad with tied or overloaded values that return UTF8. */
8714 else if (has_utf8) {
8715 vecsv = sv_mortalcopy(vecsv);
8716 sv_utf8_upgrade(vecsv);
8717 dotstr = SvPV_const(vecsv, dotstrlen);
8724 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8725 vecsv = svargs[efix ? efix-1 : svix++];
8726 vecstr = (U8*)SvPV_const(vecsv,veclen);
8727 vec_utf8 = DO_UTF8(vecsv);
8729 /* if this is a version object, we need to convert
8730 * back into v-string notation and then let the
8731 * vectorize happen normally
8733 if (sv_derived_from(vecsv, "version")) {
8734 char *version = savesvpv(vecsv);
8735 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8736 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8737 "vector argument not supported with alpha versions");
8740 vecsv = sv_newmortal();
8741 scan_vstring(version, version + veclen, vecsv);
8742 vecstr = (U8*)SvPV_const(vecsv, veclen);
8743 vec_utf8 = DO_UTF8(vecsv);
8755 i = va_arg(*args, int);
8757 i = (ewix ? ewix <= svmax : svix < svmax) ?
8758 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8760 width = (i < 0) ? -i : i;
8770 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8772 /* XXX: todo, support specified precision parameter */
8776 i = va_arg(*args, int);
8778 i = (ewix ? ewix <= svmax : svix < svmax)
8779 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8781 has_precis = !(i < 0);
8786 precis = precis * 10 + (*q++ - '0');
8795 case 'I': /* Ix, I32x, and I64x */
8797 if (q[1] == '6' && q[2] == '4') {
8803 if (q[1] == '3' && q[2] == '2') {
8813 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8824 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8825 if (*(q + 1) == 'l') { /* lld, llf */
8851 if (!vectorize && !args) {
8853 const I32 i = efix-1;
8854 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8856 argsv = (svix >= 0 && svix < svmax)
8857 ? svargs[svix++] : &PL_sv_undef;
8868 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8870 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8872 eptr = (char*)utf8buf;
8873 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8887 eptr = va_arg(*args, char*);
8889 #ifdef MACOS_TRADITIONAL
8890 /* On MacOS, %#s format is used for Pascal strings */
8895 elen = strlen(eptr);
8897 eptr = (char *)nullstr;
8898 elen = sizeof nullstr - 1;
8902 eptr = SvPV_const(argsv, elen);
8903 if (DO_UTF8(argsv)) {
8904 I32 old_precis = precis;
8905 if (has_precis && precis < elen) {
8907 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8910 if (width) { /* fudge width (can't fudge elen) */
8911 if (has_precis && precis < elen)
8912 width += precis - old_precis;
8914 width += elen - sv_len_utf8(argsv);
8921 if (has_precis && elen > precis)
8928 if (alt || vectorize)
8930 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8951 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8960 esignbuf[esignlen++] = plus;
8964 case 'h': iv = (short)va_arg(*args, int); break;
8965 case 'l': iv = va_arg(*args, long); break;
8966 case 'V': iv = va_arg(*args, IV); break;
8967 default: iv = va_arg(*args, int); break;
8969 case 'q': iv = va_arg(*args, Quad_t); break;
8974 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
8976 case 'h': iv = (short)tiv; break;
8977 case 'l': iv = (long)tiv; break;
8979 default: iv = tiv; break;
8981 case 'q': iv = (Quad_t)tiv; break;
8985 if ( !vectorize ) /* we already set uv above */
8990 esignbuf[esignlen++] = plus;
8994 esignbuf[esignlen++] = '-';
9038 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9049 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9050 case 'l': uv = va_arg(*args, unsigned long); break;
9051 case 'V': uv = va_arg(*args, UV); break;
9052 default: uv = va_arg(*args, unsigned); break;
9054 case 'q': uv = va_arg(*args, Uquad_t); break;
9059 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9061 case 'h': uv = (unsigned short)tuv; break;
9062 case 'l': uv = (unsigned long)tuv; break;
9064 default: uv = tuv; break;
9066 case 'q': uv = (Uquad_t)tuv; break;
9073 char *ptr = ebuf + sizeof ebuf;
9074 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9080 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9086 esignbuf[esignlen++] = '0';
9087 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9095 if (alt && *ptr != '0')
9104 esignbuf[esignlen++] = '0';
9105 esignbuf[esignlen++] = c;
9108 default: /* it had better be ten or less */
9112 } while (uv /= base);
9115 elen = (ebuf + sizeof ebuf) - ptr;
9119 zeros = precis - elen;
9120 else if (precis == 0 && elen == 1 && *eptr == '0'
9121 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9124 /* a precision nullifies the 0 flag. */
9131 /* FLOATING POINT */
9134 c = 'f'; /* maybe %F isn't supported here */
9142 /* This is evil, but floating point is even more evil */
9144 /* for SV-style calling, we can only get NV
9145 for C-style calling, we assume %f is double;
9146 for simplicity we allow any of %Lf, %llf, %qf for long double
9150 #if defined(USE_LONG_DOUBLE)
9154 /* [perl #20339] - we should accept and ignore %lf rather than die */
9158 #if defined(USE_LONG_DOUBLE)
9159 intsize = args ? 0 : 'q';
9163 #if defined(HAS_LONG_DOUBLE)
9172 /* now we need (long double) if intsize == 'q', else (double) */
9174 #if LONG_DOUBLESIZE > DOUBLESIZE
9176 va_arg(*args, long double) :
9177 va_arg(*args, double)
9179 va_arg(*args, double)
9184 if (c != 'e' && c != 'E') {
9186 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9187 will cast our (long double) to (double) */
9188 (void)Perl_frexp(nv, &i);
9189 if (i == PERL_INT_MIN)
9190 Perl_die(aTHX_ "panic: frexp");
9192 need = BIT_DIGITS(i);
9194 need += has_precis ? precis : 6; /* known default */
9199 #ifdef HAS_LDBL_SPRINTF_BUG
9200 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9201 with sfio - Allen <allens@cpan.org> */
9204 # define MY_DBL_MAX DBL_MAX
9205 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9206 # if DOUBLESIZE >= 8
9207 # define MY_DBL_MAX 1.7976931348623157E+308L
9209 # define MY_DBL_MAX 3.40282347E+38L
9213 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9214 # define MY_DBL_MAX_BUG 1L
9216 # define MY_DBL_MAX_BUG MY_DBL_MAX
9220 # define MY_DBL_MIN DBL_MIN
9221 # else /* XXX guessing! -Allen */
9222 # if DOUBLESIZE >= 8
9223 # define MY_DBL_MIN 2.2250738585072014E-308L
9225 # define MY_DBL_MIN 1.17549435E-38L
9229 if ((intsize == 'q') && (c == 'f') &&
9230 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9232 /* it's going to be short enough that
9233 * long double precision is not needed */
9235 if ((nv <= 0L) && (nv >= -0L))
9236 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9238 /* would use Perl_fp_class as a double-check but not
9239 * functional on IRIX - see perl.h comments */
9241 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9242 /* It's within the range that a double can represent */
9243 #if defined(DBL_MAX) && !defined(DBL_MIN)
9244 if ((nv >= ((long double)1/DBL_MAX)) ||
9245 (nv <= (-(long double)1/DBL_MAX)))
9247 fix_ldbl_sprintf_bug = TRUE;
9250 if (fix_ldbl_sprintf_bug == TRUE) {
9260 # undef MY_DBL_MAX_BUG
9263 #endif /* HAS_LDBL_SPRINTF_BUG */
9265 need += 20; /* fudge factor */
9266 if (PL_efloatsize < need) {
9267 Safefree(PL_efloatbuf);
9268 PL_efloatsize = need + 20; /* more fudge */
9269 Newx(PL_efloatbuf, PL_efloatsize, char);
9270 PL_efloatbuf[0] = '\0';
9273 if ( !(width || left || plus || alt) && fill != '0'
9274 && has_precis && intsize != 'q' ) { /* Shortcuts */
9275 /* See earlier comment about buggy Gconvert when digits,
9277 if ( c == 'g' && precis) {
9278 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9279 /* May return an empty string for digits==0 */
9280 if (*PL_efloatbuf) {
9281 elen = strlen(PL_efloatbuf);
9282 goto float_converted;
9284 } else if ( c == 'f' && !precis) {
9285 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9290 char *ptr = ebuf + sizeof ebuf;
9293 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9294 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9295 if (intsize == 'q') {
9296 /* Copy the one or more characters in a long double
9297 * format before the 'base' ([efgEFG]) character to
9298 * the format string. */
9299 static char const prifldbl[] = PERL_PRIfldbl;
9300 char const *p = prifldbl + sizeof(prifldbl) - 3;
9301 while (p >= prifldbl) { *--ptr = *p--; }
9306 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9311 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9323 /* No taint. Otherwise we are in the strange situation
9324 * where printf() taints but print($float) doesn't.
9326 #if defined(HAS_LONG_DOUBLE)
9327 elen = ((intsize == 'q')
9328 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9329 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9331 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9335 eptr = PL_efloatbuf;
9343 i = SvCUR(sv) - origlen;
9346 case 'h': *(va_arg(*args, short*)) = i; break;
9347 default: *(va_arg(*args, int*)) = i; break;
9348 case 'l': *(va_arg(*args, long*)) = i; break;
9349 case 'V': *(va_arg(*args, IV*)) = i; break;
9351 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9356 sv_setuv_mg(argsv, (UV)i);
9357 continue; /* not "break" */
9364 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9365 && ckWARN(WARN_PRINTF))
9367 SV * const msg = sv_newmortal();
9368 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9369 (PL_op->op_type == OP_PRTF) ? "" : "s");
9372 Perl_sv_catpvf(aTHX_ msg,
9373 "\"%%%c\"", c & 0xFF);
9375 Perl_sv_catpvf(aTHX_ msg,
9376 "\"%%\\%03"UVof"\"",
9379 sv_catpvs(msg, "end of string");
9380 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9383 /* output mangled stuff ... */
9389 /* ... right here, because formatting flags should not apply */
9390 SvGROW(sv, SvCUR(sv) + elen + 1);
9392 Copy(eptr, p, elen, char);
9395 SvCUR_set(sv, p - SvPVX_const(sv));
9397 continue; /* not "break" */
9400 if (is_utf8 != has_utf8) {
9403 sv_utf8_upgrade(sv);
9406 const STRLEN old_elen = elen;
9407 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9408 sv_utf8_upgrade(nsv);
9409 eptr = SvPVX_const(nsv);
9412 if (width) { /* fudge width (can't fudge elen) */
9413 width += elen - old_elen;
9419 have = esignlen + zeros + elen;
9421 Perl_croak_nocontext(PL_memory_wrap);
9423 need = (have > width ? have : width);
9426 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9427 Perl_croak_nocontext(PL_memory_wrap);
9428 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9430 if (esignlen && fill == '0') {
9432 for (i = 0; i < (int)esignlen; i++)
9436 memset(p, fill, gap);
9439 if (esignlen && fill != '0') {
9441 for (i = 0; i < (int)esignlen; i++)
9446 for (i = zeros; i; i--)
9450 Copy(eptr, p, elen, char);
9454 memset(p, ' ', gap);
9459 Copy(dotstr, p, dotstrlen, char);
9463 vectorize = FALSE; /* done iterating over vecstr */
9470 SvCUR_set(sv, p - SvPVX_const(sv));
9478 /* =========================================================================
9480 =head1 Cloning an interpreter
9482 All the macros and functions in this section are for the private use of
9483 the main function, perl_clone().
9485 The foo_dup() functions make an exact copy of an existing foo thinngy.
9486 During the course of a cloning, a hash table is used to map old addresses
9487 to new addresses. The table is created and manipulated with the
9488 ptr_table_* functions.
9492 ============================================================================*/
9495 #if defined(USE_ITHREADS)
9497 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9498 #ifndef GpREFCNT_inc
9499 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9503 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9504 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9505 If this changes, please unmerge ss_dup. */
9506 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9507 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9508 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9509 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9510 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9511 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9512 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9513 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9514 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9515 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9516 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9517 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9518 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9519 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9521 /* clone a parser */
9524 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9531 /* look for it in the table first */
9532 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9536 /* create anew and remember what it is */
9537 Newxz(parser, 1, yy_parser);
9538 ptr_table_store(PL_ptr_table, proto, parser);
9540 parser->yyerrstatus = 0;
9541 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9543 /* XXX these not yet duped */
9544 parser->old_parser = NULL;
9545 parser->stack = NULL;
9547 parser->stack_size = 0;
9548 /* XXX parser->stack->state = 0; */
9550 /* XXX eventually, just Copy() most of the parser struct ? */
9552 parser->lex_brackets = proto->lex_brackets;
9553 parser->lex_casemods = proto->lex_casemods;
9554 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9555 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9556 parser->lex_casestack = savepvn(proto->lex_casestack,
9557 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9558 parser->lex_defer = proto->lex_defer;
9559 parser->lex_dojoin = proto->lex_dojoin;
9560 parser->lex_expect = proto->lex_expect;
9561 parser->lex_formbrack = proto->lex_formbrack;
9562 parser->lex_inpat = proto->lex_inpat;
9563 parser->lex_inwhat = proto->lex_inwhat;
9564 parser->lex_op = proto->lex_op;
9565 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9566 parser->lex_starts = proto->lex_starts;
9567 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9568 parser->multi_close = proto->multi_close;
9569 parser->multi_open = proto->multi_open;
9570 parser->multi_start = proto->multi_start;
9571 parser->pending_ident = proto->pending_ident;
9572 parser->preambled = proto->preambled;
9573 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9574 parser->linestr = sv_dup_inc(proto->linestr, param);
9575 parser->expect = proto->expect;
9576 parser->copline = proto->copline;
9577 parser->last_lop_op = proto->last_lop_op;
9579 parser->linestr = sv_dup_inc(proto->linestr, param);
9582 char *ols = SvPVX(proto->linestr);
9583 char *ls = SvPVX(parser->linestr);
9585 parser->bufptr = ls + (proto->bufptr >= ols ?
9586 proto->bufptr - ols : 0);
9587 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9588 proto->oldbufptr - ols : 0);
9589 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9590 proto->oldoldbufptr - ols : 0);
9591 parser->linestart = ls + (proto->linestart >= ols ?
9592 proto->linestart - ols : 0);
9593 parser->last_uni = ls + (proto->last_uni >= ols ?
9594 proto->last_uni - ols : 0);
9595 parser->last_lop = ls + (proto->last_lop >= ols ?
9596 proto->last_lop - ols : 0);
9598 parser->bufend = ls + SvCUR(parser->linestr);
9602 parser->endwhite = proto->endwhite;
9603 parser->faketokens = proto->faketokens;
9604 parser->lasttoke = proto->lasttoke;
9605 parser->nextwhite = proto->nextwhite;
9606 parser->realtokenstart = proto->realtokenstart;
9607 parser->skipwhite = proto->skipwhite;
9608 parser->thisclose = proto->thisclose;
9609 parser->thismad = proto->thismad;
9610 parser->thisopen = proto->thisopen;
9611 parser->thisstuff = proto->thisstuff;
9612 parser->thistoken = proto->thistoken;
9613 parser->thiswhite = proto->thiswhite;
9619 /* duplicate a file handle */
9622 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9626 PERL_UNUSED_ARG(type);
9629 return (PerlIO*)NULL;
9631 /* look for it in the table first */
9632 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9636 /* create anew and remember what it is */
9637 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9638 ptr_table_store(PL_ptr_table, fp, ret);
9642 /* duplicate a directory handle */
9645 Perl_dirp_dup(pTHX_ DIR *dp)
9647 PERL_UNUSED_CONTEXT;
9654 /* duplicate a typeglob */
9657 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9663 /* look for it in the table first */
9664 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9668 /* create anew and remember what it is */
9670 ptr_table_store(PL_ptr_table, gp, ret);
9673 ret->gp_refcnt = 0; /* must be before any other dups! */
9674 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9675 ret->gp_io = io_dup_inc(gp->gp_io, param);
9676 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9677 ret->gp_av = av_dup_inc(gp->gp_av, param);
9678 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9679 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9680 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9681 ret->gp_cvgen = gp->gp_cvgen;
9682 ret->gp_line = gp->gp_line;
9683 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9687 /* duplicate a chain of magic */
9690 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9692 MAGIC *mgprev = (MAGIC*)NULL;
9695 return (MAGIC*)NULL;
9696 /* look for it in the table first */
9697 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9701 for (; mg; mg = mg->mg_moremagic) {
9703 Newxz(nmg, 1, MAGIC);
9705 mgprev->mg_moremagic = nmg;
9708 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9709 nmg->mg_private = mg->mg_private;
9710 nmg->mg_type = mg->mg_type;
9711 nmg->mg_flags = mg->mg_flags;
9712 if (mg->mg_type == PERL_MAGIC_qr) {
9713 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9715 else if(mg->mg_type == PERL_MAGIC_backref) {
9716 /* The backref AV has its reference count deliberately bumped by
9718 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9721 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9722 ? sv_dup_inc(mg->mg_obj, param)
9723 : sv_dup(mg->mg_obj, param);
9725 nmg->mg_len = mg->mg_len;
9726 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9727 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9728 if (mg->mg_len > 0) {
9729 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9730 if (mg->mg_type == PERL_MAGIC_overload_table &&
9731 AMT_AMAGIC((AMT*)mg->mg_ptr))
9733 const AMT * const amtp = (AMT*)mg->mg_ptr;
9734 AMT * const namtp = (AMT*)nmg->mg_ptr;
9736 for (i = 1; i < NofAMmeth; i++) {
9737 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9741 else if (mg->mg_len == HEf_SVKEY)
9742 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9744 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9745 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9752 #endif /* USE_ITHREADS */
9754 /* create a new pointer-mapping table */
9757 Perl_ptr_table_new(pTHX)
9760 PERL_UNUSED_CONTEXT;
9762 Newxz(tbl, 1, PTR_TBL_t);
9765 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9769 #define PTR_TABLE_HASH(ptr) \
9770 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9773 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9774 following define) and at call to new_body_inline made below in
9775 Perl_ptr_table_store()
9778 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9780 /* map an existing pointer using a table */
9782 STATIC PTR_TBL_ENT_t *
9783 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9784 PTR_TBL_ENT_t *tblent;
9785 const UV hash = PTR_TABLE_HASH(sv);
9787 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9788 for (; tblent; tblent = tblent->next) {
9789 if (tblent->oldval == sv)
9796 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9798 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9799 PERL_UNUSED_CONTEXT;
9800 return tblent ? tblent->newval : NULL;
9803 /* add a new entry to a pointer-mapping table */
9806 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9808 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9809 PERL_UNUSED_CONTEXT;
9812 tblent->newval = newsv;
9814 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9816 new_body_inline(tblent, PTE_SVSLOT);
9818 tblent->oldval = oldsv;
9819 tblent->newval = newsv;
9820 tblent->next = tbl->tbl_ary[entry];
9821 tbl->tbl_ary[entry] = tblent;
9823 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9824 ptr_table_split(tbl);
9828 /* double the hash bucket size of an existing ptr table */
9831 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9833 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9834 const UV oldsize = tbl->tbl_max + 1;
9835 UV newsize = oldsize * 2;
9837 PERL_UNUSED_CONTEXT;
9839 Renew(ary, newsize, PTR_TBL_ENT_t*);
9840 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9841 tbl->tbl_max = --newsize;
9843 for (i=0; i < oldsize; i++, ary++) {
9844 PTR_TBL_ENT_t **curentp, **entp, *ent;
9847 curentp = ary + oldsize;
9848 for (entp = ary, ent = *ary; ent; ent = *entp) {
9849 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9851 ent->next = *curentp;
9861 /* remove all the entries from a ptr table */
9864 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9866 if (tbl && tbl->tbl_items) {
9867 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9868 UV riter = tbl->tbl_max;
9871 PTR_TBL_ENT_t *entry = array[riter];
9874 PTR_TBL_ENT_t * const oentry = entry;
9875 entry = entry->next;
9884 /* clear and free a ptr table */
9887 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9892 ptr_table_clear(tbl);
9893 Safefree(tbl->tbl_ary);
9897 #if defined(USE_ITHREADS)
9900 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9903 SvRV_set(dstr, SvWEAKREF(sstr)
9904 ? sv_dup(SvRV(sstr), param)
9905 : sv_dup_inc(SvRV(sstr), param));
9908 else if (SvPVX_const(sstr)) {
9909 /* Has something there */
9911 /* Normal PV - clone whole allocated space */
9912 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9913 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9914 /* Not that normal - actually sstr is copy on write.
9915 But we are a true, independant SV, so: */
9916 SvREADONLY_off(dstr);
9921 /* Special case - not normally malloced for some reason */
9922 if (isGV_with_GP(sstr)) {
9923 /* Don't need to do anything here. */
9925 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9926 /* A "shared" PV - clone it as "shared" PV */
9928 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9932 /* Some other special case - random pointer */
9933 SvPV_set(dstr, SvPVX(sstr));
9939 if (SvTYPE(dstr) == SVt_RV)
9940 SvRV_set(dstr, NULL);
9942 SvPV_set(dstr, NULL);
9946 /* duplicate an SV of any type (including AV, HV etc) */
9949 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9954 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9956 /* look for it in the table first */
9957 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9961 if(param->flags & CLONEf_JOIN_IN) {
9962 /** We are joining here so we don't want do clone
9963 something that is bad **/
9964 if (SvTYPE(sstr) == SVt_PVHV) {
9965 const char * const hvname = HvNAME_get(sstr);
9967 /** don't clone stashes if they already exist **/
9968 return (SV*)gv_stashpv(hvname,0);
9972 /* create anew and remember what it is */
9975 #ifdef DEBUG_LEAKING_SCALARS
9976 dstr->sv_debug_optype = sstr->sv_debug_optype;
9977 dstr->sv_debug_line = sstr->sv_debug_line;
9978 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9979 dstr->sv_debug_cloned = 1;
9980 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9983 ptr_table_store(PL_ptr_table, sstr, dstr);
9986 SvFLAGS(dstr) = SvFLAGS(sstr);
9987 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9988 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9991 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9992 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9993 (void*)PL_watch_pvx, SvPVX_const(sstr));
9996 /* don't clone objects whose class has asked us not to */
9997 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9998 SvFLAGS(dstr) &= ~SVTYPEMASK;
10003 switch (SvTYPE(sstr)) {
10005 SvANY(dstr) = NULL;
10008 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10009 SvIV_set(dstr, SvIVX(sstr));
10012 SvANY(dstr) = new_XNV();
10013 SvNV_set(dstr, SvNVX(sstr));
10016 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10017 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10019 /* case SVt_BIND: */
10022 /* These are all the types that need complex bodies allocating. */
10024 const svtype sv_type = SvTYPE(sstr);
10025 const struct body_details *const sv_type_details
10026 = bodies_by_type + sv_type;
10030 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10034 if (GvUNIQUE((GV*)sstr)) {
10035 NOOP; /* Do sharing here, and fall through */
10047 assert(sv_type_details->body_size);
10048 if (sv_type_details->arena) {
10049 new_body_inline(new_body, sv_type);
10051 = (void*)((char*)new_body - sv_type_details->offset);
10053 new_body = new_NOARENA(sv_type_details);
10057 SvANY(dstr) = new_body;
10060 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10061 ((char*)SvANY(dstr)) + sv_type_details->offset,
10062 sv_type_details->copy, char);
10064 Copy(((char*)SvANY(sstr)),
10065 ((char*)SvANY(dstr)),
10066 sv_type_details->body_size + sv_type_details->offset, char);
10069 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10070 && !isGV_with_GP(dstr))
10071 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10073 /* The Copy above means that all the source (unduplicated) pointers
10074 are now in the destination. We can check the flags and the
10075 pointers in either, but it's possible that there's less cache
10076 missing by always going for the destination.
10077 FIXME - instrument and check that assumption */
10078 if (sv_type >= SVt_PVMG) {
10079 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10080 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10081 } else if (SvMAGIC(dstr))
10082 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10084 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10087 /* The cast silences a GCC warning about unhandled types. */
10088 switch ((int)sv_type) {
10098 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10099 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10100 LvTARG(dstr) = dstr;
10101 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10102 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10104 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10106 if(isGV_with_GP(sstr)) {
10107 if (GvNAME_HEK(dstr))
10108 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10109 /* Don't call sv_add_backref here as it's going to be
10110 created as part of the magic cloning of the symbol
10112 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10113 at the point of this comment. */
10114 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10115 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10116 (void)GpREFCNT_inc(GvGP(dstr));
10118 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10121 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10122 if (IoOFP(dstr) == IoIFP(sstr))
10123 IoOFP(dstr) = IoIFP(dstr);
10125 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10126 /* PL_rsfp_filters entries have fake IoDIRP() */
10127 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10128 /* I have no idea why fake dirp (rsfps)
10129 should be treated differently but otherwise
10130 we end up with leaks -- sky*/
10131 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10132 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10133 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10135 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10136 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10137 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10138 if (IoDIRP(dstr)) {
10139 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10142 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10145 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10146 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10147 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10150 if (AvARRAY((AV*)sstr)) {
10151 SV **dst_ary, **src_ary;
10152 SSize_t items = AvFILLp((AV*)sstr) + 1;
10154 src_ary = AvARRAY((AV*)sstr);
10155 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10156 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10157 AvARRAY((AV*)dstr) = dst_ary;
10158 AvALLOC((AV*)dstr) = dst_ary;
10159 if (AvREAL((AV*)sstr)) {
10160 while (items-- > 0)
10161 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10164 while (items-- > 0)
10165 *dst_ary++ = sv_dup(*src_ary++, param);
10167 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10168 while (items-- > 0) {
10169 *dst_ary++ = &PL_sv_undef;
10173 AvARRAY((AV*)dstr) = NULL;
10174 AvALLOC((AV*)dstr) = (SV**)NULL;
10178 if (HvARRAY((HV*)sstr)) {
10180 const bool sharekeys = !!HvSHAREKEYS(sstr);
10181 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10182 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10184 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10185 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10187 HvARRAY(dstr) = (HE**)darray;
10188 while (i <= sxhv->xhv_max) {
10189 const HE * const source = HvARRAY(sstr)[i];
10190 HvARRAY(dstr)[i] = source
10191 ? he_dup(source, sharekeys, param) : 0;
10196 const struct xpvhv_aux * const saux = HvAUX(sstr);
10197 struct xpvhv_aux * const daux = HvAUX(dstr);
10198 /* This flag isn't copied. */
10199 /* SvOOK_on(hv) attacks the IV flags. */
10200 SvFLAGS(dstr) |= SVf_OOK;
10202 hvname = saux->xhv_name;
10203 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10205 daux->xhv_riter = saux->xhv_riter;
10206 daux->xhv_eiter = saux->xhv_eiter
10207 ? he_dup(saux->xhv_eiter,
10208 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10209 daux->xhv_backreferences =
10210 saux->xhv_backreferences
10211 ? (AV*) SvREFCNT_inc(
10212 sv_dup((SV*)saux->xhv_backreferences, param))
10215 daux->xhv_mro_meta = saux->xhv_mro_meta
10216 ? mro_meta_dup(saux->xhv_mro_meta, param)
10219 /* Record stashes for possible cloning in Perl_clone(). */
10221 av_push(param->stashes, dstr);
10225 HvARRAY((HV*)dstr) = NULL;
10228 if (!(param->flags & CLONEf_COPY_STACKS)) {
10232 /* NOTE: not refcounted */
10233 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10235 if (!CvISXSUB(dstr))
10236 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10238 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10239 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10240 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10241 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10243 /* don't dup if copying back - CvGV isn't refcounted, so the
10244 * duped GV may never be freed. A bit of a hack! DAPM */
10245 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10246 NULL : gv_dup(CvGV(dstr), param) ;
10247 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10249 CvWEAKOUTSIDE(sstr)
10250 ? cv_dup( CvOUTSIDE(dstr), param)
10251 : cv_dup_inc(CvOUTSIDE(dstr), param);
10252 if (!CvISXSUB(dstr))
10253 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10259 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10265 /* duplicate a context */
10268 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10270 PERL_CONTEXT *ncxs;
10273 return (PERL_CONTEXT*)NULL;
10275 /* look for it in the table first */
10276 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10280 /* create anew and remember what it is */
10281 Newxz(ncxs, max + 1, PERL_CONTEXT);
10282 ptr_table_store(PL_ptr_table, cxs, ncxs);
10285 PERL_CONTEXT * const cx = &cxs[ix];
10286 PERL_CONTEXT * const ncx = &ncxs[ix];
10287 ncx->cx_type = cx->cx_type;
10288 if (CxTYPE(cx) == CXt_SUBST) {
10289 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10292 ncx->blk_oldsp = cx->blk_oldsp;
10293 ncx->blk_oldcop = cx->blk_oldcop;
10294 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10295 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10296 ncx->blk_oldpm = cx->blk_oldpm;
10297 ncx->blk_gimme = cx->blk_gimme;
10298 switch (CxTYPE(cx)) {
10300 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10301 ? cv_dup_inc(cx->blk_sub.cv, param)
10302 : cv_dup(cx->blk_sub.cv,param));
10303 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10304 ? av_dup_inc(cx->blk_sub.argarray, param)
10306 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10307 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10308 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10309 ncx->blk_sub.lval = cx->blk_sub.lval;
10310 ncx->blk_sub.retop = cx->blk_sub.retop;
10311 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10312 cx->blk_sub.oldcomppad);
10315 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10316 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10317 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10318 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10319 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10320 ncx->blk_eval.retop = cx->blk_eval.retop;
10323 ncx->blk_loop.label = cx->blk_loop.label;
10324 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10325 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10326 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10327 ? cx->blk_loop.iterdata
10328 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10329 ncx->blk_loop.oldcomppad
10330 = (PAD*)ptr_table_fetch(PL_ptr_table,
10331 cx->blk_loop.oldcomppad);
10332 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10333 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10334 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10335 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10336 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10339 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10340 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10341 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10342 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10343 ncx->blk_sub.retop = cx->blk_sub.retop;
10355 /* duplicate a stack info structure */
10358 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10363 return (PERL_SI*)NULL;
10365 /* look for it in the table first */
10366 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10370 /* create anew and remember what it is */
10371 Newxz(nsi, 1, PERL_SI);
10372 ptr_table_store(PL_ptr_table, si, nsi);
10374 nsi->si_stack = av_dup_inc(si->si_stack, param);
10375 nsi->si_cxix = si->si_cxix;
10376 nsi->si_cxmax = si->si_cxmax;
10377 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10378 nsi->si_type = si->si_type;
10379 nsi->si_prev = si_dup(si->si_prev, param);
10380 nsi->si_next = si_dup(si->si_next, param);
10381 nsi->si_markoff = si->si_markoff;
10386 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10387 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10388 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10389 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10390 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10391 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10392 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10393 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10394 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10395 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10396 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10397 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10398 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10399 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10402 #define pv_dup_inc(p) SAVEPV(p)
10403 #define pv_dup(p) SAVEPV(p)
10404 #define svp_dup_inc(p,pp) any_dup(p,pp)
10406 /* map any object to the new equivent - either something in the
10407 * ptr table, or something in the interpreter structure
10411 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10416 return (void*)NULL;
10418 /* look for it in the table first */
10419 ret = ptr_table_fetch(PL_ptr_table, v);
10423 /* see if it is part of the interpreter structure */
10424 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10425 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10433 /* duplicate the save stack */
10436 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10439 ANY * const ss = proto_perl->Tsavestack;
10440 const I32 max = proto_perl->Tsavestack_max;
10441 I32 ix = proto_perl->Tsavestack_ix;
10454 void (*dptr) (void*);
10455 void (*dxptr) (pTHX_ void*);
10457 Newxz(nss, max, ANY);
10460 const I32 type = POPINT(ss,ix);
10461 TOPINT(nss,ix) = type;
10463 case SAVEt_HELEM: /* hash element */
10464 sv = (SV*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10467 case SAVEt_ITEM: /* normal string */
10468 case SAVEt_SV: /* scalar reference */
10469 sv = (SV*)POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10473 case SAVEt_MORTALIZESV:
10474 sv = (SV*)POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10477 case SAVEt_SHARED_PVREF: /* char* in shared space */
10478 c = (char*)POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = savesharedpv(c);
10480 ptr = POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10483 case SAVEt_GENERIC_SVREF: /* generic sv */
10484 case SAVEt_SVREF: /* scalar reference */
10485 sv = (SV*)POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10487 ptr = POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10490 case SAVEt_HV: /* hash reference */
10491 case SAVEt_AV: /* array reference */
10492 sv = (SV*) POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10495 case SAVEt_COMPPAD:
10497 sv = (SV*) POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = sv_dup(sv, param);
10500 case SAVEt_INT: /* int reference */
10501 ptr = POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10503 intval = (int)POPINT(ss,ix);
10504 TOPINT(nss,ix) = intval;
10506 case SAVEt_LONG: /* long reference */
10507 ptr = POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10510 case SAVEt_CLEARSV:
10511 longval = (long)POPLONG(ss,ix);
10512 TOPLONG(nss,ix) = longval;
10514 case SAVEt_I32: /* I32 reference */
10515 case SAVEt_I16: /* I16 reference */
10516 case SAVEt_I8: /* I8 reference */
10517 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10518 ptr = POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10521 TOPINT(nss,ix) = i;
10523 case SAVEt_IV: /* IV reference */
10524 ptr = POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10527 TOPIV(nss,ix) = iv;
10529 case SAVEt_HPTR: /* HV* reference */
10530 case SAVEt_APTR: /* AV* reference */
10531 case SAVEt_SPTR: /* SV* reference */
10532 ptr = POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10534 sv = (SV*)POPPTR(ss,ix);
10535 TOPPTR(nss,ix) = sv_dup(sv, param);
10537 case SAVEt_VPTR: /* random* reference */
10538 ptr = POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10540 ptr = POPPTR(ss,ix);
10541 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10543 case SAVEt_GENERIC_PVREF: /* generic char* */
10544 case SAVEt_PPTR: /* char* reference */
10545 ptr = POPPTR(ss,ix);
10546 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10547 c = (char*)POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = pv_dup(c);
10550 case SAVEt_GP: /* scalar reference */
10551 gp = (GP*)POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10553 (void)GpREFCNT_inc(gp);
10554 gv = (GV*)POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10558 ptr = POPPTR(ss,ix);
10559 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10560 /* these are assumed to be refcounted properly */
10562 switch (((OP*)ptr)->op_type) {
10564 case OP_LEAVESUBLV:
10568 case OP_LEAVEWRITE:
10569 TOPPTR(nss,ix) = ptr;
10572 (void) OpREFCNT_inc(o);
10576 TOPPTR(nss,ix) = NULL;
10581 TOPPTR(nss,ix) = NULL;
10584 c = (char*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = pv_dup_inc(c);
10588 hv = (HV*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10590 c = (char*)POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = pv_dup_inc(c);
10593 case SAVEt_STACK_POS: /* Position on Perl stack */
10595 TOPINT(nss,ix) = i;
10597 case SAVEt_DESTRUCTOR:
10598 ptr = POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10600 dptr = POPDPTR(ss,ix);
10601 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10602 any_dup(FPTR2DPTR(void *, dptr),
10605 case SAVEt_DESTRUCTOR_X:
10606 ptr = POPPTR(ss,ix);
10607 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10608 dxptr = POPDXPTR(ss,ix);
10609 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10610 any_dup(FPTR2DPTR(void *, dxptr),
10613 case SAVEt_REGCONTEXT:
10616 TOPINT(nss,ix) = i;
10619 case SAVEt_AELEM: /* array element */
10620 sv = (SV*)POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10623 TOPINT(nss,ix) = i;
10624 av = (AV*)POPPTR(ss,ix);
10625 TOPPTR(nss,ix) = av_dup_inc(av, param);
10628 ptr = POPPTR(ss,ix);
10629 TOPPTR(nss,ix) = ptr;
10633 TOPINT(nss,ix) = i;
10634 ptr = POPPTR(ss,ix);
10637 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10638 HINTS_REFCNT_UNLOCK;
10640 TOPPTR(nss,ix) = ptr;
10641 if (i & HINT_LOCALIZE_HH) {
10642 hv = (HV*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10647 longval = (long)POPLONG(ss,ix);
10648 TOPLONG(nss,ix) = longval;
10649 ptr = POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10651 sv = (SV*)POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = sv_dup(sv, param);
10655 ptr = POPPTR(ss,ix);
10656 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10657 longval = (long)POPBOOL(ss,ix);
10658 TOPBOOL(nss,ix) = (bool)longval;
10660 case SAVEt_SET_SVFLAGS:
10662 TOPINT(nss,ix) = i;
10664 TOPINT(nss,ix) = i;
10665 sv = (SV*)POPPTR(ss,ix);
10666 TOPPTR(nss,ix) = sv_dup(sv, param);
10668 case SAVEt_RE_STATE:
10670 const struct re_save_state *const old_state
10671 = (struct re_save_state *)
10672 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10673 struct re_save_state *const new_state
10674 = (struct re_save_state *)
10675 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10677 Copy(old_state, new_state, 1, struct re_save_state);
10678 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10680 new_state->re_state_bostr
10681 = pv_dup(old_state->re_state_bostr);
10682 new_state->re_state_reginput
10683 = pv_dup(old_state->re_state_reginput);
10684 new_state->re_state_regeol
10685 = pv_dup(old_state->re_state_regeol);
10686 new_state->re_state_regoffs
10687 = (regexp_paren_pair*)
10688 any_dup(old_state->re_state_regoffs, proto_perl);
10689 new_state->re_state_reglastparen
10690 = (U32*) any_dup(old_state->re_state_reglastparen,
10692 new_state->re_state_reglastcloseparen
10693 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10695 /* XXX This just has to be broken. The old save_re_context
10696 code did SAVEGENERICPV(PL_reg_start_tmp);
10697 PL_reg_start_tmp is char **.
10698 Look above to what the dup code does for
10699 SAVEt_GENERIC_PVREF
10700 It can never have worked.
10701 So this is merely a faithful copy of the exiting bug: */
10702 new_state->re_state_reg_start_tmp
10703 = (char **) pv_dup((char *)
10704 old_state->re_state_reg_start_tmp);
10705 /* I assume that it only ever "worked" because no-one called
10706 (pseudo)fork while the regexp engine had re-entered itself.
10708 #ifdef PERL_OLD_COPY_ON_WRITE
10709 new_state->re_state_nrs
10710 = sv_dup(old_state->re_state_nrs, param);
10712 new_state->re_state_reg_magic
10713 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10715 new_state->re_state_reg_oldcurpm
10716 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10718 new_state->re_state_reg_curpm
10719 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10721 new_state->re_state_reg_oldsaved
10722 = pv_dup(old_state->re_state_reg_oldsaved);
10723 new_state->re_state_reg_poscache
10724 = pv_dup(old_state->re_state_reg_poscache);
10725 new_state->re_state_reg_starttry
10726 = pv_dup(old_state->re_state_reg_starttry);
10729 case SAVEt_COMPILE_WARNINGS:
10730 ptr = POPPTR(ss,ix);
10731 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10734 ptr = POPPTR(ss,ix);
10735 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10739 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10747 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10748 * flag to the result. This is done for each stash before cloning starts,
10749 * so we know which stashes want their objects cloned */
10752 do_mark_cloneable_stash(pTHX_ SV *sv)
10754 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10756 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10757 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10758 if (cloner && GvCV(cloner)) {
10765 XPUSHs(sv_2mortal(newSVhek(hvname)));
10767 call_sv((SV*)GvCV(cloner), G_SCALAR);
10774 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10782 =for apidoc perl_clone
10784 Create and return a new interpreter by cloning the current one.
10786 perl_clone takes these flags as parameters:
10788 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10789 without it we only clone the data and zero the stacks,
10790 with it we copy the stacks and the new perl interpreter is
10791 ready to run at the exact same point as the previous one.
10792 The pseudo-fork code uses COPY_STACKS while the
10793 threads->create doesn't.
10795 CLONEf_KEEP_PTR_TABLE
10796 perl_clone keeps a ptr_table with the pointer of the old
10797 variable as a key and the new variable as a value,
10798 this allows it to check if something has been cloned and not
10799 clone it again but rather just use the value and increase the
10800 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10801 the ptr_table using the function
10802 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10803 reason to keep it around is if you want to dup some of your own
10804 variable who are outside the graph perl scans, example of this
10805 code is in threads.xs create
10808 This is a win32 thing, it is ignored on unix, it tells perls
10809 win32host code (which is c++) to clone itself, this is needed on
10810 win32 if you want to run two threads at the same time,
10811 if you just want to do some stuff in a separate perl interpreter
10812 and then throw it away and return to the original one,
10813 you don't need to do anything.
10818 /* XXX the above needs expanding by someone who actually understands it ! */
10819 EXTERN_C PerlInterpreter *
10820 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10823 perl_clone(PerlInterpreter *proto_perl, UV flags)
10826 #ifdef PERL_IMPLICIT_SYS
10828 /* perlhost.h so we need to call into it
10829 to clone the host, CPerlHost should have a c interface, sky */
10831 if (flags & CLONEf_CLONE_HOST) {
10832 return perl_clone_host(proto_perl,flags);
10834 return perl_clone_using(proto_perl, flags,
10836 proto_perl->IMemShared,
10837 proto_perl->IMemParse,
10839 proto_perl->IStdIO,
10843 proto_perl->IProc);
10847 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10848 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10849 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10850 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10851 struct IPerlDir* ipD, struct IPerlSock* ipS,
10852 struct IPerlProc* ipP)
10854 /* XXX many of the string copies here can be optimized if they're
10855 * constants; they need to be allocated as common memory and just
10856 * their pointers copied. */
10859 CLONE_PARAMS clone_params;
10860 CLONE_PARAMS* const param = &clone_params;
10862 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10863 /* for each stash, determine whether its objects should be cloned */
10864 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10865 PERL_SET_THX(my_perl);
10868 PoisonNew(my_perl, 1, PerlInterpreter);
10874 PL_savestack_ix = 0;
10875 PL_savestack_max = -1;
10876 PL_sig_pending = 0;
10877 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10878 # else /* !DEBUGGING */
10879 Zero(my_perl, 1, PerlInterpreter);
10880 # endif /* DEBUGGING */
10882 /* host pointers */
10884 PL_MemShared = ipMS;
10885 PL_MemParse = ipMP;
10892 #else /* !PERL_IMPLICIT_SYS */
10894 CLONE_PARAMS clone_params;
10895 CLONE_PARAMS* param = &clone_params;
10896 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10897 /* for each stash, determine whether its objects should be cloned */
10898 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10899 PERL_SET_THX(my_perl);
10902 PoisonNew(my_perl, 1, PerlInterpreter);
10908 PL_savestack_ix = 0;
10909 PL_savestack_max = -1;
10910 PL_sig_pending = 0;
10911 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10912 # else /* !DEBUGGING */
10913 Zero(my_perl, 1, PerlInterpreter);
10914 # endif /* DEBUGGING */
10915 #endif /* PERL_IMPLICIT_SYS */
10916 param->flags = flags;
10917 param->proto_perl = proto_perl;
10919 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10921 PL_body_arenas = NULL;
10922 Zero(&PL_body_roots, 1, PL_body_roots);
10924 PL_nice_chunk = NULL;
10925 PL_nice_chunk_size = 0;
10927 PL_sv_objcount = 0;
10929 PL_sv_arenaroot = NULL;
10931 PL_debug = proto_perl->Idebug;
10933 PL_hash_seed = proto_perl->Ihash_seed;
10934 PL_rehash_seed = proto_perl->Irehash_seed;
10936 #ifdef USE_REENTRANT_API
10937 /* XXX: things like -Dm will segfault here in perlio, but doing
10938 * PERL_SET_CONTEXT(proto_perl);
10939 * breaks too many other things
10941 Perl_reentrant_init(aTHX);
10944 /* create SV map for pointer relocation */
10945 PL_ptr_table = ptr_table_new();
10947 /* initialize these special pointers as early as possible */
10948 SvANY(&PL_sv_undef) = NULL;
10949 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10950 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10951 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10953 SvANY(&PL_sv_no) = new_XPVNV();
10954 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10955 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10956 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10957 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10958 SvCUR_set(&PL_sv_no, 0);
10959 SvLEN_set(&PL_sv_no, 1);
10960 SvIV_set(&PL_sv_no, 0);
10961 SvNV_set(&PL_sv_no, 0);
10962 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10964 SvANY(&PL_sv_yes) = new_XPVNV();
10965 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10966 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10967 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10968 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10969 SvCUR_set(&PL_sv_yes, 1);
10970 SvLEN_set(&PL_sv_yes, 2);
10971 SvIV_set(&PL_sv_yes, 1);
10972 SvNV_set(&PL_sv_yes, 1);
10973 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10975 /* create (a non-shared!) shared string table */
10976 PL_strtab = newHV();
10977 HvSHAREKEYS_off(PL_strtab);
10978 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10979 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10981 PL_compiling = proto_perl->Icompiling;
10983 /* These two PVs will be free'd special way so must set them same way op.c does */
10984 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10985 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10987 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10988 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10990 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10991 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10992 if (PL_compiling.cop_hints_hash) {
10994 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10995 HINTS_REFCNT_UNLOCK;
10997 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10998 #ifdef PERL_DEBUG_READONLY_OPS
11003 /* pseudo environmental stuff */
11004 PL_origargc = proto_perl->Iorigargc;
11005 PL_origargv = proto_perl->Iorigargv;
11007 param->stashes = newAV(); /* Setup array of objects to call clone on */
11009 /* Set tainting stuff before PerlIO_debug can possibly get called */
11010 PL_tainting = proto_perl->Itainting;
11011 PL_taint_warn = proto_perl->Itaint_warn;
11013 #ifdef PERLIO_LAYERS
11014 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11015 PerlIO_clone(aTHX_ proto_perl, param);
11018 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11019 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11020 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11021 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11022 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11023 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11026 PL_minus_c = proto_perl->Iminus_c;
11027 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11028 PL_localpatches = proto_perl->Ilocalpatches;
11029 PL_splitstr = proto_perl->Isplitstr;
11030 PL_preprocess = proto_perl->Ipreprocess;
11031 PL_minus_n = proto_perl->Iminus_n;
11032 PL_minus_p = proto_perl->Iminus_p;
11033 PL_minus_l = proto_perl->Iminus_l;
11034 PL_minus_a = proto_perl->Iminus_a;
11035 PL_minus_E = proto_perl->Iminus_E;
11036 PL_minus_F = proto_perl->Iminus_F;
11037 PL_doswitches = proto_perl->Idoswitches;
11038 PL_dowarn = proto_perl->Idowarn;
11039 PL_doextract = proto_perl->Idoextract;
11040 PL_sawampersand = proto_perl->Isawampersand;
11041 PL_unsafe = proto_perl->Iunsafe;
11042 PL_inplace = SAVEPV(proto_perl->Iinplace);
11043 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11044 PL_perldb = proto_perl->Iperldb;
11045 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11046 PL_exit_flags = proto_perl->Iexit_flags;
11048 /* magical thingies */
11049 /* XXX time(&PL_basetime) when asked for? */
11050 PL_basetime = proto_perl->Ibasetime;
11051 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11053 PL_maxsysfd = proto_perl->Imaxsysfd;
11054 PL_statusvalue = proto_perl->Istatusvalue;
11056 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11058 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11060 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11062 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11063 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11064 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11067 /* RE engine related */
11068 Zero(&PL_reg_state, 1, struct re_save_state);
11069 PL_reginterp_cnt = 0;
11070 PL_regmatch_slab = NULL;
11072 /* Clone the regex array */
11073 PL_regex_padav = newAV();
11075 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11076 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11078 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11079 for(i = 1; i <= len; i++) {
11080 const SV * const regex = regexen[i];
11083 ? sv_dup_inc(regex, param)
11085 newSViv(PTR2IV(CALLREGDUPE(
11086 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11088 if (SvFLAGS(regex) & SVf_BREAK)
11089 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11090 av_push(PL_regex_padav, sv);
11093 PL_regex_pad = AvARRAY(PL_regex_padav);
11095 /* shortcuts to various I/O objects */
11096 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11097 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11098 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11099 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11100 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11101 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11103 /* shortcuts to regexp stuff */
11104 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11106 /* shortcuts to misc objects */
11107 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11109 /* shortcuts to debugging objects */
11110 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11111 PL_DBline = gv_dup(proto_perl->IDBline, param);
11112 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11113 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11114 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11115 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11116 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11117 PL_lineary = av_dup(proto_perl->Ilineary, param);
11118 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11120 /* symbol tables */
11121 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11122 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11123 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11124 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11125 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11127 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11128 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11129 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11130 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11131 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11132 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11133 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11134 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11136 PL_sub_generation = proto_perl->Isub_generation;
11137 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11138 PL_delayedisa = hv_dup_inc(proto_perl->Tdelayedisa, param);
11140 /* funky return mechanisms */
11141 PL_forkprocess = proto_perl->Iforkprocess;
11143 /* subprocess state */
11144 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11146 /* internal state */
11147 PL_maxo = proto_perl->Imaxo;
11148 if (proto_perl->Iop_mask)
11149 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11152 /* PL_asserting = proto_perl->Iasserting; */
11154 /* current interpreter roots */
11155 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11157 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11159 PL_main_start = proto_perl->Imain_start;
11160 PL_eval_root = proto_perl->Ieval_root;
11161 PL_eval_start = proto_perl->Ieval_start;
11163 /* runtime control stuff */
11164 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11166 PL_filemode = proto_perl->Ifilemode;
11167 PL_lastfd = proto_perl->Ilastfd;
11168 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11171 PL_gensym = proto_perl->Igensym;
11172 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11173 PL_laststatval = proto_perl->Ilaststatval;
11174 PL_laststype = proto_perl->Ilaststype;
11177 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11179 /* interpreter atexit processing */
11180 PL_exitlistlen = proto_perl->Iexitlistlen;
11181 if (PL_exitlistlen) {
11182 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11183 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11186 PL_exitlist = (PerlExitListEntry*)NULL;
11188 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11189 if (PL_my_cxt_size) {
11190 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11191 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11192 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11193 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11194 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11198 PL_my_cxt_list = (void**)NULL;
11199 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11200 PL_my_cxt_keys = (const char**)NULL;
11203 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11204 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11205 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11207 PL_profiledata = NULL;
11208 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11209 /* PL_rsfp_filters entries have fake IoDIRP() */
11210 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11212 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11214 PAD_CLONE_VARS(proto_perl, param);
11216 #ifdef HAVE_INTERP_INTERN
11217 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11220 /* more statics moved here */
11221 PL_generation = proto_perl->Igeneration;
11222 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11224 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11225 PL_in_clean_all = proto_perl->Iin_clean_all;
11227 PL_uid = proto_perl->Iuid;
11228 PL_euid = proto_perl->Ieuid;
11229 PL_gid = proto_perl->Igid;
11230 PL_egid = proto_perl->Iegid;
11231 PL_nomemok = proto_perl->Inomemok;
11232 PL_an = proto_perl->Ian;
11233 PL_evalseq = proto_perl->Ievalseq;
11234 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11235 PL_origalen = proto_perl->Iorigalen;
11236 #ifdef PERL_USES_PL_PIDSTATUS
11237 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11239 PL_osname = SAVEPV(proto_perl->Iosname);
11240 PL_sighandlerp = proto_perl->Isighandlerp;
11242 PL_runops = proto_perl->Irunops;
11244 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11247 PL_cshlen = proto_perl->Icshlen;
11248 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11251 PL_parser = parser_dup(proto_perl->Iparser, param);
11253 PL_lex_state = proto_perl->Ilex_state;
11256 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11257 PL_curforce = proto_perl->Icurforce;
11259 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11260 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11261 PL_nexttoke = proto_perl->Inexttoke;
11264 PL_multi_end = proto_perl->Imulti_end;
11266 PL_error_count = proto_perl->Ierror_count;
11267 PL_subline = proto_perl->Isubline;
11268 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11270 PL_in_my = proto_perl->Iin_my;
11271 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11273 PL_cryptseen = proto_perl->Icryptseen;
11276 PL_hints = proto_perl->Ihints;
11278 PL_amagic_generation = proto_perl->Iamagic_generation;
11280 #ifdef USE_LOCALE_COLLATE
11281 PL_collation_ix = proto_perl->Icollation_ix;
11282 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11283 PL_collation_standard = proto_perl->Icollation_standard;
11284 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11285 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11286 #endif /* USE_LOCALE_COLLATE */
11288 #ifdef USE_LOCALE_NUMERIC
11289 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11290 PL_numeric_standard = proto_perl->Inumeric_standard;
11291 PL_numeric_local = proto_perl->Inumeric_local;
11292 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11293 #endif /* !USE_LOCALE_NUMERIC */
11295 /* utf8 character classes */
11296 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11297 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11298 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11299 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11300 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11301 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11302 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11303 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11304 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11305 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11306 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11307 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11308 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11309 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11310 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11311 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11312 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11313 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11314 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11315 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11317 /* Did the locale setup indicate UTF-8? */
11318 PL_utf8locale = proto_perl->Iutf8locale;
11319 /* Unicode features (see perlrun/-C) */
11320 PL_unicode = proto_perl->Iunicode;
11322 /* Pre-5.8 signals control */
11323 PL_signals = proto_perl->Isignals;
11325 /* times() ticks per second */
11326 PL_clocktick = proto_perl->Iclocktick;
11328 /* Recursion stopper for PerlIO_find_layer */
11329 PL_in_load_module = proto_perl->Iin_load_module;
11331 /* sort() routine */
11332 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11334 /* Not really needed/useful since the reenrant_retint is "volatile",
11335 * but do it for consistency's sake. */
11336 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11338 /* Hooks to shared SVs and locks. */
11339 PL_sharehook = proto_perl->Isharehook;
11340 PL_lockhook = proto_perl->Ilockhook;
11341 PL_unlockhook = proto_perl->Iunlockhook;
11342 PL_threadhook = proto_perl->Ithreadhook;
11344 PL_runops_std = proto_perl->Irunops_std;
11345 PL_runops_dbg = proto_perl->Irunops_dbg;
11347 #ifdef THREADS_HAVE_PIDS
11348 PL_ppid = proto_perl->Ippid;
11352 PL_last_swash_hv = NULL; /* reinits on demand */
11353 PL_last_swash_klen = 0;
11354 PL_last_swash_key[0]= '\0';
11355 PL_last_swash_tmps = (U8*)NULL;
11356 PL_last_swash_slen = 0;
11358 PL_glob_index = proto_perl->Iglob_index;
11359 PL_srand_called = proto_perl->Isrand_called;
11360 PL_bitcount = NULL; /* reinits on demand */
11362 if (proto_perl->Ipsig_pend) {
11363 Newxz(PL_psig_pend, SIG_SIZE, int);
11366 PL_psig_pend = (int*)NULL;
11369 if (proto_perl->Ipsig_ptr) {
11370 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11371 Newxz(PL_psig_name, SIG_SIZE, SV*);
11372 for (i = 1; i < SIG_SIZE; i++) {
11373 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11374 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11378 PL_psig_ptr = (SV**)NULL;
11379 PL_psig_name = (SV**)NULL;
11382 /* thrdvar.h stuff */
11384 if (flags & CLONEf_COPY_STACKS) {
11385 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11386 PL_tmps_ix = proto_perl->Ttmps_ix;
11387 PL_tmps_max = proto_perl->Ttmps_max;
11388 PL_tmps_floor = proto_perl->Ttmps_floor;
11389 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11391 while (i <= PL_tmps_ix) {
11392 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11396 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11397 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11398 Newxz(PL_markstack, i, I32);
11399 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11400 - proto_perl->Tmarkstack);
11401 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11402 - proto_perl->Tmarkstack);
11403 Copy(proto_perl->Tmarkstack, PL_markstack,
11404 PL_markstack_ptr - PL_markstack + 1, I32);
11406 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11407 * NOTE: unlike the others! */
11408 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11409 PL_scopestack_max = proto_perl->Tscopestack_max;
11410 Newxz(PL_scopestack, PL_scopestack_max, I32);
11411 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11413 /* NOTE: si_dup() looks at PL_markstack */
11414 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11416 /* PL_curstack = PL_curstackinfo->si_stack; */
11417 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11418 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11420 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11421 PL_stack_base = AvARRAY(PL_curstack);
11422 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11423 - proto_perl->Tstack_base);
11424 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11426 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11427 * NOTE: unlike the others! */
11428 PL_savestack_ix = proto_perl->Tsavestack_ix;
11429 PL_savestack_max = proto_perl->Tsavestack_max;
11430 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11431 PL_savestack = ss_dup(proto_perl, param);
11435 ENTER; /* perl_destruct() wants to LEAVE; */
11437 /* although we're not duplicating the tmps stack, we should still
11438 * add entries for any SVs on the tmps stack that got cloned by a
11439 * non-refcount means (eg a temp in @_); otherwise they will be
11442 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11443 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11444 proto_perl->Ttmps_stack[i]);
11445 if (nsv && !SvREFCNT(nsv)) {
11447 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11452 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11453 PL_top_env = &PL_start_env;
11455 PL_op = proto_perl->Top;
11458 PL_Xpv = (XPV*)NULL;
11459 PL_na = proto_perl->Tna;
11461 PL_statbuf = proto_perl->Tstatbuf;
11462 PL_statcache = proto_perl->Tstatcache;
11463 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11464 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11466 PL_timesbuf = proto_perl->Ttimesbuf;
11469 PL_tainted = proto_perl->Ttainted;
11470 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11471 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11472 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11473 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11474 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11475 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11476 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11477 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11478 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11480 PL_restartop = proto_perl->Trestartop;
11481 PL_in_eval = proto_perl->Tin_eval;
11482 PL_delaymagic = proto_perl->Tdelaymagic;
11483 PL_dirty = proto_perl->Tdirty;
11484 PL_localizing = proto_perl->Tlocalizing;
11486 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11487 PL_hv_fetch_ent_mh = NULL;
11488 PL_modcount = proto_perl->Tmodcount;
11489 PL_lastgotoprobe = NULL;
11490 PL_dumpindent = proto_perl->Tdumpindent;
11492 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11493 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11494 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11495 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11496 PL_efloatbuf = NULL; /* reinits on demand */
11497 PL_efloatsize = 0; /* reinits on demand */
11501 PL_screamfirst = NULL;
11502 PL_screamnext = NULL;
11503 PL_maxscream = -1; /* reinits on demand */
11504 PL_lastscream = NULL;
11507 PL_regdummy = proto_perl->Tregdummy;
11508 PL_colorset = 0; /* reinits PL_colors[] */
11509 /*PL_colors[6] = {0,0,0,0,0,0};*/
11513 /* Pluggable optimizer */
11514 PL_peepp = proto_perl->Tpeepp;
11516 PL_stashcache = newHV();
11518 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11519 proto_perl->Twatchaddr);
11520 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11521 if (PL_debug && PL_watchaddr) {
11522 PerlIO_printf(Perl_debug_log,
11523 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11524 PTR2UV(proto_perl->Twatchaddr), PTR2UV(PL_watchaddr),
11525 PTR2UV(PL_watchok));
11528 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11529 ptr_table_free(PL_ptr_table);
11530 PL_ptr_table = NULL;
11533 /* Call the ->CLONE method, if it exists, for each of the stashes
11534 identified by sv_dup() above.
11536 while(av_len(param->stashes) != -1) {
11537 HV* const stash = (HV*) av_shift(param->stashes);
11538 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11539 if (cloner && GvCV(cloner)) {
11544 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11546 call_sv((SV*)GvCV(cloner), G_DISCARD);
11552 SvREFCNT_dec(param->stashes);
11554 /* orphaned? eg threads->new inside BEGIN or use */
11555 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11556 SvREFCNT_inc_simple_void(PL_compcv);
11557 SAVEFREESV(PL_compcv);
11563 #endif /* USE_ITHREADS */
11566 =head1 Unicode Support
11568 =for apidoc sv_recode_to_utf8
11570 The encoding is assumed to be an Encode object, on entry the PV
11571 of the sv is assumed to be octets in that encoding, and the sv
11572 will be converted into Unicode (and UTF-8).
11574 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11575 is not a reference, nothing is done to the sv. If the encoding is not
11576 an C<Encode::XS> Encoding object, bad things will happen.
11577 (See F<lib/encoding.pm> and L<Encode>).
11579 The PV of the sv is returned.
11584 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11587 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11601 Passing sv_yes is wrong - it needs to be or'ed set of constants
11602 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11603 remove converted chars from source.
11605 Both will default the value - let them.
11607 XPUSHs(&PL_sv_yes);
11610 call_method("decode", G_SCALAR);
11614 s = SvPV_const(uni, len);
11615 if (s != SvPVX_const(sv)) {
11616 SvGROW(sv, len + 1);
11617 Move(s, SvPVX(sv), len + 1, char);
11618 SvCUR_set(sv, len);
11625 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11629 =for apidoc sv_cat_decode
11631 The encoding is assumed to be an Encode object, the PV of the ssv is
11632 assumed to be octets in that encoding and decoding the input starts
11633 from the position which (PV + *offset) pointed to. The dsv will be
11634 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11635 when the string tstr appears in decoding output or the input ends on
11636 the PV of the ssv. The value which the offset points will be modified
11637 to the last input position on the ssv.
11639 Returns TRUE if the terminator was found, else returns FALSE.
11644 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11645 SV *ssv, int *offset, char *tstr, int tlen)
11649 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11660 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11661 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11663 call_method("cat_decode", G_SCALAR);
11665 ret = SvTRUE(TOPs);
11666 *offset = SvIV(offsv);
11672 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11677 /* ---------------------------------------------------------------------
11679 * support functions for report_uninit()
11682 /* the maxiumum size of array or hash where we will scan looking
11683 * for the undefined element that triggered the warning */
11685 #define FUV_MAX_SEARCH_SIZE 1000
11687 /* Look for an entry in the hash whose value has the same SV as val;
11688 * If so, return a mortal copy of the key. */
11691 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11694 register HE **array;
11697 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11698 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11701 array = HvARRAY(hv);
11703 for (i=HvMAX(hv); i>0; i--) {
11704 register HE *entry;
11705 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11706 if (HeVAL(entry) != val)
11708 if ( HeVAL(entry) == &PL_sv_undef ||
11709 HeVAL(entry) == &PL_sv_placeholder)
11713 if (HeKLEN(entry) == HEf_SVKEY)
11714 return sv_mortalcopy(HeKEY_sv(entry));
11715 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11721 /* Look for an entry in the array whose value has the same SV as val;
11722 * If so, return the index, otherwise return -1. */
11725 S_find_array_subscript(pTHX_ AV *av, SV* val)
11728 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11729 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11732 if (val != &PL_sv_undef) {
11733 SV ** const svp = AvARRAY(av);
11736 for (i=AvFILLp(av); i>=0; i--)
11743 /* S_varname(): return the name of a variable, optionally with a subscript.
11744 * If gv is non-zero, use the name of that global, along with gvtype (one
11745 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11746 * targ. Depending on the value of the subscript_type flag, return:
11749 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11750 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11751 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11752 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11755 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11756 SV* keyname, I32 aindex, int subscript_type)
11759 SV * const name = sv_newmortal();
11762 buffer[0] = gvtype;
11765 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11767 gv_fullname4(name, gv, buffer, 0);
11769 if ((unsigned int)SvPVX(name)[1] <= 26) {
11771 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11773 /* Swap the 1 unprintable control character for the 2 byte pretty
11774 version - ie substr($name, 1, 1) = $buffer; */
11775 sv_insert(name, 1, 1, buffer, 2);
11780 CV * const cv = find_runcv(&unused);
11784 if (!cv || !CvPADLIST(cv))
11786 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11787 sv = *av_fetch(av, targ, FALSE);
11788 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11791 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11792 SV * const sv = newSV(0);
11793 *SvPVX(name) = '$';
11794 Perl_sv_catpvf(aTHX_ name, "{%s}",
11795 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11798 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11799 *SvPVX(name) = '$';
11800 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11802 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11803 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11810 =for apidoc find_uninit_var
11812 Find the name of the undefined variable (if any) that caused the operator o
11813 to issue a "Use of uninitialized value" warning.
11814 If match is true, only return a name if it's value matches uninit_sv.
11815 So roughly speaking, if a unary operator (such as OP_COS) generates a
11816 warning, then following the direct child of the op may yield an
11817 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11818 other hand, with OP_ADD there are two branches to follow, so we only print
11819 the variable name if we get an exact match.
11821 The name is returned as a mortal SV.
11823 Assumes that PL_op is the op that originally triggered the error, and that
11824 PL_comppad/PL_curpad points to the currently executing pad.
11830 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11838 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11839 uninit_sv == &PL_sv_placeholder)))
11842 switch (obase->op_type) {
11849 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11850 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11853 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11855 if (pad) { /* @lex, %lex */
11856 sv = PAD_SVl(obase->op_targ);
11860 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11861 /* @global, %global */
11862 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11865 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11867 else /* @{expr}, %{expr} */
11868 return find_uninit_var(cUNOPx(obase)->op_first,
11872 /* attempt to find a match within the aggregate */
11874 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11876 subscript_type = FUV_SUBSCRIPT_HASH;
11879 index = find_array_subscript((AV*)sv, uninit_sv);
11881 subscript_type = FUV_SUBSCRIPT_ARRAY;
11884 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11887 return varname(gv, hash ? '%' : '@', obase->op_targ,
11888 keysv, index, subscript_type);
11892 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11894 return varname(NULL, '$', obase->op_targ,
11895 NULL, 0, FUV_SUBSCRIPT_NONE);
11898 gv = cGVOPx_gv(obase);
11899 if (!gv || (match && GvSV(gv) != uninit_sv))
11901 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11904 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11907 av = (AV*)PAD_SV(obase->op_targ);
11908 if (!av || SvRMAGICAL(av))
11910 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11911 if (!svp || *svp != uninit_sv)
11914 return varname(NULL, '$', obase->op_targ,
11915 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11918 gv = cGVOPx_gv(obase);
11924 if (!av || SvRMAGICAL(av))
11926 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11927 if (!svp || *svp != uninit_sv)
11930 return varname(gv, '$', 0,
11931 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11936 o = cUNOPx(obase)->op_first;
11937 if (!o || o->op_type != OP_NULL ||
11938 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11940 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11944 if (PL_op == obase)
11945 /* $a[uninit_expr] or $h{uninit_expr} */
11946 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11949 o = cBINOPx(obase)->op_first;
11950 kid = cBINOPx(obase)->op_last;
11952 /* get the av or hv, and optionally the gv */
11954 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11955 sv = PAD_SV(o->op_targ);
11957 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11958 && cUNOPo->op_first->op_type == OP_GV)
11960 gv = cGVOPx_gv(cUNOPo->op_first);
11963 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11968 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11969 /* index is constant */
11973 if (obase->op_type == OP_HELEM) {
11974 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11975 if (!he || HeVAL(he) != uninit_sv)
11979 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11980 if (!svp || *svp != uninit_sv)
11984 if (obase->op_type == OP_HELEM)
11985 return varname(gv, '%', o->op_targ,
11986 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11988 return varname(gv, '@', o->op_targ, NULL,
11989 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11992 /* index is an expression;
11993 * attempt to find a match within the aggregate */
11994 if (obase->op_type == OP_HELEM) {
11995 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11997 return varname(gv, '%', o->op_targ,
11998 keysv, 0, FUV_SUBSCRIPT_HASH);
12001 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12003 return varname(gv, '@', o->op_targ,
12004 NULL, index, FUV_SUBSCRIPT_ARRAY);
12009 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12011 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12016 /* only examine RHS */
12017 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12020 o = cUNOPx(obase)->op_first;
12021 if (o->op_type == OP_PUSHMARK)
12024 if (!o->op_sibling) {
12025 /* one-arg version of open is highly magical */
12027 if (o->op_type == OP_GV) { /* open FOO; */
12029 if (match && GvSV(gv) != uninit_sv)
12031 return varname(gv, '$', 0,
12032 NULL, 0, FUV_SUBSCRIPT_NONE);
12034 /* other possibilities not handled are:
12035 * open $x; or open my $x; should return '${*$x}'
12036 * open expr; should return '$'.expr ideally
12042 /* ops where $_ may be an implicit arg */
12046 if ( !(obase->op_flags & OPf_STACKED)) {
12047 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12048 ? PAD_SVl(obase->op_targ)
12051 sv = sv_newmortal();
12052 sv_setpvn(sv, "$_", 2);
12061 /* skip filehandle as it can't produce 'undef' warning */
12062 o = cUNOPx(obase)->op_first;
12063 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12064 o = o->op_sibling->op_sibling;
12071 match = 1; /* XS or custom code could trigger random warnings */
12076 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12077 return sv_2mortal(newSVpvs("${$/}"));
12082 if (!(obase->op_flags & OPf_KIDS))
12084 o = cUNOPx(obase)->op_first;
12090 /* if all except one arg are constant, or have no side-effects,
12091 * or are optimized away, then it's unambiguous */
12093 for (kid=o; kid; kid = kid->op_sibling) {
12095 const OPCODE type = kid->op_type;
12096 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12097 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12098 || (type == OP_PUSHMARK)
12102 if (o2) { /* more than one found */
12109 return find_uninit_var(o2, uninit_sv, match);
12111 /* scan all args */
12113 sv = find_uninit_var(o, uninit_sv, 1);
12125 =for apidoc report_uninit
12127 Print appropriate "Use of uninitialized variable" warning
12133 Perl_report_uninit(pTHX_ SV* uninit_sv)
12137 SV* varname = NULL;
12139 varname = find_uninit_var(PL_op, uninit_sv,0);
12141 sv_insert(varname, 0, 0, " ", 1);
12143 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12144 varname ? SvPV_nolen_const(varname) : "",
12145 " in ", OP_DESC(PL_op));
12148 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12154 * c-indentation-style: bsd
12155 * c-basic-offset: 4
12156 * indent-tabs-mode: t
12159 * ex: set ts=8 sts=4 sw=4 noet: