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))
975 #define del_body_type(p, sv_type) \
976 del_body(p, &PL_body_roots[sv_type])
979 #define new_body_allocated(sv_type) \
980 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
981 - bodies_by_type[sv_type].offset)
983 #define del_body_allocated(p, sv_type) \
984 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
987 #define my_safemalloc(s) (void*)safemalloc(s)
988 #define my_safecalloc(s) (void*)safecalloc(s, 1)
989 #define my_safefree(p) safefree((char*)p)
993 #define new_XNV() my_safemalloc(sizeof(XPVNV))
994 #define del_XNV(p) my_safefree(p)
996 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
997 #define del_XPVNV(p) my_safefree(p)
999 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1000 #define del_XPVAV(p) my_safefree(p)
1002 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1003 #define del_XPVHV(p) my_safefree(p)
1005 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1006 #define del_XPVMG(p) my_safefree(p)
1008 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1009 #define del_XPVGV(p) my_safefree(p)
1013 #define new_XNV() new_body_type(SVt_NV)
1014 #define del_XNV(p) del_body_type(p, SVt_NV)
1016 #define new_XPVNV() new_body_type(SVt_PVNV)
1017 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1019 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1020 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1022 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1023 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1025 #define new_XPVMG() new_body_type(SVt_PVMG)
1026 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1028 #define new_XPVGV() new_body_type(SVt_PVGV)
1029 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1033 /* no arena for you! */
1035 #define new_NOARENA(details) \
1036 my_safemalloc((details)->size + (details)->offset)
1037 #define new_NOARENAZ(details) \
1038 my_safecalloc((details)->size + (details)->offset)
1041 =for apidoc sv_upgrade
1043 Upgrade an SV to a more complex form. Generally adds a new body type to the
1044 SV, then copies across as much information as possible from the old body.
1045 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1051 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1056 const U32 old_type = SvTYPE(sv);
1057 const struct body_details *const old_type_details
1058 = bodies_by_type + old_type;
1059 const struct body_details *new_type_details = bodies_by_type + new_type;
1061 if (new_type != SVt_PV && SvIsCOW(sv)) {
1062 sv_force_normal_flags(sv, 0);
1065 if (old_type == new_type)
1068 if (old_type > new_type)
1069 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1070 (int)old_type, (int)new_type);
1073 old_body = SvANY(sv);
1075 /* Copying structures onto other structures that have been neatly zeroed
1076 has a subtle gotcha. Consider XPVMG
1078 +------+------+------+------+------+-------+-------+
1079 | NV | CUR | LEN | IV | MAGIC | STASH |
1080 +------+------+------+------+------+-------+-------+
1081 0 4 8 12 16 20 24 28
1083 where NVs are aligned to 8 bytes, so that sizeof that structure is
1084 actually 32 bytes long, with 4 bytes of padding at the end:
1086 +------+------+------+------+------+-------+-------+------+
1087 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1088 +------+------+------+------+------+-------+-------+------+
1089 0 4 8 12 16 20 24 28 32
1091 so what happens if you allocate memory for this structure:
1093 +------+------+------+------+------+-------+-------+------+------+...
1094 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1095 +------+------+------+------+------+-------+-------+------+------+...
1096 0 4 8 12 16 20 24 28 32 36
1098 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1099 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1100 started out as zero once, but it's quite possible that it isn't. So now,
1101 rather than a nicely zeroed GP, you have it pointing somewhere random.
1104 (In fact, GP ends up pointing at a previous GP structure, because the
1105 principle cause of the padding in XPVMG getting garbage is a copy of
1106 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1108 So we are careful and work out the size of used parts of all the
1115 if (new_type < SVt_PVIV) {
1116 new_type = (new_type == SVt_NV)
1117 ? SVt_PVNV : SVt_PVIV;
1118 new_type_details = bodies_by_type + new_type;
1122 if (new_type < SVt_PVNV) {
1123 new_type = SVt_PVNV;
1124 new_type_details = bodies_by_type + new_type;
1130 assert(new_type > SVt_PV);
1131 assert(SVt_IV < SVt_PV);
1132 assert(SVt_NV < SVt_PV);
1139 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1140 there's no way that it can be safely upgraded, because perl.c
1141 expects to Safefree(SvANY(PL_mess_sv)) */
1142 assert(sv != PL_mess_sv);
1143 /* This flag bit is used to mean other things in other scalar types.
1144 Given that it only has meaning inside the pad, it shouldn't be set
1145 on anything that can get upgraded. */
1146 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1149 if (old_type_details->cant_upgrade)
1150 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1153 SvFLAGS(sv) &= ~SVTYPEMASK;
1154 SvFLAGS(sv) |= new_type;
1156 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1157 the return statements above will have triggered. */
1158 assert (new_type != SVt_NULL);
1161 assert(old_type == SVt_NULL);
1162 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1166 assert(old_type == SVt_NULL);
1167 SvANY(sv) = new_XNV();
1171 assert(old_type == SVt_NULL);
1172 SvANY(sv) = &sv->sv_u.svu_rv;
1177 assert(new_type_details->size);
1180 assert(new_type_details->arena);
1181 /* This points to the start of the allocated area. */
1182 new_body_inline(new_body, new_type_details->size, new_type);
1183 Zero(new_body, new_type_details->size, char);
1184 new_body = ((char *)new_body) - new_type_details->offset;
1186 /* We always allocated the full length item with PURIFY. To do this
1187 we fake things so that arena is false for all 16 types.. */
1188 new_body = new_NOARENAZ(new_type_details);
1190 SvANY(sv) = new_body;
1191 if (new_type == SVt_PVAV) {
1197 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1198 The target created by newSVrv also is, and it can have magic.
1199 However, it never has SvPVX set.
1201 if (old_type >= SVt_RV) {
1202 assert(SvPVX_const(sv) == 0);
1205 /* Could put this in the else clause below, as PVMG must have SvPVX
1206 0 already (the assertion above) */
1209 if (old_type >= SVt_PVMG) {
1210 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1211 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1217 /* XXX Is this still needed? Was it ever needed? Surely as there is
1218 no route from NV to PVIV, NOK can never be true */
1219 assert(!SvNOKp(sv));
1231 assert(new_type_details->size);
1232 /* We always allocated the full length item with PURIFY. To do this
1233 we fake things so that arena is false for all 16 types.. */
1234 if(new_type_details->arena) {
1235 /* This points to the start of the allocated area. */
1236 new_body_inline(new_body, new_type_details->size, new_type);
1237 Zero(new_body, new_type_details->size, char);
1238 new_body = ((char *)new_body) - new_type_details->offset;
1240 new_body = new_NOARENAZ(new_type_details);
1242 SvANY(sv) = new_body;
1244 if (old_type_details->copy) {
1245 Copy((char *)old_body + old_type_details->offset,
1246 (char *)new_body + old_type_details->offset,
1247 old_type_details->copy, char);
1250 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1251 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1252 * correct 0.0 for us. Otherwise, if the old body didn't have an
1253 * NV slot, but the new one does, then we need to initialise the
1254 * freshly created NV slot with whatever the correct bit pattern is
1256 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1260 if (new_type == SVt_PVIO)
1261 IoPAGE_LEN(sv) = 60;
1262 if (old_type < SVt_RV)
1266 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1267 (unsigned long)new_type);
1270 if (old_type_details->size) {
1271 /* If the old body had an allocated size, then we need to free it. */
1273 my_safefree(old_body);
1275 del_body((void*)((char*)old_body + old_type_details->offset),
1276 &PL_body_roots[old_type]);
1282 =for apidoc sv_backoff
1284 Remove any string offset. You should normally use the C<SvOOK_off> macro
1291 Perl_sv_backoff(pTHX_ register SV *sv)
1294 assert(SvTYPE(sv) != SVt_PVHV);
1295 assert(SvTYPE(sv) != SVt_PVAV);
1297 const char * const s = SvPVX_const(sv);
1298 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1299 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1301 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1303 SvFLAGS(sv) &= ~SVf_OOK;
1310 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1311 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1312 Use the C<SvGROW> wrapper instead.
1318 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1322 #ifdef HAS_64K_LIMIT
1323 if (newlen >= 0x10000) {
1324 PerlIO_printf(Perl_debug_log,
1325 "Allocation too large: %"UVxf"\n", (UV)newlen);
1328 #endif /* HAS_64K_LIMIT */
1331 if (SvTYPE(sv) < SVt_PV) {
1332 sv_upgrade(sv, SVt_PV);
1333 s = SvPVX_mutable(sv);
1335 else if (SvOOK(sv)) { /* pv is offset? */
1337 s = SvPVX_mutable(sv);
1338 if (newlen > SvLEN(sv))
1339 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1340 #ifdef HAS_64K_LIMIT
1341 if (newlen >= 0x10000)
1346 s = SvPVX_mutable(sv);
1348 if (newlen > SvLEN(sv)) { /* need more room? */
1349 newlen = PERL_STRLEN_ROUNDUP(newlen);
1350 if (SvLEN(sv) && s) {
1352 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1358 s = saferealloc(s, newlen);
1361 s = safemalloc(newlen);
1362 if (SvPVX_const(sv) && SvCUR(sv)) {
1363 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1367 SvLEN_set(sv, newlen);
1373 =for apidoc sv_setiv
1375 Copies an integer into the given SV, upgrading first if necessary.
1376 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1382 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1385 SV_CHECK_THINKFIRST_COW_DROP(sv);
1386 switch (SvTYPE(sv)) {
1388 sv_upgrade(sv, SVt_IV);
1391 sv_upgrade(sv, SVt_PVNV);
1395 sv_upgrade(sv, SVt_PVIV);
1404 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1407 (void)SvIOK_only(sv); /* validate number */
1413 =for apidoc sv_setiv_mg
1415 Like C<sv_setiv>, but also handles 'set' magic.
1421 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1428 =for apidoc sv_setuv
1430 Copies an unsigned integer into the given SV, upgrading first if necessary.
1431 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1437 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1439 /* With these two if statements:
1440 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1443 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1445 If you wish to remove them, please benchmark to see what the effect is
1447 if (u <= (UV)IV_MAX) {
1448 sv_setiv(sv, (IV)u);
1457 =for apidoc sv_setuv_mg
1459 Like C<sv_setuv>, but also handles 'set' magic.
1465 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1474 =for apidoc sv_setnv
1476 Copies a double into the given SV, upgrading first if necessary.
1477 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1483 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1486 SV_CHECK_THINKFIRST_COW_DROP(sv);
1487 switch (SvTYPE(sv)) {
1490 sv_upgrade(sv, SVt_NV);
1495 sv_upgrade(sv, SVt_PVNV);
1504 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1508 (void)SvNOK_only(sv); /* validate number */
1513 =for apidoc sv_setnv_mg
1515 Like C<sv_setnv>, but also handles 'set' magic.
1521 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1527 /* Print an "isn't numeric" warning, using a cleaned-up,
1528 * printable version of the offending string
1532 S_not_a_number(pTHX_ SV *sv)
1540 dsv = sv_2mortal(newSVpvs(""));
1541 pv = sv_uni_display(dsv, sv, 10, 0);
1544 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1545 /* each *s can expand to 4 chars + "...\0",
1546 i.e. need room for 8 chars */
1548 const char *s = SvPVX_const(sv);
1549 const char * const end = s + SvCUR(sv);
1550 for ( ; s < end && d < limit; s++ ) {
1552 if (ch & 128 && !isPRINT_LC(ch)) {
1561 else if (ch == '\r') {
1565 else if (ch == '\f') {
1569 else if (ch == '\\') {
1573 else if (ch == '\0') {
1577 else if (isPRINT_LC(ch))
1594 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1595 "Argument \"%s\" isn't numeric in %s", pv,
1598 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1599 "Argument \"%s\" isn't numeric", pv);
1603 =for apidoc looks_like_number
1605 Test if the content of an SV looks like a number (or is a number).
1606 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1607 non-numeric warning), even if your atof() doesn't grok them.
1613 Perl_looks_like_number(pTHX_ SV *sv)
1615 register const char *sbegin;
1619 sbegin = SvPVX_const(sv);
1622 else if (SvPOKp(sv))
1623 sbegin = SvPV_const(sv, len);
1625 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1626 return grok_number(sbegin, len, NULL);
1629 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1630 until proven guilty, assume that things are not that bad... */
1635 As 64 bit platforms often have an NV that doesn't preserve all bits of
1636 an IV (an assumption perl has been based on to date) it becomes necessary
1637 to remove the assumption that the NV always carries enough precision to
1638 recreate the IV whenever needed, and that the NV is the canonical form.
1639 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1640 precision as a side effect of conversion (which would lead to insanity
1641 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1642 1) to distinguish between IV/UV/NV slots that have cached a valid
1643 conversion where precision was lost and IV/UV/NV slots that have a
1644 valid conversion which has lost no precision
1645 2) to ensure that if a numeric conversion to one form is requested that
1646 would lose precision, the precise conversion (or differently
1647 imprecise conversion) is also performed and cached, to prevent
1648 requests for different numeric formats on the same SV causing
1649 lossy conversion chains. (lossless conversion chains are perfectly
1654 SvIOKp is true if the IV slot contains a valid value
1655 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1656 SvNOKp is true if the NV slot contains a valid value
1657 SvNOK is true only if the NV value is accurate
1660 while converting from PV to NV, check to see if converting that NV to an
1661 IV(or UV) would lose accuracy over a direct conversion from PV to
1662 IV(or UV). If it would, cache both conversions, return NV, but mark
1663 SV as IOK NOKp (ie not NOK).
1665 While converting from PV to IV, check to see if converting that IV to an
1666 NV would lose accuracy over a direct conversion from PV to NV. If it
1667 would, cache both conversions, flag similarly.
1669 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1670 correctly because if IV & NV were set NV *always* overruled.
1671 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1672 changes - now IV and NV together means that the two are interchangeable:
1673 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1675 The benefit of this is that operations such as pp_add know that if
1676 SvIOK is true for both left and right operands, then integer addition
1677 can be used instead of floating point (for cases where the result won't
1678 overflow). Before, floating point was always used, which could lead to
1679 loss of precision compared with integer addition.
1681 * making IV and NV equal status should make maths accurate on 64 bit
1683 * may speed up maths somewhat if pp_add and friends start to use
1684 integers when possible instead of fp. (Hopefully the overhead in
1685 looking for SvIOK and checking for overflow will not outweigh the
1686 fp to integer speedup)
1687 * will slow down integer operations (callers of SvIV) on "inaccurate"
1688 values, as the change from SvIOK to SvIOKp will cause a call into
1689 sv_2iv each time rather than a macro access direct to the IV slot
1690 * should speed up number->string conversion on integers as IV is
1691 favoured when IV and NV are equally accurate
1693 ####################################################################
1694 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1695 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1696 On the other hand, SvUOK is true iff UV.
1697 ####################################################################
1699 Your mileage will vary depending your CPU's relative fp to integer
1703 #ifndef NV_PRESERVES_UV
1704 # define IS_NUMBER_UNDERFLOW_IV 1
1705 # define IS_NUMBER_UNDERFLOW_UV 2
1706 # define IS_NUMBER_IV_AND_UV 2
1707 # define IS_NUMBER_OVERFLOW_IV 4
1708 # define IS_NUMBER_OVERFLOW_UV 5
1710 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1712 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1714 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1717 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));
1718 if (SvNVX(sv) < (NV)IV_MIN) {
1719 (void)SvIOKp_on(sv);
1721 SvIV_set(sv, IV_MIN);
1722 return IS_NUMBER_UNDERFLOW_IV;
1724 if (SvNVX(sv) > (NV)UV_MAX) {
1725 (void)SvIOKp_on(sv);
1728 SvUV_set(sv, UV_MAX);
1729 return IS_NUMBER_OVERFLOW_UV;
1731 (void)SvIOKp_on(sv);
1733 /* Can't use strtol etc to convert this string. (See truth table in
1735 if (SvNVX(sv) <= (UV)IV_MAX) {
1736 SvIV_set(sv, I_V(SvNVX(sv)));
1737 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1738 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1740 /* Integer is imprecise. NOK, IOKp */
1742 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1745 SvUV_set(sv, U_V(SvNVX(sv)));
1746 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1747 if (SvUVX(sv) == UV_MAX) {
1748 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1749 possibly be preserved by NV. Hence, it must be overflow.
1751 return IS_NUMBER_OVERFLOW_UV;
1753 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1755 /* Integer is imprecise. NOK, IOKp */
1757 return IS_NUMBER_OVERFLOW_IV;
1759 #endif /* !NV_PRESERVES_UV*/
1762 S_sv_2iuv_common(pTHX_ SV *sv) {
1765 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1766 * without also getting a cached IV/UV from it at the same time
1767 * (ie PV->NV conversion should detect loss of accuracy and cache
1768 * IV or UV at same time to avoid this. */
1769 /* IV-over-UV optimisation - choose to cache IV if possible */
1771 if (SvTYPE(sv) == SVt_NV)
1772 sv_upgrade(sv, SVt_PVNV);
1774 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1775 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1776 certainly cast into the IV range at IV_MAX, whereas the correct
1777 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1779 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1780 SvIV_set(sv, I_V(SvNVX(sv)));
1781 if (SvNVX(sv) == (NV) SvIVX(sv)
1782 #ifndef NV_PRESERVES_UV
1783 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1784 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1785 /* Don't flag it as "accurately an integer" if the number
1786 came from a (by definition imprecise) NV operation, and
1787 we're outside the range of NV integer precision */
1790 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1791 DEBUG_c(PerlIO_printf(Perl_debug_log,
1792 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1798 /* IV not precise. No need to convert from PV, as NV
1799 conversion would already have cached IV if it detected
1800 that PV->IV would be better than PV->NV->IV
1801 flags already correct - don't set public IOK. */
1802 DEBUG_c(PerlIO_printf(Perl_debug_log,
1803 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1808 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1809 but the cast (NV)IV_MIN rounds to a the value less (more
1810 negative) than IV_MIN which happens to be equal to SvNVX ??
1811 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1812 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1813 (NV)UVX == NVX are both true, but the values differ. :-(
1814 Hopefully for 2s complement IV_MIN is something like
1815 0x8000000000000000 which will be exact. NWC */
1818 SvUV_set(sv, U_V(SvNVX(sv)));
1820 (SvNVX(sv) == (NV) SvUVX(sv))
1821 #ifndef NV_PRESERVES_UV
1822 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1823 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1824 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1825 /* Don't flag it as "accurately an integer" if the number
1826 came from a (by definition imprecise) NV operation, and
1827 we're outside the range of NV integer precision */
1832 DEBUG_c(PerlIO_printf(Perl_debug_log,
1833 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1839 else if (SvPOKp(sv) && SvLEN(sv)) {
1841 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1842 /* We want to avoid a possible problem when we cache an IV/ a UV which
1843 may be later translated to an NV, and the resulting NV is not
1844 the same as the direct translation of the initial string
1845 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1846 be careful to ensure that the value with the .456 is around if the
1847 NV value is requested in the future).
1849 This means that if we cache such an IV/a UV, we need to cache the
1850 NV as well. Moreover, we trade speed for space, and do not
1851 cache the NV if we are sure it's not needed.
1854 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1855 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1856 == IS_NUMBER_IN_UV) {
1857 /* It's definitely an integer, only upgrade to PVIV */
1858 if (SvTYPE(sv) < SVt_PVIV)
1859 sv_upgrade(sv, SVt_PVIV);
1861 } else if (SvTYPE(sv) < SVt_PVNV)
1862 sv_upgrade(sv, SVt_PVNV);
1864 /* If NVs preserve UVs then we only use the UV value if we know that
1865 we aren't going to call atof() below. If NVs don't preserve UVs
1866 then the value returned may have more precision than atof() will
1867 return, even though value isn't perfectly accurate. */
1868 if ((numtype & (IS_NUMBER_IN_UV
1869 #ifdef NV_PRESERVES_UV
1872 )) == IS_NUMBER_IN_UV) {
1873 /* This won't turn off the public IOK flag if it was set above */
1874 (void)SvIOKp_on(sv);
1876 if (!(numtype & IS_NUMBER_NEG)) {
1878 if (value <= (UV)IV_MAX) {
1879 SvIV_set(sv, (IV)value);
1881 /* it didn't overflow, and it was positive. */
1882 SvUV_set(sv, value);
1886 /* 2s complement assumption */
1887 if (value <= (UV)IV_MIN) {
1888 SvIV_set(sv, -(IV)value);
1890 /* Too negative for an IV. This is a double upgrade, but
1891 I'm assuming it will be rare. */
1892 if (SvTYPE(sv) < SVt_PVNV)
1893 sv_upgrade(sv, SVt_PVNV);
1897 SvNV_set(sv, -(NV)value);
1898 SvIV_set(sv, IV_MIN);
1902 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1903 will be in the previous block to set the IV slot, and the next
1904 block to set the NV slot. So no else here. */
1906 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1907 != IS_NUMBER_IN_UV) {
1908 /* It wasn't an (integer that doesn't overflow the UV). */
1909 SvNV_set(sv, Atof(SvPVX_const(sv)));
1911 if (! numtype && ckWARN(WARN_NUMERIC))
1914 #if defined(USE_LONG_DOUBLE)
1915 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1916 PTR2UV(sv), SvNVX(sv)));
1918 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1919 PTR2UV(sv), SvNVX(sv)));
1922 #ifdef NV_PRESERVES_UV
1923 (void)SvIOKp_on(sv);
1925 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1926 SvIV_set(sv, I_V(SvNVX(sv)));
1927 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1930 /* Integer is imprecise. NOK, IOKp */
1932 /* UV will not work better than IV */
1934 if (SvNVX(sv) > (NV)UV_MAX) {
1936 /* Integer is inaccurate. NOK, IOKp, is UV */
1937 SvUV_set(sv, UV_MAX);
1939 SvUV_set(sv, U_V(SvNVX(sv)));
1940 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1941 NV preservse UV so can do correct comparison. */
1942 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1945 /* Integer is imprecise. NOK, IOKp, is UV */
1950 #else /* NV_PRESERVES_UV */
1951 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1952 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1953 /* The IV/UV slot will have been set from value returned by
1954 grok_number above. The NV slot has just been set using
1957 assert (SvIOKp(sv));
1959 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1960 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1961 /* Small enough to preserve all bits. */
1962 (void)SvIOKp_on(sv);
1964 SvIV_set(sv, I_V(SvNVX(sv)));
1965 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1967 /* Assumption: first non-preserved integer is < IV_MAX,
1968 this NV is in the preserved range, therefore: */
1969 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1971 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);
1975 0 0 already failed to read UV.
1976 0 1 already failed to read UV.
1977 1 0 you won't get here in this case. IV/UV
1978 slot set, public IOK, Atof() unneeded.
1979 1 1 already read UV.
1980 so there's no point in sv_2iuv_non_preserve() attempting
1981 to use atol, strtol, strtoul etc. */
1982 sv_2iuv_non_preserve (sv, numtype);
1985 #endif /* NV_PRESERVES_UV */
1989 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1990 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1993 if (SvTYPE(sv) < SVt_IV)
1994 /* Typically the caller expects that sv_any is not NULL now. */
1995 sv_upgrade(sv, SVt_IV);
1996 /* Return 0 from the caller. */
2003 =for apidoc sv_2iv_flags
2005 Return the integer value of an SV, doing any necessary string
2006 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2007 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2013 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2018 if (SvGMAGICAL(sv)) {
2019 if (flags & SV_GMAGIC)
2024 return I_V(SvNVX(sv));
2026 if (SvPOKp(sv) && SvLEN(sv)) {
2029 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2031 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2032 == IS_NUMBER_IN_UV) {
2033 /* It's definitely an integer */
2034 if (numtype & IS_NUMBER_NEG) {
2035 if (value < (UV)IV_MIN)
2038 if (value < (UV)IV_MAX)
2043 if (ckWARN(WARN_NUMERIC))
2046 return I_V(Atof(SvPVX_const(sv)));
2051 assert(SvTYPE(sv) >= SVt_PVMG);
2052 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2053 } else if (SvTHINKFIRST(sv)) {
2057 SV * const tmpstr=AMG_CALLun(sv,numer);
2058 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2059 return SvIV(tmpstr);
2062 return PTR2IV(SvRV(sv));
2065 sv_force_normal_flags(sv, 0);
2067 if (SvREADONLY(sv) && !SvOK(sv)) {
2068 if (ckWARN(WARN_UNINITIALIZED))
2074 if (S_sv_2iuv_common(aTHX_ sv))
2077 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2078 PTR2UV(sv),SvIVX(sv)));
2079 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2083 =for apidoc sv_2uv_flags
2085 Return the unsigned integer value of an SV, doing any necessary string
2086 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2087 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2093 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2098 if (SvGMAGICAL(sv)) {
2099 if (flags & SV_GMAGIC)
2104 return U_V(SvNVX(sv));
2105 if (SvPOKp(sv) && SvLEN(sv)) {
2108 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2110 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2111 == IS_NUMBER_IN_UV) {
2112 /* It's definitely an integer */
2113 if (!(numtype & IS_NUMBER_NEG))
2117 if (ckWARN(WARN_NUMERIC))
2120 return U_V(Atof(SvPVX_const(sv)));
2125 assert(SvTYPE(sv) >= SVt_PVMG);
2126 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2127 } else if (SvTHINKFIRST(sv)) {
2131 SV *const tmpstr = AMG_CALLun(sv,numer);
2132 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2133 return SvUV(tmpstr);
2136 return PTR2UV(SvRV(sv));
2139 sv_force_normal_flags(sv, 0);
2141 if (SvREADONLY(sv) && !SvOK(sv)) {
2142 if (ckWARN(WARN_UNINITIALIZED))
2148 if (S_sv_2iuv_common(aTHX_ sv))
2152 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2153 PTR2UV(sv),SvUVX(sv)));
2154 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2160 Return the num value of an SV, doing any necessary string or integer
2161 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2168 Perl_sv_2nv(pTHX_ register SV *sv)
2173 if (SvGMAGICAL(sv)) {
2177 if (SvPOKp(sv) && SvLEN(sv)) {
2178 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2179 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2181 return Atof(SvPVX_const(sv));
2185 return (NV)SvUVX(sv);
2187 return (NV)SvIVX(sv);
2192 assert(SvTYPE(sv) >= SVt_PVMG);
2193 /* This falls through to the report_uninit near the end of the
2195 } else if (SvTHINKFIRST(sv)) {
2199 SV *const tmpstr = AMG_CALLun(sv,numer);
2200 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2201 return SvNV(tmpstr);
2204 return PTR2NV(SvRV(sv));
2207 sv_force_normal_flags(sv, 0);
2209 if (SvREADONLY(sv) && !SvOK(sv)) {
2210 if (ckWARN(WARN_UNINITIALIZED))
2215 if (SvTYPE(sv) < SVt_NV) {
2216 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2217 sv_upgrade(sv, SVt_NV);
2218 #ifdef USE_LONG_DOUBLE
2220 STORE_NUMERIC_LOCAL_SET_STANDARD();
2221 PerlIO_printf(Perl_debug_log,
2222 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2223 PTR2UV(sv), SvNVX(sv));
2224 RESTORE_NUMERIC_LOCAL();
2228 STORE_NUMERIC_LOCAL_SET_STANDARD();
2229 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2230 PTR2UV(sv), SvNVX(sv));
2231 RESTORE_NUMERIC_LOCAL();
2235 else if (SvTYPE(sv) < SVt_PVNV)
2236 sv_upgrade(sv, SVt_PVNV);
2241 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2242 #ifdef NV_PRESERVES_UV
2245 /* Only set the public NV OK flag if this NV preserves the IV */
2246 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2247 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2248 : (SvIVX(sv) == I_V(SvNVX(sv))))
2254 else if (SvPOKp(sv) && SvLEN(sv)) {
2256 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2257 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2259 #ifdef NV_PRESERVES_UV
2260 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2261 == IS_NUMBER_IN_UV) {
2262 /* It's definitely an integer */
2263 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2265 SvNV_set(sv, Atof(SvPVX_const(sv)));
2268 SvNV_set(sv, Atof(SvPVX_const(sv)));
2269 /* Only set the public NV OK flag if this NV preserves the value in
2270 the PV at least as well as an IV/UV would.
2271 Not sure how to do this 100% reliably. */
2272 /* if that shift count is out of range then Configure's test is
2273 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2275 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2276 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2277 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2278 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2279 /* Can't use strtol etc to convert this string, so don't try.
2280 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2283 /* value has been set. It may not be precise. */
2284 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2285 /* 2s complement assumption for (UV)IV_MIN */
2286 SvNOK_on(sv); /* Integer is too negative. */
2291 if (numtype & IS_NUMBER_NEG) {
2292 SvIV_set(sv, -(IV)value);
2293 } else if (value <= (UV)IV_MAX) {
2294 SvIV_set(sv, (IV)value);
2296 SvUV_set(sv, value);
2300 if (numtype & IS_NUMBER_NOT_INT) {
2301 /* I believe that even if the original PV had decimals,
2302 they are lost beyond the limit of the FP precision.
2303 However, neither is canonical, so both only get p
2304 flags. NWC, 2000/11/25 */
2305 /* Both already have p flags, so do nothing */
2307 const NV nv = SvNVX(sv);
2308 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2309 if (SvIVX(sv) == I_V(nv)) {
2312 /* It had no "." so it must be integer. */
2316 /* between IV_MAX and NV(UV_MAX).
2317 Could be slightly > UV_MAX */
2319 if (numtype & IS_NUMBER_NOT_INT) {
2320 /* UV and NV both imprecise. */
2322 const UV nv_as_uv = U_V(nv);
2324 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2333 #endif /* NV_PRESERVES_UV */
2336 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2338 assert (SvTYPE(sv) >= SVt_NV);
2339 /* Typically the caller expects that sv_any is not NULL now. */
2340 /* XXX Ilya implies that this is a bug in callers that assume this
2341 and ideally should be fixed. */
2344 #if defined(USE_LONG_DOUBLE)
2346 STORE_NUMERIC_LOCAL_SET_STANDARD();
2347 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2348 PTR2UV(sv), SvNVX(sv));
2349 RESTORE_NUMERIC_LOCAL();
2353 STORE_NUMERIC_LOCAL_SET_STANDARD();
2354 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2355 PTR2UV(sv), SvNVX(sv));
2356 RESTORE_NUMERIC_LOCAL();
2362 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2363 * UV as a string towards the end of buf, and return pointers to start and
2366 * We assume that buf is at least TYPE_CHARS(UV) long.
2370 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2372 char *ptr = buf + TYPE_CHARS(UV);
2373 char * const ebuf = ptr;
2386 *--ptr = '0' + (char)(uv % 10);
2394 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2395 * a regexp to its stringified form.
2399 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2401 const regexp * const re = (regexp *)mg->mg_obj;
2404 const char *fptr = "msix";
2409 bool need_newline = 0;
2410 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2412 while((ch = *fptr++)) {
2414 reflags[left++] = ch;
2417 reflags[right--] = ch;
2422 reflags[left] = '-';
2426 mg->mg_len = re->prelen + 4 + left;
2428 * If /x was used, we have to worry about a regex ending with a
2429 * comment later being embedded within another regex. If so, we don't
2430 * want this regex's "commentization" to leak out to the right part of
2431 * the enclosing regex, we must cap it with a newline.
2433 * So, if /x was used, we scan backwards from the end of the regex. If
2434 * we find a '#' before we find a newline, we need to add a newline
2435 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2436 * we don't need to add anything. -jfriedl
2438 if (PMf_EXTENDED & re->reganch) {
2439 const char *endptr = re->precomp + re->prelen;
2440 while (endptr >= re->precomp) {
2441 const char c = *(endptr--);
2443 break; /* don't need another */
2445 /* we end while in a comment, so we need a newline */
2446 mg->mg_len++; /* save space for it */
2447 need_newline = 1; /* note to add it */
2453 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2454 mg->mg_ptr[0] = '(';
2455 mg->mg_ptr[1] = '?';
2456 Copy(reflags, mg->mg_ptr+2, left, char);
2457 *(mg->mg_ptr+left+2) = ':';
2458 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2460 mg->mg_ptr[mg->mg_len - 2] = '\n';
2461 mg->mg_ptr[mg->mg_len - 1] = ')';
2462 mg->mg_ptr[mg->mg_len] = 0;
2464 PL_reginterp_cnt += re->program[0].next_off;
2466 if (re->reganch & ROPT_UTF8)
2476 =for apidoc sv_2pv_flags
2478 Returns a pointer to the string value of an SV, and sets *lp to its length.
2479 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2481 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2482 usually end up here too.
2488 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2498 if (SvGMAGICAL(sv)) {
2499 if (flags & SV_GMAGIC)
2504 if (flags & SV_MUTABLE_RETURN)
2505 return SvPVX_mutable(sv);
2506 if (flags & SV_CONST_RETURN)
2507 return (char *)SvPVX_const(sv);
2510 if (SvIOKp(sv) || SvNOKp(sv)) {
2511 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2515 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2516 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2518 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2521 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2522 /* Sneaky stuff here */
2523 SV * const tsv = newSVpvn(tbuf, len);
2533 #ifdef FIXNEGATIVEZERO
2534 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2540 SvUPGRADE(sv, SVt_PV);
2543 s = SvGROW_mutable(sv, len + 1);
2546 return memcpy(s, tbuf, len + 1);
2552 assert(SvTYPE(sv) >= SVt_PVMG);
2553 /* This falls through to the report_uninit near the end of the
2555 } else if (SvTHINKFIRST(sv)) {
2559 SV *const tmpstr = AMG_CALLun(sv,string);
2560 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2562 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2566 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2567 if (flags & SV_CONST_RETURN) {
2568 pv = (char *) SvPVX_const(tmpstr);
2570 pv = (flags & SV_MUTABLE_RETURN)
2571 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2574 *lp = SvCUR(tmpstr);
2576 pv = sv_2pv_flags(tmpstr, lp, flags);
2588 const SV *const referent = (SV*)SvRV(sv);
2591 tsv = sv_2mortal(newSVpvs("NULLREF"));
2592 } else if (SvTYPE(referent) == SVt_PVMG
2593 && ((SvFLAGS(referent) &
2594 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2595 == (SVs_OBJECT|SVs_SMG))
2596 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2597 return stringify_regexp(sv, mg, lp);
2599 const char *const typestr = sv_reftype(referent, 0);
2601 tsv = sv_newmortal();
2602 if (SvOBJECT(referent)) {
2603 const char *const name = HvNAME_get(SvSTASH(referent));
2604 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2605 name ? name : "__ANON__" , typestr,
2609 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2617 if (SvREADONLY(sv) && !SvOK(sv)) {
2618 if (ckWARN(WARN_UNINITIALIZED))
2625 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2626 /* I'm assuming that if both IV and NV are equally valid then
2627 converting the IV is going to be more efficient */
2628 const U32 isIOK = SvIOK(sv);
2629 const U32 isUIOK = SvIsUV(sv);
2630 char buf[TYPE_CHARS(UV)];
2633 if (SvTYPE(sv) < SVt_PVIV)
2634 sv_upgrade(sv, SVt_PVIV);
2635 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2636 /* inlined from sv_setpvn */
2637 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2638 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2639 SvCUR_set(sv, ebuf - ptr);
2649 else if (SvNOKp(sv)) {
2650 const int olderrno = errno;
2651 if (SvTYPE(sv) < SVt_PVNV)
2652 sv_upgrade(sv, SVt_PVNV);
2653 /* The +20 is pure guesswork. Configure test needed. --jhi */
2654 s = SvGROW_mutable(sv, NV_DIG + 20);
2655 /* some Xenix systems wipe out errno here */
2657 if (SvNVX(sv) == 0.0)
2658 (void)strcpy(s,"0");
2662 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2665 #ifdef FIXNEGATIVEZERO
2666 if (*s == '-' && s[1] == '0' && !s[2])
2676 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2680 if (SvTYPE(sv) < SVt_PV)
2681 /* Typically the caller expects that sv_any is not NULL now. */
2682 sv_upgrade(sv, SVt_PV);
2686 const STRLEN len = s - SvPVX_const(sv);
2692 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2693 PTR2UV(sv),SvPVX_const(sv)));
2694 if (flags & SV_CONST_RETURN)
2695 return (char *)SvPVX_const(sv);
2696 if (flags & SV_MUTABLE_RETURN)
2697 return SvPVX_mutable(sv);
2702 =for apidoc sv_copypv
2704 Copies a stringified representation of the source SV into the
2705 destination SV. Automatically performs any necessary mg_get and
2706 coercion of numeric values into strings. Guaranteed to preserve
2707 UTF-8 flag even from overloaded objects. Similar in nature to
2708 sv_2pv[_flags] but operates directly on an SV instead of just the
2709 string. Mostly uses sv_2pv_flags to do its work, except when that
2710 would lose the UTF-8'ness of the PV.
2716 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2719 const char * const s = SvPV_const(ssv,len);
2720 sv_setpvn(dsv,s,len);
2728 =for apidoc sv_2pvbyte
2730 Return a pointer to the byte-encoded representation of the SV, and set *lp
2731 to its length. May cause the SV to be downgraded from UTF-8 as a
2734 Usually accessed via the C<SvPVbyte> macro.
2740 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2742 sv_utf8_downgrade(sv,0);
2743 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2747 =for apidoc sv_2pvutf8
2749 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2750 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2752 Usually accessed via the C<SvPVutf8> macro.
2758 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2760 sv_utf8_upgrade(sv);
2761 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2766 =for apidoc sv_2bool
2768 This function is only called on magical items, and is only used by
2769 sv_true() or its macro equivalent.
2775 Perl_sv_2bool(pTHX_ register SV *sv)
2784 SV * const tmpsv = AMG_CALLun(sv,bool_);
2785 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2786 return (bool)SvTRUE(tmpsv);
2788 return SvRV(sv) != 0;
2791 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2793 (*sv->sv_u.svu_pv > '0' ||
2794 Xpvtmp->xpv_cur > 1 ||
2795 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2802 return SvIVX(sv) != 0;
2805 return SvNVX(sv) != 0.0;
2813 =for apidoc sv_utf8_upgrade
2815 Converts the PV of an SV to its UTF-8-encoded form.
2816 Forces the SV to string form if it is not already.
2817 Always sets the SvUTF8 flag to avoid future validity checks even
2818 if all the bytes have hibit clear.
2820 This is not as a general purpose byte encoding to Unicode interface:
2821 use the Encode extension for that.
2823 =for apidoc sv_utf8_upgrade_flags
2825 Converts the PV of an SV to its UTF-8-encoded form.
2826 Forces the SV to string form if it is not already.
2827 Always sets the SvUTF8 flag to avoid future validity checks even
2828 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2829 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2830 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2832 This is not as a general purpose byte encoding to Unicode interface:
2833 use the Encode extension for that.
2839 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2842 if (sv == &PL_sv_undef)
2846 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2847 (void) sv_2pv_flags(sv,&len, flags);
2851 (void) SvPV_force(sv,len);
2860 sv_force_normal_flags(sv, 0);
2863 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2864 sv_recode_to_utf8(sv, PL_encoding);
2865 else { /* Assume Latin-1/EBCDIC */
2866 /* This function could be much more efficient if we
2867 * had a FLAG in SVs to signal if there are any hibit
2868 * chars in the PV. Given that there isn't such a flag
2869 * make the loop as fast as possible. */
2870 const U8 * const s = (U8 *) SvPVX_const(sv);
2871 const U8 * const e = (U8 *) SvEND(sv);
2876 /* Check for hi bit */
2877 if (!NATIVE_IS_INVARIANT(ch)) {
2878 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2879 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2881 SvPV_free(sv); /* No longer using what was there before. */
2882 SvPV_set(sv, (char*)recoded);
2883 SvCUR_set(sv, len - 1);
2884 SvLEN_set(sv, len); /* No longer know the real size. */
2888 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2895 =for apidoc sv_utf8_downgrade
2897 Attempts to convert the PV of an SV from characters to bytes.
2898 If the PV contains a character beyond byte, this conversion will fail;
2899 in this case, either returns false or, if C<fail_ok> is not
2902 This is not as a general purpose Unicode to byte encoding interface:
2903 use the Encode extension for that.
2909 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2912 if (SvPOKp(sv) && SvUTF8(sv)) {
2918 sv_force_normal_flags(sv, 0);
2920 s = (U8 *) SvPV(sv, len);
2921 if (!utf8_to_bytes(s, &len)) {
2926 Perl_croak(aTHX_ "Wide character in %s",
2929 Perl_croak(aTHX_ "Wide character");
2940 =for apidoc sv_utf8_encode
2942 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2943 flag off so that it looks like octets again.
2949 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2951 (void) sv_utf8_upgrade(sv);
2953 sv_force_normal_flags(sv, 0);
2955 if (SvREADONLY(sv)) {
2956 Perl_croak(aTHX_ PL_no_modify);
2962 =for apidoc sv_utf8_decode
2964 If the PV of the SV is an octet sequence in UTF-8
2965 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2966 so that it looks like a character. If the PV contains only single-byte
2967 characters, the C<SvUTF8> flag stays being off.
2968 Scans PV for validity and returns false if the PV is invalid UTF-8.
2974 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2980 /* The octets may have got themselves encoded - get them back as
2983 if (!sv_utf8_downgrade(sv, TRUE))
2986 /* it is actually just a matter of turning the utf8 flag on, but
2987 * we want to make sure everything inside is valid utf8 first.
2989 c = (const U8 *) SvPVX_const(sv);
2990 if (!is_utf8_string(c, SvCUR(sv)+1))
2992 e = (const U8 *) SvEND(sv);
2995 if (!UTF8_IS_INVARIANT(ch)) {
3005 =for apidoc sv_setsv
3007 Copies the contents of the source SV C<ssv> into the destination SV
3008 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3009 function if the source SV needs to be reused. Does not handle 'set' magic.
3010 Loosely speaking, it performs a copy-by-value, obliterating any previous
3011 content of the destination.
3013 You probably want to use one of the assortment of wrappers, such as
3014 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3015 C<SvSetMagicSV_nosteal>.
3017 =for apidoc sv_setsv_flags
3019 Copies the contents of the source SV C<ssv> into the destination SV
3020 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3021 function if the source SV needs to be reused. Does not handle 'set' magic.
3022 Loosely speaking, it performs a copy-by-value, obliterating any previous
3023 content of the destination.
3024 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3025 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3026 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3027 and C<sv_setsv_nomg> are implemented in terms of this function.
3029 You probably want to use one of the assortment of wrappers, such as
3030 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3031 C<SvSetMagicSV_nosteal>.
3033 This is the primary function for copying scalars, and most other
3034 copy-ish functions and macros use this underneath.
3040 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
3042 if (dtype != SVt_PVGV) {
3043 const char * const name = GvNAME(sstr);
3044 const STRLEN len = GvNAMELEN(sstr);
3045 /* don't upgrade SVt_PVLV: it can hold a glob */
3046 if (dtype != SVt_PVLV)
3047 sv_upgrade(dstr, SVt_PVGV);
3048 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3049 GvSTASH(dstr) = GvSTASH(sstr);
3051 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3052 GvNAME(dstr) = savepvn(name, len);
3053 GvNAMELEN(dstr) = len;
3054 SvFAKE_on(dstr); /* can coerce to non-glob */
3057 #ifdef GV_UNIQUE_CHECK
3058 if (GvUNIQUE((GV*)dstr)) {
3059 Perl_croak(aTHX_ PL_no_modify);
3063 (void)SvOK_off(dstr);
3064 GvINTRO_off(dstr); /* one-shot flag */
3066 GvGP(dstr) = gp_ref(GvGP(sstr));
3067 if (SvTAINTED(sstr))
3069 if (GvIMPORTED(dstr) != GVf_IMPORTED
3070 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3072 GvIMPORTED_on(dstr);
3079 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
3080 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3082 const int intro = GvINTRO(dstr);
3084 #ifdef GV_UNIQUE_CHECK
3085 if (GvUNIQUE((GV*)dstr)) {
3086 Perl_croak(aTHX_ PL_no_modify);
3091 GvINTRO_off(dstr); /* one-shot flag */
3092 GvLINE(dstr) = CopLINE(PL_curcop);
3093 GvEGV(dstr) = (GV*)dstr;
3096 switch (SvTYPE(sref)) {
3099 SAVEGENERICSV(GvAV(dstr));
3101 dref = (SV*)GvAV(dstr);
3102 GvAV(dstr) = (AV*)sref;
3103 if (!GvIMPORTED_AV(dstr)
3104 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3106 GvIMPORTED_AV_on(dstr);
3111 SAVEGENERICSV(GvHV(dstr));
3113 dref = (SV*)GvHV(dstr);
3114 GvHV(dstr) = (HV*)sref;
3115 if (!GvIMPORTED_HV(dstr)
3116 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3118 GvIMPORTED_HV_on(dstr);
3123 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3124 SvREFCNT_dec(GvCV(dstr));
3126 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3127 PL_sub_generation++;
3129 SAVEGENERICSV(GvCV(dstr));
3132 dref = (SV*)GvCV(dstr);
3133 if (GvCV(dstr) != (CV*)sref) {
3134 CV* const cv = GvCV(dstr);
3136 if (!GvCVGEN((GV*)dstr) &&
3137 (CvROOT(cv) || CvXSUB(cv)))
3139 /* Redefining a sub - warning is mandatory if
3140 it was a const and its value changed. */
3141 if (CvCONST(cv) && CvCONST((CV*)sref)
3142 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3143 /* They are 2 constant subroutines generated from
3144 the same constant. This probably means that
3145 they are really the "same" proxy subroutine
3146 instantiated in 2 places. Most likely this is
3147 when a constant is exported twice. Don't warn.
3150 else if (ckWARN(WARN_REDEFINE)
3152 && (!CvCONST((CV*)sref)
3153 || sv_cmp(cv_const_sv(cv),
3154 cv_const_sv((CV*)sref))))) {
3155 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3157 ? "Constant subroutine %s::%s redefined"
3158 : "Subroutine %s::%s redefined",
3159 HvNAME_get(GvSTASH((GV*)dstr)),
3160 GvENAME((GV*)dstr));
3164 cv_ckproto(cv, (GV*)dstr,
3165 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3167 GvCV(dstr) = (CV*)sref;
3168 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3169 GvASSUMECV_on(dstr);
3170 PL_sub_generation++;
3172 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3173 GvIMPORTED_CV_on(dstr);
3178 SAVEGENERICSV(GvIOp(dstr));
3180 dref = (SV*)GvIOp(dstr);
3181 GvIOp(dstr) = (IO*)sref;
3185 SAVEGENERICSV(GvFORM(dstr));
3187 dref = (SV*)GvFORM(dstr);
3188 GvFORM(dstr) = (CV*)sref;
3192 SAVEGENERICSV(GvSV(dstr));
3194 dref = (SV*)GvSV(dstr);
3196 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3197 GvIMPORTED_SV_on(dstr);
3203 if (SvTAINTED(sstr))
3209 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3212 register U32 sflags;
3218 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3220 sstr = &PL_sv_undef;
3221 stype = SvTYPE(sstr);
3222 dtype = SvTYPE(dstr);
3227 /* need to nuke the magic */
3229 SvRMAGICAL_off(dstr);
3232 /* There's a lot of redundancy below but we're going for speed here */
3237 if (dtype != SVt_PVGV) {
3238 (void)SvOK_off(dstr);
3246 sv_upgrade(dstr, SVt_IV);
3249 sv_upgrade(dstr, SVt_PVNV);
3253 sv_upgrade(dstr, SVt_PVIV);
3256 (void)SvIOK_only(dstr);
3257 SvIV_set(dstr, SvIVX(sstr));
3260 /* SvTAINTED can only be true if the SV has taint magic, which in
3261 turn means that the SV type is PVMG (or greater). This is the
3262 case statement for SVt_IV, so this cannot be true (whatever gcov
3264 assert(!SvTAINTED(sstr));
3274 sv_upgrade(dstr, SVt_NV);
3279 sv_upgrade(dstr, SVt_PVNV);
3282 SvNV_set(dstr, SvNVX(sstr));
3283 (void)SvNOK_only(dstr);
3284 /* SvTAINTED can only be true if the SV has taint magic, which in
3285 turn means that the SV type is PVMG (or greater). This is the
3286 case statement for SVt_NV, so this cannot be true (whatever gcov
3288 assert(!SvTAINTED(sstr));
3295 sv_upgrade(dstr, SVt_RV);
3296 else if (dtype == SVt_PVGV &&
3297 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3300 if (GvIMPORTED(dstr) != GVf_IMPORTED
3301 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3303 GvIMPORTED_on(dstr);
3308 S_glob_assign(aTHX_ dstr, sstr, dtype);
3313 #ifdef PERL_OLD_COPY_ON_WRITE
3314 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3315 if (dtype < SVt_PVIV)
3316 sv_upgrade(dstr, SVt_PVIV);
3323 sv_upgrade(dstr, SVt_PV);
3326 if (dtype < SVt_PVIV)
3327 sv_upgrade(dstr, SVt_PVIV);
3330 if (dtype < SVt_PVNV)
3331 sv_upgrade(dstr, SVt_PVNV);
3338 const char * const type = sv_reftype(sstr,0);
3340 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3342 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3347 if (dtype <= SVt_PVGV) {
3348 S_glob_assign(aTHX_ dstr, sstr, dtype);
3354 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3356 if ((int)SvTYPE(sstr) != stype) {
3357 stype = SvTYPE(sstr);
3358 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3359 S_glob_assign(aTHX_ dstr, sstr, dtype);
3364 if (stype == SVt_PVLV)
3365 SvUPGRADE(dstr, SVt_PVNV);
3367 SvUPGRADE(dstr, (U32)stype);
3370 sflags = SvFLAGS(sstr);
3372 if (sflags & SVf_ROK) {
3373 if (dtype >= SVt_PV) {
3374 if (dtype == SVt_PVGV) {
3375 S_pvgv_assign(aTHX_ dstr, sstr);
3378 if (SvPVX_const(dstr)) {
3384 (void)SvOK_off(dstr);
3385 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3386 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3387 assert(!(sflags & SVp_NOK));
3388 assert(!(sflags & SVp_IOK));
3389 assert(!(sflags & SVf_NOK));
3390 assert(!(sflags & SVf_IOK));
3392 else if (sflags & SVp_POK) {
3396 * Check to see if we can just swipe the string. If so, it's a
3397 * possible small lose on short strings, but a big win on long ones.
3398 * It might even be a win on short strings if SvPVX_const(dstr)
3399 * has to be allocated and SvPVX_const(sstr) has to be freed.
3402 /* Whichever path we take through the next code, we want this true,
3403 and doing it now facilitates the COW check. */
3404 (void)SvPOK_only(dstr);
3407 /* We're not already COW */
3408 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3409 #ifndef PERL_OLD_COPY_ON_WRITE
3410 /* or we are, but dstr isn't a suitable target. */
3411 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3416 (sflags & SVs_TEMP) && /* slated for free anyway? */
3417 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3418 (!(flags & SV_NOSTEAL)) &&
3419 /* and we're allowed to steal temps */
3420 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3421 SvLEN(sstr) && /* and really is a string */
3422 /* and won't be needed again, potentially */
3423 !(PL_op && PL_op->op_type == OP_AASSIGN))
3424 #ifdef PERL_OLD_COPY_ON_WRITE
3425 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3426 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3427 && SvTYPE(sstr) >= SVt_PVIV)
3430 /* Failed the swipe test, and it's not a shared hash key either.
3431 Have to copy the string. */
3432 STRLEN len = SvCUR(sstr);
3433 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3434 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3435 SvCUR_set(dstr, len);
3436 *SvEND(dstr) = '\0';
3438 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3440 /* Either it's a shared hash key, or it's suitable for
3441 copy-on-write or we can swipe the string. */
3443 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3447 #ifdef PERL_OLD_COPY_ON_WRITE
3449 /* I believe I should acquire a global SV mutex if
3450 it's a COW sv (not a shared hash key) to stop
3451 it going un copy-on-write.
3452 If the source SV has gone un copy on write between up there
3453 and down here, then (assert() that) it is of the correct
3454 form to make it copy on write again */
3455 if ((sflags & (SVf_FAKE | SVf_READONLY))
3456 != (SVf_FAKE | SVf_READONLY)) {
3457 SvREADONLY_on(sstr);
3459 /* Make the source SV into a loop of 1.
3460 (about to become 2) */
3461 SV_COW_NEXT_SV_SET(sstr, sstr);
3465 /* Initial code is common. */
3466 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3471 /* making another shared SV. */
3472 STRLEN cur = SvCUR(sstr);
3473 STRLEN len = SvLEN(sstr);
3474 #ifdef PERL_OLD_COPY_ON_WRITE
3476 assert (SvTYPE(dstr) >= SVt_PVIV);
3477 /* SvIsCOW_normal */
3478 /* splice us in between source and next-after-source. */
3479 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3480 SV_COW_NEXT_SV_SET(sstr, dstr);
3481 SvPV_set(dstr, SvPVX_mutable(sstr));
3485 /* SvIsCOW_shared_hash */
3486 DEBUG_C(PerlIO_printf(Perl_debug_log,
3487 "Copy on write: Sharing hash\n"));
3489 assert (SvTYPE(dstr) >= SVt_PV);
3491 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3493 SvLEN_set(dstr, len);
3494 SvCUR_set(dstr, cur);
3495 SvREADONLY_on(dstr);
3497 /* Relesase a global SV mutex. */
3500 { /* Passes the swipe test. */
3501 SvPV_set(dstr, SvPVX_mutable(sstr));
3502 SvLEN_set(dstr, SvLEN(sstr));
3503 SvCUR_set(dstr, SvCUR(sstr));
3506 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3507 SvPV_set(sstr, NULL);
3513 if (sflags & SVp_NOK) {
3514 SvNV_set(dstr, SvNVX(sstr));
3516 if (sflags & SVp_IOK) {
3517 SvRELEASE_IVX(dstr);
3518 SvIV_set(dstr, SvIVX(sstr));
3519 /* Must do this otherwise some other overloaded use of 0x80000000
3520 gets confused. I guess SVpbm_VALID */
3521 if (sflags & SVf_IVisUV)
3524 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3526 const MAGIC * const smg = SvVOK(sstr);
3528 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3529 smg->mg_ptr, smg->mg_len);
3530 SvRMAGICAL_on(dstr);
3534 else if (sflags & (SVp_IOK|SVp_NOK)) {
3535 (void)SvOK_off(dstr);
3536 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3537 if (sflags & SVp_IOK) {
3538 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3539 SvIV_set(dstr, SvIVX(sstr));
3541 if (sflags & SVp_NOK) {
3542 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3543 SvNV_set(dstr, SvNVX(sstr));
3547 if (dtype == SVt_PVGV) {
3548 if (ckWARN(WARN_MISC))
3549 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3552 (void)SvOK_off(dstr);
3554 if (SvTAINTED(sstr))
3559 =for apidoc sv_setsv_mg
3561 Like C<sv_setsv>, but also handles 'set' magic.
3567 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3569 sv_setsv(dstr,sstr);
3573 #ifdef PERL_OLD_COPY_ON_WRITE
3575 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3577 STRLEN cur = SvCUR(sstr);
3578 STRLEN len = SvLEN(sstr);
3579 register char *new_pv;
3582 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3590 if (SvTHINKFIRST(dstr))
3591 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3592 else if (SvPVX_const(dstr))
3593 Safefree(SvPVX_const(dstr));
3597 SvUPGRADE(dstr, SVt_PVIV);
3599 assert (SvPOK(sstr));
3600 assert (SvPOKp(sstr));
3601 assert (!SvIOK(sstr));
3602 assert (!SvIOKp(sstr));
3603 assert (!SvNOK(sstr));
3604 assert (!SvNOKp(sstr));
3606 if (SvIsCOW(sstr)) {
3608 if (SvLEN(sstr) == 0) {
3609 /* source is a COW shared hash key. */
3610 DEBUG_C(PerlIO_printf(Perl_debug_log,
3611 "Fast copy on write: Sharing hash\n"));
3612 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3615 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3617 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3618 SvUPGRADE(sstr, SVt_PVIV);
3619 SvREADONLY_on(sstr);
3621 DEBUG_C(PerlIO_printf(Perl_debug_log,
3622 "Fast copy on write: Converting sstr to COW\n"));
3623 SV_COW_NEXT_SV_SET(dstr, sstr);
3625 SV_COW_NEXT_SV_SET(sstr, dstr);
3626 new_pv = SvPVX_mutable(sstr);
3629 SvPV_set(dstr, new_pv);
3630 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3633 SvLEN_set(dstr, len);
3634 SvCUR_set(dstr, cur);
3643 =for apidoc sv_setpvn
3645 Copies a string into an SV. The C<len> parameter indicates the number of
3646 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3647 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3653 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3656 register char *dptr;
3658 SV_CHECK_THINKFIRST_COW_DROP(sv);
3664 /* len is STRLEN which is unsigned, need to copy to signed */
3667 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3669 SvUPGRADE(sv, SVt_PV);
3671 dptr = SvGROW(sv, len + 1);
3672 Move(ptr,dptr,len,char);
3675 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3680 =for apidoc sv_setpvn_mg
3682 Like C<sv_setpvn>, but also handles 'set' magic.
3688 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3690 sv_setpvn(sv,ptr,len);
3695 =for apidoc sv_setpv
3697 Copies a string into an SV. The string must be null-terminated. Does not
3698 handle 'set' magic. See C<sv_setpv_mg>.
3704 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3707 register STRLEN len;
3709 SV_CHECK_THINKFIRST_COW_DROP(sv);
3715 SvUPGRADE(sv, SVt_PV);
3717 SvGROW(sv, len + 1);
3718 Move(ptr,SvPVX(sv),len+1,char);
3720 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3725 =for apidoc sv_setpv_mg
3727 Like C<sv_setpv>, but also handles 'set' magic.
3733 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3740 =for apidoc sv_usepvn
3742 Tells an SV to use C<ptr> to find its string value. Normally the string is
3743 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3744 The C<ptr> should point to memory that was allocated by C<malloc>. The
3745 string length, C<len>, must be supplied. This function will realloc the
3746 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3747 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3748 See C<sv_usepvn_mg>.
3754 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3758 SV_CHECK_THINKFIRST_COW_DROP(sv);
3759 SvUPGRADE(sv, SVt_PV);
3764 if (SvPVX_const(sv))
3767 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3768 ptr = saferealloc (ptr, allocate);
3771 SvLEN_set(sv, allocate);
3773 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3778 =for apidoc sv_usepvn_mg
3780 Like C<sv_usepvn>, but also handles 'set' magic.
3786 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3788 sv_usepvn(sv,ptr,len);
3792 #ifdef PERL_OLD_COPY_ON_WRITE
3793 /* Need to do this *after* making the SV normal, as we need the buffer
3794 pointer to remain valid until after we've copied it. If we let go too early,
3795 another thread could invalidate it by unsharing last of the same hash key
3796 (which it can do by means other than releasing copy-on-write Svs)
3797 or by changing the other copy-on-write SVs in the loop. */
3799 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3801 if (len) { /* this SV was SvIsCOW_normal(sv) */
3802 /* we need to find the SV pointing to us. */
3803 SV *current = SV_COW_NEXT_SV(after);
3805 if (current == sv) {
3806 /* The SV we point to points back to us (there were only two of us
3808 Hence other SV is no longer copy on write either. */
3810 SvREADONLY_off(after);
3812 /* We need to follow the pointers around the loop. */
3814 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3817 /* don't loop forever if the structure is bust, and we have
3818 a pointer into a closed loop. */
3819 assert (current != after);
3820 assert (SvPVX_const(current) == pvx);
3822 /* Make the SV before us point to the SV after us. */
3823 SV_COW_NEXT_SV_SET(current, after);
3826 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3831 Perl_sv_release_IVX(pTHX_ register SV *sv)
3834 sv_force_normal_flags(sv, 0);
3840 =for apidoc sv_force_normal_flags
3842 Undo various types of fakery on an SV: if the PV is a shared string, make
3843 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3844 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3845 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3846 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3847 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3848 set to some other value.) In addition, the C<flags> parameter gets passed to
3849 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3850 with flags set to 0.
3856 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3859 #ifdef PERL_OLD_COPY_ON_WRITE
3860 if (SvREADONLY(sv)) {
3861 /* At this point I believe I should acquire a global SV mutex. */
3863 const char * const pvx = SvPVX_const(sv);
3864 const STRLEN len = SvLEN(sv);
3865 const STRLEN cur = SvCUR(sv);
3866 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3868 PerlIO_printf(Perl_debug_log,
3869 "Copy on write: Force normal %ld\n",
3875 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3878 if (flags & SV_COW_DROP_PV) {
3879 /* OK, so we don't need to copy our buffer. */
3882 SvGROW(sv, cur + 1);
3883 Move(pvx,SvPVX(sv),cur,char);
3887 sv_release_COW(sv, pvx, len, next);
3892 else if (IN_PERL_RUNTIME)
3893 Perl_croak(aTHX_ PL_no_modify);
3894 /* At this point I believe that I can drop the global SV mutex. */
3897 if (SvREADONLY(sv)) {
3899 const char * const pvx = SvPVX_const(sv);
3900 const STRLEN len = SvCUR(sv);
3905 SvGROW(sv, len + 1);
3906 Move(pvx,SvPVX(sv),len,char);
3908 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3910 else if (IN_PERL_RUNTIME)
3911 Perl_croak(aTHX_ PL_no_modify);
3915 sv_unref_flags(sv, flags);
3916 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3923 Efficient removal of characters from the beginning of the string buffer.
3924 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3925 the string buffer. The C<ptr> becomes the first character of the adjusted
3926 string. Uses the "OOK hack".
3927 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3928 refer to the same chunk of data.
3934 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3936 register STRLEN delta;
3937 if (!ptr || !SvPOKp(sv))
3939 delta = ptr - SvPVX_const(sv);
3940 SV_CHECK_THINKFIRST(sv);
3941 if (SvTYPE(sv) < SVt_PVIV)
3942 sv_upgrade(sv,SVt_PVIV);
3945 if (!SvLEN(sv)) { /* make copy of shared string */
3946 const char *pvx = SvPVX_const(sv);
3947 const STRLEN len = SvCUR(sv);
3948 SvGROW(sv, len + 1);
3949 Move(pvx,SvPVX(sv),len,char);
3953 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3954 and we do that anyway inside the SvNIOK_off
3956 SvFLAGS(sv) |= SVf_OOK;
3959 SvLEN_set(sv, SvLEN(sv) - delta);
3960 SvCUR_set(sv, SvCUR(sv) - delta);
3961 SvPV_set(sv, SvPVX(sv) + delta);
3962 SvIV_set(sv, SvIVX(sv) + delta);
3966 =for apidoc sv_catpvn
3968 Concatenates the string onto the end of the string which is in the SV. The
3969 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3970 status set, then the bytes appended should be valid UTF-8.
3971 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3973 =for apidoc sv_catpvn_flags
3975 Concatenates the string onto the end of the string which is in the SV. The
3976 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3977 status set, then the bytes appended should be valid UTF-8.
3978 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3979 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3980 in terms of this function.
3986 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3990 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3992 SvGROW(dsv, dlen + slen + 1);
3994 sstr = SvPVX_const(dsv);
3995 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3996 SvCUR_set(dsv, SvCUR(dsv) + slen);
3998 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4000 if (flags & SV_SMAGIC)
4005 =for apidoc sv_catsv
4007 Concatenates the string from SV C<ssv> onto the end of the string in
4008 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4009 not 'set' magic. See C<sv_catsv_mg>.
4011 =for apidoc sv_catsv_flags
4013 Concatenates the string from SV C<ssv> onto the end of the string in
4014 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4015 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4016 and C<sv_catsv_nomg> are implemented in terms of this function.
4021 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4026 const char *spv = SvPV_const(ssv, slen);
4028 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4029 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4030 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4031 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4032 dsv->sv_flags doesn't have that bit set.
4033 Andy Dougherty 12 Oct 2001
4035 const I32 sutf8 = DO_UTF8(ssv);
4038 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4040 dutf8 = DO_UTF8(dsv);
4042 if (dutf8 != sutf8) {
4044 /* Not modifying source SV, so taking a temporary copy. */
4045 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4047 sv_utf8_upgrade(csv);
4048 spv = SvPV_const(csv, slen);
4051 sv_utf8_upgrade_nomg(dsv);
4053 sv_catpvn_nomg(dsv, spv, slen);
4056 if (flags & SV_SMAGIC)
4061 =for apidoc sv_catpv
4063 Concatenates the string onto the end of the string which is in the SV.
4064 If the SV has the UTF-8 status set, then the bytes appended should be
4065 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4070 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4073 register STRLEN len;
4079 junk = SvPV_force(sv, tlen);
4081 SvGROW(sv, tlen + len + 1);
4083 ptr = SvPVX_const(sv);
4084 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4085 SvCUR_set(sv, SvCUR(sv) + len);
4086 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4091 =for apidoc sv_catpv_mg
4093 Like C<sv_catpv>, but also handles 'set' magic.
4099 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4108 Creates a new SV. A non-zero C<len> parameter indicates the number of
4109 bytes of preallocated string space the SV should have. An extra byte for a
4110 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4111 space is allocated.) The reference count for the new SV is set to 1.
4113 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4114 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4115 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4116 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4117 modules supporting older perls.
4123 Perl_newSV(pTHX_ STRLEN len)
4130 sv_upgrade(sv, SVt_PV);
4131 SvGROW(sv, len + 1);
4136 =for apidoc sv_magicext
4138 Adds magic to an SV, upgrading it if necessary. Applies the
4139 supplied vtable and returns a pointer to the magic added.
4141 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4142 In particular, you can add magic to SvREADONLY SVs, and add more than
4143 one instance of the same 'how'.
4145 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4146 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4147 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4148 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4150 (This is now used as a subroutine by C<sv_magic>.)
4155 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4156 const char* name, I32 namlen)
4161 if (SvTYPE(sv) < SVt_PVMG) {
4162 SvUPGRADE(sv, SVt_PVMG);
4164 Newxz(mg, 1, MAGIC);
4165 mg->mg_moremagic = SvMAGIC(sv);
4166 SvMAGIC_set(sv, mg);
4168 /* Sometimes a magic contains a reference loop, where the sv and
4169 object refer to each other. To prevent a reference loop that
4170 would prevent such objects being freed, we look for such loops
4171 and if we find one we avoid incrementing the object refcount.
4173 Note we cannot do this to avoid self-tie loops as intervening RV must
4174 have its REFCNT incremented to keep it in existence.
4177 if (!obj || obj == sv ||
4178 how == PERL_MAGIC_arylen ||
4179 how == PERL_MAGIC_qr ||
4180 how == PERL_MAGIC_symtab ||
4181 (SvTYPE(obj) == SVt_PVGV &&
4182 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4183 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4184 GvFORM(obj) == (CV*)sv)))
4189 mg->mg_obj = SvREFCNT_inc(obj);
4190 mg->mg_flags |= MGf_REFCOUNTED;
4193 /* Normal self-ties simply pass a null object, and instead of
4194 using mg_obj directly, use the SvTIED_obj macro to produce a
4195 new RV as needed. For glob "self-ties", we are tieing the PVIO
4196 with an RV obj pointing to the glob containing the PVIO. In
4197 this case, to avoid a reference loop, we need to weaken the
4201 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4202 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4208 mg->mg_len = namlen;
4211 mg->mg_ptr = savepvn(name, namlen);
4212 else if (namlen == HEf_SVKEY)
4213 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4215 mg->mg_ptr = (char *) name;
4217 mg->mg_virtual = vtable;
4221 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4226 =for apidoc sv_magic
4228 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4229 then adds a new magic item of type C<how> to the head of the magic list.
4231 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4232 handling of the C<name> and C<namlen> arguments.
4234 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4235 to add more than one instance of the same 'how'.
4241 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4247 #ifdef PERL_OLD_COPY_ON_WRITE
4249 sv_force_normal_flags(sv, 0);
4251 if (SvREADONLY(sv)) {
4253 /* its okay to attach magic to shared strings; the subsequent
4254 * upgrade to PVMG will unshare the string */
4255 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4258 && how != PERL_MAGIC_regex_global
4259 && how != PERL_MAGIC_bm
4260 && how != PERL_MAGIC_fm
4261 && how != PERL_MAGIC_sv
4262 && how != PERL_MAGIC_backref
4265 Perl_croak(aTHX_ PL_no_modify);
4268 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4269 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4270 /* sv_magic() refuses to add a magic of the same 'how' as an
4273 if (how == PERL_MAGIC_taint)
4281 vtable = &PL_vtbl_sv;
4283 case PERL_MAGIC_overload:
4284 vtable = &PL_vtbl_amagic;
4286 case PERL_MAGIC_overload_elem:
4287 vtable = &PL_vtbl_amagicelem;
4289 case PERL_MAGIC_overload_table:
4290 vtable = &PL_vtbl_ovrld;
4293 vtable = &PL_vtbl_bm;
4295 case PERL_MAGIC_regdata:
4296 vtable = &PL_vtbl_regdata;
4298 case PERL_MAGIC_regdatum:
4299 vtable = &PL_vtbl_regdatum;
4301 case PERL_MAGIC_env:
4302 vtable = &PL_vtbl_env;
4305 vtable = &PL_vtbl_fm;
4307 case PERL_MAGIC_envelem:
4308 vtable = &PL_vtbl_envelem;
4310 case PERL_MAGIC_regex_global:
4311 vtable = &PL_vtbl_mglob;
4313 case PERL_MAGIC_isa:
4314 vtable = &PL_vtbl_isa;
4316 case PERL_MAGIC_isaelem:
4317 vtable = &PL_vtbl_isaelem;
4319 case PERL_MAGIC_nkeys:
4320 vtable = &PL_vtbl_nkeys;
4322 case PERL_MAGIC_dbfile:
4325 case PERL_MAGIC_dbline:
4326 vtable = &PL_vtbl_dbline;
4328 #ifdef USE_LOCALE_COLLATE
4329 case PERL_MAGIC_collxfrm:
4330 vtable = &PL_vtbl_collxfrm;
4332 #endif /* USE_LOCALE_COLLATE */
4333 case PERL_MAGIC_tied:
4334 vtable = &PL_vtbl_pack;
4336 case PERL_MAGIC_tiedelem:
4337 case PERL_MAGIC_tiedscalar:
4338 vtable = &PL_vtbl_packelem;
4341 vtable = &PL_vtbl_regexp;
4343 case PERL_MAGIC_sig:
4344 vtable = &PL_vtbl_sig;
4346 case PERL_MAGIC_sigelem:
4347 vtable = &PL_vtbl_sigelem;
4349 case PERL_MAGIC_taint:
4350 vtable = &PL_vtbl_taint;
4352 case PERL_MAGIC_uvar:
4353 vtable = &PL_vtbl_uvar;
4355 case PERL_MAGIC_vec:
4356 vtable = &PL_vtbl_vec;
4358 case PERL_MAGIC_arylen_p:
4359 case PERL_MAGIC_rhash:
4360 case PERL_MAGIC_symtab:
4361 case PERL_MAGIC_vstring:
4364 case PERL_MAGIC_utf8:
4365 vtable = &PL_vtbl_utf8;
4367 case PERL_MAGIC_substr:
4368 vtable = &PL_vtbl_substr;
4370 case PERL_MAGIC_defelem:
4371 vtable = &PL_vtbl_defelem;
4373 case PERL_MAGIC_glob:
4374 vtable = &PL_vtbl_glob;
4376 case PERL_MAGIC_arylen:
4377 vtable = &PL_vtbl_arylen;
4379 case PERL_MAGIC_pos:
4380 vtable = &PL_vtbl_pos;
4382 case PERL_MAGIC_backref:
4383 vtable = &PL_vtbl_backref;
4385 case PERL_MAGIC_ext:
4386 /* Reserved for use by extensions not perl internals. */
4387 /* Useful for attaching extension internal data to perl vars. */
4388 /* Note that multiple extensions may clash if magical scalars */
4389 /* etc holding private data from one are passed to another. */
4393 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4396 /* Rest of work is done else where */
4397 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4400 case PERL_MAGIC_taint:
4403 case PERL_MAGIC_ext:
4404 case PERL_MAGIC_dbfile:
4411 =for apidoc sv_unmagic
4413 Removes all magic of type C<type> from an SV.
4419 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4423 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4426 for (mg = *mgp; mg; mg = *mgp) {
4427 if (mg->mg_type == type) {
4428 const MGVTBL* const vtbl = mg->mg_virtual;
4429 *mgp = mg->mg_moremagic;
4430 if (vtbl && vtbl->svt_free)
4431 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4432 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4434 Safefree(mg->mg_ptr);
4435 else if (mg->mg_len == HEf_SVKEY)
4436 SvREFCNT_dec((SV*)mg->mg_ptr);
4437 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4438 Safefree(mg->mg_ptr);
4440 if (mg->mg_flags & MGf_REFCOUNTED)
4441 SvREFCNT_dec(mg->mg_obj);
4445 mgp = &mg->mg_moremagic;
4449 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4450 SvMAGIC_set(sv, NULL);
4457 =for apidoc sv_rvweaken
4459 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4460 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4461 push a back-reference to this RV onto the array of backreferences
4462 associated with that magic.
4468 Perl_sv_rvweaken(pTHX_ SV *sv)
4471 if (!SvOK(sv)) /* let undefs pass */
4474 Perl_croak(aTHX_ "Can't weaken a nonreference");
4475 else if (SvWEAKREF(sv)) {
4476 if (ckWARN(WARN_MISC))
4477 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4481 Perl_sv_add_backref(aTHX_ tsv, sv);
4487 /* Give tsv backref magic if it hasn't already got it, then push a
4488 * back-reference to sv onto the array associated with the backref magic.
4492 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4497 if (SvTYPE(tsv) == SVt_PVHV) {
4498 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4502 /* There is no AV in the offical place - try a fixup. */
4503 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4506 /* Aha. They've got it stowed in magic. Bring it back. */
4507 av = (AV*)mg->mg_obj;
4508 /* Stop mg_free decreasing the refernce count. */
4510 /* Stop mg_free even calling the destructor, given that
4511 there's no AV to free up. */
4513 sv_unmagic(tsv, PERL_MAGIC_backref);
4522 const MAGIC *const mg
4523 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4525 av = (AV*)mg->mg_obj;
4529 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4530 /* av now has a refcnt of 2, which avoids it getting freed
4531 * before us during global cleanup. The extra ref is removed
4532 * by magic_killbackrefs() when tsv is being freed */
4535 if (AvFILLp(av) >= AvMAX(av)) {
4536 av_extend(av, AvFILLp(av)+1);
4538 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4541 /* delete a back-reference to ourselves from the backref magic associated
4542 * with the SV we point to.
4546 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4553 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4554 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4555 /* We mustn't attempt to "fix up" the hash here by moving the
4556 backreference array back to the hv_aux structure, as that is stored
4557 in the main HvARRAY(), and hfreentries assumes that no-one
4558 reallocates HvARRAY() while it is running. */
4561 const MAGIC *const mg
4562 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4564 av = (AV *)mg->mg_obj;
4567 if (PL_in_clean_all)
4569 Perl_croak(aTHX_ "panic: del_backref");
4576 /* We shouldn't be in here more than once, but for paranoia reasons lets
4578 for (i = AvFILLp(av); i >= 0; i--) {
4580 const SSize_t fill = AvFILLp(av);
4582 /* We weren't the last entry.
4583 An unordered list has this property that you can take the
4584 last element off the end to fill the hole, and it's still
4585 an unordered list :-)
4590 AvFILLp(av) = fill - 1;
4596 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4598 SV **svp = AvARRAY(av);
4600 PERL_UNUSED_ARG(sv);
4602 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4603 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4604 if (svp && !SvIS_FREED(av)) {
4605 SV *const *const last = svp + AvFILLp(av);
4607 while (svp <= last) {
4609 SV *const referrer = *svp;
4610 if (SvWEAKREF(referrer)) {
4611 /* XXX Should we check that it hasn't changed? */
4612 SvRV_set(referrer, 0);
4614 SvWEAKREF_off(referrer);
4615 } else if (SvTYPE(referrer) == SVt_PVGV ||
4616 SvTYPE(referrer) == SVt_PVLV) {
4617 /* You lookin' at me? */
4618 assert(GvSTASH(referrer));
4619 assert(GvSTASH(referrer) == (HV*)sv);
4620 GvSTASH(referrer) = 0;
4623 "panic: magic_killbackrefs (flags=%"UVxf")",
4624 (UV)SvFLAGS(referrer));
4632 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4637 =for apidoc sv_insert
4639 Inserts a string at the specified offset/length within the SV. Similar to
4640 the Perl substr() function.
4646 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4651 register char *midend;
4652 register char *bigend;
4658 Perl_croak(aTHX_ "Can't modify non-existent substring");
4659 SvPV_force(bigstr, curlen);
4660 (void)SvPOK_only_UTF8(bigstr);
4661 if (offset + len > curlen) {
4662 SvGROW(bigstr, offset+len+1);
4663 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4664 SvCUR_set(bigstr, offset+len);
4668 i = littlelen - len;
4669 if (i > 0) { /* string might grow */
4670 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4671 mid = big + offset + len;
4672 midend = bigend = big + SvCUR(bigstr);
4675 while (midend > mid) /* shove everything down */
4676 *--bigend = *--midend;
4677 Move(little,big+offset,littlelen,char);
4678 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4683 Move(little,SvPVX(bigstr)+offset,len,char);
4688 big = SvPVX(bigstr);
4691 bigend = big + SvCUR(bigstr);
4693 if (midend > bigend)
4694 Perl_croak(aTHX_ "panic: sv_insert");
4696 if (mid - big > bigend - midend) { /* faster to shorten from end */
4698 Move(little, mid, littlelen,char);
4701 i = bigend - midend;
4703 Move(midend, mid, i,char);
4707 SvCUR_set(bigstr, mid - big);
4709 else if ((i = mid - big)) { /* faster from front */
4710 midend -= littlelen;
4712 sv_chop(bigstr,midend-i);
4717 Move(little, mid, littlelen,char);
4719 else if (littlelen) {
4720 midend -= littlelen;
4721 sv_chop(bigstr,midend);
4722 Move(little,midend,littlelen,char);
4725 sv_chop(bigstr,midend);
4731 =for apidoc sv_replace
4733 Make the first argument a copy of the second, then delete the original.
4734 The target SV physically takes over ownership of the body of the source SV
4735 and inherits its flags; however, the target keeps any magic it owns,
4736 and any magic in the source is discarded.
4737 Note that this is a rather specialist SV copying operation; most of the
4738 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4744 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4747 const U32 refcnt = SvREFCNT(sv);
4748 SV_CHECK_THINKFIRST_COW_DROP(sv);
4749 if (SvREFCNT(nsv) != 1) {
4750 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4751 UVuf " != 1)", (UV) SvREFCNT(nsv));
4753 if (SvMAGICAL(sv)) {
4757 sv_upgrade(nsv, SVt_PVMG);
4758 SvMAGIC_set(nsv, SvMAGIC(sv));
4759 SvFLAGS(nsv) |= SvMAGICAL(sv);
4761 SvMAGIC_set(sv, NULL);
4765 assert(!SvREFCNT(sv));
4766 #ifdef DEBUG_LEAKING_SCALARS
4767 sv->sv_flags = nsv->sv_flags;
4768 sv->sv_any = nsv->sv_any;
4769 sv->sv_refcnt = nsv->sv_refcnt;
4770 sv->sv_u = nsv->sv_u;
4772 StructCopy(nsv,sv,SV);
4774 /* Currently could join these into one piece of pointer arithmetic, but
4775 it would be unclear. */
4776 if(SvTYPE(sv) == SVt_IV)
4778 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4779 else if (SvTYPE(sv) == SVt_RV) {
4780 SvANY(sv) = &sv->sv_u.svu_rv;
4784 #ifdef PERL_OLD_COPY_ON_WRITE
4785 if (SvIsCOW_normal(nsv)) {
4786 /* We need to follow the pointers around the loop to make the
4787 previous SV point to sv, rather than nsv. */
4790 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4793 assert(SvPVX_const(current) == SvPVX_const(nsv));
4795 /* Make the SV before us point to the SV after us. */
4797 PerlIO_printf(Perl_debug_log, "previous is\n");
4799 PerlIO_printf(Perl_debug_log,
4800 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4801 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4803 SV_COW_NEXT_SV_SET(current, sv);
4806 SvREFCNT(sv) = refcnt;
4807 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4813 =for apidoc sv_clear
4815 Clear an SV: call any destructors, free up any memory used by the body,
4816 and free the body itself. The SV's head is I<not> freed, although
4817 its type is set to all 1's so that it won't inadvertently be assumed
4818 to be live during global destruction etc.
4819 This function should only be called when REFCNT is zero. Most of the time
4820 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4827 Perl_sv_clear(pTHX_ register SV *sv)
4830 const U32 type = SvTYPE(sv);
4831 const struct body_details *const sv_type_details
4832 = bodies_by_type + type;
4835 assert(SvREFCNT(sv) == 0);
4841 if (PL_defstash) { /* Still have a symbol table? */
4846 stash = SvSTASH(sv);
4847 destructor = StashHANDLER(stash,DESTROY);
4849 SV* const tmpref = newRV(sv);
4850 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4852 PUSHSTACKi(PERLSI_DESTROY);
4857 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4863 if(SvREFCNT(tmpref) < 2) {
4864 /* tmpref is not kept alive! */
4866 SvRV_set(tmpref, NULL);
4869 SvREFCNT_dec(tmpref);
4871 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4875 if (PL_in_clean_objs)
4876 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4878 /* DESTROY gave object new lease on life */
4884 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4885 SvOBJECT_off(sv); /* Curse the object. */
4886 if (type != SVt_PVIO)
4887 --PL_sv_objcount; /* XXX Might want something more general */
4890 if (type >= SVt_PVMG) {
4893 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4894 SvREFCNT_dec(SvSTASH(sv));
4899 IoIFP(sv) != PerlIO_stdin() &&
4900 IoIFP(sv) != PerlIO_stdout() &&
4901 IoIFP(sv) != PerlIO_stderr())
4903 io_close((IO*)sv, FALSE);
4905 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4906 PerlDir_close(IoDIRP(sv));
4907 IoDIRP(sv) = (DIR*)NULL;
4908 Safefree(IoTOP_NAME(sv));
4909 Safefree(IoFMT_NAME(sv));
4910 Safefree(IoBOTTOM_NAME(sv));
4919 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4926 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4927 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4928 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4929 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4931 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4932 SvREFCNT_dec(LvTARG(sv));
4936 Safefree(GvNAME(sv));
4937 /* If we're in a stash, we don't own a reference to it. However it does
4938 have a back reference to us, which needs to be cleared. */
4940 sv_del_backref((SV*)GvSTASH(sv), sv);
4945 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4947 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4948 /* Don't even bother with turning off the OOK flag. */
4953 SV *target = SvRV(sv);
4955 sv_del_backref(target, sv);
4957 SvREFCNT_dec(target);
4959 #ifdef PERL_OLD_COPY_ON_WRITE
4960 else if (SvPVX_const(sv)) {
4962 /* I believe I need to grab the global SV mutex here and
4963 then recheck the COW status. */
4965 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4968 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4969 SV_COW_NEXT_SV(sv));
4970 /* And drop it here. */
4972 } else if (SvLEN(sv)) {
4973 Safefree(SvPVX_const(sv));
4977 else if (SvPVX_const(sv) && SvLEN(sv))
4978 Safefree(SvPVX_mutable(sv));
4979 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4980 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4989 SvFLAGS(sv) &= SVf_BREAK;
4990 SvFLAGS(sv) |= SVTYPEMASK;
4992 if (sv_type_details->arena) {
4993 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4994 &PL_body_roots[type]);
4996 else if (sv_type_details->size) {
4997 my_safefree(SvANY(sv));
5002 =for apidoc sv_newref
5004 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5011 Perl_sv_newref(pTHX_ SV *sv)
5021 Decrement an SV's reference count, and if it drops to zero, call
5022 C<sv_clear> to invoke destructors and free up any memory used by
5023 the body; finally, deallocate the SV's head itself.
5024 Normally called via a wrapper macro C<SvREFCNT_dec>.
5030 Perl_sv_free(pTHX_ SV *sv)
5035 if (SvREFCNT(sv) == 0) {
5036 if (SvFLAGS(sv) & SVf_BREAK)
5037 /* this SV's refcnt has been artificially decremented to
5038 * trigger cleanup */
5040 if (PL_in_clean_all) /* All is fair */
5042 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5043 /* make sure SvREFCNT(sv)==0 happens very seldom */
5044 SvREFCNT(sv) = (~(U32)0)/2;
5047 if (ckWARN_d(WARN_INTERNAL)) {
5048 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5049 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5050 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5051 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5052 Perl_dump_sv_child(aTHX_ sv);
5057 if (--(SvREFCNT(sv)) > 0)
5059 Perl_sv_free2(aTHX_ sv);
5063 Perl_sv_free2(pTHX_ SV *sv)
5068 if (ckWARN_d(WARN_DEBUGGING))
5069 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5070 "Attempt to free temp prematurely: SV 0x%"UVxf
5071 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5075 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5076 /* make sure SvREFCNT(sv)==0 happens very seldom */
5077 SvREFCNT(sv) = (~(U32)0)/2;
5088 Returns the length of the string in the SV. Handles magic and type
5089 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5095 Perl_sv_len(pTHX_ register SV *sv)
5103 len = mg_length(sv);
5105 (void)SvPV_const(sv, len);
5110 =for apidoc sv_len_utf8
5112 Returns the number of characters in the string in an SV, counting wide
5113 UTF-8 bytes as a single character. Handles magic and type coercion.
5119 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5120 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5121 * (Note that the mg_len is not the length of the mg_ptr field.)
5126 Perl_sv_len_utf8(pTHX_ register SV *sv)
5132 return mg_length(sv);
5136 const U8 *s = (U8*)SvPV_const(sv, len);
5137 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5139 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5141 #ifdef PERL_UTF8_CACHE_ASSERT
5142 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5146 ulen = Perl_utf8_length(aTHX_ s, s + len);
5147 if (!mg && !SvREADONLY(sv)) {
5148 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5149 mg = mg_find(sv, PERL_MAGIC_utf8);
5159 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5160 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5161 * between UTF-8 and byte offsets. There are two (substr offset and substr
5162 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5163 * and byte offset) cache positions.
5165 * The mg_len field is used by sv_len_utf8(), see its comments.
5166 * Note that the mg_len is not the length of the mg_ptr field.
5170 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5171 I32 offsetp, const U8 *s, const U8 *start)
5175 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5177 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5181 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5183 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5184 (*mgp)->mg_ptr = (char *) *cachep;
5188 (*cachep)[i] = offsetp;
5189 (*cachep)[i+1] = s - start;
5197 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5198 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5199 * between UTF-8 and byte offsets. See also the comments of
5200 * S_utf8_mg_pos_init().
5204 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)
5208 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5210 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5211 if (*mgp && (*mgp)->mg_ptr) {
5212 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5213 ASSERT_UTF8_CACHE(*cachep);
5214 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5216 else { /* We will skip to the right spot. */
5221 /* The assumption is that going backward is half
5222 * the speed of going forward (that's where the
5223 * 2 * backw in the below comes from). (The real
5224 * figure of course depends on the UTF-8 data.) */
5226 if ((*cachep)[i] > (STRLEN)uoff) {
5228 backw = (*cachep)[i] - (STRLEN)uoff;
5230 if (forw < 2 * backw)
5233 p = start + (*cachep)[i+1];
5235 /* Try this only for the substr offset (i == 0),
5236 * not for the substr length (i == 2). */
5237 else if (i == 0) { /* (*cachep)[i] < uoff */
5238 const STRLEN ulen = sv_len_utf8(sv);
5240 if ((STRLEN)uoff < ulen) {
5241 forw = (STRLEN)uoff - (*cachep)[i];
5242 backw = ulen - (STRLEN)uoff;
5244 if (forw < 2 * backw)
5245 p = start + (*cachep)[i+1];
5250 /* If the string is not long enough for uoff,
5251 * we could extend it, but not at this low a level. */
5255 if (forw < 2 * backw) {
5262 while (UTF8_IS_CONTINUATION(*p))
5267 /* Update the cache. */
5268 (*cachep)[i] = (STRLEN)uoff;
5269 (*cachep)[i+1] = p - start;
5271 /* Drop the stale "length" cache */
5280 if (found) { /* Setup the return values. */
5281 *offsetp = (*cachep)[i+1];
5282 *sp = start + *offsetp;
5285 *offsetp = send - start;
5287 else if (*sp < start) {
5293 #ifdef PERL_UTF8_CACHE_ASSERT
5298 while (n-- && s < send)
5302 assert(*offsetp == s - start);
5303 assert((*cachep)[0] == (STRLEN)uoff);
5304 assert((*cachep)[1] == *offsetp);
5306 ASSERT_UTF8_CACHE(*cachep);
5315 =for apidoc sv_pos_u2b
5317 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5318 the start of the string, to a count of the equivalent number of bytes; if
5319 lenp is non-zero, it does the same to lenp, but this time starting from
5320 the offset, rather than from the start of the string. Handles magic and
5327 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5328 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5329 * byte offsets. See also the comments of S_utf8_mg_pos().
5334 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5342 start = (U8*)SvPV_const(sv, len);
5345 STRLEN *cache = NULL;
5346 const U8 *s = start;
5347 I32 uoffset = *offsetp;
5348 const U8 * const send = s + len;
5350 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5352 if (!found && uoffset > 0) {
5353 while (s < send && uoffset--)
5357 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5359 *offsetp = s - start;
5364 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5368 if (!found && *lenp > 0) {
5371 while (s < send && ulen--)
5375 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5379 ASSERT_UTF8_CACHE(cache);
5391 =for apidoc sv_pos_b2u
5393 Converts the value pointed to by offsetp from a count of bytes from the
5394 start of the string, to a count of the equivalent number of UTF-8 chars.
5395 Handles magic and type coercion.
5401 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5402 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5403 * byte offsets. See also the comments of S_utf8_mg_pos().
5408 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5416 s = (const U8*)SvPV_const(sv, len);
5417 if ((I32)len < *offsetp)
5418 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5420 const U8* send = s + *offsetp;
5422 STRLEN *cache = NULL;
5426 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5427 mg = mg_find(sv, PERL_MAGIC_utf8);
5428 if (mg && mg->mg_ptr) {
5429 cache = (STRLEN *) mg->mg_ptr;
5430 if (cache[1] == (STRLEN)*offsetp) {
5431 /* An exact match. */
5432 *offsetp = cache[0];
5436 else if (cache[1] < (STRLEN)*offsetp) {
5437 /* We already know part of the way. */
5440 /* Let the below loop do the rest. */
5442 else { /* cache[1] > *offsetp */
5443 /* We already know all of the way, now we may
5444 * be able to walk back. The same assumption
5445 * is made as in S_utf8_mg_pos(), namely that
5446 * walking backward is twice slower than
5447 * walking forward. */
5448 const STRLEN forw = *offsetp;
5449 STRLEN backw = cache[1] - *offsetp;
5451 if (!(forw < 2 * backw)) {
5452 const U8 *p = s + cache[1];
5459 while (UTF8_IS_CONTINUATION(*p)) {
5467 *offsetp = cache[0];
5469 /* Drop the stale "length" cache */
5477 ASSERT_UTF8_CACHE(cache);
5483 /* Call utf8n_to_uvchr() to validate the sequence
5484 * (unless a simple non-UTF character) */
5485 if (!UTF8_IS_INVARIANT(*s))
5486 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5495 if (!SvREADONLY(sv)) {
5497 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5498 mg = mg_find(sv, PERL_MAGIC_utf8);
5503 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5504 mg->mg_ptr = (char *) cache;
5509 cache[1] = *offsetp;
5510 /* Drop the stale "length" cache */
5523 Returns a boolean indicating whether the strings in the two SVs are
5524 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5525 coerce its args to strings if necessary.
5531 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5540 SV* svrecode = NULL;
5547 pv1 = SvPV_const(sv1, cur1);
5554 pv2 = SvPV_const(sv2, cur2);
5556 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5557 /* Differing utf8ness.
5558 * Do not UTF8size the comparands as a side-effect. */
5561 svrecode = newSVpvn(pv2, cur2);
5562 sv_recode_to_utf8(svrecode, PL_encoding);
5563 pv2 = SvPV_const(svrecode, cur2);
5566 svrecode = newSVpvn(pv1, cur1);
5567 sv_recode_to_utf8(svrecode, PL_encoding);
5568 pv1 = SvPV_const(svrecode, cur1);
5570 /* Now both are in UTF-8. */
5572 SvREFCNT_dec(svrecode);
5577 bool is_utf8 = TRUE;
5580 /* sv1 is the UTF-8 one,
5581 * if is equal it must be downgrade-able */
5582 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5588 /* sv2 is the UTF-8 one,
5589 * if is equal it must be downgrade-able */
5590 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5596 /* Downgrade not possible - cannot be eq */
5604 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5607 SvREFCNT_dec(svrecode);
5618 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5619 string in C<sv1> is less than, equal to, or greater than the string in
5620 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5621 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5627 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5631 const char *pv1, *pv2;
5634 SV *svrecode = NULL;
5641 pv1 = SvPV_const(sv1, cur1);
5648 pv2 = SvPV_const(sv2, cur2);
5650 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5651 /* Differing utf8ness.
5652 * Do not UTF8size the comparands as a side-effect. */
5655 svrecode = newSVpvn(pv2, cur2);
5656 sv_recode_to_utf8(svrecode, PL_encoding);
5657 pv2 = SvPV_const(svrecode, cur2);
5660 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5665 svrecode = newSVpvn(pv1, cur1);
5666 sv_recode_to_utf8(svrecode, PL_encoding);
5667 pv1 = SvPV_const(svrecode, cur1);
5670 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5676 cmp = cur2 ? -1 : 0;
5680 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5683 cmp = retval < 0 ? -1 : 1;
5684 } else if (cur1 == cur2) {
5687 cmp = cur1 < cur2 ? -1 : 1;
5692 SvREFCNT_dec(svrecode);
5701 =for apidoc sv_cmp_locale
5703 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5704 'use bytes' aware, handles get magic, and will coerce its args to strings
5705 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5711 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5714 #ifdef USE_LOCALE_COLLATE
5720 if (PL_collation_standard)
5724 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5726 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5728 if (!pv1 || !len1) {
5739 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5742 return retval < 0 ? -1 : 1;
5745 * When the result of collation is equality, that doesn't mean
5746 * that there are no differences -- some locales exclude some
5747 * characters from consideration. So to avoid false equalities,
5748 * we use the raw string as a tiebreaker.
5754 #endif /* USE_LOCALE_COLLATE */
5756 return sv_cmp(sv1, sv2);
5760 #ifdef USE_LOCALE_COLLATE
5763 =for apidoc sv_collxfrm
5765 Add Collate Transform magic to an SV if it doesn't already have it.
5767 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5768 scalar data of the variable, but transformed to such a format that a normal
5769 memory comparison can be used to compare the data according to the locale
5776 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5781 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5782 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5788 Safefree(mg->mg_ptr);
5789 s = SvPV_const(sv, len);
5790 if ((xf = mem_collxfrm(s, len, &xlen))) {
5791 if (SvREADONLY(sv)) {
5794 return xf + sizeof(PL_collation_ix);
5797 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5798 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5811 if (mg && mg->mg_ptr) {
5813 return mg->mg_ptr + sizeof(PL_collation_ix);
5821 #endif /* USE_LOCALE_COLLATE */
5826 Get a line from the filehandle and store it into the SV, optionally
5827 appending to the currently-stored string.
5833 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5838 register STDCHAR rslast;
5839 register STDCHAR *bp;
5845 if (SvTHINKFIRST(sv))
5846 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5847 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5849 However, perlbench says it's slower, because the existing swipe code
5850 is faster than copy on write.
5851 Swings and roundabouts. */
5852 SvUPGRADE(sv, SVt_PV);
5857 if (PerlIO_isutf8(fp)) {
5859 sv_utf8_upgrade_nomg(sv);
5860 sv_pos_u2b(sv,&append,0);
5862 } else if (SvUTF8(sv)) {
5863 SV * const tsv = newSV(0);
5864 sv_gets(tsv, fp, 0);
5865 sv_utf8_upgrade_nomg(tsv);
5866 SvCUR_set(sv,append);
5869 goto return_string_or_null;
5874 if (PerlIO_isutf8(fp))
5877 if (IN_PERL_COMPILETIME) {
5878 /* we always read code in line mode */
5882 else if (RsSNARF(PL_rs)) {
5883 /* If it is a regular disk file use size from stat() as estimate
5884 of amount we are going to read - may result in malloc-ing
5885 more memory than we realy need if layers bellow reduce
5886 size we read (e.g. CRLF or a gzip layer)
5889 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5890 const Off_t offset = PerlIO_tell(fp);
5891 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5892 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5898 else if (RsRECORD(PL_rs)) {
5902 /* Grab the size of the record we're getting */
5903 recsize = SvIV(SvRV(PL_rs));
5904 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5907 /* VMS wants read instead of fread, because fread doesn't respect */
5908 /* RMS record boundaries. This is not necessarily a good thing to be */
5909 /* doing, but we've got no other real choice - except avoid stdio
5910 as implementation - perhaps write a :vms layer ?
5912 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5914 bytesread = PerlIO_read(fp, buffer, recsize);
5918 SvCUR_set(sv, bytesread += append);
5919 buffer[bytesread] = '\0';
5920 goto return_string_or_null;
5922 else if (RsPARA(PL_rs)) {
5928 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5929 if (PerlIO_isutf8(fp)) {
5930 rsptr = SvPVutf8(PL_rs, rslen);
5933 if (SvUTF8(PL_rs)) {
5934 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5935 Perl_croak(aTHX_ "Wide character in $/");
5938 rsptr = SvPV_const(PL_rs, rslen);
5942 rslast = rslen ? rsptr[rslen - 1] : '\0';
5944 if (rspara) { /* have to do this both before and after */
5945 do { /* to make sure file boundaries work right */
5948 i = PerlIO_getc(fp);
5952 PerlIO_ungetc(fp,i);
5958 /* See if we know enough about I/O mechanism to cheat it ! */
5960 /* This used to be #ifdef test - it is made run-time test for ease
5961 of abstracting out stdio interface. One call should be cheap
5962 enough here - and may even be a macro allowing compile
5966 if (PerlIO_fast_gets(fp)) {
5969 * We're going to steal some values from the stdio struct
5970 * and put EVERYTHING in the innermost loop into registers.
5972 register STDCHAR *ptr;
5976 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5977 /* An ungetc()d char is handled separately from the regular
5978 * buffer, so we getc() it back out and stuff it in the buffer.
5980 i = PerlIO_getc(fp);
5981 if (i == EOF) return 0;
5982 *(--((*fp)->_ptr)) = (unsigned char) i;
5986 /* Here is some breathtakingly efficient cheating */
5988 cnt = PerlIO_get_cnt(fp); /* get count into register */
5989 /* make sure we have the room */
5990 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5991 /* Not room for all of it
5992 if we are looking for a separator and room for some
5994 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5995 /* just process what we have room for */
5996 shortbuffered = cnt - SvLEN(sv) + append + 1;
5997 cnt -= shortbuffered;
6001 /* remember that cnt can be negative */
6002 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6007 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6008 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6009 DEBUG_P(PerlIO_printf(Perl_debug_log,
6010 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6011 DEBUG_P(PerlIO_printf(Perl_debug_log,
6012 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6013 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6014 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6019 while (cnt > 0) { /* this | eat */
6021 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6022 goto thats_all_folks; /* screams | sed :-) */
6026 Copy(ptr, bp, cnt, char); /* this | eat */
6027 bp += cnt; /* screams | dust */
6028 ptr += cnt; /* louder | sed :-) */
6033 if (shortbuffered) { /* oh well, must extend */
6034 cnt = shortbuffered;
6036 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6038 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6039 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6043 DEBUG_P(PerlIO_printf(Perl_debug_log,
6044 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6045 PTR2UV(ptr),(long)cnt));
6046 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6048 DEBUG_P(PerlIO_printf(Perl_debug_log,
6049 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6050 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6051 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6053 /* This used to call 'filbuf' in stdio form, but as that behaves like
6054 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6055 another abstraction. */
6056 i = PerlIO_getc(fp); /* get more characters */
6058 DEBUG_P(PerlIO_printf(Perl_debug_log,
6059 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6060 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6061 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6063 cnt = PerlIO_get_cnt(fp);
6064 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6065 DEBUG_P(PerlIO_printf(Perl_debug_log,
6066 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6068 if (i == EOF) /* all done for ever? */
6069 goto thats_really_all_folks;
6071 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6073 SvGROW(sv, bpx + cnt + 2);
6074 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6076 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6078 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6079 goto thats_all_folks;
6083 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6084 memNE((char*)bp - rslen, rsptr, rslen))
6085 goto screamer; /* go back to the fray */
6086 thats_really_all_folks:
6088 cnt += shortbuffered;
6089 DEBUG_P(PerlIO_printf(Perl_debug_log,
6090 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6091 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6092 DEBUG_P(PerlIO_printf(Perl_debug_log,
6093 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6094 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6095 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6097 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6098 DEBUG_P(PerlIO_printf(Perl_debug_log,
6099 "Screamer: done, len=%ld, string=|%.*s|\n",
6100 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6104 /*The big, slow, and stupid way. */
6105 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6106 STDCHAR *buf = NULL;
6107 Newx(buf, 8192, STDCHAR);
6115 register const STDCHAR * const bpe = buf + sizeof(buf);
6117 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6118 ; /* keep reading */
6122 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6123 /* Accomodate broken VAXC compiler, which applies U8 cast to
6124 * both args of ?: operator, causing EOF to change into 255
6127 i = (U8)buf[cnt - 1];
6133 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6135 sv_catpvn(sv, (char *) buf, cnt);
6137 sv_setpvn(sv, (char *) buf, cnt);
6139 if (i != EOF && /* joy */
6141 SvCUR(sv) < rslen ||
6142 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6146 * If we're reading from a TTY and we get a short read,
6147 * indicating that the user hit his EOF character, we need
6148 * to notice it now, because if we try to read from the TTY
6149 * again, the EOF condition will disappear.
6151 * The comparison of cnt to sizeof(buf) is an optimization
6152 * that prevents unnecessary calls to feof().
6156 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6160 #ifdef USE_HEAP_INSTEAD_OF_STACK
6165 if (rspara) { /* have to do this both before and after */
6166 while (i != EOF) { /* to make sure file boundaries work right */
6167 i = PerlIO_getc(fp);
6169 PerlIO_ungetc(fp,i);
6175 return_string_or_null:
6176 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6182 Auto-increment of the value in the SV, doing string to numeric conversion
6183 if necessary. Handles 'get' magic.
6189 Perl_sv_inc(pTHX_ register SV *sv)
6198 if (SvTHINKFIRST(sv)) {
6200 sv_force_normal_flags(sv, 0);
6201 if (SvREADONLY(sv)) {
6202 if (IN_PERL_RUNTIME)
6203 Perl_croak(aTHX_ PL_no_modify);
6207 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6209 i = PTR2IV(SvRV(sv));
6214 flags = SvFLAGS(sv);
6215 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6216 /* It's (privately or publicly) a float, but not tested as an
6217 integer, so test it to see. */
6219 flags = SvFLAGS(sv);
6221 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6222 /* It's publicly an integer, or privately an integer-not-float */
6223 #ifdef PERL_PRESERVE_IVUV
6227 if (SvUVX(sv) == UV_MAX)
6228 sv_setnv(sv, UV_MAX_P1);
6230 (void)SvIOK_only_UV(sv);
6231 SvUV_set(sv, SvUVX(sv) + 1);
6233 if (SvIVX(sv) == IV_MAX)
6234 sv_setuv(sv, (UV)IV_MAX + 1);
6236 (void)SvIOK_only(sv);
6237 SvIV_set(sv, SvIVX(sv) + 1);
6242 if (flags & SVp_NOK) {
6243 (void)SvNOK_only(sv);
6244 SvNV_set(sv, SvNVX(sv) + 1.0);
6248 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6249 if ((flags & SVTYPEMASK) < SVt_PVIV)
6250 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6251 (void)SvIOK_only(sv);
6256 while (isALPHA(*d)) d++;
6257 while (isDIGIT(*d)) d++;
6259 #ifdef PERL_PRESERVE_IVUV
6260 /* Got to punt this as an integer if needs be, but we don't issue
6261 warnings. Probably ought to make the sv_iv_please() that does
6262 the conversion if possible, and silently. */
6263 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6264 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6265 /* Need to try really hard to see if it's an integer.
6266 9.22337203685478e+18 is an integer.
6267 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6268 so $a="9.22337203685478e+18"; $a+0; $a++
6269 needs to be the same as $a="9.22337203685478e+18"; $a++
6276 /* sv_2iv *should* have made this an NV */
6277 if (flags & SVp_NOK) {
6278 (void)SvNOK_only(sv);
6279 SvNV_set(sv, SvNVX(sv) + 1.0);
6282 /* I don't think we can get here. Maybe I should assert this
6283 And if we do get here I suspect that sv_setnv will croak. NWC
6285 #if defined(USE_LONG_DOUBLE)
6286 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",
6287 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6289 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6290 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6293 #endif /* PERL_PRESERVE_IVUV */
6294 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6298 while (d >= SvPVX_const(sv)) {
6306 /* MKS: The original code here died if letters weren't consecutive.
6307 * at least it didn't have to worry about non-C locales. The
6308 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6309 * arranged in order (although not consecutively) and that only
6310 * [A-Za-z] are accepted by isALPHA in the C locale.
6312 if (*d != 'z' && *d != 'Z') {
6313 do { ++*d; } while (!isALPHA(*d));
6316 *(d--) -= 'z' - 'a';
6321 *(d--) -= 'z' - 'a' + 1;
6325 /* oh,oh, the number grew */
6326 SvGROW(sv, SvCUR(sv) + 2);
6327 SvCUR_set(sv, SvCUR(sv) + 1);
6328 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6339 Auto-decrement of the value in the SV, doing string to numeric conversion
6340 if necessary. Handles 'get' magic.
6346 Perl_sv_dec(pTHX_ register SV *sv)
6354 if (SvTHINKFIRST(sv)) {
6356 sv_force_normal_flags(sv, 0);
6357 if (SvREADONLY(sv)) {
6358 if (IN_PERL_RUNTIME)
6359 Perl_croak(aTHX_ PL_no_modify);
6363 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6365 i = PTR2IV(SvRV(sv));
6370 /* Unlike sv_inc we don't have to worry about string-never-numbers
6371 and keeping them magic. But we mustn't warn on punting */
6372 flags = SvFLAGS(sv);
6373 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6374 /* It's publicly an integer, or privately an integer-not-float */
6375 #ifdef PERL_PRESERVE_IVUV
6379 if (SvUVX(sv) == 0) {
6380 (void)SvIOK_only(sv);
6384 (void)SvIOK_only_UV(sv);
6385 SvUV_set(sv, SvUVX(sv) - 1);
6388 if (SvIVX(sv) == IV_MIN)
6389 sv_setnv(sv, (NV)IV_MIN - 1.0);
6391 (void)SvIOK_only(sv);
6392 SvIV_set(sv, SvIVX(sv) - 1);
6397 if (flags & SVp_NOK) {
6398 SvNV_set(sv, SvNVX(sv) - 1.0);
6399 (void)SvNOK_only(sv);
6402 if (!(flags & SVp_POK)) {
6403 if ((flags & SVTYPEMASK) < SVt_PVIV)
6404 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6406 (void)SvIOK_only(sv);
6409 #ifdef PERL_PRESERVE_IVUV
6411 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6412 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6413 /* Need to try really hard to see if it's an integer.
6414 9.22337203685478e+18 is an integer.
6415 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6416 so $a="9.22337203685478e+18"; $a+0; $a--
6417 needs to be the same as $a="9.22337203685478e+18"; $a--
6424 /* sv_2iv *should* have made this an NV */
6425 if (flags & SVp_NOK) {
6426 (void)SvNOK_only(sv);
6427 SvNV_set(sv, SvNVX(sv) - 1.0);
6430 /* I don't think we can get here. Maybe I should assert this
6431 And if we do get here I suspect that sv_setnv will croak. NWC
6433 #if defined(USE_LONG_DOUBLE)
6434 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",
6435 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6437 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6438 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6442 #endif /* PERL_PRESERVE_IVUV */
6443 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6447 =for apidoc sv_mortalcopy
6449 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6450 The new SV is marked as mortal. It will be destroyed "soon", either by an
6451 explicit call to FREETMPS, or by an implicit call at places such as
6452 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6457 /* Make a string that will exist for the duration of the expression
6458 * evaluation. Actually, it may have to last longer than that, but
6459 * hopefully we won't free it until it has been assigned to a
6460 * permanent location. */
6463 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6469 sv_setsv(sv,oldstr);
6471 PL_tmps_stack[++PL_tmps_ix] = sv;
6477 =for apidoc sv_newmortal
6479 Creates a new null SV which is mortal. The reference count of the SV is
6480 set to 1. It will be destroyed "soon", either by an explicit call to
6481 FREETMPS, or by an implicit call at places such as statement boundaries.
6482 See also C<sv_mortalcopy> and C<sv_2mortal>.
6488 Perl_sv_newmortal(pTHX)
6494 SvFLAGS(sv) = SVs_TEMP;
6496 PL_tmps_stack[++PL_tmps_ix] = sv;
6501 =for apidoc sv_2mortal
6503 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6504 by an explicit call to FREETMPS, or by an implicit call at places such as
6505 statement boundaries. SvTEMP() is turned on which means that the SV's
6506 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6507 and C<sv_mortalcopy>.
6513 Perl_sv_2mortal(pTHX_ register SV *sv)
6518 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6521 PL_tmps_stack[++PL_tmps_ix] = sv;
6529 Creates a new SV and copies a string into it. The reference count for the
6530 SV is set to 1. If C<len> is zero, Perl will compute the length using
6531 strlen(). For efficiency, consider using C<newSVpvn> instead.
6537 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6543 sv_setpvn(sv,s,len ? len : strlen(s));
6548 =for apidoc newSVpvn
6550 Creates a new SV and copies a string into it. The reference count for the
6551 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6552 string. You are responsible for ensuring that the source string is at least
6553 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6559 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6565 sv_setpvn(sv,s,len);
6571 =for apidoc newSVhek
6573 Creates a new SV from the hash key structure. It will generate scalars that
6574 point to the shared string table where possible. Returns a new (undefined)
6575 SV if the hek is NULL.
6581 Perl_newSVhek(pTHX_ const HEK *hek)
6591 if (HEK_LEN(hek) == HEf_SVKEY) {
6592 return newSVsv(*(SV**)HEK_KEY(hek));
6594 const int flags = HEK_FLAGS(hek);
6595 if (flags & HVhek_WASUTF8) {
6597 Andreas would like keys he put in as utf8 to come back as utf8
6599 STRLEN utf8_len = HEK_LEN(hek);
6600 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6601 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6604 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6606 } else if (flags & HVhek_REHASH) {
6607 /* We don't have a pointer to the hv, so we have to replicate the
6608 flag into every HEK. This hv is using custom a hasing
6609 algorithm. Hence we can't return a shared string scalar, as
6610 that would contain the (wrong) hash value, and might get passed
6611 into an hv routine with a regular hash */
6613 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6618 /* This will be overwhelminly the most common case. */
6619 return newSVpvn_share(HEK_KEY(hek),
6620 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6626 =for apidoc newSVpvn_share
6628 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6629 table. If the string does not already exist in the table, it is created
6630 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6631 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6632 otherwise the hash is computed. The idea here is that as the string table
6633 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6634 hash lookup will avoid string compare.
6640 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6644 bool is_utf8 = FALSE;
6646 STRLEN tmplen = -len;
6648 /* See the note in hv.c:hv_fetch() --jhi */
6649 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6653 PERL_HASH(hash, src, len);
6655 sv_upgrade(sv, SVt_PV);
6656 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6668 #if defined(PERL_IMPLICIT_CONTEXT)
6670 /* pTHX_ magic can't cope with varargs, so this is a no-context
6671 * version of the main function, (which may itself be aliased to us).
6672 * Don't access this version directly.
6676 Perl_newSVpvf_nocontext(const char* pat, ...)
6681 va_start(args, pat);
6682 sv = vnewSVpvf(pat, &args);
6689 =for apidoc newSVpvf
6691 Creates a new SV and initializes it with the string formatted like
6698 Perl_newSVpvf(pTHX_ const char* pat, ...)
6702 va_start(args, pat);
6703 sv = vnewSVpvf(pat, &args);
6708 /* backend for newSVpvf() and newSVpvf_nocontext() */
6711 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6716 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6723 Creates a new SV and copies a floating point value into it.
6724 The reference count for the SV is set to 1.
6730 Perl_newSVnv(pTHX_ NV n)
6743 Creates a new SV and copies an integer into it. The reference count for the
6750 Perl_newSViv(pTHX_ IV i)
6763 Creates a new SV and copies an unsigned integer into it.
6764 The reference count for the SV is set to 1.
6770 Perl_newSVuv(pTHX_ UV u)
6781 =for apidoc newRV_noinc
6783 Creates an RV wrapper for an SV. The reference count for the original
6784 SV is B<not> incremented.
6790 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6796 sv_upgrade(sv, SVt_RV);
6798 SvRV_set(sv, tmpRef);
6803 /* newRV_inc is the official function name to use now.
6804 * newRV_inc is in fact #defined to newRV in sv.h
6808 Perl_newRV(pTHX_ SV *tmpRef)
6811 return newRV_noinc(SvREFCNT_inc(tmpRef));
6817 Creates a new SV which is an exact duplicate of the original SV.
6824 Perl_newSVsv(pTHX_ register SV *old)
6831 if (SvTYPE(old) == SVTYPEMASK) {
6832 if (ckWARN_d(WARN_INTERNAL))
6833 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6837 /* SV_GMAGIC is the default for sv_setv()
6838 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6839 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6840 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6845 =for apidoc sv_reset
6847 Underlying implementation for the C<reset> Perl function.
6848 Note that the perl-level function is vaguely deprecated.
6854 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6857 char todo[PERL_UCHAR_MAX+1];
6862 if (!*s) { /* reset ?? searches */
6863 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6865 PMOP *pm = (PMOP *) mg->mg_obj;
6867 pm->op_pmdynflags &= ~PMdf_USED;
6874 /* reset variables */
6876 if (!HvARRAY(stash))
6879 Zero(todo, 256, char);
6882 I32 i = (unsigned char)*s;
6886 max = (unsigned char)*s++;
6887 for ( ; i <= max; i++) {
6890 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6892 for (entry = HvARRAY(stash)[i];
6894 entry = HeNEXT(entry))
6899 if (!todo[(U8)*HeKEY(entry)])
6901 gv = (GV*)HeVAL(entry);
6904 if (SvTHINKFIRST(sv)) {
6905 if (!SvREADONLY(sv) && SvROK(sv))
6907 /* XXX Is this continue a bug? Why should THINKFIRST
6908 exempt us from resetting arrays and hashes? */
6912 if (SvTYPE(sv) >= SVt_PV) {
6914 if (SvPVX_const(sv) != NULL)
6922 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6924 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6927 # if defined(USE_ENVIRON_ARRAY)
6930 # endif /* USE_ENVIRON_ARRAY */
6941 Using various gambits, try to get an IO from an SV: the IO slot if its a
6942 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6943 named after the PV if we're a string.
6949 Perl_sv_2io(pTHX_ SV *sv)
6954 switch (SvTYPE(sv)) {
6962 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6966 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6968 return sv_2io(SvRV(sv));
6969 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6975 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6984 Using various gambits, try to get a CV from an SV; in addition, try if
6985 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6986 The flags in C<lref> are passed to sv_fetchsv.
6992 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7003 switch (SvTYPE(sv)) {
7022 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7023 tryAMAGICunDEREF(to_cv);
7026 if (SvTYPE(sv) == SVt_PVCV) {
7035 Perl_croak(aTHX_ "Not a subroutine reference");
7040 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7046 /* Some flags to gv_fetchsv mean don't really create the GV */
7047 if (SvTYPE(gv) != SVt_PVGV) {
7053 if (lref && !GvCVu(gv)) {
7057 gv_efullname3(tmpsv, gv, NULL);
7058 /* XXX this is probably not what they think they're getting.
7059 * It has the same effect as "sub name;", i.e. just a forward
7061 newSUB(start_subparse(FALSE, 0),
7062 newSVOP(OP_CONST, 0, tmpsv),
7067 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7077 Returns true if the SV has a true value by Perl's rules.
7078 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7079 instead use an in-line version.
7085 Perl_sv_true(pTHX_ register SV *sv)
7090 register const XPV* const tXpv = (XPV*)SvANY(sv);
7092 (tXpv->xpv_cur > 1 ||
7093 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7100 return SvIVX(sv) != 0;
7103 return SvNVX(sv) != 0.0;
7105 return sv_2bool(sv);
7111 =for apidoc sv_pvn_force
7113 Get a sensible string out of the SV somehow.
7114 A private implementation of the C<SvPV_force> macro for compilers which
7115 can't cope with complex macro expressions. Always use the macro instead.
7117 =for apidoc sv_pvn_force_flags
7119 Get a sensible string out of the SV somehow.
7120 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7121 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7122 implemented in terms of this function.
7123 You normally want to use the various wrapper macros instead: see
7124 C<SvPV_force> and C<SvPV_force_nomg>
7130 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7133 if (SvTHINKFIRST(sv) && !SvROK(sv))
7134 sv_force_normal_flags(sv, 0);
7144 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7145 const char * const ref = sv_reftype(sv,0);
7147 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7148 ref, OP_NAME(PL_op));
7150 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7152 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7153 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7155 s = sv_2pv_flags(sv, &len, flags);
7159 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7162 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7163 SvGROW(sv, len + 1);
7164 Move(s,SvPVX(sv),len,char);
7169 SvPOK_on(sv); /* validate pointer */
7171 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7172 PTR2UV(sv),SvPVX_const(sv)));
7175 return SvPVX_mutable(sv);
7179 =for apidoc sv_pvbyten_force
7181 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7187 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7189 sv_pvn_force(sv,lp);
7190 sv_utf8_downgrade(sv,0);
7196 =for apidoc sv_pvutf8n_force
7198 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7204 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7206 sv_pvn_force(sv,lp);
7207 sv_utf8_upgrade(sv);
7213 =for apidoc sv_reftype
7215 Returns a string describing what the SV is a reference to.
7221 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7223 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7224 inside return suggests a const propagation bug in g++. */
7225 if (ob && SvOBJECT(sv)) {
7226 char * const name = HvNAME_get(SvSTASH(sv));
7227 return name ? name : (char *) "__ANON__";
7230 switch (SvTYPE(sv)) {
7247 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7248 /* tied lvalues should appear to be
7249 * scalars for backwards compatitbility */
7250 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7251 ? "SCALAR" : "LVALUE");
7252 case SVt_PVAV: return "ARRAY";
7253 case SVt_PVHV: return "HASH";
7254 case SVt_PVCV: return "CODE";
7255 case SVt_PVGV: return "GLOB";
7256 case SVt_PVFM: return "FORMAT";
7257 case SVt_PVIO: return "IO";
7258 default: return "UNKNOWN";
7264 =for apidoc sv_isobject
7266 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7267 object. If the SV is not an RV, or if the object is not blessed, then this
7274 Perl_sv_isobject(pTHX_ SV *sv)
7290 Returns a boolean indicating whether the SV is blessed into the specified
7291 class. This does not check for subtypes; use C<sv_derived_from> to verify
7292 an inheritance relationship.
7298 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7309 hvname = HvNAME_get(SvSTASH(sv));
7313 return strEQ(hvname, name);
7319 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7320 it will be upgraded to one. If C<classname> is non-null then the new SV will
7321 be blessed in the specified package. The new SV is returned and its
7322 reference count is 1.
7328 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7335 SV_CHECK_THINKFIRST_COW_DROP(rv);
7338 if (SvTYPE(rv) >= SVt_PVMG) {
7339 const U32 refcnt = SvREFCNT(rv);
7343 SvREFCNT(rv) = refcnt;
7346 if (SvTYPE(rv) < SVt_RV)
7347 sv_upgrade(rv, SVt_RV);
7348 else if (SvTYPE(rv) > SVt_RV) {
7359 HV* const stash = gv_stashpv(classname, TRUE);
7360 (void)sv_bless(rv, stash);
7366 =for apidoc sv_setref_pv
7368 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7369 argument will be upgraded to an RV. That RV will be modified to point to
7370 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7371 into the SV. The C<classname> argument indicates the package for the
7372 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7373 will have a reference count of 1, and the RV will be returned.
7375 Do not use with other Perl types such as HV, AV, SV, CV, because those
7376 objects will become corrupted by the pointer copy process.
7378 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7384 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7388 sv_setsv(rv, &PL_sv_undef);
7392 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7397 =for apidoc sv_setref_iv
7399 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7400 argument will be upgraded to an RV. That RV will be modified to point to
7401 the new SV. The C<classname> argument indicates the package for the
7402 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7403 will have a reference count of 1, and the RV will be returned.
7409 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7411 sv_setiv(newSVrv(rv,classname), iv);
7416 =for apidoc sv_setref_uv
7418 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7419 argument will be upgraded to an RV. That RV will be modified to point to
7420 the new SV. The C<classname> argument indicates the package for the
7421 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7422 will have a reference count of 1, and the RV will be returned.
7428 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7430 sv_setuv(newSVrv(rv,classname), uv);
7435 =for apidoc sv_setref_nv
7437 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7438 argument will be upgraded to an RV. That RV will be modified to point to
7439 the new SV. The C<classname> argument indicates the package for the
7440 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7441 will have a reference count of 1, and the RV will be returned.
7447 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7449 sv_setnv(newSVrv(rv,classname), nv);
7454 =for apidoc sv_setref_pvn
7456 Copies a string into a new SV, optionally blessing the SV. The length of the
7457 string must be specified with C<n>. The C<rv> argument will be upgraded to
7458 an RV. That RV will be modified to point to the new SV. The C<classname>
7459 argument indicates the package for the blessing. Set C<classname> to
7460 C<NULL> to avoid the blessing. The new SV will have a reference count
7461 of 1, and the RV will be returned.
7463 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7469 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7471 sv_setpvn(newSVrv(rv,classname), pv, n);
7476 =for apidoc sv_bless
7478 Blesses an SV into a specified package. The SV must be an RV. The package
7479 must be designated by its stash (see C<gv_stashpv()>). The reference count
7480 of the SV is unaffected.
7486 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7491 Perl_croak(aTHX_ "Can't bless non-reference value");
7493 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7494 if (SvREADONLY(tmpRef))
7495 Perl_croak(aTHX_ PL_no_modify);
7496 if (SvOBJECT(tmpRef)) {
7497 if (SvTYPE(tmpRef) != SVt_PVIO)
7499 SvREFCNT_dec(SvSTASH(tmpRef));
7502 SvOBJECT_on(tmpRef);
7503 if (SvTYPE(tmpRef) != SVt_PVIO)
7505 SvUPGRADE(tmpRef, SVt_PVMG);
7506 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7513 if(SvSMAGICAL(tmpRef))
7514 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7522 /* Downgrades a PVGV to a PVMG.
7526 S_sv_unglob(pTHX_ SV *sv)
7531 assert(SvTYPE(sv) == SVt_PVGV);
7536 sv_del_backref((SV*)GvSTASH(sv), sv);
7539 sv_unmagic(sv, PERL_MAGIC_glob);
7540 Safefree(GvNAME(sv));
7543 /* need to keep SvANY(sv) in the right arena */
7544 xpvmg = new_XPVMG();
7545 StructCopy(SvANY(sv), xpvmg, XPVMG);
7546 del_XPVGV(SvANY(sv));
7549 SvFLAGS(sv) &= ~SVTYPEMASK;
7550 SvFLAGS(sv) |= SVt_PVMG;
7554 =for apidoc sv_unref_flags
7556 Unsets the RV status of the SV, and decrements the reference count of
7557 whatever was being referenced by the RV. This can almost be thought of
7558 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7559 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7560 (otherwise the decrementing is conditional on the reference count being
7561 different from one or the reference being a readonly SV).
7568 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7570 SV* const target = SvRV(ref);
7572 if (SvWEAKREF(ref)) {
7573 sv_del_backref(target, ref);
7575 SvRV_set(ref, NULL);
7578 SvRV_set(ref, NULL);
7580 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7581 assigned to as BEGIN {$a = \"Foo"} will fail. */
7582 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7583 SvREFCNT_dec(target);
7584 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7585 sv_2mortal(target); /* Schedule for freeing later */
7589 =for apidoc sv_untaint
7591 Untaint an SV. Use C<SvTAINTED_off> instead.
7596 Perl_sv_untaint(pTHX_ SV *sv)
7598 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7599 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7606 =for apidoc sv_tainted
7608 Test an SV for taintedness. Use C<SvTAINTED> instead.
7613 Perl_sv_tainted(pTHX_ SV *sv)
7615 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7616 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7617 if (mg && (mg->mg_len & 1) )
7624 =for apidoc sv_setpviv
7626 Copies an integer into the given SV, also updating its string value.
7627 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7633 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7635 char buf[TYPE_CHARS(UV)];
7637 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7639 sv_setpvn(sv, ptr, ebuf - ptr);
7643 =for apidoc sv_setpviv_mg
7645 Like C<sv_setpviv>, but also handles 'set' magic.
7651 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7657 #if defined(PERL_IMPLICIT_CONTEXT)
7659 /* pTHX_ magic can't cope with varargs, so this is a no-context
7660 * version of the main function, (which may itself be aliased to us).
7661 * Don't access this version directly.
7665 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7669 va_start(args, pat);
7670 sv_vsetpvf(sv, pat, &args);
7674 /* pTHX_ magic can't cope with varargs, so this is a no-context
7675 * version of the main function, (which may itself be aliased to us).
7676 * Don't access this version directly.
7680 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7684 va_start(args, pat);
7685 sv_vsetpvf_mg(sv, pat, &args);
7691 =for apidoc sv_setpvf
7693 Works like C<sv_catpvf> but copies the text into the SV instead of
7694 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7700 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7703 va_start(args, pat);
7704 sv_vsetpvf(sv, pat, &args);
7709 =for apidoc sv_vsetpvf
7711 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7712 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7714 Usually used via its frontend C<sv_setpvf>.
7720 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7722 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7726 =for apidoc sv_setpvf_mg
7728 Like C<sv_setpvf>, but also handles 'set' magic.
7734 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7737 va_start(args, pat);
7738 sv_vsetpvf_mg(sv, pat, &args);
7743 =for apidoc sv_vsetpvf_mg
7745 Like C<sv_vsetpvf>, but also handles 'set' magic.
7747 Usually used via its frontend C<sv_setpvf_mg>.
7753 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7755 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7759 #if defined(PERL_IMPLICIT_CONTEXT)
7761 /* pTHX_ magic can't cope with varargs, so this is a no-context
7762 * version of the main function, (which may itself be aliased to us).
7763 * Don't access this version directly.
7767 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7771 va_start(args, pat);
7772 sv_vcatpvf(sv, pat, &args);
7776 /* pTHX_ magic can't cope with varargs, so this is a no-context
7777 * version of the main function, (which may itself be aliased to us).
7778 * Don't access this version directly.
7782 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7786 va_start(args, pat);
7787 sv_vcatpvf_mg(sv, pat, &args);
7793 =for apidoc sv_catpvf
7795 Processes its arguments like C<sprintf> and appends the formatted
7796 output to an SV. If the appended data contains "wide" characters
7797 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7798 and characters >255 formatted with %c), the original SV might get
7799 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7800 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7801 valid UTF-8; if the original SV was bytes, the pattern should be too.
7806 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7809 va_start(args, pat);
7810 sv_vcatpvf(sv, pat, &args);
7815 =for apidoc sv_vcatpvf
7817 Processes its arguments like C<vsprintf> and appends the formatted output
7818 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7820 Usually used via its frontend C<sv_catpvf>.
7826 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7828 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7832 =for apidoc sv_catpvf_mg
7834 Like C<sv_catpvf>, but also handles 'set' magic.
7840 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7843 va_start(args, pat);
7844 sv_vcatpvf_mg(sv, pat, &args);
7849 =for apidoc sv_vcatpvf_mg
7851 Like C<sv_vcatpvf>, but also handles 'set' magic.
7853 Usually used via its frontend C<sv_catpvf_mg>.
7859 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7861 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7866 =for apidoc sv_vsetpvfn
7868 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7871 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7877 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7879 sv_setpvn(sv, "", 0);
7880 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7884 S_expect_number(pTHX_ char** pattern)
7888 switch (**pattern) {
7889 case '1': case '2': case '3':
7890 case '4': case '5': case '6':
7891 case '7': case '8': case '9':
7892 var = *(*pattern)++ - '0';
7893 while (isDIGIT(**pattern)) {
7894 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7896 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7904 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7906 const int neg = nv < 0;
7915 if (uv & 1 && uv == nv)
7916 uv--; /* Round to even */
7918 const unsigned dig = uv % 10;
7931 =for apidoc sv_vcatpvfn
7933 Processes its arguments like C<vsprintf> and appends the formatted output
7934 to an SV. Uses an array of SVs if the C style variable argument list is
7935 missing (NULL). When running with taint checks enabled, indicates via
7936 C<maybe_tainted> if results are untrustworthy (often due to the use of
7939 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7945 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7946 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7947 vec_utf8 = DO_UTF8(vecsv);
7949 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7952 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7960 static const char nullstr[] = "(null)";
7962 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7963 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7965 /* Times 4: a decimal digit takes more than 3 binary digits.
7966 * NV_DIG: mantissa takes than many decimal digits.
7967 * Plus 32: Playing safe. */
7968 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7969 /* large enough for "%#.#f" --chip */
7970 /* what about long double NVs? --jhi */
7972 PERL_UNUSED_ARG(maybe_tainted);
7974 /* no matter what, this is a string now */
7975 (void)SvPV_force(sv, origlen);
7977 /* special-case "", "%s", and "%-p" (SVf - see below) */
7980 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7982 const char * const s = va_arg(*args, char*);
7983 sv_catpv(sv, s ? s : nullstr);
7985 else if (svix < svmax) {
7986 sv_catsv(sv, *svargs);
7990 if (args && patlen == 3 && pat[0] == '%' &&
7991 pat[1] == '-' && pat[2] == 'p') {
7992 argsv = va_arg(*args, SV*);
7993 sv_catsv(sv, argsv);
7997 #ifndef USE_LONG_DOUBLE
7998 /* special-case "%.<number>[gf]" */
7999 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8000 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8001 unsigned digits = 0;
8005 while (*pp >= '0' && *pp <= '9')
8006 digits = 10 * digits + (*pp++ - '0');
8007 if (pp - pat == (int)patlen - 1) {
8015 /* Add check for digits != 0 because it seems that some
8016 gconverts are buggy in this case, and we don't yet have
8017 a Configure test for this. */
8018 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8019 /* 0, point, slack */
8020 Gconvert(nv, (int)digits, 0, ebuf);
8022 if (*ebuf) /* May return an empty string for digits==0 */
8025 } else if (!digits) {
8028 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8029 sv_catpvn(sv, p, l);
8035 #endif /* !USE_LONG_DOUBLE */
8037 if (!args && svix < svmax && DO_UTF8(*svargs))
8040 patend = (char*)pat + patlen;
8041 for (p = (char*)pat; p < patend; p = q) {
8044 bool vectorize = FALSE;
8045 bool vectorarg = FALSE;
8046 bool vec_utf8 = FALSE;
8052 bool has_precis = FALSE;
8054 const I32 osvix = svix;
8055 bool is_utf8 = FALSE; /* is this item utf8? */
8056 #ifdef HAS_LDBL_SPRINTF_BUG
8057 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8058 with sfio - Allen <allens@cpan.org> */
8059 bool fix_ldbl_sprintf_bug = FALSE;
8063 U8 utf8buf[UTF8_MAXBYTES+1];
8064 STRLEN esignlen = 0;
8066 const char *eptr = NULL;
8069 const U8 *vecstr = Null(U8*);
8076 /* we need a long double target in case HAS_LONG_DOUBLE but
8079 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8087 const char *dotstr = ".";
8088 STRLEN dotstrlen = 1;
8089 I32 efix = 0; /* explicit format parameter index */
8090 I32 ewix = 0; /* explicit width index */
8091 I32 epix = 0; /* explicit precision index */
8092 I32 evix = 0; /* explicit vector index */
8093 bool asterisk = FALSE;
8095 /* echo everything up to the next format specification */
8096 for (q = p; q < patend && *q != '%'; ++q) ;
8098 if (has_utf8 && !pat_utf8)
8099 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8101 sv_catpvn(sv, p, q - p);
8108 We allow format specification elements in this order:
8109 \d+\$ explicit format parameter index
8111 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8112 0 flag (as above): repeated to allow "v02"
8113 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8114 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8116 [%bcdefginopsuxDFOUX] format (mandatory)
8121 As of perl5.9.3, printf format checking is on by default.
8122 Internally, perl uses %p formats to provide an escape to
8123 some extended formatting. This block deals with those
8124 extensions: if it does not match, (char*)q is reset and
8125 the normal format processing code is used.
8127 Currently defined extensions are:
8128 %p include pointer address (standard)
8129 %-p (SVf) include an SV (previously %_)
8130 %-<num>p include an SV with precision <num>
8131 %1p (VDf) include a v-string (as %vd)
8132 %<num>p reserved for future extensions
8134 Robin Barker 2005-07-14
8141 n = expect_number(&q);
8148 argsv = va_arg(*args, SV*);
8149 eptr = SvPVx_const(argsv, elen);
8155 else if (n == vdNUMBER) { /* VDf */
8162 if (ckWARN_d(WARN_INTERNAL))
8163 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8164 "internal %%<num>p might conflict with future printf extensions");
8170 if ( (width = expect_number(&q)) ) {
8211 if ( (ewix = expect_number(&q)) )
8220 if ((vectorarg = asterisk)) {
8233 width = expect_number(&q);
8239 vecsv = va_arg(*args, SV*);
8241 vecsv = (evix > 0 && evix <= svmax)
8242 ? svargs[evix-1] : &PL_sv_undef;
8244 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8246 dotstr = SvPV_const(vecsv, dotstrlen);
8247 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8248 bad with tied or overloaded values that return UTF8. */
8251 else if (has_utf8) {
8252 vecsv = sv_mortalcopy(vecsv);
8253 sv_utf8_upgrade(vecsv);
8254 dotstr = SvPV_const(vecsv, dotstrlen);
8261 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8262 vecsv = svargs[efix ? efix-1 : svix++];
8263 vecstr = (U8*)SvPV_const(vecsv,veclen);
8264 vec_utf8 = DO_UTF8(vecsv);
8266 /* if this is a version object, we need to convert
8267 * back into v-string notation and then let the
8268 * vectorize happen normally
8270 if (sv_derived_from(vecsv, "version")) {
8271 char *version = savesvpv(vecsv);
8272 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8273 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8274 "vector argument not supported with alpha versions");
8277 vecsv = sv_newmortal();
8278 /* scan_vstring is expected to be called during
8279 * tokenization, so we need to fake up the end
8280 * of the buffer for it
8282 PL_bufend = version + veclen;
8283 scan_vstring(version, vecsv);
8284 vecstr = (U8*)SvPV_const(vecsv, veclen);
8285 vec_utf8 = DO_UTF8(vecsv);
8297 i = va_arg(*args, int);
8299 i = (ewix ? ewix <= svmax : svix < svmax) ?
8300 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8302 width = (i < 0) ? -i : i;
8312 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8314 /* XXX: todo, support specified precision parameter */
8318 i = va_arg(*args, int);
8320 i = (ewix ? ewix <= svmax : svix < svmax)
8321 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8322 precis = (i < 0) ? 0 : i;
8327 precis = precis * 10 + (*q++ - '0');
8336 case 'I': /* Ix, I32x, and I64x */
8338 if (q[1] == '6' && q[2] == '4') {
8344 if (q[1] == '3' && q[2] == '2') {
8354 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8365 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8366 if (*(q + 1) == 'l') { /* lld, llf */
8392 if (!vectorize && !args) {
8394 const I32 i = efix-1;
8395 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8397 argsv = (svix >= 0 && svix < svmax)
8398 ? svargs[svix++] : &PL_sv_undef;
8409 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8411 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8413 eptr = (char*)utf8buf;
8414 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8428 eptr = va_arg(*args, char*);
8430 #ifdef MACOS_TRADITIONAL
8431 /* On MacOS, %#s format is used for Pascal strings */
8436 elen = strlen(eptr);
8438 eptr = (char *)nullstr;
8439 elen = sizeof nullstr - 1;
8443 eptr = SvPVx_const(argsv, elen);
8444 if (DO_UTF8(argsv)) {
8445 if (has_precis && precis < elen) {
8447 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8450 if (width) { /* fudge width (can't fudge elen) */
8451 width += elen - sv_len_utf8(argsv);
8458 if (has_precis && elen > precis)
8465 if (alt || vectorize)
8467 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8488 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8497 esignbuf[esignlen++] = plus;
8501 case 'h': iv = (short)va_arg(*args, int); break;
8502 case 'l': iv = va_arg(*args, long); break;
8503 case 'V': iv = va_arg(*args, IV); break;
8504 default: iv = va_arg(*args, int); break;
8506 case 'q': iv = va_arg(*args, Quad_t); break;
8511 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8513 case 'h': iv = (short)tiv; break;
8514 case 'l': iv = (long)tiv; break;
8516 default: iv = tiv; break;
8518 case 'q': iv = (Quad_t)tiv; break;
8522 if ( !vectorize ) /* we already set uv above */
8527 esignbuf[esignlen++] = plus;
8531 esignbuf[esignlen++] = '-';
8574 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8585 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8586 case 'l': uv = va_arg(*args, unsigned long); break;
8587 case 'V': uv = va_arg(*args, UV); break;
8588 default: uv = va_arg(*args, unsigned); break;
8590 case 'q': uv = va_arg(*args, Uquad_t); break;
8595 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8597 case 'h': uv = (unsigned short)tuv; break;
8598 case 'l': uv = (unsigned long)tuv; break;
8600 default: uv = tuv; break;
8602 case 'q': uv = (Uquad_t)tuv; break;
8609 char *ptr = ebuf + sizeof ebuf;
8615 p = (char*)((c == 'X')
8616 ? "0123456789ABCDEF" : "0123456789abcdef");
8622 esignbuf[esignlen++] = '0';
8623 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8631 if (alt && *ptr != '0')
8642 esignbuf[esignlen++] = '0';
8643 esignbuf[esignlen++] = 'b';
8646 default: /* it had better be ten or less */
8650 } while (uv /= base);
8653 elen = (ebuf + sizeof ebuf) - ptr;
8657 zeros = precis - elen;
8658 else if (precis == 0 && elen == 1 && *eptr == '0')
8664 /* FLOATING POINT */
8667 c = 'f'; /* maybe %F isn't supported here */
8675 /* This is evil, but floating point is even more evil */
8677 /* for SV-style calling, we can only get NV
8678 for C-style calling, we assume %f is double;
8679 for simplicity we allow any of %Lf, %llf, %qf for long double
8683 #if defined(USE_LONG_DOUBLE)
8687 /* [perl #20339] - we should accept and ignore %lf rather than die */
8691 #if defined(USE_LONG_DOUBLE)
8692 intsize = args ? 0 : 'q';
8696 #if defined(HAS_LONG_DOUBLE)
8705 /* now we need (long double) if intsize == 'q', else (double) */
8707 #if LONG_DOUBLESIZE > DOUBLESIZE
8709 va_arg(*args, long double) :
8710 va_arg(*args, double)
8712 va_arg(*args, double)
8717 if (c != 'e' && c != 'E') {
8719 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8720 will cast our (long double) to (double) */
8721 (void)Perl_frexp(nv, &i);
8722 if (i == PERL_INT_MIN)
8723 Perl_die(aTHX_ "panic: frexp");
8725 need = BIT_DIGITS(i);
8727 need += has_precis ? precis : 6; /* known default */
8732 #ifdef HAS_LDBL_SPRINTF_BUG
8733 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8734 with sfio - Allen <allens@cpan.org> */
8737 # define MY_DBL_MAX DBL_MAX
8738 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8739 # if DOUBLESIZE >= 8
8740 # define MY_DBL_MAX 1.7976931348623157E+308L
8742 # define MY_DBL_MAX 3.40282347E+38L
8746 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8747 # define MY_DBL_MAX_BUG 1L
8749 # define MY_DBL_MAX_BUG MY_DBL_MAX
8753 # define MY_DBL_MIN DBL_MIN
8754 # else /* XXX guessing! -Allen */
8755 # if DOUBLESIZE >= 8
8756 # define MY_DBL_MIN 2.2250738585072014E-308L
8758 # define MY_DBL_MIN 1.17549435E-38L
8762 if ((intsize == 'q') && (c == 'f') &&
8763 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8765 /* it's going to be short enough that
8766 * long double precision is not needed */
8768 if ((nv <= 0L) && (nv >= -0L))
8769 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8771 /* would use Perl_fp_class as a double-check but not
8772 * functional on IRIX - see perl.h comments */
8774 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8775 /* It's within the range that a double can represent */
8776 #if defined(DBL_MAX) && !defined(DBL_MIN)
8777 if ((nv >= ((long double)1/DBL_MAX)) ||
8778 (nv <= (-(long double)1/DBL_MAX)))
8780 fix_ldbl_sprintf_bug = TRUE;
8783 if (fix_ldbl_sprintf_bug == TRUE) {
8793 # undef MY_DBL_MAX_BUG
8796 #endif /* HAS_LDBL_SPRINTF_BUG */
8798 need += 20; /* fudge factor */
8799 if (PL_efloatsize < need) {
8800 Safefree(PL_efloatbuf);
8801 PL_efloatsize = need + 20; /* more fudge */
8802 Newx(PL_efloatbuf, PL_efloatsize, char);
8803 PL_efloatbuf[0] = '\0';
8806 if ( !(width || left || plus || alt) && fill != '0'
8807 && has_precis && intsize != 'q' ) { /* Shortcuts */
8808 /* See earlier comment about buggy Gconvert when digits,
8810 if ( c == 'g' && precis) {
8811 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8812 /* May return an empty string for digits==0 */
8813 if (*PL_efloatbuf) {
8814 elen = strlen(PL_efloatbuf);
8815 goto float_converted;
8817 } else if ( c == 'f' && !precis) {
8818 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8823 char *ptr = ebuf + sizeof ebuf;
8826 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8827 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8828 if (intsize == 'q') {
8829 /* Copy the one or more characters in a long double
8830 * format before the 'base' ([efgEFG]) character to
8831 * the format string. */
8832 static char const prifldbl[] = PERL_PRIfldbl;
8833 char const *p = prifldbl + sizeof(prifldbl) - 3;
8834 while (p >= prifldbl) { *--ptr = *p--; }
8839 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8844 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8856 /* No taint. Otherwise we are in the strange situation
8857 * where printf() taints but print($float) doesn't.
8859 #if defined(HAS_LONG_DOUBLE)
8860 elen = ((intsize == 'q')
8861 ? my_sprintf(PL_efloatbuf, ptr, nv)
8862 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8864 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8868 eptr = PL_efloatbuf;
8876 i = SvCUR(sv) - origlen;
8879 case 'h': *(va_arg(*args, short*)) = i; break;
8880 default: *(va_arg(*args, int*)) = i; break;
8881 case 'l': *(va_arg(*args, long*)) = i; break;
8882 case 'V': *(va_arg(*args, IV*)) = i; break;
8884 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8889 sv_setuv_mg(argsv, (UV)i);
8890 continue; /* not "break" */
8897 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8898 && ckWARN(WARN_PRINTF))
8900 SV * const msg = sv_newmortal();
8901 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8902 (PL_op->op_type == OP_PRTF) ? "" : "s");
8905 Perl_sv_catpvf(aTHX_ msg,
8906 "\"%%%c\"", c & 0xFF);
8908 Perl_sv_catpvf(aTHX_ msg,
8909 "\"%%\\%03"UVof"\"",
8912 sv_catpvs(msg, "end of string");
8913 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8916 /* output mangled stuff ... */
8922 /* ... right here, because formatting flags should not apply */
8923 SvGROW(sv, SvCUR(sv) + elen + 1);
8925 Copy(eptr, p, elen, char);
8928 SvCUR_set(sv, p - SvPVX_const(sv));
8930 continue; /* not "break" */
8933 /* calculate width before utf8_upgrade changes it */
8934 have = esignlen + zeros + elen;
8936 Perl_croak_nocontext(PL_memory_wrap);
8938 if (is_utf8 != has_utf8) {
8941 sv_utf8_upgrade(sv);
8944 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8945 sv_utf8_upgrade(nsv);
8946 eptr = SvPVX_const(nsv);
8949 SvGROW(sv, SvCUR(sv) + elen + 1);
8954 need = (have > width ? have : width);
8957 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8958 Perl_croak_nocontext(PL_memory_wrap);
8959 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8961 if (esignlen && fill == '0') {
8963 for (i = 0; i < (int)esignlen; i++)
8967 memset(p, fill, gap);
8970 if (esignlen && fill != '0') {
8972 for (i = 0; i < (int)esignlen; i++)
8977 for (i = zeros; i; i--)
8981 Copy(eptr, p, elen, char);
8985 memset(p, ' ', gap);
8990 Copy(dotstr, p, dotstrlen, char);
8994 vectorize = FALSE; /* done iterating over vecstr */
9001 SvCUR_set(sv, p - SvPVX_const(sv));
9009 /* =========================================================================
9011 =head1 Cloning an interpreter
9013 All the macros and functions in this section are for the private use of
9014 the main function, perl_clone().
9016 The foo_dup() functions make an exact copy of an existing foo thinngy.
9017 During the course of a cloning, a hash table is used to map old addresses
9018 to new addresses. The table is created and manipulated with the
9019 ptr_table_* functions.
9023 ============================================================================*/
9026 #if defined(USE_ITHREADS)
9028 #ifndef GpREFCNT_inc
9029 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9033 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9034 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9035 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9036 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9037 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9038 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9039 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9040 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9041 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9042 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9043 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9044 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9045 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9048 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9049 regcomp.c. AMS 20010712 */
9052 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9057 struct reg_substr_datum *s;
9060 return (REGEXP *)NULL;
9062 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9065 len = r->offsets[0];
9066 npar = r->nparens+1;
9068 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9069 Copy(r->program, ret->program, len+1, regnode);
9071 Newx(ret->startp, npar, I32);
9072 Copy(r->startp, ret->startp, npar, I32);
9073 Newx(ret->endp, npar, I32);
9074 Copy(r->startp, ret->startp, npar, I32);
9076 Newx(ret->substrs, 1, struct reg_substr_data);
9077 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9078 s->min_offset = r->substrs->data[i].min_offset;
9079 s->max_offset = r->substrs->data[i].max_offset;
9080 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9081 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9084 ret->regstclass = NULL;
9087 const int count = r->data->count;
9090 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9091 char, struct reg_data);
9092 Newx(d->what, count, U8);
9095 for (i = 0; i < count; i++) {
9096 d->what[i] = r->data->what[i];
9097 switch (d->what[i]) {
9098 /* legal options are one of: sfpont
9099 see also regcomp.h and pregfree() */
9101 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9104 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9107 /* This is cheating. */
9108 Newx(d->data[i], 1, struct regnode_charclass_class);
9109 StructCopy(r->data->data[i], d->data[i],
9110 struct regnode_charclass_class);
9111 ret->regstclass = (regnode*)d->data[i];
9114 /* Compiled op trees are readonly, and can thus be
9115 shared without duplication. */
9117 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9121 d->data[i] = r->data->data[i];
9124 d->data[i] = r->data->data[i];
9126 ((reg_trie_data*)d->data[i])->refcount++;
9130 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9139 Newx(ret->offsets, 2*len+1, U32);
9140 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9142 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9143 ret->refcnt = r->refcnt;
9144 ret->minlen = r->minlen;
9145 ret->prelen = r->prelen;
9146 ret->nparens = r->nparens;
9147 ret->lastparen = r->lastparen;
9148 ret->lastcloseparen = r->lastcloseparen;
9149 ret->reganch = r->reganch;
9151 ret->sublen = r->sublen;
9153 if (RX_MATCH_COPIED(ret))
9154 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9157 #ifdef PERL_OLD_COPY_ON_WRITE
9158 ret->saved_copy = NULL;
9161 ptr_table_store(PL_ptr_table, r, ret);
9165 /* duplicate a file handle */
9168 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9172 PERL_UNUSED_ARG(type);
9175 return (PerlIO*)NULL;
9177 /* look for it in the table first */
9178 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9182 /* create anew and remember what it is */
9183 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9184 ptr_table_store(PL_ptr_table, fp, ret);
9188 /* duplicate a directory handle */
9191 Perl_dirp_dup(pTHX_ DIR *dp)
9199 /* duplicate a typeglob */
9202 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9207 /* look for it in the table first */
9208 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9212 /* create anew and remember what it is */
9214 ptr_table_store(PL_ptr_table, gp, ret);
9217 ret->gp_refcnt = 0; /* must be before any other dups! */
9218 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9219 ret->gp_io = io_dup_inc(gp->gp_io, param);
9220 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9221 ret->gp_av = av_dup_inc(gp->gp_av, param);
9222 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9223 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9224 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9225 ret->gp_cvgen = gp->gp_cvgen;
9226 ret->gp_line = gp->gp_line;
9227 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9231 /* duplicate a chain of magic */
9234 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9236 MAGIC *mgprev = (MAGIC*)NULL;
9239 return (MAGIC*)NULL;
9240 /* look for it in the table first */
9241 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9245 for (; mg; mg = mg->mg_moremagic) {
9247 Newxz(nmg, 1, MAGIC);
9249 mgprev->mg_moremagic = nmg;
9252 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9253 nmg->mg_private = mg->mg_private;
9254 nmg->mg_type = mg->mg_type;
9255 nmg->mg_flags = mg->mg_flags;
9256 if (mg->mg_type == PERL_MAGIC_qr) {
9257 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9259 else if(mg->mg_type == PERL_MAGIC_backref) {
9260 /* The backref AV has its reference count deliberately bumped by
9262 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9264 else if (mg->mg_type == PERL_MAGIC_symtab) {
9265 nmg->mg_obj = mg->mg_obj;
9268 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9269 ? sv_dup_inc(mg->mg_obj, param)
9270 : sv_dup(mg->mg_obj, param);
9272 nmg->mg_len = mg->mg_len;
9273 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9274 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9275 if (mg->mg_len > 0) {
9276 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9277 if (mg->mg_type == PERL_MAGIC_overload_table &&
9278 AMT_AMAGIC((AMT*)mg->mg_ptr))
9280 const AMT * const amtp = (AMT*)mg->mg_ptr;
9281 AMT * const namtp = (AMT*)nmg->mg_ptr;
9283 for (i = 1; i < NofAMmeth; i++) {
9284 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9288 else if (mg->mg_len == HEf_SVKEY)
9289 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9291 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9292 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9299 /* create a new pointer-mapping table */
9302 Perl_ptr_table_new(pTHX)
9305 Newxz(tbl, 1, PTR_TBL_t);
9308 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9312 #define PTR_TABLE_HASH(ptr) \
9313 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9316 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9317 following define) and at call to new_body_inline made below in
9318 Perl_ptr_table_store()
9321 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9323 /* map an existing pointer using a table */
9325 STATIC PTR_TBL_ENT_t *
9326 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9327 PTR_TBL_ENT_t *tblent;
9328 const UV hash = PTR_TABLE_HASH(sv);
9330 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9331 for (; tblent; tblent = tblent->next) {
9332 if (tblent->oldval == sv)
9339 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9341 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9342 return tblent ? tblent->newval : (void *) 0;
9345 /* add a new entry to a pointer-mapping table */
9348 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9350 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9353 tblent->newval = newsv;
9355 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9357 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9358 tblent->oldval = oldsv;
9359 tblent->newval = newsv;
9360 tblent->next = tbl->tbl_ary[entry];
9361 tbl->tbl_ary[entry] = tblent;
9363 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9364 ptr_table_split(tbl);
9368 /* double the hash bucket size of an existing ptr table */
9371 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9373 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9374 const UV oldsize = tbl->tbl_max + 1;
9375 UV newsize = oldsize * 2;
9378 Renew(ary, newsize, PTR_TBL_ENT_t*);
9379 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9380 tbl->tbl_max = --newsize;
9382 for (i=0; i < oldsize; i++, ary++) {
9383 PTR_TBL_ENT_t **curentp, **entp, *ent;
9386 curentp = ary + oldsize;
9387 for (entp = ary, ent = *ary; ent; ent = *entp) {
9388 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9390 ent->next = *curentp;
9400 /* remove all the entries from a ptr table */
9403 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9405 if (tbl && tbl->tbl_items) {
9406 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9407 UV riter = tbl->tbl_max;
9410 PTR_TBL_ENT_t *entry = array[riter];
9413 PTR_TBL_ENT_t * const oentry = entry;
9414 entry = entry->next;
9423 /* clear and free a ptr table */
9426 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9431 ptr_table_clear(tbl);
9432 Safefree(tbl->tbl_ary);
9438 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9441 SvRV_set(dstr, SvWEAKREF(sstr)
9442 ? sv_dup(SvRV(sstr), param)
9443 : sv_dup_inc(SvRV(sstr), param));
9446 else if (SvPVX_const(sstr)) {
9447 /* Has something there */
9449 /* Normal PV - clone whole allocated space */
9450 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9451 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9452 /* Not that normal - actually sstr is copy on write.
9453 But we are a true, independant SV, so: */
9454 SvREADONLY_off(dstr);
9459 /* Special case - not normally malloced for some reason */
9460 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9461 /* A "shared" PV - clone it as "shared" PV */
9463 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9467 /* Some other special case - random pointer */
9468 SvPV_set(dstr, SvPVX(sstr));
9474 if (SvTYPE(dstr) == SVt_RV)
9475 SvRV_set(dstr, NULL);
9477 SvPV_set(dstr, NULL);
9481 /* duplicate an SV of any type (including AV, HV etc) */
9484 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9489 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9491 /* look for it in the table first */
9492 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9496 if(param->flags & CLONEf_JOIN_IN) {
9497 /** We are joining here so we don't want do clone
9498 something that is bad **/
9499 if (SvTYPE(sstr) == SVt_PVHV) {
9500 const char * const hvname = HvNAME_get(sstr);
9502 /** don't clone stashes if they already exist **/
9503 return (SV*)gv_stashpv(hvname,0);
9507 /* create anew and remember what it is */
9510 #ifdef DEBUG_LEAKING_SCALARS
9511 dstr->sv_debug_optype = sstr->sv_debug_optype;
9512 dstr->sv_debug_line = sstr->sv_debug_line;
9513 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9514 dstr->sv_debug_cloned = 1;
9515 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9518 ptr_table_store(PL_ptr_table, sstr, dstr);
9521 SvFLAGS(dstr) = SvFLAGS(sstr);
9522 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9523 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9526 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9527 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9528 PL_watch_pvx, SvPVX_const(sstr));
9531 /* don't clone objects whose class has asked us not to */
9532 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9533 SvFLAGS(dstr) &= ~SVTYPEMASK;
9538 switch (SvTYPE(sstr)) {
9543 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9544 SvIV_set(dstr, SvIVX(sstr));
9547 SvANY(dstr) = new_XNV();
9548 SvNV_set(dstr, SvNVX(sstr));
9551 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9552 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9556 /* These are all the types that need complex bodies allocating. */
9558 const svtype sv_type = SvTYPE(sstr);
9559 const struct body_details *const sv_type_details
9560 = bodies_by_type + sv_type;
9564 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9569 if (GvUNIQUE((GV*)sstr)) {
9570 /* Do sharing here, and fall through */
9583 assert(sv_type_details->size);
9584 if (sv_type_details->arena) {
9585 new_body_inline(new_body, sv_type_details->size, sv_type);
9587 = (void*)((char*)new_body - sv_type_details->offset);
9589 new_body = new_NOARENA(sv_type_details);
9593 SvANY(dstr) = new_body;
9596 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9597 ((char*)SvANY(dstr)) + sv_type_details->offset,
9598 sv_type_details->copy, char);
9600 Copy(((char*)SvANY(sstr)),
9601 ((char*)SvANY(dstr)),
9602 sv_type_details->size + sv_type_details->offset, char);
9605 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9606 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9608 /* The Copy above means that all the source (unduplicated) pointers
9609 are now in the destination. We can check the flags and the
9610 pointers in either, but it's possible that there's less cache
9611 missing by always going for the destination.
9612 FIXME - instrument and check that assumption */
9613 if (sv_type >= SVt_PVMG) {
9615 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9617 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9620 /* The cast silences a GCC warning about unhandled types. */
9621 switch ((int)sv_type) {
9633 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9634 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9635 LvTARG(dstr) = dstr;
9636 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9637 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9639 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9642 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9643 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9644 /* Don't call sv_add_backref here as it's going to be created
9645 as part of the magic cloning of the symbol table. */
9646 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9647 (void)GpREFCNT_inc(GvGP(dstr));
9650 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9651 if (IoOFP(dstr) == IoIFP(sstr))
9652 IoOFP(dstr) = IoIFP(dstr);
9654 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9655 /* PL_rsfp_filters entries have fake IoDIRP() */
9656 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9657 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9658 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9659 /* I have no idea why fake dirp (rsfps)
9660 should be treated differently but otherwise
9661 we end up with leaks -- sky*/
9662 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9663 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9664 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9666 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9667 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9668 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9670 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9671 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9672 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9675 if (AvARRAY((AV*)sstr)) {
9676 SV **dst_ary, **src_ary;
9677 SSize_t items = AvFILLp((AV*)sstr) + 1;
9679 src_ary = AvARRAY((AV*)sstr);
9680 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9681 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9682 SvPV_set(dstr, (char*)dst_ary);
9683 AvALLOC((AV*)dstr) = dst_ary;
9684 if (AvREAL((AV*)sstr)) {
9686 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9690 *dst_ary++ = sv_dup(*src_ary++, param);
9692 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9693 while (items-- > 0) {
9694 *dst_ary++ = &PL_sv_undef;
9698 SvPV_set(dstr, NULL);
9699 AvALLOC((AV*)dstr) = (SV**)NULL;
9706 if (HvARRAY((HV*)sstr)) {
9708 const bool sharekeys = !!HvSHAREKEYS(sstr);
9709 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9710 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9712 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9713 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9715 HvARRAY(dstr) = (HE**)darray;
9716 while (i <= sxhv->xhv_max) {
9717 const HE *source = HvARRAY(sstr)[i];
9718 HvARRAY(dstr)[i] = source
9719 ? he_dup(source, sharekeys, param) : 0;
9723 struct xpvhv_aux * const saux = HvAUX(sstr);
9724 struct xpvhv_aux * const daux = HvAUX(dstr);
9725 /* This flag isn't copied. */
9726 /* SvOOK_on(hv) attacks the IV flags. */
9727 SvFLAGS(dstr) |= SVf_OOK;
9729 hvname = saux->xhv_name;
9731 = hvname ? hek_dup(hvname, param) : hvname;
9733 daux->xhv_riter = saux->xhv_riter;
9734 daux->xhv_eiter = saux->xhv_eiter
9735 ? he_dup(saux->xhv_eiter,
9736 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9737 daux->xhv_backreferences = saux->xhv_backreferences
9738 ? (AV*) SvREFCNT_inc(
9746 SvPV_set(dstr, NULL);
9748 /* Record stashes for possible cloning in Perl_clone(). */
9750 av_push(param->stashes, dstr);
9755 /* NOTE: not refcounted */
9756 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9758 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9760 if (CvCONST(dstr)) {
9761 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9762 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9763 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9765 /* don't dup if copying back - CvGV isn't refcounted, so the
9766 * duped GV may never be freed. A bit of a hack! DAPM */
9767 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9768 NULL : gv_dup(CvGV(dstr), param) ;
9769 if (!(param->flags & CLONEf_COPY_STACKS)) {
9772 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9775 ? cv_dup( CvOUTSIDE(dstr), param)
9776 : cv_dup_inc(CvOUTSIDE(dstr), param);
9778 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9784 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9790 /* duplicate a context */
9793 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9798 return (PERL_CONTEXT*)NULL;
9800 /* look for it in the table first */
9801 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9805 /* create anew and remember what it is */
9806 Newxz(ncxs, max + 1, PERL_CONTEXT);
9807 ptr_table_store(PL_ptr_table, cxs, ncxs);
9810 PERL_CONTEXT * const cx = &cxs[ix];
9811 PERL_CONTEXT * const ncx = &ncxs[ix];
9812 ncx->cx_type = cx->cx_type;
9813 if (CxTYPE(cx) == CXt_SUBST) {
9814 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9817 ncx->blk_oldsp = cx->blk_oldsp;
9818 ncx->blk_oldcop = cx->blk_oldcop;
9819 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9820 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9821 ncx->blk_oldpm = cx->blk_oldpm;
9822 ncx->blk_gimme = cx->blk_gimme;
9823 switch (CxTYPE(cx)) {
9825 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9826 ? cv_dup_inc(cx->blk_sub.cv, param)
9827 : cv_dup(cx->blk_sub.cv,param));
9828 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9829 ? av_dup_inc(cx->blk_sub.argarray, param)
9831 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9832 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9833 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9834 ncx->blk_sub.lval = cx->blk_sub.lval;
9835 ncx->blk_sub.retop = cx->blk_sub.retop;
9838 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9839 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9840 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9841 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9842 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9843 ncx->blk_eval.retop = cx->blk_eval.retop;
9846 ncx->blk_loop.label = cx->blk_loop.label;
9847 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9848 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9849 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9850 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9851 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9852 ? cx->blk_loop.iterdata
9853 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9854 ncx->blk_loop.oldcomppad
9855 = (PAD*)ptr_table_fetch(PL_ptr_table,
9856 cx->blk_loop.oldcomppad);
9857 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9858 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9859 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9860 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9861 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9864 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9865 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9866 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9867 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9868 ncx->blk_sub.retop = cx->blk_sub.retop;
9880 /* duplicate a stack info structure */
9883 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9888 return (PERL_SI*)NULL;
9890 /* look for it in the table first */
9891 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9895 /* create anew and remember what it is */
9896 Newxz(nsi, 1, PERL_SI);
9897 ptr_table_store(PL_ptr_table, si, nsi);
9899 nsi->si_stack = av_dup_inc(si->si_stack, param);
9900 nsi->si_cxix = si->si_cxix;
9901 nsi->si_cxmax = si->si_cxmax;
9902 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9903 nsi->si_type = si->si_type;
9904 nsi->si_prev = si_dup(si->si_prev, param);
9905 nsi->si_next = si_dup(si->si_next, param);
9906 nsi->si_markoff = si->si_markoff;
9911 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9912 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9913 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9914 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9915 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9916 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9917 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9918 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9919 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9920 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9921 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9922 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9923 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9924 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9927 #define pv_dup_inc(p) SAVEPV(p)
9928 #define pv_dup(p) SAVEPV(p)
9929 #define svp_dup_inc(p,pp) any_dup(p,pp)
9931 /* map any object to the new equivent - either something in the
9932 * ptr table, or something in the interpreter structure
9936 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9943 /* look for it in the table first */
9944 ret = ptr_table_fetch(PL_ptr_table, v);
9948 /* see if it is part of the interpreter structure */
9949 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9950 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9958 /* duplicate the save stack */
9961 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9963 ANY * const ss = proto_perl->Tsavestack;
9964 const I32 max = proto_perl->Tsavestack_max;
9965 I32 ix = proto_perl->Tsavestack_ix;
9977 void (*dptr) (void*);
9978 void (*dxptr) (pTHX_ void*);
9980 Newxz(nss, max, ANY);
9983 I32 i = POPINT(ss,ix);
9986 case SAVEt_ITEM: /* normal string */
9987 sv = (SV*)POPPTR(ss,ix);
9988 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9989 sv = (SV*)POPPTR(ss,ix);
9990 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9992 case SAVEt_SV: /* scalar reference */
9993 sv = (SV*)POPPTR(ss,ix);
9994 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9995 gv = (GV*)POPPTR(ss,ix);
9996 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9998 case SAVEt_GENERIC_PVREF: /* generic char* */
9999 c = (char*)POPPTR(ss,ix);
10000 TOPPTR(nss,ix) = pv_dup(c);
10001 ptr = POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10004 case SAVEt_SHARED_PVREF: /* char* in shared space */
10005 c = (char*)POPPTR(ss,ix);
10006 TOPPTR(nss,ix) = savesharedpv(c);
10007 ptr = POPPTR(ss,ix);
10008 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10010 case SAVEt_GENERIC_SVREF: /* generic sv */
10011 case SAVEt_SVREF: /* scalar reference */
10012 sv = (SV*)POPPTR(ss,ix);
10013 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10014 ptr = POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10017 case SAVEt_AV: /* array reference */
10018 av = (AV*)POPPTR(ss,ix);
10019 TOPPTR(nss,ix) = av_dup_inc(av, param);
10020 gv = (GV*)POPPTR(ss,ix);
10021 TOPPTR(nss,ix) = gv_dup(gv, param);
10023 case SAVEt_HV: /* hash reference */
10024 hv = (HV*)POPPTR(ss,ix);
10025 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10026 gv = (GV*)POPPTR(ss,ix);
10027 TOPPTR(nss,ix) = gv_dup(gv, param);
10029 case SAVEt_INT: /* int reference */
10030 ptr = POPPTR(ss,ix);
10031 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10032 intval = (int)POPINT(ss,ix);
10033 TOPINT(nss,ix) = intval;
10035 case SAVEt_LONG: /* long reference */
10036 ptr = POPPTR(ss,ix);
10037 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10038 longval = (long)POPLONG(ss,ix);
10039 TOPLONG(nss,ix) = longval;
10041 case SAVEt_I32: /* I32 reference */
10042 case SAVEt_I16: /* I16 reference */
10043 case SAVEt_I8: /* I8 reference */
10044 ptr = POPPTR(ss,ix);
10045 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10047 TOPINT(nss,ix) = i;
10049 case SAVEt_IV: /* IV reference */
10050 ptr = POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10053 TOPIV(nss,ix) = iv;
10055 case SAVEt_SPTR: /* SV* reference */
10056 ptr = POPPTR(ss,ix);
10057 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10058 sv = (SV*)POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = sv_dup(sv, param);
10061 case SAVEt_VPTR: /* random* reference */
10062 ptr = POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10064 ptr = POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10067 case SAVEt_PPTR: /* char* reference */
10068 ptr = POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10070 c = (char*)POPPTR(ss,ix);
10071 TOPPTR(nss,ix) = pv_dup(c);
10073 case SAVEt_HPTR: /* HV* reference */
10074 ptr = POPPTR(ss,ix);
10075 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10076 hv = (HV*)POPPTR(ss,ix);
10077 TOPPTR(nss,ix) = hv_dup(hv, param);
10079 case SAVEt_APTR: /* AV* reference */
10080 ptr = POPPTR(ss,ix);
10081 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10082 av = (AV*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = av_dup(av, param);
10086 gv = (GV*)POPPTR(ss,ix);
10087 TOPPTR(nss,ix) = gv_dup(gv, param);
10089 case SAVEt_GP: /* scalar reference */
10090 gp = (GP*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10092 (void)GpREFCNT_inc(gp);
10093 gv = (GV*)POPPTR(ss,ix);
10094 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10095 c = (char*)POPPTR(ss,ix);
10096 TOPPTR(nss,ix) = pv_dup(c);
10098 TOPIV(nss,ix) = iv;
10100 TOPIV(nss,ix) = iv;
10103 case SAVEt_MORTALIZESV:
10104 sv = (SV*)POPPTR(ss,ix);
10105 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10108 ptr = POPPTR(ss,ix);
10109 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10110 /* these are assumed to be refcounted properly */
10112 switch (((OP*)ptr)->op_type) {
10114 case OP_LEAVESUBLV:
10118 case OP_LEAVEWRITE:
10119 TOPPTR(nss,ix) = ptr;
10124 TOPPTR(nss,ix) = Nullop;
10129 TOPPTR(nss,ix) = Nullop;
10132 c = (char*)POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = pv_dup_inc(c);
10135 case SAVEt_CLEARSV:
10136 longval = POPLONG(ss,ix);
10137 TOPLONG(nss,ix) = longval;
10140 hv = (HV*)POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10142 c = (char*)POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = pv_dup_inc(c);
10145 TOPINT(nss,ix) = i;
10147 case SAVEt_DESTRUCTOR:
10148 ptr = POPPTR(ss,ix);
10149 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10150 dptr = POPDPTR(ss,ix);
10151 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10152 any_dup(FPTR2DPTR(void *, dptr),
10155 case SAVEt_DESTRUCTOR_X:
10156 ptr = POPPTR(ss,ix);
10157 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10158 dxptr = POPDXPTR(ss,ix);
10159 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10160 any_dup(FPTR2DPTR(void *, dxptr),
10163 case SAVEt_REGCONTEXT:
10166 TOPINT(nss,ix) = i;
10169 case SAVEt_STACK_POS: /* Position on Perl stack */
10171 TOPINT(nss,ix) = i;
10173 case SAVEt_AELEM: /* array element */
10174 sv = (SV*)POPPTR(ss,ix);
10175 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10177 TOPINT(nss,ix) = i;
10178 av = (AV*)POPPTR(ss,ix);
10179 TOPPTR(nss,ix) = av_dup_inc(av, param);
10181 case SAVEt_HELEM: /* hash element */
10182 sv = (SV*)POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10184 sv = (SV*)POPPTR(ss,ix);
10185 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10186 hv = (HV*)POPPTR(ss,ix);
10187 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10190 ptr = POPPTR(ss,ix);
10191 TOPPTR(nss,ix) = ptr;
10195 TOPINT(nss,ix) = i;
10197 case SAVEt_COMPPAD:
10198 av = (AV*)POPPTR(ss,ix);
10199 TOPPTR(nss,ix) = av_dup(av, param);
10202 longval = (long)POPLONG(ss,ix);
10203 TOPLONG(nss,ix) = longval;
10204 ptr = POPPTR(ss,ix);
10205 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10206 sv = (SV*)POPPTR(ss,ix);
10207 TOPPTR(nss,ix) = sv_dup(sv, param);
10210 ptr = POPPTR(ss,ix);
10211 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10212 longval = (long)POPBOOL(ss,ix);
10213 TOPBOOL(nss,ix) = (bool)longval;
10215 case SAVEt_SET_SVFLAGS:
10217 TOPINT(nss,ix) = i;
10219 TOPINT(nss,ix) = i;
10220 sv = (SV*)POPPTR(ss,ix);
10221 TOPPTR(nss,ix) = sv_dup(sv, param);
10224 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10232 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10233 * flag to the result. This is done for each stash before cloning starts,
10234 * so we know which stashes want their objects cloned */
10237 do_mark_cloneable_stash(pTHX_ SV *sv)
10239 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10241 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10242 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10243 if (cloner && GvCV(cloner)) {
10250 XPUSHs(sv_2mortal(newSVhek(hvname)));
10252 call_sv((SV*)GvCV(cloner), G_SCALAR);
10259 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10267 =for apidoc perl_clone
10269 Create and return a new interpreter by cloning the current one.
10271 perl_clone takes these flags as parameters:
10273 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10274 without it we only clone the data and zero the stacks,
10275 with it we copy the stacks and the new perl interpreter is
10276 ready to run at the exact same point as the previous one.
10277 The pseudo-fork code uses COPY_STACKS while the
10278 threads->new doesn't.
10280 CLONEf_KEEP_PTR_TABLE
10281 perl_clone keeps a ptr_table with the pointer of the old
10282 variable as a key and the new variable as a value,
10283 this allows it to check if something has been cloned and not
10284 clone it again but rather just use the value and increase the
10285 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10286 the ptr_table using the function
10287 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10288 reason to keep it around is if you want to dup some of your own
10289 variable who are outside the graph perl scans, example of this
10290 code is in threads.xs create
10293 This is a win32 thing, it is ignored on unix, it tells perls
10294 win32host code (which is c++) to clone itself, this is needed on
10295 win32 if you want to run two threads at the same time,
10296 if you just want to do some stuff in a separate perl interpreter
10297 and then throw it away and return to the original one,
10298 you don't need to do anything.
10303 /* XXX the above needs expanding by someone who actually understands it ! */
10304 EXTERN_C PerlInterpreter *
10305 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10308 perl_clone(PerlInterpreter *proto_perl, UV flags)
10311 #ifdef PERL_IMPLICIT_SYS
10313 /* perlhost.h so we need to call into it
10314 to clone the host, CPerlHost should have a c interface, sky */
10316 if (flags & CLONEf_CLONE_HOST) {
10317 return perl_clone_host(proto_perl,flags);
10319 return perl_clone_using(proto_perl, flags,
10321 proto_perl->IMemShared,
10322 proto_perl->IMemParse,
10324 proto_perl->IStdIO,
10328 proto_perl->IProc);
10332 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10333 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10334 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10335 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10336 struct IPerlDir* ipD, struct IPerlSock* ipS,
10337 struct IPerlProc* ipP)
10339 /* XXX many of the string copies here can be optimized if they're
10340 * constants; they need to be allocated as common memory and just
10341 * their pointers copied. */
10344 CLONE_PARAMS clone_params;
10345 CLONE_PARAMS* param = &clone_params;
10347 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10348 /* for each stash, determine whether its objects should be cloned */
10349 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10350 PERL_SET_THX(my_perl);
10353 Poison(my_perl, 1, PerlInterpreter);
10355 PL_curcop = (COP *)Nullop;
10359 PL_savestack_ix = 0;
10360 PL_savestack_max = -1;
10361 PL_sig_pending = 0;
10362 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10363 # else /* !DEBUGGING */
10364 Zero(my_perl, 1, PerlInterpreter);
10365 # endif /* DEBUGGING */
10367 /* host pointers */
10369 PL_MemShared = ipMS;
10370 PL_MemParse = ipMP;
10377 #else /* !PERL_IMPLICIT_SYS */
10379 CLONE_PARAMS clone_params;
10380 CLONE_PARAMS* param = &clone_params;
10381 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10382 /* for each stash, determine whether its objects should be cloned */
10383 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10384 PERL_SET_THX(my_perl);
10387 Poison(my_perl, 1, PerlInterpreter);
10389 PL_curcop = (COP *)Nullop;
10393 PL_savestack_ix = 0;
10394 PL_savestack_max = -1;
10395 PL_sig_pending = 0;
10396 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10397 # else /* !DEBUGGING */
10398 Zero(my_perl, 1, PerlInterpreter);
10399 # endif /* DEBUGGING */
10400 #endif /* PERL_IMPLICIT_SYS */
10401 param->flags = flags;
10402 param->proto_perl = proto_perl;
10404 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10406 PL_body_arenas = NULL;
10407 Zero(&PL_body_roots, 1, PL_body_roots);
10409 PL_nice_chunk = NULL;
10410 PL_nice_chunk_size = 0;
10412 PL_sv_objcount = 0;
10414 PL_sv_arenaroot = NULL;
10416 PL_debug = proto_perl->Idebug;
10418 PL_hash_seed = proto_perl->Ihash_seed;
10419 PL_rehash_seed = proto_perl->Irehash_seed;
10421 #ifdef USE_REENTRANT_API
10422 /* XXX: things like -Dm will segfault here in perlio, but doing
10423 * PERL_SET_CONTEXT(proto_perl);
10424 * breaks too many other things
10426 Perl_reentrant_init(aTHX);
10429 /* create SV map for pointer relocation */
10430 PL_ptr_table = ptr_table_new();
10432 /* initialize these special pointers as early as possible */
10433 SvANY(&PL_sv_undef) = NULL;
10434 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10435 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10436 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10438 SvANY(&PL_sv_no) = new_XPVNV();
10439 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10440 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10441 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10442 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10443 SvCUR_set(&PL_sv_no, 0);
10444 SvLEN_set(&PL_sv_no, 1);
10445 SvIV_set(&PL_sv_no, 0);
10446 SvNV_set(&PL_sv_no, 0);
10447 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10449 SvANY(&PL_sv_yes) = new_XPVNV();
10450 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10451 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10452 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10453 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10454 SvCUR_set(&PL_sv_yes, 1);
10455 SvLEN_set(&PL_sv_yes, 2);
10456 SvIV_set(&PL_sv_yes, 1);
10457 SvNV_set(&PL_sv_yes, 1);
10458 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10460 /* create (a non-shared!) shared string table */
10461 PL_strtab = newHV();
10462 HvSHAREKEYS_off(PL_strtab);
10463 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10464 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10466 PL_compiling = proto_perl->Icompiling;
10468 /* These two PVs will be free'd special way so must set them same way op.c does */
10469 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10470 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10472 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10473 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10475 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10476 if (!specialWARN(PL_compiling.cop_warnings))
10477 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10478 if (!specialCopIO(PL_compiling.cop_io))
10479 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10480 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10482 /* pseudo environmental stuff */
10483 PL_origargc = proto_perl->Iorigargc;
10484 PL_origargv = proto_perl->Iorigargv;
10486 param->stashes = newAV(); /* Setup array of objects to call clone on */
10488 /* Set tainting stuff before PerlIO_debug can possibly get called */
10489 PL_tainting = proto_perl->Itainting;
10490 PL_taint_warn = proto_perl->Itaint_warn;
10492 #ifdef PERLIO_LAYERS
10493 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10494 PerlIO_clone(aTHX_ proto_perl, param);
10497 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10498 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10499 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10500 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10501 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10502 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10505 PL_minus_c = proto_perl->Iminus_c;
10506 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10507 PL_localpatches = proto_perl->Ilocalpatches;
10508 PL_splitstr = proto_perl->Isplitstr;
10509 PL_preprocess = proto_perl->Ipreprocess;
10510 PL_minus_n = proto_perl->Iminus_n;
10511 PL_minus_p = proto_perl->Iminus_p;
10512 PL_minus_l = proto_perl->Iminus_l;
10513 PL_minus_a = proto_perl->Iminus_a;
10514 PL_minus_E = proto_perl->Iminus_E;
10515 PL_minus_F = proto_perl->Iminus_F;
10516 PL_doswitches = proto_perl->Idoswitches;
10517 PL_dowarn = proto_perl->Idowarn;
10518 PL_doextract = proto_perl->Idoextract;
10519 PL_sawampersand = proto_perl->Isawampersand;
10520 PL_unsafe = proto_perl->Iunsafe;
10521 PL_inplace = SAVEPV(proto_perl->Iinplace);
10522 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10523 PL_perldb = proto_perl->Iperldb;
10524 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10525 PL_exit_flags = proto_perl->Iexit_flags;
10527 /* magical thingies */
10528 /* XXX time(&PL_basetime) when asked for? */
10529 PL_basetime = proto_perl->Ibasetime;
10530 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10532 PL_maxsysfd = proto_perl->Imaxsysfd;
10533 PL_multiline = proto_perl->Imultiline;
10534 PL_statusvalue = proto_perl->Istatusvalue;
10536 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10538 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10540 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10542 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10543 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10544 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10546 /* Clone the regex array */
10547 PL_regex_padav = newAV();
10549 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10550 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10552 av_push(PL_regex_padav,
10553 sv_dup_inc(regexen[0],param));
10554 for(i = 1; i <= len; i++) {
10555 const SV * const regex = regexen[i];
10558 ? sv_dup_inc(regex, param)
10560 newSViv(PTR2IV(re_dup(
10561 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10563 av_push(PL_regex_padav, sv);
10566 PL_regex_pad = AvARRAY(PL_regex_padav);
10568 /* shortcuts to various I/O objects */
10569 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10570 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10571 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10572 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10573 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10574 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10576 /* shortcuts to regexp stuff */
10577 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10579 /* shortcuts to misc objects */
10580 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10582 /* shortcuts to debugging objects */
10583 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10584 PL_DBline = gv_dup(proto_perl->IDBline, param);
10585 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10586 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10587 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10588 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10589 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10590 PL_lineary = av_dup(proto_perl->Ilineary, param);
10591 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10593 /* symbol tables */
10594 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10595 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10596 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10597 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10598 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10600 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10601 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10602 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10603 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10604 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10605 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10607 PL_sub_generation = proto_perl->Isub_generation;
10609 /* funky return mechanisms */
10610 PL_forkprocess = proto_perl->Iforkprocess;
10612 /* subprocess state */
10613 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10615 /* internal state */
10616 PL_maxo = proto_perl->Imaxo;
10617 if (proto_perl->Iop_mask)
10618 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10621 /* PL_asserting = proto_perl->Iasserting; */
10623 /* current interpreter roots */
10624 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10625 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10626 PL_main_start = proto_perl->Imain_start;
10627 PL_eval_root = proto_perl->Ieval_root;
10628 PL_eval_start = proto_perl->Ieval_start;
10630 /* runtime control stuff */
10631 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10632 PL_copline = proto_perl->Icopline;
10634 PL_filemode = proto_perl->Ifilemode;
10635 PL_lastfd = proto_perl->Ilastfd;
10636 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10639 PL_gensym = proto_perl->Igensym;
10640 PL_preambled = proto_perl->Ipreambled;
10641 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10642 PL_laststatval = proto_perl->Ilaststatval;
10643 PL_laststype = proto_perl->Ilaststype;
10646 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10648 /* interpreter atexit processing */
10649 PL_exitlistlen = proto_perl->Iexitlistlen;
10650 if (PL_exitlistlen) {
10651 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10652 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10655 PL_exitlist = (PerlExitListEntry*)NULL;
10657 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10658 if (PL_my_cxt_size) {
10659 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10660 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10663 PL_my_cxt_list = (void**)NULL;
10664 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10665 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10666 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10668 PL_profiledata = NULL;
10669 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10670 /* PL_rsfp_filters entries have fake IoDIRP() */
10671 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10673 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10675 PAD_CLONE_VARS(proto_perl, param);
10677 #ifdef HAVE_INTERP_INTERN
10678 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10681 /* more statics moved here */
10682 PL_generation = proto_perl->Igeneration;
10683 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10685 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10686 PL_in_clean_all = proto_perl->Iin_clean_all;
10688 PL_uid = proto_perl->Iuid;
10689 PL_euid = proto_perl->Ieuid;
10690 PL_gid = proto_perl->Igid;
10691 PL_egid = proto_perl->Iegid;
10692 PL_nomemok = proto_perl->Inomemok;
10693 PL_an = proto_perl->Ian;
10694 PL_evalseq = proto_perl->Ievalseq;
10695 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10696 PL_origalen = proto_perl->Iorigalen;
10697 #ifdef PERL_USES_PL_PIDSTATUS
10698 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10700 PL_osname = SAVEPV(proto_perl->Iosname);
10701 PL_sighandlerp = proto_perl->Isighandlerp;
10703 PL_runops = proto_perl->Irunops;
10705 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10708 PL_cshlen = proto_perl->Icshlen;
10709 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10712 PL_lex_state = proto_perl->Ilex_state;
10713 PL_lex_defer = proto_perl->Ilex_defer;
10714 PL_lex_expect = proto_perl->Ilex_expect;
10715 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10716 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10717 PL_lex_starts = proto_perl->Ilex_starts;
10718 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10719 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10720 PL_lex_op = proto_perl->Ilex_op;
10721 PL_lex_inpat = proto_perl->Ilex_inpat;
10722 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10723 PL_lex_brackets = proto_perl->Ilex_brackets;
10724 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10725 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10726 PL_lex_casemods = proto_perl->Ilex_casemods;
10727 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10728 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10730 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10731 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10732 PL_nexttoke = proto_perl->Inexttoke;
10734 /* XXX This is probably masking the deeper issue of why
10735 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10736 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10737 * (A little debugging with a watchpoint on it may help.)
10739 if (SvANY(proto_perl->Ilinestr)) {
10740 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10741 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10742 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10743 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10744 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10745 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10746 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10747 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10748 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10751 PL_linestr = newSV(79);
10752 sv_upgrade(PL_linestr,SVt_PVIV);
10753 sv_setpvn(PL_linestr,"",0);
10754 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10756 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10757 PL_pending_ident = proto_perl->Ipending_ident;
10758 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10760 PL_expect = proto_perl->Iexpect;
10762 PL_multi_start = proto_perl->Imulti_start;
10763 PL_multi_end = proto_perl->Imulti_end;
10764 PL_multi_open = proto_perl->Imulti_open;
10765 PL_multi_close = proto_perl->Imulti_close;
10767 PL_error_count = proto_perl->Ierror_count;
10768 PL_subline = proto_perl->Isubline;
10769 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10771 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10772 if (SvANY(proto_perl->Ilinestr)) {
10773 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10774 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10775 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10776 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10777 PL_last_lop_op = proto_perl->Ilast_lop_op;
10780 PL_last_uni = SvPVX(PL_linestr);
10781 PL_last_lop = SvPVX(PL_linestr);
10782 PL_last_lop_op = 0;
10784 PL_in_my = proto_perl->Iin_my;
10785 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10787 PL_cryptseen = proto_perl->Icryptseen;
10790 PL_hints = proto_perl->Ihints;
10792 PL_amagic_generation = proto_perl->Iamagic_generation;
10794 #ifdef USE_LOCALE_COLLATE
10795 PL_collation_ix = proto_perl->Icollation_ix;
10796 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10797 PL_collation_standard = proto_perl->Icollation_standard;
10798 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10799 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10800 #endif /* USE_LOCALE_COLLATE */
10802 #ifdef USE_LOCALE_NUMERIC
10803 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10804 PL_numeric_standard = proto_perl->Inumeric_standard;
10805 PL_numeric_local = proto_perl->Inumeric_local;
10806 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10807 #endif /* !USE_LOCALE_NUMERIC */
10809 /* utf8 character classes */
10810 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10811 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10812 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10813 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10814 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10815 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10816 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10817 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10818 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10819 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10820 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10821 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10822 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10823 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10824 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10825 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10826 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10827 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10828 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10829 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10831 /* Did the locale setup indicate UTF-8? */
10832 PL_utf8locale = proto_perl->Iutf8locale;
10833 /* Unicode features (see perlrun/-C) */
10834 PL_unicode = proto_perl->Iunicode;
10836 /* Pre-5.8 signals control */
10837 PL_signals = proto_perl->Isignals;
10839 /* times() ticks per second */
10840 PL_clocktick = proto_perl->Iclocktick;
10842 /* Recursion stopper for PerlIO_find_layer */
10843 PL_in_load_module = proto_perl->Iin_load_module;
10845 /* sort() routine */
10846 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10848 /* Not really needed/useful since the reenrant_retint is "volatile",
10849 * but do it for consistency's sake. */
10850 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10852 /* Hooks to shared SVs and locks. */
10853 PL_sharehook = proto_perl->Isharehook;
10854 PL_lockhook = proto_perl->Ilockhook;
10855 PL_unlockhook = proto_perl->Iunlockhook;
10856 PL_threadhook = proto_perl->Ithreadhook;
10858 PL_runops_std = proto_perl->Irunops_std;
10859 PL_runops_dbg = proto_perl->Irunops_dbg;
10861 #ifdef THREADS_HAVE_PIDS
10862 PL_ppid = proto_perl->Ippid;
10866 PL_last_swash_hv = NULL; /* reinits on demand */
10867 PL_last_swash_klen = 0;
10868 PL_last_swash_key[0]= '\0';
10869 PL_last_swash_tmps = (U8*)NULL;
10870 PL_last_swash_slen = 0;
10872 PL_glob_index = proto_perl->Iglob_index;
10873 PL_srand_called = proto_perl->Isrand_called;
10874 PL_uudmap['M'] = 0; /* reinits on demand */
10875 PL_bitcount = NULL; /* reinits on demand */
10877 if (proto_perl->Ipsig_pend) {
10878 Newxz(PL_psig_pend, SIG_SIZE, int);
10881 PL_psig_pend = (int*)NULL;
10884 if (proto_perl->Ipsig_ptr) {
10885 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10886 Newxz(PL_psig_name, SIG_SIZE, SV*);
10887 for (i = 1; i < SIG_SIZE; i++) {
10888 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10889 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10893 PL_psig_ptr = (SV**)NULL;
10894 PL_psig_name = (SV**)NULL;
10897 /* thrdvar.h stuff */
10899 if (flags & CLONEf_COPY_STACKS) {
10900 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10901 PL_tmps_ix = proto_perl->Ttmps_ix;
10902 PL_tmps_max = proto_perl->Ttmps_max;
10903 PL_tmps_floor = proto_perl->Ttmps_floor;
10904 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10906 while (i <= PL_tmps_ix) {
10907 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10911 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10912 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10913 Newxz(PL_markstack, i, I32);
10914 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10915 - proto_perl->Tmarkstack);
10916 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10917 - proto_perl->Tmarkstack);
10918 Copy(proto_perl->Tmarkstack, PL_markstack,
10919 PL_markstack_ptr - PL_markstack + 1, I32);
10921 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10922 * NOTE: unlike the others! */
10923 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10924 PL_scopestack_max = proto_perl->Tscopestack_max;
10925 Newxz(PL_scopestack, PL_scopestack_max, I32);
10926 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10928 /* NOTE: si_dup() looks at PL_markstack */
10929 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10931 /* PL_curstack = PL_curstackinfo->si_stack; */
10932 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10933 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10935 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10936 PL_stack_base = AvARRAY(PL_curstack);
10937 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10938 - proto_perl->Tstack_base);
10939 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10941 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10942 * NOTE: unlike the others! */
10943 PL_savestack_ix = proto_perl->Tsavestack_ix;
10944 PL_savestack_max = proto_perl->Tsavestack_max;
10945 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10946 PL_savestack = ss_dup(proto_perl, param);
10950 ENTER; /* perl_destruct() wants to LEAVE; */
10952 /* although we're not duplicating the tmps stack, we should still
10953 * add entries for any SVs on the tmps stack that got cloned by a
10954 * non-refcount means (eg a temp in @_); otherwise they will be
10957 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10958 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10959 proto_perl->Ttmps_stack[i]);
10960 if (nsv && !SvREFCNT(nsv)) {
10962 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10967 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10968 PL_top_env = &PL_start_env;
10970 PL_op = proto_perl->Top;
10973 PL_Xpv = (XPV*)NULL;
10974 PL_na = proto_perl->Tna;
10976 PL_statbuf = proto_perl->Tstatbuf;
10977 PL_statcache = proto_perl->Tstatcache;
10978 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10979 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10981 PL_timesbuf = proto_perl->Ttimesbuf;
10984 PL_tainted = proto_perl->Ttainted;
10985 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10986 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10987 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10988 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10989 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10990 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10991 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10992 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10993 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10995 PL_restartop = proto_perl->Trestartop;
10996 PL_in_eval = proto_perl->Tin_eval;
10997 PL_delaymagic = proto_perl->Tdelaymagic;
10998 PL_dirty = proto_perl->Tdirty;
10999 PL_localizing = proto_perl->Tlocalizing;
11001 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11002 PL_hv_fetch_ent_mh = Nullhe;
11003 PL_modcount = proto_perl->Tmodcount;
11004 PL_lastgotoprobe = Nullop;
11005 PL_dumpindent = proto_perl->Tdumpindent;
11007 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11008 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11009 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11010 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11011 PL_efloatbuf = NULL; /* reinits on demand */
11012 PL_efloatsize = 0; /* reinits on demand */
11016 PL_screamfirst = NULL;
11017 PL_screamnext = NULL;
11018 PL_maxscream = -1; /* reinits on demand */
11019 PL_lastscream = NULL;
11021 PL_watchaddr = NULL;
11024 PL_regdummy = proto_perl->Tregdummy;
11025 PL_regprecomp = NULL;
11028 PL_colorset = 0; /* reinits PL_colors[] */
11029 /*PL_colors[6] = {0,0,0,0,0,0};*/
11030 PL_reginput = NULL;
11033 PL_regstartp = (I32*)NULL;
11034 PL_regendp = (I32*)NULL;
11035 PL_reglastparen = (U32*)NULL;
11036 PL_reglastcloseparen = (U32*)NULL;
11038 PL_reg_start_tmp = (char**)NULL;
11039 PL_reg_start_tmpl = 0;
11040 PL_regdata = (struct reg_data*)NULL;
11043 PL_reg_eval_set = 0;
11045 PL_regprogram = (regnode*)NULL;
11047 PL_regcc = (CURCUR*)NULL;
11048 PL_reg_call_cc = (struct re_cc_state*)NULL;
11049 PL_reg_re = (regexp*)NULL;
11050 PL_reg_ganch = NULL;
11052 PL_reg_match_utf8 = FALSE;
11053 PL_reg_magic = (MAGIC*)NULL;
11055 PL_reg_oldcurpm = (PMOP*)NULL;
11056 PL_reg_curpm = (PMOP*)NULL;
11057 PL_reg_oldsaved = NULL;
11058 PL_reg_oldsavedlen = 0;
11059 #ifdef PERL_OLD_COPY_ON_WRITE
11062 PL_reg_maxiter = 0;
11063 PL_reg_leftiter = 0;
11064 PL_reg_poscache = NULL;
11065 PL_reg_poscache_size= 0;
11067 /* RE engine - function pointers */
11068 PL_regcompp = proto_perl->Tregcompp;
11069 PL_regexecp = proto_perl->Tregexecp;
11070 PL_regint_start = proto_perl->Tregint_start;
11071 PL_regint_string = proto_perl->Tregint_string;
11072 PL_regfree = proto_perl->Tregfree;
11074 PL_reginterp_cnt = 0;
11075 PL_reg_starttry = 0;
11077 /* Pluggable optimizer */
11078 PL_peepp = proto_perl->Tpeepp;
11080 PL_stashcache = newHV();
11082 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11083 ptr_table_free(PL_ptr_table);
11084 PL_ptr_table = NULL;
11087 /* Call the ->CLONE method, if it exists, for each of the stashes
11088 identified by sv_dup() above.
11090 while(av_len(param->stashes) != -1) {
11091 HV* const stash = (HV*) av_shift(param->stashes);
11092 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11093 if (cloner && GvCV(cloner)) {
11098 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11100 call_sv((SV*)GvCV(cloner), G_DISCARD);
11106 SvREFCNT_dec(param->stashes);
11108 /* orphaned? eg threads->new inside BEGIN or use */
11109 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11110 (void)SvREFCNT_inc(PL_compcv);
11111 SAVEFREESV(PL_compcv);
11117 #endif /* USE_ITHREADS */
11120 =head1 Unicode Support
11122 =for apidoc sv_recode_to_utf8
11124 The encoding is assumed to be an Encode object, on entry the PV
11125 of the sv is assumed to be octets in that encoding, and the sv
11126 will be converted into Unicode (and UTF-8).
11128 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11129 is not a reference, nothing is done to the sv. If the encoding is not
11130 an C<Encode::XS> Encoding object, bad things will happen.
11131 (See F<lib/encoding.pm> and L<Encode>).
11133 The PV of the sv is returned.
11138 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11141 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11155 Passing sv_yes is wrong - it needs to be or'ed set of constants
11156 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11157 remove converted chars from source.
11159 Both will default the value - let them.
11161 XPUSHs(&PL_sv_yes);
11164 call_method("decode", G_SCALAR);
11168 s = SvPV_const(uni, len);
11169 if (s != SvPVX_const(sv)) {
11170 SvGROW(sv, len + 1);
11171 Move(s, SvPVX(sv), len + 1, char);
11172 SvCUR_set(sv, len);
11179 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11183 =for apidoc sv_cat_decode
11185 The encoding is assumed to be an Encode object, the PV of the ssv is
11186 assumed to be octets in that encoding and decoding the input starts
11187 from the position which (PV + *offset) pointed to. The dsv will be
11188 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11189 when the string tstr appears in decoding output or the input ends on
11190 the PV of the ssv. The value which the offset points will be modified
11191 to the last input position on the ssv.
11193 Returns TRUE if the terminator was found, else returns FALSE.
11198 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11199 SV *ssv, int *offset, char *tstr, int tlen)
11203 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11214 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11215 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11217 call_method("cat_decode", G_SCALAR);
11219 ret = SvTRUE(TOPs);
11220 *offset = SvIV(offsv);
11226 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11231 /* ---------------------------------------------------------------------
11233 * support functions for report_uninit()
11236 /* the maxiumum size of array or hash where we will scan looking
11237 * for the undefined element that triggered the warning */
11239 #define FUV_MAX_SEARCH_SIZE 1000
11241 /* Look for an entry in the hash whose value has the same SV as val;
11242 * If so, return a mortal copy of the key. */
11245 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11248 register HE **array;
11251 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11252 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11255 array = HvARRAY(hv);
11257 for (i=HvMAX(hv); i>0; i--) {
11258 register HE *entry;
11259 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11260 if (HeVAL(entry) != val)
11262 if ( HeVAL(entry) == &PL_sv_undef ||
11263 HeVAL(entry) == &PL_sv_placeholder)
11267 if (HeKLEN(entry) == HEf_SVKEY)
11268 return sv_mortalcopy(HeKEY_sv(entry));
11269 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11275 /* Look for an entry in the array whose value has the same SV as val;
11276 * If so, return the index, otherwise return -1. */
11279 S_find_array_subscript(pTHX_ AV *av, SV* val)
11284 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11285 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11289 for (i=AvFILLp(av); i>=0; i--) {
11290 if (svp[i] == val && svp[i] != &PL_sv_undef)
11296 /* S_varname(): return the name of a variable, optionally with a subscript.
11297 * If gv is non-zero, use the name of that global, along with gvtype (one
11298 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11299 * targ. Depending on the value of the subscript_type flag, return:
11302 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11303 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11304 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11305 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11308 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11309 SV* keyname, I32 aindex, int subscript_type)
11312 SV * const name = sv_newmortal();
11315 buffer[0] = gvtype;
11318 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11320 gv_fullname4(name, gv, buffer, 0);
11322 if ((unsigned int)SvPVX(name)[1] <= 26) {
11324 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11326 /* Swap the 1 unprintable control character for the 2 byte pretty
11327 version - ie substr($name, 1, 1) = $buffer; */
11328 sv_insert(name, 1, 1, buffer, 2);
11333 CV * const cv = find_runcv(&unused);
11337 if (!cv || !CvPADLIST(cv))
11339 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11340 sv = *av_fetch(av, targ, FALSE);
11341 /* SvLEN in a pad name is not to be trusted */
11342 sv_setpv(name, SvPV_nolen_const(sv));
11345 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11346 SV * const sv = newSV(0);
11347 *SvPVX(name) = '$';
11348 Perl_sv_catpvf(aTHX_ name, "{%s}",
11349 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11352 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11353 *SvPVX(name) = '$';
11354 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11356 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11357 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11364 =for apidoc find_uninit_var
11366 Find the name of the undefined variable (if any) that caused the operator o
11367 to issue a "Use of uninitialized value" warning.
11368 If match is true, only return a name if it's value matches uninit_sv.
11369 So roughly speaking, if a unary operator (such as OP_COS) generates a
11370 warning, then following the direct child of the op may yield an
11371 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11372 other hand, with OP_ADD there are two branches to follow, so we only print
11373 the variable name if we get an exact match.
11375 The name is returned as a mortal SV.
11377 Assumes that PL_op is the op that originally triggered the error, and that
11378 PL_comppad/PL_curpad points to the currently executing pad.
11384 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11392 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11393 uninit_sv == &PL_sv_placeholder)))
11396 switch (obase->op_type) {
11403 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11404 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11407 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11409 if (pad) { /* @lex, %lex */
11410 sv = PAD_SVl(obase->op_targ);
11414 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11415 /* @global, %global */
11416 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11419 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11421 else /* @{expr}, %{expr} */
11422 return find_uninit_var(cUNOPx(obase)->op_first,
11426 /* attempt to find a match within the aggregate */
11428 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11430 subscript_type = FUV_SUBSCRIPT_HASH;
11433 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11435 subscript_type = FUV_SUBSCRIPT_ARRAY;
11438 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11441 return varname(gv, hash ? '%' : '@', obase->op_targ,
11442 keysv, index, subscript_type);
11446 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11448 return varname(NULL, '$', obase->op_targ,
11449 NULL, 0, FUV_SUBSCRIPT_NONE);
11452 gv = cGVOPx_gv(obase);
11453 if (!gv || (match && GvSV(gv) != uninit_sv))
11455 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11458 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11461 av = (AV*)PAD_SV(obase->op_targ);
11462 if (!av || SvRMAGICAL(av))
11464 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11465 if (!svp || *svp != uninit_sv)
11468 return varname(NULL, '$', obase->op_targ,
11469 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11472 gv = cGVOPx_gv(obase);
11478 if (!av || SvRMAGICAL(av))
11480 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11481 if (!svp || *svp != uninit_sv)
11484 return varname(gv, '$', 0,
11485 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11490 o = cUNOPx(obase)->op_first;
11491 if (!o || o->op_type != OP_NULL ||
11492 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11494 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11498 if (PL_op == obase)
11499 /* $a[uninit_expr] or $h{uninit_expr} */
11500 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11503 o = cBINOPx(obase)->op_first;
11504 kid = cBINOPx(obase)->op_last;
11506 /* get the av or hv, and optionally the gv */
11508 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11509 sv = PAD_SV(o->op_targ);
11511 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11512 && cUNOPo->op_first->op_type == OP_GV)
11514 gv = cGVOPx_gv(cUNOPo->op_first);
11517 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11522 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11523 /* index is constant */
11527 if (obase->op_type == OP_HELEM) {
11528 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11529 if (!he || HeVAL(he) != uninit_sv)
11533 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11534 if (!svp || *svp != uninit_sv)
11538 if (obase->op_type == OP_HELEM)
11539 return varname(gv, '%', o->op_targ,
11540 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11542 return varname(gv, '@', o->op_targ, NULL,
11543 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11546 /* index is an expression;
11547 * attempt to find a match within the aggregate */
11548 if (obase->op_type == OP_HELEM) {
11549 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11551 return varname(gv, '%', o->op_targ,
11552 keysv, 0, FUV_SUBSCRIPT_HASH);
11555 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11557 return varname(gv, '@', o->op_targ,
11558 NULL, index, FUV_SUBSCRIPT_ARRAY);
11563 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11565 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11571 /* only examine RHS */
11572 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11575 o = cUNOPx(obase)->op_first;
11576 if (o->op_type == OP_PUSHMARK)
11579 if (!o->op_sibling) {
11580 /* one-arg version of open is highly magical */
11582 if (o->op_type == OP_GV) { /* open FOO; */
11584 if (match && GvSV(gv) != uninit_sv)
11586 return varname(gv, '$', 0,
11587 NULL, 0, FUV_SUBSCRIPT_NONE);
11589 /* other possibilities not handled are:
11590 * open $x; or open my $x; should return '${*$x}'
11591 * open expr; should return '$'.expr ideally
11597 /* ops where $_ may be an implicit arg */
11601 if ( !(obase->op_flags & OPf_STACKED)) {
11602 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11603 ? PAD_SVl(obase->op_targ)
11606 sv = sv_newmortal();
11607 sv_setpvn(sv, "$_", 2);
11615 /* skip filehandle as it can't produce 'undef' warning */
11616 o = cUNOPx(obase)->op_first;
11617 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11618 o = o->op_sibling->op_sibling;
11625 match = 1; /* XS or custom code could trigger random warnings */
11630 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11631 return sv_2mortal(newSVpvs("${$/}"));
11636 if (!(obase->op_flags & OPf_KIDS))
11638 o = cUNOPx(obase)->op_first;
11644 /* if all except one arg are constant, or have no side-effects,
11645 * or are optimized away, then it's unambiguous */
11647 for (kid=o; kid; kid = kid->op_sibling) {
11649 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11650 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11651 || (kid->op_type == OP_PUSHMARK)
11655 if (o2) { /* more than one found */
11662 return find_uninit_var(o2, uninit_sv, match);
11664 /* scan all args */
11666 sv = find_uninit_var(o, uninit_sv, 1);
11678 =for apidoc report_uninit
11680 Print appropriate "Use of uninitialized variable" warning
11686 Perl_report_uninit(pTHX_ SV* uninit_sv)
11690 SV* varname = NULL;
11692 varname = find_uninit_var(PL_op, uninit_sv,0);
11694 sv_insert(varname, 0, 0, " ", 1);
11696 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11697 varname ? SvPV_nolen_const(varname) : "",
11698 " in ", OP_DESC(PL_op));
11701 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11707 * c-indentation-style: bsd
11708 * c-basic-offset: 4
11709 * indent-tabs-mode: t
11712 * ex: set ts=8 sts=4 sw=4 noet: