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;
2962 if (SvGMAGICAL(sv)) {
2963 if (flags & SV_GMAGIC)
2968 if (flags & SV_MUTABLE_RETURN)
2969 return SvPVX_mutable(sv);
2970 if (flags & SV_CONST_RETURN)
2971 return (char *)SvPVX_const(sv);
2976 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
2978 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2983 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2988 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2989 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2997 if (SvTHINKFIRST(sv)) {
3000 register const char *typestr;
3001 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3002 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3004 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
3007 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
3008 if (flags & SV_CONST_RETURN) {
3009 pv = (char *) SvPVX_const(tmpstr);
3011 pv = (flags & SV_MUTABLE_RETURN)
3012 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
3015 *lp = SvCUR(tmpstr);
3017 pv = sv_2pv_flags(tmpstr, lp, flags);
3028 typestr = "NULLREF";
3032 switch (SvTYPE(sv)) {
3034 if ( ((SvFLAGS(sv) &
3035 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3036 == (SVs_OBJECT|SVs_SMG))
3037 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3038 const regexp *re = (regexp *)mg->mg_obj;
3041 const char *fptr = "msix";
3046 char need_newline = 0;
3047 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3049 while((ch = *fptr++)) {
3051 reflags[left++] = ch;
3054 reflags[right--] = ch;
3059 reflags[left] = '-';
3063 mg->mg_len = re->prelen + 4 + left;
3065 * If /x was used, we have to worry about a regex
3066 * ending with a comment later being embedded
3067 * within another regex. If so, we don't want this
3068 * regex's "commentization" to leak out to the
3069 * right part of the enclosing regex, we must cap
3070 * it with a newline.
3072 * So, if /x was used, we scan backwards from the
3073 * end of the regex. If we find a '#' before we
3074 * find a newline, we need to add a newline
3075 * ourself. If we find a '\n' first (or if we
3076 * don't find '#' or '\n'), we don't need to add
3077 * anything. -jfriedl
3079 if (PMf_EXTENDED & re->reganch)
3081 const char *endptr = re->precomp + re->prelen;
3082 while (endptr >= re->precomp)
3084 const char c = *(endptr--);
3086 break; /* don't need another */
3088 /* we end while in a comment, so we
3090 mg->mg_len++; /* save space for it */
3091 need_newline = 1; /* note to add it */
3097 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
3098 Copy("(?", mg->mg_ptr, 2, char);
3099 Copy(reflags, mg->mg_ptr+2, left, char);
3100 Copy(":", mg->mg_ptr+left+2, 1, char);
3101 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3103 mg->mg_ptr[mg->mg_len - 2] = '\n';
3104 mg->mg_ptr[mg->mg_len - 1] = ')';
3105 mg->mg_ptr[mg->mg_len] = 0;
3107 PL_reginterp_cnt += re->program[0].next_off;
3109 if (re->reganch & ROPT_UTF8)
3125 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3126 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3127 /* tied lvalues should appear to be
3128 * scalars for backwards compatitbility */
3129 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3130 ? "SCALAR" : "LVALUE"; break;
3131 case SVt_PVAV: typestr = "ARRAY"; break;
3132 case SVt_PVHV: typestr = "HASH"; break;
3133 case SVt_PVCV: typestr = "CODE"; break;
3134 case SVt_PVGV: typestr = "GLOB"; break;
3135 case SVt_PVFM: typestr = "FORMAT"; break;
3136 case SVt_PVIO: typestr = "IO"; break;
3137 default: typestr = "UNKNOWN"; break;
3141 const char * const name = HvNAME_get(SvSTASH(sv));
3142 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3143 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3146 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3150 *lp = strlen(typestr);
3151 return (char *)typestr;
3153 if (SvREADONLY(sv) && !SvOK(sv)) {
3154 if (ckWARN(WARN_UNINITIALIZED))
3161 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3162 /* I'm assuming that if both IV and NV are equally valid then
3163 converting the IV is going to be more efficient */
3164 const U32 isIOK = SvIOK(sv);
3165 const U32 isUIOK = SvIsUV(sv);
3166 char buf[TYPE_CHARS(UV)];
3169 if (SvTYPE(sv) < SVt_PVIV)
3170 sv_upgrade(sv, SVt_PVIV);
3172 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3174 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3175 /* inlined from sv_setpvn */
3176 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
3177 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
3178 SvCUR_set(sv, ebuf - ptr);
3188 else if (SvNOKp(sv)) {
3189 if (SvTYPE(sv) < SVt_PVNV)
3190 sv_upgrade(sv, SVt_PVNV);
3191 /* The +20 is pure guesswork. Configure test needed. --jhi */
3192 s = SvGROW_mutable(sv, NV_DIG + 20);
3193 olderrno = errno; /* some Xenix systems wipe out errno here */
3195 if (SvNVX(sv) == 0.0)
3196 (void)strcpy(s,"0");
3200 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3203 #ifdef FIXNEGATIVEZERO
3204 if (*s == '-' && s[1] == '0' && !s[2])
3214 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
3218 if (SvTYPE(sv) < SVt_PV)
3219 /* Typically the caller expects that sv_any is not NULL now. */
3220 sv_upgrade(sv, SVt_PV);
3224 const STRLEN len = s - SvPVX_const(sv);
3230 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3231 PTR2UV(sv),SvPVX_const(sv)));
3232 if (flags & SV_CONST_RETURN)
3233 return (char *)SvPVX_const(sv);
3234 if (flags & SV_MUTABLE_RETURN)
3235 return SvPVX_mutable(sv);
3239 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3240 /* Sneaky stuff here */
3244 tsv = newSVpv(tmpbuf, 0);
3257 t = SvPVX_const(tsv);
3262 len = strlen(tmpbuf);
3264 #ifdef FIXNEGATIVEZERO
3265 if (len == 2 && t[0] == '-' && t[1] == '0') {
3270 SvUPGRADE(sv, SVt_PV);
3273 s = SvGROW_mutable(sv, len + 1);
3276 return memcpy(s, t, len + 1);
3281 =for apidoc sv_copypv
3283 Copies a stringified representation of the source SV into the
3284 destination SV. Automatically performs any necessary mg_get and
3285 coercion of numeric values into strings. Guaranteed to preserve
3286 UTF-8 flag even from overloaded objects. Similar in nature to
3287 sv_2pv[_flags] but operates directly on an SV instead of just the
3288 string. Mostly uses sv_2pv_flags to do its work, except when that
3289 would lose the UTF-8'ness of the PV.
3295 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3298 const char * const s = SvPV_const(ssv,len);
3299 sv_setpvn(dsv,s,len);
3307 =for apidoc sv_2pvbyte
3309 Return a pointer to the byte-encoded representation of the SV, and set *lp
3310 to its length. May cause the SV to be downgraded from UTF-8 as a
3313 Usually accessed via the C<SvPVbyte> macro.
3319 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3321 sv_utf8_downgrade(sv,0);
3322 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3326 * =for apidoc sv_2pvutf8
3328 * Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3329 * to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3331 * Usually accessed via the C<SvPVutf8> macro.
3337 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3339 sv_utf8_upgrade(sv);
3340 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3345 =for apidoc sv_2bool
3347 This function is only called on magical items, and is only used by
3348 sv_true() or its macro equivalent.
3354 Perl_sv_2bool(pTHX_ register SV *sv)
3362 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3363 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3364 return (bool)SvTRUE(tmpsv);
3365 return SvRV(sv) != 0;
3368 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3370 (*sv->sv_u.svu_pv > '0' ||
3371 Xpvtmp->xpv_cur > 1 ||
3372 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3379 return SvIVX(sv) != 0;
3382 return SvNVX(sv) != 0.0;
3390 =for apidoc sv_utf8_upgrade
3392 Converts the PV of an SV to its UTF-8-encoded form.
3393 Forces the SV to string form if it is not already.
3394 Always sets the SvUTF8 flag to avoid future validity checks even
3395 if all the bytes have hibit clear.
3397 This is not as a general purpose byte encoding to Unicode interface:
3398 use the Encode extension for that.
3400 =for apidoc sv_utf8_upgrade_flags
3402 Converts the PV of an SV to its UTF-8-encoded form.
3403 Forces the SV to string form if it is not already.
3404 Always sets the SvUTF8 flag to avoid future validity checks even
3405 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3406 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3407 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3409 This is not as a general purpose byte encoding to Unicode interface:
3410 use the Encode extension for that.
3416 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3418 if (sv == &PL_sv_undef)
3422 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3423 (void) sv_2pv_flags(sv,&len, flags);
3427 (void) SvPV_force(sv,len);
3436 sv_force_normal_flags(sv, 0);
3439 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3440 sv_recode_to_utf8(sv, PL_encoding);
3441 else { /* Assume Latin-1/EBCDIC */
3442 /* This function could be much more efficient if we
3443 * had a FLAG in SVs to signal if there are any hibit
3444 * chars in the PV. Given that there isn't such a flag
3445 * make the loop as fast as possible. */
3446 const U8 *s = (U8 *) SvPVX_const(sv);
3447 const U8 * const e = (U8 *) SvEND(sv);
3453 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3457 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3458 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3460 SvPV_free(sv); /* No longer using what was there before. */
3462 SvPV_set(sv, (char*)recoded);
3463 SvCUR_set(sv, len - 1);
3464 SvLEN_set(sv, len); /* No longer know the real size. */
3466 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3473 =for apidoc sv_utf8_downgrade
3475 Attempts to convert the PV of an SV from characters to bytes.
3476 If the PV contains a character beyond byte, this conversion will fail;
3477 in this case, either returns false or, if C<fail_ok> is not
3480 This is not as a general purpose Unicode to byte encoding interface:
3481 use the Encode extension for that.
3487 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3489 if (SvPOKp(sv) && SvUTF8(sv)) {
3495 sv_force_normal_flags(sv, 0);
3497 s = (U8 *) SvPV(sv, len);
3498 if (!utf8_to_bytes(s, &len)) {
3503 Perl_croak(aTHX_ "Wide character in %s",
3506 Perl_croak(aTHX_ "Wide character");
3517 =for apidoc sv_utf8_encode
3519 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3520 flag off so that it looks like octets again.
3526 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3528 (void) sv_utf8_upgrade(sv);
3530 sv_force_normal_flags(sv, 0);
3532 if (SvREADONLY(sv)) {
3533 Perl_croak(aTHX_ PL_no_modify);
3539 =for apidoc sv_utf8_decode
3541 If the PV of the SV is an octet sequence in UTF-8
3542 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3543 so that it looks like a character. If the PV contains only single-byte
3544 characters, the C<SvUTF8> flag stays being off.
3545 Scans PV for validity and returns false if the PV is invalid UTF-8.
3551 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3557 /* The octets may have got themselves encoded - get them back as
3560 if (!sv_utf8_downgrade(sv, TRUE))
3563 /* it is actually just a matter of turning the utf8 flag on, but
3564 * we want to make sure everything inside is valid utf8 first.
3566 c = (const U8 *) SvPVX_const(sv);
3567 if (!is_utf8_string(c, SvCUR(sv)+1))
3569 e = (const U8 *) SvEND(sv);
3572 if (!UTF8_IS_INVARIANT(ch)) {
3582 =for apidoc sv_setsv
3584 Copies the contents of the source SV C<ssv> into the destination SV
3585 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3586 function if the source SV needs to be reused. Does not handle 'set' magic.
3587 Loosely speaking, it performs a copy-by-value, obliterating any previous
3588 content of the destination.
3590 You probably want to use one of the assortment of wrappers, such as
3591 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3592 C<SvSetMagicSV_nosteal>.
3594 =for apidoc sv_setsv_flags
3596 Copies the contents of the source SV C<ssv> into the destination SV
3597 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3598 function if the source SV needs to be reused. Does not handle 'set' magic.
3599 Loosely speaking, it performs a copy-by-value, obliterating any previous
3600 content of the destination.
3601 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3602 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3603 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3604 and C<sv_setsv_nomg> are implemented in terms of this function.
3606 You probably want to use one of the assortment of wrappers, such as
3607 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3608 C<SvSetMagicSV_nosteal>.
3610 This is the primary function for copying scalars, and most other
3611 copy-ish functions and macros use this underneath.
3617 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3619 register U32 sflags;
3625 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3627 sstr = &PL_sv_undef;
3628 stype = SvTYPE(sstr);
3629 dtype = SvTYPE(dstr);
3634 /* need to nuke the magic */
3636 SvRMAGICAL_off(dstr);
3639 /* There's a lot of redundancy below but we're going for speed here */
3644 if (dtype != SVt_PVGV) {
3645 (void)SvOK_off(dstr);
3653 sv_upgrade(dstr, SVt_IV);
3656 sv_upgrade(dstr, SVt_PVNV);
3660 sv_upgrade(dstr, SVt_PVIV);
3663 (void)SvIOK_only(dstr);
3664 SvIV_set(dstr, SvIVX(sstr));
3667 if (SvTAINTED(sstr))
3678 sv_upgrade(dstr, SVt_NV);
3683 sv_upgrade(dstr, SVt_PVNV);
3686 SvNV_set(dstr, SvNVX(sstr));
3687 (void)SvNOK_only(dstr);
3688 if (SvTAINTED(sstr))
3696 sv_upgrade(dstr, SVt_RV);
3697 else if (dtype == SVt_PVGV &&
3698 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3701 if (GvIMPORTED(dstr) != GVf_IMPORTED
3702 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3704 GvIMPORTED_on(dstr);
3713 #ifdef PERL_OLD_COPY_ON_WRITE
3714 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3715 if (dtype < SVt_PVIV)
3716 sv_upgrade(dstr, SVt_PVIV);
3723 sv_upgrade(dstr, SVt_PV);
3726 if (dtype < SVt_PVIV)
3727 sv_upgrade(dstr, SVt_PVIV);
3730 if (dtype < SVt_PVNV)
3731 sv_upgrade(dstr, SVt_PVNV);
3738 const char * const type = sv_reftype(sstr,0);
3740 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3742 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3747 if (dtype <= SVt_PVGV) {
3749 if (dtype != SVt_PVGV) {
3750 const char * const name = GvNAME(sstr);
3751 const STRLEN len = GvNAMELEN(sstr);
3752 /* don't upgrade SVt_PVLV: it can hold a glob */
3753 if (dtype != SVt_PVLV)
3754 sv_upgrade(dstr, SVt_PVGV);
3755 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3756 GvSTASH(dstr) = GvSTASH(sstr);
3758 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3759 GvNAME(dstr) = savepvn(name, len);
3760 GvNAMELEN(dstr) = len;
3761 SvFAKE_on(dstr); /* can coerce to non-glob */
3764 #ifdef GV_UNIQUE_CHECK
3765 if (GvUNIQUE((GV*)dstr)) {
3766 Perl_croak(aTHX_ PL_no_modify);
3770 (void)SvOK_off(dstr);
3771 GvINTRO_off(dstr); /* one-shot flag */
3773 GvGP(dstr) = gp_ref(GvGP(sstr));
3774 if (SvTAINTED(sstr))
3776 if (GvIMPORTED(dstr) != GVf_IMPORTED
3777 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3779 GvIMPORTED_on(dstr);
3787 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3789 if ((int)SvTYPE(sstr) != stype) {
3790 stype = SvTYPE(sstr);
3791 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3795 if (stype == SVt_PVLV)
3796 SvUPGRADE(dstr, SVt_PVNV);
3798 SvUPGRADE(dstr, (U32)stype);
3801 sflags = SvFLAGS(sstr);
3803 if (sflags & SVf_ROK) {
3804 if (dtype >= SVt_PV) {
3805 if (dtype == SVt_PVGV) {
3806 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3808 const int intro = GvINTRO(dstr);
3810 #ifdef GV_UNIQUE_CHECK
3811 if (GvUNIQUE((GV*)dstr)) {
3812 Perl_croak(aTHX_ PL_no_modify);
3817 GvINTRO_off(dstr); /* one-shot flag */
3818 GvLINE(dstr) = CopLINE(PL_curcop);
3819 GvEGV(dstr) = (GV*)dstr;
3822 switch (SvTYPE(sref)) {
3825 SAVEGENERICSV(GvAV(dstr));
3827 dref = (SV*)GvAV(dstr);
3828 GvAV(dstr) = (AV*)sref;
3829 if (!GvIMPORTED_AV(dstr)
3830 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3832 GvIMPORTED_AV_on(dstr);
3837 SAVEGENERICSV(GvHV(dstr));
3839 dref = (SV*)GvHV(dstr);
3840 GvHV(dstr) = (HV*)sref;
3841 if (!GvIMPORTED_HV(dstr)
3842 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3844 GvIMPORTED_HV_on(dstr);
3849 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3850 SvREFCNT_dec(GvCV(dstr));
3851 GvCV(dstr) = Nullcv;
3852 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3853 PL_sub_generation++;
3855 SAVEGENERICSV(GvCV(dstr));
3858 dref = (SV*)GvCV(dstr);
3859 if (GvCV(dstr) != (CV*)sref) {
3860 CV* const cv = GvCV(dstr);
3862 if (!GvCVGEN((GV*)dstr) &&
3863 (CvROOT(cv) || CvXSUB(cv)))
3865 /* Redefining a sub - warning is mandatory if
3866 it was a const and its value changed. */
3867 if (ckWARN(WARN_REDEFINE)
3869 && (!CvCONST((CV*)sref)
3870 || sv_cmp(cv_const_sv(cv),
3871 cv_const_sv((CV*)sref)))))
3873 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3875 ? "Constant subroutine %s::%s redefined"
3876 : "Subroutine %s::%s redefined",
3877 HvNAME_get(GvSTASH((GV*)dstr)),
3878 GvENAME((GV*)dstr));
3882 cv_ckproto(cv, (GV*)dstr,
3884 ? SvPVX_const(sref) : Nullch);
3886 GvCV(dstr) = (CV*)sref;
3887 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3888 GvASSUMECV_on(dstr);
3889 PL_sub_generation++;
3891 if (!GvIMPORTED_CV(dstr)
3892 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3894 GvIMPORTED_CV_on(dstr);
3899 SAVEGENERICSV(GvIOp(dstr));
3901 dref = (SV*)GvIOp(dstr);
3902 GvIOp(dstr) = (IO*)sref;
3906 SAVEGENERICSV(GvFORM(dstr));
3908 dref = (SV*)GvFORM(dstr);
3909 GvFORM(dstr) = (CV*)sref;
3913 SAVEGENERICSV(GvSV(dstr));
3915 dref = (SV*)GvSV(dstr);
3917 if (!GvIMPORTED_SV(dstr)
3918 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3920 GvIMPORTED_SV_on(dstr);
3926 if (SvTAINTED(sstr))
3930 if (SvPVX_const(dstr)) {
3936 (void)SvOK_off(dstr);
3937 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3939 if (sflags & SVp_NOK) {
3941 /* Only set the public OK flag if the source has public OK. */
3942 if (sflags & SVf_NOK)
3943 SvFLAGS(dstr) |= SVf_NOK;
3944 SvNV_set(dstr, SvNVX(sstr));
3946 if (sflags & SVp_IOK) {
3947 (void)SvIOKp_on(dstr);
3948 if (sflags & SVf_IOK)
3949 SvFLAGS(dstr) |= SVf_IOK;
3950 if (sflags & SVf_IVisUV)
3952 SvIV_set(dstr, SvIVX(sstr));
3954 if (SvAMAGIC(sstr)) {
3958 else if (sflags & SVp_POK) {
3962 * Check to see if we can just swipe the string. If so, it's a
3963 * possible small lose on short strings, but a big win on long ones.
3964 * It might even be a win on short strings if SvPVX_const(dstr)
3965 * has to be allocated and SvPVX_const(sstr) has to be freed.
3968 /* Whichever path we take through the next code, we want this true,
3969 and doing it now facilitates the COW check. */
3970 (void)SvPOK_only(dstr);
3973 /* We're not already COW */
3974 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3975 #ifndef PERL_OLD_COPY_ON_WRITE
3976 /* or we are, but dstr isn't a suitable target. */
3977 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3982 (sflags & SVs_TEMP) && /* slated for free anyway? */
3983 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3984 (!(flags & SV_NOSTEAL)) &&
3985 /* and we're allowed to steal temps */
3986 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3987 SvLEN(sstr) && /* and really is a string */
3988 /* and won't be needed again, potentially */
3989 !(PL_op && PL_op->op_type == OP_AASSIGN))
3990 #ifdef PERL_OLD_COPY_ON_WRITE
3991 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3992 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3993 && SvTYPE(sstr) >= SVt_PVIV)
3996 /* Failed the swipe test, and it's not a shared hash key either.
3997 Have to copy the string. */
3998 STRLEN len = SvCUR(sstr);
3999 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4000 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
4001 SvCUR_set(dstr, len);
4002 *SvEND(dstr) = '\0';
4004 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
4006 /* Either it's a shared hash key, or it's suitable for
4007 copy-on-write or we can swipe the string. */
4009 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4013 #ifdef PERL_OLD_COPY_ON_WRITE
4015 /* I believe I should acquire a global SV mutex if
4016 it's a COW sv (not a shared hash key) to stop
4017 it going un copy-on-write.
4018 If the source SV has gone un copy on write between up there
4019 and down here, then (assert() that) it is of the correct
4020 form to make it copy on write again */
4021 if ((sflags & (SVf_FAKE | SVf_READONLY))
4022 != (SVf_FAKE | SVf_READONLY)) {
4023 SvREADONLY_on(sstr);
4025 /* Make the source SV into a loop of 1.
4026 (about to become 2) */
4027 SV_COW_NEXT_SV_SET(sstr, sstr);
4031 /* Initial code is common. */
4032 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
4037 /* making another shared SV. */
4038 STRLEN cur = SvCUR(sstr);
4039 STRLEN len = SvLEN(sstr);
4040 #ifdef PERL_OLD_COPY_ON_WRITE
4042 assert (SvTYPE(dstr) >= SVt_PVIV);
4043 /* SvIsCOW_normal */
4044 /* splice us in between source and next-after-source. */
4045 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4046 SV_COW_NEXT_SV_SET(sstr, dstr);
4047 SvPV_set(dstr, SvPVX_mutable(sstr));
4051 /* SvIsCOW_shared_hash */
4052 DEBUG_C(PerlIO_printf(Perl_debug_log,
4053 "Copy on write: Sharing hash\n"));
4055 assert (SvTYPE(dstr) >= SVt_PV);
4057 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
4059 SvLEN_set(dstr, len);
4060 SvCUR_set(dstr, cur);
4061 SvREADONLY_on(dstr);
4063 /* Relesase a global SV mutex. */
4066 { /* Passes the swipe test. */
4067 SvPV_set(dstr, SvPVX_mutable(sstr));
4068 SvLEN_set(dstr, SvLEN(sstr));
4069 SvCUR_set(dstr, SvCUR(sstr));
4072 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4073 SvPV_set(sstr, Nullch);
4079 if (sflags & SVf_UTF8)
4081 if (sflags & SVp_NOK) {
4083 if (sflags & SVf_NOK)
4084 SvFLAGS(dstr) |= SVf_NOK;
4085 SvNV_set(dstr, SvNVX(sstr));
4087 if (sflags & SVp_IOK) {
4088 (void)SvIOKp_on(dstr);
4089 if (sflags & SVf_IOK)
4090 SvFLAGS(dstr) |= SVf_IOK;
4091 if (sflags & SVf_IVisUV)
4093 SvIV_set(dstr, SvIVX(sstr));
4096 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4097 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4098 smg->mg_ptr, smg->mg_len);
4099 SvRMAGICAL_on(dstr);
4102 else if (sflags & SVp_IOK) {
4103 if (sflags & SVf_IOK)
4104 (void)SvIOK_only(dstr);
4106 (void)SvOK_off(dstr);
4107 (void)SvIOKp_on(dstr);
4109 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4110 if (sflags & SVf_IVisUV)
4112 SvIV_set(dstr, SvIVX(sstr));
4113 if (sflags & SVp_NOK) {
4114 if (sflags & SVf_NOK)
4115 (void)SvNOK_on(dstr);
4117 (void)SvNOKp_on(dstr);
4118 SvNV_set(dstr, SvNVX(sstr));
4121 else if (sflags & SVp_NOK) {
4122 if (sflags & SVf_NOK)
4123 (void)SvNOK_only(dstr);
4125 (void)SvOK_off(dstr);
4128 SvNV_set(dstr, SvNVX(sstr));
4131 if (dtype == SVt_PVGV) {
4132 if (ckWARN(WARN_MISC))
4133 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4136 (void)SvOK_off(dstr);
4138 if (SvTAINTED(sstr))
4143 =for apidoc sv_setsv_mg
4145 Like C<sv_setsv>, but also handles 'set' magic.
4151 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4153 sv_setsv(dstr,sstr);
4157 #ifdef PERL_OLD_COPY_ON_WRITE
4159 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4161 STRLEN cur = SvCUR(sstr);
4162 STRLEN len = SvLEN(sstr);
4163 register char *new_pv;
4166 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4174 if (SvTHINKFIRST(dstr))
4175 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4176 else if (SvPVX_const(dstr))
4177 Safefree(SvPVX_const(dstr));
4181 SvUPGRADE(dstr, SVt_PVIV);
4183 assert (SvPOK(sstr));
4184 assert (SvPOKp(sstr));
4185 assert (!SvIOK(sstr));
4186 assert (!SvIOKp(sstr));
4187 assert (!SvNOK(sstr));
4188 assert (!SvNOKp(sstr));
4190 if (SvIsCOW(sstr)) {
4192 if (SvLEN(sstr) == 0) {
4193 /* source is a COW shared hash key. */
4194 DEBUG_C(PerlIO_printf(Perl_debug_log,
4195 "Fast copy on write: Sharing hash\n"));
4196 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4199 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4201 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4202 SvUPGRADE(sstr, SVt_PVIV);
4203 SvREADONLY_on(sstr);
4205 DEBUG_C(PerlIO_printf(Perl_debug_log,
4206 "Fast copy on write: Converting sstr to COW\n"));
4207 SV_COW_NEXT_SV_SET(dstr, sstr);
4209 SV_COW_NEXT_SV_SET(sstr, dstr);
4210 new_pv = SvPVX_mutable(sstr);
4213 SvPV_set(dstr, new_pv);
4214 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4217 SvLEN_set(dstr, len);
4218 SvCUR_set(dstr, cur);
4227 =for apidoc sv_setpvn
4229 Copies a string into an SV. The C<len> parameter indicates the number of
4230 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4231 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4237 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4239 register char *dptr;
4241 SV_CHECK_THINKFIRST_COW_DROP(sv);
4247 /* len is STRLEN which is unsigned, need to copy to signed */
4250 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4252 SvUPGRADE(sv, SVt_PV);
4254 dptr = SvGROW(sv, len + 1);
4255 Move(ptr,dptr,len,char);
4258 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4263 =for apidoc sv_setpvn_mg
4265 Like C<sv_setpvn>, but also handles 'set' magic.
4271 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4273 sv_setpvn(sv,ptr,len);
4278 =for apidoc sv_setpv
4280 Copies a string into an SV. The string must be null-terminated. Does not
4281 handle 'set' magic. See C<sv_setpv_mg>.
4287 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4289 register STRLEN len;
4291 SV_CHECK_THINKFIRST_COW_DROP(sv);
4297 SvUPGRADE(sv, SVt_PV);
4299 SvGROW(sv, len + 1);
4300 Move(ptr,SvPVX(sv),len+1,char);
4302 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4307 =for apidoc sv_setpv_mg
4309 Like C<sv_setpv>, but also handles 'set' magic.
4315 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4322 =for apidoc sv_usepvn
4324 Tells an SV to use C<ptr> to find its string value. Normally the string is
4325 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4326 The C<ptr> should point to memory that was allocated by C<malloc>. The
4327 string length, C<len>, must be supplied. This function will realloc the
4328 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4329 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4330 See C<sv_usepvn_mg>.
4336 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4339 SV_CHECK_THINKFIRST_COW_DROP(sv);
4340 SvUPGRADE(sv, SVt_PV);
4345 if (SvPVX_const(sv))
4348 allocate = PERL_STRLEN_ROUNDUP(len + 1);
4349 ptr = saferealloc (ptr, allocate);
4352 SvLEN_set(sv, allocate);
4354 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4359 =for apidoc sv_usepvn_mg
4361 Like C<sv_usepvn>, but also handles 'set' magic.
4367 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4369 sv_usepvn(sv,ptr,len);
4373 #ifdef PERL_OLD_COPY_ON_WRITE
4374 /* Need to do this *after* making the SV normal, as we need the buffer
4375 pointer to remain valid until after we've copied it. If we let go too early,
4376 another thread could invalidate it by unsharing last of the same hash key
4377 (which it can do by means other than releasing copy-on-write Svs)
4378 or by changing the other copy-on-write SVs in the loop. */
4380 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4382 if (len) { /* this SV was SvIsCOW_normal(sv) */
4383 /* we need to find the SV pointing to us. */
4384 SV * const current = SV_COW_NEXT_SV(after);
4386 if (current == sv) {
4387 /* The SV we point to points back to us (there were only two of us
4389 Hence other SV is no longer copy on write either. */
4391 SvREADONLY_off(after);
4393 /* We need to follow the pointers around the loop. */
4395 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4398 /* don't loop forever if the structure is bust, and we have
4399 a pointer into a closed loop. */
4400 assert (current != after);
4401 assert (SvPVX_const(current) == pvx);
4403 /* Make the SV before us point to the SV after us. */
4404 SV_COW_NEXT_SV_SET(current, after);
4407 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4412 Perl_sv_release_IVX(pTHX_ register SV *sv)
4415 sv_force_normal_flags(sv, 0);
4421 =for apidoc sv_force_normal_flags
4423 Undo various types of fakery on an SV: if the PV is a shared string, make
4424 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4425 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4426 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4427 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4428 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4429 set to some other value.) In addition, the C<flags> parameter gets passed to
4430 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4431 with flags set to 0.
4437 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4439 #ifdef PERL_OLD_COPY_ON_WRITE
4440 if (SvREADONLY(sv)) {
4441 /* At this point I believe I should acquire a global SV mutex. */
4443 const char * const pvx = SvPVX_const(sv);
4444 const STRLEN len = SvLEN(sv);
4445 const STRLEN cur = SvCUR(sv);
4446 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4448 PerlIO_printf(Perl_debug_log,
4449 "Copy on write: Force normal %ld\n",
4455 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4456 SvPV_set(sv, (char*)0);
4458 if (flags & SV_COW_DROP_PV) {
4459 /* OK, so we don't need to copy our buffer. */
4462 SvGROW(sv, cur + 1);
4463 Move(pvx,SvPVX(sv),cur,char);
4467 sv_release_COW(sv, pvx, len, next);
4472 else if (IN_PERL_RUNTIME)
4473 Perl_croak(aTHX_ PL_no_modify);
4474 /* At this point I believe that I can drop the global SV mutex. */
4477 if (SvREADONLY(sv)) {
4479 const char * const pvx = SvPVX_const(sv);
4480 const STRLEN len = SvCUR(sv);
4483 SvPV_set(sv, Nullch);
4485 SvGROW(sv, len + 1);
4486 Move(pvx,SvPVX(sv),len,char);
4488 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4490 else if (IN_PERL_RUNTIME)
4491 Perl_croak(aTHX_ PL_no_modify);
4495 sv_unref_flags(sv, flags);
4496 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4503 Efficient removal of characters from the beginning of the string buffer.
4504 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4505 the string buffer. The C<ptr> becomes the first character of the adjusted
4506 string. Uses the "OOK hack".
4507 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4508 refer to the same chunk of data.
4514 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4516 register STRLEN delta;
4517 if (!ptr || !SvPOKp(sv))
4519 delta = ptr - SvPVX_const(sv);
4520 SV_CHECK_THINKFIRST(sv);
4521 if (SvTYPE(sv) < SVt_PVIV)
4522 sv_upgrade(sv,SVt_PVIV);
4525 if (!SvLEN(sv)) { /* make copy of shared string */
4526 const char *pvx = SvPVX_const(sv);
4527 const STRLEN len = SvCUR(sv);
4528 SvGROW(sv, len + 1);
4529 Move(pvx,SvPVX(sv),len,char);
4533 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4534 and we do that anyway inside the SvNIOK_off
4536 SvFLAGS(sv) |= SVf_OOK;
4539 SvLEN_set(sv, SvLEN(sv) - delta);
4540 SvCUR_set(sv, SvCUR(sv) - delta);
4541 SvPV_set(sv, SvPVX(sv) + delta);
4542 SvIV_set(sv, SvIVX(sv) + delta);
4546 =for apidoc sv_catpvn
4548 Concatenates the string onto the end of the string which is in the SV. The
4549 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4550 status set, then the bytes appended should be valid UTF-8.
4551 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4553 =for apidoc sv_catpvn_flags
4555 Concatenates the string onto the end of the string which is in the SV. The
4556 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4557 status set, then the bytes appended should be valid UTF-8.
4558 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4559 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4560 in terms of this function.
4566 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4569 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4571 SvGROW(dsv, dlen + slen + 1);
4573 sstr = SvPVX_const(dsv);
4574 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4575 SvCUR_set(dsv, SvCUR(dsv) + slen);
4577 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4579 if (flags & SV_SMAGIC)
4584 =for apidoc sv_catsv
4586 Concatenates the string from SV C<ssv> onto the end of the string in
4587 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4588 not 'set' magic. See C<sv_catsv_mg>.
4590 =for apidoc sv_catsv_flags
4592 Concatenates the string from SV C<ssv> onto the end of the string in
4593 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4594 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4595 and C<sv_catsv_nomg> are implemented in terms of this function.
4600 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4605 if ((spv = SvPV_const(ssv, slen))) {
4606 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4607 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4608 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4609 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4610 dsv->sv_flags doesn't have that bit set.
4611 Andy Dougherty 12 Oct 2001
4613 const I32 sutf8 = DO_UTF8(ssv);
4616 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4618 dutf8 = DO_UTF8(dsv);
4620 if (dutf8 != sutf8) {
4622 /* Not modifying source SV, so taking a temporary copy. */
4623 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4625 sv_utf8_upgrade(csv);
4626 spv = SvPV_const(csv, slen);
4629 sv_utf8_upgrade_nomg(dsv);
4631 sv_catpvn_nomg(dsv, spv, slen);
4634 if (flags & SV_SMAGIC)
4639 =for apidoc sv_catpv
4641 Concatenates the string onto the end of the string which is in the SV.
4642 If the SV has the UTF-8 status set, then the bytes appended should be
4643 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4648 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4650 register STRLEN len;
4656 junk = SvPV_force(sv, tlen);
4658 SvGROW(sv, tlen + len + 1);
4660 ptr = SvPVX_const(sv);
4661 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4662 SvCUR_set(sv, SvCUR(sv) + len);
4663 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4668 =for apidoc sv_catpv_mg
4670 Like C<sv_catpv>, but also handles 'set' magic.
4676 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4685 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4686 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4693 Perl_newSV(pTHX_ STRLEN len)
4699 sv_upgrade(sv, SVt_PV);
4700 SvGROW(sv, len + 1);
4705 =for apidoc sv_magicext
4707 Adds magic to an SV, upgrading it if necessary. Applies the
4708 supplied vtable and returns a pointer to the magic added.
4710 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4711 In particular, you can add magic to SvREADONLY SVs, and add more than
4712 one instance of the same 'how'.
4714 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4715 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4716 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4717 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4719 (This is now used as a subroutine by C<sv_magic>.)
4724 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4725 const char* name, I32 namlen)
4729 if (SvTYPE(sv) < SVt_PVMG) {
4730 SvUPGRADE(sv, SVt_PVMG);
4732 Newxz(mg, 1, MAGIC);
4733 mg->mg_moremagic = SvMAGIC(sv);
4734 SvMAGIC_set(sv, mg);
4736 /* Sometimes a magic contains a reference loop, where the sv and
4737 object refer to each other. To prevent a reference loop that
4738 would prevent such objects being freed, we look for such loops
4739 and if we find one we avoid incrementing the object refcount.
4741 Note we cannot do this to avoid self-tie loops as intervening RV must
4742 have its REFCNT incremented to keep it in existence.
4745 if (!obj || obj == sv ||
4746 how == PERL_MAGIC_arylen ||
4747 how == PERL_MAGIC_qr ||
4748 how == PERL_MAGIC_symtab ||
4749 (SvTYPE(obj) == SVt_PVGV &&
4750 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4751 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4752 GvFORM(obj) == (CV*)sv)))
4757 mg->mg_obj = SvREFCNT_inc(obj);
4758 mg->mg_flags |= MGf_REFCOUNTED;
4761 /* Normal self-ties simply pass a null object, and instead of
4762 using mg_obj directly, use the SvTIED_obj macro to produce a
4763 new RV as needed. For glob "self-ties", we are tieing the PVIO
4764 with an RV obj pointing to the glob containing the PVIO. In
4765 this case, to avoid a reference loop, we need to weaken the
4769 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4770 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4776 mg->mg_len = namlen;
4779 mg->mg_ptr = savepvn(name, namlen);
4780 else if (namlen == HEf_SVKEY)
4781 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4783 mg->mg_ptr = (char *) name;
4785 mg->mg_virtual = vtable;
4789 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4794 =for apidoc sv_magic
4796 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4797 then adds a new magic item of type C<how> to the head of the magic list.
4799 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4800 handling of the C<name> and C<namlen> arguments.
4802 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4803 to add more than one instance of the same 'how'.
4809 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4811 const MGVTBL *vtable;
4814 #ifdef PERL_OLD_COPY_ON_WRITE
4816 sv_force_normal_flags(sv, 0);
4818 if (SvREADONLY(sv)) {
4820 /* its okay to attach magic to shared strings; the subsequent
4821 * upgrade to PVMG will unshare the string */
4822 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4825 && how != PERL_MAGIC_regex_global
4826 && how != PERL_MAGIC_bm
4827 && how != PERL_MAGIC_fm
4828 && how != PERL_MAGIC_sv
4829 && how != PERL_MAGIC_backref
4832 Perl_croak(aTHX_ PL_no_modify);
4835 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4836 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4837 /* sv_magic() refuses to add a magic of the same 'how' as an
4840 if (how == PERL_MAGIC_taint)
4848 vtable = &PL_vtbl_sv;
4850 case PERL_MAGIC_overload:
4851 vtable = &PL_vtbl_amagic;
4853 case PERL_MAGIC_overload_elem:
4854 vtable = &PL_vtbl_amagicelem;
4856 case PERL_MAGIC_overload_table:
4857 vtable = &PL_vtbl_ovrld;
4860 vtable = &PL_vtbl_bm;
4862 case PERL_MAGIC_regdata:
4863 vtable = &PL_vtbl_regdata;
4865 case PERL_MAGIC_regdatum:
4866 vtable = &PL_vtbl_regdatum;
4868 case PERL_MAGIC_env:
4869 vtable = &PL_vtbl_env;
4872 vtable = &PL_vtbl_fm;
4874 case PERL_MAGIC_envelem:
4875 vtable = &PL_vtbl_envelem;
4877 case PERL_MAGIC_regex_global:
4878 vtable = &PL_vtbl_mglob;
4880 case PERL_MAGIC_isa:
4881 vtable = &PL_vtbl_isa;
4883 case PERL_MAGIC_isaelem:
4884 vtable = &PL_vtbl_isaelem;
4886 case PERL_MAGIC_nkeys:
4887 vtable = &PL_vtbl_nkeys;
4889 case PERL_MAGIC_dbfile:
4892 case PERL_MAGIC_dbline:
4893 vtable = &PL_vtbl_dbline;
4895 #ifdef USE_LOCALE_COLLATE
4896 case PERL_MAGIC_collxfrm:
4897 vtable = &PL_vtbl_collxfrm;
4899 #endif /* USE_LOCALE_COLLATE */
4900 case PERL_MAGIC_tied:
4901 vtable = &PL_vtbl_pack;
4903 case PERL_MAGIC_tiedelem:
4904 case PERL_MAGIC_tiedscalar:
4905 vtable = &PL_vtbl_packelem;
4908 vtable = &PL_vtbl_regexp;
4910 case PERL_MAGIC_sig:
4911 vtable = &PL_vtbl_sig;
4913 case PERL_MAGIC_sigelem:
4914 vtable = &PL_vtbl_sigelem;
4916 case PERL_MAGIC_taint:
4917 vtable = &PL_vtbl_taint;
4919 case PERL_MAGIC_uvar:
4920 vtable = &PL_vtbl_uvar;
4922 case PERL_MAGIC_vec:
4923 vtable = &PL_vtbl_vec;
4925 case PERL_MAGIC_arylen_p:
4926 case PERL_MAGIC_rhash:
4927 case PERL_MAGIC_symtab:
4928 case PERL_MAGIC_vstring:
4931 case PERL_MAGIC_utf8:
4932 vtable = &PL_vtbl_utf8;
4934 case PERL_MAGIC_substr:
4935 vtable = &PL_vtbl_substr;
4937 case PERL_MAGIC_defelem:
4938 vtable = &PL_vtbl_defelem;
4940 case PERL_MAGIC_glob:
4941 vtable = &PL_vtbl_glob;
4943 case PERL_MAGIC_arylen:
4944 vtable = &PL_vtbl_arylen;
4946 case PERL_MAGIC_pos:
4947 vtable = &PL_vtbl_pos;
4949 case PERL_MAGIC_backref:
4950 vtable = &PL_vtbl_backref;
4952 case PERL_MAGIC_ext:
4953 /* Reserved for use by extensions not perl internals. */
4954 /* Useful for attaching extension internal data to perl vars. */
4955 /* Note that multiple extensions may clash if magical scalars */
4956 /* etc holding private data from one are passed to another. */
4960 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4963 /* Rest of work is done else where */
4964 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4967 case PERL_MAGIC_taint:
4970 case PERL_MAGIC_ext:
4971 case PERL_MAGIC_dbfile:
4978 =for apidoc sv_unmagic
4980 Removes all magic of type C<type> from an SV.
4986 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4990 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4993 for (mg = *mgp; mg; mg = *mgp) {
4994 if (mg->mg_type == type) {
4995 const MGVTBL* const vtbl = mg->mg_virtual;
4996 *mgp = mg->mg_moremagic;
4997 if (vtbl && vtbl->svt_free)
4998 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4999 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5001 Safefree(mg->mg_ptr);
5002 else if (mg->mg_len == HEf_SVKEY)
5003 SvREFCNT_dec((SV*)mg->mg_ptr);
5004 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5005 Safefree(mg->mg_ptr);
5007 if (mg->mg_flags & MGf_REFCOUNTED)
5008 SvREFCNT_dec(mg->mg_obj);
5012 mgp = &mg->mg_moremagic;
5016 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5023 =for apidoc sv_rvweaken
5025 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5026 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5027 push a back-reference to this RV onto the array of backreferences
5028 associated with that magic.
5034 Perl_sv_rvweaken(pTHX_ SV *sv)
5037 if (!SvOK(sv)) /* let undefs pass */
5040 Perl_croak(aTHX_ "Can't weaken a nonreference");
5041 else if (SvWEAKREF(sv)) {
5042 if (ckWARN(WARN_MISC))
5043 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5047 Perl_sv_add_backref(aTHX_ tsv, sv);
5053 /* Give tsv backref magic if it hasn't already got it, then push a
5054 * back-reference to sv onto the array associated with the backref magic.
5058 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5062 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5063 av = (AV*)mg->mg_obj;
5066 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5067 /* av now has a refcnt of 2, which avoids it getting freed
5068 * before us during global cleanup. The extra ref is removed
5069 * by magic_killbackrefs() when tsv is being freed */
5071 if (AvFILLp(av) >= AvMAX(av)) {
5072 av_extend(av, AvFILLp(av)+1);
5074 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5077 /* delete a back-reference to ourselves from the backref magic associated
5078 * with the SV we point to.
5082 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5088 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
5089 if (PL_in_clean_all)
5092 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5093 Perl_croak(aTHX_ "panic: del_backref");
5094 av = (AV *)mg->mg_obj;
5096 /* We shouldn't be in here more than once, but for paranoia reasons lets
5098 for (i = AvFILLp(av); i >= 0; i--) {
5100 const SSize_t fill = AvFILLp(av);
5102 /* We weren't the last entry.
5103 An unordered list has this property that you can take the
5104 last element off the end to fill the hole, and it's still
5105 an unordered list :-)
5110 AvFILLp(av) = fill - 1;
5116 =for apidoc sv_insert
5118 Inserts a string at the specified offset/length within the SV. Similar to
5119 the Perl substr() function.
5125 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5129 register char *midend;
5130 register char *bigend;
5136 Perl_croak(aTHX_ "Can't modify non-existent substring");
5137 SvPV_force(bigstr, curlen);
5138 (void)SvPOK_only_UTF8(bigstr);
5139 if (offset + len > curlen) {
5140 SvGROW(bigstr, offset+len+1);
5141 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5142 SvCUR_set(bigstr, offset+len);
5146 i = littlelen - len;
5147 if (i > 0) { /* string might grow */
5148 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5149 mid = big + offset + len;
5150 midend = bigend = big + SvCUR(bigstr);
5153 while (midend > mid) /* shove everything down */
5154 *--bigend = *--midend;
5155 Move(little,big+offset,littlelen,char);
5156 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5161 Move(little,SvPVX(bigstr)+offset,len,char);
5166 big = SvPVX(bigstr);
5169 bigend = big + SvCUR(bigstr);
5171 if (midend > bigend)
5172 Perl_croak(aTHX_ "panic: sv_insert");
5174 if (mid - big > bigend - midend) { /* faster to shorten from end */
5176 Move(little, mid, littlelen,char);
5179 i = bigend - midend;
5181 Move(midend, mid, i,char);
5185 SvCUR_set(bigstr, mid - big);
5187 else if ((i = mid - big)) { /* faster from front */
5188 midend -= littlelen;
5190 sv_chop(bigstr,midend-i);
5195 Move(little, mid, littlelen,char);
5197 else if (littlelen) {
5198 midend -= littlelen;
5199 sv_chop(bigstr,midend);
5200 Move(little,midend,littlelen,char);
5203 sv_chop(bigstr,midend);
5209 =for apidoc sv_replace
5211 Make the first argument a copy of the second, then delete the original.
5212 The target SV physically takes over ownership of the body of the source SV
5213 and inherits its flags; however, the target keeps any magic it owns,
5214 and any magic in the source is discarded.
5215 Note that this is a rather specialist SV copying operation; most of the
5216 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5222 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5224 const U32 refcnt = SvREFCNT(sv);
5225 SV_CHECK_THINKFIRST_COW_DROP(sv);
5226 if (SvREFCNT(nsv) != 1) {
5227 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5228 UVuf " != 1)", (UV) SvREFCNT(nsv));
5230 if (SvMAGICAL(sv)) {
5234 sv_upgrade(nsv, SVt_PVMG);
5235 SvMAGIC_set(nsv, SvMAGIC(sv));
5236 SvFLAGS(nsv) |= SvMAGICAL(sv);
5238 SvMAGIC_set(sv, NULL);
5242 assert(!SvREFCNT(sv));
5243 #ifdef DEBUG_LEAKING_SCALARS
5244 sv->sv_flags = nsv->sv_flags;
5245 sv->sv_any = nsv->sv_any;
5246 sv->sv_refcnt = nsv->sv_refcnt;
5247 sv->sv_u = nsv->sv_u;
5249 StructCopy(nsv,sv,SV);
5251 /* Currently could join these into one piece of pointer arithmetic, but
5252 it would be unclear. */
5253 if(SvTYPE(sv) == SVt_IV)
5255 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5256 else if (SvTYPE(sv) == SVt_RV) {
5257 SvANY(sv) = &sv->sv_u.svu_rv;
5261 #ifdef PERL_OLD_COPY_ON_WRITE
5262 if (SvIsCOW_normal(nsv)) {
5263 /* We need to follow the pointers around the loop to make the
5264 previous SV point to sv, rather than nsv. */
5267 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5270 assert(SvPVX_const(current) == SvPVX_const(nsv));
5272 /* Make the SV before us point to the SV after us. */
5274 PerlIO_printf(Perl_debug_log, "previous is\n");
5276 PerlIO_printf(Perl_debug_log,
5277 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5278 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5280 SV_COW_NEXT_SV_SET(current, sv);
5283 SvREFCNT(sv) = refcnt;
5284 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5290 =for apidoc sv_clear
5292 Clear an SV: call any destructors, free up any memory used by the body,
5293 and free the body itself. The SV's head is I<not> freed, although
5294 its type is set to all 1's so that it won't inadvertently be assumed
5295 to be live during global destruction etc.
5296 This function should only be called when REFCNT is zero. Most of the time
5297 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5304 Perl_sv_clear(pTHX_ register SV *sv)
5307 void** old_body_arena;
5308 size_t old_body_offset;
5309 const U32 type = SvTYPE(sv);
5312 assert(SvREFCNT(sv) == 0);
5318 old_body_offset = 0;
5321 if (PL_defstash) { /* Still have a symbol table? */
5326 stash = SvSTASH(sv);
5327 destructor = StashHANDLER(stash,DESTROY);
5329 SV* const tmpref = newRV(sv);
5330 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5332 PUSHSTACKi(PERLSI_DESTROY);
5337 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5343 if(SvREFCNT(tmpref) < 2) {
5344 /* tmpref is not kept alive! */
5346 SvRV_set(tmpref, NULL);
5349 SvREFCNT_dec(tmpref);
5351 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5355 if (PL_in_clean_objs)
5356 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5358 /* DESTROY gave object new lease on life */
5364 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5365 SvOBJECT_off(sv); /* Curse the object. */
5366 if (type != SVt_PVIO)
5367 --PL_sv_objcount; /* XXX Might want something more general */
5370 if (type >= SVt_PVMG) {
5373 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
5374 SvREFCNT_dec(SvSTASH(sv));
5379 IoIFP(sv) != PerlIO_stdin() &&
5380 IoIFP(sv) != PerlIO_stdout() &&
5381 IoIFP(sv) != PerlIO_stderr())
5383 io_close((IO*)sv, FALSE);
5385 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5386 PerlDir_close(IoDIRP(sv));
5387 IoDIRP(sv) = (DIR*)NULL;
5388 Safefree(IoTOP_NAME(sv));
5389 Safefree(IoFMT_NAME(sv));
5390 Safefree(IoBOTTOM_NAME(sv));
5391 /* PVIOs aren't from arenas */
5394 old_body_arena = (void **) &PL_xpvbm_root;
5397 old_body_arena = (void **) &PL_xpvcv_root;
5399 /* PVFMs aren't from arenas */
5404 old_body_arena = (void **) &PL_xpvhv_root;
5405 old_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill);
5409 old_body_arena = (void **) &PL_xpvav_root;
5410 old_body_offset = STRUCT_OFFSET(XPVAV, xav_fill);
5413 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5414 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5415 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5416 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5418 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5419 SvREFCNT_dec(LvTARG(sv));
5420 old_body_arena = (void **) &PL_xpvlv_root;
5424 Safefree(GvNAME(sv));
5425 /* If we're in a stash, we don't own a reference to it. However it does
5426 have a back reference to us, which needs to be cleared. */
5428 sv_del_backref((SV*)GvSTASH(sv), sv);
5429 old_body_arena = (void **) &PL_xpvgv_root;
5432 old_body_arena = (void **) &PL_xpvmg_root;
5435 old_body_arena = (void **) &PL_xpvnv_root;
5438 old_body_arena = (void **) &PL_xpviv_root;
5439 old_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur);
5441 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5443 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5444 /* Don't even bother with turning off the OOK flag. */
5448 old_body_arena = (void **) &PL_xpv_root;
5449 old_body_offset = STRUCT_OFFSET(XPV, xpv_cur);
5453 SV *target = SvRV(sv);
5455 sv_del_backref(target, sv);
5457 SvREFCNT_dec(target);
5459 #ifdef PERL_OLD_COPY_ON_WRITE
5460 else if (SvPVX_const(sv)) {
5462 /* I believe I need to grab the global SV mutex here and
5463 then recheck the COW status. */
5465 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5468 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5469 SV_COW_NEXT_SV(sv));
5470 /* And drop it here. */
5472 } else if (SvLEN(sv)) {
5473 Safefree(SvPVX_const(sv));
5477 else if (SvPVX_const(sv) && SvLEN(sv))
5478 Safefree(SvPVX_mutable(sv));
5479 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5480 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5486 old_body_arena = (void **) &PL_xnv_root;
5490 SvFLAGS(sv) &= SVf_BREAK;
5491 SvFLAGS(sv) |= SVTYPEMASK;
5494 if (old_body_arena) {
5495 del_body(((char *)SvANY(sv) + old_body_offset), old_body_arena);
5499 if (type > SVt_RV) {
5500 my_safefree(SvANY(sv));
5505 =for apidoc sv_newref
5507 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5514 Perl_sv_newref(pTHX_ SV *sv)
5524 Decrement an SV's reference count, and if it drops to zero, call
5525 C<sv_clear> to invoke destructors and free up any memory used by
5526 the body; finally, deallocate the SV's head itself.
5527 Normally called via a wrapper macro C<SvREFCNT_dec>.
5533 Perl_sv_free(pTHX_ SV *sv)
5538 if (SvREFCNT(sv) == 0) {
5539 if (SvFLAGS(sv) & SVf_BREAK)
5540 /* this SV's refcnt has been artificially decremented to
5541 * trigger cleanup */
5543 if (PL_in_clean_all) /* All is fair */
5545 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5546 /* make sure SvREFCNT(sv)==0 happens very seldom */
5547 SvREFCNT(sv) = (~(U32)0)/2;
5550 if (ckWARN_d(WARN_INTERNAL)) {
5551 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5552 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5553 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5554 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5555 Perl_dump_sv_child(aTHX_ sv);
5560 if (--(SvREFCNT(sv)) > 0)
5562 Perl_sv_free2(aTHX_ sv);
5566 Perl_sv_free2(pTHX_ SV *sv)
5571 if (ckWARN_d(WARN_DEBUGGING))
5572 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5573 "Attempt to free temp prematurely: SV 0x%"UVxf
5574 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5578 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5579 /* make sure SvREFCNT(sv)==0 happens very seldom */
5580 SvREFCNT(sv) = (~(U32)0)/2;
5591 Returns the length of the string in the SV. Handles magic and type
5592 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5598 Perl_sv_len(pTHX_ register SV *sv)
5606 len = mg_length(sv);
5608 (void)SvPV_const(sv, len);
5613 =for apidoc sv_len_utf8
5615 Returns the number of characters in the string in an SV, counting wide
5616 UTF-8 bytes as a single character. Handles magic and type coercion.
5622 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5623 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5624 * (Note that the mg_len is not the length of the mg_ptr field.)
5629 Perl_sv_len_utf8(pTHX_ register SV *sv)
5635 return mg_length(sv);
5639 const U8 *s = (U8*)SvPV_const(sv, len);
5640 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5642 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5644 #ifdef PERL_UTF8_CACHE_ASSERT
5645 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5649 ulen = Perl_utf8_length(aTHX_ s, s + len);
5650 if (!mg && !SvREADONLY(sv)) {
5651 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5652 mg = mg_find(sv, PERL_MAGIC_utf8);
5662 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5663 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5664 * between UTF-8 and byte offsets. There are two (substr offset and substr
5665 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5666 * and byte offset) cache positions.
5668 * The mg_len field is used by sv_len_utf8(), see its comments.
5669 * Note that the mg_len is not the length of the mg_ptr field.
5673 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5674 I32 offsetp, const U8 *s, const U8 *start)
5678 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5680 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5684 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5686 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5687 (*mgp)->mg_ptr = (char *) *cachep;
5691 (*cachep)[i] = offsetp;
5692 (*cachep)[i+1] = s - start;
5700 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5701 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5702 * between UTF-8 and byte offsets. See also the comments of
5703 * S_utf8_mg_pos_init().
5707 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)
5711 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5713 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5714 if (*mgp && (*mgp)->mg_ptr) {
5715 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5716 ASSERT_UTF8_CACHE(*cachep);
5717 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5719 else { /* We will skip to the right spot. */
5724 /* The assumption is that going backward is half
5725 * the speed of going forward (that's where the
5726 * 2 * backw in the below comes from). (The real
5727 * figure of course depends on the UTF-8 data.) */
5729 if ((*cachep)[i] > (STRLEN)uoff) {
5731 backw = (*cachep)[i] - (STRLEN)uoff;
5733 if (forw < 2 * backw)
5736 p = start + (*cachep)[i+1];
5738 /* Try this only for the substr offset (i == 0),
5739 * not for the substr length (i == 2). */
5740 else if (i == 0) { /* (*cachep)[i] < uoff */
5741 const STRLEN ulen = sv_len_utf8(sv);
5743 if ((STRLEN)uoff < ulen) {
5744 forw = (STRLEN)uoff - (*cachep)[i];
5745 backw = ulen - (STRLEN)uoff;
5747 if (forw < 2 * backw)
5748 p = start + (*cachep)[i+1];
5753 /* If the string is not long enough for uoff,
5754 * we could extend it, but not at this low a level. */
5758 if (forw < 2 * backw) {
5765 while (UTF8_IS_CONTINUATION(*p))
5770 /* Update the cache. */
5771 (*cachep)[i] = (STRLEN)uoff;
5772 (*cachep)[i+1] = p - start;
5774 /* Drop the stale "length" cache */
5783 if (found) { /* Setup the return values. */
5784 *offsetp = (*cachep)[i+1];
5785 *sp = start + *offsetp;
5788 *offsetp = send - start;
5790 else if (*sp < start) {
5796 #ifdef PERL_UTF8_CACHE_ASSERT
5801 while (n-- && s < send)
5805 assert(*offsetp == s - start);
5806 assert((*cachep)[0] == (STRLEN)uoff);
5807 assert((*cachep)[1] == *offsetp);
5809 ASSERT_UTF8_CACHE(*cachep);
5818 =for apidoc sv_pos_u2b
5820 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5821 the start of the string, to a count of the equivalent number of bytes; if
5822 lenp is non-zero, it does the same to lenp, but this time starting from
5823 the offset, rather than from the start of the string. Handles magic and
5830 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5831 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5832 * byte offsets. See also the comments of S_utf8_mg_pos().
5837 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5845 start = (U8*)SvPV_const(sv, len);
5849 const U8 *s = start;
5850 I32 uoffset = *offsetp;
5851 const U8 * const send = s + len;
5855 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5857 if (!found && uoffset > 0) {
5858 while (s < send && uoffset--)
5862 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5864 *offsetp = s - start;
5869 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5873 if (!found && *lenp > 0) {
5876 while (s < send && ulen--)
5880 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5884 ASSERT_UTF8_CACHE(cache);
5896 =for apidoc sv_pos_b2u
5898 Converts the value pointed to by offsetp from a count of bytes from the
5899 start of the string, to a count of the equivalent number of UTF-8 chars.
5900 Handles magic and type coercion.
5906 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5907 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5908 * byte offsets. See also the comments of S_utf8_mg_pos().
5913 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5921 s = (const U8*)SvPV_const(sv, len);
5922 if ((I32)len < *offsetp)
5923 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5925 const U8* send = s + *offsetp;
5927 STRLEN *cache = NULL;
5931 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5932 mg = mg_find(sv, PERL_MAGIC_utf8);
5933 if (mg && mg->mg_ptr) {
5934 cache = (STRLEN *) mg->mg_ptr;
5935 if (cache[1] == (STRLEN)*offsetp) {
5936 /* An exact match. */
5937 *offsetp = cache[0];
5941 else if (cache[1] < (STRLEN)*offsetp) {
5942 /* We already know part of the way. */
5945 /* Let the below loop do the rest. */
5947 else { /* cache[1] > *offsetp */
5948 /* We already know all of the way, now we may
5949 * be able to walk back. The same assumption
5950 * is made as in S_utf8_mg_pos(), namely that
5951 * walking backward is twice slower than
5952 * walking forward. */
5953 const STRLEN forw = *offsetp;
5954 STRLEN backw = cache[1] - *offsetp;
5956 if (!(forw < 2 * backw)) {
5957 const U8 *p = s + cache[1];
5964 while (UTF8_IS_CONTINUATION(*p)) {
5972 *offsetp = cache[0];
5974 /* Drop the stale "length" cache */
5982 ASSERT_UTF8_CACHE(cache);
5988 /* Call utf8n_to_uvchr() to validate the sequence
5989 * (unless a simple non-UTF character) */
5990 if (!UTF8_IS_INVARIANT(*s))
5991 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6000 if (!SvREADONLY(sv)) {
6002 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6003 mg = mg_find(sv, PERL_MAGIC_utf8);
6008 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6009 mg->mg_ptr = (char *) cache;
6014 cache[1] = *offsetp;
6015 /* Drop the stale "length" cache */
6028 Returns a boolean indicating whether the strings in the two SVs are
6029 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6030 coerce its args to strings if necessary.
6036 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6044 SV* svrecode = Nullsv;
6051 pv1 = SvPV_const(sv1, cur1);
6058 pv2 = SvPV_const(sv2, cur2);
6060 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6061 /* Differing utf8ness.
6062 * Do not UTF8size the comparands as a side-effect. */
6065 svrecode = newSVpvn(pv2, cur2);
6066 sv_recode_to_utf8(svrecode, PL_encoding);
6067 pv2 = SvPV_const(svrecode, cur2);
6070 svrecode = newSVpvn(pv1, cur1);
6071 sv_recode_to_utf8(svrecode, PL_encoding);
6072 pv1 = SvPV_const(svrecode, cur1);
6074 /* Now both are in UTF-8. */
6076 SvREFCNT_dec(svrecode);
6081 bool is_utf8 = TRUE;
6084 /* sv1 is the UTF-8 one,
6085 * if is equal it must be downgrade-able */
6086 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6092 /* sv2 is the UTF-8 one,
6093 * if is equal it must be downgrade-able */
6094 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6100 /* Downgrade not possible - cannot be eq */
6108 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6111 SvREFCNT_dec(svrecode);
6122 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6123 string in C<sv1> is less than, equal to, or greater than the string in
6124 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6125 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6131 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6134 const char *pv1, *pv2;
6137 SV *svrecode = Nullsv;
6144 pv1 = SvPV_const(sv1, cur1);
6151 pv2 = SvPV_const(sv2, cur2);
6153 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6154 /* Differing utf8ness.
6155 * Do not UTF8size the comparands as a side-effect. */
6158 svrecode = newSVpvn(pv2, cur2);
6159 sv_recode_to_utf8(svrecode, PL_encoding);
6160 pv2 = SvPV_const(svrecode, cur2);
6163 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6168 svrecode = newSVpvn(pv1, cur1);
6169 sv_recode_to_utf8(svrecode, PL_encoding);
6170 pv1 = SvPV_const(svrecode, cur1);
6173 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6179 cmp = cur2 ? -1 : 0;
6183 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6186 cmp = retval < 0 ? -1 : 1;
6187 } else if (cur1 == cur2) {
6190 cmp = cur1 < cur2 ? -1 : 1;
6195 SvREFCNT_dec(svrecode);
6204 =for apidoc sv_cmp_locale
6206 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6207 'use bytes' aware, handles get magic, and will coerce its args to strings
6208 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6214 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6216 #ifdef USE_LOCALE_COLLATE
6222 if (PL_collation_standard)
6226 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6228 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6230 if (!pv1 || !len1) {
6241 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6244 return retval < 0 ? -1 : 1;
6247 * When the result of collation is equality, that doesn't mean
6248 * that there are no differences -- some locales exclude some
6249 * characters from consideration. So to avoid false equalities,
6250 * we use the raw string as a tiebreaker.
6256 #endif /* USE_LOCALE_COLLATE */
6258 return sv_cmp(sv1, sv2);
6262 #ifdef USE_LOCALE_COLLATE
6265 =for apidoc sv_collxfrm
6267 Add Collate Transform magic to an SV if it doesn't already have it.
6269 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6270 scalar data of the variable, but transformed to such a format that a normal
6271 memory comparison can be used to compare the data according to the locale
6278 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6282 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6283 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6289 Safefree(mg->mg_ptr);
6290 s = SvPV_const(sv, len);
6291 if ((xf = mem_collxfrm(s, len, &xlen))) {
6292 if (SvREADONLY(sv)) {
6295 return xf + sizeof(PL_collation_ix);
6298 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6299 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6312 if (mg && mg->mg_ptr) {
6314 return mg->mg_ptr + sizeof(PL_collation_ix);
6322 #endif /* USE_LOCALE_COLLATE */
6327 Get a line from the filehandle and store it into the SV, optionally
6328 appending to the currently-stored string.
6334 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6338 register STDCHAR rslast;
6339 register STDCHAR *bp;
6345 if (SvTHINKFIRST(sv))
6346 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6347 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6349 However, perlbench says it's slower, because the existing swipe code
6350 is faster than copy on write.
6351 Swings and roundabouts. */
6352 SvUPGRADE(sv, SVt_PV);
6357 if (PerlIO_isutf8(fp)) {
6359 sv_utf8_upgrade_nomg(sv);
6360 sv_pos_u2b(sv,&append,0);
6362 } else if (SvUTF8(sv)) {
6363 SV * const tsv = NEWSV(0,0);
6364 sv_gets(tsv, fp, 0);
6365 sv_utf8_upgrade_nomg(tsv);
6366 SvCUR_set(sv,append);
6369 goto return_string_or_null;
6374 if (PerlIO_isutf8(fp))
6377 if (IN_PERL_COMPILETIME) {
6378 /* we always read code in line mode */
6382 else if (RsSNARF(PL_rs)) {
6383 /* If it is a regular disk file use size from stat() as estimate
6384 of amount we are going to read - may result in malloc-ing
6385 more memory than we realy need if layers bellow reduce
6386 size we read (e.g. CRLF or a gzip layer)
6389 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6390 const Off_t offset = PerlIO_tell(fp);
6391 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6392 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6398 else if (RsRECORD(PL_rs)) {
6402 /* Grab the size of the record we're getting */
6403 recsize = SvIV(SvRV(PL_rs));
6404 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6407 /* VMS wants read instead of fread, because fread doesn't respect */
6408 /* RMS record boundaries. This is not necessarily a good thing to be */
6409 /* doing, but we've got no other real choice - except avoid stdio
6410 as implementation - perhaps write a :vms layer ?
6412 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6414 bytesread = PerlIO_read(fp, buffer, recsize);
6418 SvCUR_set(sv, bytesread += append);
6419 buffer[bytesread] = '\0';
6420 goto return_string_or_null;
6422 else if (RsPARA(PL_rs)) {
6428 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6429 if (PerlIO_isutf8(fp)) {
6430 rsptr = SvPVutf8(PL_rs, rslen);
6433 if (SvUTF8(PL_rs)) {
6434 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6435 Perl_croak(aTHX_ "Wide character in $/");
6438 rsptr = SvPV_const(PL_rs, rslen);
6442 rslast = rslen ? rsptr[rslen - 1] : '\0';
6444 if (rspara) { /* have to do this both before and after */
6445 do { /* to make sure file boundaries work right */
6448 i = PerlIO_getc(fp);
6452 PerlIO_ungetc(fp,i);
6458 /* See if we know enough about I/O mechanism to cheat it ! */
6460 /* This used to be #ifdef test - it is made run-time test for ease
6461 of abstracting out stdio interface. One call should be cheap
6462 enough here - and may even be a macro allowing compile
6466 if (PerlIO_fast_gets(fp)) {
6469 * We're going to steal some values from the stdio struct
6470 * and put EVERYTHING in the innermost loop into registers.
6472 register STDCHAR *ptr;
6476 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6477 /* An ungetc()d char is handled separately from the regular
6478 * buffer, so we getc() it back out and stuff it in the buffer.
6480 i = PerlIO_getc(fp);
6481 if (i == EOF) return 0;
6482 *(--((*fp)->_ptr)) = (unsigned char) i;
6486 /* Here is some breathtakingly efficient cheating */
6488 cnt = PerlIO_get_cnt(fp); /* get count into register */
6489 /* make sure we have the room */
6490 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6491 /* Not room for all of it
6492 if we are looking for a separator and room for some
6494 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6495 /* just process what we have room for */
6496 shortbuffered = cnt - SvLEN(sv) + append + 1;
6497 cnt -= shortbuffered;
6501 /* remember that cnt can be negative */
6502 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6507 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6508 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6509 DEBUG_P(PerlIO_printf(Perl_debug_log,
6510 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6511 DEBUG_P(PerlIO_printf(Perl_debug_log,
6512 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6513 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6514 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6519 while (cnt > 0) { /* this | eat */
6521 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6522 goto thats_all_folks; /* screams | sed :-) */
6526 Copy(ptr, bp, cnt, char); /* this | eat */
6527 bp += cnt; /* screams | dust */
6528 ptr += cnt; /* louder | sed :-) */
6533 if (shortbuffered) { /* oh well, must extend */
6534 cnt = shortbuffered;
6536 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6538 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6539 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6543 DEBUG_P(PerlIO_printf(Perl_debug_log,
6544 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6545 PTR2UV(ptr),(long)cnt));
6546 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6548 DEBUG_P(PerlIO_printf(Perl_debug_log,
6549 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6550 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6551 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6553 /* This used to call 'filbuf' in stdio form, but as that behaves like
6554 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6555 another abstraction. */
6556 i = PerlIO_getc(fp); /* get more characters */
6558 DEBUG_P(PerlIO_printf(Perl_debug_log,
6559 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6560 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6561 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6563 cnt = PerlIO_get_cnt(fp);
6564 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6565 DEBUG_P(PerlIO_printf(Perl_debug_log,
6566 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6568 if (i == EOF) /* all done for ever? */
6569 goto thats_really_all_folks;
6571 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6573 SvGROW(sv, bpx + cnt + 2);
6574 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6576 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6578 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6579 goto thats_all_folks;
6583 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6584 memNE((char*)bp - rslen, rsptr, rslen))
6585 goto screamer; /* go back to the fray */
6586 thats_really_all_folks:
6588 cnt += shortbuffered;
6589 DEBUG_P(PerlIO_printf(Perl_debug_log,
6590 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6591 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6592 DEBUG_P(PerlIO_printf(Perl_debug_log,
6593 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6594 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6595 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6597 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6598 DEBUG_P(PerlIO_printf(Perl_debug_log,
6599 "Screamer: done, len=%ld, string=|%.*s|\n",
6600 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6604 /*The big, slow, and stupid way. */
6605 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6607 Newx(buf, 8192, STDCHAR);
6615 register const STDCHAR *bpe = buf + sizeof(buf);
6617 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6618 ; /* keep reading */
6622 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6623 /* Accomodate broken VAXC compiler, which applies U8 cast to
6624 * both args of ?: operator, causing EOF to change into 255
6627 i = (U8)buf[cnt - 1];
6633 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6635 sv_catpvn(sv, (char *) buf, cnt);
6637 sv_setpvn(sv, (char *) buf, cnt);
6639 if (i != EOF && /* joy */
6641 SvCUR(sv) < rslen ||
6642 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6646 * If we're reading from a TTY and we get a short read,
6647 * indicating that the user hit his EOF character, we need
6648 * to notice it now, because if we try to read from the TTY
6649 * again, the EOF condition will disappear.
6651 * The comparison of cnt to sizeof(buf) is an optimization
6652 * that prevents unnecessary calls to feof().
6656 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6660 #ifdef USE_HEAP_INSTEAD_OF_STACK
6665 if (rspara) { /* have to do this both before and after */
6666 while (i != EOF) { /* to make sure file boundaries work right */
6667 i = PerlIO_getc(fp);
6669 PerlIO_ungetc(fp,i);
6675 return_string_or_null:
6676 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6682 Auto-increment of the value in the SV, doing string to numeric conversion
6683 if necessary. Handles 'get' magic.
6689 Perl_sv_inc(pTHX_ register SV *sv)
6697 if (SvTHINKFIRST(sv)) {
6699 sv_force_normal_flags(sv, 0);
6700 if (SvREADONLY(sv)) {
6701 if (IN_PERL_RUNTIME)
6702 Perl_croak(aTHX_ PL_no_modify);
6706 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6708 i = PTR2IV(SvRV(sv));
6713 flags = SvFLAGS(sv);
6714 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6715 /* It's (privately or publicly) a float, but not tested as an
6716 integer, so test it to see. */
6718 flags = SvFLAGS(sv);
6720 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6721 /* It's publicly an integer, or privately an integer-not-float */
6722 #ifdef PERL_PRESERVE_IVUV
6726 if (SvUVX(sv) == UV_MAX)
6727 sv_setnv(sv, UV_MAX_P1);
6729 (void)SvIOK_only_UV(sv);
6730 SvUV_set(sv, SvUVX(sv) + 1);
6732 if (SvIVX(sv) == IV_MAX)
6733 sv_setuv(sv, (UV)IV_MAX + 1);
6735 (void)SvIOK_only(sv);
6736 SvIV_set(sv, SvIVX(sv) + 1);
6741 if (flags & SVp_NOK) {
6742 (void)SvNOK_only(sv);
6743 SvNV_set(sv, SvNVX(sv) + 1.0);
6747 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6748 if ((flags & SVTYPEMASK) < SVt_PVIV)
6749 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6750 (void)SvIOK_only(sv);
6755 while (isALPHA(*d)) d++;
6756 while (isDIGIT(*d)) d++;
6758 #ifdef PERL_PRESERVE_IVUV
6759 /* Got to punt this as an integer if needs be, but we don't issue
6760 warnings. Probably ought to make the sv_iv_please() that does
6761 the conversion if possible, and silently. */
6762 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6763 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6764 /* Need to try really hard to see if it's an integer.
6765 9.22337203685478e+18 is an integer.
6766 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6767 so $a="9.22337203685478e+18"; $a+0; $a++
6768 needs to be the same as $a="9.22337203685478e+18"; $a++
6775 /* sv_2iv *should* have made this an NV */
6776 if (flags & SVp_NOK) {
6777 (void)SvNOK_only(sv);
6778 SvNV_set(sv, SvNVX(sv) + 1.0);
6781 /* I don't think we can get here. Maybe I should assert this
6782 And if we do get here I suspect that sv_setnv will croak. NWC
6784 #if defined(USE_LONG_DOUBLE)
6785 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",
6786 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6788 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6789 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6792 #endif /* PERL_PRESERVE_IVUV */
6793 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6797 while (d >= SvPVX_const(sv)) {
6805 /* MKS: The original code here died if letters weren't consecutive.
6806 * at least it didn't have to worry about non-C locales. The
6807 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6808 * arranged in order (although not consecutively) and that only
6809 * [A-Za-z] are accepted by isALPHA in the C locale.
6811 if (*d != 'z' && *d != 'Z') {
6812 do { ++*d; } while (!isALPHA(*d));
6815 *(d--) -= 'z' - 'a';
6820 *(d--) -= 'z' - 'a' + 1;
6824 /* oh,oh, the number grew */
6825 SvGROW(sv, SvCUR(sv) + 2);
6826 SvCUR_set(sv, SvCUR(sv) + 1);
6827 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6838 Auto-decrement of the value in the SV, doing string to numeric conversion
6839 if necessary. Handles 'get' magic.
6845 Perl_sv_dec(pTHX_ register SV *sv)
6852 if (SvTHINKFIRST(sv)) {
6854 sv_force_normal_flags(sv, 0);
6855 if (SvREADONLY(sv)) {
6856 if (IN_PERL_RUNTIME)
6857 Perl_croak(aTHX_ PL_no_modify);
6861 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6863 i = PTR2IV(SvRV(sv));
6868 /* Unlike sv_inc we don't have to worry about string-never-numbers
6869 and keeping them magic. But we mustn't warn on punting */
6870 flags = SvFLAGS(sv);
6871 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6872 /* It's publicly an integer, or privately an integer-not-float */
6873 #ifdef PERL_PRESERVE_IVUV
6877 if (SvUVX(sv) == 0) {
6878 (void)SvIOK_only(sv);
6882 (void)SvIOK_only_UV(sv);
6883 SvUV_set(sv, SvUVX(sv) - 1);
6886 if (SvIVX(sv) == IV_MIN)
6887 sv_setnv(sv, (NV)IV_MIN - 1.0);
6889 (void)SvIOK_only(sv);
6890 SvIV_set(sv, SvIVX(sv) - 1);
6895 if (flags & SVp_NOK) {
6896 SvNV_set(sv, SvNVX(sv) - 1.0);
6897 (void)SvNOK_only(sv);
6900 if (!(flags & SVp_POK)) {
6901 if ((flags & SVTYPEMASK) < SVt_PVIV)
6902 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6904 (void)SvIOK_only(sv);
6907 #ifdef PERL_PRESERVE_IVUV
6909 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6910 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6911 /* Need to try really hard to see if it's an integer.
6912 9.22337203685478e+18 is an integer.
6913 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6914 so $a="9.22337203685478e+18"; $a+0; $a--
6915 needs to be the same as $a="9.22337203685478e+18"; $a--
6922 /* sv_2iv *should* have made this an NV */
6923 if (flags & SVp_NOK) {
6924 (void)SvNOK_only(sv);
6925 SvNV_set(sv, SvNVX(sv) - 1.0);
6928 /* I don't think we can get here. Maybe I should assert this
6929 And if we do get here I suspect that sv_setnv will croak. NWC
6931 #if defined(USE_LONG_DOUBLE)
6932 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",
6933 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6935 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6936 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6940 #endif /* PERL_PRESERVE_IVUV */
6941 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6945 =for apidoc sv_mortalcopy
6947 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6948 The new SV is marked as mortal. It will be destroyed "soon", either by an
6949 explicit call to FREETMPS, or by an implicit call at places such as
6950 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6955 /* Make a string that will exist for the duration of the expression
6956 * evaluation. Actually, it may have to last longer than that, but
6957 * hopefully we won't free it until it has been assigned to a
6958 * permanent location. */
6961 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6966 sv_setsv(sv,oldstr);
6968 PL_tmps_stack[++PL_tmps_ix] = sv;
6974 =for apidoc sv_newmortal
6976 Creates a new null SV which is mortal. The reference count of the SV is
6977 set to 1. It will be destroyed "soon", either by an explicit call to
6978 FREETMPS, or by an implicit call at places such as statement boundaries.
6979 See also C<sv_mortalcopy> and C<sv_2mortal>.
6985 Perl_sv_newmortal(pTHX)
6990 SvFLAGS(sv) = SVs_TEMP;
6992 PL_tmps_stack[++PL_tmps_ix] = sv;
6997 =for apidoc sv_2mortal
6999 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7000 by an explicit call to FREETMPS, or by an implicit call at places such as
7001 statement boundaries. SvTEMP() is turned on which means that the SV's
7002 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7003 and C<sv_mortalcopy>.
7009 Perl_sv_2mortal(pTHX_ register SV *sv)
7014 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7017 PL_tmps_stack[++PL_tmps_ix] = sv;
7025 Creates a new SV and copies a string into it. The reference count for the
7026 SV is set to 1. If C<len> is zero, Perl will compute the length using
7027 strlen(). For efficiency, consider using C<newSVpvn> instead.
7033 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7038 sv_setpvn(sv,s,len ? len : strlen(s));
7043 =for apidoc newSVpvn
7045 Creates a new SV and copies a string into it. The reference count for the
7046 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7047 string. You are responsible for ensuring that the source string is at least
7048 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7054 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7059 sv_setpvn(sv,s,len);
7065 =for apidoc newSVhek
7067 Creates a new SV from the hash key structure. It will generate scalars that
7068 point to the shared string table where possible. Returns a new (undefined)
7069 SV if the hek is NULL.
7075 Perl_newSVhek(pTHX_ const HEK *hek)
7084 if (HEK_LEN(hek) == HEf_SVKEY) {
7085 return newSVsv(*(SV**)HEK_KEY(hek));
7087 const int flags = HEK_FLAGS(hek);
7088 if (flags & HVhek_WASUTF8) {
7090 Andreas would like keys he put in as utf8 to come back as utf8
7092 STRLEN utf8_len = HEK_LEN(hek);
7093 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7094 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7097 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7099 } else if (flags & HVhek_REHASH) {
7100 /* We don't have a pointer to the hv, so we have to replicate the
7101 flag into every HEK. This hv is using custom a hasing
7102 algorithm. Hence we can't return a shared string scalar, as
7103 that would contain the (wrong) hash value, and might get passed
7104 into an hv routine with a regular hash */
7106 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7111 /* This will be overwhelminly the most common case. */
7112 return newSVpvn_share(HEK_KEY(hek),
7113 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7119 =for apidoc newSVpvn_share
7121 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7122 table. If the string does not already exist in the table, it is created
7123 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7124 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7125 otherwise the hash is computed. The idea here is that as the string table
7126 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7127 hash lookup will avoid string compare.
7133 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7136 bool is_utf8 = FALSE;
7138 STRLEN tmplen = -len;
7140 /* See the note in hv.c:hv_fetch() --jhi */
7141 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7145 PERL_HASH(hash, src, len);
7147 sv_upgrade(sv, SVt_PV);
7148 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7160 #if defined(PERL_IMPLICIT_CONTEXT)
7162 /* pTHX_ magic can't cope with varargs, so this is a no-context
7163 * version of the main function, (which may itself be aliased to us).
7164 * Don't access this version directly.
7168 Perl_newSVpvf_nocontext(const char* pat, ...)
7173 va_start(args, pat);
7174 sv = vnewSVpvf(pat, &args);
7181 =for apidoc newSVpvf
7183 Creates a new SV and initializes it with the string formatted like
7190 Perl_newSVpvf(pTHX_ const char* pat, ...)
7194 va_start(args, pat);
7195 sv = vnewSVpvf(pat, &args);
7200 /* backend for newSVpvf() and newSVpvf_nocontext() */
7203 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7207 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7214 Creates a new SV and copies a floating point value into it.
7215 The reference count for the SV is set to 1.
7221 Perl_newSVnv(pTHX_ NV n)
7233 Creates a new SV and copies an integer into it. The reference count for the
7240 Perl_newSViv(pTHX_ IV i)
7252 Creates a new SV and copies an unsigned integer into it.
7253 The reference count for the SV is set to 1.
7259 Perl_newSVuv(pTHX_ UV u)
7269 =for apidoc newRV_noinc
7271 Creates an RV wrapper for an SV. The reference count for the original
7272 SV is B<not> incremented.
7278 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7283 sv_upgrade(sv, SVt_RV);
7285 SvRV_set(sv, tmpRef);
7290 /* newRV_inc is the official function name to use now.
7291 * newRV_inc is in fact #defined to newRV in sv.h
7295 Perl_newRV(pTHX_ SV *tmpRef)
7297 return newRV_noinc(SvREFCNT_inc(tmpRef));
7303 Creates a new SV which is an exact duplicate of the original SV.
7310 Perl_newSVsv(pTHX_ register SV *old)
7316 if (SvTYPE(old) == SVTYPEMASK) {
7317 if (ckWARN_d(WARN_INTERNAL))
7318 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7322 /* SV_GMAGIC is the default for sv_setv()
7323 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7324 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7325 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7330 =for apidoc sv_reset
7332 Underlying implementation for the C<reset> Perl function.
7333 Note that the perl-level function is vaguely deprecated.
7339 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7342 char todo[PERL_UCHAR_MAX+1];
7347 if (!*s) { /* reset ?? searches */
7348 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7350 PMOP *pm = (PMOP *) mg->mg_obj;
7352 pm->op_pmdynflags &= ~PMdf_USED;
7359 /* reset variables */
7361 if (!HvARRAY(stash))
7364 Zero(todo, 256, char);
7367 I32 i = (unsigned char)*s;
7371 max = (unsigned char)*s++;
7372 for ( ; i <= max; i++) {
7375 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7377 for (entry = HvARRAY(stash)[i];
7379 entry = HeNEXT(entry))
7384 if (!todo[(U8)*HeKEY(entry)])
7386 gv = (GV*)HeVAL(entry);
7389 if (SvTHINKFIRST(sv)) {
7390 if (!SvREADONLY(sv) && SvROK(sv))
7392 /* XXX Is this continue a bug? Why should THINKFIRST
7393 exempt us from resetting arrays and hashes? */
7397 if (SvTYPE(sv) >= SVt_PV) {
7399 if (SvPVX_const(sv) != Nullch)
7407 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7409 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7412 # if defined(USE_ENVIRON_ARRAY)
7415 # endif /* USE_ENVIRON_ARRAY */
7426 Using various gambits, try to get an IO from an SV: the IO slot if its a
7427 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7428 named after the PV if we're a string.
7434 Perl_sv_2io(pTHX_ SV *sv)
7439 switch (SvTYPE(sv)) {
7447 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7451 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7453 return sv_2io(SvRV(sv));
7454 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7460 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7469 Using various gambits, try to get a CV from an SV; in addition, try if
7470 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7476 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7483 return *gvp = Nullgv, Nullcv;
7484 switch (SvTYPE(sv)) {
7502 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7503 tryAMAGICunDEREF(to_cv);
7506 if (SvTYPE(sv) == SVt_PVCV) {
7515 Perl_croak(aTHX_ "Not a subroutine reference");
7520 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7526 if (lref && !GvCVu(gv)) {
7529 tmpsv = NEWSV(704,0);
7530 gv_efullname3(tmpsv, gv, Nullch);
7531 /* XXX this is probably not what they think they're getting.
7532 * It has the same effect as "sub name;", i.e. just a forward
7534 newSUB(start_subparse(FALSE, 0),
7535 newSVOP(OP_CONST, 0, tmpsv),
7540 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7550 Returns true if the SV has a true value by Perl's rules.
7551 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7552 instead use an in-line version.
7558 Perl_sv_true(pTHX_ register SV *sv)
7563 register const XPV* const tXpv = (XPV*)SvANY(sv);
7565 (tXpv->xpv_cur > 1 ||
7566 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7573 return SvIVX(sv) != 0;
7576 return SvNVX(sv) != 0.0;
7578 return sv_2bool(sv);
7584 =for apidoc sv_pvn_force
7586 Get a sensible string out of the SV somehow.
7587 A private implementation of the C<SvPV_force> macro for compilers which
7588 can't cope with complex macro expressions. Always use the macro instead.
7590 =for apidoc sv_pvn_force_flags
7592 Get a sensible string out of the SV somehow.
7593 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7594 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7595 implemented in terms of this function.
7596 You normally want to use the various wrapper macros instead: see
7597 C<SvPV_force> and C<SvPV_force_nomg>
7603 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7606 if (SvTHINKFIRST(sv) && !SvROK(sv))
7607 sv_force_normal_flags(sv, 0);
7617 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7618 const char * const ref = sv_reftype(sv,0);
7620 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7621 ref, OP_NAME(PL_op));
7623 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7625 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7626 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7628 s = sv_2pv_flags(sv, &len, flags);
7632 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7635 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7636 SvGROW(sv, len + 1);
7637 Move(s,SvPVX(sv),len,char);
7642 SvPOK_on(sv); /* validate pointer */
7644 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7645 PTR2UV(sv),SvPVX_const(sv)));
7648 return SvPVX_mutable(sv);
7652 =for apidoc sv_pvbyten_force
7654 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7660 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7662 sv_pvn_force(sv,lp);
7663 sv_utf8_downgrade(sv,0);
7669 =for apidoc sv_pvutf8n_force
7671 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7677 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7679 sv_pvn_force(sv,lp);
7680 sv_utf8_upgrade(sv);
7686 =for apidoc sv_reftype
7688 Returns a string describing what the SV is a reference to.
7694 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7696 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7697 inside return suggests a const propagation bug in g++. */
7698 if (ob && SvOBJECT(sv)) {
7699 char * const name = HvNAME_get(SvSTASH(sv));
7700 return name ? name : (char *) "__ANON__";
7703 switch (SvTYPE(sv)) {
7720 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7721 /* tied lvalues should appear to be
7722 * scalars for backwards compatitbility */
7723 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7724 ? "SCALAR" : "LVALUE");
7725 case SVt_PVAV: return "ARRAY";
7726 case SVt_PVHV: return "HASH";
7727 case SVt_PVCV: return "CODE";
7728 case SVt_PVGV: return "GLOB";
7729 case SVt_PVFM: return "FORMAT";
7730 case SVt_PVIO: return "IO";
7731 default: return "UNKNOWN";
7737 =for apidoc sv_isobject
7739 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7740 object. If the SV is not an RV, or if the object is not blessed, then this
7747 Perl_sv_isobject(pTHX_ SV *sv)
7763 Returns a boolean indicating whether the SV is blessed into the specified
7764 class. This does not check for subtypes; use C<sv_derived_from> to verify
7765 an inheritance relationship.
7771 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7782 hvname = HvNAME_get(SvSTASH(sv));
7786 return strEQ(hvname, name);
7792 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7793 it will be upgraded to one. If C<classname> is non-null then the new SV will
7794 be blessed in the specified package. The new SV is returned and its
7795 reference count is 1.
7801 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7807 SV_CHECK_THINKFIRST_COW_DROP(rv);
7810 if (SvTYPE(rv) >= SVt_PVMG) {
7811 const U32 refcnt = SvREFCNT(rv);
7815 SvREFCNT(rv) = refcnt;
7818 if (SvTYPE(rv) < SVt_RV)
7819 sv_upgrade(rv, SVt_RV);
7820 else if (SvTYPE(rv) > SVt_RV) {
7831 HV* const stash = gv_stashpv(classname, TRUE);
7832 (void)sv_bless(rv, stash);
7838 =for apidoc sv_setref_pv
7840 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7841 argument will be upgraded to an RV. That RV will be modified to point to
7842 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7843 into the SV. The C<classname> argument indicates the package for the
7844 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7845 will have a reference count of 1, and the RV will be returned.
7847 Do not use with other Perl types such as HV, AV, SV, CV, because those
7848 objects will become corrupted by the pointer copy process.
7850 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7856 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7859 sv_setsv(rv, &PL_sv_undef);
7863 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7868 =for apidoc sv_setref_iv
7870 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7871 argument will be upgraded to an RV. That RV will be modified to point to
7872 the new SV. The C<classname> argument indicates the package for the
7873 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7874 will have a reference count of 1, and the RV will be returned.
7880 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7882 sv_setiv(newSVrv(rv,classname), iv);
7887 =for apidoc sv_setref_uv
7889 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7890 argument will be upgraded to an RV. That RV will be modified to point to
7891 the new SV. The C<classname> argument indicates the package for the
7892 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7893 will have a reference count of 1, and the RV will be returned.
7899 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7901 sv_setuv(newSVrv(rv,classname), uv);
7906 =for apidoc sv_setref_nv
7908 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7909 argument will be upgraded to an RV. That RV will be modified to point to
7910 the new SV. The C<classname> argument indicates the package for the
7911 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7912 will have a reference count of 1, and the RV will be returned.
7918 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7920 sv_setnv(newSVrv(rv,classname), nv);
7925 =for apidoc sv_setref_pvn
7927 Copies a string into a new SV, optionally blessing the SV. The length of the
7928 string must be specified with C<n>. The C<rv> argument will be upgraded to
7929 an RV. That RV will be modified to point to the new SV. The C<classname>
7930 argument indicates the package for the blessing. Set C<classname> to
7931 C<Nullch> to avoid the blessing. The new SV will have a reference count
7932 of 1, and the RV will be returned.
7934 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7940 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7942 sv_setpvn(newSVrv(rv,classname), pv, n);
7947 =for apidoc sv_bless
7949 Blesses an SV into a specified package. The SV must be an RV. The package
7950 must be designated by its stash (see C<gv_stashpv()>). The reference count
7951 of the SV is unaffected.
7957 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7961 Perl_croak(aTHX_ "Can't bless non-reference value");
7963 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7964 if (SvREADONLY(tmpRef))
7965 Perl_croak(aTHX_ PL_no_modify);
7966 if (SvOBJECT(tmpRef)) {
7967 if (SvTYPE(tmpRef) != SVt_PVIO)
7969 SvREFCNT_dec(SvSTASH(tmpRef));
7972 SvOBJECT_on(tmpRef);
7973 if (SvTYPE(tmpRef) != SVt_PVIO)
7975 SvUPGRADE(tmpRef, SVt_PVMG);
7976 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7983 if(SvSMAGICAL(tmpRef))
7984 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7992 /* Downgrades a PVGV to a PVMG.
7996 S_sv_unglob(pTHX_ SV *sv)
8000 assert(SvTYPE(sv) == SVt_PVGV);
8005 sv_del_backref((SV*)GvSTASH(sv), sv);
8006 GvSTASH(sv) = Nullhv;
8008 sv_unmagic(sv, PERL_MAGIC_glob);
8009 Safefree(GvNAME(sv));
8012 /* need to keep SvANY(sv) in the right arena */
8013 xpvmg = new_XPVMG();
8014 StructCopy(SvANY(sv), xpvmg, XPVMG);
8015 del_XPVGV(SvANY(sv));
8018 SvFLAGS(sv) &= ~SVTYPEMASK;
8019 SvFLAGS(sv) |= SVt_PVMG;
8023 =for apidoc sv_unref_flags
8025 Unsets the RV status of the SV, and decrements the reference count of
8026 whatever was being referenced by the RV. This can almost be thought of
8027 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8028 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8029 (otherwise the decrementing is conditional on the reference count being
8030 different from one or the reference being a readonly SV).
8037 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8039 SV* const target = SvRV(ref);
8041 if (SvWEAKREF(ref)) {
8042 sv_del_backref(target, ref);
8044 SvRV_set(ref, NULL);
8047 SvRV_set(ref, NULL);
8049 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8050 assigned to as BEGIN {$a = \"Foo"} will fail. */
8051 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8052 SvREFCNT_dec(target);
8053 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8054 sv_2mortal(target); /* Schedule for freeing later */
8058 =for apidoc sv_untaint
8060 Untaint an SV. Use C<SvTAINTED_off> instead.
8065 Perl_sv_untaint(pTHX_ SV *sv)
8067 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8068 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8075 =for apidoc sv_tainted
8077 Test an SV for taintedness. Use C<SvTAINTED> instead.
8082 Perl_sv_tainted(pTHX_ SV *sv)
8084 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8085 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8086 if (mg && (mg->mg_len & 1) )
8093 =for apidoc sv_setpviv
8095 Copies an integer into the given SV, also updating its string value.
8096 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8102 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8104 char buf[TYPE_CHARS(UV)];
8106 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8108 sv_setpvn(sv, ptr, ebuf - ptr);
8112 =for apidoc sv_setpviv_mg
8114 Like C<sv_setpviv>, but also handles 'set' magic.
8120 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8126 #if defined(PERL_IMPLICIT_CONTEXT)
8128 /* pTHX_ magic can't cope with varargs, so this is a no-context
8129 * version of the main function, (which may itself be aliased to us).
8130 * Don't access this version directly.
8134 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8138 va_start(args, pat);
8139 sv_vsetpvf(sv, pat, &args);
8143 /* pTHX_ magic can't cope with varargs, so this is a no-context
8144 * version of the main function, (which may itself be aliased to us).
8145 * Don't access this version directly.
8149 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8153 va_start(args, pat);
8154 sv_vsetpvf_mg(sv, pat, &args);
8160 =for apidoc sv_setpvf
8162 Works like C<sv_catpvf> but copies the text into the SV instead of
8163 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8169 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8172 va_start(args, pat);
8173 sv_vsetpvf(sv, pat, &args);
8178 =for apidoc sv_vsetpvf
8180 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8181 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8183 Usually used via its frontend C<sv_setpvf>.
8189 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8191 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8195 =for apidoc sv_setpvf_mg
8197 Like C<sv_setpvf>, but also handles 'set' magic.
8203 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8206 va_start(args, pat);
8207 sv_vsetpvf_mg(sv, pat, &args);
8212 =for apidoc sv_vsetpvf_mg
8214 Like C<sv_vsetpvf>, but also handles 'set' magic.
8216 Usually used via its frontend C<sv_setpvf_mg>.
8222 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8224 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8228 #if defined(PERL_IMPLICIT_CONTEXT)
8230 /* pTHX_ magic can't cope with varargs, so this is a no-context
8231 * version of the main function, (which may itself be aliased to us).
8232 * Don't access this version directly.
8236 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8240 va_start(args, pat);
8241 sv_vcatpvf(sv, pat, &args);
8245 /* pTHX_ magic can't cope with varargs, so this is a no-context
8246 * version of the main function, (which may itself be aliased to us).
8247 * Don't access this version directly.
8251 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8255 va_start(args, pat);
8256 sv_vcatpvf_mg(sv, pat, &args);
8262 =for apidoc sv_catpvf
8264 Processes its arguments like C<sprintf> and appends the formatted
8265 output to an SV. If the appended data contains "wide" characters
8266 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8267 and characters >255 formatted with %c), the original SV might get
8268 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8269 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8270 valid UTF-8; if the original SV was bytes, the pattern should be too.
8275 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8278 va_start(args, pat);
8279 sv_vcatpvf(sv, pat, &args);
8284 =for apidoc sv_vcatpvf
8286 Processes its arguments like C<vsprintf> and appends the formatted output
8287 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8289 Usually used via its frontend C<sv_catpvf>.
8295 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8297 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8301 =for apidoc sv_catpvf_mg
8303 Like C<sv_catpvf>, but also handles 'set' magic.
8309 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8312 va_start(args, pat);
8313 sv_vcatpvf_mg(sv, pat, &args);
8318 =for apidoc sv_vcatpvf_mg
8320 Like C<sv_vcatpvf>, but also handles 'set' magic.
8322 Usually used via its frontend C<sv_catpvf_mg>.
8328 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8330 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8335 =for apidoc sv_vsetpvfn
8337 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8340 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8346 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8348 sv_setpvn(sv, "", 0);
8349 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8352 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8355 S_expect_number(pTHX_ char** pattern)
8358 switch (**pattern) {
8359 case '1': case '2': case '3':
8360 case '4': case '5': case '6':
8361 case '7': case '8': case '9':
8362 while (isDIGIT(**pattern))
8363 var = var * 10 + (*(*pattern)++ - '0');
8367 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
8370 F0convert(NV nv, char *endbuf, STRLEN *len)
8372 const int neg = nv < 0;
8381 if (uv & 1 && uv == nv)
8382 uv--; /* Round to even */
8384 const unsigned dig = uv % 10;
8397 =for apidoc sv_vcatpvfn
8399 Processes its arguments like C<vsprintf> and appends the formatted output
8400 to an SV. Uses an array of SVs if the C style variable argument list is
8401 missing (NULL). When running with taint checks enabled, indicates via
8402 C<maybe_tainted> if results are untrustworthy (often due to the use of
8405 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8411 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8412 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8413 vec_utf8 = DO_UTF8(vecsv);
8415 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8418 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8425 static const char nullstr[] = "(null)";
8427 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8428 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8430 /* Times 4: a decimal digit takes more than 3 binary digits.
8431 * NV_DIG: mantissa takes than many decimal digits.
8432 * Plus 32: Playing safe. */
8433 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8434 /* large enough for "%#.#f" --chip */
8435 /* what about long double NVs? --jhi */
8437 PERL_UNUSED_ARG(maybe_tainted);
8439 /* no matter what, this is a string now */
8440 (void)SvPV_force(sv, origlen);
8442 /* special-case "", "%s", and "%-p" (SVf - see below) */
8445 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8447 const char * const s = va_arg(*args, char*);
8448 sv_catpv(sv, s ? s : nullstr);
8450 else if (svix < svmax) {
8451 sv_catsv(sv, *svargs);
8452 if (DO_UTF8(*svargs))
8457 if (args && patlen == 3 && pat[0] == '%' &&
8458 pat[1] == '-' && pat[2] == 'p') {
8459 argsv = va_arg(*args, SV*);
8460 sv_catsv(sv, argsv);
8466 #ifndef USE_LONG_DOUBLE
8467 /* special-case "%.<number>[gf]" */
8468 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8469 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8470 unsigned digits = 0;
8474 while (*pp >= '0' && *pp <= '9')
8475 digits = 10 * digits + (*pp++ - '0');
8476 if (pp - pat == (int)patlen - 1) {
8484 /* Add check for digits != 0 because it seems that some
8485 gconverts are buggy in this case, and we don't yet have
8486 a Configure test for this. */
8487 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8488 /* 0, point, slack */
8489 Gconvert(nv, (int)digits, 0, ebuf);
8491 if (*ebuf) /* May return an empty string for digits==0 */
8494 } else if (!digits) {
8497 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8498 sv_catpvn(sv, p, l);
8504 #endif /* !USE_LONG_DOUBLE */
8506 if (!args && svix < svmax && DO_UTF8(*svargs))
8509 patend = (char*)pat + patlen;
8510 for (p = (char*)pat; p < patend; p = q) {
8513 bool vectorize = FALSE;
8514 bool vectorarg = FALSE;
8515 bool vec_utf8 = FALSE;
8521 bool has_precis = FALSE;
8524 bool is_utf8 = FALSE; /* is this item utf8? */
8525 #ifdef HAS_LDBL_SPRINTF_BUG
8526 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8527 with sfio - Allen <allens@cpan.org> */
8528 bool fix_ldbl_sprintf_bug = FALSE;
8532 U8 utf8buf[UTF8_MAXBYTES+1];
8533 STRLEN esignlen = 0;
8535 const char *eptr = Nullch;
8538 const U8 *vecstr = Null(U8*);
8545 /* we need a long double target in case HAS_LONG_DOUBLE but
8548 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8556 const char *dotstr = ".";
8557 STRLEN dotstrlen = 1;
8558 I32 efix = 0; /* explicit format parameter index */
8559 I32 ewix = 0; /* explicit width index */
8560 I32 epix = 0; /* explicit precision index */
8561 I32 evix = 0; /* explicit vector index */
8562 bool asterisk = FALSE;
8564 /* echo everything up to the next format specification */
8565 for (q = p; q < patend && *q != '%'; ++q) ;
8567 if (has_utf8 && !pat_utf8)
8568 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8570 sv_catpvn(sv, p, q - p);
8577 We allow format specification elements in this order:
8578 \d+\$ explicit format parameter index
8580 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8581 0 flag (as above): repeated to allow "v02"
8582 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8583 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8585 [%bcdefginopsuxDFOUX] format (mandatory)
8590 As of perl5.9.3, printf format checking is on by default.
8591 Internally, perl uses %p formats to provide an escape to
8592 some extended formatting. This block deals with those
8593 extensions: if it does not match, (char*)q is reset and
8594 the normal format processing code is used.
8596 Currently defined extensions are:
8597 %p include pointer address (standard)
8598 %-p (SVf) include an SV (previously %_)
8599 %-<num>p include an SV with precision <num>
8600 %1p (VDf) include a v-string (as %vd)
8601 %<num>p reserved for future extensions
8603 Robin Barker 2005-07-14
8610 EXPECT_NUMBER(q, n);
8617 argsv = va_arg(*args, SV*);
8618 eptr = SvPVx_const(argsv, elen);
8624 else if (n == vdNUMBER) { /* VDf */
8631 if (ckWARN_d(WARN_INTERNAL))
8632 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8633 "internal %%<num>p might conflict with future printf extensions");
8639 if (EXPECT_NUMBER(q, width)) {
8680 if (EXPECT_NUMBER(q, ewix))
8689 if ((vectorarg = asterisk)) {
8702 EXPECT_NUMBER(q, width);
8708 vecsv = va_arg(*args, SV*);
8710 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8711 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8712 dotstr = SvPV_const(vecsv, dotstrlen);
8719 else if (efix ? efix <= svmax : svix < svmax) {
8720 vecsv = svargs[efix ? efix-1 : svix++];
8721 vecstr = (U8*)SvPV_const(vecsv,veclen);
8722 vec_utf8 = DO_UTF8(vecsv);
8723 /* if this is a version object, we need to return the
8724 * stringified representation (which the SvPVX_const has
8725 * already done for us), but not vectorize the args
8727 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8729 q++; /* skip past the rest of the %vd format */
8730 eptr = (const char *) vecstr;
8731 elen = strlen(eptr);
8744 i = va_arg(*args, int);
8746 i = (ewix ? ewix <= svmax : svix < svmax) ?
8747 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8749 width = (i < 0) ? -i : i;
8759 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8761 /* XXX: todo, support specified precision parameter */
8765 i = va_arg(*args, int);
8767 i = (ewix ? ewix <= svmax : svix < svmax)
8768 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8769 precis = (i < 0) ? 0 : i;
8774 precis = precis * 10 + (*q++ - '0');
8783 case 'I': /* Ix, I32x, and I64x */
8785 if (q[1] == '6' && q[2] == '4') {
8791 if (q[1] == '3' && q[2] == '2') {
8801 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8812 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8813 if (*(q + 1) == 'l') { /* lld, llf */
8838 argsv = (efix ? efix <= svmax : svix < svmax) ?
8839 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8846 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8848 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8850 eptr = (char*)utf8buf;
8851 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8862 if (args && !vectorize) {
8863 eptr = va_arg(*args, char*);
8865 #ifdef MACOS_TRADITIONAL
8866 /* On MacOS, %#s format is used for Pascal strings */
8871 elen = strlen(eptr);
8873 eptr = (char *)nullstr;
8874 elen = sizeof nullstr - 1;
8878 eptr = SvPVx_const(argsv, elen);
8879 if (DO_UTF8(argsv)) {
8880 if (has_precis && precis < elen) {
8882 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8885 if (width) { /* fudge width (can't fudge elen) */
8886 width += elen - sv_len_utf8(argsv);
8894 if (has_precis && elen > precis)
8901 if (alt || vectorize)
8903 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8924 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8933 esignbuf[esignlen++] = plus;
8937 case 'h': iv = (short)va_arg(*args, int); break;
8938 case 'l': iv = va_arg(*args, long); break;
8939 case 'V': iv = va_arg(*args, IV); break;
8940 default: iv = va_arg(*args, int); break;
8942 case 'q': iv = va_arg(*args, Quad_t); break;
8947 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8949 case 'h': iv = (short)tiv; break;
8950 case 'l': iv = (long)tiv; break;
8952 default: iv = tiv; break;
8954 case 'q': iv = (Quad_t)tiv; break;
8958 if ( !vectorize ) /* we already set uv above */
8963 esignbuf[esignlen++] = plus;
8967 esignbuf[esignlen++] = '-';
9010 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9021 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9022 case 'l': uv = va_arg(*args, unsigned long); break;
9023 case 'V': uv = va_arg(*args, UV); break;
9024 default: uv = va_arg(*args, unsigned); break;
9026 case 'q': uv = va_arg(*args, Uquad_t); break;
9031 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9033 case 'h': uv = (unsigned short)tuv; break;
9034 case 'l': uv = (unsigned long)tuv; break;
9036 default: uv = tuv; break;
9038 case 'q': uv = (Uquad_t)tuv; break;
9045 char *ptr = ebuf + sizeof ebuf;
9051 p = (char*)((c == 'X')
9052 ? "0123456789ABCDEF" : "0123456789abcdef");
9058 esignbuf[esignlen++] = '0';
9059 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9067 if (alt && *ptr != '0')
9076 esignbuf[esignlen++] = '0';
9077 esignbuf[esignlen++] = 'b';
9080 default: /* it had better be ten or less */
9084 } while (uv /= base);
9087 elen = (ebuf + sizeof ebuf) - ptr;
9091 zeros = precis - elen;
9092 else if (precis == 0 && elen == 1 && *eptr == '0')
9098 /* FLOATING POINT */
9101 c = 'f'; /* maybe %F isn't supported here */
9107 /* This is evil, but floating point is even more evil */
9109 /* for SV-style calling, we can only get NV
9110 for C-style calling, we assume %f is double;
9111 for simplicity we allow any of %Lf, %llf, %qf for long double
9115 #if defined(USE_LONG_DOUBLE)
9119 /* [perl #20339] - we should accept and ignore %lf rather than die */
9123 #if defined(USE_LONG_DOUBLE)
9124 intsize = args ? 0 : 'q';
9128 #if defined(HAS_LONG_DOUBLE)
9137 /* now we need (long double) if intsize == 'q', else (double) */
9138 nv = (args && !vectorize) ?
9139 #if LONG_DOUBLESIZE > DOUBLESIZE
9141 va_arg(*args, long double) :
9142 va_arg(*args, double)
9144 va_arg(*args, double)
9150 if (c != 'e' && c != 'E') {
9152 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9153 will cast our (long double) to (double) */
9154 (void)Perl_frexp(nv, &i);
9155 if (i == PERL_INT_MIN)
9156 Perl_die(aTHX_ "panic: frexp");
9158 need = BIT_DIGITS(i);
9160 need += has_precis ? precis : 6; /* known default */
9165 #ifdef HAS_LDBL_SPRINTF_BUG
9166 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9167 with sfio - Allen <allens@cpan.org> */
9170 # define MY_DBL_MAX DBL_MAX
9171 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9172 # if DOUBLESIZE >= 8
9173 # define MY_DBL_MAX 1.7976931348623157E+308L
9175 # define MY_DBL_MAX 3.40282347E+38L
9179 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9180 # define MY_DBL_MAX_BUG 1L
9182 # define MY_DBL_MAX_BUG MY_DBL_MAX
9186 # define MY_DBL_MIN DBL_MIN
9187 # else /* XXX guessing! -Allen */
9188 # if DOUBLESIZE >= 8
9189 # define MY_DBL_MIN 2.2250738585072014E-308L
9191 # define MY_DBL_MIN 1.17549435E-38L
9195 if ((intsize == 'q') && (c == 'f') &&
9196 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9198 /* it's going to be short enough that
9199 * long double precision is not needed */
9201 if ((nv <= 0L) && (nv >= -0L))
9202 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9204 /* would use Perl_fp_class as a double-check but not
9205 * functional on IRIX - see perl.h comments */
9207 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9208 /* It's within the range that a double can represent */
9209 #if defined(DBL_MAX) && !defined(DBL_MIN)
9210 if ((nv >= ((long double)1/DBL_MAX)) ||
9211 (nv <= (-(long double)1/DBL_MAX)))
9213 fix_ldbl_sprintf_bug = TRUE;
9216 if (fix_ldbl_sprintf_bug == TRUE) {
9226 # undef MY_DBL_MAX_BUG
9229 #endif /* HAS_LDBL_SPRINTF_BUG */
9231 need += 20; /* fudge factor */
9232 if (PL_efloatsize < need) {
9233 Safefree(PL_efloatbuf);
9234 PL_efloatsize = need + 20; /* more fudge */
9235 Newx(PL_efloatbuf, PL_efloatsize, char);
9236 PL_efloatbuf[0] = '\0';
9239 if ( !(width || left || plus || alt) && fill != '0'
9240 && has_precis && intsize != 'q' ) { /* Shortcuts */
9241 /* See earlier comment about buggy Gconvert when digits,
9243 if ( c == 'g' && precis) {
9244 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9245 /* May return an empty string for digits==0 */
9246 if (*PL_efloatbuf) {
9247 elen = strlen(PL_efloatbuf);
9248 goto float_converted;
9250 } else if ( c == 'f' && !precis) {
9251 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9256 char *ptr = ebuf + sizeof ebuf;
9259 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9260 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9261 if (intsize == 'q') {
9262 /* Copy the one or more characters in a long double
9263 * format before the 'base' ([efgEFG]) character to
9264 * the format string. */
9265 static char const prifldbl[] = PERL_PRIfldbl;
9266 char const *p = prifldbl + sizeof(prifldbl) - 3;
9267 while (p >= prifldbl) { *--ptr = *p--; }
9272 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9277 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9289 /* No taint. Otherwise we are in the strange situation
9290 * where printf() taints but print($float) doesn't.
9292 #if defined(HAS_LONG_DOUBLE)
9293 elen = ((intsize == 'q')
9294 ? my_sprintf(PL_efloatbuf, ptr, nv)
9295 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9297 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9301 eptr = PL_efloatbuf;
9307 i = SvCUR(sv) - origlen;
9308 if (args && !vectorize) {
9310 case 'h': *(va_arg(*args, short*)) = i; break;
9311 default: *(va_arg(*args, int*)) = i; break;
9312 case 'l': *(va_arg(*args, long*)) = i; break;
9313 case 'V': *(va_arg(*args, IV*)) = i; break;
9315 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9320 sv_setuv_mg(argsv, (UV)i);
9322 continue; /* not "break" */
9329 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9330 && ckWARN(WARN_PRINTF))
9332 SV * const msg = sv_newmortal();
9333 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9334 (PL_op->op_type == OP_PRTF) ? "" : "s");
9337 Perl_sv_catpvf(aTHX_ msg,
9338 "\"%%%c\"", c & 0xFF);
9340 Perl_sv_catpvf(aTHX_ msg,
9341 "\"%%\\%03"UVof"\"",
9344 sv_catpv(msg, "end of string");
9345 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9348 /* output mangled stuff ... */
9354 /* ... right here, because formatting flags should not apply */
9355 SvGROW(sv, SvCUR(sv) + elen + 1);
9357 Copy(eptr, p, elen, char);
9360 SvCUR_set(sv, p - SvPVX_const(sv));
9362 continue; /* not "break" */
9365 /* calculate width before utf8_upgrade changes it */
9366 have = esignlen + zeros + elen;
9368 if (is_utf8 != has_utf8) {
9371 sv_utf8_upgrade(sv);
9374 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9375 sv_utf8_upgrade(nsv);
9376 eptr = SvPVX_const(nsv);
9379 SvGROW(sv, SvCUR(sv) + elen + 1);
9384 need = (have > width ? have : width);
9387 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9389 if (esignlen && fill == '0') {
9391 for (i = 0; i < (int)esignlen; i++)
9395 memset(p, fill, gap);
9398 if (esignlen && fill != '0') {
9400 for (i = 0; i < (int)esignlen; i++)
9405 for (i = zeros; i; i--)
9409 Copy(eptr, p, elen, char);
9413 memset(p, ' ', gap);
9418 Copy(dotstr, p, dotstrlen, char);
9422 vectorize = FALSE; /* done iterating over vecstr */
9429 SvCUR_set(sv, p - SvPVX_const(sv));
9437 /* =========================================================================
9439 =head1 Cloning an interpreter
9441 All the macros and functions in this section are for the private use of
9442 the main function, perl_clone().
9444 The foo_dup() functions make an exact copy of an existing foo thinngy.
9445 During the course of a cloning, a hash table is used to map old addresses
9446 to new addresses. The table is created and manipulated with the
9447 ptr_table_* functions.
9451 ============================================================================*/
9454 #if defined(USE_ITHREADS)
9456 #ifndef GpREFCNT_inc
9457 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9461 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9462 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9463 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9465 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9466 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9467 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9468 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9469 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9470 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9471 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9472 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9473 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9476 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9477 regcomp.c. AMS 20010712 */
9480 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9485 struct reg_substr_datum *s;
9488 return (REGEXP *)NULL;
9490 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9493 len = r->offsets[0];
9494 npar = r->nparens+1;
9496 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9497 Copy(r->program, ret->program, len+1, regnode);
9499 Newx(ret->startp, npar, I32);
9500 Copy(r->startp, ret->startp, npar, I32);
9501 Newx(ret->endp, npar, I32);
9502 Copy(r->startp, ret->startp, npar, I32);
9504 Newx(ret->substrs, 1, struct reg_substr_data);
9505 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9506 s->min_offset = r->substrs->data[i].min_offset;
9507 s->max_offset = r->substrs->data[i].max_offset;
9508 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9509 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9512 ret->regstclass = NULL;
9515 const int count = r->data->count;
9518 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9519 char, struct reg_data);
9520 Newx(d->what, count, U8);
9523 for (i = 0; i < count; i++) {
9524 d->what[i] = r->data->what[i];
9525 switch (d->what[i]) {
9526 /* legal options are one of: sfpont
9527 see also regcomp.h and pregfree() */
9529 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9532 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9535 /* This is cheating. */
9536 Newx(d->data[i], 1, struct regnode_charclass_class);
9537 StructCopy(r->data->data[i], d->data[i],
9538 struct regnode_charclass_class);
9539 ret->regstclass = (regnode*)d->data[i];
9542 /* Compiled op trees are readonly, and can thus be
9543 shared without duplication. */
9545 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9549 d->data[i] = r->data->data[i];
9552 d->data[i] = r->data->data[i];
9554 ((reg_trie_data*)d->data[i])->refcount++;
9558 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9567 Newx(ret->offsets, 2*len+1, U32);
9568 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9570 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9571 ret->refcnt = r->refcnt;
9572 ret->minlen = r->minlen;
9573 ret->prelen = r->prelen;
9574 ret->nparens = r->nparens;
9575 ret->lastparen = r->lastparen;
9576 ret->lastcloseparen = r->lastcloseparen;
9577 ret->reganch = r->reganch;
9579 ret->sublen = r->sublen;
9581 if (RX_MATCH_COPIED(ret))
9582 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9584 ret->subbeg = Nullch;
9585 #ifdef PERL_OLD_COPY_ON_WRITE
9586 ret->saved_copy = Nullsv;
9589 ptr_table_store(PL_ptr_table, r, ret);
9593 /* duplicate a file handle */
9596 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9600 PERL_UNUSED_ARG(type);
9603 return (PerlIO*)NULL;
9605 /* look for it in the table first */
9606 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9610 /* create anew and remember what it is */
9611 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9612 ptr_table_store(PL_ptr_table, fp, ret);
9616 /* duplicate a directory handle */
9619 Perl_dirp_dup(pTHX_ DIR *dp)
9627 /* duplicate a typeglob */
9630 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9635 /* look for it in the table first */
9636 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9640 /* create anew and remember what it is */
9642 ptr_table_store(PL_ptr_table, gp, ret);
9645 ret->gp_refcnt = 0; /* must be before any other dups! */
9646 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9647 ret->gp_io = io_dup_inc(gp->gp_io, param);
9648 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9649 ret->gp_av = av_dup_inc(gp->gp_av, param);
9650 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9651 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9652 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9653 ret->gp_cvgen = gp->gp_cvgen;
9654 ret->gp_line = gp->gp_line;
9655 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9659 /* duplicate a chain of magic */
9662 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9664 MAGIC *mgprev = (MAGIC*)NULL;
9667 return (MAGIC*)NULL;
9668 /* look for it in the table first */
9669 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9673 for (; mg; mg = mg->mg_moremagic) {
9675 Newxz(nmg, 1, MAGIC);
9677 mgprev->mg_moremagic = nmg;
9680 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9681 nmg->mg_private = mg->mg_private;
9682 nmg->mg_type = mg->mg_type;
9683 nmg->mg_flags = mg->mg_flags;
9684 if (mg->mg_type == PERL_MAGIC_qr) {
9685 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9687 else if(mg->mg_type == PERL_MAGIC_backref) {
9688 const AV * const av = (AV*) mg->mg_obj;
9691 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9693 for (i = AvFILLp(av); i >= 0; i--) {
9694 if (!svp[i]) continue;
9695 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9698 else if (mg->mg_type == PERL_MAGIC_symtab) {
9699 nmg->mg_obj = mg->mg_obj;
9702 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9703 ? sv_dup_inc(mg->mg_obj, param)
9704 : sv_dup(mg->mg_obj, param);
9706 nmg->mg_len = mg->mg_len;
9707 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9708 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9709 if (mg->mg_len > 0) {
9710 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9711 if (mg->mg_type == PERL_MAGIC_overload_table &&
9712 AMT_AMAGIC((AMT*)mg->mg_ptr))
9714 AMT *amtp = (AMT*)mg->mg_ptr;
9715 AMT *namtp = (AMT*)nmg->mg_ptr;
9717 for (i = 1; i < NofAMmeth; i++) {
9718 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9722 else if (mg->mg_len == HEf_SVKEY)
9723 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9725 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9726 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9733 /* create a new pointer-mapping table */
9736 Perl_ptr_table_new(pTHX)
9739 Newxz(tbl, 1, PTR_TBL_t);
9742 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9747 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9749 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9752 #define del_pte(p) del_body_type(p, struct ptr_tbl_ent, pte)
9754 /* map an existing pointer using a table */
9757 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9759 PTR_TBL_ENT_t *tblent;
9760 const UV hash = PTR_TABLE_HASH(sv);
9762 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9763 for (; tblent; tblent = tblent->next) {
9764 if (tblent->oldval == sv)
9765 return tblent->newval;
9770 /* add a new entry to a pointer-mapping table */
9773 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9775 PTR_TBL_ENT_t *tblent, **otblent;
9776 /* XXX this may be pessimal on platforms where pointers aren't good
9777 * hash values e.g. if they grow faster in the most significant
9779 const UV hash = PTR_TABLE_HASH(oldsv);
9783 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9784 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9785 if (tblent->oldval == oldsv) {
9786 tblent->newval = newsv;
9790 new_body_inline(tblent, (void**)&PL_pte_arenaroot, (void**)&PL_pte_root,
9791 sizeof(struct ptr_tbl_ent));
9792 tblent->oldval = oldsv;
9793 tblent->newval = newsv;
9794 tblent->next = *otblent;
9797 if (!empty && tbl->tbl_items > tbl->tbl_max)
9798 ptr_table_split(tbl);
9801 /* double the hash bucket size of an existing ptr table */
9804 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9806 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9807 const UV oldsize = tbl->tbl_max + 1;
9808 UV newsize = oldsize * 2;
9811 Renew(ary, newsize, PTR_TBL_ENT_t*);
9812 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9813 tbl->tbl_max = --newsize;
9815 for (i=0; i < oldsize; i++, ary++) {
9816 PTR_TBL_ENT_t **curentp, **entp, *ent;
9819 curentp = ary + oldsize;
9820 for (entp = ary, ent = *ary; ent; ent = *entp) {
9821 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9823 ent->next = *curentp;
9833 /* remove all the entries from a ptr table */
9836 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9838 register PTR_TBL_ENT_t **array;
9839 register PTR_TBL_ENT_t *entry;
9843 if (!tbl || !tbl->tbl_items) {
9847 array = tbl->tbl_ary;
9853 PTR_TBL_ENT_t *oentry = entry;
9854 entry = entry->next;
9858 if (++riter > max) {
9861 entry = array[riter];
9868 /* clear and free a ptr table */
9871 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9876 ptr_table_clear(tbl);
9877 Safefree(tbl->tbl_ary);
9883 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9886 SvRV_set(dstr, SvWEAKREF(sstr)
9887 ? sv_dup(SvRV(sstr), param)
9888 : sv_dup_inc(SvRV(sstr), param));
9891 else if (SvPVX_const(sstr)) {
9892 /* Has something there */
9894 /* Normal PV - clone whole allocated space */
9895 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9896 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9897 /* Not that normal - actually sstr is copy on write.
9898 But we are a true, independant SV, so: */
9899 SvREADONLY_off(dstr);
9904 /* Special case - not normally malloced for some reason */
9905 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9906 /* A "shared" PV - clone it as "shared" PV */
9908 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9912 /* Some other special case - random pointer */
9913 SvPV_set(dstr, SvPVX(sstr));
9919 if (SvTYPE(dstr) == SVt_RV)
9920 SvRV_set(dstr, NULL);
9926 /* duplicate an SV of any type (including AV, HV etc) */
9929 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9934 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9936 /* look for it in the table first */
9937 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9941 if(param->flags & CLONEf_JOIN_IN) {
9942 /** We are joining here so we don't want do clone
9943 something that is bad **/
9946 if(SvTYPE(sstr) == SVt_PVHV &&
9947 (hvname = HvNAME_get(sstr))) {
9948 /** don't clone stashes if they already exist **/
9949 return (SV*)gv_stashpv(hvname,0);
9953 /* create anew and remember what it is */
9956 #ifdef DEBUG_LEAKING_SCALARS
9957 dstr->sv_debug_optype = sstr->sv_debug_optype;
9958 dstr->sv_debug_line = sstr->sv_debug_line;
9959 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9960 dstr->sv_debug_cloned = 1;
9962 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9964 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9968 ptr_table_store(PL_ptr_table, sstr, dstr);
9971 SvFLAGS(dstr) = SvFLAGS(sstr);
9972 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9973 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9976 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9977 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9978 PL_watch_pvx, SvPVX_const(sstr));
9981 /* don't clone objects whose class has asked us not to */
9982 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9983 SvFLAGS(dstr) &= ~SVTYPEMASK;
9988 switch (SvTYPE(sstr)) {
9993 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9994 SvIV_set(dstr, SvIVX(sstr));
9997 SvANY(dstr) = new_XNV();
9998 SvNV_set(dstr, SvNVX(sstr));
10001 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10002 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10006 /* These are all the types that need complex bodies allocating. */
10007 size_t new_body_length;
10008 size_t new_body_offset = 0;
10009 void **new_body_arena;
10010 void **new_body_arenaroot;
10013 switch (SvTYPE(sstr)) {
10015 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
10020 new_body = new_XPVIO();
10021 new_body_length = sizeof(XPVIO);
10024 new_body = new_XPVFM();
10025 new_body_length = sizeof(XPVFM);
10029 new_body_arena = (void **) &PL_xpvhv_root;
10030 new_body_arenaroot = (void **) &PL_xpvhv_arenaroot;
10031 new_body_offset = STRUCT_OFFSET(XPVHV, xhv_fill)
10032 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill);
10033 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10034 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10038 new_body_arena = (void **) &PL_xpvav_root;
10039 new_body_arenaroot = (void **) &PL_xpvav_arenaroot;
10040 new_body_offset = STRUCT_OFFSET(XPVAV, xav_fill)
10041 - STRUCT_OFFSET(xpvav_allocated, xav_fill);
10042 new_body_length = STRUCT_OFFSET(XPVHV, xmg_stash)
10043 + sizeof (((XPVHV*)SvANY(sstr))->xmg_stash)
10047 new_body_length = sizeof(XPVBM);
10048 new_body_arena = (void **) &PL_xpvbm_root;
10049 new_body_arenaroot = (void **) &PL_xpvbm_arenaroot;
10052 if (GvUNIQUE((GV*)sstr)) {
10053 /* Do sharing here. */
10055 new_body_length = sizeof(XPVGV);
10056 new_body_arena = (void **) &PL_xpvgv_root;
10057 new_body_arenaroot = (void **) &PL_xpvgv_arenaroot;
10060 new_body_length = sizeof(XPVCV);
10061 new_body_arena = (void **) &PL_xpvcv_root;
10062 new_body_arenaroot = (void **) &PL_xpvcv_arenaroot;
10065 new_body_length = sizeof(XPVLV);
10066 new_body_arena = (void **) &PL_xpvlv_root;
10067 new_body_arenaroot = (void **) &PL_xpvlv_arenaroot;
10070 new_body_length = sizeof(XPVMG);
10071 new_body_arena = (void **) &PL_xpvmg_root;
10072 new_body_arenaroot = (void **) &PL_xpvmg_arenaroot;
10075 new_body_length = sizeof(XPVNV);
10076 new_body_arena = (void **) &PL_xpvnv_root;
10077 new_body_arenaroot = (void **) &PL_xpvnv_arenaroot;
10080 new_body_offset = STRUCT_OFFSET(XPVIV, xpv_cur)
10081 - STRUCT_OFFSET(xpviv_allocated, xpv_cur);
10082 new_body_length = sizeof(XPVIV) - new_body_offset;
10083 new_body_arena = (void **) &PL_xpviv_root;
10084 new_body_arenaroot = (void **) &PL_xpviv_arenaroot;
10087 new_body_offset = STRUCT_OFFSET(XPV, xpv_cur)
10088 - STRUCT_OFFSET(xpv_allocated, xpv_cur);
10089 new_body_length = sizeof(XPV) - new_body_offset;
10090 new_body_arena = (void **) &PL_xpv_root;
10091 new_body_arenaroot = (void **) &PL_xpv_arenaroot;
10093 assert(new_body_length);
10095 new_body_inline(new_body, new_body_arenaroot, new_body_arena,
10097 new_body = (void*)((char*)new_body - new_body_offset);
10099 /* We always allocated the full length item with PURIFY */
10100 new_body_length += new_body_offset;
10101 new_body_offset = 0;
10102 new_body = my_safemalloc(new_body_length);
10106 SvANY(dstr) = new_body;
10108 Copy(((char*)SvANY(sstr)) + new_body_offset,
10109 ((char*)SvANY(dstr)) + new_body_offset,
10110 new_body_length, char);
10112 if (SvTYPE(sstr) != SVt_PVAV && SvTYPE(sstr) != SVt_PVHV)
10113 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10115 /* The Copy above means that all the source (unduplicated) pointers
10116 are now in the destination. We can check the flags and the
10117 pointers in either, but it's possible that there's less cache
10118 missing by always going for the destination.
10119 FIXME - instrument and check that assumption */
10120 if (SvTYPE(sstr) >= SVt_PVMG) {
10122 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10124 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10127 switch (SvTYPE(sstr)) {
10139 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10140 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10141 LvTARG(dstr) = dstr;
10142 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10143 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10145 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10148 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
10149 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10150 /* Don't call sv_add_backref here as it's going to be created
10151 as part of the magic cloning of the symbol table. */
10152 GvGP(dstr) = gp_dup(GvGP(dstr), param);
10153 (void)GpREFCNT_inc(GvGP(dstr));
10156 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10157 if (IoOFP(dstr) == IoIFP(sstr))
10158 IoOFP(dstr) = IoIFP(dstr);
10160 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10161 /* PL_rsfp_filters entries have fake IoDIRP() */
10162 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
10163 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10164 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10165 /* I have no idea why fake dirp (rsfps)
10166 should be treated differently but otherwise
10167 we end up with leaks -- sky*/
10168 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10169 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10170 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10172 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10173 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10174 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10176 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10177 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10178 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10181 if (AvARRAY((AV*)sstr)) {
10182 SV **dst_ary, **src_ary;
10183 SSize_t items = AvFILLp((AV*)sstr) + 1;
10185 src_ary = AvARRAY((AV*)sstr);
10186 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10187 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10188 SvPV_set(dstr, (char*)dst_ary);
10189 AvALLOC((AV*)dstr) = dst_ary;
10190 if (AvREAL((AV*)sstr)) {
10191 while (items-- > 0)
10192 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10195 while (items-- > 0)
10196 *dst_ary++ = sv_dup(*src_ary++, param);
10198 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10199 while (items-- > 0) {
10200 *dst_ary++ = &PL_sv_undef;
10204 SvPV_set(dstr, Nullch);
10205 AvALLOC((AV*)dstr) = (SV**)NULL;
10212 if (HvARRAY((HV*)sstr)) {
10214 const bool sharekeys = !!HvSHAREKEYS(sstr);
10215 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10216 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10218 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10219 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10221 HvARRAY(dstr) = (HE**)darray;
10222 while (i <= sxhv->xhv_max) {
10223 const HE *source = HvARRAY(sstr)[i];
10224 HvARRAY(dstr)[i] = source
10225 ? he_dup(source, sharekeys, param) : 0;
10229 struct xpvhv_aux *saux = HvAUX(sstr);
10230 struct xpvhv_aux *daux = HvAUX(dstr);
10231 /* This flag isn't copied. */
10232 /* SvOOK_on(hv) attacks the IV flags. */
10233 SvFLAGS(dstr) |= SVf_OOK;
10235 hvname = saux->xhv_name;
10237 = hvname ? hek_dup(hvname, param) : hvname;
10239 daux->xhv_riter = saux->xhv_riter;
10240 daux->xhv_eiter = saux->xhv_eiter
10241 ? he_dup(saux->xhv_eiter,
10242 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10246 SvPV_set(dstr, Nullch);
10248 /* Record stashes for possible cloning in Perl_clone(). */
10250 av_push(param->stashes, dstr);
10255 /* NOTE: not refcounted */
10256 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10258 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10260 if (CvCONST(dstr)) {
10261 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10262 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10263 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10265 /* don't dup if copying back - CvGV isn't refcounted, so the
10266 * duped GV may never be freed. A bit of a hack! DAPM */
10267 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10268 Nullgv : gv_dup(CvGV(dstr), param) ;
10269 if (!(param->flags & CLONEf_COPY_STACKS)) {
10272 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10274 CvWEAKOUTSIDE(sstr)
10275 ? cv_dup( CvOUTSIDE(dstr), param)
10276 : cv_dup_inc(CvOUTSIDE(dstr), param);
10278 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10284 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10290 /* duplicate a context */
10293 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10295 PERL_CONTEXT *ncxs;
10298 return (PERL_CONTEXT*)NULL;
10300 /* look for it in the table first */
10301 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10305 /* create anew and remember what it is */
10306 Newxz(ncxs, max + 1, PERL_CONTEXT);
10307 ptr_table_store(PL_ptr_table, cxs, ncxs);
10310 PERL_CONTEXT *cx = &cxs[ix];
10311 PERL_CONTEXT *ncx = &ncxs[ix];
10312 ncx->cx_type = cx->cx_type;
10313 if (CxTYPE(cx) == CXt_SUBST) {
10314 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10317 ncx->blk_oldsp = cx->blk_oldsp;
10318 ncx->blk_oldcop = cx->blk_oldcop;
10319 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10320 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10321 ncx->blk_oldpm = cx->blk_oldpm;
10322 ncx->blk_gimme = cx->blk_gimme;
10323 switch (CxTYPE(cx)) {
10325 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10326 ? cv_dup_inc(cx->blk_sub.cv, param)
10327 : cv_dup(cx->blk_sub.cv,param));
10328 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10329 ? av_dup_inc(cx->blk_sub.argarray, param)
10331 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10332 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10333 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10334 ncx->blk_sub.lval = cx->blk_sub.lval;
10335 ncx->blk_sub.retop = cx->blk_sub.retop;
10338 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10339 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10340 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10341 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10342 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10343 ncx->blk_eval.retop = cx->blk_eval.retop;
10346 ncx->blk_loop.label = cx->blk_loop.label;
10347 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10348 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10349 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10350 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10351 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10352 ? cx->blk_loop.iterdata
10353 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10354 ncx->blk_loop.oldcomppad
10355 = (PAD*)ptr_table_fetch(PL_ptr_table,
10356 cx->blk_loop.oldcomppad);
10357 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10358 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10359 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10360 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10361 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10364 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10365 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10366 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10367 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10368 ncx->blk_sub.retop = cx->blk_sub.retop;
10380 /* duplicate a stack info structure */
10383 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10388 return (PERL_SI*)NULL;
10390 /* look for it in the table first */
10391 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10395 /* create anew and remember what it is */
10396 Newxz(nsi, 1, PERL_SI);
10397 ptr_table_store(PL_ptr_table, si, nsi);
10399 nsi->si_stack = av_dup_inc(si->si_stack, param);
10400 nsi->si_cxix = si->si_cxix;
10401 nsi->si_cxmax = si->si_cxmax;
10402 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10403 nsi->si_type = si->si_type;
10404 nsi->si_prev = si_dup(si->si_prev, param);
10405 nsi->si_next = si_dup(si->si_next, param);
10406 nsi->si_markoff = si->si_markoff;
10411 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10412 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10413 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10414 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10415 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10416 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10417 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10418 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10419 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10420 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10421 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10422 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10423 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10424 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10427 #define pv_dup_inc(p) SAVEPV(p)
10428 #define pv_dup(p) SAVEPV(p)
10429 #define svp_dup_inc(p,pp) any_dup(p,pp)
10431 /* map any object to the new equivent - either something in the
10432 * ptr table, or something in the interpreter structure
10436 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10441 return (void*)NULL;
10443 /* look for it in the table first */
10444 ret = ptr_table_fetch(PL_ptr_table, v);
10448 /* see if it is part of the interpreter structure */
10449 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10450 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10458 /* duplicate the save stack */
10461 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10463 ANY * const ss = proto_perl->Tsavestack;
10464 const I32 max = proto_perl->Tsavestack_max;
10465 I32 ix = proto_perl->Tsavestack_ix;
10477 void (*dptr) (void*);
10478 void (*dxptr) (pTHX_ void*);
10480 Newxz(nss, max, ANY);
10483 I32 i = POPINT(ss,ix);
10484 TOPINT(nss,ix) = i;
10486 case SAVEt_ITEM: /* normal string */
10487 sv = (SV*)POPPTR(ss,ix);
10488 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10489 sv = (SV*)POPPTR(ss,ix);
10490 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10492 case SAVEt_SV: /* scalar reference */
10493 sv = (SV*)POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10495 gv = (GV*)POPPTR(ss,ix);
10496 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10498 case SAVEt_GENERIC_PVREF: /* generic char* */
10499 c = (char*)POPPTR(ss,ix);
10500 TOPPTR(nss,ix) = pv_dup(c);
10501 ptr = POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10504 case SAVEt_SHARED_PVREF: /* char* in shared space */
10505 c = (char*)POPPTR(ss,ix);
10506 TOPPTR(nss,ix) = savesharedpv(c);
10507 ptr = POPPTR(ss,ix);
10508 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10510 case SAVEt_GENERIC_SVREF: /* generic sv */
10511 case SAVEt_SVREF: /* scalar reference */
10512 sv = (SV*)POPPTR(ss,ix);
10513 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10514 ptr = POPPTR(ss,ix);
10515 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10517 case SAVEt_AV: /* array reference */
10518 av = (AV*)POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = av_dup_inc(av, param);
10520 gv = (GV*)POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = gv_dup(gv, param);
10523 case SAVEt_HV: /* hash reference */
10524 hv = (HV*)POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10526 gv = (GV*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = gv_dup(gv, param);
10529 case SAVEt_INT: /* int reference */
10530 ptr = POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10532 intval = (int)POPINT(ss,ix);
10533 TOPINT(nss,ix) = intval;
10535 case SAVEt_LONG: /* long reference */
10536 ptr = POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10538 longval = (long)POPLONG(ss,ix);
10539 TOPLONG(nss,ix) = longval;
10541 case SAVEt_I32: /* I32 reference */
10542 case SAVEt_I16: /* I16 reference */
10543 case SAVEt_I8: /* I8 reference */
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10547 TOPINT(nss,ix) = i;
10549 case SAVEt_IV: /* IV reference */
10550 ptr = POPPTR(ss,ix);
10551 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10553 TOPIV(nss,ix) = iv;
10555 case SAVEt_SPTR: /* SV* reference */
10556 ptr = POPPTR(ss,ix);
10557 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10558 sv = (SV*)POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = sv_dup(sv, param);
10561 case SAVEt_VPTR: /* random* reference */
10562 ptr = POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10564 ptr = POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10567 case SAVEt_PPTR: /* char* reference */
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10570 c = (char*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = pv_dup(c);
10573 case SAVEt_HPTR: /* HV* reference */
10574 ptr = POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10576 hv = (HV*)POPPTR(ss,ix);
10577 TOPPTR(nss,ix) = hv_dup(hv, param);
10579 case SAVEt_APTR: /* AV* reference */
10580 ptr = POPPTR(ss,ix);
10581 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10582 av = (AV*)POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = av_dup(av, param);
10586 gv = (GV*)POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = gv_dup(gv, param);
10589 case SAVEt_GP: /* scalar reference */
10590 gp = (GP*)POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10592 (void)GpREFCNT_inc(gp);
10593 gv = (GV*)POPPTR(ss,ix);
10594 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10595 c = (char*)POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = pv_dup(c);
10598 TOPIV(nss,ix) = iv;
10600 TOPIV(nss,ix) = iv;
10603 case SAVEt_MORTALIZESV:
10604 sv = (SV*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10608 ptr = POPPTR(ss,ix);
10609 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10610 /* these are assumed to be refcounted properly */
10612 switch (((OP*)ptr)->op_type) {
10614 case OP_LEAVESUBLV:
10618 case OP_LEAVEWRITE:
10619 TOPPTR(nss,ix) = ptr;
10624 TOPPTR(nss,ix) = Nullop;
10629 TOPPTR(nss,ix) = Nullop;
10632 c = (char*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = pv_dup_inc(c);
10635 case SAVEt_CLEARSV:
10636 longval = POPLONG(ss,ix);
10637 TOPLONG(nss,ix) = longval;
10640 hv = (HV*)POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10642 c = (char*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = pv_dup_inc(c);
10645 TOPINT(nss,ix) = i;
10647 case SAVEt_DESTRUCTOR:
10648 ptr = POPPTR(ss,ix);
10649 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10650 dptr = POPDPTR(ss,ix);
10651 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10652 any_dup(FPTR2DPTR(void *, dptr),
10655 case SAVEt_DESTRUCTOR_X:
10656 ptr = POPPTR(ss,ix);
10657 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10658 dxptr = POPDXPTR(ss,ix);
10659 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10660 any_dup(FPTR2DPTR(void *, dxptr),
10663 case SAVEt_REGCONTEXT:
10666 TOPINT(nss,ix) = i;
10669 case SAVEt_STACK_POS: /* Position on Perl stack */
10671 TOPINT(nss,ix) = i;
10673 case SAVEt_AELEM: /* array element */
10674 sv = (SV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10677 TOPINT(nss,ix) = i;
10678 av = (AV*)POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = av_dup_inc(av, param);
10681 case SAVEt_HELEM: /* hash element */
10682 sv = (SV*)POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10684 sv = (SV*)POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10686 hv = (HV*)POPPTR(ss,ix);
10687 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10690 ptr = POPPTR(ss,ix);
10691 TOPPTR(nss,ix) = ptr;
10695 TOPINT(nss,ix) = i;
10697 case SAVEt_COMPPAD:
10698 av = (AV*)POPPTR(ss,ix);
10699 TOPPTR(nss,ix) = av_dup(av, param);
10702 longval = (long)POPLONG(ss,ix);
10703 TOPLONG(nss,ix) = longval;
10704 ptr = POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10706 sv = (SV*)POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = sv_dup(sv, param);
10710 ptr = POPPTR(ss,ix);
10711 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10712 longval = (long)POPBOOL(ss,ix);
10713 TOPBOOL(nss,ix) = (bool)longval;
10715 case SAVEt_SET_SVFLAGS:
10717 TOPINT(nss,ix) = i;
10719 TOPINT(nss,ix) = i;
10720 sv = (SV*)POPPTR(ss,ix);
10721 TOPPTR(nss,ix) = sv_dup(sv, param);
10724 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10732 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10733 * flag to the result. This is done for each stash before cloning starts,
10734 * so we know which stashes want their objects cloned */
10737 do_mark_cloneable_stash(pTHX_ SV *sv)
10739 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10741 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10742 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10743 if (cloner && GvCV(cloner)) {
10750 XPUSHs(sv_2mortal(newSVhek(hvname)));
10752 call_sv((SV*)GvCV(cloner), G_SCALAR);
10759 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10767 =for apidoc perl_clone
10769 Create and return a new interpreter by cloning the current one.
10771 perl_clone takes these flags as parameters:
10773 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10774 without it we only clone the data and zero the stacks,
10775 with it we copy the stacks and the new perl interpreter is
10776 ready to run at the exact same point as the previous one.
10777 The pseudo-fork code uses COPY_STACKS while the
10778 threads->new doesn't.
10780 CLONEf_KEEP_PTR_TABLE
10781 perl_clone keeps a ptr_table with the pointer of the old
10782 variable as a key and the new variable as a value,
10783 this allows it to check if something has been cloned and not
10784 clone it again but rather just use the value and increase the
10785 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10786 the ptr_table using the function
10787 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10788 reason to keep it around is if you want to dup some of your own
10789 variable who are outside the graph perl scans, example of this
10790 code is in threads.xs create
10793 This is a win32 thing, it is ignored on unix, it tells perls
10794 win32host code (which is c++) to clone itself, this is needed on
10795 win32 if you want to run two threads at the same time,
10796 if you just want to do some stuff in a separate perl interpreter
10797 and then throw it away and return to the original one,
10798 you don't need to do anything.
10803 /* XXX the above needs expanding by someone who actually understands it ! */
10804 EXTERN_C PerlInterpreter *
10805 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10808 perl_clone(PerlInterpreter *proto_perl, UV flags)
10811 #ifdef PERL_IMPLICIT_SYS
10813 /* perlhost.h so we need to call into it
10814 to clone the host, CPerlHost should have a c interface, sky */
10816 if (flags & CLONEf_CLONE_HOST) {
10817 return perl_clone_host(proto_perl,flags);
10819 return perl_clone_using(proto_perl, flags,
10821 proto_perl->IMemShared,
10822 proto_perl->IMemParse,
10824 proto_perl->IStdIO,
10828 proto_perl->IProc);
10832 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10833 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10834 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10835 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10836 struct IPerlDir* ipD, struct IPerlSock* ipS,
10837 struct IPerlProc* ipP)
10839 /* XXX many of the string copies here can be optimized if they're
10840 * constants; they need to be allocated as common memory and just
10841 * their pointers copied. */
10844 CLONE_PARAMS clone_params;
10845 CLONE_PARAMS* param = &clone_params;
10847 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10848 /* for each stash, determine whether its objects should be cloned */
10849 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10850 PERL_SET_THX(my_perl);
10853 Poison(my_perl, 1, PerlInterpreter);
10855 PL_curcop = (COP *)Nullop;
10859 PL_savestack_ix = 0;
10860 PL_savestack_max = -1;
10861 PL_sig_pending = 0;
10862 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10863 # else /* !DEBUGGING */
10864 Zero(my_perl, 1, PerlInterpreter);
10865 # endif /* DEBUGGING */
10867 /* host pointers */
10869 PL_MemShared = ipMS;
10870 PL_MemParse = ipMP;
10877 #else /* !PERL_IMPLICIT_SYS */
10879 CLONE_PARAMS clone_params;
10880 CLONE_PARAMS* param = &clone_params;
10881 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10882 /* for each stash, determine whether its objects should be cloned */
10883 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10884 PERL_SET_THX(my_perl);
10887 Poison(my_perl, 1, PerlInterpreter);
10889 PL_curcop = (COP *)Nullop;
10893 PL_savestack_ix = 0;
10894 PL_savestack_max = -1;
10895 PL_sig_pending = 0;
10896 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10897 # else /* !DEBUGGING */
10898 Zero(my_perl, 1, PerlInterpreter);
10899 # endif /* DEBUGGING */
10900 #endif /* PERL_IMPLICIT_SYS */
10901 param->flags = flags;
10902 param->proto_perl = proto_perl;
10905 PL_xnv_arenaroot = NULL;
10906 PL_xnv_root = NULL;
10907 PL_xpv_arenaroot = NULL;
10908 PL_xpv_root = NULL;
10909 PL_xpviv_arenaroot = NULL;
10910 PL_xpviv_root = NULL;
10911 PL_xpvnv_arenaroot = NULL;
10912 PL_xpvnv_root = NULL;
10913 PL_xpvcv_arenaroot = NULL;
10914 PL_xpvcv_root = NULL;
10915 PL_xpvav_arenaroot = NULL;
10916 PL_xpvav_root = NULL;
10917 PL_xpvhv_arenaroot = NULL;
10918 PL_xpvhv_root = NULL;
10919 PL_xpvmg_arenaroot = NULL;
10920 PL_xpvmg_root = NULL;
10921 PL_xpvgv_arenaroot = NULL;
10922 PL_xpvgv_root = NULL;
10923 PL_xpvlv_arenaroot = NULL;
10924 PL_xpvlv_root = NULL;
10925 PL_xpvbm_arenaroot = NULL;
10926 PL_xpvbm_root = NULL;
10927 PL_he_arenaroot = NULL;
10929 #if defined(USE_ITHREADS)
10930 PL_pte_arenaroot = NULL;
10931 PL_pte_root = NULL;
10933 PL_nice_chunk = NULL;
10934 PL_nice_chunk_size = 0;
10936 PL_sv_objcount = 0;
10937 PL_sv_root = Nullsv;
10938 PL_sv_arenaroot = Nullsv;
10940 PL_debug = proto_perl->Idebug;
10942 PL_hash_seed = proto_perl->Ihash_seed;
10943 PL_rehash_seed = proto_perl->Irehash_seed;
10945 #ifdef USE_REENTRANT_API
10946 /* XXX: things like -Dm will segfault here in perlio, but doing
10947 * PERL_SET_CONTEXT(proto_perl);
10948 * breaks too many other things
10950 Perl_reentrant_init(aTHX);
10953 /* create SV map for pointer relocation */
10954 PL_ptr_table = ptr_table_new();
10956 /* initialize these special pointers as early as possible */
10957 SvANY(&PL_sv_undef) = NULL;
10958 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10959 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10960 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10962 SvANY(&PL_sv_no) = new_XPVNV();
10963 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10964 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10965 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10966 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10967 SvCUR_set(&PL_sv_no, 0);
10968 SvLEN_set(&PL_sv_no, 1);
10969 SvIV_set(&PL_sv_no, 0);
10970 SvNV_set(&PL_sv_no, 0);
10971 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10973 SvANY(&PL_sv_yes) = new_XPVNV();
10974 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10975 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10976 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10977 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10978 SvCUR_set(&PL_sv_yes, 1);
10979 SvLEN_set(&PL_sv_yes, 2);
10980 SvIV_set(&PL_sv_yes, 1);
10981 SvNV_set(&PL_sv_yes, 1);
10982 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10984 /* create (a non-shared!) shared string table */
10985 PL_strtab = newHV();
10986 HvSHAREKEYS_off(PL_strtab);
10987 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10988 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10990 PL_compiling = proto_perl->Icompiling;
10992 /* These two PVs will be free'd special way so must set them same way op.c does */
10993 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10994 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10996 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10997 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10999 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11000 if (!specialWARN(PL_compiling.cop_warnings))
11001 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11002 if (!specialCopIO(PL_compiling.cop_io))
11003 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11004 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11006 /* pseudo environmental stuff */
11007 PL_origargc = proto_perl->Iorigargc;
11008 PL_origargv = proto_perl->Iorigargv;
11010 param->stashes = newAV(); /* Setup array of objects to call clone on */
11012 /* Set tainting stuff before PerlIO_debug can possibly get called */
11013 PL_tainting = proto_perl->Itainting;
11014 PL_taint_warn = proto_perl->Itaint_warn;
11016 #ifdef PERLIO_LAYERS
11017 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11018 PerlIO_clone(aTHX_ proto_perl, param);
11021 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11022 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11023 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11024 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11025 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11026 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11029 PL_minus_c = proto_perl->Iminus_c;
11030 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11031 PL_localpatches = proto_perl->Ilocalpatches;
11032 PL_splitstr = proto_perl->Isplitstr;
11033 PL_preprocess = proto_perl->Ipreprocess;
11034 PL_minus_n = proto_perl->Iminus_n;
11035 PL_minus_p = proto_perl->Iminus_p;
11036 PL_minus_l = proto_perl->Iminus_l;
11037 PL_minus_a = proto_perl->Iminus_a;
11038 PL_minus_F = proto_perl->Iminus_F;
11039 PL_doswitches = proto_perl->Idoswitches;
11040 PL_dowarn = proto_perl->Idowarn;
11041 PL_doextract = proto_perl->Idoextract;
11042 PL_sawampersand = proto_perl->Isawampersand;
11043 PL_unsafe = proto_perl->Iunsafe;
11044 PL_inplace = SAVEPV(proto_perl->Iinplace);
11045 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11046 PL_perldb = proto_perl->Iperldb;
11047 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11048 PL_exit_flags = proto_perl->Iexit_flags;
11050 /* magical thingies */
11051 /* XXX time(&PL_basetime) when asked for? */
11052 PL_basetime = proto_perl->Ibasetime;
11053 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11055 PL_maxsysfd = proto_perl->Imaxsysfd;
11056 PL_multiline = proto_perl->Imultiline;
11057 PL_statusvalue = proto_perl->Istatusvalue;
11059 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11061 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11063 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11065 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11066 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11067 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11069 /* Clone the regex array */
11070 PL_regex_padav = newAV();
11072 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11073 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11075 av_push(PL_regex_padav,
11076 sv_dup_inc(regexen[0],param));
11077 for(i = 1; i <= len; i++) {
11078 if(SvREPADTMP(regexen[i])) {
11079 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11081 av_push(PL_regex_padav,
11083 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11084 SvIVX(regexen[i])), param)))
11089 PL_regex_pad = AvARRAY(PL_regex_padav);
11091 /* shortcuts to various I/O objects */
11092 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11093 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11094 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11095 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11096 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11097 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11099 /* shortcuts to regexp stuff */
11100 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11102 /* shortcuts to misc objects */
11103 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11105 /* shortcuts to debugging objects */
11106 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11107 PL_DBline = gv_dup(proto_perl->IDBline, param);
11108 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11109 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11110 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11111 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11112 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11113 PL_lineary = av_dup(proto_perl->Ilineary, param);
11114 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11116 /* symbol tables */
11117 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11118 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11119 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11120 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11121 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11123 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11124 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11125 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11126 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11127 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11128 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11130 PL_sub_generation = proto_perl->Isub_generation;
11132 /* funky return mechanisms */
11133 PL_forkprocess = proto_perl->Iforkprocess;
11135 /* subprocess state */
11136 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11138 /* internal state */
11139 PL_maxo = proto_perl->Imaxo;
11140 if (proto_perl->Iop_mask)
11141 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11143 PL_op_mask = Nullch;
11144 /* PL_asserting = proto_perl->Iasserting; */
11146 /* current interpreter roots */
11147 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11148 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11149 PL_main_start = proto_perl->Imain_start;
11150 PL_eval_root = proto_perl->Ieval_root;
11151 PL_eval_start = proto_perl->Ieval_start;
11153 /* runtime control stuff */
11154 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11155 PL_copline = proto_perl->Icopline;
11157 PL_filemode = proto_perl->Ifilemode;
11158 PL_lastfd = proto_perl->Ilastfd;
11159 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11162 PL_gensym = proto_perl->Igensym;
11163 PL_preambled = proto_perl->Ipreambled;
11164 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11165 PL_laststatval = proto_perl->Ilaststatval;
11166 PL_laststype = proto_perl->Ilaststype;
11167 PL_mess_sv = Nullsv;
11169 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11171 /* interpreter atexit processing */
11172 PL_exitlistlen = proto_perl->Iexitlistlen;
11173 if (PL_exitlistlen) {
11174 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11175 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11178 PL_exitlist = (PerlExitListEntry*)NULL;
11179 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11180 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11181 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11183 PL_profiledata = NULL;
11184 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11185 /* PL_rsfp_filters entries have fake IoDIRP() */
11186 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11188 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11190 PAD_CLONE_VARS(proto_perl, param);
11192 #ifdef HAVE_INTERP_INTERN
11193 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11196 /* more statics moved here */
11197 PL_generation = proto_perl->Igeneration;
11198 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11200 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11201 PL_in_clean_all = proto_perl->Iin_clean_all;
11203 PL_uid = proto_perl->Iuid;
11204 PL_euid = proto_perl->Ieuid;
11205 PL_gid = proto_perl->Igid;
11206 PL_egid = proto_perl->Iegid;
11207 PL_nomemok = proto_perl->Inomemok;
11208 PL_an = proto_perl->Ian;
11209 PL_evalseq = proto_perl->Ievalseq;
11210 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11211 PL_origalen = proto_perl->Iorigalen;
11212 #ifdef PERL_USES_PL_PIDSTATUS
11213 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11215 PL_osname = SAVEPV(proto_perl->Iosname);
11216 PL_sighandlerp = proto_perl->Isighandlerp;
11218 PL_runops = proto_perl->Irunops;
11220 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11223 PL_cshlen = proto_perl->Icshlen;
11224 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11227 PL_lex_state = proto_perl->Ilex_state;
11228 PL_lex_defer = proto_perl->Ilex_defer;
11229 PL_lex_expect = proto_perl->Ilex_expect;
11230 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11231 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11232 PL_lex_starts = proto_perl->Ilex_starts;
11233 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11234 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11235 PL_lex_op = proto_perl->Ilex_op;
11236 PL_lex_inpat = proto_perl->Ilex_inpat;
11237 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11238 PL_lex_brackets = proto_perl->Ilex_brackets;
11239 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11240 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11241 PL_lex_casemods = proto_perl->Ilex_casemods;
11242 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11243 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11245 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11246 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11247 PL_nexttoke = proto_perl->Inexttoke;
11249 /* XXX This is probably masking the deeper issue of why
11250 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11251 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11252 * (A little debugging with a watchpoint on it may help.)
11254 if (SvANY(proto_perl->Ilinestr)) {
11255 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11256 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11257 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11258 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11259 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11260 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11261 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11262 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11263 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11266 PL_linestr = NEWSV(65,79);
11267 sv_upgrade(PL_linestr,SVt_PVIV);
11268 sv_setpvn(PL_linestr,"",0);
11269 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11271 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11272 PL_pending_ident = proto_perl->Ipending_ident;
11273 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11275 PL_expect = proto_perl->Iexpect;
11277 PL_multi_start = proto_perl->Imulti_start;
11278 PL_multi_end = proto_perl->Imulti_end;
11279 PL_multi_open = proto_perl->Imulti_open;
11280 PL_multi_close = proto_perl->Imulti_close;
11282 PL_error_count = proto_perl->Ierror_count;
11283 PL_subline = proto_perl->Isubline;
11284 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11286 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11287 if (SvANY(proto_perl->Ilinestr)) {
11288 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11289 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11290 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11291 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11292 PL_last_lop_op = proto_perl->Ilast_lop_op;
11295 PL_last_uni = SvPVX(PL_linestr);
11296 PL_last_lop = SvPVX(PL_linestr);
11297 PL_last_lop_op = 0;
11299 PL_in_my = proto_perl->Iin_my;
11300 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11302 PL_cryptseen = proto_perl->Icryptseen;
11305 PL_hints = proto_perl->Ihints;
11307 PL_amagic_generation = proto_perl->Iamagic_generation;
11309 #ifdef USE_LOCALE_COLLATE
11310 PL_collation_ix = proto_perl->Icollation_ix;
11311 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11312 PL_collation_standard = proto_perl->Icollation_standard;
11313 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11314 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11315 #endif /* USE_LOCALE_COLLATE */
11317 #ifdef USE_LOCALE_NUMERIC
11318 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11319 PL_numeric_standard = proto_perl->Inumeric_standard;
11320 PL_numeric_local = proto_perl->Inumeric_local;
11321 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11322 #endif /* !USE_LOCALE_NUMERIC */
11324 /* utf8 character classes */
11325 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11326 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11327 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11328 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11329 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11330 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11331 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11332 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11333 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11334 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11335 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11336 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11337 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11338 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11339 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11340 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11341 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11342 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11343 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11344 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11346 /* Did the locale setup indicate UTF-8? */
11347 PL_utf8locale = proto_perl->Iutf8locale;
11348 /* Unicode features (see perlrun/-C) */
11349 PL_unicode = proto_perl->Iunicode;
11351 /* Pre-5.8 signals control */
11352 PL_signals = proto_perl->Isignals;
11354 /* times() ticks per second */
11355 PL_clocktick = proto_perl->Iclocktick;
11357 /* Recursion stopper for PerlIO_find_layer */
11358 PL_in_load_module = proto_perl->Iin_load_module;
11360 /* sort() routine */
11361 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11363 /* Not really needed/useful since the reenrant_retint is "volatile",
11364 * but do it for consistency's sake. */
11365 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11367 /* Hooks to shared SVs and locks. */
11368 PL_sharehook = proto_perl->Isharehook;
11369 PL_lockhook = proto_perl->Ilockhook;
11370 PL_unlockhook = proto_perl->Iunlockhook;
11371 PL_threadhook = proto_perl->Ithreadhook;
11373 PL_runops_std = proto_perl->Irunops_std;
11374 PL_runops_dbg = proto_perl->Irunops_dbg;
11376 #ifdef THREADS_HAVE_PIDS
11377 PL_ppid = proto_perl->Ippid;
11381 PL_last_swash_hv = Nullhv; /* reinits on demand */
11382 PL_last_swash_klen = 0;
11383 PL_last_swash_key[0]= '\0';
11384 PL_last_swash_tmps = (U8*)NULL;
11385 PL_last_swash_slen = 0;
11387 PL_glob_index = proto_perl->Iglob_index;
11388 PL_srand_called = proto_perl->Isrand_called;
11389 PL_uudmap['M'] = 0; /* reinits on demand */
11390 PL_bitcount = Nullch; /* reinits on demand */
11392 if (proto_perl->Ipsig_pend) {
11393 Newxz(PL_psig_pend, SIG_SIZE, int);
11396 PL_psig_pend = (int*)NULL;
11399 if (proto_perl->Ipsig_ptr) {
11400 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11401 Newxz(PL_psig_name, SIG_SIZE, SV*);
11402 for (i = 1; i < SIG_SIZE; i++) {
11403 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11404 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11408 PL_psig_ptr = (SV**)NULL;
11409 PL_psig_name = (SV**)NULL;
11412 /* thrdvar.h stuff */
11414 if (flags & CLONEf_COPY_STACKS) {
11415 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11416 PL_tmps_ix = proto_perl->Ttmps_ix;
11417 PL_tmps_max = proto_perl->Ttmps_max;
11418 PL_tmps_floor = proto_perl->Ttmps_floor;
11419 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11421 while (i <= PL_tmps_ix) {
11422 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11426 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11427 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11428 Newxz(PL_markstack, i, I32);
11429 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11430 - proto_perl->Tmarkstack);
11431 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11432 - proto_perl->Tmarkstack);
11433 Copy(proto_perl->Tmarkstack, PL_markstack,
11434 PL_markstack_ptr - PL_markstack + 1, I32);
11436 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11437 * NOTE: unlike the others! */
11438 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11439 PL_scopestack_max = proto_perl->Tscopestack_max;
11440 Newxz(PL_scopestack, PL_scopestack_max, I32);
11441 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11443 /* NOTE: si_dup() looks at PL_markstack */
11444 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11446 /* PL_curstack = PL_curstackinfo->si_stack; */
11447 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11448 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11450 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11451 PL_stack_base = AvARRAY(PL_curstack);
11452 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11453 - proto_perl->Tstack_base);
11454 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11456 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11457 * NOTE: unlike the others! */
11458 PL_savestack_ix = proto_perl->Tsavestack_ix;
11459 PL_savestack_max = proto_perl->Tsavestack_max;
11460 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11461 PL_savestack = ss_dup(proto_perl, param);
11465 ENTER; /* perl_destruct() wants to LEAVE; */
11468 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11469 PL_top_env = &PL_start_env;
11471 PL_op = proto_perl->Top;
11474 PL_Xpv = (XPV*)NULL;
11475 PL_na = proto_perl->Tna;
11477 PL_statbuf = proto_perl->Tstatbuf;
11478 PL_statcache = proto_perl->Tstatcache;
11479 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11480 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11482 PL_timesbuf = proto_perl->Ttimesbuf;
11485 PL_tainted = proto_perl->Ttainted;
11486 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11487 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11488 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11489 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11490 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11491 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11492 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11493 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11494 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11496 PL_restartop = proto_perl->Trestartop;
11497 PL_in_eval = proto_perl->Tin_eval;
11498 PL_delaymagic = proto_perl->Tdelaymagic;
11499 PL_dirty = proto_perl->Tdirty;
11500 PL_localizing = proto_perl->Tlocalizing;
11502 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11503 PL_hv_fetch_ent_mh = Nullhe;
11504 PL_modcount = proto_perl->Tmodcount;
11505 PL_lastgotoprobe = Nullop;
11506 PL_dumpindent = proto_perl->Tdumpindent;
11508 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11509 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11510 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11511 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11512 PL_efloatbuf = Nullch; /* reinits on demand */
11513 PL_efloatsize = 0; /* reinits on demand */
11517 PL_screamfirst = NULL;
11518 PL_screamnext = NULL;
11519 PL_maxscream = -1; /* reinits on demand */
11520 PL_lastscream = Nullsv;
11522 PL_watchaddr = NULL;
11523 PL_watchok = Nullch;
11525 PL_regdummy = proto_perl->Tregdummy;
11526 PL_regprecomp = Nullch;
11529 PL_colorset = 0; /* reinits PL_colors[] */
11530 /*PL_colors[6] = {0,0,0,0,0,0};*/
11531 PL_reginput = Nullch;
11532 PL_regbol = Nullch;
11533 PL_regeol = Nullch;
11534 PL_regstartp = (I32*)NULL;
11535 PL_regendp = (I32*)NULL;
11536 PL_reglastparen = (U32*)NULL;
11537 PL_reglastcloseparen = (U32*)NULL;
11538 PL_regtill = Nullch;
11539 PL_reg_start_tmp = (char**)NULL;
11540 PL_reg_start_tmpl = 0;
11541 PL_regdata = (struct reg_data*)NULL;
11544 PL_reg_eval_set = 0;
11546 PL_regprogram = (regnode*)NULL;
11548 PL_regcc = (CURCUR*)NULL;
11549 PL_reg_call_cc = (struct re_cc_state*)NULL;
11550 PL_reg_re = (regexp*)NULL;
11551 PL_reg_ganch = Nullch;
11552 PL_reg_sv = Nullsv;
11553 PL_reg_match_utf8 = FALSE;
11554 PL_reg_magic = (MAGIC*)NULL;
11556 PL_reg_oldcurpm = (PMOP*)NULL;
11557 PL_reg_curpm = (PMOP*)NULL;
11558 PL_reg_oldsaved = Nullch;
11559 PL_reg_oldsavedlen = 0;
11560 #ifdef PERL_OLD_COPY_ON_WRITE
11563 PL_reg_maxiter = 0;
11564 PL_reg_leftiter = 0;
11565 PL_reg_poscache = Nullch;
11566 PL_reg_poscache_size= 0;
11568 /* RE engine - function pointers */
11569 PL_regcompp = proto_perl->Tregcompp;
11570 PL_regexecp = proto_perl->Tregexecp;
11571 PL_regint_start = proto_perl->Tregint_start;
11572 PL_regint_string = proto_perl->Tregint_string;
11573 PL_regfree = proto_perl->Tregfree;
11575 PL_reginterp_cnt = 0;
11576 PL_reg_starttry = 0;
11578 /* Pluggable optimizer */
11579 PL_peepp = proto_perl->Tpeepp;
11581 PL_stashcache = newHV();
11583 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11584 ptr_table_free(PL_ptr_table);
11585 PL_ptr_table = NULL;
11588 /* Call the ->CLONE method, if it exists, for each of the stashes
11589 identified by sv_dup() above.
11591 while(av_len(param->stashes) != -1) {
11592 HV* const stash = (HV*) av_shift(param->stashes);
11593 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11594 if (cloner && GvCV(cloner)) {
11599 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11601 call_sv((SV*)GvCV(cloner), G_DISCARD);
11607 SvREFCNT_dec(param->stashes);
11609 /* orphaned? eg threads->new inside BEGIN or use */
11610 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11611 (void)SvREFCNT_inc(PL_compcv);
11612 SAVEFREESV(PL_compcv);
11618 #endif /* USE_ITHREADS */
11621 =head1 Unicode Support
11623 =for apidoc sv_recode_to_utf8
11625 The encoding is assumed to be an Encode object, on entry the PV
11626 of the sv is assumed to be octets in that encoding, and the sv
11627 will be converted into Unicode (and UTF-8).
11629 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11630 is not a reference, nothing is done to the sv. If the encoding is not
11631 an C<Encode::XS> Encoding object, bad things will happen.
11632 (See F<lib/encoding.pm> and L<Encode>).
11634 The PV of the sv is returned.
11639 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11642 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11656 Passing sv_yes is wrong - it needs to be or'ed set of constants
11657 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11658 remove converted chars from source.
11660 Both will default the value - let them.
11662 XPUSHs(&PL_sv_yes);
11665 call_method("decode", G_SCALAR);
11669 s = SvPV_const(uni, len);
11670 if (s != SvPVX_const(sv)) {
11671 SvGROW(sv, len + 1);
11672 Move(s, SvPVX(sv), len + 1, char);
11673 SvCUR_set(sv, len);
11680 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11684 =for apidoc sv_cat_decode
11686 The encoding is assumed to be an Encode object, the PV of the ssv is
11687 assumed to be octets in that encoding and decoding the input starts
11688 from the position which (PV + *offset) pointed to. The dsv will be
11689 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11690 when the string tstr appears in decoding output or the input ends on
11691 the PV of the ssv. The value which the offset points will be modified
11692 to the last input position on the ssv.
11694 Returns TRUE if the terminator was found, else returns FALSE.
11699 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11700 SV *ssv, int *offset, char *tstr, int tlen)
11704 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11715 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11716 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11718 call_method("cat_decode", G_SCALAR);
11720 ret = SvTRUE(TOPs);
11721 *offset = SvIV(offsv);
11727 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11733 * c-indentation-style: bsd
11734 * c-basic-offset: 4
11735 * indent-tabs-mode: t
11738 * ex: set ts=8 sts=4 sw=4 noet: