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);
1551 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1555 (void)SvIOK_only(sv); /* validate number */
1561 =for apidoc sv_setiv_mg
1563 Like C<sv_setiv>, but also handles 'set' magic.
1569 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1571 PERL_ARGS_ASSERT_SV_SETIV_MG;
1578 =for apidoc sv_setuv
1580 Copies an unsigned integer into the given SV, upgrading first if necessary.
1581 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1587 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1589 PERL_ARGS_ASSERT_SV_SETUV;
1591 /* With these two if statements:
1592 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1595 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1597 If you wish to remove them, please benchmark to see what the effect is
1599 if (u <= (UV)IV_MAX) {
1600 sv_setiv(sv, (IV)u);
1609 =for apidoc sv_setuv_mg
1611 Like C<sv_setuv>, but also handles 'set' magic.
1617 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1619 PERL_ARGS_ASSERT_SV_SETUV_MG;
1626 =for apidoc sv_setnv
1628 Copies a double into the given SV, upgrading first if necessary.
1629 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1635 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1639 PERL_ARGS_ASSERT_SV_SETNV;
1641 SV_CHECK_THINKFIRST_COW_DROP(sv);
1642 switch (SvTYPE(sv)) {
1645 sv_upgrade(sv, SVt_NV);
1649 sv_upgrade(sv, SVt_PVNV);
1658 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1663 (void)SvNOK_only(sv); /* validate number */
1668 =for apidoc sv_setnv_mg
1670 Like C<sv_setnv>, but also handles 'set' magic.
1676 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1678 PERL_ARGS_ASSERT_SV_SETNV_MG;
1684 /* Print an "isn't numeric" warning, using a cleaned-up,
1685 * printable version of the offending string
1689 S_not_a_number(pTHX_ SV *const sv)
1696 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1699 dsv = newSVpvs_flags("", SVs_TEMP);
1700 pv = sv_uni_display(dsv, sv, 10, 0);
1703 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1704 /* each *s can expand to 4 chars + "...\0",
1705 i.e. need room for 8 chars */
1707 const char *s = SvPVX_const(sv);
1708 const char * const end = s + SvCUR(sv);
1709 for ( ; s < end && d < limit; s++ ) {
1711 if (ch & 128 && !isPRINT_LC(ch)) {
1720 else if (ch == '\r') {
1724 else if (ch == '\f') {
1728 else if (ch == '\\') {
1732 else if (ch == '\0') {
1736 else if (isPRINT_LC(ch))
1753 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1754 "Argument \"%s\" isn't numeric in %s", pv,
1757 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1758 "Argument \"%s\" isn't numeric", pv);
1762 =for apidoc looks_like_number
1764 Test if the content of an SV looks like a number (or is a number).
1765 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1766 non-numeric warning), even if your atof() doesn't grok them.
1772 Perl_looks_like_number(pTHX_ SV *const sv)
1774 register const char *sbegin;
1777 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1780 sbegin = SvPVX_const(sv);
1783 else if (SvPOKp(sv))
1784 sbegin = SvPV_const(sv, len);
1786 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1787 return grok_number(sbegin, len, NULL);
1791 S_glob_2number(pTHX_ GV * const gv)
1793 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1794 SV *const buffer = sv_newmortal();
1796 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1798 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1801 gv_efullname3(buffer, gv, "*");
1802 SvFLAGS(gv) |= wasfake;
1804 /* We know that all GVs stringify to something that is not-a-number,
1805 so no need to test that. */
1806 if (ckWARN(WARN_NUMERIC))
1807 not_a_number(buffer);
1808 /* We just want something true to return, so that S_sv_2iuv_common
1809 can tail call us and return true. */
1814 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1816 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1817 SV *const buffer = sv_newmortal();
1819 PERL_ARGS_ASSERT_GLOB_2PV;
1821 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1824 gv_efullname3(buffer, gv, "*");
1825 SvFLAGS(gv) |= wasfake;
1827 assert(SvPOK(buffer));
1829 *len = SvCUR(buffer);
1831 return SvPVX(buffer);
1834 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1835 until proven guilty, assume that things are not that bad... */
1840 As 64 bit platforms often have an NV that doesn't preserve all bits of
1841 an IV (an assumption perl has been based on to date) it becomes necessary
1842 to remove the assumption that the NV always carries enough precision to
1843 recreate the IV whenever needed, and that the NV is the canonical form.
1844 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1845 precision as a side effect of conversion (which would lead to insanity
1846 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1847 1) to distinguish between IV/UV/NV slots that have cached a valid
1848 conversion where precision was lost and IV/UV/NV slots that have a
1849 valid conversion which has lost no precision
1850 2) to ensure that if a numeric conversion to one form is requested that
1851 would lose precision, the precise conversion (or differently
1852 imprecise conversion) is also performed and cached, to prevent
1853 requests for different numeric formats on the same SV causing
1854 lossy conversion chains. (lossless conversion chains are perfectly
1859 SvIOKp is true if the IV slot contains a valid value
1860 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1861 SvNOKp is true if the NV slot contains a valid value
1862 SvNOK is true only if the NV value is accurate
1865 while converting from PV to NV, check to see if converting that NV to an
1866 IV(or UV) would lose accuracy over a direct conversion from PV to
1867 IV(or UV). If it would, cache both conversions, return NV, but mark
1868 SV as IOK NOKp (ie not NOK).
1870 While converting from PV to IV, check to see if converting that IV to an
1871 NV would lose accuracy over a direct conversion from PV to NV. If it
1872 would, cache both conversions, flag similarly.
1874 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1875 correctly because if IV & NV were set NV *always* overruled.
1876 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1877 changes - now IV and NV together means that the two are interchangeable:
1878 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1880 The benefit of this is that operations such as pp_add know that if
1881 SvIOK is true for both left and right operands, then integer addition
1882 can be used instead of floating point (for cases where the result won't
1883 overflow). Before, floating point was always used, which could lead to
1884 loss of precision compared with integer addition.
1886 * making IV and NV equal status should make maths accurate on 64 bit
1888 * may speed up maths somewhat if pp_add and friends start to use
1889 integers when possible instead of fp. (Hopefully the overhead in
1890 looking for SvIOK and checking for overflow will not outweigh the
1891 fp to integer speedup)
1892 * will slow down integer operations (callers of SvIV) on "inaccurate"
1893 values, as the change from SvIOK to SvIOKp will cause a call into
1894 sv_2iv each time rather than a macro access direct to the IV slot
1895 * should speed up number->string conversion on integers as IV is
1896 favoured when IV and NV are equally accurate
1898 ####################################################################
1899 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1900 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1901 On the other hand, SvUOK is true iff UV.
1902 ####################################################################
1904 Your mileage will vary depending your CPU's relative fp to integer
1908 #ifndef NV_PRESERVES_UV
1909 # define IS_NUMBER_UNDERFLOW_IV 1
1910 # define IS_NUMBER_UNDERFLOW_UV 2
1911 # define IS_NUMBER_IV_AND_UV 2
1912 # define IS_NUMBER_OVERFLOW_IV 4
1913 # define IS_NUMBER_OVERFLOW_UV 5
1915 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1917 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1919 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1927 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1929 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));
1930 if (SvNVX(sv) < (NV)IV_MIN) {
1931 (void)SvIOKp_on(sv);
1933 SvIV_set(sv, IV_MIN);
1934 return IS_NUMBER_UNDERFLOW_IV;
1936 if (SvNVX(sv) > (NV)UV_MAX) {
1937 (void)SvIOKp_on(sv);
1940 SvUV_set(sv, UV_MAX);
1941 return IS_NUMBER_OVERFLOW_UV;
1943 (void)SvIOKp_on(sv);
1945 /* Can't use strtol etc to convert this string. (See truth table in
1947 if (SvNVX(sv) <= (UV)IV_MAX) {
1948 SvIV_set(sv, I_V(SvNVX(sv)));
1949 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1950 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1952 /* Integer is imprecise. NOK, IOKp */
1954 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1957 SvUV_set(sv, U_V(SvNVX(sv)));
1958 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1959 if (SvUVX(sv) == UV_MAX) {
1960 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1961 possibly be preserved by NV. Hence, it must be overflow.
1963 return IS_NUMBER_OVERFLOW_UV;
1965 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1967 /* Integer is imprecise. NOK, IOKp */
1969 return IS_NUMBER_OVERFLOW_IV;
1971 #endif /* !NV_PRESERVES_UV*/
1974 S_sv_2iuv_common(pTHX_ SV *const sv)
1978 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1981 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1982 * without also getting a cached IV/UV from it at the same time
1983 * (ie PV->NV conversion should detect loss of accuracy and cache
1984 * IV or UV at same time to avoid this. */
1985 /* IV-over-UV optimisation - choose to cache IV if possible */
1987 if (SvTYPE(sv) == SVt_NV)
1988 sv_upgrade(sv, SVt_PVNV);
1990 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1991 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1992 certainly cast into the IV range at IV_MAX, whereas the correct
1993 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1995 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1996 if (Perl_isnan(SvNVX(sv))) {
2002 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2003 SvIV_set(sv, I_V(SvNVX(sv)));
2004 if (SvNVX(sv) == (NV) SvIVX(sv)
2005 #ifndef NV_PRESERVES_UV
2006 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2007 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2008 /* Don't flag it as "accurately an integer" if the number
2009 came from a (by definition imprecise) NV operation, and
2010 we're outside the range of NV integer precision */
2014 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2016 /* scalar has trailing garbage, eg "42a" */
2018 DEBUG_c(PerlIO_printf(Perl_debug_log,
2019 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2025 /* IV not precise. No need to convert from PV, as NV
2026 conversion would already have cached IV if it detected
2027 that PV->IV would be better than PV->NV->IV
2028 flags already correct - don't set public IOK. */
2029 DEBUG_c(PerlIO_printf(Perl_debug_log,
2030 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2035 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2036 but the cast (NV)IV_MIN rounds to a the value less (more
2037 negative) than IV_MIN which happens to be equal to SvNVX ??
2038 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2039 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2040 (NV)UVX == NVX are both true, but the values differ. :-(
2041 Hopefully for 2s complement IV_MIN is something like
2042 0x8000000000000000 which will be exact. NWC */
2045 SvUV_set(sv, U_V(SvNVX(sv)));
2047 (SvNVX(sv) == (NV) SvUVX(sv))
2048 #ifndef NV_PRESERVES_UV
2049 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2050 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2051 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2052 /* Don't flag it as "accurately an integer" if the number
2053 came from a (by definition imprecise) NV operation, and
2054 we're outside the range of NV integer precision */
2060 DEBUG_c(PerlIO_printf(Perl_debug_log,
2061 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2067 else if (SvPOKp(sv) && SvLEN(sv)) {
2069 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2070 /* We want to avoid a possible problem when we cache an IV/ a UV which
2071 may be later translated to an NV, and the resulting NV is not
2072 the same as the direct translation of the initial string
2073 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2074 be careful to ensure that the value with the .456 is around if the
2075 NV value is requested in the future).
2077 This means that if we cache such an IV/a UV, we need to cache the
2078 NV as well. Moreover, we trade speed for space, and do not
2079 cache the NV if we are sure it's not needed.
2082 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2083 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2084 == IS_NUMBER_IN_UV) {
2085 /* It's definitely an integer, only upgrade to PVIV */
2086 if (SvTYPE(sv) < SVt_PVIV)
2087 sv_upgrade(sv, SVt_PVIV);
2089 } else if (SvTYPE(sv) < SVt_PVNV)
2090 sv_upgrade(sv, SVt_PVNV);
2092 /* If NVs preserve UVs then we only use the UV value if we know that
2093 we aren't going to call atof() below. If NVs don't preserve UVs
2094 then the value returned may have more precision than atof() will
2095 return, even though value isn't perfectly accurate. */
2096 if ((numtype & (IS_NUMBER_IN_UV
2097 #ifdef NV_PRESERVES_UV
2100 )) == IS_NUMBER_IN_UV) {
2101 /* This won't turn off the public IOK flag if it was set above */
2102 (void)SvIOKp_on(sv);
2104 if (!(numtype & IS_NUMBER_NEG)) {
2106 if (value <= (UV)IV_MAX) {
2107 SvIV_set(sv, (IV)value);
2109 /* it didn't overflow, and it was positive. */
2110 SvUV_set(sv, value);
2114 /* 2s complement assumption */
2115 if (value <= (UV)IV_MIN) {
2116 SvIV_set(sv, -(IV)value);
2118 /* Too negative for an IV. This is a double upgrade, but
2119 I'm assuming it will be rare. */
2120 if (SvTYPE(sv) < SVt_PVNV)
2121 sv_upgrade(sv, SVt_PVNV);
2125 SvNV_set(sv, -(NV)value);
2126 SvIV_set(sv, IV_MIN);
2130 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2131 will be in the previous block to set the IV slot, and the next
2132 block to set the NV slot. So no else here. */
2134 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2135 != IS_NUMBER_IN_UV) {
2136 /* It wasn't an (integer that doesn't overflow the UV). */
2137 SvNV_set(sv, Atof(SvPVX_const(sv)));
2139 if (! numtype && ckWARN(WARN_NUMERIC))
2142 #if defined(USE_LONG_DOUBLE)
2143 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2144 PTR2UV(sv), SvNVX(sv)));
2146 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2147 PTR2UV(sv), SvNVX(sv)));
2150 #ifdef NV_PRESERVES_UV
2151 (void)SvIOKp_on(sv);
2153 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2154 SvIV_set(sv, I_V(SvNVX(sv)));
2155 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2158 NOOP; /* Integer is imprecise. NOK, IOKp */
2160 /* UV will not work better than IV */
2162 if (SvNVX(sv) > (NV)UV_MAX) {
2164 /* Integer is inaccurate. NOK, IOKp, is UV */
2165 SvUV_set(sv, UV_MAX);
2167 SvUV_set(sv, U_V(SvNVX(sv)));
2168 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2169 NV preservse UV so can do correct comparison. */
2170 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2173 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2178 #else /* NV_PRESERVES_UV */
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2181 /* The IV/UV slot will have been set from value returned by
2182 grok_number above. The NV slot has just been set using
2185 assert (SvIOKp(sv));
2187 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2188 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2189 /* Small enough to preserve all bits. */
2190 (void)SvIOKp_on(sv);
2192 SvIV_set(sv, I_V(SvNVX(sv)));
2193 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2195 /* Assumption: first non-preserved integer is < IV_MAX,
2196 this NV is in the preserved range, therefore: */
2197 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2199 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);
2203 0 0 already failed to read UV.
2204 0 1 already failed to read UV.
2205 1 0 you won't get here in this case. IV/UV
2206 slot set, public IOK, Atof() unneeded.
2207 1 1 already read UV.
2208 so there's no point in sv_2iuv_non_preserve() attempting
2209 to use atol, strtol, strtoul etc. */
2211 sv_2iuv_non_preserve (sv, numtype);
2213 sv_2iuv_non_preserve (sv);
2217 #endif /* NV_PRESERVES_UV */
2218 /* It might be more code efficient to go through the entire logic above
2219 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2220 gets complex and potentially buggy, so more programmer efficient
2221 to do it this way, by turning off the public flags: */
2223 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2227 if (isGV_with_GP(sv))
2228 return glob_2number((GV *)sv);
2230 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2231 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2234 if (SvTYPE(sv) < SVt_IV)
2235 /* Typically the caller expects that sv_any is not NULL now. */
2236 sv_upgrade(sv, SVt_IV);
2237 /* Return 0 from the caller. */
2244 =for apidoc sv_2iv_flags
2246 Return the integer value of an SV, doing any necessary string
2247 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2248 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2254 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2259 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2260 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2261 cache IVs just in case. In practice it seems that they never
2262 actually anywhere accessible by user Perl code, let alone get used
2263 in anything other than a string context. */
2264 if (flags & SV_GMAGIC)
2269 return I_V(SvNVX(sv));
2271 if (SvPOKp(sv) && SvLEN(sv)) {
2274 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2276 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2277 == IS_NUMBER_IN_UV) {
2278 /* It's definitely an integer */
2279 if (numtype & IS_NUMBER_NEG) {
2280 if (value < (UV)IV_MIN)
2283 if (value < (UV)IV_MAX)
2288 if (ckWARN(WARN_NUMERIC))
2291 return I_V(Atof(SvPVX_const(sv)));
2296 assert(SvTYPE(sv) >= SVt_PVMG);
2297 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2298 } else if (SvTHINKFIRST(sv)) {
2302 SV * const tmpstr=AMG_CALLun(sv,numer);
2303 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2304 return SvIV(tmpstr);
2307 return PTR2IV(SvRV(sv));
2310 sv_force_normal_flags(sv, 0);
2312 if (SvREADONLY(sv) && !SvOK(sv)) {
2313 if (ckWARN(WARN_UNINITIALIZED))
2319 if (S_sv_2iuv_common(aTHX_ sv))
2322 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2323 PTR2UV(sv),SvIVX(sv)));
2324 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2328 =for apidoc sv_2uv_flags
2330 Return the unsigned integer value of an SV, doing any necessary string
2331 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2332 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2338 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2343 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2344 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2345 cache IVs just in case. */
2346 if (flags & SV_GMAGIC)
2351 return U_V(SvNVX(sv));
2352 if (SvPOKp(sv) && SvLEN(sv)) {
2355 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2357 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2358 == IS_NUMBER_IN_UV) {
2359 /* It's definitely an integer */
2360 if (!(numtype & IS_NUMBER_NEG))
2364 if (ckWARN(WARN_NUMERIC))
2367 return U_V(Atof(SvPVX_const(sv)));
2372 assert(SvTYPE(sv) >= SVt_PVMG);
2373 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2374 } else if (SvTHINKFIRST(sv)) {
2378 SV *const tmpstr = AMG_CALLun(sv,numer);
2379 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2380 return SvUV(tmpstr);
2383 return PTR2UV(SvRV(sv));
2386 sv_force_normal_flags(sv, 0);
2388 if (SvREADONLY(sv) && !SvOK(sv)) {
2389 if (ckWARN(WARN_UNINITIALIZED))
2395 if (S_sv_2iuv_common(aTHX_ sv))
2399 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2400 PTR2UV(sv),SvUVX(sv)));
2401 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2407 Return the num value of an SV, doing any necessary string or integer
2408 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2415 Perl_sv_2nv(pTHX_ register SV *const sv)
2420 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2421 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2422 cache IVs just in case. */
2426 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2427 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2428 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2430 return Atof(SvPVX_const(sv));
2434 return (NV)SvUVX(sv);
2436 return (NV)SvIVX(sv);
2441 assert(SvTYPE(sv) >= SVt_PVMG);
2442 /* This falls through to the report_uninit near the end of the
2444 } else if (SvTHINKFIRST(sv)) {
2448 SV *const tmpstr = AMG_CALLun(sv,numer);
2449 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2450 return SvNV(tmpstr);
2453 return PTR2NV(SvRV(sv));
2456 sv_force_normal_flags(sv, 0);
2458 if (SvREADONLY(sv) && !SvOK(sv)) {
2459 if (ckWARN(WARN_UNINITIALIZED))
2464 if (SvTYPE(sv) < SVt_NV) {
2465 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2466 sv_upgrade(sv, SVt_NV);
2467 #ifdef USE_LONG_DOUBLE
2469 STORE_NUMERIC_LOCAL_SET_STANDARD();
2470 PerlIO_printf(Perl_debug_log,
2471 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2472 PTR2UV(sv), SvNVX(sv));
2473 RESTORE_NUMERIC_LOCAL();
2477 STORE_NUMERIC_LOCAL_SET_STANDARD();
2478 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2479 PTR2UV(sv), SvNVX(sv));
2480 RESTORE_NUMERIC_LOCAL();
2484 else if (SvTYPE(sv) < SVt_PVNV)
2485 sv_upgrade(sv, SVt_PVNV);
2490 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2491 #ifdef NV_PRESERVES_UV
2497 /* Only set the public NV OK flag if this NV preserves the IV */
2498 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2500 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2501 : (SvIVX(sv) == I_V(SvNVX(sv))))
2507 else if (SvPOKp(sv) && SvLEN(sv)) {
2509 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2510 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2512 #ifdef NV_PRESERVES_UV
2513 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2514 == IS_NUMBER_IN_UV) {
2515 /* It's definitely an integer */
2516 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2518 SvNV_set(sv, Atof(SvPVX_const(sv)));
2524 SvNV_set(sv, Atof(SvPVX_const(sv)));
2525 /* Only set the public NV OK flag if this NV preserves the value in
2526 the PV at least as well as an IV/UV would.
2527 Not sure how to do this 100% reliably. */
2528 /* if that shift count is out of range then Configure's test is
2529 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2531 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2532 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2533 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2534 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2535 /* Can't use strtol etc to convert this string, so don't try.
2536 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2539 /* value has been set. It may not be precise. */
2540 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2541 /* 2s complement assumption for (UV)IV_MIN */
2542 SvNOK_on(sv); /* Integer is too negative. */
2547 if (numtype & IS_NUMBER_NEG) {
2548 SvIV_set(sv, -(IV)value);
2549 } else if (value <= (UV)IV_MAX) {
2550 SvIV_set(sv, (IV)value);
2552 SvUV_set(sv, value);
2556 if (numtype & IS_NUMBER_NOT_INT) {
2557 /* I believe that even if the original PV had decimals,
2558 they are lost beyond the limit of the FP precision.
2559 However, neither is canonical, so both only get p
2560 flags. NWC, 2000/11/25 */
2561 /* Both already have p flags, so do nothing */
2563 const NV nv = SvNVX(sv);
2564 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2565 if (SvIVX(sv) == I_V(nv)) {
2568 /* It had no "." so it must be integer. */
2572 /* between IV_MAX and NV(UV_MAX).
2573 Could be slightly > UV_MAX */
2575 if (numtype & IS_NUMBER_NOT_INT) {
2576 /* UV and NV both imprecise. */
2578 const UV nv_as_uv = U_V(nv);
2580 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2589 /* It might be more code efficient to go through the entire logic above
2590 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2591 gets complex and potentially buggy, so more programmer efficient
2592 to do it this way, by turning off the public flags: */
2594 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2595 #endif /* NV_PRESERVES_UV */
2598 if (isGV_with_GP(sv)) {
2599 glob_2number((GV *)sv);
2603 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2605 assert (SvTYPE(sv) >= SVt_NV);
2606 /* Typically the caller expects that sv_any is not NULL now. */
2607 /* XXX Ilya implies that this is a bug in callers that assume this
2608 and ideally should be fixed. */
2611 #if defined(USE_LONG_DOUBLE)
2613 STORE_NUMERIC_LOCAL_SET_STANDARD();
2614 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2615 PTR2UV(sv), SvNVX(sv));
2616 RESTORE_NUMERIC_LOCAL();
2620 STORE_NUMERIC_LOCAL_SET_STANDARD();
2621 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2622 PTR2UV(sv), SvNVX(sv));
2623 RESTORE_NUMERIC_LOCAL();
2632 Return an SV with the numeric value of the source SV, doing any necessary
2633 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2634 access this function.
2640 Perl_sv_2num(pTHX_ register SV *const sv)
2642 PERL_ARGS_ASSERT_SV_2NUM;
2647 SV * const tmpsv = AMG_CALLun(sv,numer);
2648 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2649 return sv_2num(tmpsv);
2651 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2654 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2655 * UV as a string towards the end of buf, and return pointers to start and
2658 * We assume that buf is at least TYPE_CHARS(UV) long.
2662 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2664 char *ptr = buf + TYPE_CHARS(UV);
2665 char * const ebuf = ptr;
2668 PERL_ARGS_ASSERT_UIV_2BUF;
2680 *--ptr = '0' + (char)(uv % 10);
2689 =for apidoc sv_2pv_flags
2691 Returns a pointer to the string value of an SV, and sets *lp to its length.
2692 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2694 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2695 usually end up here too.
2701 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2711 if (SvGMAGICAL(sv)) {
2712 if (flags & SV_GMAGIC)
2717 if (flags & SV_MUTABLE_RETURN)
2718 return SvPVX_mutable(sv);
2719 if (flags & SV_CONST_RETURN)
2720 return (char *)SvPVX_const(sv);
2723 if (SvIOKp(sv) || SvNOKp(sv)) {
2724 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2729 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2730 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2732 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2739 #ifdef FIXNEGATIVEZERO
2740 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2746 SvUPGRADE(sv, SVt_PV);
2749 s = SvGROW_mutable(sv, len + 1);
2752 return (char*)memcpy(s, tbuf, len + 1);
2758 assert(SvTYPE(sv) >= SVt_PVMG);
2759 /* This falls through to the report_uninit near the end of the
2761 } else if (SvTHINKFIRST(sv)) {
2765 SV *const tmpstr = AMG_CALLun(sv,string);
2766 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2768 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2772 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2773 if (flags & SV_CONST_RETURN) {
2774 pv = (char *) SvPVX_const(tmpstr);
2776 pv = (flags & SV_MUTABLE_RETURN)
2777 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2780 *lp = SvCUR(tmpstr);
2782 pv = sv_2pv_flags(tmpstr, lp, flags);
2795 const SV *const referent = (SV*)SvRV(sv);
2799 retval = buffer = savepvn("NULLREF", len);
2800 } else if (SvTYPE(referent) == SVt_REGEXP) {
2801 const REGEXP * const re = (REGEXP *)referent;
2806 /* If the regex is UTF-8 we want the containing scalar to
2807 have an UTF-8 flag too */
2813 if ((seen_evals = RX_SEEN_EVALS(re)))
2814 PL_reginterp_cnt += seen_evals;
2817 *lp = RX_WRAPLEN(re);
2819 return RX_WRAPPED(re);
2821 const char *const typestr = sv_reftype(referent, 0);
2822 const STRLEN typelen = strlen(typestr);
2823 UV addr = PTR2UV(referent);
2824 const char *stashname = NULL;
2825 STRLEN stashnamelen = 0; /* hush, gcc */
2826 const char *buffer_end;
2828 if (SvOBJECT(referent)) {
2829 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2832 stashname = HEK_KEY(name);
2833 stashnamelen = HEK_LEN(name);
2835 if (HEK_UTF8(name)) {
2841 stashname = "__ANON__";
2844 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2845 + 2 * sizeof(UV) + 2 /* )\0 */;
2847 len = typelen + 3 /* (0x */
2848 + 2 * sizeof(UV) + 2 /* )\0 */;
2851 Newx(buffer, len, char);
2852 buffer_end = retval = buffer + len;
2854 /* Working backwards */
2858 *--retval = PL_hexdigit[addr & 15];
2859 } while (addr >>= 4);
2865 memcpy(retval, typestr, typelen);
2869 retval -= stashnamelen;
2870 memcpy(retval, stashname, stashnamelen);
2872 /* retval may not neccesarily have reached the start of the
2874 assert (retval >= buffer);
2876 len = buffer_end - retval - 1; /* -1 for that \0 */
2884 if (SvREADONLY(sv) && !SvOK(sv)) {
2887 if (flags & SV_UNDEF_RETURNS_NULL)
2889 if (ckWARN(WARN_UNINITIALIZED))
2894 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2895 /* I'm assuming that if both IV and NV are equally valid then
2896 converting the IV is going to be more efficient */
2897 const U32 isUIOK = SvIsUV(sv);
2898 char buf[TYPE_CHARS(UV)];
2902 if (SvTYPE(sv) < SVt_PVIV)
2903 sv_upgrade(sv, SVt_PVIV);
2904 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2906 /* inlined from sv_setpvn */
2907 s = SvGROW_mutable(sv, len + 1);
2908 Move(ptr, s, len, char);
2912 else if (SvNOKp(sv)) {
2913 const int olderrno = errno;
2914 if (SvTYPE(sv) < SVt_PVNV)
2915 sv_upgrade(sv, SVt_PVNV);
2916 /* The +20 is pure guesswork. Configure test needed. --jhi */
2917 s = SvGROW_mutable(sv, NV_DIG + 20);
2918 /* some Xenix systems wipe out errno here */
2920 if (SvNVX(sv) == 0.0)
2921 my_strlcpy(s, "0", SvLEN(sv));
2925 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2928 #ifdef FIXNEGATIVEZERO
2929 if (*s == '-' && s[1] == '0' && !s[2]) {
2941 if (isGV_with_GP(sv))
2942 return glob_2pv((GV *)sv, lp);
2946 if (flags & SV_UNDEF_RETURNS_NULL)
2948 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2950 if (SvTYPE(sv) < SVt_PV)
2951 /* Typically the caller expects that sv_any is not NULL now. */
2952 sv_upgrade(sv, SVt_PV);
2956 const STRLEN len = s - SvPVX_const(sv);
2962 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2963 PTR2UV(sv),SvPVX_const(sv)));
2964 if (flags & SV_CONST_RETURN)
2965 return (char *)SvPVX_const(sv);
2966 if (flags & SV_MUTABLE_RETURN)
2967 return SvPVX_mutable(sv);
2972 =for apidoc sv_copypv
2974 Copies a stringified representation of the source SV into the
2975 destination SV. Automatically performs any necessary mg_get and
2976 coercion of numeric values into strings. Guaranteed to preserve
2977 UTF8 flag even from overloaded objects. Similar in nature to
2978 sv_2pv[_flags] but operates directly on an SV instead of just the
2979 string. Mostly uses sv_2pv_flags to do its work, except when that
2980 would lose the UTF-8'ness of the PV.
2986 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2989 const char * const s = SvPV_const(ssv,len);
2991 PERL_ARGS_ASSERT_SV_COPYPV;
2993 sv_setpvn(dsv,s,len);
3001 =for apidoc sv_2pvbyte
3003 Return a pointer to the byte-encoded representation of the SV, and set *lp
3004 to its length. May cause the SV to be downgraded from UTF-8 as a
3007 Usually accessed via the C<SvPVbyte> macro.
3013 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3015 PERL_ARGS_ASSERT_SV_2PVBYTE;
3017 sv_utf8_downgrade(sv,0);
3018 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3022 =for apidoc sv_2pvutf8
3024 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3025 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3027 Usually accessed via the C<SvPVutf8> macro.
3033 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3035 PERL_ARGS_ASSERT_SV_2PVUTF8;
3037 sv_utf8_upgrade(sv);
3038 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3043 =for apidoc sv_2bool
3045 This function is only called on magical items, and is only used by
3046 sv_true() or its macro equivalent.
3052 Perl_sv_2bool(pTHX_ register SV *const sv)
3056 PERL_ARGS_ASSERT_SV_2BOOL;
3064 SV * const tmpsv = AMG_CALLun(sv,bool_);
3065 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3066 return (bool)SvTRUE(tmpsv);
3068 return SvRV(sv) != 0;
3071 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3073 (*sv->sv_u.svu_pv > '0' ||
3074 Xpvtmp->xpv_cur > 1 ||
3075 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3082 return SvIVX(sv) != 0;
3085 return SvNVX(sv) != 0.0;
3087 if (isGV_with_GP(sv))
3097 =for apidoc sv_utf8_upgrade
3099 Converts the PV of an SV to its UTF-8-encoded form.
3100 Forces the SV to string form if it is not already.
3101 Always sets the SvUTF8 flag to avoid future validity checks even
3102 if all the bytes have hibit clear.
3104 This is not as a general purpose byte encoding to Unicode interface:
3105 use the Encode extension for that.
3107 =for apidoc sv_utf8_upgrade_flags
3109 Converts the PV of an SV to its UTF-8-encoded form.
3110 Forces the SV to string form if it is not already.
3111 Always sets the SvUTF8 flag to avoid future validity checks even
3112 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3113 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3114 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3116 This is not as a general purpose byte encoding to Unicode interface:
3117 use the Encode extension for that.
3123 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3127 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3129 if (sv == &PL_sv_undef)
3133 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3134 (void) sv_2pv_flags(sv,&len, flags);
3138 (void) SvPV_force(sv,len);
3147 sv_force_normal_flags(sv, 0);
3150 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3151 sv_recode_to_utf8(sv, PL_encoding);
3152 else { /* Assume Latin-1/EBCDIC */
3153 /* This function could be much more efficient if we
3154 * had a FLAG in SVs to signal if there are any hibit
3155 * chars in the PV. Given that there isn't such a flag
3156 * make the loop as fast as possible. */
3157 const U8 * const s = (U8 *) SvPVX_const(sv);
3158 const U8 * const e = (U8 *) SvEND(sv);
3163 /* Check for hi bit */
3164 if (!NATIVE_IS_INVARIANT(ch)) {
3165 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3166 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3168 SvPV_free(sv); /* No longer using what was there before. */
3169 SvPV_set(sv, (char*)recoded);
3170 SvCUR_set(sv, len - 1);
3171 SvLEN_set(sv, len); /* No longer know the real size. */
3175 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3182 =for apidoc sv_utf8_downgrade
3184 Attempts to convert the PV of an SV from characters to bytes.
3185 If the PV contains a character beyond byte, this conversion will fail;
3186 in this case, either returns false or, if C<fail_ok> is not
3189 This is not as a general purpose Unicode to byte encoding interface:
3190 use the Encode extension for that.
3196 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3200 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3202 if (SvPOKp(sv) && SvUTF8(sv)) {
3208 sv_force_normal_flags(sv, 0);
3210 s = (U8 *) SvPV(sv, len);
3211 if (!utf8_to_bytes(s, &len)) {
3216 Perl_croak(aTHX_ "Wide character in %s",
3219 Perl_croak(aTHX_ "Wide character");
3230 =for apidoc sv_utf8_encode
3232 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3233 flag off so that it looks like octets again.
3239 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3241 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3244 sv_force_normal_flags(sv, 0);
3246 if (SvREADONLY(sv)) {
3247 Perl_croak(aTHX_ PL_no_modify);
3249 (void) sv_utf8_upgrade(sv);
3254 =for apidoc sv_utf8_decode
3256 If the PV of the SV is an octet sequence in UTF-8
3257 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3258 so that it looks like a character. If the PV contains only single-byte
3259 characters, the C<SvUTF8> flag stays being off.
3260 Scans PV for validity and returns false if the PV is invalid UTF-8.
3266 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3268 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3274 /* The octets may have got themselves encoded - get them back as
3277 if (!sv_utf8_downgrade(sv, TRUE))
3280 /* it is actually just a matter of turning the utf8 flag on, but
3281 * we want to make sure everything inside is valid utf8 first.
3283 c = (const U8 *) SvPVX_const(sv);
3284 if (!is_utf8_string(c, SvCUR(sv)+1))
3286 e = (const U8 *) SvEND(sv);
3289 if (!UTF8_IS_INVARIANT(ch)) {
3299 =for apidoc sv_setsv
3301 Copies the contents of the source SV C<ssv> into the destination SV
3302 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3303 function if the source SV needs to be reused. Does not handle 'set' magic.
3304 Loosely speaking, it performs a copy-by-value, obliterating any previous
3305 content of the destination.
3307 You probably want to use one of the assortment of wrappers, such as
3308 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3309 C<SvSetMagicSV_nosteal>.
3311 =for apidoc sv_setsv_flags
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.
3318 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3319 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3320 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3321 and C<sv_setsv_nomg> are implemented in terms of this function.
3323 You probably want to use one of the assortment of wrappers, such as
3324 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3325 C<SvSetMagicSV_nosteal>.
3327 This is the primary function for copying scalars, and most other
3328 copy-ish functions and macros use this underneath.
3334 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3336 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3338 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3340 if (dtype != SVt_PVGV) {
3341 const char * const name = GvNAME(sstr);
3342 const STRLEN len = GvNAMELEN(sstr);
3344 if (dtype >= SVt_PV) {
3350 SvUPGRADE(dstr, SVt_PVGV);
3351 (void)SvOK_off(dstr);
3352 /* FIXME - why are we doing this, then turning it off and on again
3354 isGV_with_GP_on(dstr);
3356 GvSTASH(dstr) = GvSTASH(sstr);
3358 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3359 gv_name_set((GV *)dstr, name, len, GV_ADD);
3360 SvFAKE_on(dstr); /* can coerce to non-glob */
3363 #ifdef GV_UNIQUE_CHECK
3364 if (GvUNIQUE((GV*)dstr)) {
3365 Perl_croak(aTHX_ PL_no_modify);
3369 if(GvGP((GV*)sstr)) {
3370 /* If source has method cache entry, clear it */
3372 SvREFCNT_dec(GvCV(sstr));
3376 /* If source has a real method, then a method is
3378 else if(GvCV((GV*)sstr)) {
3383 /* If dest already had a real method, that's a change as well */
3384 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3388 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3392 isGV_with_GP_off(dstr);
3393 (void)SvOK_off(dstr);
3394 isGV_with_GP_on(dstr);
3395 GvINTRO_off(dstr); /* one-shot flag */
3396 GvGP(dstr) = gp_ref(GvGP(sstr));
3397 if (SvTAINTED(sstr))
3399 if (GvIMPORTED(dstr) != GVf_IMPORTED
3400 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3402 GvIMPORTED_on(dstr);
3405 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3406 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3411 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3413 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3415 const int intro = GvINTRO(dstr);
3418 const U32 stype = SvTYPE(sref);
3420 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3422 #ifdef GV_UNIQUE_CHECK
3423 if (GvUNIQUE((GV*)dstr)) {
3424 Perl_croak(aTHX_ PL_no_modify);
3429 GvINTRO_off(dstr); /* one-shot flag */
3430 GvLINE(dstr) = CopLINE(PL_curcop);
3431 GvEGV(dstr) = (GV*)dstr;
3436 location = (SV **) &GvCV(dstr);
3437 import_flag = GVf_IMPORTED_CV;
3440 location = (SV **) &GvHV(dstr);
3441 import_flag = GVf_IMPORTED_HV;
3444 location = (SV **) &GvAV(dstr);
3445 import_flag = GVf_IMPORTED_AV;
3448 location = (SV **) &GvIOp(dstr);
3451 location = (SV **) &GvFORM(dstr);
3453 location = &GvSV(dstr);
3454 import_flag = GVf_IMPORTED_SV;
3457 if (stype == SVt_PVCV) {
3458 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3459 if (GvCVGEN(dstr)) {
3460 SvREFCNT_dec(GvCV(dstr));
3462 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3465 SAVEGENERICSV(*location);
3469 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3470 CV* const cv = (CV*)*location;
3472 if (!GvCVGEN((GV*)dstr) &&
3473 (CvROOT(cv) || CvXSUB(cv)))
3475 /* Redefining a sub - warning is mandatory if
3476 it was a const and its value changed. */
3477 if (CvCONST(cv) && CvCONST((CV*)sref)
3478 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3480 /* They are 2 constant subroutines generated from
3481 the same constant. This probably means that
3482 they are really the "same" proxy subroutine
3483 instantiated in 2 places. Most likely this is
3484 when a constant is exported twice. Don't warn.
3487 else if (ckWARN(WARN_REDEFINE)
3489 && (!CvCONST((CV*)sref)
3490 || sv_cmp(cv_const_sv(cv),
3491 cv_const_sv((CV*)sref))))) {
3492 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3495 ? "Constant subroutine %s::%s redefined"
3496 : "Subroutine %s::%s redefined"),
3497 HvNAME_get(GvSTASH((GV*)dstr)),
3498 GvENAME((GV*)dstr));
3502 cv_ckproto_len(cv, (GV*)dstr,
3503 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3504 SvPOK(sref) ? SvCUR(sref) : 0);
3506 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3507 GvASSUMECV_on(dstr);
3508 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3511 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3512 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3513 GvFLAGS(dstr) |= import_flag;
3518 if (SvTAINTED(sstr))
3524 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3527 register U32 sflags;
3529 register svtype stype;
3531 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3536 if (SvIS_FREED(dstr)) {
3537 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3538 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3540 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3542 sstr = &PL_sv_undef;
3543 if (SvIS_FREED(sstr)) {
3544 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3545 (void*)sstr, (void*)dstr);
3547 stype = SvTYPE(sstr);
3548 dtype = SvTYPE(dstr);
3550 (void)SvAMAGIC_off(dstr);
3553 /* need to nuke the magic */
3557 /* There's a lot of redundancy below but we're going for speed here */
3562 if (dtype != SVt_PVGV) {
3563 (void)SvOK_off(dstr);
3571 sv_upgrade(dstr, SVt_IV);
3575 sv_upgrade(dstr, SVt_PVIV);
3578 goto end_of_first_switch;
3580 (void)SvIOK_only(dstr);
3581 SvIV_set(dstr, SvIVX(sstr));
3584 /* SvTAINTED can only be true if the SV has taint magic, which in
3585 turn means that the SV type is PVMG (or greater). This is the
3586 case statement for SVt_IV, so this cannot be true (whatever gcov
3588 assert(!SvTAINTED(sstr));
3593 if (dtype < SVt_PV && dtype != SVt_IV)
3594 sv_upgrade(dstr, SVt_IV);
3602 sv_upgrade(dstr, SVt_NV);
3606 sv_upgrade(dstr, SVt_PVNV);
3609 goto end_of_first_switch;
3611 SvNV_set(dstr, SvNVX(sstr));
3612 (void)SvNOK_only(dstr);
3613 /* SvTAINTED can only be true if the SV has taint magic, which in
3614 turn means that the SV type is PVMG (or greater). This is the
3615 case statement for SVt_NV, so this cannot be true (whatever gcov
3617 assert(!SvTAINTED(sstr));
3623 #ifdef PERL_OLD_COPY_ON_WRITE
3624 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3625 if (dtype < SVt_PVIV)
3626 sv_upgrade(dstr, SVt_PVIV);
3634 sv_upgrade(dstr, SVt_PV);
3637 if (dtype < SVt_PVIV)
3638 sv_upgrade(dstr, SVt_PVIV);
3641 if (dtype < SVt_PVNV)
3642 sv_upgrade(dstr, SVt_PVNV);
3646 const char * const type = sv_reftype(sstr,0);
3648 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3650 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3654 /* case SVt_BIND: */
3657 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3658 glob_assign_glob(dstr, sstr, dtype);
3661 /* SvVALID means that this PVGV is playing at being an FBM. */
3665 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3667 if (SvTYPE(sstr) != stype) {
3668 stype = SvTYPE(sstr);
3669 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3670 glob_assign_glob(dstr, sstr, dtype);
3675 if (stype == SVt_PVLV)
3676 SvUPGRADE(dstr, SVt_PVNV);
3678 SvUPGRADE(dstr, (svtype)stype);
3680 end_of_first_switch:
3682 /* dstr may have been upgraded. */
3683 dtype = SvTYPE(dstr);
3684 sflags = SvFLAGS(sstr);
3686 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3687 /* Assigning to a subroutine sets the prototype. */
3690 const char *const ptr = SvPV_const(sstr, len);
3692 SvGROW(dstr, len + 1);
3693 Copy(ptr, SvPVX(dstr), len + 1, char);
3694 SvCUR_set(dstr, len);
3696 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3700 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3701 const char * const type = sv_reftype(dstr,0);
3703 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3705 Perl_croak(aTHX_ "Cannot copy to %s", type);
3706 } else if (sflags & SVf_ROK) {
3707 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3708 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3711 if (GvIMPORTED(dstr) != GVf_IMPORTED
3712 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3714 GvIMPORTED_on(dstr);
3719 if (isGV_with_GP(sstr)) {
3720 glob_assign_glob(dstr, sstr, dtype);
3725 if (dtype >= SVt_PV) {
3726 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3727 glob_assign_ref(dstr, sstr);
3730 if (SvPVX_const(dstr)) {
3736 (void)SvOK_off(dstr);
3737 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3738 SvFLAGS(dstr) |= sflags & SVf_ROK;
3739 assert(!(sflags & SVp_NOK));
3740 assert(!(sflags & SVp_IOK));
3741 assert(!(sflags & SVf_NOK));
3742 assert(!(sflags & SVf_IOK));
3744 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3745 if (!(sflags & SVf_OK)) {
3746 if (ckWARN(WARN_MISC))
3747 Perl_warner(aTHX_ packWARN(WARN_MISC),
3748 "Undefined value assigned to typeglob");
3751 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3752 if (dstr != (SV*)gv) {
3755 GvGP(dstr) = gp_ref(GvGP(gv));
3759 else if (sflags & SVp_POK) {
3763 * Check to see if we can just swipe the string. If so, it's a
3764 * possible small lose on short strings, but a big win on long ones.
3765 * It might even be a win on short strings if SvPVX_const(dstr)
3766 * has to be allocated and SvPVX_const(sstr) has to be freed.
3767 * Likewise if we can set up COW rather than doing an actual copy, we
3768 * drop to the else clause, as the swipe code and the COW setup code
3769 * have much in common.
3772 /* Whichever path we take through the next code, we want this true,
3773 and doing it now facilitates the COW check. */
3774 (void)SvPOK_only(dstr);
3777 /* If we're already COW then this clause is not true, and if COW
3778 is allowed then we drop down to the else and make dest COW
3779 with us. If caller hasn't said that we're allowed to COW
3780 shared hash keys then we don't do the COW setup, even if the
3781 source scalar is a shared hash key scalar. */
3782 (((flags & SV_COW_SHARED_HASH_KEYS)
3783 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3784 : 1 /* If making a COW copy is forbidden then the behaviour we
3785 desire is as if the source SV isn't actually already
3786 COW, even if it is. So we act as if the source flags
3787 are not COW, rather than actually testing them. */
3789 #ifndef PERL_OLD_COPY_ON_WRITE
3790 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3791 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3792 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3793 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3794 but in turn, it's somewhat dead code, never expected to go
3795 live, but more kept as a placeholder on how to do it better
3796 in a newer implementation. */
3797 /* If we are COW and dstr is a suitable target then we drop down
3798 into the else and make dest a COW of us. */
3799 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3804 (sflags & SVs_TEMP) && /* slated for free anyway? */
3805 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3806 (!(flags & SV_NOSTEAL)) &&
3807 /* and we're allowed to steal temps */
3808 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3809 SvLEN(sstr) && /* and really is a string */
3810 /* and won't be needed again, potentially */
3811 !(PL_op && PL_op->op_type == OP_AASSIGN))
3812 #ifdef PERL_OLD_COPY_ON_WRITE
3813 && ((flags & SV_COW_SHARED_HASH_KEYS)
3814 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3815 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3816 && SvTYPE(sstr) >= SVt_PVIV))
3820 /* Failed the swipe test, and it's not a shared hash key either.
3821 Have to copy the string. */
3822 STRLEN len = SvCUR(sstr);
3823 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3824 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3825 SvCUR_set(dstr, len);
3826 *SvEND(dstr) = '\0';
3828 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3830 /* Either it's a shared hash key, or it's suitable for
3831 copy-on-write or we can swipe the string. */
3833 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3837 #ifdef PERL_OLD_COPY_ON_WRITE
3839 /* I believe I should acquire a global SV mutex if
3840 it's a COW sv (not a shared hash key) to stop
3841 it going un copy-on-write.
3842 If the source SV has gone un copy on write between up there
3843 and down here, then (assert() that) it is of the correct
3844 form to make it copy on write again */
3845 if ((sflags & (SVf_FAKE | SVf_READONLY))
3846 != (SVf_FAKE | SVf_READONLY)) {
3847 SvREADONLY_on(sstr);
3849 /* Make the source SV into a loop of 1.
3850 (about to become 2) */
3851 SV_COW_NEXT_SV_SET(sstr, sstr);
3855 /* Initial code is common. */
3856 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3861 /* making another shared SV. */
3862 STRLEN cur = SvCUR(sstr);
3863 STRLEN len = SvLEN(sstr);
3864 #ifdef PERL_OLD_COPY_ON_WRITE
3866 assert (SvTYPE(dstr) >= SVt_PVIV);
3867 /* SvIsCOW_normal */
3868 /* splice us in between source and next-after-source. */
3869 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3870 SV_COW_NEXT_SV_SET(sstr, dstr);
3871 SvPV_set(dstr, SvPVX_mutable(sstr));
3875 /* SvIsCOW_shared_hash */
3876 DEBUG_C(PerlIO_printf(Perl_debug_log,
3877 "Copy on write: Sharing hash\n"));
3879 assert (SvTYPE(dstr) >= SVt_PV);
3881 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3883 SvLEN_set(dstr, len);
3884 SvCUR_set(dstr, cur);
3885 SvREADONLY_on(dstr);
3887 /* Relesase a global SV mutex. */
3890 { /* Passes the swipe test. */
3891 SvPV_set(dstr, SvPVX_mutable(sstr));
3892 SvLEN_set(dstr, SvLEN(sstr));
3893 SvCUR_set(dstr, SvCUR(sstr));
3896 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3897 SvPV_set(sstr, NULL);
3903 if (sflags & SVp_NOK) {
3904 SvNV_set(dstr, SvNVX(sstr));
3906 if (sflags & SVp_IOK) {
3907 SvIV_set(dstr, SvIVX(sstr));
3908 /* Must do this otherwise some other overloaded use of 0x80000000
3909 gets confused. I guess SVpbm_VALID */
3910 if (sflags & SVf_IVisUV)
3913 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3915 const MAGIC * const smg = SvVSTRING_mg(sstr);
3917 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3918 smg->mg_ptr, smg->mg_len);
3919 SvRMAGICAL_on(dstr);
3923 else if (sflags & (SVp_IOK|SVp_NOK)) {
3924 (void)SvOK_off(dstr);
3925 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3926 if (sflags & SVp_IOK) {
3927 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3928 SvIV_set(dstr, SvIVX(sstr));
3930 if (sflags & SVp_NOK) {
3931 SvNV_set(dstr, SvNVX(sstr));
3935 if (isGV_with_GP(sstr)) {
3936 /* This stringification rule for globs is spread in 3 places.
3937 This feels bad. FIXME. */
3938 const U32 wasfake = sflags & SVf_FAKE;
3940 /* FAKE globs can get coerced, so need to turn this off
3941 temporarily if it is on. */
3943 gv_efullname3(dstr, (GV *)sstr, "*");
3944 SvFLAGS(sstr) |= wasfake;
3947 (void)SvOK_off(dstr);
3949 if (SvTAINTED(sstr))
3954 =for apidoc sv_setsv_mg
3956 Like C<sv_setsv>, but also handles 'set' magic.
3962 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3964 PERL_ARGS_ASSERT_SV_SETSV_MG;
3966 sv_setsv(dstr,sstr);
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3972 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3974 STRLEN cur = SvCUR(sstr);
3975 STRLEN len = SvLEN(sstr);
3976 register char *new_pv;
3978 PERL_ARGS_ASSERT_SV_SETSV_COW;
3981 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3982 (void*)sstr, (void*)dstr);
3989 if (SvTHINKFIRST(dstr))
3990 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3991 else if (SvPVX_const(dstr))
3992 Safefree(SvPVX_const(dstr));
3996 SvUPGRADE(dstr, SVt_PVIV);
3998 assert (SvPOK(sstr));
3999 assert (SvPOKp(sstr));
4000 assert (!SvIOK(sstr));
4001 assert (!SvIOKp(sstr));
4002 assert (!SvNOK(sstr));
4003 assert (!SvNOKp(sstr));
4005 if (SvIsCOW(sstr)) {
4007 if (SvLEN(sstr) == 0) {
4008 /* source is a COW shared hash key. */
4009 DEBUG_C(PerlIO_printf(Perl_debug_log,
4010 "Fast copy on write: Sharing hash\n"));
4011 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4014 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4016 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4017 SvUPGRADE(sstr, SVt_PVIV);
4018 SvREADONLY_on(sstr);
4020 DEBUG_C(PerlIO_printf(Perl_debug_log,
4021 "Fast copy on write: Converting sstr to COW\n"));
4022 SV_COW_NEXT_SV_SET(dstr, sstr);
4024 SV_COW_NEXT_SV_SET(sstr, dstr);
4025 new_pv = SvPVX_mutable(sstr);
4028 SvPV_set(dstr, new_pv);
4029 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4032 SvLEN_set(dstr, len);
4033 SvCUR_set(dstr, cur);
4042 =for apidoc sv_setpvn
4044 Copies a string into an SV. The C<len> parameter indicates the number of
4045 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4046 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4052 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4055 register char *dptr;
4057 PERL_ARGS_ASSERT_SV_SETPVN;
4059 SV_CHECK_THINKFIRST_COW_DROP(sv);
4065 /* len is STRLEN which is unsigned, need to copy to signed */
4068 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4070 SvUPGRADE(sv, SVt_PV);
4072 dptr = SvGROW(sv, len + 1);
4073 Move(ptr,dptr,len,char);
4076 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4081 =for apidoc sv_setpvn_mg
4083 Like C<sv_setpvn>, but also handles 'set' magic.
4089 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4091 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4093 sv_setpvn(sv,ptr,len);
4098 =for apidoc sv_setpv
4100 Copies a string into an SV. The string must be null-terminated. Does not
4101 handle 'set' magic. See C<sv_setpv_mg>.
4107 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4110 register STRLEN len;
4112 PERL_ARGS_ASSERT_SV_SETPV;
4114 SV_CHECK_THINKFIRST_COW_DROP(sv);
4120 SvUPGRADE(sv, SVt_PV);
4122 SvGROW(sv, len + 1);
4123 Move(ptr,SvPVX(sv),len+1,char);
4125 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4130 =for apidoc sv_setpv_mg
4132 Like C<sv_setpv>, but also handles 'set' magic.
4138 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4140 PERL_ARGS_ASSERT_SV_SETPV_MG;
4147 =for apidoc sv_usepvn_flags
4149 Tells an SV to use C<ptr> to find its string value. Normally the
4150 string is stored inside the SV but sv_usepvn allows the SV to use an
4151 outside string. The C<ptr> should point to memory that was allocated
4152 by C<malloc>. The string length, C<len>, must be supplied. By default
4153 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4154 so that pointer should not be freed or used by the programmer after
4155 giving it to sv_usepvn, and neither should any pointers from "behind"
4156 that pointer (e.g. ptr + 1) be used.
4158 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4159 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4160 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4161 C<len>, and already meets the requirements for storing in C<SvPVX>)
4167 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4172 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4174 SV_CHECK_THINKFIRST_COW_DROP(sv);
4175 SvUPGRADE(sv, SVt_PV);
4178 if (flags & SV_SMAGIC)
4182 if (SvPVX_const(sv))
4186 if (flags & SV_HAS_TRAILING_NUL)
4187 assert(ptr[len] == '\0');
4190 allocate = (flags & SV_HAS_TRAILING_NUL)
4192 #ifdef Perl_safesysmalloc_size
4195 PERL_STRLEN_ROUNDUP(len + 1);
4197 if (flags & SV_HAS_TRAILING_NUL) {
4198 /* It's long enough - do nothing.
4199 Specfically Perl_newCONSTSUB is relying on this. */
4202 /* Force a move to shake out bugs in callers. */
4203 char *new_ptr = (char*)safemalloc(allocate);
4204 Copy(ptr, new_ptr, len, char);
4205 PoisonFree(ptr,len,char);
4209 ptr = (char*) saferealloc (ptr, allocate);
4212 #ifdef Perl_safesysmalloc_size
4213 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4215 SvLEN_set(sv, allocate);
4219 if (!(flags & SV_HAS_TRAILING_NUL)) {
4222 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4224 if (flags & SV_SMAGIC)
4228 #ifdef PERL_OLD_COPY_ON_WRITE
4229 /* Need to do this *after* making the SV normal, as we need the buffer
4230 pointer to remain valid until after we've copied it. If we let go too early,
4231 another thread could invalidate it by unsharing last of the same hash key
4232 (which it can do by means other than releasing copy-on-write Svs)
4233 or by changing the other copy-on-write SVs in the loop. */
4235 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4237 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4239 { /* this SV was SvIsCOW_normal(sv) */
4240 /* we need to find the SV pointing to us. */
4241 SV *current = SV_COW_NEXT_SV(after);
4243 if (current == sv) {
4244 /* The SV we point to points back to us (there were only two of us
4246 Hence other SV is no longer copy on write either. */
4248 SvREADONLY_off(after);
4250 /* We need to follow the pointers around the loop. */
4252 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4255 /* don't loop forever if the structure is bust, and we have
4256 a pointer into a closed loop. */
4257 assert (current != after);
4258 assert (SvPVX_const(current) == pvx);
4260 /* Make the SV before us point to the SV after us. */
4261 SV_COW_NEXT_SV_SET(current, after);
4267 =for apidoc sv_force_normal_flags
4269 Undo various types of fakery on an SV: if the PV is a shared string, make
4270 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4271 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4272 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4273 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4274 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4275 set to some other value.) In addition, the C<flags> parameter gets passed to
4276 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4277 with flags set to 0.
4283 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4287 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4289 #ifdef PERL_OLD_COPY_ON_WRITE
4290 if (SvREADONLY(sv)) {
4291 /* At this point I believe I should acquire a global SV mutex. */
4293 const char * const pvx = SvPVX_const(sv);
4294 const STRLEN len = SvLEN(sv);
4295 const STRLEN cur = SvCUR(sv);
4296 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4297 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4298 we'll fail an assertion. */
4299 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4302 PerlIO_printf(Perl_debug_log,
4303 "Copy on write: Force normal %ld\n",
4309 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4312 if (flags & SV_COW_DROP_PV) {
4313 /* OK, so we don't need to copy our buffer. */
4316 SvGROW(sv, cur + 1);
4317 Move(pvx,SvPVX(sv),cur,char);
4322 sv_release_COW(sv, pvx, next);
4324 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4330 else if (IN_PERL_RUNTIME)
4331 Perl_croak(aTHX_ PL_no_modify);
4332 /* At this point I believe that I can drop the global SV mutex. */
4335 if (SvREADONLY(sv)) {
4337 const char * const pvx = SvPVX_const(sv);
4338 const STRLEN len = SvCUR(sv);
4343 SvGROW(sv, len + 1);
4344 Move(pvx,SvPVX(sv),len,char);
4346 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4348 else if (IN_PERL_RUNTIME)
4349 Perl_croak(aTHX_ PL_no_modify);
4353 sv_unref_flags(sv, flags);
4354 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4361 Efficient removal of characters from the beginning of the string buffer.
4362 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4363 the string buffer. The C<ptr> becomes the first character of the adjusted
4364 string. Uses the "OOK hack".
4365 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4366 refer to the same chunk of data.
4372 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4378 const U8 *real_start;
4381 PERL_ARGS_ASSERT_SV_CHOP;
4383 if (!ptr || !SvPOKp(sv))
4385 delta = ptr - SvPVX_const(sv);
4387 /* Nothing to do. */
4390 assert(ptr > SvPVX_const(sv));
4391 SV_CHECK_THINKFIRST(sv);
4394 if (!SvLEN(sv)) { /* make copy of shared string */
4395 const char *pvx = SvPVX_const(sv);
4396 const STRLEN len = SvCUR(sv);
4397 SvGROW(sv, len + 1);
4398 Move(pvx,SvPVX(sv),len,char);
4401 SvFLAGS(sv) |= SVf_OOK;
4404 SvOOK_offset(sv, old_delta);
4406 SvLEN_set(sv, SvLEN(sv) - delta);
4407 SvCUR_set(sv, SvCUR(sv) - delta);
4408 SvPV_set(sv, SvPVX(sv) + delta);
4410 p = (U8 *)SvPVX_const(sv);
4415 real_start = p - delta;
4419 if (delta < 0x100) {
4423 p -= sizeof(STRLEN);
4424 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4428 /* Fill the preceding buffer with sentinals to verify that no-one is
4430 while (p > real_start) {
4438 =for apidoc sv_catpvn
4440 Concatenates the string onto the end of the string which is in the SV. The
4441 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4442 status set, then the bytes appended should be valid UTF-8.
4443 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4445 =for apidoc sv_catpvn_flags
4447 Concatenates the string onto the end of the string which is in the SV. The
4448 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4449 status set, then the bytes appended should be valid UTF-8.
4450 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4451 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4452 in terms of this function.
4458 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4462 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4464 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4466 SvGROW(dsv, dlen + slen + 1);
4468 sstr = SvPVX_const(dsv);
4469 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4470 SvCUR_set(dsv, SvCUR(dsv) + slen);
4472 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4474 if (flags & SV_SMAGIC)
4479 =for apidoc sv_catsv
4481 Concatenates the string from SV C<ssv> onto the end of the string in
4482 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4483 not 'set' magic. See C<sv_catsv_mg>.
4485 =for apidoc sv_catsv_flags
4487 Concatenates the string from SV C<ssv> onto the end of the string in
4488 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4489 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4490 and C<sv_catsv_nomg> are implemented in terms of this function.
4495 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4499 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4503 const char *spv = SvPV_const(ssv, slen);
4505 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4506 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4507 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4508 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4509 dsv->sv_flags doesn't have that bit set.
4510 Andy Dougherty 12 Oct 2001
4512 const I32 sutf8 = DO_UTF8(ssv);
4515 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4517 dutf8 = DO_UTF8(dsv);
4519 if (dutf8 != sutf8) {
4521 /* Not modifying source SV, so taking a temporary copy. */
4522 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4524 sv_utf8_upgrade(csv);
4525 spv = SvPV_const(csv, slen);
4528 sv_utf8_upgrade_nomg(dsv);
4530 sv_catpvn_nomg(dsv, spv, slen);
4533 if (flags & SV_SMAGIC)
4538 =for apidoc sv_catpv
4540 Concatenates the string onto the end of the string which is in the SV.
4541 If the SV has the UTF-8 status set, then the bytes appended should be
4542 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4547 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4550 register STRLEN len;
4554 PERL_ARGS_ASSERT_SV_CATPV;
4558 junk = SvPV_force(sv, tlen);
4560 SvGROW(sv, tlen + len + 1);
4562 ptr = SvPVX_const(sv);
4563 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4564 SvCUR_set(sv, SvCUR(sv) + len);
4565 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4570 =for apidoc sv_catpv_mg
4572 Like C<sv_catpv>, but also handles 'set' magic.
4578 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4580 PERL_ARGS_ASSERT_SV_CATPV_MG;
4589 Creates a new SV. A non-zero C<len> parameter indicates the number of
4590 bytes of preallocated string space the SV should have. An extra byte for a
4591 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4592 space is allocated.) The reference count for the new SV is set to 1.
4594 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4595 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4596 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4597 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4598 modules supporting older perls.
4604 Perl_newSV(pTHX_ const STRLEN len)
4611 sv_upgrade(sv, SVt_PV);
4612 SvGROW(sv, len + 1);
4617 =for apidoc sv_magicext
4619 Adds magic to an SV, upgrading it if necessary. Applies the
4620 supplied vtable and returns a pointer to the magic added.
4622 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4623 In particular, you can add magic to SvREADONLY SVs, and add more than
4624 one instance of the same 'how'.
4626 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4627 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4628 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4629 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4631 (This is now used as a subroutine by C<sv_magic>.)
4636 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4637 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4642 PERL_ARGS_ASSERT_SV_MAGICEXT;
4644 SvUPGRADE(sv, SVt_PVMG);
4645 Newxz(mg, 1, MAGIC);
4646 mg->mg_moremagic = SvMAGIC(sv);
4647 SvMAGIC_set(sv, mg);
4649 /* Sometimes a magic contains a reference loop, where the sv and
4650 object refer to each other. To prevent a reference loop that
4651 would prevent such objects being freed, we look for such loops
4652 and if we find one we avoid incrementing the object refcount.
4654 Note we cannot do this to avoid self-tie loops as intervening RV must
4655 have its REFCNT incremented to keep it in existence.
4658 if (!obj || obj == sv ||
4659 how == PERL_MAGIC_arylen ||
4660 how == PERL_MAGIC_symtab ||
4661 (SvTYPE(obj) == SVt_PVGV &&
4662 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4663 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4664 GvFORM(obj) == (CV*)sv)))
4669 mg->mg_obj = SvREFCNT_inc_simple(obj);
4670 mg->mg_flags |= MGf_REFCOUNTED;
4673 /* Normal self-ties simply pass a null object, and instead of
4674 using mg_obj directly, use the SvTIED_obj macro to produce a
4675 new RV as needed. For glob "self-ties", we are tieing the PVIO
4676 with an RV obj pointing to the glob containing the PVIO. In
4677 this case, to avoid a reference loop, we need to weaken the
4681 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4682 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4688 mg->mg_len = namlen;
4691 mg->mg_ptr = savepvn(name, namlen);
4692 else if (namlen == HEf_SVKEY)
4693 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4695 mg->mg_ptr = (char *) name;
4697 mg->mg_virtual = (MGVTBL *) vtable;
4701 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4706 =for apidoc sv_magic
4708 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4709 then adds a new magic item of type C<how> to the head of the magic list.
4711 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4712 handling of the C<name> and C<namlen> arguments.
4714 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4715 to add more than one instance of the same 'how'.
4721 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4722 const char *const name, const I32 namlen)
4725 const MGVTBL *vtable;
4728 PERL_ARGS_ASSERT_SV_MAGIC;
4730 #ifdef PERL_OLD_COPY_ON_WRITE
4732 sv_force_normal_flags(sv, 0);
4734 if (SvREADONLY(sv)) {
4736 /* its okay to attach magic to shared strings; the subsequent
4737 * upgrade to PVMG will unshare the string */
4738 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4741 && how != PERL_MAGIC_regex_global
4742 && how != PERL_MAGIC_bm
4743 && how != PERL_MAGIC_fm
4744 && how != PERL_MAGIC_sv
4745 && how != PERL_MAGIC_backref
4748 Perl_croak(aTHX_ PL_no_modify);
4751 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4752 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4753 /* sv_magic() refuses to add a magic of the same 'how' as an
4756 if (how == PERL_MAGIC_taint) {
4758 /* Any scalar which already had taint magic on which someone
4759 (erroneously?) did SvIOK_on() or similar will now be
4760 incorrectly sporting public "OK" flags. */
4761 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4769 vtable = &PL_vtbl_sv;
4771 case PERL_MAGIC_overload:
4772 vtable = &PL_vtbl_amagic;
4774 case PERL_MAGIC_overload_elem:
4775 vtable = &PL_vtbl_amagicelem;
4777 case PERL_MAGIC_overload_table:
4778 vtable = &PL_vtbl_ovrld;
4781 vtable = &PL_vtbl_bm;
4783 case PERL_MAGIC_regdata:
4784 vtable = &PL_vtbl_regdata;
4786 case PERL_MAGIC_regdatum:
4787 vtable = &PL_vtbl_regdatum;
4789 case PERL_MAGIC_env:
4790 vtable = &PL_vtbl_env;
4793 vtable = &PL_vtbl_fm;
4795 case PERL_MAGIC_envelem:
4796 vtable = &PL_vtbl_envelem;
4798 case PERL_MAGIC_regex_global:
4799 vtable = &PL_vtbl_mglob;
4801 case PERL_MAGIC_isa:
4802 vtable = &PL_vtbl_isa;
4804 case PERL_MAGIC_isaelem:
4805 vtable = &PL_vtbl_isaelem;
4807 case PERL_MAGIC_nkeys:
4808 vtable = &PL_vtbl_nkeys;
4810 case PERL_MAGIC_dbfile:
4813 case PERL_MAGIC_dbline:
4814 vtable = &PL_vtbl_dbline;
4816 #ifdef USE_LOCALE_COLLATE
4817 case PERL_MAGIC_collxfrm:
4818 vtable = &PL_vtbl_collxfrm;
4820 #endif /* USE_LOCALE_COLLATE */
4821 case PERL_MAGIC_tied:
4822 vtable = &PL_vtbl_pack;
4824 case PERL_MAGIC_tiedelem:
4825 case PERL_MAGIC_tiedscalar:
4826 vtable = &PL_vtbl_packelem;
4829 vtable = &PL_vtbl_regexp;
4831 case PERL_MAGIC_hints:
4832 /* As this vtable is all NULL, we can reuse it. */
4833 case PERL_MAGIC_sig:
4834 vtable = &PL_vtbl_sig;
4836 case PERL_MAGIC_sigelem:
4837 vtable = &PL_vtbl_sigelem;
4839 case PERL_MAGIC_taint:
4840 vtable = &PL_vtbl_taint;
4842 case PERL_MAGIC_uvar:
4843 vtable = &PL_vtbl_uvar;
4845 case PERL_MAGIC_vec:
4846 vtable = &PL_vtbl_vec;
4848 case PERL_MAGIC_arylen_p:
4849 case PERL_MAGIC_rhash:
4850 case PERL_MAGIC_symtab:
4851 case PERL_MAGIC_vstring:
4854 case PERL_MAGIC_utf8:
4855 vtable = &PL_vtbl_utf8;
4857 case PERL_MAGIC_substr:
4858 vtable = &PL_vtbl_substr;
4860 case PERL_MAGIC_defelem:
4861 vtable = &PL_vtbl_defelem;
4863 case PERL_MAGIC_arylen:
4864 vtable = &PL_vtbl_arylen;
4866 case PERL_MAGIC_pos:
4867 vtable = &PL_vtbl_pos;
4869 case PERL_MAGIC_backref:
4870 vtable = &PL_vtbl_backref;
4872 case PERL_MAGIC_hintselem:
4873 vtable = &PL_vtbl_hintselem;
4875 case PERL_MAGIC_ext:
4876 /* Reserved for use by extensions not perl internals. */
4877 /* Useful for attaching extension internal data to perl vars. */
4878 /* Note that multiple extensions may clash if magical scalars */
4879 /* etc holding private data from one are passed to another. */
4883 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4886 /* Rest of work is done else where */
4887 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4890 case PERL_MAGIC_taint:
4893 case PERL_MAGIC_ext:
4894 case PERL_MAGIC_dbfile:
4901 =for apidoc sv_unmagic
4903 Removes all magic of type C<type> from an SV.
4909 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4914 PERL_ARGS_ASSERT_SV_UNMAGIC;
4916 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4918 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4919 for (mg = *mgp; mg; mg = *mgp) {
4920 if (mg->mg_type == type) {
4921 const MGVTBL* const vtbl = mg->mg_virtual;
4922 *mgp = mg->mg_moremagic;
4923 if (vtbl && vtbl->svt_free)
4924 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4925 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4927 Safefree(mg->mg_ptr);
4928 else if (mg->mg_len == HEf_SVKEY)
4929 SvREFCNT_dec((SV*)mg->mg_ptr);
4930 else if (mg->mg_type == PERL_MAGIC_utf8)
4931 Safefree(mg->mg_ptr);
4933 if (mg->mg_flags & MGf_REFCOUNTED)
4934 SvREFCNT_dec(mg->mg_obj);
4938 mgp = &mg->mg_moremagic;
4942 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4943 SvMAGIC_set(sv, NULL);
4950 =for apidoc sv_rvweaken
4952 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4953 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4954 push a back-reference to this RV onto the array of backreferences
4955 associated with that magic. If the RV is magical, set magic will be
4956 called after the RV is cleared.
4962 Perl_sv_rvweaken(pTHX_ SV *const sv)
4966 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4968 if (!SvOK(sv)) /* let undefs pass */
4971 Perl_croak(aTHX_ "Can't weaken a nonreference");
4972 else if (SvWEAKREF(sv)) {
4973 if (ckWARN(WARN_MISC))
4974 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4978 Perl_sv_add_backref(aTHX_ tsv, sv);
4984 /* Give tsv backref magic if it hasn't already got it, then push a
4985 * back-reference to sv onto the array associated with the backref magic.
4989 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4994 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4996 if (SvTYPE(tsv) == SVt_PVHV) {
4997 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5001 /* There is no AV in the offical place - try a fixup. */
5002 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5005 /* Aha. They've got it stowed in magic. Bring it back. */
5006 av = (AV*)mg->mg_obj;
5007 /* Stop mg_free decreasing the refernce count. */
5009 /* Stop mg_free even calling the destructor, given that
5010 there's no AV to free up. */
5012 sv_unmagic(tsv, PERL_MAGIC_backref);
5016 SvREFCNT_inc_simple_void(av);
5021 const MAGIC *const mg
5022 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5024 av = (AV*)mg->mg_obj;
5028 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5029 /* av now has a refcnt of 2, which avoids it getting freed
5030 * before us during global cleanup. The extra ref is removed
5031 * by magic_killbackrefs() when tsv is being freed */
5034 if (AvFILLp(av) >= AvMAX(av)) {
5035 av_extend(av, AvFILLp(av)+1);
5037 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5040 /* delete a back-reference to ourselves from the backref magic associated
5041 * with the SV we point to.
5045 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5052 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5054 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5055 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5056 /* We mustn't attempt to "fix up" the hash here by moving the
5057 backreference array back to the hv_aux structure, as that is stored
5058 in the main HvARRAY(), and hfreentries assumes that no-one
5059 reallocates HvARRAY() while it is running. */
5062 const MAGIC *const mg
5063 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5065 av = (AV *)mg->mg_obj;
5068 if (PL_in_clean_all)
5070 Perl_croak(aTHX_ "panic: del_backref");
5077 /* We shouldn't be in here more than once, but for paranoia reasons lets
5079 for (i = AvFILLp(av); i >= 0; i--) {
5081 const SSize_t fill = AvFILLp(av);
5083 /* We weren't the last entry.
5084 An unordered list has this property that you can take the
5085 last element off the end to fill the hole, and it's still
5086 an unordered list :-)
5091 AvFILLp(av) = fill - 1;
5097 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5099 SV **svp = AvARRAY(av);
5101 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5102 PERL_UNUSED_ARG(sv);
5104 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5105 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5106 if (svp && !SvIS_FREED(av)) {
5107 SV *const *const last = svp + AvFILLp(av);
5109 while (svp <= last) {
5111 SV *const referrer = *svp;
5112 if (SvWEAKREF(referrer)) {
5113 /* XXX Should we check that it hasn't changed? */
5114 SvRV_set(referrer, 0);
5116 SvWEAKREF_off(referrer);
5117 SvSETMAGIC(referrer);
5118 } else if (SvTYPE(referrer) == SVt_PVGV ||
5119 SvTYPE(referrer) == SVt_PVLV) {
5120 /* You lookin' at me? */
5121 assert(GvSTASH(referrer));
5122 assert(GvSTASH(referrer) == (HV*)sv);
5123 GvSTASH(referrer) = 0;
5126 "panic: magic_killbackrefs (flags=%"UVxf")",
5127 (UV)SvFLAGS(referrer));
5135 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5140 =for apidoc sv_insert
5142 Inserts a string at the specified offset/length within the SV. Similar to
5143 the Perl substr() function. Handles get magic.
5145 =for apidoc sv_insert_flags
5147 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5153 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5158 register char *midend;
5159 register char *bigend;
5163 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5166 Perl_croak(aTHX_ "Can't modify non-existent substring");
5167 SvPV_force_flags(bigstr, curlen, flags);
5168 (void)SvPOK_only_UTF8(bigstr);
5169 if (offset + len > curlen) {
5170 SvGROW(bigstr, offset+len+1);
5171 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5172 SvCUR_set(bigstr, offset+len);
5176 i = littlelen - len;
5177 if (i > 0) { /* string might grow */
5178 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5179 mid = big + offset + len;
5180 midend = bigend = big + SvCUR(bigstr);
5183 while (midend > mid) /* shove everything down */
5184 *--bigend = *--midend;
5185 Move(little,big+offset,littlelen,char);
5186 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5191 Move(little,SvPVX(bigstr)+offset,len,char);
5196 big = SvPVX(bigstr);
5199 bigend = big + SvCUR(bigstr);
5201 if (midend > bigend)
5202 Perl_croak(aTHX_ "panic: sv_insert");
5204 if (mid - big > bigend - midend) { /* faster to shorten from end */
5206 Move(little, mid, littlelen,char);
5209 i = bigend - midend;
5211 Move(midend, mid, i,char);
5215 SvCUR_set(bigstr, mid - big);
5217 else if ((i = mid - big)) { /* faster from front */
5218 midend -= littlelen;
5220 Move(big, midend - i, i, char);
5221 sv_chop(bigstr,midend-i);
5223 Move(little, mid, littlelen,char);
5225 else if (littlelen) {
5226 midend -= littlelen;
5227 sv_chop(bigstr,midend);
5228 Move(little,midend,littlelen,char);
5231 sv_chop(bigstr,midend);
5237 =for apidoc sv_replace
5239 Make the first argument a copy of the second, then delete the original.
5240 The target SV physically takes over ownership of the body of the source SV
5241 and inherits its flags; however, the target keeps any magic it owns,
5242 and any magic in the source is discarded.
5243 Note that this is a rather specialist SV copying operation; most of the
5244 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5250 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5253 const U32 refcnt = SvREFCNT(sv);
5255 PERL_ARGS_ASSERT_SV_REPLACE;
5257 SV_CHECK_THINKFIRST_COW_DROP(sv);
5258 if (SvREFCNT(nsv) != 1) {
5259 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5260 UVuf " != 1)", (UV) SvREFCNT(nsv));
5262 if (SvMAGICAL(sv)) {
5266 sv_upgrade(nsv, SVt_PVMG);
5267 SvMAGIC_set(nsv, SvMAGIC(sv));
5268 SvFLAGS(nsv) |= SvMAGICAL(sv);
5270 SvMAGIC_set(sv, NULL);
5274 assert(!SvREFCNT(sv));
5275 #ifdef DEBUG_LEAKING_SCALARS
5276 sv->sv_flags = nsv->sv_flags;
5277 sv->sv_any = nsv->sv_any;
5278 sv->sv_refcnt = nsv->sv_refcnt;
5279 sv->sv_u = nsv->sv_u;
5281 StructCopy(nsv,sv,SV);
5283 if(SvTYPE(sv) == SVt_IV) {
5285 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5289 #ifdef PERL_OLD_COPY_ON_WRITE
5290 if (SvIsCOW_normal(nsv)) {
5291 /* We need to follow the pointers around the loop to make the
5292 previous SV point to sv, rather than nsv. */
5295 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5298 assert(SvPVX_const(current) == SvPVX_const(nsv));
5300 /* Make the SV before us point to the SV after us. */
5302 PerlIO_printf(Perl_debug_log, "previous is\n");
5304 PerlIO_printf(Perl_debug_log,
5305 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5306 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5308 SV_COW_NEXT_SV_SET(current, sv);
5311 SvREFCNT(sv) = refcnt;
5312 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5318 =for apidoc sv_clear
5320 Clear an SV: call any destructors, free up any memory used by the body,
5321 and free the body itself. The SV's head is I<not> freed, although
5322 its type is set to all 1's so that it won't inadvertently be assumed
5323 to be live during global destruction etc.
5324 This function should only be called when REFCNT is zero. Most of the time
5325 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5332 Perl_sv_clear(pTHX_ register SV *const sv)
5335 const U32 type = SvTYPE(sv);
5336 const struct body_details *const sv_type_details
5337 = bodies_by_type + type;
5340 PERL_ARGS_ASSERT_SV_CLEAR;
5341 assert(SvREFCNT(sv) == 0);
5342 assert(SvTYPE(sv) != SVTYPEMASK);
5344 if (type <= SVt_IV) {
5345 /* See the comment in sv.h about the collusion between this early
5346 return and the overloading of the NULL and IV slots in the size
5349 SV * const target = SvRV(sv);
5351 sv_del_backref(target, sv);
5353 SvREFCNT_dec(target);
5355 SvFLAGS(sv) &= SVf_BREAK;
5356 SvFLAGS(sv) |= SVTYPEMASK;
5361 if (PL_defstash && /* Still have a symbol table? */
5368 stash = SvSTASH(sv);
5369 destructor = StashHANDLER(stash,DESTROY);
5371 SV* const tmpref = newRV(sv);
5372 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5374 PUSHSTACKi(PERLSI_DESTROY);
5379 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5385 if(SvREFCNT(tmpref) < 2) {
5386 /* tmpref is not kept alive! */
5388 SvRV_set(tmpref, NULL);
5391 SvREFCNT_dec(tmpref);
5393 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5397 if (PL_in_clean_objs)
5398 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5400 /* DESTROY gave object new lease on life */
5406 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5407 SvOBJECT_off(sv); /* Curse the object. */
5408 if (type != SVt_PVIO)
5409 --PL_sv_objcount; /* XXX Might want something more general */
5412 if (type >= SVt_PVMG) {
5413 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5414 SvREFCNT_dec(SvOURSTASH(sv));
5415 } else if (SvMAGIC(sv))
5417 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5418 SvREFCNT_dec(SvSTASH(sv));
5421 /* case SVt_BIND: */
5424 IoIFP(sv) != PerlIO_stdin() &&
5425 IoIFP(sv) != PerlIO_stdout() &&
5426 IoIFP(sv) != PerlIO_stderr())
5428 io_close((IO*)sv, FALSE);
5430 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5431 PerlDir_close(IoDIRP(sv));
5432 IoDIRP(sv) = (DIR*)NULL;
5433 Safefree(IoTOP_NAME(sv));
5434 Safefree(IoFMT_NAME(sv));
5435 Safefree(IoBOTTOM_NAME(sv));
5438 /* FIXME for plugins */
5439 pregfree2((REGEXP*) sv);
5446 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5450 if (PL_comppad == (AV*)sv) {
5457 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5458 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5459 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5460 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5462 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5463 SvREFCNT_dec(LvTARG(sv));
5465 if (isGV_with_GP(sv)) {
5466 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5467 mro_method_changed_in(stash);
5470 unshare_hek(GvNAME_HEK(sv));
5471 /* If we're in a stash, we don't own a reference to it. However it does
5472 have a back reference to us, which needs to be cleared. */
5473 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5474 sv_del_backref((SV*)stash, sv);
5476 /* FIXME. There are probably more unreferenced pointers to SVs in the
5477 interpreter struct that we should check and tidy in a similar
5479 if ((GV*)sv == PL_last_in_gv)
5480 PL_last_in_gv = NULL;
5486 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5489 SvOOK_offset(sv, offset);
5490 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5491 /* Don't even bother with turning off the OOK flag. */
5494 SV * const target = SvRV(sv);
5496 sv_del_backref(target, sv);
5498 SvREFCNT_dec(target);
5500 #ifdef PERL_OLD_COPY_ON_WRITE
5501 else if (SvPVX_const(sv)) {
5503 /* I believe I need to grab the global SV mutex here and
5504 then recheck the COW status. */
5506 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5510 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5512 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5515 /* And drop it here. */
5517 } else if (SvLEN(sv)) {
5518 Safefree(SvPVX_const(sv));
5522 else if (SvPVX_const(sv) && SvLEN(sv))
5523 Safefree(SvPVX_mutable(sv));
5524 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5525 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5534 SvFLAGS(sv) &= SVf_BREAK;
5535 SvFLAGS(sv) |= SVTYPEMASK;
5537 if (sv_type_details->arena) {
5538 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5539 &PL_body_roots[type]);
5541 else if (sv_type_details->body_size) {
5542 my_safefree(SvANY(sv));
5547 =for apidoc sv_newref
5549 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5556 Perl_sv_newref(pTHX_ SV *const sv)
5558 PERL_UNUSED_CONTEXT;
5567 Decrement an SV's reference count, and if it drops to zero, call
5568 C<sv_clear> to invoke destructors and free up any memory used by
5569 the body; finally, deallocate the SV's head itself.
5570 Normally called via a wrapper macro C<SvREFCNT_dec>.
5576 Perl_sv_free(pTHX_ SV *const sv)
5581 if (SvREFCNT(sv) == 0) {
5582 if (SvFLAGS(sv) & SVf_BREAK)
5583 /* this SV's refcnt has been artificially decremented to
5584 * trigger cleanup */
5586 if (PL_in_clean_all) /* All is fair */
5588 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5589 /* make sure SvREFCNT(sv)==0 happens very seldom */
5590 SvREFCNT(sv) = (~(U32)0)/2;
5593 if (ckWARN_d(WARN_INTERNAL)) {
5594 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5595 Perl_dump_sv_child(aTHX_ sv);
5597 #ifdef DEBUG_LEAKING_SCALARS
5600 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5601 if (PL_warnhook == PERL_WARNHOOK_FATAL
5602 || ckDEAD(packWARN(WARN_INTERNAL))) {
5603 /* Don't let Perl_warner cause us to escape our fate: */
5607 /* This may not return: */
5608 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5609 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5610 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5613 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5618 if (--(SvREFCNT(sv)) > 0)
5620 Perl_sv_free2(aTHX_ sv);
5624 Perl_sv_free2(pTHX_ SV *const sv)
5628 PERL_ARGS_ASSERT_SV_FREE2;
5632 if (ckWARN_d(WARN_DEBUGGING))
5633 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5634 "Attempt to free temp prematurely: SV 0x%"UVxf
5635 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5639 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5640 /* make sure SvREFCNT(sv)==0 happens very seldom */
5641 SvREFCNT(sv) = (~(U32)0)/2;
5652 Returns the length of the string in the SV. Handles magic and type
5653 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5659 Perl_sv_len(pTHX_ register SV *const sv)
5667 len = mg_length(sv);
5669 (void)SvPV_const(sv, len);
5674 =for apidoc sv_len_utf8
5676 Returns the number of characters in the string in an SV, counting wide
5677 UTF-8 bytes as a single character. Handles magic and type coercion.
5683 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5684 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5685 * (Note that the mg_len is not the length of the mg_ptr field.
5686 * This allows the cache to store the character length of the string without
5687 * needing to malloc() extra storage to attach to the mg_ptr.)
5692 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5698 return mg_length(sv);
5702 const U8 *s = (U8*)SvPV_const(sv, len);
5706 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5708 if (mg && mg->mg_len != -1) {
5710 if (PL_utf8cache < 0) {
5711 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5713 /* Need to turn the assertions off otherwise we may
5714 recurse infinitely while printing error messages.
5716 SAVEI8(PL_utf8cache);
5718 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5719 " real %"UVuf" for %"SVf,
5720 (UV) ulen, (UV) real, SVfARG(sv));
5725 ulen = Perl_utf8_length(aTHX_ s, s + len);
5726 if (!SvREADONLY(sv)) {
5728 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5729 &PL_vtbl_utf8, 0, 0);
5737 return Perl_utf8_length(aTHX_ s, s + len);
5741 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5744 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5747 const U8 *s = start;
5749 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5751 while (s < send && uoffset--)
5754 /* This is the existing behaviour. Possibly it should be a croak, as
5755 it's actually a bounds error */
5761 /* Given the length of the string in both bytes and UTF-8 characters, decide
5762 whether to walk forwards or backwards to find the byte corresponding to
5763 the passed in UTF-8 offset. */
5765 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5766 const STRLEN uoffset, const STRLEN uend)
5768 STRLEN backw = uend - uoffset;
5770 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5772 if (uoffset < 2 * backw) {
5773 /* The assumption is that going forwards is twice the speed of going
5774 forward (that's where the 2 * backw comes from).
5775 (The real figure of course depends on the UTF-8 data.) */
5776 return sv_pos_u2b_forwards(start, send, uoffset);
5781 while (UTF8_IS_CONTINUATION(*send))
5784 return send - start;
5787 /* For the string representation of the given scalar, find the byte
5788 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5789 give another position in the string, *before* the sought offset, which
5790 (which is always true, as 0, 0 is a valid pair of positions), which should
5791 help reduce the amount of linear searching.
5792 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5793 will be used to reduce the amount of linear searching. The cache will be
5794 created if necessary, and the found value offered to it for update. */
5796 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5797 const U8 *const send, const STRLEN uoffset,
5798 STRLEN uoffset0, STRLEN boffset0)
5800 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5803 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5805 assert (uoffset >= uoffset0);
5807 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5808 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5809 if ((*mgp)->mg_ptr) {
5810 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5811 if (cache[0] == uoffset) {
5812 /* An exact match. */
5815 if (cache[2] == uoffset) {
5816 /* An exact match. */
5820 if (cache[0] < uoffset) {
5821 /* The cache already knows part of the way. */
5822 if (cache[0] > uoffset0) {
5823 /* The cache knows more than the passed in pair */
5824 uoffset0 = cache[0];
5825 boffset0 = cache[1];
5827 if ((*mgp)->mg_len != -1) {
5828 /* And we know the end too. */
5830 + sv_pos_u2b_midway(start + boffset0, send,
5832 (*mgp)->mg_len - uoffset0);
5835 + sv_pos_u2b_forwards(start + boffset0,
5836 send, uoffset - uoffset0);
5839 else if (cache[2] < uoffset) {
5840 /* We're between the two cache entries. */
5841 if (cache[2] > uoffset0) {
5842 /* and the cache knows more than the passed in pair */
5843 uoffset0 = cache[2];
5844 boffset0 = cache[3];
5848 + sv_pos_u2b_midway(start + boffset0,
5851 cache[0] - uoffset0);
5854 + sv_pos_u2b_midway(start + boffset0,
5857 cache[2] - uoffset0);
5861 else if ((*mgp)->mg_len != -1) {
5862 /* If we can take advantage of a passed in offset, do so. */
5863 /* In fact, offset0 is either 0, or less than offset, so don't
5864 need to worry about the other possibility. */
5866 + sv_pos_u2b_midway(start + boffset0, send,
5868 (*mgp)->mg_len - uoffset0);
5873 if (!found || PL_utf8cache < 0) {
5874 const STRLEN real_boffset
5875 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5876 send, uoffset - uoffset0);
5878 if (found && PL_utf8cache < 0) {
5879 if (real_boffset != boffset) {
5880 /* Need to turn the assertions off otherwise we may recurse
5881 infinitely while printing error messages. */
5882 SAVEI8(PL_utf8cache);
5884 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5885 " real %"UVuf" for %"SVf,
5886 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5889 boffset = real_boffset;
5893 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5899 =for apidoc sv_pos_u2b
5901 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5902 the start of the string, to a count of the equivalent number of bytes; if
5903 lenp is non-zero, it does the same to lenp, but this time starting from
5904 the offset, rather than from the start of the string. Handles magic and
5911 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5912 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5913 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5918 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5923 PERL_ARGS_ASSERT_SV_POS_U2B;
5928 start = (U8*)SvPV_const(sv, len);
5930 STRLEN uoffset = (STRLEN) *offsetp;
5931 const U8 * const send = start + len;
5933 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5936 *offsetp = (I32) boffset;
5939 /* Convert the relative offset to absolute. */
5940 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5941 const STRLEN boffset2
5942 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5943 uoffset, boffset) - boffset;
5957 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5958 byte length pairing. The (byte) length of the total SV is passed in too,
5959 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5960 may not have updated SvCUR, so we can't rely on reading it directly.
5962 The proffered utf8/byte length pairing isn't used if the cache already has
5963 two pairs, and swapping either for the proffered pair would increase the
5964 RMS of the intervals between known byte offsets.
5966 The cache itself consists of 4 STRLEN values
5967 0: larger UTF-8 offset
5968 1: corresponding byte offset
5969 2: smaller UTF-8 offset
5970 3: corresponding byte offset
5972 Unused cache pairs have the value 0, 0.
5973 Keeping the cache "backwards" means that the invariant of
5974 cache[0] >= cache[2] is maintained even with empty slots, which means that
5975 the code that uses it doesn't need to worry if only 1 entry has actually
5976 been set to non-zero. It also makes the "position beyond the end of the
5977 cache" logic much simpler, as the first slot is always the one to start
5981 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5982 const STRLEN utf8, const STRLEN blen)
5986 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5992 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5994 (*mgp)->mg_len = -1;
5998 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5999 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6000 (*mgp)->mg_ptr = (char *) cache;
6004 if (PL_utf8cache < 0) {
6005 const U8 *start = (const U8 *) SvPVX_const(sv);
6006 const STRLEN realutf8 = utf8_length(start, start + byte);
6008 if (realutf8 != utf8) {
6009 /* Need to turn the assertions off otherwise we may recurse
6010 infinitely while printing error messages. */
6011 SAVEI8(PL_utf8cache);
6013 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6014 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6018 /* Cache is held with the later position first, to simplify the code
6019 that deals with unbounded ends. */
6021 ASSERT_UTF8_CACHE(cache);
6022 if (cache[1] == 0) {
6023 /* Cache is totally empty */
6026 } else if (cache[3] == 0) {
6027 if (byte > cache[1]) {
6028 /* New one is larger, so goes first. */
6029 cache[2] = cache[0];
6030 cache[3] = cache[1];
6038 #define THREEWAY_SQUARE(a,b,c,d) \
6039 ((float)((d) - (c))) * ((float)((d) - (c))) \
6040 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6041 + ((float)((b) - (a))) * ((float)((b) - (a)))
6043 /* Cache has 2 slots in use, and we know three potential pairs.
6044 Keep the two that give the lowest RMS distance. Do the
6045 calcualation in bytes simply because we always know the byte
6046 length. squareroot has the same ordering as the positive value,
6047 so don't bother with the actual square root. */
6048 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6049 if (byte > cache[1]) {
6050 /* New position is after the existing pair of pairs. */
6051 const float keep_earlier
6052 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6053 const float keep_later
6054 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6056 if (keep_later < keep_earlier) {
6057 if (keep_later < existing) {
6058 cache[2] = cache[0];
6059 cache[3] = cache[1];
6065 if (keep_earlier < existing) {
6071 else if (byte > cache[3]) {
6072 /* New position is between the existing pair of pairs. */
6073 const float keep_earlier
6074 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6075 const float keep_later
6076 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6078 if (keep_later < keep_earlier) {
6079 if (keep_later < existing) {
6085 if (keep_earlier < existing) {
6092 /* New position is before the existing pair of pairs. */
6093 const float keep_earlier
6094 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6095 const float keep_later
6096 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6098 if (keep_later < keep_earlier) {
6099 if (keep_later < existing) {
6105 if (keep_earlier < existing) {
6106 cache[0] = cache[2];
6107 cache[1] = cache[3];
6114 ASSERT_UTF8_CACHE(cache);
6117 /* We already know all of the way, now we may be able to walk back. The same
6118 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6119 backward is half the speed of walking forward. */
6121 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6122 const U8 *end, STRLEN endu)
6124 const STRLEN forw = target - s;
6125 STRLEN backw = end - target;
6127 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6129 if (forw < 2 * backw) {
6130 return utf8_length(s, target);
6133 while (end > target) {
6135 while (UTF8_IS_CONTINUATION(*end)) {
6144 =for apidoc sv_pos_b2u
6146 Converts the value pointed to by offsetp from a count of bytes from the
6147 start of the string, to a count of the equivalent number of UTF-8 chars.
6148 Handles magic and type coercion.
6154 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6155 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6160 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6163 const STRLEN byte = *offsetp;
6164 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6170 PERL_ARGS_ASSERT_SV_POS_B2U;
6175 s = (const U8*)SvPV_const(sv, blen);
6178 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6182 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6183 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6185 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6186 if (cache[1] == byte) {
6187 /* An exact match. */
6188 *offsetp = cache[0];
6191 if (cache[3] == byte) {
6192 /* An exact match. */
6193 *offsetp = cache[2];
6197 if (cache[1] < byte) {
6198 /* We already know part of the way. */
6199 if (mg->mg_len != -1) {
6200 /* Actually, we know the end too. */
6202 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6203 s + blen, mg->mg_len - cache[0]);
6205 len = cache[0] + utf8_length(s + cache[1], send);
6208 else if (cache[3] < byte) {
6209 /* We're between the two cached pairs, so we do the calculation
6210 offset by the byte/utf-8 positions for the earlier pair,
6211 then add the utf-8 characters from the string start to
6213 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6214 s + cache[1], cache[0] - cache[2])
6218 else { /* cache[3] > byte */
6219 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6223 ASSERT_UTF8_CACHE(cache);
6225 } else if (mg->mg_len != -1) {
6226 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6230 if (!found || PL_utf8cache < 0) {
6231 const STRLEN real_len = utf8_length(s, send);
6233 if (found && PL_utf8cache < 0) {
6234 if (len != real_len) {
6235 /* Need to turn the assertions off otherwise we may recurse
6236 infinitely while printing error messages. */
6237 SAVEI8(PL_utf8cache);
6239 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6240 " real %"UVuf" for %"SVf,
6241 (UV) len, (UV) real_len, SVfARG(sv));
6249 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6255 Returns a boolean indicating whether the strings in the two SVs are
6256 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6257 coerce its args to strings if necessary.
6263 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6272 SV* svrecode = NULL;
6279 /* if pv1 and pv2 are the same, second SvPV_const call may
6280 * invalidate pv1, so we may need to make a copy */
6281 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6282 pv1 = SvPV_const(sv1, cur1);
6283 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6285 pv1 = SvPV_const(sv1, cur1);
6293 pv2 = SvPV_const(sv2, cur2);
6295 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6296 /* Differing utf8ness.
6297 * Do not UTF8size the comparands as a side-effect. */
6300 svrecode = newSVpvn(pv2, cur2);
6301 sv_recode_to_utf8(svrecode, PL_encoding);
6302 pv2 = SvPV_const(svrecode, cur2);
6305 svrecode = newSVpvn(pv1, cur1);
6306 sv_recode_to_utf8(svrecode, PL_encoding);
6307 pv1 = SvPV_const(svrecode, cur1);
6309 /* Now both are in UTF-8. */
6311 SvREFCNT_dec(svrecode);
6316 bool is_utf8 = TRUE;
6319 /* sv1 is the UTF-8 one,
6320 * if is equal it must be downgrade-able */
6321 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6327 /* sv2 is the UTF-8 one,
6328 * if is equal it must be downgrade-able */
6329 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6335 /* Downgrade not possible - cannot be eq */
6343 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6345 SvREFCNT_dec(svrecode);
6355 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6356 string in C<sv1> is less than, equal to, or greater than the string in
6357 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6358 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6364 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6368 const char *pv1, *pv2;
6371 SV *svrecode = NULL;
6378 pv1 = SvPV_const(sv1, cur1);
6385 pv2 = SvPV_const(sv2, cur2);
6387 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6388 /* Differing utf8ness.
6389 * Do not UTF8size the comparands as a side-effect. */
6392 svrecode = newSVpvn(pv2, cur2);
6393 sv_recode_to_utf8(svrecode, PL_encoding);
6394 pv2 = SvPV_const(svrecode, cur2);
6397 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6402 svrecode = newSVpvn(pv1, cur1);
6403 sv_recode_to_utf8(svrecode, PL_encoding);
6404 pv1 = SvPV_const(svrecode, cur1);
6407 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6413 cmp = cur2 ? -1 : 0;
6417 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6420 cmp = retval < 0 ? -1 : 1;
6421 } else if (cur1 == cur2) {
6424 cmp = cur1 < cur2 ? -1 : 1;
6428 SvREFCNT_dec(svrecode);
6436 =for apidoc sv_cmp_locale
6438 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6439 'use bytes' aware, handles get magic, and will coerce its args to strings
6440 if necessary. See also C<sv_cmp>.
6446 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6449 #ifdef USE_LOCALE_COLLATE
6455 if (PL_collation_standard)
6459 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6461 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6463 if (!pv1 || !len1) {
6474 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6477 return retval < 0 ? -1 : 1;
6480 * When the result of collation is equality, that doesn't mean
6481 * that there are no differences -- some locales exclude some
6482 * characters from consideration. So to avoid false equalities,
6483 * we use the raw string as a tiebreaker.
6489 #endif /* USE_LOCALE_COLLATE */
6491 return sv_cmp(sv1, sv2);
6495 #ifdef USE_LOCALE_COLLATE
6498 =for apidoc sv_collxfrm
6500 Add Collate Transform magic to an SV if it doesn't already have it.
6502 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6503 scalar data of the variable, but transformed to such a format that a normal
6504 memory comparison can be used to compare the data according to the locale
6511 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6516 PERL_ARGS_ASSERT_SV_COLLXFRM;
6518 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6519 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6525 Safefree(mg->mg_ptr);
6526 s = SvPV_const(sv, len);
6527 if ((xf = mem_collxfrm(s, len, &xlen))) {
6529 #ifdef PERL_OLD_COPY_ON_WRITE
6531 sv_force_normal_flags(sv, 0);
6533 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6547 if (mg && mg->mg_ptr) {
6549 return mg->mg_ptr + sizeof(PL_collation_ix);
6557 #endif /* USE_LOCALE_COLLATE */
6562 Get a line from the filehandle and store it into the SV, optionally
6563 appending to the currently-stored string.
6569 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6574 register STDCHAR rslast;
6575 register STDCHAR *bp;
6580 PERL_ARGS_ASSERT_SV_GETS;
6582 if (SvTHINKFIRST(sv))
6583 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6584 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6586 However, perlbench says it's slower, because the existing swipe code
6587 is faster than copy on write.
6588 Swings and roundabouts. */
6589 SvUPGRADE(sv, SVt_PV);
6594 if (PerlIO_isutf8(fp)) {
6596 sv_utf8_upgrade_nomg(sv);
6597 sv_pos_u2b(sv,&append,0);
6599 } else if (SvUTF8(sv)) {
6600 SV * const tsv = newSV(0);
6601 sv_gets(tsv, fp, 0);
6602 sv_utf8_upgrade_nomg(tsv);
6603 SvCUR_set(sv,append);
6606 goto return_string_or_null;
6611 if (PerlIO_isutf8(fp))
6614 if (IN_PERL_COMPILETIME) {
6615 /* we always read code in line mode */
6619 else if (RsSNARF(PL_rs)) {
6620 /* If it is a regular disk file use size from stat() as estimate
6621 of amount we are going to read -- may result in mallocing
6622 more memory than we really need if the layers below reduce
6623 the size we read (e.g. CRLF or a gzip layer).
6626 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6627 const Off_t offset = PerlIO_tell(fp);
6628 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6629 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6635 else if (RsRECORD(PL_rs)) {
6643 /* Grab the size of the record we're getting */
6644 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6645 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6648 /* VMS wants read instead of fread, because fread doesn't respect */
6649 /* RMS record boundaries. This is not necessarily a good thing to be */
6650 /* doing, but we've got no other real choice - except avoid stdio
6651 as implementation - perhaps write a :vms layer ?
6653 fd = PerlIO_fileno(fp);
6654 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6655 bytesread = PerlIO_read(fp, buffer, recsize);
6658 bytesread = PerlLIO_read(fd, buffer, recsize);
6661 bytesread = PerlIO_read(fp, buffer, recsize);
6665 SvCUR_set(sv, bytesread += append);
6666 buffer[bytesread] = '\0';
6667 goto return_string_or_null;
6669 else if (RsPARA(PL_rs)) {
6675 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6676 if (PerlIO_isutf8(fp)) {
6677 rsptr = SvPVutf8(PL_rs, rslen);
6680 if (SvUTF8(PL_rs)) {
6681 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6682 Perl_croak(aTHX_ "Wide character in $/");
6685 rsptr = SvPV_const(PL_rs, rslen);
6689 rslast = rslen ? rsptr[rslen - 1] : '\0';
6691 if (rspara) { /* have to do this both before and after */
6692 do { /* to make sure file boundaries work right */
6695 i = PerlIO_getc(fp);
6699 PerlIO_ungetc(fp,i);
6705 /* See if we know enough about I/O mechanism to cheat it ! */
6707 /* This used to be #ifdef test - it is made run-time test for ease
6708 of abstracting out stdio interface. One call should be cheap
6709 enough here - and may even be a macro allowing compile
6713 if (PerlIO_fast_gets(fp)) {
6716 * We're going to steal some values from the stdio struct
6717 * and put EVERYTHING in the innermost loop into registers.
6719 register STDCHAR *ptr;
6723 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6724 /* An ungetc()d char is handled separately from the regular
6725 * buffer, so we getc() it back out and stuff it in the buffer.
6727 i = PerlIO_getc(fp);
6728 if (i == EOF) return 0;
6729 *(--((*fp)->_ptr)) = (unsigned char) i;
6733 /* Here is some breathtakingly efficient cheating */
6735 cnt = PerlIO_get_cnt(fp); /* get count into register */
6736 /* make sure we have the room */
6737 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6738 /* Not room for all of it
6739 if we are looking for a separator and room for some
6741 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6742 /* just process what we have room for */
6743 shortbuffered = cnt - SvLEN(sv) + append + 1;
6744 cnt -= shortbuffered;
6748 /* remember that cnt can be negative */
6749 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6754 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6755 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6756 DEBUG_P(PerlIO_printf(Perl_debug_log,
6757 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6758 DEBUG_P(PerlIO_printf(Perl_debug_log,
6759 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6760 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6761 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6766 while (cnt > 0) { /* this | eat */
6768 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6769 goto thats_all_folks; /* screams | sed :-) */
6773 Copy(ptr, bp, cnt, char); /* this | eat */
6774 bp += cnt; /* screams | dust */
6775 ptr += cnt; /* louder | sed :-) */
6780 if (shortbuffered) { /* oh well, must extend */
6781 cnt = shortbuffered;
6783 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6785 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6786 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6790 DEBUG_P(PerlIO_printf(Perl_debug_log,
6791 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6792 PTR2UV(ptr),(long)cnt));
6793 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6795 DEBUG_P(PerlIO_printf(Perl_debug_log,
6796 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6797 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6798 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6800 /* This used to call 'filbuf' in stdio form, but as that behaves like
6801 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6802 another abstraction. */
6803 i = PerlIO_getc(fp); /* get more characters */
6805 DEBUG_P(PerlIO_printf(Perl_debug_log,
6806 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6807 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6808 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6810 cnt = PerlIO_get_cnt(fp);
6811 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6812 DEBUG_P(PerlIO_printf(Perl_debug_log,
6813 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6815 if (i == EOF) /* all done for ever? */
6816 goto thats_really_all_folks;
6818 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6820 SvGROW(sv, bpx + cnt + 2);
6821 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6823 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6825 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6826 goto thats_all_folks;
6830 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6831 memNE((char*)bp - rslen, rsptr, rslen))
6832 goto screamer; /* go back to the fray */
6833 thats_really_all_folks:
6835 cnt += shortbuffered;
6836 DEBUG_P(PerlIO_printf(Perl_debug_log,
6837 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6838 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6839 DEBUG_P(PerlIO_printf(Perl_debug_log,
6840 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6841 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6842 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6844 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6845 DEBUG_P(PerlIO_printf(Perl_debug_log,
6846 "Screamer: done, len=%ld, string=|%.*s|\n",
6847 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6851 /*The big, slow, and stupid way. */
6852 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6853 STDCHAR *buf = NULL;
6854 Newx(buf, 8192, STDCHAR);
6862 register const STDCHAR * const bpe = buf + sizeof(buf);
6864 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6865 ; /* keep reading */
6869 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6870 /* Accomodate broken VAXC compiler, which applies U8 cast to
6871 * both args of ?: operator, causing EOF to change into 255
6874 i = (U8)buf[cnt - 1];
6880 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6882 sv_catpvn(sv, (char *) buf, cnt);
6884 sv_setpvn(sv, (char *) buf, cnt);
6886 if (i != EOF && /* joy */
6888 SvCUR(sv) < rslen ||
6889 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6893 * If we're reading from a TTY and we get a short read,
6894 * indicating that the user hit his EOF character, we need
6895 * to notice it now, because if we try to read from the TTY
6896 * again, the EOF condition will disappear.
6898 * The comparison of cnt to sizeof(buf) is an optimization
6899 * that prevents unnecessary calls to feof().
6903 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6907 #ifdef USE_HEAP_INSTEAD_OF_STACK
6912 if (rspara) { /* have to do this both before and after */
6913 while (i != EOF) { /* to make sure file boundaries work right */
6914 i = PerlIO_getc(fp);
6916 PerlIO_ungetc(fp,i);
6922 return_string_or_null:
6923 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6929 Auto-increment of the value in the SV, doing string to numeric conversion
6930 if necessary. Handles 'get' magic.
6936 Perl_sv_inc(pTHX_ register SV *const sv)
6945 if (SvTHINKFIRST(sv)) {
6947 sv_force_normal_flags(sv, 0);
6948 if (SvREADONLY(sv)) {
6949 if (IN_PERL_RUNTIME)
6950 Perl_croak(aTHX_ PL_no_modify);
6954 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6956 i = PTR2IV(SvRV(sv));
6961 flags = SvFLAGS(sv);
6962 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6963 /* It's (privately or publicly) a float, but not tested as an
6964 integer, so test it to see. */
6966 flags = SvFLAGS(sv);
6968 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6969 /* It's publicly an integer, or privately an integer-not-float */
6970 #ifdef PERL_PRESERVE_IVUV
6974 if (SvUVX(sv) == UV_MAX)
6975 sv_setnv(sv, UV_MAX_P1);
6977 (void)SvIOK_only_UV(sv);
6978 SvUV_set(sv, SvUVX(sv) + 1);
6980 if (SvIVX(sv) == IV_MAX)
6981 sv_setuv(sv, (UV)IV_MAX + 1);
6983 (void)SvIOK_only(sv);
6984 SvIV_set(sv, SvIVX(sv) + 1);
6989 if (flags & SVp_NOK) {
6990 const NV was = SvNVX(sv);
6991 if (NV_OVERFLOWS_INTEGERS_AT &&
6992 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6993 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6994 "Lost precision when incrementing %" NVff " by 1",
6997 (void)SvNOK_only(sv);
6998 SvNV_set(sv, was + 1.0);
7002 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7003 if ((flags & SVTYPEMASK) < SVt_PVIV)
7004 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7005 (void)SvIOK_only(sv);
7010 while (isALPHA(*d)) d++;
7011 while (isDIGIT(*d)) d++;
7013 #ifdef PERL_PRESERVE_IVUV
7014 /* Got to punt this as an integer if needs be, but we don't issue
7015 warnings. Probably ought to make the sv_iv_please() that does
7016 the conversion if possible, and silently. */
7017 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7018 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7019 /* Need to try really hard to see if it's an integer.
7020 9.22337203685478e+18 is an integer.
7021 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7022 so $a="9.22337203685478e+18"; $a+0; $a++
7023 needs to be the same as $a="9.22337203685478e+18"; $a++
7030 /* sv_2iv *should* have made this an NV */
7031 if (flags & SVp_NOK) {
7032 (void)SvNOK_only(sv);
7033 SvNV_set(sv, SvNVX(sv) + 1.0);
7036 /* I don't think we can get here. Maybe I should assert this
7037 And if we do get here I suspect that sv_setnv will croak. NWC
7039 #if defined(USE_LONG_DOUBLE)
7040 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",
7041 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7043 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7044 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7047 #endif /* PERL_PRESERVE_IVUV */
7048 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7052 while (d >= SvPVX_const(sv)) {
7060 /* MKS: The original code here died if letters weren't consecutive.
7061 * at least it didn't have to worry about non-C locales. The
7062 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7063 * arranged in order (although not consecutively) and that only
7064 * [A-Za-z] are accepted by isALPHA in the C locale.
7066 if (*d != 'z' && *d != 'Z') {
7067 do { ++*d; } while (!isALPHA(*d));
7070 *(d--) -= 'z' - 'a';
7075 *(d--) -= 'z' - 'a' + 1;
7079 /* oh,oh, the number grew */
7080 SvGROW(sv, SvCUR(sv) + 2);
7081 SvCUR_set(sv, SvCUR(sv) + 1);
7082 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7093 Auto-decrement of the value in the SV, doing string to numeric conversion
7094 if necessary. Handles 'get' magic.
7100 Perl_sv_dec(pTHX_ register SV *const sv)
7108 if (SvTHINKFIRST(sv)) {
7110 sv_force_normal_flags(sv, 0);
7111 if (SvREADONLY(sv)) {
7112 if (IN_PERL_RUNTIME)
7113 Perl_croak(aTHX_ PL_no_modify);
7117 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7119 i = PTR2IV(SvRV(sv));
7124 /* Unlike sv_inc we don't have to worry about string-never-numbers
7125 and keeping them magic. But we mustn't warn on punting */
7126 flags = SvFLAGS(sv);
7127 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7128 /* It's publicly an integer, or privately an integer-not-float */
7129 #ifdef PERL_PRESERVE_IVUV
7133 if (SvUVX(sv) == 0) {
7134 (void)SvIOK_only(sv);
7138 (void)SvIOK_only_UV(sv);
7139 SvUV_set(sv, SvUVX(sv) - 1);
7142 if (SvIVX(sv) == IV_MIN) {
7143 sv_setnv(sv, (NV)IV_MIN);
7147 (void)SvIOK_only(sv);
7148 SvIV_set(sv, SvIVX(sv) - 1);
7153 if (flags & SVp_NOK) {
7156 const NV was = SvNVX(sv);
7157 if (NV_OVERFLOWS_INTEGERS_AT &&
7158 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7159 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7160 "Lost precision when decrementing %" NVff " by 1",
7163 (void)SvNOK_only(sv);
7164 SvNV_set(sv, was - 1.0);
7168 if (!(flags & SVp_POK)) {
7169 if ((flags & SVTYPEMASK) < SVt_PVIV)
7170 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7172 (void)SvIOK_only(sv);
7175 #ifdef PERL_PRESERVE_IVUV
7177 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7178 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7179 /* Need to try really hard to see if it's an integer.
7180 9.22337203685478e+18 is an integer.
7181 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7182 so $a="9.22337203685478e+18"; $a+0; $a--
7183 needs to be the same as $a="9.22337203685478e+18"; $a--
7190 /* sv_2iv *should* have made this an NV */
7191 if (flags & SVp_NOK) {
7192 (void)SvNOK_only(sv);
7193 SvNV_set(sv, SvNVX(sv) - 1.0);
7196 /* I don't think we can get here. Maybe I should assert this
7197 And if we do get here I suspect that sv_setnv will croak. NWC
7199 #if defined(USE_LONG_DOUBLE)
7200 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",
7201 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7203 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7204 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7208 #endif /* PERL_PRESERVE_IVUV */
7209 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7213 =for apidoc sv_mortalcopy
7215 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7216 The new SV is marked as mortal. It will be destroyed "soon", either by an
7217 explicit call to FREETMPS, or by an implicit call at places such as
7218 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7223 /* Make a string that will exist for the duration of the expression
7224 * evaluation. Actually, it may have to last longer than that, but
7225 * hopefully we won't free it until it has been assigned to a
7226 * permanent location. */
7229 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7235 sv_setsv(sv,oldstr);
7237 PL_tmps_stack[++PL_tmps_ix] = sv;
7243 =for apidoc sv_newmortal
7245 Creates a new null SV which is mortal. The reference count of the SV is
7246 set to 1. It will be destroyed "soon", either by an explicit call to
7247 FREETMPS, or by an implicit call at places such as statement boundaries.
7248 See also C<sv_mortalcopy> and C<sv_2mortal>.
7254 Perl_sv_newmortal(pTHX)
7260 SvFLAGS(sv) = SVs_TEMP;
7262 PL_tmps_stack[++PL_tmps_ix] = sv;
7268 =for apidoc newSVpvn_flags
7270 Creates a new SV and copies a string into it. The reference count for the
7271 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7272 string. You are responsible for ensuring that the source string is at least
7273 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7274 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7275 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7276 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7277 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7279 #define newSVpvn_utf8(s, len, u) \
7280 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7286 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7291 /* All the flags we don't support must be zero.
7292 And we're new code so I'm going to assert this from the start. */
7293 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7295 sv_setpvn(sv,s,len);
7296 SvFLAGS(sv) |= (flags & SVf_UTF8);
7297 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7301 =for apidoc sv_2mortal
7303 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7304 by an explicit call to FREETMPS, or by an implicit call at places such as
7305 statement boundaries. SvTEMP() is turned on which means that the SV's
7306 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7307 and C<sv_mortalcopy>.
7313 Perl_sv_2mortal(pTHX_ register SV *const sv)
7318 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7321 PL_tmps_stack[++PL_tmps_ix] = sv;
7329 Creates a new SV and copies a string into it. The reference count for the
7330 SV is set to 1. If C<len> is zero, Perl will compute the length using
7331 strlen(). For efficiency, consider using C<newSVpvn> instead.
7337 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7343 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7348 =for apidoc newSVpvn
7350 Creates a new SV and copies a string into it. The reference count for the
7351 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7352 string. You are responsible for ensuring that the source string is at least
7353 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7359 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7365 sv_setpvn(sv,s,len);
7370 =for apidoc newSVhek
7372 Creates a new SV from the hash key structure. It will generate scalars that
7373 point to the shared string table where possible. Returns a new (undefined)
7374 SV if the hek is NULL.
7380 Perl_newSVhek(pTHX_ const HEK *const hek)
7390 if (HEK_LEN(hek) == HEf_SVKEY) {
7391 return newSVsv(*(SV**)HEK_KEY(hek));
7393 const int flags = HEK_FLAGS(hek);
7394 if (flags & HVhek_WASUTF8) {
7396 Andreas would like keys he put in as utf8 to come back as utf8
7398 STRLEN utf8_len = HEK_LEN(hek);
7399 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7400 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7403 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7405 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7406 /* We don't have a pointer to the hv, so we have to replicate the
7407 flag into every HEK. This hv is using custom a hasing
7408 algorithm. Hence we can't return a shared string scalar, as
7409 that would contain the (wrong) hash value, and might get passed
7410 into an hv routine with a regular hash.
7411 Similarly, a hash that isn't using shared hash keys has to have
7412 the flag in every key so that we know not to try to call
7413 share_hek_kek on it. */
7415 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7420 /* This will be overwhelminly the most common case. */
7422 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7423 more efficient than sharepvn(). */
7427 sv_upgrade(sv, SVt_PV);
7428 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7429 SvCUR_set(sv, HEK_LEN(hek));
7442 =for apidoc newSVpvn_share
7444 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7445 table. If the string does not already exist in the table, it is created
7446 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7447 value is used; otherwise the hash is computed. The string's hash can be later
7448 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7449 that as the string table is used for shared hash keys these strings will have
7450 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7456 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7460 bool is_utf8 = FALSE;
7461 const char *const orig_src = src;
7464 STRLEN tmplen = -len;
7466 /* See the note in hv.c:hv_fetch() --jhi */
7467 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7471 PERL_HASH(hash, src, len);
7473 sv_upgrade(sv, SVt_PV);
7474 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7482 if (src != orig_src)
7488 #if defined(PERL_IMPLICIT_CONTEXT)
7490 /* pTHX_ magic can't cope with varargs, so this is a no-context
7491 * version of the main function, (which may itself be aliased to us).
7492 * Don't access this version directly.
7496 Perl_newSVpvf_nocontext(const char *const pat, ...)
7502 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7504 va_start(args, pat);
7505 sv = vnewSVpvf(pat, &args);
7512 =for apidoc newSVpvf
7514 Creates a new SV and initializes it with the string formatted like
7521 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7526 PERL_ARGS_ASSERT_NEWSVPVF;
7528 va_start(args, pat);
7529 sv = vnewSVpvf(pat, &args);
7534 /* backend for newSVpvf() and newSVpvf_nocontext() */
7537 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7542 PERL_ARGS_ASSERT_VNEWSVPVF;
7545 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7552 Creates a new SV and copies a floating point value into it.
7553 The reference count for the SV is set to 1.
7559 Perl_newSVnv(pTHX_ const NV n)
7572 Creates a new SV and copies an integer into it. The reference count for the
7579 Perl_newSViv(pTHX_ const IV i)
7592 Creates a new SV and copies an unsigned integer into it.
7593 The reference count for the SV is set to 1.
7599 Perl_newSVuv(pTHX_ const UV u)
7610 =for apidoc newSV_type
7612 Creates a new SV, of the type specified. The reference count for the new SV
7619 Perl_newSV_type(pTHX_ const svtype type)
7624 sv_upgrade(sv, type);
7629 =for apidoc newRV_noinc
7631 Creates an RV wrapper for an SV. The reference count for the original
7632 SV is B<not> incremented.
7638 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7641 register SV *sv = newSV_type(SVt_IV);
7643 PERL_ARGS_ASSERT_NEWRV_NOINC;
7646 SvRV_set(sv, tmpRef);
7651 /* newRV_inc is the official function name to use now.
7652 * newRV_inc is in fact #defined to newRV in sv.h
7656 Perl_newRV(pTHX_ SV *const sv)
7660 PERL_ARGS_ASSERT_NEWRV;
7662 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7668 Creates a new SV which is an exact duplicate of the original SV.
7675 Perl_newSVsv(pTHX_ register SV *const old)
7682 if (SvTYPE(old) == SVTYPEMASK) {
7683 if (ckWARN_d(WARN_INTERNAL))
7684 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7688 /* SV_GMAGIC is the default for sv_setv()
7689 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7690 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7691 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7696 =for apidoc sv_reset
7698 Underlying implementation for the C<reset> Perl function.
7699 Note that the perl-level function is vaguely deprecated.
7705 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7708 char todo[PERL_UCHAR_MAX+1];
7710 PERL_ARGS_ASSERT_SV_RESET;
7715 if (!*s) { /* reset ?? searches */
7716 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7718 const U32 count = mg->mg_len / sizeof(PMOP**);
7719 PMOP **pmp = (PMOP**) mg->mg_ptr;
7720 PMOP *const *const end = pmp + count;
7724 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7726 (*pmp)->op_pmflags &= ~PMf_USED;
7734 /* reset variables */
7736 if (!HvARRAY(stash))
7739 Zero(todo, 256, char);
7742 I32 i = (unsigned char)*s;
7746 max = (unsigned char)*s++;
7747 for ( ; i <= max; i++) {
7750 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7752 for (entry = HvARRAY(stash)[i];
7754 entry = HeNEXT(entry))
7759 if (!todo[(U8)*HeKEY(entry)])
7761 gv = (GV*)HeVAL(entry);
7764 if (SvTHINKFIRST(sv)) {
7765 if (!SvREADONLY(sv) && SvROK(sv))
7767 /* XXX Is this continue a bug? Why should THINKFIRST
7768 exempt us from resetting arrays and hashes? */
7772 if (SvTYPE(sv) >= SVt_PV) {
7774 if (SvPVX_const(sv) != NULL)
7782 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7784 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7787 # if defined(USE_ENVIRON_ARRAY)
7790 # endif /* USE_ENVIRON_ARRAY */
7801 Using various gambits, try to get an IO from an SV: the IO slot if its a
7802 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7803 named after the PV if we're a string.
7809 Perl_sv_2io(pTHX_ SV *const sv)
7814 PERL_ARGS_ASSERT_SV_2IO;
7816 switch (SvTYPE(sv)) {
7824 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7828 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7830 return sv_2io(SvRV(sv));
7831 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7837 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7846 Using various gambits, try to get a CV from an SV; in addition, try if
7847 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7848 The flags in C<lref> are passed to sv_fetchsv.
7854 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7860 PERL_ARGS_ASSERT_SV_2CV;
7867 switch (SvTYPE(sv)) {
7885 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7887 tryAMAGICunDEREF(to_cv);
7890 if (SvTYPE(sv) == SVt_PVCV) {
7899 Perl_croak(aTHX_ "Not a subroutine reference");
7901 else if (isGV(sv)) {
7906 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7912 /* Some flags to gv_fetchsv mean don't really create the GV */
7913 if (SvTYPE(gv) != SVt_PVGV) {
7919 if (lref && !GvCVu(gv)) {
7923 gv_efullname3(tmpsv, gv, NULL);
7924 /* XXX this is probably not what they think they're getting.
7925 * It has the same effect as "sub name;", i.e. just a forward
7927 newSUB(start_subparse(FALSE, 0),
7928 newSVOP(OP_CONST, 0, tmpsv),
7932 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7933 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7942 Returns true if the SV has a true value by Perl's rules.
7943 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7944 instead use an in-line version.
7950 Perl_sv_true(pTHX_ register SV *const sv)
7955 register const XPV* const tXpv = (XPV*)SvANY(sv);
7957 (tXpv->xpv_cur > 1 ||
7958 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7965 return SvIVX(sv) != 0;
7968 return SvNVX(sv) != 0.0;
7970 return sv_2bool(sv);
7976 =for apidoc sv_pvn_force
7978 Get a sensible string out of the SV somehow.
7979 A private implementation of the C<SvPV_force> macro for compilers which
7980 can't cope with complex macro expressions. Always use the macro instead.
7982 =for apidoc sv_pvn_force_flags
7984 Get a sensible string out of the SV somehow.
7985 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7986 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7987 implemented in terms of this function.
7988 You normally want to use the various wrapper macros instead: see
7989 C<SvPV_force> and C<SvPV_force_nomg>
7995 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
7999 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8001 if (SvTHINKFIRST(sv) && !SvROK(sv))
8002 sv_force_normal_flags(sv, 0);
8012 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8013 const char * const ref = sv_reftype(sv,0);
8015 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8016 ref, OP_NAME(PL_op));
8018 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8020 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8021 || isGV_with_GP(sv))
8022 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8024 s = sv_2pv_flags(sv, &len, flags);
8028 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8031 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8032 SvGROW(sv, len + 1);
8033 Move(s,SvPVX(sv),len,char);
8035 SvPVX(sv)[len] = '\0';
8038 SvPOK_on(sv); /* validate pointer */
8040 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8041 PTR2UV(sv),SvPVX_const(sv)));
8044 return SvPVX_mutable(sv);
8048 =for apidoc sv_pvbyten_force
8050 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8056 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8058 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8060 sv_pvn_force(sv,lp);
8061 sv_utf8_downgrade(sv,0);
8067 =for apidoc sv_pvutf8n_force
8069 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8075 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8077 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8079 sv_pvn_force(sv,lp);
8080 sv_utf8_upgrade(sv);
8086 =for apidoc sv_reftype
8088 Returns a string describing what the SV is a reference to.
8094 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8096 PERL_ARGS_ASSERT_SV_REFTYPE;
8098 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8099 inside return suggests a const propagation bug in g++. */
8100 if (ob && SvOBJECT(sv)) {
8101 char * const name = HvNAME_get(SvSTASH(sv));
8102 return name ? name : (char *) "__ANON__";
8105 switch (SvTYPE(sv)) {
8120 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8121 /* tied lvalues should appear to be
8122 * scalars for backwards compatitbility */
8123 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8124 ? "SCALAR" : "LVALUE");
8125 case SVt_PVAV: return "ARRAY";
8126 case SVt_PVHV: return "HASH";
8127 case SVt_PVCV: return "CODE";
8128 case SVt_PVGV: return "GLOB";
8129 case SVt_PVFM: return "FORMAT";
8130 case SVt_PVIO: return "IO";
8131 case SVt_BIND: return "BIND";
8132 case SVt_REGEXP: return "REGEXP";
8133 default: return "UNKNOWN";
8139 =for apidoc sv_isobject
8141 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8142 object. If the SV is not an RV, or if the object is not blessed, then this
8149 Perl_sv_isobject(pTHX_ SV *sv)
8165 Returns a boolean indicating whether the SV is blessed into the specified
8166 class. This does not check for subtypes; use C<sv_derived_from> to verify
8167 an inheritance relationship.
8173 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8177 PERL_ARGS_ASSERT_SV_ISA;
8187 hvname = HvNAME_get(SvSTASH(sv));
8191 return strEQ(hvname, name);
8197 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8198 it will be upgraded to one. If C<classname> is non-null then the new SV will
8199 be blessed in the specified package. The new SV is returned and its
8200 reference count is 1.
8206 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8211 PERL_ARGS_ASSERT_NEWSVRV;
8215 SV_CHECK_THINKFIRST_COW_DROP(rv);
8216 (void)SvAMAGIC_off(rv);
8218 if (SvTYPE(rv) >= SVt_PVMG) {
8219 const U32 refcnt = SvREFCNT(rv);
8223 SvREFCNT(rv) = refcnt;
8225 sv_upgrade(rv, SVt_IV);
8226 } else if (SvROK(rv)) {
8227 SvREFCNT_dec(SvRV(rv));
8229 prepare_SV_for_RV(rv);
8237 HV* const stash = gv_stashpv(classname, GV_ADD);
8238 (void)sv_bless(rv, stash);
8244 =for apidoc sv_setref_pv
8246 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8247 argument will be upgraded to an RV. That RV will be modified to point to
8248 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8249 into the SV. The C<classname> argument indicates the package for the
8250 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8251 will have a reference count of 1, and the RV will be returned.
8253 Do not use with other Perl types such as HV, AV, SV, CV, because those
8254 objects will become corrupted by the pointer copy process.
8256 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8262 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8266 PERL_ARGS_ASSERT_SV_SETREF_PV;
8269 sv_setsv(rv, &PL_sv_undef);
8273 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8278 =for apidoc sv_setref_iv
8280 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8281 argument will be upgraded to an RV. That RV will be modified to point to
8282 the new SV. The C<classname> argument indicates the package for the
8283 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8284 will have a reference count of 1, and the RV will be returned.
8290 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8292 PERL_ARGS_ASSERT_SV_SETREF_IV;
8294 sv_setiv(newSVrv(rv,classname), iv);
8299 =for apidoc sv_setref_uv
8301 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8302 argument will be upgraded to an RV. That RV will be modified to point to
8303 the new SV. The C<classname> argument indicates the package for the
8304 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8305 will have a reference count of 1, and the RV will be returned.
8311 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8313 PERL_ARGS_ASSERT_SV_SETREF_UV;
8315 sv_setuv(newSVrv(rv,classname), uv);
8320 =for apidoc sv_setref_nv
8322 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8323 argument will be upgraded to an RV. That RV will be modified to point to
8324 the new SV. The C<classname> argument indicates the package for the
8325 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8326 will have a reference count of 1, and the RV will be returned.
8332 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8334 PERL_ARGS_ASSERT_SV_SETREF_NV;
8336 sv_setnv(newSVrv(rv,classname), nv);
8341 =for apidoc sv_setref_pvn
8343 Copies a string into a new SV, optionally blessing the SV. The length of the
8344 string must be specified with C<n>. The C<rv> argument will be upgraded to
8345 an RV. That RV will be modified to point to the new SV. The C<classname>
8346 argument indicates the package for the blessing. Set C<classname> to
8347 C<NULL> to avoid the blessing. The new SV will have a reference count
8348 of 1, and the RV will be returned.
8350 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8356 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8357 const char *const pv, const STRLEN n)
8359 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8361 sv_setpvn(newSVrv(rv,classname), pv, n);
8366 =for apidoc sv_bless
8368 Blesses an SV into a specified package. The SV must be an RV. The package
8369 must be designated by its stash (see C<gv_stashpv()>). The reference count
8370 of the SV is unaffected.
8376 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8381 PERL_ARGS_ASSERT_SV_BLESS;
8384 Perl_croak(aTHX_ "Can't bless non-reference value");
8386 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8387 if (SvIsCOW(tmpRef))
8388 sv_force_normal_flags(tmpRef, 0);
8389 if (SvREADONLY(tmpRef))
8390 Perl_croak(aTHX_ PL_no_modify);
8391 if (SvOBJECT(tmpRef)) {
8392 if (SvTYPE(tmpRef) != SVt_PVIO)
8394 SvREFCNT_dec(SvSTASH(tmpRef));
8397 SvOBJECT_on(tmpRef);
8398 if (SvTYPE(tmpRef) != SVt_PVIO)
8400 SvUPGRADE(tmpRef, SVt_PVMG);
8401 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8406 (void)SvAMAGIC_off(sv);
8408 if(SvSMAGICAL(tmpRef))
8409 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8417 /* Downgrades a PVGV to a PVMG.
8421 S_sv_unglob(pTHX_ SV *const sv)
8426 SV * const temp = sv_newmortal();
8428 PERL_ARGS_ASSERT_SV_UNGLOB;
8430 assert(SvTYPE(sv) == SVt_PVGV);
8432 gv_efullname3(temp, (GV *) sv, "*");
8435 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8436 mro_method_changed_in(stash);
8440 sv_del_backref((SV*)GvSTASH(sv), sv);
8444 if (GvNAME_HEK(sv)) {
8445 unshare_hek(GvNAME_HEK(sv));
8447 isGV_with_GP_off(sv);
8449 /* need to keep SvANY(sv) in the right arena */
8450 xpvmg = new_XPVMG();
8451 StructCopy(SvANY(sv), xpvmg, XPVMG);
8452 del_XPVGV(SvANY(sv));
8455 SvFLAGS(sv) &= ~SVTYPEMASK;
8456 SvFLAGS(sv) |= SVt_PVMG;
8458 /* Intentionally not calling any local SET magic, as this isn't so much a
8459 set operation as merely an internal storage change. */
8460 sv_setsv_flags(sv, temp, 0);
8464 =for apidoc sv_unref_flags
8466 Unsets the RV status of the SV, and decrements the reference count of
8467 whatever was being referenced by the RV. This can almost be thought of
8468 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8469 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8470 (otherwise the decrementing is conditional on the reference count being
8471 different from one or the reference being a readonly SV).
8478 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8480 SV* const target = SvRV(ref);
8482 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8484 if (SvWEAKREF(ref)) {
8485 sv_del_backref(target, ref);
8487 SvRV_set(ref, NULL);
8490 SvRV_set(ref, NULL);
8492 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8493 assigned to as BEGIN {$a = \"Foo"} will fail. */
8494 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8495 SvREFCNT_dec(target);
8496 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8497 sv_2mortal(target); /* Schedule for freeing later */
8501 =for apidoc sv_untaint
8503 Untaint an SV. Use C<SvTAINTED_off> instead.
8508 Perl_sv_untaint(pTHX_ SV *const sv)
8510 PERL_ARGS_ASSERT_SV_UNTAINT;
8512 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8513 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8520 =for apidoc sv_tainted
8522 Test an SV for taintedness. Use C<SvTAINTED> instead.
8527 Perl_sv_tainted(pTHX_ SV *const sv)
8529 PERL_ARGS_ASSERT_SV_TAINTED;
8531 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8532 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8533 if (mg && (mg->mg_len & 1) )
8540 =for apidoc sv_setpviv
8542 Copies an integer into the given SV, also updating its string value.
8543 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8549 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8551 char buf[TYPE_CHARS(UV)];
8553 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8555 PERL_ARGS_ASSERT_SV_SETPVIV;
8557 sv_setpvn(sv, ptr, ebuf - ptr);
8561 =for apidoc sv_setpviv_mg
8563 Like C<sv_setpviv>, but also handles 'set' magic.
8569 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8571 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8577 #if defined(PERL_IMPLICIT_CONTEXT)
8579 /* pTHX_ magic can't cope with varargs, so this is a no-context
8580 * version of the main function, (which may itself be aliased to us).
8581 * Don't access this version directly.
8585 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8590 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8592 va_start(args, pat);
8593 sv_vsetpvf(sv, pat, &args);
8597 /* pTHX_ magic can't cope with varargs, so this is a no-context
8598 * version of the main function, (which may itself be aliased to us).
8599 * Don't access this version directly.
8603 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8608 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8610 va_start(args, pat);
8611 sv_vsetpvf_mg(sv, pat, &args);
8617 =for apidoc sv_setpvf
8619 Works like C<sv_catpvf> but copies the text into the SV instead of
8620 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8626 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8630 PERL_ARGS_ASSERT_SV_SETPVF;
8632 va_start(args, pat);
8633 sv_vsetpvf(sv, pat, &args);
8638 =for apidoc sv_vsetpvf
8640 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8641 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8643 Usually used via its frontend C<sv_setpvf>.
8649 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8651 PERL_ARGS_ASSERT_SV_VSETPVF;
8653 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8657 =for apidoc sv_setpvf_mg
8659 Like C<sv_setpvf>, but also handles 'set' magic.
8665 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8669 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8671 va_start(args, pat);
8672 sv_vsetpvf_mg(sv, pat, &args);
8677 =for apidoc sv_vsetpvf_mg
8679 Like C<sv_vsetpvf>, but also handles 'set' magic.
8681 Usually used via its frontend C<sv_setpvf_mg>.
8687 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8689 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8691 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8695 #if defined(PERL_IMPLICIT_CONTEXT)
8697 /* pTHX_ magic can't cope with varargs, so this is a no-context
8698 * version of the main function, (which may itself be aliased to us).
8699 * Don't access this version directly.
8703 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8708 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8710 va_start(args, pat);
8711 sv_vcatpvf(sv, pat, &args);
8715 /* pTHX_ magic can't cope with varargs, so this is a no-context
8716 * version of the main function, (which may itself be aliased to us).
8717 * Don't access this version directly.
8721 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8726 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8728 va_start(args, pat);
8729 sv_vcatpvf_mg(sv, pat, &args);
8735 =for apidoc sv_catpvf
8737 Processes its arguments like C<sprintf> and appends the formatted
8738 output to an SV. If the appended data contains "wide" characters
8739 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8740 and characters >255 formatted with %c), the original SV might get
8741 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8742 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8743 valid UTF-8; if the original SV was bytes, the pattern should be too.
8748 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8752 PERL_ARGS_ASSERT_SV_CATPVF;
8754 va_start(args, pat);
8755 sv_vcatpvf(sv, pat, &args);
8760 =for apidoc sv_vcatpvf
8762 Processes its arguments like C<vsprintf> and appends the formatted output
8763 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8765 Usually used via its frontend C<sv_catpvf>.
8771 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8773 PERL_ARGS_ASSERT_SV_VCATPVF;
8775 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8779 =for apidoc sv_catpvf_mg
8781 Like C<sv_catpvf>, but also handles 'set' magic.
8787 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8791 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8793 va_start(args, pat);
8794 sv_vcatpvf_mg(sv, pat, &args);
8799 =for apidoc sv_vcatpvf_mg
8801 Like C<sv_vcatpvf>, but also handles 'set' magic.
8803 Usually used via its frontend C<sv_catpvf_mg>.
8809 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8811 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8813 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8818 =for apidoc sv_vsetpvfn
8820 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8823 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8829 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8830 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8832 PERL_ARGS_ASSERT_SV_VSETPVFN;
8834 sv_setpvn(sv, "", 0);
8835 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8839 S_expect_number(pTHX_ char **const pattern)
8844 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8846 switch (**pattern) {
8847 case '1': case '2': case '3':
8848 case '4': case '5': case '6':
8849 case '7': case '8': case '9':
8850 var = *(*pattern)++ - '0';
8851 while (isDIGIT(**pattern)) {
8852 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8854 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8862 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8864 const int neg = nv < 0;
8867 PERL_ARGS_ASSERT_F0CONVERT;
8875 if (uv & 1 && uv == nv)
8876 uv--; /* Round to even */
8878 const unsigned dig = uv % 10;
8891 =for apidoc sv_vcatpvfn
8893 Processes its arguments like C<vsprintf> and appends the formatted output
8894 to an SV. Uses an array of SVs if the C style variable argument list is
8895 missing (NULL). When running with taint checks enabled, indicates via
8896 C<maybe_tainted> if results are untrustworthy (often due to the use of
8899 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8905 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8906 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8907 vec_utf8 = DO_UTF8(vecsv);
8909 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8912 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8913 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8921 static const char nullstr[] = "(null)";
8923 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8924 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8926 /* Times 4: a decimal digit takes more than 3 binary digits.
8927 * NV_DIG: mantissa takes than many decimal digits.
8928 * Plus 32: Playing safe. */
8929 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8930 /* large enough for "%#.#f" --chip */
8931 /* what about long double NVs? --jhi */
8933 PERL_ARGS_ASSERT_SV_VCATPVFN;
8934 PERL_UNUSED_ARG(maybe_tainted);
8936 /* no matter what, this is a string now */
8937 (void)SvPV_force(sv, origlen);
8939 /* special-case "", "%s", and "%-p" (SVf - see below) */
8942 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8944 const char * const s = va_arg(*args, char*);
8945 sv_catpv(sv, s ? s : nullstr);
8947 else if (svix < svmax) {
8948 sv_catsv(sv, *svargs);
8952 if (args && patlen == 3 && pat[0] == '%' &&
8953 pat[1] == '-' && pat[2] == 'p') {
8954 argsv = (SV*)va_arg(*args, void*);
8955 sv_catsv(sv, argsv);
8959 #ifndef USE_LONG_DOUBLE
8960 /* special-case "%.<number>[gf]" */
8961 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8962 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8963 unsigned digits = 0;
8967 while (*pp >= '0' && *pp <= '9')
8968 digits = 10 * digits + (*pp++ - '0');
8969 if (pp - pat == (int)patlen - 1) {
8977 /* Add check for digits != 0 because it seems that some
8978 gconverts are buggy in this case, and we don't yet have
8979 a Configure test for this. */
8980 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8981 /* 0, point, slack */
8982 Gconvert(nv, (int)digits, 0, ebuf);
8984 if (*ebuf) /* May return an empty string for digits==0 */
8987 } else if (!digits) {
8990 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8991 sv_catpvn(sv, p, l);
8997 #endif /* !USE_LONG_DOUBLE */
8999 if (!args && svix < svmax && DO_UTF8(*svargs))
9002 patend = (char*)pat + patlen;
9003 for (p = (char*)pat; p < patend; p = q) {
9006 bool vectorize = FALSE;
9007 bool vectorarg = FALSE;
9008 bool vec_utf8 = FALSE;
9014 bool has_precis = FALSE;
9016 const I32 osvix = svix;
9017 bool is_utf8 = FALSE; /* is this item utf8? */
9018 #ifdef HAS_LDBL_SPRINTF_BUG
9019 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9020 with sfio - Allen <allens@cpan.org> */
9021 bool fix_ldbl_sprintf_bug = FALSE;
9025 U8 utf8buf[UTF8_MAXBYTES+1];
9026 STRLEN esignlen = 0;
9028 const char *eptr = NULL;
9031 const U8 *vecstr = NULL;
9038 /* we need a long double target in case HAS_LONG_DOUBLE but
9041 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9049 const char *dotstr = ".";
9050 STRLEN dotstrlen = 1;
9051 I32 efix = 0; /* explicit format parameter index */
9052 I32 ewix = 0; /* explicit width index */
9053 I32 epix = 0; /* explicit precision index */
9054 I32 evix = 0; /* explicit vector index */
9055 bool asterisk = FALSE;
9057 /* echo everything up to the next format specification */
9058 for (q = p; q < patend && *q != '%'; ++q) ;
9060 if (has_utf8 && !pat_utf8)
9061 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9063 sv_catpvn(sv, p, q - p);
9070 We allow format specification elements in this order:
9071 \d+\$ explicit format parameter index
9073 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9074 0 flag (as above): repeated to allow "v02"
9075 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9076 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9078 [%bcdefginopsuxDFOUX] format (mandatory)
9083 As of perl5.9.3, printf format checking is on by default.
9084 Internally, perl uses %p formats to provide an escape to
9085 some extended formatting. This block deals with those
9086 extensions: if it does not match, (char*)q is reset and
9087 the normal format processing code is used.
9089 Currently defined extensions are:
9090 %p include pointer address (standard)
9091 %-p (SVf) include an SV (previously %_)
9092 %-<num>p include an SV with precision <num>
9093 %<num>p reserved for future extensions
9095 Robin Barker 2005-07-14
9097 %1p (VDf) removed. RMB 2007-10-19
9104 n = expect_number(&q);
9111 argsv = (SV*)va_arg(*args, void*);
9112 eptr = SvPV_const(argsv, elen);
9118 if (ckWARN_d(WARN_INTERNAL))
9119 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9120 "internal %%<num>p might conflict with future printf extensions");
9126 if ( (width = expect_number(&q)) ) {
9141 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9170 if ( (ewix = expect_number(&q)) )
9179 if ((vectorarg = asterisk)) {
9192 width = expect_number(&q);
9198 vecsv = va_arg(*args, SV*);
9200 vecsv = (evix > 0 && evix <= svmax)
9201 ? svargs[evix-1] : &PL_sv_undef;
9203 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9205 dotstr = SvPV_const(vecsv, dotstrlen);
9206 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9207 bad with tied or overloaded values that return UTF8. */
9210 else if (has_utf8) {
9211 vecsv = sv_mortalcopy(vecsv);
9212 sv_utf8_upgrade(vecsv);
9213 dotstr = SvPV_const(vecsv, dotstrlen);
9220 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9221 vecsv = svargs[efix ? efix-1 : svix++];
9222 vecstr = (U8*)SvPV_const(vecsv,veclen);
9223 vec_utf8 = DO_UTF8(vecsv);
9225 /* if this is a version object, we need to convert
9226 * back into v-string notation and then let the
9227 * vectorize happen normally
9229 if (sv_derived_from(vecsv, "version")) {
9230 char *version = savesvpv(vecsv);
9231 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9232 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9233 "vector argument not supported with alpha versions");
9236 vecsv = sv_newmortal();
9237 scan_vstring(version, version + veclen, vecsv);
9238 vecstr = (U8*)SvPV_const(vecsv, veclen);
9239 vec_utf8 = DO_UTF8(vecsv);
9251 i = va_arg(*args, int);
9253 i = (ewix ? ewix <= svmax : svix < svmax) ?
9254 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9256 width = (i < 0) ? -i : i;
9266 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9268 /* XXX: todo, support specified precision parameter */
9272 i = va_arg(*args, int);
9274 i = (ewix ? ewix <= svmax : svix < svmax)
9275 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9277 has_precis = !(i < 0);
9282 precis = precis * 10 + (*q++ - '0');
9291 case 'I': /* Ix, I32x, and I64x */
9293 if (q[1] == '6' && q[2] == '4') {
9299 if (q[1] == '3' && q[2] == '2') {
9309 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9320 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9321 if (*(q + 1) == 'l') { /* lld, llf */
9347 if (!vectorize && !args) {
9349 const I32 i = efix-1;
9350 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9352 argsv = (svix >= 0 && svix < svmax)
9353 ? svargs[svix++] : &PL_sv_undef;
9364 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9366 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9368 eptr = (char*)utf8buf;
9369 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9383 eptr = va_arg(*args, char*);
9385 #ifdef MACOS_TRADITIONAL
9386 /* On MacOS, %#s format is used for Pascal strings */
9391 elen = strlen(eptr);
9393 eptr = (char *)nullstr;
9394 elen = sizeof nullstr - 1;
9398 eptr = SvPV_const(argsv, elen);
9399 if (DO_UTF8(argsv)) {
9400 I32 old_precis = precis;
9401 if (has_precis && precis < elen) {
9403 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9406 if (width) { /* fudge width (can't fudge elen) */
9407 if (has_precis && precis < elen)
9408 width += precis - old_precis;
9410 width += elen - sv_len_utf8(argsv);
9417 if (has_precis && elen > precis)
9424 if (alt || vectorize)
9426 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9447 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9456 esignbuf[esignlen++] = plus;
9460 case 'h': iv = (short)va_arg(*args, int); break;
9461 case 'l': iv = va_arg(*args, long); break;
9462 case 'V': iv = va_arg(*args, IV); break;
9463 default: iv = va_arg(*args, int); break;
9465 case 'q': iv = va_arg(*args, Quad_t); break;
9470 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9472 case 'h': iv = (short)tiv; break;
9473 case 'l': iv = (long)tiv; break;
9475 default: iv = tiv; break;
9477 case 'q': iv = (Quad_t)tiv; break;
9481 if ( !vectorize ) /* we already set uv above */
9486 esignbuf[esignlen++] = plus;
9490 esignbuf[esignlen++] = '-';
9534 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9545 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9546 case 'l': uv = va_arg(*args, unsigned long); break;
9547 case 'V': uv = va_arg(*args, UV); break;
9548 default: uv = va_arg(*args, unsigned); break;
9550 case 'q': uv = va_arg(*args, Uquad_t); break;
9555 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9557 case 'h': uv = (unsigned short)tuv; break;
9558 case 'l': uv = (unsigned long)tuv; break;
9560 default: uv = tuv; break;
9562 case 'q': uv = (Uquad_t)tuv; break;
9569 char *ptr = ebuf + sizeof ebuf;
9570 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9576 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9582 esignbuf[esignlen++] = '0';
9583 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9591 if (alt && *ptr != '0')
9600 esignbuf[esignlen++] = '0';
9601 esignbuf[esignlen++] = c;
9604 default: /* it had better be ten or less */
9608 } while (uv /= base);
9611 elen = (ebuf + sizeof ebuf) - ptr;
9615 zeros = precis - elen;
9616 else if (precis == 0 && elen == 1 && *eptr == '0'
9617 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9620 /* a precision nullifies the 0 flag. */
9627 /* FLOATING POINT */
9630 c = 'f'; /* maybe %F isn't supported here */
9638 /* This is evil, but floating point is even more evil */
9640 /* for SV-style calling, we can only get NV
9641 for C-style calling, we assume %f is double;
9642 for simplicity we allow any of %Lf, %llf, %qf for long double
9646 #if defined(USE_LONG_DOUBLE)
9650 /* [perl #20339] - we should accept and ignore %lf rather than die */
9654 #if defined(USE_LONG_DOUBLE)
9655 intsize = args ? 0 : 'q';
9659 #if defined(HAS_LONG_DOUBLE)
9668 /* now we need (long double) if intsize == 'q', else (double) */
9670 #if LONG_DOUBLESIZE > DOUBLESIZE
9672 va_arg(*args, long double) :
9673 va_arg(*args, double)
9675 va_arg(*args, double)
9680 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9681 else. frexp() has some unspecified behaviour for those three */
9682 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9684 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9685 will cast our (long double) to (double) */
9686 (void)Perl_frexp(nv, &i);
9687 if (i == PERL_INT_MIN)
9688 Perl_die(aTHX_ "panic: frexp");
9690 need = BIT_DIGITS(i);
9692 need += has_precis ? precis : 6; /* known default */
9697 #ifdef HAS_LDBL_SPRINTF_BUG
9698 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9699 with sfio - Allen <allens@cpan.org> */
9702 # define MY_DBL_MAX DBL_MAX
9703 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9704 # if DOUBLESIZE >= 8
9705 # define MY_DBL_MAX 1.7976931348623157E+308L
9707 # define MY_DBL_MAX 3.40282347E+38L
9711 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9712 # define MY_DBL_MAX_BUG 1L
9714 # define MY_DBL_MAX_BUG MY_DBL_MAX
9718 # define MY_DBL_MIN DBL_MIN
9719 # else /* XXX guessing! -Allen */
9720 # if DOUBLESIZE >= 8
9721 # define MY_DBL_MIN 2.2250738585072014E-308L
9723 # define MY_DBL_MIN 1.17549435E-38L
9727 if ((intsize == 'q') && (c == 'f') &&
9728 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9730 /* it's going to be short enough that
9731 * long double precision is not needed */
9733 if ((nv <= 0L) && (nv >= -0L))
9734 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9736 /* would use Perl_fp_class as a double-check but not
9737 * functional on IRIX - see perl.h comments */
9739 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9740 /* It's within the range that a double can represent */
9741 #if defined(DBL_MAX) && !defined(DBL_MIN)
9742 if ((nv >= ((long double)1/DBL_MAX)) ||
9743 (nv <= (-(long double)1/DBL_MAX)))
9745 fix_ldbl_sprintf_bug = TRUE;
9748 if (fix_ldbl_sprintf_bug == TRUE) {
9758 # undef MY_DBL_MAX_BUG
9761 #endif /* HAS_LDBL_SPRINTF_BUG */
9763 need += 20; /* fudge factor */
9764 if (PL_efloatsize < need) {
9765 Safefree(PL_efloatbuf);
9766 PL_efloatsize = need + 20; /* more fudge */
9767 Newx(PL_efloatbuf, PL_efloatsize, char);
9768 PL_efloatbuf[0] = '\0';
9771 if ( !(width || left || plus || alt) && fill != '0'
9772 && has_precis && intsize != 'q' ) { /* Shortcuts */
9773 /* See earlier comment about buggy Gconvert when digits,
9775 if ( c == 'g' && precis) {
9776 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9777 /* May return an empty string for digits==0 */
9778 if (*PL_efloatbuf) {
9779 elen = strlen(PL_efloatbuf);
9780 goto float_converted;
9782 } else if ( c == 'f' && !precis) {
9783 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9788 char *ptr = ebuf + sizeof ebuf;
9791 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9792 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9793 if (intsize == 'q') {
9794 /* Copy the one or more characters in a long double
9795 * format before the 'base' ([efgEFG]) character to
9796 * the format string. */
9797 static char const prifldbl[] = PERL_PRIfldbl;
9798 char const *p = prifldbl + sizeof(prifldbl) - 3;
9799 while (p >= prifldbl) { *--ptr = *p--; }
9804 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9809 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9821 /* No taint. Otherwise we are in the strange situation
9822 * where printf() taints but print($float) doesn't.
9824 #if defined(HAS_LONG_DOUBLE)
9825 elen = ((intsize == 'q')
9826 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9827 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9829 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9833 eptr = PL_efloatbuf;
9841 i = SvCUR(sv) - origlen;
9844 case 'h': *(va_arg(*args, short*)) = i; break;
9845 default: *(va_arg(*args, int*)) = i; break;
9846 case 'l': *(va_arg(*args, long*)) = i; break;
9847 case 'V': *(va_arg(*args, IV*)) = i; break;
9849 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9854 sv_setuv_mg(argsv, (UV)i);
9855 continue; /* not "break" */
9862 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9863 && ckWARN(WARN_PRINTF))
9865 SV * const msg = sv_newmortal();
9866 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9867 (PL_op->op_type == OP_PRTF) ? "" : "s");
9870 Perl_sv_catpvf(aTHX_ msg,
9871 "\"%%%c\"", c & 0xFF);
9873 Perl_sv_catpvf(aTHX_ msg,
9874 "\"%%\\%03"UVof"\"",
9877 sv_catpvs(msg, "end of string");
9878 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9881 /* output mangled stuff ... */
9887 /* ... right here, because formatting flags should not apply */
9888 SvGROW(sv, SvCUR(sv) + elen + 1);
9890 Copy(eptr, p, elen, char);
9893 SvCUR_set(sv, p - SvPVX_const(sv));
9895 continue; /* not "break" */
9898 if (is_utf8 != has_utf8) {
9901 sv_utf8_upgrade(sv);
9904 const STRLEN old_elen = elen;
9905 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9906 sv_utf8_upgrade(nsv);
9907 eptr = SvPVX_const(nsv);
9910 if (width) { /* fudge width (can't fudge elen) */
9911 width += elen - old_elen;
9917 have = esignlen + zeros + elen;
9919 Perl_croak_nocontext(PL_memory_wrap);
9921 need = (have > width ? have : width);
9924 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9925 Perl_croak_nocontext(PL_memory_wrap);
9926 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9928 if (esignlen && fill == '0') {
9930 for (i = 0; i < (int)esignlen; i++)
9934 memset(p, fill, gap);
9937 if (esignlen && fill != '0') {
9939 for (i = 0; i < (int)esignlen; i++)
9944 for (i = zeros; i; i--)
9948 Copy(eptr, p, elen, char);
9952 memset(p, ' ', gap);
9957 Copy(dotstr, p, dotstrlen, char);
9961 vectorize = FALSE; /* done iterating over vecstr */
9968 SvCUR_set(sv, p - SvPVX_const(sv));
9976 /* =========================================================================
9978 =head1 Cloning an interpreter
9980 All the macros and functions in this section are for the private use of
9981 the main function, perl_clone().
9983 The foo_dup() functions make an exact copy of an existing foo thingy.
9984 During the course of a cloning, a hash table is used to map old addresses
9985 to new addresses. The table is created and manipulated with the
9986 ptr_table_* functions.
9990 ============================================================================*/
9993 #if defined(USE_ITHREADS)
9995 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9996 #ifndef GpREFCNT_inc
9997 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10001 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10002 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10003 If this changes, please unmerge ss_dup. */
10004 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10005 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10006 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10007 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10008 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10009 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10010 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10011 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10012 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10013 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10014 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10015 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10016 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10017 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10019 /* clone a parser */
10022 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10026 PERL_ARGS_ASSERT_PARSER_DUP;
10031 /* look for it in the table first */
10032 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10036 /* create anew and remember what it is */
10037 Newxz(parser, 1, yy_parser);
10038 ptr_table_store(PL_ptr_table, proto, parser);
10040 parser->yyerrstatus = 0;
10041 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10043 /* XXX these not yet duped */
10044 parser->old_parser = NULL;
10045 parser->stack = NULL;
10047 parser->stack_size = 0;
10048 /* XXX parser->stack->state = 0; */
10050 /* XXX eventually, just Copy() most of the parser struct ? */
10052 parser->lex_brackets = proto->lex_brackets;
10053 parser->lex_casemods = proto->lex_casemods;
10054 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10055 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10056 parser->lex_casestack = savepvn(proto->lex_casestack,
10057 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10058 parser->lex_defer = proto->lex_defer;
10059 parser->lex_dojoin = proto->lex_dojoin;
10060 parser->lex_expect = proto->lex_expect;
10061 parser->lex_formbrack = proto->lex_formbrack;
10062 parser->lex_inpat = proto->lex_inpat;
10063 parser->lex_inwhat = proto->lex_inwhat;
10064 parser->lex_op = proto->lex_op;
10065 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10066 parser->lex_starts = proto->lex_starts;
10067 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10068 parser->multi_close = proto->multi_close;
10069 parser->multi_open = proto->multi_open;
10070 parser->multi_start = proto->multi_start;
10071 parser->multi_end = proto->multi_end;
10072 parser->pending_ident = proto->pending_ident;
10073 parser->preambled = proto->preambled;
10074 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10075 parser->linestr = sv_dup_inc(proto->linestr, param);
10076 parser->expect = proto->expect;
10077 parser->copline = proto->copline;
10078 parser->last_lop_op = proto->last_lop_op;
10079 parser->lex_state = proto->lex_state;
10080 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10081 /* rsfp_filters entries have fake IoDIRP() */
10082 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10083 parser->in_my = proto->in_my;
10084 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10085 parser->error_count = proto->error_count;
10088 parser->linestr = sv_dup_inc(proto->linestr, param);
10091 char * const ols = SvPVX(proto->linestr);
10092 char * const ls = SvPVX(parser->linestr);
10094 parser->bufptr = ls + (proto->bufptr >= ols ?
10095 proto->bufptr - ols : 0);
10096 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10097 proto->oldbufptr - ols : 0);
10098 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10099 proto->oldoldbufptr - ols : 0);
10100 parser->linestart = ls + (proto->linestart >= ols ?
10101 proto->linestart - ols : 0);
10102 parser->last_uni = ls + (proto->last_uni >= ols ?
10103 proto->last_uni - ols : 0);
10104 parser->last_lop = ls + (proto->last_lop >= ols ?
10105 proto->last_lop - ols : 0);
10107 parser->bufend = ls + SvCUR(parser->linestr);
10110 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10114 parser->endwhite = proto->endwhite;
10115 parser->faketokens = proto->faketokens;
10116 parser->lasttoke = proto->lasttoke;
10117 parser->nextwhite = proto->nextwhite;
10118 parser->realtokenstart = proto->realtokenstart;
10119 parser->skipwhite = proto->skipwhite;
10120 parser->thisclose = proto->thisclose;
10121 parser->thismad = proto->thismad;
10122 parser->thisopen = proto->thisopen;
10123 parser->thisstuff = proto->thisstuff;
10124 parser->thistoken = proto->thistoken;
10125 parser->thiswhite = proto->thiswhite;
10127 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10128 parser->curforce = proto->curforce;
10130 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10131 Copy(proto->nexttype, parser->nexttype, 5, I32);
10132 parser->nexttoke = proto->nexttoke;
10138 /* duplicate a file handle */
10141 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10145 PERL_ARGS_ASSERT_FP_DUP;
10146 PERL_UNUSED_ARG(type);
10149 return (PerlIO*)NULL;
10151 /* look for it in the table first */
10152 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10156 /* create anew and remember what it is */
10157 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10158 ptr_table_store(PL_ptr_table, fp, ret);
10162 /* duplicate a directory handle */
10165 Perl_dirp_dup(pTHX_ DIR *const dp)
10167 PERL_UNUSED_CONTEXT;
10174 /* duplicate a typeglob */
10177 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10181 PERL_ARGS_ASSERT_GP_DUP;
10185 /* look for it in the table first */
10186 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10190 /* create anew and remember what it is */
10192 ptr_table_store(PL_ptr_table, gp, ret);
10195 ret->gp_refcnt = 0; /* must be before any other dups! */
10196 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10197 ret->gp_io = io_dup_inc(gp->gp_io, param);
10198 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10199 ret->gp_av = av_dup_inc(gp->gp_av, param);
10200 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10201 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10202 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10203 ret->gp_cvgen = gp->gp_cvgen;
10204 ret->gp_line = gp->gp_line;
10205 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10209 /* duplicate a chain of magic */
10212 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10214 MAGIC *mgprev = (MAGIC*)NULL;
10217 PERL_ARGS_ASSERT_MG_DUP;
10220 return (MAGIC*)NULL;
10221 /* look for it in the table first */
10222 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10226 for (; mg; mg = mg->mg_moremagic) {
10228 Newxz(nmg, 1, MAGIC);
10230 mgprev->mg_moremagic = nmg;
10233 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10234 nmg->mg_private = mg->mg_private;
10235 nmg->mg_type = mg->mg_type;
10236 nmg->mg_flags = mg->mg_flags;
10237 /* FIXME for plugins
10238 if (mg->mg_type == PERL_MAGIC_qr) {
10239 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10243 if(mg->mg_type == PERL_MAGIC_backref) {
10244 /* The backref AV has its reference count deliberately bumped by
10246 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10249 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10250 ? sv_dup_inc(mg->mg_obj, param)
10251 : sv_dup(mg->mg_obj, param);
10253 nmg->mg_len = mg->mg_len;
10254 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10255 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10256 if (mg->mg_len > 0) {
10257 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10258 if (mg->mg_type == PERL_MAGIC_overload_table &&
10259 AMT_AMAGIC((AMT*)mg->mg_ptr))
10261 const AMT * const amtp = (AMT*)mg->mg_ptr;
10262 AMT * const namtp = (AMT*)nmg->mg_ptr;
10264 for (i = 1; i < NofAMmeth; i++) {
10265 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10269 else if (mg->mg_len == HEf_SVKEY)
10270 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10272 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10273 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10280 #endif /* USE_ITHREADS */
10282 /* create a new pointer-mapping table */
10285 Perl_ptr_table_new(pTHX)
10288 PERL_UNUSED_CONTEXT;
10290 Newxz(tbl, 1, PTR_TBL_t);
10291 tbl->tbl_max = 511;
10292 tbl->tbl_items = 0;
10293 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10297 #define PTR_TABLE_HASH(ptr) \
10298 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10301 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10302 following define) and at call to new_body_inline made below in
10303 Perl_ptr_table_store()
10306 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10308 /* map an existing pointer using a table */
10310 STATIC PTR_TBL_ENT_t *
10311 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10313 PTR_TBL_ENT_t *tblent;
10314 const UV hash = PTR_TABLE_HASH(sv);
10316 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10318 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10319 for (; tblent; tblent = tblent->next) {
10320 if (tblent->oldval == sv)
10327 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10329 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10331 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10332 PERL_UNUSED_CONTEXT;
10334 return tblent ? tblent->newval : NULL;
10337 /* add a new entry to a pointer-mapping table */
10340 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10342 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10344 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10345 PERL_UNUSED_CONTEXT;
10348 tblent->newval = newsv;
10350 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10352 new_body_inline(tblent, PTE_SVSLOT);
10354 tblent->oldval = oldsv;
10355 tblent->newval = newsv;
10356 tblent->next = tbl->tbl_ary[entry];
10357 tbl->tbl_ary[entry] = tblent;
10359 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10360 ptr_table_split(tbl);
10364 /* double the hash bucket size of an existing ptr table */
10367 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10369 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10370 const UV oldsize = tbl->tbl_max + 1;
10371 UV newsize = oldsize * 2;
10374 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10375 PERL_UNUSED_CONTEXT;
10377 Renew(ary, newsize, PTR_TBL_ENT_t*);
10378 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10379 tbl->tbl_max = --newsize;
10380 tbl->tbl_ary = ary;
10381 for (i=0; i < oldsize; i++, ary++) {
10382 PTR_TBL_ENT_t **curentp, **entp, *ent;
10385 curentp = ary + oldsize;
10386 for (entp = ary, ent = *ary; ent; ent = *entp) {
10387 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10389 ent->next = *curentp;
10399 /* remove all the entries from a ptr table */
10402 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10404 if (tbl && tbl->tbl_items) {
10405 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10406 UV riter = tbl->tbl_max;
10409 PTR_TBL_ENT_t *entry = array[riter];
10412 PTR_TBL_ENT_t * const oentry = entry;
10413 entry = entry->next;
10418 tbl->tbl_items = 0;
10422 /* clear and free a ptr table */
10425 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10430 ptr_table_clear(tbl);
10431 Safefree(tbl->tbl_ary);
10435 #if defined(USE_ITHREADS)
10438 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10440 PERL_ARGS_ASSERT_RVPV_DUP;
10443 SvRV_set(dstr, SvWEAKREF(sstr)
10444 ? sv_dup(SvRV(sstr), param)
10445 : sv_dup_inc(SvRV(sstr), param));
10448 else if (SvPVX_const(sstr)) {
10449 /* Has something there */
10451 /* Normal PV - clone whole allocated space */
10452 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10453 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10454 /* Not that normal - actually sstr is copy on write.
10455 But we are a true, independant SV, so: */
10456 SvREADONLY_off(dstr);
10461 /* Special case - not normally malloced for some reason */
10462 if (isGV_with_GP(sstr)) {
10463 /* Don't need to do anything here. */
10465 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10466 /* A "shared" PV - clone it as "shared" PV */
10468 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10472 /* Some other special case - random pointer */
10473 SvPV_set(dstr, SvPVX(sstr));
10478 /* Copy the NULL */
10479 SvPV_set(dstr, NULL);
10483 /* duplicate an SV of any type (including AV, HV etc) */
10486 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10491 PERL_ARGS_ASSERT_SV_DUP;
10495 if (SvTYPE(sstr) == SVTYPEMASK) {
10496 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10501 /* look for it in the table first */
10502 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10506 if(param->flags & CLONEf_JOIN_IN) {
10507 /** We are joining here so we don't want do clone
10508 something that is bad **/
10509 if (SvTYPE(sstr) == SVt_PVHV) {
10510 const HEK * const hvname = HvNAME_HEK(sstr);
10512 /** don't clone stashes if they already exist **/
10513 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10517 /* create anew and remember what it is */
10520 #ifdef DEBUG_LEAKING_SCALARS
10521 dstr->sv_debug_optype = sstr->sv_debug_optype;
10522 dstr->sv_debug_line = sstr->sv_debug_line;
10523 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10524 dstr->sv_debug_cloned = 1;
10525 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10528 ptr_table_store(PL_ptr_table, sstr, dstr);
10531 SvFLAGS(dstr) = SvFLAGS(sstr);
10532 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10533 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10536 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10537 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10538 (void*)PL_watch_pvx, SvPVX_const(sstr));
10541 /* don't clone objects whose class has asked us not to */
10542 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10547 switch (SvTYPE(sstr)) {
10549 SvANY(dstr) = NULL;
10552 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10554 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10556 SvIV_set(dstr, SvIVX(sstr));
10560 SvANY(dstr) = new_XNV();
10561 SvNV_set(dstr, SvNVX(sstr));
10563 /* case SVt_BIND: */
10566 /* These are all the types that need complex bodies allocating. */
10568 const svtype sv_type = SvTYPE(sstr);
10569 const struct body_details *const sv_type_details
10570 = bodies_by_type + sv_type;
10574 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10578 if (GvUNIQUE((GV*)sstr)) {
10579 NOOP; /* Do sharing here, and fall through */
10592 assert(sv_type_details->body_size);
10593 if (sv_type_details->arena) {
10594 new_body_inline(new_body, sv_type);
10596 = (void*)((char*)new_body - sv_type_details->offset);
10598 new_body = new_NOARENA(sv_type_details);
10602 SvANY(dstr) = new_body;
10605 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10606 ((char*)SvANY(dstr)) + sv_type_details->offset,
10607 sv_type_details->copy, char);
10609 Copy(((char*)SvANY(sstr)),
10610 ((char*)SvANY(dstr)),
10611 sv_type_details->body_size + sv_type_details->offset, char);
10614 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10615 && !isGV_with_GP(dstr))
10616 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10618 /* The Copy above means that all the source (unduplicated) pointers
10619 are now in the destination. We can check the flags and the
10620 pointers in either, but it's possible that there's less cache
10621 missing by always going for the destination.
10622 FIXME - instrument and check that assumption */
10623 if (sv_type >= SVt_PVMG) {
10624 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10625 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10626 } else if (SvMAGIC(dstr))
10627 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10629 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10632 /* The cast silences a GCC warning about unhandled types. */
10633 switch ((int)sv_type) {
10643 /* FIXME for plugins */
10644 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10647 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10648 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10649 LvTARG(dstr) = dstr;
10650 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10651 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10653 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10655 if(isGV_with_GP(sstr)) {
10656 if (GvNAME_HEK(dstr))
10657 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10658 /* Don't call sv_add_backref here as it's going to be
10659 created as part of the magic cloning of the symbol
10661 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10662 at the point of this comment. */
10663 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10664 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10665 (void)GpREFCNT_inc(GvGP(dstr));
10667 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10670 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10671 if (IoOFP(dstr) == IoIFP(sstr))
10672 IoOFP(dstr) = IoIFP(dstr);
10674 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10675 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10676 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10677 /* I have no idea why fake dirp (rsfps)
10678 should be treated differently but otherwise
10679 we end up with leaks -- sky*/
10680 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10681 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10682 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10684 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10685 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10686 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10687 if (IoDIRP(dstr)) {
10688 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10691 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10694 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10695 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10696 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10699 if (AvARRAY((AV*)sstr)) {
10700 SV **dst_ary, **src_ary;
10701 SSize_t items = AvFILLp((AV*)sstr) + 1;
10703 src_ary = AvARRAY((AV*)sstr);
10704 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10705 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10706 AvARRAY((AV*)dstr) = dst_ary;
10707 AvALLOC((AV*)dstr) = dst_ary;
10708 if (AvREAL((AV*)sstr)) {
10709 while (items-- > 0)
10710 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10713 while (items-- > 0)
10714 *dst_ary++ = sv_dup(*src_ary++, param);
10716 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10717 while (items-- > 0) {
10718 *dst_ary++ = &PL_sv_undef;
10722 AvARRAY((AV*)dstr) = NULL;
10723 AvALLOC((AV*)dstr) = (SV**)NULL;
10727 if (HvARRAY((HV*)sstr)) {
10729 const bool sharekeys = !!HvSHAREKEYS(sstr);
10730 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10731 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10733 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10734 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10736 HvARRAY(dstr) = (HE**)darray;
10737 while (i <= sxhv->xhv_max) {
10738 const HE * const source = HvARRAY(sstr)[i];
10739 HvARRAY(dstr)[i] = source
10740 ? he_dup(source, sharekeys, param) : 0;
10745 const struct xpvhv_aux * const saux = HvAUX(sstr);
10746 struct xpvhv_aux * const daux = HvAUX(dstr);
10747 /* This flag isn't copied. */
10748 /* SvOOK_on(hv) attacks the IV flags. */
10749 SvFLAGS(dstr) |= SVf_OOK;
10751 hvname = saux->xhv_name;
10752 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10754 daux->xhv_riter = saux->xhv_riter;
10755 daux->xhv_eiter = saux->xhv_eiter
10756 ? he_dup(saux->xhv_eiter,
10757 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10758 daux->xhv_backreferences =
10759 saux->xhv_backreferences
10760 ? (AV*) SvREFCNT_inc(
10761 sv_dup((SV*)saux->xhv_backreferences, param))
10764 daux->xhv_mro_meta = saux->xhv_mro_meta
10765 ? mro_meta_dup(saux->xhv_mro_meta, param)
10768 /* Record stashes for possible cloning in Perl_clone(). */
10770 av_push(param->stashes, dstr);
10774 HvARRAY((HV*)dstr) = NULL;
10777 if (!(param->flags & CLONEf_COPY_STACKS)) {
10781 /* NOTE: not refcounted */
10782 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10784 if (!CvISXSUB(dstr))
10785 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10787 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10788 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10789 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10790 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10792 /* don't dup if copying back - CvGV isn't refcounted, so the
10793 * duped GV may never be freed. A bit of a hack! DAPM */
10794 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10795 NULL : gv_dup(CvGV(dstr), param) ;
10796 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10798 CvWEAKOUTSIDE(sstr)
10799 ? cv_dup( CvOUTSIDE(dstr), param)
10800 : cv_dup_inc(CvOUTSIDE(dstr), param);
10801 if (!CvISXSUB(dstr))
10802 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10808 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10814 /* duplicate a context */
10817 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10819 PERL_CONTEXT *ncxs;
10821 PERL_ARGS_ASSERT_CX_DUP;
10824 return (PERL_CONTEXT*)NULL;
10826 /* look for it in the table first */
10827 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10831 /* create anew and remember what it is */
10832 Newx(ncxs, max + 1, PERL_CONTEXT);
10833 ptr_table_store(PL_ptr_table, cxs, ncxs);
10834 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10837 PERL_CONTEXT * const ncx = &ncxs[ix];
10838 if (CxTYPE(ncx) == CXt_SUBST) {
10839 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10842 switch (CxTYPE(ncx)) {
10844 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10845 ? cv_dup_inc(ncx->blk_sub.cv, param)
10846 : cv_dup(ncx->blk_sub.cv,param));
10847 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10848 ? av_dup_inc(ncx->blk_sub.argarray,
10851 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10853 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10854 ncx->blk_sub.oldcomppad);
10857 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10859 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10861 case CXt_LOOP_LAZYSV:
10862 ncx->blk_loop.state_u.lazysv.end
10863 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10864 /* We are taking advantage of av_dup_inc and sv_dup_inc
10865 actually being the same function, and order equivalance of
10867 We can assert the later [but only at run time :-(] */
10868 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10869 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10871 ncx->blk_loop.state_u.ary.ary
10872 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10873 case CXt_LOOP_LAZYIV:
10874 case CXt_LOOP_PLAIN:
10875 if (CxPADLOOP(ncx)) {
10876 ncx->blk_loop.oldcomppad
10877 = (PAD*)ptr_table_fetch(PL_ptr_table,
10878 ncx->blk_loop.oldcomppad);
10880 ncx->blk_loop.oldcomppad
10881 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10885 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10886 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10887 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10900 /* duplicate a stack info structure */
10903 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10907 PERL_ARGS_ASSERT_SI_DUP;
10910 return (PERL_SI*)NULL;
10912 /* look for it in the table first */
10913 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10917 /* create anew and remember what it is */
10918 Newxz(nsi, 1, PERL_SI);
10919 ptr_table_store(PL_ptr_table, si, nsi);
10921 nsi->si_stack = av_dup_inc(si->si_stack, param);
10922 nsi->si_cxix = si->si_cxix;
10923 nsi->si_cxmax = si->si_cxmax;
10924 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10925 nsi->si_type = si->si_type;
10926 nsi->si_prev = si_dup(si->si_prev, param);
10927 nsi->si_next = si_dup(si->si_next, param);
10928 nsi->si_markoff = si->si_markoff;
10933 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10934 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10935 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10936 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10937 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10938 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10939 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10940 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10941 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10942 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10943 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10944 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10945 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10946 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10949 #define pv_dup_inc(p) SAVEPV(p)
10950 #define pv_dup(p) SAVEPV(p)
10951 #define svp_dup_inc(p,pp) any_dup(p,pp)
10953 /* map any object to the new equivent - either something in the
10954 * ptr table, or something in the interpreter structure
10958 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10962 PERL_ARGS_ASSERT_ANY_DUP;
10965 return (void*)NULL;
10967 /* look for it in the table first */
10968 ret = ptr_table_fetch(PL_ptr_table, v);
10972 /* see if it is part of the interpreter structure */
10973 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10974 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10982 /* duplicate the save stack */
10985 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10988 ANY * const ss = proto_perl->Isavestack;
10989 const I32 max = proto_perl->Isavestack_max;
10990 I32 ix = proto_perl->Isavestack_ix;
11003 void (*dptr) (void*);
11004 void (*dxptr) (pTHX_ void*);
11006 PERL_ARGS_ASSERT_SS_DUP;
11008 Newxz(nss, max, ANY);
11011 const I32 type = POPINT(ss,ix);
11012 TOPINT(nss,ix) = type;
11014 case SAVEt_HELEM: /* hash element */
11015 sv = (SV*)POPPTR(ss,ix);
11016 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11018 case SAVEt_ITEM: /* normal string */
11019 case SAVEt_SV: /* scalar reference */
11020 sv = (SV*)POPPTR(ss,ix);
11021 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11024 case SAVEt_MORTALIZESV:
11025 sv = (SV*)POPPTR(ss,ix);
11026 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11028 case SAVEt_SHARED_PVREF: /* char* in shared space */
11029 c = (char*)POPPTR(ss,ix);
11030 TOPPTR(nss,ix) = savesharedpv(c);
11031 ptr = POPPTR(ss,ix);
11032 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11034 case SAVEt_GENERIC_SVREF: /* generic sv */
11035 case SAVEt_SVREF: /* scalar reference */
11036 sv = (SV*)POPPTR(ss,ix);
11037 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11038 ptr = POPPTR(ss,ix);
11039 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11041 case SAVEt_HV: /* hash reference */
11042 case SAVEt_AV: /* array reference */
11043 sv = (SV*) POPPTR(ss,ix);
11044 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11046 case SAVEt_COMPPAD:
11048 sv = (SV*) POPPTR(ss,ix);
11049 TOPPTR(nss,ix) = sv_dup(sv, param);
11051 case SAVEt_INT: /* int reference */
11052 ptr = POPPTR(ss,ix);
11053 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11054 intval = (int)POPINT(ss,ix);
11055 TOPINT(nss,ix) = intval;
11057 case SAVEt_LONG: /* long reference */
11058 ptr = POPPTR(ss,ix);
11059 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11061 case SAVEt_CLEARSV:
11062 longval = (long)POPLONG(ss,ix);
11063 TOPLONG(nss,ix) = longval;
11065 case SAVEt_I32: /* I32 reference */
11066 case SAVEt_I16: /* I16 reference */
11067 case SAVEt_I8: /* I8 reference */
11068 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11072 TOPINT(nss,ix) = i;
11074 case SAVEt_IV: /* IV reference */
11075 ptr = POPPTR(ss,ix);
11076 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11078 TOPIV(nss,ix) = iv;
11080 case SAVEt_HPTR: /* HV* reference */
11081 case SAVEt_APTR: /* AV* reference */
11082 case SAVEt_SPTR: /* SV* reference */
11083 ptr = POPPTR(ss,ix);
11084 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11085 sv = (SV*)POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = sv_dup(sv, param);
11088 case SAVEt_VPTR: /* random* reference */
11089 ptr = POPPTR(ss,ix);
11090 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11091 ptr = POPPTR(ss,ix);
11092 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11094 case SAVEt_GENERIC_PVREF: /* generic char* */
11095 case SAVEt_PPTR: /* char* reference */
11096 ptr = POPPTR(ss,ix);
11097 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11098 c = (char*)POPPTR(ss,ix);
11099 TOPPTR(nss,ix) = pv_dup(c);
11101 case SAVEt_GP: /* scalar reference */
11102 gp = (GP*)POPPTR(ss,ix);
11103 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11104 (void)GpREFCNT_inc(gp);
11105 gv = (GV*)POPPTR(ss,ix);
11106 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11109 ptr = POPPTR(ss,ix);
11110 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11111 /* these are assumed to be refcounted properly */
11113 switch (((OP*)ptr)->op_type) {
11115 case OP_LEAVESUBLV:
11119 case OP_LEAVEWRITE:
11120 TOPPTR(nss,ix) = ptr;
11123 (void) OpREFCNT_inc(o);
11127 TOPPTR(nss,ix) = NULL;
11132 TOPPTR(nss,ix) = NULL;
11135 c = (char*)POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = pv_dup_inc(c);
11139 hv = (HV*)POPPTR(ss,ix);
11140 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11141 c = (char*)POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = pv_dup_inc(c);
11144 case SAVEt_STACK_POS: /* Position on Perl stack */
11146 TOPINT(nss,ix) = i;
11148 case SAVEt_DESTRUCTOR:
11149 ptr = POPPTR(ss,ix);
11150 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11151 dptr = POPDPTR(ss,ix);
11152 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11153 any_dup(FPTR2DPTR(void *, dptr),
11156 case SAVEt_DESTRUCTOR_X:
11157 ptr = POPPTR(ss,ix);
11158 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11159 dxptr = POPDXPTR(ss,ix);
11160 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11161 any_dup(FPTR2DPTR(void *, dxptr),
11164 case SAVEt_REGCONTEXT:
11167 TOPINT(nss,ix) = i;
11170 case SAVEt_AELEM: /* array element */
11171 sv = (SV*)POPPTR(ss,ix);
11172 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11174 TOPINT(nss,ix) = i;
11175 av = (AV*)POPPTR(ss,ix);
11176 TOPPTR(nss,ix) = av_dup_inc(av, param);
11179 ptr = POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = ptr;
11184 TOPINT(nss,ix) = i;
11185 ptr = POPPTR(ss,ix);
11188 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11189 HINTS_REFCNT_UNLOCK;
11191 TOPPTR(nss,ix) = ptr;
11192 if (i & HINT_LOCALIZE_HH) {
11193 hv = (HV*)POPPTR(ss,ix);
11194 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11197 case SAVEt_PADSV_AND_MORTALIZE:
11198 longval = (long)POPLONG(ss,ix);
11199 TOPLONG(nss,ix) = longval;
11200 ptr = POPPTR(ss,ix);
11201 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11202 sv = (SV*)POPPTR(ss,ix);
11203 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11206 ptr = POPPTR(ss,ix);
11207 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11208 longval = (long)POPBOOL(ss,ix);
11209 TOPBOOL(nss,ix) = (bool)longval;
11211 case SAVEt_SET_SVFLAGS:
11213 TOPINT(nss,ix) = i;
11215 TOPINT(nss,ix) = i;
11216 sv = (SV*)POPPTR(ss,ix);
11217 TOPPTR(nss,ix) = sv_dup(sv, param);
11219 case SAVEt_RE_STATE:
11221 const struct re_save_state *const old_state
11222 = (struct re_save_state *)
11223 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11224 struct re_save_state *const new_state
11225 = (struct re_save_state *)
11226 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11228 Copy(old_state, new_state, 1, struct re_save_state);
11229 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11231 new_state->re_state_bostr
11232 = pv_dup(old_state->re_state_bostr);
11233 new_state->re_state_reginput
11234 = pv_dup(old_state->re_state_reginput);
11235 new_state->re_state_regeol
11236 = pv_dup(old_state->re_state_regeol);
11237 new_state->re_state_regoffs
11238 = (regexp_paren_pair*)
11239 any_dup(old_state->re_state_regoffs, proto_perl);
11240 new_state->re_state_reglastparen
11241 = (U32*) any_dup(old_state->re_state_reglastparen,
11243 new_state->re_state_reglastcloseparen
11244 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11246 /* XXX This just has to be broken. The old save_re_context
11247 code did SAVEGENERICPV(PL_reg_start_tmp);
11248 PL_reg_start_tmp is char **.
11249 Look above to what the dup code does for
11250 SAVEt_GENERIC_PVREF
11251 It can never have worked.
11252 So this is merely a faithful copy of the exiting bug: */
11253 new_state->re_state_reg_start_tmp
11254 = (char **) pv_dup((char *)
11255 old_state->re_state_reg_start_tmp);
11256 /* I assume that it only ever "worked" because no-one called
11257 (pseudo)fork while the regexp engine had re-entered itself.
11259 #ifdef PERL_OLD_COPY_ON_WRITE
11260 new_state->re_state_nrs
11261 = sv_dup(old_state->re_state_nrs, param);
11263 new_state->re_state_reg_magic
11264 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11266 new_state->re_state_reg_oldcurpm
11267 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11269 new_state->re_state_reg_curpm
11270 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11272 new_state->re_state_reg_oldsaved
11273 = pv_dup(old_state->re_state_reg_oldsaved);
11274 new_state->re_state_reg_poscache
11275 = pv_dup(old_state->re_state_reg_poscache);
11276 new_state->re_state_reg_starttry
11277 = pv_dup(old_state->re_state_reg_starttry);
11280 case SAVEt_COMPILE_WARNINGS:
11281 ptr = POPPTR(ss,ix);
11282 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11285 ptr = POPPTR(ss,ix);
11286 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11290 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11298 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11299 * flag to the result. This is done for each stash before cloning starts,
11300 * so we know which stashes want their objects cloned */
11303 do_mark_cloneable_stash(pTHX_ SV *const sv)
11305 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11307 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11308 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11309 if (cloner && GvCV(cloner)) {
11316 mXPUSHs(newSVhek(hvname));
11318 call_sv((SV*)GvCV(cloner), G_SCALAR);
11325 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11333 =for apidoc perl_clone
11335 Create and return a new interpreter by cloning the current one.
11337 perl_clone takes these flags as parameters:
11339 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11340 without it we only clone the data and zero the stacks,
11341 with it we copy the stacks and the new perl interpreter is
11342 ready to run at the exact same point as the previous one.
11343 The pseudo-fork code uses COPY_STACKS while the
11344 threads->create doesn't.
11346 CLONEf_KEEP_PTR_TABLE
11347 perl_clone keeps a ptr_table with the pointer of the old
11348 variable as a key and the new variable as a value,
11349 this allows it to check if something has been cloned and not
11350 clone it again but rather just use the value and increase the
11351 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11352 the ptr_table using the function
11353 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11354 reason to keep it around is if you want to dup some of your own
11355 variable who are outside the graph perl scans, example of this
11356 code is in threads.xs create
11359 This is a win32 thing, it is ignored on unix, it tells perls
11360 win32host code (which is c++) to clone itself, this is needed on
11361 win32 if you want to run two threads at the same time,
11362 if you just want to do some stuff in a separate perl interpreter
11363 and then throw it away and return to the original one,
11364 you don't need to do anything.
11369 /* XXX the above needs expanding by someone who actually understands it ! */
11370 EXTERN_C PerlInterpreter *
11371 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11374 perl_clone(PerlInterpreter *proto_perl, UV flags)
11377 #ifdef PERL_IMPLICIT_SYS
11379 PERL_ARGS_ASSERT_PERL_CLONE;
11381 /* perlhost.h so we need to call into it
11382 to clone the host, CPerlHost should have a c interface, sky */
11384 if (flags & CLONEf_CLONE_HOST) {
11385 return perl_clone_host(proto_perl,flags);
11387 return perl_clone_using(proto_perl, flags,
11389 proto_perl->IMemShared,
11390 proto_perl->IMemParse,
11392 proto_perl->IStdIO,
11396 proto_perl->IProc);
11400 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11401 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11402 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11403 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11404 struct IPerlDir* ipD, struct IPerlSock* ipS,
11405 struct IPerlProc* ipP)
11407 /* XXX many of the string copies here can be optimized if they're
11408 * constants; they need to be allocated as common memory and just
11409 * their pointers copied. */
11412 CLONE_PARAMS clone_params;
11413 CLONE_PARAMS* const param = &clone_params;
11415 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11417 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11419 /* for each stash, determine whether its objects should be cloned */
11420 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11421 PERL_SET_THX(my_perl);
11424 PoisonNew(my_perl, 1, PerlInterpreter);
11430 PL_savestack_ix = 0;
11431 PL_savestack_max = -1;
11432 PL_sig_pending = 0;
11434 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11435 # else /* !DEBUGGING */
11436 Zero(my_perl, 1, PerlInterpreter);
11437 # endif /* DEBUGGING */
11439 /* host pointers */
11441 PL_MemShared = ipMS;
11442 PL_MemParse = ipMP;
11449 #else /* !PERL_IMPLICIT_SYS */
11451 CLONE_PARAMS clone_params;
11452 CLONE_PARAMS* param = &clone_params;
11453 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11455 PERL_ARGS_ASSERT_PERL_CLONE;
11457 /* for each stash, determine whether its objects should be cloned */
11458 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11459 PERL_SET_THX(my_perl);
11462 PoisonNew(my_perl, 1, PerlInterpreter);
11468 PL_savestack_ix = 0;
11469 PL_savestack_max = -1;
11470 PL_sig_pending = 0;
11472 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11473 # else /* !DEBUGGING */
11474 Zero(my_perl, 1, PerlInterpreter);
11475 # endif /* DEBUGGING */
11476 #endif /* PERL_IMPLICIT_SYS */
11477 param->flags = flags;
11478 param->proto_perl = proto_perl;
11480 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11482 PL_body_arenas = NULL;
11483 Zero(&PL_body_roots, 1, PL_body_roots);
11485 PL_nice_chunk = NULL;
11486 PL_nice_chunk_size = 0;
11488 PL_sv_objcount = 0;
11490 PL_sv_arenaroot = NULL;
11492 PL_debug = proto_perl->Idebug;
11494 PL_hash_seed = proto_perl->Ihash_seed;
11495 PL_rehash_seed = proto_perl->Irehash_seed;
11497 #ifdef USE_REENTRANT_API
11498 /* XXX: things like -Dm will segfault here in perlio, but doing
11499 * PERL_SET_CONTEXT(proto_perl);
11500 * breaks too many other things
11502 Perl_reentrant_init(aTHX);
11505 /* create SV map for pointer relocation */
11506 PL_ptr_table = ptr_table_new();
11508 /* initialize these special pointers as early as possible */
11509 SvANY(&PL_sv_undef) = NULL;
11510 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11511 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11512 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11514 SvANY(&PL_sv_no) = new_XPVNV();
11515 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11516 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11517 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11518 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11519 SvCUR_set(&PL_sv_no, 0);
11520 SvLEN_set(&PL_sv_no, 1);
11521 SvIV_set(&PL_sv_no, 0);
11522 SvNV_set(&PL_sv_no, 0);
11523 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11525 SvANY(&PL_sv_yes) = new_XPVNV();
11526 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11527 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11528 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11529 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11530 SvCUR_set(&PL_sv_yes, 1);
11531 SvLEN_set(&PL_sv_yes, 2);
11532 SvIV_set(&PL_sv_yes, 1);
11533 SvNV_set(&PL_sv_yes, 1);
11534 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11536 /* create (a non-shared!) shared string table */
11537 PL_strtab = newHV();
11538 HvSHAREKEYS_off(PL_strtab);
11539 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11540 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11542 PL_compiling = proto_perl->Icompiling;
11544 /* These two PVs will be free'd special way so must set them same way op.c does */
11545 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11546 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11548 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11549 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11551 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11552 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11553 if (PL_compiling.cop_hints_hash) {
11555 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11556 HINTS_REFCNT_UNLOCK;
11558 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11559 #ifdef PERL_DEBUG_READONLY_OPS
11564 /* pseudo environmental stuff */
11565 PL_origargc = proto_perl->Iorigargc;
11566 PL_origargv = proto_perl->Iorigargv;
11568 param->stashes = newAV(); /* Setup array of objects to call clone on */
11570 /* Set tainting stuff before PerlIO_debug can possibly get called */
11571 PL_tainting = proto_perl->Itainting;
11572 PL_taint_warn = proto_perl->Itaint_warn;
11574 #ifdef PERLIO_LAYERS
11575 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11576 PerlIO_clone(aTHX_ proto_perl, param);
11579 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11580 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11581 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11582 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11583 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11584 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11587 PL_minus_c = proto_perl->Iminus_c;
11588 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11589 PL_localpatches = proto_perl->Ilocalpatches;
11590 PL_splitstr = proto_perl->Isplitstr;
11591 PL_minus_n = proto_perl->Iminus_n;
11592 PL_minus_p = proto_perl->Iminus_p;
11593 PL_minus_l = proto_perl->Iminus_l;
11594 PL_minus_a = proto_perl->Iminus_a;
11595 PL_minus_E = proto_perl->Iminus_E;
11596 PL_minus_F = proto_perl->Iminus_F;
11597 PL_doswitches = proto_perl->Idoswitches;
11598 PL_dowarn = proto_perl->Idowarn;
11599 PL_doextract = proto_perl->Idoextract;
11600 PL_sawampersand = proto_perl->Isawampersand;
11601 PL_unsafe = proto_perl->Iunsafe;
11602 PL_inplace = SAVEPV(proto_perl->Iinplace);
11603 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11604 PL_perldb = proto_perl->Iperldb;
11605 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11606 PL_exit_flags = proto_perl->Iexit_flags;
11608 /* magical thingies */
11609 /* XXX time(&PL_basetime) when asked for? */
11610 PL_basetime = proto_perl->Ibasetime;
11611 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11613 PL_maxsysfd = proto_perl->Imaxsysfd;
11614 PL_statusvalue = proto_perl->Istatusvalue;
11616 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11618 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11620 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11622 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11623 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11624 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11627 /* RE engine related */
11628 Zero(&PL_reg_state, 1, struct re_save_state);
11629 PL_reginterp_cnt = 0;
11630 PL_regmatch_slab = NULL;
11632 /* Clone the regex array */
11633 /* ORANGE FIXME for plugins, probably in the SV dup code.
11634 newSViv(PTR2IV(CALLREGDUPE(
11635 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11637 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11638 PL_regex_pad = AvARRAY(PL_regex_padav);
11640 /* shortcuts to various I/O objects */
11641 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11642 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11643 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11644 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11645 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11646 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11648 /* shortcuts to regexp stuff */
11649 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11651 /* shortcuts to misc objects */
11652 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11654 /* shortcuts to debugging objects */
11655 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11656 PL_DBline = gv_dup(proto_perl->IDBline, param);
11657 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11658 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11659 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11660 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11661 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11663 /* symbol tables */
11664 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11665 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11666 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11667 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11668 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11670 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11671 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11672 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11673 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11674 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11675 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11676 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11677 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11679 PL_sub_generation = proto_perl->Isub_generation;
11680 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11682 /* funky return mechanisms */
11683 PL_forkprocess = proto_perl->Iforkprocess;
11685 /* subprocess state */
11686 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11688 /* internal state */
11689 PL_maxo = proto_perl->Imaxo;
11690 if (proto_perl->Iop_mask)
11691 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11694 /* PL_asserting = proto_perl->Iasserting; */
11696 /* current interpreter roots */
11697 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11699 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11701 PL_main_start = proto_perl->Imain_start;
11702 PL_eval_root = proto_perl->Ieval_root;
11703 PL_eval_start = proto_perl->Ieval_start;
11705 /* runtime control stuff */
11706 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11708 PL_filemode = proto_perl->Ifilemode;
11709 PL_lastfd = proto_perl->Ilastfd;
11710 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11713 PL_gensym = proto_perl->Igensym;
11714 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11715 PL_laststatval = proto_perl->Ilaststatval;
11716 PL_laststype = proto_perl->Ilaststype;
11719 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11721 /* interpreter atexit processing */
11722 PL_exitlistlen = proto_perl->Iexitlistlen;
11723 if (PL_exitlistlen) {
11724 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11725 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11728 PL_exitlist = (PerlExitListEntry*)NULL;
11730 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11731 if (PL_my_cxt_size) {
11732 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11733 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11734 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11735 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11736 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11740 PL_my_cxt_list = (void**)NULL;
11741 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11742 PL_my_cxt_keys = (const char**)NULL;
11745 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11746 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11747 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11749 PL_profiledata = NULL;
11751 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11753 PAD_CLONE_VARS(proto_perl, param);
11755 #ifdef HAVE_INTERP_INTERN
11756 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11759 /* more statics moved here */
11760 PL_generation = proto_perl->Igeneration;
11761 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11763 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11764 PL_in_clean_all = proto_perl->Iin_clean_all;
11766 PL_uid = proto_perl->Iuid;
11767 PL_euid = proto_perl->Ieuid;
11768 PL_gid = proto_perl->Igid;
11769 PL_egid = proto_perl->Iegid;
11770 PL_nomemok = proto_perl->Inomemok;
11771 PL_an = proto_perl->Ian;
11772 PL_evalseq = proto_perl->Ievalseq;
11773 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11774 PL_origalen = proto_perl->Iorigalen;
11775 #ifdef PERL_USES_PL_PIDSTATUS
11776 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11778 PL_osname = SAVEPV(proto_perl->Iosname);
11779 PL_sighandlerp = proto_perl->Isighandlerp;
11781 PL_runops = proto_perl->Irunops;
11783 PL_parser = parser_dup(proto_perl->Iparser, param);
11785 PL_subline = proto_perl->Isubline;
11786 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11789 PL_cryptseen = proto_perl->Icryptseen;
11792 PL_hints = proto_perl->Ihints;
11794 PL_amagic_generation = proto_perl->Iamagic_generation;
11796 #ifdef USE_LOCALE_COLLATE
11797 PL_collation_ix = proto_perl->Icollation_ix;
11798 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11799 PL_collation_standard = proto_perl->Icollation_standard;
11800 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11801 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11802 #endif /* USE_LOCALE_COLLATE */
11804 #ifdef USE_LOCALE_NUMERIC
11805 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11806 PL_numeric_standard = proto_perl->Inumeric_standard;
11807 PL_numeric_local = proto_perl->Inumeric_local;
11808 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11809 #endif /* !USE_LOCALE_NUMERIC */
11811 /* utf8 character classes */
11812 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11813 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11814 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11815 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11816 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11817 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11818 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11819 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11820 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11821 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11822 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11823 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11824 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11825 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11826 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11827 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11828 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11829 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11830 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11831 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11833 /* Did the locale setup indicate UTF-8? */
11834 PL_utf8locale = proto_perl->Iutf8locale;
11835 /* Unicode features (see perlrun/-C) */
11836 PL_unicode = proto_perl->Iunicode;
11838 /* Pre-5.8 signals control */
11839 PL_signals = proto_perl->Isignals;
11841 /* times() ticks per second */
11842 PL_clocktick = proto_perl->Iclocktick;
11844 /* Recursion stopper for PerlIO_find_layer */
11845 PL_in_load_module = proto_perl->Iin_load_module;
11847 /* sort() routine */
11848 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11850 /* Not really needed/useful since the reenrant_retint is "volatile",
11851 * but do it for consistency's sake. */
11852 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11854 /* Hooks to shared SVs and locks. */
11855 PL_sharehook = proto_perl->Isharehook;
11856 PL_lockhook = proto_perl->Ilockhook;
11857 PL_unlockhook = proto_perl->Iunlockhook;
11858 PL_threadhook = proto_perl->Ithreadhook;
11859 PL_destroyhook = proto_perl->Idestroyhook;
11861 #ifdef THREADS_HAVE_PIDS
11862 PL_ppid = proto_perl->Ippid;
11866 PL_last_swash_hv = NULL; /* reinits on demand */
11867 PL_last_swash_klen = 0;
11868 PL_last_swash_key[0]= '\0';
11869 PL_last_swash_tmps = (U8*)NULL;
11870 PL_last_swash_slen = 0;
11872 PL_glob_index = proto_perl->Iglob_index;
11873 PL_srand_called = proto_perl->Isrand_called;
11874 PL_bitcount = NULL; /* reinits on demand */
11876 if (proto_perl->Ipsig_pend) {
11877 Newxz(PL_psig_pend, SIG_SIZE, int);
11880 PL_psig_pend = (int*)NULL;
11883 if (proto_perl->Ipsig_ptr) {
11884 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11885 Newxz(PL_psig_name, SIG_SIZE, SV*);
11886 for (i = 1; i < SIG_SIZE; i++) {
11887 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11888 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11892 PL_psig_ptr = (SV**)NULL;
11893 PL_psig_name = (SV**)NULL;
11896 /* intrpvar.h stuff */
11898 if (flags & CLONEf_COPY_STACKS) {
11899 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11900 PL_tmps_ix = proto_perl->Itmps_ix;
11901 PL_tmps_max = proto_perl->Itmps_max;
11902 PL_tmps_floor = proto_perl->Itmps_floor;
11903 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11905 while (i <= PL_tmps_ix) {
11906 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11910 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11911 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11912 Newxz(PL_markstack, i, I32);
11913 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11914 - proto_perl->Imarkstack);
11915 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11916 - proto_perl->Imarkstack);
11917 Copy(proto_perl->Imarkstack, PL_markstack,
11918 PL_markstack_ptr - PL_markstack + 1, I32);
11920 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11921 * NOTE: unlike the others! */
11922 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11923 PL_scopestack_max = proto_perl->Iscopestack_max;
11924 Newxz(PL_scopestack, PL_scopestack_max, I32);
11925 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11927 /* NOTE: si_dup() looks at PL_markstack */
11928 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11930 /* PL_curstack = PL_curstackinfo->si_stack; */
11931 PL_curstack = av_dup(proto_perl->Icurstack, param);
11932 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11934 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11935 PL_stack_base = AvARRAY(PL_curstack);
11936 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11937 - proto_perl->Istack_base);
11938 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11940 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11941 * NOTE: unlike the others! */
11942 PL_savestack_ix = proto_perl->Isavestack_ix;
11943 PL_savestack_max = proto_perl->Isavestack_max;
11944 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11945 PL_savestack = ss_dup(proto_perl, param);
11949 ENTER; /* perl_destruct() wants to LEAVE; */
11951 /* although we're not duplicating the tmps stack, we should still
11952 * add entries for any SVs on the tmps stack that got cloned by a
11953 * non-refcount means (eg a temp in @_); otherwise they will be
11956 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11957 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11958 proto_perl->Itmps_stack[i]);
11959 if (nsv && !SvREFCNT(nsv)) {
11961 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11966 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11967 PL_top_env = &PL_start_env;
11969 PL_op = proto_perl->Iop;
11972 PL_Xpv = (XPV*)NULL;
11973 my_perl->Ina = proto_perl->Ina;
11975 PL_statbuf = proto_perl->Istatbuf;
11976 PL_statcache = proto_perl->Istatcache;
11977 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11978 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11980 PL_timesbuf = proto_perl->Itimesbuf;
11983 PL_tainted = proto_perl->Itainted;
11984 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11985 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11986 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11987 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11988 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11989 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11990 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11991 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11992 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11994 PL_restartop = proto_perl->Irestartop;
11995 PL_in_eval = proto_perl->Iin_eval;
11996 PL_delaymagic = proto_perl->Idelaymagic;
11997 PL_dirty = proto_perl->Idirty;
11998 PL_localizing = proto_perl->Ilocalizing;
12000 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12001 PL_hv_fetch_ent_mh = NULL;
12002 PL_modcount = proto_perl->Imodcount;
12003 PL_lastgotoprobe = NULL;
12004 PL_dumpindent = proto_perl->Idumpindent;
12006 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12007 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12008 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12009 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12010 PL_efloatbuf = NULL; /* reinits on demand */
12011 PL_efloatsize = 0; /* reinits on demand */
12015 PL_screamfirst = NULL;
12016 PL_screamnext = NULL;
12017 PL_maxscream = -1; /* reinits on demand */
12018 PL_lastscream = NULL;
12021 PL_regdummy = proto_perl->Iregdummy;
12022 PL_colorset = 0; /* reinits PL_colors[] */
12023 /*PL_colors[6] = {0,0,0,0,0,0};*/
12027 /* Pluggable optimizer */
12028 PL_peepp = proto_perl->Ipeepp;
12030 PL_stashcache = newHV();
12032 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12033 proto_perl->Iwatchaddr);
12034 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12035 if (PL_debug && PL_watchaddr) {
12036 PerlIO_printf(Perl_debug_log,
12037 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12038 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12039 PTR2UV(PL_watchok));
12042 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12043 ptr_table_free(PL_ptr_table);
12044 PL_ptr_table = NULL;
12047 /* Call the ->CLONE method, if it exists, for each of the stashes
12048 identified by sv_dup() above.
12050 while(av_len(param->stashes) != -1) {
12051 HV* const stash = (HV*) av_shift(param->stashes);
12052 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12053 if (cloner && GvCV(cloner)) {
12058 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12060 call_sv((SV*)GvCV(cloner), G_DISCARD);
12066 SvREFCNT_dec(param->stashes);
12068 /* orphaned? eg threads->new inside BEGIN or use */
12069 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12070 SvREFCNT_inc_simple_void(PL_compcv);
12071 SAVEFREESV(PL_compcv);
12077 #endif /* USE_ITHREADS */
12080 =head1 Unicode Support
12082 =for apidoc sv_recode_to_utf8
12084 The encoding is assumed to be an Encode object, on entry the PV
12085 of the sv is assumed to be octets in that encoding, and the sv
12086 will be converted into Unicode (and UTF-8).
12088 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12089 is not a reference, nothing is done to the sv. If the encoding is not
12090 an C<Encode::XS> Encoding object, bad things will happen.
12091 (See F<lib/encoding.pm> and L<Encode>).
12093 The PV of the sv is returned.
12098 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12102 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12104 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12118 Passing sv_yes is wrong - it needs to be or'ed set of constants
12119 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12120 remove converted chars from source.
12122 Both will default the value - let them.
12124 XPUSHs(&PL_sv_yes);
12127 call_method("decode", G_SCALAR);
12131 s = SvPV_const(uni, len);
12132 if (s != SvPVX_const(sv)) {
12133 SvGROW(sv, len + 1);
12134 Move(s, SvPVX(sv), len + 1, char);
12135 SvCUR_set(sv, len);
12142 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12146 =for apidoc sv_cat_decode
12148 The encoding is assumed to be an Encode object, the PV of the ssv is
12149 assumed to be octets in that encoding and decoding the input starts
12150 from the position which (PV + *offset) pointed to. The dsv will be
12151 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12152 when the string tstr appears in decoding output or the input ends on
12153 the PV of the ssv. The value which the offset points will be modified
12154 to the last input position on the ssv.
12156 Returns TRUE if the terminator was found, else returns FALSE.
12161 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12162 SV *ssv, int *offset, char *tstr, int tlen)
12167 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12169 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12180 offsv = newSViv(*offset);
12182 mXPUSHp(tstr, tlen);
12184 call_method("cat_decode", G_SCALAR);
12186 ret = SvTRUE(TOPs);
12187 *offset = SvIV(offsv);
12193 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12198 /* ---------------------------------------------------------------------
12200 * support functions for report_uninit()
12203 /* the maxiumum size of array or hash where we will scan looking
12204 * for the undefined element that triggered the warning */
12206 #define FUV_MAX_SEARCH_SIZE 1000
12208 /* Look for an entry in the hash whose value has the same SV as val;
12209 * If so, return a mortal copy of the key. */
12212 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12215 register HE **array;
12218 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12220 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12221 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12224 array = HvARRAY(hv);
12226 for (i=HvMAX(hv); i>0; i--) {
12227 register HE *entry;
12228 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12229 if (HeVAL(entry) != val)
12231 if ( HeVAL(entry) == &PL_sv_undef ||
12232 HeVAL(entry) == &PL_sv_placeholder)
12236 if (HeKLEN(entry) == HEf_SVKEY)
12237 return sv_mortalcopy(HeKEY_sv(entry));
12238 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12244 /* Look for an entry in the array whose value has the same SV as val;
12245 * If so, return the index, otherwise return -1. */
12248 S_find_array_subscript(pTHX_ AV *av, SV* val)
12252 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12254 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12255 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12258 if (val != &PL_sv_undef) {
12259 SV ** const svp = AvARRAY(av);
12262 for (i=AvFILLp(av); i>=0; i--)
12269 /* S_varname(): return the name of a variable, optionally with a subscript.
12270 * If gv is non-zero, use the name of that global, along with gvtype (one
12271 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12272 * targ. Depending on the value of the subscript_type flag, return:
12275 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12276 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12277 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12278 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12281 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12282 SV* keyname, I32 aindex, int subscript_type)
12285 SV * const name = sv_newmortal();
12288 buffer[0] = gvtype;
12291 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12293 gv_fullname4(name, gv, buffer, 0);
12295 if ((unsigned int)SvPVX(name)[1] <= 26) {
12297 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12299 /* Swap the 1 unprintable control character for the 2 byte pretty
12300 version - ie substr($name, 1, 1) = $buffer; */
12301 sv_insert(name, 1, 1, buffer, 2);
12305 CV * const cv = find_runcv(NULL);
12309 if (!cv || !CvPADLIST(cv))
12311 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12312 sv = *av_fetch(av, targ, FALSE);
12313 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12316 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12317 SV * const sv = newSV(0);
12318 *SvPVX(name) = '$';
12319 Perl_sv_catpvf(aTHX_ name, "{%s}",
12320 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12323 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12324 *SvPVX(name) = '$';
12325 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12327 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12328 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12329 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12337 =for apidoc find_uninit_var
12339 Find the name of the undefined variable (if any) that caused the operator o
12340 to issue a "Use of uninitialized value" warning.
12341 If match is true, only return a name if it's value matches uninit_sv.
12342 So roughly speaking, if a unary operator (such as OP_COS) generates a
12343 warning, then following the direct child of the op may yield an
12344 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12345 other hand, with OP_ADD there are two branches to follow, so we only print
12346 the variable name if we get an exact match.
12348 The name is returned as a mortal SV.
12350 Assumes that PL_op is the op that originally triggered the error, and that
12351 PL_comppad/PL_curpad points to the currently executing pad.
12357 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12365 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12366 uninit_sv == &PL_sv_placeholder)))
12369 switch (obase->op_type) {
12376 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12377 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12380 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12382 if (pad) { /* @lex, %lex */
12383 sv = PAD_SVl(obase->op_targ);
12387 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12388 /* @global, %global */
12389 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12392 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12394 else /* @{expr}, %{expr} */
12395 return find_uninit_var(cUNOPx(obase)->op_first,
12399 /* attempt to find a match within the aggregate */
12401 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12403 subscript_type = FUV_SUBSCRIPT_HASH;
12406 index = find_array_subscript((AV*)sv, uninit_sv);
12408 subscript_type = FUV_SUBSCRIPT_ARRAY;
12411 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12414 return varname(gv, hash ? '%' : '@', obase->op_targ,
12415 keysv, index, subscript_type);
12419 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12421 return varname(NULL, '$', obase->op_targ,
12422 NULL, 0, FUV_SUBSCRIPT_NONE);
12425 gv = cGVOPx_gv(obase);
12426 if (!gv || (match && GvSV(gv) != uninit_sv))
12428 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12431 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12434 av = (AV*)PAD_SV(obase->op_targ);
12435 if (!av || SvRMAGICAL(av))
12437 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12438 if (!svp || *svp != uninit_sv)
12441 return varname(NULL, '$', obase->op_targ,
12442 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12445 gv = cGVOPx_gv(obase);
12451 if (!av || SvRMAGICAL(av))
12453 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12454 if (!svp || *svp != uninit_sv)
12457 return varname(gv, '$', 0,
12458 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12463 o = cUNOPx(obase)->op_first;
12464 if (!o || o->op_type != OP_NULL ||
12465 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12467 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12471 if (PL_op == obase)
12472 /* $a[uninit_expr] or $h{uninit_expr} */
12473 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12476 o = cBINOPx(obase)->op_first;
12477 kid = cBINOPx(obase)->op_last;
12479 /* get the av or hv, and optionally the gv */
12481 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12482 sv = PAD_SV(o->op_targ);
12484 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12485 && cUNOPo->op_first->op_type == OP_GV)
12487 gv = cGVOPx_gv(cUNOPo->op_first);
12490 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12495 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12496 /* index is constant */
12500 if (obase->op_type == OP_HELEM) {
12501 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12502 if (!he || HeVAL(he) != uninit_sv)
12506 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12507 if (!svp || *svp != uninit_sv)
12511 if (obase->op_type == OP_HELEM)
12512 return varname(gv, '%', o->op_targ,
12513 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12515 return varname(gv, '@', o->op_targ, NULL,
12516 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12519 /* index is an expression;
12520 * attempt to find a match within the aggregate */
12521 if (obase->op_type == OP_HELEM) {
12522 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12524 return varname(gv, '%', o->op_targ,
12525 keysv, 0, FUV_SUBSCRIPT_HASH);
12528 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12530 return varname(gv, '@', o->op_targ,
12531 NULL, index, FUV_SUBSCRIPT_ARRAY);
12536 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12538 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12543 /* only examine RHS */
12544 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12547 o = cUNOPx(obase)->op_first;
12548 if (o->op_type == OP_PUSHMARK)
12551 if (!o->op_sibling) {
12552 /* one-arg version of open is highly magical */
12554 if (o->op_type == OP_GV) { /* open FOO; */
12556 if (match && GvSV(gv) != uninit_sv)
12558 return varname(gv, '$', 0,
12559 NULL, 0, FUV_SUBSCRIPT_NONE);
12561 /* other possibilities not handled are:
12562 * open $x; or open my $x; should return '${*$x}'
12563 * open expr; should return '$'.expr ideally
12569 /* ops where $_ may be an implicit arg */
12573 if ( !(obase->op_flags & OPf_STACKED)) {
12574 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12575 ? PAD_SVl(obase->op_targ)
12578 sv = sv_newmortal();
12579 sv_setpvn(sv, "$_", 2);
12588 match = 1; /* print etc can return undef on defined args */
12589 /* skip filehandle as it can't produce 'undef' warning */
12590 o = cUNOPx(obase)->op_first;
12591 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12592 o = o->op_sibling->op_sibling;
12596 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12598 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12600 /* the following ops are capable of returning PL_sv_undef even for
12601 * defined arg(s) */
12620 case OP_GETPEERNAME:
12668 case OP_SMARTMATCH:
12677 /* XXX tmp hack: these two may call an XS sub, and currently
12678 XS subs don't have a SUB entry on the context stack, so CV and
12679 pad determination goes wrong, and BAD things happen. So, just
12680 don't try to determine the value under those circumstances.
12681 Need a better fix at dome point. DAPM 11/2007 */
12686 /* def-ness of rval pos() is independent of the def-ness of its arg */
12687 if ( !(obase->op_flags & OPf_MOD))
12692 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12693 return newSVpvs_flags("${$/}", SVs_TEMP);
12698 if (!(obase->op_flags & OPf_KIDS))
12700 o = cUNOPx(obase)->op_first;
12706 /* if all except one arg are constant, or have no side-effects,
12707 * or are optimized away, then it's unambiguous */
12709 for (kid=o; kid; kid = kid->op_sibling) {
12711 const OPCODE type = kid->op_type;
12712 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12713 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12714 || (type == OP_PUSHMARK)
12718 if (o2) { /* more than one found */
12725 return find_uninit_var(o2, uninit_sv, match);
12727 /* scan all args */
12729 sv = find_uninit_var(o, uninit_sv, 1);
12741 =for apidoc report_uninit
12743 Print appropriate "Use of uninitialized variable" warning
12749 Perl_report_uninit(pTHX_ SV* uninit_sv)
12753 SV* varname = NULL;
12755 varname = find_uninit_var(PL_op, uninit_sv,0);
12757 sv_insert(varname, 0, 0, " ", 1);
12759 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12760 varname ? SvPV_nolen_const(varname) : "",
12761 " in ", OP_DESC(PL_op));
12764 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12770 * c-indentation-style: bsd
12771 * c-basic-offset: 4
12772 * indent-tabs-mode: t
12775 * ex: set ts=8 sts=4 sw=4 noet: