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. Note that this also clears PL_he_arenaroot,
116 which is otherwise dealt with in hv.c.
118 Manipulation of any of the PL_*root pointers is protected by enclosing
119 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
120 if threads are enabled.
122 The function visit() scans the SV arenas list, and calls a specified
123 function for each SV it finds which is still live - ie which has an SvTYPE
124 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
125 following functions (specified as [function that calls visit()] / [function
126 called by visit() for each SV]):
128 sv_report_used() / do_report_used()
129 dump all remaining SVs (debugging aid)
131 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
132 Attempt to free all objects pointed to by RVs,
133 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
134 try to do the same for all objects indirectly
135 referenced by typeglobs too. Called once from
136 perl_destruct(), prior to calling sv_clean_all()
139 sv_clean_all() / do_clean_all()
140 SvREFCNT_dec(sv) each remaining SV, possibly
141 triggering an sv_free(). It also sets the
142 SVf_BREAK flag on the SV to indicate that the
143 refcnt has been artificially lowered, and thus
144 stopping sv_free() from giving spurious warnings
145 about SVs which unexpectedly have a refcnt
146 of zero. called repeatedly from perl_destruct()
147 until there are no SVs left.
149 =head2 Arena allocator API Summary
151 Private API to rest of sv.c
155 new_XIV(), del_XIV(),
156 new_XNV(), del_XNV(),
161 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
166 ============================================================================ */
171 * "A time to plant, and a time to uproot what was planted..."
175 * nice_chunk and nice_chunk size need to be set
176 * and queried under the protection of sv_mutex
179 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
243 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
244 PL_nice_chunk = Nullch;
245 PL_nice_chunk_size = 0;
248 char *chunk; /* must use New here to match call to */
249 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
250 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
256 /* new_SV(): return a new, empty SV head */
258 #ifdef DEBUG_LEAKING_SCALARS
259 /* provide a real function for a debugger to play with */
269 sv = S_more_sv(aTHX);
274 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
275 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
276 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
277 sv->sv_debug_inpad = 0;
278 sv->sv_debug_cloned = 0;
279 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
283 # define new_SV(p) (p)=S_new_SV(aTHX)
292 (p) = S_more_sv(aTHX); \
301 /* del_SV(): return an empty SV head to the free list */
316 S_del_sv(pTHX_ SV *p)
321 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
322 const SV * const sv = sva + 1;
323 const SV * const svend = &sva[SvREFCNT(sva)];
324 if (p >= sv && p < svend) {
330 if (ckWARN_d(WARN_INTERNAL))
331 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
332 "Attempt to free non-arena SV: 0x%"UVxf
333 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
340 #else /* ! DEBUGGING */
342 #define del_SV(p) plant_SV(p)
344 #endif /* DEBUGGING */
348 =head1 SV Manipulation Functions
350 =for apidoc sv_add_arena
352 Given a chunk of memory, link it to the head of the list of arenas,
353 and split it into a list of free SVs.
359 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
365 /* The first SV in an arena isn't an SV. */
366 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
367 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
368 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
370 PL_sv_arenaroot = sva;
371 PL_sv_root = sva + 1;
373 svend = &sva[SvREFCNT(sva) - 1];
376 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
380 /* Must always set typemask because it's awlays checked in on cleanup
381 when the arenas are walked looking for objects. */
382 SvFLAGS(sv) = SVTYPEMASK;
385 SvARENA_CHAIN(sv) = 0;
389 SvFLAGS(sv) = SVTYPEMASK;
392 /* visit(): call the named function for each non-free SV in the arenas
393 * whose flags field matches the flags/mask args. */
396 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
401 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
402 register const SV * const svend = &sva[SvREFCNT(sva)];
404 for (sv = sva + 1; sv < svend; ++sv) {
405 if (SvTYPE(sv) != SVTYPEMASK
406 && (sv->sv_flags & mask) == flags
419 /* called by sv_report_used() for each live SV */
422 do_report_used(pTHX_ SV *sv)
424 if (SvTYPE(sv) != SVTYPEMASK) {
425 PerlIO_printf(Perl_debug_log, "****\n");
432 =for apidoc sv_report_used
434 Dump the contents of all SVs not yet freed. (Debugging aid).
440 Perl_sv_report_used(pTHX)
443 visit(do_report_used, 0, 0);
447 /* called by sv_clean_objs() for each live SV */
450 do_clean_objs(pTHX_ SV *ref)
453 SV * const target = SvRV(ref);
454 if (SvOBJECT(target)) {
455 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
456 if (SvWEAKREF(ref)) {
457 sv_del_backref(target, ref);
463 SvREFCNT_dec(target);
468 /* XXX Might want to check arrays, etc. */
471 /* called by sv_clean_objs() for each live SV */
473 #ifndef DISABLE_DESTRUCTOR_KLUDGE
475 do_clean_named_objs(pTHX_ SV *sv)
477 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
479 #ifdef PERL_DONT_CREATE_GVSV
482 SvOBJECT(GvSV(sv))) ||
483 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
484 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
485 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
486 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
488 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
489 SvFLAGS(sv) |= SVf_BREAK;
497 =for apidoc sv_clean_objs
499 Attempt to destroy all objects not yet freed
505 Perl_sv_clean_objs(pTHX)
507 PL_in_clean_objs = TRUE;
508 visit(do_clean_objs, SVf_ROK, SVf_ROK);
509 #ifndef DISABLE_DESTRUCTOR_KLUDGE
510 /* some barnacles may yet remain, clinging to typeglobs */
511 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
513 PL_in_clean_objs = FALSE;
516 /* called by sv_clean_all() for each live SV */
519 do_clean_all(pTHX_ SV *sv)
521 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
522 SvFLAGS(sv) |= SVf_BREAK;
523 if (PL_comppad == (AV*)sv) {
525 PL_curpad = Null(SV**);
531 =for apidoc sv_clean_all
533 Decrement the refcnt of each remaining SV, possibly triggering a
534 cleanup. This function may have to be called multiple times to free
535 SVs which are in complex self-referential hierarchies.
541 Perl_sv_clean_all(pTHX)
544 PL_in_clean_all = TRUE;
545 cleaned = visit(do_clean_all, 0,0);
546 PL_in_clean_all = FALSE;
551 S_free_arena(pTHX_ void **root) {
553 void ** const next = *(void **)root;
560 =for apidoc sv_free_arenas
562 Deallocate the memory used by all arenas. Note that all the individual SV
563 heads and bodies within the arenas must already have been freed.
567 #define free_arena(name) \
569 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
570 PL_ ## name ## _arenaroot = 0; \
571 PL_ ## name ## _root = 0; \
575 Perl_sv_free_arenas(pTHX)
581 /* Free arenas here, but be careful about fake ones. (We assume
582 contiguity of the fake ones with the corresponding real ones.) */
584 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
585 svanext = (SV*) SvANY(sva);
586 while (svanext && SvFAKE(svanext))
587 svanext = (SV*) SvANY(svanext);
593 for (i=0; i<SVt_LAST; i++) {
594 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
595 PL_body_arenaroots[i] = 0;
596 PL_body_roots[i] = 0;
601 Safefree(PL_nice_chunk);
602 PL_nice_chunk = Nullch;
603 PL_nice_chunk_size = 0;
608 /* ---------------------------------------------------------------------
610 * support functions for report_uninit()
613 /* the maxiumum size of array or hash where we will scan looking
614 * for the undefined element that triggered the warning */
616 #define FUV_MAX_SEARCH_SIZE 1000
618 /* Look for an entry in the hash whose value has the same SV as val;
619 * If so, return a mortal copy of the key. */
622 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
628 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
629 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
634 for (i=HvMAX(hv); i>0; i--) {
636 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
637 if (HeVAL(entry) != val)
639 if ( HeVAL(entry) == &PL_sv_undef ||
640 HeVAL(entry) == &PL_sv_placeholder)
644 if (HeKLEN(entry) == HEf_SVKEY)
645 return sv_mortalcopy(HeKEY_sv(entry));
646 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
652 /* Look for an entry in the array whose value has the same SV as val;
653 * If so, return the index, otherwise return -1. */
656 S_find_array_subscript(pTHX_ AV *av, SV* val)
660 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
661 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
665 for (i=AvFILLp(av); i>=0; i--) {
666 if (svp[i] == val && svp[i] != &PL_sv_undef)
672 /* S_varname(): return the name of a variable, optionally with a subscript.
673 * If gv is non-zero, use the name of that global, along with gvtype (one
674 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
675 * targ. Depending on the value of the subscript_type flag, return:
678 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
679 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
680 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
681 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
684 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
685 SV* keyname, I32 aindex, int subscript_type)
688 SV * const name = sv_newmortal();
694 /* as gv_fullname4(), but add literal '^' for $^FOO names */
696 gv_fullname4(name, gv, buffer, 0);
698 if ((unsigned int)SvPVX(name)[1] <= 26) {
700 buffer[1] = SvPVX(name)[1] + 'A' - 1;
702 /* Swap the 1 unprintable control character for the 2 byte pretty
703 version - ie substr($name, 1, 1) = $buffer; */
704 sv_insert(name, 1, 1, buffer, 2);
709 CV * const cv = find_runcv(&unused);
713 if (!cv || !CvPADLIST(cv))
715 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
716 sv = *av_fetch(av, targ, FALSE);
717 /* SvLEN in a pad name is not to be trusted */
718 sv_setpv(name, SvPV_nolen_const(sv));
721 if (subscript_type == FUV_SUBSCRIPT_HASH) {
722 SV * const sv = NEWSV(0,0);
724 Perl_sv_catpvf(aTHX_ name, "{%s}",
725 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
728 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
730 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
732 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
733 sv_insert(name, 0, 0, "within ", 7);
740 =for apidoc find_uninit_var
742 Find the name of the undefined variable (if any) that caused the operator o
743 to issue a "Use of uninitialized value" warning.
744 If match is true, only return a name if it's value matches uninit_sv.
745 So roughly speaking, if a unary operator (such as OP_COS) generates a
746 warning, then following the direct child of the op may yield an
747 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
748 other hand, with OP_ADD there are two branches to follow, so we only print
749 the variable name if we get an exact match.
751 The name is returned as a mortal SV.
753 Assumes that PL_op is the op that originally triggered the error, and that
754 PL_comppad/PL_curpad points to the currently executing pad.
760 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
768 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
769 uninit_sv == &PL_sv_placeholder)))
772 switch (obase->op_type) {
779 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
780 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
783 int subscript_type = FUV_SUBSCRIPT_WITHIN;
785 if (pad) { /* @lex, %lex */
786 sv = PAD_SVl(obase->op_targ);
790 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
791 /* @global, %global */
792 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
795 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
797 else /* @{expr}, %{expr} */
798 return find_uninit_var(cUNOPx(obase)->op_first,
802 /* attempt to find a match within the aggregate */
804 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
806 subscript_type = FUV_SUBSCRIPT_HASH;
809 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
811 subscript_type = FUV_SUBSCRIPT_ARRAY;
814 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
817 return varname(gv, hash ? '%' : '@', obase->op_targ,
818 keysv, index, subscript_type);
822 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
824 return varname(Nullgv, '$', obase->op_targ,
825 Nullsv, 0, FUV_SUBSCRIPT_NONE);
828 gv = cGVOPx_gv(obase);
829 if (!gv || (match && GvSV(gv) != uninit_sv))
831 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
834 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
837 av = (AV*)PAD_SV(obase->op_targ);
838 if (!av || SvRMAGICAL(av))
840 svp = av_fetch(av, (I32)obase->op_private, FALSE);
841 if (!svp || *svp != uninit_sv)
844 return varname(Nullgv, '$', obase->op_targ,
845 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
848 gv = cGVOPx_gv(obase);
854 if (!av || SvRMAGICAL(av))
856 svp = av_fetch(av, (I32)obase->op_private, FALSE);
857 if (!svp || *svp != uninit_sv)
860 return varname(gv, '$', 0,
861 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
866 o = cUNOPx(obase)->op_first;
867 if (!o || o->op_type != OP_NULL ||
868 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
870 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
875 /* $a[uninit_expr] or $h{uninit_expr} */
876 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
879 o = cBINOPx(obase)->op_first;
880 kid = cBINOPx(obase)->op_last;
882 /* get the av or hv, and optionally the gv */
884 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
885 sv = PAD_SV(o->op_targ);
887 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
888 && cUNOPo->op_first->op_type == OP_GV)
890 gv = cGVOPx_gv(cUNOPo->op_first);
893 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
898 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
899 /* index is constant */
903 if (obase->op_type == OP_HELEM) {
904 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
905 if (!he || HeVAL(he) != uninit_sv)
909 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
910 if (!svp || *svp != uninit_sv)
914 if (obase->op_type == OP_HELEM)
915 return varname(gv, '%', o->op_targ,
916 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
918 return varname(gv, '@', o->op_targ, Nullsv,
919 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
923 /* index is an expression;
924 * attempt to find a match within the aggregate */
925 if (obase->op_type == OP_HELEM) {
926 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
928 return varname(gv, '%', o->op_targ,
929 keysv, 0, FUV_SUBSCRIPT_HASH);
932 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
934 return varname(gv, '@', o->op_targ,
935 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
940 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
942 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
948 /* only examine RHS */
949 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
952 o = cUNOPx(obase)->op_first;
953 if (o->op_type == OP_PUSHMARK)
956 if (!o->op_sibling) {
957 /* one-arg version of open is highly magical */
959 if (o->op_type == OP_GV) { /* open FOO; */
961 if (match && GvSV(gv) != uninit_sv)
963 return varname(gv, '$', 0,
964 Nullsv, 0, FUV_SUBSCRIPT_NONE);
966 /* other possibilities not handled are:
967 * open $x; or open my $x; should return '${*$x}'
968 * open expr; should return '$'.expr ideally
974 /* ops where $_ may be an implicit arg */
978 if ( !(obase->op_flags & OPf_STACKED)) {
979 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
980 ? PAD_SVl(obase->op_targ)
984 sv_setpvn(sv, "$_", 2);
992 /* skip filehandle as it can't produce 'undef' warning */
993 o = cUNOPx(obase)->op_first;
994 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
995 o = o->op_sibling->op_sibling;
1002 match = 1; /* XS or custom code could trigger random warnings */
1007 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1008 return sv_2mortal(newSVpvn("${$/}", 5));
1013 if (!(obase->op_flags & OPf_KIDS))
1015 o = cUNOPx(obase)->op_first;
1021 /* if all except one arg are constant, or have no side-effects,
1022 * or are optimized away, then it's unambiguous */
1024 for (kid=o; kid; kid = kid->op_sibling) {
1026 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1027 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1028 || (kid->op_type == OP_PUSHMARK)
1032 if (o2) { /* more than one found */
1039 return find_uninit_var(o2, uninit_sv, match);
1043 sv = find_uninit_var(o, uninit_sv, 1);
1055 =for apidoc report_uninit
1057 Print appropriate "Use of uninitialized variable" warning
1063 Perl_report_uninit(pTHX_ SV* uninit_sv)
1066 SV* varname = Nullsv;
1068 varname = find_uninit_var(PL_op, uninit_sv,0);
1070 sv_insert(varname, 0, 0, " ", 1);
1072 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1073 varname ? SvPV_nolen_const(varname) : "",
1074 " in ", OP_DESC(PL_op));
1077 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1082 Here are mid-level routines that manage the allocation of bodies out
1083 of the various arenas. There are 5 kinds of arenas:
1085 1. SV-head arenas, which are discussed and handled above
1086 2. regular body arenas
1087 3. arenas for reduced-size bodies
1088 4. Hash-Entry arenas
1089 5. pte arenas (thread related)
1091 Arena types 2 & 3 are chained by body-type off an array of
1092 arena-root pointers, which is indexed by svtype. Some of the
1093 larger/less used body types are malloced singly, since a large
1094 unused block of them is wasteful. Also, several svtypes dont have
1095 bodies; the data fits into the sv-head itself. The arena-root
1096 pointer thus has a few unused root-pointers (which may be hijacked
1097 later for arena types 4,5)
1099 3 differs from 2 as an optimization; some body types have several
1100 unused fields in the front of the structure (which are kept in-place
1101 for consistency). These bodies can be allocated in smaller chunks,
1102 because the leading fields arent accessed. Pointers to such bodies
1103 are decremented to point at the unused 'ghost' memory, knowing that
1104 the pointers are used with offsets to the real memory.
1106 HE, HEK arenas are managed separately, with separate code, but may
1107 be merge-able later..
1109 PTE arenas are not sv-bodies, but they share these mid-level
1110 mechanics, so are considered here. The new mid-level mechanics rely
1111 on the sv_type of the body being allocated, so we just reserve one
1112 of the unused body-slots for PTEs, then use it in those (2) PTE
1113 contexts below (line ~10k)
1117 S_more_bodies (pTHX_ size_t size, svtype sv_type)
1119 void **arena_root = &PL_body_arenaroots[sv_type];
1120 void **root = &PL_body_roots[sv_type];
1123 const size_t count = PERL_ARENA_SIZE / size;
1125 Newx(start, count*size, char);
1126 *((void **) start) = *arena_root;
1127 *arena_root = (void *)start;
1129 end = start + (count-1) * size;
1131 /* The initial slot is used to link the arenas together, so it isn't to be
1132 linked into the list of ready-to-use bodies. */
1136 *root = (void *)start;
1138 while (start < end) {
1139 char * const next = start + size;
1140 *(void**) start = (void *)next;
1143 *(void **)start = 0;
1148 /* grab a new thing from the free list, allocating more if necessary */
1150 /* 1st, the inline version */
1152 #define new_body_inline(xpv, root, size, sv_type) \
1155 xpv = *((void **)(root)) \
1156 ? *((void **)(root)) : S_more_bodies(aTHX_ size, sv_type); \
1157 *(root) = *(void**)(xpv); \
1161 /* now use the inline version in the proper function */
1165 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
1166 compilers issue warnings. */
1169 S_new_body(pTHX_ size_t size, svtype sv_type)
1172 new_body_inline(xpv, &PL_body_roots[sv_type], size, sv_type);
1178 /* return a thing to the free list */
1180 #define del_body(thing, root) \
1182 void **thing_copy = (void **)thing; \
1184 *thing_copy = *root; \
1185 *root = (void*)thing_copy; \
1190 Revisiting type 3 arenas, there are 4 body-types which have some
1191 members that are never accessed. They are XPV, XPVIV, XPVAV,
1192 XPVHV, which have corresponding types: xpv_allocated,
1193 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
1195 For these types, the arenas are carved up into *_allocated size
1196 chunks, we thus avoid wasted memory for those unaccessed members.
1197 When bodies are allocated, we adjust the pointer back in memory by
1198 the size of the bit not allocated, so it's as if we allocated the
1199 full structure. (But things will all go boom if you write to the
1200 part that is "not there", because you'll be overwriting the last
1201 members of the preceding structure in memory.)
1203 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1204 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1205 and the pointer is unchanged. If the allocated structure is smaller (no
1206 initial NV actually allocated) then the net effect is to subtract the size
1207 of the NV from the pointer, to return a new pointer as if an initial NV were
1210 This is the same trick as was used for NV and IV bodies. Ironically it
1211 doesn't need to be used for NV bodies any more, because NV is now at the
1212 start of the structure. IV bodies don't need it either, because they are
1213 no longer allocated. */
1215 /* The following 2 arrays hide the above details in a pair of
1216 lookup-tables, allowing us to be body-type agnostic.
1218 size maps svtype to its body's allocated size.
1219 offset maps svtype to the body-pointer adjustment needed
1221 NB: elements in latter are 0 or <0, and are added during
1222 allocation, and subtracted during deallocation. It may be clearer
1223 to invert the values, and call it shrinkage_by_svtype.
1226 struct body_details {
1227 size_t size; /* Size to allocate */
1228 size_t copy; /* Size of structure to copy (may be shorter) */
1230 bool cant_upgrade; /* Can upgrade this type */
1231 bool zero_nv; /* zero the NV when upgrading from this */
1234 struct body_details bodies_by_type[] = {
1235 {0, 0, 0, FALSE, TRUE},
1236 /* IVs are in the head, so the allocation size is 0 */
1237 {0, sizeof(IV), -STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, TRUE},
1238 /* 8 bytes on most ILP32 with IEEE doubles */
1239 {sizeof(NV), sizeof(NV), 0, FALSE, FALSE},
1240 /* RVs are in the head now */
1241 {0, 0, 0, FALSE, TRUE},
1242 /* 8 bytes on most ILP32 with IEEE doubles */
1243 {sizeof(xpv_allocated),
1244 STRUCT_OFFSET(XPV, xpv_len) + sizeof (((XPV*)SvANY((SV*)0))->xpv_len)
1245 + STRUCT_OFFSET(xpv_allocated, xpv_cur) - STRUCT_OFFSET(XPV, xpv_cur),
1246 + STRUCT_OFFSET(xpv_allocated, xpv_cur) - STRUCT_OFFSET(XPV, xpv_cur)
1249 {sizeof(xpviv_allocated),
1250 STRUCT_OFFSET(XPVIV, xiv_u) + sizeof (((XPVIV*)SvANY((SV*)0))->xiv_u)
1251 + STRUCT_OFFSET(xpviv_allocated, xpv_cur) - STRUCT_OFFSET(XPVIV, xpv_cur),
1252 + STRUCT_OFFSET(xpviv_allocated, xpv_cur) - STRUCT_OFFSET(XPVIV, xpv_cur)
1256 STRUCT_OFFSET(XPVNV, xiv_u) + sizeof (((XPVNV*)SvANY((SV*)0))->xiv_u),
1260 STRUCT_OFFSET(XPVMG, xmg_stash) + sizeof (((XPVMG*)SvANY((SV*)0))->xmg_stash),
1263 {sizeof(XPVBM), 0, 0, TRUE, FALSE},
1265 {sizeof(XPVGV), 0, 0, TRUE, FALSE},
1267 {sizeof(XPVLV), 0, 0, TRUE, FALSE},
1269 {sizeof(xpvav_allocated), 0,
1270 STRUCT_OFFSET(xpvav_allocated, xav_fill)
1271 - STRUCT_OFFSET(XPVAV, xav_fill), TRUE, FALSE},
1273 {sizeof(xpvhv_allocated), 0,
1274 STRUCT_OFFSET(xpvhv_allocated, xhv_fill)
1275 - STRUCT_OFFSET(XPVHV, xhv_fill), TRUE, FALSE},
1277 {sizeof(XPVCV), 0, 0, TRUE, FALSE},
1279 {sizeof(XPVFM), 0, 0, TRUE, FALSE},
1281 {sizeof(XPVIO), 0, 0, TRUE, FALSE}
1284 #define new_body_type(sv_type) \
1285 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
1286 + bodies_by_type[sv_type].offset)
1288 #define del_body_type(p, sv_type) \
1289 del_body(p, &PL_body_roots[sv_type])
1292 #define new_body_allocated(sv_type) \
1293 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
1294 + bodies_by_type[sv_type].offset)
1296 #define del_body_allocated(p, sv_type) \
1297 del_body(p - bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
1300 #define my_safemalloc(s) (void*)safemalloc(s)
1301 #define my_safefree(p) safefree((char*)p)
1305 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1306 #define del_XNV(p) my_safefree(p)
1308 #define new_XPV() my_safemalloc(sizeof(XPV))
1309 #define del_XPV(p) my_safefree(p)
1311 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1312 #define del_XPVIV(p) my_safefree(p)
1314 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1315 #define del_XPVNV(p) my_safefree(p)
1317 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1318 #define del_XPVCV(p) my_safefree(p)
1320 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1321 #define del_XPVAV(p) my_safefree(p)
1323 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1324 #define del_XPVHV(p) my_safefree(p)
1326 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1327 #define del_XPVMG(p) my_safefree(p)
1329 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1330 #define del_XPVGV(p) my_safefree(p)
1332 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1333 #define del_XPVLV(p) my_safefree(p)
1335 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1336 #define del_XPVBM(p) my_safefree(p)
1340 #define new_XNV() new_body_type(SVt_NV)
1341 #define del_XNV(p) del_body_type(p, SVt_NV)
1343 #define new_XPV() new_body_allocated(SVt_PV)
1344 #define del_XPV(p) del_body_allocated(p, SVt_PV)
1346 #define new_XPVIV() new_body_allocated(SVt_PVIV)
1347 #define del_XPVIV(p) del_body_allocated(p, SVt_PVIV)
1349 #define new_XPVNV() new_body_type(SVt_PVNV)
1350 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1352 #define new_XPVCV() new_body_type(SVt_PVCV)
1353 #define del_XPVCV(p) del_body_type(p, SVt_PVCV)
1355 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1356 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1358 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1359 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1361 #define new_XPVMG() new_body_type(SVt_PVMG)
1362 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1364 #define new_XPVGV() new_body_type(SVt_PVGV)
1365 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1367 #define new_XPVLV() new_body_type(SVt_PVLV)
1368 #define del_XPVLV(p) del_body_type(p, SVt_PVLV)
1370 #define new_XPVBM() new_body_type(SVt_PVBM)
1371 #define del_XPVBM(p) del_body_type(p, SVt_PVBM)
1375 /* no arena for you! */
1376 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1377 #define del_XPVFM(p) my_safefree(p)
1379 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1380 #define del_XPVIO(p) my_safefree(p)
1385 =for apidoc sv_upgrade
1387 Upgrade an SV to a more complex form. Generally adds a new body type to the
1388 SV, then copies across as much information as possible from the old body.
1389 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1395 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1399 size_t new_body_length;
1400 size_t new_body_offset;
1401 void** new_body_arena;
1402 void** new_body_arenaroot;
1403 const U32 old_type = SvTYPE(sv);
1404 const struct body_details *const old_type_details
1405 = bodies_by_type + old_type;
1407 if (mt != SVt_PV && SvIsCOW(sv)) {
1408 sv_force_normal_flags(sv, 0);
1415 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1416 (int)old_type, (int)mt);
1419 old_body = SvANY(sv);
1420 new_body_offset = 0;
1421 new_body_length = ~0;
1423 /* Copying structures onto other structures that have been neatly zeroed
1424 has a subtle gotcha. Consider XPVMG
1426 +------+------+------+------+------+-------+-------+
1427 | NV | CUR | LEN | IV | MAGIC | STASH |
1428 +------+------+------+------+------+-------+-------+
1429 0 4 8 12 16 20 24 28
1431 where NVs are aligned to 8 bytes, so that sizeof that structure is
1432 actually 32 bytes long, with 4 bytes of padding at the end:
1434 +------+------+------+------+------+-------+-------+------+
1435 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1436 +------+------+------+------+------+-------+-------+------+
1437 0 4 8 12 16 20 24 28 32
1439 so what happens if you allocate memory for this structure:
1441 +------+------+------+------+------+-------+-------+------+------+...
1442 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1443 +------+------+------+------+------+-------+-------+------+------+...
1444 0 4 8 12 16 20 24 28 32 36
1446 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1447 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1448 started out as zero once, but it's quite possible that it isn't. So now,
1449 rather than a nicely zeroed GP, you have it pointing somewhere random.
1452 (In fact, GP ends up pointing at a previous GP structure, because the
1453 principle cause of the padding in XPVMG getting garbage is a copy of
1454 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1456 So we are careful and work out the size of used parts of all the
1465 else if (mt < SVt_PVIV)
1477 else if (mt == SVt_NV)
1485 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1486 there's no way that it can be safely upgraded, because perl.c
1487 expects to Safefree(SvANY(PL_mess_sv)) */
1488 assert(sv != PL_mess_sv);
1489 /* This flag bit is used to mean other things in other scalar types.
1490 Given that it only has meaning inside the pad, it shouldn't be set
1491 on anything that can get upgraded. */
1492 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1495 if (old_type_details->cant_upgrade)
1496 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1499 SvFLAGS(sv) &= ~SVTYPEMASK;
1504 Perl_croak(aTHX_ "Can't upgrade to undef");
1506 assert(old_type == SVt_NULL);
1507 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1511 assert(old_type == SVt_NULL);
1512 SvANY(sv) = new_XNV();
1516 assert(old_type == SVt_NULL);
1517 SvANY(sv) = &sv->sv_u.svu_rv;
1521 SvANY(sv) = new_XPVHV();
1524 HvTOTALKEYS(sv) = 0;
1529 SvANY(sv) = new_XPVAV();
1536 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1537 The target created by newSVrv also is, and it can have magic.
1538 However, it never has SvPVX set.
1540 if (old_type >= SVt_RV) {
1541 assert(SvPVX_const(sv) == 0);
1544 /* Could put this in the else clause below, as PVMG must have SvPVX
1545 0 already (the assertion above) */
1546 SvPV_set(sv, (char*)0);
1548 if (old_type >= SVt_PVMG) {
1549 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1550 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1558 new_body = new_XPVIO();
1559 new_body_length = sizeof(XPVIO);
1562 new_body = new_XPVFM();
1563 new_body_length = sizeof(XPVFM);
1572 new_body_length = bodies_by_type[mt].size;
1573 new_body_arena = &PL_body_roots[mt];
1574 new_body_arenaroot = &PL_body_arenaroots[mt];
1578 new_body_offset = - bodies_by_type[SVt_PVIV].offset;
1579 new_body_length = sizeof(XPVIV) - new_body_offset;
1580 new_body_arena = &PL_body_roots[SVt_PVIV];
1581 new_body_arenaroot = &PL_body_arenaroots[SVt_PVIV];
1582 /* XXX Is this still needed? Was it ever needed? Surely as there is
1583 no route from NV to PVIV, NOK can never be true */
1587 goto new_body_no_NV;
1589 new_body_offset = - bodies_by_type[SVt_PV].offset;
1590 new_body_length = sizeof(XPV) - new_body_offset;
1591 new_body_arena = &PL_body_roots[SVt_PV];
1592 new_body_arenaroot = &PL_body_arenaroots[SVt_PV];
1594 /* PV and PVIV don't have an NV slot. */
1597 assert(new_body_length);
1599 /* This points to the start of the allocated area. */
1600 new_body_inline(new_body, new_body_arena, new_body_length, mt);
1602 /* We always allocated the full length item with PURIFY */
1603 new_body_length += new_body_offset;
1604 new_body_offset = 0;
1605 new_body = my_safemalloc(new_body_length);
1609 Zero(new_body, new_body_length, char);
1610 new_body = ((char *)new_body) - new_body_offset;
1611 SvANY(sv) = new_body;
1613 if (old_type_details->copy) {
1614 Copy((char *)old_body - old_type_details->offset,
1615 (char *)new_body - old_type_details->offset,
1616 old_type_details->copy, char);
1619 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1620 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1622 if (old_type_details->zero_nv)
1627 IoPAGE_LEN(sv) = 60;
1628 if (old_type < SVt_RV)
1632 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1635 if (old_type_details->size) {
1636 /* If the old body had an allocated size, then we need to free it. */
1638 my_safefree(old_body);
1640 del_body((void*)((char*)old_body - old_type_details->offset),
1641 &PL_body_roots[old_type]);
1647 =for apidoc sv_backoff
1649 Remove any string offset. You should normally use the C<SvOOK_off> macro
1656 Perl_sv_backoff(pTHX_ register SV *sv)
1659 assert(SvTYPE(sv) != SVt_PVHV);
1660 assert(SvTYPE(sv) != SVt_PVAV);
1662 const char * const s = SvPVX_const(sv);
1663 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1664 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1666 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1668 SvFLAGS(sv) &= ~SVf_OOK;
1675 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1676 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1677 Use the C<SvGROW> wrapper instead.
1683 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1687 #ifdef HAS_64K_LIMIT
1688 if (newlen >= 0x10000) {
1689 PerlIO_printf(Perl_debug_log,
1690 "Allocation too large: %"UVxf"\n", (UV)newlen);
1693 #endif /* HAS_64K_LIMIT */
1696 if (SvTYPE(sv) < SVt_PV) {
1697 sv_upgrade(sv, SVt_PV);
1698 s = SvPVX_mutable(sv);
1700 else if (SvOOK(sv)) { /* pv is offset? */
1702 s = SvPVX_mutable(sv);
1703 if (newlen > SvLEN(sv))
1704 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1705 #ifdef HAS_64K_LIMIT
1706 if (newlen >= 0x10000)
1711 s = SvPVX_mutable(sv);
1713 if (newlen > SvLEN(sv)) { /* need more room? */
1714 newlen = PERL_STRLEN_ROUNDUP(newlen);
1715 if (SvLEN(sv) && s) {
1717 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1723 s = saferealloc(s, newlen);
1726 s = safemalloc(newlen);
1727 if (SvPVX_const(sv) && SvCUR(sv)) {
1728 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1732 SvLEN_set(sv, newlen);
1738 =for apidoc sv_setiv
1740 Copies an integer into the given SV, upgrading first if necessary.
1741 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1747 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1749 SV_CHECK_THINKFIRST_COW_DROP(sv);
1750 switch (SvTYPE(sv)) {
1752 sv_upgrade(sv, SVt_IV);
1755 sv_upgrade(sv, SVt_PVNV);
1759 sv_upgrade(sv, SVt_PVIV);
1768 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1771 (void)SvIOK_only(sv); /* validate number */
1777 =for apidoc sv_setiv_mg
1779 Like C<sv_setiv>, but also handles 'set' magic.
1785 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1792 =for apidoc sv_setuv
1794 Copies an unsigned integer into the given SV, upgrading first if necessary.
1795 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1801 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1803 /* With these two if statements:
1804 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1807 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1809 If you wish to remove them, please benchmark to see what the effect is
1811 if (u <= (UV)IV_MAX) {
1812 sv_setiv(sv, (IV)u);
1821 =for apidoc sv_setuv_mg
1823 Like C<sv_setuv>, but also handles 'set' magic.
1829 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1838 =for apidoc sv_setnv
1840 Copies a double into the given SV, upgrading first if necessary.
1841 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1847 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1849 SV_CHECK_THINKFIRST_COW_DROP(sv);
1850 switch (SvTYPE(sv)) {
1853 sv_upgrade(sv, SVt_NV);
1858 sv_upgrade(sv, SVt_PVNV);
1867 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1871 (void)SvNOK_only(sv); /* validate number */
1876 =for apidoc sv_setnv_mg
1878 Like C<sv_setnv>, but also handles 'set' magic.
1884 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1890 /* Print an "isn't numeric" warning, using a cleaned-up,
1891 * printable version of the offending string
1895 S_not_a_number(pTHX_ SV *sv)
1902 dsv = sv_2mortal(newSVpvn("", 0));
1903 pv = sv_uni_display(dsv, sv, 10, 0);
1906 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1907 /* each *s can expand to 4 chars + "...\0",
1908 i.e. need room for 8 chars */
1910 const char *s, *end;
1911 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1914 if (ch & 128 && !isPRINT_LC(ch)) {
1923 else if (ch == '\r') {
1927 else if (ch == '\f') {
1931 else if (ch == '\\') {
1935 else if (ch == '\0') {
1939 else if (isPRINT_LC(ch))
1956 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1957 "Argument \"%s\" isn't numeric in %s", pv,
1960 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1961 "Argument \"%s\" isn't numeric", pv);
1965 =for apidoc looks_like_number
1967 Test if the content of an SV looks like a number (or is a number).
1968 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1969 non-numeric warning), even if your atof() doesn't grok them.
1975 Perl_looks_like_number(pTHX_ SV *sv)
1977 register const char *sbegin;
1981 sbegin = SvPVX_const(sv);
1984 else if (SvPOKp(sv))
1985 sbegin = SvPV_const(sv, len);
1987 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1988 return grok_number(sbegin, len, NULL);
1991 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1992 until proven guilty, assume that things are not that bad... */
1997 As 64 bit platforms often have an NV that doesn't preserve all bits of
1998 an IV (an assumption perl has been based on to date) it becomes necessary
1999 to remove the assumption that the NV always carries enough precision to
2000 recreate the IV whenever needed, and that the NV is the canonical form.
2001 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2002 precision as a side effect of conversion (which would lead to insanity
2003 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2004 1) to distinguish between IV/UV/NV slots that have cached a valid
2005 conversion where precision was lost and IV/UV/NV slots that have a
2006 valid conversion which has lost no precision
2007 2) to ensure that if a numeric conversion to one form is requested that
2008 would lose precision, the precise conversion (or differently
2009 imprecise conversion) is also performed and cached, to prevent
2010 requests for different numeric formats on the same SV causing
2011 lossy conversion chains. (lossless conversion chains are perfectly
2016 SvIOKp is true if the IV slot contains a valid value
2017 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2018 SvNOKp is true if the NV slot contains a valid value
2019 SvNOK is true only if the NV value is accurate
2022 while converting from PV to NV, check to see if converting that NV to an
2023 IV(or UV) would lose accuracy over a direct conversion from PV to
2024 IV(or UV). If it would, cache both conversions, return NV, but mark
2025 SV as IOK NOKp (ie not NOK).
2027 While converting from PV to IV, check to see if converting that IV to an
2028 NV would lose accuracy over a direct conversion from PV to NV. If it
2029 would, cache both conversions, flag similarly.
2031 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2032 correctly because if IV & NV were set NV *always* overruled.
2033 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2034 changes - now IV and NV together means that the two are interchangeable:
2035 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2037 The benefit of this is that operations such as pp_add know that if
2038 SvIOK is true for both left and right operands, then integer addition
2039 can be used instead of floating point (for cases where the result won't
2040 overflow). Before, floating point was always used, which could lead to
2041 loss of precision compared with integer addition.
2043 * making IV and NV equal status should make maths accurate on 64 bit
2045 * may speed up maths somewhat if pp_add and friends start to use
2046 integers when possible instead of fp. (Hopefully the overhead in
2047 looking for SvIOK and checking for overflow will not outweigh the
2048 fp to integer speedup)
2049 * will slow down integer operations (callers of SvIV) on "inaccurate"
2050 values, as the change from SvIOK to SvIOKp will cause a call into
2051 sv_2iv each time rather than a macro access direct to the IV slot
2052 * should speed up number->string conversion on integers as IV is
2053 favoured when IV and NV are equally accurate
2055 ####################################################################
2056 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2057 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2058 On the other hand, SvUOK is true iff UV.
2059 ####################################################################
2061 Your mileage will vary depending your CPU's relative fp to integer
2065 #ifndef NV_PRESERVES_UV
2066 # define IS_NUMBER_UNDERFLOW_IV 1
2067 # define IS_NUMBER_UNDERFLOW_UV 2
2068 # define IS_NUMBER_IV_AND_UV 2
2069 # define IS_NUMBER_OVERFLOW_IV 4
2070 # define IS_NUMBER_OVERFLOW_UV 5
2072 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2074 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2076 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2078 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));
2079 if (SvNVX(sv) < (NV)IV_MIN) {
2080 (void)SvIOKp_on(sv);
2082 SvIV_set(sv, IV_MIN);
2083 return IS_NUMBER_UNDERFLOW_IV;
2085 if (SvNVX(sv) > (NV)UV_MAX) {
2086 (void)SvIOKp_on(sv);
2089 SvUV_set(sv, UV_MAX);
2090 return IS_NUMBER_OVERFLOW_UV;
2092 (void)SvIOKp_on(sv);
2094 /* Can't use strtol etc to convert this string. (See truth table in
2096 if (SvNVX(sv) <= (UV)IV_MAX) {
2097 SvIV_set(sv, I_V(SvNVX(sv)));
2098 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2099 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2101 /* Integer is imprecise. NOK, IOKp */
2103 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2106 SvUV_set(sv, U_V(SvNVX(sv)));
2107 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2108 if (SvUVX(sv) == UV_MAX) {
2109 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2110 possibly be preserved by NV. Hence, it must be overflow.
2112 return IS_NUMBER_OVERFLOW_UV;
2114 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2116 /* Integer is imprecise. NOK, IOKp */
2118 return IS_NUMBER_OVERFLOW_IV;
2120 #endif /* !NV_PRESERVES_UV*/
2123 =for apidoc sv_2iv_flags
2125 Return the integer value of an SV, doing any necessary string
2126 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2127 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2133 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2137 if (SvGMAGICAL(sv)) {
2138 if (flags & SV_GMAGIC)
2143 return I_V(SvNVX(sv));
2145 if (SvPOKp(sv) && SvLEN(sv))
2148 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2149 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2155 if (SvTHINKFIRST(sv)) {
2158 SV * const tmpstr=AMG_CALLun(sv,numer);
2159 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2160 return SvIV(tmpstr);
2163 return PTR2IV(SvRV(sv));
2166 sv_force_normal_flags(sv, 0);
2168 if (SvREADONLY(sv) && !SvOK(sv)) {
2169 if (ckWARN(WARN_UNINITIALIZED))
2176 return (IV)(SvUVX(sv));
2183 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2184 * without also getting a cached IV/UV from it at the same time
2185 * (ie PV->NV conversion should detect loss of accuracy and cache
2186 * IV or UV at same time to avoid this. NWC */
2188 if (SvTYPE(sv) == SVt_NV)
2189 sv_upgrade(sv, SVt_PVNV);
2191 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2192 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2193 certainly cast into the IV range at IV_MAX, whereas the correct
2194 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2196 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2197 SvIV_set(sv, I_V(SvNVX(sv)));
2198 if (SvNVX(sv) == (NV) SvIVX(sv)
2199 #ifndef NV_PRESERVES_UV
2200 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2201 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2202 /* Don't flag it as "accurately an integer" if the number
2203 came from a (by definition imprecise) NV operation, and
2204 we're outside the range of NV integer precision */
2207 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2208 DEBUG_c(PerlIO_printf(Perl_debug_log,
2209 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2215 /* IV not precise. No need to convert from PV, as NV
2216 conversion would already have cached IV if it detected
2217 that PV->IV would be better than PV->NV->IV
2218 flags already correct - don't set public IOK. */
2219 DEBUG_c(PerlIO_printf(Perl_debug_log,
2220 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2225 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2226 but the cast (NV)IV_MIN rounds to a the value less (more
2227 negative) than IV_MIN which happens to be equal to SvNVX ??
2228 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2229 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2230 (NV)UVX == NVX are both true, but the values differ. :-(
2231 Hopefully for 2s complement IV_MIN is something like
2232 0x8000000000000000 which will be exact. NWC */
2235 SvUV_set(sv, U_V(SvNVX(sv)));
2237 (SvNVX(sv) == (NV) SvUVX(sv))
2238 #ifndef NV_PRESERVES_UV
2239 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2240 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2241 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2242 /* Don't flag it as "accurately an integer" if the number
2243 came from a (by definition imprecise) NV operation, and
2244 we're outside the range of NV integer precision */
2250 DEBUG_c(PerlIO_printf(Perl_debug_log,
2251 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2255 return (IV)SvUVX(sv);
2258 else if (SvPOKp(sv) && SvLEN(sv)) {
2260 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2261 /* We want to avoid a possible problem when we cache an IV which
2262 may be later translated to an NV, and the resulting NV is not
2263 the same as the direct translation of the initial string
2264 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2265 be careful to ensure that the value with the .456 is around if the
2266 NV value is requested in the future).
2268 This means that if we cache such an IV, we need to cache the
2269 NV as well. Moreover, we trade speed for space, and do not
2270 cache the NV if we are sure it's not needed.
2273 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2274 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2275 == IS_NUMBER_IN_UV) {
2276 /* It's definitely an integer, only upgrade to PVIV */
2277 if (SvTYPE(sv) < SVt_PVIV)
2278 sv_upgrade(sv, SVt_PVIV);
2280 } else if (SvTYPE(sv) < SVt_PVNV)
2281 sv_upgrade(sv, SVt_PVNV);
2283 /* If NV preserves UV then we only use the UV value if we know that
2284 we aren't going to call atof() below. If NVs don't preserve UVs
2285 then the value returned may have more precision than atof() will
2286 return, even though value isn't perfectly accurate. */
2287 if ((numtype & (IS_NUMBER_IN_UV
2288 #ifdef NV_PRESERVES_UV
2291 )) == IS_NUMBER_IN_UV) {
2292 /* This won't turn off the public IOK flag if it was set above */
2293 (void)SvIOKp_on(sv);
2295 if (!(numtype & IS_NUMBER_NEG)) {
2297 if (value <= (UV)IV_MAX) {
2298 SvIV_set(sv, (IV)value);
2300 SvUV_set(sv, value);
2304 /* 2s complement assumption */
2305 if (value <= (UV)IV_MIN) {
2306 SvIV_set(sv, -(IV)value);
2308 /* Too negative for an IV. This is a double upgrade, but
2309 I'm assuming it will be rare. */
2310 if (SvTYPE(sv) < SVt_PVNV)
2311 sv_upgrade(sv, SVt_PVNV);
2315 SvNV_set(sv, -(NV)value);
2316 SvIV_set(sv, IV_MIN);
2320 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2321 will be in the previous block to set the IV slot, and the next
2322 block to set the NV slot. So no else here. */
2324 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2325 != IS_NUMBER_IN_UV) {
2326 /* It wasn't an (integer that doesn't overflow the UV). */
2327 SvNV_set(sv, Atof(SvPVX_const(sv)));
2329 if (! numtype && ckWARN(WARN_NUMERIC))
2332 #if defined(USE_LONG_DOUBLE)
2333 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2334 PTR2UV(sv), SvNVX(sv)));
2336 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2337 PTR2UV(sv), SvNVX(sv)));
2341 #ifdef NV_PRESERVES_UV
2342 (void)SvIOKp_on(sv);
2344 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2345 SvIV_set(sv, I_V(SvNVX(sv)));
2346 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2349 /* Integer is imprecise. NOK, IOKp */
2351 /* UV will not work better than IV */
2353 if (SvNVX(sv) > (NV)UV_MAX) {
2355 /* Integer is inaccurate. NOK, IOKp, is UV */
2356 SvUV_set(sv, UV_MAX);
2359 SvUV_set(sv, U_V(SvNVX(sv)));
2360 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2361 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2365 /* Integer is imprecise. NOK, IOKp, is UV */
2371 #else /* NV_PRESERVES_UV */
2372 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2373 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2374 /* The IV slot will have been set from value returned by
2375 grok_number above. The NV slot has just been set using
2378 assert (SvIOKp(sv));
2380 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2381 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2382 /* Small enough to preserve all bits. */
2383 (void)SvIOKp_on(sv);
2385 SvIV_set(sv, I_V(SvNVX(sv)));
2386 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2388 /* Assumption: first non-preserved integer is < IV_MAX,
2389 this NV is in the preserved range, therefore: */
2390 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2392 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);
2396 0 0 already failed to read UV.
2397 0 1 already failed to read UV.
2398 1 0 you won't get here in this case. IV/UV
2399 slot set, public IOK, Atof() unneeded.
2400 1 1 already read UV.
2401 so there's no point in sv_2iuv_non_preserve() attempting
2402 to use atol, strtol, strtoul etc. */
2403 if (sv_2iuv_non_preserve (sv, numtype)
2404 >= IS_NUMBER_OVERFLOW_IV)
2408 #endif /* NV_PRESERVES_UV */
2411 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2413 if (SvTYPE(sv) < SVt_IV)
2414 /* Typically the caller expects that sv_any is not NULL now. */
2415 sv_upgrade(sv, SVt_IV);
2418 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2419 PTR2UV(sv),SvIVX(sv)));
2420 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2424 =for apidoc sv_2uv_flags
2426 Return the unsigned integer value of an SV, doing any necessary string
2427 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2428 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2434 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2438 if (SvGMAGICAL(sv)) {
2439 if (flags & SV_GMAGIC)
2444 return U_V(SvNVX(sv));
2445 if (SvPOKp(sv) && SvLEN(sv))
2448 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2449 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2455 if (SvTHINKFIRST(sv)) {
2458 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2459 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2460 return SvUV(tmpstr);
2461 return PTR2UV(SvRV(sv));
2464 sv_force_normal_flags(sv, 0);
2466 if (SvREADONLY(sv) && !SvOK(sv)) {
2467 if (ckWARN(WARN_UNINITIALIZED))
2477 return (UV)SvIVX(sv);
2481 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2482 * without also getting a cached IV/UV from it at the same time
2483 * (ie PV->NV conversion should detect loss of accuracy and cache
2484 * IV or UV at same time to avoid this. */
2485 /* IV-over-UV optimisation - choose to cache IV if possible */
2487 if (SvTYPE(sv) == SVt_NV)
2488 sv_upgrade(sv, SVt_PVNV);
2490 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2491 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2492 SvIV_set(sv, I_V(SvNVX(sv)));
2493 if (SvNVX(sv) == (NV) SvIVX(sv)
2494 #ifndef NV_PRESERVES_UV
2495 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2496 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2497 /* Don't flag it as "accurately an integer" if the number
2498 came from a (by definition imprecise) NV operation, and
2499 we're outside the range of NV integer precision */
2502 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2503 DEBUG_c(PerlIO_printf(Perl_debug_log,
2504 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2510 /* IV not precise. No need to convert from PV, as NV
2511 conversion would already have cached IV if it detected
2512 that PV->IV would be better than PV->NV->IV
2513 flags already correct - don't set public IOK. */
2514 DEBUG_c(PerlIO_printf(Perl_debug_log,
2515 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2520 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2521 but the cast (NV)IV_MIN rounds to a the value less (more
2522 negative) than IV_MIN which happens to be equal to SvNVX ??
2523 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2524 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2525 (NV)UVX == NVX are both true, but the values differ. :-(
2526 Hopefully for 2s complement IV_MIN is something like
2527 0x8000000000000000 which will be exact. NWC */
2530 SvUV_set(sv, U_V(SvNVX(sv)));
2532 (SvNVX(sv) == (NV) SvUVX(sv))
2533 #ifndef NV_PRESERVES_UV
2534 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2535 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2536 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2537 /* Don't flag it as "accurately an integer" if the number
2538 came from a (by definition imprecise) NV operation, and
2539 we're outside the range of NV integer precision */
2544 DEBUG_c(PerlIO_printf(Perl_debug_log,
2545 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2551 else if (SvPOKp(sv) && SvLEN(sv)) {
2553 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2555 /* We want to avoid a possible problem when we cache a UV which
2556 may be later translated to an NV, and the resulting NV is not
2557 the translation of the initial data.
2559 This means that if we cache such a UV, we need to cache the
2560 NV as well. Moreover, we trade speed for space, and do not
2561 cache the NV if not needed.
2564 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2565 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2566 == IS_NUMBER_IN_UV) {
2567 /* It's definitely an integer, only upgrade to PVIV */
2568 if (SvTYPE(sv) < SVt_PVIV)
2569 sv_upgrade(sv, SVt_PVIV);
2571 } else if (SvTYPE(sv) < SVt_PVNV)
2572 sv_upgrade(sv, SVt_PVNV);
2574 /* If NV preserves UV then we only use the UV value if we know that
2575 we aren't going to call atof() below. If NVs don't preserve UVs
2576 then the value returned may have more precision than atof() will
2577 return, even though it isn't accurate. */
2578 if ((numtype & (IS_NUMBER_IN_UV
2579 #ifdef NV_PRESERVES_UV
2582 )) == IS_NUMBER_IN_UV) {
2583 /* This won't turn off the public IOK flag if it was set above */
2584 (void)SvIOKp_on(sv);
2586 if (!(numtype & IS_NUMBER_NEG)) {
2588 if (value <= (UV)IV_MAX) {
2589 SvIV_set(sv, (IV)value);
2591 /* it didn't overflow, and it was positive. */
2592 SvUV_set(sv, value);
2596 /* 2s complement assumption */
2597 if (value <= (UV)IV_MIN) {
2598 SvIV_set(sv, -(IV)value);
2600 /* Too negative for an IV. This is a double upgrade, but
2601 I'm assuming it will be rare. */
2602 if (SvTYPE(sv) < SVt_PVNV)
2603 sv_upgrade(sv, SVt_PVNV);
2607 SvNV_set(sv, -(NV)value);
2608 SvIV_set(sv, IV_MIN);
2613 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2614 != IS_NUMBER_IN_UV) {
2615 /* It wasn't an integer, or it overflowed the UV. */
2616 SvNV_set(sv, Atof(SvPVX_const(sv)));
2618 if (! numtype && ckWARN(WARN_NUMERIC))
2621 #if defined(USE_LONG_DOUBLE)
2622 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2623 PTR2UV(sv), SvNVX(sv)));
2625 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2626 PTR2UV(sv), SvNVX(sv)));
2629 #ifdef NV_PRESERVES_UV
2630 (void)SvIOKp_on(sv);
2632 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2633 SvIV_set(sv, I_V(SvNVX(sv)));
2634 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2637 /* Integer is imprecise. NOK, IOKp */
2639 /* UV will not work better than IV */
2641 if (SvNVX(sv) > (NV)UV_MAX) {
2643 /* Integer is inaccurate. NOK, IOKp, is UV */
2644 SvUV_set(sv, UV_MAX);
2647 SvUV_set(sv, U_V(SvNVX(sv)));
2648 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2649 NV preservse UV so can do correct comparison. */
2650 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2654 /* Integer is imprecise. NOK, IOKp, is UV */
2659 #else /* NV_PRESERVES_UV */
2660 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2661 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2662 /* The UV slot will have been set from value returned by
2663 grok_number above. The NV slot has just been set using
2666 assert (SvIOKp(sv));
2668 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2669 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2670 /* Small enough to preserve all bits. */
2671 (void)SvIOKp_on(sv);
2673 SvIV_set(sv, I_V(SvNVX(sv)));
2674 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2676 /* Assumption: first non-preserved integer is < IV_MAX,
2677 this NV is in the preserved range, therefore: */
2678 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2680 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);
2683 sv_2iuv_non_preserve (sv, numtype);
2685 #endif /* NV_PRESERVES_UV */
2689 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2690 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2693 if (SvTYPE(sv) < SVt_IV)
2694 /* Typically the caller expects that sv_any is not NULL now. */
2695 sv_upgrade(sv, SVt_IV);
2699 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2700 PTR2UV(sv),SvUVX(sv)));
2701 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2707 Return the num value of an SV, doing any necessary string or integer
2708 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2715 Perl_sv_2nv(pTHX_ register SV *sv)
2719 if (SvGMAGICAL(sv)) {
2723 if (SvPOKp(sv) && SvLEN(sv)) {
2724 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2725 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2727 return Atof(SvPVX_const(sv));
2731 return (NV)SvUVX(sv);
2733 return (NV)SvIVX(sv);
2736 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2737 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2743 if (SvTHINKFIRST(sv)) {
2746 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2747 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2748 return SvNV(tmpstr);
2749 return PTR2NV(SvRV(sv));
2752 sv_force_normal_flags(sv, 0);
2754 if (SvREADONLY(sv) && !SvOK(sv)) {
2755 if (ckWARN(WARN_UNINITIALIZED))
2760 if (SvTYPE(sv) < SVt_NV) {
2761 if (SvTYPE(sv) == SVt_IV)
2762 sv_upgrade(sv, SVt_PVNV);
2764 sv_upgrade(sv, SVt_NV);
2765 #ifdef USE_LONG_DOUBLE
2767 STORE_NUMERIC_LOCAL_SET_STANDARD();
2768 PerlIO_printf(Perl_debug_log,
2769 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2770 PTR2UV(sv), SvNVX(sv));
2771 RESTORE_NUMERIC_LOCAL();
2775 STORE_NUMERIC_LOCAL_SET_STANDARD();
2776 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2777 PTR2UV(sv), SvNVX(sv));
2778 RESTORE_NUMERIC_LOCAL();
2782 else if (SvTYPE(sv) < SVt_PVNV)
2783 sv_upgrade(sv, SVt_PVNV);
2788 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2789 #ifdef NV_PRESERVES_UV
2792 /* Only set the public NV OK flag if this NV preserves the IV */
2793 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2794 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2795 : (SvIVX(sv) == I_V(SvNVX(sv))))
2801 else if (SvPOKp(sv) && SvLEN(sv)) {
2803 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2804 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2806 #ifdef NV_PRESERVES_UV
2807 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2808 == IS_NUMBER_IN_UV) {
2809 /* It's definitely an integer */
2810 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2812 SvNV_set(sv, Atof(SvPVX_const(sv)));
2815 SvNV_set(sv, Atof(SvPVX_const(sv)));
2816 /* Only set the public NV OK flag if this NV preserves the value in
2817 the PV at least as well as an IV/UV would.
2818 Not sure how to do this 100% reliably. */
2819 /* if that shift count is out of range then Configure's test is
2820 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2822 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2823 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2824 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2825 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2826 /* Can't use strtol etc to convert this string, so don't try.
2827 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2830 /* value has been set. It may not be precise. */
2831 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2832 /* 2s complement assumption for (UV)IV_MIN */
2833 SvNOK_on(sv); /* Integer is too negative. */
2838 if (numtype & IS_NUMBER_NEG) {
2839 SvIV_set(sv, -(IV)value);
2840 } else if (value <= (UV)IV_MAX) {
2841 SvIV_set(sv, (IV)value);
2843 SvUV_set(sv, value);
2847 if (numtype & IS_NUMBER_NOT_INT) {
2848 /* I believe that even if the original PV had decimals,
2849 they are lost beyond the limit of the FP precision.
2850 However, neither is canonical, so both only get p
2851 flags. NWC, 2000/11/25 */
2852 /* Both already have p flags, so do nothing */
2854 const NV nv = SvNVX(sv);
2855 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2856 if (SvIVX(sv) == I_V(nv)) {
2861 /* It had no "." so it must be integer. */
2864 /* between IV_MAX and NV(UV_MAX).
2865 Could be slightly > UV_MAX */
2867 if (numtype & IS_NUMBER_NOT_INT) {
2868 /* UV and NV both imprecise. */
2870 const UV nv_as_uv = U_V(nv);
2872 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2883 #endif /* NV_PRESERVES_UV */
2886 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2888 if (SvTYPE(sv) < SVt_NV)
2889 /* Typically the caller expects that sv_any is not NULL now. */
2890 /* XXX Ilya implies that this is a bug in callers that assume this
2891 and ideally should be fixed. */
2892 sv_upgrade(sv, SVt_NV);
2895 #if defined(USE_LONG_DOUBLE)
2897 STORE_NUMERIC_LOCAL_SET_STANDARD();
2898 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2899 PTR2UV(sv), SvNVX(sv));
2900 RESTORE_NUMERIC_LOCAL();
2904 STORE_NUMERIC_LOCAL_SET_STANDARD();
2905 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2906 PTR2UV(sv), SvNVX(sv));
2907 RESTORE_NUMERIC_LOCAL();
2913 /* asIV(): extract an integer from the string value of an SV.
2914 * Caller must validate PVX */
2917 S_asIV(pTHX_ SV *sv)
2920 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2922 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2923 == IS_NUMBER_IN_UV) {
2924 /* It's definitely an integer */
2925 if (numtype & IS_NUMBER_NEG) {
2926 if (value < (UV)IV_MIN)
2929 if (value < (UV)IV_MAX)
2934 if (ckWARN(WARN_NUMERIC))
2937 return I_V(Atof(SvPVX_const(sv)));
2940 /* asUV(): extract an unsigned integer from the string value of an SV
2941 * Caller must validate PVX */
2944 S_asUV(pTHX_ SV *sv)
2947 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2949 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2950 == IS_NUMBER_IN_UV) {
2951 /* It's definitely an integer */
2952 if (!(numtype & IS_NUMBER_NEG))
2956 if (ckWARN(WARN_NUMERIC))
2959 return U_V(Atof(SvPVX_const(sv)));
2962 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2963 * UV as a string towards the end of buf, and return pointers to start and
2966 * We assume that buf is at least TYPE_CHARS(UV) long.
2970 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2972 char *ptr = buf + TYPE_CHARS(UV);
2973 char * const ebuf = ptr;
2986 *--ptr = '0' + (char)(uv % 10);
2995 =for apidoc sv_2pv_flags
2997 Returns a pointer to the string value of an SV, and sets *lp to its length.
2998 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3000 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3001 usually end up here too.
3007 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3012 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3013 char *tmpbuf = tbuf;
3014 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
3021 if (SvGMAGICAL(sv)) {
3022 if (flags & SV_GMAGIC)
3027 if (flags & SV_MUTABLE_RETURN)
3028 return SvPVX_mutable(sv);
3029 if (flags & SV_CONST_RETURN)
3030 return (char *)SvPVX_const(sv);
3034 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
3035 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3037 goto tokensave_has_len;
3040 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3045 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3046 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3054 if (SvTHINKFIRST(sv)) {
3057 register const char *typestr;
3058 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3059 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3061 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3064 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3065 if (flags & SV_CONST_RETURN) {
3066 pv = (char *) SvPVX_const(tmpstr);
3068 pv = (flags & SV_MUTABLE_RETURN)
3069 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3072 *lp = SvCUR(tmpstr);
3074 pv = sv_2pv_flags(tmpstr, lp, flags);
3085 typestr = "NULLREF";
3089 switch (SvTYPE(sv)) {
3091 if ( ((SvFLAGS(sv) &
3092 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3093 == (SVs_OBJECT|SVs_SMG))
3094 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3095 const regexp *re = (regexp *)mg->mg_obj;
3098 const char *fptr = "msix";
3103 char need_newline = 0;
3104 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3106 while((ch = *fptr++)) {
3108 reflags[left++] = ch;
3111 reflags[right--] = ch;
3116 reflags[left] = '-';
3120 mg->mg_len = re->prelen + 4 + left;
3122 * If /x was used, we have to worry about a regex
3123 * ending with a comment later being embedded
3124 * within another regex. If so, we don't want this
3125 * regex's "commentization" to leak out to the
3126 * right part of the enclosing regex, we must cap
3127 * it with a newline.
3129 * So, if /x was used, we scan backwards from the
3130 * end of the regex. If we find a '#' before we
3131 * find a newline, we need to add a newline
3132 * ourself. If we find a '\n' first (or if we
3133 * don't find '#' or '\n'), we don't need to add
3134 * anything. -jfriedl
3136 if (PMf_EXTENDED & re->reganch)
3138 const char *endptr = re->precomp + re->prelen;
3139 while (endptr >= re->precomp)
3141 const char c = *(endptr--);
3143 break; /* don't need another */
3145 /* we end while in a comment, so we
3147 mg->mg_len++; /* save space for it */
3148 need_newline = 1; /* note to add it */
3154 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3155 Copy("(?", mg->mg_ptr, 2, char);
3156 Copy(reflags, mg->mg_ptr+2, left, char);
3157 Copy(":", mg->mg_ptr+left+2, 1, char);
3158 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3160 mg->mg_ptr[mg->mg_len - 2] = '\n';
3161 mg->mg_ptr[mg->mg_len - 1] = ')';
3162 mg->mg_ptr[mg->mg_len] = 0;
3164 PL_reginterp_cnt += re->program[0].next_off;
3166 if (re->reganch & ROPT_UTF8)
3182 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3183 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3184 /* tied lvalues should appear to be
3185 * scalars for backwards compatitbility */
3186 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3187 ? "SCALAR" : "LVALUE"; break;
3188 case SVt_PVAV: typestr = "ARRAY"; break;
3189 case SVt_PVHV: typestr = "HASH"; break;
3190 case SVt_PVCV: typestr = "CODE"; break;
3191 case SVt_PVGV: typestr = "GLOB"; break;
3192 case SVt_PVFM: typestr = "FORMAT"; break;
3193 case SVt_PVIO: typestr = "IO"; break;
3194 default: typestr = "UNKNOWN"; break;
3198 const char * const name = HvNAME_get(SvSTASH(sv));
3199 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3200 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3203 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3207 *lp = strlen(typestr);
3208 return (char *)typestr;
3210 if (SvREADONLY(sv) && !SvOK(sv)) {
3211 if (ckWARN(WARN_UNINITIALIZED))
3218 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3219 /* I'm assuming that if both IV and NV are equally valid then
3220 converting the IV is going to be more efficient */
3221 const U32 isIOK = SvIOK(sv);
3222 const U32 isUIOK = SvIsUV(sv);
3223 char buf[TYPE_CHARS(UV)];
3226 if (SvTYPE(sv) < SVt_PVIV)
3227 sv_upgrade(sv, SVt_PVIV);
3229 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3231 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3232 /* inlined from sv_setpvn */
3233 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3234 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3235 SvCUR_set(sv, ebuf - ptr);
3245 else if (SvNOKp(sv)) {
3246 if (SvTYPE(sv) < SVt_PVNV)
3247 sv_upgrade(sv, SVt_PVNV);
3248 /* The +20 is pure guesswork. Configure test needed. --jhi */
3249 s = SvGROW_mutable(sv, NV_DIG + 20);
3250 olderrno = errno; /* some Xenix systems wipe out errno here */
3252 if (SvNVX(sv) == 0.0)
3253 (void)strcpy(s,"0");
3257 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3260 #ifdef FIXNEGATIVEZERO
3261 if (*s == '-' && s[1] == '0' && !s[2])
3271 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3275 if (SvTYPE(sv) < SVt_PV)
3276 /* Typically the caller expects that sv_any is not NULL now. */
3277 sv_upgrade(sv, SVt_PV);
3281 const STRLEN len = s - SvPVX_const(sv);
3287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3288 PTR2UV(sv),SvPVX_const(sv)));
3289 if (flags & SV_CONST_RETURN)
3290 return (char *)SvPVX_const(sv);
3291 if (flags & SV_MUTABLE_RETURN)
3292 return SvPVX_mutable(sv);
3296 len = strlen(tmpbuf);
3299 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3300 /* Sneaky stuff here */
3304 tsv = newSVpvn(tmpbuf, len);
3313 #ifdef FIXNEGATIVEZERO
3314 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
3320 SvUPGRADE(sv, SVt_PV);
3323 s = SvGROW_mutable(sv, len + 1);
3326 return memcpy(s, tmpbuf, len + 1);
3331 =for apidoc sv_copypv
3333 Copies a stringified representation of the source SV into the
3334 destination SV. Automatically performs any necessary mg_get and
3335 coercion of numeric values into strings. Guaranteed to preserve
3336 UTF-8 flag even from overloaded objects. Similar in nature to
3337 sv_2pv[_flags] but operates directly on an SV instead of just the
3338 string. Mostly uses sv_2pv_flags to do its work, except when that
3339 would lose the UTF-8'ness of the PV.
3345 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3348 const char * const s = SvPV_const(ssv,len);
3349 sv_setpvn(dsv,s,len);
3357 =for apidoc sv_2pvbyte
3359 Return a pointer to the byte-encoded representation of the SV, and set *lp
3360 to its length. May cause the SV to be downgraded from UTF-8 as a
3363 Usually accessed via the C<SvPVbyte> macro.
3369 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3371 sv_utf8_downgrade(sv,0);
3372 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3376 =for apidoc sv_2pvutf8
3378 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3379 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3381 Usually accessed via the C<SvPVutf8> macro.
3387 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3389 sv_utf8_upgrade(sv);
3390 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3395 =for apidoc sv_2bool
3397 This function is only called on magical items, and is only used by
3398 sv_true() or its macro equivalent.
3404 Perl_sv_2bool(pTHX_ register SV *sv)
3412 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3413 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3414 return (bool)SvTRUE(tmpsv);
3415 return SvRV(sv) != 0;
3418 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3420 (*sv->sv_u.svu_pv > '0' ||
3421 Xpvtmp->xpv_cur > 1 ||
3422 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3429 return SvIVX(sv) != 0;
3432 return SvNVX(sv) != 0.0;
3440 =for apidoc sv_utf8_upgrade
3442 Converts the PV of an SV to its UTF-8-encoded form.
3443 Forces the SV to string form if it is not already.
3444 Always sets the SvUTF8 flag to avoid future validity checks even
3445 if all the bytes have hibit clear.
3447 This is not as a general purpose byte encoding to Unicode interface:
3448 use the Encode extension for that.
3450 =for apidoc sv_utf8_upgrade_flags
3452 Converts the PV of an SV to its UTF-8-encoded form.
3453 Forces the SV to string form if it is not already.
3454 Always sets the SvUTF8 flag to avoid future validity checks even
3455 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3456 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3457 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3459 This is not as a general purpose byte encoding to Unicode interface:
3460 use the Encode extension for that.
3466 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3468 if (sv == &PL_sv_undef)
3472 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3473 (void) sv_2pv_flags(sv,&len, flags);
3477 (void) SvPV_force(sv,len);
3486 sv_force_normal_flags(sv, 0);
3489 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3490 sv_recode_to_utf8(sv, PL_encoding);
3491 else { /* Assume Latin-1/EBCDIC */
3492 /* This function could be much more efficient if we
3493 * had a FLAG in SVs to signal if there are any hibit
3494 * chars in the PV. Given that there isn't such a flag
3495 * make the loop as fast as possible. */
3496 const U8 *s = (U8 *) SvPVX_const(sv);
3497 const U8 * const e = (U8 *) SvEND(sv);
3503 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3507 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3508 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3510 SvPV_free(sv); /* No longer using what was there before. */
3512 SvPV_set(sv, (char*)recoded);
3513 SvCUR_set(sv, len - 1);
3514 SvLEN_set(sv, len); /* No longer know the real size. */
3516 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3523 =for apidoc sv_utf8_downgrade
3525 Attempts to convert the PV of an SV from characters to bytes.
3526 If the PV contains a character beyond byte, this conversion will fail;
3527 in this case, either returns false or, if C<fail_ok> is not
3530 This is not as a general purpose Unicode to byte encoding interface:
3531 use the Encode extension for that.
3537 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3539 if (SvPOKp(sv) && SvUTF8(sv)) {
3545 sv_force_normal_flags(sv, 0);
3547 s = (U8 *) SvPV(sv, len);
3548 if (!utf8_to_bytes(s, &len)) {
3553 Perl_croak(aTHX_ "Wide character in %s",
3556 Perl_croak(aTHX_ "Wide character");
3567 =for apidoc sv_utf8_encode
3569 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3570 flag off so that it looks like octets again.
3576 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3578 (void) sv_utf8_upgrade(sv);
3580 sv_force_normal_flags(sv, 0);
3582 if (SvREADONLY(sv)) {
3583 Perl_croak(aTHX_ PL_no_modify);
3589 =for apidoc sv_utf8_decode
3591 If the PV of the SV is an octet sequence in UTF-8
3592 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3593 so that it looks like a character. If the PV contains only single-byte
3594 characters, the C<SvUTF8> flag stays being off.
3595 Scans PV for validity and returns false if the PV is invalid UTF-8.
3601 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3607 /* The octets may have got themselves encoded - get them back as
3610 if (!sv_utf8_downgrade(sv, TRUE))
3613 /* it is actually just a matter of turning the utf8 flag on, but
3614 * we want to make sure everything inside is valid utf8 first.
3616 c = (const U8 *) SvPVX_const(sv);
3617 if (!is_utf8_string(c, SvCUR(sv)+1))
3619 e = (const U8 *) SvEND(sv);
3622 if (!UTF8_IS_INVARIANT(ch)) {
3632 =for apidoc sv_setsv
3634 Copies the contents of the source SV C<ssv> into the destination SV
3635 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3636 function if the source SV needs to be reused. Does not handle 'set' magic.
3637 Loosely speaking, it performs a copy-by-value, obliterating any previous
3638 content of the destination.
3640 You probably want to use one of the assortment of wrappers, such as
3641 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3642 C<SvSetMagicSV_nosteal>.
3644 =for apidoc sv_setsv_flags
3646 Copies the contents of the source SV C<ssv> into the destination SV
3647 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3648 function if the source SV needs to be reused. Does not handle 'set' magic.
3649 Loosely speaking, it performs a copy-by-value, obliterating any previous
3650 content of the destination.
3651 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3652 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3653 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3654 and C<sv_setsv_nomg> are implemented in terms of this function.
3656 You probably want to use one of the assortment of wrappers, such as
3657 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3658 C<SvSetMagicSV_nosteal>.
3660 This is the primary function for copying scalars, and most other
3661 copy-ish functions and macros use this underneath.
3667 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3669 register U32 sflags;
3675 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3677 sstr = &PL_sv_undef;
3678 stype = SvTYPE(sstr);
3679 dtype = SvTYPE(dstr);
3684 /* need to nuke the magic */
3686 SvRMAGICAL_off(dstr);
3689 /* There's a lot of redundancy below but we're going for speed here */
3694 if (dtype != SVt_PVGV) {
3695 (void)SvOK_off(dstr);
3703 sv_upgrade(dstr, SVt_IV);
3706 sv_upgrade(dstr, SVt_PVNV);
3710 sv_upgrade(dstr, SVt_PVIV);
3713 (void)SvIOK_only(dstr);
3714 SvIV_set(dstr, SvIVX(sstr));
3717 if (SvTAINTED(sstr))
3728 sv_upgrade(dstr, SVt_NV);
3733 sv_upgrade(dstr, SVt_PVNV);
3736 SvNV_set(dstr, SvNVX(sstr));
3737 (void)SvNOK_only(dstr);
3738 if (SvTAINTED(sstr))
3746 sv_upgrade(dstr, SVt_RV);
3747 else if (dtype == SVt_PVGV &&
3748 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3751 if (GvIMPORTED(dstr) != GVf_IMPORTED
3752 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3754 GvIMPORTED_on(dstr);
3763 #ifdef PERL_OLD_COPY_ON_WRITE
3764 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3765 if (dtype < SVt_PVIV)
3766 sv_upgrade(dstr, SVt_PVIV);
3773 sv_upgrade(dstr, SVt_PV);
3776 if (dtype < SVt_PVIV)
3777 sv_upgrade(dstr, SVt_PVIV);
3780 if (dtype < SVt_PVNV)
3781 sv_upgrade(dstr, SVt_PVNV);
3788 const char * const type = sv_reftype(sstr,0);
3790 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3792 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3797 if (dtype <= SVt_PVGV) {
3799 if (dtype != SVt_PVGV) {
3800 const char * const name = GvNAME(sstr);
3801 const STRLEN len = GvNAMELEN(sstr);
3802 /* don't upgrade SVt_PVLV: it can hold a glob */
3803 if (dtype != SVt_PVLV)
3804 sv_upgrade(dstr, SVt_PVGV);
3805 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3806 GvSTASH(dstr) = GvSTASH(sstr);
3808 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3809 GvNAME(dstr) = savepvn(name, len);
3810 GvNAMELEN(dstr) = len;
3811 SvFAKE_on(dstr); /* can coerce to non-glob */
3814 #ifdef GV_UNIQUE_CHECK
3815 if (GvUNIQUE((GV*)dstr)) {
3816 Perl_croak(aTHX_ PL_no_modify);
3820 (void)SvOK_off(dstr);
3821 GvINTRO_off(dstr); /* one-shot flag */
3823 GvGP(dstr) = gp_ref(GvGP(sstr));
3824 if (SvTAINTED(sstr))
3826 if (GvIMPORTED(dstr) != GVf_IMPORTED
3827 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3829 GvIMPORTED_on(dstr);
3837 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3839 if ((int)SvTYPE(sstr) != stype) {
3840 stype = SvTYPE(sstr);
3841 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3845 if (stype == SVt_PVLV)
3846 SvUPGRADE(dstr, SVt_PVNV);
3848 SvUPGRADE(dstr, (U32)stype);
3851 sflags = SvFLAGS(sstr);
3853 if (sflags & SVf_ROK) {
3854 if (dtype >= SVt_PV) {
3855 if (dtype == SVt_PVGV) {
3856 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3858 const int intro = GvINTRO(dstr);
3860 #ifdef GV_UNIQUE_CHECK
3861 if (GvUNIQUE((GV*)dstr)) {
3862 Perl_croak(aTHX_ PL_no_modify);
3867 GvINTRO_off(dstr); /* one-shot flag */
3868 GvLINE(dstr) = CopLINE(PL_curcop);
3869 GvEGV(dstr) = (GV*)dstr;
3872 switch (SvTYPE(sref)) {
3875 SAVEGENERICSV(GvAV(dstr));
3877 dref = (SV*)GvAV(dstr);
3878 GvAV(dstr) = (AV*)sref;
3879 if (!GvIMPORTED_AV(dstr)
3880 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3882 GvIMPORTED_AV_on(dstr);
3887 SAVEGENERICSV(GvHV(dstr));
3889 dref = (SV*)GvHV(dstr);
3890 GvHV(dstr) = (HV*)sref;
3891 if (!GvIMPORTED_HV(dstr)
3892 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3894 GvIMPORTED_HV_on(dstr);
3899 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3900 SvREFCNT_dec(GvCV(dstr));
3901 GvCV(dstr) = Nullcv;
3902 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3903 PL_sub_generation++;
3905 SAVEGENERICSV(GvCV(dstr));
3908 dref = (SV*)GvCV(dstr);
3909 if (GvCV(dstr) != (CV*)sref) {
3910 CV* const cv = GvCV(dstr);
3912 if (!GvCVGEN((GV*)dstr) &&
3913 (CvROOT(cv) || CvXSUB(cv)))
3915 /* Redefining a sub - warning is mandatory if
3916 it was a const and its value changed. */
3917 if (ckWARN(WARN_REDEFINE)
3919 && (!CvCONST((CV*)sref)
3920 || sv_cmp(cv_const_sv(cv),
3921 cv_const_sv((CV*)sref)))))
3923 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3925 ? "Constant subroutine %s::%s redefined"
3926 : "Subroutine %s::%s redefined",
3927 HvNAME_get(GvSTASH((GV*)dstr)),
3928 GvENAME((GV*)dstr));
3932 cv_ckproto(cv, (GV*)dstr,
3934 ? SvPVX_const(sref) : Nullch);
3936 GvCV(dstr) = (CV*)sref;
3937 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3938 GvASSUMECV_on(dstr);
3939 PL_sub_generation++;
3941 if (!GvIMPORTED_CV(dstr)
3942 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3944 GvIMPORTED_CV_on(dstr);
3949 SAVEGENERICSV(GvIOp(dstr));
3951 dref = (SV*)GvIOp(dstr);
3952 GvIOp(dstr) = (IO*)sref;
3956 SAVEGENERICSV(GvFORM(dstr));
3958 dref = (SV*)GvFORM(dstr);
3959 GvFORM(dstr) = (CV*)sref;
3963 SAVEGENERICSV(GvSV(dstr));
3965 dref = (SV*)GvSV(dstr);
3967 if (!GvIMPORTED_SV(dstr)
3968 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3970 GvIMPORTED_SV_on(dstr);
3976 if (SvTAINTED(sstr))
3980 if (SvPVX_const(dstr)) {
3986 (void)SvOK_off(dstr);
3987 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3989 if (sflags & SVp_NOK) {
3991 /* Only set the public OK flag if the source has public OK. */
3992 if (sflags & SVf_NOK)
3993 SvFLAGS(dstr) |= SVf_NOK;
3994 SvNV_set(dstr, SvNVX(sstr));
3996 if (sflags & SVp_IOK) {
3997 (void)SvIOKp_on(dstr);
3998 if (sflags & SVf_IOK)
3999 SvFLAGS(dstr) |= SVf_IOK;
4000 if (sflags & SVf_IVisUV)
4002 SvIV_set(dstr, SvIVX(sstr));
4004 if (SvAMAGIC(sstr)) {
4008 else if (sflags & SVp_POK) {
4012 * Check to see if we can just swipe the string. If so, it's a
4013 * possible small lose on short strings, but a big win on long ones.
4014 * It might even be a win on short strings if SvPVX_const(dstr)
4015 * has to be allocated and SvPVX_const(sstr) has to be freed.
4018 /* Whichever path we take through the next code, we want this true,
4019 and doing it now facilitates the COW check. */
4020 (void)SvPOK_only(dstr);
4023 /* We're not already COW */
4024 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4025 #ifndef PERL_OLD_COPY_ON_WRITE
4026 /* or we are, but dstr isn't a suitable target. */
4027 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4032 (sflags & SVs_TEMP) && /* slated for free anyway? */
4033 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4034 (!(flags & SV_NOSTEAL)) &&
4035 /* and we're allowed to steal temps */
4036 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4037 SvLEN(sstr) && /* and really is a string */
4038 /* and won't be needed again, potentially */
4039 !(PL_op && PL_op->op_type == OP_AASSIGN))
4040 #ifdef PERL_OLD_COPY_ON_WRITE
4041 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4042 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4043 && SvTYPE(sstr) >= SVt_PVIV)
4046 /* Failed the swipe test, and it's not a shared hash key either.
4047 Have to copy the string. */
4048 STRLEN len = SvCUR(sstr);
4049 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4050 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4051 SvCUR_set(dstr, len);
4052 *SvEND(dstr) = '\0';
4054 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4056 /* Either it's a shared hash key, or it's suitable for
4057 copy-on-write or we can swipe the string. */
4059 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4063 #ifdef PERL_OLD_COPY_ON_WRITE
4065 /* I believe I should acquire a global SV mutex if
4066 it's a COW sv (not a shared hash key) to stop
4067 it going un copy-on-write.
4068 If the source SV has gone un copy on write between up there
4069 and down here, then (assert() that) it is of the correct
4070 form to make it copy on write again */
4071 if ((sflags & (SVf_FAKE | SVf_READONLY))
4072 != (SVf_FAKE | SVf_READONLY)) {
4073 SvREADONLY_on(sstr);
4075 /* Make the source SV into a loop of 1.
4076 (about to become 2) */
4077 SV_COW_NEXT_SV_SET(sstr, sstr);
4081 /* Initial code is common. */
4082 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4087 /* making another shared SV. */
4088 STRLEN cur = SvCUR(sstr);
4089 STRLEN len = SvLEN(sstr);
4090 #ifdef PERL_OLD_COPY_ON_WRITE
4092 assert (SvTYPE(dstr) >= SVt_PVIV);
4093 /* SvIsCOW_normal */
4094 /* splice us in between source and next-after-source. */
4095 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4096 SV_COW_NEXT_SV_SET(sstr, dstr);
4097 SvPV_set(dstr, SvPVX_mutable(sstr));
4101 /* SvIsCOW_shared_hash */
4102 DEBUG_C(PerlIO_printf(Perl_debug_log,
4103 "Copy on write: Sharing hash\n"));
4105 assert (SvTYPE(dstr) >= SVt_PV);
4107 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4109 SvLEN_set(dstr, len);
4110 SvCUR_set(dstr, cur);
4111 SvREADONLY_on(dstr);
4113 /* Relesase a global SV mutex. */
4116 { /* Passes the swipe test. */
4117 SvPV_set(dstr, SvPVX_mutable(sstr));
4118 SvLEN_set(dstr, SvLEN(sstr));
4119 SvCUR_set(dstr, SvCUR(sstr));
4122 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4123 SvPV_set(sstr, Nullch);
4129 if (sflags & SVf_UTF8)
4131 if (sflags & SVp_NOK) {
4133 if (sflags & SVf_NOK)
4134 SvFLAGS(dstr) |= SVf_NOK;
4135 SvNV_set(dstr, SvNVX(sstr));
4137 if (sflags & SVp_IOK) {
4138 (void)SvIOKp_on(dstr);
4139 if (sflags & SVf_IOK)
4140 SvFLAGS(dstr) |= SVf_IOK;
4141 if (sflags & SVf_IVisUV)
4143 SvIV_set(dstr, SvIVX(sstr));
4146 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4147 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4148 smg->mg_ptr, smg->mg_len);
4149 SvRMAGICAL_on(dstr);
4152 else if (sflags & SVp_IOK) {
4153 if (sflags & SVf_IOK)
4154 (void)SvIOK_only(dstr);
4156 (void)SvOK_off(dstr);
4157 (void)SvIOKp_on(dstr);
4159 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4160 if (sflags & SVf_IVisUV)
4162 SvIV_set(dstr, SvIVX(sstr));
4163 if (sflags & SVp_NOK) {
4164 if (sflags & SVf_NOK)
4165 (void)SvNOK_on(dstr);
4167 (void)SvNOKp_on(dstr);
4168 SvNV_set(dstr, SvNVX(sstr));
4171 else if (sflags & SVp_NOK) {
4172 if (sflags & SVf_NOK)
4173 (void)SvNOK_only(dstr);
4175 (void)SvOK_off(dstr);
4178 SvNV_set(dstr, SvNVX(sstr));
4181 if (dtype == SVt_PVGV) {
4182 if (ckWARN(WARN_MISC))
4183 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4186 (void)SvOK_off(dstr);
4188 if (SvTAINTED(sstr))
4193 =for apidoc sv_setsv_mg
4195 Like C<sv_setsv>, but also handles 'set' magic.
4201 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4203 sv_setsv(dstr,sstr);
4207 #ifdef PERL_OLD_COPY_ON_WRITE
4209 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4211 STRLEN cur = SvCUR(sstr);
4212 STRLEN len = SvLEN(sstr);
4213 register char *new_pv;
4216 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4224 if (SvTHINKFIRST(dstr))
4225 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4226 else if (SvPVX_const(dstr))
4227 Safefree(SvPVX_const(dstr));
4231 SvUPGRADE(dstr, SVt_PVIV);
4233 assert (SvPOK(sstr));
4234 assert (SvPOKp(sstr));
4235 assert (!SvIOK(sstr));
4236 assert (!SvIOKp(sstr));
4237 assert (!SvNOK(sstr));
4238 assert (!SvNOKp(sstr));
4240 if (SvIsCOW(sstr)) {
4242 if (SvLEN(sstr) == 0) {
4243 /* source is a COW shared hash key. */
4244 DEBUG_C(PerlIO_printf(Perl_debug_log,
4245 "Fast copy on write: Sharing hash\n"));
4246 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4249 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4251 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4252 SvUPGRADE(sstr, SVt_PVIV);
4253 SvREADONLY_on(sstr);
4255 DEBUG_C(PerlIO_printf(Perl_debug_log,
4256 "Fast copy on write: Converting sstr to COW\n"));
4257 SV_COW_NEXT_SV_SET(dstr, sstr);
4259 SV_COW_NEXT_SV_SET(sstr, dstr);
4260 new_pv = SvPVX_mutable(sstr);
4263 SvPV_set(dstr, new_pv);
4264 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4267 SvLEN_set(dstr, len);
4268 SvCUR_set(dstr, cur);
4277 =for apidoc sv_setpvn
4279 Copies a string into an SV. The C<len> parameter indicates the number of
4280 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4281 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4287 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4289 register char *dptr;
4291 SV_CHECK_THINKFIRST_COW_DROP(sv);
4297 /* len is STRLEN which is unsigned, need to copy to signed */
4300 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4302 SvUPGRADE(sv, SVt_PV);
4304 dptr = SvGROW(sv, len + 1);
4305 Move(ptr,dptr,len,char);
4308 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4313 =for apidoc sv_setpvn_mg
4315 Like C<sv_setpvn>, but also handles 'set' magic.
4321 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4323 sv_setpvn(sv,ptr,len);
4328 =for apidoc sv_setpv
4330 Copies a string into an SV. The string must be null-terminated. Does not
4331 handle 'set' magic. See C<sv_setpv_mg>.
4337 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4339 register STRLEN len;
4341 SV_CHECK_THINKFIRST_COW_DROP(sv);
4347 SvUPGRADE(sv, SVt_PV);
4349 SvGROW(sv, len + 1);
4350 Move(ptr,SvPVX(sv),len+1,char);
4352 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4357 =for apidoc sv_setpv_mg
4359 Like C<sv_setpv>, but also handles 'set' magic.
4365 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4372 =for apidoc sv_usepvn
4374 Tells an SV to use C<ptr> to find its string value. Normally the string is
4375 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4376 The C<ptr> should point to memory that was allocated by C<malloc>. The
4377 string length, C<len>, must be supplied. This function will realloc the
4378 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4379 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4380 See C<sv_usepvn_mg>.
4386 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4389 SV_CHECK_THINKFIRST_COW_DROP(sv);
4390 SvUPGRADE(sv, SVt_PV);
4395 if (SvPVX_const(sv))
4398 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4399 ptr = saferealloc (ptr, allocate);
4402 SvLEN_set(sv, allocate);
4404 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4409 =for apidoc sv_usepvn_mg
4411 Like C<sv_usepvn>, but also handles 'set' magic.
4417 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4419 sv_usepvn(sv,ptr,len);
4423 #ifdef PERL_OLD_COPY_ON_WRITE
4424 /* Need to do this *after* making the SV normal, as we need the buffer
4425 pointer to remain valid until after we've copied it. If we let go too early,
4426 another thread could invalidate it by unsharing last of the same hash key
4427 (which it can do by means other than releasing copy-on-write Svs)
4428 or by changing the other copy-on-write SVs in the loop. */
4430 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4432 if (len) { /* this SV was SvIsCOW_normal(sv) */
4433 /* we need to find the SV pointing to us. */
4434 SV * const current = SV_COW_NEXT_SV(after);
4436 if (current == sv) {
4437 /* The SV we point to points back to us (there were only two of us
4439 Hence other SV is no longer copy on write either. */
4441 SvREADONLY_off(after);
4443 /* We need to follow the pointers around the loop. */
4445 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4448 /* don't loop forever if the structure is bust, and we have
4449 a pointer into a closed loop. */
4450 assert (current != after);
4451 assert (SvPVX_const(current) == pvx);
4453 /* Make the SV before us point to the SV after us. */
4454 SV_COW_NEXT_SV_SET(current, after);
4457 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4462 Perl_sv_release_IVX(pTHX_ register SV *sv)
4465 sv_force_normal_flags(sv, 0);
4471 =for apidoc sv_force_normal_flags
4473 Undo various types of fakery on an SV: if the PV is a shared string, make
4474 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4475 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4476 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4477 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4478 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4479 set to some other value.) In addition, the C<flags> parameter gets passed to
4480 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4481 with flags set to 0.
4487 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4489 #ifdef PERL_OLD_COPY_ON_WRITE
4490 if (SvREADONLY(sv)) {
4491 /* At this point I believe I should acquire a global SV mutex. */
4493 const char * const pvx = SvPVX_const(sv);
4494 const STRLEN len = SvLEN(sv);
4495 const STRLEN cur = SvCUR(sv);
4496 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4498 PerlIO_printf(Perl_debug_log,
4499 "Copy on write: Force normal %ld\n",
4505 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4506 SvPV_set(sv, (char*)0);
4508 if (flags & SV_COW_DROP_PV) {
4509 /* OK, so we don't need to copy our buffer. */
4512 SvGROW(sv, cur + 1);
4513 Move(pvx,SvPVX(sv),cur,char);
4517 sv_release_COW(sv, pvx, len, next);
4522 else if (IN_PERL_RUNTIME)
4523 Perl_croak(aTHX_ PL_no_modify);
4524 /* At this point I believe that I can drop the global SV mutex. */
4527 if (SvREADONLY(sv)) {
4529 const char * const pvx = SvPVX_const(sv);
4530 const STRLEN len = SvCUR(sv);
4533 SvPV_set(sv, Nullch);
4535 SvGROW(sv, len + 1);
4536 Move(pvx,SvPVX(sv),len,char);
4538 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4540 else if (IN_PERL_RUNTIME)
4541 Perl_croak(aTHX_ PL_no_modify);
4545 sv_unref_flags(sv, flags);
4546 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4553 Efficient removal of characters from the beginning of the string buffer.
4554 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4555 the string buffer. The C<ptr> becomes the first character of the adjusted
4556 string. Uses the "OOK hack".
4557 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4558 refer to the same chunk of data.
4564 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4566 register STRLEN delta;
4567 if (!ptr || !SvPOKp(sv))
4569 delta = ptr - SvPVX_const(sv);
4570 SV_CHECK_THINKFIRST(sv);
4571 if (SvTYPE(sv) < SVt_PVIV)
4572 sv_upgrade(sv,SVt_PVIV);
4575 if (!SvLEN(sv)) { /* make copy of shared string */
4576 const char *pvx = SvPVX_const(sv);
4577 const STRLEN len = SvCUR(sv);
4578 SvGROW(sv, len + 1);
4579 Move(pvx,SvPVX(sv),len,char);
4583 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4584 and we do that anyway inside the SvNIOK_off
4586 SvFLAGS(sv) |= SVf_OOK;
4589 SvLEN_set(sv, SvLEN(sv) - delta);
4590 SvCUR_set(sv, SvCUR(sv) - delta);
4591 SvPV_set(sv, SvPVX(sv) + delta);
4592 SvIV_set(sv, SvIVX(sv) + delta);
4596 =for apidoc sv_catpvn
4598 Concatenates the string onto the end of the string which is in the SV. The
4599 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4600 status set, then the bytes appended should be valid UTF-8.
4601 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4603 =for apidoc sv_catpvn_flags
4605 Concatenates the string onto the end of the string which is in the SV. The
4606 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4607 status set, then the bytes appended should be valid UTF-8.
4608 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4609 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4610 in terms of this function.
4616 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4619 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4621 SvGROW(dsv, dlen + slen + 1);
4623 sstr = SvPVX_const(dsv);
4624 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4625 SvCUR_set(dsv, SvCUR(dsv) + slen);
4627 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4629 if (flags & SV_SMAGIC)
4634 =for apidoc sv_catsv
4636 Concatenates the string from SV C<ssv> onto the end of the string in
4637 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4638 not 'set' magic. See C<sv_catsv_mg>.
4640 =for apidoc sv_catsv_flags
4642 Concatenates the string from SV C<ssv> onto the end of the string in
4643 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4644 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4645 and C<sv_catsv_nomg> are implemented in terms of this function.
4650 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4655 if ((spv = SvPV_const(ssv, slen))) {
4656 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4657 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4658 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4659 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4660 dsv->sv_flags doesn't have that bit set.
4661 Andy Dougherty 12 Oct 2001
4663 const I32 sutf8 = DO_UTF8(ssv);
4666 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4668 dutf8 = DO_UTF8(dsv);
4670 if (dutf8 != sutf8) {
4672 /* Not modifying source SV, so taking a temporary copy. */
4673 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4675 sv_utf8_upgrade(csv);
4676 spv = SvPV_const(csv, slen);
4679 sv_utf8_upgrade_nomg(dsv);
4681 sv_catpvn_nomg(dsv, spv, slen);
4684 if (flags & SV_SMAGIC)
4689 =for apidoc sv_catpv
4691 Concatenates the string onto the end of the string which is in the SV.
4692 If the SV has the UTF-8 status set, then the bytes appended should be
4693 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4698 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4700 register STRLEN len;
4706 junk = SvPV_force(sv, tlen);
4708 SvGROW(sv, tlen + len + 1);
4710 ptr = SvPVX_const(sv);
4711 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4712 SvCUR_set(sv, SvCUR(sv) + len);
4713 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4718 =for apidoc sv_catpv_mg
4720 Like C<sv_catpv>, but also handles 'set' magic.
4726 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4735 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4736 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4743 Perl_newSV(pTHX_ STRLEN len)
4749 sv_upgrade(sv, SVt_PV);
4750 SvGROW(sv, len + 1);
4755 =for apidoc sv_magicext
4757 Adds magic to an SV, upgrading it if necessary. Applies the
4758 supplied vtable and returns a pointer to the magic added.
4760 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4761 In particular, you can add magic to SvREADONLY SVs, and add more than
4762 one instance of the same 'how'.
4764 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4765 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4766 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4767 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4769 (This is now used as a subroutine by C<sv_magic>.)
4774 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4775 const char* name, I32 namlen)
4779 if (SvTYPE(sv) < SVt_PVMG) {
4780 SvUPGRADE(sv, SVt_PVMG);
4782 Newxz(mg, 1, MAGIC);
4783 mg->mg_moremagic = SvMAGIC(sv);
4784 SvMAGIC_set(sv, mg);
4786 /* Sometimes a magic contains a reference loop, where the sv and
4787 object refer to each other. To prevent a reference loop that
4788 would prevent such objects being freed, we look for such loops
4789 and if we find one we avoid incrementing the object refcount.
4791 Note we cannot do this to avoid self-tie loops as intervening RV must
4792 have its REFCNT incremented to keep it in existence.
4795 if (!obj || obj == sv ||
4796 how == PERL_MAGIC_arylen ||
4797 how == PERL_MAGIC_qr ||
4798 how == PERL_MAGIC_symtab ||
4799 (SvTYPE(obj) == SVt_PVGV &&
4800 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4801 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4802 GvFORM(obj) == (CV*)sv)))
4807 mg->mg_obj = SvREFCNT_inc(obj);
4808 mg->mg_flags |= MGf_REFCOUNTED;
4811 /* Normal self-ties simply pass a null object, and instead of
4812 using mg_obj directly, use the SvTIED_obj macro to produce a
4813 new RV as needed. For glob "self-ties", we are tieing the PVIO
4814 with an RV obj pointing to the glob containing the PVIO. In
4815 this case, to avoid a reference loop, we need to weaken the
4819 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4820 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4826 mg->mg_len = namlen;
4829 mg->mg_ptr = savepvn(name, namlen);
4830 else if (namlen == HEf_SVKEY)
4831 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4833 mg->mg_ptr = (char *) name;
4835 mg->mg_virtual = vtable;
4839 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4844 =for apidoc sv_magic
4846 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4847 then adds a new magic item of type C<how> to the head of the magic list.
4849 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4850 handling of the C<name> and C<namlen> arguments.
4852 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4853 to add more than one instance of the same 'how'.
4859 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4861 const MGVTBL *vtable;
4864 #ifdef PERL_OLD_COPY_ON_WRITE
4866 sv_force_normal_flags(sv, 0);
4868 if (SvREADONLY(sv)) {
4870 /* its okay to attach magic to shared strings; the subsequent
4871 * upgrade to PVMG will unshare the string */
4872 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4875 && how != PERL_MAGIC_regex_global
4876 && how != PERL_MAGIC_bm
4877 && how != PERL_MAGIC_fm
4878 && how != PERL_MAGIC_sv
4879 && how != PERL_MAGIC_backref
4882 Perl_croak(aTHX_ PL_no_modify);
4885 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4886 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4887 /* sv_magic() refuses to add a magic of the same 'how' as an
4890 if (how == PERL_MAGIC_taint)
4898 vtable = &PL_vtbl_sv;
4900 case PERL_MAGIC_overload:
4901 vtable = &PL_vtbl_amagic;
4903 case PERL_MAGIC_overload_elem:
4904 vtable = &PL_vtbl_amagicelem;
4906 case PERL_MAGIC_overload_table:
4907 vtable = &PL_vtbl_ovrld;
4910 vtable = &PL_vtbl_bm;
4912 case PERL_MAGIC_regdata:
4913 vtable = &PL_vtbl_regdata;
4915 case PERL_MAGIC_regdatum:
4916 vtable = &PL_vtbl_regdatum;
4918 case PERL_MAGIC_env:
4919 vtable = &PL_vtbl_env;
4922 vtable = &PL_vtbl_fm;
4924 case PERL_MAGIC_envelem:
4925 vtable = &PL_vtbl_envelem;
4927 case PERL_MAGIC_regex_global:
4928 vtable = &PL_vtbl_mglob;
4930 case PERL_MAGIC_isa:
4931 vtable = &PL_vtbl_isa;
4933 case PERL_MAGIC_isaelem:
4934 vtable = &PL_vtbl_isaelem;
4936 case PERL_MAGIC_nkeys:
4937 vtable = &PL_vtbl_nkeys;
4939 case PERL_MAGIC_dbfile:
4942 case PERL_MAGIC_dbline:
4943 vtable = &PL_vtbl_dbline;
4945 #ifdef USE_LOCALE_COLLATE
4946 case PERL_MAGIC_collxfrm:
4947 vtable = &PL_vtbl_collxfrm;
4949 #endif /* USE_LOCALE_COLLATE */
4950 case PERL_MAGIC_tied:
4951 vtable = &PL_vtbl_pack;
4953 case PERL_MAGIC_tiedelem:
4954 case PERL_MAGIC_tiedscalar:
4955 vtable = &PL_vtbl_packelem;
4958 vtable = &PL_vtbl_regexp;
4960 case PERL_MAGIC_sig:
4961 vtable = &PL_vtbl_sig;
4963 case PERL_MAGIC_sigelem:
4964 vtable = &PL_vtbl_sigelem;
4966 case PERL_MAGIC_taint:
4967 vtable = &PL_vtbl_taint;
4969 case PERL_MAGIC_uvar:
4970 vtable = &PL_vtbl_uvar;
4972 case PERL_MAGIC_vec:
4973 vtable = &PL_vtbl_vec;
4975 case PERL_MAGIC_arylen_p:
4976 case PERL_MAGIC_rhash:
4977 case PERL_MAGIC_symtab:
4978 case PERL_MAGIC_vstring:
4981 case PERL_MAGIC_utf8:
4982 vtable = &PL_vtbl_utf8;
4984 case PERL_MAGIC_substr:
4985 vtable = &PL_vtbl_substr;
4987 case PERL_MAGIC_defelem:
4988 vtable = &PL_vtbl_defelem;
4990 case PERL_MAGIC_glob:
4991 vtable = &PL_vtbl_glob;
4993 case PERL_MAGIC_arylen:
4994 vtable = &PL_vtbl_arylen;
4996 case PERL_MAGIC_pos:
4997 vtable = &PL_vtbl_pos;
4999 case PERL_MAGIC_backref:
5000 vtable = &PL_vtbl_backref;
5002 case PERL_MAGIC_ext:
5003 /* Reserved for use by extensions not perl internals. */
5004 /* Useful for attaching extension internal data to perl vars. */
5005 /* Note that multiple extensions may clash if magical scalars */
5006 /* etc holding private data from one are passed to another. */
5010 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5013 /* Rest of work is done else where */
5014 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5017 case PERL_MAGIC_taint:
5020 case PERL_MAGIC_ext:
5021 case PERL_MAGIC_dbfile:
5028 =for apidoc sv_unmagic
5030 Removes all magic of type C<type> from an SV.
5036 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5040 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5043 for (mg = *mgp; mg; mg = *mgp) {
5044 if (mg->mg_type == type) {
5045 const MGVTBL* const vtbl = mg->mg_virtual;
5046 *mgp = mg->mg_moremagic;
5047 if (vtbl && vtbl->svt_free)
5048 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5049 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5051 Safefree(mg->mg_ptr);
5052 else if (mg->mg_len == HEf_SVKEY)
5053 SvREFCNT_dec((SV*)mg->mg_ptr);
5054 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5055 Safefree(mg->mg_ptr);
5057 if (mg->mg_flags & MGf_REFCOUNTED)
5058 SvREFCNT_dec(mg->mg_obj);
5062 mgp = &mg->mg_moremagic;
5066 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5073 =for apidoc sv_rvweaken
5075 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5076 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5077 push a back-reference to this RV onto the array of backreferences
5078 associated with that magic.
5084 Perl_sv_rvweaken(pTHX_ SV *sv)
5087 if (!SvOK(sv)) /* let undefs pass */
5090 Perl_croak(aTHX_ "Can't weaken a nonreference");
5091 else if (SvWEAKREF(sv)) {
5092 if (ckWARN(WARN_MISC))
5093 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5097 Perl_sv_add_backref(aTHX_ tsv, sv);
5103 /* Give tsv backref magic if it hasn't already got it, then push a
5104 * back-reference to sv onto the array associated with the backref magic.
5108 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5112 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5113 av = (AV*)mg->mg_obj;
5116 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5117 /* av now has a refcnt of 2, which avoids it getting freed
5118 * before us during global cleanup. The extra ref is removed
5119 * by magic_killbackrefs() when tsv is being freed */
5121 if (AvFILLp(av) >= AvMAX(av)) {
5122 av_extend(av, AvFILLp(av)+1);
5124 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5127 /* delete a back-reference to ourselves from the backref magic associated
5128 * with the SV we point to.
5132 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5138 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5139 if (PL_in_clean_all)
5142 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5143 Perl_croak(aTHX_ "panic: del_backref");
5144 av = (AV *)mg->mg_obj;
5146 /* We shouldn't be in here more than once, but for paranoia reasons lets
5148 for (i = AvFILLp(av); i >= 0; i--) {
5150 const SSize_t fill = AvFILLp(av);
5152 /* We weren't the last entry.
5153 An unordered list has this property that you can take the
5154 last element off the end to fill the hole, and it's still
5155 an unordered list :-)
5160 AvFILLp(av) = fill - 1;
5166 =for apidoc sv_insert
5168 Inserts a string at the specified offset/length within the SV. Similar to
5169 the Perl substr() function.
5175 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5179 register char *midend;
5180 register char *bigend;
5186 Perl_croak(aTHX_ "Can't modify non-existent substring");
5187 SvPV_force(bigstr, curlen);
5188 (void)SvPOK_only_UTF8(bigstr);
5189 if (offset + len > curlen) {
5190 SvGROW(bigstr, offset+len+1);
5191 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5192 SvCUR_set(bigstr, offset+len);
5196 i = littlelen - len;
5197 if (i > 0) { /* string might grow */
5198 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5199 mid = big + offset + len;
5200 midend = bigend = big + SvCUR(bigstr);
5203 while (midend > mid) /* shove everything down */
5204 *--bigend = *--midend;
5205 Move(little,big+offset,littlelen,char);
5206 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5211 Move(little,SvPVX(bigstr)+offset,len,char);
5216 big = SvPVX(bigstr);
5219 bigend = big + SvCUR(bigstr);
5221 if (midend > bigend)
5222 Perl_croak(aTHX_ "panic: sv_insert");
5224 if (mid - big > bigend - midend) { /* faster to shorten from end */
5226 Move(little, mid, littlelen,char);
5229 i = bigend - midend;
5231 Move(midend, mid, i,char);
5235 SvCUR_set(bigstr, mid - big);
5237 else if ((i = mid - big)) { /* faster from front */
5238 midend -= littlelen;
5240 sv_chop(bigstr,midend-i);
5245 Move(little, mid, littlelen,char);
5247 else if (littlelen) {
5248 midend -= littlelen;
5249 sv_chop(bigstr,midend);
5250 Move(little,midend,littlelen,char);
5253 sv_chop(bigstr,midend);
5259 =for apidoc sv_replace
5261 Make the first argument a copy of the second, then delete the original.
5262 The target SV physically takes over ownership of the body of the source SV
5263 and inherits its flags; however, the target keeps any magic it owns,
5264 and any magic in the source is discarded.
5265 Note that this is a rather specialist SV copying operation; most of the
5266 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5272 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5274 const U32 refcnt = SvREFCNT(sv);
5275 SV_CHECK_THINKFIRST_COW_DROP(sv);
5276 if (SvREFCNT(nsv) != 1) {
5277 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5278 UVuf " != 1)", (UV) SvREFCNT(nsv));
5280 if (SvMAGICAL(sv)) {
5284 sv_upgrade(nsv, SVt_PVMG);
5285 SvMAGIC_set(nsv, SvMAGIC(sv));
5286 SvFLAGS(nsv) |= SvMAGICAL(sv);
5288 SvMAGIC_set(sv, NULL);
5292 assert(!SvREFCNT(sv));
5293 #ifdef DEBUG_LEAKING_SCALARS
5294 sv->sv_flags = nsv->sv_flags;
5295 sv->sv_any = nsv->sv_any;
5296 sv->sv_refcnt = nsv->sv_refcnt;
5297 sv->sv_u = nsv->sv_u;
5299 StructCopy(nsv,sv,SV);
5301 /* Currently could join these into one piece of pointer arithmetic, but
5302 it would be unclear. */
5303 if(SvTYPE(sv) == SVt_IV)
5305 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5306 else if (SvTYPE(sv) == SVt_RV) {
5307 SvANY(sv) = &sv->sv_u.svu_rv;
5311 #ifdef PERL_OLD_COPY_ON_WRITE
5312 if (SvIsCOW_normal(nsv)) {
5313 /* We need to follow the pointers around the loop to make the
5314 previous SV point to sv, rather than nsv. */
5317 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5320 assert(SvPVX_const(current) == SvPVX_const(nsv));
5322 /* Make the SV before us point to the SV after us. */
5324 PerlIO_printf(Perl_debug_log, "previous is\n");
5326 PerlIO_printf(Perl_debug_log,
5327 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5328 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5330 SV_COW_NEXT_SV_SET(current, sv);
5333 SvREFCNT(sv) = refcnt;
5334 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5340 =for apidoc sv_clear
5342 Clear an SV: call any destructors, free up any memory used by the body,
5343 and free the body itself. The SV's head is I<not> freed, although
5344 its type is set to all 1's so that it won't inadvertently be assumed
5345 to be live during global destruction etc.
5346 This function should only be called when REFCNT is zero. Most of the time
5347 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5354 Perl_sv_clear(pTHX_ register SV *sv)
5357 void** old_body_arena;
5358 size_t old_body_offset;
5359 const U32 type = SvTYPE(sv);
5362 assert(SvREFCNT(sv) == 0);
5368 old_body_offset = 0;
5371 if (PL_defstash) { /* Still have a symbol table? */
5376 stash = SvSTASH(sv);
5377 destructor = StashHANDLER(stash,DESTROY);
5379 SV* const tmpref = newRV(sv);
5380 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5382 PUSHSTACKi(PERLSI_DESTROY);
5387 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5393 if(SvREFCNT(tmpref) < 2) {
5394 /* tmpref is not kept alive! */
5396 SvRV_set(tmpref, NULL);
5399 SvREFCNT_dec(tmpref);
5401 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5405 if (PL_in_clean_objs)
5406 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5408 /* DESTROY gave object new lease on life */
5414 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5415 SvOBJECT_off(sv); /* Curse the object. */
5416 if (type != SVt_PVIO)
5417 --PL_sv_objcount; /* XXX Might want something more general */
5420 if (type >= SVt_PVMG) {
5423 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5424 SvREFCNT_dec(SvSTASH(sv));
5429 IoIFP(sv) != PerlIO_stdin() &&
5430 IoIFP(sv) != PerlIO_stdout() &&
5431 IoIFP(sv) != PerlIO_stderr())
5433 io_close((IO*)sv, FALSE);
5435 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5436 PerlDir_close(IoDIRP(sv));
5437 IoDIRP(sv) = (DIR*)NULL;
5438 Safefree(IoTOP_NAME(sv));
5439 Safefree(IoFMT_NAME(sv));
5440 Safefree(IoBOTTOM_NAME(sv));
5441 /* PVIOs aren't from arenas */
5444 old_body_arena = &PL_body_roots[SVt_PVBM];
5447 old_body_arena = &PL_body_roots[SVt_PVCV];
5449 /* PVFMs aren't from arenas */
5454 old_body_arena = &PL_body_roots[SVt_PVHV];
5455 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5459 old_body_arena = &PL_body_roots[SVt_PVAV];
5460 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5463 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5464 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5465 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5466 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5468 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5469 SvREFCNT_dec(LvTARG(sv));
5470 old_body_arena = &PL_body_roots[SVt_PVLV];
5474 Safefree(GvNAME(sv));
5475 /* If we're in a stash, we don't own a reference to it. However it does
5476 have a back reference to us, which needs to be cleared. */
5478 sv_del_backref((SV*)GvSTASH(sv), sv);
5479 old_body_arena = &PL_body_roots[SVt_PVGV];
5482 old_body_arena = &PL_body_roots[SVt_PVMG];
5485 old_body_arena = &PL_body_roots[SVt_PVNV];
5488 old_body_arena = &PL_body_roots[SVt_PVIV];
5489 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5491 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5493 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5494 /* Don't even bother with turning off the OOK flag. */
5498 old_body_arena = &PL_body_roots[SVt_PV];
5499 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5503 SV *target = SvRV(sv);
5505 sv_del_backref(target, sv);
5507 SvREFCNT_dec(target);
5509 #ifdef PERL_OLD_COPY_ON_WRITE
5510 else if (SvPVX_const(sv)) {
5512 /* I believe I need to grab the global SV mutex here and
5513 then recheck the COW status. */
5515 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5518 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5519 SV_COW_NEXT_SV(sv));
5520 /* And drop it here. */
5522 } else if (SvLEN(sv)) {
5523 Safefree(SvPVX_const(sv));
5527 else if (SvPVX_const(sv) && SvLEN(sv))
5528 Safefree(SvPVX_mutable(sv));
5529 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5530 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5536 old_body_arena = PL_body_roots[SVt_NV];
5540 SvFLAGS(sv) &= SVf_BREAK;
5541 SvFLAGS(sv) |= SVTYPEMASK;
5544 if (old_body_arena) {
5545 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5549 if (type > SVt_RV) {
5550 my_safefree(SvANY(sv));
5555 =for apidoc sv_newref
5557 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5564 Perl_sv_newref(pTHX_ SV *sv)
5574 Decrement an SV's reference count, and if it drops to zero, call
5575 C<sv_clear> to invoke destructors and free up any memory used by
5576 the body; finally, deallocate the SV's head itself.
5577 Normally called via a wrapper macro C<SvREFCNT_dec>.
5583 Perl_sv_free(pTHX_ SV *sv)
5588 if (SvREFCNT(sv) == 0) {
5589 if (SvFLAGS(sv) & SVf_BREAK)
5590 /* this SV's refcnt has been artificially decremented to
5591 * trigger cleanup */
5593 if (PL_in_clean_all) /* All is fair */
5595 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5596 /* make sure SvREFCNT(sv)==0 happens very seldom */
5597 SvREFCNT(sv) = (~(U32)0)/2;
5600 if (ckWARN_d(WARN_INTERNAL)) {
5601 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5602 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5603 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5604 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5605 Perl_dump_sv_child(aTHX_ sv);
5610 if (--(SvREFCNT(sv)) > 0)
5612 Perl_sv_free2(aTHX_ sv);
5616 Perl_sv_free2(pTHX_ SV *sv)
5621 if (ckWARN_d(WARN_DEBUGGING))
5622 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5623 "Attempt to free temp prematurely: SV 0x%"UVxf
5624 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5628 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5629 /* make sure SvREFCNT(sv)==0 happens very seldom */
5630 SvREFCNT(sv) = (~(U32)0)/2;
5641 Returns the length of the string in the SV. Handles magic and type
5642 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5648 Perl_sv_len(pTHX_ register SV *sv)
5656 len = mg_length(sv);
5658 (void)SvPV_const(sv, len);
5663 =for apidoc sv_len_utf8
5665 Returns the number of characters in the string in an SV, counting wide
5666 UTF-8 bytes as a single character. Handles magic and type coercion.
5672 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5673 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5674 * (Note that the mg_len is not the length of the mg_ptr field.)
5679 Perl_sv_len_utf8(pTHX_ register SV *sv)
5685 return mg_length(sv);
5689 const U8 *s = (U8*)SvPV_const(sv, len);
5690 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5692 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5694 #ifdef PERL_UTF8_CACHE_ASSERT
5695 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5699 ulen = Perl_utf8_length(aTHX_ s, s + len);
5700 if (!mg && !SvREADONLY(sv)) {
5701 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5702 mg = mg_find(sv, PERL_MAGIC_utf8);
5712 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5713 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5714 * between UTF-8 and byte offsets. There are two (substr offset and substr
5715 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5716 * and byte offset) cache positions.
5718 * The mg_len field is used by sv_len_utf8(), see its comments.
5719 * Note that the mg_len is not the length of the mg_ptr field.
5723 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5724 I32 offsetp, const U8 *s, const U8 *start)
5728 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5730 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5734 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5736 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5737 (*mgp)->mg_ptr = (char *) *cachep;
5741 (*cachep)[i] = offsetp;
5742 (*cachep)[i+1] = s - start;
5750 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5751 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5752 * between UTF-8 and byte offsets. See also the comments of
5753 * S_utf8_mg_pos_init().
5757 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)
5761 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5763 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5764 if (*mgp && (*mgp)->mg_ptr) {
5765 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5766 ASSERT_UTF8_CACHE(*cachep);
5767 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5769 else { /* We will skip to the right spot. */
5774 /* The assumption is that going backward is half
5775 * the speed of going forward (that's where the
5776 * 2 * backw in the below comes from). (The real
5777 * figure of course depends on the UTF-8 data.) */
5779 if ((*cachep)[i] > (STRLEN)uoff) {
5781 backw = (*cachep)[i] - (STRLEN)uoff;
5783 if (forw < 2 * backw)
5786 p = start + (*cachep)[i+1];
5788 /* Try this only for the substr offset (i == 0),
5789 * not for the substr length (i == 2). */
5790 else if (i == 0) { /* (*cachep)[i] < uoff */
5791 const STRLEN ulen = sv_len_utf8(sv);
5793 if ((STRLEN)uoff < ulen) {
5794 forw = (STRLEN)uoff - (*cachep)[i];
5795 backw = ulen - (STRLEN)uoff;
5797 if (forw < 2 * backw)
5798 p = start + (*cachep)[i+1];
5803 /* If the string is not long enough for uoff,
5804 * we could extend it, but not at this low a level. */
5808 if (forw < 2 * backw) {
5815 while (UTF8_IS_CONTINUATION(*p))
5820 /* Update the cache. */
5821 (*cachep)[i] = (STRLEN)uoff;
5822 (*cachep)[i+1] = p - start;
5824 /* Drop the stale "length" cache */
5833 if (found) { /* Setup the return values. */
5834 *offsetp = (*cachep)[i+1];
5835 *sp = start + *offsetp;
5838 *offsetp = send - start;
5840 else if (*sp < start) {
5846 #ifdef PERL_UTF8_CACHE_ASSERT
5851 while (n-- && s < send)
5855 assert(*offsetp == s - start);
5856 assert((*cachep)[0] == (STRLEN)uoff);
5857 assert((*cachep)[1] == *offsetp);
5859 ASSERT_UTF8_CACHE(*cachep);
5868 =for apidoc sv_pos_u2b
5870 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5871 the start of the string, to a count of the equivalent number of bytes; if
5872 lenp is non-zero, it does the same to lenp, but this time starting from
5873 the offset, rather than from the start of the string. Handles magic and
5880 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5881 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5882 * byte offsets. See also the comments of S_utf8_mg_pos().
5887 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5895 start = (U8*)SvPV_const(sv, len);
5899 const U8 *s = start;
5900 I32 uoffset = *offsetp;
5901 const U8 * const send = s + len;
5905 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5907 if (!found && uoffset > 0) {
5908 while (s < send && uoffset--)
5912 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5914 *offsetp = s - start;
5919 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5923 if (!found && *lenp > 0) {
5926 while (s < send && ulen--)
5930 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5934 ASSERT_UTF8_CACHE(cache);
5946 =for apidoc sv_pos_b2u
5948 Converts the value pointed to by offsetp from a count of bytes from the
5949 start of the string, to a count of the equivalent number of UTF-8 chars.
5950 Handles magic and type coercion.
5956 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5957 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5958 * byte offsets. See also the comments of S_utf8_mg_pos().
5963 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5971 s = (const U8*)SvPV_const(sv, len);
5972 if ((I32)len < *offsetp)
5973 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5975 const U8* send = s + *offsetp;
5977 STRLEN *cache = NULL;
5981 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5982 mg = mg_find(sv, PERL_MAGIC_utf8);
5983 if (mg && mg->mg_ptr) {
5984 cache = (STRLEN *) mg->mg_ptr;
5985 if (cache[1] == (STRLEN)*offsetp) {
5986 /* An exact match. */
5987 *offsetp = cache[0];
5991 else if (cache[1] < (STRLEN)*offsetp) {
5992 /* We already know part of the way. */
5995 /* Let the below loop do the rest. */
5997 else { /* cache[1] > *offsetp */
5998 /* We already know all of the way, now we may
5999 * be able to walk back. The same assumption
6000 * is made as in S_utf8_mg_pos(), namely that
6001 * walking backward is twice slower than
6002 * walking forward. */
6003 const STRLEN forw = *offsetp;
6004 STRLEN backw = cache[1] - *offsetp;
6006 if (!(forw < 2 * backw)) {
6007 const U8 *p = s + cache[1];
6014 while (UTF8_IS_CONTINUATION(*p)) {
6022 *offsetp = cache[0];
6024 /* Drop the stale "length" cache */
6032 ASSERT_UTF8_CACHE(cache);
6038 /* Call utf8n_to_uvchr() to validate the sequence
6039 * (unless a simple non-UTF character) */
6040 if (!UTF8_IS_INVARIANT(*s))
6041 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6050 if (!SvREADONLY(sv)) {
6052 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6053 mg = mg_find(sv, PERL_MAGIC_utf8);
6058 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6059 mg->mg_ptr = (char *) cache;
6064 cache[1] = *offsetp;
6065 /* Drop the stale "length" cache */
6078 Returns a boolean indicating whether the strings in the two SVs are
6079 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6080 coerce its args to strings if necessary.
6086 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6094 SV* svrecode = Nullsv;
6101 pv1 = SvPV_const(sv1, cur1);
6108 pv2 = SvPV_const(sv2, cur2);
6110 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6111 /* Differing utf8ness.
6112 * Do not UTF8size the comparands as a side-effect. */
6115 svrecode = newSVpvn(pv2, cur2);
6116 sv_recode_to_utf8(svrecode, PL_encoding);
6117 pv2 = SvPV_const(svrecode, cur2);
6120 svrecode = newSVpvn(pv1, cur1);
6121 sv_recode_to_utf8(svrecode, PL_encoding);
6122 pv1 = SvPV_const(svrecode, cur1);
6124 /* Now both are in UTF-8. */
6126 SvREFCNT_dec(svrecode);
6131 bool is_utf8 = TRUE;
6134 /* sv1 is the UTF-8 one,
6135 * if is equal it must be downgrade-able */
6136 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6142 /* sv2 is the UTF-8 one,
6143 * if is equal it must be downgrade-able */
6144 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6150 /* Downgrade not possible - cannot be eq */
6158 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6161 SvREFCNT_dec(svrecode);
6172 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6173 string in C<sv1> is less than, equal to, or greater than the string in
6174 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6175 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6181 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6184 const char *pv1, *pv2;
6187 SV *svrecode = Nullsv;
6194 pv1 = SvPV_const(sv1, cur1);
6201 pv2 = SvPV_const(sv2, cur2);
6203 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6204 /* Differing utf8ness.
6205 * Do not UTF8size the comparands as a side-effect. */
6208 svrecode = newSVpvn(pv2, cur2);
6209 sv_recode_to_utf8(svrecode, PL_encoding);
6210 pv2 = SvPV_const(svrecode, cur2);
6213 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6218 svrecode = newSVpvn(pv1, cur1);
6219 sv_recode_to_utf8(svrecode, PL_encoding);
6220 pv1 = SvPV_const(svrecode, cur1);
6223 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6229 cmp = cur2 ? -1 : 0;
6233 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6236 cmp = retval < 0 ? -1 : 1;
6237 } else if (cur1 == cur2) {
6240 cmp = cur1 < cur2 ? -1 : 1;
6245 SvREFCNT_dec(svrecode);
6254 =for apidoc sv_cmp_locale
6256 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6257 'use bytes' aware, handles get magic, and will coerce its args to strings
6258 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6264 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6266 #ifdef USE_LOCALE_COLLATE
6272 if (PL_collation_standard)
6276 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6278 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6280 if (!pv1 || !len1) {
6291 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6294 return retval < 0 ? -1 : 1;
6297 * When the result of collation is equality, that doesn't mean
6298 * that there are no differences -- some locales exclude some
6299 * characters from consideration. So to avoid false equalities,
6300 * we use the raw string as a tiebreaker.
6306 #endif /* USE_LOCALE_COLLATE */
6308 return sv_cmp(sv1, sv2);
6312 #ifdef USE_LOCALE_COLLATE
6315 =for apidoc sv_collxfrm
6317 Add Collate Transform magic to an SV if it doesn't already have it.
6319 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6320 scalar data of the variable, but transformed to such a format that a normal
6321 memory comparison can be used to compare the data according to the locale
6328 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6332 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6333 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6339 Safefree(mg->mg_ptr);
6340 s = SvPV_const(sv, len);
6341 if ((xf = mem_collxfrm(s, len, &xlen))) {
6342 if (SvREADONLY(sv)) {
6345 return xf + sizeof(PL_collation_ix);
6348 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6349 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6362 if (mg && mg->mg_ptr) {
6364 return mg->mg_ptr + sizeof(PL_collation_ix);
6372 #endif /* USE_LOCALE_COLLATE */
6377 Get a line from the filehandle and store it into the SV, optionally
6378 appending to the currently-stored string.
6384 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6388 register STDCHAR rslast;
6389 register STDCHAR *bp;
6395 if (SvTHINKFIRST(sv))
6396 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6397 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6399 However, perlbench says it's slower, because the existing swipe code
6400 is faster than copy on write.
6401 Swings and roundabouts. */
6402 SvUPGRADE(sv, SVt_PV);
6407 if (PerlIO_isutf8(fp)) {
6409 sv_utf8_upgrade_nomg(sv);
6410 sv_pos_u2b(sv,&append,0);
6412 } else if (SvUTF8(sv)) {
6413 SV * const tsv = NEWSV(0,0);
6414 sv_gets(tsv, fp, 0);
6415 sv_utf8_upgrade_nomg(tsv);
6416 SvCUR_set(sv,append);
6419 goto return_string_or_null;
6424 if (PerlIO_isutf8(fp))
6427 if (IN_PERL_COMPILETIME) {
6428 /* we always read code in line mode */
6432 else if (RsSNARF(PL_rs)) {
6433 /* If it is a regular disk file use size from stat() as estimate
6434 of amount we are going to read - may result in malloc-ing
6435 more memory than we realy need if layers bellow reduce
6436 size we read (e.g. CRLF or a gzip layer)
6439 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6440 const Off_t offset = PerlIO_tell(fp);
6441 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6442 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6448 else if (RsRECORD(PL_rs)) {
6452 /* Grab the size of the record we're getting */
6453 recsize = SvIV(SvRV(PL_rs));
6454 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6457 /* VMS wants read instead of fread, because fread doesn't respect */
6458 /* RMS record boundaries. This is not necessarily a good thing to be */
6459 /* doing, but we've got no other real choice - except avoid stdio
6460 as implementation - perhaps write a :vms layer ?
6462 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6464 bytesread = PerlIO_read(fp, buffer, recsize);
6468 SvCUR_set(sv, bytesread += append);
6469 buffer[bytesread] = '\0';
6470 goto return_string_or_null;
6472 else if (RsPARA(PL_rs)) {
6478 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6479 if (PerlIO_isutf8(fp)) {
6480 rsptr = SvPVutf8(PL_rs, rslen);
6483 if (SvUTF8(PL_rs)) {
6484 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6485 Perl_croak(aTHX_ "Wide character in $/");
6488 rsptr = SvPV_const(PL_rs, rslen);
6492 rslast = rslen ? rsptr[rslen - 1] : '\0';
6494 if (rspara) { /* have to do this both before and after */
6495 do { /* to make sure file boundaries work right */
6498 i = PerlIO_getc(fp);
6502 PerlIO_ungetc(fp,i);
6508 /* See if we know enough about I/O mechanism to cheat it ! */
6510 /* This used to be #ifdef test - it is made run-time test for ease
6511 of abstracting out stdio interface. One call should be cheap
6512 enough here - and may even be a macro allowing compile
6516 if (PerlIO_fast_gets(fp)) {
6519 * We're going to steal some values from the stdio struct
6520 * and put EVERYTHING in the innermost loop into registers.
6522 register STDCHAR *ptr;
6526 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6527 /* An ungetc()d char is handled separately from the regular
6528 * buffer, so we getc() it back out and stuff it in the buffer.
6530 i = PerlIO_getc(fp);
6531 if (i == EOF) return 0;
6532 *(--((*fp)->_ptr)) = (unsigned char) i;
6536 /* Here is some breathtakingly efficient cheating */
6538 cnt = PerlIO_get_cnt(fp); /* get count into register */
6539 /* make sure we have the room */
6540 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6541 /* Not room for all of it
6542 if we are looking for a separator and room for some
6544 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6545 /* just process what we have room for */
6546 shortbuffered = cnt - SvLEN(sv) + append + 1;
6547 cnt -= shortbuffered;
6551 /* remember that cnt can be negative */
6552 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6557 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6558 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6559 DEBUG_P(PerlIO_printf(Perl_debug_log,
6560 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6561 DEBUG_P(PerlIO_printf(Perl_debug_log,
6562 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6563 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6564 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6569 while (cnt > 0) { /* this | eat */
6571 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6572 goto thats_all_folks; /* screams | sed :-) */
6576 Copy(ptr, bp, cnt, char); /* this | eat */
6577 bp += cnt; /* screams | dust */
6578 ptr += cnt; /* louder | sed :-) */
6583 if (shortbuffered) { /* oh well, must extend */
6584 cnt = shortbuffered;
6586 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6588 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6589 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6593 DEBUG_P(PerlIO_printf(Perl_debug_log,
6594 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6595 PTR2UV(ptr),(long)cnt));
6596 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6598 DEBUG_P(PerlIO_printf(Perl_debug_log,
6599 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6600 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6601 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6603 /* This used to call 'filbuf' in stdio form, but as that behaves like
6604 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6605 another abstraction. */
6606 i = PerlIO_getc(fp); /* get more characters */
6608 DEBUG_P(PerlIO_printf(Perl_debug_log,
6609 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6610 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6611 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6613 cnt = PerlIO_get_cnt(fp);
6614 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6615 DEBUG_P(PerlIO_printf(Perl_debug_log,
6616 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6618 if (i == EOF) /* all done for ever? */
6619 goto thats_really_all_folks;
6621 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6623 SvGROW(sv, bpx + cnt + 2);
6624 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6626 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6628 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6629 goto thats_all_folks;
6633 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6634 memNE((char*)bp - rslen, rsptr, rslen))
6635 goto screamer; /* go back to the fray */
6636 thats_really_all_folks:
6638 cnt += shortbuffered;
6639 DEBUG_P(PerlIO_printf(Perl_debug_log,
6640 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6641 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6642 DEBUG_P(PerlIO_printf(Perl_debug_log,
6643 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6644 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6645 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6647 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6648 DEBUG_P(PerlIO_printf(Perl_debug_log,
6649 "Screamer: done, len=%ld, string=|%.*s|\n",
6650 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6654 /*The big, slow, and stupid way. */
6655 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6657 Newx(buf, 8192, STDCHAR);
6665 register const STDCHAR *bpe = buf + sizeof(buf);
6667 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6668 ; /* keep reading */
6672 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6673 /* Accomodate broken VAXC compiler, which applies U8 cast to
6674 * both args of ?: operator, causing EOF to change into 255
6677 i = (U8)buf[cnt - 1];
6683 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6685 sv_catpvn(sv, (char *) buf, cnt);
6687 sv_setpvn(sv, (char *) buf, cnt);
6689 if (i != EOF && /* joy */
6691 SvCUR(sv) < rslen ||
6692 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6696 * If we're reading from a TTY and we get a short read,
6697 * indicating that the user hit his EOF character, we need
6698 * to notice it now, because if we try to read from the TTY
6699 * again, the EOF condition will disappear.
6701 * The comparison of cnt to sizeof(buf) is an optimization
6702 * that prevents unnecessary calls to feof().
6706 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6710 #ifdef USE_HEAP_INSTEAD_OF_STACK
6715 if (rspara) { /* have to do this both before and after */
6716 while (i != EOF) { /* to make sure file boundaries work right */
6717 i = PerlIO_getc(fp);
6719 PerlIO_ungetc(fp,i);
6725 return_string_or_null:
6726 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6732 Auto-increment of the value in the SV, doing string to numeric conversion
6733 if necessary. Handles 'get' magic.
6739 Perl_sv_inc(pTHX_ register SV *sv)
6747 if (SvTHINKFIRST(sv)) {
6749 sv_force_normal_flags(sv, 0);
6750 if (SvREADONLY(sv)) {
6751 if (IN_PERL_RUNTIME)
6752 Perl_croak(aTHX_ PL_no_modify);
6756 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6758 i = PTR2IV(SvRV(sv));
6763 flags = SvFLAGS(sv);
6764 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6765 /* It's (privately or publicly) a float, but not tested as an
6766 integer, so test it to see. */
6768 flags = SvFLAGS(sv);
6770 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6771 /* It's publicly an integer, or privately an integer-not-float */
6772 #ifdef PERL_PRESERVE_IVUV
6776 if (SvUVX(sv) == UV_MAX)
6777 sv_setnv(sv, UV_MAX_P1);
6779 (void)SvIOK_only_UV(sv);
6780 SvUV_set(sv, SvUVX(sv) + 1);
6782 if (SvIVX(sv) == IV_MAX)
6783 sv_setuv(sv, (UV)IV_MAX + 1);
6785 (void)SvIOK_only(sv);
6786 SvIV_set(sv, SvIVX(sv) + 1);
6791 if (flags & SVp_NOK) {
6792 (void)SvNOK_only(sv);
6793 SvNV_set(sv, SvNVX(sv) + 1.0);
6797 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6798 if ((flags & SVTYPEMASK) < SVt_PVIV)
6799 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6800 (void)SvIOK_only(sv);
6805 while (isALPHA(*d)) d++;
6806 while (isDIGIT(*d)) d++;
6808 #ifdef PERL_PRESERVE_IVUV
6809 /* Got to punt this as an integer if needs be, but we don't issue
6810 warnings. Probably ought to make the sv_iv_please() that does
6811 the conversion if possible, and silently. */
6812 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6813 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6814 /* Need to try really hard to see if it's an integer.
6815 9.22337203685478e+18 is an integer.
6816 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6817 so $a="9.22337203685478e+18"; $a+0; $a++
6818 needs to be the same as $a="9.22337203685478e+18"; $a++
6825 /* sv_2iv *should* have made this an NV */
6826 if (flags & SVp_NOK) {
6827 (void)SvNOK_only(sv);
6828 SvNV_set(sv, SvNVX(sv) + 1.0);
6831 /* I don't think we can get here. Maybe I should assert this
6832 And if we do get here I suspect that sv_setnv will croak. NWC
6834 #if defined(USE_LONG_DOUBLE)
6835 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",
6836 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6838 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6839 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6842 #endif /* PERL_PRESERVE_IVUV */
6843 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6847 while (d >= SvPVX_const(sv)) {
6855 /* MKS: The original code here died if letters weren't consecutive.
6856 * at least it didn't have to worry about non-C locales. The
6857 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6858 * arranged in order (although not consecutively) and that only
6859 * [A-Za-z] are accepted by isALPHA in the C locale.
6861 if (*d != 'z' && *d != 'Z') {
6862 do { ++*d; } while (!isALPHA(*d));
6865 *(d--) -= 'z' - 'a';
6870 *(d--) -= 'z' - 'a' + 1;
6874 /* oh,oh, the number grew */
6875 SvGROW(sv, SvCUR(sv) + 2);
6876 SvCUR_set(sv, SvCUR(sv) + 1);
6877 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6888 Auto-decrement of the value in the SV, doing string to numeric conversion
6889 if necessary. Handles 'get' magic.
6895 Perl_sv_dec(pTHX_ register SV *sv)
6902 if (SvTHINKFIRST(sv)) {
6904 sv_force_normal_flags(sv, 0);
6905 if (SvREADONLY(sv)) {
6906 if (IN_PERL_RUNTIME)
6907 Perl_croak(aTHX_ PL_no_modify);
6911 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6913 i = PTR2IV(SvRV(sv));
6918 /* Unlike sv_inc we don't have to worry about string-never-numbers
6919 and keeping them magic. But we mustn't warn on punting */
6920 flags = SvFLAGS(sv);
6921 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6922 /* It's publicly an integer, or privately an integer-not-float */
6923 #ifdef PERL_PRESERVE_IVUV
6927 if (SvUVX(sv) == 0) {
6928 (void)SvIOK_only(sv);
6932 (void)SvIOK_only_UV(sv);
6933 SvUV_set(sv, SvUVX(sv) - 1);
6936 if (SvIVX(sv) == IV_MIN)
6937 sv_setnv(sv, (NV)IV_MIN - 1.0);
6939 (void)SvIOK_only(sv);
6940 SvIV_set(sv, SvIVX(sv) - 1);
6945 if (flags & SVp_NOK) {
6946 SvNV_set(sv, SvNVX(sv) - 1.0);
6947 (void)SvNOK_only(sv);
6950 if (!(flags & SVp_POK)) {
6951 if ((flags & SVTYPEMASK) < SVt_PVIV)
6952 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6954 (void)SvIOK_only(sv);
6957 #ifdef PERL_PRESERVE_IVUV
6959 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6960 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6961 /* Need to try really hard to see if it's an integer.
6962 9.22337203685478e+18 is an integer.
6963 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6964 so $a="9.22337203685478e+18"; $a+0; $a--
6965 needs to be the same as $a="9.22337203685478e+18"; $a--
6972 /* sv_2iv *should* have made this an NV */
6973 if (flags & SVp_NOK) {
6974 (void)SvNOK_only(sv);
6975 SvNV_set(sv, SvNVX(sv) - 1.0);
6978 /* I don't think we can get here. Maybe I should assert this
6979 And if we do get here I suspect that sv_setnv will croak. NWC
6981 #if defined(USE_LONG_DOUBLE)
6982 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",
6983 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6985 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6986 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6990 #endif /* PERL_PRESERVE_IVUV */
6991 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6995 =for apidoc sv_mortalcopy
6997 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6998 The new SV is marked as mortal. It will be destroyed "soon", either by an
6999 explicit call to FREETMPS, or by an implicit call at places such as
7000 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7005 /* Make a string that will exist for the duration of the expression
7006 * evaluation. Actually, it may have to last longer than that, but
7007 * hopefully we won't free it until it has been assigned to a
7008 * permanent location. */
7011 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7016 sv_setsv(sv,oldstr);
7018 PL_tmps_stack[++PL_tmps_ix] = sv;
7024 =for apidoc sv_newmortal
7026 Creates a new null SV which is mortal. The reference count of the SV is
7027 set to 1. It will be destroyed "soon", either by an explicit call to
7028 FREETMPS, or by an implicit call at places such as statement boundaries.
7029 See also C<sv_mortalcopy> and C<sv_2mortal>.
7035 Perl_sv_newmortal(pTHX)
7040 SvFLAGS(sv) = SVs_TEMP;
7042 PL_tmps_stack[++PL_tmps_ix] = sv;
7047 =for apidoc sv_2mortal
7049 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7050 by an explicit call to FREETMPS, or by an implicit call at places such as
7051 statement boundaries. SvTEMP() is turned on which means that the SV's
7052 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7053 and C<sv_mortalcopy>.
7059 Perl_sv_2mortal(pTHX_ register SV *sv)
7064 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7067 PL_tmps_stack[++PL_tmps_ix] = sv;
7075 Creates a new SV and copies a string into it. The reference count for the
7076 SV is set to 1. If C<len> is zero, Perl will compute the length using
7077 strlen(). For efficiency, consider using C<newSVpvn> instead.
7083 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7088 sv_setpvn(sv,s,len ? len : strlen(s));
7093 =for apidoc newSVpvn
7095 Creates a new SV and copies a string into it. The reference count for the
7096 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7097 string. You are responsible for ensuring that the source string is at least
7098 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7104 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7109 sv_setpvn(sv,s,len);
7115 =for apidoc newSVhek
7117 Creates a new SV from the hash key structure. It will generate scalars that
7118 point to the shared string table where possible. Returns a new (undefined)
7119 SV if the hek is NULL.
7125 Perl_newSVhek(pTHX_ const HEK *hek)
7134 if (HEK_LEN(hek) == HEf_SVKEY) {
7135 return newSVsv(*(SV**)HEK_KEY(hek));
7137 const int flags = HEK_FLAGS(hek);
7138 if (flags & HVhek_WASUTF8) {
7140 Andreas would like keys he put in as utf8 to come back as utf8
7142 STRLEN utf8_len = HEK_LEN(hek);
7143 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7144 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7147 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7149 } else if (flags & HVhek_REHASH) {
7150 /* We don't have a pointer to the hv, so we have to replicate the
7151 flag into every HEK. This hv is using custom a hasing
7152 algorithm. Hence we can't return a shared string scalar, as
7153 that would contain the (wrong) hash value, and might get passed
7154 into an hv routine with a regular hash */
7156 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7161 /* This will be overwhelminly the most common case. */
7162 return newSVpvn_share(HEK_KEY(hek),
7163 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7169 =for apidoc newSVpvn_share
7171 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7172 table. If the string does not already exist in the table, it is created
7173 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7174 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7175 otherwise the hash is computed. The idea here is that as the string table
7176 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7177 hash lookup will avoid string compare.
7183 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7186 bool is_utf8 = FALSE;
7188 STRLEN tmplen = -len;
7190 /* See the note in hv.c:hv_fetch() --jhi */
7191 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7195 PERL_HASH(hash, src, len);
7197 sv_upgrade(sv, SVt_PV);
7198 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7210 #if defined(PERL_IMPLICIT_CONTEXT)
7212 /* pTHX_ magic can't cope with varargs, so this is a no-context
7213 * version of the main function, (which may itself be aliased to us).
7214 * Don't access this version directly.
7218 Perl_newSVpvf_nocontext(const char* pat, ...)
7223 va_start(args, pat);
7224 sv = vnewSVpvf(pat, &args);
7231 =for apidoc newSVpvf
7233 Creates a new SV and initializes it with the string formatted like
7240 Perl_newSVpvf(pTHX_ const char* pat, ...)
7244 va_start(args, pat);
7245 sv = vnewSVpvf(pat, &args);
7250 /* backend for newSVpvf() and newSVpvf_nocontext() */
7253 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7257 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7264 Creates a new SV and copies a floating point value into it.
7265 The reference count for the SV is set to 1.
7271 Perl_newSVnv(pTHX_ NV n)
7283 Creates a new SV and copies an integer into it. The reference count for the
7290 Perl_newSViv(pTHX_ IV i)
7302 Creates a new SV and copies an unsigned integer into it.
7303 The reference count for the SV is set to 1.
7309 Perl_newSVuv(pTHX_ UV u)
7319 =for apidoc newRV_noinc
7321 Creates an RV wrapper for an SV. The reference count for the original
7322 SV is B<not> incremented.
7328 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7333 sv_upgrade(sv, SVt_RV);
7335 SvRV_set(sv, tmpRef);
7340 /* newRV_inc is the official function name to use now.
7341 * newRV_inc is in fact #defined to newRV in sv.h
7345 Perl_newRV(pTHX_ SV *tmpRef)
7347 return newRV_noinc(SvREFCNT_inc(tmpRef));
7353 Creates a new SV which is an exact duplicate of the original SV.
7360 Perl_newSVsv(pTHX_ register SV *old)
7366 if (SvTYPE(old) == SVTYPEMASK) {
7367 if (ckWARN_d(WARN_INTERNAL))
7368 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7372 /* SV_GMAGIC is the default for sv_setv()
7373 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7374 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7375 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7380 =for apidoc sv_reset
7382 Underlying implementation for the C<reset> Perl function.
7383 Note that the perl-level function is vaguely deprecated.
7389 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7392 char todo[PERL_UCHAR_MAX+1];
7397 if (!*s) { /* reset ?? searches */
7398 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7400 PMOP *pm = (PMOP *) mg->mg_obj;
7402 pm->op_pmdynflags &= ~PMdf_USED;
7409 /* reset variables */
7411 if (!HvARRAY(stash))
7414 Zero(todo, 256, char);
7417 I32 i = (unsigned char)*s;
7421 max = (unsigned char)*s++;
7422 for ( ; i <= max; i++) {
7425 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7427 for (entry = HvARRAY(stash)[i];
7429 entry = HeNEXT(entry))
7434 if (!todo[(U8)*HeKEY(entry)])
7436 gv = (GV*)HeVAL(entry);
7439 if (SvTHINKFIRST(sv)) {
7440 if (!SvREADONLY(sv) && SvROK(sv))
7442 /* XXX Is this continue a bug? Why should THINKFIRST
7443 exempt us from resetting arrays and hashes? */
7447 if (SvTYPE(sv) >= SVt_PV) {
7449 if (SvPVX_const(sv) != Nullch)
7457 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7459 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7462 # if defined(USE_ENVIRON_ARRAY)
7465 # endif /* USE_ENVIRON_ARRAY */
7476 Using various gambits, try to get an IO from an SV: the IO slot if its a
7477 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7478 named after the PV if we're a string.
7484 Perl_sv_2io(pTHX_ SV *sv)
7489 switch (SvTYPE(sv)) {
7497 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7501 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7503 return sv_2io(SvRV(sv));
7504 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7510 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7519 Using various gambits, try to get a CV from an SV; in addition, try if
7520 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7526 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7533 return *gvp = Nullgv, Nullcv;
7534 switch (SvTYPE(sv)) {
7552 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7553 tryAMAGICunDEREF(to_cv);
7556 if (SvTYPE(sv) == SVt_PVCV) {
7565 Perl_croak(aTHX_ "Not a subroutine reference");
7570 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7576 if (lref && !GvCVu(gv)) {
7579 tmpsv = NEWSV(704,0);
7580 gv_efullname3(tmpsv, gv, Nullch);
7581 /* XXX this is probably not what they think they're getting.
7582 * It has the same effect as "sub name;", i.e. just a forward
7584 newSUB(start_subparse(FALSE, 0),
7585 newSVOP(OP_CONST, 0, tmpsv),
7590 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7600 Returns true if the SV has a true value by Perl's rules.
7601 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7602 instead use an in-line version.
7608 Perl_sv_true(pTHX_ register SV *sv)
7613 register const XPV* const tXpv = (XPV*)SvANY(sv);
7615 (tXpv->xpv_cur > 1 ||
7616 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7623 return SvIVX(sv) != 0;
7626 return SvNVX(sv) != 0.0;
7628 return sv_2bool(sv);
7634 =for apidoc sv_pvn_force
7636 Get a sensible string out of the SV somehow.
7637 A private implementation of the C<SvPV_force> macro for compilers which
7638 can't cope with complex macro expressions. Always use the macro instead.
7640 =for apidoc sv_pvn_force_flags
7642 Get a sensible string out of the SV somehow.
7643 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7644 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7645 implemented in terms of this function.
7646 You normally want to use the various wrapper macros instead: see
7647 C<SvPV_force> and C<SvPV_force_nomg>
7653 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7656 if (SvTHINKFIRST(sv) && !SvROK(sv))
7657 sv_force_normal_flags(sv, 0);
7667 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7668 const char * const ref = sv_reftype(sv,0);
7670 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7671 ref, OP_NAME(PL_op));
7673 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7675 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7676 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7678 s = sv_2pv_flags(sv, &len, flags);
7682 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7685 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7686 SvGROW(sv, len + 1);
7687 Move(s,SvPVX(sv),len,char);
7692 SvPOK_on(sv); /* validate pointer */
7694 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7695 PTR2UV(sv),SvPVX_const(sv)));
7698 return SvPVX_mutable(sv);
7702 =for apidoc sv_pvbyten_force
7704 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7710 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7712 sv_pvn_force(sv,lp);
7713 sv_utf8_downgrade(sv,0);
7719 =for apidoc sv_pvutf8n_force
7721 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7727 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7729 sv_pvn_force(sv,lp);
7730 sv_utf8_upgrade(sv);
7736 =for apidoc sv_reftype
7738 Returns a string describing what the SV is a reference to.
7744 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7746 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7747 inside return suggests a const propagation bug in g++. */
7748 if (ob && SvOBJECT(sv)) {
7749 char * const name = HvNAME_get(SvSTASH(sv));
7750 return name ? name : (char *) "__ANON__";
7753 switch (SvTYPE(sv)) {
7770 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7771 /* tied lvalues should appear to be
7772 * scalars for backwards compatitbility */
7773 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7774 ? "SCALAR" : "LVALUE");
7775 case SVt_PVAV: return "ARRAY";
7776 case SVt_PVHV: return "HASH";
7777 case SVt_PVCV: return "CODE";
7778 case SVt_PVGV: return "GLOB";
7779 case SVt_PVFM: return "FORMAT";
7780 case SVt_PVIO: return "IO";
7781 default: return "UNKNOWN";
7787 =for apidoc sv_isobject
7789 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7790 object. If the SV is not an RV, or if the object is not blessed, then this
7797 Perl_sv_isobject(pTHX_ SV *sv)
7813 Returns a boolean indicating whether the SV is blessed into the specified
7814 class. This does not check for subtypes; use C<sv_derived_from> to verify
7815 an inheritance relationship.
7821 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7832 hvname = HvNAME_get(SvSTASH(sv));
7836 return strEQ(hvname, name);
7842 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7843 it will be upgraded to one. If C<classname> is non-null then the new SV will
7844 be blessed in the specified package. The new SV is returned and its
7845 reference count is 1.
7851 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7857 SV_CHECK_THINKFIRST_COW_DROP(rv);
7860 if (SvTYPE(rv) >= SVt_PVMG) {
7861 const U32 refcnt = SvREFCNT(rv);
7865 SvREFCNT(rv) = refcnt;
7868 if (SvTYPE(rv) < SVt_RV)
7869 sv_upgrade(rv, SVt_RV);
7870 else if (SvTYPE(rv) > SVt_RV) {
7881 HV* const stash = gv_stashpv(classname, TRUE);
7882 (void)sv_bless(rv, stash);
7888 =for apidoc sv_setref_pv
7890 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7891 argument will be upgraded to an RV. That RV will be modified to point to
7892 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7893 into the SV. The C<classname> argument indicates the package for the
7894 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7895 will have a reference count of 1, and the RV will be returned.
7897 Do not use with other Perl types such as HV, AV, SV, CV, because those
7898 objects will become corrupted by the pointer copy process.
7900 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7906 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7909 sv_setsv(rv, &PL_sv_undef);
7913 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7918 =for apidoc sv_setref_iv
7920 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7921 argument will be upgraded to an RV. That RV will be modified to point to
7922 the new SV. The C<classname> argument indicates the package for the
7923 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7924 will have a reference count of 1, and the RV will be returned.
7930 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7932 sv_setiv(newSVrv(rv,classname), iv);
7937 =for apidoc sv_setref_uv
7939 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7940 argument will be upgraded to an RV. That RV will be modified to point to
7941 the new SV. The C<classname> argument indicates the package for the
7942 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7943 will have a reference count of 1, and the RV will be returned.
7949 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7951 sv_setuv(newSVrv(rv,classname), uv);
7956 =for apidoc sv_setref_nv
7958 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7959 argument will be upgraded to an RV. That RV will be modified to point to
7960 the new SV. The C<classname> argument indicates the package for the
7961 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7962 will have a reference count of 1, and the RV will be returned.
7968 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7970 sv_setnv(newSVrv(rv,classname), nv);
7975 =for apidoc sv_setref_pvn
7977 Copies a string into a new SV, optionally blessing the SV. The length of the
7978 string must be specified with C<n>. The C<rv> argument will be upgraded to
7979 an RV. That RV will be modified to point to the new SV. The C<classname>
7980 argument indicates the package for the blessing. Set C<classname> to
7981 C<Nullch> to avoid the blessing. The new SV will have a reference count
7982 of 1, and the RV will be returned.
7984 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7990 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7992 sv_setpvn(newSVrv(rv,classname), pv, n);
7997 =for apidoc sv_bless
7999 Blesses an SV into a specified package. The SV must be an RV. The package
8000 must be designated by its stash (see C<gv_stashpv()>). The reference count
8001 of the SV is unaffected.
8007 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8011 Perl_croak(aTHX_ "Can't bless non-reference value");
8013 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8014 if (SvREADONLY(tmpRef))
8015 Perl_croak(aTHX_ PL_no_modify);
8016 if (SvOBJECT(tmpRef)) {
8017 if (SvTYPE(tmpRef) != SVt_PVIO)
8019 SvREFCNT_dec(SvSTASH(tmpRef));
8022 SvOBJECT_on(tmpRef);
8023 if (SvTYPE(tmpRef) != SVt_PVIO)
8025 SvUPGRADE(tmpRef, SVt_PVMG);
8026 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8033 if(SvSMAGICAL(tmpRef))
8034 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8042 /* Downgrades a PVGV to a PVMG.
8046 S_sv_unglob(pTHX_ SV *sv)
8050 assert(SvTYPE(sv) == SVt_PVGV);
8055 sv_del_backref((SV*)GvSTASH(sv), sv);
8056 GvSTASH(sv) = Nullhv;
8058 sv_unmagic(sv, PERL_MAGIC_glob);
8059 Safefree(GvNAME(sv));
8062 /* need to keep SvANY(sv) in the right arena */
8063 xpvmg = new_XPVMG();
8064 StructCopy(SvANY(sv), xpvmg, XPVMG);
8065 del_XPVGV(SvANY(sv));
8068 SvFLAGS(sv) &= ~SVTYPEMASK;
8069 SvFLAGS(sv) |= SVt_PVMG;
8073 =for apidoc sv_unref_flags
8075 Unsets the RV status of the SV, and decrements the reference count of
8076 whatever was being referenced by the RV. This can almost be thought of
8077 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8078 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8079 (otherwise the decrementing is conditional on the reference count being
8080 different from one or the reference being a readonly SV).
8087 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8089 SV* const target = SvRV(ref);
8091 if (SvWEAKREF(ref)) {
8092 sv_del_backref(target, ref);
8094 SvRV_set(ref, NULL);
8097 SvRV_set(ref, NULL);
8099 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8100 assigned to as BEGIN {$a = \"Foo"} will fail. */
8101 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8102 SvREFCNT_dec(target);
8103 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8104 sv_2mortal(target); /* Schedule for freeing later */
8108 =for apidoc sv_untaint
8110 Untaint an SV. Use C<SvTAINTED_off> instead.
8115 Perl_sv_untaint(pTHX_ SV *sv)
8117 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8118 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8125 =for apidoc sv_tainted
8127 Test an SV for taintedness. Use C<SvTAINTED> instead.
8132 Perl_sv_tainted(pTHX_ SV *sv)
8134 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8135 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8136 if (mg && (mg->mg_len & 1) )
8143 =for apidoc sv_setpviv
8145 Copies an integer into the given SV, also updating its string value.
8146 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8152 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8154 char buf[TYPE_CHARS(UV)];
8156 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8158 sv_setpvn(sv, ptr, ebuf - ptr);
8162 =for apidoc sv_setpviv_mg
8164 Like C<sv_setpviv>, but also handles 'set' magic.
8170 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8176 #if defined(PERL_IMPLICIT_CONTEXT)
8178 /* pTHX_ magic can't cope with varargs, so this is a no-context
8179 * version of the main function, (which may itself be aliased to us).
8180 * Don't access this version directly.
8184 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8188 va_start(args, pat);
8189 sv_vsetpvf(sv, pat, &args);
8193 /* pTHX_ magic can't cope with varargs, so this is a no-context
8194 * version of the main function, (which may itself be aliased to us).
8195 * Don't access this version directly.
8199 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8203 va_start(args, pat);
8204 sv_vsetpvf_mg(sv, pat, &args);
8210 =for apidoc sv_setpvf
8212 Works like C<sv_catpvf> but copies the text into the SV instead of
8213 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8219 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8222 va_start(args, pat);
8223 sv_vsetpvf(sv, pat, &args);
8228 =for apidoc sv_vsetpvf
8230 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8231 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8233 Usually used via its frontend C<sv_setpvf>.
8239 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8241 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8245 =for apidoc sv_setpvf_mg
8247 Like C<sv_setpvf>, but also handles 'set' magic.
8253 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8256 va_start(args, pat);
8257 sv_vsetpvf_mg(sv, pat, &args);
8262 =for apidoc sv_vsetpvf_mg
8264 Like C<sv_vsetpvf>, but also handles 'set' magic.
8266 Usually used via its frontend C<sv_setpvf_mg>.
8272 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8274 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8278 #if defined(PERL_IMPLICIT_CONTEXT)
8280 /* pTHX_ magic can't cope with varargs, so this is a no-context
8281 * version of the main function, (which may itself be aliased to us).
8282 * Don't access this version directly.
8286 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8290 va_start(args, pat);
8291 sv_vcatpvf(sv, pat, &args);
8295 /* pTHX_ magic can't cope with varargs, so this is a no-context
8296 * version of the main function, (which may itself be aliased to us).
8297 * Don't access this version directly.
8301 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8305 va_start(args, pat);
8306 sv_vcatpvf_mg(sv, pat, &args);
8312 =for apidoc sv_catpvf
8314 Processes its arguments like C<sprintf> and appends the formatted
8315 output to an SV. If the appended data contains "wide" characters
8316 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8317 and characters >255 formatted with %c), the original SV might get
8318 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8319 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8320 valid UTF-8; if the original SV was bytes, the pattern should be too.
8325 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8328 va_start(args, pat);
8329 sv_vcatpvf(sv, pat, &args);
8334 =for apidoc sv_vcatpvf
8336 Processes its arguments like C<vsprintf> and appends the formatted output
8337 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8339 Usually used via its frontend C<sv_catpvf>.
8345 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8347 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8351 =for apidoc sv_catpvf_mg
8353 Like C<sv_catpvf>, but also handles 'set' magic.
8359 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8362 va_start(args, pat);
8363 sv_vcatpvf_mg(sv, pat, &args);
8368 =for apidoc sv_vcatpvf_mg
8370 Like C<sv_vcatpvf>, but also handles 'set' magic.
8372 Usually used via its frontend C<sv_catpvf_mg>.
8378 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8380 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8385 =for apidoc sv_vsetpvfn
8387 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8390 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8396 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8398 sv_setpvn(sv, "", 0);
8399 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8402 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8405 S_expect_number(pTHX_ char** pattern)
8408 switch (**pattern) {
8409 case '1': case '2': case '3':
8410 case '4': case '5': case '6':
8411 case '7': case '8': case '9':
8412 while (isDIGIT(**pattern))
8413 var = var * 10 + (*(*pattern)++ - '0');
8417 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8420 F0convert(NV nv, char *endbuf, STRLEN *len)
8422 const int neg = nv < 0;
8431 if (uv & 1 && uv == nv)
8432 uv--; /* Round to even */
8434 const unsigned dig = uv % 10;
8447 =for apidoc sv_vcatpvfn
8449 Processes its arguments like C<vsprintf> and appends the formatted output
8450 to an SV. Uses an array of SVs if the C style variable argument list is
8451 missing (NULL). When running with taint checks enabled, indicates via
8452 C<maybe_tainted> if results are untrustworthy (often due to the use of
8455 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8461 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8462 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8463 vec_utf8 = DO_UTF8(vecsv);
8465 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8468 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8475 static const char nullstr[] = "(null)";
8477 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8478 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8480 /* Times 4: a decimal digit takes more than 3 binary digits.
8481 * NV_DIG: mantissa takes than many decimal digits.
8482 * Plus 32: Playing safe. */
8483 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8484 /* large enough for "%#.#f" --chip */
8485 /* what about long double NVs? --jhi */
8487 PERL_UNUSED_ARG(maybe_tainted);
8489 /* no matter what, this is a string now */
8490 (void)SvPV_force(sv, origlen);
8492 /* special-case "", "%s", and "%-p" (SVf - see below) */
8495 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8497 const char * const s = va_arg(*args, char*);
8498 sv_catpv(sv, s ? s : nullstr);
8500 else if (svix < svmax) {
8501 sv_catsv(sv, *svargs);
8502 if (DO_UTF8(*svargs))
8507 if (args && patlen == 3 && pat[0] == '%' &&
8508 pat[1] == '-' && pat[2] == 'p') {
8509 argsv = va_arg(*args, SV*);
8510 sv_catsv(sv, argsv);
8516 #ifndef USE_LONG_DOUBLE
8517 /* special-case "%.<number>[gf]" */
8518 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8519 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8520 unsigned digits = 0;
8524 while (*pp >= '0' && *pp <= '9')
8525 digits = 10 * digits + (*pp++ - '0');
8526 if (pp - pat == (int)patlen - 1) {
8534 /* Add check for digits != 0 because it seems that some
8535 gconverts are buggy in this case, and we don't yet have
8536 a Configure test for this. */
8537 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8538 /* 0, point, slack */
8539 Gconvert(nv, (int)digits, 0, ebuf);
8541 if (*ebuf) /* May return an empty string for digits==0 */
8544 } else if (!digits) {
8547 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8548 sv_catpvn(sv, p, l);
8554 #endif /* !USE_LONG_DOUBLE */
8556 if (!args && svix < svmax && DO_UTF8(*svargs))
8559 patend = (char*)pat + patlen;
8560 for (p = (char*)pat; p < patend; p = q) {
8563 bool vectorize = FALSE;
8564 bool vectorarg = FALSE;
8565 bool vec_utf8 = FALSE;
8571 bool has_precis = FALSE;
8574 bool is_utf8 = FALSE; /* is this item utf8? */
8575 #ifdef HAS_LDBL_SPRINTF_BUG
8576 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8577 with sfio - Allen <allens@cpan.org> */
8578 bool fix_ldbl_sprintf_bug = FALSE;
8582 U8 utf8buf[UTF8_MAXBYTES+1];
8583 STRLEN esignlen = 0;
8585 const char *eptr = Nullch;
8588 const U8 *vecstr = Null(U8*);
8595 /* we need a long double target in case HAS_LONG_DOUBLE but
8598 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8606 const char *dotstr = ".";
8607 STRLEN dotstrlen = 1;
8608 I32 efix = 0; /* explicit format parameter index */
8609 I32 ewix = 0; /* explicit width index */
8610 I32 epix = 0; /* explicit precision index */
8611 I32 evix = 0; /* explicit vector index */
8612 bool asterisk = FALSE;
8614 /* echo everything up to the next format specification */
8615 for (q = p; q < patend && *q != '%'; ++q) ;
8617 if (has_utf8 && !pat_utf8)
8618 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8620 sv_catpvn(sv, p, q - p);
8627 We allow format specification elements in this order:
8628 \d+\$ explicit format parameter index
8630 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8631 0 flag (as above): repeated to allow "v02"
8632 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8633 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8635 [%bcdefginopsuxDFOUX] format (mandatory)
8640 As of perl5.9.3, printf format checking is on by default.
8641 Internally, perl uses %p formats to provide an escape to
8642 some extended formatting. This block deals with those
8643 extensions: if it does not match, (char*)q is reset and
8644 the normal format processing code is used.
8646 Currently defined extensions are:
8647 %p include pointer address (standard)
8648 %-p (SVf) include an SV (previously %_)
8649 %-<num>p include an SV with precision <num>
8650 %1p (VDf) include a v-string (as %vd)
8651 %<num>p reserved for future extensions
8653 Robin Barker 2005-07-14
8660 EXPECT_NUMBER(q, n);
8667 argsv = va_arg(*args, SV*);
8668 eptr = SvPVx_const(argsv, elen);
8674 else if (n == vdNUMBER) { /* VDf */
8681 if (ckWARN_d(WARN_INTERNAL))
8682 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8683 "internal %%<num>p might conflict with future printf extensions");
8689 if (EXPECT_NUMBER(q, width)) {
8730 if (EXPECT_NUMBER(q, ewix))
8739 if ((vectorarg = asterisk)) {
8752 EXPECT_NUMBER(q, width);
8758 vecsv = va_arg(*args, SV*);
8760 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8761 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8762 dotstr = SvPV_const(vecsv, dotstrlen);
8769 else if (efix ? efix <= svmax : svix < svmax) {
8770 vecsv = svargs[efix ? efix-1 : svix++];
8771 vecstr = (U8*)SvPV_const(vecsv,veclen);
8772 vec_utf8 = DO_UTF8(vecsv);
8773 /* if this is a version object, we need to return the
8774 * stringified representation (which the SvPVX_const has
8775 * already done for us), but not vectorize the args
8777 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8779 q++; /* skip past the rest of the %vd format */
8780 eptr = (const char *) vecstr;
8794 i = va_arg(*args, int);
8796 i = (ewix ? ewix <= svmax : svix < svmax) ?
8797 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8799 width = (i < 0) ? -i : i;
8809 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8811 /* XXX: todo, support specified precision parameter */
8815 i = va_arg(*args, int);
8817 i = (ewix ? ewix <= svmax : svix < svmax)
8818 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8819 precis = (i < 0) ? 0 : i;
8824 precis = precis * 10 + (*q++ - '0');
8833 case 'I': /* Ix, I32x, and I64x */
8835 if (q[1] == '6' && q[2] == '4') {
8841 if (q[1] == '3' && q[2] == '2') {
8851 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8862 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8863 if (*(q + 1) == 'l') { /* lld, llf */
8888 argsv = (efix ? efix <= svmax : svix < svmax) ?
8889 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8896 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8898 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8900 eptr = (char*)utf8buf;
8901 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8912 if (args && !vectorize) {
8913 eptr = va_arg(*args, char*);
8915 #ifdef MACOS_TRADITIONAL
8916 /* On MacOS, %#s format is used for Pascal strings */
8921 elen = strlen(eptr);
8923 eptr = (char *)nullstr;
8924 elen = sizeof nullstr - 1;
8928 eptr = SvPVx_const(argsv, elen);
8929 if (DO_UTF8(argsv)) {
8930 if (has_precis && precis < elen) {
8932 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8935 if (width) { /* fudge width (can't fudge elen) */
8936 width += elen - sv_len_utf8(argsv);
8944 if (has_precis && elen > precis)
8951 if (alt || vectorize)
8953 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8974 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8983 esignbuf[esignlen++] = plus;
8987 case 'h': iv = (short)va_arg(*args, int); break;
8988 case 'l': iv = va_arg(*args, long); break;
8989 case 'V': iv = va_arg(*args, IV); break;
8990 default: iv = va_arg(*args, int); break;
8992 case 'q': iv = va_arg(*args, Quad_t); break;
8997 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8999 case 'h': iv = (short)tiv; break;
9000 case 'l': iv = (long)tiv; break;
9002 default: iv = tiv; break;
9004 case 'q': iv = (Quad_t)tiv; break;
9008 if ( !vectorize ) /* we already set uv above */
9013 esignbuf[esignlen++] = plus;
9017 esignbuf[esignlen++] = '-';
9060 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9071 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9072 case 'l': uv = va_arg(*args, unsigned long); break;
9073 case 'V': uv = va_arg(*args, UV); break;
9074 default: uv = va_arg(*args, unsigned); break;
9076 case 'q': uv = va_arg(*args, Uquad_t); break;
9081 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9083 case 'h': uv = (unsigned short)tuv; break;
9084 case 'l': uv = (unsigned long)tuv; break;
9086 default: uv = tuv; break;
9088 case 'q': uv = (Uquad_t)tuv; break;
9095 char *ptr = ebuf + sizeof ebuf;
9101 p = (char*)((c == 'X')
9102 ? "0123456789ABCDEF" : "0123456789abcdef");
9108 esignbuf[esignlen++] = '0';
9109 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9117 if (alt && *ptr != '0')
9126 esignbuf[esignlen++] = '0';
9127 esignbuf[esignlen++] = 'b';
9130 default: /* it had better be ten or less */
9134 } while (uv /= base);
9137 elen = (ebuf + sizeof ebuf) - ptr;
9141 zeros = precis - elen;
9142 else if (precis == 0 && elen == 1 && *eptr == '0')
9148 /* FLOATING POINT */
9151 c = 'f'; /* maybe %F isn't supported here */
9157 /* This is evil, but floating point is even more evil */
9159 /* for SV-style calling, we can only get NV
9160 for C-style calling, we assume %f is double;
9161 for simplicity we allow any of %Lf, %llf, %qf for long double
9165 #if defined(USE_LONG_DOUBLE)
9169 /* [perl #20339] - we should accept and ignore %lf rather than die */
9173 #if defined(USE_LONG_DOUBLE)
9174 intsize = args ? 0 : 'q';
9178 #if defined(HAS_LONG_DOUBLE)
9187 /* now we need (long double) if intsize == 'q', else (double) */
9188 nv = (args && !vectorize) ?
9189 #if LONG_DOUBLESIZE > DOUBLESIZE
9191 va_arg(*args, long double) :
9192 va_arg(*args, double)
9194 va_arg(*args, double)
9200 if (c != 'e' && c != 'E') {
9202 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9203 will cast our (long double) to (double) */
9204 (void)Perl_frexp(nv, &i);
9205 if (i == PERL_INT_MIN)
9206 Perl_die(aTHX_ "panic: frexp");
9208 need = BIT_DIGITS(i);
9210 need += has_precis ? precis : 6; /* known default */
9215 #ifdef HAS_LDBL_SPRINTF_BUG
9216 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9217 with sfio - Allen <allens@cpan.org> */
9220 # define MY_DBL_MAX DBL_MAX
9221 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9222 # if DOUBLESIZE >= 8
9223 # define MY_DBL_MAX 1.7976931348623157E+308L
9225 # define MY_DBL_MAX 3.40282347E+38L
9229 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9230 # define MY_DBL_MAX_BUG 1L
9232 # define MY_DBL_MAX_BUG MY_DBL_MAX
9236 # define MY_DBL_MIN DBL_MIN
9237 # else /* XXX guessing! -Allen */
9238 # if DOUBLESIZE >= 8
9239 # define MY_DBL_MIN 2.2250738585072014E-308L
9241 # define MY_DBL_MIN 1.17549435E-38L
9245 if ((intsize == 'q') && (c == 'f') &&
9246 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9248 /* it's going to be short enough that
9249 * long double precision is not needed */
9251 if ((nv <= 0L) && (nv >= -0L))
9252 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9254 /* would use Perl_fp_class as a double-check but not
9255 * functional on IRIX - see perl.h comments */
9257 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9258 /* It's within the range that a double can represent */
9259 #if defined(DBL_MAX) && !defined(DBL_MIN)
9260 if ((nv >= ((long double)1/DBL_MAX)) ||
9261 (nv <= (-(long double)1/DBL_MAX)))
9263 fix_ldbl_sprintf_bug = TRUE;
9266 if (fix_ldbl_sprintf_bug == TRUE) {
9276 # undef MY_DBL_MAX_BUG
9279 #endif /* HAS_LDBL_SPRINTF_BUG */
9281 need += 20; /* fudge factor */
9282 if (PL_efloatsize < need) {
9283 Safefree(PL_efloatbuf);
9284 PL_efloatsize = need + 20; /* more fudge */
9285 Newx(PL_efloatbuf, PL_efloatsize, char);
9286 PL_efloatbuf[0] = '\0';
9289 if ( !(width || left || plus || alt) && fill != '0'
9290 && has_precis && intsize != 'q' ) { /* Shortcuts */
9291 /* See earlier comment about buggy Gconvert when digits,
9293 if ( c == 'g' && precis) {
9294 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9295 /* May return an empty string for digits==0 */
9296 if (*PL_efloatbuf) {
9297 elen = strlen(PL_efloatbuf);
9298 goto float_converted;
9300 } else if ( c == 'f' && !precis) {
9301 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9306 char *ptr = ebuf + sizeof ebuf;
9309 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9310 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9311 if (intsize == 'q') {
9312 /* Copy the one or more characters in a long double
9313 * format before the 'base' ([efgEFG]) character to
9314 * the format string. */
9315 static char const prifldbl[] = PERL_PRIfldbl;
9316 char const *p = prifldbl + sizeof(prifldbl) - 3;
9317 while (p >= prifldbl) { *--ptr = *p--; }
9322 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9327 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9339 /* No taint. Otherwise we are in the strange situation
9340 * where printf() taints but print($float) doesn't.
9342 #if defined(HAS_LONG_DOUBLE)
9343 elen = ((intsize == 'q')
9344 ? my_sprintf(PL_efloatbuf, ptr, nv)
9345 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9347 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9351 eptr = PL_efloatbuf;
9357 i = SvCUR(sv) - origlen;
9358 if (args && !vectorize) {
9360 case 'h': *(va_arg(*args, short*)) = i; break;
9361 default: *(va_arg(*args, int*)) = i; break;
9362 case 'l': *(va_arg(*args, long*)) = i; break;
9363 case 'V': *(va_arg(*args, IV*)) = i; break;
9365 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9370 sv_setuv_mg(argsv, (UV)i);
9372 continue; /* not "break" */
9379 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9380 && ckWARN(WARN_PRINTF))
9382 SV * const msg = sv_newmortal();
9383 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9384 (PL_op->op_type == OP_PRTF) ? "" : "s");
9387 Perl_sv_catpvf(aTHX_ msg,
9388 "\"%%%c\"", c & 0xFF);
9390 Perl_sv_catpvf(aTHX_ msg,
9391 "\"%%\\%03"UVof"\"",
9394 sv_catpv(msg, "end of string");
9395 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9398 /* output mangled stuff ... */
9404 /* ... right here, because formatting flags should not apply */
9405 SvGROW(sv, SvCUR(sv) + elen + 1);
9407 Copy(eptr, p, elen, char);
9410 SvCUR_set(sv, p - SvPVX_const(sv));
9412 continue; /* not "break" */
9415 /* calculate width before utf8_upgrade changes it */
9416 have = esignlen + zeros + elen;
9418 if (is_utf8 != has_utf8) {
9421 sv_utf8_upgrade(sv);
9424 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9425 sv_utf8_upgrade(nsv);
9426 eptr = SvPVX_const(nsv);
9429 SvGROW(sv, SvCUR(sv) + elen + 1);
9434 need = (have > width ? have : width);
9437 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9439 if (esignlen && fill == '0') {
9441 for (i = 0; i < (int)esignlen; i++)
9445 memset(p, fill, gap);
9448 if (esignlen && fill != '0') {
9450 for (i = 0; i < (int)esignlen; i++)
9455 for (i = zeros; i; i--)
9459 Copy(eptr, p, elen, char);
9463 memset(p, ' ', gap);
9468 Copy(dotstr, p, dotstrlen, char);
9472 vectorize = FALSE; /* done iterating over vecstr */
9479 SvCUR_set(sv, p - SvPVX_const(sv));
9487 /* =========================================================================
9489 =head1 Cloning an interpreter
9491 All the macros and functions in this section are for the private use of
9492 the main function, perl_clone().
9494 The foo_dup() functions make an exact copy of an existing foo thinngy.
9495 During the course of a cloning, a hash table is used to map old addresses
9496 to new addresses. The table is created and manipulated with the
9497 ptr_table_* functions.
9501 ============================================================================*/
9504 #if defined(USE_ITHREADS)
9506 #ifndef GpREFCNT_inc
9507 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9511 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9512 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9513 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9514 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9515 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9516 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9517 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9518 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9519 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9520 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9521 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9522 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9523 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9526 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9527 regcomp.c. AMS 20010712 */
9530 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9535 struct reg_substr_datum *s;
9538 return (REGEXP *)NULL;
9540 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9543 len = r->offsets[0];
9544 npar = r->nparens+1;
9546 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9547 Copy(r->program, ret->program, len+1, regnode);
9549 Newx(ret->startp, npar, I32);
9550 Copy(r->startp, ret->startp, npar, I32);
9551 Newx(ret->endp, npar, I32);
9552 Copy(r->startp, ret->startp, npar, I32);
9554 Newx(ret->substrs, 1, struct reg_substr_data);
9555 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9556 s->min_offset = r->substrs->data[i].min_offset;
9557 s->max_offset = r->substrs->data[i].max_offset;
9558 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9559 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9562 ret->regstclass = NULL;
9565 const int count = r->data->count;
9568 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9569 char, struct reg_data);
9570 Newx(d->what, count, U8);
9573 for (i = 0; i < count; i++) {
9574 d->what[i] = r->data->what[i];
9575 switch (d->what[i]) {
9576 /* legal options are one of: sfpont
9577 see also regcomp.h and pregfree() */
9579 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9582 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9585 /* This is cheating. */
9586 Newx(d->data[i], 1, struct regnode_charclass_class);
9587 StructCopy(r->data->data[i], d->data[i],
9588 struct regnode_charclass_class);
9589 ret->regstclass = (regnode*)d->data[i];
9592 /* Compiled op trees are readonly, and can thus be
9593 shared without duplication. */
9595 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9599 d->data[i] = r->data->data[i];
9602 d->data[i] = r->data->data[i];
9604 ((reg_trie_data*)d->data[i])->refcount++;
9608 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9617 Newx(ret->offsets, 2*len+1, U32);
9618 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9620 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9621 ret->refcnt = r->refcnt;
9622 ret->minlen = r->minlen;
9623 ret->prelen = r->prelen;
9624 ret->nparens = r->nparens;
9625 ret->lastparen = r->lastparen;
9626 ret->lastcloseparen = r->lastcloseparen;
9627 ret->reganch = r->reganch;
9629 ret->sublen = r->sublen;
9631 if (RX_MATCH_COPIED(ret))
9632 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9634 ret->subbeg = Nullch;
9635 #ifdef PERL_OLD_COPY_ON_WRITE
9636 ret->saved_copy = Nullsv;
9639 ptr_table_store(PL_ptr_table, r, ret);
9643 /* duplicate a file handle */
9646 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9650 PERL_UNUSED_ARG(type);
9653 return (PerlIO*)NULL;
9655 /* look for it in the table first */
9656 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9660 /* create anew and remember what it is */
9661 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9662 ptr_table_store(PL_ptr_table, fp, ret);
9666 /* duplicate a directory handle */
9669 Perl_dirp_dup(pTHX_ DIR *dp)
9677 /* duplicate a typeglob */
9680 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9685 /* look for it in the table first */
9686 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9690 /* create anew and remember what it is */
9692 ptr_table_store(PL_ptr_table, gp, ret);
9695 ret->gp_refcnt = 0; /* must be before any other dups! */
9696 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9697 ret->gp_io = io_dup_inc(gp->gp_io, param);
9698 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9699 ret->gp_av = av_dup_inc(gp->gp_av, param);
9700 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9701 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9702 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9703 ret->gp_cvgen = gp->gp_cvgen;
9704 ret->gp_line = gp->gp_line;
9705 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9709 /* duplicate a chain of magic */
9712 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9714 MAGIC *mgprev = (MAGIC*)NULL;
9717 return (MAGIC*)NULL;
9718 /* look for it in the table first */
9719 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9723 for (; mg; mg = mg->mg_moremagic) {
9725 Newxz(nmg, 1, MAGIC);
9727 mgprev->mg_moremagic = nmg;
9730 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9731 nmg->mg_private = mg->mg_private;
9732 nmg->mg_type = mg->mg_type;
9733 nmg->mg_flags = mg->mg_flags;
9734 if (mg->mg_type == PERL_MAGIC_qr) {
9735 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9737 else if(mg->mg_type == PERL_MAGIC_backref) {
9738 const AV * const av = (AV*) mg->mg_obj;
9741 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9743 for (i = AvFILLp(av); i >= 0; i--) {
9744 if (!svp[i]) continue;
9745 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9748 else if (mg->mg_type == PERL_MAGIC_symtab) {
9749 nmg->mg_obj = mg->mg_obj;
9752 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9753 ? sv_dup_inc(mg->mg_obj, param)
9754 : sv_dup(mg->mg_obj, param);
9756 nmg->mg_len = mg->mg_len;
9757 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9758 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9759 if (mg->mg_len > 0) {
9760 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9761 if (mg->mg_type == PERL_MAGIC_overload_table &&
9762 AMT_AMAGIC((AMT*)mg->mg_ptr))
9764 AMT * const amtp = (AMT*)mg->mg_ptr;
9765 AMT * const namtp = (AMT*)nmg->mg_ptr;
9767 for (i = 1; i < NofAMmeth; i++) {
9768 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9772 else if (mg->mg_len == HEf_SVKEY)
9773 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9775 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9776 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9783 /* create a new pointer-mapping table */
9786 Perl_ptr_table_new(pTHX)
9789 Newxz(tbl, 1, PTR_TBL_t);
9792 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9797 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9799 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9803 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9804 following define) and at call to new_body_inline made below in
9805 Perl_ptr_table_store()
9808 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9810 /* map an existing pointer using a table */
9813 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9815 PTR_TBL_ENT_t *tblent;
9816 const UV hash = PTR_TABLE_HASH(sv);
9818 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9819 for (; tblent; tblent = tblent->next) {
9820 if (tblent->oldval == sv)
9821 return tblent->newval;
9826 /* add a new entry to a pointer-mapping table */
9829 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9831 PTR_TBL_ENT_t *tblent, **otblent;
9832 /* XXX this may be pessimal on platforms where pointers aren't good
9833 * hash values e.g. if they grow faster in the most significant
9835 const UV hash = PTR_TABLE_HASH(oldsv);
9839 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9840 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9841 if (tblent->oldval == oldsv) {
9842 tblent->newval = newsv;
9846 new_body_inline(tblent, &PL_body_roots[PTE_SVSLOT],
9847 sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9848 tblent->oldval = oldsv;
9849 tblent->newval = newsv;
9850 tblent->next = *otblent;
9853 if (!empty && tbl->tbl_items > tbl->tbl_max)
9854 ptr_table_split(tbl);
9857 /* double the hash bucket size of an existing ptr table */
9860 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9862 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9863 const UV oldsize = tbl->tbl_max + 1;
9864 UV newsize = oldsize * 2;
9867 Renew(ary, newsize, PTR_TBL_ENT_t*);
9868 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9869 tbl->tbl_max = --newsize;
9871 for (i=0; i < oldsize; i++, ary++) {
9872 PTR_TBL_ENT_t **curentp, **entp, *ent;
9875 curentp = ary + oldsize;
9876 for (entp = ary, ent = *ary; ent; ent = *entp) {
9877 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9879 ent->next = *curentp;
9889 /* remove all the entries from a ptr table */
9892 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9894 register PTR_TBL_ENT_t **array;
9895 register PTR_TBL_ENT_t *entry;
9899 if (!tbl || !tbl->tbl_items) {
9903 array = tbl->tbl_ary;
9909 PTR_TBL_ENT_t *oentry = entry;
9910 entry = entry->next;
9914 if (++riter > max) {
9917 entry = array[riter];
9924 /* clear and free a ptr table */
9927 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9932 ptr_table_clear(tbl);
9933 Safefree(tbl->tbl_ary);
9939 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9942 SvRV_set(dstr, SvWEAKREF(sstr)
9943 ? sv_dup(SvRV(sstr), param)
9944 : sv_dup_inc(SvRV(sstr), param));
9947 else if (SvPVX_const(sstr)) {
9948 /* Has something there */
9950 /* Normal PV - clone whole allocated space */
9951 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9952 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9953 /* Not that normal - actually sstr is copy on write.
9954 But we are a true, independant SV, so: */
9955 SvREADONLY_off(dstr);
9960 /* Special case - not normally malloced for some reason */
9961 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9962 /* A "shared" PV - clone it as "shared" PV */
9964 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9968 /* Some other special case - random pointer */
9969 SvPV_set(dstr, SvPVX(sstr));
9975 if (SvTYPE(dstr) == SVt_RV)
9976 SvRV_set(dstr, NULL);
9982 /* duplicate an SV of any type (including AV, HV etc) */
9985 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9990 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9992 /* look for it in the table first */
9993 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9997 if(param->flags & CLONEf_JOIN_IN) {
9998 /** We are joining here so we don't want do clone
9999 something that is bad **/
10000 const char *hvname;
10002 if(SvTYPE(sstr) == SVt_PVHV &&
10003 (hvname = HvNAME_get(sstr))) {
10004 /** don't clone stashes if they already exist **/
10005 return (SV*)gv_stashpv(hvname,0);
10009 /* create anew and remember what it is */
10012 #ifdef DEBUG_LEAKING_SCALARS
10013 dstr->sv_debug_optype = sstr->sv_debug_optype;
10014 dstr->sv_debug_line = sstr->sv_debug_line;
10015 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10016 dstr->sv_debug_cloned = 1;
10018 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10020 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10024 ptr_table_store(PL_ptr_table, sstr, dstr);
10027 SvFLAGS(dstr) = SvFLAGS(sstr);
10028 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10029 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10032 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10033 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10034 PL_watch_pvx, SvPVX_const(sstr));
10037 /* don't clone objects whose class has asked us not to */
10038 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10039 SvFLAGS(dstr) &= ~SVTYPEMASK;
10040 SvOBJECT_off(dstr);
10044 switch (SvTYPE(sstr)) {
10046 SvANY(dstr) = NULL;
10049 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10050 SvIV_set(dstr, SvIVX(sstr));
10053 SvANY(dstr) = new_XNV();
10054 SvNV_set(dstr, SvNVX(sstr));
10057 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10058 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10062 /* These are all the types that need complex bodies allocating. */
10063 size_t new_body_length;
10064 size_t new_body_offset = 0;
10065 void **new_body_arena;
10066 void **new_body_arenaroot;
10068 svtype sv_type = SvTYPE(sstr);
10072 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10077 new_body = new_XPVIO();
10078 new_body_length = sizeof(XPVIO);
10081 new_body = new_XPVFM();
10082 new_body_length = sizeof(XPVFM);
10086 new_body_arena = &PL_body_roots[SVt_PVHV];
10087 new_body_arenaroot = &PL_body_arenaroots[SVt_PVHV];
10088 new_body_offset = - bodies_by_type[SVt_PVHV].offset;
10090 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10091 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10095 new_body_arena = &PL_body_roots[SVt_PVAV];
10096 new_body_arenaroot = &PL_body_arenaroots[SVt_PVAV];
10097 new_body_offset = - bodies_by_type[SVt_PVAV].offset;
10099 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10100 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10104 if (GvUNIQUE((GV*)sstr)) {
10105 /* Do sharing here, and fall through */
10112 new_body_length = bodies_by_type[sv_type].size;
10113 new_body_arena = &PL_body_roots[sv_type];
10114 new_body_arenaroot = &PL_body_arenaroots[sv_type];
10118 new_body_offset = - bodies_by_type[SVt_PVIV].offset;
10119 new_body_length = sizeof(XPVIV) - new_body_offset;
10120 new_body_arena = &PL_body_roots[SVt_PVIV];
10121 new_body_arenaroot = &PL_body_arenaroots[SVt_PVIV];
10124 new_body_offset = - bodies_by_type[SVt_PV].offset;
10125 new_body_length = sizeof(XPV) - new_body_offset;
10126 new_body_arena = &PL_body_roots[SVt_PV];
10127 new_body_arenaroot = &PL_body_arenaroots[SVt_PV];
10129 assert(new_body_length);
10131 new_body_inline(new_body, new_body_arena,
10132 new_body_length, SvTYPE(sstr));
10134 new_body = (void*)((char*)new_body - new_body_offset);
10136 /* We always allocated the full length item with PURIFY */
10137 new_body_length += new_body_offset;
10138 new_body_offset = 0;
10139 new_body = my_safemalloc(new_body_length);
10143 SvANY(dstr) = new_body;
10145 Copy(((char*)SvANY(sstr)) + new_body_offset,
10146 ((char*)SvANY(dstr)) + new_body_offset,
10147 new_body_length, char);
10149 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10150 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10152 /* The Copy above means that all the source (unduplicated) pointers
10153 are now in the destination. We can check the flags and the
10154 pointers in either, but it's possible that there's less cache
10155 missing by always going for the destination.
10156 FIXME - instrument and check that assumption */
10157 if (SvTYPE(sstr) >= SVt_PVMG) {
10159 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10161 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10164 switch (SvTYPE(sstr)) {
10176 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10177 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10178 LvTARG(dstr) = dstr;
10179 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10180 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10182 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10185 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10186 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10187 /* Don't call sv_add_backref here as it's going to be created
10188 as part of the magic cloning of the symbol table. */
10189 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10190 (void)GpREFCNT_inc(GvGP(dstr));
10193 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10194 if (IoOFP(dstr) == IoIFP(sstr))
10195 IoOFP(dstr) = IoIFP(dstr);
10197 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10198 /* PL_rsfp_filters entries have fake IoDIRP() */
10199 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10200 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10201 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10202 /* I have no idea why fake dirp (rsfps)
10203 should be treated differently but otherwise
10204 we end up with leaks -- sky*/
10205 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10206 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10207 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10209 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10210 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10211 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10213 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10214 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10215 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10218 if (AvARRAY((AV*)sstr)) {
10219 SV **dst_ary, **src_ary;
10220 SSize_t items = AvFILLp((AV*)sstr) + 1;
10222 src_ary = AvARRAY((AV*)sstr);
10223 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10224 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10225 SvPV_set(dstr, (char*)dst_ary);
10226 AvALLOC((AV*)dstr) = dst_ary;
10227 if (AvREAL((AV*)sstr)) {
10228 while (items-- > 0)
10229 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10232 while (items-- > 0)
10233 *dst_ary++ = sv_dup(*src_ary++, param);
10235 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10236 while (items-- > 0) {
10237 *dst_ary++ = &PL_sv_undef;
10241 SvPV_set(dstr, Nullch);
10242 AvALLOC((AV*)dstr) = (SV**)NULL;
10249 if (HvARRAY((HV*)sstr)) {
10251 const bool sharekeys = !!HvSHAREKEYS(sstr);
10252 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10253 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10255 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10256 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10258 HvARRAY(dstr) = (HE**)darray;
10259 while (i <= sxhv->xhv_max) {
10260 const HE *source = HvARRAY(sstr)[i];
10261 HvARRAY(dstr)[i] = source
10262 ? he_dup(source, sharekeys, param) : 0;
10266 struct xpvhv_aux *saux = HvAUX(sstr);
10267 struct xpvhv_aux *daux = HvAUX(dstr);
10268 /* This flag isn't copied. */
10269 /* SvOOK_on(hv) attacks the IV flags. */
10270 SvFLAGS(dstr) |= SVf_OOK;
10272 hvname = saux->xhv_name;
10274 = hvname ? hek_dup(hvname, param) : hvname;
10276 daux->xhv_riter = saux->xhv_riter;
10277 daux->xhv_eiter = saux->xhv_eiter
10278 ? he_dup(saux->xhv_eiter,
10279 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10283 SvPV_set(dstr, Nullch);
10285 /* Record stashes for possible cloning in Perl_clone(). */
10287 av_push(param->stashes, dstr);
10292 /* NOTE: not refcounted */
10293 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10295 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10297 if (CvCONST(dstr)) {
10298 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10299 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10300 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10302 /* don't dup if copying back - CvGV isn't refcounted, so the
10303 * duped GV may never be freed. A bit of a hack! DAPM */
10304 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10305 Nullgv : gv_dup(CvGV(dstr), param) ;
10306 if (!(param->flags & CLONEf_COPY_STACKS)) {
10309 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10311 CvWEAKOUTSIDE(sstr)
10312 ? cv_dup( CvOUTSIDE(dstr), param)
10313 : cv_dup_inc(CvOUTSIDE(dstr), param);
10315 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10321 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10327 /* duplicate a context */
10330 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10332 PERL_CONTEXT *ncxs;
10335 return (PERL_CONTEXT*)NULL;
10337 /* look for it in the table first */
10338 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10342 /* create anew and remember what it is */
10343 Newxz(ncxs, max + 1, PERL_CONTEXT);
10344 ptr_table_store(PL_ptr_table, cxs, ncxs);
10347 PERL_CONTEXT *cx = &cxs[ix];
10348 PERL_CONTEXT *ncx = &ncxs[ix];
10349 ncx->cx_type = cx->cx_type;
10350 if (CxTYPE(cx) == CXt_SUBST) {
10351 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10354 ncx->blk_oldsp = cx->blk_oldsp;
10355 ncx->blk_oldcop = cx->blk_oldcop;
10356 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10357 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10358 ncx->blk_oldpm = cx->blk_oldpm;
10359 ncx->blk_gimme = cx->blk_gimme;
10360 switch (CxTYPE(cx)) {
10362 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10363 ? cv_dup_inc(cx->blk_sub.cv, param)
10364 : cv_dup(cx->blk_sub.cv,param));
10365 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10366 ? av_dup_inc(cx->blk_sub.argarray, param)
10368 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10369 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10370 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10371 ncx->blk_sub.lval = cx->blk_sub.lval;
10372 ncx->blk_sub.retop = cx->blk_sub.retop;
10375 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10376 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10377 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10378 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10379 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10380 ncx->blk_eval.retop = cx->blk_eval.retop;
10383 ncx->blk_loop.label = cx->blk_loop.label;
10384 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10385 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10386 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10387 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10388 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10389 ? cx->blk_loop.iterdata
10390 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10391 ncx->blk_loop.oldcomppad
10392 = (PAD*)ptr_table_fetch(PL_ptr_table,
10393 cx->blk_loop.oldcomppad);
10394 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10395 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10396 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10397 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10398 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10401 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10402 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10403 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10404 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10405 ncx->blk_sub.retop = cx->blk_sub.retop;
10417 /* duplicate a stack info structure */
10420 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10425 return (PERL_SI*)NULL;
10427 /* look for it in the table first */
10428 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10432 /* create anew and remember what it is */
10433 Newxz(nsi, 1, PERL_SI);
10434 ptr_table_store(PL_ptr_table, si, nsi);
10436 nsi->si_stack = av_dup_inc(si->si_stack, param);
10437 nsi->si_cxix = si->si_cxix;
10438 nsi->si_cxmax = si->si_cxmax;
10439 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10440 nsi->si_type = si->si_type;
10441 nsi->si_prev = si_dup(si->si_prev, param);
10442 nsi->si_next = si_dup(si->si_next, param);
10443 nsi->si_markoff = si->si_markoff;
10448 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10449 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10450 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10451 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10452 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10453 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10454 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10455 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10456 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10457 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10458 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10459 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10460 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10461 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10464 #define pv_dup_inc(p) SAVEPV(p)
10465 #define pv_dup(p) SAVEPV(p)
10466 #define svp_dup_inc(p,pp) any_dup(p,pp)
10468 /* map any object to the new equivent - either something in the
10469 * ptr table, or something in the interpreter structure
10473 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10478 return (void*)NULL;
10480 /* look for it in the table first */
10481 ret = ptr_table_fetch(PL_ptr_table, v);
10485 /* see if it is part of the interpreter structure */
10486 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10487 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10495 /* duplicate the save stack */
10498 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10500 ANY * const ss = proto_perl->Tsavestack;
10501 const I32 max = proto_perl->Tsavestack_max;
10502 I32 ix = proto_perl->Tsavestack_ix;
10514 void (*dptr) (void*);
10515 void (*dxptr) (pTHX_ void*);
10517 Newxz(nss, max, ANY);
10520 I32 i = POPINT(ss,ix);
10521 TOPINT(nss,ix) = i;
10523 case SAVEt_ITEM: /* normal string */
10524 sv = (SV*)POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10526 sv = (SV*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10529 case SAVEt_SV: /* scalar reference */
10530 sv = (SV*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10532 gv = (GV*)POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10535 case SAVEt_GENERIC_PVREF: /* generic char* */
10536 c = (char*)POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = pv_dup(c);
10538 ptr = POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10541 case SAVEt_SHARED_PVREF: /* char* in shared space */
10542 c = (char*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = savesharedpv(c);
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10547 case SAVEt_GENERIC_SVREF: /* generic sv */
10548 case SAVEt_SVREF: /* scalar reference */
10549 sv = (SV*)POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10551 ptr = POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10554 case SAVEt_AV: /* array reference */
10555 av = (AV*)POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = av_dup_inc(av, param);
10557 gv = (GV*)POPPTR(ss,ix);
10558 TOPPTR(nss,ix) = gv_dup(gv, param);
10560 case SAVEt_HV: /* hash reference */
10561 hv = (HV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10563 gv = (GV*)POPPTR(ss,ix);
10564 TOPPTR(nss,ix) = gv_dup(gv, param);
10566 case SAVEt_INT: /* int reference */
10567 ptr = POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10569 intval = (int)POPINT(ss,ix);
10570 TOPINT(nss,ix) = intval;
10572 case SAVEt_LONG: /* long reference */
10573 ptr = POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10575 longval = (long)POPLONG(ss,ix);
10576 TOPLONG(nss,ix) = longval;
10578 case SAVEt_I32: /* I32 reference */
10579 case SAVEt_I16: /* I16 reference */
10580 case SAVEt_I8: /* I8 reference */
10581 ptr = POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10584 TOPINT(nss,ix) = i;
10586 case SAVEt_IV: /* IV reference */
10587 ptr = POPPTR(ss,ix);
10588 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10590 TOPIV(nss,ix) = iv;
10592 case SAVEt_SPTR: /* SV* reference */
10593 ptr = POPPTR(ss,ix);
10594 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10595 sv = (SV*)POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = sv_dup(sv, param);
10598 case SAVEt_VPTR: /* random* reference */
10599 ptr = POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10601 ptr = POPPTR(ss,ix);
10602 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10604 case SAVEt_PPTR: /* char* reference */
10605 ptr = POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10607 c = (char*)POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = pv_dup(c);
10610 case SAVEt_HPTR: /* HV* reference */
10611 ptr = POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10613 hv = (HV*)POPPTR(ss,ix);
10614 TOPPTR(nss,ix) = hv_dup(hv, param);
10616 case SAVEt_APTR: /* AV* reference */
10617 ptr = POPPTR(ss,ix);
10618 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10619 av = (AV*)POPPTR(ss,ix);
10620 TOPPTR(nss,ix) = av_dup(av, param);
10623 gv = (GV*)POPPTR(ss,ix);
10624 TOPPTR(nss,ix) = gv_dup(gv, param);
10626 case SAVEt_GP: /* scalar reference */
10627 gp = (GP*)POPPTR(ss,ix);
10628 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10629 (void)GpREFCNT_inc(gp);
10630 gv = (GV*)POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10632 c = (char*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = pv_dup(c);
10635 TOPIV(nss,ix) = iv;
10637 TOPIV(nss,ix) = iv;
10640 case SAVEt_MORTALIZESV:
10641 sv = (SV*)POPPTR(ss,ix);
10642 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10645 ptr = POPPTR(ss,ix);
10646 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10647 /* these are assumed to be refcounted properly */
10649 switch (((OP*)ptr)->op_type) {
10651 case OP_LEAVESUBLV:
10655 case OP_LEAVEWRITE:
10656 TOPPTR(nss,ix) = ptr;
10661 TOPPTR(nss,ix) = Nullop;
10666 TOPPTR(nss,ix) = Nullop;
10669 c = (char*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = pv_dup_inc(c);
10672 case SAVEt_CLEARSV:
10673 longval = POPLONG(ss,ix);
10674 TOPLONG(nss,ix) = longval;
10677 hv = (HV*)POPPTR(ss,ix);
10678 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10679 c = (char*)POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = pv_dup_inc(c);
10682 TOPINT(nss,ix) = i;
10684 case SAVEt_DESTRUCTOR:
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10687 dptr = POPDPTR(ss,ix);
10688 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10689 any_dup(FPTR2DPTR(void *, dptr),
10692 case SAVEt_DESTRUCTOR_X:
10693 ptr = POPPTR(ss,ix);
10694 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10695 dxptr = POPDXPTR(ss,ix);
10696 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10697 any_dup(FPTR2DPTR(void *, dxptr),
10700 case SAVEt_REGCONTEXT:
10703 TOPINT(nss,ix) = i;
10706 case SAVEt_STACK_POS: /* Position on Perl stack */
10708 TOPINT(nss,ix) = i;
10710 case SAVEt_AELEM: /* array element */
10711 sv = (SV*)POPPTR(ss,ix);
10712 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10714 TOPINT(nss,ix) = i;
10715 av = (AV*)POPPTR(ss,ix);
10716 TOPPTR(nss,ix) = av_dup_inc(av, param);
10718 case SAVEt_HELEM: /* hash element */
10719 sv = (SV*)POPPTR(ss,ix);
10720 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10721 sv = (SV*)POPPTR(ss,ix);
10722 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10723 hv = (HV*)POPPTR(ss,ix);
10724 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10727 ptr = POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = ptr;
10732 TOPINT(nss,ix) = i;
10734 case SAVEt_COMPPAD:
10735 av = (AV*)POPPTR(ss,ix);
10736 TOPPTR(nss,ix) = av_dup(av, param);
10739 longval = (long)POPLONG(ss,ix);
10740 TOPLONG(nss,ix) = longval;
10741 ptr = POPPTR(ss,ix);
10742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10743 sv = (SV*)POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = sv_dup(sv, param);
10747 ptr = POPPTR(ss,ix);
10748 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10749 longval = (long)POPBOOL(ss,ix);
10750 TOPBOOL(nss,ix) = (bool)longval;
10752 case SAVEt_SET_SVFLAGS:
10754 TOPINT(nss,ix) = i;
10756 TOPINT(nss,ix) = i;
10757 sv = (SV*)POPPTR(ss,ix);
10758 TOPPTR(nss,ix) = sv_dup(sv, param);
10761 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10769 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10770 * flag to the result. This is done for each stash before cloning starts,
10771 * so we know which stashes want their objects cloned */
10774 do_mark_cloneable_stash(pTHX_ SV *sv)
10776 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10778 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10779 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10780 if (cloner && GvCV(cloner)) {
10787 XPUSHs(sv_2mortal(newSVhek(hvname)));
10789 call_sv((SV*)GvCV(cloner), G_SCALAR);
10796 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10804 =for apidoc perl_clone
10806 Create and return a new interpreter by cloning the current one.
10808 perl_clone takes these flags as parameters:
10810 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10811 without it we only clone the data and zero the stacks,
10812 with it we copy the stacks and the new perl interpreter is
10813 ready to run at the exact same point as the previous one.
10814 The pseudo-fork code uses COPY_STACKS while the
10815 threads->new doesn't.
10817 CLONEf_KEEP_PTR_TABLE
10818 perl_clone keeps a ptr_table with the pointer of the old
10819 variable as a key and the new variable as a value,
10820 this allows it to check if something has been cloned and not
10821 clone it again but rather just use the value and increase the
10822 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10823 the ptr_table using the function
10824 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10825 reason to keep it around is if you want to dup some of your own
10826 variable who are outside the graph perl scans, example of this
10827 code is in threads.xs create
10830 This is a win32 thing, it is ignored on unix, it tells perls
10831 win32host code (which is c++) to clone itself, this is needed on
10832 win32 if you want to run two threads at the same time,
10833 if you just want to do some stuff in a separate perl interpreter
10834 and then throw it away and return to the original one,
10835 you don't need to do anything.
10840 /* XXX the above needs expanding by someone who actually understands it ! */
10841 EXTERN_C PerlInterpreter *
10842 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10845 perl_clone(PerlInterpreter *proto_perl, UV flags)
10848 #ifdef PERL_IMPLICIT_SYS
10850 /* perlhost.h so we need to call into it
10851 to clone the host, CPerlHost should have a c interface, sky */
10853 if (flags & CLONEf_CLONE_HOST) {
10854 return perl_clone_host(proto_perl,flags);
10856 return perl_clone_using(proto_perl, flags,
10858 proto_perl->IMemShared,
10859 proto_perl->IMemParse,
10861 proto_perl->IStdIO,
10865 proto_perl->IProc);
10869 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10870 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10871 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10872 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10873 struct IPerlDir* ipD, struct IPerlSock* ipS,
10874 struct IPerlProc* ipP)
10876 /* XXX many of the string copies here can be optimized if they're
10877 * constants; they need to be allocated as common memory and just
10878 * their pointers copied. */
10881 CLONE_PARAMS clone_params;
10882 CLONE_PARAMS* param = &clone_params;
10884 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10885 /* for each stash, determine whether its objects should be cloned */
10886 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10887 PERL_SET_THX(my_perl);
10890 Poison(my_perl, 1, PerlInterpreter);
10892 PL_curcop = (COP *)Nullop;
10896 PL_savestack_ix = 0;
10897 PL_savestack_max = -1;
10898 PL_sig_pending = 0;
10899 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10900 # else /* !DEBUGGING */
10901 Zero(my_perl, 1, PerlInterpreter);
10902 # endif /* DEBUGGING */
10904 /* host pointers */
10906 PL_MemShared = ipMS;
10907 PL_MemParse = ipMP;
10914 #else /* !PERL_IMPLICIT_SYS */
10916 CLONE_PARAMS clone_params;
10917 CLONE_PARAMS* param = &clone_params;
10918 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10919 /* for each stash, determine whether its objects should be cloned */
10920 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10921 PERL_SET_THX(my_perl);
10924 Poison(my_perl, 1, PerlInterpreter);
10926 PL_curcop = (COP *)Nullop;
10930 PL_savestack_ix = 0;
10931 PL_savestack_max = -1;
10932 PL_sig_pending = 0;
10933 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10934 # else /* !DEBUGGING */
10935 Zero(my_perl, 1, PerlInterpreter);
10936 # endif /* DEBUGGING */
10937 #endif /* PERL_IMPLICIT_SYS */
10938 param->flags = flags;
10939 param->proto_perl = proto_perl;
10941 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10942 Zero(&PL_body_roots, 1, PL_body_roots);
10944 PL_he_arenaroot = NULL;
10947 PL_nice_chunk = NULL;
10948 PL_nice_chunk_size = 0;
10950 PL_sv_objcount = 0;
10951 PL_sv_root = Nullsv;
10952 PL_sv_arenaroot = Nullsv;
10954 PL_debug = proto_perl->Idebug;
10956 PL_hash_seed = proto_perl->Ihash_seed;
10957 PL_rehash_seed = proto_perl->Irehash_seed;
10959 #ifdef USE_REENTRANT_API
10960 /* XXX: things like -Dm will segfault here in perlio, but doing
10961 * PERL_SET_CONTEXT(proto_perl);
10962 * breaks too many other things
10964 Perl_reentrant_init(aTHX);
10967 /* create SV map for pointer relocation */
10968 PL_ptr_table = ptr_table_new();
10970 /* initialize these special pointers as early as possible */
10971 SvANY(&PL_sv_undef) = NULL;
10972 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10973 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10974 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10976 SvANY(&PL_sv_no) = new_XPVNV();
10977 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10978 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10979 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10980 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10981 SvCUR_set(&PL_sv_no, 0);
10982 SvLEN_set(&PL_sv_no, 1);
10983 SvIV_set(&PL_sv_no, 0);
10984 SvNV_set(&PL_sv_no, 0);
10985 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10987 SvANY(&PL_sv_yes) = new_XPVNV();
10988 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10989 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10990 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10991 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10992 SvCUR_set(&PL_sv_yes, 1);
10993 SvLEN_set(&PL_sv_yes, 2);
10994 SvIV_set(&PL_sv_yes, 1);
10995 SvNV_set(&PL_sv_yes, 1);
10996 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10998 /* create (a non-shared!) shared string table */
10999 PL_strtab = newHV();
11000 HvSHAREKEYS_off(PL_strtab);
11001 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11002 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11004 PL_compiling = proto_perl->Icompiling;
11006 /* These two PVs will be free'd special way so must set them same way op.c does */
11007 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11008 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11010 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11011 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11013 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11014 if (!specialWARN(PL_compiling.cop_warnings))
11015 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11016 if (!specialCopIO(PL_compiling.cop_io))
11017 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11018 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11020 /* pseudo environmental stuff */
11021 PL_origargc = proto_perl->Iorigargc;
11022 PL_origargv = proto_perl->Iorigargv;
11024 param->stashes = newAV(); /* Setup array of objects to call clone on */
11026 /* Set tainting stuff before PerlIO_debug can possibly get called */
11027 PL_tainting = proto_perl->Itainting;
11028 PL_taint_warn = proto_perl->Itaint_warn;
11030 #ifdef PERLIO_LAYERS
11031 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11032 PerlIO_clone(aTHX_ proto_perl, param);
11035 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11036 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11037 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11038 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11039 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11040 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11043 PL_minus_c = proto_perl->Iminus_c;
11044 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11045 PL_localpatches = proto_perl->Ilocalpatches;
11046 PL_splitstr = proto_perl->Isplitstr;
11047 PL_preprocess = proto_perl->Ipreprocess;
11048 PL_minus_n = proto_perl->Iminus_n;
11049 PL_minus_p = proto_perl->Iminus_p;
11050 PL_minus_l = proto_perl->Iminus_l;
11051 PL_minus_a = proto_perl->Iminus_a;
11052 PL_minus_F = proto_perl->Iminus_F;
11053 PL_doswitches = proto_perl->Idoswitches;
11054 PL_dowarn = proto_perl->Idowarn;
11055 PL_doextract = proto_perl->Idoextract;
11056 PL_sawampersand = proto_perl->Isawampersand;
11057 PL_unsafe = proto_perl->Iunsafe;
11058 PL_inplace = SAVEPV(proto_perl->Iinplace);
11059 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11060 PL_perldb = proto_perl->Iperldb;
11061 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11062 PL_exit_flags = proto_perl->Iexit_flags;
11064 /* magical thingies */
11065 /* XXX time(&PL_basetime) when asked for? */
11066 PL_basetime = proto_perl->Ibasetime;
11067 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11069 PL_maxsysfd = proto_perl->Imaxsysfd;
11070 PL_multiline = proto_perl->Imultiline;
11071 PL_statusvalue = proto_perl->Istatusvalue;
11073 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11075 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11077 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11079 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11080 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11081 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11083 /* Clone the regex array */
11084 PL_regex_padav = newAV();
11086 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11087 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11089 av_push(PL_regex_padav,
11090 sv_dup_inc(regexen[0],param));
11091 for(i = 1; i <= len; i++) {
11092 if(SvREPADTMP(regexen[i])) {
11093 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11095 av_push(PL_regex_padav,
11097 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11098 SvIVX(regexen[i])), param)))
11103 PL_regex_pad = AvARRAY(PL_regex_padav);
11105 /* shortcuts to various I/O objects */
11106 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11107 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11108 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11109 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11110 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11111 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11113 /* shortcuts to regexp stuff */
11114 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11116 /* shortcuts to misc objects */
11117 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11119 /* shortcuts to debugging objects */
11120 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11121 PL_DBline = gv_dup(proto_perl->IDBline, param);
11122 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11123 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11124 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11125 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11126 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11127 PL_lineary = av_dup(proto_perl->Ilineary, param);
11128 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11130 /* symbol tables */
11131 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11132 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11133 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11134 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11135 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11137 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11138 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11139 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11140 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11141 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11142 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11144 PL_sub_generation = proto_perl->Isub_generation;
11146 /* funky return mechanisms */
11147 PL_forkprocess = proto_perl->Iforkprocess;
11149 /* subprocess state */
11150 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11152 /* internal state */
11153 PL_maxo = proto_perl->Imaxo;
11154 if (proto_perl->Iop_mask)
11155 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11157 PL_op_mask = Nullch;
11158 /* PL_asserting = proto_perl->Iasserting; */
11160 /* current interpreter roots */
11161 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11162 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11163 PL_main_start = proto_perl->Imain_start;
11164 PL_eval_root = proto_perl->Ieval_root;
11165 PL_eval_start = proto_perl->Ieval_start;
11167 /* runtime control stuff */
11168 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11169 PL_copline = proto_perl->Icopline;
11171 PL_filemode = proto_perl->Ifilemode;
11172 PL_lastfd = proto_perl->Ilastfd;
11173 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11176 PL_gensym = proto_perl->Igensym;
11177 PL_preambled = proto_perl->Ipreambled;
11178 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11179 PL_laststatval = proto_perl->Ilaststatval;
11180 PL_laststype = proto_perl->Ilaststype;
11181 PL_mess_sv = Nullsv;
11183 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11185 /* interpreter atexit processing */
11186 PL_exitlistlen = proto_perl->Iexitlistlen;
11187 if (PL_exitlistlen) {
11188 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11189 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11192 PL_exitlist = (PerlExitListEntry*)NULL;
11193 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11194 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11195 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11197 PL_profiledata = NULL;
11198 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11199 /* PL_rsfp_filters entries have fake IoDIRP() */
11200 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11202 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11204 PAD_CLONE_VARS(proto_perl, param);
11206 #ifdef HAVE_INTERP_INTERN
11207 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11210 /* more statics moved here */
11211 PL_generation = proto_perl->Igeneration;
11212 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11214 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11215 PL_in_clean_all = proto_perl->Iin_clean_all;
11217 PL_uid = proto_perl->Iuid;
11218 PL_euid = proto_perl->Ieuid;
11219 PL_gid = proto_perl->Igid;
11220 PL_egid = proto_perl->Iegid;
11221 PL_nomemok = proto_perl->Inomemok;
11222 PL_an = proto_perl->Ian;
11223 PL_evalseq = proto_perl->Ievalseq;
11224 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11225 PL_origalen = proto_perl->Iorigalen;
11226 #ifdef PERL_USES_PL_PIDSTATUS
11227 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11229 PL_osname = SAVEPV(proto_perl->Iosname);
11230 PL_sighandlerp = proto_perl->Isighandlerp;
11232 PL_runops = proto_perl->Irunops;
11234 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11237 PL_cshlen = proto_perl->Icshlen;
11238 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11241 PL_lex_state = proto_perl->Ilex_state;
11242 PL_lex_defer = proto_perl->Ilex_defer;
11243 PL_lex_expect = proto_perl->Ilex_expect;
11244 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11245 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11246 PL_lex_starts = proto_perl->Ilex_starts;
11247 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11248 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11249 PL_lex_op = proto_perl->Ilex_op;
11250 PL_lex_inpat = proto_perl->Ilex_inpat;
11251 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11252 PL_lex_brackets = proto_perl->Ilex_brackets;
11253 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11254 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11255 PL_lex_casemods = proto_perl->Ilex_casemods;
11256 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11257 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11259 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11260 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11261 PL_nexttoke = proto_perl->Inexttoke;
11263 /* XXX This is probably masking the deeper issue of why
11264 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11265 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11266 * (A little debugging with a watchpoint on it may help.)
11268 if (SvANY(proto_perl->Ilinestr)) {
11269 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11270 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11271 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11272 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11273 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11274 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11275 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11276 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11277 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11280 PL_linestr = NEWSV(65,79);
11281 sv_upgrade(PL_linestr,SVt_PVIV);
11282 sv_setpvn(PL_linestr,"",0);
11283 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11285 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11286 PL_pending_ident = proto_perl->Ipending_ident;
11287 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11289 PL_expect = proto_perl->Iexpect;
11291 PL_multi_start = proto_perl->Imulti_start;
11292 PL_multi_end = proto_perl->Imulti_end;
11293 PL_multi_open = proto_perl->Imulti_open;
11294 PL_multi_close = proto_perl->Imulti_close;
11296 PL_error_count = proto_perl->Ierror_count;
11297 PL_subline = proto_perl->Isubline;
11298 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11300 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11301 if (SvANY(proto_perl->Ilinestr)) {
11302 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11303 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11304 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11305 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11306 PL_last_lop_op = proto_perl->Ilast_lop_op;
11309 PL_last_uni = SvPVX(PL_linestr);
11310 PL_last_lop = SvPVX(PL_linestr);
11311 PL_last_lop_op = 0;
11313 PL_in_my = proto_perl->Iin_my;
11314 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11316 PL_cryptseen = proto_perl->Icryptseen;
11319 PL_hints = proto_perl->Ihints;
11321 PL_amagic_generation = proto_perl->Iamagic_generation;
11323 #ifdef USE_LOCALE_COLLATE
11324 PL_collation_ix = proto_perl->Icollation_ix;
11325 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11326 PL_collation_standard = proto_perl->Icollation_standard;
11327 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11328 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11329 #endif /* USE_LOCALE_COLLATE */
11331 #ifdef USE_LOCALE_NUMERIC
11332 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11333 PL_numeric_standard = proto_perl->Inumeric_standard;
11334 PL_numeric_local = proto_perl->Inumeric_local;
11335 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11336 #endif /* !USE_LOCALE_NUMERIC */
11338 /* utf8 character classes */
11339 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11340 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11341 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11342 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11343 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11344 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11345 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11346 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11347 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11348 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11349 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11350 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11351 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11352 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11353 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11354 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11355 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11356 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11357 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11358 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11360 /* Did the locale setup indicate UTF-8? */
11361 PL_utf8locale = proto_perl->Iutf8locale;
11362 /* Unicode features (see perlrun/-C) */
11363 PL_unicode = proto_perl->Iunicode;
11365 /* Pre-5.8 signals control */
11366 PL_signals = proto_perl->Isignals;
11368 /* times() ticks per second */
11369 PL_clocktick = proto_perl->Iclocktick;
11371 /* Recursion stopper for PerlIO_find_layer */
11372 PL_in_load_module = proto_perl->Iin_load_module;
11374 /* sort() routine */
11375 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11377 /* Not really needed/useful since the reenrant_retint is "volatile",
11378 * but do it for consistency's sake. */
11379 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11381 /* Hooks to shared SVs and locks. */
11382 PL_sharehook = proto_perl->Isharehook;
11383 PL_lockhook = proto_perl->Ilockhook;
11384 PL_unlockhook = proto_perl->Iunlockhook;
11385 PL_threadhook = proto_perl->Ithreadhook;
11387 PL_runops_std = proto_perl->Irunops_std;
11388 PL_runops_dbg = proto_perl->Irunops_dbg;
11390 #ifdef THREADS_HAVE_PIDS
11391 PL_ppid = proto_perl->Ippid;
11395 PL_last_swash_hv = Nullhv; /* reinits on demand */
11396 PL_last_swash_klen = 0;
11397 PL_last_swash_key[0]= '\0';
11398 PL_last_swash_tmps = (U8*)NULL;
11399 PL_last_swash_slen = 0;
11401 PL_glob_index = proto_perl->Iglob_index;
11402 PL_srand_called = proto_perl->Isrand_called;
11403 PL_uudmap['M'] = 0; /* reinits on demand */
11404 PL_bitcount = Nullch; /* reinits on demand */
11406 if (proto_perl->Ipsig_pend) {
11407 Newxz(PL_psig_pend, SIG_SIZE, int);
11410 PL_psig_pend = (int*)NULL;
11413 if (proto_perl->Ipsig_ptr) {
11414 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11415 Newxz(PL_psig_name, SIG_SIZE, SV*);
11416 for (i = 1; i < SIG_SIZE; i++) {
11417 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11418 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11422 PL_psig_ptr = (SV**)NULL;
11423 PL_psig_name = (SV**)NULL;
11426 /* thrdvar.h stuff */
11428 if (flags & CLONEf_COPY_STACKS) {
11429 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11430 PL_tmps_ix = proto_perl->Ttmps_ix;
11431 PL_tmps_max = proto_perl->Ttmps_max;
11432 PL_tmps_floor = proto_perl->Ttmps_floor;
11433 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11435 while (i <= PL_tmps_ix) {
11436 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11440 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11441 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11442 Newxz(PL_markstack, i, I32);
11443 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11444 - proto_perl->Tmarkstack);
11445 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11446 - proto_perl->Tmarkstack);
11447 Copy(proto_perl->Tmarkstack, PL_markstack,
11448 PL_markstack_ptr - PL_markstack + 1, I32);
11450 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11451 * NOTE: unlike the others! */
11452 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11453 PL_scopestack_max = proto_perl->Tscopestack_max;
11454 Newxz(PL_scopestack, PL_scopestack_max, I32);
11455 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11457 /* NOTE: si_dup() looks at PL_markstack */
11458 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11460 /* PL_curstack = PL_curstackinfo->si_stack; */
11461 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11462 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11464 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11465 PL_stack_base = AvARRAY(PL_curstack);
11466 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11467 - proto_perl->Tstack_base);
11468 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11470 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11471 * NOTE: unlike the others! */
11472 PL_savestack_ix = proto_perl->Tsavestack_ix;
11473 PL_savestack_max = proto_perl->Tsavestack_max;
11474 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11475 PL_savestack = ss_dup(proto_perl, param);
11479 ENTER; /* perl_destruct() wants to LEAVE; */
11482 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11483 PL_top_env = &PL_start_env;
11485 PL_op = proto_perl->Top;
11488 PL_Xpv = (XPV*)NULL;
11489 PL_na = proto_perl->Tna;
11491 PL_statbuf = proto_perl->Tstatbuf;
11492 PL_statcache = proto_perl->Tstatcache;
11493 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11494 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11496 PL_timesbuf = proto_perl->Ttimesbuf;
11499 PL_tainted = proto_perl->Ttainted;
11500 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11501 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11502 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11503 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11504 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11505 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11506 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11507 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11508 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11510 PL_restartop = proto_perl->Trestartop;
11511 PL_in_eval = proto_perl->Tin_eval;
11512 PL_delaymagic = proto_perl->Tdelaymagic;
11513 PL_dirty = proto_perl->Tdirty;
11514 PL_localizing = proto_perl->Tlocalizing;
11516 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11517 PL_hv_fetch_ent_mh = Nullhe;
11518 PL_modcount = proto_perl->Tmodcount;
11519 PL_lastgotoprobe = Nullop;
11520 PL_dumpindent = proto_perl->Tdumpindent;
11522 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11523 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11524 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11525 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11526 PL_efloatbuf = Nullch; /* reinits on demand */
11527 PL_efloatsize = 0; /* reinits on demand */
11531 PL_screamfirst = NULL;
11532 PL_screamnext = NULL;
11533 PL_maxscream = -1; /* reinits on demand */
11534 PL_lastscream = Nullsv;
11536 PL_watchaddr = NULL;
11537 PL_watchok = Nullch;
11539 PL_regdummy = proto_perl->Tregdummy;
11540 PL_regprecomp = Nullch;
11543 PL_colorset = 0; /* reinits PL_colors[] */
11544 /*PL_colors[6] = {0,0,0,0,0,0};*/
11545 PL_reginput = Nullch;
11546 PL_regbol = Nullch;
11547 PL_regeol = Nullch;
11548 PL_regstartp = (I32*)NULL;
11549 PL_regendp = (I32*)NULL;
11550 PL_reglastparen = (U32*)NULL;
11551 PL_reglastcloseparen = (U32*)NULL;
11552 PL_regtill = Nullch;
11553 PL_reg_start_tmp = (char**)NULL;
11554 PL_reg_start_tmpl = 0;
11555 PL_regdata = (struct reg_data*)NULL;
11558 PL_reg_eval_set = 0;
11560 PL_regprogram = (regnode*)NULL;
11562 PL_regcc = (CURCUR*)NULL;
11563 PL_reg_call_cc = (struct re_cc_state*)NULL;
11564 PL_reg_re = (regexp*)NULL;
11565 PL_reg_ganch = Nullch;
11566 PL_reg_sv = Nullsv;
11567 PL_reg_match_utf8 = FALSE;
11568 PL_reg_magic = (MAGIC*)NULL;
11570 PL_reg_oldcurpm = (PMOP*)NULL;
11571 PL_reg_curpm = (PMOP*)NULL;
11572 PL_reg_oldsaved = Nullch;
11573 PL_reg_oldsavedlen = 0;
11574 #ifdef PERL_OLD_COPY_ON_WRITE
11577 PL_reg_maxiter = 0;
11578 PL_reg_leftiter = 0;
11579 PL_reg_poscache = Nullch;
11580 PL_reg_poscache_size= 0;
11582 /* RE engine - function pointers */
11583 PL_regcompp = proto_perl->Tregcompp;
11584 PL_regexecp = proto_perl->Tregexecp;
11585 PL_regint_start = proto_perl->Tregint_start;
11586 PL_regint_string = proto_perl->Tregint_string;
11587 PL_regfree = proto_perl->Tregfree;
11589 PL_reginterp_cnt = 0;
11590 PL_reg_starttry = 0;
11592 /* Pluggable optimizer */
11593 PL_peepp = proto_perl->Tpeepp;
11595 PL_stashcache = newHV();
11597 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11598 ptr_table_free(PL_ptr_table);
11599 PL_ptr_table = NULL;
11602 /* Call the ->CLONE method, if it exists, for each of the stashes
11603 identified by sv_dup() above.
11605 while(av_len(param->stashes) != -1) {
11606 HV* const stash = (HV*) av_shift(param->stashes);
11607 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11608 if (cloner && GvCV(cloner)) {
11613 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11615 call_sv((SV*)GvCV(cloner), G_DISCARD);
11621 SvREFCNT_dec(param->stashes);
11623 /* orphaned? eg threads->new inside BEGIN or use */
11624 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11625 (void)SvREFCNT_inc(PL_compcv);
11626 SAVEFREESV(PL_compcv);
11632 #endif /* USE_ITHREADS */
11635 =head1 Unicode Support
11637 =for apidoc sv_recode_to_utf8
11639 The encoding is assumed to be an Encode object, on entry the PV
11640 of the sv is assumed to be octets in that encoding, and the sv
11641 will be converted into Unicode (and UTF-8).
11643 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11644 is not a reference, nothing is done to the sv. If the encoding is not
11645 an C<Encode::XS> Encoding object, bad things will happen.
11646 (See F<lib/encoding.pm> and L<Encode>).
11648 The PV of the sv is returned.
11653 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11656 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11670 Passing sv_yes is wrong - it needs to be or'ed set of constants
11671 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11672 remove converted chars from source.
11674 Both will default the value - let them.
11676 XPUSHs(&PL_sv_yes);
11679 call_method("decode", G_SCALAR);
11683 s = SvPV_const(uni, len);
11684 if (s != SvPVX_const(sv)) {
11685 SvGROW(sv, len + 1);
11686 Move(s, SvPVX(sv), len + 1, char);
11687 SvCUR_set(sv, len);
11694 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11698 =for apidoc sv_cat_decode
11700 The encoding is assumed to be an Encode object, the PV of the ssv is
11701 assumed to be octets in that encoding and decoding the input starts
11702 from the position which (PV + *offset) pointed to. The dsv will be
11703 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11704 when the string tstr appears in decoding output or the input ends on
11705 the PV of the ssv. The value which the offset points will be modified
11706 to the last input position on the ssv.
11708 Returns TRUE if the terminator was found, else returns FALSE.
11713 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11714 SV *ssv, int *offset, char *tstr, int tlen)
11718 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11729 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11730 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11732 call_method("cat_decode", G_SCALAR);
11734 ret = SvTRUE(TOPs);
11735 *offset = SvIV(offsv);
11741 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11747 * c-indentation-style: bsd
11748 * c-basic-offset: 4
11749 * indent-tabs-mode: t
11752 * ex: set ts=8 sts=4 sw=4 noet: