3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 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)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void **arena_root = &PL_body_arenaroots[sv_type];
644 void **root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void **r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void **thing_copy = (void **)thing; \
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s, *end;
1417 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 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));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 =for apidoc sv_2iv_flags
1631 Return the integer value of an SV, doing any necessary string
1632 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1633 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1639 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1643 if (SvGMAGICAL(sv)) {
1644 if (flags & SV_GMAGIC)
1649 return I_V(SvNVX(sv));
1651 if (SvPOKp(sv) && SvLEN(sv))
1654 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1655 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1661 if (SvTHINKFIRST(sv)) {
1664 SV * const tmpstr=AMG_CALLun(sv,numer);
1665 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1666 return SvIV(tmpstr);
1669 return PTR2IV(SvRV(sv));
1672 sv_force_normal_flags(sv, 0);
1674 if (SvREADONLY(sv) && !SvOK(sv)) {
1675 if (ckWARN(WARN_UNINITIALIZED))
1682 return (IV)(SvUVX(sv));
1689 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1690 * without also getting a cached IV/UV from it at the same time
1691 * (ie PV->NV conversion should detect loss of accuracy and cache
1692 * IV or UV at same time to avoid this. NWC */
1694 if (SvTYPE(sv) == SVt_NV)
1695 sv_upgrade(sv, SVt_PVNV);
1697 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1698 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1699 certainly cast into the IV range at IV_MAX, whereas the correct
1700 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1702 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1703 SvIV_set(sv, I_V(SvNVX(sv)));
1704 if (SvNVX(sv) == (NV) SvIVX(sv)
1705 #ifndef NV_PRESERVES_UV
1706 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1707 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1708 /* Don't flag it as "accurately an integer" if the number
1709 came from a (by definition imprecise) NV operation, and
1710 we're outside the range of NV integer precision */
1713 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1714 DEBUG_c(PerlIO_printf(Perl_debug_log,
1715 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1721 /* IV not precise. No need to convert from PV, as NV
1722 conversion would already have cached IV if it detected
1723 that PV->IV would be better than PV->NV->IV
1724 flags already correct - don't set public IOK. */
1725 DEBUG_c(PerlIO_printf(Perl_debug_log,
1726 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1731 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1732 but the cast (NV)IV_MIN rounds to a the value less (more
1733 negative) than IV_MIN which happens to be equal to SvNVX ??
1734 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1735 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1736 (NV)UVX == NVX are both true, but the values differ. :-(
1737 Hopefully for 2s complement IV_MIN is something like
1738 0x8000000000000000 which will be exact. NWC */
1741 SvUV_set(sv, U_V(SvNVX(sv)));
1743 (SvNVX(sv) == (NV) SvUVX(sv))
1744 #ifndef NV_PRESERVES_UV
1745 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1746 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1747 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1748 /* Don't flag it as "accurately an integer" if the number
1749 came from a (by definition imprecise) NV operation, and
1750 we're outside the range of NV integer precision */
1755 DEBUG_c(PerlIO_printf(Perl_debug_log,
1756 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1762 else if (SvPOKp(sv) && SvLEN(sv)) {
1764 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1765 /* We want to avoid a possible problem when we cache an IV which
1766 may be later translated to an NV, and the resulting NV is not
1767 the same as the direct translation of the initial string
1768 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1769 be careful to ensure that the value with the .456 is around if the
1770 NV value is requested in the future).
1772 This means that if we cache such an IV, we need to cache the
1773 NV as well. Moreover, we trade speed for space, and do not
1774 cache the NV if we are sure it's not needed.
1777 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1778 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1779 == IS_NUMBER_IN_UV) {
1780 /* It's definitely an integer, only upgrade to PVIV */
1781 if (SvTYPE(sv) < SVt_PVIV)
1782 sv_upgrade(sv, SVt_PVIV);
1784 } else if (SvTYPE(sv) < SVt_PVNV)
1785 sv_upgrade(sv, SVt_PVNV);
1787 /* If NV preserves UV then we only use the UV value if we know that
1788 we aren't going to call atof() below. If NVs don't preserve UVs
1789 then the value returned may have more precision than atof() will
1790 return, even though value isn't perfectly accurate. */
1791 if ((numtype & (IS_NUMBER_IN_UV
1792 #ifdef NV_PRESERVES_UV
1795 )) == IS_NUMBER_IN_UV) {
1796 /* This won't turn off the public IOK flag if it was set above */
1797 (void)SvIOKp_on(sv);
1799 if (!(numtype & IS_NUMBER_NEG)) {
1801 if (value <= (UV)IV_MAX) {
1802 SvIV_set(sv, (IV)value);
1804 SvUV_set(sv, value);
1808 /* 2s complement assumption */
1809 if (value <= (UV)IV_MIN) {
1810 SvIV_set(sv, -(IV)value);
1812 /* Too negative for an IV. This is a double upgrade, but
1813 I'm assuming it will be rare. */
1814 if (SvTYPE(sv) < SVt_PVNV)
1815 sv_upgrade(sv, SVt_PVNV);
1819 SvNV_set(sv, -(NV)value);
1820 SvIV_set(sv, IV_MIN);
1824 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1825 will be in the previous block to set the IV slot, and the next
1826 block to set the NV slot. So no else here. */
1828 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1829 != IS_NUMBER_IN_UV) {
1830 /* It wasn't an (integer that doesn't overflow the UV). */
1831 SvNV_set(sv, Atof(SvPVX_const(sv)));
1833 if (! numtype && ckWARN(WARN_NUMERIC))
1836 #if defined(USE_LONG_DOUBLE)
1837 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1838 PTR2UV(sv), SvNVX(sv)));
1840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1841 PTR2UV(sv), SvNVX(sv)));
1845 #ifdef NV_PRESERVES_UV
1846 (void)SvIOKp_on(sv);
1848 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1849 SvIV_set(sv, I_V(SvNVX(sv)));
1850 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1853 /* Integer is imprecise. NOK, IOKp */
1855 /* UV will not work better than IV */
1857 if (SvNVX(sv) > (NV)UV_MAX) {
1859 /* Integer is inaccurate. NOK, IOKp, is UV */
1860 SvUV_set(sv, UV_MAX);
1863 SvUV_set(sv, U_V(SvNVX(sv)));
1864 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1869 /* Integer is imprecise. NOK, IOKp, is UV */
1874 #else /* NV_PRESERVES_UV */
1875 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1876 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1877 /* The IV slot will have been set from value returned by
1878 grok_number above. The NV slot has just been set using
1881 assert (SvIOKp(sv));
1883 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1884 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1885 /* Small enough to preserve all bits. */
1886 (void)SvIOKp_on(sv);
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1891 /* Assumption: first non-preserved integer is < IV_MAX,
1892 this NV is in the preserved range, therefore: */
1893 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1895 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);
1899 0 0 already failed to read UV.
1900 0 1 already failed to read UV.
1901 1 0 you won't get here in this case. IV/UV
1902 slot set, public IOK, Atof() unneeded.
1903 1 1 already read UV.
1904 so there's no point in sv_2iuv_non_preserve() attempting
1905 to use atol, strtol, strtoul etc. */
1906 sv_2iuv_non_preserve (sv, numtype);
1909 #endif /* NV_PRESERVES_UV */
1912 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1914 if (SvTYPE(sv) < SVt_IV)
1915 /* Typically the caller expects that sv_any is not NULL now. */
1916 sv_upgrade(sv, SVt_IV);
1919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1920 PTR2UV(sv),SvIVX(sv)));
1921 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1925 =for apidoc sv_2uv_flags
1927 Return the unsigned integer value of an SV, doing any necessary string
1928 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1929 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1935 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1939 if (SvGMAGICAL(sv)) {
1940 if (flags & SV_GMAGIC)
1945 return U_V(SvNVX(sv));
1946 if (SvPOKp(sv) && SvLEN(sv))
1949 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1950 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1956 if (SvTHINKFIRST(sv)) {
1959 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1960 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1961 return SvUV(tmpstr);
1962 return PTR2UV(SvRV(sv));
1965 sv_force_normal_flags(sv, 0);
1967 if (SvREADONLY(sv) && !SvOK(sv)) {
1968 if (ckWARN(WARN_UNINITIALIZED))
1978 return (UV)SvIVX(sv);
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1993 SvIV_set(sv, I_V(SvNVX(sv)));
1994 if (SvNVX(sv) == (NV) SvIVX(sv)
1995 #ifndef NV_PRESERVES_UV
1996 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1997 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1998 /* Don't flag it as "accurately an integer" if the number
1999 came from a (by definition imprecise) NV operation, and
2000 we're outside the range of NV integer precision */
2003 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2004 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2011 /* IV not precise. No need to convert from PV, as NV
2012 conversion would already have cached IV if it detected
2013 that PV->IV would be better than PV->NV->IV
2014 flags already correct - don't set public IOK. */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2021 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022 but the cast (NV)IV_MIN rounds to a the value less (more
2023 negative) than IV_MIN which happens to be equal to SvNVX ??
2024 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026 (NV)UVX == NVX are both true, but the values differ. :-(
2027 Hopefully for 2s complement IV_MIN is something like
2028 0x8000000000000000 which will be exact. NWC */
2031 SvUV_set(sv, U_V(SvNVX(sv)));
2033 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef NV_PRESERVES_UV
2035 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038 /* Don't flag it as "accurately an integer" if the number
2039 came from a (by definition imprecise) NV operation, and
2040 we're outside the range of NV integer precision */
2045 DEBUG_c(PerlIO_printf(Perl_debug_log,
2046 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2052 else if (SvPOKp(sv) && SvLEN(sv)) {
2054 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2056 /* We want to avoid a possible problem when we cache a UV which
2057 may be later translated to an NV, and the resulting NV is not
2058 the translation of the initial data.
2060 This means that if we cache such a UV, we need to cache the
2061 NV as well. Moreover, we trade speed for space, and do not
2062 cache the NV if not needed.
2065 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2066 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2067 == IS_NUMBER_IN_UV) {
2068 /* It's definitely an integer, only upgrade to PVIV */
2069 if (SvTYPE(sv) < SVt_PVIV)
2070 sv_upgrade(sv, SVt_PVIV);
2072 } else if (SvTYPE(sv) < SVt_PVNV)
2073 sv_upgrade(sv, SVt_PVNV);
2075 /* If NV preserves UV then we only use the UV value if we know that
2076 we aren't going to call atof() below. If NVs don't preserve UVs
2077 then the value returned may have more precision than atof() will
2078 return, even though it isn't accurate. */
2079 if ((numtype & (IS_NUMBER_IN_UV
2080 #ifdef NV_PRESERVES_UV
2083 )) == IS_NUMBER_IN_UV) {
2084 /* This won't turn off the public IOK flag if it was set above */
2085 (void)SvIOKp_on(sv);
2087 if (!(numtype & IS_NUMBER_NEG)) {
2089 if (value <= (UV)IV_MAX) {
2090 SvIV_set(sv, (IV)value);
2092 /* it didn't overflow, and it was positive. */
2093 SvUV_set(sv, value);
2097 /* 2s complement assumption */
2098 if (value <= (UV)IV_MIN) {
2099 SvIV_set(sv, -(IV)value);
2101 /* Too negative for an IV. This is a double upgrade, but
2102 I'm assuming it will be rare. */
2103 if (SvTYPE(sv) < SVt_PVNV)
2104 sv_upgrade(sv, SVt_PVNV);
2108 SvNV_set(sv, -(NV)value);
2109 SvIV_set(sv, IV_MIN);
2114 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2115 != IS_NUMBER_IN_UV) {
2116 /* It wasn't an integer, or it overflowed the UV. */
2117 SvNV_set(sv, Atof(SvPVX_const(sv)));
2119 if (! numtype && ckWARN(WARN_NUMERIC))
2122 #if defined(USE_LONG_DOUBLE)
2123 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2124 PTR2UV(sv), SvNVX(sv)));
2126 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2127 PTR2UV(sv), SvNVX(sv)));
2130 #ifdef NV_PRESERVES_UV
2131 (void)SvIOKp_on(sv);
2133 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2134 SvIV_set(sv, I_V(SvNVX(sv)));
2135 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2138 /* Integer is imprecise. NOK, IOKp */
2140 /* UV will not work better than IV */
2142 if (SvNVX(sv) > (NV)UV_MAX) {
2144 /* Integer is inaccurate. NOK, IOKp, is UV */
2145 SvUV_set(sv, UV_MAX);
2148 SvUV_set(sv, U_V(SvNVX(sv)));
2149 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2150 NV preservse UV so can do correct comparison. */
2151 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2155 /* Integer is imprecise. NOK, IOKp, is UV */
2160 #else /* NV_PRESERVES_UV */
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2163 /* The UV slot will have been set from value returned by
2164 grok_number above. The NV slot has just been set using
2167 assert (SvIOKp(sv));
2169 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2170 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2171 /* Small enough to preserve all bits. */
2172 (void)SvIOKp_on(sv);
2174 SvIV_set(sv, I_V(SvNVX(sv)));
2175 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2177 /* Assumption: first non-preserved integer is < IV_MAX,
2178 this NV is in the preserved range, therefore: */
2179 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2181 Perl_croak(aTHX_ "sv_2uv 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);
2184 sv_2iuv_non_preserve (sv, numtype);
2186 #endif /* NV_PRESERVES_UV */
2190 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2191 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2194 if (SvTYPE(sv) < SVt_IV)
2195 /* Typically the caller expects that sv_any is not NULL now. */
2196 sv_upgrade(sv, SVt_IV);
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2201 PTR2UV(sv),SvUVX(sv)));
2202 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2208 Return the num value of an SV, doing any necessary string or integer
2209 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2216 Perl_sv_2nv(pTHX_ register SV *sv)
2220 if (SvGMAGICAL(sv)) {
2224 if (SvPOKp(sv) && SvLEN(sv)) {
2225 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2226 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2228 return Atof(SvPVX_const(sv));
2232 return (NV)SvUVX(sv);
2234 return (NV)SvIVX(sv);
2237 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2238 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2244 if (SvTHINKFIRST(sv)) {
2247 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2248 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2249 return SvNV(tmpstr);
2250 return PTR2NV(SvRV(sv));
2253 sv_force_normal_flags(sv, 0);
2255 if (SvREADONLY(sv) && !SvOK(sv)) {
2256 if (ckWARN(WARN_UNINITIALIZED))
2261 if (SvTYPE(sv) < SVt_NV) {
2262 if (SvTYPE(sv) == SVt_IV)
2263 sv_upgrade(sv, SVt_PVNV);
2265 sv_upgrade(sv, SVt_NV);
2266 #ifdef USE_LONG_DOUBLE
2268 STORE_NUMERIC_LOCAL_SET_STANDARD();
2269 PerlIO_printf(Perl_debug_log,
2270 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2271 PTR2UV(sv), SvNVX(sv));
2272 RESTORE_NUMERIC_LOCAL();
2276 STORE_NUMERIC_LOCAL_SET_STANDARD();
2277 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2278 PTR2UV(sv), SvNVX(sv));
2279 RESTORE_NUMERIC_LOCAL();
2283 else if (SvTYPE(sv) < SVt_PVNV)
2284 sv_upgrade(sv, SVt_PVNV);
2289 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2290 #ifdef NV_PRESERVES_UV
2293 /* Only set the public NV OK flag if this NV preserves the IV */
2294 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2295 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2296 : (SvIVX(sv) == I_V(SvNVX(sv))))
2302 else if (SvPOKp(sv) && SvLEN(sv)) {
2304 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2305 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2307 #ifdef NV_PRESERVES_UV
2308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2309 == IS_NUMBER_IN_UV) {
2310 /* It's definitely an integer */
2311 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2313 SvNV_set(sv, Atof(SvPVX_const(sv)));
2316 SvNV_set(sv, Atof(SvPVX_const(sv)));
2317 /* Only set the public NV OK flag if this NV preserves the value in
2318 the PV at least as well as an IV/UV would.
2319 Not sure how to do this 100% reliably. */
2320 /* if that shift count is out of range then Configure's test is
2321 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2323 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2324 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2325 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2326 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2327 /* Can't use strtol etc to convert this string, so don't try.
2328 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2331 /* value has been set. It may not be precise. */
2332 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2333 /* 2s complement assumption for (UV)IV_MIN */
2334 SvNOK_on(sv); /* Integer is too negative. */
2339 if (numtype & IS_NUMBER_NEG) {
2340 SvIV_set(sv, -(IV)value);
2341 } else if (value <= (UV)IV_MAX) {
2342 SvIV_set(sv, (IV)value);
2344 SvUV_set(sv, value);
2348 if (numtype & IS_NUMBER_NOT_INT) {
2349 /* I believe that even if the original PV had decimals,
2350 they are lost beyond the limit of the FP precision.
2351 However, neither is canonical, so both only get p
2352 flags. NWC, 2000/11/25 */
2353 /* Both already have p flags, so do nothing */
2355 const NV nv = SvNVX(sv);
2356 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2357 if (SvIVX(sv) == I_V(nv)) {
2362 /* It had no "." so it must be integer. */
2365 /* between IV_MAX and NV(UV_MAX).
2366 Could be slightly > UV_MAX */
2368 if (numtype & IS_NUMBER_NOT_INT) {
2369 /* UV and NV both imprecise. */
2371 const UV nv_as_uv = U_V(nv);
2373 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2384 #endif /* NV_PRESERVES_UV */
2387 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2389 if (SvTYPE(sv) < SVt_NV)
2390 /* Typically the caller expects that sv_any is not NULL now. */
2391 /* XXX Ilya implies that this is a bug in callers that assume this
2392 and ideally should be fixed. */
2393 sv_upgrade(sv, SVt_NV);
2396 #if defined(USE_LONG_DOUBLE)
2398 STORE_NUMERIC_LOCAL_SET_STANDARD();
2399 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 STORE_NUMERIC_LOCAL_SET_STANDARD();
2406 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2407 PTR2UV(sv), SvNVX(sv));
2408 RESTORE_NUMERIC_LOCAL();
2414 /* asIV(): extract an integer from the string value of an SV.
2415 * Caller must validate PVX */
2418 S_asIV(pTHX_ SV *sv)
2421 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2424 == IS_NUMBER_IN_UV) {
2425 /* It's definitely an integer */
2426 if (numtype & IS_NUMBER_NEG) {
2427 if (value < (UV)IV_MIN)
2430 if (value < (UV)IV_MAX)
2435 if (ckWARN(WARN_NUMERIC))
2438 return I_V(Atof(SvPVX_const(sv)));
2441 /* asUV(): extract an unsigned integer from the string value of an SV
2442 * Caller must validate PVX */
2445 S_asUV(pTHX_ SV *sv)
2448 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2450 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2451 == IS_NUMBER_IN_UV) {
2452 /* It's definitely an integer */
2453 if (!(numtype & IS_NUMBER_NEG))
2457 if (ckWARN(WARN_NUMERIC))
2460 return U_V(Atof(SvPVX_const(sv)));
2463 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2464 * UV as a string towards the end of buf, and return pointers to start and
2467 * We assume that buf is at least TYPE_CHARS(UV) long.
2471 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2473 char *ptr = buf + TYPE_CHARS(UV);
2474 char * const ebuf = ptr;
2487 *--ptr = '0' + (char)(uv % 10);
2496 =for apidoc sv_2pv_flags
2498 Returns a pointer to the string value of an SV, and sets *lp to its length.
2499 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2501 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2502 usually end up here too.
2508 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2513 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2514 char *tmpbuf = tbuf;
2515 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
2522 if (SvGMAGICAL(sv)) {
2523 if (flags & SV_GMAGIC)
2528 if (flags & SV_MUTABLE_RETURN)
2529 return SvPVX_mutable(sv);
2530 if (flags & SV_CONST_RETURN)
2531 return (char *)SvPVX_const(sv);
2535 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2536 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2538 goto tokensave_has_len;
2541 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2546 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2547 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2555 if (SvTHINKFIRST(sv)) {
2559 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2560 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2562 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2565 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2566 if (flags & SV_CONST_RETURN) {
2567 pv = (char *) SvPVX_const(tmpstr);
2569 pv = (flags & SV_MUTABLE_RETURN)
2570 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2573 *lp = SvCUR(tmpstr);
2575 pv = sv_2pv_flags(tmpstr, lp, flags);
2584 const SV *const referent = (SV*)SvRV(sv);
2587 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2588 } else if (SvTYPE(referent) == SVt_PVMG
2589 && ((SvFLAGS(referent) &
2590 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2591 == (SVs_OBJECT|SVs_SMG))
2592 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2593 const regexp *re = (regexp *)mg->mg_obj;
2596 const char *fptr = "msix";
2601 char need_newline = 0;
2603 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2605 while((ch = *fptr++)) {
2607 reflags[left++] = ch;
2610 reflags[right--] = ch;
2615 reflags[left] = '-';
2619 mg->mg_len = re->prelen + 4 + left;
2621 * If /x was used, we have to worry about a regex
2622 * ending with a comment later being embedded
2623 * within another regex. If so, we don't want this
2624 * regex's "commentization" to leak out to the
2625 * right part of the enclosing regex, we must cap
2626 * it with a newline.
2628 * So, if /x was used, we scan backwards from the
2629 * end of the regex. If we find a '#' before we
2630 * find a newline, we need to add a newline
2631 * ourself. If we find a '\n' first (or if we
2632 * don't find '#' or '\n'), we don't need to add
2633 * anything. -jfriedl
2635 if (PMf_EXTENDED & re->reganch) {
2636 const char *endptr = re->precomp + re->prelen;
2637 while (endptr >= re->precomp) {
2638 const char c = *(endptr--);
2640 break; /* don't need another */
2642 /* we end while in a comment, so we
2644 mg->mg_len++; /* save space for it */
2645 need_newline = 1; /* note to add it */
2651 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2652 Copy("(?", mg->mg_ptr, 2, char);
2653 Copy(reflags, mg->mg_ptr+2, left, char);
2654 Copy(":", mg->mg_ptr+left+2, 1, char);
2655 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2657 mg->mg_ptr[mg->mg_len - 2] = '\n';
2658 mg->mg_ptr[mg->mg_len - 1] = ')';
2659 mg->mg_ptr[mg->mg_len] = 0;
2661 PL_reginterp_cnt += re->program[0].next_off;
2663 if (re->reganch & ROPT_UTF8)
2671 const char *const typestr = sv_reftype(referent, 0);
2673 tsv = sv_newmortal();
2674 if (SvOBJECT(referent)) {
2675 const char *const name = HvNAME_get(SvSTASH(referent));
2676 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2677 name ? name : "__ANON__" , typestr,
2681 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2689 if (SvREADONLY(sv) && !SvOK(sv)) {
2690 if (ckWARN(WARN_UNINITIALIZED))
2697 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2698 /* I'm assuming that if both IV and NV are equally valid then
2699 converting the IV is going to be more efficient */
2700 const U32 isIOK = SvIOK(sv);
2701 const U32 isUIOK = SvIsUV(sv);
2702 char buf[TYPE_CHARS(UV)];
2705 if (SvTYPE(sv) < SVt_PVIV)
2706 sv_upgrade(sv, SVt_PVIV);
2708 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2710 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2711 /* inlined from sv_setpvn */
2712 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2713 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2714 SvCUR_set(sv, ebuf - ptr);
2724 else if (SvNOKp(sv)) {
2725 if (SvTYPE(sv) < SVt_PVNV)
2726 sv_upgrade(sv, SVt_PVNV);
2727 /* The +20 is pure guesswork. Configure test needed. --jhi */
2728 s = SvGROW_mutable(sv, NV_DIG + 20);
2729 olderrno = errno; /* some Xenix systems wipe out errno here */
2731 if (SvNVX(sv) == 0.0)
2732 (void)strcpy(s,"0");
2736 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2739 #ifdef FIXNEGATIVEZERO
2740 if (*s == '-' && s[1] == '0' && !s[2])
2750 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2754 if (SvTYPE(sv) < SVt_PV)
2755 /* Typically the caller expects that sv_any is not NULL now. */
2756 sv_upgrade(sv, SVt_PV);
2760 const STRLEN len = s - SvPVX_const(sv);
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2767 PTR2UV(sv),SvPVX_const(sv)));
2768 if (flags & SV_CONST_RETURN)
2769 return (char *)SvPVX_const(sv);
2770 if (flags & SV_MUTABLE_RETURN)
2771 return SvPVX_mutable(sv);
2775 len = strlen(tmpbuf);
2778 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2779 /* Sneaky stuff here */
2782 tsv = newSVpvn(tmpbuf, len);
2791 #ifdef FIXNEGATIVEZERO
2792 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2798 SvUPGRADE(sv, SVt_PV);
2801 s = SvGROW_mutable(sv, len + 1);
2804 return memcpy(s, tmpbuf, len + 1);
2809 =for apidoc sv_copypv
2811 Copies a stringified representation of the source SV into the
2812 destination SV. Automatically performs any necessary mg_get and
2813 coercion of numeric values into strings. Guaranteed to preserve
2814 UTF-8 flag even from overloaded objects. Similar in nature to
2815 sv_2pv[_flags] but operates directly on an SV instead of just the
2816 string. Mostly uses sv_2pv_flags to do its work, except when that
2817 would lose the UTF-8'ness of the PV.
2823 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2826 const char * const s = SvPV_const(ssv,len);
2827 sv_setpvn(dsv,s,len);
2835 =for apidoc sv_2pvbyte
2837 Return a pointer to the byte-encoded representation of the SV, and set *lp
2838 to its length. May cause the SV to be downgraded from UTF-8 as a
2841 Usually accessed via the C<SvPVbyte> macro.
2847 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2849 sv_utf8_downgrade(sv,0);
2850 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2854 =for apidoc sv_2pvutf8
2856 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2857 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2859 Usually accessed via the C<SvPVutf8> macro.
2865 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2867 sv_utf8_upgrade(sv);
2868 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2873 =for apidoc sv_2bool
2875 This function is only called on magical items, and is only used by
2876 sv_true() or its macro equivalent.
2882 Perl_sv_2bool(pTHX_ register SV *sv)
2890 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2891 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2892 return (bool)SvTRUE(tmpsv);
2893 return SvRV(sv) != 0;
2896 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2898 (*sv->sv_u.svu_pv > '0' ||
2899 Xpvtmp->xpv_cur > 1 ||
2900 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2907 return SvIVX(sv) != 0;
2910 return SvNVX(sv) != 0.0;
2918 =for apidoc sv_utf8_upgrade
2920 Converts the PV of an SV to its UTF-8-encoded form.
2921 Forces the SV to string form if it is not already.
2922 Always sets the SvUTF8 flag to avoid future validity checks even
2923 if all the bytes have hibit clear.
2925 This is not as a general purpose byte encoding to Unicode interface:
2926 use the Encode extension for that.
2928 =for apidoc sv_utf8_upgrade_flags
2930 Converts the PV of an SV to its UTF-8-encoded form.
2931 Forces the SV to string form if it is not already.
2932 Always sets the SvUTF8 flag to avoid future validity checks even
2933 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2934 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2935 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2937 This is not as a general purpose byte encoding to Unicode interface:
2938 use the Encode extension for that.
2944 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2946 if (sv == &PL_sv_undef)
2950 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2951 (void) sv_2pv_flags(sv,&len, flags);
2955 (void) SvPV_force(sv,len);
2964 sv_force_normal_flags(sv, 0);
2967 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2968 sv_recode_to_utf8(sv, PL_encoding);
2969 else { /* Assume Latin-1/EBCDIC */
2970 /* This function could be much more efficient if we
2971 * had a FLAG in SVs to signal if there are any hibit
2972 * chars in the PV. Given that there isn't such a flag
2973 * make the loop as fast as possible. */
2974 const U8 *s = (U8 *) SvPVX_const(sv);
2975 const U8 * const e = (U8 *) SvEND(sv);
2981 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2985 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2986 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2988 SvPV_free(sv); /* No longer using what was there before. */
2990 SvPV_set(sv, (char*)recoded);
2991 SvCUR_set(sv, len - 1);
2992 SvLEN_set(sv, len); /* No longer know the real size. */
2994 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3001 =for apidoc sv_utf8_downgrade
3003 Attempts to convert the PV of an SV from characters to bytes.
3004 If the PV contains a character beyond byte, this conversion will fail;
3005 in this case, either returns false or, if C<fail_ok> is not
3008 This is not as a general purpose Unicode to byte encoding interface:
3009 use the Encode extension for that.
3015 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3017 if (SvPOKp(sv) && SvUTF8(sv)) {
3023 sv_force_normal_flags(sv, 0);
3025 s = (U8 *) SvPV(sv, len);
3026 if (!utf8_to_bytes(s, &len)) {
3031 Perl_croak(aTHX_ "Wide character in %s",
3034 Perl_croak(aTHX_ "Wide character");
3045 =for apidoc sv_utf8_encode
3047 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3048 flag off so that it looks like octets again.
3054 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3056 (void) sv_utf8_upgrade(sv);
3058 sv_force_normal_flags(sv, 0);
3060 if (SvREADONLY(sv)) {
3061 Perl_croak(aTHX_ PL_no_modify);
3067 =for apidoc sv_utf8_decode
3069 If the PV of the SV is an octet sequence in UTF-8
3070 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3071 so that it looks like a character. If the PV contains only single-byte
3072 characters, the C<SvUTF8> flag stays being off.
3073 Scans PV for validity and returns false if the PV is invalid UTF-8.
3079 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3085 /* The octets may have got themselves encoded - get them back as
3088 if (!sv_utf8_downgrade(sv, TRUE))
3091 /* it is actually just a matter of turning the utf8 flag on, but
3092 * we want to make sure everything inside is valid utf8 first.
3094 c = (const U8 *) SvPVX_const(sv);
3095 if (!is_utf8_string(c, SvCUR(sv)+1))
3097 e = (const U8 *) SvEND(sv);
3100 if (!UTF8_IS_INVARIANT(ch)) {
3110 =for apidoc sv_setsv
3112 Copies the contents of the source SV C<ssv> into the destination SV
3113 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3114 function if the source SV needs to be reused. Does not handle 'set' magic.
3115 Loosely speaking, it performs a copy-by-value, obliterating any previous
3116 content of the destination.
3118 You probably want to use one of the assortment of wrappers, such as
3119 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3120 C<SvSetMagicSV_nosteal>.
3122 =for apidoc sv_setsv_flags
3124 Copies the contents of the source SV C<ssv> into the destination SV
3125 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3126 function if the source SV needs to be reused. Does not handle 'set' magic.
3127 Loosely speaking, it performs a copy-by-value, obliterating any previous
3128 content of the destination.
3129 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3130 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3131 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3132 and C<sv_setsv_nomg> are implemented in terms of this function.
3134 You probably want to use one of the assortment of wrappers, such as
3135 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3136 C<SvSetMagicSV_nosteal>.
3138 This is the primary function for copying scalars, and most other
3139 copy-ish functions and macros use this underneath.
3145 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3147 register U32 sflags;
3153 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3155 sstr = &PL_sv_undef;
3156 stype = SvTYPE(sstr);
3157 dtype = SvTYPE(dstr);
3162 /* need to nuke the magic */
3164 SvRMAGICAL_off(dstr);
3167 /* There's a lot of redundancy below but we're going for speed here */
3172 if (dtype != SVt_PVGV) {
3173 (void)SvOK_off(dstr);
3181 sv_upgrade(dstr, SVt_IV);
3184 sv_upgrade(dstr, SVt_PVNV);
3188 sv_upgrade(dstr, SVt_PVIV);
3191 (void)SvIOK_only(dstr);
3192 SvIV_set(dstr, SvIVX(sstr));
3195 if (SvTAINTED(sstr))
3206 sv_upgrade(dstr, SVt_NV);
3211 sv_upgrade(dstr, SVt_PVNV);
3214 SvNV_set(dstr, SvNVX(sstr));
3215 (void)SvNOK_only(dstr);
3216 if (SvTAINTED(sstr))
3224 sv_upgrade(dstr, SVt_RV);
3225 else if (dtype == SVt_PVGV &&
3226 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3229 if (GvIMPORTED(dstr) != GVf_IMPORTED
3230 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3232 GvIMPORTED_on(dstr);
3241 #ifdef PERL_OLD_COPY_ON_WRITE
3242 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3243 if (dtype < SVt_PVIV)
3244 sv_upgrade(dstr, SVt_PVIV);
3251 sv_upgrade(dstr, SVt_PV);
3254 if (dtype < SVt_PVIV)
3255 sv_upgrade(dstr, SVt_PVIV);
3258 if (dtype < SVt_PVNV)
3259 sv_upgrade(dstr, SVt_PVNV);
3266 const char * const type = sv_reftype(sstr,0);
3268 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3270 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3275 if (dtype <= SVt_PVGV) {
3277 if (dtype != SVt_PVGV) {
3278 const char * const name = GvNAME(sstr);
3279 const STRLEN len = GvNAMELEN(sstr);
3280 /* don't upgrade SVt_PVLV: it can hold a glob */
3281 if (dtype != SVt_PVLV)
3282 sv_upgrade(dstr, SVt_PVGV);
3283 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3284 GvSTASH(dstr) = GvSTASH(sstr);
3286 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3287 GvNAME(dstr) = savepvn(name, len);
3288 GvNAMELEN(dstr) = len;
3289 SvFAKE_on(dstr); /* can coerce to non-glob */
3292 #ifdef GV_UNIQUE_CHECK
3293 if (GvUNIQUE((GV*)dstr)) {
3294 Perl_croak(aTHX_ PL_no_modify);
3298 (void)SvOK_off(dstr);
3299 GvINTRO_off(dstr); /* one-shot flag */
3301 GvGP(dstr) = gp_ref(GvGP(sstr));
3302 if (SvTAINTED(sstr))
3304 if (GvIMPORTED(dstr) != GVf_IMPORTED
3305 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3307 GvIMPORTED_on(dstr);
3315 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3317 if ((int)SvTYPE(sstr) != stype) {
3318 stype = SvTYPE(sstr);
3319 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3323 if (stype == SVt_PVLV)
3324 SvUPGRADE(dstr, SVt_PVNV);
3326 SvUPGRADE(dstr, (U32)stype);
3329 sflags = SvFLAGS(sstr);
3331 if (sflags & SVf_ROK) {
3332 if (dtype >= SVt_PV) {
3333 if (dtype == SVt_PVGV) {
3334 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3336 const int intro = GvINTRO(dstr);
3338 #ifdef GV_UNIQUE_CHECK
3339 if (GvUNIQUE((GV*)dstr)) {
3340 Perl_croak(aTHX_ PL_no_modify);
3345 GvINTRO_off(dstr); /* one-shot flag */
3346 GvLINE(dstr) = CopLINE(PL_curcop);
3347 GvEGV(dstr) = (GV*)dstr;
3350 switch (SvTYPE(sref)) {
3353 SAVEGENERICSV(GvAV(dstr));
3355 dref = (SV*)GvAV(dstr);
3356 GvAV(dstr) = (AV*)sref;
3357 if (!GvIMPORTED_AV(dstr)
3358 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3360 GvIMPORTED_AV_on(dstr);
3365 SAVEGENERICSV(GvHV(dstr));
3367 dref = (SV*)GvHV(dstr);
3368 GvHV(dstr) = (HV*)sref;
3369 if (!GvIMPORTED_HV(dstr)
3370 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3372 GvIMPORTED_HV_on(dstr);
3377 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3378 SvREFCNT_dec(GvCV(dstr));
3379 GvCV(dstr) = Nullcv;
3380 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3381 PL_sub_generation++;
3383 SAVEGENERICSV(GvCV(dstr));
3386 dref = (SV*)GvCV(dstr);
3387 if (GvCV(dstr) != (CV*)sref) {
3388 CV* const cv = GvCV(dstr);
3390 if (!GvCVGEN((GV*)dstr) &&
3391 (CvROOT(cv) || CvXSUB(cv)))
3393 /* Redefining a sub - warning is mandatory if
3394 it was a const and its value changed. */
3395 if (ckWARN(WARN_REDEFINE)
3397 && (!CvCONST((CV*)sref)
3398 || sv_cmp(cv_const_sv(cv),
3399 cv_const_sv((CV*)sref)))))
3401 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3403 ? "Constant subroutine %s::%s redefined"
3404 : "Subroutine %s::%s redefined",
3405 HvNAME_get(GvSTASH((GV*)dstr)),
3406 GvENAME((GV*)dstr));
3410 cv_ckproto(cv, (GV*)dstr,
3412 ? SvPVX_const(sref) : Nullch);
3414 GvCV(dstr) = (CV*)sref;
3415 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3416 GvASSUMECV_on(dstr);
3417 PL_sub_generation++;
3419 if (!GvIMPORTED_CV(dstr)
3420 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3422 GvIMPORTED_CV_on(dstr);
3427 SAVEGENERICSV(GvIOp(dstr));
3429 dref = (SV*)GvIOp(dstr);
3430 GvIOp(dstr) = (IO*)sref;
3434 SAVEGENERICSV(GvFORM(dstr));
3436 dref = (SV*)GvFORM(dstr);
3437 GvFORM(dstr) = (CV*)sref;
3441 SAVEGENERICSV(GvSV(dstr));
3443 dref = (SV*)GvSV(dstr);
3445 if (!GvIMPORTED_SV(dstr)
3446 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3448 GvIMPORTED_SV_on(dstr);
3454 if (SvTAINTED(sstr))
3458 if (SvPVX_const(dstr)) {
3464 (void)SvOK_off(dstr);
3465 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3467 if (sflags & SVp_NOK) {
3469 /* Only set the public OK flag if the source has public OK. */
3470 if (sflags & SVf_NOK)
3471 SvFLAGS(dstr) |= SVf_NOK;
3472 SvNV_set(dstr, SvNVX(sstr));
3474 if (sflags & SVp_IOK) {
3475 (void)SvIOKp_on(dstr);
3476 if (sflags & SVf_IOK)
3477 SvFLAGS(dstr) |= SVf_IOK;
3478 if (sflags & SVf_IVisUV)
3480 SvIV_set(dstr, SvIVX(sstr));
3482 if (SvAMAGIC(sstr)) {
3486 else if (sflags & SVp_POK) {
3490 * Check to see if we can just swipe the string. If so, it's a
3491 * possible small lose on short strings, but a big win on long ones.
3492 * It might even be a win on short strings if SvPVX_const(dstr)
3493 * has to be allocated and SvPVX_const(sstr) has to be freed.
3496 /* Whichever path we take through the next code, we want this true,
3497 and doing it now facilitates the COW check. */
3498 (void)SvPOK_only(dstr);
3501 /* We're not already COW */
3502 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3503 #ifndef PERL_OLD_COPY_ON_WRITE
3504 /* or we are, but dstr isn't a suitable target. */
3505 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3510 (sflags & SVs_TEMP) && /* slated for free anyway? */
3511 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3512 (!(flags & SV_NOSTEAL)) &&
3513 /* and we're allowed to steal temps */
3514 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3515 SvLEN(sstr) && /* and really is a string */
3516 /* and won't be needed again, potentially */
3517 !(PL_op && PL_op->op_type == OP_AASSIGN))
3518 #ifdef PERL_OLD_COPY_ON_WRITE
3519 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3520 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3521 && SvTYPE(sstr) >= SVt_PVIV)
3524 /* Failed the swipe test, and it's not a shared hash key either.
3525 Have to copy the string. */
3526 STRLEN len = SvCUR(sstr);
3527 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3528 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3529 SvCUR_set(dstr, len);
3530 *SvEND(dstr) = '\0';
3532 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3534 /* Either it's a shared hash key, or it's suitable for
3535 copy-on-write or we can swipe the string. */
3537 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3541 #ifdef PERL_OLD_COPY_ON_WRITE
3543 /* I believe I should acquire a global SV mutex if
3544 it's a COW sv (not a shared hash key) to stop
3545 it going un copy-on-write.
3546 If the source SV has gone un copy on write between up there
3547 and down here, then (assert() that) it is of the correct
3548 form to make it copy on write again */
3549 if ((sflags & (SVf_FAKE | SVf_READONLY))
3550 != (SVf_FAKE | SVf_READONLY)) {
3551 SvREADONLY_on(sstr);
3553 /* Make the source SV into a loop of 1.
3554 (about to become 2) */
3555 SV_COW_NEXT_SV_SET(sstr, sstr);
3559 /* Initial code is common. */
3560 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3565 /* making another shared SV. */
3566 STRLEN cur = SvCUR(sstr);
3567 STRLEN len = SvLEN(sstr);
3568 #ifdef PERL_OLD_COPY_ON_WRITE
3570 assert (SvTYPE(dstr) >= SVt_PVIV);
3571 /* SvIsCOW_normal */
3572 /* splice us in between source and next-after-source. */
3573 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3574 SV_COW_NEXT_SV_SET(sstr, dstr);
3575 SvPV_set(dstr, SvPVX_mutable(sstr));
3579 /* SvIsCOW_shared_hash */
3580 DEBUG_C(PerlIO_printf(Perl_debug_log,
3581 "Copy on write: Sharing hash\n"));
3583 assert (SvTYPE(dstr) >= SVt_PV);
3585 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3587 SvLEN_set(dstr, len);
3588 SvCUR_set(dstr, cur);
3589 SvREADONLY_on(dstr);
3591 /* Relesase a global SV mutex. */
3594 { /* Passes the swipe test. */
3595 SvPV_set(dstr, SvPVX_mutable(sstr));
3596 SvLEN_set(dstr, SvLEN(sstr));
3597 SvCUR_set(dstr, SvCUR(sstr));
3600 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3601 SvPV_set(sstr, Nullch);
3607 if (sflags & SVf_UTF8)
3609 if (sflags & SVp_NOK) {
3611 if (sflags & SVf_NOK)
3612 SvFLAGS(dstr) |= SVf_NOK;
3613 SvNV_set(dstr, SvNVX(sstr));
3615 if (sflags & SVp_IOK) {
3616 (void)SvIOKp_on(dstr);
3617 if (sflags & SVf_IOK)
3618 SvFLAGS(dstr) |= SVf_IOK;
3619 if (sflags & SVf_IVisUV)
3621 SvIV_set(dstr, SvIVX(sstr));
3624 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3625 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3626 smg->mg_ptr, smg->mg_len);
3627 SvRMAGICAL_on(dstr);
3630 else if (sflags & SVp_IOK) {
3631 if (sflags & SVf_IOK)
3632 (void)SvIOK_only(dstr);
3634 (void)SvOK_off(dstr);
3635 (void)SvIOKp_on(dstr);
3637 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3638 if (sflags & SVf_IVisUV)
3640 SvIV_set(dstr, SvIVX(sstr));
3641 if (sflags & SVp_NOK) {
3642 if (sflags & SVf_NOK)
3643 (void)SvNOK_on(dstr);
3645 (void)SvNOKp_on(dstr);
3646 SvNV_set(dstr, SvNVX(sstr));
3649 else if (sflags & SVp_NOK) {
3650 if (sflags & SVf_NOK)
3651 (void)SvNOK_only(dstr);
3653 (void)SvOK_off(dstr);
3656 SvNV_set(dstr, SvNVX(sstr));
3659 if (dtype == SVt_PVGV) {
3660 if (ckWARN(WARN_MISC))
3661 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3664 (void)SvOK_off(dstr);
3666 if (SvTAINTED(sstr))
3671 =for apidoc sv_setsv_mg
3673 Like C<sv_setsv>, but also handles 'set' magic.
3679 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3681 sv_setsv(dstr,sstr);
3685 #ifdef PERL_OLD_COPY_ON_WRITE
3687 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3689 STRLEN cur = SvCUR(sstr);
3690 STRLEN len = SvLEN(sstr);
3691 register char *new_pv;
3694 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3702 if (SvTHINKFIRST(dstr))
3703 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3704 else if (SvPVX_const(dstr))
3705 Safefree(SvPVX_const(dstr));
3709 SvUPGRADE(dstr, SVt_PVIV);
3711 assert (SvPOK(sstr));
3712 assert (SvPOKp(sstr));
3713 assert (!SvIOK(sstr));
3714 assert (!SvIOKp(sstr));
3715 assert (!SvNOK(sstr));
3716 assert (!SvNOKp(sstr));
3718 if (SvIsCOW(sstr)) {
3720 if (SvLEN(sstr) == 0) {
3721 /* source is a COW shared hash key. */
3722 DEBUG_C(PerlIO_printf(Perl_debug_log,
3723 "Fast copy on write: Sharing hash\n"));
3724 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3727 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3729 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3730 SvUPGRADE(sstr, SVt_PVIV);
3731 SvREADONLY_on(sstr);
3733 DEBUG_C(PerlIO_printf(Perl_debug_log,
3734 "Fast copy on write: Converting sstr to COW\n"));
3735 SV_COW_NEXT_SV_SET(dstr, sstr);
3737 SV_COW_NEXT_SV_SET(sstr, dstr);
3738 new_pv = SvPVX_mutable(sstr);
3741 SvPV_set(dstr, new_pv);
3742 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3745 SvLEN_set(dstr, len);
3746 SvCUR_set(dstr, cur);
3755 =for apidoc sv_setpvn
3757 Copies a string into an SV. The C<len> parameter indicates the number of
3758 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3759 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3765 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3767 register char *dptr;
3769 SV_CHECK_THINKFIRST_COW_DROP(sv);
3775 /* len is STRLEN which is unsigned, need to copy to signed */
3778 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3780 SvUPGRADE(sv, SVt_PV);
3782 dptr = SvGROW(sv, len + 1);
3783 Move(ptr,dptr,len,char);
3786 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3791 =for apidoc sv_setpvn_mg
3793 Like C<sv_setpvn>, but also handles 'set' magic.
3799 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3801 sv_setpvn(sv,ptr,len);
3806 =for apidoc sv_setpv
3808 Copies a string into an SV. The string must be null-terminated. Does not
3809 handle 'set' magic. See C<sv_setpv_mg>.
3815 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3817 register STRLEN len;
3819 SV_CHECK_THINKFIRST_COW_DROP(sv);
3825 SvUPGRADE(sv, SVt_PV);
3827 SvGROW(sv, len + 1);
3828 Move(ptr,SvPVX(sv),len+1,char);
3830 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3835 =for apidoc sv_setpv_mg
3837 Like C<sv_setpv>, but also handles 'set' magic.
3843 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3850 =for apidoc sv_usepvn
3852 Tells an SV to use C<ptr> to find its string value. Normally the string is
3853 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3854 The C<ptr> should point to memory that was allocated by C<malloc>. The
3855 string length, C<len>, must be supplied. This function will realloc the
3856 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3857 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3858 See C<sv_usepvn_mg>.
3864 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3867 SV_CHECK_THINKFIRST_COW_DROP(sv);
3868 SvUPGRADE(sv, SVt_PV);
3873 if (SvPVX_const(sv))
3876 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3877 ptr = saferealloc (ptr, allocate);
3880 SvLEN_set(sv, allocate);
3882 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3887 =for apidoc sv_usepvn_mg
3889 Like C<sv_usepvn>, but also handles 'set' magic.
3895 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3897 sv_usepvn(sv,ptr,len);
3901 #ifdef PERL_OLD_COPY_ON_WRITE
3902 /* Need to do this *after* making the SV normal, as we need the buffer
3903 pointer to remain valid until after we've copied it. If we let go too early,
3904 another thread could invalidate it by unsharing last of the same hash key
3905 (which it can do by means other than releasing copy-on-write Svs)
3906 or by changing the other copy-on-write SVs in the loop. */
3908 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3910 if (len) { /* this SV was SvIsCOW_normal(sv) */
3911 /* we need to find the SV pointing to us. */
3912 SV * const current = SV_COW_NEXT_SV(after);
3914 if (current == sv) {
3915 /* The SV we point to points back to us (there were only two of us
3917 Hence other SV is no longer copy on write either. */
3919 SvREADONLY_off(after);
3921 /* We need to follow the pointers around the loop. */
3923 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3926 /* don't loop forever if the structure is bust, and we have
3927 a pointer into a closed loop. */
3928 assert (current != after);
3929 assert (SvPVX_const(current) == pvx);
3931 /* Make the SV before us point to the SV after us. */
3932 SV_COW_NEXT_SV_SET(current, after);
3935 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3940 Perl_sv_release_IVX(pTHX_ register SV *sv)
3943 sv_force_normal_flags(sv, 0);
3949 =for apidoc sv_force_normal_flags
3951 Undo various types of fakery on an SV: if the PV is a shared string, make
3952 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3953 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3954 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3955 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3956 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3957 set to some other value.) In addition, the C<flags> parameter gets passed to
3958 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3959 with flags set to 0.
3965 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3967 #ifdef PERL_OLD_COPY_ON_WRITE
3968 if (SvREADONLY(sv)) {
3969 /* At this point I believe I should acquire a global SV mutex. */
3971 const char * const pvx = SvPVX_const(sv);
3972 const STRLEN len = SvLEN(sv);
3973 const STRLEN cur = SvCUR(sv);
3974 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3976 PerlIO_printf(Perl_debug_log,
3977 "Copy on write: Force normal %ld\n",
3983 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3984 SvPV_set(sv, (char*)0);
3986 if (flags & SV_COW_DROP_PV) {
3987 /* OK, so we don't need to copy our buffer. */
3990 SvGROW(sv, cur + 1);
3991 Move(pvx,SvPVX(sv),cur,char);
3995 sv_release_COW(sv, pvx, len, next);
4000 else if (IN_PERL_RUNTIME)
4001 Perl_croak(aTHX_ PL_no_modify);
4002 /* At this point I believe that I can drop the global SV mutex. */
4005 if (SvREADONLY(sv)) {
4007 const char * const pvx = SvPVX_const(sv);
4008 const STRLEN len = SvCUR(sv);
4011 SvPV_set(sv, Nullch);
4013 SvGROW(sv, len + 1);
4014 Move(pvx,SvPVX(sv),len,char);
4016 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4018 else if (IN_PERL_RUNTIME)
4019 Perl_croak(aTHX_ PL_no_modify);
4023 sv_unref_flags(sv, flags);
4024 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4031 Efficient removal of characters from the beginning of the string buffer.
4032 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4033 the string buffer. The C<ptr> becomes the first character of the adjusted
4034 string. Uses the "OOK hack".
4035 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4036 refer to the same chunk of data.
4042 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4044 register STRLEN delta;
4045 if (!ptr || !SvPOKp(sv))
4047 delta = ptr - SvPVX_const(sv);
4048 SV_CHECK_THINKFIRST(sv);
4049 if (SvTYPE(sv) < SVt_PVIV)
4050 sv_upgrade(sv,SVt_PVIV);
4053 if (!SvLEN(sv)) { /* make copy of shared string */
4054 const char *pvx = SvPVX_const(sv);
4055 const STRLEN len = SvCUR(sv);
4056 SvGROW(sv, len + 1);
4057 Move(pvx,SvPVX(sv),len,char);
4061 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4062 and we do that anyway inside the SvNIOK_off
4064 SvFLAGS(sv) |= SVf_OOK;
4067 SvLEN_set(sv, SvLEN(sv) - delta);
4068 SvCUR_set(sv, SvCUR(sv) - delta);
4069 SvPV_set(sv, SvPVX(sv) + delta);
4070 SvIV_set(sv, SvIVX(sv) + delta);
4074 =for apidoc sv_catpvn
4076 Concatenates the string onto the end of the string which is in the SV. The
4077 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4078 status set, then the bytes appended should be valid UTF-8.
4079 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4081 =for apidoc sv_catpvn_flags
4083 Concatenates the string onto the end of the string which is in the SV. The
4084 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4085 status set, then the bytes appended should be valid UTF-8.
4086 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4087 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4088 in terms of this function.
4094 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4097 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4099 SvGROW(dsv, dlen + slen + 1);
4101 sstr = SvPVX_const(dsv);
4102 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4103 SvCUR_set(dsv, SvCUR(dsv) + slen);
4105 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4107 if (flags & SV_SMAGIC)
4112 =for apidoc sv_catsv
4114 Concatenates the string from SV C<ssv> onto the end of the string in
4115 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4116 not 'set' magic. See C<sv_catsv_mg>.
4118 =for apidoc sv_catsv_flags
4120 Concatenates the string from SV C<ssv> onto the end of the string in
4121 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4122 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4123 and C<sv_catsv_nomg> are implemented in terms of this function.
4128 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4133 if ((spv = SvPV_const(ssv, slen))) {
4134 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4135 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4136 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4137 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4138 dsv->sv_flags doesn't have that bit set.
4139 Andy Dougherty 12 Oct 2001
4141 const I32 sutf8 = DO_UTF8(ssv);
4144 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4146 dutf8 = DO_UTF8(dsv);
4148 if (dutf8 != sutf8) {
4150 /* Not modifying source SV, so taking a temporary copy. */
4151 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4153 sv_utf8_upgrade(csv);
4154 spv = SvPV_const(csv, slen);
4157 sv_utf8_upgrade_nomg(dsv);
4159 sv_catpvn_nomg(dsv, spv, slen);
4162 if (flags & SV_SMAGIC)
4167 =for apidoc sv_catpv
4169 Concatenates the string onto the end of the string which is in the SV.
4170 If the SV has the UTF-8 status set, then the bytes appended should be
4171 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4176 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4178 register STRLEN len;
4184 junk = SvPV_force(sv, tlen);
4186 SvGROW(sv, tlen + len + 1);
4188 ptr = SvPVX_const(sv);
4189 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4190 SvCUR_set(sv, SvCUR(sv) + len);
4191 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4196 =for apidoc sv_catpv_mg
4198 Like C<sv_catpv>, but also handles 'set' magic.
4204 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4213 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4214 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4221 Perl_newSV(pTHX_ STRLEN len)
4227 sv_upgrade(sv, SVt_PV);
4228 SvGROW(sv, len + 1);
4233 =for apidoc sv_magicext
4235 Adds magic to an SV, upgrading it if necessary. Applies the
4236 supplied vtable and returns a pointer to the magic added.
4238 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4239 In particular, you can add magic to SvREADONLY SVs, and add more than
4240 one instance of the same 'how'.
4242 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4243 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4244 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4245 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4247 (This is now used as a subroutine by C<sv_magic>.)
4252 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4253 const char* name, I32 namlen)
4257 if (SvTYPE(sv) < SVt_PVMG) {
4258 SvUPGRADE(sv, SVt_PVMG);
4260 Newxz(mg, 1, MAGIC);
4261 mg->mg_moremagic = SvMAGIC(sv);
4262 SvMAGIC_set(sv, mg);
4264 /* Sometimes a magic contains a reference loop, where the sv and
4265 object refer to each other. To prevent a reference loop that
4266 would prevent such objects being freed, we look for such loops
4267 and if we find one we avoid incrementing the object refcount.
4269 Note we cannot do this to avoid self-tie loops as intervening RV must
4270 have its REFCNT incremented to keep it in existence.
4273 if (!obj || obj == sv ||
4274 how == PERL_MAGIC_arylen ||
4275 how == PERL_MAGIC_qr ||
4276 how == PERL_MAGIC_symtab ||
4277 (SvTYPE(obj) == SVt_PVGV &&
4278 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4279 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4280 GvFORM(obj) == (CV*)sv)))
4285 mg->mg_obj = SvREFCNT_inc(obj);
4286 mg->mg_flags |= MGf_REFCOUNTED;
4289 /* Normal self-ties simply pass a null object, and instead of
4290 using mg_obj directly, use the SvTIED_obj macro to produce a
4291 new RV as needed. For glob "self-ties", we are tieing the PVIO
4292 with an RV obj pointing to the glob containing the PVIO. In
4293 this case, to avoid a reference loop, we need to weaken the
4297 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4298 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4304 mg->mg_len = namlen;
4307 mg->mg_ptr = savepvn(name, namlen);
4308 else if (namlen == HEf_SVKEY)
4309 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4311 mg->mg_ptr = (char *) name;
4313 mg->mg_virtual = vtable;
4317 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4322 =for apidoc sv_magic
4324 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4325 then adds a new magic item of type C<how> to the head of the magic list.
4327 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4328 handling of the C<name> and C<namlen> arguments.
4330 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4331 to add more than one instance of the same 'how'.
4337 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4339 const MGVTBL *vtable;
4342 #ifdef PERL_OLD_COPY_ON_WRITE
4344 sv_force_normal_flags(sv, 0);
4346 if (SvREADONLY(sv)) {
4348 /* its okay to attach magic to shared strings; the subsequent
4349 * upgrade to PVMG will unshare the string */
4350 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4353 && how != PERL_MAGIC_regex_global
4354 && how != PERL_MAGIC_bm
4355 && how != PERL_MAGIC_fm
4356 && how != PERL_MAGIC_sv
4357 && how != PERL_MAGIC_backref
4360 Perl_croak(aTHX_ PL_no_modify);
4363 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4364 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4365 /* sv_magic() refuses to add a magic of the same 'how' as an
4368 if (how == PERL_MAGIC_taint)
4376 vtable = &PL_vtbl_sv;
4378 case PERL_MAGIC_overload:
4379 vtable = &PL_vtbl_amagic;
4381 case PERL_MAGIC_overload_elem:
4382 vtable = &PL_vtbl_amagicelem;
4384 case PERL_MAGIC_overload_table:
4385 vtable = &PL_vtbl_ovrld;
4388 vtable = &PL_vtbl_bm;
4390 case PERL_MAGIC_regdata:
4391 vtable = &PL_vtbl_regdata;
4393 case PERL_MAGIC_regdatum:
4394 vtable = &PL_vtbl_regdatum;
4396 case PERL_MAGIC_env:
4397 vtable = &PL_vtbl_env;
4400 vtable = &PL_vtbl_fm;
4402 case PERL_MAGIC_envelem:
4403 vtable = &PL_vtbl_envelem;
4405 case PERL_MAGIC_regex_global:
4406 vtable = &PL_vtbl_mglob;
4408 case PERL_MAGIC_isa:
4409 vtable = &PL_vtbl_isa;
4411 case PERL_MAGIC_isaelem:
4412 vtable = &PL_vtbl_isaelem;
4414 case PERL_MAGIC_nkeys:
4415 vtable = &PL_vtbl_nkeys;
4417 case PERL_MAGIC_dbfile:
4420 case PERL_MAGIC_dbline:
4421 vtable = &PL_vtbl_dbline;
4423 #ifdef USE_LOCALE_COLLATE
4424 case PERL_MAGIC_collxfrm:
4425 vtable = &PL_vtbl_collxfrm;
4427 #endif /* USE_LOCALE_COLLATE */
4428 case PERL_MAGIC_tied:
4429 vtable = &PL_vtbl_pack;
4431 case PERL_MAGIC_tiedelem:
4432 case PERL_MAGIC_tiedscalar:
4433 vtable = &PL_vtbl_packelem;
4436 vtable = &PL_vtbl_regexp;
4438 case PERL_MAGIC_sig:
4439 vtable = &PL_vtbl_sig;
4441 case PERL_MAGIC_sigelem:
4442 vtable = &PL_vtbl_sigelem;
4444 case PERL_MAGIC_taint:
4445 vtable = &PL_vtbl_taint;
4447 case PERL_MAGIC_uvar:
4448 vtable = &PL_vtbl_uvar;
4450 case PERL_MAGIC_vec:
4451 vtable = &PL_vtbl_vec;
4453 case PERL_MAGIC_arylen_p:
4454 case PERL_MAGIC_rhash:
4455 case PERL_MAGIC_symtab:
4456 case PERL_MAGIC_vstring:
4459 case PERL_MAGIC_utf8:
4460 vtable = &PL_vtbl_utf8;
4462 case PERL_MAGIC_substr:
4463 vtable = &PL_vtbl_substr;
4465 case PERL_MAGIC_defelem:
4466 vtable = &PL_vtbl_defelem;
4468 case PERL_MAGIC_glob:
4469 vtable = &PL_vtbl_glob;
4471 case PERL_MAGIC_arylen:
4472 vtable = &PL_vtbl_arylen;
4474 case PERL_MAGIC_pos:
4475 vtable = &PL_vtbl_pos;
4477 case PERL_MAGIC_backref:
4478 vtable = &PL_vtbl_backref;
4480 case PERL_MAGIC_ext:
4481 /* Reserved for use by extensions not perl internals. */
4482 /* Useful for attaching extension internal data to perl vars. */
4483 /* Note that multiple extensions may clash if magical scalars */
4484 /* etc holding private data from one are passed to another. */
4488 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4491 /* Rest of work is done else where */
4492 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4495 case PERL_MAGIC_taint:
4498 case PERL_MAGIC_ext:
4499 case PERL_MAGIC_dbfile:
4506 =for apidoc sv_unmagic
4508 Removes all magic of type C<type> from an SV.
4514 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4518 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4521 for (mg = *mgp; mg; mg = *mgp) {
4522 if (mg->mg_type == type) {
4523 const MGVTBL* const vtbl = mg->mg_virtual;
4524 *mgp = mg->mg_moremagic;
4525 if (vtbl && vtbl->svt_free)
4526 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4527 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4529 Safefree(mg->mg_ptr);
4530 else if (mg->mg_len == HEf_SVKEY)
4531 SvREFCNT_dec((SV*)mg->mg_ptr);
4532 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4533 Safefree(mg->mg_ptr);
4535 if (mg->mg_flags & MGf_REFCOUNTED)
4536 SvREFCNT_dec(mg->mg_obj);
4540 mgp = &mg->mg_moremagic;
4544 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4551 =for apidoc sv_rvweaken
4553 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4554 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4555 push a back-reference to this RV onto the array of backreferences
4556 associated with that magic.
4562 Perl_sv_rvweaken(pTHX_ SV *sv)
4565 if (!SvOK(sv)) /* let undefs pass */
4568 Perl_croak(aTHX_ "Can't weaken a nonreference");
4569 else if (SvWEAKREF(sv)) {
4570 if (ckWARN(WARN_MISC))
4571 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4575 Perl_sv_add_backref(aTHX_ tsv, sv);
4581 /* Give tsv backref magic if it hasn't already got it, then push a
4582 * back-reference to sv onto the array associated with the backref magic.
4586 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4590 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4591 av = (AV*)mg->mg_obj;
4594 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4595 /* av now has a refcnt of 2, which avoids it getting freed
4596 * before us during global cleanup. The extra ref is removed
4597 * by magic_killbackrefs() when tsv is being freed */
4599 if (AvFILLp(av) >= AvMAX(av)) {
4600 av_extend(av, AvFILLp(av)+1);
4602 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4605 /* delete a back-reference to ourselves from the backref magic associated
4606 * with the SV we point to.
4610 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4616 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4617 if (PL_in_clean_all)
4620 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4621 Perl_croak(aTHX_ "panic: del_backref");
4622 av = (AV *)mg->mg_obj;
4624 /* We shouldn't be in here more than once, but for paranoia reasons lets
4626 for (i = AvFILLp(av); i >= 0; i--) {
4628 const SSize_t fill = AvFILLp(av);
4630 /* We weren't the last entry.
4631 An unordered list has this property that you can take the
4632 last element off the end to fill the hole, and it's still
4633 an unordered list :-)
4638 AvFILLp(av) = fill - 1;
4644 =for apidoc sv_insert
4646 Inserts a string at the specified offset/length within the SV. Similar to
4647 the Perl substr() function.
4653 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4657 register char *midend;
4658 register char *bigend;
4664 Perl_croak(aTHX_ "Can't modify non-existent substring");
4665 SvPV_force(bigstr, curlen);
4666 (void)SvPOK_only_UTF8(bigstr);
4667 if (offset + len > curlen) {
4668 SvGROW(bigstr, offset+len+1);
4669 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4670 SvCUR_set(bigstr, offset+len);
4674 i = littlelen - len;
4675 if (i > 0) { /* string might grow */
4676 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4677 mid = big + offset + len;
4678 midend = bigend = big + SvCUR(bigstr);
4681 while (midend > mid) /* shove everything down */
4682 *--bigend = *--midend;
4683 Move(little,big+offset,littlelen,char);
4684 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4689 Move(little,SvPVX(bigstr)+offset,len,char);
4694 big = SvPVX(bigstr);
4697 bigend = big + SvCUR(bigstr);
4699 if (midend > bigend)
4700 Perl_croak(aTHX_ "panic: sv_insert");
4702 if (mid - big > bigend - midend) { /* faster to shorten from end */
4704 Move(little, mid, littlelen,char);
4707 i = bigend - midend;
4709 Move(midend, mid, i,char);
4713 SvCUR_set(bigstr, mid - big);
4715 else if ((i = mid - big)) { /* faster from front */
4716 midend -= littlelen;
4718 sv_chop(bigstr,midend-i);
4723 Move(little, mid, littlelen,char);
4725 else if (littlelen) {
4726 midend -= littlelen;
4727 sv_chop(bigstr,midend);
4728 Move(little,midend,littlelen,char);
4731 sv_chop(bigstr,midend);
4737 =for apidoc sv_replace
4739 Make the first argument a copy of the second, then delete the original.
4740 The target SV physically takes over ownership of the body of the source SV
4741 and inherits its flags; however, the target keeps any magic it owns,
4742 and any magic in the source is discarded.
4743 Note that this is a rather specialist SV copying operation; most of the
4744 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4750 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4752 const U32 refcnt = SvREFCNT(sv);
4753 SV_CHECK_THINKFIRST_COW_DROP(sv);
4754 if (SvREFCNT(nsv) != 1) {
4755 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4756 UVuf " != 1)", (UV) SvREFCNT(nsv));
4758 if (SvMAGICAL(sv)) {
4762 sv_upgrade(nsv, SVt_PVMG);
4763 SvMAGIC_set(nsv, SvMAGIC(sv));
4764 SvFLAGS(nsv) |= SvMAGICAL(sv);
4766 SvMAGIC_set(sv, NULL);
4770 assert(!SvREFCNT(sv));
4771 #ifdef DEBUG_LEAKING_SCALARS
4772 sv->sv_flags = nsv->sv_flags;
4773 sv->sv_any = nsv->sv_any;
4774 sv->sv_refcnt = nsv->sv_refcnt;
4775 sv->sv_u = nsv->sv_u;
4777 StructCopy(nsv,sv,SV);
4779 /* Currently could join these into one piece of pointer arithmetic, but
4780 it would be unclear. */
4781 if(SvTYPE(sv) == SVt_IV)
4783 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4784 else if (SvTYPE(sv) == SVt_RV) {
4785 SvANY(sv) = &sv->sv_u.svu_rv;
4789 #ifdef PERL_OLD_COPY_ON_WRITE
4790 if (SvIsCOW_normal(nsv)) {
4791 /* We need to follow the pointers around the loop to make the
4792 previous SV point to sv, rather than nsv. */
4795 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4798 assert(SvPVX_const(current) == SvPVX_const(nsv));
4800 /* Make the SV before us point to the SV after us. */
4802 PerlIO_printf(Perl_debug_log, "previous is\n");
4804 PerlIO_printf(Perl_debug_log,
4805 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4806 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4808 SV_COW_NEXT_SV_SET(current, sv);
4811 SvREFCNT(sv) = refcnt;
4812 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4818 =for apidoc sv_clear
4820 Clear an SV: call any destructors, free up any memory used by the body,
4821 and free the body itself. The SV's head is I<not> freed, although
4822 its type is set to all 1's so that it won't inadvertently be assumed
4823 to be live during global destruction etc.
4824 This function should only be called when REFCNT is zero. Most of the time
4825 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4832 Perl_sv_clear(pTHX_ register SV *sv)
4835 const U32 type = SvTYPE(sv);
4836 const struct body_details *const sv_type_details
4837 = bodies_by_type + type;
4840 assert(SvREFCNT(sv) == 0);
4846 if (PL_defstash) { /* Still have a symbol table? */
4851 stash = SvSTASH(sv);
4852 destructor = StashHANDLER(stash,DESTROY);
4854 SV* const tmpref = newRV(sv);
4855 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4857 PUSHSTACKi(PERLSI_DESTROY);
4862 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4868 if(SvREFCNT(tmpref) < 2) {
4869 /* tmpref is not kept alive! */
4871 SvRV_set(tmpref, NULL);
4874 SvREFCNT_dec(tmpref);
4876 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4880 if (PL_in_clean_objs)
4881 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4883 /* DESTROY gave object new lease on life */
4889 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4890 SvOBJECT_off(sv); /* Curse the object. */
4891 if (type != SVt_PVIO)
4892 --PL_sv_objcount; /* XXX Might want something more general */
4895 if (type >= SVt_PVMG) {
4898 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4899 SvREFCNT_dec(SvSTASH(sv));
4904 IoIFP(sv) != PerlIO_stdin() &&
4905 IoIFP(sv) != PerlIO_stdout() &&
4906 IoIFP(sv) != PerlIO_stderr())
4908 io_close((IO*)sv, FALSE);
4910 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4911 PerlDir_close(IoDIRP(sv));
4912 IoDIRP(sv) = (DIR*)NULL;
4913 Safefree(IoTOP_NAME(sv));
4914 Safefree(IoFMT_NAME(sv));
4915 Safefree(IoBOTTOM_NAME(sv));
4930 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4931 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4932 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4933 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4935 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4936 SvREFCNT_dec(LvTARG(sv));
4940 Safefree(GvNAME(sv));
4941 /* If we're in a stash, we don't own a reference to it. However it does
4942 have a back reference to us, which needs to be cleared. */
4944 sv_del_backref((SV*)GvSTASH(sv), sv);
4949 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4951 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4952 /* Don't even bother with turning off the OOK flag. */
4957 SV *target = SvRV(sv);
4959 sv_del_backref(target, sv);
4961 SvREFCNT_dec(target);
4963 #ifdef PERL_OLD_COPY_ON_WRITE
4964 else if (SvPVX_const(sv)) {
4966 /* I believe I need to grab the global SV mutex here and
4967 then recheck the COW status. */
4969 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4972 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4973 SV_COW_NEXT_SV(sv));
4974 /* And drop it here. */
4976 } else if (SvLEN(sv)) {
4977 Safefree(SvPVX_const(sv));
4981 else if (SvPVX_const(sv) && SvLEN(sv))
4982 Safefree(SvPVX_mutable(sv));
4983 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4984 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4993 SvFLAGS(sv) &= SVf_BREAK;
4994 SvFLAGS(sv) |= SVTYPEMASK;
4996 if (sv_type_details->arena) {
4997 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4998 &PL_body_roots[type]);
5000 else if (sv_type_details->size) {
5001 my_safefree(SvANY(sv));
5006 =for apidoc sv_newref
5008 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5015 Perl_sv_newref(pTHX_ SV *sv)
5025 Decrement an SV's reference count, and if it drops to zero, call
5026 C<sv_clear> to invoke destructors and free up any memory used by
5027 the body; finally, deallocate the SV's head itself.
5028 Normally called via a wrapper macro C<SvREFCNT_dec>.
5034 Perl_sv_free(pTHX_ SV *sv)
5039 if (SvREFCNT(sv) == 0) {
5040 if (SvFLAGS(sv) & SVf_BREAK)
5041 /* this SV's refcnt has been artificially decremented to
5042 * trigger cleanup */
5044 if (PL_in_clean_all) /* All is fair */
5046 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5047 /* make sure SvREFCNT(sv)==0 happens very seldom */
5048 SvREFCNT(sv) = (~(U32)0)/2;
5051 if (ckWARN_d(WARN_INTERNAL)) {
5052 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5053 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5054 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5055 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5056 Perl_dump_sv_child(aTHX_ sv);
5061 if (--(SvREFCNT(sv)) > 0)
5063 Perl_sv_free2(aTHX_ sv);
5067 Perl_sv_free2(pTHX_ SV *sv)
5072 if (ckWARN_d(WARN_DEBUGGING))
5073 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5074 "Attempt to free temp prematurely: SV 0x%"UVxf
5075 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5079 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5080 /* make sure SvREFCNT(sv)==0 happens very seldom */
5081 SvREFCNT(sv) = (~(U32)0)/2;
5092 Returns the length of the string in the SV. Handles magic and type
5093 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5099 Perl_sv_len(pTHX_ register SV *sv)
5107 len = mg_length(sv);
5109 (void)SvPV_const(sv, len);
5114 =for apidoc sv_len_utf8
5116 Returns the number of characters in the string in an SV, counting wide
5117 UTF-8 bytes as a single character. Handles magic and type coercion.
5123 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5124 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5125 * (Note that the mg_len is not the length of the mg_ptr field.)
5130 Perl_sv_len_utf8(pTHX_ register SV *sv)
5136 return mg_length(sv);
5140 const U8 *s = (U8*)SvPV_const(sv, len);
5141 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5143 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5145 #ifdef PERL_UTF8_CACHE_ASSERT
5146 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5150 ulen = Perl_utf8_length(aTHX_ s, s + len);
5151 if (!mg && !SvREADONLY(sv)) {
5152 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5153 mg = mg_find(sv, PERL_MAGIC_utf8);
5163 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5164 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5165 * between UTF-8 and byte offsets. There are two (substr offset and substr
5166 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5167 * and byte offset) cache positions.
5169 * The mg_len field is used by sv_len_utf8(), see its comments.
5170 * Note that the mg_len is not the length of the mg_ptr field.
5174 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5175 I32 offsetp, const U8 *s, const U8 *start)
5179 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5181 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5185 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5187 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5188 (*mgp)->mg_ptr = (char *) *cachep;
5192 (*cachep)[i] = offsetp;
5193 (*cachep)[i+1] = s - start;
5201 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5202 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5203 * between UTF-8 and byte offsets. See also the comments of
5204 * S_utf8_mg_pos_init().
5208 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)
5212 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5214 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5215 if (*mgp && (*mgp)->mg_ptr) {
5216 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5217 ASSERT_UTF8_CACHE(*cachep);
5218 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5220 else { /* We will skip to the right spot. */
5225 /* The assumption is that going backward is half
5226 * the speed of going forward (that's where the
5227 * 2 * backw in the below comes from). (The real
5228 * figure of course depends on the UTF-8 data.) */
5230 if ((*cachep)[i] > (STRLEN)uoff) {
5232 backw = (*cachep)[i] - (STRLEN)uoff;
5234 if (forw < 2 * backw)
5237 p = start + (*cachep)[i+1];
5239 /* Try this only for the substr offset (i == 0),
5240 * not for the substr length (i == 2). */
5241 else if (i == 0) { /* (*cachep)[i] < uoff */
5242 const STRLEN ulen = sv_len_utf8(sv);
5244 if ((STRLEN)uoff < ulen) {
5245 forw = (STRLEN)uoff - (*cachep)[i];
5246 backw = ulen - (STRLEN)uoff;
5248 if (forw < 2 * backw)
5249 p = start + (*cachep)[i+1];
5254 /* If the string is not long enough for uoff,
5255 * we could extend it, but not at this low a level. */
5259 if (forw < 2 * backw) {
5266 while (UTF8_IS_CONTINUATION(*p))
5271 /* Update the cache. */
5272 (*cachep)[i] = (STRLEN)uoff;
5273 (*cachep)[i+1] = p - start;
5275 /* Drop the stale "length" cache */
5284 if (found) { /* Setup the return values. */
5285 *offsetp = (*cachep)[i+1];
5286 *sp = start + *offsetp;
5289 *offsetp = send - start;
5291 else if (*sp < start) {
5297 #ifdef PERL_UTF8_CACHE_ASSERT
5302 while (n-- && s < send)
5306 assert(*offsetp == s - start);
5307 assert((*cachep)[0] == (STRLEN)uoff);
5308 assert((*cachep)[1] == *offsetp);
5310 ASSERT_UTF8_CACHE(*cachep);
5319 =for apidoc sv_pos_u2b
5321 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5322 the start of the string, to a count of the equivalent number of bytes; if
5323 lenp is non-zero, it does the same to lenp, but this time starting from
5324 the offset, rather than from the start of the string. Handles magic and
5331 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5332 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5333 * byte offsets. See also the comments of S_utf8_mg_pos().
5338 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5346 start = (U8*)SvPV_const(sv, len);
5350 const U8 *s = start;
5351 I32 uoffset = *offsetp;
5352 const U8 * const send = s + len;
5356 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5358 if (!found && uoffset > 0) {
5359 while (s < send && uoffset--)
5363 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5365 *offsetp = s - start;
5370 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5374 if (!found && *lenp > 0) {
5377 while (s < send && ulen--)
5381 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5385 ASSERT_UTF8_CACHE(cache);
5397 =for apidoc sv_pos_b2u
5399 Converts the value pointed to by offsetp from a count of bytes from the
5400 start of the string, to a count of the equivalent number of UTF-8 chars.
5401 Handles magic and type coercion.
5407 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5408 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5409 * byte offsets. See also the comments of S_utf8_mg_pos().
5414 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5422 s = (const U8*)SvPV_const(sv, len);
5423 if ((I32)len < *offsetp)
5424 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5426 const U8* send = s + *offsetp;
5428 STRLEN *cache = NULL;
5432 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5433 mg = mg_find(sv, PERL_MAGIC_utf8);
5434 if (mg && mg->mg_ptr) {
5435 cache = (STRLEN *) mg->mg_ptr;
5436 if (cache[1] == (STRLEN)*offsetp) {
5437 /* An exact match. */
5438 *offsetp = cache[0];
5442 else if (cache[1] < (STRLEN)*offsetp) {
5443 /* We already know part of the way. */
5446 /* Let the below loop do the rest. */
5448 else { /* cache[1] > *offsetp */
5449 /* We already know all of the way, now we may
5450 * be able to walk back. The same assumption
5451 * is made as in S_utf8_mg_pos(), namely that
5452 * walking backward is twice slower than
5453 * walking forward. */
5454 const STRLEN forw = *offsetp;
5455 STRLEN backw = cache[1] - *offsetp;
5457 if (!(forw < 2 * backw)) {
5458 const U8 *p = s + cache[1];
5465 while (UTF8_IS_CONTINUATION(*p)) {
5473 *offsetp = cache[0];
5475 /* Drop the stale "length" cache */
5483 ASSERT_UTF8_CACHE(cache);
5489 /* Call utf8n_to_uvchr() to validate the sequence
5490 * (unless a simple non-UTF character) */
5491 if (!UTF8_IS_INVARIANT(*s))
5492 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5501 if (!SvREADONLY(sv)) {
5503 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5504 mg = mg_find(sv, PERL_MAGIC_utf8);
5509 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5510 mg->mg_ptr = (char *) cache;
5515 cache[1] = *offsetp;
5516 /* Drop the stale "length" cache */
5529 Returns a boolean indicating whether the strings in the two SVs are
5530 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5531 coerce its args to strings if necessary.
5537 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5545 SV* svrecode = Nullsv;
5552 pv1 = SvPV_const(sv1, cur1);
5559 pv2 = SvPV_const(sv2, cur2);
5561 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5562 /* Differing utf8ness.
5563 * Do not UTF8size the comparands as a side-effect. */
5566 svrecode = newSVpvn(pv2, cur2);
5567 sv_recode_to_utf8(svrecode, PL_encoding);
5568 pv2 = SvPV_const(svrecode, cur2);
5571 svrecode = newSVpvn(pv1, cur1);
5572 sv_recode_to_utf8(svrecode, PL_encoding);
5573 pv1 = SvPV_const(svrecode, cur1);
5575 /* Now both are in UTF-8. */
5577 SvREFCNT_dec(svrecode);
5582 bool is_utf8 = TRUE;
5585 /* sv1 is the UTF-8 one,
5586 * if is equal it must be downgrade-able */
5587 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5593 /* sv2 is the UTF-8 one,
5594 * if is equal it must be downgrade-able */
5595 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5601 /* Downgrade not possible - cannot be eq */
5609 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5612 SvREFCNT_dec(svrecode);
5623 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5624 string in C<sv1> is less than, equal to, or greater than the string in
5625 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5626 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5632 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5635 const char *pv1, *pv2;
5638 SV *svrecode = Nullsv;
5645 pv1 = SvPV_const(sv1, cur1);
5652 pv2 = SvPV_const(sv2, cur2);
5654 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5655 /* Differing utf8ness.
5656 * Do not UTF8size the comparands as a side-effect. */
5659 svrecode = newSVpvn(pv2, cur2);
5660 sv_recode_to_utf8(svrecode, PL_encoding);
5661 pv2 = SvPV_const(svrecode, cur2);
5664 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5669 svrecode = newSVpvn(pv1, cur1);
5670 sv_recode_to_utf8(svrecode, PL_encoding);
5671 pv1 = SvPV_const(svrecode, cur1);
5674 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5680 cmp = cur2 ? -1 : 0;
5684 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5687 cmp = retval < 0 ? -1 : 1;
5688 } else if (cur1 == cur2) {
5691 cmp = cur1 < cur2 ? -1 : 1;
5696 SvREFCNT_dec(svrecode);
5705 =for apidoc sv_cmp_locale
5707 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5708 'use bytes' aware, handles get magic, and will coerce its args to strings
5709 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5715 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5717 #ifdef USE_LOCALE_COLLATE
5723 if (PL_collation_standard)
5727 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5729 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5731 if (!pv1 || !len1) {
5742 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5745 return retval < 0 ? -1 : 1;
5748 * When the result of collation is equality, that doesn't mean
5749 * that there are no differences -- some locales exclude some
5750 * characters from consideration. So to avoid false equalities,
5751 * we use the raw string as a tiebreaker.
5757 #endif /* USE_LOCALE_COLLATE */
5759 return sv_cmp(sv1, sv2);
5763 #ifdef USE_LOCALE_COLLATE
5766 =for apidoc sv_collxfrm
5768 Add Collate Transform magic to an SV if it doesn't already have it.
5770 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5771 scalar data of the variable, but transformed to such a format that a normal
5772 memory comparison can be used to compare the data according to the locale
5779 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5783 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5784 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5790 Safefree(mg->mg_ptr);
5791 s = SvPV_const(sv, len);
5792 if ((xf = mem_collxfrm(s, len, &xlen))) {
5793 if (SvREADONLY(sv)) {
5796 return xf + sizeof(PL_collation_ix);
5799 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5800 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5813 if (mg && mg->mg_ptr) {
5815 return mg->mg_ptr + sizeof(PL_collation_ix);
5823 #endif /* USE_LOCALE_COLLATE */
5828 Get a line from the filehandle and store it into the SV, optionally
5829 appending to the currently-stored string.
5835 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5839 register STDCHAR rslast;
5840 register STDCHAR *bp;
5846 if (SvTHINKFIRST(sv))
5847 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5848 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5850 However, perlbench says it's slower, because the existing swipe code
5851 is faster than copy on write.
5852 Swings and roundabouts. */
5853 SvUPGRADE(sv, SVt_PV);
5858 if (PerlIO_isutf8(fp)) {
5860 sv_utf8_upgrade_nomg(sv);
5861 sv_pos_u2b(sv,&append,0);
5863 } else if (SvUTF8(sv)) {
5864 SV * const tsv = NEWSV(0,0);
5865 sv_gets(tsv, fp, 0);
5866 sv_utf8_upgrade_nomg(tsv);
5867 SvCUR_set(sv,append);
5870 goto return_string_or_null;
5875 if (PerlIO_isutf8(fp))
5878 if (IN_PERL_COMPILETIME) {
5879 /* we always read code in line mode */
5883 else if (RsSNARF(PL_rs)) {
5884 /* If it is a regular disk file use size from stat() as estimate
5885 of amount we are going to read - may result in malloc-ing
5886 more memory than we realy need if layers bellow reduce
5887 size we read (e.g. CRLF or a gzip layer)
5890 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5891 const Off_t offset = PerlIO_tell(fp);
5892 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5893 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5899 else if (RsRECORD(PL_rs)) {
5903 /* Grab the size of the record we're getting */
5904 recsize = SvIV(SvRV(PL_rs));
5905 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5908 /* VMS wants read instead of fread, because fread doesn't respect */
5909 /* RMS record boundaries. This is not necessarily a good thing to be */
5910 /* doing, but we've got no other real choice - except avoid stdio
5911 as implementation - perhaps write a :vms layer ?
5913 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5915 bytesread = PerlIO_read(fp, buffer, recsize);
5919 SvCUR_set(sv, bytesread += append);
5920 buffer[bytesread] = '\0';
5921 goto return_string_or_null;
5923 else if (RsPARA(PL_rs)) {
5929 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5930 if (PerlIO_isutf8(fp)) {
5931 rsptr = SvPVutf8(PL_rs, rslen);
5934 if (SvUTF8(PL_rs)) {
5935 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5936 Perl_croak(aTHX_ "Wide character in $/");
5939 rsptr = SvPV_const(PL_rs, rslen);
5943 rslast = rslen ? rsptr[rslen - 1] : '\0';
5945 if (rspara) { /* have to do this both before and after */
5946 do { /* to make sure file boundaries work right */
5949 i = PerlIO_getc(fp);
5953 PerlIO_ungetc(fp,i);
5959 /* See if we know enough about I/O mechanism to cheat it ! */
5961 /* This used to be #ifdef test - it is made run-time test for ease
5962 of abstracting out stdio interface. One call should be cheap
5963 enough here - and may even be a macro allowing compile
5967 if (PerlIO_fast_gets(fp)) {
5970 * We're going to steal some values from the stdio struct
5971 * and put EVERYTHING in the innermost loop into registers.
5973 register STDCHAR *ptr;
5977 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5978 /* An ungetc()d char is handled separately from the regular
5979 * buffer, so we getc() it back out and stuff it in the buffer.
5981 i = PerlIO_getc(fp);
5982 if (i == EOF) return 0;
5983 *(--((*fp)->_ptr)) = (unsigned char) i;
5987 /* Here is some breathtakingly efficient cheating */
5989 cnt = PerlIO_get_cnt(fp); /* get count into register */
5990 /* make sure we have the room */
5991 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5992 /* Not room for all of it
5993 if we are looking for a separator and room for some
5995 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5996 /* just process what we have room for */
5997 shortbuffered = cnt - SvLEN(sv) + append + 1;
5998 cnt -= shortbuffered;
6002 /* remember that cnt can be negative */
6003 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6008 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6009 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6010 DEBUG_P(PerlIO_printf(Perl_debug_log,
6011 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6012 DEBUG_P(PerlIO_printf(Perl_debug_log,
6013 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6014 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6015 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6020 while (cnt > 0) { /* this | eat */
6022 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6023 goto thats_all_folks; /* screams | sed :-) */
6027 Copy(ptr, bp, cnt, char); /* this | eat */
6028 bp += cnt; /* screams | dust */
6029 ptr += cnt; /* louder | sed :-) */
6034 if (shortbuffered) { /* oh well, must extend */
6035 cnt = shortbuffered;
6037 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6039 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6040 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6044 DEBUG_P(PerlIO_printf(Perl_debug_log,
6045 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6046 PTR2UV(ptr),(long)cnt));
6047 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6049 DEBUG_P(PerlIO_printf(Perl_debug_log,
6050 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6051 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6052 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6054 /* This used to call 'filbuf' in stdio form, but as that behaves like
6055 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6056 another abstraction. */
6057 i = PerlIO_getc(fp); /* get more characters */
6059 DEBUG_P(PerlIO_printf(Perl_debug_log,
6060 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6061 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6062 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6064 cnt = PerlIO_get_cnt(fp);
6065 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6066 DEBUG_P(PerlIO_printf(Perl_debug_log,
6067 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6069 if (i == EOF) /* all done for ever? */
6070 goto thats_really_all_folks;
6072 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6074 SvGROW(sv, bpx + cnt + 2);
6075 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6077 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6079 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6080 goto thats_all_folks;
6084 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6085 memNE((char*)bp - rslen, rsptr, rslen))
6086 goto screamer; /* go back to the fray */
6087 thats_really_all_folks:
6089 cnt += shortbuffered;
6090 DEBUG_P(PerlIO_printf(Perl_debug_log,
6091 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6092 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6093 DEBUG_P(PerlIO_printf(Perl_debug_log,
6094 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6095 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6096 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6098 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6099 DEBUG_P(PerlIO_printf(Perl_debug_log,
6100 "Screamer: done, len=%ld, string=|%.*s|\n",
6101 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6105 /*The big, slow, and stupid way. */
6106 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6108 Newx(buf, 8192, STDCHAR);
6116 register const STDCHAR *bpe = buf + sizeof(buf);
6118 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6119 ; /* keep reading */
6123 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6124 /* Accomodate broken VAXC compiler, which applies U8 cast to
6125 * both args of ?: operator, causing EOF to change into 255
6128 i = (U8)buf[cnt - 1];
6134 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6136 sv_catpvn(sv, (char *) buf, cnt);
6138 sv_setpvn(sv, (char *) buf, cnt);
6140 if (i != EOF && /* joy */
6142 SvCUR(sv) < rslen ||
6143 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6147 * If we're reading from a TTY and we get a short read,
6148 * indicating that the user hit his EOF character, we need
6149 * to notice it now, because if we try to read from the TTY
6150 * again, the EOF condition will disappear.
6152 * The comparison of cnt to sizeof(buf) is an optimization
6153 * that prevents unnecessary calls to feof().
6157 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6161 #ifdef USE_HEAP_INSTEAD_OF_STACK
6166 if (rspara) { /* have to do this both before and after */
6167 while (i != EOF) { /* to make sure file boundaries work right */
6168 i = PerlIO_getc(fp);
6170 PerlIO_ungetc(fp,i);
6176 return_string_or_null:
6177 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6183 Auto-increment of the value in the SV, doing string to numeric conversion
6184 if necessary. Handles 'get' magic.
6190 Perl_sv_inc(pTHX_ register SV *sv)
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)
6353 if (SvTHINKFIRST(sv)) {
6355 sv_force_normal_flags(sv, 0);
6356 if (SvREADONLY(sv)) {
6357 if (IN_PERL_RUNTIME)
6358 Perl_croak(aTHX_ PL_no_modify);
6362 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6364 i = PTR2IV(SvRV(sv));
6369 /* Unlike sv_inc we don't have to worry about string-never-numbers
6370 and keeping them magic. But we mustn't warn on punting */
6371 flags = SvFLAGS(sv);
6372 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6373 /* It's publicly an integer, or privately an integer-not-float */
6374 #ifdef PERL_PRESERVE_IVUV
6378 if (SvUVX(sv) == 0) {
6379 (void)SvIOK_only(sv);
6383 (void)SvIOK_only_UV(sv);
6384 SvUV_set(sv, SvUVX(sv) - 1);
6387 if (SvIVX(sv) == IV_MIN)
6388 sv_setnv(sv, (NV)IV_MIN - 1.0);
6390 (void)SvIOK_only(sv);
6391 SvIV_set(sv, SvIVX(sv) - 1);
6396 if (flags & SVp_NOK) {
6397 SvNV_set(sv, SvNVX(sv) - 1.0);
6398 (void)SvNOK_only(sv);
6401 if (!(flags & SVp_POK)) {
6402 if ((flags & SVTYPEMASK) < SVt_PVIV)
6403 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6405 (void)SvIOK_only(sv);
6408 #ifdef PERL_PRESERVE_IVUV
6410 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6411 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6412 /* Need to try really hard to see if it's an integer.
6413 9.22337203685478e+18 is an integer.
6414 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6415 so $a="9.22337203685478e+18"; $a+0; $a--
6416 needs to be the same as $a="9.22337203685478e+18"; $a--
6423 /* sv_2iv *should* have made this an NV */
6424 if (flags & SVp_NOK) {
6425 (void)SvNOK_only(sv);
6426 SvNV_set(sv, SvNVX(sv) - 1.0);
6429 /* I don't think we can get here. Maybe I should assert this
6430 And if we do get here I suspect that sv_setnv will croak. NWC
6432 #if defined(USE_LONG_DOUBLE)
6433 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",
6434 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6436 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6437 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6441 #endif /* PERL_PRESERVE_IVUV */
6442 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6446 =for apidoc sv_mortalcopy
6448 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6449 The new SV is marked as mortal. It will be destroyed "soon", either by an
6450 explicit call to FREETMPS, or by an implicit call at places such as
6451 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6456 /* Make a string that will exist for the duration of the expression
6457 * evaluation. Actually, it may have to last longer than that, but
6458 * hopefully we won't free it until it has been assigned to a
6459 * permanent location. */
6462 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6467 sv_setsv(sv,oldstr);
6469 PL_tmps_stack[++PL_tmps_ix] = sv;
6475 =for apidoc sv_newmortal
6477 Creates a new null SV which is mortal. The reference count of the SV is
6478 set to 1. It will be destroyed "soon", either by an explicit call to
6479 FREETMPS, or by an implicit call at places such as statement boundaries.
6480 See also C<sv_mortalcopy> and C<sv_2mortal>.
6486 Perl_sv_newmortal(pTHX)
6491 SvFLAGS(sv) = SVs_TEMP;
6493 PL_tmps_stack[++PL_tmps_ix] = sv;
6498 =for apidoc sv_2mortal
6500 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6501 by an explicit call to FREETMPS, or by an implicit call at places such as
6502 statement boundaries. SvTEMP() is turned on which means that the SV's
6503 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6504 and C<sv_mortalcopy>.
6510 Perl_sv_2mortal(pTHX_ register SV *sv)
6515 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6518 PL_tmps_stack[++PL_tmps_ix] = sv;
6526 Creates a new SV and copies a string into it. The reference count for the
6527 SV is set to 1. If C<len> is zero, Perl will compute the length using
6528 strlen(). For efficiency, consider using C<newSVpvn> instead.
6534 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6539 sv_setpvn(sv,s,len ? len : strlen(s));
6544 =for apidoc newSVpvn
6546 Creates a new SV and copies a string into it. The reference count for the
6547 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6548 string. You are responsible for ensuring that the source string is at least
6549 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6555 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6560 sv_setpvn(sv,s,len);
6566 =for apidoc newSVhek
6568 Creates a new SV from the hash key structure. It will generate scalars that
6569 point to the shared string table where possible. Returns a new (undefined)
6570 SV if the hek is NULL.
6576 Perl_newSVhek(pTHX_ const HEK *hek)
6585 if (HEK_LEN(hek) == HEf_SVKEY) {
6586 return newSVsv(*(SV**)HEK_KEY(hek));
6588 const int flags = HEK_FLAGS(hek);
6589 if (flags & HVhek_WASUTF8) {
6591 Andreas would like keys he put in as utf8 to come back as utf8
6593 STRLEN utf8_len = HEK_LEN(hek);
6594 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6595 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6598 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6600 } else if (flags & HVhek_REHASH) {
6601 /* We don't have a pointer to the hv, so we have to replicate the
6602 flag into every HEK. This hv is using custom a hasing
6603 algorithm. Hence we can't return a shared string scalar, as
6604 that would contain the (wrong) hash value, and might get passed
6605 into an hv routine with a regular hash */
6607 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6612 /* This will be overwhelminly the most common case. */
6613 return newSVpvn_share(HEK_KEY(hek),
6614 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6620 =for apidoc newSVpvn_share
6622 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6623 table. If the string does not already exist in the table, it is created
6624 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6625 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6626 otherwise the hash is computed. The idea here is that as the string table
6627 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6628 hash lookup will avoid string compare.
6634 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6637 bool is_utf8 = FALSE;
6639 STRLEN tmplen = -len;
6641 /* See the note in hv.c:hv_fetch() --jhi */
6642 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6646 PERL_HASH(hash, src, len);
6648 sv_upgrade(sv, SVt_PV);
6649 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6661 #if defined(PERL_IMPLICIT_CONTEXT)
6663 /* pTHX_ magic can't cope with varargs, so this is a no-context
6664 * version of the main function, (which may itself be aliased to us).
6665 * Don't access this version directly.
6669 Perl_newSVpvf_nocontext(const char* pat, ...)
6674 va_start(args, pat);
6675 sv = vnewSVpvf(pat, &args);
6682 =for apidoc newSVpvf
6684 Creates a new SV and initializes it with the string formatted like
6691 Perl_newSVpvf(pTHX_ const char* pat, ...)
6695 va_start(args, pat);
6696 sv = vnewSVpvf(pat, &args);
6701 /* backend for newSVpvf() and newSVpvf_nocontext() */
6704 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6708 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6715 Creates a new SV and copies a floating point value into it.
6716 The reference count for the SV is set to 1.
6722 Perl_newSVnv(pTHX_ NV n)
6734 Creates a new SV and copies an integer into it. The reference count for the
6741 Perl_newSViv(pTHX_ IV i)
6753 Creates a new SV and copies an unsigned integer into it.
6754 The reference count for the SV is set to 1.
6760 Perl_newSVuv(pTHX_ UV u)
6770 =for apidoc newRV_noinc
6772 Creates an RV wrapper for an SV. The reference count for the original
6773 SV is B<not> incremented.
6779 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6784 sv_upgrade(sv, SVt_RV);
6786 SvRV_set(sv, tmpRef);
6791 /* newRV_inc is the official function name to use now.
6792 * newRV_inc is in fact #defined to newRV in sv.h
6796 Perl_newRV(pTHX_ SV *tmpRef)
6798 return newRV_noinc(SvREFCNT_inc(tmpRef));
6804 Creates a new SV which is an exact duplicate of the original SV.
6811 Perl_newSVsv(pTHX_ register SV *old)
6817 if (SvTYPE(old) == SVTYPEMASK) {
6818 if (ckWARN_d(WARN_INTERNAL))
6819 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6823 /* SV_GMAGIC is the default for sv_setv()
6824 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6825 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6826 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6831 =for apidoc sv_reset
6833 Underlying implementation for the C<reset> Perl function.
6834 Note that the perl-level function is vaguely deprecated.
6840 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6843 char todo[PERL_UCHAR_MAX+1];
6848 if (!*s) { /* reset ?? searches */
6849 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6851 PMOP *pm = (PMOP *) mg->mg_obj;
6853 pm->op_pmdynflags &= ~PMdf_USED;
6860 /* reset variables */
6862 if (!HvARRAY(stash))
6865 Zero(todo, 256, char);
6868 I32 i = (unsigned char)*s;
6872 max = (unsigned char)*s++;
6873 for ( ; i <= max; i++) {
6876 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6878 for (entry = HvARRAY(stash)[i];
6880 entry = HeNEXT(entry))
6885 if (!todo[(U8)*HeKEY(entry)])
6887 gv = (GV*)HeVAL(entry);
6890 if (SvTHINKFIRST(sv)) {
6891 if (!SvREADONLY(sv) && SvROK(sv))
6893 /* XXX Is this continue a bug? Why should THINKFIRST
6894 exempt us from resetting arrays and hashes? */
6898 if (SvTYPE(sv) >= SVt_PV) {
6900 if (SvPVX_const(sv) != Nullch)
6908 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6910 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6913 # if defined(USE_ENVIRON_ARRAY)
6916 # endif /* USE_ENVIRON_ARRAY */
6927 Using various gambits, try to get an IO from an SV: the IO slot if its a
6928 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6929 named after the PV if we're a string.
6935 Perl_sv_2io(pTHX_ SV *sv)
6940 switch (SvTYPE(sv)) {
6948 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6952 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6954 return sv_2io(SvRV(sv));
6955 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6961 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6970 Using various gambits, try to get a CV from an SV; in addition, try if
6971 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6977 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6984 return *gvp = Nullgv, Nullcv;
6985 switch (SvTYPE(sv)) {
7003 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7004 tryAMAGICunDEREF(to_cv);
7007 if (SvTYPE(sv) == SVt_PVCV) {
7016 Perl_croak(aTHX_ "Not a subroutine reference");
7021 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7027 if (lref && !GvCVu(gv)) {
7030 tmpsv = NEWSV(704,0);
7031 gv_efullname3(tmpsv, gv, Nullch);
7032 /* XXX this is probably not what they think they're getting.
7033 * It has the same effect as "sub name;", i.e. just a forward
7035 newSUB(start_subparse(FALSE, 0),
7036 newSVOP(OP_CONST, 0, tmpsv),
7041 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7051 Returns true if the SV has a true value by Perl's rules.
7052 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7053 instead use an in-line version.
7059 Perl_sv_true(pTHX_ register SV *sv)
7064 register const XPV* const tXpv = (XPV*)SvANY(sv);
7066 (tXpv->xpv_cur > 1 ||
7067 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7074 return SvIVX(sv) != 0;
7077 return SvNVX(sv) != 0.0;
7079 return sv_2bool(sv);
7085 =for apidoc sv_pvn_force
7087 Get a sensible string out of the SV somehow.
7088 A private implementation of the C<SvPV_force> macro for compilers which
7089 can't cope with complex macro expressions. Always use the macro instead.
7091 =for apidoc sv_pvn_force_flags
7093 Get a sensible string out of the SV somehow.
7094 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7095 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7096 implemented in terms of this function.
7097 You normally want to use the various wrapper macros instead: see
7098 C<SvPV_force> and C<SvPV_force_nomg>
7104 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7107 if (SvTHINKFIRST(sv) && !SvROK(sv))
7108 sv_force_normal_flags(sv, 0);
7118 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7119 const char * const ref = sv_reftype(sv,0);
7121 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7122 ref, OP_NAME(PL_op));
7124 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7126 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7127 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7129 s = sv_2pv_flags(sv, &len, flags);
7133 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7136 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7137 SvGROW(sv, len + 1);
7138 Move(s,SvPVX(sv),len,char);
7143 SvPOK_on(sv); /* validate pointer */
7145 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7146 PTR2UV(sv),SvPVX_const(sv)));
7149 return SvPVX_mutable(sv);
7153 =for apidoc sv_pvbyten_force
7155 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7161 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7163 sv_pvn_force(sv,lp);
7164 sv_utf8_downgrade(sv,0);
7170 =for apidoc sv_pvutf8n_force
7172 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7178 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7180 sv_pvn_force(sv,lp);
7181 sv_utf8_upgrade(sv);
7187 =for apidoc sv_reftype
7189 Returns a string describing what the SV is a reference to.
7195 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7197 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7198 inside return suggests a const propagation bug in g++. */
7199 if (ob && SvOBJECT(sv)) {
7200 char * const name = HvNAME_get(SvSTASH(sv));
7201 return name ? name : (char *) "__ANON__";
7204 switch (SvTYPE(sv)) {
7221 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7222 /* tied lvalues should appear to be
7223 * scalars for backwards compatitbility */
7224 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7225 ? "SCALAR" : "LVALUE");
7226 case SVt_PVAV: return "ARRAY";
7227 case SVt_PVHV: return "HASH";
7228 case SVt_PVCV: return "CODE";
7229 case SVt_PVGV: return "GLOB";
7230 case SVt_PVFM: return "FORMAT";
7231 case SVt_PVIO: return "IO";
7232 default: return "UNKNOWN";
7238 =for apidoc sv_isobject
7240 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7241 object. If the SV is not an RV, or if the object is not blessed, then this
7248 Perl_sv_isobject(pTHX_ SV *sv)
7264 Returns a boolean indicating whether the SV is blessed into the specified
7265 class. This does not check for subtypes; use C<sv_derived_from> to verify
7266 an inheritance relationship.
7272 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7283 hvname = HvNAME_get(SvSTASH(sv));
7287 return strEQ(hvname, name);
7293 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7294 it will be upgraded to one. If C<classname> is non-null then the new SV will
7295 be blessed in the specified package. The new SV is returned and its
7296 reference count is 1.
7302 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7308 SV_CHECK_THINKFIRST_COW_DROP(rv);
7311 if (SvTYPE(rv) >= SVt_PVMG) {
7312 const U32 refcnt = SvREFCNT(rv);
7316 SvREFCNT(rv) = refcnt;
7319 if (SvTYPE(rv) < SVt_RV)
7320 sv_upgrade(rv, SVt_RV);
7321 else if (SvTYPE(rv) > SVt_RV) {
7332 HV* const stash = gv_stashpv(classname, TRUE);
7333 (void)sv_bless(rv, stash);
7339 =for apidoc sv_setref_pv
7341 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7342 argument will be upgraded to an RV. That RV will be modified to point to
7343 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7344 into the SV. The C<classname> argument indicates the package for the
7345 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7346 will have a reference count of 1, and the RV will be returned.
7348 Do not use with other Perl types such as HV, AV, SV, CV, because those
7349 objects will become corrupted by the pointer copy process.
7351 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7357 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7360 sv_setsv(rv, &PL_sv_undef);
7364 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7369 =for apidoc sv_setref_iv
7371 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7372 argument will be upgraded to an RV. That RV will be modified to point to
7373 the new SV. The C<classname> argument indicates the package for the
7374 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7375 will have a reference count of 1, and the RV will be returned.
7381 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7383 sv_setiv(newSVrv(rv,classname), iv);
7388 =for apidoc sv_setref_uv
7390 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7391 argument will be upgraded to an RV. That RV will be modified to point to
7392 the new SV. The C<classname> argument indicates the package for the
7393 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7394 will have a reference count of 1, and the RV will be returned.
7400 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7402 sv_setuv(newSVrv(rv,classname), uv);
7407 =for apidoc sv_setref_nv
7409 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7410 argument will be upgraded to an RV. That RV will be modified to point to
7411 the new SV. The C<classname> argument indicates the package for the
7412 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7413 will have a reference count of 1, and the RV will be returned.
7419 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7421 sv_setnv(newSVrv(rv,classname), nv);
7426 =for apidoc sv_setref_pvn
7428 Copies a string into a new SV, optionally blessing the SV. The length of the
7429 string must be specified with C<n>. The C<rv> argument will be upgraded to
7430 an RV. That RV will be modified to point to the new SV. The C<classname>
7431 argument indicates the package for the blessing. Set C<classname> to
7432 C<Nullch> to avoid the blessing. The new SV will have a reference count
7433 of 1, and the RV will be returned.
7435 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7441 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7443 sv_setpvn(newSVrv(rv,classname), pv, n);
7448 =for apidoc sv_bless
7450 Blesses an SV into a specified package. The SV must be an RV. The package
7451 must be designated by its stash (see C<gv_stashpv()>). The reference count
7452 of the SV is unaffected.
7458 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7462 Perl_croak(aTHX_ "Can't bless non-reference value");
7464 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7465 if (SvREADONLY(tmpRef))
7466 Perl_croak(aTHX_ PL_no_modify);
7467 if (SvOBJECT(tmpRef)) {
7468 if (SvTYPE(tmpRef) != SVt_PVIO)
7470 SvREFCNT_dec(SvSTASH(tmpRef));
7473 SvOBJECT_on(tmpRef);
7474 if (SvTYPE(tmpRef) != SVt_PVIO)
7476 SvUPGRADE(tmpRef, SVt_PVMG);
7477 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7484 if(SvSMAGICAL(tmpRef))
7485 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7493 /* Downgrades a PVGV to a PVMG.
7497 S_sv_unglob(pTHX_ SV *sv)
7501 assert(SvTYPE(sv) == SVt_PVGV);
7506 sv_del_backref((SV*)GvSTASH(sv), sv);
7507 GvSTASH(sv) = Nullhv;
7509 sv_unmagic(sv, PERL_MAGIC_glob);
7510 Safefree(GvNAME(sv));
7513 /* need to keep SvANY(sv) in the right arena */
7514 xpvmg = new_XPVMG();
7515 StructCopy(SvANY(sv), xpvmg, XPVMG);
7516 del_XPVGV(SvANY(sv));
7519 SvFLAGS(sv) &= ~SVTYPEMASK;
7520 SvFLAGS(sv) |= SVt_PVMG;
7524 =for apidoc sv_unref_flags
7526 Unsets the RV status of the SV, and decrements the reference count of
7527 whatever was being referenced by the RV. This can almost be thought of
7528 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7529 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7530 (otherwise the decrementing is conditional on the reference count being
7531 different from one or the reference being a readonly SV).
7538 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7540 SV* const target = SvRV(ref);
7542 if (SvWEAKREF(ref)) {
7543 sv_del_backref(target, ref);
7545 SvRV_set(ref, NULL);
7548 SvRV_set(ref, NULL);
7550 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7551 assigned to as BEGIN {$a = \"Foo"} will fail. */
7552 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7553 SvREFCNT_dec(target);
7554 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7555 sv_2mortal(target); /* Schedule for freeing later */
7559 =for apidoc sv_untaint
7561 Untaint an SV. Use C<SvTAINTED_off> instead.
7566 Perl_sv_untaint(pTHX_ SV *sv)
7568 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7569 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7576 =for apidoc sv_tainted
7578 Test an SV for taintedness. Use C<SvTAINTED> instead.
7583 Perl_sv_tainted(pTHX_ SV *sv)
7585 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7586 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7587 if (mg && (mg->mg_len & 1) )
7594 =for apidoc sv_setpviv
7596 Copies an integer into the given SV, also updating its string value.
7597 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7603 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7605 char buf[TYPE_CHARS(UV)];
7607 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7609 sv_setpvn(sv, ptr, ebuf - ptr);
7613 =for apidoc sv_setpviv_mg
7615 Like C<sv_setpviv>, but also handles 'set' magic.
7621 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7627 #if defined(PERL_IMPLICIT_CONTEXT)
7629 /* pTHX_ magic can't cope with varargs, so this is a no-context
7630 * version of the main function, (which may itself be aliased to us).
7631 * Don't access this version directly.
7635 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7639 va_start(args, pat);
7640 sv_vsetpvf(sv, pat, &args);
7644 /* pTHX_ magic can't cope with varargs, so this is a no-context
7645 * version of the main function, (which may itself be aliased to us).
7646 * Don't access this version directly.
7650 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7654 va_start(args, pat);
7655 sv_vsetpvf_mg(sv, pat, &args);
7661 =for apidoc sv_setpvf
7663 Works like C<sv_catpvf> but copies the text into the SV instead of
7664 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7670 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7673 va_start(args, pat);
7674 sv_vsetpvf(sv, pat, &args);
7679 =for apidoc sv_vsetpvf
7681 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7682 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7684 Usually used via its frontend C<sv_setpvf>.
7690 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7692 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7696 =for apidoc sv_setpvf_mg
7698 Like C<sv_setpvf>, but also handles 'set' magic.
7704 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7707 va_start(args, pat);
7708 sv_vsetpvf_mg(sv, pat, &args);
7713 =for apidoc sv_vsetpvf_mg
7715 Like C<sv_vsetpvf>, but also handles 'set' magic.
7717 Usually used via its frontend C<sv_setpvf_mg>.
7723 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7725 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7729 #if defined(PERL_IMPLICIT_CONTEXT)
7731 /* pTHX_ magic can't cope with varargs, so this is a no-context
7732 * version of the main function, (which may itself be aliased to us).
7733 * Don't access this version directly.
7737 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7741 va_start(args, pat);
7742 sv_vcatpvf(sv, pat, &args);
7746 /* pTHX_ magic can't cope with varargs, so this is a no-context
7747 * version of the main function, (which may itself be aliased to us).
7748 * Don't access this version directly.
7752 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7756 va_start(args, pat);
7757 sv_vcatpvf_mg(sv, pat, &args);
7763 =for apidoc sv_catpvf
7765 Processes its arguments like C<sprintf> and appends the formatted
7766 output to an SV. If the appended data contains "wide" characters
7767 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7768 and characters >255 formatted with %c), the original SV might get
7769 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7770 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7771 valid UTF-8; if the original SV was bytes, the pattern should be too.
7776 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7779 va_start(args, pat);
7780 sv_vcatpvf(sv, pat, &args);
7785 =for apidoc sv_vcatpvf
7787 Processes its arguments like C<vsprintf> and appends the formatted output
7788 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7790 Usually used via its frontend C<sv_catpvf>.
7796 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7798 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7802 =for apidoc sv_catpvf_mg
7804 Like C<sv_catpvf>, but also handles 'set' magic.
7810 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7813 va_start(args, pat);
7814 sv_vcatpvf_mg(sv, pat, &args);
7819 =for apidoc sv_vcatpvf_mg
7821 Like C<sv_vcatpvf>, but also handles 'set' magic.
7823 Usually used via its frontend C<sv_catpvf_mg>.
7829 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7831 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7836 =for apidoc sv_vsetpvfn
7838 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7841 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7847 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7849 sv_setpvn(sv, "", 0);
7850 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7853 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7856 S_expect_number(pTHX_ char** pattern)
7859 switch (**pattern) {
7860 case '1': case '2': case '3':
7861 case '4': case '5': case '6':
7862 case '7': case '8': case '9':
7863 while (isDIGIT(**pattern))
7864 var = var * 10 + (*(*pattern)++ - '0');
7868 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7871 F0convert(NV nv, char *endbuf, STRLEN *len)
7873 const int neg = nv < 0;
7882 if (uv & 1 && uv == nv)
7883 uv--; /* Round to even */
7885 const unsigned dig = uv % 10;
7898 =for apidoc sv_vcatpvfn
7900 Processes its arguments like C<vsprintf> and appends the formatted output
7901 to an SV. Uses an array of SVs if the C style variable argument list is
7902 missing (NULL). When running with taint checks enabled, indicates via
7903 C<maybe_tainted> if results are untrustworthy (often due to the use of
7906 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7912 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7913 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7914 vec_utf8 = DO_UTF8(vecsv);
7916 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7919 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7926 static const char nullstr[] = "(null)";
7928 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7929 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7931 /* Times 4: a decimal digit takes more than 3 binary digits.
7932 * NV_DIG: mantissa takes than many decimal digits.
7933 * Plus 32: Playing safe. */
7934 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7935 /* large enough for "%#.#f" --chip */
7936 /* what about long double NVs? --jhi */
7938 PERL_UNUSED_ARG(maybe_tainted);
7940 /* no matter what, this is a string now */
7941 (void)SvPV_force(sv, origlen);
7943 /* special-case "", "%s", and "%-p" (SVf - see below) */
7946 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7948 const char * const s = va_arg(*args, char*);
7949 sv_catpv(sv, s ? s : nullstr);
7951 else if (svix < svmax) {
7952 sv_catsv(sv, *svargs);
7956 if (args && patlen == 3 && pat[0] == '%' &&
7957 pat[1] == '-' && pat[2] == 'p') {
7958 argsv = va_arg(*args, SV*);
7959 sv_catsv(sv, argsv);
7963 #ifndef USE_LONG_DOUBLE
7964 /* special-case "%.<number>[gf]" */
7965 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7966 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7967 unsigned digits = 0;
7971 while (*pp >= '0' && *pp <= '9')
7972 digits = 10 * digits + (*pp++ - '0');
7973 if (pp - pat == (int)patlen - 1) {
7981 /* Add check for digits != 0 because it seems that some
7982 gconverts are buggy in this case, and we don't yet have
7983 a Configure test for this. */
7984 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7985 /* 0, point, slack */
7986 Gconvert(nv, (int)digits, 0, ebuf);
7988 if (*ebuf) /* May return an empty string for digits==0 */
7991 } else if (!digits) {
7994 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7995 sv_catpvn(sv, p, l);
8001 #endif /* !USE_LONG_DOUBLE */
8003 if (!args && svix < svmax && DO_UTF8(*svargs))
8006 patend = (char*)pat + patlen;
8007 for (p = (char*)pat; p < patend; p = q) {
8010 bool vectorize = FALSE;
8011 bool vectorarg = FALSE;
8012 bool vec_utf8 = FALSE;
8018 bool has_precis = FALSE;
8021 bool is_utf8 = FALSE; /* is this item utf8? */
8022 #ifdef HAS_LDBL_SPRINTF_BUG
8023 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8024 with sfio - Allen <allens@cpan.org> */
8025 bool fix_ldbl_sprintf_bug = FALSE;
8029 U8 utf8buf[UTF8_MAXBYTES+1];
8030 STRLEN esignlen = 0;
8032 const char *eptr = Nullch;
8035 const U8 *vecstr = Null(U8*);
8042 /* we need a long double target in case HAS_LONG_DOUBLE but
8045 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8053 const char *dotstr = ".";
8054 STRLEN dotstrlen = 1;
8055 I32 efix = 0; /* explicit format parameter index */
8056 I32 ewix = 0; /* explicit width index */
8057 I32 epix = 0; /* explicit precision index */
8058 I32 evix = 0; /* explicit vector index */
8059 bool asterisk = FALSE;
8061 /* echo everything up to the next format specification */
8062 for (q = p; q < patend && *q != '%'; ++q) ;
8064 if (has_utf8 && !pat_utf8)
8065 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8067 sv_catpvn(sv, p, q - p);
8074 We allow format specification elements in this order:
8075 \d+\$ explicit format parameter index
8077 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8078 0 flag (as above): repeated to allow "v02"
8079 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8080 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8082 [%bcdefginopsuxDFOUX] format (mandatory)
8087 As of perl5.9.3, printf format checking is on by default.
8088 Internally, perl uses %p formats to provide an escape to
8089 some extended formatting. This block deals with those
8090 extensions: if it does not match, (char*)q is reset and
8091 the normal format processing code is used.
8093 Currently defined extensions are:
8094 %p include pointer address (standard)
8095 %-p (SVf) include an SV (previously %_)
8096 %-<num>p include an SV with precision <num>
8097 %1p (VDf) include a v-string (as %vd)
8098 %<num>p reserved for future extensions
8100 Robin Barker 2005-07-14
8107 EXPECT_NUMBER(q, n);
8114 argsv = va_arg(*args, SV*);
8115 eptr = SvPVx_const(argsv, elen);
8121 else if (n == vdNUMBER) { /* VDf */
8128 if (ckWARN_d(WARN_INTERNAL))
8129 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8130 "internal %%<num>p might conflict with future printf extensions");
8136 if (EXPECT_NUMBER(q, width)) {
8177 if (EXPECT_NUMBER(q, ewix))
8186 if ((vectorarg = asterisk)) {
8199 EXPECT_NUMBER(q, width);
8205 vecsv = va_arg(*args, SV*);
8207 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8208 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8209 dotstr = SvPV_const(vecsv, dotstrlen);
8216 else if (efix ? efix <= svmax : svix < svmax) {
8217 vecsv = svargs[efix ? efix-1 : svix++];
8218 vecstr = (U8*)SvPV_const(vecsv,veclen);
8219 vec_utf8 = DO_UTF8(vecsv);
8220 /* if this is a version object, we need to return the
8221 * stringified representation (which the SvPVX_const has
8222 * already done for us), but not vectorize the args
8224 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8226 q++; /* skip past the rest of the %vd format */
8227 eptr = (const char *) vecstr;
8241 i = va_arg(*args, int);
8243 i = (ewix ? ewix <= svmax : svix < svmax) ?
8244 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8246 width = (i < 0) ? -i : i;
8256 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8258 /* XXX: todo, support specified precision parameter */
8262 i = va_arg(*args, int);
8264 i = (ewix ? ewix <= svmax : svix < svmax)
8265 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8266 precis = (i < 0) ? 0 : i;
8271 precis = precis * 10 + (*q++ - '0');
8280 case 'I': /* Ix, I32x, and I64x */
8282 if (q[1] == '6' && q[2] == '4') {
8288 if (q[1] == '3' && q[2] == '2') {
8298 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8309 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8310 if (*(q + 1) == 'l') { /* lld, llf */
8336 const I32 i = efix-1;
8337 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8339 argsv = (svix >= 0 && svix < svmax)
8340 ? svargs[svix++] : &PL_sv_undef;
8349 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8351 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8353 eptr = (char*)utf8buf;
8354 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8365 if (args && !vectorize) {
8366 eptr = va_arg(*args, char*);
8368 #ifdef MACOS_TRADITIONAL
8369 /* On MacOS, %#s format is used for Pascal strings */
8374 elen = strlen(eptr);
8376 eptr = (char *)nullstr;
8377 elen = sizeof nullstr - 1;
8381 eptr = SvPVx_const(argsv, elen);
8382 if (DO_UTF8(argsv)) {
8383 if (has_precis && precis < elen) {
8385 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8388 if (width) { /* fudge width (can't fudge elen) */
8389 width += elen - sv_len_utf8(argsv);
8397 if (has_precis && elen > precis)
8404 if (alt || vectorize)
8406 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8427 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8436 esignbuf[esignlen++] = plus;
8440 case 'h': iv = (short)va_arg(*args, int); break;
8441 case 'l': iv = va_arg(*args, long); break;
8442 case 'V': iv = va_arg(*args, IV); break;
8443 default: iv = va_arg(*args, int); break;
8445 case 'q': iv = va_arg(*args, Quad_t); break;
8450 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8452 case 'h': iv = (short)tiv; break;
8453 case 'l': iv = (long)tiv; break;
8455 default: iv = tiv; break;
8457 case 'q': iv = (Quad_t)tiv; break;
8461 if ( !vectorize ) /* we already set uv above */
8466 esignbuf[esignlen++] = plus;
8470 esignbuf[esignlen++] = '-';
8513 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8524 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8525 case 'l': uv = va_arg(*args, unsigned long); break;
8526 case 'V': uv = va_arg(*args, UV); break;
8527 default: uv = va_arg(*args, unsigned); break;
8529 case 'q': uv = va_arg(*args, Uquad_t); break;
8534 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8536 case 'h': uv = (unsigned short)tuv; break;
8537 case 'l': uv = (unsigned long)tuv; break;
8539 default: uv = tuv; break;
8541 case 'q': uv = (Uquad_t)tuv; break;
8548 char *ptr = ebuf + sizeof ebuf;
8554 p = (char*)((c == 'X')
8555 ? "0123456789ABCDEF" : "0123456789abcdef");
8561 esignbuf[esignlen++] = '0';
8562 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8570 if (alt && *ptr != '0')
8581 esignbuf[esignlen++] = '0';
8582 esignbuf[esignlen++] = 'b';
8585 default: /* it had better be ten or less */
8589 } while (uv /= base);
8592 elen = (ebuf + sizeof ebuf) - ptr;
8596 zeros = precis - elen;
8597 else if (precis == 0 && elen == 1 && *eptr == '0')
8603 /* FLOATING POINT */
8606 c = 'f'; /* maybe %F isn't supported here */
8612 /* This is evil, but floating point is even more evil */
8614 /* for SV-style calling, we can only get NV
8615 for C-style calling, we assume %f is double;
8616 for simplicity we allow any of %Lf, %llf, %qf for long double
8620 #if defined(USE_LONG_DOUBLE)
8624 /* [perl #20339] - we should accept and ignore %lf rather than die */
8628 #if defined(USE_LONG_DOUBLE)
8629 intsize = args ? 0 : 'q';
8633 #if defined(HAS_LONG_DOUBLE)
8642 /* now we need (long double) if intsize == 'q', else (double) */
8643 nv = (args && !vectorize) ?
8644 #if LONG_DOUBLESIZE > DOUBLESIZE
8646 va_arg(*args, long double) :
8647 va_arg(*args, double)
8649 va_arg(*args, double)
8655 if (c != 'e' && c != 'E') {
8657 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8658 will cast our (long double) to (double) */
8659 (void)Perl_frexp(nv, &i);
8660 if (i == PERL_INT_MIN)
8661 Perl_die(aTHX_ "panic: frexp");
8663 need = BIT_DIGITS(i);
8665 need += has_precis ? precis : 6; /* known default */
8670 #ifdef HAS_LDBL_SPRINTF_BUG
8671 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8672 with sfio - Allen <allens@cpan.org> */
8675 # define MY_DBL_MAX DBL_MAX
8676 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8677 # if DOUBLESIZE >= 8
8678 # define MY_DBL_MAX 1.7976931348623157E+308L
8680 # define MY_DBL_MAX 3.40282347E+38L
8684 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8685 # define MY_DBL_MAX_BUG 1L
8687 # define MY_DBL_MAX_BUG MY_DBL_MAX
8691 # define MY_DBL_MIN DBL_MIN
8692 # else /* XXX guessing! -Allen */
8693 # if DOUBLESIZE >= 8
8694 # define MY_DBL_MIN 2.2250738585072014E-308L
8696 # define MY_DBL_MIN 1.17549435E-38L
8700 if ((intsize == 'q') && (c == 'f') &&
8701 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8703 /* it's going to be short enough that
8704 * long double precision is not needed */
8706 if ((nv <= 0L) && (nv >= -0L))
8707 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8709 /* would use Perl_fp_class as a double-check but not
8710 * functional on IRIX - see perl.h comments */
8712 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8713 /* It's within the range that a double can represent */
8714 #if defined(DBL_MAX) && !defined(DBL_MIN)
8715 if ((nv >= ((long double)1/DBL_MAX)) ||
8716 (nv <= (-(long double)1/DBL_MAX)))
8718 fix_ldbl_sprintf_bug = TRUE;
8721 if (fix_ldbl_sprintf_bug == TRUE) {
8731 # undef MY_DBL_MAX_BUG
8734 #endif /* HAS_LDBL_SPRINTF_BUG */
8736 need += 20; /* fudge factor */
8737 if (PL_efloatsize < need) {
8738 Safefree(PL_efloatbuf);
8739 PL_efloatsize = need + 20; /* more fudge */
8740 Newx(PL_efloatbuf, PL_efloatsize, char);
8741 PL_efloatbuf[0] = '\0';
8744 if ( !(width || left || plus || alt) && fill != '0'
8745 && has_precis && intsize != 'q' ) { /* Shortcuts */
8746 /* See earlier comment about buggy Gconvert when digits,
8748 if ( c == 'g' && precis) {
8749 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8750 /* May return an empty string for digits==0 */
8751 if (*PL_efloatbuf) {
8752 elen = strlen(PL_efloatbuf);
8753 goto float_converted;
8755 } else if ( c == 'f' && !precis) {
8756 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8761 char *ptr = ebuf + sizeof ebuf;
8764 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8765 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8766 if (intsize == 'q') {
8767 /* Copy the one or more characters in a long double
8768 * format before the 'base' ([efgEFG]) character to
8769 * the format string. */
8770 static char const prifldbl[] = PERL_PRIfldbl;
8771 char const *p = prifldbl + sizeof(prifldbl) - 3;
8772 while (p >= prifldbl) { *--ptr = *p--; }
8777 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8782 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8794 /* No taint. Otherwise we are in the strange situation
8795 * where printf() taints but print($float) doesn't.
8797 #if defined(HAS_LONG_DOUBLE)
8798 elen = ((intsize == 'q')
8799 ? my_sprintf(PL_efloatbuf, ptr, nv)
8800 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8802 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8806 eptr = PL_efloatbuf;
8812 i = SvCUR(sv) - origlen;
8813 if (args && !vectorize) {
8815 case 'h': *(va_arg(*args, short*)) = i; break;
8816 default: *(va_arg(*args, int*)) = i; break;
8817 case 'l': *(va_arg(*args, long*)) = i; break;
8818 case 'V': *(va_arg(*args, IV*)) = i; break;
8820 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8825 sv_setuv_mg(argsv, (UV)i);
8827 continue; /* not "break" */
8834 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8835 && ckWARN(WARN_PRINTF))
8837 SV * const msg = sv_newmortal();
8838 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8839 (PL_op->op_type == OP_PRTF) ? "" : "s");
8842 Perl_sv_catpvf(aTHX_ msg,
8843 "\"%%%c\"", c & 0xFF);
8845 Perl_sv_catpvf(aTHX_ msg,
8846 "\"%%\\%03"UVof"\"",
8849 sv_catpv(msg, "end of string");
8850 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8853 /* output mangled stuff ... */
8859 /* ... right here, because formatting flags should not apply */
8860 SvGROW(sv, SvCUR(sv) + elen + 1);
8862 Copy(eptr, p, elen, char);
8865 SvCUR_set(sv, p - SvPVX_const(sv));
8867 continue; /* not "break" */
8870 /* calculate width before utf8_upgrade changes it */
8871 have = esignlen + zeros + elen;
8873 Perl_croak_nocontext(PL_memory_wrap);
8875 if (is_utf8 != has_utf8) {
8878 sv_utf8_upgrade(sv);
8881 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8882 sv_utf8_upgrade(nsv);
8883 eptr = SvPVX_const(nsv);
8886 SvGROW(sv, SvCUR(sv) + elen + 1);
8891 need = (have > width ? have : width);
8894 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8895 Perl_croak_nocontext(PL_memory_wrap);
8896 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8898 if (esignlen && fill == '0') {
8900 for (i = 0; i < (int)esignlen; i++)
8904 memset(p, fill, gap);
8907 if (esignlen && fill != '0') {
8909 for (i = 0; i < (int)esignlen; i++)
8914 for (i = zeros; i; i--)
8918 Copy(eptr, p, elen, char);
8922 memset(p, ' ', gap);
8927 Copy(dotstr, p, dotstrlen, char);
8931 vectorize = FALSE; /* done iterating over vecstr */
8938 SvCUR_set(sv, p - SvPVX_const(sv));
8946 /* =========================================================================
8948 =head1 Cloning an interpreter
8950 All the macros and functions in this section are for the private use of
8951 the main function, perl_clone().
8953 The foo_dup() functions make an exact copy of an existing foo thinngy.
8954 During the course of a cloning, a hash table is used to map old addresses
8955 to new addresses. The table is created and manipulated with the
8956 ptr_table_* functions.
8960 ============================================================================*/
8963 #if defined(USE_ITHREADS)
8965 #ifndef GpREFCNT_inc
8966 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8970 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8971 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8972 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8973 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8974 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8975 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8976 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8977 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8978 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8979 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8980 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8981 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8982 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8985 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8986 regcomp.c. AMS 20010712 */
8989 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8994 struct reg_substr_datum *s;
8997 return (REGEXP *)NULL;
8999 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9002 len = r->offsets[0];
9003 npar = r->nparens+1;
9005 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9006 Copy(r->program, ret->program, len+1, regnode);
9008 Newx(ret->startp, npar, I32);
9009 Copy(r->startp, ret->startp, npar, I32);
9010 Newx(ret->endp, npar, I32);
9011 Copy(r->startp, ret->startp, npar, I32);
9013 Newx(ret->substrs, 1, struct reg_substr_data);
9014 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9015 s->min_offset = r->substrs->data[i].min_offset;
9016 s->max_offset = r->substrs->data[i].max_offset;
9017 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9018 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9021 ret->regstclass = NULL;
9024 const int count = r->data->count;
9027 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9028 char, struct reg_data);
9029 Newx(d->what, count, U8);
9032 for (i = 0; i < count; i++) {
9033 d->what[i] = r->data->what[i];
9034 switch (d->what[i]) {
9035 /* legal options are one of: sfpont
9036 see also regcomp.h and pregfree() */
9038 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9041 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9044 /* This is cheating. */
9045 Newx(d->data[i], 1, struct regnode_charclass_class);
9046 StructCopy(r->data->data[i], d->data[i],
9047 struct regnode_charclass_class);
9048 ret->regstclass = (regnode*)d->data[i];
9051 /* Compiled op trees are readonly, and can thus be
9052 shared without duplication. */
9054 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9058 d->data[i] = r->data->data[i];
9061 d->data[i] = r->data->data[i];
9063 ((reg_trie_data*)d->data[i])->refcount++;
9067 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9076 Newx(ret->offsets, 2*len+1, U32);
9077 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9079 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9080 ret->refcnt = r->refcnt;
9081 ret->minlen = r->minlen;
9082 ret->prelen = r->prelen;
9083 ret->nparens = r->nparens;
9084 ret->lastparen = r->lastparen;
9085 ret->lastcloseparen = r->lastcloseparen;
9086 ret->reganch = r->reganch;
9088 ret->sublen = r->sublen;
9090 if (RX_MATCH_COPIED(ret))
9091 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9093 ret->subbeg = Nullch;
9094 #ifdef PERL_OLD_COPY_ON_WRITE
9095 ret->saved_copy = Nullsv;
9098 ptr_table_store(PL_ptr_table, r, ret);
9102 /* duplicate a file handle */
9105 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9109 PERL_UNUSED_ARG(type);
9112 return (PerlIO*)NULL;
9114 /* look for it in the table first */
9115 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9119 /* create anew and remember what it is */
9120 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9121 ptr_table_store(PL_ptr_table, fp, ret);
9125 /* duplicate a directory handle */
9128 Perl_dirp_dup(pTHX_ DIR *dp)
9136 /* duplicate a typeglob */
9139 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9144 /* look for it in the table first */
9145 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9149 /* create anew and remember what it is */
9151 ptr_table_store(PL_ptr_table, gp, ret);
9154 ret->gp_refcnt = 0; /* must be before any other dups! */
9155 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9156 ret->gp_io = io_dup_inc(gp->gp_io, param);
9157 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9158 ret->gp_av = av_dup_inc(gp->gp_av, param);
9159 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9160 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9161 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9162 ret->gp_cvgen = gp->gp_cvgen;
9163 ret->gp_line = gp->gp_line;
9164 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9168 /* duplicate a chain of magic */
9171 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9173 MAGIC *mgprev = (MAGIC*)NULL;
9176 return (MAGIC*)NULL;
9177 /* look for it in the table first */
9178 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9182 for (; mg; mg = mg->mg_moremagic) {
9184 Newxz(nmg, 1, MAGIC);
9186 mgprev->mg_moremagic = nmg;
9189 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9190 nmg->mg_private = mg->mg_private;
9191 nmg->mg_type = mg->mg_type;
9192 nmg->mg_flags = mg->mg_flags;
9193 if (mg->mg_type == PERL_MAGIC_qr) {
9194 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9196 else if(mg->mg_type == PERL_MAGIC_backref) {
9197 const AV * const av = (AV*) mg->mg_obj;
9200 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9202 for (i = AvFILLp(av); i >= 0; i--) {
9203 if (!svp[i]) continue;
9204 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9207 else if (mg->mg_type == PERL_MAGIC_symtab) {
9208 nmg->mg_obj = mg->mg_obj;
9211 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9212 ? sv_dup_inc(mg->mg_obj, param)
9213 : sv_dup(mg->mg_obj, param);
9215 nmg->mg_len = mg->mg_len;
9216 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9217 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9218 if (mg->mg_len > 0) {
9219 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9220 if (mg->mg_type == PERL_MAGIC_overload_table &&
9221 AMT_AMAGIC((AMT*)mg->mg_ptr))
9223 AMT * const amtp = (AMT*)mg->mg_ptr;
9224 AMT * const namtp = (AMT*)nmg->mg_ptr;
9226 for (i = 1; i < NofAMmeth; i++) {
9227 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9231 else if (mg->mg_len == HEf_SVKEY)
9232 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9234 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9235 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9242 /* create a new pointer-mapping table */
9245 Perl_ptr_table_new(pTHX)
9248 Newxz(tbl, 1, PTR_TBL_t);
9251 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9256 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9258 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9262 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9263 following define) and at call to new_body_inline made below in
9264 Perl_ptr_table_store()
9267 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9269 /* map an existing pointer using a table */
9272 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9274 PTR_TBL_ENT_t *tblent;
9275 const UV hash = PTR_TABLE_HASH(sv);
9277 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9278 for (; tblent; tblent = tblent->next) {
9279 if (tblent->oldval == sv)
9280 return tblent->newval;
9285 /* add a new entry to a pointer-mapping table */
9288 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9290 PTR_TBL_ENT_t *tblent, **otblent;
9291 /* XXX this may be pessimal on platforms where pointers aren't good
9292 * hash values e.g. if they grow faster in the most significant
9294 const UV hash = PTR_TABLE_HASH(oldsv);
9298 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9299 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9300 if (tblent->oldval == oldsv) {
9301 tblent->newval = newsv;
9305 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9306 tblent->oldval = oldsv;
9307 tblent->newval = newsv;
9308 tblent->next = *otblent;
9311 if (!empty && tbl->tbl_items > tbl->tbl_max)
9312 ptr_table_split(tbl);
9315 /* double the hash bucket size of an existing ptr table */
9318 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9320 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9321 const UV oldsize = tbl->tbl_max + 1;
9322 UV newsize = oldsize * 2;
9325 Renew(ary, newsize, PTR_TBL_ENT_t*);
9326 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9327 tbl->tbl_max = --newsize;
9329 for (i=0; i < oldsize; i++, ary++) {
9330 PTR_TBL_ENT_t **curentp, **entp, *ent;
9333 curentp = ary + oldsize;
9334 for (entp = ary, ent = *ary; ent; ent = *entp) {
9335 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9337 ent->next = *curentp;
9347 /* remove all the entries from a ptr table */
9350 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9352 register PTR_TBL_ENT_t **array;
9353 register PTR_TBL_ENT_t *entry;
9357 if (!tbl || !tbl->tbl_items) {
9361 array = tbl->tbl_ary;
9367 PTR_TBL_ENT_t *oentry = entry;
9368 entry = entry->next;
9372 if (++riter > max) {
9375 entry = array[riter];
9382 /* clear and free a ptr table */
9385 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9390 ptr_table_clear(tbl);
9391 Safefree(tbl->tbl_ary);
9397 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9400 SvRV_set(dstr, SvWEAKREF(sstr)
9401 ? sv_dup(SvRV(sstr), param)
9402 : sv_dup_inc(SvRV(sstr), param));
9405 else if (SvPVX_const(sstr)) {
9406 /* Has something there */
9408 /* Normal PV - clone whole allocated space */
9409 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9410 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9411 /* Not that normal - actually sstr is copy on write.
9412 But we are a true, independant SV, so: */
9413 SvREADONLY_off(dstr);
9418 /* Special case - not normally malloced for some reason */
9419 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9420 /* A "shared" PV - clone it as "shared" PV */
9422 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9426 /* Some other special case - random pointer */
9427 SvPV_set(dstr, SvPVX(sstr));
9433 if (SvTYPE(dstr) == SVt_RV)
9434 SvRV_set(dstr, NULL);
9440 /* duplicate an SV of any type (including AV, HV etc) */
9443 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9448 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9450 /* look for it in the table first */
9451 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9455 if(param->flags & CLONEf_JOIN_IN) {
9456 /** We are joining here so we don't want do clone
9457 something that is bad **/
9460 if(SvTYPE(sstr) == SVt_PVHV &&
9461 (hvname = HvNAME_get(sstr))) {
9462 /** don't clone stashes if they already exist **/
9463 return (SV*)gv_stashpv(hvname,0);
9467 /* create anew and remember what it is */
9470 #ifdef DEBUG_LEAKING_SCALARS
9471 dstr->sv_debug_optype = sstr->sv_debug_optype;
9472 dstr->sv_debug_line = sstr->sv_debug_line;
9473 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9474 dstr->sv_debug_cloned = 1;
9476 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9478 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9482 ptr_table_store(PL_ptr_table, sstr, dstr);
9485 SvFLAGS(dstr) = SvFLAGS(sstr);
9486 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9487 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9490 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9491 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9492 PL_watch_pvx, SvPVX_const(sstr));
9495 /* don't clone objects whose class has asked us not to */
9496 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9497 SvFLAGS(dstr) &= ~SVTYPEMASK;
9502 switch (SvTYPE(sstr)) {
9507 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9508 SvIV_set(dstr, SvIVX(sstr));
9511 SvANY(dstr) = new_XNV();
9512 SvNV_set(dstr, SvNVX(sstr));
9515 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9516 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9520 /* These are all the types that need complex bodies allocating. */
9522 const svtype sv_type = SvTYPE(sstr);
9523 const struct body_details *const sv_type_details
9524 = bodies_by_type + sv_type;
9528 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9533 if (GvUNIQUE((GV*)sstr)) {
9534 /* Do sharing here, and fall through */
9547 assert(sv_type_details->copy);
9548 if (sv_type_details->arena) {
9549 new_body_inline(new_body, sv_type_details->copy, sv_type);
9551 = (void*)((char*)new_body - sv_type_details->offset);
9553 new_body = new_NOARENA(sv_type_details);
9557 SvANY(dstr) = new_body;
9560 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9561 ((char*)SvANY(dstr)) + sv_type_details->offset,
9562 sv_type_details->copy, char);
9564 Copy(((char*)SvANY(sstr)),
9565 ((char*)SvANY(dstr)),
9566 sv_type_details->size + sv_type_details->offset, char);
9569 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9570 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9572 /* The Copy above means that all the source (unduplicated) pointers
9573 are now in the destination. We can check the flags and the
9574 pointers in either, but it's possible that there's less cache
9575 missing by always going for the destination.
9576 FIXME - instrument and check that assumption */
9577 if (sv_type >= SVt_PVMG) {
9579 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9581 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9584 /* The cast silences a GCC warning about unhandled types. */
9585 switch ((int)sv_type) {
9597 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9598 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9599 LvTARG(dstr) = dstr;
9600 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9601 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9603 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9606 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9607 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9608 /* Don't call sv_add_backref here as it's going to be created
9609 as part of the magic cloning of the symbol table. */
9610 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9611 (void)GpREFCNT_inc(GvGP(dstr));
9614 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9615 if (IoOFP(dstr) == IoIFP(sstr))
9616 IoOFP(dstr) = IoIFP(dstr);
9618 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9619 /* PL_rsfp_filters entries have fake IoDIRP() */
9620 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9621 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9622 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9623 /* I have no idea why fake dirp (rsfps)
9624 should be treated differently but otherwise
9625 we end up with leaks -- sky*/
9626 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9627 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9628 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9630 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9631 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9632 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9634 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9635 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9636 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9639 if (AvARRAY((AV*)sstr)) {
9640 SV **dst_ary, **src_ary;
9641 SSize_t items = AvFILLp((AV*)sstr) + 1;
9643 src_ary = AvARRAY((AV*)sstr);
9644 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9645 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9646 SvPV_set(dstr, (char*)dst_ary);
9647 AvALLOC((AV*)dstr) = dst_ary;
9648 if (AvREAL((AV*)sstr)) {
9650 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9654 *dst_ary++ = sv_dup(*src_ary++, param);
9656 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9657 while (items-- > 0) {
9658 *dst_ary++ = &PL_sv_undef;
9662 SvPV_set(dstr, Nullch);
9663 AvALLOC((AV*)dstr) = (SV**)NULL;
9670 if (HvARRAY((HV*)sstr)) {
9672 const bool sharekeys = !!HvSHAREKEYS(sstr);
9673 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9674 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9676 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9677 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9679 HvARRAY(dstr) = (HE**)darray;
9680 while (i <= sxhv->xhv_max) {
9681 const HE *source = HvARRAY(sstr)[i];
9682 HvARRAY(dstr)[i] = source
9683 ? he_dup(source, sharekeys, param) : 0;
9687 struct xpvhv_aux *saux = HvAUX(sstr);
9688 struct xpvhv_aux *daux = HvAUX(dstr);
9689 /* This flag isn't copied. */
9690 /* SvOOK_on(hv) attacks the IV flags. */
9691 SvFLAGS(dstr) |= SVf_OOK;
9693 hvname = saux->xhv_name;
9695 = hvname ? hek_dup(hvname, param) : hvname;
9697 daux->xhv_riter = saux->xhv_riter;
9698 daux->xhv_eiter = saux->xhv_eiter
9699 ? he_dup(saux->xhv_eiter,
9700 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9704 SvPV_set(dstr, Nullch);
9706 /* Record stashes for possible cloning in Perl_clone(). */
9708 av_push(param->stashes, dstr);
9713 /* NOTE: not refcounted */
9714 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9716 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9718 if (CvCONST(dstr)) {
9719 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9720 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9721 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9723 /* don't dup if copying back - CvGV isn't refcounted, so the
9724 * duped GV may never be freed. A bit of a hack! DAPM */
9725 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9726 Nullgv : gv_dup(CvGV(dstr), param) ;
9727 if (!(param->flags & CLONEf_COPY_STACKS)) {
9730 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9733 ? cv_dup( CvOUTSIDE(dstr), param)
9734 : cv_dup_inc(CvOUTSIDE(dstr), param);
9736 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9742 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9748 /* duplicate a context */
9751 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9756 return (PERL_CONTEXT*)NULL;
9758 /* look for it in the table first */
9759 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9763 /* create anew and remember what it is */
9764 Newxz(ncxs, max + 1, PERL_CONTEXT);
9765 ptr_table_store(PL_ptr_table, cxs, ncxs);
9768 PERL_CONTEXT *cx = &cxs[ix];
9769 PERL_CONTEXT *ncx = &ncxs[ix];
9770 ncx->cx_type = cx->cx_type;
9771 if (CxTYPE(cx) == CXt_SUBST) {
9772 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9775 ncx->blk_oldsp = cx->blk_oldsp;
9776 ncx->blk_oldcop = cx->blk_oldcop;
9777 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9778 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9779 ncx->blk_oldpm = cx->blk_oldpm;
9780 ncx->blk_gimme = cx->blk_gimme;
9781 switch (CxTYPE(cx)) {
9783 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9784 ? cv_dup_inc(cx->blk_sub.cv, param)
9785 : cv_dup(cx->blk_sub.cv,param));
9786 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9787 ? av_dup_inc(cx->blk_sub.argarray, param)
9789 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9790 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9791 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9792 ncx->blk_sub.lval = cx->blk_sub.lval;
9793 ncx->blk_sub.retop = cx->blk_sub.retop;
9796 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9797 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9798 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9799 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9800 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9801 ncx->blk_eval.retop = cx->blk_eval.retop;
9804 ncx->blk_loop.label = cx->blk_loop.label;
9805 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9806 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9807 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9808 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9809 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9810 ? cx->blk_loop.iterdata
9811 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9812 ncx->blk_loop.oldcomppad
9813 = (PAD*)ptr_table_fetch(PL_ptr_table,
9814 cx->blk_loop.oldcomppad);
9815 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9816 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9817 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9818 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9819 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9822 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9823 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9824 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9825 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9826 ncx->blk_sub.retop = cx->blk_sub.retop;
9838 /* duplicate a stack info structure */
9841 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9846 return (PERL_SI*)NULL;
9848 /* look for it in the table first */
9849 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9853 /* create anew and remember what it is */
9854 Newxz(nsi, 1, PERL_SI);
9855 ptr_table_store(PL_ptr_table, si, nsi);
9857 nsi->si_stack = av_dup_inc(si->si_stack, param);
9858 nsi->si_cxix = si->si_cxix;
9859 nsi->si_cxmax = si->si_cxmax;
9860 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9861 nsi->si_type = si->si_type;
9862 nsi->si_prev = si_dup(si->si_prev, param);
9863 nsi->si_next = si_dup(si->si_next, param);
9864 nsi->si_markoff = si->si_markoff;
9869 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9870 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9871 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9872 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9873 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9874 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9875 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9876 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9877 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9878 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9879 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9880 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9881 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9882 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9885 #define pv_dup_inc(p) SAVEPV(p)
9886 #define pv_dup(p) SAVEPV(p)
9887 #define svp_dup_inc(p,pp) any_dup(p,pp)
9889 /* map any object to the new equivent - either something in the
9890 * ptr table, or something in the interpreter structure
9894 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9901 /* look for it in the table first */
9902 ret = ptr_table_fetch(PL_ptr_table, v);
9906 /* see if it is part of the interpreter structure */
9907 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9908 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9916 /* duplicate the save stack */
9919 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9921 ANY * const ss = proto_perl->Tsavestack;
9922 const I32 max = proto_perl->Tsavestack_max;
9923 I32 ix = proto_perl->Tsavestack_ix;
9935 void (*dptr) (void*);
9936 void (*dxptr) (pTHX_ void*);
9938 Newxz(nss, max, ANY);
9941 I32 i = POPINT(ss,ix);
9944 case SAVEt_ITEM: /* normal string */
9945 sv = (SV*)POPPTR(ss,ix);
9946 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9947 sv = (SV*)POPPTR(ss,ix);
9948 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9950 case SAVEt_SV: /* scalar reference */
9951 sv = (SV*)POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9953 gv = (GV*)POPPTR(ss,ix);
9954 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9956 case SAVEt_GENERIC_PVREF: /* generic char* */
9957 c = (char*)POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = pv_dup(c);
9959 ptr = POPPTR(ss,ix);
9960 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9962 case SAVEt_SHARED_PVREF: /* char* in shared space */
9963 c = (char*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = savesharedpv(c);
9965 ptr = POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9968 case SAVEt_GENERIC_SVREF: /* generic sv */
9969 case SAVEt_SVREF: /* scalar reference */
9970 sv = (SV*)POPPTR(ss,ix);
9971 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9972 ptr = POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9975 case SAVEt_AV: /* array reference */
9976 av = (AV*)POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = av_dup_inc(av, param);
9978 gv = (GV*)POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = gv_dup(gv, param);
9981 case SAVEt_HV: /* hash reference */
9982 hv = (HV*)POPPTR(ss,ix);
9983 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9984 gv = (GV*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = gv_dup(gv, param);
9987 case SAVEt_INT: /* int reference */
9988 ptr = POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9990 intval = (int)POPINT(ss,ix);
9991 TOPINT(nss,ix) = intval;
9993 case SAVEt_LONG: /* long reference */
9994 ptr = POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9996 longval = (long)POPLONG(ss,ix);
9997 TOPLONG(nss,ix) = longval;
9999 case SAVEt_I32: /* I32 reference */
10000 case SAVEt_I16: /* I16 reference */
10001 case SAVEt_I8: /* I8 reference */
10002 ptr = POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10005 TOPINT(nss,ix) = i;
10007 case SAVEt_IV: /* IV reference */
10008 ptr = POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10011 TOPIV(nss,ix) = iv;
10013 case SAVEt_SPTR: /* SV* reference */
10014 ptr = POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10016 sv = (SV*)POPPTR(ss,ix);
10017 TOPPTR(nss,ix) = sv_dup(sv, param);
10019 case SAVEt_VPTR: /* random* reference */
10020 ptr = POPPTR(ss,ix);
10021 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10022 ptr = POPPTR(ss,ix);
10023 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10025 case SAVEt_PPTR: /* char* reference */
10026 ptr = POPPTR(ss,ix);
10027 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10028 c = (char*)POPPTR(ss,ix);
10029 TOPPTR(nss,ix) = pv_dup(c);
10031 case SAVEt_HPTR: /* HV* reference */
10032 ptr = POPPTR(ss,ix);
10033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10034 hv = (HV*)POPPTR(ss,ix);
10035 TOPPTR(nss,ix) = hv_dup(hv, param);
10037 case SAVEt_APTR: /* AV* reference */
10038 ptr = POPPTR(ss,ix);
10039 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10040 av = (AV*)POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = av_dup(av, param);
10044 gv = (GV*)POPPTR(ss,ix);
10045 TOPPTR(nss,ix) = gv_dup(gv, param);
10047 case SAVEt_GP: /* scalar reference */
10048 gp = (GP*)POPPTR(ss,ix);
10049 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10050 (void)GpREFCNT_inc(gp);
10051 gv = (GV*)POPPTR(ss,ix);
10052 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10053 c = (char*)POPPTR(ss,ix);
10054 TOPPTR(nss,ix) = pv_dup(c);
10056 TOPIV(nss,ix) = iv;
10058 TOPIV(nss,ix) = iv;
10061 case SAVEt_MORTALIZESV:
10062 sv = (SV*)POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10066 ptr = POPPTR(ss,ix);
10067 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10068 /* these are assumed to be refcounted properly */
10070 switch (((OP*)ptr)->op_type) {
10072 case OP_LEAVESUBLV:
10076 case OP_LEAVEWRITE:
10077 TOPPTR(nss,ix) = ptr;
10082 TOPPTR(nss,ix) = Nullop;
10087 TOPPTR(nss,ix) = Nullop;
10090 c = (char*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = pv_dup_inc(c);
10093 case SAVEt_CLEARSV:
10094 longval = POPLONG(ss,ix);
10095 TOPLONG(nss,ix) = longval;
10098 hv = (HV*)POPPTR(ss,ix);
10099 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10100 c = (char*)POPPTR(ss,ix);
10101 TOPPTR(nss,ix) = pv_dup_inc(c);
10103 TOPINT(nss,ix) = i;
10105 case SAVEt_DESTRUCTOR:
10106 ptr = POPPTR(ss,ix);
10107 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10108 dptr = POPDPTR(ss,ix);
10109 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10110 any_dup(FPTR2DPTR(void *, dptr),
10113 case SAVEt_DESTRUCTOR_X:
10114 ptr = POPPTR(ss,ix);
10115 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10116 dxptr = POPDXPTR(ss,ix);
10117 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10118 any_dup(FPTR2DPTR(void *, dxptr),
10121 case SAVEt_REGCONTEXT:
10124 TOPINT(nss,ix) = i;
10127 case SAVEt_STACK_POS: /* Position on Perl stack */
10129 TOPINT(nss,ix) = i;
10131 case SAVEt_AELEM: /* array element */
10132 sv = (SV*)POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10135 TOPINT(nss,ix) = i;
10136 av = (AV*)POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = av_dup_inc(av, param);
10139 case SAVEt_HELEM: /* hash element */
10140 sv = (SV*)POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10142 sv = (SV*)POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10144 hv = (HV*)POPPTR(ss,ix);
10145 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10148 ptr = POPPTR(ss,ix);
10149 TOPPTR(nss,ix) = ptr;
10153 TOPINT(nss,ix) = i;
10155 case SAVEt_COMPPAD:
10156 av = (AV*)POPPTR(ss,ix);
10157 TOPPTR(nss,ix) = av_dup(av, param);
10160 longval = (long)POPLONG(ss,ix);
10161 TOPLONG(nss,ix) = longval;
10162 ptr = POPPTR(ss,ix);
10163 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10164 sv = (SV*)POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = sv_dup(sv, param);
10168 ptr = POPPTR(ss,ix);
10169 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10170 longval = (long)POPBOOL(ss,ix);
10171 TOPBOOL(nss,ix) = (bool)longval;
10173 case SAVEt_SET_SVFLAGS:
10175 TOPINT(nss,ix) = i;
10177 TOPINT(nss,ix) = i;
10178 sv = (SV*)POPPTR(ss,ix);
10179 TOPPTR(nss,ix) = sv_dup(sv, param);
10182 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10190 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10191 * flag to the result. This is done for each stash before cloning starts,
10192 * so we know which stashes want their objects cloned */
10195 do_mark_cloneable_stash(pTHX_ SV *sv)
10197 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10199 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10200 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10201 if (cloner && GvCV(cloner)) {
10208 XPUSHs(sv_2mortal(newSVhek(hvname)));
10210 call_sv((SV*)GvCV(cloner), G_SCALAR);
10217 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10225 =for apidoc perl_clone
10227 Create and return a new interpreter by cloning the current one.
10229 perl_clone takes these flags as parameters:
10231 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10232 without it we only clone the data and zero the stacks,
10233 with it we copy the stacks and the new perl interpreter is
10234 ready to run at the exact same point as the previous one.
10235 The pseudo-fork code uses COPY_STACKS while the
10236 threads->new doesn't.
10238 CLONEf_KEEP_PTR_TABLE
10239 perl_clone keeps a ptr_table with the pointer of the old
10240 variable as a key and the new variable as a value,
10241 this allows it to check if something has been cloned and not
10242 clone it again but rather just use the value and increase the
10243 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10244 the ptr_table using the function
10245 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10246 reason to keep it around is if you want to dup some of your own
10247 variable who are outside the graph perl scans, example of this
10248 code is in threads.xs create
10251 This is a win32 thing, it is ignored on unix, it tells perls
10252 win32host code (which is c++) to clone itself, this is needed on
10253 win32 if you want to run two threads at the same time,
10254 if you just want to do some stuff in a separate perl interpreter
10255 and then throw it away and return to the original one,
10256 you don't need to do anything.
10261 /* XXX the above needs expanding by someone who actually understands it ! */
10262 EXTERN_C PerlInterpreter *
10263 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10266 perl_clone(PerlInterpreter *proto_perl, UV flags)
10269 #ifdef PERL_IMPLICIT_SYS
10271 /* perlhost.h so we need to call into it
10272 to clone the host, CPerlHost should have a c interface, sky */
10274 if (flags & CLONEf_CLONE_HOST) {
10275 return perl_clone_host(proto_perl,flags);
10277 return perl_clone_using(proto_perl, flags,
10279 proto_perl->IMemShared,
10280 proto_perl->IMemParse,
10282 proto_perl->IStdIO,
10286 proto_perl->IProc);
10290 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10291 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10292 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10293 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10294 struct IPerlDir* ipD, struct IPerlSock* ipS,
10295 struct IPerlProc* ipP)
10297 /* XXX many of the string copies here can be optimized if they're
10298 * constants; they need to be allocated as common memory and just
10299 * their pointers copied. */
10302 CLONE_PARAMS clone_params;
10303 CLONE_PARAMS* param = &clone_params;
10305 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10306 /* for each stash, determine whether its objects should be cloned */
10307 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10308 PERL_SET_THX(my_perl);
10311 Poison(my_perl, 1, PerlInterpreter);
10313 PL_curcop = (COP *)Nullop;
10317 PL_savestack_ix = 0;
10318 PL_savestack_max = -1;
10319 PL_sig_pending = 0;
10320 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10321 # else /* !DEBUGGING */
10322 Zero(my_perl, 1, PerlInterpreter);
10323 # endif /* DEBUGGING */
10325 /* host pointers */
10327 PL_MemShared = ipMS;
10328 PL_MemParse = ipMP;
10335 #else /* !PERL_IMPLICIT_SYS */
10337 CLONE_PARAMS clone_params;
10338 CLONE_PARAMS* param = &clone_params;
10339 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10340 /* for each stash, determine whether its objects should be cloned */
10341 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10342 PERL_SET_THX(my_perl);
10345 Poison(my_perl, 1, PerlInterpreter);
10347 PL_curcop = (COP *)Nullop;
10351 PL_savestack_ix = 0;
10352 PL_savestack_max = -1;
10353 PL_sig_pending = 0;
10354 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10355 # else /* !DEBUGGING */
10356 Zero(my_perl, 1, PerlInterpreter);
10357 # endif /* DEBUGGING */
10358 #endif /* PERL_IMPLICIT_SYS */
10359 param->flags = flags;
10360 param->proto_perl = proto_perl;
10362 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10363 Zero(&PL_body_roots, 1, PL_body_roots);
10365 PL_nice_chunk = NULL;
10366 PL_nice_chunk_size = 0;
10368 PL_sv_objcount = 0;
10369 PL_sv_root = Nullsv;
10370 PL_sv_arenaroot = Nullsv;
10372 PL_debug = proto_perl->Idebug;
10374 PL_hash_seed = proto_perl->Ihash_seed;
10375 PL_rehash_seed = proto_perl->Irehash_seed;
10377 #ifdef USE_REENTRANT_API
10378 /* XXX: things like -Dm will segfault here in perlio, but doing
10379 * PERL_SET_CONTEXT(proto_perl);
10380 * breaks too many other things
10382 Perl_reentrant_init(aTHX);
10385 /* create SV map for pointer relocation */
10386 PL_ptr_table = ptr_table_new();
10388 /* initialize these special pointers as early as possible */
10389 SvANY(&PL_sv_undef) = NULL;
10390 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10391 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10392 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10394 SvANY(&PL_sv_no) = new_XPVNV();
10395 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10396 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10397 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10398 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10399 SvCUR_set(&PL_sv_no, 0);
10400 SvLEN_set(&PL_sv_no, 1);
10401 SvIV_set(&PL_sv_no, 0);
10402 SvNV_set(&PL_sv_no, 0);
10403 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10405 SvANY(&PL_sv_yes) = new_XPVNV();
10406 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10407 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10408 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10409 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10410 SvCUR_set(&PL_sv_yes, 1);
10411 SvLEN_set(&PL_sv_yes, 2);
10412 SvIV_set(&PL_sv_yes, 1);
10413 SvNV_set(&PL_sv_yes, 1);
10414 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10416 /* create (a non-shared!) shared string table */
10417 PL_strtab = newHV();
10418 HvSHAREKEYS_off(PL_strtab);
10419 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10420 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10422 PL_compiling = proto_perl->Icompiling;
10424 /* These two PVs will be free'd special way so must set them same way op.c does */
10425 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10426 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10428 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10429 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10431 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10432 if (!specialWARN(PL_compiling.cop_warnings))
10433 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10434 if (!specialCopIO(PL_compiling.cop_io))
10435 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10436 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10438 /* pseudo environmental stuff */
10439 PL_origargc = proto_perl->Iorigargc;
10440 PL_origargv = proto_perl->Iorigargv;
10442 param->stashes = newAV(); /* Setup array of objects to call clone on */
10444 /* Set tainting stuff before PerlIO_debug can possibly get called */
10445 PL_tainting = proto_perl->Itainting;
10446 PL_taint_warn = proto_perl->Itaint_warn;
10448 #ifdef PERLIO_LAYERS
10449 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10450 PerlIO_clone(aTHX_ proto_perl, param);
10453 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10454 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10455 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10456 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10457 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10458 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10461 PL_minus_c = proto_perl->Iminus_c;
10462 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10463 PL_localpatches = proto_perl->Ilocalpatches;
10464 PL_splitstr = proto_perl->Isplitstr;
10465 PL_preprocess = proto_perl->Ipreprocess;
10466 PL_minus_n = proto_perl->Iminus_n;
10467 PL_minus_p = proto_perl->Iminus_p;
10468 PL_minus_l = proto_perl->Iminus_l;
10469 PL_minus_a = proto_perl->Iminus_a;
10470 PL_minus_F = proto_perl->Iminus_F;
10471 PL_doswitches = proto_perl->Idoswitches;
10472 PL_dowarn = proto_perl->Idowarn;
10473 PL_doextract = proto_perl->Idoextract;
10474 PL_sawampersand = proto_perl->Isawampersand;
10475 PL_unsafe = proto_perl->Iunsafe;
10476 PL_inplace = SAVEPV(proto_perl->Iinplace);
10477 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10478 PL_perldb = proto_perl->Iperldb;
10479 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10480 PL_exit_flags = proto_perl->Iexit_flags;
10482 /* magical thingies */
10483 /* XXX time(&PL_basetime) when asked for? */
10484 PL_basetime = proto_perl->Ibasetime;
10485 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10487 PL_maxsysfd = proto_perl->Imaxsysfd;
10488 PL_multiline = proto_perl->Imultiline;
10489 PL_statusvalue = proto_perl->Istatusvalue;
10491 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10493 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10495 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10497 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10498 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10499 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10501 /* Clone the regex array */
10502 PL_regex_padav = newAV();
10504 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10505 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10507 av_push(PL_regex_padav,
10508 sv_dup_inc(regexen[0],param));
10509 for(i = 1; i <= len; i++) {
10510 if(SvREPADTMP(regexen[i])) {
10511 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10513 av_push(PL_regex_padav,
10515 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10516 SvIVX(regexen[i])), param)))
10521 PL_regex_pad = AvARRAY(PL_regex_padav);
10523 /* shortcuts to various I/O objects */
10524 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10525 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10526 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10527 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10528 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10529 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10531 /* shortcuts to regexp stuff */
10532 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10534 /* shortcuts to misc objects */
10535 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10537 /* shortcuts to debugging objects */
10538 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10539 PL_DBline = gv_dup(proto_perl->IDBline, param);
10540 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10541 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10542 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10543 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10544 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10545 PL_lineary = av_dup(proto_perl->Ilineary, param);
10546 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10548 /* symbol tables */
10549 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10550 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10551 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10552 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10553 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10555 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10556 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10557 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10558 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10559 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10560 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10562 PL_sub_generation = proto_perl->Isub_generation;
10564 /* funky return mechanisms */
10565 PL_forkprocess = proto_perl->Iforkprocess;
10567 /* subprocess state */
10568 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10570 /* internal state */
10571 PL_maxo = proto_perl->Imaxo;
10572 if (proto_perl->Iop_mask)
10573 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10575 PL_op_mask = Nullch;
10576 /* PL_asserting = proto_perl->Iasserting; */
10578 /* current interpreter roots */
10579 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10580 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10581 PL_main_start = proto_perl->Imain_start;
10582 PL_eval_root = proto_perl->Ieval_root;
10583 PL_eval_start = proto_perl->Ieval_start;
10585 /* runtime control stuff */
10586 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10587 PL_copline = proto_perl->Icopline;
10589 PL_filemode = proto_perl->Ifilemode;
10590 PL_lastfd = proto_perl->Ilastfd;
10591 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10594 PL_gensym = proto_perl->Igensym;
10595 PL_preambled = proto_perl->Ipreambled;
10596 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10597 PL_laststatval = proto_perl->Ilaststatval;
10598 PL_laststype = proto_perl->Ilaststype;
10599 PL_mess_sv = Nullsv;
10601 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10603 /* interpreter atexit processing */
10604 PL_exitlistlen = proto_perl->Iexitlistlen;
10605 if (PL_exitlistlen) {
10606 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10607 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10610 PL_exitlist = (PerlExitListEntry*)NULL;
10611 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10612 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10613 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10615 PL_profiledata = NULL;
10616 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10617 /* PL_rsfp_filters entries have fake IoDIRP() */
10618 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10620 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10622 PAD_CLONE_VARS(proto_perl, param);
10624 #ifdef HAVE_INTERP_INTERN
10625 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10628 /* more statics moved here */
10629 PL_generation = proto_perl->Igeneration;
10630 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10632 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10633 PL_in_clean_all = proto_perl->Iin_clean_all;
10635 PL_uid = proto_perl->Iuid;
10636 PL_euid = proto_perl->Ieuid;
10637 PL_gid = proto_perl->Igid;
10638 PL_egid = proto_perl->Iegid;
10639 PL_nomemok = proto_perl->Inomemok;
10640 PL_an = proto_perl->Ian;
10641 PL_evalseq = proto_perl->Ievalseq;
10642 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10643 PL_origalen = proto_perl->Iorigalen;
10644 #ifdef PERL_USES_PL_PIDSTATUS
10645 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10647 PL_osname = SAVEPV(proto_perl->Iosname);
10648 PL_sighandlerp = proto_perl->Isighandlerp;
10650 PL_runops = proto_perl->Irunops;
10652 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10655 PL_cshlen = proto_perl->Icshlen;
10656 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10659 PL_lex_state = proto_perl->Ilex_state;
10660 PL_lex_defer = proto_perl->Ilex_defer;
10661 PL_lex_expect = proto_perl->Ilex_expect;
10662 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10663 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10664 PL_lex_starts = proto_perl->Ilex_starts;
10665 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10666 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10667 PL_lex_op = proto_perl->Ilex_op;
10668 PL_lex_inpat = proto_perl->Ilex_inpat;
10669 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10670 PL_lex_brackets = proto_perl->Ilex_brackets;
10671 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10672 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10673 PL_lex_casemods = proto_perl->Ilex_casemods;
10674 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10675 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10677 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10678 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10679 PL_nexttoke = proto_perl->Inexttoke;
10681 /* XXX This is probably masking the deeper issue of why
10682 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10683 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10684 * (A little debugging with a watchpoint on it may help.)
10686 if (SvANY(proto_perl->Ilinestr)) {
10687 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10688 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10689 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10690 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10691 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10692 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10693 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10694 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10695 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10698 PL_linestr = NEWSV(65,79);
10699 sv_upgrade(PL_linestr,SVt_PVIV);
10700 sv_setpvn(PL_linestr,"",0);
10701 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10703 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10704 PL_pending_ident = proto_perl->Ipending_ident;
10705 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10707 PL_expect = proto_perl->Iexpect;
10709 PL_multi_start = proto_perl->Imulti_start;
10710 PL_multi_end = proto_perl->Imulti_end;
10711 PL_multi_open = proto_perl->Imulti_open;
10712 PL_multi_close = proto_perl->Imulti_close;
10714 PL_error_count = proto_perl->Ierror_count;
10715 PL_subline = proto_perl->Isubline;
10716 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10718 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10719 if (SvANY(proto_perl->Ilinestr)) {
10720 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10721 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10722 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10723 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10724 PL_last_lop_op = proto_perl->Ilast_lop_op;
10727 PL_last_uni = SvPVX(PL_linestr);
10728 PL_last_lop = SvPVX(PL_linestr);
10729 PL_last_lop_op = 0;
10731 PL_in_my = proto_perl->Iin_my;
10732 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10734 PL_cryptseen = proto_perl->Icryptseen;
10737 PL_hints = proto_perl->Ihints;
10739 PL_amagic_generation = proto_perl->Iamagic_generation;
10741 #ifdef USE_LOCALE_COLLATE
10742 PL_collation_ix = proto_perl->Icollation_ix;
10743 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10744 PL_collation_standard = proto_perl->Icollation_standard;
10745 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10746 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10747 #endif /* USE_LOCALE_COLLATE */
10749 #ifdef USE_LOCALE_NUMERIC
10750 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10751 PL_numeric_standard = proto_perl->Inumeric_standard;
10752 PL_numeric_local = proto_perl->Inumeric_local;
10753 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10754 #endif /* !USE_LOCALE_NUMERIC */
10756 /* utf8 character classes */
10757 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10758 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10759 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10760 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10761 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10762 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10763 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10764 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10765 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10766 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10767 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10768 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10769 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10770 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10771 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10772 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10773 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10774 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10775 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10776 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10778 /* Did the locale setup indicate UTF-8? */
10779 PL_utf8locale = proto_perl->Iutf8locale;
10780 /* Unicode features (see perlrun/-C) */
10781 PL_unicode = proto_perl->Iunicode;
10783 /* Pre-5.8 signals control */
10784 PL_signals = proto_perl->Isignals;
10786 /* times() ticks per second */
10787 PL_clocktick = proto_perl->Iclocktick;
10789 /* Recursion stopper for PerlIO_find_layer */
10790 PL_in_load_module = proto_perl->Iin_load_module;
10792 /* sort() routine */
10793 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10795 /* Not really needed/useful since the reenrant_retint is "volatile",
10796 * but do it for consistency's sake. */
10797 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10799 /* Hooks to shared SVs and locks. */
10800 PL_sharehook = proto_perl->Isharehook;
10801 PL_lockhook = proto_perl->Ilockhook;
10802 PL_unlockhook = proto_perl->Iunlockhook;
10803 PL_threadhook = proto_perl->Ithreadhook;
10805 PL_runops_std = proto_perl->Irunops_std;
10806 PL_runops_dbg = proto_perl->Irunops_dbg;
10808 #ifdef THREADS_HAVE_PIDS
10809 PL_ppid = proto_perl->Ippid;
10813 PL_last_swash_hv = Nullhv; /* reinits on demand */
10814 PL_last_swash_klen = 0;
10815 PL_last_swash_key[0]= '\0';
10816 PL_last_swash_tmps = (U8*)NULL;
10817 PL_last_swash_slen = 0;
10819 PL_glob_index = proto_perl->Iglob_index;
10820 PL_srand_called = proto_perl->Isrand_called;
10821 PL_uudmap['M'] = 0; /* reinits on demand */
10822 PL_bitcount = Nullch; /* reinits on demand */
10824 if (proto_perl->Ipsig_pend) {
10825 Newxz(PL_psig_pend, SIG_SIZE, int);
10828 PL_psig_pend = (int*)NULL;
10831 if (proto_perl->Ipsig_ptr) {
10832 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10833 Newxz(PL_psig_name, SIG_SIZE, SV*);
10834 for (i = 1; i < SIG_SIZE; i++) {
10835 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10836 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10840 PL_psig_ptr = (SV**)NULL;
10841 PL_psig_name = (SV**)NULL;
10844 /* thrdvar.h stuff */
10846 if (flags & CLONEf_COPY_STACKS) {
10847 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10848 PL_tmps_ix = proto_perl->Ttmps_ix;
10849 PL_tmps_max = proto_perl->Ttmps_max;
10850 PL_tmps_floor = proto_perl->Ttmps_floor;
10851 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10853 while (i <= PL_tmps_ix) {
10854 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10858 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10859 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10860 Newxz(PL_markstack, i, I32);
10861 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10862 - proto_perl->Tmarkstack);
10863 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10864 - proto_perl->Tmarkstack);
10865 Copy(proto_perl->Tmarkstack, PL_markstack,
10866 PL_markstack_ptr - PL_markstack + 1, I32);
10868 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10869 * NOTE: unlike the others! */
10870 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10871 PL_scopestack_max = proto_perl->Tscopestack_max;
10872 Newxz(PL_scopestack, PL_scopestack_max, I32);
10873 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10875 /* NOTE: si_dup() looks at PL_markstack */
10876 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10878 /* PL_curstack = PL_curstackinfo->si_stack; */
10879 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10880 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10882 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10883 PL_stack_base = AvARRAY(PL_curstack);
10884 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10885 - proto_perl->Tstack_base);
10886 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10888 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10889 * NOTE: unlike the others! */
10890 PL_savestack_ix = proto_perl->Tsavestack_ix;
10891 PL_savestack_max = proto_perl->Tsavestack_max;
10892 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10893 PL_savestack = ss_dup(proto_perl, param);
10897 ENTER; /* perl_destruct() wants to LEAVE; */
10900 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10901 PL_top_env = &PL_start_env;
10903 PL_op = proto_perl->Top;
10906 PL_Xpv = (XPV*)NULL;
10907 PL_na = proto_perl->Tna;
10909 PL_statbuf = proto_perl->Tstatbuf;
10910 PL_statcache = proto_perl->Tstatcache;
10911 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10912 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10914 PL_timesbuf = proto_perl->Ttimesbuf;
10917 PL_tainted = proto_perl->Ttainted;
10918 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10919 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10920 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10921 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10922 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10923 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10924 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10925 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10926 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10928 PL_restartop = proto_perl->Trestartop;
10929 PL_in_eval = proto_perl->Tin_eval;
10930 PL_delaymagic = proto_perl->Tdelaymagic;
10931 PL_dirty = proto_perl->Tdirty;
10932 PL_localizing = proto_perl->Tlocalizing;
10934 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10935 PL_hv_fetch_ent_mh = Nullhe;
10936 PL_modcount = proto_perl->Tmodcount;
10937 PL_lastgotoprobe = Nullop;
10938 PL_dumpindent = proto_perl->Tdumpindent;
10940 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10941 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10942 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10943 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10944 PL_efloatbuf = Nullch; /* reinits on demand */
10945 PL_efloatsize = 0; /* reinits on demand */
10949 PL_screamfirst = NULL;
10950 PL_screamnext = NULL;
10951 PL_maxscream = -1; /* reinits on demand */
10952 PL_lastscream = Nullsv;
10954 PL_watchaddr = NULL;
10955 PL_watchok = Nullch;
10957 PL_regdummy = proto_perl->Tregdummy;
10958 PL_regprecomp = Nullch;
10961 PL_colorset = 0; /* reinits PL_colors[] */
10962 /*PL_colors[6] = {0,0,0,0,0,0};*/
10963 PL_reginput = Nullch;
10964 PL_regbol = Nullch;
10965 PL_regeol = Nullch;
10966 PL_regstartp = (I32*)NULL;
10967 PL_regendp = (I32*)NULL;
10968 PL_reglastparen = (U32*)NULL;
10969 PL_reglastcloseparen = (U32*)NULL;
10970 PL_regtill = Nullch;
10971 PL_reg_start_tmp = (char**)NULL;
10972 PL_reg_start_tmpl = 0;
10973 PL_regdata = (struct reg_data*)NULL;
10976 PL_reg_eval_set = 0;
10978 PL_regprogram = (regnode*)NULL;
10980 PL_regcc = (CURCUR*)NULL;
10981 PL_reg_call_cc = (struct re_cc_state*)NULL;
10982 PL_reg_re = (regexp*)NULL;
10983 PL_reg_ganch = Nullch;
10984 PL_reg_sv = Nullsv;
10985 PL_reg_match_utf8 = FALSE;
10986 PL_reg_magic = (MAGIC*)NULL;
10988 PL_reg_oldcurpm = (PMOP*)NULL;
10989 PL_reg_curpm = (PMOP*)NULL;
10990 PL_reg_oldsaved = Nullch;
10991 PL_reg_oldsavedlen = 0;
10992 #ifdef PERL_OLD_COPY_ON_WRITE
10995 PL_reg_maxiter = 0;
10996 PL_reg_leftiter = 0;
10997 PL_reg_poscache = Nullch;
10998 PL_reg_poscache_size= 0;
11000 /* RE engine - function pointers */
11001 PL_regcompp = proto_perl->Tregcompp;
11002 PL_regexecp = proto_perl->Tregexecp;
11003 PL_regint_start = proto_perl->Tregint_start;
11004 PL_regint_string = proto_perl->Tregint_string;
11005 PL_regfree = proto_perl->Tregfree;
11007 PL_reginterp_cnt = 0;
11008 PL_reg_starttry = 0;
11010 /* Pluggable optimizer */
11011 PL_peepp = proto_perl->Tpeepp;
11013 PL_stashcache = newHV();
11015 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11016 ptr_table_free(PL_ptr_table);
11017 PL_ptr_table = NULL;
11020 /* Call the ->CLONE method, if it exists, for each of the stashes
11021 identified by sv_dup() above.
11023 while(av_len(param->stashes) != -1) {
11024 HV* const stash = (HV*) av_shift(param->stashes);
11025 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11026 if (cloner && GvCV(cloner)) {
11031 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11033 call_sv((SV*)GvCV(cloner), G_DISCARD);
11039 SvREFCNT_dec(param->stashes);
11041 /* orphaned? eg threads->new inside BEGIN or use */
11042 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11043 (void)SvREFCNT_inc(PL_compcv);
11044 SAVEFREESV(PL_compcv);
11050 #endif /* USE_ITHREADS */
11053 =head1 Unicode Support
11055 =for apidoc sv_recode_to_utf8
11057 The encoding is assumed to be an Encode object, on entry the PV
11058 of the sv is assumed to be octets in that encoding, and the sv
11059 will be converted into Unicode (and UTF-8).
11061 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11062 is not a reference, nothing is done to the sv. If the encoding is not
11063 an C<Encode::XS> Encoding object, bad things will happen.
11064 (See F<lib/encoding.pm> and L<Encode>).
11066 The PV of the sv is returned.
11071 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11074 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11088 Passing sv_yes is wrong - it needs to be or'ed set of constants
11089 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11090 remove converted chars from source.
11092 Both will default the value - let them.
11094 XPUSHs(&PL_sv_yes);
11097 call_method("decode", G_SCALAR);
11101 s = SvPV_const(uni, len);
11102 if (s != SvPVX_const(sv)) {
11103 SvGROW(sv, len + 1);
11104 Move(s, SvPVX(sv), len + 1, char);
11105 SvCUR_set(sv, len);
11112 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11116 =for apidoc sv_cat_decode
11118 The encoding is assumed to be an Encode object, the PV of the ssv is
11119 assumed to be octets in that encoding and decoding the input starts
11120 from the position which (PV + *offset) pointed to. The dsv will be
11121 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11122 when the string tstr appears in decoding output or the input ends on
11123 the PV of the ssv. The value which the offset points will be modified
11124 to the last input position on the ssv.
11126 Returns TRUE if the terminator was found, else returns FALSE.
11131 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11132 SV *ssv, int *offset, char *tstr, int tlen)
11136 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11147 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11148 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11150 call_method("cat_decode", G_SCALAR);
11152 ret = SvTRUE(TOPs);
11153 *offset = SvIV(offsv);
11159 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11164 /* ---------------------------------------------------------------------
11166 * support functions for report_uninit()
11169 /* the maxiumum size of array or hash where we will scan looking
11170 * for the undefined element that triggered the warning */
11172 #define FUV_MAX_SEARCH_SIZE 1000
11174 /* Look for an entry in the hash whose value has the same SV as val;
11175 * If so, return a mortal copy of the key. */
11178 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11181 register HE **array;
11184 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11185 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11188 array = HvARRAY(hv);
11190 for (i=HvMAX(hv); i>0; i--) {
11191 register HE *entry;
11192 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11193 if (HeVAL(entry) != val)
11195 if ( HeVAL(entry) == &PL_sv_undef ||
11196 HeVAL(entry) == &PL_sv_placeholder)
11200 if (HeKLEN(entry) == HEf_SVKEY)
11201 return sv_mortalcopy(HeKEY_sv(entry));
11202 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11208 /* Look for an entry in the array whose value has the same SV as val;
11209 * If so, return the index, otherwise return -1. */
11212 S_find_array_subscript(pTHX_ AV *av, SV* val)
11216 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11217 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11221 for (i=AvFILLp(av); i>=0; i--) {
11222 if (svp[i] == val && svp[i] != &PL_sv_undef)
11228 /* S_varname(): return the name of a variable, optionally with a subscript.
11229 * If gv is non-zero, use the name of that global, along with gvtype (one
11230 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11231 * targ. Depending on the value of the subscript_type flag, return:
11234 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11235 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11236 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11237 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11240 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11241 SV* keyname, I32 aindex, int subscript_type)
11244 SV * const name = sv_newmortal();
11247 buffer[0] = gvtype;
11250 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11252 gv_fullname4(name, gv, buffer, 0);
11254 if ((unsigned int)SvPVX(name)[1] <= 26) {
11256 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11258 /* Swap the 1 unprintable control character for the 2 byte pretty
11259 version - ie substr($name, 1, 1) = $buffer; */
11260 sv_insert(name, 1, 1, buffer, 2);
11265 CV * const cv = find_runcv(&unused);
11269 if (!cv || !CvPADLIST(cv))
11271 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11272 sv = *av_fetch(av, targ, FALSE);
11273 /* SvLEN in a pad name is not to be trusted */
11274 sv_setpv(name, SvPV_nolen_const(sv));
11277 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11278 SV * const sv = NEWSV(0,0);
11279 *SvPVX(name) = '$';
11280 Perl_sv_catpvf(aTHX_ name, "{%s}",
11281 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11284 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11285 *SvPVX(name) = '$';
11286 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11288 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11289 sv_insert(name, 0, 0, "within ", 7);
11296 =for apidoc find_uninit_var
11298 Find the name of the undefined variable (if any) that caused the operator o
11299 to issue a "Use of uninitialized value" warning.
11300 If match is true, only return a name if it's value matches uninit_sv.
11301 So roughly speaking, if a unary operator (such as OP_COS) generates a
11302 warning, then following the direct child of the op may yield an
11303 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11304 other hand, with OP_ADD there are two branches to follow, so we only print
11305 the variable name if we get an exact match.
11307 The name is returned as a mortal SV.
11309 Assumes that PL_op is the op that originally triggered the error, and that
11310 PL_comppad/PL_curpad points to the currently executing pad.
11316 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11324 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11325 uninit_sv == &PL_sv_placeholder)))
11328 switch (obase->op_type) {
11335 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11336 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11338 SV *keysv = Nullsv;
11339 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11341 if (pad) { /* @lex, %lex */
11342 sv = PAD_SVl(obase->op_targ);
11346 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11347 /* @global, %global */
11348 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11351 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11353 else /* @{expr}, %{expr} */
11354 return find_uninit_var(cUNOPx(obase)->op_first,
11358 /* attempt to find a match within the aggregate */
11360 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11362 subscript_type = FUV_SUBSCRIPT_HASH;
11365 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11367 subscript_type = FUV_SUBSCRIPT_ARRAY;
11370 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11373 return varname(gv, hash ? '%' : '@', obase->op_targ,
11374 keysv, index, subscript_type);
11378 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11380 return varname(Nullgv, '$', obase->op_targ,
11381 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11384 gv = cGVOPx_gv(obase);
11385 if (!gv || (match && GvSV(gv) != uninit_sv))
11387 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11390 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11393 av = (AV*)PAD_SV(obase->op_targ);
11394 if (!av || SvRMAGICAL(av))
11396 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11397 if (!svp || *svp != uninit_sv)
11400 return varname(Nullgv, '$', obase->op_targ,
11401 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11404 gv = cGVOPx_gv(obase);
11410 if (!av || SvRMAGICAL(av))
11412 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11413 if (!svp || *svp != uninit_sv)
11416 return varname(gv, '$', 0,
11417 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11422 o = cUNOPx(obase)->op_first;
11423 if (!o || o->op_type != OP_NULL ||
11424 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11426 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11430 if (PL_op == obase)
11431 /* $a[uninit_expr] or $h{uninit_expr} */
11432 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11435 o = cBINOPx(obase)->op_first;
11436 kid = cBINOPx(obase)->op_last;
11438 /* get the av or hv, and optionally the gv */
11440 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11441 sv = PAD_SV(o->op_targ);
11443 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11444 && cUNOPo->op_first->op_type == OP_GV)
11446 gv = cGVOPx_gv(cUNOPo->op_first);
11449 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11454 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11455 /* index is constant */
11459 if (obase->op_type == OP_HELEM) {
11460 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11461 if (!he || HeVAL(he) != uninit_sv)
11465 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11466 if (!svp || *svp != uninit_sv)
11470 if (obase->op_type == OP_HELEM)
11471 return varname(gv, '%', o->op_targ,
11472 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11474 return varname(gv, '@', o->op_targ, Nullsv,
11475 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11479 /* index is an expression;
11480 * attempt to find a match within the aggregate */
11481 if (obase->op_type == OP_HELEM) {
11482 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11484 return varname(gv, '%', o->op_targ,
11485 keysv, 0, FUV_SUBSCRIPT_HASH);
11488 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11490 return varname(gv, '@', o->op_targ,
11491 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11496 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11498 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11504 /* only examine RHS */
11505 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11508 o = cUNOPx(obase)->op_first;
11509 if (o->op_type == OP_PUSHMARK)
11512 if (!o->op_sibling) {
11513 /* one-arg version of open is highly magical */
11515 if (o->op_type == OP_GV) { /* open FOO; */
11517 if (match && GvSV(gv) != uninit_sv)
11519 return varname(gv, '$', 0,
11520 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11522 /* other possibilities not handled are:
11523 * open $x; or open my $x; should return '${*$x}'
11524 * open expr; should return '$'.expr ideally
11530 /* ops where $_ may be an implicit arg */
11534 if ( !(obase->op_flags & OPf_STACKED)) {
11535 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11536 ? PAD_SVl(obase->op_targ)
11539 sv = sv_newmortal();
11540 sv_setpvn(sv, "$_", 2);
11548 /* skip filehandle as it can't produce 'undef' warning */
11549 o = cUNOPx(obase)->op_first;
11550 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11551 o = o->op_sibling->op_sibling;
11558 match = 1; /* XS or custom code could trigger random warnings */
11563 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11564 return sv_2mortal(newSVpvn("${$/}", 5));
11569 if (!(obase->op_flags & OPf_KIDS))
11571 o = cUNOPx(obase)->op_first;
11577 /* if all except one arg are constant, or have no side-effects,
11578 * or are optimized away, then it's unambiguous */
11580 for (kid=o; kid; kid = kid->op_sibling) {
11582 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11583 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11584 || (kid->op_type == OP_PUSHMARK)
11588 if (o2) { /* more than one found */
11595 return find_uninit_var(o2, uninit_sv, match);
11597 /* scan all args */
11599 sv = find_uninit_var(o, uninit_sv, 1);
11611 =for apidoc report_uninit
11613 Print appropriate "Use of uninitialized variable" warning
11619 Perl_report_uninit(pTHX_ SV* uninit_sv)
11622 SV* varname = Nullsv;
11624 varname = find_uninit_var(PL_op, uninit_sv,0);
11626 sv_insert(varname, 0, 0, " ", 1);
11628 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11629 varname ? SvPV_nolen_const(varname) : "",
11630 " in ", OP_DESC(PL_op));
11633 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11639 * c-indentation-style: bsd
11640 * c-basic-offset: 4
11641 * indent-tabs-mode: t
11644 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob