3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = NULL;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 ARENASETS: a meta-arena implementation which separates arena-info
561 into struct arena_set, which contains an array of struct
562 arena_descs, each holding info for a single arena. By separating
563 the meta-info from the arena, we recover the 1st slot, formerly
564 borrowed for list management. The arena_set is about the size of an
565 arena, avoiding the needless malloc overhead of a naive linked-list
567 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
568 memory in the last arena-set (1/2 on average). In trade, we get
569 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
572 union arena is declared with a fixed size, but is intended to vary
573 by type, allowing their use for big, rare body-types where theres
574 currently too much wastage (unused arena slots)
579 char *arena; /* the raw storage, allocated aligned */
580 size_t size; /* its size ~4k typ */
581 int unit_type; /* useful for arena audits */
582 /* info for sv-heads (eventually)
589 /* Get the maximum number of elements in set[] such that struct arena_set
590 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
591 therefore likely to be 1 aligned memory page. */
593 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
594 - 2 * sizeof(int)) / sizeof (struct arena_desc))
597 struct arena_set* next;
598 int set_size; /* ie ARENAS_PER_SET */
599 int curr; /* index of next available arena-desc */
600 struct arena_desc set[ARENAS_PER_SET];
606 S_free_arena(pTHX_ void **root) {
608 void ** const next = *(void **)root;
616 =for apidoc sv_free_arenas
618 Deallocate the memory used by all arenas. Note that all the individual SV
619 heads and bodies within the arenas must already have been freed.
624 Perl_sv_free_arenas(pTHX)
631 /* Free arenas here, but be careful about fake ones. (We assume
632 contiguity of the fake ones with the corresponding real ones.) */
634 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
635 svanext = (SV*) SvANY(sva);
636 while (svanext && SvFAKE(svanext))
637 svanext = (SV*) SvANY(svanext);
645 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
647 for (; aroot; aroot = next) {
648 int max = aroot->curr;
649 for (i=0; i<max; i++) {
650 assert(aroot->set[i].arena);
651 Safefree(aroot->set[i].arena);
658 S_free_arena(aTHX_ (void**) PL_body_arenas);
661 for (i=0; i<SVt_LAST; i++)
662 PL_body_roots[i] = 0;
664 Safefree(PL_nice_chunk);
665 PL_nice_chunk = NULL;
666 PL_nice_chunk_size = 0;
672 Here are mid-level routines that manage the allocation of bodies out
673 of the various arenas. There are 5 kinds of arenas:
675 1. SV-head arenas, which are discussed and handled above
676 2. regular body arenas
677 3. arenas for reduced-size bodies
679 5. pte arenas (thread related)
681 Arena types 2 & 3 are chained by body-type off an array of
682 arena-root pointers, which is indexed by svtype. Some of the
683 larger/less used body types are malloced singly, since a large
684 unused block of them is wasteful. Also, several svtypes dont have
685 bodies; the data fits into the sv-head itself. The arena-root
686 pointer thus has a few unused root-pointers (which may be hijacked
687 later for arena types 4,5)
689 3 differs from 2 as an optimization; some body types have several
690 unused fields in the front of the structure (which are kept in-place
691 for consistency). These bodies can be allocated in smaller chunks,
692 because the leading fields arent accessed. Pointers to such bodies
693 are decremented to point at the unused 'ghost' memory, knowing that
694 the pointers are used with offsets to the real memory.
696 HE, HEK arenas are managed separately, with separate code, but may
697 be merge-able later..
699 PTE arenas are not sv-bodies, but they share these mid-level
700 mechanics, so are considered here. The new mid-level mechanics rely
701 on the sv_type of the body being allocated, so we just reserve one
702 of the unused body-slots for PTEs, then use it in those (2) PTE
703 contexts below (line ~10k)
706 /* get_arena(size): when ARENASETS is enabled, this creates
707 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
709 TBD: export properly for hv.c: S_more_he().
712 Perl_get_arena(pTHX_ int arena_size)
717 /* allocate and attach arena */
718 Newx(arp, PERL_ARENA_SIZE, char);
719 arp->next = PL_body_arenas;
720 PL_body_arenas = arp;
724 struct arena_desc* adesc;
725 struct arena_set *newroot, *aroot = (struct arena_set*) PL_body_arenas;
729 arena_size = PERL_ARENA_SIZE;
731 /* may need new arena-set to hold new arena */
732 if (!aroot || aroot->curr >= aroot->set_size) {
733 Newxz(newroot, 1, struct arena_set);
734 newroot->set_size = ARENAS_PER_SET;
735 newroot->next = aroot;
737 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", aroot));
740 /* ok, now have arena-set with at least 1 empty/available arena-desc */
741 curr = aroot->curr++;
742 adesc = &aroot->set[curr];
743 assert(!adesc->arena);
745 /* old fixed-size way
746 Newxz(adesc->arena, 1, union arena);
747 adesc->size = sizeof(union arena);
750 Newxz(adesc->arena, arena_size, char);
751 adesc->size = arena_size;
753 /* adesc->count = sizeof(struct arena)/size; */
755 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p\n", curr, aroot));
762 S_more_bodies (pTHX_ size_t size, svtype sv_type)
765 void ** const root = &PL_body_roots[sv_type];
768 const size_t count = PERL_ARENA_SIZE / size;
770 start = (char*) Perl_get_arena(aTHX_ PERL_ARENA_SIZE); /* get a raw arena */
772 end = start + (count-1) * size;
775 /* The initial slot is used to link the arenas together, so it isn't to be
776 linked into the list of ready-to-use bodies. */
780 *root = (void *)start;
782 while (start < end) {
783 char * const next = start + size;
784 *(void**) start = (void *)next;
792 /* grab a new thing from the free list, allocating more if necessary */
794 /* 1st, the inline version */
796 #define new_body_inline(xpv, size, sv_type) \
798 void ** const r3wt = &PL_body_roots[sv_type]; \
800 xpv = *((void **)(r3wt)) \
801 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
802 *(r3wt) = *(void**)(xpv); \
806 /* now use the inline version in the proper function */
810 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
811 compilers issue warnings. */
814 S_new_body(pTHX_ size_t size, svtype sv_type)
818 new_body_inline(xpv, size, sv_type);
824 /* return a thing to the free list */
826 #define del_body(thing, root) \
828 void ** const thing_copy = (void **)thing;\
830 *thing_copy = *root; \
831 *root = (void*)thing_copy; \
836 Revisiting type 3 arenas, there are 4 body-types which have some
837 members that are never accessed. They are XPV, XPVIV, XPVAV,
838 XPVHV, which have corresponding types: xpv_allocated,
839 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
841 For these types, the arenas are carved up into *_allocated size
842 chunks, we thus avoid wasted memory for those unaccessed members.
843 When bodies are allocated, we adjust the pointer back in memory by
844 the size of the bit not allocated, so it's as if we allocated the
845 full structure. (But things will all go boom if you write to the
846 part that is "not there", because you'll be overwriting the last
847 members of the preceding structure in memory.)
849 We calculate the correction using the STRUCT_OFFSET macro. For example, if
850 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
851 and the pointer is unchanged. If the allocated structure is smaller (no
852 initial NV actually allocated) then the net effect is to subtract the size
853 of the NV from the pointer, to return a new pointer as if an initial NV were
856 This is the same trick as was used for NV and IV bodies. Ironically it
857 doesn't need to be used for NV bodies any more, because NV is now at the
858 start of the structure. IV bodies don't need it either, because they are
859 no longer allocated. */
861 /* The following 2 arrays hide the above details in a pair of
862 lookup-tables, allowing us to be body-type agnostic.
864 size maps svtype to its body's allocated size.
865 offset maps svtype to the body-pointer adjustment needed
867 NB: elements in latter are 0 or <0, and are added during
868 allocation, and subtracted during deallocation. It may be clearer
869 to invert the values, and call it shrinkage_by_svtype.
872 struct body_details {
873 size_t size; /* Size to allocate */
874 size_t copy; /* Size of structure to copy (may be shorter) */
876 bool cant_upgrade; /* Can upgrade this type */
877 bool zero_nv; /* zero the NV when upgrading from this */
878 bool arena; /* Allocated from an arena */
885 /* With -DPURFIY we allocate everything directly, and don't use arenas.
886 This seems a rather elegant way to simplify some of the code below. */
887 #define HASARENA FALSE
889 #define HASARENA TRUE
891 #define NOARENA FALSE
893 /* A macro to work out the offset needed to subtract from a pointer to (say)
900 to make its members accessible via a pointer to (say)
910 #define relative_STRUCT_OFFSET(longer, shorter, member) \
911 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
913 /* Calculate the length to copy. Specifically work out the length less any
914 final padding the compiler needed to add. See the comment in sv_upgrade
915 for why copying the padding proved to be a bug. */
917 #define copy_length(type, last_member) \
918 STRUCT_OFFSET(type, last_member) \
919 + sizeof (((type*)SvANY((SV*)0))->last_member)
921 static const struct body_details bodies_by_type[] = {
922 {0, 0, 0, FALSE, NONV, NOARENA},
923 /* IVs are in the head, so the allocation size is 0 */
924 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
925 /* 8 bytes on most ILP32 with IEEE doubles */
926 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
927 /* RVs are in the head now */
928 /* However, this slot is overloaded and used by the pte */
929 {0, 0, 0, FALSE, NONV, NOARENA},
930 /* 8 bytes on most ILP32 with IEEE doubles */
931 {sizeof(xpv_allocated),
932 copy_length(XPV, xpv_len)
933 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
934 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
935 FALSE, NONV, HASARENA},
937 {sizeof(xpviv_allocated),
938 copy_length(XPVIV, xiv_u)
939 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
940 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
941 FALSE, NONV, HASARENA},
943 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
945 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
947 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
949 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
951 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
953 {sizeof(xpvav_allocated),
954 copy_length(XPVAV, xmg_stash)
955 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
956 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
957 TRUE, HADNV, HASARENA},
959 {sizeof(xpvhv_allocated),
960 copy_length(XPVHV, xmg_stash)
961 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
962 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
963 TRUE, HADNV, HASARENA},
965 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
967 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
969 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
972 #define new_body_type(sv_type) \
973 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
974 - bodies_by_type[sv_type].offset)
976 #define del_body_type(p, sv_type) \
977 del_body(p, &PL_body_roots[sv_type])
980 #define new_body_allocated(sv_type) \
981 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
982 - bodies_by_type[sv_type].offset)
984 #define del_body_allocated(p, sv_type) \
985 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
988 #define my_safemalloc(s) (void*)safemalloc(s)
989 #define my_safecalloc(s) (void*)safecalloc(s, 1)
990 #define my_safefree(p) safefree((char*)p)
994 #define new_XNV() my_safemalloc(sizeof(XPVNV))
995 #define del_XNV(p) my_safefree(p)
997 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
998 #define del_XPVNV(p) my_safefree(p)
1000 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1001 #define del_XPVAV(p) my_safefree(p)
1003 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1004 #define del_XPVHV(p) my_safefree(p)
1006 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1007 #define del_XPVMG(p) my_safefree(p)
1009 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1010 #define del_XPVGV(p) my_safefree(p)
1014 #define new_XNV() new_body_type(SVt_NV)
1015 #define del_XNV(p) del_body_type(p, SVt_NV)
1017 #define new_XPVNV() new_body_type(SVt_PVNV)
1018 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1020 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1021 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1023 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1024 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1026 #define new_XPVMG() new_body_type(SVt_PVMG)
1027 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1029 #define new_XPVGV() new_body_type(SVt_PVGV)
1030 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1034 /* no arena for you! */
1036 #define new_NOARENA(details) \
1037 my_safemalloc((details)->size + (details)->offset)
1038 #define new_NOARENAZ(details) \
1039 my_safecalloc((details)->size + (details)->offset)
1042 =for apidoc sv_upgrade
1044 Upgrade an SV to a more complex form. Generally adds a new body type to the
1045 SV, then copies across as much information as possible from the old body.
1046 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1052 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1057 const U32 old_type = SvTYPE(sv);
1058 const struct body_details *const old_type_details
1059 = bodies_by_type + old_type;
1060 const struct body_details *new_type_details = bodies_by_type + new_type;
1062 if (new_type != SVt_PV && SvIsCOW(sv)) {
1063 sv_force_normal_flags(sv, 0);
1066 if (old_type == new_type)
1069 if (old_type > new_type)
1070 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1071 (int)old_type, (int)new_type);
1074 old_body = SvANY(sv);
1076 /* Copying structures onto other structures that have been neatly zeroed
1077 has a subtle gotcha. Consider XPVMG
1079 +------+------+------+------+------+-------+-------+
1080 | NV | CUR | LEN | IV | MAGIC | STASH |
1081 +------+------+------+------+------+-------+-------+
1082 0 4 8 12 16 20 24 28
1084 where NVs are aligned to 8 bytes, so that sizeof that structure is
1085 actually 32 bytes long, with 4 bytes of padding at the end:
1087 +------+------+------+------+------+-------+-------+------+
1088 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1089 +------+------+------+------+------+-------+-------+------+
1090 0 4 8 12 16 20 24 28 32
1092 so what happens if you allocate memory for this structure:
1094 +------+------+------+------+------+-------+-------+------+------+...
1095 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1096 +------+------+------+------+------+-------+-------+------+------+...
1097 0 4 8 12 16 20 24 28 32 36
1099 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1100 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1101 started out as zero once, but it's quite possible that it isn't. So now,
1102 rather than a nicely zeroed GP, you have it pointing somewhere random.
1105 (In fact, GP ends up pointing at a previous GP structure, because the
1106 principle cause of the padding in XPVMG getting garbage is a copy of
1107 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1109 So we are careful and work out the size of used parts of all the
1116 if (new_type < SVt_PVIV) {
1117 new_type = (new_type == SVt_NV)
1118 ? SVt_PVNV : SVt_PVIV;
1119 new_type_details = bodies_by_type + new_type;
1123 if (new_type < SVt_PVNV) {
1124 new_type = SVt_PVNV;
1125 new_type_details = bodies_by_type + new_type;
1131 assert(new_type > SVt_PV);
1132 assert(SVt_IV < SVt_PV);
1133 assert(SVt_NV < SVt_PV);
1140 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1141 there's no way that it can be safely upgraded, because perl.c
1142 expects to Safefree(SvANY(PL_mess_sv)) */
1143 assert(sv != PL_mess_sv);
1144 /* This flag bit is used to mean other things in other scalar types.
1145 Given that it only has meaning inside the pad, it shouldn't be set
1146 on anything that can get upgraded. */
1147 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1150 if (old_type_details->cant_upgrade)
1151 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1154 SvFLAGS(sv) &= ~SVTYPEMASK;
1155 SvFLAGS(sv) |= new_type;
1157 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1158 the return statements above will have triggered. */
1159 assert (new_type != SVt_NULL);
1162 assert(old_type == SVt_NULL);
1163 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1167 assert(old_type == SVt_NULL);
1168 SvANY(sv) = new_XNV();
1172 assert(old_type == SVt_NULL);
1173 SvANY(sv) = &sv->sv_u.svu_rv;
1178 assert(new_type_details->size);
1181 assert(new_type_details->arena);
1182 /* This points to the start of the allocated area. */
1183 new_body_inline(new_body, new_type_details->size, new_type);
1184 Zero(new_body, new_type_details->size, char);
1185 new_body = ((char *)new_body) - new_type_details->offset;
1187 /* We always allocated the full length item with PURIFY. To do this
1188 we fake things so that arena is false for all 16 types.. */
1189 new_body = new_NOARENAZ(new_type_details);
1191 SvANY(sv) = new_body;
1192 if (new_type == SVt_PVAV) {
1198 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1199 The target created by newSVrv also is, and it can have magic.
1200 However, it never has SvPVX set.
1202 if (old_type >= SVt_RV) {
1203 assert(SvPVX_const(sv) == 0);
1206 /* Could put this in the else clause below, as PVMG must have SvPVX
1207 0 already (the assertion above) */
1210 if (old_type >= SVt_PVMG) {
1211 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1212 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1218 /* XXX Is this still needed? Was it ever needed? Surely as there is
1219 no route from NV to PVIV, NOK can never be true */
1220 assert(!SvNOKp(sv));
1232 assert(new_type_details->size);
1233 /* We always allocated the full length item with PURIFY. To do this
1234 we fake things so that arena is false for all 16 types.. */
1235 if(new_type_details->arena) {
1236 /* This points to the start of the allocated area. */
1237 new_body_inline(new_body, new_type_details->size, new_type);
1238 Zero(new_body, new_type_details->size, char);
1239 new_body = ((char *)new_body) - new_type_details->offset;
1241 new_body = new_NOARENAZ(new_type_details);
1243 SvANY(sv) = new_body;
1245 if (old_type_details->copy) {
1246 Copy((char *)old_body + old_type_details->offset,
1247 (char *)new_body + old_type_details->offset,
1248 old_type_details->copy, char);
1251 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1252 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1253 * correct 0.0 for us. Otherwise, if the old body didn't have an
1254 * NV slot, but the new one does, then we need to initialise the
1255 * freshly created NV slot with whatever the correct bit pattern is
1257 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1261 if (new_type == SVt_PVIO)
1262 IoPAGE_LEN(sv) = 60;
1263 if (old_type < SVt_RV)
1267 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1268 (unsigned long)new_type);
1271 if (old_type_details->size) {
1272 /* If the old body had an allocated size, then we need to free it. */
1274 my_safefree(old_body);
1276 del_body((void*)((char*)old_body + old_type_details->offset),
1277 &PL_body_roots[old_type]);
1283 =for apidoc sv_backoff
1285 Remove any string offset. You should normally use the C<SvOOK_off> macro
1292 Perl_sv_backoff(pTHX_ register SV *sv)
1295 assert(SvTYPE(sv) != SVt_PVHV);
1296 assert(SvTYPE(sv) != SVt_PVAV);
1298 const char * const s = SvPVX_const(sv);
1299 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1300 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1302 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1304 SvFLAGS(sv) &= ~SVf_OOK;
1311 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1312 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1313 Use the C<SvGROW> wrapper instead.
1319 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1323 #ifdef HAS_64K_LIMIT
1324 if (newlen >= 0x10000) {
1325 PerlIO_printf(Perl_debug_log,
1326 "Allocation too large: %"UVxf"\n", (UV)newlen);
1329 #endif /* HAS_64K_LIMIT */
1332 if (SvTYPE(sv) < SVt_PV) {
1333 sv_upgrade(sv, SVt_PV);
1334 s = SvPVX_mutable(sv);
1336 else if (SvOOK(sv)) { /* pv is offset? */
1338 s = SvPVX_mutable(sv);
1339 if (newlen > SvLEN(sv))
1340 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1341 #ifdef HAS_64K_LIMIT
1342 if (newlen >= 0x10000)
1347 s = SvPVX_mutable(sv);
1349 if (newlen > SvLEN(sv)) { /* need more room? */
1350 newlen = PERL_STRLEN_ROUNDUP(newlen);
1351 if (SvLEN(sv) && s) {
1353 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1359 s = saferealloc(s, newlen);
1362 s = safemalloc(newlen);
1363 if (SvPVX_const(sv) && SvCUR(sv)) {
1364 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1368 SvLEN_set(sv, newlen);
1374 =for apidoc sv_setiv
1376 Copies an integer into the given SV, upgrading first if necessary.
1377 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1383 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1386 SV_CHECK_THINKFIRST_COW_DROP(sv);
1387 switch (SvTYPE(sv)) {
1389 sv_upgrade(sv, SVt_IV);
1392 sv_upgrade(sv, SVt_PVNV);
1396 sv_upgrade(sv, SVt_PVIV);
1405 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1408 (void)SvIOK_only(sv); /* validate number */
1414 =for apidoc sv_setiv_mg
1416 Like C<sv_setiv>, but also handles 'set' magic.
1422 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1429 =for apidoc sv_setuv
1431 Copies an unsigned integer into the given SV, upgrading first if necessary.
1432 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1438 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1440 /* With these two if statements:
1441 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1444 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1446 If you wish to remove them, please benchmark to see what the effect is
1448 if (u <= (UV)IV_MAX) {
1449 sv_setiv(sv, (IV)u);
1458 =for apidoc sv_setuv_mg
1460 Like C<sv_setuv>, but also handles 'set' magic.
1466 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1475 =for apidoc sv_setnv
1477 Copies a double into the given SV, upgrading first if necessary.
1478 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1484 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1487 SV_CHECK_THINKFIRST_COW_DROP(sv);
1488 switch (SvTYPE(sv)) {
1491 sv_upgrade(sv, SVt_NV);
1496 sv_upgrade(sv, SVt_PVNV);
1505 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1509 (void)SvNOK_only(sv); /* validate number */
1514 =for apidoc sv_setnv_mg
1516 Like C<sv_setnv>, but also handles 'set' magic.
1522 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1528 /* Print an "isn't numeric" warning, using a cleaned-up,
1529 * printable version of the offending string
1533 S_not_a_number(pTHX_ SV *sv)
1541 dsv = sv_2mortal(newSVpvs(""));
1542 pv = sv_uni_display(dsv, sv, 10, 0);
1545 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1546 /* each *s can expand to 4 chars + "...\0",
1547 i.e. need room for 8 chars */
1549 const char *s = SvPVX_const(sv);
1550 const char * const end = s + SvCUR(sv);
1551 for ( ; s < end && d < limit; s++ ) {
1553 if (ch & 128 && !isPRINT_LC(ch)) {
1562 else if (ch == '\r') {
1566 else if (ch == '\f') {
1570 else if (ch == '\\') {
1574 else if (ch == '\0') {
1578 else if (isPRINT_LC(ch))
1595 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1596 "Argument \"%s\" isn't numeric in %s", pv,
1599 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1600 "Argument \"%s\" isn't numeric", pv);
1604 =for apidoc looks_like_number
1606 Test if the content of an SV looks like a number (or is a number).
1607 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1608 non-numeric warning), even if your atof() doesn't grok them.
1614 Perl_looks_like_number(pTHX_ SV *sv)
1616 register const char *sbegin;
1620 sbegin = SvPVX_const(sv);
1623 else if (SvPOKp(sv))
1624 sbegin = SvPV_const(sv, len);
1626 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1627 return grok_number(sbegin, len, NULL);
1630 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1631 until proven guilty, assume that things are not that bad... */
1636 As 64 bit platforms often have an NV that doesn't preserve all bits of
1637 an IV (an assumption perl has been based on to date) it becomes necessary
1638 to remove the assumption that the NV always carries enough precision to
1639 recreate the IV whenever needed, and that the NV is the canonical form.
1640 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1641 precision as a side effect of conversion (which would lead to insanity
1642 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1643 1) to distinguish between IV/UV/NV slots that have cached a valid
1644 conversion where precision was lost and IV/UV/NV slots that have a
1645 valid conversion which has lost no precision
1646 2) to ensure that if a numeric conversion to one form is requested that
1647 would lose precision, the precise conversion (or differently
1648 imprecise conversion) is also performed and cached, to prevent
1649 requests for different numeric formats on the same SV causing
1650 lossy conversion chains. (lossless conversion chains are perfectly
1655 SvIOKp is true if the IV slot contains a valid value
1656 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1657 SvNOKp is true if the NV slot contains a valid value
1658 SvNOK is true only if the NV value is accurate
1661 while converting from PV to NV, check to see if converting that NV to an
1662 IV(or UV) would lose accuracy over a direct conversion from PV to
1663 IV(or UV). If it would, cache both conversions, return NV, but mark
1664 SV as IOK NOKp (ie not NOK).
1666 While converting from PV to IV, check to see if converting that IV to an
1667 NV would lose accuracy over a direct conversion from PV to NV. If it
1668 would, cache both conversions, flag similarly.
1670 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1671 correctly because if IV & NV were set NV *always* overruled.
1672 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1673 changes - now IV and NV together means that the two are interchangeable:
1674 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1676 The benefit of this is that operations such as pp_add know that if
1677 SvIOK is true for both left and right operands, then integer addition
1678 can be used instead of floating point (for cases where the result won't
1679 overflow). Before, floating point was always used, which could lead to
1680 loss of precision compared with integer addition.
1682 * making IV and NV equal status should make maths accurate on 64 bit
1684 * may speed up maths somewhat if pp_add and friends start to use
1685 integers when possible instead of fp. (Hopefully the overhead in
1686 looking for SvIOK and checking for overflow will not outweigh the
1687 fp to integer speedup)
1688 * will slow down integer operations (callers of SvIV) on "inaccurate"
1689 values, as the change from SvIOK to SvIOKp will cause a call into
1690 sv_2iv each time rather than a macro access direct to the IV slot
1691 * should speed up number->string conversion on integers as IV is
1692 favoured when IV and NV are equally accurate
1694 ####################################################################
1695 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1696 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1697 On the other hand, SvUOK is true iff UV.
1698 ####################################################################
1700 Your mileage will vary depending your CPU's relative fp to integer
1704 #ifndef NV_PRESERVES_UV
1705 # define IS_NUMBER_UNDERFLOW_IV 1
1706 # define IS_NUMBER_UNDERFLOW_UV 2
1707 # define IS_NUMBER_IV_AND_UV 2
1708 # define IS_NUMBER_OVERFLOW_IV 4
1709 # define IS_NUMBER_OVERFLOW_UV 5
1711 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1713 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1715 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1718 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));
1719 if (SvNVX(sv) < (NV)IV_MIN) {
1720 (void)SvIOKp_on(sv);
1722 SvIV_set(sv, IV_MIN);
1723 return IS_NUMBER_UNDERFLOW_IV;
1725 if (SvNVX(sv) > (NV)UV_MAX) {
1726 (void)SvIOKp_on(sv);
1729 SvUV_set(sv, UV_MAX);
1730 return IS_NUMBER_OVERFLOW_UV;
1732 (void)SvIOKp_on(sv);
1734 /* Can't use strtol etc to convert this string. (See truth table in
1736 if (SvNVX(sv) <= (UV)IV_MAX) {
1737 SvIV_set(sv, I_V(SvNVX(sv)));
1738 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1739 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1741 /* Integer is imprecise. NOK, IOKp */
1743 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1746 SvUV_set(sv, U_V(SvNVX(sv)));
1747 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1748 if (SvUVX(sv) == UV_MAX) {
1749 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1750 possibly be preserved by NV. Hence, it must be overflow.
1752 return IS_NUMBER_OVERFLOW_UV;
1754 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1756 /* Integer is imprecise. NOK, IOKp */
1758 return IS_NUMBER_OVERFLOW_IV;
1760 #endif /* !NV_PRESERVES_UV*/
1763 S_sv_2iuv_common(pTHX_ SV *sv) {
1766 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1767 * without also getting a cached IV/UV from it at the same time
1768 * (ie PV->NV conversion should detect loss of accuracy and cache
1769 * IV or UV at same time to avoid this. */
1770 /* IV-over-UV optimisation - choose to cache IV if possible */
1772 if (SvTYPE(sv) == SVt_NV)
1773 sv_upgrade(sv, SVt_PVNV);
1775 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1776 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1777 certainly cast into the IV range at IV_MAX, whereas the correct
1778 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1780 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1781 SvIV_set(sv, I_V(SvNVX(sv)));
1782 if (SvNVX(sv) == (NV) SvIVX(sv)
1783 #ifndef NV_PRESERVES_UV
1784 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1785 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1786 /* Don't flag it as "accurately an integer" if the number
1787 came from a (by definition imprecise) NV operation, and
1788 we're outside the range of NV integer precision */
1791 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1792 DEBUG_c(PerlIO_printf(Perl_debug_log,
1793 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1799 /* IV not precise. No need to convert from PV, as NV
1800 conversion would already have cached IV if it detected
1801 that PV->IV would be better than PV->NV->IV
1802 flags already correct - don't set public IOK. */
1803 DEBUG_c(PerlIO_printf(Perl_debug_log,
1804 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1809 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1810 but the cast (NV)IV_MIN rounds to a the value less (more
1811 negative) than IV_MIN which happens to be equal to SvNVX ??
1812 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1813 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1814 (NV)UVX == NVX are both true, but the values differ. :-(
1815 Hopefully for 2s complement IV_MIN is something like
1816 0x8000000000000000 which will be exact. NWC */
1819 SvUV_set(sv, U_V(SvNVX(sv)));
1821 (SvNVX(sv) == (NV) SvUVX(sv))
1822 #ifndef NV_PRESERVES_UV
1823 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1824 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1825 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1826 /* Don't flag it as "accurately an integer" if the number
1827 came from a (by definition imprecise) NV operation, and
1828 we're outside the range of NV integer precision */
1833 DEBUG_c(PerlIO_printf(Perl_debug_log,
1834 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1840 else if (SvPOKp(sv) && SvLEN(sv)) {
1842 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1843 /* We want to avoid a possible problem when we cache an IV/ a UV which
1844 may be later translated to an NV, and the resulting NV is not
1845 the same as the direct translation of the initial string
1846 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1847 be careful to ensure that the value with the .456 is around if the
1848 NV value is requested in the future).
1850 This means that if we cache such an IV/a UV, we need to cache the
1851 NV as well. Moreover, we trade speed for space, and do not
1852 cache the NV if we are sure it's not needed.
1855 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1856 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1857 == IS_NUMBER_IN_UV) {
1858 /* It's definitely an integer, only upgrade to PVIV */
1859 if (SvTYPE(sv) < SVt_PVIV)
1860 sv_upgrade(sv, SVt_PVIV);
1862 } else if (SvTYPE(sv) < SVt_PVNV)
1863 sv_upgrade(sv, SVt_PVNV);
1865 /* If NVs preserve UVs then we only use the UV value if we know that
1866 we aren't going to call atof() below. If NVs don't preserve UVs
1867 then the value returned may have more precision than atof() will
1868 return, even though value isn't perfectly accurate. */
1869 if ((numtype & (IS_NUMBER_IN_UV
1870 #ifdef NV_PRESERVES_UV
1873 )) == IS_NUMBER_IN_UV) {
1874 /* This won't turn off the public IOK flag if it was set above */
1875 (void)SvIOKp_on(sv);
1877 if (!(numtype & IS_NUMBER_NEG)) {
1879 if (value <= (UV)IV_MAX) {
1880 SvIV_set(sv, (IV)value);
1882 /* it didn't overflow, and it was positive. */
1883 SvUV_set(sv, value);
1887 /* 2s complement assumption */
1888 if (value <= (UV)IV_MIN) {
1889 SvIV_set(sv, -(IV)value);
1891 /* Too negative for an IV. This is a double upgrade, but
1892 I'm assuming it will be rare. */
1893 if (SvTYPE(sv) < SVt_PVNV)
1894 sv_upgrade(sv, SVt_PVNV);
1898 SvNV_set(sv, -(NV)value);
1899 SvIV_set(sv, IV_MIN);
1903 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1904 will be in the previous block to set the IV slot, and the next
1905 block to set the NV slot. So no else here. */
1907 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1908 != IS_NUMBER_IN_UV) {
1909 /* It wasn't an (integer that doesn't overflow the UV). */
1910 SvNV_set(sv, Atof(SvPVX_const(sv)));
1912 if (! numtype && ckWARN(WARN_NUMERIC))
1915 #if defined(USE_LONG_DOUBLE)
1916 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1917 PTR2UV(sv), SvNVX(sv)));
1919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1920 PTR2UV(sv), SvNVX(sv)));
1923 #ifdef NV_PRESERVES_UV
1924 (void)SvIOKp_on(sv);
1926 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1927 SvIV_set(sv, I_V(SvNVX(sv)));
1928 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1931 /* Integer is imprecise. NOK, IOKp */
1933 /* UV will not work better than IV */
1935 if (SvNVX(sv) > (NV)UV_MAX) {
1937 /* Integer is inaccurate. NOK, IOKp, is UV */
1938 SvUV_set(sv, UV_MAX);
1940 SvUV_set(sv, U_V(SvNVX(sv)));
1941 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1942 NV preservse UV so can do correct comparison. */
1943 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1946 /* Integer is imprecise. NOK, IOKp, is UV */
1951 #else /* NV_PRESERVES_UV */
1952 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1953 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1954 /* The IV/UV slot will have been set from value returned by
1955 grok_number above. The NV slot has just been set using
1958 assert (SvIOKp(sv));
1960 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1961 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1962 /* Small enough to preserve all bits. */
1963 (void)SvIOKp_on(sv);
1965 SvIV_set(sv, I_V(SvNVX(sv)));
1966 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1968 /* Assumption: first non-preserved integer is < IV_MAX,
1969 this NV is in the preserved range, therefore: */
1970 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1972 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);
1976 0 0 already failed to read UV.
1977 0 1 already failed to read UV.
1978 1 0 you won't get here in this case. IV/UV
1979 slot set, public IOK, Atof() unneeded.
1980 1 1 already read UV.
1981 so there's no point in sv_2iuv_non_preserve() attempting
1982 to use atol, strtol, strtoul etc. */
1983 sv_2iuv_non_preserve (sv, numtype);
1986 #endif /* NV_PRESERVES_UV */
1990 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1991 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1994 if (SvTYPE(sv) < SVt_IV)
1995 /* Typically the caller expects that sv_any is not NULL now. */
1996 sv_upgrade(sv, SVt_IV);
1997 /* Return 0 from the caller. */
2004 =for apidoc sv_2iv_flags
2006 Return the integer value of an SV, doing any necessary string
2007 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2008 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2014 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2019 if (SvGMAGICAL(sv)) {
2020 if (flags & SV_GMAGIC)
2025 return I_V(SvNVX(sv));
2027 if (SvPOKp(sv) && SvLEN(sv)) {
2030 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2033 == IS_NUMBER_IN_UV) {
2034 /* It's definitely an integer */
2035 if (numtype & IS_NUMBER_NEG) {
2036 if (value < (UV)IV_MIN)
2039 if (value < (UV)IV_MAX)
2044 if (ckWARN(WARN_NUMERIC))
2047 return I_V(Atof(SvPVX_const(sv)));
2052 assert(SvTYPE(sv) >= SVt_PVMG);
2053 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2054 } else if (SvTHINKFIRST(sv)) {
2058 SV * const tmpstr=AMG_CALLun(sv,numer);
2059 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2060 return SvIV(tmpstr);
2063 return PTR2IV(SvRV(sv));
2066 sv_force_normal_flags(sv, 0);
2068 if (SvREADONLY(sv) && !SvOK(sv)) {
2069 if (ckWARN(WARN_UNINITIALIZED))
2075 if (S_sv_2iuv_common(aTHX_ sv))
2078 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2079 PTR2UV(sv),SvIVX(sv)));
2080 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2084 =for apidoc sv_2uv_flags
2086 Return the unsigned integer value of an SV, doing any necessary string
2087 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2088 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2094 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2099 if (SvGMAGICAL(sv)) {
2100 if (flags & SV_GMAGIC)
2105 return U_V(SvNVX(sv));
2106 if (SvPOKp(sv) && SvLEN(sv)) {
2109 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2111 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2112 == IS_NUMBER_IN_UV) {
2113 /* It's definitely an integer */
2114 if (!(numtype & IS_NUMBER_NEG))
2118 if (ckWARN(WARN_NUMERIC))
2121 return U_V(Atof(SvPVX_const(sv)));
2126 assert(SvTYPE(sv) >= SVt_PVMG);
2127 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2128 } else if (SvTHINKFIRST(sv)) {
2132 SV *const tmpstr = AMG_CALLun(sv,numer);
2133 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2134 return SvUV(tmpstr);
2137 return PTR2UV(SvRV(sv));
2140 sv_force_normal_flags(sv, 0);
2142 if (SvREADONLY(sv) && !SvOK(sv)) {
2143 if (ckWARN(WARN_UNINITIALIZED))
2149 if (S_sv_2iuv_common(aTHX_ sv))
2153 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2154 PTR2UV(sv),SvUVX(sv)));
2155 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2161 Return the num value of an SV, doing any necessary string or integer
2162 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2169 Perl_sv_2nv(pTHX_ register SV *sv)
2174 if (SvGMAGICAL(sv)) {
2178 if (SvPOKp(sv) && SvLEN(sv)) {
2179 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2180 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2182 return Atof(SvPVX_const(sv));
2186 return (NV)SvUVX(sv);
2188 return (NV)SvIVX(sv);
2193 assert(SvTYPE(sv) >= SVt_PVMG);
2194 /* This falls through to the report_uninit near the end of the
2196 } else if (SvTHINKFIRST(sv)) {
2200 SV *const tmpstr = AMG_CALLun(sv,numer);
2201 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2202 return SvNV(tmpstr);
2205 return PTR2NV(SvRV(sv));
2208 sv_force_normal_flags(sv, 0);
2210 if (SvREADONLY(sv) && !SvOK(sv)) {
2211 if (ckWARN(WARN_UNINITIALIZED))
2216 if (SvTYPE(sv) < SVt_NV) {
2217 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2218 sv_upgrade(sv, SVt_NV);
2219 #ifdef USE_LONG_DOUBLE
2221 STORE_NUMERIC_LOCAL_SET_STANDARD();
2222 PerlIO_printf(Perl_debug_log,
2223 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2224 PTR2UV(sv), SvNVX(sv));
2225 RESTORE_NUMERIC_LOCAL();
2229 STORE_NUMERIC_LOCAL_SET_STANDARD();
2230 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2231 PTR2UV(sv), SvNVX(sv));
2232 RESTORE_NUMERIC_LOCAL();
2236 else if (SvTYPE(sv) < SVt_PVNV)
2237 sv_upgrade(sv, SVt_PVNV);
2242 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2243 #ifdef NV_PRESERVES_UV
2246 /* Only set the public NV OK flag if this NV preserves the IV */
2247 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2248 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2249 : (SvIVX(sv) == I_V(SvNVX(sv))))
2255 else if (SvPOKp(sv) && SvLEN(sv)) {
2257 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2258 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2260 #ifdef NV_PRESERVES_UV
2261 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2262 == IS_NUMBER_IN_UV) {
2263 /* It's definitely an integer */
2264 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2266 SvNV_set(sv, Atof(SvPVX_const(sv)));
2269 SvNV_set(sv, Atof(SvPVX_const(sv)));
2270 /* Only set the public NV OK flag if this NV preserves the value in
2271 the PV at least as well as an IV/UV would.
2272 Not sure how to do this 100% reliably. */
2273 /* if that shift count is out of range then Configure's test is
2274 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2276 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2277 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2278 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2279 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2280 /* Can't use strtol etc to convert this string, so don't try.
2281 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2284 /* value has been set. It may not be precise. */
2285 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2286 /* 2s complement assumption for (UV)IV_MIN */
2287 SvNOK_on(sv); /* Integer is too negative. */
2292 if (numtype & IS_NUMBER_NEG) {
2293 SvIV_set(sv, -(IV)value);
2294 } else if (value <= (UV)IV_MAX) {
2295 SvIV_set(sv, (IV)value);
2297 SvUV_set(sv, value);
2301 if (numtype & IS_NUMBER_NOT_INT) {
2302 /* I believe that even if the original PV had decimals,
2303 they are lost beyond the limit of the FP precision.
2304 However, neither is canonical, so both only get p
2305 flags. NWC, 2000/11/25 */
2306 /* Both already have p flags, so do nothing */
2308 const NV nv = SvNVX(sv);
2309 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2310 if (SvIVX(sv) == I_V(nv)) {
2313 /* It had no "." so it must be integer. */
2317 /* between IV_MAX and NV(UV_MAX).
2318 Could be slightly > UV_MAX */
2320 if (numtype & IS_NUMBER_NOT_INT) {
2321 /* UV and NV both imprecise. */
2323 const UV nv_as_uv = U_V(nv);
2325 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2334 #endif /* NV_PRESERVES_UV */
2337 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2339 assert (SvTYPE(sv) >= SVt_NV);
2340 /* Typically the caller expects that sv_any is not NULL now. */
2341 /* XXX Ilya implies that this is a bug in callers that assume this
2342 and ideally should be fixed. */
2345 #if defined(USE_LONG_DOUBLE)
2347 STORE_NUMERIC_LOCAL_SET_STANDARD();
2348 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2349 PTR2UV(sv), SvNVX(sv));
2350 RESTORE_NUMERIC_LOCAL();
2354 STORE_NUMERIC_LOCAL_SET_STANDARD();
2355 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2356 PTR2UV(sv), SvNVX(sv));
2357 RESTORE_NUMERIC_LOCAL();
2363 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2364 * UV as a string towards the end of buf, and return pointers to start and
2367 * We assume that buf is at least TYPE_CHARS(UV) long.
2371 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2373 char *ptr = buf + TYPE_CHARS(UV);
2374 char * const ebuf = ptr;
2387 *--ptr = '0' + (char)(uv % 10);
2395 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2396 * a regexp to its stringified form.
2400 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2402 const regexp * const re = (regexp *)mg->mg_obj;
2405 const char *fptr = "msix";
2410 bool need_newline = 0;
2411 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2413 while((ch = *fptr++)) {
2415 reflags[left++] = ch;
2418 reflags[right--] = ch;
2423 reflags[left] = '-';
2427 mg->mg_len = re->prelen + 4 + left;
2429 * If /x was used, we have to worry about a regex ending with a
2430 * comment later being embedded within another regex. If so, we don't
2431 * want this regex's "commentization" to leak out to the right part of
2432 * the enclosing regex, we must cap it with a newline.
2434 * So, if /x was used, we scan backwards from the end of the regex. If
2435 * we find a '#' before we find a newline, we need to add a newline
2436 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2437 * we don't need to add anything. -jfriedl
2439 if (PMf_EXTENDED & re->reganch) {
2440 const char *endptr = re->precomp + re->prelen;
2441 while (endptr >= re->precomp) {
2442 const char c = *(endptr--);
2444 break; /* don't need another */
2446 /* we end while in a comment, so we need a newline */
2447 mg->mg_len++; /* save space for it */
2448 need_newline = 1; /* note to add it */
2454 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2455 mg->mg_ptr[0] = '(';
2456 mg->mg_ptr[1] = '?';
2457 Copy(reflags, mg->mg_ptr+2, left, char);
2458 *(mg->mg_ptr+left+2) = ':';
2459 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2461 mg->mg_ptr[mg->mg_len - 2] = '\n';
2462 mg->mg_ptr[mg->mg_len - 1] = ')';
2463 mg->mg_ptr[mg->mg_len] = 0;
2465 PL_reginterp_cnt += re->program[0].next_off;
2467 if (re->reganch & ROPT_UTF8)
2477 =for apidoc sv_2pv_flags
2479 Returns a pointer to the string value of an SV, and sets *lp to its length.
2480 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2482 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2483 usually end up here too.
2489 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2499 if (SvGMAGICAL(sv)) {
2500 if (flags & SV_GMAGIC)
2505 if (flags & SV_MUTABLE_RETURN)
2506 return SvPVX_mutable(sv);
2507 if (flags & SV_CONST_RETURN)
2508 return (char *)SvPVX_const(sv);
2511 if (SvIOKp(sv) || SvNOKp(sv)) {
2512 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2516 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2517 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2519 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2522 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2523 /* Sneaky stuff here */
2524 SV * const tsv = newSVpvn(tbuf, len);
2534 #ifdef FIXNEGATIVEZERO
2535 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2541 SvUPGRADE(sv, SVt_PV);
2544 s = SvGROW_mutable(sv, len + 1);
2547 return memcpy(s, tbuf, len + 1);
2553 assert(SvTYPE(sv) >= SVt_PVMG);
2554 /* This falls through to the report_uninit near the end of the
2556 } else if (SvTHINKFIRST(sv)) {
2560 SV *const tmpstr = AMG_CALLun(sv,string);
2561 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2563 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2567 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2568 if (flags & SV_CONST_RETURN) {
2569 pv = (char *) SvPVX_const(tmpstr);
2571 pv = (flags & SV_MUTABLE_RETURN)
2572 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2575 *lp = SvCUR(tmpstr);
2577 pv = sv_2pv_flags(tmpstr, lp, flags);
2589 const SV *const referent = (SV*)SvRV(sv);
2592 tsv = sv_2mortal(newSVpvs("NULLREF"));
2593 } else if (SvTYPE(referent) == SVt_PVMG
2594 && ((SvFLAGS(referent) &
2595 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2596 == (SVs_OBJECT|SVs_SMG))
2597 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2598 return stringify_regexp(sv, mg, lp);
2600 const char *const typestr = sv_reftype(referent, 0);
2602 tsv = sv_newmortal();
2603 if (SvOBJECT(referent)) {
2604 const char *const name = HvNAME_get(SvSTASH(referent));
2605 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2606 name ? name : "__ANON__" , typestr,
2610 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2618 if (SvREADONLY(sv) && !SvOK(sv)) {
2619 if (ckWARN(WARN_UNINITIALIZED))
2626 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2627 /* I'm assuming that if both IV and NV are equally valid then
2628 converting the IV is going to be more efficient */
2629 const U32 isIOK = SvIOK(sv);
2630 const U32 isUIOK = SvIsUV(sv);
2631 char buf[TYPE_CHARS(UV)];
2634 if (SvTYPE(sv) < SVt_PVIV)
2635 sv_upgrade(sv, SVt_PVIV);
2636 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2637 /* inlined from sv_setpvn */
2638 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2639 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2640 SvCUR_set(sv, ebuf - ptr);
2650 else if (SvNOKp(sv)) {
2651 const int olderrno = errno;
2652 if (SvTYPE(sv) < SVt_PVNV)
2653 sv_upgrade(sv, SVt_PVNV);
2654 /* The +20 is pure guesswork. Configure test needed. --jhi */
2655 s = SvGROW_mutable(sv, NV_DIG + 20);
2656 /* some Xenix systems wipe out errno here */
2658 if (SvNVX(sv) == 0.0)
2659 (void)strcpy(s,"0");
2663 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2666 #ifdef FIXNEGATIVEZERO
2667 if (*s == '-' && s[1] == '0' && !s[2])
2677 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2681 if (SvTYPE(sv) < SVt_PV)
2682 /* Typically the caller expects that sv_any is not NULL now. */
2683 sv_upgrade(sv, SVt_PV);
2687 const STRLEN len = s - SvPVX_const(sv);
2693 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2694 PTR2UV(sv),SvPVX_const(sv)));
2695 if (flags & SV_CONST_RETURN)
2696 return (char *)SvPVX_const(sv);
2697 if (flags & SV_MUTABLE_RETURN)
2698 return SvPVX_mutable(sv);
2703 =for apidoc sv_copypv
2705 Copies a stringified representation of the source SV into the
2706 destination SV. Automatically performs any necessary mg_get and
2707 coercion of numeric values into strings. Guaranteed to preserve
2708 UTF-8 flag even from overloaded objects. Similar in nature to
2709 sv_2pv[_flags] but operates directly on an SV instead of just the
2710 string. Mostly uses sv_2pv_flags to do its work, except when that
2711 would lose the UTF-8'ness of the PV.
2717 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2720 const char * const s = SvPV_const(ssv,len);
2721 sv_setpvn(dsv,s,len);
2729 =for apidoc sv_2pvbyte
2731 Return a pointer to the byte-encoded representation of the SV, and set *lp
2732 to its length. May cause the SV to be downgraded from UTF-8 as a
2735 Usually accessed via the C<SvPVbyte> macro.
2741 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2743 sv_utf8_downgrade(sv,0);
2744 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2748 =for apidoc sv_2pvutf8
2750 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2751 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2753 Usually accessed via the C<SvPVutf8> macro.
2759 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2761 sv_utf8_upgrade(sv);
2762 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2767 =for apidoc sv_2bool
2769 This function is only called on magical items, and is only used by
2770 sv_true() or its macro equivalent.
2776 Perl_sv_2bool(pTHX_ register SV *sv)
2785 SV * const tmpsv = AMG_CALLun(sv,bool_);
2786 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2787 return (bool)SvTRUE(tmpsv);
2789 return SvRV(sv) != 0;
2792 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2794 (*sv->sv_u.svu_pv > '0' ||
2795 Xpvtmp->xpv_cur > 1 ||
2796 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2803 return SvIVX(sv) != 0;
2806 return SvNVX(sv) != 0.0;
2814 =for apidoc sv_utf8_upgrade
2816 Converts the PV of an SV to its UTF-8-encoded form.
2817 Forces the SV to string form if it is not already.
2818 Always sets the SvUTF8 flag to avoid future validity checks even
2819 if all the bytes have hibit clear.
2821 This is not as a general purpose byte encoding to Unicode interface:
2822 use the Encode extension for that.
2824 =for apidoc sv_utf8_upgrade_flags
2826 Converts the PV of an SV to its UTF-8-encoded form.
2827 Forces the SV to string form if it is not already.
2828 Always sets the SvUTF8 flag to avoid future validity checks even
2829 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2830 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2831 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2833 This is not as a general purpose byte encoding to Unicode interface:
2834 use the Encode extension for that.
2840 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2843 if (sv == &PL_sv_undef)
2847 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2848 (void) sv_2pv_flags(sv,&len, flags);
2852 (void) SvPV_force(sv,len);
2861 sv_force_normal_flags(sv, 0);
2864 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2865 sv_recode_to_utf8(sv, PL_encoding);
2866 else { /* Assume Latin-1/EBCDIC */
2867 /* This function could be much more efficient if we
2868 * had a FLAG in SVs to signal if there are any hibit
2869 * chars in the PV. Given that there isn't such a flag
2870 * make the loop as fast as possible. */
2871 const U8 * const s = (U8 *) SvPVX_const(sv);
2872 const U8 * const e = (U8 *) SvEND(sv);
2877 /* Check for hi bit */
2878 if (!NATIVE_IS_INVARIANT(ch)) {
2879 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2880 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2882 SvPV_free(sv); /* No longer using what was there before. */
2883 SvPV_set(sv, (char*)recoded);
2884 SvCUR_set(sv, len - 1);
2885 SvLEN_set(sv, len); /* No longer know the real size. */
2889 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2896 =for apidoc sv_utf8_downgrade
2898 Attempts to convert the PV of an SV from characters to bytes.
2899 If the PV contains a character beyond byte, this conversion will fail;
2900 in this case, either returns false or, if C<fail_ok> is not
2903 This is not as a general purpose Unicode to byte encoding interface:
2904 use the Encode extension for that.
2910 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2913 if (SvPOKp(sv) && SvUTF8(sv)) {
2919 sv_force_normal_flags(sv, 0);
2921 s = (U8 *) SvPV(sv, len);
2922 if (!utf8_to_bytes(s, &len)) {
2927 Perl_croak(aTHX_ "Wide character in %s",
2930 Perl_croak(aTHX_ "Wide character");
2941 =for apidoc sv_utf8_encode
2943 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2944 flag off so that it looks like octets again.
2950 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2952 (void) sv_utf8_upgrade(sv);
2954 sv_force_normal_flags(sv, 0);
2956 if (SvREADONLY(sv)) {
2957 Perl_croak(aTHX_ PL_no_modify);
2963 =for apidoc sv_utf8_decode
2965 If the PV of the SV is an octet sequence in UTF-8
2966 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2967 so that it looks like a character. If the PV contains only single-byte
2968 characters, the C<SvUTF8> flag stays being off.
2969 Scans PV for validity and returns false if the PV is invalid UTF-8.
2975 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2981 /* The octets may have got themselves encoded - get them back as
2984 if (!sv_utf8_downgrade(sv, TRUE))
2987 /* it is actually just a matter of turning the utf8 flag on, but
2988 * we want to make sure everything inside is valid utf8 first.
2990 c = (const U8 *) SvPVX_const(sv);
2991 if (!is_utf8_string(c, SvCUR(sv)+1))
2993 e = (const U8 *) SvEND(sv);
2996 if (!UTF8_IS_INVARIANT(ch)) {
3006 =for apidoc sv_setsv
3008 Copies the contents of the source SV C<ssv> into the destination SV
3009 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3010 function if the source SV needs to be reused. Does not handle 'set' magic.
3011 Loosely speaking, it performs a copy-by-value, obliterating any previous
3012 content of the destination.
3014 You probably want to use one of the assortment of wrappers, such as
3015 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3016 C<SvSetMagicSV_nosteal>.
3018 =for apidoc sv_setsv_flags
3020 Copies the contents of the source SV C<ssv> into the destination SV
3021 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3022 function if the source SV needs to be reused. Does not handle 'set' magic.
3023 Loosely speaking, it performs a copy-by-value, obliterating any previous
3024 content of the destination.
3025 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3026 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3027 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3028 and C<sv_setsv_nomg> are implemented in terms of this function.
3030 You probably want to use one of the assortment of wrappers, such as
3031 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3032 C<SvSetMagicSV_nosteal>.
3034 This is the primary function for copying scalars, and most other
3035 copy-ish functions and macros use this underneath.
3041 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
3043 if (dtype != SVt_PVGV) {
3044 const char * const name = GvNAME(sstr);
3045 const STRLEN len = GvNAMELEN(sstr);
3046 /* don't upgrade SVt_PVLV: it can hold a glob */
3047 if (dtype != SVt_PVLV)
3048 sv_upgrade(dstr, SVt_PVGV);
3049 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3050 GvSTASH(dstr) = GvSTASH(sstr);
3052 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3053 GvNAME(dstr) = savepvn(name, len);
3054 GvNAMELEN(dstr) = len;
3055 SvFAKE_on(dstr); /* can coerce to non-glob */
3058 #ifdef GV_UNIQUE_CHECK
3059 if (GvUNIQUE((GV*)dstr)) {
3060 Perl_croak(aTHX_ PL_no_modify);
3064 (void)SvOK_off(dstr);
3065 GvINTRO_off(dstr); /* one-shot flag */
3067 GvGP(dstr) = gp_ref(GvGP(sstr));
3068 if (SvTAINTED(sstr))
3070 if (GvIMPORTED(dstr) != GVf_IMPORTED
3071 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3073 GvIMPORTED_on(dstr);
3080 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
3081 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3083 const int intro = GvINTRO(dstr);
3085 #ifdef GV_UNIQUE_CHECK
3086 if (GvUNIQUE((GV*)dstr)) {
3087 Perl_croak(aTHX_ PL_no_modify);
3092 GvINTRO_off(dstr); /* one-shot flag */
3093 GvLINE(dstr) = CopLINE(PL_curcop);
3094 GvEGV(dstr) = (GV*)dstr;
3097 switch (SvTYPE(sref)) {
3100 SAVEGENERICSV(GvAV(dstr));
3102 dref = (SV*)GvAV(dstr);
3103 GvAV(dstr) = (AV*)sref;
3104 if (!GvIMPORTED_AV(dstr)
3105 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3107 GvIMPORTED_AV_on(dstr);
3112 SAVEGENERICSV(GvHV(dstr));
3114 dref = (SV*)GvHV(dstr);
3115 GvHV(dstr) = (HV*)sref;
3116 if (!GvIMPORTED_HV(dstr)
3117 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3119 GvIMPORTED_HV_on(dstr);
3124 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3125 SvREFCNT_dec(GvCV(dstr));
3127 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3128 PL_sub_generation++;
3130 SAVEGENERICSV(GvCV(dstr));
3133 dref = (SV*)GvCV(dstr);
3134 if (GvCV(dstr) != (CV*)sref) {
3135 CV* const cv = GvCV(dstr);
3137 if (!GvCVGEN((GV*)dstr) &&
3138 (CvROOT(cv) || CvXSUB(cv)))
3140 /* Redefining a sub - warning is mandatory if
3141 it was a const and its value changed. */
3142 if (CvCONST(cv) && CvCONST((CV*)sref)
3143 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3144 /* They are 2 constant subroutines generated from
3145 the same constant. This probably means that
3146 they are really the "same" proxy subroutine
3147 instantiated in 2 places. Most likely this is
3148 when a constant is exported twice. Don't warn.
3151 else if (ckWARN(WARN_REDEFINE)
3153 && (!CvCONST((CV*)sref)
3154 || sv_cmp(cv_const_sv(cv),
3155 cv_const_sv((CV*)sref))))) {
3156 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3158 ? "Constant subroutine %s::%s redefined"
3159 : "Subroutine %s::%s redefined",
3160 HvNAME_get(GvSTASH((GV*)dstr)),
3161 GvENAME((GV*)dstr));
3165 cv_ckproto(cv, (GV*)dstr,
3166 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3168 GvCV(dstr) = (CV*)sref;
3169 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3170 GvASSUMECV_on(dstr);
3171 PL_sub_generation++;
3173 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3174 GvIMPORTED_CV_on(dstr);
3179 SAVEGENERICSV(GvIOp(dstr));
3181 dref = (SV*)GvIOp(dstr);
3182 GvIOp(dstr) = (IO*)sref;
3186 SAVEGENERICSV(GvFORM(dstr));
3188 dref = (SV*)GvFORM(dstr);
3189 GvFORM(dstr) = (CV*)sref;
3193 SAVEGENERICSV(GvSV(dstr));
3195 dref = (SV*)GvSV(dstr);
3197 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3198 GvIMPORTED_SV_on(dstr);
3204 if (SvTAINTED(sstr))
3210 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3213 register U32 sflags;
3219 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3221 sstr = &PL_sv_undef;
3222 stype = SvTYPE(sstr);
3223 dtype = SvTYPE(dstr);
3228 /* need to nuke the magic */
3230 SvRMAGICAL_off(dstr);
3233 /* There's a lot of redundancy below but we're going for speed here */
3238 if (dtype != SVt_PVGV) {
3239 (void)SvOK_off(dstr);
3247 sv_upgrade(dstr, SVt_IV);
3250 sv_upgrade(dstr, SVt_PVNV);
3254 sv_upgrade(dstr, SVt_PVIV);
3257 (void)SvIOK_only(dstr);
3258 SvIV_set(dstr, SvIVX(sstr));
3261 /* SvTAINTED can only be true if the SV has taint magic, which in
3262 turn means that the SV type is PVMG (or greater). This is the
3263 case statement for SVt_IV, so this cannot be true (whatever gcov
3265 assert(!SvTAINTED(sstr));
3275 sv_upgrade(dstr, SVt_NV);
3280 sv_upgrade(dstr, SVt_PVNV);
3283 SvNV_set(dstr, SvNVX(sstr));
3284 (void)SvNOK_only(dstr);
3285 /* SvTAINTED can only be true if the SV has taint magic, which in
3286 turn means that the SV type is PVMG (or greater). This is the
3287 case statement for SVt_NV, so this cannot be true (whatever gcov
3289 assert(!SvTAINTED(sstr));
3296 sv_upgrade(dstr, SVt_RV);
3297 else if (dtype == SVt_PVGV &&
3298 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3301 if (GvIMPORTED(dstr) != GVf_IMPORTED
3302 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3304 GvIMPORTED_on(dstr);
3309 S_glob_assign(aTHX_ dstr, sstr, dtype);
3314 #ifdef PERL_OLD_COPY_ON_WRITE
3315 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3316 if (dtype < SVt_PVIV)
3317 sv_upgrade(dstr, SVt_PVIV);
3324 sv_upgrade(dstr, SVt_PV);
3327 if (dtype < SVt_PVIV)
3328 sv_upgrade(dstr, SVt_PVIV);
3331 if (dtype < SVt_PVNV)
3332 sv_upgrade(dstr, SVt_PVNV);
3339 const char * const type = sv_reftype(sstr,0);
3341 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3343 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3348 if (dtype <= SVt_PVGV) {
3349 S_glob_assign(aTHX_ dstr, sstr, dtype);
3355 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3357 if ((int)SvTYPE(sstr) != stype) {
3358 stype = SvTYPE(sstr);
3359 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3360 S_glob_assign(aTHX_ dstr, sstr, dtype);
3365 if (stype == SVt_PVLV)
3366 SvUPGRADE(dstr, SVt_PVNV);
3368 SvUPGRADE(dstr, (U32)stype);
3371 sflags = SvFLAGS(sstr);
3373 if (sflags & SVf_ROK) {
3374 if (dtype >= SVt_PV) {
3375 if (dtype == SVt_PVGV) {
3376 S_pvgv_assign(aTHX_ dstr, sstr);
3379 if (SvPVX_const(dstr)) {
3385 (void)SvOK_off(dstr);
3386 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3387 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3388 assert(!(sflags & SVp_NOK));
3389 assert(!(sflags & SVp_IOK));
3390 assert(!(sflags & SVf_NOK));
3391 assert(!(sflags & SVf_IOK));
3393 else if (sflags & SVp_POK) {
3397 * Check to see if we can just swipe the string. If so, it's a
3398 * possible small lose on short strings, but a big win on long ones.
3399 * It might even be a win on short strings if SvPVX_const(dstr)
3400 * has to be allocated and SvPVX_const(sstr) has to be freed.
3403 /* Whichever path we take through the next code, we want this true,
3404 and doing it now facilitates the COW check. */
3405 (void)SvPOK_only(dstr);
3408 /* We're not already COW */
3409 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3410 #ifndef PERL_OLD_COPY_ON_WRITE
3411 /* or we are, but dstr isn't a suitable target. */
3412 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3417 (sflags & SVs_TEMP) && /* slated for free anyway? */
3418 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3419 (!(flags & SV_NOSTEAL)) &&
3420 /* and we're allowed to steal temps */
3421 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3422 SvLEN(sstr) && /* and really is a string */
3423 /* and won't be needed again, potentially */
3424 !(PL_op && PL_op->op_type == OP_AASSIGN))
3425 #ifdef PERL_OLD_COPY_ON_WRITE
3426 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3427 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3428 && SvTYPE(sstr) >= SVt_PVIV)
3431 /* Failed the swipe test, and it's not a shared hash key either.
3432 Have to copy the string. */
3433 STRLEN len = SvCUR(sstr);
3434 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3435 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3436 SvCUR_set(dstr, len);
3437 *SvEND(dstr) = '\0';
3439 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3441 /* Either it's a shared hash key, or it's suitable for
3442 copy-on-write or we can swipe the string. */
3444 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3448 #ifdef PERL_OLD_COPY_ON_WRITE
3450 /* I believe I should acquire a global SV mutex if
3451 it's a COW sv (not a shared hash key) to stop
3452 it going un copy-on-write.
3453 If the source SV has gone un copy on write between up there
3454 and down here, then (assert() that) it is of the correct
3455 form to make it copy on write again */
3456 if ((sflags & (SVf_FAKE | SVf_READONLY))
3457 != (SVf_FAKE | SVf_READONLY)) {
3458 SvREADONLY_on(sstr);
3460 /* Make the source SV into a loop of 1.
3461 (about to become 2) */
3462 SV_COW_NEXT_SV_SET(sstr, sstr);
3466 /* Initial code is common. */
3467 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3472 /* making another shared SV. */
3473 STRLEN cur = SvCUR(sstr);
3474 STRLEN len = SvLEN(sstr);
3475 #ifdef PERL_OLD_COPY_ON_WRITE
3477 assert (SvTYPE(dstr) >= SVt_PVIV);
3478 /* SvIsCOW_normal */
3479 /* splice us in between source and next-after-source. */
3480 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3481 SV_COW_NEXT_SV_SET(sstr, dstr);
3482 SvPV_set(dstr, SvPVX_mutable(sstr));
3486 /* SvIsCOW_shared_hash */
3487 DEBUG_C(PerlIO_printf(Perl_debug_log,
3488 "Copy on write: Sharing hash\n"));
3490 assert (SvTYPE(dstr) >= SVt_PV);
3492 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3494 SvLEN_set(dstr, len);
3495 SvCUR_set(dstr, cur);
3496 SvREADONLY_on(dstr);
3498 /* Relesase a global SV mutex. */
3501 { /* Passes the swipe test. */
3502 SvPV_set(dstr, SvPVX_mutable(sstr));
3503 SvLEN_set(dstr, SvLEN(sstr));
3504 SvCUR_set(dstr, SvCUR(sstr));
3507 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3508 SvPV_set(sstr, NULL);
3514 if (sflags & SVp_NOK) {
3515 SvNV_set(dstr, SvNVX(sstr));
3517 if (sflags & SVp_IOK) {
3518 SvRELEASE_IVX(dstr);
3519 SvIV_set(dstr, SvIVX(sstr));
3520 /* Must do this otherwise some other overloaded use of 0x80000000
3521 gets confused. I guess SVpbm_VALID */
3522 if (sflags & SVf_IVisUV)
3525 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3527 const MAGIC * const smg = SvVOK(sstr);
3529 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3530 smg->mg_ptr, smg->mg_len);
3531 SvRMAGICAL_on(dstr);
3535 else if (sflags & (SVp_IOK|SVp_NOK)) {
3536 (void)SvOK_off(dstr);
3537 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3538 if (sflags & SVp_IOK) {
3539 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3540 SvIV_set(dstr, SvIVX(sstr));
3542 if (sflags & SVp_NOK) {
3543 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3544 SvNV_set(dstr, SvNVX(sstr));
3548 if (dtype == SVt_PVGV) {
3549 if (ckWARN(WARN_MISC))
3550 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3553 (void)SvOK_off(dstr);
3555 if (SvTAINTED(sstr))
3560 =for apidoc sv_setsv_mg
3562 Like C<sv_setsv>, but also handles 'set' magic.
3568 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3570 sv_setsv(dstr,sstr);
3574 #ifdef PERL_OLD_COPY_ON_WRITE
3576 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3578 STRLEN cur = SvCUR(sstr);
3579 STRLEN len = SvLEN(sstr);
3580 register char *new_pv;
3583 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3591 if (SvTHINKFIRST(dstr))
3592 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3593 else if (SvPVX_const(dstr))
3594 Safefree(SvPVX_const(dstr));
3598 SvUPGRADE(dstr, SVt_PVIV);
3600 assert (SvPOK(sstr));
3601 assert (SvPOKp(sstr));
3602 assert (!SvIOK(sstr));
3603 assert (!SvIOKp(sstr));
3604 assert (!SvNOK(sstr));
3605 assert (!SvNOKp(sstr));
3607 if (SvIsCOW(sstr)) {
3609 if (SvLEN(sstr) == 0) {
3610 /* source is a COW shared hash key. */
3611 DEBUG_C(PerlIO_printf(Perl_debug_log,
3612 "Fast copy on write: Sharing hash\n"));
3613 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3616 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3618 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3619 SvUPGRADE(sstr, SVt_PVIV);
3620 SvREADONLY_on(sstr);
3622 DEBUG_C(PerlIO_printf(Perl_debug_log,
3623 "Fast copy on write: Converting sstr to COW\n"));
3624 SV_COW_NEXT_SV_SET(dstr, sstr);
3626 SV_COW_NEXT_SV_SET(sstr, dstr);
3627 new_pv = SvPVX_mutable(sstr);
3630 SvPV_set(dstr, new_pv);
3631 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3634 SvLEN_set(dstr, len);
3635 SvCUR_set(dstr, cur);
3644 =for apidoc sv_setpvn
3646 Copies a string into an SV. The C<len> parameter indicates the number of
3647 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3648 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3654 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3657 register char *dptr;
3659 SV_CHECK_THINKFIRST_COW_DROP(sv);
3665 /* len is STRLEN which is unsigned, need to copy to signed */
3668 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3670 SvUPGRADE(sv, SVt_PV);
3672 dptr = SvGROW(sv, len + 1);
3673 Move(ptr,dptr,len,char);
3676 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3681 =for apidoc sv_setpvn_mg
3683 Like C<sv_setpvn>, but also handles 'set' magic.
3689 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3691 sv_setpvn(sv,ptr,len);
3696 =for apidoc sv_setpv
3698 Copies a string into an SV. The string must be null-terminated. Does not
3699 handle 'set' magic. See C<sv_setpv_mg>.
3705 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3708 register STRLEN len;
3710 SV_CHECK_THINKFIRST_COW_DROP(sv);
3716 SvUPGRADE(sv, SVt_PV);
3718 SvGROW(sv, len + 1);
3719 Move(ptr,SvPVX(sv),len+1,char);
3721 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3726 =for apidoc sv_setpv_mg
3728 Like C<sv_setpv>, but also handles 'set' magic.
3734 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3741 =for apidoc sv_usepvn
3743 Tells an SV to use C<ptr> to find its string value. Normally the string is
3744 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3745 The C<ptr> should point to memory that was allocated by C<malloc>. The
3746 string length, C<len>, must be supplied. This function will realloc the
3747 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3748 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3749 See C<sv_usepvn_mg>.
3755 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3759 SV_CHECK_THINKFIRST_COW_DROP(sv);
3760 SvUPGRADE(sv, SVt_PV);
3765 if (SvPVX_const(sv))
3768 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3769 ptr = saferealloc (ptr, allocate);
3772 SvLEN_set(sv, allocate);
3774 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3779 =for apidoc sv_usepvn_mg
3781 Like C<sv_usepvn>, but also handles 'set' magic.
3787 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3789 sv_usepvn(sv,ptr,len);
3793 #ifdef PERL_OLD_COPY_ON_WRITE
3794 /* Need to do this *after* making the SV normal, as we need the buffer
3795 pointer to remain valid until after we've copied it. If we let go too early,
3796 another thread could invalidate it by unsharing last of the same hash key
3797 (which it can do by means other than releasing copy-on-write Svs)
3798 or by changing the other copy-on-write SVs in the loop. */
3800 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3802 if (len) { /* this SV was SvIsCOW_normal(sv) */
3803 /* we need to find the SV pointing to us. */
3804 SV *current = SV_COW_NEXT_SV(after);
3806 if (current == sv) {
3807 /* The SV we point to points back to us (there were only two of us
3809 Hence other SV is no longer copy on write either. */
3811 SvREADONLY_off(after);
3813 /* We need to follow the pointers around the loop. */
3815 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3818 /* don't loop forever if the structure is bust, and we have
3819 a pointer into a closed loop. */
3820 assert (current != after);
3821 assert (SvPVX_const(current) == pvx);
3823 /* Make the SV before us point to the SV after us. */
3824 SV_COW_NEXT_SV_SET(current, after);
3827 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3832 Perl_sv_release_IVX(pTHX_ register SV *sv)
3835 sv_force_normal_flags(sv, 0);
3841 =for apidoc sv_force_normal_flags
3843 Undo various types of fakery on an SV: if the PV is a shared string, make
3844 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3845 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3846 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3847 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3848 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3849 set to some other value.) In addition, the C<flags> parameter gets passed to
3850 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3851 with flags set to 0.
3857 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3860 #ifdef PERL_OLD_COPY_ON_WRITE
3861 if (SvREADONLY(sv)) {
3862 /* At this point I believe I should acquire a global SV mutex. */
3864 const char * const pvx = SvPVX_const(sv);
3865 const STRLEN len = SvLEN(sv);
3866 const STRLEN cur = SvCUR(sv);
3867 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3869 PerlIO_printf(Perl_debug_log,
3870 "Copy on write: Force normal %ld\n",
3876 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3879 if (flags & SV_COW_DROP_PV) {
3880 /* OK, so we don't need to copy our buffer. */
3883 SvGROW(sv, cur + 1);
3884 Move(pvx,SvPVX(sv),cur,char);
3888 sv_release_COW(sv, pvx, len, next);
3893 else if (IN_PERL_RUNTIME)
3894 Perl_croak(aTHX_ PL_no_modify);
3895 /* At this point I believe that I can drop the global SV mutex. */
3898 if (SvREADONLY(sv)) {
3900 const char * const pvx = SvPVX_const(sv);
3901 const STRLEN len = SvCUR(sv);
3906 SvGROW(sv, len + 1);
3907 Move(pvx,SvPVX(sv),len,char);
3909 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3911 else if (IN_PERL_RUNTIME)
3912 Perl_croak(aTHX_ PL_no_modify);
3916 sv_unref_flags(sv, flags);
3917 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3924 Efficient removal of characters from the beginning of the string buffer.
3925 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3926 the string buffer. The C<ptr> becomes the first character of the adjusted
3927 string. Uses the "OOK hack".
3928 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3929 refer to the same chunk of data.
3935 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3937 register STRLEN delta;
3938 if (!ptr || !SvPOKp(sv))
3940 delta = ptr - SvPVX_const(sv);
3941 SV_CHECK_THINKFIRST(sv);
3942 if (SvTYPE(sv) < SVt_PVIV)
3943 sv_upgrade(sv,SVt_PVIV);
3946 if (!SvLEN(sv)) { /* make copy of shared string */
3947 const char *pvx = SvPVX_const(sv);
3948 const STRLEN len = SvCUR(sv);
3949 SvGROW(sv, len + 1);
3950 Move(pvx,SvPVX(sv),len,char);
3954 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3955 and we do that anyway inside the SvNIOK_off
3957 SvFLAGS(sv) |= SVf_OOK;
3960 SvLEN_set(sv, SvLEN(sv) - delta);
3961 SvCUR_set(sv, SvCUR(sv) - delta);
3962 SvPV_set(sv, SvPVX(sv) + delta);
3963 SvIV_set(sv, SvIVX(sv) + delta);
3967 =for apidoc sv_catpvn
3969 Concatenates the string onto the end of the string which is in the SV. The
3970 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3971 status set, then the bytes appended should be valid UTF-8.
3972 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3974 =for apidoc sv_catpvn_flags
3976 Concatenates the string onto the end of the string which is in the SV. The
3977 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3978 status set, then the bytes appended should be valid UTF-8.
3979 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3980 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3981 in terms of this function.
3987 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3991 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3993 SvGROW(dsv, dlen + slen + 1);
3995 sstr = SvPVX_const(dsv);
3996 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3997 SvCUR_set(dsv, SvCUR(dsv) + slen);
3999 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4001 if (flags & SV_SMAGIC)
4006 =for apidoc sv_catsv
4008 Concatenates the string from SV C<ssv> onto the end of the string in
4009 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4010 not 'set' magic. See C<sv_catsv_mg>.
4012 =for apidoc sv_catsv_flags
4014 Concatenates the string from SV C<ssv> onto the end of the string in
4015 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4016 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4017 and C<sv_catsv_nomg> are implemented in terms of this function.
4022 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4027 const char *spv = SvPV_const(ssv, slen);
4029 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4030 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4031 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4032 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4033 dsv->sv_flags doesn't have that bit set.
4034 Andy Dougherty 12 Oct 2001
4036 const I32 sutf8 = DO_UTF8(ssv);
4039 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4041 dutf8 = DO_UTF8(dsv);
4043 if (dutf8 != sutf8) {
4045 /* Not modifying source SV, so taking a temporary copy. */
4046 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4048 sv_utf8_upgrade(csv);
4049 spv = SvPV_const(csv, slen);
4052 sv_utf8_upgrade_nomg(dsv);
4054 sv_catpvn_nomg(dsv, spv, slen);
4057 if (flags & SV_SMAGIC)
4062 =for apidoc sv_catpv
4064 Concatenates the string onto the end of the string which is in the SV.
4065 If the SV has the UTF-8 status set, then the bytes appended should be
4066 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4071 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4074 register STRLEN len;
4080 junk = SvPV_force(sv, tlen);
4082 SvGROW(sv, tlen + len + 1);
4084 ptr = SvPVX_const(sv);
4085 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4086 SvCUR_set(sv, SvCUR(sv) + len);
4087 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4092 =for apidoc sv_catpv_mg
4094 Like C<sv_catpv>, but also handles 'set' magic.
4100 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4109 Creates a new SV. A non-zero C<len> parameter indicates the number of
4110 bytes of preallocated string space the SV should have. An extra byte for a
4111 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4112 space is allocated.) The reference count for the new SV is set to 1.
4114 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4115 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4116 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4117 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4118 modules supporting older perls.
4124 Perl_newSV(pTHX_ STRLEN len)
4131 sv_upgrade(sv, SVt_PV);
4132 SvGROW(sv, len + 1);
4137 =for apidoc sv_magicext
4139 Adds magic to an SV, upgrading it if necessary. Applies the
4140 supplied vtable and returns a pointer to the magic added.
4142 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4143 In particular, you can add magic to SvREADONLY SVs, and add more than
4144 one instance of the same 'how'.
4146 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4147 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4148 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4149 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4151 (This is now used as a subroutine by C<sv_magic>.)
4156 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4157 const char* name, I32 namlen)
4162 if (SvTYPE(sv) < SVt_PVMG) {
4163 SvUPGRADE(sv, SVt_PVMG);
4165 Newxz(mg, 1, MAGIC);
4166 mg->mg_moremagic = SvMAGIC(sv);
4167 SvMAGIC_set(sv, mg);
4169 /* Sometimes a magic contains a reference loop, where the sv and
4170 object refer to each other. To prevent a reference loop that
4171 would prevent such objects being freed, we look for such loops
4172 and if we find one we avoid incrementing the object refcount.
4174 Note we cannot do this to avoid self-tie loops as intervening RV must
4175 have its REFCNT incremented to keep it in existence.
4178 if (!obj || obj == sv ||
4179 how == PERL_MAGIC_arylen ||
4180 how == PERL_MAGIC_qr ||
4181 how == PERL_MAGIC_symtab ||
4182 (SvTYPE(obj) == SVt_PVGV &&
4183 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4184 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4185 GvFORM(obj) == (CV*)sv)))
4190 mg->mg_obj = SvREFCNT_inc(obj);
4191 mg->mg_flags |= MGf_REFCOUNTED;
4194 /* Normal self-ties simply pass a null object, and instead of
4195 using mg_obj directly, use the SvTIED_obj macro to produce a
4196 new RV as needed. For glob "self-ties", we are tieing the PVIO
4197 with an RV obj pointing to the glob containing the PVIO. In
4198 this case, to avoid a reference loop, we need to weaken the
4202 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4203 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4209 mg->mg_len = namlen;
4212 mg->mg_ptr = savepvn(name, namlen);
4213 else if (namlen == HEf_SVKEY)
4214 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4216 mg->mg_ptr = (char *) name;
4218 mg->mg_virtual = vtable;
4222 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4227 =for apidoc sv_magic
4229 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4230 then adds a new magic item of type C<how> to the head of the magic list.
4232 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4233 handling of the C<name> and C<namlen> arguments.
4235 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4236 to add more than one instance of the same 'how'.
4242 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4248 #ifdef PERL_OLD_COPY_ON_WRITE
4250 sv_force_normal_flags(sv, 0);
4252 if (SvREADONLY(sv)) {
4254 /* its okay to attach magic to shared strings; the subsequent
4255 * upgrade to PVMG will unshare the string */
4256 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4259 && how != PERL_MAGIC_regex_global
4260 && how != PERL_MAGIC_bm
4261 && how != PERL_MAGIC_fm
4262 && how != PERL_MAGIC_sv
4263 && how != PERL_MAGIC_backref
4266 Perl_croak(aTHX_ PL_no_modify);
4269 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4270 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4271 /* sv_magic() refuses to add a magic of the same 'how' as an
4274 if (how == PERL_MAGIC_taint)
4282 vtable = &PL_vtbl_sv;
4284 case PERL_MAGIC_overload:
4285 vtable = &PL_vtbl_amagic;
4287 case PERL_MAGIC_overload_elem:
4288 vtable = &PL_vtbl_amagicelem;
4290 case PERL_MAGIC_overload_table:
4291 vtable = &PL_vtbl_ovrld;
4294 vtable = &PL_vtbl_bm;
4296 case PERL_MAGIC_regdata:
4297 vtable = &PL_vtbl_regdata;
4299 case PERL_MAGIC_regdatum:
4300 vtable = &PL_vtbl_regdatum;
4302 case PERL_MAGIC_env:
4303 vtable = &PL_vtbl_env;
4306 vtable = &PL_vtbl_fm;
4308 case PERL_MAGIC_envelem:
4309 vtable = &PL_vtbl_envelem;
4311 case PERL_MAGIC_regex_global:
4312 vtable = &PL_vtbl_mglob;
4314 case PERL_MAGIC_isa:
4315 vtable = &PL_vtbl_isa;
4317 case PERL_MAGIC_isaelem:
4318 vtable = &PL_vtbl_isaelem;
4320 case PERL_MAGIC_nkeys:
4321 vtable = &PL_vtbl_nkeys;
4323 case PERL_MAGIC_dbfile:
4326 case PERL_MAGIC_dbline:
4327 vtable = &PL_vtbl_dbline;
4329 #ifdef USE_LOCALE_COLLATE
4330 case PERL_MAGIC_collxfrm:
4331 vtable = &PL_vtbl_collxfrm;
4333 #endif /* USE_LOCALE_COLLATE */
4334 case PERL_MAGIC_tied:
4335 vtable = &PL_vtbl_pack;
4337 case PERL_MAGIC_tiedelem:
4338 case PERL_MAGIC_tiedscalar:
4339 vtable = &PL_vtbl_packelem;
4342 vtable = &PL_vtbl_regexp;
4344 case PERL_MAGIC_sig:
4345 vtable = &PL_vtbl_sig;
4347 case PERL_MAGIC_sigelem:
4348 vtable = &PL_vtbl_sigelem;
4350 case PERL_MAGIC_taint:
4351 vtable = &PL_vtbl_taint;
4353 case PERL_MAGIC_uvar:
4354 vtable = &PL_vtbl_uvar;
4356 case PERL_MAGIC_vec:
4357 vtable = &PL_vtbl_vec;
4359 case PERL_MAGIC_arylen_p:
4360 case PERL_MAGIC_rhash:
4361 case PERL_MAGIC_symtab:
4362 case PERL_MAGIC_vstring:
4365 case PERL_MAGIC_utf8:
4366 vtable = &PL_vtbl_utf8;
4368 case PERL_MAGIC_substr:
4369 vtable = &PL_vtbl_substr;
4371 case PERL_MAGIC_defelem:
4372 vtable = &PL_vtbl_defelem;
4374 case PERL_MAGIC_glob:
4375 vtable = &PL_vtbl_glob;
4377 case PERL_MAGIC_arylen:
4378 vtable = &PL_vtbl_arylen;
4380 case PERL_MAGIC_pos:
4381 vtable = &PL_vtbl_pos;
4383 case PERL_MAGIC_backref:
4384 vtable = &PL_vtbl_backref;
4386 case PERL_MAGIC_ext:
4387 /* Reserved for use by extensions not perl internals. */
4388 /* Useful for attaching extension internal data to perl vars. */
4389 /* Note that multiple extensions may clash if magical scalars */
4390 /* etc holding private data from one are passed to another. */
4394 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4397 /* Rest of work is done else where */
4398 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4401 case PERL_MAGIC_taint:
4404 case PERL_MAGIC_ext:
4405 case PERL_MAGIC_dbfile:
4412 =for apidoc sv_unmagic
4414 Removes all magic of type C<type> from an SV.
4420 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4424 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4427 for (mg = *mgp; mg; mg = *mgp) {
4428 if (mg->mg_type == type) {
4429 const MGVTBL* const vtbl = mg->mg_virtual;
4430 *mgp = mg->mg_moremagic;
4431 if (vtbl && vtbl->svt_free)
4432 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4433 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4435 Safefree(mg->mg_ptr);
4436 else if (mg->mg_len == HEf_SVKEY)
4437 SvREFCNT_dec((SV*)mg->mg_ptr);
4438 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4439 Safefree(mg->mg_ptr);
4441 if (mg->mg_flags & MGf_REFCOUNTED)
4442 SvREFCNT_dec(mg->mg_obj);
4446 mgp = &mg->mg_moremagic;
4450 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4451 SvMAGIC_set(sv, NULL);
4458 =for apidoc sv_rvweaken
4460 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4461 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4462 push a back-reference to this RV onto the array of backreferences
4463 associated with that magic.
4469 Perl_sv_rvweaken(pTHX_ SV *sv)
4472 if (!SvOK(sv)) /* let undefs pass */
4475 Perl_croak(aTHX_ "Can't weaken a nonreference");
4476 else if (SvWEAKREF(sv)) {
4477 if (ckWARN(WARN_MISC))
4478 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4482 Perl_sv_add_backref(aTHX_ tsv, sv);
4488 /* Give tsv backref magic if it hasn't already got it, then push a
4489 * back-reference to sv onto the array associated with the backref magic.
4493 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4498 if (SvTYPE(tsv) == SVt_PVHV) {
4499 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4503 /* There is no AV in the offical place - try a fixup. */
4504 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4507 /* Aha. They've got it stowed in magic. Bring it back. */
4508 av = (AV*)mg->mg_obj;
4509 /* Stop mg_free decreasing the refernce count. */
4511 /* Stop mg_free even calling the destructor, given that
4512 there's no AV to free up. */
4514 sv_unmagic(tsv, PERL_MAGIC_backref);
4523 const MAGIC *const mg
4524 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4526 av = (AV*)mg->mg_obj;
4530 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4531 /* av now has a refcnt of 2, which avoids it getting freed
4532 * before us during global cleanup. The extra ref is removed
4533 * by magic_killbackrefs() when tsv is being freed */
4536 if (AvFILLp(av) >= AvMAX(av)) {
4537 av_extend(av, AvFILLp(av)+1);
4539 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4542 /* delete a back-reference to ourselves from the backref magic associated
4543 * with the SV we point to.
4547 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4554 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4555 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4556 /* We mustn't attempt to "fix up" the hash here by moving the
4557 backreference array back to the hv_aux structure, as that is stored
4558 in the main HvARRAY(), and hfreentries assumes that no-one
4559 reallocates HvARRAY() while it is running. */
4562 const MAGIC *const mg
4563 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4565 av = (AV *)mg->mg_obj;
4568 if (PL_in_clean_all)
4570 Perl_croak(aTHX_ "panic: del_backref");
4577 /* We shouldn't be in here more than once, but for paranoia reasons lets
4579 for (i = AvFILLp(av); i >= 0; i--) {
4581 const SSize_t fill = AvFILLp(av);
4583 /* We weren't the last entry.
4584 An unordered list has this property that you can take the
4585 last element off the end to fill the hole, and it's still
4586 an unordered list :-)
4591 AvFILLp(av) = fill - 1;
4597 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4599 SV **svp = AvARRAY(av);
4601 PERL_UNUSED_ARG(sv);
4603 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4604 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4605 if (svp && !SvIS_FREED(av)) {
4606 SV *const *const last = svp + AvFILLp(av);
4608 while (svp <= last) {
4610 SV *const referrer = *svp;
4611 if (SvWEAKREF(referrer)) {
4612 /* XXX Should we check that it hasn't changed? */
4613 SvRV_set(referrer, 0);
4615 SvWEAKREF_off(referrer);
4616 } else if (SvTYPE(referrer) == SVt_PVGV ||
4617 SvTYPE(referrer) == SVt_PVLV) {
4618 /* You lookin' at me? */
4619 assert(GvSTASH(referrer));
4620 assert(GvSTASH(referrer) == (HV*)sv);
4621 GvSTASH(referrer) = 0;
4624 "panic: magic_killbackrefs (flags=%"UVxf")",
4625 (UV)SvFLAGS(referrer));
4633 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4638 =for apidoc sv_insert
4640 Inserts a string at the specified offset/length within the SV. Similar to
4641 the Perl substr() function.
4647 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4652 register char *midend;
4653 register char *bigend;
4659 Perl_croak(aTHX_ "Can't modify non-existent substring");
4660 SvPV_force(bigstr, curlen);
4661 (void)SvPOK_only_UTF8(bigstr);
4662 if (offset + len > curlen) {
4663 SvGROW(bigstr, offset+len+1);
4664 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4665 SvCUR_set(bigstr, offset+len);
4669 i = littlelen - len;
4670 if (i > 0) { /* string might grow */
4671 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4672 mid = big + offset + len;
4673 midend = bigend = big + SvCUR(bigstr);
4676 while (midend > mid) /* shove everything down */
4677 *--bigend = *--midend;
4678 Move(little,big+offset,littlelen,char);
4679 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4684 Move(little,SvPVX(bigstr)+offset,len,char);
4689 big = SvPVX(bigstr);
4692 bigend = big + SvCUR(bigstr);
4694 if (midend > bigend)
4695 Perl_croak(aTHX_ "panic: sv_insert");
4697 if (mid - big > bigend - midend) { /* faster to shorten from end */
4699 Move(little, mid, littlelen,char);
4702 i = bigend - midend;
4704 Move(midend, mid, i,char);
4708 SvCUR_set(bigstr, mid - big);
4710 else if ((i = mid - big)) { /* faster from front */
4711 midend -= littlelen;
4713 sv_chop(bigstr,midend-i);
4718 Move(little, mid, littlelen,char);
4720 else if (littlelen) {
4721 midend -= littlelen;
4722 sv_chop(bigstr,midend);
4723 Move(little,midend,littlelen,char);
4726 sv_chop(bigstr,midend);
4732 =for apidoc sv_replace
4734 Make the first argument a copy of the second, then delete the original.
4735 The target SV physically takes over ownership of the body of the source SV
4736 and inherits its flags; however, the target keeps any magic it owns,
4737 and any magic in the source is discarded.
4738 Note that this is a rather specialist SV copying operation; most of the
4739 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4745 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4748 const U32 refcnt = SvREFCNT(sv);
4749 SV_CHECK_THINKFIRST_COW_DROP(sv);
4750 if (SvREFCNT(nsv) != 1) {
4751 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4752 UVuf " != 1)", (UV) SvREFCNT(nsv));
4754 if (SvMAGICAL(sv)) {
4758 sv_upgrade(nsv, SVt_PVMG);
4759 SvMAGIC_set(nsv, SvMAGIC(sv));
4760 SvFLAGS(nsv) |= SvMAGICAL(sv);
4762 SvMAGIC_set(sv, NULL);
4766 assert(!SvREFCNT(sv));
4767 #ifdef DEBUG_LEAKING_SCALARS
4768 sv->sv_flags = nsv->sv_flags;
4769 sv->sv_any = nsv->sv_any;
4770 sv->sv_refcnt = nsv->sv_refcnt;
4771 sv->sv_u = nsv->sv_u;
4773 StructCopy(nsv,sv,SV);
4775 /* Currently could join these into one piece of pointer arithmetic, but
4776 it would be unclear. */
4777 if(SvTYPE(sv) == SVt_IV)
4779 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4780 else if (SvTYPE(sv) == SVt_RV) {
4781 SvANY(sv) = &sv->sv_u.svu_rv;
4785 #ifdef PERL_OLD_COPY_ON_WRITE
4786 if (SvIsCOW_normal(nsv)) {
4787 /* We need to follow the pointers around the loop to make the
4788 previous SV point to sv, rather than nsv. */
4791 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4794 assert(SvPVX_const(current) == SvPVX_const(nsv));
4796 /* Make the SV before us point to the SV after us. */
4798 PerlIO_printf(Perl_debug_log, "previous is\n");
4800 PerlIO_printf(Perl_debug_log,
4801 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4802 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4804 SV_COW_NEXT_SV_SET(current, sv);
4807 SvREFCNT(sv) = refcnt;
4808 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4814 =for apidoc sv_clear
4816 Clear an SV: call any destructors, free up any memory used by the body,
4817 and free the body itself. The SV's head is I<not> freed, although
4818 its type is set to all 1's so that it won't inadvertently be assumed
4819 to be live during global destruction etc.
4820 This function should only be called when REFCNT is zero. Most of the time
4821 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4828 Perl_sv_clear(pTHX_ register SV *sv)
4831 const U32 type = SvTYPE(sv);
4832 const struct body_details *const sv_type_details
4833 = bodies_by_type + type;
4836 assert(SvREFCNT(sv) == 0);
4842 if (PL_defstash) { /* Still have a symbol table? */
4847 stash = SvSTASH(sv);
4848 destructor = StashHANDLER(stash,DESTROY);
4850 SV* const tmpref = newRV(sv);
4851 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4853 PUSHSTACKi(PERLSI_DESTROY);
4858 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4864 if(SvREFCNT(tmpref) < 2) {
4865 /* tmpref is not kept alive! */
4867 SvRV_set(tmpref, NULL);
4870 SvREFCNT_dec(tmpref);
4872 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4876 if (PL_in_clean_objs)
4877 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4879 /* DESTROY gave object new lease on life */
4885 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4886 SvOBJECT_off(sv); /* Curse the object. */
4887 if (type != SVt_PVIO)
4888 --PL_sv_objcount; /* XXX Might want something more general */
4891 if (type >= SVt_PVMG) {
4894 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4895 SvREFCNT_dec(SvSTASH(sv));
4900 IoIFP(sv) != PerlIO_stdin() &&
4901 IoIFP(sv) != PerlIO_stdout() &&
4902 IoIFP(sv) != PerlIO_stderr())
4904 io_close((IO*)sv, FALSE);
4906 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4907 PerlDir_close(IoDIRP(sv));
4908 IoDIRP(sv) = (DIR*)NULL;
4909 Safefree(IoTOP_NAME(sv));
4910 Safefree(IoFMT_NAME(sv));
4911 Safefree(IoBOTTOM_NAME(sv));
4920 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4927 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4928 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4929 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4930 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4932 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4933 SvREFCNT_dec(LvTARG(sv));
4937 Safefree(GvNAME(sv));
4938 /* If we're in a stash, we don't own a reference to it. However it does
4939 have a back reference to us, which needs to be cleared. */
4941 sv_del_backref((SV*)GvSTASH(sv), sv);
4946 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4948 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4949 /* Don't even bother with turning off the OOK flag. */
4954 SV *target = SvRV(sv);
4956 sv_del_backref(target, sv);
4958 SvREFCNT_dec(target);
4960 #ifdef PERL_OLD_COPY_ON_WRITE
4961 else if (SvPVX_const(sv)) {
4963 /* I believe I need to grab the global SV mutex here and
4964 then recheck the COW status. */
4966 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4969 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4970 SV_COW_NEXT_SV(sv));
4971 /* And drop it here. */
4973 } else if (SvLEN(sv)) {
4974 Safefree(SvPVX_const(sv));
4978 else if (SvPVX_const(sv) && SvLEN(sv))
4979 Safefree(SvPVX_mutable(sv));
4980 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4981 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4990 SvFLAGS(sv) &= SVf_BREAK;
4991 SvFLAGS(sv) |= SVTYPEMASK;
4993 if (sv_type_details->arena) {
4994 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4995 &PL_body_roots[type]);
4997 else if (sv_type_details->size) {
4998 my_safefree(SvANY(sv));
5003 =for apidoc sv_newref
5005 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5012 Perl_sv_newref(pTHX_ SV *sv)
5022 Decrement an SV's reference count, and if it drops to zero, call
5023 C<sv_clear> to invoke destructors and free up any memory used by
5024 the body; finally, deallocate the SV's head itself.
5025 Normally called via a wrapper macro C<SvREFCNT_dec>.
5031 Perl_sv_free(pTHX_ SV *sv)
5036 if (SvREFCNT(sv) == 0) {
5037 if (SvFLAGS(sv) & SVf_BREAK)
5038 /* this SV's refcnt has been artificially decremented to
5039 * trigger cleanup */
5041 if (PL_in_clean_all) /* All is fair */
5043 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5044 /* make sure SvREFCNT(sv)==0 happens very seldom */
5045 SvREFCNT(sv) = (~(U32)0)/2;
5048 if (ckWARN_d(WARN_INTERNAL)) {
5049 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5050 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5051 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5052 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5053 Perl_dump_sv_child(aTHX_ sv);
5058 if (--(SvREFCNT(sv)) > 0)
5060 Perl_sv_free2(aTHX_ sv);
5064 Perl_sv_free2(pTHX_ SV *sv)
5069 if (ckWARN_d(WARN_DEBUGGING))
5070 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5071 "Attempt to free temp prematurely: SV 0x%"UVxf
5072 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5076 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5077 /* make sure SvREFCNT(sv)==0 happens very seldom */
5078 SvREFCNT(sv) = (~(U32)0)/2;
5089 Returns the length of the string in the SV. Handles magic and type
5090 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5096 Perl_sv_len(pTHX_ register SV *sv)
5104 len = mg_length(sv);
5106 (void)SvPV_const(sv, len);
5111 =for apidoc sv_len_utf8
5113 Returns the number of characters in the string in an SV, counting wide
5114 UTF-8 bytes as a single character. Handles magic and type coercion.
5120 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5121 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5122 * (Note that the mg_len is not the length of the mg_ptr field.)
5127 Perl_sv_len_utf8(pTHX_ register SV *sv)
5133 return mg_length(sv);
5137 const U8 *s = (U8*)SvPV_const(sv, len);
5138 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5140 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5142 #ifdef PERL_UTF8_CACHE_ASSERT
5143 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5147 ulen = Perl_utf8_length(aTHX_ s, s + len);
5148 if (!mg && !SvREADONLY(sv)) {
5149 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5150 mg = mg_find(sv, PERL_MAGIC_utf8);
5160 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5161 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5162 * between UTF-8 and byte offsets. There are two (substr offset and substr
5163 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5164 * and byte offset) cache positions.
5166 * The mg_len field is used by sv_len_utf8(), see its comments.
5167 * Note that the mg_len is not the length of the mg_ptr field.
5171 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5172 I32 offsetp, const U8 *s, const U8 *start)
5176 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5178 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5182 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5184 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5185 (*mgp)->mg_ptr = (char *) *cachep;
5189 (*cachep)[i] = offsetp;
5190 (*cachep)[i+1] = s - start;
5198 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5199 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5200 * between UTF-8 and byte offsets. See also the comments of
5201 * S_utf8_mg_pos_init().
5205 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5209 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5211 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5212 if (*mgp && (*mgp)->mg_ptr) {
5213 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5214 ASSERT_UTF8_CACHE(*cachep);
5215 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5217 else { /* We will skip to the right spot. */
5222 /* The assumption is that going backward is half
5223 * the speed of going forward (that's where the
5224 * 2 * backw in the below comes from). (The real
5225 * figure of course depends on the UTF-8 data.) */
5227 if ((*cachep)[i] > (STRLEN)uoff) {
5229 backw = (*cachep)[i] - (STRLEN)uoff;
5231 if (forw < 2 * backw)
5234 p = start + (*cachep)[i+1];
5236 /* Try this only for the substr offset (i == 0),
5237 * not for the substr length (i == 2). */
5238 else if (i == 0) { /* (*cachep)[i] < uoff */
5239 const STRLEN ulen = sv_len_utf8(sv);
5241 if ((STRLEN)uoff < ulen) {
5242 forw = (STRLEN)uoff - (*cachep)[i];
5243 backw = ulen - (STRLEN)uoff;
5245 if (forw < 2 * backw)
5246 p = start + (*cachep)[i+1];
5251 /* If the string is not long enough for uoff,
5252 * we could extend it, but not at this low a level. */
5256 if (forw < 2 * backw) {
5263 while (UTF8_IS_CONTINUATION(*p))
5268 /* Update the cache. */
5269 (*cachep)[i] = (STRLEN)uoff;
5270 (*cachep)[i+1] = p - start;
5272 /* Drop the stale "length" cache */
5281 if (found) { /* Setup the return values. */
5282 *offsetp = (*cachep)[i+1];
5283 *sp = start + *offsetp;
5286 *offsetp = send - start;
5288 else if (*sp < start) {
5294 #ifdef PERL_UTF8_CACHE_ASSERT
5299 while (n-- && s < send)
5303 assert(*offsetp == s - start);
5304 assert((*cachep)[0] == (STRLEN)uoff);
5305 assert((*cachep)[1] == *offsetp);
5307 ASSERT_UTF8_CACHE(*cachep);
5316 =for apidoc sv_pos_u2b
5318 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5319 the start of the string, to a count of the equivalent number of bytes; if
5320 lenp is non-zero, it does the same to lenp, but this time starting from
5321 the offset, rather than from the start of the string. Handles magic and
5328 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5329 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5330 * byte offsets. See also the comments of S_utf8_mg_pos().
5335 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5343 start = (U8*)SvPV_const(sv, len);
5346 STRLEN *cache = NULL;
5347 const U8 *s = start;
5348 I32 uoffset = *offsetp;
5349 const U8 * const send = s + len;
5351 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5353 if (!found && uoffset > 0) {
5354 while (s < send && uoffset--)
5358 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5360 *offsetp = s - start;
5365 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5369 if (!found && *lenp > 0) {
5372 while (s < send && ulen--)
5376 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5380 ASSERT_UTF8_CACHE(cache);
5392 =for apidoc sv_pos_b2u
5394 Converts the value pointed to by offsetp from a count of bytes from the
5395 start of the string, to a count of the equivalent number of UTF-8 chars.
5396 Handles magic and type coercion.
5402 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5403 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5404 * byte offsets. See also the comments of S_utf8_mg_pos().
5409 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5417 s = (const U8*)SvPV_const(sv, len);
5418 if ((I32)len < *offsetp)
5419 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5421 const U8* send = s + *offsetp;
5423 STRLEN *cache = NULL;
5427 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5428 mg = mg_find(sv, PERL_MAGIC_utf8);
5429 if (mg && mg->mg_ptr) {
5430 cache = (STRLEN *) mg->mg_ptr;
5431 if (cache[1] == (STRLEN)*offsetp) {
5432 /* An exact match. */
5433 *offsetp = cache[0];
5437 else if (cache[1] < (STRLEN)*offsetp) {
5438 /* We already know part of the way. */
5441 /* Let the below loop do the rest. */
5443 else { /* cache[1] > *offsetp */
5444 /* We already know all of the way, now we may
5445 * be able to walk back. The same assumption
5446 * is made as in S_utf8_mg_pos(), namely that
5447 * walking backward is twice slower than
5448 * walking forward. */
5449 const STRLEN forw = *offsetp;
5450 STRLEN backw = cache[1] - *offsetp;
5452 if (!(forw < 2 * backw)) {
5453 const U8 *p = s + cache[1];
5460 while (UTF8_IS_CONTINUATION(*p)) {
5468 *offsetp = cache[0];
5470 /* Drop the stale "length" cache */
5478 ASSERT_UTF8_CACHE(cache);
5484 /* Call utf8n_to_uvchr() to validate the sequence
5485 * (unless a simple non-UTF character) */
5486 if (!UTF8_IS_INVARIANT(*s))
5487 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5496 if (!SvREADONLY(sv)) {
5498 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5499 mg = mg_find(sv, PERL_MAGIC_utf8);
5504 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5505 mg->mg_ptr = (char *) cache;
5510 cache[1] = *offsetp;
5511 /* Drop the stale "length" cache */
5524 Returns a boolean indicating whether the strings in the two SVs are
5525 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5526 coerce its args to strings if necessary.
5532 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5541 SV* svrecode = NULL;
5548 pv1 = SvPV_const(sv1, cur1);
5555 pv2 = SvPV_const(sv2, cur2);
5557 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5558 /* Differing utf8ness.
5559 * Do not UTF8size the comparands as a side-effect. */
5562 svrecode = newSVpvn(pv2, cur2);
5563 sv_recode_to_utf8(svrecode, PL_encoding);
5564 pv2 = SvPV_const(svrecode, cur2);
5567 svrecode = newSVpvn(pv1, cur1);
5568 sv_recode_to_utf8(svrecode, PL_encoding);
5569 pv1 = SvPV_const(svrecode, cur1);
5571 /* Now both are in UTF-8. */
5573 SvREFCNT_dec(svrecode);
5578 bool is_utf8 = TRUE;
5581 /* sv1 is the UTF-8 one,
5582 * if is equal it must be downgrade-able */
5583 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5589 /* sv2 is the UTF-8 one,
5590 * if is equal it must be downgrade-able */
5591 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5597 /* Downgrade not possible - cannot be eq */
5605 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5608 SvREFCNT_dec(svrecode);
5619 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5620 string in C<sv1> is less than, equal to, or greater than the string in
5621 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5622 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5628 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5632 const char *pv1, *pv2;
5635 SV *svrecode = NULL;
5642 pv1 = SvPV_const(sv1, cur1);
5649 pv2 = SvPV_const(sv2, cur2);
5651 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5652 /* Differing utf8ness.
5653 * Do not UTF8size the comparands as a side-effect. */
5656 svrecode = newSVpvn(pv2, cur2);
5657 sv_recode_to_utf8(svrecode, PL_encoding);
5658 pv2 = SvPV_const(svrecode, cur2);
5661 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5666 svrecode = newSVpvn(pv1, cur1);
5667 sv_recode_to_utf8(svrecode, PL_encoding);
5668 pv1 = SvPV_const(svrecode, cur1);
5671 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5677 cmp = cur2 ? -1 : 0;
5681 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5684 cmp = retval < 0 ? -1 : 1;
5685 } else if (cur1 == cur2) {
5688 cmp = cur1 < cur2 ? -1 : 1;
5693 SvREFCNT_dec(svrecode);
5702 =for apidoc sv_cmp_locale
5704 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5705 'use bytes' aware, handles get magic, and will coerce its args to strings
5706 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5712 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5715 #ifdef USE_LOCALE_COLLATE
5721 if (PL_collation_standard)
5725 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5727 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5729 if (!pv1 || !len1) {
5740 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5743 return retval < 0 ? -1 : 1;
5746 * When the result of collation is equality, that doesn't mean
5747 * that there are no differences -- some locales exclude some
5748 * characters from consideration. So to avoid false equalities,
5749 * we use the raw string as a tiebreaker.
5755 #endif /* USE_LOCALE_COLLATE */
5757 return sv_cmp(sv1, sv2);
5761 #ifdef USE_LOCALE_COLLATE
5764 =for apidoc sv_collxfrm
5766 Add Collate Transform magic to an SV if it doesn't already have it.
5768 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5769 scalar data of the variable, but transformed to such a format that a normal
5770 memory comparison can be used to compare the data according to the locale
5777 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5782 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5783 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5789 Safefree(mg->mg_ptr);
5790 s = SvPV_const(sv, len);
5791 if ((xf = mem_collxfrm(s, len, &xlen))) {
5792 if (SvREADONLY(sv)) {
5795 return xf + sizeof(PL_collation_ix);
5798 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5799 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5812 if (mg && mg->mg_ptr) {
5814 return mg->mg_ptr + sizeof(PL_collation_ix);
5822 #endif /* USE_LOCALE_COLLATE */
5827 Get a line from the filehandle and store it into the SV, optionally
5828 appending to the currently-stored string.
5834 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5839 register STDCHAR rslast;
5840 register STDCHAR *bp;
5846 if (SvTHINKFIRST(sv))
5847 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5848 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5850 However, perlbench says it's slower, because the existing swipe code
5851 is faster than copy on write.
5852 Swings and roundabouts. */
5853 SvUPGRADE(sv, SVt_PV);
5858 if (PerlIO_isutf8(fp)) {
5860 sv_utf8_upgrade_nomg(sv);
5861 sv_pos_u2b(sv,&append,0);
5863 } else if (SvUTF8(sv)) {
5864 SV * const tsv = newSV(0);
5865 sv_gets(tsv, fp, 0);
5866 sv_utf8_upgrade_nomg(tsv);
5867 SvCUR_set(sv,append);
5870 goto return_string_or_null;
5875 if (PerlIO_isutf8(fp))
5878 if (IN_PERL_COMPILETIME) {
5879 /* we always read code in line mode */
5883 else if (RsSNARF(PL_rs)) {
5884 /* If it is a regular disk file use size from stat() as estimate
5885 of amount we are going to read - may result in malloc-ing
5886 more memory than we realy need if layers bellow reduce
5887 size we read (e.g. CRLF or a gzip layer)
5890 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5891 const Off_t offset = PerlIO_tell(fp);
5892 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5893 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5899 else if (RsRECORD(PL_rs)) {
5903 /* Grab the size of the record we're getting */
5904 recsize = SvIV(SvRV(PL_rs));
5905 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5908 /* VMS wants read instead of fread, because fread doesn't respect */
5909 /* RMS record boundaries. This is not necessarily a good thing to be */
5910 /* doing, but we've got no other real choice - except avoid stdio
5911 as implementation - perhaps write a :vms layer ?
5913 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5915 bytesread = PerlIO_read(fp, buffer, recsize);
5919 SvCUR_set(sv, bytesread += append);
5920 buffer[bytesread] = '\0';
5921 goto return_string_or_null;
5923 else if (RsPARA(PL_rs)) {
5929 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5930 if (PerlIO_isutf8(fp)) {
5931 rsptr = SvPVutf8(PL_rs, rslen);
5934 if (SvUTF8(PL_rs)) {
5935 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5936 Perl_croak(aTHX_ "Wide character in $/");
5939 rsptr = SvPV_const(PL_rs, rslen);
5943 rslast = rslen ? rsptr[rslen - 1] : '\0';
5945 if (rspara) { /* have to do this both before and after */
5946 do { /* to make sure file boundaries work right */
5949 i = PerlIO_getc(fp);
5953 PerlIO_ungetc(fp,i);
5959 /* See if we know enough about I/O mechanism to cheat it ! */
5961 /* This used to be #ifdef test - it is made run-time test for ease
5962 of abstracting out stdio interface. One call should be cheap
5963 enough here - and may even be a macro allowing compile
5967 if (PerlIO_fast_gets(fp)) {
5970 * We're going to steal some values from the stdio struct
5971 * and put EVERYTHING in the innermost loop into registers.
5973 register STDCHAR *ptr;
5977 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5978 /* An ungetc()d char is handled separately from the regular
5979 * buffer, so we getc() it back out and stuff it in the buffer.
5981 i = PerlIO_getc(fp);
5982 if (i == EOF) return 0;
5983 *(--((*fp)->_ptr)) = (unsigned char) i;
5987 /* Here is some breathtakingly efficient cheating */
5989 cnt = PerlIO_get_cnt(fp); /* get count into register */
5990 /* make sure we have the room */
5991 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5992 /* Not room for all of it
5993 if we are looking for a separator and room for some
5995 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5996 /* just process what we have room for */
5997 shortbuffered = cnt - SvLEN(sv) + append + 1;
5998 cnt -= shortbuffered;
6002 /* remember that cnt can be negative */
6003 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6008 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6009 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6010 DEBUG_P(PerlIO_printf(Perl_debug_log,
6011 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6012 DEBUG_P(PerlIO_printf(Perl_debug_log,
6013 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6014 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6015 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6020 while (cnt > 0) { /* this | eat */
6022 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6023 goto thats_all_folks; /* screams | sed :-) */
6027 Copy(ptr, bp, cnt, char); /* this | eat */
6028 bp += cnt; /* screams | dust */
6029 ptr += cnt; /* louder | sed :-) */
6034 if (shortbuffered) { /* oh well, must extend */
6035 cnt = shortbuffered;
6037 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6039 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6040 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6044 DEBUG_P(PerlIO_printf(Perl_debug_log,
6045 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6046 PTR2UV(ptr),(long)cnt));
6047 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6049 DEBUG_P(PerlIO_printf(Perl_debug_log,
6050 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6051 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6052 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6054 /* This used to call 'filbuf' in stdio form, but as that behaves like
6055 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6056 another abstraction. */
6057 i = PerlIO_getc(fp); /* get more characters */
6059 DEBUG_P(PerlIO_printf(Perl_debug_log,
6060 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6061 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6062 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6064 cnt = PerlIO_get_cnt(fp);
6065 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6066 DEBUG_P(PerlIO_printf(Perl_debug_log,
6067 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6069 if (i == EOF) /* all done for ever? */
6070 goto thats_really_all_folks;
6072 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6074 SvGROW(sv, bpx + cnt + 2);
6075 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6077 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6079 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6080 goto thats_all_folks;
6084 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6085 memNE((char*)bp - rslen, rsptr, rslen))
6086 goto screamer; /* go back to the fray */
6087 thats_really_all_folks:
6089 cnt += shortbuffered;
6090 DEBUG_P(PerlIO_printf(Perl_debug_log,
6091 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6092 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6093 DEBUG_P(PerlIO_printf(Perl_debug_log,
6094 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6095 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6096 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6098 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6099 DEBUG_P(PerlIO_printf(Perl_debug_log,
6100 "Screamer: done, len=%ld, string=|%.*s|\n",
6101 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6105 /*The big, slow, and stupid way. */
6106 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6107 STDCHAR *buf = NULL;
6108 Newx(buf, 8192, STDCHAR);
6116 register const STDCHAR * const bpe = buf + sizeof(buf);
6118 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6119 ; /* keep reading */
6123 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6124 /* Accomodate broken VAXC compiler, which applies U8 cast to
6125 * both args of ?: operator, causing EOF to change into 255
6128 i = (U8)buf[cnt - 1];
6134 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6136 sv_catpvn(sv, (char *) buf, cnt);
6138 sv_setpvn(sv, (char *) buf, cnt);
6140 if (i != EOF && /* joy */
6142 SvCUR(sv) < rslen ||
6143 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6147 * If we're reading from a TTY and we get a short read,
6148 * indicating that the user hit his EOF character, we need
6149 * to notice it now, because if we try to read from the TTY
6150 * again, the EOF condition will disappear.
6152 * The comparison of cnt to sizeof(buf) is an optimization
6153 * that prevents unnecessary calls to feof().
6157 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6161 #ifdef USE_HEAP_INSTEAD_OF_STACK
6166 if (rspara) { /* have to do this both before and after */
6167 while (i != EOF) { /* to make sure file boundaries work right */
6168 i = PerlIO_getc(fp);
6170 PerlIO_ungetc(fp,i);
6176 return_string_or_null:
6177 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6183 Auto-increment of the value in the SV, doing string to numeric conversion
6184 if necessary. Handles 'get' magic.
6190 Perl_sv_inc(pTHX_ register SV *sv)
6199 if (SvTHINKFIRST(sv)) {
6201 sv_force_normal_flags(sv, 0);
6202 if (SvREADONLY(sv)) {
6203 if (IN_PERL_RUNTIME)
6204 Perl_croak(aTHX_ PL_no_modify);
6208 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6210 i = PTR2IV(SvRV(sv));
6215 flags = SvFLAGS(sv);
6216 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6217 /* It's (privately or publicly) a float, but not tested as an
6218 integer, so test it to see. */
6220 flags = SvFLAGS(sv);
6222 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6223 /* It's publicly an integer, or privately an integer-not-float */
6224 #ifdef PERL_PRESERVE_IVUV
6228 if (SvUVX(sv) == UV_MAX)
6229 sv_setnv(sv, UV_MAX_P1);
6231 (void)SvIOK_only_UV(sv);
6232 SvUV_set(sv, SvUVX(sv) + 1);
6234 if (SvIVX(sv) == IV_MAX)
6235 sv_setuv(sv, (UV)IV_MAX + 1);
6237 (void)SvIOK_only(sv);
6238 SvIV_set(sv, SvIVX(sv) + 1);
6243 if (flags & SVp_NOK) {
6244 (void)SvNOK_only(sv);
6245 SvNV_set(sv, SvNVX(sv) + 1.0);
6249 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6250 if ((flags & SVTYPEMASK) < SVt_PVIV)
6251 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6252 (void)SvIOK_only(sv);
6257 while (isALPHA(*d)) d++;
6258 while (isDIGIT(*d)) d++;
6260 #ifdef PERL_PRESERVE_IVUV
6261 /* Got to punt this as an integer if needs be, but we don't issue
6262 warnings. Probably ought to make the sv_iv_please() that does
6263 the conversion if possible, and silently. */
6264 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6265 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6266 /* Need to try really hard to see if it's an integer.
6267 9.22337203685478e+18 is an integer.
6268 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6269 so $a="9.22337203685478e+18"; $a+0; $a++
6270 needs to be the same as $a="9.22337203685478e+18"; $a++
6277 /* sv_2iv *should* have made this an NV */
6278 if (flags & SVp_NOK) {
6279 (void)SvNOK_only(sv);
6280 SvNV_set(sv, SvNVX(sv) + 1.0);
6283 /* I don't think we can get here. Maybe I should assert this
6284 And if we do get here I suspect that sv_setnv will croak. NWC
6286 #if defined(USE_LONG_DOUBLE)
6287 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",
6288 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6290 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6291 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6294 #endif /* PERL_PRESERVE_IVUV */
6295 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6299 while (d >= SvPVX_const(sv)) {
6307 /* MKS: The original code here died if letters weren't consecutive.
6308 * at least it didn't have to worry about non-C locales. The
6309 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6310 * arranged in order (although not consecutively) and that only
6311 * [A-Za-z] are accepted by isALPHA in the C locale.
6313 if (*d != 'z' && *d != 'Z') {
6314 do { ++*d; } while (!isALPHA(*d));
6317 *(d--) -= 'z' - 'a';
6322 *(d--) -= 'z' - 'a' + 1;
6326 /* oh,oh, the number grew */
6327 SvGROW(sv, SvCUR(sv) + 2);
6328 SvCUR_set(sv, SvCUR(sv) + 1);
6329 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6340 Auto-decrement of the value in the SV, doing string to numeric conversion
6341 if necessary. Handles 'get' magic.
6347 Perl_sv_dec(pTHX_ register SV *sv)
6355 if (SvTHINKFIRST(sv)) {
6357 sv_force_normal_flags(sv, 0);
6358 if (SvREADONLY(sv)) {
6359 if (IN_PERL_RUNTIME)
6360 Perl_croak(aTHX_ PL_no_modify);
6364 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6366 i = PTR2IV(SvRV(sv));
6371 /* Unlike sv_inc we don't have to worry about string-never-numbers
6372 and keeping them magic. But we mustn't warn on punting */
6373 flags = SvFLAGS(sv);
6374 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6375 /* It's publicly an integer, or privately an integer-not-float */
6376 #ifdef PERL_PRESERVE_IVUV
6380 if (SvUVX(sv) == 0) {
6381 (void)SvIOK_only(sv);
6385 (void)SvIOK_only_UV(sv);
6386 SvUV_set(sv, SvUVX(sv) - 1);
6389 if (SvIVX(sv) == IV_MIN)
6390 sv_setnv(sv, (NV)IV_MIN - 1.0);
6392 (void)SvIOK_only(sv);
6393 SvIV_set(sv, SvIVX(sv) - 1);
6398 if (flags & SVp_NOK) {
6399 SvNV_set(sv, SvNVX(sv) - 1.0);
6400 (void)SvNOK_only(sv);
6403 if (!(flags & SVp_POK)) {
6404 if ((flags & SVTYPEMASK) < SVt_PVIV)
6405 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6407 (void)SvIOK_only(sv);
6410 #ifdef PERL_PRESERVE_IVUV
6412 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6413 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6414 /* Need to try really hard to see if it's an integer.
6415 9.22337203685478e+18 is an integer.
6416 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6417 so $a="9.22337203685478e+18"; $a+0; $a--
6418 needs to be the same as $a="9.22337203685478e+18"; $a--
6425 /* sv_2iv *should* have made this an NV */
6426 if (flags & SVp_NOK) {
6427 (void)SvNOK_only(sv);
6428 SvNV_set(sv, SvNVX(sv) - 1.0);
6431 /* I don't think we can get here. Maybe I should assert this
6432 And if we do get here I suspect that sv_setnv will croak. NWC
6434 #if defined(USE_LONG_DOUBLE)
6435 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",
6436 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6438 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6439 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6443 #endif /* PERL_PRESERVE_IVUV */
6444 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6448 =for apidoc sv_mortalcopy
6450 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6451 The new SV is marked as mortal. It will be destroyed "soon", either by an
6452 explicit call to FREETMPS, or by an implicit call at places such as
6453 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6458 /* Make a string that will exist for the duration of the expression
6459 * evaluation. Actually, it may have to last longer than that, but
6460 * hopefully we won't free it until it has been assigned to a
6461 * permanent location. */
6464 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6470 sv_setsv(sv,oldstr);
6472 PL_tmps_stack[++PL_tmps_ix] = sv;
6478 =for apidoc sv_newmortal
6480 Creates a new null SV which is mortal. The reference count of the SV is
6481 set to 1. It will be destroyed "soon", either by an explicit call to
6482 FREETMPS, or by an implicit call at places such as statement boundaries.
6483 See also C<sv_mortalcopy> and C<sv_2mortal>.
6489 Perl_sv_newmortal(pTHX)
6495 SvFLAGS(sv) = SVs_TEMP;
6497 PL_tmps_stack[++PL_tmps_ix] = sv;
6502 =for apidoc sv_2mortal
6504 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6505 by an explicit call to FREETMPS, or by an implicit call at places such as
6506 statement boundaries. SvTEMP() is turned on which means that the SV's
6507 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6508 and C<sv_mortalcopy>.
6514 Perl_sv_2mortal(pTHX_ register SV *sv)
6519 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6522 PL_tmps_stack[++PL_tmps_ix] = sv;
6530 Creates a new SV and copies a string into it. The reference count for the
6531 SV is set to 1. If C<len> is zero, Perl will compute the length using
6532 strlen(). For efficiency, consider using C<newSVpvn> instead.
6538 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6544 sv_setpvn(sv,s,len ? len : strlen(s));
6549 =for apidoc newSVpvn
6551 Creates a new SV and copies a string into it. The reference count for the
6552 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6553 string. You are responsible for ensuring that the source string is at least
6554 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6560 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6566 sv_setpvn(sv,s,len);
6572 =for apidoc newSVhek
6574 Creates a new SV from the hash key structure. It will generate scalars that
6575 point to the shared string table where possible. Returns a new (undefined)
6576 SV if the hek is NULL.
6582 Perl_newSVhek(pTHX_ const HEK *hek)
6592 if (HEK_LEN(hek) == HEf_SVKEY) {
6593 return newSVsv(*(SV**)HEK_KEY(hek));
6595 const int flags = HEK_FLAGS(hek);
6596 if (flags & HVhek_WASUTF8) {
6598 Andreas would like keys he put in as utf8 to come back as utf8
6600 STRLEN utf8_len = HEK_LEN(hek);
6601 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6602 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6605 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6607 } else if (flags & HVhek_REHASH) {
6608 /* We don't have a pointer to the hv, so we have to replicate the
6609 flag into every HEK. This hv is using custom a hasing
6610 algorithm. Hence we can't return a shared string scalar, as
6611 that would contain the (wrong) hash value, and might get passed
6612 into an hv routine with a regular hash */
6614 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6619 /* This will be overwhelminly the most common case. */
6620 return newSVpvn_share(HEK_KEY(hek),
6621 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6627 =for apidoc newSVpvn_share
6629 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6630 table. If the string does not already exist in the table, it is created
6631 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6632 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6633 otherwise the hash is computed. The idea here is that as the string table
6634 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6635 hash lookup will avoid string compare.
6641 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6645 bool is_utf8 = FALSE;
6647 STRLEN tmplen = -len;
6649 /* See the note in hv.c:hv_fetch() --jhi */
6650 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6654 PERL_HASH(hash, src, len);
6656 sv_upgrade(sv, SVt_PV);
6657 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6669 #if defined(PERL_IMPLICIT_CONTEXT)
6671 /* pTHX_ magic can't cope with varargs, so this is a no-context
6672 * version of the main function, (which may itself be aliased to us).
6673 * Don't access this version directly.
6677 Perl_newSVpvf_nocontext(const char* pat, ...)
6682 va_start(args, pat);
6683 sv = vnewSVpvf(pat, &args);
6690 =for apidoc newSVpvf
6692 Creates a new SV and initializes it with the string formatted like
6699 Perl_newSVpvf(pTHX_ const char* pat, ...)
6703 va_start(args, pat);
6704 sv = vnewSVpvf(pat, &args);
6709 /* backend for newSVpvf() and newSVpvf_nocontext() */
6712 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6717 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6724 Creates a new SV and copies a floating point value into it.
6725 The reference count for the SV is set to 1.
6731 Perl_newSVnv(pTHX_ NV n)
6744 Creates a new SV and copies an integer into it. The reference count for the
6751 Perl_newSViv(pTHX_ IV i)
6764 Creates a new SV and copies an unsigned integer into it.
6765 The reference count for the SV is set to 1.
6771 Perl_newSVuv(pTHX_ UV u)
6782 =for apidoc newRV_noinc
6784 Creates an RV wrapper for an SV. The reference count for the original
6785 SV is B<not> incremented.
6791 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6797 sv_upgrade(sv, SVt_RV);
6799 SvRV_set(sv, tmpRef);
6804 /* newRV_inc is the official function name to use now.
6805 * newRV_inc is in fact #defined to newRV in sv.h
6809 Perl_newRV(pTHX_ SV *tmpRef)
6812 return newRV_noinc(SvREFCNT_inc(tmpRef));
6818 Creates a new SV which is an exact duplicate of the original SV.
6825 Perl_newSVsv(pTHX_ register SV *old)
6832 if (SvTYPE(old) == SVTYPEMASK) {
6833 if (ckWARN_d(WARN_INTERNAL))
6834 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6838 /* SV_GMAGIC is the default for sv_setv()
6839 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6840 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6841 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6846 =for apidoc sv_reset
6848 Underlying implementation for the C<reset> Perl function.
6849 Note that the perl-level function is vaguely deprecated.
6855 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6858 char todo[PERL_UCHAR_MAX+1];
6863 if (!*s) { /* reset ?? searches */
6864 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6866 PMOP *pm = (PMOP *) mg->mg_obj;
6868 pm->op_pmdynflags &= ~PMdf_USED;
6875 /* reset variables */
6877 if (!HvARRAY(stash))
6880 Zero(todo, 256, char);
6883 I32 i = (unsigned char)*s;
6887 max = (unsigned char)*s++;
6888 for ( ; i <= max; i++) {
6891 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6893 for (entry = HvARRAY(stash)[i];
6895 entry = HeNEXT(entry))
6900 if (!todo[(U8)*HeKEY(entry)])
6902 gv = (GV*)HeVAL(entry);
6905 if (SvTHINKFIRST(sv)) {
6906 if (!SvREADONLY(sv) && SvROK(sv))
6908 /* XXX Is this continue a bug? Why should THINKFIRST
6909 exempt us from resetting arrays and hashes? */
6913 if (SvTYPE(sv) >= SVt_PV) {
6915 if (SvPVX_const(sv) != NULL)
6923 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6925 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6928 # if defined(USE_ENVIRON_ARRAY)
6931 # endif /* USE_ENVIRON_ARRAY */
6942 Using various gambits, try to get an IO from an SV: the IO slot if its a
6943 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6944 named after the PV if we're a string.
6950 Perl_sv_2io(pTHX_ SV *sv)
6955 switch (SvTYPE(sv)) {
6963 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6967 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6969 return sv_2io(SvRV(sv));
6970 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6976 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6985 Using various gambits, try to get a CV from an SV; in addition, try if
6986 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6987 The flags in C<lref> are passed to sv_fetchsv.
6993 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7004 switch (SvTYPE(sv)) {
7023 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7024 tryAMAGICunDEREF(to_cv);
7027 if (SvTYPE(sv) == SVt_PVCV) {
7036 Perl_croak(aTHX_ "Not a subroutine reference");
7041 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7047 /* Some flags to gv_fetchsv mean don't really create the GV */
7048 if (SvTYPE(gv) != SVt_PVGV) {
7054 if (lref && !GvCVu(gv)) {
7058 gv_efullname3(tmpsv, gv, NULL);
7059 /* XXX this is probably not what they think they're getting.
7060 * It has the same effect as "sub name;", i.e. just a forward
7062 newSUB(start_subparse(FALSE, 0),
7063 newSVOP(OP_CONST, 0, tmpsv),
7068 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7078 Returns true if the SV has a true value by Perl's rules.
7079 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7080 instead use an in-line version.
7086 Perl_sv_true(pTHX_ register SV *sv)
7091 register const XPV* const tXpv = (XPV*)SvANY(sv);
7093 (tXpv->xpv_cur > 1 ||
7094 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7101 return SvIVX(sv) != 0;
7104 return SvNVX(sv) != 0.0;
7106 return sv_2bool(sv);
7112 =for apidoc sv_pvn_force
7114 Get a sensible string out of the SV somehow.
7115 A private implementation of the C<SvPV_force> macro for compilers which
7116 can't cope with complex macro expressions. Always use the macro instead.
7118 =for apidoc sv_pvn_force_flags
7120 Get a sensible string out of the SV somehow.
7121 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7122 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7123 implemented in terms of this function.
7124 You normally want to use the various wrapper macros instead: see
7125 C<SvPV_force> and C<SvPV_force_nomg>
7131 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7134 if (SvTHINKFIRST(sv) && !SvROK(sv))
7135 sv_force_normal_flags(sv, 0);
7145 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7146 const char * const ref = sv_reftype(sv,0);
7148 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7149 ref, OP_NAME(PL_op));
7151 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7153 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7154 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7156 s = sv_2pv_flags(sv, &len, flags);
7160 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7163 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7164 SvGROW(sv, len + 1);
7165 Move(s,SvPVX(sv),len,char);
7170 SvPOK_on(sv); /* validate pointer */
7172 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7173 PTR2UV(sv),SvPVX_const(sv)));
7176 return SvPVX_mutable(sv);
7180 =for apidoc sv_pvbyten_force
7182 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7188 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7190 sv_pvn_force(sv,lp);
7191 sv_utf8_downgrade(sv,0);
7197 =for apidoc sv_pvutf8n_force
7199 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7205 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7207 sv_pvn_force(sv,lp);
7208 sv_utf8_upgrade(sv);
7214 =for apidoc sv_reftype
7216 Returns a string describing what the SV is a reference to.
7222 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7224 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7225 inside return suggests a const propagation bug in g++. */
7226 if (ob && SvOBJECT(sv)) {
7227 char * const name = HvNAME_get(SvSTASH(sv));
7228 return name ? name : (char *) "__ANON__";
7231 switch (SvTYPE(sv)) {
7248 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7249 /* tied lvalues should appear to be
7250 * scalars for backwards compatitbility */
7251 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7252 ? "SCALAR" : "LVALUE");
7253 case SVt_PVAV: return "ARRAY";
7254 case SVt_PVHV: return "HASH";
7255 case SVt_PVCV: return "CODE";
7256 case SVt_PVGV: return "GLOB";
7257 case SVt_PVFM: return "FORMAT";
7258 case SVt_PVIO: return "IO";
7259 default: return "UNKNOWN";
7265 =for apidoc sv_isobject
7267 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7268 object. If the SV is not an RV, or if the object is not blessed, then this
7275 Perl_sv_isobject(pTHX_ SV *sv)
7291 Returns a boolean indicating whether the SV is blessed into the specified
7292 class. This does not check for subtypes; use C<sv_derived_from> to verify
7293 an inheritance relationship.
7299 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7310 hvname = HvNAME_get(SvSTASH(sv));
7314 return strEQ(hvname, name);
7320 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7321 it will be upgraded to one. If C<classname> is non-null then the new SV will
7322 be blessed in the specified package. The new SV is returned and its
7323 reference count is 1.
7329 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7336 SV_CHECK_THINKFIRST_COW_DROP(rv);
7339 if (SvTYPE(rv) >= SVt_PVMG) {
7340 const U32 refcnt = SvREFCNT(rv);
7344 SvREFCNT(rv) = refcnt;
7347 if (SvTYPE(rv) < SVt_RV)
7348 sv_upgrade(rv, SVt_RV);
7349 else if (SvTYPE(rv) > SVt_RV) {
7360 HV* const stash = gv_stashpv(classname, TRUE);
7361 (void)sv_bless(rv, stash);
7367 =for apidoc sv_setref_pv
7369 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7370 argument will be upgraded to an RV. That RV will be modified to point to
7371 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7372 into the SV. The C<classname> argument indicates the package for the
7373 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7374 will have a reference count of 1, and the RV will be returned.
7376 Do not use with other Perl types such as HV, AV, SV, CV, because those
7377 objects will become corrupted by the pointer copy process.
7379 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7385 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7389 sv_setsv(rv, &PL_sv_undef);
7393 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7398 =for apidoc sv_setref_iv
7400 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7401 argument will be upgraded to an RV. That RV will be modified to point to
7402 the new SV. The C<classname> argument indicates the package for the
7403 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7404 will have a reference count of 1, and the RV will be returned.
7410 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7412 sv_setiv(newSVrv(rv,classname), iv);
7417 =for apidoc sv_setref_uv
7419 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7420 argument will be upgraded to an RV. That RV will be modified to point to
7421 the new SV. The C<classname> argument indicates the package for the
7422 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7423 will have a reference count of 1, and the RV will be returned.
7429 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7431 sv_setuv(newSVrv(rv,classname), uv);
7436 =for apidoc sv_setref_nv
7438 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7439 argument will be upgraded to an RV. That RV will be modified to point to
7440 the new SV. The C<classname> argument indicates the package for the
7441 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7442 will have a reference count of 1, and the RV will be returned.
7448 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7450 sv_setnv(newSVrv(rv,classname), nv);
7455 =for apidoc sv_setref_pvn
7457 Copies a string into a new SV, optionally blessing the SV. The length of the
7458 string must be specified with C<n>. The C<rv> argument will be upgraded to
7459 an RV. That RV will be modified to point to the new SV. The C<classname>
7460 argument indicates the package for the blessing. Set C<classname> to
7461 C<NULL> to avoid the blessing. The new SV will have a reference count
7462 of 1, and the RV will be returned.
7464 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7470 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7472 sv_setpvn(newSVrv(rv,classname), pv, n);
7477 =for apidoc sv_bless
7479 Blesses an SV into a specified package. The SV must be an RV. The package
7480 must be designated by its stash (see C<gv_stashpv()>). The reference count
7481 of the SV is unaffected.
7487 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7492 Perl_croak(aTHX_ "Can't bless non-reference value");
7494 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7495 if (SvREADONLY(tmpRef))
7496 Perl_croak(aTHX_ PL_no_modify);
7497 if (SvOBJECT(tmpRef)) {
7498 if (SvTYPE(tmpRef) != SVt_PVIO)
7500 SvREFCNT_dec(SvSTASH(tmpRef));
7503 SvOBJECT_on(tmpRef);
7504 if (SvTYPE(tmpRef) != SVt_PVIO)
7506 SvUPGRADE(tmpRef, SVt_PVMG);
7507 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7514 if(SvSMAGICAL(tmpRef))
7515 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7523 /* Downgrades a PVGV to a PVMG.
7527 S_sv_unglob(pTHX_ SV *sv)
7532 assert(SvTYPE(sv) == SVt_PVGV);
7537 sv_del_backref((SV*)GvSTASH(sv), sv);
7540 sv_unmagic(sv, PERL_MAGIC_glob);
7541 Safefree(GvNAME(sv));
7544 /* need to keep SvANY(sv) in the right arena */
7545 xpvmg = new_XPVMG();
7546 StructCopy(SvANY(sv), xpvmg, XPVMG);
7547 del_XPVGV(SvANY(sv));
7550 SvFLAGS(sv) &= ~SVTYPEMASK;
7551 SvFLAGS(sv) |= SVt_PVMG;
7555 =for apidoc sv_unref_flags
7557 Unsets the RV status of the SV, and decrements the reference count of
7558 whatever was being referenced by the RV. This can almost be thought of
7559 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7560 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7561 (otherwise the decrementing is conditional on the reference count being
7562 different from one or the reference being a readonly SV).
7569 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7571 SV* const target = SvRV(ref);
7573 if (SvWEAKREF(ref)) {
7574 sv_del_backref(target, ref);
7576 SvRV_set(ref, NULL);
7579 SvRV_set(ref, NULL);
7581 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7582 assigned to as BEGIN {$a = \"Foo"} will fail. */
7583 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7584 SvREFCNT_dec(target);
7585 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7586 sv_2mortal(target); /* Schedule for freeing later */
7590 =for apidoc sv_untaint
7592 Untaint an SV. Use C<SvTAINTED_off> instead.
7597 Perl_sv_untaint(pTHX_ SV *sv)
7599 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7600 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7607 =for apidoc sv_tainted
7609 Test an SV for taintedness. Use C<SvTAINTED> instead.
7614 Perl_sv_tainted(pTHX_ SV *sv)
7616 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7617 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7618 if (mg && (mg->mg_len & 1) )
7625 =for apidoc sv_setpviv
7627 Copies an integer into the given SV, also updating its string value.
7628 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7634 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7636 char buf[TYPE_CHARS(UV)];
7638 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7640 sv_setpvn(sv, ptr, ebuf - ptr);
7644 =for apidoc sv_setpviv_mg
7646 Like C<sv_setpviv>, but also handles 'set' magic.
7652 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7658 #if defined(PERL_IMPLICIT_CONTEXT)
7660 /* pTHX_ magic can't cope with varargs, so this is a no-context
7661 * version of the main function, (which may itself be aliased to us).
7662 * Don't access this version directly.
7666 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7670 va_start(args, pat);
7671 sv_vsetpvf(sv, pat, &args);
7675 /* pTHX_ magic can't cope with varargs, so this is a no-context
7676 * version of the main function, (which may itself be aliased to us).
7677 * Don't access this version directly.
7681 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7685 va_start(args, pat);
7686 sv_vsetpvf_mg(sv, pat, &args);
7692 =for apidoc sv_setpvf
7694 Works like C<sv_catpvf> but copies the text into the SV instead of
7695 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7701 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7704 va_start(args, pat);
7705 sv_vsetpvf(sv, pat, &args);
7710 =for apidoc sv_vsetpvf
7712 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7713 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7715 Usually used via its frontend C<sv_setpvf>.
7721 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7723 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7727 =for apidoc sv_setpvf_mg
7729 Like C<sv_setpvf>, but also handles 'set' magic.
7735 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7738 va_start(args, pat);
7739 sv_vsetpvf_mg(sv, pat, &args);
7744 =for apidoc sv_vsetpvf_mg
7746 Like C<sv_vsetpvf>, but also handles 'set' magic.
7748 Usually used via its frontend C<sv_setpvf_mg>.
7754 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7756 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7760 #if defined(PERL_IMPLICIT_CONTEXT)
7762 /* pTHX_ magic can't cope with varargs, so this is a no-context
7763 * version of the main function, (which may itself be aliased to us).
7764 * Don't access this version directly.
7768 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7772 va_start(args, pat);
7773 sv_vcatpvf(sv, pat, &args);
7777 /* pTHX_ magic can't cope with varargs, so this is a no-context
7778 * version of the main function, (which may itself be aliased to us).
7779 * Don't access this version directly.
7783 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7787 va_start(args, pat);
7788 sv_vcatpvf_mg(sv, pat, &args);
7794 =for apidoc sv_catpvf
7796 Processes its arguments like C<sprintf> and appends the formatted
7797 output to an SV. If the appended data contains "wide" characters
7798 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7799 and characters >255 formatted with %c), the original SV might get
7800 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7801 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7802 valid UTF-8; if the original SV was bytes, the pattern should be too.
7807 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7810 va_start(args, pat);
7811 sv_vcatpvf(sv, pat, &args);
7816 =for apidoc sv_vcatpvf
7818 Processes its arguments like C<vsprintf> and appends the formatted output
7819 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7821 Usually used via its frontend C<sv_catpvf>.
7827 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7829 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7833 =for apidoc sv_catpvf_mg
7835 Like C<sv_catpvf>, but also handles 'set' magic.
7841 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7844 va_start(args, pat);
7845 sv_vcatpvf_mg(sv, pat, &args);
7850 =for apidoc sv_vcatpvf_mg
7852 Like C<sv_vcatpvf>, but also handles 'set' magic.
7854 Usually used via its frontend C<sv_catpvf_mg>.
7860 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7862 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7867 =for apidoc sv_vsetpvfn
7869 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7872 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7878 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7880 sv_setpvn(sv, "", 0);
7881 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7885 S_expect_number(pTHX_ char** pattern)
7889 switch (**pattern) {
7890 case '1': case '2': case '3':
7891 case '4': case '5': case '6':
7892 case '7': case '8': case '9':
7893 var = *(*pattern)++ - '0';
7894 while (isDIGIT(**pattern)) {
7895 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7897 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7905 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7907 const int neg = nv < 0;
7916 if (uv & 1 && uv == nv)
7917 uv--; /* Round to even */
7919 const unsigned dig = uv % 10;
7932 =for apidoc sv_vcatpvfn
7934 Processes its arguments like C<vsprintf> and appends the formatted output
7935 to an SV. Uses an array of SVs if the C style variable argument list is
7936 missing (NULL). When running with taint checks enabled, indicates via
7937 C<maybe_tainted> if results are untrustworthy (often due to the use of
7940 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7946 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7947 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7948 vec_utf8 = DO_UTF8(vecsv);
7950 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7953 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7961 static const char nullstr[] = "(null)";
7963 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7964 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7966 /* Times 4: a decimal digit takes more than 3 binary digits.
7967 * NV_DIG: mantissa takes than many decimal digits.
7968 * Plus 32: Playing safe. */
7969 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7970 /* large enough for "%#.#f" --chip */
7971 /* what about long double NVs? --jhi */
7973 PERL_UNUSED_ARG(maybe_tainted);
7975 /* no matter what, this is a string now */
7976 (void)SvPV_force(sv, origlen);
7978 /* special-case "", "%s", and "%-p" (SVf - see below) */
7981 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7983 const char * const s = va_arg(*args, char*);
7984 sv_catpv(sv, s ? s : nullstr);
7986 else if (svix < svmax) {
7987 sv_catsv(sv, *svargs);
7991 if (args && patlen == 3 && pat[0] == '%' &&
7992 pat[1] == '-' && pat[2] == 'p') {
7993 argsv = va_arg(*args, SV*);
7994 sv_catsv(sv, argsv);
7998 #ifndef USE_LONG_DOUBLE
7999 /* special-case "%.<number>[gf]" */
8000 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8001 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8002 unsigned digits = 0;
8006 while (*pp >= '0' && *pp <= '9')
8007 digits = 10 * digits + (*pp++ - '0');
8008 if (pp - pat == (int)patlen - 1) {
8016 /* Add check for digits != 0 because it seems that some
8017 gconverts are buggy in this case, and we don't yet have
8018 a Configure test for this. */
8019 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8020 /* 0, point, slack */
8021 Gconvert(nv, (int)digits, 0, ebuf);
8023 if (*ebuf) /* May return an empty string for digits==0 */
8026 } else if (!digits) {
8029 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8030 sv_catpvn(sv, p, l);
8036 #endif /* !USE_LONG_DOUBLE */
8038 if (!args && svix < svmax && DO_UTF8(*svargs))
8041 patend = (char*)pat + patlen;
8042 for (p = (char*)pat; p < patend; p = q) {
8045 bool vectorize = FALSE;
8046 bool vectorarg = FALSE;
8047 bool vec_utf8 = FALSE;
8053 bool has_precis = FALSE;
8055 const I32 osvix = svix;
8056 bool is_utf8 = FALSE; /* is this item utf8? */
8057 #ifdef HAS_LDBL_SPRINTF_BUG
8058 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8059 with sfio - Allen <allens@cpan.org> */
8060 bool fix_ldbl_sprintf_bug = FALSE;
8064 U8 utf8buf[UTF8_MAXBYTES+1];
8065 STRLEN esignlen = 0;
8067 const char *eptr = NULL;
8070 const U8 *vecstr = Null(U8*);
8077 /* we need a long double target in case HAS_LONG_DOUBLE but
8080 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8088 const char *dotstr = ".";
8089 STRLEN dotstrlen = 1;
8090 I32 efix = 0; /* explicit format parameter index */
8091 I32 ewix = 0; /* explicit width index */
8092 I32 epix = 0; /* explicit precision index */
8093 I32 evix = 0; /* explicit vector index */
8094 bool asterisk = FALSE;
8096 /* echo everything up to the next format specification */
8097 for (q = p; q < patend && *q != '%'; ++q) ;
8099 if (has_utf8 && !pat_utf8)
8100 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8102 sv_catpvn(sv, p, q - p);
8109 We allow format specification elements in this order:
8110 \d+\$ explicit format parameter index
8112 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8113 0 flag (as above): repeated to allow "v02"
8114 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8115 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8117 [%bcdefginopsuxDFOUX] format (mandatory)
8122 As of perl5.9.3, printf format checking is on by default.
8123 Internally, perl uses %p formats to provide an escape to
8124 some extended formatting. This block deals with those
8125 extensions: if it does not match, (char*)q is reset and
8126 the normal format processing code is used.
8128 Currently defined extensions are:
8129 %p include pointer address (standard)
8130 %-p (SVf) include an SV (previously %_)
8131 %-<num>p include an SV with precision <num>
8132 %1p (VDf) include a v-string (as %vd)
8133 %<num>p reserved for future extensions
8135 Robin Barker 2005-07-14
8142 n = expect_number(&q);
8149 argsv = va_arg(*args, SV*);
8150 eptr = SvPVx_const(argsv, elen);
8156 else if (n == vdNUMBER) { /* VDf */
8163 if (ckWARN_d(WARN_INTERNAL))
8164 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8165 "internal %%<num>p might conflict with future printf extensions");
8171 if ( (width = expect_number(&q)) ) {
8212 if ( (ewix = expect_number(&q)) )
8221 if ((vectorarg = asterisk)) {
8234 width = expect_number(&q);
8240 vecsv = va_arg(*args, SV*);
8242 vecsv = (evix > 0 && evix <= svmax)
8243 ? svargs[evix-1] : &PL_sv_undef;
8245 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8247 dotstr = SvPV_const(vecsv, dotstrlen);
8248 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8249 bad with tied or overloaded values that return UTF8. */
8252 else if (has_utf8) {
8253 vecsv = sv_mortalcopy(vecsv);
8254 sv_utf8_upgrade(vecsv);
8255 dotstr = SvPV_const(vecsv, dotstrlen);
8262 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8263 vecsv = svargs[efix ? efix-1 : svix++];
8264 vecstr = (U8*)SvPV_const(vecsv,veclen);
8265 vec_utf8 = DO_UTF8(vecsv);
8267 /* if this is a version object, we need to convert
8268 * back into v-string notation and then let the
8269 * vectorize happen normally
8271 if (sv_derived_from(vecsv, "version")) {
8272 char *version = savesvpv(vecsv);
8273 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8274 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8275 "vector argument not supported with alpha versions");
8278 vecsv = sv_newmortal();
8279 /* scan_vstring is expected to be called during
8280 * tokenization, so we need to fake up the end
8281 * of the buffer for it
8283 PL_bufend = version + veclen;
8284 scan_vstring(version, vecsv);
8285 vecstr = (U8*)SvPV_const(vecsv, veclen);
8286 vec_utf8 = DO_UTF8(vecsv);
8298 i = va_arg(*args, int);
8300 i = (ewix ? ewix <= svmax : svix < svmax) ?
8301 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8303 width = (i < 0) ? -i : i;
8313 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8315 /* XXX: todo, support specified precision parameter */
8319 i = va_arg(*args, int);
8321 i = (ewix ? ewix <= svmax : svix < svmax)
8322 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8323 precis = (i < 0) ? 0 : i;
8328 precis = precis * 10 + (*q++ - '0');
8337 case 'I': /* Ix, I32x, and I64x */
8339 if (q[1] == '6' && q[2] == '4') {
8345 if (q[1] == '3' && q[2] == '2') {
8355 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8366 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8367 if (*(q + 1) == 'l') { /* lld, llf */
8393 if (!vectorize && !args) {
8395 const I32 i = efix-1;
8396 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8398 argsv = (svix >= 0 && svix < svmax)
8399 ? svargs[svix++] : &PL_sv_undef;
8410 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8412 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8414 eptr = (char*)utf8buf;
8415 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8429 eptr = va_arg(*args, char*);
8431 #ifdef MACOS_TRADITIONAL
8432 /* On MacOS, %#s format is used for Pascal strings */
8437 elen = strlen(eptr);
8439 eptr = (char *)nullstr;
8440 elen = sizeof nullstr - 1;
8444 eptr = SvPVx_const(argsv, elen);
8445 if (DO_UTF8(argsv)) {
8446 if (has_precis && precis < elen) {
8448 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8451 if (width) { /* fudge width (can't fudge elen) */
8452 width += elen - sv_len_utf8(argsv);
8459 if (has_precis && elen > precis)
8466 if (alt || vectorize)
8468 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8489 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8498 esignbuf[esignlen++] = plus;
8502 case 'h': iv = (short)va_arg(*args, int); break;
8503 case 'l': iv = va_arg(*args, long); break;
8504 case 'V': iv = va_arg(*args, IV); break;
8505 default: iv = va_arg(*args, int); break;
8507 case 'q': iv = va_arg(*args, Quad_t); break;
8512 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8514 case 'h': iv = (short)tiv; break;
8515 case 'l': iv = (long)tiv; break;
8517 default: iv = tiv; break;
8519 case 'q': iv = (Quad_t)tiv; break;
8523 if ( !vectorize ) /* we already set uv above */
8528 esignbuf[esignlen++] = plus;
8532 esignbuf[esignlen++] = '-';
8575 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8586 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8587 case 'l': uv = va_arg(*args, unsigned long); break;
8588 case 'V': uv = va_arg(*args, UV); break;
8589 default: uv = va_arg(*args, unsigned); break;
8591 case 'q': uv = va_arg(*args, Uquad_t); break;
8596 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8598 case 'h': uv = (unsigned short)tuv; break;
8599 case 'l': uv = (unsigned long)tuv; break;
8601 default: uv = tuv; break;
8603 case 'q': uv = (Uquad_t)tuv; break;
8610 char *ptr = ebuf + sizeof ebuf;
8616 p = (char*)((c == 'X')
8617 ? "0123456789ABCDEF" : "0123456789abcdef");
8623 esignbuf[esignlen++] = '0';
8624 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8632 if (alt && *ptr != '0')
8643 esignbuf[esignlen++] = '0';
8644 esignbuf[esignlen++] = 'b';
8647 default: /* it had better be ten or less */
8651 } while (uv /= base);
8654 elen = (ebuf + sizeof ebuf) - ptr;
8658 zeros = precis - elen;
8659 else if (precis == 0 && elen == 1 && *eptr == '0')
8665 /* FLOATING POINT */
8668 c = 'f'; /* maybe %F isn't supported here */
8676 /* This is evil, but floating point is even more evil */
8678 /* for SV-style calling, we can only get NV
8679 for C-style calling, we assume %f is double;
8680 for simplicity we allow any of %Lf, %llf, %qf for long double
8684 #if defined(USE_LONG_DOUBLE)
8688 /* [perl #20339] - we should accept and ignore %lf rather than die */
8692 #if defined(USE_LONG_DOUBLE)
8693 intsize = args ? 0 : 'q';
8697 #if defined(HAS_LONG_DOUBLE)
8706 /* now we need (long double) if intsize == 'q', else (double) */
8708 #if LONG_DOUBLESIZE > DOUBLESIZE
8710 va_arg(*args, long double) :
8711 va_arg(*args, double)
8713 va_arg(*args, double)
8718 if (c != 'e' && c != 'E') {
8720 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8721 will cast our (long double) to (double) */
8722 (void)Perl_frexp(nv, &i);
8723 if (i == PERL_INT_MIN)
8724 Perl_die(aTHX_ "panic: frexp");
8726 need = BIT_DIGITS(i);
8728 need += has_precis ? precis : 6; /* known default */
8733 #ifdef HAS_LDBL_SPRINTF_BUG
8734 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8735 with sfio - Allen <allens@cpan.org> */
8738 # define MY_DBL_MAX DBL_MAX
8739 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8740 # if DOUBLESIZE >= 8
8741 # define MY_DBL_MAX 1.7976931348623157E+308L
8743 # define MY_DBL_MAX 3.40282347E+38L
8747 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8748 # define MY_DBL_MAX_BUG 1L
8750 # define MY_DBL_MAX_BUG MY_DBL_MAX
8754 # define MY_DBL_MIN DBL_MIN
8755 # else /* XXX guessing! -Allen */
8756 # if DOUBLESIZE >= 8
8757 # define MY_DBL_MIN 2.2250738585072014E-308L
8759 # define MY_DBL_MIN 1.17549435E-38L
8763 if ((intsize == 'q') && (c == 'f') &&
8764 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8766 /* it's going to be short enough that
8767 * long double precision is not needed */
8769 if ((nv <= 0L) && (nv >= -0L))
8770 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8772 /* would use Perl_fp_class as a double-check but not
8773 * functional on IRIX - see perl.h comments */
8775 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8776 /* It's within the range that a double can represent */
8777 #if defined(DBL_MAX) && !defined(DBL_MIN)
8778 if ((nv >= ((long double)1/DBL_MAX)) ||
8779 (nv <= (-(long double)1/DBL_MAX)))
8781 fix_ldbl_sprintf_bug = TRUE;
8784 if (fix_ldbl_sprintf_bug == TRUE) {
8794 # undef MY_DBL_MAX_BUG
8797 #endif /* HAS_LDBL_SPRINTF_BUG */
8799 need += 20; /* fudge factor */
8800 if (PL_efloatsize < need) {
8801 Safefree(PL_efloatbuf);
8802 PL_efloatsize = need + 20; /* more fudge */
8803 Newx(PL_efloatbuf, PL_efloatsize, char);
8804 PL_efloatbuf[0] = '\0';
8807 if ( !(width || left || plus || alt) && fill != '0'
8808 && has_precis && intsize != 'q' ) { /* Shortcuts */
8809 /* See earlier comment about buggy Gconvert when digits,
8811 if ( c == 'g' && precis) {
8812 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8813 /* May return an empty string for digits==0 */
8814 if (*PL_efloatbuf) {
8815 elen = strlen(PL_efloatbuf);
8816 goto float_converted;
8818 } else if ( c == 'f' && !precis) {
8819 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8824 char *ptr = ebuf + sizeof ebuf;
8827 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8828 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8829 if (intsize == 'q') {
8830 /* Copy the one or more characters in a long double
8831 * format before the 'base' ([efgEFG]) character to
8832 * the format string. */
8833 static char const prifldbl[] = PERL_PRIfldbl;
8834 char const *p = prifldbl + sizeof(prifldbl) - 3;
8835 while (p >= prifldbl) { *--ptr = *p--; }
8840 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8845 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8857 /* No taint. Otherwise we are in the strange situation
8858 * where printf() taints but print($float) doesn't.
8860 #if defined(HAS_LONG_DOUBLE)
8861 elen = ((intsize == 'q')
8862 ? my_sprintf(PL_efloatbuf, ptr, nv)
8863 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8865 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8869 eptr = PL_efloatbuf;
8877 i = SvCUR(sv) - origlen;
8880 case 'h': *(va_arg(*args, short*)) = i; break;
8881 default: *(va_arg(*args, int*)) = i; break;
8882 case 'l': *(va_arg(*args, long*)) = i; break;
8883 case 'V': *(va_arg(*args, IV*)) = i; break;
8885 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8890 sv_setuv_mg(argsv, (UV)i);
8891 continue; /* not "break" */
8898 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8899 && ckWARN(WARN_PRINTF))
8901 SV * const msg = sv_newmortal();
8902 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8903 (PL_op->op_type == OP_PRTF) ? "" : "s");
8906 Perl_sv_catpvf(aTHX_ msg,
8907 "\"%%%c\"", c & 0xFF);
8909 Perl_sv_catpvf(aTHX_ msg,
8910 "\"%%\\%03"UVof"\"",
8913 sv_catpvs(msg, "end of string");
8914 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8917 /* output mangled stuff ... */
8923 /* ... right here, because formatting flags should not apply */
8924 SvGROW(sv, SvCUR(sv) + elen + 1);
8926 Copy(eptr, p, elen, char);
8929 SvCUR_set(sv, p - SvPVX_const(sv));
8931 continue; /* not "break" */
8934 /* calculate width before utf8_upgrade changes it */
8935 have = esignlen + zeros + elen;
8937 Perl_croak_nocontext(PL_memory_wrap);
8939 if (is_utf8 != has_utf8) {
8942 sv_utf8_upgrade(sv);
8945 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8946 sv_utf8_upgrade(nsv);
8947 eptr = SvPVX_const(nsv);
8950 SvGROW(sv, SvCUR(sv) + elen + 1);
8955 need = (have > width ? have : width);
8958 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8959 Perl_croak_nocontext(PL_memory_wrap);
8960 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8962 if (esignlen && fill == '0') {
8964 for (i = 0; i < (int)esignlen; i++)
8968 memset(p, fill, gap);
8971 if (esignlen && fill != '0') {
8973 for (i = 0; i < (int)esignlen; i++)
8978 for (i = zeros; i; i--)
8982 Copy(eptr, p, elen, char);
8986 memset(p, ' ', gap);
8991 Copy(dotstr, p, dotstrlen, char);
8995 vectorize = FALSE; /* done iterating over vecstr */
9002 SvCUR_set(sv, p - SvPVX_const(sv));
9010 /* =========================================================================
9012 =head1 Cloning an interpreter
9014 All the macros and functions in this section are for the private use of
9015 the main function, perl_clone().
9017 The foo_dup() functions make an exact copy of an existing foo thinngy.
9018 During the course of a cloning, a hash table is used to map old addresses
9019 to new addresses. The table is created and manipulated with the
9020 ptr_table_* functions.
9024 ============================================================================*/
9027 #if defined(USE_ITHREADS)
9029 #ifndef GpREFCNT_inc
9030 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9034 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9035 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9036 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9037 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9038 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9039 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9040 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9041 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9042 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9043 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9044 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9045 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9046 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9049 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9050 regcomp.c. AMS 20010712 */
9053 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9058 struct reg_substr_datum *s;
9061 return (REGEXP *)NULL;
9063 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9066 len = r->offsets[0];
9067 npar = r->nparens+1;
9069 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9070 Copy(r->program, ret->program, len+1, regnode);
9072 Newx(ret->startp, npar, I32);
9073 Copy(r->startp, ret->startp, npar, I32);
9074 Newx(ret->endp, npar, I32);
9075 Copy(r->startp, ret->startp, npar, I32);
9077 Newx(ret->substrs, 1, struct reg_substr_data);
9078 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9079 s->min_offset = r->substrs->data[i].min_offset;
9080 s->max_offset = r->substrs->data[i].max_offset;
9081 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9082 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9085 ret->regstclass = NULL;
9088 const int count = r->data->count;
9091 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9092 char, struct reg_data);
9093 Newx(d->what, count, U8);
9096 for (i = 0; i < count; i++) {
9097 d->what[i] = r->data->what[i];
9098 switch (d->what[i]) {
9099 /* legal options are one of: sfpont
9100 see also regcomp.h and pregfree() */
9102 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9105 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9108 /* This is cheating. */
9109 Newx(d->data[i], 1, struct regnode_charclass_class);
9110 StructCopy(r->data->data[i], d->data[i],
9111 struct regnode_charclass_class);
9112 ret->regstclass = (regnode*)d->data[i];
9115 /* Compiled op trees are readonly, and can thus be
9116 shared without duplication. */
9118 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9122 d->data[i] = r->data->data[i];
9125 d->data[i] = r->data->data[i];
9127 ((reg_trie_data*)d->data[i])->refcount++;
9131 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9140 Newx(ret->offsets, 2*len+1, U32);
9141 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9143 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9144 ret->refcnt = r->refcnt;
9145 ret->minlen = r->minlen;
9146 ret->prelen = r->prelen;
9147 ret->nparens = r->nparens;
9148 ret->lastparen = r->lastparen;
9149 ret->lastcloseparen = r->lastcloseparen;
9150 ret->reganch = r->reganch;
9152 ret->sublen = r->sublen;
9154 if (RX_MATCH_COPIED(ret))
9155 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9158 #ifdef PERL_OLD_COPY_ON_WRITE
9159 ret->saved_copy = NULL;
9162 ptr_table_store(PL_ptr_table, r, ret);
9166 /* duplicate a file handle */
9169 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9173 PERL_UNUSED_ARG(type);
9176 return (PerlIO*)NULL;
9178 /* look for it in the table first */
9179 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9183 /* create anew and remember what it is */
9184 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9185 ptr_table_store(PL_ptr_table, fp, ret);
9189 /* duplicate a directory handle */
9192 Perl_dirp_dup(pTHX_ DIR *dp)
9200 /* duplicate a typeglob */
9203 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9208 /* look for it in the table first */
9209 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9213 /* create anew and remember what it is */
9215 ptr_table_store(PL_ptr_table, gp, ret);
9218 ret->gp_refcnt = 0; /* must be before any other dups! */
9219 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9220 ret->gp_io = io_dup_inc(gp->gp_io, param);
9221 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9222 ret->gp_av = av_dup_inc(gp->gp_av, param);
9223 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9224 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9225 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9226 ret->gp_cvgen = gp->gp_cvgen;
9227 ret->gp_line = gp->gp_line;
9228 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9232 /* duplicate a chain of magic */
9235 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9237 MAGIC *mgprev = (MAGIC*)NULL;
9240 return (MAGIC*)NULL;
9241 /* look for it in the table first */
9242 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9246 for (; mg; mg = mg->mg_moremagic) {
9248 Newxz(nmg, 1, MAGIC);
9250 mgprev->mg_moremagic = nmg;
9253 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9254 nmg->mg_private = mg->mg_private;
9255 nmg->mg_type = mg->mg_type;
9256 nmg->mg_flags = mg->mg_flags;
9257 if (mg->mg_type == PERL_MAGIC_qr) {
9258 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9260 else if(mg->mg_type == PERL_MAGIC_backref) {
9261 /* The backref AV has its reference count deliberately bumped by
9263 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9265 else if (mg->mg_type == PERL_MAGIC_symtab) {
9266 nmg->mg_obj = mg->mg_obj;
9269 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9270 ? sv_dup_inc(mg->mg_obj, param)
9271 : sv_dup(mg->mg_obj, param);
9273 nmg->mg_len = mg->mg_len;
9274 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9275 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9276 if (mg->mg_len > 0) {
9277 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9278 if (mg->mg_type == PERL_MAGIC_overload_table &&
9279 AMT_AMAGIC((AMT*)mg->mg_ptr))
9281 const AMT * const amtp = (AMT*)mg->mg_ptr;
9282 AMT * const namtp = (AMT*)nmg->mg_ptr;
9284 for (i = 1; i < NofAMmeth; i++) {
9285 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9289 else if (mg->mg_len == HEf_SVKEY)
9290 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9292 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9293 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9300 /* create a new pointer-mapping table */
9303 Perl_ptr_table_new(pTHX)
9306 Newxz(tbl, 1, PTR_TBL_t);
9309 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9313 #define PTR_TABLE_HASH(ptr) \
9314 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9317 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9318 following define) and at call to new_body_inline made below in
9319 Perl_ptr_table_store()
9322 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9324 /* map an existing pointer using a table */
9326 STATIC PTR_TBL_ENT_t *
9327 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9328 PTR_TBL_ENT_t *tblent;
9329 const UV hash = PTR_TABLE_HASH(sv);
9331 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9332 for (; tblent; tblent = tblent->next) {
9333 if (tblent->oldval == sv)
9340 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9342 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9343 return tblent ? tblent->newval : (void *) 0;
9346 /* add a new entry to a pointer-mapping table */
9349 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9351 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9354 tblent->newval = newsv;
9356 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9358 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9359 tblent->oldval = oldsv;
9360 tblent->newval = newsv;
9361 tblent->next = tbl->tbl_ary[entry];
9362 tbl->tbl_ary[entry] = tblent;
9364 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9365 ptr_table_split(tbl);
9369 /* double the hash bucket size of an existing ptr table */
9372 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9374 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9375 const UV oldsize = tbl->tbl_max + 1;
9376 UV newsize = oldsize * 2;
9379 Renew(ary, newsize, PTR_TBL_ENT_t*);
9380 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9381 tbl->tbl_max = --newsize;
9383 for (i=0; i < oldsize; i++, ary++) {
9384 PTR_TBL_ENT_t **curentp, **entp, *ent;
9387 curentp = ary + oldsize;
9388 for (entp = ary, ent = *ary; ent; ent = *entp) {
9389 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9391 ent->next = *curentp;
9401 /* remove all the entries from a ptr table */
9404 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9406 if (tbl && tbl->tbl_items) {
9407 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9408 UV riter = tbl->tbl_max;
9411 PTR_TBL_ENT_t *entry = array[riter];
9414 PTR_TBL_ENT_t * const oentry = entry;
9415 entry = entry->next;
9424 /* clear and free a ptr table */
9427 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9432 ptr_table_clear(tbl);
9433 Safefree(tbl->tbl_ary);
9439 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9442 SvRV_set(dstr, SvWEAKREF(sstr)
9443 ? sv_dup(SvRV(sstr), param)
9444 : sv_dup_inc(SvRV(sstr), param));
9447 else if (SvPVX_const(sstr)) {
9448 /* Has something there */
9450 /* Normal PV - clone whole allocated space */
9451 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9452 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9453 /* Not that normal - actually sstr is copy on write.
9454 But we are a true, independant SV, so: */
9455 SvREADONLY_off(dstr);
9460 /* Special case - not normally malloced for some reason */
9461 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9462 /* A "shared" PV - clone it as "shared" PV */
9464 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9468 /* Some other special case - random pointer */
9469 SvPV_set(dstr, SvPVX(sstr));
9475 if (SvTYPE(dstr) == SVt_RV)
9476 SvRV_set(dstr, NULL);
9478 SvPV_set(dstr, NULL);
9482 /* duplicate an SV of any type (including AV, HV etc) */
9485 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9490 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9492 /* look for it in the table first */
9493 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9497 if(param->flags & CLONEf_JOIN_IN) {
9498 /** We are joining here so we don't want do clone
9499 something that is bad **/
9500 if (SvTYPE(sstr) == SVt_PVHV) {
9501 const char * const hvname = HvNAME_get(sstr);
9503 /** don't clone stashes if they already exist **/
9504 return (SV*)gv_stashpv(hvname,0);
9508 /* create anew and remember what it is */
9511 #ifdef DEBUG_LEAKING_SCALARS
9512 dstr->sv_debug_optype = sstr->sv_debug_optype;
9513 dstr->sv_debug_line = sstr->sv_debug_line;
9514 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9515 dstr->sv_debug_cloned = 1;
9516 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9519 ptr_table_store(PL_ptr_table, sstr, dstr);
9522 SvFLAGS(dstr) = SvFLAGS(sstr);
9523 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9524 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9527 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9528 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9529 PL_watch_pvx, SvPVX_const(sstr));
9532 /* don't clone objects whose class has asked us not to */
9533 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9534 SvFLAGS(dstr) &= ~SVTYPEMASK;
9539 switch (SvTYPE(sstr)) {
9544 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9545 SvIV_set(dstr, SvIVX(sstr));
9548 SvANY(dstr) = new_XNV();
9549 SvNV_set(dstr, SvNVX(sstr));
9552 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9553 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9557 /* These are all the types that need complex bodies allocating. */
9559 const svtype sv_type = SvTYPE(sstr);
9560 const struct body_details *const sv_type_details
9561 = bodies_by_type + sv_type;
9565 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9570 if (GvUNIQUE((GV*)sstr)) {
9571 /* Do sharing here, and fall through */
9584 assert(sv_type_details->size);
9585 if (sv_type_details->arena) {
9586 new_body_inline(new_body, sv_type_details->size, sv_type);
9588 = (void*)((char*)new_body - sv_type_details->offset);
9590 new_body = new_NOARENA(sv_type_details);
9594 SvANY(dstr) = new_body;
9597 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9598 ((char*)SvANY(dstr)) + sv_type_details->offset,
9599 sv_type_details->copy, char);
9601 Copy(((char*)SvANY(sstr)),
9602 ((char*)SvANY(dstr)),
9603 sv_type_details->size + sv_type_details->offset, char);
9606 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9607 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9609 /* The Copy above means that all the source (unduplicated) pointers
9610 are now in the destination. We can check the flags and the
9611 pointers in either, but it's possible that there's less cache
9612 missing by always going for the destination.
9613 FIXME - instrument and check that assumption */
9614 if (sv_type >= SVt_PVMG) {
9616 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9618 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9621 /* The cast silences a GCC warning about unhandled types. */
9622 switch ((int)sv_type) {
9634 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9635 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9636 LvTARG(dstr) = dstr;
9637 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9638 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9640 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9643 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9644 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9645 /* Don't call sv_add_backref here as it's going to be created
9646 as part of the magic cloning of the symbol table. */
9647 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9648 (void)GpREFCNT_inc(GvGP(dstr));
9651 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9652 if (IoOFP(dstr) == IoIFP(sstr))
9653 IoOFP(dstr) = IoIFP(dstr);
9655 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9656 /* PL_rsfp_filters entries have fake IoDIRP() */
9657 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9658 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9659 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9660 /* I have no idea why fake dirp (rsfps)
9661 should be treated differently but otherwise
9662 we end up with leaks -- sky*/
9663 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9664 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9665 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9667 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9668 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9669 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9671 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9672 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9673 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9676 if (AvARRAY((AV*)sstr)) {
9677 SV **dst_ary, **src_ary;
9678 SSize_t items = AvFILLp((AV*)sstr) + 1;
9680 src_ary = AvARRAY((AV*)sstr);
9681 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9682 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9683 SvPV_set(dstr, (char*)dst_ary);
9684 AvALLOC((AV*)dstr) = dst_ary;
9685 if (AvREAL((AV*)sstr)) {
9687 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9691 *dst_ary++ = sv_dup(*src_ary++, param);
9693 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9694 while (items-- > 0) {
9695 *dst_ary++ = &PL_sv_undef;
9699 SvPV_set(dstr, NULL);
9700 AvALLOC((AV*)dstr) = (SV**)NULL;
9707 if (HvARRAY((HV*)sstr)) {
9709 const bool sharekeys = !!HvSHAREKEYS(sstr);
9710 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9711 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9713 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9714 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9716 HvARRAY(dstr) = (HE**)darray;
9717 while (i <= sxhv->xhv_max) {
9718 const HE *source = HvARRAY(sstr)[i];
9719 HvARRAY(dstr)[i] = source
9720 ? he_dup(source, sharekeys, param) : 0;
9724 struct xpvhv_aux * const saux = HvAUX(sstr);
9725 struct xpvhv_aux * const daux = HvAUX(dstr);
9726 /* This flag isn't copied. */
9727 /* SvOOK_on(hv) attacks the IV flags. */
9728 SvFLAGS(dstr) |= SVf_OOK;
9730 hvname = saux->xhv_name;
9732 = hvname ? hek_dup(hvname, param) : hvname;
9734 daux->xhv_riter = saux->xhv_riter;
9735 daux->xhv_eiter = saux->xhv_eiter
9736 ? he_dup(saux->xhv_eiter,
9737 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9738 daux->xhv_backreferences = saux->xhv_backreferences
9739 ? (AV*) SvREFCNT_inc(
9747 SvPV_set(dstr, NULL);
9749 /* Record stashes for possible cloning in Perl_clone(). */
9751 av_push(param->stashes, dstr);
9756 /* NOTE: not refcounted */
9757 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9759 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9761 if (CvCONST(dstr)) {
9762 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9763 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9764 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9766 /* don't dup if copying back - CvGV isn't refcounted, so the
9767 * duped GV may never be freed. A bit of a hack! DAPM */
9768 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9769 NULL : gv_dup(CvGV(dstr), param) ;
9770 if (!(param->flags & CLONEf_COPY_STACKS)) {
9773 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9776 ? cv_dup( CvOUTSIDE(dstr), param)
9777 : cv_dup_inc(CvOUTSIDE(dstr), param);
9779 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9785 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9791 /* duplicate a context */
9794 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9799 return (PERL_CONTEXT*)NULL;
9801 /* look for it in the table first */
9802 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9806 /* create anew and remember what it is */
9807 Newxz(ncxs, max + 1, PERL_CONTEXT);
9808 ptr_table_store(PL_ptr_table, cxs, ncxs);
9811 PERL_CONTEXT * const cx = &cxs[ix];
9812 PERL_CONTEXT * const ncx = &ncxs[ix];
9813 ncx->cx_type = cx->cx_type;
9814 if (CxTYPE(cx) == CXt_SUBST) {
9815 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9818 ncx->blk_oldsp = cx->blk_oldsp;
9819 ncx->blk_oldcop = cx->blk_oldcop;
9820 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9821 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9822 ncx->blk_oldpm = cx->blk_oldpm;
9823 ncx->blk_gimme = cx->blk_gimme;
9824 switch (CxTYPE(cx)) {
9826 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9827 ? cv_dup_inc(cx->blk_sub.cv, param)
9828 : cv_dup(cx->blk_sub.cv,param));
9829 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9830 ? av_dup_inc(cx->blk_sub.argarray, param)
9832 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9833 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9834 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9835 ncx->blk_sub.lval = cx->blk_sub.lval;
9836 ncx->blk_sub.retop = cx->blk_sub.retop;
9839 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9840 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9841 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9842 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9843 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9844 ncx->blk_eval.retop = cx->blk_eval.retop;
9847 ncx->blk_loop.label = cx->blk_loop.label;
9848 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9849 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9850 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9851 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9852 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9853 ? cx->blk_loop.iterdata
9854 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9855 ncx->blk_loop.oldcomppad
9856 = (PAD*)ptr_table_fetch(PL_ptr_table,
9857 cx->blk_loop.oldcomppad);
9858 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9859 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9860 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9861 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9862 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9865 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9866 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9867 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9868 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9869 ncx->blk_sub.retop = cx->blk_sub.retop;
9881 /* duplicate a stack info structure */
9884 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9889 return (PERL_SI*)NULL;
9891 /* look for it in the table first */
9892 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9896 /* create anew and remember what it is */
9897 Newxz(nsi, 1, PERL_SI);
9898 ptr_table_store(PL_ptr_table, si, nsi);
9900 nsi->si_stack = av_dup_inc(si->si_stack, param);
9901 nsi->si_cxix = si->si_cxix;
9902 nsi->si_cxmax = si->si_cxmax;
9903 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9904 nsi->si_type = si->si_type;
9905 nsi->si_prev = si_dup(si->si_prev, param);
9906 nsi->si_next = si_dup(si->si_next, param);
9907 nsi->si_markoff = si->si_markoff;
9912 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9913 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9914 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9915 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9916 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9917 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9918 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9919 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9920 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9921 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9922 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9923 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9924 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9925 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9928 #define pv_dup_inc(p) SAVEPV(p)
9929 #define pv_dup(p) SAVEPV(p)
9930 #define svp_dup_inc(p,pp) any_dup(p,pp)
9932 /* map any object to the new equivent - either something in the
9933 * ptr table, or something in the interpreter structure
9937 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9944 /* look for it in the table first */
9945 ret = ptr_table_fetch(PL_ptr_table, v);
9949 /* see if it is part of the interpreter structure */
9950 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9951 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9959 /* duplicate the save stack */
9962 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9964 ANY * const ss = proto_perl->Tsavestack;
9965 const I32 max = proto_perl->Tsavestack_max;
9966 I32 ix = proto_perl->Tsavestack_ix;
9978 void (*dptr) (void*);
9979 void (*dxptr) (pTHX_ void*);
9981 Newxz(nss, max, ANY);
9984 I32 i = POPINT(ss,ix);
9987 case SAVEt_ITEM: /* normal string */
9988 sv = (SV*)POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9990 sv = (SV*)POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9993 case SAVEt_SV: /* scalar reference */
9994 sv = (SV*)POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9996 gv = (GV*)POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9999 case SAVEt_GENERIC_PVREF: /* generic char* */
10000 c = (char*)POPPTR(ss,ix);
10001 TOPPTR(nss,ix) = pv_dup(c);
10002 ptr = POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10005 case SAVEt_SHARED_PVREF: /* char* in shared space */
10006 c = (char*)POPPTR(ss,ix);
10007 TOPPTR(nss,ix) = savesharedpv(c);
10008 ptr = POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10011 case SAVEt_GENERIC_SVREF: /* generic sv */
10012 case SAVEt_SVREF: /* scalar reference */
10013 sv = (SV*)POPPTR(ss,ix);
10014 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10015 ptr = POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10018 case SAVEt_AV: /* array reference */
10019 av = (AV*)POPPTR(ss,ix);
10020 TOPPTR(nss,ix) = av_dup_inc(av, param);
10021 gv = (GV*)POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = gv_dup(gv, param);
10024 case SAVEt_HV: /* hash reference */
10025 hv = (HV*)POPPTR(ss,ix);
10026 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10027 gv = (GV*)POPPTR(ss,ix);
10028 TOPPTR(nss,ix) = gv_dup(gv, param);
10030 case SAVEt_INT: /* int reference */
10031 ptr = POPPTR(ss,ix);
10032 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10033 intval = (int)POPINT(ss,ix);
10034 TOPINT(nss,ix) = intval;
10036 case SAVEt_LONG: /* long reference */
10037 ptr = POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10039 longval = (long)POPLONG(ss,ix);
10040 TOPLONG(nss,ix) = longval;
10042 case SAVEt_I32: /* I32 reference */
10043 case SAVEt_I16: /* I16 reference */
10044 case SAVEt_I8: /* I8 reference */
10045 ptr = POPPTR(ss,ix);
10046 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10048 TOPINT(nss,ix) = i;
10050 case SAVEt_IV: /* IV reference */
10051 ptr = POPPTR(ss,ix);
10052 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10054 TOPIV(nss,ix) = iv;
10056 case SAVEt_SPTR: /* SV* reference */
10057 ptr = POPPTR(ss,ix);
10058 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10059 sv = (SV*)POPPTR(ss,ix);
10060 TOPPTR(nss,ix) = sv_dup(sv, param);
10062 case SAVEt_VPTR: /* random* reference */
10063 ptr = POPPTR(ss,ix);
10064 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10065 ptr = POPPTR(ss,ix);
10066 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10068 case SAVEt_PPTR: /* char* reference */
10069 ptr = POPPTR(ss,ix);
10070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10071 c = (char*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = pv_dup(c);
10074 case SAVEt_HPTR: /* HV* reference */
10075 ptr = POPPTR(ss,ix);
10076 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10077 hv = (HV*)POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = hv_dup(hv, param);
10080 case SAVEt_APTR: /* AV* reference */
10081 ptr = POPPTR(ss,ix);
10082 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10083 av = (AV*)POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = av_dup(av, param);
10087 gv = (GV*)POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = gv_dup(gv, param);
10090 case SAVEt_GP: /* scalar reference */
10091 gp = (GP*)POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10093 (void)GpREFCNT_inc(gp);
10094 gv = (GV*)POPPTR(ss,ix);
10095 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10096 c = (char*)POPPTR(ss,ix);
10097 TOPPTR(nss,ix) = pv_dup(c);
10099 TOPIV(nss,ix) = iv;
10101 TOPIV(nss,ix) = iv;
10104 case SAVEt_MORTALIZESV:
10105 sv = (SV*)POPPTR(ss,ix);
10106 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10109 ptr = POPPTR(ss,ix);
10110 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10111 /* these are assumed to be refcounted properly */
10113 switch (((OP*)ptr)->op_type) {
10115 case OP_LEAVESUBLV:
10119 case OP_LEAVEWRITE:
10120 TOPPTR(nss,ix) = ptr;
10125 TOPPTR(nss,ix) = Nullop;
10130 TOPPTR(nss,ix) = Nullop;
10133 c = (char*)POPPTR(ss,ix);
10134 TOPPTR(nss,ix) = pv_dup_inc(c);
10136 case SAVEt_CLEARSV:
10137 longval = POPLONG(ss,ix);
10138 TOPLONG(nss,ix) = longval;
10141 hv = (HV*)POPPTR(ss,ix);
10142 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10143 c = (char*)POPPTR(ss,ix);
10144 TOPPTR(nss,ix) = pv_dup_inc(c);
10146 TOPINT(nss,ix) = i;
10148 case SAVEt_DESTRUCTOR:
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10151 dptr = POPDPTR(ss,ix);
10152 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10153 any_dup(FPTR2DPTR(void *, dptr),
10156 case SAVEt_DESTRUCTOR_X:
10157 ptr = POPPTR(ss,ix);
10158 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10159 dxptr = POPDXPTR(ss,ix);
10160 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10161 any_dup(FPTR2DPTR(void *, dxptr),
10164 case SAVEt_REGCONTEXT:
10167 TOPINT(nss,ix) = i;
10170 case SAVEt_STACK_POS: /* Position on Perl stack */
10172 TOPINT(nss,ix) = i;
10174 case SAVEt_AELEM: /* array element */
10175 sv = (SV*)POPPTR(ss,ix);
10176 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10178 TOPINT(nss,ix) = i;
10179 av = (AV*)POPPTR(ss,ix);
10180 TOPPTR(nss,ix) = av_dup_inc(av, param);
10182 case SAVEt_HELEM: /* hash element */
10183 sv = (SV*)POPPTR(ss,ix);
10184 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10185 sv = (SV*)POPPTR(ss,ix);
10186 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10187 hv = (HV*)POPPTR(ss,ix);
10188 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10191 ptr = POPPTR(ss,ix);
10192 TOPPTR(nss,ix) = ptr;
10196 TOPINT(nss,ix) = i;
10198 case SAVEt_COMPPAD:
10199 av = (AV*)POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = av_dup(av, param);
10203 longval = (long)POPLONG(ss,ix);
10204 TOPLONG(nss,ix) = longval;
10205 ptr = POPPTR(ss,ix);
10206 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10207 sv = (SV*)POPPTR(ss,ix);
10208 TOPPTR(nss,ix) = sv_dup(sv, param);
10211 ptr = POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10213 longval = (long)POPBOOL(ss,ix);
10214 TOPBOOL(nss,ix) = (bool)longval;
10216 case SAVEt_SET_SVFLAGS:
10218 TOPINT(nss,ix) = i;
10220 TOPINT(nss,ix) = i;
10221 sv = (SV*)POPPTR(ss,ix);
10222 TOPPTR(nss,ix) = sv_dup(sv, param);
10225 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10233 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10234 * flag to the result. This is done for each stash before cloning starts,
10235 * so we know which stashes want their objects cloned */
10238 do_mark_cloneable_stash(pTHX_ SV *sv)
10240 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10242 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10243 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10244 if (cloner && GvCV(cloner)) {
10251 XPUSHs(sv_2mortal(newSVhek(hvname)));
10253 call_sv((SV*)GvCV(cloner), G_SCALAR);
10260 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10268 =for apidoc perl_clone
10270 Create and return a new interpreter by cloning the current one.
10272 perl_clone takes these flags as parameters:
10274 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10275 without it we only clone the data and zero the stacks,
10276 with it we copy the stacks and the new perl interpreter is
10277 ready to run at the exact same point as the previous one.
10278 The pseudo-fork code uses COPY_STACKS while the
10279 threads->new doesn't.
10281 CLONEf_KEEP_PTR_TABLE
10282 perl_clone keeps a ptr_table with the pointer of the old
10283 variable as a key and the new variable as a value,
10284 this allows it to check if something has been cloned and not
10285 clone it again but rather just use the value and increase the
10286 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10287 the ptr_table using the function
10288 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10289 reason to keep it around is if you want to dup some of your own
10290 variable who are outside the graph perl scans, example of this
10291 code is in threads.xs create
10294 This is a win32 thing, it is ignored on unix, it tells perls
10295 win32host code (which is c++) to clone itself, this is needed on
10296 win32 if you want to run two threads at the same time,
10297 if you just want to do some stuff in a separate perl interpreter
10298 and then throw it away and return to the original one,
10299 you don't need to do anything.
10304 /* XXX the above needs expanding by someone who actually understands it ! */
10305 EXTERN_C PerlInterpreter *
10306 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10309 perl_clone(PerlInterpreter *proto_perl, UV flags)
10312 #ifdef PERL_IMPLICIT_SYS
10314 /* perlhost.h so we need to call into it
10315 to clone the host, CPerlHost should have a c interface, sky */
10317 if (flags & CLONEf_CLONE_HOST) {
10318 return perl_clone_host(proto_perl,flags);
10320 return perl_clone_using(proto_perl, flags,
10322 proto_perl->IMemShared,
10323 proto_perl->IMemParse,
10325 proto_perl->IStdIO,
10329 proto_perl->IProc);
10333 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10334 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10335 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10336 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10337 struct IPerlDir* ipD, struct IPerlSock* ipS,
10338 struct IPerlProc* ipP)
10340 /* XXX many of the string copies here can be optimized if they're
10341 * constants; they need to be allocated as common memory and just
10342 * their pointers copied. */
10345 CLONE_PARAMS clone_params;
10346 CLONE_PARAMS* param = &clone_params;
10348 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10349 /* for each stash, determine whether its objects should be cloned */
10350 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10351 PERL_SET_THX(my_perl);
10354 Poison(my_perl, 1, PerlInterpreter);
10356 PL_curcop = (COP *)Nullop;
10360 PL_savestack_ix = 0;
10361 PL_savestack_max = -1;
10362 PL_sig_pending = 0;
10363 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10364 # else /* !DEBUGGING */
10365 Zero(my_perl, 1, PerlInterpreter);
10366 # endif /* DEBUGGING */
10368 /* host pointers */
10370 PL_MemShared = ipMS;
10371 PL_MemParse = ipMP;
10378 #else /* !PERL_IMPLICIT_SYS */
10380 CLONE_PARAMS clone_params;
10381 CLONE_PARAMS* param = &clone_params;
10382 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10383 /* for each stash, determine whether its objects should be cloned */
10384 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10385 PERL_SET_THX(my_perl);
10388 Poison(my_perl, 1, PerlInterpreter);
10390 PL_curcop = (COP *)Nullop;
10394 PL_savestack_ix = 0;
10395 PL_savestack_max = -1;
10396 PL_sig_pending = 0;
10397 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10398 # else /* !DEBUGGING */
10399 Zero(my_perl, 1, PerlInterpreter);
10400 # endif /* DEBUGGING */
10401 #endif /* PERL_IMPLICIT_SYS */
10402 param->flags = flags;
10403 param->proto_perl = proto_perl;
10405 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10407 PL_body_arenas = NULL;
10408 Zero(&PL_body_roots, 1, PL_body_roots);
10410 PL_nice_chunk = NULL;
10411 PL_nice_chunk_size = 0;
10413 PL_sv_objcount = 0;
10415 PL_sv_arenaroot = NULL;
10417 PL_debug = proto_perl->Idebug;
10419 PL_hash_seed = proto_perl->Ihash_seed;
10420 PL_rehash_seed = proto_perl->Irehash_seed;
10422 #ifdef USE_REENTRANT_API
10423 /* XXX: things like -Dm will segfault here in perlio, but doing
10424 * PERL_SET_CONTEXT(proto_perl);
10425 * breaks too many other things
10427 Perl_reentrant_init(aTHX);
10430 /* create SV map for pointer relocation */
10431 PL_ptr_table = ptr_table_new();
10433 /* initialize these special pointers as early as possible */
10434 SvANY(&PL_sv_undef) = NULL;
10435 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10436 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10437 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10439 SvANY(&PL_sv_no) = new_XPVNV();
10440 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10441 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10442 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10443 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10444 SvCUR_set(&PL_sv_no, 0);
10445 SvLEN_set(&PL_sv_no, 1);
10446 SvIV_set(&PL_sv_no, 0);
10447 SvNV_set(&PL_sv_no, 0);
10448 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10450 SvANY(&PL_sv_yes) = new_XPVNV();
10451 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10452 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10453 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10454 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10455 SvCUR_set(&PL_sv_yes, 1);
10456 SvLEN_set(&PL_sv_yes, 2);
10457 SvIV_set(&PL_sv_yes, 1);
10458 SvNV_set(&PL_sv_yes, 1);
10459 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10461 /* create (a non-shared!) shared string table */
10462 PL_strtab = newHV();
10463 HvSHAREKEYS_off(PL_strtab);
10464 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10465 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10467 PL_compiling = proto_perl->Icompiling;
10469 /* These two PVs will be free'd special way so must set them same way op.c does */
10470 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10471 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10473 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10474 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10476 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10477 if (!specialWARN(PL_compiling.cop_warnings))
10478 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10479 if (!specialCopIO(PL_compiling.cop_io))
10480 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10481 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10483 /* pseudo environmental stuff */
10484 PL_origargc = proto_perl->Iorigargc;
10485 PL_origargv = proto_perl->Iorigargv;
10487 param->stashes = newAV(); /* Setup array of objects to call clone on */
10489 /* Set tainting stuff before PerlIO_debug can possibly get called */
10490 PL_tainting = proto_perl->Itainting;
10491 PL_taint_warn = proto_perl->Itaint_warn;
10493 #ifdef PERLIO_LAYERS
10494 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10495 PerlIO_clone(aTHX_ proto_perl, param);
10498 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10499 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10500 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10501 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10502 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10503 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10506 PL_minus_c = proto_perl->Iminus_c;
10507 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10508 PL_localpatches = proto_perl->Ilocalpatches;
10509 PL_splitstr = proto_perl->Isplitstr;
10510 PL_preprocess = proto_perl->Ipreprocess;
10511 PL_minus_n = proto_perl->Iminus_n;
10512 PL_minus_p = proto_perl->Iminus_p;
10513 PL_minus_l = proto_perl->Iminus_l;
10514 PL_minus_a = proto_perl->Iminus_a;
10515 PL_minus_E = proto_perl->Iminus_E;
10516 PL_minus_F = proto_perl->Iminus_F;
10517 PL_doswitches = proto_perl->Idoswitches;
10518 PL_dowarn = proto_perl->Idowarn;
10519 PL_doextract = proto_perl->Idoextract;
10520 PL_sawampersand = proto_perl->Isawampersand;
10521 PL_unsafe = proto_perl->Iunsafe;
10522 PL_inplace = SAVEPV(proto_perl->Iinplace);
10523 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10524 PL_perldb = proto_perl->Iperldb;
10525 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10526 PL_exit_flags = proto_perl->Iexit_flags;
10528 /* magical thingies */
10529 /* XXX time(&PL_basetime) when asked for? */
10530 PL_basetime = proto_perl->Ibasetime;
10531 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10533 PL_maxsysfd = proto_perl->Imaxsysfd;
10534 PL_multiline = proto_perl->Imultiline;
10535 PL_statusvalue = proto_perl->Istatusvalue;
10537 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10539 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10541 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10543 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10544 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10545 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10547 /* Clone the regex array */
10548 PL_regex_padav = newAV();
10550 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10551 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10553 av_push(PL_regex_padav,
10554 sv_dup_inc(regexen[0],param));
10555 for(i = 1; i <= len; i++) {
10556 const SV * const regex = regexen[i];
10559 ? sv_dup_inc(regex, param)
10561 newSViv(PTR2IV(re_dup(
10562 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10564 av_push(PL_regex_padav, sv);
10567 PL_regex_pad = AvARRAY(PL_regex_padav);
10569 /* shortcuts to various I/O objects */
10570 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10571 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10572 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10573 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10574 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10575 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10577 /* shortcuts to regexp stuff */
10578 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10580 /* shortcuts to misc objects */
10581 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10583 /* shortcuts to debugging objects */
10584 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10585 PL_DBline = gv_dup(proto_perl->IDBline, param);
10586 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10587 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10588 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10589 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10590 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10591 PL_lineary = av_dup(proto_perl->Ilineary, param);
10592 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10594 /* symbol tables */
10595 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10596 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10597 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10598 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10599 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10601 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10602 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10603 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10604 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10605 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10606 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10608 PL_sub_generation = proto_perl->Isub_generation;
10610 /* funky return mechanisms */
10611 PL_forkprocess = proto_perl->Iforkprocess;
10613 /* subprocess state */
10614 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10616 /* internal state */
10617 PL_maxo = proto_perl->Imaxo;
10618 if (proto_perl->Iop_mask)
10619 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10622 /* PL_asserting = proto_perl->Iasserting; */
10624 /* current interpreter roots */
10625 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10626 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10627 PL_main_start = proto_perl->Imain_start;
10628 PL_eval_root = proto_perl->Ieval_root;
10629 PL_eval_start = proto_perl->Ieval_start;
10631 /* runtime control stuff */
10632 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10633 PL_copline = proto_perl->Icopline;
10635 PL_filemode = proto_perl->Ifilemode;
10636 PL_lastfd = proto_perl->Ilastfd;
10637 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10640 PL_gensym = proto_perl->Igensym;
10641 PL_preambled = proto_perl->Ipreambled;
10642 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10643 PL_laststatval = proto_perl->Ilaststatval;
10644 PL_laststype = proto_perl->Ilaststype;
10647 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10649 /* interpreter atexit processing */
10650 PL_exitlistlen = proto_perl->Iexitlistlen;
10651 if (PL_exitlistlen) {
10652 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10653 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10656 PL_exitlist = (PerlExitListEntry*)NULL;
10658 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10659 if (PL_my_cxt_size) {
10660 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10661 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10664 PL_my_cxt_list = (void**)NULL;
10665 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10666 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10667 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10669 PL_profiledata = NULL;
10670 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10671 /* PL_rsfp_filters entries have fake IoDIRP() */
10672 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10674 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10676 PAD_CLONE_VARS(proto_perl, param);
10678 #ifdef HAVE_INTERP_INTERN
10679 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10682 /* more statics moved here */
10683 PL_generation = proto_perl->Igeneration;
10684 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10686 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10687 PL_in_clean_all = proto_perl->Iin_clean_all;
10689 PL_uid = proto_perl->Iuid;
10690 PL_euid = proto_perl->Ieuid;
10691 PL_gid = proto_perl->Igid;
10692 PL_egid = proto_perl->Iegid;
10693 PL_nomemok = proto_perl->Inomemok;
10694 PL_an = proto_perl->Ian;
10695 PL_evalseq = proto_perl->Ievalseq;
10696 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10697 PL_origalen = proto_perl->Iorigalen;
10698 #ifdef PERL_USES_PL_PIDSTATUS
10699 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10701 PL_osname = SAVEPV(proto_perl->Iosname);
10702 PL_sighandlerp = proto_perl->Isighandlerp;
10704 PL_runops = proto_perl->Irunops;
10706 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10709 PL_cshlen = proto_perl->Icshlen;
10710 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10713 PL_lex_state = proto_perl->Ilex_state;
10714 PL_lex_defer = proto_perl->Ilex_defer;
10715 PL_lex_expect = proto_perl->Ilex_expect;
10716 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10717 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10718 PL_lex_starts = proto_perl->Ilex_starts;
10719 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10720 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10721 PL_lex_op = proto_perl->Ilex_op;
10722 PL_lex_inpat = proto_perl->Ilex_inpat;
10723 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10724 PL_lex_brackets = proto_perl->Ilex_brackets;
10725 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10726 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10727 PL_lex_casemods = proto_perl->Ilex_casemods;
10728 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10729 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10731 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10732 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10733 PL_nexttoke = proto_perl->Inexttoke;
10735 /* XXX This is probably masking the deeper issue of why
10736 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10737 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10738 * (A little debugging with a watchpoint on it may help.)
10740 if (SvANY(proto_perl->Ilinestr)) {
10741 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10742 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10743 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10744 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10745 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10746 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10747 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10748 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10749 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10752 PL_linestr = newSV(79);
10753 sv_upgrade(PL_linestr,SVt_PVIV);
10754 sv_setpvn(PL_linestr,"",0);
10755 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10757 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10758 PL_pending_ident = proto_perl->Ipending_ident;
10759 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10761 PL_expect = proto_perl->Iexpect;
10763 PL_multi_start = proto_perl->Imulti_start;
10764 PL_multi_end = proto_perl->Imulti_end;
10765 PL_multi_open = proto_perl->Imulti_open;
10766 PL_multi_close = proto_perl->Imulti_close;
10768 PL_error_count = proto_perl->Ierror_count;
10769 PL_subline = proto_perl->Isubline;
10770 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10772 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10773 if (SvANY(proto_perl->Ilinestr)) {
10774 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10775 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10776 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10777 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10778 PL_last_lop_op = proto_perl->Ilast_lop_op;
10781 PL_last_uni = SvPVX(PL_linestr);
10782 PL_last_lop = SvPVX(PL_linestr);
10783 PL_last_lop_op = 0;
10785 PL_in_my = proto_perl->Iin_my;
10786 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10788 PL_cryptseen = proto_perl->Icryptseen;
10791 PL_hints = proto_perl->Ihints;
10793 PL_amagic_generation = proto_perl->Iamagic_generation;
10795 #ifdef USE_LOCALE_COLLATE
10796 PL_collation_ix = proto_perl->Icollation_ix;
10797 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10798 PL_collation_standard = proto_perl->Icollation_standard;
10799 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10800 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10801 #endif /* USE_LOCALE_COLLATE */
10803 #ifdef USE_LOCALE_NUMERIC
10804 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10805 PL_numeric_standard = proto_perl->Inumeric_standard;
10806 PL_numeric_local = proto_perl->Inumeric_local;
10807 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10808 #endif /* !USE_LOCALE_NUMERIC */
10810 /* utf8 character classes */
10811 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10812 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10813 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10814 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10815 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10816 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10817 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10818 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10819 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10820 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10821 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10822 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10823 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10824 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10825 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10826 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10827 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10828 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10829 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10830 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10832 /* Did the locale setup indicate UTF-8? */
10833 PL_utf8locale = proto_perl->Iutf8locale;
10834 /* Unicode features (see perlrun/-C) */
10835 PL_unicode = proto_perl->Iunicode;
10837 /* Pre-5.8 signals control */
10838 PL_signals = proto_perl->Isignals;
10840 /* times() ticks per second */
10841 PL_clocktick = proto_perl->Iclocktick;
10843 /* Recursion stopper for PerlIO_find_layer */
10844 PL_in_load_module = proto_perl->Iin_load_module;
10846 /* sort() routine */
10847 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10849 /* Not really needed/useful since the reenrant_retint is "volatile",
10850 * but do it for consistency's sake. */
10851 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10853 /* Hooks to shared SVs and locks. */
10854 PL_sharehook = proto_perl->Isharehook;
10855 PL_lockhook = proto_perl->Ilockhook;
10856 PL_unlockhook = proto_perl->Iunlockhook;
10857 PL_threadhook = proto_perl->Ithreadhook;
10859 PL_runops_std = proto_perl->Irunops_std;
10860 PL_runops_dbg = proto_perl->Irunops_dbg;
10862 #ifdef THREADS_HAVE_PIDS
10863 PL_ppid = proto_perl->Ippid;
10867 PL_last_swash_hv = NULL; /* reinits on demand */
10868 PL_last_swash_klen = 0;
10869 PL_last_swash_key[0]= '\0';
10870 PL_last_swash_tmps = (U8*)NULL;
10871 PL_last_swash_slen = 0;
10873 PL_glob_index = proto_perl->Iglob_index;
10874 PL_srand_called = proto_perl->Isrand_called;
10875 PL_uudmap['M'] = 0; /* reinits on demand */
10876 PL_bitcount = NULL; /* reinits on demand */
10878 if (proto_perl->Ipsig_pend) {
10879 Newxz(PL_psig_pend, SIG_SIZE, int);
10882 PL_psig_pend = (int*)NULL;
10885 if (proto_perl->Ipsig_ptr) {
10886 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10887 Newxz(PL_psig_name, SIG_SIZE, SV*);
10888 for (i = 1; i < SIG_SIZE; i++) {
10889 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10890 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10894 PL_psig_ptr = (SV**)NULL;
10895 PL_psig_name = (SV**)NULL;
10898 /* thrdvar.h stuff */
10900 if (flags & CLONEf_COPY_STACKS) {
10901 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10902 PL_tmps_ix = proto_perl->Ttmps_ix;
10903 PL_tmps_max = proto_perl->Ttmps_max;
10904 PL_tmps_floor = proto_perl->Ttmps_floor;
10905 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10907 while (i <= PL_tmps_ix) {
10908 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10912 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10913 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10914 Newxz(PL_markstack, i, I32);
10915 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10916 - proto_perl->Tmarkstack);
10917 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10918 - proto_perl->Tmarkstack);
10919 Copy(proto_perl->Tmarkstack, PL_markstack,
10920 PL_markstack_ptr - PL_markstack + 1, I32);
10922 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10923 * NOTE: unlike the others! */
10924 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10925 PL_scopestack_max = proto_perl->Tscopestack_max;
10926 Newxz(PL_scopestack, PL_scopestack_max, I32);
10927 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10929 /* NOTE: si_dup() looks at PL_markstack */
10930 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10932 /* PL_curstack = PL_curstackinfo->si_stack; */
10933 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10934 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10936 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10937 PL_stack_base = AvARRAY(PL_curstack);
10938 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10939 - proto_perl->Tstack_base);
10940 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10942 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10943 * NOTE: unlike the others! */
10944 PL_savestack_ix = proto_perl->Tsavestack_ix;
10945 PL_savestack_max = proto_perl->Tsavestack_max;
10946 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10947 PL_savestack = ss_dup(proto_perl, param);
10951 ENTER; /* perl_destruct() wants to LEAVE; */
10953 /* although we're not duplicating the tmps stack, we should still
10954 * add entries for any SVs on the tmps stack that got cloned by a
10955 * non-refcount means (eg a temp in @_); otherwise they will be
10958 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10959 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10960 proto_perl->Ttmps_stack[i]);
10961 if (nsv && !SvREFCNT(nsv)) {
10963 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10968 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10969 PL_top_env = &PL_start_env;
10971 PL_op = proto_perl->Top;
10974 PL_Xpv = (XPV*)NULL;
10975 PL_na = proto_perl->Tna;
10977 PL_statbuf = proto_perl->Tstatbuf;
10978 PL_statcache = proto_perl->Tstatcache;
10979 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10980 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10982 PL_timesbuf = proto_perl->Ttimesbuf;
10985 PL_tainted = proto_perl->Ttainted;
10986 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10987 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10988 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10989 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10990 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10991 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10992 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10993 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10994 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10996 PL_restartop = proto_perl->Trestartop;
10997 PL_in_eval = proto_perl->Tin_eval;
10998 PL_delaymagic = proto_perl->Tdelaymagic;
10999 PL_dirty = proto_perl->Tdirty;
11000 PL_localizing = proto_perl->Tlocalizing;
11002 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11003 PL_hv_fetch_ent_mh = Nullhe;
11004 PL_modcount = proto_perl->Tmodcount;
11005 PL_lastgotoprobe = Nullop;
11006 PL_dumpindent = proto_perl->Tdumpindent;
11008 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11009 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11010 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11011 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11012 PL_efloatbuf = NULL; /* reinits on demand */
11013 PL_efloatsize = 0; /* reinits on demand */
11017 PL_screamfirst = NULL;
11018 PL_screamnext = NULL;
11019 PL_maxscream = -1; /* reinits on demand */
11020 PL_lastscream = NULL;
11022 PL_watchaddr = NULL;
11025 PL_regdummy = proto_perl->Tregdummy;
11026 PL_regprecomp = NULL;
11029 PL_colorset = 0; /* reinits PL_colors[] */
11030 /*PL_colors[6] = {0,0,0,0,0,0};*/
11031 PL_reginput = NULL;
11034 PL_regstartp = (I32*)NULL;
11035 PL_regendp = (I32*)NULL;
11036 PL_reglastparen = (U32*)NULL;
11037 PL_reglastcloseparen = (U32*)NULL;
11039 PL_reg_start_tmp = (char**)NULL;
11040 PL_reg_start_tmpl = 0;
11041 PL_regdata = (struct reg_data*)NULL;
11044 PL_reg_eval_set = 0;
11046 PL_regprogram = (regnode*)NULL;
11048 PL_regcc = (CURCUR*)NULL;
11049 PL_reg_call_cc = (struct re_cc_state*)NULL;
11050 PL_reg_re = (regexp*)NULL;
11051 PL_reg_ganch = NULL;
11053 PL_reg_match_utf8 = FALSE;
11054 PL_reg_magic = (MAGIC*)NULL;
11056 PL_reg_oldcurpm = (PMOP*)NULL;
11057 PL_reg_curpm = (PMOP*)NULL;
11058 PL_reg_oldsaved = NULL;
11059 PL_reg_oldsavedlen = 0;
11060 #ifdef PERL_OLD_COPY_ON_WRITE
11063 PL_reg_maxiter = 0;
11064 PL_reg_leftiter = 0;
11065 PL_reg_poscache = NULL;
11066 PL_reg_poscache_size= 0;
11068 /* RE engine - function pointers */
11069 PL_regcompp = proto_perl->Tregcompp;
11070 PL_regexecp = proto_perl->Tregexecp;
11071 PL_regint_start = proto_perl->Tregint_start;
11072 PL_regint_string = proto_perl->Tregint_string;
11073 PL_regfree = proto_perl->Tregfree;
11075 PL_reginterp_cnt = 0;
11076 PL_reg_starttry = 0;
11078 /* Pluggable optimizer */
11079 PL_peepp = proto_perl->Tpeepp;
11081 PL_stashcache = newHV();
11083 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11084 ptr_table_free(PL_ptr_table);
11085 PL_ptr_table = NULL;
11088 /* Call the ->CLONE method, if it exists, for each of the stashes
11089 identified by sv_dup() above.
11091 while(av_len(param->stashes) != -1) {
11092 HV* const stash = (HV*) av_shift(param->stashes);
11093 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11094 if (cloner && GvCV(cloner)) {
11099 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11101 call_sv((SV*)GvCV(cloner), G_DISCARD);
11107 SvREFCNT_dec(param->stashes);
11109 /* orphaned? eg threads->new inside BEGIN or use */
11110 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11111 (void)SvREFCNT_inc(PL_compcv);
11112 SAVEFREESV(PL_compcv);
11118 #endif /* USE_ITHREADS */
11121 =head1 Unicode Support
11123 =for apidoc sv_recode_to_utf8
11125 The encoding is assumed to be an Encode object, on entry the PV
11126 of the sv is assumed to be octets in that encoding, and the sv
11127 will be converted into Unicode (and UTF-8).
11129 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11130 is not a reference, nothing is done to the sv. If the encoding is not
11131 an C<Encode::XS> Encoding object, bad things will happen.
11132 (See F<lib/encoding.pm> and L<Encode>).
11134 The PV of the sv is returned.
11139 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11142 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11156 Passing sv_yes is wrong - it needs to be or'ed set of constants
11157 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11158 remove converted chars from source.
11160 Both will default the value - let them.
11162 XPUSHs(&PL_sv_yes);
11165 call_method("decode", G_SCALAR);
11169 s = SvPV_const(uni, len);
11170 if (s != SvPVX_const(sv)) {
11171 SvGROW(sv, len + 1);
11172 Move(s, SvPVX(sv), len + 1, char);
11173 SvCUR_set(sv, len);
11180 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11184 =for apidoc sv_cat_decode
11186 The encoding is assumed to be an Encode object, the PV of the ssv is
11187 assumed to be octets in that encoding and decoding the input starts
11188 from the position which (PV + *offset) pointed to. The dsv will be
11189 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11190 when the string tstr appears in decoding output or the input ends on
11191 the PV of the ssv. The value which the offset points will be modified
11192 to the last input position on the ssv.
11194 Returns TRUE if the terminator was found, else returns FALSE.
11199 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11200 SV *ssv, int *offset, char *tstr, int tlen)
11204 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11215 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11216 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11218 call_method("cat_decode", G_SCALAR);
11220 ret = SvTRUE(TOPs);
11221 *offset = SvIV(offsv);
11227 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11232 /* ---------------------------------------------------------------------
11234 * support functions for report_uninit()
11237 /* the maxiumum size of array or hash where we will scan looking
11238 * for the undefined element that triggered the warning */
11240 #define FUV_MAX_SEARCH_SIZE 1000
11242 /* Look for an entry in the hash whose value has the same SV as val;
11243 * If so, return a mortal copy of the key. */
11246 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11249 register HE **array;
11252 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11253 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11256 array = HvARRAY(hv);
11258 for (i=HvMAX(hv); i>0; i--) {
11259 register HE *entry;
11260 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11261 if (HeVAL(entry) != val)
11263 if ( HeVAL(entry) == &PL_sv_undef ||
11264 HeVAL(entry) == &PL_sv_placeholder)
11268 if (HeKLEN(entry) == HEf_SVKEY)
11269 return sv_mortalcopy(HeKEY_sv(entry));
11270 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11276 /* Look for an entry in the array whose value has the same SV as val;
11277 * If so, return the index, otherwise return -1. */
11280 S_find_array_subscript(pTHX_ AV *av, SV* val)
11285 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11286 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11290 for (i=AvFILLp(av); i>=0; i--) {
11291 if (svp[i] == val && svp[i] != &PL_sv_undef)
11297 /* S_varname(): return the name of a variable, optionally with a subscript.
11298 * If gv is non-zero, use the name of that global, along with gvtype (one
11299 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11300 * targ. Depending on the value of the subscript_type flag, return:
11303 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11304 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11305 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11306 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11309 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11310 SV* keyname, I32 aindex, int subscript_type)
11313 SV * const name = sv_newmortal();
11316 buffer[0] = gvtype;
11319 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11321 gv_fullname4(name, gv, buffer, 0);
11323 if ((unsigned int)SvPVX(name)[1] <= 26) {
11325 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11327 /* Swap the 1 unprintable control character for the 2 byte pretty
11328 version - ie substr($name, 1, 1) = $buffer; */
11329 sv_insert(name, 1, 1, buffer, 2);
11334 CV * const cv = find_runcv(&unused);
11338 if (!cv || !CvPADLIST(cv))
11340 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11341 sv = *av_fetch(av, targ, FALSE);
11342 /* SvLEN in a pad name is not to be trusted */
11343 sv_setpv(name, SvPV_nolen_const(sv));
11346 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11347 SV * const sv = newSV(0);
11348 *SvPVX(name) = '$';
11349 Perl_sv_catpvf(aTHX_ name, "{%s}",
11350 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11353 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11354 *SvPVX(name) = '$';
11355 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11357 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11358 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11365 =for apidoc find_uninit_var
11367 Find the name of the undefined variable (if any) that caused the operator o
11368 to issue a "Use of uninitialized value" warning.
11369 If match is true, only return a name if it's value matches uninit_sv.
11370 So roughly speaking, if a unary operator (such as OP_COS) generates a
11371 warning, then following the direct child of the op may yield an
11372 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11373 other hand, with OP_ADD there are two branches to follow, so we only print
11374 the variable name if we get an exact match.
11376 The name is returned as a mortal SV.
11378 Assumes that PL_op is the op that originally triggered the error, and that
11379 PL_comppad/PL_curpad points to the currently executing pad.
11385 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11393 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11394 uninit_sv == &PL_sv_placeholder)))
11397 switch (obase->op_type) {
11404 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11405 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11408 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11410 if (pad) { /* @lex, %lex */
11411 sv = PAD_SVl(obase->op_targ);
11415 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11416 /* @global, %global */
11417 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11420 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11422 else /* @{expr}, %{expr} */
11423 return find_uninit_var(cUNOPx(obase)->op_first,
11427 /* attempt to find a match within the aggregate */
11429 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11431 subscript_type = FUV_SUBSCRIPT_HASH;
11434 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11436 subscript_type = FUV_SUBSCRIPT_ARRAY;
11439 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11442 return varname(gv, hash ? '%' : '@', obase->op_targ,
11443 keysv, index, subscript_type);
11447 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11449 return varname(NULL, '$', obase->op_targ,
11450 NULL, 0, FUV_SUBSCRIPT_NONE);
11453 gv = cGVOPx_gv(obase);
11454 if (!gv || (match && GvSV(gv) != uninit_sv))
11456 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11459 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11462 av = (AV*)PAD_SV(obase->op_targ);
11463 if (!av || SvRMAGICAL(av))
11465 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11466 if (!svp || *svp != uninit_sv)
11469 return varname(NULL, '$', obase->op_targ,
11470 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11473 gv = cGVOPx_gv(obase);
11479 if (!av || SvRMAGICAL(av))
11481 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11482 if (!svp || *svp != uninit_sv)
11485 return varname(gv, '$', 0,
11486 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11491 o = cUNOPx(obase)->op_first;
11492 if (!o || o->op_type != OP_NULL ||
11493 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11495 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11499 if (PL_op == obase)
11500 /* $a[uninit_expr] or $h{uninit_expr} */
11501 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11504 o = cBINOPx(obase)->op_first;
11505 kid = cBINOPx(obase)->op_last;
11507 /* get the av or hv, and optionally the gv */
11509 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11510 sv = PAD_SV(o->op_targ);
11512 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11513 && cUNOPo->op_first->op_type == OP_GV)
11515 gv = cGVOPx_gv(cUNOPo->op_first);
11518 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11523 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11524 /* index is constant */
11528 if (obase->op_type == OP_HELEM) {
11529 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11530 if (!he || HeVAL(he) != uninit_sv)
11534 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11535 if (!svp || *svp != uninit_sv)
11539 if (obase->op_type == OP_HELEM)
11540 return varname(gv, '%', o->op_targ,
11541 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11543 return varname(gv, '@', o->op_targ, NULL,
11544 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11547 /* index is an expression;
11548 * attempt to find a match within the aggregate */
11549 if (obase->op_type == OP_HELEM) {
11550 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11552 return varname(gv, '%', o->op_targ,
11553 keysv, 0, FUV_SUBSCRIPT_HASH);
11556 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11558 return varname(gv, '@', o->op_targ,
11559 NULL, index, FUV_SUBSCRIPT_ARRAY);
11564 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11566 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11572 /* only examine RHS */
11573 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11576 o = cUNOPx(obase)->op_first;
11577 if (o->op_type == OP_PUSHMARK)
11580 if (!o->op_sibling) {
11581 /* one-arg version of open is highly magical */
11583 if (o->op_type == OP_GV) { /* open FOO; */
11585 if (match && GvSV(gv) != uninit_sv)
11587 return varname(gv, '$', 0,
11588 NULL, 0, FUV_SUBSCRIPT_NONE);
11590 /* other possibilities not handled are:
11591 * open $x; or open my $x; should return '${*$x}'
11592 * open expr; should return '$'.expr ideally
11598 /* ops where $_ may be an implicit arg */
11602 if ( !(obase->op_flags & OPf_STACKED)) {
11603 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11604 ? PAD_SVl(obase->op_targ)
11607 sv = sv_newmortal();
11608 sv_setpvn(sv, "$_", 2);
11616 /* skip filehandle as it can't produce 'undef' warning */
11617 o = cUNOPx(obase)->op_first;
11618 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11619 o = o->op_sibling->op_sibling;
11626 match = 1; /* XS or custom code could trigger random warnings */
11631 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11632 return sv_2mortal(newSVpvs("${$/}"));
11637 if (!(obase->op_flags & OPf_KIDS))
11639 o = cUNOPx(obase)->op_first;
11645 /* if all except one arg are constant, or have no side-effects,
11646 * or are optimized away, then it's unambiguous */
11648 for (kid=o; kid; kid = kid->op_sibling) {
11650 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11651 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11652 || (kid->op_type == OP_PUSHMARK)
11656 if (o2) { /* more than one found */
11663 return find_uninit_var(o2, uninit_sv, match);
11665 /* scan all args */
11667 sv = find_uninit_var(o, uninit_sv, 1);
11679 =for apidoc report_uninit
11681 Print appropriate "Use of uninitialized variable" warning
11687 Perl_report_uninit(pTHX_ SV* uninit_sv)
11691 SV* varname = NULL;
11693 varname = find_uninit_var(PL_op, uninit_sv,0);
11695 sv_insert(varname, 0, 0, " ", 1);
11697 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11698 varname ? SvPV_nolen_const(varname) : "",
11699 " in ", OP_DESC(PL_op));
11702 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11708 * c-indentation-style: bsd
11709 * c-basic-offset: 4
11710 * indent-tabs-mode: t
11713 * ex: set ts=8 sts=4 sw=4 noet: