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
253 ? PL_parser->copline == NOLINE
259 sv->sv_debug_inpad = 0;
260 sv->sv_debug_cloned = 0;
261 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
265 # define new_SV(p) (p)=S_new_SV(aTHX)
273 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
294 S_del_sv(pTHX_ SV *p)
298 PERL_ARGS_ASSERT_DEL_SV;
303 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
304 const SV * const sv = sva + 1;
305 const SV * const svend = &sva[SvREFCNT(sva)];
306 if (p >= sv && p < svend) {
312 if (ckWARN_d(WARN_INTERNAL))
313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
314 "Attempt to free non-arena SV: 0x%"UVxf
315 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
322 #else /* ! DEBUGGING */
324 #define del_SV(p) plant_SV(p)
326 #endif /* DEBUGGING */
330 =head1 SV Manipulation Functions
332 =for apidoc sv_add_arena
334 Given a chunk of memory, link it to the head of the list of arenas,
335 and split it into a list of free SVs.
341 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
344 SV* const sva = (SV*)ptr;
348 PERL_ARGS_ASSERT_SV_ADD_ARENA;
350 /* The first SV in an arena isn't an SV. */
351 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
352 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
353 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
355 PL_sv_arenaroot = sva;
356 PL_sv_root = sva + 1;
358 svend = &sva[SvREFCNT(sva) - 1];
361 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
365 /* Must always set typemask because it's always checked in on cleanup
366 when the arenas are walked looking for objects. */
367 SvFLAGS(sv) = SVTYPEMASK;
370 SvARENA_CHAIN(sv) = 0;
374 SvFLAGS(sv) = SVTYPEMASK;
377 /* visit(): call the named function for each non-free SV in the arenas
378 * whose flags field matches the flags/mask args. */
381 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
387 PERL_ARGS_ASSERT_VISIT;
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *const sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
437 /* called by sv_clean_objs() for each live SV */
440 do_clean_objs(pTHX_ SV *const ref)
445 SV * const target = SvRV(ref);
446 if (SvOBJECT(target)) {
447 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
448 if (SvWEAKREF(ref)) {
449 sv_del_backref(target, ref);
455 SvREFCNT_dec(target);
460 /* XXX Might want to check arrays, etc. */
463 /* called by sv_clean_objs() for each live SV */
465 #ifndef DISABLE_DESTRUCTOR_KLUDGE
467 do_clean_named_objs(pTHX_ SV *const sv)
470 assert(SvTYPE(sv) == SVt_PVGV);
471 assert(isGV_with_GP(sv));
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
481 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *const sv)
519 if (sv == PL_fdpid || sv == PL_strtab) /* don't clean pid table and strtab */
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
527 =for apidoc sv_clean_all
529 Decrement the refcnt of each remaining SV, possibly triggering a
530 cleanup. This function may have to be called multiple times to free
531 SVs which are in complex self-referential hierarchies.
537 Perl_sv_clean_all(pTHX)
541 PL_in_clean_all = TRUE;
542 cleaned = visit(do_clean_all, 0,0);
543 PL_in_clean_all = FALSE;
548 ARENASETS: a meta-arena implementation which separates arena-info
549 into struct arena_set, which contains an array of struct
550 arena_descs, each holding info for a single arena. By separating
551 the meta-info from the arena, we recover the 1st slot, formerly
552 borrowed for list management. The arena_set is about the size of an
553 arena, avoiding the needless malloc overhead of a naive linked-list.
555 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
556 memory in the last arena-set (1/2 on average). In trade, we get
557 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
558 smaller types). The recovery of the wasted space allows use of
559 small arenas for large, rare body types, by changing array* fields
560 in body_details_by_type[] below.
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 U32 misc; /* type, and in future other things. */
570 /* Get the maximum number of elements in set[] such that struct arena_set
571 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
572 therefore likely to be 1 aligned memory page. */
574 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
575 - 2 * sizeof(int)) / sizeof (struct arena_desc))
578 struct arena_set* next;
579 unsigned int set_size; /* ie ARENAS_PER_SET */
580 unsigned int curr; /* index of next available arena-desc */
581 struct arena_desc set[ARENAS_PER_SET];
585 =for apidoc sv_free_arenas
587 Deallocate the memory used by all arenas. Note that all the individual SV
588 heads and bodies within the arenas must already have been freed.
593 Perl_sv_free_arenas(pTHX)
600 /* Free arenas here, but be careful about fake ones. (We assume
601 contiguity of the fake ones with the corresponding real ones.) */
603 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
604 svanext = (SV*) SvANY(sva);
605 while (svanext && SvFAKE(svanext))
606 svanext = (SV*) SvANY(svanext);
613 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
616 struct arena_set *current = aroot;
619 assert(aroot->set[i].arena);
620 Safefree(aroot->set[i].arena);
628 i = PERL_ARENA_ROOTS_SIZE;
630 PL_body_roots[i] = 0;
632 Safefree(PL_nice_chunk);
633 PL_nice_chunk = NULL;
634 PL_nice_chunk_size = 0;
640 Here are mid-level routines that manage the allocation of bodies out
641 of the various arenas. There are 5 kinds of arenas:
643 1. SV-head arenas, which are discussed and handled above
644 2. regular body arenas
645 3. arenas for reduced-size bodies
647 5. pte arenas (thread related)
649 Arena types 2 & 3 are chained by body-type off an array of
650 arena-root pointers, which is indexed by svtype. Some of the
651 larger/less used body types are malloced singly, since a large
652 unused block of them is wasteful. Also, several svtypes dont have
653 bodies; the data fits into the sv-head itself. The arena-root
654 pointer thus has a few unused root-pointers (which may be hijacked
655 later for arena types 4,5)
657 3 differs from 2 as an optimization; some body types have several
658 unused fields in the front of the structure (which are kept in-place
659 for consistency). These bodies can be allocated in smaller chunks,
660 because the leading fields arent accessed. Pointers to such bodies
661 are decremented to point at the unused 'ghost' memory, knowing that
662 the pointers are used with offsets to the real memory.
664 HE, HEK arenas are managed separately, with separate code, but may
665 be merge-able later..
667 PTE arenas are not sv-bodies, but they share these mid-level
668 mechanics, so are considered here. The new mid-level mechanics rely
669 on the sv_type of the body being allocated, so we just reserve one
670 of the unused body-slots for PTEs, then use it in those (2) PTE
671 contexts below (line ~10k)
674 /* get_arena(size): this creates custom-sized arenas
675 TBD: export properly for hv.c: S_more_he().
678 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
681 struct arena_desc* adesc;
682 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
685 /* shouldnt need this
686 if (!arena_size) arena_size = PERL_ARENA_SIZE;
689 /* may need new arena-set to hold new arena */
690 if (!aroot || aroot->curr >= aroot->set_size) {
691 struct arena_set *newroot;
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = aroot;
696 PL_body_arenas = (void *) newroot;
697 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
700 /* ok, now have arena-set with at least 1 empty/available arena-desc */
701 curr = aroot->curr++;
702 adesc = &(aroot->set[curr]);
703 assert(!adesc->arena);
705 Newx(adesc->arena, arena_size, char);
706 adesc->size = arena_size;
708 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
709 curr, (void*)adesc->arena, (UV)arena_size));
715 /* return a thing to the free list */
717 #define del_body(thing, root) \
719 void ** const thing_copy = (void **)thing;\
720 *thing_copy = *root; \
721 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
807 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
808 just use the same allocation semantics. At first, PTEs were also
809 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
810 bugs, so was simplified by claiming a new slot. This choice has no
811 consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* The bind placeholder pretends to be an RV for now.
891 Also it's marked as "can't upgrade" to stop anyone using it before it's
893 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
895 /* IVs are in the head, so the allocation size is 0.
896 However, the slot is overloaded for PTEs. */
897 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
898 sizeof(IV), /* This is used to copy out the IV body. */
899 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
900 NOARENA /* IVS don't need an arena */,
901 /* But PTEs need to know the size of their arena */
902 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
905 /* 8 bytes on most ILP32 with IEEE doubles */
906 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
907 FIT_ARENA(0, sizeof(NV)) },
909 /* 8 bytes on most ILP32 with IEEE doubles */
910 { sizeof(xpv_allocated),
911 copy_length(XPV, xpv_len)
912 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
913 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
917 { sizeof(xpviv_allocated),
918 copy_length(XPVIV, xiv_u)
919 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
920 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
924 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
925 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
928 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
932 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
933 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
934 SVt_REGEXP, FALSE, NONV, HASARENA,
935 FIT_ARENA(0, sizeof(struct regexp_allocated))
939 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
940 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
943 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
944 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
946 { sizeof(xpvav_allocated),
947 copy_length(XPVAV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
949 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
952 { sizeof(xpvhv_allocated),
953 copy_length(XPVHV, xmg_stash)
954 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
955 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
959 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
960 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
961 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
963 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
964 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
965 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
967 /* XPVIO is 84 bytes, fits 48x */
968 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
969 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
970 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
973 #define new_body_type(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ sv_type))
976 #define del_body_type(p, sv_type) \
977 del_body(p, &PL_body_roots[sv_type])
980 #define new_body_allocated(sv_type) \
981 (void *)((char *)S_new_body(aTHX_ sv_type) \
982 - bodies_by_type[sv_type].offset)
984 #define del_body_allocated(p, sv_type) \
985 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
988 #define my_safemalloc(s) (void*)safemalloc(s)
989 #define my_safecalloc(s) (void*)safecalloc(s, 1)
990 #define my_safefree(p) safefree((char*)p)
994 #define new_XNV() my_safemalloc(sizeof(XPVNV))
995 #define del_XNV(p) my_safefree(p)
997 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
998 #define del_XPVNV(p) my_safefree(p)
1000 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1001 #define del_XPVAV(p) my_safefree(p)
1003 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1004 #define del_XPVHV(p) my_safefree(p)
1006 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1007 #define del_XPVMG(p) my_safefree(p)
1009 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1010 #define del_XPVGV(p) my_safefree(p)
1014 #define new_XNV() new_body_type(SVt_NV)
1015 #define del_XNV(p) del_body_type(p, SVt_NV)
1017 #define new_XPVNV() new_body_type(SVt_PVNV)
1018 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1020 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1021 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1023 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1024 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1026 #define new_XPVMG() new_body_type(SVt_PVMG)
1027 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1029 #define new_XPVGV() new_body_type(SVt_PVGV)
1030 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1034 /* no arena for you! */
1036 #define new_NOARENA(details) \
1037 my_safemalloc((details)->body_size + (details)->offset)
1038 #define new_NOARENAZ(details) \
1039 my_safecalloc((details)->body_size + (details)->offset)
1042 S_more_bodies (pTHX_ const svtype sv_type)
1045 void ** const root = &PL_body_roots[sv_type];
1046 const struct body_details * const bdp = &bodies_by_type[sv_type];
1047 const size_t body_size = bdp->body_size;
1050 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 static bool done_sanity_check;
1054 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1055 * variables like done_sanity_check. */
1056 if (!done_sanity_check) {
1057 unsigned int i = SVt_LAST;
1059 done_sanity_check = TRUE;
1062 assert (bodies_by_type[i].type == i);
1066 assert(bdp->arena_size);
1068 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1070 end = start + arena_size - 2 * body_size;
1072 /* computed count doesnt reflect the 1st slot reservation */
1073 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1074 DEBUG_m(PerlIO_printf(Perl_debug_log,
1075 "arena %p end %p arena-size %d (from %d) type %d "
1077 (void*)start, (void*)end, (int)arena_size,
1078 (int)bdp->arena_size, sv_type, (int)body_size,
1079 (int)arena_size / (int)body_size));
1081 DEBUG_m(PerlIO_printf(Perl_debug_log,
1082 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1083 (void*)start, (void*)end,
1084 (int)bdp->arena_size, sv_type, (int)body_size,
1085 (int)bdp->arena_size / (int)body_size));
1087 *root = (void *)start;
1089 while (start <= end) {
1090 char * const next = start + body_size;
1091 *(void**) start = (void *)next;
1094 *(void **)start = 0;
1099 /* grab a new thing from the free list, allocating more if necessary.
1100 The inline version is used for speed in hot routines, and the
1101 function using it serves the rest (unless PURIFY).
1103 #define new_body_inline(xpv, sv_type) \
1105 void ** const r3wt = &PL_body_roots[sv_type]; \
1106 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1107 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1108 *(r3wt) = *(void**)(xpv); \
1114 S_new_body(pTHX_ const svtype sv_type)
1118 new_body_inline(xpv, sv_type);
1124 static const struct body_details fake_rv =
1125 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1128 =for apidoc sv_upgrade
1130 Upgrade an SV to a more complex form. Generally adds a new body type to the
1131 SV, then copies across as much information as possible from the old body.
1132 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1138 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1143 const svtype old_type = SvTYPE(sv);
1144 const struct body_details *new_type_details;
1145 const struct body_details *old_type_details
1146 = bodies_by_type + old_type;
1147 SV *referant = NULL;
1149 PERL_ARGS_ASSERT_SV_UPGRADE;
1151 if (new_type != SVt_PV && SvIsCOW(sv)) {
1152 sv_force_normal_flags(sv, 0);
1155 if (old_type == new_type)
1158 old_body = SvANY(sv);
1160 /* Copying structures onto other structures that have been neatly zeroed
1161 has a subtle gotcha. Consider XPVMG
1163 +------+------+------+------+------+-------+-------+
1164 | NV | CUR | LEN | IV | MAGIC | STASH |
1165 +------+------+------+------+------+-------+-------+
1166 0 4 8 12 16 20 24 28
1168 where NVs are aligned to 8 bytes, so that sizeof that structure is
1169 actually 32 bytes long, with 4 bytes of padding at the end:
1171 +------+------+------+------+------+-------+-------+------+
1172 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1173 +------+------+------+------+------+-------+-------+------+
1174 0 4 8 12 16 20 24 28 32
1176 so what happens if you allocate memory for this structure:
1178 +------+------+------+------+------+-------+-------+------+------+...
1179 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1180 +------+------+------+------+------+-------+-------+------+------+...
1181 0 4 8 12 16 20 24 28 32 36
1183 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1184 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1185 started out as zero once, but it's quite possible that it isn't. So now,
1186 rather than a nicely zeroed GP, you have it pointing somewhere random.
1189 (In fact, GP ends up pointing at a previous GP structure, because the
1190 principle cause of the padding in XPVMG getting garbage is a copy of
1191 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1192 this happens to be moot because XPVGV has been re-ordered, with GP
1193 no longer after STASH)
1195 So we are careful and work out the size of used parts of all the
1203 referant = SvRV(sv);
1204 old_type_details = &fake_rv;
1205 if (new_type == SVt_NV)
1206 new_type = SVt_PVNV;
1208 if (new_type < SVt_PVIV) {
1209 new_type = (new_type == SVt_NV)
1210 ? SVt_PVNV : SVt_PVIV;
1215 if (new_type < SVt_PVNV) {
1216 new_type = SVt_PVNV;
1220 assert(new_type > SVt_PV);
1221 assert(SVt_IV < SVt_PV);
1222 assert(SVt_NV < SVt_PV);
1229 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1230 there's no way that it can be safely upgraded, because perl.c
1231 expects to Safefree(SvANY(PL_mess_sv)) */
1232 assert(sv != PL_mess_sv);
1233 /* This flag bit is used to mean other things in other scalar types.
1234 Given that it only has meaning inside the pad, it shouldn't be set
1235 on anything that can get upgraded. */
1236 assert(!SvPAD_TYPED(sv));
1239 if (old_type_details->cant_upgrade)
1240 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1241 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1244 if (old_type > new_type)
1245 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1246 (int)old_type, (int)new_type);
1248 new_type_details = bodies_by_type + new_type;
1250 SvFLAGS(sv) &= ~SVTYPEMASK;
1251 SvFLAGS(sv) |= new_type;
1253 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1254 the return statements above will have triggered. */
1255 assert (new_type != SVt_NULL);
1258 assert(old_type == SVt_NULL);
1259 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1263 assert(old_type == SVt_NULL);
1264 SvANY(sv) = new_XNV();
1269 assert(new_type_details->body_size);
1272 assert(new_type_details->arena);
1273 assert(new_type_details->arena_size);
1274 /* This points to the start of the allocated area. */
1275 new_body_inline(new_body, new_type);
1276 Zero(new_body, new_type_details->body_size, char);
1277 new_body = ((char *)new_body) - new_type_details->offset;
1279 /* We always allocated the full length item with PURIFY. To do this
1280 we fake things so that arena is false for all 16 types.. */
1281 new_body = new_NOARENAZ(new_type_details);
1283 SvANY(sv) = new_body;
1284 if (new_type == SVt_PVAV) {
1288 if (old_type_details->body_size) {
1291 /* It will have been zeroed when the new body was allocated.
1292 Lets not write to it, in case it confuses a write-back
1298 #ifndef NODEFAULT_SHAREKEYS
1299 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1301 HvMAX(sv) = 7; /* (start with 8 buckets) */
1302 if (old_type_details->body_size) {
1305 /* It will have been zeroed when the new body was allocated.
1306 Lets not write to it, in case it confuses a write-back
1311 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1312 The target created by newSVrv also is, and it can have magic.
1313 However, it never has SvPVX set.
1315 if (old_type == SVt_IV) {
1317 } else if (old_type >= SVt_PV) {
1318 assert(SvPVX_const(sv) == 0);
1321 if (old_type >= SVt_PVMG) {
1322 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1323 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1325 sv->sv_u.svu_array = NULL; /* or svu_hash */
1331 /* XXX Is this still needed? Was it ever needed? Surely as there is
1332 no route from NV to PVIV, NOK can never be true */
1333 assert(!SvNOKp(sv));
1345 assert(new_type_details->body_size);
1346 /* We always allocated the full length item with PURIFY. To do this
1347 we fake things so that arena is false for all 16 types.. */
1348 if(new_type_details->arena) {
1349 /* This points to the start of the allocated area. */
1350 new_body_inline(new_body, new_type);
1351 Zero(new_body, new_type_details->body_size, char);
1352 new_body = ((char *)new_body) - new_type_details->offset;
1354 new_body = new_NOARENAZ(new_type_details);
1356 SvANY(sv) = new_body;
1358 if (old_type_details->copy) {
1359 /* There is now the potential for an upgrade from something without
1360 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1361 int offset = old_type_details->offset;
1362 int length = old_type_details->copy;
1364 if (new_type_details->offset > old_type_details->offset) {
1365 const int difference
1366 = new_type_details->offset - old_type_details->offset;
1367 offset += difference;
1368 length -= difference;
1370 assert (length >= 0);
1372 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1376 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1377 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1378 * correct 0.0 for us. Otherwise, if the old body didn't have an
1379 * NV slot, but the new one does, then we need to initialise the
1380 * freshly created NV slot with whatever the correct bit pattern is
1382 if (old_type_details->zero_nv && !new_type_details->zero_nv
1383 && !isGV_with_GP(sv))
1387 if (new_type == SVt_PVIO)
1388 IoPAGE_LEN(sv) = 60;
1389 if (old_type < SVt_PV) {
1390 /* referant will be NULL unless the old type was SVt_IV emulating
1392 sv->sv_u.svu_rv = referant;
1396 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1397 (unsigned long)new_type);
1400 if (old_type_details->arena) {
1401 /* If there was an old body, then we need to free it.
1402 Note that there is an assumption that all bodies of types that
1403 can be upgraded came from arenas. Only the more complex non-
1404 upgradable types are allowed to be directly malloc()ed. */
1406 my_safefree(old_body);
1408 del_body((void*)((char*)old_body + old_type_details->offset),
1409 &PL_body_roots[old_type]);
1415 =for apidoc sv_backoff
1417 Remove any string offset. You should normally use the C<SvOOK_off> macro
1424 Perl_sv_backoff(pTHX_ register SV *const sv)
1427 const char * const s = SvPVX_const(sv);
1429 PERL_ARGS_ASSERT_SV_BACKOFF;
1430 PERL_UNUSED_CONTEXT;
1433 assert(SvTYPE(sv) != SVt_PVHV);
1434 assert(SvTYPE(sv) != SVt_PVAV);
1436 SvOOK_offset(sv, delta);
1438 SvLEN_set(sv, SvLEN(sv) + delta);
1439 SvPV_set(sv, SvPVX(sv) - delta);
1440 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1441 SvFLAGS(sv) &= ~SVf_OOK;
1448 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1449 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1450 Use the C<SvGROW> wrapper instead.
1456 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1460 PERL_ARGS_ASSERT_SV_GROW;
1462 if (PL_madskills && newlen >= 0x100000) {
1463 PerlIO_printf(Perl_debug_log,
1464 "Allocation too large: %"UVxf"\n", (UV)newlen);
1466 #ifdef HAS_64K_LIMIT
1467 if (newlen >= 0x10000) {
1468 PerlIO_printf(Perl_debug_log,
1469 "Allocation too large: %"UVxf"\n", (UV)newlen);
1472 #endif /* HAS_64K_LIMIT */
1475 if (SvTYPE(sv) < SVt_PV) {
1476 sv_upgrade(sv, SVt_PV);
1477 s = SvPVX_mutable(sv);
1479 else if (SvOOK(sv)) { /* pv is offset? */
1481 s = SvPVX_mutable(sv);
1482 if (newlen > SvLEN(sv))
1483 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1484 #ifdef HAS_64K_LIMIT
1485 if (newlen >= 0x10000)
1490 s = SvPVX_mutable(sv);
1492 if (newlen > SvLEN(sv)) { /* need more room? */
1494 newlen = PERL_STRLEN_ROUNDUP(newlen);
1496 if (SvLEN(sv) && s) {
1497 s = (char*)saferealloc(s, newlen);
1500 s = (char*)safemalloc(newlen);
1501 if (SvPVX_const(sv) && SvCUR(sv)) {
1502 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1506 #ifdef Perl_safesysmalloc_size
1507 /* Do this here, do it once, do it right, and then we will never get
1508 called back into sv_grow() unless there really is some growing
1510 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1512 SvLEN_set(sv, newlen);
1519 =for apidoc sv_setiv
1521 Copies an integer into the given SV, upgrading first if necessary.
1522 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1528 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1532 PERL_ARGS_ASSERT_SV_SETIV;
1534 SV_CHECK_THINKFIRST_COW_DROP(sv);
1535 switch (SvTYPE(sv)) {
1538 sv_upgrade(sv, SVt_IV);
1541 sv_upgrade(sv, SVt_PVIV);
1550 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1554 (void)SvIOK_only(sv); /* validate number */
1560 =for apidoc sv_setiv_mg
1562 Like C<sv_setiv>, but also handles 'set' magic.
1568 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1570 PERL_ARGS_ASSERT_SV_SETIV_MG;
1577 =for apidoc sv_setuv
1579 Copies an unsigned integer into the given SV, upgrading first if necessary.
1580 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1586 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1588 PERL_ARGS_ASSERT_SV_SETUV;
1590 /* With these two if statements:
1591 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1594 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1596 If you wish to remove them, please benchmark to see what the effect is
1598 if (u <= (UV)IV_MAX) {
1599 sv_setiv(sv, (IV)u);
1608 =for apidoc sv_setuv_mg
1610 Like C<sv_setuv>, but also handles 'set' magic.
1616 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1618 PERL_ARGS_ASSERT_SV_SETUV_MG;
1625 =for apidoc sv_setnv
1627 Copies a double into the given SV, upgrading first if necessary.
1628 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1634 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1638 PERL_ARGS_ASSERT_SV_SETNV;
1640 SV_CHECK_THINKFIRST_COW_DROP(sv);
1641 switch (SvTYPE(sv)) {
1644 sv_upgrade(sv, SVt_NV);
1648 sv_upgrade(sv, SVt_PVNV);
1657 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1662 (void)SvNOK_only(sv); /* validate number */
1667 =for apidoc sv_setnv_mg
1669 Like C<sv_setnv>, but also handles 'set' magic.
1675 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1677 PERL_ARGS_ASSERT_SV_SETNV_MG;
1683 /* Print an "isn't numeric" warning, using a cleaned-up,
1684 * printable version of the offending string
1688 S_not_a_number(pTHX_ SV *const sv)
1695 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1698 dsv = newSVpvs_flags("", SVs_TEMP);
1699 pv = sv_uni_display(dsv, sv, 10, 0);
1702 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1703 /* each *s can expand to 4 chars + "...\0",
1704 i.e. need room for 8 chars */
1706 const char *s = SvPVX_const(sv);
1707 const char * const end = s + SvCUR(sv);
1708 for ( ; s < end && d < limit; s++ ) {
1710 if (ch & 128 && !isPRINT_LC(ch)) {
1719 else if (ch == '\r') {
1723 else if (ch == '\f') {
1727 else if (ch == '\\') {
1731 else if (ch == '\0') {
1735 else if (isPRINT_LC(ch))
1752 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1753 "Argument \"%s\" isn't numeric in %s", pv,
1756 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1757 "Argument \"%s\" isn't numeric", pv);
1761 =for apidoc looks_like_number
1763 Test if the content of an SV looks like a number (or is a number).
1764 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1765 non-numeric warning), even if your atof() doesn't grok them.
1771 Perl_looks_like_number(pTHX_ SV *const sv)
1773 register const char *sbegin;
1776 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1779 sbegin = SvPVX_const(sv);
1782 else if (SvPOKp(sv))
1783 sbegin = SvPV_const(sv, len);
1785 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1786 return grok_number(sbegin, len, NULL);
1790 S_glob_2number(pTHX_ GV * const gv)
1792 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1793 SV *const buffer = sv_newmortal();
1795 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1797 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1800 gv_efullname3(buffer, gv, "*");
1801 SvFLAGS(gv) |= wasfake;
1803 /* We know that all GVs stringify to something that is not-a-number,
1804 so no need to test that. */
1805 if (ckWARN(WARN_NUMERIC))
1806 not_a_number(buffer);
1807 /* We just want something true to return, so that S_sv_2iuv_common
1808 can tail call us and return true. */
1813 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1815 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1816 SV *const buffer = sv_newmortal();
1818 PERL_ARGS_ASSERT_GLOB_2PV;
1820 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1823 gv_efullname3(buffer, gv, "*");
1824 SvFLAGS(gv) |= wasfake;
1826 assert(SvPOK(buffer));
1828 *len = SvCUR(buffer);
1830 return SvPVX(buffer);
1833 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1834 until proven guilty, assume that things are not that bad... */
1839 As 64 bit platforms often have an NV that doesn't preserve all bits of
1840 an IV (an assumption perl has been based on to date) it becomes necessary
1841 to remove the assumption that the NV always carries enough precision to
1842 recreate the IV whenever needed, and that the NV is the canonical form.
1843 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1844 precision as a side effect of conversion (which would lead to insanity
1845 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1846 1) to distinguish between IV/UV/NV slots that have cached a valid
1847 conversion where precision was lost and IV/UV/NV slots that have a
1848 valid conversion which has lost no precision
1849 2) to ensure that if a numeric conversion to one form is requested that
1850 would lose precision, the precise conversion (or differently
1851 imprecise conversion) is also performed and cached, to prevent
1852 requests for different numeric formats on the same SV causing
1853 lossy conversion chains. (lossless conversion chains are perfectly
1858 SvIOKp is true if the IV slot contains a valid value
1859 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1860 SvNOKp is true if the NV slot contains a valid value
1861 SvNOK is true only if the NV value is accurate
1864 while converting from PV to NV, check to see if converting that NV to an
1865 IV(or UV) would lose accuracy over a direct conversion from PV to
1866 IV(or UV). If it would, cache both conversions, return NV, but mark
1867 SV as IOK NOKp (ie not NOK).
1869 While converting from PV to IV, check to see if converting that IV to an
1870 NV would lose accuracy over a direct conversion from PV to NV. If it
1871 would, cache both conversions, flag similarly.
1873 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1874 correctly because if IV & NV were set NV *always* overruled.
1875 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1876 changes - now IV and NV together means that the two are interchangeable:
1877 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1879 The benefit of this is that operations such as pp_add know that if
1880 SvIOK is true for both left and right operands, then integer addition
1881 can be used instead of floating point (for cases where the result won't
1882 overflow). Before, floating point was always used, which could lead to
1883 loss of precision compared with integer addition.
1885 * making IV and NV equal status should make maths accurate on 64 bit
1887 * may speed up maths somewhat if pp_add and friends start to use
1888 integers when possible instead of fp. (Hopefully the overhead in
1889 looking for SvIOK and checking for overflow will not outweigh the
1890 fp to integer speedup)
1891 * will slow down integer operations (callers of SvIV) on "inaccurate"
1892 values, as the change from SvIOK to SvIOKp will cause a call into
1893 sv_2iv each time rather than a macro access direct to the IV slot
1894 * should speed up number->string conversion on integers as IV is
1895 favoured when IV and NV are equally accurate
1897 ####################################################################
1898 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1899 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1900 On the other hand, SvUOK is true iff UV.
1901 ####################################################################
1903 Your mileage will vary depending your CPU's relative fp to integer
1907 #ifndef NV_PRESERVES_UV
1908 # define IS_NUMBER_UNDERFLOW_IV 1
1909 # define IS_NUMBER_UNDERFLOW_UV 2
1910 # define IS_NUMBER_IV_AND_UV 2
1911 # define IS_NUMBER_OVERFLOW_IV 4
1912 # define IS_NUMBER_OVERFLOW_UV 5
1914 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1916 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1918 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1926 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1928 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));
1929 if (SvNVX(sv) < (NV)IV_MIN) {
1930 (void)SvIOKp_on(sv);
1932 SvIV_set(sv, IV_MIN);
1933 return IS_NUMBER_UNDERFLOW_IV;
1935 if (SvNVX(sv) > (NV)UV_MAX) {
1936 (void)SvIOKp_on(sv);
1939 SvUV_set(sv, UV_MAX);
1940 return IS_NUMBER_OVERFLOW_UV;
1942 (void)SvIOKp_on(sv);
1944 /* Can't use strtol etc to convert this string. (See truth table in
1946 if (SvNVX(sv) <= (UV)IV_MAX) {
1947 SvIV_set(sv, I_V(SvNVX(sv)));
1948 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1949 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1951 /* Integer is imprecise. NOK, IOKp */
1953 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1956 SvUV_set(sv, U_V(SvNVX(sv)));
1957 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1958 if (SvUVX(sv) == UV_MAX) {
1959 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1960 possibly be preserved by NV. Hence, it must be overflow.
1962 return IS_NUMBER_OVERFLOW_UV;
1964 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1966 /* Integer is imprecise. NOK, IOKp */
1968 return IS_NUMBER_OVERFLOW_IV;
1970 #endif /* !NV_PRESERVES_UV*/
1973 S_sv_2iuv_common(pTHX_ SV *const sv)
1977 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1980 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1981 * without also getting a cached IV/UV from it at the same time
1982 * (ie PV->NV conversion should detect loss of accuracy and cache
1983 * IV or UV at same time to avoid this. */
1984 /* IV-over-UV optimisation - choose to cache IV if possible */
1986 if (SvTYPE(sv) == SVt_NV)
1987 sv_upgrade(sv, SVt_PVNV);
1989 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1990 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1991 certainly cast into the IV range at IV_MAX, whereas the correct
1992 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1994 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1995 if (Perl_isnan(SvNVX(sv))) {
2001 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2002 SvIV_set(sv, I_V(SvNVX(sv)));
2003 if (SvNVX(sv) == (NV) SvIVX(sv)
2004 #ifndef NV_PRESERVES_UV
2005 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2006 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2007 /* Don't flag it as "accurately an integer" if the number
2008 came from a (by definition imprecise) NV operation, and
2009 we're outside the range of NV integer precision */
2013 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2015 /* scalar has trailing garbage, eg "42a" */
2017 DEBUG_c(PerlIO_printf(Perl_debug_log,
2018 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2024 /* IV not precise. No need to convert from PV, as NV
2025 conversion would already have cached IV if it detected
2026 that PV->IV would be better than PV->NV->IV
2027 flags already correct - don't set public IOK. */
2028 DEBUG_c(PerlIO_printf(Perl_debug_log,
2029 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2034 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2035 but the cast (NV)IV_MIN rounds to a the value less (more
2036 negative) than IV_MIN which happens to be equal to SvNVX ??
2037 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2038 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2039 (NV)UVX == NVX are both true, but the values differ. :-(
2040 Hopefully for 2s complement IV_MIN is something like
2041 0x8000000000000000 which will be exact. NWC */
2044 SvUV_set(sv, U_V(SvNVX(sv)));
2046 (SvNVX(sv) == (NV) SvUVX(sv))
2047 #ifndef NV_PRESERVES_UV
2048 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2049 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2050 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2051 /* Don't flag it as "accurately an integer" if the number
2052 came from a (by definition imprecise) NV operation, and
2053 we're outside the range of NV integer precision */
2059 DEBUG_c(PerlIO_printf(Perl_debug_log,
2060 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2066 else if (SvPOKp(sv) && SvLEN(sv)) {
2068 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2069 /* We want to avoid a possible problem when we cache an IV/ a UV which
2070 may be later translated to an NV, and the resulting NV is not
2071 the same as the direct translation of the initial string
2072 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2073 be careful to ensure that the value with the .456 is around if the
2074 NV value is requested in the future).
2076 This means that if we cache such an IV/a UV, we need to cache the
2077 NV as well. Moreover, we trade speed for space, and do not
2078 cache the NV if we are sure it's not needed.
2081 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2082 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2083 == IS_NUMBER_IN_UV) {
2084 /* It's definitely an integer, only upgrade to PVIV */
2085 if (SvTYPE(sv) < SVt_PVIV)
2086 sv_upgrade(sv, SVt_PVIV);
2088 } else if (SvTYPE(sv) < SVt_PVNV)
2089 sv_upgrade(sv, SVt_PVNV);
2091 /* If NVs preserve UVs then we only use the UV value if we know that
2092 we aren't going to call atof() below. If NVs don't preserve UVs
2093 then the value returned may have more precision than atof() will
2094 return, even though value isn't perfectly accurate. */
2095 if ((numtype & (IS_NUMBER_IN_UV
2096 #ifdef NV_PRESERVES_UV
2099 )) == IS_NUMBER_IN_UV) {
2100 /* This won't turn off the public IOK flag if it was set above */
2101 (void)SvIOKp_on(sv);
2103 if (!(numtype & IS_NUMBER_NEG)) {
2105 if (value <= (UV)IV_MAX) {
2106 SvIV_set(sv, (IV)value);
2108 /* it didn't overflow, and it was positive. */
2109 SvUV_set(sv, value);
2113 /* 2s complement assumption */
2114 if (value <= (UV)IV_MIN) {
2115 SvIV_set(sv, -(IV)value);
2117 /* Too negative for an IV. This is a double upgrade, but
2118 I'm assuming it will be rare. */
2119 if (SvTYPE(sv) < SVt_PVNV)
2120 sv_upgrade(sv, SVt_PVNV);
2124 SvNV_set(sv, -(NV)value);
2125 SvIV_set(sv, IV_MIN);
2129 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2130 will be in the previous block to set the IV slot, and the next
2131 block to set the NV slot. So no else here. */
2133 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2134 != IS_NUMBER_IN_UV) {
2135 /* It wasn't an (integer that doesn't overflow the UV). */
2136 SvNV_set(sv, Atof(SvPVX_const(sv)));
2138 if (! numtype && ckWARN(WARN_NUMERIC))
2141 #if defined(USE_LONG_DOUBLE)
2142 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2143 PTR2UV(sv), SvNVX(sv)));
2145 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2146 PTR2UV(sv), SvNVX(sv)));
2149 #ifdef NV_PRESERVES_UV
2150 (void)SvIOKp_on(sv);
2152 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2153 SvIV_set(sv, I_V(SvNVX(sv)));
2154 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2157 NOOP; /* Integer is imprecise. NOK, IOKp */
2159 /* UV will not work better than IV */
2161 if (SvNVX(sv) > (NV)UV_MAX) {
2163 /* Integer is inaccurate. NOK, IOKp, is UV */
2164 SvUV_set(sv, UV_MAX);
2166 SvUV_set(sv, U_V(SvNVX(sv)));
2167 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2168 NV preservse UV so can do correct comparison. */
2169 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2172 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2177 #else /* NV_PRESERVES_UV */
2178 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2179 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2180 /* The IV/UV slot will have been set from value returned by
2181 grok_number above. The NV slot has just been set using
2184 assert (SvIOKp(sv));
2186 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2187 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2188 /* Small enough to preserve all bits. */
2189 (void)SvIOKp_on(sv);
2191 SvIV_set(sv, I_V(SvNVX(sv)));
2192 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2194 /* Assumption: first non-preserved integer is < IV_MAX,
2195 this NV is in the preserved range, therefore: */
2196 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2198 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);
2202 0 0 already failed to read UV.
2203 0 1 already failed to read UV.
2204 1 0 you won't get here in this case. IV/UV
2205 slot set, public IOK, Atof() unneeded.
2206 1 1 already read UV.
2207 so there's no point in sv_2iuv_non_preserve() attempting
2208 to use atol, strtol, strtoul etc. */
2210 sv_2iuv_non_preserve (sv, numtype);
2212 sv_2iuv_non_preserve (sv);
2216 #endif /* NV_PRESERVES_UV */
2217 /* It might be more code efficient to go through the entire logic above
2218 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2219 gets complex and potentially buggy, so more programmer efficient
2220 to do it this way, by turning off the public flags: */
2222 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2226 if (isGV_with_GP(sv))
2227 return glob_2number((GV *)sv);
2229 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2230 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2233 if (SvTYPE(sv) < SVt_IV)
2234 /* Typically the caller expects that sv_any is not NULL now. */
2235 sv_upgrade(sv, SVt_IV);
2236 /* Return 0 from the caller. */
2243 =for apidoc sv_2iv_flags
2245 Return the integer value of an SV, doing any necessary string
2246 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2247 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2253 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2258 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2259 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2260 cache IVs just in case. In practice it seems that they never
2261 actually anywhere accessible by user Perl code, let alone get used
2262 in anything other than a string context. */
2263 if (flags & SV_GMAGIC)
2268 return I_V(SvNVX(sv));
2270 if (SvPOKp(sv) && SvLEN(sv)) {
2273 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2275 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2276 == IS_NUMBER_IN_UV) {
2277 /* It's definitely an integer */
2278 if (numtype & IS_NUMBER_NEG) {
2279 if (value < (UV)IV_MIN)
2282 if (value < (UV)IV_MAX)
2287 if (ckWARN(WARN_NUMERIC))
2290 return I_V(Atof(SvPVX_const(sv)));
2295 assert(SvTYPE(sv) >= SVt_PVMG);
2296 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2297 } else if (SvTHINKFIRST(sv)) {
2301 SV * const tmpstr=AMG_CALLun(sv,numer);
2302 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2303 return SvIV(tmpstr);
2306 return PTR2IV(SvRV(sv));
2309 sv_force_normal_flags(sv, 0);
2311 if (SvREADONLY(sv) && !SvOK(sv)) {
2312 if (ckWARN(WARN_UNINITIALIZED))
2318 if (S_sv_2iuv_common(aTHX_ sv))
2321 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2322 PTR2UV(sv),SvIVX(sv)));
2323 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2327 =for apidoc sv_2uv_flags
2329 Return the unsigned integer value of an SV, doing any necessary string
2330 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2331 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2337 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2342 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2343 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2344 cache IVs just in case. */
2345 if (flags & SV_GMAGIC)
2350 return U_V(SvNVX(sv));
2351 if (SvPOKp(sv) && SvLEN(sv)) {
2354 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2356 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2357 == IS_NUMBER_IN_UV) {
2358 /* It's definitely an integer */
2359 if (!(numtype & IS_NUMBER_NEG))
2363 if (ckWARN(WARN_NUMERIC))
2366 return U_V(Atof(SvPVX_const(sv)));
2371 assert(SvTYPE(sv) >= SVt_PVMG);
2372 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2373 } else if (SvTHINKFIRST(sv)) {
2377 SV *const tmpstr = AMG_CALLun(sv,numer);
2378 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2379 return SvUV(tmpstr);
2382 return PTR2UV(SvRV(sv));
2385 sv_force_normal_flags(sv, 0);
2387 if (SvREADONLY(sv) && !SvOK(sv)) {
2388 if (ckWARN(WARN_UNINITIALIZED))
2394 if (S_sv_2iuv_common(aTHX_ sv))
2398 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2399 PTR2UV(sv),SvUVX(sv)));
2400 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2406 Return the num value of an SV, doing any necessary string or integer
2407 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2414 Perl_sv_2nv(pTHX_ register SV *const sv)
2419 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2420 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2421 cache IVs just in case. */
2425 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2426 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2427 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2429 return Atof(SvPVX_const(sv));
2433 return (NV)SvUVX(sv);
2435 return (NV)SvIVX(sv);
2440 assert(SvTYPE(sv) >= SVt_PVMG);
2441 /* This falls through to the report_uninit near the end of the
2443 } else if (SvTHINKFIRST(sv)) {
2447 SV *const tmpstr = AMG_CALLun(sv,numer);
2448 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2449 return SvNV(tmpstr);
2452 return PTR2NV(SvRV(sv));
2455 sv_force_normal_flags(sv, 0);
2457 if (SvREADONLY(sv) && !SvOK(sv)) {
2458 if (ckWARN(WARN_UNINITIALIZED))
2463 if (SvTYPE(sv) < SVt_NV) {
2464 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2465 sv_upgrade(sv, SVt_NV);
2466 #ifdef USE_LONG_DOUBLE
2468 STORE_NUMERIC_LOCAL_SET_STANDARD();
2469 PerlIO_printf(Perl_debug_log,
2470 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2471 PTR2UV(sv), SvNVX(sv));
2472 RESTORE_NUMERIC_LOCAL();
2476 STORE_NUMERIC_LOCAL_SET_STANDARD();
2477 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2478 PTR2UV(sv), SvNVX(sv));
2479 RESTORE_NUMERIC_LOCAL();
2483 else if (SvTYPE(sv) < SVt_PVNV)
2484 sv_upgrade(sv, SVt_PVNV);
2489 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2490 #ifdef NV_PRESERVES_UV
2496 /* Only set the public NV OK flag if this NV preserves the IV */
2497 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2499 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2500 : (SvIVX(sv) == I_V(SvNVX(sv))))
2506 else if (SvPOKp(sv) && SvLEN(sv)) {
2508 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2509 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2511 #ifdef NV_PRESERVES_UV
2512 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2513 == IS_NUMBER_IN_UV) {
2514 /* It's definitely an integer */
2515 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2517 SvNV_set(sv, Atof(SvPVX_const(sv)));
2523 SvNV_set(sv, Atof(SvPVX_const(sv)));
2524 /* Only set the public NV OK flag if this NV preserves the value in
2525 the PV at least as well as an IV/UV would.
2526 Not sure how to do this 100% reliably. */
2527 /* if that shift count is out of range then Configure's test is
2528 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2530 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2531 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2532 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2533 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2534 /* Can't use strtol etc to convert this string, so don't try.
2535 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2538 /* value has been set. It may not be precise. */
2539 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2540 /* 2s complement assumption for (UV)IV_MIN */
2541 SvNOK_on(sv); /* Integer is too negative. */
2546 if (numtype & IS_NUMBER_NEG) {
2547 SvIV_set(sv, -(IV)value);
2548 } else if (value <= (UV)IV_MAX) {
2549 SvIV_set(sv, (IV)value);
2551 SvUV_set(sv, value);
2555 if (numtype & IS_NUMBER_NOT_INT) {
2556 /* I believe that even if the original PV had decimals,
2557 they are lost beyond the limit of the FP precision.
2558 However, neither is canonical, so both only get p
2559 flags. NWC, 2000/11/25 */
2560 /* Both already have p flags, so do nothing */
2562 const NV nv = SvNVX(sv);
2563 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2564 if (SvIVX(sv) == I_V(nv)) {
2567 /* It had no "." so it must be integer. */
2571 /* between IV_MAX and NV(UV_MAX).
2572 Could be slightly > UV_MAX */
2574 if (numtype & IS_NUMBER_NOT_INT) {
2575 /* UV and NV both imprecise. */
2577 const UV nv_as_uv = U_V(nv);
2579 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2588 /* It might be more code efficient to go through the entire logic above
2589 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2590 gets complex and potentially buggy, so more programmer efficient
2591 to do it this way, by turning off the public flags: */
2593 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2594 #endif /* NV_PRESERVES_UV */
2597 if (isGV_with_GP(sv)) {
2598 glob_2number((GV *)sv);
2602 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2604 assert (SvTYPE(sv) >= SVt_NV);
2605 /* Typically the caller expects that sv_any is not NULL now. */
2606 /* XXX Ilya implies that this is a bug in callers that assume this
2607 and ideally should be fixed. */
2610 #if defined(USE_LONG_DOUBLE)
2612 STORE_NUMERIC_LOCAL_SET_STANDARD();
2613 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2614 PTR2UV(sv), SvNVX(sv));
2615 RESTORE_NUMERIC_LOCAL();
2619 STORE_NUMERIC_LOCAL_SET_STANDARD();
2620 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2621 PTR2UV(sv), SvNVX(sv));
2622 RESTORE_NUMERIC_LOCAL();
2631 Return an SV with the numeric value of the source SV, doing any necessary
2632 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2633 access this function.
2639 Perl_sv_2num(pTHX_ register SV *const sv)
2641 PERL_ARGS_ASSERT_SV_2NUM;
2646 SV * const tmpsv = AMG_CALLun(sv,numer);
2647 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2648 return sv_2num(tmpsv);
2650 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2653 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2654 * UV as a string towards the end of buf, and return pointers to start and
2657 * We assume that buf is at least TYPE_CHARS(UV) long.
2661 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2663 char *ptr = buf + TYPE_CHARS(UV);
2664 char * const ebuf = ptr;
2667 PERL_ARGS_ASSERT_UIV_2BUF;
2679 *--ptr = '0' + (char)(uv % 10);
2688 =for apidoc sv_2pv_flags
2690 Returns a pointer to the string value of an SV, and sets *lp to its length.
2691 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2693 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2694 usually end up here too.
2700 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2710 if (SvGMAGICAL(sv)) {
2711 if (flags & SV_GMAGIC)
2716 if (flags & SV_MUTABLE_RETURN)
2717 return SvPVX_mutable(sv);
2718 if (flags & SV_CONST_RETURN)
2719 return (char *)SvPVX_const(sv);
2722 if (SvIOKp(sv) || SvNOKp(sv)) {
2723 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2728 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2729 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2731 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2738 #ifdef FIXNEGATIVEZERO
2739 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2745 SvUPGRADE(sv, SVt_PV);
2748 s = SvGROW_mutable(sv, len + 1);
2751 return (char*)memcpy(s, tbuf, len + 1);
2757 assert(SvTYPE(sv) >= SVt_PVMG);
2758 /* This falls through to the report_uninit near the end of the
2760 } else if (SvTHINKFIRST(sv)) {
2764 SV *const tmpstr = AMG_CALLun(sv,string);
2765 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2767 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2771 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2772 if (flags & SV_CONST_RETURN) {
2773 pv = (char *) SvPVX_const(tmpstr);
2775 pv = (flags & SV_MUTABLE_RETURN)
2776 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2779 *lp = SvCUR(tmpstr);
2781 pv = sv_2pv_flags(tmpstr, lp, flags);
2794 const SV *const referent = (SV*)SvRV(sv);
2798 retval = buffer = savepvn("NULLREF", len);
2799 } else if (SvTYPE(referent) == SVt_REGEXP) {
2800 const REGEXP * const re = (REGEXP *)referent;
2805 /* If the regex is UTF-8 we want the containing scalar to
2806 have an UTF-8 flag too */
2812 if ((seen_evals = RX_SEEN_EVALS(re)))
2813 PL_reginterp_cnt += seen_evals;
2816 *lp = RX_WRAPLEN(re);
2818 return RX_WRAPPED(re);
2820 const char *const typestr = sv_reftype(referent, 0);
2821 const STRLEN typelen = strlen(typestr);
2822 UV addr = PTR2UV(referent);
2823 const char *stashname = NULL;
2824 STRLEN stashnamelen = 0; /* hush, gcc */
2825 const char *buffer_end;
2827 if (SvOBJECT(referent)) {
2828 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2831 stashname = HEK_KEY(name);
2832 stashnamelen = HEK_LEN(name);
2834 if (HEK_UTF8(name)) {
2840 stashname = "__ANON__";
2843 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2844 + 2 * sizeof(UV) + 2 /* )\0 */;
2846 len = typelen + 3 /* (0x */
2847 + 2 * sizeof(UV) + 2 /* )\0 */;
2850 Newx(buffer, len, char);
2851 buffer_end = retval = buffer + len;
2853 /* Working backwards */
2857 *--retval = PL_hexdigit[addr & 15];
2858 } while (addr >>= 4);
2864 memcpy(retval, typestr, typelen);
2868 retval -= stashnamelen;
2869 memcpy(retval, stashname, stashnamelen);
2871 /* retval may not neccesarily have reached the start of the
2873 assert (retval >= buffer);
2875 len = buffer_end - retval - 1; /* -1 for that \0 */
2883 if (SvREADONLY(sv) && !SvOK(sv)) {
2886 if (flags & SV_UNDEF_RETURNS_NULL)
2888 if (ckWARN(WARN_UNINITIALIZED))
2893 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2894 /* I'm assuming that if both IV and NV are equally valid then
2895 converting the IV is going to be more efficient */
2896 const U32 isUIOK = SvIsUV(sv);
2897 char buf[TYPE_CHARS(UV)];
2901 if (SvTYPE(sv) < SVt_PVIV)
2902 sv_upgrade(sv, SVt_PVIV);
2903 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2905 /* inlined from sv_setpvn */
2906 s = SvGROW_mutable(sv, len + 1);
2907 Move(ptr, s, len, char);
2911 else if (SvNOKp(sv)) {
2912 const int olderrno = errno;
2913 if (SvTYPE(sv) < SVt_PVNV)
2914 sv_upgrade(sv, SVt_PVNV);
2915 /* The +20 is pure guesswork. Configure test needed. --jhi */
2916 s = SvGROW_mutable(sv, NV_DIG + 20);
2917 /* some Xenix systems wipe out errno here */
2919 if (SvNVX(sv) == 0.0)
2920 my_strlcpy(s, "0", SvLEN(sv));
2924 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2927 #ifdef FIXNEGATIVEZERO
2928 if (*s == '-' && s[1] == '0' && !s[2]) {
2940 if (isGV_with_GP(sv))
2941 return glob_2pv((GV *)sv, lp);
2945 if (flags & SV_UNDEF_RETURNS_NULL)
2947 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2949 if (SvTYPE(sv) < SVt_PV)
2950 /* Typically the caller expects that sv_any is not NULL now. */
2951 sv_upgrade(sv, SVt_PV);
2955 const STRLEN len = s - SvPVX_const(sv);
2961 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2962 PTR2UV(sv),SvPVX_const(sv)));
2963 if (flags & SV_CONST_RETURN)
2964 return (char *)SvPVX_const(sv);
2965 if (flags & SV_MUTABLE_RETURN)
2966 return SvPVX_mutable(sv);
2971 =for apidoc sv_copypv
2973 Copies a stringified representation of the source SV into the
2974 destination SV. Automatically performs any necessary mg_get and
2975 coercion of numeric values into strings. Guaranteed to preserve
2976 UTF8 flag even from overloaded objects. Similar in nature to
2977 sv_2pv[_flags] but operates directly on an SV instead of just the
2978 string. Mostly uses sv_2pv_flags to do its work, except when that
2979 would lose the UTF-8'ness of the PV.
2985 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2988 const char * const s = SvPV_const(ssv,len);
2990 PERL_ARGS_ASSERT_SV_COPYPV;
2992 sv_setpvn(dsv,s,len);
3000 =for apidoc sv_2pvbyte
3002 Return a pointer to the byte-encoded representation of the SV, and set *lp
3003 to its length. May cause the SV to be downgraded from UTF-8 as a
3006 Usually accessed via the C<SvPVbyte> macro.
3012 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3014 PERL_ARGS_ASSERT_SV_2PVBYTE;
3016 sv_utf8_downgrade(sv,0);
3017 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3021 =for apidoc sv_2pvutf8
3023 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3024 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3026 Usually accessed via the C<SvPVutf8> macro.
3032 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3034 PERL_ARGS_ASSERT_SV_2PVUTF8;
3036 sv_utf8_upgrade(sv);
3037 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3042 =for apidoc sv_2bool
3044 This function is only called on magical items, and is only used by
3045 sv_true() or its macro equivalent.
3051 Perl_sv_2bool(pTHX_ register SV *const sv)
3055 PERL_ARGS_ASSERT_SV_2BOOL;
3063 SV * const tmpsv = AMG_CALLun(sv,bool_);
3064 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3065 return (bool)SvTRUE(tmpsv);
3067 return SvRV(sv) != 0;
3070 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3072 (*sv->sv_u.svu_pv > '0' ||
3073 Xpvtmp->xpv_cur > 1 ||
3074 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3081 return SvIVX(sv) != 0;
3084 return SvNVX(sv) != 0.0;
3086 if (isGV_with_GP(sv))
3096 =for apidoc sv_utf8_upgrade
3098 Converts the PV of an SV to its UTF-8-encoded form.
3099 Forces the SV to string form if it is not already.
3100 Always sets the SvUTF8 flag to avoid future validity checks even
3101 if all the bytes have hibit clear.
3103 This is not as a general purpose byte encoding to Unicode interface:
3104 use the Encode extension for that.
3106 =for apidoc sv_utf8_upgrade_flags
3108 Converts the PV of an SV to its UTF-8-encoded form.
3109 Forces the SV to string form if it is not already.
3110 Always sets the SvUTF8 flag to avoid future validity checks even
3111 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3112 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3113 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3115 This is not as a general purpose byte encoding to Unicode interface:
3116 use the Encode extension for that.
3122 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3126 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3128 if (sv == &PL_sv_undef)
3132 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3133 (void) sv_2pv_flags(sv,&len, flags);
3137 (void) SvPV_force(sv,len);
3146 sv_force_normal_flags(sv, 0);
3149 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3150 sv_recode_to_utf8(sv, PL_encoding);
3151 else { /* Assume Latin-1/EBCDIC */
3152 /* This function could be much more efficient if we
3153 * had a FLAG in SVs to signal if there are any hibit
3154 * chars in the PV. Given that there isn't such a flag
3155 * make the loop as fast as possible. */
3156 const U8 * const s = (U8 *) SvPVX_const(sv);
3157 const U8 * const e = (U8 *) SvEND(sv);
3162 /* Check for hi bit */
3163 if (!NATIVE_IS_INVARIANT(ch)) {
3164 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3165 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3167 SvPV_free(sv); /* No longer using what was there before. */
3168 SvPV_set(sv, (char*)recoded);
3169 SvCUR_set(sv, len - 1);
3170 SvLEN_set(sv, len); /* No longer know the real size. */
3174 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3181 =for apidoc sv_utf8_downgrade
3183 Attempts to convert the PV of an SV from characters to bytes.
3184 If the PV contains a character beyond byte, this conversion will fail;
3185 in this case, either returns false or, if C<fail_ok> is not
3188 This is not as a general purpose Unicode to byte encoding interface:
3189 use the Encode extension for that.
3195 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3199 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3201 if (SvPOKp(sv) && SvUTF8(sv)) {
3207 sv_force_normal_flags(sv, 0);
3209 s = (U8 *) SvPV(sv, len);
3210 if (!utf8_to_bytes(s, &len)) {
3215 Perl_croak(aTHX_ "Wide character in %s",
3218 Perl_croak(aTHX_ "Wide character");
3229 =for apidoc sv_utf8_encode
3231 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3232 flag off so that it looks like octets again.
3238 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3240 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3243 sv_force_normal_flags(sv, 0);
3245 if (SvREADONLY(sv)) {
3246 Perl_croak(aTHX_ PL_no_modify);
3248 (void) sv_utf8_upgrade(sv);
3253 =for apidoc sv_utf8_decode
3255 If the PV of the SV is an octet sequence in UTF-8
3256 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3257 so that it looks like a character. If the PV contains only single-byte
3258 characters, the C<SvUTF8> flag stays being off.
3259 Scans PV for validity and returns false if the PV is invalid UTF-8.
3265 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3267 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3273 /* The octets may have got themselves encoded - get them back as
3276 if (!sv_utf8_downgrade(sv, TRUE))
3279 /* it is actually just a matter of turning the utf8 flag on, but
3280 * we want to make sure everything inside is valid utf8 first.
3282 c = (const U8 *) SvPVX_const(sv);
3283 if (!is_utf8_string(c, SvCUR(sv)+1))
3285 e = (const U8 *) SvEND(sv);
3288 if (!UTF8_IS_INVARIANT(ch)) {
3298 =for apidoc sv_setsv
3300 Copies the contents of the source SV C<ssv> into the destination SV
3301 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3302 function if the source SV needs to be reused. Does not handle 'set' magic.
3303 Loosely speaking, it performs a copy-by-value, obliterating any previous
3304 content of the destination.
3306 You probably want to use one of the assortment of wrappers, such as
3307 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3308 C<SvSetMagicSV_nosteal>.
3310 =for apidoc sv_setsv_flags
3312 Copies the contents of the source SV C<ssv> into the destination SV
3313 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3314 function if the source SV needs to be reused. Does not handle 'set' magic.
3315 Loosely speaking, it performs a copy-by-value, obliterating any previous
3316 content of the destination.
3317 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3318 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3319 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3320 and C<sv_setsv_nomg> are implemented in terms of this function.
3322 You probably want to use one of the assortment of wrappers, such as
3323 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3324 C<SvSetMagicSV_nosteal>.
3326 This is the primary function for copying scalars, and most other
3327 copy-ish functions and macros use this underneath.
3333 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3335 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3337 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3339 if (dtype != SVt_PVGV) {
3340 const char * const name = GvNAME(sstr);
3341 const STRLEN len = GvNAMELEN(sstr);
3343 if (dtype >= SVt_PV) {
3349 SvUPGRADE(dstr, SVt_PVGV);
3350 (void)SvOK_off(dstr);
3351 /* FIXME - why are we doing this, then turning it off and on again
3353 isGV_with_GP_on(dstr);
3355 GvSTASH(dstr) = GvSTASH(sstr);
3357 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3358 gv_name_set((GV *)dstr, name, len, GV_ADD);
3359 SvFAKE_on(dstr); /* can coerce to non-glob */
3362 #ifdef GV_UNIQUE_CHECK
3363 if (GvUNIQUE((GV*)dstr)) {
3364 Perl_croak(aTHX_ PL_no_modify);
3368 if(GvGP((GV*)sstr)) {
3369 /* If source has method cache entry, clear it */
3371 SvREFCNT_dec(GvCV(sstr));
3375 /* If source has a real method, then a method is
3377 else if(GvCV((GV*)sstr)) {
3382 /* If dest already had a real method, that's a change as well */
3383 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3387 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3391 isGV_with_GP_off(dstr);
3392 (void)SvOK_off(dstr);
3393 isGV_with_GP_on(dstr);
3394 GvINTRO_off(dstr); /* one-shot flag */
3395 GvGP(dstr) = gp_ref(GvGP(sstr));
3396 if (SvTAINTED(sstr))
3398 if (GvIMPORTED(dstr) != GVf_IMPORTED
3399 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3401 GvIMPORTED_on(dstr);
3404 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3405 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3410 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3412 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3414 const int intro = GvINTRO(dstr);
3417 const U32 stype = SvTYPE(sref);
3419 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3421 #ifdef GV_UNIQUE_CHECK
3422 if (GvUNIQUE((GV*)dstr)) {
3423 Perl_croak(aTHX_ PL_no_modify);
3428 GvINTRO_off(dstr); /* one-shot flag */
3429 GvLINE(dstr) = CopLINE(PL_curcop);
3430 GvEGV(dstr) = (GV*)dstr;
3435 location = (SV **) &GvCV(dstr);
3436 import_flag = GVf_IMPORTED_CV;
3439 location = (SV **) &GvHV(dstr);
3440 import_flag = GVf_IMPORTED_HV;
3443 location = (SV **) &GvAV(dstr);
3444 import_flag = GVf_IMPORTED_AV;
3447 location = (SV **) &GvIOp(dstr);
3450 location = (SV **) &GvFORM(dstr);
3452 location = &GvSV(dstr);
3453 import_flag = GVf_IMPORTED_SV;
3456 if (stype == SVt_PVCV) {
3457 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3458 if (GvCVGEN(dstr)) {
3459 SvREFCNT_dec(GvCV(dstr));
3461 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3464 SAVEGENERICSV(*location);
3468 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3469 CV* const cv = (CV*)*location;
3471 if (!GvCVGEN((GV*)dstr) &&
3472 (CvROOT(cv) || CvXSUB(cv)))
3474 /* Redefining a sub - warning is mandatory if
3475 it was a const and its value changed. */
3476 if (CvCONST(cv) && CvCONST((CV*)sref)
3477 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3479 /* They are 2 constant subroutines generated from
3480 the same constant. This probably means that
3481 they are really the "same" proxy subroutine
3482 instantiated in 2 places. Most likely this is
3483 when a constant is exported twice. Don't warn.
3486 else if (ckWARN(WARN_REDEFINE)
3488 && (!CvCONST((CV*)sref)
3489 || sv_cmp(cv_const_sv(cv),
3490 cv_const_sv((CV*)sref))))) {
3491 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3494 ? "Constant subroutine %s::%s redefined"
3495 : "Subroutine %s::%s redefined"),
3496 HvNAME_get(GvSTASH((GV*)dstr)),
3497 GvENAME((GV*)dstr));
3501 cv_ckproto_len(cv, (GV*)dstr,
3502 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3503 SvPOK(sref) ? SvCUR(sref) : 0);
3505 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3506 GvASSUMECV_on(dstr);
3507 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3510 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3511 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3512 GvFLAGS(dstr) |= import_flag;
3517 if (SvTAINTED(sstr))
3523 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3526 register U32 sflags;
3528 register svtype stype;
3530 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3535 if (SvIS_FREED(dstr)) {
3536 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3537 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3539 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3541 sstr = &PL_sv_undef;
3542 if (SvIS_FREED(sstr)) {
3543 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3544 (void*)sstr, (void*)dstr);
3546 stype = SvTYPE(sstr);
3547 dtype = SvTYPE(dstr);
3549 (void)SvAMAGIC_off(dstr);
3552 /* need to nuke the magic */
3554 SvRMAGICAL_off(dstr);
3557 /* There's a lot of redundancy below but we're going for speed here */
3562 if (dtype != SVt_PVGV) {
3563 (void)SvOK_off(dstr);
3571 sv_upgrade(dstr, SVt_IV);
3575 sv_upgrade(dstr, SVt_PVIV);
3578 goto end_of_first_switch;
3580 (void)SvIOK_only(dstr);
3581 SvIV_set(dstr, SvIVX(sstr));
3584 /* SvTAINTED can only be true if the SV has taint magic, which in
3585 turn means that the SV type is PVMG (or greater). This is the
3586 case statement for SVt_IV, so this cannot be true (whatever gcov
3588 assert(!SvTAINTED(sstr));
3593 if (dtype < SVt_PV && dtype != SVt_IV)
3594 sv_upgrade(dstr, SVt_IV);
3602 sv_upgrade(dstr, SVt_NV);
3606 sv_upgrade(dstr, SVt_PVNV);
3609 goto end_of_first_switch;
3611 SvNV_set(dstr, SvNVX(sstr));
3612 (void)SvNOK_only(dstr);
3613 /* SvTAINTED can only be true if the SV has taint magic, which in
3614 turn means that the SV type is PVMG (or greater). This is the
3615 case statement for SVt_NV, so this cannot be true (whatever gcov
3617 assert(!SvTAINTED(sstr));
3623 #ifdef PERL_OLD_COPY_ON_WRITE
3624 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3625 if (dtype < SVt_PVIV)
3626 sv_upgrade(dstr, SVt_PVIV);
3634 sv_upgrade(dstr, SVt_PV);
3637 if (dtype < SVt_PVIV)
3638 sv_upgrade(dstr, SVt_PVIV);
3641 if (dtype < SVt_PVNV)
3642 sv_upgrade(dstr, SVt_PVNV);
3646 const char * const type = sv_reftype(sstr,0);
3648 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3650 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3654 /* case SVt_BIND: */
3657 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3658 glob_assign_glob(dstr, sstr, dtype);
3661 /* SvVALID means that this PVGV is playing at being an FBM. */
3665 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3667 if (SvTYPE(sstr) != stype) {
3668 stype = SvTYPE(sstr);
3669 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3670 glob_assign_glob(dstr, sstr, dtype);
3675 if (stype == SVt_PVLV)
3676 SvUPGRADE(dstr, SVt_PVNV);
3678 SvUPGRADE(dstr, (svtype)stype);
3680 end_of_first_switch:
3682 /* dstr may have been upgraded. */
3683 dtype = SvTYPE(dstr);
3684 sflags = SvFLAGS(sstr);
3686 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3687 /* Assigning to a subroutine sets the prototype. */
3690 const char *const ptr = SvPV_const(sstr, len);
3692 SvGROW(dstr, len + 1);
3693 Copy(ptr, SvPVX(dstr), len + 1, char);
3694 SvCUR_set(dstr, len);
3696 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3700 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3701 const char * const type = sv_reftype(dstr,0);
3703 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3705 Perl_croak(aTHX_ "Cannot copy to %s", type);
3706 } else if (sflags & SVf_ROK) {
3707 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3708 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3711 if (GvIMPORTED(dstr) != GVf_IMPORTED
3712 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3714 GvIMPORTED_on(dstr);
3719 glob_assign_glob(dstr, sstr, dtype);
3723 if (dtype >= SVt_PV) {
3724 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3725 glob_assign_ref(dstr, sstr);
3728 if (SvPVX_const(dstr)) {
3734 (void)SvOK_off(dstr);
3735 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3736 SvFLAGS(dstr) |= sflags & SVf_ROK;
3737 assert(!(sflags & SVp_NOK));
3738 assert(!(sflags & SVp_IOK));
3739 assert(!(sflags & SVf_NOK));
3740 assert(!(sflags & SVf_IOK));
3742 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3743 if (!(sflags & SVf_OK)) {
3744 if (ckWARN(WARN_MISC))
3745 Perl_warner(aTHX_ packWARN(WARN_MISC),
3746 "Undefined value assigned to typeglob");
3749 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3750 if (dstr != (SV*)gv) {
3753 GvGP(dstr) = gp_ref(GvGP(gv));
3757 else if (sflags & SVp_POK) {
3761 * Check to see if we can just swipe the string. If so, it's a
3762 * possible small lose on short strings, but a big win on long ones.
3763 * It might even be a win on short strings if SvPVX_const(dstr)
3764 * has to be allocated and SvPVX_const(sstr) has to be freed.
3765 * Likewise if we can set up COW rather than doing an actual copy, we
3766 * drop to the else clause, as the swipe code and the COW setup code
3767 * have much in common.
3770 /* Whichever path we take through the next code, we want this true,
3771 and doing it now facilitates the COW check. */
3772 (void)SvPOK_only(dstr);
3775 /* If we're already COW then this clause is not true, and if COW
3776 is allowed then we drop down to the else and make dest COW
3777 with us. If caller hasn't said that we're allowed to COW
3778 shared hash keys then we don't do the COW setup, even if the
3779 source scalar is a shared hash key scalar. */
3780 (((flags & SV_COW_SHARED_HASH_KEYS)
3781 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3782 : 1 /* If making a COW copy is forbidden then the behaviour we
3783 desire is as if the source SV isn't actually already
3784 COW, even if it is. So we act as if the source flags
3785 are not COW, rather than actually testing them. */
3787 #ifndef PERL_OLD_COPY_ON_WRITE
3788 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3789 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3790 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3791 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3792 but in turn, it's somewhat dead code, never expected to go
3793 live, but more kept as a placeholder on how to do it better
3794 in a newer implementation. */
3795 /* If we are COW and dstr is a suitable target then we drop down
3796 into the else and make dest a COW of us. */
3797 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3802 (sflags & SVs_TEMP) && /* slated for free anyway? */
3803 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3804 (!(flags & SV_NOSTEAL)) &&
3805 /* and we're allowed to steal temps */
3806 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3807 SvLEN(sstr) && /* and really is a string */
3808 /* and won't be needed again, potentially */
3809 !(PL_op && PL_op->op_type == OP_AASSIGN))
3810 #ifdef PERL_OLD_COPY_ON_WRITE
3811 && ((flags & SV_COW_SHARED_HASH_KEYS)
3812 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3813 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3814 && SvTYPE(sstr) >= SVt_PVIV))
3818 /* Failed the swipe test, and it's not a shared hash key either.
3819 Have to copy the string. */
3820 STRLEN len = SvCUR(sstr);
3821 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3822 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3823 SvCUR_set(dstr, len);
3824 *SvEND(dstr) = '\0';
3826 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3828 /* Either it's a shared hash key, or it's suitable for
3829 copy-on-write or we can swipe the string. */
3831 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3835 #ifdef PERL_OLD_COPY_ON_WRITE
3837 /* I believe I should acquire a global SV mutex if
3838 it's a COW sv (not a shared hash key) to stop
3839 it going un copy-on-write.
3840 If the source SV has gone un copy on write between up there
3841 and down here, then (assert() that) it is of the correct
3842 form to make it copy on write again */
3843 if ((sflags & (SVf_FAKE | SVf_READONLY))
3844 != (SVf_FAKE | SVf_READONLY)) {
3845 SvREADONLY_on(sstr);
3847 /* Make the source SV into a loop of 1.
3848 (about to become 2) */
3849 SV_COW_NEXT_SV_SET(sstr, sstr);
3853 /* Initial code is common. */
3854 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3859 /* making another shared SV. */
3860 STRLEN cur = SvCUR(sstr);
3861 STRLEN len = SvLEN(sstr);
3862 #ifdef PERL_OLD_COPY_ON_WRITE
3864 assert (SvTYPE(dstr) >= SVt_PVIV);
3865 /* SvIsCOW_normal */
3866 /* splice us in between source and next-after-source. */
3867 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3868 SV_COW_NEXT_SV_SET(sstr, dstr);
3869 SvPV_set(dstr, SvPVX_mutable(sstr));
3873 /* SvIsCOW_shared_hash */
3874 DEBUG_C(PerlIO_printf(Perl_debug_log,
3875 "Copy on write: Sharing hash\n"));
3877 assert (SvTYPE(dstr) >= SVt_PV);
3879 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3881 SvLEN_set(dstr, len);
3882 SvCUR_set(dstr, cur);
3883 SvREADONLY_on(dstr);
3885 /* Relesase a global SV mutex. */
3888 { /* Passes the swipe test. */
3889 SvPV_set(dstr, SvPVX_mutable(sstr));
3890 SvLEN_set(dstr, SvLEN(sstr));
3891 SvCUR_set(dstr, SvCUR(sstr));
3894 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3895 SvPV_set(sstr, NULL);
3901 if (sflags & SVp_NOK) {
3902 SvNV_set(dstr, SvNVX(sstr));
3904 if (sflags & SVp_IOK) {
3905 SvIV_set(dstr, SvIVX(sstr));
3906 /* Must do this otherwise some other overloaded use of 0x80000000
3907 gets confused. I guess SVpbm_VALID */
3908 if (sflags & SVf_IVisUV)
3911 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3913 const MAGIC * const smg = SvVSTRING_mg(sstr);
3915 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3916 smg->mg_ptr, smg->mg_len);
3917 SvRMAGICAL_on(dstr);
3921 else if (sflags & (SVp_IOK|SVp_NOK)) {
3922 (void)SvOK_off(dstr);
3923 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3924 if (sflags & SVp_IOK) {
3925 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3926 SvIV_set(dstr, SvIVX(sstr));
3928 if (sflags & SVp_NOK) {
3929 SvNV_set(dstr, SvNVX(sstr));
3933 if (isGV_with_GP(sstr)) {
3934 /* This stringification rule for globs is spread in 3 places.
3935 This feels bad. FIXME. */
3936 const U32 wasfake = sflags & SVf_FAKE;
3938 /* FAKE globs can get coerced, so need to turn this off
3939 temporarily if it is on. */
3941 gv_efullname3(dstr, (GV *)sstr, "*");
3942 SvFLAGS(sstr) |= wasfake;
3945 (void)SvOK_off(dstr);
3947 if (SvTAINTED(sstr))
3952 =for apidoc sv_setsv_mg
3954 Like C<sv_setsv>, but also handles 'set' magic.
3960 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3962 PERL_ARGS_ASSERT_SV_SETSV_MG;
3964 sv_setsv(dstr,sstr);
3968 #ifdef PERL_OLD_COPY_ON_WRITE
3970 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3972 STRLEN cur = SvCUR(sstr);
3973 STRLEN len = SvLEN(sstr);
3974 register char *new_pv;
3976 PERL_ARGS_ASSERT_SV_SETSV_COW;
3979 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3980 (void*)sstr, (void*)dstr);
3987 if (SvTHINKFIRST(dstr))
3988 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3989 else if (SvPVX_const(dstr))
3990 Safefree(SvPVX_const(dstr));
3994 SvUPGRADE(dstr, SVt_PVIV);
3996 assert (SvPOK(sstr));
3997 assert (SvPOKp(sstr));
3998 assert (!SvIOK(sstr));
3999 assert (!SvIOKp(sstr));
4000 assert (!SvNOK(sstr));
4001 assert (!SvNOKp(sstr));
4003 if (SvIsCOW(sstr)) {
4005 if (SvLEN(sstr) == 0) {
4006 /* source is a COW shared hash key. */
4007 DEBUG_C(PerlIO_printf(Perl_debug_log,
4008 "Fast copy on write: Sharing hash\n"));
4009 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4012 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4014 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4015 SvUPGRADE(sstr, SVt_PVIV);
4016 SvREADONLY_on(sstr);
4018 DEBUG_C(PerlIO_printf(Perl_debug_log,
4019 "Fast copy on write: Converting sstr to COW\n"));
4020 SV_COW_NEXT_SV_SET(dstr, sstr);
4022 SV_COW_NEXT_SV_SET(sstr, dstr);
4023 new_pv = SvPVX_mutable(sstr);
4026 SvPV_set(dstr, new_pv);
4027 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4030 SvLEN_set(dstr, len);
4031 SvCUR_set(dstr, cur);
4040 =for apidoc sv_setpvn
4042 Copies a string into an SV. The C<len> parameter indicates the number of
4043 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4044 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4050 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4053 register char *dptr;
4055 PERL_ARGS_ASSERT_SV_SETPVN;
4057 SV_CHECK_THINKFIRST_COW_DROP(sv);
4063 /* len is STRLEN which is unsigned, need to copy to signed */
4066 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4068 SvUPGRADE(sv, SVt_PV);
4070 dptr = SvGROW(sv, len + 1);
4071 Move(ptr,dptr,len,char);
4074 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4079 =for apidoc sv_setpvn_mg
4081 Like C<sv_setpvn>, but also handles 'set' magic.
4087 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4089 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4091 sv_setpvn(sv,ptr,len);
4096 =for apidoc sv_setpv
4098 Copies a string into an SV. The string must be null-terminated. Does not
4099 handle 'set' magic. See C<sv_setpv_mg>.
4105 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4108 register STRLEN len;
4110 PERL_ARGS_ASSERT_SV_SETPV;
4112 SV_CHECK_THINKFIRST_COW_DROP(sv);
4118 SvUPGRADE(sv, SVt_PV);
4120 SvGROW(sv, len + 1);
4121 Move(ptr,SvPVX(sv),len+1,char);
4123 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4128 =for apidoc sv_setpv_mg
4130 Like C<sv_setpv>, but also handles 'set' magic.
4136 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4138 PERL_ARGS_ASSERT_SV_SETPV_MG;
4145 =for apidoc sv_usepvn_flags
4147 Tells an SV to use C<ptr> to find its string value. Normally the
4148 string is stored inside the SV but sv_usepvn allows the SV to use an
4149 outside string. The C<ptr> should point to memory that was allocated
4150 by C<malloc>. The string length, C<len>, must be supplied. By default
4151 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4152 so that pointer should not be freed or used by the programmer after
4153 giving it to sv_usepvn, and neither should any pointers from "behind"
4154 that pointer (e.g. ptr + 1) be used.
4156 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4157 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4158 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4159 C<len>, and already meets the requirements for storing in C<SvPVX>)
4165 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4170 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4172 SV_CHECK_THINKFIRST_COW_DROP(sv);
4173 SvUPGRADE(sv, SVt_PV);
4176 if (flags & SV_SMAGIC)
4180 if (SvPVX_const(sv))
4184 if (flags & SV_HAS_TRAILING_NUL)
4185 assert(ptr[len] == '\0');
4188 allocate = (flags & SV_HAS_TRAILING_NUL)
4190 #ifdef Perl_safesysmalloc_size
4193 PERL_STRLEN_ROUNDUP(len + 1);
4195 if (flags & SV_HAS_TRAILING_NUL) {
4196 /* It's long enough - do nothing.
4197 Specfically Perl_newCONSTSUB is relying on this. */
4200 /* Force a move to shake out bugs in callers. */
4201 char *new_ptr = (char*)safemalloc(allocate);
4202 Copy(ptr, new_ptr, len, char);
4203 PoisonFree(ptr,len,char);
4207 ptr = (char*) saferealloc (ptr, allocate);
4210 #ifdef Perl_safesysmalloc_size
4211 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4213 SvLEN_set(sv, allocate);
4217 if (!(flags & SV_HAS_TRAILING_NUL)) {
4220 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4222 if (flags & SV_SMAGIC)
4226 #ifdef PERL_OLD_COPY_ON_WRITE
4227 /* Need to do this *after* making the SV normal, as we need the buffer
4228 pointer to remain valid until after we've copied it. If we let go too early,
4229 another thread could invalidate it by unsharing last of the same hash key
4230 (which it can do by means other than releasing copy-on-write Svs)
4231 or by changing the other copy-on-write SVs in the loop. */
4233 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4235 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4237 { /* this SV was SvIsCOW_normal(sv) */
4238 /* we need to find the SV pointing to us. */
4239 SV *current = SV_COW_NEXT_SV(after);
4241 if (current == sv) {
4242 /* The SV we point to points back to us (there were only two of us
4244 Hence other SV is no longer copy on write either. */
4246 SvREADONLY_off(after);
4248 /* We need to follow the pointers around the loop. */
4250 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4253 /* don't loop forever if the structure is bust, and we have
4254 a pointer into a closed loop. */
4255 assert (current != after);
4256 assert (SvPVX_const(current) == pvx);
4258 /* Make the SV before us point to the SV after us. */
4259 SV_COW_NEXT_SV_SET(current, after);
4265 =for apidoc sv_force_normal_flags
4267 Undo various types of fakery on an SV: if the PV is a shared string, make
4268 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4269 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4270 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4271 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4272 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4273 set to some other value.) In addition, the C<flags> parameter gets passed to
4274 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4275 with flags set to 0.
4281 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4285 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4287 #ifdef PERL_OLD_COPY_ON_WRITE
4288 if (SvREADONLY(sv)) {
4289 /* At this point I believe I should acquire a global SV mutex. */
4291 const char * const pvx = SvPVX_const(sv);
4292 const STRLEN len = SvLEN(sv);
4293 const STRLEN cur = SvCUR(sv);
4294 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4295 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4296 we'll fail an assertion. */
4297 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4300 PerlIO_printf(Perl_debug_log,
4301 "Copy on write: Force normal %ld\n",
4307 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4310 if (flags & SV_COW_DROP_PV) {
4311 /* OK, so we don't need to copy our buffer. */
4314 SvGROW(sv, cur + 1);
4315 Move(pvx,SvPVX(sv),cur,char);
4320 sv_release_COW(sv, pvx, next);
4322 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4328 else if (IN_PERL_RUNTIME)
4329 Perl_croak(aTHX_ PL_no_modify);
4330 /* At this point I believe that I can drop the global SV mutex. */
4333 if (SvREADONLY(sv)) {
4335 const char * const pvx = SvPVX_const(sv);
4336 const STRLEN len = SvCUR(sv);
4341 SvGROW(sv, len + 1);
4342 Move(pvx,SvPVX(sv),len,char);
4344 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4346 else if (IN_PERL_RUNTIME)
4347 Perl_croak(aTHX_ PL_no_modify);
4351 sv_unref_flags(sv, flags);
4352 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4359 Efficient removal of characters from the beginning of the string buffer.
4360 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4361 the string buffer. The C<ptr> becomes the first character of the adjusted
4362 string. Uses the "OOK hack".
4363 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4364 refer to the same chunk of data.
4370 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4376 const U8 *real_start;
4379 PERL_ARGS_ASSERT_SV_CHOP;
4381 if (!ptr || !SvPOKp(sv))
4383 delta = ptr - SvPVX_const(sv);
4385 /* Nothing to do. */
4388 assert(ptr > SvPVX_const(sv));
4389 SV_CHECK_THINKFIRST(sv);
4392 if (!SvLEN(sv)) { /* make copy of shared string */
4393 const char *pvx = SvPVX_const(sv);
4394 const STRLEN len = SvCUR(sv);
4395 SvGROW(sv, len + 1);
4396 Move(pvx,SvPVX(sv),len,char);
4399 SvFLAGS(sv) |= SVf_OOK;
4402 SvOOK_offset(sv, old_delta);
4404 SvLEN_set(sv, SvLEN(sv) - delta);
4405 SvCUR_set(sv, SvCUR(sv) - delta);
4406 SvPV_set(sv, SvPVX(sv) + delta);
4408 p = (U8 *)SvPVX_const(sv);
4413 real_start = p - delta;
4417 if (delta < 0x100) {
4421 p -= sizeof(STRLEN);
4422 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4426 /* Fill the preceding buffer with sentinals to verify that no-one is
4428 while (p > real_start) {
4436 =for apidoc sv_catpvn
4438 Concatenates the string onto the end of the string which is in the SV. The
4439 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4440 status set, then the bytes appended should be valid UTF-8.
4441 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4443 =for apidoc sv_catpvn_flags
4445 Concatenates the string onto the end of the string which is in the SV. The
4446 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4447 status set, then the bytes appended should be valid UTF-8.
4448 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4449 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4450 in terms of this function.
4456 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4460 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4462 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4464 SvGROW(dsv, dlen + slen + 1);
4466 sstr = SvPVX_const(dsv);
4467 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4468 SvCUR_set(dsv, SvCUR(dsv) + slen);
4470 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4472 if (flags & SV_SMAGIC)
4477 =for apidoc sv_catsv
4479 Concatenates the string from SV C<ssv> onto the end of the string in
4480 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4481 not 'set' magic. See C<sv_catsv_mg>.
4483 =for apidoc sv_catsv_flags
4485 Concatenates the string from SV C<ssv> onto the end of the string in
4486 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4487 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4488 and C<sv_catsv_nomg> are implemented in terms of this function.
4493 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4497 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4501 const char *spv = SvPV_const(ssv, slen);
4503 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4504 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4505 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4506 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4507 dsv->sv_flags doesn't have that bit set.
4508 Andy Dougherty 12 Oct 2001
4510 const I32 sutf8 = DO_UTF8(ssv);
4513 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4515 dutf8 = DO_UTF8(dsv);
4517 if (dutf8 != sutf8) {
4519 /* Not modifying source SV, so taking a temporary copy. */
4520 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4522 sv_utf8_upgrade(csv);
4523 spv = SvPV_const(csv, slen);
4526 sv_utf8_upgrade_nomg(dsv);
4528 sv_catpvn_nomg(dsv, spv, slen);
4531 if (flags & SV_SMAGIC)
4536 =for apidoc sv_catpv
4538 Concatenates the string onto the end of the string which is in the SV.
4539 If the SV has the UTF-8 status set, then the bytes appended should be
4540 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4545 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4548 register STRLEN len;
4552 PERL_ARGS_ASSERT_SV_CATPV;
4556 junk = SvPV_force(sv, tlen);
4558 SvGROW(sv, tlen + len + 1);
4560 ptr = SvPVX_const(sv);
4561 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4562 SvCUR_set(sv, SvCUR(sv) + len);
4563 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4568 =for apidoc sv_catpv_mg
4570 Like C<sv_catpv>, but also handles 'set' magic.
4576 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4578 PERL_ARGS_ASSERT_SV_CATPV_MG;
4587 Creates a new SV. A non-zero C<len> parameter indicates the number of
4588 bytes of preallocated string space the SV should have. An extra byte for a
4589 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4590 space is allocated.) The reference count for the new SV is set to 1.
4592 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4593 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4594 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4595 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4596 modules supporting older perls.
4602 Perl_newSV(pTHX_ const STRLEN len)
4609 sv_upgrade(sv, SVt_PV);
4610 SvGROW(sv, len + 1);
4615 =for apidoc sv_magicext
4617 Adds magic to an SV, upgrading it if necessary. Applies the
4618 supplied vtable and returns a pointer to the magic added.
4620 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4621 In particular, you can add magic to SvREADONLY SVs, and add more than
4622 one instance of the same 'how'.
4624 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4625 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4626 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4627 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4629 (This is now used as a subroutine by C<sv_magic>.)
4634 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4635 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4640 PERL_ARGS_ASSERT_SV_MAGICEXT;
4642 SvUPGRADE(sv, SVt_PVMG);
4643 Newxz(mg, 1, MAGIC);
4644 mg->mg_moremagic = SvMAGIC(sv);
4645 SvMAGIC_set(sv, mg);
4647 /* Sometimes a magic contains a reference loop, where the sv and
4648 object refer to each other. To prevent a reference loop that
4649 would prevent such objects being freed, we look for such loops
4650 and if we find one we avoid incrementing the object refcount.
4652 Note we cannot do this to avoid self-tie loops as intervening RV must
4653 have its REFCNT incremented to keep it in existence.
4656 if (!obj || obj == sv ||
4657 how == PERL_MAGIC_arylen ||
4658 how == PERL_MAGIC_symtab ||
4659 (SvTYPE(obj) == SVt_PVGV &&
4660 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4661 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4662 GvFORM(obj) == (CV*)sv)))
4667 mg->mg_obj = SvREFCNT_inc_simple(obj);
4668 mg->mg_flags |= MGf_REFCOUNTED;
4671 /* Normal self-ties simply pass a null object, and instead of
4672 using mg_obj directly, use the SvTIED_obj macro to produce a
4673 new RV as needed. For glob "self-ties", we are tieing the PVIO
4674 with an RV obj pointing to the glob containing the PVIO. In
4675 this case, to avoid a reference loop, we need to weaken the
4679 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4680 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4686 mg->mg_len = namlen;
4689 mg->mg_ptr = savepvn(name, namlen);
4690 else if (namlen == HEf_SVKEY)
4691 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4693 mg->mg_ptr = (char *) name;
4695 mg->mg_virtual = (MGVTBL *) vtable;
4699 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4704 =for apidoc sv_magic
4706 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4707 then adds a new magic item of type C<how> to the head of the magic list.
4709 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4710 handling of the C<name> and C<namlen> arguments.
4712 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4713 to add more than one instance of the same 'how'.
4719 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4720 const char *const name, const I32 namlen)
4723 const MGVTBL *vtable;
4726 PERL_ARGS_ASSERT_SV_MAGIC;
4728 #ifdef PERL_OLD_COPY_ON_WRITE
4730 sv_force_normal_flags(sv, 0);
4732 if (SvREADONLY(sv)) {
4734 /* its okay to attach magic to shared strings; the subsequent
4735 * upgrade to PVMG will unshare the string */
4736 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4739 && how != PERL_MAGIC_regex_global
4740 && how != PERL_MAGIC_bm
4741 && how != PERL_MAGIC_fm
4742 && how != PERL_MAGIC_sv
4743 && how != PERL_MAGIC_backref
4746 Perl_croak(aTHX_ PL_no_modify);
4749 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4750 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4751 /* sv_magic() refuses to add a magic of the same 'how' as an
4754 if (how == PERL_MAGIC_taint) {
4756 /* Any scalar which already had taint magic on which someone
4757 (erroneously?) did SvIOK_on() or similar will now be
4758 incorrectly sporting public "OK" flags. */
4759 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4767 vtable = &PL_vtbl_sv;
4769 case PERL_MAGIC_overload:
4770 vtable = &PL_vtbl_amagic;
4772 case PERL_MAGIC_overload_elem:
4773 vtable = &PL_vtbl_amagicelem;
4775 case PERL_MAGIC_overload_table:
4776 vtable = &PL_vtbl_ovrld;
4779 vtable = &PL_vtbl_bm;
4781 case PERL_MAGIC_regdata:
4782 vtable = &PL_vtbl_regdata;
4784 case PERL_MAGIC_regdatum:
4785 vtable = &PL_vtbl_regdatum;
4787 case PERL_MAGIC_env:
4788 vtable = &PL_vtbl_env;
4791 vtable = &PL_vtbl_fm;
4793 case PERL_MAGIC_envelem:
4794 vtable = &PL_vtbl_envelem;
4796 case PERL_MAGIC_regex_global:
4797 vtable = &PL_vtbl_mglob;
4799 case PERL_MAGIC_isa:
4800 vtable = &PL_vtbl_isa;
4802 case PERL_MAGIC_isaelem:
4803 vtable = &PL_vtbl_isaelem;
4805 case PERL_MAGIC_nkeys:
4806 vtable = &PL_vtbl_nkeys;
4808 case PERL_MAGIC_dbfile:
4811 case PERL_MAGIC_dbline:
4812 vtable = &PL_vtbl_dbline;
4814 #ifdef USE_LOCALE_COLLATE
4815 case PERL_MAGIC_collxfrm:
4816 vtable = &PL_vtbl_collxfrm;
4818 #endif /* USE_LOCALE_COLLATE */
4819 case PERL_MAGIC_tied:
4820 vtable = &PL_vtbl_pack;
4822 case PERL_MAGIC_tiedelem:
4823 case PERL_MAGIC_tiedscalar:
4824 vtable = &PL_vtbl_packelem;
4827 vtable = &PL_vtbl_regexp;
4829 case PERL_MAGIC_hints:
4830 /* As this vtable is all NULL, we can reuse it. */
4831 case PERL_MAGIC_sig:
4832 vtable = &PL_vtbl_sig;
4834 case PERL_MAGIC_sigelem:
4835 vtable = &PL_vtbl_sigelem;
4837 case PERL_MAGIC_taint:
4838 vtable = &PL_vtbl_taint;
4840 case PERL_MAGIC_uvar:
4841 vtable = &PL_vtbl_uvar;
4843 case PERL_MAGIC_vec:
4844 vtable = &PL_vtbl_vec;
4846 case PERL_MAGIC_arylen_p:
4847 case PERL_MAGIC_rhash:
4848 case PERL_MAGIC_symtab:
4849 case PERL_MAGIC_vstring:
4852 case PERL_MAGIC_utf8:
4853 vtable = &PL_vtbl_utf8;
4855 case PERL_MAGIC_substr:
4856 vtable = &PL_vtbl_substr;
4858 case PERL_MAGIC_defelem:
4859 vtable = &PL_vtbl_defelem;
4861 case PERL_MAGIC_arylen:
4862 vtable = &PL_vtbl_arylen;
4864 case PERL_MAGIC_pos:
4865 vtable = &PL_vtbl_pos;
4867 case PERL_MAGIC_backref:
4868 vtable = &PL_vtbl_backref;
4870 case PERL_MAGIC_hintselem:
4871 vtable = &PL_vtbl_hintselem;
4873 case PERL_MAGIC_ext:
4874 /* Reserved for use by extensions not perl internals. */
4875 /* Useful for attaching extension internal data to perl vars. */
4876 /* Note that multiple extensions may clash if magical scalars */
4877 /* etc holding private data from one are passed to another. */
4881 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4884 /* Rest of work is done else where */
4885 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4888 case PERL_MAGIC_taint:
4891 case PERL_MAGIC_ext:
4892 case PERL_MAGIC_dbfile:
4899 =for apidoc sv_unmagic
4901 Removes all magic of type C<type> from an SV.
4907 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4912 PERL_ARGS_ASSERT_SV_UNMAGIC;
4914 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4916 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4917 for (mg = *mgp; mg; mg = *mgp) {
4918 if (mg->mg_type == type) {
4919 const MGVTBL* const vtbl = mg->mg_virtual;
4920 *mgp = mg->mg_moremagic;
4921 if (vtbl && vtbl->svt_free)
4922 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4923 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4925 Safefree(mg->mg_ptr);
4926 else if (mg->mg_len == HEf_SVKEY)
4927 SvREFCNT_dec((SV*)mg->mg_ptr);
4928 else if (mg->mg_type == PERL_MAGIC_utf8)
4929 Safefree(mg->mg_ptr);
4931 if (mg->mg_flags & MGf_REFCOUNTED)
4932 SvREFCNT_dec(mg->mg_obj);
4936 mgp = &mg->mg_moremagic;
4940 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4941 SvMAGIC_set(sv, NULL);
4948 =for apidoc sv_rvweaken
4950 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4951 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4952 push a back-reference to this RV onto the array of backreferences
4953 associated with that magic. If the RV is magical, set magic will be
4954 called after the RV is cleared.
4960 Perl_sv_rvweaken(pTHX_ SV *const sv)
4964 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4966 if (!SvOK(sv)) /* let undefs pass */
4969 Perl_croak(aTHX_ "Can't weaken a nonreference");
4970 else if (SvWEAKREF(sv)) {
4971 if (ckWARN(WARN_MISC))
4972 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4976 Perl_sv_add_backref(aTHX_ tsv, sv);
4982 /* Give tsv backref magic if it hasn't already got it, then push a
4983 * back-reference to sv onto the array associated with the backref magic.
4987 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4992 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4994 if (SvTYPE(tsv) == SVt_PVHV) {
4995 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4999 /* There is no AV in the offical place - try a fixup. */
5000 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5003 /* Aha. They've got it stowed in magic. Bring it back. */
5004 av = (AV*)mg->mg_obj;
5005 /* Stop mg_free decreasing the refernce count. */
5007 /* Stop mg_free even calling the destructor, given that
5008 there's no AV to free up. */
5010 sv_unmagic(tsv, PERL_MAGIC_backref);
5014 SvREFCNT_inc_simple_void(av);
5019 const MAGIC *const mg
5020 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5022 av = (AV*)mg->mg_obj;
5026 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5027 /* av now has a refcnt of 2, which avoids it getting freed
5028 * before us during global cleanup. The extra ref is removed
5029 * by magic_killbackrefs() when tsv is being freed */
5032 if (AvFILLp(av) >= AvMAX(av)) {
5033 av_extend(av, AvFILLp(av)+1);
5035 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5038 /* delete a back-reference to ourselves from the backref magic associated
5039 * with the SV we point to.
5043 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5050 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5052 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5053 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5054 /* We mustn't attempt to "fix up" the hash here by moving the
5055 backreference array back to the hv_aux structure, as that is stored
5056 in the main HvARRAY(), and hfreentries assumes that no-one
5057 reallocates HvARRAY() while it is running. */
5060 const MAGIC *const mg
5061 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5063 av = (AV *)mg->mg_obj;
5066 if (PL_in_clean_all)
5068 Perl_croak(aTHX_ "panic: del_backref");
5075 /* We shouldn't be in here more than once, but for paranoia reasons lets
5077 for (i = AvFILLp(av); i >= 0; i--) {
5079 const SSize_t fill = AvFILLp(av);
5081 /* We weren't the last entry.
5082 An unordered list has this property that you can take the
5083 last element off the end to fill the hole, and it's still
5084 an unordered list :-)
5089 AvFILLp(av) = fill - 1;
5095 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5097 SV **svp = AvARRAY(av);
5099 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5100 PERL_UNUSED_ARG(sv);
5102 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5103 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5104 if (svp && !SvIS_FREED(av)) {
5105 SV *const *const last = svp + AvFILLp(av);
5107 while (svp <= last) {
5109 SV *const referrer = *svp;
5110 if (SvWEAKREF(referrer)) {
5111 /* XXX Should we check that it hasn't changed? */
5112 SvRV_set(referrer, 0);
5114 SvWEAKREF_off(referrer);
5115 SvSETMAGIC(referrer);
5116 } else if (SvTYPE(referrer) == SVt_PVGV ||
5117 SvTYPE(referrer) == SVt_PVLV) {
5118 /* You lookin' at me? */
5119 assert(GvSTASH(referrer));
5120 assert(GvSTASH(referrer) == (HV*)sv);
5121 GvSTASH(referrer) = 0;
5124 "panic: magic_killbackrefs (flags=%"UVxf")",
5125 (UV)SvFLAGS(referrer));
5133 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5138 =for apidoc sv_insert
5140 Inserts a string at the specified offset/length within the SV. Similar to
5141 the Perl substr() function.
5147 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
5148 const char *const little, const STRLEN littlelen)
5153 register char *midend;
5154 register char *bigend;
5158 PERL_ARGS_ASSERT_SV_INSERT;
5161 Perl_croak(aTHX_ "Can't modify non-existent substring");
5162 SvPV_force(bigstr, curlen);
5163 (void)SvPOK_only_UTF8(bigstr);
5164 if (offset + len > curlen) {
5165 SvGROW(bigstr, offset+len+1);
5166 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5167 SvCUR_set(bigstr, offset+len);
5171 i = littlelen - len;
5172 if (i > 0) { /* string might grow */
5173 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5174 mid = big + offset + len;
5175 midend = bigend = big + SvCUR(bigstr);
5178 while (midend > mid) /* shove everything down */
5179 *--bigend = *--midend;
5180 Move(little,big+offset,littlelen,char);
5181 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5186 Move(little,SvPVX(bigstr)+offset,len,char);
5191 big = SvPVX(bigstr);
5194 bigend = big + SvCUR(bigstr);
5196 if (midend > bigend)
5197 Perl_croak(aTHX_ "panic: sv_insert");
5199 if (mid - big > bigend - midend) { /* faster to shorten from end */
5201 Move(little, mid, littlelen,char);
5204 i = bigend - midend;
5206 Move(midend, mid, i,char);
5210 SvCUR_set(bigstr, mid - big);
5212 else if ((i = mid - big)) { /* faster from front */
5213 midend -= littlelen;
5215 Move(big, midend - i, i, char);
5216 sv_chop(bigstr,midend-i);
5218 Move(little, mid, littlelen,char);
5220 else if (littlelen) {
5221 midend -= littlelen;
5222 sv_chop(bigstr,midend);
5223 Move(little,midend,littlelen,char);
5226 sv_chop(bigstr,midend);
5232 =for apidoc sv_replace
5234 Make the first argument a copy of the second, then delete the original.
5235 The target SV physically takes over ownership of the body of the source SV
5236 and inherits its flags; however, the target keeps any magic it owns,
5237 and any magic in the source is discarded.
5238 Note that this is a rather specialist SV copying operation; most of the
5239 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5245 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5248 const U32 refcnt = SvREFCNT(sv);
5250 PERL_ARGS_ASSERT_SV_REPLACE;
5252 SV_CHECK_THINKFIRST_COW_DROP(sv);
5253 if (SvREFCNT(nsv) != 1) {
5254 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5255 UVuf " != 1)", (UV) SvREFCNT(nsv));
5257 if (SvMAGICAL(sv)) {
5261 sv_upgrade(nsv, SVt_PVMG);
5262 SvMAGIC_set(nsv, SvMAGIC(sv));
5263 SvFLAGS(nsv) |= SvMAGICAL(sv);
5265 SvMAGIC_set(sv, NULL);
5269 assert(!SvREFCNT(sv));
5270 #ifdef DEBUG_LEAKING_SCALARS
5271 sv->sv_flags = nsv->sv_flags;
5272 sv->sv_any = nsv->sv_any;
5273 sv->sv_refcnt = nsv->sv_refcnt;
5274 sv->sv_u = nsv->sv_u;
5276 StructCopy(nsv,sv,SV);
5278 if(SvTYPE(sv) == SVt_IV) {
5280 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5284 #ifdef PERL_OLD_COPY_ON_WRITE
5285 if (SvIsCOW_normal(nsv)) {
5286 /* We need to follow the pointers around the loop to make the
5287 previous SV point to sv, rather than nsv. */
5290 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5293 assert(SvPVX_const(current) == SvPVX_const(nsv));
5295 /* Make the SV before us point to the SV after us. */
5297 PerlIO_printf(Perl_debug_log, "previous is\n");
5299 PerlIO_printf(Perl_debug_log,
5300 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5301 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5303 SV_COW_NEXT_SV_SET(current, sv);
5306 SvREFCNT(sv) = refcnt;
5307 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5313 =for apidoc sv_clear
5315 Clear an SV: call any destructors, free up any memory used by the body,
5316 and free the body itself. The SV's head is I<not> freed, although
5317 its type is set to all 1's so that it won't inadvertently be assumed
5318 to be live during global destruction etc.
5319 This function should only be called when REFCNT is zero. Most of the time
5320 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5327 Perl_sv_clear(pTHX_ register SV *const sv)
5330 const U32 type = SvTYPE(sv);
5331 const struct body_details *const sv_type_details
5332 = bodies_by_type + type;
5335 PERL_ARGS_ASSERT_SV_CLEAR;
5336 assert(SvREFCNT(sv) == 0);
5337 assert(SvTYPE(sv) != SVTYPEMASK);
5339 if (type <= SVt_IV) {
5340 /* See the comment in sv.h about the collusion between this early
5341 return and the overloading of the NULL and IV slots in the size
5344 SV * const target = SvRV(sv);
5346 sv_del_backref(target, sv);
5348 SvREFCNT_dec(target);
5350 SvFLAGS(sv) &= SVf_BREAK;
5351 SvFLAGS(sv) |= SVTYPEMASK;
5356 if (PL_defstash && /* Still have a symbol table? */
5363 stash = SvSTASH(sv);
5364 destructor = StashHANDLER(stash,DESTROY);
5366 SV* const tmpref = newRV(sv);
5367 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5369 PUSHSTACKi(PERLSI_DESTROY);
5374 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5380 if(SvREFCNT(tmpref) < 2) {
5381 /* tmpref is not kept alive! */
5383 SvRV_set(tmpref, NULL);
5386 SvREFCNT_dec(tmpref);
5388 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5392 if (PL_in_clean_objs)
5393 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5395 /* DESTROY gave object new lease on life */
5401 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5402 SvOBJECT_off(sv); /* Curse the object. */
5403 if (type != SVt_PVIO)
5404 --PL_sv_objcount; /* XXX Might want something more general */
5407 if (type >= SVt_PVMG) {
5408 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5409 SvREFCNT_dec(SvOURSTASH(sv));
5410 } else if (SvMAGIC(sv))
5412 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5413 SvREFCNT_dec(SvSTASH(sv));
5416 /* case SVt_BIND: */
5419 IoIFP(sv) != PerlIO_stdin() &&
5420 IoIFP(sv) != PerlIO_stdout() &&
5421 IoIFP(sv) != PerlIO_stderr())
5423 io_close((IO*)sv, FALSE);
5425 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5426 PerlDir_close(IoDIRP(sv));
5427 IoDIRP(sv) = (DIR*)NULL;
5428 Safefree(IoTOP_NAME(sv));
5429 Safefree(IoFMT_NAME(sv));
5430 Safefree(IoBOTTOM_NAME(sv));
5433 /* FIXME for plugins */
5434 pregfree2((REGEXP*) sv);
5441 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5445 if (PL_comppad == (AV*)sv) {
5452 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5453 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5454 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5455 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5457 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5458 SvREFCNT_dec(LvTARG(sv));
5460 if (isGV_with_GP(sv)) {
5461 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5462 mro_method_changed_in(stash);
5465 unshare_hek(GvNAME_HEK(sv));
5466 /* If we're in a stash, we don't own a reference to it. However it does
5467 have a back reference to us, which needs to be cleared. */
5468 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5469 sv_del_backref((SV*)stash, sv);
5471 /* FIXME. There are probably more unreferenced pointers to SVs in the
5472 interpreter struct that we should check and tidy in a similar
5474 if ((GV*)sv == PL_last_in_gv)
5475 PL_last_in_gv = NULL;
5481 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5484 SvOOK_offset(sv, offset);
5485 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5486 /* Don't even bother with turning off the OOK flag. */
5489 SV * const target = SvRV(sv);
5491 sv_del_backref(target, sv);
5493 SvREFCNT_dec(target);
5495 #ifdef PERL_OLD_COPY_ON_WRITE
5496 else if (SvPVX_const(sv)) {
5498 /* I believe I need to grab the global SV mutex here and
5499 then recheck the COW status. */
5501 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5505 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5507 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5510 /* And drop it here. */
5512 } else if (SvLEN(sv)) {
5513 Safefree(SvPVX_const(sv));
5517 else if (SvPVX_const(sv) && SvLEN(sv))
5518 Safefree(SvPVX_mutable(sv));
5519 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5520 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5529 SvFLAGS(sv) &= SVf_BREAK;
5530 SvFLAGS(sv) |= SVTYPEMASK;
5532 if (sv_type_details->arena) {
5533 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5534 &PL_body_roots[type]);
5536 else if (sv_type_details->body_size) {
5537 my_safefree(SvANY(sv));
5542 =for apidoc sv_newref
5544 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5551 Perl_sv_newref(pTHX_ SV *const sv)
5553 PERL_UNUSED_CONTEXT;
5562 Decrement an SV's reference count, and if it drops to zero, call
5563 C<sv_clear> to invoke destructors and free up any memory used by
5564 the body; finally, deallocate the SV's head itself.
5565 Normally called via a wrapper macro C<SvREFCNT_dec>.
5571 Perl_sv_free(pTHX_ SV *const sv)
5576 if (SvREFCNT(sv) == 0) {
5577 if (SvFLAGS(sv) & SVf_BREAK)
5578 /* this SV's refcnt has been artificially decremented to
5579 * trigger cleanup */
5581 if (PL_in_clean_all) /* All is fair */
5583 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5584 /* make sure SvREFCNT(sv)==0 happens very seldom */
5585 SvREFCNT(sv) = (~(U32)0)/2;
5588 if (ckWARN_d(WARN_INTERNAL)) {
5589 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5590 Perl_dump_sv_child(aTHX_ sv);
5592 #ifdef DEBUG_LEAKING_SCALARS
5595 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5596 if (PL_warnhook == PERL_WARNHOOK_FATAL
5597 || ckDEAD(packWARN(WARN_INTERNAL))) {
5598 /* Don't let Perl_warner cause us to escape our fate: */
5602 /* This may not return: */
5603 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5604 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5605 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5608 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5613 if (--(SvREFCNT(sv)) > 0)
5615 Perl_sv_free2(aTHX_ sv);
5619 Perl_sv_free2(pTHX_ SV *const sv)
5623 PERL_ARGS_ASSERT_SV_FREE2;
5627 if (ckWARN_d(WARN_DEBUGGING))
5628 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5629 "Attempt to free temp prematurely: SV 0x%"UVxf
5630 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5634 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5635 /* make sure SvREFCNT(sv)==0 happens very seldom */
5636 SvREFCNT(sv) = (~(U32)0)/2;
5647 Returns the length of the string in the SV. Handles magic and type
5648 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5654 Perl_sv_len(pTHX_ register SV *const sv)
5662 len = mg_length(sv);
5664 (void)SvPV_const(sv, len);
5669 =for apidoc sv_len_utf8
5671 Returns the number of characters in the string in an SV, counting wide
5672 UTF-8 bytes as a single character. Handles magic and type coercion.
5678 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5679 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5680 * (Note that the mg_len is not the length of the mg_ptr field.
5681 * This allows the cache to store the character length of the string without
5682 * needing to malloc() extra storage to attach to the mg_ptr.)
5687 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5693 return mg_length(sv);
5697 const U8 *s = (U8*)SvPV_const(sv, len);
5701 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5703 if (mg && mg->mg_len != -1) {
5705 if (PL_utf8cache < 0) {
5706 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5708 /* Need to turn the assertions off otherwise we may
5709 recurse infinitely while printing error messages.
5711 SAVEI8(PL_utf8cache);
5713 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5714 " real %"UVuf" for %"SVf,
5715 (UV) ulen, (UV) real, SVfARG(sv));
5720 ulen = Perl_utf8_length(aTHX_ s, s + len);
5721 if (!SvREADONLY(sv)) {
5723 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5724 &PL_vtbl_utf8, 0, 0);
5732 return Perl_utf8_length(aTHX_ s, s + len);
5736 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5739 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5742 const U8 *s = start;
5744 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5746 while (s < send && uoffset--)
5749 /* This is the existing behaviour. Possibly it should be a croak, as
5750 it's actually a bounds error */
5756 /* Given the length of the string in both bytes and UTF-8 characters, decide
5757 whether to walk forwards or backwards to find the byte corresponding to
5758 the passed in UTF-8 offset. */
5760 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5761 const STRLEN uoffset, const STRLEN uend)
5763 STRLEN backw = uend - uoffset;
5765 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5767 if (uoffset < 2 * backw) {
5768 /* The assumption is that going forwards is twice the speed of going
5769 forward (that's where the 2 * backw comes from).
5770 (The real figure of course depends on the UTF-8 data.) */
5771 return sv_pos_u2b_forwards(start, send, uoffset);
5776 while (UTF8_IS_CONTINUATION(*send))
5779 return send - start;
5782 /* For the string representation of the given scalar, find the byte
5783 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5784 give another position in the string, *before* the sought offset, which
5785 (which is always true, as 0, 0 is a valid pair of positions), which should
5786 help reduce the amount of linear searching.
5787 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5788 will be used to reduce the amount of linear searching. The cache will be
5789 created if necessary, and the found value offered to it for update. */
5791 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5792 const U8 *const send, const STRLEN uoffset,
5793 STRLEN uoffset0, STRLEN boffset0)
5795 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5798 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5800 assert (uoffset >= uoffset0);
5802 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5803 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5804 if ((*mgp)->mg_ptr) {
5805 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5806 if (cache[0] == uoffset) {
5807 /* An exact match. */
5810 if (cache[2] == uoffset) {
5811 /* An exact match. */
5815 if (cache[0] < uoffset) {
5816 /* The cache already knows part of the way. */
5817 if (cache[0] > uoffset0) {
5818 /* The cache knows more than the passed in pair */
5819 uoffset0 = cache[0];
5820 boffset0 = cache[1];
5822 if ((*mgp)->mg_len != -1) {
5823 /* And we know the end too. */
5825 + sv_pos_u2b_midway(start + boffset0, send,
5827 (*mgp)->mg_len - uoffset0);
5830 + sv_pos_u2b_forwards(start + boffset0,
5831 send, uoffset - uoffset0);
5834 else if (cache[2] < uoffset) {
5835 /* We're between the two cache entries. */
5836 if (cache[2] > uoffset0) {
5837 /* and the cache knows more than the passed in pair */
5838 uoffset0 = cache[2];
5839 boffset0 = cache[3];
5843 + sv_pos_u2b_midway(start + boffset0,
5846 cache[0] - uoffset0);
5849 + sv_pos_u2b_midway(start + boffset0,
5852 cache[2] - uoffset0);
5856 else if ((*mgp)->mg_len != -1) {
5857 /* If we can take advantage of a passed in offset, do so. */
5858 /* In fact, offset0 is either 0, or less than offset, so don't
5859 need to worry about the other possibility. */
5861 + sv_pos_u2b_midway(start + boffset0, send,
5863 (*mgp)->mg_len - uoffset0);
5868 if (!found || PL_utf8cache < 0) {
5869 const STRLEN real_boffset
5870 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5871 send, uoffset - uoffset0);
5873 if (found && PL_utf8cache < 0) {
5874 if (real_boffset != boffset) {
5875 /* Need to turn the assertions off otherwise we may recurse
5876 infinitely while printing error messages. */
5877 SAVEI8(PL_utf8cache);
5879 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5880 " real %"UVuf" for %"SVf,
5881 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5884 boffset = real_boffset;
5888 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5894 =for apidoc sv_pos_u2b
5896 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5897 the start of the string, to a count of the equivalent number of bytes; if
5898 lenp is non-zero, it does the same to lenp, but this time starting from
5899 the offset, rather than from the start of the string. Handles magic and
5906 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5907 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5908 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5913 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5918 PERL_ARGS_ASSERT_SV_POS_U2B;
5923 start = (U8*)SvPV_const(sv, len);
5925 STRLEN uoffset = (STRLEN) *offsetp;
5926 const U8 * const send = start + len;
5928 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5931 *offsetp = (I32) boffset;
5934 /* Convert the relative offset to absolute. */
5935 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5936 const STRLEN boffset2
5937 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5938 uoffset, boffset) - boffset;
5952 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5953 byte length pairing. The (byte) length of the total SV is passed in too,
5954 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5955 may not have updated SvCUR, so we can't rely on reading it directly.
5957 The proffered utf8/byte length pairing isn't used if the cache already has
5958 two pairs, and swapping either for the proffered pair would increase the
5959 RMS of the intervals between known byte offsets.
5961 The cache itself consists of 4 STRLEN values
5962 0: larger UTF-8 offset
5963 1: corresponding byte offset
5964 2: smaller UTF-8 offset
5965 3: corresponding byte offset
5967 Unused cache pairs have the value 0, 0.
5968 Keeping the cache "backwards" means that the invariant of
5969 cache[0] >= cache[2] is maintained even with empty slots, which means that
5970 the code that uses it doesn't need to worry if only 1 entry has actually
5971 been set to non-zero. It also makes the "position beyond the end of the
5972 cache" logic much simpler, as the first slot is always the one to start
5976 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5977 const STRLEN utf8, const STRLEN blen)
5981 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5987 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5989 (*mgp)->mg_len = -1;
5993 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5994 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5995 (*mgp)->mg_ptr = (char *) cache;
5999 if (PL_utf8cache < 0) {
6000 const U8 *start = (const U8 *) SvPVX_const(sv);
6001 const STRLEN realutf8 = utf8_length(start, start + byte);
6003 if (realutf8 != utf8) {
6004 /* Need to turn the assertions off otherwise we may recurse
6005 infinitely while printing error messages. */
6006 SAVEI8(PL_utf8cache);
6008 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6009 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6013 /* Cache is held with the later position first, to simplify the code
6014 that deals with unbounded ends. */
6016 ASSERT_UTF8_CACHE(cache);
6017 if (cache[1] == 0) {
6018 /* Cache is totally empty */
6021 } else if (cache[3] == 0) {
6022 if (byte > cache[1]) {
6023 /* New one is larger, so goes first. */
6024 cache[2] = cache[0];
6025 cache[3] = cache[1];
6033 #define THREEWAY_SQUARE(a,b,c,d) \
6034 ((float)((d) - (c))) * ((float)((d) - (c))) \
6035 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6036 + ((float)((b) - (a))) * ((float)((b) - (a)))
6038 /* Cache has 2 slots in use, and we know three potential pairs.
6039 Keep the two that give the lowest RMS distance. Do the
6040 calcualation in bytes simply because we always know the byte
6041 length. squareroot has the same ordering as the positive value,
6042 so don't bother with the actual square root. */
6043 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6044 if (byte > cache[1]) {
6045 /* New position is after the existing pair of pairs. */
6046 const float keep_earlier
6047 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6048 const float keep_later
6049 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6051 if (keep_later < keep_earlier) {
6052 if (keep_later < existing) {
6053 cache[2] = cache[0];
6054 cache[3] = cache[1];
6060 if (keep_earlier < existing) {
6066 else if (byte > cache[3]) {
6067 /* New position is between the existing pair of pairs. */
6068 const float keep_earlier
6069 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6070 const float keep_later
6071 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6073 if (keep_later < keep_earlier) {
6074 if (keep_later < existing) {
6080 if (keep_earlier < existing) {
6087 /* New position is before the existing pair of pairs. */
6088 const float keep_earlier
6089 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6090 const float keep_later
6091 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6093 if (keep_later < keep_earlier) {
6094 if (keep_later < existing) {
6100 if (keep_earlier < existing) {
6101 cache[0] = cache[2];
6102 cache[1] = cache[3];
6109 ASSERT_UTF8_CACHE(cache);
6112 /* We already know all of the way, now we may be able to walk back. The same
6113 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6114 backward is half the speed of walking forward. */
6116 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6117 const U8 *end, STRLEN endu)
6119 const STRLEN forw = target - s;
6120 STRLEN backw = end - target;
6122 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6124 if (forw < 2 * backw) {
6125 return utf8_length(s, target);
6128 while (end > target) {
6130 while (UTF8_IS_CONTINUATION(*end)) {
6139 =for apidoc sv_pos_b2u
6141 Converts the value pointed to by offsetp from a count of bytes from the
6142 start of the string, to a count of the equivalent number of UTF-8 chars.
6143 Handles magic and type coercion.
6149 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6150 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6155 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6158 const STRLEN byte = *offsetp;
6159 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6165 PERL_ARGS_ASSERT_SV_POS_B2U;
6170 s = (const U8*)SvPV_const(sv, blen);
6173 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6177 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6178 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6180 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6181 if (cache[1] == byte) {
6182 /* An exact match. */
6183 *offsetp = cache[0];
6186 if (cache[3] == byte) {
6187 /* An exact match. */
6188 *offsetp = cache[2];
6192 if (cache[1] < byte) {
6193 /* We already know part of the way. */
6194 if (mg->mg_len != -1) {
6195 /* Actually, we know the end too. */
6197 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6198 s + blen, mg->mg_len - cache[0]);
6200 len = cache[0] + utf8_length(s + cache[1], send);
6203 else if (cache[3] < byte) {
6204 /* We're between the two cached pairs, so we do the calculation
6205 offset by the byte/utf-8 positions for the earlier pair,
6206 then add the utf-8 characters from the string start to
6208 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6209 s + cache[1], cache[0] - cache[2])
6213 else { /* cache[3] > byte */
6214 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6218 ASSERT_UTF8_CACHE(cache);
6220 } else if (mg->mg_len != -1) {
6221 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6225 if (!found || PL_utf8cache < 0) {
6226 const STRLEN real_len = utf8_length(s, send);
6228 if (found && PL_utf8cache < 0) {
6229 if (len != real_len) {
6230 /* Need to turn the assertions off otherwise we may recurse
6231 infinitely while printing error messages. */
6232 SAVEI8(PL_utf8cache);
6234 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6235 " real %"UVuf" for %"SVf,
6236 (UV) len, (UV) real_len, SVfARG(sv));
6244 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6250 Returns a boolean indicating whether the strings in the two SVs are
6251 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6252 coerce its args to strings if necessary.
6258 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6267 SV* svrecode = NULL;
6274 /* if pv1 and pv2 are the same, second SvPV_const call may
6275 * invalidate pv1, so we may need to make a copy */
6276 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6277 pv1 = SvPV_const(sv1, cur1);
6278 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6280 pv1 = SvPV_const(sv1, cur1);
6288 pv2 = SvPV_const(sv2, cur2);
6290 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6291 /* Differing utf8ness.
6292 * Do not UTF8size the comparands as a side-effect. */
6295 svrecode = newSVpvn(pv2, cur2);
6296 sv_recode_to_utf8(svrecode, PL_encoding);
6297 pv2 = SvPV_const(svrecode, cur2);
6300 svrecode = newSVpvn(pv1, cur1);
6301 sv_recode_to_utf8(svrecode, PL_encoding);
6302 pv1 = SvPV_const(svrecode, cur1);
6304 /* Now both are in UTF-8. */
6306 SvREFCNT_dec(svrecode);
6311 bool is_utf8 = TRUE;
6314 /* sv1 is the UTF-8 one,
6315 * if is equal it must be downgrade-able */
6316 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6322 /* sv2 is the UTF-8 one,
6323 * if is equal it must be downgrade-able */
6324 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6330 /* Downgrade not possible - cannot be eq */
6338 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6340 SvREFCNT_dec(svrecode);
6350 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6351 string in C<sv1> is less than, equal to, or greater than the string in
6352 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6353 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6359 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6363 const char *pv1, *pv2;
6366 SV *svrecode = NULL;
6373 pv1 = SvPV_const(sv1, cur1);
6380 pv2 = SvPV_const(sv2, cur2);
6382 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6383 /* Differing utf8ness.
6384 * Do not UTF8size the comparands as a side-effect. */
6387 svrecode = newSVpvn(pv2, cur2);
6388 sv_recode_to_utf8(svrecode, PL_encoding);
6389 pv2 = SvPV_const(svrecode, cur2);
6392 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6397 svrecode = newSVpvn(pv1, cur1);
6398 sv_recode_to_utf8(svrecode, PL_encoding);
6399 pv1 = SvPV_const(svrecode, cur1);
6402 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6408 cmp = cur2 ? -1 : 0;
6412 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6415 cmp = retval < 0 ? -1 : 1;
6416 } else if (cur1 == cur2) {
6419 cmp = cur1 < cur2 ? -1 : 1;
6423 SvREFCNT_dec(svrecode);
6431 =for apidoc sv_cmp_locale
6433 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6434 'use bytes' aware, handles get magic, and will coerce its args to strings
6435 if necessary. See also C<sv_cmp>.
6441 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6444 #ifdef USE_LOCALE_COLLATE
6450 if (PL_collation_standard)
6454 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6456 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6458 if (!pv1 || !len1) {
6469 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6472 return retval < 0 ? -1 : 1;
6475 * When the result of collation is equality, that doesn't mean
6476 * that there are no differences -- some locales exclude some
6477 * characters from consideration. So to avoid false equalities,
6478 * we use the raw string as a tiebreaker.
6484 #endif /* USE_LOCALE_COLLATE */
6486 return sv_cmp(sv1, sv2);
6490 #ifdef USE_LOCALE_COLLATE
6493 =for apidoc sv_collxfrm
6495 Add Collate Transform magic to an SV if it doesn't already have it.
6497 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6498 scalar data of the variable, but transformed to such a format that a normal
6499 memory comparison can be used to compare the data according to the locale
6506 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6511 PERL_ARGS_ASSERT_SV_COLLXFRM;
6513 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6514 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6520 Safefree(mg->mg_ptr);
6521 s = SvPV_const(sv, len);
6522 if ((xf = mem_collxfrm(s, len, &xlen))) {
6524 #ifdef PERL_OLD_COPY_ON_WRITE
6526 sv_force_normal_flags(sv, 0);
6528 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6542 if (mg && mg->mg_ptr) {
6544 return mg->mg_ptr + sizeof(PL_collation_ix);
6552 #endif /* USE_LOCALE_COLLATE */
6557 Get a line from the filehandle and store it into the SV, optionally
6558 appending to the currently-stored string.
6564 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6569 register STDCHAR rslast;
6570 register STDCHAR *bp;
6575 PERL_ARGS_ASSERT_SV_GETS;
6577 if (SvTHINKFIRST(sv))
6578 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6579 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6581 However, perlbench says it's slower, because the existing swipe code
6582 is faster than copy on write.
6583 Swings and roundabouts. */
6584 SvUPGRADE(sv, SVt_PV);
6589 if (PerlIO_isutf8(fp)) {
6591 sv_utf8_upgrade_nomg(sv);
6592 sv_pos_u2b(sv,&append,0);
6594 } else if (SvUTF8(sv)) {
6595 SV * const tsv = newSV(0);
6596 sv_gets(tsv, fp, 0);
6597 sv_utf8_upgrade_nomg(tsv);
6598 SvCUR_set(sv,append);
6601 goto return_string_or_null;
6606 if (PerlIO_isutf8(fp))
6609 if (IN_PERL_COMPILETIME) {
6610 /* we always read code in line mode */
6614 else if (RsSNARF(PL_rs)) {
6615 /* If it is a regular disk file use size from stat() as estimate
6616 of amount we are going to read -- may result in mallocing
6617 more memory than we really need if the layers below reduce
6618 the size we read (e.g. CRLF or a gzip layer).
6621 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6622 const Off_t offset = PerlIO_tell(fp);
6623 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6624 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6630 else if (RsRECORD(PL_rs)) {
6635 /* Grab the size of the record we're getting */
6636 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6637 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6640 /* VMS wants read instead of fread, because fread doesn't respect */
6641 /* RMS record boundaries. This is not necessarily a good thing to be */
6642 /* doing, but we've got no other real choice - except avoid stdio
6643 as implementation - perhaps write a :vms layer ?
6645 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6647 bytesread = PerlIO_read(fp, buffer, recsize);
6651 SvCUR_set(sv, bytesread += append);
6652 buffer[bytesread] = '\0';
6653 goto return_string_or_null;
6655 else if (RsPARA(PL_rs)) {
6661 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6662 if (PerlIO_isutf8(fp)) {
6663 rsptr = SvPVutf8(PL_rs, rslen);
6666 if (SvUTF8(PL_rs)) {
6667 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6668 Perl_croak(aTHX_ "Wide character in $/");
6671 rsptr = SvPV_const(PL_rs, rslen);
6675 rslast = rslen ? rsptr[rslen - 1] : '\0';
6677 if (rspara) { /* have to do this both before and after */
6678 do { /* to make sure file boundaries work right */
6681 i = PerlIO_getc(fp);
6685 PerlIO_ungetc(fp,i);
6691 /* See if we know enough about I/O mechanism to cheat it ! */
6693 /* This used to be #ifdef test - it is made run-time test for ease
6694 of abstracting out stdio interface. One call should be cheap
6695 enough here - and may even be a macro allowing compile
6699 if (PerlIO_fast_gets(fp)) {
6702 * We're going to steal some values from the stdio struct
6703 * and put EVERYTHING in the innermost loop into registers.
6705 register STDCHAR *ptr;
6709 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6710 /* An ungetc()d char is handled separately from the regular
6711 * buffer, so we getc() it back out and stuff it in the buffer.
6713 i = PerlIO_getc(fp);
6714 if (i == EOF) return 0;
6715 *(--((*fp)->_ptr)) = (unsigned char) i;
6719 /* Here is some breathtakingly efficient cheating */
6721 cnt = PerlIO_get_cnt(fp); /* get count into register */
6722 /* make sure we have the room */
6723 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6724 /* Not room for all of it
6725 if we are looking for a separator and room for some
6727 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6728 /* just process what we have room for */
6729 shortbuffered = cnt - SvLEN(sv) + append + 1;
6730 cnt -= shortbuffered;
6734 /* remember that cnt can be negative */
6735 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6740 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6741 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6742 DEBUG_P(PerlIO_printf(Perl_debug_log,
6743 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6744 DEBUG_P(PerlIO_printf(Perl_debug_log,
6745 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6746 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6747 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6752 while (cnt > 0) { /* this | eat */
6754 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6755 goto thats_all_folks; /* screams | sed :-) */
6759 Copy(ptr, bp, cnt, char); /* this | eat */
6760 bp += cnt; /* screams | dust */
6761 ptr += cnt; /* louder | sed :-) */
6766 if (shortbuffered) { /* oh well, must extend */
6767 cnt = shortbuffered;
6769 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6771 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6772 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6776 DEBUG_P(PerlIO_printf(Perl_debug_log,
6777 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6778 PTR2UV(ptr),(long)cnt));
6779 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6781 DEBUG_P(PerlIO_printf(Perl_debug_log,
6782 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6783 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6784 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6786 /* This used to call 'filbuf' in stdio form, but as that behaves like
6787 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6788 another abstraction. */
6789 i = PerlIO_getc(fp); /* get more characters */
6791 DEBUG_P(PerlIO_printf(Perl_debug_log,
6792 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6793 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6794 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6796 cnt = PerlIO_get_cnt(fp);
6797 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6798 DEBUG_P(PerlIO_printf(Perl_debug_log,
6799 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6801 if (i == EOF) /* all done for ever? */
6802 goto thats_really_all_folks;
6804 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6806 SvGROW(sv, bpx + cnt + 2);
6807 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6809 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6811 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6812 goto thats_all_folks;
6816 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6817 memNE((char*)bp - rslen, rsptr, rslen))
6818 goto screamer; /* go back to the fray */
6819 thats_really_all_folks:
6821 cnt += shortbuffered;
6822 DEBUG_P(PerlIO_printf(Perl_debug_log,
6823 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6824 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6825 DEBUG_P(PerlIO_printf(Perl_debug_log,
6826 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6827 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6828 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6830 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6831 DEBUG_P(PerlIO_printf(Perl_debug_log,
6832 "Screamer: done, len=%ld, string=|%.*s|\n",
6833 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6837 /*The big, slow, and stupid way. */
6838 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6839 STDCHAR *buf = NULL;
6840 Newx(buf, 8192, STDCHAR);
6848 register const STDCHAR * const bpe = buf + sizeof(buf);
6850 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6851 ; /* keep reading */
6855 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6856 /* Accomodate broken VAXC compiler, which applies U8 cast to
6857 * both args of ?: operator, causing EOF to change into 255
6860 i = (U8)buf[cnt - 1];
6866 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6868 sv_catpvn(sv, (char *) buf, cnt);
6870 sv_setpvn(sv, (char *) buf, cnt);
6872 if (i != EOF && /* joy */
6874 SvCUR(sv) < rslen ||
6875 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6879 * If we're reading from a TTY and we get a short read,
6880 * indicating that the user hit his EOF character, we need
6881 * to notice it now, because if we try to read from the TTY
6882 * again, the EOF condition will disappear.
6884 * The comparison of cnt to sizeof(buf) is an optimization
6885 * that prevents unnecessary calls to feof().
6889 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6893 #ifdef USE_HEAP_INSTEAD_OF_STACK
6898 if (rspara) { /* have to do this both before and after */
6899 while (i != EOF) { /* to make sure file boundaries work right */
6900 i = PerlIO_getc(fp);
6902 PerlIO_ungetc(fp,i);
6908 return_string_or_null:
6909 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6915 Auto-increment of the value in the SV, doing string to numeric conversion
6916 if necessary. Handles 'get' magic.
6922 Perl_sv_inc(pTHX_ register SV *const sv)
6931 if (SvTHINKFIRST(sv)) {
6933 sv_force_normal_flags(sv, 0);
6934 if (SvREADONLY(sv)) {
6935 if (IN_PERL_RUNTIME)
6936 Perl_croak(aTHX_ PL_no_modify);
6940 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6942 i = PTR2IV(SvRV(sv));
6947 flags = SvFLAGS(sv);
6948 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6949 /* It's (privately or publicly) a float, but not tested as an
6950 integer, so test it to see. */
6952 flags = SvFLAGS(sv);
6954 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6955 /* It's publicly an integer, or privately an integer-not-float */
6956 #ifdef PERL_PRESERVE_IVUV
6960 if (SvUVX(sv) == UV_MAX)
6961 sv_setnv(sv, UV_MAX_P1);
6963 (void)SvIOK_only_UV(sv);
6964 SvUV_set(sv, SvUVX(sv) + 1);
6966 if (SvIVX(sv) == IV_MAX)
6967 sv_setuv(sv, (UV)IV_MAX + 1);
6969 (void)SvIOK_only(sv);
6970 SvIV_set(sv, SvIVX(sv) + 1);
6975 if (flags & SVp_NOK) {
6976 const NV was = SvNVX(sv);
6977 if (NV_OVERFLOWS_INTEGERS_AT &&
6978 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6979 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6980 "Lost precision when incrementing %" NVff " by 1",
6983 (void)SvNOK_only(sv);
6984 SvNV_set(sv, was + 1.0);
6988 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6989 if ((flags & SVTYPEMASK) < SVt_PVIV)
6990 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6991 (void)SvIOK_only(sv);
6996 while (isALPHA(*d)) d++;
6997 while (isDIGIT(*d)) d++;
6999 #ifdef PERL_PRESERVE_IVUV
7000 /* Got to punt this as an integer if needs be, but we don't issue
7001 warnings. Probably ought to make the sv_iv_please() that does
7002 the conversion if possible, and silently. */
7003 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7004 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7005 /* Need to try really hard to see if it's an integer.
7006 9.22337203685478e+18 is an integer.
7007 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7008 so $a="9.22337203685478e+18"; $a+0; $a++
7009 needs to be the same as $a="9.22337203685478e+18"; $a++
7016 /* sv_2iv *should* have made this an NV */
7017 if (flags & SVp_NOK) {
7018 (void)SvNOK_only(sv);
7019 SvNV_set(sv, SvNVX(sv) + 1.0);
7022 /* I don't think we can get here. Maybe I should assert this
7023 And if we do get here I suspect that sv_setnv will croak. NWC
7025 #if defined(USE_LONG_DOUBLE)
7026 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",
7027 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7029 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7030 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7033 #endif /* PERL_PRESERVE_IVUV */
7034 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7038 while (d >= SvPVX_const(sv)) {
7046 /* MKS: The original code here died if letters weren't consecutive.
7047 * at least it didn't have to worry about non-C locales. The
7048 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7049 * arranged in order (although not consecutively) and that only
7050 * [A-Za-z] are accepted by isALPHA in the C locale.
7052 if (*d != 'z' && *d != 'Z') {
7053 do { ++*d; } while (!isALPHA(*d));
7056 *(d--) -= 'z' - 'a';
7061 *(d--) -= 'z' - 'a' + 1;
7065 /* oh,oh, the number grew */
7066 SvGROW(sv, SvCUR(sv) + 2);
7067 SvCUR_set(sv, SvCUR(sv) + 1);
7068 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7079 Auto-decrement of the value in the SV, doing string to numeric conversion
7080 if necessary. Handles 'get' magic.
7086 Perl_sv_dec(pTHX_ register SV *const sv)
7094 if (SvTHINKFIRST(sv)) {
7096 sv_force_normal_flags(sv, 0);
7097 if (SvREADONLY(sv)) {
7098 if (IN_PERL_RUNTIME)
7099 Perl_croak(aTHX_ PL_no_modify);
7103 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7105 i = PTR2IV(SvRV(sv));
7110 /* Unlike sv_inc we don't have to worry about string-never-numbers
7111 and keeping them magic. But we mustn't warn on punting */
7112 flags = SvFLAGS(sv);
7113 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7114 /* It's publicly an integer, or privately an integer-not-float */
7115 #ifdef PERL_PRESERVE_IVUV
7119 if (SvUVX(sv) == 0) {
7120 (void)SvIOK_only(sv);
7124 (void)SvIOK_only_UV(sv);
7125 SvUV_set(sv, SvUVX(sv) - 1);
7128 if (SvIVX(sv) == IV_MIN) {
7129 sv_setnv(sv, (NV)IV_MIN);
7133 (void)SvIOK_only(sv);
7134 SvIV_set(sv, SvIVX(sv) - 1);
7139 if (flags & SVp_NOK) {
7142 const NV was = SvNVX(sv);
7143 if (NV_OVERFLOWS_INTEGERS_AT &&
7144 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7145 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7146 "Lost precision when decrementing %" NVff " by 1",
7149 (void)SvNOK_only(sv);
7150 SvNV_set(sv, was - 1.0);
7154 if (!(flags & SVp_POK)) {
7155 if ((flags & SVTYPEMASK) < SVt_PVIV)
7156 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7158 (void)SvIOK_only(sv);
7161 #ifdef PERL_PRESERVE_IVUV
7163 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7164 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7165 /* Need to try really hard to see if it's an integer.
7166 9.22337203685478e+18 is an integer.
7167 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7168 so $a="9.22337203685478e+18"; $a+0; $a--
7169 needs to be the same as $a="9.22337203685478e+18"; $a--
7176 /* sv_2iv *should* have made this an NV */
7177 if (flags & SVp_NOK) {
7178 (void)SvNOK_only(sv);
7179 SvNV_set(sv, SvNVX(sv) - 1.0);
7182 /* I don't think we can get here. Maybe I should assert this
7183 And if we do get here I suspect that sv_setnv will croak. NWC
7185 #if defined(USE_LONG_DOUBLE)
7186 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",
7187 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7189 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7190 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7194 #endif /* PERL_PRESERVE_IVUV */
7195 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7199 =for apidoc sv_mortalcopy
7201 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7202 The new SV is marked as mortal. It will be destroyed "soon", either by an
7203 explicit call to FREETMPS, or by an implicit call at places such as
7204 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7209 /* Make a string that will exist for the duration of the expression
7210 * evaluation. Actually, it may have to last longer than that, but
7211 * hopefully we won't free it until it has been assigned to a
7212 * permanent location. */
7215 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7221 sv_setsv(sv,oldstr);
7223 PL_tmps_stack[++PL_tmps_ix] = sv;
7229 =for apidoc sv_newmortal
7231 Creates a new null SV which is mortal. The reference count of the SV is
7232 set to 1. It will be destroyed "soon", either by an explicit call to
7233 FREETMPS, or by an implicit call at places such as statement boundaries.
7234 See also C<sv_mortalcopy> and C<sv_2mortal>.
7240 Perl_sv_newmortal(pTHX)
7246 SvFLAGS(sv) = SVs_TEMP;
7248 PL_tmps_stack[++PL_tmps_ix] = sv;
7254 =for apidoc newSVpvn_flags
7256 Creates a new SV and copies a string into it. The reference count for the
7257 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7258 string. You are responsible for ensuring that the source string is at least
7259 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7260 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7261 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7262 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7263 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7265 #define newSVpvn_utf8(s, len, u) \
7266 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7272 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7277 /* All the flags we don't support must be zero.
7278 And we're new code so I'm going to assert this from the start. */
7279 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7281 sv_setpvn(sv,s,len);
7282 SvFLAGS(sv) |= (flags & SVf_UTF8);
7283 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7287 =for apidoc sv_2mortal
7289 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7290 by an explicit call to FREETMPS, or by an implicit call at places such as
7291 statement boundaries. SvTEMP() is turned on which means that the SV's
7292 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7293 and C<sv_mortalcopy>.
7299 Perl_sv_2mortal(pTHX_ register SV *const sv)
7304 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7307 PL_tmps_stack[++PL_tmps_ix] = sv;
7315 Creates a new SV and copies a string into it. The reference count for the
7316 SV is set to 1. If C<len> is zero, Perl will compute the length using
7317 strlen(). For efficiency, consider using C<newSVpvn> instead.
7323 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7329 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7334 =for apidoc newSVpvn
7336 Creates a new SV and copies a string into it. The reference count for the
7337 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7338 string. You are responsible for ensuring that the source string is at least
7339 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7345 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7351 sv_setpvn(sv,s,len);
7356 =for apidoc newSVhek
7358 Creates a new SV from the hash key structure. It will generate scalars that
7359 point to the shared string table where possible. Returns a new (undefined)
7360 SV if the hek is NULL.
7366 Perl_newSVhek(pTHX_ const HEK *const hek)
7376 if (HEK_LEN(hek) == HEf_SVKEY) {
7377 return newSVsv(*(SV**)HEK_KEY(hek));
7379 const int flags = HEK_FLAGS(hek);
7380 if (flags & HVhek_WASUTF8) {
7382 Andreas would like keys he put in as utf8 to come back as utf8
7384 STRLEN utf8_len = HEK_LEN(hek);
7385 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7386 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7389 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7391 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7392 /* We don't have a pointer to the hv, so we have to replicate the
7393 flag into every HEK. This hv is using custom a hasing
7394 algorithm. Hence we can't return a shared string scalar, as
7395 that would contain the (wrong) hash value, and might get passed
7396 into an hv routine with a regular hash.
7397 Similarly, a hash that isn't using shared hash keys has to have
7398 the flag in every key so that we know not to try to call
7399 share_hek_kek on it. */
7401 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7406 /* This will be overwhelminly the most common case. */
7408 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7409 more efficient than sharepvn(). */
7413 sv_upgrade(sv, SVt_PV);
7414 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7415 SvCUR_set(sv, HEK_LEN(hek));
7428 =for apidoc newSVpvn_share
7430 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7431 table. If the string does not already exist in the table, it is created
7432 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7433 value is used; otherwise the hash is computed. The string's hash can be later
7434 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7435 that as the string table is used for shared hash keys these strings will have
7436 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7442 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7446 bool is_utf8 = FALSE;
7447 const char *const orig_src = src;
7450 STRLEN tmplen = -len;
7452 /* See the note in hv.c:hv_fetch() --jhi */
7453 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7457 PERL_HASH(hash, src, len);
7459 sv_upgrade(sv, SVt_PV);
7460 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7468 if (src != orig_src)
7474 #if defined(PERL_IMPLICIT_CONTEXT)
7476 /* pTHX_ magic can't cope with varargs, so this is a no-context
7477 * version of the main function, (which may itself be aliased to us).
7478 * Don't access this version directly.
7482 Perl_newSVpvf_nocontext(const char *const pat, ...)
7488 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7490 va_start(args, pat);
7491 sv = vnewSVpvf(pat, &args);
7498 =for apidoc newSVpvf
7500 Creates a new SV and initializes it with the string formatted like
7507 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7512 PERL_ARGS_ASSERT_NEWSVPVF;
7514 va_start(args, pat);
7515 sv = vnewSVpvf(pat, &args);
7520 /* backend for newSVpvf() and newSVpvf_nocontext() */
7523 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7528 PERL_ARGS_ASSERT_VNEWSVPVF;
7531 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7538 Creates a new SV and copies a floating point value into it.
7539 The reference count for the SV is set to 1.
7545 Perl_newSVnv(pTHX_ const NV n)
7558 Creates a new SV and copies an integer into it. The reference count for the
7565 Perl_newSViv(pTHX_ const IV i)
7578 Creates a new SV and copies an unsigned integer into it.
7579 The reference count for the SV is set to 1.
7585 Perl_newSVuv(pTHX_ const UV u)
7596 =for apidoc newSV_type
7598 Creates a new SV, of the type specified. The reference count for the new SV
7605 Perl_newSV_type(pTHX_ const svtype type)
7610 sv_upgrade(sv, type);
7615 =for apidoc newRV_noinc
7617 Creates an RV wrapper for an SV. The reference count for the original
7618 SV is B<not> incremented.
7624 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7627 register SV *sv = newSV_type(SVt_IV);
7629 PERL_ARGS_ASSERT_NEWRV_NOINC;
7632 SvRV_set(sv, tmpRef);
7637 /* newRV_inc is the official function name to use now.
7638 * newRV_inc is in fact #defined to newRV in sv.h
7642 Perl_newRV(pTHX_ SV *const sv)
7646 PERL_ARGS_ASSERT_NEWRV;
7648 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7654 Creates a new SV which is an exact duplicate of the original SV.
7661 Perl_newSVsv(pTHX_ register SV *const old)
7668 if (SvTYPE(old) == SVTYPEMASK) {
7669 if (ckWARN_d(WARN_INTERNAL))
7670 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7674 /* SV_GMAGIC is the default for sv_setv()
7675 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7676 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7677 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7682 =for apidoc sv_reset
7684 Underlying implementation for the C<reset> Perl function.
7685 Note that the perl-level function is vaguely deprecated.
7691 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7694 char todo[PERL_UCHAR_MAX+1];
7696 PERL_ARGS_ASSERT_SV_RESET;
7701 if (!*s) { /* reset ?? searches */
7702 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7704 const U32 count = mg->mg_len / sizeof(PMOP**);
7705 PMOP **pmp = (PMOP**) mg->mg_ptr;
7706 PMOP *const *const end = pmp + count;
7710 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7712 (*pmp)->op_pmflags &= ~PMf_USED;
7720 /* reset variables */
7722 if (!HvARRAY(stash))
7725 Zero(todo, 256, char);
7728 I32 i = (unsigned char)*s;
7732 max = (unsigned char)*s++;
7733 for ( ; i <= max; i++) {
7736 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7738 for (entry = HvARRAY(stash)[i];
7740 entry = HeNEXT(entry))
7745 if (!todo[(U8)*HeKEY(entry)])
7747 gv = (GV*)HeVAL(entry);
7750 if (SvTHINKFIRST(sv)) {
7751 if (!SvREADONLY(sv) && SvROK(sv))
7753 /* XXX Is this continue a bug? Why should THINKFIRST
7754 exempt us from resetting arrays and hashes? */
7758 if (SvTYPE(sv) >= SVt_PV) {
7760 if (SvPVX_const(sv) != NULL)
7768 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7770 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7773 # if defined(USE_ENVIRON_ARRAY)
7776 # endif /* USE_ENVIRON_ARRAY */
7787 Using various gambits, try to get an IO from an SV: the IO slot if its a
7788 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7789 named after the PV if we're a string.
7795 Perl_sv_2io(pTHX_ SV *const sv)
7800 PERL_ARGS_ASSERT_SV_2IO;
7802 switch (SvTYPE(sv)) {
7810 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7814 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7816 return sv_2io(SvRV(sv));
7817 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7823 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7832 Using various gambits, try to get a CV from an SV; in addition, try if
7833 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7834 The flags in C<lref> are passed to sv_fetchsv.
7840 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7846 PERL_ARGS_ASSERT_SV_2CV;
7853 switch (SvTYPE(sv)) {
7872 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7873 tryAMAGICunDEREF(to_cv);
7876 if (SvTYPE(sv) == SVt_PVCV) {
7885 Perl_croak(aTHX_ "Not a subroutine reference");
7890 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7896 /* Some flags to gv_fetchsv mean don't really create the GV */
7897 if (SvTYPE(gv) != SVt_PVGV) {
7903 if (lref && !GvCVu(gv)) {
7907 gv_efullname3(tmpsv, gv, NULL);
7908 /* XXX this is probably not what they think they're getting.
7909 * It has the same effect as "sub name;", i.e. just a forward
7911 newSUB(start_subparse(FALSE, 0),
7912 newSVOP(OP_CONST, 0, tmpsv),
7916 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7917 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7926 Returns true if the SV has a true value by Perl's rules.
7927 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7928 instead use an in-line version.
7934 Perl_sv_true(pTHX_ register SV *const sv)
7939 register const XPV* const tXpv = (XPV*)SvANY(sv);
7941 (tXpv->xpv_cur > 1 ||
7942 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7949 return SvIVX(sv) != 0;
7952 return SvNVX(sv) != 0.0;
7954 return sv_2bool(sv);
7960 =for apidoc sv_pvn_force
7962 Get a sensible string out of the SV somehow.
7963 A private implementation of the C<SvPV_force> macro for compilers which
7964 can't cope with complex macro expressions. Always use the macro instead.
7966 =for apidoc sv_pvn_force_flags
7968 Get a sensible string out of the SV somehow.
7969 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7970 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7971 implemented in terms of this function.
7972 You normally want to use the various wrapper macros instead: see
7973 C<SvPV_force> and C<SvPV_force_nomg>
7979 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
7983 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7985 if (SvTHINKFIRST(sv) && !SvROK(sv))
7986 sv_force_normal_flags(sv, 0);
7996 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7997 const char * const ref = sv_reftype(sv,0);
7999 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8000 ref, OP_NAME(PL_op));
8002 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8004 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8005 || isGV_with_GP(sv))
8006 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8008 s = sv_2pv_flags(sv, &len, flags);
8012 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8015 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8016 SvGROW(sv, len + 1);
8017 Move(s,SvPVX(sv),len,char);
8019 SvPVX(sv)[len] = '\0';
8022 SvPOK_on(sv); /* validate pointer */
8024 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8025 PTR2UV(sv),SvPVX_const(sv)));
8028 return SvPVX_mutable(sv);
8032 =for apidoc sv_pvbyten_force
8034 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8040 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8042 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8044 sv_pvn_force(sv,lp);
8045 sv_utf8_downgrade(sv,0);
8051 =for apidoc sv_pvutf8n_force
8053 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8059 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8061 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8063 sv_pvn_force(sv,lp);
8064 sv_utf8_upgrade(sv);
8070 =for apidoc sv_reftype
8072 Returns a string describing what the SV is a reference to.
8078 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8080 PERL_ARGS_ASSERT_SV_REFTYPE;
8082 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8083 inside return suggests a const propagation bug in g++. */
8084 if (ob && SvOBJECT(sv)) {
8085 char * const name = HvNAME_get(SvSTASH(sv));
8086 return name ? name : (char *) "__ANON__";
8089 switch (SvTYPE(sv)) {
8104 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8105 /* tied lvalues should appear to be
8106 * scalars for backwards compatitbility */
8107 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8108 ? "SCALAR" : "LVALUE");
8109 case SVt_PVAV: return "ARRAY";
8110 case SVt_PVHV: return "HASH";
8111 case SVt_PVCV: return "CODE";
8112 case SVt_PVGV: return "GLOB";
8113 case SVt_PVFM: return "FORMAT";
8114 case SVt_PVIO: return "IO";
8115 case SVt_BIND: return "BIND";
8116 case SVt_REGEXP: return "REGEXP";
8117 default: return "UNKNOWN";
8123 =for apidoc sv_isobject
8125 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8126 object. If the SV is not an RV, or if the object is not blessed, then this
8133 Perl_sv_isobject(pTHX_ SV *sv)
8149 Returns a boolean indicating whether the SV is blessed into the specified
8150 class. This does not check for subtypes; use C<sv_derived_from> to verify
8151 an inheritance relationship.
8157 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8161 PERL_ARGS_ASSERT_SV_ISA;
8171 hvname = HvNAME_get(SvSTASH(sv));
8175 return strEQ(hvname, name);
8181 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8182 it will be upgraded to one. If C<classname> is non-null then the new SV will
8183 be blessed in the specified package. The new SV is returned and its
8184 reference count is 1.
8190 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8195 PERL_ARGS_ASSERT_NEWSVRV;
8199 SV_CHECK_THINKFIRST_COW_DROP(rv);
8200 (void)SvAMAGIC_off(rv);
8202 if (SvTYPE(rv) >= SVt_PVMG) {
8203 const U32 refcnt = SvREFCNT(rv);
8207 SvREFCNT(rv) = refcnt;
8209 sv_upgrade(rv, SVt_IV);
8210 } else if (SvROK(rv)) {
8211 SvREFCNT_dec(SvRV(rv));
8213 prepare_SV_for_RV(rv);
8221 HV* const stash = gv_stashpv(classname, GV_ADD);
8222 (void)sv_bless(rv, stash);
8228 =for apidoc sv_setref_pv
8230 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8231 argument will be upgraded to an RV. That RV will be modified to point to
8232 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8233 into the SV. The C<classname> argument indicates the package for the
8234 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8235 will have a reference count of 1, and the RV will be returned.
8237 Do not use with other Perl types such as HV, AV, SV, CV, because those
8238 objects will become corrupted by the pointer copy process.
8240 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8246 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8250 PERL_ARGS_ASSERT_SV_SETREF_PV;
8253 sv_setsv(rv, &PL_sv_undef);
8257 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8262 =for apidoc sv_setref_iv
8264 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8265 argument will be upgraded to an RV. That RV will be modified to point to
8266 the new SV. The C<classname> argument indicates the package for the
8267 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8268 will have a reference count of 1, and the RV will be returned.
8274 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8276 PERL_ARGS_ASSERT_SV_SETREF_IV;
8278 sv_setiv(newSVrv(rv,classname), iv);
8283 =for apidoc sv_setref_uv
8285 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8286 argument will be upgraded to an RV. That RV will be modified to point to
8287 the new SV. The C<classname> argument indicates the package for the
8288 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8289 will have a reference count of 1, and the RV will be returned.
8295 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8297 PERL_ARGS_ASSERT_SV_SETREF_UV;
8299 sv_setuv(newSVrv(rv,classname), uv);
8304 =for apidoc sv_setref_nv
8306 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8307 argument will be upgraded to an RV. That RV will be modified to point to
8308 the new SV. The C<classname> argument indicates the package for the
8309 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8310 will have a reference count of 1, and the RV will be returned.
8316 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8318 PERL_ARGS_ASSERT_SV_SETREF_NV;
8320 sv_setnv(newSVrv(rv,classname), nv);
8325 =for apidoc sv_setref_pvn
8327 Copies a string into a new SV, optionally blessing the SV. The length of the
8328 string must be specified with C<n>. The C<rv> argument will be upgraded to
8329 an RV. That RV will be modified to point to the new SV. The C<classname>
8330 argument indicates the package for the blessing. Set C<classname> to
8331 C<NULL> to avoid the blessing. The new SV will have a reference count
8332 of 1, and the RV will be returned.
8334 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8340 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8341 const char *const pv, const STRLEN n)
8343 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8345 sv_setpvn(newSVrv(rv,classname), pv, n);
8350 =for apidoc sv_bless
8352 Blesses an SV into a specified package. The SV must be an RV. The package
8353 must be designated by its stash (see C<gv_stashpv()>). The reference count
8354 of the SV is unaffected.
8360 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8365 PERL_ARGS_ASSERT_SV_BLESS;
8368 Perl_croak(aTHX_ "Can't bless non-reference value");
8370 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8371 if (SvIsCOW(tmpRef))
8372 sv_force_normal_flags(tmpRef, 0);
8373 if (SvREADONLY(tmpRef))
8374 Perl_croak(aTHX_ PL_no_modify);
8375 if (SvOBJECT(tmpRef)) {
8376 if (SvTYPE(tmpRef) != SVt_PVIO)
8378 SvREFCNT_dec(SvSTASH(tmpRef));
8381 SvOBJECT_on(tmpRef);
8382 if (SvTYPE(tmpRef) != SVt_PVIO)
8384 SvUPGRADE(tmpRef, SVt_PVMG);
8385 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8390 (void)SvAMAGIC_off(sv);
8392 if(SvSMAGICAL(tmpRef))
8393 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8401 /* Downgrades a PVGV to a PVMG.
8405 S_sv_unglob(pTHX_ SV *const sv)
8410 SV * const temp = sv_newmortal();
8412 PERL_ARGS_ASSERT_SV_UNGLOB;
8414 assert(SvTYPE(sv) == SVt_PVGV);
8416 gv_efullname3(temp, (GV *) sv, "*");
8419 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8420 mro_method_changed_in(stash);
8424 sv_del_backref((SV*)GvSTASH(sv), sv);
8428 if (GvNAME_HEK(sv)) {
8429 unshare_hek(GvNAME_HEK(sv));
8431 isGV_with_GP_off(sv);
8433 /* need to keep SvANY(sv) in the right arena */
8434 xpvmg = new_XPVMG();
8435 StructCopy(SvANY(sv), xpvmg, XPVMG);
8436 del_XPVGV(SvANY(sv));
8439 SvFLAGS(sv) &= ~SVTYPEMASK;
8440 SvFLAGS(sv) |= SVt_PVMG;
8442 /* Intentionally not calling any local SET magic, as this isn't so much a
8443 set operation as merely an internal storage change. */
8444 sv_setsv_flags(sv, temp, 0);
8448 =for apidoc sv_unref_flags
8450 Unsets the RV status of the SV, and decrements the reference count of
8451 whatever was being referenced by the RV. This can almost be thought of
8452 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8453 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8454 (otherwise the decrementing is conditional on the reference count being
8455 different from one or the reference being a readonly SV).
8462 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8464 SV* const target = SvRV(ref);
8466 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8468 if (SvWEAKREF(ref)) {
8469 sv_del_backref(target, ref);
8471 SvRV_set(ref, NULL);
8474 SvRV_set(ref, NULL);
8476 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8477 assigned to as BEGIN {$a = \"Foo"} will fail. */
8478 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8479 SvREFCNT_dec(target);
8480 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8481 sv_2mortal(target); /* Schedule for freeing later */
8485 =for apidoc sv_untaint
8487 Untaint an SV. Use C<SvTAINTED_off> instead.
8492 Perl_sv_untaint(pTHX_ SV *const sv)
8494 PERL_ARGS_ASSERT_SV_UNTAINT;
8496 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8497 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8504 =for apidoc sv_tainted
8506 Test an SV for taintedness. Use C<SvTAINTED> instead.
8511 Perl_sv_tainted(pTHX_ SV *const sv)
8513 PERL_ARGS_ASSERT_SV_TAINTED;
8515 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8516 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8517 if (mg && (mg->mg_len & 1) )
8524 =for apidoc sv_setpviv
8526 Copies an integer into the given SV, also updating its string value.
8527 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8533 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8535 char buf[TYPE_CHARS(UV)];
8537 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8539 PERL_ARGS_ASSERT_SV_SETPVIV;
8541 sv_setpvn(sv, ptr, ebuf - ptr);
8545 =for apidoc sv_setpviv_mg
8547 Like C<sv_setpviv>, but also handles 'set' magic.
8553 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8555 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8561 #if defined(PERL_IMPLICIT_CONTEXT)
8563 /* pTHX_ magic can't cope with varargs, so this is a no-context
8564 * version of the main function, (which may itself be aliased to us).
8565 * Don't access this version directly.
8569 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8574 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8576 va_start(args, pat);
8577 sv_vsetpvf(sv, pat, &args);
8581 /* pTHX_ magic can't cope with varargs, so this is a no-context
8582 * version of the main function, (which may itself be aliased to us).
8583 * Don't access this version directly.
8587 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8592 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8594 va_start(args, pat);
8595 sv_vsetpvf_mg(sv, pat, &args);
8601 =for apidoc sv_setpvf
8603 Works like C<sv_catpvf> but copies the text into the SV instead of
8604 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8610 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8614 PERL_ARGS_ASSERT_SV_SETPVF;
8616 va_start(args, pat);
8617 sv_vsetpvf(sv, pat, &args);
8622 =for apidoc sv_vsetpvf
8624 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8625 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8627 Usually used via its frontend C<sv_setpvf>.
8633 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8635 PERL_ARGS_ASSERT_SV_VSETPVF;
8637 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8641 =for apidoc sv_setpvf_mg
8643 Like C<sv_setpvf>, but also handles 'set' magic.
8649 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8653 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8655 va_start(args, pat);
8656 sv_vsetpvf_mg(sv, pat, &args);
8661 =for apidoc sv_vsetpvf_mg
8663 Like C<sv_vsetpvf>, but also handles 'set' magic.
8665 Usually used via its frontend C<sv_setpvf_mg>.
8671 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8673 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8675 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8679 #if defined(PERL_IMPLICIT_CONTEXT)
8681 /* pTHX_ magic can't cope with varargs, so this is a no-context
8682 * version of the main function, (which may itself be aliased to us).
8683 * Don't access this version directly.
8687 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8692 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8694 va_start(args, pat);
8695 sv_vcatpvf(sv, pat, &args);
8699 /* pTHX_ magic can't cope with varargs, so this is a no-context
8700 * version of the main function, (which may itself be aliased to us).
8701 * Don't access this version directly.
8705 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8710 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8712 va_start(args, pat);
8713 sv_vcatpvf_mg(sv, pat, &args);
8719 =for apidoc sv_catpvf
8721 Processes its arguments like C<sprintf> and appends the formatted
8722 output to an SV. If the appended data contains "wide" characters
8723 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8724 and characters >255 formatted with %c), the original SV might get
8725 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8726 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8727 valid UTF-8; if the original SV was bytes, the pattern should be too.
8732 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8736 PERL_ARGS_ASSERT_SV_CATPVF;
8738 va_start(args, pat);
8739 sv_vcatpvf(sv, pat, &args);
8744 =for apidoc sv_vcatpvf
8746 Processes its arguments like C<vsprintf> and appends the formatted output
8747 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8749 Usually used via its frontend C<sv_catpvf>.
8755 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8757 PERL_ARGS_ASSERT_SV_VCATPVF;
8759 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8763 =for apidoc sv_catpvf_mg
8765 Like C<sv_catpvf>, but also handles 'set' magic.
8771 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8775 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8777 va_start(args, pat);
8778 sv_vcatpvf_mg(sv, pat, &args);
8783 =for apidoc sv_vcatpvf_mg
8785 Like C<sv_vcatpvf>, but also handles 'set' magic.
8787 Usually used via its frontend C<sv_catpvf_mg>.
8793 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8795 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8797 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8802 =for apidoc sv_vsetpvfn
8804 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8807 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8813 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8814 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8816 PERL_ARGS_ASSERT_SV_VSETPVFN;
8818 sv_setpvn(sv, "", 0);
8819 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8823 S_expect_number(pTHX_ char **const pattern)
8828 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8830 switch (**pattern) {
8831 case '1': case '2': case '3':
8832 case '4': case '5': case '6':
8833 case '7': case '8': case '9':
8834 var = *(*pattern)++ - '0';
8835 while (isDIGIT(**pattern)) {
8836 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8838 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8846 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8848 const int neg = nv < 0;
8851 PERL_ARGS_ASSERT_F0CONVERT;
8859 if (uv & 1 && uv == nv)
8860 uv--; /* Round to even */
8862 const unsigned dig = uv % 10;
8875 =for apidoc sv_vcatpvfn
8877 Processes its arguments like C<vsprintf> and appends the formatted output
8878 to an SV. Uses an array of SVs if the C style variable argument list is
8879 missing (NULL). When running with taint checks enabled, indicates via
8880 C<maybe_tainted> if results are untrustworthy (often due to the use of
8883 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8889 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8890 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8891 vec_utf8 = DO_UTF8(vecsv);
8893 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8896 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8897 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8905 static const char nullstr[] = "(null)";
8907 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8908 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8910 /* Times 4: a decimal digit takes more than 3 binary digits.
8911 * NV_DIG: mantissa takes than many decimal digits.
8912 * Plus 32: Playing safe. */
8913 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8914 /* large enough for "%#.#f" --chip */
8915 /* what about long double NVs? --jhi */
8917 PERL_ARGS_ASSERT_SV_VCATPVFN;
8918 PERL_UNUSED_ARG(maybe_tainted);
8920 /* no matter what, this is a string now */
8921 (void)SvPV_force(sv, origlen);
8923 /* special-case "", "%s", and "%-p" (SVf - see below) */
8926 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8928 const char * const s = va_arg(*args, char*);
8929 sv_catpv(sv, s ? s : nullstr);
8931 else if (svix < svmax) {
8932 sv_catsv(sv, *svargs);
8936 if (args && patlen == 3 && pat[0] == '%' &&
8937 pat[1] == '-' && pat[2] == 'p') {
8938 argsv = (SV*)va_arg(*args, void*);
8939 sv_catsv(sv, argsv);
8943 #ifndef USE_LONG_DOUBLE
8944 /* special-case "%.<number>[gf]" */
8945 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8946 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8947 unsigned digits = 0;
8951 while (*pp >= '0' && *pp <= '9')
8952 digits = 10 * digits + (*pp++ - '0');
8953 if (pp - pat == (int)patlen - 1) {
8961 /* Add check for digits != 0 because it seems that some
8962 gconverts are buggy in this case, and we don't yet have
8963 a Configure test for this. */
8964 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8965 /* 0, point, slack */
8966 Gconvert(nv, (int)digits, 0, ebuf);
8968 if (*ebuf) /* May return an empty string for digits==0 */
8971 } else if (!digits) {
8974 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8975 sv_catpvn(sv, p, l);
8981 #endif /* !USE_LONG_DOUBLE */
8983 if (!args && svix < svmax && DO_UTF8(*svargs))
8986 patend = (char*)pat + patlen;
8987 for (p = (char*)pat; p < patend; p = q) {
8990 bool vectorize = FALSE;
8991 bool vectorarg = FALSE;
8992 bool vec_utf8 = FALSE;
8998 bool has_precis = FALSE;
9000 const I32 osvix = svix;
9001 bool is_utf8 = FALSE; /* is this item utf8? */
9002 #ifdef HAS_LDBL_SPRINTF_BUG
9003 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9004 with sfio - Allen <allens@cpan.org> */
9005 bool fix_ldbl_sprintf_bug = FALSE;
9009 U8 utf8buf[UTF8_MAXBYTES+1];
9010 STRLEN esignlen = 0;
9012 const char *eptr = NULL;
9015 const U8 *vecstr = NULL;
9022 /* we need a long double target in case HAS_LONG_DOUBLE but
9025 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9033 const char *dotstr = ".";
9034 STRLEN dotstrlen = 1;
9035 I32 efix = 0; /* explicit format parameter index */
9036 I32 ewix = 0; /* explicit width index */
9037 I32 epix = 0; /* explicit precision index */
9038 I32 evix = 0; /* explicit vector index */
9039 bool asterisk = FALSE;
9041 /* echo everything up to the next format specification */
9042 for (q = p; q < patend && *q != '%'; ++q) ;
9044 if (has_utf8 && !pat_utf8)
9045 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9047 sv_catpvn(sv, p, q - p);
9054 We allow format specification elements in this order:
9055 \d+\$ explicit format parameter index
9057 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9058 0 flag (as above): repeated to allow "v02"
9059 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9060 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9062 [%bcdefginopsuxDFOUX] format (mandatory)
9067 As of perl5.9.3, printf format checking is on by default.
9068 Internally, perl uses %p formats to provide an escape to
9069 some extended formatting. This block deals with those
9070 extensions: if it does not match, (char*)q is reset and
9071 the normal format processing code is used.
9073 Currently defined extensions are:
9074 %p include pointer address (standard)
9075 %-p (SVf) include an SV (previously %_)
9076 %-<num>p include an SV with precision <num>
9077 %<num>p reserved for future extensions
9079 Robin Barker 2005-07-14
9081 %1p (VDf) removed. RMB 2007-10-19
9088 n = expect_number(&q);
9095 argsv = (SV*)va_arg(*args, void*);
9096 eptr = SvPV_const(argsv, elen);
9102 if (ckWARN_d(WARN_INTERNAL))
9103 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9104 "internal %%<num>p might conflict with future printf extensions");
9110 if ( (width = expect_number(&q)) ) {
9125 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9154 if ( (ewix = expect_number(&q)) )
9163 if ((vectorarg = asterisk)) {
9176 width = expect_number(&q);
9182 vecsv = va_arg(*args, SV*);
9184 vecsv = (evix > 0 && evix <= svmax)
9185 ? svargs[evix-1] : &PL_sv_undef;
9187 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9189 dotstr = SvPV_const(vecsv, dotstrlen);
9190 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9191 bad with tied or overloaded values that return UTF8. */
9194 else if (has_utf8) {
9195 vecsv = sv_mortalcopy(vecsv);
9196 sv_utf8_upgrade(vecsv);
9197 dotstr = SvPV_const(vecsv, dotstrlen);
9204 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9205 vecsv = svargs[efix ? efix-1 : svix++];
9206 vecstr = (U8*)SvPV_const(vecsv,veclen);
9207 vec_utf8 = DO_UTF8(vecsv);
9209 /* if this is a version object, we need to convert
9210 * back into v-string notation and then let the
9211 * vectorize happen normally
9213 if (sv_derived_from(vecsv, "version")) {
9214 char *version = savesvpv(vecsv);
9215 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9216 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9217 "vector argument not supported with alpha versions");
9220 vecsv = sv_newmortal();
9221 scan_vstring(version, version + veclen, vecsv);
9222 vecstr = (U8*)SvPV_const(vecsv, veclen);
9223 vec_utf8 = DO_UTF8(vecsv);
9235 i = va_arg(*args, int);
9237 i = (ewix ? ewix <= svmax : svix < svmax) ?
9238 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9240 width = (i < 0) ? -i : i;
9250 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9252 /* XXX: todo, support specified precision parameter */
9256 i = va_arg(*args, int);
9258 i = (ewix ? ewix <= svmax : svix < svmax)
9259 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9261 has_precis = !(i < 0);
9266 precis = precis * 10 + (*q++ - '0');
9275 case 'I': /* Ix, I32x, and I64x */
9277 if (q[1] == '6' && q[2] == '4') {
9283 if (q[1] == '3' && q[2] == '2') {
9293 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9304 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9305 if (*(q + 1) == 'l') { /* lld, llf */
9331 if (!vectorize && !args) {
9333 const I32 i = efix-1;
9334 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9336 argsv = (svix >= 0 && svix < svmax)
9337 ? svargs[svix++] : &PL_sv_undef;
9348 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9350 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9352 eptr = (char*)utf8buf;
9353 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9367 eptr = va_arg(*args, char*);
9369 #ifdef MACOS_TRADITIONAL
9370 /* On MacOS, %#s format is used for Pascal strings */
9375 elen = strlen(eptr);
9377 eptr = (char *)nullstr;
9378 elen = sizeof nullstr - 1;
9382 eptr = SvPV_const(argsv, elen);
9383 if (DO_UTF8(argsv)) {
9384 I32 old_precis = precis;
9385 if (has_precis && precis < elen) {
9387 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9390 if (width) { /* fudge width (can't fudge elen) */
9391 if (has_precis && precis < elen)
9392 width += precis - old_precis;
9394 width += elen - sv_len_utf8(argsv);
9401 if (has_precis && elen > precis)
9408 if (alt || vectorize)
9410 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9431 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9440 esignbuf[esignlen++] = plus;
9444 case 'h': iv = (short)va_arg(*args, int); break;
9445 case 'l': iv = va_arg(*args, long); break;
9446 case 'V': iv = va_arg(*args, IV); break;
9447 default: iv = va_arg(*args, int); break;
9449 case 'q': iv = va_arg(*args, Quad_t); break;
9454 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9456 case 'h': iv = (short)tiv; break;
9457 case 'l': iv = (long)tiv; break;
9459 default: iv = tiv; break;
9461 case 'q': iv = (Quad_t)tiv; break;
9465 if ( !vectorize ) /* we already set uv above */
9470 esignbuf[esignlen++] = plus;
9474 esignbuf[esignlen++] = '-';
9518 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9529 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9530 case 'l': uv = va_arg(*args, unsigned long); break;
9531 case 'V': uv = va_arg(*args, UV); break;
9532 default: uv = va_arg(*args, unsigned); break;
9534 case 'q': uv = va_arg(*args, Uquad_t); break;
9539 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9541 case 'h': uv = (unsigned short)tuv; break;
9542 case 'l': uv = (unsigned long)tuv; break;
9544 default: uv = tuv; break;
9546 case 'q': uv = (Uquad_t)tuv; break;
9553 char *ptr = ebuf + sizeof ebuf;
9554 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9560 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9566 esignbuf[esignlen++] = '0';
9567 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9575 if (alt && *ptr != '0')
9584 esignbuf[esignlen++] = '0';
9585 esignbuf[esignlen++] = c;
9588 default: /* it had better be ten or less */
9592 } while (uv /= base);
9595 elen = (ebuf + sizeof ebuf) - ptr;
9599 zeros = precis - elen;
9600 else if (precis == 0 && elen == 1 && *eptr == '0'
9601 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9604 /* a precision nullifies the 0 flag. */
9611 /* FLOATING POINT */
9614 c = 'f'; /* maybe %F isn't supported here */
9622 /* This is evil, but floating point is even more evil */
9624 /* for SV-style calling, we can only get NV
9625 for C-style calling, we assume %f is double;
9626 for simplicity we allow any of %Lf, %llf, %qf for long double
9630 #if defined(USE_LONG_DOUBLE)
9634 /* [perl #20339] - we should accept and ignore %lf rather than die */
9638 #if defined(USE_LONG_DOUBLE)
9639 intsize = args ? 0 : 'q';
9643 #if defined(HAS_LONG_DOUBLE)
9652 /* now we need (long double) if intsize == 'q', else (double) */
9654 #if LONG_DOUBLESIZE > DOUBLESIZE
9656 va_arg(*args, long double) :
9657 va_arg(*args, double)
9659 va_arg(*args, double)
9664 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9665 else. frexp() has some unspecified behaviour for those three */
9666 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9668 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9669 will cast our (long double) to (double) */
9670 (void)Perl_frexp(nv, &i);
9671 if (i == PERL_INT_MIN)
9672 Perl_die(aTHX_ "panic: frexp");
9674 need = BIT_DIGITS(i);
9676 need += has_precis ? precis : 6; /* known default */
9681 #ifdef HAS_LDBL_SPRINTF_BUG
9682 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9683 with sfio - Allen <allens@cpan.org> */
9686 # define MY_DBL_MAX DBL_MAX
9687 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9688 # if DOUBLESIZE >= 8
9689 # define MY_DBL_MAX 1.7976931348623157E+308L
9691 # define MY_DBL_MAX 3.40282347E+38L
9695 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9696 # define MY_DBL_MAX_BUG 1L
9698 # define MY_DBL_MAX_BUG MY_DBL_MAX
9702 # define MY_DBL_MIN DBL_MIN
9703 # else /* XXX guessing! -Allen */
9704 # if DOUBLESIZE >= 8
9705 # define MY_DBL_MIN 2.2250738585072014E-308L
9707 # define MY_DBL_MIN 1.17549435E-38L
9711 if ((intsize == 'q') && (c == 'f') &&
9712 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9714 /* it's going to be short enough that
9715 * long double precision is not needed */
9717 if ((nv <= 0L) && (nv >= -0L))
9718 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9720 /* would use Perl_fp_class as a double-check but not
9721 * functional on IRIX - see perl.h comments */
9723 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9724 /* It's within the range that a double can represent */
9725 #if defined(DBL_MAX) && !defined(DBL_MIN)
9726 if ((nv >= ((long double)1/DBL_MAX)) ||
9727 (nv <= (-(long double)1/DBL_MAX)))
9729 fix_ldbl_sprintf_bug = TRUE;
9732 if (fix_ldbl_sprintf_bug == TRUE) {
9742 # undef MY_DBL_MAX_BUG
9745 #endif /* HAS_LDBL_SPRINTF_BUG */
9747 need += 20; /* fudge factor */
9748 if (PL_efloatsize < need) {
9749 Safefree(PL_efloatbuf);
9750 PL_efloatsize = need + 20; /* more fudge */
9751 Newx(PL_efloatbuf, PL_efloatsize, char);
9752 PL_efloatbuf[0] = '\0';
9755 if ( !(width || left || plus || alt) && fill != '0'
9756 && has_precis && intsize != 'q' ) { /* Shortcuts */
9757 /* See earlier comment about buggy Gconvert when digits,
9759 if ( c == 'g' && precis) {
9760 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9761 /* May return an empty string for digits==0 */
9762 if (*PL_efloatbuf) {
9763 elen = strlen(PL_efloatbuf);
9764 goto float_converted;
9766 } else if ( c == 'f' && !precis) {
9767 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9772 char *ptr = ebuf + sizeof ebuf;
9775 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9776 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9777 if (intsize == 'q') {
9778 /* Copy the one or more characters in a long double
9779 * format before the 'base' ([efgEFG]) character to
9780 * the format string. */
9781 static char const prifldbl[] = PERL_PRIfldbl;
9782 char const *p = prifldbl + sizeof(prifldbl) - 3;
9783 while (p >= prifldbl) { *--ptr = *p--; }
9788 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9793 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9805 /* No taint. Otherwise we are in the strange situation
9806 * where printf() taints but print($float) doesn't.
9808 #if defined(HAS_LONG_DOUBLE)
9809 elen = ((intsize == 'q')
9810 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9811 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9813 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9817 eptr = PL_efloatbuf;
9825 i = SvCUR(sv) - origlen;
9828 case 'h': *(va_arg(*args, short*)) = i; break;
9829 default: *(va_arg(*args, int*)) = i; break;
9830 case 'l': *(va_arg(*args, long*)) = i; break;
9831 case 'V': *(va_arg(*args, IV*)) = i; break;
9833 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9838 sv_setuv_mg(argsv, (UV)i);
9839 continue; /* not "break" */
9846 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9847 && ckWARN(WARN_PRINTF))
9849 SV * const msg = sv_newmortal();
9850 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9851 (PL_op->op_type == OP_PRTF) ? "" : "s");
9854 Perl_sv_catpvf(aTHX_ msg,
9855 "\"%%%c\"", c & 0xFF);
9857 Perl_sv_catpvf(aTHX_ msg,
9858 "\"%%\\%03"UVof"\"",
9861 sv_catpvs(msg, "end of string");
9862 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9865 /* output mangled stuff ... */
9871 /* ... right here, because formatting flags should not apply */
9872 SvGROW(sv, SvCUR(sv) + elen + 1);
9874 Copy(eptr, p, elen, char);
9877 SvCUR_set(sv, p - SvPVX_const(sv));
9879 continue; /* not "break" */
9882 if (is_utf8 != has_utf8) {
9885 sv_utf8_upgrade(sv);
9888 const STRLEN old_elen = elen;
9889 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9890 sv_utf8_upgrade(nsv);
9891 eptr = SvPVX_const(nsv);
9894 if (width) { /* fudge width (can't fudge elen) */
9895 width += elen - old_elen;
9901 have = esignlen + zeros + elen;
9903 Perl_croak_nocontext(PL_memory_wrap);
9905 need = (have > width ? have : width);
9908 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9909 Perl_croak_nocontext(PL_memory_wrap);
9910 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9912 if (esignlen && fill == '0') {
9914 for (i = 0; i < (int)esignlen; i++)
9918 memset(p, fill, gap);
9921 if (esignlen && fill != '0') {
9923 for (i = 0; i < (int)esignlen; i++)
9928 for (i = zeros; i; i--)
9932 Copy(eptr, p, elen, char);
9936 memset(p, ' ', gap);
9941 Copy(dotstr, p, dotstrlen, char);
9945 vectorize = FALSE; /* done iterating over vecstr */
9952 SvCUR_set(sv, p - SvPVX_const(sv));
9960 /* =========================================================================
9962 =head1 Cloning an interpreter
9964 All the macros and functions in this section are for the private use of
9965 the main function, perl_clone().
9967 The foo_dup() functions make an exact copy of an existing foo thingy.
9968 During the course of a cloning, a hash table is used to map old addresses
9969 to new addresses. The table is created and manipulated with the
9970 ptr_table_* functions.
9974 ============================================================================*/
9977 #if defined(USE_ITHREADS)
9979 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9980 #ifndef GpREFCNT_inc
9981 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9985 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9986 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9987 If this changes, please unmerge ss_dup. */
9988 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9989 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9990 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9991 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9992 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9993 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9994 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9995 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9996 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9997 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9998 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9999 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10000 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10001 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10003 /* clone a parser */
10006 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10010 PERL_ARGS_ASSERT_PARSER_DUP;
10015 /* look for it in the table first */
10016 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10020 /* create anew and remember what it is */
10021 Newxz(parser, 1, yy_parser);
10022 ptr_table_store(PL_ptr_table, proto, parser);
10024 parser->yyerrstatus = 0;
10025 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10027 /* XXX these not yet duped */
10028 parser->old_parser = NULL;
10029 parser->stack = NULL;
10031 parser->stack_size = 0;
10032 /* XXX parser->stack->state = 0; */
10034 /* XXX eventually, just Copy() most of the parser struct ? */
10036 parser->lex_brackets = proto->lex_brackets;
10037 parser->lex_casemods = proto->lex_casemods;
10038 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10039 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10040 parser->lex_casestack = savepvn(proto->lex_casestack,
10041 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10042 parser->lex_defer = proto->lex_defer;
10043 parser->lex_dojoin = proto->lex_dojoin;
10044 parser->lex_expect = proto->lex_expect;
10045 parser->lex_formbrack = proto->lex_formbrack;
10046 parser->lex_inpat = proto->lex_inpat;
10047 parser->lex_inwhat = proto->lex_inwhat;
10048 parser->lex_op = proto->lex_op;
10049 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10050 parser->lex_starts = proto->lex_starts;
10051 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10052 parser->multi_close = proto->multi_close;
10053 parser->multi_open = proto->multi_open;
10054 parser->multi_start = proto->multi_start;
10055 parser->multi_end = proto->multi_end;
10056 parser->pending_ident = proto->pending_ident;
10057 parser->preambled = proto->preambled;
10058 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10059 parser->linestr = sv_dup_inc(proto->linestr, param);
10060 parser->expect = proto->expect;
10061 parser->copline = proto->copline;
10062 parser->last_lop_op = proto->last_lop_op;
10063 parser->lex_state = proto->lex_state;
10064 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10065 /* rsfp_filters entries have fake IoDIRP() */
10066 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10067 parser->in_my = proto->in_my;
10068 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10069 parser->error_count = proto->error_count;
10072 parser->linestr = sv_dup_inc(proto->linestr, param);
10075 char * const ols = SvPVX(proto->linestr);
10076 char * const ls = SvPVX(parser->linestr);
10078 parser->bufptr = ls + (proto->bufptr >= ols ?
10079 proto->bufptr - ols : 0);
10080 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10081 proto->oldbufptr - ols : 0);
10082 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10083 proto->oldoldbufptr - ols : 0);
10084 parser->linestart = ls + (proto->linestart >= ols ?
10085 proto->linestart - ols : 0);
10086 parser->last_uni = ls + (proto->last_uni >= ols ?
10087 proto->last_uni - ols : 0);
10088 parser->last_lop = ls + (proto->last_lop >= ols ?
10089 proto->last_lop - ols : 0);
10091 parser->bufend = ls + SvCUR(parser->linestr);
10094 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10098 parser->endwhite = proto->endwhite;
10099 parser->faketokens = proto->faketokens;
10100 parser->lasttoke = proto->lasttoke;
10101 parser->nextwhite = proto->nextwhite;
10102 parser->realtokenstart = proto->realtokenstart;
10103 parser->skipwhite = proto->skipwhite;
10104 parser->thisclose = proto->thisclose;
10105 parser->thismad = proto->thismad;
10106 parser->thisopen = proto->thisopen;
10107 parser->thisstuff = proto->thisstuff;
10108 parser->thistoken = proto->thistoken;
10109 parser->thiswhite = proto->thiswhite;
10111 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10112 parser->curforce = proto->curforce;
10114 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10115 Copy(proto->nexttype, parser->nexttype, 5, I32);
10116 parser->nexttoke = proto->nexttoke;
10122 /* duplicate a file handle */
10125 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10129 PERL_ARGS_ASSERT_FP_DUP;
10130 PERL_UNUSED_ARG(type);
10133 return (PerlIO*)NULL;
10135 /* look for it in the table first */
10136 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10140 /* create anew and remember what it is */
10141 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10142 ptr_table_store(PL_ptr_table, fp, ret);
10146 /* duplicate a directory handle */
10149 Perl_dirp_dup(pTHX_ DIR *const dp)
10151 PERL_UNUSED_CONTEXT;
10158 /* duplicate a typeglob */
10161 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10165 PERL_ARGS_ASSERT_GP_DUP;
10169 /* look for it in the table first */
10170 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10174 /* create anew and remember what it is */
10176 ptr_table_store(PL_ptr_table, gp, ret);
10179 ret->gp_refcnt = 0; /* must be before any other dups! */
10180 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10181 ret->gp_io = io_dup_inc(gp->gp_io, param);
10182 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10183 ret->gp_av = av_dup_inc(gp->gp_av, param);
10184 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10185 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10186 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10187 ret->gp_cvgen = gp->gp_cvgen;
10188 ret->gp_line = gp->gp_line;
10189 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10193 /* duplicate a chain of magic */
10196 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10198 MAGIC *mgprev = (MAGIC*)NULL;
10201 PERL_ARGS_ASSERT_MG_DUP;
10204 return (MAGIC*)NULL;
10205 /* look for it in the table first */
10206 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10210 for (; mg; mg = mg->mg_moremagic) {
10212 Newxz(nmg, 1, MAGIC);
10214 mgprev->mg_moremagic = nmg;
10217 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10218 nmg->mg_private = mg->mg_private;
10219 nmg->mg_type = mg->mg_type;
10220 nmg->mg_flags = mg->mg_flags;
10221 /* FIXME for plugins
10222 if (mg->mg_type == PERL_MAGIC_qr) {
10223 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10227 if(mg->mg_type == PERL_MAGIC_backref) {
10228 /* The backref AV has its reference count deliberately bumped by
10230 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10233 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10234 ? sv_dup_inc(mg->mg_obj, param)
10235 : sv_dup(mg->mg_obj, param);
10237 nmg->mg_len = mg->mg_len;
10238 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10239 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10240 if (mg->mg_len > 0) {
10241 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10242 if (mg->mg_type == PERL_MAGIC_overload_table &&
10243 AMT_AMAGIC((AMT*)mg->mg_ptr))
10245 const AMT * const amtp = (AMT*)mg->mg_ptr;
10246 AMT * const namtp = (AMT*)nmg->mg_ptr;
10248 for (i = 1; i < NofAMmeth; i++) {
10249 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10253 else if (mg->mg_len == HEf_SVKEY)
10254 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10256 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10257 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10264 #endif /* USE_ITHREADS */
10266 /* create a new pointer-mapping table */
10269 Perl_ptr_table_new(pTHX)
10272 PERL_UNUSED_CONTEXT;
10274 Newxz(tbl, 1, PTR_TBL_t);
10275 tbl->tbl_max = 511;
10276 tbl->tbl_items = 0;
10277 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10281 #define PTR_TABLE_HASH(ptr) \
10282 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10285 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10286 following define) and at call to new_body_inline made below in
10287 Perl_ptr_table_store()
10290 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10292 /* map an existing pointer using a table */
10294 STATIC PTR_TBL_ENT_t *
10295 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10297 PTR_TBL_ENT_t *tblent;
10298 const UV hash = PTR_TABLE_HASH(sv);
10300 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10302 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10303 for (; tblent; tblent = tblent->next) {
10304 if (tblent->oldval == sv)
10311 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10313 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10315 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10316 PERL_UNUSED_CONTEXT;
10318 return tblent ? tblent->newval : NULL;
10321 /* add a new entry to a pointer-mapping table */
10324 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10326 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10328 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10329 PERL_UNUSED_CONTEXT;
10332 tblent->newval = newsv;
10334 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10336 new_body_inline(tblent, PTE_SVSLOT);
10338 tblent->oldval = oldsv;
10339 tblent->newval = newsv;
10340 tblent->next = tbl->tbl_ary[entry];
10341 tbl->tbl_ary[entry] = tblent;
10343 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10344 ptr_table_split(tbl);
10348 /* double the hash bucket size of an existing ptr table */
10351 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10353 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10354 const UV oldsize = tbl->tbl_max + 1;
10355 UV newsize = oldsize * 2;
10358 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10359 PERL_UNUSED_CONTEXT;
10361 Renew(ary, newsize, PTR_TBL_ENT_t*);
10362 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10363 tbl->tbl_max = --newsize;
10364 tbl->tbl_ary = ary;
10365 for (i=0; i < oldsize; i++, ary++) {
10366 PTR_TBL_ENT_t **curentp, **entp, *ent;
10369 curentp = ary + oldsize;
10370 for (entp = ary, ent = *ary; ent; ent = *entp) {
10371 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10373 ent->next = *curentp;
10383 /* remove all the entries from a ptr table */
10386 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10388 if (tbl && tbl->tbl_items) {
10389 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10390 UV riter = tbl->tbl_max;
10393 PTR_TBL_ENT_t *entry = array[riter];
10396 PTR_TBL_ENT_t * const oentry = entry;
10397 entry = entry->next;
10402 tbl->tbl_items = 0;
10406 /* clear and free a ptr table */
10409 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10414 ptr_table_clear(tbl);
10415 Safefree(tbl->tbl_ary);
10419 #if defined(USE_ITHREADS)
10422 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10424 PERL_ARGS_ASSERT_RVPV_DUP;
10427 SvRV_set(dstr, SvWEAKREF(sstr)
10428 ? sv_dup(SvRV(sstr), param)
10429 : sv_dup_inc(SvRV(sstr), param));
10432 else if (SvPVX_const(sstr)) {
10433 /* Has something there */
10435 /* Normal PV - clone whole allocated space */
10436 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10437 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10438 /* Not that normal - actually sstr is copy on write.
10439 But we are a true, independant SV, so: */
10440 SvREADONLY_off(dstr);
10445 /* Special case - not normally malloced for some reason */
10446 if (isGV_with_GP(sstr)) {
10447 /* Don't need to do anything here. */
10449 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10450 /* A "shared" PV - clone it as "shared" PV */
10452 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10456 /* Some other special case - random pointer */
10457 SvPV_set(dstr, SvPVX(sstr));
10462 /* Copy the NULL */
10463 SvPV_set(dstr, NULL);
10467 /* duplicate an SV of any type (including AV, HV etc) */
10470 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10475 PERL_ARGS_ASSERT_SV_DUP;
10479 if (SvTYPE(sstr) == SVTYPEMASK) {
10480 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10485 /* look for it in the table first */
10486 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10490 if(param->flags & CLONEf_JOIN_IN) {
10491 /** We are joining here so we don't want do clone
10492 something that is bad **/
10493 if (SvTYPE(sstr) == SVt_PVHV) {
10494 const HEK * const hvname = HvNAME_HEK(sstr);
10496 /** don't clone stashes if they already exist **/
10497 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10501 /* create anew and remember what it is */
10504 #ifdef DEBUG_LEAKING_SCALARS
10505 dstr->sv_debug_optype = sstr->sv_debug_optype;
10506 dstr->sv_debug_line = sstr->sv_debug_line;
10507 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10508 dstr->sv_debug_cloned = 1;
10509 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10512 ptr_table_store(PL_ptr_table, sstr, dstr);
10515 SvFLAGS(dstr) = SvFLAGS(sstr);
10516 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10517 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10520 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10521 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10522 (void*)PL_watch_pvx, SvPVX_const(sstr));
10525 /* don't clone objects whose class has asked us not to */
10526 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10531 switch (SvTYPE(sstr)) {
10533 SvANY(dstr) = NULL;
10536 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10538 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10540 SvIV_set(dstr, SvIVX(sstr));
10544 SvANY(dstr) = new_XNV();
10545 SvNV_set(dstr, SvNVX(sstr));
10547 /* case SVt_BIND: */
10550 /* These are all the types that need complex bodies allocating. */
10552 const svtype sv_type = SvTYPE(sstr);
10553 const struct body_details *const sv_type_details
10554 = bodies_by_type + sv_type;
10558 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10562 if (GvUNIQUE((GV*)sstr)) {
10563 NOOP; /* Do sharing here, and fall through */
10576 assert(sv_type_details->body_size);
10577 if (sv_type_details->arena) {
10578 new_body_inline(new_body, sv_type);
10580 = (void*)((char*)new_body - sv_type_details->offset);
10582 new_body = new_NOARENA(sv_type_details);
10586 SvANY(dstr) = new_body;
10589 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10590 ((char*)SvANY(dstr)) + sv_type_details->offset,
10591 sv_type_details->copy, char);
10593 Copy(((char*)SvANY(sstr)),
10594 ((char*)SvANY(dstr)),
10595 sv_type_details->body_size + sv_type_details->offset, char);
10598 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10599 && !isGV_with_GP(dstr))
10600 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10602 /* The Copy above means that all the source (unduplicated) pointers
10603 are now in the destination. We can check the flags and the
10604 pointers in either, but it's possible that there's less cache
10605 missing by always going for the destination.
10606 FIXME - instrument and check that assumption */
10607 if (sv_type >= SVt_PVMG) {
10608 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10609 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10610 } else if (SvMAGIC(dstr))
10611 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10613 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10616 /* The cast silences a GCC warning about unhandled types. */
10617 switch ((int)sv_type) {
10627 /* FIXME for plugins */
10628 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10631 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10632 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10633 LvTARG(dstr) = dstr;
10634 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10635 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10637 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10639 if(isGV_with_GP(sstr)) {
10640 if (GvNAME_HEK(dstr))
10641 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10642 /* Don't call sv_add_backref here as it's going to be
10643 created as part of the magic cloning of the symbol
10645 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10646 at the point of this comment. */
10647 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10648 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10649 (void)GpREFCNT_inc(GvGP(dstr));
10651 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10654 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10655 if (IoOFP(dstr) == IoIFP(sstr))
10656 IoOFP(dstr) = IoIFP(dstr);
10658 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10659 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10660 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10661 /* I have no idea why fake dirp (rsfps)
10662 should be treated differently but otherwise
10663 we end up with leaks -- sky*/
10664 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10665 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10666 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10668 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10669 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10670 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10671 if (IoDIRP(dstr)) {
10672 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10675 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10678 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10679 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10680 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10683 if (AvARRAY((AV*)sstr)) {
10684 SV **dst_ary, **src_ary;
10685 SSize_t items = AvFILLp((AV*)sstr) + 1;
10687 src_ary = AvARRAY((AV*)sstr);
10688 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10689 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10690 AvARRAY((AV*)dstr) = dst_ary;
10691 AvALLOC((AV*)dstr) = dst_ary;
10692 if (AvREAL((AV*)sstr)) {
10693 while (items-- > 0)
10694 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10697 while (items-- > 0)
10698 *dst_ary++ = sv_dup(*src_ary++, param);
10700 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10701 while (items-- > 0) {
10702 *dst_ary++ = &PL_sv_undef;
10706 AvARRAY((AV*)dstr) = NULL;
10707 AvALLOC((AV*)dstr) = (SV**)NULL;
10711 if (HvARRAY((HV*)sstr)) {
10713 const bool sharekeys = !!HvSHAREKEYS(sstr);
10714 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10715 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10717 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10718 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10720 HvARRAY(dstr) = (HE**)darray;
10721 while (i <= sxhv->xhv_max) {
10722 const HE * const source = HvARRAY(sstr)[i];
10723 HvARRAY(dstr)[i] = source
10724 ? he_dup(source, sharekeys, param) : 0;
10729 const struct xpvhv_aux * const saux = HvAUX(sstr);
10730 struct xpvhv_aux * const daux = HvAUX(dstr);
10731 /* This flag isn't copied. */
10732 /* SvOOK_on(hv) attacks the IV flags. */
10733 SvFLAGS(dstr) |= SVf_OOK;
10735 hvname = saux->xhv_name;
10736 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10738 daux->xhv_riter = saux->xhv_riter;
10739 daux->xhv_eiter = saux->xhv_eiter
10740 ? he_dup(saux->xhv_eiter,
10741 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10742 daux->xhv_backreferences =
10743 saux->xhv_backreferences
10744 ? (AV*) SvREFCNT_inc(
10745 sv_dup((SV*)saux->xhv_backreferences, param))
10748 daux->xhv_mro_meta = saux->xhv_mro_meta
10749 ? mro_meta_dup(saux->xhv_mro_meta, param)
10752 /* Record stashes for possible cloning in Perl_clone(). */
10754 av_push(param->stashes, dstr);
10758 HvARRAY((HV*)dstr) = NULL;
10761 if (!(param->flags & CLONEf_COPY_STACKS)) {
10765 /* NOTE: not refcounted */
10766 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10768 if (!CvISXSUB(dstr))
10769 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10771 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10772 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10773 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10774 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10776 /* don't dup if copying back - CvGV isn't refcounted, so the
10777 * duped GV may never be freed. A bit of a hack! DAPM */
10778 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10779 NULL : gv_dup(CvGV(dstr), param) ;
10780 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10782 CvWEAKOUTSIDE(sstr)
10783 ? cv_dup( CvOUTSIDE(dstr), param)
10784 : cv_dup_inc(CvOUTSIDE(dstr), param);
10785 if (!CvISXSUB(dstr))
10786 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10792 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10798 /* duplicate a context */
10801 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10803 PERL_CONTEXT *ncxs;
10805 PERL_ARGS_ASSERT_CX_DUP;
10808 return (PERL_CONTEXT*)NULL;
10810 /* look for it in the table first */
10811 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10815 /* create anew and remember what it is */
10816 Newx(ncxs, max + 1, PERL_CONTEXT);
10817 ptr_table_store(PL_ptr_table, cxs, ncxs);
10818 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10821 PERL_CONTEXT * const ncx = &ncxs[ix];
10822 if (CxTYPE(ncx) == CXt_SUBST) {
10823 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10826 switch (CxTYPE(ncx)) {
10828 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10829 ? cv_dup_inc(ncx->blk_sub.cv, param)
10830 : cv_dup(ncx->blk_sub.cv,param));
10831 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10832 ? av_dup_inc(ncx->blk_sub.argarray,
10835 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10837 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10838 ncx->blk_sub.oldcomppad);
10841 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10843 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10845 case CXt_LOOP_LAZYSV:
10846 ncx->blk_loop.state_u.lazysv.end
10847 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10848 /* We are taking advantage of av_dup_inc and sv_dup_inc
10849 actually being the same function, and order equivalance of
10851 We can assert the later [but only at run time :-(] */
10852 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10853 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10855 ncx->blk_loop.state_u.ary.ary
10856 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10857 case CXt_LOOP_LAZYIV:
10858 case CXt_LOOP_PLAIN:
10859 if (CxPADLOOP(ncx)) {
10860 ncx->blk_loop.oldcomppad
10861 = (PAD*)ptr_table_fetch(PL_ptr_table,
10862 ncx->blk_loop.oldcomppad);
10864 ncx->blk_loop.oldcomppad
10865 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10869 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10870 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10871 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10884 /* duplicate a stack info structure */
10887 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10891 PERL_ARGS_ASSERT_SI_DUP;
10894 return (PERL_SI*)NULL;
10896 /* look for it in the table first */
10897 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10901 /* create anew and remember what it is */
10902 Newxz(nsi, 1, PERL_SI);
10903 ptr_table_store(PL_ptr_table, si, nsi);
10905 nsi->si_stack = av_dup_inc(si->si_stack, param);
10906 nsi->si_cxix = si->si_cxix;
10907 nsi->si_cxmax = si->si_cxmax;
10908 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10909 nsi->si_type = si->si_type;
10910 nsi->si_prev = si_dup(si->si_prev, param);
10911 nsi->si_next = si_dup(si->si_next, param);
10912 nsi->si_markoff = si->si_markoff;
10917 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10918 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10919 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10920 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10921 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10922 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10923 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10924 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10925 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10926 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10927 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10928 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10929 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10930 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10933 #define pv_dup_inc(p) SAVEPV(p)
10934 #define pv_dup(p) SAVEPV(p)
10935 #define svp_dup_inc(p,pp) any_dup(p,pp)
10937 /* map any object to the new equivent - either something in the
10938 * ptr table, or something in the interpreter structure
10942 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10946 PERL_ARGS_ASSERT_ANY_DUP;
10949 return (void*)NULL;
10951 /* look for it in the table first */
10952 ret = ptr_table_fetch(PL_ptr_table, v);
10956 /* see if it is part of the interpreter structure */
10957 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10958 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10966 /* duplicate the save stack */
10969 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10972 ANY * const ss = proto_perl->Isavestack;
10973 const I32 max = proto_perl->Isavestack_max;
10974 I32 ix = proto_perl->Isavestack_ix;
10987 void (*dptr) (void*);
10988 void (*dxptr) (pTHX_ void*);
10990 PERL_ARGS_ASSERT_SS_DUP;
10992 Newxz(nss, max, ANY);
10995 const I32 type = POPINT(ss,ix);
10996 TOPINT(nss,ix) = type;
10998 case SAVEt_HELEM: /* hash element */
10999 sv = (SV*)POPPTR(ss,ix);
11000 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11002 case SAVEt_ITEM: /* normal string */
11003 case SAVEt_SV: /* scalar reference */
11004 sv = (SV*)POPPTR(ss,ix);
11005 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11008 case SAVEt_MORTALIZESV:
11009 sv = (SV*)POPPTR(ss,ix);
11010 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11012 case SAVEt_SHARED_PVREF: /* char* in shared space */
11013 c = (char*)POPPTR(ss,ix);
11014 TOPPTR(nss,ix) = savesharedpv(c);
11015 ptr = POPPTR(ss,ix);
11016 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11018 case SAVEt_GENERIC_SVREF: /* generic sv */
11019 case SAVEt_SVREF: /* scalar reference */
11020 sv = (SV*)POPPTR(ss,ix);
11021 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11022 ptr = POPPTR(ss,ix);
11023 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11025 case SAVEt_HV: /* hash reference */
11026 case SAVEt_AV: /* array reference */
11027 sv = (SV*) POPPTR(ss,ix);
11028 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11030 case SAVEt_COMPPAD:
11032 sv = (SV*) POPPTR(ss,ix);
11033 TOPPTR(nss,ix) = sv_dup(sv, param);
11035 case SAVEt_INT: /* int reference */
11036 ptr = POPPTR(ss,ix);
11037 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11038 intval = (int)POPINT(ss,ix);
11039 TOPINT(nss,ix) = intval;
11041 case SAVEt_LONG: /* long reference */
11042 ptr = POPPTR(ss,ix);
11043 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11045 case SAVEt_CLEARSV:
11046 longval = (long)POPLONG(ss,ix);
11047 TOPLONG(nss,ix) = longval;
11049 case SAVEt_I32: /* I32 reference */
11050 case SAVEt_I16: /* I16 reference */
11051 case SAVEt_I8: /* I8 reference */
11052 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11053 ptr = POPPTR(ss,ix);
11054 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11056 TOPINT(nss,ix) = i;
11058 case SAVEt_IV: /* IV reference */
11059 ptr = POPPTR(ss,ix);
11060 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11062 TOPIV(nss,ix) = iv;
11064 case SAVEt_HPTR: /* HV* reference */
11065 case SAVEt_APTR: /* AV* reference */
11066 case SAVEt_SPTR: /* SV* reference */
11067 ptr = POPPTR(ss,ix);
11068 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11069 sv = (SV*)POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = sv_dup(sv, param);
11072 case SAVEt_VPTR: /* random* reference */
11073 ptr = POPPTR(ss,ix);
11074 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11075 ptr = POPPTR(ss,ix);
11076 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11078 case SAVEt_GENERIC_PVREF: /* generic char* */
11079 case SAVEt_PPTR: /* char* reference */
11080 ptr = POPPTR(ss,ix);
11081 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11082 c = (char*)POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = pv_dup(c);
11085 case SAVEt_GP: /* scalar reference */
11086 gp = (GP*)POPPTR(ss,ix);
11087 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11088 (void)GpREFCNT_inc(gp);
11089 gv = (GV*)POPPTR(ss,ix);
11090 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11093 ptr = POPPTR(ss,ix);
11094 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11095 /* these are assumed to be refcounted properly */
11097 switch (((OP*)ptr)->op_type) {
11099 case OP_LEAVESUBLV:
11103 case OP_LEAVEWRITE:
11104 TOPPTR(nss,ix) = ptr;
11107 (void) OpREFCNT_inc(o);
11111 TOPPTR(nss,ix) = NULL;
11116 TOPPTR(nss,ix) = NULL;
11119 c = (char*)POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = pv_dup_inc(c);
11123 hv = (HV*)POPPTR(ss,ix);
11124 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11125 c = (char*)POPPTR(ss,ix);
11126 TOPPTR(nss,ix) = pv_dup_inc(c);
11128 case SAVEt_STACK_POS: /* Position on Perl stack */
11130 TOPINT(nss,ix) = i;
11132 case SAVEt_DESTRUCTOR:
11133 ptr = POPPTR(ss,ix);
11134 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11135 dptr = POPDPTR(ss,ix);
11136 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11137 any_dup(FPTR2DPTR(void *, dptr),
11140 case SAVEt_DESTRUCTOR_X:
11141 ptr = POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11143 dxptr = POPDXPTR(ss,ix);
11144 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11145 any_dup(FPTR2DPTR(void *, dxptr),
11148 case SAVEt_REGCONTEXT:
11151 TOPINT(nss,ix) = i;
11154 case SAVEt_AELEM: /* array element */
11155 sv = (SV*)POPPTR(ss,ix);
11156 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11158 TOPINT(nss,ix) = i;
11159 av = (AV*)POPPTR(ss,ix);
11160 TOPPTR(nss,ix) = av_dup_inc(av, param);
11163 ptr = POPPTR(ss,ix);
11164 TOPPTR(nss,ix) = ptr;
11168 TOPINT(nss,ix) = i;
11169 ptr = POPPTR(ss,ix);
11172 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11173 HINTS_REFCNT_UNLOCK;
11175 TOPPTR(nss,ix) = ptr;
11176 if (i & HINT_LOCALIZE_HH) {
11177 hv = (HV*)POPPTR(ss,ix);
11178 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11181 case SAVEt_PADSV_AND_MORTALIZE:
11182 longval = (long)POPLONG(ss,ix);
11183 TOPLONG(nss,ix) = longval;
11184 ptr = POPPTR(ss,ix);
11185 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11186 sv = (SV*)POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11190 ptr = POPPTR(ss,ix);
11191 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11192 longval = (long)POPBOOL(ss,ix);
11193 TOPBOOL(nss,ix) = (bool)longval;
11195 case SAVEt_SET_SVFLAGS:
11197 TOPINT(nss,ix) = i;
11199 TOPINT(nss,ix) = i;
11200 sv = (SV*)POPPTR(ss,ix);
11201 TOPPTR(nss,ix) = sv_dup(sv, param);
11203 case SAVEt_RE_STATE:
11205 const struct re_save_state *const old_state
11206 = (struct re_save_state *)
11207 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11208 struct re_save_state *const new_state
11209 = (struct re_save_state *)
11210 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11212 Copy(old_state, new_state, 1, struct re_save_state);
11213 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11215 new_state->re_state_bostr
11216 = pv_dup(old_state->re_state_bostr);
11217 new_state->re_state_reginput
11218 = pv_dup(old_state->re_state_reginput);
11219 new_state->re_state_regeol
11220 = pv_dup(old_state->re_state_regeol);
11221 new_state->re_state_regoffs
11222 = (regexp_paren_pair*)
11223 any_dup(old_state->re_state_regoffs, proto_perl);
11224 new_state->re_state_reglastparen
11225 = (U32*) any_dup(old_state->re_state_reglastparen,
11227 new_state->re_state_reglastcloseparen
11228 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11230 /* XXX This just has to be broken. The old save_re_context
11231 code did SAVEGENERICPV(PL_reg_start_tmp);
11232 PL_reg_start_tmp is char **.
11233 Look above to what the dup code does for
11234 SAVEt_GENERIC_PVREF
11235 It can never have worked.
11236 So this is merely a faithful copy of the exiting bug: */
11237 new_state->re_state_reg_start_tmp
11238 = (char **) pv_dup((char *)
11239 old_state->re_state_reg_start_tmp);
11240 /* I assume that it only ever "worked" because no-one called
11241 (pseudo)fork while the regexp engine had re-entered itself.
11243 #ifdef PERL_OLD_COPY_ON_WRITE
11244 new_state->re_state_nrs
11245 = sv_dup(old_state->re_state_nrs, param);
11247 new_state->re_state_reg_magic
11248 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11250 new_state->re_state_reg_oldcurpm
11251 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11253 new_state->re_state_reg_curpm
11254 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11256 new_state->re_state_reg_oldsaved
11257 = pv_dup(old_state->re_state_reg_oldsaved);
11258 new_state->re_state_reg_poscache
11259 = pv_dup(old_state->re_state_reg_poscache);
11260 new_state->re_state_reg_starttry
11261 = pv_dup(old_state->re_state_reg_starttry);
11264 case SAVEt_COMPILE_WARNINGS:
11265 ptr = POPPTR(ss,ix);
11266 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11269 ptr = POPPTR(ss,ix);
11270 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11274 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11282 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11283 * flag to the result. This is done for each stash before cloning starts,
11284 * so we know which stashes want their objects cloned */
11287 do_mark_cloneable_stash(pTHX_ SV *const sv)
11289 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11291 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11292 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11293 if (cloner && GvCV(cloner)) {
11300 mXPUSHs(newSVhek(hvname));
11302 call_sv((SV*)GvCV(cloner), G_SCALAR);
11309 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11317 =for apidoc perl_clone
11319 Create and return a new interpreter by cloning the current one.
11321 perl_clone takes these flags as parameters:
11323 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11324 without it we only clone the data and zero the stacks,
11325 with it we copy the stacks and the new perl interpreter is
11326 ready to run at the exact same point as the previous one.
11327 The pseudo-fork code uses COPY_STACKS while the
11328 threads->create doesn't.
11330 CLONEf_KEEP_PTR_TABLE
11331 perl_clone keeps a ptr_table with the pointer of the old
11332 variable as a key and the new variable as a value,
11333 this allows it to check if something has been cloned and not
11334 clone it again but rather just use the value and increase the
11335 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11336 the ptr_table using the function
11337 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11338 reason to keep it around is if you want to dup some of your own
11339 variable who are outside the graph perl scans, example of this
11340 code is in threads.xs create
11343 This is a win32 thing, it is ignored on unix, it tells perls
11344 win32host code (which is c++) to clone itself, this is needed on
11345 win32 if you want to run two threads at the same time,
11346 if you just want to do some stuff in a separate perl interpreter
11347 and then throw it away and return to the original one,
11348 you don't need to do anything.
11353 /* XXX the above needs expanding by someone who actually understands it ! */
11354 EXTERN_C PerlInterpreter *
11355 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11358 perl_clone(PerlInterpreter *proto_perl, UV flags)
11361 #ifdef PERL_IMPLICIT_SYS
11363 PERL_ARGS_ASSERT_PERL_CLONE;
11365 /* perlhost.h so we need to call into it
11366 to clone the host, CPerlHost should have a c interface, sky */
11368 if (flags & CLONEf_CLONE_HOST) {
11369 return perl_clone_host(proto_perl,flags);
11371 return perl_clone_using(proto_perl, flags,
11373 proto_perl->IMemShared,
11374 proto_perl->IMemParse,
11376 proto_perl->IStdIO,
11380 proto_perl->IProc);
11384 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11385 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11386 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11387 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11388 struct IPerlDir* ipD, struct IPerlSock* ipS,
11389 struct IPerlProc* ipP)
11391 /* XXX many of the string copies here can be optimized if they're
11392 * constants; they need to be allocated as common memory and just
11393 * their pointers copied. */
11396 CLONE_PARAMS clone_params;
11397 CLONE_PARAMS* const param = &clone_params;
11399 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11401 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11403 /* for each stash, determine whether its objects should be cloned */
11404 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11405 PERL_SET_THX(my_perl);
11408 PoisonNew(my_perl, 1, PerlInterpreter);
11414 PL_savestack_ix = 0;
11415 PL_savestack_max = -1;
11416 PL_sig_pending = 0;
11418 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11419 # else /* !DEBUGGING */
11420 Zero(my_perl, 1, PerlInterpreter);
11421 # endif /* DEBUGGING */
11423 /* host pointers */
11425 PL_MemShared = ipMS;
11426 PL_MemParse = ipMP;
11433 #else /* !PERL_IMPLICIT_SYS */
11435 CLONE_PARAMS clone_params;
11436 CLONE_PARAMS* param = &clone_params;
11437 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11439 PERL_ARGS_ASSERT_PERL_CLONE;
11441 /* for each stash, determine whether its objects should be cloned */
11442 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11443 PERL_SET_THX(my_perl);
11446 PoisonNew(my_perl, 1, PerlInterpreter);
11452 PL_savestack_ix = 0;
11453 PL_savestack_max = -1;
11454 PL_sig_pending = 0;
11456 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11457 # else /* !DEBUGGING */
11458 Zero(my_perl, 1, PerlInterpreter);
11459 # endif /* DEBUGGING */
11460 #endif /* PERL_IMPLICIT_SYS */
11461 param->flags = flags;
11462 param->proto_perl = proto_perl;
11464 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11466 PL_body_arenas = NULL;
11467 Zero(&PL_body_roots, 1, PL_body_roots);
11469 PL_nice_chunk = NULL;
11470 PL_nice_chunk_size = 0;
11472 PL_sv_objcount = 0;
11474 PL_sv_arenaroot = NULL;
11476 PL_debug = proto_perl->Idebug;
11478 PL_hash_seed = proto_perl->Ihash_seed;
11479 PL_rehash_seed = proto_perl->Irehash_seed;
11481 #ifdef USE_REENTRANT_API
11482 /* XXX: things like -Dm will segfault here in perlio, but doing
11483 * PERL_SET_CONTEXT(proto_perl);
11484 * breaks too many other things
11486 Perl_reentrant_init(aTHX);
11489 /* create SV map for pointer relocation */
11490 PL_ptr_table = ptr_table_new();
11492 /* initialize these special pointers as early as possible */
11493 SvANY(&PL_sv_undef) = NULL;
11494 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11495 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11496 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11498 SvANY(&PL_sv_no) = new_XPVNV();
11499 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11500 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11501 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11502 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11503 SvCUR_set(&PL_sv_no, 0);
11504 SvLEN_set(&PL_sv_no, 1);
11505 SvIV_set(&PL_sv_no, 0);
11506 SvNV_set(&PL_sv_no, 0);
11507 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11509 SvANY(&PL_sv_yes) = new_XPVNV();
11510 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11511 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11512 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11513 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11514 SvCUR_set(&PL_sv_yes, 1);
11515 SvLEN_set(&PL_sv_yes, 2);
11516 SvIV_set(&PL_sv_yes, 1);
11517 SvNV_set(&PL_sv_yes, 1);
11518 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11520 /* create (a non-shared!) shared string table */
11521 PL_strtab = newHV();
11522 HvSHAREKEYS_off(PL_strtab);
11523 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11524 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11526 PL_compiling = proto_perl->Icompiling;
11528 /* These two PVs will be free'd special way so must set them same way op.c does */
11529 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11530 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11532 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11533 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11535 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11536 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11537 if (PL_compiling.cop_hints_hash) {
11539 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11540 HINTS_REFCNT_UNLOCK;
11542 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11543 #ifdef PERL_DEBUG_READONLY_OPS
11548 /* pseudo environmental stuff */
11549 PL_origargc = proto_perl->Iorigargc;
11550 PL_origargv = proto_perl->Iorigargv;
11552 param->stashes = newAV(); /* Setup array of objects to call clone on */
11554 /* Set tainting stuff before PerlIO_debug can possibly get called */
11555 PL_tainting = proto_perl->Itainting;
11556 PL_taint_warn = proto_perl->Itaint_warn;
11558 #ifdef PERLIO_LAYERS
11559 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11560 PerlIO_clone(aTHX_ proto_perl, param);
11563 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11564 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11565 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11566 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11567 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11568 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11571 PL_minus_c = proto_perl->Iminus_c;
11572 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11573 PL_localpatches = proto_perl->Ilocalpatches;
11574 PL_splitstr = proto_perl->Isplitstr;
11575 PL_minus_n = proto_perl->Iminus_n;
11576 PL_minus_p = proto_perl->Iminus_p;
11577 PL_minus_l = proto_perl->Iminus_l;
11578 PL_minus_a = proto_perl->Iminus_a;
11579 PL_minus_E = proto_perl->Iminus_E;
11580 PL_minus_F = proto_perl->Iminus_F;
11581 PL_doswitches = proto_perl->Idoswitches;
11582 PL_dowarn = proto_perl->Idowarn;
11583 PL_doextract = proto_perl->Idoextract;
11584 PL_sawampersand = proto_perl->Isawampersand;
11585 PL_unsafe = proto_perl->Iunsafe;
11586 PL_inplace = SAVEPV(proto_perl->Iinplace);
11587 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11588 PL_perldb = proto_perl->Iperldb;
11589 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11590 PL_exit_flags = proto_perl->Iexit_flags;
11592 /* magical thingies */
11593 /* XXX time(&PL_basetime) when asked for? */
11594 PL_basetime = proto_perl->Ibasetime;
11595 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11597 PL_maxsysfd = proto_perl->Imaxsysfd;
11598 PL_statusvalue = proto_perl->Istatusvalue;
11600 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11602 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11604 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11606 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11607 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11608 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11611 /* RE engine related */
11612 Zero(&PL_reg_state, 1, struct re_save_state);
11613 PL_reginterp_cnt = 0;
11614 PL_regmatch_slab = NULL;
11616 /* Clone the regex array */
11617 /* ORANGE FIXME for plugins, probably in the SV dup code.
11618 newSViv(PTR2IV(CALLREGDUPE(
11619 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11621 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11622 PL_regex_pad = AvARRAY(PL_regex_padav);
11624 /* shortcuts to various I/O objects */
11625 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11626 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11627 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11628 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11629 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11630 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11632 /* shortcuts to regexp stuff */
11633 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11635 /* shortcuts to misc objects */
11636 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11638 /* shortcuts to debugging objects */
11639 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11640 PL_DBline = gv_dup(proto_perl->IDBline, param);
11641 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11642 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11643 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11644 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11645 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11647 /* symbol tables */
11648 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11649 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11650 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11651 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11652 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11654 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11655 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11656 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11657 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11658 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11659 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11660 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11661 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11663 PL_sub_generation = proto_perl->Isub_generation;
11664 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11666 /* funky return mechanisms */
11667 PL_forkprocess = proto_perl->Iforkprocess;
11669 /* subprocess state */
11670 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11672 /* internal state */
11673 PL_maxo = proto_perl->Imaxo;
11674 if (proto_perl->Iop_mask)
11675 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11678 /* PL_asserting = proto_perl->Iasserting; */
11680 /* current interpreter roots */
11681 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11683 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11685 PL_main_start = proto_perl->Imain_start;
11686 PL_eval_root = proto_perl->Ieval_root;
11687 PL_eval_start = proto_perl->Ieval_start;
11689 /* runtime control stuff */
11690 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11692 PL_filemode = proto_perl->Ifilemode;
11693 PL_lastfd = proto_perl->Ilastfd;
11694 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11697 PL_gensym = proto_perl->Igensym;
11698 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11699 PL_laststatval = proto_perl->Ilaststatval;
11700 PL_laststype = proto_perl->Ilaststype;
11703 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11705 /* interpreter atexit processing */
11706 PL_exitlistlen = proto_perl->Iexitlistlen;
11707 if (PL_exitlistlen) {
11708 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11709 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11712 PL_exitlist = (PerlExitListEntry*)NULL;
11714 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11715 if (PL_my_cxt_size) {
11716 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11717 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11718 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11719 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11720 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11724 PL_my_cxt_list = (void**)NULL;
11725 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11726 PL_my_cxt_keys = (const char**)NULL;
11729 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11730 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11731 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11733 PL_profiledata = NULL;
11735 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11737 PAD_CLONE_VARS(proto_perl, param);
11739 #ifdef HAVE_INTERP_INTERN
11740 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11743 /* more statics moved here */
11744 PL_generation = proto_perl->Igeneration;
11745 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11747 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11748 PL_in_clean_all = proto_perl->Iin_clean_all;
11750 PL_uid = proto_perl->Iuid;
11751 PL_euid = proto_perl->Ieuid;
11752 PL_gid = proto_perl->Igid;
11753 PL_egid = proto_perl->Iegid;
11754 PL_nomemok = proto_perl->Inomemok;
11755 PL_an = proto_perl->Ian;
11756 PL_evalseq = proto_perl->Ievalseq;
11757 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11758 PL_origalen = proto_perl->Iorigalen;
11759 #ifdef PERL_USES_PL_PIDSTATUS
11760 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11762 PL_osname = SAVEPV(proto_perl->Iosname);
11763 PL_sighandlerp = proto_perl->Isighandlerp;
11765 PL_runops = proto_perl->Irunops;
11767 PL_parser = parser_dup(proto_perl->Iparser, param);
11769 PL_subline = proto_perl->Isubline;
11770 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11773 PL_cryptseen = proto_perl->Icryptseen;
11776 PL_hints = proto_perl->Ihints;
11778 PL_amagic_generation = proto_perl->Iamagic_generation;
11780 #ifdef USE_LOCALE_COLLATE
11781 PL_collation_ix = proto_perl->Icollation_ix;
11782 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11783 PL_collation_standard = proto_perl->Icollation_standard;
11784 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11785 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11786 #endif /* USE_LOCALE_COLLATE */
11788 #ifdef USE_LOCALE_NUMERIC
11789 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11790 PL_numeric_standard = proto_perl->Inumeric_standard;
11791 PL_numeric_local = proto_perl->Inumeric_local;
11792 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11793 #endif /* !USE_LOCALE_NUMERIC */
11795 /* utf8 character classes */
11796 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11797 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11798 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11799 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11800 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11801 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11802 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11803 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11804 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11805 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11806 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11807 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11808 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11809 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11810 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11811 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11812 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11813 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11814 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11815 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11817 /* Did the locale setup indicate UTF-8? */
11818 PL_utf8locale = proto_perl->Iutf8locale;
11819 /* Unicode features (see perlrun/-C) */
11820 PL_unicode = proto_perl->Iunicode;
11822 /* Pre-5.8 signals control */
11823 PL_signals = proto_perl->Isignals;
11825 /* times() ticks per second */
11826 PL_clocktick = proto_perl->Iclocktick;
11828 /* Recursion stopper for PerlIO_find_layer */
11829 PL_in_load_module = proto_perl->Iin_load_module;
11831 /* sort() routine */
11832 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11834 /* Not really needed/useful since the reenrant_retint is "volatile",
11835 * but do it for consistency's sake. */
11836 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11838 /* Hooks to shared SVs and locks. */
11839 PL_sharehook = proto_perl->Isharehook;
11840 PL_lockhook = proto_perl->Ilockhook;
11841 PL_unlockhook = proto_perl->Iunlockhook;
11842 PL_threadhook = proto_perl->Ithreadhook;
11843 PL_destroyhook = proto_perl->Idestroyhook;
11845 #ifdef THREADS_HAVE_PIDS
11846 PL_ppid = proto_perl->Ippid;
11850 PL_last_swash_hv = NULL; /* reinits on demand */
11851 PL_last_swash_klen = 0;
11852 PL_last_swash_key[0]= '\0';
11853 PL_last_swash_tmps = (U8*)NULL;
11854 PL_last_swash_slen = 0;
11856 PL_glob_index = proto_perl->Iglob_index;
11857 PL_srand_called = proto_perl->Isrand_called;
11858 PL_bitcount = NULL; /* reinits on demand */
11860 if (proto_perl->Ipsig_pend) {
11861 Newxz(PL_psig_pend, SIG_SIZE, int);
11864 PL_psig_pend = (int*)NULL;
11867 if (proto_perl->Ipsig_ptr) {
11868 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11869 Newxz(PL_psig_name, SIG_SIZE, SV*);
11870 for (i = 1; i < SIG_SIZE; i++) {
11871 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11872 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11876 PL_psig_ptr = (SV**)NULL;
11877 PL_psig_name = (SV**)NULL;
11880 /* intrpvar.h stuff */
11882 if (flags & CLONEf_COPY_STACKS) {
11883 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11884 PL_tmps_ix = proto_perl->Itmps_ix;
11885 PL_tmps_max = proto_perl->Itmps_max;
11886 PL_tmps_floor = proto_perl->Itmps_floor;
11887 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11889 while (i <= PL_tmps_ix) {
11890 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11894 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11895 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11896 Newxz(PL_markstack, i, I32);
11897 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11898 - proto_perl->Imarkstack);
11899 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11900 - proto_perl->Imarkstack);
11901 Copy(proto_perl->Imarkstack, PL_markstack,
11902 PL_markstack_ptr - PL_markstack + 1, I32);
11904 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11905 * NOTE: unlike the others! */
11906 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11907 PL_scopestack_max = proto_perl->Iscopestack_max;
11908 Newxz(PL_scopestack, PL_scopestack_max, I32);
11909 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11911 /* NOTE: si_dup() looks at PL_markstack */
11912 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11914 /* PL_curstack = PL_curstackinfo->si_stack; */
11915 PL_curstack = av_dup(proto_perl->Icurstack, param);
11916 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11918 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11919 PL_stack_base = AvARRAY(PL_curstack);
11920 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11921 - proto_perl->Istack_base);
11922 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11924 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11925 * NOTE: unlike the others! */
11926 PL_savestack_ix = proto_perl->Isavestack_ix;
11927 PL_savestack_max = proto_perl->Isavestack_max;
11928 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11929 PL_savestack = ss_dup(proto_perl, param);
11933 ENTER; /* perl_destruct() wants to LEAVE; */
11935 /* although we're not duplicating the tmps stack, we should still
11936 * add entries for any SVs on the tmps stack that got cloned by a
11937 * non-refcount means (eg a temp in @_); otherwise they will be
11940 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11941 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11942 proto_perl->Itmps_stack[i]);
11943 if (nsv && !SvREFCNT(nsv)) {
11945 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11950 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11951 PL_top_env = &PL_start_env;
11953 PL_op = proto_perl->Iop;
11956 PL_Xpv = (XPV*)NULL;
11957 my_perl->Ina = proto_perl->Ina;
11959 PL_statbuf = proto_perl->Istatbuf;
11960 PL_statcache = proto_perl->Istatcache;
11961 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11962 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11964 PL_timesbuf = proto_perl->Itimesbuf;
11967 PL_tainted = proto_perl->Itainted;
11968 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11969 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11970 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11971 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11972 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11973 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11974 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11975 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11976 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11978 PL_restartop = proto_perl->Irestartop;
11979 PL_in_eval = proto_perl->Iin_eval;
11980 PL_delaymagic = proto_perl->Idelaymagic;
11981 PL_dirty = proto_perl->Idirty;
11982 PL_localizing = proto_perl->Ilocalizing;
11984 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11985 PL_hv_fetch_ent_mh = NULL;
11986 PL_modcount = proto_perl->Imodcount;
11987 PL_lastgotoprobe = NULL;
11988 PL_dumpindent = proto_perl->Idumpindent;
11990 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11991 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11992 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11993 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11994 PL_efloatbuf = NULL; /* reinits on demand */
11995 PL_efloatsize = 0; /* reinits on demand */
11999 PL_screamfirst = NULL;
12000 PL_screamnext = NULL;
12001 PL_maxscream = -1; /* reinits on demand */
12002 PL_lastscream = NULL;
12005 PL_regdummy = proto_perl->Iregdummy;
12006 PL_colorset = 0; /* reinits PL_colors[] */
12007 /*PL_colors[6] = {0,0,0,0,0,0};*/
12011 /* Pluggable optimizer */
12012 PL_peepp = proto_perl->Ipeepp;
12014 PL_stashcache = newHV();
12016 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12017 proto_perl->Iwatchaddr);
12018 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12019 if (PL_debug && PL_watchaddr) {
12020 PerlIO_printf(Perl_debug_log,
12021 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12022 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12023 PTR2UV(PL_watchok));
12026 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12027 ptr_table_free(PL_ptr_table);
12028 PL_ptr_table = NULL;
12031 /* Call the ->CLONE method, if it exists, for each of the stashes
12032 identified by sv_dup() above.
12034 while(av_len(param->stashes) != -1) {
12035 HV* const stash = (HV*) av_shift(param->stashes);
12036 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12037 if (cloner && GvCV(cloner)) {
12042 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12044 call_sv((SV*)GvCV(cloner), G_DISCARD);
12050 SvREFCNT_dec(param->stashes);
12052 /* orphaned? eg threads->new inside BEGIN or use */
12053 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12054 SvREFCNT_inc_simple_void(PL_compcv);
12055 SAVEFREESV(PL_compcv);
12061 #endif /* USE_ITHREADS */
12064 =head1 Unicode Support
12066 =for apidoc sv_recode_to_utf8
12068 The encoding is assumed to be an Encode object, on entry the PV
12069 of the sv is assumed to be octets in that encoding, and the sv
12070 will be converted into Unicode (and UTF-8).
12072 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12073 is not a reference, nothing is done to the sv. If the encoding is not
12074 an C<Encode::XS> Encoding object, bad things will happen.
12075 (See F<lib/encoding.pm> and L<Encode>).
12077 The PV of the sv is returned.
12082 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12086 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12088 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12102 Passing sv_yes is wrong - it needs to be or'ed set of constants
12103 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12104 remove converted chars from source.
12106 Both will default the value - let them.
12108 XPUSHs(&PL_sv_yes);
12111 call_method("decode", G_SCALAR);
12115 s = SvPV_const(uni, len);
12116 if (s != SvPVX_const(sv)) {
12117 SvGROW(sv, len + 1);
12118 Move(s, SvPVX(sv), len + 1, char);
12119 SvCUR_set(sv, len);
12126 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12130 =for apidoc sv_cat_decode
12132 The encoding is assumed to be an Encode object, the PV of the ssv is
12133 assumed to be octets in that encoding and decoding the input starts
12134 from the position which (PV + *offset) pointed to. The dsv will be
12135 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12136 when the string tstr appears in decoding output or the input ends on
12137 the PV of the ssv. The value which the offset points will be modified
12138 to the last input position on the ssv.
12140 Returns TRUE if the terminator was found, else returns FALSE.
12145 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12146 SV *ssv, int *offset, char *tstr, int tlen)
12151 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12153 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12164 offsv = newSViv(*offset);
12166 mXPUSHp(tstr, tlen);
12168 call_method("cat_decode", G_SCALAR);
12170 ret = SvTRUE(TOPs);
12171 *offset = SvIV(offsv);
12177 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12182 /* ---------------------------------------------------------------------
12184 * support functions for report_uninit()
12187 /* the maxiumum size of array or hash where we will scan looking
12188 * for the undefined element that triggered the warning */
12190 #define FUV_MAX_SEARCH_SIZE 1000
12192 /* Look for an entry in the hash whose value has the same SV as val;
12193 * If so, return a mortal copy of the key. */
12196 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12199 register HE **array;
12202 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12204 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12205 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12208 array = HvARRAY(hv);
12210 for (i=HvMAX(hv); i>0; i--) {
12211 register HE *entry;
12212 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12213 if (HeVAL(entry) != val)
12215 if ( HeVAL(entry) == &PL_sv_undef ||
12216 HeVAL(entry) == &PL_sv_placeholder)
12220 if (HeKLEN(entry) == HEf_SVKEY)
12221 return sv_mortalcopy(HeKEY_sv(entry));
12222 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12228 /* Look for an entry in the array whose value has the same SV as val;
12229 * If so, return the index, otherwise return -1. */
12232 S_find_array_subscript(pTHX_ AV *av, SV* val)
12236 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12238 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12239 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12242 if (val != &PL_sv_undef) {
12243 SV ** const svp = AvARRAY(av);
12246 for (i=AvFILLp(av); i>=0; i--)
12253 /* S_varname(): return the name of a variable, optionally with a subscript.
12254 * If gv is non-zero, use the name of that global, along with gvtype (one
12255 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12256 * targ. Depending on the value of the subscript_type flag, return:
12259 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12260 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12261 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12262 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12265 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12266 SV* keyname, I32 aindex, int subscript_type)
12269 SV * const name = sv_newmortal();
12272 buffer[0] = gvtype;
12275 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12277 gv_fullname4(name, gv, buffer, 0);
12279 if ((unsigned int)SvPVX(name)[1] <= 26) {
12281 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12283 /* Swap the 1 unprintable control character for the 2 byte pretty
12284 version - ie substr($name, 1, 1) = $buffer; */
12285 sv_insert(name, 1, 1, buffer, 2);
12289 CV * const cv = find_runcv(NULL);
12293 if (!cv || !CvPADLIST(cv))
12295 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12296 sv = *av_fetch(av, targ, FALSE);
12297 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12300 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12301 SV * const sv = newSV(0);
12302 *SvPVX(name) = '$';
12303 Perl_sv_catpvf(aTHX_ name, "{%s}",
12304 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12307 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12308 *SvPVX(name) = '$';
12309 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12311 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
12312 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
12319 =for apidoc find_uninit_var
12321 Find the name of the undefined variable (if any) that caused the operator o
12322 to issue a "Use of uninitialized value" warning.
12323 If match is true, only return a name if it's value matches uninit_sv.
12324 So roughly speaking, if a unary operator (such as OP_COS) generates a
12325 warning, then following the direct child of the op may yield an
12326 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12327 other hand, with OP_ADD there are two branches to follow, so we only print
12328 the variable name if we get an exact match.
12330 The name is returned as a mortal SV.
12332 Assumes that PL_op is the op that originally triggered the error, and that
12333 PL_comppad/PL_curpad points to the currently executing pad.
12339 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12347 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12348 uninit_sv == &PL_sv_placeholder)))
12351 switch (obase->op_type) {
12358 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12359 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12362 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12364 if (pad) { /* @lex, %lex */
12365 sv = PAD_SVl(obase->op_targ);
12369 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12370 /* @global, %global */
12371 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12374 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12376 else /* @{expr}, %{expr} */
12377 return find_uninit_var(cUNOPx(obase)->op_first,
12381 /* attempt to find a match within the aggregate */
12383 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12385 subscript_type = FUV_SUBSCRIPT_HASH;
12388 index = find_array_subscript((AV*)sv, uninit_sv);
12390 subscript_type = FUV_SUBSCRIPT_ARRAY;
12393 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12396 return varname(gv, hash ? '%' : '@', obase->op_targ,
12397 keysv, index, subscript_type);
12401 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12403 return varname(NULL, '$', obase->op_targ,
12404 NULL, 0, FUV_SUBSCRIPT_NONE);
12407 gv = cGVOPx_gv(obase);
12408 if (!gv || (match && GvSV(gv) != uninit_sv))
12410 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12413 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12416 av = (AV*)PAD_SV(obase->op_targ);
12417 if (!av || SvRMAGICAL(av))
12419 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12420 if (!svp || *svp != uninit_sv)
12423 return varname(NULL, '$', obase->op_targ,
12424 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12427 gv = cGVOPx_gv(obase);
12433 if (!av || SvRMAGICAL(av))
12435 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12436 if (!svp || *svp != uninit_sv)
12439 return varname(gv, '$', 0,
12440 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12445 o = cUNOPx(obase)->op_first;
12446 if (!o || o->op_type != OP_NULL ||
12447 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12449 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12453 if (PL_op == obase)
12454 /* $a[uninit_expr] or $h{uninit_expr} */
12455 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12458 o = cBINOPx(obase)->op_first;
12459 kid = cBINOPx(obase)->op_last;
12461 /* get the av or hv, and optionally the gv */
12463 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12464 sv = PAD_SV(o->op_targ);
12466 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12467 && cUNOPo->op_first->op_type == OP_GV)
12469 gv = cGVOPx_gv(cUNOPo->op_first);
12472 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12477 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12478 /* index is constant */
12482 if (obase->op_type == OP_HELEM) {
12483 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12484 if (!he || HeVAL(he) != uninit_sv)
12488 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12489 if (!svp || *svp != uninit_sv)
12493 if (obase->op_type == OP_HELEM)
12494 return varname(gv, '%', o->op_targ,
12495 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12497 return varname(gv, '@', o->op_targ, NULL,
12498 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12501 /* index is an expression;
12502 * attempt to find a match within the aggregate */
12503 if (obase->op_type == OP_HELEM) {
12504 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12506 return varname(gv, '%', o->op_targ,
12507 keysv, 0, FUV_SUBSCRIPT_HASH);
12510 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12512 return varname(gv, '@', o->op_targ,
12513 NULL, index, FUV_SUBSCRIPT_ARRAY);
12518 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12520 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12525 /* only examine RHS */
12526 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12529 o = cUNOPx(obase)->op_first;
12530 if (o->op_type == OP_PUSHMARK)
12533 if (!o->op_sibling) {
12534 /* one-arg version of open is highly magical */
12536 if (o->op_type == OP_GV) { /* open FOO; */
12538 if (match && GvSV(gv) != uninit_sv)
12540 return varname(gv, '$', 0,
12541 NULL, 0, FUV_SUBSCRIPT_NONE);
12543 /* other possibilities not handled are:
12544 * open $x; or open my $x; should return '${*$x}'
12545 * open expr; should return '$'.expr ideally
12551 /* ops where $_ may be an implicit arg */
12555 if ( !(obase->op_flags & OPf_STACKED)) {
12556 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12557 ? PAD_SVl(obase->op_targ)
12560 sv = sv_newmortal();
12561 sv_setpvn(sv, "$_", 2);
12570 /* skip filehandle as it can't produce 'undef' warning */
12571 o = cUNOPx(obase)->op_first;
12572 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12573 o = o->op_sibling->op_sibling;
12577 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12580 match = 1; /* XS or custom code could trigger random warnings */
12585 /* XXX tmp hack: these two may call an XS sub, and currently
12586 XS subs don't have a SUB entry on the context stack, so CV and
12587 pad determination goes wrong, and BAD things happen. So, just
12588 don't try to determine the value under those circumstances.
12589 Need a better fix at dome point. DAPM 11/2007 */
12593 /* def-ness of rval pos() is independent of the def-ness of its arg */
12594 if ( !(obase->op_flags & OPf_MOD))
12599 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12600 return newSVpvs_flags("${$/}", SVs_TEMP);
12605 if (!(obase->op_flags & OPf_KIDS))
12607 o = cUNOPx(obase)->op_first;
12613 /* if all except one arg are constant, or have no side-effects,
12614 * or are optimized away, then it's unambiguous */
12616 for (kid=o; kid; kid = kid->op_sibling) {
12618 const OPCODE type = kid->op_type;
12619 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12620 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12621 || (type == OP_PUSHMARK)
12625 if (o2) { /* more than one found */
12632 return find_uninit_var(o2, uninit_sv, match);
12634 /* scan all args */
12636 sv = find_uninit_var(o, uninit_sv, 1);
12648 =for apidoc report_uninit
12650 Print appropriate "Use of uninitialized variable" warning
12656 Perl_report_uninit(pTHX_ SV* uninit_sv)
12660 SV* varname = NULL;
12662 varname = find_uninit_var(PL_op, uninit_sv,0);
12664 sv_insert(varname, 0, 0, " ", 1);
12666 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12667 varname ? SvPV_nolen_const(varname) : "",
12668 " in ", OP_DESC(PL_op));
12671 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12677 * c-indentation-style: bsd
12678 * c-basic-offset: 4
12679 * indent-tabs-mode: t
12682 * ex: set ts=8 sts=4 sw=4 noet: