3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
921 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
922 SVt_REGEXP, FALSE, NONV, HASARENA,
923 FIT_ARENA(0, sizeof(struct regexp_allocated))
927 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
934 { sizeof(xpvav_allocated),
935 copy_length(XPVAV, xmg_stash)
936 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
937 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
938 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
940 { sizeof(xpvhv_allocated),
941 copy_length(XPVHV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
943 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
944 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
947 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
948 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
949 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
951 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
952 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
953 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
955 /* XPVIO is 84 bytes, fits 48x */
956 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
957 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
960 #define new_body_type(sv_type) \
961 (void *)((char *)S_new_body(aTHX_ sv_type))
963 #define del_body_type(p, sv_type) \
964 del_body(p, &PL_body_roots[sv_type])
967 #define new_body_allocated(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type) \
969 - bodies_by_type[sv_type].offset)
971 #define del_body_allocated(p, sv_type) \
972 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
975 #define my_safemalloc(s) (void*)safemalloc(s)
976 #define my_safecalloc(s) (void*)safecalloc(s, 1)
977 #define my_safefree(p) safefree((char*)p)
981 #define new_XNV() my_safemalloc(sizeof(XPVNV))
982 #define del_XNV(p) my_safefree(p)
984 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
985 #define del_XPVNV(p) my_safefree(p)
987 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
988 #define del_XPVAV(p) my_safefree(p)
990 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
991 #define del_XPVHV(p) my_safefree(p)
993 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
994 #define del_XPVMG(p) my_safefree(p)
996 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
997 #define del_XPVGV(p) my_safefree(p)
1001 #define new_XNV() new_body_type(SVt_NV)
1002 #define del_XNV(p) del_body_type(p, SVt_NV)
1004 #define new_XPVNV() new_body_type(SVt_PVNV)
1005 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1007 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1008 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1010 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1011 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1013 #define new_XPVMG() new_body_type(SVt_PVMG)
1014 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1016 #define new_XPVGV() new_body_type(SVt_PVGV)
1017 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1021 /* no arena for you! */
1023 #define new_NOARENA(details) \
1024 my_safemalloc((details)->body_size + (details)->offset)
1025 #define new_NOARENAZ(details) \
1026 my_safecalloc((details)->body_size + (details)->offset)
1029 S_more_bodies (pTHX_ svtype sv_type)
1032 void ** const root = &PL_body_roots[sv_type];
1033 const struct body_details * const bdp = &bodies_by_type[sv_type];
1034 const size_t body_size = bdp->body_size;
1037 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1038 static bool done_sanity_check;
1040 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1041 * variables like done_sanity_check. */
1042 if (!done_sanity_check) {
1043 unsigned int i = SVt_LAST;
1045 done_sanity_check = TRUE;
1048 assert (bodies_by_type[i].type == i);
1052 assert(bdp->arena_size);
1054 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1056 end = start + bdp->arena_size - body_size;
1058 /* computed count doesnt reflect the 1st slot reservation */
1059 DEBUG_m(PerlIO_printf(Perl_debug_log,
1060 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1061 (void*)start, (void*)end,
1062 (int)bdp->arena_size, sv_type, (int)body_size,
1063 (int)bdp->arena_size / (int)body_size));
1065 *root = (void *)start;
1067 while (start < end) {
1068 char * const next = start + body_size;
1069 *(void**) start = (void *)next;
1072 *(void **)start = 0;
1077 /* grab a new thing from the free list, allocating more if necessary.
1078 The inline version is used for speed in hot routines, and the
1079 function using it serves the rest (unless PURIFY).
1081 #define new_body_inline(xpv, sv_type) \
1083 void ** const r3wt = &PL_body_roots[sv_type]; \
1084 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1085 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1086 *(r3wt) = *(void**)(xpv); \
1092 S_new_body(pTHX_ svtype sv_type)
1096 new_body_inline(xpv, sv_type);
1102 static const struct body_details fake_rv =
1103 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1106 =for apidoc sv_upgrade
1108 Upgrade an SV to a more complex form. Generally adds a new body type to the
1109 SV, then copies across as much information as possible from the old body.
1110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1116 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1121 const svtype old_type = SvTYPE(sv);
1122 const struct body_details *new_type_details;
1123 const struct body_details *old_type_details
1124 = bodies_by_type + old_type;
1125 SV *referant = NULL;
1127 if (new_type != SVt_PV && SvIsCOW(sv)) {
1128 sv_force_normal_flags(sv, 0);
1131 if (old_type == new_type)
1134 old_body = SvANY(sv);
1136 /* Copying structures onto other structures that have been neatly zeroed
1137 has a subtle gotcha. Consider XPVMG
1139 +------+------+------+------+------+-------+-------+
1140 | NV | CUR | LEN | IV | MAGIC | STASH |
1141 +------+------+------+------+------+-------+-------+
1142 0 4 8 12 16 20 24 28
1144 where NVs are aligned to 8 bytes, so that sizeof that structure is
1145 actually 32 bytes long, with 4 bytes of padding at the end:
1147 +------+------+------+------+------+-------+-------+------+
1148 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1149 +------+------+------+------+------+-------+-------+------+
1150 0 4 8 12 16 20 24 28 32
1152 so what happens if you allocate memory for this structure:
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1156 +------+------+------+------+------+-------+-------+------+------+...
1157 0 4 8 12 16 20 24 28 32 36
1159 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1160 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1161 started out as zero once, but it's quite possible that it isn't. So now,
1162 rather than a nicely zeroed GP, you have it pointing somewhere random.
1165 (In fact, GP ends up pointing at a previous GP structure, because the
1166 principle cause of the padding in XPVMG getting garbage is a copy of
1167 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1168 this happens to be moot because XPVGV has been re-ordered, with GP
1169 no longer after STASH)
1171 So we are careful and work out the size of used parts of all the
1179 referant = SvRV(sv);
1180 old_type_details = &fake_rv;
1181 if (new_type == SVt_NV)
1182 new_type = SVt_PVNV;
1184 if (new_type < SVt_PVIV) {
1185 new_type = (new_type == SVt_NV)
1186 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1196 assert(new_type > SVt_PV);
1197 assert(SVt_IV < SVt_PV);
1198 assert(SVt_NV < SVt_PV);
1205 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1206 there's no way that it can be safely upgraded, because perl.c
1207 expects to Safefree(SvANY(PL_mess_sv)) */
1208 assert(sv != PL_mess_sv);
1209 /* This flag bit is used to mean other things in other scalar types.
1210 Given that it only has meaning inside the pad, it shouldn't be set
1211 on anything that can get upgraded. */
1212 assert(!SvPAD_TYPED(sv));
1215 if (old_type_details->cant_upgrade)
1216 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1217 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1220 if (old_type > new_type)
1221 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1222 (int)old_type, (int)new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1245 assert(new_type_details->body_size);
1248 assert(new_type_details->arena);
1249 assert(new_type_details->arena_size);
1250 /* This points to the start of the allocated area. */
1251 new_body_inline(new_body, new_type);
1252 Zero(new_body, new_type_details->body_size, char);
1253 new_body = ((char *)new_body) - new_type_details->offset;
1255 /* We always allocated the full length item with PURIFY. To do this
1256 we fake things so that arena is false for all 16 types.. */
1257 new_body = new_NOARENAZ(new_type_details);
1259 SvANY(sv) = new_body;
1260 if (new_type == SVt_PVAV) {
1264 if (old_type_details->body_size) {
1267 /* It will have been zeroed when the new body was allocated.
1268 Lets not write to it, in case it confuses a write-back
1274 #ifndef NODEFAULT_SHAREKEYS
1275 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1277 HvMAX(sv) = 7; /* (start with 8 buckets) */
1278 if (old_type_details->body_size) {
1281 /* It will have been zeroed when the new body was allocated.
1282 Lets not write to it, in case it confuses a write-back
1287 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1288 The target created by newSVrv also is, and it can have magic.
1289 However, it never has SvPVX set.
1291 if (old_type == SVt_IV) {
1293 } else if (old_type >= SVt_PV) {
1294 assert(SvPVX_const(sv) == 0);
1297 if (old_type >= SVt_PVMG) {
1298 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1299 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1301 sv->sv_u.svu_array = NULL; /* or svu_hash */
1307 /* XXX Is this still needed? Was it ever needed? Surely as there is
1308 no route from NV to PVIV, NOK can never be true */
1309 assert(!SvNOKp(sv));
1321 assert(new_type_details->body_size);
1322 /* We always allocated the full length item with PURIFY. To do this
1323 we fake things so that arena is false for all 16 types.. */
1324 if(new_type_details->arena) {
1325 /* This points to the start of the allocated area. */
1326 new_body_inline(new_body, new_type);
1327 Zero(new_body, new_type_details->body_size, char);
1328 new_body = ((char *)new_body) - new_type_details->offset;
1330 new_body = new_NOARENAZ(new_type_details);
1332 SvANY(sv) = new_body;
1334 if (old_type_details->copy) {
1335 /* There is now the potential for an upgrade from something without
1336 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1337 int offset = old_type_details->offset;
1338 int length = old_type_details->copy;
1340 if (new_type_details->offset > old_type_details->offset) {
1341 const int difference
1342 = new_type_details->offset - old_type_details->offset;
1343 offset += difference;
1344 length -= difference;
1346 assert (length >= 0);
1348 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354 * correct 0.0 for us. Otherwise, if the old body didn't have an
1355 * NV slot, but the new one does, then we need to initialise the
1356 * freshly created NV slot with whatever the correct bit pattern is
1358 if (old_type_details->zero_nv && !new_type_details->zero_nv
1359 && !isGV_with_GP(sv))
1363 if (new_type == SVt_PVIO)
1364 IoPAGE_LEN(sv) = 60;
1365 if (old_type < SVt_PV) {
1366 /* referant will be NULL unless the old type was SVt_IV emulating
1368 sv->sv_u.svu_rv = referant;
1372 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1373 (unsigned long)new_type);
1376 if (old_type_details->arena) {
1377 /* If there was an old body, then we need to free it.
1378 Note that there is an assumption that all bodies of types that
1379 can be upgraded came from arenas. Only the more complex non-
1380 upgradable types are allowed to be directly malloc()ed. */
1382 my_safefree(old_body);
1384 del_body((void*)((char*)old_body + old_type_details->offset),
1385 &PL_body_roots[old_type]);
1391 =for apidoc sv_backoff
1393 Remove any string offset. You should normally use the C<SvOOK_off> macro
1400 Perl_sv_backoff(pTHX_ register SV *sv)
1403 const char * const s = SvPVX_const(sv);
1404 PERL_UNUSED_CONTEXT;
1406 assert(SvTYPE(sv) != SVt_PVHV);
1407 assert(SvTYPE(sv) != SVt_PVAV);
1409 SvOOK_offset(sv, delta);
1411 SvLEN_set(sv, SvLEN(sv) + delta);
1412 SvPV_set(sv, SvPVX(sv) - delta);
1413 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1414 SvFLAGS(sv) &= ~SVf_OOK;
1421 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1422 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1423 Use the C<SvGROW> wrapper instead.
1429 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1433 if (PL_madskills && newlen >= 0x100000) {
1434 PerlIO_printf(Perl_debug_log,
1435 "Allocation too large: %"UVxf"\n", (UV)newlen);
1437 #ifdef HAS_64K_LIMIT
1438 if (newlen >= 0x10000) {
1439 PerlIO_printf(Perl_debug_log,
1440 "Allocation too large: %"UVxf"\n", (UV)newlen);
1443 #endif /* HAS_64K_LIMIT */
1446 if (SvTYPE(sv) < SVt_PV) {
1447 sv_upgrade(sv, SVt_PV);
1448 s = SvPVX_mutable(sv);
1450 else if (SvOOK(sv)) { /* pv is offset? */
1452 s = SvPVX_mutable(sv);
1453 if (newlen > SvLEN(sv))
1454 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1455 #ifdef HAS_64K_LIMIT
1456 if (newlen >= 0x10000)
1461 s = SvPVX_mutable(sv);
1463 if (newlen > SvLEN(sv)) { /* need more room? */
1464 newlen = PERL_STRLEN_ROUNDUP(newlen);
1465 if (SvLEN(sv) && s) {
1467 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1473 s = (char*)saferealloc(s, newlen);
1476 s = (char*)safemalloc(newlen);
1477 if (SvPVX_const(sv) && SvCUR(sv)) {
1478 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1482 SvLEN_set(sv, newlen);
1488 =for apidoc sv_setiv
1490 Copies an integer into the given SV, upgrading first if necessary.
1491 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1497 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1500 SV_CHECK_THINKFIRST_COW_DROP(sv);
1501 switch (SvTYPE(sv)) {
1504 sv_upgrade(sv, SVt_IV);
1507 sv_upgrade(sv, SVt_PVIV);
1516 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1520 (void)SvIOK_only(sv); /* validate number */
1526 =for apidoc sv_setiv_mg
1528 Like C<sv_setiv>, but also handles 'set' magic.
1534 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1541 =for apidoc sv_setuv
1543 Copies an unsigned integer into the given SV, upgrading first if necessary.
1544 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1550 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1552 /* With these two if statements:
1553 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1556 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1558 If you wish to remove them, please benchmark to see what the effect is
1560 if (u <= (UV)IV_MAX) {
1561 sv_setiv(sv, (IV)u);
1570 =for apidoc sv_setuv_mg
1572 Like C<sv_setuv>, but also handles 'set' magic.
1578 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1585 =for apidoc sv_setnv
1587 Copies a double into the given SV, upgrading first if necessary.
1588 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1594 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1597 SV_CHECK_THINKFIRST_COW_DROP(sv);
1598 switch (SvTYPE(sv)) {
1601 sv_upgrade(sv, SVt_NV);
1605 sv_upgrade(sv, SVt_PVNV);
1614 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1619 (void)SvNOK_only(sv); /* validate number */
1624 =for apidoc sv_setnv_mg
1626 Like C<sv_setnv>, but also handles 'set' magic.
1632 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1638 /* Print an "isn't numeric" warning, using a cleaned-up,
1639 * printable version of the offending string
1643 S_not_a_number(pTHX_ SV *sv)
1651 dsv = newSVpvs_flags("", SVs_TEMP);
1652 pv = sv_uni_display(dsv, sv, 10, 0);
1655 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1656 /* each *s can expand to 4 chars + "...\0",
1657 i.e. need room for 8 chars */
1659 const char *s = SvPVX_const(sv);
1660 const char * const end = s + SvCUR(sv);
1661 for ( ; s < end && d < limit; s++ ) {
1663 if (ch & 128 && !isPRINT_LC(ch)) {
1672 else if (ch == '\r') {
1676 else if (ch == '\f') {
1680 else if (ch == '\\') {
1684 else if (ch == '\0') {
1688 else if (isPRINT_LC(ch))
1705 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706 "Argument \"%s\" isn't numeric in %s", pv,
1709 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1710 "Argument \"%s\" isn't numeric", pv);
1714 =for apidoc looks_like_number
1716 Test if the content of an SV looks like a number (or is a number).
1717 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1718 non-numeric warning), even if your atof() doesn't grok them.
1724 Perl_looks_like_number(pTHX_ SV *sv)
1726 register const char *sbegin;
1730 sbegin = SvPVX_const(sv);
1733 else if (SvPOKp(sv))
1734 sbegin = SvPV_const(sv, len);
1736 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1737 return grok_number(sbegin, len, NULL);
1741 S_glob_2number(pTHX_ GV * const gv)
1743 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1744 SV *const buffer = sv_newmortal();
1746 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1749 gv_efullname3(buffer, gv, "*");
1750 SvFLAGS(gv) |= wasfake;
1752 /* We know that all GVs stringify to something that is not-a-number,
1753 so no need to test that. */
1754 if (ckWARN(WARN_NUMERIC))
1755 not_a_number(buffer);
1756 /* We just want something true to return, so that S_sv_2iuv_common
1757 can tail call us and return true. */
1762 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1764 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1765 SV *const buffer = sv_newmortal();
1767 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1770 gv_efullname3(buffer, gv, "*");
1771 SvFLAGS(gv) |= wasfake;
1773 assert(SvPOK(buffer));
1775 *len = SvCUR(buffer);
1777 return SvPVX(buffer);
1780 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1781 until proven guilty, assume that things are not that bad... */
1786 As 64 bit platforms often have an NV that doesn't preserve all bits of
1787 an IV (an assumption perl has been based on to date) it becomes necessary
1788 to remove the assumption that the NV always carries enough precision to
1789 recreate the IV whenever needed, and that the NV is the canonical form.
1790 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1791 precision as a side effect of conversion (which would lead to insanity
1792 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1793 1) to distinguish between IV/UV/NV slots that have cached a valid
1794 conversion where precision was lost and IV/UV/NV slots that have a
1795 valid conversion which has lost no precision
1796 2) to ensure that if a numeric conversion to one form is requested that
1797 would lose precision, the precise conversion (or differently
1798 imprecise conversion) is also performed and cached, to prevent
1799 requests for different numeric formats on the same SV causing
1800 lossy conversion chains. (lossless conversion chains are perfectly
1805 SvIOKp is true if the IV slot contains a valid value
1806 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1807 SvNOKp is true if the NV slot contains a valid value
1808 SvNOK is true only if the NV value is accurate
1811 while converting from PV to NV, check to see if converting that NV to an
1812 IV(or UV) would lose accuracy over a direct conversion from PV to
1813 IV(or UV). If it would, cache both conversions, return NV, but mark
1814 SV as IOK NOKp (ie not NOK).
1816 While converting from PV to IV, check to see if converting that IV to an
1817 NV would lose accuracy over a direct conversion from PV to NV. If it
1818 would, cache both conversions, flag similarly.
1820 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1821 correctly because if IV & NV were set NV *always* overruled.
1822 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1823 changes - now IV and NV together means that the two are interchangeable:
1824 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1826 The benefit of this is that operations such as pp_add know that if
1827 SvIOK is true for both left and right operands, then integer addition
1828 can be used instead of floating point (for cases where the result won't
1829 overflow). Before, floating point was always used, which could lead to
1830 loss of precision compared with integer addition.
1832 * making IV and NV equal status should make maths accurate on 64 bit
1834 * may speed up maths somewhat if pp_add and friends start to use
1835 integers when possible instead of fp. (Hopefully the overhead in
1836 looking for SvIOK and checking for overflow will not outweigh the
1837 fp to integer speedup)
1838 * will slow down integer operations (callers of SvIV) on "inaccurate"
1839 values, as the change from SvIOK to SvIOKp will cause a call into
1840 sv_2iv each time rather than a macro access direct to the IV slot
1841 * should speed up number->string conversion on integers as IV is
1842 favoured when IV and NV are equally accurate
1844 ####################################################################
1845 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1846 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1847 On the other hand, SvUOK is true iff UV.
1848 ####################################################################
1850 Your mileage will vary depending your CPU's relative fp to integer
1854 #ifndef NV_PRESERVES_UV
1855 # define IS_NUMBER_UNDERFLOW_IV 1
1856 # define IS_NUMBER_UNDERFLOW_UV 2
1857 # define IS_NUMBER_IV_AND_UV 2
1858 # define IS_NUMBER_OVERFLOW_IV 4
1859 # define IS_NUMBER_OVERFLOW_UV 5
1861 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1863 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1865 S_sv_2iuv_non_preserve(pTHX_ register SV *sv
1872 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));
1873 if (SvNVX(sv) < (NV)IV_MIN) {
1874 (void)SvIOKp_on(sv);
1876 SvIV_set(sv, IV_MIN);
1877 return IS_NUMBER_UNDERFLOW_IV;
1879 if (SvNVX(sv) > (NV)UV_MAX) {
1880 (void)SvIOKp_on(sv);
1883 SvUV_set(sv, UV_MAX);
1884 return IS_NUMBER_OVERFLOW_UV;
1886 (void)SvIOKp_on(sv);
1888 /* Can't use strtol etc to convert this string. (See truth table in
1890 if (SvNVX(sv) <= (UV)IV_MAX) {
1891 SvIV_set(sv, I_V(SvNVX(sv)));
1892 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1893 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1895 /* Integer is imprecise. NOK, IOKp */
1897 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1900 SvUV_set(sv, U_V(SvNVX(sv)));
1901 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1902 if (SvUVX(sv) == UV_MAX) {
1903 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1904 possibly be preserved by NV. Hence, it must be overflow.
1906 return IS_NUMBER_OVERFLOW_UV;
1908 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1910 /* Integer is imprecise. NOK, IOKp */
1912 return IS_NUMBER_OVERFLOW_IV;
1914 #endif /* !NV_PRESERVES_UV*/
1917 S_sv_2iuv_common(pTHX_ SV *sv) {
1920 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1921 * without also getting a cached IV/UV from it at the same time
1922 * (ie PV->NV conversion should detect loss of accuracy and cache
1923 * IV or UV at same time to avoid this. */
1924 /* IV-over-UV optimisation - choose to cache IV if possible */
1926 if (SvTYPE(sv) == SVt_NV)
1927 sv_upgrade(sv, SVt_PVNV);
1929 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1930 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1931 certainly cast into the IV range at IV_MAX, whereas the correct
1932 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1934 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1935 if (Perl_isnan(SvNVX(sv))) {
1941 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1942 SvIV_set(sv, I_V(SvNVX(sv)));
1943 if (SvNVX(sv) == (NV) SvIVX(sv)
1944 #ifndef NV_PRESERVES_UV
1945 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1946 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1947 /* Don't flag it as "accurately an integer" if the number
1948 came from a (by definition imprecise) NV operation, and
1949 we're outside the range of NV integer precision */
1953 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1955 /* scalar has trailing garbage, eg "42a" */
1957 DEBUG_c(PerlIO_printf(Perl_debug_log,
1958 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1964 /* IV not precise. No need to convert from PV, as NV
1965 conversion would already have cached IV if it detected
1966 that PV->IV would be better than PV->NV->IV
1967 flags already correct - don't set public IOK. */
1968 DEBUG_c(PerlIO_printf(Perl_debug_log,
1969 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1974 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1975 but the cast (NV)IV_MIN rounds to a the value less (more
1976 negative) than IV_MIN which happens to be equal to SvNVX ??
1977 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1978 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1979 (NV)UVX == NVX are both true, but the values differ. :-(
1980 Hopefully for 2s complement IV_MIN is something like
1981 0x8000000000000000 which will be exact. NWC */
1984 SvUV_set(sv, U_V(SvNVX(sv)));
1986 (SvNVX(sv) == (NV) SvUVX(sv))
1987 #ifndef NV_PRESERVES_UV
1988 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1989 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1990 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1991 /* Don't flag it as "accurately an integer" if the number
1992 came from a (by definition imprecise) NV operation, and
1993 we're outside the range of NV integer precision */
1999 DEBUG_c(PerlIO_printf(Perl_debug_log,
2000 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2006 else if (SvPOKp(sv) && SvLEN(sv)) {
2008 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2009 /* We want to avoid a possible problem when we cache an IV/ a UV which
2010 may be later translated to an NV, and the resulting NV is not
2011 the same as the direct translation of the initial string
2012 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2013 be careful to ensure that the value with the .456 is around if the
2014 NV value is requested in the future).
2016 This means that if we cache such an IV/a UV, we need to cache the
2017 NV as well. Moreover, we trade speed for space, and do not
2018 cache the NV if we are sure it's not needed.
2021 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2022 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2023 == IS_NUMBER_IN_UV) {
2024 /* It's definitely an integer, only upgrade to PVIV */
2025 if (SvTYPE(sv) < SVt_PVIV)
2026 sv_upgrade(sv, SVt_PVIV);
2028 } else if (SvTYPE(sv) < SVt_PVNV)
2029 sv_upgrade(sv, SVt_PVNV);
2031 /* If NVs preserve UVs then we only use the UV value if we know that
2032 we aren't going to call atof() below. If NVs don't preserve UVs
2033 then the value returned may have more precision than atof() will
2034 return, even though value isn't perfectly accurate. */
2035 if ((numtype & (IS_NUMBER_IN_UV
2036 #ifdef NV_PRESERVES_UV
2039 )) == IS_NUMBER_IN_UV) {
2040 /* This won't turn off the public IOK flag if it was set above */
2041 (void)SvIOKp_on(sv);
2043 if (!(numtype & IS_NUMBER_NEG)) {
2045 if (value <= (UV)IV_MAX) {
2046 SvIV_set(sv, (IV)value);
2048 /* it didn't overflow, and it was positive. */
2049 SvUV_set(sv, value);
2053 /* 2s complement assumption */
2054 if (value <= (UV)IV_MIN) {
2055 SvIV_set(sv, -(IV)value);
2057 /* Too negative for an IV. This is a double upgrade, but
2058 I'm assuming it will be rare. */
2059 if (SvTYPE(sv) < SVt_PVNV)
2060 sv_upgrade(sv, SVt_PVNV);
2064 SvNV_set(sv, -(NV)value);
2065 SvIV_set(sv, IV_MIN);
2069 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2070 will be in the previous block to set the IV slot, and the next
2071 block to set the NV slot. So no else here. */
2073 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2074 != IS_NUMBER_IN_UV) {
2075 /* It wasn't an (integer that doesn't overflow the UV). */
2076 SvNV_set(sv, Atof(SvPVX_const(sv)));
2078 if (! numtype && ckWARN(WARN_NUMERIC))
2081 #if defined(USE_LONG_DOUBLE)
2082 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2083 PTR2UV(sv), SvNVX(sv)));
2085 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2086 PTR2UV(sv), SvNVX(sv)));
2089 #ifdef NV_PRESERVES_UV
2090 (void)SvIOKp_on(sv);
2092 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2093 SvIV_set(sv, I_V(SvNVX(sv)));
2094 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2097 NOOP; /* Integer is imprecise. NOK, IOKp */
2099 /* UV will not work better than IV */
2101 if (SvNVX(sv) > (NV)UV_MAX) {
2103 /* Integer is inaccurate. NOK, IOKp, is UV */
2104 SvUV_set(sv, UV_MAX);
2106 SvUV_set(sv, U_V(SvNVX(sv)));
2107 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2108 NV preservse UV so can do correct comparison. */
2109 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2112 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2117 #else /* NV_PRESERVES_UV */
2118 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2119 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2120 /* The IV/UV slot will have been set from value returned by
2121 grok_number above. The NV slot has just been set using
2124 assert (SvIOKp(sv));
2126 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2127 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2128 /* Small enough to preserve all bits. */
2129 (void)SvIOKp_on(sv);
2131 SvIV_set(sv, I_V(SvNVX(sv)));
2132 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2134 /* Assumption: first non-preserved integer is < IV_MAX,
2135 this NV is in the preserved range, therefore: */
2136 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2138 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);
2142 0 0 already failed to read UV.
2143 0 1 already failed to read UV.
2144 1 0 you won't get here in this case. IV/UV
2145 slot set, public IOK, Atof() unneeded.
2146 1 1 already read UV.
2147 so there's no point in sv_2iuv_non_preserve() attempting
2148 to use atol, strtol, strtoul etc. */
2150 sv_2iuv_non_preserve (sv, numtype);
2152 sv_2iuv_non_preserve (sv);
2156 #endif /* NV_PRESERVES_UV */
2157 /* It might be more code efficient to go through the entire logic above
2158 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2159 gets complex and potentially buggy, so more programmer efficient
2160 to do it this way, by turning off the public flags: */
2162 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2166 if (isGV_with_GP(sv))
2167 return glob_2number((GV *)sv);
2169 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2170 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2173 if (SvTYPE(sv) < SVt_IV)
2174 /* Typically the caller expects that sv_any is not NULL now. */
2175 sv_upgrade(sv, SVt_IV);
2176 /* Return 0 from the caller. */
2183 =for apidoc sv_2iv_flags
2185 Return the integer value of an SV, doing any necessary string
2186 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2187 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2193 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2198 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2199 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2200 cache IVs just in case. In practice it seems that they never
2201 actually anywhere accessible by user Perl code, let alone get used
2202 in anything other than a string context. */
2203 if (flags & SV_GMAGIC)
2208 return I_V(SvNVX(sv));
2210 if (SvPOKp(sv) && SvLEN(sv)) {
2213 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2215 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2216 == IS_NUMBER_IN_UV) {
2217 /* It's definitely an integer */
2218 if (numtype & IS_NUMBER_NEG) {
2219 if (value < (UV)IV_MIN)
2222 if (value < (UV)IV_MAX)
2227 if (ckWARN(WARN_NUMERIC))
2230 return I_V(Atof(SvPVX_const(sv)));
2235 assert(SvTYPE(sv) >= SVt_PVMG);
2236 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2237 } else if (SvTHINKFIRST(sv)) {
2241 SV * const tmpstr=AMG_CALLun(sv,numer);
2242 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2243 return SvIV(tmpstr);
2246 return PTR2IV(SvRV(sv));
2249 sv_force_normal_flags(sv, 0);
2251 if (SvREADONLY(sv) && !SvOK(sv)) {
2252 if (ckWARN(WARN_UNINITIALIZED))
2258 if (S_sv_2iuv_common(aTHX_ sv))
2261 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2262 PTR2UV(sv),SvIVX(sv)));
2263 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2267 =for apidoc sv_2uv_flags
2269 Return the unsigned integer value of an SV, doing any necessary string
2270 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2271 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2277 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2282 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2283 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2284 cache IVs just in case. */
2285 if (flags & SV_GMAGIC)
2290 return U_V(SvNVX(sv));
2291 if (SvPOKp(sv) && SvLEN(sv)) {
2294 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2296 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2297 == IS_NUMBER_IN_UV) {
2298 /* It's definitely an integer */
2299 if (!(numtype & IS_NUMBER_NEG))
2303 if (ckWARN(WARN_NUMERIC))
2306 return U_V(Atof(SvPVX_const(sv)));
2311 assert(SvTYPE(sv) >= SVt_PVMG);
2312 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2313 } else if (SvTHINKFIRST(sv)) {
2317 SV *const tmpstr = AMG_CALLun(sv,numer);
2318 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2319 return SvUV(tmpstr);
2322 return PTR2UV(SvRV(sv));
2325 sv_force_normal_flags(sv, 0);
2327 if (SvREADONLY(sv) && !SvOK(sv)) {
2328 if (ckWARN(WARN_UNINITIALIZED))
2334 if (S_sv_2iuv_common(aTHX_ sv))
2338 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2339 PTR2UV(sv),SvUVX(sv)));
2340 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2346 Return the num value of an SV, doing any necessary string or integer
2347 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2354 Perl_sv_2nv(pTHX_ register SV *sv)
2359 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2360 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2361 cache IVs just in case. */
2365 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2366 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2367 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2369 return Atof(SvPVX_const(sv));
2373 return (NV)SvUVX(sv);
2375 return (NV)SvIVX(sv);
2380 assert(SvTYPE(sv) >= SVt_PVMG);
2381 /* This falls through to the report_uninit near the end of the
2383 } else if (SvTHINKFIRST(sv)) {
2387 SV *const tmpstr = AMG_CALLun(sv,numer);
2388 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2389 return SvNV(tmpstr);
2392 return PTR2NV(SvRV(sv));
2395 sv_force_normal_flags(sv, 0);
2397 if (SvREADONLY(sv) && !SvOK(sv)) {
2398 if (ckWARN(WARN_UNINITIALIZED))
2403 if (SvTYPE(sv) < SVt_NV) {
2404 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2405 sv_upgrade(sv, SVt_NV);
2406 #ifdef USE_LONG_DOUBLE
2408 STORE_NUMERIC_LOCAL_SET_STANDARD();
2409 PerlIO_printf(Perl_debug_log,
2410 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2411 PTR2UV(sv), SvNVX(sv));
2412 RESTORE_NUMERIC_LOCAL();
2416 STORE_NUMERIC_LOCAL_SET_STANDARD();
2417 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2418 PTR2UV(sv), SvNVX(sv));
2419 RESTORE_NUMERIC_LOCAL();
2423 else if (SvTYPE(sv) < SVt_PVNV)
2424 sv_upgrade(sv, SVt_PVNV);
2429 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2430 #ifdef NV_PRESERVES_UV
2436 /* Only set the public NV OK flag if this NV preserves the IV */
2437 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2439 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2440 : (SvIVX(sv) == I_V(SvNVX(sv))))
2446 else if (SvPOKp(sv) && SvLEN(sv)) {
2448 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2449 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2451 #ifdef NV_PRESERVES_UV
2452 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2453 == IS_NUMBER_IN_UV) {
2454 /* It's definitely an integer */
2455 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2457 SvNV_set(sv, Atof(SvPVX_const(sv)));
2463 SvNV_set(sv, Atof(SvPVX_const(sv)));
2464 /* Only set the public NV OK flag if this NV preserves the value in
2465 the PV at least as well as an IV/UV would.
2466 Not sure how to do this 100% reliably. */
2467 /* if that shift count is out of range then Configure's test is
2468 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2470 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2471 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2472 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2473 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2474 /* Can't use strtol etc to convert this string, so don't try.
2475 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2478 /* value has been set. It may not be precise. */
2479 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2480 /* 2s complement assumption for (UV)IV_MIN */
2481 SvNOK_on(sv); /* Integer is too negative. */
2486 if (numtype & IS_NUMBER_NEG) {
2487 SvIV_set(sv, -(IV)value);
2488 } else if (value <= (UV)IV_MAX) {
2489 SvIV_set(sv, (IV)value);
2491 SvUV_set(sv, value);
2495 if (numtype & IS_NUMBER_NOT_INT) {
2496 /* I believe that even if the original PV had decimals,
2497 they are lost beyond the limit of the FP precision.
2498 However, neither is canonical, so both only get p
2499 flags. NWC, 2000/11/25 */
2500 /* Both already have p flags, so do nothing */
2502 const NV nv = SvNVX(sv);
2503 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2504 if (SvIVX(sv) == I_V(nv)) {
2507 /* It had no "." so it must be integer. */
2511 /* between IV_MAX and NV(UV_MAX).
2512 Could be slightly > UV_MAX */
2514 if (numtype & IS_NUMBER_NOT_INT) {
2515 /* UV and NV both imprecise. */
2517 const UV nv_as_uv = U_V(nv);
2519 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2528 /* It might be more code efficient to go through the entire logic above
2529 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2530 gets complex and potentially buggy, so more programmer efficient
2531 to do it this way, by turning off the public flags: */
2533 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2534 #endif /* NV_PRESERVES_UV */
2537 if (isGV_with_GP(sv)) {
2538 glob_2number((GV *)sv);
2542 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2544 assert (SvTYPE(sv) >= SVt_NV);
2545 /* Typically the caller expects that sv_any is not NULL now. */
2546 /* XXX Ilya implies that this is a bug in callers that assume this
2547 and ideally should be fixed. */
2550 #if defined(USE_LONG_DOUBLE)
2552 STORE_NUMERIC_LOCAL_SET_STANDARD();
2553 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2554 PTR2UV(sv), SvNVX(sv));
2555 RESTORE_NUMERIC_LOCAL();
2559 STORE_NUMERIC_LOCAL_SET_STANDARD();
2560 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2561 PTR2UV(sv), SvNVX(sv));
2562 RESTORE_NUMERIC_LOCAL();
2571 Return an SV with the numeric value of the source SV, doing any necessary
2572 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2573 access this function.
2579 Perl_sv_2num(pTHX_ register SV *sv)
2584 SV * const tmpsv = AMG_CALLun(sv,numer);
2585 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2586 return sv_2num(tmpsv);
2588 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2591 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2592 * UV as a string towards the end of buf, and return pointers to start and
2595 * We assume that buf is at least TYPE_CHARS(UV) long.
2599 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2601 char *ptr = buf + TYPE_CHARS(UV);
2602 char * const ebuf = ptr;
2615 *--ptr = '0' + (char)(uv % 10);
2624 =for apidoc sv_2pv_flags
2626 Returns a pointer to the string value of an SV, and sets *lp to its length.
2627 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2629 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2630 usually end up here too.
2636 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2646 if (SvGMAGICAL(sv)) {
2647 if (flags & SV_GMAGIC)
2652 if (flags & SV_MUTABLE_RETURN)
2653 return SvPVX_mutable(sv);
2654 if (flags & SV_CONST_RETURN)
2655 return (char *)SvPVX_const(sv);
2658 if (SvIOKp(sv) || SvNOKp(sv)) {
2659 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2664 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2665 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2667 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2674 #ifdef FIXNEGATIVEZERO
2675 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2681 SvUPGRADE(sv, SVt_PV);
2684 s = SvGROW_mutable(sv, len + 1);
2687 return (char*)memcpy(s, tbuf, len + 1);
2693 assert(SvTYPE(sv) >= SVt_PVMG);
2694 /* This falls through to the report_uninit near the end of the
2696 } else if (SvTHINKFIRST(sv)) {
2700 SV *const tmpstr = AMG_CALLun(sv,string);
2701 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2703 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2707 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2708 if (flags & SV_CONST_RETURN) {
2709 pv = (char *) SvPVX_const(tmpstr);
2711 pv = (flags & SV_MUTABLE_RETURN)
2712 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2715 *lp = SvCUR(tmpstr);
2717 pv = sv_2pv_flags(tmpstr, lp, flags);
2730 const SV *const referent = (SV*)SvRV(sv);
2734 retval = buffer = savepvn("NULLREF", len);
2735 } else if (SvTYPE(referent) == SVt_REGEXP) {
2736 const REGEXP * const re = (REGEXP *)referent;
2741 /* If the regex is UTF-8 we want the containing scalar to
2742 have an UTF-8 flag too */
2748 if ((seen_evals = RX_SEEN_EVALS(re)))
2749 PL_reginterp_cnt += seen_evals;
2752 *lp = RX_WRAPLEN(re);
2754 return RX_WRAPPED(re);
2756 const char *const typestr = sv_reftype(referent, 0);
2757 const STRLEN typelen = strlen(typestr);
2758 UV addr = PTR2UV(referent);
2759 const char *stashname = NULL;
2760 STRLEN stashnamelen = 0; /* hush, gcc */
2761 const char *buffer_end;
2763 if (SvOBJECT(referent)) {
2764 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2767 stashname = HEK_KEY(name);
2768 stashnamelen = HEK_LEN(name);
2770 if (HEK_UTF8(name)) {
2776 stashname = "__ANON__";
2779 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2780 + 2 * sizeof(UV) + 2 /* )\0 */;
2782 len = typelen + 3 /* (0x */
2783 + 2 * sizeof(UV) + 2 /* )\0 */;
2786 Newx(buffer, len, char);
2787 buffer_end = retval = buffer + len;
2789 /* Working backwards */
2793 *--retval = PL_hexdigit[addr & 15];
2794 } while (addr >>= 4);
2800 memcpy(retval, typestr, typelen);
2804 retval -= stashnamelen;
2805 memcpy(retval, stashname, stashnamelen);
2807 /* retval may not neccesarily have reached the start of the
2809 assert (retval >= buffer);
2811 len = buffer_end - retval - 1; /* -1 for that \0 */
2819 if (SvREADONLY(sv) && !SvOK(sv)) {
2822 if (flags & SV_UNDEF_RETURNS_NULL)
2824 if (ckWARN(WARN_UNINITIALIZED))
2829 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2830 /* I'm assuming that if both IV and NV are equally valid then
2831 converting the IV is going to be more efficient */
2832 const U32 isUIOK = SvIsUV(sv);
2833 char buf[TYPE_CHARS(UV)];
2837 if (SvTYPE(sv) < SVt_PVIV)
2838 sv_upgrade(sv, SVt_PVIV);
2839 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2841 /* inlined from sv_setpvn */
2842 s = SvGROW_mutable(sv, len + 1);
2843 Move(ptr, s, len, char);
2847 else if (SvNOKp(sv)) {
2848 const int olderrno = errno;
2849 if (SvTYPE(sv) < SVt_PVNV)
2850 sv_upgrade(sv, SVt_PVNV);
2851 /* The +20 is pure guesswork. Configure test needed. --jhi */
2852 s = SvGROW_mutable(sv, NV_DIG + 20);
2853 /* some Xenix systems wipe out errno here */
2855 if (SvNVX(sv) == 0.0)
2856 my_strlcpy(s, "0", SvLEN(sv));
2860 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2863 #ifdef FIXNEGATIVEZERO
2864 if (*s == '-' && s[1] == '0' && !s[2]) {
2876 if (isGV_with_GP(sv))
2877 return glob_2pv((GV *)sv, lp);
2881 if (flags & SV_UNDEF_RETURNS_NULL)
2883 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2885 if (SvTYPE(sv) < SVt_PV)
2886 /* Typically the caller expects that sv_any is not NULL now. */
2887 sv_upgrade(sv, SVt_PV);
2891 const STRLEN len = s - SvPVX_const(sv);
2897 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2898 PTR2UV(sv),SvPVX_const(sv)));
2899 if (flags & SV_CONST_RETURN)
2900 return (char *)SvPVX_const(sv);
2901 if (flags & SV_MUTABLE_RETURN)
2902 return SvPVX_mutable(sv);
2907 =for apidoc sv_copypv
2909 Copies a stringified representation of the source SV into the
2910 destination SV. Automatically performs any necessary mg_get and
2911 coercion of numeric values into strings. Guaranteed to preserve
2912 UTF8 flag even from overloaded objects. Similar in nature to
2913 sv_2pv[_flags] but operates directly on an SV instead of just the
2914 string. Mostly uses sv_2pv_flags to do its work, except when that
2915 would lose the UTF-8'ness of the PV.
2921 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2924 const char * const s = SvPV_const(ssv,len);
2925 sv_setpvn(dsv,s,len);
2933 =for apidoc sv_2pvbyte
2935 Return a pointer to the byte-encoded representation of the SV, and set *lp
2936 to its length. May cause the SV to be downgraded from UTF-8 as a
2939 Usually accessed via the C<SvPVbyte> macro.
2945 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2947 sv_utf8_downgrade(sv,0);
2948 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2952 =for apidoc sv_2pvutf8
2954 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2955 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2957 Usually accessed via the C<SvPVutf8> macro.
2963 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2965 sv_utf8_upgrade(sv);
2966 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2971 =for apidoc sv_2bool
2973 This function is only called on magical items, and is only used by
2974 sv_true() or its macro equivalent.
2980 Perl_sv_2bool(pTHX_ register SV *sv)
2989 SV * const tmpsv = AMG_CALLun(sv,bool_);
2990 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2991 return (bool)SvTRUE(tmpsv);
2993 return SvRV(sv) != 0;
2996 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2998 (*sv->sv_u.svu_pv > '0' ||
2999 Xpvtmp->xpv_cur > 1 ||
3000 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3007 return SvIVX(sv) != 0;
3010 return SvNVX(sv) != 0.0;
3012 if (isGV_with_GP(sv))
3022 =for apidoc sv_utf8_upgrade
3024 Converts the PV of an SV to its UTF-8-encoded form.
3025 Forces the SV to string form if it is not already.
3026 Always sets the SvUTF8 flag to avoid future validity checks even
3027 if all the bytes have hibit clear.
3029 This is not as a general purpose byte encoding to Unicode interface:
3030 use the Encode extension for that.
3032 =for apidoc sv_utf8_upgrade_flags
3034 Converts the PV of an SV to its UTF-8-encoded form.
3035 Forces the SV to string form if it is not already.
3036 Always sets the SvUTF8 flag to avoid future validity checks even
3037 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3038 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3039 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3041 This is not as a general purpose byte encoding to Unicode interface:
3042 use the Encode extension for that.
3048 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3051 if (sv == &PL_sv_undef)
3055 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3056 (void) sv_2pv_flags(sv,&len, flags);
3060 (void) SvPV_force(sv,len);
3069 sv_force_normal_flags(sv, 0);
3072 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3073 sv_recode_to_utf8(sv, PL_encoding);
3074 else { /* Assume Latin-1/EBCDIC */
3075 /* This function could be much more efficient if we
3076 * had a FLAG in SVs to signal if there are any hibit
3077 * chars in the PV. Given that there isn't such a flag
3078 * make the loop as fast as possible. */
3079 const U8 * const s = (U8 *) SvPVX_const(sv);
3080 const U8 * const e = (U8 *) SvEND(sv);
3085 /* Check for hi bit */
3086 if (!NATIVE_IS_INVARIANT(ch)) {
3087 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3088 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3090 SvPV_free(sv); /* No longer using what was there before. */
3091 SvPV_set(sv, (char*)recoded);
3092 SvCUR_set(sv, len - 1);
3093 SvLEN_set(sv, len); /* No longer know the real size. */
3097 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3104 =for apidoc sv_utf8_downgrade
3106 Attempts to convert the PV of an SV from characters to bytes.
3107 If the PV contains a character beyond byte, this conversion will fail;
3108 in this case, either returns false or, if C<fail_ok> is not
3111 This is not as a general purpose Unicode to byte encoding interface:
3112 use the Encode extension for that.
3118 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3121 if (SvPOKp(sv) && SvUTF8(sv)) {
3127 sv_force_normal_flags(sv, 0);
3129 s = (U8 *) SvPV(sv, len);
3130 if (!utf8_to_bytes(s, &len)) {
3135 Perl_croak(aTHX_ "Wide character in %s",
3138 Perl_croak(aTHX_ "Wide character");
3149 =for apidoc sv_utf8_encode
3151 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3152 flag off so that it looks like octets again.
3158 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3161 sv_force_normal_flags(sv, 0);
3163 if (SvREADONLY(sv)) {
3164 Perl_croak(aTHX_ PL_no_modify);
3166 (void) sv_utf8_upgrade(sv);
3171 =for apidoc sv_utf8_decode
3173 If the PV of the SV is an octet sequence in UTF-8
3174 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3175 so that it looks like a character. If the PV contains only single-byte
3176 characters, the C<SvUTF8> flag stays being off.
3177 Scans PV for validity and returns false if the PV is invalid UTF-8.
3183 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3189 /* The octets may have got themselves encoded - get them back as
3192 if (!sv_utf8_downgrade(sv, TRUE))
3195 /* it is actually just a matter of turning the utf8 flag on, but
3196 * we want to make sure everything inside is valid utf8 first.
3198 c = (const U8 *) SvPVX_const(sv);
3199 if (!is_utf8_string(c, SvCUR(sv)+1))
3201 e = (const U8 *) SvEND(sv);
3204 if (!UTF8_IS_INVARIANT(ch)) {
3214 =for apidoc sv_setsv
3216 Copies the contents of the source SV C<ssv> into the destination SV
3217 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3218 function if the source SV needs to be reused. Does not handle 'set' magic.
3219 Loosely speaking, it performs a copy-by-value, obliterating any previous
3220 content of the destination.
3222 You probably want to use one of the assortment of wrappers, such as
3223 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3224 C<SvSetMagicSV_nosteal>.
3226 =for apidoc sv_setsv_flags
3228 Copies the contents of the source SV C<ssv> into the destination SV
3229 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3230 function if the source SV needs to be reused. Does not handle 'set' magic.
3231 Loosely speaking, it performs a copy-by-value, obliterating any previous
3232 content of the destination.
3233 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3234 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3235 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3236 and C<sv_setsv_nomg> are implemented in terms of this function.
3238 You probably want to use one of the assortment of wrappers, such as
3239 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3240 C<SvSetMagicSV_nosteal>.
3242 This is the primary function for copying scalars, and most other
3243 copy-ish functions and macros use this underneath.
3249 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3251 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3253 if (dtype != SVt_PVGV) {
3254 const char * const name = GvNAME(sstr);
3255 const STRLEN len = GvNAMELEN(sstr);
3257 if (dtype >= SVt_PV) {
3263 SvUPGRADE(dstr, SVt_PVGV);
3264 (void)SvOK_off(dstr);
3265 /* FIXME - why are we doing this, then turning it off and on again
3267 isGV_with_GP_on(dstr);
3269 GvSTASH(dstr) = GvSTASH(sstr);
3271 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3272 gv_name_set((GV *)dstr, name, len, GV_ADD);
3273 SvFAKE_on(dstr); /* can coerce to non-glob */
3276 #ifdef GV_UNIQUE_CHECK
3277 if (GvUNIQUE((GV*)dstr)) {
3278 Perl_croak(aTHX_ PL_no_modify);
3282 if(GvGP((GV*)sstr)) {
3283 /* If source has method cache entry, clear it */
3285 SvREFCNT_dec(GvCV(sstr));
3289 /* If source has a real method, then a method is
3291 else if(GvCV((GV*)sstr)) {
3296 /* If dest already had a real method, that's a change as well */
3297 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3301 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3305 isGV_with_GP_off(dstr);
3306 (void)SvOK_off(dstr);
3307 isGV_with_GP_on(dstr);
3308 GvINTRO_off(dstr); /* one-shot flag */
3309 GvGP(dstr) = gp_ref(GvGP(sstr));
3310 if (SvTAINTED(sstr))
3312 if (GvIMPORTED(dstr) != GVf_IMPORTED
3313 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3315 GvIMPORTED_on(dstr);
3318 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3319 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3324 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3325 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3327 const int intro = GvINTRO(dstr);
3330 const U32 stype = SvTYPE(sref);
3333 #ifdef GV_UNIQUE_CHECK
3334 if (GvUNIQUE((GV*)dstr)) {
3335 Perl_croak(aTHX_ PL_no_modify);
3340 GvINTRO_off(dstr); /* one-shot flag */
3341 GvLINE(dstr) = CopLINE(PL_curcop);
3342 GvEGV(dstr) = (GV*)dstr;
3347 location = (SV **) &GvCV(dstr);
3348 import_flag = GVf_IMPORTED_CV;
3351 location = (SV **) &GvHV(dstr);
3352 import_flag = GVf_IMPORTED_HV;
3355 location = (SV **) &GvAV(dstr);
3356 import_flag = GVf_IMPORTED_AV;
3359 location = (SV **) &GvIOp(dstr);
3362 location = (SV **) &GvFORM(dstr);
3364 location = &GvSV(dstr);
3365 import_flag = GVf_IMPORTED_SV;
3368 if (stype == SVt_PVCV) {
3369 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3370 if (GvCVGEN(dstr)) {
3371 SvREFCNT_dec(GvCV(dstr));
3373 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3376 SAVEGENERICSV(*location);
3380 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3381 CV* const cv = (CV*)*location;
3383 if (!GvCVGEN((GV*)dstr) &&
3384 (CvROOT(cv) || CvXSUB(cv)))
3386 /* Redefining a sub - warning is mandatory if
3387 it was a const and its value changed. */
3388 if (CvCONST(cv) && CvCONST((CV*)sref)
3389 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3391 /* They are 2 constant subroutines generated from
3392 the same constant. This probably means that
3393 they are really the "same" proxy subroutine
3394 instantiated in 2 places. Most likely this is
3395 when a constant is exported twice. Don't warn.
3398 else if (ckWARN(WARN_REDEFINE)
3400 && (!CvCONST((CV*)sref)
3401 || sv_cmp(cv_const_sv(cv),
3402 cv_const_sv((CV*)sref))))) {
3403 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3406 ? "Constant subroutine %s::%s redefined"
3407 : "Subroutine %s::%s redefined"),
3408 HvNAME_get(GvSTASH((GV*)dstr)),
3409 GvENAME((GV*)dstr));
3413 cv_ckproto_len(cv, (GV*)dstr,
3414 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3415 SvPOK(sref) ? SvCUR(sref) : 0);
3417 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3418 GvASSUMECV_on(dstr);
3419 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3422 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3423 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3424 GvFLAGS(dstr) |= import_flag;
3429 if (SvTAINTED(sstr))
3435 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3438 register U32 sflags;
3440 register svtype stype;
3445 if (SvIS_FREED(dstr)) {
3446 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3447 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3449 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3451 sstr = &PL_sv_undef;
3452 if (SvIS_FREED(sstr)) {
3453 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3454 (void*)sstr, (void*)dstr);
3456 stype = SvTYPE(sstr);
3457 dtype = SvTYPE(dstr);
3459 (void)SvAMAGIC_off(dstr);
3462 /* need to nuke the magic */
3464 SvRMAGICAL_off(dstr);
3467 /* There's a lot of redundancy below but we're going for speed here */
3472 if (dtype != SVt_PVGV) {
3473 (void)SvOK_off(dstr);
3481 sv_upgrade(dstr, SVt_IV);
3485 sv_upgrade(dstr, SVt_PVIV);
3488 goto end_of_first_switch;
3490 (void)SvIOK_only(dstr);
3491 SvIV_set(dstr, SvIVX(sstr));
3494 /* SvTAINTED can only be true if the SV has taint magic, which in
3495 turn means that the SV type is PVMG (or greater). This is the
3496 case statement for SVt_IV, so this cannot be true (whatever gcov
3498 assert(!SvTAINTED(sstr));
3503 if (dtype < SVt_PV && dtype != SVt_IV)
3504 sv_upgrade(dstr, SVt_IV);
3512 sv_upgrade(dstr, SVt_NV);
3516 sv_upgrade(dstr, SVt_PVNV);
3519 goto end_of_first_switch;
3521 SvNV_set(dstr, SvNVX(sstr));
3522 (void)SvNOK_only(dstr);
3523 /* SvTAINTED can only be true if the SV has taint magic, which in
3524 turn means that the SV type is PVMG (or greater). This is the
3525 case statement for SVt_NV, so this cannot be true (whatever gcov
3527 assert(!SvTAINTED(sstr));
3533 #ifdef PERL_OLD_COPY_ON_WRITE
3534 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3535 if (dtype < SVt_PVIV)
3536 sv_upgrade(dstr, SVt_PVIV);
3544 sv_upgrade(dstr, SVt_PV);
3547 if (dtype < SVt_PVIV)
3548 sv_upgrade(dstr, SVt_PVIV);
3551 if (dtype < SVt_PVNV)
3552 sv_upgrade(dstr, SVt_PVNV);
3556 const char * const type = sv_reftype(sstr,0);
3558 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3560 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3564 /* case SVt_BIND: */
3567 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3568 glob_assign_glob(dstr, sstr, dtype);
3571 /* SvVALID means that this PVGV is playing at being an FBM. */
3575 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3577 if (SvTYPE(sstr) != stype) {
3578 stype = SvTYPE(sstr);
3579 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3580 glob_assign_glob(dstr, sstr, dtype);
3585 if (stype == SVt_PVLV)
3586 SvUPGRADE(dstr, SVt_PVNV);
3588 SvUPGRADE(dstr, (svtype)stype);
3590 end_of_first_switch:
3592 /* dstr may have been upgraded. */
3593 dtype = SvTYPE(dstr);
3594 sflags = SvFLAGS(sstr);
3596 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3597 /* Assigning to a subroutine sets the prototype. */
3600 const char *const ptr = SvPV_const(sstr, len);
3602 SvGROW(dstr, len + 1);
3603 Copy(ptr, SvPVX(dstr), len + 1, char);
3604 SvCUR_set(dstr, len);
3606 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3610 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3611 const char * const type = sv_reftype(dstr,0);
3613 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3615 Perl_croak(aTHX_ "Cannot copy to %s", type);
3616 } else if (sflags & SVf_ROK) {
3617 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3618 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3621 if (GvIMPORTED(dstr) != GVf_IMPORTED
3622 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3624 GvIMPORTED_on(dstr);
3629 glob_assign_glob(dstr, sstr, dtype);
3633 if (dtype >= SVt_PV) {
3634 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3635 glob_assign_ref(dstr, sstr);
3638 if (SvPVX_const(dstr)) {
3644 (void)SvOK_off(dstr);
3645 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3646 SvFLAGS(dstr) |= sflags & SVf_ROK;
3647 assert(!(sflags & SVp_NOK));
3648 assert(!(sflags & SVp_IOK));
3649 assert(!(sflags & SVf_NOK));
3650 assert(!(sflags & SVf_IOK));
3652 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3653 if (!(sflags & SVf_OK)) {
3654 if (ckWARN(WARN_MISC))
3655 Perl_warner(aTHX_ packWARN(WARN_MISC),
3656 "Undefined value assigned to typeglob");
3659 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3660 if (dstr != (SV*)gv) {
3663 GvGP(dstr) = gp_ref(GvGP(gv));
3667 else if (sflags & SVp_POK) {
3671 * Check to see if we can just swipe the string. If so, it's a
3672 * possible small lose on short strings, but a big win on long ones.
3673 * It might even be a win on short strings if SvPVX_const(dstr)
3674 * has to be allocated and SvPVX_const(sstr) has to be freed.
3675 * Likewise if we can set up COW rather than doing an actual copy, we
3676 * drop to the else clause, as the swipe code and the COW setup code
3677 * have much in common.
3680 /* Whichever path we take through the next code, we want this true,
3681 and doing it now facilitates the COW check. */
3682 (void)SvPOK_only(dstr);
3685 /* If we're already COW then this clause is not true, and if COW
3686 is allowed then we drop down to the else and make dest COW
3687 with us. If caller hasn't said that we're allowed to COW
3688 shared hash keys then we don't do the COW setup, even if the
3689 source scalar is a shared hash key scalar. */
3690 (((flags & SV_COW_SHARED_HASH_KEYS)
3691 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3692 : 1 /* If making a COW copy is forbidden then the behaviour we
3693 desire is as if the source SV isn't actually already
3694 COW, even if it is. So we act as if the source flags
3695 are not COW, rather than actually testing them. */
3697 #ifndef PERL_OLD_COPY_ON_WRITE
3698 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3699 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3700 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3701 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3702 but in turn, it's somewhat dead code, never expected to go
3703 live, but more kept as a placeholder on how to do it better
3704 in a newer implementation. */
3705 /* If we are COW and dstr is a suitable target then we drop down
3706 into the else and make dest a COW of us. */
3707 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3712 (sflags & SVs_TEMP) && /* slated for free anyway? */
3713 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3714 (!(flags & SV_NOSTEAL)) &&
3715 /* and we're allowed to steal temps */
3716 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3717 SvLEN(sstr) && /* and really is a string */
3718 /* and won't be needed again, potentially */
3719 !(PL_op && PL_op->op_type == OP_AASSIGN))
3720 #ifdef PERL_OLD_COPY_ON_WRITE
3721 && ((flags & SV_COW_SHARED_HASH_KEYS)
3722 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3723 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3724 && SvTYPE(sstr) >= SVt_PVIV))
3728 /* Failed the swipe test, and it's not a shared hash key either.
3729 Have to copy the string. */
3730 STRLEN len = SvCUR(sstr);
3731 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3732 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3733 SvCUR_set(dstr, len);
3734 *SvEND(dstr) = '\0';
3736 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3738 /* Either it's a shared hash key, or it's suitable for
3739 copy-on-write or we can swipe the string. */
3741 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3745 #ifdef PERL_OLD_COPY_ON_WRITE
3747 /* I believe I should acquire a global SV mutex if
3748 it's a COW sv (not a shared hash key) to stop
3749 it going un copy-on-write.
3750 If the source SV has gone un copy on write between up there
3751 and down here, then (assert() that) it is of the correct
3752 form to make it copy on write again */
3753 if ((sflags & (SVf_FAKE | SVf_READONLY))
3754 != (SVf_FAKE | SVf_READONLY)) {
3755 SvREADONLY_on(sstr);
3757 /* Make the source SV into a loop of 1.
3758 (about to become 2) */
3759 SV_COW_NEXT_SV_SET(sstr, sstr);
3763 /* Initial code is common. */
3764 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3769 /* making another shared SV. */
3770 STRLEN cur = SvCUR(sstr);
3771 STRLEN len = SvLEN(sstr);
3772 #ifdef PERL_OLD_COPY_ON_WRITE
3774 assert (SvTYPE(dstr) >= SVt_PVIV);
3775 /* SvIsCOW_normal */
3776 /* splice us in between source and next-after-source. */
3777 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3778 SV_COW_NEXT_SV_SET(sstr, dstr);
3779 SvPV_set(dstr, SvPVX_mutable(sstr));
3783 /* SvIsCOW_shared_hash */
3784 DEBUG_C(PerlIO_printf(Perl_debug_log,
3785 "Copy on write: Sharing hash\n"));
3787 assert (SvTYPE(dstr) >= SVt_PV);
3789 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3791 SvLEN_set(dstr, len);
3792 SvCUR_set(dstr, cur);
3793 SvREADONLY_on(dstr);
3795 /* Relesase a global SV mutex. */
3798 { /* Passes the swipe test. */
3799 SvPV_set(dstr, SvPVX_mutable(sstr));
3800 SvLEN_set(dstr, SvLEN(sstr));
3801 SvCUR_set(dstr, SvCUR(sstr));
3804 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3805 SvPV_set(sstr, NULL);
3811 if (sflags & SVp_NOK) {
3812 SvNV_set(dstr, SvNVX(sstr));
3814 if (sflags & SVp_IOK) {
3815 SvIV_set(dstr, SvIVX(sstr));
3816 /* Must do this otherwise some other overloaded use of 0x80000000
3817 gets confused. I guess SVpbm_VALID */
3818 if (sflags & SVf_IVisUV)
3821 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3823 const MAGIC * const smg = SvVSTRING_mg(sstr);
3825 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3826 smg->mg_ptr, smg->mg_len);
3827 SvRMAGICAL_on(dstr);
3831 else if (sflags & (SVp_IOK|SVp_NOK)) {
3832 (void)SvOK_off(dstr);
3833 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3834 if (sflags & SVp_IOK) {
3835 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3836 SvIV_set(dstr, SvIVX(sstr));
3838 if (sflags & SVp_NOK) {
3839 SvNV_set(dstr, SvNVX(sstr));
3843 if (isGV_with_GP(sstr)) {
3844 /* This stringification rule for globs is spread in 3 places.
3845 This feels bad. FIXME. */
3846 const U32 wasfake = sflags & SVf_FAKE;
3848 /* FAKE globs can get coerced, so need to turn this off
3849 temporarily if it is on. */
3851 gv_efullname3(dstr, (GV *)sstr, "*");
3852 SvFLAGS(sstr) |= wasfake;
3855 (void)SvOK_off(dstr);
3857 if (SvTAINTED(sstr))
3862 =for apidoc sv_setsv_mg
3864 Like C<sv_setsv>, but also handles 'set' magic.
3870 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3872 sv_setsv(dstr,sstr);
3876 #ifdef PERL_OLD_COPY_ON_WRITE
3878 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3880 STRLEN cur = SvCUR(sstr);
3881 STRLEN len = SvLEN(sstr);
3882 register char *new_pv;
3885 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3886 (void*)sstr, (void*)dstr);
3893 if (SvTHINKFIRST(dstr))
3894 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3895 else if (SvPVX_const(dstr))
3896 Safefree(SvPVX_const(dstr));
3900 SvUPGRADE(dstr, SVt_PVIV);
3902 assert (SvPOK(sstr));
3903 assert (SvPOKp(sstr));
3904 assert (!SvIOK(sstr));
3905 assert (!SvIOKp(sstr));
3906 assert (!SvNOK(sstr));
3907 assert (!SvNOKp(sstr));
3909 if (SvIsCOW(sstr)) {
3911 if (SvLEN(sstr) == 0) {
3912 /* source is a COW shared hash key. */
3913 DEBUG_C(PerlIO_printf(Perl_debug_log,
3914 "Fast copy on write: Sharing hash\n"));
3915 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3918 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3920 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3921 SvUPGRADE(sstr, SVt_PVIV);
3922 SvREADONLY_on(sstr);
3924 DEBUG_C(PerlIO_printf(Perl_debug_log,
3925 "Fast copy on write: Converting sstr to COW\n"));
3926 SV_COW_NEXT_SV_SET(dstr, sstr);
3928 SV_COW_NEXT_SV_SET(sstr, dstr);
3929 new_pv = SvPVX_mutable(sstr);
3932 SvPV_set(dstr, new_pv);
3933 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3936 SvLEN_set(dstr, len);
3937 SvCUR_set(dstr, cur);
3946 =for apidoc sv_setpvn
3948 Copies a string into an SV. The C<len> parameter indicates the number of
3949 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3950 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3956 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3959 register char *dptr;
3961 SV_CHECK_THINKFIRST_COW_DROP(sv);
3967 /* len is STRLEN which is unsigned, need to copy to signed */
3970 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3972 SvUPGRADE(sv, SVt_PV);
3974 dptr = SvGROW(sv, len + 1);
3975 Move(ptr,dptr,len,char);
3978 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3983 =for apidoc sv_setpvn_mg
3985 Like C<sv_setpvn>, but also handles 'set' magic.
3991 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3993 sv_setpvn(sv,ptr,len);
3998 =for apidoc sv_setpv
4000 Copies a string into an SV. The string must be null-terminated. Does not
4001 handle 'set' magic. See C<sv_setpv_mg>.
4007 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4010 register STRLEN len;
4012 SV_CHECK_THINKFIRST_COW_DROP(sv);
4018 SvUPGRADE(sv, SVt_PV);
4020 SvGROW(sv, len + 1);
4021 Move(ptr,SvPVX(sv),len+1,char);
4023 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4028 =for apidoc sv_setpv_mg
4030 Like C<sv_setpv>, but also handles 'set' magic.
4036 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4043 =for apidoc sv_usepvn_flags
4045 Tells an SV to use C<ptr> to find its string value. Normally the
4046 string is stored inside the SV but sv_usepvn allows the SV to use an
4047 outside string. The C<ptr> should point to memory that was allocated
4048 by C<malloc>. The string length, C<len>, must be supplied. By default
4049 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4050 so that pointer should not be freed or used by the programmer after
4051 giving it to sv_usepvn, and neither should any pointers from "behind"
4052 that pointer (e.g. ptr + 1) be used.
4054 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4055 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4056 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4057 C<len>, and already meets the requirements for storing in C<SvPVX>)
4063 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4067 SV_CHECK_THINKFIRST_COW_DROP(sv);
4068 SvUPGRADE(sv, SVt_PV);
4071 if (flags & SV_SMAGIC)
4075 if (SvPVX_const(sv))
4079 if (flags & SV_HAS_TRAILING_NUL)
4080 assert(ptr[len] == '\0');
4083 allocate = (flags & SV_HAS_TRAILING_NUL)
4084 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4085 if (flags & SV_HAS_TRAILING_NUL) {
4086 /* It's long enough - do nothing.
4087 Specfically Perl_newCONSTSUB is relying on this. */
4090 /* Force a move to shake out bugs in callers. */
4091 char *new_ptr = (char*)safemalloc(allocate);
4092 Copy(ptr, new_ptr, len, char);
4093 PoisonFree(ptr,len,char);
4097 ptr = (char*) saferealloc (ptr, allocate);
4102 SvLEN_set(sv, allocate);
4103 if (!(flags & SV_HAS_TRAILING_NUL)) {
4106 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4108 if (flags & SV_SMAGIC)
4112 #ifdef PERL_OLD_COPY_ON_WRITE
4113 /* Need to do this *after* making the SV normal, as we need the buffer
4114 pointer to remain valid until after we've copied it. If we let go too early,
4115 another thread could invalidate it by unsharing last of the same hash key
4116 (which it can do by means other than releasing copy-on-write Svs)
4117 or by changing the other copy-on-write SVs in the loop. */
4119 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4121 { /* this SV was SvIsCOW_normal(sv) */
4122 /* we need to find the SV pointing to us. */
4123 SV *current = SV_COW_NEXT_SV(after);
4125 if (current == sv) {
4126 /* The SV we point to points back to us (there were only two of us
4128 Hence other SV is no longer copy on write either. */
4130 SvREADONLY_off(after);
4132 /* We need to follow the pointers around the loop. */
4134 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4137 /* don't loop forever if the structure is bust, and we have
4138 a pointer into a closed loop. */
4139 assert (current != after);
4140 assert (SvPVX_const(current) == pvx);
4142 /* Make the SV before us point to the SV after us. */
4143 SV_COW_NEXT_SV_SET(current, after);
4149 =for apidoc sv_force_normal_flags
4151 Undo various types of fakery on an SV: if the PV is a shared string, make
4152 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4153 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4154 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4155 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4156 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4157 set to some other value.) In addition, the C<flags> parameter gets passed to
4158 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4159 with flags set to 0.
4165 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4168 #ifdef PERL_OLD_COPY_ON_WRITE
4169 if (SvREADONLY(sv)) {
4170 /* At this point I believe I should acquire a global SV mutex. */
4172 const char * const pvx = SvPVX_const(sv);
4173 const STRLEN len = SvLEN(sv);
4174 const STRLEN cur = SvCUR(sv);
4175 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4176 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4177 we'll fail an assertion. */
4178 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4181 PerlIO_printf(Perl_debug_log,
4182 "Copy on write: Force normal %ld\n",
4188 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4191 if (flags & SV_COW_DROP_PV) {
4192 /* OK, so we don't need to copy our buffer. */
4195 SvGROW(sv, cur + 1);
4196 Move(pvx,SvPVX(sv),cur,char);
4201 sv_release_COW(sv, pvx, next);
4203 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4209 else if (IN_PERL_RUNTIME)
4210 Perl_croak(aTHX_ PL_no_modify);
4211 /* At this point I believe that I can drop the global SV mutex. */
4214 if (SvREADONLY(sv)) {
4216 const char * const pvx = SvPVX_const(sv);
4217 const STRLEN len = SvCUR(sv);
4222 SvGROW(sv, len + 1);
4223 Move(pvx,SvPVX(sv),len,char);
4225 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4227 else if (IN_PERL_RUNTIME)
4228 Perl_croak(aTHX_ PL_no_modify);
4232 sv_unref_flags(sv, flags);
4233 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4240 Efficient removal of characters from the beginning of the string buffer.
4241 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4242 the string buffer. The C<ptr> becomes the first character of the adjusted
4243 string. Uses the "OOK hack".
4244 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4245 refer to the same chunk of data.
4251 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4257 const U8 *real_start;
4260 if (!ptr || !SvPOKp(sv))
4262 delta = ptr - SvPVX_const(sv);
4264 /* Nothing to do. */
4267 assert(ptr > SvPVX_const(sv));
4268 SV_CHECK_THINKFIRST(sv);
4271 if (!SvLEN(sv)) { /* make copy of shared string */
4272 const char *pvx = SvPVX_const(sv);
4273 const STRLEN len = SvCUR(sv);
4274 SvGROW(sv, len + 1);
4275 Move(pvx,SvPVX(sv),len,char);
4278 SvFLAGS(sv) |= SVf_OOK;
4281 SvOOK_offset(sv, old_delta);
4283 SvLEN_set(sv, SvLEN(sv) - delta);
4284 SvCUR_set(sv, SvCUR(sv) - delta);
4285 SvPV_set(sv, SvPVX(sv) + delta);
4287 p = (U8 *)SvPVX_const(sv);
4292 real_start = p - delta;
4296 if (delta < 0x100) {
4300 p -= sizeof(STRLEN);
4301 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4305 /* Fill the preceding buffer with sentinals to verify that no-one is
4307 while (p > real_start) {
4315 =for apidoc sv_catpvn
4317 Concatenates the string onto the end of the string which is in the SV. The
4318 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4319 status set, then the bytes appended should be valid UTF-8.
4320 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4322 =for apidoc sv_catpvn_flags
4324 Concatenates the string onto the end of the string which is in the SV. The
4325 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4326 status set, then the bytes appended should be valid UTF-8.
4327 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4328 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4329 in terms of this function.
4335 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4339 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4341 SvGROW(dsv, dlen + slen + 1);
4343 sstr = SvPVX_const(dsv);
4344 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4345 SvCUR_set(dsv, SvCUR(dsv) + slen);
4347 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4349 if (flags & SV_SMAGIC)
4354 =for apidoc sv_catsv
4356 Concatenates the string from SV C<ssv> onto the end of the string in
4357 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4358 not 'set' magic. See C<sv_catsv_mg>.
4360 =for apidoc sv_catsv_flags
4362 Concatenates the string from SV C<ssv> onto the end of the string in
4363 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4364 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4365 and C<sv_catsv_nomg> are implemented in terms of this function.
4370 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4375 const char *spv = SvPV_const(ssv, slen);
4377 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4378 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4379 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4380 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4381 dsv->sv_flags doesn't have that bit set.
4382 Andy Dougherty 12 Oct 2001
4384 const I32 sutf8 = DO_UTF8(ssv);
4387 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4389 dutf8 = DO_UTF8(dsv);
4391 if (dutf8 != sutf8) {
4393 /* Not modifying source SV, so taking a temporary copy. */
4394 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4396 sv_utf8_upgrade(csv);
4397 spv = SvPV_const(csv, slen);
4400 sv_utf8_upgrade_nomg(dsv);
4402 sv_catpvn_nomg(dsv, spv, slen);
4405 if (flags & SV_SMAGIC)
4410 =for apidoc sv_catpv
4412 Concatenates the string onto the end of the string which is in the SV.
4413 If the SV has the UTF-8 status set, then the bytes appended should be
4414 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4419 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4422 register STRLEN len;
4428 junk = SvPV_force(sv, tlen);
4430 SvGROW(sv, tlen + len + 1);
4432 ptr = SvPVX_const(sv);
4433 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4434 SvCUR_set(sv, SvCUR(sv) + len);
4435 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4440 =for apidoc sv_catpv_mg
4442 Like C<sv_catpv>, but also handles 'set' magic.
4448 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4457 Creates a new SV. A non-zero C<len> parameter indicates the number of
4458 bytes of preallocated string space the SV should have. An extra byte for a
4459 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4460 space is allocated.) The reference count for the new SV is set to 1.
4462 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4463 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4464 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4465 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4466 modules supporting older perls.
4472 Perl_newSV(pTHX_ STRLEN len)
4479 sv_upgrade(sv, SVt_PV);
4480 SvGROW(sv, len + 1);
4485 =for apidoc sv_magicext
4487 Adds magic to an SV, upgrading it if necessary. Applies the
4488 supplied vtable and returns a pointer to the magic added.
4490 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4491 In particular, you can add magic to SvREADONLY SVs, and add more than
4492 one instance of the same 'how'.
4494 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4495 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4496 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4497 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4499 (This is now used as a subroutine by C<sv_magic>.)
4504 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4505 const char* name, I32 namlen)
4510 SvUPGRADE(sv, SVt_PVMG);
4511 Newxz(mg, 1, MAGIC);
4512 mg->mg_moremagic = SvMAGIC(sv);
4513 SvMAGIC_set(sv, mg);
4515 /* Sometimes a magic contains a reference loop, where the sv and
4516 object refer to each other. To prevent a reference loop that
4517 would prevent such objects being freed, we look for such loops
4518 and if we find one we avoid incrementing the object refcount.
4520 Note we cannot do this to avoid self-tie loops as intervening RV must
4521 have its REFCNT incremented to keep it in existence.
4524 if (!obj || obj == sv ||
4525 how == PERL_MAGIC_arylen ||
4526 how == PERL_MAGIC_symtab ||
4527 (SvTYPE(obj) == SVt_PVGV &&
4528 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4529 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4530 GvFORM(obj) == (CV*)sv)))
4535 mg->mg_obj = SvREFCNT_inc_simple(obj);
4536 mg->mg_flags |= MGf_REFCOUNTED;
4539 /* Normal self-ties simply pass a null object, and instead of
4540 using mg_obj directly, use the SvTIED_obj macro to produce a
4541 new RV as needed. For glob "self-ties", we are tieing the PVIO
4542 with an RV obj pointing to the glob containing the PVIO. In
4543 this case, to avoid a reference loop, we need to weaken the
4547 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4548 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4554 mg->mg_len = namlen;
4557 mg->mg_ptr = savepvn(name, namlen);
4558 else if (namlen == HEf_SVKEY)
4559 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4561 mg->mg_ptr = (char *) name;
4563 mg->mg_virtual = (MGVTBL *) vtable;
4567 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4572 =for apidoc sv_magic
4574 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4575 then adds a new magic item of type C<how> to the head of the magic list.
4577 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4578 handling of the C<name> and C<namlen> arguments.
4580 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4581 to add more than one instance of the same 'how'.
4587 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4590 const MGVTBL *vtable;
4593 #ifdef PERL_OLD_COPY_ON_WRITE
4595 sv_force_normal_flags(sv, 0);
4597 if (SvREADONLY(sv)) {
4599 /* its okay to attach magic to shared strings; the subsequent
4600 * upgrade to PVMG will unshare the string */
4601 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4604 && how != PERL_MAGIC_regex_global
4605 && how != PERL_MAGIC_bm
4606 && how != PERL_MAGIC_fm
4607 && how != PERL_MAGIC_sv
4608 && how != PERL_MAGIC_backref
4611 Perl_croak(aTHX_ PL_no_modify);
4614 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4615 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4616 /* sv_magic() refuses to add a magic of the same 'how' as an
4619 if (how == PERL_MAGIC_taint) {
4621 /* Any scalar which already had taint magic on which someone
4622 (erroneously?) did SvIOK_on() or similar will now be
4623 incorrectly sporting public "OK" flags. */
4624 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4632 vtable = &PL_vtbl_sv;
4634 case PERL_MAGIC_overload:
4635 vtable = &PL_vtbl_amagic;
4637 case PERL_MAGIC_overload_elem:
4638 vtable = &PL_vtbl_amagicelem;
4640 case PERL_MAGIC_overload_table:
4641 vtable = &PL_vtbl_ovrld;
4644 vtable = &PL_vtbl_bm;
4646 case PERL_MAGIC_regdata:
4647 vtable = &PL_vtbl_regdata;
4649 case PERL_MAGIC_regdatum:
4650 vtable = &PL_vtbl_regdatum;
4652 case PERL_MAGIC_env:
4653 vtable = &PL_vtbl_env;
4656 vtable = &PL_vtbl_fm;
4658 case PERL_MAGIC_envelem:
4659 vtable = &PL_vtbl_envelem;
4661 case PERL_MAGIC_regex_global:
4662 vtable = &PL_vtbl_mglob;
4664 case PERL_MAGIC_isa:
4665 vtable = &PL_vtbl_isa;
4667 case PERL_MAGIC_isaelem:
4668 vtable = &PL_vtbl_isaelem;
4670 case PERL_MAGIC_nkeys:
4671 vtable = &PL_vtbl_nkeys;
4673 case PERL_MAGIC_dbfile:
4676 case PERL_MAGIC_dbline:
4677 vtable = &PL_vtbl_dbline;
4679 #ifdef USE_LOCALE_COLLATE
4680 case PERL_MAGIC_collxfrm:
4681 vtable = &PL_vtbl_collxfrm;
4683 #endif /* USE_LOCALE_COLLATE */
4684 case PERL_MAGIC_tied:
4685 vtable = &PL_vtbl_pack;
4687 case PERL_MAGIC_tiedelem:
4688 case PERL_MAGIC_tiedscalar:
4689 vtable = &PL_vtbl_packelem;
4692 vtable = &PL_vtbl_regexp;
4694 case PERL_MAGIC_hints:
4695 /* As this vtable is all NULL, we can reuse it. */
4696 case PERL_MAGIC_sig:
4697 vtable = &PL_vtbl_sig;
4699 case PERL_MAGIC_sigelem:
4700 vtable = &PL_vtbl_sigelem;
4702 case PERL_MAGIC_taint:
4703 vtable = &PL_vtbl_taint;
4705 case PERL_MAGIC_uvar:
4706 vtable = &PL_vtbl_uvar;
4708 case PERL_MAGIC_vec:
4709 vtable = &PL_vtbl_vec;
4711 case PERL_MAGIC_arylen_p:
4712 case PERL_MAGIC_rhash:
4713 case PERL_MAGIC_symtab:
4714 case PERL_MAGIC_vstring:
4717 case PERL_MAGIC_utf8:
4718 vtable = &PL_vtbl_utf8;
4720 case PERL_MAGIC_substr:
4721 vtable = &PL_vtbl_substr;
4723 case PERL_MAGIC_defelem:
4724 vtable = &PL_vtbl_defelem;
4726 case PERL_MAGIC_arylen:
4727 vtable = &PL_vtbl_arylen;
4729 case PERL_MAGIC_pos:
4730 vtable = &PL_vtbl_pos;
4732 case PERL_MAGIC_backref:
4733 vtable = &PL_vtbl_backref;
4735 case PERL_MAGIC_hintselem:
4736 vtable = &PL_vtbl_hintselem;
4738 case PERL_MAGIC_ext:
4739 /* Reserved for use by extensions not perl internals. */
4740 /* Useful for attaching extension internal data to perl vars. */
4741 /* Note that multiple extensions may clash if magical scalars */
4742 /* etc holding private data from one are passed to another. */
4746 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4749 /* Rest of work is done else where */
4750 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4753 case PERL_MAGIC_taint:
4756 case PERL_MAGIC_ext:
4757 case PERL_MAGIC_dbfile:
4764 =for apidoc sv_unmagic
4766 Removes all magic of type C<type> from an SV.
4772 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4776 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4778 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4779 for (mg = *mgp; mg; mg = *mgp) {
4780 if (mg->mg_type == type) {
4781 const MGVTBL* const vtbl = mg->mg_virtual;
4782 *mgp = mg->mg_moremagic;
4783 if (vtbl && vtbl->svt_free)
4784 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4785 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4787 Safefree(mg->mg_ptr);
4788 else if (mg->mg_len == HEf_SVKEY)
4789 SvREFCNT_dec((SV*)mg->mg_ptr);
4790 else if (mg->mg_type == PERL_MAGIC_utf8)
4791 Safefree(mg->mg_ptr);
4793 if (mg->mg_flags & MGf_REFCOUNTED)
4794 SvREFCNT_dec(mg->mg_obj);
4798 mgp = &mg->mg_moremagic;
4802 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4803 SvMAGIC_set(sv, NULL);
4810 =for apidoc sv_rvweaken
4812 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4813 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4814 push a back-reference to this RV onto the array of backreferences
4815 associated with that magic. If the RV is magical, set magic will be
4816 called after the RV is cleared.
4822 Perl_sv_rvweaken(pTHX_ SV *sv)
4825 if (!SvOK(sv)) /* let undefs pass */
4828 Perl_croak(aTHX_ "Can't weaken a nonreference");
4829 else if (SvWEAKREF(sv)) {
4830 if (ckWARN(WARN_MISC))
4831 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4835 Perl_sv_add_backref(aTHX_ tsv, sv);
4841 /* Give tsv backref magic if it hasn't already got it, then push a
4842 * back-reference to sv onto the array associated with the backref magic.
4846 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4851 if (SvTYPE(tsv) == SVt_PVHV) {
4852 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4856 /* There is no AV in the offical place - try a fixup. */
4857 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4860 /* Aha. They've got it stowed in magic. Bring it back. */
4861 av = (AV*)mg->mg_obj;
4862 /* Stop mg_free decreasing the refernce count. */
4864 /* Stop mg_free even calling the destructor, given that
4865 there's no AV to free up. */
4867 sv_unmagic(tsv, PERL_MAGIC_backref);
4871 SvREFCNT_inc_simple_void(av);
4876 const MAGIC *const mg
4877 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4879 av = (AV*)mg->mg_obj;
4883 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4884 /* av now has a refcnt of 2, which avoids it getting freed
4885 * before us during global cleanup. The extra ref is removed
4886 * by magic_killbackrefs() when tsv is being freed */
4889 if (AvFILLp(av) >= AvMAX(av)) {
4890 av_extend(av, AvFILLp(av)+1);
4892 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4895 /* delete a back-reference to ourselves from the backref magic associated
4896 * with the SV we point to.
4900 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4907 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4908 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4909 /* We mustn't attempt to "fix up" the hash here by moving the
4910 backreference array back to the hv_aux structure, as that is stored
4911 in the main HvARRAY(), and hfreentries assumes that no-one
4912 reallocates HvARRAY() while it is running. */
4915 const MAGIC *const mg
4916 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4918 av = (AV *)mg->mg_obj;
4921 if (PL_in_clean_all)
4923 Perl_croak(aTHX_ "panic: del_backref");
4930 /* We shouldn't be in here more than once, but for paranoia reasons lets
4932 for (i = AvFILLp(av); i >= 0; i--) {
4934 const SSize_t fill = AvFILLp(av);
4936 /* We weren't the last entry.
4937 An unordered list has this property that you can take the
4938 last element off the end to fill the hole, and it's still
4939 an unordered list :-)
4944 AvFILLp(av) = fill - 1;
4950 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4952 SV **svp = AvARRAY(av);
4954 PERL_UNUSED_ARG(sv);
4956 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4957 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4958 if (svp && !SvIS_FREED(av)) {
4959 SV *const *const last = svp + AvFILLp(av);
4961 while (svp <= last) {
4963 SV *const referrer = *svp;
4964 if (SvWEAKREF(referrer)) {
4965 /* XXX Should we check that it hasn't changed? */
4966 SvRV_set(referrer, 0);
4968 SvWEAKREF_off(referrer);
4969 SvSETMAGIC(referrer);
4970 } else if (SvTYPE(referrer) == SVt_PVGV ||
4971 SvTYPE(referrer) == SVt_PVLV) {
4972 /* You lookin' at me? */
4973 assert(GvSTASH(referrer));
4974 assert(GvSTASH(referrer) == (HV*)sv);
4975 GvSTASH(referrer) = 0;
4978 "panic: magic_killbackrefs (flags=%"UVxf")",
4979 (UV)SvFLAGS(referrer));
4987 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4992 =for apidoc sv_insert
4994 Inserts a string at the specified offset/length within the SV. Similar to
4995 the Perl substr() function.
5001 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5006 register char *midend;
5007 register char *bigend;
5013 Perl_croak(aTHX_ "Can't modify non-existent substring");
5014 SvPV_force(bigstr, curlen);
5015 (void)SvPOK_only_UTF8(bigstr);
5016 if (offset + len > curlen) {
5017 SvGROW(bigstr, offset+len+1);
5018 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5019 SvCUR_set(bigstr, offset+len);
5023 i = littlelen - len;
5024 if (i > 0) { /* string might grow */
5025 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5026 mid = big + offset + len;
5027 midend = bigend = big + SvCUR(bigstr);
5030 while (midend > mid) /* shove everything down */
5031 *--bigend = *--midend;
5032 Move(little,big+offset,littlelen,char);
5033 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5038 Move(little,SvPVX(bigstr)+offset,len,char);
5043 big = SvPVX(bigstr);
5046 bigend = big + SvCUR(bigstr);
5048 if (midend > bigend)
5049 Perl_croak(aTHX_ "panic: sv_insert");
5051 if (mid - big > bigend - midend) { /* faster to shorten from end */
5053 Move(little, mid, littlelen,char);
5056 i = bigend - midend;
5058 Move(midend, mid, i,char);
5062 SvCUR_set(bigstr, mid - big);
5064 else if ((i = mid - big)) { /* faster from front */
5065 midend -= littlelen;
5067 Move(big, midend - i, i, char);
5068 sv_chop(bigstr,midend-i);
5070 Move(little, mid, littlelen,char);
5072 else if (littlelen) {
5073 midend -= littlelen;
5074 sv_chop(bigstr,midend);
5075 Move(little,midend,littlelen,char);
5078 sv_chop(bigstr,midend);
5084 =for apidoc sv_replace
5086 Make the first argument a copy of the second, then delete the original.
5087 The target SV physically takes over ownership of the body of the source SV
5088 and inherits its flags; however, the target keeps any magic it owns,
5089 and any magic in the source is discarded.
5090 Note that this is a rather specialist SV copying operation; most of the
5091 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5097 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5100 const U32 refcnt = SvREFCNT(sv);
5101 SV_CHECK_THINKFIRST_COW_DROP(sv);
5102 if (SvREFCNT(nsv) != 1) {
5103 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5104 UVuf " != 1)", (UV) SvREFCNT(nsv));
5106 if (SvMAGICAL(sv)) {
5110 sv_upgrade(nsv, SVt_PVMG);
5111 SvMAGIC_set(nsv, SvMAGIC(sv));
5112 SvFLAGS(nsv) |= SvMAGICAL(sv);
5114 SvMAGIC_set(sv, NULL);
5118 assert(!SvREFCNT(sv));
5119 #ifdef DEBUG_LEAKING_SCALARS
5120 sv->sv_flags = nsv->sv_flags;
5121 sv->sv_any = nsv->sv_any;
5122 sv->sv_refcnt = nsv->sv_refcnt;
5123 sv->sv_u = nsv->sv_u;
5125 StructCopy(nsv,sv,SV);
5127 if(SvTYPE(sv) == SVt_IV) {
5129 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5133 #ifdef PERL_OLD_COPY_ON_WRITE
5134 if (SvIsCOW_normal(nsv)) {
5135 /* We need to follow the pointers around the loop to make the
5136 previous SV point to sv, rather than nsv. */
5139 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5142 assert(SvPVX_const(current) == SvPVX_const(nsv));
5144 /* Make the SV before us point to the SV after us. */
5146 PerlIO_printf(Perl_debug_log, "previous is\n");
5148 PerlIO_printf(Perl_debug_log,
5149 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5150 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5152 SV_COW_NEXT_SV_SET(current, sv);
5155 SvREFCNT(sv) = refcnt;
5156 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5162 =for apidoc sv_clear
5164 Clear an SV: call any destructors, free up any memory used by the body,
5165 and free the body itself. The SV's head is I<not> freed, although
5166 its type is set to all 1's so that it won't inadvertently be assumed
5167 to be live during global destruction etc.
5168 This function should only be called when REFCNT is zero. Most of the time
5169 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5176 Perl_sv_clear(pTHX_ register SV *sv)
5179 const U32 type = SvTYPE(sv);
5180 const struct body_details *const sv_type_details
5181 = bodies_by_type + type;
5185 assert(SvREFCNT(sv) == 0);
5186 assert(SvTYPE(sv) != SVTYPEMASK);
5188 if (type <= SVt_IV) {
5189 /* See the comment in sv.h about the collusion between this early
5190 return and the overloading of the NULL and IV slots in the size
5193 SV * const target = SvRV(sv);
5195 sv_del_backref(target, sv);
5197 SvREFCNT_dec(target);
5199 SvFLAGS(sv) &= SVf_BREAK;
5200 SvFLAGS(sv) |= SVTYPEMASK;
5205 if (PL_defstash && /* Still have a symbol table? */
5212 stash = SvSTASH(sv);
5213 destructor = StashHANDLER(stash,DESTROY);
5215 SV* const tmpref = newRV(sv);
5216 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5218 PUSHSTACKi(PERLSI_DESTROY);
5223 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5229 if(SvREFCNT(tmpref) < 2) {
5230 /* tmpref is not kept alive! */
5232 SvRV_set(tmpref, NULL);
5235 SvREFCNT_dec(tmpref);
5237 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5241 if (PL_in_clean_objs)
5242 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5244 /* DESTROY gave object new lease on life */
5250 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5251 SvOBJECT_off(sv); /* Curse the object. */
5252 if (type != SVt_PVIO)
5253 --PL_sv_objcount; /* XXX Might want something more general */
5256 if (type >= SVt_PVMG) {
5257 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5258 SvREFCNT_dec(SvOURSTASH(sv));
5259 } else if (SvMAGIC(sv))
5261 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5262 SvREFCNT_dec(SvSTASH(sv));
5265 /* case SVt_BIND: */
5268 IoIFP(sv) != PerlIO_stdin() &&
5269 IoIFP(sv) != PerlIO_stdout() &&
5270 IoIFP(sv) != PerlIO_stderr())
5272 io_close((IO*)sv, FALSE);
5274 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5275 PerlDir_close(IoDIRP(sv));
5276 IoDIRP(sv) = (DIR*)NULL;
5277 Safefree(IoTOP_NAME(sv));
5278 Safefree(IoFMT_NAME(sv));
5279 Safefree(IoBOTTOM_NAME(sv));
5282 /* FIXME for plugins */
5283 pregfree2((REGEXP*) sv);
5290 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5294 if (PL_comppad == (AV*)sv) {
5301 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5302 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5303 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5304 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5306 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5307 SvREFCNT_dec(LvTARG(sv));
5309 if (isGV_with_GP(sv)) {
5310 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5311 mro_method_changed_in(stash);
5314 unshare_hek(GvNAME_HEK(sv));
5315 /* If we're in a stash, we don't own a reference to it. However it does
5316 have a back reference to us, which needs to be cleared. */
5317 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5318 sv_del_backref((SV*)stash, sv);
5320 /* FIXME. There are probably more unreferenced pointers to SVs in the
5321 interpreter struct that we should check and tidy in a similar
5323 if ((GV*)sv == PL_last_in_gv)
5324 PL_last_in_gv = NULL;
5330 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5333 SvOOK_offset(sv, offset);
5334 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5335 /* Don't even bother with turning off the OOK flag. */
5338 SV * const target = SvRV(sv);
5340 sv_del_backref(target, sv);
5342 SvREFCNT_dec(target);
5344 #ifdef PERL_OLD_COPY_ON_WRITE
5345 else if (SvPVX_const(sv)) {
5347 /* I believe I need to grab the global SV mutex here and
5348 then recheck the COW status. */
5350 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5354 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5356 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5359 /* And drop it here. */
5361 } else if (SvLEN(sv)) {
5362 Safefree(SvPVX_const(sv));
5366 else if (SvPVX_const(sv) && SvLEN(sv))
5367 Safefree(SvPVX_mutable(sv));
5368 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5369 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5378 SvFLAGS(sv) &= SVf_BREAK;
5379 SvFLAGS(sv) |= SVTYPEMASK;
5381 if (sv_type_details->arena) {
5382 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5383 &PL_body_roots[type]);
5385 else if (sv_type_details->body_size) {
5386 my_safefree(SvANY(sv));
5391 =for apidoc sv_newref
5393 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5400 Perl_sv_newref(pTHX_ SV *sv)
5402 PERL_UNUSED_CONTEXT;
5411 Decrement an SV's reference count, and if it drops to zero, call
5412 C<sv_clear> to invoke destructors and free up any memory used by
5413 the body; finally, deallocate the SV's head itself.
5414 Normally called via a wrapper macro C<SvREFCNT_dec>.
5420 Perl_sv_free(pTHX_ SV *sv)
5425 if (SvREFCNT(sv) == 0) {
5426 if (SvFLAGS(sv) & SVf_BREAK)
5427 /* this SV's refcnt has been artificially decremented to
5428 * trigger cleanup */
5430 if (PL_in_clean_all) /* All is fair */
5432 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5433 /* make sure SvREFCNT(sv)==0 happens very seldom */
5434 SvREFCNT(sv) = (~(U32)0)/2;
5437 if (ckWARN_d(WARN_INTERNAL)) {
5438 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5439 Perl_dump_sv_child(aTHX_ sv);
5441 #ifdef DEBUG_LEAKING_SCALARS
5444 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5445 if (PL_warnhook == PERL_WARNHOOK_FATAL
5446 || ckDEAD(packWARN(WARN_INTERNAL))) {
5447 /* Don't let Perl_warner cause us to escape our fate: */
5451 /* This may not return: */
5452 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5453 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5454 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5457 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5462 if (--(SvREFCNT(sv)) > 0)
5464 Perl_sv_free2(aTHX_ sv);
5468 Perl_sv_free2(pTHX_ SV *sv)
5473 if (ckWARN_d(WARN_DEBUGGING))
5474 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5475 "Attempt to free temp prematurely: SV 0x%"UVxf
5476 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5480 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5481 /* make sure SvREFCNT(sv)==0 happens very seldom */
5482 SvREFCNT(sv) = (~(U32)0)/2;
5493 Returns the length of the string in the SV. Handles magic and type
5494 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5500 Perl_sv_len(pTHX_ register SV *sv)
5508 len = mg_length(sv);
5510 (void)SvPV_const(sv, len);
5515 =for apidoc sv_len_utf8
5517 Returns the number of characters in the string in an SV, counting wide
5518 UTF-8 bytes as a single character. Handles magic and type coercion.
5524 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5525 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5526 * (Note that the mg_len is not the length of the mg_ptr field.
5527 * This allows the cache to store the character length of the string without
5528 * needing to malloc() extra storage to attach to the mg_ptr.)
5533 Perl_sv_len_utf8(pTHX_ register SV *sv)
5539 return mg_length(sv);
5543 const U8 *s = (U8*)SvPV_const(sv, len);
5547 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5549 if (mg && mg->mg_len != -1) {
5551 if (PL_utf8cache < 0) {
5552 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5554 /* Need to turn the assertions off otherwise we may
5555 recurse infinitely while printing error messages.
5557 SAVEI8(PL_utf8cache);
5559 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5560 " real %"UVuf" for %"SVf,
5561 (UV) ulen, (UV) real, SVfARG(sv));
5566 ulen = Perl_utf8_length(aTHX_ s, s + len);
5567 if (!SvREADONLY(sv)) {
5569 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5570 &PL_vtbl_utf8, 0, 0);
5578 return Perl_utf8_length(aTHX_ s, s + len);
5582 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5585 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5588 const U8 *s = start;
5590 while (s < send && uoffset--)
5593 /* This is the existing behaviour. Possibly it should be a croak, as
5594 it's actually a bounds error */
5600 /* Given the length of the string in both bytes and UTF-8 characters, decide
5601 whether to walk forwards or backwards to find the byte corresponding to
5602 the passed in UTF-8 offset. */
5604 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5605 STRLEN uoffset, STRLEN uend)
5607 STRLEN backw = uend - uoffset;
5608 if (uoffset < 2 * backw) {
5609 /* The assumption is that going forwards is twice the speed of going
5610 forward (that's where the 2 * backw comes from).
5611 (The real figure of course depends on the UTF-8 data.) */
5612 return sv_pos_u2b_forwards(start, send, uoffset);
5617 while (UTF8_IS_CONTINUATION(*send))
5620 return send - start;
5623 /* For the string representation of the given scalar, find the byte
5624 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5625 give another position in the string, *before* the sought offset, which
5626 (which is always true, as 0, 0 is a valid pair of positions), which should
5627 help reduce the amount of linear searching.
5628 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5629 will be used to reduce the amount of linear searching. The cache will be
5630 created if necessary, and the found value offered to it for update. */
5632 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5633 const U8 *const send, STRLEN uoffset,
5634 STRLEN uoffset0, STRLEN boffset0) {
5635 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5638 assert (uoffset >= uoffset0);
5640 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5641 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5642 if ((*mgp)->mg_ptr) {
5643 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5644 if (cache[0] == uoffset) {
5645 /* An exact match. */
5648 if (cache[2] == uoffset) {
5649 /* An exact match. */
5653 if (cache[0] < uoffset) {
5654 /* The cache already knows part of the way. */
5655 if (cache[0] > uoffset0) {
5656 /* The cache knows more than the passed in pair */
5657 uoffset0 = cache[0];
5658 boffset0 = cache[1];
5660 if ((*mgp)->mg_len != -1) {
5661 /* And we know the end too. */
5663 + sv_pos_u2b_midway(start + boffset0, send,
5665 (*mgp)->mg_len - uoffset0);
5668 + sv_pos_u2b_forwards(start + boffset0,
5669 send, uoffset - uoffset0);
5672 else if (cache[2] < uoffset) {
5673 /* We're between the two cache entries. */
5674 if (cache[2] > uoffset0) {
5675 /* and the cache knows more than the passed in pair */
5676 uoffset0 = cache[2];
5677 boffset0 = cache[3];
5681 + sv_pos_u2b_midway(start + boffset0,
5684 cache[0] - uoffset0);
5687 + sv_pos_u2b_midway(start + boffset0,
5690 cache[2] - uoffset0);
5694 else if ((*mgp)->mg_len != -1) {
5695 /* If we can take advantage of a passed in offset, do so. */
5696 /* In fact, offset0 is either 0, or less than offset, so don't
5697 need to worry about the other possibility. */
5699 + sv_pos_u2b_midway(start + boffset0, send,
5701 (*mgp)->mg_len - uoffset0);
5706 if (!found || PL_utf8cache < 0) {
5707 const STRLEN real_boffset
5708 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5709 send, uoffset - uoffset0);
5711 if (found && PL_utf8cache < 0) {
5712 if (real_boffset != boffset) {
5713 /* Need to turn the assertions off otherwise we may recurse
5714 infinitely while printing error messages. */
5715 SAVEI8(PL_utf8cache);
5717 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5718 " real %"UVuf" for %"SVf,
5719 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5722 boffset = real_boffset;
5725 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5731 =for apidoc sv_pos_u2b
5733 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5734 the start of the string, to a count of the equivalent number of bytes; if
5735 lenp is non-zero, it does the same to lenp, but this time starting from
5736 the offset, rather than from the start of the string. Handles magic and
5743 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5744 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5745 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5750 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5758 start = (U8*)SvPV_const(sv, len);
5760 STRLEN uoffset = (STRLEN) *offsetp;
5761 const U8 * const send = start + len;
5763 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5766 *offsetp = (I32) boffset;
5769 /* Convert the relative offset to absolute. */
5770 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5771 const STRLEN boffset2
5772 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5773 uoffset, boffset) - boffset;
5787 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5788 byte length pairing. The (byte) length of the total SV is passed in too,
5789 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5790 may not have updated SvCUR, so we can't rely on reading it directly.
5792 The proffered utf8/byte length pairing isn't used if the cache already has
5793 two pairs, and swapping either for the proffered pair would increase the
5794 RMS of the intervals between known byte offsets.
5796 The cache itself consists of 4 STRLEN values
5797 0: larger UTF-8 offset
5798 1: corresponding byte offset
5799 2: smaller UTF-8 offset
5800 3: corresponding byte offset
5802 Unused cache pairs have the value 0, 0.
5803 Keeping the cache "backwards" means that the invariant of
5804 cache[0] >= cache[2] is maintained even with empty slots, which means that
5805 the code that uses it doesn't need to worry if only 1 entry has actually
5806 been set to non-zero. It also makes the "position beyond the end of the
5807 cache" logic much simpler, as the first slot is always the one to start
5811 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5819 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5821 (*mgp)->mg_len = -1;
5825 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5826 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5827 (*mgp)->mg_ptr = (char *) cache;
5831 if (PL_utf8cache < 0) {
5832 const U8 *start = (const U8 *) SvPVX_const(sv);
5833 const STRLEN realutf8 = utf8_length(start, start + byte);
5835 if (realutf8 != utf8) {
5836 /* Need to turn the assertions off otherwise we may recurse
5837 infinitely while printing error messages. */
5838 SAVEI8(PL_utf8cache);
5840 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5841 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5845 /* Cache is held with the later position first, to simplify the code
5846 that deals with unbounded ends. */
5848 ASSERT_UTF8_CACHE(cache);
5849 if (cache[1] == 0) {
5850 /* Cache is totally empty */
5853 } else if (cache[3] == 0) {
5854 if (byte > cache[1]) {
5855 /* New one is larger, so goes first. */
5856 cache[2] = cache[0];
5857 cache[3] = cache[1];
5865 #define THREEWAY_SQUARE(a,b,c,d) \
5866 ((float)((d) - (c))) * ((float)((d) - (c))) \
5867 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5868 + ((float)((b) - (a))) * ((float)((b) - (a)))
5870 /* Cache has 2 slots in use, and we know three potential pairs.
5871 Keep the two that give the lowest RMS distance. Do the
5872 calcualation in bytes simply because we always know the byte
5873 length. squareroot has the same ordering as the positive value,
5874 so don't bother with the actual square root. */
5875 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5876 if (byte > cache[1]) {
5877 /* New position is after the existing pair of pairs. */
5878 const float keep_earlier
5879 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5880 const float keep_later
5881 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5883 if (keep_later < keep_earlier) {
5884 if (keep_later < existing) {
5885 cache[2] = cache[0];
5886 cache[3] = cache[1];
5892 if (keep_earlier < existing) {
5898 else if (byte > cache[3]) {
5899 /* New position is between the existing pair of pairs. */
5900 const float keep_earlier
5901 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5902 const float keep_later
5903 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5905 if (keep_later < keep_earlier) {
5906 if (keep_later < existing) {
5912 if (keep_earlier < existing) {
5919 /* New position is before the existing pair of pairs. */
5920 const float keep_earlier
5921 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5922 const float keep_later
5923 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5925 if (keep_later < keep_earlier) {
5926 if (keep_later < existing) {
5932 if (keep_earlier < existing) {
5933 cache[0] = cache[2];
5934 cache[1] = cache[3];
5941 ASSERT_UTF8_CACHE(cache);
5944 /* We already know all of the way, now we may be able to walk back. The same
5945 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5946 backward is half the speed of walking forward. */
5948 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5951 const STRLEN forw = target - s;
5952 STRLEN backw = end - target;
5954 if (forw < 2 * backw) {
5955 return utf8_length(s, target);
5958 while (end > target) {
5960 while (UTF8_IS_CONTINUATION(*end)) {
5969 =for apidoc sv_pos_b2u
5971 Converts the value pointed to by offsetp from a count of bytes from the
5972 start of the string, to a count of the equivalent number of UTF-8 chars.
5973 Handles magic and type coercion.
5979 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5980 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5985 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5988 const STRLEN byte = *offsetp;
5989 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5998 s = (const U8*)SvPV_const(sv, blen);
6001 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6005 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6006 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6008 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6009 if (cache[1] == byte) {
6010 /* An exact match. */
6011 *offsetp = cache[0];
6014 if (cache[3] == byte) {
6015 /* An exact match. */
6016 *offsetp = cache[2];
6020 if (cache[1] < byte) {
6021 /* We already know part of the way. */
6022 if (mg->mg_len != -1) {
6023 /* Actually, we know the end too. */
6025 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6026 s + blen, mg->mg_len - cache[0]);
6028 len = cache[0] + utf8_length(s + cache[1], send);
6031 else if (cache[3] < byte) {
6032 /* We're between the two cached pairs, so we do the calculation
6033 offset by the byte/utf-8 positions for the earlier pair,
6034 then add the utf-8 characters from the string start to
6036 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6037 s + cache[1], cache[0] - cache[2])
6041 else { /* cache[3] > byte */
6042 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6046 ASSERT_UTF8_CACHE(cache);
6048 } else if (mg->mg_len != -1) {
6049 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6053 if (!found || PL_utf8cache < 0) {
6054 const STRLEN real_len = utf8_length(s, send);
6056 if (found && PL_utf8cache < 0) {
6057 if (len != real_len) {
6058 /* Need to turn the assertions off otherwise we may recurse
6059 infinitely while printing error messages. */
6060 SAVEI8(PL_utf8cache);
6062 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6063 " real %"UVuf" for %"SVf,
6064 (UV) len, (UV) real_len, SVfARG(sv));
6071 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6077 Returns a boolean indicating whether the strings in the two SVs are
6078 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6079 coerce its args to strings if necessary.
6085 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6094 SV* svrecode = NULL;
6101 /* if pv1 and pv2 are the same, second SvPV_const call may
6102 * invalidate pv1, so we may need to make a copy */
6103 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6104 pv1 = SvPV_const(sv1, cur1);
6105 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6107 pv1 = SvPV_const(sv1, cur1);
6115 pv2 = SvPV_const(sv2, cur2);
6117 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6118 /* Differing utf8ness.
6119 * Do not UTF8size the comparands as a side-effect. */
6122 svrecode = newSVpvn(pv2, cur2);
6123 sv_recode_to_utf8(svrecode, PL_encoding);
6124 pv2 = SvPV_const(svrecode, cur2);
6127 svrecode = newSVpvn(pv1, cur1);
6128 sv_recode_to_utf8(svrecode, PL_encoding);
6129 pv1 = SvPV_const(svrecode, cur1);
6131 /* Now both are in UTF-8. */
6133 SvREFCNT_dec(svrecode);
6138 bool is_utf8 = TRUE;
6141 /* sv1 is the UTF-8 one,
6142 * if is equal it must be downgrade-able */
6143 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6149 /* sv2 is the UTF-8 one,
6150 * if is equal it must be downgrade-able */
6151 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6157 /* Downgrade not possible - cannot be eq */
6165 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6167 SvREFCNT_dec(svrecode);
6177 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6178 string in C<sv1> is less than, equal to, or greater than the string in
6179 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6180 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6186 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6190 const char *pv1, *pv2;
6193 SV *svrecode = NULL;
6200 pv1 = SvPV_const(sv1, cur1);
6207 pv2 = SvPV_const(sv2, cur2);
6209 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6210 /* Differing utf8ness.
6211 * Do not UTF8size the comparands as a side-effect. */
6214 svrecode = newSVpvn(pv2, cur2);
6215 sv_recode_to_utf8(svrecode, PL_encoding);
6216 pv2 = SvPV_const(svrecode, cur2);
6219 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6224 svrecode = newSVpvn(pv1, cur1);
6225 sv_recode_to_utf8(svrecode, PL_encoding);
6226 pv1 = SvPV_const(svrecode, cur1);
6229 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6235 cmp = cur2 ? -1 : 0;
6239 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6242 cmp = retval < 0 ? -1 : 1;
6243 } else if (cur1 == cur2) {
6246 cmp = cur1 < cur2 ? -1 : 1;
6250 SvREFCNT_dec(svrecode);
6258 =for apidoc sv_cmp_locale
6260 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6261 'use bytes' aware, handles get magic, and will coerce its args to strings
6262 if necessary. See also C<sv_cmp>.
6268 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6271 #ifdef USE_LOCALE_COLLATE
6277 if (PL_collation_standard)
6281 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6283 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6285 if (!pv1 || !len1) {
6296 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6299 return retval < 0 ? -1 : 1;
6302 * When the result of collation is equality, that doesn't mean
6303 * that there are no differences -- some locales exclude some
6304 * characters from consideration. So to avoid false equalities,
6305 * we use the raw string as a tiebreaker.
6311 #endif /* USE_LOCALE_COLLATE */
6313 return sv_cmp(sv1, sv2);
6317 #ifdef USE_LOCALE_COLLATE
6320 =for apidoc sv_collxfrm
6322 Add Collate Transform magic to an SV if it doesn't already have it.
6324 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6325 scalar data of the variable, but transformed to such a format that a normal
6326 memory comparison can be used to compare the data according to the locale
6333 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6338 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6339 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6345 Safefree(mg->mg_ptr);
6346 s = SvPV_const(sv, len);
6347 if ((xf = mem_collxfrm(s, len, &xlen))) {
6348 if (SvREADONLY(sv)) {
6351 return xf + sizeof(PL_collation_ix);
6354 #ifdef PERL_OLD_COPY_ON_WRITE
6356 sv_force_normal_flags(sv, 0);
6358 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6372 if (mg && mg->mg_ptr) {
6374 return mg->mg_ptr + sizeof(PL_collation_ix);
6382 #endif /* USE_LOCALE_COLLATE */
6387 Get a line from the filehandle and store it into the SV, optionally
6388 appending to the currently-stored string.
6394 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6399 register STDCHAR rslast;
6400 register STDCHAR *bp;
6405 if (SvTHINKFIRST(sv))
6406 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6407 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6409 However, perlbench says it's slower, because the existing swipe code
6410 is faster than copy on write.
6411 Swings and roundabouts. */
6412 SvUPGRADE(sv, SVt_PV);
6417 if (PerlIO_isutf8(fp)) {
6419 sv_utf8_upgrade_nomg(sv);
6420 sv_pos_u2b(sv,&append,0);
6422 } else if (SvUTF8(sv)) {
6423 SV * const tsv = newSV(0);
6424 sv_gets(tsv, fp, 0);
6425 sv_utf8_upgrade_nomg(tsv);
6426 SvCUR_set(sv,append);
6429 goto return_string_or_null;
6434 if (PerlIO_isutf8(fp))
6437 if (IN_PERL_COMPILETIME) {
6438 /* we always read code in line mode */
6442 else if (RsSNARF(PL_rs)) {
6443 /* If it is a regular disk file use size from stat() as estimate
6444 of amount we are going to read -- may result in mallocing
6445 more memory than we really need if the layers below reduce
6446 the size we read (e.g. CRLF or a gzip layer).
6449 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6450 const Off_t offset = PerlIO_tell(fp);
6451 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6452 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6458 else if (RsRECORD(PL_rs)) {
6463 /* Grab the size of the record we're getting */
6464 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6465 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6468 /* VMS wants read instead of fread, because fread doesn't respect */
6469 /* RMS record boundaries. This is not necessarily a good thing to be */
6470 /* doing, but we've got no other real choice - except avoid stdio
6471 as implementation - perhaps write a :vms layer ?
6473 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6475 bytesread = PerlIO_read(fp, buffer, recsize);
6479 SvCUR_set(sv, bytesread += append);
6480 buffer[bytesread] = '\0';
6481 goto return_string_or_null;
6483 else if (RsPARA(PL_rs)) {
6489 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6490 if (PerlIO_isutf8(fp)) {
6491 rsptr = SvPVutf8(PL_rs, rslen);
6494 if (SvUTF8(PL_rs)) {
6495 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6496 Perl_croak(aTHX_ "Wide character in $/");
6499 rsptr = SvPV_const(PL_rs, rslen);
6503 rslast = rslen ? rsptr[rslen - 1] : '\0';
6505 if (rspara) { /* have to do this both before and after */
6506 do { /* to make sure file boundaries work right */
6509 i = PerlIO_getc(fp);
6513 PerlIO_ungetc(fp,i);
6519 /* See if we know enough about I/O mechanism to cheat it ! */
6521 /* This used to be #ifdef test - it is made run-time test for ease
6522 of abstracting out stdio interface. One call should be cheap
6523 enough here - and may even be a macro allowing compile
6527 if (PerlIO_fast_gets(fp)) {
6530 * We're going to steal some values from the stdio struct
6531 * and put EVERYTHING in the innermost loop into registers.
6533 register STDCHAR *ptr;
6537 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6538 /* An ungetc()d char is handled separately from the regular
6539 * buffer, so we getc() it back out and stuff it in the buffer.
6541 i = PerlIO_getc(fp);
6542 if (i == EOF) return 0;
6543 *(--((*fp)->_ptr)) = (unsigned char) i;
6547 /* Here is some breathtakingly efficient cheating */
6549 cnt = PerlIO_get_cnt(fp); /* get count into register */
6550 /* make sure we have the room */
6551 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6552 /* Not room for all of it
6553 if we are looking for a separator and room for some
6555 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6556 /* just process what we have room for */
6557 shortbuffered = cnt - SvLEN(sv) + append + 1;
6558 cnt -= shortbuffered;
6562 /* remember that cnt can be negative */
6563 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6568 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6569 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6570 DEBUG_P(PerlIO_printf(Perl_debug_log,
6571 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6572 DEBUG_P(PerlIO_printf(Perl_debug_log,
6573 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6574 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6575 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6580 while (cnt > 0) { /* this | eat */
6582 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6583 goto thats_all_folks; /* screams | sed :-) */
6587 Copy(ptr, bp, cnt, char); /* this | eat */
6588 bp += cnt; /* screams | dust */
6589 ptr += cnt; /* louder | sed :-) */
6594 if (shortbuffered) { /* oh well, must extend */
6595 cnt = shortbuffered;
6597 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6599 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6600 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6604 DEBUG_P(PerlIO_printf(Perl_debug_log,
6605 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6606 PTR2UV(ptr),(long)cnt));
6607 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6609 DEBUG_P(PerlIO_printf(Perl_debug_log,
6610 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6611 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6612 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6614 /* This used to call 'filbuf' in stdio form, but as that behaves like
6615 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6616 another abstraction. */
6617 i = PerlIO_getc(fp); /* get more characters */
6619 DEBUG_P(PerlIO_printf(Perl_debug_log,
6620 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6621 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6622 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6624 cnt = PerlIO_get_cnt(fp);
6625 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6626 DEBUG_P(PerlIO_printf(Perl_debug_log,
6627 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6629 if (i == EOF) /* all done for ever? */
6630 goto thats_really_all_folks;
6632 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6634 SvGROW(sv, bpx + cnt + 2);
6635 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6637 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6639 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6640 goto thats_all_folks;
6644 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6645 memNE((char*)bp - rslen, rsptr, rslen))
6646 goto screamer; /* go back to the fray */
6647 thats_really_all_folks:
6649 cnt += shortbuffered;
6650 DEBUG_P(PerlIO_printf(Perl_debug_log,
6651 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6652 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6653 DEBUG_P(PerlIO_printf(Perl_debug_log,
6654 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6655 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6656 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6658 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6659 DEBUG_P(PerlIO_printf(Perl_debug_log,
6660 "Screamer: done, len=%ld, string=|%.*s|\n",
6661 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6665 /*The big, slow, and stupid way. */
6666 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6667 STDCHAR *buf = NULL;
6668 Newx(buf, 8192, STDCHAR);
6676 register const STDCHAR * const bpe = buf + sizeof(buf);
6678 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6679 ; /* keep reading */
6683 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6684 /* Accomodate broken VAXC compiler, which applies U8 cast to
6685 * both args of ?: operator, causing EOF to change into 255
6688 i = (U8)buf[cnt - 1];
6694 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6696 sv_catpvn(sv, (char *) buf, cnt);
6698 sv_setpvn(sv, (char *) buf, cnt);
6700 if (i != EOF && /* joy */
6702 SvCUR(sv) < rslen ||
6703 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6707 * If we're reading from a TTY and we get a short read,
6708 * indicating that the user hit his EOF character, we need
6709 * to notice it now, because if we try to read from the TTY
6710 * again, the EOF condition will disappear.
6712 * The comparison of cnt to sizeof(buf) is an optimization
6713 * that prevents unnecessary calls to feof().
6717 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6721 #ifdef USE_HEAP_INSTEAD_OF_STACK
6726 if (rspara) { /* have to do this both before and after */
6727 while (i != EOF) { /* to make sure file boundaries work right */
6728 i = PerlIO_getc(fp);
6730 PerlIO_ungetc(fp,i);
6736 return_string_or_null:
6737 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6743 Auto-increment of the value in the SV, doing string to numeric conversion
6744 if necessary. Handles 'get' magic.
6750 Perl_sv_inc(pTHX_ register SV *sv)
6759 if (SvTHINKFIRST(sv)) {
6761 sv_force_normal_flags(sv, 0);
6762 if (SvREADONLY(sv)) {
6763 if (IN_PERL_RUNTIME)
6764 Perl_croak(aTHX_ PL_no_modify);
6768 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6770 i = PTR2IV(SvRV(sv));
6775 flags = SvFLAGS(sv);
6776 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6777 /* It's (privately or publicly) a float, but not tested as an
6778 integer, so test it to see. */
6780 flags = SvFLAGS(sv);
6782 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6783 /* It's publicly an integer, or privately an integer-not-float */
6784 #ifdef PERL_PRESERVE_IVUV
6788 if (SvUVX(sv) == UV_MAX)
6789 sv_setnv(sv, UV_MAX_P1);
6791 (void)SvIOK_only_UV(sv);
6792 SvUV_set(sv, SvUVX(sv) + 1);
6794 if (SvIVX(sv) == IV_MAX)
6795 sv_setuv(sv, (UV)IV_MAX + 1);
6797 (void)SvIOK_only(sv);
6798 SvIV_set(sv, SvIVX(sv) + 1);
6803 if (flags & SVp_NOK) {
6804 const NV was = SvNVX(sv);
6805 if (NV_OVERFLOWS_INTEGERS_AT &&
6806 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6807 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6808 "Lost precision when incrementing %" NVff " by 1",
6811 (void)SvNOK_only(sv);
6812 SvNV_set(sv, was + 1.0);
6816 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6817 if ((flags & SVTYPEMASK) < SVt_PVIV)
6818 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6819 (void)SvIOK_only(sv);
6824 while (isALPHA(*d)) d++;
6825 while (isDIGIT(*d)) d++;
6827 #ifdef PERL_PRESERVE_IVUV
6828 /* Got to punt this as an integer if needs be, but we don't issue
6829 warnings. Probably ought to make the sv_iv_please() that does
6830 the conversion if possible, and silently. */
6831 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6832 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6833 /* Need to try really hard to see if it's an integer.
6834 9.22337203685478e+18 is an integer.
6835 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6836 so $a="9.22337203685478e+18"; $a+0; $a++
6837 needs to be the same as $a="9.22337203685478e+18"; $a++
6844 /* sv_2iv *should* have made this an NV */
6845 if (flags & SVp_NOK) {
6846 (void)SvNOK_only(sv);
6847 SvNV_set(sv, SvNVX(sv) + 1.0);
6850 /* I don't think we can get here. Maybe I should assert this
6851 And if we do get here I suspect that sv_setnv will croak. NWC
6853 #if defined(USE_LONG_DOUBLE)
6854 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",
6855 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6857 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6858 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6861 #endif /* PERL_PRESERVE_IVUV */
6862 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6866 while (d >= SvPVX_const(sv)) {
6874 /* MKS: The original code here died if letters weren't consecutive.
6875 * at least it didn't have to worry about non-C locales. The
6876 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6877 * arranged in order (although not consecutively) and that only
6878 * [A-Za-z] are accepted by isALPHA in the C locale.
6880 if (*d != 'z' && *d != 'Z') {
6881 do { ++*d; } while (!isALPHA(*d));
6884 *(d--) -= 'z' - 'a';
6889 *(d--) -= 'z' - 'a' + 1;
6893 /* oh,oh, the number grew */
6894 SvGROW(sv, SvCUR(sv) + 2);
6895 SvCUR_set(sv, SvCUR(sv) + 1);
6896 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6907 Auto-decrement of the value in the SV, doing string to numeric conversion
6908 if necessary. Handles 'get' magic.
6914 Perl_sv_dec(pTHX_ register SV *sv)
6922 if (SvTHINKFIRST(sv)) {
6924 sv_force_normal_flags(sv, 0);
6925 if (SvREADONLY(sv)) {
6926 if (IN_PERL_RUNTIME)
6927 Perl_croak(aTHX_ PL_no_modify);
6931 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6933 i = PTR2IV(SvRV(sv));
6938 /* Unlike sv_inc we don't have to worry about string-never-numbers
6939 and keeping them magic. But we mustn't warn on punting */
6940 flags = SvFLAGS(sv);
6941 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6942 /* It's publicly an integer, or privately an integer-not-float */
6943 #ifdef PERL_PRESERVE_IVUV
6947 if (SvUVX(sv) == 0) {
6948 (void)SvIOK_only(sv);
6952 (void)SvIOK_only_UV(sv);
6953 SvUV_set(sv, SvUVX(sv) - 1);
6956 if (SvIVX(sv) == IV_MIN) {
6957 sv_setnv(sv, (NV)IV_MIN);
6961 (void)SvIOK_only(sv);
6962 SvIV_set(sv, SvIVX(sv) - 1);
6967 if (flags & SVp_NOK) {
6970 const NV was = SvNVX(sv);
6971 if (NV_OVERFLOWS_INTEGERS_AT &&
6972 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6973 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6974 "Lost precision when decrementing %" NVff " by 1",
6977 (void)SvNOK_only(sv);
6978 SvNV_set(sv, was - 1.0);
6982 if (!(flags & SVp_POK)) {
6983 if ((flags & SVTYPEMASK) < SVt_PVIV)
6984 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6986 (void)SvIOK_only(sv);
6989 #ifdef PERL_PRESERVE_IVUV
6991 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6992 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6993 /* Need to try really hard to see if it's an integer.
6994 9.22337203685478e+18 is an integer.
6995 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6996 so $a="9.22337203685478e+18"; $a+0; $a--
6997 needs to be the same as $a="9.22337203685478e+18"; $a--
7004 /* sv_2iv *should* have made this an NV */
7005 if (flags & SVp_NOK) {
7006 (void)SvNOK_only(sv);
7007 SvNV_set(sv, SvNVX(sv) - 1.0);
7010 /* I don't think we can get here. Maybe I should assert this
7011 And if we do get here I suspect that sv_setnv will croak. NWC
7013 #if defined(USE_LONG_DOUBLE)
7014 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",
7015 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7017 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7018 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7022 #endif /* PERL_PRESERVE_IVUV */
7023 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7027 =for apidoc sv_mortalcopy
7029 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7030 The new SV is marked as mortal. It will be destroyed "soon", either by an
7031 explicit call to FREETMPS, or by an implicit call at places such as
7032 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7037 /* Make a string that will exist for the duration of the expression
7038 * evaluation. Actually, it may have to last longer than that, but
7039 * hopefully we won't free it until it has been assigned to a
7040 * permanent location. */
7043 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7049 sv_setsv(sv,oldstr);
7051 PL_tmps_stack[++PL_tmps_ix] = sv;
7057 =for apidoc sv_newmortal
7059 Creates a new null SV which is mortal. The reference count of the SV is
7060 set to 1. It will be destroyed "soon", either by an explicit call to
7061 FREETMPS, or by an implicit call at places such as statement boundaries.
7062 See also C<sv_mortalcopy> and C<sv_2mortal>.
7068 Perl_sv_newmortal(pTHX)
7074 SvFLAGS(sv) = SVs_TEMP;
7076 PL_tmps_stack[++PL_tmps_ix] = sv;
7082 =for apidoc newSVpvn_flags
7084 Creates a new SV and copies a string into it. The reference count for the
7085 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7086 string. You are responsible for ensuring that the source string is at least
7087 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7088 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7089 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7090 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7091 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7093 #define newSVpvn_utf8(s, len, u) \
7094 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7100 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7105 /* All the flags we don't support must be zero.
7106 And we're new code so I'm going to assert this from the start. */
7107 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7109 sv_setpvn(sv,s,len);
7110 SvFLAGS(sv) |= (flags & SVf_UTF8);
7111 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7115 =for apidoc sv_2mortal
7117 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7118 by an explicit call to FREETMPS, or by an implicit call at places such as
7119 statement boundaries. SvTEMP() is turned on which means that the SV's
7120 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7121 and C<sv_mortalcopy>.
7127 Perl_sv_2mortal(pTHX_ register SV *sv)
7132 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7135 PL_tmps_stack[++PL_tmps_ix] = sv;
7143 Creates a new SV and copies a string into it. The reference count for the
7144 SV is set to 1. If C<len> is zero, Perl will compute the length using
7145 strlen(). For efficiency, consider using C<newSVpvn> instead.
7151 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7157 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7162 =for apidoc newSVpvn
7164 Creates a new SV and copies a string into it. The reference count for the
7165 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7166 string. You are responsible for ensuring that the source string is at least
7167 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7173 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7179 sv_setpvn(sv,s,len);
7184 =for apidoc newSVhek
7186 Creates a new SV from the hash key structure. It will generate scalars that
7187 point to the shared string table where possible. Returns a new (undefined)
7188 SV if the hek is NULL.
7194 Perl_newSVhek(pTHX_ const HEK *hek)
7204 if (HEK_LEN(hek) == HEf_SVKEY) {
7205 return newSVsv(*(SV**)HEK_KEY(hek));
7207 const int flags = HEK_FLAGS(hek);
7208 if (flags & HVhek_WASUTF8) {
7210 Andreas would like keys he put in as utf8 to come back as utf8
7212 STRLEN utf8_len = HEK_LEN(hek);
7213 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7214 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7217 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7219 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7220 /* We don't have a pointer to the hv, so we have to replicate the
7221 flag into every HEK. This hv is using custom a hasing
7222 algorithm. Hence we can't return a shared string scalar, as
7223 that would contain the (wrong) hash value, and might get passed
7224 into an hv routine with a regular hash.
7225 Similarly, a hash that isn't using shared hash keys has to have
7226 the flag in every key so that we know not to try to call
7227 share_hek_kek on it. */
7229 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7234 /* This will be overwhelminly the most common case. */
7236 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7237 more efficient than sharepvn(). */
7241 sv_upgrade(sv, SVt_PV);
7242 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7243 SvCUR_set(sv, HEK_LEN(hek));
7256 =for apidoc newSVpvn_share
7258 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7259 table. If the string does not already exist in the table, it is created
7260 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7261 value is used; otherwise the hash is computed. The string's hash can be later
7262 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7263 that as the string table is used for shared hash keys these strings will have
7264 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7270 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7274 bool is_utf8 = FALSE;
7275 const char *const orig_src = src;
7278 STRLEN tmplen = -len;
7280 /* See the note in hv.c:hv_fetch() --jhi */
7281 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7285 PERL_HASH(hash, src, len);
7287 sv_upgrade(sv, SVt_PV);
7288 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7296 if (src != orig_src)
7302 #if defined(PERL_IMPLICIT_CONTEXT)
7304 /* pTHX_ magic can't cope with varargs, so this is a no-context
7305 * version of the main function, (which may itself be aliased to us).
7306 * Don't access this version directly.
7310 Perl_newSVpvf_nocontext(const char* pat, ...)
7315 va_start(args, pat);
7316 sv = vnewSVpvf(pat, &args);
7323 =for apidoc newSVpvf
7325 Creates a new SV and initializes it with the string formatted like
7332 Perl_newSVpvf(pTHX_ const char* pat, ...)
7336 va_start(args, pat);
7337 sv = vnewSVpvf(pat, &args);
7342 /* backend for newSVpvf() and newSVpvf_nocontext() */
7345 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7350 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7357 Creates a new SV and copies a floating point value into it.
7358 The reference count for the SV is set to 1.
7364 Perl_newSVnv(pTHX_ NV n)
7377 Creates a new SV and copies an integer into it. The reference count for the
7384 Perl_newSViv(pTHX_ IV i)
7397 Creates a new SV and copies an unsigned integer into it.
7398 The reference count for the SV is set to 1.
7404 Perl_newSVuv(pTHX_ UV u)
7415 =for apidoc newSV_type
7417 Creates a new SV, of the type specified. The reference count for the new SV
7424 Perl_newSV_type(pTHX_ svtype type)
7429 sv_upgrade(sv, type);
7434 =for apidoc newRV_noinc
7436 Creates an RV wrapper for an SV. The reference count for the original
7437 SV is B<not> incremented.
7443 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7446 register SV *sv = newSV_type(SVt_IV);
7448 SvRV_set(sv, tmpRef);
7453 /* newRV_inc is the official function name to use now.
7454 * newRV_inc is in fact #defined to newRV in sv.h
7458 Perl_newRV(pTHX_ SV *sv)
7461 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7467 Creates a new SV which is an exact duplicate of the original SV.
7474 Perl_newSVsv(pTHX_ register SV *old)
7481 if (SvTYPE(old) == SVTYPEMASK) {
7482 if (ckWARN_d(WARN_INTERNAL))
7483 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7487 /* SV_GMAGIC is the default for sv_setv()
7488 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7489 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7490 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7495 =for apidoc sv_reset
7497 Underlying implementation for the C<reset> Perl function.
7498 Note that the perl-level function is vaguely deprecated.
7504 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7507 char todo[PERL_UCHAR_MAX+1];
7512 if (!*s) { /* reset ?? searches */
7513 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7515 const U32 count = mg->mg_len / sizeof(PMOP**);
7516 PMOP **pmp = (PMOP**) mg->mg_ptr;
7517 PMOP *const *const end = pmp + count;
7521 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7523 (*pmp)->op_pmflags &= ~PMf_USED;
7531 /* reset variables */
7533 if (!HvARRAY(stash))
7536 Zero(todo, 256, char);
7539 I32 i = (unsigned char)*s;
7543 max = (unsigned char)*s++;
7544 for ( ; i <= max; i++) {
7547 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7549 for (entry = HvARRAY(stash)[i];
7551 entry = HeNEXT(entry))
7556 if (!todo[(U8)*HeKEY(entry)])
7558 gv = (GV*)HeVAL(entry);
7561 if (SvTHINKFIRST(sv)) {
7562 if (!SvREADONLY(sv) && SvROK(sv))
7564 /* XXX Is this continue a bug? Why should THINKFIRST
7565 exempt us from resetting arrays and hashes? */
7569 if (SvTYPE(sv) >= SVt_PV) {
7571 if (SvPVX_const(sv) != NULL)
7579 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7581 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7584 # if defined(USE_ENVIRON_ARRAY)
7587 # endif /* USE_ENVIRON_ARRAY */
7598 Using various gambits, try to get an IO from an SV: the IO slot if its a
7599 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7600 named after the PV if we're a string.
7606 Perl_sv_2io(pTHX_ SV *sv)
7611 switch (SvTYPE(sv)) {
7619 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7623 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7625 return sv_2io(SvRV(sv));
7626 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7632 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7641 Using various gambits, try to get a CV from an SV; in addition, try if
7642 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7643 The flags in C<lref> are passed to sv_fetchsv.
7649 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7660 switch (SvTYPE(sv)) {
7679 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7680 tryAMAGICunDEREF(to_cv);
7683 if (SvTYPE(sv) == SVt_PVCV) {
7692 Perl_croak(aTHX_ "Not a subroutine reference");
7697 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7703 /* Some flags to gv_fetchsv mean don't really create the GV */
7704 if (SvTYPE(gv) != SVt_PVGV) {
7710 if (lref && !GvCVu(gv)) {
7714 gv_efullname3(tmpsv, gv, NULL);
7715 /* XXX this is probably not what they think they're getting.
7716 * It has the same effect as "sub name;", i.e. just a forward
7718 newSUB(start_subparse(FALSE, 0),
7719 newSVOP(OP_CONST, 0, tmpsv),
7723 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7733 Returns true if the SV has a true value by Perl's rules.
7734 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7735 instead use an in-line version.
7741 Perl_sv_true(pTHX_ register SV *sv)
7746 register const XPV* const tXpv = (XPV*)SvANY(sv);
7748 (tXpv->xpv_cur > 1 ||
7749 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7756 return SvIVX(sv) != 0;
7759 return SvNVX(sv) != 0.0;
7761 return sv_2bool(sv);
7767 =for apidoc sv_pvn_force
7769 Get a sensible string out of the SV somehow.
7770 A private implementation of the C<SvPV_force> macro for compilers which
7771 can't cope with complex macro expressions. Always use the macro instead.
7773 =for apidoc sv_pvn_force_flags
7775 Get a sensible string out of the SV somehow.
7776 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7777 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7778 implemented in terms of this function.
7779 You normally want to use the various wrapper macros instead: see
7780 C<SvPV_force> and C<SvPV_force_nomg>
7786 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7789 if (SvTHINKFIRST(sv) && !SvROK(sv))
7790 sv_force_normal_flags(sv, 0);
7800 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7801 const char * const ref = sv_reftype(sv,0);
7803 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7804 ref, OP_NAME(PL_op));
7806 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7808 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7809 || isGV_with_GP(sv))
7810 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7812 s = sv_2pv_flags(sv, &len, flags);
7816 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7819 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7820 SvGROW(sv, len + 1);
7821 Move(s,SvPVX(sv),len,char);
7823 SvPVX(sv)[len] = '\0';
7826 SvPOK_on(sv); /* validate pointer */
7828 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7829 PTR2UV(sv),SvPVX_const(sv)));
7832 return SvPVX_mutable(sv);
7836 =for apidoc sv_pvbyten_force
7838 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7844 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7846 sv_pvn_force(sv,lp);
7847 sv_utf8_downgrade(sv,0);
7853 =for apidoc sv_pvutf8n_force
7855 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7861 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7863 sv_pvn_force(sv,lp);
7864 sv_utf8_upgrade(sv);
7870 =for apidoc sv_reftype
7872 Returns a string describing what the SV is a reference to.
7878 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7880 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7881 inside return suggests a const propagation bug in g++. */
7882 if (ob && SvOBJECT(sv)) {
7883 char * const name = HvNAME_get(SvSTASH(sv));
7884 return name ? name : (char *) "__ANON__";
7887 switch (SvTYPE(sv)) {
7902 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7903 /* tied lvalues should appear to be
7904 * scalars for backwards compatitbility */
7905 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7906 ? "SCALAR" : "LVALUE");
7907 case SVt_PVAV: return "ARRAY";
7908 case SVt_PVHV: return "HASH";
7909 case SVt_PVCV: return "CODE";
7910 case SVt_PVGV: return "GLOB";
7911 case SVt_PVFM: return "FORMAT";
7912 case SVt_PVIO: return "IO";
7913 case SVt_BIND: return "BIND";
7914 case SVt_REGEXP: return "REGEXP";
7915 default: return "UNKNOWN";
7921 =for apidoc sv_isobject
7923 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7924 object. If the SV is not an RV, or if the object is not blessed, then this
7931 Perl_sv_isobject(pTHX_ SV *sv)
7947 Returns a boolean indicating whether the SV is blessed into the specified
7948 class. This does not check for subtypes; use C<sv_derived_from> to verify
7949 an inheritance relationship.
7955 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7966 hvname = HvNAME_get(SvSTASH(sv));
7970 return strEQ(hvname, name);
7976 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7977 it will be upgraded to one. If C<classname> is non-null then the new SV will
7978 be blessed in the specified package. The new SV is returned and its
7979 reference count is 1.
7985 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7992 SV_CHECK_THINKFIRST_COW_DROP(rv);
7993 (void)SvAMAGIC_off(rv);
7995 if (SvTYPE(rv) >= SVt_PVMG) {
7996 const U32 refcnt = SvREFCNT(rv);
8000 SvREFCNT(rv) = refcnt;
8002 sv_upgrade(rv, SVt_IV);
8003 } else if (SvROK(rv)) {
8004 SvREFCNT_dec(SvRV(rv));
8006 prepare_SV_for_RV(rv);
8014 HV* const stash = gv_stashpv(classname, GV_ADD);
8015 (void)sv_bless(rv, stash);
8021 =for apidoc sv_setref_pv
8023 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8024 argument will be upgraded to an RV. That RV will be modified to point to
8025 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8026 into the SV. The C<classname> argument indicates the package for the
8027 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8028 will have a reference count of 1, and the RV will be returned.
8030 Do not use with other Perl types such as HV, AV, SV, CV, because those
8031 objects will become corrupted by the pointer copy process.
8033 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8039 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8043 sv_setsv(rv, &PL_sv_undef);
8047 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8052 =for apidoc sv_setref_iv
8054 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8055 argument will be upgraded to an RV. That RV will be modified to point to
8056 the new SV. The C<classname> argument indicates the package for the
8057 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8058 will have a reference count of 1, and the RV will be returned.
8064 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8066 sv_setiv(newSVrv(rv,classname), iv);
8071 =for apidoc sv_setref_uv
8073 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8074 argument will be upgraded to an RV. That RV will be modified to point to
8075 the new SV. The C<classname> argument indicates the package for the
8076 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8077 will have a reference count of 1, and the RV will be returned.
8083 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8085 sv_setuv(newSVrv(rv,classname), uv);
8090 =for apidoc sv_setref_nv
8092 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8093 argument will be upgraded to an RV. That RV will be modified to point to
8094 the new SV. The C<classname> argument indicates the package for the
8095 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8096 will have a reference count of 1, and the RV will be returned.
8102 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8104 sv_setnv(newSVrv(rv,classname), nv);
8109 =for apidoc sv_setref_pvn
8111 Copies a string into a new SV, optionally blessing the SV. The length of the
8112 string must be specified with C<n>. The C<rv> argument will be upgraded to
8113 an RV. That RV will be modified to point to the new SV. The C<classname>
8114 argument indicates the package for the blessing. Set C<classname> to
8115 C<NULL> to avoid the blessing. The new SV will have a reference count
8116 of 1, and the RV will be returned.
8118 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8124 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8126 sv_setpvn(newSVrv(rv,classname), pv, n);
8131 =for apidoc sv_bless
8133 Blesses an SV into a specified package. The SV must be an RV. The package
8134 must be designated by its stash (see C<gv_stashpv()>). The reference count
8135 of the SV is unaffected.
8141 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8146 Perl_croak(aTHX_ "Can't bless non-reference value");
8148 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8149 if (SvIsCOW(tmpRef))
8150 sv_force_normal_flags(tmpRef, 0);
8151 if (SvREADONLY(tmpRef))
8152 Perl_croak(aTHX_ PL_no_modify);
8153 if (SvOBJECT(tmpRef)) {
8154 if (SvTYPE(tmpRef) != SVt_PVIO)
8156 SvREFCNT_dec(SvSTASH(tmpRef));
8159 SvOBJECT_on(tmpRef);
8160 if (SvTYPE(tmpRef) != SVt_PVIO)
8162 SvUPGRADE(tmpRef, SVt_PVMG);
8163 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8168 (void)SvAMAGIC_off(sv);
8170 if(SvSMAGICAL(tmpRef))
8171 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8179 /* Downgrades a PVGV to a PVMG.
8183 S_sv_unglob(pTHX_ SV *sv)
8188 SV * const temp = sv_newmortal();
8190 assert(SvTYPE(sv) == SVt_PVGV);
8192 gv_efullname3(temp, (GV *) sv, "*");
8195 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8196 mro_method_changed_in(stash);
8200 sv_del_backref((SV*)GvSTASH(sv), sv);
8204 if (GvNAME_HEK(sv)) {
8205 unshare_hek(GvNAME_HEK(sv));
8207 isGV_with_GP_off(sv);
8209 /* need to keep SvANY(sv) in the right arena */
8210 xpvmg = new_XPVMG();
8211 StructCopy(SvANY(sv), xpvmg, XPVMG);
8212 del_XPVGV(SvANY(sv));
8215 SvFLAGS(sv) &= ~SVTYPEMASK;
8216 SvFLAGS(sv) |= SVt_PVMG;
8218 /* Intentionally not calling any local SET magic, as this isn't so much a
8219 set operation as merely an internal storage change. */
8220 sv_setsv_flags(sv, temp, 0);
8224 =for apidoc sv_unref_flags
8226 Unsets the RV status of the SV, and decrements the reference count of
8227 whatever was being referenced by the RV. This can almost be thought of
8228 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8229 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8230 (otherwise the decrementing is conditional on the reference count being
8231 different from one or the reference being a readonly SV).
8238 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8240 SV* const target = SvRV(ref);
8242 if (SvWEAKREF(ref)) {
8243 sv_del_backref(target, ref);
8245 SvRV_set(ref, NULL);
8248 SvRV_set(ref, NULL);
8250 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8251 assigned to as BEGIN {$a = \"Foo"} will fail. */
8252 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8253 SvREFCNT_dec(target);
8254 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8255 sv_2mortal(target); /* Schedule for freeing later */
8259 =for apidoc sv_untaint
8261 Untaint an SV. Use C<SvTAINTED_off> instead.
8266 Perl_sv_untaint(pTHX_ SV *sv)
8268 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8269 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8276 =for apidoc sv_tainted
8278 Test an SV for taintedness. Use C<SvTAINTED> instead.
8283 Perl_sv_tainted(pTHX_ SV *sv)
8285 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8286 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8287 if (mg && (mg->mg_len & 1) )
8294 =for apidoc sv_setpviv
8296 Copies an integer into the given SV, also updating its string value.
8297 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8303 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8305 char buf[TYPE_CHARS(UV)];
8307 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8309 sv_setpvn(sv, ptr, ebuf - ptr);
8313 =for apidoc sv_setpviv_mg
8315 Like C<sv_setpviv>, but also handles 'set' magic.
8321 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8327 #if defined(PERL_IMPLICIT_CONTEXT)
8329 /* pTHX_ magic can't cope with varargs, so this is a no-context
8330 * version of the main function, (which may itself be aliased to us).
8331 * Don't access this version directly.
8335 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8339 va_start(args, pat);
8340 sv_vsetpvf(sv, pat, &args);
8344 /* pTHX_ magic can't cope with varargs, so this is a no-context
8345 * version of the main function, (which may itself be aliased to us).
8346 * Don't access this version directly.
8350 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8354 va_start(args, pat);
8355 sv_vsetpvf_mg(sv, pat, &args);
8361 =for apidoc sv_setpvf
8363 Works like C<sv_catpvf> but copies the text into the SV instead of
8364 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8370 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8373 va_start(args, pat);
8374 sv_vsetpvf(sv, pat, &args);
8379 =for apidoc sv_vsetpvf
8381 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8382 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8384 Usually used via its frontend C<sv_setpvf>.
8390 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8392 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8396 =for apidoc sv_setpvf_mg
8398 Like C<sv_setpvf>, but also handles 'set' magic.
8404 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8407 va_start(args, pat);
8408 sv_vsetpvf_mg(sv, pat, &args);
8413 =for apidoc sv_vsetpvf_mg
8415 Like C<sv_vsetpvf>, but also handles 'set' magic.
8417 Usually used via its frontend C<sv_setpvf_mg>.
8423 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8425 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8429 #if defined(PERL_IMPLICIT_CONTEXT)
8431 /* pTHX_ magic can't cope with varargs, so this is a no-context
8432 * version of the main function, (which may itself be aliased to us).
8433 * Don't access this version directly.
8437 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8441 va_start(args, pat);
8442 sv_vcatpvf(sv, pat, &args);
8446 /* pTHX_ magic can't cope with varargs, so this is a no-context
8447 * version of the main function, (which may itself be aliased to us).
8448 * Don't access this version directly.
8452 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8456 va_start(args, pat);
8457 sv_vcatpvf_mg(sv, pat, &args);
8463 =for apidoc sv_catpvf
8465 Processes its arguments like C<sprintf> and appends the formatted
8466 output to an SV. If the appended data contains "wide" characters
8467 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8468 and characters >255 formatted with %c), the original SV might get
8469 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8470 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8471 valid UTF-8; if the original SV was bytes, the pattern should be too.
8476 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8479 va_start(args, pat);
8480 sv_vcatpvf(sv, pat, &args);
8485 =for apidoc sv_vcatpvf
8487 Processes its arguments like C<vsprintf> and appends the formatted output
8488 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8490 Usually used via its frontend C<sv_catpvf>.
8496 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8498 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8502 =for apidoc sv_catpvf_mg
8504 Like C<sv_catpvf>, but also handles 'set' magic.
8510 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8513 va_start(args, pat);
8514 sv_vcatpvf_mg(sv, pat, &args);
8519 =for apidoc sv_vcatpvf_mg
8521 Like C<sv_vcatpvf>, but also handles 'set' magic.
8523 Usually used via its frontend C<sv_catpvf_mg>.
8529 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8531 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8536 =for apidoc sv_vsetpvfn
8538 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8541 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8547 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8549 sv_setpvn(sv, "", 0);
8550 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8554 S_expect_number(pTHX_ char** pattern)
8558 switch (**pattern) {
8559 case '1': case '2': case '3':
8560 case '4': case '5': case '6':
8561 case '7': case '8': case '9':
8562 var = *(*pattern)++ - '0';
8563 while (isDIGIT(**pattern)) {
8564 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8566 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8574 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8576 const int neg = nv < 0;
8585 if (uv & 1 && uv == nv)
8586 uv--; /* Round to even */
8588 const unsigned dig = uv % 10;
8601 =for apidoc sv_vcatpvfn
8603 Processes its arguments like C<vsprintf> and appends the formatted output
8604 to an SV. Uses an array of SVs if the C style variable argument list is
8605 missing (NULL). When running with taint checks enabled, indicates via
8606 C<maybe_tainted> if results are untrustworthy (often due to the use of
8609 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8615 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8616 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8617 vec_utf8 = DO_UTF8(vecsv);
8619 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8622 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8630 static const char nullstr[] = "(null)";
8632 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8633 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8635 /* Times 4: a decimal digit takes more than 3 binary digits.
8636 * NV_DIG: mantissa takes than many decimal digits.
8637 * Plus 32: Playing safe. */
8638 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8639 /* large enough for "%#.#f" --chip */
8640 /* what about long double NVs? --jhi */
8642 PERL_UNUSED_ARG(maybe_tainted);
8644 /* no matter what, this is a string now */
8645 (void)SvPV_force(sv, origlen);
8647 /* special-case "", "%s", and "%-p" (SVf - see below) */
8650 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8652 const char * const s = va_arg(*args, char*);
8653 sv_catpv(sv, s ? s : nullstr);
8655 else if (svix < svmax) {
8656 sv_catsv(sv, *svargs);
8660 if (args && patlen == 3 && pat[0] == '%' &&
8661 pat[1] == '-' && pat[2] == 'p') {
8662 argsv = (SV*)va_arg(*args, void*);
8663 sv_catsv(sv, argsv);
8667 #ifndef USE_LONG_DOUBLE
8668 /* special-case "%.<number>[gf]" */
8669 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8670 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8671 unsigned digits = 0;
8675 while (*pp >= '0' && *pp <= '9')
8676 digits = 10 * digits + (*pp++ - '0');
8677 if (pp - pat == (int)patlen - 1) {
8685 /* Add check for digits != 0 because it seems that some
8686 gconverts are buggy in this case, and we don't yet have
8687 a Configure test for this. */
8688 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8689 /* 0, point, slack */
8690 Gconvert(nv, (int)digits, 0, ebuf);
8692 if (*ebuf) /* May return an empty string for digits==0 */
8695 } else if (!digits) {
8698 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8699 sv_catpvn(sv, p, l);
8705 #endif /* !USE_LONG_DOUBLE */
8707 if (!args && svix < svmax && DO_UTF8(*svargs))
8710 patend = (char*)pat + patlen;
8711 for (p = (char*)pat; p < patend; p = q) {
8714 bool vectorize = FALSE;
8715 bool vectorarg = FALSE;
8716 bool vec_utf8 = FALSE;
8722 bool has_precis = FALSE;
8724 const I32 osvix = svix;
8725 bool is_utf8 = FALSE; /* is this item utf8? */
8726 #ifdef HAS_LDBL_SPRINTF_BUG
8727 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8728 with sfio - Allen <allens@cpan.org> */
8729 bool fix_ldbl_sprintf_bug = FALSE;
8733 U8 utf8buf[UTF8_MAXBYTES+1];
8734 STRLEN esignlen = 0;
8736 const char *eptr = NULL;
8739 const U8 *vecstr = NULL;
8746 /* we need a long double target in case HAS_LONG_DOUBLE but
8749 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8757 const char *dotstr = ".";
8758 STRLEN dotstrlen = 1;
8759 I32 efix = 0; /* explicit format parameter index */
8760 I32 ewix = 0; /* explicit width index */
8761 I32 epix = 0; /* explicit precision index */
8762 I32 evix = 0; /* explicit vector index */
8763 bool asterisk = FALSE;
8765 /* echo everything up to the next format specification */
8766 for (q = p; q < patend && *q != '%'; ++q) ;
8768 if (has_utf8 && !pat_utf8)
8769 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8771 sv_catpvn(sv, p, q - p);
8778 We allow format specification elements in this order:
8779 \d+\$ explicit format parameter index
8781 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8782 0 flag (as above): repeated to allow "v02"
8783 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8784 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8786 [%bcdefginopsuxDFOUX] format (mandatory)
8791 As of perl5.9.3, printf format checking is on by default.
8792 Internally, perl uses %p formats to provide an escape to
8793 some extended formatting. This block deals with those
8794 extensions: if it does not match, (char*)q is reset and
8795 the normal format processing code is used.
8797 Currently defined extensions are:
8798 %p include pointer address (standard)
8799 %-p (SVf) include an SV (previously %_)
8800 %-<num>p include an SV with precision <num>
8801 %<num>p reserved for future extensions
8803 Robin Barker 2005-07-14
8805 %1p (VDf) removed. RMB 2007-10-19
8812 n = expect_number(&q);
8819 argsv = (SV*)va_arg(*args, void*);
8820 eptr = SvPV_const(argsv, elen);
8826 if (ckWARN_d(WARN_INTERNAL))
8827 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8828 "internal %%<num>p might conflict with future printf extensions");
8834 if ( (width = expect_number(&q)) ) {
8849 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8878 if ( (ewix = expect_number(&q)) )
8887 if ((vectorarg = asterisk)) {
8900 width = expect_number(&q);
8906 vecsv = va_arg(*args, SV*);
8908 vecsv = (evix > 0 && evix <= svmax)
8909 ? svargs[evix-1] : &PL_sv_undef;
8911 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8913 dotstr = SvPV_const(vecsv, dotstrlen);
8914 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8915 bad with tied or overloaded values that return UTF8. */
8918 else if (has_utf8) {
8919 vecsv = sv_mortalcopy(vecsv);
8920 sv_utf8_upgrade(vecsv);
8921 dotstr = SvPV_const(vecsv, dotstrlen);
8928 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8929 vecsv = svargs[efix ? efix-1 : svix++];
8930 vecstr = (U8*)SvPV_const(vecsv,veclen);
8931 vec_utf8 = DO_UTF8(vecsv);
8933 /* if this is a version object, we need to convert
8934 * back into v-string notation and then let the
8935 * vectorize happen normally
8937 if (sv_derived_from(vecsv, "version")) {
8938 char *version = savesvpv(vecsv);
8939 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8940 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8941 "vector argument not supported with alpha versions");
8944 vecsv = sv_newmortal();
8945 scan_vstring(version, version + veclen, vecsv);
8946 vecstr = (U8*)SvPV_const(vecsv, veclen);
8947 vec_utf8 = DO_UTF8(vecsv);
8959 i = va_arg(*args, int);
8961 i = (ewix ? ewix <= svmax : svix < svmax) ?
8962 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8964 width = (i < 0) ? -i : i;
8974 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8976 /* XXX: todo, support specified precision parameter */
8980 i = va_arg(*args, int);
8982 i = (ewix ? ewix <= svmax : svix < svmax)
8983 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8985 has_precis = !(i < 0);
8990 precis = precis * 10 + (*q++ - '0');
8999 case 'I': /* Ix, I32x, and I64x */
9001 if (q[1] == '6' && q[2] == '4') {
9007 if (q[1] == '3' && q[2] == '2') {
9017 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9028 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9029 if (*(q + 1) == 'l') { /* lld, llf */
9055 if (!vectorize && !args) {
9057 const I32 i = efix-1;
9058 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9060 argsv = (svix >= 0 && svix < svmax)
9061 ? svargs[svix++] : &PL_sv_undef;
9072 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9074 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9076 eptr = (char*)utf8buf;
9077 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9091 eptr = va_arg(*args, char*);
9093 #ifdef MACOS_TRADITIONAL
9094 /* On MacOS, %#s format is used for Pascal strings */
9099 elen = strlen(eptr);
9101 eptr = (char *)nullstr;
9102 elen = sizeof nullstr - 1;
9106 eptr = SvPV_const(argsv, elen);
9107 if (DO_UTF8(argsv)) {
9108 I32 old_precis = precis;
9109 if (has_precis && precis < elen) {
9111 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9114 if (width) { /* fudge width (can't fudge elen) */
9115 if (has_precis && precis < elen)
9116 width += precis - old_precis;
9118 width += elen - sv_len_utf8(argsv);
9125 if (has_precis && elen > precis)
9132 if (alt || vectorize)
9134 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9155 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9164 esignbuf[esignlen++] = plus;
9168 case 'h': iv = (short)va_arg(*args, int); break;
9169 case 'l': iv = va_arg(*args, long); break;
9170 case 'V': iv = va_arg(*args, IV); break;
9171 default: iv = va_arg(*args, int); break;
9173 case 'q': iv = va_arg(*args, Quad_t); break;
9178 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9180 case 'h': iv = (short)tiv; break;
9181 case 'l': iv = (long)tiv; break;
9183 default: iv = tiv; break;
9185 case 'q': iv = (Quad_t)tiv; break;
9189 if ( !vectorize ) /* we already set uv above */
9194 esignbuf[esignlen++] = plus;
9198 esignbuf[esignlen++] = '-';
9242 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9253 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9254 case 'l': uv = va_arg(*args, unsigned long); break;
9255 case 'V': uv = va_arg(*args, UV); break;
9256 default: uv = va_arg(*args, unsigned); break;
9258 case 'q': uv = va_arg(*args, Uquad_t); break;
9263 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9265 case 'h': uv = (unsigned short)tuv; break;
9266 case 'l': uv = (unsigned long)tuv; break;
9268 default: uv = tuv; break;
9270 case 'q': uv = (Uquad_t)tuv; break;
9277 char *ptr = ebuf + sizeof ebuf;
9278 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9284 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9290 esignbuf[esignlen++] = '0';
9291 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9299 if (alt && *ptr != '0')
9308 esignbuf[esignlen++] = '0';
9309 esignbuf[esignlen++] = c;
9312 default: /* it had better be ten or less */
9316 } while (uv /= base);
9319 elen = (ebuf + sizeof ebuf) - ptr;
9323 zeros = precis - elen;
9324 else if (precis == 0 && elen == 1 && *eptr == '0'
9325 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9328 /* a precision nullifies the 0 flag. */
9335 /* FLOATING POINT */
9338 c = 'f'; /* maybe %F isn't supported here */
9346 /* This is evil, but floating point is even more evil */
9348 /* for SV-style calling, we can only get NV
9349 for C-style calling, we assume %f is double;
9350 for simplicity we allow any of %Lf, %llf, %qf for long double
9354 #if defined(USE_LONG_DOUBLE)
9358 /* [perl #20339] - we should accept and ignore %lf rather than die */
9362 #if defined(USE_LONG_DOUBLE)
9363 intsize = args ? 0 : 'q';
9367 #if defined(HAS_LONG_DOUBLE)
9376 /* now we need (long double) if intsize == 'q', else (double) */
9378 #if LONG_DOUBLESIZE > DOUBLESIZE
9380 va_arg(*args, long double) :
9381 va_arg(*args, double)
9383 va_arg(*args, double)
9388 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9389 else. frexp() has some unspecified behaviour for those three */
9390 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9392 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9393 will cast our (long double) to (double) */
9394 (void)Perl_frexp(nv, &i);
9395 if (i == PERL_INT_MIN)
9396 Perl_die(aTHX_ "panic: frexp");
9398 need = BIT_DIGITS(i);
9400 need += has_precis ? precis : 6; /* known default */
9405 #ifdef HAS_LDBL_SPRINTF_BUG
9406 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9407 with sfio - Allen <allens@cpan.org> */
9410 # define MY_DBL_MAX DBL_MAX
9411 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9412 # if DOUBLESIZE >= 8
9413 # define MY_DBL_MAX 1.7976931348623157E+308L
9415 # define MY_DBL_MAX 3.40282347E+38L
9419 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9420 # define MY_DBL_MAX_BUG 1L
9422 # define MY_DBL_MAX_BUG MY_DBL_MAX
9426 # define MY_DBL_MIN DBL_MIN
9427 # else /* XXX guessing! -Allen */
9428 # if DOUBLESIZE >= 8
9429 # define MY_DBL_MIN 2.2250738585072014E-308L
9431 # define MY_DBL_MIN 1.17549435E-38L
9435 if ((intsize == 'q') && (c == 'f') &&
9436 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9438 /* it's going to be short enough that
9439 * long double precision is not needed */
9441 if ((nv <= 0L) && (nv >= -0L))
9442 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9444 /* would use Perl_fp_class as a double-check but not
9445 * functional on IRIX - see perl.h comments */
9447 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9448 /* It's within the range that a double can represent */
9449 #if defined(DBL_MAX) && !defined(DBL_MIN)
9450 if ((nv >= ((long double)1/DBL_MAX)) ||
9451 (nv <= (-(long double)1/DBL_MAX)))
9453 fix_ldbl_sprintf_bug = TRUE;
9456 if (fix_ldbl_sprintf_bug == TRUE) {
9466 # undef MY_DBL_MAX_BUG
9469 #endif /* HAS_LDBL_SPRINTF_BUG */
9471 need += 20; /* fudge factor */
9472 if (PL_efloatsize < need) {
9473 Safefree(PL_efloatbuf);
9474 PL_efloatsize = need + 20; /* more fudge */
9475 Newx(PL_efloatbuf, PL_efloatsize, char);
9476 PL_efloatbuf[0] = '\0';
9479 if ( !(width || left || plus || alt) && fill != '0'
9480 && has_precis && intsize != 'q' ) { /* Shortcuts */
9481 /* See earlier comment about buggy Gconvert when digits,
9483 if ( c == 'g' && precis) {
9484 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9485 /* May return an empty string for digits==0 */
9486 if (*PL_efloatbuf) {
9487 elen = strlen(PL_efloatbuf);
9488 goto float_converted;
9490 } else if ( c == 'f' && !precis) {
9491 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9496 char *ptr = ebuf + sizeof ebuf;
9499 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9500 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9501 if (intsize == 'q') {
9502 /* Copy the one or more characters in a long double
9503 * format before the 'base' ([efgEFG]) character to
9504 * the format string. */
9505 static char const prifldbl[] = PERL_PRIfldbl;
9506 char const *p = prifldbl + sizeof(prifldbl) - 3;
9507 while (p >= prifldbl) { *--ptr = *p--; }
9512 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9517 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9529 /* No taint. Otherwise we are in the strange situation
9530 * where printf() taints but print($float) doesn't.
9532 #if defined(HAS_LONG_DOUBLE)
9533 elen = ((intsize == 'q')
9534 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9535 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9537 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9541 eptr = PL_efloatbuf;
9549 i = SvCUR(sv) - origlen;
9552 case 'h': *(va_arg(*args, short*)) = i; break;
9553 default: *(va_arg(*args, int*)) = i; break;
9554 case 'l': *(va_arg(*args, long*)) = i; break;
9555 case 'V': *(va_arg(*args, IV*)) = i; break;
9557 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9562 sv_setuv_mg(argsv, (UV)i);
9563 continue; /* not "break" */
9570 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9571 && ckWARN(WARN_PRINTF))
9573 SV * const msg = sv_newmortal();
9574 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9575 (PL_op->op_type == OP_PRTF) ? "" : "s");
9578 Perl_sv_catpvf(aTHX_ msg,
9579 "\"%%%c\"", c & 0xFF);
9581 Perl_sv_catpvf(aTHX_ msg,
9582 "\"%%\\%03"UVof"\"",
9585 sv_catpvs(msg, "end of string");
9586 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9589 /* output mangled stuff ... */
9595 /* ... right here, because formatting flags should not apply */
9596 SvGROW(sv, SvCUR(sv) + elen + 1);
9598 Copy(eptr, p, elen, char);
9601 SvCUR_set(sv, p - SvPVX_const(sv));
9603 continue; /* not "break" */
9606 if (is_utf8 != has_utf8) {
9609 sv_utf8_upgrade(sv);
9612 const STRLEN old_elen = elen;
9613 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9614 sv_utf8_upgrade(nsv);
9615 eptr = SvPVX_const(nsv);
9618 if (width) { /* fudge width (can't fudge elen) */
9619 width += elen - old_elen;
9625 have = esignlen + zeros + elen;
9627 Perl_croak_nocontext(PL_memory_wrap);
9629 need = (have > width ? have : width);
9632 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9633 Perl_croak_nocontext(PL_memory_wrap);
9634 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9636 if (esignlen && fill == '0') {
9638 for (i = 0; i < (int)esignlen; i++)
9642 memset(p, fill, gap);
9645 if (esignlen && fill != '0') {
9647 for (i = 0; i < (int)esignlen; i++)
9652 for (i = zeros; i; i--)
9656 Copy(eptr, p, elen, char);
9660 memset(p, ' ', gap);
9665 Copy(dotstr, p, dotstrlen, char);
9669 vectorize = FALSE; /* done iterating over vecstr */
9676 SvCUR_set(sv, p - SvPVX_const(sv));
9684 /* =========================================================================
9686 =head1 Cloning an interpreter
9688 All the macros and functions in this section are for the private use of
9689 the main function, perl_clone().
9691 The foo_dup() functions make an exact copy of an existing foo thingy.
9692 During the course of a cloning, a hash table is used to map old addresses
9693 to new addresses. The table is created and manipulated with the
9694 ptr_table_* functions.
9698 ============================================================================*/
9701 #if defined(USE_ITHREADS)
9703 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9704 #ifndef GpREFCNT_inc
9705 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9709 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9710 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9711 If this changes, please unmerge ss_dup. */
9712 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9713 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9714 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9715 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9716 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9717 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9718 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9719 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9720 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9721 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9722 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9723 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9724 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9725 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9727 /* clone a parser */
9730 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9737 /* look for it in the table first */
9738 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9742 /* create anew and remember what it is */
9743 Newxz(parser, 1, yy_parser);
9744 ptr_table_store(PL_ptr_table, proto, parser);
9746 parser->yyerrstatus = 0;
9747 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9749 /* XXX these not yet duped */
9750 parser->old_parser = NULL;
9751 parser->stack = NULL;
9753 parser->stack_size = 0;
9754 /* XXX parser->stack->state = 0; */
9756 /* XXX eventually, just Copy() most of the parser struct ? */
9758 parser->lex_brackets = proto->lex_brackets;
9759 parser->lex_casemods = proto->lex_casemods;
9760 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9761 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9762 parser->lex_casestack = savepvn(proto->lex_casestack,
9763 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9764 parser->lex_defer = proto->lex_defer;
9765 parser->lex_dojoin = proto->lex_dojoin;
9766 parser->lex_expect = proto->lex_expect;
9767 parser->lex_formbrack = proto->lex_formbrack;
9768 parser->lex_inpat = proto->lex_inpat;
9769 parser->lex_inwhat = proto->lex_inwhat;
9770 parser->lex_op = proto->lex_op;
9771 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9772 parser->lex_starts = proto->lex_starts;
9773 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9774 parser->multi_close = proto->multi_close;
9775 parser->multi_open = proto->multi_open;
9776 parser->multi_start = proto->multi_start;
9777 parser->multi_end = proto->multi_end;
9778 parser->pending_ident = proto->pending_ident;
9779 parser->preambled = proto->preambled;
9780 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9781 parser->linestr = sv_dup_inc(proto->linestr, param);
9782 parser->expect = proto->expect;
9783 parser->copline = proto->copline;
9784 parser->last_lop_op = proto->last_lop_op;
9785 parser->lex_state = proto->lex_state;
9786 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9787 /* rsfp_filters entries have fake IoDIRP() */
9788 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9789 parser->in_my = proto->in_my;
9790 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9791 parser->error_count = proto->error_count;
9794 parser->linestr = sv_dup_inc(proto->linestr, param);
9797 char * const ols = SvPVX(proto->linestr);
9798 char * const ls = SvPVX(parser->linestr);
9800 parser->bufptr = ls + (proto->bufptr >= ols ?
9801 proto->bufptr - ols : 0);
9802 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9803 proto->oldbufptr - ols : 0);
9804 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9805 proto->oldoldbufptr - ols : 0);
9806 parser->linestart = ls + (proto->linestart >= ols ?
9807 proto->linestart - ols : 0);
9808 parser->last_uni = ls + (proto->last_uni >= ols ?
9809 proto->last_uni - ols : 0);
9810 parser->last_lop = ls + (proto->last_lop >= ols ?
9811 proto->last_lop - ols : 0);
9813 parser->bufend = ls + SvCUR(parser->linestr);
9816 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9820 parser->endwhite = proto->endwhite;
9821 parser->faketokens = proto->faketokens;
9822 parser->lasttoke = proto->lasttoke;
9823 parser->nextwhite = proto->nextwhite;
9824 parser->realtokenstart = proto->realtokenstart;
9825 parser->skipwhite = proto->skipwhite;
9826 parser->thisclose = proto->thisclose;
9827 parser->thismad = proto->thismad;
9828 parser->thisopen = proto->thisopen;
9829 parser->thisstuff = proto->thisstuff;
9830 parser->thistoken = proto->thistoken;
9831 parser->thiswhite = proto->thiswhite;
9833 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9834 parser->curforce = proto->curforce;
9836 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9837 Copy(proto->nexttype, parser->nexttype, 5, I32);
9838 parser->nexttoke = proto->nexttoke;
9844 /* duplicate a file handle */
9847 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9851 PERL_UNUSED_ARG(type);
9854 return (PerlIO*)NULL;
9856 /* look for it in the table first */
9857 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9861 /* create anew and remember what it is */
9862 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9863 ptr_table_store(PL_ptr_table, fp, ret);
9867 /* duplicate a directory handle */
9870 Perl_dirp_dup(pTHX_ DIR *dp)
9872 PERL_UNUSED_CONTEXT;
9879 /* duplicate a typeglob */
9882 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9888 /* look for it in the table first */
9889 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9893 /* create anew and remember what it is */
9895 ptr_table_store(PL_ptr_table, gp, ret);
9898 ret->gp_refcnt = 0; /* must be before any other dups! */
9899 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9900 ret->gp_io = io_dup_inc(gp->gp_io, param);
9901 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9902 ret->gp_av = av_dup_inc(gp->gp_av, param);
9903 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9904 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9905 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9906 ret->gp_cvgen = gp->gp_cvgen;
9907 ret->gp_line = gp->gp_line;
9908 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9912 /* duplicate a chain of magic */
9915 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9917 MAGIC *mgprev = (MAGIC*)NULL;
9920 return (MAGIC*)NULL;
9921 /* look for it in the table first */
9922 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9926 for (; mg; mg = mg->mg_moremagic) {
9928 Newxz(nmg, 1, MAGIC);
9930 mgprev->mg_moremagic = nmg;
9933 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9934 nmg->mg_private = mg->mg_private;
9935 nmg->mg_type = mg->mg_type;
9936 nmg->mg_flags = mg->mg_flags;
9937 /* FIXME for plugins
9938 if (mg->mg_type == PERL_MAGIC_qr) {
9939 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9943 if(mg->mg_type == PERL_MAGIC_backref) {
9944 /* The backref AV has its reference count deliberately bumped by
9946 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9949 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9950 ? sv_dup_inc(mg->mg_obj, param)
9951 : sv_dup(mg->mg_obj, param);
9953 nmg->mg_len = mg->mg_len;
9954 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9955 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9956 if (mg->mg_len > 0) {
9957 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9958 if (mg->mg_type == PERL_MAGIC_overload_table &&
9959 AMT_AMAGIC((AMT*)mg->mg_ptr))
9961 const AMT * const amtp = (AMT*)mg->mg_ptr;
9962 AMT * const namtp = (AMT*)nmg->mg_ptr;
9964 for (i = 1; i < NofAMmeth; i++) {
9965 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9969 else if (mg->mg_len == HEf_SVKEY)
9970 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9972 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9973 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9980 #endif /* USE_ITHREADS */
9982 /* create a new pointer-mapping table */
9985 Perl_ptr_table_new(pTHX)
9988 PERL_UNUSED_CONTEXT;
9990 Newxz(tbl, 1, PTR_TBL_t);
9993 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9997 #define PTR_TABLE_HASH(ptr) \
9998 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10001 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10002 following define) and at call to new_body_inline made below in
10003 Perl_ptr_table_store()
10006 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10008 /* map an existing pointer using a table */
10010 STATIC PTR_TBL_ENT_t *
10011 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
10012 PTR_TBL_ENT_t *tblent;
10013 const UV hash = PTR_TABLE_HASH(sv);
10015 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10016 for (; tblent; tblent = tblent->next) {
10017 if (tblent->oldval == sv)
10024 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10026 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10027 PERL_UNUSED_CONTEXT;
10028 return tblent ? tblent->newval : NULL;
10031 /* add a new entry to a pointer-mapping table */
10034 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10036 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10037 PERL_UNUSED_CONTEXT;
10040 tblent->newval = newsv;
10042 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10044 new_body_inline(tblent, PTE_SVSLOT);
10046 tblent->oldval = oldsv;
10047 tblent->newval = newsv;
10048 tblent->next = tbl->tbl_ary[entry];
10049 tbl->tbl_ary[entry] = tblent;
10051 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10052 ptr_table_split(tbl);
10056 /* double the hash bucket size of an existing ptr table */
10059 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10061 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10062 const UV oldsize = tbl->tbl_max + 1;
10063 UV newsize = oldsize * 2;
10065 PERL_UNUSED_CONTEXT;
10067 Renew(ary, newsize, PTR_TBL_ENT_t*);
10068 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10069 tbl->tbl_max = --newsize;
10070 tbl->tbl_ary = ary;
10071 for (i=0; i < oldsize; i++, ary++) {
10072 PTR_TBL_ENT_t **curentp, **entp, *ent;
10075 curentp = ary + oldsize;
10076 for (entp = ary, ent = *ary; ent; ent = *entp) {
10077 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10079 ent->next = *curentp;
10089 /* remove all the entries from a ptr table */
10092 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10094 if (tbl && tbl->tbl_items) {
10095 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10096 UV riter = tbl->tbl_max;
10099 PTR_TBL_ENT_t *entry = array[riter];
10102 PTR_TBL_ENT_t * const oentry = entry;
10103 entry = entry->next;
10108 tbl->tbl_items = 0;
10112 /* clear and free a ptr table */
10115 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10120 ptr_table_clear(tbl);
10121 Safefree(tbl->tbl_ary);
10125 #if defined(USE_ITHREADS)
10128 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10131 SvRV_set(dstr, SvWEAKREF(sstr)
10132 ? sv_dup(SvRV(sstr), param)
10133 : sv_dup_inc(SvRV(sstr), param));
10136 else if (SvPVX_const(sstr)) {
10137 /* Has something there */
10139 /* Normal PV - clone whole allocated space */
10140 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10141 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10142 /* Not that normal - actually sstr is copy on write.
10143 But we are a true, independant SV, so: */
10144 SvREADONLY_off(dstr);
10149 /* Special case - not normally malloced for some reason */
10150 if (isGV_with_GP(sstr)) {
10151 /* Don't need to do anything here. */
10153 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10154 /* A "shared" PV - clone it as "shared" PV */
10156 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10160 /* Some other special case - random pointer */
10161 SvPV_set(dstr, SvPVX(sstr));
10166 /* Copy the NULL */
10167 SvPV_set(dstr, NULL);
10171 /* duplicate an SV of any type (including AV, HV etc) */
10174 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10181 if (SvTYPE(sstr) == SVTYPEMASK) {
10182 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10187 /* look for it in the table first */
10188 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10192 if(param->flags & CLONEf_JOIN_IN) {
10193 /** We are joining here so we don't want do clone
10194 something that is bad **/
10195 if (SvTYPE(sstr) == SVt_PVHV) {
10196 const HEK * const hvname = HvNAME_HEK(sstr);
10198 /** don't clone stashes if they already exist **/
10199 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10203 /* create anew and remember what it is */
10206 #ifdef DEBUG_LEAKING_SCALARS
10207 dstr->sv_debug_optype = sstr->sv_debug_optype;
10208 dstr->sv_debug_line = sstr->sv_debug_line;
10209 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10210 dstr->sv_debug_cloned = 1;
10211 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10214 ptr_table_store(PL_ptr_table, sstr, dstr);
10217 SvFLAGS(dstr) = SvFLAGS(sstr);
10218 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10219 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10222 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10223 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10224 (void*)PL_watch_pvx, SvPVX_const(sstr));
10227 /* don't clone objects whose class has asked us not to */
10228 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10233 switch (SvTYPE(sstr)) {
10235 SvANY(dstr) = NULL;
10238 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10240 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10242 SvIV_set(dstr, SvIVX(sstr));
10246 SvANY(dstr) = new_XNV();
10247 SvNV_set(dstr, SvNVX(sstr));
10249 /* case SVt_BIND: */
10252 /* These are all the types that need complex bodies allocating. */
10254 const svtype sv_type = SvTYPE(sstr);
10255 const struct body_details *const sv_type_details
10256 = bodies_by_type + sv_type;
10260 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10264 if (GvUNIQUE((GV*)sstr)) {
10265 NOOP; /* Do sharing here, and fall through */
10278 assert(sv_type_details->body_size);
10279 if (sv_type_details->arena) {
10280 new_body_inline(new_body, sv_type);
10282 = (void*)((char*)new_body - sv_type_details->offset);
10284 new_body = new_NOARENA(sv_type_details);
10288 SvANY(dstr) = new_body;
10291 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10292 ((char*)SvANY(dstr)) + sv_type_details->offset,
10293 sv_type_details->copy, char);
10295 Copy(((char*)SvANY(sstr)),
10296 ((char*)SvANY(dstr)),
10297 sv_type_details->body_size + sv_type_details->offset, char);
10300 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10301 && !isGV_with_GP(dstr))
10302 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10304 /* The Copy above means that all the source (unduplicated) pointers
10305 are now in the destination. We can check the flags and the
10306 pointers in either, but it's possible that there's less cache
10307 missing by always going for the destination.
10308 FIXME - instrument and check that assumption */
10309 if (sv_type >= SVt_PVMG) {
10310 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10311 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10312 } else if (SvMAGIC(dstr))
10313 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10315 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10318 /* The cast silences a GCC warning about unhandled types. */
10319 switch ((int)sv_type) {
10329 /* FIXME for plugins */
10330 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10333 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10334 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10335 LvTARG(dstr) = dstr;
10336 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10337 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10339 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10341 if(isGV_with_GP(sstr)) {
10342 if (GvNAME_HEK(dstr))
10343 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10344 /* Don't call sv_add_backref here as it's going to be
10345 created as part of the magic cloning of the symbol
10347 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10348 at the point of this comment. */
10349 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10350 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10351 (void)GpREFCNT_inc(GvGP(dstr));
10353 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10356 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10357 if (IoOFP(dstr) == IoIFP(sstr))
10358 IoOFP(dstr) = IoIFP(dstr);
10360 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10361 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10362 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10363 /* I have no idea why fake dirp (rsfps)
10364 should be treated differently but otherwise
10365 we end up with leaks -- sky*/
10366 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10367 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10368 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10370 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10371 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10372 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10373 if (IoDIRP(dstr)) {
10374 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10377 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10380 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10381 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10382 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10385 if (AvARRAY((AV*)sstr)) {
10386 SV **dst_ary, **src_ary;
10387 SSize_t items = AvFILLp((AV*)sstr) + 1;
10389 src_ary = AvARRAY((AV*)sstr);
10390 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10391 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10392 AvARRAY((AV*)dstr) = dst_ary;
10393 AvALLOC((AV*)dstr) = dst_ary;
10394 if (AvREAL((AV*)sstr)) {
10395 while (items-- > 0)
10396 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10399 while (items-- > 0)
10400 *dst_ary++ = sv_dup(*src_ary++, param);
10402 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10403 while (items-- > 0) {
10404 *dst_ary++ = &PL_sv_undef;
10408 AvARRAY((AV*)dstr) = NULL;
10409 AvALLOC((AV*)dstr) = (SV**)NULL;
10413 if (HvARRAY((HV*)sstr)) {
10415 const bool sharekeys = !!HvSHAREKEYS(sstr);
10416 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10417 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10419 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10420 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10422 HvARRAY(dstr) = (HE**)darray;
10423 while (i <= sxhv->xhv_max) {
10424 const HE * const source = HvARRAY(sstr)[i];
10425 HvARRAY(dstr)[i] = source
10426 ? he_dup(source, sharekeys, param) : 0;
10431 const struct xpvhv_aux * const saux = HvAUX(sstr);
10432 struct xpvhv_aux * const daux = HvAUX(dstr);
10433 /* This flag isn't copied. */
10434 /* SvOOK_on(hv) attacks the IV flags. */
10435 SvFLAGS(dstr) |= SVf_OOK;
10437 hvname = saux->xhv_name;
10438 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10440 daux->xhv_riter = saux->xhv_riter;
10441 daux->xhv_eiter = saux->xhv_eiter
10442 ? he_dup(saux->xhv_eiter,
10443 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10444 daux->xhv_backreferences =
10445 saux->xhv_backreferences
10446 ? (AV*) SvREFCNT_inc(
10447 sv_dup((SV*)saux->xhv_backreferences, param))
10450 daux->xhv_mro_meta = saux->xhv_mro_meta
10451 ? mro_meta_dup(saux->xhv_mro_meta, param)
10454 /* Record stashes for possible cloning in Perl_clone(). */
10456 av_push(param->stashes, dstr);
10460 HvARRAY((HV*)dstr) = NULL;
10463 if (!(param->flags & CLONEf_COPY_STACKS)) {
10467 /* NOTE: not refcounted */
10468 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10470 if (!CvISXSUB(dstr))
10471 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10473 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10474 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10475 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10476 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10478 /* don't dup if copying back - CvGV isn't refcounted, so the
10479 * duped GV may never be freed. A bit of a hack! DAPM */
10480 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10481 NULL : gv_dup(CvGV(dstr), param) ;
10482 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10484 CvWEAKOUTSIDE(sstr)
10485 ? cv_dup( CvOUTSIDE(dstr), param)
10486 : cv_dup_inc(CvOUTSIDE(dstr), param);
10487 if (!CvISXSUB(dstr))
10488 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10494 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10500 /* duplicate a context */
10503 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10505 PERL_CONTEXT *ncxs;
10508 return (PERL_CONTEXT*)NULL;
10510 /* look for it in the table first */
10511 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10515 /* create anew and remember what it is */
10516 Newx(ncxs, max + 1, PERL_CONTEXT);
10517 ptr_table_store(PL_ptr_table, cxs, ncxs);
10518 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10521 PERL_CONTEXT * const ncx = &ncxs[ix];
10522 if (CxTYPE(ncx) == CXt_SUBST) {
10523 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10526 switch (CxTYPE(ncx)) {
10528 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10529 ? cv_dup_inc(ncx->blk_sub.cv, param)
10530 : cv_dup(ncx->blk_sub.cv,param));
10531 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10532 ? av_dup_inc(ncx->blk_sub.argarray,
10535 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10537 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10538 ncx->blk_sub.oldcomppad);
10541 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10543 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10546 ncx->blk_loop.iterdata = (CxPADLOOP(ncx)
10547 ? ncx->blk_loop.iterdata
10548 : gv_dup((GV*)ncx->blk_loop.iterdata,
10550 ncx->blk_loop.oldcomppad
10551 = (PAD*)ptr_table_fetch(PL_ptr_table,
10552 ncx->blk_loop.oldcomppad);
10553 ncx->blk_loop.itersave = sv_dup_inc(ncx->blk_loop.itersave,
10555 ncx->blk_loop.iterlval = sv_dup_inc(ncx->blk_loop.iterlval,
10557 ncx->blk_loop.iterary = av_dup_inc(ncx->blk_loop.iterary,
10561 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10562 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10563 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10576 /* duplicate a stack info structure */
10579 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10584 return (PERL_SI*)NULL;
10586 /* look for it in the table first */
10587 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10591 /* create anew and remember what it is */
10592 Newxz(nsi, 1, PERL_SI);
10593 ptr_table_store(PL_ptr_table, si, nsi);
10595 nsi->si_stack = av_dup_inc(si->si_stack, param);
10596 nsi->si_cxix = si->si_cxix;
10597 nsi->si_cxmax = si->si_cxmax;
10598 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10599 nsi->si_type = si->si_type;
10600 nsi->si_prev = si_dup(si->si_prev, param);
10601 nsi->si_next = si_dup(si->si_next, param);
10602 nsi->si_markoff = si->si_markoff;
10607 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10608 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10609 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10610 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10611 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10612 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10613 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10614 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10615 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10616 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10617 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10618 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10619 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10620 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10623 #define pv_dup_inc(p) SAVEPV(p)
10624 #define pv_dup(p) SAVEPV(p)
10625 #define svp_dup_inc(p,pp) any_dup(p,pp)
10627 /* map any object to the new equivent - either something in the
10628 * ptr table, or something in the interpreter structure
10632 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10637 return (void*)NULL;
10639 /* look for it in the table first */
10640 ret = ptr_table_fetch(PL_ptr_table, v);
10644 /* see if it is part of the interpreter structure */
10645 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10646 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10654 /* duplicate the save stack */
10657 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10660 ANY * const ss = proto_perl->Isavestack;
10661 const I32 max = proto_perl->Isavestack_max;
10662 I32 ix = proto_perl->Isavestack_ix;
10675 void (*dptr) (void*);
10676 void (*dxptr) (pTHX_ void*);
10678 Newxz(nss, max, ANY);
10681 const I32 type = POPINT(ss,ix);
10682 TOPINT(nss,ix) = type;
10684 case SAVEt_HELEM: /* hash element */
10685 sv = (SV*)POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10688 case SAVEt_ITEM: /* normal string */
10689 case SAVEt_SV: /* scalar reference */
10690 sv = (SV*)POPPTR(ss,ix);
10691 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10694 case SAVEt_MORTALIZESV:
10695 sv = (SV*)POPPTR(ss,ix);
10696 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10698 case SAVEt_SHARED_PVREF: /* char* in shared space */
10699 c = (char*)POPPTR(ss,ix);
10700 TOPPTR(nss,ix) = savesharedpv(c);
10701 ptr = POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10704 case SAVEt_GENERIC_SVREF: /* generic sv */
10705 case SAVEt_SVREF: /* scalar reference */
10706 sv = (SV*)POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10708 ptr = POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10711 case SAVEt_HV: /* hash reference */
10712 case SAVEt_AV: /* array reference */
10713 sv = (SV*) POPPTR(ss,ix);
10714 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10716 case SAVEt_COMPPAD:
10718 sv = (SV*) POPPTR(ss,ix);
10719 TOPPTR(nss,ix) = sv_dup(sv, param);
10721 case SAVEt_INT: /* int reference */
10722 ptr = POPPTR(ss,ix);
10723 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10724 intval = (int)POPINT(ss,ix);
10725 TOPINT(nss,ix) = intval;
10727 case SAVEt_LONG: /* long reference */
10728 ptr = POPPTR(ss,ix);
10729 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10731 case SAVEt_CLEARSV:
10732 longval = (long)POPLONG(ss,ix);
10733 TOPLONG(nss,ix) = longval;
10735 case SAVEt_I32: /* I32 reference */
10736 case SAVEt_I16: /* I16 reference */
10737 case SAVEt_I8: /* I8 reference */
10738 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10739 ptr = POPPTR(ss,ix);
10740 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10742 TOPINT(nss,ix) = i;
10744 case SAVEt_IV: /* IV reference */
10745 ptr = POPPTR(ss,ix);
10746 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10748 TOPIV(nss,ix) = iv;
10750 case SAVEt_HPTR: /* HV* reference */
10751 case SAVEt_APTR: /* AV* reference */
10752 case SAVEt_SPTR: /* SV* reference */
10753 ptr = POPPTR(ss,ix);
10754 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10755 sv = (SV*)POPPTR(ss,ix);
10756 TOPPTR(nss,ix) = sv_dup(sv, param);
10758 case SAVEt_VPTR: /* random* reference */
10759 ptr = POPPTR(ss,ix);
10760 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10761 ptr = POPPTR(ss,ix);
10762 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10764 case SAVEt_GENERIC_PVREF: /* generic char* */
10765 case SAVEt_PPTR: /* char* reference */
10766 ptr = POPPTR(ss,ix);
10767 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10768 c = (char*)POPPTR(ss,ix);
10769 TOPPTR(nss,ix) = pv_dup(c);
10771 case SAVEt_GP: /* scalar reference */
10772 gp = (GP*)POPPTR(ss,ix);
10773 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10774 (void)GpREFCNT_inc(gp);
10775 gv = (GV*)POPPTR(ss,ix);
10776 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10779 ptr = POPPTR(ss,ix);
10780 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10781 /* these are assumed to be refcounted properly */
10783 switch (((OP*)ptr)->op_type) {
10785 case OP_LEAVESUBLV:
10789 case OP_LEAVEWRITE:
10790 TOPPTR(nss,ix) = ptr;
10793 (void) OpREFCNT_inc(o);
10797 TOPPTR(nss,ix) = NULL;
10802 TOPPTR(nss,ix) = NULL;
10805 c = (char*)POPPTR(ss,ix);
10806 TOPPTR(nss,ix) = pv_dup_inc(c);
10809 hv = (HV*)POPPTR(ss,ix);
10810 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10811 c = (char*)POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = pv_dup_inc(c);
10814 case SAVEt_STACK_POS: /* Position on Perl stack */
10816 TOPINT(nss,ix) = i;
10818 case SAVEt_DESTRUCTOR:
10819 ptr = POPPTR(ss,ix);
10820 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10821 dptr = POPDPTR(ss,ix);
10822 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10823 any_dup(FPTR2DPTR(void *, dptr),
10826 case SAVEt_DESTRUCTOR_X:
10827 ptr = POPPTR(ss,ix);
10828 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10829 dxptr = POPDXPTR(ss,ix);
10830 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10831 any_dup(FPTR2DPTR(void *, dxptr),
10834 case SAVEt_REGCONTEXT:
10837 TOPINT(nss,ix) = i;
10840 case SAVEt_AELEM: /* array element */
10841 sv = (SV*)POPPTR(ss,ix);
10842 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10844 TOPINT(nss,ix) = i;
10845 av = (AV*)POPPTR(ss,ix);
10846 TOPPTR(nss,ix) = av_dup_inc(av, param);
10849 ptr = POPPTR(ss,ix);
10850 TOPPTR(nss,ix) = ptr;
10854 TOPINT(nss,ix) = i;
10855 ptr = POPPTR(ss,ix);
10858 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10859 HINTS_REFCNT_UNLOCK;
10861 TOPPTR(nss,ix) = ptr;
10862 if (i & HINT_LOCALIZE_HH) {
10863 hv = (HV*)POPPTR(ss,ix);
10864 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10868 longval = (long)POPLONG(ss,ix);
10869 TOPLONG(nss,ix) = longval;
10870 ptr = POPPTR(ss,ix);
10871 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10872 sv = (SV*)POPPTR(ss,ix);
10873 TOPPTR(nss,ix) = sv_dup(sv, param);
10876 ptr = POPPTR(ss,ix);
10877 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10878 longval = (long)POPBOOL(ss,ix);
10879 TOPBOOL(nss,ix) = (bool)longval;
10881 case SAVEt_SET_SVFLAGS:
10883 TOPINT(nss,ix) = i;
10885 TOPINT(nss,ix) = i;
10886 sv = (SV*)POPPTR(ss,ix);
10887 TOPPTR(nss,ix) = sv_dup(sv, param);
10889 case SAVEt_RE_STATE:
10891 const struct re_save_state *const old_state
10892 = (struct re_save_state *)
10893 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10894 struct re_save_state *const new_state
10895 = (struct re_save_state *)
10896 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10898 Copy(old_state, new_state, 1, struct re_save_state);
10899 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10901 new_state->re_state_bostr
10902 = pv_dup(old_state->re_state_bostr);
10903 new_state->re_state_reginput
10904 = pv_dup(old_state->re_state_reginput);
10905 new_state->re_state_regeol
10906 = pv_dup(old_state->re_state_regeol);
10907 new_state->re_state_regoffs
10908 = (regexp_paren_pair*)
10909 any_dup(old_state->re_state_regoffs, proto_perl);
10910 new_state->re_state_reglastparen
10911 = (U32*) any_dup(old_state->re_state_reglastparen,
10913 new_state->re_state_reglastcloseparen
10914 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10916 /* XXX This just has to be broken. The old save_re_context
10917 code did SAVEGENERICPV(PL_reg_start_tmp);
10918 PL_reg_start_tmp is char **.
10919 Look above to what the dup code does for
10920 SAVEt_GENERIC_PVREF
10921 It can never have worked.
10922 So this is merely a faithful copy of the exiting bug: */
10923 new_state->re_state_reg_start_tmp
10924 = (char **) pv_dup((char *)
10925 old_state->re_state_reg_start_tmp);
10926 /* I assume that it only ever "worked" because no-one called
10927 (pseudo)fork while the regexp engine had re-entered itself.
10929 #ifdef PERL_OLD_COPY_ON_WRITE
10930 new_state->re_state_nrs
10931 = sv_dup(old_state->re_state_nrs, param);
10933 new_state->re_state_reg_magic
10934 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10936 new_state->re_state_reg_oldcurpm
10937 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10939 new_state->re_state_reg_curpm
10940 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10942 new_state->re_state_reg_oldsaved
10943 = pv_dup(old_state->re_state_reg_oldsaved);
10944 new_state->re_state_reg_poscache
10945 = pv_dup(old_state->re_state_reg_poscache);
10946 new_state->re_state_reg_starttry
10947 = pv_dup(old_state->re_state_reg_starttry);
10950 case SAVEt_COMPILE_WARNINGS:
10951 ptr = POPPTR(ss,ix);
10952 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10955 ptr = POPPTR(ss,ix);
10956 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10960 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10968 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10969 * flag to the result. This is done for each stash before cloning starts,
10970 * so we know which stashes want their objects cloned */
10973 do_mark_cloneable_stash(pTHX_ SV *sv)
10975 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10977 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10978 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10979 if (cloner && GvCV(cloner)) {
10986 mXPUSHs(newSVhek(hvname));
10988 call_sv((SV*)GvCV(cloner), G_SCALAR);
10995 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11003 =for apidoc perl_clone
11005 Create and return a new interpreter by cloning the current one.
11007 perl_clone takes these flags as parameters:
11009 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11010 without it we only clone the data and zero the stacks,
11011 with it we copy the stacks and the new perl interpreter is
11012 ready to run at the exact same point as the previous one.
11013 The pseudo-fork code uses COPY_STACKS while the
11014 threads->create doesn't.
11016 CLONEf_KEEP_PTR_TABLE
11017 perl_clone keeps a ptr_table with the pointer of the old
11018 variable as a key and the new variable as a value,
11019 this allows it to check if something has been cloned and not
11020 clone it again but rather just use the value and increase the
11021 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11022 the ptr_table using the function
11023 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11024 reason to keep it around is if you want to dup some of your own
11025 variable who are outside the graph perl scans, example of this
11026 code is in threads.xs create
11029 This is a win32 thing, it is ignored on unix, it tells perls
11030 win32host code (which is c++) to clone itself, this is needed on
11031 win32 if you want to run two threads at the same time,
11032 if you just want to do some stuff in a separate perl interpreter
11033 and then throw it away and return to the original one,
11034 you don't need to do anything.
11039 /* XXX the above needs expanding by someone who actually understands it ! */
11040 EXTERN_C PerlInterpreter *
11041 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11044 perl_clone(PerlInterpreter *proto_perl, UV flags)
11047 #ifdef PERL_IMPLICIT_SYS
11049 /* perlhost.h so we need to call into it
11050 to clone the host, CPerlHost should have a c interface, sky */
11052 if (flags & CLONEf_CLONE_HOST) {
11053 return perl_clone_host(proto_perl,flags);
11055 return perl_clone_using(proto_perl, flags,
11057 proto_perl->IMemShared,
11058 proto_perl->IMemParse,
11060 proto_perl->IStdIO,
11064 proto_perl->IProc);
11068 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11069 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11070 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11071 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11072 struct IPerlDir* ipD, struct IPerlSock* ipS,
11073 struct IPerlProc* ipP)
11075 /* XXX many of the string copies here can be optimized if they're
11076 * constants; they need to be allocated as common memory and just
11077 * their pointers copied. */
11080 CLONE_PARAMS clone_params;
11081 CLONE_PARAMS* const param = &clone_params;
11083 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11084 /* for each stash, determine whether its objects should be cloned */
11085 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11086 PERL_SET_THX(my_perl);
11089 PoisonNew(my_perl, 1, PerlInterpreter);
11095 PL_savestack_ix = 0;
11096 PL_savestack_max = -1;
11097 PL_sig_pending = 0;
11099 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11100 # else /* !DEBUGGING */
11101 Zero(my_perl, 1, PerlInterpreter);
11102 # endif /* DEBUGGING */
11104 /* host pointers */
11106 PL_MemShared = ipMS;
11107 PL_MemParse = ipMP;
11114 #else /* !PERL_IMPLICIT_SYS */
11116 CLONE_PARAMS clone_params;
11117 CLONE_PARAMS* param = &clone_params;
11118 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11119 /* for each stash, determine whether its objects should be cloned */
11120 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11121 PERL_SET_THX(my_perl);
11124 PoisonNew(my_perl, 1, PerlInterpreter);
11130 PL_savestack_ix = 0;
11131 PL_savestack_max = -1;
11132 PL_sig_pending = 0;
11134 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11135 # else /* !DEBUGGING */
11136 Zero(my_perl, 1, PerlInterpreter);
11137 # endif /* DEBUGGING */
11138 #endif /* PERL_IMPLICIT_SYS */
11139 param->flags = flags;
11140 param->proto_perl = proto_perl;
11142 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11144 PL_body_arenas = NULL;
11145 Zero(&PL_body_roots, 1, PL_body_roots);
11147 PL_nice_chunk = NULL;
11148 PL_nice_chunk_size = 0;
11150 PL_sv_objcount = 0;
11152 PL_sv_arenaroot = NULL;
11154 PL_debug = proto_perl->Idebug;
11156 PL_hash_seed = proto_perl->Ihash_seed;
11157 PL_rehash_seed = proto_perl->Irehash_seed;
11159 #ifdef USE_REENTRANT_API
11160 /* XXX: things like -Dm will segfault here in perlio, but doing
11161 * PERL_SET_CONTEXT(proto_perl);
11162 * breaks too many other things
11164 Perl_reentrant_init(aTHX);
11167 /* create SV map for pointer relocation */
11168 PL_ptr_table = ptr_table_new();
11170 /* initialize these special pointers as early as possible */
11171 SvANY(&PL_sv_undef) = NULL;
11172 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11173 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11174 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11176 SvANY(&PL_sv_no) = new_XPVNV();
11177 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11178 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11179 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11180 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11181 SvCUR_set(&PL_sv_no, 0);
11182 SvLEN_set(&PL_sv_no, 1);
11183 SvIV_set(&PL_sv_no, 0);
11184 SvNV_set(&PL_sv_no, 0);
11185 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11187 SvANY(&PL_sv_yes) = new_XPVNV();
11188 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11189 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11190 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11191 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11192 SvCUR_set(&PL_sv_yes, 1);
11193 SvLEN_set(&PL_sv_yes, 2);
11194 SvIV_set(&PL_sv_yes, 1);
11195 SvNV_set(&PL_sv_yes, 1);
11196 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11198 /* create (a non-shared!) shared string table */
11199 PL_strtab = newHV();
11200 HvSHAREKEYS_off(PL_strtab);
11201 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11202 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11204 PL_compiling = proto_perl->Icompiling;
11206 /* These two PVs will be free'd special way so must set them same way op.c does */
11207 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11208 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11210 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11211 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11213 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11214 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11215 if (PL_compiling.cop_hints_hash) {
11217 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11218 HINTS_REFCNT_UNLOCK;
11220 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11221 #ifdef PERL_DEBUG_READONLY_OPS
11226 /* pseudo environmental stuff */
11227 PL_origargc = proto_perl->Iorigargc;
11228 PL_origargv = proto_perl->Iorigargv;
11230 param->stashes = newAV(); /* Setup array of objects to call clone on */
11232 /* Set tainting stuff before PerlIO_debug can possibly get called */
11233 PL_tainting = proto_perl->Itainting;
11234 PL_taint_warn = proto_perl->Itaint_warn;
11236 #ifdef PERLIO_LAYERS
11237 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11238 PerlIO_clone(aTHX_ proto_perl, param);
11241 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11242 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11243 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11244 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11245 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11246 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11249 PL_minus_c = proto_perl->Iminus_c;
11250 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11251 PL_localpatches = proto_perl->Ilocalpatches;
11252 PL_splitstr = proto_perl->Isplitstr;
11253 PL_minus_n = proto_perl->Iminus_n;
11254 PL_minus_p = proto_perl->Iminus_p;
11255 PL_minus_l = proto_perl->Iminus_l;
11256 PL_minus_a = proto_perl->Iminus_a;
11257 PL_minus_E = proto_perl->Iminus_E;
11258 PL_minus_F = proto_perl->Iminus_F;
11259 PL_doswitches = proto_perl->Idoswitches;
11260 PL_dowarn = proto_perl->Idowarn;
11261 PL_doextract = proto_perl->Idoextract;
11262 PL_sawampersand = proto_perl->Isawampersand;
11263 PL_unsafe = proto_perl->Iunsafe;
11264 PL_inplace = SAVEPV(proto_perl->Iinplace);
11265 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11266 PL_perldb = proto_perl->Iperldb;
11267 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11268 PL_exit_flags = proto_perl->Iexit_flags;
11270 /* magical thingies */
11271 /* XXX time(&PL_basetime) when asked for? */
11272 PL_basetime = proto_perl->Ibasetime;
11273 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11275 PL_maxsysfd = proto_perl->Imaxsysfd;
11276 PL_statusvalue = proto_perl->Istatusvalue;
11278 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11280 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11282 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11284 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11285 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11286 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11289 /* RE engine related */
11290 Zero(&PL_reg_state, 1, struct re_save_state);
11291 PL_reginterp_cnt = 0;
11292 PL_regmatch_slab = NULL;
11294 /* Clone the regex array */
11295 /* ORANGE FIXME for plugins, probably in the SV dup code.
11296 newSViv(PTR2IV(CALLREGDUPE(
11297 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11299 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11300 PL_regex_pad = AvARRAY(PL_regex_padav);
11302 /* shortcuts to various I/O objects */
11303 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11304 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11305 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11306 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11307 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11308 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11310 /* shortcuts to regexp stuff */
11311 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11313 /* shortcuts to misc objects */
11314 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11316 /* shortcuts to debugging objects */
11317 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11318 PL_DBline = gv_dup(proto_perl->IDBline, param);
11319 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11320 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11321 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11322 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11323 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11325 /* symbol tables */
11326 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11327 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11328 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11329 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11330 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11332 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11333 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11334 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11335 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11336 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11337 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11338 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11339 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11341 PL_sub_generation = proto_perl->Isub_generation;
11342 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11344 /* funky return mechanisms */
11345 PL_forkprocess = proto_perl->Iforkprocess;
11347 /* subprocess state */
11348 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11350 /* internal state */
11351 PL_maxo = proto_perl->Imaxo;
11352 if (proto_perl->Iop_mask)
11353 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11356 /* PL_asserting = proto_perl->Iasserting; */
11358 /* current interpreter roots */
11359 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11361 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11363 PL_main_start = proto_perl->Imain_start;
11364 PL_eval_root = proto_perl->Ieval_root;
11365 PL_eval_start = proto_perl->Ieval_start;
11367 /* runtime control stuff */
11368 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11370 PL_filemode = proto_perl->Ifilemode;
11371 PL_lastfd = proto_perl->Ilastfd;
11372 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11375 PL_gensym = proto_perl->Igensym;
11376 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11377 PL_laststatval = proto_perl->Ilaststatval;
11378 PL_laststype = proto_perl->Ilaststype;
11381 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11383 /* interpreter atexit processing */
11384 PL_exitlistlen = proto_perl->Iexitlistlen;
11385 if (PL_exitlistlen) {
11386 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11387 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11390 PL_exitlist = (PerlExitListEntry*)NULL;
11392 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11393 if (PL_my_cxt_size) {
11394 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11395 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11396 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11397 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11398 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11402 PL_my_cxt_list = (void**)NULL;
11403 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11404 PL_my_cxt_keys = (const char**)NULL;
11407 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11408 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11409 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11411 PL_profiledata = NULL;
11413 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11415 PAD_CLONE_VARS(proto_perl, param);
11417 #ifdef HAVE_INTERP_INTERN
11418 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11421 /* more statics moved here */
11422 PL_generation = proto_perl->Igeneration;
11423 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11425 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11426 PL_in_clean_all = proto_perl->Iin_clean_all;
11428 PL_uid = proto_perl->Iuid;
11429 PL_euid = proto_perl->Ieuid;
11430 PL_gid = proto_perl->Igid;
11431 PL_egid = proto_perl->Iegid;
11432 PL_nomemok = proto_perl->Inomemok;
11433 PL_an = proto_perl->Ian;
11434 PL_evalseq = proto_perl->Ievalseq;
11435 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11436 PL_origalen = proto_perl->Iorigalen;
11437 #ifdef PERL_USES_PL_PIDSTATUS
11438 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11440 PL_osname = SAVEPV(proto_perl->Iosname);
11441 PL_sighandlerp = proto_perl->Isighandlerp;
11443 PL_runops = proto_perl->Irunops;
11445 PL_parser = parser_dup(proto_perl->Iparser, param);
11447 PL_subline = proto_perl->Isubline;
11448 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11451 PL_cryptseen = proto_perl->Icryptseen;
11454 PL_hints = proto_perl->Ihints;
11456 PL_amagic_generation = proto_perl->Iamagic_generation;
11458 #ifdef USE_LOCALE_COLLATE
11459 PL_collation_ix = proto_perl->Icollation_ix;
11460 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11461 PL_collation_standard = proto_perl->Icollation_standard;
11462 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11463 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11464 #endif /* USE_LOCALE_COLLATE */
11466 #ifdef USE_LOCALE_NUMERIC
11467 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11468 PL_numeric_standard = proto_perl->Inumeric_standard;
11469 PL_numeric_local = proto_perl->Inumeric_local;
11470 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11471 #endif /* !USE_LOCALE_NUMERIC */
11473 /* utf8 character classes */
11474 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11475 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11476 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11477 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11478 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11479 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11480 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11481 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11482 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11483 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11484 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11485 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11486 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11487 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11488 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11489 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11490 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11491 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11492 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11493 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11495 /* Did the locale setup indicate UTF-8? */
11496 PL_utf8locale = proto_perl->Iutf8locale;
11497 /* Unicode features (see perlrun/-C) */
11498 PL_unicode = proto_perl->Iunicode;
11500 /* Pre-5.8 signals control */
11501 PL_signals = proto_perl->Isignals;
11503 /* times() ticks per second */
11504 PL_clocktick = proto_perl->Iclocktick;
11506 /* Recursion stopper for PerlIO_find_layer */
11507 PL_in_load_module = proto_perl->Iin_load_module;
11509 /* sort() routine */
11510 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11512 /* Not really needed/useful since the reenrant_retint is "volatile",
11513 * but do it for consistency's sake. */
11514 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11516 /* Hooks to shared SVs and locks. */
11517 PL_sharehook = proto_perl->Isharehook;
11518 PL_lockhook = proto_perl->Ilockhook;
11519 PL_unlockhook = proto_perl->Iunlockhook;
11520 PL_threadhook = proto_perl->Ithreadhook;
11521 PL_destroyhook = proto_perl->Idestroyhook;
11523 #ifdef THREADS_HAVE_PIDS
11524 PL_ppid = proto_perl->Ippid;
11528 PL_last_swash_hv = NULL; /* reinits on demand */
11529 PL_last_swash_klen = 0;
11530 PL_last_swash_key[0]= '\0';
11531 PL_last_swash_tmps = (U8*)NULL;
11532 PL_last_swash_slen = 0;
11534 PL_glob_index = proto_perl->Iglob_index;
11535 PL_srand_called = proto_perl->Isrand_called;
11536 PL_bitcount = NULL; /* reinits on demand */
11538 if (proto_perl->Ipsig_pend) {
11539 Newxz(PL_psig_pend, SIG_SIZE, int);
11542 PL_psig_pend = (int*)NULL;
11545 if (proto_perl->Ipsig_ptr) {
11546 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11547 Newxz(PL_psig_name, SIG_SIZE, SV*);
11548 for (i = 1; i < SIG_SIZE; i++) {
11549 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11550 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11554 PL_psig_ptr = (SV**)NULL;
11555 PL_psig_name = (SV**)NULL;
11558 /* intrpvar.h stuff */
11560 if (flags & CLONEf_COPY_STACKS) {
11561 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11562 PL_tmps_ix = proto_perl->Itmps_ix;
11563 PL_tmps_max = proto_perl->Itmps_max;
11564 PL_tmps_floor = proto_perl->Itmps_floor;
11565 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11567 while (i <= PL_tmps_ix) {
11568 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11572 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11573 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11574 Newxz(PL_markstack, i, I32);
11575 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11576 - proto_perl->Imarkstack);
11577 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11578 - proto_perl->Imarkstack);
11579 Copy(proto_perl->Imarkstack, PL_markstack,
11580 PL_markstack_ptr - PL_markstack + 1, I32);
11582 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11583 * NOTE: unlike the others! */
11584 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11585 PL_scopestack_max = proto_perl->Iscopestack_max;
11586 Newxz(PL_scopestack, PL_scopestack_max, I32);
11587 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11589 /* NOTE: si_dup() looks at PL_markstack */
11590 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11592 /* PL_curstack = PL_curstackinfo->si_stack; */
11593 PL_curstack = av_dup(proto_perl->Icurstack, param);
11594 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11596 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11597 PL_stack_base = AvARRAY(PL_curstack);
11598 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11599 - proto_perl->Istack_base);
11600 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11602 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11603 * NOTE: unlike the others! */
11604 PL_savestack_ix = proto_perl->Isavestack_ix;
11605 PL_savestack_max = proto_perl->Isavestack_max;
11606 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11607 PL_savestack = ss_dup(proto_perl, param);
11611 ENTER; /* perl_destruct() wants to LEAVE; */
11613 /* although we're not duplicating the tmps stack, we should still
11614 * add entries for any SVs on the tmps stack that got cloned by a
11615 * non-refcount means (eg a temp in @_); otherwise they will be
11618 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11619 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11620 proto_perl->Itmps_stack[i]);
11621 if (nsv && !SvREFCNT(nsv)) {
11623 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11628 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11629 PL_top_env = &PL_start_env;
11631 PL_op = proto_perl->Iop;
11634 PL_Xpv = (XPV*)NULL;
11635 my_perl->Ina = proto_perl->Ina;
11637 PL_statbuf = proto_perl->Istatbuf;
11638 PL_statcache = proto_perl->Istatcache;
11639 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11640 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11642 PL_timesbuf = proto_perl->Itimesbuf;
11645 PL_tainted = proto_perl->Itainted;
11646 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11647 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11648 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11649 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11650 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11651 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11652 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11653 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11654 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11656 PL_restartop = proto_perl->Irestartop;
11657 PL_in_eval = proto_perl->Iin_eval;
11658 PL_delaymagic = proto_perl->Idelaymagic;
11659 PL_dirty = proto_perl->Idirty;
11660 PL_localizing = proto_perl->Ilocalizing;
11662 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11663 PL_hv_fetch_ent_mh = NULL;
11664 PL_modcount = proto_perl->Imodcount;
11665 PL_lastgotoprobe = NULL;
11666 PL_dumpindent = proto_perl->Idumpindent;
11668 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11669 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11670 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11671 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11672 PL_efloatbuf = NULL; /* reinits on demand */
11673 PL_efloatsize = 0; /* reinits on demand */
11677 PL_screamfirst = NULL;
11678 PL_screamnext = NULL;
11679 PL_maxscream = -1; /* reinits on demand */
11680 PL_lastscream = NULL;
11683 PL_regdummy = proto_perl->Iregdummy;
11684 PL_colorset = 0; /* reinits PL_colors[] */
11685 /*PL_colors[6] = {0,0,0,0,0,0};*/
11689 /* Pluggable optimizer */
11690 PL_peepp = proto_perl->Ipeepp;
11692 PL_stashcache = newHV();
11694 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11695 proto_perl->Iwatchaddr);
11696 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11697 if (PL_debug && PL_watchaddr) {
11698 PerlIO_printf(Perl_debug_log,
11699 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11700 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11701 PTR2UV(PL_watchok));
11704 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11705 ptr_table_free(PL_ptr_table);
11706 PL_ptr_table = NULL;
11709 /* Call the ->CLONE method, if it exists, for each of the stashes
11710 identified by sv_dup() above.
11712 while(av_len(param->stashes) != -1) {
11713 HV* const stash = (HV*) av_shift(param->stashes);
11714 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11715 if (cloner && GvCV(cloner)) {
11720 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11722 call_sv((SV*)GvCV(cloner), G_DISCARD);
11728 SvREFCNT_dec(param->stashes);
11730 /* orphaned? eg threads->new inside BEGIN or use */
11731 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11732 SvREFCNT_inc_simple_void(PL_compcv);
11733 SAVEFREESV(PL_compcv);
11739 #endif /* USE_ITHREADS */
11742 =head1 Unicode Support
11744 =for apidoc sv_recode_to_utf8
11746 The encoding is assumed to be an Encode object, on entry the PV
11747 of the sv is assumed to be octets in that encoding, and the sv
11748 will be converted into Unicode (and UTF-8).
11750 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11751 is not a reference, nothing is done to the sv. If the encoding is not
11752 an C<Encode::XS> Encoding object, bad things will happen.
11753 (See F<lib/encoding.pm> and L<Encode>).
11755 The PV of the sv is returned.
11760 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11763 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11777 Passing sv_yes is wrong - it needs to be or'ed set of constants
11778 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11779 remove converted chars from source.
11781 Both will default the value - let them.
11783 XPUSHs(&PL_sv_yes);
11786 call_method("decode", G_SCALAR);
11790 s = SvPV_const(uni, len);
11791 if (s != SvPVX_const(sv)) {
11792 SvGROW(sv, len + 1);
11793 Move(s, SvPVX(sv), len + 1, char);
11794 SvCUR_set(sv, len);
11801 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11805 =for apidoc sv_cat_decode
11807 The encoding is assumed to be an Encode object, the PV of the ssv is
11808 assumed to be octets in that encoding and decoding the input starts
11809 from the position which (PV + *offset) pointed to. The dsv will be
11810 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11811 when the string tstr appears in decoding output or the input ends on
11812 the PV of the ssv. The value which the offset points will be modified
11813 to the last input position on the ssv.
11815 Returns TRUE if the terminator was found, else returns FALSE.
11820 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11821 SV *ssv, int *offset, char *tstr, int tlen)
11825 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11836 offsv = newSViv(*offset);
11838 mXPUSHp(tstr, tlen);
11840 call_method("cat_decode", G_SCALAR);
11842 ret = SvTRUE(TOPs);
11843 *offset = SvIV(offsv);
11849 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11854 /* ---------------------------------------------------------------------
11856 * support functions for report_uninit()
11859 /* the maxiumum size of array or hash where we will scan looking
11860 * for the undefined element that triggered the warning */
11862 #define FUV_MAX_SEARCH_SIZE 1000
11864 /* Look for an entry in the hash whose value has the same SV as val;
11865 * If so, return a mortal copy of the key. */
11868 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11871 register HE **array;
11874 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11875 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11878 array = HvARRAY(hv);
11880 for (i=HvMAX(hv); i>0; i--) {
11881 register HE *entry;
11882 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11883 if (HeVAL(entry) != val)
11885 if ( HeVAL(entry) == &PL_sv_undef ||
11886 HeVAL(entry) == &PL_sv_placeholder)
11890 if (HeKLEN(entry) == HEf_SVKEY)
11891 return sv_mortalcopy(HeKEY_sv(entry));
11892 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11898 /* Look for an entry in the array whose value has the same SV as val;
11899 * If so, return the index, otherwise return -1. */
11902 S_find_array_subscript(pTHX_ AV *av, SV* val)
11905 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11906 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11909 if (val != &PL_sv_undef) {
11910 SV ** const svp = AvARRAY(av);
11913 for (i=AvFILLp(av); i>=0; i--)
11920 /* S_varname(): return the name of a variable, optionally with a subscript.
11921 * If gv is non-zero, use the name of that global, along with gvtype (one
11922 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11923 * targ. Depending on the value of the subscript_type flag, return:
11926 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11927 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11928 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11929 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11932 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11933 SV* keyname, I32 aindex, int subscript_type)
11936 SV * const name = sv_newmortal();
11939 buffer[0] = gvtype;
11942 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11944 gv_fullname4(name, gv, buffer, 0);
11946 if ((unsigned int)SvPVX(name)[1] <= 26) {
11948 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11950 /* Swap the 1 unprintable control character for the 2 byte pretty
11951 version - ie substr($name, 1, 1) = $buffer; */
11952 sv_insert(name, 1, 1, buffer, 2);
11956 CV * const cv = find_runcv(NULL);
11960 if (!cv || !CvPADLIST(cv))
11962 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11963 sv = *av_fetch(av, targ, FALSE);
11964 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11967 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11968 SV * const sv = newSV(0);
11969 *SvPVX(name) = '$';
11970 Perl_sv_catpvf(aTHX_ name, "{%s}",
11971 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11974 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11975 *SvPVX(name) = '$';
11976 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11978 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11979 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11986 =for apidoc find_uninit_var
11988 Find the name of the undefined variable (if any) that caused the operator o
11989 to issue a "Use of uninitialized value" warning.
11990 If match is true, only return a name if it's value matches uninit_sv.
11991 So roughly speaking, if a unary operator (such as OP_COS) generates a
11992 warning, then following the direct child of the op may yield an
11993 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11994 other hand, with OP_ADD there are two branches to follow, so we only print
11995 the variable name if we get an exact match.
11997 The name is returned as a mortal SV.
11999 Assumes that PL_op is the op that originally triggered the error, and that
12000 PL_comppad/PL_curpad points to the currently executing pad.
12006 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12014 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12015 uninit_sv == &PL_sv_placeholder)))
12018 switch (obase->op_type) {
12025 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12026 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12029 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12031 if (pad) { /* @lex, %lex */
12032 sv = PAD_SVl(obase->op_targ);
12036 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12037 /* @global, %global */
12038 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12041 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12043 else /* @{expr}, %{expr} */
12044 return find_uninit_var(cUNOPx(obase)->op_first,
12048 /* attempt to find a match within the aggregate */
12050 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12052 subscript_type = FUV_SUBSCRIPT_HASH;
12055 index = find_array_subscript((AV*)sv, uninit_sv);
12057 subscript_type = FUV_SUBSCRIPT_ARRAY;
12060 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12063 return varname(gv, hash ? '%' : '@', obase->op_targ,
12064 keysv, index, subscript_type);
12068 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12070 return varname(NULL, '$', obase->op_targ,
12071 NULL, 0, FUV_SUBSCRIPT_NONE);
12074 gv = cGVOPx_gv(obase);
12075 if (!gv || (match && GvSV(gv) != uninit_sv))
12077 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12080 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12083 av = (AV*)PAD_SV(obase->op_targ);
12084 if (!av || SvRMAGICAL(av))
12086 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12087 if (!svp || *svp != uninit_sv)
12090 return varname(NULL, '$', obase->op_targ,
12091 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12094 gv = cGVOPx_gv(obase);
12100 if (!av || SvRMAGICAL(av))
12102 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12103 if (!svp || *svp != uninit_sv)
12106 return varname(gv, '$', 0,
12107 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12112 o = cUNOPx(obase)->op_first;
12113 if (!o || o->op_type != OP_NULL ||
12114 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12116 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12120 if (PL_op == obase)
12121 /* $a[uninit_expr] or $h{uninit_expr} */
12122 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12125 o = cBINOPx(obase)->op_first;
12126 kid = cBINOPx(obase)->op_last;
12128 /* get the av or hv, and optionally the gv */
12130 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12131 sv = PAD_SV(o->op_targ);
12133 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12134 && cUNOPo->op_first->op_type == OP_GV)
12136 gv = cGVOPx_gv(cUNOPo->op_first);
12139 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12144 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12145 /* index is constant */
12149 if (obase->op_type == OP_HELEM) {
12150 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12151 if (!he || HeVAL(he) != uninit_sv)
12155 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12156 if (!svp || *svp != uninit_sv)
12160 if (obase->op_type == OP_HELEM)
12161 return varname(gv, '%', o->op_targ,
12162 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12164 return varname(gv, '@', o->op_targ, NULL,
12165 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12168 /* index is an expression;
12169 * attempt to find a match within the aggregate */
12170 if (obase->op_type == OP_HELEM) {
12171 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12173 return varname(gv, '%', o->op_targ,
12174 keysv, 0, FUV_SUBSCRIPT_HASH);
12177 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12179 return varname(gv, '@', o->op_targ,
12180 NULL, index, FUV_SUBSCRIPT_ARRAY);
12185 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12187 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12192 /* only examine RHS */
12193 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12196 o = cUNOPx(obase)->op_first;
12197 if (o->op_type == OP_PUSHMARK)
12200 if (!o->op_sibling) {
12201 /* one-arg version of open is highly magical */
12203 if (o->op_type == OP_GV) { /* open FOO; */
12205 if (match && GvSV(gv) != uninit_sv)
12207 return varname(gv, '$', 0,
12208 NULL, 0, FUV_SUBSCRIPT_NONE);
12210 /* other possibilities not handled are:
12211 * open $x; or open my $x; should return '${*$x}'
12212 * open expr; should return '$'.expr ideally
12218 /* ops where $_ may be an implicit arg */
12222 if ( !(obase->op_flags & OPf_STACKED)) {
12223 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12224 ? PAD_SVl(obase->op_targ)
12227 sv = sv_newmortal();
12228 sv_setpvn(sv, "$_", 2);
12237 /* skip filehandle as it can't produce 'undef' warning */
12238 o = cUNOPx(obase)->op_first;
12239 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12240 o = o->op_sibling->op_sibling;
12246 match = 1; /* XS or custom code could trigger random warnings */
12251 /* XXX tmp hack: these two may call an XS sub, and currently
12252 XS subs don't have a SUB entry on the context stack, so CV and
12253 pad determination goes wrong, and BAD things happen. So, just
12254 don't try to determine the value under those circumstances.
12255 Need a better fix at dome point. DAPM 11/2007 */
12259 /* def-ness of rval pos() is independent of the def-ness of its arg */
12260 if ( !(obase->op_flags & OPf_MOD))
12265 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12266 return newSVpvs_flags("${$/}", SVs_TEMP);
12271 if (!(obase->op_flags & OPf_KIDS))
12273 o = cUNOPx(obase)->op_first;
12279 /* if all except one arg are constant, or have no side-effects,
12280 * or are optimized away, then it's unambiguous */
12282 for (kid=o; kid; kid = kid->op_sibling) {
12284 const OPCODE type = kid->op_type;
12285 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12286 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12287 || (type == OP_PUSHMARK)
12291 if (o2) { /* more than one found */
12298 return find_uninit_var(o2, uninit_sv, match);
12300 /* scan all args */
12302 sv = find_uninit_var(o, uninit_sv, 1);
12314 =for apidoc report_uninit
12316 Print appropriate "Use of uninitialized variable" warning
12322 Perl_report_uninit(pTHX_ SV* uninit_sv)
12326 SV* varname = NULL;
12328 varname = find_uninit_var(PL_op, uninit_sv,0);
12330 sv_insert(varname, 0, 0, " ", 1);
12332 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12333 varname ? SvPV_nolen_const(varname) : "",
12334 " in ", OP_DESC(PL_op));
12337 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12343 * c-indentation-style: bsd
12344 * c-basic-offset: 4
12345 * indent-tabs-mode: t
12348 * ex: set ts=8 sts=4 sw=4 noet: