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)
2518 if (SvGMAGICAL(sv)) {
2519 if (flags & SV_GMAGIC)
2524 if (flags & SV_MUTABLE_RETURN)
2525 return SvPVX_mutable(sv);
2526 if (flags & SV_CONST_RETURN)
2527 return (char *)SvPVX_const(sv);
2530 if (SvIOKp(sv) || SvNOKp(sv)) {
2531 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2532 char *tmpbuf = tbuf;
2536 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2537 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2539 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2540 len = strlen(tmpbuf);
2542 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2543 /* Sneaky stuff here */
2544 SV *tsv = newSVpvn(tmpbuf, len);
2554 #ifdef FIXNEGATIVEZERO
2555 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2561 SvUPGRADE(sv, SVt_PV);
2564 s = SvGROW_mutable(sv, len + 1);
2567 return memcpy(s, tmpbuf, len + 1);
2571 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2572 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2580 if (SvTHINKFIRST(sv)) {
2584 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2585 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2587 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2590 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2591 if (flags & SV_CONST_RETURN) {
2592 pv = (char *) SvPVX_const(tmpstr);
2594 pv = (flags & SV_MUTABLE_RETURN)
2595 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2598 *lp = SvCUR(tmpstr);
2600 pv = sv_2pv_flags(tmpstr, lp, flags);
2610 const SV *const referent = (SV*)SvRV(sv);
2613 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2614 } else if (SvTYPE(referent) == SVt_PVMG
2615 && ((SvFLAGS(referent) &
2616 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2617 == (SVs_OBJECT|SVs_SMG))
2618 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2619 const regexp *re = (regexp *)mg->mg_obj;
2622 const char *fptr = "msix";
2627 char need_newline = 0;
2629 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2631 while((ch = *fptr++)) {
2633 reflags[left++] = ch;
2636 reflags[right--] = ch;
2641 reflags[left] = '-';
2645 mg->mg_len = re->prelen + 4 + left;
2647 * If /x was used, we have to worry about a regex
2648 * ending with a comment later being embedded
2649 * within another regex. If so, we don't want this
2650 * regex's "commentization" to leak out to the
2651 * right part of the enclosing regex, we must cap
2652 * it with a newline.
2654 * So, if /x was used, we scan backwards from the
2655 * end of the regex. If we find a '#' before we
2656 * find a newline, we need to add a newline
2657 * ourself. If we find a '\n' first (or if we
2658 * don't find '#' or '\n'), we don't need to add
2659 * anything. -jfriedl
2661 if (PMf_EXTENDED & re->reganch) {
2662 const char *endptr = re->precomp + re->prelen;
2663 while (endptr >= re->precomp) {
2664 const char c = *(endptr--);
2666 break; /* don't need another */
2668 /* we end while in a comment, so we
2670 mg->mg_len++; /* save space for it */
2671 need_newline = 1; /* note to add it */
2677 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2678 Copy("(?", mg->mg_ptr, 2, char);
2679 Copy(reflags, mg->mg_ptr+2, left, char);
2680 Copy(":", mg->mg_ptr+left+2, 1, char);
2681 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2683 mg->mg_ptr[mg->mg_len - 2] = '\n';
2684 mg->mg_ptr[mg->mg_len - 1] = ')';
2685 mg->mg_ptr[mg->mg_len] = 0;
2687 PL_reginterp_cnt += re->program[0].next_off;
2689 if (re->reganch & ROPT_UTF8)
2697 const char *const typestr = sv_reftype(referent, 0);
2699 tsv = sv_newmortal();
2700 if (SvOBJECT(referent)) {
2701 const char *const name = HvNAME_get(SvSTASH(referent));
2702 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2703 name ? name : "__ANON__" , typestr,
2707 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2715 if (SvREADONLY(sv) && !SvOK(sv)) {
2716 if (ckWARN(WARN_UNINITIALIZED))
2723 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2724 /* I'm assuming that if both IV and NV are equally valid then
2725 converting the IV is going to be more efficient */
2726 const U32 isIOK = SvIOK(sv);
2727 const U32 isUIOK = SvIsUV(sv);
2728 char buf[TYPE_CHARS(UV)];
2731 if (SvTYPE(sv) < SVt_PVIV)
2732 sv_upgrade(sv, SVt_PVIV);
2734 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2736 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2737 /* inlined from sv_setpvn */
2738 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2739 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2740 SvCUR_set(sv, ebuf - ptr);
2750 else if (SvNOKp(sv)) {
2751 if (SvTYPE(sv) < SVt_PVNV)
2752 sv_upgrade(sv, SVt_PVNV);
2753 /* The +20 is pure guesswork. Configure test needed. --jhi */
2754 s = SvGROW_mutable(sv, NV_DIG + 20);
2755 olderrno = errno; /* some Xenix systems wipe out errno here */
2757 if (SvNVX(sv) == 0.0)
2758 (void)strcpy(s,"0");
2762 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2765 #ifdef FIXNEGATIVEZERO
2766 if (*s == '-' && s[1] == '0' && !s[2])
2776 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2780 if (SvTYPE(sv) < SVt_PV)
2781 /* Typically the caller expects that sv_any is not NULL now. */
2782 sv_upgrade(sv, SVt_PV);
2786 const STRLEN len = s - SvPVX_const(sv);
2792 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2793 PTR2UV(sv),SvPVX_const(sv)));
2794 if (flags & SV_CONST_RETURN)
2795 return (char *)SvPVX_const(sv);
2796 if (flags & SV_MUTABLE_RETURN)
2797 return SvPVX_mutable(sv);
2802 =for apidoc sv_copypv
2804 Copies a stringified representation of the source SV into the
2805 destination SV. Automatically performs any necessary mg_get and
2806 coercion of numeric values into strings. Guaranteed to preserve
2807 UTF-8 flag even from overloaded objects. Similar in nature to
2808 sv_2pv[_flags] but operates directly on an SV instead of just the
2809 string. Mostly uses sv_2pv_flags to do its work, except when that
2810 would lose the UTF-8'ness of the PV.
2816 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2819 const char * const s = SvPV_const(ssv,len);
2820 sv_setpvn(dsv,s,len);
2828 =for apidoc sv_2pvbyte
2830 Return a pointer to the byte-encoded representation of the SV, and set *lp
2831 to its length. May cause the SV to be downgraded from UTF-8 as a
2834 Usually accessed via the C<SvPVbyte> macro.
2840 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2842 sv_utf8_downgrade(sv,0);
2843 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2847 =for apidoc sv_2pvutf8
2849 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2850 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2852 Usually accessed via the C<SvPVutf8> macro.
2858 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2860 sv_utf8_upgrade(sv);
2861 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2866 =for apidoc sv_2bool
2868 This function is only called on magical items, and is only used by
2869 sv_true() or its macro equivalent.
2875 Perl_sv_2bool(pTHX_ register SV *sv)
2883 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2884 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2885 return (bool)SvTRUE(tmpsv);
2886 return SvRV(sv) != 0;
2889 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2891 (*sv->sv_u.svu_pv > '0' ||
2892 Xpvtmp->xpv_cur > 1 ||
2893 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2900 return SvIVX(sv) != 0;
2903 return SvNVX(sv) != 0.0;
2911 =for apidoc sv_utf8_upgrade
2913 Converts the PV of an SV to its UTF-8-encoded form.
2914 Forces the SV to string form if it is not already.
2915 Always sets the SvUTF8 flag to avoid future validity checks even
2916 if all the bytes have hibit clear.
2918 This is not as a general purpose byte encoding to Unicode interface:
2919 use the Encode extension for that.
2921 =for apidoc sv_utf8_upgrade_flags
2923 Converts the PV of an SV to its UTF-8-encoded form.
2924 Forces the SV to string form if it is not already.
2925 Always sets the SvUTF8 flag to avoid future validity checks even
2926 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2927 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2928 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2930 This is not as a general purpose byte encoding to Unicode interface:
2931 use the Encode extension for that.
2937 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2939 if (sv == &PL_sv_undef)
2943 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2944 (void) sv_2pv_flags(sv,&len, flags);
2948 (void) SvPV_force(sv,len);
2957 sv_force_normal_flags(sv, 0);
2960 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2961 sv_recode_to_utf8(sv, PL_encoding);
2962 else { /* Assume Latin-1/EBCDIC */
2963 /* This function could be much more efficient if we
2964 * had a FLAG in SVs to signal if there are any hibit
2965 * chars in the PV. Given that there isn't such a flag
2966 * make the loop as fast as possible. */
2967 const U8 *s = (U8 *) SvPVX_const(sv);
2968 const U8 * const e = (U8 *) SvEND(sv);
2974 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2978 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2979 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2981 SvPV_free(sv); /* No longer using what was there before. */
2983 SvPV_set(sv, (char*)recoded);
2984 SvCUR_set(sv, len - 1);
2985 SvLEN_set(sv, len); /* No longer know the real size. */
2987 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2994 =for apidoc sv_utf8_downgrade
2996 Attempts to convert the PV of an SV from characters to bytes.
2997 If the PV contains a character beyond byte, this conversion will fail;
2998 in this case, either returns false or, if C<fail_ok> is not
3001 This is not as a general purpose Unicode to byte encoding interface:
3002 use the Encode extension for that.
3008 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3010 if (SvPOKp(sv) && SvUTF8(sv)) {
3016 sv_force_normal_flags(sv, 0);
3018 s = (U8 *) SvPV(sv, len);
3019 if (!utf8_to_bytes(s, &len)) {
3024 Perl_croak(aTHX_ "Wide character in %s",
3027 Perl_croak(aTHX_ "Wide character");
3038 =for apidoc sv_utf8_encode
3040 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3041 flag off so that it looks like octets again.
3047 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3049 (void) sv_utf8_upgrade(sv);
3051 sv_force_normal_flags(sv, 0);
3053 if (SvREADONLY(sv)) {
3054 Perl_croak(aTHX_ PL_no_modify);
3060 =for apidoc sv_utf8_decode
3062 If the PV of the SV is an octet sequence in UTF-8
3063 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3064 so that it looks like a character. If the PV contains only single-byte
3065 characters, the C<SvUTF8> flag stays being off.
3066 Scans PV for validity and returns false if the PV is invalid UTF-8.
3072 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3078 /* The octets may have got themselves encoded - get them back as
3081 if (!sv_utf8_downgrade(sv, TRUE))
3084 /* it is actually just a matter of turning the utf8 flag on, but
3085 * we want to make sure everything inside is valid utf8 first.
3087 c = (const U8 *) SvPVX_const(sv);
3088 if (!is_utf8_string(c, SvCUR(sv)+1))
3090 e = (const U8 *) SvEND(sv);
3093 if (!UTF8_IS_INVARIANT(ch)) {
3103 =for apidoc sv_setsv
3105 Copies the contents of the source SV C<ssv> into the destination SV
3106 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3107 function if the source SV needs to be reused. Does not handle 'set' magic.
3108 Loosely speaking, it performs a copy-by-value, obliterating any previous
3109 content of the destination.
3111 You probably want to use one of the assortment of wrappers, such as
3112 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3113 C<SvSetMagicSV_nosteal>.
3115 =for apidoc sv_setsv_flags
3117 Copies the contents of the source SV C<ssv> into the destination SV
3118 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3119 function if the source SV needs to be reused. Does not handle 'set' magic.
3120 Loosely speaking, it performs a copy-by-value, obliterating any previous
3121 content of the destination.
3122 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3123 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3124 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3125 and C<sv_setsv_nomg> are implemented in terms of this function.
3127 You probably want to use one of the assortment of wrappers, such as
3128 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3129 C<SvSetMagicSV_nosteal>.
3131 This is the primary function for copying scalars, and most other
3132 copy-ish functions and macros use this underneath.
3138 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3140 register U32 sflags;
3146 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3148 sstr = &PL_sv_undef;
3149 stype = SvTYPE(sstr);
3150 dtype = SvTYPE(dstr);
3155 /* need to nuke the magic */
3157 SvRMAGICAL_off(dstr);
3160 /* There's a lot of redundancy below but we're going for speed here */
3165 if (dtype != SVt_PVGV) {
3166 (void)SvOK_off(dstr);
3174 sv_upgrade(dstr, SVt_IV);
3177 sv_upgrade(dstr, SVt_PVNV);
3181 sv_upgrade(dstr, SVt_PVIV);
3184 (void)SvIOK_only(dstr);
3185 SvIV_set(dstr, SvIVX(sstr));
3188 if (SvTAINTED(sstr))
3199 sv_upgrade(dstr, SVt_NV);
3204 sv_upgrade(dstr, SVt_PVNV);
3207 SvNV_set(dstr, SvNVX(sstr));
3208 (void)SvNOK_only(dstr);
3209 if (SvTAINTED(sstr))
3217 sv_upgrade(dstr, SVt_RV);
3218 else if (dtype == SVt_PVGV &&
3219 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3222 if (GvIMPORTED(dstr) != GVf_IMPORTED
3223 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3225 GvIMPORTED_on(dstr);
3234 #ifdef PERL_OLD_COPY_ON_WRITE
3235 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3236 if (dtype < SVt_PVIV)
3237 sv_upgrade(dstr, SVt_PVIV);
3244 sv_upgrade(dstr, SVt_PV);
3247 if (dtype < SVt_PVIV)
3248 sv_upgrade(dstr, SVt_PVIV);
3251 if (dtype < SVt_PVNV)
3252 sv_upgrade(dstr, SVt_PVNV);
3259 const char * const type = sv_reftype(sstr,0);
3261 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3263 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3268 if (dtype <= SVt_PVGV) {
3270 if (dtype != SVt_PVGV) {
3271 const char * const name = GvNAME(sstr);
3272 const STRLEN len = GvNAMELEN(sstr);
3273 /* don't upgrade SVt_PVLV: it can hold a glob */
3274 if (dtype != SVt_PVLV)
3275 sv_upgrade(dstr, SVt_PVGV);
3276 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3277 GvSTASH(dstr) = GvSTASH(sstr);
3279 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3280 GvNAME(dstr) = savepvn(name, len);
3281 GvNAMELEN(dstr) = len;
3282 SvFAKE_on(dstr); /* can coerce to non-glob */
3285 #ifdef GV_UNIQUE_CHECK
3286 if (GvUNIQUE((GV*)dstr)) {
3287 Perl_croak(aTHX_ PL_no_modify);
3291 (void)SvOK_off(dstr);
3292 GvINTRO_off(dstr); /* one-shot flag */
3294 GvGP(dstr) = gp_ref(GvGP(sstr));
3295 if (SvTAINTED(sstr))
3297 if (GvIMPORTED(dstr) != GVf_IMPORTED
3298 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3300 GvIMPORTED_on(dstr);
3308 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3310 if ((int)SvTYPE(sstr) != stype) {
3311 stype = SvTYPE(sstr);
3312 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3316 if (stype == SVt_PVLV)
3317 SvUPGRADE(dstr, SVt_PVNV);
3319 SvUPGRADE(dstr, (U32)stype);
3322 sflags = SvFLAGS(sstr);
3324 if (sflags & SVf_ROK) {
3325 if (dtype >= SVt_PV) {
3326 if (dtype == SVt_PVGV) {
3327 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3329 const int intro = GvINTRO(dstr);
3331 #ifdef GV_UNIQUE_CHECK
3332 if (GvUNIQUE((GV*)dstr)) {
3333 Perl_croak(aTHX_ PL_no_modify);
3338 GvINTRO_off(dstr); /* one-shot flag */
3339 GvLINE(dstr) = CopLINE(PL_curcop);
3340 GvEGV(dstr) = (GV*)dstr;
3343 switch (SvTYPE(sref)) {
3346 SAVEGENERICSV(GvAV(dstr));
3348 dref = (SV*)GvAV(dstr);
3349 GvAV(dstr) = (AV*)sref;
3350 if (!GvIMPORTED_AV(dstr)
3351 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3353 GvIMPORTED_AV_on(dstr);
3358 SAVEGENERICSV(GvHV(dstr));
3360 dref = (SV*)GvHV(dstr);
3361 GvHV(dstr) = (HV*)sref;
3362 if (!GvIMPORTED_HV(dstr)
3363 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3365 GvIMPORTED_HV_on(dstr);
3370 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3371 SvREFCNT_dec(GvCV(dstr));
3372 GvCV(dstr) = Nullcv;
3373 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3374 PL_sub_generation++;
3376 SAVEGENERICSV(GvCV(dstr));
3379 dref = (SV*)GvCV(dstr);
3380 if (GvCV(dstr) != (CV*)sref) {
3381 CV* const cv = GvCV(dstr);
3383 if (!GvCVGEN((GV*)dstr) &&
3384 (CvROOT(cv) || CvXSUB(cv)))
3386 /* Redefining a sub - warning is mandatory if
3387 it was a const and its value changed. */
3388 if (ckWARN(WARN_REDEFINE)
3390 && (!CvCONST((CV*)sref)
3391 || sv_cmp(cv_const_sv(cv),
3392 cv_const_sv((CV*)sref)))))
3394 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3396 ? "Constant subroutine %s::%s redefined"
3397 : "Subroutine %s::%s redefined",
3398 HvNAME_get(GvSTASH((GV*)dstr)),
3399 GvENAME((GV*)dstr));
3403 cv_ckproto(cv, (GV*)dstr,
3405 ? SvPVX_const(sref) : Nullch);
3407 GvCV(dstr) = (CV*)sref;
3408 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3409 GvASSUMECV_on(dstr);
3410 PL_sub_generation++;
3412 if (!GvIMPORTED_CV(dstr)
3413 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3415 GvIMPORTED_CV_on(dstr);
3420 SAVEGENERICSV(GvIOp(dstr));
3422 dref = (SV*)GvIOp(dstr);
3423 GvIOp(dstr) = (IO*)sref;
3427 SAVEGENERICSV(GvFORM(dstr));
3429 dref = (SV*)GvFORM(dstr);
3430 GvFORM(dstr) = (CV*)sref;
3434 SAVEGENERICSV(GvSV(dstr));
3436 dref = (SV*)GvSV(dstr);
3438 if (!GvIMPORTED_SV(dstr)
3439 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3441 GvIMPORTED_SV_on(dstr);
3447 if (SvTAINTED(sstr))
3451 if (SvPVX_const(dstr)) {
3457 (void)SvOK_off(dstr);
3458 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3460 if (sflags & SVp_NOK) {
3462 /* Only set the public OK flag if the source has public OK. */
3463 if (sflags & SVf_NOK)
3464 SvFLAGS(dstr) |= SVf_NOK;
3465 SvNV_set(dstr, SvNVX(sstr));
3467 if (sflags & SVp_IOK) {
3468 (void)SvIOKp_on(dstr);
3469 if (sflags & SVf_IOK)
3470 SvFLAGS(dstr) |= SVf_IOK;
3471 if (sflags & SVf_IVisUV)
3473 SvIV_set(dstr, SvIVX(sstr));
3475 if (SvAMAGIC(sstr)) {
3479 else if (sflags & SVp_POK) {
3483 * Check to see if we can just swipe the string. If so, it's a
3484 * possible small lose on short strings, but a big win on long ones.
3485 * It might even be a win on short strings if SvPVX_const(dstr)
3486 * has to be allocated and SvPVX_const(sstr) has to be freed.
3489 /* Whichever path we take through the next code, we want this true,
3490 and doing it now facilitates the COW check. */
3491 (void)SvPOK_only(dstr);
3494 /* We're not already COW */
3495 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3496 #ifndef PERL_OLD_COPY_ON_WRITE
3497 /* or we are, but dstr isn't a suitable target. */
3498 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3503 (sflags & SVs_TEMP) && /* slated for free anyway? */
3504 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3505 (!(flags & SV_NOSTEAL)) &&
3506 /* and we're allowed to steal temps */
3507 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3508 SvLEN(sstr) && /* and really is a string */
3509 /* and won't be needed again, potentially */
3510 !(PL_op && PL_op->op_type == OP_AASSIGN))
3511 #ifdef PERL_OLD_COPY_ON_WRITE
3512 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3513 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3514 && SvTYPE(sstr) >= SVt_PVIV)
3517 /* Failed the swipe test, and it's not a shared hash key either.
3518 Have to copy the string. */
3519 STRLEN len = SvCUR(sstr);
3520 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3521 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3522 SvCUR_set(dstr, len);
3523 *SvEND(dstr) = '\0';
3525 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3527 /* Either it's a shared hash key, or it's suitable for
3528 copy-on-write or we can swipe the string. */
3530 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3534 #ifdef PERL_OLD_COPY_ON_WRITE
3536 /* I believe I should acquire a global SV mutex if
3537 it's a COW sv (not a shared hash key) to stop
3538 it going un copy-on-write.
3539 If the source SV has gone un copy on write between up there
3540 and down here, then (assert() that) it is of the correct
3541 form to make it copy on write again */
3542 if ((sflags & (SVf_FAKE | SVf_READONLY))
3543 != (SVf_FAKE | SVf_READONLY)) {
3544 SvREADONLY_on(sstr);
3546 /* Make the source SV into a loop of 1.
3547 (about to become 2) */
3548 SV_COW_NEXT_SV_SET(sstr, sstr);
3552 /* Initial code is common. */
3553 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3558 /* making another shared SV. */
3559 STRLEN cur = SvCUR(sstr);
3560 STRLEN len = SvLEN(sstr);
3561 #ifdef PERL_OLD_COPY_ON_WRITE
3563 assert (SvTYPE(dstr) >= SVt_PVIV);
3564 /* SvIsCOW_normal */
3565 /* splice us in between source and next-after-source. */
3566 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3567 SV_COW_NEXT_SV_SET(sstr, dstr);
3568 SvPV_set(dstr, SvPVX_mutable(sstr));
3572 /* SvIsCOW_shared_hash */
3573 DEBUG_C(PerlIO_printf(Perl_debug_log,
3574 "Copy on write: Sharing hash\n"));
3576 assert (SvTYPE(dstr) >= SVt_PV);
3578 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3580 SvLEN_set(dstr, len);
3581 SvCUR_set(dstr, cur);
3582 SvREADONLY_on(dstr);
3584 /* Relesase a global SV mutex. */
3587 { /* Passes the swipe test. */
3588 SvPV_set(dstr, SvPVX_mutable(sstr));
3589 SvLEN_set(dstr, SvLEN(sstr));
3590 SvCUR_set(dstr, SvCUR(sstr));
3593 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3594 SvPV_set(sstr, Nullch);
3600 if (sflags & SVf_UTF8)
3602 if (sflags & SVp_NOK) {
3604 if (sflags & SVf_NOK)
3605 SvFLAGS(dstr) |= SVf_NOK;
3606 SvNV_set(dstr, SvNVX(sstr));
3608 if (sflags & SVp_IOK) {
3609 (void)SvIOKp_on(dstr);
3610 if (sflags & SVf_IOK)
3611 SvFLAGS(dstr) |= SVf_IOK;
3612 if (sflags & SVf_IVisUV)
3614 SvIV_set(dstr, SvIVX(sstr));
3617 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3618 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3619 smg->mg_ptr, smg->mg_len);
3620 SvRMAGICAL_on(dstr);
3623 else if (sflags & SVp_IOK) {
3624 if (sflags & SVf_IOK)
3625 (void)SvIOK_only(dstr);
3627 (void)SvOK_off(dstr);
3628 (void)SvIOKp_on(dstr);
3630 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3631 if (sflags & SVf_IVisUV)
3633 SvIV_set(dstr, SvIVX(sstr));
3634 if (sflags & SVp_NOK) {
3635 if (sflags & SVf_NOK)
3636 (void)SvNOK_on(dstr);
3638 (void)SvNOKp_on(dstr);
3639 SvNV_set(dstr, SvNVX(sstr));
3642 else if (sflags & SVp_NOK) {
3643 if (sflags & SVf_NOK)
3644 (void)SvNOK_only(dstr);
3646 (void)SvOK_off(dstr);
3649 SvNV_set(dstr, SvNVX(sstr));
3652 if (dtype == SVt_PVGV) {
3653 if (ckWARN(WARN_MISC))
3654 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3657 (void)SvOK_off(dstr);
3659 if (SvTAINTED(sstr))
3664 =for apidoc sv_setsv_mg
3666 Like C<sv_setsv>, but also handles 'set' magic.
3672 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3674 sv_setsv(dstr,sstr);
3678 #ifdef PERL_OLD_COPY_ON_WRITE
3680 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3682 STRLEN cur = SvCUR(sstr);
3683 STRLEN len = SvLEN(sstr);
3684 register char *new_pv;
3687 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3695 if (SvTHINKFIRST(dstr))
3696 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3697 else if (SvPVX_const(dstr))
3698 Safefree(SvPVX_const(dstr));
3702 SvUPGRADE(dstr, SVt_PVIV);
3704 assert (SvPOK(sstr));
3705 assert (SvPOKp(sstr));
3706 assert (!SvIOK(sstr));
3707 assert (!SvIOKp(sstr));
3708 assert (!SvNOK(sstr));
3709 assert (!SvNOKp(sstr));
3711 if (SvIsCOW(sstr)) {
3713 if (SvLEN(sstr) == 0) {
3714 /* source is a COW shared hash key. */
3715 DEBUG_C(PerlIO_printf(Perl_debug_log,
3716 "Fast copy on write: Sharing hash\n"));
3717 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3720 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3722 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3723 SvUPGRADE(sstr, SVt_PVIV);
3724 SvREADONLY_on(sstr);
3726 DEBUG_C(PerlIO_printf(Perl_debug_log,
3727 "Fast copy on write: Converting sstr to COW\n"));
3728 SV_COW_NEXT_SV_SET(dstr, sstr);
3730 SV_COW_NEXT_SV_SET(sstr, dstr);
3731 new_pv = SvPVX_mutable(sstr);
3734 SvPV_set(dstr, new_pv);
3735 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3738 SvLEN_set(dstr, len);
3739 SvCUR_set(dstr, cur);
3748 =for apidoc sv_setpvn
3750 Copies a string into an SV. The C<len> parameter indicates the number of
3751 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3752 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3758 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3760 register char *dptr;
3762 SV_CHECK_THINKFIRST_COW_DROP(sv);
3768 /* len is STRLEN which is unsigned, need to copy to signed */
3771 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3773 SvUPGRADE(sv, SVt_PV);
3775 dptr = SvGROW(sv, len + 1);
3776 Move(ptr,dptr,len,char);
3779 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3784 =for apidoc sv_setpvn_mg
3786 Like C<sv_setpvn>, but also handles 'set' magic.
3792 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3794 sv_setpvn(sv,ptr,len);
3799 =for apidoc sv_setpv
3801 Copies a string into an SV. The string must be null-terminated. Does not
3802 handle 'set' magic. See C<sv_setpv_mg>.
3808 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3810 register STRLEN len;
3812 SV_CHECK_THINKFIRST_COW_DROP(sv);
3818 SvUPGRADE(sv, SVt_PV);
3820 SvGROW(sv, len + 1);
3821 Move(ptr,SvPVX(sv),len+1,char);
3823 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3828 =for apidoc sv_setpv_mg
3830 Like C<sv_setpv>, but also handles 'set' magic.
3836 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3843 =for apidoc sv_usepvn
3845 Tells an SV to use C<ptr> to find its string value. Normally the string is
3846 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3847 The C<ptr> should point to memory that was allocated by C<malloc>. The
3848 string length, C<len>, must be supplied. This function will realloc the
3849 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3850 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3851 See C<sv_usepvn_mg>.
3857 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3860 SV_CHECK_THINKFIRST_COW_DROP(sv);
3861 SvUPGRADE(sv, SVt_PV);
3866 if (SvPVX_const(sv))
3869 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3870 ptr = saferealloc (ptr, allocate);
3873 SvLEN_set(sv, allocate);
3875 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3880 =for apidoc sv_usepvn_mg
3882 Like C<sv_usepvn>, but also handles 'set' magic.
3888 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3890 sv_usepvn(sv,ptr,len);
3894 #ifdef PERL_OLD_COPY_ON_WRITE
3895 /* Need to do this *after* making the SV normal, as we need the buffer
3896 pointer to remain valid until after we've copied it. If we let go too early,
3897 another thread could invalidate it by unsharing last of the same hash key
3898 (which it can do by means other than releasing copy-on-write Svs)
3899 or by changing the other copy-on-write SVs in the loop. */
3901 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3903 if (len) { /* this SV was SvIsCOW_normal(sv) */
3904 /* we need to find the SV pointing to us. */
3905 SV * const current = SV_COW_NEXT_SV(after);
3907 if (current == sv) {
3908 /* The SV we point to points back to us (there were only two of us
3910 Hence other SV is no longer copy on write either. */
3912 SvREADONLY_off(after);
3914 /* We need to follow the pointers around the loop. */
3916 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3919 /* don't loop forever if the structure is bust, and we have
3920 a pointer into a closed loop. */
3921 assert (current != after);
3922 assert (SvPVX_const(current) == pvx);
3924 /* Make the SV before us point to the SV after us. */
3925 SV_COW_NEXT_SV_SET(current, after);
3928 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3933 Perl_sv_release_IVX(pTHX_ register SV *sv)
3936 sv_force_normal_flags(sv, 0);
3942 =for apidoc sv_force_normal_flags
3944 Undo various types of fakery on an SV: if the PV is a shared string, make
3945 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3946 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3947 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3948 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3949 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3950 set to some other value.) In addition, the C<flags> parameter gets passed to
3951 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3952 with flags set to 0.
3958 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3960 #ifdef PERL_OLD_COPY_ON_WRITE
3961 if (SvREADONLY(sv)) {
3962 /* At this point I believe I should acquire a global SV mutex. */
3964 const char * const pvx = SvPVX_const(sv);
3965 const STRLEN len = SvLEN(sv);
3966 const STRLEN cur = SvCUR(sv);
3967 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3969 PerlIO_printf(Perl_debug_log,
3970 "Copy on write: Force normal %ld\n",
3976 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3977 SvPV_set(sv, (char*)0);
3979 if (flags & SV_COW_DROP_PV) {
3980 /* OK, so we don't need to copy our buffer. */
3983 SvGROW(sv, cur + 1);
3984 Move(pvx,SvPVX(sv),cur,char);
3988 sv_release_COW(sv, pvx, len, next);
3993 else if (IN_PERL_RUNTIME)
3994 Perl_croak(aTHX_ PL_no_modify);
3995 /* At this point I believe that I can drop the global SV mutex. */
3998 if (SvREADONLY(sv)) {
4000 const char * const pvx = SvPVX_const(sv);
4001 const STRLEN len = SvCUR(sv);
4004 SvPV_set(sv, Nullch);
4006 SvGROW(sv, len + 1);
4007 Move(pvx,SvPVX(sv),len,char);
4009 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4011 else if (IN_PERL_RUNTIME)
4012 Perl_croak(aTHX_ PL_no_modify);
4016 sv_unref_flags(sv, flags);
4017 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4024 Efficient removal of characters from the beginning of the string buffer.
4025 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4026 the string buffer. The C<ptr> becomes the first character of the adjusted
4027 string. Uses the "OOK hack".
4028 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4029 refer to the same chunk of data.
4035 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4037 register STRLEN delta;
4038 if (!ptr || !SvPOKp(sv))
4040 delta = ptr - SvPVX_const(sv);
4041 SV_CHECK_THINKFIRST(sv);
4042 if (SvTYPE(sv) < SVt_PVIV)
4043 sv_upgrade(sv,SVt_PVIV);
4046 if (!SvLEN(sv)) { /* make copy of shared string */
4047 const char *pvx = SvPVX_const(sv);
4048 const STRLEN len = SvCUR(sv);
4049 SvGROW(sv, len + 1);
4050 Move(pvx,SvPVX(sv),len,char);
4054 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4055 and we do that anyway inside the SvNIOK_off
4057 SvFLAGS(sv) |= SVf_OOK;
4060 SvLEN_set(sv, SvLEN(sv) - delta);
4061 SvCUR_set(sv, SvCUR(sv) - delta);
4062 SvPV_set(sv, SvPVX(sv) + delta);
4063 SvIV_set(sv, SvIVX(sv) + delta);
4067 =for apidoc sv_catpvn
4069 Concatenates the string onto the end of the string which is in the SV. The
4070 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4071 status set, then the bytes appended should be valid UTF-8.
4072 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4074 =for apidoc sv_catpvn_flags
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 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4080 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4081 in terms of this function.
4087 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4090 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4092 SvGROW(dsv, dlen + slen + 1);
4094 sstr = SvPVX_const(dsv);
4095 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4096 SvCUR_set(dsv, SvCUR(dsv) + slen);
4098 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4100 if (flags & SV_SMAGIC)
4105 =for apidoc sv_catsv
4107 Concatenates the string from SV C<ssv> onto the end of the string in
4108 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4109 not 'set' magic. See C<sv_catsv_mg>.
4111 =for apidoc sv_catsv_flags
4113 Concatenates the string from SV C<ssv> onto the end of the string in
4114 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4115 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4116 and C<sv_catsv_nomg> are implemented in terms of this function.
4121 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4126 if ((spv = SvPV_const(ssv, slen))) {
4127 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4128 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4129 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4130 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4131 dsv->sv_flags doesn't have that bit set.
4132 Andy Dougherty 12 Oct 2001
4134 const I32 sutf8 = DO_UTF8(ssv);
4137 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4139 dutf8 = DO_UTF8(dsv);
4141 if (dutf8 != sutf8) {
4143 /* Not modifying source SV, so taking a temporary copy. */
4144 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4146 sv_utf8_upgrade(csv);
4147 spv = SvPV_const(csv, slen);
4150 sv_utf8_upgrade_nomg(dsv);
4152 sv_catpvn_nomg(dsv, spv, slen);
4155 if (flags & SV_SMAGIC)
4160 =for apidoc sv_catpv
4162 Concatenates the string onto the end of the string which is in the SV.
4163 If the SV has the UTF-8 status set, then the bytes appended should be
4164 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4169 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4171 register STRLEN len;
4177 junk = SvPV_force(sv, tlen);
4179 SvGROW(sv, tlen + len + 1);
4181 ptr = SvPVX_const(sv);
4182 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4183 SvCUR_set(sv, SvCUR(sv) + len);
4184 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4189 =for apidoc sv_catpv_mg
4191 Like C<sv_catpv>, but also handles 'set' magic.
4197 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4206 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4207 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4214 Perl_newSV(pTHX_ STRLEN len)
4220 sv_upgrade(sv, SVt_PV);
4221 SvGROW(sv, len + 1);
4226 =for apidoc sv_magicext
4228 Adds magic to an SV, upgrading it if necessary. Applies the
4229 supplied vtable and returns a pointer to the magic added.
4231 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4232 In particular, you can add magic to SvREADONLY SVs, and add more than
4233 one instance of the same 'how'.
4235 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4236 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4237 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4238 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4240 (This is now used as a subroutine by C<sv_magic>.)
4245 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4246 const char* name, I32 namlen)
4250 if (SvTYPE(sv) < SVt_PVMG) {
4251 SvUPGRADE(sv, SVt_PVMG);
4253 Newxz(mg, 1, MAGIC);
4254 mg->mg_moremagic = SvMAGIC(sv);
4255 SvMAGIC_set(sv, mg);
4257 /* Sometimes a magic contains a reference loop, where the sv and
4258 object refer to each other. To prevent a reference loop that
4259 would prevent such objects being freed, we look for such loops
4260 and if we find one we avoid incrementing the object refcount.
4262 Note we cannot do this to avoid self-tie loops as intervening RV must
4263 have its REFCNT incremented to keep it in existence.
4266 if (!obj || obj == sv ||
4267 how == PERL_MAGIC_arylen ||
4268 how == PERL_MAGIC_qr ||
4269 how == PERL_MAGIC_symtab ||
4270 (SvTYPE(obj) == SVt_PVGV &&
4271 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4272 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4273 GvFORM(obj) == (CV*)sv)))
4278 mg->mg_obj = SvREFCNT_inc(obj);
4279 mg->mg_flags |= MGf_REFCOUNTED;
4282 /* Normal self-ties simply pass a null object, and instead of
4283 using mg_obj directly, use the SvTIED_obj macro to produce a
4284 new RV as needed. For glob "self-ties", we are tieing the PVIO
4285 with an RV obj pointing to the glob containing the PVIO. In
4286 this case, to avoid a reference loop, we need to weaken the
4290 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4291 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4297 mg->mg_len = namlen;
4300 mg->mg_ptr = savepvn(name, namlen);
4301 else if (namlen == HEf_SVKEY)
4302 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4304 mg->mg_ptr = (char *) name;
4306 mg->mg_virtual = vtable;
4310 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4315 =for apidoc sv_magic
4317 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4318 then adds a new magic item of type C<how> to the head of the magic list.
4320 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4321 handling of the C<name> and C<namlen> arguments.
4323 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4324 to add more than one instance of the same 'how'.
4330 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4332 const MGVTBL *vtable;
4335 #ifdef PERL_OLD_COPY_ON_WRITE
4337 sv_force_normal_flags(sv, 0);
4339 if (SvREADONLY(sv)) {
4341 /* its okay to attach magic to shared strings; the subsequent
4342 * upgrade to PVMG will unshare the string */
4343 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4346 && how != PERL_MAGIC_regex_global
4347 && how != PERL_MAGIC_bm
4348 && how != PERL_MAGIC_fm
4349 && how != PERL_MAGIC_sv
4350 && how != PERL_MAGIC_backref
4353 Perl_croak(aTHX_ PL_no_modify);
4356 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4357 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4358 /* sv_magic() refuses to add a magic of the same 'how' as an
4361 if (how == PERL_MAGIC_taint)
4369 vtable = &PL_vtbl_sv;
4371 case PERL_MAGIC_overload:
4372 vtable = &PL_vtbl_amagic;
4374 case PERL_MAGIC_overload_elem:
4375 vtable = &PL_vtbl_amagicelem;
4377 case PERL_MAGIC_overload_table:
4378 vtable = &PL_vtbl_ovrld;
4381 vtable = &PL_vtbl_bm;
4383 case PERL_MAGIC_regdata:
4384 vtable = &PL_vtbl_regdata;
4386 case PERL_MAGIC_regdatum:
4387 vtable = &PL_vtbl_regdatum;
4389 case PERL_MAGIC_env:
4390 vtable = &PL_vtbl_env;
4393 vtable = &PL_vtbl_fm;
4395 case PERL_MAGIC_envelem:
4396 vtable = &PL_vtbl_envelem;
4398 case PERL_MAGIC_regex_global:
4399 vtable = &PL_vtbl_mglob;
4401 case PERL_MAGIC_isa:
4402 vtable = &PL_vtbl_isa;
4404 case PERL_MAGIC_isaelem:
4405 vtable = &PL_vtbl_isaelem;
4407 case PERL_MAGIC_nkeys:
4408 vtable = &PL_vtbl_nkeys;
4410 case PERL_MAGIC_dbfile:
4413 case PERL_MAGIC_dbline:
4414 vtable = &PL_vtbl_dbline;
4416 #ifdef USE_LOCALE_COLLATE
4417 case PERL_MAGIC_collxfrm:
4418 vtable = &PL_vtbl_collxfrm;
4420 #endif /* USE_LOCALE_COLLATE */
4421 case PERL_MAGIC_tied:
4422 vtable = &PL_vtbl_pack;
4424 case PERL_MAGIC_tiedelem:
4425 case PERL_MAGIC_tiedscalar:
4426 vtable = &PL_vtbl_packelem;
4429 vtable = &PL_vtbl_regexp;
4431 case PERL_MAGIC_sig:
4432 vtable = &PL_vtbl_sig;
4434 case PERL_MAGIC_sigelem:
4435 vtable = &PL_vtbl_sigelem;
4437 case PERL_MAGIC_taint:
4438 vtable = &PL_vtbl_taint;
4440 case PERL_MAGIC_uvar:
4441 vtable = &PL_vtbl_uvar;
4443 case PERL_MAGIC_vec:
4444 vtable = &PL_vtbl_vec;
4446 case PERL_MAGIC_arylen_p:
4447 case PERL_MAGIC_rhash:
4448 case PERL_MAGIC_symtab:
4449 case PERL_MAGIC_vstring:
4452 case PERL_MAGIC_utf8:
4453 vtable = &PL_vtbl_utf8;
4455 case PERL_MAGIC_substr:
4456 vtable = &PL_vtbl_substr;
4458 case PERL_MAGIC_defelem:
4459 vtable = &PL_vtbl_defelem;
4461 case PERL_MAGIC_glob:
4462 vtable = &PL_vtbl_glob;
4464 case PERL_MAGIC_arylen:
4465 vtable = &PL_vtbl_arylen;
4467 case PERL_MAGIC_pos:
4468 vtable = &PL_vtbl_pos;
4470 case PERL_MAGIC_backref:
4471 vtable = &PL_vtbl_backref;
4473 case PERL_MAGIC_ext:
4474 /* Reserved for use by extensions not perl internals. */
4475 /* Useful for attaching extension internal data to perl vars. */
4476 /* Note that multiple extensions may clash if magical scalars */
4477 /* etc holding private data from one are passed to another. */
4481 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4484 /* Rest of work is done else where */
4485 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4488 case PERL_MAGIC_taint:
4491 case PERL_MAGIC_ext:
4492 case PERL_MAGIC_dbfile:
4499 =for apidoc sv_unmagic
4501 Removes all magic of type C<type> from an SV.
4507 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4511 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4514 for (mg = *mgp; mg; mg = *mgp) {
4515 if (mg->mg_type == type) {
4516 const MGVTBL* const vtbl = mg->mg_virtual;
4517 *mgp = mg->mg_moremagic;
4518 if (vtbl && vtbl->svt_free)
4519 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4520 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4522 Safefree(mg->mg_ptr);
4523 else if (mg->mg_len == HEf_SVKEY)
4524 SvREFCNT_dec((SV*)mg->mg_ptr);
4525 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4526 Safefree(mg->mg_ptr);
4528 if (mg->mg_flags & MGf_REFCOUNTED)
4529 SvREFCNT_dec(mg->mg_obj);
4533 mgp = &mg->mg_moremagic;
4537 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4544 =for apidoc sv_rvweaken
4546 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4547 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4548 push a back-reference to this RV onto the array of backreferences
4549 associated with that magic.
4555 Perl_sv_rvweaken(pTHX_ SV *sv)
4558 if (!SvOK(sv)) /* let undefs pass */
4561 Perl_croak(aTHX_ "Can't weaken a nonreference");
4562 else if (SvWEAKREF(sv)) {
4563 if (ckWARN(WARN_MISC))
4564 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4568 Perl_sv_add_backref(aTHX_ tsv, sv);
4574 /* Give tsv backref magic if it hasn't already got it, then push a
4575 * back-reference to sv onto the array associated with the backref magic.
4579 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4583 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4584 av = (AV*)mg->mg_obj;
4587 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4588 /* av now has a refcnt of 2, which avoids it getting freed
4589 * before us during global cleanup. The extra ref is removed
4590 * by magic_killbackrefs() when tsv is being freed */
4592 if (AvFILLp(av) >= AvMAX(av)) {
4593 av_extend(av, AvFILLp(av)+1);
4595 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4598 /* delete a back-reference to ourselves from the backref magic associated
4599 * with the SV we point to.
4603 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4609 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4610 if (PL_in_clean_all)
4613 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4614 Perl_croak(aTHX_ "panic: del_backref");
4615 av = (AV *)mg->mg_obj;
4617 /* We shouldn't be in here more than once, but for paranoia reasons lets
4619 for (i = AvFILLp(av); i >= 0; i--) {
4621 const SSize_t fill = AvFILLp(av);
4623 /* We weren't the last entry.
4624 An unordered list has this property that you can take the
4625 last element off the end to fill the hole, and it's still
4626 an unordered list :-)
4631 AvFILLp(av) = fill - 1;
4637 =for apidoc sv_insert
4639 Inserts a string at the specified offset/length within the SV. Similar to
4640 the Perl substr() function.
4646 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4650 register char *midend;
4651 register char *bigend;
4657 Perl_croak(aTHX_ "Can't modify non-existent substring");
4658 SvPV_force(bigstr, curlen);
4659 (void)SvPOK_only_UTF8(bigstr);
4660 if (offset + len > curlen) {
4661 SvGROW(bigstr, offset+len+1);
4662 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4663 SvCUR_set(bigstr, offset+len);
4667 i = littlelen - len;
4668 if (i > 0) { /* string might grow */
4669 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4670 mid = big + offset + len;
4671 midend = bigend = big + SvCUR(bigstr);
4674 while (midend > mid) /* shove everything down */
4675 *--bigend = *--midend;
4676 Move(little,big+offset,littlelen,char);
4677 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4682 Move(little,SvPVX(bigstr)+offset,len,char);
4687 big = SvPVX(bigstr);
4690 bigend = big + SvCUR(bigstr);
4692 if (midend > bigend)
4693 Perl_croak(aTHX_ "panic: sv_insert");
4695 if (mid - big > bigend - midend) { /* faster to shorten from end */
4697 Move(little, mid, littlelen,char);
4700 i = bigend - midend;
4702 Move(midend, mid, i,char);
4706 SvCUR_set(bigstr, mid - big);
4708 else if ((i = mid - big)) { /* faster from front */
4709 midend -= littlelen;
4711 sv_chop(bigstr,midend-i);
4716 Move(little, mid, littlelen,char);
4718 else if (littlelen) {
4719 midend -= littlelen;
4720 sv_chop(bigstr,midend);
4721 Move(little,midend,littlelen,char);
4724 sv_chop(bigstr,midend);
4730 =for apidoc sv_replace
4732 Make the first argument a copy of the second, then delete the original.
4733 The target SV physically takes over ownership of the body of the source SV
4734 and inherits its flags; however, the target keeps any magic it owns,
4735 and any magic in the source is discarded.
4736 Note that this is a rather specialist SV copying operation; most of the
4737 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4743 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4745 const U32 refcnt = SvREFCNT(sv);
4746 SV_CHECK_THINKFIRST_COW_DROP(sv);
4747 if (SvREFCNT(nsv) != 1) {
4748 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4749 UVuf " != 1)", (UV) SvREFCNT(nsv));
4751 if (SvMAGICAL(sv)) {
4755 sv_upgrade(nsv, SVt_PVMG);
4756 SvMAGIC_set(nsv, SvMAGIC(sv));
4757 SvFLAGS(nsv) |= SvMAGICAL(sv);
4759 SvMAGIC_set(sv, NULL);
4763 assert(!SvREFCNT(sv));
4764 #ifdef DEBUG_LEAKING_SCALARS
4765 sv->sv_flags = nsv->sv_flags;
4766 sv->sv_any = nsv->sv_any;
4767 sv->sv_refcnt = nsv->sv_refcnt;
4768 sv->sv_u = nsv->sv_u;
4770 StructCopy(nsv,sv,SV);
4772 /* Currently could join these into one piece of pointer arithmetic, but
4773 it would be unclear. */
4774 if(SvTYPE(sv) == SVt_IV)
4776 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4777 else if (SvTYPE(sv) == SVt_RV) {
4778 SvANY(sv) = &sv->sv_u.svu_rv;
4782 #ifdef PERL_OLD_COPY_ON_WRITE
4783 if (SvIsCOW_normal(nsv)) {
4784 /* We need to follow the pointers around the loop to make the
4785 previous SV point to sv, rather than nsv. */
4788 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4791 assert(SvPVX_const(current) == SvPVX_const(nsv));
4793 /* Make the SV before us point to the SV after us. */
4795 PerlIO_printf(Perl_debug_log, "previous is\n");
4797 PerlIO_printf(Perl_debug_log,
4798 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4799 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4801 SV_COW_NEXT_SV_SET(current, sv);
4804 SvREFCNT(sv) = refcnt;
4805 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4811 =for apidoc sv_clear
4813 Clear an SV: call any destructors, free up any memory used by the body,
4814 and free the body itself. The SV's head is I<not> freed, although
4815 its type is set to all 1's so that it won't inadvertently be assumed
4816 to be live during global destruction etc.
4817 This function should only be called when REFCNT is zero. Most of the time
4818 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4825 Perl_sv_clear(pTHX_ register SV *sv)
4828 const U32 type = SvTYPE(sv);
4829 const struct body_details *const sv_type_details
4830 = bodies_by_type + type;
4833 assert(SvREFCNT(sv) == 0);
4839 if (PL_defstash) { /* Still have a symbol table? */
4844 stash = SvSTASH(sv);
4845 destructor = StashHANDLER(stash,DESTROY);
4847 SV* const tmpref = newRV(sv);
4848 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4850 PUSHSTACKi(PERLSI_DESTROY);
4855 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4861 if(SvREFCNT(tmpref) < 2) {
4862 /* tmpref is not kept alive! */
4864 SvRV_set(tmpref, NULL);
4867 SvREFCNT_dec(tmpref);
4869 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4873 if (PL_in_clean_objs)
4874 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4876 /* DESTROY gave object new lease on life */
4882 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4883 SvOBJECT_off(sv); /* Curse the object. */
4884 if (type != SVt_PVIO)
4885 --PL_sv_objcount; /* XXX Might want something more general */
4888 if (type >= SVt_PVMG) {
4891 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4892 SvREFCNT_dec(SvSTASH(sv));
4897 IoIFP(sv) != PerlIO_stdin() &&
4898 IoIFP(sv) != PerlIO_stdout() &&
4899 IoIFP(sv) != PerlIO_stderr())
4901 io_close((IO*)sv, FALSE);
4903 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4904 PerlDir_close(IoDIRP(sv));
4905 IoDIRP(sv) = (DIR*)NULL;
4906 Safefree(IoTOP_NAME(sv));
4907 Safefree(IoFMT_NAME(sv));
4908 Safefree(IoBOTTOM_NAME(sv));
4923 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4924 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4925 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4926 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4928 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4929 SvREFCNT_dec(LvTARG(sv));
4933 Safefree(GvNAME(sv));
4934 /* If we're in a stash, we don't own a reference to it. However it does
4935 have a back reference to us, which needs to be cleared. */
4937 sv_del_backref((SV*)GvSTASH(sv), sv);
4942 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4944 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4945 /* Don't even bother with turning off the OOK flag. */
4950 SV *target = SvRV(sv);
4952 sv_del_backref(target, sv);
4954 SvREFCNT_dec(target);
4956 #ifdef PERL_OLD_COPY_ON_WRITE
4957 else if (SvPVX_const(sv)) {
4959 /* I believe I need to grab the global SV mutex here and
4960 then recheck the COW status. */
4962 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4965 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4966 SV_COW_NEXT_SV(sv));
4967 /* And drop it here. */
4969 } else if (SvLEN(sv)) {
4970 Safefree(SvPVX_const(sv));
4974 else if (SvPVX_const(sv) && SvLEN(sv))
4975 Safefree(SvPVX_mutable(sv));
4976 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4977 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4986 SvFLAGS(sv) &= SVf_BREAK;
4987 SvFLAGS(sv) |= SVTYPEMASK;
4989 if (sv_type_details->arena) {
4990 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4991 &PL_body_roots[type]);
4993 else if (sv_type_details->size) {
4994 my_safefree(SvANY(sv));
4999 =for apidoc sv_newref
5001 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5008 Perl_sv_newref(pTHX_ SV *sv)
5018 Decrement an SV's reference count, and if it drops to zero, call
5019 C<sv_clear> to invoke destructors and free up any memory used by
5020 the body; finally, deallocate the SV's head itself.
5021 Normally called via a wrapper macro C<SvREFCNT_dec>.
5027 Perl_sv_free(pTHX_ SV *sv)
5032 if (SvREFCNT(sv) == 0) {
5033 if (SvFLAGS(sv) & SVf_BREAK)
5034 /* this SV's refcnt has been artificially decremented to
5035 * trigger cleanup */
5037 if (PL_in_clean_all) /* All is fair */
5039 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5040 /* make sure SvREFCNT(sv)==0 happens very seldom */
5041 SvREFCNT(sv) = (~(U32)0)/2;
5044 if (ckWARN_d(WARN_INTERNAL)) {
5045 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5046 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5047 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5048 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5049 Perl_dump_sv_child(aTHX_ sv);
5054 if (--(SvREFCNT(sv)) > 0)
5056 Perl_sv_free2(aTHX_ sv);
5060 Perl_sv_free2(pTHX_ SV *sv)
5065 if (ckWARN_d(WARN_DEBUGGING))
5066 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5067 "Attempt to free temp prematurely: SV 0x%"UVxf
5068 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5072 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5073 /* make sure SvREFCNT(sv)==0 happens very seldom */
5074 SvREFCNT(sv) = (~(U32)0)/2;
5085 Returns the length of the string in the SV. Handles magic and type
5086 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5092 Perl_sv_len(pTHX_ register SV *sv)
5100 len = mg_length(sv);
5102 (void)SvPV_const(sv, len);
5107 =for apidoc sv_len_utf8
5109 Returns the number of characters in the string in an SV, counting wide
5110 UTF-8 bytes as a single character. Handles magic and type coercion.
5116 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5117 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5118 * (Note that the mg_len is not the length of the mg_ptr field.)
5123 Perl_sv_len_utf8(pTHX_ register SV *sv)
5129 return mg_length(sv);
5133 const U8 *s = (U8*)SvPV_const(sv, len);
5134 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5136 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5138 #ifdef PERL_UTF8_CACHE_ASSERT
5139 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5143 ulen = Perl_utf8_length(aTHX_ s, s + len);
5144 if (!mg && !SvREADONLY(sv)) {
5145 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5146 mg = mg_find(sv, PERL_MAGIC_utf8);
5156 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5157 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5158 * between UTF-8 and byte offsets. There are two (substr offset and substr
5159 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5160 * and byte offset) cache positions.
5162 * The mg_len field is used by sv_len_utf8(), see its comments.
5163 * Note that the mg_len is not the length of the mg_ptr field.
5167 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5168 I32 offsetp, const U8 *s, const U8 *start)
5172 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5174 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5178 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5180 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5181 (*mgp)->mg_ptr = (char *) *cachep;
5185 (*cachep)[i] = offsetp;
5186 (*cachep)[i+1] = s - start;
5194 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5195 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5196 * between UTF-8 and byte offsets. See also the comments of
5197 * S_utf8_mg_pos_init().
5201 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)
5205 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5207 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5208 if (*mgp && (*mgp)->mg_ptr) {
5209 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5210 ASSERT_UTF8_CACHE(*cachep);
5211 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5213 else { /* We will skip to the right spot. */
5218 /* The assumption is that going backward is half
5219 * the speed of going forward (that's where the
5220 * 2 * backw in the below comes from). (The real
5221 * figure of course depends on the UTF-8 data.) */
5223 if ((*cachep)[i] > (STRLEN)uoff) {
5225 backw = (*cachep)[i] - (STRLEN)uoff;
5227 if (forw < 2 * backw)
5230 p = start + (*cachep)[i+1];
5232 /* Try this only for the substr offset (i == 0),
5233 * not for the substr length (i == 2). */
5234 else if (i == 0) { /* (*cachep)[i] < uoff */
5235 const STRLEN ulen = sv_len_utf8(sv);
5237 if ((STRLEN)uoff < ulen) {
5238 forw = (STRLEN)uoff - (*cachep)[i];
5239 backw = ulen - (STRLEN)uoff;
5241 if (forw < 2 * backw)
5242 p = start + (*cachep)[i+1];
5247 /* If the string is not long enough for uoff,
5248 * we could extend it, but not at this low a level. */
5252 if (forw < 2 * backw) {
5259 while (UTF8_IS_CONTINUATION(*p))
5264 /* Update the cache. */
5265 (*cachep)[i] = (STRLEN)uoff;
5266 (*cachep)[i+1] = p - start;
5268 /* Drop the stale "length" cache */
5277 if (found) { /* Setup the return values. */
5278 *offsetp = (*cachep)[i+1];
5279 *sp = start + *offsetp;
5282 *offsetp = send - start;
5284 else if (*sp < start) {
5290 #ifdef PERL_UTF8_CACHE_ASSERT
5295 while (n-- && s < send)
5299 assert(*offsetp == s - start);
5300 assert((*cachep)[0] == (STRLEN)uoff);
5301 assert((*cachep)[1] == *offsetp);
5303 ASSERT_UTF8_CACHE(*cachep);
5312 =for apidoc sv_pos_u2b
5314 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5315 the start of the string, to a count of the equivalent number of bytes; if
5316 lenp is non-zero, it does the same to lenp, but this time starting from
5317 the offset, rather than from the start of the string. Handles magic and
5324 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5325 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5326 * byte offsets. See also the comments of S_utf8_mg_pos().
5331 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5339 start = (U8*)SvPV_const(sv, len);
5343 const U8 *s = start;
5344 I32 uoffset = *offsetp;
5345 const U8 * const send = s + len;
5349 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5351 if (!found && uoffset > 0) {
5352 while (s < send && uoffset--)
5356 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5358 *offsetp = s - start;
5363 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5367 if (!found && *lenp > 0) {
5370 while (s < send && ulen--)
5374 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5378 ASSERT_UTF8_CACHE(cache);
5390 =for apidoc sv_pos_b2u
5392 Converts the value pointed to by offsetp from a count of bytes from the
5393 start of the string, to a count of the equivalent number of UTF-8 chars.
5394 Handles magic and type coercion.
5400 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5401 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5402 * byte offsets. See also the comments of S_utf8_mg_pos().
5407 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5415 s = (const U8*)SvPV_const(sv, len);
5416 if ((I32)len < *offsetp)
5417 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5419 const U8* send = s + *offsetp;
5421 STRLEN *cache = NULL;
5425 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5426 mg = mg_find(sv, PERL_MAGIC_utf8);
5427 if (mg && mg->mg_ptr) {
5428 cache = (STRLEN *) mg->mg_ptr;
5429 if (cache[1] == (STRLEN)*offsetp) {
5430 /* An exact match. */
5431 *offsetp = cache[0];
5435 else if (cache[1] < (STRLEN)*offsetp) {
5436 /* We already know part of the way. */
5439 /* Let the below loop do the rest. */
5441 else { /* cache[1] > *offsetp */
5442 /* We already know all of the way, now we may
5443 * be able to walk back. The same assumption
5444 * is made as in S_utf8_mg_pos(), namely that
5445 * walking backward is twice slower than
5446 * walking forward. */
5447 const STRLEN forw = *offsetp;
5448 STRLEN backw = cache[1] - *offsetp;
5450 if (!(forw < 2 * backw)) {
5451 const U8 *p = s + cache[1];
5458 while (UTF8_IS_CONTINUATION(*p)) {
5466 *offsetp = cache[0];
5468 /* Drop the stale "length" cache */
5476 ASSERT_UTF8_CACHE(cache);
5482 /* Call utf8n_to_uvchr() to validate the sequence
5483 * (unless a simple non-UTF character) */
5484 if (!UTF8_IS_INVARIANT(*s))
5485 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5494 if (!SvREADONLY(sv)) {
5496 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5497 mg = mg_find(sv, PERL_MAGIC_utf8);
5502 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5503 mg->mg_ptr = (char *) cache;
5508 cache[1] = *offsetp;
5509 /* Drop the stale "length" cache */
5522 Returns a boolean indicating whether the strings in the two SVs are
5523 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5524 coerce its args to strings if necessary.
5530 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5538 SV* svrecode = Nullsv;
5545 pv1 = SvPV_const(sv1, cur1);
5552 pv2 = SvPV_const(sv2, cur2);
5554 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5555 /* Differing utf8ness.
5556 * Do not UTF8size the comparands as a side-effect. */
5559 svrecode = newSVpvn(pv2, cur2);
5560 sv_recode_to_utf8(svrecode, PL_encoding);
5561 pv2 = SvPV_const(svrecode, cur2);
5564 svrecode = newSVpvn(pv1, cur1);
5565 sv_recode_to_utf8(svrecode, PL_encoding);
5566 pv1 = SvPV_const(svrecode, cur1);
5568 /* Now both are in UTF-8. */
5570 SvREFCNT_dec(svrecode);
5575 bool is_utf8 = TRUE;
5578 /* sv1 is the UTF-8 one,
5579 * if is equal it must be downgrade-able */
5580 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5586 /* sv2 is the UTF-8 one,
5587 * if is equal it must be downgrade-able */
5588 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5594 /* Downgrade not possible - cannot be eq */
5602 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5605 SvREFCNT_dec(svrecode);
5616 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5617 string in C<sv1> is less than, equal to, or greater than the string in
5618 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5619 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5625 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5628 const char *pv1, *pv2;
5631 SV *svrecode = Nullsv;
5638 pv1 = SvPV_const(sv1, cur1);
5645 pv2 = SvPV_const(sv2, cur2);
5647 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5648 /* Differing utf8ness.
5649 * Do not UTF8size the comparands as a side-effect. */
5652 svrecode = newSVpvn(pv2, cur2);
5653 sv_recode_to_utf8(svrecode, PL_encoding);
5654 pv2 = SvPV_const(svrecode, cur2);
5657 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5662 svrecode = newSVpvn(pv1, cur1);
5663 sv_recode_to_utf8(svrecode, PL_encoding);
5664 pv1 = SvPV_const(svrecode, cur1);
5667 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5673 cmp = cur2 ? -1 : 0;
5677 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5680 cmp = retval < 0 ? -1 : 1;
5681 } else if (cur1 == cur2) {
5684 cmp = cur1 < cur2 ? -1 : 1;
5689 SvREFCNT_dec(svrecode);
5698 =for apidoc sv_cmp_locale
5700 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5701 'use bytes' aware, handles get magic, and will coerce its args to strings
5702 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5708 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5710 #ifdef USE_LOCALE_COLLATE
5716 if (PL_collation_standard)
5720 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5722 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5724 if (!pv1 || !len1) {
5735 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5738 return retval < 0 ? -1 : 1;
5741 * When the result of collation is equality, that doesn't mean
5742 * that there are no differences -- some locales exclude some
5743 * characters from consideration. So to avoid false equalities,
5744 * we use the raw string as a tiebreaker.
5750 #endif /* USE_LOCALE_COLLATE */
5752 return sv_cmp(sv1, sv2);
5756 #ifdef USE_LOCALE_COLLATE
5759 =for apidoc sv_collxfrm
5761 Add Collate Transform magic to an SV if it doesn't already have it.
5763 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5764 scalar data of the variable, but transformed to such a format that a normal
5765 memory comparison can be used to compare the data according to the locale
5772 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5776 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5777 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5783 Safefree(mg->mg_ptr);
5784 s = SvPV_const(sv, len);
5785 if ((xf = mem_collxfrm(s, len, &xlen))) {
5786 if (SvREADONLY(sv)) {
5789 return xf + sizeof(PL_collation_ix);
5792 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5793 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5806 if (mg && mg->mg_ptr) {
5808 return mg->mg_ptr + sizeof(PL_collation_ix);
5816 #endif /* USE_LOCALE_COLLATE */
5821 Get a line from the filehandle and store it into the SV, optionally
5822 appending to the currently-stored string.
5828 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5832 register STDCHAR rslast;
5833 register STDCHAR *bp;
5839 if (SvTHINKFIRST(sv))
5840 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5841 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5843 However, perlbench says it's slower, because the existing swipe code
5844 is faster than copy on write.
5845 Swings and roundabouts. */
5846 SvUPGRADE(sv, SVt_PV);
5851 if (PerlIO_isutf8(fp)) {
5853 sv_utf8_upgrade_nomg(sv);
5854 sv_pos_u2b(sv,&append,0);
5856 } else if (SvUTF8(sv)) {
5857 SV * const tsv = NEWSV(0,0);
5858 sv_gets(tsv, fp, 0);
5859 sv_utf8_upgrade_nomg(tsv);
5860 SvCUR_set(sv,append);
5863 goto return_string_or_null;
5868 if (PerlIO_isutf8(fp))
5871 if (IN_PERL_COMPILETIME) {
5872 /* we always read code in line mode */
5876 else if (RsSNARF(PL_rs)) {
5877 /* If it is a regular disk file use size from stat() as estimate
5878 of amount we are going to read - may result in malloc-ing
5879 more memory than we realy need if layers bellow reduce
5880 size we read (e.g. CRLF or a gzip layer)
5883 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5884 const Off_t offset = PerlIO_tell(fp);
5885 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5886 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5892 else if (RsRECORD(PL_rs)) {
5896 /* Grab the size of the record we're getting */
5897 recsize = SvIV(SvRV(PL_rs));
5898 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5901 /* VMS wants read instead of fread, because fread doesn't respect */
5902 /* RMS record boundaries. This is not necessarily a good thing to be */
5903 /* doing, but we've got no other real choice - except avoid stdio
5904 as implementation - perhaps write a :vms layer ?
5906 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5908 bytesread = PerlIO_read(fp, buffer, recsize);
5912 SvCUR_set(sv, bytesread += append);
5913 buffer[bytesread] = '\0';
5914 goto return_string_or_null;
5916 else if (RsPARA(PL_rs)) {
5922 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5923 if (PerlIO_isutf8(fp)) {
5924 rsptr = SvPVutf8(PL_rs, rslen);
5927 if (SvUTF8(PL_rs)) {
5928 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5929 Perl_croak(aTHX_ "Wide character in $/");
5932 rsptr = SvPV_const(PL_rs, rslen);
5936 rslast = rslen ? rsptr[rslen - 1] : '\0';
5938 if (rspara) { /* have to do this both before and after */
5939 do { /* to make sure file boundaries work right */
5942 i = PerlIO_getc(fp);
5946 PerlIO_ungetc(fp,i);
5952 /* See if we know enough about I/O mechanism to cheat it ! */
5954 /* This used to be #ifdef test - it is made run-time test for ease
5955 of abstracting out stdio interface. One call should be cheap
5956 enough here - and may even be a macro allowing compile
5960 if (PerlIO_fast_gets(fp)) {
5963 * We're going to steal some values from the stdio struct
5964 * and put EVERYTHING in the innermost loop into registers.
5966 register STDCHAR *ptr;
5970 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5971 /* An ungetc()d char is handled separately from the regular
5972 * buffer, so we getc() it back out and stuff it in the buffer.
5974 i = PerlIO_getc(fp);
5975 if (i == EOF) return 0;
5976 *(--((*fp)->_ptr)) = (unsigned char) i;
5980 /* Here is some breathtakingly efficient cheating */
5982 cnt = PerlIO_get_cnt(fp); /* get count into register */
5983 /* make sure we have the room */
5984 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5985 /* Not room for all of it
5986 if we are looking for a separator and room for some
5988 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5989 /* just process what we have room for */
5990 shortbuffered = cnt - SvLEN(sv) + append + 1;
5991 cnt -= shortbuffered;
5995 /* remember that cnt can be negative */
5996 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6001 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6002 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6003 DEBUG_P(PerlIO_printf(Perl_debug_log,
6004 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6005 DEBUG_P(PerlIO_printf(Perl_debug_log,
6006 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6007 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6008 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6013 while (cnt > 0) { /* this | eat */
6015 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6016 goto thats_all_folks; /* screams | sed :-) */
6020 Copy(ptr, bp, cnt, char); /* this | eat */
6021 bp += cnt; /* screams | dust */
6022 ptr += cnt; /* louder | sed :-) */
6027 if (shortbuffered) { /* oh well, must extend */
6028 cnt = shortbuffered;
6030 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6032 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6033 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6037 DEBUG_P(PerlIO_printf(Perl_debug_log,
6038 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6039 PTR2UV(ptr),(long)cnt));
6040 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6042 DEBUG_P(PerlIO_printf(Perl_debug_log,
6043 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6044 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6045 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6047 /* This used to call 'filbuf' in stdio form, but as that behaves like
6048 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6049 another abstraction. */
6050 i = PerlIO_getc(fp); /* get more characters */
6052 DEBUG_P(PerlIO_printf(Perl_debug_log,
6053 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6054 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6055 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6057 cnt = PerlIO_get_cnt(fp);
6058 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6059 DEBUG_P(PerlIO_printf(Perl_debug_log,
6060 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6062 if (i == EOF) /* all done for ever? */
6063 goto thats_really_all_folks;
6065 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6067 SvGROW(sv, bpx + cnt + 2);
6068 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6070 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6072 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6073 goto thats_all_folks;
6077 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6078 memNE((char*)bp - rslen, rsptr, rslen))
6079 goto screamer; /* go back to the fray */
6080 thats_really_all_folks:
6082 cnt += shortbuffered;
6083 DEBUG_P(PerlIO_printf(Perl_debug_log,
6084 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6085 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6086 DEBUG_P(PerlIO_printf(Perl_debug_log,
6087 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6088 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6089 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6091 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6092 DEBUG_P(PerlIO_printf(Perl_debug_log,
6093 "Screamer: done, len=%ld, string=|%.*s|\n",
6094 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6098 /*The big, slow, and stupid way. */
6099 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6101 Newx(buf, 8192, STDCHAR);
6109 register const STDCHAR *bpe = buf + sizeof(buf);
6111 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6112 ; /* keep reading */
6116 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6117 /* Accomodate broken VAXC compiler, which applies U8 cast to
6118 * both args of ?: operator, causing EOF to change into 255
6121 i = (U8)buf[cnt - 1];
6127 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6129 sv_catpvn(sv, (char *) buf, cnt);
6131 sv_setpvn(sv, (char *) buf, cnt);
6133 if (i != EOF && /* joy */
6135 SvCUR(sv) < rslen ||
6136 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6140 * If we're reading from a TTY and we get a short read,
6141 * indicating that the user hit his EOF character, we need
6142 * to notice it now, because if we try to read from the TTY
6143 * again, the EOF condition will disappear.
6145 * The comparison of cnt to sizeof(buf) is an optimization
6146 * that prevents unnecessary calls to feof().
6150 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6154 #ifdef USE_HEAP_INSTEAD_OF_STACK
6159 if (rspara) { /* have to do this both before and after */
6160 while (i != EOF) { /* to make sure file boundaries work right */
6161 i = PerlIO_getc(fp);
6163 PerlIO_ungetc(fp,i);
6169 return_string_or_null:
6170 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6176 Auto-increment of the value in the SV, doing string to numeric conversion
6177 if necessary. Handles 'get' magic.
6183 Perl_sv_inc(pTHX_ register SV *sv)
6191 if (SvTHINKFIRST(sv)) {
6193 sv_force_normal_flags(sv, 0);
6194 if (SvREADONLY(sv)) {
6195 if (IN_PERL_RUNTIME)
6196 Perl_croak(aTHX_ PL_no_modify);
6200 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6202 i = PTR2IV(SvRV(sv));
6207 flags = SvFLAGS(sv);
6208 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6209 /* It's (privately or publicly) a float, but not tested as an
6210 integer, so test it to see. */
6212 flags = SvFLAGS(sv);
6214 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6215 /* It's publicly an integer, or privately an integer-not-float */
6216 #ifdef PERL_PRESERVE_IVUV
6220 if (SvUVX(sv) == UV_MAX)
6221 sv_setnv(sv, UV_MAX_P1);
6223 (void)SvIOK_only_UV(sv);
6224 SvUV_set(sv, SvUVX(sv) + 1);
6226 if (SvIVX(sv) == IV_MAX)
6227 sv_setuv(sv, (UV)IV_MAX + 1);
6229 (void)SvIOK_only(sv);
6230 SvIV_set(sv, SvIVX(sv) + 1);
6235 if (flags & SVp_NOK) {
6236 (void)SvNOK_only(sv);
6237 SvNV_set(sv, SvNVX(sv) + 1.0);
6241 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6242 if ((flags & SVTYPEMASK) < SVt_PVIV)
6243 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6244 (void)SvIOK_only(sv);
6249 while (isALPHA(*d)) d++;
6250 while (isDIGIT(*d)) d++;
6252 #ifdef PERL_PRESERVE_IVUV
6253 /* Got to punt this as an integer if needs be, but we don't issue
6254 warnings. Probably ought to make the sv_iv_please() that does
6255 the conversion if possible, and silently. */
6256 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6257 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6258 /* Need to try really hard to see if it's an integer.
6259 9.22337203685478e+18 is an integer.
6260 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6261 so $a="9.22337203685478e+18"; $a+0; $a++
6262 needs to be the same as $a="9.22337203685478e+18"; $a++
6269 /* sv_2iv *should* have made this an NV */
6270 if (flags & SVp_NOK) {
6271 (void)SvNOK_only(sv);
6272 SvNV_set(sv, SvNVX(sv) + 1.0);
6275 /* I don't think we can get here. Maybe I should assert this
6276 And if we do get here I suspect that sv_setnv will croak. NWC
6278 #if defined(USE_LONG_DOUBLE)
6279 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",
6280 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6282 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6283 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6286 #endif /* PERL_PRESERVE_IVUV */
6287 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6291 while (d >= SvPVX_const(sv)) {
6299 /* MKS: The original code here died if letters weren't consecutive.
6300 * at least it didn't have to worry about non-C locales. The
6301 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6302 * arranged in order (although not consecutively) and that only
6303 * [A-Za-z] are accepted by isALPHA in the C locale.
6305 if (*d != 'z' && *d != 'Z') {
6306 do { ++*d; } while (!isALPHA(*d));
6309 *(d--) -= 'z' - 'a';
6314 *(d--) -= 'z' - 'a' + 1;
6318 /* oh,oh, the number grew */
6319 SvGROW(sv, SvCUR(sv) + 2);
6320 SvCUR_set(sv, SvCUR(sv) + 1);
6321 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6332 Auto-decrement of the value in the SV, doing string to numeric conversion
6333 if necessary. Handles 'get' magic.
6339 Perl_sv_dec(pTHX_ register SV *sv)
6346 if (SvTHINKFIRST(sv)) {
6348 sv_force_normal_flags(sv, 0);
6349 if (SvREADONLY(sv)) {
6350 if (IN_PERL_RUNTIME)
6351 Perl_croak(aTHX_ PL_no_modify);
6355 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6357 i = PTR2IV(SvRV(sv));
6362 /* Unlike sv_inc we don't have to worry about string-never-numbers
6363 and keeping them magic. But we mustn't warn on punting */
6364 flags = SvFLAGS(sv);
6365 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6366 /* It's publicly an integer, or privately an integer-not-float */
6367 #ifdef PERL_PRESERVE_IVUV
6371 if (SvUVX(sv) == 0) {
6372 (void)SvIOK_only(sv);
6376 (void)SvIOK_only_UV(sv);
6377 SvUV_set(sv, SvUVX(sv) - 1);
6380 if (SvIVX(sv) == IV_MIN)
6381 sv_setnv(sv, (NV)IV_MIN - 1.0);
6383 (void)SvIOK_only(sv);
6384 SvIV_set(sv, SvIVX(sv) - 1);
6389 if (flags & SVp_NOK) {
6390 SvNV_set(sv, SvNVX(sv) - 1.0);
6391 (void)SvNOK_only(sv);
6394 if (!(flags & SVp_POK)) {
6395 if ((flags & SVTYPEMASK) < SVt_PVIV)
6396 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6398 (void)SvIOK_only(sv);
6401 #ifdef PERL_PRESERVE_IVUV
6403 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6404 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6405 /* Need to try really hard to see if it's an integer.
6406 9.22337203685478e+18 is an integer.
6407 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6408 so $a="9.22337203685478e+18"; $a+0; $a--
6409 needs to be the same as $a="9.22337203685478e+18"; $a--
6416 /* sv_2iv *should* have made this an NV */
6417 if (flags & SVp_NOK) {
6418 (void)SvNOK_only(sv);
6419 SvNV_set(sv, SvNVX(sv) - 1.0);
6422 /* I don't think we can get here. Maybe I should assert this
6423 And if we do get here I suspect that sv_setnv will croak. NWC
6425 #if defined(USE_LONG_DOUBLE)
6426 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",
6427 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6429 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6430 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6434 #endif /* PERL_PRESERVE_IVUV */
6435 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6439 =for apidoc sv_mortalcopy
6441 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6442 The new SV is marked as mortal. It will be destroyed "soon", either by an
6443 explicit call to FREETMPS, or by an implicit call at places such as
6444 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6449 /* Make a string that will exist for the duration of the expression
6450 * evaluation. Actually, it may have to last longer than that, but
6451 * hopefully we won't free it until it has been assigned to a
6452 * permanent location. */
6455 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6460 sv_setsv(sv,oldstr);
6462 PL_tmps_stack[++PL_tmps_ix] = sv;
6468 =for apidoc sv_newmortal
6470 Creates a new null SV which is mortal. The reference count of the SV is
6471 set to 1. It will be destroyed "soon", either by an explicit call to
6472 FREETMPS, or by an implicit call at places such as statement boundaries.
6473 See also C<sv_mortalcopy> and C<sv_2mortal>.
6479 Perl_sv_newmortal(pTHX)
6484 SvFLAGS(sv) = SVs_TEMP;
6486 PL_tmps_stack[++PL_tmps_ix] = sv;
6491 =for apidoc sv_2mortal
6493 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6494 by an explicit call to FREETMPS, or by an implicit call at places such as
6495 statement boundaries. SvTEMP() is turned on which means that the SV's
6496 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6497 and C<sv_mortalcopy>.
6503 Perl_sv_2mortal(pTHX_ register SV *sv)
6508 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6511 PL_tmps_stack[++PL_tmps_ix] = sv;
6519 Creates a new SV and copies a string into it. The reference count for the
6520 SV is set to 1. If C<len> is zero, Perl will compute the length using
6521 strlen(). For efficiency, consider using C<newSVpvn> instead.
6527 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6532 sv_setpvn(sv,s,len ? len : strlen(s));
6537 =for apidoc newSVpvn
6539 Creates a new SV and copies a string into it. The reference count for the
6540 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6541 string. You are responsible for ensuring that the source string is at least
6542 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6548 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6553 sv_setpvn(sv,s,len);
6559 =for apidoc newSVhek
6561 Creates a new SV from the hash key structure. It will generate scalars that
6562 point to the shared string table where possible. Returns a new (undefined)
6563 SV if the hek is NULL.
6569 Perl_newSVhek(pTHX_ const HEK *hek)
6578 if (HEK_LEN(hek) == HEf_SVKEY) {
6579 return newSVsv(*(SV**)HEK_KEY(hek));
6581 const int flags = HEK_FLAGS(hek);
6582 if (flags & HVhek_WASUTF8) {
6584 Andreas would like keys he put in as utf8 to come back as utf8
6586 STRLEN utf8_len = HEK_LEN(hek);
6587 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6588 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6591 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6593 } else if (flags & HVhek_REHASH) {
6594 /* We don't have a pointer to the hv, so we have to replicate the
6595 flag into every HEK. This hv is using custom a hasing
6596 algorithm. Hence we can't return a shared string scalar, as
6597 that would contain the (wrong) hash value, and might get passed
6598 into an hv routine with a regular hash */
6600 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6605 /* This will be overwhelminly the most common case. */
6606 return newSVpvn_share(HEK_KEY(hek),
6607 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6613 =for apidoc newSVpvn_share
6615 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6616 table. If the string does not already exist in the table, it is created
6617 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6618 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6619 otherwise the hash is computed. The idea here is that as the string table
6620 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6621 hash lookup will avoid string compare.
6627 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6630 bool is_utf8 = FALSE;
6632 STRLEN tmplen = -len;
6634 /* See the note in hv.c:hv_fetch() --jhi */
6635 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6639 PERL_HASH(hash, src, len);
6641 sv_upgrade(sv, SVt_PV);
6642 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6654 #if defined(PERL_IMPLICIT_CONTEXT)
6656 /* pTHX_ magic can't cope with varargs, so this is a no-context
6657 * version of the main function, (which may itself be aliased to us).
6658 * Don't access this version directly.
6662 Perl_newSVpvf_nocontext(const char* pat, ...)
6667 va_start(args, pat);
6668 sv = vnewSVpvf(pat, &args);
6675 =for apidoc newSVpvf
6677 Creates a new SV and initializes it with the string formatted like
6684 Perl_newSVpvf(pTHX_ const char* pat, ...)
6688 va_start(args, pat);
6689 sv = vnewSVpvf(pat, &args);
6694 /* backend for newSVpvf() and newSVpvf_nocontext() */
6697 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6701 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6708 Creates a new SV and copies a floating point value into it.
6709 The reference count for the SV is set to 1.
6715 Perl_newSVnv(pTHX_ NV n)
6727 Creates a new SV and copies an integer into it. The reference count for the
6734 Perl_newSViv(pTHX_ IV i)
6746 Creates a new SV and copies an unsigned integer into it.
6747 The reference count for the SV is set to 1.
6753 Perl_newSVuv(pTHX_ UV u)
6763 =for apidoc newRV_noinc
6765 Creates an RV wrapper for an SV. The reference count for the original
6766 SV is B<not> incremented.
6772 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6777 sv_upgrade(sv, SVt_RV);
6779 SvRV_set(sv, tmpRef);
6784 /* newRV_inc is the official function name to use now.
6785 * newRV_inc is in fact #defined to newRV in sv.h
6789 Perl_newRV(pTHX_ SV *tmpRef)
6791 return newRV_noinc(SvREFCNT_inc(tmpRef));
6797 Creates a new SV which is an exact duplicate of the original SV.
6804 Perl_newSVsv(pTHX_ register SV *old)
6810 if (SvTYPE(old) == SVTYPEMASK) {
6811 if (ckWARN_d(WARN_INTERNAL))
6812 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6816 /* SV_GMAGIC is the default for sv_setv()
6817 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6818 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6819 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6824 =for apidoc sv_reset
6826 Underlying implementation for the C<reset> Perl function.
6827 Note that the perl-level function is vaguely deprecated.
6833 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6836 char todo[PERL_UCHAR_MAX+1];
6841 if (!*s) { /* reset ?? searches */
6842 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6844 PMOP *pm = (PMOP *) mg->mg_obj;
6846 pm->op_pmdynflags &= ~PMdf_USED;
6853 /* reset variables */
6855 if (!HvARRAY(stash))
6858 Zero(todo, 256, char);
6861 I32 i = (unsigned char)*s;
6865 max = (unsigned char)*s++;
6866 for ( ; i <= max; i++) {
6869 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6871 for (entry = HvARRAY(stash)[i];
6873 entry = HeNEXT(entry))
6878 if (!todo[(U8)*HeKEY(entry)])
6880 gv = (GV*)HeVAL(entry);
6883 if (SvTHINKFIRST(sv)) {
6884 if (!SvREADONLY(sv) && SvROK(sv))
6886 /* XXX Is this continue a bug? Why should THINKFIRST
6887 exempt us from resetting arrays and hashes? */
6891 if (SvTYPE(sv) >= SVt_PV) {
6893 if (SvPVX_const(sv) != Nullch)
6901 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6903 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6906 # if defined(USE_ENVIRON_ARRAY)
6909 # endif /* USE_ENVIRON_ARRAY */
6920 Using various gambits, try to get an IO from an SV: the IO slot if its a
6921 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6922 named after the PV if we're a string.
6928 Perl_sv_2io(pTHX_ SV *sv)
6933 switch (SvTYPE(sv)) {
6941 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6945 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6947 return sv_2io(SvRV(sv));
6948 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6954 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6963 Using various gambits, try to get a CV from an SV; in addition, try if
6964 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6970 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6977 return *gvp = Nullgv, Nullcv;
6978 switch (SvTYPE(sv)) {
6996 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6997 tryAMAGICunDEREF(to_cv);
7000 if (SvTYPE(sv) == SVt_PVCV) {
7009 Perl_croak(aTHX_ "Not a subroutine reference");
7014 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7020 if (lref && !GvCVu(gv)) {
7023 tmpsv = NEWSV(704,0);
7024 gv_efullname3(tmpsv, gv, Nullch);
7025 /* XXX this is probably not what they think they're getting.
7026 * It has the same effect as "sub name;", i.e. just a forward
7028 newSUB(start_subparse(FALSE, 0),
7029 newSVOP(OP_CONST, 0, tmpsv),
7034 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7044 Returns true if the SV has a true value by Perl's rules.
7045 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7046 instead use an in-line version.
7052 Perl_sv_true(pTHX_ register SV *sv)
7057 register const XPV* const tXpv = (XPV*)SvANY(sv);
7059 (tXpv->xpv_cur > 1 ||
7060 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7067 return SvIVX(sv) != 0;
7070 return SvNVX(sv) != 0.0;
7072 return sv_2bool(sv);
7078 =for apidoc sv_pvn_force
7080 Get a sensible string out of the SV somehow.
7081 A private implementation of the C<SvPV_force> macro for compilers which
7082 can't cope with complex macro expressions. Always use the macro instead.
7084 =for apidoc sv_pvn_force_flags
7086 Get a sensible string out of the SV somehow.
7087 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7088 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7089 implemented in terms of this function.
7090 You normally want to use the various wrapper macros instead: see
7091 C<SvPV_force> and C<SvPV_force_nomg>
7097 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7100 if (SvTHINKFIRST(sv) && !SvROK(sv))
7101 sv_force_normal_flags(sv, 0);
7111 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7112 const char * const ref = sv_reftype(sv,0);
7114 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7115 ref, OP_NAME(PL_op));
7117 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7119 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7120 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7122 s = sv_2pv_flags(sv, &len, flags);
7126 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7129 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7130 SvGROW(sv, len + 1);
7131 Move(s,SvPVX(sv),len,char);
7136 SvPOK_on(sv); /* validate pointer */
7138 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7139 PTR2UV(sv),SvPVX_const(sv)));
7142 return SvPVX_mutable(sv);
7146 =for apidoc sv_pvbyten_force
7148 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7154 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7156 sv_pvn_force(sv,lp);
7157 sv_utf8_downgrade(sv,0);
7163 =for apidoc sv_pvutf8n_force
7165 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7171 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7173 sv_pvn_force(sv,lp);
7174 sv_utf8_upgrade(sv);
7180 =for apidoc sv_reftype
7182 Returns a string describing what the SV is a reference to.
7188 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7190 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7191 inside return suggests a const propagation bug in g++. */
7192 if (ob && SvOBJECT(sv)) {
7193 char * const name = HvNAME_get(SvSTASH(sv));
7194 return name ? name : (char *) "__ANON__";
7197 switch (SvTYPE(sv)) {
7214 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7215 /* tied lvalues should appear to be
7216 * scalars for backwards compatitbility */
7217 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7218 ? "SCALAR" : "LVALUE");
7219 case SVt_PVAV: return "ARRAY";
7220 case SVt_PVHV: return "HASH";
7221 case SVt_PVCV: return "CODE";
7222 case SVt_PVGV: return "GLOB";
7223 case SVt_PVFM: return "FORMAT";
7224 case SVt_PVIO: return "IO";
7225 default: return "UNKNOWN";
7231 =for apidoc sv_isobject
7233 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7234 object. If the SV is not an RV, or if the object is not blessed, then this
7241 Perl_sv_isobject(pTHX_ SV *sv)
7257 Returns a boolean indicating whether the SV is blessed into the specified
7258 class. This does not check for subtypes; use C<sv_derived_from> to verify
7259 an inheritance relationship.
7265 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7276 hvname = HvNAME_get(SvSTASH(sv));
7280 return strEQ(hvname, name);
7286 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7287 it will be upgraded to one. If C<classname> is non-null then the new SV will
7288 be blessed in the specified package. The new SV is returned and its
7289 reference count is 1.
7295 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7301 SV_CHECK_THINKFIRST_COW_DROP(rv);
7304 if (SvTYPE(rv) >= SVt_PVMG) {
7305 const U32 refcnt = SvREFCNT(rv);
7309 SvREFCNT(rv) = refcnt;
7312 if (SvTYPE(rv) < SVt_RV)
7313 sv_upgrade(rv, SVt_RV);
7314 else if (SvTYPE(rv) > SVt_RV) {
7325 HV* const stash = gv_stashpv(classname, TRUE);
7326 (void)sv_bless(rv, stash);
7332 =for apidoc sv_setref_pv
7334 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7335 argument will be upgraded to an RV. That RV will be modified to point to
7336 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7337 into the SV. The C<classname> argument indicates the package for the
7338 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7339 will have a reference count of 1, and the RV will be returned.
7341 Do not use with other Perl types such as HV, AV, SV, CV, because those
7342 objects will become corrupted by the pointer copy process.
7344 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7350 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7353 sv_setsv(rv, &PL_sv_undef);
7357 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7362 =for apidoc sv_setref_iv
7364 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7365 argument will be upgraded to an RV. That RV will be modified to point to
7366 the new SV. The C<classname> argument indicates the package for the
7367 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7368 will have a reference count of 1, and the RV will be returned.
7374 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7376 sv_setiv(newSVrv(rv,classname), iv);
7381 =for apidoc sv_setref_uv
7383 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7384 argument will be upgraded to an RV. That RV will be modified to point to
7385 the new SV. The C<classname> argument indicates the package for the
7386 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7387 will have a reference count of 1, and the RV will be returned.
7393 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7395 sv_setuv(newSVrv(rv,classname), uv);
7400 =for apidoc sv_setref_nv
7402 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7403 argument will be upgraded to an RV. That RV will be modified to point to
7404 the new SV. The C<classname> argument indicates the package for the
7405 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7406 will have a reference count of 1, and the RV will be returned.
7412 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7414 sv_setnv(newSVrv(rv,classname), nv);
7419 =for apidoc sv_setref_pvn
7421 Copies a string into a new SV, optionally blessing the SV. The length of the
7422 string must be specified with C<n>. The C<rv> argument will be upgraded to
7423 an RV. That RV will be modified to point to the new SV. The C<classname>
7424 argument indicates the package for the blessing. Set C<classname> to
7425 C<Nullch> to avoid the blessing. The new SV will have a reference count
7426 of 1, and the RV will be returned.
7428 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7434 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7436 sv_setpvn(newSVrv(rv,classname), pv, n);
7441 =for apidoc sv_bless
7443 Blesses an SV into a specified package. The SV must be an RV. The package
7444 must be designated by its stash (see C<gv_stashpv()>). The reference count
7445 of the SV is unaffected.
7451 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7455 Perl_croak(aTHX_ "Can't bless non-reference value");
7457 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7458 if (SvREADONLY(tmpRef))
7459 Perl_croak(aTHX_ PL_no_modify);
7460 if (SvOBJECT(tmpRef)) {
7461 if (SvTYPE(tmpRef) != SVt_PVIO)
7463 SvREFCNT_dec(SvSTASH(tmpRef));
7466 SvOBJECT_on(tmpRef);
7467 if (SvTYPE(tmpRef) != SVt_PVIO)
7469 SvUPGRADE(tmpRef, SVt_PVMG);
7470 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7477 if(SvSMAGICAL(tmpRef))
7478 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7486 /* Downgrades a PVGV to a PVMG.
7490 S_sv_unglob(pTHX_ SV *sv)
7494 assert(SvTYPE(sv) == SVt_PVGV);
7499 sv_del_backref((SV*)GvSTASH(sv), sv);
7500 GvSTASH(sv) = Nullhv;
7502 sv_unmagic(sv, PERL_MAGIC_glob);
7503 Safefree(GvNAME(sv));
7506 /* need to keep SvANY(sv) in the right arena */
7507 xpvmg = new_XPVMG();
7508 StructCopy(SvANY(sv), xpvmg, XPVMG);
7509 del_XPVGV(SvANY(sv));
7512 SvFLAGS(sv) &= ~SVTYPEMASK;
7513 SvFLAGS(sv) |= SVt_PVMG;
7517 =for apidoc sv_unref_flags
7519 Unsets the RV status of the SV, and decrements the reference count of
7520 whatever was being referenced by the RV. This can almost be thought of
7521 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7522 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7523 (otherwise the decrementing is conditional on the reference count being
7524 different from one or the reference being a readonly SV).
7531 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7533 SV* const target = SvRV(ref);
7535 if (SvWEAKREF(ref)) {
7536 sv_del_backref(target, ref);
7538 SvRV_set(ref, NULL);
7541 SvRV_set(ref, NULL);
7543 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7544 assigned to as BEGIN {$a = \"Foo"} will fail. */
7545 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7546 SvREFCNT_dec(target);
7547 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7548 sv_2mortal(target); /* Schedule for freeing later */
7552 =for apidoc sv_untaint
7554 Untaint an SV. Use C<SvTAINTED_off> instead.
7559 Perl_sv_untaint(pTHX_ SV *sv)
7561 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7562 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7569 =for apidoc sv_tainted
7571 Test an SV for taintedness. Use C<SvTAINTED> instead.
7576 Perl_sv_tainted(pTHX_ SV *sv)
7578 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7579 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7580 if (mg && (mg->mg_len & 1) )
7587 =for apidoc sv_setpviv
7589 Copies an integer into the given SV, also updating its string value.
7590 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7596 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7598 char buf[TYPE_CHARS(UV)];
7600 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7602 sv_setpvn(sv, ptr, ebuf - ptr);
7606 =for apidoc sv_setpviv_mg
7608 Like C<sv_setpviv>, but also handles 'set' magic.
7614 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7620 #if defined(PERL_IMPLICIT_CONTEXT)
7622 /* pTHX_ magic can't cope with varargs, so this is a no-context
7623 * version of the main function, (which may itself be aliased to us).
7624 * Don't access this version directly.
7628 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7632 va_start(args, pat);
7633 sv_vsetpvf(sv, pat, &args);
7637 /* pTHX_ magic can't cope with varargs, so this is a no-context
7638 * version of the main function, (which may itself be aliased to us).
7639 * Don't access this version directly.
7643 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7647 va_start(args, pat);
7648 sv_vsetpvf_mg(sv, pat, &args);
7654 =for apidoc sv_setpvf
7656 Works like C<sv_catpvf> but copies the text into the SV instead of
7657 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7663 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7666 va_start(args, pat);
7667 sv_vsetpvf(sv, pat, &args);
7672 =for apidoc sv_vsetpvf
7674 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7675 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7677 Usually used via its frontend C<sv_setpvf>.
7683 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7685 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7689 =for apidoc sv_setpvf_mg
7691 Like C<sv_setpvf>, but also handles 'set' magic.
7697 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7700 va_start(args, pat);
7701 sv_vsetpvf_mg(sv, pat, &args);
7706 =for apidoc sv_vsetpvf_mg
7708 Like C<sv_vsetpvf>, but also handles 'set' magic.
7710 Usually used via its frontend C<sv_setpvf_mg>.
7716 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7718 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7722 #if defined(PERL_IMPLICIT_CONTEXT)
7724 /* pTHX_ magic can't cope with varargs, so this is a no-context
7725 * version of the main function, (which may itself be aliased to us).
7726 * Don't access this version directly.
7730 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7734 va_start(args, pat);
7735 sv_vcatpvf(sv, pat, &args);
7739 /* pTHX_ magic can't cope with varargs, so this is a no-context
7740 * version of the main function, (which may itself be aliased to us).
7741 * Don't access this version directly.
7745 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7749 va_start(args, pat);
7750 sv_vcatpvf_mg(sv, pat, &args);
7756 =for apidoc sv_catpvf
7758 Processes its arguments like C<sprintf> and appends the formatted
7759 output to an SV. If the appended data contains "wide" characters
7760 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7761 and characters >255 formatted with %c), the original SV might get
7762 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7763 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7764 valid UTF-8; if the original SV was bytes, the pattern should be too.
7769 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7772 va_start(args, pat);
7773 sv_vcatpvf(sv, pat, &args);
7778 =for apidoc sv_vcatpvf
7780 Processes its arguments like C<vsprintf> and appends the formatted output
7781 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7783 Usually used via its frontend C<sv_catpvf>.
7789 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7791 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7795 =for apidoc sv_catpvf_mg
7797 Like C<sv_catpvf>, but also handles 'set' magic.
7803 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7806 va_start(args, pat);
7807 sv_vcatpvf_mg(sv, pat, &args);
7812 =for apidoc sv_vcatpvf_mg
7814 Like C<sv_vcatpvf>, but also handles 'set' magic.
7816 Usually used via its frontend C<sv_catpvf_mg>.
7822 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7824 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7829 =for apidoc sv_vsetpvfn
7831 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7834 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7840 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7842 sv_setpvn(sv, "", 0);
7843 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7846 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7849 S_expect_number(pTHX_ char** pattern)
7852 switch (**pattern) {
7853 case '1': case '2': case '3':
7854 case '4': case '5': case '6':
7855 case '7': case '8': case '9':
7856 while (isDIGIT(**pattern))
7857 var = var * 10 + (*(*pattern)++ - '0');
7861 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7864 F0convert(NV nv, char *endbuf, STRLEN *len)
7866 const int neg = nv < 0;
7875 if (uv & 1 && uv == nv)
7876 uv--; /* Round to even */
7878 const unsigned dig = uv % 10;
7891 =for apidoc sv_vcatpvfn
7893 Processes its arguments like C<vsprintf> and appends the formatted output
7894 to an SV. Uses an array of SVs if the C style variable argument list is
7895 missing (NULL). When running with taint checks enabled, indicates via
7896 C<maybe_tainted> if results are untrustworthy (often due to the use of
7899 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7905 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7906 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7907 vec_utf8 = DO_UTF8(vecsv);
7909 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7912 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7919 static const char nullstr[] = "(null)";
7921 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7922 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7924 /* Times 4: a decimal digit takes more than 3 binary digits.
7925 * NV_DIG: mantissa takes than many decimal digits.
7926 * Plus 32: Playing safe. */
7927 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7928 /* large enough for "%#.#f" --chip */
7929 /* what about long double NVs? --jhi */
7931 PERL_UNUSED_ARG(maybe_tainted);
7933 /* no matter what, this is a string now */
7934 (void)SvPV_force(sv, origlen);
7936 /* special-case "", "%s", and "%-p" (SVf - see below) */
7939 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7941 const char * const s = va_arg(*args, char*);
7942 sv_catpv(sv, s ? s : nullstr);
7944 else if (svix < svmax) {
7945 sv_catsv(sv, *svargs);
7949 if (args && patlen == 3 && pat[0] == '%' &&
7950 pat[1] == '-' && pat[2] == 'p') {
7951 argsv = va_arg(*args, SV*);
7952 sv_catsv(sv, argsv);
7956 #ifndef USE_LONG_DOUBLE
7957 /* special-case "%.<number>[gf]" */
7958 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7959 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7960 unsigned digits = 0;
7964 while (*pp >= '0' && *pp <= '9')
7965 digits = 10 * digits + (*pp++ - '0');
7966 if (pp - pat == (int)patlen - 1) {
7974 /* Add check for digits != 0 because it seems that some
7975 gconverts are buggy in this case, and we don't yet have
7976 a Configure test for this. */
7977 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7978 /* 0, point, slack */
7979 Gconvert(nv, (int)digits, 0, ebuf);
7981 if (*ebuf) /* May return an empty string for digits==0 */
7984 } else if (!digits) {
7987 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7988 sv_catpvn(sv, p, l);
7994 #endif /* !USE_LONG_DOUBLE */
7996 if (!args && svix < svmax && DO_UTF8(*svargs))
7999 patend = (char*)pat + patlen;
8000 for (p = (char*)pat; p < patend; p = q) {
8003 bool vectorize = FALSE;
8004 bool vectorarg = FALSE;
8005 bool vec_utf8 = FALSE;
8011 bool has_precis = FALSE;
8014 bool is_utf8 = FALSE; /* is this item utf8? */
8015 #ifdef HAS_LDBL_SPRINTF_BUG
8016 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8017 with sfio - Allen <allens@cpan.org> */
8018 bool fix_ldbl_sprintf_bug = FALSE;
8022 U8 utf8buf[UTF8_MAXBYTES+1];
8023 STRLEN esignlen = 0;
8025 const char *eptr = Nullch;
8028 const U8 *vecstr = Null(U8*);
8035 /* we need a long double target in case HAS_LONG_DOUBLE but
8038 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8046 const char *dotstr = ".";
8047 STRLEN dotstrlen = 1;
8048 I32 efix = 0; /* explicit format parameter index */
8049 I32 ewix = 0; /* explicit width index */
8050 I32 epix = 0; /* explicit precision index */
8051 I32 evix = 0; /* explicit vector index */
8052 bool asterisk = FALSE;
8054 /* echo everything up to the next format specification */
8055 for (q = p; q < patend && *q != '%'; ++q) ;
8057 if (has_utf8 && !pat_utf8)
8058 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8060 sv_catpvn(sv, p, q - p);
8067 We allow format specification elements in this order:
8068 \d+\$ explicit format parameter index
8070 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8071 0 flag (as above): repeated to allow "v02"
8072 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8073 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8075 [%bcdefginopsuxDFOUX] format (mandatory)
8080 As of perl5.9.3, printf format checking is on by default.
8081 Internally, perl uses %p formats to provide an escape to
8082 some extended formatting. This block deals with those
8083 extensions: if it does not match, (char*)q is reset and
8084 the normal format processing code is used.
8086 Currently defined extensions are:
8087 %p include pointer address (standard)
8088 %-p (SVf) include an SV (previously %_)
8089 %-<num>p include an SV with precision <num>
8090 %1p (VDf) include a v-string (as %vd)
8091 %<num>p reserved for future extensions
8093 Robin Barker 2005-07-14
8100 EXPECT_NUMBER(q, n);
8107 argsv = va_arg(*args, SV*);
8108 eptr = SvPVx_const(argsv, elen);
8114 else if (n == vdNUMBER) { /* VDf */
8121 if (ckWARN_d(WARN_INTERNAL))
8122 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8123 "internal %%<num>p might conflict with future printf extensions");
8129 if (EXPECT_NUMBER(q, width)) {
8170 if (EXPECT_NUMBER(q, ewix))
8179 if ((vectorarg = asterisk)) {
8192 EXPECT_NUMBER(q, width);
8198 vecsv = va_arg(*args, SV*);
8200 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8201 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8202 dotstr = SvPV_const(vecsv, dotstrlen);
8209 else if (efix ? efix <= svmax : svix < svmax) {
8210 vecsv = svargs[efix ? efix-1 : svix++];
8211 vecstr = (U8*)SvPV_const(vecsv,veclen);
8212 vec_utf8 = DO_UTF8(vecsv);
8213 /* if this is a version object, we need to return the
8214 * stringified representation (which the SvPVX_const has
8215 * already done for us), but not vectorize the args
8217 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8219 q++; /* skip past the rest of the %vd format */
8220 eptr = (const char *) vecstr;
8234 i = va_arg(*args, int);
8236 i = (ewix ? ewix <= svmax : svix < svmax) ?
8237 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8239 width = (i < 0) ? -i : i;
8249 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8251 /* XXX: todo, support specified precision parameter */
8255 i = va_arg(*args, int);
8257 i = (ewix ? ewix <= svmax : svix < svmax)
8258 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8259 precis = (i < 0) ? 0 : i;
8264 precis = precis * 10 + (*q++ - '0');
8273 case 'I': /* Ix, I32x, and I64x */
8275 if (q[1] == '6' && q[2] == '4') {
8281 if (q[1] == '3' && q[2] == '2') {
8291 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8302 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8303 if (*(q + 1) == 'l') { /* lld, llf */
8329 const I32 i = efix-1;
8330 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8332 argsv = (svix >= 0 && svix < svmax)
8333 ? svargs[svix++] : &PL_sv_undef;
8342 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8344 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8346 eptr = (char*)utf8buf;
8347 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8358 if (args && !vectorize) {
8359 eptr = va_arg(*args, char*);
8361 #ifdef MACOS_TRADITIONAL
8362 /* On MacOS, %#s format is used for Pascal strings */
8367 elen = strlen(eptr);
8369 eptr = (char *)nullstr;
8370 elen = sizeof nullstr - 1;
8374 eptr = SvPVx_const(argsv, elen);
8375 if (DO_UTF8(argsv)) {
8376 if (has_precis && precis < elen) {
8378 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8381 if (width) { /* fudge width (can't fudge elen) */
8382 width += elen - sv_len_utf8(argsv);
8390 if (has_precis && elen > precis)
8397 if (alt || vectorize)
8399 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8420 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8429 esignbuf[esignlen++] = plus;
8433 case 'h': iv = (short)va_arg(*args, int); break;
8434 case 'l': iv = va_arg(*args, long); break;
8435 case 'V': iv = va_arg(*args, IV); break;
8436 default: iv = va_arg(*args, int); break;
8438 case 'q': iv = va_arg(*args, Quad_t); break;
8443 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8445 case 'h': iv = (short)tiv; break;
8446 case 'l': iv = (long)tiv; break;
8448 default: iv = tiv; break;
8450 case 'q': iv = (Quad_t)tiv; break;
8454 if ( !vectorize ) /* we already set uv above */
8459 esignbuf[esignlen++] = plus;
8463 esignbuf[esignlen++] = '-';
8506 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8517 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8518 case 'l': uv = va_arg(*args, unsigned long); break;
8519 case 'V': uv = va_arg(*args, UV); break;
8520 default: uv = va_arg(*args, unsigned); break;
8522 case 'q': uv = va_arg(*args, Uquad_t); break;
8527 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8529 case 'h': uv = (unsigned short)tuv; break;
8530 case 'l': uv = (unsigned long)tuv; break;
8532 default: uv = tuv; break;
8534 case 'q': uv = (Uquad_t)tuv; break;
8541 char *ptr = ebuf + sizeof ebuf;
8547 p = (char*)((c == 'X')
8548 ? "0123456789ABCDEF" : "0123456789abcdef");
8554 esignbuf[esignlen++] = '0';
8555 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8563 if (alt && *ptr != '0')
8574 esignbuf[esignlen++] = '0';
8575 esignbuf[esignlen++] = 'b';
8578 default: /* it had better be ten or less */
8582 } while (uv /= base);
8585 elen = (ebuf + sizeof ebuf) - ptr;
8589 zeros = precis - elen;
8590 else if (precis == 0 && elen == 1 && *eptr == '0')
8596 /* FLOATING POINT */
8599 c = 'f'; /* maybe %F isn't supported here */
8605 /* This is evil, but floating point is even more evil */
8607 /* for SV-style calling, we can only get NV
8608 for C-style calling, we assume %f is double;
8609 for simplicity we allow any of %Lf, %llf, %qf for long double
8613 #if defined(USE_LONG_DOUBLE)
8617 /* [perl #20339] - we should accept and ignore %lf rather than die */
8621 #if defined(USE_LONG_DOUBLE)
8622 intsize = args ? 0 : 'q';
8626 #if defined(HAS_LONG_DOUBLE)
8635 /* now we need (long double) if intsize == 'q', else (double) */
8636 nv = (args && !vectorize) ?
8637 #if LONG_DOUBLESIZE > DOUBLESIZE
8639 va_arg(*args, long double) :
8640 va_arg(*args, double)
8642 va_arg(*args, double)
8648 if (c != 'e' && c != 'E') {
8650 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8651 will cast our (long double) to (double) */
8652 (void)Perl_frexp(nv, &i);
8653 if (i == PERL_INT_MIN)
8654 Perl_die(aTHX_ "panic: frexp");
8656 need = BIT_DIGITS(i);
8658 need += has_precis ? precis : 6; /* known default */
8663 #ifdef HAS_LDBL_SPRINTF_BUG
8664 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8665 with sfio - Allen <allens@cpan.org> */
8668 # define MY_DBL_MAX DBL_MAX
8669 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8670 # if DOUBLESIZE >= 8
8671 # define MY_DBL_MAX 1.7976931348623157E+308L
8673 # define MY_DBL_MAX 3.40282347E+38L
8677 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8678 # define MY_DBL_MAX_BUG 1L
8680 # define MY_DBL_MAX_BUG MY_DBL_MAX
8684 # define MY_DBL_MIN DBL_MIN
8685 # else /* XXX guessing! -Allen */
8686 # if DOUBLESIZE >= 8
8687 # define MY_DBL_MIN 2.2250738585072014E-308L
8689 # define MY_DBL_MIN 1.17549435E-38L
8693 if ((intsize == 'q') && (c == 'f') &&
8694 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8696 /* it's going to be short enough that
8697 * long double precision is not needed */
8699 if ((nv <= 0L) && (nv >= -0L))
8700 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8702 /* would use Perl_fp_class as a double-check but not
8703 * functional on IRIX - see perl.h comments */
8705 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8706 /* It's within the range that a double can represent */
8707 #if defined(DBL_MAX) && !defined(DBL_MIN)
8708 if ((nv >= ((long double)1/DBL_MAX)) ||
8709 (nv <= (-(long double)1/DBL_MAX)))
8711 fix_ldbl_sprintf_bug = TRUE;
8714 if (fix_ldbl_sprintf_bug == TRUE) {
8724 # undef MY_DBL_MAX_BUG
8727 #endif /* HAS_LDBL_SPRINTF_BUG */
8729 need += 20; /* fudge factor */
8730 if (PL_efloatsize < need) {
8731 Safefree(PL_efloatbuf);
8732 PL_efloatsize = need + 20; /* more fudge */
8733 Newx(PL_efloatbuf, PL_efloatsize, char);
8734 PL_efloatbuf[0] = '\0';
8737 if ( !(width || left || plus || alt) && fill != '0'
8738 && has_precis && intsize != 'q' ) { /* Shortcuts */
8739 /* See earlier comment about buggy Gconvert when digits,
8741 if ( c == 'g' && precis) {
8742 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8743 /* May return an empty string for digits==0 */
8744 if (*PL_efloatbuf) {
8745 elen = strlen(PL_efloatbuf);
8746 goto float_converted;
8748 } else if ( c == 'f' && !precis) {
8749 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8754 char *ptr = ebuf + sizeof ebuf;
8757 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8758 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8759 if (intsize == 'q') {
8760 /* Copy the one or more characters in a long double
8761 * format before the 'base' ([efgEFG]) character to
8762 * the format string. */
8763 static char const prifldbl[] = PERL_PRIfldbl;
8764 char const *p = prifldbl + sizeof(prifldbl) - 3;
8765 while (p >= prifldbl) { *--ptr = *p--; }
8770 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8775 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8787 /* No taint. Otherwise we are in the strange situation
8788 * where printf() taints but print($float) doesn't.
8790 #if defined(HAS_LONG_DOUBLE)
8791 elen = ((intsize == 'q')
8792 ? my_sprintf(PL_efloatbuf, ptr, nv)
8793 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8795 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8799 eptr = PL_efloatbuf;
8805 i = SvCUR(sv) - origlen;
8806 if (args && !vectorize) {
8808 case 'h': *(va_arg(*args, short*)) = i; break;
8809 default: *(va_arg(*args, int*)) = i; break;
8810 case 'l': *(va_arg(*args, long*)) = i; break;
8811 case 'V': *(va_arg(*args, IV*)) = i; break;
8813 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8818 sv_setuv_mg(argsv, (UV)i);
8820 continue; /* not "break" */
8827 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8828 && ckWARN(WARN_PRINTF))
8830 SV * const msg = sv_newmortal();
8831 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8832 (PL_op->op_type == OP_PRTF) ? "" : "s");
8835 Perl_sv_catpvf(aTHX_ msg,
8836 "\"%%%c\"", c & 0xFF);
8838 Perl_sv_catpvf(aTHX_ msg,
8839 "\"%%\\%03"UVof"\"",
8842 sv_catpv(msg, "end of string");
8843 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8846 /* output mangled stuff ... */
8852 /* ... right here, because formatting flags should not apply */
8853 SvGROW(sv, SvCUR(sv) + elen + 1);
8855 Copy(eptr, p, elen, char);
8858 SvCUR_set(sv, p - SvPVX_const(sv));
8860 continue; /* not "break" */
8863 /* calculate width before utf8_upgrade changes it */
8864 have = esignlen + zeros + elen;
8866 Perl_croak_nocontext(PL_memory_wrap);
8868 if (is_utf8 != has_utf8) {
8871 sv_utf8_upgrade(sv);
8874 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8875 sv_utf8_upgrade(nsv);
8876 eptr = SvPVX_const(nsv);
8879 SvGROW(sv, SvCUR(sv) + elen + 1);
8884 need = (have > width ? have : width);
8887 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8888 Perl_croak_nocontext(PL_memory_wrap);
8889 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8891 if (esignlen && fill == '0') {
8893 for (i = 0; i < (int)esignlen; i++)
8897 memset(p, fill, gap);
8900 if (esignlen && fill != '0') {
8902 for (i = 0; i < (int)esignlen; i++)
8907 for (i = zeros; i; i--)
8911 Copy(eptr, p, elen, char);
8915 memset(p, ' ', gap);
8920 Copy(dotstr, p, dotstrlen, char);
8924 vectorize = FALSE; /* done iterating over vecstr */
8931 SvCUR_set(sv, p - SvPVX_const(sv));
8939 /* =========================================================================
8941 =head1 Cloning an interpreter
8943 All the macros and functions in this section are for the private use of
8944 the main function, perl_clone().
8946 The foo_dup() functions make an exact copy of an existing foo thinngy.
8947 During the course of a cloning, a hash table is used to map old addresses
8948 to new addresses. The table is created and manipulated with the
8949 ptr_table_* functions.
8953 ============================================================================*/
8956 #if defined(USE_ITHREADS)
8958 #ifndef GpREFCNT_inc
8959 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8963 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8964 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8965 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8966 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8967 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8968 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8969 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8970 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8971 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8972 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8973 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8974 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8975 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8978 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8979 regcomp.c. AMS 20010712 */
8982 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8987 struct reg_substr_datum *s;
8990 return (REGEXP *)NULL;
8992 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8995 len = r->offsets[0];
8996 npar = r->nparens+1;
8998 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8999 Copy(r->program, ret->program, len+1, regnode);
9001 Newx(ret->startp, npar, I32);
9002 Copy(r->startp, ret->startp, npar, I32);
9003 Newx(ret->endp, npar, I32);
9004 Copy(r->startp, ret->startp, npar, I32);
9006 Newx(ret->substrs, 1, struct reg_substr_data);
9007 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9008 s->min_offset = r->substrs->data[i].min_offset;
9009 s->max_offset = r->substrs->data[i].max_offset;
9010 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9011 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9014 ret->regstclass = NULL;
9017 const int count = r->data->count;
9020 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9021 char, struct reg_data);
9022 Newx(d->what, count, U8);
9025 for (i = 0; i < count; i++) {
9026 d->what[i] = r->data->what[i];
9027 switch (d->what[i]) {
9028 /* legal options are one of: sfpont
9029 see also regcomp.h and pregfree() */
9031 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9034 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9037 /* This is cheating. */
9038 Newx(d->data[i], 1, struct regnode_charclass_class);
9039 StructCopy(r->data->data[i], d->data[i],
9040 struct regnode_charclass_class);
9041 ret->regstclass = (regnode*)d->data[i];
9044 /* Compiled op trees are readonly, and can thus be
9045 shared without duplication. */
9047 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9051 d->data[i] = r->data->data[i];
9054 d->data[i] = r->data->data[i];
9056 ((reg_trie_data*)d->data[i])->refcount++;
9060 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9069 Newx(ret->offsets, 2*len+1, U32);
9070 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9072 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9073 ret->refcnt = r->refcnt;
9074 ret->minlen = r->minlen;
9075 ret->prelen = r->prelen;
9076 ret->nparens = r->nparens;
9077 ret->lastparen = r->lastparen;
9078 ret->lastcloseparen = r->lastcloseparen;
9079 ret->reganch = r->reganch;
9081 ret->sublen = r->sublen;
9083 if (RX_MATCH_COPIED(ret))
9084 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9086 ret->subbeg = Nullch;
9087 #ifdef PERL_OLD_COPY_ON_WRITE
9088 ret->saved_copy = Nullsv;
9091 ptr_table_store(PL_ptr_table, r, ret);
9095 /* duplicate a file handle */
9098 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9102 PERL_UNUSED_ARG(type);
9105 return (PerlIO*)NULL;
9107 /* look for it in the table first */
9108 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9112 /* create anew and remember what it is */
9113 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9114 ptr_table_store(PL_ptr_table, fp, ret);
9118 /* duplicate a directory handle */
9121 Perl_dirp_dup(pTHX_ DIR *dp)
9129 /* duplicate a typeglob */
9132 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9137 /* look for it in the table first */
9138 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9142 /* create anew and remember what it is */
9144 ptr_table_store(PL_ptr_table, gp, ret);
9147 ret->gp_refcnt = 0; /* must be before any other dups! */
9148 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9149 ret->gp_io = io_dup_inc(gp->gp_io, param);
9150 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9151 ret->gp_av = av_dup_inc(gp->gp_av, param);
9152 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9153 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9154 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9155 ret->gp_cvgen = gp->gp_cvgen;
9156 ret->gp_line = gp->gp_line;
9157 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9161 /* duplicate a chain of magic */
9164 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9166 MAGIC *mgprev = (MAGIC*)NULL;
9169 return (MAGIC*)NULL;
9170 /* look for it in the table first */
9171 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9175 for (; mg; mg = mg->mg_moremagic) {
9177 Newxz(nmg, 1, MAGIC);
9179 mgprev->mg_moremagic = nmg;
9182 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9183 nmg->mg_private = mg->mg_private;
9184 nmg->mg_type = mg->mg_type;
9185 nmg->mg_flags = mg->mg_flags;
9186 if (mg->mg_type == PERL_MAGIC_qr) {
9187 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9189 else if(mg->mg_type == PERL_MAGIC_backref) {
9190 const AV * const av = (AV*) mg->mg_obj;
9193 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9195 for (i = AvFILLp(av); i >= 0; i--) {
9196 if (!svp[i]) continue;
9197 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9200 else if (mg->mg_type == PERL_MAGIC_symtab) {
9201 nmg->mg_obj = mg->mg_obj;
9204 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9205 ? sv_dup_inc(mg->mg_obj, param)
9206 : sv_dup(mg->mg_obj, param);
9208 nmg->mg_len = mg->mg_len;
9209 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9210 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9211 if (mg->mg_len > 0) {
9212 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9213 if (mg->mg_type == PERL_MAGIC_overload_table &&
9214 AMT_AMAGIC((AMT*)mg->mg_ptr))
9216 AMT * const amtp = (AMT*)mg->mg_ptr;
9217 AMT * const namtp = (AMT*)nmg->mg_ptr;
9219 for (i = 1; i < NofAMmeth; i++) {
9220 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9224 else if (mg->mg_len == HEf_SVKEY)
9225 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9227 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9228 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9235 /* create a new pointer-mapping table */
9238 Perl_ptr_table_new(pTHX)
9241 Newxz(tbl, 1, PTR_TBL_t);
9244 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9249 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9251 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9255 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9256 following define) and at call to new_body_inline made below in
9257 Perl_ptr_table_store()
9260 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9262 /* map an existing pointer using a table */
9265 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9267 PTR_TBL_ENT_t *tblent;
9268 const UV hash = PTR_TABLE_HASH(sv);
9270 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9271 for (; tblent; tblent = tblent->next) {
9272 if (tblent->oldval == sv)
9273 return tblent->newval;
9278 /* add a new entry to a pointer-mapping table */
9281 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9283 PTR_TBL_ENT_t *tblent, **otblent;
9284 /* XXX this may be pessimal on platforms where pointers aren't good
9285 * hash values e.g. if they grow faster in the most significant
9287 const UV hash = PTR_TABLE_HASH(oldsv);
9291 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9292 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9293 if (tblent->oldval == oldsv) {
9294 tblent->newval = newsv;
9298 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9299 tblent->oldval = oldsv;
9300 tblent->newval = newsv;
9301 tblent->next = *otblent;
9304 if (!empty && tbl->tbl_items > tbl->tbl_max)
9305 ptr_table_split(tbl);
9308 /* double the hash bucket size of an existing ptr table */
9311 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9313 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9314 const UV oldsize = tbl->tbl_max + 1;
9315 UV newsize = oldsize * 2;
9318 Renew(ary, newsize, PTR_TBL_ENT_t*);
9319 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9320 tbl->tbl_max = --newsize;
9322 for (i=0; i < oldsize; i++, ary++) {
9323 PTR_TBL_ENT_t **curentp, **entp, *ent;
9326 curentp = ary + oldsize;
9327 for (entp = ary, ent = *ary; ent; ent = *entp) {
9328 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9330 ent->next = *curentp;
9340 /* remove all the entries from a ptr table */
9343 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9345 register PTR_TBL_ENT_t **array;
9346 register PTR_TBL_ENT_t *entry;
9350 if (!tbl || !tbl->tbl_items) {
9354 array = tbl->tbl_ary;
9360 PTR_TBL_ENT_t *oentry = entry;
9361 entry = entry->next;
9365 if (++riter > max) {
9368 entry = array[riter];
9375 /* clear and free a ptr table */
9378 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9383 ptr_table_clear(tbl);
9384 Safefree(tbl->tbl_ary);
9390 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9393 SvRV_set(dstr, SvWEAKREF(sstr)
9394 ? sv_dup(SvRV(sstr), param)
9395 : sv_dup_inc(SvRV(sstr), param));
9398 else if (SvPVX_const(sstr)) {
9399 /* Has something there */
9401 /* Normal PV - clone whole allocated space */
9402 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9403 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9404 /* Not that normal - actually sstr is copy on write.
9405 But we are a true, independant SV, so: */
9406 SvREADONLY_off(dstr);
9411 /* Special case - not normally malloced for some reason */
9412 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9413 /* A "shared" PV - clone it as "shared" PV */
9415 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9419 /* Some other special case - random pointer */
9420 SvPV_set(dstr, SvPVX(sstr));
9426 if (SvTYPE(dstr) == SVt_RV)
9427 SvRV_set(dstr, NULL);
9433 /* duplicate an SV of any type (including AV, HV etc) */
9436 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9441 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9443 /* look for it in the table first */
9444 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9448 if(param->flags & CLONEf_JOIN_IN) {
9449 /** We are joining here so we don't want do clone
9450 something that is bad **/
9453 if(SvTYPE(sstr) == SVt_PVHV &&
9454 (hvname = HvNAME_get(sstr))) {
9455 /** don't clone stashes if they already exist **/
9456 return (SV*)gv_stashpv(hvname,0);
9460 /* create anew and remember what it is */
9463 #ifdef DEBUG_LEAKING_SCALARS
9464 dstr->sv_debug_optype = sstr->sv_debug_optype;
9465 dstr->sv_debug_line = sstr->sv_debug_line;
9466 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9467 dstr->sv_debug_cloned = 1;
9469 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9471 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9475 ptr_table_store(PL_ptr_table, sstr, dstr);
9478 SvFLAGS(dstr) = SvFLAGS(sstr);
9479 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9480 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9483 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9484 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9485 PL_watch_pvx, SvPVX_const(sstr));
9488 /* don't clone objects whose class has asked us not to */
9489 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9490 SvFLAGS(dstr) &= ~SVTYPEMASK;
9495 switch (SvTYPE(sstr)) {
9500 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9501 SvIV_set(dstr, SvIVX(sstr));
9504 SvANY(dstr) = new_XNV();
9505 SvNV_set(dstr, SvNVX(sstr));
9508 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9509 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9513 /* These are all the types that need complex bodies allocating. */
9515 const svtype sv_type = SvTYPE(sstr);
9516 const struct body_details *const sv_type_details
9517 = bodies_by_type + sv_type;
9521 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9526 if (GvUNIQUE((GV*)sstr)) {
9527 /* Do sharing here, and fall through */
9540 assert(sv_type_details->copy);
9541 if (sv_type_details->arena) {
9542 new_body_inline(new_body, sv_type_details->copy, sv_type);
9544 = (void*)((char*)new_body - sv_type_details->offset);
9546 new_body = new_NOARENA(sv_type_details);
9550 SvANY(dstr) = new_body;
9553 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9554 ((char*)SvANY(dstr)) + sv_type_details->offset,
9555 sv_type_details->copy, char);
9557 Copy(((char*)SvANY(sstr)),
9558 ((char*)SvANY(dstr)),
9559 sv_type_details->size + sv_type_details->offset, char);
9562 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9563 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9565 /* The Copy above means that all the source (unduplicated) pointers
9566 are now in the destination. We can check the flags and the
9567 pointers in either, but it's possible that there's less cache
9568 missing by always going for the destination.
9569 FIXME - instrument and check that assumption */
9570 if (sv_type >= SVt_PVMG) {
9572 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9574 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9577 /* The cast silences a GCC warning about unhandled types. */
9578 switch ((int)sv_type) {
9590 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9591 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9592 LvTARG(dstr) = dstr;
9593 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9594 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9596 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9599 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9600 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9601 /* Don't call sv_add_backref here as it's going to be created
9602 as part of the magic cloning of the symbol table. */
9603 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9604 (void)GpREFCNT_inc(GvGP(dstr));
9607 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9608 if (IoOFP(dstr) == IoIFP(sstr))
9609 IoOFP(dstr) = IoIFP(dstr);
9611 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9612 /* PL_rsfp_filters entries have fake IoDIRP() */
9613 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9614 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9615 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9616 /* I have no idea why fake dirp (rsfps)
9617 should be treated differently but otherwise
9618 we end up with leaks -- sky*/
9619 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9620 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9621 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9623 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9624 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9625 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9627 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9628 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9629 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9632 if (AvARRAY((AV*)sstr)) {
9633 SV **dst_ary, **src_ary;
9634 SSize_t items = AvFILLp((AV*)sstr) + 1;
9636 src_ary = AvARRAY((AV*)sstr);
9637 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9638 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9639 SvPV_set(dstr, (char*)dst_ary);
9640 AvALLOC((AV*)dstr) = dst_ary;
9641 if (AvREAL((AV*)sstr)) {
9643 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9647 *dst_ary++ = sv_dup(*src_ary++, param);
9649 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9650 while (items-- > 0) {
9651 *dst_ary++ = &PL_sv_undef;
9655 SvPV_set(dstr, Nullch);
9656 AvALLOC((AV*)dstr) = (SV**)NULL;
9663 if (HvARRAY((HV*)sstr)) {
9665 const bool sharekeys = !!HvSHAREKEYS(sstr);
9666 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9667 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9669 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9670 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9672 HvARRAY(dstr) = (HE**)darray;
9673 while (i <= sxhv->xhv_max) {
9674 const HE *source = HvARRAY(sstr)[i];
9675 HvARRAY(dstr)[i] = source
9676 ? he_dup(source, sharekeys, param) : 0;
9680 struct xpvhv_aux *saux = HvAUX(sstr);
9681 struct xpvhv_aux *daux = HvAUX(dstr);
9682 /* This flag isn't copied. */
9683 /* SvOOK_on(hv) attacks the IV flags. */
9684 SvFLAGS(dstr) |= SVf_OOK;
9686 hvname = saux->xhv_name;
9688 = hvname ? hek_dup(hvname, param) : hvname;
9690 daux->xhv_riter = saux->xhv_riter;
9691 daux->xhv_eiter = saux->xhv_eiter
9692 ? he_dup(saux->xhv_eiter,
9693 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9697 SvPV_set(dstr, Nullch);
9699 /* Record stashes for possible cloning in Perl_clone(). */
9701 av_push(param->stashes, dstr);
9706 /* NOTE: not refcounted */
9707 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9709 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9711 if (CvCONST(dstr)) {
9712 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9713 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9714 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9716 /* don't dup if copying back - CvGV isn't refcounted, so the
9717 * duped GV may never be freed. A bit of a hack! DAPM */
9718 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9719 Nullgv : gv_dup(CvGV(dstr), param) ;
9720 if (!(param->flags & CLONEf_COPY_STACKS)) {
9723 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9726 ? cv_dup( CvOUTSIDE(dstr), param)
9727 : cv_dup_inc(CvOUTSIDE(dstr), param);
9729 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9735 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9741 /* duplicate a context */
9744 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9749 return (PERL_CONTEXT*)NULL;
9751 /* look for it in the table first */
9752 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9756 /* create anew and remember what it is */
9757 Newxz(ncxs, max + 1, PERL_CONTEXT);
9758 ptr_table_store(PL_ptr_table, cxs, ncxs);
9761 PERL_CONTEXT *cx = &cxs[ix];
9762 PERL_CONTEXT *ncx = &ncxs[ix];
9763 ncx->cx_type = cx->cx_type;
9764 if (CxTYPE(cx) == CXt_SUBST) {
9765 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9768 ncx->blk_oldsp = cx->blk_oldsp;
9769 ncx->blk_oldcop = cx->blk_oldcop;
9770 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9771 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9772 ncx->blk_oldpm = cx->blk_oldpm;
9773 ncx->blk_gimme = cx->blk_gimme;
9774 switch (CxTYPE(cx)) {
9776 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9777 ? cv_dup_inc(cx->blk_sub.cv, param)
9778 : cv_dup(cx->blk_sub.cv,param));
9779 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9780 ? av_dup_inc(cx->blk_sub.argarray, param)
9782 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9783 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9784 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9785 ncx->blk_sub.lval = cx->blk_sub.lval;
9786 ncx->blk_sub.retop = cx->blk_sub.retop;
9789 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9790 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9791 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9792 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9793 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9794 ncx->blk_eval.retop = cx->blk_eval.retop;
9797 ncx->blk_loop.label = cx->blk_loop.label;
9798 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9799 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9800 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9801 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9802 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9803 ? cx->blk_loop.iterdata
9804 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9805 ncx->blk_loop.oldcomppad
9806 = (PAD*)ptr_table_fetch(PL_ptr_table,
9807 cx->blk_loop.oldcomppad);
9808 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9809 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9810 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9811 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9812 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9815 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9816 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9817 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9818 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9819 ncx->blk_sub.retop = cx->blk_sub.retop;
9831 /* duplicate a stack info structure */
9834 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9839 return (PERL_SI*)NULL;
9841 /* look for it in the table first */
9842 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9846 /* create anew and remember what it is */
9847 Newxz(nsi, 1, PERL_SI);
9848 ptr_table_store(PL_ptr_table, si, nsi);
9850 nsi->si_stack = av_dup_inc(si->si_stack, param);
9851 nsi->si_cxix = si->si_cxix;
9852 nsi->si_cxmax = si->si_cxmax;
9853 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9854 nsi->si_type = si->si_type;
9855 nsi->si_prev = si_dup(si->si_prev, param);
9856 nsi->si_next = si_dup(si->si_next, param);
9857 nsi->si_markoff = si->si_markoff;
9862 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9863 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9864 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9865 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9866 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9867 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9868 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9869 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9870 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9871 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9872 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9873 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9874 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9875 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9878 #define pv_dup_inc(p) SAVEPV(p)
9879 #define pv_dup(p) SAVEPV(p)
9880 #define svp_dup_inc(p,pp) any_dup(p,pp)
9882 /* map any object to the new equivent - either something in the
9883 * ptr table, or something in the interpreter structure
9887 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9894 /* look for it in the table first */
9895 ret = ptr_table_fetch(PL_ptr_table, v);
9899 /* see if it is part of the interpreter structure */
9900 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9901 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9909 /* duplicate the save stack */
9912 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9914 ANY * const ss = proto_perl->Tsavestack;
9915 const I32 max = proto_perl->Tsavestack_max;
9916 I32 ix = proto_perl->Tsavestack_ix;
9928 void (*dptr) (void*);
9929 void (*dxptr) (pTHX_ void*);
9931 Newxz(nss, max, ANY);
9934 I32 i = POPINT(ss,ix);
9937 case SAVEt_ITEM: /* normal string */
9938 sv = (SV*)POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9940 sv = (SV*)POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9943 case SAVEt_SV: /* scalar reference */
9944 sv = (SV*)POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9946 gv = (GV*)POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9949 case SAVEt_GENERIC_PVREF: /* generic char* */
9950 c = (char*)POPPTR(ss,ix);
9951 TOPPTR(nss,ix) = pv_dup(c);
9952 ptr = POPPTR(ss,ix);
9953 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9955 case SAVEt_SHARED_PVREF: /* char* in shared space */
9956 c = (char*)POPPTR(ss,ix);
9957 TOPPTR(nss,ix) = savesharedpv(c);
9958 ptr = POPPTR(ss,ix);
9959 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9961 case SAVEt_GENERIC_SVREF: /* generic sv */
9962 case SAVEt_SVREF: /* scalar reference */
9963 sv = (SV*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9965 ptr = POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9968 case SAVEt_AV: /* array reference */
9969 av = (AV*)POPPTR(ss,ix);
9970 TOPPTR(nss,ix) = av_dup_inc(av, param);
9971 gv = (GV*)POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = gv_dup(gv, param);
9974 case SAVEt_HV: /* hash reference */
9975 hv = (HV*)POPPTR(ss,ix);
9976 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9977 gv = (GV*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = gv_dup(gv, param);
9980 case SAVEt_INT: /* int reference */
9981 ptr = POPPTR(ss,ix);
9982 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9983 intval = (int)POPINT(ss,ix);
9984 TOPINT(nss,ix) = intval;
9986 case SAVEt_LONG: /* long reference */
9987 ptr = POPPTR(ss,ix);
9988 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9989 longval = (long)POPLONG(ss,ix);
9990 TOPLONG(nss,ix) = longval;
9992 case SAVEt_I32: /* I32 reference */
9993 case SAVEt_I16: /* I16 reference */
9994 case SAVEt_I8: /* I8 reference */
9995 ptr = POPPTR(ss,ix);
9996 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10000 case SAVEt_IV: /* IV reference */
10001 ptr = POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10004 TOPIV(nss,ix) = iv;
10006 case SAVEt_SPTR: /* SV* reference */
10007 ptr = POPPTR(ss,ix);
10008 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10009 sv = (SV*)POPPTR(ss,ix);
10010 TOPPTR(nss,ix) = sv_dup(sv, param);
10012 case SAVEt_VPTR: /* random* reference */
10013 ptr = POPPTR(ss,ix);
10014 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10015 ptr = POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10018 case SAVEt_PPTR: /* char* reference */
10019 ptr = POPPTR(ss,ix);
10020 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10021 c = (char*)POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = pv_dup(c);
10024 case SAVEt_HPTR: /* HV* reference */
10025 ptr = POPPTR(ss,ix);
10026 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10027 hv = (HV*)POPPTR(ss,ix);
10028 TOPPTR(nss,ix) = hv_dup(hv, param);
10030 case SAVEt_APTR: /* AV* reference */
10031 ptr = POPPTR(ss,ix);
10032 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10033 av = (AV*)POPPTR(ss,ix);
10034 TOPPTR(nss,ix) = av_dup(av, param);
10037 gv = (GV*)POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = gv_dup(gv, param);
10040 case SAVEt_GP: /* scalar reference */
10041 gp = (GP*)POPPTR(ss,ix);
10042 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10043 (void)GpREFCNT_inc(gp);
10044 gv = (GV*)POPPTR(ss,ix);
10045 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10046 c = (char*)POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = pv_dup(c);
10049 TOPIV(nss,ix) = iv;
10051 TOPIV(nss,ix) = iv;
10054 case SAVEt_MORTALIZESV:
10055 sv = (SV*)POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10059 ptr = POPPTR(ss,ix);
10060 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10061 /* these are assumed to be refcounted properly */
10063 switch (((OP*)ptr)->op_type) {
10065 case OP_LEAVESUBLV:
10069 case OP_LEAVEWRITE:
10070 TOPPTR(nss,ix) = ptr;
10075 TOPPTR(nss,ix) = Nullop;
10080 TOPPTR(nss,ix) = Nullop;
10083 c = (char*)POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = pv_dup_inc(c);
10086 case SAVEt_CLEARSV:
10087 longval = POPLONG(ss,ix);
10088 TOPLONG(nss,ix) = longval;
10091 hv = (HV*)POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10093 c = (char*)POPPTR(ss,ix);
10094 TOPPTR(nss,ix) = pv_dup_inc(c);
10096 TOPINT(nss,ix) = i;
10098 case SAVEt_DESTRUCTOR:
10099 ptr = POPPTR(ss,ix);
10100 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10101 dptr = POPDPTR(ss,ix);
10102 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10103 any_dup(FPTR2DPTR(void *, dptr),
10106 case SAVEt_DESTRUCTOR_X:
10107 ptr = POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10109 dxptr = POPDXPTR(ss,ix);
10110 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10111 any_dup(FPTR2DPTR(void *, dxptr),
10114 case SAVEt_REGCONTEXT:
10117 TOPINT(nss,ix) = i;
10120 case SAVEt_STACK_POS: /* Position on Perl stack */
10122 TOPINT(nss,ix) = i;
10124 case SAVEt_AELEM: /* array element */
10125 sv = (SV*)POPPTR(ss,ix);
10126 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10128 TOPINT(nss,ix) = i;
10129 av = (AV*)POPPTR(ss,ix);
10130 TOPPTR(nss,ix) = av_dup_inc(av, param);
10132 case SAVEt_HELEM: /* hash element */
10133 sv = (SV*)POPPTR(ss,ix);
10134 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10135 sv = (SV*)POPPTR(ss,ix);
10136 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10137 hv = (HV*)POPPTR(ss,ix);
10138 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10141 ptr = POPPTR(ss,ix);
10142 TOPPTR(nss,ix) = ptr;
10146 TOPINT(nss,ix) = i;
10148 case SAVEt_COMPPAD:
10149 av = (AV*)POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = av_dup(av, param);
10153 longval = (long)POPLONG(ss,ix);
10154 TOPLONG(nss,ix) = longval;
10155 ptr = POPPTR(ss,ix);
10156 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10157 sv = (SV*)POPPTR(ss,ix);
10158 TOPPTR(nss,ix) = sv_dup(sv, param);
10161 ptr = POPPTR(ss,ix);
10162 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10163 longval = (long)POPBOOL(ss,ix);
10164 TOPBOOL(nss,ix) = (bool)longval;
10166 case SAVEt_SET_SVFLAGS:
10168 TOPINT(nss,ix) = i;
10170 TOPINT(nss,ix) = i;
10171 sv = (SV*)POPPTR(ss,ix);
10172 TOPPTR(nss,ix) = sv_dup(sv, param);
10175 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10183 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10184 * flag to the result. This is done for each stash before cloning starts,
10185 * so we know which stashes want their objects cloned */
10188 do_mark_cloneable_stash(pTHX_ SV *sv)
10190 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10192 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10193 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10194 if (cloner && GvCV(cloner)) {
10201 XPUSHs(sv_2mortal(newSVhek(hvname)));
10203 call_sv((SV*)GvCV(cloner), G_SCALAR);
10210 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10218 =for apidoc perl_clone
10220 Create and return a new interpreter by cloning the current one.
10222 perl_clone takes these flags as parameters:
10224 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10225 without it we only clone the data and zero the stacks,
10226 with it we copy the stacks and the new perl interpreter is
10227 ready to run at the exact same point as the previous one.
10228 The pseudo-fork code uses COPY_STACKS while the
10229 threads->new doesn't.
10231 CLONEf_KEEP_PTR_TABLE
10232 perl_clone keeps a ptr_table with the pointer of the old
10233 variable as a key and the new variable as a value,
10234 this allows it to check if something has been cloned and not
10235 clone it again but rather just use the value and increase the
10236 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10237 the ptr_table using the function
10238 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10239 reason to keep it around is if you want to dup some of your own
10240 variable who are outside the graph perl scans, example of this
10241 code is in threads.xs create
10244 This is a win32 thing, it is ignored on unix, it tells perls
10245 win32host code (which is c++) to clone itself, this is needed on
10246 win32 if you want to run two threads at the same time,
10247 if you just want to do some stuff in a separate perl interpreter
10248 and then throw it away and return to the original one,
10249 you don't need to do anything.
10254 /* XXX the above needs expanding by someone who actually understands it ! */
10255 EXTERN_C PerlInterpreter *
10256 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10259 perl_clone(PerlInterpreter *proto_perl, UV flags)
10262 #ifdef PERL_IMPLICIT_SYS
10264 /* perlhost.h so we need to call into it
10265 to clone the host, CPerlHost should have a c interface, sky */
10267 if (flags & CLONEf_CLONE_HOST) {
10268 return perl_clone_host(proto_perl,flags);
10270 return perl_clone_using(proto_perl, flags,
10272 proto_perl->IMemShared,
10273 proto_perl->IMemParse,
10275 proto_perl->IStdIO,
10279 proto_perl->IProc);
10283 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10284 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10285 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10286 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10287 struct IPerlDir* ipD, struct IPerlSock* ipS,
10288 struct IPerlProc* ipP)
10290 /* XXX many of the string copies here can be optimized if they're
10291 * constants; they need to be allocated as common memory and just
10292 * their pointers copied. */
10295 CLONE_PARAMS clone_params;
10296 CLONE_PARAMS* param = &clone_params;
10298 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10299 /* for each stash, determine whether its objects should be cloned */
10300 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10301 PERL_SET_THX(my_perl);
10304 Poison(my_perl, 1, PerlInterpreter);
10306 PL_curcop = (COP *)Nullop;
10310 PL_savestack_ix = 0;
10311 PL_savestack_max = -1;
10312 PL_sig_pending = 0;
10313 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10314 # else /* !DEBUGGING */
10315 Zero(my_perl, 1, PerlInterpreter);
10316 # endif /* DEBUGGING */
10318 /* host pointers */
10320 PL_MemShared = ipMS;
10321 PL_MemParse = ipMP;
10328 #else /* !PERL_IMPLICIT_SYS */
10330 CLONE_PARAMS clone_params;
10331 CLONE_PARAMS* param = &clone_params;
10332 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10333 /* for each stash, determine whether its objects should be cloned */
10334 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10335 PERL_SET_THX(my_perl);
10338 Poison(my_perl, 1, PerlInterpreter);
10340 PL_curcop = (COP *)Nullop;
10344 PL_savestack_ix = 0;
10345 PL_savestack_max = -1;
10346 PL_sig_pending = 0;
10347 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10348 # else /* !DEBUGGING */
10349 Zero(my_perl, 1, PerlInterpreter);
10350 # endif /* DEBUGGING */
10351 #endif /* PERL_IMPLICIT_SYS */
10352 param->flags = flags;
10353 param->proto_perl = proto_perl;
10355 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10356 Zero(&PL_body_roots, 1, PL_body_roots);
10358 PL_nice_chunk = NULL;
10359 PL_nice_chunk_size = 0;
10361 PL_sv_objcount = 0;
10362 PL_sv_root = Nullsv;
10363 PL_sv_arenaroot = Nullsv;
10365 PL_debug = proto_perl->Idebug;
10367 PL_hash_seed = proto_perl->Ihash_seed;
10368 PL_rehash_seed = proto_perl->Irehash_seed;
10370 #ifdef USE_REENTRANT_API
10371 /* XXX: things like -Dm will segfault here in perlio, but doing
10372 * PERL_SET_CONTEXT(proto_perl);
10373 * breaks too many other things
10375 Perl_reentrant_init(aTHX);
10378 /* create SV map for pointer relocation */
10379 PL_ptr_table = ptr_table_new();
10381 /* initialize these special pointers as early as possible */
10382 SvANY(&PL_sv_undef) = NULL;
10383 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10384 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10385 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10387 SvANY(&PL_sv_no) = new_XPVNV();
10388 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10389 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10390 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10391 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10392 SvCUR_set(&PL_sv_no, 0);
10393 SvLEN_set(&PL_sv_no, 1);
10394 SvIV_set(&PL_sv_no, 0);
10395 SvNV_set(&PL_sv_no, 0);
10396 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10398 SvANY(&PL_sv_yes) = new_XPVNV();
10399 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10400 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10401 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10402 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10403 SvCUR_set(&PL_sv_yes, 1);
10404 SvLEN_set(&PL_sv_yes, 2);
10405 SvIV_set(&PL_sv_yes, 1);
10406 SvNV_set(&PL_sv_yes, 1);
10407 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10409 /* create (a non-shared!) shared string table */
10410 PL_strtab = newHV();
10411 HvSHAREKEYS_off(PL_strtab);
10412 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10413 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10415 PL_compiling = proto_perl->Icompiling;
10417 /* These two PVs will be free'd special way so must set them same way op.c does */
10418 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10419 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10421 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10422 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10424 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10425 if (!specialWARN(PL_compiling.cop_warnings))
10426 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10427 if (!specialCopIO(PL_compiling.cop_io))
10428 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10429 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10431 /* pseudo environmental stuff */
10432 PL_origargc = proto_perl->Iorigargc;
10433 PL_origargv = proto_perl->Iorigargv;
10435 param->stashes = newAV(); /* Setup array of objects to call clone on */
10437 /* Set tainting stuff before PerlIO_debug can possibly get called */
10438 PL_tainting = proto_perl->Itainting;
10439 PL_taint_warn = proto_perl->Itaint_warn;
10441 #ifdef PERLIO_LAYERS
10442 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10443 PerlIO_clone(aTHX_ proto_perl, param);
10446 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10447 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10448 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10449 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10450 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10451 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10454 PL_minus_c = proto_perl->Iminus_c;
10455 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10456 PL_localpatches = proto_perl->Ilocalpatches;
10457 PL_splitstr = proto_perl->Isplitstr;
10458 PL_preprocess = proto_perl->Ipreprocess;
10459 PL_minus_n = proto_perl->Iminus_n;
10460 PL_minus_p = proto_perl->Iminus_p;
10461 PL_minus_l = proto_perl->Iminus_l;
10462 PL_minus_a = proto_perl->Iminus_a;
10463 PL_minus_F = proto_perl->Iminus_F;
10464 PL_doswitches = proto_perl->Idoswitches;
10465 PL_dowarn = proto_perl->Idowarn;
10466 PL_doextract = proto_perl->Idoextract;
10467 PL_sawampersand = proto_perl->Isawampersand;
10468 PL_unsafe = proto_perl->Iunsafe;
10469 PL_inplace = SAVEPV(proto_perl->Iinplace);
10470 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10471 PL_perldb = proto_perl->Iperldb;
10472 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10473 PL_exit_flags = proto_perl->Iexit_flags;
10475 /* magical thingies */
10476 /* XXX time(&PL_basetime) when asked for? */
10477 PL_basetime = proto_perl->Ibasetime;
10478 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10480 PL_maxsysfd = proto_perl->Imaxsysfd;
10481 PL_multiline = proto_perl->Imultiline;
10482 PL_statusvalue = proto_perl->Istatusvalue;
10484 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10486 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10488 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10490 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10491 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10492 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10494 /* Clone the regex array */
10495 PL_regex_padav = newAV();
10497 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10498 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10500 av_push(PL_regex_padav,
10501 sv_dup_inc(regexen[0],param));
10502 for(i = 1; i <= len; i++) {
10503 if(SvREPADTMP(regexen[i])) {
10504 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10506 av_push(PL_regex_padav,
10508 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10509 SvIVX(regexen[i])), param)))
10514 PL_regex_pad = AvARRAY(PL_regex_padav);
10516 /* shortcuts to various I/O objects */
10517 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10518 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10519 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10520 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10521 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10522 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10524 /* shortcuts to regexp stuff */
10525 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10527 /* shortcuts to misc objects */
10528 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10530 /* shortcuts to debugging objects */
10531 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10532 PL_DBline = gv_dup(proto_perl->IDBline, param);
10533 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10534 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10535 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10536 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10537 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10538 PL_lineary = av_dup(proto_perl->Ilineary, param);
10539 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10541 /* symbol tables */
10542 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10543 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10544 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10545 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10546 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10548 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10549 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10550 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10551 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10552 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10553 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10555 PL_sub_generation = proto_perl->Isub_generation;
10557 /* funky return mechanisms */
10558 PL_forkprocess = proto_perl->Iforkprocess;
10560 /* subprocess state */
10561 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10563 /* internal state */
10564 PL_maxo = proto_perl->Imaxo;
10565 if (proto_perl->Iop_mask)
10566 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10568 PL_op_mask = Nullch;
10569 /* PL_asserting = proto_perl->Iasserting; */
10571 /* current interpreter roots */
10572 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10573 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10574 PL_main_start = proto_perl->Imain_start;
10575 PL_eval_root = proto_perl->Ieval_root;
10576 PL_eval_start = proto_perl->Ieval_start;
10578 /* runtime control stuff */
10579 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10580 PL_copline = proto_perl->Icopline;
10582 PL_filemode = proto_perl->Ifilemode;
10583 PL_lastfd = proto_perl->Ilastfd;
10584 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10587 PL_gensym = proto_perl->Igensym;
10588 PL_preambled = proto_perl->Ipreambled;
10589 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10590 PL_laststatval = proto_perl->Ilaststatval;
10591 PL_laststype = proto_perl->Ilaststype;
10592 PL_mess_sv = Nullsv;
10594 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10596 /* interpreter atexit processing */
10597 PL_exitlistlen = proto_perl->Iexitlistlen;
10598 if (PL_exitlistlen) {
10599 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10600 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10603 PL_exitlist = (PerlExitListEntry*)NULL;
10604 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10605 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10606 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10608 PL_profiledata = NULL;
10609 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10610 /* PL_rsfp_filters entries have fake IoDIRP() */
10611 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10613 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10615 PAD_CLONE_VARS(proto_perl, param);
10617 #ifdef HAVE_INTERP_INTERN
10618 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10621 /* more statics moved here */
10622 PL_generation = proto_perl->Igeneration;
10623 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10625 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10626 PL_in_clean_all = proto_perl->Iin_clean_all;
10628 PL_uid = proto_perl->Iuid;
10629 PL_euid = proto_perl->Ieuid;
10630 PL_gid = proto_perl->Igid;
10631 PL_egid = proto_perl->Iegid;
10632 PL_nomemok = proto_perl->Inomemok;
10633 PL_an = proto_perl->Ian;
10634 PL_evalseq = proto_perl->Ievalseq;
10635 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10636 PL_origalen = proto_perl->Iorigalen;
10637 #ifdef PERL_USES_PL_PIDSTATUS
10638 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10640 PL_osname = SAVEPV(proto_perl->Iosname);
10641 PL_sighandlerp = proto_perl->Isighandlerp;
10643 PL_runops = proto_perl->Irunops;
10645 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10648 PL_cshlen = proto_perl->Icshlen;
10649 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10652 PL_lex_state = proto_perl->Ilex_state;
10653 PL_lex_defer = proto_perl->Ilex_defer;
10654 PL_lex_expect = proto_perl->Ilex_expect;
10655 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10656 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10657 PL_lex_starts = proto_perl->Ilex_starts;
10658 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10659 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10660 PL_lex_op = proto_perl->Ilex_op;
10661 PL_lex_inpat = proto_perl->Ilex_inpat;
10662 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10663 PL_lex_brackets = proto_perl->Ilex_brackets;
10664 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10665 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10666 PL_lex_casemods = proto_perl->Ilex_casemods;
10667 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10668 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10670 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10671 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10672 PL_nexttoke = proto_perl->Inexttoke;
10674 /* XXX This is probably masking the deeper issue of why
10675 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10676 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10677 * (A little debugging with a watchpoint on it may help.)
10679 if (SvANY(proto_perl->Ilinestr)) {
10680 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10681 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10682 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10683 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10684 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10685 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10686 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10687 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10688 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10691 PL_linestr = NEWSV(65,79);
10692 sv_upgrade(PL_linestr,SVt_PVIV);
10693 sv_setpvn(PL_linestr,"",0);
10694 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10696 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10697 PL_pending_ident = proto_perl->Ipending_ident;
10698 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10700 PL_expect = proto_perl->Iexpect;
10702 PL_multi_start = proto_perl->Imulti_start;
10703 PL_multi_end = proto_perl->Imulti_end;
10704 PL_multi_open = proto_perl->Imulti_open;
10705 PL_multi_close = proto_perl->Imulti_close;
10707 PL_error_count = proto_perl->Ierror_count;
10708 PL_subline = proto_perl->Isubline;
10709 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10711 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10712 if (SvANY(proto_perl->Ilinestr)) {
10713 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10714 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10715 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10716 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10717 PL_last_lop_op = proto_perl->Ilast_lop_op;
10720 PL_last_uni = SvPVX(PL_linestr);
10721 PL_last_lop = SvPVX(PL_linestr);
10722 PL_last_lop_op = 0;
10724 PL_in_my = proto_perl->Iin_my;
10725 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10727 PL_cryptseen = proto_perl->Icryptseen;
10730 PL_hints = proto_perl->Ihints;
10732 PL_amagic_generation = proto_perl->Iamagic_generation;
10734 #ifdef USE_LOCALE_COLLATE
10735 PL_collation_ix = proto_perl->Icollation_ix;
10736 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10737 PL_collation_standard = proto_perl->Icollation_standard;
10738 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10739 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10740 #endif /* USE_LOCALE_COLLATE */
10742 #ifdef USE_LOCALE_NUMERIC
10743 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10744 PL_numeric_standard = proto_perl->Inumeric_standard;
10745 PL_numeric_local = proto_perl->Inumeric_local;
10746 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10747 #endif /* !USE_LOCALE_NUMERIC */
10749 /* utf8 character classes */
10750 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10751 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10752 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10753 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10754 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10755 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10756 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10757 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10758 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10759 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10760 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10761 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10762 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10763 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10764 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10765 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10766 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10767 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10768 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10769 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10771 /* Did the locale setup indicate UTF-8? */
10772 PL_utf8locale = proto_perl->Iutf8locale;
10773 /* Unicode features (see perlrun/-C) */
10774 PL_unicode = proto_perl->Iunicode;
10776 /* Pre-5.8 signals control */
10777 PL_signals = proto_perl->Isignals;
10779 /* times() ticks per second */
10780 PL_clocktick = proto_perl->Iclocktick;
10782 /* Recursion stopper for PerlIO_find_layer */
10783 PL_in_load_module = proto_perl->Iin_load_module;
10785 /* sort() routine */
10786 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10788 /* Not really needed/useful since the reenrant_retint is "volatile",
10789 * but do it for consistency's sake. */
10790 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10792 /* Hooks to shared SVs and locks. */
10793 PL_sharehook = proto_perl->Isharehook;
10794 PL_lockhook = proto_perl->Ilockhook;
10795 PL_unlockhook = proto_perl->Iunlockhook;
10796 PL_threadhook = proto_perl->Ithreadhook;
10798 PL_runops_std = proto_perl->Irunops_std;
10799 PL_runops_dbg = proto_perl->Irunops_dbg;
10801 #ifdef THREADS_HAVE_PIDS
10802 PL_ppid = proto_perl->Ippid;
10806 PL_last_swash_hv = Nullhv; /* reinits on demand */
10807 PL_last_swash_klen = 0;
10808 PL_last_swash_key[0]= '\0';
10809 PL_last_swash_tmps = (U8*)NULL;
10810 PL_last_swash_slen = 0;
10812 PL_glob_index = proto_perl->Iglob_index;
10813 PL_srand_called = proto_perl->Isrand_called;
10814 PL_uudmap['M'] = 0; /* reinits on demand */
10815 PL_bitcount = Nullch; /* reinits on demand */
10817 if (proto_perl->Ipsig_pend) {
10818 Newxz(PL_psig_pend, SIG_SIZE, int);
10821 PL_psig_pend = (int*)NULL;
10824 if (proto_perl->Ipsig_ptr) {
10825 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10826 Newxz(PL_psig_name, SIG_SIZE, SV*);
10827 for (i = 1; i < SIG_SIZE; i++) {
10828 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10829 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10833 PL_psig_ptr = (SV**)NULL;
10834 PL_psig_name = (SV**)NULL;
10837 /* thrdvar.h stuff */
10839 if (flags & CLONEf_COPY_STACKS) {
10840 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10841 PL_tmps_ix = proto_perl->Ttmps_ix;
10842 PL_tmps_max = proto_perl->Ttmps_max;
10843 PL_tmps_floor = proto_perl->Ttmps_floor;
10844 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10846 while (i <= PL_tmps_ix) {
10847 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10851 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10852 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10853 Newxz(PL_markstack, i, I32);
10854 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10855 - proto_perl->Tmarkstack);
10856 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10857 - proto_perl->Tmarkstack);
10858 Copy(proto_perl->Tmarkstack, PL_markstack,
10859 PL_markstack_ptr - PL_markstack + 1, I32);
10861 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10862 * NOTE: unlike the others! */
10863 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10864 PL_scopestack_max = proto_perl->Tscopestack_max;
10865 Newxz(PL_scopestack, PL_scopestack_max, I32);
10866 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10868 /* NOTE: si_dup() looks at PL_markstack */
10869 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10871 /* PL_curstack = PL_curstackinfo->si_stack; */
10872 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10873 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10875 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10876 PL_stack_base = AvARRAY(PL_curstack);
10877 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10878 - proto_perl->Tstack_base);
10879 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10881 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10882 * NOTE: unlike the others! */
10883 PL_savestack_ix = proto_perl->Tsavestack_ix;
10884 PL_savestack_max = proto_perl->Tsavestack_max;
10885 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10886 PL_savestack = ss_dup(proto_perl, param);
10890 ENTER; /* perl_destruct() wants to LEAVE; */
10893 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10894 PL_top_env = &PL_start_env;
10896 PL_op = proto_perl->Top;
10899 PL_Xpv = (XPV*)NULL;
10900 PL_na = proto_perl->Tna;
10902 PL_statbuf = proto_perl->Tstatbuf;
10903 PL_statcache = proto_perl->Tstatcache;
10904 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10905 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10907 PL_timesbuf = proto_perl->Ttimesbuf;
10910 PL_tainted = proto_perl->Ttainted;
10911 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10912 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10913 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10914 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10915 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10916 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10917 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10918 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10919 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10921 PL_restartop = proto_perl->Trestartop;
10922 PL_in_eval = proto_perl->Tin_eval;
10923 PL_delaymagic = proto_perl->Tdelaymagic;
10924 PL_dirty = proto_perl->Tdirty;
10925 PL_localizing = proto_perl->Tlocalizing;
10927 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10928 PL_hv_fetch_ent_mh = Nullhe;
10929 PL_modcount = proto_perl->Tmodcount;
10930 PL_lastgotoprobe = Nullop;
10931 PL_dumpindent = proto_perl->Tdumpindent;
10933 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10934 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10935 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10936 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10937 PL_efloatbuf = Nullch; /* reinits on demand */
10938 PL_efloatsize = 0; /* reinits on demand */
10942 PL_screamfirst = NULL;
10943 PL_screamnext = NULL;
10944 PL_maxscream = -1; /* reinits on demand */
10945 PL_lastscream = Nullsv;
10947 PL_watchaddr = NULL;
10948 PL_watchok = Nullch;
10950 PL_regdummy = proto_perl->Tregdummy;
10951 PL_regprecomp = Nullch;
10954 PL_colorset = 0; /* reinits PL_colors[] */
10955 /*PL_colors[6] = {0,0,0,0,0,0};*/
10956 PL_reginput = Nullch;
10957 PL_regbol = Nullch;
10958 PL_regeol = Nullch;
10959 PL_regstartp = (I32*)NULL;
10960 PL_regendp = (I32*)NULL;
10961 PL_reglastparen = (U32*)NULL;
10962 PL_reglastcloseparen = (U32*)NULL;
10963 PL_regtill = Nullch;
10964 PL_reg_start_tmp = (char**)NULL;
10965 PL_reg_start_tmpl = 0;
10966 PL_regdata = (struct reg_data*)NULL;
10969 PL_reg_eval_set = 0;
10971 PL_regprogram = (regnode*)NULL;
10973 PL_regcc = (CURCUR*)NULL;
10974 PL_reg_call_cc = (struct re_cc_state*)NULL;
10975 PL_reg_re = (regexp*)NULL;
10976 PL_reg_ganch = Nullch;
10977 PL_reg_sv = Nullsv;
10978 PL_reg_match_utf8 = FALSE;
10979 PL_reg_magic = (MAGIC*)NULL;
10981 PL_reg_oldcurpm = (PMOP*)NULL;
10982 PL_reg_curpm = (PMOP*)NULL;
10983 PL_reg_oldsaved = Nullch;
10984 PL_reg_oldsavedlen = 0;
10985 #ifdef PERL_OLD_COPY_ON_WRITE
10988 PL_reg_maxiter = 0;
10989 PL_reg_leftiter = 0;
10990 PL_reg_poscache = Nullch;
10991 PL_reg_poscache_size= 0;
10993 /* RE engine - function pointers */
10994 PL_regcompp = proto_perl->Tregcompp;
10995 PL_regexecp = proto_perl->Tregexecp;
10996 PL_regint_start = proto_perl->Tregint_start;
10997 PL_regint_string = proto_perl->Tregint_string;
10998 PL_regfree = proto_perl->Tregfree;
11000 PL_reginterp_cnt = 0;
11001 PL_reg_starttry = 0;
11003 /* Pluggable optimizer */
11004 PL_peepp = proto_perl->Tpeepp;
11006 PL_stashcache = newHV();
11008 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11009 ptr_table_free(PL_ptr_table);
11010 PL_ptr_table = NULL;
11013 /* Call the ->CLONE method, if it exists, for each of the stashes
11014 identified by sv_dup() above.
11016 while(av_len(param->stashes) != -1) {
11017 HV* const stash = (HV*) av_shift(param->stashes);
11018 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11019 if (cloner && GvCV(cloner)) {
11024 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11026 call_sv((SV*)GvCV(cloner), G_DISCARD);
11032 SvREFCNT_dec(param->stashes);
11034 /* orphaned? eg threads->new inside BEGIN or use */
11035 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11036 (void)SvREFCNT_inc(PL_compcv);
11037 SAVEFREESV(PL_compcv);
11043 #endif /* USE_ITHREADS */
11046 =head1 Unicode Support
11048 =for apidoc sv_recode_to_utf8
11050 The encoding is assumed to be an Encode object, on entry the PV
11051 of the sv is assumed to be octets in that encoding, and the sv
11052 will be converted into Unicode (and UTF-8).
11054 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11055 is not a reference, nothing is done to the sv. If the encoding is not
11056 an C<Encode::XS> Encoding object, bad things will happen.
11057 (See F<lib/encoding.pm> and L<Encode>).
11059 The PV of the sv is returned.
11064 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11067 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11081 Passing sv_yes is wrong - it needs to be or'ed set of constants
11082 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11083 remove converted chars from source.
11085 Both will default the value - let them.
11087 XPUSHs(&PL_sv_yes);
11090 call_method("decode", G_SCALAR);
11094 s = SvPV_const(uni, len);
11095 if (s != SvPVX_const(sv)) {
11096 SvGROW(sv, len + 1);
11097 Move(s, SvPVX(sv), len + 1, char);
11098 SvCUR_set(sv, len);
11105 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11109 =for apidoc sv_cat_decode
11111 The encoding is assumed to be an Encode object, the PV of the ssv is
11112 assumed to be octets in that encoding and decoding the input starts
11113 from the position which (PV + *offset) pointed to. The dsv will be
11114 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11115 when the string tstr appears in decoding output or the input ends on
11116 the PV of the ssv. The value which the offset points will be modified
11117 to the last input position on the ssv.
11119 Returns TRUE if the terminator was found, else returns FALSE.
11124 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11125 SV *ssv, int *offset, char *tstr, int tlen)
11129 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11140 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11141 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11143 call_method("cat_decode", G_SCALAR);
11145 ret = SvTRUE(TOPs);
11146 *offset = SvIV(offsv);
11152 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11157 /* ---------------------------------------------------------------------
11159 * support functions for report_uninit()
11162 /* the maxiumum size of array or hash where we will scan looking
11163 * for the undefined element that triggered the warning */
11165 #define FUV_MAX_SEARCH_SIZE 1000
11167 /* Look for an entry in the hash whose value has the same SV as val;
11168 * If so, return a mortal copy of the key. */
11171 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11174 register HE **array;
11177 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11178 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11181 array = HvARRAY(hv);
11183 for (i=HvMAX(hv); i>0; i--) {
11184 register HE *entry;
11185 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11186 if (HeVAL(entry) != val)
11188 if ( HeVAL(entry) == &PL_sv_undef ||
11189 HeVAL(entry) == &PL_sv_placeholder)
11193 if (HeKLEN(entry) == HEf_SVKEY)
11194 return sv_mortalcopy(HeKEY_sv(entry));
11195 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11201 /* Look for an entry in the array whose value has the same SV as val;
11202 * If so, return the index, otherwise return -1. */
11205 S_find_array_subscript(pTHX_ AV *av, SV* val)
11209 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11210 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11214 for (i=AvFILLp(av); i>=0; i--) {
11215 if (svp[i] == val && svp[i] != &PL_sv_undef)
11221 /* S_varname(): return the name of a variable, optionally with a subscript.
11222 * If gv is non-zero, use the name of that global, along with gvtype (one
11223 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11224 * targ. Depending on the value of the subscript_type flag, return:
11227 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11228 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11229 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11230 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11233 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11234 SV* keyname, I32 aindex, int subscript_type)
11237 SV * const name = sv_newmortal();
11240 buffer[0] = gvtype;
11243 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11245 gv_fullname4(name, gv, buffer, 0);
11247 if ((unsigned int)SvPVX(name)[1] <= 26) {
11249 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11251 /* Swap the 1 unprintable control character for the 2 byte pretty
11252 version - ie substr($name, 1, 1) = $buffer; */
11253 sv_insert(name, 1, 1, buffer, 2);
11258 CV * const cv = find_runcv(&unused);
11262 if (!cv || !CvPADLIST(cv))
11264 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11265 sv = *av_fetch(av, targ, FALSE);
11266 /* SvLEN in a pad name is not to be trusted */
11267 sv_setpv(name, SvPV_nolen_const(sv));
11270 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11271 SV * const sv = NEWSV(0,0);
11272 *SvPVX(name) = '$';
11273 Perl_sv_catpvf(aTHX_ name, "{%s}",
11274 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11277 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11278 *SvPVX(name) = '$';
11279 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11281 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11282 sv_insert(name, 0, 0, "within ", 7);
11289 =for apidoc find_uninit_var
11291 Find the name of the undefined variable (if any) that caused the operator o
11292 to issue a "Use of uninitialized value" warning.
11293 If match is true, only return a name if it's value matches uninit_sv.
11294 So roughly speaking, if a unary operator (such as OP_COS) generates a
11295 warning, then following the direct child of the op may yield an
11296 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11297 other hand, with OP_ADD there are two branches to follow, so we only print
11298 the variable name if we get an exact match.
11300 The name is returned as a mortal SV.
11302 Assumes that PL_op is the op that originally triggered the error, and that
11303 PL_comppad/PL_curpad points to the currently executing pad.
11309 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11317 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11318 uninit_sv == &PL_sv_placeholder)))
11321 switch (obase->op_type) {
11328 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11329 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11331 SV *keysv = Nullsv;
11332 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11334 if (pad) { /* @lex, %lex */
11335 sv = PAD_SVl(obase->op_targ);
11339 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11340 /* @global, %global */
11341 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11344 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11346 else /* @{expr}, %{expr} */
11347 return find_uninit_var(cUNOPx(obase)->op_first,
11351 /* attempt to find a match within the aggregate */
11353 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11355 subscript_type = FUV_SUBSCRIPT_HASH;
11358 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11360 subscript_type = FUV_SUBSCRIPT_ARRAY;
11363 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11366 return varname(gv, hash ? '%' : '@', obase->op_targ,
11367 keysv, index, subscript_type);
11371 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11373 return varname(Nullgv, '$', obase->op_targ,
11374 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11377 gv = cGVOPx_gv(obase);
11378 if (!gv || (match && GvSV(gv) != uninit_sv))
11380 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11383 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11386 av = (AV*)PAD_SV(obase->op_targ);
11387 if (!av || SvRMAGICAL(av))
11389 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11390 if (!svp || *svp != uninit_sv)
11393 return varname(Nullgv, '$', obase->op_targ,
11394 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11397 gv = cGVOPx_gv(obase);
11403 if (!av || SvRMAGICAL(av))
11405 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11406 if (!svp || *svp != uninit_sv)
11409 return varname(gv, '$', 0,
11410 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11415 o = cUNOPx(obase)->op_first;
11416 if (!o || o->op_type != OP_NULL ||
11417 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11419 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11423 if (PL_op == obase)
11424 /* $a[uninit_expr] or $h{uninit_expr} */
11425 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11428 o = cBINOPx(obase)->op_first;
11429 kid = cBINOPx(obase)->op_last;
11431 /* get the av or hv, and optionally the gv */
11433 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11434 sv = PAD_SV(o->op_targ);
11436 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11437 && cUNOPo->op_first->op_type == OP_GV)
11439 gv = cGVOPx_gv(cUNOPo->op_first);
11442 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11447 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11448 /* index is constant */
11452 if (obase->op_type == OP_HELEM) {
11453 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11454 if (!he || HeVAL(he) != uninit_sv)
11458 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11459 if (!svp || *svp != uninit_sv)
11463 if (obase->op_type == OP_HELEM)
11464 return varname(gv, '%', o->op_targ,
11465 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11467 return varname(gv, '@', o->op_targ, Nullsv,
11468 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11472 /* index is an expression;
11473 * attempt to find a match within the aggregate */
11474 if (obase->op_type == OP_HELEM) {
11475 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11477 return varname(gv, '%', o->op_targ,
11478 keysv, 0, FUV_SUBSCRIPT_HASH);
11481 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11483 return varname(gv, '@', o->op_targ,
11484 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11489 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11491 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11497 /* only examine RHS */
11498 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11501 o = cUNOPx(obase)->op_first;
11502 if (o->op_type == OP_PUSHMARK)
11505 if (!o->op_sibling) {
11506 /* one-arg version of open is highly magical */
11508 if (o->op_type == OP_GV) { /* open FOO; */
11510 if (match && GvSV(gv) != uninit_sv)
11512 return varname(gv, '$', 0,
11513 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11515 /* other possibilities not handled are:
11516 * open $x; or open my $x; should return '${*$x}'
11517 * open expr; should return '$'.expr ideally
11523 /* ops where $_ may be an implicit arg */
11527 if ( !(obase->op_flags & OPf_STACKED)) {
11528 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11529 ? PAD_SVl(obase->op_targ)
11532 sv = sv_newmortal();
11533 sv_setpvn(sv, "$_", 2);
11541 /* skip filehandle as it can't produce 'undef' warning */
11542 o = cUNOPx(obase)->op_first;
11543 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11544 o = o->op_sibling->op_sibling;
11551 match = 1; /* XS or custom code could trigger random warnings */
11556 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11557 return sv_2mortal(newSVpvn("${$/}", 5));
11562 if (!(obase->op_flags & OPf_KIDS))
11564 o = cUNOPx(obase)->op_first;
11570 /* if all except one arg are constant, or have no side-effects,
11571 * or are optimized away, then it's unambiguous */
11573 for (kid=o; kid; kid = kid->op_sibling) {
11575 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11576 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11577 || (kid->op_type == OP_PUSHMARK)
11581 if (o2) { /* more than one found */
11588 return find_uninit_var(o2, uninit_sv, match);
11590 /* scan all args */
11592 sv = find_uninit_var(o, uninit_sv, 1);
11604 =for apidoc report_uninit
11606 Print appropriate "Use of uninitialized variable" warning
11612 Perl_report_uninit(pTHX_ SV* uninit_sv)
11615 SV* varname = Nullsv;
11617 varname = find_uninit_var(PL_op, uninit_sv,0);
11619 sv_insert(varname, 0, 0, " ", 1);
11621 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11622 varname ? SvPV_nolen_const(varname) : "",
11623 " in ", OP_DESC(PL_op));
11626 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11632 * c-indentation-style: bsd
11633 * c-basic-offset: 4
11634 * indent-tabs-mode: t
11637 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob