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 Normally, this allocation is done using arenas, which by default are
67 approximately 4K chunks of memory parcelled up into N heads or bodies. The
68 first slot in each arena is reserved, and is used to hold a link to the next
69 arena. In the case of heads, the unused first slot also contains some flags
70 and a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free list.
74 The following global variables are associated with arenas:
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
83 Note that some of the larger and more rarely used body types (eg xpvio)
84 are not allocated using arenas, but are instead just malloc()/free()ed as
85 required. Also, if PURIFY is defined, arenas are abandoned altogether,
86 with all items individually malloc()ed. In addition, a few SV heads are
87 not allocated from an arena, but are instead directly created as static
88 or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89 the default by setting PERL_ARENA_SIZE appropriately at compile time.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
169 * nice_chunk and nice_chunk size need to be set
170 * and queried under the protection of sv_mutex
173 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
178 new_chunk = (void *)(chunk);
179 new_chunk_size = (chunk_size);
180 if (new_chunk_size > PL_nice_chunk_size) {
181 Safefree(PL_nice_chunk);
182 PL_nice_chunk = (char *) new_chunk;
183 PL_nice_chunk_size = new_chunk_size;
190 #ifdef DEBUG_LEAKING_SCALARS
191 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
193 # define FREE_SV_DEBUG_FILE(sv)
196 #define plant_SV(p) \
198 FREE_SV_DEBUG_FILE(p); \
199 SvANY(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 /* sv_mutex must be held while calling uproot_SV() */
206 #define uproot_SV(p) \
209 PL_sv_root = (SV*)SvANY(p); \
214 /* make some more SVs by adding another arena */
216 /* sv_mutex must be held while calling more_sv() */
223 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
224 PL_nice_chunk = Nullch;
225 PL_nice_chunk_size = 0;
228 char *chunk; /* must use New here to match call to */
229 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
230 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
236 /* new_SV(): return a new, empty SV head */
238 #ifdef DEBUG_LEAKING_SCALARS
239 /* provide a real function for a debugger to play with */
249 sv = S_more_sv(aTHX);
254 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
255 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
256 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
257 sv->sv_debug_inpad = 0;
258 sv->sv_debug_cloned = 0;
259 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
263 # define new_SV(p) (p)=S_new_SV(aTHX)
272 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
296 S_del_sv(pTHX_ SV *p)
301 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
302 const SV * const sv = sva + 1;
303 const SV * const svend = &sva[SvREFCNT(sva)];
304 if (p >= sv && p < svend) {
310 if (ckWARN_d(WARN_INTERNAL))
311 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
312 "Attempt to free non-arena SV: 0x%"UVxf
313 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
320 #else /* ! DEBUGGING */
322 #define del_SV(p) plant_SV(p)
324 #endif /* DEBUGGING */
328 =head1 SV Manipulation Functions
330 =for apidoc sv_add_arena
332 Given a chunk of memory, link it to the head of the list of arenas,
333 and split it into a list of free SVs.
339 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
345 /* The first SV in an arena isn't an SV. */
346 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
347 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
348 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
350 PL_sv_arenaroot = sva;
351 PL_sv_root = sva + 1;
353 svend = &sva[SvREFCNT(sva) - 1];
356 SvANY(sv) = (void *)(SV*)(sv + 1);
360 /* Must always set typemask because it's awlays checked in on cleanup
361 when the arenas are walked looking for objects. */
362 SvFLAGS(sv) = SVTYPEMASK;
369 SvFLAGS(sv) = SVTYPEMASK;
372 /* visit(): call the named function for each non-free SV in the arenas
373 * whose flags field matches the flags/mask args. */
376 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
381 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
382 register const SV * const svend = &sva[SvREFCNT(sva)];
384 for (sv = sva + 1; sv < svend; ++sv) {
385 if (SvTYPE(sv) != SVTYPEMASK
386 && (sv->sv_flags & mask) == flags
399 /* called by sv_report_used() for each live SV */
402 do_report_used(pTHX_ SV *sv)
404 if (SvTYPE(sv) != SVTYPEMASK) {
405 PerlIO_printf(Perl_debug_log, "****\n");
412 =for apidoc sv_report_used
414 Dump the contents of all SVs not yet freed. (Debugging aid).
420 Perl_sv_report_used(pTHX)
423 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
433 SV * const target = SvRV(ref);
434 if (SvOBJECT(target)) {
435 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
436 if (SvWEAKREF(ref)) {
437 sv_del_backref(target, ref);
443 SvREFCNT_dec(target);
448 /* XXX Might want to check arrays, etc. */
451 /* called by sv_clean_objs() for each live SV */
453 #ifndef DISABLE_DESTRUCTOR_KLUDGE
455 do_clean_named_objs(pTHX_ SV *sv)
457 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
459 #ifdef PERL_DONT_CREATE_GVSV
462 SvOBJECT(GvSV(sv))) ||
463 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
464 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
465 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
466 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
468 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
469 SvFLAGS(sv) |= SVf_BREAK;
477 =for apidoc sv_clean_objs
479 Attempt to destroy all objects not yet freed
485 Perl_sv_clean_objs(pTHX)
487 PL_in_clean_objs = TRUE;
488 visit(do_clean_objs, SVf_ROK, SVf_ROK);
489 #ifndef DISABLE_DESTRUCTOR_KLUDGE
490 /* some barnacles may yet remain, clinging to typeglobs */
491 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
493 PL_in_clean_objs = FALSE;
496 /* called by sv_clean_all() for each live SV */
499 do_clean_all(pTHX_ SV *sv)
501 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
502 SvFLAGS(sv) |= SVf_BREAK;
503 if (PL_comppad == (AV*)sv) {
505 PL_curpad = Null(SV**);
511 =for apidoc sv_clean_all
513 Decrement the refcnt of each remaining SV, possibly triggering a
514 cleanup. This function may have to be called multiple times to free
515 SVs which are in complex self-referential hierarchies.
521 Perl_sv_clean_all(pTHX)
524 PL_in_clean_all = TRUE;
525 cleaned = visit(do_clean_all, 0,0);
526 PL_in_clean_all = FALSE;
531 S_free_arena(pTHX_ void **root) {
533 void ** const next = *(void **)root;
540 =for apidoc sv_free_arenas
542 Deallocate the memory used by all arenas. Note that all the individual SV
543 heads and bodies within the arenas must already have been freed.
548 #define free_arena(name) \
550 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
551 PL_ ## name ## _arenaroot = 0; \
552 PL_ ## name ## _root = 0; \
556 Perl_sv_free_arenas(pTHX)
561 /* Free arenas here, but be careful about fake ones. (We assume
562 contiguity of the fake ones with the corresponding real ones.) */
564 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
565 svanext = (SV*) SvANY(sva);
566 while (svanext && SvFAKE(svanext))
567 svanext = (SV*) SvANY(svanext);
585 #if defined(USE_ITHREADS)
589 Safefree(PL_nice_chunk);
590 PL_nice_chunk = Nullch;
591 PL_nice_chunk_size = 0;
596 /* ---------------------------------------------------------------------
598 * support functions for report_uninit()
601 /* the maxiumum size of array or hash where we will scan looking
602 * for the undefined element that triggered the warning */
604 #define FUV_MAX_SEARCH_SIZE 1000
606 /* Look for an entry in the hash whose value has the same SV as val;
607 * If so, return a mortal copy of the key. */
610 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
616 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
617 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
622 for (i=HvMAX(hv); i>0; i--) {
624 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
625 if (HeVAL(entry) != val)
627 if ( HeVAL(entry) == &PL_sv_undef ||
628 HeVAL(entry) == &PL_sv_placeholder)
632 if (HeKLEN(entry) == HEf_SVKEY)
633 return sv_mortalcopy(HeKEY_sv(entry));
634 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
640 /* Look for an entry in the array whose value has the same SV as val;
641 * If so, return the index, otherwise return -1. */
644 S_find_array_subscript(pTHX_ AV *av, SV* val)
648 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
649 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
653 for (i=AvFILLp(av); i>=0; i--) {
654 if (svp[i] == val && svp[i] != &PL_sv_undef)
660 /* S_varname(): return the name of a variable, optionally with a subscript.
661 * If gv is non-zero, use the name of that global, along with gvtype (one
662 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
663 * targ. Depending on the value of the subscript_type flag, return:
666 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
667 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
668 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
669 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
672 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
673 SV* keyname, I32 aindex, int subscript_type)
676 SV * const name = sv_newmortal();
682 /* as gv_fullname4(), but add literal '^' for $^FOO names */
684 gv_fullname4(name, gv, buffer, 0);
686 if ((unsigned int)SvPVX(name)[1] <= 26) {
688 buffer[1] = SvPVX(name)[1] + 'A' - 1;
690 /* Swap the 1 unprintable control character for the 2 byte pretty
691 version - ie substr($name, 1, 1) = $buffer; */
692 sv_insert(name, 1, 1, buffer, 2);
697 CV * const cv = find_runcv(&unused);
701 if (!cv || !CvPADLIST(cv))
703 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
704 sv = *av_fetch(av, targ, FALSE);
705 /* SvLEN in a pad name is not to be trusted */
706 sv_setpv(name, SvPV_nolen_const(sv));
709 if (subscript_type == FUV_SUBSCRIPT_HASH) {
710 SV * const sv = NEWSV(0,0);
712 Perl_sv_catpvf(aTHX_ name, "{%s}",
713 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
716 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
718 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
720 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
721 sv_insert(name, 0, 0, "within ", 7);
728 =for apidoc find_uninit_var
730 Find the name of the undefined variable (if any) that caused the operator o
731 to issue a "Use of uninitialized value" warning.
732 If match is true, only return a name if it's value matches uninit_sv.
733 So roughly speaking, if a unary operator (such as OP_COS) generates a
734 warning, then following the direct child of the op may yield an
735 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
736 other hand, with OP_ADD there are two branches to follow, so we only print
737 the variable name if we get an exact match.
739 The name is returned as a mortal SV.
741 Assumes that PL_op is the op that originally triggered the error, and that
742 PL_comppad/PL_curpad points to the currently executing pad.
748 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
756 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
757 uninit_sv == &PL_sv_placeholder)))
760 switch (obase->op_type) {
767 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
768 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
771 int subscript_type = FUV_SUBSCRIPT_WITHIN;
773 if (pad) { /* @lex, %lex */
774 sv = PAD_SVl(obase->op_targ);
778 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
779 /* @global, %global */
780 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
783 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
785 else /* @{expr}, %{expr} */
786 return find_uninit_var(cUNOPx(obase)->op_first,
790 /* attempt to find a match within the aggregate */
792 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
794 subscript_type = FUV_SUBSCRIPT_HASH;
797 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
799 subscript_type = FUV_SUBSCRIPT_ARRAY;
802 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
805 return varname(gv, hash ? '%' : '@', obase->op_targ,
806 keysv, index, subscript_type);
810 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
812 return varname(Nullgv, '$', obase->op_targ,
813 Nullsv, 0, FUV_SUBSCRIPT_NONE);
816 gv = cGVOPx_gv(obase);
817 if (!gv || (match && GvSV(gv) != uninit_sv))
819 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
822 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
825 av = (AV*)PAD_SV(obase->op_targ);
826 if (!av || SvRMAGICAL(av))
828 svp = av_fetch(av, (I32)obase->op_private, FALSE);
829 if (!svp || *svp != uninit_sv)
832 return varname(Nullgv, '$', obase->op_targ,
833 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
836 gv = cGVOPx_gv(obase);
842 if (!av || SvRMAGICAL(av))
844 svp = av_fetch(av, (I32)obase->op_private, FALSE);
845 if (!svp || *svp != uninit_sv)
848 return varname(gv, '$', 0,
849 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
854 o = cUNOPx(obase)->op_first;
855 if (!o || o->op_type != OP_NULL ||
856 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
858 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
863 /* $a[uninit_expr] or $h{uninit_expr} */
864 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
867 o = cBINOPx(obase)->op_first;
868 kid = cBINOPx(obase)->op_last;
870 /* get the av or hv, and optionally the gv */
872 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
873 sv = PAD_SV(o->op_targ);
875 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
876 && cUNOPo->op_first->op_type == OP_GV)
878 gv = cGVOPx_gv(cUNOPo->op_first);
881 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
886 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
887 /* index is constant */
891 if (obase->op_type == OP_HELEM) {
892 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
893 if (!he || HeVAL(he) != uninit_sv)
897 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
898 if (!svp || *svp != uninit_sv)
902 if (obase->op_type == OP_HELEM)
903 return varname(gv, '%', o->op_targ,
904 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
906 return varname(gv, '@', o->op_targ, Nullsv,
907 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
911 /* index is an expression;
912 * attempt to find a match within the aggregate */
913 if (obase->op_type == OP_HELEM) {
914 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
916 return varname(gv, '%', o->op_targ,
917 keysv, 0, FUV_SUBSCRIPT_HASH);
920 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
922 return varname(gv, '@', o->op_targ,
923 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
928 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
930 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
936 /* only examine RHS */
937 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
940 o = cUNOPx(obase)->op_first;
941 if (o->op_type == OP_PUSHMARK)
944 if (!o->op_sibling) {
945 /* one-arg version of open is highly magical */
947 if (o->op_type == OP_GV) { /* open FOO; */
949 if (match && GvSV(gv) != uninit_sv)
951 return varname(gv, '$', 0,
952 Nullsv, 0, FUV_SUBSCRIPT_NONE);
954 /* other possibilities not handled are:
955 * open $x; or open my $x; should return '${*$x}'
956 * open expr; should return '$'.expr ideally
962 /* ops where $_ may be an implicit arg */
966 if ( !(obase->op_flags & OPf_STACKED)) {
967 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
968 ? PAD_SVl(obase->op_targ)
972 sv_setpvn(sv, "$_", 2);
980 /* skip filehandle as it can't produce 'undef' warning */
981 o = cUNOPx(obase)->op_first;
982 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
983 o = o->op_sibling->op_sibling;
990 match = 1; /* XS or custom code could trigger random warnings */
995 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
996 return sv_2mortal(newSVpvn("${$/}", 5));
1001 if (!(obase->op_flags & OPf_KIDS))
1003 o = cUNOPx(obase)->op_first;
1009 /* if all except one arg are constant, or have no side-effects,
1010 * or are optimized away, then it's unambiguous */
1012 for (kid=o; kid; kid = kid->op_sibling) {
1014 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1015 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1016 || (kid->op_type == OP_PUSHMARK)
1020 if (o2) { /* more than one found */
1027 return find_uninit_var(o2, uninit_sv, match);
1031 sv = find_uninit_var(o, uninit_sv, 1);
1043 =for apidoc report_uninit
1045 Print appropriate "Use of uninitialized variable" warning
1051 Perl_report_uninit(pTHX_ SV* uninit_sv)
1054 SV* varname = Nullsv;
1056 varname = find_uninit_var(PL_op, uninit_sv,0);
1058 sv_insert(varname, 0, 0, " ", 1);
1060 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1061 varname ? SvPV_nolen_const(varname) : "",
1062 " in ", OP_DESC(PL_op));
1065 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1070 S_more_bodies (pTHX_ void **arena_root, void **root, size_t size)
1074 const size_t count = PERL_ARENA_SIZE/size;
1075 Newx(start, count*size, char);
1076 *((void **) start) = *arena_root;
1077 *arena_root = (void *)start;
1079 end = start + (count-1) * size;
1081 /* The initial slot is used to link the arenas together, so it isn't to be
1082 linked into the list of ready-to-use bodies. */
1086 *root = (void *)start;
1088 while (start < end) {
1089 char * const next = start + size;
1090 *(void**) start = (void *)next;
1093 *(void **)start = 0;
1098 /* grab a new thing from the free list, allocating more if necessary */
1100 /* 1st, the inline version */
1102 #define new_body_inline(xpv, arena_root, root, size) \
1105 xpv = *((void **)(root)) \
1106 ? *((void **)(root)) : S_more_bodies(aTHX_ arena_root, root, size); \
1107 *(root) = *(void**)(xpv); \
1111 /* now use the inline version in the proper function */
1114 S_new_body(pTHX_ void **arena_root, void **root, size_t size)
1117 new_body_inline(xpv, arena_root, root, size);
1121 /* return a thing to the free list */
1123 #define del_body(thing, root) \
1125 void **thing_copy = (void **)thing; \
1127 *thing_copy = *root; \
1128 *root = (void*)thing_copy; \
1132 /* Conventionally we simply malloc() a big block of memory, then divide it
1133 up into lots of the thing that we're allocating.
1135 This macro will expand to call to S_new_body. So for XPVBM (with ithreads),
1138 S_new_body(my_perl, (void**)&(my_perl->Ixpvbm_arenaroot),
1139 (void**)&(my_perl->Ixpvbm_root), sizeof(XPVBM), 0)
1142 #define new_body_type(TYPE,lctype) \
1143 S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1144 (void**)&PL_ ## lctype ## _root, \
1147 #define del_body_type(p,TYPE,lctype) \
1148 del_body((void*)p, (void**)&PL_ ## lctype ## _root)
1150 /* But for some types, we cheat. The type starts with some members that are
1151 never accessed. So we allocate the substructure, starting at the first used
1152 member, then adjust the pointer back in memory by the size of the bit not
1153 allocated, so it's as if we allocated the full structure.
1154 (But things will all go boom if you write to the part that is "not there",
1155 because you'll be overwriting the last members of the preceding structure
1158 We calculate the correction using the STRUCT_OFFSET macro. For example, if
1159 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
1160 and the pointer is unchanged. If the allocated structure is smaller (no
1161 initial NV actually allocated) then the net effect is to subtract the size
1162 of the NV from the pointer, to return a new pointer as if an initial NV were
1165 This is the same trick as was used for NV and IV bodies. Ironically it
1166 doesn't need to be used for NV bodies any more, because NV is now at the
1167 start of the structure. IV bodies don't need it either, because they are
1168 no longer allocated. */
1170 #define new_body_allocated(TYPE,lctype,member) \
1171 (void*)((char*)S_new_body(aTHX_ (void**)&PL_ ## lctype ## _arenaroot, \
1172 (void**)&PL_ ## lctype ## _root, \
1173 sizeof(lctype ## _allocated)) - \
1174 STRUCT_OFFSET(TYPE, member) \
1175 + STRUCT_OFFSET(lctype ## _allocated, member))
1178 #define del_body_allocated(p,TYPE,lctype,member) \
1179 del_body((void*)((char*)p + STRUCT_OFFSET(TYPE, member) \
1180 - STRUCT_OFFSET(lctype ## _allocated, member)), \
1181 (void**)&PL_ ## lctype ## _root)
1183 #define my_safemalloc(s) (void*)safemalloc(s)
1184 #define my_safefree(p) safefree((char*)p)
1188 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1189 #define del_XNV(p) my_safefree(p)
1191 #define new_XPV() my_safemalloc(sizeof(XPV))
1192 #define del_XPV(p) my_safefree(p)
1194 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1195 #define del_XPVIV(p) my_safefree(p)
1197 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1198 #define del_XPVNV(p) my_safefree(p)
1200 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1201 #define del_XPVCV(p) my_safefree(p)
1203 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1204 #define del_XPVAV(p) my_safefree(p)
1206 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1207 #define del_XPVHV(p) my_safefree(p)
1209 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1210 #define del_XPVMG(p) my_safefree(p)
1212 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1213 #define del_XPVGV(p) my_safefree(p)
1215 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1216 #define del_XPVLV(p) my_safefree(p)
1218 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1219 #define del_XPVBM(p) my_safefree(p)
1223 #define new_XNV() new_body_type(NV, xnv)
1224 #define del_XNV(p) del_body_type(p, NV, xnv)
1226 #define new_XPV() new_body_allocated(XPV, xpv, xpv_cur)
1227 #define del_XPV(p) del_body_allocated(p, XPV, xpv, xpv_cur)
1229 #define new_XPVIV() new_body_allocated(XPVIV, xpviv, xpv_cur)
1230 #define del_XPVIV(p) del_body_allocated(p, XPVIV, xpviv, xpv_cur)
1232 #define new_XPVNV() new_body_type(XPVNV, xpvnv)
1233 #define del_XPVNV(p) del_body_type(p, XPVNV, xpvnv)
1235 #define new_XPVCV() new_body_type(XPVCV, xpvcv)
1236 #define del_XPVCV(p) del_body_type(p, XPVCV, xpvcv)
1238 #define new_XPVAV() new_body_allocated(XPVAV, xpvav, xav_fill)
1239 #define del_XPVAV(p) del_body_allocated(p, XPVAV, xpvav, xav_fill)
1241 #define new_XPVHV() new_body_allocated(XPVHV, xpvhv, xhv_fill)
1242 #define del_XPVHV(p) del_body_allocated(p, XPVHV, xpvhv, xhv_fill)
1244 #define new_XPVMG() new_body_type(XPVMG, xpvmg)
1245 #define del_XPVMG(p) del_body_type(p, XPVMG, xpvmg)
1247 #define new_XPVGV() new_body_type(XPVGV, xpvgv)
1248 #define del_XPVGV(p) del_body_type(p, XPVGV, xpvgv)
1250 #define new_XPVLV() new_body_type(XPVLV, xpvlv)
1251 #define del_XPVLV(p) del_body_type(p, XPVLV, xpvlv)
1253 #define new_XPVBM() new_body_type(XPVBM, xpvbm)
1254 #define del_XPVBM(p) del_body_type(p, XPVBM, xpvbm)
1258 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1259 #define del_XPVFM(p) my_safefree(p)
1261 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1262 #define del_XPVIO(p) my_safefree(p)
1265 =for apidoc sv_upgrade
1267 Upgrade an SV to a more complex form. Generally adds a new body type to the
1268 SV, then copies across as much information as possible from the old body.
1269 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1275 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1277 void** old_body_arena;
1278 size_t old_body_offset;
1279 size_t old_body_length; /* Well, the length to copy. */
1281 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1282 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1284 bool zero_nv = TRUE;
1287 size_t new_body_length;
1288 size_t new_body_offset;
1289 void** new_body_arena;
1290 void** new_body_arenaroot;
1291 const U32 old_type = SvTYPE(sv);
1293 if (mt != SVt_PV && SvIsCOW(sv)) {
1294 sv_force_normal_flags(sv, 0);
1297 if (SvTYPE(sv) == mt)
1300 if (SvTYPE(sv) > mt)
1301 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1302 (int)SvTYPE(sv), (int)mt);
1305 old_body = SvANY(sv);
1307 old_body_offset = 0;
1308 old_body_length = 0;
1309 new_body_offset = 0;
1310 new_body_length = ~0;
1312 /* Copying structures onto other structures that have been neatly zeroed
1313 has a subtle gotcha. Consider XPVMG
1315 +------+------+------+------+------+-------+-------+
1316 | NV | CUR | LEN | IV | MAGIC | STASH |
1317 +------+------+------+------+------+-------+-------+
1318 0 4 8 12 16 20 24 28
1320 where NVs are aligned to 8 bytes, so that sizeof that structure is
1321 actually 32 bytes long, with 4 bytes of padding at the end:
1323 +------+------+------+------+------+-------+-------+------+
1324 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1325 +------+------+------+------+------+-------+-------+------+
1326 0 4 8 12 16 20 24 28 32
1328 so what happens if you allocate memory for this structure:
1330 +------+------+------+------+------+-------+-------+------+------+...
1331 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1332 +------+------+------+------+------+-------+-------+------+------+...
1333 0 4 8 12 16 20 24 28 32 36
1335 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1336 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1337 started out as zero once, but it's quite possible that it isn't. So now,
1338 rather than a nicely zeroed GP, you have it pointing somewhere random.
1341 (In fact, GP ends up pointing at a previous GP structure, because the
1342 principle cause of the padding in XPVMG getting garbage is a copy of
1343 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1345 So we are careful and work out the size of used parts of all the
1348 switch (SvTYPE(sv)) {
1354 else if (mt < SVt_PVIV)
1356 old_body_offset = STRUCT_OFFSET(XPVIV, xiv_iv);
1357 old_body_length = sizeof(IV);
1360 old_body_arena = (void **) &PL_xnv_root;
1361 old_body_length = sizeof(NV);
1362 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1371 old_body_arena = (void **) &PL_xpv_root;
1372 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1373 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1374 old_body_length = STRUCT_OFFSET(XPV, xpv_len)
1375 + sizeof (((XPV*)SvANY(sv))->xpv_len)
1379 else if (mt == SVt_NV)
1383 old_body_arena = (void **) &PL_xpviv_root;
1384 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1385 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1386 old_body_length = STRUCT_OFFSET(XPVIV, xiv_u)
1387 + sizeof (((XPVIV*)SvANY(sv))->xiv_u)
1391 old_body_arena = (void **) &PL_xpvnv_root;
1392 old_body_length = STRUCT_OFFSET(XPVNV, xiv_u)
1393 + sizeof (((XPVNV*)SvANY(sv))->xiv_u);
1394 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1399 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1400 there's no way that it can be safely upgraded, because perl.c
1401 expects to Safefree(SvANY(PL_mess_sv)) */
1402 assert(sv != PL_mess_sv);
1403 /* This flag bit is used to mean other things in other scalar types.
1404 Given that it only has meaning inside the pad, it shouldn't be set
1405 on anything that can get upgraded. */
1406 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1407 old_body_arena = (void **) &PL_xpvmg_root;
1408 old_body_length = STRUCT_OFFSET(XPVMG, xmg_stash)
1409 + sizeof (((XPVMG*)SvANY(sv))->xmg_stash);
1410 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1415 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1418 SvFLAGS(sv) &= ~SVTYPEMASK;
1423 Perl_croak(aTHX_ "Can't upgrade to undef");
1425 assert(old_type == SVt_NULL);
1426 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1430 assert(old_type == SVt_NULL);
1431 SvANY(sv) = new_XNV();
1435 assert(old_type == SVt_NULL);
1436 SvANY(sv) = &sv->sv_u.svu_rv;
1440 SvANY(sv) = new_XPVHV();
1443 HvTOTALKEYS(sv) = 0;
1448 SvANY(sv) = new_XPVAV();
1455 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1456 The target created by newSVrv also is, and it can have magic.
1457 However, it never has SvPVX set.
1459 if (old_type >= SVt_RV) {
1460 assert(SvPVX_const(sv) == 0);
1463 /* Could put this in the else clause below, as PVMG must have SvPVX
1464 0 already (the assertion above) */
1465 SvPV_set(sv, (char*)0);
1467 if (old_type >= SVt_PVMG) {
1468 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1469 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1477 new_body = new_XPVIO();
1478 new_body_length = sizeof(XPVIO);
1481 new_body = new_XPVFM();
1482 new_body_length = sizeof(XPVFM);
1486 new_body_length = sizeof(XPVBM);
1487 new_body_arena = (void **) &PL_xpvbm_root;
1488 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
1491 new_body_length = sizeof(XPVGV);
1492 new_body_arena = (void **) &PL_xpvgv_root;
1493 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
1496 new_body_length = sizeof(XPVCV);
1497 new_body_arena = (void **) &PL_xpvcv_root;
1498 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
1501 new_body_length = sizeof(XPVLV);
1502 new_body_arena = (void **) &PL_xpvlv_root;
1503 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
1506 new_body_length = sizeof(XPVMG);
1507 new_body_arena = (void **) &PL_xpvmg_root;
1508 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
1511 new_body_length = sizeof(XPVNV);
1512 new_body_arena = (void **) &PL_xpvnv_root;
1513 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
1516 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
1517 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
1518 new_body_length = sizeof(XPVIV) - new_body_offset;
1519 new_body_arena = (void **) &PL_xpviv_root;
1520 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
1521 /* XXX Is this still needed? Was it ever needed? Surely as there is
1522 no route from NV to PVIV, NOK can never be true */
1526 goto new_body_no_NV;
1528 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
1529 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
1530 new_body_length = sizeof(XPV) - new_body_offset;
1531 new_body_arena = (void **) &PL_xpv_root;
1532 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
1534 /* PV and PVIV don't have an NV slot. */
1535 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1540 assert(new_body_length);
1542 /* This points to the start of the allocated area. */
1543 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
1546 /* We always allocated the full length item with PURIFY */
1547 new_body_length += new_body_offset;
1548 new_body_offset = 0;
1549 new_body = my_safemalloc(new_body_length);
1553 Zero(new_body, new_body_length, char);
1554 new_body = ((char *)new_body) - new_body_offset;
1555 SvANY(sv) = new_body;
1557 if (old_body_length) {
1558 Copy((char *)old_body + old_body_offset,
1559 (char *)new_body + old_body_offset,
1560 old_body_length, char);
1563 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1569 IoPAGE_LEN(sv) = 60;
1570 if (old_type < SVt_RV)
1574 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", mt);
1578 if (old_body_arena) {
1580 my_safefree(old_body);
1582 del_body((void*)((char*)old_body + old_body_offset),
1589 =for apidoc sv_backoff
1591 Remove any string offset. You should normally use the C<SvOOK_off> macro
1598 Perl_sv_backoff(pTHX_ register SV *sv)
1601 assert(SvTYPE(sv) != SVt_PVHV);
1602 assert(SvTYPE(sv) != SVt_PVAV);
1604 const char * const s = SvPVX_const(sv);
1605 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1606 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1608 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1610 SvFLAGS(sv) &= ~SVf_OOK;
1617 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1618 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1619 Use the C<SvGROW> wrapper instead.
1625 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1629 #ifdef HAS_64K_LIMIT
1630 if (newlen >= 0x10000) {
1631 PerlIO_printf(Perl_debug_log,
1632 "Allocation too large: %"UVxf"\n", (UV)newlen);
1635 #endif /* HAS_64K_LIMIT */
1638 if (SvTYPE(sv) < SVt_PV) {
1639 sv_upgrade(sv, SVt_PV);
1640 s = SvPVX_mutable(sv);
1642 else if (SvOOK(sv)) { /* pv is offset? */
1644 s = SvPVX_mutable(sv);
1645 if (newlen > SvLEN(sv))
1646 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1647 #ifdef HAS_64K_LIMIT
1648 if (newlen >= 0x10000)
1653 s = SvPVX_mutable(sv);
1655 if (newlen > SvLEN(sv)) { /* need more room? */
1656 newlen = PERL_STRLEN_ROUNDUP(newlen);
1657 if (SvLEN(sv) && s) {
1659 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1665 s = saferealloc(s, newlen);
1668 s = safemalloc(newlen);
1669 if (SvPVX_const(sv) && SvCUR(sv)) {
1670 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1674 SvLEN_set(sv, newlen);
1680 =for apidoc sv_setiv
1682 Copies an integer into the given SV, upgrading first if necessary.
1683 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1689 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1691 SV_CHECK_THINKFIRST_COW_DROP(sv);
1692 switch (SvTYPE(sv)) {
1694 sv_upgrade(sv, SVt_IV);
1697 sv_upgrade(sv, SVt_PVNV);
1701 sv_upgrade(sv, SVt_PVIV);
1710 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1713 (void)SvIOK_only(sv); /* validate number */
1719 =for apidoc sv_setiv_mg
1721 Like C<sv_setiv>, but also handles 'set' magic.
1727 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1734 =for apidoc sv_setuv
1736 Copies an unsigned integer into the given SV, upgrading first if necessary.
1737 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1743 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1745 /* With these two if statements:
1746 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1749 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1751 If you wish to remove them, please benchmark to see what the effect is
1753 if (u <= (UV)IV_MAX) {
1754 sv_setiv(sv, (IV)u);
1763 =for apidoc sv_setuv_mg
1765 Like C<sv_setuv>, but also handles 'set' magic.
1771 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1780 =for apidoc sv_setnv
1782 Copies a double into the given SV, upgrading first if necessary.
1783 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1789 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1791 SV_CHECK_THINKFIRST_COW_DROP(sv);
1792 switch (SvTYPE(sv)) {
1795 sv_upgrade(sv, SVt_NV);
1800 sv_upgrade(sv, SVt_PVNV);
1809 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1813 (void)SvNOK_only(sv); /* validate number */
1818 =for apidoc sv_setnv_mg
1820 Like C<sv_setnv>, but also handles 'set' magic.
1826 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1832 /* Print an "isn't numeric" warning, using a cleaned-up,
1833 * printable version of the offending string
1837 S_not_a_number(pTHX_ SV *sv)
1844 dsv = sv_2mortal(newSVpvn("", 0));
1845 pv = sv_uni_display(dsv, sv, 10, 0);
1848 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1849 /* each *s can expand to 4 chars + "...\0",
1850 i.e. need room for 8 chars */
1852 const char *s, *end;
1853 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1856 if (ch & 128 && !isPRINT_LC(ch)) {
1865 else if (ch == '\r') {
1869 else if (ch == '\f') {
1873 else if (ch == '\\') {
1877 else if (ch == '\0') {
1881 else if (isPRINT_LC(ch))
1898 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1899 "Argument \"%s\" isn't numeric in %s", pv,
1902 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1903 "Argument \"%s\" isn't numeric", pv);
1907 =for apidoc looks_like_number
1909 Test if the content of an SV looks like a number (or is a number).
1910 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1911 non-numeric warning), even if your atof() doesn't grok them.
1917 Perl_looks_like_number(pTHX_ SV *sv)
1919 register const char *sbegin;
1923 sbegin = SvPVX_const(sv);
1926 else if (SvPOKp(sv))
1927 sbegin = SvPV_const(sv, len);
1929 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1930 return grok_number(sbegin, len, NULL);
1933 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1934 until proven guilty, assume that things are not that bad... */
1939 As 64 bit platforms often have an NV that doesn't preserve all bits of
1940 an IV (an assumption perl has been based on to date) it becomes necessary
1941 to remove the assumption that the NV always carries enough precision to
1942 recreate the IV whenever needed, and that the NV is the canonical form.
1943 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1944 precision as a side effect of conversion (which would lead to insanity
1945 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1946 1) to distinguish between IV/UV/NV slots that have cached a valid
1947 conversion where precision was lost and IV/UV/NV slots that have a
1948 valid conversion which has lost no precision
1949 2) to ensure that if a numeric conversion to one form is requested that
1950 would lose precision, the precise conversion (or differently
1951 imprecise conversion) is also performed and cached, to prevent
1952 requests for different numeric formats on the same SV causing
1953 lossy conversion chains. (lossless conversion chains are perfectly
1958 SvIOKp is true if the IV slot contains a valid value
1959 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1960 SvNOKp is true if the NV slot contains a valid value
1961 SvNOK is true only if the NV value is accurate
1964 while converting from PV to NV, check to see if converting that NV to an
1965 IV(or UV) would lose accuracy over a direct conversion from PV to
1966 IV(or UV). If it would, cache both conversions, return NV, but mark
1967 SV as IOK NOKp (ie not NOK).
1969 While converting from PV to IV, check to see if converting that IV to an
1970 NV would lose accuracy over a direct conversion from PV to NV. If it
1971 would, cache both conversions, flag similarly.
1973 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1974 correctly because if IV & NV were set NV *always* overruled.
1975 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1976 changes - now IV and NV together means that the two are interchangeable:
1977 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1979 The benefit of this is that operations such as pp_add know that if
1980 SvIOK is true for both left and right operands, then integer addition
1981 can be used instead of floating point (for cases where the result won't
1982 overflow). Before, floating point was always used, which could lead to
1983 loss of precision compared with integer addition.
1985 * making IV and NV equal status should make maths accurate on 64 bit
1987 * may speed up maths somewhat if pp_add and friends start to use
1988 integers when possible instead of fp. (Hopefully the overhead in
1989 looking for SvIOK and checking for overflow will not outweigh the
1990 fp to integer speedup)
1991 * will slow down integer operations (callers of SvIV) on "inaccurate"
1992 values, as the change from SvIOK to SvIOKp will cause a call into
1993 sv_2iv each time rather than a macro access direct to the IV slot
1994 * should speed up number->string conversion on integers as IV is
1995 favoured when IV and NV are equally accurate
1997 ####################################################################
1998 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1999 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2000 On the other hand, SvUOK is true iff UV.
2001 ####################################################################
2003 Your mileage will vary depending your CPU's relative fp to integer
2007 #ifndef NV_PRESERVES_UV
2008 # define IS_NUMBER_UNDERFLOW_IV 1
2009 # define IS_NUMBER_UNDERFLOW_UV 2
2010 # define IS_NUMBER_IV_AND_UV 2
2011 # define IS_NUMBER_OVERFLOW_IV 4
2012 # define IS_NUMBER_OVERFLOW_UV 5
2014 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2016 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2018 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2020 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));
2021 if (SvNVX(sv) < (NV)IV_MIN) {
2022 (void)SvIOKp_on(sv);
2024 SvIV_set(sv, IV_MIN);
2025 return IS_NUMBER_UNDERFLOW_IV;
2027 if (SvNVX(sv) > (NV)UV_MAX) {
2028 (void)SvIOKp_on(sv);
2031 SvUV_set(sv, UV_MAX);
2032 return IS_NUMBER_OVERFLOW_UV;
2034 (void)SvIOKp_on(sv);
2036 /* Can't use strtol etc to convert this string. (See truth table in
2038 if (SvNVX(sv) <= (UV)IV_MAX) {
2039 SvIV_set(sv, I_V(SvNVX(sv)));
2040 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2041 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2043 /* Integer is imprecise. NOK, IOKp */
2045 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2048 SvUV_set(sv, U_V(SvNVX(sv)));
2049 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2050 if (SvUVX(sv) == UV_MAX) {
2051 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2052 possibly be preserved by NV. Hence, it must be overflow.
2054 return IS_NUMBER_OVERFLOW_UV;
2056 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2058 /* Integer is imprecise. NOK, IOKp */
2060 return IS_NUMBER_OVERFLOW_IV;
2062 #endif /* !NV_PRESERVES_UV*/
2065 =for apidoc sv_2iv_flags
2067 Return the integer value of an SV, doing any necessary string
2068 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2069 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2075 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2079 if (SvGMAGICAL(sv)) {
2080 if (flags & SV_GMAGIC)
2085 return I_V(SvNVX(sv));
2087 if (SvPOKp(sv) && SvLEN(sv))
2090 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2091 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2097 if (SvTHINKFIRST(sv)) {
2100 SV * const tmpstr=AMG_CALLun(sv,numer);
2101 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2102 return SvIV(tmpstr);
2105 return PTR2IV(SvRV(sv));
2108 sv_force_normal_flags(sv, 0);
2110 if (SvREADONLY(sv) && !SvOK(sv)) {
2111 if (ckWARN(WARN_UNINITIALIZED))
2118 return (IV)(SvUVX(sv));
2125 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2126 * without also getting a cached IV/UV from it at the same time
2127 * (ie PV->NV conversion should detect loss of accuracy and cache
2128 * IV or UV at same time to avoid this. NWC */
2130 if (SvTYPE(sv) == SVt_NV)
2131 sv_upgrade(sv, SVt_PVNV);
2133 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2134 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2135 certainly cast into the IV range at IV_MAX, whereas the correct
2136 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2138 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2139 SvIV_set(sv, I_V(SvNVX(sv)));
2140 if (SvNVX(sv) == (NV) SvIVX(sv)
2141 #ifndef NV_PRESERVES_UV
2142 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2143 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2144 /* Don't flag it as "accurately an integer" if the number
2145 came from a (by definition imprecise) NV operation, and
2146 we're outside the range of NV integer precision */
2149 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2150 DEBUG_c(PerlIO_printf(Perl_debug_log,
2151 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2157 /* IV not precise. No need to convert from PV, as NV
2158 conversion would already have cached IV if it detected
2159 that PV->IV would be better than PV->NV->IV
2160 flags already correct - don't set public IOK. */
2161 DEBUG_c(PerlIO_printf(Perl_debug_log,
2162 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2167 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2168 but the cast (NV)IV_MIN rounds to a the value less (more
2169 negative) than IV_MIN which happens to be equal to SvNVX ??
2170 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2171 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2172 (NV)UVX == NVX are both true, but the values differ. :-(
2173 Hopefully for 2s complement IV_MIN is something like
2174 0x8000000000000000 which will be exact. NWC */
2177 SvUV_set(sv, U_V(SvNVX(sv)));
2179 (SvNVX(sv) == (NV) SvUVX(sv))
2180 #ifndef NV_PRESERVES_UV
2181 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2182 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2183 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2184 /* Don't flag it as "accurately an integer" if the number
2185 came from a (by definition imprecise) NV operation, and
2186 we're outside the range of NV integer precision */
2192 DEBUG_c(PerlIO_printf(Perl_debug_log,
2193 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2197 return (IV)SvUVX(sv);
2200 else if (SvPOKp(sv) && SvLEN(sv)) {
2202 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2203 /* We want to avoid a possible problem when we cache an IV which
2204 may be later translated to an NV, and the resulting NV is not
2205 the same as the direct translation of the initial string
2206 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2207 be careful to ensure that the value with the .456 is around if the
2208 NV value is requested in the future).
2210 This means that if we cache such an IV, we need to cache the
2211 NV as well. Moreover, we trade speed for space, and do not
2212 cache the NV if we are sure it's not needed.
2215 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2216 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2217 == IS_NUMBER_IN_UV) {
2218 /* It's definitely an integer, only upgrade to PVIV */
2219 if (SvTYPE(sv) < SVt_PVIV)
2220 sv_upgrade(sv, SVt_PVIV);
2222 } else if (SvTYPE(sv) < SVt_PVNV)
2223 sv_upgrade(sv, SVt_PVNV);
2225 /* If NV preserves UV then we only use the UV value if we know that
2226 we aren't going to call atof() below. If NVs don't preserve UVs
2227 then the value returned may have more precision than atof() will
2228 return, even though value isn't perfectly accurate. */
2229 if ((numtype & (IS_NUMBER_IN_UV
2230 #ifdef NV_PRESERVES_UV
2233 )) == IS_NUMBER_IN_UV) {
2234 /* This won't turn off the public IOK flag if it was set above */
2235 (void)SvIOKp_on(sv);
2237 if (!(numtype & IS_NUMBER_NEG)) {
2239 if (value <= (UV)IV_MAX) {
2240 SvIV_set(sv, (IV)value);
2242 SvUV_set(sv, value);
2246 /* 2s complement assumption */
2247 if (value <= (UV)IV_MIN) {
2248 SvIV_set(sv, -(IV)value);
2250 /* Too negative for an IV. This is a double upgrade, but
2251 I'm assuming it will be rare. */
2252 if (SvTYPE(sv) < SVt_PVNV)
2253 sv_upgrade(sv, SVt_PVNV);
2257 SvNV_set(sv, -(NV)value);
2258 SvIV_set(sv, IV_MIN);
2262 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2263 will be in the previous block to set the IV slot, and the next
2264 block to set the NV slot. So no else here. */
2266 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2267 != IS_NUMBER_IN_UV) {
2268 /* It wasn't an (integer that doesn't overflow the UV). */
2269 SvNV_set(sv, Atof(SvPVX_const(sv)));
2271 if (! numtype && ckWARN(WARN_NUMERIC))
2274 #if defined(USE_LONG_DOUBLE)
2275 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2276 PTR2UV(sv), SvNVX(sv)));
2278 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2279 PTR2UV(sv), SvNVX(sv)));
2283 #ifdef NV_PRESERVES_UV
2284 (void)SvIOKp_on(sv);
2286 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2287 SvIV_set(sv, I_V(SvNVX(sv)));
2288 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2291 /* Integer is imprecise. NOK, IOKp */
2293 /* UV will not work better than IV */
2295 if (SvNVX(sv) > (NV)UV_MAX) {
2297 /* Integer is inaccurate. NOK, IOKp, is UV */
2298 SvUV_set(sv, UV_MAX);
2301 SvUV_set(sv, U_V(SvNVX(sv)));
2302 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2303 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2307 /* Integer is imprecise. NOK, IOKp, is UV */
2313 #else /* NV_PRESERVES_UV */
2314 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2315 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2316 /* The IV slot will have been set from value returned by
2317 grok_number above. The NV slot has just been set using
2320 assert (SvIOKp(sv));
2322 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2323 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2324 /* Small enough to preserve all bits. */
2325 (void)SvIOKp_on(sv);
2327 SvIV_set(sv, I_V(SvNVX(sv)));
2328 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2330 /* Assumption: first non-preserved integer is < IV_MAX,
2331 this NV is in the preserved range, therefore: */
2332 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2334 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);
2338 0 0 already failed to read UV.
2339 0 1 already failed to read UV.
2340 1 0 you won't get here in this case. IV/UV
2341 slot set, public IOK, Atof() unneeded.
2342 1 1 already read UV.
2343 so there's no point in sv_2iuv_non_preserve() attempting
2344 to use atol, strtol, strtoul etc. */
2345 if (sv_2iuv_non_preserve (sv, numtype)
2346 >= IS_NUMBER_OVERFLOW_IV)
2350 #endif /* NV_PRESERVES_UV */
2353 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2355 if (SvTYPE(sv) < SVt_IV)
2356 /* Typically the caller expects that sv_any is not NULL now. */
2357 sv_upgrade(sv, SVt_IV);
2360 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2361 PTR2UV(sv),SvIVX(sv)));
2362 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2366 =for apidoc sv_2uv_flags
2368 Return the unsigned integer value of an SV, doing any necessary string
2369 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2370 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2376 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2380 if (SvGMAGICAL(sv)) {
2381 if (flags & SV_GMAGIC)
2386 return U_V(SvNVX(sv));
2387 if (SvPOKp(sv) && SvLEN(sv))
2390 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2391 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2397 if (SvTHINKFIRST(sv)) {
2400 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2401 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2402 return SvUV(tmpstr);
2403 return PTR2UV(SvRV(sv));
2406 sv_force_normal_flags(sv, 0);
2408 if (SvREADONLY(sv) && !SvOK(sv)) {
2409 if (ckWARN(WARN_UNINITIALIZED))
2419 return (UV)SvIVX(sv);
2423 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2424 * without also getting a cached IV/UV from it at the same time
2425 * (ie PV->NV conversion should detect loss of accuracy and cache
2426 * IV or UV at same time to avoid this. */
2427 /* IV-over-UV optimisation - choose to cache IV if possible */
2429 if (SvTYPE(sv) == SVt_NV)
2430 sv_upgrade(sv, SVt_PVNV);
2432 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2433 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2434 SvIV_set(sv, I_V(SvNVX(sv)));
2435 if (SvNVX(sv) == (NV) SvIVX(sv)
2436 #ifndef NV_PRESERVES_UV
2437 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2438 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2439 /* Don't flag it as "accurately an integer" if the number
2440 came from a (by definition imprecise) NV operation, and
2441 we're outside the range of NV integer precision */
2444 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2445 DEBUG_c(PerlIO_printf(Perl_debug_log,
2446 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2452 /* IV not precise. No need to convert from PV, as NV
2453 conversion would already have cached IV if it detected
2454 that PV->IV would be better than PV->NV->IV
2455 flags already correct - don't set public IOK. */
2456 DEBUG_c(PerlIO_printf(Perl_debug_log,
2457 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2462 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2463 but the cast (NV)IV_MIN rounds to a the value less (more
2464 negative) than IV_MIN which happens to be equal to SvNVX ??
2465 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2466 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2467 (NV)UVX == NVX are both true, but the values differ. :-(
2468 Hopefully for 2s complement IV_MIN is something like
2469 0x8000000000000000 which will be exact. NWC */
2472 SvUV_set(sv, U_V(SvNVX(sv)));
2474 (SvNVX(sv) == (NV) SvUVX(sv))
2475 #ifndef NV_PRESERVES_UV
2476 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2477 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2478 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2479 /* Don't flag it as "accurately an integer" if the number
2480 came from a (by definition imprecise) NV operation, and
2481 we're outside the range of NV integer precision */
2486 DEBUG_c(PerlIO_printf(Perl_debug_log,
2487 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2493 else if (SvPOKp(sv) && SvLEN(sv)) {
2495 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2497 /* We want to avoid a possible problem when we cache a UV which
2498 may be later translated to an NV, and the resulting NV is not
2499 the translation of the initial data.
2501 This means that if we cache such a UV, we need to cache the
2502 NV as well. Moreover, we trade speed for space, and do not
2503 cache the NV if not needed.
2506 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2507 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2508 == IS_NUMBER_IN_UV) {
2509 /* It's definitely an integer, only upgrade to PVIV */
2510 if (SvTYPE(sv) < SVt_PVIV)
2511 sv_upgrade(sv, SVt_PVIV);
2513 } else if (SvTYPE(sv) < SVt_PVNV)
2514 sv_upgrade(sv, SVt_PVNV);
2516 /* If NV preserves UV then we only use the UV value if we know that
2517 we aren't going to call atof() below. If NVs don't preserve UVs
2518 then the value returned may have more precision than atof() will
2519 return, even though it isn't accurate. */
2520 if ((numtype & (IS_NUMBER_IN_UV
2521 #ifdef NV_PRESERVES_UV
2524 )) == IS_NUMBER_IN_UV) {
2525 /* This won't turn off the public IOK flag if it was set above */
2526 (void)SvIOKp_on(sv);
2528 if (!(numtype & IS_NUMBER_NEG)) {
2530 if (value <= (UV)IV_MAX) {
2531 SvIV_set(sv, (IV)value);
2533 /* it didn't overflow, and it was positive. */
2534 SvUV_set(sv, value);
2538 /* 2s complement assumption */
2539 if (value <= (UV)IV_MIN) {
2540 SvIV_set(sv, -(IV)value);
2542 /* Too negative for an IV. This is a double upgrade, but
2543 I'm assuming it will be rare. */
2544 if (SvTYPE(sv) < SVt_PVNV)
2545 sv_upgrade(sv, SVt_PVNV);
2549 SvNV_set(sv, -(NV)value);
2550 SvIV_set(sv, IV_MIN);
2555 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2556 != IS_NUMBER_IN_UV) {
2557 /* It wasn't an integer, or it overflowed the UV. */
2558 SvNV_set(sv, Atof(SvPVX_const(sv)));
2560 if (! numtype && ckWARN(WARN_NUMERIC))
2563 #if defined(USE_LONG_DOUBLE)
2564 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2565 PTR2UV(sv), SvNVX(sv)));
2567 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2568 PTR2UV(sv), SvNVX(sv)));
2571 #ifdef NV_PRESERVES_UV
2572 (void)SvIOKp_on(sv);
2574 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2575 SvIV_set(sv, I_V(SvNVX(sv)));
2576 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2579 /* Integer is imprecise. NOK, IOKp */
2581 /* UV will not work better than IV */
2583 if (SvNVX(sv) > (NV)UV_MAX) {
2585 /* Integer is inaccurate. NOK, IOKp, is UV */
2586 SvUV_set(sv, UV_MAX);
2589 SvUV_set(sv, U_V(SvNVX(sv)));
2590 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2591 NV preservse UV so can do correct comparison. */
2592 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2596 /* Integer is imprecise. NOK, IOKp, is UV */
2601 #else /* NV_PRESERVES_UV */
2602 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2603 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2604 /* The UV slot will have been set from value returned by
2605 grok_number above. The NV slot has just been set using
2608 assert (SvIOKp(sv));
2610 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2611 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2612 /* Small enough to preserve all bits. */
2613 (void)SvIOKp_on(sv);
2615 SvIV_set(sv, I_V(SvNVX(sv)));
2616 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2618 /* Assumption: first non-preserved integer is < IV_MAX,
2619 this NV is in the preserved range, therefore: */
2620 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2622 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);
2625 sv_2iuv_non_preserve (sv, numtype);
2627 #endif /* NV_PRESERVES_UV */
2631 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2632 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2635 if (SvTYPE(sv) < SVt_IV)
2636 /* Typically the caller expects that sv_any is not NULL now. */
2637 sv_upgrade(sv, SVt_IV);
2641 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2642 PTR2UV(sv),SvUVX(sv)));
2643 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2649 Return the num value of an SV, doing any necessary string or integer
2650 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2657 Perl_sv_2nv(pTHX_ register SV *sv)
2661 if (SvGMAGICAL(sv)) {
2665 if (SvPOKp(sv) && SvLEN(sv)) {
2666 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2667 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2669 return Atof(SvPVX_const(sv));
2673 return (NV)SvUVX(sv);
2675 return (NV)SvIVX(sv);
2678 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2679 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2685 if (SvTHINKFIRST(sv)) {
2688 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2689 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2690 return SvNV(tmpstr);
2691 return PTR2NV(SvRV(sv));
2694 sv_force_normal_flags(sv, 0);
2696 if (SvREADONLY(sv) && !SvOK(sv)) {
2697 if (ckWARN(WARN_UNINITIALIZED))
2702 if (SvTYPE(sv) < SVt_NV) {
2703 if (SvTYPE(sv) == SVt_IV)
2704 sv_upgrade(sv, SVt_PVNV);
2706 sv_upgrade(sv, SVt_NV);
2707 #ifdef USE_LONG_DOUBLE
2709 STORE_NUMERIC_LOCAL_SET_STANDARD();
2710 PerlIO_printf(Perl_debug_log,
2711 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2712 PTR2UV(sv), SvNVX(sv));
2713 RESTORE_NUMERIC_LOCAL();
2717 STORE_NUMERIC_LOCAL_SET_STANDARD();
2718 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2719 PTR2UV(sv), SvNVX(sv));
2720 RESTORE_NUMERIC_LOCAL();
2724 else if (SvTYPE(sv) < SVt_PVNV)
2725 sv_upgrade(sv, SVt_PVNV);
2730 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2731 #ifdef NV_PRESERVES_UV
2734 /* Only set the public NV OK flag if this NV preserves the IV */
2735 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2736 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2737 : (SvIVX(sv) == I_V(SvNVX(sv))))
2743 else if (SvPOKp(sv) && SvLEN(sv)) {
2745 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2746 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2748 #ifdef NV_PRESERVES_UV
2749 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2750 == IS_NUMBER_IN_UV) {
2751 /* It's definitely an integer */
2752 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2754 SvNV_set(sv, Atof(SvPVX_const(sv)));
2757 SvNV_set(sv, Atof(SvPVX_const(sv)));
2758 /* Only set the public NV OK flag if this NV preserves the value in
2759 the PV at least as well as an IV/UV would.
2760 Not sure how to do this 100% reliably. */
2761 /* if that shift count is out of range then Configure's test is
2762 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2764 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2765 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2766 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2767 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2768 /* Can't use strtol etc to convert this string, so don't try.
2769 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2772 /* value has been set. It may not be precise. */
2773 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2774 /* 2s complement assumption for (UV)IV_MIN */
2775 SvNOK_on(sv); /* Integer is too negative. */
2780 if (numtype & IS_NUMBER_NEG) {
2781 SvIV_set(sv, -(IV)value);
2782 } else if (value <= (UV)IV_MAX) {
2783 SvIV_set(sv, (IV)value);
2785 SvUV_set(sv, value);
2789 if (numtype & IS_NUMBER_NOT_INT) {
2790 /* I believe that even if the original PV had decimals,
2791 they are lost beyond the limit of the FP precision.
2792 However, neither is canonical, so both only get p
2793 flags. NWC, 2000/11/25 */
2794 /* Both already have p flags, so do nothing */
2796 const NV nv = SvNVX(sv);
2797 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2798 if (SvIVX(sv) == I_V(nv)) {
2803 /* It had no "." so it must be integer. */
2806 /* between IV_MAX and NV(UV_MAX).
2807 Could be slightly > UV_MAX */
2809 if (numtype & IS_NUMBER_NOT_INT) {
2810 /* UV and NV both imprecise. */
2812 const UV nv_as_uv = U_V(nv);
2814 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2825 #endif /* NV_PRESERVES_UV */
2828 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2830 if (SvTYPE(sv) < SVt_NV)
2831 /* Typically the caller expects that sv_any is not NULL now. */
2832 /* XXX Ilya implies that this is a bug in callers that assume this
2833 and ideally should be fixed. */
2834 sv_upgrade(sv, SVt_NV);
2837 #if defined(USE_LONG_DOUBLE)
2839 STORE_NUMERIC_LOCAL_SET_STANDARD();
2840 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2841 PTR2UV(sv), SvNVX(sv));
2842 RESTORE_NUMERIC_LOCAL();
2846 STORE_NUMERIC_LOCAL_SET_STANDARD();
2847 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2848 PTR2UV(sv), SvNVX(sv));
2849 RESTORE_NUMERIC_LOCAL();
2855 /* asIV(): extract an integer from the string value of an SV.
2856 * Caller must validate PVX */
2859 S_asIV(pTHX_ SV *sv)
2862 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2864 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2865 == IS_NUMBER_IN_UV) {
2866 /* It's definitely an integer */
2867 if (numtype & IS_NUMBER_NEG) {
2868 if (value < (UV)IV_MIN)
2871 if (value < (UV)IV_MAX)
2876 if (ckWARN(WARN_NUMERIC))
2879 return I_V(Atof(SvPVX_const(sv)));
2882 /* asUV(): extract an unsigned integer from the string value of an SV
2883 * Caller must validate PVX */
2886 S_asUV(pTHX_ SV *sv)
2889 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2891 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2892 == IS_NUMBER_IN_UV) {
2893 /* It's definitely an integer */
2894 if (!(numtype & IS_NUMBER_NEG))
2898 if (ckWARN(WARN_NUMERIC))
2901 return U_V(Atof(SvPVX_const(sv)));
2905 =for apidoc sv_2pv_nolen
2907 Like C<sv_2pv()>, but doesn't return the length too. You should usually
2908 use the macro wrapper C<SvPV_nolen(sv)> instead.
2913 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
2915 return sv_2pv(sv, 0);
2918 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2919 * UV as a string towards the end of buf, and return pointers to start and
2922 * We assume that buf is at least TYPE_CHARS(UV) long.
2926 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2928 char *ptr = buf + TYPE_CHARS(UV);
2929 char * const ebuf = ptr;
2942 *--ptr = '0' + (char)(uv % 10);
2951 =for apidoc sv_2pv_flags
2953 Returns a pointer to the string value of an SV, and sets *lp to its length.
2954 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2956 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2957 usually end up here too.
2963 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2968 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2969 char *tmpbuf = tbuf;
2976 if (SvGMAGICAL(sv)) {
2977 if (flags & SV_GMAGIC)
2982 if (flags & SV_MUTABLE_RETURN)
2983 return SvPVX_mutable(sv);
2984 if (flags & SV_CONST_RETURN)
2985 return (char *)SvPVX_const(sv);
2990 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2992 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2997 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3002 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3003 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
3011 if (SvTHINKFIRST(sv)) {
3014 register const char *typestr;
3015 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3016 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3018 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3021 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3022 if (flags & SV_CONST_RETURN) {
3023 pv = (char *) SvPVX_const(tmpstr);
3025 pv = (flags & SV_MUTABLE_RETURN)
3026 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3029 *lp = SvCUR(tmpstr);
3031 pv = sv_2pv_flags(tmpstr, lp, flags);
3042 typestr = "NULLREF";
3046 switch (SvTYPE(sv)) {
3048 if ( ((SvFLAGS(sv) &
3049 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3050 == (SVs_OBJECT|SVs_SMG))
3051 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3052 const regexp *re = (regexp *)mg->mg_obj;
3055 const char *fptr = "msix";
3060 char need_newline = 0;
3061 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3063 while((ch = *fptr++)) {
3065 reflags[left++] = ch;
3068 reflags[right--] = ch;
3073 reflags[left] = '-';
3077 mg->mg_len = re->prelen + 4 + left;
3079 * If /x was used, we have to worry about a regex
3080 * ending with a comment later being embedded
3081 * within another regex. If so, we don't want this
3082 * regex's "commentization" to leak out to the
3083 * right part of the enclosing regex, we must cap
3084 * it with a newline.
3086 * So, if /x was used, we scan backwards from the
3087 * end of the regex. If we find a '#' before we
3088 * find a newline, we need to add a newline
3089 * ourself. If we find a '\n' first (or if we
3090 * don't find '#' or '\n'), we don't need to add
3091 * anything. -jfriedl
3093 if (PMf_EXTENDED & re->reganch)
3095 const char *endptr = re->precomp + re->prelen;
3096 while (endptr >= re->precomp)
3098 const char c = *(endptr--);
3100 break; /* don't need another */
3102 /* we end while in a comment, so we
3104 mg->mg_len++; /* save space for it */
3105 need_newline = 1; /* note to add it */
3111 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3112 Copy("(?", mg->mg_ptr, 2, char);
3113 Copy(reflags, mg->mg_ptr+2, left, char);
3114 Copy(":", mg->mg_ptr+left+2, 1, char);
3115 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3117 mg->mg_ptr[mg->mg_len - 2] = '\n';
3118 mg->mg_ptr[mg->mg_len - 1] = ')';
3119 mg->mg_ptr[mg->mg_len] = 0;
3121 PL_reginterp_cnt += re->program[0].next_off;
3123 if (re->reganch & ROPT_UTF8)
3139 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3140 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3141 /* tied lvalues should appear to be
3142 * scalars for backwards compatitbility */
3143 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3144 ? "SCALAR" : "LVALUE"; break;
3145 case SVt_PVAV: typestr = "ARRAY"; break;
3146 case SVt_PVHV: typestr = "HASH"; break;
3147 case SVt_PVCV: typestr = "CODE"; break;
3148 case SVt_PVGV: typestr = "GLOB"; break;
3149 case SVt_PVFM: typestr = "FORMAT"; break;
3150 case SVt_PVIO: typestr = "IO"; break;
3151 default: typestr = "UNKNOWN"; break;
3155 const char *name = HvNAME_get(SvSTASH(sv));
3156 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3157 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3160 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3164 *lp = strlen(typestr);
3165 return (char *)typestr;
3167 if (SvREADONLY(sv) && !SvOK(sv)) {
3168 if (ckWARN(WARN_UNINITIALIZED))
3175 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3176 /* I'm assuming that if both IV and NV are equally valid then
3177 converting the IV is going to be more efficient */
3178 const U32 isIOK = SvIOK(sv);
3179 const U32 isUIOK = SvIsUV(sv);
3180 char buf[TYPE_CHARS(UV)];
3183 if (SvTYPE(sv) < SVt_PVIV)
3184 sv_upgrade(sv, SVt_PVIV);
3186 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3188 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3189 /* inlined from sv_setpvn */
3190 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3191 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3192 SvCUR_set(sv, ebuf - ptr);
3202 else if (SvNOKp(sv)) {
3203 if (SvTYPE(sv) < SVt_PVNV)
3204 sv_upgrade(sv, SVt_PVNV);
3205 /* The +20 is pure guesswork. Configure test needed. --jhi */
3206 s = SvGROW_mutable(sv, NV_DIG + 20);
3207 olderrno = errno; /* some Xenix systems wipe out errno here */
3209 if (SvNVX(sv) == 0.0)
3210 (void)strcpy(s,"0");
3214 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3217 #ifdef FIXNEGATIVEZERO
3218 if (*s == '-' && s[1] == '0' && !s[2])
3228 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3232 if (SvTYPE(sv) < SVt_PV)
3233 /* Typically the caller expects that sv_any is not NULL now. */
3234 sv_upgrade(sv, SVt_PV);
3238 const STRLEN len = s - SvPVX_const(sv);
3244 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3245 PTR2UV(sv),SvPVX_const(sv)));
3246 if (flags & SV_CONST_RETURN)
3247 return (char *)SvPVX_const(sv);
3248 if (flags & SV_MUTABLE_RETURN)
3249 return SvPVX_mutable(sv);
3253 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3254 /* Sneaky stuff here */
3258 tsv = newSVpv(tmpbuf, 0);
3271 t = SvPVX_const(tsv);
3276 len = strlen(tmpbuf);
3278 #ifdef FIXNEGATIVEZERO
3279 if (len == 2 && t[0] == '-' && t[1] == '0') {
3284 SvUPGRADE(sv, SVt_PV);
3287 s = SvGROW_mutable(sv, len + 1);
3290 return memcpy(s, t, len + 1);
3295 =for apidoc sv_copypv
3297 Copies a stringified representation of the source SV into the
3298 destination SV. Automatically performs any necessary mg_get and
3299 coercion of numeric values into strings. Guaranteed to preserve
3300 UTF-8 flag even from overloaded objects. Similar in nature to
3301 sv_2pv[_flags] but operates directly on an SV instead of just the
3302 string. Mostly uses sv_2pv_flags to do its work, except when that
3303 would lose the UTF-8'ness of the PV.
3309 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3312 const char * const s = SvPV_const(ssv,len);
3313 sv_setpvn(dsv,s,len);
3321 =for apidoc sv_2pvbyte_nolen
3323 Return a pointer to the byte-encoded representation of the SV.
3324 May cause the SV to be downgraded from UTF-8 as a side-effect.
3326 Usually accessed via the C<SvPVbyte_nolen> macro.
3332 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3334 return sv_2pvbyte(sv, 0);
3338 =for apidoc sv_2pvbyte
3340 Return a pointer to the byte-encoded representation of the SV, and set *lp
3341 to its length. May cause the SV to be downgraded from UTF-8 as a
3344 Usually accessed via the C<SvPVbyte> macro.
3350 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3352 sv_utf8_downgrade(sv,0);
3353 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3357 =for apidoc sv_2pvutf8_nolen
3359 Return a pointer to the UTF-8-encoded representation of the SV.
3360 May cause the SV to be upgraded to UTF-8 as a side-effect.
3362 Usually accessed via the C<SvPVutf8_nolen> macro.
3368 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3370 return sv_2pvutf8(sv, 0);
3374 * =for apidoc sv_2pvutf8
3376 * Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3377 * to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3379 * Usually accessed via the C<SvPVutf8> macro.
3385 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3387 sv_utf8_upgrade(sv);
3388 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3393 =for apidoc sv_2bool
3395 This function is only called on magical items, and is only used by
3396 sv_true() or its macro equivalent.
3402 Perl_sv_2bool(pTHX_ register SV *sv)
3410 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3411 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3412 return (bool)SvTRUE(tmpsv);
3413 return SvRV(sv) != 0;
3416 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3418 (*sv->sv_u.svu_pv > '0' ||
3419 Xpvtmp->xpv_cur > 1 ||
3420 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3427 return SvIVX(sv) != 0;
3430 return SvNVX(sv) != 0.0;
3438 =for apidoc sv_utf8_upgrade
3440 Converts the PV of an SV to its UTF-8-encoded form.
3441 Forces the SV to string form if it is not already.
3442 Always sets the SvUTF8 flag to avoid future validity checks even
3443 if all the bytes have hibit clear.
3445 This is not as a general purpose byte encoding to Unicode interface:
3446 use the Encode extension for that.
3448 =for apidoc sv_utf8_upgrade_flags
3450 Converts the PV of an SV to its UTF-8-encoded form.
3451 Forces the SV to string form if it is not already.
3452 Always sets the SvUTF8 flag to avoid future validity checks even
3453 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3454 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3455 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3457 This is not as a general purpose byte encoding to Unicode interface:
3458 use the Encode extension for that.
3464 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3466 if (sv == &PL_sv_undef)
3470 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3471 (void) sv_2pv_flags(sv,&len, flags);
3475 (void) SvPV_force(sv,len);
3484 sv_force_normal_flags(sv, 0);
3487 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3488 sv_recode_to_utf8(sv, PL_encoding);
3489 else { /* Assume Latin-1/EBCDIC */
3490 /* This function could be much more efficient if we
3491 * had a FLAG in SVs to signal if there are any hibit
3492 * chars in the PV. Given that there isn't such a flag
3493 * make the loop as fast as possible. */
3494 const U8 *s = (U8 *) SvPVX_const(sv);
3495 const U8 *e = (U8 *) SvEND(sv);
3501 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3505 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3506 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3508 SvPV_free(sv); /* No longer using what was there before. */
3510 SvPV_set(sv, (char*)recoded);
3511 SvCUR_set(sv, len - 1);
3512 SvLEN_set(sv, len); /* No longer know the real size. */
3514 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3521 =for apidoc sv_utf8_downgrade
3523 Attempts to convert the PV of an SV from characters to bytes.
3524 If the PV contains a character beyond byte, this conversion will fail;
3525 in this case, either returns false or, if C<fail_ok> is not
3528 This is not as a general purpose Unicode to byte encoding interface:
3529 use the Encode extension for that.
3535 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3537 if (SvPOKp(sv) && SvUTF8(sv)) {
3543 sv_force_normal_flags(sv, 0);
3545 s = (U8 *) SvPV(sv, len);
3546 if (!utf8_to_bytes(s, &len)) {
3551 Perl_croak(aTHX_ "Wide character in %s",
3554 Perl_croak(aTHX_ "Wide character");
3565 =for apidoc sv_utf8_encode
3567 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3568 flag off so that it looks like octets again.
3574 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3576 (void) sv_utf8_upgrade(sv);
3578 sv_force_normal_flags(sv, 0);
3580 if (SvREADONLY(sv)) {
3581 Perl_croak(aTHX_ PL_no_modify);
3587 =for apidoc sv_utf8_decode
3589 If the PV of the SV is an octet sequence in UTF-8
3590 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3591 so that it looks like a character. If the PV contains only single-byte
3592 characters, the C<SvUTF8> flag stays being off.
3593 Scans PV for validity and returns false if the PV is invalid UTF-8.
3599 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3605 /* The octets may have got themselves encoded - get them back as
3608 if (!sv_utf8_downgrade(sv, TRUE))
3611 /* it is actually just a matter of turning the utf8 flag on, but
3612 * we want to make sure everything inside is valid utf8 first.
3614 c = (const U8 *) SvPVX_const(sv);
3615 if (!is_utf8_string(c, SvCUR(sv)+1))
3617 e = (const U8 *) SvEND(sv);
3620 if (!UTF8_IS_INVARIANT(ch)) {
3630 =for apidoc sv_setsv
3632 Copies the contents of the source SV C<ssv> into the destination SV
3633 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3634 function if the source SV needs to be reused. Does not handle 'set' magic.
3635 Loosely speaking, it performs a copy-by-value, obliterating any previous
3636 content of the destination.
3638 You probably want to use one of the assortment of wrappers, such as
3639 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3640 C<SvSetMagicSV_nosteal>.
3642 =for apidoc sv_setsv_flags
3644 Copies the contents of the source SV C<ssv> into the destination SV
3645 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3646 function if the source SV needs to be reused. Does not handle 'set' magic.
3647 Loosely speaking, it performs a copy-by-value, obliterating any previous
3648 content of the destination.
3649 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3650 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3651 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3652 and C<sv_setsv_nomg> are implemented in terms of this function.
3654 You probably want to use one of the assortment of wrappers, such as
3655 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3656 C<SvSetMagicSV_nosteal>.
3658 This is the primary function for copying scalars, and most other
3659 copy-ish functions and macros use this underneath.
3665 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3667 register U32 sflags;
3673 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3675 sstr = &PL_sv_undef;
3676 stype = SvTYPE(sstr);
3677 dtype = SvTYPE(dstr);
3682 /* need to nuke the magic */
3684 SvRMAGICAL_off(dstr);
3687 /* There's a lot of redundancy below but we're going for speed here */
3692 if (dtype != SVt_PVGV) {
3693 (void)SvOK_off(dstr);
3701 sv_upgrade(dstr, SVt_IV);
3704 sv_upgrade(dstr, SVt_PVNV);
3708 sv_upgrade(dstr, SVt_PVIV);
3711 (void)SvIOK_only(dstr);
3712 SvIV_set(dstr, SvIVX(sstr));
3715 if (SvTAINTED(sstr))
3726 sv_upgrade(dstr, SVt_NV);
3731 sv_upgrade(dstr, SVt_PVNV);
3734 SvNV_set(dstr, SvNVX(sstr));
3735 (void)SvNOK_only(dstr);
3736 if (SvTAINTED(sstr))
3744 sv_upgrade(dstr, SVt_RV);
3745 else if (dtype == SVt_PVGV &&
3746 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3749 if (GvIMPORTED(dstr) != GVf_IMPORTED
3750 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3752 GvIMPORTED_on(dstr);
3761 #ifdef PERL_OLD_COPY_ON_WRITE
3762 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3763 if (dtype < SVt_PVIV)
3764 sv_upgrade(dstr, SVt_PVIV);
3771 sv_upgrade(dstr, SVt_PV);
3774 if (dtype < SVt_PVIV)
3775 sv_upgrade(dstr, SVt_PVIV);
3778 if (dtype < SVt_PVNV)
3779 sv_upgrade(dstr, SVt_PVNV);
3786 const char * const type = sv_reftype(sstr,0);
3788 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3790 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3795 if (dtype <= SVt_PVGV) {
3797 if (dtype != SVt_PVGV) {
3798 const char * const name = GvNAME(sstr);
3799 const STRLEN len = GvNAMELEN(sstr);
3800 /* don't upgrade SVt_PVLV: it can hold a glob */
3801 if (dtype != SVt_PVLV)
3802 sv_upgrade(dstr, SVt_PVGV);
3803 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3804 GvSTASH(dstr) = GvSTASH(sstr);
3806 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3807 GvNAME(dstr) = savepvn(name, len);
3808 GvNAMELEN(dstr) = len;
3809 SvFAKE_on(dstr); /* can coerce to non-glob */
3811 /* ahem, death to those who redefine active sort subs */
3812 else if (PL_curstackinfo->si_type == PERLSI_SORT
3813 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
3814 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
3817 #ifdef GV_UNIQUE_CHECK
3818 if (GvUNIQUE((GV*)dstr)) {
3819 Perl_croak(aTHX_ PL_no_modify);
3823 (void)SvOK_off(dstr);
3824 GvINTRO_off(dstr); /* one-shot flag */
3826 GvGP(dstr) = gp_ref(GvGP(sstr));
3827 if (SvTAINTED(sstr))
3829 if (GvIMPORTED(dstr) != GVf_IMPORTED
3830 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3832 GvIMPORTED_on(dstr);
3840 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3842 if ((int)SvTYPE(sstr) != stype) {
3843 stype = SvTYPE(sstr);
3844 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3848 if (stype == SVt_PVLV)
3849 SvUPGRADE(dstr, SVt_PVNV);
3851 SvUPGRADE(dstr, (U32)stype);
3854 sflags = SvFLAGS(sstr);
3856 if (sflags & SVf_ROK) {
3857 if (dtype >= SVt_PV) {
3858 if (dtype == SVt_PVGV) {
3859 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3861 const int intro = GvINTRO(dstr);
3863 #ifdef GV_UNIQUE_CHECK
3864 if (GvUNIQUE((GV*)dstr)) {
3865 Perl_croak(aTHX_ PL_no_modify);
3870 GvINTRO_off(dstr); /* one-shot flag */
3871 GvLINE(dstr) = CopLINE(PL_curcop);
3872 GvEGV(dstr) = (GV*)dstr;
3875 switch (SvTYPE(sref)) {
3878 SAVEGENERICSV(GvAV(dstr));
3880 dref = (SV*)GvAV(dstr);
3881 GvAV(dstr) = (AV*)sref;
3882 if (!GvIMPORTED_AV(dstr)
3883 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3885 GvIMPORTED_AV_on(dstr);
3890 SAVEGENERICSV(GvHV(dstr));
3892 dref = (SV*)GvHV(dstr);
3893 GvHV(dstr) = (HV*)sref;
3894 if (!GvIMPORTED_HV(dstr)
3895 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3897 GvIMPORTED_HV_on(dstr);
3902 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3903 SvREFCNT_dec(GvCV(dstr));
3904 GvCV(dstr) = Nullcv;
3905 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3906 PL_sub_generation++;
3908 SAVEGENERICSV(GvCV(dstr));
3911 dref = (SV*)GvCV(dstr);
3912 if (GvCV(dstr) != (CV*)sref) {
3913 CV* const cv = GvCV(dstr);
3915 if (!GvCVGEN((GV*)dstr) &&
3916 (CvROOT(cv) || CvXSUB(cv)))
3918 /* ahem, death to those who redefine
3919 * active sort subs */
3920 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3921 PL_sortcop == CvSTART(cv))
3923 "Can't redefine active sort subroutine %s",
3924 GvENAME((GV*)dstr));
3925 /* Redefining a sub - warning is mandatory if
3926 it was a const and its value changed. */
3927 if (ckWARN(WARN_REDEFINE)
3929 && (!CvCONST((CV*)sref)
3930 || sv_cmp(cv_const_sv(cv),
3931 cv_const_sv((CV*)sref)))))
3933 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3935 ? "Constant subroutine %s::%s redefined"
3936 : "Subroutine %s::%s redefined",
3937 HvNAME_get(GvSTASH((GV*)dstr)),
3938 GvENAME((GV*)dstr));
3942 cv_ckproto(cv, (GV*)dstr,
3944 ? SvPVX_const(sref) : Nullch);
3946 GvCV(dstr) = (CV*)sref;
3947 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3948 GvASSUMECV_on(dstr);
3949 PL_sub_generation++;
3951 if (!GvIMPORTED_CV(dstr)
3952 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3954 GvIMPORTED_CV_on(dstr);
3959 SAVEGENERICSV(GvIOp(dstr));
3961 dref = (SV*)GvIOp(dstr);
3962 GvIOp(dstr) = (IO*)sref;
3966 SAVEGENERICSV(GvFORM(dstr));
3968 dref = (SV*)GvFORM(dstr);
3969 GvFORM(dstr) = (CV*)sref;
3973 SAVEGENERICSV(GvSV(dstr));
3975 dref = (SV*)GvSV(dstr);
3977 if (!GvIMPORTED_SV(dstr)
3978 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3980 GvIMPORTED_SV_on(dstr);
3986 if (SvTAINTED(sstr))
3990 if (SvPVX_const(dstr)) {
3996 (void)SvOK_off(dstr);
3997 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3999 if (sflags & SVp_NOK) {
4001 /* Only set the public OK flag if the source has public OK. */
4002 if (sflags & SVf_NOK)
4003 SvFLAGS(dstr) |= SVf_NOK;
4004 SvNV_set(dstr, SvNVX(sstr));
4006 if (sflags & SVp_IOK) {
4007 (void)SvIOKp_on(dstr);
4008 if (sflags & SVf_IOK)
4009 SvFLAGS(dstr) |= SVf_IOK;
4010 if (sflags & SVf_IVisUV)
4012 SvIV_set(dstr, SvIVX(sstr));
4014 if (SvAMAGIC(sstr)) {
4018 else if (sflags & SVp_POK) {
4022 * Check to see if we can just swipe the string. If so, it's a
4023 * possible small lose on short strings, but a big win on long ones.
4024 * It might even be a win on short strings if SvPVX_const(dstr)
4025 * has to be allocated and SvPVX_const(sstr) has to be freed.
4028 /* Whichever path we take through the next code, we want this true,
4029 and doing it now facilitates the COW check. */
4030 (void)SvPOK_only(dstr);
4033 /* We're not already COW */
4034 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4035 #ifndef PERL_OLD_COPY_ON_WRITE
4036 /* or we are, but dstr isn't a suitable target. */
4037 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
4042 (sflags & SVs_TEMP) && /* slated for free anyway? */
4043 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4044 (!(flags & SV_NOSTEAL)) &&
4045 /* and we're allowed to steal temps */
4046 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4047 SvLEN(sstr) && /* and really is a string */
4048 /* and won't be needed again, potentially */
4049 !(PL_op && PL_op->op_type == OP_AASSIGN))
4050 #ifdef PERL_OLD_COPY_ON_WRITE
4051 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4052 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4053 && SvTYPE(sstr) >= SVt_PVIV)
4056 /* Failed the swipe test, and it's not a shared hash key either.
4057 Have to copy the string. */
4058 STRLEN len = SvCUR(sstr);
4059 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4060 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4061 SvCUR_set(dstr, len);
4062 *SvEND(dstr) = '\0';
4064 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4066 /* Either it's a shared hash key, or it's suitable for
4067 copy-on-write or we can swipe the string. */
4069 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4073 #ifdef PERL_OLD_COPY_ON_WRITE
4075 /* I believe I should acquire a global SV mutex if
4076 it's a COW sv (not a shared hash key) to stop
4077 it going un copy-on-write.
4078 If the source SV has gone un copy on write between up there
4079 and down here, then (assert() that) it is of the correct
4080 form to make it copy on write again */
4081 if ((sflags & (SVf_FAKE | SVf_READONLY))
4082 != (SVf_FAKE | SVf_READONLY)) {
4083 SvREADONLY_on(sstr);
4085 /* Make the source SV into a loop of 1.
4086 (about to become 2) */
4087 SV_COW_NEXT_SV_SET(sstr, sstr);
4091 /* Initial code is common. */
4092 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4097 /* making another shared SV. */
4098 STRLEN cur = SvCUR(sstr);
4099 STRLEN len = SvLEN(sstr);
4100 #ifdef PERL_OLD_COPY_ON_WRITE
4102 assert (SvTYPE(dstr) >= SVt_PVIV);
4103 /* SvIsCOW_normal */
4104 /* splice us in between source and next-after-source. */
4105 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4106 SV_COW_NEXT_SV_SET(sstr, dstr);
4107 SvPV_set(dstr, SvPVX_mutable(sstr));
4111 /* SvIsCOW_shared_hash */
4112 DEBUG_C(PerlIO_printf(Perl_debug_log,
4113 "Copy on write: Sharing hash\n"));
4115 assert (SvTYPE(dstr) >= SVt_PV);
4117 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4119 SvLEN_set(dstr, len);
4120 SvCUR_set(dstr, cur);
4121 SvREADONLY_on(dstr);
4123 /* Relesase a global SV mutex. */
4126 { /* Passes the swipe test. */
4127 SvPV_set(dstr, SvPVX_mutable(sstr));
4128 SvLEN_set(dstr, SvLEN(sstr));
4129 SvCUR_set(dstr, SvCUR(sstr));
4132 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4133 SvPV_set(sstr, Nullch);
4139 if (sflags & SVf_UTF8)
4141 if (sflags & SVp_NOK) {
4143 if (sflags & SVf_NOK)
4144 SvFLAGS(dstr) |= SVf_NOK;
4145 SvNV_set(dstr, SvNVX(sstr));
4147 if (sflags & SVp_IOK) {
4148 (void)SvIOKp_on(dstr);
4149 if (sflags & SVf_IOK)
4150 SvFLAGS(dstr) |= SVf_IOK;
4151 if (sflags & SVf_IVisUV)
4153 SvIV_set(dstr, SvIVX(sstr));
4156 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4157 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4158 smg->mg_ptr, smg->mg_len);
4159 SvRMAGICAL_on(dstr);
4162 else if (sflags & SVp_IOK) {
4163 if (sflags & SVf_IOK)
4164 (void)SvIOK_only(dstr);
4166 (void)SvOK_off(dstr);
4167 (void)SvIOKp_on(dstr);
4169 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4170 if (sflags & SVf_IVisUV)
4172 SvIV_set(dstr, SvIVX(sstr));
4173 if (sflags & SVp_NOK) {
4174 if (sflags & SVf_NOK)
4175 (void)SvNOK_on(dstr);
4177 (void)SvNOKp_on(dstr);
4178 SvNV_set(dstr, SvNVX(sstr));
4181 else if (sflags & SVp_NOK) {
4182 if (sflags & SVf_NOK)
4183 (void)SvNOK_only(dstr);
4185 (void)SvOK_off(dstr);
4188 SvNV_set(dstr, SvNVX(sstr));
4191 if (dtype == SVt_PVGV) {
4192 if (ckWARN(WARN_MISC))
4193 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4196 (void)SvOK_off(dstr);
4198 if (SvTAINTED(sstr))
4203 =for apidoc sv_setsv_mg
4205 Like C<sv_setsv>, but also handles 'set' magic.
4211 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4213 sv_setsv(dstr,sstr);
4217 #ifdef PERL_OLD_COPY_ON_WRITE
4219 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4221 STRLEN cur = SvCUR(sstr);
4222 STRLEN len = SvLEN(sstr);
4223 register char *new_pv;
4226 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4234 if (SvTHINKFIRST(dstr))
4235 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4236 else if (SvPVX_const(dstr))
4237 Safefree(SvPVX_const(dstr));
4241 SvUPGRADE(dstr, SVt_PVIV);
4243 assert (SvPOK(sstr));
4244 assert (SvPOKp(sstr));
4245 assert (!SvIOK(sstr));
4246 assert (!SvIOKp(sstr));
4247 assert (!SvNOK(sstr));
4248 assert (!SvNOKp(sstr));
4250 if (SvIsCOW(sstr)) {
4252 if (SvLEN(sstr) == 0) {
4253 /* source is a COW shared hash key. */
4254 DEBUG_C(PerlIO_printf(Perl_debug_log,
4255 "Fast copy on write: Sharing hash\n"));
4256 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4259 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4261 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4262 SvUPGRADE(sstr, SVt_PVIV);
4263 SvREADONLY_on(sstr);
4265 DEBUG_C(PerlIO_printf(Perl_debug_log,
4266 "Fast copy on write: Converting sstr to COW\n"));
4267 SV_COW_NEXT_SV_SET(dstr, sstr);
4269 SV_COW_NEXT_SV_SET(sstr, dstr);
4270 new_pv = SvPVX_mutable(sstr);
4273 SvPV_set(dstr, new_pv);
4274 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4277 SvLEN_set(dstr, len);
4278 SvCUR_set(dstr, cur);
4287 =for apidoc sv_setpvn
4289 Copies a string into an SV. The C<len> parameter indicates the number of
4290 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4291 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4297 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4299 register char *dptr;
4301 SV_CHECK_THINKFIRST_COW_DROP(sv);
4307 /* len is STRLEN which is unsigned, need to copy to signed */
4310 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4312 SvUPGRADE(sv, SVt_PV);
4314 dptr = SvGROW(sv, len + 1);
4315 Move(ptr,dptr,len,char);
4318 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4323 =for apidoc sv_setpvn_mg
4325 Like C<sv_setpvn>, but also handles 'set' magic.
4331 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4333 sv_setpvn(sv,ptr,len);
4338 =for apidoc sv_setpv
4340 Copies a string into an SV. The string must be null-terminated. Does not
4341 handle 'set' magic. See C<sv_setpv_mg>.
4347 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4349 register STRLEN len;
4351 SV_CHECK_THINKFIRST_COW_DROP(sv);
4357 SvUPGRADE(sv, SVt_PV);
4359 SvGROW(sv, len + 1);
4360 Move(ptr,SvPVX(sv),len+1,char);
4362 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4367 =for apidoc sv_setpv_mg
4369 Like C<sv_setpv>, but also handles 'set' magic.
4375 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4382 =for apidoc sv_usepvn
4384 Tells an SV to use C<ptr> to find its string value. Normally the string is
4385 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4386 The C<ptr> should point to memory that was allocated by C<malloc>. The
4387 string length, C<len>, must be supplied. This function will realloc the
4388 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4389 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4390 See C<sv_usepvn_mg>.
4396 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4399 SV_CHECK_THINKFIRST_COW_DROP(sv);
4400 SvUPGRADE(sv, SVt_PV);
4405 if (SvPVX_const(sv))
4408 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4409 ptr = saferealloc (ptr, allocate);
4412 SvLEN_set(sv, allocate);
4414 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4419 =for apidoc sv_usepvn_mg
4421 Like C<sv_usepvn>, but also handles 'set' magic.
4427 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4429 sv_usepvn(sv,ptr,len);
4433 #ifdef PERL_OLD_COPY_ON_WRITE
4434 /* Need to do this *after* making the SV normal, as we need the buffer
4435 pointer to remain valid until after we've copied it. If we let go too early,
4436 another thread could invalidate it by unsharing last of the same hash key
4437 (which it can do by means other than releasing copy-on-write Svs)
4438 or by changing the other copy-on-write SVs in the loop. */
4440 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4442 if (len) { /* this SV was SvIsCOW_normal(sv) */
4443 /* we need to find the SV pointing to us. */
4444 SV * const current = SV_COW_NEXT_SV(after);
4446 if (current == sv) {
4447 /* The SV we point to points back to us (there were only two of us
4449 Hence other SV is no longer copy on write either. */
4451 SvREADONLY_off(after);
4453 /* We need to follow the pointers around the loop. */
4455 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4458 /* don't loop forever if the structure is bust, and we have
4459 a pointer into a closed loop. */
4460 assert (current != after);
4461 assert (SvPVX_const(current) == pvx);
4463 /* Make the SV before us point to the SV after us. */
4464 SV_COW_NEXT_SV_SET(current, after);
4467 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4472 Perl_sv_release_IVX(pTHX_ register SV *sv)
4475 sv_force_normal_flags(sv, 0);
4481 =for apidoc sv_force_normal_flags
4483 Undo various types of fakery on an SV: if the PV is a shared string, make
4484 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4485 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4486 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4487 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4488 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4489 set to some other value.) In addition, the C<flags> parameter gets passed to
4490 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4491 with flags set to 0.
4497 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4499 #ifdef PERL_OLD_COPY_ON_WRITE
4500 if (SvREADONLY(sv)) {
4501 /* At this point I believe I should acquire a global SV mutex. */
4503 const char * const pvx = SvPVX_const(sv);
4504 const STRLEN len = SvLEN(sv);
4505 const STRLEN cur = SvCUR(sv);
4506 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4508 PerlIO_printf(Perl_debug_log,
4509 "Copy on write: Force normal %ld\n",
4515 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4516 SvPV_set(sv, (char*)0);
4518 if (flags & SV_COW_DROP_PV) {
4519 /* OK, so we don't need to copy our buffer. */
4522 SvGROW(sv, cur + 1);
4523 Move(pvx,SvPVX(sv),cur,char);
4527 sv_release_COW(sv, pvx, len, next);
4532 else if (IN_PERL_RUNTIME)
4533 Perl_croak(aTHX_ PL_no_modify);
4534 /* At this point I believe that I can drop the global SV mutex. */
4537 if (SvREADONLY(sv)) {
4539 const char * const pvx = SvPVX_const(sv);
4540 const STRLEN len = SvCUR(sv);
4543 SvPV_set(sv, Nullch);
4545 SvGROW(sv, len + 1);
4546 Move(pvx,SvPVX(sv),len,char);
4548 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4550 else if (IN_PERL_RUNTIME)
4551 Perl_croak(aTHX_ PL_no_modify);
4555 sv_unref_flags(sv, flags);
4556 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4563 Efficient removal of characters from the beginning of the string buffer.
4564 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4565 the string buffer. The C<ptr> becomes the first character of the adjusted
4566 string. Uses the "OOK hack".
4567 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4568 refer to the same chunk of data.
4574 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4576 register STRLEN delta;
4577 if (!ptr || !SvPOKp(sv))
4579 delta = ptr - SvPVX_const(sv);
4580 SV_CHECK_THINKFIRST(sv);
4581 if (SvTYPE(sv) < SVt_PVIV)
4582 sv_upgrade(sv,SVt_PVIV);
4585 if (!SvLEN(sv)) { /* make copy of shared string */
4586 const char *pvx = SvPVX_const(sv);
4587 const STRLEN len = SvCUR(sv);
4588 SvGROW(sv, len + 1);
4589 Move(pvx,SvPVX(sv),len,char);
4593 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4594 and we do that anyway inside the SvNIOK_off
4596 SvFLAGS(sv) |= SVf_OOK;
4599 SvLEN_set(sv, SvLEN(sv) - delta);
4600 SvCUR_set(sv, SvCUR(sv) - delta);
4601 SvPV_set(sv, SvPVX(sv) + delta);
4602 SvIV_set(sv, SvIVX(sv) + delta);
4606 =for apidoc sv_catpvn
4608 Concatenates the string onto the end of the string which is in the SV. The
4609 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4610 status set, then the bytes appended should be valid UTF-8.
4611 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4613 =for apidoc sv_catpvn_flags
4615 Concatenates the string onto the end of the string which is in the SV. The
4616 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4617 status set, then the bytes appended should be valid UTF-8.
4618 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4619 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4620 in terms of this function.
4626 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4629 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4631 SvGROW(dsv, dlen + slen + 1);
4633 sstr = SvPVX_const(dsv);
4634 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4635 SvCUR_set(dsv, SvCUR(dsv) + slen);
4637 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4642 =for apidoc sv_catpvn_mg
4644 Like C<sv_catpvn>, but also handles 'set' magic.
4650 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4652 sv_catpvn(sv,ptr,len);
4657 =for apidoc sv_catsv
4659 Concatenates the string from SV C<ssv> onto the end of the string in
4660 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4661 not 'set' magic. See C<sv_catsv_mg>.
4663 =for apidoc sv_catsv_flags
4665 Concatenates the string from SV C<ssv> onto the end of the string in
4666 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4667 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4668 and C<sv_catsv_nomg> are implemented in terms of this function.
4673 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4679 if ((spv = SvPV_const(ssv, slen))) {
4680 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4681 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4682 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4683 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4684 dsv->sv_flags doesn't have that bit set.
4685 Andy Dougherty 12 Oct 2001
4687 const I32 sutf8 = DO_UTF8(ssv);
4690 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4692 dutf8 = DO_UTF8(dsv);
4694 if (dutf8 != sutf8) {
4696 /* Not modifying source SV, so taking a temporary copy. */
4697 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4699 sv_utf8_upgrade(csv);
4700 spv = SvPV_const(csv, slen);
4703 sv_utf8_upgrade_nomg(dsv);
4705 sv_catpvn_nomg(dsv, spv, slen);
4710 =for apidoc sv_catsv_mg
4712 Like C<sv_catsv>, but also handles 'set' magic.
4718 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
4725 =for apidoc sv_catpv
4727 Concatenates the string onto the end of the string which is in the SV.
4728 If the SV has the UTF-8 status set, then the bytes appended should be
4729 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4734 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4736 register STRLEN len;
4742 junk = SvPV_force(sv, tlen);
4744 SvGROW(sv, tlen + len + 1);
4746 ptr = SvPVX_const(sv);
4747 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4748 SvCUR_set(sv, SvCUR(sv) + len);
4749 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4754 =for apidoc sv_catpv_mg
4756 Like C<sv_catpv>, but also handles 'set' magic.
4762 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4771 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4772 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4779 Perl_newSV(pTHX_ STRLEN len)
4785 sv_upgrade(sv, SVt_PV);
4786 SvGROW(sv, len + 1);
4791 =for apidoc sv_magicext
4793 Adds magic to an SV, upgrading it if necessary. Applies the
4794 supplied vtable and returns a pointer to the magic added.
4796 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4797 In particular, you can add magic to SvREADONLY SVs, and add more than
4798 one instance of the same 'how'.
4800 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4801 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4802 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4803 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4805 (This is now used as a subroutine by C<sv_magic>.)
4810 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4811 const char* name, I32 namlen)
4815 if (SvTYPE(sv) < SVt_PVMG) {
4816 SvUPGRADE(sv, SVt_PVMG);
4818 Newxz(mg, 1, MAGIC);
4819 mg->mg_moremagic = SvMAGIC(sv);
4820 SvMAGIC_set(sv, mg);
4822 /* Sometimes a magic contains a reference loop, where the sv and
4823 object refer to each other. To prevent a reference loop that
4824 would prevent such objects being freed, we look for such loops
4825 and if we find one we avoid incrementing the object refcount.
4827 Note we cannot do this to avoid self-tie loops as intervening RV must
4828 have its REFCNT incremented to keep it in existence.
4831 if (!obj || obj == sv ||
4832 how == PERL_MAGIC_arylen ||
4833 how == PERL_MAGIC_qr ||
4834 how == PERL_MAGIC_symtab ||
4835 (SvTYPE(obj) == SVt_PVGV &&
4836 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4837 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4838 GvFORM(obj) == (CV*)sv)))
4843 mg->mg_obj = SvREFCNT_inc(obj);
4844 mg->mg_flags |= MGf_REFCOUNTED;
4847 /* Normal self-ties simply pass a null object, and instead of
4848 using mg_obj directly, use the SvTIED_obj macro to produce a
4849 new RV as needed. For glob "self-ties", we are tieing the PVIO
4850 with an RV obj pointing to the glob containing the PVIO. In
4851 this case, to avoid a reference loop, we need to weaken the
4855 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4856 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4862 mg->mg_len = namlen;
4865 mg->mg_ptr = savepvn(name, namlen);
4866 else if (namlen == HEf_SVKEY)
4867 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4869 mg->mg_ptr = (char *) name;
4871 mg->mg_virtual = vtable;
4875 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4880 =for apidoc sv_magic
4882 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4883 then adds a new magic item of type C<how> to the head of the magic list.
4885 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4886 handling of the C<name> and C<namlen> arguments.
4888 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4889 to add more than one instance of the same 'how'.
4895 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4897 const MGVTBL *vtable;
4900 #ifdef PERL_OLD_COPY_ON_WRITE
4902 sv_force_normal_flags(sv, 0);
4904 if (SvREADONLY(sv)) {
4906 /* its okay to attach magic to shared strings; the subsequent
4907 * upgrade to PVMG will unshare the string */
4908 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4911 && how != PERL_MAGIC_regex_global
4912 && how != PERL_MAGIC_bm
4913 && how != PERL_MAGIC_fm
4914 && how != PERL_MAGIC_sv
4915 && how != PERL_MAGIC_backref
4918 Perl_croak(aTHX_ PL_no_modify);
4921 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4922 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4923 /* sv_magic() refuses to add a magic of the same 'how' as an
4926 if (how == PERL_MAGIC_taint)
4934 vtable = &PL_vtbl_sv;
4936 case PERL_MAGIC_overload:
4937 vtable = &PL_vtbl_amagic;
4939 case PERL_MAGIC_overload_elem:
4940 vtable = &PL_vtbl_amagicelem;
4942 case PERL_MAGIC_overload_table:
4943 vtable = &PL_vtbl_ovrld;
4946 vtable = &PL_vtbl_bm;
4948 case PERL_MAGIC_regdata:
4949 vtable = &PL_vtbl_regdata;
4951 case PERL_MAGIC_regdatum:
4952 vtable = &PL_vtbl_regdatum;
4954 case PERL_MAGIC_env:
4955 vtable = &PL_vtbl_env;
4958 vtable = &PL_vtbl_fm;
4960 case PERL_MAGIC_envelem:
4961 vtable = &PL_vtbl_envelem;
4963 case PERL_MAGIC_regex_global:
4964 vtable = &PL_vtbl_mglob;
4966 case PERL_MAGIC_isa:
4967 vtable = &PL_vtbl_isa;
4969 case PERL_MAGIC_isaelem:
4970 vtable = &PL_vtbl_isaelem;
4972 case PERL_MAGIC_nkeys:
4973 vtable = &PL_vtbl_nkeys;
4975 case PERL_MAGIC_dbfile:
4978 case PERL_MAGIC_dbline:
4979 vtable = &PL_vtbl_dbline;
4981 #ifdef USE_LOCALE_COLLATE
4982 case PERL_MAGIC_collxfrm:
4983 vtable = &PL_vtbl_collxfrm;
4985 #endif /* USE_LOCALE_COLLATE */
4986 case PERL_MAGIC_tied:
4987 vtable = &PL_vtbl_pack;
4989 case PERL_MAGIC_tiedelem:
4990 case PERL_MAGIC_tiedscalar:
4991 vtable = &PL_vtbl_packelem;
4994 vtable = &PL_vtbl_regexp;
4996 case PERL_MAGIC_sig:
4997 vtable = &PL_vtbl_sig;
4999 case PERL_MAGIC_sigelem:
5000 vtable = &PL_vtbl_sigelem;
5002 case PERL_MAGIC_taint:
5003 vtable = &PL_vtbl_taint;
5005 case PERL_MAGIC_uvar:
5006 vtable = &PL_vtbl_uvar;
5008 case PERL_MAGIC_vec:
5009 vtable = &PL_vtbl_vec;
5011 case PERL_MAGIC_arylen_p:
5012 case PERL_MAGIC_rhash:
5013 case PERL_MAGIC_symtab:
5014 case PERL_MAGIC_vstring:
5017 case PERL_MAGIC_utf8:
5018 vtable = &PL_vtbl_utf8;
5020 case PERL_MAGIC_substr:
5021 vtable = &PL_vtbl_substr;
5023 case PERL_MAGIC_defelem:
5024 vtable = &PL_vtbl_defelem;
5026 case PERL_MAGIC_glob:
5027 vtable = &PL_vtbl_glob;
5029 case PERL_MAGIC_arylen:
5030 vtable = &PL_vtbl_arylen;
5032 case PERL_MAGIC_pos:
5033 vtable = &PL_vtbl_pos;
5035 case PERL_MAGIC_backref:
5036 vtable = &PL_vtbl_backref;
5038 case PERL_MAGIC_ext:
5039 /* Reserved for use by extensions not perl internals. */
5040 /* Useful for attaching extension internal data to perl vars. */
5041 /* Note that multiple extensions may clash if magical scalars */
5042 /* etc holding private data from one are passed to another. */
5046 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5049 /* Rest of work is done else where */
5050 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5053 case PERL_MAGIC_taint:
5056 case PERL_MAGIC_ext:
5057 case PERL_MAGIC_dbfile:
5064 =for apidoc sv_unmagic
5066 Removes all magic of type C<type> from an SV.
5072 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5076 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5079 for (mg = *mgp; mg; mg = *mgp) {
5080 if (mg->mg_type == type) {
5081 const MGVTBL* const vtbl = mg->mg_virtual;
5082 *mgp = mg->mg_moremagic;
5083 if (vtbl && vtbl->svt_free)
5084 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5085 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5087 Safefree(mg->mg_ptr);
5088 else if (mg->mg_len == HEf_SVKEY)
5089 SvREFCNT_dec((SV*)mg->mg_ptr);
5090 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5091 Safefree(mg->mg_ptr);
5093 if (mg->mg_flags & MGf_REFCOUNTED)
5094 SvREFCNT_dec(mg->mg_obj);
5098 mgp = &mg->mg_moremagic;
5102 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5109 =for apidoc sv_rvweaken
5111 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5112 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5113 push a back-reference to this RV onto the array of backreferences
5114 associated with that magic.
5120 Perl_sv_rvweaken(pTHX_ SV *sv)
5123 if (!SvOK(sv)) /* let undefs pass */
5126 Perl_croak(aTHX_ "Can't weaken a nonreference");
5127 else if (SvWEAKREF(sv)) {
5128 if (ckWARN(WARN_MISC))
5129 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5133 Perl_sv_add_backref(aTHX_ tsv, sv);
5139 /* Give tsv backref magic if it hasn't already got it, then push a
5140 * back-reference to sv onto the array associated with the backref magic.
5144 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5148 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5149 av = (AV*)mg->mg_obj;
5152 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5153 /* av now has a refcnt of 2, which avoids it getting freed
5154 * before us during global cleanup. The extra ref is removed
5155 * by magic_killbackrefs() when tsv is being freed */
5157 if (AvFILLp(av) >= AvMAX(av)) {
5158 av_extend(av, AvFILLp(av)+1);
5160 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5163 /* delete a back-reference to ourselves from the backref magic associated
5164 * with the SV we point to.
5168 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5174 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5175 if (PL_in_clean_all)
5178 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5179 Perl_croak(aTHX_ "panic: del_backref");
5180 av = (AV *)mg->mg_obj;
5182 /* We shouldn't be in here more than once, but for paranoia reasons lets
5184 for (i = AvFILLp(av); i >= 0; i--) {
5186 const SSize_t fill = AvFILLp(av);
5188 /* We weren't the last entry.
5189 An unordered list has this property that you can take the
5190 last element off the end to fill the hole, and it's still
5191 an unordered list :-)
5196 AvFILLp(av) = fill - 1;
5202 =for apidoc sv_insert
5204 Inserts a string at the specified offset/length within the SV. Similar to
5205 the Perl substr() function.
5211 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5215 register char *midend;
5216 register char *bigend;
5222 Perl_croak(aTHX_ "Can't modify non-existent substring");
5223 SvPV_force(bigstr, curlen);
5224 (void)SvPOK_only_UTF8(bigstr);
5225 if (offset + len > curlen) {
5226 SvGROW(bigstr, offset+len+1);
5227 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5228 SvCUR_set(bigstr, offset+len);
5232 i = littlelen - len;
5233 if (i > 0) { /* string might grow */
5234 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5235 mid = big + offset + len;
5236 midend = bigend = big + SvCUR(bigstr);
5239 while (midend > mid) /* shove everything down */
5240 *--bigend = *--midend;
5241 Move(little,big+offset,littlelen,char);
5242 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5247 Move(little,SvPVX(bigstr)+offset,len,char);
5252 big = SvPVX(bigstr);
5255 bigend = big + SvCUR(bigstr);
5257 if (midend > bigend)
5258 Perl_croak(aTHX_ "panic: sv_insert");
5260 if (mid - big > bigend - midend) { /* faster to shorten from end */
5262 Move(little, mid, littlelen,char);
5265 i = bigend - midend;
5267 Move(midend, mid, i,char);
5271 SvCUR_set(bigstr, mid - big);
5273 else if ((i = mid - big)) { /* faster from front */
5274 midend -= littlelen;
5276 sv_chop(bigstr,midend-i);
5281 Move(little, mid, littlelen,char);
5283 else if (littlelen) {
5284 midend -= littlelen;
5285 sv_chop(bigstr,midend);
5286 Move(little,midend,littlelen,char);
5289 sv_chop(bigstr,midend);
5295 =for apidoc sv_replace
5297 Make the first argument a copy of the second, then delete the original.
5298 The target SV physically takes over ownership of the body of the source SV
5299 and inherits its flags; however, the target keeps any magic it owns,
5300 and any magic in the source is discarded.
5301 Note that this is a rather specialist SV copying operation; most of the
5302 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5308 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5310 const U32 refcnt = SvREFCNT(sv);
5311 SV_CHECK_THINKFIRST_COW_DROP(sv);
5312 if (SvREFCNT(nsv) != 1) {
5313 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5314 UVuf " != 1)", (UV) SvREFCNT(nsv));
5316 if (SvMAGICAL(sv)) {
5320 sv_upgrade(nsv, SVt_PVMG);
5321 SvMAGIC_set(nsv, SvMAGIC(sv));
5322 SvFLAGS(nsv) |= SvMAGICAL(sv);
5324 SvMAGIC_set(sv, NULL);
5328 assert(!SvREFCNT(sv));
5329 #ifdef DEBUG_LEAKING_SCALARS
5330 sv->sv_flags = nsv->sv_flags;
5331 sv->sv_any = nsv->sv_any;
5332 sv->sv_refcnt = nsv->sv_refcnt;
5333 sv->sv_u = nsv->sv_u;
5335 StructCopy(nsv,sv,SV);
5337 /* Currently could join these into one piece of pointer arithmetic, but
5338 it would be unclear. */
5339 if(SvTYPE(sv) == SVt_IV)
5341 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5342 else if (SvTYPE(sv) == SVt_RV) {
5343 SvANY(sv) = &sv->sv_u.svu_rv;
5347 #ifdef PERL_OLD_COPY_ON_WRITE
5348 if (SvIsCOW_normal(nsv)) {
5349 /* We need to follow the pointers around the loop to make the
5350 previous SV point to sv, rather than nsv. */
5353 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5356 assert(SvPVX_const(current) == SvPVX_const(nsv));
5358 /* Make the SV before us point to the SV after us. */
5360 PerlIO_printf(Perl_debug_log, "previous is\n");
5362 PerlIO_printf(Perl_debug_log,
5363 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5364 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5366 SV_COW_NEXT_SV_SET(current, sv);
5369 SvREFCNT(sv) = refcnt;
5370 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5376 =for apidoc sv_clear
5378 Clear an SV: call any destructors, free up any memory used by the body,
5379 and free the body itself. The SV's head is I<not> freed, although
5380 its type is set to all 1's so that it won't inadvertently be assumed
5381 to be live during global destruction etc.
5382 This function should only be called when REFCNT is zero. Most of the time
5383 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5390 Perl_sv_clear(pTHX_ register SV *sv)
5393 void** old_body_arena;
5394 size_t old_body_offset;
5395 const U32 type = SvTYPE(sv);
5398 assert(SvREFCNT(sv) == 0);
5404 old_body_offset = 0;
5407 if (PL_defstash) { /* Still have a symbol table? */
5412 stash = SvSTASH(sv);
5413 destructor = StashHANDLER(stash,DESTROY);
5415 SV* const tmpref = newRV(sv);
5416 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5418 PUSHSTACKi(PERLSI_DESTROY);
5423 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5429 if(SvREFCNT(tmpref) < 2) {
5430 /* tmpref is not kept alive! */
5432 SvRV_set(tmpref, NULL);
5435 SvREFCNT_dec(tmpref);
5437 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5441 if (PL_in_clean_objs)
5442 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5444 /* DESTROY gave object new lease on life */
5450 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5451 SvOBJECT_off(sv); /* Curse the object. */
5452 if (type != SVt_PVIO)
5453 --PL_sv_objcount; /* XXX Might want something more general */
5456 if (type >= SVt_PVMG) {
5459 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5460 SvREFCNT_dec(SvSTASH(sv));
5465 IoIFP(sv) != PerlIO_stdin() &&
5466 IoIFP(sv) != PerlIO_stdout() &&
5467 IoIFP(sv) != PerlIO_stderr())
5469 io_close((IO*)sv, FALSE);
5471 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5472 PerlDir_close(IoDIRP(sv));
5473 IoDIRP(sv) = (DIR*)NULL;
5474 Safefree(IoTOP_NAME(sv));
5475 Safefree(IoFMT_NAME(sv));
5476 Safefree(IoBOTTOM_NAME(sv));
5477 /* PVIOs aren't from arenas */
5480 old_body_arena = (void **) &PL_xpvbm_root;
5483 old_body_arena = (void **) &PL_xpvcv_root;
5485 /* PVFMs aren't from arenas */
5490 old_body_arena = (void **) &PL_xpvhv_root;
5491 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5495 old_body_arena = (void **) &PL_xpvav_root;
5496 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5499 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5500 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5501 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5502 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5504 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5505 SvREFCNT_dec(LvTARG(sv));
5506 old_body_arena = (void **) &PL_xpvlv_root;
5510 Safefree(GvNAME(sv));
5511 /* If we're in a stash, we don't own a reference to it. However it does
5512 have a back reference to us, which needs to be cleared. */
5514 sv_del_backref((SV*)GvSTASH(sv), sv);
5515 old_body_arena = (void **) &PL_xpvgv_root;
5518 old_body_arena = (void **) &PL_xpvmg_root;
5521 old_body_arena = (void **) &PL_xpvnv_root;
5524 old_body_arena = (void **) &PL_xpviv_root;
5525 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5527 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5529 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5530 /* Don't even bother with turning off the OOK flag. */
5534 old_body_arena = (void **) &PL_xpv_root;
5535 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5539 SV *target = SvRV(sv);
5541 sv_del_backref(target, sv);
5543 SvREFCNT_dec(target);
5545 #ifdef PERL_OLD_COPY_ON_WRITE
5546 else if (SvPVX_const(sv)) {
5548 /* I believe I need to grab the global SV mutex here and
5549 then recheck the COW status. */
5551 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5554 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5555 SV_COW_NEXT_SV(sv));
5556 /* And drop it here. */
5558 } else if (SvLEN(sv)) {
5559 Safefree(SvPVX_const(sv));
5563 else if (SvPVX_const(sv) && SvLEN(sv))
5564 Safefree(SvPVX_mutable(sv));
5565 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5566 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5572 old_body_arena = (void **) &PL_xnv_root;
5576 SvFLAGS(sv) &= SVf_BREAK;
5577 SvFLAGS(sv) |= SVTYPEMASK;
5580 if (old_body_arena) {
5581 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5585 if (type > SVt_RV) {
5586 my_safefree(SvANY(sv));
5591 =for apidoc sv_newref
5593 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5600 Perl_sv_newref(pTHX_ SV *sv)
5610 Decrement an SV's reference count, and if it drops to zero, call
5611 C<sv_clear> to invoke destructors and free up any memory used by
5612 the body; finally, deallocate the SV's head itself.
5613 Normally called via a wrapper macro C<SvREFCNT_dec>.
5619 Perl_sv_free(pTHX_ SV *sv)
5624 if (SvREFCNT(sv) == 0) {
5625 if (SvFLAGS(sv) & SVf_BREAK)
5626 /* this SV's refcnt has been artificially decremented to
5627 * trigger cleanup */
5629 if (PL_in_clean_all) /* All is fair */
5631 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5632 /* make sure SvREFCNT(sv)==0 happens very seldom */
5633 SvREFCNT(sv) = (~(U32)0)/2;
5636 if (ckWARN_d(WARN_INTERNAL)) {
5637 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5638 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5639 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5640 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5641 Perl_dump_sv_child(aTHX_ sv);
5646 if (--(SvREFCNT(sv)) > 0)
5648 Perl_sv_free2(aTHX_ sv);
5652 Perl_sv_free2(pTHX_ SV *sv)
5657 if (ckWARN_d(WARN_DEBUGGING))
5658 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5659 "Attempt to free temp prematurely: SV 0x%"UVxf
5660 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5664 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5665 /* make sure SvREFCNT(sv)==0 happens very seldom */
5666 SvREFCNT(sv) = (~(U32)0)/2;
5677 Returns the length of the string in the SV. Handles magic and type
5678 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5684 Perl_sv_len(pTHX_ register SV *sv)
5692 len = mg_length(sv);
5694 (void)SvPV_const(sv, len);
5699 =for apidoc sv_len_utf8
5701 Returns the number of characters in the string in an SV, counting wide
5702 UTF-8 bytes as a single character. Handles magic and type coercion.
5708 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5709 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5710 * (Note that the mg_len is not the length of the mg_ptr field.)
5715 Perl_sv_len_utf8(pTHX_ register SV *sv)
5721 return mg_length(sv);
5725 const U8 *s = (U8*)SvPV_const(sv, len);
5726 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5728 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5730 #ifdef PERL_UTF8_CACHE_ASSERT
5731 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5735 ulen = Perl_utf8_length(aTHX_ s, s + len);
5736 if (!mg && !SvREADONLY(sv)) {
5737 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5738 mg = mg_find(sv, PERL_MAGIC_utf8);
5748 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5749 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5750 * between UTF-8 and byte offsets. There are two (substr offset and substr
5751 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5752 * and byte offset) cache positions.
5754 * The mg_len field is used by sv_len_utf8(), see its comments.
5755 * Note that the mg_len is not the length of the mg_ptr field.
5759 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5760 I32 offsetp, const U8 *s, const U8 *start)
5764 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5766 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5770 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5772 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5773 (*mgp)->mg_ptr = (char *) *cachep;
5777 (*cachep)[i] = offsetp;
5778 (*cachep)[i+1] = s - start;
5786 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5787 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5788 * between UTF-8 and byte offsets. See also the comments of
5789 * S_utf8_mg_pos_init().
5793 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)
5797 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5799 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5800 if (*mgp && (*mgp)->mg_ptr) {
5801 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5802 ASSERT_UTF8_CACHE(*cachep);
5803 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5805 else { /* We will skip to the right spot. */
5810 /* The assumption is that going backward is half
5811 * the speed of going forward (that's where the
5812 * 2 * backw in the below comes from). (The real
5813 * figure of course depends on the UTF-8 data.) */
5815 if ((*cachep)[i] > (STRLEN)uoff) {
5817 backw = (*cachep)[i] - (STRLEN)uoff;
5819 if (forw < 2 * backw)
5822 p = start + (*cachep)[i+1];
5824 /* Try this only for the substr offset (i == 0),
5825 * not for the substr length (i == 2). */
5826 else if (i == 0) { /* (*cachep)[i] < uoff */
5827 const STRLEN ulen = sv_len_utf8(sv);
5829 if ((STRLEN)uoff < ulen) {
5830 forw = (STRLEN)uoff - (*cachep)[i];
5831 backw = ulen - (STRLEN)uoff;
5833 if (forw < 2 * backw)
5834 p = start + (*cachep)[i+1];
5839 /* If the string is not long enough for uoff,
5840 * we could extend it, but not at this low a level. */
5844 if (forw < 2 * backw) {
5851 while (UTF8_IS_CONTINUATION(*p))
5856 /* Update the cache. */
5857 (*cachep)[i] = (STRLEN)uoff;
5858 (*cachep)[i+1] = p - start;
5860 /* Drop the stale "length" cache */
5869 if (found) { /* Setup the return values. */
5870 *offsetp = (*cachep)[i+1];
5871 *sp = start + *offsetp;
5874 *offsetp = send - start;
5876 else if (*sp < start) {
5882 #ifdef PERL_UTF8_CACHE_ASSERT
5887 while (n-- && s < send)
5891 assert(*offsetp == s - start);
5892 assert((*cachep)[0] == (STRLEN)uoff);
5893 assert((*cachep)[1] == *offsetp);
5895 ASSERT_UTF8_CACHE(*cachep);
5904 =for apidoc sv_pos_u2b
5906 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5907 the start of the string, to a count of the equivalent number of bytes; if
5908 lenp is non-zero, it does the same to lenp, but this time starting from
5909 the offset, rather than from the start of the string. Handles magic and
5916 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5917 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5918 * byte offsets. See also the comments of S_utf8_mg_pos().
5923 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5931 start = (U8*)SvPV_const(sv, len);
5935 const U8 *s = start;
5936 I32 uoffset = *offsetp;
5937 const U8 * const send = s + len;
5941 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5943 if (!found && uoffset > 0) {
5944 while (s < send && uoffset--)
5948 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5950 *offsetp = s - start;
5955 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5959 if (!found && *lenp > 0) {
5962 while (s < send && ulen--)
5966 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5970 ASSERT_UTF8_CACHE(cache);
5982 =for apidoc sv_pos_b2u
5984 Converts the value pointed to by offsetp from a count of bytes from the
5985 start of the string, to a count of the equivalent number of UTF-8 chars.
5986 Handles magic and type coercion.
5992 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5993 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5994 * byte offsets. See also the comments of S_utf8_mg_pos().
5999 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6007 s = (const U8*)SvPV_const(sv, len);
6008 if ((I32)len < *offsetp)
6009 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6011 const U8* send = s + *offsetp;
6013 STRLEN *cache = NULL;
6017 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6018 mg = mg_find(sv, PERL_MAGIC_utf8);
6019 if (mg && mg->mg_ptr) {
6020 cache = (STRLEN *) mg->mg_ptr;
6021 if (cache[1] == (STRLEN)*offsetp) {
6022 /* An exact match. */
6023 *offsetp = cache[0];
6027 else if (cache[1] < (STRLEN)*offsetp) {
6028 /* We already know part of the way. */
6031 /* Let the below loop do the rest. */
6033 else { /* cache[1] > *offsetp */
6034 /* We already know all of the way, now we may
6035 * be able to walk back. The same assumption
6036 * is made as in S_utf8_mg_pos(), namely that
6037 * walking backward is twice slower than
6038 * walking forward. */
6039 const STRLEN forw = *offsetp;
6040 STRLEN backw = cache[1] - *offsetp;
6042 if (!(forw < 2 * backw)) {
6043 const U8 *p = s + cache[1];
6050 while (UTF8_IS_CONTINUATION(*p)) {
6058 *offsetp = cache[0];
6060 /* Drop the stale "length" cache */
6068 ASSERT_UTF8_CACHE(cache);
6074 /* Call utf8n_to_uvchr() to validate the sequence
6075 * (unless a simple non-UTF character) */
6076 if (!UTF8_IS_INVARIANT(*s))
6077 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6086 if (!SvREADONLY(sv)) {
6088 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6089 mg = mg_find(sv, PERL_MAGIC_utf8);
6094 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6095 mg->mg_ptr = (char *) cache;
6100 cache[1] = *offsetp;
6101 /* Drop the stale "length" cache */
6114 Returns a boolean indicating whether the strings in the two SVs are
6115 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6116 coerce its args to strings if necessary.
6122 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6130 SV* svrecode = Nullsv;
6137 pv1 = SvPV_const(sv1, cur1);
6144 pv2 = SvPV_const(sv2, cur2);
6146 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6147 /* Differing utf8ness.
6148 * Do not UTF8size the comparands as a side-effect. */
6151 svrecode = newSVpvn(pv2, cur2);
6152 sv_recode_to_utf8(svrecode, PL_encoding);
6153 pv2 = SvPV_const(svrecode, cur2);
6156 svrecode = newSVpvn(pv1, cur1);
6157 sv_recode_to_utf8(svrecode, PL_encoding);
6158 pv1 = SvPV_const(svrecode, cur1);
6160 /* Now both are in UTF-8. */
6162 SvREFCNT_dec(svrecode);
6167 bool is_utf8 = TRUE;
6170 /* sv1 is the UTF-8 one,
6171 * if is equal it must be downgrade-able */
6172 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6178 /* sv2 is the UTF-8 one,
6179 * if is equal it must be downgrade-able */
6180 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6186 /* Downgrade not possible - cannot be eq */
6194 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6197 SvREFCNT_dec(svrecode);
6208 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6209 string in C<sv1> is less than, equal to, or greater than the string in
6210 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6211 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6217 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6220 const char *pv1, *pv2;
6223 SV *svrecode = Nullsv;
6230 pv1 = SvPV_const(sv1, cur1);
6237 pv2 = SvPV_const(sv2, cur2);
6239 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6240 /* Differing utf8ness.
6241 * Do not UTF8size the comparands as a side-effect. */
6244 svrecode = newSVpvn(pv2, cur2);
6245 sv_recode_to_utf8(svrecode, PL_encoding);
6246 pv2 = SvPV_const(svrecode, cur2);
6249 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6254 svrecode = newSVpvn(pv1, cur1);
6255 sv_recode_to_utf8(svrecode, PL_encoding);
6256 pv1 = SvPV_const(svrecode, cur1);
6259 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6265 cmp = cur2 ? -1 : 0;
6269 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6272 cmp = retval < 0 ? -1 : 1;
6273 } else if (cur1 == cur2) {
6276 cmp = cur1 < cur2 ? -1 : 1;
6281 SvREFCNT_dec(svrecode);
6290 =for apidoc sv_cmp_locale
6292 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6293 'use bytes' aware, handles get magic, and will coerce its args to strings
6294 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6300 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6302 #ifdef USE_LOCALE_COLLATE
6308 if (PL_collation_standard)
6312 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6314 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6316 if (!pv1 || !len1) {
6327 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6330 return retval < 0 ? -1 : 1;
6333 * When the result of collation is equality, that doesn't mean
6334 * that there are no differences -- some locales exclude some
6335 * characters from consideration. So to avoid false equalities,
6336 * we use the raw string as a tiebreaker.
6342 #endif /* USE_LOCALE_COLLATE */
6344 return sv_cmp(sv1, sv2);
6348 #ifdef USE_LOCALE_COLLATE
6351 =for apidoc sv_collxfrm
6353 Add Collate Transform magic to an SV if it doesn't already have it.
6355 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6356 scalar data of the variable, but transformed to such a format that a normal
6357 memory comparison can be used to compare the data according to the locale
6364 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6368 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6369 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6375 Safefree(mg->mg_ptr);
6376 s = SvPV_const(sv, len);
6377 if ((xf = mem_collxfrm(s, len, &xlen))) {
6378 if (SvREADONLY(sv)) {
6381 return xf + sizeof(PL_collation_ix);
6384 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6385 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6398 if (mg && mg->mg_ptr) {
6400 return mg->mg_ptr + sizeof(PL_collation_ix);
6408 #endif /* USE_LOCALE_COLLATE */
6413 Get a line from the filehandle and store it into the SV, optionally
6414 appending to the currently-stored string.
6420 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6424 register STDCHAR rslast;
6425 register STDCHAR *bp;
6431 if (SvTHINKFIRST(sv))
6432 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6433 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6435 However, perlbench says it's slower, because the existing swipe code
6436 is faster than copy on write.
6437 Swings and roundabouts. */
6438 SvUPGRADE(sv, SVt_PV);
6443 if (PerlIO_isutf8(fp)) {
6445 sv_utf8_upgrade_nomg(sv);
6446 sv_pos_u2b(sv,&append,0);
6448 } else if (SvUTF8(sv)) {
6449 SV * const tsv = NEWSV(0,0);
6450 sv_gets(tsv, fp, 0);
6451 sv_utf8_upgrade_nomg(tsv);
6452 SvCUR_set(sv,append);
6455 goto return_string_or_null;
6460 if (PerlIO_isutf8(fp))
6463 if (IN_PERL_COMPILETIME) {
6464 /* we always read code in line mode */
6468 else if (RsSNARF(PL_rs)) {
6469 /* If it is a regular disk file use size from stat() as estimate
6470 of amount we are going to read - may result in malloc-ing
6471 more memory than we realy need if layers bellow reduce
6472 size we read (e.g. CRLF or a gzip layer)
6475 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6476 const Off_t offset = PerlIO_tell(fp);
6477 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6478 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6484 else if (RsRECORD(PL_rs)) {
6488 /* Grab the size of the record we're getting */
6489 recsize = SvIV(SvRV(PL_rs));
6490 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6493 /* VMS wants read instead of fread, because fread doesn't respect */
6494 /* RMS record boundaries. This is not necessarily a good thing to be */
6495 /* doing, but we've got no other real choice - except avoid stdio
6496 as implementation - perhaps write a :vms layer ?
6498 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6500 bytesread = PerlIO_read(fp, buffer, recsize);
6504 SvCUR_set(sv, bytesread += append);
6505 buffer[bytesread] = '\0';
6506 goto return_string_or_null;
6508 else if (RsPARA(PL_rs)) {
6514 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6515 if (PerlIO_isutf8(fp)) {
6516 rsptr = SvPVutf8(PL_rs, rslen);
6519 if (SvUTF8(PL_rs)) {
6520 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6521 Perl_croak(aTHX_ "Wide character in $/");
6524 rsptr = SvPV_const(PL_rs, rslen);
6528 rslast = rslen ? rsptr[rslen - 1] : '\0';
6530 if (rspara) { /* have to do this both before and after */
6531 do { /* to make sure file boundaries work right */
6534 i = PerlIO_getc(fp);
6538 PerlIO_ungetc(fp,i);
6544 /* See if we know enough about I/O mechanism to cheat it ! */
6546 /* This used to be #ifdef test - it is made run-time test for ease
6547 of abstracting out stdio interface. One call should be cheap
6548 enough here - and may even be a macro allowing compile
6552 if (PerlIO_fast_gets(fp)) {
6555 * We're going to steal some values from the stdio struct
6556 * and put EVERYTHING in the innermost loop into registers.
6558 register STDCHAR *ptr;
6562 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6563 /* An ungetc()d char is handled separately from the regular
6564 * buffer, so we getc() it back out and stuff it in the buffer.
6566 i = PerlIO_getc(fp);
6567 if (i == EOF) return 0;
6568 *(--((*fp)->_ptr)) = (unsigned char) i;
6572 /* Here is some breathtakingly efficient cheating */
6574 cnt = PerlIO_get_cnt(fp); /* get count into register */
6575 /* make sure we have the room */
6576 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6577 /* Not room for all of it
6578 if we are looking for a separator and room for some
6580 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6581 /* just process what we have room for */
6582 shortbuffered = cnt - SvLEN(sv) + append + 1;
6583 cnt -= shortbuffered;
6587 /* remember that cnt can be negative */
6588 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6593 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6594 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6595 DEBUG_P(PerlIO_printf(Perl_debug_log,
6596 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6597 DEBUG_P(PerlIO_printf(Perl_debug_log,
6598 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6599 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6600 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6605 while (cnt > 0) { /* this | eat */
6607 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6608 goto thats_all_folks; /* screams | sed :-) */
6612 Copy(ptr, bp, cnt, char); /* this | eat */
6613 bp += cnt; /* screams | dust */
6614 ptr += cnt; /* louder | sed :-) */
6619 if (shortbuffered) { /* oh well, must extend */
6620 cnt = shortbuffered;
6622 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6624 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6625 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6629 DEBUG_P(PerlIO_printf(Perl_debug_log,
6630 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6631 PTR2UV(ptr),(long)cnt));
6632 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6634 DEBUG_P(PerlIO_printf(Perl_debug_log,
6635 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6636 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6637 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6639 /* This used to call 'filbuf' in stdio form, but as that behaves like
6640 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6641 another abstraction. */
6642 i = PerlIO_getc(fp); /* get more characters */
6644 DEBUG_P(PerlIO_printf(Perl_debug_log,
6645 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6646 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6647 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6649 cnt = PerlIO_get_cnt(fp);
6650 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6651 DEBUG_P(PerlIO_printf(Perl_debug_log,
6652 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6654 if (i == EOF) /* all done for ever? */
6655 goto thats_really_all_folks;
6657 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6659 SvGROW(sv, bpx + cnt + 2);
6660 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6662 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6664 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6665 goto thats_all_folks;
6669 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6670 memNE((char*)bp - rslen, rsptr, rslen))
6671 goto screamer; /* go back to the fray */
6672 thats_really_all_folks:
6674 cnt += shortbuffered;
6675 DEBUG_P(PerlIO_printf(Perl_debug_log,
6676 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6677 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6678 DEBUG_P(PerlIO_printf(Perl_debug_log,
6679 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6680 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6681 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6683 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6684 DEBUG_P(PerlIO_printf(Perl_debug_log,
6685 "Screamer: done, len=%ld, string=|%.*s|\n",
6686 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6690 /*The big, slow, and stupid way. */
6691 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6693 Newx(buf, 8192, STDCHAR);
6701 register const STDCHAR *bpe = buf + sizeof(buf);
6703 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6704 ; /* keep reading */
6708 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6709 /* Accomodate broken VAXC compiler, which applies U8 cast to
6710 * both args of ?: operator, causing EOF to change into 255
6713 i = (U8)buf[cnt - 1];
6719 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6721 sv_catpvn(sv, (char *) buf, cnt);
6723 sv_setpvn(sv, (char *) buf, cnt);
6725 if (i != EOF && /* joy */
6727 SvCUR(sv) < rslen ||
6728 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6732 * If we're reading from a TTY and we get a short read,
6733 * indicating that the user hit his EOF character, we need
6734 * to notice it now, because if we try to read from the TTY
6735 * again, the EOF condition will disappear.
6737 * The comparison of cnt to sizeof(buf) is an optimization
6738 * that prevents unnecessary calls to feof().
6742 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6746 #ifdef USE_HEAP_INSTEAD_OF_STACK
6751 if (rspara) { /* have to do this both before and after */
6752 while (i != EOF) { /* to make sure file boundaries work right */
6753 i = PerlIO_getc(fp);
6755 PerlIO_ungetc(fp,i);
6761 return_string_or_null:
6762 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6768 Auto-increment of the value in the SV, doing string to numeric conversion
6769 if necessary. Handles 'get' magic.
6775 Perl_sv_inc(pTHX_ register SV *sv)
6783 if (SvTHINKFIRST(sv)) {
6785 sv_force_normal_flags(sv, 0);
6786 if (SvREADONLY(sv)) {
6787 if (IN_PERL_RUNTIME)
6788 Perl_croak(aTHX_ PL_no_modify);
6792 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6794 i = PTR2IV(SvRV(sv));
6799 flags = SvFLAGS(sv);
6800 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6801 /* It's (privately or publicly) a float, but not tested as an
6802 integer, so test it to see. */
6804 flags = SvFLAGS(sv);
6806 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6807 /* It's publicly an integer, or privately an integer-not-float */
6808 #ifdef PERL_PRESERVE_IVUV
6812 if (SvUVX(sv) == UV_MAX)
6813 sv_setnv(sv, UV_MAX_P1);
6815 (void)SvIOK_only_UV(sv);
6816 SvUV_set(sv, SvUVX(sv) + 1);
6818 if (SvIVX(sv) == IV_MAX)
6819 sv_setuv(sv, (UV)IV_MAX + 1);
6821 (void)SvIOK_only(sv);
6822 SvIV_set(sv, SvIVX(sv) + 1);
6827 if (flags & SVp_NOK) {
6828 (void)SvNOK_only(sv);
6829 SvNV_set(sv, SvNVX(sv) + 1.0);
6833 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6834 if ((flags & SVTYPEMASK) < SVt_PVIV)
6835 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6836 (void)SvIOK_only(sv);
6841 while (isALPHA(*d)) d++;
6842 while (isDIGIT(*d)) d++;
6844 #ifdef PERL_PRESERVE_IVUV
6845 /* Got to punt this as an integer if needs be, but we don't issue
6846 warnings. Probably ought to make the sv_iv_please() that does
6847 the conversion if possible, and silently. */
6848 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6849 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6850 /* Need to try really hard to see if it's an integer.
6851 9.22337203685478e+18 is an integer.
6852 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6853 so $a="9.22337203685478e+18"; $a+0; $a++
6854 needs to be the same as $a="9.22337203685478e+18"; $a++
6861 /* sv_2iv *should* have made this an NV */
6862 if (flags & SVp_NOK) {
6863 (void)SvNOK_only(sv);
6864 SvNV_set(sv, SvNVX(sv) + 1.0);
6867 /* I don't think we can get here. Maybe I should assert this
6868 And if we do get here I suspect that sv_setnv will croak. NWC
6870 #if defined(USE_LONG_DOUBLE)
6871 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",
6872 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6874 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6875 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6878 #endif /* PERL_PRESERVE_IVUV */
6879 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6883 while (d >= SvPVX_const(sv)) {
6891 /* MKS: The original code here died if letters weren't consecutive.
6892 * at least it didn't have to worry about non-C locales. The
6893 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6894 * arranged in order (although not consecutively) and that only
6895 * [A-Za-z] are accepted by isALPHA in the C locale.
6897 if (*d != 'z' && *d != 'Z') {
6898 do { ++*d; } while (!isALPHA(*d));
6901 *(d--) -= 'z' - 'a';
6906 *(d--) -= 'z' - 'a' + 1;
6910 /* oh,oh, the number grew */
6911 SvGROW(sv, SvCUR(sv) + 2);
6912 SvCUR_set(sv, SvCUR(sv) + 1);
6913 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6924 Auto-decrement of the value in the SV, doing string to numeric conversion
6925 if necessary. Handles 'get' magic.
6931 Perl_sv_dec(pTHX_ register SV *sv)
6938 if (SvTHINKFIRST(sv)) {
6940 sv_force_normal_flags(sv, 0);
6941 if (SvREADONLY(sv)) {
6942 if (IN_PERL_RUNTIME)
6943 Perl_croak(aTHX_ PL_no_modify);
6947 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6949 i = PTR2IV(SvRV(sv));
6954 /* Unlike sv_inc we don't have to worry about string-never-numbers
6955 and keeping them magic. But we mustn't warn on punting */
6956 flags = SvFLAGS(sv);
6957 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6958 /* It's publicly an integer, or privately an integer-not-float */
6959 #ifdef PERL_PRESERVE_IVUV
6963 if (SvUVX(sv) == 0) {
6964 (void)SvIOK_only(sv);
6968 (void)SvIOK_only_UV(sv);
6969 SvUV_set(sv, SvUVX(sv) - 1);
6972 if (SvIVX(sv) == IV_MIN)
6973 sv_setnv(sv, (NV)IV_MIN - 1.0);
6975 (void)SvIOK_only(sv);
6976 SvIV_set(sv, SvIVX(sv) - 1);
6981 if (flags & SVp_NOK) {
6982 SvNV_set(sv, SvNVX(sv) - 1.0);
6983 (void)SvNOK_only(sv);
6986 if (!(flags & SVp_POK)) {
6987 if ((flags & SVTYPEMASK) < SVt_PVIV)
6988 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6990 (void)SvIOK_only(sv);
6993 #ifdef PERL_PRESERVE_IVUV
6995 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6996 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6997 /* Need to try really hard to see if it's an integer.
6998 9.22337203685478e+18 is an integer.
6999 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7000 so $a="9.22337203685478e+18"; $a+0; $a--
7001 needs to be the same as $a="9.22337203685478e+18"; $a--
7008 /* sv_2iv *should* have made this an NV */
7009 if (flags & SVp_NOK) {
7010 (void)SvNOK_only(sv);
7011 SvNV_set(sv, SvNVX(sv) - 1.0);
7014 /* I don't think we can get here. Maybe I should assert this
7015 And if we do get here I suspect that sv_setnv will croak. NWC
7017 #if defined(USE_LONG_DOUBLE)
7018 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",
7019 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7021 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7022 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7026 #endif /* PERL_PRESERVE_IVUV */
7027 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7031 =for apidoc sv_mortalcopy
7033 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7034 The new SV is marked as mortal. It will be destroyed "soon", either by an
7035 explicit call to FREETMPS, or by an implicit call at places such as
7036 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7041 /* Make a string that will exist for the duration of the expression
7042 * evaluation. Actually, it may have to last longer than that, but
7043 * hopefully we won't free it until it has been assigned to a
7044 * permanent location. */
7047 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7052 sv_setsv(sv,oldstr);
7054 PL_tmps_stack[++PL_tmps_ix] = sv;
7060 =for apidoc sv_newmortal
7062 Creates a new null SV which is mortal. The reference count of the SV is
7063 set to 1. It will be destroyed "soon", either by an explicit call to
7064 FREETMPS, or by an implicit call at places such as statement boundaries.
7065 See also C<sv_mortalcopy> and C<sv_2mortal>.
7071 Perl_sv_newmortal(pTHX)
7076 SvFLAGS(sv) = SVs_TEMP;
7078 PL_tmps_stack[++PL_tmps_ix] = sv;
7083 =for apidoc sv_2mortal
7085 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7086 by an explicit call to FREETMPS, or by an implicit call at places such as
7087 statement boundaries. SvTEMP() is turned on which means that the SV's
7088 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7089 and C<sv_mortalcopy>.
7095 Perl_sv_2mortal(pTHX_ register SV *sv)
7100 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7103 PL_tmps_stack[++PL_tmps_ix] = sv;
7111 Creates a new SV and copies a string into it. The reference count for the
7112 SV is set to 1. If C<len> is zero, Perl will compute the length using
7113 strlen(). For efficiency, consider using C<newSVpvn> instead.
7119 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7124 sv_setpvn(sv,s,len ? len : strlen(s));
7129 =for apidoc newSVpvn
7131 Creates a new SV and copies a string into it. The reference count for the
7132 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7133 string. You are responsible for ensuring that the source string is at least
7134 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7140 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7145 sv_setpvn(sv,s,len);
7151 =for apidoc newSVhek
7153 Creates a new SV from the hash key structure. It will generate scalars that
7154 point to the shared string table where possible. Returns a new (undefined)
7155 SV if the hek is NULL.
7161 Perl_newSVhek(pTHX_ const HEK *hek)
7170 if (HEK_LEN(hek) == HEf_SVKEY) {
7171 return newSVsv(*(SV**)HEK_KEY(hek));
7173 const int flags = HEK_FLAGS(hek);
7174 if (flags & HVhek_WASUTF8) {
7176 Andreas would like keys he put in as utf8 to come back as utf8
7178 STRLEN utf8_len = HEK_LEN(hek);
7179 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7180 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7183 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7185 } else if (flags & HVhek_REHASH) {
7186 /* We don't have a pointer to the hv, so we have to replicate the
7187 flag into every HEK. This hv is using custom a hasing
7188 algorithm. Hence we can't return a shared string scalar, as
7189 that would contain the (wrong) hash value, and might get passed
7190 into an hv routine with a regular hash */
7192 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7197 /* This will be overwhelminly the most common case. */
7198 return newSVpvn_share(HEK_KEY(hek),
7199 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7205 =for apidoc newSVpvn_share
7207 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7208 table. If the string does not already exist in the table, it is created
7209 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7210 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7211 otherwise the hash is computed. The idea here is that as the string table
7212 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7213 hash lookup will avoid string compare.
7219 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7222 bool is_utf8 = FALSE;
7224 STRLEN tmplen = -len;
7226 /* See the note in hv.c:hv_fetch() --jhi */
7227 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7231 PERL_HASH(hash, src, len);
7233 sv_upgrade(sv, SVt_PV);
7234 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7246 #if defined(PERL_IMPLICIT_CONTEXT)
7248 /* pTHX_ magic can't cope with varargs, so this is a no-context
7249 * version of the main function, (which may itself be aliased to us).
7250 * Don't access this version directly.
7254 Perl_newSVpvf_nocontext(const char* pat, ...)
7259 va_start(args, pat);
7260 sv = vnewSVpvf(pat, &args);
7267 =for apidoc newSVpvf
7269 Creates a new SV and initializes it with the string formatted like
7276 Perl_newSVpvf(pTHX_ const char* pat, ...)
7280 va_start(args, pat);
7281 sv = vnewSVpvf(pat, &args);
7286 /* backend for newSVpvf() and newSVpvf_nocontext() */
7289 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7293 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7300 Creates a new SV and copies a floating point value into it.
7301 The reference count for the SV is set to 1.
7307 Perl_newSVnv(pTHX_ NV n)
7319 Creates a new SV and copies an integer into it. The reference count for the
7326 Perl_newSViv(pTHX_ IV i)
7338 Creates a new SV and copies an unsigned integer into it.
7339 The reference count for the SV is set to 1.
7345 Perl_newSVuv(pTHX_ UV u)
7355 =for apidoc newRV_noinc
7357 Creates an RV wrapper for an SV. The reference count for the original
7358 SV is B<not> incremented.
7364 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7369 sv_upgrade(sv, SVt_RV);
7371 SvRV_set(sv, tmpRef);
7376 /* newRV_inc is the official function name to use now.
7377 * newRV_inc is in fact #defined to newRV in sv.h
7381 Perl_newRV(pTHX_ SV *tmpRef)
7383 return newRV_noinc(SvREFCNT_inc(tmpRef));
7389 Creates a new SV which is an exact duplicate of the original SV.
7396 Perl_newSVsv(pTHX_ register SV *old)
7402 if (SvTYPE(old) == SVTYPEMASK) {
7403 if (ckWARN_d(WARN_INTERNAL))
7404 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7408 /* SV_GMAGIC is the default for sv_setv()
7409 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7410 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7411 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7416 =for apidoc sv_reset
7418 Underlying implementation for the C<reset> Perl function.
7419 Note that the perl-level function is vaguely deprecated.
7425 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7428 char todo[PERL_UCHAR_MAX+1];
7433 if (!*s) { /* reset ?? searches */
7434 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7436 PMOP *pm = (PMOP *) mg->mg_obj;
7438 pm->op_pmdynflags &= ~PMdf_USED;
7445 /* reset variables */
7447 if (!HvARRAY(stash))
7450 Zero(todo, 256, char);
7453 I32 i = (unsigned char)*s;
7457 max = (unsigned char)*s++;
7458 for ( ; i <= max; i++) {
7461 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7463 for (entry = HvARRAY(stash)[i];
7465 entry = HeNEXT(entry))
7470 if (!todo[(U8)*HeKEY(entry)])
7472 gv = (GV*)HeVAL(entry);
7475 if (SvTHINKFIRST(sv)) {
7476 if (!SvREADONLY(sv) && SvROK(sv))
7478 /* XXX Is this continue a bug? Why should THINKFIRST
7479 exempt us from resetting arrays and hashes? */
7483 if (SvTYPE(sv) >= SVt_PV) {
7485 if (SvPVX_const(sv) != Nullch)
7493 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7496 #ifdef USE_ENVIRON_ARRAY
7498 # ifdef USE_ITHREADS
7499 && PL_curinterp == aTHX
7503 environ[0] = Nullch;
7506 #endif /* !PERL_MICRO */
7516 Using various gambits, try to get an IO from an SV: the IO slot if its a
7517 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7518 named after the PV if we're a string.
7524 Perl_sv_2io(pTHX_ SV *sv)
7529 switch (SvTYPE(sv)) {
7537 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7541 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7543 return sv_2io(SvRV(sv));
7544 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7550 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7559 Using various gambits, try to get a CV from an SV; in addition, try if
7560 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7566 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7573 return *gvp = Nullgv, Nullcv;
7574 switch (SvTYPE(sv)) {
7592 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7593 tryAMAGICunDEREF(to_cv);
7596 if (SvTYPE(sv) == SVt_PVCV) {
7605 Perl_croak(aTHX_ "Not a subroutine reference");
7610 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7616 if (lref && !GvCVu(gv)) {
7619 tmpsv = NEWSV(704,0);
7620 gv_efullname3(tmpsv, gv, Nullch);
7621 /* XXX this is probably not what they think they're getting.
7622 * It has the same effect as "sub name;", i.e. just a forward
7624 newSUB(start_subparse(FALSE, 0),
7625 newSVOP(OP_CONST, 0, tmpsv),
7630 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7640 Returns true if the SV has a true value by Perl's rules.
7641 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7642 instead use an in-line version.
7648 Perl_sv_true(pTHX_ register SV *sv)
7653 register const XPV* const tXpv = (XPV*)SvANY(sv);
7655 (tXpv->xpv_cur > 1 ||
7656 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7663 return SvIVX(sv) != 0;
7666 return SvNVX(sv) != 0.0;
7668 return sv_2bool(sv);
7676 A private implementation of the C<SvIVx> macro for compilers which can't
7677 cope with complex macro expressions. Always use the macro instead.
7683 Perl_sv_iv(pTHX_ register SV *sv)
7687 return (IV)SvUVX(sv);
7696 A private implementation of the C<SvUVx> macro for compilers which can't
7697 cope with complex macro expressions. Always use the macro instead.
7703 Perl_sv_uv(pTHX_ register SV *sv)
7708 return (UV)SvIVX(sv);
7716 A private implementation of the C<SvNVx> macro for compilers which can't
7717 cope with complex macro expressions. Always use the macro instead.
7723 Perl_sv_nv(pTHX_ register SV *sv)
7733 Use the C<SvPV_nolen> macro instead
7737 A private implementation of the C<SvPV> macro for compilers which can't
7738 cope with complex macro expressions. Always use the macro instead.
7744 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
7750 return sv_2pv(sv, lp);
7755 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7761 return sv_2pv_flags(sv, lp, 0);
7765 =for apidoc sv_pvn_force
7767 Get a sensible string out of the SV somehow.
7768 A private implementation of the C<SvPV_force> macro for compilers which
7769 can't cope with complex macro expressions. Always use the macro instead.
7771 =for apidoc sv_pvn_force_flags
7773 Get a sensible string out of the SV somehow.
7774 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7775 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7776 implemented in terms of this function.
7777 You normally want to use the various wrapper macros instead: see
7778 C<SvPV_force> and C<SvPV_force_nomg>
7784 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7787 if (SvTHINKFIRST(sv) && !SvROK(sv))
7788 sv_force_normal_flags(sv, 0);
7798 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7799 const char * const ref = sv_reftype(sv,0);
7801 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7802 ref, OP_NAME(PL_op));
7804 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7806 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7807 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7809 s = sv_2pv_flags(sv, &len, flags);
7813 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7816 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7817 SvGROW(sv, len + 1);
7818 Move(s,SvPVX(sv),len,char);
7823 SvPOK_on(sv); /* validate pointer */
7825 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7826 PTR2UV(sv),SvPVX_const(sv)));
7829 return SvPVX_mutable(sv);
7833 =for apidoc sv_pvbyte
7835 Use C<SvPVbyte_nolen> instead.
7837 =for apidoc sv_pvbyten
7839 A private implementation of the C<SvPVbyte> macro for compilers
7840 which can't cope with complex macro expressions. Always use the macro
7847 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7849 sv_utf8_downgrade(sv,0);
7850 return sv_pvn(sv,lp);
7854 =for apidoc sv_pvbyten_force
7856 A private implementation of the C<SvPVbytex_force> macro for compilers
7857 which can't cope with complex macro expressions. Always use the macro
7864 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7866 sv_pvn_force(sv,lp);
7867 sv_utf8_downgrade(sv,0);
7873 =for apidoc sv_pvutf8
7875 Use the C<SvPVutf8_nolen> macro instead
7877 =for apidoc sv_pvutf8n
7879 A private implementation of the C<SvPVutf8> macro for compilers
7880 which can't cope with complex macro expressions. Always use the macro
7887 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7889 sv_utf8_upgrade(sv);
7890 return sv_pvn(sv,lp);
7894 =for apidoc sv_pvutf8n_force
7896 A private implementation of the C<SvPVutf8_force> macro for compilers
7897 which can't cope with complex macro expressions. Always use the macro
7904 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7906 sv_pvn_force(sv,lp);
7907 sv_utf8_upgrade(sv);
7913 =for apidoc sv_reftype
7915 Returns a string describing what the SV is a reference to.
7921 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7923 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7924 inside return suggests a const propagation bug in g++. */
7925 if (ob && SvOBJECT(sv)) {
7926 char * const name = HvNAME_get(SvSTASH(sv));
7927 return name ? name : (char *) "__ANON__";
7930 switch (SvTYPE(sv)) {
7947 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7948 /* tied lvalues should appear to be
7949 * scalars for backwards compatitbility */
7950 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7951 ? "SCALAR" : "LVALUE");
7952 case SVt_PVAV: return "ARRAY";
7953 case SVt_PVHV: return "HASH";
7954 case SVt_PVCV: return "CODE";
7955 case SVt_PVGV: return "GLOB";
7956 case SVt_PVFM: return "FORMAT";
7957 case SVt_PVIO: return "IO";
7958 default: return "UNKNOWN";
7964 =for apidoc sv_isobject
7966 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7967 object. If the SV is not an RV, or if the object is not blessed, then this
7974 Perl_sv_isobject(pTHX_ SV *sv)
7990 Returns a boolean indicating whether the SV is blessed into the specified
7991 class. This does not check for subtypes; use C<sv_derived_from> to verify
7992 an inheritance relationship.
7998 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8009 hvname = HvNAME_get(SvSTASH(sv));
8013 return strEQ(hvname, name);
8019 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8020 it will be upgraded to one. If C<classname> is non-null then the new SV will
8021 be blessed in the specified package. The new SV is returned and its
8022 reference count is 1.
8028 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8034 SV_CHECK_THINKFIRST_COW_DROP(rv);
8037 if (SvTYPE(rv) >= SVt_PVMG) {
8038 const U32 refcnt = SvREFCNT(rv);
8042 SvREFCNT(rv) = refcnt;
8045 if (SvTYPE(rv) < SVt_RV)
8046 sv_upgrade(rv, SVt_RV);
8047 else if (SvTYPE(rv) > SVt_RV) {
8058 HV* const stash = gv_stashpv(classname, TRUE);
8059 (void)sv_bless(rv, stash);
8065 =for apidoc sv_setref_pv
8067 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8068 argument will be upgraded to an RV. That RV will be modified to point to
8069 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8070 into the SV. The C<classname> argument indicates the package for the
8071 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8072 will have a reference count of 1, and the RV will be returned.
8074 Do not use with other Perl types such as HV, AV, SV, CV, because those
8075 objects will become corrupted by the pointer copy process.
8077 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8083 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8086 sv_setsv(rv, &PL_sv_undef);
8090 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8095 =for apidoc sv_setref_iv
8097 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8098 argument will be upgraded to an RV. That RV will be modified to point to
8099 the new SV. The C<classname> argument indicates the package for the
8100 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8101 will have a reference count of 1, and the RV will be returned.
8107 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8109 sv_setiv(newSVrv(rv,classname), iv);
8114 =for apidoc sv_setref_uv
8116 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8117 argument will be upgraded to an RV. That RV will be modified to point to
8118 the new SV. The C<classname> argument indicates the package for the
8119 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8120 will have a reference count of 1, and the RV will be returned.
8126 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8128 sv_setuv(newSVrv(rv,classname), uv);
8133 =for apidoc sv_setref_nv
8135 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8136 argument will be upgraded to an RV. That RV will be modified to point to
8137 the new SV. The C<classname> argument indicates the package for the
8138 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8139 will have a reference count of 1, and the RV will be returned.
8145 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8147 sv_setnv(newSVrv(rv,classname), nv);
8152 =for apidoc sv_setref_pvn
8154 Copies a string into a new SV, optionally blessing the SV. The length of the
8155 string must be specified with C<n>. The C<rv> argument will be upgraded to
8156 an RV. That RV will be modified to point to the new SV. The C<classname>
8157 argument indicates the package for the blessing. Set C<classname> to
8158 C<Nullch> to avoid the blessing. The new SV will have a reference count
8159 of 1, and the RV will be returned.
8161 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8167 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8169 sv_setpvn(newSVrv(rv,classname), pv, n);
8174 =for apidoc sv_bless
8176 Blesses an SV into a specified package. The SV must be an RV. The package
8177 must be designated by its stash (see C<gv_stashpv()>). The reference count
8178 of the SV is unaffected.
8184 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8188 Perl_croak(aTHX_ "Can't bless non-reference value");
8190 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8191 if (SvREADONLY(tmpRef))
8192 Perl_croak(aTHX_ PL_no_modify);
8193 if (SvOBJECT(tmpRef)) {
8194 if (SvTYPE(tmpRef) != SVt_PVIO)
8196 SvREFCNT_dec(SvSTASH(tmpRef));
8199 SvOBJECT_on(tmpRef);
8200 if (SvTYPE(tmpRef) != SVt_PVIO)
8202 SvUPGRADE(tmpRef, SVt_PVMG);
8203 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8210 if(SvSMAGICAL(tmpRef))
8211 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8219 /* Downgrades a PVGV to a PVMG.
8223 S_sv_unglob(pTHX_ SV *sv)
8227 assert(SvTYPE(sv) == SVt_PVGV);
8232 sv_del_backref((SV*)GvSTASH(sv), sv);
8233 GvSTASH(sv) = Nullhv;
8235 sv_unmagic(sv, PERL_MAGIC_glob);
8236 Safefree(GvNAME(sv));
8239 /* need to keep SvANY(sv) in the right arena */
8240 xpvmg = new_XPVMG();
8241 StructCopy(SvANY(sv), xpvmg, XPVMG);
8242 del_XPVGV(SvANY(sv));
8245 SvFLAGS(sv) &= ~SVTYPEMASK;
8246 SvFLAGS(sv) |= SVt_PVMG;
8250 =for apidoc sv_unref_flags
8252 Unsets the RV status of the SV, and decrements the reference count of
8253 whatever was being referenced by the RV. This can almost be thought of
8254 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8255 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8256 (otherwise the decrementing is conditional on the reference count being
8257 different from one or the reference being a readonly SV).
8264 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8266 SV* const target = SvRV(ref);
8268 if (SvWEAKREF(ref)) {
8269 sv_del_backref(target, ref);
8271 SvRV_set(ref, NULL);
8274 SvRV_set(ref, NULL);
8276 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8277 assigned to as BEGIN {$a = \"Foo"} will fail. */
8278 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8279 SvREFCNT_dec(target);
8280 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8281 sv_2mortal(target); /* Schedule for freeing later */
8285 =for apidoc sv_untaint
8287 Untaint an SV. Use C<SvTAINTED_off> instead.
8292 Perl_sv_untaint(pTHX_ SV *sv)
8294 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8295 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8302 =for apidoc sv_tainted
8304 Test an SV for taintedness. Use C<SvTAINTED> instead.
8309 Perl_sv_tainted(pTHX_ SV *sv)
8311 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8312 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8313 if (mg && (mg->mg_len & 1) )
8320 =for apidoc sv_setpviv
8322 Copies an integer into the given SV, also updating its string value.
8323 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8329 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8331 char buf[TYPE_CHARS(UV)];
8333 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8335 sv_setpvn(sv, ptr, ebuf - ptr);
8339 =for apidoc sv_setpviv_mg
8341 Like C<sv_setpviv>, but also handles 'set' magic.
8347 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8349 char buf[TYPE_CHARS(UV)];
8351 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8353 sv_setpvn(sv, ptr, ebuf - ptr);
8357 #if defined(PERL_IMPLICIT_CONTEXT)
8359 /* pTHX_ magic can't cope with varargs, so this is a no-context
8360 * version of the main function, (which may itself be aliased to us).
8361 * Don't access this version directly.
8365 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8369 va_start(args, pat);
8370 sv_vsetpvf(sv, pat, &args);
8374 /* pTHX_ magic can't cope with varargs, so this is a no-context
8375 * version of the main function, (which may itself be aliased to us).
8376 * Don't access this version directly.
8380 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8384 va_start(args, pat);
8385 sv_vsetpvf_mg(sv, pat, &args);
8391 =for apidoc sv_setpvf
8393 Works like C<sv_catpvf> but copies the text into the SV instead of
8394 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8400 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8403 va_start(args, pat);
8404 sv_vsetpvf(sv, pat, &args);
8409 =for apidoc sv_vsetpvf
8411 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8412 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8414 Usually used via its frontend C<sv_setpvf>.
8420 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8422 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8426 =for apidoc sv_setpvf_mg
8428 Like C<sv_setpvf>, but also handles 'set' magic.
8434 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8437 va_start(args, pat);
8438 sv_vsetpvf_mg(sv, pat, &args);
8443 =for apidoc sv_vsetpvf_mg
8445 Like C<sv_vsetpvf>, but also handles 'set' magic.
8447 Usually used via its frontend C<sv_setpvf_mg>.
8453 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8455 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8459 #if defined(PERL_IMPLICIT_CONTEXT)
8461 /* pTHX_ magic can't cope with varargs, so this is a no-context
8462 * version of the main function, (which may itself be aliased to us).
8463 * Don't access this version directly.
8467 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8471 va_start(args, pat);
8472 sv_vcatpvf(sv, pat, &args);
8476 /* pTHX_ magic can't cope with varargs, so this is a no-context
8477 * version of the main function, (which may itself be aliased to us).
8478 * Don't access this version directly.
8482 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8486 va_start(args, pat);
8487 sv_vcatpvf_mg(sv, pat, &args);
8493 =for apidoc sv_catpvf
8495 Processes its arguments like C<sprintf> and appends the formatted
8496 output to an SV. If the appended data contains "wide" characters
8497 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8498 and characters >255 formatted with %c), the original SV might get
8499 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8500 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8501 valid UTF-8; if the original SV was bytes, the pattern should be too.
8506 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8509 va_start(args, pat);
8510 sv_vcatpvf(sv, pat, &args);
8515 =for apidoc sv_vcatpvf
8517 Processes its arguments like C<vsprintf> and appends the formatted output
8518 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8520 Usually used via its frontend C<sv_catpvf>.
8526 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8528 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8532 =for apidoc sv_catpvf_mg
8534 Like C<sv_catpvf>, but also handles 'set' magic.
8540 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8543 va_start(args, pat);
8544 sv_vcatpvf_mg(sv, pat, &args);
8549 =for apidoc sv_vcatpvf_mg
8551 Like C<sv_vcatpvf>, but also handles 'set' magic.
8553 Usually used via its frontend C<sv_catpvf_mg>.
8559 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8561 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8566 =for apidoc sv_vsetpvfn
8568 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8571 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8577 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8579 sv_setpvn(sv, "", 0);
8580 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8583 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8586 S_expect_number(pTHX_ char** pattern)
8589 switch (**pattern) {
8590 case '1': case '2': case '3':
8591 case '4': case '5': case '6':
8592 case '7': case '8': case '9':
8593 while (isDIGIT(**pattern))
8594 var = var * 10 + (*(*pattern)++ - '0');
8598 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8601 F0convert(NV nv, char *endbuf, STRLEN *len)
8603 const int neg = nv < 0;
8612 if (uv & 1 && uv == nv)
8613 uv--; /* Round to even */
8615 const unsigned dig = uv % 10;
8628 =for apidoc sv_vcatpvfn
8630 Processes its arguments like C<vsprintf> and appends the formatted output
8631 to an SV. Uses an array of SVs if the C style variable argument list is
8632 missing (NULL). When running with taint checks enabled, indicates via
8633 C<maybe_tainted> if results are untrustworthy (often due to the use of
8636 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8642 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8643 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8644 vec_utf8 = DO_UTF8(vecsv);
8646 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8649 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8656 static const char nullstr[] = "(null)";
8658 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8659 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8661 /* Times 4: a decimal digit takes more than 3 binary digits.
8662 * NV_DIG: mantissa takes than many decimal digits.
8663 * Plus 32: Playing safe. */
8664 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8665 /* large enough for "%#.#f" --chip */
8666 /* what about long double NVs? --jhi */
8668 PERL_UNUSED_ARG(maybe_tainted);
8670 /* no matter what, this is a string now */
8671 (void)SvPV_force(sv, origlen);
8673 /* special-case "", "%s", and "%-p" (SVf - see below) */
8676 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8678 const char * const s = va_arg(*args, char*);
8679 sv_catpv(sv, s ? s : nullstr);
8681 else if (svix < svmax) {
8682 sv_catsv(sv, *svargs);
8683 if (DO_UTF8(*svargs))
8688 if (args && patlen == 3 && pat[0] == '%' &&
8689 pat[1] == '-' && pat[2] == 'p') {
8690 argsv = va_arg(*args, SV*);
8691 sv_catsv(sv, argsv);
8697 #ifndef USE_LONG_DOUBLE
8698 /* special-case "%.<number>[gf]" */
8699 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8700 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8701 unsigned digits = 0;
8705 while (*pp >= '0' && *pp <= '9')
8706 digits = 10 * digits + (*pp++ - '0');
8707 if (pp - pat == (int)patlen - 1) {
8715 /* Add check for digits != 0 because it seems that some
8716 gconverts are buggy in this case, and we don't yet have
8717 a Configure test for this. */
8718 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8719 /* 0, point, slack */
8720 Gconvert(nv, (int)digits, 0, ebuf);
8722 if (*ebuf) /* May return an empty string for digits==0 */
8725 } else if (!digits) {
8728 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8729 sv_catpvn(sv, p, l);
8735 #endif /* !USE_LONG_DOUBLE */
8737 if (!args && svix < svmax && DO_UTF8(*svargs))
8740 patend = (char*)pat + patlen;
8741 for (p = (char*)pat; p < patend; p = q) {
8744 bool vectorize = FALSE;
8745 bool vectorarg = FALSE;
8746 bool vec_utf8 = FALSE;
8752 bool has_precis = FALSE;
8755 bool is_utf8 = FALSE; /* is this item utf8? */
8756 #ifdef HAS_LDBL_SPRINTF_BUG
8757 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8758 with sfio - Allen <allens@cpan.org> */
8759 bool fix_ldbl_sprintf_bug = FALSE;
8763 U8 utf8buf[UTF8_MAXBYTES+1];
8764 STRLEN esignlen = 0;
8766 const char *eptr = Nullch;
8769 const U8 *vecstr = Null(U8*);
8776 /* we need a long double target in case HAS_LONG_DOUBLE but
8779 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8787 const char *dotstr = ".";
8788 STRLEN dotstrlen = 1;
8789 I32 efix = 0; /* explicit format parameter index */
8790 I32 ewix = 0; /* explicit width index */
8791 I32 epix = 0; /* explicit precision index */
8792 I32 evix = 0; /* explicit vector index */
8793 bool asterisk = FALSE;
8795 /* echo everything up to the next format specification */
8796 for (q = p; q < patend && *q != '%'; ++q) ;
8798 if (has_utf8 && !pat_utf8)
8799 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8801 sv_catpvn(sv, p, q - p);
8808 We allow format specification elements in this order:
8809 \d+\$ explicit format parameter index
8811 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8812 0 flag (as above): repeated to allow "v02"
8813 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8814 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8816 [%bcdefginopsuxDFOUX] format (mandatory)
8821 As of perl5.9.3, printf format checking is on by default.
8822 Internally, perl uses %p formats to provide an escape to
8823 some extended formatting. This block deals with those
8824 extensions: if it does not match, (char*)q is reset and
8825 the normal format processing code is used.
8827 Currently defined extensions are:
8828 %p include pointer address (standard)
8829 %-p (SVf) include an SV (previously %_)
8830 %-<num>p include an SV with precision <num>
8831 %1p (VDf) include a v-string (as %vd)
8832 %<num>p reserved for future extensions
8834 Robin Barker 2005-07-14
8841 EXPECT_NUMBER(q, n);
8848 argsv = va_arg(*args, SV*);
8849 eptr = SvPVx_const(argsv, elen);
8855 else if (n == vdNUMBER) { /* VDf */
8862 if (ckWARN_d(WARN_INTERNAL))
8863 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8864 "internal %%<num>p might conflict with future printf extensions");
8870 if (EXPECT_NUMBER(q, width)) {
8911 if (EXPECT_NUMBER(q, ewix))
8920 if ((vectorarg = asterisk)) {
8933 EXPECT_NUMBER(q, width);
8939 vecsv = va_arg(*args, SV*);
8941 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8942 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8943 dotstr = SvPV_const(vecsv, dotstrlen);
8950 else if (efix ? efix <= svmax : svix < svmax) {
8951 vecsv = svargs[efix ? efix-1 : svix++];
8952 vecstr = (U8*)SvPV_const(vecsv,veclen);
8953 vec_utf8 = DO_UTF8(vecsv);
8954 /* if this is a version object, we need to return the
8955 * stringified representation (which the SvPVX_const has
8956 * already done for us), but not vectorize the args
8958 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8960 q++; /* skip past the rest of the %vd format */
8961 eptr = (const char *) vecstr;
8962 elen = strlen(eptr);
8975 i = va_arg(*args, int);
8977 i = (ewix ? ewix <= svmax : svix < svmax) ?
8978 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8980 width = (i < 0) ? -i : i;
8990 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8992 /* XXX: todo, support specified precision parameter */
8996 i = va_arg(*args, int);
8998 i = (ewix ? ewix <= svmax : svix < svmax)
8999 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9000 precis = (i < 0) ? 0 : i;
9005 precis = precis * 10 + (*q++ - '0');
9014 case 'I': /* Ix, I32x, and I64x */
9016 if (q[1] == '6' && q[2] == '4') {
9022 if (q[1] == '3' && q[2] == '2') {
9032 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9043 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9044 if (*(q + 1) == 'l') { /* lld, llf */
9069 argsv = (efix ? efix <= svmax : svix < svmax) ?
9070 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9077 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9079 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9081 eptr = (char*)utf8buf;
9082 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9093 if (args && !vectorize) {
9094 eptr = va_arg(*args, char*);
9096 #ifdef MACOS_TRADITIONAL
9097 /* On MacOS, %#s format is used for Pascal strings */
9102 elen = strlen(eptr);
9104 eptr = (char *)nullstr;
9105 elen = sizeof nullstr - 1;
9109 eptr = SvPVx_const(argsv, elen);
9110 if (DO_UTF8(argsv)) {
9111 if (has_precis && precis < elen) {
9113 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9116 if (width) { /* fudge width (can't fudge elen) */
9117 width += elen - sv_len_utf8(argsv);
9125 if (has_precis && elen > precis)
9132 if (alt || vectorize)
9134 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9155 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9164 esignbuf[esignlen++] = plus;
9168 case 'h': iv = (short)va_arg(*args, int); break;
9169 case 'l': iv = va_arg(*args, long); break;
9170 case 'V': iv = va_arg(*args, IV); break;
9171 default: iv = va_arg(*args, int); break;
9173 case 'q': iv = va_arg(*args, Quad_t); break;
9178 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9180 case 'h': iv = (short)tiv; break;
9181 case 'l': iv = (long)tiv; break;
9183 default: iv = tiv; break;
9185 case 'q': iv = (Quad_t)tiv; break;
9189 if ( !vectorize ) /* we already set uv above */
9194 esignbuf[esignlen++] = plus;
9198 esignbuf[esignlen++] = '-';
9241 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9252 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9253 case 'l': uv = va_arg(*args, unsigned long); break;
9254 case 'V': uv = va_arg(*args, UV); break;
9255 default: uv = va_arg(*args, unsigned); break;
9257 case 'q': uv = va_arg(*args, Uquad_t); break;
9262 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9264 case 'h': uv = (unsigned short)tuv; break;
9265 case 'l': uv = (unsigned long)tuv; break;
9267 default: uv = tuv; break;
9269 case 'q': uv = (Uquad_t)tuv; break;
9276 char *ptr = ebuf + sizeof ebuf;
9282 p = (char*)((c == 'X')
9283 ? "0123456789ABCDEF" : "0123456789abcdef");
9289 esignbuf[esignlen++] = '0';
9290 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9298 if (alt && *ptr != '0')
9307 esignbuf[esignlen++] = '0';
9308 esignbuf[esignlen++] = 'b';
9311 default: /* it had better be ten or less */
9315 } while (uv /= base);
9318 elen = (ebuf + sizeof ebuf) - ptr;
9322 zeros = precis - elen;
9323 else if (precis == 0 && elen == 1 && *eptr == '0')
9329 /* FLOATING POINT */
9332 c = 'f'; /* maybe %F isn't supported here */
9338 /* This is evil, but floating point is even more evil */
9340 /* for SV-style calling, we can only get NV
9341 for C-style calling, we assume %f is double;
9342 for simplicity we allow any of %Lf, %llf, %qf for long double
9346 #if defined(USE_LONG_DOUBLE)
9350 /* [perl #20339] - we should accept and ignore %lf rather than die */
9354 #if defined(USE_LONG_DOUBLE)
9355 intsize = args ? 0 : 'q';
9359 #if defined(HAS_LONG_DOUBLE)
9368 /* now we need (long double) if intsize == 'q', else (double) */
9369 nv = (args && !vectorize) ?
9370 #if LONG_DOUBLESIZE > DOUBLESIZE
9372 va_arg(*args, long double) :
9373 va_arg(*args, double)
9375 va_arg(*args, double)
9381 if (c != 'e' && c != 'E') {
9383 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9384 will cast our (long double) to (double) */
9385 (void)Perl_frexp(nv, &i);
9386 if (i == PERL_INT_MIN)
9387 Perl_die(aTHX_ "panic: frexp");
9389 need = BIT_DIGITS(i);
9391 need += has_precis ? precis : 6; /* known default */
9396 #ifdef HAS_LDBL_SPRINTF_BUG
9397 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9398 with sfio - Allen <allens@cpan.org> */
9401 # define MY_DBL_MAX DBL_MAX
9402 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9403 # if DOUBLESIZE >= 8
9404 # define MY_DBL_MAX 1.7976931348623157E+308L
9406 # define MY_DBL_MAX 3.40282347E+38L
9410 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9411 # define MY_DBL_MAX_BUG 1L
9413 # define MY_DBL_MAX_BUG MY_DBL_MAX
9417 # define MY_DBL_MIN DBL_MIN
9418 # else /* XXX guessing! -Allen */
9419 # if DOUBLESIZE >= 8
9420 # define MY_DBL_MIN 2.2250738585072014E-308L
9422 # define MY_DBL_MIN 1.17549435E-38L
9426 if ((intsize == 'q') && (c == 'f') &&
9427 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9429 /* it's going to be short enough that
9430 * long double precision is not needed */
9432 if ((nv <= 0L) && (nv >= -0L))
9433 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9435 /* would use Perl_fp_class as a double-check but not
9436 * functional on IRIX - see perl.h comments */
9438 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9439 /* It's within the range that a double can represent */
9440 #if defined(DBL_MAX) && !defined(DBL_MIN)
9441 if ((nv >= ((long double)1/DBL_MAX)) ||
9442 (nv <= (-(long double)1/DBL_MAX)))
9444 fix_ldbl_sprintf_bug = TRUE;
9447 if (fix_ldbl_sprintf_bug == TRUE) {
9457 # undef MY_DBL_MAX_BUG
9460 #endif /* HAS_LDBL_SPRINTF_BUG */
9462 need += 20; /* fudge factor */
9463 if (PL_efloatsize < need) {
9464 Safefree(PL_efloatbuf);
9465 PL_efloatsize = need + 20; /* more fudge */
9466 Newx(PL_efloatbuf, PL_efloatsize, char);
9467 PL_efloatbuf[0] = '\0';
9470 if ( !(width || left || plus || alt) && fill != '0'
9471 && has_precis && intsize != 'q' ) { /* Shortcuts */
9472 /* See earlier comment about buggy Gconvert when digits,
9474 if ( c == 'g' && precis) {
9475 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9476 /* May return an empty string for digits==0 */
9477 if (*PL_efloatbuf) {
9478 elen = strlen(PL_efloatbuf);
9479 goto float_converted;
9481 } else if ( c == 'f' && !precis) {
9482 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9487 char *ptr = ebuf + sizeof ebuf;
9490 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9491 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9492 if (intsize == 'q') {
9493 /* Copy the one or more characters in a long double
9494 * format before the 'base' ([efgEFG]) character to
9495 * the format string. */
9496 static char const prifldbl[] = PERL_PRIfldbl;
9497 char const *p = prifldbl + sizeof(prifldbl) - 3;
9498 while (p >= prifldbl) { *--ptr = *p--; }
9503 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9508 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9520 /* No taint. Otherwise we are in the strange situation
9521 * where printf() taints but print($float) doesn't.
9523 #if defined(HAS_LONG_DOUBLE)
9524 elen = ((intsize == 'q')
9525 ? my_sprintf(PL_efloatbuf, ptr, nv)
9526 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9528 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9532 eptr = PL_efloatbuf;
9538 i = SvCUR(sv) - origlen;
9539 if (args && !vectorize) {
9541 case 'h': *(va_arg(*args, short*)) = i; break;
9542 default: *(va_arg(*args, int*)) = i; break;
9543 case 'l': *(va_arg(*args, long*)) = i; break;
9544 case 'V': *(va_arg(*args, IV*)) = i; break;
9546 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9551 sv_setuv_mg(argsv, (UV)i);
9553 continue; /* not "break" */
9560 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9561 && ckWARN(WARN_PRINTF))
9563 SV *msg = sv_newmortal();
9564 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9565 (PL_op->op_type == OP_PRTF) ? "" : "s");
9568 Perl_sv_catpvf(aTHX_ msg,
9569 "\"%%%c\"", c & 0xFF);
9571 Perl_sv_catpvf(aTHX_ msg,
9572 "\"%%\\%03"UVof"\"",
9575 sv_catpv(msg, "end of string");
9576 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9579 /* output mangled stuff ... */
9585 /* ... right here, because formatting flags should not apply */
9586 SvGROW(sv, SvCUR(sv) + elen + 1);
9588 Copy(eptr, p, elen, char);
9591 SvCUR_set(sv, p - SvPVX_const(sv));
9593 continue; /* not "break" */
9596 /* calculate width before utf8_upgrade changes it */
9597 have = esignlen + zeros + elen;
9599 if (is_utf8 != has_utf8) {
9602 sv_utf8_upgrade(sv);
9605 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9606 sv_utf8_upgrade(nsv);
9607 eptr = SvPVX_const(nsv);
9610 SvGROW(sv, SvCUR(sv) + elen + 1);
9615 need = (have > width ? have : width);
9618 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9620 if (esignlen && fill == '0') {
9622 for (i = 0; i < (int)esignlen; i++)
9626 memset(p, fill, gap);
9629 if (esignlen && fill != '0') {
9631 for (i = 0; i < (int)esignlen; i++)
9636 for (i = zeros; i; i--)
9640 Copy(eptr, p, elen, char);
9644 memset(p, ' ', gap);
9649 Copy(dotstr, p, dotstrlen, char);
9653 vectorize = FALSE; /* done iterating over vecstr */
9660 SvCUR_set(sv, p - SvPVX_const(sv));
9668 /* =========================================================================
9670 =head1 Cloning an interpreter
9672 All the macros and functions in this section are for the private use of
9673 the main function, perl_clone().
9675 The foo_dup() functions make an exact copy of an existing foo thinngy.
9676 During the course of a cloning, a hash table is used to map old addresses
9677 to new addresses. The table is created and manipulated with the
9678 ptr_table_* functions.
9682 ============================================================================*/
9685 #if defined(USE_ITHREADS)
9687 #ifndef GpREFCNT_inc
9688 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9692 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9693 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9694 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9695 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9696 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9697 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9698 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9699 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9700 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9701 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9702 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9703 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9704 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9707 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9708 regcomp.c. AMS 20010712 */
9711 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9716 struct reg_substr_datum *s;
9719 return (REGEXP *)NULL;
9721 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9724 len = r->offsets[0];
9725 npar = r->nparens+1;
9727 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9728 Copy(r->program, ret->program, len+1, regnode);
9730 Newx(ret->startp, npar, I32);
9731 Copy(r->startp, ret->startp, npar, I32);
9732 Newx(ret->endp, npar, I32);
9733 Copy(r->startp, ret->startp, npar, I32);
9735 Newx(ret->substrs, 1, struct reg_substr_data);
9736 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9737 s->min_offset = r->substrs->data[i].min_offset;
9738 s->max_offset = r->substrs->data[i].max_offset;
9739 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9740 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9743 ret->regstclass = NULL;
9746 const int count = r->data->count;
9749 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9750 char, struct reg_data);
9751 Newx(d->what, count, U8);
9754 for (i = 0; i < count; i++) {
9755 d->what[i] = r->data->what[i];
9756 switch (d->what[i]) {
9757 /* legal options are one of: sfpont
9758 see also regcomp.h and pregfree() */
9760 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9763 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9766 /* This is cheating. */
9767 Newx(d->data[i], 1, struct regnode_charclass_class);
9768 StructCopy(r->data->data[i], d->data[i],
9769 struct regnode_charclass_class);
9770 ret->regstclass = (regnode*)d->data[i];
9773 /* Compiled op trees are readonly, and can thus be
9774 shared without duplication. */
9776 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9780 d->data[i] = r->data->data[i];
9783 d->data[i] = r->data->data[i];
9785 ((reg_trie_data*)d->data[i])->refcount++;
9789 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9798 Newx(ret->offsets, 2*len+1, U32);
9799 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9801 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9802 ret->refcnt = r->refcnt;
9803 ret->minlen = r->minlen;
9804 ret->prelen = r->prelen;
9805 ret->nparens = r->nparens;
9806 ret->lastparen = r->lastparen;
9807 ret->lastcloseparen = r->lastcloseparen;
9808 ret->reganch = r->reganch;
9810 ret->sublen = r->sublen;
9812 if (RX_MATCH_COPIED(ret))
9813 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9815 ret->subbeg = Nullch;
9816 #ifdef PERL_OLD_COPY_ON_WRITE
9817 ret->saved_copy = Nullsv;
9820 ptr_table_store(PL_ptr_table, r, ret);
9824 /* duplicate a file handle */
9827 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9831 PERL_UNUSED_ARG(type);
9834 return (PerlIO*)NULL;
9836 /* look for it in the table first */
9837 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9841 /* create anew and remember what it is */
9842 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9843 ptr_table_store(PL_ptr_table, fp, ret);
9847 /* duplicate a directory handle */
9850 Perl_dirp_dup(pTHX_ DIR *dp)
9858 /* duplicate a typeglob */
9861 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9866 /* look for it in the table first */
9867 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9871 /* create anew and remember what it is */
9873 ptr_table_store(PL_ptr_table, gp, ret);
9876 ret->gp_refcnt = 0; /* must be before any other dups! */
9877 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9878 ret->gp_io = io_dup_inc(gp->gp_io, param);
9879 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9880 ret->gp_av = av_dup_inc(gp->gp_av, param);
9881 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9882 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9883 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9884 ret->gp_cvgen = gp->gp_cvgen;
9885 ret->gp_line = gp->gp_line;
9886 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9890 /* duplicate a chain of magic */
9893 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9895 MAGIC *mgprev = (MAGIC*)NULL;
9898 return (MAGIC*)NULL;
9899 /* look for it in the table first */
9900 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9904 for (; mg; mg = mg->mg_moremagic) {
9906 Newxz(nmg, 1, MAGIC);
9908 mgprev->mg_moremagic = nmg;
9911 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9912 nmg->mg_private = mg->mg_private;
9913 nmg->mg_type = mg->mg_type;
9914 nmg->mg_flags = mg->mg_flags;
9915 if (mg->mg_type == PERL_MAGIC_qr) {
9916 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9918 else if(mg->mg_type == PERL_MAGIC_backref) {
9919 const AV * const av = (AV*) mg->mg_obj;
9922 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9924 for (i = AvFILLp(av); i >= 0; i--) {
9925 if (!svp[i]) continue;
9926 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9929 else if (mg->mg_type == PERL_MAGIC_symtab) {
9930 nmg->mg_obj = mg->mg_obj;
9933 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9934 ? sv_dup_inc(mg->mg_obj, param)
9935 : sv_dup(mg->mg_obj, param);
9937 nmg->mg_len = mg->mg_len;
9938 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9939 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9940 if (mg->mg_len > 0) {
9941 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9942 if (mg->mg_type == PERL_MAGIC_overload_table &&
9943 AMT_AMAGIC((AMT*)mg->mg_ptr))
9945 AMT *amtp = (AMT*)mg->mg_ptr;
9946 AMT *namtp = (AMT*)nmg->mg_ptr;
9948 for (i = 1; i < NofAMmeth; i++) {
9949 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9953 else if (mg->mg_len == HEf_SVKEY)
9954 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9956 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9957 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9964 /* create a new pointer-mapping table */
9967 Perl_ptr_table_new(pTHX)
9970 Newxz(tbl, 1, PTR_TBL_t);
9973 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9978 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9980 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9983 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
9985 /* map an existing pointer using a table */
9988 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9990 PTR_TBL_ENT_t *tblent;
9991 const UV hash = PTR_TABLE_HASH(sv);
9993 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9994 for (; tblent; tblent = tblent->next) {
9995 if (tblent->oldval == sv)
9996 return tblent->newval;
10001 /* add a new entry to a pointer-mapping table */
10004 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10006 PTR_TBL_ENT_t *tblent, **otblent;
10007 /* XXX this may be pessimal on platforms where pointers aren't good
10008 * hash values e.g. if they grow faster in the most significant
10010 const UV hash = PTR_TABLE_HASH(oldsv);
10014 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10015 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10016 if (tblent->oldval == oldsv) {
10017 tblent->newval = newsv;
10021 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
10022 sizeof(struct ptr_tbl_ent));
10023 tblent->oldval = oldsv;
10024 tblent->newval = newsv;
10025 tblent->next = *otblent;
10028 if (!empty && tbl->tbl_items > tbl->tbl_max)
10029 ptr_table_split(tbl);
10032 /* double the hash bucket size of an existing ptr table */
10035 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10037 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10038 const UV oldsize = tbl->tbl_max + 1;
10039 UV newsize = oldsize * 2;
10042 Renew(ary, newsize, PTR_TBL_ENT_t*);
10043 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10044 tbl->tbl_max = --newsize;
10045 tbl->tbl_ary = ary;
10046 for (i=0; i < oldsize; i++, ary++) {
10047 PTR_TBL_ENT_t **curentp, **entp, *ent;
10050 curentp = ary + oldsize;
10051 for (entp = ary, ent = *ary; ent; ent = *entp) {
10052 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10054 ent->next = *curentp;
10064 /* remove all the entries from a ptr table */
10067 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10069 register PTR_TBL_ENT_t **array;
10070 register PTR_TBL_ENT_t *entry;
10074 if (!tbl || !tbl->tbl_items) {
10078 array = tbl->tbl_ary;
10080 max = tbl->tbl_max;
10084 PTR_TBL_ENT_t *oentry = entry;
10085 entry = entry->next;
10089 if (++riter > max) {
10092 entry = array[riter];
10096 tbl->tbl_items = 0;
10099 /* clear and free a ptr table */
10102 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10107 ptr_table_clear(tbl);
10108 Safefree(tbl->tbl_ary);
10114 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10117 SvRV_set(dstr, SvWEAKREF(sstr)
10118 ? sv_dup(SvRV(sstr), param)
10119 : sv_dup_inc(SvRV(sstr), param));
10122 else if (SvPVX_const(sstr)) {
10123 /* Has something there */
10125 /* Normal PV - clone whole allocated space */
10126 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10127 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10128 /* Not that normal - actually sstr is copy on write.
10129 But we are a true, independant SV, so: */
10130 SvREADONLY_off(dstr);
10135 /* Special case - not normally malloced for some reason */
10136 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10137 /* A "shared" PV - clone it as "shared" PV */
10139 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10143 /* Some other special case - random pointer */
10144 SvPV_set(dstr, SvPVX(sstr));
10149 /* Copy the Null */
10150 if (SvTYPE(dstr) == SVt_RV)
10151 SvRV_set(dstr, NULL);
10157 /* duplicate an SV of any type (including AV, HV etc) */
10160 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10165 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10167 /* look for it in the table first */
10168 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10172 if(param->flags & CLONEf_JOIN_IN) {
10173 /** We are joining here so we don't want do clone
10174 something that is bad **/
10175 const char *hvname;
10177 if(SvTYPE(sstr) == SVt_PVHV &&
10178 (hvname = HvNAME_get(sstr))) {
10179 /** don't clone stashes if they already exist **/
10180 return (SV*)gv_stashpv(hvname,0);
10184 /* create anew and remember what it is */
10187 #ifdef DEBUG_LEAKING_SCALARS
10188 dstr->sv_debug_optype = sstr->sv_debug_optype;
10189 dstr->sv_debug_line = sstr->sv_debug_line;
10190 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10191 dstr->sv_debug_cloned = 1;
10193 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10195 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10199 ptr_table_store(PL_ptr_table, sstr, dstr);
10202 SvFLAGS(dstr) = SvFLAGS(sstr);
10203 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10204 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10207 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10208 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10209 PL_watch_pvx, SvPVX_const(sstr));
10212 /* don't clone objects whose class has asked us not to */
10213 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10214 SvFLAGS(dstr) &= ~SVTYPEMASK;
10215 SvOBJECT_off(dstr);
10219 switch (SvTYPE(sstr)) {
10221 SvANY(dstr) = NULL;
10224 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10225 SvIV_set(dstr, SvIVX(sstr));
10228 SvANY(dstr) = new_XNV();
10229 SvNV_set(dstr, SvNVX(sstr));
10232 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10233 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10237 /* These are all the types that need complex bodies allocating. */
10238 size_t new_body_length;
10239 size_t new_body_offset = 0;
10240 void **new_body_arena;
10241 void **new_body_arenaroot;
10244 switch (SvTYPE(sstr)) {
10246 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10251 new_body = new_XPVIO();
10252 new_body_length = sizeof(XPVIO);
10255 new_body = new_XPVFM();
10256 new_body_length = sizeof(XPVFM);
10260 new_body_arena = (void **) &PL_xpvhv_root;
10261 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10262 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10263 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10264 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10265 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10269 new_body_arena = (void **) &PL_xpvav_root;
10270 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10271 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10272 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10273 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10274 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10278 new_body_length = sizeof(XPVBM);
10279 new_body_arena = (void **) &PL_xpvbm_root;
10280 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10283 if (GvUNIQUE((GV*)sstr)) {
10284 /* Do sharing here. */
10286 new_body_length = sizeof(XPVGV);
10287 new_body_arena = (void **) &PL_xpvgv_root;
10288 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10291 new_body_length = sizeof(XPVCV);
10292 new_body_arena = (void **) &PL_xpvcv_root;
10293 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10296 new_body_length = sizeof(XPVLV);
10297 new_body_arena = (void **) &PL_xpvlv_root;
10298 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10301 new_body_length = sizeof(XPVMG);
10302 new_body_arena = (void **) &PL_xpvmg_root;
10303 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10306 new_body_length = sizeof(XPVNV);
10307 new_body_arena = (void **) &PL_xpvnv_root;
10308 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10311 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10312 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10313 new_body_length = sizeof(XPVIV) - new_body_offset;
10314 new_body_arena = (void **) &PL_xpviv_root;
10315 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10318 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10319 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10320 new_body_length = sizeof(XPV) - new_body_offset;
10321 new_body_arena = (void **) &PL_xpv_root;
10322 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10324 assert(new_body_length);
10326 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10328 new_body = (void*)((char*)new_body - new_body_offset);
10330 /* We always allocated the full length item with PURIFY */
10331 new_body_length += new_body_offset;
10332 new_body_offset = 0;
10333 new_body = my_safemalloc(new_body_length);
10337 SvANY(dstr) = new_body;
10339 Copy(((char*)SvANY(sstr)) + new_body_offset,
10340 ((char*)SvANY(dstr)) + new_body_offset,
10341 new_body_length, char);
10343 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10344 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10346 /* The Copy above means that all the source (unduplicated) pointers
10347 are now in the destination. We can check the flags and the
10348 pointers in either, but it's possible that there's less cache
10349 missing by always going for the destination.
10350 FIXME - instrument and check that assumption */
10351 if (SvTYPE(sstr) >= SVt_PVMG) {
10353 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10355 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10358 switch (SvTYPE(sstr)) {
10370 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10371 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10372 LvTARG(dstr) = dstr;
10373 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10374 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10376 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10379 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10380 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10381 /* Don't call sv_add_backref here as it's going to be created
10382 as part of the magic cloning of the symbol table. */
10383 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10384 (void)GpREFCNT_inc(GvGP(dstr));
10387 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10388 if (IoOFP(dstr) == IoIFP(sstr))
10389 IoOFP(dstr) = IoIFP(dstr);
10391 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10392 /* PL_rsfp_filters entries have fake IoDIRP() */
10393 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10394 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10395 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10396 /* I have no idea why fake dirp (rsfps)
10397 should be treated differently but otherwise
10398 we end up with leaks -- sky*/
10399 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10400 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10401 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10403 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10404 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10405 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10407 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10408 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10409 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10412 if (AvARRAY((AV*)sstr)) {
10413 SV **dst_ary, **src_ary;
10414 SSize_t items = AvFILLp((AV*)sstr) + 1;
10416 src_ary = AvARRAY((AV*)sstr);
10417 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10418 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10419 SvPV_set(dstr, (char*)dst_ary);
10420 AvALLOC((AV*)dstr) = dst_ary;
10421 if (AvREAL((AV*)sstr)) {
10422 while (items-- > 0)
10423 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10426 while (items-- > 0)
10427 *dst_ary++ = sv_dup(*src_ary++, param);
10429 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10430 while (items-- > 0) {
10431 *dst_ary++ = &PL_sv_undef;
10435 SvPV_set(dstr, Nullch);
10436 AvALLOC((AV*)dstr) = (SV**)NULL;
10443 if (HvARRAY((HV*)sstr)) {
10445 const bool sharekeys = !!HvSHAREKEYS(sstr);
10446 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10447 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10449 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10450 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10452 HvARRAY(dstr) = (HE**)darray;
10453 while (i <= sxhv->xhv_max) {
10454 const HE *source = HvARRAY(sstr)[i];
10455 HvARRAY(dstr)[i] = source
10456 ? he_dup(source, sharekeys, param) : 0;
10460 struct xpvhv_aux *saux = HvAUX(sstr);
10461 struct xpvhv_aux *daux = HvAUX(dstr);
10462 /* This flag isn't copied. */
10463 /* SvOOK_on(hv) attacks the IV flags. */
10464 SvFLAGS(dstr) |= SVf_OOK;
10466 hvname = saux->xhv_name;
10468 = hvname ? hek_dup(hvname, param) : hvname;
10470 daux->xhv_riter = saux->xhv_riter;
10471 daux->xhv_eiter = saux->xhv_eiter
10472 ? he_dup(saux->xhv_eiter,
10473 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10477 SvPV_set(dstr, Nullch);
10479 /* Record stashes for possible cloning in Perl_clone(). */
10481 av_push(param->stashes, dstr);
10486 /* NOTE: not refcounted */
10487 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10489 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10491 if (CvCONST(dstr)) {
10492 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10493 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10494 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10496 /* don't dup if copying back - CvGV isn't refcounted, so the
10497 * duped GV may never be freed. A bit of a hack! DAPM */
10498 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10499 Nullgv : gv_dup(CvGV(dstr), param) ;
10500 if (!(param->flags & CLONEf_COPY_STACKS)) {
10503 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10505 CvWEAKOUTSIDE(sstr)
10506 ? cv_dup( CvOUTSIDE(dstr), param)
10507 : cv_dup_inc(CvOUTSIDE(dstr), param);
10509 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10515 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10521 /* duplicate a context */
10524 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10526 PERL_CONTEXT *ncxs;
10529 return (PERL_CONTEXT*)NULL;
10531 /* look for it in the table first */
10532 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10536 /* create anew and remember what it is */
10537 Newxz(ncxs, max + 1, PERL_CONTEXT);
10538 ptr_table_store(PL_ptr_table, cxs, ncxs);
10541 PERL_CONTEXT *cx = &cxs[ix];
10542 PERL_CONTEXT *ncx = &ncxs[ix];
10543 ncx->cx_type = cx->cx_type;
10544 if (CxTYPE(cx) == CXt_SUBST) {
10545 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10548 ncx->blk_oldsp = cx->blk_oldsp;
10549 ncx->blk_oldcop = cx->blk_oldcop;
10550 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10551 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10552 ncx->blk_oldpm = cx->blk_oldpm;
10553 ncx->blk_gimme = cx->blk_gimme;
10554 switch (CxTYPE(cx)) {
10556 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10557 ? cv_dup_inc(cx->blk_sub.cv, param)
10558 : cv_dup(cx->blk_sub.cv,param));
10559 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10560 ? av_dup_inc(cx->blk_sub.argarray, param)
10562 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10563 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10564 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10565 ncx->blk_sub.lval = cx->blk_sub.lval;
10566 ncx->blk_sub.retop = cx->blk_sub.retop;
10569 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10570 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10571 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10572 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10573 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10574 ncx->blk_eval.retop = cx->blk_eval.retop;
10577 ncx->blk_loop.label = cx->blk_loop.label;
10578 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10579 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10580 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10581 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10582 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10583 ? cx->blk_loop.iterdata
10584 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10585 ncx->blk_loop.oldcomppad
10586 = (PAD*)ptr_table_fetch(PL_ptr_table,
10587 cx->blk_loop.oldcomppad);
10588 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10589 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10590 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10591 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10592 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10595 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10596 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10597 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10598 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10599 ncx->blk_sub.retop = cx->blk_sub.retop;
10611 /* duplicate a stack info structure */
10614 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10619 return (PERL_SI*)NULL;
10621 /* look for it in the table first */
10622 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10626 /* create anew and remember what it is */
10627 Newxz(nsi, 1, PERL_SI);
10628 ptr_table_store(PL_ptr_table, si, nsi);
10630 nsi->si_stack = av_dup_inc(si->si_stack, param);
10631 nsi->si_cxix = si->si_cxix;
10632 nsi->si_cxmax = si->si_cxmax;
10633 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10634 nsi->si_type = si->si_type;
10635 nsi->si_prev = si_dup(si->si_prev, param);
10636 nsi->si_next = si_dup(si->si_next, param);
10637 nsi->si_markoff = si->si_markoff;
10642 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10643 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10644 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10645 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10646 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10647 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10648 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10649 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10650 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10651 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10652 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10653 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10654 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10655 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10658 #define pv_dup_inc(p) SAVEPV(p)
10659 #define pv_dup(p) SAVEPV(p)
10660 #define svp_dup_inc(p,pp) any_dup(p,pp)
10662 /* map any object to the new equivent - either something in the
10663 * ptr table, or something in the interpreter structure
10667 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10672 return (void*)NULL;
10674 /* look for it in the table first */
10675 ret = ptr_table_fetch(PL_ptr_table, v);
10679 /* see if it is part of the interpreter structure */
10680 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10681 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10689 /* duplicate the save stack */
10692 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10694 ANY * const ss = proto_perl->Tsavestack;
10695 const I32 max = proto_perl->Tsavestack_max;
10696 I32 ix = proto_perl->Tsavestack_ix;
10708 void (*dptr) (void*);
10709 void (*dxptr) (pTHX_ void*);
10711 Newxz(nss, max, ANY);
10714 I32 i = POPINT(ss,ix);
10715 TOPINT(nss,ix) = i;
10717 case SAVEt_ITEM: /* normal string */
10718 sv = (SV*)POPPTR(ss,ix);
10719 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10720 sv = (SV*)POPPTR(ss,ix);
10721 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10723 case SAVEt_SV: /* scalar reference */
10724 sv = (SV*)POPPTR(ss,ix);
10725 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10726 gv = (GV*)POPPTR(ss,ix);
10727 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10729 case SAVEt_GENERIC_PVREF: /* generic char* */
10730 c = (char*)POPPTR(ss,ix);
10731 TOPPTR(nss,ix) = pv_dup(c);
10732 ptr = POPPTR(ss,ix);
10733 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10735 case SAVEt_SHARED_PVREF: /* char* in shared space */
10736 c = (char*)POPPTR(ss,ix);
10737 TOPPTR(nss,ix) = savesharedpv(c);
10738 ptr = POPPTR(ss,ix);
10739 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10741 case SAVEt_GENERIC_SVREF: /* generic sv */
10742 case SAVEt_SVREF: /* scalar reference */
10743 sv = (SV*)POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10745 ptr = POPPTR(ss,ix);
10746 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10748 case SAVEt_AV: /* array reference */
10749 av = (AV*)POPPTR(ss,ix);
10750 TOPPTR(nss,ix) = av_dup_inc(av, param);
10751 gv = (GV*)POPPTR(ss,ix);
10752 TOPPTR(nss,ix) = gv_dup(gv, param);
10754 case SAVEt_HV: /* hash reference */
10755 hv = (HV*)POPPTR(ss,ix);
10756 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10757 gv = (GV*)POPPTR(ss,ix);
10758 TOPPTR(nss,ix) = gv_dup(gv, param);
10760 case SAVEt_INT: /* int reference */
10761 ptr = POPPTR(ss,ix);
10762 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10763 intval = (int)POPINT(ss,ix);
10764 TOPINT(nss,ix) = intval;
10766 case SAVEt_LONG: /* long reference */
10767 ptr = POPPTR(ss,ix);
10768 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10769 longval = (long)POPLONG(ss,ix);
10770 TOPLONG(nss,ix) = longval;
10772 case SAVEt_I32: /* I32 reference */
10773 case SAVEt_I16: /* I16 reference */
10774 case SAVEt_I8: /* I8 reference */
10775 ptr = POPPTR(ss,ix);
10776 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10778 TOPINT(nss,ix) = i;
10780 case SAVEt_IV: /* IV reference */
10781 ptr = POPPTR(ss,ix);
10782 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10784 TOPIV(nss,ix) = iv;
10786 case SAVEt_SPTR: /* SV* reference */
10787 ptr = POPPTR(ss,ix);
10788 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10789 sv = (SV*)POPPTR(ss,ix);
10790 TOPPTR(nss,ix) = sv_dup(sv, param);
10792 case SAVEt_VPTR: /* random* reference */
10793 ptr = POPPTR(ss,ix);
10794 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10795 ptr = POPPTR(ss,ix);
10796 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10798 case SAVEt_PPTR: /* char* reference */
10799 ptr = POPPTR(ss,ix);
10800 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10801 c = (char*)POPPTR(ss,ix);
10802 TOPPTR(nss,ix) = pv_dup(c);
10804 case SAVEt_HPTR: /* HV* reference */
10805 ptr = POPPTR(ss,ix);
10806 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10807 hv = (HV*)POPPTR(ss,ix);
10808 TOPPTR(nss,ix) = hv_dup(hv, param);
10810 case SAVEt_APTR: /* AV* reference */
10811 ptr = POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10813 av = (AV*)POPPTR(ss,ix);
10814 TOPPTR(nss,ix) = av_dup(av, param);
10817 gv = (GV*)POPPTR(ss,ix);
10818 TOPPTR(nss,ix) = gv_dup(gv, param);
10820 case SAVEt_GP: /* scalar reference */
10821 gp = (GP*)POPPTR(ss,ix);
10822 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10823 (void)GpREFCNT_inc(gp);
10824 gv = (GV*)POPPTR(ss,ix);
10825 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10826 c = (char*)POPPTR(ss,ix);
10827 TOPPTR(nss,ix) = pv_dup(c);
10829 TOPIV(nss,ix) = iv;
10831 TOPIV(nss,ix) = iv;
10834 case SAVEt_MORTALIZESV:
10835 sv = (SV*)POPPTR(ss,ix);
10836 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10839 ptr = POPPTR(ss,ix);
10840 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10841 /* these are assumed to be refcounted properly */
10843 switch (((OP*)ptr)->op_type) {
10845 case OP_LEAVESUBLV:
10849 case OP_LEAVEWRITE:
10850 TOPPTR(nss,ix) = ptr;
10855 TOPPTR(nss,ix) = Nullop;
10860 TOPPTR(nss,ix) = Nullop;
10863 c = (char*)POPPTR(ss,ix);
10864 TOPPTR(nss,ix) = pv_dup_inc(c);
10866 case SAVEt_CLEARSV:
10867 longval = POPLONG(ss,ix);
10868 TOPLONG(nss,ix) = longval;
10871 hv = (HV*)POPPTR(ss,ix);
10872 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10873 c = (char*)POPPTR(ss,ix);
10874 TOPPTR(nss,ix) = pv_dup_inc(c);
10876 TOPINT(nss,ix) = i;
10878 case SAVEt_DESTRUCTOR:
10879 ptr = POPPTR(ss,ix);
10880 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10881 dptr = POPDPTR(ss,ix);
10882 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10883 any_dup(FPTR2DPTR(void *, dptr),
10886 case SAVEt_DESTRUCTOR_X:
10887 ptr = POPPTR(ss,ix);
10888 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10889 dxptr = POPDXPTR(ss,ix);
10890 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10891 any_dup(FPTR2DPTR(void *, dxptr),
10894 case SAVEt_REGCONTEXT:
10897 TOPINT(nss,ix) = i;
10900 case SAVEt_STACK_POS: /* Position on Perl stack */
10902 TOPINT(nss,ix) = i;
10904 case SAVEt_AELEM: /* array element */
10905 sv = (SV*)POPPTR(ss,ix);
10906 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10908 TOPINT(nss,ix) = i;
10909 av = (AV*)POPPTR(ss,ix);
10910 TOPPTR(nss,ix) = av_dup_inc(av, param);
10912 case SAVEt_HELEM: /* hash element */
10913 sv = (SV*)POPPTR(ss,ix);
10914 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10915 sv = (SV*)POPPTR(ss,ix);
10916 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10917 hv = (HV*)POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10921 ptr = POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = ptr;
10926 TOPINT(nss,ix) = i;
10928 case SAVEt_COMPPAD:
10929 av = (AV*)POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = av_dup(av, param);
10933 longval = (long)POPLONG(ss,ix);
10934 TOPLONG(nss,ix) = longval;
10935 ptr = POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10937 sv = (SV*)POPPTR(ss,ix);
10938 TOPPTR(nss,ix) = sv_dup(sv, param);
10941 ptr = POPPTR(ss,ix);
10942 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10943 longval = (long)POPBOOL(ss,ix);
10944 TOPBOOL(nss,ix) = (bool)longval;
10946 case SAVEt_SET_SVFLAGS:
10948 TOPINT(nss,ix) = i;
10950 TOPINT(nss,ix) = i;
10951 sv = (SV*)POPPTR(ss,ix);
10952 TOPPTR(nss,ix) = sv_dup(sv, param);
10955 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10963 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10964 * flag to the result. This is done for each stash before cloning starts,
10965 * so we know which stashes want their objects cloned */
10968 do_mark_cloneable_stash(pTHX_ SV *sv)
10970 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10972 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10973 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10974 if (cloner && GvCV(cloner)) {
10981 XPUSHs(sv_2mortal(newSVhek(hvname)));
10983 call_sv((SV*)GvCV(cloner), G_SCALAR);
10990 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10998 =for apidoc perl_clone
11000 Create and return a new interpreter by cloning the current one.
11002 perl_clone takes these flags as parameters:
11004 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11005 without it we only clone the data and zero the stacks,
11006 with it we copy the stacks and the new perl interpreter is
11007 ready to run at the exact same point as the previous one.
11008 The pseudo-fork code uses COPY_STACKS while the
11009 threads->new doesn't.
11011 CLONEf_KEEP_PTR_TABLE
11012 perl_clone keeps a ptr_table with the pointer of the old
11013 variable as a key and the new variable as a value,
11014 this allows it to check if something has been cloned and not
11015 clone it again but rather just use the value and increase the
11016 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11017 the ptr_table using the function
11018 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11019 reason to keep it around is if you want to dup some of your own
11020 variable who are outside the graph perl scans, example of this
11021 code is in threads.xs create
11024 This is a win32 thing, it is ignored on unix, it tells perls
11025 win32host code (which is c++) to clone itself, this is needed on
11026 win32 if you want to run two threads at the same time,
11027 if you just want to do some stuff in a separate perl interpreter
11028 and then throw it away and return to the original one,
11029 you don't need to do anything.
11034 /* XXX the above needs expanding by someone who actually understands it ! */
11035 EXTERN_C PerlInterpreter *
11036 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11039 perl_clone(PerlInterpreter *proto_perl, UV flags)
11042 #ifdef PERL_IMPLICIT_SYS
11044 /* perlhost.h so we need to call into it
11045 to clone the host, CPerlHost should have a c interface, sky */
11047 if (flags & CLONEf_CLONE_HOST) {
11048 return perl_clone_host(proto_perl,flags);
11050 return perl_clone_using(proto_perl, flags,
11052 proto_perl->IMemShared,
11053 proto_perl->IMemParse,
11055 proto_perl->IStdIO,
11059 proto_perl->IProc);
11063 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11064 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11065 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11066 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11067 struct IPerlDir* ipD, struct IPerlSock* ipS,
11068 struct IPerlProc* ipP)
11070 /* XXX many of the string copies here can be optimized if they're
11071 * constants; they need to be allocated as common memory and just
11072 * their pointers copied. */
11075 CLONE_PARAMS clone_params;
11076 CLONE_PARAMS* param = &clone_params;
11078 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11079 /* for each stash, determine whether its objects should be cloned */
11080 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11081 PERL_SET_THX(my_perl);
11084 Poison(my_perl, 1, PerlInterpreter);
11086 PL_curcop = (COP *)Nullop;
11090 PL_savestack_ix = 0;
11091 PL_savestack_max = -1;
11092 PL_sig_pending = 0;
11093 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11094 # else /* !DEBUGGING */
11095 Zero(my_perl, 1, PerlInterpreter);
11096 # endif /* DEBUGGING */
11098 /* host pointers */
11100 PL_MemShared = ipMS;
11101 PL_MemParse = ipMP;
11108 #else /* !PERL_IMPLICIT_SYS */
11110 CLONE_PARAMS clone_params;
11111 CLONE_PARAMS* param = &clone_params;
11112 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11113 /* for each stash, determine whether its objects should be cloned */
11114 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11115 PERL_SET_THX(my_perl);
11118 Poison(my_perl, 1, PerlInterpreter);
11120 PL_curcop = (COP *)Nullop;
11124 PL_savestack_ix = 0;
11125 PL_savestack_max = -1;
11126 PL_sig_pending = 0;
11127 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11128 # else /* !DEBUGGING */
11129 Zero(my_perl, 1, PerlInterpreter);
11130 # endif /* DEBUGGING */
11131 #endif /* PERL_IMPLICIT_SYS */
11132 param->flags = flags;
11133 param->proto_perl = proto_perl;
11136 PL_xnv_arenaroot = NULL;
11137 PL_xnv_root = NULL;
11138 PL_xpv_arenaroot = NULL;
11139 PL_xpv_root = NULL;
11140 PL_xpviv_arenaroot = NULL;
11141 PL_xpviv_root = NULL;
11142 PL_xpvnv_arenaroot = NULL;
11143 PL_xpvnv_root = NULL;
11144 PL_xpvcv_arenaroot = NULL;
11145 PL_xpvcv_root = NULL;
11146 PL_xpvav_arenaroot = NULL;
11147 PL_xpvav_root = NULL;
11148 PL_xpvhv_arenaroot = NULL;
11149 PL_xpvhv_root = NULL;
11150 PL_xpvmg_arenaroot = NULL;
11151 PL_xpvmg_root = NULL;
11152 PL_xpvgv_arenaroot = NULL;
11153 PL_xpvgv_root = NULL;
11154 PL_xpvlv_arenaroot = NULL;
11155 PL_xpvlv_root = NULL;
11156 PL_xpvbm_arenaroot = NULL;
11157 PL_xpvbm_root = NULL;
11158 PL_he_arenaroot = NULL;
11160 #if defined(USE_ITHREADS)
11161 PL_pte_arenaroot = NULL;
11162 PL_pte_root = NULL;
11164 PL_nice_chunk = NULL;
11165 PL_nice_chunk_size = 0;
11167 PL_sv_objcount = 0;
11168 PL_sv_root = Nullsv;
11169 PL_sv_arenaroot = Nullsv;
11171 PL_debug = proto_perl->Idebug;
11173 PL_hash_seed = proto_perl->Ihash_seed;
11174 PL_rehash_seed = proto_perl->Irehash_seed;
11176 #ifdef USE_REENTRANT_API
11177 /* XXX: things like -Dm will segfault here in perlio, but doing
11178 * PERL_SET_CONTEXT(proto_perl);
11179 * breaks too many other things
11181 Perl_reentrant_init(aTHX);
11184 /* create SV map for pointer relocation */
11185 PL_ptr_table = ptr_table_new();
11187 /* initialize these special pointers as early as possible */
11188 SvANY(&PL_sv_undef) = NULL;
11189 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11190 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11191 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11193 SvANY(&PL_sv_no) = new_XPVNV();
11194 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11195 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11196 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11197 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11198 SvCUR_set(&PL_sv_no, 0);
11199 SvLEN_set(&PL_sv_no, 1);
11200 SvIV_set(&PL_sv_no, 0);
11201 SvNV_set(&PL_sv_no, 0);
11202 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11204 SvANY(&PL_sv_yes) = new_XPVNV();
11205 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11206 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11207 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11208 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11209 SvCUR_set(&PL_sv_yes, 1);
11210 SvLEN_set(&PL_sv_yes, 2);
11211 SvIV_set(&PL_sv_yes, 1);
11212 SvNV_set(&PL_sv_yes, 1);
11213 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11215 /* create (a non-shared!) shared string table */
11216 PL_strtab = newHV();
11217 HvSHAREKEYS_off(PL_strtab);
11218 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11219 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11221 PL_compiling = proto_perl->Icompiling;
11223 /* These two PVs will be free'd special way so must set them same way op.c does */
11224 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11225 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11227 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11228 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11230 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11231 if (!specialWARN(PL_compiling.cop_warnings))
11232 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11233 if (!specialCopIO(PL_compiling.cop_io))
11234 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11235 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11237 /* pseudo environmental stuff */
11238 PL_origargc = proto_perl->Iorigargc;
11239 PL_origargv = proto_perl->Iorigargv;
11241 param->stashes = newAV(); /* Setup array of objects to call clone on */
11243 /* Set tainting stuff before PerlIO_debug can possibly get called */
11244 PL_tainting = proto_perl->Itainting;
11245 PL_taint_warn = proto_perl->Itaint_warn;
11247 #ifdef PERLIO_LAYERS
11248 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11249 PerlIO_clone(aTHX_ proto_perl, param);
11252 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11253 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11254 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11255 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11256 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11257 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11260 PL_minus_c = proto_perl->Iminus_c;
11261 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11262 PL_localpatches = proto_perl->Ilocalpatches;
11263 PL_splitstr = proto_perl->Isplitstr;
11264 PL_preprocess = proto_perl->Ipreprocess;
11265 PL_minus_n = proto_perl->Iminus_n;
11266 PL_minus_p = proto_perl->Iminus_p;
11267 PL_minus_l = proto_perl->Iminus_l;
11268 PL_minus_a = proto_perl->Iminus_a;
11269 PL_minus_F = proto_perl->Iminus_F;
11270 PL_doswitches = proto_perl->Idoswitches;
11271 PL_dowarn = proto_perl->Idowarn;
11272 PL_doextract = proto_perl->Idoextract;
11273 PL_sawampersand = proto_perl->Isawampersand;
11274 PL_unsafe = proto_perl->Iunsafe;
11275 PL_inplace = SAVEPV(proto_perl->Iinplace);
11276 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11277 PL_perldb = proto_perl->Iperldb;
11278 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11279 PL_exit_flags = proto_perl->Iexit_flags;
11281 /* magical thingies */
11282 /* XXX time(&PL_basetime) when asked for? */
11283 PL_basetime = proto_perl->Ibasetime;
11284 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11286 PL_maxsysfd = proto_perl->Imaxsysfd;
11287 PL_multiline = proto_perl->Imultiline;
11288 PL_statusvalue = proto_perl->Istatusvalue;
11290 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11292 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11294 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11296 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11297 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11298 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11300 /* Clone the regex array */
11301 PL_regex_padav = newAV();
11303 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11304 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11306 av_push(PL_regex_padav,
11307 sv_dup_inc(regexen[0],param));
11308 for(i = 1; i <= len; i++) {
11309 if(SvREPADTMP(regexen[i])) {
11310 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11312 av_push(PL_regex_padav,
11314 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11315 SvIVX(regexen[i])), param)))
11320 PL_regex_pad = AvARRAY(PL_regex_padav);
11322 /* shortcuts to various I/O objects */
11323 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11324 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11325 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11326 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11327 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11328 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11330 /* shortcuts to regexp stuff */
11331 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11333 /* shortcuts to misc objects */
11334 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11336 /* shortcuts to debugging objects */
11337 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11338 PL_DBline = gv_dup(proto_perl->IDBline, param);
11339 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11340 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11341 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11342 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11343 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11344 PL_lineary = av_dup(proto_perl->Ilineary, param);
11345 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11347 /* symbol tables */
11348 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11349 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11350 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11351 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11352 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11354 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11355 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11356 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11357 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11358 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11359 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11361 PL_sub_generation = proto_perl->Isub_generation;
11363 /* funky return mechanisms */
11364 PL_forkprocess = proto_perl->Iforkprocess;
11366 /* subprocess state */
11367 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11369 /* internal state */
11370 PL_maxo = proto_perl->Imaxo;
11371 if (proto_perl->Iop_mask)
11372 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11374 PL_op_mask = Nullch;
11375 /* PL_asserting = proto_perl->Iasserting; */
11377 /* current interpreter roots */
11378 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11379 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11380 PL_main_start = proto_perl->Imain_start;
11381 PL_eval_root = proto_perl->Ieval_root;
11382 PL_eval_start = proto_perl->Ieval_start;
11384 /* runtime control stuff */
11385 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11386 PL_copline = proto_perl->Icopline;
11388 PL_filemode = proto_perl->Ifilemode;
11389 PL_lastfd = proto_perl->Ilastfd;
11390 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11393 PL_gensym = proto_perl->Igensym;
11394 PL_preambled = proto_perl->Ipreambled;
11395 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11396 PL_laststatval = proto_perl->Ilaststatval;
11397 PL_laststype = proto_perl->Ilaststype;
11398 PL_mess_sv = Nullsv;
11400 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11402 /* interpreter atexit processing */
11403 PL_exitlistlen = proto_perl->Iexitlistlen;
11404 if (PL_exitlistlen) {
11405 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11406 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11409 PL_exitlist = (PerlExitListEntry*)NULL;
11410 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11411 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11412 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11414 PL_profiledata = NULL;
11415 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11416 /* PL_rsfp_filters entries have fake IoDIRP() */
11417 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11419 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11421 PAD_CLONE_VARS(proto_perl, param);
11423 #ifdef HAVE_INTERP_INTERN
11424 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11427 /* more statics moved here */
11428 PL_generation = proto_perl->Igeneration;
11429 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11431 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11432 PL_in_clean_all = proto_perl->Iin_clean_all;
11434 PL_uid = proto_perl->Iuid;
11435 PL_euid = proto_perl->Ieuid;
11436 PL_gid = proto_perl->Igid;
11437 PL_egid = proto_perl->Iegid;
11438 PL_nomemok = proto_perl->Inomemok;
11439 PL_an = proto_perl->Ian;
11440 PL_evalseq = proto_perl->Ievalseq;
11441 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11442 PL_origalen = proto_perl->Iorigalen;
11443 #ifdef PERL_USES_PL_PIDSTATUS
11444 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11446 PL_osname = SAVEPV(proto_perl->Iosname);
11447 PL_sighandlerp = proto_perl->Isighandlerp;
11449 PL_runops = proto_perl->Irunops;
11451 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11454 PL_cshlen = proto_perl->Icshlen;
11455 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11458 PL_lex_state = proto_perl->Ilex_state;
11459 PL_lex_defer = proto_perl->Ilex_defer;
11460 PL_lex_expect = proto_perl->Ilex_expect;
11461 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11462 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11463 PL_lex_starts = proto_perl->Ilex_starts;
11464 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11465 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11466 PL_lex_op = proto_perl->Ilex_op;
11467 PL_lex_inpat = proto_perl->Ilex_inpat;
11468 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11469 PL_lex_brackets = proto_perl->Ilex_brackets;
11470 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11471 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11472 PL_lex_casemods = proto_perl->Ilex_casemods;
11473 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11474 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11476 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11477 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11478 PL_nexttoke = proto_perl->Inexttoke;
11480 /* XXX This is probably masking the deeper issue of why
11481 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11482 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11483 * (A little debugging with a watchpoint on it may help.)
11485 if (SvANY(proto_perl->Ilinestr)) {
11486 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11487 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11488 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11489 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11490 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11491 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11492 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11493 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11494 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11497 PL_linestr = NEWSV(65,79);
11498 sv_upgrade(PL_linestr,SVt_PVIV);
11499 sv_setpvn(PL_linestr,"",0);
11500 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11502 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11503 PL_pending_ident = proto_perl->Ipending_ident;
11504 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11506 PL_expect = proto_perl->Iexpect;
11508 PL_multi_start = proto_perl->Imulti_start;
11509 PL_multi_end = proto_perl->Imulti_end;
11510 PL_multi_open = proto_perl->Imulti_open;
11511 PL_multi_close = proto_perl->Imulti_close;
11513 PL_error_count = proto_perl->Ierror_count;
11514 PL_subline = proto_perl->Isubline;
11515 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11517 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11518 if (SvANY(proto_perl->Ilinestr)) {
11519 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11520 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11521 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11522 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11523 PL_last_lop_op = proto_perl->Ilast_lop_op;
11526 PL_last_uni = SvPVX(PL_linestr);
11527 PL_last_lop = SvPVX(PL_linestr);
11528 PL_last_lop_op = 0;
11530 PL_in_my = proto_perl->Iin_my;
11531 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11533 PL_cryptseen = proto_perl->Icryptseen;
11536 PL_hints = proto_perl->Ihints;
11538 PL_amagic_generation = proto_perl->Iamagic_generation;
11540 #ifdef USE_LOCALE_COLLATE
11541 PL_collation_ix = proto_perl->Icollation_ix;
11542 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11543 PL_collation_standard = proto_perl->Icollation_standard;
11544 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11545 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11546 #endif /* USE_LOCALE_COLLATE */
11548 #ifdef USE_LOCALE_NUMERIC
11549 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11550 PL_numeric_standard = proto_perl->Inumeric_standard;
11551 PL_numeric_local = proto_perl->Inumeric_local;
11552 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11553 #endif /* !USE_LOCALE_NUMERIC */
11555 /* utf8 character classes */
11556 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11557 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11558 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11559 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11560 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11561 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11562 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11563 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11564 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11565 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11566 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11567 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11568 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11569 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11570 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11571 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11572 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11573 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11574 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11575 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11577 /* Did the locale setup indicate UTF-8? */
11578 PL_utf8locale = proto_perl->Iutf8locale;
11579 /* Unicode features (see perlrun/-C) */
11580 PL_unicode = proto_perl->Iunicode;
11582 /* Pre-5.8 signals control */
11583 PL_signals = proto_perl->Isignals;
11585 /* times() ticks per second */
11586 PL_clocktick = proto_perl->Iclocktick;
11588 /* Recursion stopper for PerlIO_find_layer */
11589 PL_in_load_module = proto_perl->Iin_load_module;
11591 /* sort() routine */
11592 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11594 /* Not really needed/useful since the reenrant_retint is "volatile",
11595 * but do it for consistency's sake. */
11596 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11598 /* Hooks to shared SVs and locks. */
11599 PL_sharehook = proto_perl->Isharehook;
11600 PL_lockhook = proto_perl->Ilockhook;
11601 PL_unlockhook = proto_perl->Iunlockhook;
11602 PL_threadhook = proto_perl->Ithreadhook;
11604 PL_runops_std = proto_perl->Irunops_std;
11605 PL_runops_dbg = proto_perl->Irunops_dbg;
11607 #ifdef THREADS_HAVE_PIDS
11608 PL_ppid = proto_perl->Ippid;
11612 PL_last_swash_hv = Nullhv; /* reinits on demand */
11613 PL_last_swash_klen = 0;
11614 PL_last_swash_key[0]= '\0';
11615 PL_last_swash_tmps = (U8*)NULL;
11616 PL_last_swash_slen = 0;
11618 PL_glob_index = proto_perl->Iglob_index;
11619 PL_srand_called = proto_perl->Isrand_called;
11620 PL_uudmap['M'] = 0; /* reinits on demand */
11621 PL_bitcount = Nullch; /* reinits on demand */
11623 if (proto_perl->Ipsig_pend) {
11624 Newxz(PL_psig_pend, SIG_SIZE, int);
11627 PL_psig_pend = (int*)NULL;
11630 if (proto_perl->Ipsig_ptr) {
11631 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11632 Newxz(PL_psig_name, SIG_SIZE, SV*);
11633 for (i = 1; i < SIG_SIZE; i++) {
11634 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11635 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11639 PL_psig_ptr = (SV**)NULL;
11640 PL_psig_name = (SV**)NULL;
11643 /* thrdvar.h stuff */
11645 if (flags & CLONEf_COPY_STACKS) {
11646 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11647 PL_tmps_ix = proto_perl->Ttmps_ix;
11648 PL_tmps_max = proto_perl->Ttmps_max;
11649 PL_tmps_floor = proto_perl->Ttmps_floor;
11650 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11652 while (i <= PL_tmps_ix) {
11653 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11657 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11658 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11659 Newxz(PL_markstack, i, I32);
11660 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11661 - proto_perl->Tmarkstack);
11662 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11663 - proto_perl->Tmarkstack);
11664 Copy(proto_perl->Tmarkstack, PL_markstack,
11665 PL_markstack_ptr - PL_markstack + 1, I32);
11667 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11668 * NOTE: unlike the others! */
11669 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11670 PL_scopestack_max = proto_perl->Tscopestack_max;
11671 Newxz(PL_scopestack, PL_scopestack_max, I32);
11672 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11674 /* NOTE: si_dup() looks at PL_markstack */
11675 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11677 /* PL_curstack = PL_curstackinfo->si_stack; */
11678 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11679 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11681 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11682 PL_stack_base = AvARRAY(PL_curstack);
11683 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11684 - proto_perl->Tstack_base);
11685 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11687 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11688 * NOTE: unlike the others! */
11689 PL_savestack_ix = proto_perl->Tsavestack_ix;
11690 PL_savestack_max = proto_perl->Tsavestack_max;
11691 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11692 PL_savestack = ss_dup(proto_perl, param);
11696 ENTER; /* perl_destruct() wants to LEAVE; */
11699 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11700 PL_top_env = &PL_start_env;
11702 PL_op = proto_perl->Top;
11705 PL_Xpv = (XPV*)NULL;
11706 PL_na = proto_perl->Tna;
11708 PL_statbuf = proto_perl->Tstatbuf;
11709 PL_statcache = proto_perl->Tstatcache;
11710 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11711 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11713 PL_timesbuf = proto_perl->Ttimesbuf;
11716 PL_tainted = proto_perl->Ttainted;
11717 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11718 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11719 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11720 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11721 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11722 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11723 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11724 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11725 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11727 PL_restartop = proto_perl->Trestartop;
11728 PL_in_eval = proto_perl->Tin_eval;
11729 PL_delaymagic = proto_perl->Tdelaymagic;
11730 PL_dirty = proto_perl->Tdirty;
11731 PL_localizing = proto_perl->Tlocalizing;
11733 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11734 PL_hv_fetch_ent_mh = Nullhe;
11735 PL_modcount = proto_perl->Tmodcount;
11736 PL_lastgotoprobe = Nullop;
11737 PL_dumpindent = proto_perl->Tdumpindent;
11739 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11740 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11741 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11742 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11743 PL_sortcxix = proto_perl->Tsortcxix;
11744 PL_efloatbuf = Nullch; /* reinits on demand */
11745 PL_efloatsize = 0; /* reinits on demand */
11749 PL_screamfirst = NULL;
11750 PL_screamnext = NULL;
11751 PL_maxscream = -1; /* reinits on demand */
11752 PL_lastscream = Nullsv;
11754 PL_watchaddr = NULL;
11755 PL_watchok = Nullch;
11757 PL_regdummy = proto_perl->Tregdummy;
11758 PL_regprecomp = Nullch;
11761 PL_colorset = 0; /* reinits PL_colors[] */
11762 /*PL_colors[6] = {0,0,0,0,0,0};*/
11763 PL_reginput = Nullch;
11764 PL_regbol = Nullch;
11765 PL_regeol = Nullch;
11766 PL_regstartp = (I32*)NULL;
11767 PL_regendp = (I32*)NULL;
11768 PL_reglastparen = (U32*)NULL;
11769 PL_reglastcloseparen = (U32*)NULL;
11770 PL_regtill = Nullch;
11771 PL_reg_start_tmp = (char**)NULL;
11772 PL_reg_start_tmpl = 0;
11773 PL_regdata = (struct reg_data*)NULL;
11776 PL_reg_eval_set = 0;
11778 PL_regprogram = (regnode*)NULL;
11780 PL_regcc = (CURCUR*)NULL;
11781 PL_reg_call_cc = (struct re_cc_state*)NULL;
11782 PL_reg_re = (regexp*)NULL;
11783 PL_reg_ganch = Nullch;
11784 PL_reg_sv = Nullsv;
11785 PL_reg_match_utf8 = FALSE;
11786 PL_reg_magic = (MAGIC*)NULL;
11788 PL_reg_oldcurpm = (PMOP*)NULL;
11789 PL_reg_curpm = (PMOP*)NULL;
11790 PL_reg_oldsaved = Nullch;
11791 PL_reg_oldsavedlen = 0;
11792 #ifdef PERL_OLD_COPY_ON_WRITE
11795 PL_reg_maxiter = 0;
11796 PL_reg_leftiter = 0;
11797 PL_reg_poscache = Nullch;
11798 PL_reg_poscache_size= 0;
11800 /* RE engine - function pointers */
11801 PL_regcompp = proto_perl->Tregcompp;
11802 PL_regexecp = proto_perl->Tregexecp;
11803 PL_regint_start = proto_perl->Tregint_start;
11804 PL_regint_string = proto_perl->Tregint_string;
11805 PL_regfree = proto_perl->Tregfree;
11807 PL_reginterp_cnt = 0;
11808 PL_reg_starttry = 0;
11810 /* Pluggable optimizer */
11811 PL_peepp = proto_perl->Tpeepp;
11813 PL_stashcache = newHV();
11815 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11816 ptr_table_free(PL_ptr_table);
11817 PL_ptr_table = NULL;
11820 /* Call the ->CLONE method, if it exists, for each of the stashes
11821 identified by sv_dup() above.
11823 while(av_len(param->stashes) != -1) {
11824 HV* const stash = (HV*) av_shift(param->stashes);
11825 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11826 if (cloner && GvCV(cloner)) {
11831 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11833 call_sv((SV*)GvCV(cloner), G_DISCARD);
11839 SvREFCNT_dec(param->stashes);
11841 /* orphaned? eg threads->new inside BEGIN or use */
11842 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11843 (void)SvREFCNT_inc(PL_compcv);
11844 SAVEFREESV(PL_compcv);
11850 #endif /* USE_ITHREADS */
11853 =head1 Unicode Support
11855 =for apidoc sv_recode_to_utf8
11857 The encoding is assumed to be an Encode object, on entry the PV
11858 of the sv is assumed to be octets in that encoding, and the sv
11859 will be converted into Unicode (and UTF-8).
11861 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11862 is not a reference, nothing is done to the sv. If the encoding is not
11863 an C<Encode::XS> Encoding object, bad things will happen.
11864 (See F<lib/encoding.pm> and L<Encode>).
11866 The PV of the sv is returned.
11871 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11874 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11888 Passing sv_yes is wrong - it needs to be or'ed set of constants
11889 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11890 remove converted chars from source.
11892 Both will default the value - let them.
11894 XPUSHs(&PL_sv_yes);
11897 call_method("decode", G_SCALAR);
11901 s = SvPV_const(uni, len);
11902 if (s != SvPVX_const(sv)) {
11903 SvGROW(sv, len + 1);
11904 Move(s, SvPVX(sv), len + 1, char);
11905 SvCUR_set(sv, len);
11912 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11916 =for apidoc sv_cat_decode
11918 The encoding is assumed to be an Encode object, the PV of the ssv is
11919 assumed to be octets in that encoding and decoding the input starts
11920 from the position which (PV + *offset) pointed to. The dsv will be
11921 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11922 when the string tstr appears in decoding output or the input ends on
11923 the PV of the ssv. The value which the offset points will be modified
11924 to the last input position on the ssv.
11926 Returns TRUE if the terminator was found, else returns FALSE.
11931 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11932 SV *ssv, int *offset, char *tstr, int tlen)
11936 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11947 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11948 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11950 call_method("cat_decode", G_SCALAR);
11952 ret = SvTRUE(TOPs);
11953 *offset = SvIV(offsv);
11959 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11965 * c-indentation-style: bsd
11966 * c-basic-offset: 4
11967 * indent-tabs-mode: t
11970 * ex: set ts=8 sts=4 sw=4 noet: