3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
176 #ifdef DEBUG_LEAKING_SCALARS
177 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
179 # define FREE_SV_DEBUG_FILE(sv)
183 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
184 /* Whilst I'd love to do this, it seems that things like to check on
186 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
188 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
189 PoisonNew(&SvREFCNT(sv), 1, U32)
191 # define SvARENA_CHAIN(sv) SvANY(sv)
192 # define POSION_SV_HEAD(sv)
195 #define plant_SV(p) \
197 FREE_SV_DEBUG_FILE(p); \
199 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 #define uproot_SV(p) \
208 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
213 /* make some more SVs by adding another arena */
222 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
223 PL_nice_chunk = NULL;
224 PL_nice_chunk_size = 0;
227 char *chunk; /* must use New here to match call to */
228 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
229 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
235 /* new_SV(): return a new, empty SV head */
237 #ifdef DEBUG_LEAKING_SCALARS
238 /* provide a real function for a debugger to play with */
247 sv = S_more_sv(aTHX);
251 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
252 sv->sv_debug_line = (U16) (PL_parser && PL_parser->copline != NOLINE
258 sv->sv_debug_inpad = 0;
259 sv->sv_debug_cloned = 0;
260 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
264 # define new_SV(p) (p)=S_new_SV(aTHX)
272 (p) = S_more_sv(aTHX); \
280 /* del_SV(): return an empty SV head to the free list */
293 S_del_sv(pTHX_ SV *p)
297 PERL_ARGS_ASSERT_DEL_SV;
302 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
303 const SV * const sv = sva + 1;
304 const SV * const svend = &sva[SvREFCNT(sva)];
305 if (p >= sv && p < svend) {
311 if (ckWARN_d(WARN_INTERNAL))
312 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
313 "Attempt to free non-arena SV: 0x%"UVxf
314 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
321 #else /* ! DEBUGGING */
323 #define del_SV(p) plant_SV(p)
325 #endif /* DEBUGGING */
329 =head1 SV Manipulation Functions
331 =for apidoc sv_add_arena
333 Given a chunk of memory, link it to the head of the list of arenas,
334 and split it into a list of free SVs.
340 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
343 SV* const sva = (SV*)ptr;
347 PERL_ARGS_ASSERT_SV_ADD_ARENA;
349 /* The first SV in an arena isn't an SV. */
350 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
351 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
352 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
354 PL_sv_arenaroot = sva;
355 PL_sv_root = sva + 1;
357 svend = &sva[SvREFCNT(sva) - 1];
360 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
364 /* Must always set typemask because it's always checked in on cleanup
365 when the arenas are walked looking for objects. */
366 SvFLAGS(sv) = SVTYPEMASK;
369 SvARENA_CHAIN(sv) = 0;
373 SvFLAGS(sv) = SVTYPEMASK;
376 /* visit(): call the named function for each non-free SV in the arenas
377 * whose flags field matches the flags/mask args. */
380 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
386 PERL_ARGS_ASSERT_VISIT;
388 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
389 register const SV * const svend = &sva[SvREFCNT(sva)];
391 for (sv = sva + 1; sv < svend; ++sv) {
392 if (SvTYPE(sv) != SVTYPEMASK
393 && (sv->sv_flags & mask) == flags
406 /* called by sv_report_used() for each live SV */
409 do_report_used(pTHX_ SV *const sv)
411 if (SvTYPE(sv) != SVTYPEMASK) {
412 PerlIO_printf(Perl_debug_log, "****\n");
419 =for apidoc sv_report_used
421 Dump the contents of all SVs not yet freed. (Debugging aid).
427 Perl_sv_report_used(pTHX)
430 visit(do_report_used, 0, 0);
436 /* called by sv_clean_objs() for each live SV */
439 do_clean_objs(pTHX_ SV *const ref)
444 SV * const target = SvRV(ref);
445 if (SvOBJECT(target)) {
446 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
447 if (SvWEAKREF(ref)) {
448 sv_del_backref(target, ref);
454 SvREFCNT_dec(target);
459 /* XXX Might want to check arrays, etc. */
462 /* called by sv_clean_objs() for each live SV */
464 #ifndef DISABLE_DESTRUCTOR_KLUDGE
466 do_clean_named_objs(pTHX_ SV *const sv)
469 assert(SvTYPE(sv) == SVt_PVGV);
470 assert(isGV_with_GP(sv));
473 #ifdef PERL_DONT_CREATE_GVSV
476 SvOBJECT(GvSV(sv))) ||
477 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
478 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
479 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
480 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *const sv)
518 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
519 /* don't clean pid table and strtab */
522 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
523 SvFLAGS(sv) |= SVf_BREAK;
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list.
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types, by changing array* fields
561 in body_details_by_type[] below.
564 char *arena; /* the raw storage, allocated aligned */
565 size_t size; /* its size ~4k typ */
566 U32 misc; /* type, and in future other things. */
571 /* Get the maximum number of elements in set[] such that struct arena_set
572 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
573 therefore likely to be 1 aligned memory page. */
575 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
576 - 2 * sizeof(int)) / sizeof (struct arena_desc))
579 struct arena_set* next;
580 unsigned int set_size; /* ie ARENAS_PER_SET */
581 unsigned int curr; /* index of next available arena-desc */
582 struct arena_desc set[ARENAS_PER_SET];
586 =for apidoc sv_free_arenas
588 Deallocate the memory used by all arenas. Note that all the individual SV
589 heads and bodies within the arenas must already have been freed.
594 Perl_sv_free_arenas(pTHX)
601 /* Free arenas here, but be careful about fake ones. (We assume
602 contiguity of the fake ones with the corresponding real ones.) */
604 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
605 svanext = (SV*) SvANY(sva);
606 while (svanext && SvFAKE(svanext))
607 svanext = (SV*) SvANY(svanext);
614 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
617 struct arena_set *current = aroot;
620 assert(aroot->set[i].arena);
621 Safefree(aroot->set[i].arena);
629 i = PERL_ARENA_ROOTS_SIZE;
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
682 struct arena_desc* adesc;
683 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!aroot || aroot->curr >= aroot->set_size) {
692 struct arena_set *newroot;
693 Newxz(newroot, 1, struct arena_set);
694 newroot->set_size = ARENAS_PER_SET;
695 newroot->next = aroot;
697 PL_body_arenas = (void *) newroot;
698 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
701 /* ok, now have arena-set with at least 1 empty/available arena-desc */
702 curr = aroot->curr++;
703 adesc = &(aroot->set[curr]);
704 assert(!adesc->arena);
706 Newx(adesc->arena, arena_size, char);
707 adesc->size = arena_size;
709 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
710 curr, (void*)adesc->arena, (UV)arena_size));
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
721 *thing_copy = *root; \
722 *root = (void*)thing_copy; \
727 =head1 SV-Body Allocation
729 Allocation of SV-bodies is similar to SV-heads, differing as follows;
730 the allocation mechanism is used for many body types, so is somewhat
731 more complicated, it uses arena-sets, and has no need for still-live
734 At the outermost level, (new|del)_X*V macros return bodies of the
735 appropriate type. These macros call either (new|del)_body_type or
736 (new|del)_body_allocated macro pairs, depending on specifics of the
737 type. Most body types use the former pair, the latter pair is used to
738 allocate body types with "ghost fields".
740 "ghost fields" are fields that are unused in certain types, and
741 consequently dont need to actually exist. They are declared because
742 they're part of a "base type", which allows use of functions as
743 methods. The simplest examples are AVs and HVs, 2 aggregate types
744 which don't use the fields which support SCALAR semantics.
746 For these types, the arenas are carved up into *_allocated size
747 chunks, we thus avoid wasted memory for those unaccessed members.
748 When bodies are allocated, we adjust the pointer back in memory by the
749 size of the bit not allocated, so it's as if we allocated the full
750 structure. (But things will all go boom if you write to the part that
751 is "not there", because you'll be overwriting the last members of the
752 preceding structure in memory.)
754 We calculate the correction using the STRUCT_OFFSET macro. For
755 example, if xpv_allocated is the same structure as XPV then the two
756 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
757 structure is smaller (no initial NV actually allocated) then the net
758 effect is to subtract the size of the NV from the pointer, to return a
759 new pointer as if an initial NV were actually allocated.
761 This is the same trick as was used for NV and IV bodies. Ironically it
762 doesn't need to be used for NV bodies any more, because NV is now at
763 the start of the structure. IV bodies don't need it either, because
764 they are no longer allocated.
766 In turn, the new_body_* allocators call S_new_body(), which invokes
767 new_body_inline macro, which takes a lock, and takes a body off the
768 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
769 necessary to refresh an empty list. Then the lock is released, and
770 the body is returned.
772 S_more_bodies calls get_arena(), and carves it up into an array of N
773 bodies, which it strings into a linked list. It looks up arena-size
774 and body-size from the body_details table described below, thus
775 supporting the multiple body-types.
777 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
778 the (new|del)_X*V macros are mapped directly to malloc/free.
784 For each sv-type, struct body_details bodies_by_type[] carries
785 parameters which control these aspects of SV handling:
787 Arena_size determines whether arenas are used for this body type, and if
788 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
789 zero, forcing individual mallocs and frees.
791 Body_size determines how big a body is, and therefore how many fit into
792 each arena. Offset carries the body-pointer adjustment needed for
793 *_allocated body types, and is used in *_allocated macros.
795 But its main purpose is to parameterize info needed in
796 Perl_sv_upgrade(). The info here dramatically simplifies the function
797 vs the implementation in 5.8.7, making it table-driven. All fields
798 are used for this, except for arena_size.
800 For the sv-types that have no bodies, arenas are not used, so those
801 PL_body_roots[sv_type] are unused, and can be overloaded. In
802 something of a special case, SVt_NULL is borrowed for HE arenas;
803 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
804 bodies_by_type[SVt_NULL] slot is not used, as the table is not
807 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
808 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
809 just use the same allocation semantics. At first, PTEs were also
810 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
811 bugs, so was simplified by claiming a new slot. This choice has no
812 consequence at this time.
816 struct body_details {
817 U8 body_size; /* Size to allocate */
818 U8 copy; /* Size of structure to copy (may be shorter) */
820 unsigned int type : 4; /* We have space for a sanity check. */
821 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
822 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
823 unsigned int arena : 1; /* Allocated from an arena */
824 size_t arena_size; /* Size of arena to allocate */
832 /* With -DPURFIY we allocate everything directly, and don't use arenas.
833 This seems a rather elegant way to simplify some of the code below. */
834 #define HASARENA FALSE
836 #define HASARENA TRUE
838 #define NOARENA FALSE
840 /* Size the arenas to exactly fit a given number of bodies. A count
841 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
842 simplifying the default. If count > 0, the arena is sized to fit
843 only that many bodies, allowing arenas to be used for large, rare
844 bodies (XPVFM, XPVIO) without undue waste. The arena size is
845 limited by PERL_ARENA_SIZE, so we can safely oversize the
848 #define FIT_ARENA0(body_size) \
849 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
850 #define FIT_ARENAn(count,body_size) \
851 ( count * body_size <= PERL_ARENA_SIZE) \
852 ? count * body_size \
853 : FIT_ARENA0 (body_size)
854 #define FIT_ARENA(count,body_size) \
856 ? FIT_ARENAn (count, body_size) \
857 : FIT_ARENA0 (body_size)
859 /* A macro to work out the offset needed to subtract from a pointer to (say)
866 to make its members accessible via a pointer to (say)
876 #define relative_STRUCT_OFFSET(longer, shorter, member) \
877 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
879 /* Calculate the length to copy. Specifically work out the length less any
880 final padding the compiler needed to add. See the comment in sv_upgrade
881 for why copying the padding proved to be a bug. */
883 #define copy_length(type, last_member) \
884 STRUCT_OFFSET(type, last_member) \
885 + sizeof (((type*)SvANY((SV*)0))->last_member)
887 static const struct body_details bodies_by_type[] = {
888 { sizeof(HE), 0, 0, SVt_NULL,
889 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
891 /* The bind placeholder pretends to be an RV for now.
892 Also it's marked as "can't upgrade" to stop anyone using it before it's
894 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
896 /* IVs are in the head, so the allocation size is 0.
897 However, the slot is overloaded for PTEs. */
898 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
899 sizeof(IV), /* This is used to copy out the IV body. */
900 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
901 NOARENA /* IVS don't need an arena */,
902 /* But PTEs need to know the size of their arena */
903 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
908 FIT_ARENA(0, sizeof(NV)) },
910 /* 8 bytes on most ILP32 with IEEE doubles */
911 { sizeof(xpv_allocated),
912 copy_length(XPV, xpv_len)
913 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
918 { sizeof(xpviv_allocated),
919 copy_length(XPVIV, xiv_u)
920 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
925 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
929 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
933 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
934 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
935 SVt_REGEXP, FALSE, NONV, HASARENA,
936 FIT_ARENA(0, sizeof(struct regexp_allocated))
940 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
944 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
945 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
947 { sizeof(xpvav_allocated),
948 copy_length(XPVAV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
953 { sizeof(xpvhv_allocated),
954 copy_length(XPVHV, xmg_stash)
955 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
960 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
961 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
962 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
964 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
965 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
966 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
968 /* XPVIO is 84 bytes, fits 48x */
969 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
970 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
971 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
974 #define new_body_type(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type))
977 #define del_body_type(p, sv_type) \
978 del_body(p, &PL_body_roots[sv_type])
981 #define new_body_allocated(sv_type) \
982 (void *)((char *)S_new_body(aTHX_ sv_type) \
983 - bodies_by_type[sv_type].offset)
985 #define del_body_allocated(p, sv_type) \
986 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
989 #define my_safemalloc(s) (void*)safemalloc(s)
990 #define my_safecalloc(s) (void*)safecalloc(s, 1)
991 #define my_safefree(p) safefree((char*)p)
995 #define new_XNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XNV(p) my_safefree(p)
998 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
999 #define del_XPVNV(p) my_safefree(p)
1001 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1002 #define del_XPVAV(p) my_safefree(p)
1004 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1005 #define del_XPVHV(p) my_safefree(p)
1007 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1008 #define del_XPVMG(p) my_safefree(p)
1010 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1011 #define del_XPVGV(p) my_safefree(p)
1015 #define new_XNV() new_body_type(SVt_NV)
1016 #define del_XNV(p) del_body_type(p, SVt_NV)
1018 #define new_XPVNV() new_body_type(SVt_PVNV)
1019 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1021 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1022 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1024 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1025 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1027 #define new_XPVMG() new_body_type(SVt_PVMG)
1028 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1030 #define new_XPVGV() new_body_type(SVt_PVGV)
1031 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1035 /* no arena for you! */
1037 #define new_NOARENA(details) \
1038 my_safemalloc((details)->body_size + (details)->offset)
1039 #define new_NOARENAZ(details) \
1040 my_safecalloc((details)->body_size + (details)->offset)
1043 S_more_bodies (pTHX_ const svtype sv_type)
1046 void ** const root = &PL_body_roots[sv_type];
1047 const struct body_details * const bdp = &bodies_by_type[sv_type];
1048 const size_t body_size = bdp->body_size;
1051 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1052 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1053 static bool done_sanity_check;
1055 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1056 * variables like done_sanity_check. */
1057 if (!done_sanity_check) {
1058 unsigned int i = SVt_LAST;
1060 done_sanity_check = TRUE;
1063 assert (bodies_by_type[i].type == i);
1067 assert(bdp->arena_size);
1069 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1071 end = start + arena_size - 2 * body_size;
1073 /* computed count doesnt reflect the 1st slot reservation */
1074 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1075 DEBUG_m(PerlIO_printf(Perl_debug_log,
1076 "arena %p end %p arena-size %d (from %d) type %d "
1078 (void*)start, (void*)end, (int)arena_size,
1079 (int)bdp->arena_size, sv_type, (int)body_size,
1080 (int)arena_size / (int)body_size));
1082 DEBUG_m(PerlIO_printf(Perl_debug_log,
1083 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1084 (void*)start, (void*)end,
1085 (int)bdp->arena_size, sv_type, (int)body_size,
1086 (int)bdp->arena_size / (int)body_size));
1088 *root = (void *)start;
1090 while (start <= end) {
1091 char * const next = start + body_size;
1092 *(void**) start = (void *)next;
1095 *(void **)start = 0;
1100 /* grab a new thing from the free list, allocating more if necessary.
1101 The inline version is used for speed in hot routines, and the
1102 function using it serves the rest (unless PURIFY).
1104 #define new_body_inline(xpv, sv_type) \
1106 void ** const r3wt = &PL_body_roots[sv_type]; \
1107 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1108 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1109 *(r3wt) = *(void**)(xpv); \
1115 S_new_body(pTHX_ const svtype sv_type)
1119 new_body_inline(xpv, sv_type);
1125 static const struct body_details fake_rv =
1126 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1129 =for apidoc sv_upgrade
1131 Upgrade an SV to a more complex form. Generally adds a new body type to the
1132 SV, then copies across as much information as possible from the old body.
1133 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1139 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1144 const svtype old_type = SvTYPE(sv);
1145 const struct body_details *new_type_details;
1146 const struct body_details *old_type_details
1147 = bodies_by_type + old_type;
1148 SV *referant = NULL;
1150 PERL_ARGS_ASSERT_SV_UPGRADE;
1152 if (new_type != SVt_PV && SvIsCOW(sv)) {
1153 sv_force_normal_flags(sv, 0);
1156 if (old_type == new_type)
1159 old_body = SvANY(sv);
1161 /* Copying structures onto other structures that have been neatly zeroed
1162 has a subtle gotcha. Consider XPVMG
1164 +------+------+------+------+------+-------+-------+
1165 | NV | CUR | LEN | IV | MAGIC | STASH |
1166 +------+------+------+------+------+-------+-------+
1167 0 4 8 12 16 20 24 28
1169 where NVs are aligned to 8 bytes, so that sizeof that structure is
1170 actually 32 bytes long, with 4 bytes of padding at the end:
1172 +------+------+------+------+------+-------+-------+------+
1173 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1174 +------+------+------+------+------+-------+-------+------+
1175 0 4 8 12 16 20 24 28 32
1177 so what happens if you allocate memory for this structure:
1179 +------+------+------+------+------+-------+-------+------+------+...
1180 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1181 +------+------+------+------+------+-------+-------+------+------+...
1182 0 4 8 12 16 20 24 28 32 36
1184 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1185 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1186 started out as zero once, but it's quite possible that it isn't. So now,
1187 rather than a nicely zeroed GP, you have it pointing somewhere random.
1190 (In fact, GP ends up pointing at a previous GP structure, because the
1191 principle cause of the padding in XPVMG getting garbage is a copy of
1192 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1193 this happens to be moot because XPVGV has been re-ordered, with GP
1194 no longer after STASH)
1196 So we are careful and work out the size of used parts of all the
1204 referant = SvRV(sv);
1205 old_type_details = &fake_rv;
1206 if (new_type == SVt_NV)
1207 new_type = SVt_PVNV;
1209 if (new_type < SVt_PVIV) {
1210 new_type = (new_type == SVt_NV)
1211 ? SVt_PVNV : SVt_PVIV;
1216 if (new_type < SVt_PVNV) {
1217 new_type = SVt_PVNV;
1221 assert(new_type > SVt_PV);
1222 assert(SVt_IV < SVt_PV);
1223 assert(SVt_NV < SVt_PV);
1230 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1231 there's no way that it can be safely upgraded, because perl.c
1232 expects to Safefree(SvANY(PL_mess_sv)) */
1233 assert(sv != PL_mess_sv);
1234 /* This flag bit is used to mean other things in other scalar types.
1235 Given that it only has meaning inside the pad, it shouldn't be set
1236 on anything that can get upgraded. */
1237 assert(!SvPAD_TYPED(sv));
1240 if (old_type_details->cant_upgrade)
1241 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1242 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1245 if (old_type > new_type)
1246 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1247 (int)old_type, (int)new_type);
1249 new_type_details = bodies_by_type + new_type;
1251 SvFLAGS(sv) &= ~SVTYPEMASK;
1252 SvFLAGS(sv) |= new_type;
1254 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1255 the return statements above will have triggered. */
1256 assert (new_type != SVt_NULL);
1259 assert(old_type == SVt_NULL);
1260 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1264 assert(old_type == SVt_NULL);
1265 SvANY(sv) = new_XNV();
1270 assert(new_type_details->body_size);
1273 assert(new_type_details->arena);
1274 assert(new_type_details->arena_size);
1275 /* This points to the start of the allocated area. */
1276 new_body_inline(new_body, new_type);
1277 Zero(new_body, new_type_details->body_size, char);
1278 new_body = ((char *)new_body) - new_type_details->offset;
1280 /* We always allocated the full length item with PURIFY. To do this
1281 we fake things so that arena is false for all 16 types.. */
1282 new_body = new_NOARENAZ(new_type_details);
1284 SvANY(sv) = new_body;
1285 if (new_type == SVt_PVAV) {
1289 if (old_type_details->body_size) {
1292 /* It will have been zeroed when the new body was allocated.
1293 Lets not write to it, in case it confuses a write-back
1299 #ifndef NODEFAULT_SHAREKEYS
1300 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1302 HvMAX(sv) = 7; /* (start with 8 buckets) */
1303 if (old_type_details->body_size) {
1306 /* It will have been zeroed when the new body was allocated.
1307 Lets not write to it, in case it confuses a write-back
1312 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1313 The target created by newSVrv also is, and it can have magic.
1314 However, it never has SvPVX set.
1316 if (old_type == SVt_IV) {
1318 } else if (old_type >= SVt_PV) {
1319 assert(SvPVX_const(sv) == 0);
1322 if (old_type >= SVt_PVMG) {
1323 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1324 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1326 sv->sv_u.svu_array = NULL; /* or svu_hash */
1332 /* XXX Is this still needed? Was it ever needed? Surely as there is
1333 no route from NV to PVIV, NOK can never be true */
1334 assert(!SvNOKp(sv));
1346 assert(new_type_details->body_size);
1347 /* We always allocated the full length item with PURIFY. To do this
1348 we fake things so that arena is false for all 16 types.. */
1349 if(new_type_details->arena) {
1350 /* This points to the start of the allocated area. */
1351 new_body_inline(new_body, new_type);
1352 Zero(new_body, new_type_details->body_size, char);
1353 new_body = ((char *)new_body) - new_type_details->offset;
1355 new_body = new_NOARENAZ(new_type_details);
1357 SvANY(sv) = new_body;
1359 if (old_type_details->copy) {
1360 /* There is now the potential for an upgrade from something without
1361 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1362 int offset = old_type_details->offset;
1363 int length = old_type_details->copy;
1365 if (new_type_details->offset > old_type_details->offset) {
1366 const int difference
1367 = new_type_details->offset - old_type_details->offset;
1368 offset += difference;
1369 length -= difference;
1371 assert (length >= 0);
1373 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1378 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1379 * correct 0.0 for us. Otherwise, if the old body didn't have an
1380 * NV slot, but the new one does, then we need to initialise the
1381 * freshly created NV slot with whatever the correct bit pattern is
1383 if (old_type_details->zero_nv && !new_type_details->zero_nv
1384 && !isGV_with_GP(sv))
1388 if (new_type == SVt_PVIO)
1389 IoPAGE_LEN(sv) = 60;
1390 if (old_type < SVt_PV) {
1391 /* referant will be NULL unless the old type was SVt_IV emulating
1393 sv->sv_u.svu_rv = referant;
1397 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1398 (unsigned long)new_type);
1401 if (old_type_details->arena) {
1402 /* If there was an old body, then we need to free it.
1403 Note that there is an assumption that all bodies of types that
1404 can be upgraded came from arenas. Only the more complex non-
1405 upgradable types are allowed to be directly malloc()ed. */
1407 my_safefree(old_body);
1409 del_body((void*)((char*)old_body + old_type_details->offset),
1410 &PL_body_roots[old_type]);
1416 =for apidoc sv_backoff
1418 Remove any string offset. You should normally use the C<SvOOK_off> macro
1425 Perl_sv_backoff(pTHX_ register SV *const sv)
1428 const char * const s = SvPVX_const(sv);
1430 PERL_ARGS_ASSERT_SV_BACKOFF;
1431 PERL_UNUSED_CONTEXT;
1434 assert(SvTYPE(sv) != SVt_PVHV);
1435 assert(SvTYPE(sv) != SVt_PVAV);
1437 SvOOK_offset(sv, delta);
1439 SvLEN_set(sv, SvLEN(sv) + delta);
1440 SvPV_set(sv, SvPVX(sv) - delta);
1441 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1442 SvFLAGS(sv) &= ~SVf_OOK;
1449 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1450 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1451 Use the C<SvGROW> wrapper instead.
1457 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1461 PERL_ARGS_ASSERT_SV_GROW;
1463 if (PL_madskills && newlen >= 0x100000) {
1464 PerlIO_printf(Perl_debug_log,
1465 "Allocation too large: %"UVxf"\n", (UV)newlen);
1467 #ifdef HAS_64K_LIMIT
1468 if (newlen >= 0x10000) {
1469 PerlIO_printf(Perl_debug_log,
1470 "Allocation too large: %"UVxf"\n", (UV)newlen);
1473 #endif /* HAS_64K_LIMIT */
1476 if (SvTYPE(sv) < SVt_PV) {
1477 sv_upgrade(sv, SVt_PV);
1478 s = SvPVX_mutable(sv);
1480 else if (SvOOK(sv)) { /* pv is offset? */
1482 s = SvPVX_mutable(sv);
1483 if (newlen > SvLEN(sv))
1484 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1485 #ifdef HAS_64K_LIMIT
1486 if (newlen >= 0x10000)
1491 s = SvPVX_mutable(sv);
1493 if (newlen > SvLEN(sv)) { /* need more room? */
1494 #ifndef Perl_safesysmalloc_size
1495 newlen = PERL_STRLEN_ROUNDUP(newlen);
1497 if (SvLEN(sv) && s) {
1498 s = (char*)saferealloc(s, newlen);
1501 s = (char*)safemalloc(newlen);
1502 if (SvPVX_const(sv) && SvCUR(sv)) {
1503 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1507 #ifdef Perl_safesysmalloc_size
1508 /* Do this here, do it once, do it right, and then we will never get
1509 called back into sv_grow() unless there really is some growing
1511 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1513 SvLEN_set(sv, newlen);
1520 =for apidoc sv_setiv
1522 Copies an integer into the given SV, upgrading first if necessary.
1523 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1529 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1533 PERL_ARGS_ASSERT_SV_SETIV;
1535 SV_CHECK_THINKFIRST_COW_DROP(sv);
1536 switch (SvTYPE(sv)) {
1539 sv_upgrade(sv, SVt_IV);
1542 sv_upgrade(sv, SVt_PVIV);
1546 if (!isGV_with_GP(sv))
1553 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1557 (void)SvIOK_only(sv); /* validate number */
1563 =for apidoc sv_setiv_mg
1565 Like C<sv_setiv>, but also handles 'set' magic.
1571 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1573 PERL_ARGS_ASSERT_SV_SETIV_MG;
1580 =for apidoc sv_setuv
1582 Copies an unsigned integer into the given SV, upgrading first if necessary.
1583 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1589 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1591 PERL_ARGS_ASSERT_SV_SETUV;
1593 /* With these two if statements:
1594 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1597 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1599 If you wish to remove them, please benchmark to see what the effect is
1601 if (u <= (UV)IV_MAX) {
1602 sv_setiv(sv, (IV)u);
1611 =for apidoc sv_setuv_mg
1613 Like C<sv_setuv>, but also handles 'set' magic.
1619 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1621 PERL_ARGS_ASSERT_SV_SETUV_MG;
1628 =for apidoc sv_setnv
1630 Copies a double into the given SV, upgrading first if necessary.
1631 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1637 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1641 PERL_ARGS_ASSERT_SV_SETNV;
1643 SV_CHECK_THINKFIRST_COW_DROP(sv);
1644 switch (SvTYPE(sv)) {
1647 sv_upgrade(sv, SVt_NV);
1651 sv_upgrade(sv, SVt_PVNV);
1655 if (!isGV_with_GP(sv))
1662 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1667 (void)SvNOK_only(sv); /* validate number */
1672 =for apidoc sv_setnv_mg
1674 Like C<sv_setnv>, but also handles 'set' magic.
1680 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1682 PERL_ARGS_ASSERT_SV_SETNV_MG;
1688 /* Print an "isn't numeric" warning, using a cleaned-up,
1689 * printable version of the offending string
1693 S_not_a_number(pTHX_ SV *const sv)
1700 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1703 dsv = newSVpvs_flags("", SVs_TEMP);
1704 pv = sv_uni_display(dsv, sv, 10, 0);
1707 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1708 /* each *s can expand to 4 chars + "...\0",
1709 i.e. need room for 8 chars */
1711 const char *s = SvPVX_const(sv);
1712 const char * const end = s + SvCUR(sv);
1713 for ( ; s < end && d < limit; s++ ) {
1715 if (ch & 128 && !isPRINT_LC(ch)) {
1724 else if (ch == '\r') {
1728 else if (ch == '\f') {
1732 else if (ch == '\\') {
1736 else if (ch == '\0') {
1740 else if (isPRINT_LC(ch))
1757 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1758 "Argument \"%s\" isn't numeric in %s", pv,
1761 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1762 "Argument \"%s\" isn't numeric", pv);
1766 =for apidoc looks_like_number
1768 Test if the content of an SV looks like a number (or is a number).
1769 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1770 non-numeric warning), even if your atof() doesn't grok them.
1776 Perl_looks_like_number(pTHX_ SV *const sv)
1778 register const char *sbegin;
1781 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1784 sbegin = SvPVX_const(sv);
1787 else if (SvPOKp(sv))
1788 sbegin = SvPV_const(sv, len);
1790 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1791 return grok_number(sbegin, len, NULL);
1795 S_glob_2number(pTHX_ GV * const gv)
1797 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1798 SV *const buffer = sv_newmortal();
1800 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1802 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1805 gv_efullname3(buffer, gv, "*");
1806 SvFLAGS(gv) |= wasfake;
1808 /* We know that all GVs stringify to something that is not-a-number,
1809 so no need to test that. */
1810 if (ckWARN(WARN_NUMERIC))
1811 not_a_number(buffer);
1812 /* We just want something true to return, so that S_sv_2iuv_common
1813 can tail call us and return true. */
1818 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1820 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1821 SV *const buffer = sv_newmortal();
1823 PERL_ARGS_ASSERT_GLOB_2PV;
1825 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1828 gv_efullname3(buffer, gv, "*");
1829 SvFLAGS(gv) |= wasfake;
1831 assert(SvPOK(buffer));
1833 *len = SvCUR(buffer);
1835 return SvPVX(buffer);
1838 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1839 until proven guilty, assume that things are not that bad... */
1844 As 64 bit platforms often have an NV that doesn't preserve all bits of
1845 an IV (an assumption perl has been based on to date) it becomes necessary
1846 to remove the assumption that the NV always carries enough precision to
1847 recreate the IV whenever needed, and that the NV is the canonical form.
1848 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1849 precision as a side effect of conversion (which would lead to insanity
1850 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1851 1) to distinguish between IV/UV/NV slots that have cached a valid
1852 conversion where precision was lost and IV/UV/NV slots that have a
1853 valid conversion which has lost no precision
1854 2) to ensure that if a numeric conversion to one form is requested that
1855 would lose precision, the precise conversion (or differently
1856 imprecise conversion) is also performed and cached, to prevent
1857 requests for different numeric formats on the same SV causing
1858 lossy conversion chains. (lossless conversion chains are perfectly
1863 SvIOKp is true if the IV slot contains a valid value
1864 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1865 SvNOKp is true if the NV slot contains a valid value
1866 SvNOK is true only if the NV value is accurate
1869 while converting from PV to NV, check to see if converting that NV to an
1870 IV(or UV) would lose accuracy over a direct conversion from PV to
1871 IV(or UV). If it would, cache both conversions, return NV, but mark
1872 SV as IOK NOKp (ie not NOK).
1874 While converting from PV to IV, check to see if converting that IV to an
1875 NV would lose accuracy over a direct conversion from PV to NV. If it
1876 would, cache both conversions, flag similarly.
1878 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1879 correctly because if IV & NV were set NV *always* overruled.
1880 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1881 changes - now IV and NV together means that the two are interchangeable:
1882 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1884 The benefit of this is that operations such as pp_add know that if
1885 SvIOK is true for both left and right operands, then integer addition
1886 can be used instead of floating point (for cases where the result won't
1887 overflow). Before, floating point was always used, which could lead to
1888 loss of precision compared with integer addition.
1890 * making IV and NV equal status should make maths accurate on 64 bit
1892 * may speed up maths somewhat if pp_add and friends start to use
1893 integers when possible instead of fp. (Hopefully the overhead in
1894 looking for SvIOK and checking for overflow will not outweigh the
1895 fp to integer speedup)
1896 * will slow down integer operations (callers of SvIV) on "inaccurate"
1897 values, as the change from SvIOK to SvIOKp will cause a call into
1898 sv_2iv each time rather than a macro access direct to the IV slot
1899 * should speed up number->string conversion on integers as IV is
1900 favoured when IV and NV are equally accurate
1902 ####################################################################
1903 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1904 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1905 On the other hand, SvUOK is true iff UV.
1906 ####################################################################
1908 Your mileage will vary depending your CPU's relative fp to integer
1912 #ifndef NV_PRESERVES_UV
1913 # define IS_NUMBER_UNDERFLOW_IV 1
1914 # define IS_NUMBER_UNDERFLOW_UV 2
1915 # define IS_NUMBER_IV_AND_UV 2
1916 # define IS_NUMBER_OVERFLOW_IV 4
1917 # define IS_NUMBER_OVERFLOW_UV 5
1919 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1921 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1923 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1931 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1933 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1934 if (SvNVX(sv) < (NV)IV_MIN) {
1935 (void)SvIOKp_on(sv);
1937 SvIV_set(sv, IV_MIN);
1938 return IS_NUMBER_UNDERFLOW_IV;
1940 if (SvNVX(sv) > (NV)UV_MAX) {
1941 (void)SvIOKp_on(sv);
1944 SvUV_set(sv, UV_MAX);
1945 return IS_NUMBER_OVERFLOW_UV;
1947 (void)SvIOKp_on(sv);
1949 /* Can't use strtol etc to convert this string. (See truth table in
1951 if (SvNVX(sv) <= (UV)IV_MAX) {
1952 SvIV_set(sv, I_V(SvNVX(sv)));
1953 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1954 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1956 /* Integer is imprecise. NOK, IOKp */
1958 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1962 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1963 if (SvUVX(sv) == UV_MAX) {
1964 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1965 possibly be preserved by NV. Hence, it must be overflow.
1967 return IS_NUMBER_OVERFLOW_UV;
1969 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1971 /* Integer is imprecise. NOK, IOKp */
1973 return IS_NUMBER_OVERFLOW_IV;
1975 #endif /* !NV_PRESERVES_UV*/
1978 S_sv_2iuv_common(pTHX_ SV *const sv)
1982 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1985 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1986 * without also getting a cached IV/UV from it at the same time
1987 * (ie PV->NV conversion should detect loss of accuracy and cache
1988 * IV or UV at same time to avoid this. */
1989 /* IV-over-UV optimisation - choose to cache IV if possible */
1991 if (SvTYPE(sv) == SVt_NV)
1992 sv_upgrade(sv, SVt_PVNV);
1994 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1995 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1996 certainly cast into the IV range at IV_MAX, whereas the correct
1997 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1999 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2000 if (Perl_isnan(SvNVX(sv))) {
2006 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2007 SvIV_set(sv, I_V(SvNVX(sv)));
2008 if (SvNVX(sv) == (NV) SvIVX(sv)
2009 #ifndef NV_PRESERVES_UV
2010 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2011 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2012 /* Don't flag it as "accurately an integer" if the number
2013 came from a (by definition imprecise) NV operation, and
2014 we're outside the range of NV integer precision */
2018 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2020 /* scalar has trailing garbage, eg "42a" */
2022 DEBUG_c(PerlIO_printf(Perl_debug_log,
2023 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2029 /* IV not precise. No need to convert from PV, as NV
2030 conversion would already have cached IV if it detected
2031 that PV->IV would be better than PV->NV->IV
2032 flags already correct - don't set public IOK. */
2033 DEBUG_c(PerlIO_printf(Perl_debug_log,
2034 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2039 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2040 but the cast (NV)IV_MIN rounds to a the value less (more
2041 negative) than IV_MIN which happens to be equal to SvNVX ??
2042 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2043 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2044 (NV)UVX == NVX are both true, but the values differ. :-(
2045 Hopefully for 2s complement IV_MIN is something like
2046 0x8000000000000000 which will be exact. NWC */
2049 SvUV_set(sv, U_V(SvNVX(sv)));
2051 (SvNVX(sv) == (NV) SvUVX(sv))
2052 #ifndef NV_PRESERVES_UV
2053 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2054 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2055 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2056 /* Don't flag it as "accurately an integer" if the number
2057 came from a (by definition imprecise) NV operation, and
2058 we're outside the range of NV integer precision */
2064 DEBUG_c(PerlIO_printf(Perl_debug_log,
2065 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2071 else if (SvPOKp(sv) && SvLEN(sv)) {
2073 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2074 /* We want to avoid a possible problem when we cache an IV/ a UV which
2075 may be later translated to an NV, and the resulting NV is not
2076 the same as the direct translation of the initial string
2077 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2078 be careful to ensure that the value with the .456 is around if the
2079 NV value is requested in the future).
2081 This means that if we cache such an IV/a UV, we need to cache the
2082 NV as well. Moreover, we trade speed for space, and do not
2083 cache the NV if we are sure it's not needed.
2086 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2087 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2088 == IS_NUMBER_IN_UV) {
2089 /* It's definitely an integer, only upgrade to PVIV */
2090 if (SvTYPE(sv) < SVt_PVIV)
2091 sv_upgrade(sv, SVt_PVIV);
2093 } else if (SvTYPE(sv) < SVt_PVNV)
2094 sv_upgrade(sv, SVt_PVNV);
2096 /* If NVs preserve UVs then we only use the UV value if we know that
2097 we aren't going to call atof() below. If NVs don't preserve UVs
2098 then the value returned may have more precision than atof() will
2099 return, even though value isn't perfectly accurate. */
2100 if ((numtype & (IS_NUMBER_IN_UV
2101 #ifdef NV_PRESERVES_UV
2104 )) == IS_NUMBER_IN_UV) {
2105 /* This won't turn off the public IOK flag if it was set above */
2106 (void)SvIOKp_on(sv);
2108 if (!(numtype & IS_NUMBER_NEG)) {
2110 if (value <= (UV)IV_MAX) {
2111 SvIV_set(sv, (IV)value);
2113 /* it didn't overflow, and it was positive. */
2114 SvUV_set(sv, value);
2118 /* 2s complement assumption */
2119 if (value <= (UV)IV_MIN) {
2120 SvIV_set(sv, -(IV)value);
2122 /* Too negative for an IV. This is a double upgrade, but
2123 I'm assuming it will be rare. */
2124 if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2129 SvNV_set(sv, -(NV)value);
2130 SvIV_set(sv, IV_MIN);
2134 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2135 will be in the previous block to set the IV slot, and the next
2136 block to set the NV slot. So no else here. */
2138 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2139 != IS_NUMBER_IN_UV) {
2140 /* It wasn't an (integer that doesn't overflow the UV). */
2141 SvNV_set(sv, Atof(SvPVX_const(sv)));
2143 if (! numtype && ckWARN(WARN_NUMERIC))
2146 #if defined(USE_LONG_DOUBLE)
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2150 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2151 PTR2UV(sv), SvNVX(sv)));
2154 #ifdef NV_PRESERVES_UV
2155 (void)SvIOKp_on(sv);
2157 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2158 SvIV_set(sv, I_V(SvNVX(sv)));
2159 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2162 NOOP; /* Integer is imprecise. NOK, IOKp */
2164 /* UV will not work better than IV */
2166 if (SvNVX(sv) > (NV)UV_MAX) {
2168 /* Integer is inaccurate. NOK, IOKp, is UV */
2169 SvUV_set(sv, UV_MAX);
2171 SvUV_set(sv, U_V(SvNVX(sv)));
2172 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2173 NV preservse UV so can do correct comparison. */
2174 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2177 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2182 #else /* NV_PRESERVES_UV */
2183 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2184 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2185 /* The IV/UV slot will have been set from value returned by
2186 grok_number above. The NV slot has just been set using
2189 assert (SvIOKp(sv));
2191 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2192 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2193 /* Small enough to preserve all bits. */
2194 (void)SvIOKp_on(sv);
2196 SvIV_set(sv, I_V(SvNVX(sv)));
2197 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2199 /* Assumption: first non-preserved integer is < IV_MAX,
2200 this NV is in the preserved range, therefore: */
2201 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2203 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2207 0 0 already failed to read UV.
2208 0 1 already failed to read UV.
2209 1 0 you won't get here in this case. IV/UV
2210 slot set, public IOK, Atof() unneeded.
2211 1 1 already read UV.
2212 so there's no point in sv_2iuv_non_preserve() attempting
2213 to use atol, strtol, strtoul etc. */
2215 sv_2iuv_non_preserve (sv, numtype);
2217 sv_2iuv_non_preserve (sv);
2221 #endif /* NV_PRESERVES_UV */
2222 /* It might be more code efficient to go through the entire logic above
2223 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2224 gets complex and potentially buggy, so more programmer efficient
2225 to do it this way, by turning off the public flags: */
2227 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2231 if (isGV_with_GP(sv))
2232 return glob_2number((GV *)sv);
2234 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2235 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2238 if (SvTYPE(sv) < SVt_IV)
2239 /* Typically the caller expects that sv_any is not NULL now. */
2240 sv_upgrade(sv, SVt_IV);
2241 /* Return 0 from the caller. */
2248 =for apidoc sv_2iv_flags
2250 Return the integer value of an SV, doing any necessary string
2251 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2252 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2258 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2263 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2264 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2265 cache IVs just in case. In practice it seems that they never
2266 actually anywhere accessible by user Perl code, let alone get used
2267 in anything other than a string context. */
2268 if (flags & SV_GMAGIC)
2273 return I_V(SvNVX(sv));
2275 if (SvPOKp(sv) && SvLEN(sv)) {
2278 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2281 == IS_NUMBER_IN_UV) {
2282 /* It's definitely an integer */
2283 if (numtype & IS_NUMBER_NEG) {
2284 if (value < (UV)IV_MIN)
2287 if (value < (UV)IV_MAX)
2292 if (ckWARN(WARN_NUMERIC))
2295 return I_V(Atof(SvPVX_const(sv)));
2300 assert(SvTYPE(sv) >= SVt_PVMG);
2301 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2302 } else if (SvTHINKFIRST(sv)) {
2306 SV * const tmpstr=AMG_CALLun(sv,numer);
2307 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2308 return SvIV(tmpstr);
2311 return PTR2IV(SvRV(sv));
2314 sv_force_normal_flags(sv, 0);
2316 if (SvREADONLY(sv) && !SvOK(sv)) {
2317 if (ckWARN(WARN_UNINITIALIZED))
2323 if (S_sv_2iuv_common(aTHX_ sv))
2326 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2327 PTR2UV(sv),SvIVX(sv)));
2328 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2332 =for apidoc sv_2uv_flags
2334 Return the unsigned integer value of an SV, doing any necessary string
2335 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2336 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2342 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2347 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2348 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2349 cache IVs just in case. */
2350 if (flags & SV_GMAGIC)
2355 return U_V(SvNVX(sv));
2356 if (SvPOKp(sv) && SvLEN(sv)) {
2359 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2361 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2362 == IS_NUMBER_IN_UV) {
2363 /* It's definitely an integer */
2364 if (!(numtype & IS_NUMBER_NEG))
2368 if (ckWARN(WARN_NUMERIC))
2371 return U_V(Atof(SvPVX_const(sv)));
2376 assert(SvTYPE(sv) >= SVt_PVMG);
2377 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2378 } else if (SvTHINKFIRST(sv)) {
2382 SV *const tmpstr = AMG_CALLun(sv,numer);
2383 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2384 return SvUV(tmpstr);
2387 return PTR2UV(SvRV(sv));
2390 sv_force_normal_flags(sv, 0);
2392 if (SvREADONLY(sv) && !SvOK(sv)) {
2393 if (ckWARN(WARN_UNINITIALIZED))
2399 if (S_sv_2iuv_common(aTHX_ sv))
2403 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2404 PTR2UV(sv),SvUVX(sv)));
2405 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2411 Return the num value of an SV, doing any necessary string or integer
2412 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2419 Perl_sv_2nv(pTHX_ register SV *const sv)
2424 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2425 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2426 cache IVs just in case. */
2430 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2431 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2432 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2434 return Atof(SvPVX_const(sv));
2438 return (NV)SvUVX(sv);
2440 return (NV)SvIVX(sv);
2445 assert(SvTYPE(sv) >= SVt_PVMG);
2446 /* This falls through to the report_uninit near the end of the
2448 } else if (SvTHINKFIRST(sv)) {
2452 SV *const tmpstr = AMG_CALLun(sv,numer);
2453 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2454 return SvNV(tmpstr);
2457 return PTR2NV(SvRV(sv));
2460 sv_force_normal_flags(sv, 0);
2462 if (SvREADONLY(sv) && !SvOK(sv)) {
2463 if (ckWARN(WARN_UNINITIALIZED))
2468 if (SvTYPE(sv) < SVt_NV) {
2469 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2470 sv_upgrade(sv, SVt_NV);
2471 #ifdef USE_LONG_DOUBLE
2473 STORE_NUMERIC_LOCAL_SET_STANDARD();
2474 PerlIO_printf(Perl_debug_log,
2475 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2488 else if (SvTYPE(sv) < SVt_PVNV)
2489 sv_upgrade(sv, SVt_PVNV);
2494 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2495 #ifdef NV_PRESERVES_UV
2501 /* Only set the public NV OK flag if this NV preserves the IV */
2502 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2504 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2505 : (SvIVX(sv) == I_V(SvNVX(sv))))
2511 else if (SvPOKp(sv) && SvLEN(sv)) {
2513 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2514 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2516 #ifdef NV_PRESERVES_UV
2517 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2518 == IS_NUMBER_IN_UV) {
2519 /* It's definitely an integer */
2520 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2522 SvNV_set(sv, Atof(SvPVX_const(sv)));
2528 SvNV_set(sv, Atof(SvPVX_const(sv)));
2529 /* Only set the public NV OK flag if this NV preserves the value in
2530 the PV at least as well as an IV/UV would.
2531 Not sure how to do this 100% reliably. */
2532 /* if that shift count is out of range then Configure's test is
2533 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2535 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2536 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2537 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2538 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2539 /* Can't use strtol etc to convert this string, so don't try.
2540 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2543 /* value has been set. It may not be precise. */
2544 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2545 /* 2s complement assumption for (UV)IV_MIN */
2546 SvNOK_on(sv); /* Integer is too negative. */
2551 if (numtype & IS_NUMBER_NEG) {
2552 SvIV_set(sv, -(IV)value);
2553 } else if (value <= (UV)IV_MAX) {
2554 SvIV_set(sv, (IV)value);
2556 SvUV_set(sv, value);
2560 if (numtype & IS_NUMBER_NOT_INT) {
2561 /* I believe that even if the original PV had decimals,
2562 they are lost beyond the limit of the FP precision.
2563 However, neither is canonical, so both only get p
2564 flags. NWC, 2000/11/25 */
2565 /* Both already have p flags, so do nothing */
2567 const NV nv = SvNVX(sv);
2568 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2569 if (SvIVX(sv) == I_V(nv)) {
2572 /* It had no "." so it must be integer. */
2576 /* between IV_MAX and NV(UV_MAX).
2577 Could be slightly > UV_MAX */
2579 if (numtype & IS_NUMBER_NOT_INT) {
2580 /* UV and NV both imprecise. */
2582 const UV nv_as_uv = U_V(nv);
2584 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2593 /* It might be more code efficient to go through the entire logic above
2594 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2595 gets complex and potentially buggy, so more programmer efficient
2596 to do it this way, by turning off the public flags: */
2598 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2599 #endif /* NV_PRESERVES_UV */
2602 if (isGV_with_GP(sv)) {
2603 glob_2number((GV *)sv);
2607 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2609 assert (SvTYPE(sv) >= SVt_NV);
2610 /* Typically the caller expects that sv_any is not NULL now. */
2611 /* XXX Ilya implies that this is a bug in callers that assume this
2612 and ideally should be fixed. */
2615 #if defined(USE_LONG_DOUBLE)
2617 STORE_NUMERIC_LOCAL_SET_STANDARD();
2618 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2619 PTR2UV(sv), SvNVX(sv));
2620 RESTORE_NUMERIC_LOCAL();
2624 STORE_NUMERIC_LOCAL_SET_STANDARD();
2625 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2626 PTR2UV(sv), SvNVX(sv));
2627 RESTORE_NUMERIC_LOCAL();
2636 Return an SV with the numeric value of the source SV, doing any necessary
2637 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2638 access this function.
2644 Perl_sv_2num(pTHX_ register SV *const sv)
2646 PERL_ARGS_ASSERT_SV_2NUM;
2651 SV * const tmpsv = AMG_CALLun(sv,numer);
2652 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2653 return sv_2num(tmpsv);
2655 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2658 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2659 * UV as a string towards the end of buf, and return pointers to start and
2662 * We assume that buf is at least TYPE_CHARS(UV) long.
2666 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2668 char *ptr = buf + TYPE_CHARS(UV);
2669 char * const ebuf = ptr;
2672 PERL_ARGS_ASSERT_UIV_2BUF;
2684 *--ptr = '0' + (char)(uv % 10);
2693 =for apidoc sv_2pv_flags
2695 Returns a pointer to the string value of an SV, and sets *lp to its length.
2696 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2698 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2699 usually end up here too.
2705 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2715 if (SvGMAGICAL(sv)) {
2716 if (flags & SV_GMAGIC)
2721 if (flags & SV_MUTABLE_RETURN)
2722 return SvPVX_mutable(sv);
2723 if (flags & SV_CONST_RETURN)
2724 return (char *)SvPVX_const(sv);
2727 if (SvIOKp(sv) || SvNOKp(sv)) {
2728 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2733 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2734 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2736 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2743 #ifdef FIXNEGATIVEZERO
2744 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2750 SvUPGRADE(sv, SVt_PV);
2753 s = SvGROW_mutable(sv, len + 1);
2756 return (char*)memcpy(s, tbuf, len + 1);
2762 assert(SvTYPE(sv) >= SVt_PVMG);
2763 /* This falls through to the report_uninit near the end of the
2765 } else if (SvTHINKFIRST(sv)) {
2769 SV *const tmpstr = AMG_CALLun(sv,string);
2770 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2772 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2776 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2777 if (flags & SV_CONST_RETURN) {
2778 pv = (char *) SvPVX_const(tmpstr);
2780 pv = (flags & SV_MUTABLE_RETURN)
2781 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2784 *lp = SvCUR(tmpstr);
2786 pv = sv_2pv_flags(tmpstr, lp, flags);
2799 const SV *const referent = (SV*)SvRV(sv);
2803 retval = buffer = savepvn("NULLREF", len);
2804 } else if (SvTYPE(referent) == SVt_REGEXP) {
2805 const REGEXP * const re = (REGEXP *)referent;
2810 /* If the regex is UTF-8 we want the containing scalar to
2811 have an UTF-8 flag too */
2817 if ((seen_evals = RX_SEEN_EVALS(re)))
2818 PL_reginterp_cnt += seen_evals;
2821 *lp = RX_WRAPLEN(re);
2823 return RX_WRAPPED(re);
2825 const char *const typestr = sv_reftype(referent, 0);
2826 const STRLEN typelen = strlen(typestr);
2827 UV addr = PTR2UV(referent);
2828 const char *stashname = NULL;
2829 STRLEN stashnamelen = 0; /* hush, gcc */
2830 const char *buffer_end;
2832 if (SvOBJECT(referent)) {
2833 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2836 stashname = HEK_KEY(name);
2837 stashnamelen = HEK_LEN(name);
2839 if (HEK_UTF8(name)) {
2845 stashname = "__ANON__";
2848 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2851 len = typelen + 3 /* (0x */
2852 + 2 * sizeof(UV) + 2 /* )\0 */;
2855 Newx(buffer, len, char);
2856 buffer_end = retval = buffer + len;
2858 /* Working backwards */
2862 *--retval = PL_hexdigit[addr & 15];
2863 } while (addr >>= 4);
2869 memcpy(retval, typestr, typelen);
2873 retval -= stashnamelen;
2874 memcpy(retval, stashname, stashnamelen);
2876 /* retval may not neccesarily have reached the start of the
2878 assert (retval >= buffer);
2880 len = buffer_end - retval - 1; /* -1 for that \0 */
2888 if (SvREADONLY(sv) && !SvOK(sv)) {
2891 if (flags & SV_UNDEF_RETURNS_NULL)
2893 if (ckWARN(WARN_UNINITIALIZED))
2898 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2899 /* I'm assuming that if both IV and NV are equally valid then
2900 converting the IV is going to be more efficient */
2901 const U32 isUIOK = SvIsUV(sv);
2902 char buf[TYPE_CHARS(UV)];
2906 if (SvTYPE(sv) < SVt_PVIV)
2907 sv_upgrade(sv, SVt_PVIV);
2908 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2910 /* inlined from sv_setpvn */
2911 s = SvGROW_mutable(sv, len + 1);
2912 Move(ptr, s, len, char);
2916 else if (SvNOKp(sv)) {
2917 const int olderrno = errno;
2918 if (SvTYPE(sv) < SVt_PVNV)
2919 sv_upgrade(sv, SVt_PVNV);
2920 /* The +20 is pure guesswork. Configure test needed. --jhi */
2921 s = SvGROW_mutable(sv, NV_DIG + 20);
2922 /* some Xenix systems wipe out errno here */
2924 if (SvNVX(sv) == 0.0)
2925 my_strlcpy(s, "0", SvLEN(sv));
2929 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2932 #ifdef FIXNEGATIVEZERO
2933 if (*s == '-' && s[1] == '0' && !s[2]) {
2945 if (isGV_with_GP(sv))
2946 return glob_2pv((GV *)sv, lp);
2950 if (flags & SV_UNDEF_RETURNS_NULL)
2952 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2954 if (SvTYPE(sv) < SVt_PV)
2955 /* Typically the caller expects that sv_any is not NULL now. */
2956 sv_upgrade(sv, SVt_PV);
2960 const STRLEN len = s - SvPVX_const(sv);
2966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2967 PTR2UV(sv),SvPVX_const(sv)));
2968 if (flags & SV_CONST_RETURN)
2969 return (char *)SvPVX_const(sv);
2970 if (flags & SV_MUTABLE_RETURN)
2971 return SvPVX_mutable(sv);
2976 =for apidoc sv_copypv
2978 Copies a stringified representation of the source SV into the
2979 destination SV. Automatically performs any necessary mg_get and
2980 coercion of numeric values into strings. Guaranteed to preserve
2981 UTF8 flag even from overloaded objects. Similar in nature to
2982 sv_2pv[_flags] but operates directly on an SV instead of just the
2983 string. Mostly uses sv_2pv_flags to do its work, except when that
2984 would lose the UTF-8'ness of the PV.
2990 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2993 const char * const s = SvPV_const(ssv,len);
2995 PERL_ARGS_ASSERT_SV_COPYPV;
2997 sv_setpvn(dsv,s,len);
3005 =for apidoc sv_2pvbyte
3007 Return a pointer to the byte-encoded representation of the SV, and set *lp
3008 to its length. May cause the SV to be downgraded from UTF-8 as a
3011 Usually accessed via the C<SvPVbyte> macro.
3017 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3019 PERL_ARGS_ASSERT_SV_2PVBYTE;
3021 sv_utf8_downgrade(sv,0);
3022 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3026 =for apidoc sv_2pvutf8
3028 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3029 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3031 Usually accessed via the C<SvPVutf8> macro.
3037 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3039 PERL_ARGS_ASSERT_SV_2PVUTF8;
3041 sv_utf8_upgrade(sv);
3042 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3047 =for apidoc sv_2bool
3049 This function is only called on magical items, and is only used by
3050 sv_true() or its macro equivalent.
3056 Perl_sv_2bool(pTHX_ register SV *const sv)
3060 PERL_ARGS_ASSERT_SV_2BOOL;
3068 SV * const tmpsv = AMG_CALLun(sv,bool_);
3069 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3070 return (bool)SvTRUE(tmpsv);
3072 return SvRV(sv) != 0;
3075 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3077 (*sv->sv_u.svu_pv > '0' ||
3078 Xpvtmp->xpv_cur > 1 ||
3079 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3086 return SvIVX(sv) != 0;
3089 return SvNVX(sv) != 0.0;
3091 if (isGV_with_GP(sv))
3101 =for apidoc sv_utf8_upgrade
3103 Converts the PV of an SV to its UTF-8-encoded form.
3104 Forces the SV to string form if it is not already.
3105 Always sets the SvUTF8 flag to avoid future validity checks even
3106 if all the bytes have hibit clear.
3108 This is not as a general purpose byte encoding to Unicode interface:
3109 use the Encode extension for that.
3111 =for apidoc sv_utf8_upgrade_flags
3113 Converts the PV of an SV to its UTF-8-encoded form.
3114 Forces the SV to string form if it is not already.
3115 Always sets the SvUTF8 flag to avoid future validity checks even
3116 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3117 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3118 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3120 This is not as a general purpose byte encoding to Unicode interface:
3121 use the Encode extension for that.
3127 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3131 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3133 if (sv == &PL_sv_undef)
3137 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3138 (void) sv_2pv_flags(sv,&len, flags);
3142 (void) SvPV_force(sv,len);
3151 sv_force_normal_flags(sv, 0);
3154 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3155 sv_recode_to_utf8(sv, PL_encoding);
3156 else { /* Assume Latin-1/EBCDIC */
3157 /* This function could be much more efficient if we
3158 * had a FLAG in SVs to signal if there are any hibit
3159 * chars in the PV. Given that there isn't such a flag
3160 * make the loop as fast as possible. */
3161 const U8 * const s = (U8 *) SvPVX_const(sv);
3162 const U8 * const e = (U8 *) SvEND(sv);
3167 /* Check for hi bit */
3168 if (!NATIVE_IS_INVARIANT(ch)) {
3169 STRLEN len = SvCUR(sv);
3170 /* *Currently* bytes_to_utf8() adds a '\0' after every string
3171 it converts. This isn't documented. It's not clear if it's
3172 a bad thing to be doing, and should be changed to do exactly
3173 what the documentation says. If so, this code will have to
3175 As is, we mustn't rely on our incoming SV being well formed
3176 and having a trailing '\0', as certain code in pp_formline
3177 can send us partially built SVs. */
3178 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3180 SvPV_free(sv); /* No longer using what was there before. */
3181 SvPV_set(sv, (char*)recoded);
3183 SvLEN_set(sv, len + 1); /* No longer know the real size. */
3187 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3194 =for apidoc sv_utf8_downgrade
3196 Attempts to convert the PV of an SV from characters to bytes.
3197 If the PV contains a character beyond byte, this conversion will fail;
3198 in this case, either returns false or, if C<fail_ok> is not
3201 This is not as a general purpose Unicode to byte encoding interface:
3202 use the Encode extension for that.
3208 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3212 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3214 if (SvPOKp(sv) && SvUTF8(sv)) {
3220 sv_force_normal_flags(sv, 0);
3222 s = (U8 *) SvPV(sv, len);
3223 if (!utf8_to_bytes(s, &len)) {
3228 Perl_croak(aTHX_ "Wide character in %s",
3231 Perl_croak(aTHX_ "Wide character");
3242 =for apidoc sv_utf8_encode
3244 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3245 flag off so that it looks like octets again.
3251 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3253 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3256 sv_force_normal_flags(sv, 0);
3258 if (SvREADONLY(sv)) {
3259 Perl_croak(aTHX_ PL_no_modify);
3261 (void) sv_utf8_upgrade(sv);
3266 =for apidoc sv_utf8_decode
3268 If the PV of the SV is an octet sequence in UTF-8
3269 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3270 so that it looks like a character. If the PV contains only single-byte
3271 characters, the C<SvUTF8> flag stays being off.
3272 Scans PV for validity and returns false if the PV is invalid UTF-8.
3278 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3280 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3286 /* The octets may have got themselves encoded - get them back as
3289 if (!sv_utf8_downgrade(sv, TRUE))
3292 /* it is actually just a matter of turning the utf8 flag on, but
3293 * we want to make sure everything inside is valid utf8 first.
3295 c = (const U8 *) SvPVX_const(sv);
3296 if (!is_utf8_string(c, SvCUR(sv)+1))
3298 e = (const U8 *) SvEND(sv);
3301 if (!UTF8_IS_INVARIANT(ch)) {
3311 =for apidoc sv_setsv
3313 Copies the contents of the source SV C<ssv> into the destination SV
3314 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3315 function if the source SV needs to be reused. Does not handle 'set' magic.
3316 Loosely speaking, it performs a copy-by-value, obliterating any previous
3317 content of the destination.
3319 You probably want to use one of the assortment of wrappers, such as
3320 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3321 C<SvSetMagicSV_nosteal>.
3323 =for apidoc sv_setsv_flags
3325 Copies the contents of the source SV C<ssv> into the destination SV
3326 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3327 function if the source SV needs to be reused. Does not handle 'set' magic.
3328 Loosely speaking, it performs a copy-by-value, obliterating any previous
3329 content of the destination.
3330 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3331 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3332 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3333 and C<sv_setsv_nomg> are implemented in terms of this function.
3335 You probably want to use one of the assortment of wrappers, such as
3336 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3337 C<SvSetMagicSV_nosteal>.
3339 This is the primary function for copying scalars, and most other
3340 copy-ish functions and macros use this underneath.
3346 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3348 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3350 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3352 if (dtype != SVt_PVGV) {
3353 const char * const name = GvNAME(sstr);
3354 const STRLEN len = GvNAMELEN(sstr);
3356 if (dtype >= SVt_PV) {
3362 SvUPGRADE(dstr, SVt_PVGV);
3363 (void)SvOK_off(dstr);
3364 /* FIXME - why are we doing this, then turning it off and on again
3366 isGV_with_GP_on(dstr);
3368 GvSTASH(dstr) = GvSTASH(sstr);
3370 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3371 gv_name_set((GV *)dstr, name, len, GV_ADD);
3372 SvFAKE_on(dstr); /* can coerce to non-glob */
3375 #ifdef GV_UNIQUE_CHECK
3376 if (GvUNIQUE((GV*)dstr)) {
3377 Perl_croak(aTHX_ PL_no_modify);
3381 if(GvGP((GV*)sstr)) {
3382 /* If source has method cache entry, clear it */
3384 SvREFCNT_dec(GvCV(sstr));
3388 /* If source has a real method, then a method is
3390 else if(GvCV((GV*)sstr)) {
3395 /* If dest already had a real method, that's a change as well */
3396 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3400 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3404 isGV_with_GP_off(dstr);
3405 (void)SvOK_off(dstr);
3406 isGV_with_GP_on(dstr);
3407 GvINTRO_off(dstr); /* one-shot flag */
3408 GvGP(dstr) = gp_ref(GvGP(sstr));
3409 if (SvTAINTED(sstr))
3411 if (GvIMPORTED(dstr) != GVf_IMPORTED
3412 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3414 GvIMPORTED_on(dstr);
3417 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3418 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3423 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3425 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3427 const int intro = GvINTRO(dstr);
3430 const U32 stype = SvTYPE(sref);
3432 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3434 #ifdef GV_UNIQUE_CHECK
3435 if (GvUNIQUE((GV*)dstr)) {
3436 Perl_croak(aTHX_ PL_no_modify);
3441 GvINTRO_off(dstr); /* one-shot flag */
3442 GvLINE(dstr) = CopLINE(PL_curcop);
3443 GvEGV(dstr) = (GV*)dstr;
3448 location = (SV **) &GvCV(dstr);
3449 import_flag = GVf_IMPORTED_CV;
3452 location = (SV **) &GvHV(dstr);
3453 import_flag = GVf_IMPORTED_HV;
3456 location = (SV **) &GvAV(dstr);
3457 import_flag = GVf_IMPORTED_AV;
3460 location = (SV **) &GvIOp(dstr);
3463 location = (SV **) &GvFORM(dstr);
3465 location = &GvSV(dstr);
3466 import_flag = GVf_IMPORTED_SV;
3469 if (stype == SVt_PVCV) {
3470 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3471 if (GvCVGEN(dstr)) {
3472 SvREFCNT_dec(GvCV(dstr));
3474 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3477 SAVEGENERICSV(*location);
3481 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3482 CV* const cv = (CV*)*location;
3484 if (!GvCVGEN((GV*)dstr) &&
3485 (CvROOT(cv) || CvXSUB(cv)))
3487 /* Redefining a sub - warning is mandatory if
3488 it was a const and its value changed. */
3489 if (CvCONST(cv) && CvCONST((CV*)sref)
3490 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3492 /* They are 2 constant subroutines generated from
3493 the same constant. This probably means that
3494 they are really the "same" proxy subroutine
3495 instantiated in 2 places. Most likely this is
3496 when a constant is exported twice. Don't warn.
3499 else if (ckWARN(WARN_REDEFINE)
3501 && (!CvCONST((CV*)sref)
3502 || sv_cmp(cv_const_sv(cv),
3503 cv_const_sv((CV*)sref))))) {
3504 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3507 ? "Constant subroutine %s::%s redefined"
3508 : "Subroutine %s::%s redefined"),
3509 HvNAME_get(GvSTASH((GV*)dstr)),
3510 GvENAME((GV*)dstr));
3514 cv_ckproto_len(cv, (GV*)dstr,
3515 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3516 SvPOK(sref) ? SvCUR(sref) : 0);
3518 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3519 GvASSUMECV_on(dstr);
3520 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3523 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3524 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3525 GvFLAGS(dstr) |= import_flag;
3530 if (SvTAINTED(sstr))
3536 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3539 register U32 sflags;
3541 register svtype stype;
3543 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3548 if (SvIS_FREED(dstr)) {
3549 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3550 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3552 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3554 sstr = &PL_sv_undef;
3555 if (SvIS_FREED(sstr)) {
3556 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3557 (void*)sstr, (void*)dstr);
3559 stype = SvTYPE(sstr);
3560 dtype = SvTYPE(dstr);
3562 (void)SvAMAGIC_off(dstr);
3565 /* need to nuke the magic */
3569 /* There's a lot of redundancy below but we're going for speed here */
3574 if (dtype != SVt_PVGV) {
3575 (void)SvOK_off(dstr);
3583 sv_upgrade(dstr, SVt_IV);
3587 sv_upgrade(dstr, SVt_PVIV);
3590 goto end_of_first_switch;
3592 (void)SvIOK_only(dstr);
3593 SvIV_set(dstr, SvIVX(sstr));
3596 /* SvTAINTED can only be true if the SV has taint magic, which in
3597 turn means that the SV type is PVMG (or greater). This is the
3598 case statement for SVt_IV, so this cannot be true (whatever gcov
3600 assert(!SvTAINTED(sstr));
3605 if (dtype < SVt_PV && dtype != SVt_IV)
3606 sv_upgrade(dstr, SVt_IV);
3614 sv_upgrade(dstr, SVt_NV);
3618 sv_upgrade(dstr, SVt_PVNV);
3621 goto end_of_first_switch;
3623 SvNV_set(dstr, SvNVX(sstr));
3624 (void)SvNOK_only(dstr);
3625 /* SvTAINTED can only be true if the SV has taint magic, which in
3626 turn means that the SV type is PVMG (or greater). This is the
3627 case statement for SVt_NV, so this cannot be true (whatever gcov
3629 assert(!SvTAINTED(sstr));
3635 #ifdef PERL_OLD_COPY_ON_WRITE
3636 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3637 if (dtype < SVt_PVIV)
3638 sv_upgrade(dstr, SVt_PVIV);
3646 sv_upgrade(dstr, SVt_PV);
3649 if (dtype < SVt_PVIV)
3650 sv_upgrade(dstr, SVt_PVIV);
3653 if (dtype < SVt_PVNV)
3654 sv_upgrade(dstr, SVt_PVNV);
3658 const char * const type = sv_reftype(sstr,0);
3660 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3662 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3666 /* case SVt_BIND: */
3669 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3670 glob_assign_glob(dstr, sstr, dtype);
3673 /* SvVALID means that this PVGV is playing at being an FBM. */
3677 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3679 if (SvTYPE(sstr) != stype) {
3680 stype = SvTYPE(sstr);
3681 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3682 glob_assign_glob(dstr, sstr, dtype);
3687 if (stype == SVt_PVLV)
3688 SvUPGRADE(dstr, SVt_PVNV);
3690 SvUPGRADE(dstr, (svtype)stype);
3692 end_of_first_switch:
3694 /* dstr may have been upgraded. */
3695 dtype = SvTYPE(dstr);
3696 sflags = SvFLAGS(sstr);
3698 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3699 /* Assigning to a subroutine sets the prototype. */
3702 const char *const ptr = SvPV_const(sstr, len);
3704 SvGROW(dstr, len + 1);
3705 Copy(ptr, SvPVX(dstr), len + 1, char);
3706 SvCUR_set(dstr, len);
3708 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3712 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3713 const char * const type = sv_reftype(dstr,0);
3715 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3717 Perl_croak(aTHX_ "Cannot copy to %s", type);
3718 } else if (sflags & SVf_ROK) {
3719 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3720 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3723 if (GvIMPORTED(dstr) != GVf_IMPORTED
3724 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3726 GvIMPORTED_on(dstr);
3731 if (isGV_with_GP(sstr)) {
3732 glob_assign_glob(dstr, sstr, dtype);
3737 if (dtype >= SVt_PV) {
3738 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3739 glob_assign_ref(dstr, sstr);
3742 if (SvPVX_const(dstr)) {
3748 (void)SvOK_off(dstr);
3749 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3750 SvFLAGS(dstr) |= sflags & SVf_ROK;
3751 assert(!(sflags & SVp_NOK));
3752 assert(!(sflags & SVp_IOK));
3753 assert(!(sflags & SVf_NOK));
3754 assert(!(sflags & SVf_IOK));
3756 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3757 if (!(sflags & SVf_OK)) {
3758 if (ckWARN(WARN_MISC))
3759 Perl_warner(aTHX_ packWARN(WARN_MISC),
3760 "Undefined value assigned to typeglob");
3763 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3764 if (dstr != (SV*)gv) {
3767 GvGP(dstr) = gp_ref(GvGP(gv));
3771 else if (sflags & SVp_POK) {
3775 * Check to see if we can just swipe the string. If so, it's a
3776 * possible small lose on short strings, but a big win on long ones.
3777 * It might even be a win on short strings if SvPVX_const(dstr)
3778 * has to be allocated and SvPVX_const(sstr) has to be freed.
3779 * Likewise if we can set up COW rather than doing an actual copy, we
3780 * drop to the else clause, as the swipe code and the COW setup code
3781 * have much in common.
3784 /* Whichever path we take through the next code, we want this true,
3785 and doing it now facilitates the COW check. */
3786 (void)SvPOK_only(dstr);
3789 /* If we're already COW then this clause is not true, and if COW
3790 is allowed then we drop down to the else and make dest COW
3791 with us. If caller hasn't said that we're allowed to COW
3792 shared hash keys then we don't do the COW setup, even if the
3793 source scalar is a shared hash key scalar. */
3794 (((flags & SV_COW_SHARED_HASH_KEYS)
3795 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3796 : 1 /* If making a COW copy is forbidden then the behaviour we
3797 desire is as if the source SV isn't actually already
3798 COW, even if it is. So we act as if the source flags
3799 are not COW, rather than actually testing them. */
3801 #ifndef PERL_OLD_COPY_ON_WRITE
3802 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3803 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3804 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3805 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3806 but in turn, it's somewhat dead code, never expected to go
3807 live, but more kept as a placeholder on how to do it better
3808 in a newer implementation. */
3809 /* If we are COW and dstr is a suitable target then we drop down
3810 into the else and make dest a COW of us. */
3811 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3816 (sflags & SVs_TEMP) && /* slated for free anyway? */
3817 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3818 (!(flags & SV_NOSTEAL)) &&
3819 /* and we're allowed to steal temps */
3820 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3821 SvLEN(sstr) && /* and really is a string */
3822 /* and won't be needed again, potentially */
3823 !(PL_op && PL_op->op_type == OP_AASSIGN))
3824 #ifdef PERL_OLD_COPY_ON_WRITE
3825 && ((flags & SV_COW_SHARED_HASH_KEYS)
3826 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3827 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3828 && SvTYPE(sstr) >= SVt_PVIV))
3832 /* Failed the swipe test, and it's not a shared hash key either.
3833 Have to copy the string. */
3834 STRLEN len = SvCUR(sstr);
3835 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3836 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3837 SvCUR_set(dstr, len);
3838 *SvEND(dstr) = '\0';
3840 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3842 /* Either it's a shared hash key, or it's suitable for
3843 copy-on-write or we can swipe the string. */
3845 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3849 #ifdef PERL_OLD_COPY_ON_WRITE
3851 /* I believe I should acquire a global SV mutex if
3852 it's a COW sv (not a shared hash key) to stop
3853 it going un copy-on-write.
3854 If the source SV has gone un copy on write between up there
3855 and down here, then (assert() that) it is of the correct
3856 form to make it copy on write again */
3857 if ((sflags & (SVf_FAKE | SVf_READONLY))
3858 != (SVf_FAKE | SVf_READONLY)) {
3859 SvREADONLY_on(sstr);
3861 /* Make the source SV into a loop of 1.
3862 (about to become 2) */
3863 SV_COW_NEXT_SV_SET(sstr, sstr);
3867 /* Initial code is common. */
3868 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3873 /* making another shared SV. */
3874 STRLEN cur = SvCUR(sstr);
3875 STRLEN len = SvLEN(sstr);
3876 #ifdef PERL_OLD_COPY_ON_WRITE
3878 assert (SvTYPE(dstr) >= SVt_PVIV);
3879 /* SvIsCOW_normal */
3880 /* splice us in between source and next-after-source. */
3881 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3882 SV_COW_NEXT_SV_SET(sstr, dstr);
3883 SvPV_set(dstr, SvPVX_mutable(sstr));
3887 /* SvIsCOW_shared_hash */
3888 DEBUG_C(PerlIO_printf(Perl_debug_log,
3889 "Copy on write: Sharing hash\n"));
3891 assert (SvTYPE(dstr) >= SVt_PV);
3893 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3895 SvLEN_set(dstr, len);
3896 SvCUR_set(dstr, cur);
3897 SvREADONLY_on(dstr);
3899 /* Relesase a global SV mutex. */
3902 { /* Passes the swipe test. */
3903 SvPV_set(dstr, SvPVX_mutable(sstr));
3904 SvLEN_set(dstr, SvLEN(sstr));
3905 SvCUR_set(dstr, SvCUR(sstr));
3908 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3909 SvPV_set(sstr, NULL);
3915 if (sflags & SVp_NOK) {
3916 SvNV_set(dstr, SvNVX(sstr));
3918 if (sflags & SVp_IOK) {
3919 SvIV_set(dstr, SvIVX(sstr));
3920 /* Must do this otherwise some other overloaded use of 0x80000000
3921 gets confused. I guess SVpbm_VALID */
3922 if (sflags & SVf_IVisUV)
3925 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3927 const MAGIC * const smg = SvVSTRING_mg(sstr);
3929 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3930 smg->mg_ptr, smg->mg_len);
3931 SvRMAGICAL_on(dstr);
3935 else if (sflags & (SVp_IOK|SVp_NOK)) {
3936 (void)SvOK_off(dstr);
3937 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3938 if (sflags & SVp_IOK) {
3939 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3940 SvIV_set(dstr, SvIVX(sstr));
3942 if (sflags & SVp_NOK) {
3943 SvNV_set(dstr, SvNVX(sstr));
3947 if (isGV_with_GP(sstr)) {
3948 /* This stringification rule for globs is spread in 3 places.
3949 This feels bad. FIXME. */
3950 const U32 wasfake = sflags & SVf_FAKE;
3952 /* FAKE globs can get coerced, so need to turn this off
3953 temporarily if it is on. */
3955 gv_efullname3(dstr, (GV *)sstr, "*");
3956 SvFLAGS(sstr) |= wasfake;
3959 (void)SvOK_off(dstr);
3961 if (SvTAINTED(sstr))
3966 =for apidoc sv_setsv_mg
3968 Like C<sv_setsv>, but also handles 'set' magic.
3974 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3976 PERL_ARGS_ASSERT_SV_SETSV_MG;
3978 sv_setsv(dstr,sstr);
3982 #ifdef PERL_OLD_COPY_ON_WRITE
3984 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3986 STRLEN cur = SvCUR(sstr);
3987 STRLEN len = SvLEN(sstr);
3988 register char *new_pv;
3990 PERL_ARGS_ASSERT_SV_SETSV_COW;
3993 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3994 (void*)sstr, (void*)dstr);
4001 if (SvTHINKFIRST(dstr))
4002 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4003 else if (SvPVX_const(dstr))
4004 Safefree(SvPVX_const(dstr));
4008 SvUPGRADE(dstr, SVt_PVIV);
4010 assert (SvPOK(sstr));
4011 assert (SvPOKp(sstr));
4012 assert (!SvIOK(sstr));
4013 assert (!SvIOKp(sstr));
4014 assert (!SvNOK(sstr));
4015 assert (!SvNOKp(sstr));
4017 if (SvIsCOW(sstr)) {
4019 if (SvLEN(sstr) == 0) {
4020 /* source is a COW shared hash key. */
4021 DEBUG_C(PerlIO_printf(Perl_debug_log,
4022 "Fast copy on write: Sharing hash\n"));
4023 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4026 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4028 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4029 SvUPGRADE(sstr, SVt_PVIV);
4030 SvREADONLY_on(sstr);
4032 DEBUG_C(PerlIO_printf(Perl_debug_log,
4033 "Fast copy on write: Converting sstr to COW\n"));
4034 SV_COW_NEXT_SV_SET(dstr, sstr);
4036 SV_COW_NEXT_SV_SET(sstr, dstr);
4037 new_pv = SvPVX_mutable(sstr);
4040 SvPV_set(dstr, new_pv);
4041 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4044 SvLEN_set(dstr, len);
4045 SvCUR_set(dstr, cur);
4054 =for apidoc sv_setpvn
4056 Copies a string into an SV. The C<len> parameter indicates the number of
4057 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4058 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4064 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4067 register char *dptr;
4069 PERL_ARGS_ASSERT_SV_SETPVN;
4071 SV_CHECK_THINKFIRST_COW_DROP(sv);
4077 /* len is STRLEN which is unsigned, need to copy to signed */
4080 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4082 SvUPGRADE(sv, SVt_PV);
4084 dptr = SvGROW(sv, len + 1);
4085 Move(ptr,dptr,len,char);
4088 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4093 =for apidoc sv_setpvn_mg
4095 Like C<sv_setpvn>, but also handles 'set' magic.
4101 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4103 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4105 sv_setpvn(sv,ptr,len);
4110 =for apidoc sv_setpv
4112 Copies a string into an SV. The string must be null-terminated. Does not
4113 handle 'set' magic. See C<sv_setpv_mg>.
4119 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4122 register STRLEN len;
4124 PERL_ARGS_ASSERT_SV_SETPV;
4126 SV_CHECK_THINKFIRST_COW_DROP(sv);
4132 SvUPGRADE(sv, SVt_PV);
4134 SvGROW(sv, len + 1);
4135 Move(ptr,SvPVX(sv),len+1,char);
4137 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4142 =for apidoc sv_setpv_mg
4144 Like C<sv_setpv>, but also handles 'set' magic.
4150 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4152 PERL_ARGS_ASSERT_SV_SETPV_MG;
4159 =for apidoc sv_usepvn_flags
4161 Tells an SV to use C<ptr> to find its string value. Normally the
4162 string is stored inside the SV but sv_usepvn allows the SV to use an
4163 outside string. The C<ptr> should point to memory that was allocated
4164 by C<malloc>. The string length, C<len>, must be supplied. By default
4165 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4166 so that pointer should not be freed or used by the programmer after
4167 giving it to sv_usepvn, and neither should any pointers from "behind"
4168 that pointer (e.g. ptr + 1) be used.
4170 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4171 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4172 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4173 C<len>, and already meets the requirements for storing in C<SvPVX>)
4179 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4184 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4186 SV_CHECK_THINKFIRST_COW_DROP(sv);
4187 SvUPGRADE(sv, SVt_PV);
4190 if (flags & SV_SMAGIC)
4194 if (SvPVX_const(sv))
4198 if (flags & SV_HAS_TRAILING_NUL)
4199 assert(ptr[len] == '\0');
4202 allocate = (flags & SV_HAS_TRAILING_NUL)
4204 #ifdef Perl_safesysmalloc_size
4207 PERL_STRLEN_ROUNDUP(len + 1);
4209 if (flags & SV_HAS_TRAILING_NUL) {
4210 /* It's long enough - do nothing.
4211 Specfically Perl_newCONSTSUB is relying on this. */
4214 /* Force a move to shake out bugs in callers. */
4215 char *new_ptr = (char*)safemalloc(allocate);
4216 Copy(ptr, new_ptr, len, char);
4217 PoisonFree(ptr,len,char);
4221 ptr = (char*) saferealloc (ptr, allocate);
4224 #ifdef Perl_safesysmalloc_size
4225 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4227 SvLEN_set(sv, allocate);
4231 if (!(flags & SV_HAS_TRAILING_NUL)) {
4234 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4236 if (flags & SV_SMAGIC)
4240 #ifdef PERL_OLD_COPY_ON_WRITE
4241 /* Need to do this *after* making the SV normal, as we need the buffer
4242 pointer to remain valid until after we've copied it. If we let go too early,
4243 another thread could invalidate it by unsharing last of the same hash key
4244 (which it can do by means other than releasing copy-on-write Svs)
4245 or by changing the other copy-on-write SVs in the loop. */
4247 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4249 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4251 { /* this SV was SvIsCOW_normal(sv) */
4252 /* we need to find the SV pointing to us. */
4253 SV *current = SV_COW_NEXT_SV(after);
4255 if (current == sv) {
4256 /* The SV we point to points back to us (there were only two of us
4258 Hence other SV is no longer copy on write either. */
4260 SvREADONLY_off(after);
4262 /* We need to follow the pointers around the loop. */
4264 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4267 /* don't loop forever if the structure is bust, and we have
4268 a pointer into a closed loop. */
4269 assert (current != after);
4270 assert (SvPVX_const(current) == pvx);
4272 /* Make the SV before us point to the SV after us. */
4273 SV_COW_NEXT_SV_SET(current, after);
4279 =for apidoc sv_force_normal_flags
4281 Undo various types of fakery on an SV: if the PV is a shared string, make
4282 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4283 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4284 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4285 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4286 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4287 set to some other value.) In addition, the C<flags> parameter gets passed to
4288 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4289 with flags set to 0.
4295 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4299 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4301 #ifdef PERL_OLD_COPY_ON_WRITE
4302 if (SvREADONLY(sv)) {
4303 /* At this point I believe I should acquire a global SV mutex. */
4305 const char * const pvx = SvPVX_const(sv);
4306 const STRLEN len = SvLEN(sv);
4307 const STRLEN cur = SvCUR(sv);
4308 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4309 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4310 we'll fail an assertion. */
4311 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4314 PerlIO_printf(Perl_debug_log,
4315 "Copy on write: Force normal %ld\n",
4321 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4324 if (flags & SV_COW_DROP_PV) {
4325 /* OK, so we don't need to copy our buffer. */
4328 SvGROW(sv, cur + 1);
4329 Move(pvx,SvPVX(sv),cur,char);
4334 sv_release_COW(sv, pvx, next);
4336 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4342 else if (IN_PERL_RUNTIME)
4343 Perl_croak(aTHX_ PL_no_modify);
4344 /* At this point I believe that I can drop the global SV mutex. */
4347 if (SvREADONLY(sv)) {
4349 const char * const pvx = SvPVX_const(sv);
4350 const STRLEN len = SvCUR(sv);
4355 SvGROW(sv, len + 1);
4356 Move(pvx,SvPVX(sv),len,char);
4358 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4360 else if (IN_PERL_RUNTIME)
4361 Perl_croak(aTHX_ PL_no_modify);
4365 sv_unref_flags(sv, flags);
4366 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4373 Efficient removal of characters from the beginning of the string buffer.
4374 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4375 the string buffer. The C<ptr> becomes the first character of the adjusted
4376 string. Uses the "OOK hack".
4377 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4378 refer to the same chunk of data.
4384 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4390 const U8 *real_start;
4394 PERL_ARGS_ASSERT_SV_CHOP;
4396 if (!ptr || !SvPOKp(sv))
4398 delta = ptr - SvPVX_const(sv);
4400 /* Nothing to do. */
4403 /* SvPVX(sv) may move in SV_CHECK_THINKFIRST(sv), but after this line,
4404 nothing uses the value of ptr any more. */
4405 max_delta = SvLEN(sv) ? SvLEN(sv) : SvCUR(sv);
4406 if (ptr <= SvPVX_const(sv))
4407 Perl_croak(aTHX_ "panic: sv_chop ptr=%p, start=%p, end=%p",
4408 ptr, SvPVX_const(sv), SvPVX_const(sv) + max_delta);
4409 SV_CHECK_THINKFIRST(sv);
4410 if (delta > max_delta)
4411 Perl_croak(aTHX_ "panic: sv_chop ptr=%p (was %p), start=%p, end=%p",
4412 SvPVX_const(sv) + delta, ptr, SvPVX_const(sv),
4413 SvPVX_const(sv) + max_delta);
4416 if (!SvLEN(sv)) { /* make copy of shared string */
4417 const char *pvx = SvPVX_const(sv);
4418 const STRLEN len = SvCUR(sv);
4419 SvGROW(sv, len + 1);
4420 Move(pvx,SvPVX(sv),len,char);
4423 SvFLAGS(sv) |= SVf_OOK;
4426 SvOOK_offset(sv, old_delta);
4428 SvLEN_set(sv, SvLEN(sv) - delta);
4429 SvCUR_set(sv, SvCUR(sv) - delta);
4430 SvPV_set(sv, SvPVX(sv) + delta);
4432 p = (U8 *)SvPVX_const(sv);
4437 real_start = p - delta;
4441 if (delta < 0x100) {
4445 p -= sizeof(STRLEN);
4446 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4450 /* Fill the preceding buffer with sentinals to verify that no-one is
4452 while (p > real_start) {
4460 =for apidoc sv_catpvn
4462 Concatenates the string onto the end of the string which is in the SV. The
4463 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4464 status set, then the bytes appended should be valid UTF-8.
4465 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4467 =for apidoc sv_catpvn_flags
4469 Concatenates the string onto the end of the string which is in the SV. The
4470 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4471 status set, then the bytes appended should be valid UTF-8.
4472 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4473 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4474 in terms of this function.
4480 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4484 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4486 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4488 SvGROW(dsv, dlen + slen + 1);
4490 sstr = SvPVX_const(dsv);
4491 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4492 SvCUR_set(dsv, SvCUR(dsv) + slen);
4494 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4496 if (flags & SV_SMAGIC)
4501 =for apidoc sv_catsv
4503 Concatenates the string from SV C<ssv> onto the end of the string in
4504 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4505 not 'set' magic. See C<sv_catsv_mg>.
4507 =for apidoc sv_catsv_flags
4509 Concatenates the string from SV C<ssv> onto the end of the string in
4510 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4511 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4512 and C<sv_catsv_nomg> are implemented in terms of this function.
4517 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4521 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4525 const char *spv = SvPV_const(ssv, slen);
4527 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4528 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4529 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4530 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4531 dsv->sv_flags doesn't have that bit set.
4532 Andy Dougherty 12 Oct 2001
4534 const I32 sutf8 = DO_UTF8(ssv);
4537 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4539 dutf8 = DO_UTF8(dsv);
4541 if (dutf8 != sutf8) {
4543 /* Not modifying source SV, so taking a temporary copy. */
4544 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4546 sv_utf8_upgrade(csv);
4547 spv = SvPV_const(csv, slen);
4550 sv_utf8_upgrade_nomg(dsv);
4552 sv_catpvn_nomg(dsv, spv, slen);
4555 if (flags & SV_SMAGIC)
4560 =for apidoc sv_catpv
4562 Concatenates the string onto the end of the string which is in the SV.
4563 If the SV has the UTF-8 status set, then the bytes appended should be
4564 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4569 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4572 register STRLEN len;
4576 PERL_ARGS_ASSERT_SV_CATPV;
4580 junk = SvPV_force(sv, tlen);
4582 SvGROW(sv, tlen + len + 1);
4584 ptr = SvPVX_const(sv);
4585 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4586 SvCUR_set(sv, SvCUR(sv) + len);
4587 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4592 =for apidoc sv_catpv_mg
4594 Like C<sv_catpv>, but also handles 'set' magic.
4600 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4602 PERL_ARGS_ASSERT_SV_CATPV_MG;
4611 Creates a new SV. A non-zero C<len> parameter indicates the number of
4612 bytes of preallocated string space the SV should have. An extra byte for a
4613 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4614 space is allocated.) The reference count for the new SV is set to 1.
4616 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4617 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4618 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4619 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4620 modules supporting older perls.
4626 Perl_newSV(pTHX_ const STRLEN len)
4633 sv_upgrade(sv, SVt_PV);
4634 SvGROW(sv, len + 1);
4639 =for apidoc sv_magicext
4641 Adds magic to an SV, upgrading it if necessary. Applies the
4642 supplied vtable and returns a pointer to the magic added.
4644 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4645 In particular, you can add magic to SvREADONLY SVs, and add more than
4646 one instance of the same 'how'.
4648 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4649 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4650 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4651 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4653 (This is now used as a subroutine by C<sv_magic>.)
4658 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4659 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4664 PERL_ARGS_ASSERT_SV_MAGICEXT;
4666 SvUPGRADE(sv, SVt_PVMG);
4667 Newxz(mg, 1, MAGIC);
4668 mg->mg_moremagic = SvMAGIC(sv);
4669 SvMAGIC_set(sv, mg);
4671 /* Sometimes a magic contains a reference loop, where the sv and
4672 object refer to each other. To prevent a reference loop that
4673 would prevent such objects being freed, we look for such loops
4674 and if we find one we avoid incrementing the object refcount.
4676 Note we cannot do this to avoid self-tie loops as intervening RV must
4677 have its REFCNT incremented to keep it in existence.
4680 if (!obj || obj == sv ||
4681 how == PERL_MAGIC_arylen ||
4682 how == PERL_MAGIC_symtab ||
4683 (SvTYPE(obj) == SVt_PVGV &&
4684 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4685 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4686 GvFORM(obj) == (CV*)sv)))
4691 mg->mg_obj = SvREFCNT_inc_simple(obj);
4692 mg->mg_flags |= MGf_REFCOUNTED;
4695 /* Normal self-ties simply pass a null object, and instead of
4696 using mg_obj directly, use the SvTIED_obj macro to produce a
4697 new RV as needed. For glob "self-ties", we are tieing the PVIO
4698 with an RV obj pointing to the glob containing the PVIO. In
4699 this case, to avoid a reference loop, we need to weaken the
4703 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4704 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4710 mg->mg_len = namlen;
4713 mg->mg_ptr = savepvn(name, namlen);
4714 else if (namlen == HEf_SVKEY)
4715 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4717 mg->mg_ptr = (char *) name;
4719 mg->mg_virtual = (MGVTBL *) vtable;
4723 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4728 =for apidoc sv_magic
4730 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4731 then adds a new magic item of type C<how> to the head of the magic list.
4733 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4734 handling of the C<name> and C<namlen> arguments.
4736 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4737 to add more than one instance of the same 'how'.
4743 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4744 const char *const name, const I32 namlen)
4747 const MGVTBL *vtable;
4750 PERL_ARGS_ASSERT_SV_MAGIC;
4752 #ifdef PERL_OLD_COPY_ON_WRITE
4754 sv_force_normal_flags(sv, 0);
4756 if (SvREADONLY(sv)) {
4758 /* its okay to attach magic to shared strings; the subsequent
4759 * upgrade to PVMG will unshare the string */
4760 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4763 && how != PERL_MAGIC_regex_global
4764 && how != PERL_MAGIC_bm
4765 && how != PERL_MAGIC_fm
4766 && how != PERL_MAGIC_sv
4767 && how != PERL_MAGIC_backref
4770 Perl_croak(aTHX_ PL_no_modify);
4773 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4774 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4775 /* sv_magic() refuses to add a magic of the same 'how' as an
4778 if (how == PERL_MAGIC_taint) {
4780 /* Any scalar which already had taint magic on which someone
4781 (erroneously?) did SvIOK_on() or similar will now be
4782 incorrectly sporting public "OK" flags. */
4783 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4791 vtable = &PL_vtbl_sv;
4793 case PERL_MAGIC_overload:
4794 vtable = &PL_vtbl_amagic;
4796 case PERL_MAGIC_overload_elem:
4797 vtable = &PL_vtbl_amagicelem;
4799 case PERL_MAGIC_overload_table:
4800 vtable = &PL_vtbl_ovrld;
4803 vtable = &PL_vtbl_bm;
4805 case PERL_MAGIC_regdata:
4806 vtable = &PL_vtbl_regdata;
4808 case PERL_MAGIC_regdatum:
4809 vtable = &PL_vtbl_regdatum;
4811 case PERL_MAGIC_env:
4812 vtable = &PL_vtbl_env;
4815 vtable = &PL_vtbl_fm;
4817 case PERL_MAGIC_envelem:
4818 vtable = &PL_vtbl_envelem;
4820 case PERL_MAGIC_regex_global:
4821 vtable = &PL_vtbl_mglob;
4823 case PERL_MAGIC_isa:
4824 vtable = &PL_vtbl_isa;
4826 case PERL_MAGIC_isaelem:
4827 vtable = &PL_vtbl_isaelem;
4829 case PERL_MAGIC_nkeys:
4830 vtable = &PL_vtbl_nkeys;
4832 case PERL_MAGIC_dbfile:
4835 case PERL_MAGIC_dbline:
4836 vtable = &PL_vtbl_dbline;
4838 #ifdef USE_LOCALE_COLLATE
4839 case PERL_MAGIC_collxfrm:
4840 vtable = &PL_vtbl_collxfrm;
4842 #endif /* USE_LOCALE_COLLATE */
4843 case PERL_MAGIC_tied:
4844 vtable = &PL_vtbl_pack;
4846 case PERL_MAGIC_tiedelem:
4847 case PERL_MAGIC_tiedscalar:
4848 vtable = &PL_vtbl_packelem;
4851 vtable = &PL_vtbl_regexp;
4853 case PERL_MAGIC_hints:
4854 /* As this vtable is all NULL, we can reuse it. */
4855 case PERL_MAGIC_sig:
4856 vtable = &PL_vtbl_sig;
4858 case PERL_MAGIC_sigelem:
4859 vtable = &PL_vtbl_sigelem;
4861 case PERL_MAGIC_taint:
4862 vtable = &PL_vtbl_taint;
4864 case PERL_MAGIC_uvar:
4865 vtable = &PL_vtbl_uvar;
4867 case PERL_MAGIC_vec:
4868 vtable = &PL_vtbl_vec;
4870 case PERL_MAGIC_arylen_p:
4871 case PERL_MAGIC_rhash:
4872 case PERL_MAGIC_symtab:
4873 case PERL_MAGIC_vstring:
4876 case PERL_MAGIC_utf8:
4877 vtable = &PL_vtbl_utf8;
4879 case PERL_MAGIC_substr:
4880 vtable = &PL_vtbl_substr;
4882 case PERL_MAGIC_defelem:
4883 vtable = &PL_vtbl_defelem;
4885 case PERL_MAGIC_arylen:
4886 vtable = &PL_vtbl_arylen;
4888 case PERL_MAGIC_pos:
4889 vtable = &PL_vtbl_pos;
4891 case PERL_MAGIC_backref:
4892 vtable = &PL_vtbl_backref;
4894 case PERL_MAGIC_hintselem:
4895 vtable = &PL_vtbl_hintselem;
4897 case PERL_MAGIC_ext:
4898 /* Reserved for use by extensions not perl internals. */
4899 /* Useful for attaching extension internal data to perl vars. */
4900 /* Note that multiple extensions may clash if magical scalars */
4901 /* etc holding private data from one are passed to another. */
4905 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4908 /* Rest of work is done else where */
4909 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4912 case PERL_MAGIC_taint:
4915 case PERL_MAGIC_ext:
4916 case PERL_MAGIC_dbfile:
4923 =for apidoc sv_unmagic
4925 Removes all magic of type C<type> from an SV.
4931 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4936 PERL_ARGS_ASSERT_SV_UNMAGIC;
4938 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4940 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4941 for (mg = *mgp; mg; mg = *mgp) {
4942 if (mg->mg_type == type) {
4943 const MGVTBL* const vtbl = mg->mg_virtual;
4944 *mgp = mg->mg_moremagic;
4945 if (vtbl && vtbl->svt_free)
4946 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4947 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4949 Safefree(mg->mg_ptr);
4950 else if (mg->mg_len == HEf_SVKEY)
4951 SvREFCNT_dec((SV*)mg->mg_ptr);
4952 else if (mg->mg_type == PERL_MAGIC_utf8)
4953 Safefree(mg->mg_ptr);
4955 if (mg->mg_flags & MGf_REFCOUNTED)
4956 SvREFCNT_dec(mg->mg_obj);
4960 mgp = &mg->mg_moremagic;
4964 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4965 SvMAGIC_set(sv, NULL);
4972 =for apidoc sv_rvweaken
4974 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4975 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4976 push a back-reference to this RV onto the array of backreferences
4977 associated with that magic. If the RV is magical, set magic will be
4978 called after the RV is cleared.
4984 Perl_sv_rvweaken(pTHX_ SV *const sv)
4988 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4990 if (!SvOK(sv)) /* let undefs pass */
4993 Perl_croak(aTHX_ "Can't weaken a nonreference");
4994 else if (SvWEAKREF(sv)) {
4995 if (ckWARN(WARN_MISC))
4996 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5000 Perl_sv_add_backref(aTHX_ tsv, sv);
5006 /* Give tsv backref magic if it hasn't already got it, then push a
5007 * back-reference to sv onto the array associated with the backref magic.
5011 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
5016 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5018 if (SvTYPE(tsv) == SVt_PVHV) {
5019 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5023 /* There is no AV in the offical place - try a fixup. */
5024 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5027 /* Aha. They've got it stowed in magic. Bring it back. */
5028 av = (AV*)mg->mg_obj;
5029 /* Stop mg_free decreasing the refernce count. */
5031 /* Stop mg_free even calling the destructor, given that
5032 there's no AV to free up. */
5034 sv_unmagic(tsv, PERL_MAGIC_backref);
5038 SvREFCNT_inc_simple_void(av);
5043 const MAGIC *const mg
5044 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5046 av = (AV*)mg->mg_obj;
5050 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5051 /* av now has a refcnt of 2, which avoids it getting freed
5052 * before us during global cleanup. The extra ref is removed
5053 * by magic_killbackrefs() when tsv is being freed */
5056 if (AvFILLp(av) >= AvMAX(av)) {
5057 av_extend(av, AvFILLp(av)+1);
5059 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5062 /* delete a back-reference to ourselves from the backref magic associated
5063 * with the SV we point to.
5067 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5074 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5076 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5077 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5078 /* We mustn't attempt to "fix up" the hash here by moving the
5079 backreference array back to the hv_aux structure, as that is stored
5080 in the main HvARRAY(), and hfreentries assumes that no-one
5081 reallocates HvARRAY() while it is running. */
5084 const MAGIC *const mg
5085 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5087 av = (AV *)mg->mg_obj;
5090 if (PL_in_clean_all)
5092 Perl_croak(aTHX_ "panic: del_backref");
5099 /* We shouldn't be in here more than once, but for paranoia reasons lets
5101 for (i = AvFILLp(av); i >= 0; i--) {
5103 const SSize_t fill = AvFILLp(av);
5105 /* We weren't the last entry.
5106 An unordered list has this property that you can take the
5107 last element off the end to fill the hole, and it's still
5108 an unordered list :-)
5113 AvFILLp(av) = fill - 1;
5119 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5121 SV **svp = AvARRAY(av);
5123 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5124 PERL_UNUSED_ARG(sv);
5126 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5127 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5128 if (svp && !SvIS_FREED(av)) {
5129 SV *const *const last = svp + AvFILLp(av);
5131 while (svp <= last) {
5133 SV *const referrer = *svp;
5134 if (SvWEAKREF(referrer)) {
5135 /* XXX Should we check that it hasn't changed? */
5136 SvRV_set(referrer, 0);
5138 SvWEAKREF_off(referrer);
5139 SvSETMAGIC(referrer);
5140 } else if (SvTYPE(referrer) == SVt_PVGV ||
5141 SvTYPE(referrer) == SVt_PVLV) {
5142 /* You lookin' at me? */
5143 assert(GvSTASH(referrer));
5144 assert(GvSTASH(referrer) == (HV*)sv);
5145 GvSTASH(referrer) = 0;
5148 "panic: magic_killbackrefs (flags=%"UVxf")",
5149 (UV)SvFLAGS(referrer));
5157 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5162 =for apidoc sv_insert
5164 Inserts a string at the specified offset/length within the SV. Similar to
5165 the Perl substr() function. Handles get magic.
5167 =for apidoc sv_insert_flags
5169 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5175 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5180 register char *midend;
5181 register char *bigend;
5185 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5188 Perl_croak(aTHX_ "Can't modify non-existent substring");
5189 SvPV_force_flags(bigstr, curlen, flags);
5190 (void)SvPOK_only_UTF8(bigstr);
5191 if (offset + len > curlen) {
5192 SvGROW(bigstr, offset+len+1);
5193 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5194 SvCUR_set(bigstr, offset+len);
5198 i = littlelen - len;
5199 if (i > 0) { /* string might grow */
5200 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5201 mid = big + offset + len;
5202 midend = bigend = big + SvCUR(bigstr);
5205 while (midend > mid) /* shove everything down */
5206 *--bigend = *--midend;
5207 Move(little,big+offset,littlelen,char);
5208 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5213 Move(little,SvPVX(bigstr)+offset,len,char);
5218 big = SvPVX(bigstr);
5221 bigend = big + SvCUR(bigstr);
5223 if (midend > bigend)
5224 Perl_croak(aTHX_ "panic: sv_insert");
5226 if (mid - big > bigend - midend) { /* faster to shorten from end */
5228 Move(little, mid, littlelen,char);
5231 i = bigend - midend;
5233 Move(midend, mid, i,char);
5237 SvCUR_set(bigstr, mid - big);
5239 else if ((i = mid - big)) { /* faster from front */
5240 midend -= littlelen;
5242 Move(big, midend - i, i, char);
5243 sv_chop(bigstr,midend-i);
5245 Move(little, mid, littlelen,char);
5247 else if (littlelen) {
5248 midend -= littlelen;
5249 sv_chop(bigstr,midend);
5250 Move(little,midend,littlelen,char);
5253 sv_chop(bigstr,midend);
5259 =for apidoc sv_replace
5261 Make the first argument a copy of the second, then delete the original.
5262 The target SV physically takes over ownership of the body of the source SV
5263 and inherits its flags; however, the target keeps any magic it owns,
5264 and any magic in the source is discarded.
5265 Note that this is a rather specialist SV copying operation; most of the
5266 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5272 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5275 const U32 refcnt = SvREFCNT(sv);
5277 PERL_ARGS_ASSERT_SV_REPLACE;
5279 SV_CHECK_THINKFIRST_COW_DROP(sv);
5280 if (SvREFCNT(nsv) != 1) {
5281 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5282 UVuf " != 1)", (UV) SvREFCNT(nsv));
5284 if (SvMAGICAL(sv)) {
5288 sv_upgrade(nsv, SVt_PVMG);
5289 SvMAGIC_set(nsv, SvMAGIC(sv));
5290 SvFLAGS(nsv) |= SvMAGICAL(sv);
5292 SvMAGIC_set(sv, NULL);
5296 assert(!SvREFCNT(sv));
5297 #ifdef DEBUG_LEAKING_SCALARS
5298 sv->sv_flags = nsv->sv_flags;
5299 sv->sv_any = nsv->sv_any;
5300 sv->sv_refcnt = nsv->sv_refcnt;
5301 sv->sv_u = nsv->sv_u;
5303 StructCopy(nsv,sv,SV);
5305 if(SvTYPE(sv) == SVt_IV) {
5307 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5311 #ifdef PERL_OLD_COPY_ON_WRITE
5312 if (SvIsCOW_normal(nsv)) {
5313 /* We need to follow the pointers around the loop to make the
5314 previous SV point to sv, rather than nsv. */
5317 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5320 assert(SvPVX_const(current) == SvPVX_const(nsv));
5322 /* Make the SV before us point to the SV after us. */
5324 PerlIO_printf(Perl_debug_log, "previous is\n");
5326 PerlIO_printf(Perl_debug_log,
5327 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5328 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5330 SV_COW_NEXT_SV_SET(current, sv);
5333 SvREFCNT(sv) = refcnt;
5334 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5340 =for apidoc sv_clear
5342 Clear an SV: call any destructors, free up any memory used by the body,
5343 and free the body itself. The SV's head is I<not> freed, although
5344 its type is set to all 1's so that it won't inadvertently be assumed
5345 to be live during global destruction etc.
5346 This function should only be called when REFCNT is zero. Most of the time
5347 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5354 Perl_sv_clear(pTHX_ register SV *const sv)
5357 const U32 type = SvTYPE(sv);
5358 const struct body_details *const sv_type_details
5359 = bodies_by_type + type;
5362 PERL_ARGS_ASSERT_SV_CLEAR;
5363 assert(SvREFCNT(sv) == 0);
5364 assert(SvTYPE(sv) != SVTYPEMASK);
5366 if (type <= SVt_IV) {
5367 /* See the comment in sv.h about the collusion between this early
5368 return and the overloading of the NULL and IV slots in the size
5371 SV * const target = SvRV(sv);
5373 sv_del_backref(target, sv);
5375 SvREFCNT_dec(target);
5377 SvFLAGS(sv) &= SVf_BREAK;
5378 SvFLAGS(sv) |= SVTYPEMASK;
5383 if (PL_defstash && /* Still have a symbol table? */
5390 stash = SvSTASH(sv);
5391 destructor = StashHANDLER(stash,DESTROY);
5393 SV* const tmpref = newRV(sv);
5394 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5396 PUSHSTACKi(PERLSI_DESTROY);
5401 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5407 if(SvREFCNT(tmpref) < 2) {
5408 /* tmpref is not kept alive! */
5410 SvRV_set(tmpref, NULL);
5413 SvREFCNT_dec(tmpref);
5415 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5419 if (PL_in_clean_objs)
5420 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5422 /* DESTROY gave object new lease on life */
5428 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5429 SvOBJECT_off(sv); /* Curse the object. */
5430 if (type != SVt_PVIO)
5431 --PL_sv_objcount; /* XXX Might want something more general */
5434 if (type >= SVt_PVMG) {
5435 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5436 SvREFCNT_dec(SvOURSTASH(sv));
5437 } else if (SvMAGIC(sv))
5439 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5440 SvREFCNT_dec(SvSTASH(sv));
5443 /* case SVt_BIND: */
5446 IoIFP(sv) != PerlIO_stdin() &&
5447 IoIFP(sv) != PerlIO_stdout() &&
5448 IoIFP(sv) != PerlIO_stderr())
5450 io_close((IO*)sv, FALSE);
5452 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5453 PerlDir_close(IoDIRP(sv));
5454 IoDIRP(sv) = (DIR*)NULL;
5455 Safefree(IoTOP_NAME(sv));
5456 Safefree(IoFMT_NAME(sv));
5457 Safefree(IoBOTTOM_NAME(sv));
5460 /* FIXME for plugins */
5461 pregfree2((REGEXP*) sv);
5468 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5472 if (PL_comppad == (AV*)sv) {
5479 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5480 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5481 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5482 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5484 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5485 SvREFCNT_dec(LvTARG(sv));
5487 if (isGV_with_GP(sv)) {
5488 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5489 mro_method_changed_in(stash);
5492 unshare_hek(GvNAME_HEK(sv));
5493 /* If we're in a stash, we don't own a reference to it. However it does
5494 have a back reference to us, which needs to be cleared. */
5495 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5496 sv_del_backref((SV*)stash, sv);
5498 /* FIXME. There are probably more unreferenced pointers to SVs in the
5499 interpreter struct that we should check and tidy in a similar
5501 if ((GV*)sv == PL_last_in_gv)
5502 PL_last_in_gv = NULL;
5508 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5511 SvOOK_offset(sv, offset);
5512 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5513 /* Don't even bother with turning off the OOK flag. */
5516 SV * const target = SvRV(sv);
5518 sv_del_backref(target, sv);
5520 SvREFCNT_dec(target);
5522 #ifdef PERL_OLD_COPY_ON_WRITE
5523 else if (SvPVX_const(sv)) {
5525 /* I believe I need to grab the global SV mutex here and
5526 then recheck the COW status. */
5528 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5532 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5534 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5537 /* And drop it here. */
5539 } else if (SvLEN(sv)) {
5540 Safefree(SvPVX_const(sv));
5544 else if (SvPVX_const(sv) && SvLEN(sv))
5545 Safefree(SvPVX_mutable(sv));
5546 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5547 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5556 SvFLAGS(sv) &= SVf_BREAK;
5557 SvFLAGS(sv) |= SVTYPEMASK;
5559 if (sv_type_details->arena) {
5560 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5561 &PL_body_roots[type]);
5563 else if (sv_type_details->body_size) {
5564 my_safefree(SvANY(sv));
5569 =for apidoc sv_newref
5571 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5578 Perl_sv_newref(pTHX_ SV *const sv)
5580 PERL_UNUSED_CONTEXT;
5589 Decrement an SV's reference count, and if it drops to zero, call
5590 C<sv_clear> to invoke destructors and free up any memory used by
5591 the body; finally, deallocate the SV's head itself.
5592 Normally called via a wrapper macro C<SvREFCNT_dec>.
5598 Perl_sv_free(pTHX_ SV *const sv)
5603 if (SvREFCNT(sv) == 0) {
5604 if (SvFLAGS(sv) & SVf_BREAK)
5605 /* this SV's refcnt has been artificially decremented to
5606 * trigger cleanup */
5608 if (PL_in_clean_all) /* All is fair */
5610 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5611 /* make sure SvREFCNT(sv)==0 happens very seldom */
5612 SvREFCNT(sv) = (~(U32)0)/2;
5615 if (ckWARN_d(WARN_INTERNAL)) {
5616 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5617 Perl_dump_sv_child(aTHX_ sv);
5619 #ifdef DEBUG_LEAKING_SCALARS
5622 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5623 if (PL_warnhook == PERL_WARNHOOK_FATAL
5624 || ckDEAD(packWARN(WARN_INTERNAL))) {
5625 /* Don't let Perl_warner cause us to escape our fate: */
5629 /* This may not return: */
5630 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5631 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5632 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5635 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5640 if (--(SvREFCNT(sv)) > 0)
5642 Perl_sv_free2(aTHX_ sv);
5646 Perl_sv_free2(pTHX_ SV *const sv)
5650 PERL_ARGS_ASSERT_SV_FREE2;
5654 if (ckWARN_d(WARN_DEBUGGING))
5655 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5656 "Attempt to free temp prematurely: SV 0x%"UVxf
5657 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5661 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5662 /* make sure SvREFCNT(sv)==0 happens very seldom */
5663 SvREFCNT(sv) = (~(U32)0)/2;
5674 Returns the length of the string in the SV. Handles magic and type
5675 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5681 Perl_sv_len(pTHX_ register SV *const sv)
5689 len = mg_length(sv);
5691 (void)SvPV_const(sv, len);
5696 =for apidoc sv_len_utf8
5698 Returns the number of characters in the string in an SV, counting wide
5699 UTF-8 bytes as a single character. Handles magic and type coercion.
5705 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5706 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5707 * (Note that the mg_len is not the length of the mg_ptr field.
5708 * This allows the cache to store the character length of the string without
5709 * needing to malloc() extra storage to attach to the mg_ptr.)
5714 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5720 return mg_length(sv);
5724 const U8 *s = (U8*)SvPV_const(sv, len);
5728 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5730 if (mg && mg->mg_len != -1) {
5732 if (PL_utf8cache < 0) {
5733 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5735 /* Need to turn the assertions off otherwise we may
5736 recurse infinitely while printing error messages.
5738 SAVEI8(PL_utf8cache);
5740 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5741 " real %"UVuf" for %"SVf,
5742 (UV) ulen, (UV) real, SVfARG(sv));
5747 ulen = Perl_utf8_length(aTHX_ s, s + len);
5748 if (!SvREADONLY(sv)) {
5750 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5751 &PL_vtbl_utf8, 0, 0);
5759 return Perl_utf8_length(aTHX_ s, s + len);
5763 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5766 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5769 const U8 *s = start;
5771 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5773 while (s < send && uoffset--)
5776 /* This is the existing behaviour. Possibly it should be a croak, as
5777 it's actually a bounds error */
5783 /* Given the length of the string in both bytes and UTF-8 characters, decide
5784 whether to walk forwards or backwards to find the byte corresponding to
5785 the passed in UTF-8 offset. */
5787 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5788 const STRLEN uoffset, const STRLEN uend)
5790 STRLEN backw = uend - uoffset;
5792 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5794 if (uoffset < 2 * backw) {
5795 /* The assumption is that going forwards is twice the speed of going
5796 forward (that's where the 2 * backw comes from).
5797 (The real figure of course depends on the UTF-8 data.) */
5798 return sv_pos_u2b_forwards(start, send, uoffset);
5803 while (UTF8_IS_CONTINUATION(*send))
5806 return send - start;
5809 /* For the string representation of the given scalar, find the byte
5810 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5811 give another position in the string, *before* the sought offset, which
5812 (which is always true, as 0, 0 is a valid pair of positions), which should
5813 help reduce the amount of linear searching.
5814 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5815 will be used to reduce the amount of linear searching. The cache will be
5816 created if necessary, and the found value offered to it for update. */
5818 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5819 const U8 *const send, const STRLEN uoffset,
5820 STRLEN uoffset0, STRLEN boffset0)
5822 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5825 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5827 assert (uoffset >= uoffset0);
5829 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5830 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5831 if ((*mgp)->mg_ptr) {
5832 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5833 if (cache[0] == uoffset) {
5834 /* An exact match. */
5837 if (cache[2] == uoffset) {
5838 /* An exact match. */
5842 if (cache[0] < uoffset) {
5843 /* The cache already knows part of the way. */
5844 if (cache[0] > uoffset0) {
5845 /* The cache knows more than the passed in pair */
5846 uoffset0 = cache[0];
5847 boffset0 = cache[1];
5849 if ((*mgp)->mg_len != -1) {
5850 /* And we know the end too. */
5852 + sv_pos_u2b_midway(start + boffset0, send,
5854 (*mgp)->mg_len - uoffset0);
5857 + sv_pos_u2b_forwards(start + boffset0,
5858 send, uoffset - uoffset0);
5861 else if (cache[2] < uoffset) {
5862 /* We're between the two cache entries. */
5863 if (cache[2] > uoffset0) {
5864 /* and the cache knows more than the passed in pair */
5865 uoffset0 = cache[2];
5866 boffset0 = cache[3];
5870 + sv_pos_u2b_midway(start + boffset0,
5873 cache[0] - uoffset0);
5876 + sv_pos_u2b_midway(start + boffset0,
5879 cache[2] - uoffset0);
5883 else if ((*mgp)->mg_len != -1) {
5884 /* If we can take advantage of a passed in offset, do so. */
5885 /* In fact, offset0 is either 0, or less than offset, so don't
5886 need to worry about the other possibility. */
5888 + sv_pos_u2b_midway(start + boffset0, send,
5890 (*mgp)->mg_len - uoffset0);
5895 if (!found || PL_utf8cache < 0) {
5896 const STRLEN real_boffset
5897 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5898 send, uoffset - uoffset0);
5900 if (found && PL_utf8cache < 0) {
5901 if (real_boffset != boffset) {
5902 /* Need to turn the assertions off otherwise we may recurse
5903 infinitely while printing error messages. */
5904 SAVEI8(PL_utf8cache);
5906 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5907 " real %"UVuf" for %"SVf,
5908 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5911 boffset = real_boffset;
5915 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5921 =for apidoc sv_pos_u2b
5923 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5924 the start of the string, to a count of the equivalent number of bytes; if
5925 lenp is non-zero, it does the same to lenp, but this time starting from
5926 the offset, rather than from the start of the string. Handles magic and
5933 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5934 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5935 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5940 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5945 PERL_ARGS_ASSERT_SV_POS_U2B;
5950 start = (U8*)SvPV_const(sv, len);
5952 STRLEN uoffset = (STRLEN) *offsetp;
5953 const U8 * const send = start + len;
5955 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5958 *offsetp = (I32) boffset;
5961 /* Convert the relative offset to absolute. */
5962 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5963 const STRLEN boffset2
5964 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5965 uoffset, boffset) - boffset;
5979 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5980 byte length pairing. The (byte) length of the total SV is passed in too,
5981 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5982 may not have updated SvCUR, so we can't rely on reading it directly.
5984 The proffered utf8/byte length pairing isn't used if the cache already has
5985 two pairs, and swapping either for the proffered pair would increase the
5986 RMS of the intervals between known byte offsets.
5988 The cache itself consists of 4 STRLEN values
5989 0: larger UTF-8 offset
5990 1: corresponding byte offset
5991 2: smaller UTF-8 offset
5992 3: corresponding byte offset
5994 Unused cache pairs have the value 0, 0.
5995 Keeping the cache "backwards" means that the invariant of
5996 cache[0] >= cache[2] is maintained even with empty slots, which means that
5997 the code that uses it doesn't need to worry if only 1 entry has actually
5998 been set to non-zero. It also makes the "position beyond the end of the
5999 cache" logic much simpler, as the first slot is always the one to start
6003 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
6004 const STRLEN utf8, const STRLEN blen)
6008 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
6014 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
6016 (*mgp)->mg_len = -1;
6020 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6021 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6022 (*mgp)->mg_ptr = (char *) cache;
6026 if (PL_utf8cache < 0) {
6027 const U8 *start = (const U8 *) SvPVX_const(sv);
6028 const STRLEN realutf8 = utf8_length(start, start + byte);
6030 if (realutf8 != utf8) {
6031 /* Need to turn the assertions off otherwise we may recurse
6032 infinitely while printing error messages. */
6033 SAVEI8(PL_utf8cache);
6035 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6036 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6040 /* Cache is held with the later position first, to simplify the code
6041 that deals with unbounded ends. */
6043 ASSERT_UTF8_CACHE(cache);
6044 if (cache[1] == 0) {
6045 /* Cache is totally empty */
6048 } else if (cache[3] == 0) {
6049 if (byte > cache[1]) {
6050 /* New one is larger, so goes first. */
6051 cache[2] = cache[0];
6052 cache[3] = cache[1];
6060 #define THREEWAY_SQUARE(a,b,c,d) \
6061 ((float)((d) - (c))) * ((float)((d) - (c))) \
6062 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6063 + ((float)((b) - (a))) * ((float)((b) - (a)))
6065 /* Cache has 2 slots in use, and we know three potential pairs.
6066 Keep the two that give the lowest RMS distance. Do the
6067 calcualation in bytes simply because we always know the byte
6068 length. squareroot has the same ordering as the positive value,
6069 so don't bother with the actual square root. */
6070 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6071 if (byte > cache[1]) {
6072 /* New position is after 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, cache[1], byte, blen);
6078 if (keep_later < keep_earlier) {
6079 if (keep_later < existing) {
6080 cache[2] = cache[0];
6081 cache[3] = cache[1];
6087 if (keep_earlier < existing) {
6093 else if (byte > cache[3]) {
6094 /* New position is between the existing pair of pairs. */
6095 const float keep_earlier
6096 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6097 const float keep_later
6098 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6100 if (keep_later < keep_earlier) {
6101 if (keep_later < existing) {
6107 if (keep_earlier < existing) {
6114 /* New position is before the existing pair of pairs. */
6115 const float keep_earlier
6116 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6117 const float keep_later
6118 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6120 if (keep_later < keep_earlier) {
6121 if (keep_later < existing) {
6127 if (keep_earlier < existing) {
6128 cache[0] = cache[2];
6129 cache[1] = cache[3];
6136 ASSERT_UTF8_CACHE(cache);
6139 /* We already know all of the way, now we may be able to walk back. The same
6140 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6141 backward is half the speed of walking forward. */
6143 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6144 const U8 *end, STRLEN endu)
6146 const STRLEN forw = target - s;
6147 STRLEN backw = end - target;
6149 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6151 if (forw < 2 * backw) {
6152 return utf8_length(s, target);
6155 while (end > target) {
6157 while (UTF8_IS_CONTINUATION(*end)) {
6166 =for apidoc sv_pos_b2u
6168 Converts the value pointed to by offsetp from a count of bytes from the
6169 start of the string, to a count of the equivalent number of UTF-8 chars.
6170 Handles magic and type coercion.
6176 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6177 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6182 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6185 const STRLEN byte = *offsetp;
6186 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6192 PERL_ARGS_ASSERT_SV_POS_B2U;
6197 s = (const U8*)SvPV_const(sv, blen);
6200 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6204 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6205 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6207 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6208 if (cache[1] == byte) {
6209 /* An exact match. */
6210 *offsetp = cache[0];
6213 if (cache[3] == byte) {
6214 /* An exact match. */
6215 *offsetp = cache[2];
6219 if (cache[1] < byte) {
6220 /* We already know part of the way. */
6221 if (mg->mg_len != -1) {
6222 /* Actually, we know the end too. */
6224 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6225 s + blen, mg->mg_len - cache[0]);
6227 len = cache[0] + utf8_length(s + cache[1], send);
6230 else if (cache[3] < byte) {
6231 /* We're between the two cached pairs, so we do the calculation
6232 offset by the byte/utf-8 positions for the earlier pair,
6233 then add the utf-8 characters from the string start to
6235 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6236 s + cache[1], cache[0] - cache[2])
6240 else { /* cache[3] > byte */
6241 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6245 ASSERT_UTF8_CACHE(cache);
6247 } else if (mg->mg_len != -1) {
6248 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6252 if (!found || PL_utf8cache < 0) {
6253 const STRLEN real_len = utf8_length(s, send);
6255 if (found && PL_utf8cache < 0) {
6256 if (len != real_len) {
6257 /* Need to turn the assertions off otherwise we may recurse
6258 infinitely while printing error messages. */
6259 SAVEI8(PL_utf8cache);
6261 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6262 " real %"UVuf" for %"SVf,
6263 (UV) len, (UV) real_len, SVfARG(sv));
6271 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6277 Returns a boolean indicating whether the strings in the two SVs are
6278 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6279 coerce its args to strings if necessary.
6285 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6294 SV* svrecode = NULL;
6301 /* if pv1 and pv2 are the same, second SvPV_const call may
6302 * invalidate pv1, so we may need to make a copy */
6303 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6304 pv1 = SvPV_const(sv1, cur1);
6305 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6307 pv1 = SvPV_const(sv1, cur1);
6315 pv2 = SvPV_const(sv2, cur2);
6317 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6318 /* Differing utf8ness.
6319 * Do not UTF8size the comparands as a side-effect. */
6322 svrecode = newSVpvn(pv2, cur2);
6323 sv_recode_to_utf8(svrecode, PL_encoding);
6324 pv2 = SvPV_const(svrecode, cur2);
6327 svrecode = newSVpvn(pv1, cur1);
6328 sv_recode_to_utf8(svrecode, PL_encoding);
6329 pv1 = SvPV_const(svrecode, cur1);
6331 /* Now both are in UTF-8. */
6333 SvREFCNT_dec(svrecode);
6338 bool is_utf8 = TRUE;
6341 /* sv1 is the UTF-8 one,
6342 * if is equal it must be downgrade-able */
6343 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6349 /* sv2 is the UTF-8 one,
6350 * if is equal it must be downgrade-able */
6351 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6357 /* Downgrade not possible - cannot be eq */
6365 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6367 SvREFCNT_dec(svrecode);
6377 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6378 string in C<sv1> is less than, equal to, or greater than the string in
6379 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6380 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6386 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6390 const char *pv1, *pv2;
6393 SV *svrecode = NULL;
6400 pv1 = SvPV_const(sv1, cur1);
6407 pv2 = SvPV_const(sv2, cur2);
6409 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6410 /* Differing utf8ness.
6411 * Do not UTF8size the comparands as a side-effect. */
6414 svrecode = newSVpvn(pv2, cur2);
6415 sv_recode_to_utf8(svrecode, PL_encoding);
6416 pv2 = SvPV_const(svrecode, cur2);
6419 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6424 svrecode = newSVpvn(pv1, cur1);
6425 sv_recode_to_utf8(svrecode, PL_encoding);
6426 pv1 = SvPV_const(svrecode, cur1);
6429 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6435 cmp = cur2 ? -1 : 0;
6439 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6442 cmp = retval < 0 ? -1 : 1;
6443 } else if (cur1 == cur2) {
6446 cmp = cur1 < cur2 ? -1 : 1;
6450 SvREFCNT_dec(svrecode);
6458 =for apidoc sv_cmp_locale
6460 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6461 'use bytes' aware, handles get magic, and will coerce its args to strings
6462 if necessary. See also C<sv_cmp>.
6468 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6471 #ifdef USE_LOCALE_COLLATE
6477 if (PL_collation_standard)
6481 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6483 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6485 if (!pv1 || !len1) {
6496 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6499 return retval < 0 ? -1 : 1;
6502 * When the result of collation is equality, that doesn't mean
6503 * that there are no differences -- some locales exclude some
6504 * characters from consideration. So to avoid false equalities,
6505 * we use the raw string as a tiebreaker.
6511 #endif /* USE_LOCALE_COLLATE */
6513 return sv_cmp(sv1, sv2);
6517 #ifdef USE_LOCALE_COLLATE
6520 =for apidoc sv_collxfrm
6522 Add Collate Transform magic to an SV if it doesn't already have it.
6524 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6525 scalar data of the variable, but transformed to such a format that a normal
6526 memory comparison can be used to compare the data according to the locale
6533 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6538 PERL_ARGS_ASSERT_SV_COLLXFRM;
6540 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6541 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6547 Safefree(mg->mg_ptr);
6548 s = SvPV_const(sv, len);
6549 if ((xf = mem_collxfrm(s, len, &xlen))) {
6551 #ifdef PERL_OLD_COPY_ON_WRITE
6553 sv_force_normal_flags(sv, 0);
6555 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6569 if (mg && mg->mg_ptr) {
6571 return mg->mg_ptr + sizeof(PL_collation_ix);
6579 #endif /* USE_LOCALE_COLLATE */
6584 Get a line from the filehandle and store it into the SV, optionally
6585 appending to the currently-stored string.
6591 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6596 register STDCHAR rslast;
6597 register STDCHAR *bp;
6602 PERL_ARGS_ASSERT_SV_GETS;
6604 if (SvTHINKFIRST(sv))
6605 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6606 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6608 However, perlbench says it's slower, because the existing swipe code
6609 is faster than copy on write.
6610 Swings and roundabouts. */
6611 SvUPGRADE(sv, SVt_PV);
6616 if (PerlIO_isutf8(fp)) {
6618 sv_utf8_upgrade_nomg(sv);
6619 sv_pos_u2b(sv,&append,0);
6621 } else if (SvUTF8(sv)) {
6622 SV * const tsv = newSV(0);
6623 sv_gets(tsv, fp, 0);
6624 sv_utf8_upgrade_nomg(tsv);
6625 SvCUR_set(sv,append);
6628 goto return_string_or_null;
6633 if (PerlIO_isutf8(fp))
6636 if (IN_PERL_COMPILETIME) {
6637 /* we always read code in line mode */
6641 else if (RsSNARF(PL_rs)) {
6642 /* If it is a regular disk file use size from stat() as estimate
6643 of amount we are going to read -- may result in mallocing
6644 more memory than we really need if the layers below reduce
6645 the size we read (e.g. CRLF or a gzip layer).
6648 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6649 const Off_t offset = PerlIO_tell(fp);
6650 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6651 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6657 else if (RsRECORD(PL_rs)) {
6665 /* Grab the size of the record we're getting */
6666 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6667 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6670 /* VMS wants read instead of fread, because fread doesn't respect */
6671 /* RMS record boundaries. This is not necessarily a good thing to be */
6672 /* doing, but we've got no other real choice - except avoid stdio
6673 as implementation - perhaps write a :vms layer ?
6675 fd = PerlIO_fileno(fp);
6676 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6677 bytesread = PerlIO_read(fp, buffer, recsize);
6680 bytesread = PerlLIO_read(fd, buffer, recsize);
6683 bytesread = PerlIO_read(fp, buffer, recsize);
6687 SvCUR_set(sv, bytesread += append);
6688 buffer[bytesread] = '\0';
6689 goto return_string_or_null;
6691 else if (RsPARA(PL_rs)) {
6697 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6698 if (PerlIO_isutf8(fp)) {
6699 rsptr = SvPVutf8(PL_rs, rslen);
6702 if (SvUTF8(PL_rs)) {
6703 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6704 Perl_croak(aTHX_ "Wide character in $/");
6707 rsptr = SvPV_const(PL_rs, rslen);
6711 rslast = rslen ? rsptr[rslen - 1] : '\0';
6713 if (rspara) { /* have to do this both before and after */
6714 do { /* to make sure file boundaries work right */
6717 i = PerlIO_getc(fp);
6721 PerlIO_ungetc(fp,i);
6727 /* See if we know enough about I/O mechanism to cheat it ! */
6729 /* This used to be #ifdef test - it is made run-time test for ease
6730 of abstracting out stdio interface. One call should be cheap
6731 enough here - and may even be a macro allowing compile
6735 if (PerlIO_fast_gets(fp)) {
6738 * We're going to steal some values from the stdio struct
6739 * and put EVERYTHING in the innermost loop into registers.
6741 register STDCHAR *ptr;
6745 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6746 /* An ungetc()d char is handled separately from the regular
6747 * buffer, so we getc() it back out and stuff it in the buffer.
6749 i = PerlIO_getc(fp);
6750 if (i == EOF) return 0;
6751 *(--((*fp)->_ptr)) = (unsigned char) i;
6755 /* Here is some breathtakingly efficient cheating */
6757 cnt = PerlIO_get_cnt(fp); /* get count into register */
6758 /* make sure we have the room */
6759 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6760 /* Not room for all of it
6761 if we are looking for a separator and room for some
6763 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6764 /* just process what we have room for */
6765 shortbuffered = cnt - SvLEN(sv) + append + 1;
6766 cnt -= shortbuffered;
6770 /* remember that cnt can be negative */
6771 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6776 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6777 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6778 DEBUG_P(PerlIO_printf(Perl_debug_log,
6779 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6780 DEBUG_P(PerlIO_printf(Perl_debug_log,
6781 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6782 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6783 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6788 while (cnt > 0) { /* this | eat */
6790 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6791 goto thats_all_folks; /* screams | sed :-) */
6795 Copy(ptr, bp, cnt, char); /* this | eat */
6796 bp += cnt; /* screams | dust */
6797 ptr += cnt; /* louder | sed :-) */
6802 if (shortbuffered) { /* oh well, must extend */
6803 cnt = shortbuffered;
6805 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6807 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6808 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6812 DEBUG_P(PerlIO_printf(Perl_debug_log,
6813 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6814 PTR2UV(ptr),(long)cnt));
6815 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6817 DEBUG_P(PerlIO_printf(Perl_debug_log,
6818 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6819 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6820 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6822 /* This used to call 'filbuf' in stdio form, but as that behaves like
6823 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6824 another abstraction. */
6825 i = PerlIO_getc(fp); /* get more characters */
6827 DEBUG_P(PerlIO_printf(Perl_debug_log,
6828 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6829 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6830 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6832 cnt = PerlIO_get_cnt(fp);
6833 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6834 DEBUG_P(PerlIO_printf(Perl_debug_log,
6835 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6837 if (i == EOF) /* all done for ever? */
6838 goto thats_really_all_folks;
6840 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6842 SvGROW(sv, bpx + cnt + 2);
6843 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6845 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6847 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6848 goto thats_all_folks;
6852 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6853 memNE((char*)bp - rslen, rsptr, rslen))
6854 goto screamer; /* go back to the fray */
6855 thats_really_all_folks:
6857 cnt += shortbuffered;
6858 DEBUG_P(PerlIO_printf(Perl_debug_log,
6859 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6860 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6861 DEBUG_P(PerlIO_printf(Perl_debug_log,
6862 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6863 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6864 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6866 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6867 DEBUG_P(PerlIO_printf(Perl_debug_log,
6868 "Screamer: done, len=%ld, string=|%.*s|\n",
6869 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6873 /*The big, slow, and stupid way. */
6874 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6875 STDCHAR *buf = NULL;
6876 Newx(buf, 8192, STDCHAR);
6884 register const STDCHAR * const bpe = buf + sizeof(buf);
6886 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6887 ; /* keep reading */
6891 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6892 /* Accomodate broken VAXC compiler, which applies U8 cast to
6893 * both args of ?: operator, causing EOF to change into 255
6896 i = (U8)buf[cnt - 1];
6902 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6904 sv_catpvn(sv, (char *) buf, cnt);
6906 sv_setpvn(sv, (char *) buf, cnt);
6908 if (i != EOF && /* joy */
6910 SvCUR(sv) < rslen ||
6911 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6915 * If we're reading from a TTY and we get a short read,
6916 * indicating that the user hit his EOF character, we need
6917 * to notice it now, because if we try to read from the TTY
6918 * again, the EOF condition will disappear.
6920 * The comparison of cnt to sizeof(buf) is an optimization
6921 * that prevents unnecessary calls to feof().
6925 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6929 #ifdef USE_HEAP_INSTEAD_OF_STACK
6934 if (rspara) { /* have to do this both before and after */
6935 while (i != EOF) { /* to make sure file boundaries work right */
6936 i = PerlIO_getc(fp);
6938 PerlIO_ungetc(fp,i);
6944 return_string_or_null:
6945 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6951 Auto-increment of the value in the SV, doing string to numeric conversion
6952 if necessary. Handles 'get' magic.
6958 Perl_sv_inc(pTHX_ register SV *const sv)
6967 if (SvTHINKFIRST(sv)) {
6969 sv_force_normal_flags(sv, 0);
6970 if (SvREADONLY(sv)) {
6971 if (IN_PERL_RUNTIME)
6972 Perl_croak(aTHX_ PL_no_modify);
6976 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6978 i = PTR2IV(SvRV(sv));
6983 flags = SvFLAGS(sv);
6984 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6985 /* It's (privately or publicly) a float, but not tested as an
6986 integer, so test it to see. */
6988 flags = SvFLAGS(sv);
6990 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6991 /* It's publicly an integer, or privately an integer-not-float */
6992 #ifdef PERL_PRESERVE_IVUV
6996 if (SvUVX(sv) == UV_MAX)
6997 sv_setnv(sv, UV_MAX_P1);
6999 (void)SvIOK_only_UV(sv);
7000 SvUV_set(sv, SvUVX(sv) + 1);
7002 if (SvIVX(sv) == IV_MAX)
7003 sv_setuv(sv, (UV)IV_MAX + 1);
7005 (void)SvIOK_only(sv);
7006 SvIV_set(sv, SvIVX(sv) + 1);
7011 if (flags & SVp_NOK) {
7012 const NV was = SvNVX(sv);
7013 if (NV_OVERFLOWS_INTEGERS_AT &&
7014 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7015 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7016 "Lost precision when incrementing %" NVff " by 1",
7019 (void)SvNOK_only(sv);
7020 SvNV_set(sv, was + 1.0);
7024 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7025 if ((flags & SVTYPEMASK) < SVt_PVIV)
7026 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7027 (void)SvIOK_only(sv);
7032 while (isALPHA(*d)) d++;
7033 while (isDIGIT(*d)) d++;
7035 #ifdef PERL_PRESERVE_IVUV
7036 /* Got to punt this as an integer if needs be, but we don't issue
7037 warnings. Probably ought to make the sv_iv_please() that does
7038 the conversion if possible, and silently. */
7039 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7040 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7041 /* Need to try really hard to see if it's an integer.
7042 9.22337203685478e+18 is an integer.
7043 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7044 so $a="9.22337203685478e+18"; $a+0; $a++
7045 needs to be the same as $a="9.22337203685478e+18"; $a++
7052 /* sv_2iv *should* have made this an NV */
7053 if (flags & SVp_NOK) {
7054 (void)SvNOK_only(sv);
7055 SvNV_set(sv, SvNVX(sv) + 1.0);
7058 /* I don't think we can get here. Maybe I should assert this
7059 And if we do get here I suspect that sv_setnv will croak. NWC
7061 #if defined(USE_LONG_DOUBLE)
7062 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",
7063 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7065 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7066 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7069 #endif /* PERL_PRESERVE_IVUV */
7070 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7074 while (d >= SvPVX_const(sv)) {
7082 /* MKS: The original code here died if letters weren't consecutive.
7083 * at least it didn't have to worry about non-C locales. The
7084 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7085 * arranged in order (although not consecutively) and that only
7086 * [A-Za-z] are accepted by isALPHA in the C locale.
7088 if (*d != 'z' && *d != 'Z') {
7089 do { ++*d; } while (!isALPHA(*d));
7092 *(d--) -= 'z' - 'a';
7097 *(d--) -= 'z' - 'a' + 1;
7101 /* oh,oh, the number grew */
7102 SvGROW(sv, SvCUR(sv) + 2);
7103 SvCUR_set(sv, SvCUR(sv) + 1);
7104 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7115 Auto-decrement of the value in the SV, doing string to numeric conversion
7116 if necessary. Handles 'get' magic.
7122 Perl_sv_dec(pTHX_ register SV *const sv)
7130 if (SvTHINKFIRST(sv)) {
7132 sv_force_normal_flags(sv, 0);
7133 if (SvREADONLY(sv)) {
7134 if (IN_PERL_RUNTIME)
7135 Perl_croak(aTHX_ PL_no_modify);
7139 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7141 i = PTR2IV(SvRV(sv));
7146 /* Unlike sv_inc we don't have to worry about string-never-numbers
7147 and keeping them magic. But we mustn't warn on punting */
7148 flags = SvFLAGS(sv);
7149 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7150 /* It's publicly an integer, or privately an integer-not-float */
7151 #ifdef PERL_PRESERVE_IVUV
7155 if (SvUVX(sv) == 0) {
7156 (void)SvIOK_only(sv);
7160 (void)SvIOK_only_UV(sv);
7161 SvUV_set(sv, SvUVX(sv) - 1);
7164 if (SvIVX(sv) == IV_MIN) {
7165 sv_setnv(sv, (NV)IV_MIN);
7169 (void)SvIOK_only(sv);
7170 SvIV_set(sv, SvIVX(sv) - 1);
7175 if (flags & SVp_NOK) {
7178 const NV was = SvNVX(sv);
7179 if (NV_OVERFLOWS_INTEGERS_AT &&
7180 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7181 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7182 "Lost precision when decrementing %" NVff " by 1",
7185 (void)SvNOK_only(sv);
7186 SvNV_set(sv, was - 1.0);
7190 if (!(flags & SVp_POK)) {
7191 if ((flags & SVTYPEMASK) < SVt_PVIV)
7192 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7194 (void)SvIOK_only(sv);
7197 #ifdef PERL_PRESERVE_IVUV
7199 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7200 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7201 /* Need to try really hard to see if it's an integer.
7202 9.22337203685478e+18 is an integer.
7203 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7204 so $a="9.22337203685478e+18"; $a+0; $a--
7205 needs to be the same as $a="9.22337203685478e+18"; $a--
7212 /* sv_2iv *should* have made this an NV */
7213 if (flags & SVp_NOK) {
7214 (void)SvNOK_only(sv);
7215 SvNV_set(sv, SvNVX(sv) - 1.0);
7218 /* I don't think we can get here. Maybe I should assert this
7219 And if we do get here I suspect that sv_setnv will croak. NWC
7221 #if defined(USE_LONG_DOUBLE)
7222 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",
7223 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7225 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7226 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7230 #endif /* PERL_PRESERVE_IVUV */
7231 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7235 =for apidoc sv_mortalcopy
7237 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7238 The new SV is marked as mortal. It will be destroyed "soon", either by an
7239 explicit call to FREETMPS, or by an implicit call at places such as
7240 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7245 /* Make a string that will exist for the duration of the expression
7246 * evaluation. Actually, it may have to last longer than that, but
7247 * hopefully we won't free it until it has been assigned to a
7248 * permanent location. */
7251 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7257 sv_setsv(sv,oldstr);
7259 PL_tmps_stack[++PL_tmps_ix] = sv;
7265 =for apidoc sv_newmortal
7267 Creates a new null SV which is mortal. The reference count of the SV is
7268 set to 1. It will be destroyed "soon", either by an explicit call to
7269 FREETMPS, or by an implicit call at places such as statement boundaries.
7270 See also C<sv_mortalcopy> and C<sv_2mortal>.
7276 Perl_sv_newmortal(pTHX)
7282 SvFLAGS(sv) = SVs_TEMP;
7284 PL_tmps_stack[++PL_tmps_ix] = sv;
7290 =for apidoc newSVpvn_flags
7292 Creates a new SV and copies a string into it. The reference count for the
7293 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7294 string. You are responsible for ensuring that the source string is at least
7295 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7296 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7297 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7298 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7299 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7301 #define newSVpvn_utf8(s, len, u) \
7302 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7308 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7313 /* All the flags we don't support must be zero.
7314 And we're new code so I'm going to assert this from the start. */
7315 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7317 sv_setpvn(sv,s,len);
7318 SvFLAGS(sv) |= (flags & SVf_UTF8);
7319 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7323 =for apidoc sv_2mortal
7325 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7326 by an explicit call to FREETMPS, or by an implicit call at places such as
7327 statement boundaries. SvTEMP() is turned on which means that the SV's
7328 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7329 and C<sv_mortalcopy>.
7335 Perl_sv_2mortal(pTHX_ register SV *const sv)
7340 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7343 PL_tmps_stack[++PL_tmps_ix] = sv;
7351 Creates a new SV and copies a string into it. The reference count for the
7352 SV is set to 1. If C<len> is zero, Perl will compute the length using
7353 strlen(). For efficiency, consider using C<newSVpvn> instead.
7359 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7365 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7370 =for apidoc newSVpvn
7372 Creates a new SV and copies a string into it. The reference count for the
7373 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7374 string. You are responsible for ensuring that the source string is at least
7375 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7381 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7387 sv_setpvn(sv,s,len);
7392 =for apidoc newSVhek
7394 Creates a new SV from the hash key structure. It will generate scalars that
7395 point to the shared string table where possible. Returns a new (undefined)
7396 SV if the hek is NULL.
7402 Perl_newSVhek(pTHX_ const HEK *const hek)
7412 if (HEK_LEN(hek) == HEf_SVKEY) {
7413 return newSVsv(*(SV**)HEK_KEY(hek));
7415 const int flags = HEK_FLAGS(hek);
7416 if (flags & HVhek_WASUTF8) {
7418 Andreas would like keys he put in as utf8 to come back as utf8
7420 STRLEN utf8_len = HEK_LEN(hek);
7421 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7422 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7425 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7427 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7428 /* We don't have a pointer to the hv, so we have to replicate the
7429 flag into every HEK. This hv is using custom a hasing
7430 algorithm. Hence we can't return a shared string scalar, as
7431 that would contain the (wrong) hash value, and might get passed
7432 into an hv routine with a regular hash.
7433 Similarly, a hash that isn't using shared hash keys has to have
7434 the flag in every key so that we know not to try to call
7435 share_hek_kek on it. */
7437 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7442 /* This will be overwhelminly the most common case. */
7444 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7445 more efficient than sharepvn(). */
7449 sv_upgrade(sv, SVt_PV);
7450 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7451 SvCUR_set(sv, HEK_LEN(hek));
7464 =for apidoc newSVpvn_share
7466 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7467 table. If the string does not already exist in the table, it is created
7468 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7469 value is used; otherwise the hash is computed. The string's hash can be later
7470 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7471 that as the string table is used for shared hash keys these strings will have
7472 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7478 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7482 bool is_utf8 = FALSE;
7483 const char *const orig_src = src;
7486 STRLEN tmplen = -len;
7488 /* See the note in hv.c:hv_fetch() --jhi */
7489 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7493 PERL_HASH(hash, src, len);
7495 sv_upgrade(sv, SVt_PV);
7496 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7504 if (src != orig_src)
7510 #if defined(PERL_IMPLICIT_CONTEXT)
7512 /* pTHX_ magic can't cope with varargs, so this is a no-context
7513 * version of the main function, (which may itself be aliased to us).
7514 * Don't access this version directly.
7518 Perl_newSVpvf_nocontext(const char *const pat, ...)
7524 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7526 va_start(args, pat);
7527 sv = vnewSVpvf(pat, &args);
7534 =for apidoc newSVpvf
7536 Creates a new SV and initializes it with the string formatted like
7543 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7548 PERL_ARGS_ASSERT_NEWSVPVF;
7550 va_start(args, pat);
7551 sv = vnewSVpvf(pat, &args);
7556 /* backend for newSVpvf() and newSVpvf_nocontext() */
7559 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7564 PERL_ARGS_ASSERT_VNEWSVPVF;
7567 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7574 Creates a new SV and copies a floating point value into it.
7575 The reference count for the SV is set to 1.
7581 Perl_newSVnv(pTHX_ const NV n)
7594 Creates a new SV and copies an integer into it. The reference count for the
7601 Perl_newSViv(pTHX_ const IV i)
7614 Creates a new SV and copies an unsigned integer into it.
7615 The reference count for the SV is set to 1.
7621 Perl_newSVuv(pTHX_ const UV u)
7632 =for apidoc newSV_type
7634 Creates a new SV, of the type specified. The reference count for the new SV
7641 Perl_newSV_type(pTHX_ const svtype type)
7646 sv_upgrade(sv, type);
7651 =for apidoc newRV_noinc
7653 Creates an RV wrapper for an SV. The reference count for the original
7654 SV is B<not> incremented.
7660 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7663 register SV *sv = newSV_type(SVt_IV);
7665 PERL_ARGS_ASSERT_NEWRV_NOINC;
7668 SvRV_set(sv, tmpRef);
7673 /* newRV_inc is the official function name to use now.
7674 * newRV_inc is in fact #defined to newRV in sv.h
7678 Perl_newRV(pTHX_ SV *const sv)
7682 PERL_ARGS_ASSERT_NEWRV;
7684 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7690 Creates a new SV which is an exact duplicate of the original SV.
7697 Perl_newSVsv(pTHX_ register SV *const old)
7704 if (SvTYPE(old) == SVTYPEMASK) {
7705 if (ckWARN_d(WARN_INTERNAL))
7706 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7710 /* SV_GMAGIC is the default for sv_setv()
7711 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7712 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7713 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7718 =for apidoc sv_reset
7720 Underlying implementation for the C<reset> Perl function.
7721 Note that the perl-level function is vaguely deprecated.
7727 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7730 char todo[PERL_UCHAR_MAX+1];
7732 PERL_ARGS_ASSERT_SV_RESET;
7737 if (!*s) { /* reset ?? searches */
7738 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7740 const U32 count = mg->mg_len / sizeof(PMOP**);
7741 PMOP **pmp = (PMOP**) mg->mg_ptr;
7742 PMOP *const *const end = pmp + count;
7746 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7748 (*pmp)->op_pmflags &= ~PMf_USED;
7756 /* reset variables */
7758 if (!HvARRAY(stash))
7761 Zero(todo, 256, char);
7764 I32 i = (unsigned char)*s;
7768 max = (unsigned char)*s++;
7769 for ( ; i <= max; i++) {
7772 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7774 for (entry = HvARRAY(stash)[i];
7776 entry = HeNEXT(entry))
7781 if (!todo[(U8)*HeKEY(entry)])
7783 gv = (GV*)HeVAL(entry);
7786 if (SvTHINKFIRST(sv)) {
7787 if (!SvREADONLY(sv) && SvROK(sv))
7789 /* XXX Is this continue a bug? Why should THINKFIRST
7790 exempt us from resetting arrays and hashes? */
7794 if (SvTYPE(sv) >= SVt_PV) {
7796 if (SvPVX_const(sv) != NULL)
7804 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7806 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7809 # if defined(USE_ENVIRON_ARRAY)
7812 # endif /* USE_ENVIRON_ARRAY */
7823 Using various gambits, try to get an IO from an SV: the IO slot if its a
7824 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7825 named after the PV if we're a string.
7831 Perl_sv_2io(pTHX_ SV *const sv)
7836 PERL_ARGS_ASSERT_SV_2IO;
7838 switch (SvTYPE(sv)) {
7843 if (isGV_with_GP(sv)) {
7847 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7853 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7855 return sv_2io(SvRV(sv));
7856 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7862 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7871 Using various gambits, try to get a CV from an SV; in addition, try if
7872 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7873 The flags in C<lref> are passed to sv_fetchsv.
7879 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7885 PERL_ARGS_ASSERT_SV_2CV;
7892 switch (SvTYPE(sv)) {
7903 if (isGV_with_GP(sv)) {
7913 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7915 tryAMAGICunDEREF(to_cv);
7918 if (SvTYPE(sv) == SVt_PVCV) {
7924 else if(isGV_with_GP(sv))
7927 Perl_croak(aTHX_ "Not a subroutine reference");
7929 else if (isGV_with_GP(sv)) {
7934 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7940 /* Some flags to gv_fetchsv mean don't really create the GV */
7941 if (!isGV_with_GP(gv)) {
7947 if (lref && !GvCVu(gv)) {
7951 gv_efullname3(tmpsv, gv, NULL);
7952 /* XXX this is probably not what they think they're getting.
7953 * It has the same effect as "sub name;", i.e. just a forward
7955 newSUB(start_subparse(FALSE, 0),
7956 newSVOP(OP_CONST, 0, tmpsv),
7960 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7961 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7970 Returns true if the SV has a true value by Perl's rules.
7971 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7972 instead use an in-line version.
7978 Perl_sv_true(pTHX_ register SV *const sv)
7983 register const XPV* const tXpv = (XPV*)SvANY(sv);
7985 (tXpv->xpv_cur > 1 ||
7986 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7993 return SvIVX(sv) != 0;
7996 return SvNVX(sv) != 0.0;
7998 return sv_2bool(sv);
8004 =for apidoc sv_pvn_force
8006 Get a sensible string out of the SV somehow.
8007 A private implementation of the C<SvPV_force> macro for compilers which
8008 can't cope with complex macro expressions. Always use the macro instead.
8010 =for apidoc sv_pvn_force_flags
8012 Get a sensible string out of the SV somehow.
8013 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8014 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8015 implemented in terms of this function.
8016 You normally want to use the various wrapper macros instead: see
8017 C<SvPV_force> and C<SvPV_force_nomg>
8023 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8027 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8029 if (SvTHINKFIRST(sv) && !SvROK(sv))
8030 sv_force_normal_flags(sv, 0);
8040 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8041 const char * const ref = sv_reftype(sv,0);
8043 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8044 ref, OP_NAME(PL_op));
8046 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8048 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8049 || isGV_with_GP(sv))
8050 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8052 s = sv_2pv_flags(sv, &len, flags);
8056 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8059 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8060 SvGROW(sv, len + 1);
8061 Move(s,SvPVX(sv),len,char);
8063 SvPVX(sv)[len] = '\0';
8066 SvPOK_on(sv); /* validate pointer */
8068 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8069 PTR2UV(sv),SvPVX_const(sv)));
8072 return SvPVX_mutable(sv);
8076 =for apidoc sv_pvbyten_force
8078 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8084 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8086 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8088 sv_pvn_force(sv,lp);
8089 sv_utf8_downgrade(sv,0);
8095 =for apidoc sv_pvutf8n_force
8097 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8103 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8105 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8107 sv_pvn_force(sv,lp);
8108 sv_utf8_upgrade(sv);
8114 =for apidoc sv_reftype
8116 Returns a string describing what the SV is a reference to.
8122 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8124 PERL_ARGS_ASSERT_SV_REFTYPE;
8126 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8127 inside return suggests a const propagation bug in g++. */
8128 if (ob && SvOBJECT(sv)) {
8129 char * const name = HvNAME_get(SvSTASH(sv));
8130 return name ? name : (char *) "__ANON__";
8133 switch (SvTYPE(sv)) {
8148 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8149 /* tied lvalues should appear to be
8150 * scalars for backwards compatitbility */
8151 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8152 ? "SCALAR" : "LVALUE");
8153 case SVt_PVAV: return "ARRAY";
8154 case SVt_PVHV: return "HASH";
8155 case SVt_PVCV: return "CODE";
8156 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8157 ? "GLOB" : "SCALAR");
8158 case SVt_PVFM: return "FORMAT";
8159 case SVt_PVIO: return "IO";
8160 case SVt_BIND: return "BIND";
8161 case SVt_REGEXP: return "REGEXP";
8162 default: return "UNKNOWN";
8168 =for apidoc sv_isobject
8170 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8171 object. If the SV is not an RV, or if the object is not blessed, then this
8178 Perl_sv_isobject(pTHX_ SV *sv)
8194 Returns a boolean indicating whether the SV is blessed into the specified
8195 class. This does not check for subtypes; use C<sv_derived_from> to verify
8196 an inheritance relationship.
8202 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8206 PERL_ARGS_ASSERT_SV_ISA;
8216 hvname = HvNAME_get(SvSTASH(sv));
8220 return strEQ(hvname, name);
8226 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8227 it will be upgraded to one. If C<classname> is non-null then the new SV will
8228 be blessed in the specified package. The new SV is returned and its
8229 reference count is 1.
8235 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8240 PERL_ARGS_ASSERT_NEWSVRV;
8244 SV_CHECK_THINKFIRST_COW_DROP(rv);
8245 (void)SvAMAGIC_off(rv);
8247 if (SvTYPE(rv) >= SVt_PVMG) {
8248 const U32 refcnt = SvREFCNT(rv);
8252 SvREFCNT(rv) = refcnt;
8254 sv_upgrade(rv, SVt_IV);
8255 } else if (SvROK(rv)) {
8256 SvREFCNT_dec(SvRV(rv));
8258 prepare_SV_for_RV(rv);
8266 HV* const stash = gv_stashpv(classname, GV_ADD);
8267 (void)sv_bless(rv, stash);
8273 =for apidoc sv_setref_pv
8275 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8276 argument will be upgraded to an RV. That RV will be modified to point to
8277 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8278 into the SV. The C<classname> argument indicates the package for the
8279 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8280 will have a reference count of 1, and the RV will be returned.
8282 Do not use with other Perl types such as HV, AV, SV, CV, because those
8283 objects will become corrupted by the pointer copy process.
8285 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8291 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8295 PERL_ARGS_ASSERT_SV_SETREF_PV;
8298 sv_setsv(rv, &PL_sv_undef);
8302 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8307 =for apidoc sv_setref_iv
8309 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8310 argument will be upgraded to an RV. That RV will be modified to point to
8311 the new SV. The C<classname> argument indicates the package for the
8312 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8313 will have a reference count of 1, and the RV will be returned.
8319 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8321 PERL_ARGS_ASSERT_SV_SETREF_IV;
8323 sv_setiv(newSVrv(rv,classname), iv);
8328 =for apidoc sv_setref_uv
8330 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8331 argument will be upgraded to an RV. That RV will be modified to point to
8332 the new SV. The C<classname> argument indicates the package for the
8333 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8334 will have a reference count of 1, and the RV will be returned.
8340 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8342 PERL_ARGS_ASSERT_SV_SETREF_UV;
8344 sv_setuv(newSVrv(rv,classname), uv);
8349 =for apidoc sv_setref_nv
8351 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8352 argument will be upgraded to an RV. That RV will be modified to point to
8353 the new SV. The C<classname> argument indicates the package for the
8354 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8355 will have a reference count of 1, and the RV will be returned.
8361 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8363 PERL_ARGS_ASSERT_SV_SETREF_NV;
8365 sv_setnv(newSVrv(rv,classname), nv);
8370 =for apidoc sv_setref_pvn
8372 Copies a string into a new SV, optionally blessing the SV. The length of the
8373 string must be specified with C<n>. The C<rv> argument will be upgraded to
8374 an RV. That RV will be modified to point to the new SV. The C<classname>
8375 argument indicates the package for the blessing. Set C<classname> to
8376 C<NULL> to avoid the blessing. The new SV will have a reference count
8377 of 1, and the RV will be returned.
8379 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8385 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8386 const char *const pv, const STRLEN n)
8388 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8390 sv_setpvn(newSVrv(rv,classname), pv, n);
8395 =for apidoc sv_bless
8397 Blesses an SV into a specified package. The SV must be an RV. The package
8398 must be designated by its stash (see C<gv_stashpv()>). The reference count
8399 of the SV is unaffected.
8405 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8410 PERL_ARGS_ASSERT_SV_BLESS;
8413 Perl_croak(aTHX_ "Can't bless non-reference value");
8415 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8416 if (SvIsCOW(tmpRef))
8417 sv_force_normal_flags(tmpRef, 0);
8418 if (SvREADONLY(tmpRef))
8419 Perl_croak(aTHX_ PL_no_modify);
8420 if (SvOBJECT(tmpRef)) {
8421 if (SvTYPE(tmpRef) != SVt_PVIO)
8423 SvREFCNT_dec(SvSTASH(tmpRef));
8426 SvOBJECT_on(tmpRef);
8427 if (SvTYPE(tmpRef) != SVt_PVIO)
8429 SvUPGRADE(tmpRef, SVt_PVMG);
8430 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8435 (void)SvAMAGIC_off(sv);
8437 if(SvSMAGICAL(tmpRef))
8438 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8446 /* Downgrades a PVGV to a PVMG.
8450 S_sv_unglob(pTHX_ SV *const sv)
8455 SV * const temp = sv_newmortal();
8457 PERL_ARGS_ASSERT_SV_UNGLOB;
8459 assert(SvTYPE(sv) == SVt_PVGV);
8461 gv_efullname3(temp, (GV *) sv, "*");
8464 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8465 mro_method_changed_in(stash);
8469 sv_del_backref((SV*)GvSTASH(sv), sv);
8473 if (GvNAME_HEK(sv)) {
8474 unshare_hek(GvNAME_HEK(sv));
8476 isGV_with_GP_off(sv);
8478 /* need to keep SvANY(sv) in the right arena */
8479 xpvmg = new_XPVMG();
8480 StructCopy(SvANY(sv), xpvmg, XPVMG);
8481 del_XPVGV(SvANY(sv));
8484 SvFLAGS(sv) &= ~SVTYPEMASK;
8485 SvFLAGS(sv) |= SVt_PVMG;
8487 /* Intentionally not calling any local SET magic, as this isn't so much a
8488 set operation as merely an internal storage change. */
8489 sv_setsv_flags(sv, temp, 0);
8493 =for apidoc sv_unref_flags
8495 Unsets the RV status of the SV, and decrements the reference count of
8496 whatever was being referenced by the RV. This can almost be thought of
8497 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8498 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8499 (otherwise the decrementing is conditional on the reference count being
8500 different from one or the reference being a readonly SV).
8507 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8509 SV* const target = SvRV(ref);
8511 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8513 if (SvWEAKREF(ref)) {
8514 sv_del_backref(target, ref);
8516 SvRV_set(ref, NULL);
8519 SvRV_set(ref, NULL);
8521 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8522 assigned to as BEGIN {$a = \"Foo"} will fail. */
8523 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8524 SvREFCNT_dec(target);
8525 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8526 sv_2mortal(target); /* Schedule for freeing later */
8530 =for apidoc sv_untaint
8532 Untaint an SV. Use C<SvTAINTED_off> instead.
8537 Perl_sv_untaint(pTHX_ SV *const sv)
8539 PERL_ARGS_ASSERT_SV_UNTAINT;
8541 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8542 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8549 =for apidoc sv_tainted
8551 Test an SV for taintedness. Use C<SvTAINTED> instead.
8556 Perl_sv_tainted(pTHX_ SV *const sv)
8558 PERL_ARGS_ASSERT_SV_TAINTED;
8560 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8561 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8562 if (mg && (mg->mg_len & 1) )
8569 =for apidoc sv_setpviv
8571 Copies an integer into the given SV, also updating its string value.
8572 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8578 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8580 char buf[TYPE_CHARS(UV)];
8582 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8584 PERL_ARGS_ASSERT_SV_SETPVIV;
8586 sv_setpvn(sv, ptr, ebuf - ptr);
8590 =for apidoc sv_setpviv_mg
8592 Like C<sv_setpviv>, but also handles 'set' magic.
8598 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8600 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8606 #if defined(PERL_IMPLICIT_CONTEXT)
8608 /* pTHX_ magic can't cope with varargs, so this is a no-context
8609 * version of the main function, (which may itself be aliased to us).
8610 * Don't access this version directly.
8614 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8619 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8621 va_start(args, pat);
8622 sv_vsetpvf(sv, pat, &args);
8626 /* pTHX_ magic can't cope with varargs, so this is a no-context
8627 * version of the main function, (which may itself be aliased to us).
8628 * Don't access this version directly.
8632 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8637 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8639 va_start(args, pat);
8640 sv_vsetpvf_mg(sv, pat, &args);
8646 =for apidoc sv_setpvf
8648 Works like C<sv_catpvf> but copies the text into the SV instead of
8649 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8655 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8659 PERL_ARGS_ASSERT_SV_SETPVF;
8661 va_start(args, pat);
8662 sv_vsetpvf(sv, pat, &args);
8667 =for apidoc sv_vsetpvf
8669 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8670 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8672 Usually used via its frontend C<sv_setpvf>.
8678 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8680 PERL_ARGS_ASSERT_SV_VSETPVF;
8682 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8686 =for apidoc sv_setpvf_mg
8688 Like C<sv_setpvf>, but also handles 'set' magic.
8694 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8698 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8700 va_start(args, pat);
8701 sv_vsetpvf_mg(sv, pat, &args);
8706 =for apidoc sv_vsetpvf_mg
8708 Like C<sv_vsetpvf>, but also handles 'set' magic.
8710 Usually used via its frontend C<sv_setpvf_mg>.
8716 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8718 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8720 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8724 #if defined(PERL_IMPLICIT_CONTEXT)
8726 /* pTHX_ magic can't cope with varargs, so this is a no-context
8727 * version of the main function, (which may itself be aliased to us).
8728 * Don't access this version directly.
8732 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8737 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8739 va_start(args, pat);
8740 sv_vcatpvf(sv, pat, &args);
8744 /* pTHX_ magic can't cope with varargs, so this is a no-context
8745 * version of the main function, (which may itself be aliased to us).
8746 * Don't access this version directly.
8750 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8755 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8757 va_start(args, pat);
8758 sv_vcatpvf_mg(sv, pat, &args);
8764 =for apidoc sv_catpvf
8766 Processes its arguments like C<sprintf> and appends the formatted
8767 output to an SV. If the appended data contains "wide" characters
8768 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8769 and characters >255 formatted with %c), the original SV might get
8770 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8771 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8772 valid UTF-8; if the original SV was bytes, the pattern should be too.
8777 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8781 PERL_ARGS_ASSERT_SV_CATPVF;
8783 va_start(args, pat);
8784 sv_vcatpvf(sv, pat, &args);
8789 =for apidoc sv_vcatpvf
8791 Processes its arguments like C<vsprintf> and appends the formatted output
8792 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8794 Usually used via its frontend C<sv_catpvf>.
8800 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8802 PERL_ARGS_ASSERT_SV_VCATPVF;
8804 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8808 =for apidoc sv_catpvf_mg
8810 Like C<sv_catpvf>, but also handles 'set' magic.
8816 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8820 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8822 va_start(args, pat);
8823 sv_vcatpvf_mg(sv, pat, &args);
8828 =for apidoc sv_vcatpvf_mg
8830 Like C<sv_vcatpvf>, but also handles 'set' magic.
8832 Usually used via its frontend C<sv_catpvf_mg>.
8838 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8840 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8842 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8847 =for apidoc sv_vsetpvfn
8849 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8852 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8858 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8859 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8861 PERL_ARGS_ASSERT_SV_VSETPVFN;
8863 sv_setpvn(sv, "", 0);
8864 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8868 S_expect_number(pTHX_ char **const pattern)
8873 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8875 switch (**pattern) {
8876 case '1': case '2': case '3':
8877 case '4': case '5': case '6':
8878 case '7': case '8': case '9':
8879 var = *(*pattern)++ - '0';
8880 while (isDIGIT(**pattern)) {
8881 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8883 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8891 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8893 const int neg = nv < 0;
8896 PERL_ARGS_ASSERT_F0CONVERT;
8904 if (uv & 1 && uv == nv)
8905 uv--; /* Round to even */
8907 const unsigned dig = uv % 10;
8920 =for apidoc sv_vcatpvfn
8922 Processes its arguments like C<vsprintf> and appends the formatted output
8923 to an SV. Uses an array of SVs if the C style variable argument list is
8924 missing (NULL). When running with taint checks enabled, indicates via
8925 C<maybe_tainted> if results are untrustworthy (often due to the use of
8928 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8934 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8935 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8936 vec_utf8 = DO_UTF8(vecsv);
8938 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8941 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8942 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8950 static const char nullstr[] = "(null)";
8952 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8953 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8955 /* Times 4: a decimal digit takes more than 3 binary digits.
8956 * NV_DIG: mantissa takes than many decimal digits.
8957 * Plus 32: Playing safe. */
8958 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8959 /* large enough for "%#.#f" --chip */
8960 /* what about long double NVs? --jhi */
8962 PERL_ARGS_ASSERT_SV_VCATPVFN;
8963 PERL_UNUSED_ARG(maybe_tainted);
8965 /* no matter what, this is a string now */
8966 (void)SvPV_force(sv, origlen);
8968 /* special-case "", "%s", and "%-p" (SVf - see below) */
8971 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8973 const char * const s = va_arg(*args, char*);
8974 sv_catpv(sv, s ? s : nullstr);
8976 else if (svix < svmax) {
8977 sv_catsv(sv, *svargs);
8981 if (args && patlen == 3 && pat[0] == '%' &&
8982 pat[1] == '-' && pat[2] == 'p') {
8983 argsv = (SV*)va_arg(*args, void*);
8984 sv_catsv(sv, argsv);
8988 #ifndef USE_LONG_DOUBLE
8989 /* special-case "%.<number>[gf]" */
8990 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8991 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8992 unsigned digits = 0;
8996 while (*pp >= '0' && *pp <= '9')
8997 digits = 10 * digits + (*pp++ - '0');
8998 if (pp - pat == (int)patlen - 1) {
9006 /* Add check for digits != 0 because it seems that some
9007 gconverts are buggy in this case, and we don't yet have
9008 a Configure test for this. */
9009 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9010 /* 0, point, slack */
9011 Gconvert(nv, (int)digits, 0, ebuf);
9013 if (*ebuf) /* May return an empty string for digits==0 */
9016 } else if (!digits) {
9019 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9020 sv_catpvn(sv, p, l);
9026 #endif /* !USE_LONG_DOUBLE */
9028 if (!args && svix < svmax && DO_UTF8(*svargs))
9031 patend = (char*)pat + patlen;
9032 for (p = (char*)pat; p < patend; p = q) {
9035 bool vectorize = FALSE;
9036 bool vectorarg = FALSE;
9037 bool vec_utf8 = FALSE;
9043 bool has_precis = FALSE;
9045 const I32 osvix = svix;
9046 bool is_utf8 = FALSE; /* is this item utf8? */
9047 #ifdef HAS_LDBL_SPRINTF_BUG
9048 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9049 with sfio - Allen <allens@cpan.org> */
9050 bool fix_ldbl_sprintf_bug = FALSE;
9054 U8 utf8buf[UTF8_MAXBYTES+1];
9055 STRLEN esignlen = 0;
9057 const char *eptr = NULL;
9060 const U8 *vecstr = NULL;
9067 /* we need a long double target in case HAS_LONG_DOUBLE but
9070 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9078 const char *dotstr = ".";
9079 STRLEN dotstrlen = 1;
9080 I32 efix = 0; /* explicit format parameter index */
9081 I32 ewix = 0; /* explicit width index */
9082 I32 epix = 0; /* explicit precision index */
9083 I32 evix = 0; /* explicit vector index */
9084 bool asterisk = FALSE;
9086 /* echo everything up to the next format specification */
9087 for (q = p; q < patend && *q != '%'; ++q) ;
9089 if (has_utf8 && !pat_utf8)
9090 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9092 sv_catpvn(sv, p, q - p);
9099 We allow format specification elements in this order:
9100 \d+\$ explicit format parameter index
9102 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9103 0 flag (as above): repeated to allow "v02"
9104 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9105 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9107 [%bcdefginopsuxDFOUX] format (mandatory)
9112 As of perl5.9.3, printf format checking is on by default.
9113 Internally, perl uses %p formats to provide an escape to
9114 some extended formatting. This block deals with those
9115 extensions: if it does not match, (char*)q is reset and
9116 the normal format processing code is used.
9118 Currently defined extensions are:
9119 %p include pointer address (standard)
9120 %-p (SVf) include an SV (previously %_)
9121 %-<num>p include an SV with precision <num>
9122 %<num>p reserved for future extensions
9124 Robin Barker 2005-07-14
9126 %1p (VDf) removed. RMB 2007-10-19
9133 n = expect_number(&q);
9140 argsv = (SV*)va_arg(*args, void*);
9141 eptr = SvPV_const(argsv, elen);
9147 if (ckWARN_d(WARN_INTERNAL))
9148 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9149 "internal %%<num>p might conflict with future printf extensions");
9155 if ( (width = expect_number(&q)) ) {
9170 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9199 if ( (ewix = expect_number(&q)) )
9208 if ((vectorarg = asterisk)) {
9221 width = expect_number(&q);
9227 vecsv = va_arg(*args, SV*);
9229 vecsv = (evix > 0 && evix <= svmax)
9230 ? svargs[evix-1] : &PL_sv_undef;
9232 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9234 dotstr = SvPV_const(vecsv, dotstrlen);
9235 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9236 bad with tied or overloaded values that return UTF8. */
9239 else if (has_utf8) {
9240 vecsv = sv_mortalcopy(vecsv);
9241 sv_utf8_upgrade(vecsv);
9242 dotstr = SvPV_const(vecsv, dotstrlen);
9249 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9250 vecsv = svargs[efix ? efix-1 : svix++];
9251 vecstr = (U8*)SvPV_const(vecsv,veclen);
9252 vec_utf8 = DO_UTF8(vecsv);
9254 /* if this is a version object, we need to convert
9255 * back into v-string notation and then let the
9256 * vectorize happen normally
9258 if (sv_derived_from(vecsv, "version")) {
9259 char *version = savesvpv(vecsv);
9260 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9261 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9262 "vector argument not supported with alpha versions");
9265 vecsv = sv_newmortal();
9266 scan_vstring(version, version + veclen, vecsv);
9267 vecstr = (U8*)SvPV_const(vecsv, veclen);
9268 vec_utf8 = DO_UTF8(vecsv);
9280 i = va_arg(*args, int);
9282 i = (ewix ? ewix <= svmax : svix < svmax) ?
9283 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9285 width = (i < 0) ? -i : i;
9295 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9297 /* XXX: todo, support specified precision parameter */
9301 i = va_arg(*args, int);
9303 i = (ewix ? ewix <= svmax : svix < svmax)
9304 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9306 has_precis = !(i < 0);
9311 precis = precis * 10 + (*q++ - '0');
9320 case 'I': /* Ix, I32x, and I64x */
9322 if (q[1] == '6' && q[2] == '4') {
9328 if (q[1] == '3' && q[2] == '2') {
9338 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9349 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9350 if (*(q + 1) == 'l') { /* lld, llf */
9376 if (!vectorize && !args) {
9378 const I32 i = efix-1;
9379 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9381 argsv = (svix >= 0 && svix < svmax)
9382 ? svargs[svix++] : &PL_sv_undef;
9393 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9395 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9397 eptr = (char*)utf8buf;
9398 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9412 eptr = va_arg(*args, char*);
9414 #ifdef MACOS_TRADITIONAL
9415 /* On MacOS, %#s format is used for Pascal strings */
9420 elen = strlen(eptr);
9422 eptr = (char *)nullstr;
9423 elen = sizeof nullstr - 1;
9427 eptr = SvPV_const(argsv, elen);
9428 if (DO_UTF8(argsv)) {
9429 I32 old_precis = precis;
9430 if (has_precis && precis < elen) {
9432 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9435 if (width) { /* fudge width (can't fudge elen) */
9436 if (has_precis && precis < elen)
9437 width += precis - old_precis;
9439 width += elen - sv_len_utf8(argsv);
9446 if (has_precis && elen > precis)
9453 if (alt || vectorize)
9455 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9476 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9485 esignbuf[esignlen++] = plus;
9489 case 'h': iv = (short)va_arg(*args, int); break;
9490 case 'l': iv = va_arg(*args, long); break;
9491 case 'V': iv = va_arg(*args, IV); break;
9492 default: iv = va_arg(*args, int); break;
9494 case 'q': iv = va_arg(*args, Quad_t); break;
9499 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9501 case 'h': iv = (short)tiv; break;
9502 case 'l': iv = (long)tiv; break;
9504 default: iv = tiv; break;
9506 case 'q': iv = (Quad_t)tiv; break;
9510 if ( !vectorize ) /* we already set uv above */
9515 esignbuf[esignlen++] = plus;
9519 esignbuf[esignlen++] = '-';
9563 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9574 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9575 case 'l': uv = va_arg(*args, unsigned long); break;
9576 case 'V': uv = va_arg(*args, UV); break;
9577 default: uv = va_arg(*args, unsigned); break;
9579 case 'q': uv = va_arg(*args, Uquad_t); break;
9584 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9586 case 'h': uv = (unsigned short)tuv; break;
9587 case 'l': uv = (unsigned long)tuv; break;
9589 default: uv = tuv; break;
9591 case 'q': uv = (Uquad_t)tuv; break;
9598 char *ptr = ebuf + sizeof ebuf;
9599 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9605 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9611 esignbuf[esignlen++] = '0';
9612 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9620 if (alt && *ptr != '0')
9629 esignbuf[esignlen++] = '0';
9630 esignbuf[esignlen++] = c;
9633 default: /* it had better be ten or less */
9637 } while (uv /= base);
9640 elen = (ebuf + sizeof ebuf) - ptr;
9644 zeros = precis - elen;
9645 else if (precis == 0 && elen == 1 && *eptr == '0'
9646 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9649 /* a precision nullifies the 0 flag. */
9656 /* FLOATING POINT */
9659 c = 'f'; /* maybe %F isn't supported here */
9667 /* This is evil, but floating point is even more evil */
9669 /* for SV-style calling, we can only get NV
9670 for C-style calling, we assume %f is double;
9671 for simplicity we allow any of %Lf, %llf, %qf for long double
9675 #if defined(USE_LONG_DOUBLE)
9679 /* [perl #20339] - we should accept and ignore %lf rather than die */
9683 #if defined(USE_LONG_DOUBLE)
9684 intsize = args ? 0 : 'q';
9688 #if defined(HAS_LONG_DOUBLE)
9697 /* now we need (long double) if intsize == 'q', else (double) */
9699 #if LONG_DOUBLESIZE > DOUBLESIZE
9701 va_arg(*args, long double) :
9702 va_arg(*args, double)
9704 va_arg(*args, double)
9709 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9710 else. frexp() has some unspecified behaviour for those three */
9711 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9713 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9714 will cast our (long double) to (double) */
9715 (void)Perl_frexp(nv, &i);
9716 if (i == PERL_INT_MIN)
9717 Perl_die(aTHX_ "panic: frexp");
9719 need = BIT_DIGITS(i);
9721 need += has_precis ? precis : 6; /* known default */
9726 #ifdef HAS_LDBL_SPRINTF_BUG
9727 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9728 with sfio - Allen <allens@cpan.org> */
9731 # define MY_DBL_MAX DBL_MAX
9732 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9733 # if DOUBLESIZE >= 8
9734 # define MY_DBL_MAX 1.7976931348623157E+308L
9736 # define MY_DBL_MAX 3.40282347E+38L
9740 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9741 # define MY_DBL_MAX_BUG 1L
9743 # define MY_DBL_MAX_BUG MY_DBL_MAX
9747 # define MY_DBL_MIN DBL_MIN
9748 # else /* XXX guessing! -Allen */
9749 # if DOUBLESIZE >= 8
9750 # define MY_DBL_MIN 2.2250738585072014E-308L
9752 # define MY_DBL_MIN 1.17549435E-38L
9756 if ((intsize == 'q') && (c == 'f') &&
9757 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9759 /* it's going to be short enough that
9760 * long double precision is not needed */
9762 if ((nv <= 0L) && (nv >= -0L))
9763 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9765 /* would use Perl_fp_class as a double-check but not
9766 * functional on IRIX - see perl.h comments */
9768 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9769 /* It's within the range that a double can represent */
9770 #if defined(DBL_MAX) && !defined(DBL_MIN)
9771 if ((nv >= ((long double)1/DBL_MAX)) ||
9772 (nv <= (-(long double)1/DBL_MAX)))
9774 fix_ldbl_sprintf_bug = TRUE;
9777 if (fix_ldbl_sprintf_bug == TRUE) {
9787 # undef MY_DBL_MAX_BUG
9790 #endif /* HAS_LDBL_SPRINTF_BUG */
9792 need += 20; /* fudge factor */
9793 if (PL_efloatsize < need) {
9794 Safefree(PL_efloatbuf);
9795 PL_efloatsize = need + 20; /* more fudge */
9796 Newx(PL_efloatbuf, PL_efloatsize, char);
9797 PL_efloatbuf[0] = '\0';
9800 if ( !(width || left || plus || alt) && fill != '0'
9801 && has_precis && intsize != 'q' ) { /* Shortcuts */
9802 /* See earlier comment about buggy Gconvert when digits,
9804 if ( c == 'g' && precis) {
9805 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9806 /* May return an empty string for digits==0 */
9807 if (*PL_efloatbuf) {
9808 elen = strlen(PL_efloatbuf);
9809 goto float_converted;
9811 } else if ( c == 'f' && !precis) {
9812 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9817 char *ptr = ebuf + sizeof ebuf;
9820 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9821 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9822 if (intsize == 'q') {
9823 /* Copy the one or more characters in a long double
9824 * format before the 'base' ([efgEFG]) character to
9825 * the format string. */
9826 static char const prifldbl[] = PERL_PRIfldbl;
9827 char const *p = prifldbl + sizeof(prifldbl) - 3;
9828 while (p >= prifldbl) { *--ptr = *p--; }
9833 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9838 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9850 /* No taint. Otherwise we are in the strange situation
9851 * where printf() taints but print($float) doesn't.
9853 #if defined(HAS_LONG_DOUBLE)
9854 elen = ((intsize == 'q')
9855 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9856 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9858 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9862 eptr = PL_efloatbuf;
9870 i = SvCUR(sv) - origlen;
9873 case 'h': *(va_arg(*args, short*)) = i; break;
9874 default: *(va_arg(*args, int*)) = i; break;
9875 case 'l': *(va_arg(*args, long*)) = i; break;
9876 case 'V': *(va_arg(*args, IV*)) = i; break;
9878 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9883 sv_setuv_mg(argsv, (UV)i);
9884 continue; /* not "break" */
9891 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9892 && ckWARN(WARN_PRINTF))
9894 SV * const msg = sv_newmortal();
9895 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9896 (PL_op->op_type == OP_PRTF) ? "" : "s");
9899 Perl_sv_catpvf(aTHX_ msg,
9900 "\"%%%c\"", c & 0xFF);
9902 Perl_sv_catpvf(aTHX_ msg,
9903 "\"%%\\%03"UVof"\"",
9906 sv_catpvs(msg, "end of string");
9907 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9910 /* output mangled stuff ... */
9916 /* ... right here, because formatting flags should not apply */
9917 SvGROW(sv, SvCUR(sv) + elen + 1);
9919 Copy(eptr, p, elen, char);
9922 SvCUR_set(sv, p - SvPVX_const(sv));
9924 continue; /* not "break" */
9927 if (is_utf8 != has_utf8) {
9930 sv_utf8_upgrade(sv);
9933 const STRLEN old_elen = elen;
9934 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9935 sv_utf8_upgrade(nsv);
9936 eptr = SvPVX_const(nsv);
9939 if (width) { /* fudge width (can't fudge elen) */
9940 width += elen - old_elen;
9946 have = esignlen + zeros + elen;
9948 Perl_croak_nocontext(PL_memory_wrap);
9950 need = (have > width ? have : width);
9953 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9954 Perl_croak_nocontext(PL_memory_wrap);
9955 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9957 if (esignlen && fill == '0') {
9959 for (i = 0; i < (int)esignlen; i++)
9963 memset(p, fill, gap);
9966 if (esignlen && fill != '0') {
9968 for (i = 0; i < (int)esignlen; i++)
9973 for (i = zeros; i; i--)
9977 Copy(eptr, p, elen, char);
9981 memset(p, ' ', gap);
9986 Copy(dotstr, p, dotstrlen, char);
9990 vectorize = FALSE; /* done iterating over vecstr */
9997 SvCUR_set(sv, p - SvPVX_const(sv));
10005 /* =========================================================================
10007 =head1 Cloning an interpreter
10009 All the macros and functions in this section are for the private use of
10010 the main function, perl_clone().
10012 The foo_dup() functions make an exact copy of an existing foo thingy.
10013 During the course of a cloning, a hash table is used to map old addresses
10014 to new addresses. The table is created and manipulated with the
10015 ptr_table_* functions.
10019 ============================================================================*/
10022 #if defined(USE_ITHREADS)
10024 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10025 #ifndef GpREFCNT_inc
10026 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10030 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10031 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10032 If this changes, please unmerge ss_dup. */
10033 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10034 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10035 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10036 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10037 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10038 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10039 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10040 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10041 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10042 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10043 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10044 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10045 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10046 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10048 /* clone a parser */
10051 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10055 PERL_ARGS_ASSERT_PARSER_DUP;
10060 /* look for it in the table first */
10061 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10065 /* create anew and remember what it is */
10066 Newxz(parser, 1, yy_parser);
10067 ptr_table_store(PL_ptr_table, proto, parser);
10069 parser->yyerrstatus = 0;
10070 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10072 /* XXX these not yet duped */
10073 parser->old_parser = NULL;
10074 parser->stack = NULL;
10076 parser->stack_size = 0;
10077 /* XXX parser->stack->state = 0; */
10079 /* XXX eventually, just Copy() most of the parser struct ? */
10081 parser->lex_brackets = proto->lex_brackets;
10082 parser->lex_casemods = proto->lex_casemods;
10083 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10084 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10085 parser->lex_casestack = savepvn(proto->lex_casestack,
10086 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10087 parser->lex_defer = proto->lex_defer;
10088 parser->lex_dojoin = proto->lex_dojoin;
10089 parser->lex_expect = proto->lex_expect;
10090 parser->lex_formbrack = proto->lex_formbrack;
10091 parser->lex_inpat = proto->lex_inpat;
10092 parser->lex_inwhat = proto->lex_inwhat;
10093 parser->lex_op = proto->lex_op;
10094 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10095 parser->lex_starts = proto->lex_starts;
10096 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10097 parser->multi_close = proto->multi_close;
10098 parser->multi_open = proto->multi_open;
10099 parser->multi_start = proto->multi_start;
10100 parser->multi_end = proto->multi_end;
10101 parser->pending_ident = proto->pending_ident;
10102 parser->preambled = proto->preambled;
10103 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10104 parser->linestr = sv_dup_inc(proto->linestr, param);
10105 parser->expect = proto->expect;
10106 parser->copline = proto->copline;
10107 parser->last_lop_op = proto->last_lop_op;
10108 parser->lex_state = proto->lex_state;
10109 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10110 /* rsfp_filters entries have fake IoDIRP() */
10111 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10112 parser->in_my = proto->in_my;
10113 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10114 parser->error_count = proto->error_count;
10117 parser->linestr = sv_dup_inc(proto->linestr, param);
10120 char * const ols = SvPVX(proto->linestr);
10121 char * const ls = SvPVX(parser->linestr);
10123 parser->bufptr = ls + (proto->bufptr >= ols ?
10124 proto->bufptr - ols : 0);
10125 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10126 proto->oldbufptr - ols : 0);
10127 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10128 proto->oldoldbufptr - ols : 0);
10129 parser->linestart = ls + (proto->linestart >= ols ?
10130 proto->linestart - ols : 0);
10131 parser->last_uni = ls + (proto->last_uni >= ols ?
10132 proto->last_uni - ols : 0);
10133 parser->last_lop = ls + (proto->last_lop >= ols ?
10134 proto->last_lop - ols : 0);
10136 parser->bufend = ls + SvCUR(parser->linestr);
10139 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10143 parser->endwhite = proto->endwhite;
10144 parser->faketokens = proto->faketokens;
10145 parser->lasttoke = proto->lasttoke;
10146 parser->nextwhite = proto->nextwhite;
10147 parser->realtokenstart = proto->realtokenstart;
10148 parser->skipwhite = proto->skipwhite;
10149 parser->thisclose = proto->thisclose;
10150 parser->thismad = proto->thismad;
10151 parser->thisopen = proto->thisopen;
10152 parser->thisstuff = proto->thisstuff;
10153 parser->thistoken = proto->thistoken;
10154 parser->thiswhite = proto->thiswhite;
10156 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10157 parser->curforce = proto->curforce;
10159 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10160 Copy(proto->nexttype, parser->nexttype, 5, I32);
10161 parser->nexttoke = proto->nexttoke;
10167 /* duplicate a file handle */
10170 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10174 PERL_ARGS_ASSERT_FP_DUP;
10175 PERL_UNUSED_ARG(type);
10178 return (PerlIO*)NULL;
10180 /* look for it in the table first */
10181 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10185 /* create anew and remember what it is */
10186 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10187 ptr_table_store(PL_ptr_table, fp, ret);
10191 /* duplicate a directory handle */
10194 Perl_dirp_dup(pTHX_ DIR *const dp)
10196 PERL_UNUSED_CONTEXT;
10203 /* duplicate a typeglob */
10206 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10210 PERL_ARGS_ASSERT_GP_DUP;
10214 /* look for it in the table first */
10215 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10219 /* create anew and remember what it is */
10221 ptr_table_store(PL_ptr_table, gp, ret);
10224 ret->gp_refcnt = 0; /* must be before any other dups! */
10225 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10226 ret->gp_io = io_dup_inc(gp->gp_io, param);
10227 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10228 ret->gp_av = av_dup_inc(gp->gp_av, param);
10229 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10230 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10231 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10232 ret->gp_cvgen = gp->gp_cvgen;
10233 ret->gp_line = gp->gp_line;
10234 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10238 /* duplicate a chain of magic */
10241 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10243 MAGIC *mgprev = (MAGIC*)NULL;
10246 PERL_ARGS_ASSERT_MG_DUP;
10249 return (MAGIC*)NULL;
10250 /* look for it in the table first */
10251 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10255 for (; mg; mg = mg->mg_moremagic) {
10257 Newxz(nmg, 1, MAGIC);
10259 mgprev->mg_moremagic = nmg;
10262 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10263 nmg->mg_private = mg->mg_private;
10264 nmg->mg_type = mg->mg_type;
10265 nmg->mg_flags = mg->mg_flags;
10266 /* FIXME for plugins
10267 if (mg->mg_type == PERL_MAGIC_qr) {
10268 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10272 if(mg->mg_type == PERL_MAGIC_backref) {
10273 /* The backref AV has its reference count deliberately bumped by
10275 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10278 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10279 ? sv_dup_inc(mg->mg_obj, param)
10280 : sv_dup(mg->mg_obj, param);
10282 nmg->mg_len = mg->mg_len;
10283 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10284 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10285 if (mg->mg_len > 0) {
10286 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10287 if (mg->mg_type == PERL_MAGIC_overload_table &&
10288 AMT_AMAGIC((AMT*)mg->mg_ptr))
10290 const AMT * const amtp = (AMT*)mg->mg_ptr;
10291 AMT * const namtp = (AMT*)nmg->mg_ptr;
10293 for (i = 1; i < NofAMmeth; i++) {
10294 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10298 else if (mg->mg_len == HEf_SVKEY)
10299 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10301 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10302 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10309 #endif /* USE_ITHREADS */
10311 /* create a new pointer-mapping table */
10314 Perl_ptr_table_new(pTHX)
10317 PERL_UNUSED_CONTEXT;
10319 Newxz(tbl, 1, PTR_TBL_t);
10320 tbl->tbl_max = 511;
10321 tbl->tbl_items = 0;
10322 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10326 #define PTR_TABLE_HASH(ptr) \
10327 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10330 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10331 following define) and at call to new_body_inline made below in
10332 Perl_ptr_table_store()
10335 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10337 /* map an existing pointer using a table */
10339 STATIC PTR_TBL_ENT_t *
10340 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10342 PTR_TBL_ENT_t *tblent;
10343 const UV hash = PTR_TABLE_HASH(sv);
10345 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10347 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10348 for (; tblent; tblent = tblent->next) {
10349 if (tblent->oldval == sv)
10356 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10358 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10360 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10361 PERL_UNUSED_CONTEXT;
10363 return tblent ? tblent->newval : NULL;
10366 /* add a new entry to a pointer-mapping table */
10369 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10371 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10373 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10374 PERL_UNUSED_CONTEXT;
10377 tblent->newval = newsv;
10379 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10381 new_body_inline(tblent, PTE_SVSLOT);
10383 tblent->oldval = oldsv;
10384 tblent->newval = newsv;
10385 tblent->next = tbl->tbl_ary[entry];
10386 tbl->tbl_ary[entry] = tblent;
10388 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10389 ptr_table_split(tbl);
10393 /* double the hash bucket size of an existing ptr table */
10396 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10398 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10399 const UV oldsize = tbl->tbl_max + 1;
10400 UV newsize = oldsize * 2;
10403 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10404 PERL_UNUSED_CONTEXT;
10406 Renew(ary, newsize, PTR_TBL_ENT_t*);
10407 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10408 tbl->tbl_max = --newsize;
10409 tbl->tbl_ary = ary;
10410 for (i=0; i < oldsize; i++, ary++) {
10411 PTR_TBL_ENT_t **curentp, **entp, *ent;
10414 curentp = ary + oldsize;
10415 for (entp = ary, ent = *ary; ent; ent = *entp) {
10416 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10418 ent->next = *curentp;
10428 /* remove all the entries from a ptr table */
10431 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10433 if (tbl && tbl->tbl_items) {
10434 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10435 UV riter = tbl->tbl_max;
10438 PTR_TBL_ENT_t *entry = array[riter];
10441 PTR_TBL_ENT_t * const oentry = entry;
10442 entry = entry->next;
10447 tbl->tbl_items = 0;
10451 /* clear and free a ptr table */
10454 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10459 ptr_table_clear(tbl);
10460 Safefree(tbl->tbl_ary);
10464 #if defined(USE_ITHREADS)
10467 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10469 PERL_ARGS_ASSERT_RVPV_DUP;
10472 SvRV_set(dstr, SvWEAKREF(sstr)
10473 ? sv_dup(SvRV(sstr), param)
10474 : sv_dup_inc(SvRV(sstr), param));
10477 else if (SvPVX_const(sstr)) {
10478 /* Has something there */
10480 /* Normal PV - clone whole allocated space */
10481 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10482 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10483 /* Not that normal - actually sstr is copy on write.
10484 But we are a true, independant SV, so: */
10485 SvREADONLY_off(dstr);
10490 /* Special case - not normally malloced for some reason */
10491 if (isGV_with_GP(sstr)) {
10492 /* Don't need to do anything here. */
10494 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10495 /* A "shared" PV - clone it as "shared" PV */
10497 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10501 /* Some other special case - random pointer */
10502 SvPV_set(dstr, SvPVX(sstr));
10507 /* Copy the NULL */
10508 SvPV_set(dstr, NULL);
10512 /* duplicate an SV of any type (including AV, HV etc) */
10515 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10520 PERL_ARGS_ASSERT_SV_DUP;
10524 if (SvTYPE(sstr) == SVTYPEMASK) {
10525 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10530 /* look for it in the table first */
10531 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10535 if(param->flags & CLONEf_JOIN_IN) {
10536 /** We are joining here so we don't want do clone
10537 something that is bad **/
10538 if (SvTYPE(sstr) == SVt_PVHV) {
10539 const HEK * const hvname = HvNAME_HEK(sstr);
10541 /** don't clone stashes if they already exist **/
10542 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10546 /* create anew and remember what it is */
10549 #ifdef DEBUG_LEAKING_SCALARS
10550 dstr->sv_debug_optype = sstr->sv_debug_optype;
10551 dstr->sv_debug_line = sstr->sv_debug_line;
10552 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10553 dstr->sv_debug_cloned = 1;
10554 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10557 ptr_table_store(PL_ptr_table, sstr, dstr);
10560 SvFLAGS(dstr) = SvFLAGS(sstr);
10561 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10562 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10565 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10566 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10567 (void*)PL_watch_pvx, SvPVX_const(sstr));
10570 /* don't clone objects whose class has asked us not to */
10571 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10576 switch (SvTYPE(sstr)) {
10578 SvANY(dstr) = NULL;
10581 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10583 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10585 SvIV_set(dstr, SvIVX(sstr));
10589 SvANY(dstr) = new_XNV();
10590 SvNV_set(dstr, SvNVX(sstr));
10592 /* case SVt_BIND: */
10595 /* These are all the types that need complex bodies allocating. */
10597 const svtype sv_type = SvTYPE(sstr);
10598 const struct body_details *const sv_type_details
10599 = bodies_by_type + sv_type;
10603 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10607 if (GvUNIQUE((GV*)sstr)) {
10608 NOOP; /* Do sharing here, and fall through */
10621 assert(sv_type_details->body_size);
10622 if (sv_type_details->arena) {
10623 new_body_inline(new_body, sv_type);
10625 = (void*)((char*)new_body - sv_type_details->offset);
10627 new_body = new_NOARENA(sv_type_details);
10631 SvANY(dstr) = new_body;
10634 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10635 ((char*)SvANY(dstr)) + sv_type_details->offset,
10636 sv_type_details->copy, char);
10638 Copy(((char*)SvANY(sstr)),
10639 ((char*)SvANY(dstr)),
10640 sv_type_details->body_size + sv_type_details->offset, char);
10643 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10644 && !isGV_with_GP(dstr))
10645 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10647 /* The Copy above means that all the source (unduplicated) pointers
10648 are now in the destination. We can check the flags and the
10649 pointers in either, but it's possible that there's less cache
10650 missing by always going for the destination.
10651 FIXME - instrument and check that assumption */
10652 if (sv_type >= SVt_PVMG) {
10653 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10654 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10655 } else if (SvMAGIC(dstr))
10656 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10658 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10661 /* The cast silences a GCC warning about unhandled types. */
10662 switch ((int)sv_type) {
10672 /* FIXME for plugins */
10673 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10676 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10677 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10678 LvTARG(dstr) = dstr;
10679 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10680 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10682 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10684 if(isGV_with_GP(sstr)) {
10685 if (GvNAME_HEK(dstr))
10686 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10687 /* Don't call sv_add_backref here as it's going to be
10688 created as part of the magic cloning of the symbol
10690 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10691 at the point of this comment. */
10692 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10693 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10694 (void)GpREFCNT_inc(GvGP(dstr));
10696 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10699 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10700 if (IoOFP(dstr) == IoIFP(sstr))
10701 IoOFP(dstr) = IoIFP(dstr);
10703 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10704 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10705 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10706 /* I have no idea why fake dirp (rsfps)
10707 should be treated differently but otherwise
10708 we end up with leaks -- sky*/
10709 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10710 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10711 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10713 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10714 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10715 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10716 if (IoDIRP(dstr)) {
10717 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10720 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10723 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10724 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10725 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10728 if (AvARRAY((AV*)sstr)) {
10729 SV **dst_ary, **src_ary;
10730 SSize_t items = AvFILLp((AV*)sstr) + 1;
10732 src_ary = AvARRAY((AV*)sstr);
10733 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10734 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10735 AvARRAY((AV*)dstr) = dst_ary;
10736 AvALLOC((AV*)dstr) = dst_ary;
10737 if (AvREAL((AV*)sstr)) {
10738 while (items-- > 0)
10739 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10742 while (items-- > 0)
10743 *dst_ary++ = sv_dup(*src_ary++, param);
10745 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10746 while (items-- > 0) {
10747 *dst_ary++ = &PL_sv_undef;
10751 AvARRAY((AV*)dstr) = NULL;
10752 AvALLOC((AV*)dstr) = (SV**)NULL;
10756 if (HvARRAY((HV*)sstr)) {
10758 const bool sharekeys = !!HvSHAREKEYS(sstr);
10759 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10760 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10762 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10763 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10765 HvARRAY(dstr) = (HE**)darray;
10766 while (i <= sxhv->xhv_max) {
10767 const HE * const source = HvARRAY(sstr)[i];
10768 HvARRAY(dstr)[i] = source
10769 ? he_dup(source, sharekeys, param) : 0;
10774 const struct xpvhv_aux * const saux = HvAUX(sstr);
10775 struct xpvhv_aux * const daux = HvAUX(dstr);
10776 /* This flag isn't copied. */
10777 /* SvOOK_on(hv) attacks the IV flags. */
10778 SvFLAGS(dstr) |= SVf_OOK;
10780 hvname = saux->xhv_name;
10781 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10783 daux->xhv_riter = saux->xhv_riter;
10784 daux->xhv_eiter = saux->xhv_eiter
10785 ? he_dup(saux->xhv_eiter,
10786 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10787 /* backref array needs refcnt=2; see sv_add_backref */
10788 daux->xhv_backreferences =
10789 saux->xhv_backreferences
10790 ? (AV*) SvREFCNT_inc(
10791 sv_dup_inc((SV*)saux->xhv_backreferences, param))
10794 daux->xhv_mro_meta = saux->xhv_mro_meta
10795 ? mro_meta_dup(saux->xhv_mro_meta, param)
10798 /* Record stashes for possible cloning in Perl_clone(). */
10800 av_push(param->stashes, dstr);
10804 HvARRAY((HV*)dstr) = NULL;
10807 if (!(param->flags & CLONEf_COPY_STACKS)) {
10811 /* NOTE: not refcounted */
10812 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10814 if (!CvISXSUB(dstr))
10815 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10817 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10818 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10819 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10820 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10822 /* don't dup if copying back - CvGV isn't refcounted, so the
10823 * duped GV may never be freed. A bit of a hack! DAPM */
10824 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10825 NULL : gv_dup(CvGV(dstr), param) ;
10826 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10828 CvWEAKOUTSIDE(sstr)
10829 ? cv_dup( CvOUTSIDE(dstr), param)
10830 : cv_dup_inc(CvOUTSIDE(dstr), param);
10831 if (!CvISXSUB(dstr))
10832 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10838 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10844 /* duplicate a context */
10847 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10849 PERL_CONTEXT *ncxs;
10851 PERL_ARGS_ASSERT_CX_DUP;
10854 return (PERL_CONTEXT*)NULL;
10856 /* look for it in the table first */
10857 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10861 /* create anew and remember what it is */
10862 Newx(ncxs, max + 1, PERL_CONTEXT);
10863 ptr_table_store(PL_ptr_table, cxs, ncxs);
10864 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10867 PERL_CONTEXT * const ncx = &ncxs[ix];
10868 if (CxTYPE(ncx) == CXt_SUBST) {
10869 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10872 switch (CxTYPE(ncx)) {
10874 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10875 ? cv_dup_inc(ncx->blk_sub.cv, param)
10876 : cv_dup(ncx->blk_sub.cv,param));
10877 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10878 ? av_dup_inc(ncx->blk_sub.argarray,
10881 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10883 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10884 ncx->blk_sub.oldcomppad);
10887 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10889 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10891 case CXt_LOOP_LAZYSV:
10892 ncx->blk_loop.state_u.lazysv.end
10893 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10894 /* We are taking advantage of av_dup_inc and sv_dup_inc
10895 actually being the same function, and order equivalance of
10897 We can assert the later [but only at run time :-(] */
10898 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10899 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10901 ncx->blk_loop.state_u.ary.ary
10902 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10903 case CXt_LOOP_LAZYIV:
10904 case CXt_LOOP_PLAIN:
10905 if (CxPADLOOP(ncx)) {
10906 ncx->blk_loop.oldcomppad
10907 = (PAD*)ptr_table_fetch(PL_ptr_table,
10908 ncx->blk_loop.oldcomppad);
10910 ncx->blk_loop.oldcomppad
10911 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10915 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10916 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10917 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10930 /* duplicate a stack info structure */
10933 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10937 PERL_ARGS_ASSERT_SI_DUP;
10940 return (PERL_SI*)NULL;
10942 /* look for it in the table first */
10943 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10947 /* create anew and remember what it is */
10948 Newxz(nsi, 1, PERL_SI);
10949 ptr_table_store(PL_ptr_table, si, nsi);
10951 nsi->si_stack = av_dup_inc(si->si_stack, param);
10952 nsi->si_cxix = si->si_cxix;
10953 nsi->si_cxmax = si->si_cxmax;
10954 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10955 nsi->si_type = si->si_type;
10956 nsi->si_prev = si_dup(si->si_prev, param);
10957 nsi->si_next = si_dup(si->si_next, param);
10958 nsi->si_markoff = si->si_markoff;
10963 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10964 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10965 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10966 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10967 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10968 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10969 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10970 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10971 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10972 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10973 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10974 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10975 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10976 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10979 #define pv_dup_inc(p) SAVEPV(p)
10980 #define pv_dup(p) SAVEPV(p)
10981 #define svp_dup_inc(p,pp) any_dup(p,pp)
10983 /* map any object to the new equivent - either something in the
10984 * ptr table, or something in the interpreter structure
10988 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10992 PERL_ARGS_ASSERT_ANY_DUP;
10995 return (void*)NULL;
10997 /* look for it in the table first */
10998 ret = ptr_table_fetch(PL_ptr_table, v);
11002 /* see if it is part of the interpreter structure */
11003 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11004 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11012 /* duplicate the save stack */
11015 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11018 ANY * const ss = proto_perl->Isavestack;
11019 const I32 max = proto_perl->Isavestack_max;
11020 I32 ix = proto_perl->Isavestack_ix;
11033 void (*dptr) (void*);
11034 void (*dxptr) (pTHX_ void*);
11036 PERL_ARGS_ASSERT_SS_DUP;
11038 Newxz(nss, max, ANY);
11041 const I32 type = POPINT(ss,ix);
11042 TOPINT(nss,ix) = type;
11044 case SAVEt_HELEM: /* hash element */
11045 sv = (SV*)POPPTR(ss,ix);
11046 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11048 case SAVEt_ITEM: /* normal string */
11049 case SAVEt_SV: /* scalar reference */
11050 sv = (SV*)POPPTR(ss,ix);
11051 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11054 case SAVEt_MORTALIZESV:
11055 sv = (SV*)POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11058 case SAVEt_SHARED_PVREF: /* char* in shared space */
11059 c = (char*)POPPTR(ss,ix);
11060 TOPPTR(nss,ix) = savesharedpv(c);
11061 ptr = POPPTR(ss,ix);
11062 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11064 case SAVEt_GENERIC_SVREF: /* generic sv */
11065 case SAVEt_SVREF: /* scalar reference */
11066 sv = (SV*)POPPTR(ss,ix);
11067 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11068 ptr = POPPTR(ss,ix);
11069 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11071 case SAVEt_HV: /* hash reference */
11072 case SAVEt_AV: /* array reference */
11073 sv = (SV*) POPPTR(ss,ix);
11074 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11076 case SAVEt_COMPPAD:
11078 sv = (SV*) POPPTR(ss,ix);
11079 TOPPTR(nss,ix) = sv_dup(sv, param);
11081 case SAVEt_INT: /* int reference */
11082 ptr = POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11084 intval = (int)POPINT(ss,ix);
11085 TOPINT(nss,ix) = intval;
11087 case SAVEt_LONG: /* long reference */
11088 ptr = POPPTR(ss,ix);
11089 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11091 case SAVEt_CLEARSV:
11092 longval = (long)POPLONG(ss,ix);
11093 TOPLONG(nss,ix) = longval;
11095 case SAVEt_I32: /* I32 reference */
11096 case SAVEt_I16: /* I16 reference */
11097 case SAVEt_I8: /* I8 reference */
11098 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11099 ptr = POPPTR(ss,ix);
11100 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11102 TOPINT(nss,ix) = i;
11104 case SAVEt_IV: /* IV reference */
11105 ptr = POPPTR(ss,ix);
11106 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11108 TOPIV(nss,ix) = iv;
11110 case SAVEt_HPTR: /* HV* reference */
11111 case SAVEt_APTR: /* AV* reference */
11112 case SAVEt_SPTR: /* SV* reference */
11113 ptr = POPPTR(ss,ix);
11114 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11115 sv = (SV*)POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = sv_dup(sv, param);
11118 case SAVEt_VPTR: /* random* reference */
11119 ptr = POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11121 ptr = POPPTR(ss,ix);
11122 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11124 case SAVEt_GENERIC_PVREF: /* generic char* */
11125 case SAVEt_PPTR: /* char* reference */
11126 ptr = POPPTR(ss,ix);
11127 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11128 c = (char*)POPPTR(ss,ix);
11129 TOPPTR(nss,ix) = pv_dup(c);
11131 case SAVEt_GP: /* scalar reference */
11132 gp = (GP*)POPPTR(ss,ix);
11133 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11134 (void)GpREFCNT_inc(gp);
11135 gv = (GV*)POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11139 ptr = POPPTR(ss,ix);
11140 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11141 /* these are assumed to be refcounted properly */
11143 switch (((OP*)ptr)->op_type) {
11145 case OP_LEAVESUBLV:
11149 case OP_LEAVEWRITE:
11150 TOPPTR(nss,ix) = ptr;
11153 (void) OpREFCNT_inc(o);
11157 TOPPTR(nss,ix) = NULL;
11162 TOPPTR(nss,ix) = NULL;
11165 c = (char*)POPPTR(ss,ix);
11166 TOPPTR(nss,ix) = pv_dup_inc(c);
11169 hv = (HV*)POPPTR(ss,ix);
11170 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11171 c = (char*)POPPTR(ss,ix);
11172 TOPPTR(nss,ix) = pv_dup_inc(c);
11174 case SAVEt_STACK_POS: /* Position on Perl stack */
11176 TOPINT(nss,ix) = i;
11178 case SAVEt_DESTRUCTOR:
11179 ptr = POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11181 dptr = POPDPTR(ss,ix);
11182 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11183 any_dup(FPTR2DPTR(void *, dptr),
11186 case SAVEt_DESTRUCTOR_X:
11187 ptr = POPPTR(ss,ix);
11188 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11189 dxptr = POPDXPTR(ss,ix);
11190 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11191 any_dup(FPTR2DPTR(void *, dxptr),
11194 case SAVEt_REGCONTEXT:
11197 TOPINT(nss,ix) = i;
11200 case SAVEt_AELEM: /* array element */
11201 sv = (SV*)POPPTR(ss,ix);
11202 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11204 TOPINT(nss,ix) = i;
11205 av = (AV*)POPPTR(ss,ix);
11206 TOPPTR(nss,ix) = av_dup_inc(av, param);
11209 ptr = POPPTR(ss,ix);
11210 TOPPTR(nss,ix) = ptr;
11214 TOPINT(nss,ix) = i;
11215 ptr = POPPTR(ss,ix);
11218 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11219 HINTS_REFCNT_UNLOCK;
11221 TOPPTR(nss,ix) = ptr;
11222 if (i & HINT_LOCALIZE_HH) {
11223 hv = (HV*)POPPTR(ss,ix);
11224 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11227 case SAVEt_PADSV_AND_MORTALIZE:
11228 longval = (long)POPLONG(ss,ix);
11229 TOPLONG(nss,ix) = longval;
11230 ptr = POPPTR(ss,ix);
11231 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11232 sv = (SV*)POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11236 ptr = POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11238 longval = (long)POPBOOL(ss,ix);
11239 TOPBOOL(nss,ix) = (bool)longval;
11241 case SAVEt_SET_SVFLAGS:
11243 TOPINT(nss,ix) = i;
11245 TOPINT(nss,ix) = i;
11246 sv = (SV*)POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = sv_dup(sv, param);
11249 case SAVEt_RE_STATE:
11251 const struct re_save_state *const old_state
11252 = (struct re_save_state *)
11253 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11254 struct re_save_state *const new_state
11255 = (struct re_save_state *)
11256 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11258 Copy(old_state, new_state, 1, struct re_save_state);
11259 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11261 new_state->re_state_bostr
11262 = pv_dup(old_state->re_state_bostr);
11263 new_state->re_state_reginput
11264 = pv_dup(old_state->re_state_reginput);
11265 new_state->re_state_regeol
11266 = pv_dup(old_state->re_state_regeol);
11267 new_state->re_state_regoffs
11268 = (regexp_paren_pair*)
11269 any_dup(old_state->re_state_regoffs, proto_perl);
11270 new_state->re_state_reglastparen
11271 = (U32*) any_dup(old_state->re_state_reglastparen,
11273 new_state->re_state_reglastcloseparen
11274 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11276 /* XXX This just has to be broken. The old save_re_context
11277 code did SAVEGENERICPV(PL_reg_start_tmp);
11278 PL_reg_start_tmp is char **.
11279 Look above to what the dup code does for
11280 SAVEt_GENERIC_PVREF
11281 It can never have worked.
11282 So this is merely a faithful copy of the exiting bug: */
11283 new_state->re_state_reg_start_tmp
11284 = (char **) pv_dup((char *)
11285 old_state->re_state_reg_start_tmp);
11286 /* I assume that it only ever "worked" because no-one called
11287 (pseudo)fork while the regexp engine had re-entered itself.
11289 #ifdef PERL_OLD_COPY_ON_WRITE
11290 new_state->re_state_nrs
11291 = sv_dup(old_state->re_state_nrs, param);
11293 new_state->re_state_reg_magic
11294 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11296 new_state->re_state_reg_oldcurpm
11297 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11299 new_state->re_state_reg_curpm
11300 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11302 new_state->re_state_reg_oldsaved
11303 = pv_dup(old_state->re_state_reg_oldsaved);
11304 new_state->re_state_reg_poscache
11305 = pv_dup(old_state->re_state_reg_poscache);
11306 new_state->re_state_reg_starttry
11307 = pv_dup(old_state->re_state_reg_starttry);
11310 case SAVEt_COMPILE_WARNINGS:
11311 ptr = POPPTR(ss,ix);
11312 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11315 ptr = POPPTR(ss,ix);
11316 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11320 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11328 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11329 * flag to the result. This is done for each stash before cloning starts,
11330 * so we know which stashes want their objects cloned */
11333 do_mark_cloneable_stash(pTHX_ SV *const sv)
11335 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11337 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11338 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11339 if (cloner && GvCV(cloner)) {
11346 mXPUSHs(newSVhek(hvname));
11348 call_sv((SV*)GvCV(cloner), G_SCALAR);
11355 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11363 =for apidoc perl_clone
11365 Create and return a new interpreter by cloning the current one.
11367 perl_clone takes these flags as parameters:
11369 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11370 without it we only clone the data and zero the stacks,
11371 with it we copy the stacks and the new perl interpreter is
11372 ready to run at the exact same point as the previous one.
11373 The pseudo-fork code uses COPY_STACKS while the
11374 threads->create doesn't.
11376 CLONEf_KEEP_PTR_TABLE
11377 perl_clone keeps a ptr_table with the pointer of the old
11378 variable as a key and the new variable as a value,
11379 this allows it to check if something has been cloned and not
11380 clone it again but rather just use the value and increase the
11381 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11382 the ptr_table using the function
11383 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11384 reason to keep it around is if you want to dup some of your own
11385 variable who are outside the graph perl scans, example of this
11386 code is in threads.xs create
11389 This is a win32 thing, it is ignored on unix, it tells perls
11390 win32host code (which is c++) to clone itself, this is needed on
11391 win32 if you want to run two threads at the same time,
11392 if you just want to do some stuff in a separate perl interpreter
11393 and then throw it away and return to the original one,
11394 you don't need to do anything.
11399 /* XXX the above needs expanding by someone who actually understands it ! */
11400 EXTERN_C PerlInterpreter *
11401 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11404 perl_clone(PerlInterpreter *proto_perl, UV flags)
11407 #ifdef PERL_IMPLICIT_SYS
11409 PERL_ARGS_ASSERT_PERL_CLONE;
11411 /* perlhost.h so we need to call into it
11412 to clone the host, CPerlHost should have a c interface, sky */
11414 if (flags & CLONEf_CLONE_HOST) {
11415 return perl_clone_host(proto_perl,flags);
11417 return perl_clone_using(proto_perl, flags,
11419 proto_perl->IMemShared,
11420 proto_perl->IMemParse,
11422 proto_perl->IStdIO,
11426 proto_perl->IProc);
11430 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11431 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11432 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11433 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11434 struct IPerlDir* ipD, struct IPerlSock* ipS,
11435 struct IPerlProc* ipP)
11437 /* XXX many of the string copies here can be optimized if they're
11438 * constants; they need to be allocated as common memory and just
11439 * their pointers copied. */
11442 CLONE_PARAMS clone_params;
11443 CLONE_PARAMS* const param = &clone_params;
11445 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11447 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11449 /* for each stash, determine whether its objects should be cloned */
11450 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11451 PERL_SET_THX(my_perl);
11454 PoisonNew(my_perl, 1, PerlInterpreter);
11460 PL_savestack_ix = 0;
11461 PL_savestack_max = -1;
11462 PL_sig_pending = 0;
11464 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11465 # else /* !DEBUGGING */
11466 Zero(my_perl, 1, PerlInterpreter);
11467 # endif /* DEBUGGING */
11469 /* host pointers */
11471 PL_MemShared = ipMS;
11472 PL_MemParse = ipMP;
11479 #else /* !PERL_IMPLICIT_SYS */
11481 CLONE_PARAMS clone_params;
11482 CLONE_PARAMS* param = &clone_params;
11483 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11485 PERL_ARGS_ASSERT_PERL_CLONE;
11487 /* for each stash, determine whether its objects should be cloned */
11488 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11489 PERL_SET_THX(my_perl);
11492 PoisonNew(my_perl, 1, PerlInterpreter);
11498 PL_savestack_ix = 0;
11499 PL_savestack_max = -1;
11500 PL_sig_pending = 0;
11502 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11503 # else /* !DEBUGGING */
11504 Zero(my_perl, 1, PerlInterpreter);
11505 # endif /* DEBUGGING */
11506 #endif /* PERL_IMPLICIT_SYS */
11507 param->flags = flags;
11508 param->proto_perl = proto_perl;
11510 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11512 PL_body_arenas = NULL;
11513 Zero(&PL_body_roots, 1, PL_body_roots);
11515 PL_nice_chunk = NULL;
11516 PL_nice_chunk_size = 0;
11518 PL_sv_objcount = 0;
11520 PL_sv_arenaroot = NULL;
11522 PL_debug = proto_perl->Idebug;
11524 PL_hash_seed = proto_perl->Ihash_seed;
11525 PL_rehash_seed = proto_perl->Irehash_seed;
11527 #ifdef USE_REENTRANT_API
11528 /* XXX: things like -Dm will segfault here in perlio, but doing
11529 * PERL_SET_CONTEXT(proto_perl);
11530 * breaks too many other things
11532 Perl_reentrant_init(aTHX);
11535 /* create SV map for pointer relocation */
11536 PL_ptr_table = ptr_table_new();
11538 /* initialize these special pointers as early as possible */
11539 SvANY(&PL_sv_undef) = NULL;
11540 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11541 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11542 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11544 SvANY(&PL_sv_no) = new_XPVNV();
11545 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11546 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11547 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11548 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11549 SvCUR_set(&PL_sv_no, 0);
11550 SvLEN_set(&PL_sv_no, 1);
11551 SvIV_set(&PL_sv_no, 0);
11552 SvNV_set(&PL_sv_no, 0);
11553 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11555 SvANY(&PL_sv_yes) = new_XPVNV();
11556 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11557 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11558 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11559 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11560 SvCUR_set(&PL_sv_yes, 1);
11561 SvLEN_set(&PL_sv_yes, 2);
11562 SvIV_set(&PL_sv_yes, 1);
11563 SvNV_set(&PL_sv_yes, 1);
11564 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11566 /* create (a non-shared!) shared string table */
11567 PL_strtab = newHV();
11568 HvSHAREKEYS_off(PL_strtab);
11569 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11570 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11572 PL_compiling = proto_perl->Icompiling;
11574 /* These two PVs will be free'd special way so must set them same way op.c does */
11575 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11576 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11578 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11579 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11581 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11582 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11583 if (PL_compiling.cop_hints_hash) {
11585 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11586 HINTS_REFCNT_UNLOCK;
11588 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11589 #ifdef PERL_DEBUG_READONLY_OPS
11594 /* pseudo environmental stuff */
11595 PL_origargc = proto_perl->Iorigargc;
11596 PL_origargv = proto_perl->Iorigargv;
11598 param->stashes = newAV(); /* Setup array of objects to call clone on */
11600 /* Set tainting stuff before PerlIO_debug can possibly get called */
11601 PL_tainting = proto_perl->Itainting;
11602 PL_taint_warn = proto_perl->Itaint_warn;
11604 #ifdef PERLIO_LAYERS
11605 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11606 PerlIO_clone(aTHX_ proto_perl, param);
11609 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11610 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11611 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11612 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11613 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11614 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11617 PL_minus_c = proto_perl->Iminus_c;
11618 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11619 PL_localpatches = proto_perl->Ilocalpatches;
11620 PL_splitstr = proto_perl->Isplitstr;
11621 PL_minus_n = proto_perl->Iminus_n;
11622 PL_minus_p = proto_perl->Iminus_p;
11623 PL_minus_l = proto_perl->Iminus_l;
11624 PL_minus_a = proto_perl->Iminus_a;
11625 PL_minus_E = proto_perl->Iminus_E;
11626 PL_minus_F = proto_perl->Iminus_F;
11627 PL_doswitches = proto_perl->Idoswitches;
11628 PL_dowarn = proto_perl->Idowarn;
11629 PL_doextract = proto_perl->Idoextract;
11630 PL_sawampersand = proto_perl->Isawampersand;
11631 PL_unsafe = proto_perl->Iunsafe;
11632 PL_inplace = SAVEPV(proto_perl->Iinplace);
11633 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11634 PL_perldb = proto_perl->Iperldb;
11635 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11636 PL_exit_flags = proto_perl->Iexit_flags;
11638 /* magical thingies */
11639 /* XXX time(&PL_basetime) when asked for? */
11640 PL_basetime = proto_perl->Ibasetime;
11641 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11643 PL_maxsysfd = proto_perl->Imaxsysfd;
11644 PL_statusvalue = proto_perl->Istatusvalue;
11646 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11648 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11650 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11652 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11653 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11654 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11657 /* RE engine related */
11658 Zero(&PL_reg_state, 1, struct re_save_state);
11659 PL_reginterp_cnt = 0;
11660 PL_regmatch_slab = NULL;
11662 /* Clone the regex array */
11663 /* ORANGE FIXME for plugins, probably in the SV dup code.
11664 newSViv(PTR2IV(CALLREGDUPE(
11665 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11667 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11668 PL_regex_pad = AvARRAY(PL_regex_padav);
11670 /* shortcuts to various I/O objects */
11671 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11672 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11673 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11674 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11675 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11676 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11678 /* shortcuts to regexp stuff */
11679 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11681 /* shortcuts to misc objects */
11682 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11684 /* shortcuts to debugging objects */
11685 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11686 PL_DBline = gv_dup(proto_perl->IDBline, param);
11687 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11688 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11689 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11690 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11691 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11693 /* symbol tables */
11694 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11695 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11696 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11697 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11698 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11700 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11701 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11702 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11703 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11704 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11705 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11706 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11707 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11709 PL_sub_generation = proto_perl->Isub_generation;
11710 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11712 /* funky return mechanisms */
11713 PL_forkprocess = proto_perl->Iforkprocess;
11715 /* subprocess state */
11716 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11718 /* internal state */
11719 PL_maxo = proto_perl->Imaxo;
11720 if (proto_perl->Iop_mask)
11721 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11724 /* PL_asserting = proto_perl->Iasserting; */
11726 /* current interpreter roots */
11727 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11729 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11731 PL_main_start = proto_perl->Imain_start;
11732 PL_eval_root = proto_perl->Ieval_root;
11733 PL_eval_start = proto_perl->Ieval_start;
11735 /* runtime control stuff */
11736 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11738 PL_filemode = proto_perl->Ifilemode;
11739 PL_lastfd = proto_perl->Ilastfd;
11740 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11743 PL_gensym = proto_perl->Igensym;
11744 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11745 PL_laststatval = proto_perl->Ilaststatval;
11746 PL_laststype = proto_perl->Ilaststype;
11749 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11751 /* interpreter atexit processing */
11752 PL_exitlistlen = proto_perl->Iexitlistlen;
11753 if (PL_exitlistlen) {
11754 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11755 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11758 PL_exitlist = (PerlExitListEntry*)NULL;
11760 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11761 if (PL_my_cxt_size) {
11762 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11763 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11764 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11765 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11766 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11770 PL_my_cxt_list = (void**)NULL;
11771 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11772 PL_my_cxt_keys = (const char**)NULL;
11775 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11776 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11777 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11779 PL_profiledata = NULL;
11781 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11783 PAD_CLONE_VARS(proto_perl, param);
11785 #ifdef HAVE_INTERP_INTERN
11786 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11789 /* more statics moved here */
11790 PL_generation = proto_perl->Igeneration;
11791 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11793 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11794 PL_in_clean_all = proto_perl->Iin_clean_all;
11796 PL_uid = proto_perl->Iuid;
11797 PL_euid = proto_perl->Ieuid;
11798 PL_gid = proto_perl->Igid;
11799 PL_egid = proto_perl->Iegid;
11800 PL_nomemok = proto_perl->Inomemok;
11801 PL_an = proto_perl->Ian;
11802 PL_evalseq = proto_perl->Ievalseq;
11803 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11804 PL_origalen = proto_perl->Iorigalen;
11805 #ifdef PERL_USES_PL_PIDSTATUS
11806 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11808 PL_osname = SAVEPV(proto_perl->Iosname);
11809 PL_sighandlerp = proto_perl->Isighandlerp;
11811 PL_runops = proto_perl->Irunops;
11813 PL_parser = parser_dup(proto_perl->Iparser, param);
11815 PL_subline = proto_perl->Isubline;
11816 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11819 PL_cryptseen = proto_perl->Icryptseen;
11822 PL_hints = proto_perl->Ihints;
11824 PL_amagic_generation = proto_perl->Iamagic_generation;
11826 #ifdef USE_LOCALE_COLLATE
11827 PL_collation_ix = proto_perl->Icollation_ix;
11828 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11829 PL_collation_standard = proto_perl->Icollation_standard;
11830 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11831 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11832 #endif /* USE_LOCALE_COLLATE */
11834 #ifdef USE_LOCALE_NUMERIC
11835 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11836 PL_numeric_standard = proto_perl->Inumeric_standard;
11837 PL_numeric_local = proto_perl->Inumeric_local;
11838 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11839 #endif /* !USE_LOCALE_NUMERIC */
11841 /* utf8 character classes */
11842 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11843 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11844 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11845 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11846 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11847 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11848 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11849 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11850 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11851 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11852 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11853 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11854 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11855 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11856 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11857 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11858 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11859 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11860 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11861 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11863 /* Did the locale setup indicate UTF-8? */
11864 PL_utf8locale = proto_perl->Iutf8locale;
11865 /* Unicode features (see perlrun/-C) */
11866 PL_unicode = proto_perl->Iunicode;
11868 /* Pre-5.8 signals control */
11869 PL_signals = proto_perl->Isignals;
11871 /* times() ticks per second */
11872 PL_clocktick = proto_perl->Iclocktick;
11874 /* Recursion stopper for PerlIO_find_layer */
11875 PL_in_load_module = proto_perl->Iin_load_module;
11877 /* sort() routine */
11878 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11880 /* Not really needed/useful since the reenrant_retint is "volatile",
11881 * but do it for consistency's sake. */
11882 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11884 /* Hooks to shared SVs and locks. */
11885 PL_sharehook = proto_perl->Isharehook;
11886 PL_lockhook = proto_perl->Ilockhook;
11887 PL_unlockhook = proto_perl->Iunlockhook;
11888 PL_threadhook = proto_perl->Ithreadhook;
11889 PL_destroyhook = proto_perl->Idestroyhook;
11891 #ifdef THREADS_HAVE_PIDS
11892 PL_ppid = proto_perl->Ippid;
11896 PL_last_swash_hv = NULL; /* reinits on demand */
11897 PL_last_swash_klen = 0;
11898 PL_last_swash_key[0]= '\0';
11899 PL_last_swash_tmps = (U8*)NULL;
11900 PL_last_swash_slen = 0;
11902 PL_glob_index = proto_perl->Iglob_index;
11903 PL_srand_called = proto_perl->Isrand_called;
11904 PL_bitcount = NULL; /* reinits on demand */
11906 if (proto_perl->Ipsig_pend) {
11907 Newxz(PL_psig_pend, SIG_SIZE, int);
11910 PL_psig_pend = (int*)NULL;
11913 if (proto_perl->Ipsig_ptr) {
11914 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11915 Newxz(PL_psig_name, SIG_SIZE, SV*);
11916 for (i = 1; i < SIG_SIZE; i++) {
11917 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11918 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11922 PL_psig_ptr = (SV**)NULL;
11923 PL_psig_name = (SV**)NULL;
11926 /* intrpvar.h stuff */
11928 if (flags & CLONEf_COPY_STACKS) {
11929 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11930 PL_tmps_ix = proto_perl->Itmps_ix;
11931 PL_tmps_max = proto_perl->Itmps_max;
11932 PL_tmps_floor = proto_perl->Itmps_floor;
11933 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11935 while (i <= PL_tmps_ix) {
11936 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11940 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11941 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11942 Newxz(PL_markstack, i, I32);
11943 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11944 - proto_perl->Imarkstack);
11945 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11946 - proto_perl->Imarkstack);
11947 Copy(proto_perl->Imarkstack, PL_markstack,
11948 PL_markstack_ptr - PL_markstack + 1, I32);
11950 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11951 * NOTE: unlike the others! */
11952 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11953 PL_scopestack_max = proto_perl->Iscopestack_max;
11954 Newxz(PL_scopestack, PL_scopestack_max, I32);
11955 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11957 /* NOTE: si_dup() looks at PL_markstack */
11958 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11960 /* PL_curstack = PL_curstackinfo->si_stack; */
11961 PL_curstack = av_dup(proto_perl->Icurstack, param);
11962 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11964 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11965 PL_stack_base = AvARRAY(PL_curstack);
11966 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11967 - proto_perl->Istack_base);
11968 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11970 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11971 * NOTE: unlike the others! */
11972 PL_savestack_ix = proto_perl->Isavestack_ix;
11973 PL_savestack_max = proto_perl->Isavestack_max;
11974 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11975 PL_savestack = ss_dup(proto_perl, param);
11979 ENTER; /* perl_destruct() wants to LEAVE; */
11981 /* although we're not duplicating the tmps stack, we should still
11982 * add entries for any SVs on the tmps stack that got cloned by a
11983 * non-refcount means (eg a temp in @_); otherwise they will be
11986 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11987 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11988 proto_perl->Itmps_stack[i]);
11989 if (nsv && !SvREFCNT(nsv)) {
11991 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11996 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11997 PL_top_env = &PL_start_env;
11999 PL_op = proto_perl->Iop;
12002 PL_Xpv = (XPV*)NULL;
12003 my_perl->Ina = proto_perl->Ina;
12005 PL_statbuf = proto_perl->Istatbuf;
12006 PL_statcache = proto_perl->Istatcache;
12007 PL_statgv = gv_dup(proto_perl->Istatgv, param);
12008 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
12010 PL_timesbuf = proto_perl->Itimesbuf;
12013 PL_tainted = proto_perl->Itainted;
12014 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
12015 PL_rs = sv_dup_inc(proto_perl->Irs, param);
12016 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
12017 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
12018 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12019 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12020 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12021 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12022 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12024 PL_restartop = proto_perl->Irestartop;
12025 PL_in_eval = proto_perl->Iin_eval;
12026 PL_delaymagic = proto_perl->Idelaymagic;
12027 PL_dirty = proto_perl->Idirty;
12028 PL_localizing = proto_perl->Ilocalizing;
12030 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12031 PL_hv_fetch_ent_mh = NULL;
12032 PL_modcount = proto_perl->Imodcount;
12033 PL_lastgotoprobe = NULL;
12034 PL_dumpindent = proto_perl->Idumpindent;
12036 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12037 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12038 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12039 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12040 PL_efloatbuf = NULL; /* reinits on demand */
12041 PL_efloatsize = 0; /* reinits on demand */
12045 PL_screamfirst = NULL;
12046 PL_screamnext = NULL;
12047 PL_maxscream = -1; /* reinits on demand */
12048 PL_lastscream = NULL;
12051 PL_regdummy = proto_perl->Iregdummy;
12052 PL_colorset = 0; /* reinits PL_colors[] */
12053 /*PL_colors[6] = {0,0,0,0,0,0};*/
12057 /* Pluggable optimizer */
12058 PL_peepp = proto_perl->Ipeepp;
12060 PL_stashcache = newHV();
12062 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12063 proto_perl->Iwatchaddr);
12064 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12065 if (PL_debug && PL_watchaddr) {
12066 PerlIO_printf(Perl_debug_log,
12067 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12068 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12069 PTR2UV(PL_watchok));
12072 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12073 ptr_table_free(PL_ptr_table);
12074 PL_ptr_table = NULL;
12077 /* Call the ->CLONE method, if it exists, for each of the stashes
12078 identified by sv_dup() above.
12080 while(av_len(param->stashes) != -1) {
12081 HV* const stash = (HV*) av_shift(param->stashes);
12082 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12083 if (cloner && GvCV(cloner)) {
12088 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12090 call_sv((SV*)GvCV(cloner), G_DISCARD);
12096 SvREFCNT_dec(param->stashes);
12098 /* orphaned? eg threads->new inside BEGIN or use */
12099 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12100 SvREFCNT_inc_simple_void(PL_compcv);
12101 SAVEFREESV(PL_compcv);
12107 #endif /* USE_ITHREADS */
12110 =head1 Unicode Support
12112 =for apidoc sv_recode_to_utf8
12114 The encoding is assumed to be an Encode object, on entry the PV
12115 of the sv is assumed to be octets in that encoding, and the sv
12116 will be converted into Unicode (and UTF-8).
12118 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12119 is not a reference, nothing is done to the sv. If the encoding is not
12120 an C<Encode::XS> Encoding object, bad things will happen.
12121 (See F<lib/encoding.pm> and L<Encode>).
12123 The PV of the sv is returned.
12128 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12132 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12134 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12148 Passing sv_yes is wrong - it needs to be or'ed set of constants
12149 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12150 remove converted chars from source.
12152 Both will default the value - let them.
12154 XPUSHs(&PL_sv_yes);
12157 call_method("decode", G_SCALAR);
12161 s = SvPV_const(uni, len);
12162 if (s != SvPVX_const(sv)) {
12163 SvGROW(sv, len + 1);
12164 Move(s, SvPVX(sv), len + 1, char);
12165 SvCUR_set(sv, len);
12172 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12176 =for apidoc sv_cat_decode
12178 The encoding is assumed to be an Encode object, the PV of the ssv is
12179 assumed to be octets in that encoding and decoding the input starts
12180 from the position which (PV + *offset) pointed to. The dsv will be
12181 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12182 when the string tstr appears in decoding output or the input ends on
12183 the PV of the ssv. The value which the offset points will be modified
12184 to the last input position on the ssv.
12186 Returns TRUE if the terminator was found, else returns FALSE.
12191 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12192 SV *ssv, int *offset, char *tstr, int tlen)
12197 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12199 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12210 offsv = newSViv(*offset);
12212 mXPUSHp(tstr, tlen);
12214 call_method("cat_decode", G_SCALAR);
12216 ret = SvTRUE(TOPs);
12217 *offset = SvIV(offsv);
12223 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12228 /* ---------------------------------------------------------------------
12230 * support functions for report_uninit()
12233 /* the maxiumum size of array or hash where we will scan looking
12234 * for the undefined element that triggered the warning */
12236 #define FUV_MAX_SEARCH_SIZE 1000
12238 /* Look for an entry in the hash whose value has the same SV as val;
12239 * If so, return a mortal copy of the key. */
12242 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12245 register HE **array;
12248 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12250 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12251 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12254 array = HvARRAY(hv);
12256 for (i=HvMAX(hv); i>0; i--) {
12257 register HE *entry;
12258 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12259 if (HeVAL(entry) != val)
12261 if ( HeVAL(entry) == &PL_sv_undef ||
12262 HeVAL(entry) == &PL_sv_placeholder)
12266 if (HeKLEN(entry) == HEf_SVKEY)
12267 return sv_mortalcopy(HeKEY_sv(entry));
12268 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12274 /* Look for an entry in the array whose value has the same SV as val;
12275 * If so, return the index, otherwise return -1. */
12278 S_find_array_subscript(pTHX_ AV *av, SV* val)
12282 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12284 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12285 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12288 if (val != &PL_sv_undef) {
12289 SV ** const svp = AvARRAY(av);
12292 for (i=AvFILLp(av); i>=0; i--)
12299 /* S_varname(): return the name of a variable, optionally with a subscript.
12300 * If gv is non-zero, use the name of that global, along with gvtype (one
12301 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12302 * targ. Depending on the value of the subscript_type flag, return:
12305 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12306 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12307 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12308 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12311 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12312 SV* keyname, I32 aindex, int subscript_type)
12315 SV * const name = sv_newmortal();
12318 buffer[0] = gvtype;
12321 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12323 gv_fullname4(name, gv, buffer, 0);
12325 if ((unsigned int)SvPVX(name)[1] <= 26) {
12327 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12329 /* Swap the 1 unprintable control character for the 2 byte pretty
12330 version - ie substr($name, 1, 1) = $buffer; */
12331 sv_insert(name, 1, 1, buffer, 2);
12335 CV * const cv = find_runcv(NULL);
12339 if (!cv || !CvPADLIST(cv))
12341 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12342 sv = *av_fetch(av, targ, FALSE);
12343 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12346 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12347 SV * const sv = newSV(0);
12348 *SvPVX(name) = '$';
12349 Perl_sv_catpvf(aTHX_ name, "{%s}",
12350 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12353 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12354 *SvPVX(name) = '$';
12355 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12357 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12358 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12359 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12367 =for apidoc find_uninit_var
12369 Find the name of the undefined variable (if any) that caused the operator o
12370 to issue a "Use of uninitialized value" warning.
12371 If match is true, only return a name if it's value matches uninit_sv.
12372 So roughly speaking, if a unary operator (such as OP_COS) generates a
12373 warning, then following the direct child of the op may yield an
12374 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12375 other hand, with OP_ADD there are two branches to follow, so we only print
12376 the variable name if we get an exact match.
12378 The name is returned as a mortal SV.
12380 Assumes that PL_op is the op that originally triggered the error, and that
12381 PL_comppad/PL_curpad points to the currently executing pad.
12387 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12395 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12396 uninit_sv == &PL_sv_placeholder)))
12399 switch (obase->op_type) {
12406 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12407 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12410 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12412 if (pad) { /* @lex, %lex */
12413 sv = PAD_SVl(obase->op_targ);
12417 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12418 /* @global, %global */
12419 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12422 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12424 else /* @{expr}, %{expr} */
12425 return find_uninit_var(cUNOPx(obase)->op_first,
12429 /* attempt to find a match within the aggregate */
12431 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12433 subscript_type = FUV_SUBSCRIPT_HASH;
12436 index = find_array_subscript((AV*)sv, uninit_sv);
12438 subscript_type = FUV_SUBSCRIPT_ARRAY;
12441 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12444 return varname(gv, hash ? '%' : '@', obase->op_targ,
12445 keysv, index, subscript_type);
12449 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12451 return varname(NULL, '$', obase->op_targ,
12452 NULL, 0, FUV_SUBSCRIPT_NONE);
12455 gv = cGVOPx_gv(obase);
12456 if (!gv || (match && GvSV(gv) != uninit_sv))
12458 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12461 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12464 av = (AV*)PAD_SV(obase->op_targ);
12465 if (!av || SvRMAGICAL(av))
12467 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12468 if (!svp || *svp != uninit_sv)
12471 return varname(NULL, '$', obase->op_targ,
12472 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12475 gv = cGVOPx_gv(obase);
12481 if (!av || SvRMAGICAL(av))
12483 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12484 if (!svp || *svp != uninit_sv)
12487 return varname(gv, '$', 0,
12488 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12493 o = cUNOPx(obase)->op_first;
12494 if (!o || o->op_type != OP_NULL ||
12495 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12497 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12501 if (PL_op == obase)
12502 /* $a[uninit_expr] or $h{uninit_expr} */
12503 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12506 o = cBINOPx(obase)->op_first;
12507 kid = cBINOPx(obase)->op_last;
12509 /* get the av or hv, and optionally the gv */
12511 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12512 sv = PAD_SV(o->op_targ);
12514 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12515 && cUNOPo->op_first->op_type == OP_GV)
12517 gv = cGVOPx_gv(cUNOPo->op_first);
12520 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12525 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12526 /* index is constant */
12530 if (obase->op_type == OP_HELEM) {
12531 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12532 if (!he || HeVAL(he) != uninit_sv)
12536 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12537 if (!svp || *svp != uninit_sv)
12541 if (obase->op_type == OP_HELEM)
12542 return varname(gv, '%', o->op_targ,
12543 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12545 return varname(gv, '@', o->op_targ, NULL,
12546 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12549 /* index is an expression;
12550 * attempt to find a match within the aggregate */
12551 if (obase->op_type == OP_HELEM) {
12552 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12554 return varname(gv, '%', o->op_targ,
12555 keysv, 0, FUV_SUBSCRIPT_HASH);
12558 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12560 return varname(gv, '@', o->op_targ,
12561 NULL, index, FUV_SUBSCRIPT_ARRAY);
12566 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12568 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12573 /* only examine RHS */
12574 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12577 o = cUNOPx(obase)->op_first;
12578 if (o->op_type == OP_PUSHMARK)
12581 if (!o->op_sibling) {
12582 /* one-arg version of open is highly magical */
12584 if (o->op_type == OP_GV) { /* open FOO; */
12586 if (match && GvSV(gv) != uninit_sv)
12588 return varname(gv, '$', 0,
12589 NULL, 0, FUV_SUBSCRIPT_NONE);
12591 /* other possibilities not handled are:
12592 * open $x; or open my $x; should return '${*$x}'
12593 * open expr; should return '$'.expr ideally
12599 /* ops where $_ may be an implicit arg */
12603 if ( !(obase->op_flags & OPf_STACKED)) {
12604 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12605 ? PAD_SVl(obase->op_targ)
12608 sv = sv_newmortal();
12609 sv_setpvn(sv, "$_", 2);
12618 match = 1; /* print etc can return undef on defined args */
12619 /* skip filehandle as it can't produce 'undef' warning */
12620 o = cUNOPx(obase)->op_first;
12621 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12622 o = o->op_sibling->op_sibling;
12626 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12628 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12630 /* the following ops are capable of returning PL_sv_undef even for
12631 * defined arg(s) */
12650 case OP_GETPEERNAME:
12698 case OP_SMARTMATCH:
12707 /* XXX tmp hack: these two may call an XS sub, and currently
12708 XS subs don't have a SUB entry on the context stack, so CV and
12709 pad determination goes wrong, and BAD things happen. So, just
12710 don't try to determine the value under those circumstances.
12711 Need a better fix at dome point. DAPM 11/2007 */
12716 /* def-ness of rval pos() is independent of the def-ness of its arg */
12717 if ( !(obase->op_flags & OPf_MOD))
12722 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12723 return newSVpvs_flags("${$/}", SVs_TEMP);
12728 if (!(obase->op_flags & OPf_KIDS))
12730 o = cUNOPx(obase)->op_first;
12736 /* if all except one arg are constant, or have no side-effects,
12737 * or are optimized away, then it's unambiguous */
12739 for (kid=o; kid; kid = kid->op_sibling) {
12741 const OPCODE type = kid->op_type;
12742 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12743 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12744 || (type == OP_PUSHMARK)
12748 if (o2) { /* more than one found */
12755 return find_uninit_var(o2, uninit_sv, match);
12757 /* scan all args */
12759 sv = find_uninit_var(o, uninit_sv, 1);
12771 =for apidoc report_uninit
12773 Print appropriate "Use of uninitialized variable" warning
12779 Perl_report_uninit(pTHX_ SV* uninit_sv)
12783 SV* varname = NULL;
12785 varname = find_uninit_var(PL_op, uninit_sv,0);
12787 sv_insert(varname, 0, 0, " ", 1);
12789 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12790 varname ? SvPV_nolen_const(varname) : "",
12791 " in ", OP_DESC(PL_op));
12794 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12800 * c-indentation-style: bsd
12801 * c-basic-offset: 4
12802 * indent-tabs-mode: t
12805 * ex: set ts=8 sts=4 sw=4 noet: