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
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* RVs are in the head now. */
898 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(xpv_allocated),
902 copy_length(XPV, xpv_len)
903 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
905 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
908 { sizeof(xpviv_allocated),
909 copy_length(XPVIV, xiv_u)
910 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
912 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
915 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
916 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
919 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
920 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
923 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
924 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
927 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
930 { sizeof(xpvav_allocated),
931 copy_length(XPVAV, xmg_stash)
932 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
934 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
936 { sizeof(xpvhv_allocated),
937 copy_length(XPVHV, xmg_stash)
938 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
940 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
943 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
944 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
945 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
947 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
948 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
949 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
951 /* XPVIO is 84 bytes, fits 48x */
952 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
953 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
956 #define new_body_type(sv_type) \
957 (void *)((char *)S_new_body(aTHX_ sv_type))
959 #define del_body_type(p, sv_type) \
960 del_body(p, &PL_body_roots[sv_type])
963 #define new_body_allocated(sv_type) \
964 (void *)((char *)S_new_body(aTHX_ sv_type) \
965 - bodies_by_type[sv_type].offset)
967 #define del_body_allocated(p, sv_type) \
968 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
971 #define my_safemalloc(s) (void*)safemalloc(s)
972 #define my_safecalloc(s) (void*)safecalloc(s, 1)
973 #define my_safefree(p) safefree((char*)p)
977 #define new_XNV() my_safemalloc(sizeof(XPVNV))
978 #define del_XNV(p) my_safefree(p)
980 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
981 #define del_XPVNV(p) my_safefree(p)
983 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
984 #define del_XPVAV(p) my_safefree(p)
986 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
987 #define del_XPVHV(p) my_safefree(p)
989 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
990 #define del_XPVMG(p) my_safefree(p)
992 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
993 #define del_XPVGV(p) my_safefree(p)
997 #define new_XNV() new_body_type(SVt_NV)
998 #define del_XNV(p) del_body_type(p, SVt_NV)
1000 #define new_XPVNV() new_body_type(SVt_PVNV)
1001 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1003 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1004 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1006 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1007 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1009 #define new_XPVMG() new_body_type(SVt_PVMG)
1010 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1012 #define new_XPVGV() new_body_type(SVt_PVGV)
1013 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1017 /* no arena for you! */
1019 #define new_NOARENA(details) \
1020 my_safemalloc((details)->body_size + (details)->offset)
1021 #define new_NOARENAZ(details) \
1022 my_safecalloc((details)->body_size + (details)->offset)
1025 S_more_bodies (pTHX_ svtype sv_type)
1028 void ** const root = &PL_body_roots[sv_type];
1029 const struct body_details * const bdp = &bodies_by_type[sv_type];
1030 const size_t body_size = bdp->body_size;
1033 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1034 static bool done_sanity_check;
1036 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1037 * variables like done_sanity_check. */
1038 if (!done_sanity_check) {
1039 unsigned int i = SVt_LAST;
1041 done_sanity_check = TRUE;
1044 assert (bodies_by_type[i].type == i);
1048 assert(bdp->arena_size);
1050 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1052 end = start + bdp->arena_size - body_size;
1054 /* computed count doesnt reflect the 1st slot reservation */
1055 DEBUG_m(PerlIO_printf(Perl_debug_log,
1056 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1057 (void*)start, (void*)end,
1058 (int)bdp->arena_size, sv_type, (int)body_size,
1059 (int)bdp->arena_size / (int)body_size));
1061 *root = (void *)start;
1063 while (start < end) {
1064 char * const next = start + body_size;
1065 *(void**) start = (void *)next;
1068 *(void **)start = 0;
1073 /* grab a new thing from the free list, allocating more if necessary.
1074 The inline version is used for speed in hot routines, and the
1075 function using it serves the rest (unless PURIFY).
1077 #define new_body_inline(xpv, sv_type) \
1079 void ** const r3wt = &PL_body_roots[sv_type]; \
1080 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1081 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1082 *(r3wt) = *(void**)(xpv); \
1088 S_new_body(pTHX_ svtype sv_type)
1092 new_body_inline(xpv, sv_type);
1099 =for apidoc sv_upgrade
1101 Upgrade an SV to a more complex form. Generally adds a new body type to the
1102 SV, then copies across as much information as possible from the old body.
1103 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1109 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1114 const svtype old_type = SvTYPE(sv);
1115 const struct body_details *new_type_details;
1116 const struct body_details *const old_type_details
1117 = bodies_by_type + old_type;
1119 if (new_type != SVt_PV && SvIsCOW(sv)) {
1120 sv_force_normal_flags(sv, 0);
1123 if (old_type == new_type)
1126 old_body = SvANY(sv);
1128 /* Copying structures onto other structures that have been neatly zeroed
1129 has a subtle gotcha. Consider XPVMG
1131 +------+------+------+------+------+-------+-------+
1132 | NV | CUR | LEN | IV | MAGIC | STASH |
1133 +------+------+------+------+------+-------+-------+
1134 0 4 8 12 16 20 24 28
1136 where NVs are aligned to 8 bytes, so that sizeof that structure is
1137 actually 32 bytes long, with 4 bytes of padding at the end:
1139 +------+------+------+------+------+-------+-------+------+
1140 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1141 +------+------+------+------+------+-------+-------+------+
1142 0 4 8 12 16 20 24 28 32
1144 so what happens if you allocate memory for this structure:
1146 +------+------+------+------+------+-------+-------+------+------+...
1147 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1148 +------+------+------+------+------+-------+-------+------+------+...
1149 0 4 8 12 16 20 24 28 32 36
1151 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1152 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1153 started out as zero once, but it's quite possible that it isn't. So now,
1154 rather than a nicely zeroed GP, you have it pointing somewhere random.
1157 (In fact, GP ends up pointing at a previous GP structure, because the
1158 principle cause of the padding in XPVMG getting garbage is a copy of
1159 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1160 this happens to be moot because XPVGV has been re-ordered, with GP
1161 no longer after STASH)
1163 So we are careful and work out the size of used parts of all the
1170 if (new_type < SVt_PVIV) {
1171 new_type = (new_type == SVt_NV)
1172 ? SVt_PVNV : SVt_PVIV;
1176 if (new_type < SVt_PVNV) {
1177 new_type = SVt_PVNV;
1183 assert(new_type > SVt_PV);
1184 assert(SVt_IV < SVt_PV);
1185 assert(SVt_NV < SVt_PV);
1192 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1193 there's no way that it can be safely upgraded, because perl.c
1194 expects to Safefree(SvANY(PL_mess_sv)) */
1195 assert(sv != PL_mess_sv);
1196 /* This flag bit is used to mean other things in other scalar types.
1197 Given that it only has meaning inside the pad, it shouldn't be set
1198 on anything that can get upgraded. */
1199 assert(!SvPAD_TYPED(sv));
1202 if (old_type_details->cant_upgrade)
1203 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1204 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1207 if (old_type > new_type)
1208 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1209 (int)old_type, (int)new_type);
1211 new_type_details = bodies_by_type + new_type;
1213 SvFLAGS(sv) &= ~SVTYPEMASK;
1214 SvFLAGS(sv) |= new_type;
1216 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1217 the return statements above will have triggered. */
1218 assert (new_type != SVt_NULL);
1221 assert(old_type == SVt_NULL);
1222 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1226 assert(old_type == SVt_NULL);
1227 SvANY(sv) = new_XNV();
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = &sv->sv_u.svu_rv;
1237 assert(new_type_details->body_size);
1240 assert(new_type_details->arena);
1241 assert(new_type_details->arena_size);
1242 /* This points to the start of the allocated area. */
1243 new_body_inline(new_body, new_type);
1244 Zero(new_body, new_type_details->body_size, char);
1245 new_body = ((char *)new_body) - new_type_details->offset;
1247 /* We always allocated the full length item with PURIFY. To do this
1248 we fake things so that arena is false for all 16 types.. */
1249 new_body = new_NOARENAZ(new_type_details);
1251 SvANY(sv) = new_body;
1252 if (new_type == SVt_PVAV) {
1256 if (old_type_details->body_size) {
1259 /* It will have been zeroed when the new body was allocated.
1260 Lets not write to it, in case it confuses a write-back
1266 #ifndef NODEFAULT_SHAREKEYS
1267 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1269 HvMAX(sv) = 7; /* (start with 8 buckets) */
1270 if (old_type_details->body_size) {
1273 /* It will have been zeroed when the new body was allocated.
1274 Lets not write to it, in case it confuses a write-back
1279 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1280 The target created by newSVrv also is, and it can have magic.
1281 However, it never has SvPVX set.
1283 if (old_type >= SVt_RV) {
1284 assert(SvPVX_const(sv) == 0);
1287 if (old_type >= SVt_PVMG) {
1288 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1289 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1291 sv->sv_u.svu_array = NULL; /* or svu_hash */
1297 /* XXX Is this still needed? Was it ever needed? Surely as there is
1298 no route from NV to PVIV, NOK can never be true */
1299 assert(!SvNOKp(sv));
1310 assert(new_type_details->body_size);
1311 /* We always allocated the full length item with PURIFY. To do this
1312 we fake things so that arena is false for all 16 types.. */
1313 if(new_type_details->arena) {
1314 /* This points to the start of the allocated area. */
1315 new_body_inline(new_body, new_type);
1316 Zero(new_body, new_type_details->body_size, char);
1317 new_body = ((char *)new_body) - new_type_details->offset;
1319 new_body = new_NOARENAZ(new_type_details);
1321 SvANY(sv) = new_body;
1323 if (old_type_details->copy) {
1324 /* There is now the potential for an upgrade from something without
1325 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1326 int offset = old_type_details->offset;
1327 int length = old_type_details->copy;
1329 if (new_type_details->offset > old_type_details->offset) {
1330 const int difference
1331 = new_type_details->offset - old_type_details->offset;
1332 offset += difference;
1333 length -= difference;
1335 assert (length >= 0);
1337 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1341 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1342 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1343 * correct 0.0 for us. Otherwise, if the old body didn't have an
1344 * NV slot, but the new one does, then we need to initialise the
1345 * freshly created NV slot with whatever the correct bit pattern is
1347 if (old_type_details->zero_nv && !new_type_details->zero_nv
1348 && !isGV_with_GP(sv))
1352 if (new_type == SVt_PVIO)
1353 IoPAGE_LEN(sv) = 60;
1354 if (old_type < SVt_RV)
1358 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1359 (unsigned long)new_type);
1362 if (old_type_details->arena) {
1363 /* If there was an old body, then we need to free it.
1364 Note that there is an assumption that all bodies of types that
1365 can be upgraded came from arenas. Only the more complex non-
1366 upgradable types are allowed to be directly malloc()ed. */
1368 my_safefree(old_body);
1370 del_body((void*)((char*)old_body + old_type_details->offset),
1371 &PL_body_roots[old_type]);
1377 =for apidoc sv_backoff
1379 Remove any string offset. You should normally use the C<SvOOK_off> macro
1386 Perl_sv_backoff(pTHX_ register SV *sv)
1388 PERL_UNUSED_CONTEXT;
1390 assert(SvTYPE(sv) != SVt_PVHV);
1391 assert(SvTYPE(sv) != SVt_PVAV);
1393 const char * const s = SvPVX_const(sv);
1394 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1395 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1397 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1399 SvFLAGS(sv) &= ~SVf_OOK;
1406 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1407 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1408 Use the C<SvGROW> wrapper instead.
1414 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1418 if (PL_madskills && newlen >= 0x100000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1422 #ifdef HAS_64K_LIMIT
1423 if (newlen >= 0x10000) {
1424 PerlIO_printf(Perl_debug_log,
1425 "Allocation too large: %"UVxf"\n", (UV)newlen);
1428 #endif /* HAS_64K_LIMIT */
1431 if (SvTYPE(sv) < SVt_PV) {
1432 sv_upgrade(sv, SVt_PV);
1433 s = SvPVX_mutable(sv);
1435 else if (SvOOK(sv)) { /* pv is offset? */
1437 s = SvPVX_mutable(sv);
1438 if (newlen > SvLEN(sv))
1439 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1440 #ifdef HAS_64K_LIMIT
1441 if (newlen >= 0x10000)
1446 s = SvPVX_mutable(sv);
1448 if (newlen > SvLEN(sv)) { /* need more room? */
1449 newlen = PERL_STRLEN_ROUNDUP(newlen);
1450 if (SvLEN(sv) && s) {
1452 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1458 s = (char*)saferealloc(s, newlen);
1461 s = (char*)safemalloc(newlen);
1462 if (SvPVX_const(sv) && SvCUR(sv)) {
1463 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1467 SvLEN_set(sv, newlen);
1473 =for apidoc sv_setiv
1475 Copies an integer into the given SV, upgrading first if necessary.
1476 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1482 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1485 SV_CHECK_THINKFIRST_COW_DROP(sv);
1486 switch (SvTYPE(sv)) {
1489 sv_upgrade(sv, SVt_IV);
1493 sv_upgrade(sv, SVt_PVIV);
1502 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1506 (void)SvIOK_only(sv); /* validate number */
1512 =for apidoc sv_setiv_mg
1514 Like C<sv_setiv>, but also handles 'set' magic.
1520 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1527 =for apidoc sv_setuv
1529 Copies an unsigned integer into the given SV, upgrading first if necessary.
1530 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1536 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1538 /* With these two if statements:
1539 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1542 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1544 If you wish to remove them, please benchmark to see what the effect is
1546 if (u <= (UV)IV_MAX) {
1547 sv_setiv(sv, (IV)u);
1556 =for apidoc sv_setuv_mg
1558 Like C<sv_setuv>, but also handles 'set' magic.
1564 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1571 =for apidoc sv_setnv
1573 Copies a double into the given SV, upgrading first if necessary.
1574 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1580 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1583 SV_CHECK_THINKFIRST_COW_DROP(sv);
1584 switch (SvTYPE(sv)) {
1587 sv_upgrade(sv, SVt_NV);
1592 sv_upgrade(sv, SVt_PVNV);
1601 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1606 (void)SvNOK_only(sv); /* validate number */
1611 =for apidoc sv_setnv_mg
1613 Like C<sv_setnv>, but also handles 'set' magic.
1619 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1625 /* Print an "isn't numeric" warning, using a cleaned-up,
1626 * printable version of the offending string
1630 S_not_a_number(pTHX_ SV *sv)
1638 dsv = sv_2mortal(newSVpvs(""));
1639 pv = sv_uni_display(dsv, sv, 10, 0);
1642 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1643 /* each *s can expand to 4 chars + "...\0",
1644 i.e. need room for 8 chars */
1646 const char *s = SvPVX_const(sv);
1647 const char * const end = s + SvCUR(sv);
1648 for ( ; s < end && d < limit; s++ ) {
1650 if (ch & 128 && !isPRINT_LC(ch)) {
1659 else if (ch == '\r') {
1663 else if (ch == '\f') {
1667 else if (ch == '\\') {
1671 else if (ch == '\0') {
1675 else if (isPRINT_LC(ch))
1692 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1693 "Argument \"%s\" isn't numeric in %s", pv,
1696 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1697 "Argument \"%s\" isn't numeric", pv);
1701 =for apidoc looks_like_number
1703 Test if the content of an SV looks like a number (or is a number).
1704 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1705 non-numeric warning), even if your atof() doesn't grok them.
1711 Perl_looks_like_number(pTHX_ SV *sv)
1713 register const char *sbegin;
1717 sbegin = SvPVX_const(sv);
1720 else if (SvPOKp(sv))
1721 sbegin = SvPV_const(sv, len);
1723 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1724 return grok_number(sbegin, len, NULL);
1728 S_glob_2number(pTHX_ GV * const gv)
1730 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1731 SV *const buffer = sv_newmortal();
1733 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1736 gv_efullname3(buffer, gv, "*");
1737 SvFLAGS(gv) |= wasfake;
1739 /* We know that all GVs stringify to something that is not-a-number,
1740 so no need to test that. */
1741 if (ckWARN(WARN_NUMERIC))
1742 not_a_number(buffer);
1743 /* We just want something true to return, so that S_sv_2iuv_common
1744 can tail call us and return true. */
1749 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1751 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1752 SV *const buffer = sv_newmortal();
1754 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1757 gv_efullname3(buffer, gv, "*");
1758 SvFLAGS(gv) |= wasfake;
1760 assert(SvPOK(buffer));
1762 *len = SvCUR(buffer);
1764 return SvPVX(buffer);
1767 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1768 until proven guilty, assume that things are not that bad... */
1773 As 64 bit platforms often have an NV that doesn't preserve all bits of
1774 an IV (an assumption perl has been based on to date) it becomes necessary
1775 to remove the assumption that the NV always carries enough precision to
1776 recreate the IV whenever needed, and that the NV is the canonical form.
1777 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1778 precision as a side effect of conversion (which would lead to insanity
1779 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1780 1) to distinguish between IV/UV/NV slots that have cached a valid
1781 conversion where precision was lost and IV/UV/NV slots that have a
1782 valid conversion which has lost no precision
1783 2) to ensure that if a numeric conversion to one form is requested that
1784 would lose precision, the precise conversion (or differently
1785 imprecise conversion) is also performed and cached, to prevent
1786 requests for different numeric formats on the same SV causing
1787 lossy conversion chains. (lossless conversion chains are perfectly
1792 SvIOKp is true if the IV slot contains a valid value
1793 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1794 SvNOKp is true if the NV slot contains a valid value
1795 SvNOK is true only if the NV value is accurate
1798 while converting from PV to NV, check to see if converting that NV to an
1799 IV(or UV) would lose accuracy over a direct conversion from PV to
1800 IV(or UV). If it would, cache both conversions, return NV, but mark
1801 SV as IOK NOKp (ie not NOK).
1803 While converting from PV to IV, check to see if converting that IV to an
1804 NV would lose accuracy over a direct conversion from PV to NV. If it
1805 would, cache both conversions, flag similarly.
1807 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1808 correctly because if IV & NV were set NV *always* overruled.
1809 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1810 changes - now IV and NV together means that the two are interchangeable:
1811 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1813 The benefit of this is that operations such as pp_add know that if
1814 SvIOK is true for both left and right operands, then integer addition
1815 can be used instead of floating point (for cases where the result won't
1816 overflow). Before, floating point was always used, which could lead to
1817 loss of precision compared with integer addition.
1819 * making IV and NV equal status should make maths accurate on 64 bit
1821 * may speed up maths somewhat if pp_add and friends start to use
1822 integers when possible instead of fp. (Hopefully the overhead in
1823 looking for SvIOK and checking for overflow will not outweigh the
1824 fp to integer speedup)
1825 * will slow down integer operations (callers of SvIV) on "inaccurate"
1826 values, as the change from SvIOK to SvIOKp will cause a call into
1827 sv_2iv each time rather than a macro access direct to the IV slot
1828 * should speed up number->string conversion on integers as IV is
1829 favoured when IV and NV are equally accurate
1831 ####################################################################
1832 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1833 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1834 On the other hand, SvUOK is true iff UV.
1835 ####################################################################
1837 Your mileage will vary depending your CPU's relative fp to integer
1841 #ifndef NV_PRESERVES_UV
1842 # define IS_NUMBER_UNDERFLOW_IV 1
1843 # define IS_NUMBER_UNDERFLOW_UV 2
1844 # define IS_NUMBER_IV_AND_UV 2
1845 # define IS_NUMBER_OVERFLOW_IV 4
1846 # define IS_NUMBER_OVERFLOW_UV 5
1848 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1850 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1852 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1855 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1856 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));
1857 if (SvNVX(sv) < (NV)IV_MIN) {
1858 (void)SvIOKp_on(sv);
1860 SvIV_set(sv, IV_MIN);
1861 return IS_NUMBER_UNDERFLOW_IV;
1863 if (SvNVX(sv) > (NV)UV_MAX) {
1864 (void)SvIOKp_on(sv);
1867 SvUV_set(sv, UV_MAX);
1868 return IS_NUMBER_OVERFLOW_UV;
1870 (void)SvIOKp_on(sv);
1872 /* Can't use strtol etc to convert this string. (See truth table in
1874 if (SvNVX(sv) <= (UV)IV_MAX) {
1875 SvIV_set(sv, I_V(SvNVX(sv)));
1876 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1877 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1879 /* Integer is imprecise. NOK, IOKp */
1881 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1884 SvUV_set(sv, U_V(SvNVX(sv)));
1885 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1886 if (SvUVX(sv) == UV_MAX) {
1887 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1888 possibly be preserved by NV. Hence, it must be overflow.
1890 return IS_NUMBER_OVERFLOW_UV;
1892 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1894 /* Integer is imprecise. NOK, IOKp */
1896 return IS_NUMBER_OVERFLOW_IV;
1898 #endif /* !NV_PRESERVES_UV*/
1901 S_sv_2iuv_common(pTHX_ SV *sv) {
1904 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1905 * without also getting a cached IV/UV from it at the same time
1906 * (ie PV->NV conversion should detect loss of accuracy and cache
1907 * IV or UV at same time to avoid this. */
1908 /* IV-over-UV optimisation - choose to cache IV if possible */
1910 if (SvTYPE(sv) == SVt_NV)
1911 sv_upgrade(sv, SVt_PVNV);
1913 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1914 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1915 certainly cast into the IV range at IV_MAX, whereas the correct
1916 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1918 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1919 if (Perl_isnan(SvNVX(sv))) {
1925 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1926 SvIV_set(sv, I_V(SvNVX(sv)));
1927 if (SvNVX(sv) == (NV) SvIVX(sv)
1928 #ifndef NV_PRESERVES_UV
1929 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1930 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1931 /* Don't flag it as "accurately an integer" if the number
1932 came from a (by definition imprecise) NV operation, and
1933 we're outside the range of NV integer precision */
1936 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1937 DEBUG_c(PerlIO_printf(Perl_debug_log,
1938 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1944 /* IV not precise. No need to convert from PV, as NV
1945 conversion would already have cached IV if it detected
1946 that PV->IV would be better than PV->NV->IV
1947 flags already correct - don't set public IOK. */
1948 DEBUG_c(PerlIO_printf(Perl_debug_log,
1949 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1954 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1955 but the cast (NV)IV_MIN rounds to a the value less (more
1956 negative) than IV_MIN which happens to be equal to SvNVX ??
1957 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1958 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1959 (NV)UVX == NVX are both true, but the values differ. :-(
1960 Hopefully for 2s complement IV_MIN is something like
1961 0x8000000000000000 which will be exact. NWC */
1964 SvUV_set(sv, U_V(SvNVX(sv)));
1966 (SvNVX(sv) == (NV) SvUVX(sv))
1967 #ifndef NV_PRESERVES_UV
1968 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1969 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1970 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1971 /* Don't flag it as "accurately an integer" if the number
1972 came from a (by definition imprecise) NV operation, and
1973 we're outside the range of NV integer precision */
1978 DEBUG_c(PerlIO_printf(Perl_debug_log,
1979 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1985 else if (SvPOKp(sv) && SvLEN(sv)) {
1987 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1988 /* We want to avoid a possible problem when we cache an IV/ a UV which
1989 may be later translated to an NV, and the resulting NV is not
1990 the same as the direct translation of the initial string
1991 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1992 be careful to ensure that the value with the .456 is around if the
1993 NV value is requested in the future).
1995 This means that if we cache such an IV/a UV, we need to cache the
1996 NV as well. Moreover, we trade speed for space, and do not
1997 cache the NV if we are sure it's not needed.
2000 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2001 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2002 == IS_NUMBER_IN_UV) {
2003 /* It's definitely an integer, only upgrade to PVIV */
2004 if (SvTYPE(sv) < SVt_PVIV)
2005 sv_upgrade(sv, SVt_PVIV);
2007 } else if (SvTYPE(sv) < SVt_PVNV)
2008 sv_upgrade(sv, SVt_PVNV);
2010 /* If NVs preserve UVs then we only use the UV value if we know that
2011 we aren't going to call atof() below. If NVs don't preserve UVs
2012 then the value returned may have more precision than atof() will
2013 return, even though value isn't perfectly accurate. */
2014 if ((numtype & (IS_NUMBER_IN_UV
2015 #ifdef NV_PRESERVES_UV
2018 )) == IS_NUMBER_IN_UV) {
2019 /* This won't turn off the public IOK flag if it was set above */
2020 (void)SvIOKp_on(sv);
2022 if (!(numtype & IS_NUMBER_NEG)) {
2024 if (value <= (UV)IV_MAX) {
2025 SvIV_set(sv, (IV)value);
2027 /* it didn't overflow, and it was positive. */
2028 SvUV_set(sv, value);
2032 /* 2s complement assumption */
2033 if (value <= (UV)IV_MIN) {
2034 SvIV_set(sv, -(IV)value);
2036 /* Too negative for an IV. This is a double upgrade, but
2037 I'm assuming it will be rare. */
2038 if (SvTYPE(sv) < SVt_PVNV)
2039 sv_upgrade(sv, SVt_PVNV);
2043 SvNV_set(sv, -(NV)value);
2044 SvIV_set(sv, IV_MIN);
2048 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2049 will be in the previous block to set the IV slot, and the next
2050 block to set the NV slot. So no else here. */
2052 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2053 != IS_NUMBER_IN_UV) {
2054 /* It wasn't an (integer that doesn't overflow the UV). */
2055 SvNV_set(sv, Atof(SvPVX_const(sv)));
2057 if (! numtype && ckWARN(WARN_NUMERIC))
2060 #if defined(USE_LONG_DOUBLE)
2061 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2062 PTR2UV(sv), SvNVX(sv)));
2064 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2065 PTR2UV(sv), SvNVX(sv)));
2068 #ifdef NV_PRESERVES_UV
2069 (void)SvIOKp_on(sv);
2071 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2072 SvIV_set(sv, I_V(SvNVX(sv)));
2073 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2076 NOOP; /* Integer is imprecise. NOK, IOKp */
2078 /* UV will not work better than IV */
2080 if (SvNVX(sv) > (NV)UV_MAX) {
2082 /* Integer is inaccurate. NOK, IOKp, is UV */
2083 SvUV_set(sv, UV_MAX);
2085 SvUV_set(sv, U_V(SvNVX(sv)));
2086 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2087 NV preservse UV so can do correct comparison. */
2088 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2091 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2096 #else /* NV_PRESERVES_UV */
2097 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2098 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2099 /* The IV/UV slot will have been set from value returned by
2100 grok_number above. The NV slot has just been set using
2103 assert (SvIOKp(sv));
2105 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2106 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2107 /* Small enough to preserve all bits. */
2108 (void)SvIOKp_on(sv);
2110 SvIV_set(sv, I_V(SvNVX(sv)));
2111 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2113 /* Assumption: first non-preserved integer is < IV_MAX,
2114 this NV is in the preserved range, therefore: */
2115 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2117 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);
2121 0 0 already failed to read UV.
2122 0 1 already failed to read UV.
2123 1 0 you won't get here in this case. IV/UV
2124 slot set, public IOK, Atof() unneeded.
2125 1 1 already read UV.
2126 so there's no point in sv_2iuv_non_preserve() attempting
2127 to use atol, strtol, strtoul etc. */
2128 sv_2iuv_non_preserve (sv, numtype);
2131 #endif /* NV_PRESERVES_UV */
2135 if (isGV_with_GP(sv))
2136 return glob_2number((GV *)sv);
2138 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2139 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2142 if (SvTYPE(sv) < SVt_IV)
2143 /* Typically the caller expects that sv_any is not NULL now. */
2144 sv_upgrade(sv, SVt_IV);
2145 /* Return 0 from the caller. */
2152 =for apidoc sv_2iv_flags
2154 Return the integer value of an SV, doing any necessary string
2155 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2156 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2162 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2167 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2168 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2169 cache IVs just in case. In practice it seems that they never
2170 actually anywhere accessible by user Perl code, let alone get used
2171 in anything other than a string context. */
2172 if (flags & SV_GMAGIC)
2177 return I_V(SvNVX(sv));
2179 if (SvPOKp(sv) && SvLEN(sv)) {
2182 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2184 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2185 == IS_NUMBER_IN_UV) {
2186 /* It's definitely an integer */
2187 if (numtype & IS_NUMBER_NEG) {
2188 if (value < (UV)IV_MIN)
2191 if (value < (UV)IV_MAX)
2196 if (ckWARN(WARN_NUMERIC))
2199 return I_V(Atof(SvPVX_const(sv)));
2204 assert(SvTYPE(sv) >= SVt_PVMG);
2205 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2206 } else if (SvTHINKFIRST(sv)) {
2210 SV * const tmpstr=AMG_CALLun(sv,numer);
2211 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2212 return SvIV(tmpstr);
2215 return PTR2IV(SvRV(sv));
2218 sv_force_normal_flags(sv, 0);
2220 if (SvREADONLY(sv) && !SvOK(sv)) {
2221 if (ckWARN(WARN_UNINITIALIZED))
2227 if (S_sv_2iuv_common(aTHX_ sv))
2230 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2231 PTR2UV(sv),SvIVX(sv)));
2232 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2236 =for apidoc sv_2uv_flags
2238 Return the unsigned integer value of an SV, doing any necessary string
2239 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2240 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2246 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2251 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2252 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2253 cache IVs just in case. */
2254 if (flags & SV_GMAGIC)
2259 return U_V(SvNVX(sv));
2260 if (SvPOKp(sv) && SvLEN(sv)) {
2263 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2265 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2266 == IS_NUMBER_IN_UV) {
2267 /* It's definitely an integer */
2268 if (!(numtype & IS_NUMBER_NEG))
2272 if (ckWARN(WARN_NUMERIC))
2275 return U_V(Atof(SvPVX_const(sv)));
2280 assert(SvTYPE(sv) >= SVt_PVMG);
2281 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2282 } else if (SvTHINKFIRST(sv)) {
2286 SV *const tmpstr = AMG_CALLun(sv,numer);
2287 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2288 return SvUV(tmpstr);
2291 return PTR2UV(SvRV(sv));
2294 sv_force_normal_flags(sv, 0);
2296 if (SvREADONLY(sv) && !SvOK(sv)) {
2297 if (ckWARN(WARN_UNINITIALIZED))
2303 if (S_sv_2iuv_common(aTHX_ sv))
2307 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2308 PTR2UV(sv),SvUVX(sv)));
2309 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2315 Return the num value of an SV, doing any necessary string or integer
2316 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2323 Perl_sv_2nv(pTHX_ register SV *sv)
2328 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2329 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2330 cache IVs just in case. */
2334 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2335 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2336 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2338 return Atof(SvPVX_const(sv));
2342 return (NV)SvUVX(sv);
2344 return (NV)SvIVX(sv);
2349 assert(SvTYPE(sv) >= SVt_PVMG);
2350 /* This falls through to the report_uninit near the end of the
2352 } else if (SvTHINKFIRST(sv)) {
2356 SV *const tmpstr = AMG_CALLun(sv,numer);
2357 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2358 return SvNV(tmpstr);
2361 return PTR2NV(SvRV(sv));
2364 sv_force_normal_flags(sv, 0);
2366 if (SvREADONLY(sv) && !SvOK(sv)) {
2367 if (ckWARN(WARN_UNINITIALIZED))
2372 if (SvTYPE(sv) < SVt_NV) {
2373 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2374 sv_upgrade(sv, SVt_NV);
2375 #ifdef USE_LONG_DOUBLE
2377 STORE_NUMERIC_LOCAL_SET_STANDARD();
2378 PerlIO_printf(Perl_debug_log,
2379 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2380 PTR2UV(sv), SvNVX(sv));
2381 RESTORE_NUMERIC_LOCAL();
2385 STORE_NUMERIC_LOCAL_SET_STANDARD();
2386 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2387 PTR2UV(sv), SvNVX(sv));
2388 RESTORE_NUMERIC_LOCAL();
2392 else if (SvTYPE(sv) < SVt_PVNV)
2393 sv_upgrade(sv, SVt_PVNV);
2398 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2399 #ifdef NV_PRESERVES_UV
2402 /* Only set the public NV OK flag if this NV preserves the IV */
2403 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2404 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2405 : (SvIVX(sv) == I_V(SvNVX(sv))))
2411 else if (SvPOKp(sv) && SvLEN(sv)) {
2413 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2414 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2416 #ifdef NV_PRESERVES_UV
2417 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2418 == IS_NUMBER_IN_UV) {
2419 /* It's definitely an integer */
2420 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2422 SvNV_set(sv, Atof(SvPVX_const(sv)));
2425 SvNV_set(sv, Atof(SvPVX_const(sv)));
2426 /* Only set the public NV OK flag if this NV preserves the value in
2427 the PV at least as well as an IV/UV would.
2428 Not sure how to do this 100% reliably. */
2429 /* if that shift count is out of range then Configure's test is
2430 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2432 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2433 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2434 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2435 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2436 /* Can't use strtol etc to convert this string, so don't try.
2437 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2440 /* value has been set. It may not be precise. */
2441 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2442 /* 2s complement assumption for (UV)IV_MIN */
2443 SvNOK_on(sv); /* Integer is too negative. */
2448 if (numtype & IS_NUMBER_NEG) {
2449 SvIV_set(sv, -(IV)value);
2450 } else if (value <= (UV)IV_MAX) {
2451 SvIV_set(sv, (IV)value);
2453 SvUV_set(sv, value);
2457 if (numtype & IS_NUMBER_NOT_INT) {
2458 /* I believe that even if the original PV had decimals,
2459 they are lost beyond the limit of the FP precision.
2460 However, neither is canonical, so both only get p
2461 flags. NWC, 2000/11/25 */
2462 /* Both already have p flags, so do nothing */
2464 const NV nv = SvNVX(sv);
2465 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2466 if (SvIVX(sv) == I_V(nv)) {
2469 /* It had no "." so it must be integer. */
2473 /* between IV_MAX and NV(UV_MAX).
2474 Could be slightly > UV_MAX */
2476 if (numtype & IS_NUMBER_NOT_INT) {
2477 /* UV and NV both imprecise. */
2479 const UV nv_as_uv = U_V(nv);
2481 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2490 #endif /* NV_PRESERVES_UV */
2493 if (isGV_with_GP(sv)) {
2494 glob_2number((GV *)sv);
2498 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2500 assert (SvTYPE(sv) >= SVt_NV);
2501 /* Typically the caller expects that sv_any is not NULL now. */
2502 /* XXX Ilya implies that this is a bug in callers that assume this
2503 and ideally should be fixed. */
2506 #if defined(USE_LONG_DOUBLE)
2508 STORE_NUMERIC_LOCAL_SET_STANDARD();
2509 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2510 PTR2UV(sv), SvNVX(sv));
2511 RESTORE_NUMERIC_LOCAL();
2515 STORE_NUMERIC_LOCAL_SET_STANDARD();
2516 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2517 PTR2UV(sv), SvNVX(sv));
2518 RESTORE_NUMERIC_LOCAL();
2527 Return an SV with the numeric value of the source SV, doing any necessary
2528 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2529 access this function.
2535 Perl_sv_2num(pTHX_ register SV *sv)
2540 SV * const tmpsv = AMG_CALLun(sv,numer);
2541 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2542 return sv_2num(tmpsv);
2544 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2547 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2548 * UV as a string towards the end of buf, and return pointers to start and
2551 * We assume that buf is at least TYPE_CHARS(UV) long.
2555 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2557 char *ptr = buf + TYPE_CHARS(UV);
2558 char * const ebuf = ptr;
2571 *--ptr = '0' + (char)(uv % 10);
2580 =for apidoc sv_2pv_flags
2582 Returns a pointer to the string value of an SV, and sets *lp to its length.
2583 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2585 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2586 usually end up here too.
2592 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2602 if (SvGMAGICAL(sv)) {
2603 if (flags & SV_GMAGIC)
2608 if (flags & SV_MUTABLE_RETURN)
2609 return SvPVX_mutable(sv);
2610 if (flags & SV_CONST_RETURN)
2611 return (char *)SvPVX_const(sv);
2614 if (SvIOKp(sv) || SvNOKp(sv)) {
2615 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2620 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2621 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2623 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2630 #ifdef FIXNEGATIVEZERO
2631 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2637 SvUPGRADE(sv, SVt_PV);
2640 s = SvGROW_mutable(sv, len + 1);
2643 return (char*)memcpy(s, tbuf, len + 1);
2649 assert(SvTYPE(sv) >= SVt_PVMG);
2650 /* This falls through to the report_uninit near the end of the
2652 } else if (SvTHINKFIRST(sv)) {
2656 SV *const tmpstr = AMG_CALLun(sv,string);
2657 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2659 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2663 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2664 if (flags & SV_CONST_RETURN) {
2665 pv = (char *) SvPVX_const(tmpstr);
2667 pv = (flags & SV_MUTABLE_RETURN)
2668 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2671 *lp = SvCUR(tmpstr);
2673 pv = sv_2pv_flags(tmpstr, lp, flags);
2687 const SV *const referent = (SV*)SvRV(sv);
2691 retval = buffer = savepvn("NULLREF", len);
2692 } else if (SvTYPE(referent) == SVt_PVMG
2693 && ((SvFLAGS(referent) &
2694 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2695 == (SVs_OBJECT|SVs_SMG))
2696 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2701 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2706 PL_reginterp_cnt += haseval;
2709 const char *const typestr = sv_reftype(referent, 0);
2710 const STRLEN typelen = strlen(typestr);
2711 UV addr = PTR2UV(referent);
2712 const char *stashname = NULL;
2713 STRLEN stashnamelen = 0; /* hush, gcc */
2714 const char *buffer_end;
2716 if (SvOBJECT(referent)) {
2717 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2720 stashname = HEK_KEY(name);
2721 stashnamelen = HEK_LEN(name);
2723 if (HEK_UTF8(name)) {
2729 stashname = "__ANON__";
2732 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2733 + 2 * sizeof(UV) + 2 /* )\0 */;
2735 len = typelen + 3 /* (0x */
2736 + 2 * sizeof(UV) + 2 /* )\0 */;
2739 Newx(buffer, len, char);
2740 buffer_end = retval = buffer + len;
2742 /* Working backwards */
2746 *--retval = PL_hexdigit[addr & 15];
2747 } while (addr >>= 4);
2753 memcpy(retval, typestr, typelen);
2757 retval -= stashnamelen;
2758 memcpy(retval, stashname, stashnamelen);
2760 /* retval may not neccesarily have reached the start of the
2762 assert (retval >= buffer);
2764 len = buffer_end - retval - 1; /* -1 for that \0 */
2772 if (SvREADONLY(sv) && !SvOK(sv)) {
2773 if (ckWARN(WARN_UNINITIALIZED))
2780 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2781 /* I'm assuming that if both IV and NV are equally valid then
2782 converting the IV is going to be more efficient */
2783 const U32 isUIOK = SvIsUV(sv);
2784 char buf[TYPE_CHARS(UV)];
2788 if (SvTYPE(sv) < SVt_PVIV)
2789 sv_upgrade(sv, SVt_PVIV);
2790 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2792 /* inlined from sv_setpvn */
2793 s = SvGROW_mutable(sv, len + 1);
2794 Move(ptr, s, len, char);
2798 else if (SvNOKp(sv)) {
2799 const int olderrno = errno;
2800 if (SvTYPE(sv) < SVt_PVNV)
2801 sv_upgrade(sv, SVt_PVNV);
2802 /* The +20 is pure guesswork. Configure test needed. --jhi */
2803 s = SvGROW_mutable(sv, NV_DIG + 20);
2804 /* some Xenix systems wipe out errno here */
2806 if (SvNVX(sv) == 0.0)
2807 my_strlcpy(s, "0", SvLEN(sv));
2811 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2814 #ifdef FIXNEGATIVEZERO
2815 if (*s == '-' && s[1] == '0' && !s[2]) {
2827 if (isGV_with_GP(sv))
2828 return glob_2pv((GV *)sv, lp);
2830 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2834 if (SvTYPE(sv) < SVt_PV)
2835 /* Typically the caller expects that sv_any is not NULL now. */
2836 sv_upgrade(sv, SVt_PV);
2840 const STRLEN len = s - SvPVX_const(sv);
2846 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2847 PTR2UV(sv),SvPVX_const(sv)));
2848 if (flags & SV_CONST_RETURN)
2849 return (char *)SvPVX_const(sv);
2850 if (flags & SV_MUTABLE_RETURN)
2851 return SvPVX_mutable(sv);
2856 =for apidoc sv_copypv
2858 Copies a stringified representation of the source SV into the
2859 destination SV. Automatically performs any necessary mg_get and
2860 coercion of numeric values into strings. Guaranteed to preserve
2861 UTF8 flag even from overloaded objects. Similar in nature to
2862 sv_2pv[_flags] but operates directly on an SV instead of just the
2863 string. Mostly uses sv_2pv_flags to do its work, except when that
2864 would lose the UTF-8'ness of the PV.
2870 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2873 const char * const s = SvPV_const(ssv,len);
2874 sv_setpvn(dsv,s,len);
2882 =for apidoc sv_2pvbyte
2884 Return a pointer to the byte-encoded representation of the SV, and set *lp
2885 to its length. May cause the SV to be downgraded from UTF-8 as a
2888 Usually accessed via the C<SvPVbyte> macro.
2894 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2896 sv_utf8_downgrade(sv,0);
2897 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2901 =for apidoc sv_2pvutf8
2903 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2904 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2906 Usually accessed via the C<SvPVutf8> macro.
2912 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2914 sv_utf8_upgrade(sv);
2915 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2920 =for apidoc sv_2bool
2922 This function is only called on magical items, and is only used by
2923 sv_true() or its macro equivalent.
2929 Perl_sv_2bool(pTHX_ register SV *sv)
2938 SV * const tmpsv = AMG_CALLun(sv,bool_);
2939 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2940 return (bool)SvTRUE(tmpsv);
2942 return SvRV(sv) != 0;
2945 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2947 (*sv->sv_u.svu_pv > '0' ||
2948 Xpvtmp->xpv_cur > 1 ||
2949 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2956 return SvIVX(sv) != 0;
2959 return SvNVX(sv) != 0.0;
2961 if (isGV_with_GP(sv))
2971 =for apidoc sv_utf8_upgrade
2973 Converts the PV of an SV to its UTF-8-encoded form.
2974 Forces the SV to string form if it is not already.
2975 Always sets the SvUTF8 flag to avoid future validity checks even
2976 if all the bytes have hibit clear.
2978 This is not as a general purpose byte encoding to Unicode interface:
2979 use the Encode extension for that.
2981 =for apidoc sv_utf8_upgrade_flags
2983 Converts the PV of an SV to its UTF-8-encoded form.
2984 Forces the SV to string form if it is not already.
2985 Always sets the SvUTF8 flag to avoid future validity checks even
2986 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2987 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2988 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2990 This is not as a general purpose byte encoding to Unicode interface:
2991 use the Encode extension for that.
2997 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3000 if (sv == &PL_sv_undef)
3004 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3005 (void) sv_2pv_flags(sv,&len, flags);
3009 (void) SvPV_force(sv,len);
3018 sv_force_normal_flags(sv, 0);
3021 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3022 sv_recode_to_utf8(sv, PL_encoding);
3023 else { /* Assume Latin-1/EBCDIC */
3024 /* This function could be much more efficient if we
3025 * had a FLAG in SVs to signal if there are any hibit
3026 * chars in the PV. Given that there isn't such a flag
3027 * make the loop as fast as possible. */
3028 const U8 * const s = (U8 *) SvPVX_const(sv);
3029 const U8 * const e = (U8 *) SvEND(sv);
3034 /* Check for hi bit */
3035 if (!NATIVE_IS_INVARIANT(ch)) {
3036 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3037 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3039 SvPV_free(sv); /* No longer using what was there before. */
3040 SvPV_set(sv, (char*)recoded);
3041 SvCUR_set(sv, len - 1);
3042 SvLEN_set(sv, len); /* No longer know the real size. */
3046 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3053 =for apidoc sv_utf8_downgrade
3055 Attempts to convert the PV of an SV from characters to bytes.
3056 If the PV contains a character beyond byte, this conversion will fail;
3057 in this case, either returns false or, if C<fail_ok> is not
3060 This is not as a general purpose Unicode to byte encoding interface:
3061 use the Encode extension for that.
3067 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3070 if (SvPOKp(sv) && SvUTF8(sv)) {
3076 sv_force_normal_flags(sv, 0);
3078 s = (U8 *) SvPV(sv, len);
3079 if (!utf8_to_bytes(s, &len)) {
3084 Perl_croak(aTHX_ "Wide character in %s",
3087 Perl_croak(aTHX_ "Wide character");
3098 =for apidoc sv_utf8_encode
3100 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3101 flag off so that it looks like octets again.
3107 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3110 sv_force_normal_flags(sv, 0);
3112 if (SvREADONLY(sv)) {
3113 Perl_croak(aTHX_ PL_no_modify);
3115 (void) sv_utf8_upgrade(sv);
3120 =for apidoc sv_utf8_decode
3122 If the PV of the SV is an octet sequence in UTF-8
3123 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3124 so that it looks like a character. If the PV contains only single-byte
3125 characters, the C<SvUTF8> flag stays being off.
3126 Scans PV for validity and returns false if the PV is invalid UTF-8.
3132 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3138 /* The octets may have got themselves encoded - get them back as
3141 if (!sv_utf8_downgrade(sv, TRUE))
3144 /* it is actually just a matter of turning the utf8 flag on, but
3145 * we want to make sure everything inside is valid utf8 first.
3147 c = (const U8 *) SvPVX_const(sv);
3148 if (!is_utf8_string(c, SvCUR(sv)+1))
3150 e = (const U8 *) SvEND(sv);
3153 if (!UTF8_IS_INVARIANT(ch)) {
3163 =for apidoc sv_setsv
3165 Copies the contents of the source SV C<ssv> into the destination SV
3166 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3167 function if the source SV needs to be reused. Does not handle 'set' magic.
3168 Loosely speaking, it performs a copy-by-value, obliterating any previous
3169 content of the destination.
3171 You probably want to use one of the assortment of wrappers, such as
3172 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3173 C<SvSetMagicSV_nosteal>.
3175 =for apidoc sv_setsv_flags
3177 Copies the contents of the source SV C<ssv> into the destination SV
3178 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3179 function if the source SV needs to be reused. Does not handle 'set' magic.
3180 Loosely speaking, it performs a copy-by-value, obliterating any previous
3181 content of the destination.
3182 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3183 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3184 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3185 and C<sv_setsv_nomg> are implemented in terms of this function.
3187 You probably want to use one of the assortment of wrappers, such as
3188 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3189 C<SvSetMagicSV_nosteal>.
3191 This is the primary function for copying scalars, and most other
3192 copy-ish functions and macros use this underneath.
3198 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3200 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3202 if (dtype != SVt_PVGV) {
3203 const char * const name = GvNAME(sstr);
3204 const STRLEN len = GvNAMELEN(sstr);
3206 if (dtype >= SVt_PV) {
3212 SvUPGRADE(dstr, SVt_PVGV);
3213 (void)SvOK_off(dstr);
3214 /* FIXME - why are we doing this, then turning it off and on again
3216 isGV_with_GP_on(dstr);
3218 GvSTASH(dstr) = GvSTASH(sstr);
3220 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3221 gv_name_set((GV *)dstr, name, len, GV_ADD);
3222 SvFAKE_on(dstr); /* can coerce to non-glob */
3225 #ifdef GV_UNIQUE_CHECK
3226 if (GvUNIQUE((GV*)dstr)) {
3227 Perl_croak(aTHX_ PL_no_modify);
3231 if(GvGP((GV*)sstr)) {
3232 /* If source has method cache entry, clear it */
3234 SvREFCNT_dec(GvCV(sstr));
3238 /* If source has a real method, then a method is
3240 else if(GvCV((GV*)sstr)) {
3245 /* If dest already had a real method, that's a change as well */
3246 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3250 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3254 isGV_with_GP_off(dstr);
3255 (void)SvOK_off(dstr);
3256 isGV_with_GP_on(dstr);
3257 GvINTRO_off(dstr); /* one-shot flag */
3258 GvGP(dstr) = gp_ref(GvGP(sstr));
3259 if (SvTAINTED(sstr))
3261 if (GvIMPORTED(dstr) != GVf_IMPORTED
3262 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3264 GvIMPORTED_on(dstr);
3267 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3268 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3273 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3274 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3276 const int intro = GvINTRO(dstr);
3279 const U32 stype = SvTYPE(sref);
3282 #ifdef GV_UNIQUE_CHECK
3283 if (GvUNIQUE((GV*)dstr)) {
3284 Perl_croak(aTHX_ PL_no_modify);
3289 GvINTRO_off(dstr); /* one-shot flag */
3290 GvLINE(dstr) = CopLINE(PL_curcop);
3291 GvEGV(dstr) = (GV*)dstr;
3296 location = (SV **) &GvCV(dstr);
3297 import_flag = GVf_IMPORTED_CV;
3300 location = (SV **) &GvHV(dstr);
3301 import_flag = GVf_IMPORTED_HV;
3304 location = (SV **) &GvAV(dstr);
3305 import_flag = GVf_IMPORTED_AV;
3308 location = (SV **) &GvIOp(dstr);
3311 location = (SV **) &GvFORM(dstr);
3313 location = &GvSV(dstr);
3314 import_flag = GVf_IMPORTED_SV;
3317 if (stype == SVt_PVCV) {
3318 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3319 if (GvCVGEN(dstr)) {
3320 SvREFCNT_dec(GvCV(dstr));
3322 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3325 SAVEGENERICSV(*location);
3329 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3330 CV* const cv = (CV*)*location;
3332 if (!GvCVGEN((GV*)dstr) &&
3333 (CvROOT(cv) || CvXSUB(cv)))
3335 /* Redefining a sub - warning is mandatory if
3336 it was a const and its value changed. */
3337 if (CvCONST(cv) && CvCONST((CV*)sref)
3338 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3340 /* They are 2 constant subroutines generated from
3341 the same constant. This probably means that
3342 they are really the "same" proxy subroutine
3343 instantiated in 2 places. Most likely this is
3344 when a constant is exported twice. Don't warn.
3347 else if (ckWARN(WARN_REDEFINE)
3349 && (!CvCONST((CV*)sref)
3350 || sv_cmp(cv_const_sv(cv),
3351 cv_const_sv((CV*)sref))))) {
3352 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3355 ? "Constant subroutine %s::%s redefined"
3356 : "Subroutine %s::%s redefined"),
3357 HvNAME_get(GvSTASH((GV*)dstr)),
3358 GvENAME((GV*)dstr));
3362 cv_ckproto_len(cv, (GV*)dstr,
3363 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3364 SvPOK(sref) ? SvCUR(sref) : 0);
3366 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3367 GvASSUMECV_on(dstr);
3368 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3371 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3372 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3373 GvFLAGS(dstr) |= import_flag;
3378 if (SvTAINTED(sstr))
3384 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3387 register U32 sflags;
3389 register svtype stype;
3394 if (SvIS_FREED(dstr)) {
3395 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3396 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3398 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3400 sstr = &PL_sv_undef;
3401 if (SvIS_FREED(sstr)) {
3402 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3403 (void*)sstr, (void*)dstr);
3405 stype = SvTYPE(sstr);
3406 dtype = SvTYPE(dstr);
3408 (void)SvAMAGIC_off(dstr);
3411 /* need to nuke the magic */
3413 SvRMAGICAL_off(dstr);
3416 /* There's a lot of redundancy below but we're going for speed here */
3421 if (dtype != SVt_PVGV) {
3422 (void)SvOK_off(dstr);
3430 sv_upgrade(dstr, SVt_IV);
3435 sv_upgrade(dstr, SVt_PVIV);
3438 goto end_of_first_switch;
3440 (void)SvIOK_only(dstr);
3441 SvIV_set(dstr, SvIVX(sstr));
3444 /* SvTAINTED can only be true if the SV has taint magic, which in
3445 turn means that the SV type is PVMG (or greater). This is the
3446 case statement for SVt_IV, so this cannot be true (whatever gcov
3448 assert(!SvTAINTED(sstr));
3458 sv_upgrade(dstr, SVt_NV);
3463 sv_upgrade(dstr, SVt_PVNV);
3466 goto end_of_first_switch;
3468 SvNV_set(dstr, SvNVX(sstr));
3469 (void)SvNOK_only(dstr);
3470 /* SvTAINTED can only be true if the SV has taint magic, which in
3471 turn means that the SV type is PVMG (or greater). This is the
3472 case statement for SVt_NV, so this cannot be true (whatever gcov
3474 assert(!SvTAINTED(sstr));
3481 sv_upgrade(dstr, SVt_RV);
3484 #ifdef PERL_OLD_COPY_ON_WRITE
3485 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3486 if (dtype < SVt_PVIV)
3487 sv_upgrade(dstr, SVt_PVIV);
3494 sv_upgrade(dstr, SVt_PV);
3497 if (dtype < SVt_PVIV)
3498 sv_upgrade(dstr, SVt_PVIV);
3501 if (dtype < SVt_PVNV)
3502 sv_upgrade(dstr, SVt_PVNV);
3506 const char * const type = sv_reftype(sstr,0);
3508 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3510 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3514 /* case SVt_BIND: */
3517 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3518 glob_assign_glob(dstr, sstr, dtype);
3521 /* SvVALID means that this PVGV is playing at being an FBM. */
3525 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3527 if (SvTYPE(sstr) != stype) {
3528 stype = SvTYPE(sstr);
3529 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3530 glob_assign_glob(dstr, sstr, dtype);
3535 if (stype == SVt_PVLV)
3536 SvUPGRADE(dstr, SVt_PVNV);
3538 SvUPGRADE(dstr, (svtype)stype);
3540 end_of_first_switch:
3542 /* dstr may have been upgraded. */
3543 dtype = SvTYPE(dstr);
3544 sflags = SvFLAGS(sstr);
3546 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3547 /* Assigning to a subroutine sets the prototype. */
3550 const char *const ptr = SvPV_const(sstr, len);
3552 SvGROW(dstr, len + 1);
3553 Copy(ptr, SvPVX(dstr), len + 1, char);
3554 SvCUR_set(dstr, len);
3556 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3560 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3561 const char * const type = sv_reftype(dstr,0);
3563 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3565 Perl_croak(aTHX_ "Cannot copy to %s", type);
3566 } else if (sflags & SVf_ROK) {
3567 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3568 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3571 if (GvIMPORTED(dstr) != GVf_IMPORTED
3572 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3574 GvIMPORTED_on(dstr);
3579 glob_assign_glob(dstr, sstr, dtype);
3583 if (dtype >= SVt_PV) {
3584 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3585 glob_assign_ref(dstr, sstr);
3588 if (SvPVX_const(dstr)) {
3594 (void)SvOK_off(dstr);
3595 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3596 SvFLAGS(dstr) |= sflags & SVf_ROK;
3597 assert(!(sflags & SVp_NOK));
3598 assert(!(sflags & SVp_IOK));
3599 assert(!(sflags & SVf_NOK));
3600 assert(!(sflags & SVf_IOK));
3602 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3603 if (!(sflags & SVf_OK)) {
3604 if (ckWARN(WARN_MISC))
3605 Perl_warner(aTHX_ packWARN(WARN_MISC),
3606 "Undefined value assigned to typeglob");
3609 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3610 if (dstr != (SV*)gv) {
3613 GvGP(dstr) = gp_ref(GvGP(gv));
3617 else if (sflags & SVp_POK) {
3621 * Check to see if we can just swipe the string. If so, it's a
3622 * possible small lose on short strings, but a big win on long ones.
3623 * It might even be a win on short strings if SvPVX_const(dstr)
3624 * has to be allocated and SvPVX_const(sstr) has to be freed.
3625 * Likewise if we can set up COW rather than doing an actual copy, we
3626 * drop to the else clause, as the swipe code and the COW setup code
3627 * have much in common.
3630 /* Whichever path we take through the next code, we want this true,
3631 and doing it now facilitates the COW check. */
3632 (void)SvPOK_only(dstr);
3635 /* If we're already COW then this clause is not true, and if COW
3636 is allowed then we drop down to the else and make dest COW
3637 with us. If caller hasn't said that we're allowed to COW
3638 shared hash keys then we don't do the COW setup, even if the
3639 source scalar is a shared hash key scalar. */
3640 (((flags & SV_COW_SHARED_HASH_KEYS)
3641 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3642 : 1 /* If making a COW copy is forbidden then the behaviour we
3643 desire is as if the source SV isn't actually already
3644 COW, even if it is. So we act as if the source flags
3645 are not COW, rather than actually testing them. */
3647 #ifndef PERL_OLD_COPY_ON_WRITE
3648 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3649 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3650 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3651 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3652 but in turn, it's somewhat dead code, never expected to go
3653 live, but more kept as a placeholder on how to do it better
3654 in a newer implementation. */
3655 /* If we are COW and dstr is a suitable target then we drop down
3656 into the else and make dest a COW of us. */
3657 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3662 (sflags & SVs_TEMP) && /* slated for free anyway? */
3663 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3664 (!(flags & SV_NOSTEAL)) &&
3665 /* and we're allowed to steal temps */
3666 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3667 SvLEN(sstr) && /* and really is a string */
3668 /* and won't be needed again, potentially */
3669 !(PL_op && PL_op->op_type == OP_AASSIGN))
3670 #ifdef PERL_OLD_COPY_ON_WRITE
3671 && ((flags & SV_COW_SHARED_HASH_KEYS)
3672 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3673 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3674 && SvTYPE(sstr) >= SVt_PVIV))
3678 /* Failed the swipe test, and it's not a shared hash key either.
3679 Have to copy the string. */
3680 STRLEN len = SvCUR(sstr);
3681 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3682 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3683 SvCUR_set(dstr, len);
3684 *SvEND(dstr) = '\0';
3686 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3688 /* Either it's a shared hash key, or it's suitable for
3689 copy-on-write or we can swipe the string. */
3691 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3695 #ifdef PERL_OLD_COPY_ON_WRITE
3697 /* I believe I should acquire a global SV mutex if
3698 it's a COW sv (not a shared hash key) to stop
3699 it going un copy-on-write.
3700 If the source SV has gone un copy on write between up there
3701 and down here, then (assert() that) it is of the correct
3702 form to make it copy on write again */
3703 if ((sflags & (SVf_FAKE | SVf_READONLY))
3704 != (SVf_FAKE | SVf_READONLY)) {
3705 SvREADONLY_on(sstr);
3707 /* Make the source SV into a loop of 1.
3708 (about to become 2) */
3709 SV_COW_NEXT_SV_SET(sstr, sstr);
3713 /* Initial code is common. */
3714 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3719 /* making another shared SV. */
3720 STRLEN cur = SvCUR(sstr);
3721 STRLEN len = SvLEN(sstr);
3722 #ifdef PERL_OLD_COPY_ON_WRITE
3724 assert (SvTYPE(dstr) >= SVt_PVIV);
3725 /* SvIsCOW_normal */
3726 /* splice us in between source and next-after-source. */
3727 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3728 SV_COW_NEXT_SV_SET(sstr, dstr);
3729 SvPV_set(dstr, SvPVX_mutable(sstr));
3733 /* SvIsCOW_shared_hash */
3734 DEBUG_C(PerlIO_printf(Perl_debug_log,
3735 "Copy on write: Sharing hash\n"));
3737 assert (SvTYPE(dstr) >= SVt_PV);
3739 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3741 SvLEN_set(dstr, len);
3742 SvCUR_set(dstr, cur);
3743 SvREADONLY_on(dstr);
3745 /* Relesase a global SV mutex. */
3748 { /* Passes the swipe test. */
3749 SvPV_set(dstr, SvPVX_mutable(sstr));
3750 SvLEN_set(dstr, SvLEN(sstr));
3751 SvCUR_set(dstr, SvCUR(sstr));
3754 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3755 SvPV_set(sstr, NULL);
3761 if (sflags & SVp_NOK) {
3762 SvNV_set(dstr, SvNVX(sstr));
3764 if (sflags & SVp_IOK) {
3766 SvIV_set(dstr, SvIVX(sstr));
3767 /* Must do this otherwise some other overloaded use of 0x80000000
3768 gets confused. I guess SVpbm_VALID */
3769 if (sflags & SVf_IVisUV)
3772 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3774 const MAGIC * const smg = SvVSTRING_mg(sstr);
3776 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3777 smg->mg_ptr, smg->mg_len);
3778 SvRMAGICAL_on(dstr);
3782 else if (sflags & (SVp_IOK|SVp_NOK)) {
3783 (void)SvOK_off(dstr);
3784 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3785 if (sflags & SVp_IOK) {
3786 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3787 SvIV_set(dstr, SvIVX(sstr));
3789 if (sflags & SVp_NOK) {
3790 SvNV_set(dstr, SvNVX(sstr));
3794 if (isGV_with_GP(sstr)) {
3795 /* This stringification rule for globs is spread in 3 places.
3796 This feels bad. FIXME. */
3797 const U32 wasfake = sflags & SVf_FAKE;
3799 /* FAKE globs can get coerced, so need to turn this off
3800 temporarily if it is on. */
3802 gv_efullname3(dstr, (GV *)sstr, "*");
3803 SvFLAGS(sstr) |= wasfake;
3806 (void)SvOK_off(dstr);
3808 if (SvTAINTED(sstr))
3813 =for apidoc sv_setsv_mg
3815 Like C<sv_setsv>, but also handles 'set' magic.
3821 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3823 sv_setsv(dstr,sstr);
3827 #ifdef PERL_OLD_COPY_ON_WRITE
3829 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3831 STRLEN cur = SvCUR(sstr);
3832 STRLEN len = SvLEN(sstr);
3833 register char *new_pv;
3836 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3837 (void*)sstr, (void*)dstr);
3844 if (SvTHINKFIRST(dstr))
3845 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3846 else if (SvPVX_const(dstr))
3847 Safefree(SvPVX_const(dstr));
3851 SvUPGRADE(dstr, SVt_PVIV);
3853 assert (SvPOK(sstr));
3854 assert (SvPOKp(sstr));
3855 assert (!SvIOK(sstr));
3856 assert (!SvIOKp(sstr));
3857 assert (!SvNOK(sstr));
3858 assert (!SvNOKp(sstr));
3860 if (SvIsCOW(sstr)) {
3862 if (SvLEN(sstr) == 0) {
3863 /* source is a COW shared hash key. */
3864 DEBUG_C(PerlIO_printf(Perl_debug_log,
3865 "Fast copy on write: Sharing hash\n"));
3866 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3869 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3871 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3872 SvUPGRADE(sstr, SVt_PVIV);
3873 SvREADONLY_on(sstr);
3875 DEBUG_C(PerlIO_printf(Perl_debug_log,
3876 "Fast copy on write: Converting sstr to COW\n"));
3877 SV_COW_NEXT_SV_SET(dstr, sstr);
3879 SV_COW_NEXT_SV_SET(sstr, dstr);
3880 new_pv = SvPVX_mutable(sstr);
3883 SvPV_set(dstr, new_pv);
3884 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3887 SvLEN_set(dstr, len);
3888 SvCUR_set(dstr, cur);
3897 =for apidoc sv_setpvn
3899 Copies a string into an SV. The C<len> parameter indicates the number of
3900 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3901 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3907 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3910 register char *dptr;
3912 SV_CHECK_THINKFIRST_COW_DROP(sv);
3918 /* len is STRLEN which is unsigned, need to copy to signed */
3921 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3923 SvUPGRADE(sv, SVt_PV);
3925 dptr = SvGROW(sv, len + 1);
3926 Move(ptr,dptr,len,char);
3929 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3934 =for apidoc sv_setpvn_mg
3936 Like C<sv_setpvn>, but also handles 'set' magic.
3942 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3944 sv_setpvn(sv,ptr,len);
3949 =for apidoc sv_setpv
3951 Copies a string into an SV. The string must be null-terminated. Does not
3952 handle 'set' magic. See C<sv_setpv_mg>.
3958 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3961 register STRLEN len;
3963 SV_CHECK_THINKFIRST_COW_DROP(sv);
3969 SvUPGRADE(sv, SVt_PV);
3971 SvGROW(sv, len + 1);
3972 Move(ptr,SvPVX(sv),len+1,char);
3974 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3979 =for apidoc sv_setpv_mg
3981 Like C<sv_setpv>, but also handles 'set' magic.
3987 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3994 =for apidoc sv_usepvn_flags
3996 Tells an SV to use C<ptr> to find its string value. Normally the
3997 string is stored inside the SV but sv_usepvn allows the SV to use an
3998 outside string. The C<ptr> should point to memory that was allocated
3999 by C<malloc>. The string length, C<len>, must be supplied. By default
4000 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4001 so that pointer should not be freed or used by the programmer after
4002 giving it to sv_usepvn, and neither should any pointers from "behind"
4003 that pointer (e.g. ptr + 1) be used.
4005 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4006 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4007 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4008 C<len>, and already meets the requirements for storing in C<SvPVX>)
4014 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4018 SV_CHECK_THINKFIRST_COW_DROP(sv);
4019 SvUPGRADE(sv, SVt_PV);
4022 if (flags & SV_SMAGIC)
4026 if (SvPVX_const(sv))
4030 if (flags & SV_HAS_TRAILING_NUL)
4031 assert(ptr[len] == '\0');
4034 allocate = (flags & SV_HAS_TRAILING_NUL)
4035 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4036 if (flags & SV_HAS_TRAILING_NUL) {
4037 /* It's long enough - do nothing.
4038 Specfically Perl_newCONSTSUB is relying on this. */
4041 /* Force a move to shake out bugs in callers. */
4042 char *new_ptr = (char*)safemalloc(allocate);
4043 Copy(ptr, new_ptr, len, char);
4044 PoisonFree(ptr,len,char);
4048 ptr = (char*) saferealloc (ptr, allocate);
4053 SvLEN_set(sv, allocate);
4054 if (!(flags & SV_HAS_TRAILING_NUL)) {
4057 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4059 if (flags & SV_SMAGIC)
4063 #ifdef PERL_OLD_COPY_ON_WRITE
4064 /* Need to do this *after* making the SV normal, as we need the buffer
4065 pointer to remain valid until after we've copied it. If we let go too early,
4066 another thread could invalidate it by unsharing last of the same hash key
4067 (which it can do by means other than releasing copy-on-write Svs)
4068 or by changing the other copy-on-write SVs in the loop. */
4070 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4072 { /* this SV was SvIsCOW_normal(sv) */
4073 /* we need to find the SV pointing to us. */
4074 SV *current = SV_COW_NEXT_SV(after);
4076 if (current == sv) {
4077 /* The SV we point to points back to us (there were only two of us
4079 Hence other SV is no longer copy on write either. */
4081 SvREADONLY_off(after);
4083 /* We need to follow the pointers around the loop. */
4085 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4088 /* don't loop forever if the structure is bust, and we have
4089 a pointer into a closed loop. */
4090 assert (current != after);
4091 assert (SvPVX_const(current) == pvx);
4093 /* Make the SV before us point to the SV after us. */
4094 SV_COW_NEXT_SV_SET(current, after);
4100 =for apidoc sv_force_normal_flags
4102 Undo various types of fakery on an SV: if the PV is a shared string, make
4103 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4104 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4105 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4106 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4107 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4108 set to some other value.) In addition, the C<flags> parameter gets passed to
4109 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4110 with flags set to 0.
4116 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4119 #ifdef PERL_OLD_COPY_ON_WRITE
4120 if (SvREADONLY(sv)) {
4121 /* At this point I believe I should acquire a global SV mutex. */
4123 const char * const pvx = SvPVX_const(sv);
4124 const STRLEN len = SvLEN(sv);
4125 const STRLEN cur = SvCUR(sv);
4126 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4127 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4128 we'll fail an assertion. */
4129 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4132 PerlIO_printf(Perl_debug_log,
4133 "Copy on write: Force normal %ld\n",
4139 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4142 if (flags & SV_COW_DROP_PV) {
4143 /* OK, so we don't need to copy our buffer. */
4146 SvGROW(sv, cur + 1);
4147 Move(pvx,SvPVX(sv),cur,char);
4152 sv_release_COW(sv, pvx, next);
4154 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4160 else if (IN_PERL_RUNTIME)
4161 Perl_croak(aTHX_ PL_no_modify);
4162 /* At this point I believe that I can drop the global SV mutex. */
4165 if (SvREADONLY(sv)) {
4167 const char * const pvx = SvPVX_const(sv);
4168 const STRLEN len = SvCUR(sv);
4173 SvGROW(sv, len + 1);
4174 Move(pvx,SvPVX(sv),len,char);
4176 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4178 else if (IN_PERL_RUNTIME)
4179 Perl_croak(aTHX_ PL_no_modify);
4183 sv_unref_flags(sv, flags);
4184 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4191 Efficient removal of characters from the beginning of the string buffer.
4192 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4193 the string buffer. The C<ptr> becomes the first character of the adjusted
4194 string. Uses the "OOK hack".
4195 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4196 refer to the same chunk of data.
4202 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4204 register STRLEN delta;
4205 if (!ptr || !SvPOKp(sv))
4207 delta = ptr - SvPVX_const(sv);
4208 SV_CHECK_THINKFIRST(sv);
4209 if (SvTYPE(sv) < SVt_PVIV)
4210 sv_upgrade(sv,SVt_PVIV);
4213 if (!SvLEN(sv)) { /* make copy of shared string */
4214 const char *pvx = SvPVX_const(sv);
4215 const STRLEN len = SvCUR(sv);
4216 SvGROW(sv, len + 1);
4217 Move(pvx,SvPVX(sv),len,char);
4221 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4222 and we do that anyway inside the SvNIOK_off
4224 SvFLAGS(sv) |= SVf_OOK;
4227 SvLEN_set(sv, SvLEN(sv) - delta);
4228 SvCUR_set(sv, SvCUR(sv) - delta);
4229 SvPV_set(sv, SvPVX(sv) + delta);
4230 SvIV_set(sv, SvIVX(sv) + delta);
4234 =for apidoc sv_catpvn
4236 Concatenates the string onto the end of the string which is in the SV. The
4237 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4238 status set, then the bytes appended should be valid UTF-8.
4239 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4241 =for apidoc sv_catpvn_flags
4243 Concatenates the string onto the end of the string which is in the SV. The
4244 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4245 status set, then the bytes appended should be valid UTF-8.
4246 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4247 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4248 in terms of this function.
4254 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4258 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4260 SvGROW(dsv, dlen + slen + 1);
4262 sstr = SvPVX_const(dsv);
4263 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4264 SvCUR_set(dsv, SvCUR(dsv) + slen);
4266 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4268 if (flags & SV_SMAGIC)
4273 =for apidoc sv_catsv
4275 Concatenates the string from SV C<ssv> onto the end of the string in
4276 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4277 not 'set' magic. See C<sv_catsv_mg>.
4279 =for apidoc sv_catsv_flags
4281 Concatenates the string from SV C<ssv> onto the end of the string in
4282 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4283 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4284 and C<sv_catsv_nomg> are implemented in terms of this function.
4289 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4294 const char *spv = SvPV_const(ssv, slen);
4296 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4297 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4298 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4299 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4300 dsv->sv_flags doesn't have that bit set.
4301 Andy Dougherty 12 Oct 2001
4303 const I32 sutf8 = DO_UTF8(ssv);
4306 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4308 dutf8 = DO_UTF8(dsv);
4310 if (dutf8 != sutf8) {
4312 /* Not modifying source SV, so taking a temporary copy. */
4313 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4315 sv_utf8_upgrade(csv);
4316 spv = SvPV_const(csv, slen);
4319 sv_utf8_upgrade_nomg(dsv);
4321 sv_catpvn_nomg(dsv, spv, slen);
4324 if (flags & SV_SMAGIC)
4329 =for apidoc sv_catpv
4331 Concatenates the string onto the end of the string which is in the SV.
4332 If the SV has the UTF-8 status set, then the bytes appended should be
4333 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4338 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4341 register STRLEN len;
4347 junk = SvPV_force(sv, tlen);
4349 SvGROW(sv, tlen + len + 1);
4351 ptr = SvPVX_const(sv);
4352 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4353 SvCUR_set(sv, SvCUR(sv) + len);
4354 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4359 =for apidoc sv_catpv_mg
4361 Like C<sv_catpv>, but also handles 'set' magic.
4367 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4376 Creates a new SV. A non-zero C<len> parameter indicates the number of
4377 bytes of preallocated string space the SV should have. An extra byte for a
4378 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4379 space is allocated.) The reference count for the new SV is set to 1.
4381 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4382 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4383 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4384 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4385 modules supporting older perls.
4391 Perl_newSV(pTHX_ STRLEN len)
4398 sv_upgrade(sv, SVt_PV);
4399 SvGROW(sv, len + 1);
4404 =for apidoc sv_magicext
4406 Adds magic to an SV, upgrading it if necessary. Applies the
4407 supplied vtable and returns a pointer to the magic added.
4409 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4410 In particular, you can add magic to SvREADONLY SVs, and add more than
4411 one instance of the same 'how'.
4413 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4414 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4415 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4416 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4418 (This is now used as a subroutine by C<sv_magic>.)
4423 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4424 const char* name, I32 namlen)
4429 SvUPGRADE(sv, SVt_PVMG);
4430 Newxz(mg, 1, MAGIC);
4431 mg->mg_moremagic = SvMAGIC(sv);
4432 SvMAGIC_set(sv, mg);
4434 /* Sometimes a magic contains a reference loop, where the sv and
4435 object refer to each other. To prevent a reference loop that
4436 would prevent such objects being freed, we look for such loops
4437 and if we find one we avoid incrementing the object refcount.
4439 Note we cannot do this to avoid self-tie loops as intervening RV must
4440 have its REFCNT incremented to keep it in existence.
4443 if (!obj || obj == sv ||
4444 how == PERL_MAGIC_arylen ||
4445 how == PERL_MAGIC_qr ||
4446 how == PERL_MAGIC_symtab ||
4447 (SvTYPE(obj) == SVt_PVGV &&
4448 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4449 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4450 GvFORM(obj) == (CV*)sv)))
4455 mg->mg_obj = SvREFCNT_inc_simple(obj);
4456 mg->mg_flags |= MGf_REFCOUNTED;
4459 /* Normal self-ties simply pass a null object, and instead of
4460 using mg_obj directly, use the SvTIED_obj macro to produce a
4461 new RV as needed. For glob "self-ties", we are tieing the PVIO
4462 with an RV obj pointing to the glob containing the PVIO. In
4463 this case, to avoid a reference loop, we need to weaken the
4467 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4468 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4474 mg->mg_len = namlen;
4477 mg->mg_ptr = savepvn(name, namlen);
4478 else if (namlen == HEf_SVKEY)
4479 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4481 mg->mg_ptr = (char *) name;
4483 mg->mg_virtual = (MGVTBL *) vtable;
4487 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4492 =for apidoc sv_magic
4494 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4495 then adds a new magic item of type C<how> to the head of the magic list.
4497 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4498 handling of the C<name> and C<namlen> arguments.
4500 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4501 to add more than one instance of the same 'how'.
4507 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4510 const MGVTBL *vtable;
4513 #ifdef PERL_OLD_COPY_ON_WRITE
4515 sv_force_normal_flags(sv, 0);
4517 if (SvREADONLY(sv)) {
4519 /* its okay to attach magic to shared strings; the subsequent
4520 * upgrade to PVMG will unshare the string */
4521 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4524 && how != PERL_MAGIC_regex_global
4525 && how != PERL_MAGIC_bm
4526 && how != PERL_MAGIC_fm
4527 && how != PERL_MAGIC_sv
4528 && how != PERL_MAGIC_backref
4531 Perl_croak(aTHX_ PL_no_modify);
4534 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4535 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4536 /* sv_magic() refuses to add a magic of the same 'how' as an
4539 if (how == PERL_MAGIC_taint) {
4541 /* Any scalar which already had taint magic on which someone
4542 (erroneously?) did SvIOK_on() or similar will now be
4543 incorrectly sporting public "OK" flags. */
4544 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4552 vtable = &PL_vtbl_sv;
4554 case PERL_MAGIC_overload:
4555 vtable = &PL_vtbl_amagic;
4557 case PERL_MAGIC_overload_elem:
4558 vtable = &PL_vtbl_amagicelem;
4560 case PERL_MAGIC_overload_table:
4561 vtable = &PL_vtbl_ovrld;
4564 vtable = &PL_vtbl_bm;
4566 case PERL_MAGIC_regdata:
4567 vtable = &PL_vtbl_regdata;
4569 case PERL_MAGIC_regdatum:
4570 vtable = &PL_vtbl_regdatum;
4572 case PERL_MAGIC_env:
4573 vtable = &PL_vtbl_env;
4576 vtable = &PL_vtbl_fm;
4578 case PERL_MAGIC_envelem:
4579 vtable = &PL_vtbl_envelem;
4581 case PERL_MAGIC_regex_global:
4582 vtable = &PL_vtbl_mglob;
4584 case PERL_MAGIC_isa:
4585 vtable = &PL_vtbl_isa;
4587 case PERL_MAGIC_isaelem:
4588 vtable = &PL_vtbl_isaelem;
4590 case PERL_MAGIC_nkeys:
4591 vtable = &PL_vtbl_nkeys;
4593 case PERL_MAGIC_dbfile:
4596 case PERL_MAGIC_dbline:
4597 vtable = &PL_vtbl_dbline;
4599 #ifdef USE_LOCALE_COLLATE
4600 case PERL_MAGIC_collxfrm:
4601 vtable = &PL_vtbl_collxfrm;
4603 #endif /* USE_LOCALE_COLLATE */
4604 case PERL_MAGIC_tied:
4605 vtable = &PL_vtbl_pack;
4607 case PERL_MAGIC_tiedelem:
4608 case PERL_MAGIC_tiedscalar:
4609 vtable = &PL_vtbl_packelem;
4612 vtable = &PL_vtbl_regexp;
4614 case PERL_MAGIC_hints:
4615 /* As this vtable is all NULL, we can reuse it. */
4616 case PERL_MAGIC_sig:
4617 vtable = &PL_vtbl_sig;
4619 case PERL_MAGIC_sigelem:
4620 vtable = &PL_vtbl_sigelem;
4622 case PERL_MAGIC_taint:
4623 vtable = &PL_vtbl_taint;
4625 case PERL_MAGIC_uvar:
4626 vtable = &PL_vtbl_uvar;
4628 case PERL_MAGIC_vec:
4629 vtable = &PL_vtbl_vec;
4631 case PERL_MAGIC_arylen_p:
4632 case PERL_MAGIC_rhash:
4633 case PERL_MAGIC_symtab:
4634 case PERL_MAGIC_vstring:
4637 case PERL_MAGIC_utf8:
4638 vtable = &PL_vtbl_utf8;
4640 case PERL_MAGIC_substr:
4641 vtable = &PL_vtbl_substr;
4643 case PERL_MAGIC_defelem:
4644 vtable = &PL_vtbl_defelem;
4646 case PERL_MAGIC_arylen:
4647 vtable = &PL_vtbl_arylen;
4649 case PERL_MAGIC_pos:
4650 vtable = &PL_vtbl_pos;
4652 case PERL_MAGIC_backref:
4653 vtable = &PL_vtbl_backref;
4655 case PERL_MAGIC_hintselem:
4656 vtable = &PL_vtbl_hintselem;
4658 case PERL_MAGIC_ext:
4659 /* Reserved for use by extensions not perl internals. */
4660 /* Useful for attaching extension internal data to perl vars. */
4661 /* Note that multiple extensions may clash if magical scalars */
4662 /* etc holding private data from one are passed to another. */
4666 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4669 /* Rest of work is done else where */
4670 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4673 case PERL_MAGIC_taint:
4676 case PERL_MAGIC_ext:
4677 case PERL_MAGIC_dbfile:
4684 =for apidoc sv_unmagic
4686 Removes all magic of type C<type> from an SV.
4692 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4696 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4698 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4699 for (mg = *mgp; mg; mg = *mgp) {
4700 if (mg->mg_type == type) {
4701 const MGVTBL* const vtbl = mg->mg_virtual;
4702 *mgp = mg->mg_moremagic;
4703 if (vtbl && vtbl->svt_free)
4704 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4705 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4707 Safefree(mg->mg_ptr);
4708 else if (mg->mg_len == HEf_SVKEY)
4709 SvREFCNT_dec((SV*)mg->mg_ptr);
4710 else if (mg->mg_type == PERL_MAGIC_utf8)
4711 Safefree(mg->mg_ptr);
4713 if (mg->mg_flags & MGf_REFCOUNTED)
4714 SvREFCNT_dec(mg->mg_obj);
4718 mgp = &mg->mg_moremagic;
4722 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4723 SvMAGIC_set(sv, NULL);
4730 =for apidoc sv_rvweaken
4732 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4733 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4734 push a back-reference to this RV onto the array of backreferences
4735 associated with that magic. If the RV is magical, set magic will be
4736 called after the RV is cleared.
4742 Perl_sv_rvweaken(pTHX_ SV *sv)
4745 if (!SvOK(sv)) /* let undefs pass */
4748 Perl_croak(aTHX_ "Can't weaken a nonreference");
4749 else if (SvWEAKREF(sv)) {
4750 if (ckWARN(WARN_MISC))
4751 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4755 Perl_sv_add_backref(aTHX_ tsv, sv);
4761 /* Give tsv backref magic if it hasn't already got it, then push a
4762 * back-reference to sv onto the array associated with the backref magic.
4766 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4771 if (SvTYPE(tsv) == SVt_PVHV) {
4772 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4776 /* There is no AV in the offical place - try a fixup. */
4777 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4780 /* Aha. They've got it stowed in magic. Bring it back. */
4781 av = (AV*)mg->mg_obj;
4782 /* Stop mg_free decreasing the refernce count. */
4784 /* Stop mg_free even calling the destructor, given that
4785 there's no AV to free up. */
4787 sv_unmagic(tsv, PERL_MAGIC_backref);
4791 SvREFCNT_inc_simple_void(av);
4796 const MAGIC *const mg
4797 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4799 av = (AV*)mg->mg_obj;
4803 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4804 /* av now has a refcnt of 2, which avoids it getting freed
4805 * before us during global cleanup. The extra ref is removed
4806 * by magic_killbackrefs() when tsv is being freed */
4809 if (AvFILLp(av) >= AvMAX(av)) {
4810 av_extend(av, AvFILLp(av)+1);
4812 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4815 /* delete a back-reference to ourselves from the backref magic associated
4816 * with the SV we point to.
4820 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4827 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4828 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4829 /* We mustn't attempt to "fix up" the hash here by moving the
4830 backreference array back to the hv_aux structure, as that is stored
4831 in the main HvARRAY(), and hfreentries assumes that no-one
4832 reallocates HvARRAY() while it is running. */
4835 const MAGIC *const mg
4836 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4838 av = (AV *)mg->mg_obj;
4841 if (PL_in_clean_all)
4843 Perl_croak(aTHX_ "panic: del_backref");
4850 /* We shouldn't be in here more than once, but for paranoia reasons lets
4852 for (i = AvFILLp(av); i >= 0; i--) {
4854 const SSize_t fill = AvFILLp(av);
4856 /* We weren't the last entry.
4857 An unordered list has this property that you can take the
4858 last element off the end to fill the hole, and it's still
4859 an unordered list :-)
4864 AvFILLp(av) = fill - 1;
4870 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4872 SV **svp = AvARRAY(av);
4874 PERL_UNUSED_ARG(sv);
4876 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4877 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4878 if (svp && !SvIS_FREED(av)) {
4879 SV *const *const last = svp + AvFILLp(av);
4881 while (svp <= last) {
4883 SV *const referrer = *svp;
4884 if (SvWEAKREF(referrer)) {
4885 /* XXX Should we check that it hasn't changed? */
4886 SvRV_set(referrer, 0);
4888 SvWEAKREF_off(referrer);
4889 SvSETMAGIC(referrer);
4890 } else if (SvTYPE(referrer) == SVt_PVGV ||
4891 SvTYPE(referrer) == SVt_PVLV) {
4892 /* You lookin' at me? */
4893 assert(GvSTASH(referrer));
4894 assert(GvSTASH(referrer) == (HV*)sv);
4895 GvSTASH(referrer) = 0;
4898 "panic: magic_killbackrefs (flags=%"UVxf")",
4899 (UV)SvFLAGS(referrer));
4907 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4912 =for apidoc sv_insert
4914 Inserts a string at the specified offset/length within the SV. Similar to
4915 the Perl substr() function.
4921 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4926 register char *midend;
4927 register char *bigend;
4933 Perl_croak(aTHX_ "Can't modify non-existent substring");
4934 SvPV_force(bigstr, curlen);
4935 (void)SvPOK_only_UTF8(bigstr);
4936 if (offset + len > curlen) {
4937 SvGROW(bigstr, offset+len+1);
4938 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4939 SvCUR_set(bigstr, offset+len);
4943 i = littlelen - len;
4944 if (i > 0) { /* string might grow */
4945 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4946 mid = big + offset + len;
4947 midend = bigend = big + SvCUR(bigstr);
4950 while (midend > mid) /* shove everything down */
4951 *--bigend = *--midend;
4952 Move(little,big+offset,littlelen,char);
4953 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4958 Move(little,SvPVX(bigstr)+offset,len,char);
4963 big = SvPVX(bigstr);
4966 bigend = big + SvCUR(bigstr);
4968 if (midend > bigend)
4969 Perl_croak(aTHX_ "panic: sv_insert");
4971 if (mid - big > bigend - midend) { /* faster to shorten from end */
4973 Move(little, mid, littlelen,char);
4976 i = bigend - midend;
4978 Move(midend, mid, i,char);
4982 SvCUR_set(bigstr, mid - big);
4984 else if ((i = mid - big)) { /* faster from front */
4985 midend -= littlelen;
4987 sv_chop(bigstr,midend-i);
4992 Move(little, mid, littlelen,char);
4994 else if (littlelen) {
4995 midend -= littlelen;
4996 sv_chop(bigstr,midend);
4997 Move(little,midend,littlelen,char);
5000 sv_chop(bigstr,midend);
5006 =for apidoc sv_replace
5008 Make the first argument a copy of the second, then delete the original.
5009 The target SV physically takes over ownership of the body of the source SV
5010 and inherits its flags; however, the target keeps any magic it owns,
5011 and any magic in the source is discarded.
5012 Note that this is a rather specialist SV copying operation; most of the
5013 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5019 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5022 const U32 refcnt = SvREFCNT(sv);
5023 SV_CHECK_THINKFIRST_COW_DROP(sv);
5024 if (SvREFCNT(nsv) != 1) {
5025 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5026 UVuf " != 1)", (UV) SvREFCNT(nsv));
5028 if (SvMAGICAL(sv)) {
5032 sv_upgrade(nsv, SVt_PVMG);
5033 SvMAGIC_set(nsv, SvMAGIC(sv));
5034 SvFLAGS(nsv) |= SvMAGICAL(sv);
5036 SvMAGIC_set(sv, NULL);
5040 assert(!SvREFCNT(sv));
5041 #ifdef DEBUG_LEAKING_SCALARS
5042 sv->sv_flags = nsv->sv_flags;
5043 sv->sv_any = nsv->sv_any;
5044 sv->sv_refcnt = nsv->sv_refcnt;
5045 sv->sv_u = nsv->sv_u;
5047 StructCopy(nsv,sv,SV);
5049 /* Currently could join these into one piece of pointer arithmetic, but
5050 it would be unclear. */
5051 if(SvTYPE(sv) == SVt_IV)
5053 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5054 else if (SvTYPE(sv) == SVt_RV) {
5055 SvANY(sv) = &sv->sv_u.svu_rv;
5059 #ifdef PERL_OLD_COPY_ON_WRITE
5060 if (SvIsCOW_normal(nsv)) {
5061 /* We need to follow the pointers around the loop to make the
5062 previous SV point to sv, rather than nsv. */
5065 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5068 assert(SvPVX_const(current) == SvPVX_const(nsv));
5070 /* Make the SV before us point to the SV after us. */
5072 PerlIO_printf(Perl_debug_log, "previous is\n");
5074 PerlIO_printf(Perl_debug_log,
5075 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5076 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5078 SV_COW_NEXT_SV_SET(current, sv);
5081 SvREFCNT(sv) = refcnt;
5082 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5088 =for apidoc sv_clear
5090 Clear an SV: call any destructors, free up any memory used by the body,
5091 and free the body itself. The SV's head is I<not> freed, although
5092 its type is set to all 1's so that it won't inadvertently be assumed
5093 to be live during global destruction etc.
5094 This function should only be called when REFCNT is zero. Most of the time
5095 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5102 Perl_sv_clear(pTHX_ register SV *sv)
5105 const U32 type = SvTYPE(sv);
5106 const struct body_details *const sv_type_details
5107 = bodies_by_type + type;
5111 assert(SvREFCNT(sv) == 0);
5113 if (type <= SVt_IV) {
5114 /* See the comment in sv.h about the collusion between this early
5115 return and the overloading of the NULL and IV slots in the size
5121 if (PL_defstash && /* Still have a symbol table? */
5128 stash = SvSTASH(sv);
5129 destructor = StashHANDLER(stash,DESTROY);
5131 SV* const tmpref = newRV(sv);
5132 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5134 PUSHSTACKi(PERLSI_DESTROY);
5139 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5145 if(SvREFCNT(tmpref) < 2) {
5146 /* tmpref is not kept alive! */
5148 SvRV_set(tmpref, NULL);
5151 SvREFCNT_dec(tmpref);
5153 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5157 if (PL_in_clean_objs)
5158 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5160 /* DESTROY gave object new lease on life */
5166 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5167 SvOBJECT_off(sv); /* Curse the object. */
5168 if (type != SVt_PVIO)
5169 --PL_sv_objcount; /* XXX Might want something more general */
5172 if (type >= SVt_PVMG) {
5173 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5174 SvREFCNT_dec(SvOURSTASH(sv));
5175 } else if (SvMAGIC(sv))
5177 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5178 SvREFCNT_dec(SvSTASH(sv));
5181 /* case SVt_BIND: */
5184 IoIFP(sv) != PerlIO_stdin() &&
5185 IoIFP(sv) != PerlIO_stdout() &&
5186 IoIFP(sv) != PerlIO_stderr())
5188 io_close((IO*)sv, FALSE);
5190 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5191 PerlDir_close(IoDIRP(sv));
5192 IoDIRP(sv) = (DIR*)NULL;
5193 Safefree(IoTOP_NAME(sv));
5194 Safefree(IoFMT_NAME(sv));
5195 Safefree(IoBOTTOM_NAME(sv));
5202 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5206 if (PL_comppad == (AV*)sv) {
5213 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5214 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5215 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5216 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5218 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5219 SvREFCNT_dec(LvTARG(sv));
5221 if (isGV_with_GP(sv)) {
5222 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5223 mro_method_changed_in(stash);
5226 unshare_hek(GvNAME_HEK(sv));
5227 /* If we're in a stash, we don't own a reference to it. However it does
5228 have a back reference to us, which needs to be cleared. */
5229 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5230 sv_del_backref((SV*)stash, sv);
5232 /* FIXME. There are probably more unreferenced pointers to SVs in the
5233 interpreter struct that we should check and tidy in a similar
5235 if ((GV*)sv == PL_last_in_gv)
5236 PL_last_in_gv = NULL;
5241 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5243 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5244 /* Don't even bother with turning off the OOK flag. */
5249 SV * const target = SvRV(sv);
5251 sv_del_backref(target, sv);
5253 SvREFCNT_dec(target);
5255 #ifdef PERL_OLD_COPY_ON_WRITE
5256 else if (SvPVX_const(sv)) {
5258 /* I believe I need to grab the global SV mutex here and
5259 then recheck the COW status. */
5261 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5265 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5267 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5270 /* And drop it here. */
5272 } else if (SvLEN(sv)) {
5273 Safefree(SvPVX_const(sv));
5277 else if (SvPVX_const(sv) && SvLEN(sv))
5278 Safefree(SvPVX_mutable(sv));
5279 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5280 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5289 SvFLAGS(sv) &= SVf_BREAK;
5290 SvFLAGS(sv) |= SVTYPEMASK;
5292 if (sv_type_details->arena) {
5293 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5294 &PL_body_roots[type]);
5296 else if (sv_type_details->body_size) {
5297 my_safefree(SvANY(sv));
5302 =for apidoc sv_newref
5304 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5311 Perl_sv_newref(pTHX_ SV *sv)
5313 PERL_UNUSED_CONTEXT;
5322 Decrement an SV's reference count, and if it drops to zero, call
5323 C<sv_clear> to invoke destructors and free up any memory used by
5324 the body; finally, deallocate the SV's head itself.
5325 Normally called via a wrapper macro C<SvREFCNT_dec>.
5331 Perl_sv_free(pTHX_ SV *sv)
5336 if (SvREFCNT(sv) == 0) {
5337 if (SvFLAGS(sv) & SVf_BREAK)
5338 /* this SV's refcnt has been artificially decremented to
5339 * trigger cleanup */
5341 if (PL_in_clean_all) /* All is fair */
5343 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5344 /* make sure SvREFCNT(sv)==0 happens very seldom */
5345 SvREFCNT(sv) = (~(U32)0)/2;
5348 if (ckWARN_d(WARN_INTERNAL)) {
5349 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5350 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5351 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5352 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5353 Perl_dump_sv_child(aTHX_ sv);
5355 #ifdef DEBUG_LEAKING_SCALARS
5362 if (--(SvREFCNT(sv)) > 0)
5364 Perl_sv_free2(aTHX_ sv);
5368 Perl_sv_free2(pTHX_ SV *sv)
5373 if (ckWARN_d(WARN_DEBUGGING))
5374 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5375 "Attempt to free temp prematurely: SV 0x%"UVxf
5376 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5380 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5381 /* make sure SvREFCNT(sv)==0 happens very seldom */
5382 SvREFCNT(sv) = (~(U32)0)/2;
5393 Returns the length of the string in the SV. Handles magic and type
5394 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5400 Perl_sv_len(pTHX_ register SV *sv)
5408 len = mg_length(sv);
5410 (void)SvPV_const(sv, len);
5415 =for apidoc sv_len_utf8
5417 Returns the number of characters in the string in an SV, counting wide
5418 UTF-8 bytes as a single character. Handles magic and type coercion.
5424 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5425 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5426 * (Note that the mg_len is not the length of the mg_ptr field.
5427 * This allows the cache to store the character length of the string without
5428 * needing to malloc() extra storage to attach to the mg_ptr.)
5433 Perl_sv_len_utf8(pTHX_ register SV *sv)
5439 return mg_length(sv);
5443 const U8 *s = (U8*)SvPV_const(sv, len);
5447 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5449 if (mg && mg->mg_len != -1) {
5451 if (PL_utf8cache < 0) {
5452 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5454 /* Need to turn the assertions off otherwise we may
5455 recurse infinitely while printing error messages.
5457 SAVEI8(PL_utf8cache);
5459 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5460 " real %"UVuf" for %"SVf,
5461 (UV) ulen, (UV) real, SVfARG(sv));
5466 ulen = Perl_utf8_length(aTHX_ s, s + len);
5467 if (!SvREADONLY(sv)) {
5469 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5470 &PL_vtbl_utf8, 0, 0);
5478 return Perl_utf8_length(aTHX_ s, s + len);
5482 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5485 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5488 const U8 *s = start;
5490 while (s < send && uoffset--)
5493 /* This is the existing behaviour. Possibly it should be a croak, as
5494 it's actually a bounds error */
5500 /* Given the length of the string in both bytes and UTF-8 characters, decide
5501 whether to walk forwards or backwards to find the byte corresponding to
5502 the passed in UTF-8 offset. */
5504 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5505 STRLEN uoffset, STRLEN uend)
5507 STRLEN backw = uend - uoffset;
5508 if (uoffset < 2 * backw) {
5509 /* The assumption is that going forwards is twice the speed of going
5510 forward (that's where the 2 * backw comes from).
5511 (The real figure of course depends on the UTF-8 data.) */
5512 return sv_pos_u2b_forwards(start, send, uoffset);
5517 while (UTF8_IS_CONTINUATION(*send))
5520 return send - start;
5523 /* For the string representation of the given scalar, find the byte
5524 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5525 give another position in the string, *before* the sought offset, which
5526 (which is always true, as 0, 0 is a valid pair of positions), which should
5527 help reduce the amount of linear searching.
5528 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5529 will be used to reduce the amount of linear searching. The cache will be
5530 created if necessary, and the found value offered to it for update. */
5532 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5533 const U8 *const send, STRLEN uoffset,
5534 STRLEN uoffset0, STRLEN boffset0) {
5535 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5538 assert (uoffset >= uoffset0);
5540 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5541 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5542 if ((*mgp)->mg_ptr) {
5543 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5544 if (cache[0] == uoffset) {
5545 /* An exact match. */
5548 if (cache[2] == uoffset) {
5549 /* An exact match. */
5553 if (cache[0] < uoffset) {
5554 /* The cache already knows part of the way. */
5555 if (cache[0] > uoffset0) {
5556 /* The cache knows more than the passed in pair */
5557 uoffset0 = cache[0];
5558 boffset0 = cache[1];
5560 if ((*mgp)->mg_len != -1) {
5561 /* And we know the end too. */
5563 + sv_pos_u2b_midway(start + boffset0, send,
5565 (*mgp)->mg_len - uoffset0);
5568 + sv_pos_u2b_forwards(start + boffset0,
5569 send, uoffset - uoffset0);
5572 else if (cache[2] < uoffset) {
5573 /* We're between the two cache entries. */
5574 if (cache[2] > uoffset0) {
5575 /* and the cache knows more than the passed in pair */
5576 uoffset0 = cache[2];
5577 boffset0 = cache[3];
5581 + sv_pos_u2b_midway(start + boffset0,
5584 cache[0] - uoffset0);
5587 + sv_pos_u2b_midway(start + boffset0,
5590 cache[2] - uoffset0);
5594 else if ((*mgp)->mg_len != -1) {
5595 /* If we can take advantage of a passed in offset, do so. */
5596 /* In fact, offset0 is either 0, or less than offset, so don't
5597 need to worry about the other possibility. */
5599 + sv_pos_u2b_midway(start + boffset0, send,
5601 (*mgp)->mg_len - uoffset0);
5606 if (!found || PL_utf8cache < 0) {
5607 const STRLEN real_boffset
5608 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5609 send, uoffset - uoffset0);
5611 if (found && PL_utf8cache < 0) {
5612 if (real_boffset != boffset) {
5613 /* Need to turn the assertions off otherwise we may recurse
5614 infinitely while printing error messages. */
5615 SAVEI8(PL_utf8cache);
5617 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5618 " real %"UVuf" for %"SVf,
5619 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5622 boffset = real_boffset;
5625 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5631 =for apidoc sv_pos_u2b
5633 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5634 the start of the string, to a count of the equivalent number of bytes; if
5635 lenp is non-zero, it does the same to lenp, but this time starting from
5636 the offset, rather than from the start of the string. Handles magic and
5643 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5644 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5645 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5650 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5658 start = (U8*)SvPV_const(sv, len);
5660 STRLEN uoffset = (STRLEN) *offsetp;
5661 const U8 * const send = start + len;
5663 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5666 *offsetp = (I32) boffset;
5669 /* Convert the relative offset to absolute. */
5670 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5671 const STRLEN boffset2
5672 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5673 uoffset, boffset) - boffset;
5687 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5688 byte length pairing. The (byte) length of the total SV is passed in too,
5689 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5690 may not have updated SvCUR, so we can't rely on reading it directly.
5692 The proffered utf8/byte length pairing isn't used if the cache already has
5693 two pairs, and swapping either for the proffered pair would increase the
5694 RMS of the intervals between known byte offsets.
5696 The cache itself consists of 4 STRLEN values
5697 0: larger UTF-8 offset
5698 1: corresponding byte offset
5699 2: smaller UTF-8 offset
5700 3: corresponding byte offset
5702 Unused cache pairs have the value 0, 0.
5703 Keeping the cache "backwards" means that the invariant of
5704 cache[0] >= cache[2] is maintained even with empty slots, which means that
5705 the code that uses it doesn't need to worry if only 1 entry has actually
5706 been set to non-zero. It also makes the "position beyond the end of the
5707 cache" logic much simpler, as the first slot is always the one to start
5711 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5719 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5721 (*mgp)->mg_len = -1;
5725 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5726 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5727 (*mgp)->mg_ptr = (char *) cache;
5731 if (PL_utf8cache < 0) {
5732 const U8 *start = (const U8 *) SvPVX_const(sv);
5733 const STRLEN realutf8 = utf8_length(start, start + byte);
5735 if (realutf8 != utf8) {
5736 /* Need to turn the assertions off otherwise we may recurse
5737 infinitely while printing error messages. */
5738 SAVEI8(PL_utf8cache);
5740 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5741 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5745 /* Cache is held with the later position first, to simplify the code
5746 that deals with unbounded ends. */
5748 ASSERT_UTF8_CACHE(cache);
5749 if (cache[1] == 0) {
5750 /* Cache is totally empty */
5753 } else if (cache[3] == 0) {
5754 if (byte > cache[1]) {
5755 /* New one is larger, so goes first. */
5756 cache[2] = cache[0];
5757 cache[3] = cache[1];
5765 #define THREEWAY_SQUARE(a,b,c,d) \
5766 ((float)((d) - (c))) * ((float)((d) - (c))) \
5767 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5768 + ((float)((b) - (a))) * ((float)((b) - (a)))
5770 /* Cache has 2 slots in use, and we know three potential pairs.
5771 Keep the two that give the lowest RMS distance. Do the
5772 calcualation in bytes simply because we always know the byte
5773 length. squareroot has the same ordering as the positive value,
5774 so don't bother with the actual square root. */
5775 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5776 if (byte > cache[1]) {
5777 /* New position is after the existing pair of pairs. */
5778 const float keep_earlier
5779 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5780 const float keep_later
5781 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5783 if (keep_later < keep_earlier) {
5784 if (keep_later < existing) {
5785 cache[2] = cache[0];
5786 cache[3] = cache[1];
5792 if (keep_earlier < existing) {
5798 else if (byte > cache[3]) {
5799 /* New position is between the existing pair of pairs. */
5800 const float keep_earlier
5801 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5802 const float keep_later
5803 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5805 if (keep_later < keep_earlier) {
5806 if (keep_later < existing) {
5812 if (keep_earlier < existing) {
5819 /* New position is before the existing pair of pairs. */
5820 const float keep_earlier
5821 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5822 const float keep_later
5823 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5825 if (keep_later < keep_earlier) {
5826 if (keep_later < existing) {
5832 if (keep_earlier < existing) {
5833 cache[0] = cache[2];
5834 cache[1] = cache[3];
5841 ASSERT_UTF8_CACHE(cache);
5844 /* We already know all of the way, now we may be able to walk back. The same
5845 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5846 backward is half the speed of walking forward. */
5848 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5851 const STRLEN forw = target - s;
5852 STRLEN backw = end - target;
5854 if (forw < 2 * backw) {
5855 return utf8_length(s, target);
5858 while (end > target) {
5860 while (UTF8_IS_CONTINUATION(*end)) {
5869 =for apidoc sv_pos_b2u
5871 Converts the value pointed to by offsetp from a count of bytes from the
5872 start of the string, to a count of the equivalent number of UTF-8 chars.
5873 Handles magic and type coercion.
5879 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5880 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5885 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5888 const STRLEN byte = *offsetp;
5889 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5898 s = (const U8*)SvPV_const(sv, blen);
5901 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5905 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5906 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5908 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5909 if (cache[1] == byte) {
5910 /* An exact match. */
5911 *offsetp = cache[0];
5914 if (cache[3] == byte) {
5915 /* An exact match. */
5916 *offsetp = cache[2];
5920 if (cache[1] < byte) {
5921 /* We already know part of the way. */
5922 if (mg->mg_len != -1) {
5923 /* Actually, we know the end too. */
5925 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5926 s + blen, mg->mg_len - cache[0]);
5928 len = cache[0] + utf8_length(s + cache[1], send);
5931 else if (cache[3] < byte) {
5932 /* We're between the two cached pairs, so we do the calculation
5933 offset by the byte/utf-8 positions for the earlier pair,
5934 then add the utf-8 characters from the string start to
5936 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5937 s + cache[1], cache[0] - cache[2])
5941 else { /* cache[3] > byte */
5942 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5946 ASSERT_UTF8_CACHE(cache);
5948 } else if (mg->mg_len != -1) {
5949 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5953 if (!found || PL_utf8cache < 0) {
5954 const STRLEN real_len = utf8_length(s, send);
5956 if (found && PL_utf8cache < 0) {
5957 if (len != real_len) {
5958 /* Need to turn the assertions off otherwise we may recurse
5959 infinitely while printing error messages. */
5960 SAVEI8(PL_utf8cache);
5962 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5963 " real %"UVuf" for %"SVf,
5964 (UV) len, (UV) real_len, SVfARG(sv));
5971 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5977 Returns a boolean indicating whether the strings in the two SVs are
5978 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5979 coerce its args to strings if necessary.
5985 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5994 SV* svrecode = NULL;
6001 /* if pv1 and pv2 are the same, second SvPV_const call may
6002 * invalidate pv1, so we may need to make a copy */
6003 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6004 pv1 = SvPV_const(sv1, cur1);
6005 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
6006 if (SvUTF8(sv2)) SvUTF8_on(sv1);
6008 pv1 = SvPV_const(sv1, cur1);
6016 pv2 = SvPV_const(sv2, cur2);
6018 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6019 /* Differing utf8ness.
6020 * Do not UTF8size the comparands as a side-effect. */
6023 svrecode = newSVpvn(pv2, cur2);
6024 sv_recode_to_utf8(svrecode, PL_encoding);
6025 pv2 = SvPV_const(svrecode, cur2);
6028 svrecode = newSVpvn(pv1, cur1);
6029 sv_recode_to_utf8(svrecode, PL_encoding);
6030 pv1 = SvPV_const(svrecode, cur1);
6032 /* Now both are in UTF-8. */
6034 SvREFCNT_dec(svrecode);
6039 bool is_utf8 = TRUE;
6042 /* sv1 is the UTF-8 one,
6043 * if is equal it must be downgrade-able */
6044 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6050 /* sv2 is the UTF-8 one,
6051 * if is equal it must be downgrade-able */
6052 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6058 /* Downgrade not possible - cannot be eq */
6066 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6068 SvREFCNT_dec(svrecode);
6078 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6079 string in C<sv1> is less than, equal to, or greater than the string in
6080 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6081 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6087 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6091 const char *pv1, *pv2;
6094 SV *svrecode = NULL;
6101 pv1 = SvPV_const(sv1, cur1);
6108 pv2 = SvPV_const(sv2, cur2);
6110 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6111 /* Differing utf8ness.
6112 * Do not UTF8size the comparands as a side-effect. */
6115 svrecode = newSVpvn(pv2, cur2);
6116 sv_recode_to_utf8(svrecode, PL_encoding);
6117 pv2 = SvPV_const(svrecode, cur2);
6120 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6125 svrecode = newSVpvn(pv1, cur1);
6126 sv_recode_to_utf8(svrecode, PL_encoding);
6127 pv1 = SvPV_const(svrecode, cur1);
6130 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6136 cmp = cur2 ? -1 : 0;
6140 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6143 cmp = retval < 0 ? -1 : 1;
6144 } else if (cur1 == cur2) {
6147 cmp = cur1 < cur2 ? -1 : 1;
6151 SvREFCNT_dec(svrecode);
6159 =for apidoc sv_cmp_locale
6161 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6162 'use bytes' aware, handles get magic, and will coerce its args to strings
6163 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6169 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6172 #ifdef USE_LOCALE_COLLATE
6178 if (PL_collation_standard)
6182 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6184 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6186 if (!pv1 || !len1) {
6197 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6200 return retval < 0 ? -1 : 1;
6203 * When the result of collation is equality, that doesn't mean
6204 * that there are no differences -- some locales exclude some
6205 * characters from consideration. So to avoid false equalities,
6206 * we use the raw string as a tiebreaker.
6212 #endif /* USE_LOCALE_COLLATE */
6214 return sv_cmp(sv1, sv2);
6218 #ifdef USE_LOCALE_COLLATE
6221 =for apidoc sv_collxfrm
6223 Add Collate Transform magic to an SV if it doesn't already have it.
6225 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6226 scalar data of the variable, but transformed to such a format that a normal
6227 memory comparison can be used to compare the data according to the locale
6234 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6239 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6240 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6246 Safefree(mg->mg_ptr);
6247 s = SvPV_const(sv, len);
6248 if ((xf = mem_collxfrm(s, len, &xlen))) {
6249 if (SvREADONLY(sv)) {
6252 return xf + sizeof(PL_collation_ix);
6255 #ifdef PERL_OLD_COPY_ON_WRITE
6257 sv_force_normal_flags(sv, 0);
6259 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6273 if (mg && mg->mg_ptr) {
6275 return mg->mg_ptr + sizeof(PL_collation_ix);
6283 #endif /* USE_LOCALE_COLLATE */
6288 Get a line from the filehandle and store it into the SV, optionally
6289 appending to the currently-stored string.
6295 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6300 register STDCHAR rslast;
6301 register STDCHAR *bp;
6306 if (SvTHINKFIRST(sv))
6307 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6308 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6310 However, perlbench says it's slower, because the existing swipe code
6311 is faster than copy on write.
6312 Swings and roundabouts. */
6313 SvUPGRADE(sv, SVt_PV);
6318 if (PerlIO_isutf8(fp)) {
6320 sv_utf8_upgrade_nomg(sv);
6321 sv_pos_u2b(sv,&append,0);
6323 } else if (SvUTF8(sv)) {
6324 SV * const tsv = newSV(0);
6325 sv_gets(tsv, fp, 0);
6326 sv_utf8_upgrade_nomg(tsv);
6327 SvCUR_set(sv,append);
6330 goto return_string_or_null;
6335 if (PerlIO_isutf8(fp))
6338 if (IN_PERL_COMPILETIME) {
6339 /* we always read code in line mode */
6343 else if (RsSNARF(PL_rs)) {
6344 /* If it is a regular disk file use size from stat() as estimate
6345 of amount we are going to read -- may result in mallocing
6346 more memory than we really need if the layers below reduce
6347 the size we read (e.g. CRLF or a gzip layer).
6350 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6351 const Off_t offset = PerlIO_tell(fp);
6352 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6353 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6359 else if (RsRECORD(PL_rs)) {
6364 /* Grab the size of the record we're getting */
6365 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6366 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6369 /* VMS wants read instead of fread, because fread doesn't respect */
6370 /* RMS record boundaries. This is not necessarily a good thing to be */
6371 /* doing, but we've got no other real choice - except avoid stdio
6372 as implementation - perhaps write a :vms layer ?
6374 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6376 bytesread = PerlIO_read(fp, buffer, recsize);
6380 SvCUR_set(sv, bytesread += append);
6381 buffer[bytesread] = '\0';
6382 goto return_string_or_null;
6384 else if (RsPARA(PL_rs)) {
6390 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6391 if (PerlIO_isutf8(fp)) {
6392 rsptr = SvPVutf8(PL_rs, rslen);
6395 if (SvUTF8(PL_rs)) {
6396 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6397 Perl_croak(aTHX_ "Wide character in $/");
6400 rsptr = SvPV_const(PL_rs, rslen);
6404 rslast = rslen ? rsptr[rslen - 1] : '\0';
6406 if (rspara) { /* have to do this both before and after */
6407 do { /* to make sure file boundaries work right */
6410 i = PerlIO_getc(fp);
6414 PerlIO_ungetc(fp,i);
6420 /* See if we know enough about I/O mechanism to cheat it ! */
6422 /* This used to be #ifdef test - it is made run-time test for ease
6423 of abstracting out stdio interface. One call should be cheap
6424 enough here - and may even be a macro allowing compile
6428 if (PerlIO_fast_gets(fp)) {
6431 * We're going to steal some values from the stdio struct
6432 * and put EVERYTHING in the innermost loop into registers.
6434 register STDCHAR *ptr;
6438 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6439 /* An ungetc()d char is handled separately from the regular
6440 * buffer, so we getc() it back out and stuff it in the buffer.
6442 i = PerlIO_getc(fp);
6443 if (i == EOF) return 0;
6444 *(--((*fp)->_ptr)) = (unsigned char) i;
6448 /* Here is some breathtakingly efficient cheating */
6450 cnt = PerlIO_get_cnt(fp); /* get count into register */
6451 /* make sure we have the room */
6452 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6453 /* Not room for all of it
6454 if we are looking for a separator and room for some
6456 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6457 /* just process what we have room for */
6458 shortbuffered = cnt - SvLEN(sv) + append + 1;
6459 cnt -= shortbuffered;
6463 /* remember that cnt can be negative */
6464 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6469 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6470 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6471 DEBUG_P(PerlIO_printf(Perl_debug_log,
6472 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6475 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6476 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6481 while (cnt > 0) { /* this | eat */
6483 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6484 goto thats_all_folks; /* screams | sed :-) */
6488 Copy(ptr, bp, cnt, char); /* this | eat */
6489 bp += cnt; /* screams | dust */
6490 ptr += cnt; /* louder | sed :-) */
6495 if (shortbuffered) { /* oh well, must extend */
6496 cnt = shortbuffered;
6498 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6500 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6501 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6505 DEBUG_P(PerlIO_printf(Perl_debug_log,
6506 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6507 PTR2UV(ptr),(long)cnt));
6508 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6510 DEBUG_P(PerlIO_printf(Perl_debug_log,
6511 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6512 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6513 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6515 /* This used to call 'filbuf' in stdio form, but as that behaves like
6516 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6517 another abstraction. */
6518 i = PerlIO_getc(fp); /* get more characters */
6520 DEBUG_P(PerlIO_printf(Perl_debug_log,
6521 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6522 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6523 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6525 cnt = PerlIO_get_cnt(fp);
6526 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6527 DEBUG_P(PerlIO_printf(Perl_debug_log,
6528 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6530 if (i == EOF) /* all done for ever? */
6531 goto thats_really_all_folks;
6533 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6535 SvGROW(sv, bpx + cnt + 2);
6536 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6538 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6540 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6541 goto thats_all_folks;
6545 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6546 memNE((char*)bp - rslen, rsptr, rslen))
6547 goto screamer; /* go back to the fray */
6548 thats_really_all_folks:
6550 cnt += shortbuffered;
6551 DEBUG_P(PerlIO_printf(Perl_debug_log,
6552 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6553 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6554 DEBUG_P(PerlIO_printf(Perl_debug_log,
6555 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6556 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6557 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6559 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6560 DEBUG_P(PerlIO_printf(Perl_debug_log,
6561 "Screamer: done, len=%ld, string=|%.*s|\n",
6562 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6566 /*The big, slow, and stupid way. */
6567 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6568 STDCHAR *buf = NULL;
6569 Newx(buf, 8192, STDCHAR);
6577 register const STDCHAR * const bpe = buf + sizeof(buf);
6579 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6580 ; /* keep reading */
6584 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6585 /* Accomodate broken VAXC compiler, which applies U8 cast to
6586 * both args of ?: operator, causing EOF to change into 255
6589 i = (U8)buf[cnt - 1];
6595 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6597 sv_catpvn(sv, (char *) buf, cnt);
6599 sv_setpvn(sv, (char *) buf, cnt);
6601 if (i != EOF && /* joy */
6603 SvCUR(sv) < rslen ||
6604 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6608 * If we're reading from a TTY and we get a short read,
6609 * indicating that the user hit his EOF character, we need
6610 * to notice it now, because if we try to read from the TTY
6611 * again, the EOF condition will disappear.
6613 * The comparison of cnt to sizeof(buf) is an optimization
6614 * that prevents unnecessary calls to feof().
6618 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6622 #ifdef USE_HEAP_INSTEAD_OF_STACK
6627 if (rspara) { /* have to do this both before and after */
6628 while (i != EOF) { /* to make sure file boundaries work right */
6629 i = PerlIO_getc(fp);
6631 PerlIO_ungetc(fp,i);
6637 return_string_or_null:
6638 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6644 Auto-increment of the value in the SV, doing string to numeric conversion
6645 if necessary. Handles 'get' magic.
6651 Perl_sv_inc(pTHX_ register SV *sv)
6660 if (SvTHINKFIRST(sv)) {
6662 sv_force_normal_flags(sv, 0);
6663 if (SvREADONLY(sv)) {
6664 if (IN_PERL_RUNTIME)
6665 Perl_croak(aTHX_ PL_no_modify);
6669 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6671 i = PTR2IV(SvRV(sv));
6676 flags = SvFLAGS(sv);
6677 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6678 /* It's (privately or publicly) a float, but not tested as an
6679 integer, so test it to see. */
6681 flags = SvFLAGS(sv);
6683 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6684 /* It's publicly an integer, or privately an integer-not-float */
6685 #ifdef PERL_PRESERVE_IVUV
6689 if (SvUVX(sv) == UV_MAX)
6690 sv_setnv(sv, UV_MAX_P1);
6692 (void)SvIOK_only_UV(sv);
6693 SvUV_set(sv, SvUVX(sv) + 1);
6695 if (SvIVX(sv) == IV_MAX)
6696 sv_setuv(sv, (UV)IV_MAX + 1);
6698 (void)SvIOK_only(sv);
6699 SvIV_set(sv, SvIVX(sv) + 1);
6704 if (flags & SVp_NOK) {
6705 (void)SvNOK_only(sv);
6706 SvNV_set(sv, SvNVX(sv) + 1.0);
6710 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6711 if ((flags & SVTYPEMASK) < SVt_PVIV)
6712 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6713 (void)SvIOK_only(sv);
6718 while (isALPHA(*d)) d++;
6719 while (isDIGIT(*d)) d++;
6721 #ifdef PERL_PRESERVE_IVUV
6722 /* Got to punt this as an integer if needs be, but we don't issue
6723 warnings. Probably ought to make the sv_iv_please() that does
6724 the conversion if possible, and silently. */
6725 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6726 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6727 /* Need to try really hard to see if it's an integer.
6728 9.22337203685478e+18 is an integer.
6729 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6730 so $a="9.22337203685478e+18"; $a+0; $a++
6731 needs to be the same as $a="9.22337203685478e+18"; $a++
6738 /* sv_2iv *should* have made this an NV */
6739 if (flags & SVp_NOK) {
6740 (void)SvNOK_only(sv);
6741 SvNV_set(sv, SvNVX(sv) + 1.0);
6744 /* I don't think we can get here. Maybe I should assert this
6745 And if we do get here I suspect that sv_setnv will croak. NWC
6747 #if defined(USE_LONG_DOUBLE)
6748 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",
6749 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6751 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6752 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6755 #endif /* PERL_PRESERVE_IVUV */
6756 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6760 while (d >= SvPVX_const(sv)) {
6768 /* MKS: The original code here died if letters weren't consecutive.
6769 * at least it didn't have to worry about non-C locales. The
6770 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6771 * arranged in order (although not consecutively) and that only
6772 * [A-Za-z] are accepted by isALPHA in the C locale.
6774 if (*d != 'z' && *d != 'Z') {
6775 do { ++*d; } while (!isALPHA(*d));
6778 *(d--) -= 'z' - 'a';
6783 *(d--) -= 'z' - 'a' + 1;
6787 /* oh,oh, the number grew */
6788 SvGROW(sv, SvCUR(sv) + 2);
6789 SvCUR_set(sv, SvCUR(sv) + 1);
6790 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6801 Auto-decrement of the value in the SV, doing string to numeric conversion
6802 if necessary. Handles 'get' magic.
6808 Perl_sv_dec(pTHX_ register SV *sv)
6816 if (SvTHINKFIRST(sv)) {
6818 sv_force_normal_flags(sv, 0);
6819 if (SvREADONLY(sv)) {
6820 if (IN_PERL_RUNTIME)
6821 Perl_croak(aTHX_ PL_no_modify);
6825 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6827 i = PTR2IV(SvRV(sv));
6832 /* Unlike sv_inc we don't have to worry about string-never-numbers
6833 and keeping them magic. But we mustn't warn on punting */
6834 flags = SvFLAGS(sv);
6835 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6836 /* It's publicly an integer, or privately an integer-not-float */
6837 #ifdef PERL_PRESERVE_IVUV
6841 if (SvUVX(sv) == 0) {
6842 (void)SvIOK_only(sv);
6846 (void)SvIOK_only_UV(sv);
6847 SvUV_set(sv, SvUVX(sv) - 1);
6850 if (SvIVX(sv) == IV_MIN)
6851 sv_setnv(sv, (NV)IV_MIN - 1.0);
6853 (void)SvIOK_only(sv);
6854 SvIV_set(sv, SvIVX(sv) - 1);
6859 if (flags & SVp_NOK) {
6860 SvNV_set(sv, SvNVX(sv) - 1.0);
6861 (void)SvNOK_only(sv);
6864 if (!(flags & SVp_POK)) {
6865 if ((flags & SVTYPEMASK) < SVt_PVIV)
6866 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6868 (void)SvIOK_only(sv);
6871 #ifdef PERL_PRESERVE_IVUV
6873 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6874 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6875 /* Need to try really hard to see if it's an integer.
6876 9.22337203685478e+18 is an integer.
6877 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6878 so $a="9.22337203685478e+18"; $a+0; $a--
6879 needs to be the same as $a="9.22337203685478e+18"; $a--
6886 /* sv_2iv *should* have made this an NV */
6887 if (flags & SVp_NOK) {
6888 (void)SvNOK_only(sv);
6889 SvNV_set(sv, SvNVX(sv) - 1.0);
6892 /* I don't think we can get here. Maybe I should assert this
6893 And if we do get here I suspect that sv_setnv will croak. NWC
6895 #if defined(USE_LONG_DOUBLE)
6896 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",
6897 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6899 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6900 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6904 #endif /* PERL_PRESERVE_IVUV */
6905 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6909 =for apidoc sv_mortalcopy
6911 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6912 The new SV is marked as mortal. It will be destroyed "soon", either by an
6913 explicit call to FREETMPS, or by an implicit call at places such as
6914 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6919 /* Make a string that will exist for the duration of the expression
6920 * evaluation. Actually, it may have to last longer than that, but
6921 * hopefully we won't free it until it has been assigned to a
6922 * permanent location. */
6925 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6931 sv_setsv(sv,oldstr);
6933 PL_tmps_stack[++PL_tmps_ix] = sv;
6939 =for apidoc sv_newmortal
6941 Creates a new null SV which is mortal. The reference count of the SV is
6942 set to 1. It will be destroyed "soon", either by an explicit call to
6943 FREETMPS, or by an implicit call at places such as statement boundaries.
6944 See also C<sv_mortalcopy> and C<sv_2mortal>.
6950 Perl_sv_newmortal(pTHX)
6956 SvFLAGS(sv) = SVs_TEMP;
6958 PL_tmps_stack[++PL_tmps_ix] = sv;
6963 =for apidoc sv_2mortal
6965 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6966 by an explicit call to FREETMPS, or by an implicit call at places such as
6967 statement boundaries. SvTEMP() is turned on which means that the SV's
6968 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6969 and C<sv_mortalcopy>.
6975 Perl_sv_2mortal(pTHX_ register SV *sv)
6980 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6983 PL_tmps_stack[++PL_tmps_ix] = sv;
6991 Creates a new SV and copies a string into it. The reference count for the
6992 SV is set to 1. If C<len> is zero, Perl will compute the length using
6993 strlen(). For efficiency, consider using C<newSVpvn> instead.
6999 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7005 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7010 =for apidoc newSVpvn
7012 Creates a new SV and copies a string into it. The reference count for the
7013 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7014 string. You are responsible for ensuring that the source string is at least
7015 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7021 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7027 sv_setpvn(sv,s,len);
7033 =for apidoc newSVhek
7035 Creates a new SV from the hash key structure. It will generate scalars that
7036 point to the shared string table where possible. Returns a new (undefined)
7037 SV if the hek is NULL.
7043 Perl_newSVhek(pTHX_ const HEK *hek)
7053 if (HEK_LEN(hek) == HEf_SVKEY) {
7054 return newSVsv(*(SV**)HEK_KEY(hek));
7056 const int flags = HEK_FLAGS(hek);
7057 if (flags & HVhek_WASUTF8) {
7059 Andreas would like keys he put in as utf8 to come back as utf8
7061 STRLEN utf8_len = HEK_LEN(hek);
7062 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7063 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7066 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7068 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7069 /* We don't have a pointer to the hv, so we have to replicate the
7070 flag into every HEK. This hv is using custom a hasing
7071 algorithm. Hence we can't return a shared string scalar, as
7072 that would contain the (wrong) hash value, and might get passed
7073 into an hv routine with a regular hash.
7074 Similarly, a hash that isn't using shared hash keys has to have
7075 the flag in every key so that we know not to try to call
7076 share_hek_kek on it. */
7078 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7083 /* This will be overwhelminly the most common case. */
7085 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7086 more efficient than sharepvn(). */
7090 sv_upgrade(sv, SVt_PV);
7091 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7092 SvCUR_set(sv, HEK_LEN(hek));
7105 =for apidoc newSVpvn_share
7107 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7108 table. If the string does not already exist in the table, it is created
7109 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7110 value is used; otherwise the hash is computed. The string's hash can be later
7111 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7112 that as the string table is used for shared hash keys these strings will have
7113 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7119 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7123 bool is_utf8 = FALSE;
7124 const char *const orig_src = src;
7127 STRLEN tmplen = -len;
7129 /* See the note in hv.c:hv_fetch() --jhi */
7130 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7134 PERL_HASH(hash, src, len);
7136 sv_upgrade(sv, SVt_PV);
7137 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7145 if (src != orig_src)
7151 #if defined(PERL_IMPLICIT_CONTEXT)
7153 /* pTHX_ magic can't cope with varargs, so this is a no-context
7154 * version of the main function, (which may itself be aliased to us).
7155 * Don't access this version directly.
7159 Perl_newSVpvf_nocontext(const char* pat, ...)
7164 va_start(args, pat);
7165 sv = vnewSVpvf(pat, &args);
7172 =for apidoc newSVpvf
7174 Creates a new SV and initializes it with the string formatted like
7181 Perl_newSVpvf(pTHX_ const char* pat, ...)
7185 va_start(args, pat);
7186 sv = vnewSVpvf(pat, &args);
7191 /* backend for newSVpvf() and newSVpvf_nocontext() */
7194 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7199 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7206 Creates a new SV and copies a floating point value into it.
7207 The reference count for the SV is set to 1.
7213 Perl_newSVnv(pTHX_ NV n)
7226 Creates a new SV and copies an integer into it. The reference count for the
7233 Perl_newSViv(pTHX_ IV i)
7246 Creates a new SV and copies an unsigned integer into it.
7247 The reference count for the SV is set to 1.
7253 Perl_newSVuv(pTHX_ UV u)
7264 =for apidoc newSV_type
7266 Creates a new SV, of the type specified. The reference count for the new SV
7273 Perl_newSV_type(pTHX_ svtype type)
7278 sv_upgrade(sv, type);
7283 =for apidoc newRV_noinc
7285 Creates an RV wrapper for an SV. The reference count for the original
7286 SV is B<not> incremented.
7292 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7295 register SV *sv = newSV_type(SVt_RV);
7297 SvRV_set(sv, tmpRef);
7302 /* newRV_inc is the official function name to use now.
7303 * newRV_inc is in fact #defined to newRV in sv.h
7307 Perl_newRV(pTHX_ SV *sv)
7310 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7316 Creates a new SV which is an exact duplicate of the original SV.
7323 Perl_newSVsv(pTHX_ register SV *old)
7330 if (SvTYPE(old) == SVTYPEMASK) {
7331 if (ckWARN_d(WARN_INTERNAL))
7332 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7336 /* SV_GMAGIC is the default for sv_setv()
7337 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7338 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7339 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7344 =for apidoc sv_reset
7346 Underlying implementation for the C<reset> Perl function.
7347 Note that the perl-level function is vaguely deprecated.
7353 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7356 char todo[PERL_UCHAR_MAX+1];
7361 if (!*s) { /* reset ?? searches */
7362 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7364 const U32 count = mg->mg_len / sizeof(PMOP**);
7365 PMOP **pmp = (PMOP**) mg->mg_ptr;
7366 PMOP *const *const end = pmp + count;
7370 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7372 (*pmp)->op_pmflags &= ~PMf_USED;
7380 /* reset variables */
7382 if (!HvARRAY(stash))
7385 Zero(todo, 256, char);
7388 I32 i = (unsigned char)*s;
7392 max = (unsigned char)*s++;
7393 for ( ; i <= max; i++) {
7396 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7398 for (entry = HvARRAY(stash)[i];
7400 entry = HeNEXT(entry))
7405 if (!todo[(U8)*HeKEY(entry)])
7407 gv = (GV*)HeVAL(entry);
7410 if (SvTHINKFIRST(sv)) {
7411 if (!SvREADONLY(sv) && SvROK(sv))
7413 /* XXX Is this continue a bug? Why should THINKFIRST
7414 exempt us from resetting arrays and hashes? */
7418 if (SvTYPE(sv) >= SVt_PV) {
7420 if (SvPVX_const(sv) != NULL)
7428 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7430 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7433 # if defined(USE_ENVIRON_ARRAY)
7436 # endif /* USE_ENVIRON_ARRAY */
7447 Using various gambits, try to get an IO from an SV: the IO slot if its a
7448 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7449 named after the PV if we're a string.
7455 Perl_sv_2io(pTHX_ SV *sv)
7460 switch (SvTYPE(sv)) {
7468 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7472 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7474 return sv_2io(SvRV(sv));
7475 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7481 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7490 Using various gambits, try to get a CV from an SV; in addition, try if
7491 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7492 The flags in C<lref> are passed to sv_fetchsv.
7498 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7509 switch (SvTYPE(sv)) {
7528 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7529 tryAMAGICunDEREF(to_cv);
7532 if (SvTYPE(sv) == SVt_PVCV) {
7541 Perl_croak(aTHX_ "Not a subroutine reference");
7546 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7552 /* Some flags to gv_fetchsv mean don't really create the GV */
7553 if (SvTYPE(gv) != SVt_PVGV) {
7559 if (lref && !GvCVu(gv)) {
7563 gv_efullname3(tmpsv, gv, NULL);
7564 /* XXX this is probably not what they think they're getting.
7565 * It has the same effect as "sub name;", i.e. just a forward
7567 newSUB(start_subparse(FALSE, 0),
7568 newSVOP(OP_CONST, 0, tmpsv),
7572 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7582 Returns true if the SV has a true value by Perl's rules.
7583 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7584 instead use an in-line version.
7590 Perl_sv_true(pTHX_ register SV *sv)
7595 register const XPV* const tXpv = (XPV*)SvANY(sv);
7597 (tXpv->xpv_cur > 1 ||
7598 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7605 return SvIVX(sv) != 0;
7608 return SvNVX(sv) != 0.0;
7610 return sv_2bool(sv);
7616 =for apidoc sv_pvn_force
7618 Get a sensible string out of the SV somehow.
7619 A private implementation of the C<SvPV_force> macro for compilers which
7620 can't cope with complex macro expressions. Always use the macro instead.
7622 =for apidoc sv_pvn_force_flags
7624 Get a sensible string out of the SV somehow.
7625 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7626 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7627 implemented in terms of this function.
7628 You normally want to use the various wrapper macros instead: see
7629 C<SvPV_force> and C<SvPV_force_nomg>
7635 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7638 if (SvTHINKFIRST(sv) && !SvROK(sv))
7639 sv_force_normal_flags(sv, 0);
7649 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7650 const char * const ref = sv_reftype(sv,0);
7652 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7653 ref, OP_NAME(PL_op));
7655 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7657 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7658 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7660 s = sv_2pv_flags(sv, &len, flags);
7664 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7667 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7668 SvGROW(sv, len + 1);
7669 Move(s,SvPVX(sv),len,char);
7671 SvPVX(sv)[len] = '\0';
7674 SvPOK_on(sv); /* validate pointer */
7676 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7677 PTR2UV(sv),SvPVX_const(sv)));
7680 return SvPVX_mutable(sv);
7684 =for apidoc sv_pvbyten_force
7686 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7692 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7694 sv_pvn_force(sv,lp);
7695 sv_utf8_downgrade(sv,0);
7701 =for apidoc sv_pvutf8n_force
7703 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7709 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7711 sv_pvn_force(sv,lp);
7712 sv_utf8_upgrade(sv);
7718 =for apidoc sv_reftype
7720 Returns a string describing what the SV is a reference to.
7726 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7728 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7729 inside return suggests a const propagation bug in g++. */
7730 if (ob && SvOBJECT(sv)) {
7731 char * const name = HvNAME_get(SvSTASH(sv));
7732 return name ? name : (char *) "__ANON__";
7735 switch (SvTYPE(sv)) {
7751 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7752 /* tied lvalues should appear to be
7753 * scalars for backwards compatitbility */
7754 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7755 ? "SCALAR" : "LVALUE");
7756 case SVt_PVAV: return "ARRAY";
7757 case SVt_PVHV: return "HASH";
7758 case SVt_PVCV: return "CODE";
7759 case SVt_PVGV: return "GLOB";
7760 case SVt_PVFM: return "FORMAT";
7761 case SVt_PVIO: return "IO";
7762 case SVt_BIND: return "BIND";
7763 default: return "UNKNOWN";
7769 =for apidoc sv_isobject
7771 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7772 object. If the SV is not an RV, or if the object is not blessed, then this
7779 Perl_sv_isobject(pTHX_ SV *sv)
7795 Returns a boolean indicating whether the SV is blessed into the specified
7796 class. This does not check for subtypes; use C<sv_derived_from> to verify
7797 an inheritance relationship.
7803 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7814 hvname = HvNAME_get(SvSTASH(sv));
7818 return strEQ(hvname, name);
7824 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7825 it will be upgraded to one. If C<classname> is non-null then the new SV will
7826 be blessed in the specified package. The new SV is returned and its
7827 reference count is 1.
7833 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7840 SV_CHECK_THINKFIRST_COW_DROP(rv);
7841 (void)SvAMAGIC_off(rv);
7843 if (SvTYPE(rv) >= SVt_PVMG) {
7844 const U32 refcnt = SvREFCNT(rv);
7848 SvREFCNT(rv) = refcnt;
7850 sv_upgrade(rv, SVt_RV);
7851 } else if (SvROK(rv)) {
7852 SvREFCNT_dec(SvRV(rv));
7853 } else if (SvTYPE(rv) < SVt_RV)
7854 sv_upgrade(rv, SVt_RV);
7855 else if (SvTYPE(rv) > SVt_RV) {
7866 HV* const stash = gv_stashpv(classname, GV_ADD);
7867 (void)sv_bless(rv, stash);
7873 =for apidoc sv_setref_pv
7875 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7876 argument will be upgraded to an RV. That RV will be modified to point to
7877 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7878 into the SV. The C<classname> argument indicates the package for the
7879 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7880 will have a reference count of 1, and the RV will be returned.
7882 Do not use with other Perl types such as HV, AV, SV, CV, because those
7883 objects will become corrupted by the pointer copy process.
7885 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7891 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7895 sv_setsv(rv, &PL_sv_undef);
7899 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7904 =for apidoc sv_setref_iv
7906 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7907 argument will be upgraded to an RV. That RV will be modified to point to
7908 the new SV. The C<classname> argument indicates the package for the
7909 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7910 will have a reference count of 1, and the RV will be returned.
7916 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7918 sv_setiv(newSVrv(rv,classname), iv);
7923 =for apidoc sv_setref_uv
7925 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7926 argument will be upgraded to an RV. That RV will be modified to point to
7927 the new SV. The C<classname> argument indicates the package for the
7928 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7929 will have a reference count of 1, and the RV will be returned.
7935 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7937 sv_setuv(newSVrv(rv,classname), uv);
7942 =for apidoc sv_setref_nv
7944 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7945 argument will be upgraded to an RV. That RV will be modified to point to
7946 the new SV. The C<classname> argument indicates the package for the
7947 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7948 will have a reference count of 1, and the RV will be returned.
7954 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7956 sv_setnv(newSVrv(rv,classname), nv);
7961 =for apidoc sv_setref_pvn
7963 Copies a string into a new SV, optionally blessing the SV. The length of the
7964 string must be specified with C<n>. The C<rv> argument will be upgraded to
7965 an RV. That RV will be modified to point to the new SV. The C<classname>
7966 argument indicates the package for the blessing. Set C<classname> to
7967 C<NULL> to avoid the blessing. The new SV will have a reference count
7968 of 1, and the RV will be returned.
7970 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7976 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7978 sv_setpvn(newSVrv(rv,classname), pv, n);
7983 =for apidoc sv_bless
7985 Blesses an SV into a specified package. The SV must be an RV. The package
7986 must be designated by its stash (see C<gv_stashpv()>). The reference count
7987 of the SV is unaffected.
7993 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7998 Perl_croak(aTHX_ "Can't bless non-reference value");
8000 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8001 if (SvIsCOW(tmpRef))
8002 sv_force_normal_flags(tmpRef, 0);
8003 if (SvREADONLY(tmpRef))
8004 Perl_croak(aTHX_ PL_no_modify);
8005 if (SvOBJECT(tmpRef)) {
8006 if (SvTYPE(tmpRef) != SVt_PVIO)
8008 SvREFCNT_dec(SvSTASH(tmpRef));
8011 SvOBJECT_on(tmpRef);
8012 if (SvTYPE(tmpRef) != SVt_PVIO)
8014 SvUPGRADE(tmpRef, SVt_PVMG);
8015 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8020 (void)SvAMAGIC_off(sv);
8022 if(SvSMAGICAL(tmpRef))
8023 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8031 /* Downgrades a PVGV to a PVMG.
8035 S_sv_unglob(pTHX_ SV *sv)
8040 SV * const temp = sv_newmortal();
8042 assert(SvTYPE(sv) == SVt_PVGV);
8044 gv_efullname3(temp, (GV *) sv, "*");
8047 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8048 mro_method_changed_in(stash);
8052 sv_del_backref((SV*)GvSTASH(sv), sv);
8056 if (GvNAME_HEK(sv)) {
8057 unshare_hek(GvNAME_HEK(sv));
8059 isGV_with_GP_off(sv);
8061 /* need to keep SvANY(sv) in the right arena */
8062 xpvmg = new_XPVMG();
8063 StructCopy(SvANY(sv), xpvmg, XPVMG);
8064 del_XPVGV(SvANY(sv));
8067 SvFLAGS(sv) &= ~SVTYPEMASK;
8068 SvFLAGS(sv) |= SVt_PVMG;
8070 /* Intentionally not calling any local SET magic, as this isn't so much a
8071 set operation as merely an internal storage change. */
8072 sv_setsv_flags(sv, temp, 0);
8076 =for apidoc sv_unref_flags
8078 Unsets the RV status of the SV, and decrements the reference count of
8079 whatever was being referenced by the RV. This can almost be thought of
8080 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8081 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8082 (otherwise the decrementing is conditional on the reference count being
8083 different from one or the reference being a readonly SV).
8090 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8092 SV* const target = SvRV(ref);
8094 if (SvWEAKREF(ref)) {
8095 sv_del_backref(target, ref);
8097 SvRV_set(ref, NULL);
8100 SvRV_set(ref, NULL);
8102 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8103 assigned to as BEGIN {$a = \"Foo"} will fail. */
8104 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8105 SvREFCNT_dec(target);
8106 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8107 sv_2mortal(target); /* Schedule for freeing later */
8111 =for apidoc sv_untaint
8113 Untaint an SV. Use C<SvTAINTED_off> instead.
8118 Perl_sv_untaint(pTHX_ SV *sv)
8120 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8121 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8128 =for apidoc sv_tainted
8130 Test an SV for taintedness. Use C<SvTAINTED> instead.
8135 Perl_sv_tainted(pTHX_ SV *sv)
8137 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8138 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8139 if (mg && (mg->mg_len & 1) )
8146 =for apidoc sv_setpviv
8148 Copies an integer into the given SV, also updating its string value.
8149 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8155 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8157 char buf[TYPE_CHARS(UV)];
8159 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8161 sv_setpvn(sv, ptr, ebuf - ptr);
8165 =for apidoc sv_setpviv_mg
8167 Like C<sv_setpviv>, but also handles 'set' magic.
8173 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8179 #if defined(PERL_IMPLICIT_CONTEXT)
8181 /* pTHX_ magic can't cope with varargs, so this is a no-context
8182 * version of the main function, (which may itself be aliased to us).
8183 * Don't access this version directly.
8187 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8191 va_start(args, pat);
8192 sv_vsetpvf(sv, pat, &args);
8196 /* pTHX_ magic can't cope with varargs, so this is a no-context
8197 * version of the main function, (which may itself be aliased to us).
8198 * Don't access this version directly.
8202 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8206 va_start(args, pat);
8207 sv_vsetpvf_mg(sv, pat, &args);
8213 =for apidoc sv_setpvf
8215 Works like C<sv_catpvf> but copies the text into the SV instead of
8216 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8222 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8225 va_start(args, pat);
8226 sv_vsetpvf(sv, pat, &args);
8231 =for apidoc sv_vsetpvf
8233 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8234 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8236 Usually used via its frontend C<sv_setpvf>.
8242 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8244 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8248 =for apidoc sv_setpvf_mg
8250 Like C<sv_setpvf>, but also handles 'set' magic.
8256 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8259 va_start(args, pat);
8260 sv_vsetpvf_mg(sv, pat, &args);
8265 =for apidoc sv_vsetpvf_mg
8267 Like C<sv_vsetpvf>, but also handles 'set' magic.
8269 Usually used via its frontend C<sv_setpvf_mg>.
8275 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8277 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8281 #if defined(PERL_IMPLICIT_CONTEXT)
8283 /* pTHX_ magic can't cope with varargs, so this is a no-context
8284 * version of the main function, (which may itself be aliased to us).
8285 * Don't access this version directly.
8289 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8293 va_start(args, pat);
8294 sv_vcatpvf(sv, pat, &args);
8298 /* pTHX_ magic can't cope with varargs, so this is a no-context
8299 * version of the main function, (which may itself be aliased to us).
8300 * Don't access this version directly.
8304 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8308 va_start(args, pat);
8309 sv_vcatpvf_mg(sv, pat, &args);
8315 =for apidoc sv_catpvf
8317 Processes its arguments like C<sprintf> and appends the formatted
8318 output to an SV. If the appended data contains "wide" characters
8319 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8320 and characters >255 formatted with %c), the original SV might get
8321 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8322 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8323 valid UTF-8; if the original SV was bytes, the pattern should be too.
8328 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8331 va_start(args, pat);
8332 sv_vcatpvf(sv, pat, &args);
8337 =for apidoc sv_vcatpvf
8339 Processes its arguments like C<vsprintf> and appends the formatted output
8340 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8342 Usually used via its frontend C<sv_catpvf>.
8348 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8350 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8354 =for apidoc sv_catpvf_mg
8356 Like C<sv_catpvf>, but also handles 'set' magic.
8362 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8365 va_start(args, pat);
8366 sv_vcatpvf_mg(sv, pat, &args);
8371 =for apidoc sv_vcatpvf_mg
8373 Like C<sv_vcatpvf>, but also handles 'set' magic.
8375 Usually used via its frontend C<sv_catpvf_mg>.
8381 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8383 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8388 =for apidoc sv_vsetpvfn
8390 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8393 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8399 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8401 sv_setpvn(sv, "", 0);
8402 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8406 S_expect_number(pTHX_ char** pattern)
8410 switch (**pattern) {
8411 case '1': case '2': case '3':
8412 case '4': case '5': case '6':
8413 case '7': case '8': case '9':
8414 var = *(*pattern)++ - '0';
8415 while (isDIGIT(**pattern)) {
8416 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8418 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8426 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8428 const int neg = nv < 0;
8437 if (uv & 1 && uv == nv)
8438 uv--; /* Round to even */
8440 const unsigned dig = uv % 10;
8453 =for apidoc sv_vcatpvfn
8455 Processes its arguments like C<vsprintf> and appends the formatted output
8456 to an SV. Uses an array of SVs if the C style variable argument list is
8457 missing (NULL). When running with taint checks enabled, indicates via
8458 C<maybe_tainted> if results are untrustworthy (often due to the use of
8461 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8467 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8468 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8469 vec_utf8 = DO_UTF8(vecsv);
8471 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8474 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8482 static const char nullstr[] = "(null)";
8484 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8485 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8487 /* Times 4: a decimal digit takes more than 3 binary digits.
8488 * NV_DIG: mantissa takes than many decimal digits.
8489 * Plus 32: Playing safe. */
8490 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8491 /* large enough for "%#.#f" --chip */
8492 /* what about long double NVs? --jhi */
8494 PERL_UNUSED_ARG(maybe_tainted);
8496 /* no matter what, this is a string now */
8497 (void)SvPV_force(sv, origlen);
8499 /* special-case "", "%s", and "%-p" (SVf - see below) */
8502 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8504 const char * const s = va_arg(*args, char*);
8505 sv_catpv(sv, s ? s : nullstr);
8507 else if (svix < svmax) {
8508 sv_catsv(sv, *svargs);
8512 if (args && patlen == 3 && pat[0] == '%' &&
8513 pat[1] == '-' && pat[2] == 'p') {
8514 argsv = (SV*)va_arg(*args, void*);
8515 sv_catsv(sv, argsv);
8519 #ifndef USE_LONG_DOUBLE
8520 /* special-case "%.<number>[gf]" */
8521 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8522 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8523 unsigned digits = 0;
8527 while (*pp >= '0' && *pp <= '9')
8528 digits = 10 * digits + (*pp++ - '0');
8529 if (pp - pat == (int)patlen - 1) {
8537 /* Add check for digits != 0 because it seems that some
8538 gconverts are buggy in this case, and we don't yet have
8539 a Configure test for this. */
8540 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8541 /* 0, point, slack */
8542 Gconvert(nv, (int)digits, 0, ebuf);
8544 if (*ebuf) /* May return an empty string for digits==0 */
8547 } else if (!digits) {
8550 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8551 sv_catpvn(sv, p, l);
8557 #endif /* !USE_LONG_DOUBLE */
8559 if (!args && svix < svmax && DO_UTF8(*svargs))
8562 patend = (char*)pat + patlen;
8563 for (p = (char*)pat; p < patend; p = q) {
8566 bool vectorize = FALSE;
8567 bool vectorarg = FALSE;
8568 bool vec_utf8 = FALSE;
8574 bool has_precis = FALSE;
8576 const I32 osvix = svix;
8577 bool is_utf8 = FALSE; /* is this item utf8? */
8578 #ifdef HAS_LDBL_SPRINTF_BUG
8579 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8580 with sfio - Allen <allens@cpan.org> */
8581 bool fix_ldbl_sprintf_bug = FALSE;
8585 U8 utf8buf[UTF8_MAXBYTES+1];
8586 STRLEN esignlen = 0;
8588 const char *eptr = NULL;
8591 const U8 *vecstr = NULL;
8598 /* we need a long double target in case HAS_LONG_DOUBLE but
8601 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8609 const char *dotstr = ".";
8610 STRLEN dotstrlen = 1;
8611 I32 efix = 0; /* explicit format parameter index */
8612 I32 ewix = 0; /* explicit width index */
8613 I32 epix = 0; /* explicit precision index */
8614 I32 evix = 0; /* explicit vector index */
8615 bool asterisk = FALSE;
8617 /* echo everything up to the next format specification */
8618 for (q = p; q < patend && *q != '%'; ++q) ;
8620 if (has_utf8 && !pat_utf8)
8621 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8623 sv_catpvn(sv, p, q - p);
8630 We allow format specification elements in this order:
8631 \d+\$ explicit format parameter index
8633 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8634 0 flag (as above): repeated to allow "v02"
8635 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8636 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8638 [%bcdefginopsuxDFOUX] format (mandatory)
8643 As of perl5.9.3, printf format checking is on by default.
8644 Internally, perl uses %p formats to provide an escape to
8645 some extended formatting. This block deals with those
8646 extensions: if it does not match, (char*)q is reset and
8647 the normal format processing code is used.
8649 Currently defined extensions are:
8650 %p include pointer address (standard)
8651 %-p (SVf) include an SV (previously %_)
8652 %-<num>p include an SV with precision <num>
8653 %<num>p reserved for future extensions
8655 Robin Barker 2005-07-14
8657 %1p (VDf) removed. RMB 2007-10-19
8664 n = expect_number(&q);
8671 argsv = (SV*)va_arg(*args, void*);
8672 eptr = SvPV_const(argsv, elen);
8678 if (ckWARN_d(WARN_INTERNAL))
8679 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8680 "internal %%<num>p might conflict with future printf extensions");
8686 if ( (width = expect_number(&q)) ) {
8701 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8730 if ( (ewix = expect_number(&q)) )
8739 if ((vectorarg = asterisk)) {
8752 width = expect_number(&q);
8758 vecsv = va_arg(*args, SV*);
8760 vecsv = (evix > 0 && evix <= svmax)
8761 ? svargs[evix-1] : &PL_sv_undef;
8763 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8765 dotstr = SvPV_const(vecsv, dotstrlen);
8766 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8767 bad with tied or overloaded values that return UTF8. */
8770 else if (has_utf8) {
8771 vecsv = sv_mortalcopy(vecsv);
8772 sv_utf8_upgrade(vecsv);
8773 dotstr = SvPV_const(vecsv, dotstrlen);
8780 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8781 vecsv = svargs[efix ? efix-1 : svix++];
8782 vecstr = (U8*)SvPV_const(vecsv,veclen);
8783 vec_utf8 = DO_UTF8(vecsv);
8785 /* if this is a version object, we need to convert
8786 * back into v-string notation and then let the
8787 * vectorize happen normally
8789 if (sv_derived_from(vecsv, "version")) {
8790 char *version = savesvpv(vecsv);
8791 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8792 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8793 "vector argument not supported with alpha versions");
8796 vecsv = sv_newmortal();
8797 scan_vstring(version, version + veclen, vecsv);
8798 vecstr = (U8*)SvPV_const(vecsv, veclen);
8799 vec_utf8 = DO_UTF8(vecsv);
8811 i = va_arg(*args, int);
8813 i = (ewix ? ewix <= svmax : svix < svmax) ?
8814 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8816 width = (i < 0) ? -i : i;
8826 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8828 /* XXX: todo, support specified precision parameter */
8832 i = va_arg(*args, int);
8834 i = (ewix ? ewix <= svmax : svix < svmax)
8835 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8837 has_precis = !(i < 0);
8842 precis = precis * 10 + (*q++ - '0');
8851 case 'I': /* Ix, I32x, and I64x */
8853 if (q[1] == '6' && q[2] == '4') {
8859 if (q[1] == '3' && q[2] == '2') {
8869 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8880 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8881 if (*(q + 1) == 'l') { /* lld, llf */
8907 if (!vectorize && !args) {
8909 const I32 i = efix-1;
8910 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8912 argsv = (svix >= 0 && svix < svmax)
8913 ? svargs[svix++] : &PL_sv_undef;
8924 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8926 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8928 eptr = (char*)utf8buf;
8929 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8943 eptr = va_arg(*args, char*);
8945 #ifdef MACOS_TRADITIONAL
8946 /* On MacOS, %#s format is used for Pascal strings */
8951 elen = strlen(eptr);
8953 eptr = (char *)nullstr;
8954 elen = sizeof nullstr - 1;
8958 eptr = SvPV_const(argsv, elen);
8959 if (DO_UTF8(argsv)) {
8960 I32 old_precis = precis;
8961 if (has_precis && precis < elen) {
8963 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8966 if (width) { /* fudge width (can't fudge elen) */
8967 if (has_precis && precis < elen)
8968 width += precis - old_precis;
8970 width += elen - sv_len_utf8(argsv);
8977 if (has_precis && elen > precis)
8984 if (alt || vectorize)
8986 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9007 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9016 esignbuf[esignlen++] = plus;
9020 case 'h': iv = (short)va_arg(*args, int); break;
9021 case 'l': iv = va_arg(*args, long); break;
9022 case 'V': iv = va_arg(*args, IV); break;
9023 default: iv = va_arg(*args, int); break;
9025 case 'q': iv = va_arg(*args, Quad_t); break;
9030 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9032 case 'h': iv = (short)tiv; break;
9033 case 'l': iv = (long)tiv; break;
9035 default: iv = tiv; break;
9037 case 'q': iv = (Quad_t)tiv; break;
9041 if ( !vectorize ) /* we already set uv above */
9046 esignbuf[esignlen++] = plus;
9050 esignbuf[esignlen++] = '-';
9094 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9105 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9106 case 'l': uv = va_arg(*args, unsigned long); break;
9107 case 'V': uv = va_arg(*args, UV); break;
9108 default: uv = va_arg(*args, unsigned); break;
9110 case 'q': uv = va_arg(*args, Uquad_t); break;
9115 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9117 case 'h': uv = (unsigned short)tuv; break;
9118 case 'l': uv = (unsigned long)tuv; break;
9120 default: uv = tuv; break;
9122 case 'q': uv = (Uquad_t)tuv; break;
9129 char *ptr = ebuf + sizeof ebuf;
9130 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9136 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9142 esignbuf[esignlen++] = '0';
9143 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9151 if (alt && *ptr != '0')
9160 esignbuf[esignlen++] = '0';
9161 esignbuf[esignlen++] = c;
9164 default: /* it had better be ten or less */
9168 } while (uv /= base);
9171 elen = (ebuf + sizeof ebuf) - ptr;
9175 zeros = precis - elen;
9176 else if (precis == 0 && elen == 1 && *eptr == '0'
9177 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9180 /* a precision nullifies the 0 flag. */
9187 /* FLOATING POINT */
9190 c = 'f'; /* maybe %F isn't supported here */
9198 /* This is evil, but floating point is even more evil */
9200 /* for SV-style calling, we can only get NV
9201 for C-style calling, we assume %f is double;
9202 for simplicity we allow any of %Lf, %llf, %qf for long double
9206 #if defined(USE_LONG_DOUBLE)
9210 /* [perl #20339] - we should accept and ignore %lf rather than die */
9214 #if defined(USE_LONG_DOUBLE)
9215 intsize = args ? 0 : 'q';
9219 #if defined(HAS_LONG_DOUBLE)
9228 /* now we need (long double) if intsize == 'q', else (double) */
9230 #if LONG_DOUBLESIZE > DOUBLESIZE
9232 va_arg(*args, long double) :
9233 va_arg(*args, double)
9235 va_arg(*args, double)
9240 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9241 else. frexp() has some unspecified behaviour for those three */
9242 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9244 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9245 will cast our (long double) to (double) */
9246 (void)Perl_frexp(nv, &i);
9247 if (i == PERL_INT_MIN)
9248 Perl_die(aTHX_ "panic: frexp");
9250 need = BIT_DIGITS(i);
9252 need += has_precis ? precis : 6; /* known default */
9257 #ifdef HAS_LDBL_SPRINTF_BUG
9258 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9259 with sfio - Allen <allens@cpan.org> */
9262 # define MY_DBL_MAX DBL_MAX
9263 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9264 # if DOUBLESIZE >= 8
9265 # define MY_DBL_MAX 1.7976931348623157E+308L
9267 # define MY_DBL_MAX 3.40282347E+38L
9271 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9272 # define MY_DBL_MAX_BUG 1L
9274 # define MY_DBL_MAX_BUG MY_DBL_MAX
9278 # define MY_DBL_MIN DBL_MIN
9279 # else /* XXX guessing! -Allen */
9280 # if DOUBLESIZE >= 8
9281 # define MY_DBL_MIN 2.2250738585072014E-308L
9283 # define MY_DBL_MIN 1.17549435E-38L
9287 if ((intsize == 'q') && (c == 'f') &&
9288 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9290 /* it's going to be short enough that
9291 * long double precision is not needed */
9293 if ((nv <= 0L) && (nv >= -0L))
9294 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9296 /* would use Perl_fp_class as a double-check but not
9297 * functional on IRIX - see perl.h comments */
9299 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9300 /* It's within the range that a double can represent */
9301 #if defined(DBL_MAX) && !defined(DBL_MIN)
9302 if ((nv >= ((long double)1/DBL_MAX)) ||
9303 (nv <= (-(long double)1/DBL_MAX)))
9305 fix_ldbl_sprintf_bug = TRUE;
9308 if (fix_ldbl_sprintf_bug == TRUE) {
9318 # undef MY_DBL_MAX_BUG
9321 #endif /* HAS_LDBL_SPRINTF_BUG */
9323 need += 20; /* fudge factor */
9324 if (PL_efloatsize < need) {
9325 Safefree(PL_efloatbuf);
9326 PL_efloatsize = need + 20; /* more fudge */
9327 Newx(PL_efloatbuf, PL_efloatsize, char);
9328 PL_efloatbuf[0] = '\0';
9331 if ( !(width || left || plus || alt) && fill != '0'
9332 && has_precis && intsize != 'q' ) { /* Shortcuts */
9333 /* See earlier comment about buggy Gconvert when digits,
9335 if ( c == 'g' && precis) {
9336 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9337 /* May return an empty string for digits==0 */
9338 if (*PL_efloatbuf) {
9339 elen = strlen(PL_efloatbuf);
9340 goto float_converted;
9342 } else if ( c == 'f' && !precis) {
9343 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9348 char *ptr = ebuf + sizeof ebuf;
9351 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9352 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9353 if (intsize == 'q') {
9354 /* Copy the one or more characters in a long double
9355 * format before the 'base' ([efgEFG]) character to
9356 * the format string. */
9357 static char const prifldbl[] = PERL_PRIfldbl;
9358 char const *p = prifldbl + sizeof(prifldbl) - 3;
9359 while (p >= prifldbl) { *--ptr = *p--; }
9364 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9369 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9381 /* No taint. Otherwise we are in the strange situation
9382 * where printf() taints but print($float) doesn't.
9384 #if defined(HAS_LONG_DOUBLE)
9385 elen = ((intsize == 'q')
9386 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9387 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9389 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9393 eptr = PL_efloatbuf;
9401 i = SvCUR(sv) - origlen;
9404 case 'h': *(va_arg(*args, short*)) = i; break;
9405 default: *(va_arg(*args, int*)) = i; break;
9406 case 'l': *(va_arg(*args, long*)) = i; break;
9407 case 'V': *(va_arg(*args, IV*)) = i; break;
9409 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9414 sv_setuv_mg(argsv, (UV)i);
9415 continue; /* not "break" */
9422 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9423 && ckWARN(WARN_PRINTF))
9425 SV * const msg = sv_newmortal();
9426 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9427 (PL_op->op_type == OP_PRTF) ? "" : "s");
9430 Perl_sv_catpvf(aTHX_ msg,
9431 "\"%%%c\"", c & 0xFF);
9433 Perl_sv_catpvf(aTHX_ msg,
9434 "\"%%\\%03"UVof"\"",
9437 sv_catpvs(msg, "end of string");
9438 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9441 /* output mangled stuff ... */
9447 /* ... right here, because formatting flags should not apply */
9448 SvGROW(sv, SvCUR(sv) + elen + 1);
9450 Copy(eptr, p, elen, char);
9453 SvCUR_set(sv, p - SvPVX_const(sv));
9455 continue; /* not "break" */
9458 if (is_utf8 != has_utf8) {
9461 sv_utf8_upgrade(sv);
9464 const STRLEN old_elen = elen;
9465 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9466 sv_utf8_upgrade(nsv);
9467 eptr = SvPVX_const(nsv);
9470 if (width) { /* fudge width (can't fudge elen) */
9471 width += elen - old_elen;
9477 have = esignlen + zeros + elen;
9479 Perl_croak_nocontext(PL_memory_wrap);
9481 need = (have > width ? have : width);
9484 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9485 Perl_croak_nocontext(PL_memory_wrap);
9486 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9488 if (esignlen && fill == '0') {
9490 for (i = 0; i < (int)esignlen; i++)
9494 memset(p, fill, gap);
9497 if (esignlen && fill != '0') {
9499 for (i = 0; i < (int)esignlen; i++)
9504 for (i = zeros; i; i--)
9508 Copy(eptr, p, elen, char);
9512 memset(p, ' ', gap);
9517 Copy(dotstr, p, dotstrlen, char);
9521 vectorize = FALSE; /* done iterating over vecstr */
9528 SvCUR_set(sv, p - SvPVX_const(sv));
9536 /* =========================================================================
9538 =head1 Cloning an interpreter
9540 All the macros and functions in this section are for the private use of
9541 the main function, perl_clone().
9543 The foo_dup() functions make an exact copy of an existing foo thingy.
9544 During the course of a cloning, a hash table is used to map old addresses
9545 to new addresses. The table is created and manipulated with the
9546 ptr_table_* functions.
9550 ============================================================================*/
9553 #if defined(USE_ITHREADS)
9555 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9556 #ifndef GpREFCNT_inc
9557 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9561 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9562 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9563 If this changes, please unmerge ss_dup. */
9564 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9565 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9566 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9567 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9568 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9569 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9570 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9571 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9572 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9573 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9574 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9575 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9576 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9577 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9579 /* clone a parser */
9582 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9589 /* look for it in the table first */
9590 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9594 /* create anew and remember what it is */
9595 Newxz(parser, 1, yy_parser);
9596 ptr_table_store(PL_ptr_table, proto, parser);
9598 parser->yyerrstatus = 0;
9599 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9601 /* XXX these not yet duped */
9602 parser->old_parser = NULL;
9603 parser->stack = NULL;
9605 parser->stack_size = 0;
9606 /* XXX parser->stack->state = 0; */
9608 /* XXX eventually, just Copy() most of the parser struct ? */
9610 parser->lex_brackets = proto->lex_brackets;
9611 parser->lex_casemods = proto->lex_casemods;
9612 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9613 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9614 parser->lex_casestack = savepvn(proto->lex_casestack,
9615 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9616 parser->lex_defer = proto->lex_defer;
9617 parser->lex_dojoin = proto->lex_dojoin;
9618 parser->lex_expect = proto->lex_expect;
9619 parser->lex_formbrack = proto->lex_formbrack;
9620 parser->lex_inpat = proto->lex_inpat;
9621 parser->lex_inwhat = proto->lex_inwhat;
9622 parser->lex_op = proto->lex_op;
9623 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9624 parser->lex_starts = proto->lex_starts;
9625 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9626 parser->multi_close = proto->multi_close;
9627 parser->multi_open = proto->multi_open;
9628 parser->multi_start = proto->multi_start;
9629 parser->multi_end = proto->multi_end;
9630 parser->pending_ident = proto->pending_ident;
9631 parser->preambled = proto->preambled;
9632 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9633 parser->linestr = sv_dup_inc(proto->linestr, param);
9634 parser->expect = proto->expect;
9635 parser->copline = proto->copline;
9636 parser->last_lop_op = proto->last_lop_op;
9637 parser->lex_state = proto->lex_state;
9638 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9639 /* rsfp_filters entries have fake IoDIRP() */
9640 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9641 parser->in_my = proto->in_my;
9642 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9643 parser->error_count = proto->error_count;
9646 parser->linestr = sv_dup_inc(proto->linestr, param);
9649 char * const ols = SvPVX(proto->linestr);
9650 char * const ls = SvPVX(parser->linestr);
9652 parser->bufptr = ls + (proto->bufptr >= ols ?
9653 proto->bufptr - ols : 0);
9654 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9655 proto->oldbufptr - ols : 0);
9656 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9657 proto->oldoldbufptr - ols : 0);
9658 parser->linestart = ls + (proto->linestart >= ols ?
9659 proto->linestart - ols : 0);
9660 parser->last_uni = ls + (proto->last_uni >= ols ?
9661 proto->last_uni - ols : 0);
9662 parser->last_lop = ls + (proto->last_lop >= ols ?
9663 proto->last_lop - ols : 0);
9665 parser->bufend = ls + SvCUR(parser->linestr);
9668 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9672 parser->endwhite = proto->endwhite;
9673 parser->faketokens = proto->faketokens;
9674 parser->lasttoke = proto->lasttoke;
9675 parser->nextwhite = proto->nextwhite;
9676 parser->realtokenstart = proto->realtokenstart;
9677 parser->skipwhite = proto->skipwhite;
9678 parser->thisclose = proto->thisclose;
9679 parser->thismad = proto->thismad;
9680 parser->thisopen = proto->thisopen;
9681 parser->thisstuff = proto->thisstuff;
9682 parser->thistoken = proto->thistoken;
9683 parser->thiswhite = proto->thiswhite;
9685 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9686 parser->curforce = proto->curforce;
9688 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9689 Copy(proto->nexttype, parser->nexttype, 5, I32);
9690 parser->nexttoke = proto->nexttoke;
9696 /* duplicate a file handle */
9699 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9703 PERL_UNUSED_ARG(type);
9706 return (PerlIO*)NULL;
9708 /* look for it in the table first */
9709 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9713 /* create anew and remember what it is */
9714 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9715 ptr_table_store(PL_ptr_table, fp, ret);
9719 /* duplicate a directory handle */
9722 Perl_dirp_dup(pTHX_ DIR *dp)
9724 PERL_UNUSED_CONTEXT;
9731 /* duplicate a typeglob */
9734 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9740 /* look for it in the table first */
9741 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9745 /* create anew and remember what it is */
9747 ptr_table_store(PL_ptr_table, gp, ret);
9750 ret->gp_refcnt = 0; /* must be before any other dups! */
9751 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9752 ret->gp_io = io_dup_inc(gp->gp_io, param);
9753 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9754 ret->gp_av = av_dup_inc(gp->gp_av, param);
9755 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9756 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9757 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9758 ret->gp_cvgen = gp->gp_cvgen;
9759 ret->gp_line = gp->gp_line;
9760 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9764 /* duplicate a chain of magic */
9767 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9769 MAGIC *mgprev = (MAGIC*)NULL;
9772 return (MAGIC*)NULL;
9773 /* look for it in the table first */
9774 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9778 for (; mg; mg = mg->mg_moremagic) {
9780 Newxz(nmg, 1, MAGIC);
9782 mgprev->mg_moremagic = nmg;
9785 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9786 nmg->mg_private = mg->mg_private;
9787 nmg->mg_type = mg->mg_type;
9788 nmg->mg_flags = mg->mg_flags;
9789 if (mg->mg_type == PERL_MAGIC_qr) {
9790 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9792 else if(mg->mg_type == PERL_MAGIC_backref) {
9793 /* The backref AV has its reference count deliberately bumped by
9795 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9798 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9799 ? sv_dup_inc(mg->mg_obj, param)
9800 : sv_dup(mg->mg_obj, param);
9802 nmg->mg_len = mg->mg_len;
9803 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9804 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9805 if (mg->mg_len > 0) {
9806 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9807 if (mg->mg_type == PERL_MAGIC_overload_table &&
9808 AMT_AMAGIC((AMT*)mg->mg_ptr))
9810 const AMT * const amtp = (AMT*)mg->mg_ptr;
9811 AMT * const namtp = (AMT*)nmg->mg_ptr;
9813 for (i = 1; i < NofAMmeth; i++) {
9814 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9818 else if (mg->mg_len == HEf_SVKEY)
9819 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9821 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9822 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9829 #endif /* USE_ITHREADS */
9831 /* create a new pointer-mapping table */
9834 Perl_ptr_table_new(pTHX)
9837 PERL_UNUSED_CONTEXT;
9839 Newxz(tbl, 1, PTR_TBL_t);
9842 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9846 #define PTR_TABLE_HASH(ptr) \
9847 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9850 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9851 following define) and at call to new_body_inline made below in
9852 Perl_ptr_table_store()
9855 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9857 /* map an existing pointer using a table */
9859 STATIC PTR_TBL_ENT_t *
9860 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9861 PTR_TBL_ENT_t *tblent;
9862 const UV hash = PTR_TABLE_HASH(sv);
9864 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9865 for (; tblent; tblent = tblent->next) {
9866 if (tblent->oldval == sv)
9873 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9875 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9876 PERL_UNUSED_CONTEXT;
9877 return tblent ? tblent->newval : NULL;
9880 /* add a new entry to a pointer-mapping table */
9883 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9885 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9886 PERL_UNUSED_CONTEXT;
9889 tblent->newval = newsv;
9891 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9893 new_body_inline(tblent, PTE_SVSLOT);
9895 tblent->oldval = oldsv;
9896 tblent->newval = newsv;
9897 tblent->next = tbl->tbl_ary[entry];
9898 tbl->tbl_ary[entry] = tblent;
9900 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9901 ptr_table_split(tbl);
9905 /* double the hash bucket size of an existing ptr table */
9908 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9910 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9911 const UV oldsize = tbl->tbl_max + 1;
9912 UV newsize = oldsize * 2;
9914 PERL_UNUSED_CONTEXT;
9916 Renew(ary, newsize, PTR_TBL_ENT_t*);
9917 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9918 tbl->tbl_max = --newsize;
9920 for (i=0; i < oldsize; i++, ary++) {
9921 PTR_TBL_ENT_t **curentp, **entp, *ent;
9924 curentp = ary + oldsize;
9925 for (entp = ary, ent = *ary; ent; ent = *entp) {
9926 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9928 ent->next = *curentp;
9938 /* remove all the entries from a ptr table */
9941 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9943 if (tbl && tbl->tbl_items) {
9944 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9945 UV riter = tbl->tbl_max;
9948 PTR_TBL_ENT_t *entry = array[riter];
9951 PTR_TBL_ENT_t * const oentry = entry;
9952 entry = entry->next;
9961 /* clear and free a ptr table */
9964 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9969 ptr_table_clear(tbl);
9970 Safefree(tbl->tbl_ary);
9974 #if defined(USE_ITHREADS)
9977 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9980 SvRV_set(dstr, SvWEAKREF(sstr)
9981 ? sv_dup(SvRV(sstr), param)
9982 : sv_dup_inc(SvRV(sstr), param));
9985 else if (SvPVX_const(sstr)) {
9986 /* Has something there */
9988 /* Normal PV - clone whole allocated space */
9989 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9990 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9991 /* Not that normal - actually sstr is copy on write.
9992 But we are a true, independant SV, so: */
9993 SvREADONLY_off(dstr);
9998 /* Special case - not normally malloced for some reason */
9999 if (isGV_with_GP(sstr)) {
10000 /* Don't need to do anything here. */
10002 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10003 /* A "shared" PV - clone it as "shared" PV */
10005 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10009 /* Some other special case - random pointer */
10010 SvPV_set(dstr, SvPVX(sstr));
10015 /* Copy the NULL */
10016 if (SvTYPE(dstr) == SVt_RV)
10017 SvRV_set(dstr, NULL);
10019 SvPV_set(dstr, NULL);
10023 /* duplicate an SV of any type (including AV, HV etc) */
10026 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10031 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10033 /* look for it in the table first */
10034 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10038 if(param->flags & CLONEf_JOIN_IN) {
10039 /** We are joining here so we don't want do clone
10040 something that is bad **/
10041 if (SvTYPE(sstr) == SVt_PVHV) {
10042 const HEK * const hvname = HvNAME_HEK(sstr);
10044 /** don't clone stashes if they already exist **/
10045 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10049 /* create anew and remember what it is */
10052 #ifdef DEBUG_LEAKING_SCALARS
10053 dstr->sv_debug_optype = sstr->sv_debug_optype;
10054 dstr->sv_debug_line = sstr->sv_debug_line;
10055 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10056 dstr->sv_debug_cloned = 1;
10057 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10060 ptr_table_store(PL_ptr_table, sstr, dstr);
10063 SvFLAGS(dstr) = SvFLAGS(sstr);
10064 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10065 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10068 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10069 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10070 (void*)PL_watch_pvx, SvPVX_const(sstr));
10073 /* don't clone objects whose class has asked us not to */
10074 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10079 switch (SvTYPE(sstr)) {
10081 SvANY(dstr) = NULL;
10084 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10085 SvIV_set(dstr, SvIVX(sstr));
10088 SvANY(dstr) = new_XNV();
10089 SvNV_set(dstr, SvNVX(sstr));
10092 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10093 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10095 /* case SVt_BIND: */
10098 /* These are all the types that need complex bodies allocating. */
10100 const svtype sv_type = SvTYPE(sstr);
10101 const struct body_details *const sv_type_details
10102 = bodies_by_type + sv_type;
10106 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10110 if (GvUNIQUE((GV*)sstr)) {
10111 NOOP; /* Do sharing here, and fall through */
10123 assert(sv_type_details->body_size);
10124 if (sv_type_details->arena) {
10125 new_body_inline(new_body, sv_type);
10127 = (void*)((char*)new_body - sv_type_details->offset);
10129 new_body = new_NOARENA(sv_type_details);
10133 SvANY(dstr) = new_body;
10136 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10137 ((char*)SvANY(dstr)) + sv_type_details->offset,
10138 sv_type_details->copy, char);
10140 Copy(((char*)SvANY(sstr)),
10141 ((char*)SvANY(dstr)),
10142 sv_type_details->body_size + sv_type_details->offset, char);
10145 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10146 && !isGV_with_GP(dstr))
10147 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10149 /* The Copy above means that all the source (unduplicated) pointers
10150 are now in the destination. We can check the flags and the
10151 pointers in either, but it's possible that there's less cache
10152 missing by always going for the destination.
10153 FIXME - instrument and check that assumption */
10154 if (sv_type >= SVt_PVMG) {
10155 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10156 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10157 } else if (SvMAGIC(dstr))
10158 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10160 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10163 /* The cast silences a GCC warning about unhandled types. */
10164 switch ((int)sv_type) {
10174 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10175 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10176 LvTARG(dstr) = dstr;
10177 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10178 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10180 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10182 if(isGV_with_GP(sstr)) {
10183 if (GvNAME_HEK(dstr))
10184 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10185 /* Don't call sv_add_backref here as it's going to be
10186 created as part of the magic cloning of the symbol
10188 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10189 at the point of this comment. */
10190 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10191 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10192 (void)GpREFCNT_inc(GvGP(dstr));
10194 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10197 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10198 if (IoOFP(dstr) == IoIFP(sstr))
10199 IoOFP(dstr) = IoIFP(dstr);
10201 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10202 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10203 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10204 /* I have no idea why fake dirp (rsfps)
10205 should be treated differently but otherwise
10206 we end up with leaks -- sky*/
10207 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10208 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10209 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10211 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10212 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10213 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10214 if (IoDIRP(dstr)) {
10215 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10218 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10221 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10222 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10223 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10226 if (AvARRAY((AV*)sstr)) {
10227 SV **dst_ary, **src_ary;
10228 SSize_t items = AvFILLp((AV*)sstr) + 1;
10230 src_ary = AvARRAY((AV*)sstr);
10231 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10232 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10233 AvARRAY((AV*)dstr) = dst_ary;
10234 AvALLOC((AV*)dstr) = dst_ary;
10235 if (AvREAL((AV*)sstr)) {
10236 while (items-- > 0)
10237 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10240 while (items-- > 0)
10241 *dst_ary++ = sv_dup(*src_ary++, param);
10243 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10244 while (items-- > 0) {
10245 *dst_ary++ = &PL_sv_undef;
10249 AvARRAY((AV*)dstr) = NULL;
10250 AvALLOC((AV*)dstr) = (SV**)NULL;
10254 if (HvARRAY((HV*)sstr)) {
10256 const bool sharekeys = !!HvSHAREKEYS(sstr);
10257 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10258 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10260 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10261 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10263 HvARRAY(dstr) = (HE**)darray;
10264 while (i <= sxhv->xhv_max) {
10265 const HE * const source = HvARRAY(sstr)[i];
10266 HvARRAY(dstr)[i] = source
10267 ? he_dup(source, sharekeys, param) : 0;
10272 const struct xpvhv_aux * const saux = HvAUX(sstr);
10273 struct xpvhv_aux * const daux = HvAUX(dstr);
10274 /* This flag isn't copied. */
10275 /* SvOOK_on(hv) attacks the IV flags. */
10276 SvFLAGS(dstr) |= SVf_OOK;
10278 hvname = saux->xhv_name;
10279 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10281 daux->xhv_riter = saux->xhv_riter;
10282 daux->xhv_eiter = saux->xhv_eiter
10283 ? he_dup(saux->xhv_eiter,
10284 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10285 daux->xhv_backreferences =
10286 saux->xhv_backreferences
10287 ? (AV*) SvREFCNT_inc(
10288 sv_dup((SV*)saux->xhv_backreferences, param))
10291 daux->xhv_mro_meta = saux->xhv_mro_meta
10292 ? mro_meta_dup(saux->xhv_mro_meta, param)
10295 /* Record stashes for possible cloning in Perl_clone(). */
10297 av_push(param->stashes, dstr);
10301 HvARRAY((HV*)dstr) = NULL;
10304 if (!(param->flags & CLONEf_COPY_STACKS)) {
10308 /* NOTE: not refcounted */
10309 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10311 if (!CvISXSUB(dstr))
10312 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10314 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10315 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10316 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10317 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10319 /* don't dup if copying back - CvGV isn't refcounted, so the
10320 * duped GV may never be freed. A bit of a hack! DAPM */
10321 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10322 NULL : gv_dup(CvGV(dstr), param) ;
10323 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10325 CvWEAKOUTSIDE(sstr)
10326 ? cv_dup( CvOUTSIDE(dstr), param)
10327 : cv_dup_inc(CvOUTSIDE(dstr), param);
10328 if (!CvISXSUB(dstr))
10329 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10335 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10341 /* duplicate a context */
10344 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10346 PERL_CONTEXT *ncxs;
10349 return (PERL_CONTEXT*)NULL;
10351 /* look for it in the table first */
10352 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10356 /* create anew and remember what it is */
10357 Newxz(ncxs, max + 1, PERL_CONTEXT);
10358 ptr_table_store(PL_ptr_table, cxs, ncxs);
10361 PERL_CONTEXT * const cx = &cxs[ix];
10362 PERL_CONTEXT * const ncx = &ncxs[ix];
10363 ncx->cx_type = cx->cx_type;
10364 if (CxTYPE(cx) == CXt_SUBST) {
10365 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10368 ncx->blk_oldsp = cx->blk_oldsp;
10369 ncx->blk_oldcop = cx->blk_oldcop;
10370 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10371 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10372 ncx->blk_oldpm = cx->blk_oldpm;
10373 ncx->blk_gimme = cx->blk_gimme;
10374 switch (CxTYPE(cx)) {
10376 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10377 ? cv_dup_inc(cx->blk_sub.cv, param)
10378 : cv_dup(cx->blk_sub.cv,param));
10379 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10380 ? av_dup_inc(cx->blk_sub.argarray, param)
10382 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10383 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10384 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10385 ncx->blk_sub.lval = cx->blk_sub.lval;
10386 ncx->blk_sub.retop = cx->blk_sub.retop;
10387 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10388 cx->blk_sub.oldcomppad);
10391 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10392 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10393 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10394 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10395 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10396 ncx->blk_eval.retop = cx->blk_eval.retop;
10399 ncx->blk_loop.label = cx->blk_loop.label;
10400 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10401 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10402 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10403 ? cx->blk_loop.iterdata
10404 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10405 ncx->blk_loop.oldcomppad
10406 = (PAD*)ptr_table_fetch(PL_ptr_table,
10407 cx->blk_loop.oldcomppad);
10408 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10409 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10410 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10411 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10412 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10415 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10416 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10417 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10418 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10419 ncx->blk_sub.retop = cx->blk_sub.retop;
10431 /* duplicate a stack info structure */
10434 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10439 return (PERL_SI*)NULL;
10441 /* look for it in the table first */
10442 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10446 /* create anew and remember what it is */
10447 Newxz(nsi, 1, PERL_SI);
10448 ptr_table_store(PL_ptr_table, si, nsi);
10450 nsi->si_stack = av_dup_inc(si->si_stack, param);
10451 nsi->si_cxix = si->si_cxix;
10452 nsi->si_cxmax = si->si_cxmax;
10453 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10454 nsi->si_type = si->si_type;
10455 nsi->si_prev = si_dup(si->si_prev, param);
10456 nsi->si_next = si_dup(si->si_next, param);
10457 nsi->si_markoff = si->si_markoff;
10462 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10463 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10464 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10465 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10466 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10467 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10468 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10469 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10470 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10471 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10472 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10473 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10474 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10475 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10478 #define pv_dup_inc(p) SAVEPV(p)
10479 #define pv_dup(p) SAVEPV(p)
10480 #define svp_dup_inc(p,pp) any_dup(p,pp)
10482 /* map any object to the new equivent - either something in the
10483 * ptr table, or something in the interpreter structure
10487 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10492 return (void*)NULL;
10494 /* look for it in the table first */
10495 ret = ptr_table_fetch(PL_ptr_table, v);
10499 /* see if it is part of the interpreter structure */
10500 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10501 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10509 /* duplicate the save stack */
10512 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10515 ANY * const ss = proto_perl->Isavestack;
10516 const I32 max = proto_perl->Isavestack_max;
10517 I32 ix = proto_perl->Isavestack_ix;
10530 void (*dptr) (void*);
10531 void (*dxptr) (pTHX_ void*);
10533 Newxz(nss, max, ANY);
10536 const I32 type = POPINT(ss,ix);
10537 TOPINT(nss,ix) = type;
10539 case SAVEt_HELEM: /* hash element */
10540 sv = (SV*)POPPTR(ss,ix);
10541 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10543 case SAVEt_ITEM: /* normal string */
10544 case SAVEt_SV: /* scalar reference */
10545 sv = (SV*)POPPTR(ss,ix);
10546 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10549 case SAVEt_MORTALIZESV:
10550 sv = (SV*)POPPTR(ss,ix);
10551 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10553 case SAVEt_SHARED_PVREF: /* char* in shared space */
10554 c = (char*)POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = savesharedpv(c);
10556 ptr = POPPTR(ss,ix);
10557 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10559 case SAVEt_GENERIC_SVREF: /* generic sv */
10560 case SAVEt_SVREF: /* scalar reference */
10561 sv = (SV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10563 ptr = POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10566 case SAVEt_HV: /* hash reference */
10567 case SAVEt_AV: /* array reference */
10568 sv = (SV*) POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10571 case SAVEt_COMPPAD:
10573 sv = (SV*) POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = sv_dup(sv, param);
10576 case SAVEt_INT: /* int reference */
10577 ptr = POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10579 intval = (int)POPINT(ss,ix);
10580 TOPINT(nss,ix) = intval;
10582 case SAVEt_LONG: /* long reference */
10583 ptr = POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10586 case SAVEt_CLEARSV:
10587 longval = (long)POPLONG(ss,ix);
10588 TOPLONG(nss,ix) = longval;
10590 case SAVEt_I32: /* I32 reference */
10591 case SAVEt_I16: /* I16 reference */
10592 case SAVEt_I8: /* I8 reference */
10593 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10594 ptr = POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 TOPINT(nss,ix) = i;
10599 case SAVEt_IV: /* IV reference */
10600 ptr = POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10603 TOPIV(nss,ix) = iv;
10605 case SAVEt_HPTR: /* HV* reference */
10606 case SAVEt_APTR: /* AV* reference */
10607 case SAVEt_SPTR: /* SV* reference */
10608 ptr = POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10610 sv = (SV*)POPPTR(ss,ix);
10611 TOPPTR(nss,ix) = sv_dup(sv, param);
10613 case SAVEt_VPTR: /* random* reference */
10614 ptr = POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10616 ptr = POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10619 case SAVEt_GENERIC_PVREF: /* generic char* */
10620 case SAVEt_PPTR: /* char* reference */
10621 ptr = POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10623 c = (char*)POPPTR(ss,ix);
10624 TOPPTR(nss,ix) = pv_dup(c);
10626 case SAVEt_GP: /* scalar reference */
10627 gp = (GP*)POPPTR(ss,ix);
10628 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10629 (void)GpREFCNT_inc(gp);
10630 gv = (GV*)POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10634 ptr = POPPTR(ss,ix);
10635 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10636 /* these are assumed to be refcounted properly */
10638 switch (((OP*)ptr)->op_type) {
10640 case OP_LEAVESUBLV:
10644 case OP_LEAVEWRITE:
10645 TOPPTR(nss,ix) = ptr;
10648 (void) OpREFCNT_inc(o);
10652 TOPPTR(nss,ix) = NULL;
10657 TOPPTR(nss,ix) = NULL;
10660 c = (char*)POPPTR(ss,ix);
10661 TOPPTR(nss,ix) = pv_dup_inc(c);
10664 hv = (HV*)POPPTR(ss,ix);
10665 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10666 c = (char*)POPPTR(ss,ix);
10667 TOPPTR(nss,ix) = pv_dup_inc(c);
10669 case SAVEt_STACK_POS: /* Position on Perl stack */
10671 TOPINT(nss,ix) = i;
10673 case SAVEt_DESTRUCTOR:
10674 ptr = POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10676 dptr = POPDPTR(ss,ix);
10677 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10678 any_dup(FPTR2DPTR(void *, dptr),
10681 case SAVEt_DESTRUCTOR_X:
10682 ptr = POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10684 dxptr = POPDXPTR(ss,ix);
10685 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10686 any_dup(FPTR2DPTR(void *, dxptr),
10689 case SAVEt_REGCONTEXT:
10692 TOPINT(nss,ix) = i;
10695 case SAVEt_AELEM: /* array element */
10696 sv = (SV*)POPPTR(ss,ix);
10697 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10699 TOPINT(nss,ix) = i;
10700 av = (AV*)POPPTR(ss,ix);
10701 TOPPTR(nss,ix) = av_dup_inc(av, param);
10704 ptr = POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = ptr;
10709 TOPINT(nss,ix) = i;
10710 ptr = POPPTR(ss,ix);
10713 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10714 HINTS_REFCNT_UNLOCK;
10716 TOPPTR(nss,ix) = ptr;
10717 if (i & HINT_LOCALIZE_HH) {
10718 hv = (HV*)POPPTR(ss,ix);
10719 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10723 longval = (long)POPLONG(ss,ix);
10724 TOPLONG(nss,ix) = longval;
10725 ptr = POPPTR(ss,ix);
10726 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10727 sv = (SV*)POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = sv_dup(sv, param);
10731 ptr = POPPTR(ss,ix);
10732 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10733 longval = (long)POPBOOL(ss,ix);
10734 TOPBOOL(nss,ix) = (bool)longval;
10736 case SAVEt_SET_SVFLAGS:
10738 TOPINT(nss,ix) = i;
10740 TOPINT(nss,ix) = i;
10741 sv = (SV*)POPPTR(ss,ix);
10742 TOPPTR(nss,ix) = sv_dup(sv, param);
10744 case SAVEt_RE_STATE:
10746 const struct re_save_state *const old_state
10747 = (struct re_save_state *)
10748 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10749 struct re_save_state *const new_state
10750 = (struct re_save_state *)
10751 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10753 Copy(old_state, new_state, 1, struct re_save_state);
10754 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10756 new_state->re_state_bostr
10757 = pv_dup(old_state->re_state_bostr);
10758 new_state->re_state_reginput
10759 = pv_dup(old_state->re_state_reginput);
10760 new_state->re_state_regeol
10761 = pv_dup(old_state->re_state_regeol);
10762 new_state->re_state_regoffs
10763 = (regexp_paren_pair*)
10764 any_dup(old_state->re_state_regoffs, proto_perl);
10765 new_state->re_state_reglastparen
10766 = (U32*) any_dup(old_state->re_state_reglastparen,
10768 new_state->re_state_reglastcloseparen
10769 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10771 /* XXX This just has to be broken. The old save_re_context
10772 code did SAVEGENERICPV(PL_reg_start_tmp);
10773 PL_reg_start_tmp is char **.
10774 Look above to what the dup code does for
10775 SAVEt_GENERIC_PVREF
10776 It can never have worked.
10777 So this is merely a faithful copy of the exiting bug: */
10778 new_state->re_state_reg_start_tmp
10779 = (char **) pv_dup((char *)
10780 old_state->re_state_reg_start_tmp);
10781 /* I assume that it only ever "worked" because no-one called
10782 (pseudo)fork while the regexp engine had re-entered itself.
10784 #ifdef PERL_OLD_COPY_ON_WRITE
10785 new_state->re_state_nrs
10786 = sv_dup(old_state->re_state_nrs, param);
10788 new_state->re_state_reg_magic
10789 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10791 new_state->re_state_reg_oldcurpm
10792 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10794 new_state->re_state_reg_curpm
10795 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10797 new_state->re_state_reg_oldsaved
10798 = pv_dup(old_state->re_state_reg_oldsaved);
10799 new_state->re_state_reg_poscache
10800 = pv_dup(old_state->re_state_reg_poscache);
10801 new_state->re_state_reg_starttry
10802 = pv_dup(old_state->re_state_reg_starttry);
10805 case SAVEt_COMPILE_WARNINGS:
10806 ptr = POPPTR(ss,ix);
10807 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10810 ptr = POPPTR(ss,ix);
10811 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10815 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10823 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10824 * flag to the result. This is done for each stash before cloning starts,
10825 * so we know which stashes want their objects cloned */
10828 do_mark_cloneable_stash(pTHX_ SV *sv)
10830 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10832 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10833 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10834 if (cloner && GvCV(cloner)) {
10841 XPUSHs(sv_2mortal(newSVhek(hvname)));
10843 call_sv((SV*)GvCV(cloner), G_SCALAR);
10850 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10858 =for apidoc perl_clone
10860 Create and return a new interpreter by cloning the current one.
10862 perl_clone takes these flags as parameters:
10864 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10865 without it we only clone the data and zero the stacks,
10866 with it we copy the stacks and the new perl interpreter is
10867 ready to run at the exact same point as the previous one.
10868 The pseudo-fork code uses COPY_STACKS while the
10869 threads->create doesn't.
10871 CLONEf_KEEP_PTR_TABLE
10872 perl_clone keeps a ptr_table with the pointer of the old
10873 variable as a key and the new variable as a value,
10874 this allows it to check if something has been cloned and not
10875 clone it again but rather just use the value and increase the
10876 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10877 the ptr_table using the function
10878 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10879 reason to keep it around is if you want to dup some of your own
10880 variable who are outside the graph perl scans, example of this
10881 code is in threads.xs create
10884 This is a win32 thing, it is ignored on unix, it tells perls
10885 win32host code (which is c++) to clone itself, this is needed on
10886 win32 if you want to run two threads at the same time,
10887 if you just want to do some stuff in a separate perl interpreter
10888 and then throw it away and return to the original one,
10889 you don't need to do anything.
10894 /* XXX the above needs expanding by someone who actually understands it ! */
10895 EXTERN_C PerlInterpreter *
10896 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10899 perl_clone(PerlInterpreter *proto_perl, UV flags)
10902 #ifdef PERL_IMPLICIT_SYS
10904 /* perlhost.h so we need to call into it
10905 to clone the host, CPerlHost should have a c interface, sky */
10907 if (flags & CLONEf_CLONE_HOST) {
10908 return perl_clone_host(proto_perl,flags);
10910 return perl_clone_using(proto_perl, flags,
10912 proto_perl->IMemShared,
10913 proto_perl->IMemParse,
10915 proto_perl->IStdIO,
10919 proto_perl->IProc);
10923 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10924 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10925 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10926 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10927 struct IPerlDir* ipD, struct IPerlSock* ipS,
10928 struct IPerlProc* ipP)
10930 /* XXX many of the string copies here can be optimized if they're
10931 * constants; they need to be allocated as common memory and just
10932 * their pointers copied. */
10935 CLONE_PARAMS clone_params;
10936 CLONE_PARAMS* const param = &clone_params;
10938 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10939 /* for each stash, determine whether its objects should be cloned */
10940 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10941 PERL_SET_THX(my_perl);
10944 PoisonNew(my_perl, 1, PerlInterpreter);
10950 PL_savestack_ix = 0;
10951 PL_savestack_max = -1;
10952 PL_sig_pending = 0;
10954 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10955 # else /* !DEBUGGING */
10956 Zero(my_perl, 1, PerlInterpreter);
10957 # endif /* DEBUGGING */
10959 /* host pointers */
10961 PL_MemShared = ipMS;
10962 PL_MemParse = ipMP;
10969 #else /* !PERL_IMPLICIT_SYS */
10971 CLONE_PARAMS clone_params;
10972 CLONE_PARAMS* param = &clone_params;
10973 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10974 /* for each stash, determine whether its objects should be cloned */
10975 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10976 PERL_SET_THX(my_perl);
10979 PoisonNew(my_perl, 1, PerlInterpreter);
10985 PL_savestack_ix = 0;
10986 PL_savestack_max = -1;
10987 PL_sig_pending = 0;
10989 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10990 # else /* !DEBUGGING */
10991 Zero(my_perl, 1, PerlInterpreter);
10992 # endif /* DEBUGGING */
10993 #endif /* PERL_IMPLICIT_SYS */
10994 param->flags = flags;
10995 param->proto_perl = proto_perl;
10997 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10999 PL_body_arenas = NULL;
11000 Zero(&PL_body_roots, 1, PL_body_roots);
11002 PL_nice_chunk = NULL;
11003 PL_nice_chunk_size = 0;
11005 PL_sv_objcount = 0;
11007 PL_sv_arenaroot = NULL;
11009 PL_debug = proto_perl->Idebug;
11011 PL_hash_seed = proto_perl->Ihash_seed;
11012 PL_rehash_seed = proto_perl->Irehash_seed;
11014 #ifdef USE_REENTRANT_API
11015 /* XXX: things like -Dm will segfault here in perlio, but doing
11016 * PERL_SET_CONTEXT(proto_perl);
11017 * breaks too many other things
11019 Perl_reentrant_init(aTHX);
11022 /* create SV map for pointer relocation */
11023 PL_ptr_table = ptr_table_new();
11025 /* initialize these special pointers as early as possible */
11026 SvANY(&PL_sv_undef) = NULL;
11027 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11028 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11029 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11031 SvANY(&PL_sv_no) = new_XPVNV();
11032 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11033 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11034 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11035 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11036 SvCUR_set(&PL_sv_no, 0);
11037 SvLEN_set(&PL_sv_no, 1);
11038 SvIV_set(&PL_sv_no, 0);
11039 SvNV_set(&PL_sv_no, 0);
11040 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11042 SvANY(&PL_sv_yes) = new_XPVNV();
11043 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11044 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11045 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11046 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11047 SvCUR_set(&PL_sv_yes, 1);
11048 SvLEN_set(&PL_sv_yes, 2);
11049 SvIV_set(&PL_sv_yes, 1);
11050 SvNV_set(&PL_sv_yes, 1);
11051 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11053 /* create (a non-shared!) shared string table */
11054 PL_strtab = newHV();
11055 HvSHAREKEYS_off(PL_strtab);
11056 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11057 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11059 PL_compiling = proto_perl->Icompiling;
11061 /* These two PVs will be free'd special way so must set them same way op.c does */
11062 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11063 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11065 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11066 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11068 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11069 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11070 if (PL_compiling.cop_hints_hash) {
11072 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11073 HINTS_REFCNT_UNLOCK;
11075 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11076 #ifdef PERL_DEBUG_READONLY_OPS
11081 /* pseudo environmental stuff */
11082 PL_origargc = proto_perl->Iorigargc;
11083 PL_origargv = proto_perl->Iorigargv;
11085 param->stashes = newAV(); /* Setup array of objects to call clone on */
11087 /* Set tainting stuff before PerlIO_debug can possibly get called */
11088 PL_tainting = proto_perl->Itainting;
11089 PL_taint_warn = proto_perl->Itaint_warn;
11091 #ifdef PERLIO_LAYERS
11092 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11093 PerlIO_clone(aTHX_ proto_perl, param);
11096 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11097 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11098 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11099 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11100 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11101 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11104 PL_minus_c = proto_perl->Iminus_c;
11105 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11106 PL_localpatches = proto_perl->Ilocalpatches;
11107 PL_splitstr = proto_perl->Isplitstr;
11108 PL_preprocess = proto_perl->Ipreprocess;
11109 PL_minus_n = proto_perl->Iminus_n;
11110 PL_minus_p = proto_perl->Iminus_p;
11111 PL_minus_l = proto_perl->Iminus_l;
11112 PL_minus_a = proto_perl->Iminus_a;
11113 PL_minus_E = proto_perl->Iminus_E;
11114 PL_minus_F = proto_perl->Iminus_F;
11115 PL_doswitches = proto_perl->Idoswitches;
11116 PL_dowarn = proto_perl->Idowarn;
11117 PL_doextract = proto_perl->Idoextract;
11118 PL_sawampersand = proto_perl->Isawampersand;
11119 PL_unsafe = proto_perl->Iunsafe;
11120 PL_inplace = SAVEPV(proto_perl->Iinplace);
11121 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11122 PL_perldb = proto_perl->Iperldb;
11123 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11124 PL_exit_flags = proto_perl->Iexit_flags;
11126 /* magical thingies */
11127 /* XXX time(&PL_basetime) when asked for? */
11128 PL_basetime = proto_perl->Ibasetime;
11129 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11131 PL_maxsysfd = proto_perl->Imaxsysfd;
11132 PL_statusvalue = proto_perl->Istatusvalue;
11134 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11136 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11138 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11140 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11141 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11142 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11145 /* RE engine related */
11146 Zero(&PL_reg_state, 1, struct re_save_state);
11147 PL_reginterp_cnt = 0;
11148 PL_regmatch_slab = NULL;
11150 /* Clone the regex array */
11151 PL_regex_padav = newAV();
11153 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11154 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11156 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11157 for(i = 1; i <= len; i++) {
11158 const SV * const regex = regexen[i];
11161 ? sv_dup_inc(regex, param)
11163 newSViv(PTR2IV(CALLREGDUPE(
11164 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11166 if (SvFLAGS(regex) & SVf_BREAK)
11167 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11168 av_push(PL_regex_padav, sv);
11171 PL_regex_pad = AvARRAY(PL_regex_padav);
11173 /* shortcuts to various I/O objects */
11174 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11175 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11176 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11177 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11178 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11179 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11181 /* shortcuts to regexp stuff */
11182 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11184 /* shortcuts to misc objects */
11185 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11187 /* shortcuts to debugging objects */
11188 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11189 PL_DBline = gv_dup(proto_perl->IDBline, param);
11190 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11191 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11192 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11193 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11194 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11196 /* symbol tables */
11197 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11198 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11199 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11200 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11201 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11203 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11204 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11205 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11206 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11207 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11208 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11209 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11210 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11212 PL_sub_generation = proto_perl->Isub_generation;
11213 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11215 /* funky return mechanisms */
11216 PL_forkprocess = proto_perl->Iforkprocess;
11218 /* subprocess state */
11219 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11221 /* internal state */
11222 PL_maxo = proto_perl->Imaxo;
11223 if (proto_perl->Iop_mask)
11224 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11227 /* PL_asserting = proto_perl->Iasserting; */
11229 /* current interpreter roots */
11230 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11232 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11234 PL_main_start = proto_perl->Imain_start;
11235 PL_eval_root = proto_perl->Ieval_root;
11236 PL_eval_start = proto_perl->Ieval_start;
11238 /* runtime control stuff */
11239 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11241 PL_filemode = proto_perl->Ifilemode;
11242 PL_lastfd = proto_perl->Ilastfd;
11243 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11246 PL_gensym = proto_perl->Igensym;
11247 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11248 PL_laststatval = proto_perl->Ilaststatval;
11249 PL_laststype = proto_perl->Ilaststype;
11252 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11254 /* interpreter atexit processing */
11255 PL_exitlistlen = proto_perl->Iexitlistlen;
11256 if (PL_exitlistlen) {
11257 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11258 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11261 PL_exitlist = (PerlExitListEntry*)NULL;
11263 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11264 if (PL_my_cxt_size) {
11265 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11266 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11267 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11268 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11269 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11273 PL_my_cxt_list = (void**)NULL;
11274 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11275 PL_my_cxt_keys = (const char**)NULL;
11278 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11279 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11280 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11282 PL_profiledata = NULL;
11284 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11286 PAD_CLONE_VARS(proto_perl, param);
11288 #ifdef HAVE_INTERP_INTERN
11289 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11292 /* more statics moved here */
11293 PL_generation = proto_perl->Igeneration;
11294 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11296 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11297 PL_in_clean_all = proto_perl->Iin_clean_all;
11299 PL_uid = proto_perl->Iuid;
11300 PL_euid = proto_perl->Ieuid;
11301 PL_gid = proto_perl->Igid;
11302 PL_egid = proto_perl->Iegid;
11303 PL_nomemok = proto_perl->Inomemok;
11304 PL_an = proto_perl->Ian;
11305 PL_evalseq = proto_perl->Ievalseq;
11306 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11307 PL_origalen = proto_perl->Iorigalen;
11308 #ifdef PERL_USES_PL_PIDSTATUS
11309 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11311 PL_osname = SAVEPV(proto_perl->Iosname);
11312 PL_sighandlerp = proto_perl->Isighandlerp;
11314 PL_runops = proto_perl->Irunops;
11316 PL_parser = parser_dup(proto_perl->Iparser, param);
11318 PL_subline = proto_perl->Isubline;
11319 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11322 PL_cryptseen = proto_perl->Icryptseen;
11325 PL_hints = proto_perl->Ihints;
11327 PL_amagic_generation = proto_perl->Iamagic_generation;
11329 #ifdef USE_LOCALE_COLLATE
11330 PL_collation_ix = proto_perl->Icollation_ix;
11331 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11332 PL_collation_standard = proto_perl->Icollation_standard;
11333 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11334 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11335 #endif /* USE_LOCALE_COLLATE */
11337 #ifdef USE_LOCALE_NUMERIC
11338 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11339 PL_numeric_standard = proto_perl->Inumeric_standard;
11340 PL_numeric_local = proto_perl->Inumeric_local;
11341 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11342 #endif /* !USE_LOCALE_NUMERIC */
11344 /* utf8 character classes */
11345 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11346 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11347 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11348 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11349 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11350 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11351 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11352 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11353 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11354 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11355 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11356 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11357 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11358 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11359 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11360 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11361 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11362 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11363 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11364 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11366 /* Did the locale setup indicate UTF-8? */
11367 PL_utf8locale = proto_perl->Iutf8locale;
11368 /* Unicode features (see perlrun/-C) */
11369 PL_unicode = proto_perl->Iunicode;
11371 /* Pre-5.8 signals control */
11372 PL_signals = proto_perl->Isignals;
11374 /* times() ticks per second */
11375 PL_clocktick = proto_perl->Iclocktick;
11377 /* Recursion stopper for PerlIO_find_layer */
11378 PL_in_load_module = proto_perl->Iin_load_module;
11380 /* sort() routine */
11381 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11383 /* Not really needed/useful since the reenrant_retint is "volatile",
11384 * but do it for consistency's sake. */
11385 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11387 /* Hooks to shared SVs and locks. */
11388 PL_sharehook = proto_perl->Isharehook;
11389 PL_lockhook = proto_perl->Ilockhook;
11390 PL_unlockhook = proto_perl->Iunlockhook;
11391 PL_threadhook = proto_perl->Ithreadhook;
11392 PL_destroyhook = proto_perl->Idestroyhook;
11394 #ifdef THREADS_HAVE_PIDS
11395 PL_ppid = proto_perl->Ippid;
11399 PL_last_swash_hv = NULL; /* reinits on demand */
11400 PL_last_swash_klen = 0;
11401 PL_last_swash_key[0]= '\0';
11402 PL_last_swash_tmps = (U8*)NULL;
11403 PL_last_swash_slen = 0;
11405 PL_glob_index = proto_perl->Iglob_index;
11406 PL_srand_called = proto_perl->Isrand_called;
11407 PL_bitcount = NULL; /* reinits on demand */
11409 if (proto_perl->Ipsig_pend) {
11410 Newxz(PL_psig_pend, SIG_SIZE, int);
11413 PL_psig_pend = (int*)NULL;
11416 if (proto_perl->Ipsig_ptr) {
11417 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11418 Newxz(PL_psig_name, SIG_SIZE, SV*);
11419 for (i = 1; i < SIG_SIZE; i++) {
11420 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11421 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11425 PL_psig_ptr = (SV**)NULL;
11426 PL_psig_name = (SV**)NULL;
11429 /* intrpvar.h stuff */
11431 if (flags & CLONEf_COPY_STACKS) {
11432 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11433 PL_tmps_ix = proto_perl->Itmps_ix;
11434 PL_tmps_max = proto_perl->Itmps_max;
11435 PL_tmps_floor = proto_perl->Itmps_floor;
11436 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11438 while (i <= PL_tmps_ix) {
11439 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11443 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11444 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11445 Newxz(PL_markstack, i, I32);
11446 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11447 - proto_perl->Imarkstack);
11448 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11449 - proto_perl->Imarkstack);
11450 Copy(proto_perl->Imarkstack, PL_markstack,
11451 PL_markstack_ptr - PL_markstack + 1, I32);
11453 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11454 * NOTE: unlike the others! */
11455 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11456 PL_scopestack_max = proto_perl->Iscopestack_max;
11457 Newxz(PL_scopestack, PL_scopestack_max, I32);
11458 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11460 /* NOTE: si_dup() looks at PL_markstack */
11461 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11463 /* PL_curstack = PL_curstackinfo->si_stack; */
11464 PL_curstack = av_dup(proto_perl->Icurstack, param);
11465 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11467 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11468 PL_stack_base = AvARRAY(PL_curstack);
11469 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11470 - proto_perl->Istack_base);
11471 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11473 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11474 * NOTE: unlike the others! */
11475 PL_savestack_ix = proto_perl->Isavestack_ix;
11476 PL_savestack_max = proto_perl->Isavestack_max;
11477 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11478 PL_savestack = ss_dup(proto_perl, param);
11482 ENTER; /* perl_destruct() wants to LEAVE; */
11484 /* although we're not duplicating the tmps stack, we should still
11485 * add entries for any SVs on the tmps stack that got cloned by a
11486 * non-refcount means (eg a temp in @_); otherwise they will be
11489 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11490 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11491 proto_perl->Itmps_stack[i]);
11492 if (nsv && !SvREFCNT(nsv)) {
11494 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11499 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11500 PL_top_env = &PL_start_env;
11502 PL_op = proto_perl->Iop;
11505 PL_Xpv = (XPV*)NULL;
11506 my_perl->Ina = proto_perl->Ina;
11508 PL_statbuf = proto_perl->Istatbuf;
11509 PL_statcache = proto_perl->Istatcache;
11510 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11511 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11513 PL_timesbuf = proto_perl->Itimesbuf;
11516 PL_tainted = proto_perl->Itainted;
11517 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11518 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11519 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11520 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11521 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11522 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11523 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11524 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11525 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11527 PL_restartop = proto_perl->Irestartop;
11528 PL_in_eval = proto_perl->Iin_eval;
11529 PL_delaymagic = proto_perl->Idelaymagic;
11530 PL_dirty = proto_perl->Idirty;
11531 PL_localizing = proto_perl->Ilocalizing;
11533 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11534 PL_hv_fetch_ent_mh = NULL;
11535 PL_modcount = proto_perl->Imodcount;
11536 PL_lastgotoprobe = NULL;
11537 PL_dumpindent = proto_perl->Idumpindent;
11539 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11540 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11541 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11542 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11543 PL_efloatbuf = NULL; /* reinits on demand */
11544 PL_efloatsize = 0; /* reinits on demand */
11548 PL_screamfirst = NULL;
11549 PL_screamnext = NULL;
11550 PL_maxscream = -1; /* reinits on demand */
11551 PL_lastscream = NULL;
11554 PL_regdummy = proto_perl->Iregdummy;
11555 PL_colorset = 0; /* reinits PL_colors[] */
11556 /*PL_colors[6] = {0,0,0,0,0,0};*/
11560 /* Pluggable optimizer */
11561 PL_peepp = proto_perl->Ipeepp;
11563 PL_stashcache = newHV();
11565 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11566 proto_perl->Iwatchaddr);
11567 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11568 if (PL_debug && PL_watchaddr) {
11569 PerlIO_printf(Perl_debug_log,
11570 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11571 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11572 PTR2UV(PL_watchok));
11575 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11576 ptr_table_free(PL_ptr_table);
11577 PL_ptr_table = NULL;
11580 /* Call the ->CLONE method, if it exists, for each of the stashes
11581 identified by sv_dup() above.
11583 while(av_len(param->stashes) != -1) {
11584 HV* const stash = (HV*) av_shift(param->stashes);
11585 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11586 if (cloner && GvCV(cloner)) {
11591 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11593 call_sv((SV*)GvCV(cloner), G_DISCARD);
11599 SvREFCNT_dec(param->stashes);
11601 /* orphaned? eg threads->new inside BEGIN or use */
11602 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11603 SvREFCNT_inc_simple_void(PL_compcv);
11604 SAVEFREESV(PL_compcv);
11610 #endif /* USE_ITHREADS */
11613 =head1 Unicode Support
11615 =for apidoc sv_recode_to_utf8
11617 The encoding is assumed to be an Encode object, on entry the PV
11618 of the sv is assumed to be octets in that encoding, and the sv
11619 will be converted into Unicode (and UTF-8).
11621 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11622 is not a reference, nothing is done to the sv. If the encoding is not
11623 an C<Encode::XS> Encoding object, bad things will happen.
11624 (See F<lib/encoding.pm> and L<Encode>).
11626 The PV of the sv is returned.
11631 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11634 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11648 Passing sv_yes is wrong - it needs to be or'ed set of constants
11649 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11650 remove converted chars from source.
11652 Both will default the value - let them.
11654 XPUSHs(&PL_sv_yes);
11657 call_method("decode", G_SCALAR);
11661 s = SvPV_const(uni, len);
11662 if (s != SvPVX_const(sv)) {
11663 SvGROW(sv, len + 1);
11664 Move(s, SvPVX(sv), len + 1, char);
11665 SvCUR_set(sv, len);
11672 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11676 =for apidoc sv_cat_decode
11678 The encoding is assumed to be an Encode object, the PV of the ssv is
11679 assumed to be octets in that encoding and decoding the input starts
11680 from the position which (PV + *offset) pointed to. The dsv will be
11681 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11682 when the string tstr appears in decoding output or the input ends on
11683 the PV of the ssv. The value which the offset points will be modified
11684 to the last input position on the ssv.
11686 Returns TRUE if the terminator was found, else returns FALSE.
11691 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11692 SV *ssv, int *offset, char *tstr, int tlen)
11696 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11707 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11708 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11710 call_method("cat_decode", G_SCALAR);
11712 ret = SvTRUE(TOPs);
11713 *offset = SvIV(offsv);
11719 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11724 /* ---------------------------------------------------------------------
11726 * support functions for report_uninit()
11729 /* the maxiumum size of array or hash where we will scan looking
11730 * for the undefined element that triggered the warning */
11732 #define FUV_MAX_SEARCH_SIZE 1000
11734 /* Look for an entry in the hash whose value has the same SV as val;
11735 * If so, return a mortal copy of the key. */
11738 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11741 register HE **array;
11744 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11745 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11748 array = HvARRAY(hv);
11750 for (i=HvMAX(hv); i>0; i--) {
11751 register HE *entry;
11752 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11753 if (HeVAL(entry) != val)
11755 if ( HeVAL(entry) == &PL_sv_undef ||
11756 HeVAL(entry) == &PL_sv_placeholder)
11760 if (HeKLEN(entry) == HEf_SVKEY)
11761 return sv_mortalcopy(HeKEY_sv(entry));
11762 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11768 /* Look for an entry in the array whose value has the same SV as val;
11769 * If so, return the index, otherwise return -1. */
11772 S_find_array_subscript(pTHX_ AV *av, SV* val)
11775 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11776 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11779 if (val != &PL_sv_undef) {
11780 SV ** const svp = AvARRAY(av);
11783 for (i=AvFILLp(av); i>=0; i--)
11790 /* S_varname(): return the name of a variable, optionally with a subscript.
11791 * If gv is non-zero, use the name of that global, along with gvtype (one
11792 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11793 * targ. Depending on the value of the subscript_type flag, return:
11796 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11797 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11798 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11799 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11802 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11803 SV* keyname, I32 aindex, int subscript_type)
11806 SV * const name = sv_newmortal();
11809 buffer[0] = gvtype;
11812 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11814 gv_fullname4(name, gv, buffer, 0);
11816 if ((unsigned int)SvPVX(name)[1] <= 26) {
11818 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11820 /* Swap the 1 unprintable control character for the 2 byte pretty
11821 version - ie substr($name, 1, 1) = $buffer; */
11822 sv_insert(name, 1, 1, buffer, 2);
11826 CV * const cv = find_runcv(NULL);
11830 if (!cv || !CvPADLIST(cv))
11832 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11833 sv = *av_fetch(av, targ, FALSE);
11834 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11837 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11838 SV * const sv = newSV(0);
11839 *SvPVX(name) = '$';
11840 Perl_sv_catpvf(aTHX_ name, "{%s}",
11841 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11844 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11845 *SvPVX(name) = '$';
11846 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11848 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11849 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11856 =for apidoc find_uninit_var
11858 Find the name of the undefined variable (if any) that caused the operator o
11859 to issue a "Use of uninitialized value" warning.
11860 If match is true, only return a name if it's value matches uninit_sv.
11861 So roughly speaking, if a unary operator (such as OP_COS) generates a
11862 warning, then following the direct child of the op may yield an
11863 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11864 other hand, with OP_ADD there are two branches to follow, so we only print
11865 the variable name if we get an exact match.
11867 The name is returned as a mortal SV.
11869 Assumes that PL_op is the op that originally triggered the error, and that
11870 PL_comppad/PL_curpad points to the currently executing pad.
11876 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11884 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11885 uninit_sv == &PL_sv_placeholder)))
11888 switch (obase->op_type) {
11895 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11896 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11899 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11901 if (pad) { /* @lex, %lex */
11902 sv = PAD_SVl(obase->op_targ);
11906 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11907 /* @global, %global */
11908 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11911 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11913 else /* @{expr}, %{expr} */
11914 return find_uninit_var(cUNOPx(obase)->op_first,
11918 /* attempt to find a match within the aggregate */
11920 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11922 subscript_type = FUV_SUBSCRIPT_HASH;
11925 index = find_array_subscript((AV*)sv, uninit_sv);
11927 subscript_type = FUV_SUBSCRIPT_ARRAY;
11930 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11933 return varname(gv, hash ? '%' : '@', obase->op_targ,
11934 keysv, index, subscript_type);
11938 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11940 return varname(NULL, '$', obase->op_targ,
11941 NULL, 0, FUV_SUBSCRIPT_NONE);
11944 gv = cGVOPx_gv(obase);
11945 if (!gv || (match && GvSV(gv) != uninit_sv))
11947 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11950 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11953 av = (AV*)PAD_SV(obase->op_targ);
11954 if (!av || SvRMAGICAL(av))
11956 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11957 if (!svp || *svp != uninit_sv)
11960 return varname(NULL, '$', obase->op_targ,
11961 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11964 gv = cGVOPx_gv(obase);
11970 if (!av || SvRMAGICAL(av))
11972 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11973 if (!svp || *svp != uninit_sv)
11976 return varname(gv, '$', 0,
11977 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11982 o = cUNOPx(obase)->op_first;
11983 if (!o || o->op_type != OP_NULL ||
11984 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11986 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11990 if (PL_op == obase)
11991 /* $a[uninit_expr] or $h{uninit_expr} */
11992 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11995 o = cBINOPx(obase)->op_first;
11996 kid = cBINOPx(obase)->op_last;
11998 /* get the av or hv, and optionally the gv */
12000 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12001 sv = PAD_SV(o->op_targ);
12003 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12004 && cUNOPo->op_first->op_type == OP_GV)
12006 gv = cGVOPx_gv(cUNOPo->op_first);
12009 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12014 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12015 /* index is constant */
12019 if (obase->op_type == OP_HELEM) {
12020 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12021 if (!he || HeVAL(he) != uninit_sv)
12025 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12026 if (!svp || *svp != uninit_sv)
12030 if (obase->op_type == OP_HELEM)
12031 return varname(gv, '%', o->op_targ,
12032 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12034 return varname(gv, '@', o->op_targ, NULL,
12035 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12038 /* index is an expression;
12039 * attempt to find a match within the aggregate */
12040 if (obase->op_type == OP_HELEM) {
12041 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12043 return varname(gv, '%', o->op_targ,
12044 keysv, 0, FUV_SUBSCRIPT_HASH);
12047 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12049 return varname(gv, '@', o->op_targ,
12050 NULL, index, FUV_SUBSCRIPT_ARRAY);
12055 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12057 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12062 /* only examine RHS */
12063 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12066 o = cUNOPx(obase)->op_first;
12067 if (o->op_type == OP_PUSHMARK)
12070 if (!o->op_sibling) {
12071 /* one-arg version of open is highly magical */
12073 if (o->op_type == OP_GV) { /* open FOO; */
12075 if (match && GvSV(gv) != uninit_sv)
12077 return varname(gv, '$', 0,
12078 NULL, 0, FUV_SUBSCRIPT_NONE);
12080 /* other possibilities not handled are:
12081 * open $x; or open my $x; should return '${*$x}'
12082 * open expr; should return '$'.expr ideally
12088 /* ops where $_ may be an implicit arg */
12092 if ( !(obase->op_flags & OPf_STACKED)) {
12093 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12094 ? PAD_SVl(obase->op_targ)
12097 sv = sv_newmortal();
12098 sv_setpvn(sv, "$_", 2);
12107 /* skip filehandle as it can't produce 'undef' warning */
12108 o = cUNOPx(obase)->op_first;
12109 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12110 o = o->op_sibling->op_sibling;
12116 match = 1; /* XS or custom code could trigger random warnings */
12121 /* XXX tmp hack: these two may call an XS sub, and currently
12122 XS subs don't have a SUB entry on the context stack, so CV and
12123 pad determination goes wrong, and BAD things happen. So, just
12124 don't try to determine the value under those circumstances.
12125 Need a better fix at dome point. DAPM 11/2007 */
12129 /* def-ness of rval pos() is independent of the def-ness of its arg */
12130 if ( !(obase->op_flags & OPf_MOD))
12135 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12136 return sv_2mortal(newSVpvs("${$/}"));
12141 if (!(obase->op_flags & OPf_KIDS))
12143 o = cUNOPx(obase)->op_first;
12149 /* if all except one arg are constant, or have no side-effects,
12150 * or are optimized away, then it's unambiguous */
12152 for (kid=o; kid; kid = kid->op_sibling) {
12154 const OPCODE type = kid->op_type;
12155 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12156 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12157 || (type == OP_PUSHMARK)
12161 if (o2) { /* more than one found */
12168 return find_uninit_var(o2, uninit_sv, match);
12170 /* scan all args */
12172 sv = find_uninit_var(o, uninit_sv, 1);
12184 =for apidoc report_uninit
12186 Print appropriate "Use of uninitialized variable" warning
12192 Perl_report_uninit(pTHX_ SV* uninit_sv)
12196 SV* varname = NULL;
12198 varname = find_uninit_var(PL_op, uninit_sv,0);
12200 sv_insert(varname, 0, 0, " ", 1);
12202 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12203 varname ? SvPV_nolen_const(varname) : "",
12204 " in ", OP_DESC(PL_op));
12207 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12213 * c-indentation-style: bsd
12214 * c-basic-offset: 4
12215 * indent-tabs-mode: t
12218 * ex: set ts=8 sts=4 sw=4 noet: