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 *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
176 #ifdef DEBUG_LEAKING_SCALARS
177 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
179 # define FREE_SV_DEBUG_FILE(sv)
183 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
184 /* Whilst I'd love to do this, it seems that things like to check on
186 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
188 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
189 PoisonNew(&SvREFCNT(sv), 1, U32)
191 # define SvARENA_CHAIN(sv) SvANY(sv)
192 # define POSION_SV_HEAD(sv)
195 #define plant_SV(p) \
197 FREE_SV_DEBUG_FILE(p); \
199 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 #define uproot_SV(p) \
208 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
213 /* make some more SVs by adding another arena */
222 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
223 PL_nice_chunk = NULL;
224 PL_nice_chunk_size = 0;
227 char *chunk; /* must use New here to match call to */
228 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
229 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
235 /* new_SV(): return a new, empty SV head */
237 #ifdef DEBUG_LEAKING_SCALARS
238 /* provide a real function for a debugger to play with */
247 sv = S_more_sv(aTHX);
251 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
252 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
258 sv->sv_debug_inpad = 0;
259 sv->sv_debug_cloned = 0;
260 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
264 # define new_SV(p) (p)=S_new_SV(aTHX)
272 (p) = S_more_sv(aTHX); \
280 /* del_SV(): return an empty SV head to the free list */
293 S_del_sv(pTHX_ SV *p)
297 PERL_ARGS_ASSERT_DEL_SV;
302 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
303 const SV * const sv = sva + 1;
304 const SV * const svend = &sva[SvREFCNT(sva)];
305 if (p >= sv && p < svend) {
311 if (ckWARN_d(WARN_INTERNAL))
312 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
313 "Attempt to free non-arena SV: 0x%"UVxf
314 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
321 #else /* ! DEBUGGING */
323 #define del_SV(p) plant_SV(p)
325 #endif /* DEBUGGING */
329 =head1 SV Manipulation Functions
331 =for apidoc sv_add_arena
333 Given a chunk of memory, link it to the head of the list of arenas,
334 and split it into a list of free SVs.
340 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
343 SV* const sva = (SV*)ptr;
347 PERL_ARGS_ASSERT_SV_ADD_ARENA;
349 /* The first SV in an arena isn't an SV. */
350 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
351 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
352 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
354 PL_sv_arenaroot = sva;
355 PL_sv_root = sva + 1;
357 svend = &sva[SvREFCNT(sva) - 1];
360 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
364 /* Must always set typemask because it's always checked in on cleanup
365 when the arenas are walked looking for objects. */
366 SvFLAGS(sv) = SVTYPEMASK;
369 SvARENA_CHAIN(sv) = 0;
373 SvFLAGS(sv) = SVTYPEMASK;
376 /* visit(): call the named function for each non-free SV in the arenas
377 * whose flags field matches the flags/mask args. */
380 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
386 PERL_ARGS_ASSERT_VISIT;
388 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
389 register const SV * const svend = &sva[SvREFCNT(sva)];
391 for (sv = sva + 1; sv < svend; ++sv) {
392 if (SvTYPE(sv) != SVTYPEMASK
393 && (sv->sv_flags & mask) == flags
406 /* called by sv_report_used() for each live SV */
409 do_report_used(pTHX_ SV *const sv)
411 if (SvTYPE(sv) != SVTYPEMASK) {
412 PerlIO_printf(Perl_debug_log, "****\n");
419 =for apidoc sv_report_used
421 Dump the contents of all SVs not yet freed. (Debugging aid).
427 Perl_sv_report_used(pTHX)
430 visit(do_report_used, 0, 0);
436 /* called by sv_clean_objs() for each live SV */
439 do_clean_objs(pTHX_ SV *const ref)
444 SV * const target = SvRV(ref);
445 if (SvOBJECT(target)) {
446 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
447 if (SvWEAKREF(ref)) {
448 sv_del_backref(target, ref);
454 SvREFCNT_dec(target);
459 /* XXX Might want to check arrays, etc. */
462 /* called by sv_clean_objs() for each live SV */
464 #ifndef DISABLE_DESTRUCTOR_KLUDGE
466 do_clean_named_objs(pTHX_ SV *const sv)
469 assert(SvTYPE(sv) == SVt_PVGV);
470 assert(isGV_with_GP(sv));
473 #ifdef PERL_DONT_CREATE_GVSV
476 SvOBJECT(GvSV(sv))) ||
477 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
478 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
479 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
480 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *const sv)
518 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
519 /* don't clean pid table and strtab */
522 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
523 SvFLAGS(sv) |= SVf_BREAK;
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list.
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types, by changing array* fields
561 in body_details_by_type[] below.
564 char *arena; /* the raw storage, allocated aligned */
565 size_t size; /* its size ~4k typ */
566 U32 misc; /* type, and in future other things. */
571 /* Get the maximum number of elements in set[] such that struct arena_set
572 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
573 therefore likely to be 1 aligned memory page. */
575 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
576 - 2 * sizeof(int)) / sizeof (struct arena_desc))
579 struct arena_set* next;
580 unsigned int set_size; /* ie ARENAS_PER_SET */
581 unsigned int curr; /* index of next available arena-desc */
582 struct arena_desc set[ARENAS_PER_SET];
586 =for apidoc sv_free_arenas
588 Deallocate the memory used by all arenas. Note that all the individual SV
589 heads and bodies within the arenas must already have been freed.
594 Perl_sv_free_arenas(pTHX)
601 /* Free arenas here, but be careful about fake ones. (We assume
602 contiguity of the fake ones with the corresponding real ones.) */
604 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
605 svanext = (SV*) SvANY(sva);
606 while (svanext && SvFAKE(svanext))
607 svanext = (SV*) SvANY(svanext);
614 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
617 struct arena_set *current = aroot;
620 assert(aroot->set[i].arena);
621 Safefree(aroot->set[i].arena);
629 i = PERL_ARENA_ROOTS_SIZE;
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
682 struct arena_desc* adesc;
683 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!aroot || aroot->curr >= aroot->set_size) {
692 struct arena_set *newroot;
693 Newxz(newroot, 1, struct arena_set);
694 newroot->set_size = ARENAS_PER_SET;
695 newroot->next = aroot;
697 PL_body_arenas = (void *) newroot;
698 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
701 /* ok, now have arena-set with at least 1 empty/available arena-desc */
702 curr = aroot->curr++;
703 adesc = &(aroot->set[curr]);
704 assert(!adesc->arena);
706 Newx(adesc->arena, arena_size, char);
707 adesc->size = arena_size;
709 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
710 curr, (void*)adesc->arena, (UV)arena_size));
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
721 *thing_copy = *root; \
722 *root = (void*)thing_copy; \
727 =head1 SV-Body Allocation
729 Allocation of SV-bodies is similar to SV-heads, differing as follows;
730 the allocation mechanism is used for many body types, so is somewhat
731 more complicated, it uses arena-sets, and has no need for still-live
734 At the outermost level, (new|del)_X*V macros return bodies of the
735 appropriate type. These macros call either (new|del)_body_type or
736 (new|del)_body_allocated macro pairs, depending on specifics of the
737 type. Most body types use the former pair, the latter pair is used to
738 allocate body types with "ghost fields".
740 "ghost fields" are fields that are unused in certain types, and
741 consequently dont need to actually exist. They are declared because
742 they're part of a "base type", which allows use of functions as
743 methods. The simplest examples are AVs and HVs, 2 aggregate types
744 which don't use the fields which support SCALAR semantics.
746 For these types, the arenas are carved up into *_allocated size
747 chunks, we thus avoid wasted memory for those unaccessed members.
748 When bodies are allocated, we adjust the pointer back in memory by the
749 size of the bit not allocated, so it's as if we allocated the full
750 structure. (But things will all go boom if you write to the part that
751 is "not there", because you'll be overwriting the last members of the
752 preceding structure in memory.)
754 We calculate the correction using the STRUCT_OFFSET macro. For
755 example, if xpv_allocated is the same structure as XPV then the two
756 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
757 structure is smaller (no initial NV actually allocated) then the net
758 effect is to subtract the size of the NV from the pointer, to return a
759 new pointer as if an initial NV were actually allocated.
761 This is the same trick as was used for NV and IV bodies. Ironically it
762 doesn't need to be used for NV bodies any more, because NV is now at
763 the start of the structure. IV bodies don't need it either, because
764 they are no longer allocated.
766 In turn, the new_body_* allocators call S_new_body(), which invokes
767 new_body_inline macro, which takes a lock, and takes a body off the
768 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
769 necessary to refresh an empty list. Then the lock is released, and
770 the body is returned.
772 S_more_bodies calls get_arena(), and carves it up into an array of N
773 bodies, which it strings into a linked list. It looks up arena-size
774 and body-size from the body_details table described below, thus
775 supporting the multiple body-types.
777 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
778 the (new|del)_X*V macros are mapped directly to malloc/free.
784 For each sv-type, struct body_details bodies_by_type[] carries
785 parameters which control these aspects of SV handling:
787 Arena_size determines whether arenas are used for this body type, and if
788 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
789 zero, forcing individual mallocs and frees.
791 Body_size determines how big a body is, and therefore how many fit into
792 each arena. Offset carries the body-pointer adjustment needed for
793 *_allocated body types, and is used in *_allocated macros.
795 But its main purpose is to parameterize info needed in
796 Perl_sv_upgrade(). The info here dramatically simplifies the function
797 vs the implementation in 5.8.7, making it table-driven. All fields
798 are used for this, except for arena_size.
800 For the sv-types that have no bodies, arenas are not used, so those
801 PL_body_roots[sv_type] are unused, and can be overloaded. In
802 something of a special case, SVt_NULL is borrowed for HE arenas;
803 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
804 bodies_by_type[SVt_NULL] slot is not used, as the table is not
807 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
808 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
809 just use the same allocation semantics. At first, PTEs were also
810 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
811 bugs, so was simplified by claiming a new slot. This choice has no
812 consequence at this time.
816 struct body_details {
817 U8 body_size; /* Size to allocate */
818 U8 copy; /* Size of structure to copy (may be shorter) */
820 unsigned int type : 4; /* We have space for a sanity check. */
821 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
822 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
823 unsigned int arena : 1; /* Allocated from an arena */
824 size_t arena_size; /* Size of arena to allocate */
832 /* With -DPURFIY we allocate everything directly, and don't use arenas.
833 This seems a rather elegant way to simplify some of the code below. */
834 #define HASARENA FALSE
836 #define HASARENA TRUE
838 #define NOARENA FALSE
840 /* Size the arenas to exactly fit a given number of bodies. A count
841 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
842 simplifying the default. If count > 0, the arena is sized to fit
843 only that many bodies, allowing arenas to be used for large, rare
844 bodies (XPVFM, XPVIO) without undue waste. The arena size is
845 limited by PERL_ARENA_SIZE, so we can safely oversize the
848 #define FIT_ARENA0(body_size) \
849 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
850 #define FIT_ARENAn(count,body_size) \
851 ( count * body_size <= PERL_ARENA_SIZE) \
852 ? count * body_size \
853 : FIT_ARENA0 (body_size)
854 #define FIT_ARENA(count,body_size) \
856 ? FIT_ARENAn (count, body_size) \
857 : FIT_ARENA0 (body_size)
859 /* A macro to work out the offset needed to subtract from a pointer to (say)
866 to make its members accessible via a pointer to (say)
876 #define relative_STRUCT_OFFSET(longer, shorter, member) \
877 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
879 /* Calculate the length to copy. Specifically work out the length less any
880 final padding the compiler needed to add. See the comment in sv_upgrade
881 for why copying the padding proved to be a bug. */
883 #define copy_length(type, last_member) \
884 STRUCT_OFFSET(type, last_member) \
885 + sizeof (((type*)SvANY((SV*)0))->last_member)
887 static const struct body_details bodies_by_type[] = {
888 { sizeof(HE), 0, 0, SVt_NULL,
889 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
891 /* The bind placeholder pretends to be an RV for now.
892 Also it's marked as "can't upgrade" to stop anyone using it before it's
894 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
896 /* IVs are in the head, so the allocation size is 0.
897 However, the slot is overloaded for PTEs. */
898 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
899 sizeof(IV), /* This is used to copy out the IV body. */
900 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
901 NOARENA /* IVS don't need an arena */,
902 /* But PTEs need to know the size of their arena */
903 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
908 FIT_ARENA(0, sizeof(NV)) },
910 /* 8 bytes on most ILP32 with IEEE doubles */
911 { sizeof(xpv_allocated),
912 copy_length(XPV, xpv_len)
913 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
918 { sizeof(xpviv_allocated),
919 copy_length(XPVIV, xiv_u)
920 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
925 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
929 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
933 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
934 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
935 SVt_REGEXP, FALSE, NONV, HASARENA,
936 FIT_ARENA(0, sizeof(struct regexp_allocated))
940 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
944 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
945 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
947 { sizeof(xpvav_allocated),
948 copy_length(XPVAV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
953 { sizeof(xpvhv_allocated),
954 copy_length(XPVHV, xmg_stash)
955 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
960 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
961 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
962 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
964 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
965 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
966 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
968 /* XPVIO is 84 bytes, fits 48x */
969 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
970 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
971 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
974 #define new_body_type(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type))
977 #define del_body_type(p, sv_type) \
978 del_body(p, &PL_body_roots[sv_type])
981 #define new_body_allocated(sv_type) \
982 (void *)((char *)S_new_body(aTHX_ sv_type) \
983 - bodies_by_type[sv_type].offset)
985 #define del_body_allocated(p, sv_type) \
986 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
989 #define my_safemalloc(s) (void*)safemalloc(s)
990 #define my_safecalloc(s) (void*)safecalloc(s, 1)
991 #define my_safefree(p) safefree((char*)p)
995 #define new_XNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XNV(p) my_safefree(p)
998 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
999 #define del_XPVNV(p) my_safefree(p)
1001 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1002 #define del_XPVAV(p) my_safefree(p)
1004 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1005 #define del_XPVHV(p) my_safefree(p)
1007 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1008 #define del_XPVMG(p) my_safefree(p)
1010 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1011 #define del_XPVGV(p) my_safefree(p)
1015 #define new_XNV() new_body_type(SVt_NV)
1016 #define del_XNV(p) del_body_type(p, SVt_NV)
1018 #define new_XPVNV() new_body_type(SVt_PVNV)
1019 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1021 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1022 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1024 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1025 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1027 #define new_XPVMG() new_body_type(SVt_PVMG)
1028 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1030 #define new_XPVGV() new_body_type(SVt_PVGV)
1031 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1035 /* no arena for you! */
1037 #define new_NOARENA(details) \
1038 my_safemalloc((details)->body_size + (details)->offset)
1039 #define new_NOARENAZ(details) \
1040 my_safecalloc((details)->body_size + (details)->offset)
1043 S_more_bodies (pTHX_ const svtype sv_type)
1046 void ** const root = &PL_body_roots[sv_type];
1047 const struct body_details * const bdp = &bodies_by_type[sv_type];
1048 const size_t body_size = bdp->body_size;
1051 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1052 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1053 static bool done_sanity_check;
1055 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1056 * variables like done_sanity_check. */
1057 if (!done_sanity_check) {
1058 unsigned int i = SVt_LAST;
1060 done_sanity_check = TRUE;
1063 assert (bodies_by_type[i].type == i);
1067 assert(bdp->arena_size);
1069 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1071 end = start + arena_size - 2 * body_size;
1073 /* computed count doesnt reflect the 1st slot reservation */
1074 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1075 DEBUG_m(PerlIO_printf(Perl_debug_log,
1076 "arena %p end %p arena-size %d (from %d) type %d "
1078 (void*)start, (void*)end, (int)arena_size,
1079 (int)bdp->arena_size, sv_type, (int)body_size,
1080 (int)arena_size / (int)body_size));
1082 DEBUG_m(PerlIO_printf(Perl_debug_log,
1083 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1084 (void*)start, (void*)end,
1085 (int)bdp->arena_size, sv_type, (int)body_size,
1086 (int)bdp->arena_size / (int)body_size));
1088 *root = (void *)start;
1090 while (start <= end) {
1091 char * const next = start + body_size;
1092 *(void**) start = (void *)next;
1095 *(void **)start = 0;
1100 /* grab a new thing from the free list, allocating more if necessary.
1101 The inline version is used for speed in hot routines, and the
1102 function using it serves the rest (unless PURIFY).
1104 #define new_body_inline(xpv, sv_type) \
1106 void ** const r3wt = &PL_body_roots[sv_type]; \
1107 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1108 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1109 *(r3wt) = *(void**)(xpv); \
1115 S_new_body(pTHX_ const svtype sv_type)
1119 new_body_inline(xpv, sv_type);
1125 static const struct body_details fake_rv =
1126 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1129 =for apidoc sv_upgrade
1131 Upgrade an SV to a more complex form. Generally adds a new body type to the
1132 SV, then copies across as much information as possible from the old body.
1133 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1139 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1144 const svtype old_type = SvTYPE(sv);
1145 const struct body_details *new_type_details;
1146 const struct body_details *old_type_details
1147 = bodies_by_type + old_type;
1148 SV *referant = NULL;
1150 PERL_ARGS_ASSERT_SV_UPGRADE;
1152 if (new_type != SVt_PV && SvIsCOW(sv)) {
1153 sv_force_normal_flags(sv, 0);
1156 if (old_type == new_type)
1159 old_body = SvANY(sv);
1161 /* Copying structures onto other structures that have been neatly zeroed
1162 has a subtle gotcha. Consider XPVMG
1164 +------+------+------+------+------+-------+-------+
1165 | NV | CUR | LEN | IV | MAGIC | STASH |
1166 +------+------+------+------+------+-------+-------+
1167 0 4 8 12 16 20 24 28
1169 where NVs are aligned to 8 bytes, so that sizeof that structure is
1170 actually 32 bytes long, with 4 bytes of padding at the end:
1172 +------+------+------+------+------+-------+-------+------+
1173 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1174 +------+------+------+------+------+-------+-------+------+
1175 0 4 8 12 16 20 24 28 32
1177 so what happens if you allocate memory for this structure:
1179 +------+------+------+------+------+-------+-------+------+------+...
1180 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1181 +------+------+------+------+------+-------+-------+------+------+...
1182 0 4 8 12 16 20 24 28 32 36
1184 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1185 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1186 started out as zero once, but it's quite possible that it isn't. So now,
1187 rather than a nicely zeroed GP, you have it pointing somewhere random.
1190 (In fact, GP ends up pointing at a previous GP structure, because the
1191 principle cause of the padding in XPVMG getting garbage is a copy of
1192 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1193 this happens to be moot because XPVGV has been re-ordered, with GP
1194 no longer after STASH)
1196 So we are careful and work out the size of used parts of all the
1204 referant = SvRV(sv);
1205 old_type_details = &fake_rv;
1206 if (new_type == SVt_NV)
1207 new_type = SVt_PVNV;
1209 if (new_type < SVt_PVIV) {
1210 new_type = (new_type == SVt_NV)
1211 ? SVt_PVNV : SVt_PVIV;
1216 if (new_type < SVt_PVNV) {
1217 new_type = SVt_PVNV;
1221 assert(new_type > SVt_PV);
1222 assert(SVt_IV < SVt_PV);
1223 assert(SVt_NV < SVt_PV);
1230 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1231 there's no way that it can be safely upgraded, because perl.c
1232 expects to Safefree(SvANY(PL_mess_sv)) */
1233 assert(sv != PL_mess_sv);
1234 /* This flag bit is used to mean other things in other scalar types.
1235 Given that it only has meaning inside the pad, it shouldn't be set
1236 on anything that can get upgraded. */
1237 assert(!SvPAD_TYPED(sv));
1240 if (old_type_details->cant_upgrade)
1241 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1242 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1245 if (old_type > new_type)
1246 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1247 (int)old_type, (int)new_type);
1249 new_type_details = bodies_by_type + new_type;
1251 SvFLAGS(sv) &= ~SVTYPEMASK;
1252 SvFLAGS(sv) |= new_type;
1254 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1255 the return statements above will have triggered. */
1256 assert (new_type != SVt_NULL);
1259 assert(old_type == SVt_NULL);
1260 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1264 assert(old_type == SVt_NULL);
1265 SvANY(sv) = new_XNV();
1270 assert(new_type_details->body_size);
1273 assert(new_type_details->arena);
1274 assert(new_type_details->arena_size);
1275 /* This points to the start of the allocated area. */
1276 new_body_inline(new_body, new_type);
1277 Zero(new_body, new_type_details->body_size, char);
1278 new_body = ((char *)new_body) - new_type_details->offset;
1280 /* We always allocated the full length item with PURIFY. To do this
1281 we fake things so that arena is false for all 16 types.. */
1282 new_body = new_NOARENAZ(new_type_details);
1284 SvANY(sv) = new_body;
1285 if (new_type == SVt_PVAV) {
1289 if (old_type_details->body_size) {
1292 /* It will have been zeroed when the new body was allocated.
1293 Lets not write to it, in case it confuses a write-back
1299 #ifndef NODEFAULT_SHAREKEYS
1300 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1302 HvMAX(sv) = 7; /* (start with 8 buckets) */
1303 if (old_type_details->body_size) {
1306 /* It will have been zeroed when the new body was allocated.
1307 Lets not write to it, in case it confuses a write-back
1312 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1313 The target created by newSVrv also is, and it can have magic.
1314 However, it never has SvPVX set.
1316 if (old_type == SVt_IV) {
1318 } else if (old_type >= SVt_PV) {
1319 assert(SvPVX_const(sv) == 0);
1322 if (old_type >= SVt_PVMG) {
1323 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1324 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1326 sv->sv_u.svu_array = NULL; /* or svu_hash */
1332 /* XXX Is this still needed? Was it ever needed? Surely as there is
1333 no route from NV to PVIV, NOK can never be true */
1334 assert(!SvNOKp(sv));
1346 assert(new_type_details->body_size);
1347 /* We always allocated the full length item with PURIFY. To do this
1348 we fake things so that arena is false for all 16 types.. */
1349 if(new_type_details->arena) {
1350 /* This points to the start of the allocated area. */
1351 new_body_inline(new_body, new_type);
1352 Zero(new_body, new_type_details->body_size, char);
1353 new_body = ((char *)new_body) - new_type_details->offset;
1355 new_body = new_NOARENAZ(new_type_details);
1357 SvANY(sv) = new_body;
1359 if (old_type_details->copy) {
1360 /* There is now the potential for an upgrade from something without
1361 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1362 int offset = old_type_details->offset;
1363 int length = old_type_details->copy;
1365 if (new_type_details->offset > old_type_details->offset) {
1366 const int difference
1367 = new_type_details->offset - old_type_details->offset;
1368 offset += difference;
1369 length -= difference;
1371 assert (length >= 0);
1373 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1378 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1379 * correct 0.0 for us. Otherwise, if the old body didn't have an
1380 * NV slot, but the new one does, then we need to initialise the
1381 * freshly created NV slot with whatever the correct bit pattern is
1383 if (old_type_details->zero_nv && !new_type_details->zero_nv
1384 && !isGV_with_GP(sv))
1388 if (new_type == SVt_PVIO)
1389 IoPAGE_LEN(sv) = 60;
1390 if (old_type < SVt_PV) {
1391 /* referant will be NULL unless the old type was SVt_IV emulating
1393 sv->sv_u.svu_rv = referant;
1397 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1398 (unsigned long)new_type);
1401 if (old_type_details->arena) {
1402 /* If there was an old body, then we need to free it.
1403 Note that there is an assumption that all bodies of types that
1404 can be upgraded came from arenas. Only the more complex non-
1405 upgradable types are allowed to be directly malloc()ed. */
1407 my_safefree(old_body);
1409 del_body((void*)((char*)old_body + old_type_details->offset),
1410 &PL_body_roots[old_type]);
1416 =for apidoc sv_backoff
1418 Remove any string offset. You should normally use the C<SvOOK_off> macro
1425 Perl_sv_backoff(pTHX_ register SV *const sv)
1428 const char * const s = SvPVX_const(sv);
1430 PERL_ARGS_ASSERT_SV_BACKOFF;
1431 PERL_UNUSED_CONTEXT;
1434 assert(SvTYPE(sv) != SVt_PVHV);
1435 assert(SvTYPE(sv) != SVt_PVAV);
1437 SvOOK_offset(sv, delta);
1439 SvLEN_set(sv, SvLEN(sv) + delta);
1440 SvPV_set(sv, SvPVX(sv) - delta);
1441 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1442 SvFLAGS(sv) &= ~SVf_OOK;
1449 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1450 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1451 Use the C<SvGROW> wrapper instead.
1457 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1461 PERL_ARGS_ASSERT_SV_GROW;
1463 if (PL_madskills && newlen >= 0x100000) {
1464 PerlIO_printf(Perl_debug_log,
1465 "Allocation too large: %"UVxf"\n", (UV)newlen);
1467 #ifdef HAS_64K_LIMIT
1468 if (newlen >= 0x10000) {
1469 PerlIO_printf(Perl_debug_log,
1470 "Allocation too large: %"UVxf"\n", (UV)newlen);
1473 #endif /* HAS_64K_LIMIT */
1476 if (SvTYPE(sv) < SVt_PV) {
1477 sv_upgrade(sv, SVt_PV);
1478 s = SvPVX_mutable(sv);
1480 else if (SvOOK(sv)) { /* pv is offset? */
1482 s = SvPVX_mutable(sv);
1483 if (newlen > SvLEN(sv))
1484 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1485 #ifdef HAS_64K_LIMIT
1486 if (newlen >= 0x10000)
1491 s = SvPVX_mutable(sv);
1493 if (newlen > SvLEN(sv)) { /* need more room? */
1494 #ifndef Perl_safesysmalloc_size
1495 newlen = PERL_STRLEN_ROUNDUP(newlen);
1497 if (SvLEN(sv) && s) {
1498 s = (char*)saferealloc(s, newlen);
1501 s = (char*)safemalloc(newlen);
1502 if (SvPVX_const(sv) && SvCUR(sv)) {
1503 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1507 #ifdef Perl_safesysmalloc_size
1508 /* Do this here, do it once, do it right, and then we will never get
1509 called back into sv_grow() unless there really is some growing
1511 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1513 SvLEN_set(sv, newlen);
1520 =for apidoc sv_setiv
1522 Copies an integer into the given SV, upgrading first if necessary.
1523 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1529 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1533 PERL_ARGS_ASSERT_SV_SETIV;
1535 SV_CHECK_THINKFIRST_COW_DROP(sv);
1536 switch (SvTYPE(sv)) {
1539 sv_upgrade(sv, SVt_IV);
1542 sv_upgrade(sv, SVt_PVIV);
1546 if (!isGV_with_GP(sv))
1553 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1557 (void)SvIOK_only(sv); /* validate number */
1563 =for apidoc sv_setiv_mg
1565 Like C<sv_setiv>, but also handles 'set' magic.
1571 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1573 PERL_ARGS_ASSERT_SV_SETIV_MG;
1580 =for apidoc sv_setuv
1582 Copies an unsigned integer into the given SV, upgrading first if necessary.
1583 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1589 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1591 PERL_ARGS_ASSERT_SV_SETUV;
1593 /* With these two if statements:
1594 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1597 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1599 If you wish to remove them, please benchmark to see what the effect is
1601 if (u <= (UV)IV_MAX) {
1602 sv_setiv(sv, (IV)u);
1611 =for apidoc sv_setuv_mg
1613 Like C<sv_setuv>, but also handles 'set' magic.
1619 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1621 PERL_ARGS_ASSERT_SV_SETUV_MG;
1628 =for apidoc sv_setnv
1630 Copies a double into the given SV, upgrading first if necessary.
1631 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1637 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1641 PERL_ARGS_ASSERT_SV_SETNV;
1643 SV_CHECK_THINKFIRST_COW_DROP(sv);
1644 switch (SvTYPE(sv)) {
1647 sv_upgrade(sv, SVt_NV);
1651 sv_upgrade(sv, SVt_PVNV);
1655 if (!isGV_with_GP(sv))
1662 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1667 (void)SvNOK_only(sv); /* validate number */
1672 =for apidoc sv_setnv_mg
1674 Like C<sv_setnv>, but also handles 'set' magic.
1680 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1682 PERL_ARGS_ASSERT_SV_SETNV_MG;
1688 /* Print an "isn't numeric" warning, using a cleaned-up,
1689 * printable version of the offending string
1693 S_not_a_number(pTHX_ SV *const sv)
1700 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1703 dsv = newSVpvs_flags("", SVs_TEMP);
1704 pv = sv_uni_display(dsv, sv, 10, 0);
1707 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1708 /* each *s can expand to 4 chars + "...\0",
1709 i.e. need room for 8 chars */
1711 const char *s = SvPVX_const(sv);
1712 const char * const end = s + SvCUR(sv);
1713 for ( ; s < end && d < limit; s++ ) {
1715 if (ch & 128 && !isPRINT_LC(ch)) {
1724 else if (ch == '\r') {
1728 else if (ch == '\f') {
1732 else if (ch == '\\') {
1736 else if (ch == '\0') {
1740 else if (isPRINT_LC(ch))
1757 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1758 "Argument \"%s\" isn't numeric in %s", pv,
1761 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1762 "Argument \"%s\" isn't numeric", pv);
1766 =for apidoc looks_like_number
1768 Test if the content of an SV looks like a number (or is a number).
1769 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1770 non-numeric warning), even if your atof() doesn't grok them.
1776 Perl_looks_like_number(pTHX_ SV *const sv)
1778 register const char *sbegin;
1781 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1784 sbegin = SvPVX_const(sv);
1787 else if (SvPOKp(sv))
1788 sbegin = SvPV_const(sv, len);
1790 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1791 return grok_number(sbegin, len, NULL);
1795 S_glob_2number(pTHX_ GV * const gv)
1797 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1798 SV *const buffer = sv_newmortal();
1800 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1802 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1805 gv_efullname3(buffer, gv, "*");
1806 SvFLAGS(gv) |= wasfake;
1808 /* We know that all GVs stringify to something that is not-a-number,
1809 so no need to test that. */
1810 if (ckWARN(WARN_NUMERIC))
1811 not_a_number(buffer);
1812 /* We just want something true to return, so that S_sv_2iuv_common
1813 can tail call us and return true. */
1818 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1820 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1821 SV *const buffer = sv_newmortal();
1823 PERL_ARGS_ASSERT_GLOB_2PV;
1825 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1828 gv_efullname3(buffer, gv, "*");
1829 SvFLAGS(gv) |= wasfake;
1831 assert(SvPOK(buffer));
1833 *len = SvCUR(buffer);
1835 return SvPVX(buffer);
1838 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1839 until proven guilty, assume that things are not that bad... */
1844 As 64 bit platforms often have an NV that doesn't preserve all bits of
1845 an IV (an assumption perl has been based on to date) it becomes necessary
1846 to remove the assumption that the NV always carries enough precision to
1847 recreate the IV whenever needed, and that the NV is the canonical form.
1848 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1849 precision as a side effect of conversion (which would lead to insanity
1850 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1851 1) to distinguish between IV/UV/NV slots that have cached a valid
1852 conversion where precision was lost and IV/UV/NV slots that have a
1853 valid conversion which has lost no precision
1854 2) to ensure that if a numeric conversion to one form is requested that
1855 would lose precision, the precise conversion (or differently
1856 imprecise conversion) is also performed and cached, to prevent
1857 requests for different numeric formats on the same SV causing
1858 lossy conversion chains. (lossless conversion chains are perfectly
1863 SvIOKp is true if the IV slot contains a valid value
1864 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1865 SvNOKp is true if the NV slot contains a valid value
1866 SvNOK is true only if the NV value is accurate
1869 while converting from PV to NV, check to see if converting that NV to an
1870 IV(or UV) would lose accuracy over a direct conversion from PV to
1871 IV(or UV). If it would, cache both conversions, return NV, but mark
1872 SV as IOK NOKp (ie not NOK).
1874 While converting from PV to IV, check to see if converting that IV to an
1875 NV would lose accuracy over a direct conversion from PV to NV. If it
1876 would, cache both conversions, flag similarly.
1878 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1879 correctly because if IV & NV were set NV *always* overruled.
1880 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1881 changes - now IV and NV together means that the two are interchangeable:
1882 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1884 The benefit of this is that operations such as pp_add know that if
1885 SvIOK is true for both left and right operands, then integer addition
1886 can be used instead of floating point (for cases where the result won't
1887 overflow). Before, floating point was always used, which could lead to
1888 loss of precision compared with integer addition.
1890 * making IV and NV equal status should make maths accurate on 64 bit
1892 * may speed up maths somewhat if pp_add and friends start to use
1893 integers when possible instead of fp. (Hopefully the overhead in
1894 looking for SvIOK and checking for overflow will not outweigh the
1895 fp to integer speedup)
1896 * will slow down integer operations (callers of SvIV) on "inaccurate"
1897 values, as the change from SvIOK to SvIOKp will cause a call into
1898 sv_2iv each time rather than a macro access direct to the IV slot
1899 * should speed up number->string conversion on integers as IV is
1900 favoured when IV and NV are equally accurate
1902 ####################################################################
1903 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1904 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1905 On the other hand, SvUOK is true iff UV.
1906 ####################################################################
1908 Your mileage will vary depending your CPU's relative fp to integer
1912 #ifndef NV_PRESERVES_UV
1913 # define IS_NUMBER_UNDERFLOW_IV 1
1914 # define IS_NUMBER_UNDERFLOW_UV 2
1915 # define IS_NUMBER_IV_AND_UV 2
1916 # define IS_NUMBER_OVERFLOW_IV 4
1917 # define IS_NUMBER_OVERFLOW_UV 5
1919 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1921 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1923 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1931 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1933 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));
1934 if (SvNVX(sv) < (NV)IV_MIN) {
1935 (void)SvIOKp_on(sv);
1937 SvIV_set(sv, IV_MIN);
1938 return IS_NUMBER_UNDERFLOW_IV;
1940 if (SvNVX(sv) > (NV)UV_MAX) {
1941 (void)SvIOKp_on(sv);
1944 SvUV_set(sv, UV_MAX);
1945 return IS_NUMBER_OVERFLOW_UV;
1947 (void)SvIOKp_on(sv);
1949 /* Can't use strtol etc to convert this string. (See truth table in
1951 if (SvNVX(sv) <= (UV)IV_MAX) {
1952 SvIV_set(sv, I_V(SvNVX(sv)));
1953 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1954 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1956 /* Integer is imprecise. NOK, IOKp */
1958 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1962 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1963 if (SvUVX(sv) == UV_MAX) {
1964 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1965 possibly be preserved by NV. Hence, it must be overflow.
1967 return IS_NUMBER_OVERFLOW_UV;
1969 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1971 /* Integer is imprecise. NOK, IOKp */
1973 return IS_NUMBER_OVERFLOW_IV;
1975 #endif /* !NV_PRESERVES_UV*/
1978 S_sv_2iuv_common(pTHX_ SV *const sv)
1982 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1985 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1986 * without also getting a cached IV/UV from it at the same time
1987 * (ie PV->NV conversion should detect loss of accuracy and cache
1988 * IV or UV at same time to avoid this. */
1989 /* IV-over-UV optimisation - choose to cache IV if possible */
1991 if (SvTYPE(sv) == SVt_NV)
1992 sv_upgrade(sv, SVt_PVNV);
1994 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1995 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1996 certainly cast into the IV range at IV_MAX, whereas the correct
1997 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1999 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2000 if (Perl_isnan(SvNVX(sv))) {
2006 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2007 SvIV_set(sv, I_V(SvNVX(sv)));
2008 if (SvNVX(sv) == (NV) SvIVX(sv)
2009 #ifndef NV_PRESERVES_UV
2010 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2011 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2012 /* Don't flag it as "accurately an integer" if the number
2013 came from a (by definition imprecise) NV operation, and
2014 we're outside the range of NV integer precision */
2018 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2020 /* scalar has trailing garbage, eg "42a" */
2022 DEBUG_c(PerlIO_printf(Perl_debug_log,
2023 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2029 /* IV not precise. No need to convert from PV, as NV
2030 conversion would already have cached IV if it detected
2031 that PV->IV would be better than PV->NV->IV
2032 flags already correct - don't set public IOK. */
2033 DEBUG_c(PerlIO_printf(Perl_debug_log,
2034 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2039 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2040 but the cast (NV)IV_MIN rounds to a the value less (more
2041 negative) than IV_MIN which happens to be equal to SvNVX ??
2042 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2043 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2044 (NV)UVX == NVX are both true, but the values differ. :-(
2045 Hopefully for 2s complement IV_MIN is something like
2046 0x8000000000000000 which will be exact. NWC */
2049 SvUV_set(sv, U_V(SvNVX(sv)));
2051 (SvNVX(sv) == (NV) SvUVX(sv))
2052 #ifndef NV_PRESERVES_UV
2053 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2054 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2055 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2056 /* Don't flag it as "accurately an integer" if the number
2057 came from a (by definition imprecise) NV operation, and
2058 we're outside the range of NV integer precision */
2064 DEBUG_c(PerlIO_printf(Perl_debug_log,
2065 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2071 else if (SvPOKp(sv) && SvLEN(sv)) {
2073 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2074 /* We want to avoid a possible problem when we cache an IV/ a UV which
2075 may be later translated to an NV, and the resulting NV is not
2076 the same as the direct translation of the initial string
2077 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2078 be careful to ensure that the value with the .456 is around if the
2079 NV value is requested in the future).
2081 This means that if we cache such an IV/a UV, we need to cache the
2082 NV as well. Moreover, we trade speed for space, and do not
2083 cache the NV if we are sure it's not needed.
2086 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2087 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2088 == IS_NUMBER_IN_UV) {
2089 /* It's definitely an integer, only upgrade to PVIV */
2090 if (SvTYPE(sv) < SVt_PVIV)
2091 sv_upgrade(sv, SVt_PVIV);
2093 } else if (SvTYPE(sv) < SVt_PVNV)
2094 sv_upgrade(sv, SVt_PVNV);
2096 /* If NVs preserve UVs then we only use the UV value if we know that
2097 we aren't going to call atof() below. If NVs don't preserve UVs
2098 then the value returned may have more precision than atof() will
2099 return, even though value isn't perfectly accurate. */
2100 if ((numtype & (IS_NUMBER_IN_UV
2101 #ifdef NV_PRESERVES_UV
2104 )) == IS_NUMBER_IN_UV) {
2105 /* This won't turn off the public IOK flag if it was set above */
2106 (void)SvIOKp_on(sv);
2108 if (!(numtype & IS_NUMBER_NEG)) {
2110 if (value <= (UV)IV_MAX) {
2111 SvIV_set(sv, (IV)value);
2113 /* it didn't overflow, and it was positive. */
2114 SvUV_set(sv, value);
2118 /* 2s complement assumption */
2119 if (value <= (UV)IV_MIN) {
2120 SvIV_set(sv, -(IV)value);
2122 /* Too negative for an IV. This is a double upgrade, but
2123 I'm assuming it will be rare. */
2124 if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2129 SvNV_set(sv, -(NV)value);
2130 SvIV_set(sv, IV_MIN);
2134 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2135 will be in the previous block to set the IV slot, and the next
2136 block to set the NV slot. So no else here. */
2138 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2139 != IS_NUMBER_IN_UV) {
2140 /* It wasn't an (integer that doesn't overflow the UV). */
2141 SvNV_set(sv, Atof(SvPVX_const(sv)));
2143 if (! numtype && ckWARN(WARN_NUMERIC))
2146 #if defined(USE_LONG_DOUBLE)
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2150 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2151 PTR2UV(sv), SvNVX(sv)));
2154 #ifdef NV_PRESERVES_UV
2155 (void)SvIOKp_on(sv);
2157 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2158 SvIV_set(sv, I_V(SvNVX(sv)));
2159 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2162 NOOP; /* Integer is imprecise. NOK, IOKp */
2164 /* UV will not work better than IV */
2166 if (SvNVX(sv) > (NV)UV_MAX) {
2168 /* Integer is inaccurate. NOK, IOKp, is UV */
2169 SvUV_set(sv, UV_MAX);
2171 SvUV_set(sv, U_V(SvNVX(sv)));
2172 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2173 NV preservse UV so can do correct comparison. */
2174 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2177 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2182 #else /* NV_PRESERVES_UV */
2183 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2184 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2185 /* The IV/UV slot will have been set from value returned by
2186 grok_number above. The NV slot has just been set using
2189 assert (SvIOKp(sv));
2191 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2192 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2193 /* Small enough to preserve all bits. */
2194 (void)SvIOKp_on(sv);
2196 SvIV_set(sv, I_V(SvNVX(sv)));
2197 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2199 /* Assumption: first non-preserved integer is < IV_MAX,
2200 this NV is in the preserved range, therefore: */
2201 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2203 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);
2207 0 0 already failed to read UV.
2208 0 1 already failed to read UV.
2209 1 0 you won't get here in this case. IV/UV
2210 slot set, public IOK, Atof() unneeded.
2211 1 1 already read UV.
2212 so there's no point in sv_2iuv_non_preserve() attempting
2213 to use atol, strtol, strtoul etc. */
2215 sv_2iuv_non_preserve (sv, numtype);
2217 sv_2iuv_non_preserve (sv);
2221 #endif /* NV_PRESERVES_UV */
2222 /* It might be more code efficient to go through the entire logic above
2223 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2224 gets complex and potentially buggy, so more programmer efficient
2225 to do it this way, by turning off the public flags: */
2227 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2231 if (isGV_with_GP(sv))
2232 return glob_2number((GV *)sv);
2234 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2235 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2238 if (SvTYPE(sv) < SVt_IV)
2239 /* Typically the caller expects that sv_any is not NULL now. */
2240 sv_upgrade(sv, SVt_IV);
2241 /* Return 0 from the caller. */
2248 =for apidoc sv_2iv_flags
2250 Return the integer value of an SV, doing any necessary string
2251 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2252 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2258 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2263 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2264 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2265 cache IVs just in case. In practice it seems that they never
2266 actually anywhere accessible by user Perl code, let alone get used
2267 in anything other than a string context. */
2268 if (flags & SV_GMAGIC)
2273 return I_V(SvNVX(sv));
2275 if (SvPOKp(sv) && SvLEN(sv)) {
2278 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2281 == IS_NUMBER_IN_UV) {
2282 /* It's definitely an integer */
2283 if (numtype & IS_NUMBER_NEG) {
2284 if (value < (UV)IV_MIN)
2287 if (value < (UV)IV_MAX)
2292 if (ckWARN(WARN_NUMERIC))
2295 return I_V(Atof(SvPVX_const(sv)));
2300 assert(SvTYPE(sv) >= SVt_PVMG);
2301 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2302 } else if (SvTHINKFIRST(sv)) {
2306 SV * const tmpstr=AMG_CALLun(sv,numer);
2307 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2308 return SvIV(tmpstr);
2311 return PTR2IV(SvRV(sv));
2314 sv_force_normal_flags(sv, 0);
2316 if (SvREADONLY(sv) && !SvOK(sv)) {
2317 if (ckWARN(WARN_UNINITIALIZED))
2323 if (S_sv_2iuv_common(aTHX_ sv))
2326 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2327 PTR2UV(sv),SvIVX(sv)));
2328 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2332 =for apidoc sv_2uv_flags
2334 Return the unsigned integer value of an SV, doing any necessary string
2335 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2336 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2342 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2347 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2348 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2349 cache IVs just in case. */
2350 if (flags & SV_GMAGIC)
2355 return U_V(SvNVX(sv));
2356 if (SvPOKp(sv) && SvLEN(sv)) {
2359 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2361 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2362 == IS_NUMBER_IN_UV) {
2363 /* It's definitely an integer */
2364 if (!(numtype & IS_NUMBER_NEG))
2368 if (ckWARN(WARN_NUMERIC))
2371 return U_V(Atof(SvPVX_const(sv)));
2376 assert(SvTYPE(sv) >= SVt_PVMG);
2377 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2378 } else if (SvTHINKFIRST(sv)) {
2382 SV *const tmpstr = AMG_CALLun(sv,numer);
2383 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2384 return SvUV(tmpstr);
2387 return PTR2UV(SvRV(sv));
2390 sv_force_normal_flags(sv, 0);
2392 if (SvREADONLY(sv) && !SvOK(sv)) {
2393 if (ckWARN(WARN_UNINITIALIZED))
2399 if (S_sv_2iuv_common(aTHX_ sv))
2403 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2404 PTR2UV(sv),SvUVX(sv)));
2405 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2411 Return the num value of an SV, doing any necessary string or integer
2412 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2419 Perl_sv_2nv(pTHX_ register SV *const sv)
2424 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2425 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2426 cache IVs just in case. */
2430 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2431 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2432 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2434 return Atof(SvPVX_const(sv));
2438 return (NV)SvUVX(sv);
2440 return (NV)SvIVX(sv);
2445 assert(SvTYPE(sv) >= SVt_PVMG);
2446 /* This falls through to the report_uninit near the end of the
2448 } else if (SvTHINKFIRST(sv)) {
2452 SV *const tmpstr = AMG_CALLun(sv,numer);
2453 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2454 return SvNV(tmpstr);
2457 return PTR2NV(SvRV(sv));
2460 sv_force_normal_flags(sv, 0);
2462 if (SvREADONLY(sv) && !SvOK(sv)) {
2463 if (ckWARN(WARN_UNINITIALIZED))
2468 if (SvTYPE(sv) < SVt_NV) {
2469 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2470 sv_upgrade(sv, SVt_NV);
2471 #ifdef USE_LONG_DOUBLE
2473 STORE_NUMERIC_LOCAL_SET_STANDARD();
2474 PerlIO_printf(Perl_debug_log,
2475 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2488 else if (SvTYPE(sv) < SVt_PVNV)
2489 sv_upgrade(sv, SVt_PVNV);
2494 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2495 #ifdef NV_PRESERVES_UV
2501 /* Only set the public NV OK flag if this NV preserves the IV */
2502 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2504 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2505 : (SvIVX(sv) == I_V(SvNVX(sv))))
2511 else if (SvPOKp(sv) && SvLEN(sv)) {
2513 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2514 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2516 #ifdef NV_PRESERVES_UV
2517 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2518 == IS_NUMBER_IN_UV) {
2519 /* It's definitely an integer */
2520 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2522 SvNV_set(sv, Atof(SvPVX_const(sv)));
2528 SvNV_set(sv, Atof(SvPVX_const(sv)));
2529 /* Only set the public NV OK flag if this NV preserves the value in
2530 the PV at least as well as an IV/UV would.
2531 Not sure how to do this 100% reliably. */
2532 /* if that shift count is out of range then Configure's test is
2533 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2535 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2536 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2537 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2538 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2539 /* Can't use strtol etc to convert this string, so don't try.
2540 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2543 /* value has been set. It may not be precise. */
2544 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2545 /* 2s complement assumption for (UV)IV_MIN */
2546 SvNOK_on(sv); /* Integer is too negative. */
2551 if (numtype & IS_NUMBER_NEG) {
2552 SvIV_set(sv, -(IV)value);
2553 } else if (value <= (UV)IV_MAX) {
2554 SvIV_set(sv, (IV)value);
2556 SvUV_set(sv, value);
2560 if (numtype & IS_NUMBER_NOT_INT) {
2561 /* I believe that even if the original PV had decimals,
2562 they are lost beyond the limit of the FP precision.
2563 However, neither is canonical, so both only get p
2564 flags. NWC, 2000/11/25 */
2565 /* Both already have p flags, so do nothing */
2567 const NV nv = SvNVX(sv);
2568 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2569 if (SvIVX(sv) == I_V(nv)) {
2572 /* It had no "." so it must be integer. */
2576 /* between IV_MAX and NV(UV_MAX).
2577 Could be slightly > UV_MAX */
2579 if (numtype & IS_NUMBER_NOT_INT) {
2580 /* UV and NV both imprecise. */
2582 const UV nv_as_uv = U_V(nv);
2584 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2593 /* It might be more code efficient to go through the entire logic above
2594 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2595 gets complex and potentially buggy, so more programmer efficient
2596 to do it this way, by turning off the public flags: */
2598 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2599 #endif /* NV_PRESERVES_UV */
2602 if (isGV_with_GP(sv)) {
2603 glob_2number((GV *)sv);
2607 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2609 assert (SvTYPE(sv) >= SVt_NV);
2610 /* Typically the caller expects that sv_any is not NULL now. */
2611 /* XXX Ilya implies that this is a bug in callers that assume this
2612 and ideally should be fixed. */
2615 #if defined(USE_LONG_DOUBLE)
2617 STORE_NUMERIC_LOCAL_SET_STANDARD();
2618 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2619 PTR2UV(sv), SvNVX(sv));
2620 RESTORE_NUMERIC_LOCAL();
2624 STORE_NUMERIC_LOCAL_SET_STANDARD();
2625 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2626 PTR2UV(sv), SvNVX(sv));
2627 RESTORE_NUMERIC_LOCAL();
2636 Return an SV with the numeric value of the source SV, doing any necessary
2637 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2638 access this function.
2644 Perl_sv_2num(pTHX_ register SV *const sv)
2646 PERL_ARGS_ASSERT_SV_2NUM;
2651 SV * const tmpsv = AMG_CALLun(sv,numer);
2652 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2653 return sv_2num(tmpsv);
2655 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2658 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2659 * UV as a string towards the end of buf, and return pointers to start and
2662 * We assume that buf is at least TYPE_CHARS(UV) long.
2666 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2668 char *ptr = buf + TYPE_CHARS(UV);
2669 char * const ebuf = ptr;
2672 PERL_ARGS_ASSERT_UIV_2BUF;
2684 *--ptr = '0' + (char)(uv % 10);
2693 =for apidoc sv_2pv_flags
2695 Returns a pointer to the string value of an SV, and sets *lp to its length.
2696 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2698 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2699 usually end up here too.
2705 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2715 if (SvGMAGICAL(sv)) {
2716 if (flags & SV_GMAGIC)
2721 if (flags & SV_MUTABLE_RETURN)
2722 return SvPVX_mutable(sv);
2723 if (flags & SV_CONST_RETURN)
2724 return (char *)SvPVX_const(sv);
2727 if (SvIOKp(sv) || SvNOKp(sv)) {
2728 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2733 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2734 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2736 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2743 #ifdef FIXNEGATIVEZERO
2744 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2750 SvUPGRADE(sv, SVt_PV);
2753 s = SvGROW_mutable(sv, len + 1);
2756 return (char*)memcpy(s, tbuf, len + 1);
2762 assert(SvTYPE(sv) >= SVt_PVMG);
2763 /* This falls through to the report_uninit near the end of the
2765 } else if (SvTHINKFIRST(sv)) {
2769 SV *const tmpstr = AMG_CALLun(sv,string);
2770 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2772 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2776 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2777 if (flags & SV_CONST_RETURN) {
2778 pv = (char *) SvPVX_const(tmpstr);
2780 pv = (flags & SV_MUTABLE_RETURN)
2781 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2784 *lp = SvCUR(tmpstr);
2786 pv = sv_2pv_flags(tmpstr, lp, flags);
2799 const SV *const referent = (SV*)SvRV(sv);
2803 retval = buffer = savepvn("NULLREF", len);
2804 } else if (SvTYPE(referent) == SVt_REGEXP) {
2805 const REGEXP * const re = (REGEXP *)referent;
2810 /* If the regex is UTF-8 we want the containing scalar to
2811 have an UTF-8 flag too */
2817 if ((seen_evals = RX_SEEN_EVALS(re)))
2818 PL_reginterp_cnt += seen_evals;
2821 *lp = RX_WRAPLEN(re);
2823 return RX_WRAPPED(re);
2825 const char *const typestr = sv_reftype(referent, 0);
2826 const STRLEN typelen = strlen(typestr);
2827 UV addr = PTR2UV(referent);
2828 const char *stashname = NULL;
2829 STRLEN stashnamelen = 0; /* hush, gcc */
2830 const char *buffer_end;
2832 if (SvOBJECT(referent)) {
2833 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2836 stashname = HEK_KEY(name);
2837 stashnamelen = HEK_LEN(name);
2839 if (HEK_UTF8(name)) {
2845 stashname = "__ANON__";
2848 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2851 len = typelen + 3 /* (0x */
2852 + 2 * sizeof(UV) + 2 /* )\0 */;
2855 Newx(buffer, len, char);
2856 buffer_end = retval = buffer + len;
2858 /* Working backwards */
2862 *--retval = PL_hexdigit[addr & 15];
2863 } while (addr >>= 4);
2869 memcpy(retval, typestr, typelen);
2873 retval -= stashnamelen;
2874 memcpy(retval, stashname, stashnamelen);
2876 /* retval may not neccesarily have reached the start of the
2878 assert (retval >= buffer);
2880 len = buffer_end - retval - 1; /* -1 for that \0 */
2888 if (SvREADONLY(sv) && !SvOK(sv)) {
2891 if (flags & SV_UNDEF_RETURNS_NULL)
2893 if (ckWARN(WARN_UNINITIALIZED))
2898 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2899 /* I'm assuming that if both IV and NV are equally valid then
2900 converting the IV is going to be more efficient */
2901 const U32 isUIOK = SvIsUV(sv);
2902 char buf[TYPE_CHARS(UV)];
2906 if (SvTYPE(sv) < SVt_PVIV)
2907 sv_upgrade(sv, SVt_PVIV);
2908 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2910 /* inlined from sv_setpvn */
2911 s = SvGROW_mutable(sv, len + 1);
2912 Move(ptr, s, len, char);
2916 else if (SvNOKp(sv)) {
2917 const int olderrno = errno;
2918 if (SvTYPE(sv) < SVt_PVNV)
2919 sv_upgrade(sv, SVt_PVNV);
2920 /* The +20 is pure guesswork. Configure test needed. --jhi */
2921 s = SvGROW_mutable(sv, NV_DIG + 20);
2922 /* some Xenix systems wipe out errno here */
2924 if (SvNVX(sv) == 0.0)
2925 my_strlcpy(s, "0", SvLEN(sv));
2929 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2932 #ifdef FIXNEGATIVEZERO
2933 if (*s == '-' && s[1] == '0' && !s[2]) {
2945 if (isGV_with_GP(sv))
2946 return glob_2pv((GV *)sv, lp);
2950 if (flags & SV_UNDEF_RETURNS_NULL)
2952 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2954 if (SvTYPE(sv) < SVt_PV)
2955 /* Typically the caller expects that sv_any is not NULL now. */
2956 sv_upgrade(sv, SVt_PV);
2960 const STRLEN len = s - SvPVX_const(sv);
2966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2967 PTR2UV(sv),SvPVX_const(sv)));
2968 if (flags & SV_CONST_RETURN)
2969 return (char *)SvPVX_const(sv);
2970 if (flags & SV_MUTABLE_RETURN)
2971 return SvPVX_mutable(sv);
2976 =for apidoc sv_copypv
2978 Copies a stringified representation of the source SV into the
2979 destination SV. Automatically performs any necessary mg_get and
2980 coercion of numeric values into strings. Guaranteed to preserve
2981 UTF8 flag even from overloaded objects. Similar in nature to
2982 sv_2pv[_flags] but operates directly on an SV instead of just the
2983 string. Mostly uses sv_2pv_flags to do its work, except when that
2984 would lose the UTF-8'ness of the PV.
2990 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2993 const char * const s = SvPV_const(ssv,len);
2995 PERL_ARGS_ASSERT_SV_COPYPV;
2997 sv_setpvn(dsv,s,len);
3005 =for apidoc sv_2pvbyte
3007 Return a pointer to the byte-encoded representation of the SV, and set *lp
3008 to its length. May cause the SV to be downgraded from UTF-8 as a
3011 Usually accessed via the C<SvPVbyte> macro.
3017 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3019 PERL_ARGS_ASSERT_SV_2PVBYTE;
3021 sv_utf8_downgrade(sv,0);
3022 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3026 =for apidoc sv_2pvutf8
3028 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3029 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3031 Usually accessed via the C<SvPVutf8> macro.
3037 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3039 PERL_ARGS_ASSERT_SV_2PVUTF8;
3041 sv_utf8_upgrade(sv);
3042 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3047 =for apidoc sv_2bool
3049 This function is only called on magical items, and is only used by
3050 sv_true() or its macro equivalent.
3056 Perl_sv_2bool(pTHX_ register SV *const sv)
3060 PERL_ARGS_ASSERT_SV_2BOOL;
3068 SV * const tmpsv = AMG_CALLun(sv,bool_);
3069 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3070 return (bool)SvTRUE(tmpsv);
3072 return SvRV(sv) != 0;
3075 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3077 (*sv->sv_u.svu_pv > '0' ||
3078 Xpvtmp->xpv_cur > 1 ||
3079 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3086 return SvIVX(sv) != 0;
3089 return SvNVX(sv) != 0.0;
3091 if (isGV_with_GP(sv))
3101 =for apidoc sv_utf8_upgrade
3103 Converts the PV of an SV to its UTF-8-encoded form.
3104 Forces the SV to string form if it is not already.
3105 Always sets the SvUTF8 flag to avoid future validity checks even
3106 if all the bytes have hibit clear.
3108 This is not as a general purpose byte encoding to Unicode interface:
3109 use the Encode extension for that.
3111 =for apidoc sv_utf8_upgrade_flags
3113 Converts the PV of an SV to its UTF-8-encoded form.
3114 Forces the SV to string form if it is not already.
3115 Always sets the SvUTF8 flag to avoid future validity checks even
3116 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3117 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3118 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3120 This is not as a general purpose byte encoding to Unicode interface:
3121 use the Encode extension for that.
3127 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3131 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3133 if (sv == &PL_sv_undef)
3137 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3138 (void) sv_2pv_flags(sv,&len, flags);
3142 (void) SvPV_force(sv,len);
3151 sv_force_normal_flags(sv, 0);
3154 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3155 sv_recode_to_utf8(sv, PL_encoding);
3156 else { /* Assume Latin-1/EBCDIC */
3157 /* This function could be much more efficient if we
3158 * had a FLAG in SVs to signal if there are any hibit
3159 * chars in the PV. Given that there isn't such a flag
3160 * make the loop as fast as possible. */
3161 const U8 * const s = (U8 *) SvPVX_const(sv);
3162 const U8 * const e = (U8 *) SvEND(sv);
3167 /* Check for hi bit */
3168 if (!NATIVE_IS_INVARIANT(ch)) {
3169 STRLEN len = SvCUR(sv);
3170 /* *Currently* bytes_to_utf8() adds a '\0' after every string
3171 it converts. This isn't documented. It's not clear if it's
3172 a bad thing to be doing, and should be changed to do exactly
3173 what the documentation says. If so, this code will have to
3175 As is, we mustn't rely on our incoming SV being well formed
3176 and having a trailing '\0', as certain code in pp_formline
3177 can send us partially built SVs. */
3178 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3180 SvPV_free(sv); /* No longer using what was there before. */
3181 SvPV_set(sv, (char*)recoded);
3183 SvLEN_set(sv, len + 1); /* No longer know the real size. */
3187 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3194 =for apidoc sv_utf8_downgrade
3196 Attempts to convert the PV of an SV from characters to bytes.
3197 If the PV contains a character beyond byte, this conversion will fail;
3198 in this case, either returns false or, if C<fail_ok> is not
3201 This is not as a general purpose Unicode to byte encoding interface:
3202 use the Encode extension for that.
3208 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3212 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3214 if (SvPOKp(sv) && SvUTF8(sv)) {
3220 sv_force_normal_flags(sv, 0);
3222 s = (U8 *) SvPV(sv, len);
3223 if (!utf8_to_bytes(s, &len)) {
3228 Perl_croak(aTHX_ "Wide character in %s",
3231 Perl_croak(aTHX_ "Wide character");
3242 =for apidoc sv_utf8_encode
3244 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3245 flag off so that it looks like octets again.
3251 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3253 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3256 sv_force_normal_flags(sv, 0);
3258 if (SvREADONLY(sv)) {
3259 Perl_croak(aTHX_ PL_no_modify);
3261 (void) sv_utf8_upgrade(sv);
3266 =for apidoc sv_utf8_decode
3268 If the PV of the SV is an octet sequence in UTF-8
3269 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3270 so that it looks like a character. If the PV contains only single-byte
3271 characters, the C<SvUTF8> flag stays being off.
3272 Scans PV for validity and returns false if the PV is invalid UTF-8.
3278 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3280 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3286 /* The octets may have got themselves encoded - get them back as
3289 if (!sv_utf8_downgrade(sv, TRUE))
3292 /* it is actually just a matter of turning the utf8 flag on, but
3293 * we want to make sure everything inside is valid utf8 first.
3295 c = (const U8 *) SvPVX_const(sv);
3296 if (!is_utf8_string(c, SvCUR(sv)+1))
3298 e = (const U8 *) SvEND(sv);
3301 if (!UTF8_IS_INVARIANT(ch)) {
3311 =for apidoc sv_setsv
3313 Copies the contents of the source SV C<ssv> into the destination SV
3314 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3315 function if the source SV needs to be reused. Does not handle 'set' magic.
3316 Loosely speaking, it performs a copy-by-value, obliterating any previous
3317 content of the destination.
3319 You probably want to use one of the assortment of wrappers, such as
3320 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3321 C<SvSetMagicSV_nosteal>.
3323 =for apidoc sv_setsv_flags
3325 Copies the contents of the source SV C<ssv> into the destination SV
3326 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3327 function if the source SV needs to be reused. Does not handle 'set' magic.
3328 Loosely speaking, it performs a copy-by-value, obliterating any previous
3329 content of the destination.
3330 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3331 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3332 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3333 and C<sv_setsv_nomg> are implemented in terms of this function.
3335 You probably want to use one of the assortment of wrappers, such as
3336 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3337 C<SvSetMagicSV_nosteal>.
3339 This is the primary function for copying scalars, and most other
3340 copy-ish functions and macros use this underneath.
3346 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3348 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3350 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3352 if (dtype != SVt_PVGV) {
3353 const char * const name = GvNAME(sstr);
3354 const STRLEN len = GvNAMELEN(sstr);
3356 if (dtype >= SVt_PV) {
3362 SvUPGRADE(dstr, SVt_PVGV);
3363 (void)SvOK_off(dstr);
3364 /* FIXME - why are we doing this, then turning it off and on again
3366 isGV_with_GP_on(dstr);
3368 GvSTASH(dstr) = GvSTASH(sstr);
3370 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3371 gv_name_set((GV *)dstr, name, len, GV_ADD);
3372 SvFAKE_on(dstr); /* can coerce to non-glob */
3375 #ifdef GV_UNIQUE_CHECK
3376 if (GvUNIQUE((GV*)dstr)) {
3377 Perl_croak(aTHX_ PL_no_modify);
3381 if(GvGP((GV*)sstr)) {
3382 /* If source has method cache entry, clear it */
3384 SvREFCNT_dec(GvCV(sstr));
3388 /* If source has a real method, then a method is
3390 else if(GvCV((GV*)sstr)) {
3395 /* If dest already had a real method, that's a change as well */
3396 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3400 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3404 isGV_with_GP_off(dstr);
3405 (void)SvOK_off(dstr);
3406 isGV_with_GP_on(dstr);
3407 GvINTRO_off(dstr); /* one-shot flag */
3408 GvGP(dstr) = gp_ref(GvGP(sstr));
3409 if (SvTAINTED(sstr))
3411 if (GvIMPORTED(dstr) != GVf_IMPORTED
3412 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3414 GvIMPORTED_on(dstr);
3417 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3418 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3423 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3425 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3427 const int intro = GvINTRO(dstr);
3430 const U32 stype = SvTYPE(sref);
3432 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3434 #ifdef GV_UNIQUE_CHECK
3435 if (GvUNIQUE((GV*)dstr)) {
3436 Perl_croak(aTHX_ PL_no_modify);
3441 GvINTRO_off(dstr); /* one-shot flag */
3442 GvLINE(dstr) = CopLINE(PL_curcop);
3443 GvEGV(dstr) = (GV*)dstr;
3448 location = (SV **) &GvCV(dstr);
3449 import_flag = GVf_IMPORTED_CV;
3452 location = (SV **) &GvHV(dstr);
3453 import_flag = GVf_IMPORTED_HV;
3456 location = (SV **) &GvAV(dstr);
3457 import_flag = GVf_IMPORTED_AV;
3460 location = (SV **) &GvIOp(dstr);
3463 location = (SV **) &GvFORM(dstr);
3465 location = &GvSV(dstr);
3466 import_flag = GVf_IMPORTED_SV;
3469 if (stype == SVt_PVCV) {
3470 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3471 if (GvCVGEN(dstr)) {
3472 SvREFCNT_dec(GvCV(dstr));
3474 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3477 SAVEGENERICSV(*location);
3481 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3482 CV* const cv = (CV*)*location;
3484 if (!GvCVGEN((GV*)dstr) &&
3485 (CvROOT(cv) || CvXSUB(cv)))
3487 /* Redefining a sub - warning is mandatory if
3488 it was a const and its value changed. */
3489 if (CvCONST(cv) && CvCONST((CV*)sref)
3490 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3492 /* They are 2 constant subroutines generated from
3493 the same constant. This probably means that
3494 they are really the "same" proxy subroutine
3495 instantiated in 2 places. Most likely this is
3496 when a constant is exported twice. Don't warn.
3499 else if (ckWARN(WARN_REDEFINE)
3501 && (!CvCONST((CV*)sref)
3502 || sv_cmp(cv_const_sv(cv),
3503 cv_const_sv((CV*)sref))))) {
3504 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3507 ? "Constant subroutine %s::%s redefined"
3508 : "Subroutine %s::%s redefined"),
3509 HvNAME_get(GvSTASH((GV*)dstr)),
3510 GvENAME((GV*)dstr));
3514 cv_ckproto_len(cv, (GV*)dstr,
3515 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3516 SvPOK(sref) ? SvCUR(sref) : 0);
3518 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3519 GvASSUMECV_on(dstr);
3520 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3523 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3524 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3525 GvFLAGS(dstr) |= import_flag;
3530 if (SvTAINTED(sstr))
3536 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3539 register U32 sflags;
3541 register svtype stype;
3543 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3548 if (SvIS_FREED(dstr)) {
3549 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3550 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3552 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3554 sstr = &PL_sv_undef;
3555 if (SvIS_FREED(sstr)) {
3556 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3557 (void*)sstr, (void*)dstr);
3559 stype = SvTYPE(sstr);
3560 dtype = SvTYPE(dstr);
3562 (void)SvAMAGIC_off(dstr);
3565 /* need to nuke the magic */
3569 /* There's a lot of redundancy below but we're going for speed here */
3574 if (dtype != SVt_PVGV) {
3575 (void)SvOK_off(dstr);
3583 sv_upgrade(dstr, SVt_IV);
3587 sv_upgrade(dstr, SVt_PVIV);
3590 goto end_of_first_switch;
3592 (void)SvIOK_only(dstr);
3593 SvIV_set(dstr, SvIVX(sstr));
3596 /* SvTAINTED can only be true if the SV has taint magic, which in
3597 turn means that the SV type is PVMG (or greater). This is the
3598 case statement for SVt_IV, so this cannot be true (whatever gcov
3600 assert(!SvTAINTED(sstr));
3605 if (dtype < SVt_PV && dtype != SVt_IV)
3606 sv_upgrade(dstr, SVt_IV);
3614 sv_upgrade(dstr, SVt_NV);
3618 sv_upgrade(dstr, SVt_PVNV);
3621 goto end_of_first_switch;
3623 SvNV_set(dstr, SvNVX(sstr));
3624 (void)SvNOK_only(dstr);
3625 /* SvTAINTED can only be true if the SV has taint magic, which in
3626 turn means that the SV type is PVMG (or greater). This is the
3627 case statement for SVt_NV, so this cannot be true (whatever gcov
3629 assert(!SvTAINTED(sstr));
3635 #ifdef PERL_OLD_COPY_ON_WRITE
3636 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3637 if (dtype < SVt_PVIV)
3638 sv_upgrade(dstr, SVt_PVIV);
3646 sv_upgrade(dstr, SVt_PV);
3649 if (dtype < SVt_PVIV)
3650 sv_upgrade(dstr, SVt_PVIV);
3653 if (dtype < SVt_PVNV)
3654 sv_upgrade(dstr, SVt_PVNV);
3658 const char * const type = sv_reftype(sstr,0);
3660 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3662 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3666 /* case SVt_BIND: */
3669 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3670 glob_assign_glob(dstr, sstr, dtype);
3673 /* SvVALID means that this PVGV is playing at being an FBM. */
3677 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3679 if (SvTYPE(sstr) != stype) {
3680 stype = SvTYPE(sstr);
3681 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3682 glob_assign_glob(dstr, sstr, dtype);
3687 if (stype == SVt_PVLV)
3688 SvUPGRADE(dstr, SVt_PVNV);
3690 SvUPGRADE(dstr, (svtype)stype);
3692 end_of_first_switch:
3694 /* dstr may have been upgraded. */
3695 dtype = SvTYPE(dstr);
3696 sflags = SvFLAGS(sstr);
3698 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3699 /* Assigning to a subroutine sets the prototype. */
3702 const char *const ptr = SvPV_const(sstr, len);
3704 SvGROW(dstr, len + 1);
3705 Copy(ptr, SvPVX(dstr), len + 1, char);
3706 SvCUR_set(dstr, len);
3708 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3712 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3713 const char * const type = sv_reftype(dstr,0);
3715 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3717 Perl_croak(aTHX_ "Cannot copy to %s", type);
3718 } else if (sflags & SVf_ROK) {
3719 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3720 && SvTYPE(SvRV(sstr)) == SVt_PVGV && isGV_with_GP(SvRV(sstr))) {
3723 if (GvIMPORTED(dstr) != GVf_IMPORTED
3724 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3726 GvIMPORTED_on(dstr);
3731 glob_assign_glob(dstr, sstr, dtype);
3735 if (dtype >= SVt_PV) {
3736 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3737 glob_assign_ref(dstr, sstr);
3740 if (SvPVX_const(dstr)) {
3746 (void)SvOK_off(dstr);
3747 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3748 SvFLAGS(dstr) |= sflags & SVf_ROK;
3749 assert(!(sflags & SVp_NOK));
3750 assert(!(sflags & SVp_IOK));
3751 assert(!(sflags & SVf_NOK));
3752 assert(!(sflags & SVf_IOK));
3754 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3755 if (!(sflags & SVf_OK)) {
3756 if (ckWARN(WARN_MISC))
3757 Perl_warner(aTHX_ packWARN(WARN_MISC),
3758 "Undefined value assigned to typeglob");
3761 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3762 if (dstr != (SV*)gv) {
3765 GvGP(dstr) = gp_ref(GvGP(gv));
3769 else if (sflags & SVp_POK) {
3773 * Check to see if we can just swipe the string. If so, it's a
3774 * possible small lose on short strings, but a big win on long ones.
3775 * It might even be a win on short strings if SvPVX_const(dstr)
3776 * has to be allocated and SvPVX_const(sstr) has to be freed.
3777 * Likewise if we can set up COW rather than doing an actual copy, we
3778 * drop to the else clause, as the swipe code and the COW setup code
3779 * have much in common.
3782 /* Whichever path we take through the next code, we want this true,
3783 and doing it now facilitates the COW check. */
3784 (void)SvPOK_only(dstr);
3787 /* If we're already COW then this clause is not true, and if COW
3788 is allowed then we drop down to the else and make dest COW
3789 with us. If caller hasn't said that we're allowed to COW
3790 shared hash keys then we don't do the COW setup, even if the
3791 source scalar is a shared hash key scalar. */
3792 (((flags & SV_COW_SHARED_HASH_KEYS)
3793 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3794 : 1 /* If making a COW copy is forbidden then the behaviour we
3795 desire is as if the source SV isn't actually already
3796 COW, even if it is. So we act as if the source flags
3797 are not COW, rather than actually testing them. */
3799 #ifndef PERL_OLD_COPY_ON_WRITE
3800 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3801 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3802 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3803 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3804 but in turn, it's somewhat dead code, never expected to go
3805 live, but more kept as a placeholder on how to do it better
3806 in a newer implementation. */
3807 /* If we are COW and dstr is a suitable target then we drop down
3808 into the else and make dest a COW of us. */
3809 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3814 (sflags & SVs_TEMP) && /* slated for free anyway? */
3815 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3816 (!(flags & SV_NOSTEAL)) &&
3817 /* and we're allowed to steal temps */
3818 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3819 SvLEN(sstr) && /* and really is a string */
3820 /* and won't be needed again, potentially */
3821 !(PL_op && PL_op->op_type == OP_AASSIGN))
3822 #ifdef PERL_OLD_COPY_ON_WRITE
3823 && ((flags & SV_COW_SHARED_HASH_KEYS)
3824 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3825 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3826 && SvTYPE(sstr) >= SVt_PVIV))
3830 /* Failed the swipe test, and it's not a shared hash key either.
3831 Have to copy the string. */
3832 STRLEN len = SvCUR(sstr);
3833 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3834 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3835 SvCUR_set(dstr, len);
3836 *SvEND(dstr) = '\0';
3838 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3840 /* Either it's a shared hash key, or it's suitable for
3841 copy-on-write or we can swipe the string. */
3843 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3847 #ifdef PERL_OLD_COPY_ON_WRITE
3849 /* I believe I should acquire a global SV mutex if
3850 it's a COW sv (not a shared hash key) to stop
3851 it going un copy-on-write.
3852 If the source SV has gone un copy on write between up there
3853 and down here, then (assert() that) it is of the correct
3854 form to make it copy on write again */
3855 if ((sflags & (SVf_FAKE | SVf_READONLY))
3856 != (SVf_FAKE | SVf_READONLY)) {
3857 SvREADONLY_on(sstr);
3859 /* Make the source SV into a loop of 1.
3860 (about to become 2) */
3861 SV_COW_NEXT_SV_SET(sstr, sstr);
3865 /* Initial code is common. */
3866 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3871 /* making another shared SV. */
3872 STRLEN cur = SvCUR(sstr);
3873 STRLEN len = SvLEN(sstr);
3874 #ifdef PERL_OLD_COPY_ON_WRITE
3876 assert (SvTYPE(dstr) >= SVt_PVIV);
3877 /* SvIsCOW_normal */
3878 /* splice us in between source and next-after-source. */
3879 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3880 SV_COW_NEXT_SV_SET(sstr, dstr);
3881 SvPV_set(dstr, SvPVX_mutable(sstr));
3885 /* SvIsCOW_shared_hash */
3886 DEBUG_C(PerlIO_printf(Perl_debug_log,
3887 "Copy on write: Sharing hash\n"));
3889 assert (SvTYPE(dstr) >= SVt_PV);
3891 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3893 SvLEN_set(dstr, len);
3894 SvCUR_set(dstr, cur);
3895 SvREADONLY_on(dstr);
3897 /* Relesase a global SV mutex. */
3900 { /* Passes the swipe test. */
3901 SvPV_set(dstr, SvPVX_mutable(sstr));
3902 SvLEN_set(dstr, SvLEN(sstr));
3903 SvCUR_set(dstr, SvCUR(sstr));
3906 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3907 SvPV_set(sstr, NULL);
3913 if (sflags & SVp_NOK) {
3914 SvNV_set(dstr, SvNVX(sstr));
3916 if (sflags & SVp_IOK) {
3917 SvIV_set(dstr, SvIVX(sstr));
3918 /* Must do this otherwise some other overloaded use of 0x80000000
3919 gets confused. I guess SVpbm_VALID */
3920 if (sflags & SVf_IVisUV)
3923 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3925 const MAGIC * const smg = SvVSTRING_mg(sstr);
3927 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3928 smg->mg_ptr, smg->mg_len);
3929 SvRMAGICAL_on(dstr);
3933 else if (sflags & (SVp_IOK|SVp_NOK)) {
3934 (void)SvOK_off(dstr);
3935 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3936 if (sflags & SVp_IOK) {
3937 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3938 SvIV_set(dstr, SvIVX(sstr));
3940 if (sflags & SVp_NOK) {
3941 SvNV_set(dstr, SvNVX(sstr));
3945 if (isGV_with_GP(sstr)) {
3946 /* This stringification rule for globs is spread in 3 places.
3947 This feels bad. FIXME. */
3948 const U32 wasfake = sflags & SVf_FAKE;
3950 /* FAKE globs can get coerced, so need to turn this off
3951 temporarily if it is on. */
3953 gv_efullname3(dstr, (GV *)sstr, "*");
3954 SvFLAGS(sstr) |= wasfake;
3957 (void)SvOK_off(dstr);
3959 if (SvTAINTED(sstr))
3964 =for apidoc sv_setsv_mg
3966 Like C<sv_setsv>, but also handles 'set' magic.
3972 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3974 PERL_ARGS_ASSERT_SV_SETSV_MG;
3976 sv_setsv(dstr,sstr);
3980 #ifdef PERL_OLD_COPY_ON_WRITE
3982 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3984 STRLEN cur = SvCUR(sstr);
3985 STRLEN len = SvLEN(sstr);
3986 register char *new_pv;
3988 PERL_ARGS_ASSERT_SV_SETSV_COW;
3991 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3992 (void*)sstr, (void*)dstr);
3999 if (SvTHINKFIRST(dstr))
4000 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4001 else if (SvPVX_const(dstr))
4002 Safefree(SvPVX_const(dstr));
4006 SvUPGRADE(dstr, SVt_PVIV);
4008 assert (SvPOK(sstr));
4009 assert (SvPOKp(sstr));
4010 assert (!SvIOK(sstr));
4011 assert (!SvIOKp(sstr));
4012 assert (!SvNOK(sstr));
4013 assert (!SvNOKp(sstr));
4015 if (SvIsCOW(sstr)) {
4017 if (SvLEN(sstr) == 0) {
4018 /* source is a COW shared hash key. */
4019 DEBUG_C(PerlIO_printf(Perl_debug_log,
4020 "Fast copy on write: Sharing hash\n"));
4021 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4024 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4026 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4027 SvUPGRADE(sstr, SVt_PVIV);
4028 SvREADONLY_on(sstr);
4030 DEBUG_C(PerlIO_printf(Perl_debug_log,
4031 "Fast copy on write: Converting sstr to COW\n"));
4032 SV_COW_NEXT_SV_SET(dstr, sstr);
4034 SV_COW_NEXT_SV_SET(sstr, dstr);
4035 new_pv = SvPVX_mutable(sstr);
4038 SvPV_set(dstr, new_pv);
4039 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4042 SvLEN_set(dstr, len);
4043 SvCUR_set(dstr, cur);
4052 =for apidoc sv_setpvn
4054 Copies a string into an SV. The C<len> parameter indicates the number of
4055 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4056 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4062 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4065 register char *dptr;
4067 PERL_ARGS_ASSERT_SV_SETPVN;
4069 SV_CHECK_THINKFIRST_COW_DROP(sv);
4075 /* len is STRLEN which is unsigned, need to copy to signed */
4078 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4080 SvUPGRADE(sv, SVt_PV);
4082 dptr = SvGROW(sv, len + 1);
4083 Move(ptr,dptr,len,char);
4086 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4091 =for apidoc sv_setpvn_mg
4093 Like C<sv_setpvn>, but also handles 'set' magic.
4099 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4101 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4103 sv_setpvn(sv,ptr,len);
4108 =for apidoc sv_setpv
4110 Copies a string into an SV. The string must be null-terminated. Does not
4111 handle 'set' magic. See C<sv_setpv_mg>.
4117 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4120 register STRLEN len;
4122 PERL_ARGS_ASSERT_SV_SETPV;
4124 SV_CHECK_THINKFIRST_COW_DROP(sv);
4130 SvUPGRADE(sv, SVt_PV);
4132 SvGROW(sv, len + 1);
4133 Move(ptr,SvPVX(sv),len+1,char);
4135 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4140 =for apidoc sv_setpv_mg
4142 Like C<sv_setpv>, but also handles 'set' magic.
4148 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4150 PERL_ARGS_ASSERT_SV_SETPV_MG;
4157 =for apidoc sv_usepvn_flags
4159 Tells an SV to use C<ptr> to find its string value. Normally the
4160 string is stored inside the SV but sv_usepvn allows the SV to use an
4161 outside string. The C<ptr> should point to memory that was allocated
4162 by C<malloc>. The string length, C<len>, must be supplied. By default
4163 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4164 so that pointer should not be freed or used by the programmer after
4165 giving it to sv_usepvn, and neither should any pointers from "behind"
4166 that pointer (e.g. ptr + 1) be used.
4168 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4169 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4170 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4171 C<len>, and already meets the requirements for storing in C<SvPVX>)
4177 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4182 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4184 SV_CHECK_THINKFIRST_COW_DROP(sv);
4185 SvUPGRADE(sv, SVt_PV);
4188 if (flags & SV_SMAGIC)
4192 if (SvPVX_const(sv))
4196 if (flags & SV_HAS_TRAILING_NUL)
4197 assert(ptr[len] == '\0');
4200 allocate = (flags & SV_HAS_TRAILING_NUL)
4202 #ifdef Perl_safesysmalloc_size
4205 PERL_STRLEN_ROUNDUP(len + 1);
4207 if (flags & SV_HAS_TRAILING_NUL) {
4208 /* It's long enough - do nothing.
4209 Specfically Perl_newCONSTSUB is relying on this. */
4212 /* Force a move to shake out bugs in callers. */
4213 char *new_ptr = (char*)safemalloc(allocate);
4214 Copy(ptr, new_ptr, len, char);
4215 PoisonFree(ptr,len,char);
4219 ptr = (char*) saferealloc (ptr, allocate);
4222 #ifdef Perl_safesysmalloc_size
4223 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4225 SvLEN_set(sv, allocate);
4229 if (!(flags & SV_HAS_TRAILING_NUL)) {
4232 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4234 if (flags & SV_SMAGIC)
4238 #ifdef PERL_OLD_COPY_ON_WRITE
4239 /* Need to do this *after* making the SV normal, as we need the buffer
4240 pointer to remain valid until after we've copied it. If we let go too early,
4241 another thread could invalidate it by unsharing last of the same hash key
4242 (which it can do by means other than releasing copy-on-write Svs)
4243 or by changing the other copy-on-write SVs in the loop. */
4245 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4247 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4249 { /* this SV was SvIsCOW_normal(sv) */
4250 /* we need to find the SV pointing to us. */
4251 SV *current = SV_COW_NEXT_SV(after);
4253 if (current == sv) {
4254 /* The SV we point to points back to us (there were only two of us
4256 Hence other SV is no longer copy on write either. */
4258 SvREADONLY_off(after);
4260 /* We need to follow the pointers around the loop. */
4262 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4265 /* don't loop forever if the structure is bust, and we have
4266 a pointer into a closed loop. */
4267 assert (current != after);
4268 assert (SvPVX_const(current) == pvx);
4270 /* Make the SV before us point to the SV after us. */
4271 SV_COW_NEXT_SV_SET(current, after);
4277 =for apidoc sv_force_normal_flags
4279 Undo various types of fakery on an SV: if the PV is a shared string, make
4280 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4281 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4282 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4283 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4284 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4285 set to some other value.) In addition, the C<flags> parameter gets passed to
4286 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4287 with flags set to 0.
4293 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4297 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4299 #ifdef PERL_OLD_COPY_ON_WRITE
4300 if (SvREADONLY(sv)) {
4301 /* At this point I believe I should acquire a global SV mutex. */
4303 const char * const pvx = SvPVX_const(sv);
4304 const STRLEN len = SvLEN(sv);
4305 const STRLEN cur = SvCUR(sv);
4306 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4307 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4308 we'll fail an assertion. */
4309 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4312 PerlIO_printf(Perl_debug_log,
4313 "Copy on write: Force normal %ld\n",
4319 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4322 if (flags & SV_COW_DROP_PV) {
4323 /* OK, so we don't need to copy our buffer. */
4326 SvGROW(sv, cur + 1);
4327 Move(pvx,SvPVX(sv),cur,char);
4332 sv_release_COW(sv, pvx, next);
4334 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4340 else if (IN_PERL_RUNTIME)
4341 Perl_croak(aTHX_ PL_no_modify);
4342 /* At this point I believe that I can drop the global SV mutex. */
4345 if (SvREADONLY(sv)) {
4347 const char * const pvx = SvPVX_const(sv);
4348 const STRLEN len = SvCUR(sv);
4353 SvGROW(sv, len + 1);
4354 Move(pvx,SvPVX(sv),len,char);
4356 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4358 else if (IN_PERL_RUNTIME)
4359 Perl_croak(aTHX_ PL_no_modify);
4363 sv_unref_flags(sv, flags);
4364 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4371 Efficient removal of characters from the beginning of the string buffer.
4372 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4373 the string buffer. The C<ptr> becomes the first character of the adjusted
4374 string. Uses the "OOK hack".
4375 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4376 refer to the same chunk of data.
4382 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4388 const U8 *real_start;
4392 PERL_ARGS_ASSERT_SV_CHOP;
4394 if (!ptr || !SvPOKp(sv))
4396 delta = ptr - SvPVX_const(sv);
4398 /* Nothing to do. */
4401 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4402 nothing uses the value of ptr any more. */
4403 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4404 if (ptr <= SvPVX_const(sv))
4405 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4406 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4407 SV_CHECK_THINKFIRST(sv);
4408 if (delta > max_delta)
4409 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4410 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4411 SvPVX_const(sv) + max_delta);
4414 if (!SvLEN(sv)) { /* make copy of shared string */
4415 const char *pvx = SvPVX_const(sv);
4416 const STRLEN len = SvCUR(sv);
4417 SvGROW(sv, len + 1);
4418 Move(pvx,SvPVX(sv),len,char);
4421 SvFLAGS(sv) |= SVf_OOK;
4424 SvOOK_offset(sv, old_delta);
4426 SvLEN_set(sv, SvLEN(sv) - delta);
4427 SvCUR_set(sv, SvCUR(sv) - delta);
4428 SvPV_set(sv, SvPVX(sv) + delta);
4430 p = (U8 *)SvPVX_const(sv);
4435 real_start = p - delta;
4439 if (delta < 0x100) {
4443 p -= sizeof(STRLEN);
4444 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4448 /* Fill the preceding buffer with sentinals to verify that no-one is
4450 while (p > real_start) {
4458 =for apidoc sv_catpvn
4460 Concatenates the string onto the end of the string which is in the SV. The
4461 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4462 status set, then the bytes appended should be valid UTF-8.
4463 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4465 =for apidoc sv_catpvn_flags
4467 Concatenates the string onto the end of the string which is in the SV. The
4468 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4469 status set, then the bytes appended should be valid UTF-8.
4470 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4471 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4472 in terms of this function.
4478 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4482 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4484 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4486 SvGROW(dsv, dlen + slen + 1);
4488 sstr = SvPVX_const(dsv);
4489 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4490 SvCUR_set(dsv, SvCUR(dsv) + slen);
4492 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4494 if (flags & SV_SMAGIC)
4499 =for apidoc sv_catsv
4501 Concatenates the string from SV C<ssv> onto the end of the string in
4502 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4503 not 'set' magic. See C<sv_catsv_mg>.
4505 =for apidoc sv_catsv_flags
4507 Concatenates the string from SV C<ssv> onto the end of the string in
4508 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4509 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4510 and C<sv_catsv_nomg> are implemented in terms of this function.
4515 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4519 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4523 const char *spv = SvPV_const(ssv, slen);
4525 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4526 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4527 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4528 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4529 dsv->sv_flags doesn't have that bit set.
4530 Andy Dougherty 12 Oct 2001
4532 const I32 sutf8 = DO_UTF8(ssv);
4535 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4537 dutf8 = DO_UTF8(dsv);
4539 if (dutf8 != sutf8) {
4541 /* Not modifying source SV, so taking a temporary copy. */
4542 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4544 sv_utf8_upgrade(csv);
4545 spv = SvPV_const(csv, slen);
4548 sv_utf8_upgrade_nomg(dsv);
4550 sv_catpvn_nomg(dsv, spv, slen);
4553 if (flags & SV_SMAGIC)
4558 =for apidoc sv_catpv
4560 Concatenates the string onto the end of the string which is in the SV.
4561 If the SV has the UTF-8 status set, then the bytes appended should be
4562 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4567 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4570 register STRLEN len;
4574 PERL_ARGS_ASSERT_SV_CATPV;
4578 junk = SvPV_force(sv, tlen);
4580 SvGROW(sv, tlen + len + 1);
4582 ptr = SvPVX_const(sv);
4583 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4584 SvCUR_set(sv, SvCUR(sv) + len);
4585 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4590 =for apidoc sv_catpv_mg
4592 Like C<sv_catpv>, but also handles 'set' magic.
4598 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4600 PERL_ARGS_ASSERT_SV_CATPV_MG;
4609 Creates a new SV. A non-zero C<len> parameter indicates the number of
4610 bytes of preallocated string space the SV should have. An extra byte for a
4611 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4612 space is allocated.) The reference count for the new SV is set to 1.
4614 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4615 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4616 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4617 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4618 modules supporting older perls.
4624 Perl_newSV(pTHX_ const STRLEN len)
4631 sv_upgrade(sv, SVt_PV);
4632 SvGROW(sv, len + 1);
4637 =for apidoc sv_magicext
4639 Adds magic to an SV, upgrading it if necessary. Applies the
4640 supplied vtable and returns a pointer to the magic added.
4642 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4643 In particular, you can add magic to SvREADONLY SVs, and add more than
4644 one instance of the same 'how'.
4646 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4647 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4648 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4649 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4651 (This is now used as a subroutine by C<sv_magic>.)
4656 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4657 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4662 PERL_ARGS_ASSERT_SV_MAGICEXT;
4664 SvUPGRADE(sv, SVt_PVMG);
4665 Newxz(mg, 1, MAGIC);
4666 mg->mg_moremagic = SvMAGIC(sv);
4667 SvMAGIC_set(sv, mg);
4669 /* Sometimes a magic contains a reference loop, where the sv and
4670 object refer to each other. To prevent a reference loop that
4671 would prevent such objects being freed, we look for such loops
4672 and if we find one we avoid incrementing the object refcount.
4674 Note we cannot do this to avoid self-tie loops as intervening RV must
4675 have its REFCNT incremented to keep it in existence.
4678 if (!obj || obj == sv ||
4679 how == PERL_MAGIC_arylen ||
4680 how == PERL_MAGIC_symtab ||
4681 (SvTYPE(obj) == SVt_PVGV &&
4682 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4683 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4684 GvFORM(obj) == (CV*)sv)))
4689 mg->mg_obj = SvREFCNT_inc_simple(obj);
4690 mg->mg_flags |= MGf_REFCOUNTED;
4693 /* Normal self-ties simply pass a null object, and instead of
4694 using mg_obj directly, use the SvTIED_obj macro to produce a
4695 new RV as needed. For glob "self-ties", we are tieing the PVIO
4696 with an RV obj pointing to the glob containing the PVIO. In
4697 this case, to avoid a reference loop, we need to weaken the
4701 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4702 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4708 mg->mg_len = namlen;
4711 mg->mg_ptr = savepvn(name, namlen);
4712 else if (namlen == HEf_SVKEY)
4713 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4715 mg->mg_ptr = (char *) name;
4717 mg->mg_virtual = (MGVTBL *) vtable;
4721 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4726 =for apidoc sv_magic
4728 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4729 then adds a new magic item of type C<how> to the head of the magic list.
4731 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4732 handling of the C<name> and C<namlen> arguments.
4734 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4735 to add more than one instance of the same 'how'.
4741 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4742 const char *const name, const I32 namlen)
4745 const MGVTBL *vtable;
4748 PERL_ARGS_ASSERT_SV_MAGIC;
4750 #ifdef PERL_OLD_COPY_ON_WRITE
4752 sv_force_normal_flags(sv, 0);
4754 if (SvREADONLY(sv)) {
4756 /* its okay to attach magic to shared strings; the subsequent
4757 * upgrade to PVMG will unshare the string */
4758 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4761 && how != PERL_MAGIC_regex_global
4762 && how != PERL_MAGIC_bm
4763 && how != PERL_MAGIC_fm
4764 && how != PERL_MAGIC_sv
4765 && how != PERL_MAGIC_backref
4768 Perl_croak(aTHX_ PL_no_modify);
4771 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4772 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4773 /* sv_magic() refuses to add a magic of the same 'how' as an
4776 if (how == PERL_MAGIC_taint) {
4778 /* Any scalar which already had taint magic on which someone
4779 (erroneously?) did SvIOK_on() or similar will now be
4780 incorrectly sporting public "OK" flags. */
4781 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4789 vtable = &PL_vtbl_sv;
4791 case PERL_MAGIC_overload:
4792 vtable = &PL_vtbl_amagic;
4794 case PERL_MAGIC_overload_elem:
4795 vtable = &PL_vtbl_amagicelem;
4797 case PERL_MAGIC_overload_table:
4798 vtable = &PL_vtbl_ovrld;
4801 vtable = &PL_vtbl_bm;
4803 case PERL_MAGIC_regdata:
4804 vtable = &PL_vtbl_regdata;
4806 case PERL_MAGIC_regdatum:
4807 vtable = &PL_vtbl_regdatum;
4809 case PERL_MAGIC_env:
4810 vtable = &PL_vtbl_env;
4813 vtable = &PL_vtbl_fm;
4815 case PERL_MAGIC_envelem:
4816 vtable = &PL_vtbl_envelem;
4818 case PERL_MAGIC_regex_global:
4819 vtable = &PL_vtbl_mglob;
4821 case PERL_MAGIC_isa:
4822 vtable = &PL_vtbl_isa;
4824 case PERL_MAGIC_isaelem:
4825 vtable = &PL_vtbl_isaelem;
4827 case PERL_MAGIC_nkeys:
4828 vtable = &PL_vtbl_nkeys;
4830 case PERL_MAGIC_dbfile:
4833 case PERL_MAGIC_dbline:
4834 vtable = &PL_vtbl_dbline;
4836 #ifdef USE_LOCALE_COLLATE
4837 case PERL_MAGIC_collxfrm:
4838 vtable = &PL_vtbl_collxfrm;
4840 #endif /* USE_LOCALE_COLLATE */
4841 case PERL_MAGIC_tied:
4842 vtable = &PL_vtbl_pack;
4844 case PERL_MAGIC_tiedelem:
4845 case PERL_MAGIC_tiedscalar:
4846 vtable = &PL_vtbl_packelem;
4849 vtable = &PL_vtbl_regexp;
4851 case PERL_MAGIC_hints:
4852 /* As this vtable is all NULL, we can reuse it. */
4853 case PERL_MAGIC_sig:
4854 vtable = &PL_vtbl_sig;
4856 case PERL_MAGIC_sigelem:
4857 vtable = &PL_vtbl_sigelem;
4859 case PERL_MAGIC_taint:
4860 vtable = &PL_vtbl_taint;
4862 case PERL_MAGIC_uvar:
4863 vtable = &PL_vtbl_uvar;
4865 case PERL_MAGIC_vec:
4866 vtable = &PL_vtbl_vec;
4868 case PERL_MAGIC_arylen_p:
4869 case PERL_MAGIC_rhash:
4870 case PERL_MAGIC_symtab:
4871 case PERL_MAGIC_vstring:
4874 case PERL_MAGIC_utf8:
4875 vtable = &PL_vtbl_utf8;
4877 case PERL_MAGIC_substr:
4878 vtable = &PL_vtbl_substr;
4880 case PERL_MAGIC_defelem:
4881 vtable = &PL_vtbl_defelem;
4883 case PERL_MAGIC_arylen:
4884 vtable = &PL_vtbl_arylen;
4886 case PERL_MAGIC_pos:
4887 vtable = &PL_vtbl_pos;
4889 case PERL_MAGIC_backref:
4890 vtable = &PL_vtbl_backref;
4892 case PERL_MAGIC_hintselem:
4893 vtable = &PL_vtbl_hintselem;
4895 case PERL_MAGIC_ext:
4896 /* Reserved for use by extensions not perl internals. */
4897 /* Useful for attaching extension internal data to perl vars. */
4898 /* Note that multiple extensions may clash if magical scalars */
4899 /* etc holding private data from one are passed to another. */
4903 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4906 /* Rest of work is done else where */
4907 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4910 case PERL_MAGIC_taint:
4913 case PERL_MAGIC_ext:
4914 case PERL_MAGIC_dbfile:
4921 =for apidoc sv_unmagic
4923 Removes all magic of type C<type> from an SV.
4929 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4934 PERL_ARGS_ASSERT_SV_UNMAGIC;
4936 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4938 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4939 for (mg = *mgp; mg; mg = *mgp) {
4940 if (mg->mg_type == type) {
4941 const MGVTBL* const vtbl = mg->mg_virtual;
4942 *mgp = mg->mg_moremagic;
4943 if (vtbl && vtbl->svt_free)
4944 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4945 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4947 Safefree(mg->mg_ptr);
4948 else if (mg->mg_len == HEf_SVKEY)
4949 SvREFCNT_dec((SV*)mg->mg_ptr);
4950 else if (mg->mg_type == PERL_MAGIC_utf8)
4951 Safefree(mg->mg_ptr);
4953 if (mg->mg_flags & MGf_REFCOUNTED)
4954 SvREFCNT_dec(mg->mg_obj);
4958 mgp = &mg->mg_moremagic;
4962 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4963 SvMAGIC_set(sv, NULL);
4970 =for apidoc sv_rvweaken
4972 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4973 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4974 push a back-reference to this RV onto the array of backreferences
4975 associated with that magic. If the RV is magical, set magic will be
4976 called after the RV is cleared.
4982 Perl_sv_rvweaken(pTHX_ SV *const sv)
4986 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4988 if (!SvOK(sv)) /* let undefs pass */
4991 Perl_croak(aTHX_ "Can't weaken a nonreference");
4992 else if (SvWEAKREF(sv)) {
4993 if (ckWARN(WARN_MISC))
4994 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4998 Perl_sv_add_backref(aTHX_ tsv, sv);
5004 /* Give tsv backref magic if it hasn't already got it, then push a
5005 * back-reference to sv onto the array associated with the backref magic.
5008 /* A discussion about the backreferences array and its refcount:
5010 * The AV holding the backreferences is pointed to either as the mg_obj of
5011 * PERL_MAGIC_backref, or in the specific case of a HV that has the hv_aux
5012 * structure, from the xhv_backreferences field. (A HV without hv_aux will
5013 * have the standard magic instead.) The array is created with a refcount
5014 * of 2. This means that if during global destruction the array gets
5015 * picked on first to have its refcount decremented by the random zapper,
5016 * it won't actually be freed, meaning it's still theere for when its
5017 * parent gets freed.
5018 * When the parent SV is freed, in the case of magic, the magic is freed,
5019 * Perl_magic_killbackrefs is called which decrements one refcount, then
5020 * mg_obj is freed which kills the second count.
5021 * In the vase of a HV being freed, one ref is removed by
5022 * Perl_hv_kill_backrefs, the other by Perl_sv_kill_backrefs, which it
5027 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5032 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5034 if (SvTYPE(tsv) == SVt_PVHV) {
5035 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5039 /* There is no AV in the offical place - try a fixup. */
5040 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5043 /* Aha. They've got it stowed in magic. Bring it back. */
5044 av = (AV*)mg->mg_obj;
5045 /* Stop mg_free decreasing the refernce count. */
5047 /* Stop mg_free even calling the destructor, given that
5048 there's no AV to free up. */
5050 sv_unmagic(tsv, PERL_MAGIC_backref);
5054 SvREFCNT_inc_simple_void(av); /* see discussion above */
5059 const MAGIC *const mg
5060 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5062 av = (AV*)mg->mg_obj;
5066 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5067 /* av now has a refcnt of 2; see discussion above */
5070 if (AvFILLp(av) >= AvMAX(av)) {
5071 av_extend(av, AvFILLp(av)+1);
5073 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5076 /* delete a back-reference to ourselves from the backref magic associated
5077 * with the SV we point to.
5081 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5088 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5090 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5091 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5092 /* We mustn't attempt to "fix up" the hash here by moving the
5093 backreference array back to the hv_aux structure, as that is stored
5094 in the main HvARRAY(), and hfreentries assumes that no-one
5095 reallocates HvARRAY() while it is running. */
5098 const MAGIC *const mg
5099 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5101 av = (AV *)mg->mg_obj;
5105 Perl_croak(aTHX_ "panic: del_backref");
5107 assert(!SvIS_FREED(av));
5110 /* We shouldn't be in here more than once, but for paranoia reasons lets
5112 for (i = AvFILLp(av); i >= 0; i--) {
5114 const SSize_t fill = AvFILLp(av);
5116 /* We weren't the last entry.
5117 An unordered list has this property that you can take the
5118 last element off the end to fill the hole, and it's still
5119 an unordered list :-)
5124 AvFILLp(av) = fill - 1;
5130 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5132 SV **svp = AvARRAY(av);
5134 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5135 PERL_UNUSED_ARG(sv);
5137 assert(!svp || !SvIS_FREED(av));
5139 SV *const *const last = svp + AvFILLp(av);
5141 while (svp <= last) {
5143 SV *const referrer = *svp;
5144 if (SvWEAKREF(referrer)) {
5145 /* XXX Should we check that it hasn't changed? */
5146 SvRV_set(referrer, 0);
5148 SvWEAKREF_off(referrer);
5149 SvSETMAGIC(referrer);
5150 } else if (SvTYPE(referrer) == SVt_PVGV ||
5151 SvTYPE(referrer) == SVt_PVLV) {
5152 /* You lookin' at me? */
5153 assert(GvSTASH(referrer));
5154 assert(GvSTASH(referrer) == (HV*)sv);
5155 GvSTASH(referrer) = 0;
5158 "panic: magic_killbackrefs (flags=%"UVxf")",
5159 (UV)SvFLAGS(referrer));
5167 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5172 =for apidoc sv_insert
5174 Inserts a string at the specified offset/length within the SV. Similar to
5175 the Perl substr() function. Handles get magic.
5177 =for apidoc sv_insert_flags
5179 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5185 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5190 register char *midend;
5191 register char *bigend;
5195 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5198 Perl_croak(aTHX_ "Can't modify non-existent substring");
5199 SvPV_force_flags(bigstr, curlen, flags);
5200 (void)SvPOK_only_UTF8(bigstr);
5201 if (offset + len > curlen) {
5202 SvGROW(bigstr, offset+len+1);
5203 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5204 SvCUR_set(bigstr, offset+len);
5208 i = littlelen - len;
5209 if (i > 0) { /* string might grow */
5210 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5211 mid = big + offset + len;
5212 midend = bigend = big + SvCUR(bigstr);
5215 while (midend > mid) /* shove everything down */
5216 *--bigend = *--midend;
5217 Move(little,big+offset,littlelen,char);
5218 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5223 Move(little,SvPVX(bigstr)+offset,len,char);
5228 big = SvPVX(bigstr);
5231 bigend = big + SvCUR(bigstr);
5233 if (midend > bigend)
5234 Perl_croak(aTHX_ "panic: sv_insert");
5236 if (mid - big > bigend - midend) { /* faster to shorten from end */
5238 Move(little, mid, littlelen,char);
5241 i = bigend - midend;
5243 Move(midend, mid, i,char);
5247 SvCUR_set(bigstr, mid - big);
5249 else if ((i = mid - big)) { /* faster from front */
5250 midend -= littlelen;
5252 Move(big, midend - i, i, char);
5253 sv_chop(bigstr,midend-i);
5255 Move(little, mid, littlelen,char);
5257 else if (littlelen) {
5258 midend -= littlelen;
5259 sv_chop(bigstr,midend);
5260 Move(little,midend,littlelen,char);
5263 sv_chop(bigstr,midend);
5269 =for apidoc sv_replace
5271 Make the first argument a copy of the second, then delete the original.
5272 The target SV physically takes over ownership of the body of the source SV
5273 and inherits its flags; however, the target keeps any magic it owns,
5274 and any magic in the source is discarded.
5275 Note that this is a rather specialist SV copying operation; most of the
5276 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5282 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5285 const U32 refcnt = SvREFCNT(sv);
5287 PERL_ARGS_ASSERT_SV_REPLACE;
5289 SV_CHECK_THINKFIRST_COW_DROP(sv);
5290 if (SvREFCNT(nsv) != 1) {
5291 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5292 UVuf " != 1)", (UV) SvREFCNT(nsv));
5294 if (SvMAGICAL(sv)) {
5298 sv_upgrade(nsv, SVt_PVMG);
5299 SvMAGIC_set(nsv, SvMAGIC(sv));
5300 SvFLAGS(nsv) |= SvMAGICAL(sv);
5302 SvMAGIC_set(sv, NULL);
5306 assert(!SvREFCNT(sv));
5307 #ifdef DEBUG_LEAKING_SCALARS
5308 sv->sv_flags = nsv->sv_flags;
5309 sv->sv_any = nsv->sv_any;
5310 sv->sv_refcnt = nsv->sv_refcnt;
5311 sv->sv_u = nsv->sv_u;
5313 StructCopy(nsv,sv,SV);
5315 if(SvTYPE(sv) == SVt_IV) {
5317 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5321 #ifdef PERL_OLD_COPY_ON_WRITE
5322 if (SvIsCOW_normal(nsv)) {
5323 /* We need to follow the pointers around the loop to make the
5324 previous SV point to sv, rather than nsv. */
5327 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5330 assert(SvPVX_const(current) == SvPVX_const(nsv));
5332 /* Make the SV before us point to the SV after us. */
5334 PerlIO_printf(Perl_debug_log, "previous is\n");
5336 PerlIO_printf(Perl_debug_log,
5337 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5338 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5340 SV_COW_NEXT_SV_SET(current, sv);
5343 SvREFCNT(sv) = refcnt;
5344 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5350 =for apidoc sv_clear
5352 Clear an SV: call any destructors, free up any memory used by the body,
5353 and free the body itself. The SV's head is I<not> freed, although
5354 its type is set to all 1's so that it won't inadvertently be assumed
5355 to be live during global destruction etc.
5356 This function should only be called when REFCNT is zero. Most of the time
5357 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5364 Perl_sv_clear(pTHX_ register SV *const sv)
5367 const U32 type = SvTYPE(sv);
5368 const struct body_details *const sv_type_details
5369 = bodies_by_type + type;
5372 PERL_ARGS_ASSERT_SV_CLEAR;
5373 assert(SvREFCNT(sv) == 0);
5374 assert(SvTYPE(sv) != SVTYPEMASK);
5376 if (type <= SVt_IV) {
5377 /* See the comment in sv.h about the collusion between this early
5378 return and the overloading of the NULL and IV slots in the size
5381 SV * const target = SvRV(sv);
5383 sv_del_backref(target, sv);
5385 SvREFCNT_dec(target);
5387 SvFLAGS(sv) &= SVf_BREAK;
5388 SvFLAGS(sv) |= SVTYPEMASK;
5393 if (PL_defstash && /* Still have a symbol table? */
5400 stash = SvSTASH(sv);
5401 destructor = StashHANDLER(stash,DESTROY);
5403 SV* const tmpref = newRV(sv);
5404 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5406 PUSHSTACKi(PERLSI_DESTROY);
5411 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5417 if(SvREFCNT(tmpref) < 2) {
5418 /* tmpref is not kept alive! */
5420 SvRV_set(tmpref, NULL);
5423 SvREFCNT_dec(tmpref);
5425 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5429 if (PL_in_clean_objs)
5430 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5432 /* DESTROY gave object new lease on life */
5438 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5439 SvOBJECT_off(sv); /* Curse the object. */
5440 if (type != SVt_PVIO)
5441 --PL_sv_objcount; /* XXX Might want something more general */
5444 if (type >= SVt_PVMG) {
5445 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5446 SvREFCNT_dec(SvOURSTASH(sv));
5447 } else if (SvMAGIC(sv))
5449 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5450 SvREFCNT_dec(SvSTASH(sv));
5453 /* case SVt_BIND: */
5456 IoIFP(sv) != PerlIO_stdin() &&
5457 IoIFP(sv) != PerlIO_stdout() &&
5458 IoIFP(sv) != PerlIO_stderr())
5460 io_close((IO*)sv, FALSE);
5462 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5463 PerlDir_close(IoDIRP(sv));
5464 IoDIRP(sv) = (DIR*)NULL;
5465 Safefree(IoTOP_NAME(sv));
5466 Safefree(IoFMT_NAME(sv));
5467 Safefree(IoBOTTOM_NAME(sv));
5470 /* FIXME for plugins */
5471 pregfree2((REGEXP*) sv);
5478 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5482 if (PL_comppad == (AV*)sv) {
5489 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5490 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5491 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5492 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5494 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5495 SvREFCNT_dec(LvTARG(sv));
5497 if (isGV_with_GP(sv)) {
5498 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5499 mro_method_changed_in(stash);
5502 unshare_hek(GvNAME_HEK(sv));
5503 /* If we're in a stash, we don't own a reference to it. However it does
5504 have a back reference to us, which needs to be cleared. */
5505 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5506 sv_del_backref((SV*)stash, sv);
5508 /* FIXME. There are probably more unreferenced pointers to SVs in the
5509 interpreter struct that we should check and tidy in a similar
5511 if ((GV*)sv == PL_last_in_gv)
5512 PL_last_in_gv = NULL;
5518 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5521 SvOOK_offset(sv, offset);
5522 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5523 /* Don't even bother with turning off the OOK flag. */
5526 SV * const target = SvRV(sv);
5528 sv_del_backref(target, sv);
5530 SvREFCNT_dec(target);
5532 #ifdef PERL_OLD_COPY_ON_WRITE
5533 else if (SvPVX_const(sv)) {
5535 /* I believe I need to grab the global SV mutex here and
5536 then recheck the COW status. */
5538 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5542 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5544 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5547 /* And drop it here. */
5549 } else if (SvLEN(sv)) {
5550 Safefree(SvPVX_const(sv));
5554 else if (SvPVX_const(sv) && SvLEN(sv))
5555 Safefree(SvPVX_mutable(sv));
5556 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5557 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5566 SvFLAGS(sv) &= SVf_BREAK;
5567 SvFLAGS(sv) |= SVTYPEMASK;
5569 if (sv_type_details->arena) {
5570 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5571 &PL_body_roots[type]);
5573 else if (sv_type_details->body_size) {
5574 my_safefree(SvANY(sv));
5579 =for apidoc sv_newref
5581 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5588 Perl_sv_newref(pTHX_ SV *const sv)
5590 PERL_UNUSED_CONTEXT;
5599 Decrement an SV's reference count, and if it drops to zero, call
5600 C<sv_clear> to invoke destructors and free up any memory used by
5601 the body; finally, deallocate the SV's head itself.
5602 Normally called via a wrapper macro C<SvREFCNT_dec>.
5608 Perl_sv_free(pTHX_ SV *const sv)
5613 if (SvREFCNT(sv) == 0) {
5614 if (SvFLAGS(sv) & SVf_BREAK)
5615 /* this SV's refcnt has been artificially decremented to
5616 * trigger cleanup */
5618 if (PL_in_clean_all) /* All is fair */
5620 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5621 /* make sure SvREFCNT(sv)==0 happens very seldom */
5622 SvREFCNT(sv) = (~(U32)0)/2;
5625 if (ckWARN_d(WARN_INTERNAL)) {
5626 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5627 Perl_dump_sv_child(aTHX_ sv);
5629 #ifdef DEBUG_LEAKING_SCALARS
5632 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5633 if (PL_warnhook == PERL_WARNHOOK_FATAL
5634 || ckDEAD(packWARN(WARN_INTERNAL))) {
5635 /* Don't let Perl_warner cause us to escape our fate: */
5639 /* This may not return: */
5640 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5641 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5642 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5645 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5650 if (--(SvREFCNT(sv)) > 0)
5652 Perl_sv_free2(aTHX_ sv);
5656 Perl_sv_free2(pTHX_ SV *const sv)
5660 PERL_ARGS_ASSERT_SV_FREE2;
5664 if (ckWARN_d(WARN_DEBUGGING))
5665 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5666 "Attempt to free temp prematurely: SV 0x%"UVxf
5667 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5671 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5672 /* make sure SvREFCNT(sv)==0 happens very seldom */
5673 SvREFCNT(sv) = (~(U32)0)/2;
5684 Returns the length of the string in the SV. Handles magic and type
5685 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5691 Perl_sv_len(pTHX_ register SV *const sv)
5699 len = mg_length(sv);
5701 (void)SvPV_const(sv, len);
5706 =for apidoc sv_len_utf8
5708 Returns the number of characters in the string in an SV, counting wide
5709 UTF-8 bytes as a single character. Handles magic and type coercion.
5715 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5716 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5717 * (Note that the mg_len is not the length of the mg_ptr field.
5718 * This allows the cache to store the character length of the string without
5719 * needing to malloc() extra storage to attach to the mg_ptr.)
5724 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5730 return mg_length(sv);
5734 const U8 *s = (U8*)SvPV_const(sv, len);
5738 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5740 if (mg && mg->mg_len != -1) {
5742 if (PL_utf8cache < 0) {
5743 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5745 /* Need to turn the assertions off otherwise we may
5746 recurse infinitely while printing error messages.
5748 SAVEI8(PL_utf8cache);
5750 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5751 " real %"UVuf" for %"SVf,
5752 (UV) ulen, (UV) real, SVfARG(sv));
5757 ulen = Perl_utf8_length(aTHX_ s, s + len);
5758 if (!SvREADONLY(sv)) {
5760 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5761 &PL_vtbl_utf8, 0, 0);
5769 return Perl_utf8_length(aTHX_ s, s + len);
5773 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5776 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5779 const U8 *s = start;
5781 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5783 while (s < send && uoffset--)
5786 /* This is the existing behaviour. Possibly it should be a croak, as
5787 it's actually a bounds error */
5793 /* Given the length of the string in both bytes and UTF-8 characters, decide
5794 whether to walk forwards or backwards to find the byte corresponding to
5795 the passed in UTF-8 offset. */
5797 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5798 const STRLEN uoffset, const STRLEN uend)
5800 STRLEN backw = uend - uoffset;
5802 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5804 if (uoffset < 2 * backw) {
5805 /* The assumption is that going forwards is twice the speed of going
5806 forward (that's where the 2 * backw comes from).
5807 (The real figure of course depends on the UTF-8 data.) */
5808 return sv_pos_u2b_forwards(start, send, uoffset);
5813 while (UTF8_IS_CONTINUATION(*send))
5816 return send - start;
5819 /* For the string representation of the given scalar, find the byte
5820 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5821 give another position in the string, *before* the sought offset, which
5822 (which is always true, as 0, 0 is a valid pair of positions), which should
5823 help reduce the amount of linear searching.
5824 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5825 will be used to reduce the amount of linear searching. The cache will be
5826 created if necessary, and the found value offered to it for update. */
5828 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5829 const U8 *const send, const STRLEN uoffset,
5830 STRLEN uoffset0, STRLEN boffset0)
5832 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5835 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5837 assert (uoffset >= uoffset0);
5839 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5840 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5841 if ((*mgp)->mg_ptr) {
5842 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5843 if (cache[0] == uoffset) {
5844 /* An exact match. */
5847 if (cache[2] == uoffset) {
5848 /* An exact match. */
5852 if (cache[0] < uoffset) {
5853 /* The cache already knows part of the way. */
5854 if (cache[0] > uoffset0) {
5855 /* The cache knows more than the passed in pair */
5856 uoffset0 = cache[0];
5857 boffset0 = cache[1];
5859 if ((*mgp)->mg_len != -1) {
5860 /* And we know the end too. */
5862 + sv_pos_u2b_midway(start + boffset0, send,
5864 (*mgp)->mg_len - uoffset0);
5867 + sv_pos_u2b_forwards(start + boffset0,
5868 send, uoffset - uoffset0);
5871 else if (cache[2] < uoffset) {
5872 /* We're between the two cache entries. */
5873 if (cache[2] > uoffset0) {
5874 /* and the cache knows more than the passed in pair */
5875 uoffset0 = cache[2];
5876 boffset0 = cache[3];
5880 + sv_pos_u2b_midway(start + boffset0,
5883 cache[0] - uoffset0);
5886 + sv_pos_u2b_midway(start + boffset0,
5889 cache[2] - uoffset0);
5893 else if ((*mgp)->mg_len != -1) {
5894 /* If we can take advantage of a passed in offset, do so. */
5895 /* In fact, offset0 is either 0, or less than offset, so don't
5896 need to worry about the other possibility. */
5898 + sv_pos_u2b_midway(start + boffset0, send,
5900 (*mgp)->mg_len - uoffset0);
5905 if (!found || PL_utf8cache < 0) {
5906 const STRLEN real_boffset
5907 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5908 send, uoffset - uoffset0);
5910 if (found && PL_utf8cache < 0) {
5911 if (real_boffset != boffset) {
5912 /* Need to turn the assertions off otherwise we may recurse
5913 infinitely while printing error messages. */
5914 SAVEI8(PL_utf8cache);
5916 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5917 " real %"UVuf" for %"SVf,
5918 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5921 boffset = real_boffset;
5925 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5931 =for apidoc sv_pos_u2b
5933 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5934 the start of the string, to a count of the equivalent number of bytes; if
5935 lenp is non-zero, it does the same to lenp, but this time starting from
5936 the offset, rather than from the start of the string. Handles magic and
5943 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5944 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5945 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5950 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5955 PERL_ARGS_ASSERT_SV_POS_U2B;
5960 start = (U8*)SvPV_const(sv, len);
5962 STRLEN uoffset = (STRLEN) *offsetp;
5963 const U8 * const send = start + len;
5965 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5968 *offsetp = (I32) boffset;
5971 /* Convert the relative offset to absolute. */
5972 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5973 const STRLEN boffset2
5974 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5975 uoffset, boffset) - boffset;
5989 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5990 byte length pairing. The (byte) length of the total SV is passed in too,
5991 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5992 may not have updated SvCUR, so we can't rely on reading it directly.
5994 The proffered utf8/byte length pairing isn't used if the cache already has
5995 two pairs, and swapping either for the proffered pair would increase the
5996 RMS of the intervals between known byte offsets.
5998 The cache itself consists of 4 STRLEN values
5999 0: larger UTF-8 offset
6000 1: corresponding byte offset
6001 2: smaller UTF-8 offset
6002 3: corresponding byte offset
6004 Unused cache pairs have the value 0, 0.
6005 Keeping the cache "backwards" means that the invariant of
6006 cache[0] >= cache[2] is maintained even with empty slots, which means that
6007 the code that uses it doesn't need to worry if only 1 entry has actually
6008 been set to non-zero. It also makes the "position beyond the end of the
6009 cache" logic much simpler, as the first slot is always the one to start
6013 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6014 const STRLEN utf8, const STRLEN blen)
6018 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6024 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6026 (*mgp)->mg_len = -1;
6030 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6031 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6032 (*mgp)->mg_ptr = (char *) cache;
6036 if (PL_utf8cache < 0) {
6037 const U8 *start = (const U8 *) SvPVX_const(sv);
6038 const STRLEN realutf8 = utf8_length(start, start + byte);
6040 if (realutf8 != utf8) {
6041 /* Need to turn the assertions off otherwise we may recurse
6042 infinitely while printing error messages. */
6043 SAVEI8(PL_utf8cache);
6045 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6046 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6050 /* Cache is held with the later position first, to simplify the code
6051 that deals with unbounded ends. */
6053 ASSERT_UTF8_CACHE(cache);
6054 if (cache[1] == 0) {
6055 /* Cache is totally empty */
6058 } else if (cache[3] == 0) {
6059 if (byte > cache[1]) {
6060 /* New one is larger, so goes first. */
6061 cache[2] = cache[0];
6062 cache[3] = cache[1];
6070 #define THREEWAY_SQUARE(a,b,c,d) \
6071 ((float)((d) - (c))) * ((float)((d) - (c))) \
6072 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6073 + ((float)((b) - (a))) * ((float)((b) - (a)))
6075 /* Cache has 2 slots in use, and we know three potential pairs.
6076 Keep the two that give the lowest RMS distance. Do the
6077 calcualation in bytes simply because we always know the byte
6078 length. squareroot has the same ordering as the positive value,
6079 so don't bother with the actual square root. */
6080 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6081 if (byte > cache[1]) {
6082 /* New position is after the existing pair of pairs. */
6083 const float keep_earlier
6084 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6085 const float keep_later
6086 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6088 if (keep_later < keep_earlier) {
6089 if (keep_later < existing) {
6090 cache[2] = cache[0];
6091 cache[3] = cache[1];
6097 if (keep_earlier < existing) {
6103 else if (byte > cache[3]) {
6104 /* New position is between the existing pair of pairs. */
6105 const float keep_earlier
6106 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6107 const float keep_later
6108 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6110 if (keep_later < keep_earlier) {
6111 if (keep_later < existing) {
6117 if (keep_earlier < existing) {
6124 /* New position is before the existing pair of pairs. */
6125 const float keep_earlier
6126 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6127 const float keep_later
6128 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6130 if (keep_later < keep_earlier) {
6131 if (keep_later < existing) {
6137 if (keep_earlier < existing) {
6138 cache[0] = cache[2];
6139 cache[1] = cache[3];
6146 ASSERT_UTF8_CACHE(cache);
6149 /* We already know all of the way, now we may be able to walk back. The same
6150 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6151 backward is half the speed of walking forward. */
6153 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6154 const U8 *end, STRLEN endu)
6156 const STRLEN forw = target - s;
6157 STRLEN backw = end - target;
6159 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6161 if (forw < 2 * backw) {
6162 return utf8_length(s, target);
6165 while (end > target) {
6167 while (UTF8_IS_CONTINUATION(*end)) {
6176 =for apidoc sv_pos_b2u
6178 Converts the value pointed to by offsetp from a count of bytes from the
6179 start of the string, to a count of the equivalent number of UTF-8 chars.
6180 Handles magic and type coercion.
6186 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6187 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6192 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6195 const STRLEN byte = *offsetp;
6196 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6202 PERL_ARGS_ASSERT_SV_POS_B2U;
6207 s = (const U8*)SvPV_const(sv, blen);
6210 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6214 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6215 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6217 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6218 if (cache[1] == byte) {
6219 /* An exact match. */
6220 *offsetp = cache[0];
6223 if (cache[3] == byte) {
6224 /* An exact match. */
6225 *offsetp = cache[2];
6229 if (cache[1] < byte) {
6230 /* We already know part of the way. */
6231 if (mg->mg_len != -1) {
6232 /* Actually, we know the end too. */
6234 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6235 s + blen, mg->mg_len - cache[0]);
6237 len = cache[0] + utf8_length(s + cache[1], send);
6240 else if (cache[3] < byte) {
6241 /* We're between the two cached pairs, so we do the calculation
6242 offset by the byte/utf-8 positions for the earlier pair,
6243 then add the utf-8 characters from the string start to
6245 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6246 s + cache[1], cache[0] - cache[2])
6250 else { /* cache[3] > byte */
6251 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6255 ASSERT_UTF8_CACHE(cache);
6257 } else if (mg->mg_len != -1) {
6258 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6262 if (!found || PL_utf8cache < 0) {
6263 const STRLEN real_len = utf8_length(s, send);
6265 if (found && PL_utf8cache < 0) {
6266 if (len != real_len) {
6267 /* Need to turn the assertions off otherwise we may recurse
6268 infinitely while printing error messages. */
6269 SAVEI8(PL_utf8cache);
6271 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6272 " real %"UVuf" for %"SVf,
6273 (UV) len, (UV) real_len, SVfARG(sv));
6281 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6287 Returns a boolean indicating whether the strings in the two SVs are
6288 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6289 coerce its args to strings if necessary.
6295 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6304 SV* svrecode = NULL;
6311 /* if pv1 and pv2 are the same, second SvPV_const call may
6312 * invalidate pv1, so we may need to make a copy */
6313 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6314 pv1 = SvPV_const(sv1, cur1);
6315 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6317 pv1 = SvPV_const(sv1, cur1);
6325 pv2 = SvPV_const(sv2, cur2);
6327 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6328 /* Differing utf8ness.
6329 * Do not UTF8size the comparands as a side-effect. */
6332 svrecode = newSVpvn(pv2, cur2);
6333 sv_recode_to_utf8(svrecode, PL_encoding);
6334 pv2 = SvPV_const(svrecode, cur2);
6337 svrecode = newSVpvn(pv1, cur1);
6338 sv_recode_to_utf8(svrecode, PL_encoding);
6339 pv1 = SvPV_const(svrecode, cur1);
6341 /* Now both are in UTF-8. */
6343 SvREFCNT_dec(svrecode);
6348 bool is_utf8 = TRUE;
6351 /* sv1 is the UTF-8 one,
6352 * if is equal it must be downgrade-able */
6353 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6359 /* sv2 is the UTF-8 one,
6360 * if is equal it must be downgrade-able */
6361 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6367 /* Downgrade not possible - cannot be eq */
6375 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6377 SvREFCNT_dec(svrecode);
6387 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6388 string in C<sv1> is less than, equal to, or greater than the string in
6389 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6390 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6396 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6400 const char *pv1, *pv2;
6403 SV *svrecode = NULL;
6410 pv1 = SvPV_const(sv1, cur1);
6417 pv2 = SvPV_const(sv2, cur2);
6419 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6420 /* Differing utf8ness.
6421 * Do not UTF8size the comparands as a side-effect. */
6424 svrecode = newSVpvn(pv2, cur2);
6425 sv_recode_to_utf8(svrecode, PL_encoding);
6426 pv2 = SvPV_const(svrecode, cur2);
6429 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6434 svrecode = newSVpvn(pv1, cur1);
6435 sv_recode_to_utf8(svrecode, PL_encoding);
6436 pv1 = SvPV_const(svrecode, cur1);
6439 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6445 cmp = cur2 ? -1 : 0;
6449 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6452 cmp = retval < 0 ? -1 : 1;
6453 } else if (cur1 == cur2) {
6456 cmp = cur1 < cur2 ? -1 : 1;
6460 SvREFCNT_dec(svrecode);
6468 =for apidoc sv_cmp_locale
6470 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6471 'use bytes' aware, handles get magic, and will coerce its args to strings
6472 if necessary. See also C<sv_cmp>.
6478 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6481 #ifdef USE_LOCALE_COLLATE
6487 if (PL_collation_standard)
6491 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6493 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6495 if (!pv1 || !len1) {
6506 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6509 return retval < 0 ? -1 : 1;
6512 * When the result of collation is equality, that doesn't mean
6513 * that there are no differences -- some locales exclude some
6514 * characters from consideration. So to avoid false equalities,
6515 * we use the raw string as a tiebreaker.
6521 #endif /* USE_LOCALE_COLLATE */
6523 return sv_cmp(sv1, sv2);
6527 #ifdef USE_LOCALE_COLLATE
6530 =for apidoc sv_collxfrm
6532 Add Collate Transform magic to an SV if it doesn't already have it.
6534 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6535 scalar data of the variable, but transformed to such a format that a normal
6536 memory comparison can be used to compare the data according to the locale
6543 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6548 PERL_ARGS_ASSERT_SV_COLLXFRM;
6550 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6551 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6557 Safefree(mg->mg_ptr);
6558 s = SvPV_const(sv, len);
6559 if ((xf = mem_collxfrm(s, len, &xlen))) {
6561 #ifdef PERL_OLD_COPY_ON_WRITE
6563 sv_force_normal_flags(sv, 0);
6565 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6579 if (mg && mg->mg_ptr) {
6581 return mg->mg_ptr + sizeof(PL_collation_ix);
6589 #endif /* USE_LOCALE_COLLATE */
6594 Get a line from the filehandle and store it into the SV, optionally
6595 appending to the currently-stored string.
6601 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6606 register STDCHAR rslast;
6607 register STDCHAR *bp;
6612 PERL_ARGS_ASSERT_SV_GETS;
6614 if (SvTHINKFIRST(sv))
6615 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6616 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6618 However, perlbench says it's slower, because the existing swipe code
6619 is faster than copy on write.
6620 Swings and roundabouts. */
6621 SvUPGRADE(sv, SVt_PV);
6626 if (PerlIO_isutf8(fp)) {
6628 sv_utf8_upgrade_nomg(sv);
6629 sv_pos_u2b(sv,&append,0);
6631 } else if (SvUTF8(sv)) {
6632 SV * const tsv = newSV(0);
6633 sv_gets(tsv, fp, 0);
6634 sv_utf8_upgrade_nomg(tsv);
6635 SvCUR_set(sv,append);
6638 goto return_string_or_null;
6643 if (PerlIO_isutf8(fp))
6646 if (IN_PERL_COMPILETIME) {
6647 /* we always read code in line mode */
6651 else if (RsSNARF(PL_rs)) {
6652 /* If it is a regular disk file use size from stat() as estimate
6653 of amount we are going to read -- may result in mallocing
6654 more memory than we really need if the layers below reduce
6655 the size we read (e.g. CRLF or a gzip layer).
6658 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6659 const Off_t offset = PerlIO_tell(fp);
6660 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6661 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6667 else if (RsRECORD(PL_rs)) {
6675 /* Grab the size of the record we're getting */
6676 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6677 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6680 /* VMS wants read instead of fread, because fread doesn't respect */
6681 /* RMS record boundaries. This is not necessarily a good thing to be */
6682 /* doing, but we've got no other real choice - except avoid stdio
6683 as implementation - perhaps write a :vms layer ?
6685 fd = PerlIO_fileno(fp);
6686 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6687 bytesread = PerlIO_read(fp, buffer, recsize);
6690 bytesread = PerlLIO_read(fd, buffer, recsize);
6693 bytesread = PerlIO_read(fp, buffer, recsize);
6697 SvCUR_set(sv, bytesread += append);
6698 buffer[bytesread] = '\0';
6699 goto return_string_or_null;
6701 else if (RsPARA(PL_rs)) {
6707 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6708 if (PerlIO_isutf8(fp)) {
6709 rsptr = SvPVutf8(PL_rs, rslen);
6712 if (SvUTF8(PL_rs)) {
6713 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6714 Perl_croak(aTHX_ "Wide character in $/");
6717 rsptr = SvPV_const(PL_rs, rslen);
6721 rslast = rslen ? rsptr[rslen - 1] : '\0';
6723 if (rspara) { /* have to do this both before and after */
6724 do { /* to make sure file boundaries work right */
6727 i = PerlIO_getc(fp);
6731 PerlIO_ungetc(fp,i);
6737 /* See if we know enough about I/O mechanism to cheat it ! */
6739 /* This used to be #ifdef test - it is made run-time test for ease
6740 of abstracting out stdio interface. One call should be cheap
6741 enough here - and may even be a macro allowing compile
6745 if (PerlIO_fast_gets(fp)) {
6748 * We're going to steal some values from the stdio struct
6749 * and put EVERYTHING in the innermost loop into registers.
6751 register STDCHAR *ptr;
6755 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6756 /* An ungetc()d char is handled separately from the regular
6757 * buffer, so we getc() it back out and stuff it in the buffer.
6759 i = PerlIO_getc(fp);
6760 if (i == EOF) return 0;
6761 *(--((*fp)->_ptr)) = (unsigned char) i;
6765 /* Here is some breathtakingly efficient cheating */
6767 cnt = PerlIO_get_cnt(fp); /* get count into register */
6768 /* make sure we have the room */
6769 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6770 /* Not room for all of it
6771 if we are looking for a separator and room for some
6773 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6774 /* just process what we have room for */
6775 shortbuffered = cnt - SvLEN(sv) + append + 1;
6776 cnt -= shortbuffered;
6780 /* remember that cnt can be negative */
6781 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6786 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6787 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6788 DEBUG_P(PerlIO_printf(Perl_debug_log,
6789 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6790 DEBUG_P(PerlIO_printf(Perl_debug_log,
6791 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6792 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6793 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6798 while (cnt > 0) { /* this | eat */
6800 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6801 goto thats_all_folks; /* screams | sed :-) */
6805 Copy(ptr, bp, cnt, char); /* this | eat */
6806 bp += cnt; /* screams | dust */
6807 ptr += cnt; /* louder | sed :-) */
6812 if (shortbuffered) { /* oh well, must extend */
6813 cnt = shortbuffered;
6815 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6817 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6818 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6822 DEBUG_P(PerlIO_printf(Perl_debug_log,
6823 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6824 PTR2UV(ptr),(long)cnt));
6825 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6827 DEBUG_P(PerlIO_printf(Perl_debug_log,
6828 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6829 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6830 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6832 /* This used to call 'filbuf' in stdio form, but as that behaves like
6833 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6834 another abstraction. */
6835 i = PerlIO_getc(fp); /* get more characters */
6837 DEBUG_P(PerlIO_printf(Perl_debug_log,
6838 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6839 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6840 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6842 cnt = PerlIO_get_cnt(fp);
6843 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6844 DEBUG_P(PerlIO_printf(Perl_debug_log,
6845 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6847 if (i == EOF) /* all done for ever? */
6848 goto thats_really_all_folks;
6850 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6852 SvGROW(sv, bpx + cnt + 2);
6853 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6855 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6857 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6858 goto thats_all_folks;
6862 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6863 memNE((char*)bp - rslen, rsptr, rslen))
6864 goto screamer; /* go back to the fray */
6865 thats_really_all_folks:
6867 cnt += shortbuffered;
6868 DEBUG_P(PerlIO_printf(Perl_debug_log,
6869 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6870 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6871 DEBUG_P(PerlIO_printf(Perl_debug_log,
6872 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6873 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6874 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6876 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6877 DEBUG_P(PerlIO_printf(Perl_debug_log,
6878 "Screamer: done, len=%ld, string=|%.*s|\n",
6879 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6883 /*The big, slow, and stupid way. */
6884 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6885 STDCHAR *buf = NULL;
6886 Newx(buf, 8192, STDCHAR);
6894 register const STDCHAR * const bpe = buf + sizeof(buf);
6896 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6897 ; /* keep reading */
6901 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6902 /* Accomodate broken VAXC compiler, which applies U8 cast to
6903 * both args of ?: operator, causing EOF to change into 255
6906 i = (U8)buf[cnt - 1];
6912 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6914 sv_catpvn(sv, (char *) buf, cnt);
6916 sv_setpvn(sv, (char *) buf, cnt);
6918 if (i != EOF && /* joy */
6920 SvCUR(sv) < rslen ||
6921 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6925 * If we're reading from a TTY and we get a short read,
6926 * indicating that the user hit his EOF character, we need
6927 * to notice it now, because if we try to read from the TTY
6928 * again, the EOF condition will disappear.
6930 * The comparison of cnt to sizeof(buf) is an optimization
6931 * that prevents unnecessary calls to feof().
6935 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6939 #ifdef USE_HEAP_INSTEAD_OF_STACK
6944 if (rspara) { /* have to do this both before and after */
6945 while (i != EOF) { /* to make sure file boundaries work right */
6946 i = PerlIO_getc(fp);
6948 PerlIO_ungetc(fp,i);
6954 return_string_or_null:
6955 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6961 Auto-increment of the value in the SV, doing string to numeric conversion
6962 if necessary. Handles 'get' magic.
6968 Perl_sv_inc(pTHX_ register SV *const sv)
6977 if (SvTHINKFIRST(sv)) {
6979 sv_force_normal_flags(sv, 0);
6980 if (SvREADONLY(sv)) {
6981 if (IN_PERL_RUNTIME)
6982 Perl_croak(aTHX_ PL_no_modify);
6986 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6988 i = PTR2IV(SvRV(sv));
6993 flags = SvFLAGS(sv);
6994 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6995 /* It's (privately or publicly) a float, but not tested as an
6996 integer, so test it to see. */
6998 flags = SvFLAGS(sv);
7000 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7001 /* It's publicly an integer, or privately an integer-not-float */
7002 #ifdef PERL_PRESERVE_IVUV
7006 if (SvUVX(sv) == UV_MAX)
7007 sv_setnv(sv, UV_MAX_P1);
7009 (void)SvIOK_only_UV(sv);
7010 SvUV_set(sv, SvUVX(sv) + 1);
7012 if (SvIVX(sv) == IV_MAX)
7013 sv_setuv(sv, (UV)IV_MAX + 1);
7015 (void)SvIOK_only(sv);
7016 SvIV_set(sv, SvIVX(sv) + 1);
7021 if (flags & SVp_NOK) {
7022 const NV was = SvNVX(sv);
7023 if (NV_OVERFLOWS_INTEGERS_AT &&
7024 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7025 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7026 "Lost precision when incrementing %" NVff " by 1",
7029 (void)SvNOK_only(sv);
7030 SvNV_set(sv, was + 1.0);
7034 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7035 if ((flags & SVTYPEMASK) < SVt_PVIV)
7036 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7037 (void)SvIOK_only(sv);
7042 while (isALPHA(*d)) d++;
7043 while (isDIGIT(*d)) d++;
7045 #ifdef PERL_PRESERVE_IVUV
7046 /* Got to punt this as an integer if needs be, but we don't issue
7047 warnings. Probably ought to make the sv_iv_please() that does
7048 the conversion if possible, and silently. */
7049 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7050 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7051 /* Need to try really hard to see if it's an integer.
7052 9.22337203685478e+18 is an integer.
7053 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7054 so $a="9.22337203685478e+18"; $a+0; $a++
7055 needs to be the same as $a="9.22337203685478e+18"; $a++
7062 /* sv_2iv *should* have made this an NV */
7063 if (flags & SVp_NOK) {
7064 (void)SvNOK_only(sv);
7065 SvNV_set(sv, SvNVX(sv) + 1.0);
7068 /* I don't think we can get here. Maybe I should assert this
7069 And if we do get here I suspect that sv_setnv will croak. NWC
7071 #if defined(USE_LONG_DOUBLE)
7072 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",
7073 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7075 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7076 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7079 #endif /* PERL_PRESERVE_IVUV */
7080 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7084 while (d >= SvPVX_const(sv)) {
7092 /* MKS: The original code here died if letters weren't consecutive.
7093 * at least it didn't have to worry about non-C locales. The
7094 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7095 * arranged in order (although not consecutively) and that only
7096 * [A-Za-z] are accepted by isALPHA in the C locale.
7098 if (*d != 'z' && *d != 'Z') {
7099 do { ++*d; } while (!isALPHA(*d));
7102 *(d--) -= 'z' - 'a';
7107 *(d--) -= 'z' - 'a' + 1;
7111 /* oh,oh, the number grew */
7112 SvGROW(sv, SvCUR(sv) + 2);
7113 SvCUR_set(sv, SvCUR(sv) + 1);
7114 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7125 Auto-decrement of the value in the SV, doing string to numeric conversion
7126 if necessary. Handles 'get' magic.
7132 Perl_sv_dec(pTHX_ register SV *const sv)
7140 if (SvTHINKFIRST(sv)) {
7142 sv_force_normal_flags(sv, 0);
7143 if (SvREADONLY(sv)) {
7144 if (IN_PERL_RUNTIME)
7145 Perl_croak(aTHX_ PL_no_modify);
7149 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7151 i = PTR2IV(SvRV(sv));
7156 /* Unlike sv_inc we don't have to worry about string-never-numbers
7157 and keeping them magic. But we mustn't warn on punting */
7158 flags = SvFLAGS(sv);
7159 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7160 /* It's publicly an integer, or privately an integer-not-float */
7161 #ifdef PERL_PRESERVE_IVUV
7165 if (SvUVX(sv) == 0) {
7166 (void)SvIOK_only(sv);
7170 (void)SvIOK_only_UV(sv);
7171 SvUV_set(sv, SvUVX(sv) - 1);
7174 if (SvIVX(sv) == IV_MIN) {
7175 sv_setnv(sv, (NV)IV_MIN);
7179 (void)SvIOK_only(sv);
7180 SvIV_set(sv, SvIVX(sv) - 1);
7185 if (flags & SVp_NOK) {
7188 const NV was = SvNVX(sv);
7189 if (NV_OVERFLOWS_INTEGERS_AT &&
7190 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7191 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7192 "Lost precision when decrementing %" NVff " by 1",
7195 (void)SvNOK_only(sv);
7196 SvNV_set(sv, was - 1.0);
7200 if (!(flags & SVp_POK)) {
7201 if ((flags & SVTYPEMASK) < SVt_PVIV)
7202 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7204 (void)SvIOK_only(sv);
7207 #ifdef PERL_PRESERVE_IVUV
7209 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7210 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7211 /* Need to try really hard to see if it's an integer.
7212 9.22337203685478e+18 is an integer.
7213 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7214 so $a="9.22337203685478e+18"; $a+0; $a--
7215 needs to be the same as $a="9.22337203685478e+18"; $a--
7222 /* sv_2iv *should* have made this an NV */
7223 if (flags & SVp_NOK) {
7224 (void)SvNOK_only(sv);
7225 SvNV_set(sv, SvNVX(sv) - 1.0);
7228 /* I don't think we can get here. Maybe I should assert this
7229 And if we do get here I suspect that sv_setnv will croak. NWC
7231 #if defined(USE_LONG_DOUBLE)
7232 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",
7233 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7235 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7236 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7240 #endif /* PERL_PRESERVE_IVUV */
7241 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7245 =for apidoc sv_mortalcopy
7247 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7248 The new SV is marked as mortal. It will be destroyed "soon", either by an
7249 explicit call to FREETMPS, or by an implicit call at places such as
7250 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7255 /* Make a string that will exist for the duration of the expression
7256 * evaluation. Actually, it may have to last longer than that, but
7257 * hopefully we won't free it until it has been assigned to a
7258 * permanent location. */
7261 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7267 sv_setsv(sv,oldstr);
7269 PL_tmps_stack[++PL_tmps_ix] = sv;
7275 =for apidoc sv_newmortal
7277 Creates a new null SV which is mortal. The reference count of the SV is
7278 set to 1. It will be destroyed "soon", either by an explicit call to
7279 FREETMPS, or by an implicit call at places such as statement boundaries.
7280 See also C<sv_mortalcopy> and C<sv_2mortal>.
7286 Perl_sv_newmortal(pTHX)
7292 SvFLAGS(sv) = SVs_TEMP;
7294 PL_tmps_stack[++PL_tmps_ix] = sv;
7300 =for apidoc newSVpvn_flags
7302 Creates a new SV and copies a string into it. The reference count for the
7303 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7304 string. You are responsible for ensuring that the source string is at least
7305 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7306 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7307 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7308 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7309 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7311 #define newSVpvn_utf8(s, len, u) \
7312 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7318 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7323 /* All the flags we don't support must be zero.
7324 And we're new code so I'm going to assert this from the start. */
7325 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7327 sv_setpvn(sv,s,len);
7328 SvFLAGS(sv) |= (flags & SVf_UTF8);
7329 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7333 =for apidoc sv_2mortal
7335 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7336 by an explicit call to FREETMPS, or by an implicit call at places such as
7337 statement boundaries. SvTEMP() is turned on which means that the SV's
7338 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7339 and C<sv_mortalcopy>.
7345 Perl_sv_2mortal(pTHX_ register SV *const sv)
7350 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7353 PL_tmps_stack[++PL_tmps_ix] = sv;
7361 Creates a new SV and copies a string into it. The reference count for the
7362 SV is set to 1. If C<len> is zero, Perl will compute the length using
7363 strlen(). For efficiency, consider using C<newSVpvn> instead.
7369 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7375 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7380 =for apidoc newSVpvn
7382 Creates a new SV and copies a string into it. The reference count for the
7383 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7384 string. You are responsible for ensuring that the source string is at least
7385 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7391 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7397 sv_setpvn(sv,s,len);
7402 =for apidoc newSVhek
7404 Creates a new SV from the hash key structure. It will generate scalars that
7405 point to the shared string table where possible. Returns a new (undefined)
7406 SV if the hek is NULL.
7412 Perl_newSVhek(pTHX_ const HEK *const hek)
7422 if (HEK_LEN(hek) == HEf_SVKEY) {
7423 return newSVsv(*(SV**)HEK_KEY(hek));
7425 const int flags = HEK_FLAGS(hek);
7426 if (flags & HVhek_WASUTF8) {
7428 Andreas would like keys he put in as utf8 to come back as utf8
7430 STRLEN utf8_len = HEK_LEN(hek);
7431 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7432 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7435 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7437 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7438 /* We don't have a pointer to the hv, so we have to replicate the
7439 flag into every HEK. This hv is using custom a hasing
7440 algorithm. Hence we can't return a shared string scalar, as
7441 that would contain the (wrong) hash value, and might get passed
7442 into an hv routine with a regular hash.
7443 Similarly, a hash that isn't using shared hash keys has to have
7444 the flag in every key so that we know not to try to call
7445 share_hek_kek on it. */
7447 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7452 /* This will be overwhelminly the most common case. */
7454 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7455 more efficient than sharepvn(). */
7459 sv_upgrade(sv, SVt_PV);
7460 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7461 SvCUR_set(sv, HEK_LEN(hek));
7474 =for apidoc newSVpvn_share
7476 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7477 table. If the string does not already exist in the table, it is created
7478 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7479 value is used; otherwise the hash is computed. The string's hash can be later
7480 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7481 that as the string table is used for shared hash keys these strings will have
7482 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7488 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7492 bool is_utf8 = FALSE;
7493 const char *const orig_src = src;
7496 STRLEN tmplen = -len;
7498 /* See the note in hv.c:hv_fetch() --jhi */
7499 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7503 PERL_HASH(hash, src, len);
7505 sv_upgrade(sv, SVt_PV);
7506 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7514 if (src != orig_src)
7520 #if defined(PERL_IMPLICIT_CONTEXT)
7522 /* pTHX_ magic can't cope with varargs, so this is a no-context
7523 * version of the main function, (which may itself be aliased to us).
7524 * Don't access this version directly.
7528 Perl_newSVpvf_nocontext(const char *const pat, ...)
7534 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7536 va_start(args, pat);
7537 sv = vnewSVpvf(pat, &args);
7544 =for apidoc newSVpvf
7546 Creates a new SV and initializes it with the string formatted like
7553 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7558 PERL_ARGS_ASSERT_NEWSVPVF;
7560 va_start(args, pat);
7561 sv = vnewSVpvf(pat, &args);
7566 /* backend for newSVpvf() and newSVpvf_nocontext() */
7569 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7574 PERL_ARGS_ASSERT_VNEWSVPVF;
7577 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7584 Creates a new SV and copies a floating point value into it.
7585 The reference count for the SV is set to 1.
7591 Perl_newSVnv(pTHX_ const NV n)
7604 Creates a new SV and copies an integer into it. The reference count for the
7611 Perl_newSViv(pTHX_ const IV i)
7624 Creates a new SV and copies an unsigned integer into it.
7625 The reference count for the SV is set to 1.
7631 Perl_newSVuv(pTHX_ const UV u)
7642 =for apidoc newSV_type
7644 Creates a new SV, of the type specified. The reference count for the new SV
7651 Perl_newSV_type(pTHX_ const svtype type)
7656 sv_upgrade(sv, type);
7661 =for apidoc newRV_noinc
7663 Creates an RV wrapper for an SV. The reference count for the original
7664 SV is B<not> incremented.
7670 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7673 register SV *sv = newSV_type(SVt_IV);
7675 PERL_ARGS_ASSERT_NEWRV_NOINC;
7678 SvRV_set(sv, tmpRef);
7683 /* newRV_inc is the official function name to use now.
7684 * newRV_inc is in fact #defined to newRV in sv.h
7688 Perl_newRV(pTHX_ SV *const sv)
7692 PERL_ARGS_ASSERT_NEWRV;
7694 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7700 Creates a new SV which is an exact duplicate of the original SV.
7707 Perl_newSVsv(pTHX_ register SV *const old)
7714 if (SvTYPE(old) == SVTYPEMASK) {
7715 if (ckWARN_d(WARN_INTERNAL))
7716 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7720 /* SV_GMAGIC is the default for sv_setv()
7721 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7722 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7723 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7728 =for apidoc sv_reset
7730 Underlying implementation for the C<reset> Perl function.
7731 Note that the perl-level function is vaguely deprecated.
7737 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7740 char todo[PERL_UCHAR_MAX+1];
7742 PERL_ARGS_ASSERT_SV_RESET;
7747 if (!*s) { /* reset ?? searches */
7748 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7750 const U32 count = mg->mg_len / sizeof(PMOP**);
7751 PMOP **pmp = (PMOP**) mg->mg_ptr;
7752 PMOP *const *const end = pmp + count;
7756 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7758 (*pmp)->op_pmflags &= ~PMf_USED;
7766 /* reset variables */
7768 if (!HvARRAY(stash))
7771 Zero(todo, 256, char);
7774 I32 i = (unsigned char)*s;
7778 max = (unsigned char)*s++;
7779 for ( ; i <= max; i++) {
7782 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7784 for (entry = HvARRAY(stash)[i];
7786 entry = HeNEXT(entry))
7791 if (!todo[(U8)*HeKEY(entry)])
7793 gv = (GV*)HeVAL(entry);
7796 if (SvTHINKFIRST(sv)) {
7797 if (!SvREADONLY(sv) && SvROK(sv))
7799 /* XXX Is this continue a bug? Why should THINKFIRST
7800 exempt us from resetting arrays and hashes? */
7804 if (SvTYPE(sv) >= SVt_PV) {
7806 if (SvPVX_const(sv) != NULL)
7814 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7816 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7819 # if defined(USE_ENVIRON_ARRAY)
7822 # endif /* USE_ENVIRON_ARRAY */
7833 Using various gambits, try to get an IO from an SV: the IO slot if its a
7834 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7835 named after the PV if we're a string.
7841 Perl_sv_2io(pTHX_ SV *const sv)
7846 PERL_ARGS_ASSERT_SV_2IO;
7848 switch (SvTYPE(sv)) {
7853 if (isGV_with_GP(sv)) {
7857 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7863 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7865 return sv_2io(SvRV(sv));
7866 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7872 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7881 Using various gambits, try to get a CV from an SV; in addition, try if
7882 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7883 The flags in C<lref> are passed to sv_fetchsv.
7889 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7895 PERL_ARGS_ASSERT_SV_2CV;
7902 switch (SvTYPE(sv)) {
7913 if (isGV_with_GP(sv)) {
7923 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7925 tryAMAGICunDEREF(to_cv);
7928 if (SvTYPE(sv) == SVt_PVCV) {
7934 else if(isGV_with_GP(sv))
7937 Perl_croak(aTHX_ "Not a subroutine reference");
7939 else if (isGV_with_GP(sv)) {
7944 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7950 /* Some flags to gv_fetchsv mean don't really create the GV */
7951 if (!isGV_with_GP(gv)) {
7957 if (lref && !GvCVu(gv)) {
7961 gv_efullname3(tmpsv, gv, NULL);
7962 /* XXX this is probably not what they think they're getting.
7963 * It has the same effect as "sub name;", i.e. just a forward
7965 newSUB(start_subparse(FALSE, 0),
7966 newSVOP(OP_CONST, 0, tmpsv),
7970 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7971 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7980 Returns true if the SV has a true value by Perl's rules.
7981 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7982 instead use an in-line version.
7988 Perl_sv_true(pTHX_ register SV *const sv)
7993 register const XPV* const tXpv = (XPV*)SvANY(sv);
7995 (tXpv->xpv_cur > 1 ||
7996 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
8003 return SvIVX(sv) != 0;
8006 return SvNVX(sv) != 0.0;
8008 return sv_2bool(sv);
8014 =for apidoc sv_pvn_force
8016 Get a sensible string out of the SV somehow.
8017 A private implementation of the C<SvPV_force> macro for compilers which
8018 can't cope with complex macro expressions. Always use the macro instead.
8020 =for apidoc sv_pvn_force_flags
8022 Get a sensible string out of the SV somehow.
8023 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8024 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8025 implemented in terms of this function.
8026 You normally want to use the various wrapper macros instead: see
8027 C<SvPV_force> and C<SvPV_force_nomg>
8033 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8037 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8039 if (SvTHINKFIRST(sv) && !SvROK(sv))
8040 sv_force_normal_flags(sv, 0);
8050 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8051 const char * const ref = sv_reftype(sv,0);
8053 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8054 ref, OP_NAME(PL_op));
8056 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8058 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8059 || isGV_with_GP(sv))
8060 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8062 s = sv_2pv_flags(sv, &len, flags);
8066 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8069 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8070 SvGROW(sv, len + 1);
8071 Move(s,SvPVX(sv),len,char);
8073 SvPVX(sv)[len] = '\0';
8076 SvPOK_on(sv); /* validate pointer */
8078 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8079 PTR2UV(sv),SvPVX_const(sv)));
8082 return SvPVX_mutable(sv);
8086 =for apidoc sv_pvbyten_force
8088 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8094 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8096 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8098 sv_pvn_force(sv,lp);
8099 sv_utf8_downgrade(sv,0);
8105 =for apidoc sv_pvutf8n_force
8107 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8113 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8115 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8117 sv_pvn_force(sv,lp);
8118 sv_utf8_upgrade(sv);
8124 =for apidoc sv_reftype
8126 Returns a string describing what the SV is a reference to.
8132 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8134 PERL_ARGS_ASSERT_SV_REFTYPE;
8136 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8137 inside return suggests a const propagation bug in g++. */
8138 if (ob && SvOBJECT(sv)) {
8139 char * const name = HvNAME_get(SvSTASH(sv));
8140 return name ? name : (char *) "__ANON__";
8143 switch (SvTYPE(sv)) {
8158 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8159 /* tied lvalues should appear to be
8160 * scalars for backwards compatitbility */
8161 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8162 ? "SCALAR" : "LVALUE");
8163 case SVt_PVAV: return "ARRAY";
8164 case SVt_PVHV: return "HASH";
8165 case SVt_PVCV: return "CODE";
8166 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8167 ? "GLOB" : "SCALAR");
8168 case SVt_PVFM: return "FORMAT";
8169 case SVt_PVIO: return "IO";
8170 case SVt_BIND: return "BIND";
8171 case SVt_REGEXP: return "REGEXP";
8172 default: return "UNKNOWN";
8178 =for apidoc sv_isobject
8180 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8181 object. If the SV is not an RV, or if the object is not blessed, then this
8188 Perl_sv_isobject(pTHX_ SV *sv)
8204 Returns a boolean indicating whether the SV is blessed into the specified
8205 class. This does not check for subtypes; use C<sv_derived_from> to verify
8206 an inheritance relationship.
8212 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8216 PERL_ARGS_ASSERT_SV_ISA;
8226 hvname = HvNAME_get(SvSTASH(sv));
8230 return strEQ(hvname, name);
8236 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8237 it will be upgraded to one. If C<classname> is non-null then the new SV will
8238 be blessed in the specified package. The new SV is returned and its
8239 reference count is 1.
8245 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8250 PERL_ARGS_ASSERT_NEWSVRV;
8254 SV_CHECK_THINKFIRST_COW_DROP(rv);
8255 (void)SvAMAGIC_off(rv);
8257 if (SvTYPE(rv) >= SVt_PVMG) {
8258 const U32 refcnt = SvREFCNT(rv);
8262 SvREFCNT(rv) = refcnt;
8264 sv_upgrade(rv, SVt_IV);
8265 } else if (SvROK(rv)) {
8266 SvREFCNT_dec(SvRV(rv));
8268 prepare_SV_for_RV(rv);
8276 HV* const stash = gv_stashpv(classname, GV_ADD);
8277 (void)sv_bless(rv, stash);
8283 =for apidoc sv_setref_pv
8285 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8286 argument will be upgraded to an RV. That RV will be modified to point to
8287 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8288 into the SV. The C<classname> argument indicates the package for the
8289 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8290 will have a reference count of 1, and the RV will be returned.
8292 Do not use with other Perl types such as HV, AV, SV, CV, because those
8293 objects will become corrupted by the pointer copy process.
8295 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8301 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8305 PERL_ARGS_ASSERT_SV_SETREF_PV;
8308 sv_setsv(rv, &PL_sv_undef);
8312 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8317 =for apidoc sv_setref_iv
8319 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8320 argument will be upgraded to an RV. That RV will be modified to point to
8321 the new SV. The C<classname> argument indicates the package for the
8322 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8323 will have a reference count of 1, and the RV will be returned.
8329 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8331 PERL_ARGS_ASSERT_SV_SETREF_IV;
8333 sv_setiv(newSVrv(rv,classname), iv);
8338 =for apidoc sv_setref_uv
8340 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8341 argument will be upgraded to an RV. That RV will be modified to point to
8342 the new SV. The C<classname> argument indicates the package for the
8343 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8344 will have a reference count of 1, and the RV will be returned.
8350 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8352 PERL_ARGS_ASSERT_SV_SETREF_UV;
8354 sv_setuv(newSVrv(rv,classname), uv);
8359 =for apidoc sv_setref_nv
8361 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8362 argument will be upgraded to an RV. That RV will be modified to point to
8363 the new SV. The C<classname> argument indicates the package for the
8364 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8365 will have a reference count of 1, and the RV will be returned.
8371 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8373 PERL_ARGS_ASSERT_SV_SETREF_NV;
8375 sv_setnv(newSVrv(rv,classname), nv);
8380 =for apidoc sv_setref_pvn
8382 Copies a string into a new SV, optionally blessing the SV. The length of the
8383 string must be specified with C<n>. The C<rv> argument will be upgraded to
8384 an RV. That RV will be modified to point to the new SV. The C<classname>
8385 argument indicates the package for the blessing. Set C<classname> to
8386 C<NULL> to avoid the blessing. The new SV will have a reference count
8387 of 1, and the RV will be returned.
8389 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8395 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8396 const char *const pv, const STRLEN n)
8398 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8400 sv_setpvn(newSVrv(rv,classname), pv, n);
8405 =for apidoc sv_bless
8407 Blesses an SV into a specified package. The SV must be an RV. The package
8408 must be designated by its stash (see C<gv_stashpv()>). The reference count
8409 of the SV is unaffected.
8415 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8420 PERL_ARGS_ASSERT_SV_BLESS;
8423 Perl_croak(aTHX_ "Can't bless non-reference value");
8425 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8426 if (SvIsCOW(tmpRef))
8427 sv_force_normal_flags(tmpRef, 0);
8428 if (SvREADONLY(tmpRef))
8429 Perl_croak(aTHX_ PL_no_modify);
8430 if (SvOBJECT(tmpRef)) {
8431 if (SvTYPE(tmpRef) != SVt_PVIO)
8433 SvREFCNT_dec(SvSTASH(tmpRef));
8436 SvOBJECT_on(tmpRef);
8437 if (SvTYPE(tmpRef) != SVt_PVIO)
8439 SvUPGRADE(tmpRef, SVt_PVMG);
8440 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8445 (void)SvAMAGIC_off(sv);
8447 if(SvSMAGICAL(tmpRef))
8448 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8456 /* Downgrades a PVGV to a PVMG.
8460 S_sv_unglob(pTHX_ SV *const sv)
8465 SV * const temp = sv_newmortal();
8467 PERL_ARGS_ASSERT_SV_UNGLOB;
8469 assert(SvTYPE(sv) == SVt_PVGV);
8471 gv_efullname3(temp, (GV *) sv, "*");
8474 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8475 mro_method_changed_in(stash);
8479 sv_del_backref((SV*)GvSTASH(sv), sv);
8483 if (GvNAME_HEK(sv)) {
8484 unshare_hek(GvNAME_HEK(sv));
8486 isGV_with_GP_off(sv);
8488 /* need to keep SvANY(sv) in the right arena */
8489 xpvmg = new_XPVMG();
8490 StructCopy(SvANY(sv), xpvmg, XPVMG);
8491 del_XPVGV(SvANY(sv));
8494 SvFLAGS(sv) &= ~SVTYPEMASK;
8495 SvFLAGS(sv) |= SVt_PVMG;
8497 /* Intentionally not calling any local SET magic, as this isn't so much a
8498 set operation as merely an internal storage change. */
8499 sv_setsv_flags(sv, temp, 0);
8503 =for apidoc sv_unref_flags
8505 Unsets the RV status of the SV, and decrements the reference count of
8506 whatever was being referenced by the RV. This can almost be thought of
8507 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8508 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8509 (otherwise the decrementing is conditional on the reference count being
8510 different from one or the reference being a readonly SV).
8517 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8519 SV* const target = SvRV(ref);
8521 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8523 if (SvWEAKREF(ref)) {
8524 sv_del_backref(target, ref);
8526 SvRV_set(ref, NULL);
8529 SvRV_set(ref, NULL);
8531 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8532 assigned to as BEGIN {$a = \"Foo"} will fail. */
8533 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8534 SvREFCNT_dec(target);
8535 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8536 sv_2mortal(target); /* Schedule for freeing later */
8540 =for apidoc sv_untaint
8542 Untaint an SV. Use C<SvTAINTED_off> instead.
8547 Perl_sv_untaint(pTHX_ SV *const sv)
8549 PERL_ARGS_ASSERT_SV_UNTAINT;
8551 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8552 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8559 =for apidoc sv_tainted
8561 Test an SV for taintedness. Use C<SvTAINTED> instead.
8566 Perl_sv_tainted(pTHX_ SV *const sv)
8568 PERL_ARGS_ASSERT_SV_TAINTED;
8570 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8571 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8572 if (mg && (mg->mg_len & 1) )
8579 =for apidoc sv_setpviv
8581 Copies an integer into the given SV, also updating its string value.
8582 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8588 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8590 char buf[TYPE_CHARS(UV)];
8592 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8594 PERL_ARGS_ASSERT_SV_SETPVIV;
8596 sv_setpvn(sv, ptr, ebuf - ptr);
8600 =for apidoc sv_setpviv_mg
8602 Like C<sv_setpviv>, but also handles 'set' magic.
8608 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8610 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8616 #if defined(PERL_IMPLICIT_CONTEXT)
8618 /* pTHX_ magic can't cope with varargs, so this is a no-context
8619 * version of the main function, (which may itself be aliased to us).
8620 * Don't access this version directly.
8624 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8629 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8631 va_start(args, pat);
8632 sv_vsetpvf(sv, pat, &args);
8636 /* pTHX_ magic can't cope with varargs, so this is a no-context
8637 * version of the main function, (which may itself be aliased to us).
8638 * Don't access this version directly.
8642 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8647 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8649 va_start(args, pat);
8650 sv_vsetpvf_mg(sv, pat, &args);
8656 =for apidoc sv_setpvf
8658 Works like C<sv_catpvf> but copies the text into the SV instead of
8659 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8665 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8669 PERL_ARGS_ASSERT_SV_SETPVF;
8671 va_start(args, pat);
8672 sv_vsetpvf(sv, pat, &args);
8677 =for apidoc sv_vsetpvf
8679 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8680 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8682 Usually used via its frontend C<sv_setpvf>.
8688 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8690 PERL_ARGS_ASSERT_SV_VSETPVF;
8692 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8696 =for apidoc sv_setpvf_mg
8698 Like C<sv_setpvf>, but also handles 'set' magic.
8704 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8708 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8710 va_start(args, pat);
8711 sv_vsetpvf_mg(sv, pat, &args);
8716 =for apidoc sv_vsetpvf_mg
8718 Like C<sv_vsetpvf>, but also handles 'set' magic.
8720 Usually used via its frontend C<sv_setpvf_mg>.
8726 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8728 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8730 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8734 #if defined(PERL_IMPLICIT_CONTEXT)
8736 /* pTHX_ magic can't cope with varargs, so this is a no-context
8737 * version of the main function, (which may itself be aliased to us).
8738 * Don't access this version directly.
8742 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8747 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8749 va_start(args, pat);
8750 sv_vcatpvf(sv, pat, &args);
8754 /* pTHX_ magic can't cope with varargs, so this is a no-context
8755 * version of the main function, (which may itself be aliased to us).
8756 * Don't access this version directly.
8760 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8765 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8767 va_start(args, pat);
8768 sv_vcatpvf_mg(sv, pat, &args);
8774 =for apidoc sv_catpvf
8776 Processes its arguments like C<sprintf> and appends the formatted
8777 output to an SV. If the appended data contains "wide" characters
8778 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8779 and characters >255 formatted with %c), the original SV might get
8780 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8781 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8782 valid UTF-8; if the original SV was bytes, the pattern should be too.
8787 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8791 PERL_ARGS_ASSERT_SV_CATPVF;
8793 va_start(args, pat);
8794 sv_vcatpvf(sv, pat, &args);
8799 =for apidoc sv_vcatpvf
8801 Processes its arguments like C<vsprintf> and appends the formatted output
8802 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8804 Usually used via its frontend C<sv_catpvf>.
8810 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8812 PERL_ARGS_ASSERT_SV_VCATPVF;
8814 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8818 =for apidoc sv_catpvf_mg
8820 Like C<sv_catpvf>, but also handles 'set' magic.
8826 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8830 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8832 va_start(args, pat);
8833 sv_vcatpvf_mg(sv, pat, &args);
8838 =for apidoc sv_vcatpvf_mg
8840 Like C<sv_vcatpvf>, but also handles 'set' magic.
8842 Usually used via its frontend C<sv_catpvf_mg>.
8848 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8850 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8852 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8857 =for apidoc sv_vsetpvfn
8859 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8862 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8868 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8869 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8871 PERL_ARGS_ASSERT_SV_VSETPVFN;
8873 sv_setpvn(sv, "", 0);
8874 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8878 S_expect_number(pTHX_ char **const pattern)
8883 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8885 switch (**pattern) {
8886 case '1': case '2': case '3':
8887 case '4': case '5': case '6':
8888 case '7': case '8': case '9':
8889 var = *(*pattern)++ - '0';
8890 while (isDIGIT(**pattern)) {
8891 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8893 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8901 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8903 const int neg = nv < 0;
8906 PERL_ARGS_ASSERT_F0CONVERT;
8914 if (uv & 1 && uv == nv)
8915 uv--; /* Round to even */
8917 const unsigned dig = uv % 10;
8930 =for apidoc sv_vcatpvfn
8932 Processes its arguments like C<vsprintf> and appends the formatted output
8933 to an SV. Uses an array of SVs if the C style variable argument list is
8934 missing (NULL). When running with taint checks enabled, indicates via
8935 C<maybe_tainted> if results are untrustworthy (often due to the use of
8938 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8944 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8945 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8946 vec_utf8 = DO_UTF8(vecsv);
8948 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8951 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8952 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8960 static const char nullstr[] = "(null)";
8962 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8963 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8965 /* Times 4: a decimal digit takes more than 3 binary digits.
8966 * NV_DIG: mantissa takes than many decimal digits.
8967 * Plus 32: Playing safe. */
8968 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8969 /* large enough for "%#.#f" --chip */
8970 /* what about long double NVs? --jhi */
8972 PERL_ARGS_ASSERT_SV_VCATPVFN;
8973 PERL_UNUSED_ARG(maybe_tainted);
8975 /* no matter what, this is a string now */
8976 (void)SvPV_force(sv, origlen);
8978 /* special-case "", "%s", and "%-p" (SVf - see below) */
8981 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8983 const char * const s = va_arg(*args, char*);
8984 sv_catpv(sv, s ? s : nullstr);
8986 else if (svix < svmax) {
8987 sv_catsv(sv, *svargs);
8991 if (args && patlen == 3 && pat[0] == '%' &&
8992 pat[1] == '-' && pat[2] == 'p') {
8993 argsv = (SV*)va_arg(*args, void*);
8994 sv_catsv(sv, argsv);
8998 #ifndef USE_LONG_DOUBLE
8999 /* special-case "%.<number>[gf]" */
9000 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9001 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9002 unsigned digits = 0;
9006 while (*pp >= '0' && *pp <= '9')
9007 digits = 10 * digits + (*pp++ - '0');
9008 if (pp - pat == (int)patlen - 1) {
9016 /* Add check for digits != 0 because it seems that some
9017 gconverts are buggy in this case, and we don't yet have
9018 a Configure test for this. */
9019 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9020 /* 0, point, slack */
9021 Gconvert(nv, (int)digits, 0, ebuf);
9023 if (*ebuf) /* May return an empty string for digits==0 */
9026 } else if (!digits) {
9029 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9030 sv_catpvn(sv, p, l);
9036 #endif /* !USE_LONG_DOUBLE */
9038 if (!args && svix < svmax && DO_UTF8(*svargs))
9041 patend = (char*)pat + patlen;
9042 for (p = (char*)pat; p < patend; p = q) {
9045 bool vectorize = FALSE;
9046 bool vectorarg = FALSE;
9047 bool vec_utf8 = FALSE;
9053 bool has_precis = FALSE;
9055 const I32 osvix = svix;
9056 bool is_utf8 = FALSE; /* is this item utf8? */
9057 #ifdef HAS_LDBL_SPRINTF_BUG
9058 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9059 with sfio - Allen <allens@cpan.org> */
9060 bool fix_ldbl_sprintf_bug = FALSE;
9064 U8 utf8buf[UTF8_MAXBYTES+1];
9065 STRLEN esignlen = 0;
9067 const char *eptr = NULL;
9070 const U8 *vecstr = NULL;
9077 /* we need a long double target in case HAS_LONG_DOUBLE but
9080 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9088 const char *dotstr = ".";
9089 STRLEN dotstrlen = 1;
9090 I32 efix = 0; /* explicit format parameter index */
9091 I32 ewix = 0; /* explicit width index */
9092 I32 epix = 0; /* explicit precision index */
9093 I32 evix = 0; /* explicit vector index */
9094 bool asterisk = FALSE;
9096 /* echo everything up to the next format specification */
9097 for (q = p; q < patend && *q != '%'; ++q) ;
9099 if (has_utf8 && !pat_utf8)
9100 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9102 sv_catpvn(sv, p, q - p);
9109 We allow format specification elements in this order:
9110 \d+\$ explicit format parameter index
9112 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9113 0 flag (as above): repeated to allow "v02"
9114 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9115 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9117 [%bcdefginopsuxDFOUX] format (mandatory)
9122 As of perl5.9.3, printf format checking is on by default.
9123 Internally, perl uses %p formats to provide an escape to
9124 some extended formatting. This block deals with those
9125 extensions: if it does not match, (char*)q is reset and
9126 the normal format processing code is used.
9128 Currently defined extensions are:
9129 %p include pointer address (standard)
9130 %-p (SVf) include an SV (previously %_)
9131 %-<num>p include an SV with precision <num>
9132 %<num>p reserved for future extensions
9134 Robin Barker 2005-07-14
9136 %1p (VDf) removed. RMB 2007-10-19
9143 n = expect_number(&q);
9150 argsv = (SV*)va_arg(*args, void*);
9151 eptr = SvPV_const(argsv, elen);
9157 if (ckWARN_d(WARN_INTERNAL))
9158 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9159 "internal %%<num>p might conflict with future printf extensions");
9165 if ( (width = expect_number(&q)) ) {
9180 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9209 if ( (ewix = expect_number(&q)) )
9218 if ((vectorarg = asterisk)) {
9231 width = expect_number(&q);
9237 vecsv = va_arg(*args, SV*);
9239 vecsv = (evix > 0 && evix <= svmax)
9240 ? svargs[evix-1] : &PL_sv_undef;
9242 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9244 dotstr = SvPV_const(vecsv, dotstrlen);
9245 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9246 bad with tied or overloaded values that return UTF8. */
9249 else if (has_utf8) {
9250 vecsv = sv_mortalcopy(vecsv);
9251 sv_utf8_upgrade(vecsv);
9252 dotstr = SvPV_const(vecsv, dotstrlen);
9259 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9260 vecsv = svargs[efix ? efix-1 : svix++];
9261 vecstr = (U8*)SvPV_const(vecsv,veclen);
9262 vec_utf8 = DO_UTF8(vecsv);
9264 /* if this is a version object, we need to convert
9265 * back into v-string notation and then let the
9266 * vectorize happen normally
9268 if (sv_derived_from(vecsv, "version")) {
9269 char *version = savesvpv(vecsv);
9270 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9271 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9272 "vector argument not supported with alpha versions");
9275 vecsv = sv_newmortal();
9276 scan_vstring(version, version + veclen, vecsv);
9277 vecstr = (U8*)SvPV_const(vecsv, veclen);
9278 vec_utf8 = DO_UTF8(vecsv);
9290 i = va_arg(*args, int);
9292 i = (ewix ? ewix <= svmax : svix < svmax) ?
9293 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9295 width = (i < 0) ? -i : i;
9305 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9307 /* XXX: todo, support specified precision parameter */
9311 i = va_arg(*args, int);
9313 i = (ewix ? ewix <= svmax : svix < svmax)
9314 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9316 has_precis = !(i < 0);
9321 precis = precis * 10 + (*q++ - '0');
9330 case 'I': /* Ix, I32x, and I64x */
9332 if (q[1] == '6' && q[2] == '4') {
9338 if (q[1] == '3' && q[2] == '2') {
9348 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9359 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9360 if (*(q + 1) == 'l') { /* lld, llf */
9386 if (!vectorize && !args) {
9388 const I32 i = efix-1;
9389 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9391 argsv = (svix >= 0 && svix < svmax)
9392 ? svargs[svix++] : &PL_sv_undef;
9403 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9405 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9407 eptr = (char*)utf8buf;
9408 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9422 eptr = va_arg(*args, char*);
9424 #ifdef MACOS_TRADITIONAL
9425 /* On MacOS, %#s format is used for Pascal strings */
9430 elen = strlen(eptr);
9432 eptr = (char *)nullstr;
9433 elen = sizeof nullstr - 1;
9437 eptr = SvPV_const(argsv, elen);
9438 if (DO_UTF8(argsv)) {
9439 I32 old_precis = precis;
9440 if (has_precis && precis < elen) {
9442 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9445 if (width) { /* fudge width (can't fudge elen) */
9446 if (has_precis && precis < elen)
9447 width += precis - old_precis;
9449 width += elen - sv_len_utf8(argsv);
9456 if (has_precis && elen > precis)
9463 if (alt || vectorize)
9465 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9486 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9495 esignbuf[esignlen++] = plus;
9499 case 'h': iv = (short)va_arg(*args, int); break;
9500 case 'l': iv = va_arg(*args, long); break;
9501 case 'V': iv = va_arg(*args, IV); break;
9502 default: iv = va_arg(*args, int); break;
9504 case 'q': iv = va_arg(*args, Quad_t); break;
9509 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9511 case 'h': iv = (short)tiv; break;
9512 case 'l': iv = (long)tiv; break;
9514 default: iv = tiv; break;
9516 case 'q': iv = (Quad_t)tiv; break;
9520 if ( !vectorize ) /* we already set uv above */
9525 esignbuf[esignlen++] = plus;
9529 esignbuf[esignlen++] = '-';
9573 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9584 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9585 case 'l': uv = va_arg(*args, unsigned long); break;
9586 case 'V': uv = va_arg(*args, UV); break;
9587 default: uv = va_arg(*args, unsigned); break;
9589 case 'q': uv = va_arg(*args, Uquad_t); break;
9594 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9596 case 'h': uv = (unsigned short)tuv; break;
9597 case 'l': uv = (unsigned long)tuv; break;
9599 default: uv = tuv; break;
9601 case 'q': uv = (Uquad_t)tuv; break;
9608 char *ptr = ebuf + sizeof ebuf;
9609 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9615 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9621 esignbuf[esignlen++] = '0';
9622 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9630 if (alt && *ptr != '0')
9639 esignbuf[esignlen++] = '0';
9640 esignbuf[esignlen++] = c;
9643 default: /* it had better be ten or less */
9647 } while (uv /= base);
9650 elen = (ebuf + sizeof ebuf) - ptr;
9654 zeros = precis - elen;
9655 else if (precis == 0 && elen == 1 && *eptr == '0'
9656 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9659 /* a precision nullifies the 0 flag. */
9666 /* FLOATING POINT */
9669 c = 'f'; /* maybe %F isn't supported here */
9677 /* This is evil, but floating point is even more evil */
9679 /* for SV-style calling, we can only get NV
9680 for C-style calling, we assume %f is double;
9681 for simplicity we allow any of %Lf, %llf, %qf for long double
9685 #if defined(USE_LONG_DOUBLE)
9689 /* [perl #20339] - we should accept and ignore %lf rather than die */
9693 #if defined(USE_LONG_DOUBLE)
9694 intsize = args ? 0 : 'q';
9698 #if defined(HAS_LONG_DOUBLE)
9707 /* now we need (long double) if intsize == 'q', else (double) */
9709 #if LONG_DOUBLESIZE > DOUBLESIZE
9711 va_arg(*args, long double) :
9712 va_arg(*args, double)
9714 va_arg(*args, double)
9719 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9720 else. frexp() has some unspecified behaviour for those three */
9721 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9723 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9724 will cast our (long double) to (double) */
9725 (void)Perl_frexp(nv, &i);
9726 if (i == PERL_INT_MIN)
9727 Perl_die(aTHX_ "panic: frexp");
9729 need = BIT_DIGITS(i);
9731 need += has_precis ? precis : 6; /* known default */
9736 #ifdef HAS_LDBL_SPRINTF_BUG
9737 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9738 with sfio - Allen <allens@cpan.org> */
9741 # define MY_DBL_MAX DBL_MAX
9742 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9743 # if DOUBLESIZE >= 8
9744 # define MY_DBL_MAX 1.7976931348623157E+308L
9746 # define MY_DBL_MAX 3.40282347E+38L
9750 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9751 # define MY_DBL_MAX_BUG 1L
9753 # define MY_DBL_MAX_BUG MY_DBL_MAX
9757 # define MY_DBL_MIN DBL_MIN
9758 # else /* XXX guessing! -Allen */
9759 # if DOUBLESIZE >= 8
9760 # define MY_DBL_MIN 2.2250738585072014E-308L
9762 # define MY_DBL_MIN 1.17549435E-38L
9766 if ((intsize == 'q') && (c == 'f') &&
9767 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9769 /* it's going to be short enough that
9770 * long double precision is not needed */
9772 if ((nv <= 0L) && (nv >= -0L))
9773 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9775 /* would use Perl_fp_class as a double-check but not
9776 * functional on IRIX - see perl.h comments */
9778 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9779 /* It's within the range that a double can represent */
9780 #if defined(DBL_MAX) && !defined(DBL_MIN)
9781 if ((nv >= ((long double)1/DBL_MAX)) ||
9782 (nv <= (-(long double)1/DBL_MAX)))
9784 fix_ldbl_sprintf_bug = TRUE;
9787 if (fix_ldbl_sprintf_bug == TRUE) {
9797 # undef MY_DBL_MAX_BUG
9800 #endif /* HAS_LDBL_SPRINTF_BUG */
9802 need += 20; /* fudge factor */
9803 if (PL_efloatsize < need) {
9804 Safefree(PL_efloatbuf);
9805 PL_efloatsize = need + 20; /* more fudge */
9806 Newx(PL_efloatbuf, PL_efloatsize, char);
9807 PL_efloatbuf[0] = '\0';
9810 if ( !(width || left || plus || alt) && fill != '0'
9811 && has_precis && intsize != 'q' ) { /* Shortcuts */
9812 /* See earlier comment about buggy Gconvert when digits,
9814 if ( c == 'g' && precis) {
9815 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9816 /* May return an empty string for digits==0 */
9817 if (*PL_efloatbuf) {
9818 elen = strlen(PL_efloatbuf);
9819 goto float_converted;
9821 } else if ( c == 'f' && !precis) {
9822 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9827 char *ptr = ebuf + sizeof ebuf;
9830 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9831 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9832 if (intsize == 'q') {
9833 /* Copy the one or more characters in a long double
9834 * format before the 'base' ([efgEFG]) character to
9835 * the format string. */
9836 static char const prifldbl[] = PERL_PRIfldbl;
9837 char const *p = prifldbl + sizeof(prifldbl) - 3;
9838 while (p >= prifldbl) { *--ptr = *p--; }
9843 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9848 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9860 /* No taint. Otherwise we are in the strange situation
9861 * where printf() taints but print($float) doesn't.
9863 #if defined(HAS_LONG_DOUBLE)
9864 elen = ((intsize == 'q')
9865 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9866 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9868 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9872 eptr = PL_efloatbuf;
9880 i = SvCUR(sv) - origlen;
9883 case 'h': *(va_arg(*args, short*)) = i; break;
9884 default: *(va_arg(*args, int*)) = i; break;
9885 case 'l': *(va_arg(*args, long*)) = i; break;
9886 case 'V': *(va_arg(*args, IV*)) = i; break;
9888 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9893 sv_setuv_mg(argsv, (UV)i);
9894 continue; /* not "break" */
9901 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9902 && ckWARN(WARN_PRINTF))
9904 SV * const msg = sv_newmortal();
9905 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9906 (PL_op->op_type == OP_PRTF) ? "" : "s");
9909 Perl_sv_catpvf(aTHX_ msg,
9910 "\"%%%c\"", c & 0xFF);
9912 Perl_sv_catpvf(aTHX_ msg,
9913 "\"%%\\%03"UVof"\"",
9916 sv_catpvs(msg, "end of string");
9917 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9920 /* output mangled stuff ... */
9926 /* ... right here, because formatting flags should not apply */
9927 SvGROW(sv, SvCUR(sv) + elen + 1);
9929 Copy(eptr, p, elen, char);
9932 SvCUR_set(sv, p - SvPVX_const(sv));
9934 continue; /* not "break" */
9937 if (is_utf8 != has_utf8) {
9940 sv_utf8_upgrade(sv);
9943 const STRLEN old_elen = elen;
9944 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9945 sv_utf8_upgrade(nsv);
9946 eptr = SvPVX_const(nsv);
9949 if (width) { /* fudge width (can't fudge elen) */
9950 width += elen - old_elen;
9956 have = esignlen + zeros + elen;
9958 Perl_croak_nocontext(PL_memory_wrap);
9960 need = (have > width ? have : width);
9963 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9964 Perl_croak_nocontext(PL_memory_wrap);
9965 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9967 if (esignlen && fill == '0') {
9969 for (i = 0; i < (int)esignlen; i++)
9973 memset(p, fill, gap);
9976 if (esignlen && fill != '0') {
9978 for (i = 0; i < (int)esignlen; i++)
9983 for (i = zeros; i; i--)
9987 Copy(eptr, p, elen, char);
9991 memset(p, ' ', gap);
9996 Copy(dotstr, p, dotstrlen, char);
10000 vectorize = FALSE; /* done iterating over vecstr */
10007 SvCUR_set(sv, p - SvPVX_const(sv));
10015 /* =========================================================================
10017 =head1 Cloning an interpreter
10019 All the macros and functions in this section are for the private use of
10020 the main function, perl_clone().
10022 The foo_dup() functions make an exact copy of an existing foo thingy.
10023 During the course of a cloning, a hash table is used to map old addresses
10024 to new addresses. The table is created and manipulated with the
10025 ptr_table_* functions.
10029 ============================================================================*/
10032 #if defined(USE_ITHREADS)
10034 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10035 #ifndef GpREFCNT_inc
10036 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10040 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10041 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10042 If this changes, please unmerge ss_dup. */
10043 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10044 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10045 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10046 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10047 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10048 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10049 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10050 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10051 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10052 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10053 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10054 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10055 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10056 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10058 /* clone a parser */
10061 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10065 PERL_ARGS_ASSERT_PARSER_DUP;
10070 /* look for it in the table first */
10071 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10075 /* create anew and remember what it is */
10076 Newxz(parser, 1, yy_parser);
10077 ptr_table_store(PL_ptr_table, proto, parser);
10079 parser->yyerrstatus = 0;
10080 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10082 /* XXX these not yet duped */
10083 parser->old_parser = NULL;
10084 parser->stack = NULL;
10086 parser->stack_size = 0;
10087 /* XXX parser->stack->state = 0; */
10089 /* XXX eventually, just Copy() most of the parser struct ? */
10091 parser->lex_brackets = proto->lex_brackets;
10092 parser->lex_casemods = proto->lex_casemods;
10093 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10094 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10095 parser->lex_casestack = savepvn(proto->lex_casestack,
10096 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10097 parser->lex_defer = proto->lex_defer;
10098 parser->lex_dojoin = proto->lex_dojoin;
10099 parser->lex_expect = proto->lex_expect;
10100 parser->lex_formbrack = proto->lex_formbrack;
10101 parser->lex_inpat = proto->lex_inpat;
10102 parser->lex_inwhat = proto->lex_inwhat;
10103 parser->lex_op = proto->lex_op;
10104 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10105 parser->lex_starts = proto->lex_starts;
10106 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10107 parser->multi_close = proto->multi_close;
10108 parser->multi_open = proto->multi_open;
10109 parser->multi_start = proto->multi_start;
10110 parser->multi_end = proto->multi_end;
10111 parser->pending_ident = proto->pending_ident;
10112 parser->preambled = proto->preambled;
10113 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10114 parser->linestr = sv_dup_inc(proto->linestr, param);
10115 parser->expect = proto->expect;
10116 parser->copline = proto->copline;
10117 parser->last_lop_op = proto->last_lop_op;
10118 parser->lex_state = proto->lex_state;
10119 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10120 /* rsfp_filters entries have fake IoDIRP() */
10121 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10122 parser->in_my = proto->in_my;
10123 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10124 parser->error_count = proto->error_count;
10127 parser->linestr = sv_dup_inc(proto->linestr, param);
10130 char * const ols = SvPVX(proto->linestr);
10131 char * const ls = SvPVX(parser->linestr);
10133 parser->bufptr = ls + (proto->bufptr >= ols ?
10134 proto->bufptr - ols : 0);
10135 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10136 proto->oldbufptr - ols : 0);
10137 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10138 proto->oldoldbufptr - ols : 0);
10139 parser->linestart = ls + (proto->linestart >= ols ?
10140 proto->linestart - ols : 0);
10141 parser->last_uni = ls + (proto->last_uni >= ols ?
10142 proto->last_uni - ols : 0);
10143 parser->last_lop = ls + (proto->last_lop >= ols ?
10144 proto->last_lop - ols : 0);
10146 parser->bufend = ls + SvCUR(parser->linestr);
10149 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10153 parser->endwhite = proto->endwhite;
10154 parser->faketokens = proto->faketokens;
10155 parser->lasttoke = proto->lasttoke;
10156 parser->nextwhite = proto->nextwhite;
10157 parser->realtokenstart = proto->realtokenstart;
10158 parser->skipwhite = proto->skipwhite;
10159 parser->thisclose = proto->thisclose;
10160 parser->thismad = proto->thismad;
10161 parser->thisopen = proto->thisopen;
10162 parser->thisstuff = proto->thisstuff;
10163 parser->thistoken = proto->thistoken;
10164 parser->thiswhite = proto->thiswhite;
10166 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10167 parser->curforce = proto->curforce;
10169 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10170 Copy(proto->nexttype, parser->nexttype, 5, I32);
10171 parser->nexttoke = proto->nexttoke;
10177 /* duplicate a file handle */
10180 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10184 PERL_ARGS_ASSERT_FP_DUP;
10185 PERL_UNUSED_ARG(type);
10188 return (PerlIO*)NULL;
10190 /* look for it in the table first */
10191 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10195 /* create anew and remember what it is */
10196 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10197 ptr_table_store(PL_ptr_table, fp, ret);
10201 /* duplicate a directory handle */
10204 Perl_dirp_dup(pTHX_ DIR *const dp)
10206 PERL_UNUSED_CONTEXT;
10213 /* duplicate a typeglob */
10216 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10220 PERL_ARGS_ASSERT_GP_DUP;
10224 /* look for it in the table first */
10225 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10229 /* create anew and remember what it is */
10231 ptr_table_store(PL_ptr_table, gp, ret);
10234 ret->gp_refcnt = 0; /* must be before any other dups! */
10235 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10236 ret->gp_io = io_dup_inc(gp->gp_io, param);
10237 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10238 ret->gp_av = av_dup_inc(gp->gp_av, param);
10239 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10240 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10241 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10242 ret->gp_cvgen = gp->gp_cvgen;
10243 ret->gp_line = gp->gp_line;
10244 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10248 /* duplicate a chain of magic */
10251 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10253 MAGIC *mgprev = (MAGIC*)NULL;
10256 PERL_ARGS_ASSERT_MG_DUP;
10259 return (MAGIC*)NULL;
10260 /* look for it in the table first */
10261 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10265 for (; mg; mg = mg->mg_moremagic) {
10267 Newxz(nmg, 1, MAGIC);
10269 mgprev->mg_moremagic = nmg;
10272 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10273 nmg->mg_private = mg->mg_private;
10274 nmg->mg_type = mg->mg_type;
10275 nmg->mg_flags = mg->mg_flags;
10276 /* FIXME for plugins
10277 if (mg->mg_type == PERL_MAGIC_qr) {
10278 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10282 if(mg->mg_type == PERL_MAGIC_backref) {
10283 /* The backref AV has its reference count deliberately bumped by
10285 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10288 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10289 ? sv_dup_inc(mg->mg_obj, param)
10290 : sv_dup(mg->mg_obj, param);
10292 nmg->mg_len = mg->mg_len;
10293 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10294 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10295 if (mg->mg_len > 0) {
10296 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10297 if (mg->mg_type == PERL_MAGIC_overload_table &&
10298 AMT_AMAGIC((AMT*)mg->mg_ptr))
10300 const AMT * const amtp = (AMT*)mg->mg_ptr;
10301 AMT * const namtp = (AMT*)nmg->mg_ptr;
10303 for (i = 1; i < NofAMmeth; i++) {
10304 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10308 else if (mg->mg_len == HEf_SVKEY)
10309 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10311 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10312 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10319 #endif /* USE_ITHREADS */
10321 /* create a new pointer-mapping table */
10324 Perl_ptr_table_new(pTHX)
10327 PERL_UNUSED_CONTEXT;
10329 Newxz(tbl, 1, PTR_TBL_t);
10330 tbl->tbl_max = 511;
10331 tbl->tbl_items = 0;
10332 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10336 #define PTR_TABLE_HASH(ptr) \
10337 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10340 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10341 following define) and at call to new_body_inline made below in
10342 Perl_ptr_table_store()
10345 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10347 /* map an existing pointer using a table */
10349 STATIC PTR_TBL_ENT_t *
10350 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10352 PTR_TBL_ENT_t *tblent;
10353 const UV hash = PTR_TABLE_HASH(sv);
10355 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10357 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10358 for (; tblent; tblent = tblent->next) {
10359 if (tblent->oldval == sv)
10366 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10368 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10370 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10371 PERL_UNUSED_CONTEXT;
10373 return tblent ? tblent->newval : NULL;
10376 /* add a new entry to a pointer-mapping table */
10379 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10381 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10383 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10384 PERL_UNUSED_CONTEXT;
10387 tblent->newval = newsv;
10389 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10391 new_body_inline(tblent, PTE_SVSLOT);
10393 tblent->oldval = oldsv;
10394 tblent->newval = newsv;
10395 tblent->next = tbl->tbl_ary[entry];
10396 tbl->tbl_ary[entry] = tblent;
10398 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10399 ptr_table_split(tbl);
10403 /* double the hash bucket size of an existing ptr table */
10406 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10408 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10409 const UV oldsize = tbl->tbl_max + 1;
10410 UV newsize = oldsize * 2;
10413 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10414 PERL_UNUSED_CONTEXT;
10416 Renew(ary, newsize, PTR_TBL_ENT_t*);
10417 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10418 tbl->tbl_max = --newsize;
10419 tbl->tbl_ary = ary;
10420 for (i=0; i < oldsize; i++, ary++) {
10421 PTR_TBL_ENT_t **curentp, **entp, *ent;
10424 curentp = ary + oldsize;
10425 for (entp = ary, ent = *ary; ent; ent = *entp) {
10426 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10428 ent->next = *curentp;
10438 /* remove all the entries from a ptr table */
10441 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10443 if (tbl && tbl->tbl_items) {
10444 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10445 UV riter = tbl->tbl_max;
10448 PTR_TBL_ENT_t *entry = array[riter];
10451 PTR_TBL_ENT_t * const oentry = entry;
10452 entry = entry->next;
10457 tbl->tbl_items = 0;
10461 /* clear and free a ptr table */
10464 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10469 ptr_table_clear(tbl);
10470 Safefree(tbl->tbl_ary);
10474 #if defined(USE_ITHREADS)
10477 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10479 PERL_ARGS_ASSERT_RVPV_DUP;
10482 SvRV_set(dstr, SvWEAKREF(sstr)
10483 ? sv_dup(SvRV(sstr), param)
10484 : sv_dup_inc(SvRV(sstr), param));
10487 else if (SvPVX_const(sstr)) {
10488 /* Has something there */
10490 /* Normal PV - clone whole allocated space */
10491 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10492 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10493 /* Not that normal - actually sstr is copy on write.
10494 But we are a true, independant SV, so: */
10495 SvREADONLY_off(dstr);
10500 /* Special case - not normally malloced for some reason */
10501 if (isGV_with_GP(sstr)) {
10502 /* Don't need to do anything here. */
10504 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10505 /* A "shared" PV - clone it as "shared" PV */
10507 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10511 /* Some other special case - random pointer */
10512 SvPV_set(dstr, SvPVX(sstr));
10517 /* Copy the NULL */
10518 SvPV_set(dstr, NULL);
10522 /* duplicate an SV of any type (including AV, HV etc) */
10525 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10530 PERL_ARGS_ASSERT_SV_DUP;
10534 if (SvTYPE(sstr) == SVTYPEMASK) {
10535 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10540 /* look for it in the table first */
10541 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10545 if(param->flags & CLONEf_JOIN_IN) {
10546 /** We are joining here so we don't want do clone
10547 something that is bad **/
10548 if (SvTYPE(sstr) == SVt_PVHV) {
10549 const HEK * const hvname = HvNAME_HEK(sstr);
10551 /** don't clone stashes if they already exist **/
10552 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10556 /* create anew and remember what it is */
10559 #ifdef DEBUG_LEAKING_SCALARS
10560 dstr->sv_debug_optype = sstr->sv_debug_optype;
10561 dstr->sv_debug_line = sstr->sv_debug_line;
10562 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10563 dstr->sv_debug_cloned = 1;
10564 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10567 ptr_table_store(PL_ptr_table, sstr, dstr);
10570 SvFLAGS(dstr) = SvFLAGS(sstr);
10571 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10572 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10575 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10576 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10577 (void*)PL_watch_pvx, SvPVX_const(sstr));
10580 /* don't clone objects whose class has asked us not to */
10581 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10586 switch (SvTYPE(sstr)) {
10588 SvANY(dstr) = NULL;
10591 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10593 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10595 SvIV_set(dstr, SvIVX(sstr));
10599 SvANY(dstr) = new_XNV();
10600 SvNV_set(dstr, SvNVX(sstr));
10602 /* case SVt_BIND: */
10605 /* These are all the types that need complex bodies allocating. */
10607 const svtype sv_type = SvTYPE(sstr);
10608 const struct body_details *const sv_type_details
10609 = bodies_by_type + sv_type;
10613 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10617 if (GvUNIQUE((GV*)sstr)) {
10618 NOOP; /* Do sharing here, and fall through */
10631 assert(sv_type_details->body_size);
10632 if (sv_type_details->arena) {
10633 new_body_inline(new_body, sv_type);
10635 = (void*)((char*)new_body - sv_type_details->offset);
10637 new_body = new_NOARENA(sv_type_details);
10641 SvANY(dstr) = new_body;
10644 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10645 ((char*)SvANY(dstr)) + sv_type_details->offset,
10646 sv_type_details->copy, char);
10648 Copy(((char*)SvANY(sstr)),
10649 ((char*)SvANY(dstr)),
10650 sv_type_details->body_size + sv_type_details->offset, char);
10653 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10654 && !isGV_with_GP(dstr))
10655 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10657 /* The Copy above means that all the source (unduplicated) pointers
10658 are now in the destination. We can check the flags and the
10659 pointers in either, but it's possible that there's less cache
10660 missing by always going for the destination.
10661 FIXME - instrument and check that assumption */
10662 if (sv_type >= SVt_PVMG) {
10663 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10664 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10665 } else if (SvMAGIC(dstr))
10666 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10668 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10671 /* The cast silences a GCC warning about unhandled types. */
10672 switch ((int)sv_type) {
10682 /* FIXME for plugins */
10683 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10686 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10687 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10688 LvTARG(dstr) = dstr;
10689 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10690 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10692 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10694 if(isGV_with_GP(sstr)) {
10695 if (GvNAME_HEK(dstr))
10696 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10697 /* Don't call sv_add_backref here as it's going to be
10698 created as part of the magic cloning of the symbol
10700 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10701 at the point of this comment. */
10702 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10703 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10704 (void)GpREFCNT_inc(GvGP(dstr));
10706 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10709 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10710 if (IoOFP(dstr) == IoIFP(sstr))
10711 IoOFP(dstr) = IoIFP(dstr);
10713 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10714 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10715 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10716 /* I have no idea why fake dirp (rsfps)
10717 should be treated differently but otherwise
10718 we end up with leaks -- sky*/
10719 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10720 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10721 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10723 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10724 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10725 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10726 if (IoDIRP(dstr)) {
10727 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10730 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10733 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10734 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10735 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10738 if (AvARRAY((AV*)sstr)) {
10739 SV **dst_ary, **src_ary;
10740 SSize_t items = AvFILLp((AV*)sstr) + 1;
10742 src_ary = AvARRAY((AV*)sstr);
10743 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10744 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10745 AvARRAY((AV*)dstr) = dst_ary;
10746 AvALLOC((AV*)dstr) = dst_ary;
10747 if (AvREAL((AV*)sstr)) {
10748 while (items-- > 0)
10749 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10752 while (items-- > 0)
10753 *dst_ary++ = sv_dup(*src_ary++, param);
10755 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10756 while (items-- > 0) {
10757 *dst_ary++ = &PL_sv_undef;
10761 AvARRAY((AV*)dstr) = NULL;
10762 AvALLOC((AV*)dstr) = (SV**)NULL;
10766 if (HvARRAY((HV*)sstr)) {
10768 const bool sharekeys = !!HvSHAREKEYS(sstr);
10769 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10770 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10772 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10773 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10775 HvARRAY(dstr) = (HE**)darray;
10776 while (i <= sxhv->xhv_max) {
10777 const HE * const source = HvARRAY(sstr)[i];
10778 HvARRAY(dstr)[i] = source
10779 ? he_dup(source, sharekeys, param) : 0;
10784 const struct xpvhv_aux * const saux = HvAUX(sstr);
10785 struct xpvhv_aux * const daux = HvAUX(dstr);
10786 /* This flag isn't copied. */
10787 /* SvOOK_on(hv) attacks the IV flags. */
10788 SvFLAGS(dstr) |= SVf_OOK;
10790 hvname = saux->xhv_name;
10791 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10793 daux->xhv_riter = saux->xhv_riter;
10794 daux->xhv_eiter = saux->xhv_eiter
10795 ? he_dup(saux->xhv_eiter,
10796 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10797 /* backref array needs refcnt=2; see sv_add_backref */
10798 daux->xhv_backreferences =
10799 saux->xhv_backreferences
10800 ? (AV*) SvREFCNT_inc(
10801 sv_dup_inc((SV*)saux->xhv_backreferences, param))
10804 daux->xhv_mro_meta = saux->xhv_mro_meta
10805 ? mro_meta_dup(saux->xhv_mro_meta, param)
10808 /* Record stashes for possible cloning in Perl_clone(). */
10810 av_push(param->stashes, dstr);
10814 HvARRAY((HV*)dstr) = NULL;
10817 if (!(param->flags & CLONEf_COPY_STACKS)) {
10821 /* NOTE: not refcounted */
10822 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10824 if (!CvISXSUB(dstr))
10825 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10827 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10828 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10829 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10830 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10832 /* don't dup if copying back - CvGV isn't refcounted, so the
10833 * duped GV may never be freed. A bit of a hack! DAPM */
10834 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10835 NULL : gv_dup(CvGV(dstr), param) ;
10836 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10838 CvWEAKOUTSIDE(sstr)
10839 ? cv_dup( CvOUTSIDE(dstr), param)
10840 : cv_dup_inc(CvOUTSIDE(dstr), param);
10841 if (!CvISXSUB(dstr))
10842 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10848 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10854 /* duplicate a context */
10857 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10859 PERL_CONTEXT *ncxs;
10861 PERL_ARGS_ASSERT_CX_DUP;
10864 return (PERL_CONTEXT*)NULL;
10866 /* look for it in the table first */
10867 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10871 /* create anew and remember what it is */
10872 Newx(ncxs, max + 1, PERL_CONTEXT);
10873 ptr_table_store(PL_ptr_table, cxs, ncxs);
10874 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10877 PERL_CONTEXT * const ncx = &ncxs[ix];
10878 if (CxTYPE(ncx) == CXt_SUBST) {
10879 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10882 switch (CxTYPE(ncx)) {
10884 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10885 ? cv_dup_inc(ncx->blk_sub.cv, param)
10886 : cv_dup(ncx->blk_sub.cv,param));
10887 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10888 ? av_dup_inc(ncx->blk_sub.argarray,
10891 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10893 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10894 ncx->blk_sub.oldcomppad);
10897 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10899 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10901 case CXt_LOOP_LAZYSV:
10902 ncx->blk_loop.state_u.lazysv.end
10903 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10904 /* We are taking advantage of av_dup_inc and sv_dup_inc
10905 actually being the same function, and order equivalance of
10907 We can assert the later [but only at run time :-(] */
10908 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10909 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10911 ncx->blk_loop.state_u.ary.ary
10912 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10913 case CXt_LOOP_LAZYIV:
10914 case CXt_LOOP_PLAIN:
10915 if (CxPADLOOP(ncx)) {
10916 ncx->blk_loop.oldcomppad
10917 = (PAD*)ptr_table_fetch(PL_ptr_table,
10918 ncx->blk_loop.oldcomppad);
10920 ncx->blk_loop.oldcomppad
10921 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10925 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10926 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10927 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10940 /* duplicate a stack info structure */
10943 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10947 PERL_ARGS_ASSERT_SI_DUP;
10950 return (PERL_SI*)NULL;
10952 /* look for it in the table first */
10953 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10957 /* create anew and remember what it is */
10958 Newxz(nsi, 1, PERL_SI);
10959 ptr_table_store(PL_ptr_table, si, nsi);
10961 nsi->si_stack = av_dup_inc(si->si_stack, param);
10962 nsi->si_cxix = si->si_cxix;
10963 nsi->si_cxmax = si->si_cxmax;
10964 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10965 nsi->si_type = si->si_type;
10966 nsi->si_prev = si_dup(si->si_prev, param);
10967 nsi->si_next = si_dup(si->si_next, param);
10968 nsi->si_markoff = si->si_markoff;
10973 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10974 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10975 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10976 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10977 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10978 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10979 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10980 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10981 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10982 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10983 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10984 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10985 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10986 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10989 #define pv_dup_inc(p) SAVEPV(p)
10990 #define pv_dup(p) SAVEPV(p)
10991 #define svp_dup_inc(p,pp) any_dup(p,pp)
10993 /* map any object to the new equivent - either something in the
10994 * ptr table, or something in the interpreter structure
10998 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
11002 PERL_ARGS_ASSERT_ANY_DUP;
11005 return (void*)NULL;
11007 /* look for it in the table first */
11008 ret = ptr_table_fetch(PL_ptr_table, v);
11012 /* see if it is part of the interpreter structure */
11013 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11014 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11022 /* duplicate the save stack */
11025 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11028 ANY * const ss = proto_perl->Isavestack;
11029 const I32 max = proto_perl->Isavestack_max;
11030 I32 ix = proto_perl->Isavestack_ix;
11043 void (*dptr) (void*);
11044 void (*dxptr) (pTHX_ void*);
11046 PERL_ARGS_ASSERT_SS_DUP;
11048 Newxz(nss, max, ANY);
11051 const I32 type = POPINT(ss,ix);
11052 TOPINT(nss,ix) = type;
11054 case SAVEt_HELEM: /* hash element */
11055 sv = (SV*)POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11058 case SAVEt_ITEM: /* normal string */
11059 case SAVEt_SV: /* scalar reference */
11060 sv = (SV*)POPPTR(ss,ix);
11061 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11064 case SAVEt_MORTALIZESV:
11065 sv = (SV*)POPPTR(ss,ix);
11066 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11068 case SAVEt_SHARED_PVREF: /* char* in shared space */
11069 c = (char*)POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = savesharedpv(c);
11071 ptr = POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11074 case SAVEt_GENERIC_SVREF: /* generic sv */
11075 case SAVEt_SVREF: /* scalar reference */
11076 sv = (SV*)POPPTR(ss,ix);
11077 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11078 ptr = POPPTR(ss,ix);
11079 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11081 case SAVEt_HV: /* hash reference */
11082 case SAVEt_AV: /* array reference */
11083 sv = (SV*) POPPTR(ss,ix);
11084 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11086 case SAVEt_COMPPAD:
11088 sv = (SV*) POPPTR(ss,ix);
11089 TOPPTR(nss,ix) = sv_dup(sv, param);
11091 case SAVEt_INT: /* int reference */
11092 ptr = POPPTR(ss,ix);
11093 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11094 intval = (int)POPINT(ss,ix);
11095 TOPINT(nss,ix) = intval;
11097 case SAVEt_LONG: /* long reference */
11098 ptr = POPPTR(ss,ix);
11099 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11101 case SAVEt_CLEARSV:
11102 longval = (long)POPLONG(ss,ix);
11103 TOPLONG(nss,ix) = longval;
11105 case SAVEt_I32: /* I32 reference */
11106 case SAVEt_I16: /* I16 reference */
11107 case SAVEt_I8: /* I8 reference */
11108 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11109 ptr = POPPTR(ss,ix);
11110 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11112 TOPINT(nss,ix) = i;
11114 case SAVEt_IV: /* IV reference */
11115 ptr = POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11118 TOPIV(nss,ix) = iv;
11120 case SAVEt_HPTR: /* HV* reference */
11121 case SAVEt_APTR: /* AV* reference */
11122 case SAVEt_SPTR: /* SV* reference */
11123 ptr = POPPTR(ss,ix);
11124 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11125 sv = (SV*)POPPTR(ss,ix);
11126 TOPPTR(nss,ix) = sv_dup(sv, param);
11128 case SAVEt_VPTR: /* random* reference */
11129 ptr = POPPTR(ss,ix);
11130 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11131 ptr = POPPTR(ss,ix);
11132 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11134 case SAVEt_GENERIC_PVREF: /* generic char* */
11135 case SAVEt_PPTR: /* char* reference */
11136 ptr = POPPTR(ss,ix);
11137 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11138 c = (char*)POPPTR(ss,ix);
11139 TOPPTR(nss,ix) = pv_dup(c);
11141 case SAVEt_GP: /* scalar reference */
11142 gp = (GP*)POPPTR(ss,ix);
11143 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11144 (void)GpREFCNT_inc(gp);
11145 gv = (GV*)POPPTR(ss,ix);
11146 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11149 ptr = POPPTR(ss,ix);
11150 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11151 /* these are assumed to be refcounted properly */
11153 switch (((OP*)ptr)->op_type) {
11155 case OP_LEAVESUBLV:
11159 case OP_LEAVEWRITE:
11160 TOPPTR(nss,ix) = ptr;
11163 (void) OpREFCNT_inc(o);
11167 TOPPTR(nss,ix) = NULL;
11172 TOPPTR(nss,ix) = NULL;
11175 c = (char*)POPPTR(ss,ix);
11176 TOPPTR(nss,ix) = pv_dup_inc(c);
11179 hv = (HV*)POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11181 c = (char*)POPPTR(ss,ix);
11182 TOPPTR(nss,ix) = pv_dup_inc(c);
11184 case SAVEt_STACK_POS: /* Position on Perl stack */
11186 TOPINT(nss,ix) = i;
11188 case SAVEt_DESTRUCTOR:
11189 ptr = POPPTR(ss,ix);
11190 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11191 dptr = POPDPTR(ss,ix);
11192 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11193 any_dup(FPTR2DPTR(void *, dptr),
11196 case SAVEt_DESTRUCTOR_X:
11197 ptr = POPPTR(ss,ix);
11198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11199 dxptr = POPDXPTR(ss,ix);
11200 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11201 any_dup(FPTR2DPTR(void *, dxptr),
11204 case SAVEt_REGCONTEXT:
11207 TOPINT(nss,ix) = i;
11210 case SAVEt_AELEM: /* array element */
11211 sv = (SV*)POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11214 TOPINT(nss,ix) = i;
11215 av = (AV*)POPPTR(ss,ix);
11216 TOPPTR(nss,ix) = av_dup_inc(av, param);
11219 ptr = POPPTR(ss,ix);
11220 TOPPTR(nss,ix) = ptr;
11224 TOPINT(nss,ix) = i;
11225 ptr = POPPTR(ss,ix);
11228 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11229 HINTS_REFCNT_UNLOCK;
11231 TOPPTR(nss,ix) = ptr;
11232 if (i & HINT_LOCALIZE_HH) {
11233 hv = (HV*)POPPTR(ss,ix);
11234 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11237 case SAVEt_PADSV_AND_MORTALIZE:
11238 longval = (long)POPLONG(ss,ix);
11239 TOPLONG(nss,ix) = longval;
11240 ptr = POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11242 sv = (SV*)POPPTR(ss,ix);
11243 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11246 ptr = POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11248 longval = (long)POPBOOL(ss,ix);
11249 TOPBOOL(nss,ix) = (bool)longval;
11251 case SAVEt_SET_SVFLAGS:
11253 TOPINT(nss,ix) = i;
11255 TOPINT(nss,ix) = i;
11256 sv = (SV*)POPPTR(ss,ix);
11257 TOPPTR(nss,ix) = sv_dup(sv, param);
11259 case SAVEt_RE_STATE:
11261 const struct re_save_state *const old_state
11262 = (struct re_save_state *)
11263 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11264 struct re_save_state *const new_state
11265 = (struct re_save_state *)
11266 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11268 Copy(old_state, new_state, 1, struct re_save_state);
11269 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11271 new_state->re_state_bostr
11272 = pv_dup(old_state->re_state_bostr);
11273 new_state->re_state_reginput
11274 = pv_dup(old_state->re_state_reginput);
11275 new_state->re_state_regeol
11276 = pv_dup(old_state->re_state_regeol);
11277 new_state->re_state_regoffs
11278 = (regexp_paren_pair*)
11279 any_dup(old_state->re_state_regoffs, proto_perl);
11280 new_state->re_state_reglastparen
11281 = (U32*) any_dup(old_state->re_state_reglastparen,
11283 new_state->re_state_reglastcloseparen
11284 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11286 /* XXX This just has to be broken. The old save_re_context
11287 code did SAVEGENERICPV(PL_reg_start_tmp);
11288 PL_reg_start_tmp is char **.
11289 Look above to what the dup code does for
11290 SAVEt_GENERIC_PVREF
11291 It can never have worked.
11292 So this is merely a faithful copy of the exiting bug: */
11293 new_state->re_state_reg_start_tmp
11294 = (char **) pv_dup((char *)
11295 old_state->re_state_reg_start_tmp);
11296 /* I assume that it only ever "worked" because no-one called
11297 (pseudo)fork while the regexp engine had re-entered itself.
11299 #ifdef PERL_OLD_COPY_ON_WRITE
11300 new_state->re_state_nrs
11301 = sv_dup(old_state->re_state_nrs, param);
11303 new_state->re_state_reg_magic
11304 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11306 new_state->re_state_reg_oldcurpm
11307 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11309 new_state->re_state_reg_curpm
11310 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11312 new_state->re_state_reg_oldsaved
11313 = pv_dup(old_state->re_state_reg_oldsaved);
11314 new_state->re_state_reg_poscache
11315 = pv_dup(old_state->re_state_reg_poscache);
11316 new_state->re_state_reg_starttry
11317 = pv_dup(old_state->re_state_reg_starttry);
11320 case SAVEt_COMPILE_WARNINGS:
11321 ptr = POPPTR(ss,ix);
11322 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11325 ptr = POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11330 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11338 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11339 * flag to the result. This is done for each stash before cloning starts,
11340 * so we know which stashes want their objects cloned */
11343 do_mark_cloneable_stash(pTHX_ SV *const sv)
11345 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11347 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11348 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11349 if (cloner && GvCV(cloner)) {
11356 mXPUSHs(newSVhek(hvname));
11358 call_sv((SV*)GvCV(cloner), G_SCALAR);
11365 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11373 =for apidoc perl_clone
11375 Create and return a new interpreter by cloning the current one.
11377 perl_clone takes these flags as parameters:
11379 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11380 without it we only clone the data and zero the stacks,
11381 with it we copy the stacks and the new perl interpreter is
11382 ready to run at the exact same point as the previous one.
11383 The pseudo-fork code uses COPY_STACKS while the
11384 threads->create doesn't.
11386 CLONEf_KEEP_PTR_TABLE
11387 perl_clone keeps a ptr_table with the pointer of the old
11388 variable as a key and the new variable as a value,
11389 this allows it to check if something has been cloned and not
11390 clone it again but rather just use the value and increase the
11391 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11392 the ptr_table using the function
11393 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11394 reason to keep it around is if you want to dup some of your own
11395 variable who are outside the graph perl scans, example of this
11396 code is in threads.xs create
11399 This is a win32 thing, it is ignored on unix, it tells perls
11400 win32host code (which is c++) to clone itself, this is needed on
11401 win32 if you want to run two threads at the same time,
11402 if you just want to do some stuff in a separate perl interpreter
11403 and then throw it away and return to the original one,
11404 you don't need to do anything.
11409 /* XXX the above needs expanding by someone who actually understands it ! */
11410 EXTERN_C PerlInterpreter *
11411 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11414 perl_clone(PerlInterpreter *proto_perl, UV flags)
11417 #ifdef PERL_IMPLICIT_SYS
11419 PERL_ARGS_ASSERT_PERL_CLONE;
11421 /* perlhost.h so we need to call into it
11422 to clone the host, CPerlHost should have a c interface, sky */
11424 if (flags & CLONEf_CLONE_HOST) {
11425 return perl_clone_host(proto_perl,flags);
11427 return perl_clone_using(proto_perl, flags,
11429 proto_perl->IMemShared,
11430 proto_perl->IMemParse,
11432 proto_perl->IStdIO,
11436 proto_perl->IProc);
11440 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11441 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11442 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11443 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11444 struct IPerlDir* ipD, struct IPerlSock* ipS,
11445 struct IPerlProc* ipP)
11447 /* XXX many of the string copies here can be optimized if they're
11448 * constants; they need to be allocated as common memory and just
11449 * their pointers copied. */
11452 CLONE_PARAMS clone_params;
11453 CLONE_PARAMS* const param = &clone_params;
11455 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11457 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11459 /* for each stash, determine whether its objects should be cloned */
11460 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11461 PERL_SET_THX(my_perl);
11464 PoisonNew(my_perl, 1, PerlInterpreter);
11470 PL_savestack_ix = 0;
11471 PL_savestack_max = -1;
11472 PL_sig_pending = 0;
11474 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11475 # else /* !DEBUGGING */
11476 Zero(my_perl, 1, PerlInterpreter);
11477 # endif /* DEBUGGING */
11479 /* host pointers */
11481 PL_MemShared = ipMS;
11482 PL_MemParse = ipMP;
11489 #else /* !PERL_IMPLICIT_SYS */
11491 CLONE_PARAMS clone_params;
11492 CLONE_PARAMS* param = &clone_params;
11493 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11495 PERL_ARGS_ASSERT_PERL_CLONE;
11497 /* for each stash, determine whether its objects should be cloned */
11498 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11499 PERL_SET_THX(my_perl);
11502 PoisonNew(my_perl, 1, PerlInterpreter);
11508 PL_savestack_ix = 0;
11509 PL_savestack_max = -1;
11510 PL_sig_pending = 0;
11512 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11513 # else /* !DEBUGGING */
11514 Zero(my_perl, 1, PerlInterpreter);
11515 # endif /* DEBUGGING */
11516 #endif /* PERL_IMPLICIT_SYS */
11517 param->flags = flags;
11518 param->proto_perl = proto_perl;
11520 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11522 PL_body_arenas = NULL;
11523 Zero(&PL_body_roots, 1, PL_body_roots);
11525 PL_nice_chunk = NULL;
11526 PL_nice_chunk_size = 0;
11528 PL_sv_objcount = 0;
11530 PL_sv_arenaroot = NULL;
11532 PL_debug = proto_perl->Idebug;
11534 PL_hash_seed = proto_perl->Ihash_seed;
11535 PL_rehash_seed = proto_perl->Irehash_seed;
11537 #ifdef USE_REENTRANT_API
11538 /* XXX: things like -Dm will segfault here in perlio, but doing
11539 * PERL_SET_CONTEXT(proto_perl);
11540 * breaks too many other things
11542 Perl_reentrant_init(aTHX);
11545 /* create SV map for pointer relocation */
11546 PL_ptr_table = ptr_table_new();
11548 /* initialize these special pointers as early as possible */
11549 SvANY(&PL_sv_undef) = NULL;
11550 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11551 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11552 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11554 SvANY(&PL_sv_no) = new_XPVNV();
11555 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11556 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11557 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11558 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11559 SvCUR_set(&PL_sv_no, 0);
11560 SvLEN_set(&PL_sv_no, 1);
11561 SvIV_set(&PL_sv_no, 0);
11562 SvNV_set(&PL_sv_no, 0);
11563 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11565 SvANY(&PL_sv_yes) = new_XPVNV();
11566 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11567 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11568 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11569 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11570 SvCUR_set(&PL_sv_yes, 1);
11571 SvLEN_set(&PL_sv_yes, 2);
11572 SvIV_set(&PL_sv_yes, 1);
11573 SvNV_set(&PL_sv_yes, 1);
11574 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11576 /* create (a non-shared!) shared string table */
11577 PL_strtab = newHV();
11578 HvSHAREKEYS_off(PL_strtab);
11579 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11580 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11582 PL_compiling = proto_perl->Icompiling;
11584 /* These two PVs will be free'd special way so must set them same way op.c does */
11585 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11586 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11588 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11589 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11591 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11592 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11593 if (PL_compiling.cop_hints_hash) {
11595 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11596 HINTS_REFCNT_UNLOCK;
11598 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11599 #ifdef PERL_DEBUG_READONLY_OPS
11604 /* pseudo environmental stuff */
11605 PL_origargc = proto_perl->Iorigargc;
11606 PL_origargv = proto_perl->Iorigargv;
11608 param->stashes = newAV(); /* Setup array of objects to call clone on */
11610 /* Set tainting stuff before PerlIO_debug can possibly get called */
11611 PL_tainting = proto_perl->Itainting;
11612 PL_taint_warn = proto_perl->Itaint_warn;
11614 #ifdef PERLIO_LAYERS
11615 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11616 PerlIO_clone(aTHX_ proto_perl, param);
11619 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11620 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11621 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11622 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11623 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11624 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11627 PL_minus_c = proto_perl->Iminus_c;
11628 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11629 PL_localpatches = proto_perl->Ilocalpatches;
11630 PL_splitstr = proto_perl->Isplitstr;
11631 PL_minus_n = proto_perl->Iminus_n;
11632 PL_minus_p = proto_perl->Iminus_p;
11633 PL_minus_l = proto_perl->Iminus_l;
11634 PL_minus_a = proto_perl->Iminus_a;
11635 PL_minus_E = proto_perl->Iminus_E;
11636 PL_minus_F = proto_perl->Iminus_F;
11637 PL_doswitches = proto_perl->Idoswitches;
11638 PL_dowarn = proto_perl->Idowarn;
11639 PL_doextract = proto_perl->Idoextract;
11640 PL_sawampersand = proto_perl->Isawampersand;
11641 PL_unsafe = proto_perl->Iunsafe;
11642 PL_inplace = SAVEPV(proto_perl->Iinplace);
11643 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11644 PL_perldb = proto_perl->Iperldb;
11645 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11646 PL_exit_flags = proto_perl->Iexit_flags;
11648 /* magical thingies */
11649 /* XXX time(&PL_basetime) when asked for? */
11650 PL_basetime = proto_perl->Ibasetime;
11651 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11653 PL_maxsysfd = proto_perl->Imaxsysfd;
11654 PL_statusvalue = proto_perl->Istatusvalue;
11656 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11658 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11660 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11662 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11663 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11664 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11667 /* RE engine related */
11668 Zero(&PL_reg_state, 1, struct re_save_state);
11669 PL_reginterp_cnt = 0;
11670 PL_regmatch_slab = NULL;
11672 /* Clone the regex array */
11673 /* ORANGE FIXME for plugins, probably in the SV dup code.
11674 newSViv(PTR2IV(CALLREGDUPE(
11675 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11677 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11678 PL_regex_pad = AvARRAY(PL_regex_padav);
11680 /* shortcuts to various I/O objects */
11681 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11682 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11683 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11684 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11685 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11686 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11688 /* shortcuts to regexp stuff */
11689 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11691 /* shortcuts to misc objects */
11692 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11694 /* shortcuts to debugging objects */
11695 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11696 PL_DBline = gv_dup(proto_perl->IDBline, param);
11697 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11698 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11699 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11700 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11701 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11703 /* symbol tables */
11704 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11705 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11706 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11707 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11708 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11710 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11711 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11712 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11713 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11714 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11715 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11716 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11717 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11719 PL_sub_generation = proto_perl->Isub_generation;
11720 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11722 /* funky return mechanisms */
11723 PL_forkprocess = proto_perl->Iforkprocess;
11725 /* subprocess state */
11726 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11728 /* internal state */
11729 PL_maxo = proto_perl->Imaxo;
11730 if (proto_perl->Iop_mask)
11731 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11734 /* PL_asserting = proto_perl->Iasserting; */
11736 /* current interpreter roots */
11737 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11739 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11741 PL_main_start = proto_perl->Imain_start;
11742 PL_eval_root = proto_perl->Ieval_root;
11743 PL_eval_start = proto_perl->Ieval_start;
11745 /* runtime control stuff */
11746 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11748 PL_filemode = proto_perl->Ifilemode;
11749 PL_lastfd = proto_perl->Ilastfd;
11750 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11753 PL_gensym = proto_perl->Igensym;
11754 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11755 PL_laststatval = proto_perl->Ilaststatval;
11756 PL_laststype = proto_perl->Ilaststype;
11759 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11761 /* interpreter atexit processing */
11762 PL_exitlistlen = proto_perl->Iexitlistlen;
11763 if (PL_exitlistlen) {
11764 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11765 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11768 PL_exitlist = (PerlExitListEntry*)NULL;
11770 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11771 if (PL_my_cxt_size) {
11772 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11773 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11774 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11775 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11776 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11780 PL_my_cxt_list = (void**)NULL;
11781 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11782 PL_my_cxt_keys = (const char**)NULL;
11785 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11786 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11787 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11789 PL_profiledata = NULL;
11791 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11793 PAD_CLONE_VARS(proto_perl, param);
11795 #ifdef HAVE_INTERP_INTERN
11796 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11799 /* more statics moved here */
11800 PL_generation = proto_perl->Igeneration;
11801 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11803 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11804 PL_in_clean_all = proto_perl->Iin_clean_all;
11806 PL_uid = proto_perl->Iuid;
11807 PL_euid = proto_perl->Ieuid;
11808 PL_gid = proto_perl->Igid;
11809 PL_egid = proto_perl->Iegid;
11810 PL_nomemok = proto_perl->Inomemok;
11811 PL_an = proto_perl->Ian;
11812 PL_evalseq = proto_perl->Ievalseq;
11813 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11814 PL_origalen = proto_perl->Iorigalen;
11815 #ifdef PERL_USES_PL_PIDSTATUS
11816 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11818 PL_osname = SAVEPV(proto_perl->Iosname);
11819 PL_sighandlerp = proto_perl->Isighandlerp;
11821 PL_runops = proto_perl->Irunops;
11823 PL_parser = parser_dup(proto_perl->Iparser, param);
11825 PL_subline = proto_perl->Isubline;
11826 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11829 PL_cryptseen = proto_perl->Icryptseen;
11832 PL_hints = proto_perl->Ihints;
11834 PL_amagic_generation = proto_perl->Iamagic_generation;
11836 #ifdef USE_LOCALE_COLLATE
11837 PL_collation_ix = proto_perl->Icollation_ix;
11838 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11839 PL_collation_standard = proto_perl->Icollation_standard;
11840 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11841 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11842 #endif /* USE_LOCALE_COLLATE */
11844 #ifdef USE_LOCALE_NUMERIC
11845 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11846 PL_numeric_standard = proto_perl->Inumeric_standard;
11847 PL_numeric_local = proto_perl->Inumeric_local;
11848 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11849 #endif /* !USE_LOCALE_NUMERIC */
11851 /* utf8 character classes */
11852 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11853 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11854 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11855 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11856 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11857 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11858 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11859 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11860 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11861 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11862 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11863 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11864 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11865 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11866 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11867 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11868 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11869 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11870 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11871 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11873 /* Did the locale setup indicate UTF-8? */
11874 PL_utf8locale = proto_perl->Iutf8locale;
11875 /* Unicode features (see perlrun/-C) */
11876 PL_unicode = proto_perl->Iunicode;
11878 /* Pre-5.8 signals control */
11879 PL_signals = proto_perl->Isignals;
11881 /* times() ticks per second */
11882 PL_clocktick = proto_perl->Iclocktick;
11884 /* Recursion stopper for PerlIO_find_layer */
11885 PL_in_load_module = proto_perl->Iin_load_module;
11887 /* sort() routine */
11888 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11890 /* Not really needed/useful since the reenrant_retint is "volatile",
11891 * but do it for consistency's sake. */
11892 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11894 /* Hooks to shared SVs and locks. */
11895 PL_sharehook = proto_perl->Isharehook;
11896 PL_lockhook = proto_perl->Ilockhook;
11897 PL_unlockhook = proto_perl->Iunlockhook;
11898 PL_threadhook = proto_perl->Ithreadhook;
11899 PL_destroyhook = proto_perl->Idestroyhook;
11901 #ifdef THREADS_HAVE_PIDS
11902 PL_ppid = proto_perl->Ippid;
11906 PL_last_swash_hv = NULL; /* reinits on demand */
11907 PL_last_swash_klen = 0;
11908 PL_last_swash_key[0]= '\0';
11909 PL_last_swash_tmps = (U8*)NULL;
11910 PL_last_swash_slen = 0;
11912 PL_glob_index = proto_perl->Iglob_index;
11913 PL_srand_called = proto_perl->Isrand_called;
11914 PL_bitcount = NULL; /* reinits on demand */
11916 if (proto_perl->Ipsig_pend) {
11917 Newxz(PL_psig_pend, SIG_SIZE, int);
11920 PL_psig_pend = (int*)NULL;
11923 if (proto_perl->Ipsig_ptr) {
11924 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11925 Newxz(PL_psig_name, SIG_SIZE, SV*);
11926 for (i = 1; i < SIG_SIZE; i++) {
11927 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11928 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11932 PL_psig_ptr = (SV**)NULL;
11933 PL_psig_name = (SV**)NULL;
11936 /* intrpvar.h stuff */
11938 if (flags & CLONEf_COPY_STACKS) {
11939 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11940 PL_tmps_ix = proto_perl->Itmps_ix;
11941 PL_tmps_max = proto_perl->Itmps_max;
11942 PL_tmps_floor = proto_perl->Itmps_floor;
11943 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11945 while (i <= PL_tmps_ix) {
11946 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11950 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11951 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11952 Newxz(PL_markstack, i, I32);
11953 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11954 - proto_perl->Imarkstack);
11955 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11956 - proto_perl->Imarkstack);
11957 Copy(proto_perl->Imarkstack, PL_markstack,
11958 PL_markstack_ptr - PL_markstack + 1, I32);
11960 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11961 * NOTE: unlike the others! */
11962 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11963 PL_scopestack_max = proto_perl->Iscopestack_max;
11964 Newxz(PL_scopestack, PL_scopestack_max, I32);
11965 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11967 /* NOTE: si_dup() looks at PL_markstack */
11968 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11970 /* PL_curstack = PL_curstackinfo->si_stack; */
11971 PL_curstack = av_dup(proto_perl->Icurstack, param);
11972 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11974 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11975 PL_stack_base = AvARRAY(PL_curstack);
11976 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11977 - proto_perl->Istack_base);
11978 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11980 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11981 * NOTE: unlike the others! */
11982 PL_savestack_ix = proto_perl->Isavestack_ix;
11983 PL_savestack_max = proto_perl->Isavestack_max;
11984 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11985 PL_savestack = ss_dup(proto_perl, param);
11989 ENTER; /* perl_destruct() wants to LEAVE; */
11991 /* although we're not duplicating the tmps stack, we should still
11992 * add entries for any SVs on the tmps stack that got cloned by a
11993 * non-refcount means (eg a temp in @_); otherwise they will be
11996 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11997 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11998 proto_perl->Itmps_stack[i]);
11999 if (nsv && !SvREFCNT(nsv)) {
12001 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
12006 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
12007 PL_top_env = &PL_start_env;
12009 PL_op = proto_perl->Iop;
12012 PL_Xpv = (XPV*)NULL;
12013 my_perl->Ina = proto_perl->Ina;
12015 PL_statbuf = proto_perl->Istatbuf;
12016 PL_statcache = proto_perl->Istatcache;
12017 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12018 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12020 PL_timesbuf = proto_perl->Itimesbuf;
12023 PL_tainted = proto_perl->Itainted;
12024 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12025 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12026 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12027 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
12028 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12029 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12030 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12031 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12032 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12034 PL_restartop = proto_perl->Irestartop;
12035 PL_in_eval = proto_perl->Iin_eval;
12036 PL_delaymagic = proto_perl->Idelaymagic;
12037 PL_dirty = proto_perl->Idirty;
12038 PL_localizing = proto_perl->Ilocalizing;
12040 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12041 PL_hv_fetch_ent_mh = NULL;
12042 PL_modcount = proto_perl->Imodcount;
12043 PL_lastgotoprobe = NULL;
12044 PL_dumpindent = proto_perl->Idumpindent;
12046 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12047 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12048 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12049 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12050 PL_efloatbuf = NULL; /* reinits on demand */
12051 PL_efloatsize = 0; /* reinits on demand */
12055 PL_screamfirst = NULL;
12056 PL_screamnext = NULL;
12057 PL_maxscream = -1; /* reinits on demand */
12058 PL_lastscream = NULL;
12061 PL_regdummy = proto_perl->Iregdummy;
12062 PL_colorset = 0; /* reinits PL_colors[] */
12063 /*PL_colors[6] = {0,0,0,0,0,0};*/
12067 /* Pluggable optimizer */
12068 PL_peepp = proto_perl->Ipeepp;
12070 PL_stashcache = newHV();
12072 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12073 proto_perl->Iwatchaddr);
12074 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12075 if (PL_debug && PL_watchaddr) {
12076 PerlIO_printf(Perl_debug_log,
12077 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12078 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12079 PTR2UV(PL_watchok));
12082 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12083 ptr_table_free(PL_ptr_table);
12084 PL_ptr_table = NULL;
12087 /* Call the ->CLONE method, if it exists, for each of the stashes
12088 identified by sv_dup() above.
12090 while(av_len(param->stashes) != -1) {
12091 HV* const stash = (HV*) av_shift(param->stashes);
12092 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12093 if (cloner && GvCV(cloner)) {
12098 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12100 call_sv((SV*)GvCV(cloner), G_DISCARD);
12106 SvREFCNT_dec(param->stashes);
12108 /* orphaned? eg threads->new inside BEGIN or use */
12109 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12110 SvREFCNT_inc_simple_void(PL_compcv);
12111 SAVEFREESV(PL_compcv);
12117 #endif /* USE_ITHREADS */
12120 =head1 Unicode Support
12122 =for apidoc sv_recode_to_utf8
12124 The encoding is assumed to be an Encode object, on entry the PV
12125 of the sv is assumed to be octets in that encoding, and the sv
12126 will be converted into Unicode (and UTF-8).
12128 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12129 is not a reference, nothing is done to the sv. If the encoding is not
12130 an C<Encode::XS> Encoding object, bad things will happen.
12131 (See F<lib/encoding.pm> and L<Encode>).
12133 The PV of the sv is returned.
12138 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12142 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12144 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12158 Passing sv_yes is wrong - it needs to be or'ed set of constants
12159 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12160 remove converted chars from source.
12162 Both will default the value - let them.
12164 XPUSHs(&PL_sv_yes);
12167 call_method("decode", G_SCALAR);
12171 s = SvPV_const(uni, len);
12172 if (s != SvPVX_const(sv)) {
12173 SvGROW(sv, len + 1);
12174 Move(s, SvPVX(sv), len + 1, char);
12175 SvCUR_set(sv, len);
12182 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12186 =for apidoc sv_cat_decode
12188 The encoding is assumed to be an Encode object, the PV of the ssv is
12189 assumed to be octets in that encoding and decoding the input starts
12190 from the position which (PV + *offset) pointed to. The dsv will be
12191 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12192 when the string tstr appears in decoding output or the input ends on
12193 the PV of the ssv. The value which the offset points will be modified
12194 to the last input position on the ssv.
12196 Returns TRUE if the terminator was found, else returns FALSE.
12201 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12202 SV *ssv, int *offset, char *tstr, int tlen)
12207 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12209 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12220 offsv = newSViv(*offset);
12222 mXPUSHp(tstr, tlen);
12224 call_method("cat_decode", G_SCALAR);
12226 ret = SvTRUE(TOPs);
12227 *offset = SvIV(offsv);
12233 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12238 /* ---------------------------------------------------------------------
12240 * support functions for report_uninit()
12243 /* the maxiumum size of array or hash where we will scan looking
12244 * for the undefined element that triggered the warning */
12246 #define FUV_MAX_SEARCH_SIZE 1000
12248 /* Look for an entry in the hash whose value has the same SV as val;
12249 * If so, return a mortal copy of the key. */
12252 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12255 register HE **array;
12258 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12260 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12261 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12264 array = HvARRAY(hv);
12266 for (i=HvMAX(hv); i>0; i--) {
12267 register HE *entry;
12268 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12269 if (HeVAL(entry) != val)
12271 if ( HeVAL(entry) == &PL_sv_undef ||
12272 HeVAL(entry) == &PL_sv_placeholder)
12276 if (HeKLEN(entry) == HEf_SVKEY)
12277 return sv_mortalcopy(HeKEY_sv(entry));
12278 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12284 /* Look for an entry in the array whose value has the same SV as val;
12285 * If so, return the index, otherwise return -1. */
12288 S_find_array_subscript(pTHX_ AV *av, SV* val)
12292 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12294 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12295 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12298 if (val != &PL_sv_undef) {
12299 SV ** const svp = AvARRAY(av);
12302 for (i=AvFILLp(av); i>=0; i--)
12309 /* S_varname(): return the name of a variable, optionally with a subscript.
12310 * If gv is non-zero, use the name of that global, along with gvtype (one
12311 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12312 * targ. Depending on the value of the subscript_type flag, return:
12315 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12316 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12317 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12318 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12321 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12322 SV* keyname, I32 aindex, int subscript_type)
12325 SV * const name = sv_newmortal();
12328 buffer[0] = gvtype;
12331 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12333 gv_fullname4(name, gv, buffer, 0);
12335 if ((unsigned int)SvPVX(name)[1] <= 26) {
12337 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12339 /* Swap the 1 unprintable control character for the 2 byte pretty
12340 version - ie substr($name, 1, 1) = $buffer; */
12341 sv_insert(name, 1, 1, buffer, 2);
12345 CV * const cv = find_runcv(NULL);
12349 if (!cv || !CvPADLIST(cv))
12351 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12352 sv = *av_fetch(av, targ, FALSE);
12353 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12356 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12357 SV * const sv = newSV(0);
12358 *SvPVX(name) = '$';
12359 Perl_sv_catpvf(aTHX_ name, "{%s}",
12360 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12363 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12364 *SvPVX(name) = '$';
12365 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12367 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12368 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12369 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12377 =for apidoc find_uninit_var
12379 Find the name of the undefined variable (if any) that caused the operator o
12380 to issue a "Use of uninitialized value" warning.
12381 If match is true, only return a name if it's value matches uninit_sv.
12382 So roughly speaking, if a unary operator (such as OP_COS) generates a
12383 warning, then following the direct child of the op may yield an
12384 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12385 other hand, with OP_ADD there are two branches to follow, so we only print
12386 the variable name if we get an exact match.
12388 The name is returned as a mortal SV.
12390 Assumes that PL_op is the op that originally triggered the error, and that
12391 PL_comppad/PL_curpad points to the currently executing pad.
12397 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12405 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12406 uninit_sv == &PL_sv_placeholder)))
12409 switch (obase->op_type) {
12416 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12417 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12420 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12422 if (pad) { /* @lex, %lex */
12423 sv = PAD_SVl(obase->op_targ);
12427 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12428 /* @global, %global */
12429 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12432 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12434 else /* @{expr}, %{expr} */
12435 return find_uninit_var(cUNOPx(obase)->op_first,
12439 /* attempt to find a match within the aggregate */
12441 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12443 subscript_type = FUV_SUBSCRIPT_HASH;
12446 index = find_array_subscript((AV*)sv, uninit_sv);
12448 subscript_type = FUV_SUBSCRIPT_ARRAY;
12451 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12454 return varname(gv, hash ? '%' : '@', obase->op_targ,
12455 keysv, index, subscript_type);
12459 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12461 return varname(NULL, '$', obase->op_targ,
12462 NULL, 0, FUV_SUBSCRIPT_NONE);
12465 gv = cGVOPx_gv(obase);
12466 if (!gv || (match && GvSV(gv) != uninit_sv))
12468 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12471 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12474 av = (AV*)PAD_SV(obase->op_targ);
12475 if (!av || SvRMAGICAL(av))
12477 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12478 if (!svp || *svp != uninit_sv)
12481 return varname(NULL, '$', obase->op_targ,
12482 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12485 gv = cGVOPx_gv(obase);
12491 if (!av || SvRMAGICAL(av))
12493 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12494 if (!svp || *svp != uninit_sv)
12497 return varname(gv, '$', 0,
12498 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12503 o = cUNOPx(obase)->op_first;
12504 if (!o || o->op_type != OP_NULL ||
12505 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12507 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12511 if (PL_op == obase)
12512 /* $a[uninit_expr] or $h{uninit_expr} */
12513 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12516 o = cBINOPx(obase)->op_first;
12517 kid = cBINOPx(obase)->op_last;
12519 /* get the av or hv, and optionally the gv */
12521 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12522 sv = PAD_SV(o->op_targ);
12524 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12525 && cUNOPo->op_first->op_type == OP_GV)
12527 gv = cGVOPx_gv(cUNOPo->op_first);
12530 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12535 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12536 /* index is constant */
12540 if (obase->op_type == OP_HELEM) {
12541 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12542 if (!he || HeVAL(he) != uninit_sv)
12546 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12547 if (!svp || *svp != uninit_sv)
12551 if (obase->op_type == OP_HELEM)
12552 return varname(gv, '%', o->op_targ,
12553 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12555 return varname(gv, '@', o->op_targ, NULL,
12556 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12559 /* index is an expression;
12560 * attempt to find a match within the aggregate */
12561 if (obase->op_type == OP_HELEM) {
12562 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12564 return varname(gv, '%', o->op_targ,
12565 keysv, 0, FUV_SUBSCRIPT_HASH);
12568 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12570 return varname(gv, '@', o->op_targ,
12571 NULL, index, FUV_SUBSCRIPT_ARRAY);
12576 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12578 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12583 /* only examine RHS */
12584 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12587 o = cUNOPx(obase)->op_first;
12588 if (o->op_type == OP_PUSHMARK)
12591 if (!o->op_sibling) {
12592 /* one-arg version of open is highly magical */
12594 if (o->op_type == OP_GV) { /* open FOO; */
12596 if (match && GvSV(gv) != uninit_sv)
12598 return varname(gv, '$', 0,
12599 NULL, 0, FUV_SUBSCRIPT_NONE);
12601 /* other possibilities not handled are:
12602 * open $x; or open my $x; should return '${*$x}'
12603 * open expr; should return '$'.expr ideally
12609 /* ops where $_ may be an implicit arg */
12613 if ( !(obase->op_flags & OPf_STACKED)) {
12614 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12615 ? PAD_SVl(obase->op_targ)
12618 sv = sv_newmortal();
12619 sv_setpvn(sv, "$_", 2);
12628 match = 1; /* print etc can return undef on defined args */
12629 /* skip filehandle as it can't produce 'undef' warning */
12630 o = cUNOPx(obase)->op_first;
12631 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12632 o = o->op_sibling->op_sibling;
12636 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12638 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12640 /* the following ops are capable of returning PL_sv_undef even for
12641 * defined arg(s) */
12660 case OP_GETPEERNAME:
12708 case OP_SMARTMATCH:
12717 /* XXX tmp hack: these two may call an XS sub, and currently
12718 XS subs don't have a SUB entry on the context stack, so CV and
12719 pad determination goes wrong, and BAD things happen. So, just
12720 don't try to determine the value under those circumstances.
12721 Need a better fix at dome point. DAPM 11/2007 */
12726 /* def-ness of rval pos() is independent of the def-ness of its arg */
12727 if ( !(obase->op_flags & OPf_MOD))
12732 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12733 return newSVpvs_flags("${$/}", SVs_TEMP);
12738 if (!(obase->op_flags & OPf_KIDS))
12740 o = cUNOPx(obase)->op_first;
12746 /* if all except one arg are constant, or have no side-effects,
12747 * or are optimized away, then it's unambiguous */
12749 for (kid=o; kid; kid = kid->op_sibling) {
12751 const OPCODE type = kid->op_type;
12752 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12753 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12754 || (type == OP_PUSHMARK)
12758 if (o2) { /* more than one found */
12765 return find_uninit_var(o2, uninit_sv, match);
12767 /* scan all args */
12769 sv = find_uninit_var(o, uninit_sv, 1);
12781 =for apidoc report_uninit
12783 Print appropriate "Use of uninitialized variable" warning
12789 Perl_report_uninit(pTHX_ SV* uninit_sv)
12793 SV* varname = NULL;
12795 varname = find_uninit_var(PL_op, uninit_sv,0);
12797 sv_insert(varname, 0, 0, " ", 1);
12799 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12800 varname ? SvPV_nolen_const(varname) : "",
12801 " in ", OP_DESC(PL_op));
12804 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12810 * c-indentation-style: bsd
12811 * c-basic-offset: 4
12812 * indent-tabs-mode: t
12815 * ex: set ts=8 sts=4 sw=4 noet: