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)));
2904 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2905 * UV as a string towards the end of buf, and return pointers to start and
2908 * We assume that buf is at least TYPE_CHARS(UV) long.
2912 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2914 char *ptr = buf + TYPE_CHARS(UV);
2915 char * const ebuf = ptr;
2928 *--ptr = '0' + (char)(uv % 10);
2937 =for apidoc sv_2pv_flags
2939 Returns a pointer to the string value of an SV, and sets *lp to its length.
2940 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2942 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2943 usually end up here too.
2949 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2954 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2955 char *tmpbuf = tbuf;
2956 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
2963 if (SvGMAGICAL(sv)) {
2964 if (flags & SV_GMAGIC)
2969 if (flags & SV_MUTABLE_RETURN)
2970 return SvPVX_mutable(sv);
2971 if (flags & SV_CONST_RETURN)
2972 return (char *)SvPVX_const(sv);
2976 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2977 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2979 goto tokensave_has_len;
2982 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2987 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2988 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2996 if (SvTHINKFIRST(sv)) {
2999 register const char *typestr;
3000 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3001 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3003 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3006 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3007 if (flags & SV_CONST_RETURN) {
3008 pv = (char *) SvPVX_const(tmpstr);
3010 pv = (flags & SV_MUTABLE_RETURN)
3011 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3014 *lp = SvCUR(tmpstr);
3016 pv = sv_2pv_flags(tmpstr, lp, flags);
3027 typestr = "NULLREF";
3031 switch (SvTYPE(sv)) {
3033 if ( ((SvFLAGS(sv) &
3034 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3035 == (SVs_OBJECT|SVs_SMG))
3036 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3037 const regexp *re = (regexp *)mg->mg_obj;
3040 const char *fptr = "msix";
3045 char need_newline = 0;
3046 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3048 while((ch = *fptr++)) {
3050 reflags[left++] = ch;
3053 reflags[right--] = ch;
3058 reflags[left] = '-';
3062 mg->mg_len = re->prelen + 4 + left;
3064 * If /x was used, we have to worry about a regex
3065 * ending with a comment later being embedded
3066 * within another regex. If so, we don't want this
3067 * regex's "commentization" to leak out to the
3068 * right part of the enclosing regex, we must cap
3069 * it with a newline.
3071 * So, if /x was used, we scan backwards from the
3072 * end of the regex. If we find a '#' before we
3073 * find a newline, we need to add a newline
3074 * ourself. If we find a '\n' first (or if we
3075 * don't find '#' or '\n'), we don't need to add
3076 * anything. -jfriedl
3078 if (PMf_EXTENDED & re->reganch)
3080 const char *endptr = re->precomp + re->prelen;
3081 while (endptr >= re->precomp)
3083 const char c = *(endptr--);
3085 break; /* don't need another */
3087 /* we end while in a comment, so we
3089 mg->mg_len++; /* save space for it */
3090 need_newline = 1; /* note to add it */
3096 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3097 Copy("(?", mg->mg_ptr, 2, char);
3098 Copy(reflags, mg->mg_ptr+2, left, char);
3099 Copy(":", mg->mg_ptr+left+2, 1, char);
3100 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3102 mg->mg_ptr[mg->mg_len - 2] = '\n';
3103 mg->mg_ptr[mg->mg_len - 1] = ')';
3104 mg->mg_ptr[mg->mg_len] = 0;
3106 PL_reginterp_cnt += re->program[0].next_off;
3108 if (re->reganch & ROPT_UTF8)
3124 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3125 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3126 /* tied lvalues should appear to be
3127 * scalars for backwards compatitbility */
3128 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3129 ? "SCALAR" : "LVALUE"; break;
3130 case SVt_PVAV: typestr = "ARRAY"; break;
3131 case SVt_PVHV: typestr = "HASH"; break;
3132 case SVt_PVCV: typestr = "CODE"; break;
3133 case SVt_PVGV: typestr = "GLOB"; break;
3134 case SVt_PVFM: typestr = "FORMAT"; break;
3135 case SVt_PVIO: typestr = "IO"; break;
3136 default: typestr = "UNKNOWN"; break;
3140 const char * const name = HvNAME_get(SvSTASH(sv));
3141 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3142 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3145 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3149 *lp = strlen(typestr);
3150 return (char *)typestr;
3152 if (SvREADONLY(sv) && !SvOK(sv)) {
3153 if (ckWARN(WARN_UNINITIALIZED))
3160 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3161 /* I'm assuming that if both IV and NV are equally valid then
3162 converting the IV is going to be more efficient */
3163 const U32 isIOK = SvIOK(sv);
3164 const U32 isUIOK = SvIsUV(sv);
3165 char buf[TYPE_CHARS(UV)];
3168 if (SvTYPE(sv) < SVt_PVIV)
3169 sv_upgrade(sv, SVt_PVIV);
3171 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3173 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3174 /* inlined from sv_setpvn */
3175 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3176 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3177 SvCUR_set(sv, ebuf - ptr);
3187 else if (SvNOKp(sv)) {
3188 if (SvTYPE(sv) < SVt_PVNV)
3189 sv_upgrade(sv, SVt_PVNV);
3190 /* The +20 is pure guesswork. Configure test needed. --jhi */
3191 s = SvGROW_mutable(sv, NV_DIG + 20);
3192 olderrno = errno; /* some Xenix systems wipe out errno here */
3194 if (SvNVX(sv) == 0.0)
3195 (void)strcpy(s,"0");
3199 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3202 #ifdef FIXNEGATIVEZERO
3203 if (*s == '-' && s[1] == '0' && !s[2])
3213 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3217 if (SvTYPE(sv) < SVt_PV)
3218 /* Typically the caller expects that sv_any is not NULL now. */
3219 sv_upgrade(sv, SVt_PV);
3223 const STRLEN len = s - SvPVX_const(sv);
3229 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3230 PTR2UV(sv),SvPVX_const(sv)));
3231 if (flags & SV_CONST_RETURN)
3232 return (char *)SvPVX_const(sv);
3233 if (flags & SV_MUTABLE_RETURN)
3234 return SvPVX_mutable(sv);
3238 len = strlen(tmpbuf);
3241 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3242 /* Sneaky stuff here */
3246 tsv = newSVpvn(tmpbuf, len);
3255 #ifdef FIXNEGATIVEZERO
3256 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
3262 SvUPGRADE(sv, SVt_PV);
3265 s = SvGROW_mutable(sv, len + 1);
3268 return memcpy(s, tmpbuf, len + 1);
3273 =for apidoc sv_copypv
3275 Copies a stringified representation of the source SV into the
3276 destination SV. Automatically performs any necessary mg_get and
3277 coercion of numeric values into strings. Guaranteed to preserve
3278 UTF-8 flag even from overloaded objects. Similar in nature to
3279 sv_2pv[_flags] but operates directly on an SV instead of just the
3280 string. Mostly uses sv_2pv_flags to do its work, except when that
3281 would lose the UTF-8'ness of the PV.
3287 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3290 const char * const s = SvPV_const(ssv,len);
3291 sv_setpvn(dsv,s,len);
3299 =for apidoc sv_2pvbyte
3301 Return a pointer to the byte-encoded representation of the SV, and set *lp
3302 to its length. May cause the SV to be downgraded from UTF-8 as a
3305 Usually accessed via the C<SvPVbyte> macro.
3311 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3313 sv_utf8_downgrade(sv,0);
3314 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3318 * =for apidoc sv_2pvutf8
3320 * Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3321 * to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3323 * Usually accessed via the C<SvPVutf8> macro.
3329 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3331 sv_utf8_upgrade(sv);
3332 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3337 =for apidoc sv_2bool
3339 This function is only called on magical items, and is only used by
3340 sv_true() or its macro equivalent.
3346 Perl_sv_2bool(pTHX_ register SV *sv)
3354 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3355 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3356 return (bool)SvTRUE(tmpsv);
3357 return SvRV(sv) != 0;
3360 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3362 (*sv->sv_u.svu_pv > '0' ||
3363 Xpvtmp->xpv_cur > 1 ||
3364 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3371 return SvIVX(sv) != 0;
3374 return SvNVX(sv) != 0.0;
3382 =for apidoc sv_utf8_upgrade
3384 Converts the PV of an SV to its UTF-8-encoded form.
3385 Forces the SV to string form if it is not already.
3386 Always sets the SvUTF8 flag to avoid future validity checks even
3387 if all the bytes have hibit clear.
3389 This is not as a general purpose byte encoding to Unicode interface:
3390 use the Encode extension for that.
3392 =for apidoc sv_utf8_upgrade_flags
3394 Converts the PV of an SV to its UTF-8-encoded form.
3395 Forces the SV to string form if it is not already.
3396 Always sets the SvUTF8 flag to avoid future validity checks even
3397 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3398 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3399 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3401 This is not as a general purpose byte encoding to Unicode interface:
3402 use the Encode extension for that.
3408 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3410 if (sv == &PL_sv_undef)
3414 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3415 (void) sv_2pv_flags(sv,&len, flags);
3419 (void) SvPV_force(sv,len);
3428 sv_force_normal_flags(sv, 0);
3431 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3432 sv_recode_to_utf8(sv, PL_encoding);
3433 else { /* Assume Latin-1/EBCDIC */
3434 /* This function could be much more efficient if we
3435 * had a FLAG in SVs to signal if there are any hibit
3436 * chars in the PV. Given that there isn't such a flag
3437 * make the loop as fast as possible. */
3438 const U8 *s = (U8 *) SvPVX_const(sv);
3439 const U8 * const e = (U8 *) SvEND(sv);
3445 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3449 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3450 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3452 SvPV_free(sv); /* No longer using what was there before. */
3454 SvPV_set(sv, (char*)recoded);
3455 SvCUR_set(sv, len - 1);
3456 SvLEN_set(sv, len); /* No longer know the real size. */
3458 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3465 =for apidoc sv_utf8_downgrade
3467 Attempts to convert the PV of an SV from characters to bytes.
3468 If the PV contains a character beyond byte, this conversion will fail;
3469 in this case, either returns false or, if C<fail_ok> is not
3472 This is not as a general purpose Unicode to byte encoding interface:
3473 use the Encode extension for that.
3479 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3481 if (SvPOKp(sv) && SvUTF8(sv)) {
3487 sv_force_normal_flags(sv, 0);
3489 s = (U8 *) SvPV(sv, len);
3490 if (!utf8_to_bytes(s, &len)) {
3495 Perl_croak(aTHX_ "Wide character in %s",
3498 Perl_croak(aTHX_ "Wide character");
3509 =for apidoc sv_utf8_encode
3511 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3512 flag off so that it looks like octets again.
3518 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3520 (void) sv_utf8_upgrade(sv);
3522 sv_force_normal_flags(sv, 0);
3524 if (SvREADONLY(sv)) {
3525 Perl_croak(aTHX_ PL_no_modify);
3531 =for apidoc sv_utf8_decode
3533 If the PV of the SV is an octet sequence in UTF-8
3534 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3535 so that it looks like a character. If the PV contains only single-byte
3536 characters, the C<SvUTF8> flag stays being off.
3537 Scans PV for validity and returns false if the PV is invalid UTF-8.
3543 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3549 /* The octets may have got themselves encoded - get them back as
3552 if (!sv_utf8_downgrade(sv, TRUE))
3555 /* it is actually just a matter of turning the utf8 flag on, but
3556 * we want to make sure everything inside is valid utf8 first.
3558 c = (const U8 *) SvPVX_const(sv);
3559 if (!is_utf8_string(c, SvCUR(sv)+1))
3561 e = (const U8 *) SvEND(sv);
3564 if (!UTF8_IS_INVARIANT(ch)) {
3574 =for apidoc sv_setsv
3576 Copies the contents of the source SV C<ssv> into the destination SV
3577 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3578 function if the source SV needs to be reused. Does not handle 'set' magic.
3579 Loosely speaking, it performs a copy-by-value, obliterating any previous
3580 content of the destination.
3582 You probably want to use one of the assortment of wrappers, such as
3583 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3584 C<SvSetMagicSV_nosteal>.
3586 =for apidoc sv_setsv_flags
3588 Copies the contents of the source SV C<ssv> into the destination SV
3589 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3590 function if the source SV needs to be reused. Does not handle 'set' magic.
3591 Loosely speaking, it performs a copy-by-value, obliterating any previous
3592 content of the destination.
3593 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3594 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3595 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3596 and C<sv_setsv_nomg> are implemented in terms of this function.
3598 You probably want to use one of the assortment of wrappers, such as
3599 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3600 C<SvSetMagicSV_nosteal>.
3602 This is the primary function for copying scalars, and most other
3603 copy-ish functions and macros use this underneath.
3609 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3611 register U32 sflags;
3617 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3619 sstr = &PL_sv_undef;
3620 stype = SvTYPE(sstr);
3621 dtype = SvTYPE(dstr);
3626 /* need to nuke the magic */
3628 SvRMAGICAL_off(dstr);
3631 /* There's a lot of redundancy below but we're going for speed here */
3636 if (dtype != SVt_PVGV) {
3637 (void)SvOK_off(dstr);
3645 sv_upgrade(dstr, SVt_IV);
3648 sv_upgrade(dstr, SVt_PVNV);
3652 sv_upgrade(dstr, SVt_PVIV);
3655 (void)SvIOK_only(dstr);
3656 SvIV_set(dstr, SvIVX(sstr));
3659 if (SvTAINTED(sstr))
3670 sv_upgrade(dstr, SVt_NV);
3675 sv_upgrade(dstr, SVt_PVNV);
3678 SvNV_set(dstr, SvNVX(sstr));
3679 (void)SvNOK_only(dstr);
3680 if (SvTAINTED(sstr))
3688 sv_upgrade(dstr, SVt_RV);
3689 else if (dtype == SVt_PVGV &&
3690 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3693 if (GvIMPORTED(dstr) != GVf_IMPORTED
3694 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3696 GvIMPORTED_on(dstr);
3705 #ifdef PERL_OLD_COPY_ON_WRITE
3706 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3707 if (dtype < SVt_PVIV)
3708 sv_upgrade(dstr, SVt_PVIV);
3715 sv_upgrade(dstr, SVt_PV);
3718 if (dtype < SVt_PVIV)
3719 sv_upgrade(dstr, SVt_PVIV);
3722 if (dtype < SVt_PVNV)
3723 sv_upgrade(dstr, SVt_PVNV);
3730 const char * const type = sv_reftype(sstr,0);
3732 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3734 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3739 if (dtype <= SVt_PVGV) {
3741 if (dtype != SVt_PVGV) {
3742 const char * const name = GvNAME(sstr);
3743 const STRLEN len = GvNAMELEN(sstr);
3744 /* don't upgrade SVt_PVLV: it can hold a glob */
3745 if (dtype != SVt_PVLV)
3746 sv_upgrade(dstr, SVt_PVGV);
3747 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3748 GvSTASH(dstr) = GvSTASH(sstr);
3750 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3751 GvNAME(dstr) = savepvn(name, len);
3752 GvNAMELEN(dstr) = len;
3753 SvFAKE_on(dstr); /* can coerce to non-glob */
3756 #ifdef GV_UNIQUE_CHECK
3757 if (GvUNIQUE((GV*)dstr)) {
3758 Perl_croak(aTHX_ PL_no_modify);
3762 (void)SvOK_off(dstr);
3763 GvINTRO_off(dstr); /* one-shot flag */
3765 GvGP(dstr) = gp_ref(GvGP(sstr));
3766 if (SvTAINTED(sstr))
3768 if (GvIMPORTED(dstr) != GVf_IMPORTED
3769 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3771 GvIMPORTED_on(dstr);
3779 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3781 if ((int)SvTYPE(sstr) != stype) {
3782 stype = SvTYPE(sstr);
3783 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3787 if (stype == SVt_PVLV)
3788 SvUPGRADE(dstr, SVt_PVNV);
3790 SvUPGRADE(dstr, (U32)stype);
3793 sflags = SvFLAGS(sstr);
3795 if (sflags & SVf_ROK) {
3796 if (dtype >= SVt_PV) {
3797 if (dtype == SVt_PVGV) {
3798 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3800 const int intro = GvINTRO(dstr);
3802 #ifdef GV_UNIQUE_CHECK
3803 if (GvUNIQUE((GV*)dstr)) {
3804 Perl_croak(aTHX_ PL_no_modify);
3809 GvINTRO_off(dstr); /* one-shot flag */
3810 GvLINE(dstr) = CopLINE(PL_curcop);
3811 GvEGV(dstr) = (GV*)dstr;
3814 switch (SvTYPE(sref)) {
3817 SAVEGENERICSV(GvAV(dstr));
3819 dref = (SV*)GvAV(dstr);
3820 GvAV(dstr) = (AV*)sref;
3821 if (!GvIMPORTED_AV(dstr)
3822 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3824 GvIMPORTED_AV_on(dstr);
3829 SAVEGENERICSV(GvHV(dstr));
3831 dref = (SV*)GvHV(dstr);
3832 GvHV(dstr) = (HV*)sref;
3833 if (!GvIMPORTED_HV(dstr)
3834 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3836 GvIMPORTED_HV_on(dstr);
3841 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3842 SvREFCNT_dec(GvCV(dstr));
3843 GvCV(dstr) = Nullcv;
3844 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3845 PL_sub_generation++;
3847 SAVEGENERICSV(GvCV(dstr));
3850 dref = (SV*)GvCV(dstr);
3851 if (GvCV(dstr) != (CV*)sref) {
3852 CV* const cv = GvCV(dstr);
3854 if (!GvCVGEN((GV*)dstr) &&
3855 (CvROOT(cv) || CvXSUB(cv)))
3857 /* Redefining a sub - warning is mandatory if
3858 it was a const and its value changed. */
3859 if (ckWARN(WARN_REDEFINE)
3861 && (!CvCONST((CV*)sref)
3862 || sv_cmp(cv_const_sv(cv),
3863 cv_const_sv((CV*)sref)))))
3865 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3867 ? "Constant subroutine %s::%s redefined"
3868 : "Subroutine %s::%s redefined",
3869 HvNAME_get(GvSTASH((GV*)dstr)),
3870 GvENAME((GV*)dstr));
3874 cv_ckproto(cv, (GV*)dstr,
3876 ? SvPVX_const(sref) : Nullch);
3878 GvCV(dstr) = (CV*)sref;
3879 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3880 GvASSUMECV_on(dstr);
3881 PL_sub_generation++;
3883 if (!GvIMPORTED_CV(dstr)
3884 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3886 GvIMPORTED_CV_on(dstr);
3891 SAVEGENERICSV(GvIOp(dstr));
3893 dref = (SV*)GvIOp(dstr);
3894 GvIOp(dstr) = (IO*)sref;
3898 SAVEGENERICSV(GvFORM(dstr));
3900 dref = (SV*)GvFORM(dstr);
3901 GvFORM(dstr) = (CV*)sref;
3905 SAVEGENERICSV(GvSV(dstr));
3907 dref = (SV*)GvSV(dstr);
3909 if (!GvIMPORTED_SV(dstr)
3910 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3912 GvIMPORTED_SV_on(dstr);
3918 if (SvTAINTED(sstr))
3922 if (SvPVX_const(dstr)) {
3928 (void)SvOK_off(dstr);
3929 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3931 if (sflags & SVp_NOK) {
3933 /* Only set the public OK flag if the source has public OK. */
3934 if (sflags & SVf_NOK)
3935 SvFLAGS(dstr) |= SVf_NOK;
3936 SvNV_set(dstr, SvNVX(sstr));
3938 if (sflags & SVp_IOK) {
3939 (void)SvIOKp_on(dstr);
3940 if (sflags & SVf_IOK)
3941 SvFLAGS(dstr) |= SVf_IOK;
3942 if (sflags & SVf_IVisUV)
3944 SvIV_set(dstr, SvIVX(sstr));
3946 if (SvAMAGIC(sstr)) {
3950 else if (sflags & SVp_POK) {
3954 * Check to see if we can just swipe the string. If so, it's a
3955 * possible small lose on short strings, but a big win on long ones.
3956 * It might even be a win on short strings if SvPVX_const(dstr)
3957 * has to be allocated and SvPVX_const(sstr) has to be freed.
3960 /* Whichever path we take through the next code, we want this true,
3961 and doing it now facilitates the COW check. */
3962 (void)SvPOK_only(dstr);
3965 /* We're not already COW */
3966 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3967 #ifndef PERL_OLD_COPY_ON_WRITE
3968 /* or we are, but dstr isn't a suitable target. */
3969 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3974 (sflags & SVs_TEMP) && /* slated for free anyway? */
3975 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3976 (!(flags & SV_NOSTEAL)) &&
3977 /* and we're allowed to steal temps */
3978 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3979 SvLEN(sstr) && /* and really is a string */
3980 /* and won't be needed again, potentially */
3981 !(PL_op && PL_op->op_type == OP_AASSIGN))
3982 #ifdef PERL_OLD_COPY_ON_WRITE
3983 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3984 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3985 && SvTYPE(sstr) >= SVt_PVIV)
3988 /* Failed the swipe test, and it's not a shared hash key either.
3989 Have to copy the string. */
3990 STRLEN len = SvCUR(sstr);
3991 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3992 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3993 SvCUR_set(dstr, len);
3994 *SvEND(dstr) = '\0';
3996 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3998 /* Either it's a shared hash key, or it's suitable for
3999 copy-on-write or we can swipe the string. */
4001 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4005 #ifdef PERL_OLD_COPY_ON_WRITE
4007 /* I believe I should acquire a global SV mutex if
4008 it's a COW sv (not a shared hash key) to stop
4009 it going un copy-on-write.
4010 If the source SV has gone un copy on write between up there
4011 and down here, then (assert() that) it is of the correct
4012 form to make it copy on write again */
4013 if ((sflags & (SVf_FAKE | SVf_READONLY))
4014 != (SVf_FAKE | SVf_READONLY)) {
4015 SvREADONLY_on(sstr);
4017 /* Make the source SV into a loop of 1.
4018 (about to become 2) */
4019 SV_COW_NEXT_SV_SET(sstr, sstr);
4023 /* Initial code is common. */
4024 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4029 /* making another shared SV. */
4030 STRLEN cur = SvCUR(sstr);
4031 STRLEN len = SvLEN(sstr);
4032 #ifdef PERL_OLD_COPY_ON_WRITE
4034 assert (SvTYPE(dstr) >= SVt_PVIV);
4035 /* SvIsCOW_normal */
4036 /* splice us in between source and next-after-source. */
4037 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4038 SV_COW_NEXT_SV_SET(sstr, dstr);
4039 SvPV_set(dstr, SvPVX_mutable(sstr));
4043 /* SvIsCOW_shared_hash */
4044 DEBUG_C(PerlIO_printf(Perl_debug_log,
4045 "Copy on write: Sharing hash\n"));
4047 assert (SvTYPE(dstr) >= SVt_PV);
4049 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4051 SvLEN_set(dstr, len);
4052 SvCUR_set(dstr, cur);
4053 SvREADONLY_on(dstr);
4055 /* Relesase a global SV mutex. */
4058 { /* Passes the swipe test. */
4059 SvPV_set(dstr, SvPVX_mutable(sstr));
4060 SvLEN_set(dstr, SvLEN(sstr));
4061 SvCUR_set(dstr, SvCUR(sstr));
4064 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4065 SvPV_set(sstr, Nullch);
4071 if (sflags & SVf_UTF8)
4073 if (sflags & SVp_NOK) {
4075 if (sflags & SVf_NOK)
4076 SvFLAGS(dstr) |= SVf_NOK;
4077 SvNV_set(dstr, SvNVX(sstr));
4079 if (sflags & SVp_IOK) {
4080 (void)SvIOKp_on(dstr);
4081 if (sflags & SVf_IOK)
4082 SvFLAGS(dstr) |= SVf_IOK;
4083 if (sflags & SVf_IVisUV)
4085 SvIV_set(dstr, SvIVX(sstr));
4088 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4089 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4090 smg->mg_ptr, smg->mg_len);
4091 SvRMAGICAL_on(dstr);
4094 else if (sflags & SVp_IOK) {
4095 if (sflags & SVf_IOK)
4096 (void)SvIOK_only(dstr);
4098 (void)SvOK_off(dstr);
4099 (void)SvIOKp_on(dstr);
4101 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4102 if (sflags & SVf_IVisUV)
4104 SvIV_set(dstr, SvIVX(sstr));
4105 if (sflags & SVp_NOK) {
4106 if (sflags & SVf_NOK)
4107 (void)SvNOK_on(dstr);
4109 (void)SvNOKp_on(dstr);
4110 SvNV_set(dstr, SvNVX(sstr));
4113 else if (sflags & SVp_NOK) {
4114 if (sflags & SVf_NOK)
4115 (void)SvNOK_only(dstr);
4117 (void)SvOK_off(dstr);
4120 SvNV_set(dstr, SvNVX(sstr));
4123 if (dtype == SVt_PVGV) {
4124 if (ckWARN(WARN_MISC))
4125 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4128 (void)SvOK_off(dstr);
4130 if (SvTAINTED(sstr))
4135 =for apidoc sv_setsv_mg
4137 Like C<sv_setsv>, but also handles 'set' magic.
4143 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4145 sv_setsv(dstr,sstr);
4149 #ifdef PERL_OLD_COPY_ON_WRITE
4151 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4153 STRLEN cur = SvCUR(sstr);
4154 STRLEN len = SvLEN(sstr);
4155 register char *new_pv;
4158 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4166 if (SvTHINKFIRST(dstr))
4167 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4168 else if (SvPVX_const(dstr))
4169 Safefree(SvPVX_const(dstr));
4173 SvUPGRADE(dstr, SVt_PVIV);
4175 assert (SvPOK(sstr));
4176 assert (SvPOKp(sstr));
4177 assert (!SvIOK(sstr));
4178 assert (!SvIOKp(sstr));
4179 assert (!SvNOK(sstr));
4180 assert (!SvNOKp(sstr));
4182 if (SvIsCOW(sstr)) {
4184 if (SvLEN(sstr) == 0) {
4185 /* source is a COW shared hash key. */
4186 DEBUG_C(PerlIO_printf(Perl_debug_log,
4187 "Fast copy on write: Sharing hash\n"));
4188 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4191 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4193 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4194 SvUPGRADE(sstr, SVt_PVIV);
4195 SvREADONLY_on(sstr);
4197 DEBUG_C(PerlIO_printf(Perl_debug_log,
4198 "Fast copy on write: Converting sstr to COW\n"));
4199 SV_COW_NEXT_SV_SET(dstr, sstr);
4201 SV_COW_NEXT_SV_SET(sstr, dstr);
4202 new_pv = SvPVX_mutable(sstr);
4205 SvPV_set(dstr, new_pv);
4206 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4209 SvLEN_set(dstr, len);
4210 SvCUR_set(dstr, cur);
4219 =for apidoc sv_setpvn
4221 Copies a string into an SV. The C<len> parameter indicates the number of
4222 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4223 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4229 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4231 register char *dptr;
4233 SV_CHECK_THINKFIRST_COW_DROP(sv);
4239 /* len is STRLEN which is unsigned, need to copy to signed */
4242 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4244 SvUPGRADE(sv, SVt_PV);
4246 dptr = SvGROW(sv, len + 1);
4247 Move(ptr,dptr,len,char);
4250 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4255 =for apidoc sv_setpvn_mg
4257 Like C<sv_setpvn>, but also handles 'set' magic.
4263 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4265 sv_setpvn(sv,ptr,len);
4270 =for apidoc sv_setpv
4272 Copies a string into an SV. The string must be null-terminated. Does not
4273 handle 'set' magic. See C<sv_setpv_mg>.
4279 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4281 register STRLEN len;
4283 SV_CHECK_THINKFIRST_COW_DROP(sv);
4289 SvUPGRADE(sv, SVt_PV);
4291 SvGROW(sv, len + 1);
4292 Move(ptr,SvPVX(sv),len+1,char);
4294 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4299 =for apidoc sv_setpv_mg
4301 Like C<sv_setpv>, but also handles 'set' magic.
4307 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4314 =for apidoc sv_usepvn
4316 Tells an SV to use C<ptr> to find its string value. Normally the string is
4317 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4318 The C<ptr> should point to memory that was allocated by C<malloc>. The
4319 string length, C<len>, must be supplied. This function will realloc the
4320 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4321 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4322 See C<sv_usepvn_mg>.
4328 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4331 SV_CHECK_THINKFIRST_COW_DROP(sv);
4332 SvUPGRADE(sv, SVt_PV);
4337 if (SvPVX_const(sv))
4340 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4341 ptr = saferealloc (ptr, allocate);
4344 SvLEN_set(sv, allocate);
4346 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4351 =for apidoc sv_usepvn_mg
4353 Like C<sv_usepvn>, but also handles 'set' magic.
4359 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4361 sv_usepvn(sv,ptr,len);
4365 #ifdef PERL_OLD_COPY_ON_WRITE
4366 /* Need to do this *after* making the SV normal, as we need the buffer
4367 pointer to remain valid until after we've copied it. If we let go too early,
4368 another thread could invalidate it by unsharing last of the same hash key
4369 (which it can do by means other than releasing copy-on-write Svs)
4370 or by changing the other copy-on-write SVs in the loop. */
4372 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4374 if (len) { /* this SV was SvIsCOW_normal(sv) */
4375 /* we need to find the SV pointing to us. */
4376 SV * const current = SV_COW_NEXT_SV(after);
4378 if (current == sv) {
4379 /* The SV we point to points back to us (there were only two of us
4381 Hence other SV is no longer copy on write either. */
4383 SvREADONLY_off(after);
4385 /* We need to follow the pointers around the loop. */
4387 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4390 /* don't loop forever if the structure is bust, and we have
4391 a pointer into a closed loop. */
4392 assert (current != after);
4393 assert (SvPVX_const(current) == pvx);
4395 /* Make the SV before us point to the SV after us. */
4396 SV_COW_NEXT_SV_SET(current, after);
4399 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4404 Perl_sv_release_IVX(pTHX_ register SV *sv)
4407 sv_force_normal_flags(sv, 0);
4413 =for apidoc sv_force_normal_flags
4415 Undo various types of fakery on an SV: if the PV is a shared string, make
4416 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4417 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4418 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4419 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4420 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4421 set to some other value.) In addition, the C<flags> parameter gets passed to
4422 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4423 with flags set to 0.
4429 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4431 #ifdef PERL_OLD_COPY_ON_WRITE
4432 if (SvREADONLY(sv)) {
4433 /* At this point I believe I should acquire a global SV mutex. */
4435 const char * const pvx = SvPVX_const(sv);
4436 const STRLEN len = SvLEN(sv);
4437 const STRLEN cur = SvCUR(sv);
4438 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4440 PerlIO_printf(Perl_debug_log,
4441 "Copy on write: Force normal %ld\n",
4447 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4448 SvPV_set(sv, (char*)0);
4450 if (flags & SV_COW_DROP_PV) {
4451 /* OK, so we don't need to copy our buffer. */
4454 SvGROW(sv, cur + 1);
4455 Move(pvx,SvPVX(sv),cur,char);
4459 sv_release_COW(sv, pvx, len, next);
4464 else if (IN_PERL_RUNTIME)
4465 Perl_croak(aTHX_ PL_no_modify);
4466 /* At this point I believe that I can drop the global SV mutex. */
4469 if (SvREADONLY(sv)) {
4471 const char * const pvx = SvPVX_const(sv);
4472 const STRLEN len = SvCUR(sv);
4475 SvPV_set(sv, Nullch);
4477 SvGROW(sv, len + 1);
4478 Move(pvx,SvPVX(sv),len,char);
4480 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4482 else if (IN_PERL_RUNTIME)
4483 Perl_croak(aTHX_ PL_no_modify);
4487 sv_unref_flags(sv, flags);
4488 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4495 Efficient removal of characters from the beginning of the string buffer.
4496 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4497 the string buffer. The C<ptr> becomes the first character of the adjusted
4498 string. Uses the "OOK hack".
4499 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4500 refer to the same chunk of data.
4506 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4508 register STRLEN delta;
4509 if (!ptr || !SvPOKp(sv))
4511 delta = ptr - SvPVX_const(sv);
4512 SV_CHECK_THINKFIRST(sv);
4513 if (SvTYPE(sv) < SVt_PVIV)
4514 sv_upgrade(sv,SVt_PVIV);
4517 if (!SvLEN(sv)) { /* make copy of shared string */
4518 const char *pvx = SvPVX_const(sv);
4519 const STRLEN len = SvCUR(sv);
4520 SvGROW(sv, len + 1);
4521 Move(pvx,SvPVX(sv),len,char);
4525 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4526 and we do that anyway inside the SvNIOK_off
4528 SvFLAGS(sv) |= SVf_OOK;
4531 SvLEN_set(sv, SvLEN(sv) - delta);
4532 SvCUR_set(sv, SvCUR(sv) - delta);
4533 SvPV_set(sv, SvPVX(sv) + delta);
4534 SvIV_set(sv, SvIVX(sv) + delta);
4538 =for apidoc sv_catpvn
4540 Concatenates the string onto the end of the string which is in the SV. The
4541 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4542 status set, then the bytes appended should be valid UTF-8.
4543 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4545 =for apidoc sv_catpvn_flags
4547 Concatenates the string onto the end of the string which is in the SV. The
4548 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4549 status set, then the bytes appended should be valid UTF-8.
4550 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4551 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4552 in terms of this function.
4558 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4561 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4563 SvGROW(dsv, dlen + slen + 1);
4565 sstr = SvPVX_const(dsv);
4566 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4567 SvCUR_set(dsv, SvCUR(dsv) + slen);
4569 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4571 if (flags & SV_SMAGIC)
4576 =for apidoc sv_catsv
4578 Concatenates the string from SV C<ssv> onto the end of the string in
4579 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4580 not 'set' magic. See C<sv_catsv_mg>.
4582 =for apidoc sv_catsv_flags
4584 Concatenates the string from SV C<ssv> onto the end of the string in
4585 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4586 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4587 and C<sv_catsv_nomg> are implemented in terms of this function.
4592 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4597 if ((spv = SvPV_const(ssv, slen))) {
4598 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4599 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4600 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4601 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4602 dsv->sv_flags doesn't have that bit set.
4603 Andy Dougherty 12 Oct 2001
4605 const I32 sutf8 = DO_UTF8(ssv);
4608 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4610 dutf8 = DO_UTF8(dsv);
4612 if (dutf8 != sutf8) {
4614 /* Not modifying source SV, so taking a temporary copy. */
4615 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4617 sv_utf8_upgrade(csv);
4618 spv = SvPV_const(csv, slen);
4621 sv_utf8_upgrade_nomg(dsv);
4623 sv_catpvn_nomg(dsv, spv, slen);
4626 if (flags & SV_SMAGIC)
4631 =for apidoc sv_catpv
4633 Concatenates the string onto the end of the string which is in the SV.
4634 If the SV has the UTF-8 status set, then the bytes appended should be
4635 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4640 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4642 register STRLEN len;
4648 junk = SvPV_force(sv, tlen);
4650 SvGROW(sv, tlen + len + 1);
4652 ptr = SvPVX_const(sv);
4653 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4654 SvCUR_set(sv, SvCUR(sv) + len);
4655 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4660 =for apidoc sv_catpv_mg
4662 Like C<sv_catpv>, but also handles 'set' magic.
4668 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4677 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4678 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4685 Perl_newSV(pTHX_ STRLEN len)
4691 sv_upgrade(sv, SVt_PV);
4692 SvGROW(sv, len + 1);
4697 =for apidoc sv_magicext
4699 Adds magic to an SV, upgrading it if necessary. Applies the
4700 supplied vtable and returns a pointer to the magic added.
4702 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4703 In particular, you can add magic to SvREADONLY SVs, and add more than
4704 one instance of the same 'how'.
4706 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4707 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4708 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4709 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4711 (This is now used as a subroutine by C<sv_magic>.)
4716 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4717 const char* name, I32 namlen)
4721 if (SvTYPE(sv) < SVt_PVMG) {
4722 SvUPGRADE(sv, SVt_PVMG);
4724 Newxz(mg, 1, MAGIC);
4725 mg->mg_moremagic = SvMAGIC(sv);
4726 SvMAGIC_set(sv, mg);
4728 /* Sometimes a magic contains a reference loop, where the sv and
4729 object refer to each other. To prevent a reference loop that
4730 would prevent such objects being freed, we look for such loops
4731 and if we find one we avoid incrementing the object refcount.
4733 Note we cannot do this to avoid self-tie loops as intervening RV must
4734 have its REFCNT incremented to keep it in existence.
4737 if (!obj || obj == sv ||
4738 how == PERL_MAGIC_arylen ||
4739 how == PERL_MAGIC_qr ||
4740 how == PERL_MAGIC_symtab ||
4741 (SvTYPE(obj) == SVt_PVGV &&
4742 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4743 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4744 GvFORM(obj) == (CV*)sv)))
4749 mg->mg_obj = SvREFCNT_inc(obj);
4750 mg->mg_flags |= MGf_REFCOUNTED;
4753 /* Normal self-ties simply pass a null object, and instead of
4754 using mg_obj directly, use the SvTIED_obj macro to produce a
4755 new RV as needed. For glob "self-ties", we are tieing the PVIO
4756 with an RV obj pointing to the glob containing the PVIO. In
4757 this case, to avoid a reference loop, we need to weaken the
4761 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4762 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4768 mg->mg_len = namlen;
4771 mg->mg_ptr = savepvn(name, namlen);
4772 else if (namlen == HEf_SVKEY)
4773 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4775 mg->mg_ptr = (char *) name;
4777 mg->mg_virtual = vtable;
4781 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4786 =for apidoc sv_magic
4788 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4789 then adds a new magic item of type C<how> to the head of the magic list.
4791 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4792 handling of the C<name> and C<namlen> arguments.
4794 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4795 to add more than one instance of the same 'how'.
4801 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4803 const MGVTBL *vtable;
4806 #ifdef PERL_OLD_COPY_ON_WRITE
4808 sv_force_normal_flags(sv, 0);
4810 if (SvREADONLY(sv)) {
4812 /* its okay to attach magic to shared strings; the subsequent
4813 * upgrade to PVMG will unshare the string */
4814 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4817 && how != PERL_MAGIC_regex_global
4818 && how != PERL_MAGIC_bm
4819 && how != PERL_MAGIC_fm
4820 && how != PERL_MAGIC_sv
4821 && how != PERL_MAGIC_backref
4824 Perl_croak(aTHX_ PL_no_modify);
4827 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4828 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4829 /* sv_magic() refuses to add a magic of the same 'how' as an
4832 if (how == PERL_MAGIC_taint)
4840 vtable = &PL_vtbl_sv;
4842 case PERL_MAGIC_overload:
4843 vtable = &PL_vtbl_amagic;
4845 case PERL_MAGIC_overload_elem:
4846 vtable = &PL_vtbl_amagicelem;
4848 case PERL_MAGIC_overload_table:
4849 vtable = &PL_vtbl_ovrld;
4852 vtable = &PL_vtbl_bm;
4854 case PERL_MAGIC_regdata:
4855 vtable = &PL_vtbl_regdata;
4857 case PERL_MAGIC_regdatum:
4858 vtable = &PL_vtbl_regdatum;
4860 case PERL_MAGIC_env:
4861 vtable = &PL_vtbl_env;
4864 vtable = &PL_vtbl_fm;
4866 case PERL_MAGIC_envelem:
4867 vtable = &PL_vtbl_envelem;
4869 case PERL_MAGIC_regex_global:
4870 vtable = &PL_vtbl_mglob;
4872 case PERL_MAGIC_isa:
4873 vtable = &PL_vtbl_isa;
4875 case PERL_MAGIC_isaelem:
4876 vtable = &PL_vtbl_isaelem;
4878 case PERL_MAGIC_nkeys:
4879 vtable = &PL_vtbl_nkeys;
4881 case PERL_MAGIC_dbfile:
4884 case PERL_MAGIC_dbline:
4885 vtable = &PL_vtbl_dbline;
4887 #ifdef USE_LOCALE_COLLATE
4888 case PERL_MAGIC_collxfrm:
4889 vtable = &PL_vtbl_collxfrm;
4891 #endif /* USE_LOCALE_COLLATE */
4892 case PERL_MAGIC_tied:
4893 vtable = &PL_vtbl_pack;
4895 case PERL_MAGIC_tiedelem:
4896 case PERL_MAGIC_tiedscalar:
4897 vtable = &PL_vtbl_packelem;
4900 vtable = &PL_vtbl_regexp;
4902 case PERL_MAGIC_sig:
4903 vtable = &PL_vtbl_sig;
4905 case PERL_MAGIC_sigelem:
4906 vtable = &PL_vtbl_sigelem;
4908 case PERL_MAGIC_taint:
4909 vtable = &PL_vtbl_taint;
4911 case PERL_MAGIC_uvar:
4912 vtable = &PL_vtbl_uvar;
4914 case PERL_MAGIC_vec:
4915 vtable = &PL_vtbl_vec;
4917 case PERL_MAGIC_arylen_p:
4918 case PERL_MAGIC_rhash:
4919 case PERL_MAGIC_symtab:
4920 case PERL_MAGIC_vstring:
4923 case PERL_MAGIC_utf8:
4924 vtable = &PL_vtbl_utf8;
4926 case PERL_MAGIC_substr:
4927 vtable = &PL_vtbl_substr;
4929 case PERL_MAGIC_defelem:
4930 vtable = &PL_vtbl_defelem;
4932 case PERL_MAGIC_glob:
4933 vtable = &PL_vtbl_glob;
4935 case PERL_MAGIC_arylen:
4936 vtable = &PL_vtbl_arylen;
4938 case PERL_MAGIC_pos:
4939 vtable = &PL_vtbl_pos;
4941 case PERL_MAGIC_backref:
4942 vtable = &PL_vtbl_backref;
4944 case PERL_MAGIC_ext:
4945 /* Reserved for use by extensions not perl internals. */
4946 /* Useful for attaching extension internal data to perl vars. */
4947 /* Note that multiple extensions may clash if magical scalars */
4948 /* etc holding private data from one are passed to another. */
4952 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4955 /* Rest of work is done else where */
4956 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4959 case PERL_MAGIC_taint:
4962 case PERL_MAGIC_ext:
4963 case PERL_MAGIC_dbfile:
4970 =for apidoc sv_unmagic
4972 Removes all magic of type C<type> from an SV.
4978 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4982 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4985 for (mg = *mgp; mg; mg = *mgp) {
4986 if (mg->mg_type == type) {
4987 const MGVTBL* const vtbl = mg->mg_virtual;
4988 *mgp = mg->mg_moremagic;
4989 if (vtbl && vtbl->svt_free)
4990 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4991 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4993 Safefree(mg->mg_ptr);
4994 else if (mg->mg_len == HEf_SVKEY)
4995 SvREFCNT_dec((SV*)mg->mg_ptr);
4996 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4997 Safefree(mg->mg_ptr);
4999 if (mg->mg_flags & MGf_REFCOUNTED)
5000 SvREFCNT_dec(mg->mg_obj);
5004 mgp = &mg->mg_moremagic;
5008 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5015 =for apidoc sv_rvweaken
5017 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5018 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5019 push a back-reference to this RV onto the array of backreferences
5020 associated with that magic.
5026 Perl_sv_rvweaken(pTHX_ SV *sv)
5029 if (!SvOK(sv)) /* let undefs pass */
5032 Perl_croak(aTHX_ "Can't weaken a nonreference");
5033 else if (SvWEAKREF(sv)) {
5034 if (ckWARN(WARN_MISC))
5035 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5039 Perl_sv_add_backref(aTHX_ tsv, sv);
5045 /* Give tsv backref magic if it hasn't already got it, then push a
5046 * back-reference to sv onto the array associated with the backref magic.
5050 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5054 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5055 av = (AV*)mg->mg_obj;
5058 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5059 /* av now has a refcnt of 2, which avoids it getting freed
5060 * before us during global cleanup. The extra ref is removed
5061 * by magic_killbackrefs() when tsv is being freed */
5063 if (AvFILLp(av) >= AvMAX(av)) {
5064 av_extend(av, AvFILLp(av)+1);
5066 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5069 /* delete a back-reference to ourselves from the backref magic associated
5070 * with the SV we point to.
5074 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5080 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5081 if (PL_in_clean_all)
5084 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5085 Perl_croak(aTHX_ "panic: del_backref");
5086 av = (AV *)mg->mg_obj;
5088 /* We shouldn't be in here more than once, but for paranoia reasons lets
5090 for (i = AvFILLp(av); i >= 0; i--) {
5092 const SSize_t fill = AvFILLp(av);
5094 /* We weren't the last entry.
5095 An unordered list has this property that you can take the
5096 last element off the end to fill the hole, and it's still
5097 an unordered list :-)
5102 AvFILLp(av) = fill - 1;
5108 =for apidoc sv_insert
5110 Inserts a string at the specified offset/length within the SV. Similar to
5111 the Perl substr() function.
5117 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5121 register char *midend;
5122 register char *bigend;
5128 Perl_croak(aTHX_ "Can't modify non-existent substring");
5129 SvPV_force(bigstr, curlen);
5130 (void)SvPOK_only_UTF8(bigstr);
5131 if (offset + len > curlen) {
5132 SvGROW(bigstr, offset+len+1);
5133 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5134 SvCUR_set(bigstr, offset+len);
5138 i = littlelen - len;
5139 if (i > 0) { /* string might grow */
5140 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5141 mid = big + offset + len;
5142 midend = bigend = big + SvCUR(bigstr);
5145 while (midend > mid) /* shove everything down */
5146 *--bigend = *--midend;
5147 Move(little,big+offset,littlelen,char);
5148 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5153 Move(little,SvPVX(bigstr)+offset,len,char);
5158 big = SvPVX(bigstr);
5161 bigend = big + SvCUR(bigstr);
5163 if (midend > bigend)
5164 Perl_croak(aTHX_ "panic: sv_insert");
5166 if (mid - big > bigend - midend) { /* faster to shorten from end */
5168 Move(little, mid, littlelen,char);
5171 i = bigend - midend;
5173 Move(midend, mid, i,char);
5177 SvCUR_set(bigstr, mid - big);
5179 else if ((i = mid - big)) { /* faster from front */
5180 midend -= littlelen;
5182 sv_chop(bigstr,midend-i);
5187 Move(little, mid, littlelen,char);
5189 else if (littlelen) {
5190 midend -= littlelen;
5191 sv_chop(bigstr,midend);
5192 Move(little,midend,littlelen,char);
5195 sv_chop(bigstr,midend);
5201 =for apidoc sv_replace
5203 Make the first argument a copy of the second, then delete the original.
5204 The target SV physically takes over ownership of the body of the source SV
5205 and inherits its flags; however, the target keeps any magic it owns,
5206 and any magic in the source is discarded.
5207 Note that this is a rather specialist SV copying operation; most of the
5208 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5214 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5216 const U32 refcnt = SvREFCNT(sv);
5217 SV_CHECK_THINKFIRST_COW_DROP(sv);
5218 if (SvREFCNT(nsv) != 1) {
5219 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5220 UVuf " != 1)", (UV) SvREFCNT(nsv));
5222 if (SvMAGICAL(sv)) {
5226 sv_upgrade(nsv, SVt_PVMG);
5227 SvMAGIC_set(nsv, SvMAGIC(sv));
5228 SvFLAGS(nsv) |= SvMAGICAL(sv);
5230 SvMAGIC_set(sv, NULL);
5234 assert(!SvREFCNT(sv));
5235 #ifdef DEBUG_LEAKING_SCALARS
5236 sv->sv_flags = nsv->sv_flags;
5237 sv->sv_any = nsv->sv_any;
5238 sv->sv_refcnt = nsv->sv_refcnt;
5239 sv->sv_u = nsv->sv_u;
5241 StructCopy(nsv,sv,SV);
5243 /* Currently could join these into one piece of pointer arithmetic, but
5244 it would be unclear. */
5245 if(SvTYPE(sv) == SVt_IV)
5247 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5248 else if (SvTYPE(sv) == SVt_RV) {
5249 SvANY(sv) = &sv->sv_u.svu_rv;
5253 #ifdef PERL_OLD_COPY_ON_WRITE
5254 if (SvIsCOW_normal(nsv)) {
5255 /* We need to follow the pointers around the loop to make the
5256 previous SV point to sv, rather than nsv. */
5259 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5262 assert(SvPVX_const(current) == SvPVX_const(nsv));
5264 /* Make the SV before us point to the SV after us. */
5266 PerlIO_printf(Perl_debug_log, "previous is\n");
5268 PerlIO_printf(Perl_debug_log,
5269 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5270 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5272 SV_COW_NEXT_SV_SET(current, sv);
5275 SvREFCNT(sv) = refcnt;
5276 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5282 =for apidoc sv_clear
5284 Clear an SV: call any destructors, free up any memory used by the body,
5285 and free the body itself. The SV's head is I<not> freed, although
5286 its type is set to all 1's so that it won't inadvertently be assumed
5287 to be live during global destruction etc.
5288 This function should only be called when REFCNT is zero. Most of the time
5289 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5296 Perl_sv_clear(pTHX_ register SV *sv)
5299 void** old_body_arena;
5300 size_t old_body_offset;
5301 const U32 type = SvTYPE(sv);
5304 assert(SvREFCNT(sv) == 0);
5310 old_body_offset = 0;
5313 if (PL_defstash) { /* Still have a symbol table? */
5318 stash = SvSTASH(sv);
5319 destructor = StashHANDLER(stash,DESTROY);
5321 SV* const tmpref = newRV(sv);
5322 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5324 PUSHSTACKi(PERLSI_DESTROY);
5329 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5335 if(SvREFCNT(tmpref) < 2) {
5336 /* tmpref is not kept alive! */
5338 SvRV_set(tmpref, NULL);
5341 SvREFCNT_dec(tmpref);
5343 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5347 if (PL_in_clean_objs)
5348 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5350 /* DESTROY gave object new lease on life */
5356 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5357 SvOBJECT_off(sv); /* Curse the object. */
5358 if (type != SVt_PVIO)
5359 --PL_sv_objcount; /* XXX Might want something more general */
5362 if (type >= SVt_PVMG) {
5365 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5366 SvREFCNT_dec(SvSTASH(sv));
5371 IoIFP(sv) != PerlIO_stdin() &&
5372 IoIFP(sv) != PerlIO_stdout() &&
5373 IoIFP(sv) != PerlIO_stderr())
5375 io_close((IO*)sv, FALSE);
5377 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5378 PerlDir_close(IoDIRP(sv));
5379 IoDIRP(sv) = (DIR*)NULL;
5380 Safefree(IoTOP_NAME(sv));
5381 Safefree(IoFMT_NAME(sv));
5382 Safefree(IoBOTTOM_NAME(sv));
5383 /* PVIOs aren't from arenas */
5386 old_body_arena = (void **) &PL_xpvbm_root;
5389 old_body_arena = (void **) &PL_xpvcv_root;
5391 /* PVFMs aren't from arenas */
5396 old_body_arena = (void **) &PL_xpvhv_root;
5397 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5401 old_body_arena = (void **) &PL_xpvav_root;
5402 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5405 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5406 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5407 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5408 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5410 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5411 SvREFCNT_dec(LvTARG(sv));
5412 old_body_arena = (void **) &PL_xpvlv_root;
5416 Safefree(GvNAME(sv));
5417 /* If we're in a stash, we don't own a reference to it. However it does
5418 have a back reference to us, which needs to be cleared. */
5420 sv_del_backref((SV*)GvSTASH(sv), sv);
5421 old_body_arena = (void **) &PL_xpvgv_root;
5424 old_body_arena = (void **) &PL_xpvmg_root;
5427 old_body_arena = (void **) &PL_xpvnv_root;
5430 old_body_arena = (void **) &PL_xpviv_root;
5431 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5433 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5435 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5436 /* Don't even bother with turning off the OOK flag. */
5440 old_body_arena = (void **) &PL_xpv_root;
5441 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5445 SV *target = SvRV(sv);
5447 sv_del_backref(target, sv);
5449 SvREFCNT_dec(target);
5451 #ifdef PERL_OLD_COPY_ON_WRITE
5452 else if (SvPVX_const(sv)) {
5454 /* I believe I need to grab the global SV mutex here and
5455 then recheck the COW status. */
5457 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5460 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5461 SV_COW_NEXT_SV(sv));
5462 /* And drop it here. */
5464 } else if (SvLEN(sv)) {
5465 Safefree(SvPVX_const(sv));
5469 else if (SvPVX_const(sv) && SvLEN(sv))
5470 Safefree(SvPVX_mutable(sv));
5471 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5472 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5478 old_body_arena = (void **) &PL_xnv_root;
5482 SvFLAGS(sv) &= SVf_BREAK;
5483 SvFLAGS(sv) |= SVTYPEMASK;
5486 if (old_body_arena) {
5487 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5491 if (type > SVt_RV) {
5492 my_safefree(SvANY(sv));
5497 =for apidoc sv_newref
5499 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5506 Perl_sv_newref(pTHX_ SV *sv)
5516 Decrement an SV's reference count, and if it drops to zero, call
5517 C<sv_clear> to invoke destructors and free up any memory used by
5518 the body; finally, deallocate the SV's head itself.
5519 Normally called via a wrapper macro C<SvREFCNT_dec>.
5525 Perl_sv_free(pTHX_ SV *sv)
5530 if (SvREFCNT(sv) == 0) {
5531 if (SvFLAGS(sv) & SVf_BREAK)
5532 /* this SV's refcnt has been artificially decremented to
5533 * trigger cleanup */
5535 if (PL_in_clean_all) /* All is fair */
5537 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5538 /* make sure SvREFCNT(sv)==0 happens very seldom */
5539 SvREFCNT(sv) = (~(U32)0)/2;
5542 if (ckWARN_d(WARN_INTERNAL)) {
5543 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5544 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5545 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5546 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5547 Perl_dump_sv_child(aTHX_ sv);
5552 if (--(SvREFCNT(sv)) > 0)
5554 Perl_sv_free2(aTHX_ sv);
5558 Perl_sv_free2(pTHX_ SV *sv)
5563 if (ckWARN_d(WARN_DEBUGGING))
5564 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5565 "Attempt to free temp prematurely: SV 0x%"UVxf
5566 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5570 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5571 /* make sure SvREFCNT(sv)==0 happens very seldom */
5572 SvREFCNT(sv) = (~(U32)0)/2;
5583 Returns the length of the string in the SV. Handles magic and type
5584 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5590 Perl_sv_len(pTHX_ register SV *sv)
5598 len = mg_length(sv);
5600 (void)SvPV_const(sv, len);
5605 =for apidoc sv_len_utf8
5607 Returns the number of characters in the string in an SV, counting wide
5608 UTF-8 bytes as a single character. Handles magic and type coercion.
5614 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5615 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5616 * (Note that the mg_len is not the length of the mg_ptr field.)
5621 Perl_sv_len_utf8(pTHX_ register SV *sv)
5627 return mg_length(sv);
5631 const U8 *s = (U8*)SvPV_const(sv, len);
5632 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5634 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5636 #ifdef PERL_UTF8_CACHE_ASSERT
5637 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5641 ulen = Perl_utf8_length(aTHX_ s, s + len);
5642 if (!mg && !SvREADONLY(sv)) {
5643 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5644 mg = mg_find(sv, PERL_MAGIC_utf8);
5654 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5655 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5656 * between UTF-8 and byte offsets. There are two (substr offset and substr
5657 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5658 * and byte offset) cache positions.
5660 * The mg_len field is used by sv_len_utf8(), see its comments.
5661 * Note that the mg_len is not the length of the mg_ptr field.
5665 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5666 I32 offsetp, const U8 *s, const U8 *start)
5670 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5672 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5676 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5678 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5679 (*mgp)->mg_ptr = (char *) *cachep;
5683 (*cachep)[i] = offsetp;
5684 (*cachep)[i+1] = s - start;
5692 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5693 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5694 * between UTF-8 and byte offsets. See also the comments of
5695 * S_utf8_mg_pos_init().
5699 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)
5703 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5705 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5706 if (*mgp && (*mgp)->mg_ptr) {
5707 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5708 ASSERT_UTF8_CACHE(*cachep);
5709 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5711 else { /* We will skip to the right spot. */
5716 /* The assumption is that going backward is half
5717 * the speed of going forward (that's where the
5718 * 2 * backw in the below comes from). (The real
5719 * figure of course depends on the UTF-8 data.) */
5721 if ((*cachep)[i] > (STRLEN)uoff) {
5723 backw = (*cachep)[i] - (STRLEN)uoff;
5725 if (forw < 2 * backw)
5728 p = start + (*cachep)[i+1];
5730 /* Try this only for the substr offset (i == 0),
5731 * not for the substr length (i == 2). */
5732 else if (i == 0) { /* (*cachep)[i] < uoff */
5733 const STRLEN ulen = sv_len_utf8(sv);
5735 if ((STRLEN)uoff < ulen) {
5736 forw = (STRLEN)uoff - (*cachep)[i];
5737 backw = ulen - (STRLEN)uoff;
5739 if (forw < 2 * backw)
5740 p = start + (*cachep)[i+1];
5745 /* If the string is not long enough for uoff,
5746 * we could extend it, but not at this low a level. */
5750 if (forw < 2 * backw) {
5757 while (UTF8_IS_CONTINUATION(*p))
5762 /* Update the cache. */
5763 (*cachep)[i] = (STRLEN)uoff;
5764 (*cachep)[i+1] = p - start;
5766 /* Drop the stale "length" cache */
5775 if (found) { /* Setup the return values. */
5776 *offsetp = (*cachep)[i+1];
5777 *sp = start + *offsetp;
5780 *offsetp = send - start;
5782 else if (*sp < start) {
5788 #ifdef PERL_UTF8_CACHE_ASSERT
5793 while (n-- && s < send)
5797 assert(*offsetp == s - start);
5798 assert((*cachep)[0] == (STRLEN)uoff);
5799 assert((*cachep)[1] == *offsetp);
5801 ASSERT_UTF8_CACHE(*cachep);
5810 =for apidoc sv_pos_u2b
5812 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5813 the start of the string, to a count of the equivalent number of bytes; if
5814 lenp is non-zero, it does the same to lenp, but this time starting from
5815 the offset, rather than from the start of the string. Handles magic and
5822 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5823 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5824 * byte offsets. See also the comments of S_utf8_mg_pos().
5829 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5837 start = (U8*)SvPV_const(sv, len);
5841 const U8 *s = start;
5842 I32 uoffset = *offsetp;
5843 const U8 * const send = s + len;
5847 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5849 if (!found && uoffset > 0) {
5850 while (s < send && uoffset--)
5854 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5856 *offsetp = s - start;
5861 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5865 if (!found && *lenp > 0) {
5868 while (s < send && ulen--)
5872 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5876 ASSERT_UTF8_CACHE(cache);
5888 =for apidoc sv_pos_b2u
5890 Converts the value pointed to by offsetp from a count of bytes from the
5891 start of the string, to a count of the equivalent number of UTF-8 chars.
5892 Handles magic and type coercion.
5898 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5899 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5900 * byte offsets. See also the comments of S_utf8_mg_pos().
5905 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5913 s = (const U8*)SvPV_const(sv, len);
5914 if ((I32)len < *offsetp)
5915 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5917 const U8* send = s + *offsetp;
5919 STRLEN *cache = NULL;
5923 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5924 mg = mg_find(sv, PERL_MAGIC_utf8);
5925 if (mg && mg->mg_ptr) {
5926 cache = (STRLEN *) mg->mg_ptr;
5927 if (cache[1] == (STRLEN)*offsetp) {
5928 /* An exact match. */
5929 *offsetp = cache[0];
5933 else if (cache[1] < (STRLEN)*offsetp) {
5934 /* We already know part of the way. */
5937 /* Let the below loop do the rest. */
5939 else { /* cache[1] > *offsetp */
5940 /* We already know all of the way, now we may
5941 * be able to walk back. The same assumption
5942 * is made as in S_utf8_mg_pos(), namely that
5943 * walking backward is twice slower than
5944 * walking forward. */
5945 const STRLEN forw = *offsetp;
5946 STRLEN backw = cache[1] - *offsetp;
5948 if (!(forw < 2 * backw)) {
5949 const U8 *p = s + cache[1];
5956 while (UTF8_IS_CONTINUATION(*p)) {
5964 *offsetp = cache[0];
5966 /* Drop the stale "length" cache */
5974 ASSERT_UTF8_CACHE(cache);
5980 /* Call utf8n_to_uvchr() to validate the sequence
5981 * (unless a simple non-UTF character) */
5982 if (!UTF8_IS_INVARIANT(*s))
5983 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5992 if (!SvREADONLY(sv)) {
5994 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5995 mg = mg_find(sv, PERL_MAGIC_utf8);
6000 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6001 mg->mg_ptr = (char *) cache;
6006 cache[1] = *offsetp;
6007 /* Drop the stale "length" cache */
6020 Returns a boolean indicating whether the strings in the two SVs are
6021 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6022 coerce its args to strings if necessary.
6028 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6036 SV* svrecode = Nullsv;
6043 pv1 = SvPV_const(sv1, cur1);
6050 pv2 = SvPV_const(sv2, cur2);
6052 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6053 /* Differing utf8ness.
6054 * Do not UTF8size the comparands as a side-effect. */
6057 svrecode = newSVpvn(pv2, cur2);
6058 sv_recode_to_utf8(svrecode, PL_encoding);
6059 pv2 = SvPV_const(svrecode, cur2);
6062 svrecode = newSVpvn(pv1, cur1);
6063 sv_recode_to_utf8(svrecode, PL_encoding);
6064 pv1 = SvPV_const(svrecode, cur1);
6066 /* Now both are in UTF-8. */
6068 SvREFCNT_dec(svrecode);
6073 bool is_utf8 = TRUE;
6076 /* sv1 is the UTF-8 one,
6077 * if is equal it must be downgrade-able */
6078 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6084 /* sv2 is the UTF-8 one,
6085 * if is equal it must be downgrade-able */
6086 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6092 /* Downgrade not possible - cannot be eq */
6100 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6103 SvREFCNT_dec(svrecode);
6114 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6115 string in C<sv1> is less than, equal to, or greater than the string in
6116 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6117 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6123 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6126 const char *pv1, *pv2;
6129 SV *svrecode = Nullsv;
6136 pv1 = SvPV_const(sv1, cur1);
6143 pv2 = SvPV_const(sv2, cur2);
6145 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6146 /* Differing utf8ness.
6147 * Do not UTF8size the comparands as a side-effect. */
6150 svrecode = newSVpvn(pv2, cur2);
6151 sv_recode_to_utf8(svrecode, PL_encoding);
6152 pv2 = SvPV_const(svrecode, cur2);
6155 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6160 svrecode = newSVpvn(pv1, cur1);
6161 sv_recode_to_utf8(svrecode, PL_encoding);
6162 pv1 = SvPV_const(svrecode, cur1);
6165 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6171 cmp = cur2 ? -1 : 0;
6175 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6178 cmp = retval < 0 ? -1 : 1;
6179 } else if (cur1 == cur2) {
6182 cmp = cur1 < cur2 ? -1 : 1;
6187 SvREFCNT_dec(svrecode);
6196 =for apidoc sv_cmp_locale
6198 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6199 'use bytes' aware, handles get magic, and will coerce its args to strings
6200 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6206 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6208 #ifdef USE_LOCALE_COLLATE
6214 if (PL_collation_standard)
6218 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6220 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6222 if (!pv1 || !len1) {
6233 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6236 return retval < 0 ? -1 : 1;
6239 * When the result of collation is equality, that doesn't mean
6240 * that there are no differences -- some locales exclude some
6241 * characters from consideration. So to avoid false equalities,
6242 * we use the raw string as a tiebreaker.
6248 #endif /* USE_LOCALE_COLLATE */
6250 return sv_cmp(sv1, sv2);
6254 #ifdef USE_LOCALE_COLLATE
6257 =for apidoc sv_collxfrm
6259 Add Collate Transform magic to an SV if it doesn't already have it.
6261 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6262 scalar data of the variable, but transformed to such a format that a normal
6263 memory comparison can be used to compare the data according to the locale
6270 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6274 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6275 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6281 Safefree(mg->mg_ptr);
6282 s = SvPV_const(sv, len);
6283 if ((xf = mem_collxfrm(s, len, &xlen))) {
6284 if (SvREADONLY(sv)) {
6287 return xf + sizeof(PL_collation_ix);
6290 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6291 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6304 if (mg && mg->mg_ptr) {
6306 return mg->mg_ptr + sizeof(PL_collation_ix);
6314 #endif /* USE_LOCALE_COLLATE */
6319 Get a line from the filehandle and store it into the SV, optionally
6320 appending to the currently-stored string.
6326 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6330 register STDCHAR rslast;
6331 register STDCHAR *bp;
6337 if (SvTHINKFIRST(sv))
6338 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6339 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6341 However, perlbench says it's slower, because the existing swipe code
6342 is faster than copy on write.
6343 Swings and roundabouts. */
6344 SvUPGRADE(sv, SVt_PV);
6349 if (PerlIO_isutf8(fp)) {
6351 sv_utf8_upgrade_nomg(sv);
6352 sv_pos_u2b(sv,&append,0);
6354 } else if (SvUTF8(sv)) {
6355 SV * const tsv = NEWSV(0,0);
6356 sv_gets(tsv, fp, 0);
6357 sv_utf8_upgrade_nomg(tsv);
6358 SvCUR_set(sv,append);
6361 goto return_string_or_null;
6366 if (PerlIO_isutf8(fp))
6369 if (IN_PERL_COMPILETIME) {
6370 /* we always read code in line mode */
6374 else if (RsSNARF(PL_rs)) {
6375 /* If it is a regular disk file use size from stat() as estimate
6376 of amount we are going to read - may result in malloc-ing
6377 more memory than we realy need if layers bellow reduce
6378 size we read (e.g. CRLF or a gzip layer)
6381 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6382 const Off_t offset = PerlIO_tell(fp);
6383 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6384 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6390 else if (RsRECORD(PL_rs)) {
6394 /* Grab the size of the record we're getting */
6395 recsize = SvIV(SvRV(PL_rs));
6396 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6399 /* VMS wants read instead of fread, because fread doesn't respect */
6400 /* RMS record boundaries. This is not necessarily a good thing to be */
6401 /* doing, but we've got no other real choice - except avoid stdio
6402 as implementation - perhaps write a :vms layer ?
6404 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6406 bytesread = PerlIO_read(fp, buffer, recsize);
6410 SvCUR_set(sv, bytesread += append);
6411 buffer[bytesread] = '\0';
6412 goto return_string_or_null;
6414 else if (RsPARA(PL_rs)) {
6420 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6421 if (PerlIO_isutf8(fp)) {
6422 rsptr = SvPVutf8(PL_rs, rslen);
6425 if (SvUTF8(PL_rs)) {
6426 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6427 Perl_croak(aTHX_ "Wide character in $/");
6430 rsptr = SvPV_const(PL_rs, rslen);
6434 rslast = rslen ? rsptr[rslen - 1] : '\0';
6436 if (rspara) { /* have to do this both before and after */
6437 do { /* to make sure file boundaries work right */
6440 i = PerlIO_getc(fp);
6444 PerlIO_ungetc(fp,i);
6450 /* See if we know enough about I/O mechanism to cheat it ! */
6452 /* This used to be #ifdef test - it is made run-time test for ease
6453 of abstracting out stdio interface. One call should be cheap
6454 enough here - and may even be a macro allowing compile
6458 if (PerlIO_fast_gets(fp)) {
6461 * We're going to steal some values from the stdio struct
6462 * and put EVERYTHING in the innermost loop into registers.
6464 register STDCHAR *ptr;
6468 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6469 /* An ungetc()d char is handled separately from the regular
6470 * buffer, so we getc() it back out and stuff it in the buffer.
6472 i = PerlIO_getc(fp);
6473 if (i == EOF) return 0;
6474 *(--((*fp)->_ptr)) = (unsigned char) i;
6478 /* Here is some breathtakingly efficient cheating */
6480 cnt = PerlIO_get_cnt(fp); /* get count into register */
6481 /* make sure we have the room */
6482 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6483 /* Not room for all of it
6484 if we are looking for a separator and room for some
6486 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6487 /* just process what we have room for */
6488 shortbuffered = cnt - SvLEN(sv) + append + 1;
6489 cnt -= shortbuffered;
6493 /* remember that cnt can be negative */
6494 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6499 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6500 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6501 DEBUG_P(PerlIO_printf(Perl_debug_log,
6502 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6503 DEBUG_P(PerlIO_printf(Perl_debug_log,
6504 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6505 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6506 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6511 while (cnt > 0) { /* this | eat */
6513 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6514 goto thats_all_folks; /* screams | sed :-) */
6518 Copy(ptr, bp, cnt, char); /* this | eat */
6519 bp += cnt; /* screams | dust */
6520 ptr += cnt; /* louder | sed :-) */
6525 if (shortbuffered) { /* oh well, must extend */
6526 cnt = shortbuffered;
6528 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6530 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6531 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6535 DEBUG_P(PerlIO_printf(Perl_debug_log,
6536 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6537 PTR2UV(ptr),(long)cnt));
6538 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6540 DEBUG_P(PerlIO_printf(Perl_debug_log,
6541 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6542 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6543 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6545 /* This used to call 'filbuf' in stdio form, but as that behaves like
6546 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6547 another abstraction. */
6548 i = PerlIO_getc(fp); /* get more characters */
6550 DEBUG_P(PerlIO_printf(Perl_debug_log,
6551 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6552 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6553 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6555 cnt = PerlIO_get_cnt(fp);
6556 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6557 DEBUG_P(PerlIO_printf(Perl_debug_log,
6558 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6560 if (i == EOF) /* all done for ever? */
6561 goto thats_really_all_folks;
6563 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6565 SvGROW(sv, bpx + cnt + 2);
6566 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6568 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6570 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6571 goto thats_all_folks;
6575 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6576 memNE((char*)bp - rslen, rsptr, rslen))
6577 goto screamer; /* go back to the fray */
6578 thats_really_all_folks:
6580 cnt += shortbuffered;
6581 DEBUG_P(PerlIO_printf(Perl_debug_log,
6582 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6583 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6584 DEBUG_P(PerlIO_printf(Perl_debug_log,
6585 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6586 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6587 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6589 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6590 DEBUG_P(PerlIO_printf(Perl_debug_log,
6591 "Screamer: done, len=%ld, string=|%.*s|\n",
6592 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6596 /*The big, slow, and stupid way. */
6597 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6599 Newx(buf, 8192, STDCHAR);
6607 register const STDCHAR *bpe = buf + sizeof(buf);
6609 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6610 ; /* keep reading */
6614 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6615 /* Accomodate broken VAXC compiler, which applies U8 cast to
6616 * both args of ?: operator, causing EOF to change into 255
6619 i = (U8)buf[cnt - 1];
6625 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6627 sv_catpvn(sv, (char *) buf, cnt);
6629 sv_setpvn(sv, (char *) buf, cnt);
6631 if (i != EOF && /* joy */
6633 SvCUR(sv) < rslen ||
6634 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6638 * If we're reading from a TTY and we get a short read,
6639 * indicating that the user hit his EOF character, we need
6640 * to notice it now, because if we try to read from the TTY
6641 * again, the EOF condition will disappear.
6643 * The comparison of cnt to sizeof(buf) is an optimization
6644 * that prevents unnecessary calls to feof().
6648 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6652 #ifdef USE_HEAP_INSTEAD_OF_STACK
6657 if (rspara) { /* have to do this both before and after */
6658 while (i != EOF) { /* to make sure file boundaries work right */
6659 i = PerlIO_getc(fp);
6661 PerlIO_ungetc(fp,i);
6667 return_string_or_null:
6668 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6674 Auto-increment of the value in the SV, doing string to numeric conversion
6675 if necessary. Handles 'get' magic.
6681 Perl_sv_inc(pTHX_ register SV *sv)
6689 if (SvTHINKFIRST(sv)) {
6691 sv_force_normal_flags(sv, 0);
6692 if (SvREADONLY(sv)) {
6693 if (IN_PERL_RUNTIME)
6694 Perl_croak(aTHX_ PL_no_modify);
6698 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6700 i = PTR2IV(SvRV(sv));
6705 flags = SvFLAGS(sv);
6706 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6707 /* It's (privately or publicly) a float, but not tested as an
6708 integer, so test it to see. */
6710 flags = SvFLAGS(sv);
6712 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6713 /* It's publicly an integer, or privately an integer-not-float */
6714 #ifdef PERL_PRESERVE_IVUV
6718 if (SvUVX(sv) == UV_MAX)
6719 sv_setnv(sv, UV_MAX_P1);
6721 (void)SvIOK_only_UV(sv);
6722 SvUV_set(sv, SvUVX(sv) + 1);
6724 if (SvIVX(sv) == IV_MAX)
6725 sv_setuv(sv, (UV)IV_MAX + 1);
6727 (void)SvIOK_only(sv);
6728 SvIV_set(sv, SvIVX(sv) + 1);
6733 if (flags & SVp_NOK) {
6734 (void)SvNOK_only(sv);
6735 SvNV_set(sv, SvNVX(sv) + 1.0);
6739 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6740 if ((flags & SVTYPEMASK) < SVt_PVIV)
6741 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6742 (void)SvIOK_only(sv);
6747 while (isALPHA(*d)) d++;
6748 while (isDIGIT(*d)) d++;
6750 #ifdef PERL_PRESERVE_IVUV
6751 /* Got to punt this as an integer if needs be, but we don't issue
6752 warnings. Probably ought to make the sv_iv_please() that does
6753 the conversion if possible, and silently. */
6754 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6755 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6756 /* Need to try really hard to see if it's an integer.
6757 9.22337203685478e+18 is an integer.
6758 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6759 so $a="9.22337203685478e+18"; $a+0; $a++
6760 needs to be the same as $a="9.22337203685478e+18"; $a++
6767 /* sv_2iv *should* have made this an NV */
6768 if (flags & SVp_NOK) {
6769 (void)SvNOK_only(sv);
6770 SvNV_set(sv, SvNVX(sv) + 1.0);
6773 /* I don't think we can get here. Maybe I should assert this
6774 And if we do get here I suspect that sv_setnv will croak. NWC
6776 #if defined(USE_LONG_DOUBLE)
6777 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",
6778 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6780 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6781 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6784 #endif /* PERL_PRESERVE_IVUV */
6785 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6789 while (d >= SvPVX_const(sv)) {
6797 /* MKS: The original code here died if letters weren't consecutive.
6798 * at least it didn't have to worry about non-C locales. The
6799 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6800 * arranged in order (although not consecutively) and that only
6801 * [A-Za-z] are accepted by isALPHA in the C locale.
6803 if (*d != 'z' && *d != 'Z') {
6804 do { ++*d; } while (!isALPHA(*d));
6807 *(d--) -= 'z' - 'a';
6812 *(d--) -= 'z' - 'a' + 1;
6816 /* oh,oh, the number grew */
6817 SvGROW(sv, SvCUR(sv) + 2);
6818 SvCUR_set(sv, SvCUR(sv) + 1);
6819 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6830 Auto-decrement of the value in the SV, doing string to numeric conversion
6831 if necessary. Handles 'get' magic.
6837 Perl_sv_dec(pTHX_ register SV *sv)
6844 if (SvTHINKFIRST(sv)) {
6846 sv_force_normal_flags(sv, 0);
6847 if (SvREADONLY(sv)) {
6848 if (IN_PERL_RUNTIME)
6849 Perl_croak(aTHX_ PL_no_modify);
6853 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6855 i = PTR2IV(SvRV(sv));
6860 /* Unlike sv_inc we don't have to worry about string-never-numbers
6861 and keeping them magic. But we mustn't warn on punting */
6862 flags = SvFLAGS(sv);
6863 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6864 /* It's publicly an integer, or privately an integer-not-float */
6865 #ifdef PERL_PRESERVE_IVUV
6869 if (SvUVX(sv) == 0) {
6870 (void)SvIOK_only(sv);
6874 (void)SvIOK_only_UV(sv);
6875 SvUV_set(sv, SvUVX(sv) - 1);
6878 if (SvIVX(sv) == IV_MIN)
6879 sv_setnv(sv, (NV)IV_MIN - 1.0);
6881 (void)SvIOK_only(sv);
6882 SvIV_set(sv, SvIVX(sv) - 1);
6887 if (flags & SVp_NOK) {
6888 SvNV_set(sv, SvNVX(sv) - 1.0);
6889 (void)SvNOK_only(sv);
6892 if (!(flags & SVp_POK)) {
6893 if ((flags & SVTYPEMASK) < SVt_PVIV)
6894 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6896 (void)SvIOK_only(sv);
6899 #ifdef PERL_PRESERVE_IVUV
6901 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6902 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6903 /* Need to try really hard to see if it's an integer.
6904 9.22337203685478e+18 is an integer.
6905 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6906 so $a="9.22337203685478e+18"; $a+0; $a--
6907 needs to be the same as $a="9.22337203685478e+18"; $a--
6914 /* sv_2iv *should* have made this an NV */
6915 if (flags & SVp_NOK) {
6916 (void)SvNOK_only(sv);
6917 SvNV_set(sv, SvNVX(sv) - 1.0);
6920 /* I don't think we can get here. Maybe I should assert this
6921 And if we do get here I suspect that sv_setnv will croak. NWC
6923 #if defined(USE_LONG_DOUBLE)
6924 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",
6925 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6927 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6928 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6932 #endif /* PERL_PRESERVE_IVUV */
6933 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6937 =for apidoc sv_mortalcopy
6939 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6940 The new SV is marked as mortal. It will be destroyed "soon", either by an
6941 explicit call to FREETMPS, or by an implicit call at places such as
6942 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6947 /* Make a string that will exist for the duration of the expression
6948 * evaluation. Actually, it may have to last longer than that, but
6949 * hopefully we won't free it until it has been assigned to a
6950 * permanent location. */
6953 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6958 sv_setsv(sv,oldstr);
6960 PL_tmps_stack[++PL_tmps_ix] = sv;
6966 =for apidoc sv_newmortal
6968 Creates a new null SV which is mortal. The reference count of the SV is
6969 set to 1. It will be destroyed "soon", either by an explicit call to
6970 FREETMPS, or by an implicit call at places such as statement boundaries.
6971 See also C<sv_mortalcopy> and C<sv_2mortal>.
6977 Perl_sv_newmortal(pTHX)
6982 SvFLAGS(sv) = SVs_TEMP;
6984 PL_tmps_stack[++PL_tmps_ix] = sv;
6989 =for apidoc sv_2mortal
6991 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6992 by an explicit call to FREETMPS, or by an implicit call at places such as
6993 statement boundaries. SvTEMP() is turned on which means that the SV's
6994 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6995 and C<sv_mortalcopy>.
7001 Perl_sv_2mortal(pTHX_ register SV *sv)
7006 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7009 PL_tmps_stack[++PL_tmps_ix] = sv;
7017 Creates a new SV and copies a string into it. The reference count for the
7018 SV is set to 1. If C<len> is zero, Perl will compute the length using
7019 strlen(). For efficiency, consider using C<newSVpvn> instead.
7025 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7030 sv_setpvn(sv,s,len ? len : strlen(s));
7035 =for apidoc newSVpvn
7037 Creates a new SV and copies a string into it. The reference count for the
7038 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7039 string. You are responsible for ensuring that the source string is at least
7040 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7046 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7051 sv_setpvn(sv,s,len);
7057 =for apidoc newSVhek
7059 Creates a new SV from the hash key structure. It will generate scalars that
7060 point to the shared string table where possible. Returns a new (undefined)
7061 SV if the hek is NULL.
7067 Perl_newSVhek(pTHX_ const HEK *hek)
7076 if (HEK_LEN(hek) == HEf_SVKEY) {
7077 return newSVsv(*(SV**)HEK_KEY(hek));
7079 const int flags = HEK_FLAGS(hek);
7080 if (flags & HVhek_WASUTF8) {
7082 Andreas would like keys he put in as utf8 to come back as utf8
7084 STRLEN utf8_len = HEK_LEN(hek);
7085 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7086 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7089 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7091 } else if (flags & HVhek_REHASH) {
7092 /* We don't have a pointer to the hv, so we have to replicate the
7093 flag into every HEK. This hv is using custom a hasing
7094 algorithm. Hence we can't return a shared string scalar, as
7095 that would contain the (wrong) hash value, and might get passed
7096 into an hv routine with a regular hash */
7098 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7103 /* This will be overwhelminly the most common case. */
7104 return newSVpvn_share(HEK_KEY(hek),
7105 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7111 =for apidoc newSVpvn_share
7113 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7114 table. If the string does not already exist in the table, it is created
7115 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7116 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7117 otherwise the hash is computed. The idea here is that as the string table
7118 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7119 hash lookup will avoid string compare.
7125 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7128 bool is_utf8 = FALSE;
7130 STRLEN tmplen = -len;
7132 /* See the note in hv.c:hv_fetch() --jhi */
7133 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7137 PERL_HASH(hash, src, len);
7139 sv_upgrade(sv, SVt_PV);
7140 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7152 #if defined(PERL_IMPLICIT_CONTEXT)
7154 /* pTHX_ magic can't cope with varargs, so this is a no-context
7155 * version of the main function, (which may itself be aliased to us).
7156 * Don't access this version directly.
7160 Perl_newSVpvf_nocontext(const char* pat, ...)
7165 va_start(args, pat);
7166 sv = vnewSVpvf(pat, &args);
7173 =for apidoc newSVpvf
7175 Creates a new SV and initializes it with the string formatted like
7182 Perl_newSVpvf(pTHX_ const char* pat, ...)
7186 va_start(args, pat);
7187 sv = vnewSVpvf(pat, &args);
7192 /* backend for newSVpvf() and newSVpvf_nocontext() */
7195 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7199 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7206 Creates a new SV and copies a floating point value into it.
7207 The reference count for the SV is set to 1.
7213 Perl_newSVnv(pTHX_ NV n)
7225 Creates a new SV and copies an integer into it. The reference count for the
7232 Perl_newSViv(pTHX_ IV i)
7244 Creates a new SV and copies an unsigned integer into it.
7245 The reference count for the SV is set to 1.
7251 Perl_newSVuv(pTHX_ UV u)
7261 =for apidoc newRV_noinc
7263 Creates an RV wrapper for an SV. The reference count for the original
7264 SV is B<not> incremented.
7270 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7275 sv_upgrade(sv, SVt_RV);
7277 SvRV_set(sv, tmpRef);
7282 /* newRV_inc is the official function name to use now.
7283 * newRV_inc is in fact #defined to newRV in sv.h
7287 Perl_newRV(pTHX_ SV *tmpRef)
7289 return newRV_noinc(SvREFCNT_inc(tmpRef));
7295 Creates a new SV which is an exact duplicate of the original SV.
7302 Perl_newSVsv(pTHX_ register SV *old)
7308 if (SvTYPE(old) == SVTYPEMASK) {
7309 if (ckWARN_d(WARN_INTERNAL))
7310 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7314 /* SV_GMAGIC is the default for sv_setv()
7315 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7316 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7317 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7322 =for apidoc sv_reset
7324 Underlying implementation for the C<reset> Perl function.
7325 Note that the perl-level function is vaguely deprecated.
7331 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7334 char todo[PERL_UCHAR_MAX+1];
7339 if (!*s) { /* reset ?? searches */
7340 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7342 PMOP *pm = (PMOP *) mg->mg_obj;
7344 pm->op_pmdynflags &= ~PMdf_USED;
7351 /* reset variables */
7353 if (!HvARRAY(stash))
7356 Zero(todo, 256, char);
7359 I32 i = (unsigned char)*s;
7363 max = (unsigned char)*s++;
7364 for ( ; i <= max; i++) {
7367 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7369 for (entry = HvARRAY(stash)[i];
7371 entry = HeNEXT(entry))
7376 if (!todo[(U8)*HeKEY(entry)])
7378 gv = (GV*)HeVAL(entry);
7381 if (SvTHINKFIRST(sv)) {
7382 if (!SvREADONLY(sv) && SvROK(sv))
7384 /* XXX Is this continue a bug? Why should THINKFIRST
7385 exempt us from resetting arrays and hashes? */
7389 if (SvTYPE(sv) >= SVt_PV) {
7391 if (SvPVX_const(sv) != Nullch)
7399 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7401 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7404 # if defined(USE_ENVIRON_ARRAY)
7407 # endif /* USE_ENVIRON_ARRAY */
7418 Using various gambits, try to get an IO from an SV: the IO slot if its a
7419 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7420 named after the PV if we're a string.
7426 Perl_sv_2io(pTHX_ SV *sv)
7431 switch (SvTYPE(sv)) {
7439 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7443 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7445 return sv_2io(SvRV(sv));
7446 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7452 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7461 Using various gambits, try to get a CV from an SV; in addition, try if
7462 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7468 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7475 return *gvp = Nullgv, Nullcv;
7476 switch (SvTYPE(sv)) {
7494 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7495 tryAMAGICunDEREF(to_cv);
7498 if (SvTYPE(sv) == SVt_PVCV) {
7507 Perl_croak(aTHX_ "Not a subroutine reference");
7512 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7518 if (lref && !GvCVu(gv)) {
7521 tmpsv = NEWSV(704,0);
7522 gv_efullname3(tmpsv, gv, Nullch);
7523 /* XXX this is probably not what they think they're getting.
7524 * It has the same effect as "sub name;", i.e. just a forward
7526 newSUB(start_subparse(FALSE, 0),
7527 newSVOP(OP_CONST, 0, tmpsv),
7532 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7542 Returns true if the SV has a true value by Perl's rules.
7543 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7544 instead use an in-line version.
7550 Perl_sv_true(pTHX_ register SV *sv)
7555 register const XPV* const tXpv = (XPV*)SvANY(sv);
7557 (tXpv->xpv_cur > 1 ||
7558 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7565 return SvIVX(sv) != 0;
7568 return SvNVX(sv) != 0.0;
7570 return sv_2bool(sv);
7576 =for apidoc sv_pvn_force
7578 Get a sensible string out of the SV somehow.
7579 A private implementation of the C<SvPV_force> macro for compilers which
7580 can't cope with complex macro expressions. Always use the macro instead.
7582 =for apidoc sv_pvn_force_flags
7584 Get a sensible string out of the SV somehow.
7585 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7586 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7587 implemented in terms of this function.
7588 You normally want to use the various wrapper macros instead: see
7589 C<SvPV_force> and C<SvPV_force_nomg>
7595 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7598 if (SvTHINKFIRST(sv) && !SvROK(sv))
7599 sv_force_normal_flags(sv, 0);
7609 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7610 const char * const ref = sv_reftype(sv,0);
7612 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7613 ref, OP_NAME(PL_op));
7615 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7617 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7618 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7620 s = sv_2pv_flags(sv, &len, flags);
7624 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7627 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7628 SvGROW(sv, len + 1);
7629 Move(s,SvPVX(sv),len,char);
7634 SvPOK_on(sv); /* validate pointer */
7636 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7637 PTR2UV(sv),SvPVX_const(sv)));
7640 return SvPVX_mutable(sv);
7644 =for apidoc sv_pvbyten_force
7646 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7652 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7654 sv_pvn_force(sv,lp);
7655 sv_utf8_downgrade(sv,0);
7661 =for apidoc sv_pvutf8n_force
7663 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7669 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7671 sv_pvn_force(sv,lp);
7672 sv_utf8_upgrade(sv);
7678 =for apidoc sv_reftype
7680 Returns a string describing what the SV is a reference to.
7686 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7688 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7689 inside return suggests a const propagation bug in g++. */
7690 if (ob && SvOBJECT(sv)) {
7691 char * const name = HvNAME_get(SvSTASH(sv));
7692 return name ? name : (char *) "__ANON__";
7695 switch (SvTYPE(sv)) {
7712 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7713 /* tied lvalues should appear to be
7714 * scalars for backwards compatitbility */
7715 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7716 ? "SCALAR" : "LVALUE");
7717 case SVt_PVAV: return "ARRAY";
7718 case SVt_PVHV: return "HASH";
7719 case SVt_PVCV: return "CODE";
7720 case SVt_PVGV: return "GLOB";
7721 case SVt_PVFM: return "FORMAT";
7722 case SVt_PVIO: return "IO";
7723 default: return "UNKNOWN";
7729 =for apidoc sv_isobject
7731 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7732 object. If the SV is not an RV, or if the object is not blessed, then this
7739 Perl_sv_isobject(pTHX_ SV *sv)
7755 Returns a boolean indicating whether the SV is blessed into the specified
7756 class. This does not check for subtypes; use C<sv_derived_from> to verify
7757 an inheritance relationship.
7763 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7774 hvname = HvNAME_get(SvSTASH(sv));
7778 return strEQ(hvname, name);
7784 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7785 it will be upgraded to one. If C<classname> is non-null then the new SV will
7786 be blessed in the specified package. The new SV is returned and its
7787 reference count is 1.
7793 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7799 SV_CHECK_THINKFIRST_COW_DROP(rv);
7802 if (SvTYPE(rv) >= SVt_PVMG) {
7803 const U32 refcnt = SvREFCNT(rv);
7807 SvREFCNT(rv) = refcnt;
7810 if (SvTYPE(rv) < SVt_RV)
7811 sv_upgrade(rv, SVt_RV);
7812 else if (SvTYPE(rv) > SVt_RV) {
7823 HV* const stash = gv_stashpv(classname, TRUE);
7824 (void)sv_bless(rv, stash);
7830 =for apidoc sv_setref_pv
7832 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7833 argument will be upgraded to an RV. That RV will be modified to point to
7834 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7835 into the SV. The C<classname> argument indicates the package for the
7836 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7837 will have a reference count of 1, and the RV will be returned.
7839 Do not use with other Perl types such as HV, AV, SV, CV, because those
7840 objects will become corrupted by the pointer copy process.
7842 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7848 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7851 sv_setsv(rv, &PL_sv_undef);
7855 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7860 =for apidoc sv_setref_iv
7862 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7863 argument will be upgraded to an RV. That RV will be modified to point to
7864 the new SV. The C<classname> argument indicates the package for the
7865 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7866 will have a reference count of 1, and the RV will be returned.
7872 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7874 sv_setiv(newSVrv(rv,classname), iv);
7879 =for apidoc sv_setref_uv
7881 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7882 argument will be upgraded to an RV. That RV will be modified to point to
7883 the new SV. The C<classname> argument indicates the package for the
7884 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7885 will have a reference count of 1, and the RV will be returned.
7891 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7893 sv_setuv(newSVrv(rv,classname), uv);
7898 =for apidoc sv_setref_nv
7900 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7901 argument will be upgraded to an RV. That RV will be modified to point to
7902 the new SV. The C<classname> argument indicates the package for the
7903 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7904 will have a reference count of 1, and the RV will be returned.
7910 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7912 sv_setnv(newSVrv(rv,classname), nv);
7917 =for apidoc sv_setref_pvn
7919 Copies a string into a new SV, optionally blessing the SV. The length of the
7920 string must be specified with C<n>. The C<rv> argument will be upgraded to
7921 an RV. That RV will be modified to point to the new SV. The C<classname>
7922 argument indicates the package for the blessing. Set C<classname> to
7923 C<Nullch> to avoid the blessing. The new SV will have a reference count
7924 of 1, and the RV will be returned.
7926 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7932 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7934 sv_setpvn(newSVrv(rv,classname), pv, n);
7939 =for apidoc sv_bless
7941 Blesses an SV into a specified package. The SV must be an RV. The package
7942 must be designated by its stash (see C<gv_stashpv()>). The reference count
7943 of the SV is unaffected.
7949 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7953 Perl_croak(aTHX_ "Can't bless non-reference value");
7955 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7956 if (SvREADONLY(tmpRef))
7957 Perl_croak(aTHX_ PL_no_modify);
7958 if (SvOBJECT(tmpRef)) {
7959 if (SvTYPE(tmpRef) != SVt_PVIO)
7961 SvREFCNT_dec(SvSTASH(tmpRef));
7964 SvOBJECT_on(tmpRef);
7965 if (SvTYPE(tmpRef) != SVt_PVIO)
7967 SvUPGRADE(tmpRef, SVt_PVMG);
7968 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7975 if(SvSMAGICAL(tmpRef))
7976 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7984 /* Downgrades a PVGV to a PVMG.
7988 S_sv_unglob(pTHX_ SV *sv)
7992 assert(SvTYPE(sv) == SVt_PVGV);
7997 sv_del_backref((SV*)GvSTASH(sv), sv);
7998 GvSTASH(sv) = Nullhv;
8000 sv_unmagic(sv, PERL_MAGIC_glob);
8001 Safefree(GvNAME(sv));
8004 /* need to keep SvANY(sv) in the right arena */
8005 xpvmg = new_XPVMG();
8006 StructCopy(SvANY(sv), xpvmg, XPVMG);
8007 del_XPVGV(SvANY(sv));
8010 SvFLAGS(sv) &= ~SVTYPEMASK;
8011 SvFLAGS(sv) |= SVt_PVMG;
8015 =for apidoc sv_unref_flags
8017 Unsets the RV status of the SV, and decrements the reference count of
8018 whatever was being referenced by the RV. This can almost be thought of
8019 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8020 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8021 (otherwise the decrementing is conditional on the reference count being
8022 different from one or the reference being a readonly SV).
8029 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8031 SV* const target = SvRV(ref);
8033 if (SvWEAKREF(ref)) {
8034 sv_del_backref(target, ref);
8036 SvRV_set(ref, NULL);
8039 SvRV_set(ref, NULL);
8041 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8042 assigned to as BEGIN {$a = \"Foo"} will fail. */
8043 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8044 SvREFCNT_dec(target);
8045 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8046 sv_2mortal(target); /* Schedule for freeing later */
8050 =for apidoc sv_untaint
8052 Untaint an SV. Use C<SvTAINTED_off> instead.
8057 Perl_sv_untaint(pTHX_ SV *sv)
8059 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8060 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8067 =for apidoc sv_tainted
8069 Test an SV for taintedness. Use C<SvTAINTED> instead.
8074 Perl_sv_tainted(pTHX_ SV *sv)
8076 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8077 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8078 if (mg && (mg->mg_len & 1) )
8085 =for apidoc sv_setpviv
8087 Copies an integer into the given SV, also updating its string value.
8088 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8094 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8096 char buf[TYPE_CHARS(UV)];
8098 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8100 sv_setpvn(sv, ptr, ebuf - ptr);
8104 =for apidoc sv_setpviv_mg
8106 Like C<sv_setpviv>, but also handles 'set' magic.
8112 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8118 #if defined(PERL_IMPLICIT_CONTEXT)
8120 /* pTHX_ magic can't cope with varargs, so this is a no-context
8121 * version of the main function, (which may itself be aliased to us).
8122 * Don't access this version directly.
8126 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8130 va_start(args, pat);
8131 sv_vsetpvf(sv, pat, &args);
8135 /* pTHX_ magic can't cope with varargs, so this is a no-context
8136 * version of the main function, (which may itself be aliased to us).
8137 * Don't access this version directly.
8141 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8145 va_start(args, pat);
8146 sv_vsetpvf_mg(sv, pat, &args);
8152 =for apidoc sv_setpvf
8154 Works like C<sv_catpvf> but copies the text into the SV instead of
8155 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8161 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8164 va_start(args, pat);
8165 sv_vsetpvf(sv, pat, &args);
8170 =for apidoc sv_vsetpvf
8172 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8173 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8175 Usually used via its frontend C<sv_setpvf>.
8181 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8183 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8187 =for apidoc sv_setpvf_mg
8189 Like C<sv_setpvf>, but also handles 'set' magic.
8195 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8198 va_start(args, pat);
8199 sv_vsetpvf_mg(sv, pat, &args);
8204 =for apidoc sv_vsetpvf_mg
8206 Like C<sv_vsetpvf>, but also handles 'set' magic.
8208 Usually used via its frontend C<sv_setpvf_mg>.
8214 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8216 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8220 #if defined(PERL_IMPLICIT_CONTEXT)
8222 /* pTHX_ magic can't cope with varargs, so this is a no-context
8223 * version of the main function, (which may itself be aliased to us).
8224 * Don't access this version directly.
8228 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8232 va_start(args, pat);
8233 sv_vcatpvf(sv, pat, &args);
8237 /* pTHX_ magic can't cope with varargs, so this is a no-context
8238 * version of the main function, (which may itself be aliased to us).
8239 * Don't access this version directly.
8243 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8247 va_start(args, pat);
8248 sv_vcatpvf_mg(sv, pat, &args);
8254 =for apidoc sv_catpvf
8256 Processes its arguments like C<sprintf> and appends the formatted
8257 output to an SV. If the appended data contains "wide" characters
8258 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8259 and characters >255 formatted with %c), the original SV might get
8260 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8261 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8262 valid UTF-8; if the original SV was bytes, the pattern should be too.
8267 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8270 va_start(args, pat);
8271 sv_vcatpvf(sv, pat, &args);
8276 =for apidoc sv_vcatpvf
8278 Processes its arguments like C<vsprintf> and appends the formatted output
8279 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8281 Usually used via its frontend C<sv_catpvf>.
8287 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8289 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8293 =for apidoc sv_catpvf_mg
8295 Like C<sv_catpvf>, but also handles 'set' magic.
8301 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8304 va_start(args, pat);
8305 sv_vcatpvf_mg(sv, pat, &args);
8310 =for apidoc sv_vcatpvf_mg
8312 Like C<sv_vcatpvf>, but also handles 'set' magic.
8314 Usually used via its frontend C<sv_catpvf_mg>.
8320 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8322 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8327 =for apidoc sv_vsetpvfn
8329 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8332 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8338 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8340 sv_setpvn(sv, "", 0);
8341 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8344 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8347 S_expect_number(pTHX_ char** pattern)
8350 switch (**pattern) {
8351 case '1': case '2': case '3':
8352 case '4': case '5': case '6':
8353 case '7': case '8': case '9':
8354 while (isDIGIT(**pattern))
8355 var = var * 10 + (*(*pattern)++ - '0');
8359 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8362 F0convert(NV nv, char *endbuf, STRLEN *len)
8364 const int neg = nv < 0;
8373 if (uv & 1 && uv == nv)
8374 uv--; /* Round to even */
8376 const unsigned dig = uv % 10;
8389 =for apidoc sv_vcatpvfn
8391 Processes its arguments like C<vsprintf> and appends the formatted output
8392 to an SV. Uses an array of SVs if the C style variable argument list is
8393 missing (NULL). When running with taint checks enabled, indicates via
8394 C<maybe_tainted> if results are untrustworthy (often due to the use of
8397 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8403 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8404 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8405 vec_utf8 = DO_UTF8(vecsv);
8407 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8410 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8417 static const char nullstr[] = "(null)";
8419 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8420 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8422 /* Times 4: a decimal digit takes more than 3 binary digits.
8423 * NV_DIG: mantissa takes than many decimal digits.
8424 * Plus 32: Playing safe. */
8425 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8426 /* large enough for "%#.#f" --chip */
8427 /* what about long double NVs? --jhi */
8429 PERL_UNUSED_ARG(maybe_tainted);
8431 /* no matter what, this is a string now */
8432 (void)SvPV_force(sv, origlen);
8434 /* special-case "", "%s", and "%-p" (SVf - see below) */
8437 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8439 const char * const s = va_arg(*args, char*);
8440 sv_catpv(sv, s ? s : nullstr);
8442 else if (svix < svmax) {
8443 sv_catsv(sv, *svargs);
8444 if (DO_UTF8(*svargs))
8449 if (args && patlen == 3 && pat[0] == '%' &&
8450 pat[1] == '-' && pat[2] == 'p') {
8451 argsv = va_arg(*args, SV*);
8452 sv_catsv(sv, argsv);
8458 #ifndef USE_LONG_DOUBLE
8459 /* special-case "%.<number>[gf]" */
8460 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8461 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8462 unsigned digits = 0;
8466 while (*pp >= '0' && *pp <= '9')
8467 digits = 10 * digits + (*pp++ - '0');
8468 if (pp - pat == (int)patlen - 1) {
8476 /* Add check for digits != 0 because it seems that some
8477 gconverts are buggy in this case, and we don't yet have
8478 a Configure test for this. */
8479 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8480 /* 0, point, slack */
8481 Gconvert(nv, (int)digits, 0, ebuf);
8483 if (*ebuf) /* May return an empty string for digits==0 */
8486 } else if (!digits) {
8489 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8490 sv_catpvn(sv, p, l);
8496 #endif /* !USE_LONG_DOUBLE */
8498 if (!args && svix < svmax && DO_UTF8(*svargs))
8501 patend = (char*)pat + patlen;
8502 for (p = (char*)pat; p < patend; p = q) {
8505 bool vectorize = FALSE;
8506 bool vectorarg = FALSE;
8507 bool vec_utf8 = FALSE;
8513 bool has_precis = FALSE;
8516 bool is_utf8 = FALSE; /* is this item utf8? */
8517 #ifdef HAS_LDBL_SPRINTF_BUG
8518 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8519 with sfio - Allen <allens@cpan.org> */
8520 bool fix_ldbl_sprintf_bug = FALSE;
8524 U8 utf8buf[UTF8_MAXBYTES+1];
8525 STRLEN esignlen = 0;
8527 const char *eptr = Nullch;
8530 const U8 *vecstr = Null(U8*);
8537 /* we need a long double target in case HAS_LONG_DOUBLE but
8540 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8548 const char *dotstr = ".";
8549 STRLEN dotstrlen = 1;
8550 I32 efix = 0; /* explicit format parameter index */
8551 I32 ewix = 0; /* explicit width index */
8552 I32 epix = 0; /* explicit precision index */
8553 I32 evix = 0; /* explicit vector index */
8554 bool asterisk = FALSE;
8556 /* echo everything up to the next format specification */
8557 for (q = p; q < patend && *q != '%'; ++q) ;
8559 if (has_utf8 && !pat_utf8)
8560 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8562 sv_catpvn(sv, p, q - p);
8569 We allow format specification elements in this order:
8570 \d+\$ explicit format parameter index
8572 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8573 0 flag (as above): repeated to allow "v02"
8574 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8575 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8577 [%bcdefginopsuxDFOUX] format (mandatory)
8582 As of perl5.9.3, printf format checking is on by default.
8583 Internally, perl uses %p formats to provide an escape to
8584 some extended formatting. This block deals with those
8585 extensions: if it does not match, (char*)q is reset and
8586 the normal format processing code is used.
8588 Currently defined extensions are:
8589 %p include pointer address (standard)
8590 %-p (SVf) include an SV (previously %_)
8591 %-<num>p include an SV with precision <num>
8592 %1p (VDf) include a v-string (as %vd)
8593 %<num>p reserved for future extensions
8595 Robin Barker 2005-07-14
8602 EXPECT_NUMBER(q, n);
8609 argsv = va_arg(*args, SV*);
8610 eptr = SvPVx_const(argsv, elen);
8616 else if (n == vdNUMBER) { /* VDf */
8623 if (ckWARN_d(WARN_INTERNAL))
8624 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8625 "internal %%<num>p might conflict with future printf extensions");
8631 if (EXPECT_NUMBER(q, width)) {
8672 if (EXPECT_NUMBER(q, ewix))
8681 if ((vectorarg = asterisk)) {
8694 EXPECT_NUMBER(q, width);
8700 vecsv = va_arg(*args, SV*);
8702 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8703 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8704 dotstr = SvPV_const(vecsv, dotstrlen);
8711 else if (efix ? efix <= svmax : svix < svmax) {
8712 vecsv = svargs[efix ? efix-1 : svix++];
8713 vecstr = (U8*)SvPV_const(vecsv,veclen);
8714 vec_utf8 = DO_UTF8(vecsv);
8715 /* if this is a version object, we need to return the
8716 * stringified representation (which the SvPVX_const has
8717 * already done for us), but not vectorize the args
8719 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8721 q++; /* skip past the rest of the %vd format */
8722 eptr = (const char *) vecstr;
8723 elen = strlen(eptr);
8736 i = va_arg(*args, int);
8738 i = (ewix ? ewix <= svmax : svix < svmax) ?
8739 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8741 width = (i < 0) ? -i : i;
8751 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8753 /* XXX: todo, support specified precision parameter */
8757 i = va_arg(*args, int);
8759 i = (ewix ? ewix <= svmax : svix < svmax)
8760 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8761 precis = (i < 0) ? 0 : i;
8766 precis = precis * 10 + (*q++ - '0');
8775 case 'I': /* Ix, I32x, and I64x */
8777 if (q[1] == '6' && q[2] == '4') {
8783 if (q[1] == '3' && q[2] == '2') {
8793 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8804 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8805 if (*(q + 1) == 'l') { /* lld, llf */
8830 argsv = (efix ? efix <= svmax : svix < svmax) ?
8831 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8838 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8840 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8842 eptr = (char*)utf8buf;
8843 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8854 if (args && !vectorize) {
8855 eptr = va_arg(*args, char*);
8857 #ifdef MACOS_TRADITIONAL
8858 /* On MacOS, %#s format is used for Pascal strings */
8863 elen = strlen(eptr);
8865 eptr = (char *)nullstr;
8866 elen = sizeof nullstr - 1;
8870 eptr = SvPVx_const(argsv, elen);
8871 if (DO_UTF8(argsv)) {
8872 if (has_precis && precis < elen) {
8874 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8877 if (width) { /* fudge width (can't fudge elen) */
8878 width += elen - sv_len_utf8(argsv);
8886 if (has_precis && elen > precis)
8893 if (alt || vectorize)
8895 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8916 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8925 esignbuf[esignlen++] = plus;
8929 case 'h': iv = (short)va_arg(*args, int); break;
8930 case 'l': iv = va_arg(*args, long); break;
8931 case 'V': iv = va_arg(*args, IV); break;
8932 default: iv = va_arg(*args, int); break;
8934 case 'q': iv = va_arg(*args, Quad_t); break;
8939 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8941 case 'h': iv = (short)tiv; break;
8942 case 'l': iv = (long)tiv; break;
8944 default: iv = tiv; break;
8946 case 'q': iv = (Quad_t)tiv; break;
8950 if ( !vectorize ) /* we already set uv above */
8955 esignbuf[esignlen++] = plus;
8959 esignbuf[esignlen++] = '-';
9002 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9013 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9014 case 'l': uv = va_arg(*args, unsigned long); break;
9015 case 'V': uv = va_arg(*args, UV); break;
9016 default: uv = va_arg(*args, unsigned); break;
9018 case 'q': uv = va_arg(*args, Uquad_t); break;
9023 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9025 case 'h': uv = (unsigned short)tuv; break;
9026 case 'l': uv = (unsigned long)tuv; break;
9028 default: uv = tuv; break;
9030 case 'q': uv = (Uquad_t)tuv; break;
9037 char *ptr = ebuf + sizeof ebuf;
9043 p = (char*)((c == 'X')
9044 ? "0123456789ABCDEF" : "0123456789abcdef");
9050 esignbuf[esignlen++] = '0';
9051 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9059 if (alt && *ptr != '0')
9068 esignbuf[esignlen++] = '0';
9069 esignbuf[esignlen++] = 'b';
9072 default: /* it had better be ten or less */
9076 } while (uv /= base);
9079 elen = (ebuf + sizeof ebuf) - ptr;
9083 zeros = precis - elen;
9084 else if (precis == 0 && elen == 1 && *eptr == '0')
9090 /* FLOATING POINT */
9093 c = 'f'; /* maybe %F isn't supported here */
9099 /* This is evil, but floating point is even more evil */
9101 /* for SV-style calling, we can only get NV
9102 for C-style calling, we assume %f is double;
9103 for simplicity we allow any of %Lf, %llf, %qf for long double
9107 #if defined(USE_LONG_DOUBLE)
9111 /* [perl #20339] - we should accept and ignore %lf rather than die */
9115 #if defined(USE_LONG_DOUBLE)
9116 intsize = args ? 0 : 'q';
9120 #if defined(HAS_LONG_DOUBLE)
9129 /* now we need (long double) if intsize == 'q', else (double) */
9130 nv = (args && !vectorize) ?
9131 #if LONG_DOUBLESIZE > DOUBLESIZE
9133 va_arg(*args, long double) :
9134 va_arg(*args, double)
9136 va_arg(*args, double)
9142 if (c != 'e' && c != 'E') {
9144 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9145 will cast our (long double) to (double) */
9146 (void)Perl_frexp(nv, &i);
9147 if (i == PERL_INT_MIN)
9148 Perl_die(aTHX_ "panic: frexp");
9150 need = BIT_DIGITS(i);
9152 need += has_precis ? precis : 6; /* known default */
9157 #ifdef HAS_LDBL_SPRINTF_BUG
9158 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9159 with sfio - Allen <allens@cpan.org> */
9162 # define MY_DBL_MAX DBL_MAX
9163 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9164 # if DOUBLESIZE >= 8
9165 # define MY_DBL_MAX 1.7976931348623157E+308L
9167 # define MY_DBL_MAX 3.40282347E+38L
9171 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9172 # define MY_DBL_MAX_BUG 1L
9174 # define MY_DBL_MAX_BUG MY_DBL_MAX
9178 # define MY_DBL_MIN DBL_MIN
9179 # else /* XXX guessing! -Allen */
9180 # if DOUBLESIZE >= 8
9181 # define MY_DBL_MIN 2.2250738585072014E-308L
9183 # define MY_DBL_MIN 1.17549435E-38L
9187 if ((intsize == 'q') && (c == 'f') &&
9188 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9190 /* it's going to be short enough that
9191 * long double precision is not needed */
9193 if ((nv <= 0L) && (nv >= -0L))
9194 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9196 /* would use Perl_fp_class as a double-check but not
9197 * functional on IRIX - see perl.h comments */
9199 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9200 /* It's within the range that a double can represent */
9201 #if defined(DBL_MAX) && !defined(DBL_MIN)
9202 if ((nv >= ((long double)1/DBL_MAX)) ||
9203 (nv <= (-(long double)1/DBL_MAX)))
9205 fix_ldbl_sprintf_bug = TRUE;
9208 if (fix_ldbl_sprintf_bug == TRUE) {
9218 # undef MY_DBL_MAX_BUG
9221 #endif /* HAS_LDBL_SPRINTF_BUG */
9223 need += 20; /* fudge factor */
9224 if (PL_efloatsize < need) {
9225 Safefree(PL_efloatbuf);
9226 PL_efloatsize = need + 20; /* more fudge */
9227 Newx(PL_efloatbuf, PL_efloatsize, char);
9228 PL_efloatbuf[0] = '\0';
9231 if ( !(width || left || plus || alt) && fill != '0'
9232 && has_precis && intsize != 'q' ) { /* Shortcuts */
9233 /* See earlier comment about buggy Gconvert when digits,
9235 if ( c == 'g' && precis) {
9236 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9237 /* May return an empty string for digits==0 */
9238 if (*PL_efloatbuf) {
9239 elen = strlen(PL_efloatbuf);
9240 goto float_converted;
9242 } else if ( c == 'f' && !precis) {
9243 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9248 char *ptr = ebuf + sizeof ebuf;
9251 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9252 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9253 if (intsize == 'q') {
9254 /* Copy the one or more characters in a long double
9255 * format before the 'base' ([efgEFG]) character to
9256 * the format string. */
9257 static char const prifldbl[] = PERL_PRIfldbl;
9258 char const *p = prifldbl + sizeof(prifldbl) - 3;
9259 while (p >= prifldbl) { *--ptr = *p--; }
9264 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9269 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9281 /* No taint. Otherwise we are in the strange situation
9282 * where printf() taints but print($float) doesn't.
9284 #if defined(HAS_LONG_DOUBLE)
9285 elen = ((intsize == 'q')
9286 ? my_sprintf(PL_efloatbuf, ptr, nv)
9287 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9289 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9293 eptr = PL_efloatbuf;
9299 i = SvCUR(sv) - origlen;
9300 if (args && !vectorize) {
9302 case 'h': *(va_arg(*args, short*)) = i; break;
9303 default: *(va_arg(*args, int*)) = i; break;
9304 case 'l': *(va_arg(*args, long*)) = i; break;
9305 case 'V': *(va_arg(*args, IV*)) = i; break;
9307 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9312 sv_setuv_mg(argsv, (UV)i);
9314 continue; /* not "break" */
9321 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9322 && ckWARN(WARN_PRINTF))
9324 SV * const msg = sv_newmortal();
9325 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9326 (PL_op->op_type == OP_PRTF) ? "" : "s");
9329 Perl_sv_catpvf(aTHX_ msg,
9330 "\"%%%c\"", c & 0xFF);
9332 Perl_sv_catpvf(aTHX_ msg,
9333 "\"%%\\%03"UVof"\"",
9336 sv_catpv(msg, "end of string");
9337 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9340 /* output mangled stuff ... */
9346 /* ... right here, because formatting flags should not apply */
9347 SvGROW(sv, SvCUR(sv) + elen + 1);
9349 Copy(eptr, p, elen, char);
9352 SvCUR_set(sv, p - SvPVX_const(sv));
9354 continue; /* not "break" */
9357 /* calculate width before utf8_upgrade changes it */
9358 have = esignlen + zeros + elen;
9360 if (is_utf8 != has_utf8) {
9363 sv_utf8_upgrade(sv);
9366 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9367 sv_utf8_upgrade(nsv);
9368 eptr = SvPVX_const(nsv);
9371 SvGROW(sv, SvCUR(sv) + elen + 1);
9376 need = (have > width ? have : width);
9379 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9381 if (esignlen && fill == '0') {
9383 for (i = 0; i < (int)esignlen; i++)
9387 memset(p, fill, gap);
9390 if (esignlen && fill != '0') {
9392 for (i = 0; i < (int)esignlen; i++)
9397 for (i = zeros; i; i--)
9401 Copy(eptr, p, elen, char);
9405 memset(p, ' ', gap);
9410 Copy(dotstr, p, dotstrlen, char);
9414 vectorize = FALSE; /* done iterating over vecstr */
9421 SvCUR_set(sv, p - SvPVX_const(sv));
9429 /* =========================================================================
9431 =head1 Cloning an interpreter
9433 All the macros and functions in this section are for the private use of
9434 the main function, perl_clone().
9436 The foo_dup() functions make an exact copy of an existing foo thinngy.
9437 During the course of a cloning, a hash table is used to map old addresses
9438 to new addresses. The table is created and manipulated with the
9439 ptr_table_* functions.
9443 ============================================================================*/
9446 #if defined(USE_ITHREADS)
9448 #ifndef GpREFCNT_inc
9449 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9453 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9454 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9455 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9456 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9457 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9459 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9461 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9463 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9465 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9468 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9469 regcomp.c. AMS 20010712 */
9472 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9477 struct reg_substr_datum *s;
9480 return (REGEXP *)NULL;
9482 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9485 len = r->offsets[0];
9486 npar = r->nparens+1;
9488 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9489 Copy(r->program, ret->program, len+1, regnode);
9491 Newx(ret->startp, npar, I32);
9492 Copy(r->startp, ret->startp, npar, I32);
9493 Newx(ret->endp, npar, I32);
9494 Copy(r->startp, ret->startp, npar, I32);
9496 Newx(ret->substrs, 1, struct reg_substr_data);
9497 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9498 s->min_offset = r->substrs->data[i].min_offset;
9499 s->max_offset = r->substrs->data[i].max_offset;
9500 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9501 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9504 ret->regstclass = NULL;
9507 const int count = r->data->count;
9510 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9511 char, struct reg_data);
9512 Newx(d->what, count, U8);
9515 for (i = 0; i < count; i++) {
9516 d->what[i] = r->data->what[i];
9517 switch (d->what[i]) {
9518 /* legal options are one of: sfpont
9519 see also regcomp.h and pregfree() */
9521 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9524 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9527 /* This is cheating. */
9528 Newx(d->data[i], 1, struct regnode_charclass_class);
9529 StructCopy(r->data->data[i], d->data[i],
9530 struct regnode_charclass_class);
9531 ret->regstclass = (regnode*)d->data[i];
9534 /* Compiled op trees are readonly, and can thus be
9535 shared without duplication. */
9537 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9541 d->data[i] = r->data->data[i];
9544 d->data[i] = r->data->data[i];
9546 ((reg_trie_data*)d->data[i])->refcount++;
9550 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9559 Newx(ret->offsets, 2*len+1, U32);
9560 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9562 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9563 ret->refcnt = r->refcnt;
9564 ret->minlen = r->minlen;
9565 ret->prelen = r->prelen;
9566 ret->nparens = r->nparens;
9567 ret->lastparen = r->lastparen;
9568 ret->lastcloseparen = r->lastcloseparen;
9569 ret->reganch = r->reganch;
9571 ret->sublen = r->sublen;
9573 if (RX_MATCH_COPIED(ret))
9574 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9576 ret->subbeg = Nullch;
9577 #ifdef PERL_OLD_COPY_ON_WRITE
9578 ret->saved_copy = Nullsv;
9581 ptr_table_store(PL_ptr_table, r, ret);
9585 /* duplicate a file handle */
9588 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9592 PERL_UNUSED_ARG(type);
9595 return (PerlIO*)NULL;
9597 /* look for it in the table first */
9598 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9602 /* create anew and remember what it is */
9603 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9604 ptr_table_store(PL_ptr_table, fp, ret);
9608 /* duplicate a directory handle */
9611 Perl_dirp_dup(pTHX_ DIR *dp)
9619 /* duplicate a typeglob */
9622 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9627 /* look for it in the table first */
9628 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9632 /* create anew and remember what it is */
9634 ptr_table_store(PL_ptr_table, gp, ret);
9637 ret->gp_refcnt = 0; /* must be before any other dups! */
9638 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9639 ret->gp_io = io_dup_inc(gp->gp_io, param);
9640 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9641 ret->gp_av = av_dup_inc(gp->gp_av, param);
9642 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9643 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9644 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9645 ret->gp_cvgen = gp->gp_cvgen;
9646 ret->gp_line = gp->gp_line;
9647 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9651 /* duplicate a chain of magic */
9654 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9656 MAGIC *mgprev = (MAGIC*)NULL;
9659 return (MAGIC*)NULL;
9660 /* look for it in the table first */
9661 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9665 for (; mg; mg = mg->mg_moremagic) {
9667 Newxz(nmg, 1, MAGIC);
9669 mgprev->mg_moremagic = nmg;
9672 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9673 nmg->mg_private = mg->mg_private;
9674 nmg->mg_type = mg->mg_type;
9675 nmg->mg_flags = mg->mg_flags;
9676 if (mg->mg_type == PERL_MAGIC_qr) {
9677 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9679 else if(mg->mg_type == PERL_MAGIC_backref) {
9680 const AV * const av = (AV*) mg->mg_obj;
9683 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9685 for (i = AvFILLp(av); i >= 0; i--) {
9686 if (!svp[i]) continue;
9687 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9690 else if (mg->mg_type == PERL_MAGIC_symtab) {
9691 nmg->mg_obj = mg->mg_obj;
9694 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9695 ? sv_dup_inc(mg->mg_obj, param)
9696 : sv_dup(mg->mg_obj, param);
9698 nmg->mg_len = mg->mg_len;
9699 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9700 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9701 if (mg->mg_len > 0) {
9702 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9703 if (mg->mg_type == PERL_MAGIC_overload_table &&
9704 AMT_AMAGIC((AMT*)mg->mg_ptr))
9706 AMT *amtp = (AMT*)mg->mg_ptr;
9707 AMT *namtp = (AMT*)nmg->mg_ptr;
9709 for (i = 1; i < NofAMmeth; i++) {
9710 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9714 else if (mg->mg_len == HEf_SVKEY)
9715 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9717 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9718 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9725 /* create a new pointer-mapping table */
9728 Perl_ptr_table_new(pTHX)
9731 Newxz(tbl, 1, PTR_TBL_t);
9734 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9739 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9741 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9744 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
9746 /* map an existing pointer using a table */
9749 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9751 PTR_TBL_ENT_t *tblent;
9752 const UV hash = PTR_TABLE_HASH(sv);
9754 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9755 for (; tblent; tblent = tblent->next) {
9756 if (tblent->oldval == sv)
9757 return tblent->newval;
9762 /* add a new entry to a pointer-mapping table */
9765 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9767 PTR_TBL_ENT_t *tblent, **otblent;
9768 /* XXX this may be pessimal on platforms where pointers aren't good
9769 * hash values e.g. if they grow faster in the most significant
9771 const UV hash = PTR_TABLE_HASH(oldsv);
9775 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9776 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9777 if (tblent->oldval == oldsv) {
9778 tblent->newval = newsv;
9782 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
9783 sizeof(struct ptr_tbl_ent));
9784 tblent->oldval = oldsv;
9785 tblent->newval = newsv;
9786 tblent->next = *otblent;
9789 if (!empty && tbl->tbl_items > tbl->tbl_max)
9790 ptr_table_split(tbl);
9793 /* double the hash bucket size of an existing ptr table */
9796 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9798 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9799 const UV oldsize = tbl->tbl_max + 1;
9800 UV newsize = oldsize * 2;
9803 Renew(ary, newsize, PTR_TBL_ENT_t*);
9804 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9805 tbl->tbl_max = --newsize;
9807 for (i=0; i < oldsize; i++, ary++) {
9808 PTR_TBL_ENT_t **curentp, **entp, *ent;
9811 curentp = ary + oldsize;
9812 for (entp = ary, ent = *ary; ent; ent = *entp) {
9813 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9815 ent->next = *curentp;
9825 /* remove all the entries from a ptr table */
9828 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9830 register PTR_TBL_ENT_t **array;
9831 register PTR_TBL_ENT_t *entry;
9835 if (!tbl || !tbl->tbl_items) {
9839 array = tbl->tbl_ary;
9845 PTR_TBL_ENT_t *oentry = entry;
9846 entry = entry->next;
9850 if (++riter > max) {
9853 entry = array[riter];
9860 /* clear and free a ptr table */
9863 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9868 ptr_table_clear(tbl);
9869 Safefree(tbl->tbl_ary);
9875 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9878 SvRV_set(dstr, SvWEAKREF(sstr)
9879 ? sv_dup(SvRV(sstr), param)
9880 : sv_dup_inc(SvRV(sstr), param));
9883 else if (SvPVX_const(sstr)) {
9884 /* Has something there */
9886 /* Normal PV - clone whole allocated space */
9887 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9888 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9889 /* Not that normal - actually sstr is copy on write.
9890 But we are a true, independant SV, so: */
9891 SvREADONLY_off(dstr);
9896 /* Special case - not normally malloced for some reason */
9897 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9898 /* A "shared" PV - clone it as "shared" PV */
9900 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9904 /* Some other special case - random pointer */
9905 SvPV_set(dstr, SvPVX(sstr));
9911 if (SvTYPE(dstr) == SVt_RV)
9912 SvRV_set(dstr, NULL);
9918 /* duplicate an SV of any type (including AV, HV etc) */
9921 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9926 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9928 /* look for it in the table first */
9929 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9933 if(param->flags & CLONEf_JOIN_IN) {
9934 /** We are joining here so we don't want do clone
9935 something that is bad **/
9938 if(SvTYPE(sstr) == SVt_PVHV &&
9939 (hvname = HvNAME_get(sstr))) {
9940 /** don't clone stashes if they already exist **/
9941 return (SV*)gv_stashpv(hvname,0);
9945 /* create anew and remember what it is */
9948 #ifdef DEBUG_LEAKING_SCALARS
9949 dstr->sv_debug_optype = sstr->sv_debug_optype;
9950 dstr->sv_debug_line = sstr->sv_debug_line;
9951 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9952 dstr->sv_debug_cloned = 1;
9954 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9956 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9960 ptr_table_store(PL_ptr_table, sstr, dstr);
9963 SvFLAGS(dstr) = SvFLAGS(sstr);
9964 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9965 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9968 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9969 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9970 PL_watch_pvx, SvPVX_const(sstr));
9973 /* don't clone objects whose class has asked us not to */
9974 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9975 SvFLAGS(dstr) &= ~SVTYPEMASK;
9980 switch (SvTYPE(sstr)) {
9985 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9986 SvIV_set(dstr, SvIVX(sstr));
9989 SvANY(dstr) = new_XNV();
9990 SvNV_set(dstr, SvNVX(sstr));
9993 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9994 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9998 /* These are all the types that need complex bodies allocating. */
9999 size_t new_body_length;
10000 size_t new_body_offset = 0;
10001 void **new_body_arena;
10002 void **new_body_arenaroot;
10005 switch (SvTYPE(sstr)) {
10007 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10012 new_body = new_XPVIO();
10013 new_body_length = sizeof(XPVIO);
10016 new_body = new_XPVFM();
10017 new_body_length = sizeof(XPVFM);
10021 new_body_arena = (void **) &PL_xpvhv_root;
10022 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10023 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10024 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10025 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10026 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10030 new_body_arena = (void **) &PL_xpvav_root;
10031 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10032 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10033 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10034 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10035 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10039 new_body_length = sizeof(XPVBM);
10040 new_body_arena = (void **) &PL_xpvbm_root;
10041 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10044 if (GvUNIQUE((GV*)sstr)) {
10045 /* Do sharing here. */
10047 new_body_length = sizeof(XPVGV);
10048 new_body_arena = (void **) &PL_xpvgv_root;
10049 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10052 new_body_length = sizeof(XPVCV);
10053 new_body_arena = (void **) &PL_xpvcv_root;
10054 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10057 new_body_length = sizeof(XPVLV);
10058 new_body_arena = (void **) &PL_xpvlv_root;
10059 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10062 new_body_length = sizeof(XPVMG);
10063 new_body_arena = (void **) &PL_xpvmg_root;
10064 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10067 new_body_length = sizeof(XPVNV);
10068 new_body_arena = (void **) &PL_xpvnv_root;
10069 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10072 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10073 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10074 new_body_length = sizeof(XPVIV) - new_body_offset;
10075 new_body_arena = (void **) &PL_xpviv_root;
10076 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10079 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10080 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10081 new_body_length = sizeof(XPV) - new_body_offset;
10082 new_body_arena = (void **) &PL_xpv_root;
10083 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10085 assert(new_body_length);
10087 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10089 new_body = (void*)((char*)new_body - new_body_offset);
10091 /* We always allocated the full length item with PURIFY */
10092 new_body_length += new_body_offset;
10093 new_body_offset = 0;
10094 new_body = my_safemalloc(new_body_length);
10098 SvANY(dstr) = new_body;
10100 Copy(((char*)SvANY(sstr)) + new_body_offset,
10101 ((char*)SvANY(dstr)) + new_body_offset,
10102 new_body_length, char);
10104 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10105 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10107 /* The Copy above means that all the source (unduplicated) pointers
10108 are now in the destination. We can check the flags and the
10109 pointers in either, but it's possible that there's less cache
10110 missing by always going for the destination.
10111 FIXME - instrument and check that assumption */
10112 if (SvTYPE(sstr) >= SVt_PVMG) {
10114 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10116 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10119 switch (SvTYPE(sstr)) {
10131 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10132 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10133 LvTARG(dstr) = dstr;
10134 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10135 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10137 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10140 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10141 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10142 /* Don't call sv_add_backref here as it's going to be created
10143 as part of the magic cloning of the symbol table. */
10144 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10145 (void)GpREFCNT_inc(GvGP(dstr));
10148 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10149 if (IoOFP(dstr) == IoIFP(sstr))
10150 IoOFP(dstr) = IoIFP(dstr);
10152 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10153 /* PL_rsfp_filters entries have fake IoDIRP() */
10154 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10155 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10156 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10157 /* I have no idea why fake dirp (rsfps)
10158 should be treated differently but otherwise
10159 we end up with leaks -- sky*/
10160 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10161 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10162 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10164 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10165 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10166 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10168 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10169 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10170 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10173 if (AvARRAY((AV*)sstr)) {
10174 SV **dst_ary, **src_ary;
10175 SSize_t items = AvFILLp((AV*)sstr) + 1;
10177 src_ary = AvARRAY((AV*)sstr);
10178 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10179 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10180 SvPV_set(dstr, (char*)dst_ary);
10181 AvALLOC((AV*)dstr) = dst_ary;
10182 if (AvREAL((AV*)sstr)) {
10183 while (items-- > 0)
10184 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10187 while (items-- > 0)
10188 *dst_ary++ = sv_dup(*src_ary++, param);
10190 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10191 while (items-- > 0) {
10192 *dst_ary++ = &PL_sv_undef;
10196 SvPV_set(dstr, Nullch);
10197 AvALLOC((AV*)dstr) = (SV**)NULL;
10204 if (HvARRAY((HV*)sstr)) {
10206 const bool sharekeys = !!HvSHAREKEYS(sstr);
10207 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10208 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10210 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10211 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10213 HvARRAY(dstr) = (HE**)darray;
10214 while (i <= sxhv->xhv_max) {
10215 const HE *source = HvARRAY(sstr)[i];
10216 HvARRAY(dstr)[i] = source
10217 ? he_dup(source, sharekeys, param) : 0;
10221 struct xpvhv_aux *saux = HvAUX(sstr);
10222 struct xpvhv_aux *daux = HvAUX(dstr);
10223 /* This flag isn't copied. */
10224 /* SvOOK_on(hv) attacks the IV flags. */
10225 SvFLAGS(dstr) |= SVf_OOK;
10227 hvname = saux->xhv_name;
10229 = hvname ? hek_dup(hvname, param) : hvname;
10231 daux->xhv_riter = saux->xhv_riter;
10232 daux->xhv_eiter = saux->xhv_eiter
10233 ? he_dup(saux->xhv_eiter,
10234 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10238 SvPV_set(dstr, Nullch);
10240 /* Record stashes for possible cloning in Perl_clone(). */
10242 av_push(param->stashes, dstr);
10247 /* NOTE: not refcounted */
10248 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10250 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10252 if (CvCONST(dstr)) {
10253 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10254 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10255 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10257 /* don't dup if copying back - CvGV isn't refcounted, so the
10258 * duped GV may never be freed. A bit of a hack! DAPM */
10259 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10260 Nullgv : gv_dup(CvGV(dstr), param) ;
10261 if (!(param->flags & CLONEf_COPY_STACKS)) {
10264 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10266 CvWEAKOUTSIDE(sstr)
10267 ? cv_dup( CvOUTSIDE(dstr), param)
10268 : cv_dup_inc(CvOUTSIDE(dstr), param);
10270 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10276 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10282 /* duplicate a context */
10285 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10287 PERL_CONTEXT *ncxs;
10290 return (PERL_CONTEXT*)NULL;
10292 /* look for it in the table first */
10293 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10297 /* create anew and remember what it is */
10298 Newxz(ncxs, max + 1, PERL_CONTEXT);
10299 ptr_table_store(PL_ptr_table, cxs, ncxs);
10302 PERL_CONTEXT *cx = &cxs[ix];
10303 PERL_CONTEXT *ncx = &ncxs[ix];
10304 ncx->cx_type = cx->cx_type;
10305 if (CxTYPE(cx) == CXt_SUBST) {
10306 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10309 ncx->blk_oldsp = cx->blk_oldsp;
10310 ncx->blk_oldcop = cx->blk_oldcop;
10311 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10312 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10313 ncx->blk_oldpm = cx->blk_oldpm;
10314 ncx->blk_gimme = cx->blk_gimme;
10315 switch (CxTYPE(cx)) {
10317 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10318 ? cv_dup_inc(cx->blk_sub.cv, param)
10319 : cv_dup(cx->blk_sub.cv,param));
10320 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10321 ? av_dup_inc(cx->blk_sub.argarray, param)
10323 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10324 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10325 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10326 ncx->blk_sub.lval = cx->blk_sub.lval;
10327 ncx->blk_sub.retop = cx->blk_sub.retop;
10330 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10331 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10332 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10333 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10334 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10335 ncx->blk_eval.retop = cx->blk_eval.retop;
10338 ncx->blk_loop.label = cx->blk_loop.label;
10339 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10340 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10341 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10342 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10343 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10344 ? cx->blk_loop.iterdata
10345 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10346 ncx->blk_loop.oldcomppad
10347 = (PAD*)ptr_table_fetch(PL_ptr_table,
10348 cx->blk_loop.oldcomppad);
10349 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10350 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10351 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10352 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10353 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10356 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10357 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10358 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10359 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10360 ncx->blk_sub.retop = cx->blk_sub.retop;
10372 /* duplicate a stack info structure */
10375 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10380 return (PERL_SI*)NULL;
10382 /* look for it in the table first */
10383 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10387 /* create anew and remember what it is */
10388 Newxz(nsi, 1, PERL_SI);
10389 ptr_table_store(PL_ptr_table, si, nsi);
10391 nsi->si_stack = av_dup_inc(si->si_stack, param);
10392 nsi->si_cxix = si->si_cxix;
10393 nsi->si_cxmax = si->si_cxmax;
10394 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10395 nsi->si_type = si->si_type;
10396 nsi->si_prev = si_dup(si->si_prev, param);
10397 nsi->si_next = si_dup(si->si_next, param);
10398 nsi->si_markoff = si->si_markoff;
10403 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10404 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10405 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10406 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10407 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10408 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10409 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10410 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10411 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10412 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10413 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10414 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10415 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10416 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10419 #define pv_dup_inc(p) SAVEPV(p)
10420 #define pv_dup(p) SAVEPV(p)
10421 #define svp_dup_inc(p,pp) any_dup(p,pp)
10423 /* map any object to the new equivent - either something in the
10424 * ptr table, or something in the interpreter structure
10428 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10433 return (void*)NULL;
10435 /* look for it in the table first */
10436 ret = ptr_table_fetch(PL_ptr_table, v);
10440 /* see if it is part of the interpreter structure */
10441 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10442 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10450 /* duplicate the save stack */
10453 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10455 ANY * const ss = proto_perl->Tsavestack;
10456 const I32 max = proto_perl->Tsavestack_max;
10457 I32 ix = proto_perl->Tsavestack_ix;
10469 void (*dptr) (void*);
10470 void (*dxptr) (pTHX_ void*);
10472 Newxz(nss, max, ANY);
10475 I32 i = POPINT(ss,ix);
10476 TOPINT(nss,ix) = i;
10478 case SAVEt_ITEM: /* normal string */
10479 sv = (SV*)POPPTR(ss,ix);
10480 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10481 sv = (SV*)POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10484 case SAVEt_SV: /* scalar reference */
10485 sv = (SV*)POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10487 gv = (GV*)POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10490 case SAVEt_GENERIC_PVREF: /* generic char* */
10491 c = (char*)POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = pv_dup(c);
10493 ptr = POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10496 case SAVEt_SHARED_PVREF: /* char* in shared space */
10497 c = (char*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = savesharedpv(c);
10499 ptr = POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10502 case SAVEt_GENERIC_SVREF: /* generic sv */
10503 case SAVEt_SVREF: /* scalar reference */
10504 sv = (SV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10506 ptr = POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10509 case SAVEt_AV: /* array reference */
10510 av = (AV*)POPPTR(ss,ix);
10511 TOPPTR(nss,ix) = av_dup_inc(av, param);
10512 gv = (GV*)POPPTR(ss,ix);
10513 TOPPTR(nss,ix) = gv_dup(gv, param);
10515 case SAVEt_HV: /* hash reference */
10516 hv = (HV*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10518 gv = (GV*)POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = gv_dup(gv, param);
10521 case SAVEt_INT: /* int reference */
10522 ptr = POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10524 intval = (int)POPINT(ss,ix);
10525 TOPINT(nss,ix) = intval;
10527 case SAVEt_LONG: /* long reference */
10528 ptr = POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10530 longval = (long)POPLONG(ss,ix);
10531 TOPLONG(nss,ix) = longval;
10533 case SAVEt_I32: /* I32 reference */
10534 case SAVEt_I16: /* I16 reference */
10535 case SAVEt_I8: /* I8 reference */
10536 ptr = POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10539 TOPINT(nss,ix) = i;
10541 case SAVEt_IV: /* IV reference */
10542 ptr = POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10545 TOPIV(nss,ix) = iv;
10547 case SAVEt_SPTR: /* SV* reference */
10548 ptr = POPPTR(ss,ix);
10549 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10550 sv = (SV*)POPPTR(ss,ix);
10551 TOPPTR(nss,ix) = sv_dup(sv, param);
10553 case SAVEt_VPTR: /* random* reference */
10554 ptr = POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10556 ptr = POPPTR(ss,ix);
10557 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10559 case SAVEt_PPTR: /* char* reference */
10560 ptr = POPPTR(ss,ix);
10561 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10562 c = (char*)POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = pv_dup(c);
10565 case SAVEt_HPTR: /* HV* reference */
10566 ptr = POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10568 hv = (HV*)POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = hv_dup(hv, param);
10571 case SAVEt_APTR: /* AV* reference */
10572 ptr = POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10574 av = (AV*)POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = av_dup(av, param);
10578 gv = (GV*)POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = gv_dup(gv, param);
10581 case SAVEt_GP: /* scalar reference */
10582 gp = (GP*)POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10584 (void)GpREFCNT_inc(gp);
10585 gv = (GV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10587 c = (char*)POPPTR(ss,ix);
10588 TOPPTR(nss,ix) = pv_dup(c);
10590 TOPIV(nss,ix) = iv;
10592 TOPIV(nss,ix) = iv;
10595 case SAVEt_MORTALIZESV:
10596 sv = (SV*)POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10600 ptr = POPPTR(ss,ix);
10601 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10602 /* these are assumed to be refcounted properly */
10604 switch (((OP*)ptr)->op_type) {
10606 case OP_LEAVESUBLV:
10610 case OP_LEAVEWRITE:
10611 TOPPTR(nss,ix) = ptr;
10616 TOPPTR(nss,ix) = Nullop;
10621 TOPPTR(nss,ix) = Nullop;
10624 c = (char*)POPPTR(ss,ix);
10625 TOPPTR(nss,ix) = pv_dup_inc(c);
10627 case SAVEt_CLEARSV:
10628 longval = POPLONG(ss,ix);
10629 TOPLONG(nss,ix) = longval;
10632 hv = (HV*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10634 c = (char*)POPPTR(ss,ix);
10635 TOPPTR(nss,ix) = pv_dup_inc(c);
10637 TOPINT(nss,ix) = i;
10639 case SAVEt_DESTRUCTOR:
10640 ptr = POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10642 dptr = POPDPTR(ss,ix);
10643 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10644 any_dup(FPTR2DPTR(void *, dptr),
10647 case SAVEt_DESTRUCTOR_X:
10648 ptr = POPPTR(ss,ix);
10649 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10650 dxptr = POPDXPTR(ss,ix);
10651 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10652 any_dup(FPTR2DPTR(void *, dxptr),
10655 case SAVEt_REGCONTEXT:
10658 TOPINT(nss,ix) = i;
10661 case SAVEt_STACK_POS: /* Position on Perl stack */
10663 TOPINT(nss,ix) = i;
10665 case SAVEt_AELEM: /* array element */
10666 sv = (SV*)POPPTR(ss,ix);
10667 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10669 TOPINT(nss,ix) = i;
10670 av = (AV*)POPPTR(ss,ix);
10671 TOPPTR(nss,ix) = av_dup_inc(av, param);
10673 case SAVEt_HELEM: /* hash element */
10674 sv = (SV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10676 sv = (SV*)POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10678 hv = (HV*)POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10682 ptr = POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = ptr;
10687 TOPINT(nss,ix) = i;
10689 case SAVEt_COMPPAD:
10690 av = (AV*)POPPTR(ss,ix);
10691 TOPPTR(nss,ix) = av_dup(av, param);
10694 longval = (long)POPLONG(ss,ix);
10695 TOPLONG(nss,ix) = longval;
10696 ptr = POPPTR(ss,ix);
10697 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10698 sv = (SV*)POPPTR(ss,ix);
10699 TOPPTR(nss,ix) = sv_dup(sv, param);
10702 ptr = POPPTR(ss,ix);
10703 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10704 longval = (long)POPBOOL(ss,ix);
10705 TOPBOOL(nss,ix) = (bool)longval;
10707 case SAVEt_SET_SVFLAGS:
10709 TOPINT(nss,ix) = i;
10711 TOPINT(nss,ix) = i;
10712 sv = (SV*)POPPTR(ss,ix);
10713 TOPPTR(nss,ix) = sv_dup(sv, param);
10716 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10724 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10725 * flag to the result. This is done for each stash before cloning starts,
10726 * so we know which stashes want their objects cloned */
10729 do_mark_cloneable_stash(pTHX_ SV *sv)
10731 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10733 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10734 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10735 if (cloner && GvCV(cloner)) {
10742 XPUSHs(sv_2mortal(newSVhek(hvname)));
10744 call_sv((SV*)GvCV(cloner), G_SCALAR);
10751 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10759 =for apidoc perl_clone
10761 Create and return a new interpreter by cloning the current one.
10763 perl_clone takes these flags as parameters:
10765 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10766 without it we only clone the data and zero the stacks,
10767 with it we copy the stacks and the new perl interpreter is
10768 ready to run at the exact same point as the previous one.
10769 The pseudo-fork code uses COPY_STACKS while the
10770 threads->new doesn't.
10772 CLONEf_KEEP_PTR_TABLE
10773 perl_clone keeps a ptr_table with the pointer of the old
10774 variable as a key and the new variable as a value,
10775 this allows it to check if something has been cloned and not
10776 clone it again but rather just use the value and increase the
10777 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10778 the ptr_table using the function
10779 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10780 reason to keep it around is if you want to dup some of your own
10781 variable who are outside the graph perl scans, example of this
10782 code is in threads.xs create
10785 This is a win32 thing, it is ignored on unix, it tells perls
10786 win32host code (which is c++) to clone itself, this is needed on
10787 win32 if you want to run two threads at the same time,
10788 if you just want to do some stuff in a separate perl interpreter
10789 and then throw it away and return to the original one,
10790 you don't need to do anything.
10795 /* XXX the above needs expanding by someone who actually understands it ! */
10796 EXTERN_C PerlInterpreter *
10797 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10800 perl_clone(PerlInterpreter *proto_perl, UV flags)
10803 #ifdef PERL_IMPLICIT_SYS
10805 /* perlhost.h so we need to call into it
10806 to clone the host, CPerlHost should have a c interface, sky */
10808 if (flags & CLONEf_CLONE_HOST) {
10809 return perl_clone_host(proto_perl,flags);
10811 return perl_clone_using(proto_perl, flags,
10813 proto_perl->IMemShared,
10814 proto_perl->IMemParse,
10816 proto_perl->IStdIO,
10820 proto_perl->IProc);
10824 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10825 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10826 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10827 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10828 struct IPerlDir* ipD, struct IPerlSock* ipS,
10829 struct IPerlProc* ipP)
10831 /* XXX many of the string copies here can be optimized if they're
10832 * constants; they need to be allocated as common memory and just
10833 * their pointers copied. */
10836 CLONE_PARAMS clone_params;
10837 CLONE_PARAMS* param = &clone_params;
10839 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10840 /* for each stash, determine whether its objects should be cloned */
10841 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10842 PERL_SET_THX(my_perl);
10845 Poison(my_perl, 1, PerlInterpreter);
10847 PL_curcop = (COP *)Nullop;
10851 PL_savestack_ix = 0;
10852 PL_savestack_max = -1;
10853 PL_sig_pending = 0;
10854 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10855 # else /* !DEBUGGING */
10856 Zero(my_perl, 1, PerlInterpreter);
10857 # endif /* DEBUGGING */
10859 /* host pointers */
10861 PL_MemShared = ipMS;
10862 PL_MemParse = ipMP;
10869 #else /* !PERL_IMPLICIT_SYS */
10871 CLONE_PARAMS clone_params;
10872 CLONE_PARAMS* param = &clone_params;
10873 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10874 /* for each stash, determine whether its objects should be cloned */
10875 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10876 PERL_SET_THX(my_perl);
10879 Poison(my_perl, 1, PerlInterpreter);
10881 PL_curcop = (COP *)Nullop;
10885 PL_savestack_ix = 0;
10886 PL_savestack_max = -1;
10887 PL_sig_pending = 0;
10888 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10889 # else /* !DEBUGGING */
10890 Zero(my_perl, 1, PerlInterpreter);
10891 # endif /* DEBUGGING */
10892 #endif /* PERL_IMPLICIT_SYS */
10893 param->flags = flags;
10894 param->proto_perl = proto_perl;
10897 PL_xnv_arenaroot = NULL;
10898 PL_xnv_root = NULL;
10899 PL_xpv_arenaroot = NULL;
10900 PL_xpv_root = NULL;
10901 PL_xpviv_arenaroot = NULL;
10902 PL_xpviv_root = NULL;
10903 PL_xpvnv_arenaroot = NULL;
10904 PL_xpvnv_root = NULL;
10905 PL_xpvcv_arenaroot = NULL;
10906 PL_xpvcv_root = NULL;
10907 PL_xpvav_arenaroot = NULL;
10908 PL_xpvav_root = NULL;
10909 PL_xpvhv_arenaroot = NULL;
10910 PL_xpvhv_root = NULL;
10911 PL_xpvmg_arenaroot = NULL;
10912 PL_xpvmg_root = NULL;
10913 PL_xpvgv_arenaroot = NULL;
10914 PL_xpvgv_root = NULL;
10915 PL_xpvlv_arenaroot = NULL;
10916 PL_xpvlv_root = NULL;
10917 PL_xpvbm_arenaroot = NULL;
10918 PL_xpvbm_root = NULL;
10919 PL_he_arenaroot = NULL;
10921 #if defined(USE_ITHREADS)
10922 PL_pte_arenaroot = NULL;
10923 PL_pte_root = NULL;
10925 PL_nice_chunk = NULL;
10926 PL_nice_chunk_size = 0;
10928 PL_sv_objcount = 0;
10929 PL_sv_root = Nullsv;
10930 PL_sv_arenaroot = Nullsv;
10932 PL_debug = proto_perl->Idebug;
10934 PL_hash_seed = proto_perl->Ihash_seed;
10935 PL_rehash_seed = proto_perl->Irehash_seed;
10937 #ifdef USE_REENTRANT_API
10938 /* XXX: things like -Dm will segfault here in perlio, but doing
10939 * PERL_SET_CONTEXT(proto_perl);
10940 * breaks too many other things
10942 Perl_reentrant_init(aTHX);
10945 /* create SV map for pointer relocation */
10946 PL_ptr_table = ptr_table_new();
10948 /* initialize these special pointers as early as possible */
10949 SvANY(&PL_sv_undef) = NULL;
10950 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10951 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10952 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10954 SvANY(&PL_sv_no) = new_XPVNV();
10955 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10956 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10957 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10958 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10959 SvCUR_set(&PL_sv_no, 0);
10960 SvLEN_set(&PL_sv_no, 1);
10961 SvIV_set(&PL_sv_no, 0);
10962 SvNV_set(&PL_sv_no, 0);
10963 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10965 SvANY(&PL_sv_yes) = new_XPVNV();
10966 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10967 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10968 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10969 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10970 SvCUR_set(&PL_sv_yes, 1);
10971 SvLEN_set(&PL_sv_yes, 2);
10972 SvIV_set(&PL_sv_yes, 1);
10973 SvNV_set(&PL_sv_yes, 1);
10974 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10976 /* create (a non-shared!) shared string table */
10977 PL_strtab = newHV();
10978 HvSHAREKEYS_off(PL_strtab);
10979 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10980 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10982 PL_compiling = proto_perl->Icompiling;
10984 /* These two PVs will be free'd special way so must set them same way op.c does */
10985 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10986 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10988 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10989 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10991 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10992 if (!specialWARN(PL_compiling.cop_warnings))
10993 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10994 if (!specialCopIO(PL_compiling.cop_io))
10995 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10996 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10998 /* pseudo environmental stuff */
10999 PL_origargc = proto_perl->Iorigargc;
11000 PL_origargv = proto_perl->Iorigargv;
11002 param->stashes = newAV(); /* Setup array of objects to call clone on */
11004 /* Set tainting stuff before PerlIO_debug can possibly get called */
11005 PL_tainting = proto_perl->Itainting;
11006 PL_taint_warn = proto_perl->Itaint_warn;
11008 #ifdef PERLIO_LAYERS
11009 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11010 PerlIO_clone(aTHX_ proto_perl, param);
11013 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11014 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11015 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11016 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11017 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11018 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11021 PL_minus_c = proto_perl->Iminus_c;
11022 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11023 PL_localpatches = proto_perl->Ilocalpatches;
11024 PL_splitstr = proto_perl->Isplitstr;
11025 PL_preprocess = proto_perl->Ipreprocess;
11026 PL_minus_n = proto_perl->Iminus_n;
11027 PL_minus_p = proto_perl->Iminus_p;
11028 PL_minus_l = proto_perl->Iminus_l;
11029 PL_minus_a = proto_perl->Iminus_a;
11030 PL_minus_F = proto_perl->Iminus_F;
11031 PL_doswitches = proto_perl->Idoswitches;
11032 PL_dowarn = proto_perl->Idowarn;
11033 PL_doextract = proto_perl->Idoextract;
11034 PL_sawampersand = proto_perl->Isawampersand;
11035 PL_unsafe = proto_perl->Iunsafe;
11036 PL_inplace = SAVEPV(proto_perl->Iinplace);
11037 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11038 PL_perldb = proto_perl->Iperldb;
11039 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11040 PL_exit_flags = proto_perl->Iexit_flags;
11042 /* magical thingies */
11043 /* XXX time(&PL_basetime) when asked for? */
11044 PL_basetime = proto_perl->Ibasetime;
11045 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11047 PL_maxsysfd = proto_perl->Imaxsysfd;
11048 PL_multiline = proto_perl->Imultiline;
11049 PL_statusvalue = proto_perl->Istatusvalue;
11051 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11053 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11055 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11057 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11058 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11059 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11061 /* Clone the regex array */
11062 PL_regex_padav = newAV();
11064 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11065 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11067 av_push(PL_regex_padav,
11068 sv_dup_inc(regexen[0],param));
11069 for(i = 1; i <= len; i++) {
11070 if(SvREPADTMP(regexen[i])) {
11071 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11073 av_push(PL_regex_padav,
11075 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11076 SvIVX(regexen[i])), param)))
11081 PL_regex_pad = AvARRAY(PL_regex_padav);
11083 /* shortcuts to various I/O objects */
11084 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11085 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11086 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11087 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11088 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11089 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11091 /* shortcuts to regexp stuff */
11092 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11094 /* shortcuts to misc objects */
11095 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11097 /* shortcuts to debugging objects */
11098 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11099 PL_DBline = gv_dup(proto_perl->IDBline, param);
11100 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11101 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11102 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11103 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11104 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11105 PL_lineary = av_dup(proto_perl->Ilineary, param);
11106 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11108 /* symbol tables */
11109 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11110 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11111 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11112 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11113 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11115 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11116 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11117 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11118 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11119 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11120 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11122 PL_sub_generation = proto_perl->Isub_generation;
11124 /* funky return mechanisms */
11125 PL_forkprocess = proto_perl->Iforkprocess;
11127 /* subprocess state */
11128 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11130 /* internal state */
11131 PL_maxo = proto_perl->Imaxo;
11132 if (proto_perl->Iop_mask)
11133 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11135 PL_op_mask = Nullch;
11136 /* PL_asserting = proto_perl->Iasserting; */
11138 /* current interpreter roots */
11139 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11140 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11141 PL_main_start = proto_perl->Imain_start;
11142 PL_eval_root = proto_perl->Ieval_root;
11143 PL_eval_start = proto_perl->Ieval_start;
11145 /* runtime control stuff */
11146 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11147 PL_copline = proto_perl->Icopline;
11149 PL_filemode = proto_perl->Ifilemode;
11150 PL_lastfd = proto_perl->Ilastfd;
11151 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11154 PL_gensym = proto_perl->Igensym;
11155 PL_preambled = proto_perl->Ipreambled;
11156 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11157 PL_laststatval = proto_perl->Ilaststatval;
11158 PL_laststype = proto_perl->Ilaststype;
11159 PL_mess_sv = Nullsv;
11161 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11163 /* interpreter atexit processing */
11164 PL_exitlistlen = proto_perl->Iexitlistlen;
11165 if (PL_exitlistlen) {
11166 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11167 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11170 PL_exitlist = (PerlExitListEntry*)NULL;
11171 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11172 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11173 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11175 PL_profiledata = NULL;
11176 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11177 /* PL_rsfp_filters entries have fake IoDIRP() */
11178 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11180 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11182 PAD_CLONE_VARS(proto_perl, param);
11184 #ifdef HAVE_INTERP_INTERN
11185 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11188 /* more statics moved here */
11189 PL_generation = proto_perl->Igeneration;
11190 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11192 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11193 PL_in_clean_all = proto_perl->Iin_clean_all;
11195 PL_uid = proto_perl->Iuid;
11196 PL_euid = proto_perl->Ieuid;
11197 PL_gid = proto_perl->Igid;
11198 PL_egid = proto_perl->Iegid;
11199 PL_nomemok = proto_perl->Inomemok;
11200 PL_an = proto_perl->Ian;
11201 PL_evalseq = proto_perl->Ievalseq;
11202 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11203 PL_origalen = proto_perl->Iorigalen;
11204 #ifdef PERL_USES_PL_PIDSTATUS
11205 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11207 PL_osname = SAVEPV(proto_perl->Iosname);
11208 PL_sighandlerp = proto_perl->Isighandlerp;
11210 PL_runops = proto_perl->Irunops;
11212 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11215 PL_cshlen = proto_perl->Icshlen;
11216 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11219 PL_lex_state = proto_perl->Ilex_state;
11220 PL_lex_defer = proto_perl->Ilex_defer;
11221 PL_lex_expect = proto_perl->Ilex_expect;
11222 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11223 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11224 PL_lex_starts = proto_perl->Ilex_starts;
11225 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11226 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11227 PL_lex_op = proto_perl->Ilex_op;
11228 PL_lex_inpat = proto_perl->Ilex_inpat;
11229 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11230 PL_lex_brackets = proto_perl->Ilex_brackets;
11231 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11232 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11233 PL_lex_casemods = proto_perl->Ilex_casemods;
11234 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11235 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11237 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11238 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11239 PL_nexttoke = proto_perl->Inexttoke;
11241 /* XXX This is probably masking the deeper issue of why
11242 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11243 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11244 * (A little debugging with a watchpoint on it may help.)
11246 if (SvANY(proto_perl->Ilinestr)) {
11247 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11248 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11249 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11250 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11251 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11252 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11253 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11254 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11255 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11258 PL_linestr = NEWSV(65,79);
11259 sv_upgrade(PL_linestr,SVt_PVIV);
11260 sv_setpvn(PL_linestr,"",0);
11261 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11263 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11264 PL_pending_ident = proto_perl->Ipending_ident;
11265 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11267 PL_expect = proto_perl->Iexpect;
11269 PL_multi_start = proto_perl->Imulti_start;
11270 PL_multi_end = proto_perl->Imulti_end;
11271 PL_multi_open = proto_perl->Imulti_open;
11272 PL_multi_close = proto_perl->Imulti_close;
11274 PL_error_count = proto_perl->Ierror_count;
11275 PL_subline = proto_perl->Isubline;
11276 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11278 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11279 if (SvANY(proto_perl->Ilinestr)) {
11280 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11281 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11282 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11283 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11284 PL_last_lop_op = proto_perl->Ilast_lop_op;
11287 PL_last_uni = SvPVX(PL_linestr);
11288 PL_last_lop = SvPVX(PL_linestr);
11289 PL_last_lop_op = 0;
11291 PL_in_my = proto_perl->Iin_my;
11292 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11294 PL_cryptseen = proto_perl->Icryptseen;
11297 PL_hints = proto_perl->Ihints;
11299 PL_amagic_generation = proto_perl->Iamagic_generation;
11301 #ifdef USE_LOCALE_COLLATE
11302 PL_collation_ix = proto_perl->Icollation_ix;
11303 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11304 PL_collation_standard = proto_perl->Icollation_standard;
11305 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11306 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11307 #endif /* USE_LOCALE_COLLATE */
11309 #ifdef USE_LOCALE_NUMERIC
11310 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11311 PL_numeric_standard = proto_perl->Inumeric_standard;
11312 PL_numeric_local = proto_perl->Inumeric_local;
11313 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11314 #endif /* !USE_LOCALE_NUMERIC */
11316 /* utf8 character classes */
11317 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11318 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11319 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11320 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11321 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11322 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11323 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11324 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11325 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11326 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11327 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11328 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11329 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11330 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11331 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11332 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11333 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11334 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11335 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11336 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11338 /* Did the locale setup indicate UTF-8? */
11339 PL_utf8locale = proto_perl->Iutf8locale;
11340 /* Unicode features (see perlrun/-C) */
11341 PL_unicode = proto_perl->Iunicode;
11343 /* Pre-5.8 signals control */
11344 PL_signals = proto_perl->Isignals;
11346 /* times() ticks per second */
11347 PL_clocktick = proto_perl->Iclocktick;
11349 /* Recursion stopper for PerlIO_find_layer */
11350 PL_in_load_module = proto_perl->Iin_load_module;
11352 /* sort() routine */
11353 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11355 /* Not really needed/useful since the reenrant_retint is "volatile",
11356 * but do it for consistency's sake. */
11357 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11359 /* Hooks to shared SVs and locks. */
11360 PL_sharehook = proto_perl->Isharehook;
11361 PL_lockhook = proto_perl->Ilockhook;
11362 PL_unlockhook = proto_perl->Iunlockhook;
11363 PL_threadhook = proto_perl->Ithreadhook;
11365 PL_runops_std = proto_perl->Irunops_std;
11366 PL_runops_dbg = proto_perl->Irunops_dbg;
11368 #ifdef THREADS_HAVE_PIDS
11369 PL_ppid = proto_perl->Ippid;
11373 PL_last_swash_hv = Nullhv; /* reinits on demand */
11374 PL_last_swash_klen = 0;
11375 PL_last_swash_key[0]= '\0';
11376 PL_last_swash_tmps = (U8*)NULL;
11377 PL_last_swash_slen = 0;
11379 PL_glob_index = proto_perl->Iglob_index;
11380 PL_srand_called = proto_perl->Isrand_called;
11381 PL_uudmap['M'] = 0; /* reinits on demand */
11382 PL_bitcount = Nullch; /* reinits on demand */
11384 if (proto_perl->Ipsig_pend) {
11385 Newxz(PL_psig_pend, SIG_SIZE, int);
11388 PL_psig_pend = (int*)NULL;
11391 if (proto_perl->Ipsig_ptr) {
11392 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11393 Newxz(PL_psig_name, SIG_SIZE, SV*);
11394 for (i = 1; i < SIG_SIZE; i++) {
11395 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11396 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11400 PL_psig_ptr = (SV**)NULL;
11401 PL_psig_name = (SV**)NULL;
11404 /* thrdvar.h stuff */
11406 if (flags & CLONEf_COPY_STACKS) {
11407 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11408 PL_tmps_ix = proto_perl->Ttmps_ix;
11409 PL_tmps_max = proto_perl->Ttmps_max;
11410 PL_tmps_floor = proto_perl->Ttmps_floor;
11411 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11413 while (i <= PL_tmps_ix) {
11414 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11418 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11419 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11420 Newxz(PL_markstack, i, I32);
11421 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11422 - proto_perl->Tmarkstack);
11423 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11424 - proto_perl->Tmarkstack);
11425 Copy(proto_perl->Tmarkstack, PL_markstack,
11426 PL_markstack_ptr - PL_markstack + 1, I32);
11428 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11429 * NOTE: unlike the others! */
11430 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11431 PL_scopestack_max = proto_perl->Tscopestack_max;
11432 Newxz(PL_scopestack, PL_scopestack_max, I32);
11433 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11435 /* NOTE: si_dup() looks at PL_markstack */
11436 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11438 /* PL_curstack = PL_curstackinfo->si_stack; */
11439 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11440 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11442 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11443 PL_stack_base = AvARRAY(PL_curstack);
11444 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11445 - proto_perl->Tstack_base);
11446 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11448 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11449 * NOTE: unlike the others! */
11450 PL_savestack_ix = proto_perl->Tsavestack_ix;
11451 PL_savestack_max = proto_perl->Tsavestack_max;
11452 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11453 PL_savestack = ss_dup(proto_perl, param);
11457 ENTER; /* perl_destruct() wants to LEAVE; */
11460 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11461 PL_top_env = &PL_start_env;
11463 PL_op = proto_perl->Top;
11466 PL_Xpv = (XPV*)NULL;
11467 PL_na = proto_perl->Tna;
11469 PL_statbuf = proto_perl->Tstatbuf;
11470 PL_statcache = proto_perl->Tstatcache;
11471 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11472 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11474 PL_timesbuf = proto_perl->Ttimesbuf;
11477 PL_tainted = proto_perl->Ttainted;
11478 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11479 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11480 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11481 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11482 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11483 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11484 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11485 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11486 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11488 PL_restartop = proto_perl->Trestartop;
11489 PL_in_eval = proto_perl->Tin_eval;
11490 PL_delaymagic = proto_perl->Tdelaymagic;
11491 PL_dirty = proto_perl->Tdirty;
11492 PL_localizing = proto_perl->Tlocalizing;
11494 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11495 PL_hv_fetch_ent_mh = Nullhe;
11496 PL_modcount = proto_perl->Tmodcount;
11497 PL_lastgotoprobe = Nullop;
11498 PL_dumpindent = proto_perl->Tdumpindent;
11500 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11501 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11502 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11503 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11504 PL_efloatbuf = Nullch; /* reinits on demand */
11505 PL_efloatsize = 0; /* reinits on demand */
11509 PL_screamfirst = NULL;
11510 PL_screamnext = NULL;
11511 PL_maxscream = -1; /* reinits on demand */
11512 PL_lastscream = Nullsv;
11514 PL_watchaddr = NULL;
11515 PL_watchok = Nullch;
11517 PL_regdummy = proto_perl->Tregdummy;
11518 PL_regprecomp = Nullch;
11521 PL_colorset = 0; /* reinits PL_colors[] */
11522 /*PL_colors[6] = {0,0,0,0,0,0};*/
11523 PL_reginput = Nullch;
11524 PL_regbol = Nullch;
11525 PL_regeol = Nullch;
11526 PL_regstartp = (I32*)NULL;
11527 PL_regendp = (I32*)NULL;
11528 PL_reglastparen = (U32*)NULL;
11529 PL_reglastcloseparen = (U32*)NULL;
11530 PL_regtill = Nullch;
11531 PL_reg_start_tmp = (char**)NULL;
11532 PL_reg_start_tmpl = 0;
11533 PL_regdata = (struct reg_data*)NULL;
11536 PL_reg_eval_set = 0;
11538 PL_regprogram = (regnode*)NULL;
11540 PL_regcc = (CURCUR*)NULL;
11541 PL_reg_call_cc = (struct re_cc_state*)NULL;
11542 PL_reg_re = (regexp*)NULL;
11543 PL_reg_ganch = Nullch;
11544 PL_reg_sv = Nullsv;
11545 PL_reg_match_utf8 = FALSE;
11546 PL_reg_magic = (MAGIC*)NULL;
11548 PL_reg_oldcurpm = (PMOP*)NULL;
11549 PL_reg_curpm = (PMOP*)NULL;
11550 PL_reg_oldsaved = Nullch;
11551 PL_reg_oldsavedlen = 0;
11552 #ifdef PERL_OLD_COPY_ON_WRITE
11555 PL_reg_maxiter = 0;
11556 PL_reg_leftiter = 0;
11557 PL_reg_poscache = Nullch;
11558 PL_reg_poscache_size= 0;
11560 /* RE engine - function pointers */
11561 PL_regcompp = proto_perl->Tregcompp;
11562 PL_regexecp = proto_perl->Tregexecp;
11563 PL_regint_start = proto_perl->Tregint_start;
11564 PL_regint_string = proto_perl->Tregint_string;
11565 PL_regfree = proto_perl->Tregfree;
11567 PL_reginterp_cnt = 0;
11568 PL_reg_starttry = 0;
11570 /* Pluggable optimizer */
11571 PL_peepp = proto_perl->Tpeepp;
11573 PL_stashcache = newHV();
11575 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11576 ptr_table_free(PL_ptr_table);
11577 PL_ptr_table = NULL;
11580 /* Call the ->CLONE method, if it exists, for each of the stashes
11581 identified by sv_dup() above.
11583 while(av_len(param->stashes) != -1) {
11584 HV* const stash = (HV*) av_shift(param->stashes);
11585 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11586 if (cloner && GvCV(cloner)) {
11591 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11593 call_sv((SV*)GvCV(cloner), G_DISCARD);
11599 SvREFCNT_dec(param->stashes);
11601 /* orphaned? eg threads->new inside BEGIN or use */
11602 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11603 (void)SvREFCNT_inc(PL_compcv);
11604 SAVEFREESV(PL_compcv);
11610 #endif /* USE_ITHREADS */
11613 =head1 Unicode Support
11615 =for apidoc sv_recode_to_utf8
11617 The encoding is assumed to be an Encode object, on entry the PV
11618 of the sv is assumed to be octets in that encoding, and the sv
11619 will be converted into Unicode (and UTF-8).
11621 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11622 is not a reference, nothing is done to the sv. If the encoding is not
11623 an C<Encode::XS> Encoding object, bad things will happen.
11624 (See F<lib/encoding.pm> and L<Encode>).
11626 The PV of the sv is returned.
11631 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11634 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11648 Passing sv_yes is wrong - it needs to be or'ed set of constants
11649 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11650 remove converted chars from source.
11652 Both will default the value - let them.
11654 XPUSHs(&PL_sv_yes);
11657 call_method("decode", G_SCALAR);
11661 s = SvPV_const(uni, len);
11662 if (s != SvPVX_const(sv)) {
11663 SvGROW(sv, len + 1);
11664 Move(s, SvPVX(sv), len + 1, char);
11665 SvCUR_set(sv, len);
11672 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11676 =for apidoc sv_cat_decode
11678 The encoding is assumed to be an Encode object, the PV of the ssv is
11679 assumed to be octets in that encoding and decoding the input starts
11680 from the position which (PV + *offset) pointed to. The dsv will be
11681 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11682 when the string tstr appears in decoding output or the input ends on
11683 the PV of the ssv. The value which the offset points will be modified
11684 to the last input position on the ssv.
11686 Returns TRUE if the terminator was found, else returns FALSE.
11691 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11692 SV *ssv, int *offset, char *tstr, int tlen)
11696 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11707 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11708 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11710 call_method("cat_decode", G_SCALAR);
11712 ret = SvTRUE(TOPs);
11713 *offset = SvIV(offsv);
11719 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11725 * c-indentation-style: bsd
11726 * c-basic-offset: 4
11727 * indent-tabs-mode: t
11730 * ex: set ts=8 sts=4 sw=4 noet: